@entifix/service-shell 0.13.0 → 0.15.0
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 +7 -7
- package/dist/auth/failures.d.ts +0 -12
- package/dist/auth/failures.d.ts.map +1 -1
- package/dist/auth/failures.js +0 -10
- package/dist/auth/failures.js.map +1 -1
- package/dist/auth/index.d.ts +0 -1
- package/dist/auth/index.d.ts.map +1 -1
- package/dist/auth/index.js +0 -1
- package/dist/auth/index.js.map +1 -1
- package/dist/auth/require-principal.d.ts +0 -16
- package/dist/auth/require-principal.d.ts.map +1 -1
- package/dist/auth/require-principal.js +1 -38
- package/dist/auth/require-principal.js.map +1 -1
- package/dist/auth/require-service-crossing.d.ts +2 -73
- package/dist/auth/require-service-crossing.d.ts.map +1 -1
- package/dist/auth/require-service-crossing.js +2 -117
- package/dist/auth/require-service-crossing.js.map +1 -1
- package/dist/auth/shared-token.d.ts +0 -15
- package/dist/auth/shared-token.d.ts.map +1 -1
- package/dist/auth/shared-token.js +0 -25
- package/dist/auth/shared-token.js.map +1 -1
- package/dist/http-api/build-api.d.ts.map +1 -1
- package/dist/http-api/build-api.js +1 -1
- package/dist/http-api/build-api.js.map +1 -1
- package/dist/http-api/entity-api.d.ts.map +1 -1
- package/dist/http-api/entity-api.js +6 -2
- package/dist/http-api/entity-api.js.map +1 -1
- package/dist/index.d.ts +0 -4
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +0 -4
- package/dist/index.js.map +1 -1
- package/dist/load-remote-configuration.d.ts +4 -4
- package/dist/load-remote-configuration.d.ts.map +1 -1
- package/dist/load-remote-configuration.js +7 -14
- package/dist/load-remote-configuration.js.map +1 -1
- package/dist/observability.d.ts +2 -2
- package/dist/observability.d.ts.map +1 -1
- package/dist/observability.js.map +1 -1
- package/dist/push/index.d.ts +9 -0
- package/dist/push/index.d.ts.map +1 -0
- package/dist/push/index.js +9 -0
- package/dist/push/index.js.map +1 -0
- package/dist/push/server-push.d.ts +82 -0
- package/dist/push/server-push.d.ts.map +1 -0
- package/dist/push/server-push.js +48 -0
- package/dist/push/server-push.js.map +1 -0
- package/dist/push/sse.d.ts +62 -0
- package/dist/push/sse.d.ts.map +1 -0
- package/dist/push/sse.js +120 -0
- package/dist/push/sse.js.map +1 -0
- package/dist/respond.d.ts +1 -7
- package/dist/respond.d.ts.map +1 -1
- package/dist/respond.js +1 -8
- package/dist/respond.js.map +1 -1
- package/package.json +23 -13
- package/dist/auth/require-organization.d.ts +0 -32
- package/dist/auth/require-organization.d.ts.map +0 -1
- package/dist/auth/require-organization.js +0 -52
- package/dist/auth/require-organization.js.map +0 -1
- package/dist/entity-facet-routes.d.ts +0 -44
- package/dist/entity-facet-routes.d.ts.map +0 -1
- package/dist/entity-facet-routes.js +0 -70
- package/dist/entity-facet-routes.js.map +0 -1
- package/dist/entity-metadata-route.d.ts +0 -25
- package/dist/entity-metadata-route.d.ts.map +0 -1
- package/dist/entity-metadata-route.js +0 -102
- package/dist/entity-metadata-route.js.map +0 -1
- package/dist/entity-route-guard.d.ts +0 -62
- package/dist/entity-route-guard.d.ts.map +0 -1
- package/dist/entity-route-guard.js +0 -35
- package/dist/entity-route-guard.js.map +0 -1
- package/dist/entity-routes.d.ts +0 -76
- package/dist/entity-routes.d.ts.map +0 -1
- package/dist/entity-routes.js +0 -267
- package/dist/entity-routes.js.map +0 -1
- package/dist/route-responses.d.ts +0 -44
- package/dist/route-responses.d.ts.map +0 -1
- package/dist/route-responses.js +0 -104
- package/dist/route-responses.js.map +0 -1
- package/dist/sse.d.ts +0 -43
- package/dist/sse.d.ts.map +0 -1
- package/dist/sse.js +0 -78
- package/dist/sse.js.map +0 -1
|
@@ -1,62 +0,0 @@
|
|
|
1
|
-
import { type Action, type PolicyDecisionTag, type ServiceCrossingPolicyTag } from '@entifix/authz';
|
|
2
|
-
import type { RepositoryScope, RequestPrincipal, TokenServiceTag, VerifiedContext } from '@entifix/business';
|
|
3
|
-
import type { Entity, EntityConstructor, FilterGroup } from '@entifix/core';
|
|
4
|
-
import type { Effect } from 'effect';
|
|
5
|
-
import { type ServiceCrossingTokenTag } from './auth/index.js';
|
|
6
|
-
/**
|
|
7
|
-
* Who may reach a route, and where the organization a per-organization store
|
|
8
|
-
* needs comes from.
|
|
9
|
-
*
|
|
10
|
-
* - `public` — anybody; nothing is checked and no organization is known.
|
|
11
|
-
* - `permission` — a verified session holding the permission the entity
|
|
12
|
-
* derives for the verb.
|
|
13
|
-
* - `organization` — the same, plus the session's active organization, which
|
|
14
|
-
* is what a per-organization store opens.
|
|
15
|
-
* - `crossing` — the fleet's crossing token and no session at all. With
|
|
16
|
-
* `organization: true` the caller names the organization in a header, which
|
|
17
|
-
* only a caller that has proved it is the fleet may do.
|
|
18
|
-
*/
|
|
19
|
-
export type EntityRouteGuard = {
|
|
20
|
-
readonly kind: 'public';
|
|
21
|
-
} | {
|
|
22
|
-
readonly kind: 'permission';
|
|
23
|
-
} | {
|
|
24
|
-
readonly kind: 'organization';
|
|
25
|
-
} | {
|
|
26
|
-
readonly kind: 'crossing';
|
|
27
|
-
readonly organization: boolean;
|
|
28
|
-
};
|
|
29
|
-
/** What a route learned about its caller from its guard. */
|
|
30
|
-
export interface EntityRouteContext extends RepositoryScope {
|
|
31
|
-
readonly principal?: RequestPrincipal;
|
|
32
|
-
/** The caller's verified context, built by the guard from the principal. */
|
|
33
|
-
readonly verified?: VerifiedContext;
|
|
34
|
-
}
|
|
35
|
-
/**
|
|
36
|
-
* Which records of an entity a caller may see.
|
|
37
|
-
*
|
|
38
|
-
* `filter` narrows a list and `includes` decides a by-id read — both are
|
|
39
|
-
* needed, because `id` is the one member no query can name. `'none'` is a
|
|
40
|
-
* caller who holds the read grant and owns nothing: an empty page and a `404`,
|
|
41
|
-
* never a `403`, because owning no records is not an error.
|
|
42
|
-
*/
|
|
43
|
-
export type EntityReadScope<T extends Entity> = 'all' | 'none' | {
|
|
44
|
-
readonly filter: FilterGroup<T>;
|
|
45
|
-
readonly includes: (entity: T) => boolean;
|
|
46
|
-
};
|
|
47
|
-
/**
|
|
48
|
-
* What a route needs from the host for its guard: a session's services always
|
|
49
|
-
* (a `$metadata` read and a session guard both read the caller), the fleet's
|
|
50
|
-
* crossing services only when a guard is a crossing.
|
|
51
|
-
*/
|
|
52
|
-
export type GuardServices<G extends EntityRouteGuard> = TokenServiceTag | PolicyDecisionTag | (G extends {
|
|
53
|
-
readonly kind: 'crossing';
|
|
54
|
-
} ? ServiceCrossingTokenTag | ServiceCrossingPolicyTag : never);
|
|
55
|
-
/**
|
|
56
|
-
* Runs `use` behind `guard`, checking the permission the entity derives for
|
|
57
|
-
* `action` — the one place a derived route turns a stated guard into the
|
|
58
|
-
* check that enforces it, so the entity routes and the facet route cannot
|
|
59
|
-
* enforce the same guard differently.
|
|
60
|
-
*/
|
|
61
|
-
export declare const guardRoute: <T extends Entity, A, E, R>(entityConstructor: EntityConstructor<T>, guard: EntityRouteGuard, action: Action, use: (context: EntityRouteContext) => Effect.Effect<A, E, R>) => Effect.Effect<import("effect/http/HttpServerResponse").HttpServerResponse | A, E, TokenServiceTag | PolicyDecisionTag | import("effect/http/HttpServerRequest").HttpServerRequest | Exclude<R, import("@entifix/business").VerifiedContextTag>> | Effect.Effect<import("effect/http/HttpServerResponse").HttpServerResponse | A, E, ServiceCrossingPolicyTag | import("effect/http/HttpServerRequest").HttpServerRequest | ServiceCrossingTokenTag | Exclude<R, import("@entifix/business").VerifiedContextTag>>;
|
|
62
|
-
//# sourceMappingURL=entity-route-guard.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"entity-route-guard.d.ts","sourceRoot":"","sources":["../src/entity-route-guard.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,MAAM,EAEX,KAAK,iBAAiB,EACtB,KAAK,wBAAwB,EAC9B,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EACV,eAAe,EACf,gBAAgB,EAChB,eAAe,EACf,eAAe,EAChB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,MAAM,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAErC,OAAO,EAKL,KAAK,uBAAuB,EAE7B,MAAM,iBAAiB,CAAC;AAEzB;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,gBAAgB,GACxB;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;CAAE,GAC3B;IAAE,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAA;CAAE,GAC/B;IAAE,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAA;CAAE,GACjC;IAAE,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAAC,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAA;CAAE,CAAC;AAElE,4DAA4D;AAC5D,MAAM,WAAW,kBAAmB,SAAQ,eAAe;IACzD,QAAQ,CAAC,SAAS,CAAC,EAAE,gBAAgB,CAAC;IACtC,4EAA4E;IAC5E,QAAQ,CAAC,QAAQ,CAAC,EAAE,eAAe,CAAC;CACrC;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,MAAM,IACxC,KAAK,GACL,MAAM,GACN;IACE,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAChC,QAAQ,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,OAAO,CAAC;CAC3C,CAAC;AAEN;;;;GAIG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,gBAAgB,IAChD,eAAe,GACf,iBAAiB,GACjB,CAAC,CAAC,SAAS;IAAE,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAA;CAAE,GACpC,uBAAuB,GAAG,wBAAwB,GAClD,KAAK,CAAC,CAAC;AAEf;;;;;GAKG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAClD,mBAAmB,iBAAiB,CAAC,CAAC,CAAC,EACvC,OAAO,gBAAgB,EACvB,QAAQ,MAAM,EACd,KAAK,CAAC,OAAO,EAAE,kBAAkB,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,qfAyB7D,CAAC"}
|
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
import { _ as _extends } from "@swc/helpers/_/_extends";
|
|
2
|
-
import { permissionForEntity } from '@entifix/authz';
|
|
3
|
-
import { requireCrossing, requireOrganization, requirePermission, requireServiceCrossing, withVerifiedContext } from './auth/index.js';
|
|
4
|
-
/**
|
|
5
|
-
* Runs `use` behind `guard`, checking the permission the entity derives for
|
|
6
|
-
* `action` — the one place a derived route turns a stated guard into the
|
|
7
|
-
* check that enforces it, so the entity routes and the facet route cannot
|
|
8
|
-
* enforce the same guard differently.
|
|
9
|
-
*/ export const guardRoute = (entityConstructor, guard, action, use)=>{
|
|
10
|
-
const permission = permissionForEntity(entityConstructor, action);
|
|
11
|
-
// Every guard ends here: the context is built once, from what the guard
|
|
12
|
-
// verified, and provided to everything the route runs.
|
|
13
|
-
const verify = (context)=>withVerifiedContext(context.principal, (verified)=>use(_extends({}, context, {
|
|
14
|
-
verified
|
|
15
|
-
})));
|
|
16
|
-
switch(guard.kind){
|
|
17
|
-
case 'public':
|
|
18
|
-
return verify({});
|
|
19
|
-
case 'permission':
|
|
20
|
-
return requirePermission(permission)((principal)=>verify({
|
|
21
|
-
principal
|
|
22
|
-
}));
|
|
23
|
-
case 'organization':
|
|
24
|
-
return requireOrganization(permission)((organizationId, principal)=>verify({
|
|
25
|
-
organizationId,
|
|
26
|
-
principal
|
|
27
|
-
}));
|
|
28
|
-
case 'crossing':
|
|
29
|
-
return guard.organization ? requireServiceCrossing(permission)((organizationId)=>verify({
|
|
30
|
-
organizationId
|
|
31
|
-
})) : requireCrossing(permission)(verify({}));
|
|
32
|
-
}
|
|
33
|
-
};
|
|
34
|
-
|
|
35
|
-
//# sourceMappingURL=entity-route-guard.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/entity-route-guard.ts"],"sourcesContent":["import {\n type Action,\n permissionForEntity,\n type PolicyDecisionTag,\n type ServiceCrossingPolicyTag,\n} from '@entifix/authz';\nimport type {\n RepositoryScope,\n RequestPrincipal,\n TokenServiceTag,\n VerifiedContext,\n} from '@entifix/business';\nimport type { Entity, EntityConstructor, FilterGroup } from '@entifix/core';\nimport type { Effect } from 'effect';\n\nimport {\n requireCrossing,\n requireOrganization,\n requirePermission,\n requireServiceCrossing,\n type ServiceCrossingTokenTag,\n withVerifiedContext,\n} from './auth/index.js';\n\n/**\n * Who may reach a route, and where the organization a per-organization store\n * needs comes from.\n *\n * - `public` — anybody; nothing is checked and no organization is known.\n * - `permission` — a verified session holding the permission the entity\n * derives for the verb.\n * - `organization` — the same, plus the session's active organization, which\n * is what a per-organization store opens.\n * - `crossing` — the fleet's crossing token and no session at all. With\n * `organization: true` the caller names the organization in a header, which\n * only a caller that has proved it is the fleet may do.\n */\nexport type EntityRouteGuard =\n | { readonly kind: 'public' }\n | { readonly kind: 'permission' }\n | { readonly kind: 'organization' }\n | { readonly kind: 'crossing'; readonly organization: boolean };\n\n/** What a route learned about its caller from its guard. */\nexport interface EntityRouteContext extends RepositoryScope {\n readonly principal?: RequestPrincipal;\n /** The caller's verified context, built by the guard from the principal. */\n readonly verified?: VerifiedContext;\n}\n\n/**\n * Which records of an entity a caller may see.\n *\n * `filter` narrows a list and `includes` decides a by-id read — both are\n * needed, because `id` is the one member no query can name. `'none'` is a\n * caller who holds the read grant and owns nothing: an empty page and a `404`,\n * never a `403`, because owning no records is not an error.\n */\nexport type EntityReadScope<T extends Entity> =\n | 'all'\n | 'none'\n | {\n readonly filter: FilterGroup<T>;\n readonly includes: (entity: T) => boolean;\n };\n\n/**\n * What a route needs from the host for its guard: a session's services always\n * (a `$metadata` read and a session guard both read the caller), the fleet's\n * crossing services only when a guard is a crossing.\n */\nexport type GuardServices<G extends EntityRouteGuard> =\n | TokenServiceTag\n | PolicyDecisionTag\n | (G extends { readonly kind: 'crossing' }\n ? ServiceCrossingTokenTag | ServiceCrossingPolicyTag\n : never);\n\n/**\n * Runs `use` behind `guard`, checking the permission the entity derives for\n * `action` — the one place a derived route turns a stated guard into the\n * check that enforces it, so the entity routes and the facet route cannot\n * enforce the same guard differently.\n */\nexport const guardRoute = <T extends Entity, A, E, R>(\n entityConstructor: EntityConstructor<T>,\n guard: EntityRouteGuard,\n action: Action,\n use: (context: EntityRouteContext) => Effect.Effect<A, E, R>,\n) => {\n const permission = permissionForEntity(entityConstructor, action);\n // Every guard ends here: the context is built once, from what the guard\n // verified, and provided to everything the route runs.\n const verify = (context: EntityRouteContext) =>\n withVerifiedContext(context.principal, verified =>\n use({ ...context, verified }),\n );\n switch (guard.kind) {\n case 'public':\n return verify({});\n case 'permission':\n return requirePermission(permission)(principal => verify({ principal }));\n case 'organization':\n return requireOrganization(permission)((organizationId, principal) =>\n verify({ organizationId, principal }),\n );\n case 'crossing':\n return guard.organization\n ? requireServiceCrossing(permission)(organizationId =>\n verify({ organizationId }),\n )\n : requireCrossing(permission)(verify({}));\n }\n};\n"],"names":["permissionForEntity","requireCrossing","requireOrganization","requirePermission","requireServiceCrossing","withVerifiedContext","guardRoute","entityConstructor","guard","action","use","permission","verify","context","principal","verified","kind","organizationId","organization"],"mappings":";AAAA,SAEEA,mBAAmB,QAGd,iBAAiB;AAUxB,SACEC,eAAe,EACfC,mBAAmB,EACnBC,iBAAiB,EACjBC,sBAAsB,EAEtBC,mBAAmB,QACd,kBAAkB;AAwDzB;;;;;CAKC,GACD,OAAO,MAAMC,aAAa,CACxBC,mBACAC,OACAC,QACAC;IAEA,MAAMC,aAAaX,oBAAoBO,mBAAmBE;IAC1D,wEAAwE;IACxE,uDAAuD;IACvD,MAAMG,SAAS,CAACC,UACdR,oBAAoBQ,QAAQC,SAAS,EAAEC,CAAAA,WACrCL,IAAI,aAAKG;gBAASE;;IAEtB,OAAQP,MAAMQ,IAAI;QAChB,KAAK;YACH,OAAOJ,OAAO,CAAC;QACjB,KAAK;YACH,OAAOT,kBAAkBQ,YAAYG,CAAAA,YAAaF,OAAO;oBAAEE;gBAAU;QACvE,KAAK;YACH,OAAOZ,oBAAoBS,YAAY,CAACM,gBAAgBH,YACtDF,OAAO;oBAAEK;oBAAgBH;gBAAU;QAEvC,KAAK;YACH,OAAON,MAAMU,YAAY,GACrBd,uBAAuBO,YAAYM,CAAAA,iBACjCL,OAAO;oBAAEK;gBAAe,MAE1BhB,gBAAgBU,YAAYC,OAAO,CAAC;IAC5C;AACF,EAAE"}
|
package/dist/entity-routes.d.ts
DELETED
|
@@ -1,76 +0,0 @@
|
|
|
1
|
-
import type { NarrowingRules } from '@entifix/business';
|
|
2
|
-
import { EntityRepositoryFactoryTag } from '@entifix/business';
|
|
3
|
-
import { type EntifixBuildError, type EntifixEnvelopeLink, type Entity, type EntityConstructor, type EntityId } from '@entifix/core';
|
|
4
|
-
import { Effect } from 'effect';
|
|
5
|
-
import { HttpRouter, HttpServerResponse } from 'effect/http';
|
|
6
|
-
import { type EntityReadScope, type EntityRouteContext, type EntityRouteGuard } from './entity-route-guard.js';
|
|
7
|
-
import type { MetadataCompositions } from './metadata-composition.js';
|
|
8
|
-
import { type FailurePolicy } from './respond.js';
|
|
9
|
-
import { type EntityRouteRefusal, routeFailure } from './route-responses.js';
|
|
10
|
-
/** The five generic verbs a route set can mount. */
|
|
11
|
-
export type EntityVerb = 'list' | 'get' | 'create' | 'update' | 'delete';
|
|
12
|
-
export { type EntityReadScope, type EntityRouteContext, type EntityRouteGuard, } from './entity-route-guard.js';
|
|
13
|
-
export { EntityRouteRefusal } from './route-responses.js';
|
|
14
|
-
/** A hand-written handler for one verb, mounted under the derived guard. */
|
|
15
|
-
export type EntityRouteOverride<R> = (context: EntityRouteContext, links: EntityRouteLinks) => Effect.Effect<HttpServerResponse.HttpServerResponse, unknown, R>;
|
|
16
|
-
/** The affordances a route set derives from the verbs it mounts. */
|
|
17
|
-
export interface EntityRouteLinks {
|
|
18
|
-
readonly record: (id: EntityId) => EntifixEnvelopeLink[];
|
|
19
|
-
readonly collection: () => EntifixEnvelopeLink[];
|
|
20
|
-
}
|
|
21
|
-
export interface EntityRoutesOptions<T extends Entity, R, G extends EntityRouteGuard = EntityRouteGuard> {
|
|
22
|
-
readonly verbs: readonly EntityVerb[];
|
|
23
|
-
/** One guard for every verb, or one for the reads and one for the writes. */
|
|
24
|
-
readonly guard: G | {
|
|
25
|
-
readonly read: G;
|
|
26
|
-
readonly write: G;
|
|
27
|
-
};
|
|
28
|
-
/** Defaults to `/api/<entity key>`. */
|
|
29
|
-
readonly basePath?: `/${string}`;
|
|
30
|
-
/**
|
|
31
|
-
* Narrows the reads to what this caller may see, as resolver rules over the
|
|
32
|
-
* verified context. Replaces `scope`; a route set naming both throws.
|
|
33
|
-
*/
|
|
34
|
-
readonly narrowing?: NarrowingRules<T>;
|
|
35
|
-
/**
|
|
36
|
-
* The variant rules, recipes and catalog the entity's `@useCase()` verbs
|
|
37
|
-
* name, so `$metadata` can report what each resolves to for the caller.
|
|
38
|
-
*/
|
|
39
|
-
readonly compositions?: MetadataCompositions;
|
|
40
|
-
/** Narrows the reads to what this caller may see. Superseded by `narrowing`. */
|
|
41
|
-
readonly scope?: (context: EntityRouteContext) => Effect.Effect<EntityReadScope<T>, never, R>;
|
|
42
|
-
/**
|
|
43
|
-
* Runs on every create and update, after the body is read and before the
|
|
44
|
-
* save — and may change what is saved, or refuse it.
|
|
45
|
-
*/
|
|
46
|
-
readonly prepare?: (entity: T, context: EntityRouteContext & {
|
|
47
|
-
readonly verb: 'create' | 'update';
|
|
48
|
-
}) => Effect.Effect<T, EntityRouteRefusal | EntifixBuildError, R>;
|
|
49
|
-
/**
|
|
50
|
-
* A hand-written handler in place of the generic one for a verb. It keeps
|
|
51
|
-
* the derived guard and receives the derived links, so the escape hatch
|
|
52
|
-
* cannot drift from the rest of the set.
|
|
53
|
-
*/
|
|
54
|
-
readonly override?: Partial<Record<EntityVerb, EntityRouteOverride<R>>>;
|
|
55
|
-
/**
|
|
56
|
-
* How every verb's failures are answered and logged. Defaults to
|
|
57
|
-
* {@link defaultFailurePolicy}; a host passes its fleet policy.
|
|
58
|
-
*/
|
|
59
|
-
readonly policy?: FailurePolicy;
|
|
60
|
-
}
|
|
61
|
-
/**
|
|
62
|
-
* {@link deriveEntityRoutes}, with a curried form for a caller that has to
|
|
63
|
-
* name the services its `override`, `scope` or `prepare` handlers need:
|
|
64
|
-
* `makeEntityRoutes.for<R>()(Entity, options)` names `R` and still infers the
|
|
65
|
-
* entity and the guard from the value, which a single call with explicit type
|
|
66
|
-
* arguments cannot do.
|
|
67
|
-
*/
|
|
68
|
-
export { routeFailure };
|
|
69
|
-
export declare const makeEntityRoutes: (<T extends Entity, R = never, const G extends EntityRouteGuard = never>(entityConstructor: EntityConstructor<T>, options: EntityRoutesOptions<T, R, G>) => import("effect/Layer").Layer<never, never, HttpRouter.HttpRouter | HttpRouter.Request<"Requires", import("@entifix/business").TokenServiceTag> | HttpRouter.Request<"Requires", import("@entifix/authz").PolicyDecisionTag> | HttpRouter.Request<"Requires", EntityRepositoryFactoryTag> | HttpRouter.Request.From<"Requires", Exclude<Exclude<R, HttpRouter.Provided>, HttpRouter.Provided>> | HttpRouter.Request.From<"Requires", Exclude<Exclude<G extends {
|
|
70
|
-
readonly kind: "crossing";
|
|
71
|
-
} ? import("@entifix/authz").ServiceCrossingPolicyTag | import("./index.js").ServiceCrossingTokenTag : never, HttpRouter.Provided>, HttpRouter.Provided>>>) & {
|
|
72
|
-
for: <R>() => <T extends Entity, const G extends EntityRouteGuard>(entityConstructor: EntityConstructor<T>, options: EntityRoutesOptions<T, R, G>) => import("effect/Layer").Layer<never, never, HttpRouter.HttpRouter | HttpRouter.Request<"Requires", import("@entifix/business").TokenServiceTag> | HttpRouter.Request<"Requires", import("@entifix/authz").PolicyDecisionTag> | HttpRouter.Request<"Requires", EntityRepositoryFactoryTag> | HttpRouter.Request.From<"Requires", Exclude<Exclude<R, HttpRouter.Provided>, HttpRouter.Provided>> | HttpRouter.Request.From<"Requires", Exclude<Exclude<G extends {
|
|
73
|
-
readonly kind: "crossing";
|
|
74
|
-
} ? import("@entifix/authz").ServiceCrossingPolicyTag | import("./index.js").ServiceCrossingTokenTag : never, HttpRouter.Provided>, HttpRouter.Provided>>>;
|
|
75
|
-
};
|
|
76
|
-
//# sourceMappingURL=entity-routes.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"entity-routes.d.ts","sourceRoot":"","sources":["../src/entity-routes.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAIL,0BAA0B,EAM3B,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,MAAM,EACX,KAAK,iBAAiB,EACtB,KAAK,QAAQ,EASd,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,UAAU,EAAqB,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAGhF,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EAGtB,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAMtE,OAAO,EAEL,KAAK,aAAa,EAEnB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,KAAK,kBAAkB,EAEvB,YAAY,EACb,MAAM,sBAAsB,CAAC;AAE9B,oDAAoD;AACpD,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEzE,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,GACtB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,4EAA4E;AAC5E,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,CACnC,OAAO,EAAE,kBAAkB,EAC3B,KAAK,EAAE,gBAAgB,KACpB,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,kBAAkB,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;AAEtE,oEAAoE;AACpE,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,QAAQ,KAAK,mBAAmB,EAAE,CAAC;IACzD,QAAQ,CAAC,UAAU,EAAE,MAAM,mBAAmB,EAAE,CAAC;CAClD;AAED,MAAM,WAAW,mBAAmB,CAClC,CAAC,SAAS,MAAM,EAChB,CAAC,EACD,CAAC,SAAS,gBAAgB,GAAG,gBAAgB;IAE7C,QAAQ,CAAC,KAAK,EAAE,SAAS,UAAU,EAAE,CAAC;IACtC,6EAA6E;IAC7E,QAAQ,CAAC,KAAK,EAAE,CAAC,GAAG;QAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;QAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;KAAE,CAAC;IAC5D,uCAAuC;IACvC,QAAQ,CAAC,QAAQ,CAAC,EAAE,IAAI,MAAM,EAAE,CAAC;IACjC;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC;IACvC;;;OAGG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,oBAAoB,CAAC;IAC7C,gFAAgF;IAChF,QAAQ,CAAC,KAAK,CAAC,EAAE,CACf,OAAO,EAAE,kBAAkB,KACxB,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IACjD;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,CACjB,MAAM,EAAE,CAAC,EACT,OAAO,EAAE,kBAAkB,GAAG;QAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,GAAG,QAAQ,CAAA;KAAE,KACjE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,EAAE,CAAC,CAAC,CAAC;IACjE;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,UAAU,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACxE;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,aAAa,CAAC;CACjC;AA6UD;;;;;;GAMG;AACH,OAAO,EAAE,YAAY,EAAE,CAAC;AAExB,eAAO,MAAM,gBAAgB,IA1T3B,CAAC,SAAS,MAAM,EAChB,CAAC,gBAOK,CAAC,SAAS,gBAAgB,6BAEb,iBAAiB,CAAC,CAAC,CAAC,WAC9B,mBAAmB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;;;UAiTlC,CAAC,QACD,CAAC,SAAS,MAAM,QAAQ,CAAC,SAAS,gBAAgB,qBAC9B,iBAAiB,CAAC,CAAC,CAAC,WAC9B,mBAAmB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;;;CAGzC,CAAC"}
|
package/dist/entity-routes.js
DELETED
|
@@ -1,267 +0,0 @@
|
|
|
1
|
-
import { _ as _extends } from "@swc/helpers/_/_extends";
|
|
2
|
-
import { deleteUCFactory, EntityIdTag, EntityLoadRequestTag, EntityRepositoryFactoryTag, EntityRepositoryTag, EntityTag, getUCFactory, loadUCFactory, saveUCFactory } from '@entifix/business';
|
|
3
|
-
import { envelopeEntityName, extractMetaEntity, makeEntityEnvelope, makeEntityPageEnvelope, NotFound, parseLoadRequestParams, readEntityEnvelope } from '@entifix/core';
|
|
4
|
-
import { Effect } from 'effect';
|
|
5
|
-
import { HttpRouter, HttpServerRequest, HttpServerResponse } from 'effect/http';
|
|
6
|
-
import { entityMetadataRoute } from './entity-metadata-route.js';
|
|
7
|
-
import { guardRoute } from './entity-route-guard.js';
|
|
8
|
-
import { narrowedByIdRequest, narrowingFor, narrowLoadRequest } from './narrowing.js';
|
|
9
|
-
import { defaultFailurePolicy, respond } from './respond.js';
|
|
10
|
-
import { legacyAnswer, routeFailure } from './route-responses.js';
|
|
11
|
-
export { EntityRouteRefusal } from './route-responses.js';
|
|
12
|
-
const ACTION = {
|
|
13
|
-
list: 'read',
|
|
14
|
-
get: 'read',
|
|
15
|
-
create: 'write',
|
|
16
|
-
update: 'write',
|
|
17
|
-
delete: 'delete'
|
|
18
|
-
};
|
|
19
|
-
const READS = new Set([
|
|
20
|
-
'list',
|
|
21
|
-
'get'
|
|
22
|
-
]);
|
|
23
|
-
/**
|
|
24
|
-
* The generic routes for one entity — list, read, create, update, delete and
|
|
25
|
-
* its `$metadata` — derived from the entity and bound to storage through the
|
|
26
|
-
* host's {@link EntityRepositoryFactoryTag}.
|
|
27
|
-
*
|
|
28
|
-
* What a route set varies on is stated, not written: which verbs exist, who may
|
|
29
|
-
* reach them, which records a reader sees, and what a save must pass. What it
|
|
30
|
-
* never varies on is the wire: the load request is parsed against the entity's
|
|
31
|
-
* own metadata (so a query can only name a member the entity declared
|
|
32
|
-
* filterable or sortable), every answer is an envelope, and the links name
|
|
33
|
-
* exactly the verbs mounted — never one that would `404`.
|
|
34
|
-
*
|
|
35
|
-
* A path that is not one of these verbs is written by hand beside it, and a
|
|
36
|
-
* verb whose generic form does not fit is replaced with `override`.
|
|
37
|
-
*/ const deriveEntityRoutes = (entityConstructor, options)=>{
|
|
38
|
-
var _options_basePath, _options_compositions;
|
|
39
|
-
const key = envelopeEntityName(entityConstructor);
|
|
40
|
-
const base = (_options_basePath = options.basePath) != null ? _options_basePath : `/api/${key}`;
|
|
41
|
-
const mounted = new Set(options.verbs);
|
|
42
|
-
const links = {
|
|
43
|
-
record: (id)=>{
|
|
44
|
-
const href = `${base}/${String(id)}`;
|
|
45
|
-
return [
|
|
46
|
-
...mounted.has('get') ? [
|
|
47
|
-
{
|
|
48
|
-
rel: 'self',
|
|
49
|
-
href,
|
|
50
|
-
method: 'GET'
|
|
51
|
-
}
|
|
52
|
-
] : [],
|
|
53
|
-
...mounted.has('list') ? [
|
|
54
|
-
{
|
|
55
|
-
rel: 'list',
|
|
56
|
-
href: base,
|
|
57
|
-
method: 'GET'
|
|
58
|
-
}
|
|
59
|
-
] : [],
|
|
60
|
-
...mounted.has('update') ? [
|
|
61
|
-
{
|
|
62
|
-
rel: 'update',
|
|
63
|
-
href,
|
|
64
|
-
method: 'PUT'
|
|
65
|
-
}
|
|
66
|
-
] : [],
|
|
67
|
-
...mounted.has('delete') ? [
|
|
68
|
-
{
|
|
69
|
-
rel: 'delete',
|
|
70
|
-
href,
|
|
71
|
-
method: 'DELETE'
|
|
72
|
-
}
|
|
73
|
-
] : []
|
|
74
|
-
];
|
|
75
|
-
},
|
|
76
|
-
collection: ()=>[
|
|
77
|
-
...mounted.has('list') ? [
|
|
78
|
-
{
|
|
79
|
-
rel: 'self',
|
|
80
|
-
href: base,
|
|
81
|
-
method: 'GET'
|
|
82
|
-
}
|
|
83
|
-
] : [],
|
|
84
|
-
...mounted.has('create') ? [
|
|
85
|
-
{
|
|
86
|
-
rel: 'create',
|
|
87
|
-
href: base,
|
|
88
|
-
method: 'POST'
|
|
89
|
-
}
|
|
90
|
-
] : []
|
|
91
|
-
]
|
|
92
|
-
};
|
|
93
|
-
const guardFor = (verb)=>{
|
|
94
|
-
const guard = options.guard;
|
|
95
|
-
return 'kind' in guard ? guard : READS.has(verb) ? guard.read : guard.write;
|
|
96
|
-
};
|
|
97
|
-
const guarded = (verb, use)=>guardRoute(entityConstructor, guardFor(verb), ACTION[verb], use);
|
|
98
|
-
const repository = (context)=>Effect.gen(function*() {
|
|
99
|
-
const factory = yield* EntityRepositoryFactoryTag;
|
|
100
|
-
return yield* factory.for(entityConstructor, _extends({}, context.organizationId === undefined ? {} : {
|
|
101
|
-
organizationId: context.organizationId
|
|
102
|
-
}));
|
|
103
|
-
});
|
|
104
|
-
if (options.narrowing !== undefined && options.scope !== undefined) throw new Error(`the routes for '${extractMetaEntity(entityConstructor).key}' name both ` + '`narrowing` and `scope`; `narrowing` replaces `scope`, so name one.');
|
|
105
|
-
const scopeOf = (context)=>options.scope ? options.scope(context) : Effect.succeed('all');
|
|
106
|
-
/** The narrowing rules choose for this caller, or `undefined` without rules. */ const narrowingOf = (context)=>options.narrowing === undefined || context.verified === undefined ? undefined : narrowingFor(options.narrowing, context.verified);
|
|
107
|
-
const readLoadRequest = Effect.gen(function*() {
|
|
108
|
-
const request = yield* HttpServerRequest.HttpServerRequest;
|
|
109
|
-
const search = new URL(request.url, 'http://localhost').searchParams;
|
|
110
|
-
return yield* Effect.try({
|
|
111
|
-
try: ()=>parseLoadRequestParams(entityConstructor, search),
|
|
112
|
-
catch: (error)=>error
|
|
113
|
-
});
|
|
114
|
-
});
|
|
115
|
-
const notFound = Effect.fail(new NotFound({
|
|
116
|
-
entity: extractMetaEntity(entityConstructor).key
|
|
117
|
-
}));
|
|
118
|
-
const list = (context)=>Effect.gen(function*() {
|
|
119
|
-
var _parsed_filtering;
|
|
120
|
-
const parsed = yield* readLoadRequest;
|
|
121
|
-
const narrowing = narrowingOf(context);
|
|
122
|
-
const scope = narrowing === undefined ? yield* scopeOf(context) : narrowing === 'nothing' ? 'none' : 'all';
|
|
123
|
-
if (scope === 'none') {
|
|
124
|
-
// Still parsed: whether a query is well-formed must not depend on who
|
|
125
|
-
// asked. `nothing` answers here without a query.
|
|
126
|
-
return yield* HttpServerResponse.json(makeEntityPageEnvelope(entityConstructor, {
|
|
127
|
-
items: [],
|
|
128
|
-
total: 0,
|
|
129
|
-
request: parsed
|
|
130
|
-
}, links.collection()));
|
|
131
|
-
}
|
|
132
|
-
// Conjoined, never substituted: the translator `$and`s every top-level
|
|
133
|
-
// element, so an added element can only narrow, and no `or` in a query
|
|
134
|
-
// string can escape it.
|
|
135
|
-
const request = narrowing !== undefined && narrowing !== 'nothing' ? narrowLoadRequest(parsed, narrowing) : scope === 'all' ? parsed : _extends({}, parsed, {
|
|
136
|
-
filtering: [
|
|
137
|
-
...(_parsed_filtering = parsed.filtering) != null ? _parsed_filtering : [],
|
|
138
|
-
scope.filter
|
|
139
|
-
]
|
|
140
|
-
});
|
|
141
|
-
const page = yield* loadUCFactory().pipe(Effect.provideService(EntityRepositoryTag, (yield* repository(context))), Effect.provideService(EntityLoadRequestTag, request));
|
|
142
|
-
return yield* HttpServerResponse.json(makeEntityPageEnvelope(entityConstructor, page, links.collection()));
|
|
143
|
-
}).pipe(Effect.catch(legacyAnswer('invalidQuery')));
|
|
144
|
-
const get = (context)=>Effect.gen(function*() {
|
|
145
|
-
const params = yield* HttpRouter.params;
|
|
146
|
-
const narrowing = narrowingOf(context);
|
|
147
|
-
if (narrowing === 'nothing') return yield* notFound;
|
|
148
|
-
// A filter narrowing reads by id as a narrowed load, so the read and the
|
|
149
|
-
// list apply one rule: there is no second, in-memory predicate to drift.
|
|
150
|
-
if (narrowing !== undefined && narrowing !== 'unscoped') {
|
|
151
|
-
const page = yield* loadUCFactory().pipe(Effect.provideService(EntityRepositoryTag, (yield* repository(context))), Effect.provideService(EntityLoadRequestTag, narrowedByIdRequest(narrowing, params.id)));
|
|
152
|
-
const [only] = page.items;
|
|
153
|
-
if (only === undefined) return yield* notFound;
|
|
154
|
-
return yield* HttpServerResponse.json(makeEntityEnvelope(entityConstructor, only, links.record(params.id)));
|
|
155
|
-
}
|
|
156
|
-
const scope = narrowing === undefined ? yield* scopeOf(context) : 'all';
|
|
157
|
-
if (scope === 'none') return yield* notFound;
|
|
158
|
-
const found = yield* getUCFactory().pipe(Effect.provideService(EntityRepositoryTag, (yield* repository(context))), Effect.provideService(EntityIdTag, params.id), Effect.option);
|
|
159
|
-
// Out of scope answers exactly as absent does: a `403` would confirm the
|
|
160
|
-
// record exists to somebody who may not read it.
|
|
161
|
-
if (found._tag === 'None' || scope !== 'all' && !scope.includes(found.value)) {
|
|
162
|
-
return yield* notFound;
|
|
163
|
-
}
|
|
164
|
-
return yield* HttpServerResponse.json(makeEntityEnvelope(entityConstructor, found.value, links.record(params.id)));
|
|
165
|
-
}).pipe(Effect.catch(legacyAnswer('invalid')));
|
|
166
|
-
const save = (verb)=>(context)=>Effect.gen(function*() {
|
|
167
|
-
const request = yield* HttpServerRequest.HttpServerRequest;
|
|
168
|
-
const body = yield* request.json;
|
|
169
|
-
let entity = yield* readEntityEnvelope(entityConstructor, body);
|
|
170
|
-
// On update the URL is authoritative, so a record cannot be renamed
|
|
171
|
-
// onto another one by editing its payload.
|
|
172
|
-
if (verb === 'update') {
|
|
173
|
-
const params = yield* HttpRouter.params;
|
|
174
|
-
entity.id = params.id;
|
|
175
|
-
}
|
|
176
|
-
if (options.prepare) {
|
|
177
|
-
entity = yield* options.prepare(entity, _extends({}, context, {
|
|
178
|
-
verb
|
|
179
|
-
}));
|
|
180
|
-
}
|
|
181
|
-
const saved = yield* saveUCFactory().pipe(Effect.provideService(EntityRepositoryTag, (yield* repository(context))), Effect.provideService(EntityTag, entity));
|
|
182
|
-
return yield* HttpServerResponse.json(makeEntityEnvelope(entityConstructor, saved, links.record(saved.id)));
|
|
183
|
-
}).pipe(Effect.catch(legacyAnswer('invalidBody')));
|
|
184
|
-
/**
|
|
185
|
-
* Answers with an envelope rather than a bare `204`: every message between
|
|
186
|
-
* entifix artifacts is one, and the fetch client parses every response as
|
|
187
|
-
* JSON.
|
|
188
|
-
*/ const remove = (context)=>Effect.gen(function*() {
|
|
189
|
-
const params = yield* HttpRouter.params;
|
|
190
|
-
yield* deleteUCFactory().pipe(Effect.provideService(EntityRepositoryTag, (yield* repository(context))), Effect.provideService(EntityIdTag, params.id));
|
|
191
|
-
return yield* HttpServerResponse.json({
|
|
192
|
-
meta: {
|
|
193
|
-
type: 'entity',
|
|
194
|
-
entity: key,
|
|
195
|
-
links: links.collection()
|
|
196
|
-
},
|
|
197
|
-
data: {
|
|
198
|
-
id: params.id
|
|
199
|
-
}
|
|
200
|
-
});
|
|
201
|
-
}).pipe(Effect.catch(legacyAnswer('invalid')));
|
|
202
|
-
const generic = (verb, context)=>{
|
|
203
|
-
switch(verb){
|
|
204
|
-
case 'list':
|
|
205
|
-
return list(context);
|
|
206
|
-
case 'get':
|
|
207
|
-
return get(context);
|
|
208
|
-
case 'create':
|
|
209
|
-
return save('create')(context);
|
|
210
|
-
case 'update':
|
|
211
|
-
return save('update')(context);
|
|
212
|
-
case 'delete':
|
|
213
|
-
return remove(context);
|
|
214
|
-
}
|
|
215
|
-
};
|
|
216
|
-
/**
|
|
217
|
-
* Each guard asks for different services, so the branches do not unify on
|
|
218
|
-
* their own; the cast states the union every guard this set can reach
|
|
219
|
-
* actually needs.
|
|
220
|
-
*/ const handlerFor = (verb)=>{
|
|
221
|
-
var _options_policy;
|
|
222
|
-
return respond(guarded(verb, (context)=>{
|
|
223
|
-
var _options_override;
|
|
224
|
-
const override = (_options_override = options.override) == null ? void 0 : _options_override[verb];
|
|
225
|
-
return override ? override(context, links) : generic(verb, context);
|
|
226
|
-
}).pipe(Effect.catch(legacyAnswer('invalid'))), (_options_policy = options.policy) != null ? _options_policy : defaultFailurePolicy);
|
|
227
|
-
};
|
|
228
|
-
const ROUTES = {
|
|
229
|
-
list: {
|
|
230
|
-
method: 'GET',
|
|
231
|
-
path: base
|
|
232
|
-
},
|
|
233
|
-
get: {
|
|
234
|
-
method: 'GET',
|
|
235
|
-
path: `${base}/:id`
|
|
236
|
-
},
|
|
237
|
-
create: {
|
|
238
|
-
method: 'POST',
|
|
239
|
-
path: base
|
|
240
|
-
},
|
|
241
|
-
update: {
|
|
242
|
-
method: 'PUT',
|
|
243
|
-
path: `${base}/:id`
|
|
244
|
-
},
|
|
245
|
-
delete: {
|
|
246
|
-
method: 'DELETE',
|
|
247
|
-
path: `${base}/:id`
|
|
248
|
-
}
|
|
249
|
-
};
|
|
250
|
-
return HttpRouter.addAll([
|
|
251
|
-
// A literal, so it wins over `/:id` regardless of order.
|
|
252
|
-
HttpRouter.route('GET', `${base}/$metadata`, entityMetadataRoute(entityConstructor, (_options_compositions = options.compositions) != null ? _options_compositions : {})),
|
|
253
|
-
...options.verbs.map((verb)=>HttpRouter.route(ROUTES[verb].method, ROUTES[verb].path, handlerFor(verb)))
|
|
254
|
-
]);
|
|
255
|
-
};
|
|
256
|
-
/**
|
|
257
|
-
* {@link deriveEntityRoutes}, with a curried form for a caller that has to
|
|
258
|
-
* name the services its `override`, `scope` or `prepare` handlers need:
|
|
259
|
-
* `makeEntityRoutes.for<R>()(Entity, options)` names `R` and still infers the
|
|
260
|
-
* entity and the guard from the value, which a single call with explicit type
|
|
261
|
-
* arguments cannot do.
|
|
262
|
-
*/ export { routeFailure };
|
|
263
|
-
export const makeEntityRoutes = Object.assign(deriveEntityRoutes, {
|
|
264
|
-
for: ()=>(entityConstructor, options)=>deriveEntityRoutes(entityConstructor, options)
|
|
265
|
-
});
|
|
266
|
-
|
|
267
|
-
//# sourceMappingURL=entity-routes.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/entity-routes.ts"],"sourcesContent":["import type { Action } from '@entifix/authz';\nimport type { NarrowingRules } from '@entifix/business';\nimport {\n deleteUCFactory,\n EntityIdTag,\n EntityLoadRequestTag,\n EntityRepositoryFactoryTag,\n EntityRepositoryTag,\n EntityTag,\n getUCFactory,\n loadUCFactory,\n saveUCFactory,\n} from '@entifix/business';\nimport {\n type EntifixBuildError,\n type EntifixEnvelopeLink,\n type Entity,\n type EntityConstructor,\n type EntityId,\n type EntityLoadRequest,\n envelopeEntityName,\n extractMetaEntity,\n makeEntityEnvelope,\n makeEntityPageEnvelope,\n NotFound,\n parseLoadRequestParams,\n readEntityEnvelope,\n} from '@entifix/core';\nimport { Effect } from 'effect';\nimport { HttpRouter, HttpServerRequest, HttpServerResponse } from 'effect/http';\n\nimport { entityMetadataRoute } from './entity-metadata-route.js';\nimport {\n type EntityReadScope,\n type EntityRouteContext,\n type EntityRouteGuard,\n guardRoute,\n type GuardServices,\n} from './entity-route-guard.js';\nimport type { MetadataCompositions } from './metadata-composition.js';\nimport {\n narrowedByIdRequest,\n narrowingFor,\n narrowLoadRequest,\n} from './narrowing.js';\nimport {\n defaultFailurePolicy,\n type FailurePolicy,\n respond,\n} from './respond.js';\nimport {\n type EntityRouteRefusal,\n legacyAnswer,\n routeFailure,\n} from './route-responses.js';\n\n/** The five generic verbs a route set can mount. */\nexport type EntityVerb = 'list' | 'get' | 'create' | 'update' | 'delete';\n\nexport {\n type EntityReadScope,\n type EntityRouteContext,\n type EntityRouteGuard,\n} from './entity-route-guard.js';\nexport { EntityRouteRefusal } from './route-responses.js';\n\n/** A hand-written handler for one verb, mounted under the derived guard. */\nexport type EntityRouteOverride<R> = (\n context: EntityRouteContext,\n links: EntityRouteLinks,\n) => Effect.Effect<HttpServerResponse.HttpServerResponse, unknown, R>;\n\n/** The affordances a route set derives from the verbs it mounts. */\nexport interface EntityRouteLinks {\n readonly record: (id: EntityId) => EntifixEnvelopeLink[];\n readonly collection: () => EntifixEnvelopeLink[];\n}\n\nexport interface EntityRoutesOptions<\n T extends Entity,\n R,\n G extends EntityRouteGuard = EntityRouteGuard,\n> {\n readonly verbs: readonly EntityVerb[];\n /** One guard for every verb, or one for the reads and one for the writes. */\n readonly guard: G | { readonly read: G; readonly write: G };\n /** Defaults to `/api/<entity key>`. */\n readonly basePath?: `/${string}`;\n /**\n * Narrows the reads to what this caller may see, as resolver rules over the\n * verified context. Replaces `scope`; a route set naming both throws.\n */\n readonly narrowing?: NarrowingRules<T>;\n /**\n * The variant rules, recipes and catalog the entity's `@useCase()` verbs\n * name, so `$metadata` can report what each resolves to for the caller.\n */\n readonly compositions?: MetadataCompositions;\n /** Narrows the reads to what this caller may see. Superseded by `narrowing`. */\n readonly scope?: (\n context: EntityRouteContext,\n ) => Effect.Effect<EntityReadScope<T>, never, R>;\n /**\n * Runs on every create and update, after the body is read and before the\n * save — and may change what is saved, or refuse it.\n */\n readonly prepare?: (\n entity: T,\n context: EntityRouteContext & { readonly verb: 'create' | 'update' },\n ) => Effect.Effect<T, EntityRouteRefusal | EntifixBuildError, R>;\n /**\n * A hand-written handler in place of the generic one for a verb. It keeps\n * the derived guard and receives the derived links, so the escape hatch\n * cannot drift from the rest of the set.\n */\n readonly override?: Partial<Record<EntityVerb, EntityRouteOverride<R>>>;\n /**\n * How every verb's failures are answered and logged. Defaults to\n * {@link defaultFailurePolicy}; a host passes its fleet policy.\n */\n readonly policy?: FailurePolicy;\n}\n\nconst ACTION: Record<EntityVerb, Action> = {\n list: 'read',\n get: 'read',\n create: 'write',\n update: 'write',\n delete: 'delete',\n};\n\nconst READS: ReadonlySet<EntityVerb> = new Set(['list', 'get']);\n\n/**\n * The generic routes for one entity — list, read, create, update, delete and\n * its `$metadata` — derived from the entity and bound to storage through the\n * host's {@link EntityRepositoryFactoryTag}.\n *\n * What a route set varies on is stated, not written: which verbs exist, who may\n * reach them, which records a reader sees, and what a save must pass. What it\n * never varies on is the wire: the load request is parsed against the entity's\n * own metadata (so a query can only name a member the entity declared\n * filterable or sortable), every answer is an envelope, and the links name\n * exactly the verbs mounted — never one that would `404`.\n *\n * A path that is not one of these verbs is written by hand beside it, and a\n * verb whose generic form does not fit is replaced with `override`.\n */\nconst deriveEntityRoutes = <\n T extends Entity,\n R = never,\n // `never`, not the whole union: TypeScript infers no type argument once a\n // caller names one, so `makeEntityRoutes<T, R>(…)` used to default `G` to\n // every guard. Then the crossing tags became requirements of a route that\n // guards on a session, and the error surfaced at the host's `Layer.provide`\n // instead of here. Defaulting to `never` refuses that call at the guard\n // itself; `makeEntityRoutes.for<R>()` is the way to name `R` alone.\n const G extends EntityRouteGuard = never,\n>(\n entityConstructor: EntityConstructor<T>,\n options: EntityRoutesOptions<T, R, G>,\n) => {\n const key = envelopeEntityName(entityConstructor);\n const base: `/${string}` = options.basePath ?? `/api/${key}`;\n const mounted = new Set(options.verbs);\n\n const links: EntityRouteLinks = {\n record: id => {\n const href = `${base}/${String(id)}`;\n return [\n ...(mounted.has('get')\n ? [{ rel: 'self', href, method: 'GET' } as const]\n : []),\n ...(mounted.has('list')\n ? [{ rel: 'list', href: base, method: 'GET' } as const]\n : []),\n ...(mounted.has('update')\n ? [{ rel: 'update', href, method: 'PUT' } as const]\n : []),\n ...(mounted.has('delete')\n ? [{ rel: 'delete', href, method: 'DELETE' } as const]\n : []),\n ];\n },\n collection: () => [\n ...(mounted.has('list')\n ? [{ rel: 'self', href: base, method: 'GET' } as const]\n : []),\n ...(mounted.has('create')\n ? [{ rel: 'create', href: base, method: 'POST' } as const]\n : []),\n ],\n };\n\n const guardFor = (verb: EntityVerb): EntityRouteGuard => {\n const guard = options.guard as\n | EntityRouteGuard\n | { readonly read: EntityRouteGuard; readonly write: EntityRouteGuard };\n return 'kind' in guard ? guard : READS.has(verb) ? guard.read : guard.write;\n };\n\n const guarded = <A, E, RR>(\n verb: EntityVerb,\n use: (context: EntityRouteContext) => Effect.Effect<A, E, RR>,\n ) => guardRoute(entityConstructor, guardFor(verb), ACTION[verb], use);\n\n const repository = (context: EntityRouteContext) =>\n Effect.gen(function* () {\n const factory = yield* EntityRepositoryFactoryTag;\n return yield* factory.for(entityConstructor, {\n ...(context.organizationId === undefined\n ? {}\n : { organizationId: context.organizationId }),\n });\n });\n\n if (options.narrowing !== undefined && options.scope !== undefined)\n throw new Error(\n `the routes for '${extractMetaEntity(entityConstructor).key}' name both ` +\n '`narrowing` and `scope`; `narrowing` replaces `scope`, so name one.',\n );\n\n const scopeOf = (context: EntityRouteContext) =>\n options.scope ? options.scope(context) : Effect.succeed('all' as const);\n\n /** The narrowing rules choose for this caller, or `undefined` without rules. */\n const narrowingOf = (context: EntityRouteContext) =>\n options.narrowing === undefined || context.verified === undefined\n ? undefined\n : narrowingFor(options.narrowing, context.verified);\n\n const readLoadRequest = Effect.gen(function* () {\n const request = yield* HttpServerRequest.HttpServerRequest;\n const search = new URL(request.url, 'http://localhost').searchParams;\n return yield* Effect.try({\n try: () =>\n parseLoadRequestParams(\n entityConstructor,\n search,\n ) as unknown as EntityLoadRequest<T>,\n catch: error => error as EntifixBuildError,\n });\n });\n\n const notFound = Effect.fail(\n new NotFound({ entity: extractMetaEntity(entityConstructor).key }),\n );\n\n const list = (context: EntityRouteContext) =>\n Effect.gen(function* () {\n const parsed = yield* readLoadRequest;\n const narrowing = narrowingOf(context);\n const scope =\n narrowing === undefined\n ? yield* scopeOf(context)\n : narrowing === 'nothing'\n ? ('none' as const)\n : ('all' as const);\n if (scope === 'none') {\n // Still parsed: whether a query is well-formed must not depend on who\n // asked. `nothing` answers here without a query.\n return yield* HttpServerResponse.json(\n makeEntityPageEnvelope(\n entityConstructor,\n { items: [], total: 0, request: parsed },\n links.collection(),\n ),\n );\n }\n // Conjoined, never substituted: the translator `$and`s every top-level\n // element, so an added element can only narrow, and no `or` in a query\n // string can escape it.\n const request: EntityLoadRequest<T> =\n narrowing !== undefined && narrowing !== 'nothing'\n ? narrowLoadRequest(parsed, narrowing)\n : scope === 'all'\n ? parsed\n : {\n ...parsed,\n filtering: [...(parsed.filtering ?? []), scope.filter],\n };\n const page = yield* loadUCFactory<T>().pipe(\n Effect.provideService(EntityRepositoryTag, yield* repository(context)),\n Effect.provideService(\n EntityLoadRequestTag,\n request as unknown as EntityLoadRequest,\n ),\n );\n return yield* HttpServerResponse.json(\n makeEntityPageEnvelope(entityConstructor, page, links.collection()),\n );\n }).pipe(Effect.catch(legacyAnswer('invalidQuery')));\n\n const get = (context: EntityRouteContext) =>\n Effect.gen(function* () {\n const params = yield* HttpRouter.params;\n const narrowing = narrowingOf(context);\n if (narrowing === 'nothing') return yield* notFound;\n // A filter narrowing reads by id as a narrowed load, so the read and the\n // list apply one rule: there is no second, in-memory predicate to drift.\n if (narrowing !== undefined && narrowing !== 'unscoped') {\n const page = yield* loadUCFactory<T>().pipe(\n Effect.provideService(\n EntityRepositoryTag,\n yield* repository(context),\n ),\n Effect.provideService(\n EntityLoadRequestTag,\n narrowedByIdRequest<T>(\n narrowing,\n params.id,\n ) as unknown as EntityLoadRequest,\n ),\n );\n const [only] = page.items;\n if (only === undefined) return yield* notFound;\n return yield* HttpServerResponse.json(\n makeEntityEnvelope(entityConstructor, only, links.record(params.id)),\n );\n }\n const scope = narrowing === undefined ? yield* scopeOf(context) : 'all';\n if (scope === 'none') return yield* notFound;\n const found = yield* getUCFactory<T>().pipe(\n Effect.provideService(EntityRepositoryTag, yield* repository(context)),\n Effect.provideService(EntityIdTag, params.id),\n Effect.option,\n );\n // Out of scope answers exactly as absent does: a `403` would confirm the\n // record exists to somebody who may not read it.\n if (\n found._tag === 'None' ||\n (scope !== 'all' && !scope.includes(found.value))\n ) {\n return yield* notFound;\n }\n return yield* HttpServerResponse.json(\n makeEntityEnvelope(\n entityConstructor,\n found.value,\n links.record(params.id),\n ),\n );\n }).pipe(Effect.catch(legacyAnswer('invalid')));\n\n const save = (verb: 'create' | 'update') => (context: EntityRouteContext) =>\n Effect.gen(function* () {\n const request = yield* HttpServerRequest.HttpServerRequest;\n const body = yield* request.json;\n let entity = yield* readEntityEnvelope(entityConstructor, body);\n\n // On update the URL is authoritative, so a record cannot be renamed\n // onto another one by editing its payload.\n if (verb === 'update') {\n const params = yield* HttpRouter.params;\n entity.id = params.id;\n }\n if (options.prepare) {\n entity = yield* options.prepare(entity, { ...context, verb });\n }\n\n const saved = yield* saveUCFactory<T>().pipe(\n Effect.provideService(EntityRepositoryTag, yield* repository(context)),\n Effect.provideService(EntityTag, entity),\n );\n return yield* HttpServerResponse.json(\n makeEntityEnvelope(entityConstructor, saved, links.record(saved.id)),\n );\n }).pipe(Effect.catch(legacyAnswer('invalidBody')));\n\n /**\n * Answers with an envelope rather than a bare `204`: every message between\n * entifix artifacts is one, and the fetch client parses every response as\n * JSON.\n */\n const remove = (context: EntityRouteContext) =>\n Effect.gen(function* () {\n const params = yield* HttpRouter.params;\n yield* deleteUCFactory<T>().pipe(\n Effect.provideService(EntityRepositoryTag, yield* repository(context)),\n Effect.provideService(EntityIdTag, params.id),\n );\n return yield* HttpServerResponse.json({\n meta: { type: 'entity', entity: key, links: links.collection() },\n data: { id: params.id },\n });\n }).pipe(Effect.catch(legacyAnswer('invalid')));\n\n const generic = (verb: EntityVerb, context: EntityRouteContext) => {\n switch (verb) {\n case 'list':\n return list(context);\n case 'get':\n return get(context);\n case 'create':\n return save('create')(context);\n case 'update':\n return save('update')(context);\n case 'delete':\n return remove(context);\n }\n };\n\n /**\n * Each guard asks for different services, so the branches do not unify on\n * their own; the cast states the union every guard this set can reach\n * actually needs.\n */\n const handlerFor = (verb: EntityVerb) =>\n respond(\n (\n guarded(verb, context => {\n const override = options.override?.[verb];\n return override ? override(context, links) : generic(verb, context);\n }) as Effect.Effect<\n HttpServerResponse.HttpServerResponse,\n unknown,\n | R\n | EntityRepositoryFactoryTag\n | GuardServices<G>\n | HttpServerRequest.HttpServerRequest\n | HttpRouter.RouteContext\n >\n ).pipe(Effect.catch(legacyAnswer('invalid'))),\n options.policy ?? defaultFailurePolicy,\n );\n\n const ROUTES: Record<\n EntityVerb,\n { method: 'GET' | 'POST' | 'PUT' | 'DELETE'; path: `/${string}` }\n > = {\n list: { method: 'GET', path: base },\n get: { method: 'GET', path: `${base}/:id` },\n create: { method: 'POST', path: base },\n update: { method: 'PUT', path: `${base}/:id` },\n delete: { method: 'DELETE', path: `${base}/:id` },\n };\n\n return HttpRouter.addAll([\n // A literal, so it wins over `/:id` regardless of order.\n HttpRouter.route(\n 'GET',\n `${base}/$metadata`,\n entityMetadataRoute(entityConstructor, options.compositions ?? {}),\n ),\n ...options.verbs.map(verb =>\n HttpRouter.route(\n ROUTES[verb].method,\n ROUTES[verb].path,\n handlerFor(verb),\n ),\n ),\n ]);\n};\n\n/**\n * {@link deriveEntityRoutes}, with a curried form for a caller that has to\n * name the services its `override`, `scope` or `prepare` handlers need:\n * `makeEntityRoutes.for<R>()(Entity, options)` names `R` and still infers the\n * entity and the guard from the value, which a single call with explicit type\n * arguments cannot do.\n */\nexport { routeFailure };\n\nexport const makeEntityRoutes = Object.assign(deriveEntityRoutes, {\n for:\n <R>() =>\n <T extends Entity, const G extends EntityRouteGuard>(\n entityConstructor: EntityConstructor<T>,\n options: EntityRoutesOptions<T, R, G>,\n ) =>\n deriveEntityRoutes<T, R, G>(entityConstructor, options),\n});\n"],"names":["deleteUCFactory","EntityIdTag","EntityLoadRequestTag","EntityRepositoryFactoryTag","EntityRepositoryTag","EntityTag","getUCFactory","loadUCFactory","saveUCFactory","envelopeEntityName","extractMetaEntity","makeEntityEnvelope","makeEntityPageEnvelope","NotFound","parseLoadRequestParams","readEntityEnvelope","Effect","HttpRouter","HttpServerRequest","HttpServerResponse","entityMetadataRoute","guardRoute","narrowedByIdRequest","narrowingFor","narrowLoadRequest","defaultFailurePolicy","respond","legacyAnswer","routeFailure","EntityRouteRefusal","ACTION","list","get","create","update","delete","READS","Set","deriveEntityRoutes","entityConstructor","options","key","base","basePath","mounted","verbs","links","record","id","href","String","has","rel","method","collection","guardFor","verb","guard","read","write","guarded","use","repository","context","gen","factory","for","organizationId","undefined","narrowing","scope","Error","scopeOf","succeed","narrowingOf","verified","readLoadRequest","request","search","URL","url","searchParams","try","catch","error","notFound","fail","entity","parsed","json","items","total","filtering","filter","page","pipe","provideService","params","only","found","option","_tag","includes","value","save","body","prepare","saved","remove","meta","type","data","generic","handlerFor","override","policy","ROUTES","path","addAll","route","compositions","map","makeEntityRoutes","Object","assign"],"mappings":";AAEA,SACEA,eAAe,EACfC,WAAW,EACXC,oBAAoB,EACpBC,0BAA0B,EAC1BC,mBAAmB,EACnBC,SAAS,EACTC,YAAY,EACZC,aAAa,EACbC,aAAa,QACR,oBAAoB;AAC3B,SAOEC,kBAAkB,EAClBC,iBAAiB,EACjBC,kBAAkB,EAClBC,sBAAsB,EACtBC,QAAQ,EACRC,sBAAsB,EACtBC,kBAAkB,QACb,gBAAgB;AACvB,SAASC,MAAM,QAAQ,SAAS;AAChC,SAASC,UAAU,EAAEC,iBAAiB,EAAEC,kBAAkB,QAAQ,cAAc;AAEhF,SAASC,mBAAmB,QAAQ,6BAA6B;AACjE,SAIEC,UAAU,QAEL,0BAA0B;AAEjC,SACEC,mBAAmB,EACnBC,YAAY,EACZC,iBAAiB,QACZ,iBAAiB;AACxB,SACEC,oBAAoB,EAEpBC,OAAO,QACF,eAAe;AACtB,SAEEC,YAAY,EACZC,YAAY,QACP,uBAAuB;AAU9B,SAASC,kBAAkB,QAAQ,uBAAuB;AA2D1D,MAAMC,SAAqC;IACzCC,MAAM;IACNC,KAAK;IACLC,QAAQ;IACRC,QAAQ;IACRC,QAAQ;AACV;AAEA,MAAMC,QAAiC,IAAIC,IAAI;IAAC;IAAQ;CAAM;AAE9D;;;;;;;;;;;;;;CAcC,GACD,MAAMC,qBAAqB,CAWzBC,mBACAC;QAG2BA,mBAuRgBA;IAxR3C,MAAMC,MAAMhC,mBAAmB8B;IAC/B,MAAMG,QAAqBF,oBAAAA,QAAQG,QAAQ,YAAhBH,oBAAoB,CAAC,KAAK,EAAEC,KAAK;IAC5D,MAAMG,UAAU,IAAIP,IAAIG,QAAQK,KAAK;IAErC,MAAMC,QAA0B;QAC9BC,QAAQC,CAAAA;YACN,MAAMC,OAAO,GAAGP,KAAK,CAAC,EAAEQ,OAAOF,KAAK;YACpC,OAAO;mBACDJ,QAAQO,GAAG,CAAC,SACZ;oBAAC;wBAAEC,KAAK;wBAAQH;wBAAMI,QAAQ;oBAAM;iBAAW,GAC/C,EAAE;mBACFT,QAAQO,GAAG,CAAC,UACZ;oBAAC;wBAAEC,KAAK;wBAAQH,MAAMP;wBAAMW,QAAQ;oBAAM;iBAAW,GACrD,EAAE;mBACFT,QAAQO,GAAG,CAAC,YACZ;oBAAC;wBAAEC,KAAK;wBAAUH;wBAAMI,QAAQ;oBAAM;iBAAW,GACjD,EAAE;mBACFT,QAAQO,GAAG,CAAC,YACZ;oBAAC;wBAAEC,KAAK;wBAAUH;wBAAMI,QAAQ;oBAAS;iBAAW,GACpD,EAAE;aACP;QACH;QACAC,YAAY,IAAM;mBACZV,QAAQO,GAAG,CAAC,UACZ;oBAAC;wBAAEC,KAAK;wBAAQH,MAAMP;wBAAMW,QAAQ;oBAAM;iBAAW,GACrD,EAAE;mBACFT,QAAQO,GAAG,CAAC,YACZ;oBAAC;wBAAEC,KAAK;wBAAUH,MAAMP;wBAAMW,QAAQ;oBAAO;iBAAW,GACxD,EAAE;aACP;IACH;IAEA,MAAME,WAAW,CAACC;QAChB,MAAMC,QAAQjB,QAAQiB,KAAK;QAG3B,OAAO,UAAUA,QAAQA,QAAQrB,MAAMe,GAAG,CAACK,QAAQC,MAAMC,IAAI,GAAGD,MAAME,KAAK;IAC7E;IAEA,MAAMC,UAAU,CACdJ,MACAK,MACGxC,WAAWkB,mBAAmBgB,SAASC,OAAO1B,MAAM,CAAC0B,KAAK,EAAEK;IAEjE,MAAMC,aAAa,CAACC,UAClB/C,OAAOgD,GAAG,CAAC;YACT,MAAMC,UAAU,OAAO9D;YACvB,OAAO,OAAO8D,QAAQC,GAAG,CAAC3B,mBAAmB,aACvCwB,QAAQI,cAAc,KAAKC,YAC3B,CAAC,IACD;gBAAED,gBAAgBJ,QAAQI,cAAc;YAAC;QAEjD;IAEF,IAAI3B,QAAQ6B,SAAS,KAAKD,aAAa5B,QAAQ8B,KAAK,KAAKF,WACvD,MAAM,IAAIG,MACR,CAAC,gBAAgB,EAAE7D,kBAAkB6B,mBAAmBE,GAAG,CAAC,YAAY,CAAC,GACvE;IAGN,MAAM+B,UAAU,CAACT,UACfvB,QAAQ8B,KAAK,GAAG9B,QAAQ8B,KAAK,CAACP,WAAW/C,OAAOyD,OAAO,CAAC;IAE1D,8EAA8E,GAC9E,MAAMC,cAAc,CAACX,UACnBvB,QAAQ6B,SAAS,KAAKD,aAAaL,QAAQY,QAAQ,KAAKP,YACpDA,YACA7C,aAAaiB,QAAQ6B,SAAS,EAAEN,QAAQY,QAAQ;IAEtD,MAAMC,kBAAkB5D,OAAOgD,GAAG,CAAC;QACjC,MAAMa,UAAU,OAAO3D,kBAAkBA,iBAAiB;QAC1D,MAAM4D,SAAS,IAAIC,IAAIF,QAAQG,GAAG,EAAE,oBAAoBC,YAAY;QACpE,OAAO,OAAOjE,OAAOkE,GAAG,CAAC;YACvBA,KAAK,IACHpE,uBACEyB,mBACAuC;YAEJK,OAAOC,CAAAA,QAASA;QAClB;IACF;IAEA,MAAMC,WAAWrE,OAAOsE,IAAI,CAC1B,IAAIzE,SAAS;QAAE0E,QAAQ7E,kBAAkB6B,mBAAmBE,GAAG;IAAC;IAGlE,MAAMV,OAAO,CAACgC,UACZ/C,OAAOgD,GAAG,CAAC;gBA8BiBwB;YA7B1B,MAAMA,SAAS,OAAOZ;YACtB,MAAMP,YAAYK,YAAYX;YAC9B,MAAMO,QACJD,cAAcD,YACV,OAAOI,QAAQT,WACfM,cAAc,YACX,SACA;YACT,IAAIC,UAAU,QAAQ;gBACpB,sEAAsE;gBACtE,iDAAiD;gBACjD,OAAO,OAAOnD,mBAAmBsE,IAAI,CACnC7E,uBACE2B,mBACA;oBAAEmD,OAAO,EAAE;oBAAEC,OAAO;oBAAGd,SAASW;gBAAO,GACvC1C,MAAMQ,UAAU;YAGtB;YACA,uEAAuE;YACvE,uEAAuE;YACvE,wBAAwB;YACxB,MAAMuB,UACJR,cAAcD,aAAaC,cAAc,YACrC7C,kBAAkBgE,QAAQnB,aAC1BC,UAAU,QACRkB,SACA,aACKA;gBACHI,WAAW;wBAAKJ,oBAAAA,OAAOI,SAAS,YAAhBJ,oBAAoB,EAAE;oBAAGlB,MAAMuB,MAAM;iBAAC;;YAEhE,MAAMC,OAAO,OAAOvF,gBAAmBwF,IAAI,CACzC/E,OAAOgF,cAAc,CAAC5F,qBAAqB,CAAA,OAAO0D,WAAWC,QAAO,IACpE/C,OAAOgF,cAAc,CACnB9F,sBACA2E;YAGJ,OAAO,OAAO1D,mBAAmBsE,IAAI,CACnC7E,uBAAuB2B,mBAAmBuD,MAAMhD,MAAMQ,UAAU;QAEpE,GAAGyC,IAAI,CAAC/E,OAAOmE,KAAK,CAACxD,aAAa;IAEpC,MAAMK,MAAM,CAAC+B,UACX/C,OAAOgD,GAAG,CAAC;YACT,MAAMiC,SAAS,OAAOhF,WAAWgF,MAAM;YACvC,MAAM5B,YAAYK,YAAYX;YAC9B,IAAIM,cAAc,WAAW,OAAO,OAAOgB;YAC3C,yEAAyE;YACzE,yEAAyE;YACzE,IAAIhB,cAAcD,aAAaC,cAAc,YAAY;gBACvD,MAAMyB,OAAO,OAAOvF,gBAAmBwF,IAAI,CACzC/E,OAAOgF,cAAc,CACnB5F,qBACA,CAAA,OAAO0D,WAAWC,QAAO,IAE3B/C,OAAOgF,cAAc,CACnB9F,sBACAoB,oBACE+C,WACA4B,OAAOjD,EAAE;gBAIf,MAAM,CAACkD,KAAK,GAAGJ,KAAKJ,KAAK;gBACzB,IAAIQ,SAAS9B,WAAW,OAAO,OAAOiB;gBACtC,OAAO,OAAOlE,mBAAmBsE,IAAI,CACnC9E,mBAAmB4B,mBAAmB2D,MAAMpD,MAAMC,MAAM,CAACkD,OAAOjD,EAAE;YAEtE;YACA,MAAMsB,QAAQD,cAAcD,YAAY,OAAOI,QAAQT,WAAW;YAClE,IAAIO,UAAU,QAAQ,OAAO,OAAOe;YACpC,MAAMc,QAAQ,OAAO7F,eAAkByF,IAAI,CACzC/E,OAAOgF,cAAc,CAAC5F,qBAAqB,CAAA,OAAO0D,WAAWC,QAAO,IACpE/C,OAAOgF,cAAc,CAAC/F,aAAagG,OAAOjD,EAAE,GAC5ChC,OAAOoF,MAAM;YAEf,yEAAyE;YACzE,iDAAiD;YACjD,IACED,MAAME,IAAI,KAAK,UACd/B,UAAU,SAAS,CAACA,MAAMgC,QAAQ,CAACH,MAAMI,KAAK,GAC/C;gBACA,OAAO,OAAOlB;YAChB;YACA,OAAO,OAAOlE,mBAAmBsE,IAAI,CACnC9E,mBACE4B,mBACA4D,MAAMI,KAAK,EACXzD,MAAMC,MAAM,CAACkD,OAAOjD,EAAE;QAG5B,GAAG+C,IAAI,CAAC/E,OAAOmE,KAAK,CAACxD,aAAa;IAEpC,MAAM6E,OAAO,CAAChD,OAA8B,CAACO,UAC3C/C,OAAOgD,GAAG,CAAC;gBACT,MAAMa,UAAU,OAAO3D,kBAAkBA,iBAAiB;gBAC1D,MAAMuF,OAAO,OAAO5B,QAAQY,IAAI;gBAChC,IAAIF,SAAS,OAAOxE,mBAAmBwB,mBAAmBkE;gBAE1D,oEAAoE;gBACpE,2CAA2C;gBAC3C,IAAIjD,SAAS,UAAU;oBACrB,MAAMyC,SAAS,OAAOhF,WAAWgF,MAAM;oBACvCV,OAAOvC,EAAE,GAAGiD,OAAOjD,EAAE;gBACvB;gBACA,IAAIR,QAAQkE,OAAO,EAAE;oBACnBnB,SAAS,OAAO/C,QAAQkE,OAAO,CAACnB,QAAQ,aAAKxB;wBAASP;;gBACxD;gBAEA,MAAMmD,QAAQ,OAAOnG,gBAAmBuF,IAAI,CAC1C/E,OAAOgF,cAAc,CAAC5F,qBAAqB,CAAA,OAAO0D,WAAWC,QAAO,IACpE/C,OAAOgF,cAAc,CAAC3F,WAAWkF;gBAEnC,OAAO,OAAOpE,mBAAmBsE,IAAI,CACnC9E,mBAAmB4B,mBAAmBoE,OAAO7D,MAAMC,MAAM,CAAC4D,MAAM3D,EAAE;YAEtE,GAAG+C,IAAI,CAAC/E,OAAOmE,KAAK,CAACxD,aAAa;IAEpC;;;;GAIC,GACD,MAAMiF,SAAS,CAAC7C,UACd/C,OAAOgD,GAAG,CAAC;YACT,MAAMiC,SAAS,OAAOhF,WAAWgF,MAAM;YACvC,OAAOjG,kBAAqB+F,IAAI,CAC9B/E,OAAOgF,cAAc,CAAC5F,qBAAqB,CAAA,OAAO0D,WAAWC,QAAO,IACpE/C,OAAOgF,cAAc,CAAC/F,aAAagG,OAAOjD,EAAE;YAE9C,OAAO,OAAO7B,mBAAmBsE,IAAI,CAAC;gBACpCoB,MAAM;oBAAEC,MAAM;oBAAUvB,QAAQ9C;oBAAKK,OAAOA,MAAMQ,UAAU;gBAAG;gBAC/DyD,MAAM;oBAAE/D,IAAIiD,OAAOjD,EAAE;gBAAC;YACxB;QACF,GAAG+C,IAAI,CAAC/E,OAAOmE,KAAK,CAACxD,aAAa;IAEpC,MAAMqF,UAAU,CAACxD,MAAkBO;QACjC,OAAQP;YACN,KAAK;gBACH,OAAOzB,KAAKgC;YACd,KAAK;gBACH,OAAO/B,IAAI+B;YACb,KAAK;gBACH,OAAOyC,KAAK,UAAUzC;YACxB,KAAK;gBACH,OAAOyC,KAAK,UAAUzC;YACxB,KAAK;gBACH,OAAO6C,OAAO7C;QAClB;IACF;IAEA;;;;GAIC,GACD,MAAMkD,aAAa,CAACzD;YAgBhBhB;eAfFd,QACE,AACEkC,QAAQJ,MAAMO,CAAAA;gBACKvB;YAAjB,MAAM0E,YAAW1E,oBAAAA,QAAQ0E,QAAQ,qBAAhB1E,iBAAkB,CAACgB,KAAK;YACzC,OAAO0D,WAAWA,SAASnD,SAASjB,SAASkE,QAAQxD,MAAMO;QAC7D,GASAgC,IAAI,CAAC/E,OAAOmE,KAAK,CAACxD,aAAa,eACjCa,kBAAAA,QAAQ2E,MAAM,YAAd3E,kBAAkBf;;IAGtB,MAAM2F,SAGF;QACFrF,MAAM;YAAEsB,QAAQ;YAAOgE,MAAM3E;QAAK;QAClCV,KAAK;YAAEqB,QAAQ;YAAOgE,MAAM,GAAG3E,KAAK,IAAI,CAAC;QAAC;QAC1CT,QAAQ;YAAEoB,QAAQ;YAAQgE,MAAM3E;QAAK;QACrCR,QAAQ;YAAEmB,QAAQ;YAAOgE,MAAM,GAAG3E,KAAK,IAAI,CAAC;QAAC;QAC7CP,QAAQ;YAAEkB,QAAQ;YAAUgE,MAAM,GAAG3E,KAAK,IAAI,CAAC;QAAC;IAClD;IAEA,OAAOzB,WAAWqG,MAAM,CAAC;QACvB,yDAAyD;QACzDrG,WAAWsG,KAAK,CACd,OACA,GAAG7E,KAAK,UAAU,CAAC,EACnBtB,oBAAoBmB,oBAAmBC,wBAAAA,QAAQgF,YAAY,YAApBhF,wBAAwB,CAAC;WAE/DA,QAAQK,KAAK,CAAC4E,GAAG,CAACjE,CAAAA,OACnBvC,WAAWsG,KAAK,CACdH,MAAM,CAAC5D,KAAK,CAACH,MAAM,EACnB+D,MAAM,CAAC5D,KAAK,CAAC6D,IAAI,EACjBJ,WAAWzD;KAGhB;AACH;AAEA;;;;;;CAMC,GACD,SAAS5B,YAAY,GAAG;AAExB,OAAO,MAAM8F,mBAAmBC,OAAOC,MAAM,CAACtF,oBAAoB;IAChE4B,KACE,IACA,CACE3B,mBACAC,UAEAF,mBAA4BC,mBAAmBC;AACrD,GAAG"}
|
|
@@ -1,44 +0,0 @@
|
|
|
1
|
-
import { type EntifixFailure } from '@entifix/core';
|
|
2
|
-
import { Effect } from 'effect';
|
|
3
|
-
import { HttpServerResponse } from 'effect/http';
|
|
4
|
-
/**
|
|
5
|
-
* A save refused by a rule the entity's own deserializer does not make — a
|
|
6
|
-
* closed set, a rule over the other records — answered as `status` with
|
|
7
|
-
* `code`, which is what a client translates.
|
|
8
|
-
*/
|
|
9
|
-
export declare class EntityRouteRefusal {
|
|
10
|
-
readonly status: 400 | 409 | 422;
|
|
11
|
-
readonly code: string;
|
|
12
|
-
readonly detail?: string | undefined;
|
|
13
|
-
readonly _tag = "EntityRouteRefusal";
|
|
14
|
-
constructor(status: 400 | 409 | 422, code: string, detail?: string | undefined);
|
|
15
|
-
}
|
|
16
|
-
/**
|
|
17
|
-
* The `500` for anything a route did not anticipate.
|
|
18
|
-
*
|
|
19
|
-
* @deprecated A route mounted through `mountRoutes` answers through `respond`,
|
|
20
|
-
* which never writes `String(error)`. Kept for a host's unmigrated routes and
|
|
21
|
-
* removed with the class tree.
|
|
22
|
-
*/
|
|
23
|
-
export declare const routeFailure: (error: unknown) => Effect.Effect<HttpServerResponse.HttpServerResponse, import("effect/http/HttpBody").HttpBodyError, never>;
|
|
24
|
-
/**
|
|
25
|
-
* @deprecated A route mounted through `mountRoutes` fails with typed failures
|
|
26
|
-
* and lets `respond` answer them. Kept for a host's unmigrated routes and
|
|
27
|
-
* removed with the class tree.
|
|
28
|
-
*
|
|
29
|
-
* The answer to a request the route refused: a `400` for what the client sent
|
|
30
|
-
* wrong, the refusal's own status for a rule a save broke, a business-family
|
|
31
|
-
* failure's category status, and a `500` for anything else.
|
|
32
|
-
*/
|
|
33
|
-
export declare const invalid: (error: unknown, label: string, code: string) => Effect.Effect<HttpServerResponse.HttpServerResponse, import("effect/http/HttpBody").HttpBodyError, never>;
|
|
34
|
-
/**
|
|
35
|
-
* What a framework route's errors mean, while some still arrive as the old
|
|
36
|
-
* class tree: a typed failure passes through to `respond`, a refusal answers
|
|
37
|
-
* as its own problem body, an unreachable store becomes `Unavailable`, and
|
|
38
|
-
* anything else is a defect — the opaque `500`, logged where `respond`
|
|
39
|
-
* catches it.
|
|
40
|
-
*
|
|
41
|
-
* @param fallbackCode the code a domain error carrying none answers with.
|
|
42
|
-
*/
|
|
43
|
-
export declare const legacyAnswer: (fallbackCode: string) => (error: unknown) => Effect.Effect<HttpServerResponse.HttpServerResponse, EntifixFailure>;
|
|
44
|
-
//# sourceMappingURL=route-responses.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"route-responses.d.ts","sourceRoot":"","sources":["../src/route-responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,KAAK,cAAc,EAKpB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAEjD;;;;GAIG;AACH,qBAAa,kBAAkB;IAI3B,QAAQ,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG;IAChC,QAAQ,CAAC,IAAI,EAAE,MAAM;IACrB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM;IAL1B,QAAQ,CAAC,IAAI,wBAAwB;gBAG1B,MAAM,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,EACvB,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,MAAM,YAAA;CAE3B;AAED;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,GAAI,OAAO,OAAO,8GAIxC,CAAC;AASJ;;;;;;;;GAQG;AACH,eAAO,MAAM,OAAO,GAAI,OAAO,OAAO,EAAE,OAAO,MAAM,EAAE,MAAM,MAAM,8GA8BtC,CAAC;AAmC9B;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,GACtB,cAAc,MAAM,MAEnB,OAAO,OAAO,KACb,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,kBAAkB,EAAE,cAAc,CAezC,CAAC"}
|