refactor: refactored AddToSiriButton

BREAKING CHANGE: `supportsSiriButton` has been deprecated. The component now returns null when not supported.

BREAKING CHANGE: AddToSiriButton now returns `null` on Android.

Added `automatic` and `automaticOutline` styles to AddToSiriButton

fix: Removed observer from `init` in RNSSSiriShortcuts.m, so an observer is only created when there are listeners.

BREAKING CHANGE: RNSiriShortcuts has been renamed to RNSSSiriShortcuts.

Prefixed files with RNSS for namespacing purposes.

Exporting AddToSiriButton and SiriButtonStyles from `index.js`.

fix: Added TS types for AddToSiriButton and SiriButtonStyles.

Removed Swift setup from podspec.

SiriButtonStyles is not exported natively to ensure the values match.

Author: Gustash

AddToSiriButton.ios.js

@@ -0,0 +1,55 @@
+// @flow
+import type { ShortcutOptions } from ".";
+
+import * as React from "react";
+import {
+  requireNativeComponent,
+  View,
+  Platform,
+  UIManager,
+  NativeModules,
+} from "react-native";
+
+const RNTAddToSiriButton = requireNativeComponent("RNSSAddToSiriButton");
+const Constants = (
+  UIManager.getViewManagerConfig
+    ? UIManager.getViewManagerConfig("RNSSAddToSiriButton")
+    : UIManager["RNSSAddToSiriButton"]
+).Constants;
+
+export const SiriButtonStyles = Constants.AvailableStyles;
+
+type ViewProps = React.ElementConfig<typeof View>;
+type ViewStyleProp = $PropertyType<ViewProps, "style">;
+
+type Props = {
+  buttonStyle?: 0 | 1 | 2 | 3 | 4 | 5,
+  style?: ViewStyleProp,
+  shortcut: ShortcutOptions,
+  onPress?: () => void,
+};
+
+/** @deprecated The component itself now returns `null` when the device does not support the AddToSiriButton */
+export const supportsSiriButton = Number.parseFloat(Platform.Version, 10) >= 12;
+
+const AddToSiriButton = ({ buttonStyle, onPress, shortcut, style }: Props) => {
+  if (!supportsSiriButton) {
+    return null;
+  }
+
+  return (
+  <RNTAddToSiriButton
+    buttonStyle={buttonStyle}
+    onPress={onPress}
+    shortcut={shortcut}
+    style={[
+      {
+        height: Constants.ComponentHeight,
+        width: Constants.ComponentWidth,
+      },
+      style,
+    ]}
+  />
+)};
+
+export default AddToSiriButton;

AddToSiriButton.js

@@ -1,58 +1,5 @@
-// @flow
-import type { ShortcutOptions } from ".";
+export const SiriButtonStyles = {};
 
-import * as React from "react";
-import {
-  requireNativeComponent,
-  View,
-  StyleSheet,
-  Platform
-} from "react-native";
-
-const RNTAddToSiriButton = requireNativeComponent("RNTAddToSiriButton");
-
-export const SiriButtonStyles = {
-  white: 0,
-  whiteOutline: 1,
-  black: 2,
-  blackOutline: 3
-};
-
-type ViewProps = React.ElementConfig<typeof View>;
-type ViewStyleProp = $PropertyType<ViewProps, "style">;
-
-type Props = {
-  buttonStyle?: 0 | 1 | 2 | 3,
-  style?: ViewStyleProp,
-  shortcut: ShortcutOptions,
-  onPress?: () => void
-};
-
-export const supportsSiriButton =
-  Platform.OS === "ios" && Number.parseFloat(Platform.Version, 10) >= 12;
-
-const AddToSiriButton = ({
-  buttonStyle = SiriButtonStyles.white,
-  style = {},
-  onPress = () => {},
-  shortcut
-}: Props) => (
-  <View
-    style={[
-      {
-        width: 149,
-        height: 50
-      },
-      style
-    ]}
-  >
-    <RNTAddToSiriButton
-      buttonStyle={buttonStyle}
-      style={{ flex: 1 }}
-      onPress={onPress}
-      shortcut={shortcut}
-    />
-  </View>
-);
-
-export default AddToSiriButton;
+export default function AddToSiriButton() {
+  return null;
+}

