@dxos/plugin-pwa 0.8.4-main.f9ba587 → 0.8.4-main.fcfe5033a5
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 +85 -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 +7 -7
- package/dist/types/src/translations.d.ts.map +1 -1
- package/dist/types/tsconfig.tsbuildinfo +1 -1
- package/package.json +31 -21
- package/src/PwaPlugin.tsx +38 -59
- package/src/meta.ts +8 -5
- package/src/translations.ts +7 -7
- package/dist/lib/node-esm/index.mjs +0 -117
- package/dist/lib/node-esm/index.mjs.map +0 -7
- package/dist/lib/node-esm/meta.json +0 -1
|
@@ -1,29 +1,36 @@
|
|
|
1
1
|
// src/meta.ts
|
|
2
|
-
|
|
2
|
+
import { trim } from "@dxos/util";
|
|
3
3
|
var meta = {
|
|
4
|
-
id:
|
|
5
|
-
name: "PWA"
|
|
4
|
+
id: "org.dxos.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 {
|
|
18
|
+
import { meta as meta3 } from "#meta";
|
|
13
19
|
|
|
14
20
|
// src/translations.ts
|
|
21
|
+
import { meta as meta2 } from "#meta";
|
|
15
22
|
var translations = [
|
|
16
23
|
{
|
|
17
24
|
"en-US": {
|
|
18
|
-
[
|
|
19
|
-
"need
|
|
20
|
-
"need
|
|
21
|
-
"refresh
|
|
22
|
-
"refresh
|
|
25
|
+
[meta2.id]: {
|
|
26
|
+
"need-refresh.label": "Refresh now to get app updates",
|
|
27
|
+
"need-refresh.description": "You\u2019ll need these updates to continue without interruption.",
|
|
28
|
+
"refresh.label": "Refresh",
|
|
29
|
+
"refresh.alt": "Click your browser\u2019s refresh button or use the refresh keyboard shortcut.",
|
|
23
30
|
// TODO(wittjosiah): Non-react translation utils.
|
|
24
31
|
// 'offline ready label': '{{appName}} is ready to use offline.',
|
|
25
|
-
"offline
|
|
26
|
-
"confirm
|
|
32
|
+
"offline-ready.label": "Ready to use offline.",
|
|
33
|
+
"confirm.label": "Okay"
|
|
27
34
|
}
|
|
28
35
|
}
|
|
29
36
|
}
|
|
@@ -31,84 +38,74 @@ var translations = [
|
|
|
31
38
|
|
|
32
39
|
// src/PwaPlugin.tsx
|
|
33
40
|
var __dxlog_file = "/__w/dxos/dxos/packages/plugins/plugin-pwa/src/PwaPlugin.tsx";
|
|
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
|
-
}
|
|
41
|
+
var PwaPlugin = Plugin.define(meta3).pipe(AppPlugin.addTranslationsModule({
|
|
42
|
+
translations
|
|
43
|
+
}), Plugin.addModule({
|
|
44
|
+
id: "register-pwa",
|
|
45
|
+
activatesOn: ActivationEvents.OperationInvokerReady,
|
|
46
|
+
activate: Effect.fnUntraced(function* () {
|
|
47
|
+
const { invokePromise } = yield* Capability.get(Capabilities.OperationInvoker);
|
|
48
|
+
const updateSW = registerSW({
|
|
49
|
+
onNeedRefresh: () => {
|
|
50
|
+
void invokePromise(LayoutOperation.AddToast, {
|
|
51
|
+
id: `${meta3.id}.need-refresh`,
|
|
52
|
+
title: [
|
|
53
|
+
"need-refresh.label",
|
|
54
|
+
{
|
|
55
|
+
ns: meta3.id
|
|
56
|
+
}
|
|
57
|
+
],
|
|
58
|
+
description: [
|
|
59
|
+
"need-refresh.description",
|
|
60
|
+
{
|
|
61
|
+
ns: meta3.id
|
|
62
|
+
}
|
|
63
|
+
],
|
|
64
|
+
duration: 4 * 60 * 1e3,
|
|
65
|
+
actionLabel: [
|
|
66
|
+
"refresh.label",
|
|
67
|
+
{
|
|
68
|
+
ns: meta3.id
|
|
69
|
+
}
|
|
70
|
+
],
|
|
71
|
+
actionAlt: [
|
|
72
|
+
"refresh.alt",
|
|
73
|
+
{
|
|
74
|
+
ns: meta3.id
|
|
75
|
+
}
|
|
76
|
+
],
|
|
77
|
+
onAction: () => updateSW(true)
|
|
78
|
+
});
|
|
79
|
+
},
|
|
80
|
+
onOfflineReady: () => {
|
|
81
|
+
void invokePromise(LayoutOperation.AddToast, {
|
|
82
|
+
id: `${meta3.id}.offline-ready`,
|
|
83
|
+
title: [
|
|
84
|
+
"offline-ready.label",
|
|
85
|
+
{
|
|
86
|
+
ns: meta3.id
|
|
87
|
+
}
|
|
88
|
+
],
|
|
89
|
+
closeLabel: [
|
|
90
|
+
"confirm.label",
|
|
91
|
+
{
|
|
92
|
+
ns: meta3.id
|
|
93
|
+
}
|
|
94
|
+
]
|
|
95
|
+
});
|
|
96
|
+
},
|
|
97
|
+
onRegisterError: (err) => {
|
|
98
|
+
log.error(err, void 0, {
|
|
99
|
+
F: __dxlog_file,
|
|
100
|
+
L: 44,
|
|
101
|
+
S: this,
|
|
102
|
+
C: (f, a) => f(...a)
|
|
103
|
+
});
|
|
104
|
+
}
|
|
105
|
+
});
|
|
108
106
|
})
|
|
109
|
-
|
|
107
|
+
}), Plugin.make);
|
|
110
108
|
export {
|
|
111
|
-
PWA_PLUGIN,
|
|
112
109
|
PwaPlugin,
|
|
113
110
|
meta
|
|
114
111
|
};
|
|
@@ -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: '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};\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';\n\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", "//\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;AAEpB,SAASC,QAAAA,aAAY;;;ACLrB,SAASC,QAAAA,aAAY;AAEd,IAAMC,eAAe;EAC1B;IACE,SAAS;MACP,CAACC,MAAKC,EAAE,GAAG;QACT,sBAAsB;QACtB,4BAA4B;QAC5B,iBAAiB;QACjB,eAAe;;;QAGf,uBAAuB;QACvB,iBAAiB;MACnB;IACF;EACF;;;;;ADPK,IAAMC,YAAYC,OAAOC,OAAOC,KAAAA,EAAMC,KAC3CC,UAAUC,sBAAsB;EAAEC;AAAa,CAAA,GAC/CN,OAAOO,UAAU;EACfC,IAAI;EACJC,aAAaC,iBAAiBC;EAC9BC,UAAiBC,kBAAW,aAAA;AAC1B,UAAM,EAAEC,cAAa,IAAK,OAAOC,WAAWC,IAAIC,aAAaC,gBAAgB;AAE7E,UAAMC,WAAWC,WAAW;MAC1BC,eAAe,MAAA;AACb,aAAKP,cAAcQ,gBAAgBC,UAAU;UAC3Cf,IAAI,GAAGN,MAAKM,EAAE;UACdgB,OAAO;YAAC;YAAsB;cAAEC,IAAIvB,MAAKM;YAAG;;UAC5CkB,aAAa;YAAC;YAA4B;cAAED,IAAIvB,MAAKM;YAAG;;UACxDmB,UAAU,IAAI,KAAK;UACnBC,aAAa;YAAC;YAAiB;cAAEH,IAAIvB,MAAKM;YAAG;;UAC7CqB,WAAW;YAAC;YAAe;cAAEJ,IAAIvB,MAAKM;YAAG;;UACzCsB,UAAU,MAAMX,SAAS,IAAA;QAC3B,CAAA;MACF;MACAY,gBAAgB,MAAA;AACd,aAAKjB,cAAcQ,gBAAgBC,UAAU;UAC3Cf,IAAI,GAAGN,MAAKM,EAAE;UACdgB,OAAO;YAAC;YAAuB;cAAEC,IAAIvB,MAAKM;YAAG;;UAC7CwB,YAAY;YAAC;YAAiB;cAAEP,IAAIvB,MAAKM;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", "meta", "meta", "translations", "meta", "id", "PwaPlugin", "Plugin", "define", "meta", "pipe", "AppPlugin", "addTranslationsModule", "translations", "addModule", "id", "activatesOn", "ActivationEvents", "OperationInvokerReady", "activate", "fnUntraced", "invokePromise", "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":{"src/meta.ts":{"bytes":
|
|
1
|
+
{"inputs":{"src/meta.ts":{"bytes":1383,"imports":[{"path":"@dxos/util","kind":"import-statement","external":true}],"format":"esm"},"src/translations.ts":{"bytes":2451,"imports":[{"path":"#meta","kind":"import-statement","external":true}],"format":"esm"},"src/PwaPlugin.tsx":{"bytes":7552,"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":"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":5105},"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},{"path":"#meta","kind":"import-statement","external":true},{"path":"#meta","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":2074},"src/translations.ts":{"bytesInOutput":649}},"bytes":3164}}}
|
|
@@ -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;AAQzF,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,13 +1,13 @@
|
|
|
1
|
-
import { meta } from '
|
|
1
|
+
import { meta } from '#meta';
|
|
2
2
|
export declare const translations: [{
|
|
3
3
|
readonly 'en-US': {
|
|
4
4
|
readonly [meta.id]: {
|
|
5
|
-
readonly 'need
|
|
6
|
-
readonly 'need
|
|
7
|
-
readonly 'refresh
|
|
8
|
-
readonly 'refresh
|
|
9
|
-
readonly 'offline
|
|
10
|
-
readonly 'confirm
|
|
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";
|
|
11
11
|
};
|
|
12
12
|
};
|
|
13
13
|
}];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"translations.d.ts","sourceRoot":"","sources":["../../../src/translations.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,IAAI,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"translations.d.ts","sourceRoot":"","sources":["../../../src/translations.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC;AAE7B,eAAO,MAAM,YAAY;;QAGnB,SAAA,CAAC,IAAI,CAAC,EAAE,CAAC;;;;;;;UASR;;EAGwB,CAAC"}
|