@web-ts-toolkit/access-router 0.43.0 → 0.45.0

package/index.d.mts

@@ -1,7 +1,7 @@
 import mongoose, { Schema } from 'mongoose';
 import { Response, NextFunction, RequestHandler, Router } from 'express';
-import { a8 as GlobalOptions, R as DefaultModelRouterOptions, az as ModelRouterOptions, N as DataRouterOptions, Z as ExtendedDefaultModelRouterOptions, _ as ExtendedModelRouterOptions, Y as ExtendedDataRouterOptions, A as AccessRouterBaseRequest, aa as GuardHook, ay as ModelRequest, L as DataRequest, cG as DataService, $ as Filter, aI as Projection, bD as Sort, aF as Populate, cH as Service, cI as PublicService, cj as Validation, bu as RootRouterOptions } from './parsers-PMWujHUV.mjs';
-export { cJ as AccessRouterPermissionMap, cK as AccessRouterPermissions, c as AccessRouterRequest, d as AccessRouterRequestExtensions, l as AjvErrorObjectLike, m as AjvValidatorLike, n as ArkTypeErrorsLike, o as ArkTypeLike, a9 as GlobalPermissionValue, ad as IoTsContextEntryLike, ae as IoTsDecodeErrorLike, af as IoTsDecoderLike, ag as JoiSchemaLike, ah as JoiValidationErrorDetailLike, am as MaybePromise, an as ModelBaseFilterHook, ap as ModelDeleteHook, aq as ModelDocPermissionsHook, as as ModelDocumentHook, at as ModelHook, av as ModelIdentifierHook, aw as ModelListHook, ax as ModelOverrideFilterHook, aA as ModelValidateHook, cL as Permissions, a_ as RequestSchemaAdapter, a$ as RequestSchemaFailure, b0 as RequestSchemaIssue, b1 as RequestSchemaLike, b2 as RequestSchemaOptions, b3 as RequestSchemaResult, b4 as RequestSchemaSuccess, b5 as RequestSchemaValidator, bx as RouteGuardAccess, bF as StandardSchemaFailure, bG as StandardSchemaInferOutput, bH as StandardSchemaIssue, bI as StandardSchemaPathSegment, bJ as StandardSchemaResult, bK as StandardSchemaSuccess, bL as StandardSchemaV1, c0 as SuperstructFailureLike, c1 as SuperstructValidateLike, cd as ValibotIssueLike, ce as ValibotPathItemLike, cf as ValibotSafeParseLike, cg as ValibotSafeParseResult, cl as VineValidationErrorLike, cm as VineValidationMessageLike, cn as VineValidatorLike, co as YupSchemaLike, cp as YupValidationErrorLike, cq as defineRequestSchema, cr as fromAjv, cs as fromArkType, ct as fromIoTs, cu as fromJoi, cv as fromStandardSchema, cw as fromSuperstruct, cx as fromValibot, cy as fromVine, cz as fromYup, cA as fromZod } from './parsers-PMWujHUV.mjs';
+import { ag as GlobalOptions, Z as DefaultModelRouterOptions, aI as ModelRouterOptions, V as DataRouterOptions, a5 as ExtendedDefaultModelRouterOptions, a6 as ExtendedModelRouterOptions, a4 as ExtendedDataRouterOptions, A as AccessRouterBaseRequest, ai as GuardHook, aH as ModelRequest, T as DataRequest, cR as DataService, a7 as Filter, aS as Projection, bN as Sort, aP as Populate, cS as Service, cT as PublicService, cu as Validation, bE as RootRouterOptions } from './parsers-DppKW-Fd.mjs';
+export { cU as AccessRouterPermissionMap, cV as AccessRouterPermissions, c as AccessRouterRequest, d as AccessRouterRequestExtensions, l as AjvErrorObjectLike, n as AjvValidatorLike, o as ArkTypeErrorsLike, p as ArkTypeLike, ah as GlobalPermissionValue, al as IoTsContextEntryLike, am as IoTsDecodeErrorLike, an as IoTsDecoderLike, ao as JoiSchemaLike, ap as JoiValidationErrorDetailLike, av as MaybePromise, aw as ModelBaseFilterHook, ay as ModelDeleteHook, az as ModelDocPermissionsHook, aB as ModelDocumentHook, aC as ModelHook, aE as ModelIdentifierHook, aF as ModelListHook, aG as ModelOverrideFilterHook, aJ as ModelValidateHook, cW as Permissions, b8 as RequestSchemaAdapter, b9 as RequestSchemaFailure, ba as RequestSchemaIssue, bb as RequestSchemaLike, bc as RequestSchemaOptions, bd as RequestSchemaResult, be as RequestSchemaSuccess, bf as RequestSchemaValidator, bH as RouteGuardAccess, bP as StandardSchemaFailure, bQ as StandardSchemaInferOutput, bR as StandardSchemaIssue, bS as StandardSchemaPathSegment, bT as StandardSchemaResult, bU as StandardSchemaSuccess, bV as StandardSchemaV1, ca as SuperstructFailureLike, cb as SuperstructValidateLike, co as ValibotIssueLike, cp as ValibotPathItemLike, cq as ValibotSafeParseLike, cr as ValibotSafeParseResult, cw as VineValidationErrorLike, cx as VineValidationMessageLike, cy as VineValidatorLike, cz as YupSchemaLike, cA as YupValidationErrorLike, cB as defineRequestSchema, cC as fromAjv, cD as fromArkType, cE as fromIoTs, cF as fromJoi, cG as fromStandardSchema, cH as fromSuperstruct, cI as fromValibot, cJ as fromVine, cK as fromYup, cL as fromZod } from './parsers-DppKW-Fd.mjs';
 import JsonRouter from '@web-ts-toolkit/express-json-router';
 import 'zod';
 
