@dxos/plugin-pwa 0.8.4-main.dedc0f3 → 0.8.4-main.dfabb4ec29

package/dist/lib/neutral/PwaPlugin.mjs

@@ -0,0 +1,77 @@
+// 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";
+import { meta } from "#meta";
+import { translations } from "#translations";
+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 { invokePromise } = yield* Capability.get(Capabilities.OperationInvoker);
+    const updateSW = registerSW({
+      onNeedRefresh: () => {
+        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 * 1e3,
+          actionLabel: [
+            "refresh.label",
+            {
+              ns: meta.id
+            }
+          ],
+          actionAlt: [
+            "refresh.alt",
+            {
+              ns: meta.id
+            }
+          ],
+          onAction: () => updateSW(true)
+        });
+      },
+      onOfflineReady: () => {
+        void invokePromise(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, { "~LogMeta": "~LogMeta", F: __dxlog_file, L: 68, S: this });
+      }
+    });
+  })
+}), Plugin.make);
+var PwaPlugin_default = PwaPlugin;
+export {
+  PwaPlugin,
+  PwaPlugin_default as default
+};
+//# sourceMappingURL=PwaPlugin.mjs.map

package/dist/lib/neutral/PwaPlugin.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/PwaPlugin.tsx"],
+  "sourcesContent": ["//\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 { invokePromise } = yield* Capability.get(Capabilities.OperationInvoker);\n\n      const updateSW = registerSW({\n        onNeedRefresh: () => {\n          void invokePromise(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          void invokePromise(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\nexport default PwaPlugin;\n"],
+  "mappings": ";AAIA,YAAYA,YAAY;AACxB,SAASC,kBAAkB;AAE3B,SAASC,kBAAkBC,cAAcC,YAAYC,cAAc;AACnE,SAASC,WAAWC,uBAAuB;AAC3C,SAASC,WAAW;AAEpB,SAASC,YAAY;AACrB,SAASC,oBAAoB;AAE7B,IAAA,eAAaC;AAEXN,IAAOO,YAAU,OAAA,OAAA,IAAA,EAAA,KAAA,UAAA,sBAAA;EACfC;IACAC,OAAAA,UAAaZ;EACba,IAAAA;eACUC,iBAAkB;YAEpBC,kBAAWhB,aAAW;UAC1BiB,EAAAA,cAAe,IAAA,OAAA,WAAA,IAAA,aAAA,gBAAA;qBACRF,WAAcT;qBACVE,MAAAA;aACPU,cAAO,gBAAA,UAAA;cAAC,GAAA,KAAA,EAAA;iBAAsB;;YAAc;cAAE,IAAA,KAAA;YAC9CC;;uBAA0C;;YAAc;cAAE,IAAA,KAAA;YAC1DC;UACAC;oBAAc,IAAA,KAAA;uBAAiB;;YAAc;cAAE,IAAA,KAAA;YAC/CC;;qBAA2B;;YAAc;cAAE,IAAA,KAAA;YAC3CC;UACF;UACF,UAAA,MAAA,SAAA,IAAA;QACAC,CAAAA;;sBAEWhB,MAAKI;aACZM,cAAO,gBAAA,UAAA;cAAC,GAAA,KAAA,EAAA;iBAAuB;;YAAc;cAAE,IAAA,KAAA;YAC/CO;;sBAA8B;;YAAc;cAAE,IAAA,KAAA;YAChD;UACF;QACAC,CAAAA;;MAEA,iBAAA,CAAA,QAAA;AACF,YAAA,MAAA,KAAA,QAAA,EAAA,YAAA,YAAA,GAAA,cAAA,GAAA,IAAA,GAAA,KAAA,CAAA;MACF;IAEFtB,CAAAA;EAGF,CAAA;;;",
+  "names": ["Effect", "registerSW", "ActivationEvents", "Capabilities", "Capability", "Plugin", "AppPlugin", "LayoutOperation", "log", "meta", "translations", "PwaPlugin", "addModule", "id", "activatesOn", "activate", "invokePromise", "updateSW", "onNeedRefresh", "title", "description", "duration", "actionLabel", "actionAlt", "onAction", "onOfflineReady", "closeLabel", "onRegisterError"]
+}

package/dist/lib/neutral/chunk-SCMZU5OW.mjs

