expo-live-activity 0.4.2 → 0.5.0-alpha1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-live-activity",
-  "version": "0.4.2",
+  "version": "0.5.0-alpha1",
   "description": "A module for adding Live Activity to a React Native app for iOS.",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -8,7 +8,7 @@
     "build": "expo-module build",
     "clean": "expo-module clean",
     "clean:plugin": "rm -rf plugin/build plugin/tsconfig.tsbuildinfo",
-    "format:check": "prettier --check .",
+    "lint:fix": "expo-module eslint --fix && swiftformat --exclude \"**/node_modules/\" .",
     "lint": "expo-module eslint",
     "lint:libOnly": "expo-module eslint --ignore-pattern 'example/*'",
     "test": "expo-module test",
@@ -16,7 +16,10 @@
     "prepublishOnly": "expo-module prepublishOnly",
     "expo-module": "expo-module",
     "open:ios": "xed example/ios",
-    "typecheck": "tsc"
+    "typecheck": "tsc",
+    "generateTests": "node ./example/tests/scripts/generateFlows.js",
+    "runAllTests": "./example/tests/scripts/runAllTests.sh",
+    "generateTestReport": "node ./example/tests/scripts/generateReport.js"
   },
   "keywords": [
     "react-native",
@@ -47,7 +50,8 @@
     "expo": "~54.0.0",
     "expo-module-scripts": "^5.0.3",
     "prettier": "^3.6.2",
-    "react-native": "0.81.4"
+    "react-native": "0.81.4",
+    "pdf-lib": "^1.17.1"
   },
   "peerDependencies": {
     "expo": "*",

package/plugin/build/index.js

@@ -7,6 +7,7 @@ const config_plugins_1 = require("expo/config-plugins");
 const withConfig_1 = require("./withConfig");
 const withPlist_1 = __importDefault(require("./withPlist"));
 const withPushNotifications_1 = require("./withPushNotifications");
+const withUnsupportedOS_1 = require("./withUnsupportedOS");
 const withWidgetExtensionEntitlements_1 = require("./withWidgetExtensionEntitlements");
 const withXcode_1 = require("./withXcode");
 const withWidgetsAndLiveActivities = (config, props) => {
@@ -37,6 +38,7 @@ const withWidgetsAndLiveActivities = (config, props) => {
     if (props?.enablePushNotifications) {
         config = (0, withPushNotifications_1.withPushNotifications)(config);
     }
+    config = (0, withUnsupportedOS_1.withUnsupportedOS)(config, { silentOnUnsupportedOS: props?.silentOnUnsupportedOS ?? false });
     return config;
 };
 exports.default = withWidgetsAndLiveActivities;

package/plugin/build/lib/getWidgetFiles.js

@@ -102,7 +102,7 @@ function getWidgetFiles(targetPath) {
         const imagesXcassetsTarget = path.join(targetPath, 'Assets.xcassets');
         const files = fs.readdirSync(imageAssetsPath);
         files.forEach((file) => {
-            if (path.extname(file).match(/\.(png|jpg|jpeg)$/)) {
+            if (path.extname(file).match(/\.(png|jpg|jpeg|svg)$/)) {
                 const source = path.join(imageAssetsPath, file);
                 const imageSetDir = path.join(imagesXcassetsTarget, `${path.basename(file, path.extname(file))}.imageset`);
                 // Create the .imageset directory if it doesn't exist

package/plugin/build/types.d.ts

@@ -1,6 +1,7 @@
 import { ConfigPlugin } from '@expo/config-plugins';
 interface ConfigPluginProps {
     enablePushNotifications?: boolean;
+    silentOnUnsupportedOS?: boolean;
 }
 export type LiveActivityConfigPlugin = ConfigPlugin<ConfigPluginProps | undefined>;
 export {};

package/plugin/build/withUnsupportedOS.d.ts

@@ -0,0 +1,4 @@
+import { ConfigPlugin } from '@expo/config-plugins';
+export declare const withUnsupportedOS: ConfigPlugin<{
+    silentOnUnsupportedOS: boolean;
+}>;

package/plugin/build/withUnsupportedOS.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withUnsupportedOS = void 0;
+const config_plugins_1 = require("@expo/config-plugins");
+const withUnsupportedOS = (config, { silentOnUnsupportedOS }) => (0, config_plugins_1.withInfoPlist)(config, (mod) => {
+    mod.modResults['ExpoLiveActivity_SilentOnUnsupportedOS'] = silentOnUnsupportedOS;
+    return mod;
+});
+exports.withUnsupportedOS = withUnsupportedOS;

package/plugin/src/index.ts

@@ -4,6 +4,7 @@ import type { LiveActivityConfigPlugin } from './types'
 import { withConfig } from './withConfig'
 import withPlist from './withPlist'
 import { withPushNotifications } from './withPushNotifications'
+import { withUnsupportedOS } from './withUnsupportedOS'
 import { withWidgetExtensionEntitlements } from './withWidgetExtensionEntitlements'
 import { withXcode } from './withXcode'
 
@@ -39,6 +40,8 @@ const withWidgetsAndLiveActivities: LiveActivityConfigPlugin = (config, props) =
     config = withPushNotifications(config)
   }
 
+  config = withUnsupportedOS(config, { silentOnUnsupportedOS: props?.silentOnUnsupportedOS ?? false })
+
   return config
 }
 

package/plugin/src/lib/getWidgetFiles.ts

@@ -78,7 +78,7 @@ export function getWidgetFiles(targetPath: string) {
     const files = fs.readdirSync(imageAssetsPath)
 
     files.forEach((file) => {
-      if (path.extname(file).match(/\.(png|jpg|jpeg)$/)) {
+      if (path.extname(file).match(/\.(png|jpg|jpeg|svg)$/)) {
         const source = path.join(imageAssetsPath, file)
         const imageSetDir = path.join(imagesXcassetsTarget, `${path.basename(file, path.extname(file))}.imageset`)
 

package/plugin/src/types.ts

@@ -2,6 +2,7 @@ import { ConfigPlugin } from '@expo/config-plugins'
 
 interface ConfigPluginProps {
   enablePushNotifications?: boolean
+  silentOnUnsupportedOS?: boolean
 }
 
 export type LiveActivityConfigPlugin = ConfigPlugin<ConfigPluginProps | undefined>

package/plugin/src/withUnsupportedOS.ts

@@ -0,0 +1,10 @@
+import { ConfigPlugin, withInfoPlist } from '@expo/config-plugins'
+
+export const withUnsupportedOS: ConfigPlugin<{ silentOnUnsupportedOS: boolean }> = (
+  config,
+  { silentOnUnsupportedOS }
+) =>
+  withInfoPlist(config, (mod) => {
+    mod.modResults['ExpoLiveActivity_SilentOnUnsupportedOS'] = silentOnUnsupportedOS
+    return mod
+  })

package/plugin/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["./src/index.ts","./src/types.ts","./src/withConfig.ts","./src/withPlist.ts","./src/withPushNotifications.ts","./src/withWidgetExtensionEntitlements.ts","./src/withXcode.ts","./src/lib/getWidgetExtensionEntitlements.ts","./src/lib/getWidgetFiles.ts","./src/xcode/addBuildPhases.ts","./src/xcode/addPbxGroup.ts","./src/xcode/addProductFile.ts","./src/xcode/addTargetDependency.ts","./src/xcode/addToPbxNativeTargetSection.ts","./src/xcode/addToPbxProjectSection.ts","./src/xcode/addXCConfigurationList.ts"],"version":"5.8.3"}
+{"root":["./src/index.ts","./src/types.ts","./src/withConfig.ts","./src/withPlist.ts","./src/withPushNotifications.ts","./src/withUnsupportedOS.ts","./src/withWidgetExtensionEntitlements.ts","./src/withXcode.ts","./src/lib/getWidgetExtensionEntitlements.ts","./src/lib/getWidgetFiles.ts","./src/xcode/addBuildPhases.ts","./src/xcode/addPbxGroup.ts","./src/xcode/addProductFile.ts","./src/xcode/addTargetDependency.ts","./src/xcode/addToPbxNativeTargetSection.ts","./src/xcode/addToPbxProjectSection.ts","./src/xcode/addXCConfigurationList.ts"],"version":"5.8.3"}

package/src/index.ts

@@ -7,14 +7,38 @@ type Voidable<T> = T | void
 
 export type DynamicIslandTimerType = 'circular' | 'digital'
 
+export type ElapsedTimer = {
+  startDate: number // milliseconds timestamp (past time when timer started)
+}
+
 type ProgressBarType =
   | {
       date?: number
       progress?: undefined
+      elapsedTimer?: undefined
+      currentStep?: undefined
+      totalSteps?: undefined
     }
   | {
       date?: undefined
       progress?: number
+      elapsedTimer?: undefined
+      currentStep?: undefined
+      totalSteps?: undefined
+    }
+  | {
+      date?: undefined
+      progress?: undefined
+      elapsedTimer?: ElapsedTimer
+      currentStep?: undefined
+      totalSteps?: undefined
+    }
+  | {
+      date?: undefined
+      progress?: undefined
+      elapsedTimer?: undefined
+      currentStep?: number
+      totalSteps?: number
     }
 
 export type LiveActivityState = {
@@ -23,6 +47,7 @@ export type LiveActivityState = {
   progressBar?: ProgressBarType
   imageName?: string
   dynamicIslandImageName?: string
+  smallImageName?: string
 }
 
 export type NativeLiveActivityState = {
@@ -51,8 +76,8 @@ export type ImageAlign = 'top' | 'center' | 'bottom'
 
 export type ImageDimension = number | `${number}%`
 export type ImageSize = {
-  width: ImageDimension
-  height: ImageDimension
+  width?: ImageDimension
+  height?: ImageDimension
 }
 
 export type ImageContentFit = 'cover' | 'contain' | 'fill' | 'none' | 'scale-down'
@@ -69,7 +94,10 @@ export type LiveActivityConfig = {
   imagePosition?: ImagePosition
   imageAlign?: ImageAlign
   imageSize?: ImageSize
+  smallImageSize?: ImageSize
   contentFit?: ImageContentFit
+  progressSegmentActiveColor?: string
+  progressSegmentInactiveColor?: string
 }
 
 export type ActivityTokenReceivedEvent = {
@@ -79,7 +107,7 @@ export type ActivityTokenReceivedEvent = {
 }
 
 export type ActivityPushToStartTokenReceivedEvent = {
-  activityPushToStartToken: string
+  activityPushToStartToken: string | null
 }
 
 type ActivityState = 'active' | 'dismissed' | 'pending' | 'stale' | 'ended'
@@ -107,15 +135,24 @@ function assertIOS(name: string) {
 function normalizeConfig(config?: LiveActivityConfig) {
   if (config === undefined) return config
 
-  const { padding, imageSize, ...base } = config
+  const { padding, imageSize, smallImageSize, progressSegmentActiveColor, progressSegmentInactiveColor, ...base } =
+    config
   type NormalizedConfig = LiveActivityConfig & {
     paddingDetails?: Padding
     imageWidth?: number
     imageHeight?: number
     imageWidthPercent?: number
     imageHeightPercent?: number
+    smallImageWidth?: number
+    smallImageHeight?: number
+    smallImageWidthPercent?: number
+    smallImageHeightPercent?: number
+  }
+  const normalized: NormalizedConfig = {
+    ...base,
+    progressSegmentActiveColor,
+    progressSegmentInactiveColor,
   }
-  const normalized: NormalizedConfig = { ...base }
 
   // Normalize padding: keep number in padding, object in paddingDetails
   if (typeof padding === 'number') {
@@ -124,33 +161,38 @@ function normalizeConfig(config?: LiveActivityConfig) {
     normalized.paddingDetails = padding
   }
 
-  // Normalize imageSize: object with width/height each a number (points) or percent string like '50%'
-  if (imageSize) {
+  // Helper to parse a dimension value (number or percent string like '50%')
+  const parseDimension = (
+    value: ImageDimension | undefined,
+    fieldName: string
+  ): { absolute?: number; percent?: number } => {
+    if (value === undefined) return {}
+
+    if (typeof value === 'number') return { absolute: value }
     const regExp = /^(100(?:\.0+)?|\d{1,2}(?:\.\d+)?)%$/ // Matches 0.0% to 100.0%
+    const match = value.trim().match(regExp)
+    if (match) return { percent: Number(match[1]) }
+    throw new Error(`${fieldName} percent string must be in format "0%" to "100%"`)
+  }
 
-    const { width, height } = imageSize
-
-    if (typeof width === 'number') {
-      normalized.imageWidth = width
-    } else if (typeof width === 'string') {
-      const match = width.trim().match(regExp)
-      if (match) {
-        normalized.imageWidthPercent = Number(match[1])
-      } else {
-        throw new Error('imageSize.width percent string must be in format "0%" to "100%"')
-      }
-    }
+  // Normalize imageSize
+  if (imageSize) {
+    const w = parseDimension(imageSize.width, 'imageSize.width')
+    const h = parseDimension(imageSize.height, 'imageSize.height')
+    if (w.absolute !== undefined) normalized.imageWidth = w.absolute
+    if (w.percent !== undefined) normalized.imageWidthPercent = w.percent
+    if (h.absolute !== undefined) normalized.imageHeight = h.absolute
+    if (h.percent !== undefined) normalized.imageHeightPercent = h.percent
+  }
 
-    if (typeof height === 'number') {
-      normalized.imageHeight = height
-    } else if (typeof height === 'string') {
-      const match = height.trim().match(regExp)
-      if (match) {
-        normalized.imageHeightPercent = Number(match[1])
-      } else {
-        throw new Error('imageSize.height percent string must be in format "0%" to "100%"')
-      }
-    }
+  // Normalize smallImageSize
+  if (smallImageSize) {
+    const w = parseDimension(smallImageSize.width, 'smallImageSize.width')
+    const h = parseDimension(smallImageSize.height, 'smallImageSize.height')
+    if (w.absolute !== undefined) normalized.smallImageWidth = w.absolute
+    if (w.percent !== undefined) normalized.smallImageWidthPercent = w.percent
+    if (h.absolute !== undefined) normalized.smallImageHeight = h.absolute
+    if (h.percent !== undefined) normalized.smallImageHeightPercent = h.percent
   }
 
   return normalized
@@ -181,12 +223,21 @@ export function updateActivity(id: string, state: LiveActivityState) {
   if (assertIOS('updateActivity')) return ExpoLiveActivityModule.updateActivity(id, state)
 }
 
+/**
+ * @param {function} updateTokenListener The listener function that will be called when an update token is received.
+ */
 export function addActivityTokenListener(
-  listener: (event: ActivityTokenReceivedEvent) => void
+  updateTokenListener: (event: ActivityTokenReceivedEvent) => void
 ): Voidable<EventSubscription> {
-  if (assertIOS('addActivityTokenListener')) return ExpoLiveActivityModule.addListener('onTokenReceived', listener)
+  if (assertIOS('addActivityTokenListener'))
+    return ExpoLiveActivityModule.addListener('onTokenReceived', updateTokenListener)
 }
 
+/**
+ * Adds a listener that is called when a push-to-start token is received. Supported only on iOS > 17.2.
+ * On earlier iOS versions, the listener will return null as a token.
+ * @param {function} listener The listener function that will be called when the observer starts and then when a push-to-start token is received.
+ */
 export function addActivityPushToStartTokenListener(
   listener: (event: ActivityPushToStartTokenReceivedEvent) => void
 ): Voidable<EventSubscription> {
@@ -194,8 +245,12 @@ export function addActivityPushToStartTokenListener(
     return ExpoLiveActivityModule.addListener('onPushToStartTokenReceived', listener)
 }
 
+/**
+ * @param {function} statusListener The listener function that will be called when an activity status changes.
+ */
 export function addActivityUpdatesListener(
-  listener: (event: ActivityUpdateEvent) => void
+  statusListener: (event: ActivityUpdateEvent) => void
 ): Voidable<EventSubscription> {
-  if (assertIOS('addActivityUpdatesListener')) return ExpoLiveActivityModule.addListener('onStateChange', listener)
+  if (assertIOS('addActivityUpdatesListener'))
+    return ExpoLiveActivityModule.addListener('onStateChange', statusListener)
 }

package/.prettierignore

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