@dxos/plugin-pwa 0.8.4-main.c85a9c8dae → 0.8.4-main.d05539e30a

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/plugin-pwa",
-  "version": "0.8.4-main.c85a9c8dae",
+  "version": "0.8.4-main.d05539e30a",
   "description": "DXOS Surface plugin for PWA registration and update handling.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -8,52 +8,77 @@
     "type": "git",
     "url": "https://github.com/dxos/dxos"
   },
-  "license": "MIT",
+  "license": "FSL-1.1-Apache-2.0",
   "author": "DXOS.org",
   "sideEffects": true,
   "type": "module",
+  "imports": {
+    "#meta": {
+      "source": "./src/meta.ts",
+      "types": "./dist/types/src/meta.d.ts",
+      "default": "./dist/lib/neutral/meta.mjs"
+    },
+    "#plugin": {
+      "source": "./src/PwaPlugin.tsx",
+      "types": "./dist/types/src/PwaPlugin.d.ts",
+      "default": "./dist/lib/neutral/PwaPlugin.mjs"
+    },
+    "#translations": {
+      "source": "./src/translations.ts",
+      "types": "./dist/types/src/translations.d.ts",
+      "default": "./dist/lib/neutral/translations.mjs"
+    }
+  },
   "exports": {
     ".": {
       "source": "./src/index.ts",
       "types": "./dist/types/src/index.d.ts",
-      "browser": "./dist/lib/browser/index.mjs"
+      "default": "./dist/lib/neutral/index.mjs"
+    },
+    "./plugin": {
+      "source": "./src/plugin.ts",
+      "types": "./dist/types/src/plugin.d.ts",
+      "default": "./dist/lib/neutral/plugin.mjs"
+    },
+    "./translations": {
+      "source": "./src/translations.ts",
+      "types": "./dist/types/src/translations.d.ts",
+      "default": "./dist/lib/neutral/translations.mjs"
     }
   },
   "types": "dist/types/src/index.d.ts",
