@swoff/cli 0.3.7 → 0.3.9
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/README.md +53 -606
- package/dist/__tests__/assemble-sw.test.js +8 -38
- package/dist/__tests__/assemble-sw.test.js.map +1 -1
- package/dist/__tests__/cli-integration.test.js +119 -11
- package/dist/__tests__/cli-integration.test.js.map +1 -1
- package/dist/__tests__/config-types.test.js +38 -18
- package/dist/__tests__/config-types.test.js.map +1 -1
- package/dist/__tests__/file-generators.test.js +2 -2
- package/dist/__tests__/file-generators.test.js.map +1 -1
- package/dist/__tests__/glob-matcher.test.js +86 -0
- package/dist/__tests__/glob-matcher.test.js.map +1 -0
- package/dist/__tests__/invalidation-tags.test.js +207 -23
- package/dist/__tests__/invalidation-tags.test.js.map +1 -1
- package/dist/__tests__/loader.test.js +12 -12
- package/dist/__tests__/loader.test.js.map +1 -1
- package/dist/__tests__/validator.test.js +170 -74
- package/dist/__tests__/validator.test.js.map +1 -1
- package/dist/index.js +12 -11
- package/dist/index.js.map +1 -1
- package/dist/lib/cli/help.js +0 -5
- package/dist/lib/cli/help.js.map +1 -1
- package/dist/lib/commands/add.js +52 -33
- package/dist/lib/commands/add.js.map +1 -1
- package/dist/lib/commands/clean.js +1 -15
- package/dist/lib/commands/clean.js.map +1 -1
- package/dist/lib/commands/generate-guide.js +5 -5
- package/dist/lib/commands/generate-guide.js.map +1 -1
- package/dist/lib/commands/generate.js +7 -21
- package/dist/lib/commands/generate.js.map +1 -1
- package/dist/lib/commands/info.js +37 -12
- package/dist/lib/commands/info.js.map +1 -1
- package/dist/lib/commands/init.js +2 -10
- package/dist/lib/commands/init.js.map +1 -1
- package/dist/lib/commands/validate.js +3 -3
- package/dist/lib/commands/validate.js.map +1 -1
- package/dist/lib/config/loader.js +3 -6
- package/dist/lib/config/loader.js.map +1 -1
- package/dist/lib/config/validator.js +192 -42
- package/dist/lib/config/validator.js.map +1 -1
- package/dist/lib/generators/file-generators/cache.js +2 -10
- package/dist/lib/generators/file-generators/cache.js.map +1 -1
- package/dist/lib/generators/file-generators/client-injector.js +51 -12
- package/dist/lib/generators/file-generators/client-injector.js.map +1 -1
- package/dist/lib/generators/file-generators/fetch-wrapper.js +127 -58
- package/dist/lib/generators/file-generators/fetch-wrapper.js.map +1 -1
- package/dist/lib/generators/file-generators/generate-hooks.js +6 -2
- package/dist/lib/generators/file-generators/generate-hooks.js.map +1 -1
- package/dist/lib/generators/file-generators/gql-wrapper.js +139 -0
- package/dist/lib/generators/file-generators/gql-wrapper.js.map +1 -0
- package/dist/lib/generators/file-generators/guide-generator.js +6 -436
- package/dist/lib/generators/file-generators/guide-generator.js.map +1 -1
- package/dist/lib/generators/file-generators/invalidation-tags.js +206 -19
- package/dist/lib/generators/file-generators/invalidation-tags.js.map +1 -1
- package/dist/lib/generators/file-generators/manifest.js +2 -2
- package/dist/lib/generators/file-generators/manifest.js.map +1 -1
- package/dist/lib/generators/file-generators/mutation-queue.js +140 -52
- package/dist/lib/generators/file-generators/mutation-queue.js.map +1 -1
- package/dist/lib/generators/file-generators/mutation-state.js +126 -0
- package/dist/lib/generators/file-generators/mutation-state.js.map +1 -0
- package/dist/lib/generators/file-generators/push.js +6 -7
- package/dist/lib/generators/file-generators/push.js.map +1 -1
- package/dist/lib/generators/file-generators/quick-readme.js +8 -75
- package/dist/lib/generators/file-generators/quick-readme.js.map +1 -1
- package/dist/lib/generators/file-generators/server-push.js +146 -0
- package/dist/lib/generators/file-generators/server-push.js.map +1 -0
- package/dist/lib/generators/file-generators/sw-generator-build.js +8 -9
- package/dist/lib/generators/file-generators/sw-generator-build.js.map +1 -1
- package/dist/lib/generators/file-generators/sw-injector.js +2 -1
- package/dist/lib/generators/file-generators/sw-injector.js.map +1 -1
- package/dist/lib/generators/file-generators/type-definitions.js +26 -1
- package/dist/lib/generators/file-generators/type-definitions.js.map +1 -1
- package/dist/lib/generators/sw-generator.js +8 -18
- package/dist/lib/generators/sw-generator.js.map +1 -1
- package/dist/lib/generators/sw-sections/activate-handler.js.map +1 -1
- package/dist/lib/generators/sw-sections/assemble-sw.js +19 -11
- package/dist/lib/generators/sw-sections/assemble-sw.js.map +1 -1
- package/dist/lib/generators/sw-sections/background-sync-handler.js +80 -24
- package/dist/lib/generators/sw-sections/background-sync-handler.js.map +1 -1
- package/dist/lib/generators/sw-sections/config-header.js +2 -2
- package/dist/lib/generators/sw-sections/config-header.js.map +1 -1
- package/dist/lib/generators/sw-sections/default-template.js +2 -1
- package/dist/lib/generators/sw-sections/default-template.js.map +1 -1
- package/dist/lib/generators/sw-sections/fetch-handler.js +461 -121
- package/dist/lib/generators/sw-sections/fetch-handler.js.map +1 -1
- package/dist/lib/generators/sw-sections/message-handler.js +55 -15
- package/dist/lib/generators/sw-sections/message-handler.js.map +1 -1
- package/dist/lib/generators/sw-sections/server-push-handler.js +114 -0
- package/dist/lib/generators/sw-sections/server-push-handler.js.map +1 -0
- package/dist/lib/generators/sw-sections/sw-push.js +67 -0
- package/dist/lib/generators/sw-sections/sw-push.js.map +1 -0
- package/dist/lib/generators/sw-sections/tag-management.js +62 -21
- package/dist/lib/generators/sw-sections/tag-management.js.map +1 -1
- package/dist/lib/generators/swoff-files-generator.js +12 -16
- package/dist/lib/generators/swoff-files-generator.js.map +1 -1
- package/dist/lib/shared/config-types.js +133 -45
- package/dist/lib/shared/config-types.js.map +1 -1
- package/dist/lib/shared/glob-matcher.js +77 -0
- package/dist/lib/shared/glob-matcher.js.map +1 -0
- package/dist/lib/utils/tty-status.js +21 -0
- package/dist/lib/utils/tty-status.js.map +1 -0
- package/docs/API.md +565 -0
- package/docs/ARCHITECTURE.md +374 -0
- package/docs/CLI.md +148 -0
- package/docs/COMPARISON.md +192 -0
- package/docs/CONFIG.md +277 -0
- package/docs/ECOSYSTEM.md +33 -0
- package/package.json +2 -1
- package/templates/hooks/useAuth.jsx +2 -2
- package/templates/hooks/useAuth.tsx +2 -2
- package/templates/hooks/useCachedFetch.jsx +21 -7
- package/templates/hooks/useCachedFetch.tsx +23 -11
- package/templates/hooks/useMutation.jsx +76 -0
- package/templates/hooks/useMutation.tsx +109 -0
- package/templates/hooks/useMutationQueue.jsx +20 -11
- package/templates/hooks/useMutationQueue.tsx +31 -15
- package/templates/hooks/useMutationState.jsx +13 -0
- package/templates/hooks/useMutationState.tsx +25 -0
- package/templates/hooks/usePrefetch.jsx +10 -0
- package/templates/hooks/usePrefetch.tsx +25 -0
- package/templates/hooks/usePushSubscription.jsx +3 -3
- package/templates/hooks/usePushSubscription.tsx +3 -3
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"activate-handler.js","sourceRoot":"","sources":["../../../../src/lib/generators/sw-sections/activate-handler.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,uBAAuB,CAAC,
|
|
1
|
+
{"version":3,"file":"activate-handler.js","sourceRoot":"","sources":["../../../../src/lib/generators/sw-sections/activate-handler.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,uBAAuB,CAAC,oBAA6B,EAAE,iBAA2B;IAChG,MAAM,YAAY,GAAG,oBAAoB;QACvC,CAAC,CAAC,0CAA0C;QAC5C,CAAC,CAAC,wEAAwE,CAAC;IAE7E,MAAM,cAAc,GAAG,iBAAiB,CAAC,CAAC,CAAC;;;QAGrC,CAAC,CAAC,CAAC,EAAE,CAAC;IAEZ,OAAO;;;;mCAI0B,cAAc;;;UAGvC,YAAY;;;;IAIlB,CAAC;AACL,CAAC"}
|
|
@@ -1,7 +1,3 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Assembles the complete service worker string from config and version.
|
|
3
|
-
* Calls individual section generators and performs placeholder replacement.
|
|
4
|
-
*/
|
|
5
1
|
import { readdirSync, existsSync } from "fs";
|
|
6
2
|
import { join, relative } from "path";
|
|
7
3
|
import { createHash } from "crypto";
|
|
@@ -13,7 +9,8 @@ import { generateMessageHandler } from "./message-handler.js";
|
|
|
13
9
|
import { generateFetchHandler } from "./fetch-handler.js";
|
|
14
10
|
import { generateTagManagement } from "./tag-management.js";
|
|
15
11
|
import { generateBackgroundSyncHandler } from "./background-sync-handler.js";
|
|
16
|
-
import { generateSwPushHandlers } from "
|
|
12
|
+
import { generateSwPushHandlers } from "./sw-push.js";
|
|
13
|
+
import { generateServerPushHandler } from "./server-push-handler.js";
|
|
17
14
|
function collectAssets(dir, baseDir) {
|
|
18
15
|
if (!existsSync(dir))
|
|
19
16
|
return [];
|
|
@@ -39,16 +36,26 @@ function applyReplacements(sw, config, assetsToCache) {
|
|
|
39
36
|
const { features } = config;
|
|
40
37
|
sw = sw.replace("// [[ASSETS_LIST]]", `ASSETS_TO_CACHE = ${JSON.stringify(assetsToCache, null, 2)}`);
|
|
41
38
|
sw = sw.replace("// [[AUTO_SKIP_WAITING]]", `const AUTO_SKIP_WAITING = ${serviceWorker.autoActivate};`);
|
|
42
|
-
|
|
43
|
-
|
|
39
|
+
const { strategy, navigation } = serviceWorker;
|
|
40
|
+
const { refetchQueue } = features;
|
|
41
|
+
const tagInvalidationEnabled = features.tagInvalidation.enabled;
|
|
42
|
+
sw = sw.replace("// [[FETCH_HANDLER]]", generateFetchHandler({
|
|
43
|
+
strategy,
|
|
44
|
+
navigation,
|
|
45
|
+
refetchQueue,
|
|
46
|
+
}, tagInvalidationEnabled, features.mutationQueue.enabled));
|
|
47
|
+
sw = sw.replace("// [[ACTIVATE_HANDLER]]", generateActivateHandler(strategy.clearRuntimeOnUpdate, navigation.preload));
|
|
44
48
|
sw = sw.replace("// [[INSTALL_HANDLER]]", generateInstallHandler());
|
|
45
|
-
sw = sw.replace("// [[MESSAGE_HANDLER]]", generateMessageHandler(
|
|
46
|
-
sw =
|
|
49
|
+
sw = sw.replace("// [[MESSAGE_HANDLER]]", generateMessageHandler(tagInvalidationEnabled, features.tagInvalidation.debounceMs ?? 0));
|
|
50
|
+
sw = tagInvalidationEnabled
|
|
47
51
|
? sw.replace("// [[TAG_MANAGEMENT]]", generateTagManagement())
|
|
48
52
|
: sw.replace("// [[TAG_MANAGEMENT]]", "");
|
|
49
53
|
sw = features.pushNotifications?.enabled
|
|
50
54
|
? sw.replace("// [[PUSH_HANDLERS]]", generateSwPushHandlers())
|
|
51
55
|
: sw.replace("// [[PUSH_HANDLERS]]", "");
|
|
56
|
+
sw = features.serverPush?.enabled
|
|
57
|
+
? sw.replace("// [[SERVER_PUSH_HANDLER]]", generateServerPushHandler(features.serverPush.type, features.serverPush.endpoint, features.serverPush.reconnectDelayMs))
|
|
58
|
+
: sw.replace("// [[SERVER_PUSH_HANDLER]]", "");
|
|
52
59
|
return sw;
|
|
53
60
|
}
|
|
54
61
|
export function assembleSW(config, version, projectRoot) {
|
|
@@ -56,7 +63,7 @@ export function assembleSW(config, version, projectRoot) {
|
|
|
56
63
|
const { features } = config;
|
|
57
64
|
const outputDir = config.build?.outputDir || "dist";
|
|
58
65
|
const swFilename = config.build?.swFilename || "sw";
|
|
59
|
-
const versionEnabled = serviceWorker.version.
|
|
66
|
+
const versionEnabled = serviceWorker.version !== false && serviceWorker.version !== "hash";
|
|
60
67
|
const fallback = ["/index.html"];
|
|
61
68
|
if (features.pwa.enabled)
|
|
62
69
|
fallback.push("/manifest.json");
|
|
@@ -88,7 +95,8 @@ export function assembleSW(config, version, projectRoot) {
|
|
|
88
95
|
}
|
|
89
96
|
if (features.backgroundSync) {
|
|
90
97
|
const authType = features.auth.enabled ? features.auth.type : undefined;
|
|
91
|
-
|
|
98
|
+
const mq = features.mutationQueue;
|
|
99
|
+
sw += `\n\n${generateBackgroundSyncHandler(authType, mq.batchSize, mq.batchDelayMs, mq.maxRetries, mq.retryBackoffMs, config.features.tagInvalidation.enabled)}`;
|
|
92
100
|
}
|
|
93
101
|
return sw;
|
|
94
102
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"assemble-sw.js","sourceRoot":"","sources":["../../../../src/lib/generators/sw-sections/assemble-sw.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"assemble-sw.js","sourceRoot":"","sources":["../../../../src/lib/generators/sw-sections/assemble-sw.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAC7C,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEpC,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAE,6BAA6B,EAAE,MAAM,8BAA8B,CAAC;AAC7E,OAAO,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AACtD,OAAO,EAAE,yBAAyB,EAAE,MAAM,0BAA0B,CAAC;AAErE,SAAS,aAAa,CAAC,GAAW,EAAE,OAAe;IACjD,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;QAAE,OAAO,EAAE,CAAC;IAEhC,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1D,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;YACxB,MAAM,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;QACnD,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;QACjD,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,yBAAyB,CAAC,SAAiB;IAClD,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAC/E,OAAO,YAAY,IAAI,EAAE,CAAC;AAC5B,CAAC;AAED,SAAS,iBAAiB,CAAC,EAAU,EAAE,MAAmB,EAAE,aAAkE;IAC5H,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC;IAC1C,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;IAE5B,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,oBAAoB,EAAE,qBAAqB,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;IACrG,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,0BAA0B,EAAE,6BAA6B,aAAa,CAAC,YAAY,GAAG,CAAC,CAAC;IAExG,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,aAAa,CAAC;IAC/C,MAAM,EAAE,YAAY,EAAE,GAAG,QAAQ,CAAC;IAClC,MAAM,sBAAsB,GAAG,QAAQ,CAAC,eAAe,CAAC,OAAO,CAAC;IAEhE,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,sBAAsB,EAAE,oBAAoB,CAAC;QAC3D,QAAQ;QACR,UAAU;QACV,YAAY;KACb,EAAE,sBAAsB,EAAE,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IAE5D,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,yBAAyB,EAAE,uBAAuB,CAAC,QAAQ,CAAC,oBAAoB,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;IACvH,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,wBAAwB,EAAE,sBAAsB,EAAE,CAAC,CAAC;IACpE,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,wBAAwB,EAAE,sBAAsB,CAAC,sBAAsB,EAAE,QAAQ,CAAC,eAAe,CAAC,UAAU,IAAI,CAAC,CAAC,CAAC,CAAC;IACpI,EAAE,GAAG,sBAAsB;QACzB,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,uBAAuB,EAAE,qBAAqB,EAAE,CAAC;QAC9D,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,uBAAuB,EAAE,EAAE,CAAC,CAAC;IAE5C,EAAE,GAAG,QAAQ,CAAC,iBAAiB,EAAE,OAAO;QACtC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,sBAAsB,EAAE,sBAAsB,EAAE,CAAC;QAC9D,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,sBAAsB,EAAE,EAAE,CAAC,CAAC;IAE3C,EAAE,GAAG,QAAQ,CAAC,UAAU,EAAE,OAAO;QAC/B,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,4BAA4B,EAAE,yBAAyB,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,QAAQ,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;QACnK,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,4BAA4B,EAAE,EAAE,CAAC,CAAC;IAEjD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,MAAmB,EAAE,OAAe,EAAE,WAAoB;IACnF,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC;IAC1C,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;IAC5B,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,EAAE,SAAS,IAAI,MAAM,CAAC;IACpD,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,EAAE,UAAU,IAAI,IAAI,CAAC;IACpD,MAAM,cAAc,GAAG,aAAa,CAAC,OAAO,KAAK,KAAK,IAAI,aAAa,CAAC,OAAO,KAAK,MAAM,CAAC;IAE3F,MAAM,QAAQ,GAAa,CAAC,aAAa,CAAC,CAAC;IAC3C,IAAI,QAAQ,CAAC,GAAG,CAAC,OAAO;QAAE,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAE1D,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;QAC9C,MAAM,SAAS,GAAG,aAAa,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACpD,MAAM,MAAM,GAAG,cAAc,CAAC,CAAC,CAAC,GAAG,UAAU,KAAK,OAAO,KAAK,CAAC,CAAC,CAAC,GAAG,UAAU,KAAK,CAAC;QACpF,KAAK,MAAM,CAAC,IAAI,SAAS,EAAE,CAAC;YAC1B,IAAI,CAAC,KAAK,IAAI,MAAM,EAAE,IAAI,CAAC,KAAK,eAAe;gBAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;IAED,MAAM,aAAa,GAAG,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,QAAQ,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;IAC9F,MAAM,eAAe,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;IAE3E,IAAI,EAAE,GAAG,kBAAkB,EAAE,CAAC;IAE9B,IAAI,cAAc,EAAE,CAAC;QACnB,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,mBAAmB,EAAE,qBAAqB,OAAO,GAAG,CAAC,CAAC;QACtE,EAAE,GAAG,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC;QACpD,EAAE,GAAG,GAAG,oBAAoB,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;IAC3D,CAAC;SAAM,CAAC;QACN,MAAM,QAAQ,GAAG,mBAAmB,CAAC;QACrC,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,mBAAmB,EAAE,iBAAiB,QAAQ,GAAG,CAAC,CAAC;QACnE,EAAE,GAAG,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC;QACpD,MAAM,SAAS,GAAG,yBAAyB,CAAC,EAAE,CAAC,CAAC;QAChD,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QACrC,EAAE,GAAG,GAAG,oBAAoB,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;IAC3D,CAAC;IAED,IAAI,QAAQ,CAAC,cAAc,EAAE,CAAC;QAC5B,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;QACxE,MAAM,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC;QAClC,EAAE,IAAI,OAAO,6BAA6B,CAAC,QAAQ,EAAE,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,YAAY,EAAE,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;IACnK,CAAC;IAED,OAAO,EAAE,CAAC;AACZ,CAAC"}
|
|
@@ -1,8 +1,6 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
*/
|
|
5
|
-
export function generateBackgroundSyncHandler(authType) {
|
|
1
|
+
export function generateBackgroundSyncHandler(authType, batchSize, batchDelayMs, maxRetries, retryBackoffMs, tagInvalidationEnabled) {
|
|
2
|
+
const DB_NAME = "swoff-queue";
|
|
3
|
+
const STORE_NAME = "mutations";
|
|
6
4
|
const credentialsLine = authType === "cookie"
|
|
7
5
|
? ` credentials: "same-origin",`
|
|
8
6
|
: "";
|
|
@@ -13,22 +11,32 @@ self.addEventListener("sync", (event) => {
|
|
|
13
11
|
}
|
|
14
12
|
});
|
|
15
13
|
|
|
16
|
-
const
|
|
17
|
-
const
|
|
18
|
-
const SW_MAX_RETRIES =
|
|
14
|
+
const SW_BATCH_SIZE = ${batchSize};
|
|
15
|
+
const SW_BATCH_DELAY_MS = ${batchDelayMs};
|
|
16
|
+
const SW_MAX_RETRIES = ${maxRetries};
|
|
17
|
+
const SW_RETRY_BACKOFF_MS = ${retryBackoffMs};
|
|
18
|
+
|
|
19
|
+
function swSleep(ms) {
|
|
20
|
+
return new Promise((r) => setTimeout(r, ms));
|
|
21
|
+
}
|
|
19
22
|
|
|
20
23
|
async function processMutationQueueInSW() {
|
|
24
|
+
// If any client pages are open, skip entirely — the client always wins when open.
|
|
25
|
+
// Only the SW processes the queue when all tabs are closed (background sync event).
|
|
26
|
+
const activeClients = await self.clients.matchAll();
|
|
27
|
+
if (activeClients.length > 0) return;
|
|
28
|
+
|
|
21
29
|
let succeeded = 0;
|
|
22
30
|
let failed = 0;
|
|
23
31
|
const tagsToInvalidate = new Set();
|
|
24
32
|
|
|
25
33
|
try {
|
|
26
34
|
const db = await new Promise((resolve, reject) => {
|
|
27
|
-
const request = indexedDB.open(
|
|
35
|
+
const request = indexedDB.open("${DB_NAME}", 1);
|
|
28
36
|
request.onupgradeneeded = (e) => {
|
|
29
37
|
const db = e.target.result;
|
|
30
|
-
if (!db.objectStoreNames.contains(
|
|
31
|
-
const store = db.createObjectStore(
|
|
38
|
+
if (!db.objectStoreNames.contains("${STORE_NAME}")) {
|
|
39
|
+
const store = db.createObjectStore("${STORE_NAME}", { keyPath: "id" });
|
|
32
40
|
store.createIndex("by-timestamp", "timestamp");
|
|
33
41
|
}
|
|
34
42
|
};
|
|
@@ -36,8 +44,8 @@ async function processMutationQueueInSW() {
|
|
|
36
44
|
request.onerror = (e) => reject(e.target.error);
|
|
37
45
|
});
|
|
38
46
|
|
|
39
|
-
const tx = db.transaction(
|
|
40
|
-
const store = tx.objectStore(
|
|
47
|
+
const tx = db.transaction("${STORE_NAME}", "readonly");
|
|
48
|
+
const store = tx.objectStore("${STORE_NAME}");
|
|
41
49
|
const index = store.index("by-timestamp");
|
|
42
50
|
const queue = await new Promise((resolve, reject) => {
|
|
43
51
|
const request = index.getAll();
|
|
@@ -45,40 +53,88 @@ async function processMutationQueueInSW() {
|
|
|
45
53
|
request.onerror = () => reject(request.error);
|
|
46
54
|
});
|
|
47
55
|
|
|
56
|
+
const total = queue.length;
|
|
48
57
|
for (const item of queue) {
|
|
49
58
|
if (item.retryCount >= SW_MAX_RETRIES) {
|
|
50
59
|
await removeFromSWQueue(db, item.id);
|
|
51
60
|
failed++;
|
|
52
61
|
continue;
|
|
53
62
|
}
|
|
63
|
+
|
|
64
|
+
// Skip items whose backoff delay hasn't elapsed yet
|
|
65
|
+
if (item.nextRetryAt && Date.now() < item.nextRetryAt) {
|
|
66
|
+
continue;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
// Stop processing if browser went offline during sync
|
|
70
|
+
if (!self.navigator.onLine) break;
|
|
71
|
+
|
|
72
|
+
// Reconstruct request body based on stored bodyType
|
|
73
|
+
let replayBody = null;
|
|
74
|
+
let contentType;
|
|
75
|
+
const bt = item.bodyType || "json";
|
|
76
|
+
if (bt === "formdata") {
|
|
77
|
+
replayBody = new FormData();
|
|
78
|
+
const entries = item.body || [];
|
|
79
|
+
for (let i = 0; i < entries.length; i++) {
|
|
80
|
+
replayBody.append(entries[i][0], entries[i][1]);
|
|
81
|
+
}
|
|
82
|
+
} else if (bt === "blob") {
|
|
83
|
+
replayBody = item.body;
|
|
84
|
+
} else if (bt === "buffer") {
|
|
85
|
+
replayBody = item.body instanceof ArrayBuffer ? new Uint8Array(item.body) : item.body;
|
|
86
|
+
} else {
|
|
87
|
+
replayBody = JSON.stringify(item.body);
|
|
88
|
+
contentType = "application/json";
|
|
89
|
+
}
|
|
90
|
+
|
|
54
91
|
try {
|
|
55
92
|
const response = await fetch(item.url, {
|
|
56
93
|
method: item.method,
|
|
57
|
-
headers: {
|
|
58
|
-
|
|
94
|
+
headers: {
|
|
95
|
+
...(contentType ? { "Content-Type": contentType } : {}),
|
|
96
|
+
...item.headers,
|
|
97
|
+
},
|
|
98
|
+
body: replayBody,
|
|
59
99
|
${credentialsLine} });
|
|
60
100
|
if (!response.ok) throw new Error(\`HTTP \${response.status}\`);
|
|
61
101
|
|
|
62
102
|
if (item.tags) {
|
|
63
|
-
item.tags.forEach((tag) =>
|
|
103
|
+
item.tags.forEach((tag) => {
|
|
104
|
+
tagsToInvalidate.add(tag);
|
|
105
|
+
if (typeof invalidateByTag !== "undefined") invalidateByTag(tag);
|
|
106
|
+
});
|
|
64
107
|
}
|
|
65
108
|
|
|
66
109
|
await removeFromSWQueue(db, item.id);
|
|
67
110
|
succeeded++;
|
|
68
111
|
} catch {
|
|
69
112
|
item.retryCount++;
|
|
113
|
+
item.nextRetryAt = Date.now() + SW_RETRY_BACKOFF_MS * Math.pow(2, item.retryCount - 1);
|
|
70
114
|
await updateInSWQueue(db, item);
|
|
71
115
|
failed++;
|
|
72
116
|
}
|
|
117
|
+
|
|
118
|
+
// Rate limiting delay between mutations
|
|
119
|
+
if (SW_BATCH_DELAY_MS > 0 && succeeded + failed < total) {
|
|
120
|
+
await swSleep(SW_BATCH_DELAY_MS);
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
// Emit progress after every SW_BATCH_SIZE mutations
|
|
124
|
+
if ((succeeded + failed) % SW_BATCH_SIZE === 0 || succeeded + failed === total) {
|
|
125
|
+
const clients = await self.clients.matchAll();
|
|
126
|
+
for (const client of clients) {
|
|
127
|
+
client.postMessage({
|
|
128
|
+
type: "BACKGROUND_SYNC_PROGRESS",
|
|
129
|
+
detail: { succeeded, failed, total, current: succeeded + failed },
|
|
130
|
+
});
|
|
131
|
+
}
|
|
132
|
+
}
|
|
73
133
|
}
|
|
74
134
|
} catch (err) {
|
|
75
135
|
console.error("Background sync failed:", err);
|
|
76
136
|
}
|
|
77
137
|
|
|
78
|
-
for (const tag of tagsToInvalidate) {
|
|
79
|
-
await invalidateByTag(tag);
|
|
80
|
-
}
|
|
81
|
-
|
|
82
138
|
const clients = await self.clients.matchAll();
|
|
83
139
|
for (const client of clients) {
|
|
84
140
|
client.postMessage({
|
|
@@ -89,8 +145,8 @@ ${credentialsLine} });
|
|
|
89
145
|
}
|
|
90
146
|
|
|
91
147
|
async function removeFromSWQueue(db, id) {
|
|
92
|
-
const tx = db.transaction(
|
|
93
|
-
tx.objectStore(
|
|
148
|
+
const tx = db.transaction("${STORE_NAME}", "readwrite");
|
|
149
|
+
tx.objectStore("${STORE_NAME}").delete(id);
|
|
94
150
|
await new Promise((resolve, reject) => {
|
|
95
151
|
tx.oncomplete = () => resolve();
|
|
96
152
|
tx.onerror = () => reject(tx.error);
|
|
@@ -98,8 +154,8 @@ async function removeFromSWQueue(db, id) {
|
|
|
98
154
|
}
|
|
99
155
|
|
|
100
156
|
async function updateInSWQueue(db, item) {
|
|
101
|
-
const tx = db.transaction(
|
|
102
|
-
tx.objectStore(
|
|
157
|
+
const tx = db.transaction("${STORE_NAME}", "readwrite");
|
|
158
|
+
tx.objectStore("${STORE_NAME}").put(item);
|
|
103
159
|
await new Promise((resolve, reject) => {
|
|
104
160
|
tx.oncomplete = () => resolve();
|
|
105
161
|
tx.onerror = () => reject(tx.error);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"background-sync-handler.js","sourceRoot":"","sources":["../../../../src/lib/generators/sw-sections/background-sync-handler.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"background-sync-handler.js","sourceRoot":"","sources":["../../../../src/lib/generators/sw-sections/background-sync-handler.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,6BAA6B,CAAC,QAA4B,EAAE,SAAiB,EAAE,YAAoB,EAAE,UAAkB,EAAE,cAAsB,EAAE,sBAA+B;IAC9L,MAAM,OAAO,GAAG,aAAa,CAAC;IAC9B,MAAM,UAAU,GAAG,WAAW,CAAC;IAE/B,MAAM,eAAe,GAAG,QAAQ,KAAK,QAAQ;QAC3C,CAAC,CAAC,uCAAuC;QACzC,CAAC,CAAC,EAAE,CAAC;IAEP,OAAO;;;;;;;wBAOe,SAAS;4BACL,YAAY;yBACf,UAAU;8BACL,cAAc;;;;;;;;;;;;;;;;;;wCAkBJ,OAAO;;;6CAGF,UAAU;gDACP,UAAU;;;;;;;;iCAQzB,UAAU;oCACP,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAmD5C,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;+BAiDc,UAAU;oBACrB,UAAU;;;;;;;;+BAQC,UAAU;oBACrB,UAAU;;;;;EAK5B,CAAC;AACH,CAAC"}
|
|
@@ -7,8 +7,8 @@ export function generateConfigHeader(config, resolvedVersion) {
|
|
|
7
7
|
* Generated from swoff.config.json
|
|
8
8
|
* DO NOT EDIT MANUALLY
|
|
9
9
|
* Version: ${resolvedVersion}
|
|
10
|
-
* Features: version
|
|
11
|
-
* Default Strategy: ${config.features.serviceWorker.
|
|
10
|
+
* Features: version=${config.features.serviceWorker.version}, mutationQueue=${config.features.mutationQueue.enabled}, backgroundSync=${config.features.backgroundSync}, tagInvalidation=${config.features.tagInvalidation.enabled}
|
|
11
|
+
* Default Strategy: ${config.features.serviceWorker.strategy.default}
|
|
12
12
|
* See: https://swoff.netlify.app/docs
|
|
13
13
|
*/`;
|
|
14
14
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config-header.js","sourceRoot":"","sources":["../../../../src/lib/generators/sw-sections/config-header.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,MAAM,UAAU,oBAAoB,CAAC,MAAmB,EAAE,eAAuB;IAC/E,OAAO;;;;cAIK,eAAe
|
|
1
|
+
{"version":3,"file":"config-header.js","sourceRoot":"","sources":["../../../../src/lib/generators/sw-sections/config-header.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,MAAM,UAAU,oBAAoB,CAAC,MAAmB,EAAE,eAAuB;IAC/E,OAAO;;;;cAIK,eAAe;uBACN,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,OAAO,mBAAmB,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,OAAO,oBAAoB,MAAM,CAAC,QAAQ,CAAC,cAAc,qBAAqB,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,OAAO;uBAC3M,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,OAAO;;IAEjE,CAAC;AACL,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"default-template.js","sourceRoot":"","sources":["../../../../src/lib/generators/sw-sections/default-template.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,UAAU,kBAAkB;IAChC,OAAO
|
|
1
|
+
{"version":3,"file":"default-template.js","sourceRoot":"","sources":["../../../../src/lib/generators/sw-sections/default-template.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,UAAU,kBAAkB;IAChC,OAAO;;;;;;;;;;;;;;;2BAekB,CAAC;AAC5B,CAAC"}
|