@sigil-dev/grimoire 0.9.20 → 0.9.22

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 (94) hide show
  1. package/README.md +83 -83
  2. package/index.ts +50 -48
  3. package/package.json +16 -5
  4. package/public/__grimoire__/grimoire-client.js +12 -0
  5. package/public/__grimoire__/runtime.js +1241 -0
  6. package/server.ts +22 -20
  7. package/src/adapters/bun.ts +17 -0
  8. package/src/adapters/static.ts +41 -0
  9. package/src/adapters/types.ts +36 -0
  10. package/src/base.ts +91 -0
  11. package/src/client/csrf.ts +47 -47
  12. package/src/client/deferred.ts +179 -179
  13. package/src/client/enhance.ts +160 -160
  14. package/src/client/router.ts +870 -833
  15. package/src/dev/compile-module.ts +211 -211
  16. package/src/dev/loader.ts +141 -141
  17. package/src/dev/resolve.ts +70 -70
  18. package/src/dev/runtime-bundle.ts +51 -51
  19. package/src/env/modules.ts +62 -62
  20. package/src/env/required.ts +42 -0
  21. package/src/env/typegen.ts +61 -61
  22. package/src/headers.ts +105 -114
  23. package/src/logger/transports.ts +117 -117
  24. package/src/rendering/head.ts +49 -49
  25. package/src/rendering/hydrate.ts +161 -161
  26. package/src/rendering/images.ts +43 -43
  27. package/src/rendering/index.ts +755 -745
  28. package/src/rendering/preload.ts +101 -95
  29. package/src/rendering/ssrPlugin.ts +108 -108
  30. package/src/rendering/timing.ts +40 -40
  31. package/src/routing/router.ts +186 -186
  32. package/src/routing/scanner.ts +225 -196
  33. package/src/routing/transform-routes.ts +102 -102
  34. package/src/server/after-response.ts +206 -194
  35. package/src/server/asset-cache.ts +57 -55
  36. package/src/server/build.ts +262 -249
  37. package/src/server/cached.ts +114 -114
  38. package/src/server/client-address.ts +82 -82
  39. package/src/server/client-dir.ts +57 -57
  40. package/src/server/client-entry.ts +44 -0
  41. package/src/server/cookie-utils.ts +80 -80
  42. package/src/server/coordinator.ts +476 -471
  43. package/src/server/hooks.ts +122 -122
  44. package/src/server/index.ts +1138 -1022
  45. package/src/server/plugins.ts +172 -172
  46. package/src/server/prerender.ts +444 -0
  47. package/src/server/reserved.ts +17 -0
  48. package/src/server/resolver.ts +98 -98
  49. package/src/server/rewrite.ts +28 -0
  50. package/src/server/warm.ts +91 -91
  51. package/src/server/with-headers.ts +27 -0
  52. package/src/server/worker.ts +74 -72
  53. package/src/testing/dom.ts +73 -0
  54. package/src/testing/index.ts +169 -0
  55. package/src/testing/server.ts +162 -0
  56. package/src/typegen/index.ts +450 -450
  57. package/src/types.ts +501 -432
  58. package/test/after-response.test.ts +132 -113
  59. package/test/asset-cache-policy.test.ts +96 -96
  60. package/test/base.test.ts +134 -0
  61. package/test/cached.test.ts +126 -126
  62. package/test/client-address.test.ts +78 -78
  63. package/test/client-csrf.test.ts +61 -61
  64. package/test/client-dir.test.ts +101 -69
  65. package/test/client-router.test.ts +789 -734
  66. package/test/coordinator.test.ts +96 -94
  67. package/test/deferred.test.ts +256 -256
  68. package/test/dev-loader.test.ts +30 -30
  69. package/test/env.test.ts +168 -168
  70. package/test/force-production.test.ts +44 -0
  71. package/test/images.test.ts +49 -49
  72. package/test/locals-header.test.ts +61 -0
  73. package/test/middleware.test.ts +243 -243
  74. package/test/parser-plugins.test.ts +92 -92
  75. package/test/plugin-handle.test.ts +62 -62
  76. package/test/plugin-services-context.test.ts +97 -97
  77. package/test/preload.test.ts +48 -48
  78. package/test/prerender.test.ts +353 -0
  79. package/test/rendering.test.ts +798 -798
  80. package/test/required-env.test.ts +32 -0
  81. package/test/rewrite-html.test.ts +90 -0
  82. package/test/scanning.test.ts +349 -314
  83. package/test/server.test.ts +640 -619
  84. package/test/services.test.ts +90 -90
  85. package/test/streaming.test.ts +378 -378
  86. package/test/testing-helpers.test.ts +166 -0
  87. package/test/typegen.test.ts +805 -799
  88. package/test/warm.test.ts +96 -96
  89. package/test/worker-context.test.ts +59 -59
  90. package/test/workspace-files.test.ts +149 -146
  91. package/test/workspace-versions.test.ts +131 -131
  92. package/.grimoire/_routes.ts +0 -4
  93. package/public/__grimoire__/client.js +0 -55
  94. package/public/__grimoire__/hydrate.js +0 -63
