@dxos/plugin-pwa 0.8.3 → 0.8.4-main.1068cf700f

package/package.json

@@ -1,15 +1,20 @@
 {
   "name": "@dxos/plugin-pwa",
-  "version": "0.8.3",
+  "version": "0.8.4-main.1068cf700f",
   "description": "DXOS Surface plugin for PWA registration and update handling.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dxos/dxos"
+  },
   "license": "MIT",
   "author": "DXOS.org",
   "sideEffects": true,
   "type": "module",
   "exports": {
     ".": {
+      "source": "./src/index.ts",
       "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs"
     }
@@ -23,32 +28,32 @@
     "src"
   ],
   "dependencies": {
-    "@preact-signals/safe-react": "^0.9.0",
-    "effect": "^3.13.3",
-    "@dxos/app-framework": "0.8.3",
-    "@dxos/observability": "0.8.3",
-    "@dxos/log": "0.8.3"
+    "effect": "3.19.16",
+    "@dxos/app-framework": "0.8.4-main.1068cf700f",
+    "@dxos/log": "0.8.4-main.1068cf700f",
+    "@dxos/util": "0.8.4-main.1068cf700f",
+    "@dxos/app-toolkit": "0.8.4-main.1068cf700f",
+    "@dxos/observability": "0.8.4-main.1068cf700f",
+    "@dxos/operation": "0.8.4-main.1068cf700f"
   },
   "devDependencies": {
-    "@phosphor-icons/react": "^2.1.5",
-    "@types/react": "~18.2.0",
-    "@types/react-dom": "~18.2.0",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
-    "vite": "5.4.7",
-    "vite-plugin-pwa": "^0.18.2",
-    "workbox-window": "^7.0.0",
-    "@dxos/react-ui": "0.8.3",
-    "@dxos/storybook-utils": "0.8.3",
-    "@dxos/react-ui-theme": "0.8.3"
+    "@types/react": "~19.2.7",
+    "@types/react-dom": "~19.2.3",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "vite": "7.1.9",
+    "vite-plugin-pwa": "^1.0.2",
+    "workbox-window": "^7.3.0",
+    "@dxos/ui-theme": "0.8.4-main.1068cf700f",
+    "@dxos/storybook-utils": "0.8.4-main.1068cf700f",
+    "@dxos/react-ui": "0.8.4-main.1068cf700f"
   },
   "peerDependencies": {
-    "@phosphor-icons/react": "^2.1.5",
-    "effect": "^3.13.3",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
-    "@dxos/react-ui": "0.8.3",
-    "@dxos/react-ui-theme": "0.8.3"
+    "effect": "3.19.16",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "@dxos/react-ui": "0.8.4-main.1068cf700f",
+    "@dxos/ui-theme": "0.8.4-main.1068cf700f"
   },
   "publishConfig": {
     "access": "public"

package/src/PwaPlugin.tsx

@@ -2,70 +2,48 @@
 // Copyright 2023 DXOS.org
 //
 
+import * as Effect from 'effect/Effect';
 import { registerSW } from 'virtual:pwa-register';
 
-import {
-  Capabilities,
-  contributes,
-  createIntent,
-  defineModule,
-  definePlugin,
-  Events,
-  LayoutAction,
-} from '@dxos/app-framework';
+import { ActivationEvents, Capabilities, Capability, Plugin } from '@dxos/app-framework';
+import { AppPlugin, LayoutOperation } from '@dxos/app-toolkit';
 import { log } from '@dxos/log';
-import { captureException } from '@dxos/observability/sentry';
 
-import { meta, PWA_PLUGIN } from './meta';
-import translations from './translations';
+import { meta } from './meta';
+import { translations } from './translations';
 
-export const PwaPlugin = () =>
-  definePlugin(meta, [
-    defineModule({
-      id: `${meta.id}/module/translations`,
-      activatesOn: Events.SetupTranslations,
-      activate: () => contributes(Capabilities.Translations, translations),
-    }),
-    defineModule({
-      id: `${meta.id}/module/register-pwa`,
-      activatesOn: Events.DispatcherReady,
-      activate: (context) => {
-        const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);
-
-        const updateSW = registerSW({
-          onNeedRefresh: () =>
-            dispatch?.(
-              createIntent(LayoutAction.AddToast, {
-                part: 'toast',
-                subject: {
-                  id: `${PWA_PLUGIN}/need-refresh`,
-                  title: ['need refresh label', { ns: PWA_PLUGIN }],
-                  description: ['need refresh description', { ns: PWA_PLUGIN }],
-                  duration: 4 * 60 * 1000, // 4m
-                  actionLabel: ['refresh label', { ns: PWA_PLUGIN }],
-                  actionAlt: ['refresh alt', { ns: PWA_PLUGIN }],
-                  onAction: () => updateSW(true),
-                },
-              }),
-            ),
-          onOfflineReady: () =>
-            dispatch?.(
-              createIntent(LayoutAction.AddToast, {
-                part: 'toast',
-                subject: {
-                  id: `${PWA_PLUGIN}/offline-ready`,
-                  title: ['offline ready label', { ns: PWA_PLUGIN }],
-                  closeLabel: ['confirm label', { ns: PWA_PLUGIN }],
-                },
-              }),
-            ),
-          onRegisterError: (err) => {
-            captureException(err);
-            log.error(err);
-          },
-        });
+export const 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);
 
-        return contributes(Capabilities.Null, null);
-      },
+      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 * 1000, // 4m
+            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);
+        },
+      });
     }),
-  ]);
+  }),
+  Plugin.make,
+);

package/src/meta.ts

@@ -2,11 +2,14 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type PluginMeta } from '@dxos/app-framework';
+import { type Plugin } from '@dxos/app-framework';
+import { trim } from '@dxos/util';
 
-export const PWA_PLUGIN = 'dxos.org/plugin/pwa';
-
-export const meta: PluginMeta = {
-  id: PWA_PLUGIN,
+export const meta: Plugin.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.
+  `,
 };

package/src/translations.ts

@@ -2,12 +2,14 @@
 // Copyright 2022 DXOS.org
 //
 
-import { PWA_PLUGIN } from './meta';
+import { type Resource } from '@dxos/react-ui';
 
-export default [
+import { meta } from './meta';
+
+export const translations = [
   {
     'en-US': {
-      [PWA_PLUGIN]: {
+      [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',
@@ -19,4 +21,4 @@ export default [
       },
     },
   },
-];
+] as const satisfies Resource[];