expo-live-activity 0.2.1-alpha1 → 0.3.0-alpha1

package/.prettierignore

@@ -0,0 +1,5 @@
+/build
+/example/.expo
+/example/ios
+/plugin/build
+/.eslintrc.js

package/.prettierrc

@@ -0,0 +1,6 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "printWidth": 120,
+  "trailingComma": "es5"
+}

package/README.md

@@ -6,68 +6,80 @@
 `expo-live-activity` is a React Native module designed for use with Expo to manage and display live activities on iOS devices exclusively. This module leverages the Live Activities feature introduced in iOS 16, allowing developers to deliver timely updates right on the lock screen.
 
 ## Features
+
 - Start, update, and stop live activities directly from your React Native application.
 - Easy integration with a comprehensive API.
 - Custom image support within live activities with a pre-configured path.
 - Listen and handle changes in push notification tokens associated with a live activity.
 
 ## Platform compatibility
+
 **Note:** This module is intended for use on **iOS devices only**. The minimal iOS version that supports Live Activities is 16.2. When methods are invoked on platforms other than iOS or on older iOS versions, they will log an error, ensuring that they are used in the correct context.
 
 ## Installation
+
 > [!NOTE]  
 > The library isn't supported in Expo Go, to set it up correctly you need to use [Expo DevClient](https://docs.expo.dev/versions/latest/sdk/dev-client/) .
-To begin using `expo-live-activity`, follow the installation and configuration steps outlined below:
+> To begin using `expo-live-activity`, follow the installation and configuration steps outlined below:
 
 ### Step 1: Installation
+
 Run the following command to add the expo-live-activity module to your project:
+
 ```sh
 npm install expo-live-activity
 ```
 
 ### Step 2: Config Plugin Setup
+
 The module comes with a built-in config plugin that creates a target in iOS with all the necessary files. The images used in live activities should be added to a pre-defined folder in your assets directory:
+
 1. **Add the config plugin to your app.json or app.config.js:**
    ```json
    {
-      "expo": {
-         "plugins": ["expo-live-activity"]
-      }
+     "expo": {
+       "plugins": ["expo-live-activity"]
+     }
    }
    ```
    If you want to update Live Acitivity with push notifications you can add option `"enablePushNotifications": true`:
    ```json
    {
-    "expo": {
-      "plugins": [
-        [
-          "expo-live-activity",
-          {
-            "enablePushNotifications": true
-          }
-        ]
-      ]
-    }
+     "expo": {
+       "plugins": [
+         [
+           "expo-live-activity",
+           {
+             "enablePushNotifications": true
+           }
+         ]
+       ]
+     }
    }
    ```
 2. **Assets configuration:**
    Place images intended for live activities in the `assets/liveActivity` folder. The plugin manages these assets automatically.
 
 Then prebuild your app with:
+
 ```sh
-npx expo prebuild --clean  
+npx expo prebuild --clean
 ```
 
 ### Step 3: Usage in Your React Native App
+
 Import the functionalities provided by the `expo-live-activity` module in your JavaScript or TypeScript files:
+
 ```javascript
-import * as LiveActivity from "expo-live-activity";
+import * as LiveActivity from 'expo-live-activity'
 ```
 
 ## API
+
 `expo-live-activity` module exports three primary functions to manage live activities:
 
 ### Managing Live Activities
+
 - **`startActivity(state: LiveActivityState, config?: LiveActivityConfig): string | undefined`**:
   Start a new live activity. Takes a `state` configuration object for initial activity state and an optional `config` object to customize appearance or behavior. It returns the `ID` of the created live activity, which should be stored for future reference. If the live activity can't be created (eg. on android or iOS lower than 16.2), it will return `undefined`.
 
@@ -78,16 +90,40 @@ import * as LiveActivity from "expo-live-activity";
   Terminate an ongoing live activity. The `state` object should contain the final state of the activity. The `activityId` indicates which activity should be stopped.
 
 ### Handling Push Notification Tokens
+
+- **`addActivityPushToStartTokenListener(listener: (event: ActivityPushToStartTokenReceivedEvent) => void): EventSubscription | undefined`**:
+  Subscribe to changes in the push to start token for starting live acitivities with push notifications.
 - **`addActivityTokenListener(listener: (event: ActivityTokenReceivedEvent) => void): EventSubscription | undefined`**:
   Subscribe to changes in the push notification token associated with live activities.
 
