@swoff/cli 0.3.8 → 0.3.10

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 (228) hide show
  1. package/README.md +47 -33
  2. package/dist/__tests__/assemble-sw.test.js +14 -53
  3. package/dist/__tests__/assemble-sw.test.js.map +1 -1
  4. package/dist/__tests__/cli-integration.test.js +119 -11
  5. package/dist/__tests__/cli-integration.test.js.map +1 -1
  6. package/dist/__tests__/config-types.test.js +44 -17
  7. package/dist/__tests__/config-types.test.js.map +1 -1
  8. package/dist/__tests__/file-generators.test.js +3 -3
  9. package/dist/__tests__/file-generators.test.js.map +1 -1
  10. package/dist/__tests__/glob-matcher.test.js +86 -0
  11. package/dist/__tests__/glob-matcher.test.js.map +1 -0
  12. package/dist/__tests__/invalidation-tags.test.js +207 -23
  13. package/dist/__tests__/invalidation-tags.test.js.map +1 -1
  14. package/dist/__tests__/loader.test.js +16 -12
  15. package/dist/__tests__/loader.test.js.map +1 -1
  16. package/dist/__tests__/validator.test.js +140 -100
  17. package/dist/__tests__/validator.test.js.map +1 -1
  18. package/dist/index.js +39 -34
  19. package/dist/index.js.map +1 -1
  20. package/dist/lib/cli/help.js +12 -12
  21. package/dist/lib/cli/help.js.map +1 -1
  22. package/dist/lib/commands/add.js +84 -36
  23. package/dist/lib/commands/add.js.map +1 -1
  24. package/dist/lib/commands/assets.js +37 -0
  25. package/dist/lib/commands/assets.js.map +1 -0
  26. package/dist/lib/commands/clean.js +32 -30
  27. package/dist/lib/commands/clean.js.map +1 -1
  28. package/dist/lib/commands/generate-assets.js +44 -0
  29. package/dist/lib/commands/generate-assets.js.map +1 -0
  30. package/dist/lib/commands/generate-guide.js +22 -29
  31. package/dist/lib/commands/generate-guide.js.map +1 -1
  32. package/dist/lib/commands/generate.js +17 -24
  33. package/dist/lib/commands/generate.js.map +1 -1
  34. package/dist/lib/commands/info.js +41 -48
  35. package/dist/lib/commands/info.js.map +1 -1
  36. package/dist/lib/commands/init.js +27 -13
  37. package/dist/lib/commands/init.js.map +1 -1
  38. package/dist/lib/commands/validate.js +4 -4
  39. package/dist/lib/commands/validate.js.map +1 -1
  40. package/dist/lib/config/loader.js +25 -23
  41. package/dist/lib/config/loader.js.map +1 -1
  42. package/dist/lib/config/validator.js +169 -91
  43. package/dist/lib/config/validator.js.map +1 -1
  44. package/dist/lib/generators/asset-generator/dependency-resolver.js +76 -0
  45. package/dist/lib/generators/asset-generator/dependency-resolver.js.map +1 -0
  46. package/dist/lib/generators/asset-generator/generate.js +111 -0
  47. package/dist/lib/generators/asset-generator/generate.js.map +1 -0
  48. package/dist/lib/generators/asset-generator/guide.js +43 -0
  49. package/dist/lib/generators/asset-generator/guide.js.map +1 -0
  50. package/dist/lib/generators/asset-generator/html-patcher.js +65 -0
  51. package/dist/lib/generators/asset-generator/html-patcher.js.map +1 -0
  52. package/dist/lib/generators/asset-generator/ico-encoder.js +29 -0
  53. package/dist/lib/generators/asset-generator/ico-encoder.js.map +1 -0
  54. package/dist/lib/generators/asset-generator/manifest-patcher.js +23 -0
  55. package/dist/lib/generators/asset-generator/manifest-patcher.js.map +1 -0
  56. package/dist/lib/generators/asset-generator/maskable.js +15 -0
  57. package/dist/lib/generators/asset-generator/maskable.js.map +1 -0
  58. package/dist/lib/generators/asset-generator/rasterize.js +32 -0
  59. package/dist/lib/generators/asset-generator/rasterize.js.map +1 -0
  60. package/dist/lib/generators/asset-generator/sizes.js +25 -0
  61. package/dist/lib/generators/asset-generator/sizes.js.map +1 -0
  62. package/dist/lib/generators/file-generators/api-config.js +6 -0
  63. package/dist/lib/generators/file-generators/api-config.js.map +1 -0
  64. package/dist/lib/generators/file-generators/auth-state.js +2 -34
  65. package/dist/lib/generators/file-generators/auth-state.js.map +1 -1
  66. package/dist/lib/generators/file-generators/auth-store.js +2 -250
  67. package/dist/lib/generators/file-generators/auth-store.js.map +1 -1
  68. package/dist/lib/generators/file-generators/auth-user.js +3 -81
  69. package/dist/lib/generators/file-generators/auth-user.js.map +1 -1
  70. package/dist/lib/generators/file-generators/background-sync.js +2 -57
  71. package/dist/lib/generators/file-generators/background-sync.js.map +1 -1
  72. package/dist/lib/generators/file-generators/cache.js +2 -38
  73. package/dist/lib/generators/file-generators/cache.js.map +1 -1
  74. package/dist/lib/generators/file-generators/client-injector.js +2 -91
  75. package/dist/lib/generators/file-generators/client-injector.js.map +1 -1
  76. package/dist/lib/generators/file-generators/fetch-state.js +6 -0
  77. package/dist/lib/generators/file-generators/fetch-state.js.map +1 -0
  78. package/dist/lib/generators/file-generators/fetch-wrapper.js +3 -267
  79. package/dist/lib/generators/file-generators/fetch-wrapper.js.map +1 -1
  80. package/dist/lib/generators/file-generators/generate-framework-adapters.js +56 -0
  81. package/dist/lib/generators/file-generators/generate-framework-adapters.js.map +1 -0
  82. package/dist/lib/generators/file-generators/generate-hooks.js +4 -3
  83. package/dist/lib/generators/file-generators/generate-hooks.js.map +1 -1
  84. package/dist/lib/generators/file-generators/gql-wrapper.js +3 -145
  85. package/dist/lib/generators/file-generators/gql-wrapper.js.map +1 -1
  86. package/dist/lib/generators/file-generators/guide-generator.js +24 -630
  87. package/dist/lib/generators/file-generators/guide-generator.js.map +1 -1
  88. package/dist/lib/generators/file-generators/invalidation-tags.js +18 -86
  89. package/dist/lib/generators/file-generators/invalidation-tags.js.map +1 -1
  90. package/dist/lib/generators/file-generators/manifest.js +15 -5
  91. package/dist/lib/generators/file-generators/manifest.js.map +1 -1
  92. package/dist/lib/generators/file-generators/mutation-queue.js +3 -285
  93. package/dist/lib/generators/file-generators/mutation-queue.js.map +1 -1
  94. package/dist/lib/generators/file-generators/mutation-state.js +2 -117
  95. package/dist/lib/generators/file-generators/mutation-state.js.map +1 -1
  96. package/dist/lib/generators/file-generators/push.js +6 -139
  97. package/dist/lib/generators/file-generators/push.js.map +1 -1
  98. package/dist/lib/generators/file-generators/pwa-install.js +11 -84
  99. package/dist/lib/generators/file-generators/pwa-install.js.map +1 -1
  100. package/dist/lib/generators/file-generators/quick-readme.js +8 -125
  101. package/dist/lib/generators/file-generators/quick-readme.js.map +1 -1
  102. package/dist/lib/generators/file-generators/reset.js +6 -0
  103. package/dist/lib/generators/file-generators/reset.js.map +1 -0
  104. package/dist/lib/generators/file-generators/server-push.js +3 -124
  105. package/dist/lib/generators/file-generators/server-push.js.map +1 -1
  106. package/dist/lib/generators/file-generators/sw-generator-build.js +8 -9
  107. package/dist/lib/generators/file-generators/sw-generator-build.js.map +1 -1
  108. package/dist/lib/generators/file-generators/sw-injector.js +10 -230
  109. package/dist/lib/generators/file-generators/sw-injector.js.map +1 -1
  110. package/dist/lib/generators/file-generators/type-definitions.js +2 -114
  111. package/dist/lib/generators/file-generators/type-definitions.js.map +1 -1
  112. package/dist/lib/generators/sw-generator.js +10 -20
  113. package/dist/lib/generators/sw-generator.js.map +1 -1
  114. package/dist/lib/generators/sw-sections/activate-handler.js +25 -3
  115. package/dist/lib/generators/sw-sections/activate-handler.js.map +1 -1
  116. package/dist/lib/generators/sw-sections/assemble-sw.js +20 -16
  117. package/dist/lib/generators/sw-sections/assemble-sw.js.map +1 -1
  118. package/dist/lib/generators/sw-sections/background-sync-handler.js +68 -19
  119. package/dist/lib/generators/sw-sections/background-sync-handler.js.map +1 -1
  120. package/dist/lib/generators/sw-sections/config-header.js +2 -2
  121. package/dist/lib/generators/sw-sections/config-header.js.map +1 -1
  122. package/dist/lib/generators/sw-sections/fetch-handler.js +506 -144
  123. package/dist/lib/generators/sw-sections/fetch-handler.js.map +1 -1
  124. package/dist/lib/generators/sw-sections/glob-matcher-code.js.map +1 -0
  125. package/dist/lib/generators/sw-sections/message-handler.js +55 -15
  126. package/dist/lib/generators/sw-sections/message-handler.js.map +1 -1
  127. package/dist/lib/generators/sw-sections/server-push-handler.js +12 -0
  128. package/dist/lib/generators/sw-sections/server-push-handler.js.map +1 -1
  129. package/dist/lib/generators/sw-sections/sw-push.js +67 -0
  130. package/dist/lib/generators/sw-sections/sw-push.js.map +1 -0
  131. package/dist/lib/generators/sw-sections/tag-management.js +65 -23
  132. package/dist/lib/generators/sw-sections/tag-management.js.map +1 -1
  133. package/dist/lib/generators/swoff-files-generator.js +66 -45
  134. package/dist/lib/generators/swoff-files-generator.js.map +1 -1
  135. package/dist/lib/shared/config-types.js +182 -71
  136. package/dist/lib/shared/config-types.js.map +1 -1
  137. package/dist/lib/shared/glob-matcher.js +77 -0
  138. package/dist/lib/shared/glob-matcher.js.map +1 -0
  139. package/dist/lib/utils/tty-status.js +21 -0
  140. package/dist/lib/utils/tty-status.js.map +1 -0
  141. package/dist/runtime/api-config.js +18 -0
  142. package/dist/runtime/api-config.js.map +1 -0
  143. package/dist/runtime/auth-state.js +35 -0
  144. package/dist/runtime/auth-state.js.map +1 -0
  145. package/dist/runtime/auth-store.js +273 -0
  146. package/dist/runtime/auth-store.js.map +1 -0
  147. package/dist/runtime/auth-user.js +168 -0
  148. package/dist/runtime/auth-user.js.map +1 -0
  149. package/dist/runtime/background-sync.js +59 -0
  150. package/dist/runtime/background-sync.js.map +1 -0
  151. package/dist/runtime/cache.js +30 -0
  152. package/dist/runtime/cache.js.map +1 -0
  153. package/dist/runtime/client-injector.js +136 -0
  154. package/dist/runtime/client-injector.js.map +1 -0
  155. package/dist/runtime/fetch-state.js +42 -0
  156. package/dist/runtime/fetch-state.js.map +1 -0
  157. package/dist/runtime/fetch-wrapper.js +355 -0
  158. package/dist/runtime/fetch-wrapper.js.map +1 -0
  159. package/dist/runtime/gql-wrapper.js +135 -0
  160. package/dist/runtime/gql-wrapper.js.map +1 -0
  161. package/dist/runtime/invalidation-tags.js +260 -0
  162. package/dist/runtime/invalidation-tags.js.map +1 -0
  163. package/dist/runtime/mutation-queue.js +304 -0
  164. package/dist/runtime/mutation-queue.js.map +1 -0
  165. package/dist/runtime/mutation-state.js +117 -0
  166. package/dist/runtime/mutation-state.js.map +1 -0
  167. package/dist/runtime/push.js +138 -0
  168. package/dist/runtime/push.js.map +1 -0
  169. package/dist/runtime/pwa-index.js +11 -0
  170. package/dist/runtime/pwa-index.js.map +1 -0
  171. package/dist/runtime/pwa-injector.js +44 -0
  172. package/dist/runtime/pwa-injector.js.map +1 -0
  173. package/dist/runtime/pwa-install.js +83 -0
  174. package/dist/runtime/pwa-install.js.map +1 -0
  175. package/dist/runtime/pwa-prompt.js +54 -0
  176. package/dist/runtime/pwa-prompt.js.map +1 -0
  177. package/dist/runtime/reset.js +148 -0
  178. package/dist/runtime/reset.js.map +1 -0
  179. package/dist/runtime/server-push.js +148 -0
  180. package/dist/runtime/server-push.js.map +1 -0
  181. package/dist/runtime/sw-injector.js +236 -0
  182. package/dist/runtime/sw-injector.js.map +1 -0
  183. package/dist/runtime/type-definitions.js +138 -0
  184. package/dist/runtime/type-definitions.js.map +1 -0
  185. package/dist/runtime/utils.js +27 -0
  186. package/dist/runtime/utils.js.map +1 -0
  187. package/package.json +3 -1
  188. package/templates/react/useAuth.jsx +106 -0
  189. package/templates/react/useAuth.tsx +118 -0
  190. package/templates/{hooks → react}/useBackgroundSync.jsx +6 -4
  191. package/templates/{hooks → react}/useBackgroundSync.tsx +6 -4
  192. package/templates/{hooks → react}/useCacheInvalidation.jsx +2 -2
  193. package/templates/react/useCacheInvalidation.tsx +52 -0
  194. package/templates/react/useCachedFetch.jsx +140 -0
  195. package/templates/react/useCachedFetch.tsx +160 -0
  196. package/templates/react/useIsFetching.jsx +32 -0
  197. package/templates/react/useIsFetching.tsx +32 -0
  198. package/templates/react/useMutation.jsx +141 -0
  199. package/templates/react/useMutation.tsx +180 -0
  200. package/templates/react/useMutationQueue.jsx +69 -0
  201. package/templates/react/useMutationQueue.tsx +83 -0
  202. package/templates/react/useMutationState.jsx +13 -0
  203. package/templates/react/useMutationState.tsx +25 -0
  204. package/templates/react/useNetworkStatus.jsx +61 -0
  205. package/templates/react/useNetworkStatus.tsx +76 -0
  206. package/templates/react/usePrefetch.jsx +32 -0
  207. package/templates/react/usePrefetch.tsx +42 -0
  208. package/templates/{hooks → react}/usePushSubscription.jsx +7 -7
  209. package/templates/{hooks → react}/usePushSubscription.tsx +7 -7
  210. package/templates/{hooks → react}/useSWUpdate.jsx +3 -3
  211. package/templates/{hooks → react}/useSWUpdate.tsx +4 -4
  212. package/templates/react/useSwoffReset.jsx +32 -0
  213. package/templates/react/useSwoffReset.tsx +39 -0
  214. package/templates/hooks/useAuth.jsx +0 -30
  215. package/templates/hooks/useAuth.tsx +0 -30
  216. package/templates/hooks/useCacheInvalidation.tsx +0 -19
  217. package/templates/hooks/useCachedFetch.jsx +0 -94
  218. package/templates/hooks/useCachedFetch.tsx +0 -112
  219. package/templates/hooks/useMutation.jsx +0 -76
  220. package/templates/hooks/useMutation.tsx +0 -97
  221. package/templates/hooks/useMutationQueue.jsx +0 -42
  222. package/templates/hooks/useMutationQueue.tsx +0 -49
  223. package/templates/hooks/useMutationState.jsx +0 -27
  224. package/templates/hooks/useMutationState.tsx +0 -41
  225. package/templates/hooks/useNetworkStatus.jsx +0 -19
  226. package/templates/hooks/useNetworkStatus.tsx +0 -19
  227. package/templates/hooks/usePrefetch.jsx +0 -10
  228. package/templates/hooks/usePrefetch.tsx +0 -25
