@venizia/ignis-kernel 0.4.8-14 → 0.4.8-16
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/dist/esm/base/applications/artifact-index.d.ts +3 -3
- package/dist/esm/base/applications/artifact-index.js.map +1 -1
- package/dist/esm/base/applications/body-limit.js +1 -1
- package/dist/esm/base/applications/body-limit.js.map +1 -1
- package/dist/esm/base/applications/common/types/application.d.ts +2 -2
- package/dist/esm/base/applications/common/types/application.js.map +1 -1
- package/dist/esm/base/applications/common/types/middlewares.d.ts +2 -2
- package/dist/esm/base/applications/common/types/middlewares.js.map +1 -1
- package/dist/esm/base/applications/rest.js.map +1 -1
- package/dist/esm/base/auth/authenticate/common/types/jwt.d.ts +1 -1
- package/dist/esm/base/auth/authenticate/common/types/jwt.js.map +1 -1
- package/dist/esm/base/auth/authenticate/common/types/strategy.d.ts +2 -3
- package/dist/esm/base/auth/authenticate/common/types/strategy.js.map +1 -1
- package/dist/esm/base/auth/authorize/providers/request-domain.js +2 -1
- package/dist/esm/base/auth/authorize/providers/request-domain.js.map +1 -1
- package/dist/esm/base/controllers/common/types/route.d.ts +13 -4
- package/dist/esm/base/controllers/common/types/route.js.map +1 -1
- package/dist/esm/base/controllers/factory/controller.d.ts +3 -4
- package/dist/esm/base/controllers/factory/controller.js +0 -1
- package/dist/esm/base/controllers/factory/controller.js.map +1 -1
- package/dist/esm/base/controllers/factory/crud/abstract.d.ts +3 -4
- package/dist/esm/base/controllers/factory/crud/abstract.js.map +1 -1
- package/dist/esm/base/controllers/factory/index.d.ts +1 -0
- package/dist/esm/base/controllers/factory/index.js +1 -0
- package/dist/esm/base/controllers/factory/index.js.map +1 -1
- package/dist/esm/base/controllers/factory/injection.d.ts +38 -0
- package/dist/esm/base/controllers/factory/injection.js +54 -0
- package/dist/esm/base/controllers/factory/injection.js.map +1 -0
- package/dist/esm/base/controllers/rest/base.d.ts +3 -3
- package/dist/esm/base/controllers/rest/base.js.map +1 -1
- package/dist/esm/base/datasources/common/types.d.ts +2 -2
- package/dist/esm/base/datasources/common/types.js.map +1 -1
- package/dist/esm/base/datasources/root.d.ts +2 -2
- package/dist/esm/base/datasources/root.js.map +1 -1
- package/dist/esm/base/events/event-bus.js.map +1 -1
- package/dist/esm/base/metadata/index.d.ts +1 -1
- package/dist/esm/base/metadata/index.js +1 -1
- package/dist/esm/base/metadata/injectors.d.ts +1 -1
- package/dist/esm/base/metadata/persistents/datasource.d.ts +21 -0
- package/dist/esm/base/metadata/persistents/datasource.js +46 -0
- package/dist/esm/base/metadata/persistents/datasource.js.map +1 -0
- package/dist/esm/base/metadata/persistents/index.d.ts +5 -0
- package/dist/esm/base/metadata/persistents/index.js +5 -0
- package/dist/esm/base/metadata/persistents/index.js.map +1 -0
- package/dist/esm/base/metadata/persistents/model.d.ts +18 -0
- package/dist/esm/base/metadata/persistents/model.js +64 -0
- package/dist/esm/base/metadata/persistents/model.js.map +1 -0
- package/dist/esm/base/metadata/persistents/repository/index.d.ts +19 -0
- package/dist/esm/base/metadata/persistents/repository/index.js +32 -0
- package/dist/esm/base/metadata/persistents/repository/index.js.map +1 -0
- package/dist/esm/base/metadata/persistents/repository/injection.d.ts +15 -0
- package/dist/esm/base/metadata/persistents/repository/injection.js +64 -0
- package/dist/esm/base/metadata/persistents/repository/injection.js.map +1 -0
- package/dist/esm/base/metadata/persistents/repository/resolve.d.ts +15 -0
- package/dist/esm/base/metadata/persistents/repository/resolve.js +76 -0
- package/dist/esm/base/metadata/persistents/repository/resolve.js.map +1 -0
- package/dist/esm/base/metadata/persistents/repository/validate.d.ts +15 -0
- package/dist/esm/base/metadata/persistents/repository/validate.js +50 -0
- package/dist/esm/base/metadata/persistents/repository/validate.js.map +1 -0
- package/dist/esm/base/models/common/utilities.d.ts +1 -1
- package/dist/esm/base/repositories/common/types/options.d.ts +2 -2
- package/dist/esm/base/repositories/common/types/options.js.map +1 -1
- package/dist/esm/base/repositories/common/types/query.d.ts +6 -15
- package/dist/esm/base/repositories/common/types/query.js.map +1 -1
- package/dist/esm/base/repositories/query-schemas/index.js +7 -0
- package/dist/esm/base/repositories/query-schemas/index.js.map +1 -1
- package/dist/esm/helpers/inversion/common/types/model.d.ts +1 -1
- package/dist/esm/helpers/inversion/common/types/model.js.map +1 -1
- package/dist/esm/helpers/inversion/mixins/artifact.mixin.d.ts +3 -3
- package/dist/esm/helpers/inversion/mixins/controllers/controller.d.ts +3 -3
- package/dist/esm/helpers/inversion/mixins/controllers/grpc.d.ts +3 -3
- package/dist/esm/helpers/inversion/mixins/controllers/rest.d.ts +3 -3
- package/dist/esm/helpers/inversion/mixins/datasource.mixin.d.ts +3 -3
- package/dist/esm/helpers/inversion/mixins/model.mixin.d.ts +3 -3
- package/dist/esm/helpers/inversion/mixins/repository.mixin.d.ts +8 -8
- package/dist/esm/helpers/inversion/mixins/repository.mixin.js +5 -6
- package/dist/esm/helpers/inversion/mixins/repository.mixin.js.map +1 -1
- package/dist/esm/helpers/inversion/registry.d.ts +26 -26
- package/dist/esm/helpers/inversion/registry.js.map +1 -1
- package/dist/esm/helpers/singleton-realm.js +5 -4
- package/dist/esm/helpers/singleton-realm.js.map +1 -1
- package/dist/esm/metadata.d.ts +1 -1
- package/dist/esm/metadata.js +1 -1
- package/dist/esm/utilities/index.d.ts +1 -0
- package/dist/esm/utilities/index.js +1 -0
- package/dist/esm/utilities/index.js.map +1 -1
- package/dist/esm/utilities/toggle.utility.d.ts +22 -0
- package/dist/esm/utilities/toggle.utility.js +16 -0
- package/dist/esm/utilities/toggle.utility.js.map +1 -0
- package/package.json +5 -5
- package/dist/esm/base/metadata/persistents.d.ts +0 -55
- package/dist/esm/base/metadata/persistents.js +0 -303
- package/dist/esm/base/metadata/persistents.js.map +0 -1
|
@@ -1,13 +1,12 @@
|
|
|
1
1
|
import type { TContext } from '../../../../controllers/common/types/index.js';
|
|
2
2
|
import type { IdType } from '../../../../models/common/index.js';
|
|
3
|
-
import type { AnyObject } from '@venizia/ignis-helpers/common';
|
|
4
3
|
import type { Env, MiddlewareHandler } from 'hono';
|
|
5
4
|
import type { TChangePasswordRequest, TSignInRequest, TSignUpRequest } from '../../../models/requests/index.js';
|
|
6
5
|
import type { TAuthMode } from '../constants/index.js';
|
|
7
6
|
/** The authenticated identity a strategy returns and the request context stores. Carries at least `userId`. */
|
|
8
7
|
export interface IAuthUser {
|
|
9
8
|
userId: IdType;
|
|
10
|
-
[extra: string | symbol]:
|
|
9
|
+
[extra: string | symbol]: unknown;
|
|
11
10
|
}
|
|
12
11
|
/** A strategy that authenticates a request. `name` is the name it is registered under; `authenticate` returns the user or throws. */
|
|
13
12
|
export interface IAuthenticationStrategy<E extends Env = Env> {
|
|
@@ -21,7 +20,7 @@ export type TAuthenticateFn<RouteEnv extends Env = Env> = (opts: {
|
|
|
21
20
|
mode?: TAuthMode;
|
|
22
21
|
}) => MiddlewareHandler<RouteEnv>;
|
|
23
22
|
/** The service behind the auth controller routes. `getUserInformation` and `refreshToken` are optional. The type parameters set each route's request and response types. */
|
|
24
|
-
export interface IAuthService<E extends Env = Env, SIRQ extends TSignInRequest = TSignInRequest, SIRS =
|
|
23
|
+
export interface IAuthService<E extends Env = Env, SIRQ extends TSignInRequest = TSignInRequest, SIRS = Record<string, unknown>, SURQ extends TSignUpRequest = TSignUpRequest, SURS = Record<string, unknown>, CPRQ extends TChangePasswordRequest = TChangePasswordRequest, CPRS = Record<string, unknown>, UIRQ = Record<string, unknown>, UIRS = Record<string, unknown>, RTRS = Record<string, unknown>> {
|
|
25
24
|
signIn(context: TContext<E>, opts: SIRQ): Promise<SIRS>;
|
|
26
25
|
signUp(context: TContext<E>, opts: SURQ): Promise<SURS>;
|
|
27
26
|
changePassword(context: TContext<E>, opts: CPRQ): Promise<CPRS>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"strategy.js","sourceRoot":"","sources":["../../../../../../../src/base/auth/authenticate/common/types/strategy.ts"],"names":[],"mappings":"","sourcesContent":["import type { TContext } from '@/base/controllers/common/types';\nimport type { IdType } from '@/base/models/common';\nimport type {
|
|
1
|
+
{"version":3,"file":"strategy.js","sourceRoot":"","sources":["../../../../../../../src/base/auth/authenticate/common/types/strategy.ts"],"names":[],"mappings":"","sourcesContent":["import type { TContext } from '@/base/controllers/common/types';\nimport type { IdType } from '@/base/models/common';\nimport type { Env, MiddlewareHandler } from 'hono';\nimport type {\n TChangePasswordRequest,\n TSignInRequest,\n TSignUpRequest,\n} from '../../../models/requests';\nimport type { TAuthMode } from '../constants';\n\n/** The authenticated identity a strategy returns and the request context stores. Carries at least `userId`. */\nexport interface IAuthUser {\n userId: IdType;\n [extra: string | symbol]: unknown;\n}\n\n/** A strategy that authenticates a request. `name` is the name it is registered under; `authenticate` returns the user or throws. */\nexport interface IAuthenticationStrategy<E extends Env = Env> {\n name: string;\n authenticate(context: TContext<E, string>): Promise<IAuthUser>;\n}\n\n/** Builds the authentication middleware for the listed strategy names. */\nexport type TAuthenticateFn<RouteEnv extends Env = Env> = (opts: {\n strategies: string[];\n\n /** @default 'any' */\n mode?: TAuthMode;\n}) => MiddlewareHandler<RouteEnv>;\n\n/** The service behind the auth controller routes. `getUserInformation` and `refreshToken` are optional. The type parameters set each route's request and response types. */\nexport interface IAuthService<\n E extends Env = Env,\n // SignIn types\n SIRQ extends TSignInRequest = TSignInRequest,\n SIRS = Record<string, unknown>,\n // SignUp types\n SURQ extends TSignUpRequest = TSignUpRequest,\n SURS = Record<string, unknown>,\n // ChangePassword types\n CPRQ extends TChangePasswordRequest = TChangePasswordRequest,\n CPRS = Record<string, unknown>,\n // UserInformation types\n UIRQ = Record<string, unknown>,\n UIRS = Record<string, unknown>,\n // RefreshToken types\n RTRS = Record<string, unknown>,\n> {\n signIn(context: TContext<E>, opts: SIRQ): Promise<SIRS>;\n signUp(context: TContext<E>, opts: SURQ): Promise<SURS>;\n changePassword(context: TContext<E>, opts: CPRQ): Promise<CPRS>;\n getUserInformation?(context: TContext<E>, opts: UIRQ): Promise<UIRS>;\n refreshToken?(context: TContext<E>): Promise<RTRS>;\n}\n"]}
|
|
@@ -15,7 +15,8 @@ export class RequestDomainResolver {
|
|
|
15
15
|
return context.req.query(source.key) ?? null;
|
|
16
16
|
}
|
|
17
17
|
case AuthorizationDomainSources.CONTEXT: {
|
|
18
|
-
|
|
18
|
+
// A declarative key is a string read off the request, so it cannot satisfy `get`'s `keyof Variables` parameter.
|
|
19
|
+
const value = Reflect.apply(context.get, context, [source.key]);
|
|
19
20
|
return value == null ? null : String(value);
|
|
20
21
|
}
|
|
21
22
|
default: {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"request-domain.js","sourceRoot":"","sources":["../../../../../../src/base/auth/authorize/providers/request-domain.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,yBAAyB,EAAE,0BAA0B,EAAE,MAAM,qBAAqB,CAAC;AAO5F,kEAAkE;AAClE,MAAM,OAAO,qBAAqB;IAChC,yEAAyE;IACzE,MAAM,CAAC,eAAe,CAAC,IAGtB;QACC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QAEjC,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;YACpB,KAAK,0BAA0B,CAAC,KAAK,CAAC,CAAC,CAAC;gBACtC,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC;YAC/C,CAAC;YACD,KAAK,0BAA0B,CAAC,MAAM,CAAC,CAAC,CAAC;gBACvC,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC;YAChD,CAAC;YACD,KAAK,0BAA0B,CAAC,KAAK,CAAC,CAAC,CAAC;gBACtC,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC;YAC/C,CAAC;YACD,KAAK,0BAA0B,CAAC,OAAO,CAAC,CAAC,CAAC;gBACxC,MAAM,KAAK,
|
|
1
|
+
{"version":3,"file":"request-domain.js","sourceRoot":"","sources":["../../../../../../src/base/auth/authorize/providers/request-domain.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,yBAAyB,EAAE,0BAA0B,EAAE,MAAM,qBAAqB,CAAC;AAO5F,kEAAkE;AAClE,MAAM,OAAO,qBAAqB;IAChC,yEAAyE;IACzE,MAAM,CAAC,eAAe,CAAC,IAGtB;QACC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QAEjC,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;YACpB,KAAK,0BAA0B,CAAC,KAAK,CAAC,CAAC,CAAC;gBACtC,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC;YAC/C,CAAC;YACD,KAAK,0BAA0B,CAAC,MAAM,CAAC,CAAC,CAAC;gBACvC,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC;YAChD,CAAC;YACD,KAAK,0BAA0B,CAAC,KAAK,CAAC,CAAC,CAAC;gBACtC,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC;YAC/C,CAAC;YACD,KAAK,0BAA0B,CAAC,OAAO,CAAC,CAAC,CAAC;gBACxC,gHAAgH;gBAChH,MAAM,KAAK,GAAY,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;gBAEzE,OAAO,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC9C,CAAC;YACD,OAAO,CAAC,CAAC,CAAC;gBACR,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;IACH,CAAC;IAED,iMAAiM;IACjM,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,IAIjC;QACC,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QAExC,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;YACtC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;YAEhD,OAAO,QAAQ;gBACb,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;gBACxC,CAAC,CAAC,yBAAyB,CAAC,WAAW,CAAC;QAC5C,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,EAAE,GAAG,qBAAqB,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;YAEnF,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,yBAAyB,CAAC,WAAW,CAAC;QACvF,CAAC;QAED,MAAM,cAAc,GAAG,OAAO,EAAE,cAAc,IAAI,IAAI,CAAC;QAEvD,IAAI,cAAc,EAAE,CAAC;YACnB,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;YAEnD,OAAO,QAAQ;gBACb,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;gBACxC,CAAC,CAAC,yBAAyB,CAAC,WAAW,CAAC;QAC5C,CAAC;QAED,OAAO,yBAAyB,CAAC,WAAW,CAAC;IAC/C,CAAC;CACF","sourcesContent":["import type { TContext } from '@/base/controllers/common/types';\nimport type { TNullable } from '@venizia/ignis-helpers/common';\nimport type { Env } from 'hono';\nimport { AuthorizationDomainScopes, AuthorizationDomainSources } from '../common/constants';\nimport type {\n IAuthorizationDomainSource,\n IAuthorizationSpec,\n IAuthorizeOptions,\n} from '../common/types';\n\n/** Reads the domain of an authorization check off the request. */\nexport class RequestDomainResolver {\n /** Read a domain value from a declarative source on the Hono context. */\n static readDeclarative(opts: {\n source: IAuthorizationDomainSource;\n context: TContext<Env, string>;\n }): TNullable<string> {\n const { source, context } = opts;\n\n switch (source.from) {\n case AuthorizationDomainSources.PARAM: {\n return context.req.param(source.key) ?? null;\n }\n case AuthorizationDomainSources.HEADER: {\n return context.req.header(source.key) ?? null;\n }\n case AuthorizationDomainSources.QUERY: {\n return context.req.query(source.key) ?? null;\n }\n case AuthorizationDomainSources.CONTEXT: {\n // A declarative key is a string read off the request, so it cannot satisfy `get`'s `keyof Variables` parameter.\n const value: unknown = Reflect.apply(context.get, context, [source.key]);\n\n return value == null ? null : String(value);\n }\n default: {\n return null;\n }\n }\n }\n\n /** Resolve the request domain, precedence spec.domain (method | declarative) -> options.domainResolver -> SYSTEM_WIDE, as a casbin domain string (\"<type>_<id>\") or the SYSTEM_WIDE sentinel. */\n static async resolveRequestDomain(opts: {\n spec: IAuthorizationSpec;\n context: TContext<Env, string>;\n options: TNullable<IAuthorizeOptions>;\n }): Promise<string> {\n const { spec, context, options } = opts;\n\n if (typeof spec.domain === 'function') {\n const resolved = await spec.domain({ context });\n\n return resolved\n ? [resolved.type, resolved.id].join('_')\n : AuthorizationDomainScopes.SYSTEM_WIDE;\n }\n\n if (spec.domain) {\n const id = RequestDomainResolver.readDeclarative({ source: spec.domain, context });\n\n return id ? [spec.domain.type, id].join('_') : AuthorizationDomainScopes.SYSTEM_WIDE;\n }\n\n const globalResolver = options?.domainResolver ?? null;\n\n if (globalResolver) {\n const resolved = await globalResolver({ context });\n\n return resolved\n ? [resolved.type, resolved.id].join('_')\n : AuthorizationDomainScopes.SYSTEM_WIDE;\n }\n\n return AuthorizationDomainScopes.SYSTEM_WIDE;\n }\n}\n"]}
|
|
@@ -2,7 +2,6 @@ import type { TAuthMode, TAuthStrategy } from '../../../auth/authenticate/common
|
|
|
2
2
|
import type { IAuthorizationSpec } from '../../../auth/authorize/common/types/index.js';
|
|
3
3
|
import type { TAnyObjectSchema } from '../schema-builders.js';
|
|
4
4
|
import type { createRoute, RouteConfig as HonoRouteConfig, OpenAPIHono, z } from '@hono/zod-openapi';
|
|
5
|
-
import type { AnyType } from '@venizia/ignis-helpers/common';
|
|
6
5
|
import type { Env, Schema } from 'hono';
|
|
7
6
|
import type { TRouteHandler } from './context.js';
|
|
8
7
|
/** Registered route with its configuration and router instance. */
|
|
@@ -53,10 +52,17 @@ export type TResponseHeaderObject = {
|
|
|
53
52
|
/** OpenAPI response headers format */
|
|
54
53
|
export type TResponseHeaders = Record<string, TResponseHeaderObject>;
|
|
55
54
|
type TInferDistributive<S> = S extends z.ZodType ? z.infer<S> : never;
|
|
55
|
+
type TJsonSchemaOf<Response> = Response extends {
|
|
56
|
+
content: {
|
|
57
|
+
'application/json': {
|
|
58
|
+
schema: infer JsonSchema;
|
|
59
|
+
};
|
|
60
|
+
};
|
|
61
|
+
} ? JsonSchema : never;
|
|
56
62
|
/** The JSON response body type of a route config `R`: the union of the schemas under `application/json` across all its response codes. */
|
|
57
63
|
export type TResponseBodyOf<R extends {
|
|
58
|
-
responses:
|
|
59
|
-
}> = TInferDistributive<R['responses'][keyof R['responses']]
|
|
64
|
+
responses: object;
|
|
65
|
+
}> = TInferDistributive<TJsonSchemaOf<R['responses'][keyof R['responses']]>>;
|
|
60
66
|
/** What a CRUD route lets a caller override: auth, the request schemas (params, query, body, headers) and the response schema and headers. */
|
|
61
67
|
export type TCustomizableRouteConfig = TRouteAuthConfig & {
|
|
62
68
|
request?: {
|
|
@@ -88,7 +94,10 @@ export interface ICustomizableRoutes<RouteConfig extends TCustomizableRouteConfi
|
|
|
88
94
|
* The routes of a CRUD controller: only a listed route exists, as `true` (on, with its defaults) or a config
|
|
89
95
|
* (on, with overrides). `restoreById` and `restoreBy` are listed only for a repository that has both methods.
|
|
90
96
|
*/
|
|
91
|
-
export type TCrudRoutes<Repository extends object =
|
|
97
|
+
export type TCrudRoutes<Repository extends object = {
|
|
98
|
+
restoreById: unknown;
|
|
99
|
+
restoreBy: unknown;
|
|
100
|
+
}> = {
|
|
92
101
|
[Key in keyof ICustomizableRoutes]?: Key extends 'restoreById' | 'restoreBy' ? Repository extends {
|
|
93
102
|
restoreById: unknown;
|
|
94
103
|
restoreBy: unknown;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"route.js","sourceRoot":"","sources":["../../../../../../src/base/controllers/common/types/route.ts"],"names":[],"mappings":"","sourcesContent":["import type { TAuthMode, TAuthStrategy } from '@/base/auth/authenticate/common/constants';\nimport type { IAuthorizationSpec } from '@/base/auth/authorize/common/types';\nimport type { TAnyObjectSchema } from '@/base/controllers/common/schema-builders';\nimport type {\n createRoute,\n RouteConfig as HonoRouteConfig,\n OpenAPIHono,\n z,\n} from '@hono/zod-openapi';\nimport type {
|
|
1
|
+
{"version":3,"file":"route.js","sourceRoot":"","sources":["../../../../../../src/base/controllers/common/types/route.ts"],"names":[],"mappings":"","sourcesContent":["import type { TAuthMode, TAuthStrategy } from '@/base/auth/authenticate/common/constants';\nimport type { IAuthorizationSpec } from '@/base/auth/authorize/common/types';\nimport type { TAnyObjectSchema } from '@/base/controllers/common/schema-builders';\nimport type {\n createRoute,\n RouteConfig as HonoRouteConfig,\n OpenAPIHono,\n z,\n} from '@hono/zod-openapi';\nimport type { Env, Schema } from 'hono';\nimport type { TRouteHandler } from './context';\n\n/** Registered route with its configuration and router instance. */\nexport interface IDefineRouteOptions<\n RouteConfig extends HonoRouteConfig,\n RouteEnv extends Env = Env,\n RouteSchema extends Schema = {},\n BasePath extends string = '/',\n> {\n configs: ReturnType<typeof createRoute<string, RouteConfig>>;\n route: OpenAPIHono<RouteEnv, RouteSchema, BasePath>;\n}\n\n/** Fluent binding for two-step route registration: bindRoute({ configs }).to({ handler }). */\nexport interface IBindRouteOptions<\n RouteConfig extends HonoRouteConfig,\n RouteEnv extends Env = Env,\n RouteSchema extends Schema = {},\n BasePath extends string = '/',\n> {\n configs: RouteConfig;\n to: <ResponseType = unknown>(opts: {\n handler: TRouteHandler<ResponseType, RouteEnv>;\n }) => IDefineRouteOptions<RouteConfig, RouteEnv, RouteSchema, BasePath>;\n}\n\n/** Route configuration extended with optional authenticate and authorize fields. */\nexport interface IAuthRouteConfig extends HonoRouteConfig {\n authenticate?: { strategies?: TAuthStrategy[]; mode?: TAuthMode };\n authorize?: IAuthorizationSpec | IAuthorizationSpec[];\n}\n\n/** Per-route authentication config: { skip: true } or { strategies, mode }. */\nexport type TRouteAuthenticateConfig =\n | { skip: true }\n | { skip?: false; strategies?: TAuthStrategy[]; mode?: TAuthMode };\n\n/** Per-route authorization config: { skip: true }, single spec, or array of specs. */\nexport type TRouteAuthorizeConfig = { skip: true } | IAuthorizationSpec | IAuthorizationSpec[];\n\n/** Per-route auth config. Endpoint config takes precedence over controller-level config. */\nexport type TRouteAuthConfig = {\n authenticate?: TRouteAuthenticateConfig;\n authorize?: TRouteAuthorizeConfig;\n};\n\n/** OpenAPI response header object */\nexport type TResponseHeaderObject = {\n description?: string;\n schema: { type: 'string'; examples?: string[] };\n};\n\n/** OpenAPI response headers format */\nexport type TResponseHeaders = Record<string, TResponseHeaderObject>;\n\n// Response body types derived from route definitions; a distributive conditional applies z.infer to each schema of the union separately.\ntype TInferDistributive<S> = S extends z.ZodType ? z.infer<S> : never;\ntype TJsonSchemaOf<Response> = Response extends {\n content: { 'application/json': { schema: infer JsonSchema } };\n}\n ? JsonSchema\n : never;\n/** The JSON response body type of a route config `R`: the union of the schemas under `application/json` across all its response codes. */\nexport type TResponseBodyOf<R extends { responses: object }> = TInferDistributive<\n TJsonSchemaOf<R['responses'][keyof R['responses']]>\n>;\n\n/** What a CRUD route lets a caller override: auth, the request schemas (params, query, body, headers) and the response schema and headers. */\nexport type TCustomizableRouteConfig = TRouteAuthConfig & {\n request?: {\n params?: TAnyObjectSchema;\n query?: TAnyObjectSchema;\n body?: TAnyObjectSchema;\n headers?: TAnyObjectSchema;\n };\n response?: {\n schema?: z.ZodType;\n headers?: TResponseHeaders;\n };\n};\n\n/** Per-route configuration for CRUD controller endpoints (auth, request, response). */\nexport interface ICustomizableRoutes<\n RouteConfig extends TCustomizableRouteConfig = TCustomizableRouteConfig,\n> {\n count?: RouteConfig;\n find?: RouteConfig;\n findById?: RouteConfig;\n findOne?: RouteConfig;\n create?: RouteConfig;\n updateById?: RouteConfig;\n updateBy?: RouteConfig;\n deleteById?: RouteConfig;\n deleteBy?: RouteConfig;\n restoreById?: RouteConfig;\n restoreBy?: RouteConfig;\n}\n\n/**\n * The routes of a CRUD controller: only a listed route exists, as `true` (on, with its defaults) or a config\n * (on, with overrides). `restoreById` and `restoreBy` are listed only for a repository that has both methods.\n */\nexport type TCrudRoutes<Repository extends object = { restoreById: unknown; restoreBy: unknown }> =\n {\n [Key in keyof ICustomizableRoutes]?: Key extends 'restoreById' | 'restoreBy'\n ? Repository extends { restoreById: unknown; restoreBy: unknown }\n ? true | TCustomizableRouteConfig\n : never\n : true | TCustomizableRouteConfig;\n };\n"]}
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import type { AnyType } from '@venizia/ignis-helpers/common';
|
|
2
1
|
import type { AbstractRepository } from '../../repositories/index.js';
|
|
3
2
|
import type { IAuthorizationSpec } from '../../auth/authorize/common/types/index.js';
|
|
4
3
|
import type { TClass, ValueOrPromise } from '@venizia/ignis-helpers/common';
|
|
@@ -22,7 +21,7 @@ export declare class CrudControllerFactory extends BaseHelper {
|
|
|
22
21
|
repositoryName: string;
|
|
23
22
|
}): void;
|
|
24
23
|
static build<Repository extends TCrudRepositoryClass, RouteEnv extends Env = Env, RouteSchema extends Schema = {}, BasePath extends string = '/', ConfigurableOptions extends object = {}, TDataObject extends object = TRepositoryDataObject<InstanceType<Repository>>, TPersistObject extends object = TRepositoryPersistObject<InstanceType<Repository>>>(opts: ICrudControllerOptions<Repository>): {
|
|
25
|
-
new (repositoryInstance: AbstractRepository<TDataObject, TPersistObject
|
|
24
|
+
new (repositoryInstance: AbstractRepository<TDataObject, TPersistObject>): {
|
|
26
25
|
/** The routes of a generated controller come from `routes`; a subclass adds its own here. */
|
|
27
26
|
binding(): ValueOrPromise<void>;
|
|
28
27
|
/** Registers each listed CRUD route, after `binding()`: a custom static path is never taken by `/{id}`. */
|
|
@@ -96,8 +95,8 @@ export declare class CrudControllerFactory extends BaseHelper {
|
|
|
96
95
|
scope: string;
|
|
97
96
|
args: unknown;
|
|
98
97
|
task: () => Promise<R>;
|
|
99
|
-
}): Promise<
|
|
100
|
-
normalizeCountData<ResponseSchema
|
|
98
|
+
}): Promise<R>;
|
|
99
|
+
normalizeCountData<ResponseSchema, RequestContext extends import("../index.js").TRouteContext<RouteEnv> = import("../index.js").TRouteContext<RouteEnv>, ResponseData extends {
|
|
101
100
|
count: number;
|
|
102
101
|
data?: import("@venizia/ignis-helpers/common").TNullable<ResponseSchema>;
|
|
103
102
|
} = {
|
|
@@ -79,7 +79,6 @@ export class CrudControllerFactory extends BaseHelper {
|
|
|
79
79
|
serverStampedKeys: [...(settings?.properties?.stamped ?? AuditFields.SCHEME_SET)],
|
|
80
80
|
});
|
|
81
81
|
const controllerClass = class extends PersistableCrudController {
|
|
82
|
-
// Any extra options: a repository whose options narrow `IExtraOptions` (a typed transaction) must fit.
|
|
83
82
|
constructor(repositoryInstance) {
|
|
84
83
|
super({
|
|
85
84
|
scope: new.target.name,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"controller.js","sourceRoot":"","sources":["../../../../../src/base/controllers/factory/controller.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,oBAAoB,EAAE,MAAM,wCAAwC,CAAC;AAG9E,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAE1E,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEpE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AASnD,OAAO,EAAE,yBAAyB,EAAE,MAAM,QAAQ,CAAC;AACnD,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAEnD,6EAA6E;AAC7E,MAAM,OAAO,qBAAsB,SAAQ,UAAU;IACnD,0GAA0G;aAClF,gBAAW,GAAG;QACpC,QAAQ;QACR,YAAY;QACZ,UAAU;QACV,YAAY;QACZ,UAAU;QACV,aAAa;QACb,WAAW;KACH,CAAC;IAEX;QACE,KAAK,CAAC,EAAE,KAAK,EAAE,qBAAqB,CAAC,IAAI,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,2BAA2B,CAAC,IAIlC;QACC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC;QAErD,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,MAAM,QAAQ,CAAC;gBACb,OAAO,EAAE,IAAI,WAAW,8EAA8E;aACvG,CAAC,CAAC;QACL,CAAC;QAED,gBAAgB,CAAC,WAAW,EAAE,CAAC,iBAAiB,CAAC;YAC/C,MAAM;YACN,KAAK,EAAE,CAAC;YACR,QAAQ,EAAE;gBACR,GAAG,EAAE,WAAW,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,iBAAiB,CAAC,UAAU,EAAE,GAAG,EAAE,cAAc,EAAE,CAAC;gBACxF,KAAK,EAAE,CAAC;gBACR,UAAU,EAAE,KAAK;aAClB;SACF,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,KAAK,CAQV,IAAwC;QACxC,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC;QAE5E,qBAAqB,CAAC,gCAAgC,CAAC;YACrD,cAAc,EAAE,UAAU,CAAC,IAAI;YAC/B,SAAS;YACT,MAAM;SACP,CAAC,CAAC;QACH,qBAAqB,CAAC,4BAA4B,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,CAAC;QAE3E,MAAM,KAAK,GAAG,gBAAgB,CAAC,WAAW,EAAE,CAAC,oBAAoB,CAAC;YAChE,MAAM,EAAE,UAAU;SACnB,CAAC,EAAE,KAAK,CAAC;QAEV,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,QAAQ,CAAC;gBACb,OAAO,EAAE,yEAAyE,UAAU,CAAC,IAAI,2CAA2C;aAC7I,CAAC,CAAC;QACL,CAAC;QAED,MAAM,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;QACrD,MAAM,cAAc,GAAG,IAAI,WAAW,EAAE,CAAC;QACzC,MAAM,QAAQ,GAAG,gBAAgB,CAAC,WAAW,EAAE,CAAC,gBAAgB,CAAC;YAC/D,MAAM,EAAE,WAAW;SACpB,CAAC,EAAE,QAAQ,CAAC;QAEb,MAAM,gBAAgB,GAAG,mBAAmB,CAAC,4BAA4B,CAAC;YACxE,QAAQ,EAAE,QAAQ,CAAC,aAAa,IAAI,IAAI;YACxC,MAAM,EAAE,cAAc,CAAC,SAAS,EAAE;YAClC,YAAY;YACZ,SAAS;YACT,MAAM;YACN,MAAM,EAAE;gBACN,MAAM,EAAE,cAAc,CAAC,SAAS,CAAmB,EAAE,IAAI,EAAE,WAAW,CAAC,MAAM,EAAE,CAAC;gBAChF,MAAM,EAAE,cAAc,CAAC,SAAS,CAAmB,EAAE,IAAI,EAAE,WAAW,CAAC,MAAM,EAAE,CAAC;gBAChF,MAAM,EAAE,cAAc,CAAC,SAAS,CAAmB,EAAE,IAAI,EAAE,WAAW,CAAC,MAAM,EAAE,CAAC;aACjF;YACD,iBAAiB,EAAE,CAAC,GAAG,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,IAAI,WAAW,CAAC,UAAU,CAAC,CAAC;SAClF,CAAC,CAAC;QAEH,MAAM,eAAe,GAAG,KAAM,SAAQ,yBAQrC;YACC,uGAAuG;YACvG,YAAY,kBAA4E;gBACtF,KAAK,CAAC;oBACJ,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,IAAI;oBACtB,QAAQ,EAAE,QAAQ,CAAC,IAAI,IAAI,IAAI;oBAC/B,UAAU,EAAE,kBAAkB;oBAC9B,WAAW,EAAE,gBAAgB;iBAC9B,CAAC,CAAC;YACL,CAAC;YAED,6FAA6F;YACpF,OAAO,KAA0B,CAAC;YAE3C,2GAA2G;YAClG,iBAAiB;gBACxB,IAAI,gBAAgB,CAAC,KAAK,EAAE,CAAC;oBAC3B,IAAI,CAAC,WAAW,CAAC;wBACf,OAAO,EAAE,gBAAgB,CAAC,KAAK;wBAC/B,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;qBACpD,CAAC,CAAC;gBACL,CAAC;gBAED,IAAI,gBAAgB,CAAC,IAAI,EAAE,CAAC;oBAC1B,IAAI,CAAC,WAAW,CAAC;wBACf,OAAO,EAAE,gBAAgB,CAAC,IAAI;wBAC9B,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC;qBACnD,CAAC,CAAC;gBACL,CAAC;gBAED,IAAI,gBAAgB,CAAC,QAAQ,EAAE,CAAC;oBAC9B,IAAI,CAAC,WAAW,CAAC;wBACf,OAAO,EAAE,gBAAgB,CAAC,QAAQ;wBAClC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC;qBACtD,CAAC,CAAC;gBACL,CAAC;gBAED,IAAI,gBAAgB,CAAC,UAAU,EAAE,CAAC;oBAChC,IAAI,CAAC,WAAW,CAAC;wBACf,OAAO,EAAE,gBAAgB,CAAC,UAAU;wBACpC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;qBACvD,CAAC,CAAC;gBACL,CAAC;gBAED,IAAI,gBAAgB,CAAC,MAAM,EAAE,CAAC;oBAC5B,IAAI,CAAC,WAAW,CAAC;wBACf,OAAO,EAAE,gBAAgB,CAAC,MAAM;wBAChC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC;qBACrD,CAAC,CAAC;gBACL,CAAC;gBAED,IAAI,gBAAgB,CAAC,YAAY,EAAE,CAAC;oBAClC,IAAI,CAAC,WAAW,CAAC;wBACf,OAAO,EAAE,gBAAgB,CAAC,YAAY;wBACtC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,CAAC;qBACzD,CAAC,CAAC;gBACL,CAAC;gBAED,IAAI,gBAAgB,CAAC,SAAS,EAAE,CAAC;oBAC/B,IAAI,CAAC,WAAW,CAAC;wBACf,OAAO,EAAE,gBAAgB,CAAC,SAAS;wBACnC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;qBACvD,CAAC,CAAC;gBACL,CAAC;gBAED,IAAI,gBAAgB,CAAC,YAAY,EAAE,CAAC;oBAClC,IAAI,CAAC,WAAW,CAAC;wBACf,OAAO,EAAE,gBAAgB,CAAC,YAAY;wBACtC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,CAAC;qBACzD,CAAC,CAAC;gBACL,CAAC;gBAED,IAAI,gBAAgB,CAAC,SAAS,EAAE,CAAC;oBAC/B,IAAI,CAAC,WAAW,CAAC;wBACf,OAAO,EAAE,gBAAgB,CAAC,SAAS;wBACnC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;qBACvD,CAAC,CAAC;gBACL,CAAC;gBAED,IAAI,gBAAgB,CAAC,UAAU,EAAE,CAAC;oBAChC,IAAI,CAAC,WAAW,CAAC;wBACf,OAAO,EAAE,gBAAgB,CAAC,UAAU;wBACpC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,CAAC;qBACxD,CAAC,CAAC;gBACL,CAAC;gBAED,IAAI,gBAAgB,CAAC,aAAa,EAAE,CAAC;oBACnC,IAAI,CAAC,WAAW,CAAC;wBACf,OAAO,EAAE,gBAAgB,CAAC,aAAa;wBACvC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,CAAC;qBAC1D,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;SACF,CAAC;QAEF,qBAAqB,CAAC,2BAA2B,CAAC;YAChD,MAAM,EAAE,eAAe;YACvB,WAAW,EAAE,6BAA6B;YAC1C,cAAc,EAAE,UAAU,CAAC,IAAI;SAChC,CAAC,CAAC;QAEH,OAAO,eAAe,CAAC;IACzB,CAAC;IAED,iJAAiJ;IACzI,MAAM,CAAC,4BAA4B,CAAC,IAG3C;QACC,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QAEpC,MAAM,eAAe,GAAG,MAAM,EAAE,WAAW,KAAK,SAAS,IAAI,MAAM,EAAE,SAAS,KAAK,SAAS,CAAC;QAC7F,MAAM,YAAY,GAChB,OAAO,UAAU,CAAC,SAAS,CAAC,WAAW,KAAK,UAAU;YACtD,OAAO,UAAU,CAAC,SAAS,CAAC,SAAS,KAAK,UAAU,CAAC;QAEvD,IAAI,eAAe,IAAI,CAAC,YAAY,EAAE,CAAC;YACrC,MAAM,QAAQ,CAAC;gBACb,OAAO,EAAE,sHAAsH,UAAU,CAAC,IAAI,EAAE;aACjJ,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,YAAY,CAAC,IAAkC;QAC5D,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QAEtB,OAAO,aAAa,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,eAAe,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;IAClF,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,gCAAgC,CAAC,IAIvC;QACC,MAAM,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QAEnD,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;YACtB,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QACjE,MAAM,oBAAoB,GACxB,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,oBAAoB,CAAC,IAAI,CAAC,CAAC;QAEvF,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC1B,OAAO;QACT,CAAC;QAED,MAAM,SAAS,GAAG,qBAAqB,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;YAClE,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC;YAE7B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,OAAO,KAAK,CAAC;YACf,CAAC;YAED,OAAO,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,IAAI,KAAK,IAAI,IAAI,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,CAAC;QAC1F,CAAC,CAAC,CAAC;QAEH,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,OAAO;QACT,CAAC;QAED,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,qBAAqB,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/F,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,cAAc,IAAI,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE9E,MAAM,QAAQ,CAAC;YACb,OAAO,EAAE;gBACP,gGAAgG,cAAc,cAAc,KAAK,iBAAiB,SAAS,EAAE;gBAC7J,sEAAsE;gBACtE,0HAA0H;aAC3H,CAAC,IAAI,CAAC,KAAK,CAAC;SACd,CAAC,CAAC;IACL,CAAC","sourcesContent":["import type { AnyType } from '@venizia/ignis-helpers/common';\nimport type { AbstractRepository } from '@/base/repositories';\nimport { AuthorizationActions } from '@/base/auth/authorize/common/constants';\nimport type { IAuthorizationSpec } from '@/base/auth/authorize/common/types';\nimport type { AbstractEntity } from '@/base/models';\nimport { AuditFields, SchemaTypes } from '@/base/models/common/constants';\nimport type { TAnyObjectSchema } from '@/base/controllers/common/schema-builders';\nimport { BindingNamespaces } from '@/common/bindings';\nimport { BindingKeys, MetadataRegistry } from '@/helpers/inversion';\nimport type { TClass, ValueOrPromise } from '@venizia/ignis-helpers/common';\nimport { BaseHelper, getError } from '@venizia/ignis-helpers/core';\nimport { isClass } from '@venizia/ignis-inversion';\nimport type { Env, Schema } from 'hono';\nimport type {\n ICrudControllerOptions,\n TCrudRepositoryClass,\n TCrudRoutes,\n TRepositoryDataObject,\n TRepositoryPersistObject,\n} from '../common';\nimport { PersistableCrudController } from './crud';\nimport { RouteConfigResolver } from './definition';\n\n/** Factory for generating typed CRUD controllers from entity definitions. */\nexport class CrudControllerFactory extends BaseHelper {\n /** The generated routes that change data: the ones that must never be answered by a `read` permission. */\n private static readonly WRITE_VERBS = [\n 'create',\n 'updateById',\n 'updateBy',\n 'deleteById',\n 'deleteBy',\n 'restoreById',\n 'restoreBy',\n ] as const;\n\n constructor() {\n super({ scope: CrudControllerFactory.name });\n }\n\n /**\n * Injects `repositories.<repositoryName>` into constructor parameter 0 of a factory-generated\n * controller, so a subclass needs no constructor. Recorded as metadata rather than a parameter\n * decorator, which Bun drops in some configurations. A subclass that declares its own `@inject` at\n * index 0 wins, and a sibling subclass keeps the factory's key.\n */\n static registerRepositoryInjection(opts: {\n target: TClass<unknown>;\n factoryName: string;\n repositoryName: string;\n }): void {\n const { target, factoryName, repositoryName } = opts;\n\n if (!repositoryName) {\n throw getError({\n message: `[${factoryName}] Invalid repository name | repository.name must name the repository binding`,\n });\n }\n\n MetadataRegistry.getInstance().setInjectMetadata({\n target,\n index: 0,\n metadata: {\n key: BindingKeys.build({ namespace: BindingNamespaces.REPOSITORY, key: repositoryName }),\n index: 0,\n isOptional: false,\n },\n });\n }\n\n static build<\n Repository extends TCrudRepositoryClass,\n RouteEnv extends Env = Env,\n RouteSchema extends Schema = {},\n BasePath extends string = '/',\n ConfigurableOptions extends object = {},\n TDataObject extends object = TRepositoryDataObject<InstanceType<Repository>>,\n TPersistObject extends object = TRepositoryPersistObject<InstanceType<Repository>>,\n >(opts: ICrudControllerOptions<Repository>) {\n const { repository, authenticate, authorize, routes, isStrict = {} } = opts;\n\n CrudControllerFactory.assertWriteVerbsDeclareAuthorize({\n repositoryName: repository.name,\n authorize,\n routes,\n });\n CrudControllerFactory.assertRestoreRoutesSupported({ repository, routes });\n\n const model = MetadataRegistry.getInstance().getRepositoryBinding({\n target: repository,\n })?.model;\n\n if (!model) {\n throw getError({\n message: `[CrudControllerFactory.build] Cannot resolve the entity | repository: ${repository.name} | declare it with @repository({ model })`,\n });\n }\n\n const entityClass = isClass(model) ? model : model();\n const entityInstance = new entityClass();\n const settings = MetadataRegistry.getInstance().getModelMetadata({\n target: entityClass,\n })?.settings;\n\n const routeDefinitions = RouteConfigResolver.defineControllerRouteConfigs({\n isStrict: isStrict.requestSchema ?? true,\n idType: entityInstance.getIdType(),\n authenticate,\n authorize,\n routes,\n schema: {\n select: entityInstance.getSchema<TAnyObjectSchema>({ type: SchemaTypes.SELECT }),\n create: entityInstance.getSchema<TAnyObjectSchema>({ type: SchemaTypes.CREATE }),\n update: entityInstance.getSchema<TAnyObjectSchema>({ type: SchemaTypes.UPDATE }),\n },\n serverStampedKeys: [...(settings?.properties?.stamped ?? AuditFields.SCHEME_SET)],\n });\n\n const controllerClass = class extends PersistableCrudController<\n AbstractEntity<TAnyObjectSchema>,\n RouteEnv,\n RouteSchema,\n BasePath,\n ConfigurableOptions,\n TDataObject,\n TPersistObject\n > {\n // Any extra options: a repository whose options narrow `IExtraOptions` (a typed transaction) must fit.\n constructor(repositoryInstance: AbstractRepository<TDataObject, TPersistObject, AnyType>) {\n super({\n scope: new.target.name,\n isStrict: isStrict.path ?? true,\n repository: repositoryInstance,\n definitions: routeDefinitions,\n });\n }\n\n /** The routes of a generated controller come from `routes`; a subclass adds its own here. */\n override binding(): ValueOrPromise<void> {}\n\n /** Registers each listed CRUD route, after `binding()`: a custom static path is never taken by `/{id}`. */\n override bindDefaultRoutes(): ValueOrPromise<void> {\n if (routeDefinitions.COUNT) {\n this.defineRoute({\n configs: routeDefinitions.COUNT,\n handler: async (context) => this.count({ context }),\n });\n }\n\n if (routeDefinitions.FIND) {\n this.defineRoute({\n configs: routeDefinitions.FIND,\n handler: async (context) => this.find({ context }),\n });\n }\n\n if (routeDefinitions.FIND_ONE) {\n this.defineRoute({\n configs: routeDefinitions.FIND_ONE,\n handler: async (context) => this.findOne({ context }),\n });\n }\n\n if (routeDefinitions.FIND_BY_ID) {\n this.defineRoute({\n configs: routeDefinitions.FIND_BY_ID,\n handler: async (context) => this.findById({ context }),\n });\n }\n\n if (routeDefinitions.CREATE) {\n this.defineRoute({\n configs: routeDefinitions.CREATE,\n handler: async (context) => this.create({ context }),\n });\n }\n\n if (routeDefinitions.UPDATE_BY_ID) {\n this.defineRoute({\n configs: routeDefinitions.UPDATE_BY_ID,\n handler: async (context) => this.updateById({ context }),\n });\n }\n\n if (routeDefinitions.UPDATE_BY) {\n this.defineRoute({\n configs: routeDefinitions.UPDATE_BY,\n handler: async (context) => this.updateBy({ context }),\n });\n }\n\n if (routeDefinitions.DELETE_BY_ID) {\n this.defineRoute({\n configs: routeDefinitions.DELETE_BY_ID,\n handler: async (context) => this.deleteById({ context }),\n });\n }\n\n if (routeDefinitions.DELETE_BY) {\n this.defineRoute({\n configs: routeDefinitions.DELETE_BY,\n handler: async (context) => this.deleteBy({ context }),\n });\n }\n\n if (routeDefinitions.RESTORE_BY) {\n this.defineRoute({\n configs: routeDefinitions.RESTORE_BY,\n handler: async (context) => this.restoreBy({ context }),\n });\n }\n\n if (routeDefinitions.RESTORE_BY_ID) {\n this.defineRoute({\n configs: routeDefinitions.RESTORE_BY_ID,\n handler: async (context) => this.restoreById({ context }),\n });\n }\n }\n };\n\n CrudControllerFactory.registerRepositoryInjection({\n target: controllerClass,\n factoryName: 'CrudControllerFactory.build',\n repositoryName: repository.name,\n });\n\n return controllerClass;\n }\n\n /** A restore route needs a repository that has the restore methods; the types already refuse one, this is the backstop for an untyped caller. */\n private static assertRestoreRoutesSupported(opts: {\n repository: TCrudRepositoryClass;\n routes: TCrudRoutes | undefined;\n }): void {\n const { repository, routes } = opts;\n\n const isRestoreListed = routes?.restoreById !== undefined || routes?.restoreBy !== undefined;\n const isRestorable =\n typeof repository.prototype.restoreById === 'function' &&\n typeof repository.prototype.restoreBy === 'function';\n\n if (isRestoreListed && !isRestorable) {\n throw getError({\n message: `[CrudControllerFactory.build] a restore route needs a repository with both restoreById and restoreBy | repository: ${repository.name}`,\n });\n }\n }\n\n private static describeSpec(opts: { spec: IAuthorizationSpec }): string {\n const { spec } = opts;\n\n return `{ action: ${String(spec.action)}, resource: ${String(spec.resource)} }`;\n }\n\n /**\n * Refuses a CRUD controller that lists a write verb which would inherit a controller-level `authorize`\n * that is only a `read` permission: the verb would then answer to anyone who may read.\n *\n * A listed write verb is fine when it declares its own `authorize` (a spec, an array, or `{ skip: true }`) or\n * skips authentication. Only the literal action `read` is detected; a custom action name is the application's own\n * vocabulary. An array counts when every spec in it is `read`, since the specs of one route must all pass.\n */\n static assertWriteVerbsDeclareAuthorize(opts: {\n repositoryName: string;\n authorize: IAuthorizationSpec | IAuthorizationSpec[] | undefined;\n routes: TCrudRoutes | undefined;\n }): void {\n const { repositoryName, authorize, routes } = opts;\n\n if (authorize == null) {\n return;\n }\n\n const specs = Array.isArray(authorize) ? authorize : [authorize];\n const isReadOnlyPermission =\n specs.length > 0 && specs.every((spec) => spec.action === AuthorizationActions.READ);\n\n if (!isReadOnlyPermission) {\n return;\n }\n\n const offending = CrudControllerFactory.WRITE_VERBS.filter((verb) => {\n const route = routes?.[verb];\n\n if (route === undefined) {\n return false;\n }\n\n return route === true || (route.authenticate?.skip !== true && route.authorize == null);\n });\n\n if (offending.length === 0) {\n return;\n }\n\n const inherited = specs.map((spec) => CrudControllerFactory.describeSpec({ spec })).join(', ');\n const verbs = offending.map((verb) => `${repositoryName}.${verb}`).join(', ');\n\n throw getError({\n message: [\n `[CrudControllerFactory.build] Write routes would inherit a read-only authorize | repository: ${repositoryName} | routes: ${verbs} | inherited: ${inherited}`,\n 'Anyone allowed to read could then create, update, delete or restore.',\n 'Fix: declare routes.<verb>.authorize for each of them (a spec, an array or { skip: true }), or leave them out of routes.',\n ].join(' | '),\n });\n }\n}\n"]}
|
|
1
|
+
{"version":3,"file":"controller.js","sourceRoot":"","sources":["../../../../../src/base/controllers/factory/controller.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,wCAAwC,CAAC;AAG9E,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAE1E,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEpE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AASnD,OAAO,EAAE,yBAAyB,EAAE,MAAM,QAAQ,CAAC;AACnD,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAEnD,6EAA6E;AAC7E,MAAM,OAAO,qBAAsB,SAAQ,UAAU;IACnD,0GAA0G;aAClF,gBAAW,GAAG;QACpC,QAAQ;QACR,YAAY;QACZ,UAAU;QACV,YAAY;QACZ,UAAU;QACV,aAAa;QACb,WAAW;KACH,CAAC;IAEX;QACE,KAAK,CAAC,EAAE,KAAK,EAAE,qBAAqB,CAAC,IAAI,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,2BAA2B,CAAC,IAIlC;QACC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC;QAErD,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,MAAM,QAAQ,CAAC;gBACb,OAAO,EAAE,IAAI,WAAW,8EAA8E;aACvG,CAAC,CAAC;QACL,CAAC;QAED,gBAAgB,CAAC,WAAW,EAAE,CAAC,iBAAiB,CAAC;YAC/C,MAAM;YACN,KAAK,EAAE,CAAC;YACR,QAAQ,EAAE;gBACR,GAAG,EAAE,WAAW,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,iBAAiB,CAAC,UAAU,EAAE,GAAG,EAAE,cAAc,EAAE,CAAC;gBACxF,KAAK,EAAE,CAAC;gBACR,UAAU,EAAE,KAAK;aAClB;SACF,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,KAAK,CAQV,IAAwC;QACxC,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC;QAE5E,qBAAqB,CAAC,gCAAgC,CAAC;YACrD,cAAc,EAAE,UAAU,CAAC,IAAI;YAC/B,SAAS;YACT,MAAM;SACP,CAAC,CAAC;QACH,qBAAqB,CAAC,4BAA4B,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,CAAC;QAE3E,MAAM,KAAK,GAAG,gBAAgB,CAAC,WAAW,EAAE,CAAC,oBAAoB,CAAC;YAChE,MAAM,EAAE,UAAU;SACnB,CAAC,EAAE,KAAK,CAAC;QAEV,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,QAAQ,CAAC;gBACb,OAAO,EAAE,yEAAyE,UAAU,CAAC,IAAI,2CAA2C;aAC7I,CAAC,CAAC;QACL,CAAC;QAED,MAAM,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;QACrD,MAAM,cAAc,GAAG,IAAI,WAAW,EAAE,CAAC;QACzC,MAAM,QAAQ,GAAG,gBAAgB,CAAC,WAAW,EAAE,CAAC,gBAAgB,CAAC;YAC/D,MAAM,EAAE,WAAW;SACpB,CAAC,EAAE,QAAQ,CAAC;QAEb,MAAM,gBAAgB,GAAG,mBAAmB,CAAC,4BAA4B,CAAC;YACxE,QAAQ,EAAE,QAAQ,CAAC,aAAa,IAAI,IAAI;YACxC,MAAM,EAAE,cAAc,CAAC,SAAS,EAAE;YAClC,YAAY;YACZ,SAAS;YACT,MAAM;YACN,MAAM,EAAE;gBACN,MAAM,EAAE,cAAc,CAAC,SAAS,CAAmB,EAAE,IAAI,EAAE,WAAW,CAAC,MAAM,EAAE,CAAC;gBAChF,MAAM,EAAE,cAAc,CAAC,SAAS,CAAmB,EAAE,IAAI,EAAE,WAAW,CAAC,MAAM,EAAE,CAAC;gBAChF,MAAM,EAAE,cAAc,CAAC,SAAS,CAAmB,EAAE,IAAI,EAAE,WAAW,CAAC,MAAM,EAAE,CAAC;aACjF;YACD,iBAAiB,EAAE,CAAC,GAAG,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,IAAI,WAAW,CAAC,UAAU,CAAC,CAAC;SAClF,CAAC,CAAC;QAEH,MAAM,eAAe,GAAG,KAAM,SAAQ,yBAQrC;YACC,YAAY,kBAAmE;gBAC7E,KAAK,CAAC;oBACJ,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,IAAI;oBACtB,QAAQ,EAAE,QAAQ,CAAC,IAAI,IAAI,IAAI;oBAC/B,UAAU,EAAE,kBAAkB;oBAC9B,WAAW,EAAE,gBAAgB;iBAC9B,CAAC,CAAC;YACL,CAAC;YAED,6FAA6F;YACpF,OAAO,KAA0B,CAAC;YAE3C,2GAA2G;YAClG,iBAAiB;gBACxB,IAAI,gBAAgB,CAAC,KAAK,EAAE,CAAC;oBAC3B,IAAI,CAAC,WAAW,CAAC;wBACf,OAAO,EAAE,gBAAgB,CAAC,KAAK;wBAC/B,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;qBACpD,CAAC,CAAC;gBACL,CAAC;gBAED,IAAI,gBAAgB,CAAC,IAAI,EAAE,CAAC;oBAC1B,IAAI,CAAC,WAAW,CAAC;wBACf,OAAO,EAAE,gBAAgB,CAAC,IAAI;wBAC9B,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC;qBACnD,CAAC,CAAC;gBACL,CAAC;gBAED,IAAI,gBAAgB,CAAC,QAAQ,EAAE,CAAC;oBAC9B,IAAI,CAAC,WAAW,CAAC;wBACf,OAAO,EAAE,gBAAgB,CAAC,QAAQ;wBAClC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC;qBACtD,CAAC,CAAC;gBACL,CAAC;gBAED,IAAI,gBAAgB,CAAC,UAAU,EAAE,CAAC;oBAChC,IAAI,CAAC,WAAW,CAAC;wBACf,OAAO,EAAE,gBAAgB,CAAC,UAAU;wBACpC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;qBACvD,CAAC,CAAC;gBACL,CAAC;gBAED,IAAI,gBAAgB,CAAC,MAAM,EAAE,CAAC;oBAC5B,IAAI,CAAC,WAAW,CAAC;wBACf,OAAO,EAAE,gBAAgB,CAAC,MAAM;wBAChC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC;qBACrD,CAAC,CAAC;gBACL,CAAC;gBAED,IAAI,gBAAgB,CAAC,YAAY,EAAE,CAAC;oBAClC,IAAI,CAAC,WAAW,CAAC;wBACf,OAAO,EAAE,gBAAgB,CAAC,YAAY;wBACtC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,CAAC;qBACzD,CAAC,CAAC;gBACL,CAAC;gBAED,IAAI,gBAAgB,CAAC,SAAS,EAAE,CAAC;oBAC/B,IAAI,CAAC,WAAW,CAAC;wBACf,OAAO,EAAE,gBAAgB,CAAC,SAAS;wBACnC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;qBACvD,CAAC,CAAC;gBACL,CAAC;gBAED,IAAI,gBAAgB,CAAC,YAAY,EAAE,CAAC;oBAClC,IAAI,CAAC,WAAW,CAAC;wBACf,OAAO,EAAE,gBAAgB,CAAC,YAAY;wBACtC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,CAAC;qBACzD,CAAC,CAAC;gBACL,CAAC;gBAED,IAAI,gBAAgB,CAAC,SAAS,EAAE,CAAC;oBAC/B,IAAI,CAAC,WAAW,CAAC;wBACf,OAAO,EAAE,gBAAgB,CAAC,SAAS;wBACnC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;qBACvD,CAAC,CAAC;gBACL,CAAC;gBAED,IAAI,gBAAgB,CAAC,UAAU,EAAE,CAAC;oBAChC,IAAI,CAAC,WAAW,CAAC;wBACf,OAAO,EAAE,gBAAgB,CAAC,UAAU;wBACpC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,CAAC;qBACxD,CAAC,CAAC;gBACL,CAAC;gBAED,IAAI,gBAAgB,CAAC,aAAa,EAAE,CAAC;oBACnC,IAAI,CAAC,WAAW,CAAC;wBACf,OAAO,EAAE,gBAAgB,CAAC,aAAa;wBACvC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,CAAC;qBAC1D,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;SACF,CAAC;QAEF,qBAAqB,CAAC,2BAA2B,CAAC;YAChD,MAAM,EAAE,eAAe;YACvB,WAAW,EAAE,6BAA6B;YAC1C,cAAc,EAAE,UAAU,CAAC,IAAI;SAChC,CAAC,CAAC;QAEH,OAAO,eAAe,CAAC;IACzB,CAAC;IAED,iJAAiJ;IACzI,MAAM,CAAC,4BAA4B,CAAC,IAG3C;QACC,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QAEpC,MAAM,eAAe,GAAG,MAAM,EAAE,WAAW,KAAK,SAAS,IAAI,MAAM,EAAE,SAAS,KAAK,SAAS,CAAC;QAC7F,MAAM,YAAY,GAChB,OAAO,UAAU,CAAC,SAAS,CAAC,WAAW,KAAK,UAAU;YACtD,OAAO,UAAU,CAAC,SAAS,CAAC,SAAS,KAAK,UAAU,CAAC;QAEvD,IAAI,eAAe,IAAI,CAAC,YAAY,EAAE,CAAC;YACrC,MAAM,QAAQ,CAAC;gBACb,OAAO,EAAE,sHAAsH,UAAU,CAAC,IAAI,EAAE;aACjJ,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,YAAY,CAAC,IAAkC;QAC5D,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QAEtB,OAAO,aAAa,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,eAAe,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;IAClF,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,gCAAgC,CAAC,IAIvC;QACC,MAAM,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QAEnD,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;YACtB,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QACjE,MAAM,oBAAoB,GACxB,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,oBAAoB,CAAC,IAAI,CAAC,CAAC;QAEvF,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC1B,OAAO;QACT,CAAC;QAED,MAAM,SAAS,GAAG,qBAAqB,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;YAClE,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC;YAE7B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,OAAO,KAAK,CAAC;YACf,CAAC;YAED,OAAO,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,IAAI,KAAK,IAAI,IAAI,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,CAAC;QAC1F,CAAC,CAAC,CAAC;QAEH,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,OAAO;QACT,CAAC;QAED,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,qBAAqB,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/F,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,cAAc,IAAI,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE9E,MAAM,QAAQ,CAAC;YACb,OAAO,EAAE;gBACP,gGAAgG,cAAc,cAAc,KAAK,iBAAiB,SAAS,EAAE;gBAC7J,sEAAsE;gBACtE,0HAA0H;aAC3H,CAAC,IAAI,CAAC,KAAK,CAAC;SACd,CAAC,CAAC;IACL,CAAC","sourcesContent":["import type { AbstractRepository } from '@/base/repositories';\nimport { AuthorizationActions } from '@/base/auth/authorize/common/constants';\nimport type { IAuthorizationSpec } from '@/base/auth/authorize/common/types';\nimport type { AbstractEntity } from '@/base/models';\nimport { AuditFields, SchemaTypes } from '@/base/models/common/constants';\nimport type { TAnyObjectSchema } from '@/base/controllers/common/schema-builders';\nimport { BindingNamespaces } from '@/common/bindings';\nimport { BindingKeys, MetadataRegistry } from '@/helpers/inversion';\nimport type { TClass, ValueOrPromise } from '@venizia/ignis-helpers/common';\nimport { BaseHelper, getError } from '@venizia/ignis-helpers/core';\nimport { isClass } from '@venizia/ignis-inversion';\nimport type { Env, Schema } from 'hono';\nimport type {\n ICrudControllerOptions,\n TCrudRepositoryClass,\n TCrudRoutes,\n TRepositoryDataObject,\n TRepositoryPersistObject,\n} from '../common';\nimport { PersistableCrudController } from './crud';\nimport { RouteConfigResolver } from './definition';\n\n/** Factory for generating typed CRUD controllers from entity definitions. */\nexport class CrudControllerFactory extends BaseHelper {\n /** The generated routes that change data: the ones that must never be answered by a `read` permission. */\n private static readonly WRITE_VERBS = [\n 'create',\n 'updateById',\n 'updateBy',\n 'deleteById',\n 'deleteBy',\n 'restoreById',\n 'restoreBy',\n ] as const;\n\n constructor() {\n super({ scope: CrudControllerFactory.name });\n }\n\n /**\n * Injects `repositories.<repositoryName>` into constructor parameter 0 of a factory-generated\n * controller, so a subclass needs no constructor. Recorded as metadata rather than a parameter\n * decorator, which Bun drops in some configurations. A subclass that declares its own `@inject` at\n * index 0 wins, and a sibling subclass keeps the factory's key.\n */\n static registerRepositoryInjection(opts: {\n target: TClass<unknown>;\n factoryName: string;\n repositoryName: string;\n }): void {\n const { target, factoryName, repositoryName } = opts;\n\n if (!repositoryName) {\n throw getError({\n message: `[${factoryName}] Invalid repository name | repository.name must name the repository binding`,\n });\n }\n\n MetadataRegistry.getInstance().setInjectMetadata({\n target,\n index: 0,\n metadata: {\n key: BindingKeys.build({ namespace: BindingNamespaces.REPOSITORY, key: repositoryName }),\n index: 0,\n isOptional: false,\n },\n });\n }\n\n static build<\n Repository extends TCrudRepositoryClass,\n RouteEnv extends Env = Env,\n RouteSchema extends Schema = {},\n BasePath extends string = '/',\n ConfigurableOptions extends object = {},\n TDataObject extends object = TRepositoryDataObject<InstanceType<Repository>>,\n TPersistObject extends object = TRepositoryPersistObject<InstanceType<Repository>>,\n >(opts: ICrudControllerOptions<Repository>) {\n const { repository, authenticate, authorize, routes, isStrict = {} } = opts;\n\n CrudControllerFactory.assertWriteVerbsDeclareAuthorize({\n repositoryName: repository.name,\n authorize,\n routes,\n });\n CrudControllerFactory.assertRestoreRoutesSupported({ repository, routes });\n\n const model = MetadataRegistry.getInstance().getRepositoryBinding({\n target: repository,\n })?.model;\n\n if (!model) {\n throw getError({\n message: `[CrudControllerFactory.build] Cannot resolve the entity | repository: ${repository.name} | declare it with @repository({ model })`,\n });\n }\n\n const entityClass = isClass(model) ? model : model();\n const entityInstance = new entityClass();\n const settings = MetadataRegistry.getInstance().getModelMetadata({\n target: entityClass,\n })?.settings;\n\n const routeDefinitions = RouteConfigResolver.defineControllerRouteConfigs({\n isStrict: isStrict.requestSchema ?? true,\n idType: entityInstance.getIdType(),\n authenticate,\n authorize,\n routes,\n schema: {\n select: entityInstance.getSchema<TAnyObjectSchema>({ type: SchemaTypes.SELECT }),\n create: entityInstance.getSchema<TAnyObjectSchema>({ type: SchemaTypes.CREATE }),\n update: entityInstance.getSchema<TAnyObjectSchema>({ type: SchemaTypes.UPDATE }),\n },\n serverStampedKeys: [...(settings?.properties?.stamped ?? AuditFields.SCHEME_SET)],\n });\n\n const controllerClass = class extends PersistableCrudController<\n AbstractEntity<TAnyObjectSchema>,\n RouteEnv,\n RouteSchema,\n BasePath,\n ConfigurableOptions,\n TDataObject,\n TPersistObject\n > {\n constructor(repositoryInstance: AbstractRepository<TDataObject, TPersistObject>) {\n super({\n scope: new.target.name,\n isStrict: isStrict.path ?? true,\n repository: repositoryInstance,\n definitions: routeDefinitions,\n });\n }\n\n /** The routes of a generated controller come from `routes`; a subclass adds its own here. */\n override binding(): ValueOrPromise<void> {}\n\n /** Registers each listed CRUD route, after `binding()`: a custom static path is never taken by `/{id}`. */\n override bindDefaultRoutes(): ValueOrPromise<void> {\n if (routeDefinitions.COUNT) {\n this.defineRoute({\n configs: routeDefinitions.COUNT,\n handler: async (context) => this.count({ context }),\n });\n }\n\n if (routeDefinitions.FIND) {\n this.defineRoute({\n configs: routeDefinitions.FIND,\n handler: async (context) => this.find({ context }),\n });\n }\n\n if (routeDefinitions.FIND_ONE) {\n this.defineRoute({\n configs: routeDefinitions.FIND_ONE,\n handler: async (context) => this.findOne({ context }),\n });\n }\n\n if (routeDefinitions.FIND_BY_ID) {\n this.defineRoute({\n configs: routeDefinitions.FIND_BY_ID,\n handler: async (context) => this.findById({ context }),\n });\n }\n\n if (routeDefinitions.CREATE) {\n this.defineRoute({\n configs: routeDefinitions.CREATE,\n handler: async (context) => this.create({ context }),\n });\n }\n\n if (routeDefinitions.UPDATE_BY_ID) {\n this.defineRoute({\n configs: routeDefinitions.UPDATE_BY_ID,\n handler: async (context) => this.updateById({ context }),\n });\n }\n\n if (routeDefinitions.UPDATE_BY) {\n this.defineRoute({\n configs: routeDefinitions.UPDATE_BY,\n handler: async (context) => this.updateBy({ context }),\n });\n }\n\n if (routeDefinitions.DELETE_BY_ID) {\n this.defineRoute({\n configs: routeDefinitions.DELETE_BY_ID,\n handler: async (context) => this.deleteById({ context }),\n });\n }\n\n if (routeDefinitions.DELETE_BY) {\n this.defineRoute({\n configs: routeDefinitions.DELETE_BY,\n handler: async (context) => this.deleteBy({ context }),\n });\n }\n\n if (routeDefinitions.RESTORE_BY) {\n this.defineRoute({\n configs: routeDefinitions.RESTORE_BY,\n handler: async (context) => this.restoreBy({ context }),\n });\n }\n\n if (routeDefinitions.RESTORE_BY_ID) {\n this.defineRoute({\n configs: routeDefinitions.RESTORE_BY_ID,\n handler: async (context) => this.restoreById({ context }),\n });\n }\n }\n };\n\n CrudControllerFactory.registerRepositoryInjection({\n target: controllerClass,\n factoryName: 'CrudControllerFactory.build',\n repositoryName: repository.name,\n });\n\n return controllerClass;\n }\n\n /** A restore route needs a repository that has the restore methods; the types already refuse one, this is the backstop for an untyped caller. */\n private static assertRestoreRoutesSupported(opts: {\n repository: TCrudRepositoryClass;\n routes: TCrudRoutes | undefined;\n }): void {\n const { repository, routes } = opts;\n\n const isRestoreListed = routes?.restoreById !== undefined || routes?.restoreBy !== undefined;\n const isRestorable =\n typeof repository.prototype.restoreById === 'function' &&\n typeof repository.prototype.restoreBy === 'function';\n\n if (isRestoreListed && !isRestorable) {\n throw getError({\n message: `[CrudControllerFactory.build] a restore route needs a repository with both restoreById and restoreBy | repository: ${repository.name}`,\n });\n }\n }\n\n private static describeSpec(opts: { spec: IAuthorizationSpec }): string {\n const { spec } = opts;\n\n return `{ action: ${String(spec.action)}, resource: ${String(spec.resource)} }`;\n }\n\n /**\n * Refuses a CRUD controller that lists a write verb which would inherit a controller-level `authorize`\n * that is only a `read` permission: the verb would then answer to anyone who may read.\n *\n * A listed write verb is fine when it declares its own `authorize` (a spec, an array, or `{ skip: true }`) or\n * skips authentication. Only the literal action `read` is detected; a custom action name is the application's own\n * vocabulary. An array counts when every spec in it is `read`, since the specs of one route must all pass.\n */\n static assertWriteVerbsDeclareAuthorize(opts: {\n repositoryName: string;\n authorize: IAuthorizationSpec | IAuthorizationSpec[] | undefined;\n routes: TCrudRoutes | undefined;\n }): void {\n const { repositoryName, authorize, routes } = opts;\n\n if (authorize == null) {\n return;\n }\n\n const specs = Array.isArray(authorize) ? authorize : [authorize];\n const isReadOnlyPermission =\n specs.length > 0 && specs.every((spec) => spec.action === AuthorizationActions.READ);\n\n if (!isReadOnlyPermission) {\n return;\n }\n\n const offending = CrudControllerFactory.WRITE_VERBS.filter((verb) => {\n const route = routes?.[verb];\n\n if (route === undefined) {\n return false;\n }\n\n return route === true || (route.authenticate?.skip !== true && route.authorize == null);\n });\n\n if (offending.length === 0) {\n return;\n }\n\n const inherited = specs.map((spec) => CrudControllerFactory.describeSpec({ spec })).join(', ');\n const verbs = offending.map((verb) => `${repositoryName}.${verb}`).join(', ');\n\n throw getError({\n message: [\n `[CrudControllerFactory.build] Write routes would inherit a read-only authorize | repository: ${repositoryName} | routes: ${verbs} | inherited: ${inherited}`,\n 'Anyone allowed to read could then create, update, delete or restore.',\n 'Fix: declare routes.<verb>.authorize for each of them (a spec, an array or { skip: true }), or leave them out of routes.',\n ].join(' | '),\n });\n }\n}\n"]}
|
|
@@ -1,9 +1,8 @@
|
|
|
1
1
|
import type { AbstractEntity } from '../../../models/base.js';
|
|
2
2
|
import type { AbstractRepository } from '../../../repositories/index.js';
|
|
3
3
|
import type { TAnyObjectSchema } from '../../common/schema-builders.js';
|
|
4
|
-
import type { AnyType } from '@venizia/ignis-helpers/common';
|
|
5
4
|
import type { Env, Schema } from 'hono';
|
|
6
|
-
import type { TEntityDataObject, TEntityPersistObject, TRouteContext } from '../../common/index.js';
|
|
5
|
+
import type { IAuthRouteConfig, TEntityDataObject, TEntityPersistObject, TRouteContext } from '../../common/index.js';
|
|
7
6
|
import { BaseRestController } from '../../rest/base.js';
|
|
8
7
|
type TBulkWhereResolution<WhereType> = {
|
|
9
8
|
where: WhereType;
|
|
@@ -18,8 +17,8 @@ export declare abstract class AbstractCrudController<TEntity extends AbstractEnt
|
|
|
18
17
|
constructor(opts: {
|
|
19
18
|
scope: string;
|
|
20
19
|
isStrict?: boolean;
|
|
21
|
-
repository: AbstractRepository<TDataObject, TPersistObject
|
|
22
|
-
definitions:
|
|
20
|
+
repository: AbstractRepository<TDataObject, TPersistObject>;
|
|
21
|
+
definitions: Record<string, IAuthRouteConfig>;
|
|
23
22
|
});
|
|
24
23
|
/**
|
|
25
24
|
* Refuses (400) a filter the client sent when it names a field the model hides (`where`, `order`, an include scope).
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"abstract.js","sourceRoot":"","sources":["../../../../../../src/base/controllers/factory/crud/abstract.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"abstract.js","sourceRoot":"","sources":["../../../../../../src/base/controllers/factory/crud/abstract.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,IAAI,EAAE,MAAM,+BAA+B,CAAC;AAQrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAMrD,yRAAyR;AACzR,MAAM,OAAgB,sBAQpB,SAAQ,kBAAwE;IAGhF,YAAY,IAKX;QACC,KAAK,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QACtD,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAClC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;IACtC,CAAC;IAED;;;OAGG;IACH,mBAAmB,CAAC,IAEnB;QAEG,IAAI,CAAC,UACN,CAAC,mBAAmB,EAAE,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED,6FAA6F;IAC7F,cAAc,CAAC,IAA0D;QACvE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QAEhC,IAAI,CAAC,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9C,OAAO,OAAO,CAAC,IAAI,CACjB,EAAE,OAAO,EAAE,8CAA8C,EAAE,EAC3D,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CACjC,CAAC;QACJ,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,2GAA2G;IAC3G,gBAAgB,CAA2B,IAM1C;QACC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC;QAC9C,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,YAAY,IAAI,EAAE,CAAC;QAEnD,IAAI,SAAS,KAAK,SAAS,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YACtD,OAAO;gBACL,KAAK,EAAE,OAAO,CAAC,IAAI,CACjB,EAAE,OAAO,EAAE,6DAA6D,EAAE,EAC1E,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CACjC;aACF,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAG,SAAS,IAAI,QAAQ,CAAC;QAEpC,IAAI,CAAC,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9C,OAAO;gBACL,KAAK,EAAE,OAAO,CAAC,IAAI,CACjB,EAAE,OAAO,EAAE,8CAA8C,EAAE,EAC3D,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CACjC;aACF,CAAC;QACJ,CAAC;QAED,OAAO,EAAE,KAAK,EAAE,CAAC;IACnB,CAAC;CACF","sourcesContent":["import type { AbstractEntity } from '@/base/models/base';\nimport type { AbstractRepository } from '@/base/repositories';\nimport type { TAnyObjectSchema } from '@/base/controllers/common/schema-builders';\nimport { HTTP } from '@venizia/ignis-helpers/common';\nimport type { Env, Schema } from 'hono';\nimport type {\n IAuthRouteConfig,\n TEntityDataObject,\n TEntityPersistObject,\n TRouteContext,\n} from '../../common';\nimport { BaseRestController } from '../../rest/base';\n\ntype TBulkWhereResolution<WhereType> =\n | { where: WhereType; error?: undefined }\n | { where?: undefined; error: Response };\n\n/** Base tier of a generated CRUD controller - the repository handle; the response helpers (`respond`, `setListHeaders`) live on BaseRestController so hand-written controllers share them. Read and write verbs are layered on by ReadableCrudController / PersistableCrudController. */\nexport abstract class AbstractCrudController<\n TEntity extends AbstractEntity<TAnyObjectSchema> = AbstractEntity<TAnyObjectSchema>,\n RouteEnv extends Env = Env,\n RouteSchema extends Schema = {},\n BasePath extends string = '/',\n ConfigurableOptions extends object = {},\n TDataObject extends object = TEntityDataObject<TEntity>,\n TPersistObject extends object = TEntityPersistObject<TEntity>,\n> extends BaseRestController<RouteEnv, RouteSchema, BasePath, ConfigurableOptions> {\n repository: AbstractRepository<TDataObject, TPersistObject>;\n\n constructor(opts: {\n scope: string;\n isStrict?: boolean;\n repository: AbstractRepository<TDataObject, TPersistObject>;\n definitions: Record<string, IAuthRouteConfig>;\n }) {\n super({ scope: opts.scope, isStrict: opts.isStrict });\n this.repository = opts.repository;\n this.definitions = opts.definitions;\n }\n\n /**\n * Refuses (400) a filter the client sent when it names a field the model hides (`where`, `order`, an include scope).\n * The repository answers it; a stand-in that does not extend `AbstractRepository` has no hidden fields to hold the filter to.\n */\n assertRequestFilter(opts: {\n filter?: { where?: unknown; order?: unknown; include?: unknown };\n }): void {\n (\n this.repository as Partial<Pick<AbstractRepository<object>, 'assertRequestFilter'>>\n ).assertRequestFilter?.(opts);\n }\n\n /** 400 when a bulk operation is missing its `where` filter; undefined when it is present. */\n bulkWhereError(opts: { context: TRouteContext<RouteEnv>; where?: object }) {\n const { context, where } = opts;\n\n if (!where || Object.keys(where).length === 0) {\n return context.json(\n { message: 'where filter is required for bulk operations' },\n HTTP.ResultCodes.RS_4.BadRequest,\n );\n }\n\n return undefined;\n }\n\n /** Bulk `where` from the query or the JSON body (long id lists outgrow a URL). Both, or none, is a 400. */\n resolveBulkWhere<WhereType extends object>(opts: {\n context: TRouteContext<RouteEnv>;\n where?: {\n fromQuery?: WhereType;\n fromBody?: WhereType;\n };\n }): TBulkWhereResolution<WhereType> {\n const { context, where: whereSources } = opts;\n const { fromQuery, fromBody } = whereSources ?? {};\n\n if (fromQuery !== undefined && fromBody !== undefined) {\n return {\n error: context.json(\n { message: 'where given in both the query and the body - send it in one' },\n HTTP.ResultCodes.RS_4.BadRequest,\n ),\n };\n }\n\n const where = fromQuery ?? fromBody;\n\n if (!where || Object.keys(where).length === 0) {\n return {\n error: context.json(\n { message: 'where filter is required for bulk operations' },\n HTTP.ResultCodes.RS_4.BadRequest,\n ),\n };\n }\n\n return { where };\n }\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/base/controllers/factory/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC","sourcesContent":["export * from './controller';\nexport * from './crud';\nexport * from './definition';\n"]}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/base/controllers/factory/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC","sourcesContent":["export * from './controller';\nexport * from './crud';\nexport * from './definition';\nexport * from './injection';\n"]}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import type { TClass } from '@venizia/ignis-helpers/common';
|
|
2
|
+
/** What an options object declares: a name for each class its callbacks need. Classes only: a key or an optional dependency is not declared here. */
|
|
3
|
+
export type TInjectMap = Record<string, TClass<object>>;
|
|
4
|
+
/** What each callback receives: the same names, holding the instances the container resolved. */
|
|
5
|
+
export type TInjected<Inject extends TInjectMap> = {
|
|
6
|
+
[Name in keyof Inject]: InstanceType<Inject[Name]>;
|
|
7
|
+
};
|
|
8
|
+
/**
|
|
9
|
+
* Dependencies of a factory's callbacks. A factory takes `inject: { products: ProductRepository }`, records each class
|
|
10
|
+
* as a constructor parameter of the controller it generates, and hands the resolved instances to every callback as
|
|
11
|
+
* `injected`. The container resolves them once, when it builds the controller at boot, so a class that is not
|
|
12
|
+
* registered fails the boot and not a request. A callback never looks anything up in the container.
|
|
13
|
+
*/
|
|
14
|
+
export declare class Injection {
|
|
15
|
+
/**
|
|
16
|
+
* Records each declared class as constructor parameter `offset + n` of `target`: the metadata `@inject({ target })`
|
|
17
|
+
* writes, and the metadata `CrudControllerFactory.registerRepositoryInjection` writes for parameter 0. Recorded as
|
|
18
|
+
* metadata rather than a parameter decorator, which Bun drops in some configurations.
|
|
19
|
+
*/
|
|
20
|
+
static register(opts: {
|
|
21
|
+
target: TClass<unknown>;
|
|
22
|
+
inject: TInjectMap;
|
|
23
|
+
offset: number;
|
|
24
|
+
}): void;
|
|
25
|
+
/** The one trust boundary: the container hands instances positionally and untyped; this checks that every name got one. */
|
|
26
|
+
private static isComplete;
|
|
27
|
+
/**
|
|
28
|
+
* Zips the declared names with the instances the container passed to the constructor, in declaration order. A subclass
|
|
29
|
+
* with a constructor of its own must pass every argument on to `super`; one that does not is refused here, at boot.
|
|
30
|
+
*/
|
|
31
|
+
static collect<Inject extends TInjectMap>(opts: {
|
|
32
|
+
scope: string;
|
|
33
|
+
/** `undefined` when the options declare none: nothing is collected. */
|
|
34
|
+
inject: Inject | undefined;
|
|
35
|
+
instances: unknown[];
|
|
36
|
+
}): TInjected<Inject>;
|
|
37
|
+
}
|
|
38
|
+
//# sourceMappingURL=injection.d.ts.map
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
import { MetadataRegistry } from '../../../helpers/inversion/index.js';
|
|
2
|
+
import { HTTP } from '@venizia/ignis-helpers/common';
|
|
3
|
+
import { getError } from '@venizia/ignis-helpers/core';
|
|
4
|
+
/**
|
|
5
|
+
* Dependencies of a factory's callbacks. A factory takes `inject: { products: ProductRepository }`, records each class
|
|
6
|
+
* as a constructor parameter of the controller it generates, and hands the resolved instances to every callback as
|
|
7
|
+
* `injected`. The container resolves them once, when it builds the controller at boot, so a class that is not
|
|
8
|
+
* registered fails the boot and not a request. A callback never looks anything up in the container.
|
|
9
|
+
*/
|
|
10
|
+
export class Injection {
|
|
11
|
+
/**
|
|
12
|
+
* Records each declared class as constructor parameter `offset + n` of `target`: the metadata `@inject({ target })`
|
|
13
|
+
* writes, and the metadata `CrudControllerFactory.registerRepositoryInjection` writes for parameter 0. Recorded as
|
|
14
|
+
* metadata rather than a parameter decorator, which Bun drops in some configurations.
|
|
15
|
+
*/
|
|
16
|
+
static register(opts) {
|
|
17
|
+
const { target, inject, offset } = opts;
|
|
18
|
+
Object.values(inject).forEach((dependency, position) => {
|
|
19
|
+
const index = offset + position;
|
|
20
|
+
MetadataRegistry.getInstance().setInjectMetadata({
|
|
21
|
+
target,
|
|
22
|
+
index,
|
|
23
|
+
metadata: { target: dependency, index, isOptional: false },
|
|
24
|
+
});
|
|
25
|
+
});
|
|
26
|
+
}
|
|
27
|
+
/** The one trust boundary: the container hands instances positionally and untyped; this checks that every name got one. */
|
|
28
|
+
static isComplete(opts) {
|
|
29
|
+
return Object.keys(opts.inject ?? {}).every((name) => {
|
|
30
|
+
const instance = opts.injected[name];
|
|
31
|
+
return typeof instance === 'object' && instance !== null;
|
|
32
|
+
});
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* Zips the declared names with the instances the container passed to the constructor, in declaration order. A subclass
|
|
36
|
+
* with a constructor of its own must pass every argument on to `super`; one that does not is refused here, at boot.
|
|
37
|
+
*/
|
|
38
|
+
static collect(opts) {
|
|
39
|
+
const { scope, inject, instances } = opts;
|
|
40
|
+
const names = Object.keys(inject ?? {});
|
|
41
|
+
const candidate = {
|
|
42
|
+
inject,
|
|
43
|
+
injected: Object.fromEntries(names.map((name, position) => [name, instances[position]])),
|
|
44
|
+
};
|
|
45
|
+
if (!Injection.isComplete(candidate)) {
|
|
46
|
+
throw getError({
|
|
47
|
+
statusCode: HTTP.ResultCodes.RS_5.InternalServerError,
|
|
48
|
+
message: `[${scope}] A declared dependency was not injected | inject: ${names.join(', ')} | a subclass constructor must pass every argument on to super`,
|
|
49
|
+
});
|
|
50
|
+
}
|
|
51
|
+
return candidate.injected;
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
//# sourceMappingURL=injection.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"injection.js","sourceRoot":"","sources":["../../../../../src/base/controllers/factory/injection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,IAAI,EAAE,MAAM,+BAA+B,CAAC;AAErD,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAUvD;;;;;GAKG;AACH,MAAM,OAAO,SAAS;IACpB;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAqE;QACnF,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QAExC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,QAAQ,EAAE,EAAE;YACrD,MAAM,KAAK,GAAG,MAAM,GAAG,QAAQ,CAAC;YAEhC,gBAAgB,CAAC,WAAW,EAAE,CAAC,iBAAiB,CAAC;gBAC/C,MAAM;gBACN,KAAK;gBACL,QAAQ,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE;aAC3D,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,2HAA2H;IACnH,MAAM,CAAC,UAAU,CAA4B,IAGpD;QACC,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE;YACnD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAErC,OAAO,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,CAAC;QAC3D,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,OAAO,CAA4B,IAKzC;QACC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;QAC1C,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;QACxC,MAAM,SAAS,GAAG;YAChB,MAAM;YACN,QAAQ,EAAE,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;SACzF,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YACrC,MAAM,QAAQ,CAAC;gBACb,UAAU,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,mBAAmB;gBACrD,OAAO,EAAE,IAAI,KAAK,sDAAsD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,gEAAgE;aACzJ,CAAC,CAAC;QACL,CAAC;QAED,OAAO,SAAS,CAAC,QAAQ,CAAC;IAC5B,CAAC;CACF","sourcesContent":["import { MetadataRegistry } from '@/helpers/inversion';\nimport { HTTP } from '@venizia/ignis-helpers/common';\nimport type { TClass } from '@venizia/ignis-helpers/common';\nimport { getError } from '@venizia/ignis-helpers/core';\n\n/** What an options object declares: a name for each class its callbacks need. Classes only: a key or an optional dependency is not declared here. */\nexport type TInjectMap = Record<string, TClass<object>>;\n\n/** What each callback receives: the same names, holding the instances the container resolved. */\nexport type TInjected<Inject extends TInjectMap> = {\n [Name in keyof Inject]: InstanceType<Inject[Name]>;\n};\n\n/**\n * Dependencies of a factory's callbacks. A factory takes `inject: { products: ProductRepository }`, records each class\n * as a constructor parameter of the controller it generates, and hands the resolved instances to every callback as\n * `injected`. The container resolves them once, when it builds the controller at boot, so a class that is not\n * registered fails the boot and not a request. A callback never looks anything up in the container.\n */\nexport class Injection {\n /**\n * Records each declared class as constructor parameter `offset + n` of `target`: the metadata `@inject({ target })`\n * writes, and the metadata `CrudControllerFactory.registerRepositoryInjection` writes for parameter 0. Recorded as\n * metadata rather than a parameter decorator, which Bun drops in some configurations.\n */\n static register(opts: { target: TClass<unknown>; inject: TInjectMap; offset: number }): void {\n const { target, inject, offset } = opts;\n\n Object.values(inject).forEach((dependency, position) => {\n const index = offset + position;\n\n MetadataRegistry.getInstance().setInjectMetadata({\n target,\n index,\n metadata: { target: dependency, index, isOptional: false },\n });\n });\n }\n\n /** The one trust boundary: the container hands instances positionally and untyped; this checks that every name got one. */\n private static isComplete<Inject extends TInjectMap>(opts: {\n inject: Inject | undefined;\n injected: Record<string, unknown>;\n }): opts is { inject: Inject | undefined; injected: TInjected<Inject> } {\n return Object.keys(opts.inject ?? {}).every((name) => {\n const instance = opts.injected[name];\n\n return typeof instance === 'object' && instance !== null;\n });\n }\n\n /**\n * Zips the declared names with the instances the container passed to the constructor, in declaration order. A subclass\n * with a constructor of its own must pass every argument on to `super`; one that does not is refused here, at boot.\n */\n static collect<Inject extends TInjectMap>(opts: {\n scope: string;\n /** `undefined` when the options declare none: nothing is collected. */\n inject: Inject | undefined;\n instances: unknown[];\n }): TInjected<Inject> {\n const { scope, inject, instances } = opts;\n const names = Object.keys(inject ?? {});\n const candidate = {\n inject,\n injected: Object.fromEntries(names.map((name, position) => [name, instances[position]])),\n };\n\n if (!Injection.isComplete(candidate)) {\n throw getError({\n statusCode: HTTP.ResultCodes.RS_5.InternalServerError,\n message: `[${scope}] A declared dependency was not injected | inject: ${names.join(', ')} | a subclass constructor must pass every argument on to super`,\n });\n }\n\n return candidate.injected;\n }\n}\n"]}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { Hook, OpenAPIHono } from '@hono/zod-openapi';
|
|
2
2
|
import type { TDataRange } from '../../repositories/common/types/index.js';
|
|
3
|
-
import type {
|
|
3
|
+
import type { TNullable, ValueOrPromise } from '@venizia/ignis-helpers/common';
|
|
4
4
|
import type { Env, Schema } from 'hono';
|
|
5
5
|
import type { TResponseFormat } from '../common/constants.js';
|
|
6
6
|
import type { IAuthRouteConfig, IBindRouteOptions, IDefineRouteOptions, TRouteContext, TRouteHandler } from '../common/types/index.js';
|
|
@@ -13,9 +13,9 @@ export declare abstract class BaseRestController<RouteEnv extends Env = Env, Rou
|
|
|
13
13
|
scope: string;
|
|
14
14
|
args: unknown;
|
|
15
15
|
task: () => Promise<R>;
|
|
16
|
-
}): Promise<
|
|
16
|
+
}): Promise<R>;
|
|
17
17
|
/** Returns the full `{ count, data }` envelope, or just `data` when the client sent `x-request-count: false`; `X-Response-Count` is set either way. */
|
|
18
|
-
normalizeCountData<ResponseSchema
|
|
18
|
+
normalizeCountData<ResponseSchema, RequestContext extends TRouteContext<RouteEnv> = TRouteContext<RouteEnv>, ResponseData extends {
|
|
19
19
|
count: number;
|
|
20
20
|
data?: TNullable<ResponseSchema>;
|
|
21
21
|
} = {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"base.js","sourceRoot":"","sources":["../../../../../src/base/controllers/rest/base.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAGpE,OAAO,EAAE,IAAI,EAAE,MAAM,+BAA+B,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAE/E,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAStD,OAAO,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAC;AAEpD,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAE1C,2GAA2G;AAC3G,MAAM,OAAgB,kBAMpB,SAAQ,sBAMT;IACC,0FAA0F;IAC1F,OAAO,CAAI,IAA8D;QACvE,OAAO,kBAAkB,CAAC,kBAAkB,CAAC;YAC3C,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,KAAK,EAAE,OAAO;YACd,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,WAAW,EAAE,WAAW,IAAI,CAAC,KAAK,EAAE;YACpC,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC,CAAC;IACL,CAAC;IAED,uJAAuJ;IACvJ,kBAAkB,CAOhB,IAAwD;QACxD,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QAClC,MAAM,gBAAgB,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,IAAI,MAAM,CAAC;QACvF,MAAM,YAAY,GAAG,YAAY,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,gBAAgB,EAAE,CAAC,CAAC;QAEzE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE3E,IAAI,YAAY,EAAE,CAAC;YACjB,OAAO,OAAO,CAAC;QACjB,CAAC;QAED,OAAO,OAAO,CAAC,IAAI,CAAC;IACtB,CAAC;IAED,+FAA+F;IAC/F,kBAAkB,CAAC,IAA0C;QAC3D,OAAO,cAAc,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;IAC/F,CAAC;IA8CD,OAAO,CAAI,IAMV;QACC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QAExD,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,CAAC,MAAM,CACZ,IAAI,CAAC,OAAO,CAAC,aAAa,EAC1B,gBAAgB,CAAC,cAAc,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CACjE,CAAC;QACJ,CAAC;QAED,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;QAErD,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO,IAAI,CAAC,kBAAkB,CAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;QAC1D,CAAC;QAED,OAAO,IAAI,CAAC,gBAAgB,CAAI,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED,2GAA2G;IAC3G,KAAK,CAAC,gBAAgB,CAAI,IAIzB;QACC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QACzC,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,CAAC;YAClC,SAAS,EAAE,IAAI,CAAC,kBAAkB,CAAC,EAAE,OAAO,EAAE,CAAC;YAC/C,OAAO,EAAE,KAAK;SACf,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YACpB,OAAO,IAAI,CAAC,kBAAkB,CAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;QAC1D,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QAExE,+FAA+F;QAC/F,mGAAmG;QACnG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC3E,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAC7E,MAAM,YAAY,GAAG,YAAY,CAAC,SAAS,CAAC;YAC1C,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,IAAI,MAAM;SACrE,CAAC,CAAC;QAEH,OAAO,YAAY;YACjB,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE;YAC/D,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;IAC9C,CAAC;IAED,4UAA4U;IAC5U,cAAc,CACZ,IAGC;QAED,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QAChC,MAAM,KAAK,GACT,OAAO,IAAI,IAAI;YACb,CAAC,CAAC,IAAI,CAAC,KAAK;YACZ,CAAC,CAAC,gBAAgB,CAAC,cAAc,CAAC;gBAC9B,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,UAAU,EAAE,KAAK;gBACjB,KAAK,EAAE,IAAI,CAAC,KAAK;aAClB,CAAC,CAAC;QAET,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,gBAAgB,CAAC,cAAc,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;QAC9F,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;QACnE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;IACtE,CAAC;IAED,mPAAmP;IACnP,aAAa,CAAyB,IAAwD;QAC5F,OAAO,IAAI,CAAC,OAA0D,CAAC;IACzE,CAAC;IAED,uFAAuF;IACvF,SAAS,CAAuC,IAE/C;QACC,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,CAAc,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QAElF,OAAO;YACL,OAAO,EAAE,YAAY;YACrB,EAAE,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE;gBAClB,OAAO;oBACL,OAAO,EAAE,YAAY;oBACrB,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;iBAC1E,CAAC;YACJ,CAAC;SACF,CAAC;IACJ,CAAC;IAED,uEAAuE;IACvE,WAAW,CAA+D,IAIzE;QACC,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,CAAc,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QAElF,OAAO;YACL,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,YAAY,EACZ,IAAI,CAAC,aAAa,CAAe,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,EAC3D,IAAI,CAAC,IAAI,CACV;SACF,CAAC;IACJ,CAAC;IAED,sEAAsE;IACtE,cAAc,CAA+D,IAI5E;QACC,MAAM,YAAY,GAAG,IAAI,CAAC,kBAAkB,CAAc,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QAErF,OAAO;YACL,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,YAAY,EACZ,IAAI,CAAC,aAAa,CAAe,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,EAC3D,IAAI,CAAC,IAAI,CACV;SACF,CAAC;IACJ,CAAC;CACF","sourcesContent":["import type { Hook, OpenAPIHono } from '@hono/zod-openapi';\nimport { DataRangeUtility } from '@/base/repositories/common/types';\nimport type { TDataRange } from '@/base/repositories/common/types';\nimport type { AnyType, TNullable, ValueOrPromise } from '@venizia/ignis-helpers/common';\nimport { HTTP } from '@venizia/ignis-helpers/common';\nimport { PerformanceUtility, ParseUtility } from '@venizia/ignis-helpers/core';\nimport type { Env, Schema } from 'hono';\nimport { ResponseFormats } from '../common/constants';\nimport type { TResponseFormat } from '../common/constants';\nimport type {\n IAuthRouteConfig,\n IBindRouteOptions,\n IDefineRouteOptions,\n TRouteContext,\n TRouteHandler,\n} from '../common/types';\nimport { AbstractRestController } from './abstract';\nimport type { IRequestedExtra, TResponseExtra } from './extras';\nimport { ResponseExtras } from './extras';\n\n/** Recommended base class for REST controllers with concrete bindRoute and defineRoute implementations. */\nexport abstract class BaseRestController<\n RouteEnv extends Env = Env,\n RouteSchema extends Schema = {},\n BasePath extends string = '/',\n ConfigurableOptions extends object = {},\n Definitions extends Record<string, IAuthRouteConfig> = Record<string, IAuthRouteConfig>,\n> extends AbstractRestController<\n RouteEnv,\n RouteSchema,\n BasePath,\n ConfigurableOptions,\n Definitions\n> {\n /** Runs a handler task under performance measurement (fixed logger/level/description). */\n measure<R>(opts: { scope: string; args: unknown; task: () => Promise<R> }) {\n return PerformanceUtility.executeWithMeasure({\n logger: this.logger,\n level: 'debug',\n scope: opts.scope,\n description: `execute ${opts.scope}`,\n args: opts.args,\n task: opts.task,\n });\n }\n\n /** Returns the full `{ count, data }` envelope, or just `data` when the client sent `x-request-count: false`; `X-Response-Count` is set either way. */\n normalizeCountData<\n ResponseSchema extends AnyType,\n RequestContext extends TRouteContext<RouteEnv> = TRouteContext<RouteEnv>,\n ResponseData extends {\n count: number;\n data?: TNullable<ResponseSchema>;\n } = { count: number; data?: TNullable<ResponseSchema> },\n >(opts: { context: RequestContext; payload: ResponseData }) {\n const { context, payload } = opts;\n const requestCountData = context.req.header(HTTP.Headers.REQUEST_COUNT_DATA) ?? 'true';\n const useCountData = ParseUtility.toBoolean({ input: requestCountData });\n\n context.header(HTTP.Headers.RESPONSE_COUNT_DATA, payload.count.toString());\n\n if (useCountData) {\n return payload;\n }\n\n return payload.data;\n }\n\n /** `x-request-extra`, parsed: `name`, `-name` (a default switched off) and `name(key,key)`. */\n getRequestedExtras(opts: { context: TRouteContext<RouteEnv> }): Array<IRequestedExtra> {\n return ResponseExtras.parse({ header: opts.context.req.header(HTTP.Headers.REQUEST_EXTRA) });\n }\n\n /**\n * The one response call. Sets `X-Response-Format`, and with `range` (a list) also `Content-Range` -\n * `payload.count` is the rows of THIS response, never the total - then normalizes count/data per\n * the request-count header.\n *\n * `extra` offers figures beside the rows (see {@link TResponseExtra}): each runs when the client\n * names it in `x-request-extra`, or always when it is a default. When any runs, the body is\n * `{ data, extra }` (with `count` when it is requested); when none does, nothing is computed and the\n * body is what it would be without `extra`. A name the route does not offer is a 400 listing the\n * ones it does.\n */\n respond<R>(opts: {\n context: TRouteContext<RouteEnv>;\n format: TResponseFormat;\n payload: { count: number; data?: TNullable<R> };\n range?: TDataRange;\n extra?: never;\n }): R | { count: number; data?: TNullable<R> } | null | undefined;\n respond<R, Extra extends Record<string, TResponseExtra>>(opts: {\n context: TRouteContext<RouteEnv>;\n format: TResponseFormat;\n payload: { count: number; data?: TNullable<R> };\n range?: TDataRange;\n extra: Extra;\n }): Promise<\n | R\n | { count: number; data?: TNullable<R> }\n | {\n count?: number;\n data?: TNullable<R>;\n extra: Partial<Record<keyof Extra, unknown>>;\n }\n | null\n | undefined\n >;\n respond<R>(opts: {\n context: TRouteContext<RouteEnv>;\n format: TResponseFormat;\n payload: { count: number; data?: TNullable<R> };\n range?: TDataRange;\n extra?: Record<string, TResponseExtra>;\n }): ValueOrPromise<\n R | { count?: number; data?: TNullable<R>; extra?: Record<string, unknown> } | null | undefined\n >;\n respond<R>(opts: {\n context: TRouteContext<RouteEnv>;\n format: TResponseFormat;\n payload: { count: number; data?: TNullable<R> };\n range?: TDataRange;\n extra?: Record<string, TResponseExtra>;\n }) {\n const { context, format, payload, range, extra } = opts;\n\n if (range) {\n context.header(\n HTTP.Headers.CONTENT_RANGE,\n DataRangeUtility.toContentRange({ range, count: payload.count }),\n );\n }\n\n context.header(HTTP.Headers.RESPONSE_FORMAT, format);\n\n if (!extra) {\n return this.normalizeCountData<R>({ context, payload });\n }\n\n return this.respondWithExtra<R>({ context, payload, extra });\n }\n\n /** The `extra` half of `respond`: resolves what was asked against what is offered, runs it in parallel. */\n async respondWithExtra<R>(opts: {\n context: TRouteContext<RouteEnv>;\n payload: { count: number; data?: TNullable<R> };\n extra: Record<string, TResponseExtra>;\n }) {\n const { context, payload, extra } = opts;\n const plan = ResponseExtras.resolve({\n requested: this.getRequestedExtras({ context }),\n offered: extra,\n });\n\n if (plan.size === 0) {\n return this.normalizeCountData<R>({ context, payload });\n }\n\n const computed = await ResponseExtras.compute({ plan, offered: extra });\n\n // Rows still counted in the header; the body is an object, since an array cannot carry extras.\n // `x-response-extra` marks it, so a client unwraps `{ data, extra }` only when the server says so.\n context.header(HTTP.Headers.RESPONSE_COUNT_DATA, payload.count.toString());\n context.header(HTTP.Headers.RESPONSE_EXTRA, Object.keys(computed).join(','));\n const useCountData = ParseUtility.toBoolean({\n input: context.req.header(HTTP.Headers.REQUEST_COUNT_DATA) ?? 'true',\n });\n\n return useCountData\n ? { count: payload.count, data: payload.data, extra: computed }\n : { data: payload.data, extra: computed };\n }\n\n /** The list headers without the body, for a list whose body is not a `{ count, data }` envelope: `Content-Range`, `X-Response-Count` = rows in THIS response, `X-Response-Format: array`. Pass a `range`, or `offset` + `total` for an engine that reports those (a search page): the range is derived with the same inclusive-end rule. */\n setListHeaders(\n opts: { context: TRouteContext<RouteEnv>; count: number } & (\n | { range: TDataRange }\n | { offset: number; total: number }\n ),\n ) {\n const { context, count } = opts;\n const range =\n 'range' in opts\n ? opts.range\n : DataRangeUtility.buildDataRange({\n offset: opts.offset,\n dataLength: count,\n total: opts.total,\n });\n\n context.header(HTTP.Headers.CONTENT_RANGE, DataRangeUtility.toContentRange({ range, count }));\n context.header(HTTP.Headers.RESPONSE_COUNT_DATA, count.toString());\n context.header(HTTP.Headers.RESPONSE_FORMAT, ResponseFormats.ARRAY);\n }\n\n /** TRouteHandler's TRouteContext is a lightweight custom shape (different `json`/`req.valid` signatures) built on Hono's real Context, not a subtype of the RouteHandler `.openapi()` expects - genuinely different handler types bridged here. */\n toHonoHandler<ResponseType = unknown>(opts: { handler: TRouteHandler<ResponseType, RouteEnv> }) {\n return opts.handler as Parameters<OpenAPIHono<RouteEnv>['openapi']>[1];\n }\n\n /** Creates a fluent binding for registering a route (call .to() to attach handler). */\n bindRoute<RouteConfig extends IAuthRouteConfig>(opts: {\n configs: RouteConfig;\n }): IBindRouteOptions<RouteConfig, RouteEnv, RouteSchema, BasePath> {\n const routeConfigs = this.getRouteConfigs<RouteConfig>({ configs: opts.configs });\n\n return {\n configs: routeConfigs,\n to: ({ handler }) => {\n return {\n configs: routeConfigs,\n route: this.router.openapi(routeConfigs, this.toHonoHandler({ handler })),\n };\n },\n };\n }\n\n /** Defines and registers a route with its handler in a single call. */\n defineRoute<RouteConfig extends IAuthRouteConfig, ResponseType = unknown>(opts: {\n configs: RouteConfig;\n handler: TRouteHandler<ResponseType, RouteEnv>;\n hook?: Hook<any, RouteEnv, string, ValueOrPromise<any>>;\n }): IDefineRouteOptions<RouteConfig, RouteEnv, RouteSchema, BasePath> {\n const routeConfigs = this.getRouteConfigs<RouteConfig>({ configs: opts.configs });\n\n return {\n configs: routeConfigs,\n route: this.router.openapi(\n routeConfigs,\n this.toHonoHandler<ResponseType>({ handler: opts.handler }),\n opts.hook,\n ),\n };\n }\n\n /** Defines a JSX route that renders server-side HTML via c.html(). */\n defineJSXRoute<RouteConfig extends IAuthRouteConfig, ResponseType = unknown>(opts: {\n configs: RouteConfig;\n handler: TRouteHandler<ResponseType, RouteEnv>;\n hook?: Hook<any, RouteEnv, string, ValueOrPromise<any>>;\n }): IDefineRouteOptions<RouteConfig, RouteEnv, RouteSchema, BasePath> {\n const routeConfigs = this.getJSXRouteConfigs<RouteConfig>({ configs: opts.configs });\n\n return {\n configs: routeConfigs,\n route: this.router.openapi(\n routeConfigs,\n this.toHonoHandler<ResponseType>({ handler: opts.handler }),\n opts.hook,\n ),\n };\n }\n}\n"]}
|
|
1
|
+
{"version":3,"file":"base.js","sourceRoot":"","sources":["../../../../../src/base/controllers/rest/base.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAGpE,OAAO,EAAE,IAAI,EAAE,MAAM,+BAA+B,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAE/E,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAStD,OAAO,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAC;AAEpD,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAE1C,2GAA2G;AAC3G,MAAM,OAAgB,kBAMpB,SAAQ,sBAMT;IACC,0FAA0F;IAC1F,OAAO,CAAI,IAA8D;QACvE,OAAO,kBAAkB,CAAC,kBAAkB,CAAC;YAC3C,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,KAAK,EAAE,OAAO;YACd,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,WAAW,EAAE,WAAW,IAAI,CAAC,KAAK,EAAE;YACpC,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC,CAAC;IACL,CAAC;IAED,uJAAuJ;IACvJ,kBAAkB,CAOhB,IAAwD;QACxD,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QAClC,MAAM,gBAAgB,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,IAAI,MAAM,CAAC;QACvF,MAAM,YAAY,GAAG,YAAY,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,gBAAgB,EAAE,CAAC,CAAC;QAEzE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE3E,IAAI,YAAY,EAAE,CAAC;YACjB,OAAO,OAAO,CAAC;QACjB,CAAC;QAED,OAAO,OAAO,CAAC,IAAI,CAAC;IACtB,CAAC;IAED,+FAA+F;IAC/F,kBAAkB,CAAC,IAA0C;QAC3D,OAAO,cAAc,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;IAC/F,CAAC;IA8CD,OAAO,CAAI,IAMV;QACC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QAExD,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,CAAC,MAAM,CACZ,IAAI,CAAC,OAAO,CAAC,aAAa,EAC1B,gBAAgB,CAAC,cAAc,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CACjE,CAAC;QACJ,CAAC;QAED,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;QAErD,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO,IAAI,CAAC,kBAAkB,CAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;QAC1D,CAAC;QAED,OAAO,IAAI,CAAC,gBAAgB,CAAI,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED,2GAA2G;IAC3G,KAAK,CAAC,gBAAgB,CAAI,IAIzB;QACC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QACzC,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,CAAC;YAClC,SAAS,EAAE,IAAI,CAAC,kBAAkB,CAAC,EAAE,OAAO,EAAE,CAAC;YAC/C,OAAO,EAAE,KAAK;SACf,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YACpB,OAAO,IAAI,CAAC,kBAAkB,CAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;QAC1D,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QAExE,+FAA+F;QAC/F,mGAAmG;QACnG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC3E,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAC7E,MAAM,YAAY,GAAG,YAAY,CAAC,SAAS,CAAC;YAC1C,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,IAAI,MAAM;SACrE,CAAC,CAAC;QAEH,OAAO,YAAY;YACjB,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE;YAC/D,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;IAC9C,CAAC;IAED,4UAA4U;IAC5U,cAAc,CACZ,IAGC;QAED,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QAChC,MAAM,KAAK,GACT,OAAO,IAAI,IAAI;YACb,CAAC,CAAC,IAAI,CAAC,KAAK;YACZ,CAAC,CAAC,gBAAgB,CAAC,cAAc,CAAC;gBAC9B,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,UAAU,EAAE,KAAK;gBACjB,KAAK,EAAE,IAAI,CAAC,KAAK;aAClB,CAAC,CAAC;QAET,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,gBAAgB,CAAC,cAAc,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;QAC9F,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;QACnE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;IACtE,CAAC;IAED,mPAAmP;IACnP,aAAa,CAAyB,IAAwD;QAC5F,OAAO,IAAI,CAAC,OAA0D,CAAC;IACzE,CAAC;IAED,uFAAuF;IACvF,SAAS,CAAuC,IAE/C;QACC,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,CAAc,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QAElF,OAAO;YACL,OAAO,EAAE,YAAY;YACrB,EAAE,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE;gBAClB,OAAO;oBACL,OAAO,EAAE,YAAY;oBACrB,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;iBAC1E,CAAC;YACJ,CAAC;SACF,CAAC;IACJ,CAAC;IAED,uEAAuE;IACvE,WAAW,CAA+D,IAIzE;QACC,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,CAAc,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QAElF,OAAO;YACL,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,YAAY,EACZ,IAAI,CAAC,aAAa,CAAe,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,EAC3D,IAAI,CAAC,IAAI,CACV;SACF,CAAC;IACJ,CAAC;IAED,sEAAsE;IACtE,cAAc,CAA+D,IAI5E;QACC,MAAM,YAAY,GAAG,IAAI,CAAC,kBAAkB,CAAc,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QAErF,OAAO;YACL,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,YAAY,EACZ,IAAI,CAAC,aAAa,CAAe,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,EAC3D,IAAI,CAAC,IAAI,CACV;SACF,CAAC;IACJ,CAAC;CACF","sourcesContent":["import type { Hook, OpenAPIHono } from '@hono/zod-openapi';\nimport { DataRangeUtility } from '@/base/repositories/common/types';\nimport type { TDataRange } from '@/base/repositories/common/types';\nimport type { TNullable, ValueOrPromise } from '@venizia/ignis-helpers/common';\nimport { HTTP } from '@venizia/ignis-helpers/common';\nimport { PerformanceUtility, ParseUtility } from '@venizia/ignis-helpers/core';\nimport type { Env, Schema } from 'hono';\nimport { ResponseFormats } from '../common/constants';\nimport type { TResponseFormat } from '../common/constants';\nimport type {\n IAuthRouteConfig,\n IBindRouteOptions,\n IDefineRouteOptions,\n TRouteContext,\n TRouteHandler,\n} from '../common/types';\nimport { AbstractRestController } from './abstract';\nimport type { IRequestedExtra, TResponseExtra } from './extras';\nimport { ResponseExtras } from './extras';\n\n/** Recommended base class for REST controllers with concrete bindRoute and defineRoute implementations. */\nexport abstract class BaseRestController<\n RouteEnv extends Env = Env,\n RouteSchema extends Schema = {},\n BasePath extends string = '/',\n ConfigurableOptions extends object = {},\n Definitions extends Record<string, IAuthRouteConfig> = Record<string, IAuthRouteConfig>,\n> extends AbstractRestController<\n RouteEnv,\n RouteSchema,\n BasePath,\n ConfigurableOptions,\n Definitions\n> {\n /** Runs a handler task under performance measurement (fixed logger/level/description). */\n measure<R>(opts: { scope: string; args: unknown; task: () => Promise<R> }) {\n return PerformanceUtility.executeWithMeasure({\n logger: this.logger,\n level: 'debug',\n scope: opts.scope,\n description: `execute ${opts.scope}`,\n args: opts.args,\n task: opts.task,\n });\n }\n\n /** Returns the full `{ count, data }` envelope, or just `data` when the client sent `x-request-count: false`; `X-Response-Count` is set either way. */\n normalizeCountData<\n ResponseSchema,\n RequestContext extends TRouteContext<RouteEnv> = TRouteContext<RouteEnv>,\n ResponseData extends {\n count: number;\n data?: TNullable<ResponseSchema>;\n } = { count: number; data?: TNullable<ResponseSchema> },\n >(opts: { context: RequestContext; payload: ResponseData }) {\n const { context, payload } = opts;\n const requestCountData = context.req.header(HTTP.Headers.REQUEST_COUNT_DATA) ?? 'true';\n const useCountData = ParseUtility.toBoolean({ input: requestCountData });\n\n context.header(HTTP.Headers.RESPONSE_COUNT_DATA, payload.count.toString());\n\n if (useCountData) {\n return payload;\n }\n\n return payload.data;\n }\n\n /** `x-request-extra`, parsed: `name`, `-name` (a default switched off) and `name(key,key)`. */\n getRequestedExtras(opts: { context: TRouteContext<RouteEnv> }): Array<IRequestedExtra> {\n return ResponseExtras.parse({ header: opts.context.req.header(HTTP.Headers.REQUEST_EXTRA) });\n }\n\n /**\n * The one response call. Sets `X-Response-Format`, and with `range` (a list) also `Content-Range` -\n * `payload.count` is the rows of THIS response, never the total - then normalizes count/data per\n * the request-count header.\n *\n * `extra` offers figures beside the rows (see {@link TResponseExtra}): each runs when the client\n * names it in `x-request-extra`, or always when it is a default. When any runs, the body is\n * `{ data, extra }` (with `count` when it is requested); when none does, nothing is computed and the\n * body is what it would be without `extra`. A name the route does not offer is a 400 listing the\n * ones it does.\n */\n respond<R>(opts: {\n context: TRouteContext<RouteEnv>;\n format: TResponseFormat;\n payload: { count: number; data?: TNullable<R> };\n range?: TDataRange;\n extra?: never;\n }): R | { count: number; data?: TNullable<R> } | null | undefined;\n respond<R, Extra extends Record<string, TResponseExtra>>(opts: {\n context: TRouteContext<RouteEnv>;\n format: TResponseFormat;\n payload: { count: number; data?: TNullable<R> };\n range?: TDataRange;\n extra: Extra;\n }): Promise<\n | R\n | { count: number; data?: TNullable<R> }\n | {\n count?: number;\n data?: TNullable<R>;\n extra: Partial<Record<keyof Extra, unknown>>;\n }\n | null\n | undefined\n >;\n respond<R>(opts: {\n context: TRouteContext<RouteEnv>;\n format: TResponseFormat;\n payload: { count: number; data?: TNullable<R> };\n range?: TDataRange;\n extra?: Record<string, TResponseExtra>;\n }): ValueOrPromise<\n R | { count?: number; data?: TNullable<R>; extra?: Record<string, unknown> } | null | undefined\n >;\n respond<R>(opts: {\n context: TRouteContext<RouteEnv>;\n format: TResponseFormat;\n payload: { count: number; data?: TNullable<R> };\n range?: TDataRange;\n extra?: Record<string, TResponseExtra>;\n }) {\n const { context, format, payload, range, extra } = opts;\n\n if (range) {\n context.header(\n HTTP.Headers.CONTENT_RANGE,\n DataRangeUtility.toContentRange({ range, count: payload.count }),\n );\n }\n\n context.header(HTTP.Headers.RESPONSE_FORMAT, format);\n\n if (!extra) {\n return this.normalizeCountData<R>({ context, payload });\n }\n\n return this.respondWithExtra<R>({ context, payload, extra });\n }\n\n /** The `extra` half of `respond`: resolves what was asked against what is offered, runs it in parallel. */\n async respondWithExtra<R>(opts: {\n context: TRouteContext<RouteEnv>;\n payload: { count: number; data?: TNullable<R> };\n extra: Record<string, TResponseExtra>;\n }) {\n const { context, payload, extra } = opts;\n const plan = ResponseExtras.resolve({\n requested: this.getRequestedExtras({ context }),\n offered: extra,\n });\n\n if (plan.size === 0) {\n return this.normalizeCountData<R>({ context, payload });\n }\n\n const computed = await ResponseExtras.compute({ plan, offered: extra });\n\n // Rows still counted in the header; the body is an object, since an array cannot carry extras.\n // `x-response-extra` marks it, so a client unwraps `{ data, extra }` only when the server says so.\n context.header(HTTP.Headers.RESPONSE_COUNT_DATA, payload.count.toString());\n context.header(HTTP.Headers.RESPONSE_EXTRA, Object.keys(computed).join(','));\n const useCountData = ParseUtility.toBoolean({\n input: context.req.header(HTTP.Headers.REQUEST_COUNT_DATA) ?? 'true',\n });\n\n return useCountData\n ? { count: payload.count, data: payload.data, extra: computed }\n : { data: payload.data, extra: computed };\n }\n\n /** The list headers without the body, for a list whose body is not a `{ count, data }` envelope: `Content-Range`, `X-Response-Count` = rows in THIS response, `X-Response-Format: array`. Pass a `range`, or `offset` + `total` for an engine that reports those (a search page): the range is derived with the same inclusive-end rule. */\n setListHeaders(\n opts: { context: TRouteContext<RouteEnv>; count: number } & (\n | { range: TDataRange }\n | { offset: number; total: number }\n ),\n ) {\n const { context, count } = opts;\n const range =\n 'range' in opts\n ? opts.range\n : DataRangeUtility.buildDataRange({\n offset: opts.offset,\n dataLength: count,\n total: opts.total,\n });\n\n context.header(HTTP.Headers.CONTENT_RANGE, DataRangeUtility.toContentRange({ range, count }));\n context.header(HTTP.Headers.RESPONSE_COUNT_DATA, count.toString());\n context.header(HTTP.Headers.RESPONSE_FORMAT, ResponseFormats.ARRAY);\n }\n\n /** TRouteHandler's TRouteContext is a lightweight custom shape (different `json`/`req.valid` signatures) built on Hono's real Context, not a subtype of the RouteHandler `.openapi()` expects - genuinely different handler types bridged here. */\n toHonoHandler<ResponseType = unknown>(opts: { handler: TRouteHandler<ResponseType, RouteEnv> }) {\n return opts.handler as Parameters<OpenAPIHono<RouteEnv>['openapi']>[1];\n }\n\n /** Creates a fluent binding for registering a route (call .to() to attach handler). */\n bindRoute<RouteConfig extends IAuthRouteConfig>(opts: {\n configs: RouteConfig;\n }): IBindRouteOptions<RouteConfig, RouteEnv, RouteSchema, BasePath> {\n const routeConfigs = this.getRouteConfigs<RouteConfig>({ configs: opts.configs });\n\n return {\n configs: routeConfigs,\n to: ({ handler }) => {\n return {\n configs: routeConfigs,\n route: this.router.openapi(routeConfigs, this.toHonoHandler({ handler })),\n };\n },\n };\n }\n\n /** Defines and registers a route with its handler in a single call. */\n defineRoute<RouteConfig extends IAuthRouteConfig, ResponseType = unknown>(opts: {\n configs: RouteConfig;\n handler: TRouteHandler<ResponseType, RouteEnv>;\n hook?: Hook<any, RouteEnv, string, ValueOrPromise<any>>;\n }): IDefineRouteOptions<RouteConfig, RouteEnv, RouteSchema, BasePath> {\n const routeConfigs = this.getRouteConfigs<RouteConfig>({ configs: opts.configs });\n\n return {\n configs: routeConfigs,\n route: this.router.openapi(\n routeConfigs,\n this.toHonoHandler<ResponseType>({ handler: opts.handler }),\n opts.hook,\n ),\n };\n }\n\n /** Defines a JSX route that renders server-side HTML via c.html(). */\n defineJSXRoute<RouteConfig extends IAuthRouteConfig, ResponseType = unknown>(opts: {\n configs: RouteConfig;\n handler: TRouteHandler<ResponseType, RouteEnv>;\n hook?: Hook<any, RouteEnv, string, ValueOrPromise<any>>;\n }): IDefineRouteOptions<RouteConfig, RouteEnv, RouteSchema, BasePath> {\n const routeConfigs = this.getJSXRouteConfigs<RouteConfig>({ configs: opts.configs });\n\n return {\n configs: routeConfigs,\n route: this.router.openapi(\n routeConfigs,\n this.toHonoHandler<ResponseType>({ handler: opts.handler }),\n opts.hook,\n ),\n };\n }\n}\n"]}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { IConfigurable, TClass, TConstValue, ValueOrPromise } from '@venizia/ignis-helpers/common';
|
|
2
2
|
/** Names of the supported datasource drivers, split into relational and search sets. `isValid` checks a value against all of them. */
|
|
3
3
|
export declare class DataSourceDrivers {
|
|
4
4
|
static readonly NODE_POSTGRES = "node-postgres";
|
|
@@ -68,7 +68,7 @@ export type TDataSourceDriver = TConstValue<typeof DataSourceDrivers> | (string
|
|
|
68
68
|
* package into a bundle - a name string pulls nothing, and a bare side-effect import may be
|
|
69
69
|
* dropped. Untyped because `IRelationalDriver` lives under `connectors/`, off-limits to `base/`.
|
|
70
70
|
*/
|
|
71
|
-
export type TDataSourceDriverClass = TClass<
|
|
71
|
+
export type TDataSourceDriverClass = TClass<unknown>;
|
|
72
72
|
/** Loose schema record of a datasource; the default `Schema` type argument of `IDataSource`. */
|
|
73
73
|
export type TAnyDataSourceSchema = Record<string, any>;
|
|
74
74
|
/** Engine-neutral datasource contract - the root every connector family implements. */
|