-
 ### Deep linking
-When starting a new live activity, it's possible to pass `deepLinkUrl` field in `config` object. This can be any string that you can handle in your main app target. 
+
+When starting a new live activity, it's possible to pass `deepLinkUrl` field in `config` object. This usually should be a path to one of your screens. If you are using @react-navigation in your project, it's easiest to enable auto linking:
+
+```typescript
+const prefix = Linking.createURL('')
+
+export default function App() {
+  const url = Linking.useLinkingURL()
+  const linking = {
+    enabled: 'auto' as const,
+    prefixes: [prefix],
+  }
+}
+
+// Then start the activity with:
+LiveActivity.startActivity(state, {
+  deepLinkUrl: '/order',
+})
+```
+
+URL scheme will be taken automatically from `scheme` field in `app.json` or fall back to `ios.bundleIdentifier`.
 
 ### State Object Structure
+
 The `state` object should include:
-```javascript
+
+```typescript
 {
   title: string;
   subtitle?: string;
@@ -98,7 +134,9 @@ The `state` object should include:
 ```
 
 ### Config Object Structure
+
 The `config` object should include:
+
 ```typescript
 {
    backgroundColor?: string;
@@ -111,75 +149,133 @@ The `config` object should include:
 };
 ```
 
+### Activity updates
+
+`LiveActivity.addActivityUpdatesListener` API allows to subscribe to changes in live activity state. This is useful for example when you want to update the live activity with new information. Handler will receive an `ActivityUpdateEvent` object which contains information about new state under `activityState` property which is of `ActivityState` type, so the possible values are: `'active'`, `'dismissed'`, `'pending'`, `'stale'` or `'ended'`. Apart from this property, the event also contains `activityId` and `activityName` which can be used to identify the live activity.
+
 ## Example Usage
+
 Managing a live activity:
-```javascript
+
+```typescript
 const state: LiveActivity.LiveActivityState = {
-  title: "Title",
-  subtitle: "This is a subtitle",
+  title: 'Title',
+  subtitle: 'This is a subtitle',
   date: new Date(Date.now() + 60 * 1000 * 5).getTime(),
-  imageName: "live_activity_image",
-  dynamicIslandImageName: "dynamic_island_image"
-};
+  imageName: 'live_activity_image',
+  dynamicIslandImageName: 'dynamic_island_image',
+}
 
 const config: LiveActivity.LiveActivityConfig = {
-  backgroundColor: "#FFFFFF",
-  titleColor: "#000000",
-  subtitleColor: "#333333",
-  progressViewTint: "#4CAF50",
-  progressViewLabelColor: "#FFFFFF",
-  deepLinkUrl: "/dashboard",
-  timerType: "circular"
-};
+  backgroundColor: '#FFFFFF',
+  titleColor: '#000000',
+  subtitleColor: '#333333',
+  progressViewTint: '#4CAF50',
+  progressViewLabelColor: '#FFFFFF',
+  deepLinkUrl: '/dashboard',
+  timerType: 'circular',
+}
 
-const activityId = LiveActivity.startActivity(state, config);
+const activityId = LiveActivity.startActivity(state, config)
 // Store activityId for future reference
 ```
+
 This will initiate a live activity with the specified title, subtitle, image from your configured assets folder and a time to which there will be a countdown in a progress view.
 
 Subscribing to push token changes:
-```javascript
+
+```typescript
 useEffect(() => {
-  const subscription = LiveActivity.addActivityTokenListener(({ 
-    activityID: newActivityID,
-    activityPushToken: newToken
-  }) => {
-    // Send token to a remote server to update live activity with push notifications
-  });
-
-  return () => subscription?.remove();
-}, []);
+  const updateTokenSubscription = LiveActivity.addActivityTokenListener(
+    ({ activityID: newActivityID, activityName: newName, activityPushToken: newToken }) => {
+      // Send token to a remote server to update live activity with push notifications
+    }
+  )
+  const startTokenSubscription = LiveActivity.addActivityPushToStartTokenListener(
+    ({ activityPushToStartToken: newActivityPushToStartToken }) => {
+      // Send token to a remote server to start live activity with push notifications
+    }
+  )
+
+  return () => {
+    updateTokenSubscription?.remove()
+    startTokenSubscription?.remove()
+  }
+}, [])
 ```
 
 > [!NOTE]
 > Receiving push token may not work on simulators. Make sure to use physical device when testing this functionality.
 
 ## Push notifications
-By default, updating live activity is possible only via API. If you want to have possibility to update live activity using push notifications, you can enable that feature by adding `"enablePushNotifications": true` in the plugin config in your `app.json` or `app.config.ts` file. Then, the notification payload should look like this:
+
+By default, starting and updating live activity is possible only via API. If you want to have possibility to start or update live activity using push notifications, you can enable that feature by adding `"enablePushNotifications": true` in the plugin config in your `app.json` or `app.config.ts` file.
+
+> [!NOTE]
+> PushToStart works only for iOS 17.2 and higher.
+
+Example payload for starting live activity:
 
 ```json
 {
-    "aps":{
-        "event":"update",
-        "content-state":{
-            "title":"Hello",
-            "subtitle":"World",
-            "timerEndDateInMilliseconds":1754064245000,
-            "imageName": "live_activity_image",
-            "dynamicIslandImageName": "dynamic_island_image"
-        },
-        "timestamp":1754063621319 // timestamp of when the push notification was sent
+  "aps": {
+    "event": "start",
+    "content-state": {
+      "title": "Live activity title!",
+      "subtitle": "Live activity subtitle.",
+      "timerEndDateInMilliseconds": 1754410997000,
+      "imageName": "live_activity_image",
+      "dynamicIslandImageName": "dynamic_island_image"
+    },
+    "timestamp": 1754491435000, // timestamp of when the push notification was sent
+    "attributes-type": "LiveActivityAttributes",
+    "attributes": {
+      "name": "Test",
+      "backgroundColor": "001A72",
+      "titleColor": "EBEBF0",
+      "subtitleColor": "FFFFFF75",
+      "progressViewTint": "38ACDD",
+      "progressViewLabelColor": "FFFFFF",
+      "deepLinkUrl": "/dashboard",
+      "timerType": "digital"
+    },
+    "alert": {
+      "title": "",
+      "body": "",
+      "sound": "default"
     }
+  }
+}
+```
+
+Example payload for updating live activity:
+
+```json
+{
+  "aps": {
+    "event": "update",
+    "content-state": {
+      "title": "Hello",
+      "subtitle": "World",
+      "timerEndDateInMilliseconds": 1754064245000,
+      "imageName": "live_activity_image",
+      "dynamicIslandImageName": "dynamic_island_image"
+    },
+    "timestamp": 1754063621319 // timestamp of when the push notification was sent
+  }
 }
 ```
 
 Where `timerEndDateInMilliseconds` value is a timestamp in milliseconds corresponding to the target point of the counter displayed in live activity view.
 
 ## Image support
+
 Live activity view also supports image display. There are two dedicated fields in the `state` object for that:
+
 - `imageName`
 - `dynamicIslandImageName`
 
 The value of each field can be:
+
 - a string which maps to an asset name
-- a URL to remote image - currently, it's possible to use this option only via API, but we plan on to add that feature to push notifications as well. It also requires adding "App Groups" capability to both "main app" and "live activity" targets.
+- a URL to remote image - currently, it's possible to use this option only via API, but we plan on to add that feature to push notifications as well. It also requires adding "App Groups" capability to both "main app" and "live activity" targets.

package/app.plugin.js

@@ -1,2 +1,2 @@
 // This file configures the entry file for your plugin.
-module.exports = require('./plugin/build');
+module.exports = require('./plugin/build')

package/build/ExpoLiveActivityModule.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ExpoLiveActivityModule.d.ts","sourceRoot":"","sources":["../src/ExpoLiveActivityModule.ts"],"names":[],"mappings":";AAEA,wBAA+D"}
+{"version":3,"file":"ExpoLiveActivityModule.d.ts","sourceRoot":"","sources":["../src/ExpoLiveActivityModule.ts"],"names":[],"mappings":";AAEA,wBAA8D"}

package/build/ExpoLiveActivityModule.js.map

@@ -1 +1 @@
-{"version":3,"file":"ExpoLiveActivityModule.js","sourceRoot":"","sources":["../src/ExpoLiveActivityModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,MAAM,CAAC;AAEnD,eAAe,2BAA2B,CAAC,kBAAkB,CAAC,CAAC","sourcesContent":["import { requireOptionalNativeModule } from 'expo';\n\nexport default requireOptionalNativeModule('ExpoLiveActivity');\n"]}
+{"version":3,"file":"ExpoLiveActivityModule.js","sourceRoot":"","sources":["../src/ExpoLiveActivityModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,MAAM,CAAA;AAElD,eAAe,2BAA2B,CAAC,kBAAkB,CAAC,CAAA","sourcesContent":["import { requireOptionalNativeModule } from 'expo'\n\nexport default requireOptionalNativeModule('ExpoLiveActivity')\n"]}

package/build/index.d.ts

@@ -1,4 +1,5 @@
 import { EventSubscription } from 'expo-modules-core';
+type Voidable<T> = T | void;
 export type DynamicIslandTimerType = 'circular' | 'digital';
 export type LiveActivityState = {
     title: string;
@@ -18,17 +19,29 @@ export type LiveActivityConfig = {
 };
 export type ActivityTokenReceivedEvent = {
     activityID: string;
+    activityName: string;
     activityPushToken: string;
 };
+export type ActivityPushToStartTokenReceivedEvent = {
+    activityPushToStartToken: string;
+};
+type ActivityState = 'active' | 'dismissed' | 'pending' | 'stale' | 'ended';
+export type ActivityUpdateEvent = {
+    activityID: string;
+    activityName: string;
+    activityState: ActivityState;
+};
 export type LiveActivityModuleEvents = {
     onTokenReceived: (params: ActivityTokenReceivedEvent) => void;
+    onPushToStartTokenReceived: (params: ActivityPushToStartTokenReceivedEvent) => void;
+    onStateChange: (params: ActivityUpdateEvent) => void;
 };
 /**
  * @param {LiveActivityState} state The state for the live activity.
  * @param {LiveActivityConfig} config Live activity config object.
  * @returns {string} The identifier of the started activity or undefined if creating live activity failed.
  */
-export declare function startActivity(state: LiveActivityState, config?: LiveActivityConfig): string | undefined;
+export declare function startActivity(state: LiveActivityState, config?: LiveActivityConfig): Voidable<string>;
 /**
  * @param {string} id The identifier of the activity to stop.
  * @param {LiveActivityState} state The updated state for the live activity.
@@ -39,5 +52,8 @@ export declare function stopActivity(id: string, state: LiveActivityState): any;
  * @param {LiveActivityState} state The updated state for the live activity.
  */
 export declare function updateActivity(id: string, state: LiveActivityState): any;
-export declare function addActivityTokenListener(listener: (event: ActivityTokenReceivedEvent) => void): EventSubscription | undefined;
+export declare function addActivityTokenListener(listener: (event: ActivityTokenReceivedEvent) => void): Voidable<EventSubscription>;
+export declare function addActivityPushToStartTokenListener(listener: (event: ActivityPushToStartTokenReceivedEvent) => void): Voidable<EventSubscription>;
+export declare function addActivityUpdatesListener(listener: (event: ActivityUpdateEvent) => void): Voidable<EventSubscription>;
+export {};
 //# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAEtD,MAAM,MAAM,sBAAsB,GAAG,UAAU,GAAG,SAAS,CAAA;AAE3D,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,sBAAsB,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,UAAU,EAAE,MAAM,CAAC;IACnB,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,eAAe,EAAE,CAAC,MAAM,EAAE,0BAA0B,KAAK,IAAI,CAAC;CAC/D,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,iBAAiB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,MAAM,GAAG,SAAS,CAWvG;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB,OAShE;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB,OASlE;AAED,wBAAgB,wBAAwB,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,0BAA0B,KAAK,IAAI,GAAG,iBAAiB,GAAG,SAAS,CAM7H"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAKrD,KAAK,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;AAE3B,MAAM,MAAM,sBAAsB,GAAG,UAAU,GAAG,SAAS,CAAA;AAE3D,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,sBAAsB,CAAC,EAAE,MAAM,CAAA;CAChC,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,sBAAsB,CAAA;CACnC,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG;IACvC,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,EAAE,MAAM,CAAA;IACpB,iBAAiB,EAAE,MAAM,CAAA;CAC1B,CAAA;AAED,MAAM,MAAM,qCAAqC,GAAG;IAClD,wBAAwB,EAAE,MAAM,CAAA;CACjC,CAAA;AAED,KAAK,aAAa,GAAG,QAAQ,GAAG,WAAW,GAAG,SAAS,GAAG,OAAO,GAAG,OAAO,CAAA;AAE3E,MAAM,MAAM,mBAAmB,GAAG;IAChC,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,aAAa,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,eAAe,EAAE,CAAC,MAAM,EAAE,0BAA0B,KAAK,IAAI,CAAA;IAC7D,0BAA0B,EAAE,CAAC,MAAM,EAAE,qCAAqC,KAAK,IAAI,CAAA;IACnF,aAAa,EAAE,CAAC,MAAM,EAAE,mBAAmB,KAAK,IAAI,CAAA;CACrD,CAAA;AAUD;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,iBAAiB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,QAAQ,CAAC,MAAM,CAAC,CAErG;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB,OAEhE;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB,OAElE;AAED,wBAAgB,wBAAwB,CACtC,QAAQ,EAAE,CAAC,KAAK,EAAE,0BAA0B,KAAK,IAAI,GACpD,QAAQ,CAAC,iBAAiB,CAAC,CAE7B;AAED,wBAAgB,mCAAmC,CACjD,QAAQ,EAAE,CAAC,KAAK,EAAE,qCAAqC,KAAK,IAAI,GAC/D,QAAQ,CAAC,iBAAiB,CAAC,CAG7B;AAED,wBAAgB,0BAA0B,CACxC,QAAQ,EAAE,CAAC,KAAK,EAAE,mBAAmB,KAAK,IAAI,GAC7C,QAAQ,CAAC,iBAAiB,CAAC,CAE7B"}

package/build/index.js

@@ -1,58 +1,46 @@
-import ExpoLiveActivityModule from "./ExpoLiveActivityModule";
-import { Platform } from "react-native";
+import { Platform } from 'react-native';
+import ExpoLiveActivityModule from './ExpoLiveActivityModule';
+function assertIOS(name) {
+    const isIOS = Platform.OS === 'ios';
+    if (!isIOS)
+        console.error(`${name} is only available on iOS`);
+    return isIOS;
+}
 /**
  * @param {LiveActivityState} state The state for the live activity.
  * @param {LiveActivityConfig} config Live activity config object.
  * @returns {string} The identifier of the started activity or undefined if creating live activity failed.
  */
 export function startActivity(state, config) {
-    if (Platform.OS !== "ios") {
-        console.error("startActivity is only available on iOS");
-        return undefined;
-    }
-    try {
+    if (assertIOS('startActivity'))
         return ExpoLiveActivityModule.startActivity(state, config);
-    }
-    catch (error) {
-        console.error(`startActivity failed with an error: ${error}`);
-        return undefined;
-    }
 }
 /**
  * @param {string} id The identifier of the activity to stop.
  * @param {LiveActivityState} state The updated state for the live activity.
  */
 export function stopActivity(id, state) {
-    if (Platform.OS !== "ios") {
-        console.error("stopActivity is only available on iOS");
-    }
-    try {
+    if (assertIOS('stopActivity'))
         return ExpoLiveActivityModule.stopActivity(id, state);
-    }
-    catch (error) {
-        console.error(`stopActivity failed with an error: ${error}`);
-    }
 }
 /**
  * @param {string} id The identifier of the activity to update.
  * @param {LiveActivityState} state The updated state for the live activity.
  */
 export function updateActivity(id, state) {
-    if (Platform.OS !== "ios") {
-        console.error("updateActivity is only available on iOS");
-    }
-    try {
+    if (assertIOS('updateActivity'))
         return ExpoLiveActivityModule.updateActivity(id, state);
-    }
-    catch (error) {
-        console.error(`updateActivity failed with an error: ${error}`);
-    }
 }
 export function addActivityTokenListener(listener) {
-    if (Platform.OS !== "ios") {
-        console.error("addActivityTokenListener is only available on iOS");
-        return undefined;
-    }
-    return ExpoLiveActivityModule.addListener('onTokenReceived', listener);
+    if (assertIOS('addActivityTokenListener'))
+        return ExpoLiveActivityModule.addListener('onTokenReceived', listener);
+}
+export function addActivityPushToStartTokenListener(listener) {
+    if (assertIOS('addActivityPushToStartTokenListener'))
+        return ExpoLiveActivityModule.addListener('onPushToStartTokenReceived', listener);
+}
+export function addActivityUpdatesListener(listener) {
+    if (assertIOS('addActivityUpdatesListener'))
+        return ExpoLiveActivityModule.addListener('onStateChange', listener);
 }
 //# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,sBAAsB,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAgCxC;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,KAAwB,EAAE,MAA2B;IACjF,IAAI,QAAQ,CAAC,EAAE,KAAK,KAAK,EAAE,CAAC;QAC1B,OAAO,CAAC,KAAK,CAAC,wCAAwC,CAAC,CAAC;QACxD,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,IAAI,CAAC;QACH,OAAO,sBAAsB,CAAC,aAAa,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAC7D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,uCAAuC,KAAK,EAAE,CAAC,CAAC;QAC9D,OAAO,SAAS,CAAA;IAClB,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,EAAU,EAAE,KAAwB;IAC/D,IAAI,QAAQ,CAAC,EAAE,KAAK,KAAK,EAAE,CAAC;QAC1B,OAAO,CAAC,KAAK,CAAC,uCAAuC,CAAC,CAAC;IACzD,CAAC;IACD,IAAI,CAAC;QACH,OAAO,sBAAsB,CAAC,YAAY,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;IACxD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,sCAAsC,KAAK,EAAE,CAAC,CAAC;IAC/D,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,cAAc,CAAC,EAAU,EAAE,KAAwB;IACjE,IAAI,QAAQ,CAAC,EAAE,KAAK,KAAK,EAAE,CAAC;QAC1B,OAAO,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC3D,CAAC;IACD,IAAI,CAAC;QACH,OAAO,sBAAsB,CAAC,cAAc,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;IAC1D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,wCAAwC,KAAK,EAAE,CAAC,CAAC;IACjE,CAAC;AACH,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,QAAqD;IAC5F,IAAI,QAAQ,CAAC,EAAE,KAAK,KAAK,EAAE,CAAC;QAC1B,OAAO,CAAC,KAAK,CAAC,mDAAmD,CAAC,CAAC;QACnE,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,OAAO,sBAAsB,CAAC,WAAW,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;AACzE,CAAC","sourcesContent":["import ExpoLiveActivityModule from \"./ExpoLiveActivityModule\";\nimport { Platform } from \"react-native\";\nimport { EventSubscription } from 'expo-modules-core';\n\nexport type DynamicIslandTimerType = 'circular' | 'digital'\n\nexport type LiveActivityState = {\n  title: string;\n  subtitle?: string;\n  date?: number;\n  imageName?: string;\n  dynamicIslandImageName?: string;\n};\n\nexport type LiveActivityConfig = {\n  backgroundColor?: string;\n  titleColor?: string;\n  subtitleColor?: string;\n  progressViewTint?: string;\n  progressViewLabelColor?: string;\n  deepLinkUrl?: string;\n  timerType?: DynamicIslandTimerType;\n};\n\nexport type ActivityTokenReceivedEvent = {\n  activityID: string;\n  activityPushToken: string;\n};\n\nexport type LiveActivityModuleEvents = {\n  onTokenReceived: (params: ActivityTokenReceivedEvent) => void;\n};\n\n/**\n * @param {LiveActivityState} state The state for the live activity.\n * @param {LiveActivityConfig} config Live activity config object.\n * @returns {string} The identifier of the started activity or undefined if creating live activity failed.\n */\nexport function startActivity(state: LiveActivityState, config?: LiveActivityConfig): string | undefined {\n  if (Platform.OS !== \"ios\") {\n    console.error(\"startActivity is only available on iOS\");\n    return undefined\n  }\n  try {\n    return ExpoLiveActivityModule.startActivity(state, config);\n  } catch (error) {\n    console.error(`startActivity failed with an error: ${error}`);\n    return undefined\n  }\n}\n\n/**\n * @param {string} id The identifier of the activity to stop.\n * @param {LiveActivityState} state The updated state for the live activity.\n */\nexport function stopActivity(id: string, state: LiveActivityState) {\n  if (Platform.OS !== \"ios\") {\n    console.error(\"stopActivity is only available on iOS\");\n  }\n  try {\n    return ExpoLiveActivityModule.stopActivity(id, state);\n  } catch (error) {\n    console.error(`stopActivity failed with an error: ${error}`);\n  }\n}\n\n/**\n * @param {string} id The identifier of the activity to update.\n * @param {LiveActivityState} state The updated state for the live activity.\n */\nexport function updateActivity(id: string, state: LiveActivityState) {\n  if (Platform.OS !== \"ios\") {\n    console.error(\"updateActivity is only available on iOS\");\n  }\n  try {\n    return ExpoLiveActivityModule.updateActivity(id, state);\n  } catch (error) {\n    console.error(`updateActivity failed with an error: ${error}`);\n  }\n}\n\nexport function addActivityTokenListener(listener: (event: ActivityTokenReceivedEvent) => void): EventSubscription | undefined {\n  if (Platform.OS !== \"ios\") {\n    console.error(\"addActivityTokenListener is only available on iOS\");\n    return undefined\n  }\n  return ExpoLiveActivityModule.addListener('onTokenReceived', listener);\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AAEvC,OAAO,sBAAsB,MAAM,0BAA0B,CAAA;AAgD7D,SAAS,SAAS,CAAC,IAAY;IAC7B,MAAM,KAAK,GAAG,QAAQ,CAAC,EAAE,KAAK,KAAK,CAAA;IAEnC,IAAI,CAAC,KAAK;QAAE,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,2BAA2B,CAAC,CAAA;IAE7D,OAAO,KAAK,CAAA;AACd,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,KAAwB,EAAE,MAA2B;IACjF,IAAI,SAAS,CAAC,eAAe,CAAC;QAAE,OAAO,sBAAsB,CAAC,aAAa,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;AAC5F,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,EAAU,EAAE,KAAwB;IAC/D,IAAI,SAAS,CAAC,cAAc,CAAC;QAAE,OAAO,sBAAsB,CAAC,YAAY,CAAC,EAAE,EAAE,KAAK,CAAC,CAAA;AACtF,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,cAAc,CAAC,EAAU,EAAE,KAAwB;IACjE,IAAI,SAAS,CAAC,gBAAgB,CAAC;QAAE,OAAO,sBAAsB,CAAC,cAAc,CAAC,EAAE,EAAE,KAAK,CAAC,CAAA;AAC1F,CAAC;AAED,MAAM,UAAU,wBAAwB,CACtC,QAAqD;IAErD,IAAI,SAAS,CAAC,0BAA0B,CAAC;QAAE,OAAO,sBAAsB,CAAC,WAAW,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAA;AACnH,CAAC;AAED,MAAM,UAAU,mCAAmC,CACjD,QAAgE;IAEhE,IAAI,SAAS,CAAC,qCAAqC,CAAC;QAClD,OAAO,sBAAsB,CAAC,WAAW,CAAC,4BAA4B,EAAE,QAAQ,CAAC,CAAA;AACrF,CAAC;AAED,MAAM,UAAU,0BAA0B,CACxC,QAA8C;IAE9C,IAAI,SAAS,CAAC,4BAA4B,CAAC;QAAE,OAAO,sBAAsB,CAAC,WAAW,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAA;AACnH,CAAC","sourcesContent":["import { EventSubscription } from 'expo-modules-core'\nimport { Platform } from 'react-native'\n\nimport ExpoLiveActivityModule from './ExpoLiveActivityModule'\n\ntype Voidable<T> = T | void\n\nexport type DynamicIslandTimerType = 'circular' | 'digital'\n\nexport type LiveActivityState = {\n  title: string\n  subtitle?: string\n  date?: number\n  imageName?: string\n  dynamicIslandImageName?: string\n}\n\nexport type LiveActivityConfig = {\n  backgroundColor?: string\n  titleColor?: string\n  subtitleColor?: string\n  progressViewTint?: string\n  progressViewLabelColor?: string\n  deepLinkUrl?: string\n  timerType?: DynamicIslandTimerType\n}\n\nexport type ActivityTokenReceivedEvent = {\n  activityID: string\n  activityName: string\n  activityPushToken: string\n}\n\nexport type ActivityPushToStartTokenReceivedEvent = {\n  activityPushToStartToken: string\n}\n\ntype ActivityState = 'active' | 'dismissed' | 'pending' | 'stale' | 'ended'\n\nexport type ActivityUpdateEvent = {\n  activityID: string\n  activityName: string\n  activityState: ActivityState\n}\n\nexport type LiveActivityModuleEvents = {\n  onTokenReceived: (params: ActivityTokenReceivedEvent) => void\n  onPushToStartTokenReceived: (params: ActivityPushToStartTokenReceivedEvent) => void\n  onStateChange: (params: ActivityUpdateEvent) => void\n}\n\nfunction assertIOS(name: string) {\n  const isIOS = Platform.OS === 'ios'\n\n  if (!isIOS) console.error(`${name} is only available on iOS`)\n\n  return isIOS\n}\n\n/**\n * @param {LiveActivityState} state The state for the live activity.\n * @param {LiveActivityConfig} config Live activity config object.\n * @returns {string} The identifier of the started activity or undefined if creating live activity failed.\n */\nexport function startActivity(state: LiveActivityState, config?: LiveActivityConfig): Voidable<string> {\n  if (assertIOS('startActivity')) return ExpoLiveActivityModule.startActivity(state, config)\n}\n\n/**\n * @param {string} id The identifier of the activity to stop.\n * @param {LiveActivityState} state The updated state for the live activity.\n */\nexport function stopActivity(id: string, state: LiveActivityState) {\n  if (assertIOS('stopActivity')) return ExpoLiveActivityModule.stopActivity(id, state)\n}\n\n/**\n * @param {string} id The identifier of the activity to update.\n * @param {LiveActivityState} state The updated state for the live activity.\n */\nexport function updateActivity(id: string, state: LiveActivityState) {\n  if (assertIOS('updateActivity')) return ExpoLiveActivityModule.updateActivity(id, state)\n}\n\nexport function addActivityTokenListener(\n  listener: (event: ActivityTokenReceivedEvent) => void\n): Voidable<EventSubscription> {\n  if (assertIOS('addActivityTokenListener')) return ExpoLiveActivityModule.addListener('onTokenReceived', listener)\n}\n\nexport function addActivityPushToStartTokenListener(\n  listener: (event: ActivityPushToStartTokenReceivedEvent) => void\n): Voidable<EventSubscription> {\n  if (assertIOS('addActivityPushToStartTokenListener'))\n    return ExpoLiveActivityModule.addListener('onPushToStartTokenReceived', listener)\n}\n\nexport function addActivityUpdatesListener(\n  listener: (event: ActivityUpdateEvent) => void\n): Voidable<EventSubscription> {\n  if (assertIOS('addActivityUpdatesListener')) return ExpoLiveActivityModule.addListener('onStateChange', listener)\n}\n"]}

package/eslint.config.js

@@ -0,0 +1,42 @@
+const { defineConfig } = require('eslint/config')
+const expoConfig = require('eslint-config-expo/flat')
+const eslintPluginPrettierRecommended = require('eslint-plugin-prettier/recommended')
+const simpleImportSort = require('eslint-plugin-simple-import-sort')
+
+module.exports = defineConfig([
+  expoConfig,
+  eslintPluginPrettierRecommended,
+  {
+    ignores: ['build/*', 'plugin/build/*'],
+  },
+  defineConfig([
+    {
+      files: ['example/webpack.config.js'],
+      languageOptions: {
+        globals: {
+          __dirname: 'readonly',
+        },
+      },
+    },
+    {
+      basePath: 'example',
+      settings: {
+        'import/resolver': {
+          alias: {
+            map: [['expo-live-activity', './src']],
+            extensions: ['.ts'],
+          },
+        },
+      },
+    },
+    {
+      plugins: {
+        'simple-import-sort': simpleImportSort,
+      },
+      rules: {
+        'simple-import-sort/imports': 'error',
+        'simple-import-sort/exports': 'error',
+      },
+    },
+  ]),
+])