@budarin/pluggable-serviceworker 1.1.0 → 1.2.0

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.
Files changed (74) hide show
  1. package/README.md +502 -420
  2. package/dist/index.d.ts +35 -18
  3. package/dist/index.d.ts.map +1 -1
  4. package/dist/index.js +49 -32
  5. package/dist/index.js.map +1 -1
  6. package/dist/plugins/cacheFirst.d.ts +3 -0
  7. package/dist/plugins/cacheFirst.d.ts.map +1 -0
  8. package/dist/plugins/cacheFirst.js +20 -0
  9. package/dist/plugins/cacheFirst.js.map +1 -0
  10. package/dist/plugins/claim.d.ts +3 -0
  11. package/dist/plugins/claim.d.ts.map +1 -0
  12. package/dist/plugins/claim.js +7 -0
  13. package/dist/plugins/claim.js.map +1 -0
  14. package/dist/plugins/claimOnMessage.d.ts +3 -0
  15. package/dist/plugins/claimOnMessage.d.ts.map +1 -0
  16. package/dist/plugins/claimOnMessage.js +11 -0
  17. package/dist/plugins/claimOnMessage.js.map +1 -0
  18. package/dist/plugins/index.d.ts +10 -0
  19. package/dist/plugins/index.d.ts.map +1 -0
  20. package/dist/plugins/index.js +10 -0
  21. package/dist/plugins/index.js.map +1 -0
  22. package/dist/plugins/networkFirst.d.ts +3 -0
  23. package/dist/plugins/networkFirst.d.ts.map +1 -0
  24. package/dist/plugins/networkFirst.js +17 -0
  25. package/dist/plugins/networkFirst.js.map +1 -0
  26. package/dist/plugins/networkOnly.d.ts +3 -0
  27. package/dist/plugins/networkOnly.d.ts.map +1 -0
  28. package/dist/plugins/networkOnly.js +5 -0
  29. package/dist/plugins/networkOnly.js.map +1 -0
  30. package/dist/plugins/precache.d.ts +3 -0
  31. package/dist/plugins/precache.d.ts.map +1 -0
  32. package/dist/plugins/precache.js +8 -0
  33. package/dist/plugins/precache.js.map +1 -0
  34. package/dist/plugins/restoreAssetToCache.d.ts +3 -0
  35. package/dist/plugins/restoreAssetToCache.d.ts.map +1 -0
  36. package/dist/plugins/restoreAssetToCache.js +42 -0
  37. package/dist/plugins/restoreAssetToCache.js.map +1 -0
  38. package/dist/plugins/serveFromCache.d.ts +3 -0
  39. package/dist/plugins/serveFromCache.d.ts.map +1 -0
  40. package/dist/plugins/serveFromCache.js +11 -0
  41. package/dist/plugins/serveFromCache.js.map +1 -0
  42. package/dist/plugins/skipWaiting.d.ts +3 -0
  43. package/dist/plugins/skipWaiting.d.ts.map +1 -0
  44. package/dist/plugins/skipWaiting.js +7 -0
  45. package/dist/plugins/skipWaiting.js.map +1 -0
  46. package/dist/plugins/staleWhileRevalidate.d.ts +3 -0
  47. package/dist/plugins/staleWhileRevalidate.d.ts.map +1 -0
  48. package/dist/plugins/staleWhileRevalidate.js +19 -0
  49. package/dist/plugins/staleWhileRevalidate.js.map +1 -0
  50. package/dist/presets/index.d.ts +2 -0
  51. package/dist/presets/index.d.ts.map +1 -0
  52. package/dist/presets/index.js +2 -0
  53. package/dist/presets/index.js.map +1 -0
  54. package/dist/presets/offlineFirst.d.ts +3 -0
  55. package/dist/presets/offlineFirst.d.ts.map +1 -0
  56. package/dist/presets/offlineFirst.js +7 -0
  57. package/dist/presets/offlineFirst.js.map +1 -0
  58. package/dist/sw/activateImmediately.d.ts +3 -0
  59. package/dist/sw/activateImmediately.d.ts.map +1 -0
  60. package/dist/sw/activateImmediately.js +8 -0
  61. package/dist/sw/activateImmediately.js.map +1 -0
  62. package/dist/sw/activateOnNextVisit.d.ts +3 -0
  63. package/dist/sw/activateOnNextVisit.d.ts.map +1 -0
  64. package/dist/sw/activateOnNextVisit.js +6 -0
  65. package/dist/sw/activateOnNextVisit.js.map +1 -0
  66. package/dist/sw/activateOnSignal.d.ts +3 -0
  67. package/dist/sw/activateOnSignal.d.ts.map +1 -0
  68. package/dist/sw/activateOnSignal.js +8 -0
  69. package/dist/sw/activateOnSignal.js.map +1 -0
  70. package/dist/sw/index.d.ts +4 -0
  71. package/dist/sw/index.d.ts.map +1 -0
  72. package/dist/sw/index.js +4 -0
  73. package/dist/sw/index.js.map +1 -0
  74. package/package.json +7 -4
