@sourceregistry/sveltekit-enhance 1.2.0 → 1.3.1

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 CHANGED
@@ -138,6 +138,39 @@ All helpers are available from `@sourceregistry/sveltekit-enhance` or `@sourcere
138
138
 
139
139
  ---
140
140
 
141
+ ### `CSRF`
142
+
143
+ Blocks cross-site form submissions on mutating methods (`POST`, `PUT`, `PATCH`, `DELETE`) with form content types. Checks the `Origin` header against the request origin. Absent `Origin` (server-side fetch, curl) is allowed through. Returns `403` — JSON body when `Accept: application/json`, SvelteKit `error()` otherwise.
144
+
145
+ ```ts
146
+ import { CSRF, CSRFChecker } from '@sourceregistry/sveltekit-enhance';
147
+
148
+ export const handle = enhance.handle(
149
+ myHandler,
150
+ CSRF.inspect(
151
+ CSRFChecker.list('/api/webhooks/stripe'), // bypass paths
152
+ myLogger, // optional, defaults to console
153
+ ),
154
+ );
155
+ ```
156
+
157
+ Built-in bypass checkers:
158
+
159
+ | Checker | Description |
160
+ |---------|-------------|
161
+ | `CSRFChecker.list(...paths)` | Exact pathname match |
162
+ | `CSRFChecker.regex(...patterns)` | RegExp match against pathname |
163
+
164
+ Custom checker — any `(input: EnhanceInput) => MaybePromise<boolean>`:
165
+ ```ts
166
+ // true = bypass CSRF check
167
+ CSRF.inspect((input) => input.url.pathname.startsWith('/api/public'))
168
+ ```
169
+
170
+ Returns `{ csrf_valid: true }` on pass. Locals set: none.
171
+
172
+ ---
173
+
141
174
  ### `Auth`
142
175
 
143
176
  Extracts and validates `Authorization: Bearer <token>` headers.
@@ -353,6 +386,7 @@ TraceOptions // { logger?: TraceLogger; record?: (entry) => any }
353
386
  RecordTraceMetricEntry // { method: string; path: string; status: number; durationMs: number }
354
387
  RequestTraceLocals // { trace?: { id: string; started_at: bigint } }
355
388
  RequestCorrelationLocals // { correlation_id?: string; request_started_at?: number }
389
+ CSRFChecker // { regex(...patterns): checker; list(...paths): checker }
356
390
  ```
357
391
 
358
392
  ---
@@ -0,0 +1,14 @@
1
+ import { type EnhanceFunction, type EnhanceInput } from "../index.js";
2
+ import type { MaybePromise } from "../index.js";
3
+ import type { Logger } from "./logger.js";
4
+ export declare const CSRF: {
5
+ inspect: (checker: (input: EnhanceInput) => MaybePromise<boolean>, logger?: Logger) => EnhanceFunction<"handle">;
6
+ };
7
+ export declare const CSRFChecker: {
8
+ regex: (...oneOf: RegExp[]) => (input: {
9
+ url: URL;
10
+ }) => boolean;
11
+ list: (...oneOf: string[]) => (input: {
12
+ url: URL;
13
+ }) => boolean;
14
+ };
@@ -0,0 +1,38 @@
1
+ import { json } from '@sveltejs/kit';
2
+ import { error } from "../index.js";
3
+ function isContentType(request, ...types) {
4
+ const type = request.headers.get('content-type')?.split(';', 1)[0].trim() ?? '';
5
+ return types.includes(type.toLowerCase());
6
+ }
7
+ function isFormContentType(request) {
8
+ return isContentType(request, 'application/x-www-form-urlencoded', 'multipart/form-data', 'text/plain');
9
+ }
10
+ const MUTATING_METHODS = new Set(['POST', 'PUT', 'PATCH', 'DELETE']);
11
+ const SAFE_LOG_HEADERS = new Set(['content-type', 'origin', 'referer', 'user-agent', 'accept', 'host']);
12
+ export const CSRF = {
13
+ inspect: (checker, logger = console) => async (input) => {
14
+ const { request, url } = input;
15
+ const origin = request.headers.get('origin');
16
+ const forbidden = isFormContentType(request) &&
17
+ MUTATING_METHODS.has(request.method) &&
18
+ origin !== null &&
19
+ origin !== url.origin &&
20
+ !(await checker(input));
21
+ if (forbidden) {
22
+ const message = `Cross-site ${request.method} form submissions are forbidden`;
23
+ logger.warn('CSRF Violation detected', {
24
+ url: url.toString(),
25
+ headers: Object.fromEntries([...request.headers.entries()].filter(([k]) => SAFE_LOG_HEADERS.has(k.toLowerCase())))
26
+ });
27
+ if (request.headers.get('accept') === 'application/json') {
28
+ return json({ message }, { status: 403 });
29
+ }
30
+ return error(403, { message });
31
+ }
32
+ return { csrf_valid: true };
33
+ }
34
+ };
35
+ export const CSRFChecker = {
36
+ regex: (...oneOf) => (input) => oneOf.some((exp) => exp[Symbol.match](input.url.pathname)),
37
+ list: (...oneOf) => (input) => oneOf.includes(input.url.pathname)
38
+ };
@@ -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;
@@ -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 undefined;
173
+ return null;
173
174
  }
174
175
  return new Date(val);
175
176
  }
@@ -4,3 +4,5 @@ export * from './featureflag.js';
4
4
  export * from './form.ts';
5
5
  export * from './request-correlation.ts';
6
6
  export * from './request-monitor.js';
7
+ export * from './CSRF.js';
8
+ export * from './logger.js';
@@ -4,3 +4,5 @@ export * from './featureflag.js';
4
4
  export * from "./form.js";
5
5
  export * from "./request-correlation.js";
6
6
  export * from './request-monitor.js';
7
+ export * from './CSRF.js';
8
+ export * from './logger.js';
@@ -0,0 +1,6 @@
1
+ export type Logger = {
2
+ debug: (...args: any[]) => any;
3
+ info: (...args: any[]) => any;
4
+ warn: (...args: any[]) => any;
5
+ error: (...args: any[]) => any;
6
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -1,4 +1,5 @@
1
1
  import type { EnhanceFunction } from "../index.js";
2
+ import type { Logger } from "./logger.js";
2
3
  export type RequestTraceLocals = {
3
4
  trace?: {
4
5
  id: string;
@@ -11,14 +12,8 @@ export type RecordTraceMetricEntry = {
11
12
  status: number;
12
13
  durationMs: number;
13
14
  };
14
- export type TraceLogger = {
15
- debug: (...args: any[]) => any;
16
- info: (...args: any[]) => any;
17
- warn: (...args: any[]) => any;
18
- error: (...args: any[]) => any;
19
- };
20
15
  export type TraceOptions = {
21
- logger?: TraceLogger;
16
+ logger?: Logger;
22
17
  record?: (entry: RecordTraceMetricEntry) => any;
23
18
  };
24
19
  export declare const RequestMonitor: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sourceregistry/sveltekit-enhance",
3
- "version": "1.2.0",
3
+ "version": "1.3.1",
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": {