@sourceregistry/sveltekit-enhance 1.3.0 → 1.3.2
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.
- package/README.md +24 -0
- package/dist/helpers/form.d.ts +4 -1
- package/dist/helpers/form.js +3 -2
- package/dist/index.js +7 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -80,6 +80,30 @@ export const handle = enhance.handle(
|
|
|
80
80
|
);
|
|
81
81
|
```
|
|
82
82
|
|
|
83
|
+
#### SSE / streaming responses
|
|
84
|
+
|
|
85
|
+
`enhance.handle` automatically detects Server-Sent Events and other streaming requests (via `Accept: text/event-stream`) and bypasses the main handler entirely — going straight to SvelteKit's `resolve`. This prevents the handler from blocking indefinitely on `await resolve(event)`, which never settles for a streaming response.
|
|
86
|
+
|
|
87
|
+
Consequences:
|
|
88
|
+
- The **main handler** does not run for SSE requests — it cannot inspect or modify the response headers.
|
|
89
|
+
- **`responseHandlers`** (added by enhancers via `contextInput.responseHandlers.push(...)`) are also skipped for responses with `Content-Type: text/event-stream`.
|
|
90
|
+
- **Enhancers** (the variadic context arguments) still run normally — they can set locals, authenticate the request, or short-circuit with an error response.
|
|
91
|
+
|
|
92
|
+
```ts
|
|
93
|
+
// This handler is skipped for SSE requests — no change needed on your end.
|
|
94
|
+
export const handle = enhance.handle(
|
|
95
|
+
async ({ event, resolve }) => {
|
|
96
|
+
const response = await resolve(event); // not called for SSE
|
|
97
|
+
response.headers.set('x-custom', 'value');
|
|
98
|
+
return response;
|
|
99
|
+
},
|
|
100
|
+
Auth.Bearer, // still runs — can reject unauthorized SSE requests
|
|
101
|
+
SessionGuard.hook, // still runs
|
|
102
|
+
);
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
If you need to set response headers on SSE routes, do it in the route handler itself (e.g. `+server.ts`) rather than in the `enhance.handle` main handler.
|
|
106
|
+
|
|
83
107
|
### `enhance.load`
|
|
84
108
|
|
|
85
109
|
Wraps server `load` functions.
|
package/dist/helpers/form.d.ts
CHANGED
|
@@ -50,6 +50,7 @@ declare const createContext: (data: FormData) => {
|
|
|
50
50
|
enum: <E extends Record<string, string | number | any>>(name: string, _enum: E) => keyof E | undefined;
|
|
51
51
|
enum$: <E extends Record<string, string | number | any>>(name: string, _enum: E) => E[keyof E];
|
|
52
52
|
date: (name: string, parser?: (formdata: FormData, name: string) => number | string | Date | undefined) => Date | undefined;
|
|
53
|
+
_date: (name: string, parser?: (formdata: FormData, name: string) => number | string | Date | undefined) => Date | null | undefined;
|
|
53
54
|
date$: (name: string, parser?: (formdata: FormData, name: string) => number | string | Date) => Date;
|
|
54
55
|
process: <T, R>(name: string, parser: ((formdata: FormData, name: string) => T) | ((name: string) => T), processor: (val: T, name: string) => R) => R;
|
|
55
56
|
number: (name: string) => number | undefined;
|
|
@@ -105,7 +106,7 @@ export declare function number(formdata: FormData, name: string): number | undef
|
|
|
105
106
|
export declare function number$(formdata: FormData, name: string): number;
|
|
106
107
|
export declare function boolean(formdata: FormData, name: string): boolean | undefined;
|
|
107
108
|
export declare function boolean$(formdata: FormData, name: string): boolean;
|
|
108
|
-
export declare function date(formdata: FormData, name: string, parser?: (formdata: FormData, name: string) => number | string | Date | undefined): Date | undefined;
|
|
109
|
+
export declare function date(formdata: FormData, name: string, parser?: (formdata: FormData, name: string) => number | string | Date | undefined): Date | null | undefined;
|
|
109
110
|
export declare function date$(formdata: FormData, name: string, parser: (formdata: FormData, name: string) => number | string | Date): Date;
|
|
110
111
|
export declare function json<T = unknown, F = T>(formdata: FormData, name: string, transformer?: (val: F) => T): T | undefined;
|
|
111
112
|
export declare function record(formdata: FormData, options?: Partial<{
|
|
@@ -187,6 +188,7 @@ export declare const schema: <const T extends AnyValidator>(validator: T, option
|
|
|
187
188
|
readonly enum: <E extends Record<string, string | number | any>>(name: string, _enum: E) => keyof E | undefined;
|
|
188
189
|
readonly enum$: <E extends Record<string, string | number | any>>(name: string, _enum: E) => E[keyof E];
|
|
189
190
|
readonly date: (name: string, parser?: (formdata: FormData, name: string) => number | string | Date | undefined) => Date | undefined;
|
|
191
|
+
readonly _date: (name: string, parser?: (formdata: FormData, name: string) => number | string | Date | undefined) => Date | null | undefined;
|
|
190
192
|
readonly date$: (name: string, parser?: (formdata: FormData, name: string) => number | string | Date) => Date;
|
|
191
193
|
readonly process: <T_1, R>(name: string, parser: ((formdata: FormData, name: string) => T_1) | ((name: string) => T_1), processor: (val: T_1, name: string) => R) => R;
|
|
192
194
|
readonly number: (name: string) => number | undefined;
|
|
@@ -267,6 +269,7 @@ export declare const Form: {
|
|
|
267
269
|
readonly enum: <E extends Record<string, string | number | any>>(name: string, _enum: E) => keyof E | undefined;
|
|
268
270
|
readonly enum$: <E extends Record<string, string | number | any>>(name: string, _enum: E) => E[keyof E];
|
|
269
271
|
readonly date: (name: string, parser?: (formdata: FormData, name: string) => number | string | Date | undefined) => Date | undefined;
|
|
272
|
+
readonly _date: (name: string, parser?: (formdata: FormData, name: string) => number | string | Date | undefined) => Date | null | undefined;
|
|
270
273
|
readonly date$: (name: string, parser?: (formdata: FormData, name: string) => number | string | Date) => Date;
|
|
271
274
|
readonly process: <T_1, R>(name: string, parser: ((formdata: FormData, name: string) => T_1) | ((name: string) => T_1), processor: (val: T_1, name: string) => R) => R;
|
|
272
275
|
readonly number: (name: string) => number | undefined;
|
package/dist/helpers/form.js
CHANGED
|
@@ -47,7 +47,8 @@ const createContext = (data) => {
|
|
|
47
47
|
pattern$: (name, pattern) => pattern$(data, name, pattern),
|
|
48
48
|
enum: (name, _enum) => Enum(data, name, _enum),
|
|
49
49
|
enum$: (name, _enum) => Enum$(data, name, _enum),
|
|
50
|
-
date: (name, parser = (data, name) => data.get(name)) => date(data, name, parser),
|
|
50
|
+
date: (name, parser = (data, name) => data.get(name)) => date(data, name, parser) ?? undefined,
|
|
51
|
+
_date: (name, parser = (data, name) => data.get(name)) => date(data, name, parser),
|
|
51
52
|
date$: (name, parser = (data, name) => data.get(name)) => date$(data, name, parser),
|
|
52
53
|
process: (name, parser, processor) => process(data, name, (formdata, name) => parser.length === 2
|
|
53
54
|
? parser(formdata, name)
|
|
@@ -169,7 +170,7 @@ export function date(formdata, name, parser = (data, name) => data.get(name)) {
|
|
|
169
170
|
}
|
|
170
171
|
const val = parser(formdata, name);
|
|
171
172
|
if (!val) {
|
|
172
|
-
return
|
|
173
|
+
return null;
|
|
173
174
|
}
|
|
174
175
|
return new Date(val);
|
|
175
176
|
}
|
package/dist/index.js
CHANGED
|
@@ -181,6 +181,11 @@ export const handle = (handle, ...contexts) => async (input) => {
|
|
|
181
181
|
contextInput.resolve = previous_resolve;
|
|
182
182
|
}
|
|
183
183
|
}
|
|
184
|
+
// SSE responses cannot be awaited — bypass the main handler to avoid blocking
|
|
185
|
+
// indefinitely on a streaming response that never ends.
|
|
186
|
+
if (event.request.headers.get('accept')?.includes('text/event-stream')) {
|
|
187
|
+
return input.resolve(event, parent_options);
|
|
188
|
+
}
|
|
184
189
|
try {
|
|
185
190
|
return await handle({
|
|
186
191
|
...input,
|
|
@@ -195,7 +200,8 @@ export const handle = (handle, ...contexts) => async (input) => {
|
|
|
195
200
|
};
|
|
196
201
|
try {
|
|
197
202
|
const response = await apply_handle(0, input.event);
|
|
198
|
-
|
|
203
|
+
const isSSE = response.headers.get('content-type')?.includes('text/event-stream');
|
|
204
|
+
if (!isSSE && contextInput.responseHandlers.length > 0) {
|
|
199
205
|
for (const responseHandler of contextInput.responseHandlers) {
|
|
200
206
|
await responseHandler({ event: contextInput, response });
|
|
201
207
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sourceregistry/sveltekit-enhance",
|
|
3
|
-
"version": "1.3.
|
|
3
|
+
"version": "1.3.2",
|
|
4
4
|
"description": "Composable enhance and form utilities for SvelteKit actions, loads, methods, and hooks.",
|
|
5
5
|
"author": "A.P.A. Slaa (a.p.a.slaa@projectsource.nl)",
|
|
6
6
|
"scripts": {
|