@dxos/plugin-pwa 0.9.1-staging.ee54ba693a → 0.11.0

package/dist/lib/PwaPlugin.mjs

@@ -0,0 +1,100 @@
+import { ActivationEvent, ActivationEvents, Capabilities, Capability, Plugin } from "@dxos/app-framework";
+import * as Duration from "effect/Duration";
+import * as Effect from "effect/Effect";
+import * as Fiber from "effect/Fiber";
+import * as Predicate from "effect/Predicate";
+import * as Schedule from "effect/Schedule";
+import { registerSW } from "virtual:pwa-register";
+import { AppActivationEvents, AppCapabilities, AppPlugin, LayoutOperation } from "@dxos/app-toolkit";
+import { log } from "@dxos/log";
+import { meta } from "#meta";
+import { translations } from "#translations";
+//#region src/PwaPlugin.tsx
+var __dxlog_file = "/__w/dxos/dxos/packages/plugins/plugin-pwa/src/PwaPlugin.tsx";
+var UPDATE_CHECK_INTERVAL = Duration.hours(1);
+/**
+* Progress envelope posted by the host's service worker while it precaches a build. The contract is
+* duplicated in `composer-app/src/sw.ts` so the worker bundle stays free of host code — keep in sync.
+*/
+var PRECACHE_PROGRESS = "dxos:precache-progress";
+var isPrecacheProgress = (data) => Predicate.isRecord(data) && data.type === PRECACHE_PROGRESS;
+var PwaPlugin = Plugin.define(meta).pipe(AppPlugin.addTranslationsModule({ translations }), Plugin.addModule({
+	id: "register-pwa",
+	activatesOn: ActivationEvents.ProcessManagerReady,
+	activate: Effect.fnUntraced(function* () {
+		const { invokePromise } = yield* Capability.get(Capabilities.OperationInvoker);
+		let registration;
+		const updateSW = registerSW({
+			onRegisteredSW: (_swUrl, swRegistration) => {
+				registration = swRegistration;
+			},
+			onNeedRefresh: () => {
+				invokePromise(LayoutOperation.AddToast, {
+					id: `${meta.profile.key}.need-refresh`,
+					title: ["need-refresh.label", { ns: meta.profile.key }],
+					description: ["need-refresh.description", { ns: meta.profile.key }],
+					duration: 240 * 1e3,
+					actionLabel: ["refresh.label", { ns: meta.profile.key }],
+					actionAlt: ["refresh.alt", { ns: meta.profile.key }],
+					onAction: () => updateSW(true)
+				});
+			},
+			onOfflineReady: () => {
+				invokePromise(LayoutOperation.AddToast, {
+					id: `${meta.profile.key}.offline-ready`,
+					title: ["offline-ready.label", { ns: meta.profile.key }],
+					closeLabel: ["confirm.label", { ns: meta.profile.key }]
+				});
+			},
+			onRegisterError: (err) => {
+				log.error(err, void 0, {
+					"~LogMeta": "~LogMeta",
+					F: __dxlog_file,
+					L: 71,
+					S: this
+				});
+			}
+		});
+		const fiber = yield* Effect.tryPromise(async () => {
+			await registration?.update();
+		}).pipe(Effect.catchAll((error) => Effect.sync(() => log.warn("service worker update check failed", { error }, {
+			"~LogMeta": "~LogMeta",
+			F: __dxlog_file,
+			L: 86,
+			S: this
+		})))).pipe(Effect.repeat(Schedule.fixed(UPDATE_CHECK_INTERVAL)), Effect.forkDaemon);
+		return Capability.contributes(Capabilities.Null, null, () => Fiber.interrupt(fiber));
+	})
+}), Plugin.addModule({
+	id: "update-progress",
+	activatesOn: ActivationEvent.allOf(ActivationEvents.ProcessManagerReady, AppActivationEvents.ProgressRegistryReady),
+	activate: Effect.fnUntraced(function* () {
+		const registry = yield* Capability.get(AppCapabilities.ProgressRegistry);
+		let monitor;
+		const handleMessage = (event) => {
+			if (!isPrecacheProgress(event.data)) return;
+			const { current, total, isUpdate, done } = event.data;
+			if (done && !monitor) return;
+			monitor ??= registry.register(`${meta.profile.key}.precache`, {
+				label: isUpdate ? "Downloading app update" : "Preparing offline use",
+				total
+			});
+			monitor.total(total);
+			monitor.set(current);
+			if (done) {
+				monitor.done();
+				monitor.remove();
+				monitor = void 0;
+			}
+		};
+		navigator.serviceWorker?.addEventListener("message", handleMessage);
+		return Capability.contributes(Capabilities.Null, null, () => Effect.sync(() => {
+			navigator.serviceWorker?.removeEventListener("message", handleMessage);
+			monitor?.remove();
+		}));
+	})
+}), Plugin.make);
+//#endregion
+export { PwaPlugin, PwaPlugin as default };
+
+//# sourceMappingURL=PwaPlugin.mjs.map

