@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,122 +1,122 @@
1
- /**
2
- * SvelteKit-style server hooks.
3
- *
4
- * Create a hooks.server.ts in your project root:
5
- *
6
- * import type { Handle } from "@sigil-dev/grimoire/hooks";
7
- *
8
- * export const handle: Handle = async ({ event, resolve }) => {
9
- * event.locals.user = await getUser(event.cookies.get("session"));
10
- * const response = await resolve(event);
11
- * response.headers.set("x-custom", "value");
12
- * return response;
13
- * };
14
- *
15
- * export const handleError: HandleError = ({ error, status, message }) => {
16
- * console.error(`[${status}] ${message}`, error);
17
- * };
18
- *
19
- * // optional: runs once at server start
20
- * export const init = () => {
21
- * console.log("Server started");
22
- * };
23
- *
24
- * Chain multiple handlers with sequence():
25
- *
26
- * import { sequence } from "@sigil-dev/grimoire/hooks";
27
- * import { logger } from "./hooks/logger";
28
- * import { auth } from "./hooks/auth";
29
- *
30
- * export const handle = sequence(logger, auth);
31
- */
32
-
33
- export type MaybePromise<T> = T | Promise<T>;
34
-
35
- export interface RequestEvent {
36
- request: Request;
37
- url: URL;
38
- params: Record<string, string>;
39
- locals: App.Locals;
40
- cookies: Cookies;
41
- route: { id: string };
42
- fetch: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
43
- setHeaders: (headers: Record<string, string>) => void;
44
- /**
45
- * The visitor's IP address. Behind a reverse proxy on the same machine or
46
- * network, it is the address the proxy reports; a visitor connecting
47
- * directly cannot claim another one.
48
- */
49
- getClientAddress: () => string;
50
- }
51
-
52
- export interface Cookies {
53
- get(name: string): string | undefined;
54
- /** Path defaults to "/". */
55
- set(name: string, value: string, options?: CookieOptions): void;
56
- /** Pass the path and domain the cookie was set with; path defaults to "/". */
57
- delete(name: string, options?: Pick<CookieOptions, "path" | "domain">): void;
58
- }
59
-
60
- export interface CookieOptions {
61
- path?: string;
62
- domain?: string;
63
- maxAge?: number;
64
- expires?: Date;
65
- httpOnly?: boolean;
66
- secure?: boolean;
67
- sameSite?: "strict" | "lax" | "none";
68
- }
69
-
70
- export type ResolveFunction = (event: RequestEvent) => MaybePromise<Response>;
71
-
72
- export type Handle = (input: {
73
- event: RequestEvent;
74
- resolve: ResolveFunction;
75
- }) => MaybePromise<Response>;
76
-
77
- export interface HandleErrorInput {
78
- error: unknown;
79
- event: RequestEvent;
80
- status: number;
81
- message: string;
82
- }
83
- export type HandleError = (input: HandleErrorInput) => void | Promise<void>;
84
-
85
- export interface HandleFetchInput {
86
- request: Request;
87
- fetch: typeof globalThis.fetch;
88
- event: RequestEvent;
89
- }
90
- export type HandleFetch = (input: HandleFetchInput) => MaybePromise<Response>;
91
-
92
- export type InitFunction = () => void | Promise<void>;
93
-
94
- /**
95
- * Chain multiple Handle functions into one.
96
- * First handler in the array runs first.
97
- */
98
- export function sequence(...handlers: Handle[]): Handle {
99
- return async ({ event, resolve }) => {
100
- let i = 0;
101
-
102
- const next: ResolveFunction = async (evt) => {
103
- if (i < handlers.length) {
104
- const handler = handlers[i++];
105
- return handler!({ event: evt, resolve: next });
106
- }
107
- return resolve(evt);
108
- };
109
-
110
- return next(event);
111
- };
112
- }
113
-
114
- /**
115
- * Create a hooks object with handle and optional init.
116
- */
117
- export function createHooks(
118
- handle: Handle,
119
- init?: InitFunction,
120
- ): { handle: Handle; init?: InitFunction } {
121
- return { handle, init };
122
- }
1
+ /**
2
+ * SvelteKit-style server hooks.
3
+ *
4
+ * Create a hooks.server.ts in your project root:
5
+ *
6
+ * import type { Handle } from "@sigil-dev/grimoire/hooks";
7
+ *
8
+ * export const handle: Handle = async ({ event, resolve }) => {
9
+ * event.locals.user = await getUser(event.cookies.get("session"));
10
+ * const response = await resolve(event);
11
+ * response.headers.set("x-custom", "value");
12
+ * return response;
13
+ * };
14
+ *
15
+ * export const handleError: HandleError = ({ error, status, message }) => {
16
+ * console.error(`[${status}] ${message}`, error);
17
+ * };
18
+ *
19
+ * // optional: runs once at server start
20
+ * export const init = () => {
21
+ * console.log("Server started");
22
+ * };
23
+ *
24
+ * Chain multiple handlers with sequence():
25
+ *
26
+ * import { sequence } from "@sigil-dev/grimoire/hooks";
27
+ * import { logger } from "./hooks/logger";
28
+ * import { auth } from "./hooks/auth";
29
+ *
30
+ * export const handle = sequence(logger, auth);
31
+ */
32
+
33
+ export type MaybePromise<T> = T | Promise<T>;
34
+
35
+ export interface RequestEvent {
36
+ request: Request;
37
+ url: URL;
38
+ params: Record<string, string>;
39
+ locals: App.Locals;
40
+ cookies: Cookies;
41
+ route: { id: string };
42
+ fetch: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
43
+ setHeaders: (headers: Record<string, string>) => void;
44
+ /**
45
+ * The visitor's IP address. Behind a reverse proxy on the same machine or
46
+ * network, it is the address the proxy reports; a visitor connecting
47
+ * directly cannot claim another one.
48
+ */
49
+ getClientAddress: () => string;
50
+ }
51
+
52
+ export interface Cookies {
53
+ get(name: string): string | undefined;
54
+ /** Path defaults to "/". */
55
+ set(name: string, value: string, options?: CookieOptions): void;
56
+ /** Pass the path and domain the cookie was set with; path defaults to "/". */
57
+ delete(name: string, options?: Pick<CookieOptions, "path" | "domain">): void;
58
+ }
59
+
60
+ export interface CookieOptions {
61
+ path?: string;
62
+ domain?: string;
63
+ maxAge?: number;
64
+ expires?: Date;
65
+ httpOnly?: boolean;
66
+ secure?: boolean;
67
+ sameSite?: "strict" | "lax" | "none";
68
+ }
69
+
70
+ export type ResolveFunction = (event: RequestEvent) => MaybePromise<Response>;
71
+
72
+ export type Handle = (input: {
73
+ event: RequestEvent;
74
+ resolve: ResolveFunction;
75
+ }) => MaybePromise<Response>;
76
+
77
+ export interface HandleErrorInput {
78
+ error: unknown;
79
+ event: RequestEvent;
80
+ status: number;
81
+ message: string;
82
+ }
83
+ export type HandleError = (input: HandleErrorInput) => void | Promise<void>;
84
+
85
+ export interface HandleFetchInput {
86
+ request: Request;
87
+ fetch: typeof globalThis.fetch;
88
+ event: RequestEvent;
89
+ }
90
+ export type HandleFetch = (input: HandleFetchInput) => MaybePromise<Response>;
91
+
92
+ export type InitFunction = () => void | Promise<void>;
93
+
94
+ /**
95
+ * Chain multiple Handle functions into one.
96
+ * First handler in the array runs first.
97
+ */
98
+ export function sequence(...handlers: Handle[]): Handle {
99
+ return async ({ event, resolve }) => {
100
+ let i = 0;
101
+
102
+ const next: ResolveFunction = async (evt) => {
103
+ if (i < handlers.length) {
104
+ const handler = handlers[i++];
105
+ return handler!({ event: evt, resolve: next });
106
+ }
107
+ return resolve(evt);
108
+ };
109
+
110
+ return next(event);
111
+ };
112
+ }
113
+
114
+ /**
115
+ * Create a hooks object with handle and optional init.
116
+ */
117
+ export function createHooks(
118
+ handle: Handle,
119
+ init?: InitFunction,
120
+ ): { handle: Handle; init?: InitFunction } {
121
+ return { handle, init };
122
+ }