expo-live-activity 0.2.0-alpha4 → 0.2.0

package/README.md

@@ -12,9 +12,11 @@
 - 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**. When methods are invoked on platforms other than iOS, they will throw an error, ensuring that they are used in the correct context.
+**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:
 
 ### Step 1: Installation
@@ -33,49 +35,41 @@ The module comes with a built-in config plugin that creates a target in iOS with
       }
    }
    ```
+   If you want to update Live Acitivity with push notifications you can add option `"enablePushNotifications": true`:
+   ```json
+   {
+    "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  
+```
+
 ### 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";
 ```
 
-## Push notifications
-By default, updating live activity is possible only via API. There is also a way to update live activity using push notifications. To enable that feature, add `"enablePushNotifications": true`. Then, the notification payload should be looking like this:
-
-```json
-{
-    "aps":{
-        "event":"update",
-        "content-state":{
-            "title":"Hello",
-            "subtitle":"World",
-            "date":1754064245000
-        },
-        "timestamp":1754063621319
-    }
-}
-```
-
-Where `date` 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 for that:
-- `imageName`
-- `dynamicIslandImageName`
-Currently, it's possible to set them only via API, but we plan on to add that feature to push notifications as well. The value of each field can be:
-- a string which maps to an asset name
-- a URL to remote image
-The latter requires adding "App Groups" capability to both "main app" and "live activity" targets.
-
 ## API
 `expo-live-activity` module exports three primary functions to manage live activities:
 
 ### Managing Live Activities
-- **`startActivity(state: LiveActivityState, config?: LiveActivityConfig)`**:
-  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.
+- **`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`.
 
 - **`updateActivity(id: string, state: LiveActivityState)`**:
   Update an existing live activity. The `state` object should contain updated information. The `activityId` indicates which activity should be updated.
@@ -84,9 +78,10 @@ The latter requires adding "App Groups" capability to both "main app" and "live
   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
-- **`addActivityTokenListener(listener: (event: ActivityTokenReceivedEvent) => void): EventSubscription)`**:
+- **`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. 
 
@@ -96,7 +91,7 @@ The `state` object should include:
 {
   title: string;
   subtitle?: string;
-  date?: number; // Set as epoch time in milliseconds
+  date?: number; // Set as epoch time in milliseconds. This is used as an end date in a timer.
   imageName?: string; // Matches the name of the image in 'assets/live-activity'
   dynamicIslandImageName?: string; // Matches the name of the image in 'assets/live-activity'
 };
@@ -119,7 +114,7 @@ The `config` object should include:
 ## Example Usage
 Managing a live activity:
 ```javascript
-const state = {
+const state: LiveActivity.LiveActivityState = {
   title: "Title",
   subtitle: "This is a subtitle",
   date: new Date(Date.now() + 60 * 1000 * 5).getTime(),
@@ -127,7 +122,7 @@ const state = {
   dynamicIslandImageName: "dynamic_island_image"
 };
 
-const config = {
+const config: LiveActivity.LiveActivityConfig = {
   backgroundColor: "#FFFFFF",
   titleColor: "#000000",
   subtitleColor: "#333333",
@@ -152,6 +147,39 @@ useEffect(() => {
     // Send token to a remote server to update live activity with push notifications
   });
 
-  return () => subscription.remove();
+  return () => subscription?.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:
+
+```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.

package/build/index.d.ts

@@ -26,21 +26,18 @@ export type LiveActivityModuleEvents = {
 /**
  * @param {LiveActivityState} state The state for the live activity.
  * @param {LiveActivityConfig} config Live activity config object.
- * @returns {string} The identifier of the started activity.
- * @throws {Error} When function is called on a platform different from iOS.
+ * @returns {string} The identifier of the started activity or undefined if creating live activity failed.
  */
-export declare function startActivity(state: LiveActivityState, config?: LiveActivityConfig): string;
+export declare function startActivity(state: LiveActivityState, config?: LiveActivityConfig): string | undefined;
 /**
  * @param {string} id The identifier of the activity to stop.
  * @param {LiveActivityState} state The updated state for the live activity.
- * @throws {Error} When function is called on a platform different from iOS.
  */
 export declare function stopActivity(id: string, state: LiveActivityState): any;
 /**
  * @param {string} id The identifier of the activity to update.
  * @param {LiveActivityState} state The updated state for the live activity.
- * @throws {Error} When function is called on a platform different from iOS.
  */
 export declare function updateActivity(id: string, state: LiveActivityState): any;
-export declare function addActivityTokenListener(listener: (event: ActivityTokenReceivedEvent) => void): EventSubscription;
+export declare function addActivityTokenListener(listener: (event: ActivityTokenReceivedEvent) => void): EventSubscription | undefined;
 //# 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;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,iBAAiB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,MAAM,CAK3F;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB,OAKhE;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB,OAKlE;AAED,wBAAgB,wBAAwB,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,0BAA0B,KAAK,IAAI,GAAG,iBAAiB,CAKjH"}
+{"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"}

package/build/index.js

@@ -3,40 +3,55 @@ import { Platform } from "react-native";
 /**
  * @param {LiveActivityState} state The state for the live activity.
  * @param {LiveActivityConfig} config Live activity config object.
- * @returns {string} The identifier of the started activity.
- * @throws {Error} When function is called on a platform different from iOS.
+ * @returns {string} The identifier of the started activity or undefined if creating live activity failed.
  */
 export function startActivity(state, config) {
     if (Platform.OS !== "ios") {
-        throw new Error("startActivity is only available on iOS");
+        console.error("startActivity is only available on iOS");
+        return undefined;
+    }
+    try {
+        return ExpoLiveActivityModule.startActivity(state, config);
+    }
+    catch (error) {
+        console.error(`startActivity failed with an error: ${error}`);
+        return undefined;
     }
-    return ExpoLiveActivityModule.startActivity(state, config);
 }
 /**
  * @param {string} id The identifier of the activity to stop.
  * @param {LiveActivityState} state The updated state for the live activity.
- * @throws {Error} When function is called on a platform different from iOS.
  */
 export function stopActivity(id, state) {
     if (Platform.OS !== "ios") {
-        throw new Error("stopActivity is only available on iOS");
+        console.error("stopActivity is only available on iOS");
+    }
+    try {
+        return ExpoLiveActivityModule.stopActivity(id, state);
+    }
+    catch (error) {
+        console.error(`stopActivity failed with an error: ${error}`);
     }
-    return ExpoLiveActivityModule.stopActivity(id, state);
 }
 /**
  * @param {string} id The identifier of the activity to update.
  * @param {LiveActivityState} state The updated state for the live activity.
- * @throws {Error} When function is called on a platform different from iOS.
  */
 export function updateActivity(id, state) {
     if (Platform.OS !== "ios") {
-        throw new Error("updateActivity is only available on iOS");
+        console.error("updateActivity is only available on iOS");
+    }
+    try {
+        return ExpoLiveActivityModule.updateActivity(id, state);
+    }
+    catch (error) {
+        console.error(`updateActivity failed with an error: ${error}`);
     }
-    return ExpoLiveActivityModule.updateActivity(id, state);
 }
 export function addActivityTokenListener(listener) {
     if (Platform.OS !== "ios") {
-        throw new Error("updateActivity is only available on iOS");
+        console.error("addActivityTokenListener is only available on iOS");
+        return undefined;
     }
     return ExpoLiveActivityModule.addListener('onTokenReceived', listener);
 }

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;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,KAAwB,EAAE,MAA2B;IACjF,IAAI,QAAQ,CAAC,EAAE,KAAK,KAAK,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;IAC5D,CAAC;IACD,OAAO,sBAAsB,CAAC,aAAa,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;AAC7D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,EAAU,EAAE,KAAwB;IAC/D,IAAI,QAAQ,CAAC,EAAE,KAAK,KAAK,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;IAC3D,CAAC;IACD,OAAO,sBAAsB,CAAC,YAAY,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;AACxD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,EAAU,EAAE,KAAwB;IACjE,IAAI,QAAQ,CAAC,EAAE,KAAK,KAAK,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC7D,CAAC;IACD,OAAO,sBAAsB,CAAC,cAAc,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;AAC1D,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,QAAqD;IAC5F,IAAI,QAAQ,CAAC,EAAE,KAAK,KAAK,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC7D,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.\n * @throws {Error} When function is called on a platform different from iOS.\n */\nexport function startActivity(state: LiveActivityState, config?: LiveActivityConfig): string {\n  if (Platform.OS !== \"ios\") {\n    throw new Error(\"startActivity is only available on iOS\");\n  }\n  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 * @throws {Error} When function is called on a platform different from iOS.\n */\nexport function stopActivity(id: string, state: LiveActivityState) {\n  if (Platform.OS !== \"ios\") {\n    throw new Error(\"stopActivity is only available on iOS\");\n  }\n  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 * @throws {Error} When function is called on a platform different from iOS.\n */\nexport function updateActivity(id: string, state: LiveActivityState) {\n  if (Platform.OS !== \"ios\") {\n    throw new Error(\"updateActivity is only available on iOS\");\n  }\n  return ExpoLiveActivityModule.updateActivity(id, state);\n}\n\nexport function addActivityTokenListener(listener: (event: ActivityTokenReceivedEvent) => void): EventSubscription {\n  if (Platform.OS !== \"ios\") {\n    throw new Error(\"updateActivity is only available on iOS\");\n  }\n  return ExpoLiveActivityModule.addListener('onTokenReceived', listener);\n}\n"]}
+{"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"]}

package/ios/ExpoLiveActivityModule.swift

@@ -1,9 +1,10 @@
 import ActivityKit
 import ExpoModulesCore
 
-enum ModuleErrors: Error {
-  case unsupported
-  case liveActivitiesNotEnabled
+enum LiveActivityErrors: Error {
+    case unsupportedOS
+    case liveActivitiesNotEnabled
+    case unexpetedError(Error)
 }
 
 public class ExpoLiveActivityModule: Module {
@@ -62,10 +63,6 @@ public class ExpoLiveActivityModule: Module {
     )
   }
 
-  func toContentStateDate(date: Double?) -> Date? {
-    return date.map { Date(timeIntervalSince1970: $0 / 1000) }
-  }
-
   func updateImages(state: LiveActivityState, newState: inout LiveActivityAttributes.ContentState) async throws {
     if let name = state.imageName {
       print("imageName: \(name)")
@@ -102,7 +99,7 @@ public class ExpoLiveActivityModule: Module {
             let initialState = LiveActivityAttributes.ContentState(
               title: state.title,
               subtitle: state.subtitle,
-              date: toContentStateDate(date: state.date),
+              timerEndDateInMilliseconds: state.date,
             )
             let pushNotificationsEnabled =
               Bundle.main.object(forInfoDictionaryKey: "ExpoLiveActivity_EnablePushNotifications") as? Bool
@@ -129,11 +126,12 @@ public class ExpoLiveActivityModule: Module {
             return activity.id
           } catch (let error) {
             print("Error with live activity: \(error)")
+            throw LiveActivityErrors.unexpetedError(error)
           }
         }
-        throw ModuleErrors.liveActivitiesNotEnabled
+        throw LiveActivityErrors.liveActivitiesNotEnabled
       } else {
-        throw ModuleErrors.unsupported
+        throw LiveActivityErrors.unsupportedOS
       }
     }
 
@@ -143,7 +141,7 @@ public class ExpoLiveActivityModule: Module {
         var newState = LiveActivityAttributes.ContentState(
           title: state.title,
           subtitle: state.subtitle,
-          date: toContentStateDate(date: state.date),
+          timerEndDateInMilliseconds: state.date,
         )
         if let activity = Activity<LiveActivityAttributes>.activities.first(where: {
           $0.id == activityId
@@ -160,7 +158,7 @@ public class ExpoLiveActivityModule: Module {
           print("Didn't find activity with ID \(activityId)")
         }
       } else {
-        throw ModuleErrors.unsupported
+        throw LiveActivityErrors.unsupportedOS
       }
     }
 
@@ -170,7 +168,7 @@ public class ExpoLiveActivityModule: Module {
         var newState = LiveActivityAttributes.ContentState(
           title: state.title,
           subtitle: state.subtitle,
-          date: toContentStateDate(date: state.date),
+          timerEndDateInMilliseconds: state.date,
         )
         if let activity = Activity<LiveActivityAttributes>.activities.first(where: {
           $0.id == activityId
@@ -184,7 +182,7 @@ public class ExpoLiveActivityModule: Module {
           print("Didn't find activity with ID \(activityId)")
         }
       } else {
-        throw ModuleErrors.unsupported
+        throw LiveActivityErrors.unsupportedOS
       }
     }
   }

package/ios/LiveActivityAttributes.swift

@@ -12,7 +12,7 @@ struct LiveActivityAttributes: ActivityAttributes {
   public struct ContentState: Codable, Hashable {
     var title: String
     var subtitle: String?
-    var date: Date?
+    var timerEndDateInMilliseconds: Double?
     var imageName: String?
     var dynamicIslandImageName: String?
   }
@@ -24,7 +24,7 @@ struct LiveActivityAttributes: ActivityAttributes {
   var progressViewTint: String?
   var progressViewLabelColor: String?
   var deepLinkUrl: String?
-  var timerType: DynamicIslandTimerType
+  var timerType: DynamicIslandTimerType?
 
   enum DynamicIslandTimerType: String, Codable {
     case circular

package/ios-files/LiveActivityView.swift

@@ -54,7 +54,7 @@ import WidgetKit
           }
         }
 
-        if let date = contentState.date {
+        if let date = contentState.timerEndDateInMilliseconds {
           ProgressView(timerInterval: Date.toTimerInterval(miliseconds: date))
             .tint(progressViewTint)
             .modifier(ConditionalForegroundViewModifier(color: attributes.progressViewLabelColor))

package/ios-files/LiveActivityWidget.swift

@@ -13,7 +13,7 @@ struct LiveActivityAttributes: ActivityAttributes {
   public struct ContentState: Codable, Hashable {
     var title: String
     var subtitle: String?
-    var date: Double?
+    var timerEndDateInMilliseconds: Double?
     var imageName: String?
     var dynamicIslandImageName: String?
   }
@@ -25,7 +25,7 @@ struct LiveActivityAttributes: ActivityAttributes {
   var progressViewTint: String?
   var progressViewLabelColor: String?
   var deepLinkUrl: String?
-  var timerType: DynamicIslandTimerType
+  var timerType: DynamicIslandTimerType?
 
   enum DynamicIslandTimerType: String, Codable {
     case circular
@@ -58,7 +58,7 @@ struct LiveActivityWidget: Widget {
           }
         }
         DynamicIslandExpandedRegion(.bottom) {
-          if let date = context.state.date {
+          if let date = context.state.timerEndDateInMilliseconds {
             dynamicIslandExpandedBottom(endDate: date, progressViewTint: context.attributes.progressViewTint)
               .padding(.horizontal, 5)
               .applyWidgetURL(from: context.attributes.deepLinkUrl)
@@ -71,18 +71,18 @@ struct LiveActivityWidget: Widget {
             .applyWidgetURL(from: context.attributes.deepLinkUrl)
         }
       } compactTrailing: {
-        if let date = context.state.date {
+        if let date = context.state.timerEndDateInMilliseconds {
           compactTimer(
             endDate: date,
-            timerType: context.attributes.timerType,
+            timerType: context.attributes.timerType ?? .circular,
             progressViewTint: context.attributes.progressViewTint
           ).applyWidgetURL(from: context.attributes.deepLinkUrl)
         }
       } minimal: {
-        if let date = context.state.date {
+        if let date = context.state.timerEndDateInMilliseconds {
           compactTimer(
             endDate: date,
-            timerType: context.attributes.timerType,
+            timerType: context.attributes.timerType ?? .circular,
             progressViewTint: context.attributes.progressViewTint
           ).applyWidgetURL(from: context.attributes.deepLinkUrl)
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-live-activity",
-  "version": "0.2.0-alpha4",
+  "version": "0.2.0",
   "description": "A module for adding Live Activity to a React Native app for iOS.",
   "main": "build/index.js",
   "types": "build/index.d.ts",

package/plugin/build/lib/getWidgetFiles.js

@@ -97,7 +97,7 @@ function getWidgetFiles(targetPath) {
     const imagesXcassetsSource = path.join(liveActivityFilesPath, "Assets.xcassets");
     copyFolderRecursiveSync(imagesXcassetsSource, targetPath);
     // Move images to assets directory
-    if (fs.lstatSync(imageAssetsPath).isDirectory()) {
+    if (fs.existsSync(imageAssetsPath) && fs.lstatSync(imageAssetsPath).isDirectory()) {
         const imagesXcassetsTarget = path.join(targetPath, "Assets.xcassets");
         const files = fs.readdirSync(imageAssetsPath);
         files.forEach((file) => {
@@ -128,6 +128,9 @@ function getWidgetFiles(targetPath) {
             }
         });
     }
+    else {
+        console.warn(`Warning: Skipping adding images to live activity because directory does not exist at path: ${imageAssetsPath}`);
+    }
     return widgetFiles;
 }
 function copyFileSync(source, target) {

package/plugin/src/lib/getWidgetFiles.ts

@@ -75,7 +75,7 @@ export function getWidgetFiles(
   copyFolderRecursiveSync(imagesXcassetsSource, targetPath);
 
   // Move images to assets directory
-  if (fs.lstatSync(imageAssetsPath).isDirectory()) {
+  if (fs.existsSync(imageAssetsPath) && fs.lstatSync(imageAssetsPath).isDirectory()) {
     const imagesXcassetsTarget = path.join(targetPath, "Assets.xcassets");
 
     const files = fs.readdirSync(imageAssetsPath);
@@ -114,6 +114,8 @@ export function getWidgetFiles(
         );
       }
     })
+  } else {
+    console.warn(`Warning: Skipping adding images to live activity because directory does not exist at path: ${imageAssetsPath}`);
   }
 
   return widgetFiles;

package/src/index.ts

@@ -34,43 +34,55 @@ export type LiveActivityModuleEvents = {
 /**
  * @param {LiveActivityState} state The state for the live activity.
  * @param {LiveActivityConfig} config Live activity config object.
- * @returns {string} The identifier of the started activity.
- * @throws {Error} When function is called on a platform different from iOS.
+ * @returns {string} The identifier of the started activity or undefined if creating live activity failed.
  */
-export function startActivity(state: LiveActivityState, config?: LiveActivityConfig): string {
+export function startActivity(state: LiveActivityState, config?: LiveActivityConfig): string | undefined {
   if (Platform.OS !== "ios") {
-    throw new Error("startActivity is only available on iOS");
+    console.error("startActivity is only available on iOS");
+    return undefined
+  }
+  try {
+    return ExpoLiveActivityModule.startActivity(state, config);
+  } catch (error) {
+    console.error(`startActivity failed with an error: ${error}`);
+    return undefined
   }
-  return ExpoLiveActivityModule.startActivity(state, config);
 }
 
 /**
  * @param {string} id The identifier of the activity to stop.
  * @param {LiveActivityState} state The updated state for the live activity.
- * @throws {Error} When function is called on a platform different from iOS.
  */
 export function stopActivity(id: string, state: LiveActivityState) {
   if (Platform.OS !== "ios") {
-    throw new Error("stopActivity is only available on iOS");
+    console.error("stopActivity is only available on iOS");
+  }
+  try {
+    return ExpoLiveActivityModule.stopActivity(id, state);
+  } catch (error) {
+    console.error(`stopActivity failed with an error: ${error}`);
   }
-  return ExpoLiveActivityModule.stopActivity(id, state);
 }
 
 /**
  * @param {string} id The identifier of the activity to update.
  * @param {LiveActivityState} state The updated state for the live activity.
- * @throws {Error} When function is called on a platform different from iOS.
  */
 export function updateActivity(id: string, state: LiveActivityState) {
   if (Platform.OS !== "ios") {
-    throw new Error("updateActivity is only available on iOS");
+    console.error("updateActivity is only available on iOS");
+  }
+  try {
+    return ExpoLiveActivityModule.updateActivity(id, state);
+  } catch (error) {
+    console.error(`updateActivity failed with an error: ${error}`);
   }
-  return ExpoLiveActivityModule.updateActivity(id, state);
 }
 
-export function addActivityTokenListener(listener: (event: ActivityTokenReceivedEvent) => void): EventSubscription {
+export function addActivityTokenListener(listener: (event: ActivityTokenReceivedEvent) => void): EventSubscription | undefined {
   if (Platform.OS !== "ios") {
-    throw new Error("updateActivity is only available on iOS");
+    console.error("addActivityTokenListener is only available on iOS");
+    return undefined
   }
   return ExpoLiveActivityModule.addListener('onTokenReceived', listener);
 }