@sigil-dev/grimoire 0.9.21 → 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 -105
  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 -749
  28. package/src/rendering/preload.ts +101 -101
  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 -206
  35. package/src/server/asset-cache.ts +57 -57
  36. package/src/server/build.ts +262 -262
  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 -44
  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 -1018
  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 -27
  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 -132
  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 -101
  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,172 +1,172 @@
1
- import type { Server } from "bun";
2
- import type { RouteTree } from "../routing/scanner";
3
- import type {
4
- BuildResult,
5
- CoordinatorContext,
6
- GrimoirePlugin,
7
- LoadContext,
8
- PluginContext,
9
- Route,
10
- WorkerDescriptor,
11
- WorkerEnv,
12
- } from "../types";
13
- import { type Handle, sequence } from "./hooks";
14
-
15
- // Fire-and-forget hooks routed through runHook.
16
- // onRequest and onRouteRender are intentionally excluded: they have distinct
17
- // calling conventions (middleware chain / inline transform loop) handled in index.ts.
18
- // Keep HookArgs in sync with GrimoirePlugin in types.ts.
19
- type HookArgs = {
20
- onPluginsResolved: [ctx: PluginContext];
21
- onStart: [server: Server<unknown>];
22
- onStop: [reason: "shutdown" | "restart"];
23
- onBuildStart: [];
24
- onBuildEnd: [result: BuildResult];
25
- onRouteLoad: [route: Route, context: LoadContext];
26
- onCoordinatorStart: [ctx: CoordinatorContext];
27
- onWorkerReady: [worker: WorkerDescriptor];
28
- onWorkerDeath: [worker: WorkerDescriptor, reason: "crash" | "intentional"];
29
- };
30
- type FireAndForgetHook = keyof HookArgs;
31
-
32
- export async function runHook<K extends FireAndForgetHook>(
33
- plugins: GrimoirePlugin[],
34
- hook: K,
35
- ...args: HookArgs[K]
36
- ): Promise<void> {
37
- for (const plugin of plugins) {
38
- const fn = plugin[hook] as ((...a: any[]) => any) | undefined;
39
- await fn?.(...args);
40
- }
41
- }
42
-
43
- /**
44
- * Collect `services()` from every plugin, merged in plugin order.
45
- *
46
- * Called once at startup and cached by the caller: the result is shared by
47
- * every request. `services` is a fire-and-forget hook, so it is kept out of
48
- * HookArgs on purpose — its return value is used, unlike every other entry
49
- * in that map.
50
- *
51
- * Each plugin is handed what the plugins before it already published, so a
52
- * plugin can build on a resource another one owns. The SQL plugin opening the
53
- * connection and a jobs plugin writing rows through it is the case that
54
- * matters: without this, every consumer opens a second pool and the worker
55
- * budget is split again by whoever registered first.
56
- *
57
- * The context is a snapshot, so a plugin registered before the one it needs
58
- * sees nothing and reports that. It does not see its own contribution, and
59
- * it cannot write into the result — a plugin that wants to publish does so by
60
- * returning, which is what keeps the merge order predictable.
61
- */
62
- export async function collectServices(
63
- plugins: GrimoirePlugin[],
64
- ): Promise<Record<string, unknown>> {
65
- const collected: Record<string, unknown> = {};
66
- for (const plugin of plugins) {
67
- if (!plugin.services) continue;
68
- const provided = await plugin.services({ services: { ...collected } });
69
- if (!provided) continue;
70
- for (const [key, value] of Object.entries(provided)) {
71
- if (value === undefined) continue;
72
- collected[key] = value;
73
- }
74
- }
75
- return collected;
76
- }
77
-
78
- export async function runRequestHooks(
79
- plugins: GrimoirePlugin[],
80
- req: Request,
81
- final: () => Promise<Response>,
82
- ): Promise<Response> {
83
- const chain = plugins
84
- .filter((p) => p.onRequest)
85
- .reduceRight(
86
- (next, plugin) => async () => plugin.onRequest!(req, next),
87
- final,
88
- );
89
- return chain();
90
- }
91
-
92
- /**
93
- * Calls onWorkerSpawn on ALL plugins and merges results.
94
- * env is combined (later plugins override earlier on conflict).
95
- * name is last-write-wins.
96
- */
97
- export async function runWorkerSpawn(
98
- plugins: GrimoirePlugin[],
99
- worker: WorkerDescriptor,
100
- ): Promise<WorkerEnv> {
101
- const merged: WorkerEnv = { env: {} };
102
- for (const plugin of plugins) {
103
- const result = await plugin.onWorkerSpawn?.(worker);
104
- //@ts-expect-error WTF TS? its result? meaning its not gonna do anything if null.
105
- if (result?.env) Object.assign(merged.env!, result.env);
106
- //@ts-expect-error WTF TS? its result? meaning its not gonna do anything if null.
107
- if (result?.name) merged.name = result.name;
108
- }
109
- return merged;
110
- }
111
-
112
- /**
113
- * First plugin to return a non-null string wins.
114
- * Returns null if no plugin handles it — coordinator uses default.
115
- */
116
- export async function runSerializeLocals(
117
- plugins: GrimoirePlugin[],
118
- locals: App.Locals,
119
- ): Promise<string | null> {
120
- for (const plugin of plugins) {
121
- const result = await plugin.serializeLocals?.(locals);
122
- if (result != null) return result;
123
- }
124
- return null;
125
- }
126
-
127
- /**
128
- * First plugin to return non-null wins.
129
- * Returns null if no plugin handles it — worker uses default.
130
- */
131
- export async function runDeserializeLocals(
132
- plugins: GrimoirePlugin[],
133
- raw: string,
134
- ): Promise<App.Locals | null> {
135
- for (const plugin of plugins) {
136
- const result = await plugin.deserializeLocals?.(raw);
137
- if (result != null) return result;
138
- }
139
- return null;
140
- }
141
-
142
- /**
143
- * First plugin to return a WorkerDescriptor wins.
144
- * Returns null if no plugin handles it — coordinator uses default routing.
145
- */
146
- export async function runRouteRequest(
147
- plugins: GrimoirePlugin[],
148
- req: Request,
149
- workers: WorkerDescriptor[],
150
- routes: RouteTree,
151
- ): Promise<WorkerDescriptor | null> {
152
- for (const plugin of plugins) {
153
- const result = await plugin.routeRequest?.(req, workers, routes);
154
- if (result != null) return result;
155
- }
156
- return null;
157
- }
158
-
159
- /**
160
- * One handle out of every plugin's `handle` followed by the app's own, so
161
- * hooks.server.ts sees what the plugins put on `locals`. Undefined when
162
- * nobody has one.
163
- */
164
- export function composeHandle(
165
- plugins: GrimoirePlugin[],
166
- appHandle: Handle | undefined,
167
- ): Handle | undefined {
168
- const handles = plugins.flatMap((p) => (p.handle ? [p.handle] : []));
169
- if (appHandle) handles.push(appHandle);
170
- if (handles.length === 0) return undefined;
171
- return handles.length === 1 ? handles[0] : sequence(...handles);
172
- }
1
+ import type { Server } from "bun";
2
+ import type { RouteTree } from "../routing/scanner";
3
+ import type {
4
+ BuildResult,
5
+ CoordinatorContext,
6
+ GrimoirePlugin,
7
+ LoadContext,
8
+ PluginContext,
9
+ Route,
10
+ WorkerDescriptor,
11
+ WorkerEnv,
12
+ } from "../types";
13
+ import { type Handle, sequence } from "./hooks";
14
+
15
+ // Fire-and-forget hooks routed through runHook.
16
+ // onRequest and onRouteRender are intentionally excluded: they have distinct
17
+ // calling conventions (middleware chain / inline transform loop) handled in index.ts.
18
+ // Keep HookArgs in sync with GrimoirePlugin in types.ts.
19
+ type HookArgs = {
20
+ onPluginsResolved: [ctx: PluginContext];
21
+ onStart: [server: Server<unknown>];
22
+ onStop: [reason: "shutdown" | "restart"];
23
+ onBuildStart: [];
24
+ onBuildEnd: [result: BuildResult];
25
+ onRouteLoad: [route: Route, context: LoadContext];
26
+ onCoordinatorStart: [ctx: CoordinatorContext];
27
+ onWorkerReady: [worker: WorkerDescriptor];
28
+ onWorkerDeath: [worker: WorkerDescriptor, reason: "crash" | "intentional"];
29
+ };
30
+ type FireAndForgetHook = keyof HookArgs;
31
+
32
+ export async function runHook<K extends FireAndForgetHook>(
33
+ plugins: GrimoirePlugin[],
34
+ hook: K,
35
+ ...args: HookArgs[K]
36
+ ): Promise<void> {
37
+ for (const plugin of plugins) {
38
+ const fn = plugin[hook] as ((...a: any[]) => any) | undefined;
39
+ await fn?.(...args);
40
+ }
41
+ }
42
+
43
+ /**
44
+ * Collect `services()` from every plugin, merged in plugin order.
45
+ *
46
+ * Called once at startup and cached by the caller: the result is shared by
47
+ * every request. `services` is a fire-and-forget hook, so it is kept out of
48
+ * HookArgs on purpose — its return value is used, unlike every other entry
49
+ * in that map.
50
+ *
51
+ * Each plugin is handed what the plugins before it already published, so a
52
+ * plugin can build on a resource another one owns. The SQL plugin opening the
53
+ * connection and a jobs plugin writing rows through it is the case that
54
+ * matters: without this, every consumer opens a second pool and the worker
55
+ * budget is split again by whoever registered first.
56
+ *
57
+ * The context is a snapshot, so a plugin registered before the one it needs
58
+ * sees nothing and reports that. It does not see its own contribution, and
59
+ * it cannot write into the result — a plugin that wants to publish does so by
60
+ * returning, which is what keeps the merge order predictable.
61
+ */
62
+ export async function collectServices(
63
+ plugins: GrimoirePlugin[],
64
+ ): Promise<Record<string, unknown>> {
65
+ const collected: Record<string, unknown> = {};
66
+ for (const plugin of plugins) {
67
+ if (!plugin.services) continue;
68
+ const provided = await plugin.services({ services: { ...collected } });
69
+ if (!provided) continue;
70
+ for (const [key, value] of Object.entries(provided)) {
71
+ if (value === undefined) continue;
72
+ collected[key] = value;
73
+ }
74
+ }
75
+ return collected;
76
+ }
77
+
78
+ export async function runRequestHooks(
79
+ plugins: GrimoirePlugin[],
80
+ req: Request,
81
+ final: () => Promise<Response>,
82
+ ): Promise<Response> {
83
+ const chain = plugins
84
+ .filter((p) => p.onRequest)
85
+ .reduceRight(
86
+ (next, plugin) => async () => plugin.onRequest!(req, next),
87
+ final,
88
+ );
89
+ return chain();
90
+ }
91
+
92
+ /**
93
+ * Calls onWorkerSpawn on ALL plugins and merges results.
94
+ * env is combined (later plugins override earlier on conflict).
95
+ * name is last-write-wins.
96
+ */
97
+ export async function runWorkerSpawn(
98
+ plugins: GrimoirePlugin[],
99
+ worker: WorkerDescriptor,
100
+ ): Promise<WorkerEnv> {
101
+ const merged: WorkerEnv = { env: {} };
102
+ for (const plugin of plugins) {
103
+ const result = await plugin.onWorkerSpawn?.(worker);
104
+ //@ts-expect-error WTF TS? its result? meaning its not gonna do anything if null.
105
+ if (result?.env) Object.assign(merged.env!, result.env);
106
+ //@ts-expect-error WTF TS? its result? meaning its not gonna do anything if null.
107
+ if (result?.name) merged.name = result.name;
108
+ }
109
+ return merged;
110
+ }
111
+
112
+ /**
113
+ * First plugin to return a non-null string wins.
114
+ * Returns null if no plugin handles it — coordinator uses default.
115
+ */
116
+ export async function runSerializeLocals(
117
+ plugins: GrimoirePlugin[],
118
+ locals: App.Locals,
119
+ ): Promise<string | null> {
120
+ for (const plugin of plugins) {
121
+ const result = await plugin.serializeLocals?.(locals);
122
+ if (result != null) return result;
123
+ }
124
+ return null;
125
+ }
126
+
127
+ /**
128
+ * First plugin to return non-null wins.
129
+ * Returns null if no plugin handles it — worker uses default.
130
+ */
131
+ export async function runDeserializeLocals(
132
+ plugins: GrimoirePlugin[],
133
+ raw: string,
134
+ ): Promise<App.Locals | null> {
135
+ for (const plugin of plugins) {
136
+ const result = await plugin.deserializeLocals?.(raw);
137
+ if (result != null) return result;
138
+ }
139
+ return null;
140
+ }
141
+
142
+ /**
143
+ * First plugin to return a WorkerDescriptor wins.
144
+ * Returns null if no plugin handles it — coordinator uses default routing.
145
+ */
146
+ export async function runRouteRequest(
147
+ plugins: GrimoirePlugin[],
148
+ req: Request,
149
+ workers: WorkerDescriptor[],
150
+ routes: RouteTree,
151
+ ): Promise<WorkerDescriptor | null> {
152
+ for (const plugin of plugins) {
153
+ const result = await plugin.routeRequest?.(req, workers, routes);
154
+ if (result != null) return result;
155
+ }
156
+ return null;
157
+ }
158
+
159
+ /**
160
+ * One handle out of every plugin's `handle` followed by the app's own, so
161
+ * hooks.server.ts sees what the plugins put on `locals`. Undefined when
162
+ * nobody has one.
163
+ */
164
+ export function composeHandle(
165
+ plugins: GrimoirePlugin[],
166
+ appHandle: Handle | undefined,
167
+ ): Handle | undefined {
168
+ const handles = plugins.flatMap((p) => (p.handle ? [p.handle] : []));
169
+ if (appHandle) handles.push(appHandle);
170
+ if (handles.length === 0) return undefined;
171
+ return handles.length === 1 ? handles[0] : sequence(...handles);
172
+ }