@@ -0,0 +1,7 @@
1
+ export const skipWaiting = {
2
+ name: 'skipWaiting',
3
+ install: (_event, _context) => {
4
+ self.skipWaiting();
5
+ },
6
+ };
7
+ //# sourceMappingURL=skipWaiting.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"skipWaiting.js","sourceRoot":"","sources":["../../src/plugins/skipWaiting.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,WAAW,GAAwB;IAC5C,IAAI,EAAE,aAAa;IACnB,OAAO,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE;QAC1B,IAAI,CAAC,WAAW,EAAE,CAAC;IACvB,CAAC;CACJ,CAAC"}
@@ -0,0 +1,3 @@
1
+ import type { ServiceWorkerPlugin, OfflineFirstContext } from '../index.js';
2
+ export declare const staleWhileRevalidate: ServiceWorkerPlugin<OfflineFirstContext>;
3
+ //# sourceMappingURL=staleWhileRevalidate.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"staleWhileRevalidate.d.ts","sourceRoot":"","sources":["../../src/plugins/staleWhileRevalidate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAE5E,eAAO,MAAM,oBAAoB,EAAE,mBAAmB,CAAC,mBAAmB,CAoBzE,CAAC"}
@@ -0,0 +1,19 @@
1
+ export const staleWhileRevalidate = {
2
+ name: 'staleWhileRevalidate',
3
+ fetch: async (event, context) => {
4
+ const cache = await caches.open(context.cacheName);
5
+ const cached = await cache.match(event.request);
6
+ const revalidate = fetch(event.request).then(async (response) => {
7
+ if (response.ok) {
8
+ await cache.put(event.request, response.clone());
9
+ }
10
+ return response;
11
+ });
12
+ if (cached) {
13
+ void revalidate;
14
+ return cached;
15
+ }
16
+ return revalidate;
17
+ },
18
+ };
19
+ //# sourceMappingURL=staleWhileRevalidate.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"staleWhileRevalidate.js","sourceRoot":"","sources":["../../src/plugins/staleWhileRevalidate.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,oBAAoB,GAA6C;IAC1E,IAAI,EAAE,sBAAsB;IAC5B,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;QAC5B,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACnD,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAChD,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;YAC5D,IAAI,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACd,MAAM,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;YACrD,CAAC;YAED,OAAO,QAAQ,CAAC;QACpB,CAAC,CAAC,CAAC;QAEH,IAAI,MAAM,EAAE,CAAC;YACT,KAAK,UAAU,CAAC;YAChB,OAAO,MAAM,CAAC;QAClB,CAAC;QAED,OAAO,UAAU,CAAC;IACtB,CAAC;CACJ,CAAC"}
@@ -0,0 +1,2 @@
1
+ export { offlineFirst } from './offlineFirst.js';
2
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/presets/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC"}
@@ -0,0 +1,2 @@
1
+ export { offlineFirst } from './offlineFirst.js';
2
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/presets/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC"}
@@ -0,0 +1,3 @@
1
+ import type { ServiceWorkerPlugin, OfflineFirstContext } from '../index.js';
2
+ export declare const offlineFirst: ServiceWorkerPlugin<OfflineFirstContext>[];
3
+ //# sourceMappingURL=offlineFirst.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"offlineFirst.d.ts","sourceRoot":"","sources":["../../src/presets/offlineFirst.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAK5E,eAAO,MAAM,YAAY,EAAE,mBAAmB,CAAC,mBAAmB,CAAC,EAGlE,CAAC"}
@@ -0,0 +1,7 @@
1
+ import { precache } from '../plugins/precache.js';
2
+ import { serveFromCache } from '../plugins/serveFromCache.js';
3
+ export const offlineFirst = [
4
+ precache,
5
+ serveFromCache,
6
+ ];
7
+ //# sourceMappingURL=offlineFirst.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"offlineFirst.js","sourceRoot":"","sources":["../../src/presets/offlineFirst.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAG9D,MAAM,CAAC,MAAM,YAAY,GAA+C;IACpE,QAAQ;IACR,cAAc;CACjB,CAAC"}
@@ -0,0 +1,3 @@
1
+ import { type OfflineFirstContext, type ServiceWorkerInitOptions } from '../index.js';
2
+ export declare function activateImmediatelyServiceWorker(options: OfflineFirstContext & ServiceWorkerInitOptions): void;
3
+ //# sourceMappingURL=activateImmediately.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"activateImmediately.d.ts","sourceRoot":"","sources":["../../src/sw/activateImmediately.ts"],"names":[],"mappings":"AAAA,OAAO,EAEH,KAAK,mBAAmB,EACxB,KAAK,wBAAwB,EAChC,MAAM,aAAa,CAAC;AAQrB,wBAAgB,gCAAgC,CAC5C,OAAO,EAAE,mBAAmB,GAAG,wBAAwB,GACxD,IAAI,CAEN"}
@@ -0,0 +1,8 @@
1
+ import { initServiceWorker, } from '../index.js';
2
+ import { offlineFirst } from '../presets/offlineFirst.js';
3
+ import { skipWaiting } from '../plugins/skipWaiting.js';
4
+ import { claim } from '../plugins/claim.js';
5
+ export function activateImmediatelyServiceWorker(options) {
6
+ initServiceWorker([...offlineFirst, skipWaiting, claim], options);
7
+ }
8
+ //# sourceMappingURL=activateImmediately.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"activateImmediately.js","sourceRoot":"","sources":["../../src/sw/activateImmediately.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,iBAAiB,GAGpB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAK5C,MAAM,UAAU,gCAAgC,CAC5C,OAAuD;IAEvD,iBAAiB,CAAC,CAAC,GAAG,YAAY,EAAE,WAAW,EAAE,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;AACtE,CAAC"}
@@ -0,0 +1,3 @@
1
+ import { type OfflineFirstContext, type ServiceWorkerInitOptions } from '../index.js';
2
+ export declare function activateOnNextVisitServiceWorker(options: OfflineFirstContext & ServiceWorkerInitOptions): void;
3
+ //# sourceMappingURL=activateOnNextVisit.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"activateOnNextVisit.d.ts","sourceRoot":"","sources":["../../src/sw/activateOnNextVisit.ts"],"names":[],"mappings":"AAAA,OAAO,EAEH,KAAK,mBAAmB,EACxB,KAAK,wBAAwB,EAChC,MAAM,aAAa,CAAC;AAOrB,wBAAgB,gCAAgC,CAC5C,OAAO,EAAE,mBAAmB,GAAG,wBAAwB,GACxD,IAAI,CAEN"}
@@ -0,0 +1,6 @@
1
+ import { initServiceWorker, } from '../index.js';
2
+ import { offlineFirst } from '../presets/offlineFirst.js';
3
+ export function activateOnNextVisitServiceWorker(options) {
4
+ initServiceWorker(offlineFirst, options);
5
+ }
6
+ //# sourceMappingURL=activateOnNextVisit.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"activateOnNextVisit.js","sourceRoot":"","sources":["../../src/sw/activateOnNextVisit.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,iBAAiB,GAGpB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAM1D,MAAM,UAAU,gCAAgC,CAC5C,OAAuD;IAEvD,iBAAiB,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;AAC7C,CAAC"}
@@ -0,0 +1,3 @@
1
+ import { type OfflineFirstContext, type ServiceWorkerInitOptions } from '../index.js';
2
+ export declare function activateOnSignalServiceWorker(options: OfflineFirstContext & ServiceWorkerInitOptions): void;
3
+ //# sourceMappingURL=activateOnSignal.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"activateOnSignal.d.ts","sourceRoot":"","sources":["../../src/sw/activateOnSignal.ts"],"names":[],"mappings":"AAAA,OAAO,EAEH,KAAK,mBAAmB,EACxB,KAAK,wBAAwB,EAChC,MAAM,aAAa,CAAC;AAUrB,wBAAgB,6BAA6B,CACzC,OAAO,EAAE,mBAAmB,GAAG,wBAAwB,GACxD,IAAI,CAEN"}
@@ -0,0 +1,8 @@
1
+ import { initServiceWorker, } from '../index.js';
2
+ import { offlineFirst } from '../presets/offlineFirst.js';
3
+ import { claim } from '../plugins/claim.js';
4
+ import { claimOnMessage } from '../plugins/claimOnMessage.js';
5
+ export function activateOnSignalServiceWorker(options) {
6
+ initServiceWorker([...offlineFirst, claimOnMessage, claim], options);
7
+ }
8
+ //# sourceMappingURL=activateOnSignal.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"activateOnSignal.js","sourceRoot":"","sources":["../../src/sw/activateOnSignal.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,iBAAiB,GAGpB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAO9D,MAAM,UAAU,6BAA6B,CACzC,OAAuD;IAEvD,iBAAiB,CAAC,CAAC,GAAG,YAAY,EAAE,cAAc,EAAE,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;AACzE,CAAC"}
@@ -0,0 +1,4 @@
1
+ export { activateOnNextVisitServiceWorker } from './activateOnNextVisit.js';
2
+ export { activateImmediatelyServiceWorker } from './activateImmediately.js';
3
+ export { activateOnSignalServiceWorker } from './activateOnSignal.js';
4
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/sw/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gCAAgC,EAAE,MAAM,0BAA0B,CAAC;AAC5E,OAAO,EAAE,gCAAgC,EAAE,MAAM,0BAA0B,CAAC;AAC5E,OAAO,EAAE,6BAA6B,EAAE,MAAM,uBAAuB,CAAC"}
@@ -0,0 +1,4 @@
1
+ export { activateOnNextVisitServiceWorker } from './activateOnNextVisit.js';
2
+ export { activateImmediatelyServiceWorker } from './activateImmediately.js';
3
+ export { activateOnSignalServiceWorker } from './activateOnSignal.js';
4
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/sw/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gCAAgC,EAAE,MAAM,0BAA0B,CAAC;AAC5E,OAAO,EAAE,gCAAgC,EAAE,MAAM,0BAA0B,CAAC;AAC5E,OAAO,EAAE,6BAA6B,EAAE,MAAM,uBAAuB,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@budarin/pluggable-serviceworker",
3
- "version": "1.1.0",
3
+ "version": "1.2.0",
4
4
  "description": "Extensible via plugins service worker",
5
5
  "keywords": [
6
6
  "serviceworker",
@@ -20,13 +20,16 @@
20
20
  "README.md"
21
21
  ],
22
22
  "exports": {
23
- ".": "./dist/index.js"
23
+ ".": "./dist/index.js",
24
+ "./plugins": "./dist/plugins/index.js",
25
+ "./presets": "./dist/presets/index.js",
26
+ "./sw": "./dist/sw/index.js"
24
27
  },
25
28
  "devDependencies": {
26
- "@types/node": "^24.10.1",
29
+ "@types/node": "^24.10.11",
27
30
  "@types/serviceworker": "^0.0.153",
28
31
  "@types/web": "^0.0.269",
29
- "prettier": "^3.6.2",
32
+ "prettier": "^3.8.1",
30
33
  "typescript": "^5.9.3",
31
34
  "vitest": "^3.2.4"
32
35
  },