package/dist/lib/PwaPlugin.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"PwaPlugin.mjs","names":[],"sources":["../../src/PwaPlugin.tsx"],"sourcesContent":["//\n// Copyright 2023 DXOS.org\n//\n\nimport * as Duration from 'effect/Duration';\nimport * as Effect from 'effect/Effect';\nimport * as Fiber from 'effect/Fiber';\nimport * as Predicate from 'effect/Predicate';\nimport * as Schedule from 'effect/Schedule';\nimport { registerSW } from 'virtual:pwa-register';\n\nimport { ActivationEvent, ActivationEvents, Capabilities, Capability, Plugin } from '@dxos/app-framework';\nimport { AppActivationEvents, AppCapabilities, AppPlugin, LayoutOperation } from '@dxos/app-toolkit';\nimport { log } from '@dxos/log';\n\nimport { meta } from '#meta';\nimport { translations } from '#translations';\n\nconst UPDATE_CHECK_INTERVAL = Duration.hours(1);\n\n/**\n * Progress envelope posted by the host's service worker while it precaches a build. The contract is\n * duplicated in `composer-app/src/sw.ts` so the worker bundle stays free of host code — keep in sync.\n */\nconst PRECACHE_PROGRESS = 'dxos:precache-progress';\n\ntype PrecacheProgress = {\n  type: typeof PRECACHE_PROGRESS;\n  current: number;\n  total: number;\n  isUpdate: boolean;\n  done: boolean;\n};\n\nconst isPrecacheProgress = (data: unknown): data is PrecacheProgress =>\n  Predicate.isRecord(data) && data.type === PRECACHE_PROGRESS;\n\nexport const PwaPlugin = Plugin.define(meta).pipe(\n  AppPlugin.addTranslationsModule({ translations }),\n  Plugin.addModule({\n    id: 'register-pwa',\n    activatesOn: ActivationEvents.ProcessManagerReady,\n    activate: Effect.fnUntraced(function* () {\n      const { invokePromise } = yield* Capability.get(Capabilities.OperationInvoker);\n\n      let registration: ServiceWorkerRegistration | undefined;\n\n      const updateSW = registerSW({\n        onRegisteredSW: (_swUrl, swRegistration) => {\n          registration = swRegistration;\n        },\n        onNeedRefresh: () => {\n          void invokePromise(LayoutOperation.AddToast, {\n            id: `${meta.profile.key}.need-refresh`,\n            title: ['need-refresh.label', { ns: meta.profile.key }],\n            description: ['need-refresh.description', { ns: meta.profile.key }],\n            duration: 4 * 60 * 1000, // 4m\n            actionLabel: ['refresh.label', { ns: meta.profile.key }],\n            actionAlt: ['refresh.alt', { ns: meta.profile.key }],\n            onAction: () => updateSW(true),\n          });\n        },\n        onOfflineReady: () => {\n          void invokePromise(LayoutOperation.AddToast, {\n            id: `${meta.profile.key}.offline-ready`,\n            title: ['offline-ready.label', { ns: meta.profile.key }],\n            closeLabel: ['confirm.label', { ns: meta.profile.key }],\n          });\n        },\n        onRegisterError: (err) => {\n          log.error(err);\n        },\n      });\n\n      // The browser only re-fetches the worker script on navigation, but Composer sessions stay open\n      // for days, so without polling a deployed update is never noticed and the refresh toast only\n      // ever appears on reload. `Effect.repeat` runs the first check straight away, before\n      // `onRegisteredSW` has fired — the optional call makes that opening tick a no-op.\n      //\n      // `update()` rejects in its own right — `InvalidStateError` while a worker is already\n      // installing, a `TypeError` when the script fetch fails offline — so the rejection is recovered\n      // rather than left to `Effect.promise`, whose defect would kill the daemon fiber and silently\n      // end polling for the rest of the session.\n      const checkForUpdate = Effect.tryPromise(async () => {\n        await registration?.update();\n      }).pipe(Effect.catchAll((error) => Effect.sync(() => log.warn('service worker update check failed', { error }))));\n\n      const fiber = yield* checkForUpdate.pipe(Effect.repeat(Schedule.fixed(UPDATE_CHECK_INTERVAL)), Effect.forkDaemon);\n\n      // Return the interruption effect directly; Fiber.interrupt is async and would throw\n      // AsyncFiberException if wrapped in Effect.runSync.\n      return Capability.contributes(Capabilities.Null, null, () => Fiber.interrupt(fiber));\n    }),\n  }),\n  // Separate from `register-pwa` so that an app without the progress registry still registers the\n  // service worker — only the meter is lost, not the update flow itself.\n  Plugin.addModule({\n    id: 'update-progress',\n    activatesOn: ActivationEvent.allOf(ActivationEvents.ProcessManagerReady, AppActivationEvents.ProgressRegistryReady),\n    activate: Effect.fnUntraced(function* () {\n      const registry = yield* Capability.get(AppCapabilities.ProgressRegistry);\n\n      let monitor: AppCapabilities.ProgressMonitor | undefined;\n      const handleMessage = (event: MessageEvent) => {\n        if (!isPrecacheProgress(event.data)) {\n          return;\n        }\n\n        const { current, total, isUpdate, done } = event.data;\n        if (done && !monitor) {\n          // Completion for a download this window never saw start — nothing to report.\n          return;\n        }\n\n        monitor ??= registry.register(`${meta.profile.key}.precache`, {\n          label: isUpdate ? 'Downloading app update' : 'Preparing offline use',\n          total,\n        });\n        monitor.total(total);\n        monitor.set(current);\n        if (done) {\n          monitor.done();\n          // Transient monitor: the download is a one-shot, so drop it rather than leave a completed\n          // row in the registry until the next reload.\n          monitor.remove();\n          monitor = undefined;\n        }\n      };\n\n      navigator.serviceWorker?.addEventListener('message', handleMessage);\n\n      return Capability.contributes(Capabilities.Null, null, () =>\n        Effect.sync(() => {\n          navigator.serviceWorker?.removeEventListener('message', handleMessage);\n          monitor?.remove();\n        }),\n      );\n    }),\n  }),\n  Plugin.make,\n);\n\nexport default PwaPlugin;\n"],"mappings":";;;;;;;;;;;;;AAkBA,IAAM,wBAAwB,SAAS,MAAM,CAAC;;;;;AAM9C,IAAM,oBAAoB;AAU1B,IAAM,sBAAsB,SAC1B,UAAU,SAAS,IAAI,KAAK,KAAK,SAAS;AAE5C,IAAa,YAAY,OAAO,OAAO,IAAI,CAAC,CAAC,KAC3C,UAAU,sBAAsB,EAAE,aAAa,CAAC,GAChD,OAAO,UAAU;CACf,IAAI;CACJ,aAAa,iBAAiB;CAC9B,UAAU,OAAO,WAAW,aAAa;EACvC,MAAM,EAAE,kBAAkB,OAAO,WAAW,IAAI,aAAa,gBAAgB;EAE7E,IAAI;EAEJ,MAAM,WAAW,WAAW;GAC1B,iBAAiB,QAAQ,mBAAmB;IAC1C,eAAe;GACjB;GACA,qBAAqB;IACnB,cAAmB,gBAAgB,UAAU;KAC3C,IAAI,GAAG,KAAK,QAAQ,IAAI;KACxB,OAAO,CAAC,sBAAsB,EAAE,IAAI,KAAK,QAAQ,IAAI,CAAC;KACtD,aAAa,CAAC,4BAA4B,EAAE,IAAI,KAAK,QAAQ,IAAI,CAAC;KAClE,UAAU,MAAS;KACnB,aAAa,CAAC,iBAAiB,EAAE,IAAI,KAAK,QAAQ,IAAI,CAAC;KACvD,WAAW,CAAC,eAAe,EAAE,IAAI,KAAK,QAAQ,IAAI,CAAC;KACnD,gBAAgB,SAAS,IAAI;IAC/B,CAAC;GACH;GACA,sBAAsB;IACpB,cAAmB,gBAAgB,UAAU;KAC3C,IAAI,GAAG,KAAK,QAAQ,IAAI;KACxB,OAAO,CAAC,uBAAuB,EAAE,IAAI,KAAK,QAAQ,IAAI,CAAC;KACvD,YAAY,CAAC,iBAAiB,EAAE,IAAI,KAAK,QAAQ,IAAI,CAAC;IACxD,CAAC;GACH;GACA,kBAAkB,QAAQ;IACxB,IAAI,MAAM,KAAE,KAAA,GAAA;KAAA,YAAA;KAAA,GAAA;KAAA,GAAA;KAAA,GAAA;IAAA,CAAC;GACf;EACF,CAAC;EAeD,MAAM,QAAQ,OAJS,OAAO,WAAW,YAAY;GACnD,MAAM,cAAc,OAAO;EAC7B,CAAC,CAAC,CAAC,KAAK,OAAO,UAAU,UAAU,OAAO,WAAW,IAAI,KAAK,sCAAsC,EAAE,MAAM,GAAA;GAAA,YAAA;GAAA,GAAA;GAAA,GAAA;GAAA,GAAA;EAAA,CAAC,CAAC,CAAC,CAE1F,CAAA,CAAe,KAAK,OAAO,OAAO,SAAS,MAAM,qBAAqB,CAAC,GAAG,OAAO,UAAU;EAIhH,OAAO,WAAW,YAAY,aAAa,MAAM,YAAY,MAAM,UAAU,KAAK,CAAC;CACrF,CAAC;AACH,CAAC,GAGD,OAAO,UAAU;CACf,IAAI;CACJ,aAAa,gBAAgB,MAAM,iBAAiB,qBAAqB,oBAAoB,qBAAqB;CAClH,UAAU,OAAO,WAAW,aAAa;EACvC,MAAM,WAAW,OAAO,WAAW,IAAI,gBAAgB,gBAAgB;EAEvE,IAAI;EACJ,MAAM,iBAAiB,UAAwB;GAC7C,IAAI,CAAC,mBAAmB,MAAM,IAAI,GAChC;GAGF,MAAM,EAAE,SAAS,OAAO,UAAU,SAAS,MAAM;GACjD,IAAI,QAAQ,CAAC,SAEX;GAGF,YAAY,SAAS,SAAS,GAAG,KAAK,QAAQ,IAAI,YAAY;IAC5D,OAAO,WAAW,2BAA2B;IAC7C;GACF,CAAC;GACD,QAAQ,MAAM,KAAK;GACnB,QAAQ,IAAI,OAAO;GACnB,IAAI,MAAM;IACR,QAAQ,KAAK;IAGb,QAAQ,OAAO;IACf,UAAU,KAAA;GACZ;EACF;EAEA,UAAU,eAAe,iBAAiB,WAAW,aAAa;EAElE,OAAO,WAAW,YAAY,aAAa,MAAM,YAC/C,OAAO,WAAW;GAChB,UAAU,eAAe,oBAAoB,WAAW,aAAa;GACrE,SAAS,OAAO;EAClB,CAAC,CACH;CACF,CAAC;AACH,CAAC,GACD,OAAO,IACT"}

