@sigil-dev/grimoire 0.9.29 → 0.9.31

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 (105) hide show
  1. package/bin/sigil.ts +4 -0
  2. package/index.ts +16 -10
  3. package/package.json +14 -6
  4. package/server.ts +2 -2
  5. package/src/adapters/bun.ts +17 -17
  6. package/src/adapters/static.ts +41 -41
  7. package/src/adapters/types.ts +36 -36
  8. package/src/base.ts +4 -1
  9. package/src/client/csrf.ts +47 -47
  10. package/src/client/deferred.ts +1 -4
  11. package/src/client/enhance.ts +160 -160
  12. package/src/client/router.ts +927 -926
  13. package/src/config-file.ts +84 -0
  14. package/src/dev/compile-module.ts +199 -193
  15. package/src/dev/hmr-client.ts +229 -229
  16. package/src/dev/hmr-server.ts +274 -266
  17. package/src/dev/loader.ts +144 -144
  18. package/src/dev/runtime-bundle.ts +5 -3
  19. package/src/duration.ts +46 -0
  20. package/src/env/modules.ts +62 -62
  21. package/src/env/required.ts +42 -42
  22. package/src/env/typegen.ts +61 -61
  23. package/src/headers.ts +105 -105
  24. package/src/logger/transports.ts +117 -117
  25. package/src/plugin-order.ts +88 -0
  26. package/src/rendering/head.ts +49 -49
  27. package/src/rendering/hydrate.ts +162 -162
  28. package/src/rendering/images.ts +43 -43
  29. package/src/rendering/preload.ts +22 -8
  30. package/src/rendering/ssrPlugin.ts +107 -107
  31. package/src/rendering/timing.ts +40 -40
  32. package/src/routing/route-ids.ts +65 -0
  33. package/src/routing/route.ts +65 -0
  34. package/src/routing/router.ts +84 -32
  35. package/src/routing/scanner.ts +18 -5
  36. package/src/routing/transform-routes.ts +102 -102
  37. package/src/server/after-response.ts +206 -206
  38. package/src/server/asset-cache.ts +57 -57
  39. package/src/server/build.ts +304 -295
  40. package/src/server/cached.ts +114 -114
  41. package/src/server/client-address.ts +82 -82
  42. package/src/server/client-dir.ts +63 -63
  43. package/src/server/client-entry.ts +44 -44
  44. package/src/server/context.ts +18 -10
  45. package/src/server/cookie-utils.ts +80 -80
  46. package/src/server/coordinator.ts +479 -476
  47. package/src/server/hooks.ts +122 -122
  48. package/src/server/index.ts +1181 -1171
  49. package/src/server/plugins.ts +172 -172
  50. package/src/server/prerender.ts +473 -473
  51. package/src/server/reserved.ts +17 -17
  52. package/src/server/resolver.ts +149 -123
  53. package/src/server/rewrite.ts +28 -28
  54. package/src/server/warm.ts +9 -3
  55. package/src/server/with-headers.ts +27 -27
  56. package/src/server/worker.ts +2 -6
  57. package/src/server-only.ts +78 -0
  58. package/src/testing/dom.ts +73 -73
  59. package/src/testing/index.ts +169 -169
  60. package/src/testing/server.ts +1 -0
  61. package/src/typegen/index.ts +97 -2
  62. package/src/types.ts +642 -508
  63. package/test/after-response.test.ts +132 -132
  64. package/test/asset-cache-policy.test.ts +6 -2
  65. package/test/base.test.ts +20 -6
  66. package/test/cached.test.ts +126 -126
  67. package/test/client-address.test.ts +78 -78
  68. package/test/client-csrf.test.ts +61 -61
  69. package/test/client-dir.test.ts +101 -101
  70. package/test/client-router.test.ts +37 -5
  71. package/test/config-file.test.ts +84 -0
  72. package/test/coordinator.test.ts +9 -2
  73. package/test/deferred.test.ts +4 -2
  74. package/test/dev-loader.test.ts +30 -30
  75. package/test/env.test.ts +171 -171
  76. package/test/force-production.test.ts +7 -2
  77. package/test/images.test.ts +20 -8
  78. package/test/locals-header.test.ts +61 -61
  79. package/test/middleware.test.ts +243 -243
  80. package/test/parser-plugins.test.ts +98 -92
  81. package/test/plugin-handle.test.ts +62 -62
  82. package/test/plugin-order.test.ts +98 -0
  83. package/test/plugin-routes.test.ts +47 -42
  84. package/test/plugin-services-context.test.ts +7 -2
  85. package/test/preload.test.ts +4 -1
  86. package/test/prerender.test.ts +3 -1
  87. package/test/rendering.test.ts +3 -2
  88. package/test/required-env.test.ts +32 -32
  89. package/test/resolver-windows.test.ts +22 -23
  90. package/test/rewrite-html.test.ts +90 -90
  91. package/test/route-group-layouts.test.ts +38 -36
  92. package/test/route.test.ts +103 -0
  93. package/test/routing.test.ts +225 -197
  94. package/test/scanning.test.ts +53 -33
  95. package/test/server-context.test.ts +22 -0
  96. package/test/server-only.test.ts +110 -0
  97. package/test/server.test.ts +659 -640
  98. package/test/services.test.ts +3 -3
  99. package/test/streaming.test.ts +11 -6
  100. package/test/testing-helpers.test.ts +166 -166
  101. package/test/typegen.test.ts +209 -112
  102. package/test/warm.test.ts +96 -96
  103. package/test/worker-context.test.ts +59 -59
  104. package/test/workspace-files.test.ts +26 -10
  105. package/test/workspace-versions.test.ts +146 -131
@@ -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
+ }