@@ -103,9 +103,9 @@ declare class AccessRuntime {
     private readonly modelAtts;
     private readonly modelInstances;
     private readonly openApiRegistry;
-    registerModelInstance(modelName: string, model: mongoose.Model<unknown>): void;
+    registerModelInstance<TModel>(modelName: string, model: mongoose.Model<TModel>): void;
     hasModelInstance(modelName: string): boolean;
-    getModelInstance(modelName: string): mongoose.Model<unknown> | null;
+    getModelInstance<TModel = unknown>(modelName: string): mongoose.Model<TModel> | null;
     registerOpenApiRoute(route: OpenApiRouteDescriptor): void;
     /**
      * Enable strict OpenAPI collision detection for the remainder of this
@@ -177,6 +177,7 @@ declare class AccessRuntime {
     setDataOptions<TData = unknown>(dataName: string, options: DataRouterOptions<TData>): void;
     setDataOption<K extends keyof DataRouterOptions<TData>, TData = unknown>(dataName: string, key: K, value: DataRouterOptions<TData>[K]): void;
     getDataOptions<TData = unknown>(dataName: string): DataRouterOptions<TData>;
+    getDataSnapshot<TData = unknown>(dataName: string): readonly TData[];
     getDataOption<K extends keyof DataRouterOptions<TData>, TData = unknown>(dataName: string, key: K | string, defaultValue?: DataRouterOptions<TData>[K]): DataRouterOptions<TData>[K];
     getExactDataOption<K extends keyof ExtendedDataRouterOptions<TData>, TData = unknown>(dataName: string, key: K | string): ExtendedDataRouterOptions<TData>[K];
     getDataNames(): string[];
@@ -228,6 +229,11 @@ declare class DataRouter<TData = unknown> {
     permissionSchema: SetTargetOption$1<DataRouter<TData>, DataRouterOptions<TData>['permissionSchema']>;
     operationAccess: SetTargetOption$1<DataRouter<TData>, DataRouterOptions<TData>['operationAccess']>;
     baseFilter: SetTargetOption$1<DataRouter<TData>, DataRouterOptions<TData>['baseFilter']>;
+    /**
+     * Trusted filter replacements applied before base-filter composition.
+     * They may replace ordinary filters, but cannot replace an existing `false` denial.
+     * Returning `false` denies the transaction.
+     */
     overrideFilter: SetTargetOption$1<DataRouter<TData>, DataRouterOptions<TData>['overrideFilter']>;
     decorate: SetTargetOption$1<DataRouter<TData>, DataRouterOptions<TData>['decorate']>;
     decorateAll: SetTargetOption$1<DataRouter<TData>, DataRouterOptions<TData>['decorateAll']>;
@@ -281,7 +287,7 @@ declare class ModelRouter<TModel = unknown> {
     readonly options: ModelRouterOptions<TModel>;
     readonly fullBasePath: string;
     constructor(modelName: string, initialOptions: ModelRouterOptions<TModel>, runtime?: AccessRuntime);
-    static fromModel<TModel = unknown>(model: mongoose.Model<unknown>, initialOptions: ModelRouterOptions<TModel>, runtime?: AccessRuntime): ModelRouter<TModel>;
+    static fromModel<TModel>(model: mongoose.Model<TModel>, initialOptions: ModelRouterOptions<TModel>, runtime?: AccessRuntime): ModelRouter<TModel>;
     private getRequestSchema;
     getService(req: ModelRequest): Service<TModel>;
     getPublicService(req: ModelRequest): PublicService<TModel>;
@@ -326,7 +332,9 @@ declare class ModelRouter<TModel = unknown> {
      */
     baseFilter: SetTargetOption<ModelRouter<TModel>, ModelRouterOptions<TModel>['baseFilter']>;
     /**
-     * The override filter definitions applied in every query transaction.
+     * Trusted filter replacements applied before base-filter composition.
+     * They may replace ordinary filters, but cannot replace an existing `false` denial.
+     * Returning `false` denies the transaction.
      * @operation `list`, `read`, `update`, `delete`
      */
     overrideFilter: SetTargetOption<ModelRouter<TModel>, ModelRouterOptions<TModel>['overrideFilter']>;
@@ -517,9 +525,9 @@ declare const getModelOptions: <TModel = unknown>(modelName: string) => ModelRou
 declare const getModelOption: <K extends keyof ExtendedModelRouterOptions<TModel>, TModel = unknown>(modelName: string, key: K | string, defaultValue?: ExtendedModelRouterOptions<TModel>[K]) => ExtendedModelRouterOptions<TModel>[K];
 declare const getModelNames: () => string[];
 declare const getModelJsonSchema: (modelName: string) => Record<string, unknown>;
-declare const registerModelInstance: (modelName: string, model: mongoose.Model<unknown>) => void;
+declare const registerModelInstance: <TModel>(modelName: string, model: mongoose.Model<TModel>) => void;
 declare const hasModelInstance: (modelName: string) => boolean;
-declare const getModelInstance: (modelName: string) => mongoose.Model<unknown> | null;
+declare const getModelInstance: <TModel = unknown>(modelName: string) => mongoose.Model<TModel> | null;
 
 declare const setDefaultModelOptions: (options: DefaultModelRouterOptions) => void;
 declare const setDefaultModelOption: <K extends keyof ExtendedDefaultModelRouterOptions>(key: K, value: ExtendedDefaultModelRouterOptions[K]) => void;
@@ -590,9 +598,9 @@ interface Wtt {
     setDefaultModelOption: typeof setDefaultModelOption;
     getDefaultModelOptions: typeof getDefaultModelOptions;
     getDefaultModelOption: typeof getDefaultModelOption;
-    registerModelInstance: (modelName: string, model: mongoose.Model<unknown>) => void;
+    registerModelInstance: <TModel>(modelName: string, model: mongoose.Model<TModel>) => void;
     hasModelInstance: (modelName: string) => boolean;
-    getModelInstance: (modelName: string) => mongoose.Model<unknown> | null;
+    getModelInstance: <TModel = unknown>(modelName: string) => mongoose.Model<TModel> | null;
     RootRouter: typeof RootRouter;
     ModelRouter: typeof ModelRouter;
     DataRouter: typeof DataRouter;

package/index.d.ts

@@ -1,7 +1,7 @@
 import mongoose, { Schema } from 'mongoose';
 import { Response, NextFunction, RequestHandler, Router } from 'express';
-import { a8 as GlobalOptions, R as DefaultModelRouterOptions, az as ModelRouterOptions, N as DataRouterOptions, Z as ExtendedDefaultModelRouterOptions, _ as ExtendedModelRouterOptions, Y as ExtendedDataRouterOptions, A as AccessRouterBaseRequest, aa as GuardHook, ay as ModelRequest, L as DataRequest, cG as DataService, $ as Filter, aI as Projection, bD as Sort, aF as Populate, cH as Service, cI as PublicService, cj as Validation, bu as RootRouterOptions } from './parsers-PMWujHUV.js';
-export { cJ as AccessRouterPermissionMap, cK as AccessRouterPermissions, c as AccessRouterRequest, d as AccessRouterRequestExtensions, l as AjvErrorObjectLike, m as AjvValidatorLike, n as ArkTypeErrorsLike, o as ArkTypeLike, a9 as GlobalPermissionValue, ad as IoTsContextEntryLike, ae as IoTsDecodeErrorLike, af as IoTsDecoderLike, ag as JoiSchemaLike, ah as JoiValidationErrorDetailLike, am as MaybePromise, an as ModelBaseFilterHook, ap as ModelDeleteHook, aq as ModelDocPermissionsHook, as as ModelDocumentHook, at as ModelHook, av as ModelIdentifierHook, aw as ModelListHook, ax as ModelOverrideFilterHook, aA as ModelValidateHook, cL as Permissions, a_ as RequestSchemaAdapter, a$ as RequestSchemaFailure, b0 as RequestSchemaIssue, b1 as RequestSchemaLike, b2 as RequestSchemaOptions, b3 as RequestSchemaResult, b4 as RequestSchemaSuccess, b5 as RequestSchemaValidator, bx as RouteGuardAccess, bF as StandardSchemaFailure, bG as StandardSchemaInferOutput, bH as StandardSchemaIssue, bI as StandardSchemaPathSegment, bJ as StandardSchemaResult, bK as StandardSchemaSuccess, bL as StandardSchemaV1, c0 as SuperstructFailureLike, c1 as SuperstructValidateLike, cd as ValibotIssueLike, ce as ValibotPathItemLike, cf as ValibotSafeParseLike, cg as ValibotSafeParseResult, cl as VineValidationErrorLike, cm as VineValidationMessageLike, cn as VineValidatorLike, co as YupSchemaLike, cp as YupValidationErrorLike, cq as defineRequestSchema, cr as fromAjv, cs as fromArkType, ct as fromIoTs, cu as fromJoi, cv as fromStandardSchema, cw as fromSuperstruct, cx as fromValibot, cy as fromVine, cz as fromYup, cA as fromZod } from './parsers-PMWujHUV.js';
+import { ag as GlobalOptions, Z as DefaultModelRouterOptions, aI as ModelRouterOptions, V as DataRouterOptions, a5 as ExtendedDefaultModelRouterOptions, a6 as ExtendedModelRouterOptions, a4 as ExtendedDataRouterOptions, A as AccessRouterBaseRequest, ai as GuardHook, aH as ModelRequest, T as DataRequest, cR as DataService, a7 as Filter, aS as Projection, bN as Sort, aP as Populate, cS as Service, cT as PublicService, cu as Validation, bE as RootRouterOptions } from './parsers-DppKW-Fd.js';
+export { cU as AccessRouterPermissionMap, cV as AccessRouterPermissions, c as AccessRouterRequest, d as AccessRouterRequestExtensions, l as AjvErrorObjectLike, n as AjvValidatorLike, o as ArkTypeErrorsLike, p as ArkTypeLike, ah as GlobalPermissionValue, al as IoTsContextEntryLike, am as IoTsDecodeErrorLike, an as IoTsDecoderLike, ao as JoiSchemaLike, ap as JoiValidationErrorDetailLike, av as MaybePromise, aw as ModelBaseFilterHook, ay as ModelDeleteHook, az as ModelDocPermissionsHook, aB as ModelDocumentHook, aC as ModelHook, aE as ModelIdentifierHook, aF as ModelListHook, aG as ModelOverrideFilterHook, aJ as ModelValidateHook, cW as Permissions, b8 as RequestSchemaAdapter, b9 as RequestSchemaFailure, ba as RequestSchemaIssue, bb as RequestSchemaLike, bc as RequestSchemaOptions, bd as RequestSchemaResult, be as RequestSchemaSuccess, bf as RequestSchemaValidator, bH as RouteGuardAccess, bP as StandardSchemaFailure, bQ as StandardSchemaInferOutput, bR as StandardSchemaIssue, bS as StandardSchemaPathSegment, bT as StandardSchemaResult, bU as StandardSchemaSuccess, bV as StandardSchemaV1, ca as SuperstructFailureLike, cb as SuperstructValidateLike, co as ValibotIssueLike, cp as ValibotPathItemLike, cq as ValibotSafeParseLike, cr as ValibotSafeParseResult, cw as VineValidationErrorLike, cx as VineValidationMessageLike, cy as VineValidatorLike, cz as YupSchemaLike, cA as YupValidationErrorLike, cB as defineRequestSchema, cC as fromAjv, cD as fromArkType, cE as fromIoTs, cF as fromJoi, cG as fromStandardSchema, cH as fromSuperstruct, cI as fromValibot, cJ as fromVine, cK as fromYup, cL as fromZod } from './parsers-DppKW-Fd.js';
 import JsonRouter from '@web-ts-toolkit/express-json-router';
 import 'zod';
 
@@ -103,9 +103,9 @@ declare class AccessRuntime {
     private readonly modelAtts;
     private readonly modelInstances;
     private readonly openApiRegistry;
-    registerModelInstance(modelName: string, model: mongoose.Model<unknown>): void;
+    registerModelInstance<TModel>(modelName: string, model: mongoose.Model<TModel>): void;
     hasModelInstance(modelName: string): boolean;
-    getModelInstance(modelName: string): mongoose.Model<unknown> | null;
+    getModelInstance<TModel = unknown>(modelName: string): mongoose.Model<TModel> | null;
     registerOpenApiRoute(route: OpenApiRouteDescriptor): void;
     /**
      * Enable strict OpenAPI collision detection for the remainder of this
@@ -177,6 +177,7 @@ declare class AccessRuntime {
     setDataOptions<TData = unknown>(dataName: string, options: DataRouterOptions<TData>): void;
     setDataOption<K extends keyof DataRouterOptions<TData>, TData = unknown>(dataName: string, key: K, value: DataRouterOptions<TData>[K]): void;
     getDataOptions<TData = unknown>(dataName: string): DataRouterOptions<TData>;
+    getDataSnapshot<TData = unknown>(dataName: string): readonly TData[];
     getDataOption<K extends keyof DataRouterOptions<TData>, TData = unknown>(dataName: string, key: K | string, defaultValue?: DataRouterOptions<TData>[K]): DataRouterOptions<TData>[K];
     getExactDataOption<K extends keyof ExtendedDataRouterOptions<TData>, TData = unknown>(dataName: string, key: K | string): ExtendedDataRouterOptions<TData>[K];
     getDataNames(): string[];
@@ -228,6 +229,11 @@ declare class DataRouter<TData = unknown> {
     permissionSchema: SetTargetOption$1<DataRouter<TData>, DataRouterOptions<TData>['permissionSchema']>;
     operationAccess: SetTargetOption$1<DataRouter<TData>, DataRouterOptions<TData>['operationAccess']>;
     baseFilter: SetTargetOption$1<DataRouter<TData>, DataRouterOptions<TData>['baseFilter']>;
+    /**
+     * Trusted filter replacements applied before base-filter composition.
+     * They may replace ordinary filters, but cannot replace an existing `false` denial.
+     * Returning `false` denies the transaction.
+     */
     overrideFilter: SetTargetOption$1<DataRouter<TData>, DataRouterOptions<TData>['overrideFilter']>;
     decorate: SetTargetOption$1<DataRouter<TData>, DataRouterOptions<TData>['decorate']>;
     decorateAll: SetTargetOption$1<DataRouter<TData>, DataRouterOptions<TData>['decorateAll']>;
@@ -281,7 +287,7 @@ declare class ModelRouter<TModel = unknown> {
     readonly options: ModelRouterOptions<TModel>;
     readonly fullBasePath: string;
     constructor(modelName: string, initialOptions: ModelRouterOptions<TModel>, runtime?: AccessRuntime);
-    static fromModel<TModel = unknown>(model: mongoose.Model<unknown>, initialOptions: ModelRouterOptions<TModel>, runtime?: AccessRuntime): ModelRouter<TModel>;
+    static fromModel<TModel>(model: mongoose.Model<TModel>, initialOptions: ModelRouterOptions<TModel>, runtime?: AccessRuntime): ModelRouter<TModel>;
     private getRequestSchema;
     getService(req: ModelRequest): Service<TModel>;
     getPublicService(req: ModelRequest): PublicService<TModel>;
@@ -326,7 +332,9 @@ declare class ModelRouter<TModel = unknown> {
      */
     baseFilter: SetTargetOption<ModelRouter<TModel>, ModelRouterOptions<TModel>['baseFilter']>;
     /**
-     * The override filter definitions applied in every query transaction.
+     * Trusted filter replacements applied before base-filter composition.
+     * They may replace ordinary filters, but cannot replace an existing `false` denial.
+     * Returning `false` denies the transaction.
      * @operation `list`, `read`, `update`, `delete`
      */
     overrideFilter: SetTargetOption<ModelRouter<TModel>, ModelRouterOptions<TModel>['overrideFilter']>;
@@ -517,9 +525,9 @@ declare const getModelOptions: <TModel = unknown>(modelName: string) => ModelRou
 declare const getModelOption: <K extends keyof ExtendedModelRouterOptions<TModel>, TModel = unknown>(modelName: string, key: K | string, defaultValue?: ExtendedModelRouterOptions<TModel>[K]) => ExtendedModelRouterOptions<TModel>[K];
 declare const getModelNames: () => string[];
 declare const getModelJsonSchema: (modelName: string) => Record<string, unknown>;
-declare const registerModelInstance: (modelName: string, model: mongoose.Model<unknown>) => void;
+declare const registerModelInstance: <TModel>(modelName: string, model: mongoose.Model<TModel>) => void;
 declare const hasModelInstance: (modelName: string) => boolean;
-declare const getModelInstance: (modelName: string) => mongoose.Model<unknown> | null;
+declare const getModelInstance: <TModel = unknown>(modelName: string) => mongoose.Model<TModel> | null;
 
 declare const setDefaultModelOptions: (options: DefaultModelRouterOptions) => void;
 declare const setDefaultModelOption: <K extends keyof ExtendedDefaultModelRouterOptions>(key: K, value: ExtendedDefaultModelRouterOptions[K]) => void;
@@ -590,9 +598,9 @@ interface Wtt {
     setDefaultModelOption: typeof setDefaultModelOption;
     getDefaultModelOptions: typeof getDefaultModelOptions;
     getDefaultModelOption: typeof getDefaultModelOption;
-    registerModelInstance: (modelName: string, model: mongoose.Model<unknown>) => void;
+    registerModelInstance: <TModel>(modelName: string, model: mongoose.Model<TModel>) => void;
     hasModelInstance: (modelName: string) => boolean;
-    getModelInstance: (modelName: string) => mongoose.Model<unknown> | null;
+    getModelInstance: <TModel = unknown>(modelName: string) => mongoose.Model<TModel> | null;
     RootRouter: typeof RootRouter;
     ModelRouter: typeof ModelRouter;
     DataRouter: typeof DataRouter;