@@ -0,0 +1,18 @@
+// src/meta.ts
+import { trim } from "@dxos/util";
+var meta = {
+  id: "org.dxos.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.
+  `,
+  tags: [
+    "system"
+  ]
+};
+
+export {
+  meta
+};
+//# sourceMappingURL=chunk-SCMZU5OW.mjs.map

package/dist/lib/neutral/chunk-SCMZU5OW.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/meta.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: 'org.dxos.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  tags: ['system'],\n};\n"],
+  "mappings": ";AAKA,SAASA,YAAY;AAEd,IAAMC,OAAoB;EAC/BC,IAAI;EACJC,MAAM;EACNC,aAAaJ;;;;EAIbK,MAAM;IAAC;;AACT;",
+  "names": ["trim", "meta", "id", "name", "description", "tags"]
+}

package/dist/lib/neutral/index.mjs

@@ -0,0 +1,7 @@
+import {
+  meta
+} from "./chunk-SCMZU5OW.mjs";
+export {
+  meta
+};
+//# sourceMappingURL=index.mjs.map

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

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": [],
+  "sourcesContent": [],
+  "mappings": "",
+  "names": []
+}

package/dist/lib/neutral/meta.json

@@ -0,0 +1 @@
+{"inputs":{"src/meta.ts":{"bytes":1406,"imports":[{"path":"@dxos/util","kind":"import-statement","external":true}],"format":"esm"},"src/index.ts":{"bytes":368,"imports":[{"path":"src/meta.ts","kind":"import-statement","original":"./meta"}],"format":"esm"},"src/PwaPlugin.tsx":{"bytes":7521,"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":"#meta","kind":"import-statement","external":true},{"path":"#translations","kind":"import-statement","external":true}],"format":"esm"},"src/plugin.ts":{"bytes":844,"imports":[{"path":"@dxos/app-framework","kind":"import-statement","external":true},{"path":"src/meta.ts","kind":"import-statement","original":"./meta"},{"path":"#plugin","kind":"dynamic-import","external":true}],"format":"esm"},"src/translations.ts":{"bytes":2366,"imports":[{"path":"#meta","kind":"import-statement","external":true}],"format":"esm"}},"outputs":{"dist/lib/neutral/index.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":93},"dist/lib/neutral/index.mjs":{"imports":[{"path":"dist/lib/neutral/chunk-SCMZU5OW.mjs","kind":"import-statement"}],"exports":["meta"],"entryPoint":"src/index.ts","inputs":{"src/index.ts":{"bytesInOutput":0}},"bytes":101},"dist/lib/neutral/PwaPlugin.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":3118},"dist/lib/neutral/PwaPlugin.mjs":{"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":"#meta","kind":"import-statement","external":true},{"path":"#translations","kind":"import-statement","external":true}],"exports":["PwaPlugin","default"],"entryPoint":"src/PwaPlugin.tsx","inputs":{"src/PwaPlugin.tsx":{"bytesInOutput":2091}},"bytes":2207},"dist/lib/neutral/meta.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":93},"dist/lib/neutral/meta.mjs":{"imports":[{"path":"dist/lib/neutral/chunk-SCMZU5OW.mjs","kind":"import-statement"}],"exports":["meta"],"entryPoint":"src/meta.ts","inputs":{},"bytes":100},"dist/lib/neutral/plugin.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":433},"dist/lib/neutral/plugin.mjs":{"imports":[{"path":"dist/lib/neutral/chunk-SCMZU5OW.mjs","kind":"import-statement"},{"path":"@dxos/app-framework","kind":"import-statement","external":true},{"path":"#plugin","kind":"dynamic-import","external":true}],"exports":["PwaPlugin"],"entryPoint":"src/plugin.ts","inputs":{"src/plugin.ts":{"bytesInOutput":106}},"bytes":231},"dist/lib/neutral/chunk-SCMZU5OW.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":698},"dist/lib/neutral/chunk-SCMZU5OW.mjs":{"imports":[{"path":"@dxos/util","kind":"import-statement","external":true}],"exports":["meta"],"inputs":{"src/meta.ts":{"bytesInOutput":319}},"bytes":398},"dist/lib/neutral/translations.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":1106},"dist/lib/neutral/translations.mjs":{"imports":[{"path":"#meta","kind":"import-statement","external":true}],"exports":["translations"],"entryPoint":"src/translations.ts","inputs":{"src/translations.ts":{"bytesInOutput":639}},"bytes":731}}}

package/dist/lib/neutral/meta.mjs

@@ -0,0 +1,7 @@
+import {
+  meta
+} from "./chunk-SCMZU5OW.mjs";
+export {
+  meta
+};
+//# sourceMappingURL=meta.mjs.map

package/dist/lib/neutral/meta.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": [],
+  "sourcesContent": [],
+  "mappings": "",
+  "names": []
+}

package/dist/lib/neutral/plugin.mjs

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

package/dist/lib/neutral/plugin.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "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": ";;;;;AAIA,SAASA,cAAc;AAIhB,IAAMC,YAAYC,OAAOC,KAAKC,MAAM,MAAM,OAAO,SAAA,CAAA;",
+  "names": ["Plugin", "PwaPlugin", "Plugin", "lazy", "meta"]
+}

package/dist/lib/neutral/translations.mjs

@@ -0,0 +1,22 @@
+// src/translations.ts
+import { meta } from "#meta";
+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"
+      }
+    }
+  }
+];
+export {
+  translations
+};
+//# sourceMappingURL=translations.mjs.map

package/dist/lib/neutral/translations.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "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.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": ";AAMA,SAASA,YAAY;AAEd,IAAMC,eAAe;EAC1B;IACE,SAAS;MACP,CAACD,KAAKE,EAAE,GAAG;QACT,sBAAsB;QACtB,4BAA4B;QAC5B,iBAAiB;QACjB,eAAe;;;QAGf,uBAAuB;QACvB,iBAAiB;MACnB;IACF;EACF;;",
+  "names": ["meta", "translations", "id"]
+}

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

@@ -1,2 +1,4 @@
-export declare const PwaPlugin: () => import("@dxos/app-framework").Plugin;
+import { Plugin } from '@dxos/app-framework';
+export declare const PwaPlugin: Plugin.PluginFactory<void>;
+export default PwaPlugin;
 //# sourceMappingURL=PwaPlugin.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"PwaPlugin.d.ts","sourceRoot":"","sources":["../../../src/PwaPlugin.tsx"],"names":[],"mappings":"AAqBA,eAAO,MAAM,SAAS,4CAiDlB,CAAC"}
+{"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"}

package/dist/types/src/index.d.ts

@@ -1,3 +1,2 @@
 export * from './meta';
-export * from './PwaPlugin';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAIA,cAAc,QAAQ,CAAC;AACvB,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAIA,cAAc,QAAQ,CAAC"}

package/dist/types/src/meta.d.ts

@@ -1,4 +1,3 @@
-import { type PluginMeta } from '@dxos/app-framework';
-export declare const PWA_PLUGIN = "dxos.org/plugin/pwa";
-export declare const meta: PluginMeta;
+import { type Plugin } from '@dxos/app-framework';
+export declare const meta: Plugin.Meta;
 //# sourceMappingURL=meta.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"meta.d.ts","sourceRoot":"","sources":["../../../src/meta.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEtD,eAAO,MAAM,UAAU,wBAAwB,CAAC;AAEhD,eAAO,MAAM,IAAI,EAAE,UAGlB,CAAC"}
+{"version":3,"file":"meta.d.ts","sourceRoot":"","sources":["../../../src/meta.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAGlD,eAAO,MAAM,IAAI,EAAE,MAAM,CAAC,IAQzB,CAAC"}

package/dist/types/src/plugin.d.ts

@@ -0,0 +1,3 @@
+import { Plugin } from '@dxos/app-framework';
+export declare const PwaPlugin: Plugin.PluginFactory<void>;
+//# sourceMappingURL=plugin.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../../src/plugin.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAI7C,eAAO,MAAM,SAAS,4BAA6C,CAAC"}

package/dist/types/src/translations.d.ts

@@ -1,13 +1,12 @@
-import { meta } from './meta';
 export declare const translations: [{
     readonly 'en-US': {
-        readonly [meta.id]: {
-            readonly 'need refresh label': "Refresh now to get app updates";
-            readonly 'need refresh description': "You’ll need these updates to continue without interruption.";
-            readonly 'refresh label': "Refresh";
-            readonly 'refresh alt': "Click your browser’s refresh button or use the refresh keyboard shortcut.";
-            readonly 'offline ready label': "Ready to use offline.";
-            readonly 'confirm label': "Okay";
+        readonly [x: string]: {
+            readonly 'need-refresh.label': 'Refresh now to get app updates';
+            readonly 'need-refresh.description': 'You\u2019ll need these updates to continue without interruption.';
+            readonly 'refresh.label': 'Refresh';
+            readonly 'refresh.alt': 'Click your browser\u2019s refresh button or use the refresh keyboard shortcut.';
+            readonly 'offline-ready.label': 'Ready to use offline.';
+            readonly 'confirm.label': 'Okay';
         };
     };
 }];

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

@@ -1 +1 @@
-{"version":3,"file":"translations.d.ts","sourceRoot":"","sources":["../../../src/translations.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,eAAO,MAAM,YAAY;;QAGnB,SAAA,CAAC,IAAI,CAAC,EAAE,CAAC;;;;;;;UASR;;EAGwB,CAAC"}
+{"version":3,"file":"translations.d.ts","sourceRoot":"","sources":["../../../src/translations.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,YAAY;;;2CAIK,gCAAgC;iDAC1B,kEAA6D;sCACxE,SAAS;oCACX,gFAA2E;4CAGnE,uBAAuB;sCAC7B,MAAM;;;EAIA,CAAC"}