@@ -1,42 +0,0 @@
1
- import { useState, useEffect, useCallback } from "react";
2
- import { getPendingCount, getQueueItems } from "../mutation-queue.js";
3
-
4
- export function useMutationQueue() {
5
- const [state, setState] = useState({
6
- pending: 0,
7
- items: [],
8
- lastSync: null,
9
- });
10
-
11
- const refresh = useCallback(async () => {
12
- const [count, items] = await Promise.all([
13
- getPendingCount(),
14
- getQueueItems(),
15
- ]);
16
- setState((s) => ({ ...s, pending: count, items }));
17
- }, []);
18
-
19
- useEffect(() => {
20
- refresh();
21
-
22
- const onSync = (e) => {
23
- refresh();
24
- setState((s) => ({
25
- ...s,
26
- lastSync: { succeeded: e.detail.succeeded, failed: e.detail.failed },
27
- }));
28
- };
29
- const onChange = () => {
30
- refresh();
31
- };
32
-
33
- window.addEventListener("mutation-sync-complete", onSync);
34
- window.addEventListener("mutation-queue-changed", onChange);
35
- return () => {
36
- window.removeEventListener("mutation-sync-complete", onSync);
37
- window.removeEventListener("mutation-queue-changed", onChange);
38
- };
39
- }, [refresh]);
40
-
41
- return state;
42
- }
@@ -1,49 +0,0 @@
1
- import { useState, useEffect, useCallback } from "react";
2
- import { getPendingCount, getQueueItems } from "../mutation-queue.ts";
3
- import type { MutationQueueItem } from "../swoff.d.ts";
4
-
5
- export interface MutationQueueState {
6
- pending: number;
7
- items: MutationQueueItem[];
8
- lastSync: { succeeded: number; failed: number } | null;
9
- }
10
-
11
- export function useMutationQueue() {
12
- const [state, setState] = useState<MutationQueueState>({
13
- pending: 0,
14
- items: [],
15
- lastSync: null,
16
- });
17
-
18
- const refresh = useCallback(async () => {
19
- const [count, items] = await Promise.all([
20
- getPendingCount(),
21
- getQueueItems(),
22
- ]);
23
- setState((s) => ({ ...s, pending: count, items }));
24
- }, []);
25
-
26
- useEffect(() => {
27
- refresh();
28
-
29
- const onSync = (e: CustomEvent) => {
30
- refresh();
31
- setState((s) => ({
32
- ...s,
33
- lastSync: { succeeded: e.detail.succeeded, failed: e.detail.failed },
34
- }));
35
- };
36
- const onChange = () => {
37
- refresh();
38
- };
39
-
40
- window.addEventListener("mutation-sync-complete", onSync);
41
- window.addEventListener("mutation-queue-changed", onChange);
42
- return () => {
43
- window.removeEventListener("mutation-sync-complete", onSync);
44
- window.removeEventListener("mutation-queue-changed", onChange);
45
- };
46
- }, [refresh]);
47
-
48
- return state;
49
- }
@@ -1,27 +0,0 @@
1
- import { useState, useEffect } from "react";
2
- import { getMutationState, onMutationStateChange } from "../mutation-state.js";
3
-
4
- export function useMutationState(id) {
5
- const [state, setState] = useState(() =>
6
- id ? getMutationState(id) ?? null : null,
7
- );
8
-
9
- useEffect(() => {
10
- if (!id) {
11
- setState(null);
12
- return;
13
- }
14
-
15
- setState(getMutationState(id) ?? null);
16
-
17
- const unsub = onMutationStateChange((updated) => {
18
- if (updated.id === id) {
19
- setState(updated);
20
- }
21
- });
22
-
23
- return unsub;
24
- }, [id]);
25
-
26
- return state;
27
- }
@@ -1,41 +0,0 @@
1
- import { useState, useEffect } from "react";
2
- import {
3
- getMutationState,
4
- onMutationStateChange,
5
- } from "../mutation-state.ts";
6
- import type { MutationState } from "../mutation-state.ts";
7
-
8
- /**
9
- * Hook that subscribes to a specific mutation's state changes.
10
- * Useful for showing per-mutation loading spinners, error states, etc.
11
- *
12
- * Usage:
13
- * const mutation = useMutationState(mutationId);
14
- * if (mutation?.status === "error") { ... }
15
- */
16
- export function useMutationState(id: string | null): MutationState | null {
17
- const [state, setState] = useState<MutationState | null>(() =>
18
- id ? getMutationState(id) ?? null : null,
19
- );
20
-
21
- useEffect(() => {
22
- if (!id) {
23
- setState(null);
24
- return;
25
- }
26
-
27
- // Initial state
28
- setState(getMutationState(id) ?? null);
29
-
30
- // Subscribe to changes
31
- const unsub = onMutationStateChange((updated) => {
32
- if (updated.id === id) {
33
- setState(updated);
34
- }
35
- });
36
-
37
- return unsub;
38
- }, [id]);
39
-
40
- return state;
41
- }
@@ -1,19 +0,0 @@
1
- import { useState, useEffect } from "react";
2
-
3
- export function useNetworkStatus() {
4
- const [online, setOnline] = useState(navigator.onLine);
5
-
6
- useEffect(() => {
7
- const onOnline = () => setOnline(true);
8
- const onOffline = () => setOnline(false);
9
-
10
- window.addEventListener("online", onOnline);
11
- window.addEventListener("offline", onOffline);
12
- return () => {
13
- window.removeEventListener("online", onOnline);
14
- window.removeEventListener("offline", onOffline);
15
- };
16
- }, []);
17
-
18
- return online;
19
- }
@@ -1,19 +0,0 @@
1
- import { useState, useEffect } from "react";
2
-
3
- export function useNetworkStatus() {
4
- const [online, setOnline] = useState(navigator.onLine);
5
-
6
- useEffect(() => {
7
- const onOnline = () => setOnline(true);
8
- const onOffline = () => setOnline(false);
9
-
10
- window.addEventListener("online", onOnline);
11
- window.addEventListener("offline", onOffline);
12
- return () => {
13
- window.removeEventListener("online", onOnline);
14
- window.removeEventListener("offline", onOffline);
15
- };
16
- }, []);
17
-
18
- return online;
19
- }
@@ -1,10 +0,0 @@
1
- import { useCallback } from "react";
2
- import { prefetchCache } from "../fetch-wrapper.js";
3
-
4
- export function usePrefetch() {
5
- const prefetch = useCallback((url, options) => {
6
- prefetchCache(url, options);
7
- }, []);
8
-
9
- return prefetch;
10
- }
@@ -1,25 +0,0 @@
1
- import { useCallback } from "react";
2
- import { prefetchCache } from "../fetch-wrapper.ts";
3
- import type { FetchWithCacheOptions } from "../fetch-wrapper.ts";
4
-
5
- /**
6
- * Hook that returns a stable prefetch callback for warming the SW cache.
7
- * Useful for route-level prefetching, link hover prefetching, etc.
8
- *
9
- * Usage:
10
- * const prefetch = usePrefetch();
11
- * <Link onMouseEnter={() => prefetch("/api/todos")} to="/todos" />
12
- */
13
- export function usePrefetch(): (
14
- url: string,
15
- options?: FetchWithCacheOptions,
16
- ) => void {
17
- const prefetch = useCallback(
18
- (url: string, options?: FetchWithCacheOptions) => {
19
- prefetchCache(url, options);
20
- },
21
- [],
22
- );
23
-
24
- return prefetch;
25
- }