@@ -1,160 +1,160 @@
1
- /**
2
- * Client-side form action handler.
3
- * Wraps form submission with fetch, handles fail() responses, and updates state.
4
- *
5
- * Usage in +page.tsx:
6
- *
7
- * import { enhance } from "@sigil-dev/grimoire/client";
8
- * import { createSignal } from "@sigil-dev/runtime";
9
- *
10
- * const [errors, setErrors] = createSignal({});
11
- *
12
- * <form use={[enhance, { action: "/api/login", onSuccess: () => { ... }, onFail: (data) => setErrors(data) }]}>
13
- * ...
14
- * </form>
15
- */
16
- import { ensureCsrf } from "./csrf.ts";
17
-
18
- export interface EnhanceOptions {
19
- /** URL to submit to (defaults to form's action) */
20
- action?: string;
21
- /**
22
- * Called when the action succeeds, before navigating to `redirect` (the
23
- * page itself, unless the action redirected). `data` is whatever the
24
- * action returned.
25
- */
26
- onSuccess?: (result: { redirect: string; data?: unknown }) => void;
27
- /**
28
- * Called when the action returns fail(). The page has already been shown
29
- * again with that data as its `form` prop, so most forms need no handler.
30
- */
31
- onFail?: (data: Record<string, unknown>) => void;
32
- /** Called on network or unexpected errors, and for error() */
33
- onError?: (error: Error) => void;
34
- /** Whether to reset the form on success (default: true) */
35
- reset?: boolean;
36
- }
37
-
38
- type Outcome =
39
- | { fail: true; status: number; data: Record<string, unknown> }
40
- | { error: true; status: number; message: string }
41
- | { type: "success"; location: string; data: unknown }
42
- | { type: "redirect"; status: number; location: string };
43
-
44
- /**
45
- * Go where the action sent us through the client router, so the destination's
46
- * loads run again. Landing back on the same page replaces the history entry
47
- * rather than adding one, and the router keeps the scroll position.
48
- */
49
- function follow(location: string): void {
50
- const navigate = (
51
- globalThis as {
52
- __grimoire_navigate__?: (path: string, replace?: boolean) => void;
53
- }
54
- ).__grimoire_navigate__;
55
- const target = new URL(location, window.location.href);
56
- if (target.origin !== window.location.origin || !navigate) {
57
- window.location.href = target.href;
58
- return;
59
- }
60
- const path = target.pathname + target.search + target.hash;
61
- const here = window.location.pathname + window.location.search;
62
- navigate(path, target.pathname + target.search === here);
63
- }
64
-
65
- /**
66
- * use:enhance directive for progressive form enhancement.
67
- * Attaches to a <form> element and intercepts submit events.
68
- *
69
- * Returns a cleanup function.
70
- */
71
- export function enhance(
72
- form: HTMLFormElement,
73
- options: EnhanceOptions = {},
74
- ): () => void {
75
- const { action, onSuccess, onFail, onError, reset = true } = options;
76
-
77
- async function handleSubmit(e: Event) {
78
- e.preventDefault();
79
-
80
- // client-rendered forms have no SSR-injected token; the server's CSRF
81
- // check covers fetch submissions too
82
- ensureCsrf(form);
83
- const formData = new FormData(form);
84
- // the button that submitted the form sends its own name=value, just
85
- // as a native submission would
86
- const submitter = (e as SubmitEvent).submitter as
87
- | HTMLButtonElement
88
- | HTMLInputElement
89
- | null;
90
- if (submitter?.name) formData.append(submitter.name, submitter.value);
91
- const resolved =
92
- action ?? form.getAttribute("action") ?? window.location.pathname;
93
- // SvelteKit-style named action: "?/create" submits to the current path
94
- const url = resolved.startsWith("?/")
95
- ? window.location.pathname + resolved
96
- : resolved;
97
-
98
- try {
99
- const res = await fetch(url, {
100
- method: "POST",
101
- headers: {
102
- "X-Grimoire-Form": "1",
103
- Accept: "application/json",
104
- },
105
- body: formData,
106
- });
107
-
108
- const contentType = res.headers.get("content-type") ?? "";
109
- if (!contentType.includes("application/json")) {
110
- if (!res.ok) throw new Error(`Form submission failed: ${res.status}`);
111
- // something that isn't a page action answered (a proxy, a plain
112
- // endpoint): count it as done and stay put
113
- if (reset) form.reset();
114
- onSuccess?.({ redirect: window.location.pathname });
115
- return;
116
- }
117
-
118
- const json = (await res.json()) as Outcome | Record<string, unknown>;
119
- if ("fail" in json && json.fail) {
120
- const data = (json as { data: Record<string, unknown> }).data;
121
- // the page that posted shows the failure as its `form` prop, as
122
- // it would after a submission without JavaScript
123
- if (
124
- new URL(url, window.location.href).pathname ===
125
- window.location.pathname
126
- ) {
127
- await (
128
- globalThis as {
129
- __grimoire_form__?: (form: unknown) => Promise<void>;
130
- }
131
- ).__grimoire_form__?.(data);
132
- }
133
- onFail?.(data);
134
- return;
135
- }
136
- if ("error" in json && json.error) {
137
- throw new Error(String((json as { message?: unknown }).message));
138
- }
139
- if (
140
- "type" in json &&
141
- (json.type === "success" || json.type === "redirect")
142
- ) {
143
- const outcome = json as { location: string; data?: unknown };
144
- if (reset) form.reset();
145
- onSuccess?.({ redirect: outcome.location, data: outcome.data });
146
- follow(outcome.location);
147
- return;
148
- }
149
- // JSON from a +server.ts endpoint (action: "/api/…")
150
- if (!res.ok) throw new Error(`Form submission failed: ${res.status}`);
151
- if (reset) form.reset();
152
- onSuccess?.({ redirect: window.location.pathname, data: json });
153
- } catch (err) {
154
- onError?.(err instanceof Error ? err : new Error(String(err)));
155
- }
156
- }
157
-
158
- form.addEventListener("submit", handleSubmit);
159
- return () => form.removeEventListener("submit", handleSubmit);
160
- }
1
+ /**
2
+ * Client-side form action handler.
3
+ * Wraps form submission with fetch, handles fail() responses, and updates state.
4
+ *
5
+ * Usage in +page.tsx:
6
+ *
7
+ * import { enhance } from "@sigil-dev/grimoire/client";
8
+ * import { createSignal } from "@sigil-dev/runtime";
9
+ *
10
+ * const [errors, setErrors] = createSignal({});
11
+ *
12
+ * <form use={[enhance, { action: "/api/login", onSuccess: () => { ... }, onFail: (data) => setErrors(data) }]}>
13
+ * ...
14
+ * </form>
15
+ */
16
+ import { ensureCsrf } from "./csrf.ts";
17
+
18
+ export interface EnhanceOptions {
19
+ /** URL to submit to (defaults to form's action) */
20
+ action?: string;
21
+ /**
22
+ * Called when the action succeeds, before navigating to `redirect` (the
23
+ * page itself, unless the action redirected). `data` is whatever the
24
+ * action returned.
25
+ */
26
+ onSuccess?: (result: { redirect: string; data?: unknown }) => void;
27
+ /**
28
+ * Called when the action returns fail(). The page has already been shown
29
+ * again with that data as its `form` prop, so most forms need no handler.
30
+ */
31
+ onFail?: (data: Record<string, unknown>) => void;
32
+ /** Called on network or unexpected errors, and for error() */
33
+ onError?: (error: Error) => void;
34
+ /** Whether to reset the form on success (default: true) */
35
+ reset?: boolean;
36
+ }
37
+
38
+ type Outcome =
39
+ | { fail: true; status: number; data: Record<string, unknown> }
40
+ | { error: true; status: number; message: string }
41
+ | { type: "success"; location: string; data: unknown }
42
+ | { type: "redirect"; status: number; location: string };
43
+
44
+ /**
45
+ * Go where the action sent us through the client router, so the destination's
46
+ * loads run again. Landing back on the same page replaces the history entry
47
+ * rather than adding one, and the router keeps the scroll position.
48
+ */
49
+ function follow(location: string): void {
50
+ const navigate = (
51
+ globalThis as {
52
+ __grimoire_navigate__?: (path: string, replace?: boolean) => void;
53
+ }
54
+ ).__grimoire_navigate__;
55
+ const target = new URL(location, window.location.href);
56
+ if (target.origin !== window.location.origin || !navigate) {
57
+ window.location.href = target.href;
58
+ return;
59
+ }
60
+ const path = target.pathname + target.search + target.hash;
61
+ const here = window.location.pathname + window.location.search;
62
+ navigate(path, target.pathname + target.search === here);
63
+ }
64
+
65
+ /**
66
+ * use:enhance directive for progressive form enhancement.
67
+ * Attaches to a <form> element and intercepts submit events.
68
+ *
69
+ * Returns a cleanup function.
70
+ */
71
+ export function enhance(
72
+ form: HTMLFormElement,
73
+ options: EnhanceOptions = {},
74
+ ): () => void {
75
+ const { action, onSuccess, onFail, onError, reset = true } = options;
76
+
77
+ async function handleSubmit(e: Event) {
78
+ e.preventDefault();
79
+
80
+ // client-rendered forms have no SSR-injected token; the server's CSRF
81
+ // check covers fetch submissions too
82
+ ensureCsrf(form);
83
+ const formData = new FormData(form);
84
+ // the button that submitted the form sends its own name=value, just
85
+ // as a native submission would
86
+ const submitter = (e as SubmitEvent).submitter as
87
+ | HTMLButtonElement
88
+ | HTMLInputElement
89
+ | null;
90
+ if (submitter?.name) formData.append(submitter.name, submitter.value);
91
+ const resolved =
92
+ action ?? form.getAttribute("action") ?? window.location.pathname;
93
+ // SvelteKit-style named action: "?/create" submits to the current path
94
+ const url = resolved.startsWith("?/")
95
+ ? window.location.pathname + resolved
96
+ : resolved;
97
+
98
+ try {
99
+ const res = await fetch(url, {
100
+ method: "POST",
101
+ headers: {
102
+ "X-Grimoire-Form": "1",
103
+ Accept: "application/json",
104
+ },
105
+ body: formData,
106
+ });
107
+
108
+ const contentType = res.headers.get("content-type") ?? "";
109
+ if (!contentType.includes("application/json")) {
110
+ if (!res.ok) throw new Error(`Form submission failed: ${res.status}`);
111
+ // something that isn't a page action answered (a proxy, a plain
112
+ // endpoint): count it as done and stay put
113
+ if (reset) form.reset();
114
+ onSuccess?.({ redirect: window.location.pathname });
115
+ return;
116
+ }
117
+
118
+ const json = (await res.json()) as Outcome | Record<string, unknown>;
119
+ if ("fail" in json && json.fail) {
120
+ const data = (json as { data: Record<string, unknown> }).data;
121
+ // the page that posted shows the failure as its `form` prop, as
122
+ // it would after a submission without JavaScript
123
+ if (
124
+ new URL(url, window.location.href).pathname ===
125
+ window.location.pathname
126
+ ) {
127
+ await (
128
+ globalThis as {
129
+ __grimoire_form__?: (form: unknown) => Promise<void>;
130
+ }
131
+ ).__grimoire_form__?.(data);
132
+ }
133
+ onFail?.(data);
134
+ return;
135
+ }
136
+ if ("error" in json && json.error) {
137
+ throw new Error(String((json as { message?: unknown }).message));
138
+ }
139
+ if (
140
+ "type" in json &&
141
+ (json.type === "success" || json.type === "redirect")
142
+ ) {
143
+ const outcome = json as { location: string; data?: unknown };
144
+ if (reset) form.reset();
145
+ onSuccess?.({ redirect: outcome.location, data: outcome.data });
146
+ follow(outcome.location);
147
+ return;
148
+ }
149
+ // JSON from a +server.ts endpoint (action: "/api/…")
150
+ if (!res.ok) throw new Error(`Form submission failed: ${res.status}`);
151
+ if (reset) form.reset();
152
+ onSuccess?.({ redirect: window.location.pathname, data: json });
153
+ } catch (err) {
154
+ onError?.(err instanceof Error ? err : new Error(String(err)));
155
+ }
156
+ }
157
+
158
+ form.addEventListener("submit", handleSubmit);
159
+ return () => form.removeEventListener("submit", handleSubmit);
160
+ }