@ng-native/expo 0.3.0 → 0.4.0

package/dist/widget.js

@@ -0,0 +1,98 @@
+/**
+ * `widget`, which keeps a home screen widget from `expo-widgets` in step with a signal, and hands the
+ * app the taps on its buttons.
+ *
+ * A widget button runs in the widget extension, not in the app, which iOS keeps suspended, so a
+ * tap's own event is lost unless the app is running. The widget's layout records each tap in its
+ * own props instead, as `taps`, and `widget` collects them when the app next runs: at once while it
+ * is running, and when it comes back to the foreground. It takes the widget `createWidget` makes in
+ * the app's layout file, so this package imports `expo-widgets` only for its tap events.
+ */
+import { DestroyRef, ErrorHandler, InjectionToken, effect, inject, signal, untracked, } from '@angular/core';
+import { optional } from "./native.js";
+/** Overridden in a test to tap a widget that is not there. */
+export const WIDGET_EVENTS = new InjectionToken('angular-native.widgetEvents', {
+    factory: () => {
+        const widgets = optional(() => require('expo-widgets'));
+        const native = optional(() => require('react-native'));
+        const onState = (wanted) => (listener) => {
+            const subscription = native?.AppState.addEventListener('change', (state) => {
+                if (state === wanted)
+                    listener();
+            });
+            return () => subscription?.remove();
+        };
+        return {
+            onTap: (listener) => {
+                const subscription = widgets?.addUserInteractionListener(listener);
+                return () => subscription?.remove();
+            },
+            onForeground: onState('active'),
+            onBackground: onState('background'),
+        };
+    },
+});
+/**
+ * Shows `props` on the widget and follows the signal, and hands taps on its buttons to `onTaps`.
+ * A write replaces the props that hold the taps, so every write comes after the taps are read, and
+ * nothing is written while they cannot be; a tap is handed over once the write that clears it has
+ * worked. Going to the background asks iOS to redraw the widget, which it otherwise does on its own
+ * schedule. Destroying the injector stops both. Call it in an injection context.
+ */
+export function widget(native, props, options = {}) {
+    const errors = inject(ErrorHandler);
+    const events = inject(WIDGET_EVENTS);
+    const error = signal(null, /* @ts-ignore */
+    ...(ngDevMode ? [{ debugName: "error" }] : /* istanbul ignore next */ []));
+    let syncing = null;
+    const queued = async () => (await native.getTimeline()).at(-1)?.props.taps ?? [];
+    /** The taps, read again until no more land, since the write after it clears them. */
+    const collect = async () => {
+        let taps = await queued();
+        while (taps.length) {
+            const more = await queued();
+            if (more.length <= taps.length)
+                break;
+            taps = more;
+        }
+        return taps;
+    };
+    const hand = (taps) => {
+        try {
+            options.onTaps?.(taps);
+        }
+        catch (failure) {
+            errors.handleError(failure);
+        }
+    };
+    const run = async () => {
+        try {
+            const taps = await collect();
+            native.updateSnapshot(untracked(props));
+            error.set(null);
+            if (taps.length)
+                hand(taps);
+        }
+        catch (failure) {
+            error.set(failure);
+            errors.handleError(failure);
+        }
+    };
+    /**
+     * One sync at a time. One asked for during it is already covered: its write reads the signal then,
+     * and nothing is awaited after it.
+     */
+    const sync = () => (syncing ??= run().finally(() => (syncing = null)));
+    effect(() => {
+        props();
+        untracked(() => void sync());
+    });
+    const stops = [
+        events.onTap(() => void sync()),
+        events.onForeground(() => void sync()),
+        events.onBackground(() => native.reload()),
+    ];
+    inject(DestroyRef).onDestroy(() => stops.forEach((stop) => stop()));
+    return { error: error.asReadonly(), sync, reload: () => native.reload() };
+}
+//# sourceMappingURL=widget.js.map