package/dist/lib/{neutral/chunk-N6ICXF4W.mjs → chunk-meta.mjs}

@@ -1,28 +1,21 @@
-// src/meta.ts
 import { Plugin } from "@dxos/app-framework";
-
-// dx.config.ts
 import { Config2 } from "@dxos/app-framework/config";
 import { trim } from "@dxos/util";
-var dx_config_default = Config2.make({
-  plugin: {
-    key: "org.dxos.plugin.pwa",
-    name: "PWA",
-    author: "DXOS",
-    description: trim`
+//#region dx.config.ts
+var dx_config_default = Config2.make({ plugin: {
+	key: "org.dxos.plugin.pwa",
+	name: "PWA",
+	author: "DXOS",
+	description: trim`
       Progressive Web App capabilities enabling offline functionality and app-like experience.
       Install to home screen and use the workspace without internet connection.
     `,
-    tags: [
-      "system"
-    ]
-  }
-});
-
-// src/meta.ts
+	tags: ["system"]
+} });
+//#endregion
+//#region src/meta.ts
 var meta = Plugin.getMetaFromConfig(dx_config_default);
+//#endregion
+export { meta as t };
 
-export {
-  meta
-};
-//# sourceMappingURL=chunk-N6ICXF4W.mjs.map
+//# sourceMappingURL=chunk-meta.mjs.map

package/dist/lib/chunk-meta.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"chunk-meta.mjs","names":[],"sources":["../../dx.config.ts","../../src/meta.ts"],"sourcesContent":["//\n// Copyright 2025 DXOS.org\n//\n\nimport { Config2 } from '@dxos/app-framework/config';\nimport { trim } from '@dxos/util';\n\nexport default Config2.make({\n  plugin: {\n    key: 'org.dxos.plugin.pwa',\n    name: 'PWA',\n    author: 'DXOS',\n    description: trim`\n      Progressive Web App capabilities enabling offline functionality and app-like experience.\n      Install to home screen and use the workspace without internet connection.\n    `,\n    tags: ['system'],\n  },\n});\n","//\n// Copyright 2023 DXOS.org\n//\n\nimport { Plugin } from '@dxos/app-framework';\n\nimport config from '../dx.config';\n\nexport const meta = Plugin.getMetaFromConfig(config);\n"],"mappings":";;;;AAOA,IAAA,oBAAe,QAAQ,KAAK,EAC1B,QAAQ;CACN,KAAK;CACL,MAAM;CACN,QAAQ;CACR,aAAa,IAAI;;;;CAIjB,MAAM,CAAC,QAAQ;AACjB,EACF,CAAC;;;ACVD,IAAa,OAAO,OAAO,kBAAkB,iBAAM"}

package/dist/lib/index.mjs

@@ -0,0 +1,2 @@
+import { t as meta } from "./chunk-meta.mjs";
+export { meta };

package/dist/lib/meta.mjs

@@ -0,0 +1,2 @@
+import { t as meta } from "./chunk-meta.mjs";
+export { meta };

package/dist/lib/plugin.mjs

@@ -0,0 +1,8 @@
+import { t as meta } from "./chunk-meta.mjs";
+import { Plugin } from "@dxos/app-framework";
+//#region src/plugin.ts
+var PwaPlugin = Plugin.lazy(meta, () => import("#plugin"));
+//#endregion
+export { PwaPlugin };
+
+//# sourceMappingURL=plugin.mjs.map

package/dist/lib/plugin.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.mjs","names":[],"sources":["../../src/plugin.ts"],"sourcesContent":["//\n// Copyright 2023 DXOS.org\n//\n\nimport { Plugin } from '@dxos/app-framework';\n\nimport { meta } from './meta';\n\nexport const PwaPlugin = Plugin.lazy(meta, () => import('#plugin'));\n"],"mappings":";;;AAQA,IAAa,YAAY,OAAO,KAAK,YAAY,OAAO,UAAU"}

package/dist/lib/translations.mjs

@@ -0,0 +1,14 @@
+import { meta } from "#meta";
+//#region src/translations.ts
+var translations = [{ "en-US": { [meta.profile.key]: {
+	"need-refresh.label": "Refresh now to get app updates",
+	"need-refresh.description": "You’ll need these updates to continue without interruption.",
+	"refresh.label": "Refresh",
+	"refresh.alt": "Click your browser’s refresh button or use the refresh keyboard shortcut.",
+	"offline-ready.label": "Ready to use offline.",
+	"confirm.label": "Okay"
+} } }];
+//#endregion
+export { translations };
+
+//# sourceMappingURL=translations.mjs.map

package/dist/lib/translations.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"translations.mjs","names":[],"sources":["../../src/translations.ts"],"sourcesContent":["//\n// Copyright 2022 DXOS.org\n//\n\nimport { type Resource } from '@dxos/react-ui';\n\nimport { meta } from '#meta';\n\nexport const translations = [\n  {\n    'en-US': {\n      [meta.profile.key]: {\n        'need-refresh.label': 'Refresh now to get app updates',\n        'need-refresh.description': 'You’ll need these updates to continue without interruption.',\n        'refresh.label': 'Refresh',\n        'refresh.alt': 'Click your browser’s refresh button or use the refresh keyboard shortcut.',\n        // TODO(wittjosiah): Non-react translation utils.\n        // 'offline ready label': '{{appName}} is ready to use offline.',\n        'offline-ready.label': 'Ready to use offline.',\n        'confirm.label': 'Okay',\n      },\n    },\n  },\n] as const satisfies Resource[];\n"],"mappings":";;AAQA,IAAa,eAAe,CAC1B,EACE,SAAS,GACN,KAAK,QAAQ,MAAM;CAClB,sBAAsB;CACtB,4BAA4B;CAC5B,iBAAiB;CACjB,eAAe;CAGf,uBAAuB;CACvB,iBAAiB;AACnB,EACF,EACF,CACF"}

package/dist/types/src/PwaPlugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PwaPlugin.d.ts","sourceRoot":"","sources":["../../../src/PwaPlugin.tsx"],"names":[],"mappings":"AAOA,OAAO,EAA8C,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAOzF,eAAO,MAAM,SAAS,4BAkCrB,CAAC;eAEa,SAAS"}
+{"version":3,"file":"PwaPlugin.d.ts","sourceRoot":"","sources":["../../../src/PwaPlugin.tsx"],"names":[],"mappings":"AAWA,OAAO,EAA+D,MAAM,EAAE,MAAM,qBAAqB,CAAC;AA0B1G,eAAO,MAAM,SAAS,4BAuGrB,CAAC;eAEa,SAAS"}