-  "typesVersions": {
-    "*": {}
-  },
   "files": [
     "dist",
     "src"
   ],
   "dependencies": {
-    "effect": "3.19.16",
-    "@dxos/app-toolkit": "0.8.4-main.c85a9c8dae",
-    "@dxos/app-framework": "0.8.4-main.c85a9c8dae",
-    "@dxos/log": "0.8.4-main.c85a9c8dae",
-    "@dxos/operation": "0.8.4-main.c85a9c8dae",
-    "@dxos/observability": "0.8.4-main.c85a9c8dae",
-    "@dxos/util": "0.8.4-main.c85a9c8dae"
+    "effect": "3.20.0",
+    "@dxos/observability": "0.8.4-main.d05539e30a",
+    "@dxos/operation": "0.8.4-main.d05539e30a",
+    "@dxos/util": "0.8.4-main.d05539e30a",
+    "@dxos/app-framework": "0.8.4-main.d05539e30a",
+    "@dxos/app-toolkit": "0.8.4-main.d05539e30a",
+    "@dxos/log": "0.8.4-main.d05539e30a"
   },
   "devDependencies": {
     "@types/react": "~19.2.7",
     "@types/react-dom": "~19.2.3",
     "react": "~19.2.3",
     "react-dom": "~19.2.3",
-    "vite": "^7.1.11",
-    "vite-plugin-pwa": "^1.0.2",
-    "workbox-window": "^7.3.0",
-    "@dxos/react-ui": "0.8.4-main.c85a9c8dae",
-    "@dxos/storybook-utils": "0.8.4-main.c85a9c8dae",
-    "@dxos/ui-theme": "0.8.4-main.c85a9c8dae"
+    "vite": "^8.0.13",
+    "vite-plugin-pwa": "^1.2.0",
+    "workbox-window": "^7.4.0",
+    "@dxos/plugin-testing": "0.8.4-main.d05539e30a",
+    "@dxos/react-ui": "0.8.4-main.d05539e30a",
+    "@dxos/storybook-utils": "0.8.4-main.d05539e30a",
+    "@dxos/ui-theme": "0.8.4-main.d05539e30a"
   },
   "peerDependencies": {
-    "effect": "3.19.16",
+    "effect": "3.20.0",
     "react": "~19.2.3",
     "react-dom": "~19.2.3",
-    "@dxos/react-ui": "0.8.4-main.c85a9c8dae",
-    "@dxos/ui-theme": "0.8.4-main.c85a9c8dae"
+    "@dxos/react-ui": "0.8.4-main.d05539e30a",
+    "@dxos/ui-theme": "0.8.4-main.d05539e30a"
   },
   "publishConfig": {
     "access": "public"

package/src/PwaPlugin.tsx

@@ -9,34 +9,34 @@ import { ActivationEvents, Capabilities, Capability, Plugin } from '@dxos/app-fr
 import { AppPlugin, LayoutOperation } from '@dxos/app-toolkit';
 import { log } from '@dxos/log';
 
-import { meta } from './meta';
-import { translations } from './translations';
+import { meta } from '#meta';
+import { translations } from '#translations';
 
 export const PwaPlugin = Plugin.define(meta).pipe(
   AppPlugin.addTranslationsModule({ translations }),
   Plugin.addModule({
     id: 'register-pwa',
-    activatesOn: ActivationEvents.OperationInvokerReady,
+    activatesOn: ActivationEvents.ProcessManagerReady,
     activate: Effect.fnUntraced(function* () {
-      const { invokeSync } = yield* Capability.get(Capabilities.OperationInvoker);
+      const { invokePromise } = yield* Capability.get(Capabilities.OperationInvoker);
 
       const updateSW = registerSW({
         onNeedRefresh: () => {
-          invokeSync(LayoutOperation.AddToast, {
-            id: `${meta.id}/need-refresh`,
-            title: ['need refresh label', { ns: meta.id }],
-            description: ['need refresh description', { ns: meta.id }],
+          void invokePromise(LayoutOperation.AddToast, {
+            id: `${meta.id}.need-refresh`,
+            title: ['need-refresh.label', { ns: meta.id }],
+            description: ['need-refresh.description', { ns: meta.id }],
             duration: 4 * 60 * 1000, // 4m
-            actionLabel: ['refresh label', { ns: meta.id }],
-            actionAlt: ['refresh alt', { ns: meta.id }],
+            actionLabel: ['refresh.label', { ns: meta.id }],
+            actionAlt: ['refresh.alt', { ns: meta.id }],
             onAction: () => updateSW(true),
           });
         },
         onOfflineReady: () => {
-          invokeSync(LayoutOperation.AddToast, {
-            id: `${meta.id}/offline-ready`,
-            title: ['offline ready label', { ns: meta.id }],
-            closeLabel: ['confirm label', { ns: meta.id }],
+          void invokePromise(LayoutOperation.AddToast, {
+            id: `${meta.id}.offline-ready`,
+            title: ['offline-ready.label', { ns: meta.id }],
+            closeLabel: ['confirm.label', { ns: meta.id }],
           });
         },
         onRegisterError: (err) => {
@@ -47,3 +47,5 @@ export const PwaPlugin = Plugin.define(meta).pipe(
   }),
   Plugin.make,
 );
+
+export default PwaPlugin;

package/src/index.ts

@@ -3,4 +3,3 @@
 //
 
 export * from './meta';
-export * from './PwaPlugin';

package/src/meta.ts

@@ -6,10 +6,12 @@ import { type Plugin } from '@dxos/app-framework';
 import { trim } from '@dxos/util';
 
 export const meta: Plugin.Meta = {
-  id: 'dxos.org/plugin/pwa',
+  id: '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'],
 };

package/src/plugin.ts

@@ -0,0 +1,9 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { Plugin } from '@dxos/app-framework';
+
+import { meta } from './meta';
+
+export const PwaPlugin = Plugin.lazy(meta, () => import('#plugin'));

package/src/translations.ts

@@ -4,20 +4,20 @@
 
 import { type Resource } from '@dxos/react-ui';
 
-import { meta } from './meta';
+import { meta } from '#meta';
 
 export const translations = [
   {
     'en-US': {
       [meta.id]: {
-        '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.',
+        '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.',
         // TODO(wittjosiah): Non-react translation utils.
         // 'offline ready label': '{{appName}} is ready to use offline.',
-        'offline ready label': 'Ready to use offline.',
-        'confirm label': 'Okay',
+        'offline-ready.label': 'Ready to use offline.',
+        'confirm.label': 'Okay',
       },
     },
   },

package/dist/lib/browser/index.mjs

@@ -1,110 +0,0 @@
-// src/meta.ts
-import { trim } from "@dxos/util";
-var meta = {
-  id: "dxos.org/plugin/pwa",
-  name: "PWA",
-  description: trim`
-    Progressive Web App capabilities enabling offline functionality and app-like experience.
-    Install to home screen and use the workspace without internet connection.
-  `
-};
-
-// src/PwaPlugin.tsx
-import * as Effect from "effect/Effect";
-import { registerSW } from "virtual:pwa-register";
-import { ActivationEvents, Capabilities, Capability, Plugin } from "@dxos/app-framework";
-import { AppPlugin, LayoutOperation } from "@dxos/app-toolkit";
-import { log } from "@dxos/log";
-
-// src/translations.ts
-var translations = [
-  {
-    "en-US": {
-      [meta.id]: {
-        "need refresh label": "Refresh now to get app updates",
-        "need refresh description": "You\u2019ll need these updates to continue without interruption.",
-        "refresh label": "Refresh",
-        "refresh alt": "Click your browser\u2019s refresh button or use the refresh keyboard shortcut.",
-        // TODO(wittjosiah): Non-react translation utils.
-        // 'offline ready label': '{{appName}} is ready to use offline.',
-        "offline ready label": "Ready to use offline.",
-        "confirm label": "Okay"
-      }
-    }
-  }
-];
-
-// src/PwaPlugin.tsx
-var __dxlog_file = "/__w/dxos/dxos/packages/plugins/plugin-pwa/src/PwaPlugin.tsx";
-var PwaPlugin = Plugin.define(meta).pipe(AppPlugin.addTranslationsModule({
-  translations
-}), Plugin.addModule({
-  id: "register-pwa",
-  activatesOn: ActivationEvents.OperationInvokerReady,
-  activate: Effect.fnUntraced(function* () {
-    const { invokeSync } = yield* Capability.get(Capabilities.OperationInvoker);
-    const updateSW = registerSW({
-      onNeedRefresh: () => {
-        invokeSync(LayoutOperation.AddToast, {
-          id: `${meta.id}/need-refresh`,
-          title: [
-            "need refresh label",
-            {
-              ns: meta.id
-            }
-          ],
-          description: [
-            "need refresh description",
-            {
-              ns: meta.id
-            }
-          ],
-          duration: 4 * 60 * 1e3,
-          actionLabel: [
-            "refresh label",
-            {
-              ns: meta.id
-            }
-          ],
-          actionAlt: [
-            "refresh alt",
-            {
-              ns: meta.id
-            }
-          ],
-          onAction: () => updateSW(true)
-        });
-      },
-      onOfflineReady: () => {
-        invokeSync(LayoutOperation.AddToast, {
-          id: `${meta.id}/offline-ready`,
-          title: [
-            "offline ready label",
-            {
-              ns: meta.id
-            }
-          ],
-          closeLabel: [
-            "confirm label",
-            {
-              ns: meta.id
-            }
-          ]
-        });
-      },
-      onRegisterError: (err) => {
-        log.error(err, void 0, {
-          F: __dxlog_file,
-          L: 43,
-          S: this,
-          C: (f, a) => f(...a)
-        });
-      }
-    });
-  })
-}), Plugin.make);
-export {
-  PwaPlugin,
-  meta
-};
-//# sourceMappingURL=index.mjs.map

package/dist/lib/browser/index.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/meta.ts", "../../../src/PwaPlugin.tsx", "../../../src/translations.ts"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { type Plugin } from '@dxos/app-framework';\nimport { trim } from '@dxos/util';\n\nexport const meta: Plugin.Meta = {\n  id: 'dxos.org/plugin/pwa',\n  name: 'PWA',\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};\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport * as Effect from 'effect/Effect';\nimport { registerSW } from 'virtual:pwa-register';\n\nimport { ActivationEvents, Capabilities, Capability, Plugin } from '@dxos/app-framework';\nimport { AppPlugin, LayoutOperation } from '@dxos/app-toolkit';\nimport { log } from '@dxos/log';\n\nimport { meta } from './meta';\nimport { translations } from './translations';\n\nexport const PwaPlugin = Plugin.define(meta).pipe(\n  AppPlugin.addTranslationsModule({ translations }),\n  Plugin.addModule({\n    id: 'register-pwa',\n    activatesOn: ActivationEvents.OperationInvokerReady,\n    activate: Effect.fnUntraced(function* () {\n      const { invokeSync } = yield* Capability.get(Capabilities.OperationInvoker);\n\n      const updateSW = registerSW({\n        onNeedRefresh: () => {\n          invokeSync(LayoutOperation.AddToast, {\n            id: `${meta.id}/need-refresh`,\n            title: ['need refresh label', { ns: meta.id }],\n            description: ['need refresh description', { ns: meta.id }],\n            duration: 4 * 60 * 1000, // 4m\n            actionLabel: ['refresh label', { ns: meta.id }],\n            actionAlt: ['refresh alt', { ns: meta.id }],\n            onAction: () => updateSW(true),\n          });\n        },\n        onOfflineReady: () => {\n          invokeSync(LayoutOperation.AddToast, {\n            id: `${meta.id}/offline-ready`,\n            title: ['offline ready label', { ns: meta.id }],\n            closeLabel: ['confirm label', { ns: meta.id }],\n          });\n        },\n        onRegisterError: (err) => {\n          log.error(err);\n        },\n      });\n    }),\n  }),\n  Plugin.make,\n);\n", "//\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.id]: {\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": ";AAKA,SAASA,YAAY;AAEd,IAAMC,OAAoB;EAC/BC,IAAI;EACJC,MAAM;EACNC,aAAaC;;;;AAIf;;;ACVA,YAAYC,YAAY;AACxB,SAASC,kBAAkB;AAE3B,SAASC,kBAAkBC,cAAcC,YAAYC,cAAc;AACnE,SAASC,WAAWC,uBAAuB;AAC3C,SAASC,WAAW;;;ACDb,IAAMC,eAAe;EAC1B;IACE,SAAS;MACP,CAACC,KAAKC,EAAE,GAAG;QACT,sBAAsB;QACtB,4BAA4B;QAC5B,iBAAiB;QACjB,eAAe;;;QAGf,uBAAuB;QACvB,iBAAiB;MACnB;IACF;EACF;;;;;ADRK,IAAMC,YAAYC,OAAOC,OAAOC,IAAAA,EAAMC,KAC3CC,UAAUC,sBAAsB;EAAEC;AAAa,CAAA,GAC/CN,OAAOO,UAAU;EACfC,IAAI;EACJC,aAAaC,iBAAiBC;EAC9BC,UAAiBC,kBAAW,aAAA;AAC1B,UAAM,EAAEC,WAAU,IAAK,OAAOC,WAAWC,IAAIC,aAAaC,gBAAgB;AAE1E,UAAMC,WAAWC,WAAW;MAC1BC,eAAe,MAAA;AACbP,mBAAWQ,gBAAgBC,UAAU;UACnCf,IAAI,GAAGN,KAAKM,EAAE;UACdgB,OAAO;YAAC;YAAsB;cAAEC,IAAIvB,KAAKM;YAAG;;UAC5CkB,aAAa;YAAC;YAA4B;cAAED,IAAIvB,KAAKM;YAAG;;UACxDmB,UAAU,IAAI,KAAK;UACnBC,aAAa;YAAC;YAAiB;cAAEH,IAAIvB,KAAKM;YAAG;;UAC7CqB,WAAW;YAAC;YAAe;cAAEJ,IAAIvB,KAAKM;YAAG;;UACzCsB,UAAU,MAAMX,SAAS,IAAA;QAC3B,CAAA;MACF;MACAY,gBAAgB,MAAA;AACdjB,mBAAWQ,gBAAgBC,UAAU;UACnCf,IAAI,GAAGN,KAAKM,EAAE;UACdgB,OAAO;YAAC;YAAuB;cAAEC,IAAIvB,KAAKM;YAAG;;UAC7CwB,YAAY;YAAC;YAAiB;cAAEP,IAAIvB,KAAKM;YAAG;;QAC9C,CAAA;MACF;MACAyB,iBAAiB,CAACC,QAAAA;AAChBC,YAAIC,MAAMF,KAAAA,QAAAA;;;;;;MACZ;IACF,CAAA;EACF,CAAA;AACF,CAAA,GACAlC,OAAOqC,IAAI;",
-  "names": ["trim", "meta", "id", "name", "description", "trim", "Effect", "registerSW", "ActivationEvents", "Capabilities", "Capability", "Plugin", "AppPlugin", "LayoutOperation", "log", "translations", "meta", "id", "PwaPlugin", "Plugin", "define", "meta", "pipe", "AppPlugin", "addTranslationsModule", "translations", "addModule", "id", "activatesOn", "ActivationEvents", "OperationInvokerReady", "activate", "fnUntraced", "invokeSync", "Capability", "get", "Capabilities", "OperationInvoker", "updateSW", "registerSW", "onNeedRefresh", "LayoutOperation", "AddToast", "title", "ns", "description", "duration", "actionLabel", "actionAlt", "onAction", "onOfflineReady", "closeLabel", "onRegisterError", "err", "log", "error", "make"]
-}

package/dist/lib/browser/meta.json

@@ -1 +0,0 @@
-{"inputs":{"src/meta.ts":{"bytes":1383,"imports":[{"path":"@dxos/util","kind":"import-statement","external":true}],"format":"esm"},"src/translations.ts":{"bytes":2456,"imports":[{"path":"src/meta.ts","kind":"import-statement","original":"./meta"}],"format":"esm"},"src/PwaPlugin.tsx":{"bytes":7490,"imports":[{"path":"effect/Effect","kind":"import-statement","external":true},{"path":"virtual:pwa-register","kind":"import-statement","external":true},{"path":"@dxos/app-framework","kind":"import-statement","external":true},{"path":"@dxos/app-toolkit","kind":"import-statement","external":true},{"path":"@dxos/log","kind":"import-statement","external":true},{"path":"src/meta.ts","kind":"import-statement","original":"./meta"},{"path":"src/translations.ts","kind":"import-statement","original":"./translations"}],"format":"esm"},"src/index.ts":{"bytes":535,"imports":[{"path":"src/meta.ts","kind":"import-statement","original":"./meta"},{"path":"src/PwaPlugin.tsx","kind":"import-statement","original":"./PwaPlugin"}],"format":"esm"}},"outputs":{"dist/lib/browser/index.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":5013},"dist/lib/browser/index.mjs":{"imports":[{"path":"@dxos/util","kind":"import-statement","external":true},{"path":"effect/Effect","kind":"import-statement","external":true},{"path":"virtual:pwa-register","kind":"import-statement","external":true},{"path":"@dxos/app-framework","kind":"import-statement","external":true},{"path":"@dxos/app-toolkit","kind":"import-statement","external":true},{"path":"@dxos/log","kind":"import-statement","external":true}],"exports":["PwaPlugin","meta"],"entryPoint":"src/index.ts","inputs":{"src/meta.ts":{"bytesInOutput":291},"src/index.ts":{"bytesInOutput":0},"src/PwaPlugin.tsx":{"bytesInOutput":2007},"src/translations.ts":{"bytesInOutput":609}},"bytes":3057}}}