package/dist/widget.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"widget.js","sourceRoot":"","sources":["../src/widget.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EACL,UAAU,EACV,YAAY,EACZ,cAAc,EACd,MAAM,EACN,MAAM,EACN,MAAM,EACN,SAAS,GAEV,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAoDvC,8DAA8D;AAC9D,MAAM,CAAC,MAAM,aAAa,GAAG,IAAI,cAAc,CAAe,6BAA6B,EAAE;IAC3F,OAAO,EAAE,GAAG,EAAE;QACZ,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,cAAc,CAAgB,CAAC,CAAC;QACvE,MAAM,MAAM,GAAG,QAAQ,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,cAAc,CAAgB,CAAC,CAAC;QACtE,MAAM,OAAO,GAAG,CAAC,MAAc,EAAE,EAAE,CAAC,CAAC,QAAoB,EAAE,EAAE;YAC3D,MAAM,YAAY,GAAG,MAAM,EAAE,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE;gBACzE,IAAI,KAAK,KAAK,MAAM;oBAAE,QAAQ,EAAE,CAAC;YACnC,CAAC,CAAC,CAAC;YACH,OAAO,GAAG,EAAE,CAAC,YAAY,EAAE,MAAM,EAAE,CAAC;QACtC,CAAC,CAAC;QACF,OAAO;YACL,KAAK,EAAE,CAAC,QAAQ,EAAE,EAAE;gBAClB,MAAM,YAAY,GAAG,OAAO,EAAE,0BAA0B,CAAC,QAAQ,CAAC,CAAC;gBACnE,OAAO,GAAG,EAAE,CAAC,YAAY,EAAE,MAAM,EAAE,CAAC;YACtC,CAAC;YACD,YAAY,EAAE,OAAO,CAAC,QAAQ,CAAC;YAC/B,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC;SACpC,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,UAAU,MAAM,CACpB,MAAuB,EACvB,KAAgB,EAChB,UAAyB,EAAE;IAE3B,MAAM,MAAM,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC;IACpC,MAAM,MAAM,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC;IACrC,MAAM,KAAK,GAAG,MAAM,CAAU,IAAI;8EAAC,CAAC;IACpC,IAAI,OAAO,GAAyB,IAAI,CAAC;IAEzC,MAAM,MAAM,GAAG,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC;IAEjF,qFAAqF;IACrF,MAAM,OAAO,GAAG,KAAK,IAAI,EAAE;QACzB,IAAI,IAAI,GAAG,MAAM,MAAM,EAAE,CAAC;QAC1B,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;YACnB,MAAM,IAAI,GAAG,MAAM,MAAM,EAAE,CAAC;YAC5B,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM;gBAAE,MAAM;YACtC,IAAI,GAAG,IAAI,CAAC;QACd,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAEF,MAAM,IAAI,GAAG,CAAC,IAAuB,EAAE,EAAE;QACvC,IAAI,CAAC;YACH,OAAO,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC;QAAC,OAAO,OAAO,EAAE,CAAC;YACjB,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,GAAG,GAAG,KAAK,IAAI,EAAE;QACrB,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,OAAO,EAAE,CAAC;YAC7B,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;YACxC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAChB,IAAI,IAAI,CAAC,MAAM;gBAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9B,CAAC;QAAC,OAAO,OAAO,EAAE,CAAC;YACjB,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACnB,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC,CAAC;IAEF;;;OAGG;IACH,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC,CAAC,OAAO,KAAK,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IAEvE,MAAM,CAAC,GAAG,EAAE;QACV,KAAK,EAAE,CAAC;QACR,SAAS,CAAC,GAAG,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH,MAAM,KAAK,GAAG;QACZ,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC;QAC/B,MAAM,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC;QACtC,MAAM,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;KAC3C,CAAC;IACF,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAEpE,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC;AAC5E,CAAC","sourcesContent":["/**\n * `widget`, which keeps a home screen widget from `expo-widgets` in step with a signal, and hands the\n * app the taps on its buttons.\n *\n * A widget button runs in the widget extension, not in the app, which iOS keeps suspended, so a\n * tap's own event is lost unless the app is running. The widget's layout records each tap in its\n * own props instead, as `taps`, and `widget` collects them when the app next runs: at once while it\n * is running, and when it comes back to the foreground. It takes the widget `createWidget` makes in\n * the app's layout file, so this package imports `expo-widgets` only for its tap events.\n */\nimport {\n  DestroyRef,\n  ErrorHandler,\n  InjectionToken,\n  effect,\n  inject,\n  signal,\n  untracked,\n  type Signal,\n} from '@angular/core';\nimport { optional } from './native.ts';\n\n/** One entry of a widget's timeline, as `expo-widgets` stores it. */\nexport interface WidgetEntry<T extends object> {\n  readonly date: Date;\n  /** The entry's props, with the targets of the buttons tapped since the app last collected them. */\n  readonly props: T & { readonly taps?: readonly string[] };\n}\n\n/** What `createWidget` answers. */\nexport interface NativeWidget<T extends object> {\n  updateSnapshot(props: T): void;\n  getTimeline(): Promise<readonly WidgetEntry<T>[]>;\n  reload(): void;\n}\n\n/** When to collect taps, and when to ask iOS to redraw the widget. */\nexport interface WidgetEvents {\n  /** A widget button was tapped while the app was running. */\n  onTap(listener: () => void): () => void;\n  onForeground(listener: () => void): () => void;\n  onBackground(listener: () => void): () => void;\n}\n\nexport interface WidgetOptions {\n  /**\n   * Called with the targets of the buttons tapped since the last call, oldest first, once the write\n   * that clears them from the widget has worked, so a tap is handed over once. A handler that throws\n   * goes to the `ErrorHandler`, and its taps are still cleared.\n   */\n  readonly onTaps?: (taps: readonly string[]) => void;\n}\n\n/** A home screen widget kept in step with a signal. */\nexport interface WidgetRef {\n  /**\n   * Why the last sync did not happen: the taps could not be read, or the widget not written. It also\n   * goes to the `ErrorHandler`, and is null again once a sync works. A failing `onTaps` is not kept\n   * here.\n   */\n  readonly error: Signal<unknown>;\n  /** Collects the taps now, then shows the signal's value. */\n  sync(): Promise<void>;\n  /** Asks iOS to redraw the widget. */\n  reload(): void;\n}\n\ntype ReactNative = typeof import('react-native');\ntype ExpoWidgets = {\n  addUserInteractionListener(listener: () => void): { remove(): void };\n};\n\n/** Overridden in a test to tap a widget that is not there. */\nexport const WIDGET_EVENTS = new InjectionToken<WidgetEvents>('angular-native.widgetEvents', {\n  factory: () => {\n    const widgets = optional(() => require('expo-widgets') as ExpoWidgets);\n    const native = optional(() => require('react-native') as ReactNative);\n    const onState = (wanted: string) => (listener: () => void) => {\n      const subscription = native?.AppState.addEventListener('change', (state) => {\n        if (state === wanted) listener();\n      });\n      return () => subscription?.remove();\n    };\n    return {\n      onTap: (listener) => {\n        const subscription = widgets?.addUserInteractionListener(listener);\n        return () => subscription?.remove();\n      },\n      onForeground: onState('active'),\n      onBackground: onState('background'),\n    };\n  },\n});\n\n/**\n * Shows `props` on the widget and follows the signal, and hands taps on its buttons to `onTaps`.\n * A write replaces the props that hold the taps, so every write comes after the taps are read, and\n * nothing is written while they cannot be; a tap is handed over once the write that clears it has\n * worked. Going to the background asks iOS to redraw the widget, which it otherwise does on its own\n * schedule. Destroying the injector stops both. Call it in an injection context.\n */\nexport function widget<T extends object>(\n  native: NativeWidget<T>,\n  props: Signal<T>,\n  options: WidgetOptions = {},\n): WidgetRef {\n  const errors = inject(ErrorHandler);\n  const events = inject(WIDGET_EVENTS);\n  const error = signal<unknown>(null);\n  let syncing: Promise<void> | null = null;\n\n  const queued = async () => (await native.getTimeline()).at(-1)?.props.taps ?? [];\n\n  /** The taps, read again until no more land, since the write after it clears them. */\n  const collect = async () => {\n    let taps = await queued();\n    while (taps.length) {\n      const more = await queued();\n      if (more.length <= taps.length) break;\n      taps = more;\n    }\n    return taps;\n  };\n\n  const hand = (taps: readonly string[]) => {\n    try {\n      options.onTaps?.(taps);\n    } catch (failure) {\n      errors.handleError(failure);\n    }\n  };\n\n  const run = async () => {\n    try {\n      const taps = await collect();\n      native.updateSnapshot(untracked(props));\n      error.set(null);\n      if (taps.length) hand(taps);\n    } catch (failure) {\n      error.set(failure);\n      errors.handleError(failure);\n    }\n  };\n\n  /**\n   * One sync at a time. One asked for during it is already covered: its write reads the signal then,\n   * and nothing is awaited after it.\n   */\n  const sync = () => (syncing ??= run().finally(() => (syncing = null)));\n\n  effect(() => {\n    props();\n    untracked(() => void sync());\n  });\n\n  const stops = [\n    events.onTap(() => void sync()),\n    events.onForeground(() => void sync()),\n    events.onBackground(() => native.reload()),\n  ];\n  inject(DestroyRef).onDestroy(() => stops.forEach((stop) => stop()));\n\n  return { error: error.asReadonly(), sync, reload: () => native.reload() };\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ng-native/expo",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Expo modules as Angular services for Angular Native, plus registerExpoView for a module's native view.",
   "keywords": [
     "angular",
@@ -196,13 +196,17 @@
       "types": "./dist/watch.d.ts",
       "default": "./dist/watch.js"
     },
+    "./widget": {
+      "types": "./dist/widget.d.ts",
+      "default": "./dist/widget.js"
+    },
     "./package.json": "./package.json"
   },
   "publishConfig": {
     "access": "public"
   },
   "dependencies": {
-    "@ng-native/fabric": "0.3.0"
+    "@ng-native/fabric": "0.4.0"
   },
   "nx": {
     "tags": [