RNSiriShortcuts.podspec

@@ -11,8 +11,6 @@ Pod::Spec.new do |s|
   s.authors      = package['author']
   s.homepage     = package['homepage']
   s.platform     = :ios, "9.0"
-  s.swift_version = "5.2"
-  s.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES' }
 
   s.source       = { :git => "https://github.com/Gustash/react-native-siri-shortcut.git", :tag => "v#{s.version}" }
   s.source_files  = "ios/**/*.{h,m,swift}"

example/App.js

@@ -30,11 +30,9 @@ import {
   getShortcuts,
   addShortcutListener,
   getInitialShortcut,
-} from 'react-native-siri-shortcut';
-import AddToSiriButton, {
+  AddToSiriButton,
   SiriButtonStyles,
-  supportsSiriButton,
-} from 'react-native-siri-shortcut/AddToSiriButton';
+} from 'react-native-siri-shortcut';
 
 const opts1: ShortcutOptions = {
   activityType: 'com.github.gustash.SiriShortcutsModuleExample.sayHello',
@@ -66,7 +64,7 @@ const opts2: ShortcutOptions = {
 type State = {
   shortcutInfo: ?any,
   shortcutActivityType: ?string,
-  addToSiriStyle: 0 | 1 | 2 | 3,
+  addToSiriStyle: 0 | 1 | 2 | 3 | 4 | 5,
   shortcuts: Array<ShortcutData>,
 };
 export default class App extends Component<void, State> {
@@ -229,23 +227,19 @@ export default class App extends Component<void, State> {
             title="Update list of shortcuts"
             onPress={this.updateShortcutList.bind(this)}
           />
-          {supportsSiriButton && (
-            <>
-              <AddToSiriButton
-                buttonStyle={addToSiriStyle}
-                onPress={() => {
-                  presentShortcut(opts1, ({status}) => {
-                    console.log(`I was ${status}`);
-                  });
-                }}
-                shortcut={opts1}
-              />
-              <Button
-                title="Swap Siri Button Theme"
-                onPress={this.swapSiriButtonTheme.bind(this)}
-              />
-            </>
-          )}
+          <AddToSiriButton
+            buttonStyle={addToSiriStyle}
+            onPress={() => {
+              presentShortcut(opts1, ({status}) => {
+                console.log(`I was ${status}`);
+              });
+            }}
+            shortcut={opts1}
+          />
+          <Button
+            title="Swap Siri Button Theme"
+            onPress={this.swapSiriButtonTheme.bind(this)}
+          />
           {shortcuts.length ? (
             shortcuts.map(({identifier, phrase, options}, i) => (
               <View key={identifier}>

example/ios/Podfile.lock

@@ -540,7 +540,7 @@ SPEC CHECKSUMS:
   React-RCTVibration: 9e344c840176b0af9c84d5019eb4fed8b3c105a1
   React-runtimeexecutor: 7285b499d0339104b2813a1f58ad1ada4adbd6c0
   ReactCommon: bf2888a826ceedf54b99ad1b6182d1bc4a8a3984
-  RNSiriShortcuts: 93d7607c6e1dd693657395ce6d705f6005e88240
+  RNSiriShortcuts: 25b8d989565561f96a6a8791b474226f916fef72
   SocketRocket: fccef3f9c5cedea1353a9ef6ada904fde10d6608
   Yoga: 17cd9a50243093b547c1e539c749928dd68152da
   YogaKit: f782866e155069a2cca2517aafea43200b01fd5a

example/ios/example/AppDelegate.mm

@@ -110,7 +110,7 @@ - (BOOL)application:(UIApplication *)application
 continueUserActivity:(NSUserActivity *)userActivity
  restorationHandler:(void (^)(NSArray<id<UIUserActivityRestoring>> * _Nullable))restorationHandler
 {
-  return [RNSiriShortcuts application:application continueUserActivity:userActivity restorationHandler:restorationHandler];
+  return [RNSSSiriShortcuts application:application continueUserActivity:userActivity restorationHandler:restorationHandler];
 }
 
 @end

index.d.ts

@@ -1,4 +1,5 @@
-import { EmitterSubscription, NativeEventEmitter } from "react-native";
+import React from "react";
+import { EmitterSubscription, NativeEventEmitter, StyleProp, ViewStyle } from "react-native";
 
 export type ShortcutOptions = {
   activityType: string;
@@ -59,3 +60,21 @@ export function clearShortcutsWithIdentifiers(
 ): Promise<void>;
 
 export const supportsPresentShortcut: boolean;
+
+export enum SiriButtonStyles {
+  white = 0,
+  whiteOutline = 1,
+  black = 2,
+  blackOutline = 3,
+  /** Only supported on iOS >= 13. On iOS 12 this defaults to `white` */
+  automatic = 4,
+  /** Only supported on iOS >= 13. On iOS 12 this defaults to `whiteOutline` */
+  automaticOutline = 5,
+}
+export interface AddToSiriButtonProps {
+  buttonStyle?: SiriButtonStyles;
+  style?: StyleProp<ViewStyle>;
+  shortcut: ShortcutOptions;
+  onPress?: () => void;
+}
+export const AddToSiriButton: (props: AddToSiriButtonProps) => JSX.Element | null;

index.js

@@ -111,3 +111,8 @@ export const getInitialShortcut = safeCall(() => RNSiriShortcuts.getInitialShort
 export const addShortcutListener = (callback: (shortcut: ShortcutInfo) => void) => {
   return SiriShortcutsEvent.addListener("SiriShortcutListener", callback);
 }
+
+export {
+  default as AddToSiriButton,
+  SiriButtonStyles,
+} from "./AddToSiriButton";

ios/NSUserActivity+ShortcutOptions.h

@@ -0,0 +1,21 @@
+//
+//  RCTConvert+INShortcut.h
+//  Pods
+//
+//  Created by Gustavo Parreira on 21/04/2022.
+//
+
+#ifndef RCTConvert_INShortcut_h
+#define RCTConvert_INShortcut_h
+
+#import <React/RCTConvert.h>
+#import <Intents/Intents.h>
+
+API_AVAILABLE(ios(12.0))
+@interface RCTConvert (INShortcut)
+
++ (INShortcut *)INShortcut:(id)json;
+
+@end
+
+#endif /* RCTConvert_INShortcut_h */

ios/NSUserActivity+ShortcutOptions.m

@@ -0,0 +1,19 @@
+//
+//  RCTConvert+INShortcut.m
+//  RNSiriShortcuts
+//
+//  Created by Gustavo Parreira on 21/04/2022.
+//
+
+#import "RCTConvert+INShortcut.h"
+#import "RCTConvert+NSUserActivity.h"
+
+API_AVAILABLE(ios(12.0))
+@implementation RCTConvert (INShortcut)
+
++ (INShortcut *)INShortcut:(id)json
+{
+    return [[INShortcut alloc] initWithUserActivity:[self NSUserActivity:json]];
+}
+
+@end

ios/RCTConvert+INShortcut.h

@@ -0,0 +1,21 @@
+//
+//  RCTConvert+INUIAddVoiceShortcutButtonStyle.h
+//  Pods
+//
+//  Created by Gustavo Parreira on 21/04/2022.
+//
+
+#ifndef RCTConvert_INUIAddVoiceShortcutButtonStyle_h
+#define RCTConvert_INUIAddVoiceShortcutButtonStyle_h
+
+#import <React/RCTConvert.h>
+#import <IntentsUI/IntentsUI.h>
+
+API_AVAILABLE(ios(12.0))
+@interface RCTConvert (INUIAddVoiceShortcutButtonStyle)
+
++ (INUIAddVoiceShortcutButtonStyle)INUIAddVoiceShortcutButtonStyle:(id)json;
+
+@end
+
+#endif /* RCTConvert_INUIAddVoiceShortcutButtonStyle_h */