refactor: simplified setup API

It is no longer necessary to set initialProperties, and the library
exports a static `application:continueUserActivity:restorationHandler:` handler.

The listener is also no longer called immediately with the initial shortcut.

Instead, the library now provides a `getInitialShortcut` async method to get the
initial shortcut. This should make it easier to integrate with `react-navigation`'s
Deep Linking.

We should also write a React Navigation Example at some point, with Deep Linking setup.

A migration guide needs to be written for this change. This release WILL BE A BREAKING CHANGE.

Author: Gustash

example/App.js

@@ -5,7 +5,11 @@
  * @format
  * @flow strict-local
  */
-import type {ShortcutOptions, ShortcutData} from 'react-native-siri-shortcut';
+import type {
+  ShortcutOptions,
+  ShortcutData,
+  ShortcutInfo,
+} from 'react-native-siri-shortcut';
 
 import React, {Component} from 'react';
 import {
@@ -15,15 +19,17 @@ import {
   Button,
   SafeAreaView,
   View,
+  EmitterSubscription,
 } from 'react-native';
 import {
-  SiriShortcutsEvent,
   donateShortcut,
   suggestShortcuts,
   clearAllShortcuts,
   clearShortcutsWithIdentifiers,
   presentShortcut,
   getShortcuts,
+  addShortcutListener,
+  getInitialShortcut,
 } from 'react-native-siri-shortcut';
 import AddToSiriButton, {
   SiriButtonStyles,
@@ -38,6 +44,7 @@ const opts1: ShortcutOptions = {
     bar: 'baz',
     baz: 34.5,
   },
+  requiredUserInfoKeys: ['foo', 'bar', 'baz'],
   keywords: ['kek', 'foo', 'bar'],
   persistentIdentifier:
     'com.github.gustash.SiriShortcutsModuleExample.sayHello',
@@ -63,6 +70,8 @@ type State = {
   shortcuts: Array<ShortcutData>,
 };
 export default class App extends Component<void, State> {
+  listener: ?EmitterSubscription = null;
+
   state: State = {
     shortcutInfo: null,
     shortcutActivityType: null,
@@ -71,10 +80,8 @@ export default class App extends Component<void, State> {
   };
 
   componentDidMount() {
-    SiriShortcutsEvent.addListener(
-      'SiriShortcutListener',
-      this.handleSiriShortcut.bind(this),
-    );
+    this.handleInitialShortcut();
+    this.listener = addShortcutListener(this.handleSiriShortcut.bind(this));
 
     // This will suggest these two shortcuts so that they appear
     // in Settings > Siri & Search, even if they are not yet
@@ -85,7 +92,23 @@ export default class App extends Component<void, State> {
     this.updateShortcutList();
   }
 
-  handleSiriShortcut({userInfo, activityType}: any) {
+  componentWillUnmount() {
+    if (this.listener) {
+      this.listener.remove();
+    }
+  }
+
+  async handleInitialShortcut() {
+    const initialShortcut = await getInitialShortcut();
+
+    if (!initialShortcut) {
+      return;
+    }
+
+    this.handleSiriShortcut(initialShortcut);
+  }
+
+  handleSiriShortcut({userInfo, activityType}: ShortcutInfo) {
     this.setState({
       shortcutInfo: userInfo,
       shortcutActivityType: activityType,
@@ -157,20 +180,16 @@ export default class App extends Component<void, State> {
     const {addToSiriStyle} = this.state;
 
     const styles = Object.keys(SiriButtonStyles).map(
-      (key) => SiriButtonStyles[key],
+      key => SiriButtonStyles[key],
     );
-    const index = styles.findIndex((style) => style === addToSiriStyle);
+    const index = styles.findIndex(style => style === addToSiriStyle);
     if (index === styles.length - 1) this.setState({addToSiriStyle: styles[0]});
     else this.setState({addToSiriStyle: styles[index + 1]});
   }
 
   render() {
-    const {
-      shortcutInfo,
-      shortcutActivityType,
-      addToSiriStyle,
-      shortcuts,
-    } = this.state;
+    const {shortcutInfo, shortcutActivityType, addToSiriStyle, shortcuts} =
+      this.state;
 
     return (
       <SafeAreaView style={styles.container}>

example/ios/example/AppDelegate.mm

@@ -42,13 +42,7 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
   bridge.surfacePresenter = _bridgeAdapter.surfacePresenter;
 #endif
 
-  // Check if the app launched with any shortcuts
-  BOOL launchedFromShortcut = [launchOptions objectForKey:@"UIApplicationLaunchOptionsUserActivityDictionaryKey"] != nil;
-  // Add a boolean to the initialProperties to let the app know you got the initial shortcut
-  NSDictionary *initialProperties = @{ @"launchedFromShortcut":@(launchedFromShortcut) };
-  UIView *rootView = RCTAppSetupDefaultRootView(bridge,
-                                                @"example",
-                                                initialProperties); // Add the initial properties here
+  UIView *rootView = RCTAppSetupDefaultRootView(bridge, @"example", nil);
 
   if (@available(iOS 13.0, *)) {
     rootView.backgroundColor = [UIColor systemBackgroundColor];
@@ -116,19 +110,7 @@ - (BOOL)application:(UIApplication *)application
 continueUserActivity:(NSUserActivity *)userActivity
  restorationHandler:(void (^)(NSArray<id<UIUserActivityRestoring>> * _Nullable))restorationHandler
 {
-  UIViewController *viewController = self.window.rootViewController;
-  RCTRootView *rootView = (RCTRootView *)viewController.view;
-  
-  // If the initial properties say the app launched from a shortcut (see above), tell the library about it.
-  if ([[rootView.appProperties objectForKey:@"launchedFromShortcut"] boolValue]) {
-    RNSiriShortcuts.initialUserActivity = userActivity;
-    
-    rootView.appProperties = @{ @"launchedFromShortcut": @NO };
-  }
-  
-  [RNSiriShortcuts shortcutReceived:userActivity];
-  
-  return YES;
+  return [RNSiriShortcuts application:application continueUserActivity:userActivity restorationHandler:restorationHandler];
 }
 
 @end

index.d.ts

@@ -1,4 +1,4 @@
-import { NativeEventEmitter } from "react-native";
+import { EmitterSubscription, NativeEventEmitter } from "react-native";
 
 export type ShortcutOptions = {
   activityType: string;
@@ -28,8 +28,19 @@ export type ShortcutData = {
   options?: ShortcutOptions;
 };
 
+export type ShortcutInfo = {
+  activityType: string;
+  userInfo?: { [key: string]: any };
+}
+
+/** @deprecated Use `addShortcutListener` instead. */
 export const SiriShortcutsEvent: NativeEventEmitter;
 
+export function getInitialShortcut(): Promise<ShortcutInfo | null>;
+
+export type ShortcutListener = (shortcut: ShortcutInfo) => void;
+export function addShortcutListener(callback: ShortcutListener): EmitterSubscription;
+
 export function donateShortcut(options: ShortcutOptions): void;
 
 export function suggestShortcuts(options: Array<ShortcutOptions>): void;

index.js

@@ -44,6 +44,11 @@ export type ShortcutData = {
   options?: ShortcutOptions
 };
 
+export type ShortcutInfo = {
+  activityType: string,
+  userInfo: ?object,
+}
+
 const noop = () => ({});
 const safeCall = (func, minVersion = 12) => {
   if (
@@ -59,7 +64,7 @@ const safeCall = (func, minVersion = 12) => {
 export const SiriShortcutsEvent = Platform.select({
   ios: new NativeEventEmitter(RNSiriShortcuts),
   android: {
-    addListener: () => {},
+    addListener: () => ({remove: () => {}}),
     removeListener: () => {},
     removeAllListeners: () => {},
     removeCurrentListener: () => {},
@@ -100,3 +105,9 @@ export const presentShortcut = safeCall(
 );
 
 export const getShortcuts = safeCall(() => RNSiriShortcuts.getShortcuts());
+
+export const getInitialShortcut = safeCall(() => RNSiriShortcuts.getInitialShortcut(), 9);
+
+export const addShortcutListener = (callback: (shortcut: ShortcutInfo) => void) => {
+  return SiriShortcutsEvent.addListener("SiriShortcutListener", callback);
+}

ios/RNSiriShortcuts.h

@@ -9,16 +9,24 @@
 #ifndef RNSiriShortcuts_h
 #define RNSiriShortcuts_h
 
-#import <React/RCTBridgeModule.h>
+#if defined(__IPHONE_OS_VERSION_MAX_ALLOWED) && (__IPHONE_OS_VERSION_MAX_ALLOWED >= 12000) /* __IPHONE_12_0 */
+#import <UIKit/UIUserActivity.h>
+#endif
+
 #import <React/RCTEventEmitter.h>
 
 NS_ASSUME_NONNULL_BEGIN
 
-@interface RNSiriShortcuts : RCTEventEmitter <RCTBridgeModule>
-
-@property (class, nonatomic, strong) NSUserActivity * _Nullable initialUserActivity;
+@interface RNSiriShortcuts : RCTEventEmitter
 
-+ (void)shortcutReceived:(NSUserActivity *)activity;
++ (BOOL)application:(nonnull UIApplication *)application
+    continueUserActivity:(nonnull NSUserActivity *)userActivity
+      restorationHandler:
+        #if defined(__IPHONE_OS_VERSION_MAX_ALLOWED) && (__IPHONE_OS_VERSION_MAX_ALLOWED >= 12000) /* __IPHONE_12_0 */
+            (nonnull void (^)(NSArray<id<UIUserActivityRestoring>> *_Nullable))restorationHandler;
+        #else
+            (nonnull void (^)(NSArray *_Nullable))restorationHandler;
+        #endif
 
 @end