@beignet/core 0.0.2 → 0.0.4
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/CHANGELOG.md +173 -0
- package/README.md +821 -30
- package/dist/application/index.d.ts +28 -2
- package/dist/application/index.d.ts.map +1 -1
- package/dist/application/index.js +140 -12
- package/dist/application/index.js.map +1 -1
- package/dist/client/client.d.ts +2 -2
- package/dist/client/client.d.ts.map +1 -1
- package/dist/client/client.js +136 -48
- package/dist/client/client.js.map +1 -1
- package/dist/client/error-messages.d.ts +14 -0
- package/dist/client/error-messages.d.ts.map +1 -0
- package/dist/client/error-messages.js +23 -0
- package/dist/client/error-messages.js.map +1 -0
- package/dist/client/index.d.ts +8 -4
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +6 -2
- package/dist/client/index.js.map +1 -1
- package/dist/client/types.d.ts +35 -5
- package/dist/client/types.d.ts.map +1 -1
- package/dist/client-only.d.ts +8 -0
- package/dist/client-only.d.ts.map +1 -0
- package/dist/client-only.js +8 -0
- package/dist/client-only.js.map +1 -0
- package/dist/config/index.d.ts +5 -5
- package/dist/config/index.d.ts.map +1 -1
- package/dist/config/index.js +2 -2
- package/dist/config/index.js.map +1 -1
- package/dist/contracts/catalog-errors.d.ts +27 -0
- package/dist/contracts/catalog-errors.d.ts.map +1 -0
- package/dist/contracts/catalog-errors.js +69 -0
- package/dist/contracts/catalog-errors.js.map +1 -0
- package/dist/contracts/contract-builder.d.ts +15 -12
- package/dist/contracts/contract-builder.d.ts.map +1 -1
- package/dist/contracts/contract-builder.js +15 -41
- package/dist/contracts/contract-builder.js.map +1 -1
- package/dist/contracts/contract-group.d.ts +11 -8
- package/dist/contracts/contract-group.d.ts.map +1 -1
- package/dist/contracts/contract-group.js +13 -40
- package/dist/contracts/contract-group.js.map +1 -1
- package/dist/contracts/contract-like.d.ts +1 -1
- package/dist/contracts/contract-like.d.ts.map +1 -1
- package/dist/contracts/index.d.ts +13 -9
- package/dist/contracts/index.d.ts.map +1 -1
- package/dist/contracts/index.js +9 -5
- package/dist/contracts/index.js.map +1 -1
- package/dist/contracts/openapi-meta.d.ts +48 -0
- package/dist/contracts/openapi-meta.d.ts.map +1 -1
- package/dist/contracts/openapi-meta.js +3 -0
- package/dist/contracts/openapi-meta.js.map +1 -1
- package/dist/contracts/path-template.d.ts +1 -1
- package/dist/contracts/path-template.js +2 -2
- package/dist/contracts/path-template.js.map +1 -1
- package/dist/contracts/schema-shape.d.ts +37 -0
- package/dist/contracts/schema-shape.d.ts.map +1 -0
- package/dist/contracts/schema-shape.js +61 -0
- package/dist/contracts/schema-shape.js.map +1 -0
- package/dist/contracts/success-status.d.ts +32 -0
- package/dist/contracts/success-status.d.ts.map +1 -0
- package/dist/contracts/success-status.js +18 -0
- package/dist/contracts/success-status.js.map +1 -0
- package/dist/contracts/types.d.ts +25 -5
- package/dist/contracts/types.d.ts.map +1 -1
- package/dist/contracts/types.js.map +1 -1
- package/dist/contracts/utils.d.ts +1 -1
- package/dist/contracts/utils.d.ts.map +1 -1
- package/dist/contracts/utils.js +1 -1
- package/dist/contracts/utils.js.map +1 -1
- package/dist/domain/events.d.ts +1 -1
- package/dist/domain/events.d.ts.map +1 -1
- package/dist/domain/events.js +1 -1
- package/dist/domain/events.js.map +1 -1
- package/dist/domain/index.d.ts +3 -3
- package/dist/domain/index.d.ts.map +1 -1
- package/dist/domain/index.js +3 -3
- package/dist/domain/index.js.map +1 -1
- package/dist/errors/catalog.d.ts +9 -1
- package/dist/errors/catalog.d.ts.map +1 -1
- package/dist/errors/catalog.js +7 -1
- package/dist/errors/catalog.js.map +1 -1
- package/dist/errors/http.d.ts +10 -0
- package/dist/errors/http.d.ts.map +1 -1
- package/dist/errors/http.js +11 -1
- package/dist/errors/http.js.map +1 -1
- package/dist/errors/index.d.ts +4 -4
- package/dist/errors/index.d.ts.map +1 -1
- package/dist/errors/index.js +4 -4
- package/dist/errors/index.js.map +1 -1
- package/dist/errors/response.d.ts +4 -1
- package/dist/errors/response.d.ts.map +1 -1
- package/dist/errors/response.js.map +1 -1
- package/dist/events/index.d.ts +10 -12
- package/dist/events/index.d.ts.map +1 -1
- package/dist/events/index.js +10 -10
- package/dist/events/index.js.map +1 -1
- package/dist/idempotency/index.d.ts +5 -3
- package/dist/idempotency/index.d.ts.map +1 -1
- package/dist/idempotency/index.js.map +1 -1
- package/dist/jobs/index.d.ts +148 -16
- package/dist/jobs/index.d.ts.map +1 -1
- package/dist/jobs/index.js +174 -14
- package/dist/jobs/index.js.map +1 -1
- package/dist/notifications/index.d.ts +14 -16
- package/dist/notifications/index.d.ts.map +1 -1
- package/dist/notifications/index.js +14 -14
- package/dist/notifications/index.js.map +1 -1
- package/dist/openapi/index.d.ts +8 -3
- package/dist/openapi/index.d.ts.map +1 -1
- package/dist/openapi/index.js +41 -29
- package/dist/openapi/index.js.map +1 -1
- package/dist/openapi/schema-introspector.d.ts +37 -0
- package/dist/openapi/schema-introspector.d.ts.map +1 -1
- package/dist/openapi/schema-introspector.js +23 -17
- package/dist/openapi/schema-introspector.js.map +1 -1
- package/dist/outbox/index.d.ts +18 -4
- package/dist/outbox/index.d.ts.map +1 -1
- package/dist/outbox/index.js +104 -4
- package/dist/outbox/index.js.map +1 -1
- package/dist/ports/audit.d.ts +56 -10
- package/dist/ports/audit.d.ts.map +1 -1
- package/dist/ports/audit.js +71 -3
- package/dist/ports/audit.js.map +1 -1
- package/dist/ports/auth.d.ts +92 -0
- package/dist/ports/auth.d.ts.map +1 -1
- package/dist/ports/auth.js +92 -0
- package/dist/ports/auth.js.map +1 -1
- package/dist/ports/events.d.ts +2 -2
- package/dist/ports/events.d.ts.map +1 -1
- package/dist/ports/index.d.ts +62 -33
- package/dist/ports/index.d.ts.map +1 -1
- package/dist/ports/index.js +28 -34
- package/dist/ports/index.js.map +1 -1
- package/dist/ports/policy.d.ts +32 -3
- package/dist/ports/policy.d.ts.map +1 -1
- package/dist/ports/policy.js +13 -2
- package/dist/ports/policy.js.map +1 -1
- package/dist/ports/testing.d.ts +1030 -2
- package/dist/ports/testing.d.ts.map +1 -1
- package/dist/ports/testing.js +1031 -1
- package/dist/ports/testing.js.map +1 -1
- package/dist/ports/unbound.d.ts +21 -0
- package/dist/ports/unbound.d.ts.map +1 -0
- package/dist/ports/unbound.js +57 -0
- package/dist/ports/unbound.js.map +1 -0
- package/dist/ports/unit-of-work.d.ts +1 -1
- package/dist/ports/unit-of-work.d.ts.map +1 -1
- package/dist/ports/unit-of-work.js +1 -1
- package/dist/ports/unit-of-work.js.map +1 -1
- package/dist/providers/index.d.ts +3 -2
- package/dist/providers/index.d.ts.map +1 -1
- package/dist/providers/index.js +3 -2
- package/dist/providers/index.js.map +1 -1
- package/dist/providers/instrumentation.d.ts +46 -5
- package/dist/providers/instrumentation.d.ts.map +1 -1
- package/dist/providers/instrumentation.js +25 -6
- package/dist/providers/instrumentation.js.map +1 -1
- package/dist/providers/metadata.d.ts +39 -0
- package/dist/providers/metadata.d.ts.map +1 -0
- package/dist/providers/metadata.js +169 -0
- package/dist/providers/metadata.js.map +1 -0
- package/dist/providers/provider.d.ts +114 -9
- package/dist/providers/provider.d.ts.map +1 -1
- package/dist/providers/provider.js +3 -20
- package/dist/providers/provider.js.map +1 -1
- package/dist/schedules/index.d.ts +94 -13
- package/dist/schedules/index.d.ts.map +1 -1
- package/dist/schedules/index.js +66 -12
- package/dist/schedules/index.js.map +1 -1
- package/dist/server/audit-context.d.ts +29 -0
- package/dist/server/audit-context.d.ts.map +1 -0
- package/dist/server/audit-context.js +44 -0
- package/dist/server/audit-context.js.map +1 -0
- package/dist/server/context.d.ts +141 -0
- package/dist/server/context.d.ts.map +1 -0
- package/dist/server/context.js +39 -0
- package/dist/server/context.js.map +1 -0
- package/dist/server/contract-like.d.ts +1 -1
- package/dist/server/contract-like.d.ts.map +1 -1
- package/dist/server/contract-like.js +1 -1
- package/dist/server/contract-like.js.map +1 -1
- package/dist/server/health.d.ts +2 -2
- package/dist/server/health.d.ts.map +1 -1
- package/dist/server/hooks/auth.d.ts +89 -65
- package/dist/server/hooks/auth.d.ts.map +1 -1
- package/dist/server/hooks/auth.js +84 -55
- package/dist/server/hooks/auth.js.map +1 -1
- package/dist/server/hooks/cors.d.ts +1 -1
- package/dist/server/hooks/cors.d.ts.map +1 -1
- package/dist/server/hooks/errors.d.ts +2 -2
- package/dist/server/hooks/errors.d.ts.map +1 -1
- package/dist/server/hooks/errors.js +2 -2
- package/dist/server/hooks/errors.js.map +1 -1
- package/dist/server/hooks/idempotency.d.ts +78 -0
- package/dist/server/hooks/idempotency.d.ts.map +1 -0
- package/dist/server/hooks/idempotency.js +154 -0
- package/dist/server/hooks/idempotency.js.map +1 -0
- package/dist/server/hooks/index.d.ts +8 -7
- package/dist/server/hooks/index.d.ts.map +1 -1
- package/dist/server/hooks/index.js +6 -5
- package/dist/server/hooks/index.js.map +1 -1
- package/dist/server/hooks/logging.d.ts +2 -2
- package/dist/server/hooks/logging.d.ts.map +1 -1
- package/dist/server/hooks/logging.js +1 -1
- package/dist/server/hooks/logging.js.map +1 -1
- package/dist/server/hooks/rate-limit.d.ts +25 -7
- package/dist/server/hooks/rate-limit.d.ts.map +1 -1
- package/dist/server/hooks/rate-limit.js +47 -12
- package/dist/server/hooks/rate-limit.js.map +1 -1
- package/dist/server/hooks.d.ts +1 -1
- package/dist/server/hooks.d.ts.map +1 -1
- package/dist/server/hooks.js +1 -1
- package/dist/server/hooks.js.map +1 -1
- package/dist/server/http.d.ts +84 -6
- package/dist/server/http.d.ts.map +1 -1
- package/dist/server/index.d.ts +36 -12
- package/dist/server/index.d.ts.map +1 -1
- package/dist/server/index.js +24 -8
- package/dist/server/index.js.map +1 -1
- package/dist/server/instrumentation.d.ts +108 -0
- package/dist/server/instrumentation.d.ts.map +1 -0
- package/dist/server/instrumentation.js +297 -0
- package/dist/server/instrumentation.js.map +1 -0
- package/dist/server/openapi.d.ts +3 -3
- package/dist/server/openapi.d.ts.map +1 -1
- package/dist/server/openapi.js +1 -1
- package/dist/server/openapi.js.map +1 -1
- package/dist/server/providers/index.d.ts +3 -3
- package/dist/server/providers/index.d.ts.map +1 -1
- package/dist/server/providers/index.js +3 -3
- package/dist/server/providers/index.js.map +1 -1
- package/dist/server/providers/loadProviderConfig.d.ts +2 -2
- package/dist/server/providers/loadProviderConfig.d.ts.map +1 -1
- package/dist/server/providers/loadProviderConfig.js +2 -2
- package/dist/server/providers/loadProviderConfig.js.map +1 -1
- package/dist/server/request-context.d.ts +67 -0
- package/dist/server/request-context.d.ts.map +1 -0
- package/dist/server/request-context.js +79 -0
- package/dist/server/request-context.js.map +1 -0
- package/dist/server/server-context.d.ts +38 -0
- package/dist/server/server-context.d.ts.map +1 -0
- package/dist/server/server-context.js +38 -0
- package/dist/server/server-context.js.map +1 -0
- package/dist/server/server.d.ts +148 -35
- package/dist/server/server.d.ts.map +1 -1
- package/dist/server/server.js +482 -145
- package/dist/server/server.js.map +1 -1
- package/dist/server/types.d.ts +2 -2
- package/dist/server/types.d.ts.map +1 -1
- package/dist/server/types.js +2 -2
- package/dist/server/types.js.map +1 -1
- package/dist/server/use-case-route.d.ts +263 -0
- package/dist/server/use-case-route.d.ts.map +1 -0
- package/dist/server/use-case-route.js +77 -0
- package/dist/server/use-case-route.js.map +1 -0
- package/dist/server-only.d.ts +8 -0
- package/dist/server-only.d.ts.map +1 -0
- package/dist/server-only.js +8 -0
- package/dist/server-only.js.map +1 -0
- package/dist/tasks/index.d.ts +139 -0
- package/dist/tasks/index.d.ts.map +1 -0
- package/dist/tasks/index.js +98 -0
- package/dist/tasks/index.js.map +1 -0
- package/dist/testing/index.d.ts +611 -5
- package/dist/testing/index.d.ts.map +1 -1
- package/dist/testing/index.js +434 -4
- package/dist/testing/index.js.map +1 -1
- package/dist/tracing/index.d.ts +89 -0
- package/dist/tracing/index.d.ts.map +1 -0
- package/dist/tracing/index.js +101 -0
- package/dist/tracing/index.js.map +1 -0
- package/dist/uploads/client.d.ts +278 -0
- package/dist/uploads/client.d.ts.map +1 -0
- package/dist/uploads/client.js +428 -0
- package/dist/uploads/client.js.map +1 -0
- package/dist/uploads/index.d.ts +361 -0
- package/dist/uploads/index.d.ts.map +1 -0
- package/dist/uploads/index.js +543 -0
- package/dist/uploads/index.js.map +1 -0
- package/package.json +34 -3
- package/src/application/index.ts +193 -10
- package/src/client/client.ts +148 -150
- package/src/client/error-messages.ts +35 -0
- package/src/client/index.ts +12 -4
- package/src/client/types.ts +44 -5
- package/src/client-only.ts +7 -0
- package/src/config/index.ts +6 -6
- package/src/contracts/catalog-errors.ts +115 -0
- package/src/contracts/contract-builder.ts +39 -76
- package/src/contracts/contract-group.ts +33 -68
- package/src/contracts/contract-like.ts +1 -1
- package/src/contracts/index.ts +24 -11
- package/src/contracts/openapi-meta.ts +55 -0
- package/src/contracts/path-template.ts +2 -2
- package/src/contracts/schema-shape.ts +75 -0
- package/src/contracts/success-status.ts +68 -0
- package/src/contracts/types.ts +32 -5
- package/src/contracts/utils.ts +5 -2
- package/src/domain/events.ts +6 -2
- package/src/domain/index.ts +3 -3
- package/src/errors/catalog.ts +9 -1
- package/src/errors/http.ts +11 -1
- package/src/errors/index.ts +4 -4
- package/src/errors/response.ts +4 -1
- package/src/events/index.ts +12 -26
- package/src/idempotency/index.ts +5 -3
- package/src/jobs/index.ts +340 -29
- package/src/notifications/index.ts +17 -27
- package/src/openapi/index.ts +73 -38
- package/src/openapi/schema-introspector.ts +68 -17
- package/src/outbox/index.ts +151 -6
- package/src/ports/audit.ts +120 -11
- package/src/ports/auth.ts +132 -0
- package/src/ports/events.ts +2 -2
- package/src/ports/index.ts +104 -35
- package/src/ports/policy.ts +50 -3
- package/src/ports/testing.ts +2220 -33
- package/src/ports/unbound.ts +64 -0
- package/src/ports/unit-of-work.ts +6 -2
- package/src/providers/index.ts +16 -3
- package/src/providers/instrumentation.ts +93 -8
- package/src/providers/metadata.ts +234 -0
- package/src/providers/provider.ts +168 -9
- package/src/schedules/index.ts +173 -23
- package/src/server/audit-context.ts +45 -0
- package/src/server/context.ts +224 -0
- package/src/server/contract-like.ts +1 -1
- package/src/server/health.ts +2 -2
- package/src/server/hooks/auth.ts +175 -158
- package/src/server/hooks/cors.ts +1 -1
- package/src/server/hooks/errors.ts +7 -4
- package/src/server/hooks/idempotency.ts +263 -0
- package/src/server/hooks/index.ts +15 -12
- package/src/server/hooks/logging.ts +3 -3
- package/src/server/hooks/rate-limit.ts +85 -17
- package/src/server/hooks.ts +1 -1
- package/src/server/http.ts +112 -6
- package/src/server/index.ts +63 -12
- package/src/server/instrumentation.ts +470 -0
- package/src/server/openapi.ts +4 -4
- package/src/server/providers/index.ts +6 -3
- package/src/server/providers/loadProviderConfig.ts +4 -4
- package/src/server/request-context.ts +116 -0
- package/src/server/server-context.ts +44 -0
- package/src/server/server.ts +1045 -229
- package/src/server/types.ts +2 -2
- package/src/server/use-case-route.ts +430 -0
- package/src/server-only.ts +7 -0
- package/src/tasks/index.ts +275 -0
- package/src/testing/index.ts +1153 -6
- package/src/tracing/index.ts +176 -0
- package/src/uploads/client.ts +861 -0
- package/src/uploads/index.ts +1071 -0
- package/dist/ports/mailer.d.ts +0 -6
- package/dist/ports/mailer.d.ts.map +0 -1
- package/dist/ports/mailer.js +0 -2
- package/dist/ports/mailer.js.map +0 -1
- package/dist/ports/schedules.d.ts +0 -9
- package/dist/ports/schedules.d.ts.map +0 -1
- package/dist/ports/schedules.js +0 -2
- package/dist/ports/schedules.js.map +0 -1
|
@@ -0,0 +1,224 @@
|
|
|
1
|
+
import type { HttpContractConfig } from "../contracts/index.js";
|
|
2
|
+
import type {
|
|
3
|
+
AnyPorts,
|
|
4
|
+
BoundGate,
|
|
5
|
+
GatePort,
|
|
6
|
+
PolicyDefinition,
|
|
7
|
+
} from "../ports/index.js";
|
|
8
|
+
import type { TraceContext } from "../tracing/index.js";
|
|
9
|
+
import type { HttpRequestLike, MaybePromise } from "./http.js";
|
|
10
|
+
|
|
11
|
+
/**
|
|
12
|
+
* Arguments passed to the `context.request` factory after a route is matched.
|
|
13
|
+
*/
|
|
14
|
+
export type RequestContextArgs<Ports extends AnyPorts = AnyPorts> = {
|
|
15
|
+
/**
|
|
16
|
+
* Framework-neutral request.
|
|
17
|
+
*/
|
|
18
|
+
req: HttpRequestLike;
|
|
19
|
+
/**
|
|
20
|
+
* Final app ports, including ports contributed by providers.
|
|
21
|
+
*/
|
|
22
|
+
ports: Ports;
|
|
23
|
+
/**
|
|
24
|
+
* Matched contract, when the request resolved to a registered route.
|
|
25
|
+
*/
|
|
26
|
+
contract?: HttpContractConfig;
|
|
27
|
+
/**
|
|
28
|
+
* Request correlation ID resolved by the server from the configured request
|
|
29
|
+
* ID header, or generated when the request did not send one.
|
|
30
|
+
*/
|
|
31
|
+
requestId: string;
|
|
32
|
+
/**
|
|
33
|
+
* W3C trace context resolved by the server from the incoming `traceparent`
|
|
34
|
+
* header, or generated when the request did not send one. Spread this into
|
|
35
|
+
* the context (`...trace`) to correlate downstream activity.
|
|
36
|
+
*/
|
|
37
|
+
trace: TraceContext;
|
|
38
|
+
};
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* Arguments passed to the `context.service` factory.
|
|
42
|
+
*/
|
|
43
|
+
export type ServiceContextArgs<
|
|
44
|
+
Ports extends AnyPorts = AnyPorts,
|
|
45
|
+
ServiceInput = void,
|
|
46
|
+
> = {
|
|
47
|
+
/**
|
|
48
|
+
* Final app ports, including ports contributed by providers.
|
|
49
|
+
*/
|
|
50
|
+
ports: Ports;
|
|
51
|
+
/**
|
|
52
|
+
* Caller-provided input such as the service actor or tenant.
|
|
53
|
+
*/
|
|
54
|
+
input: ServiceInput;
|
|
55
|
+
/**
|
|
56
|
+
* Fresh correlation ID generated for this service context.
|
|
57
|
+
*/
|
|
58
|
+
requestId: string;
|
|
59
|
+
/**
|
|
60
|
+
* Fresh W3C trace context generated for this service context. Spread this
|
|
61
|
+
* into the context (`...trace`) to correlate downstream activity.
|
|
62
|
+
*/
|
|
63
|
+
trace: TraceContext;
|
|
64
|
+
};
|
|
65
|
+
|
|
66
|
+
/**
|
|
67
|
+
* App context without its `gate` property.
|
|
68
|
+
*
|
|
69
|
+
* Context factories return seeds; the server attaches the gate declared by
|
|
70
|
+
* the blueprint's `gate` selector, so hand-binding `gate` in a factory is a
|
|
71
|
+
* type error.
|
|
72
|
+
*/
|
|
73
|
+
export type ContextSeed<Ctx> = Omit<Ctx, "gate"> & { gate?: never };
|
|
74
|
+
|
|
75
|
+
type ContextGateOption<Ctx, Ports extends AnyPorts> = [Ctx] extends [
|
|
76
|
+
{ gate: BoundGate<infer TPolicies extends readonly PolicyDefinition[]> },
|
|
77
|
+
]
|
|
78
|
+
? {
|
|
79
|
+
/**
|
|
80
|
+
* Select the gate port the server attaches to every context it builds.
|
|
81
|
+
*/
|
|
82
|
+
gate: (ports: Ports) => GatePort<ContextSeed<Ctx>, TPolicies>;
|
|
83
|
+
}
|
|
84
|
+
: {
|
|
85
|
+
/**
|
|
86
|
+
* Gate selection is only available when the context type declares a
|
|
87
|
+
* `gate` property.
|
|
88
|
+
*/
|
|
89
|
+
gate?: never;
|
|
90
|
+
};
|
|
91
|
+
|
|
92
|
+
/**
|
|
93
|
+
* Context blueprint accepted by `createServer(...)`.
|
|
94
|
+
*
|
|
95
|
+
* The server owns context assembly: `request` and `service` return context
|
|
96
|
+
* seeds, and the server attaches the gate declared by `gate` so identity
|
|
97
|
+
* changes can never authorize against a stale context.
|
|
98
|
+
*/
|
|
99
|
+
export type ServerContextOptions<
|
|
100
|
+
Ctx,
|
|
101
|
+
Ports extends AnyPorts = AnyPorts,
|
|
102
|
+
ServiceInput = void,
|
|
103
|
+
> = {
|
|
104
|
+
/**
|
|
105
|
+
* Build the per-request context seed.
|
|
106
|
+
*/
|
|
107
|
+
request: (args: RequestContextArgs<Ports>) => MaybePromise<ContextSeed<Ctx>>;
|
|
108
|
+
/**
|
|
109
|
+
* Build a service context seed for schedules, outbox drains, tasks, and
|
|
110
|
+
* background work. Required before `server.createServiceContext(...)` can
|
|
111
|
+
* be called.
|
|
112
|
+
*/
|
|
113
|
+
service?: (
|
|
114
|
+
args: ServiceContextArgs<Ports, ServiceInput>,
|
|
115
|
+
) => MaybePromise<ContextSeed<Ctx>>;
|
|
116
|
+
} & ContextGateOption<Ctx, Ports>;
|
|
117
|
+
|
|
118
|
+
/**
|
|
119
|
+
* Context configuration accepted by `createServer(...)`.
|
|
120
|
+
*
|
|
121
|
+
* Contexts without a `gate` property may use the plain request-factory
|
|
122
|
+
* shorthand. Contexts with a `gate` must use the blueprint form so the server
|
|
123
|
+
* owns gate attachment.
|
|
124
|
+
*/
|
|
125
|
+
export type ServerContextConfig<
|
|
126
|
+
Ctx,
|
|
127
|
+
Ports extends AnyPorts = AnyPorts,
|
|
128
|
+
ServiceInput = void,
|
|
129
|
+
> = [Ctx] extends [{ gate: unknown }]
|
|
130
|
+
? ServerContextOptions<Ctx, Ports, ServiceInput>
|
|
131
|
+
:
|
|
132
|
+
| ((args: RequestContextArgs<Ports>) => MaybePromise<Ctx>)
|
|
133
|
+
| ServerContextOptions<Ctx, Ports, ServiceInput>;
|
|
134
|
+
|
|
135
|
+
/**
|
|
136
|
+
* Argument tuple for `createServiceContext(...)`.
|
|
137
|
+
*
|
|
138
|
+
* Servers without a declared service input are callable with no arguments;
|
|
139
|
+
* optional inputs stay optional at the call site.
|
|
140
|
+
*/
|
|
141
|
+
export type ServiceContextInputArgs<ServiceInput> = [ServiceInput] extends [
|
|
142
|
+
// biome-ignore lint/suspicious/noConfusingVoidType: void marks "no declared service input" here
|
|
143
|
+
void,
|
|
144
|
+
]
|
|
145
|
+
? []
|
|
146
|
+
: undefined extends ServiceInput
|
|
147
|
+
? [input?: ServiceInput]
|
|
148
|
+
: [input: ServiceInput];
|
|
149
|
+
|
|
150
|
+
type AnyGateSelector<Ports extends AnyPorts> = (
|
|
151
|
+
ports: Ports,
|
|
152
|
+
) => Pick<GatePort<unknown>, "attach">;
|
|
153
|
+
|
|
154
|
+
/**
|
|
155
|
+
* Normalized runtime view of a server context configuration.
|
|
156
|
+
*/
|
|
157
|
+
export type ResolvedServerContext<Ctx, Ports extends AnyPorts, ServiceInput> = {
|
|
158
|
+
request: (
|
|
159
|
+
args: RequestContextArgs<Ports>,
|
|
160
|
+
) => MaybePromise<ContextSeed<Ctx> | Ctx>;
|
|
161
|
+
service?: (
|
|
162
|
+
args: ServiceContextArgs<Ports, ServiceInput>,
|
|
163
|
+
) => MaybePromise<ContextSeed<Ctx>>;
|
|
164
|
+
gate?: AnyGateSelector<Ports>;
|
|
165
|
+
};
|
|
166
|
+
|
|
167
|
+
/**
|
|
168
|
+
* Normalize a server context configuration into its runtime parts.
|
|
169
|
+
*/
|
|
170
|
+
export function resolveServerContext<Ctx, Ports extends AnyPorts, ServiceInput>(
|
|
171
|
+
config: ServerContextConfig<Ctx, Ports, ServiceInput>,
|
|
172
|
+
): ResolvedServerContext<Ctx, Ports, ServiceInput> {
|
|
173
|
+
const value = config as
|
|
174
|
+
| ((args: RequestContextArgs<Ports>) => MaybePromise<Ctx>)
|
|
175
|
+
| (ResolvedServerContext<Ctx, Ports, ServiceInput> & {
|
|
176
|
+
gate?: AnyGateSelector<Ports>;
|
|
177
|
+
});
|
|
178
|
+
|
|
179
|
+
if (typeof value === "function") {
|
|
180
|
+
return { request: value };
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
return {
|
|
184
|
+
request: value.request,
|
|
185
|
+
service: value.service,
|
|
186
|
+
gate: value.gate,
|
|
187
|
+
};
|
|
188
|
+
}
|
|
189
|
+
|
|
190
|
+
/**
|
|
191
|
+
* Create the context finalizer for a resolved server context.
|
|
192
|
+
*
|
|
193
|
+
* When the blueprint declares a gate, the finalizer strips hand-assigned
|
|
194
|
+
* `gate` values from seeds and attaches the live gate. Without a gate
|
|
195
|
+
* declaration the seed is the context.
|
|
196
|
+
*/
|
|
197
|
+
export function createContextFinalizer<
|
|
198
|
+
Ctx,
|
|
199
|
+
Ports extends AnyPorts,
|
|
200
|
+
ServiceInput,
|
|
201
|
+
>(
|
|
202
|
+
resolved: ResolvedServerContext<Ctx, Ports, ServiceInput>,
|
|
203
|
+
getPorts: () => Ports,
|
|
204
|
+
): (seed: ContextSeed<Ctx> | Ctx) => Ctx {
|
|
205
|
+
const gateSelector = resolved.gate;
|
|
206
|
+
if (!gateSelector) {
|
|
207
|
+
return (seed) => seed as Ctx;
|
|
208
|
+
}
|
|
209
|
+
|
|
210
|
+
return (seed) => {
|
|
211
|
+
const target = seed as object;
|
|
212
|
+
const existing = Object.getOwnPropertyDescriptor(target, "gate");
|
|
213
|
+
if (existing && existing.get === undefined) {
|
|
214
|
+
if (process.env.NODE_ENV !== "production") {
|
|
215
|
+
console.warn(
|
|
216
|
+
"[beignet] Ignoring a hand-assigned ctx.gate value. The server context blueprint owns gate attachment; remove `gate` from context factories and hook additions.",
|
|
217
|
+
);
|
|
218
|
+
}
|
|
219
|
+
delete (target as { gate?: unknown }).gate;
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
return gateSelector(getPorts()).attach(target) as Ctx;
|
|
223
|
+
};
|
|
224
|
+
}
|
package/src/server/health.ts
CHANGED
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
* Health check handler for Beignet server adapters.
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
|
-
import type { AnyPorts } from "../ports";
|
|
7
|
-
import type { HttpRequestLike, HttpResponseLike } from "./types";
|
|
6
|
+
import type { AnyPorts } from "../ports/index.js";
|
|
7
|
+
import type { HttpRequestLike, HttpResponseLike } from "./types.js";
|
|
8
8
|
|
|
9
9
|
/**
|
|
10
10
|
* Health check result returned by health handlers.
|
package/src/server/hooks/auth.ts
CHANGED
|
@@ -1,205 +1,222 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
AuthUnauthorizedError,
|
|
5
|
-
} from "../../ports";
|
|
6
|
-
import type { HttpRequestLike, HttpResponse, ServerHook } from "../types";
|
|
1
|
+
import type { InferOutput, StandardSchema } from "../../contracts/index.js";
|
|
2
|
+
import { AuthUnauthorizedError } from "../../ports/index.js";
|
|
3
|
+
import type { HttpRequestLike, RouteHook } from "../types.js";
|
|
7
4
|
|
|
8
5
|
type MaybePromise<T> = T | Promise<T>;
|
|
9
6
|
|
|
10
7
|
/**
|
|
11
|
-
*
|
|
8
|
+
* Arguments passed to auth route-hook callbacks.
|
|
12
9
|
*/
|
|
13
|
-
export type
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
*/
|
|
21
|
-
export type AuthHookModeInput = AuthHookMode | boolean | null | undefined;
|
|
22
|
-
|
|
23
|
-
/**
|
|
24
|
-
* Minimal context shape required when `createAuthHooks(...)` reads
|
|
25
|
-
* `ctx.ports.auth`.
|
|
26
|
-
*/
|
|
27
|
-
export type CtxWithAuthPort = {
|
|
28
|
-
ports: {
|
|
29
|
-
auth: AuthPort;
|
|
30
|
-
};
|
|
31
|
-
};
|
|
32
|
-
|
|
33
|
-
/**
|
|
34
|
-
* Arguments passed to auth hook callbacks.
|
|
35
|
-
*/
|
|
36
|
-
export type AuthHookArgs<Ctx> = {
|
|
10
|
+
export type AuthHookArgs<
|
|
11
|
+
Ctx,
|
|
12
|
+
HeadersSchema extends StandardSchema | undefined = undefined,
|
|
13
|
+
> = {
|
|
14
|
+
/**
|
|
15
|
+
* Framework-neutral request.
|
|
16
|
+
*/
|
|
37
17
|
req: HttpRequestLike;
|
|
18
|
+
/**
|
|
19
|
+
* Current route handler context.
|
|
20
|
+
*/
|
|
38
21
|
ctx: Ctx;
|
|
22
|
+
/**
|
|
23
|
+
* Matched contract metadata and schemas.
|
|
24
|
+
*/
|
|
39
25
|
contract: {
|
|
40
26
|
metadata?: Record<string, unknown>;
|
|
41
27
|
};
|
|
28
|
+
/**
|
|
29
|
+
* Parsed path parameters.
|
|
30
|
+
*/
|
|
42
31
|
path: unknown;
|
|
32
|
+
/**
|
|
33
|
+
* Parsed query parameters.
|
|
34
|
+
*/
|
|
43
35
|
query: unknown;
|
|
44
|
-
|
|
36
|
+
/**
|
|
37
|
+
* Hook-owned request headers.
|
|
38
|
+
*
|
|
39
|
+
* When the auth hooks declare a `headers` schema, this is that schema's
|
|
40
|
+
* output parsed from the raw lowercase request header record. Without a
|
|
41
|
+
* schema it is the raw lowercase header record itself, so auth resolution
|
|
42
|
+
* never depends on each route's contract header schema.
|
|
43
|
+
*/
|
|
44
|
+
headers: HeadersSchema extends StandardSchema
|
|
45
|
+
? InferOutput<HeadersSchema>
|
|
46
|
+
: Record<string, string>;
|
|
47
|
+
/**
|
|
48
|
+
* Parsed request body.
|
|
49
|
+
*/
|
|
45
50
|
body: unknown;
|
|
46
51
|
};
|
|
47
52
|
|
|
48
53
|
/**
|
|
49
|
-
*
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
/**
|
|
56
|
-
* Arguments passed to the auth `unauthorized` callback.
|
|
57
|
-
*/
|
|
58
|
-
export type AuthHookUnauthorizedArgs<Ctx, Session> = AuthHookArgs<Ctx> & {
|
|
59
|
-
session: Session | null;
|
|
60
|
-
};
|
|
61
|
-
|
|
62
|
-
/**
|
|
63
|
-
* Options for `createAuthHooks(...)`.
|
|
54
|
+
* Options for route-scoped auth hooks.
|
|
55
|
+
*
|
|
56
|
+
* Auth additions must not include `gate`: the server re-attaches the gate
|
|
57
|
+
* declared by the context blueprint after every hook, so elevated identities
|
|
58
|
+
* are authorized against the updated context automatically.
|
|
64
59
|
*/
|
|
65
|
-
export type AuthHooksOptions<
|
|
60
|
+
export type AuthHooksOptions<
|
|
61
|
+
Ctx,
|
|
62
|
+
AddedCtx extends object & { gate?: never },
|
|
63
|
+
HeadersSchema extends StandardSchema | undefined = undefined,
|
|
64
|
+
> = {
|
|
66
65
|
/**
|
|
67
|
-
* Hook name used in diagnostics.
|
|
66
|
+
* Hook name prefix used in diagnostics.
|
|
68
67
|
*/
|
|
69
68
|
name?: string;
|
|
70
69
|
/**
|
|
71
|
-
*
|
|
70
|
+
* Optional Standard Schema for the credential headers this hook reads.
|
|
71
|
+
*
|
|
72
|
+
* The schema is validated against the raw lowercase request header record
|
|
73
|
+
* before `resolve` runs. On `required()` hooks a schema failure rejects the
|
|
74
|
+
* request with a framework-owned 401; on `optional()` hooks a schema failure
|
|
75
|
+
* skips auth resolution; `public()` hooks never parse headers.
|
|
72
76
|
*/
|
|
73
|
-
|
|
77
|
+
headers?: HeadersSchema;
|
|
74
78
|
/**
|
|
75
|
-
*
|
|
76
|
-
*
|
|
79
|
+
* Resolve authenticated context additions for the current request.
|
|
80
|
+
*
|
|
81
|
+
* Return `null` when the request is unauthenticated. Required hooks will
|
|
82
|
+
* reject that request; optional hooks will add no auth context.
|
|
77
83
|
*/
|
|
78
|
-
|
|
84
|
+
resolve: (
|
|
85
|
+
args: AuthHookArgs<Ctx, HeadersSchema>,
|
|
86
|
+
) => MaybePromise<AddedCtx | null>;
|
|
87
|
+
};
|
|
88
|
+
|
|
89
|
+
/**
|
|
90
|
+
* Route-scoped auth hook set.
|
|
91
|
+
*/
|
|
92
|
+
export type AuthRouteHooks<Ctx, AddedCtx extends object & { gate?: never }> = {
|
|
79
93
|
/**
|
|
80
|
-
*
|
|
94
|
+
* Mark a route as intentionally public.
|
|
81
95
|
*/
|
|
82
|
-
|
|
96
|
+
public: () => RouteHook<Ctx, Record<string, never>>;
|
|
83
97
|
/**
|
|
84
|
-
*
|
|
98
|
+
* Resolve auth when present and add optional auth fields to the handler ctx.
|
|
85
99
|
*/
|
|
86
|
-
|
|
100
|
+
optional: () => RouteHook<Ctx, Partial<AddedCtx>>;
|
|
87
101
|
/**
|
|
88
|
-
*
|
|
102
|
+
* Require auth and add authenticated fields to the handler ctx.
|
|
89
103
|
*/
|
|
90
|
-
|
|
91
|
-
args: AuthHookUnauthorizedArgs<Ctx, Session>,
|
|
92
|
-
) => MaybePromise<HttpResponse>;
|
|
104
|
+
required: () => RouteHook<Ctx, AddedCtx>;
|
|
93
105
|
};
|
|
94
106
|
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
if (input === true || input === "required") return "required";
|
|
102
|
-
if (input === "optional") return "optional";
|
|
103
|
-
return "public";
|
|
107
|
+
function rawRequestHeaders(req: HttpRequestLike): Record<string, string> {
|
|
108
|
+
const record: Record<string, string> = {};
|
|
109
|
+
req.headers.forEach((value, key) => {
|
|
110
|
+
record[key.toLowerCase()] = value;
|
|
111
|
+
});
|
|
112
|
+
return record;
|
|
104
113
|
}
|
|
105
114
|
|
|
106
|
-
|
|
107
|
-
return modeFromInput(args.contract.metadata?.auth as AuthHookModeInput);
|
|
108
|
-
}
|
|
115
|
+
type ParsedAuthHeaders = { ok: true; headers: unknown } | { ok: false };
|
|
109
116
|
|
|
110
|
-
async function
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
);
|
|
117
|
+
async function parseAuthHeaders(
|
|
118
|
+
schema: StandardSchema | undefined,
|
|
119
|
+
req: HttpRequestLike,
|
|
120
|
+
): Promise<ParsedAuthHeaders> {
|
|
121
|
+
const raw = rawRequestHeaders(req);
|
|
122
|
+
if (!schema) {
|
|
123
|
+
return { ok: true, headers: raw };
|
|
118
124
|
}
|
|
119
125
|
|
|
120
|
-
|
|
121
|
-
|
|
126
|
+
const result = await schema["~standard"].validate(raw);
|
|
127
|
+
if (result.issues) {
|
|
128
|
+
return { ok: false };
|
|
129
|
+
}
|
|
122
130
|
|
|
123
|
-
|
|
124
|
-
return session !== null;
|
|
131
|
+
return { ok: true, headers: result.value };
|
|
125
132
|
}
|
|
126
133
|
|
|
127
134
|
/**
|
|
128
|
-
* Create
|
|
135
|
+
* Create route-scoped authentication hooks.
|
|
136
|
+
*
|
|
137
|
+
* The outer call binds the app context; the inner call takes auth options and
|
|
138
|
+
* infers the added context from `resolve`:
|
|
139
|
+
*
|
|
140
|
+
* ```ts
|
|
141
|
+
* const auth = createAuthHooks<AppContext>()({
|
|
142
|
+
* resolve: ({ ctx }) => (ctx.auth ? { user: ctx.auth.user } : null),
|
|
143
|
+
* });
|
|
144
|
+
* ```
|
|
145
|
+
*
|
|
146
|
+
* Use `auth.required()` on routes that require an authenticated actor and
|
|
147
|
+
* `auth.optional()` where handlers can use auth when present. The returned
|
|
148
|
+
* route hooks enrich handler `ctx`; business authorization still belongs in
|
|
149
|
+
* feature policies or use cases.
|
|
129
150
|
*
|
|
130
|
-
*
|
|
131
|
-
*
|
|
132
|
-
*
|
|
133
|
-
*
|
|
134
|
-
* cases.
|
|
151
|
+
* Declare a `headers` schema when credentials live in request headers. The
|
|
152
|
+
* hook validates the raw lowercase header record itself, so `resolve` receives
|
|
153
|
+
* typed headers without contract casts and a `required()` hook rejects
|
|
154
|
+
* missing or malformed credentials with a framework-owned 401.
|
|
135
155
|
*
|
|
136
|
-
* @
|
|
137
|
-
*
|
|
138
|
-
* @returns A server hook that runs before route handlers.
|
|
156
|
+
* @returns A function that takes auth options and returns public, optional,
|
|
157
|
+
* and required route-hook factories.
|
|
139
158
|
*/
|
|
140
|
-
export function createAuthHooks<Ctx
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
headers,
|
|
160
|
-
body,
|
|
161
|
-
}) => {
|
|
162
|
-
const args: AuthHookArgs<Ctx> = {
|
|
163
|
-
req,
|
|
164
|
-
ctx,
|
|
165
|
-
contract,
|
|
166
|
-
path,
|
|
167
|
-
query,
|
|
159
|
+
export function createAuthHooks<Ctx>() {
|
|
160
|
+
return <
|
|
161
|
+
AddedCtx extends object & { gate?: never },
|
|
162
|
+
HeadersSchema extends StandardSchema | undefined = undefined,
|
|
163
|
+
>(
|
|
164
|
+
options: AuthHooksOptions<Ctx, AddedCtx, HeadersSchema>,
|
|
165
|
+
): AuthRouteHooks<Ctx, AddedCtx> => {
|
|
166
|
+
const name = options.name ?? "auth";
|
|
167
|
+
|
|
168
|
+
const toAuthArgs = (
|
|
169
|
+
args: Parameters<RouteHook<Ctx, object>["resolve"]>[0],
|
|
170
|
+
headers: unknown,
|
|
171
|
+
): AuthHookArgs<Ctx, HeadersSchema> =>
|
|
172
|
+
({
|
|
173
|
+
req: args.req,
|
|
174
|
+
ctx: args.ctx,
|
|
175
|
+
contract: args.contract,
|
|
176
|
+
path: args.path,
|
|
177
|
+
query: args.query,
|
|
168
178
|
headers,
|
|
169
|
-
body,
|
|
170
|
-
}
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
)
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
179
|
+
body: args.body,
|
|
180
|
+
}) as AuthHookArgs<Ctx, HeadersSchema>;
|
|
181
|
+
|
|
182
|
+
return {
|
|
183
|
+
public: () => ({
|
|
184
|
+
name: `${name}.public`,
|
|
185
|
+
resolve: () => undefined,
|
|
186
|
+
}),
|
|
187
|
+
optional: () => ({
|
|
188
|
+
name: `${name}.optional`,
|
|
189
|
+
resolve: async (args) => {
|
|
190
|
+
const parsed = await parseAuthHeaders(options.headers, args.req);
|
|
191
|
+
if (!parsed.ok) {
|
|
192
|
+
return undefined;
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
const additions = await options.resolve(
|
|
196
|
+
toAuthArgs(args, parsed.headers),
|
|
197
|
+
);
|
|
198
|
+
|
|
199
|
+
return additions ?? undefined;
|
|
200
|
+
},
|
|
201
|
+
}),
|
|
202
|
+
required: () => ({
|
|
203
|
+
name: `${name}.required`,
|
|
204
|
+
resolve: async (args) => {
|
|
205
|
+
const parsed = await parseAuthHeaders(options.headers, args.req);
|
|
206
|
+
if (!parsed.ok) {
|
|
207
|
+
throw new AuthUnauthorizedError();
|
|
208
|
+
}
|
|
209
|
+
|
|
210
|
+
const additions = await options.resolve(
|
|
211
|
+
toAuthArgs(args, parsed.headers),
|
|
212
|
+
);
|
|
213
|
+
if (!additions) {
|
|
214
|
+
throw new AuthUnauthorizedError();
|
|
215
|
+
}
|
|
216
|
+
|
|
217
|
+
return additions;
|
|
218
|
+
},
|
|
219
|
+
}),
|
|
220
|
+
};
|
|
204
221
|
};
|
|
205
222
|
}
|
package/src/server/hooks/cors.ts
CHANGED
|
@@ -2,14 +2,17 @@
|
|
|
2
2
|
* Framework-agnostic error mapping utilities for @beignet/core/server
|
|
3
3
|
*/
|
|
4
4
|
|
|
5
|
-
import {
|
|
6
|
-
|
|
7
|
-
|
|
5
|
+
import {
|
|
6
|
+
createErrorResponseBody,
|
|
7
|
+
type ErrorResponseBody,
|
|
8
|
+
} from "../../errors/index.js";
|
|
9
|
+
import type { AppEnvironment } from "../health.js";
|
|
10
|
+
import { getRequestIdFromContext } from "./utils.js";
|
|
8
11
|
|
|
9
12
|
/**
|
|
10
13
|
* Re-export `AppEnvironment` for convenience.
|
|
11
14
|
*/
|
|
12
|
-
export type { AppEnvironment } from "../health";
|
|
15
|
+
export type { AppEnvironment } from "../health.js";
|
|
13
16
|
|
|
14
17
|
/**
|
|
15
18
|
* Framework-neutral response produced by an error mapper.
|