@dxos/plugin-pwa 0.8.3 → 0.8.4-main.1068cf700f
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/lib/browser/index.mjs +83 -88
- package/dist/lib/browser/index.mjs.map +3 -3
- package/dist/lib/browser/meta.json +1 -1
- package/dist/types/src/PwaPlugin.d.ts +2 -1
- package/dist/types/src/PwaPlugin.d.ts.map +1 -1
- package/dist/types/src/meta.d.ts +2 -3
- package/dist/types/src/meta.d.ts.map +1 -1
- package/dist/types/src/translations.d.ts +11 -11
- package/dist/types/src/translations.d.ts.map +1 -1
- package/dist/types/tsconfig.tsbuildinfo +1 -1
- package/package.json +28 -23
- package/src/PwaPlugin.tsx +38 -60
- package/src/meta.ts +8 -5
- package/src/translations.ts +6 -4
|
@@ -1,21 +1,26 @@
|
|
|
1
|
-
//
|
|
2
|
-
|
|
1
|
+
// src/meta.ts
|
|
2
|
+
import { trim } from "@dxos/util";
|
|
3
3
|
var meta = {
|
|
4
|
-
id:
|
|
5
|
-
name: "PWA"
|
|
4
|
+
id: "dxos.org/plugin/pwa",
|
|
5
|
+
name: "PWA",
|
|
6
|
+
description: trim`
|
|
7
|
+
Progressive Web App capabilities enabling offline functionality and app-like experience.
|
|
8
|
+
Install to home screen and use the workspace without internet connection.
|
|
9
|
+
`
|
|
6
10
|
};
|
|
7
11
|
|
|
8
|
-
//
|
|
12
|
+
// src/PwaPlugin.tsx
|
|
13
|
+
import * as Effect from "effect/Effect";
|
|
9
14
|
import { registerSW } from "virtual:pwa-register";
|
|
10
|
-
import {
|
|
15
|
+
import { ActivationEvents, Capabilities, Capability, Plugin } from "@dxos/app-framework";
|
|
16
|
+
import { AppPlugin, LayoutOperation } from "@dxos/app-toolkit";
|
|
11
17
|
import { log } from "@dxos/log";
|
|
12
|
-
import { captureException } from "@dxos/observability/sentry";
|
|
13
18
|
|
|
14
|
-
//
|
|
15
|
-
var
|
|
19
|
+
// src/translations.ts
|
|
20
|
+
var translations = [
|
|
16
21
|
{
|
|
17
22
|
"en-US": {
|
|
18
|
-
[
|
|
23
|
+
[meta.id]: {
|
|
19
24
|
"need refresh label": "Refresh now to get app updates",
|
|
20
25
|
"need refresh description": "You\u2019ll need these updates to continue without interruption.",
|
|
21
26
|
"refresh label": "Refresh",
|
|
@@ -29,86 +34,76 @@ var translations_default = [
|
|
|
29
34
|
}
|
|
30
35
|
];
|
|
31
36
|
|
|
32
|
-
//
|
|
33
|
-
var __dxlog_file = "/
|
|
34
|
-
var PwaPlugin = ()
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
F: __dxlog_file,
|
|
100
|
-
L: 64,
|
|
101
|
-
S: void 0,
|
|
102
|
-
C: (f, a) => f(...a)
|
|
103
|
-
});
|
|
104
|
-
}
|
|
105
|
-
});
|
|
106
|
-
return contributes(Capabilities.Null, null);
|
|
107
|
-
}
|
|
37
|
+
// src/PwaPlugin.tsx
|
|
38
|
+
var __dxlog_file = "/__w/dxos/dxos/packages/plugins/plugin-pwa/src/PwaPlugin.tsx";
|
|
39
|
+
var PwaPlugin = Plugin.define(meta).pipe(AppPlugin.addTranslationsModule({
|
|
40
|
+
translations
|
|
41
|
+
}), Plugin.addModule({
|
|
42
|
+
id: "register-pwa",
|
|
43
|
+
activatesOn: ActivationEvents.OperationInvokerReady,
|
|
44
|
+
activate: Effect.fnUntraced(function* () {
|
|
45
|
+
const { invokeSync } = yield* Capability.get(Capabilities.OperationInvoker);
|
|
46
|
+
const updateSW = registerSW({
|
|
47
|
+
onNeedRefresh: () => {
|
|
48
|
+
invokeSync(LayoutOperation.AddToast, {
|
|
49
|
+
id: `${meta.id}/need-refresh`,
|
|
50
|
+
title: [
|
|
51
|
+
"need refresh label",
|
|
52
|
+
{
|
|
53
|
+
ns: meta.id
|
|
54
|
+
}
|
|
55
|
+
],
|
|
56
|
+
description: [
|
|
57
|
+
"need refresh description",
|
|
58
|
+
{
|
|
59
|
+
ns: meta.id
|
|
60
|
+
}
|
|
61
|
+
],
|
|
62
|
+
duration: 4 * 60 * 1e3,
|
|
63
|
+
actionLabel: [
|
|
64
|
+
"refresh label",
|
|
65
|
+
{
|
|
66
|
+
ns: meta.id
|
|
67
|
+
}
|
|
68
|
+
],
|
|
69
|
+
actionAlt: [
|
|
70
|
+
"refresh alt",
|
|
71
|
+
{
|
|
72
|
+
ns: meta.id
|
|
73
|
+
}
|
|
74
|
+
],
|
|
75
|
+
onAction: () => updateSW(true)
|
|
76
|
+
});
|
|
77
|
+
},
|
|
78
|
+
onOfflineReady: () => {
|
|
79
|
+
invokeSync(LayoutOperation.AddToast, {
|
|
80
|
+
id: `${meta.id}/offline-ready`,
|
|
81
|
+
title: [
|
|
82
|
+
"offline ready label",
|
|
83
|
+
{
|
|
84
|
+
ns: meta.id
|
|
85
|
+
}
|
|
86
|
+
],
|
|
87
|
+
closeLabel: [
|
|
88
|
+
"confirm label",
|
|
89
|
+
{
|
|
90
|
+
ns: meta.id
|
|
91
|
+
}
|
|
92
|
+
]
|
|
93
|
+
});
|
|
94
|
+
},
|
|
95
|
+
onRegisterError: (err) => {
|
|
96
|
+
log.error(err, void 0, {
|
|
97
|
+
F: __dxlog_file,
|
|
98
|
+
L: 43,
|
|
99
|
+
S: this,
|
|
100
|
+
C: (f, a) => f(...a)
|
|
101
|
+
});
|
|
102
|
+
}
|
|
103
|
+
});
|
|
108
104
|
})
|
|
109
|
-
|
|
105
|
+
}), Plugin.make);
|
|
110
106
|
export {
|
|
111
|
-
PWA_PLUGIN,
|
|
112
107
|
PwaPlugin,
|
|
113
108
|
meta
|
|
114
109
|
};
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../../src/meta.ts", "../../../src/PwaPlugin.tsx", "../../../src/translations.ts"],
|
|
4
|
-
"sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { type
|
|
5
|
-
"mappings": ";
|
|
6
|
-
"names": ["
|
|
4
|
+
"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"],
|
|
5
|
+
"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;",
|
|
6
|
+
"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"]
|
|
7
7
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"inputs":{"
|
|
1
|
+
{"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}}}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PwaPlugin.d.ts","sourceRoot":"","sources":["../../../src/PwaPlugin.tsx"],"names":[],"mappings":"
|
|
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"}
|
package/dist/types/src/meta.d.ts
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { type
|
|
2
|
-
export declare const
|
|
3
|
-
export declare const meta: PluginMeta;
|
|
1
|
+
import { type Plugin } from '@dxos/app-framework';
|
|
2
|
+
export declare const meta: Plugin.Meta;
|
|
4
3
|
//# sourceMappingURL=meta.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"meta.d.ts","sourceRoot":"","sources":["../../../src/meta.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,
|
|
1
|
+
{"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,IAOzB,CAAC"}
|
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
'need refresh
|
|
6
|
-
'refresh
|
|
7
|
-
'refresh
|
|
8
|
-
'
|
|
9
|
-
'
|
|
1
|
+
import { meta } from './meta';
|
|
2
|
+
export declare const translations: [{
|
|
3
|
+
readonly 'en-US': {
|
|
4
|
+
readonly [meta.id]: {
|
|
5
|
+
readonly 'need refresh label': "Refresh now to get app updates";
|
|
6
|
+
readonly 'need refresh description': "You’ll need these updates to continue without interruption.";
|
|
7
|
+
readonly 'refresh label': "Refresh";
|
|
8
|
+
readonly 'refresh alt': "Click your browser’s refresh button or use the refresh keyboard shortcut.";
|
|
9
|
+
readonly 'offline ready label': "Ready to use offline.";
|
|
10
|
+
readonly 'confirm label': "Okay";
|
|
10
11
|
};
|
|
11
12
|
};
|
|
12
|
-
}
|
|
13
|
-
export default _default;
|
|
13
|
+
}];
|
|
14
14
|
//# sourceMappingURL=translations.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"translations.d.ts","sourceRoot":"","sources":["../../../src/translations.ts"],"names":[],"mappings":"
|
|
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"}
|