@web-ts-toolkit/access-router 0.66.0 → 0.68.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import mongoose__default, { Schema } from 'mongoose';
2
2
  import { Response, NextFunction, RequestHandler, Router } from 'express';
3
- import { A as AccessRouterBaseRequest, au as GuardHook, a_ as ModelRequest, dY as AccessRuntime, $ as DataRouterOptions, Z as DataRequest, dZ as DataService, ab as ExtendedDataRouterOptions, ai as Filter, bv as Projection, cC as Sort, br as Populate, a$ as ModelRouterOptions, d_ as Service, d$ as PublicService, ba as ModelVirtualRecordAccess, b4 as ModelVirtualDescriptor, b6 as ModelVirtualGetter, b7 as ModelVirtualLeaf, ad as ExtendedModelRouterOptions, dz as Validation, cm as RootRouterOptions, e0 as OpenApiRouterOptions, e1 as OpenApiRegistryOptions, e2 as OpenApiRouteDescriptor, e3 as OpenApiDocumentOptions, e4 as OpenApiParameter, e5 as OpenApiSchema, e6 as OpenApiResponses, as as GlobalOptions, a3 as DefaultModelRouterOptions, ac as ExtendedDefaultModelRouterOptions } from './parsers-BiFHfrNd.js';
4
- export { e7 as AccessRouterPermissionMap, e8 as AccessRouterPermissions, c as AccessRouterRequest, d as AccessRouterRequestExtensions, l as AjvErrorObjectLike, n as AjvValidatorLike, o as AllowedOutputFieldOptions, p as ArkTypeErrorsLike, q as ArkTypeLike, s as AuthorizationMode, t as AuthorizedListResult, u as AuthorizedSingleResult, I as CreateAuthorization, O as DataFieldOptions, a8 as DocumentGrants, ae as FieldAuthorization, af as FieldOperationAccess, ag as FieldPermissionHook, ah as FieldValidation, ak as FilteredOutput, at as GlobalPermissionValue, av as HydrationMode, ay as InputFieldAuthorization, az as InputFieldPath, aA as IoTsContextEntryLike, aB as IoTsDecodeErrorLike, aC as IoTsDecoderLike, aD as JoiSchemaLike, aE as JoiValidationErrorDetailLike, aK as MaybePromise, aL as ModelBaseFilterHook, aN as ModelDeleteHook, aO as ModelDocPermissionsHook, aQ as ModelDocumentHook, aR as ModelHook, aT as ModelHydrationOptions, aU as ModelIdentifierHook, aV as ModelListHook, aW as ModelOutputContext, aX as ModelOutputHook, aY as ModelOutputListHook, aZ as ModelOverrideFilterHook, b0 as ModelValidateHook, b1 as ModelVirtualAccess, b2 as ModelVirtualAccessRecord, b3 as ModelVirtualContext, b5 as ModelVirtualDoc, b8 as ModelVirtualPopulateDependency, b9 as ModelVirtualPopulateInputs, bb as ModelVirtuals, bc as MutationAuthorization, bd as NewArgs, be as NewOptions, e9 as OpenApiMethod, bf as OperationAccess, bg as OperationAuthorization, bh as OutputAuthorization, bi as OutputFieldOptions, bj as OutputFieldPath, bk as OutputPlanningOptions, bn as PairedRouteAccess, bq as PermissionSchema, ea as Permissions, bt as PopulatePlanningOptions, bH as PublicSubdocumentCreateOptions, bI as PublicSubdocumentListOptions, bJ as PublicSubdocumentMutationOptions, bK as PublicSubdocumentReadOptions, bQ as RelatedAuthorization, bS as RequestSchemaAdapter, bT as RequestSchemaFailure, bU as RequestSchemaIssue, bV as RequestSchemaLike, bW as RequestSchemaOptions, bX as RequestSchemaResult, bY as RequestSchemaSuccess, bZ as RequestSchemaValidator, cp as RouteBaseAccess, cq as RouteGuardAccess, cr as RouteVariant, cs as RouteVariantAccess, ct as RowAuthorization, cx as ServiceAuthorization, cy as ServiceOutputContext, cz as ServiceOutputDecorator, cE as StandardSchemaFailure, cF as StandardSchemaInferOutput, cG as StandardSchemaIssue, cH as StandardSchemaPathSegment, cI as StandardSchemaResult, cJ as StandardSchemaSuccess, cK as StandardSchemaV1, cN as SubOperationAccess, cR as SubRouteGuardOptions, cU as SubdocumentCreateAuthorization, cW as SubdocumentCreateOptions, cX as SubdocumentCreateVisibilityAuthorization, cY as SubdocumentDeleteAuthorization, cZ as SubdocumentDeleteOptions, c_ as SubdocumentGateAuthorization, d0 as SubdocumentInputAuthorization, d1 as SubdocumentListOptions, d2 as SubdocumentModel, d3 as SubdocumentMutationAuthorization, d4 as SubdocumentName, d5 as SubdocumentOutputAuthorization, d8 as SubdocumentReadAuthorization, d9 as SubdocumentReadOptions, db as SubdocumentUpdateOptions, dc as SubdocumentVirtuals, dd as SubdocumentVisibilityAuthorization, de as SuperstructFailureLike, df as SuperstructValidateLike, dt as ValibotIssueLike, du as ValibotPathItemLike, dv as ValibotSafeParseLike, dw as ValibotSafeParseResult, dB as VineValidationErrorLike, dC as VineValidationMessageLike, dD as VineValidatorLike, dE as VirtualSubModel, dF as WithVirtuals, dG as YupSchemaLike, dH as YupValidationErrorLike, eb as defaultRuntime, dI as defineRequestSchema, dJ as fromAjv, dK as fromArkType, dL as fromIoTs, dM as fromJoi, dN as fromStandardSchema, dO as fromSuperstruct, dP as fromValibot, dQ as fromVine, dR as fromYup, dS as fromZod } from './parsers-BiFHfrNd.js';
3
+ import { A as AccessRouterBaseRequest, au as GuardHook, b1 as ModelRequest, e3 as AccessRuntime, $ as DataRouterOptions, Z as DataRequest, e4 as DataService, ab as ExtendedDataRouterOptions, bm as OperationAccessSetter, ai as Filter, bD as Projection, cJ as Sort, bz as Populate, b2 as ModelRouterOptions, e5 as Service, e6 as PublicService, bd as ModelVirtualRecordAccess, b7 as ModelVirtualDescriptor, b9 as ModelVirtualGetter, ba as ModelVirtualLeaf, ad as ExtendedModelRouterOptions, aP as ModelDocPermissionsDefinition, dG as Validation, cu as RootRouterOptions, e7 as OpenApiRouterOptions, e8 as OpenApiRegistryOptions, e9 as OpenApiRouteDescriptor, ea as OpenApiDocumentOptions, eb as OpenApiParameter, ec as OpenApiSchema, ed as OpenApiResponses, as as GlobalOptions, a3 as DefaultModelRouterOptions, ac as ExtendedDefaultModelRouterOptions } from './parsers-fSBARZSn.js';
4
+ export { ee as AccessRouterPermissionMap, ef as AccessRouterPermissions, c as AccessRouterRequest, d as AccessRouterRequestExtensions, l as AjvErrorObjectLike, n as AjvValidatorLike, o as AllowedOutputFieldOptions, p as ArkTypeErrorsLike, q as ArkTypeLike, s as AuthorizationMode, t as AuthorizedListResult, u as AuthorizedSingleResult, I as CreateAuthorization, O as DataFieldOptions, a8 as DocumentGrants, ae as FieldAuthorization, af as FieldOperationAccess, ag as FieldPermissionHook, ah as FieldValidation, ak as FilteredOutput, at as GlobalPermissionValue, av as HydrationMode, ay as InputFieldAuthorization, az as InputFieldPath, aA as IoTsContextEntryLike, aB as IoTsDecodeErrorLike, aC as IoTsDecoderLike, aD as JoiSchemaLike, aE as JoiValidationErrorDetailLike, aK as MaybePromise, aL as ModelBaseFilterHook, aN as ModelDeleteHook, aO as ModelDocPermissionsAccessRecord, aQ as ModelDocPermissionsDescriptor, aR as ModelDocPermissionsHook, aT as ModelDocumentHook, aU as ModelHook, aW as ModelHydrationOptions, aX as ModelIdentifierHook, aY as ModelListHook, aZ as ModelOutputContext, a_ as ModelOutputHook, a$ as ModelOutputListHook, b0 as ModelOverrideFilterHook, b3 as ModelValidateHook, b4 as ModelVirtualAccess, b5 as ModelVirtualAccessRecord, b6 as ModelVirtualContext, b8 as ModelVirtualDoc, bb as ModelVirtualPopulateDependency, bc as ModelVirtualPopulateInputs, be as ModelVirtuals, bf as MutationAuthorization, bg as NewArgs, bh as NewOptions, eg as OpenApiMethod, bi as OperationAccess, bj as OperationAccessContext, bk as OperationAccessPaths, bl as OperationAccessRule, bn as OperationAccessVariants, bo as OperationAuthorization, bp as OutputAuthorization, bq as OutputFieldOptions, br as OutputFieldPath, bs as OutputPlanningOptions, bv as PairedRouteAccess, by as PermissionSchema, eh as Permissions, bB as PopulatePlanningOptions, bP as PublicSubdocumentCreateOptions, bQ as PublicSubdocumentListOptions, bR as PublicSubdocumentMutationOptions, bS as PublicSubdocumentReadOptions, bY as RelatedAuthorization, b_ as RequestSchemaAdapter, b$ as RequestSchemaFailure, c0 as RequestSchemaIssue, c1 as RequestSchemaLike, c2 as RequestSchemaOptions, c3 as RequestSchemaResult, c4 as RequestSchemaSuccess, c5 as RequestSchemaValidator, cx as RouteBaseAccess, cy as RouteGuardAccess, cz as RouteVariant, cA as RowAuthorization, cE as ServiceAuthorization, cF as ServiceOutputContext, cG as ServiceOutputDecorator, cL as StandardSchemaFailure, cM as StandardSchemaInferOutput, cN as StandardSchemaIssue, cO as StandardSchemaPathSegment, cP as StandardSchemaResult, cQ as StandardSchemaSuccess, cR as StandardSchemaV1, cU as SubOperationAccess, cY as SubRouteGuardOptions, c$ as SubdocumentCreateAuthorization, d1 as SubdocumentCreateOptions, d2 as SubdocumentCreateVisibilityAuthorization, d3 as SubdocumentDeleteAuthorization, d4 as SubdocumentDeleteOptions, d5 as SubdocumentGateAuthorization, d7 as SubdocumentInputAuthorization, d8 as SubdocumentListOptions, d9 as SubdocumentModel, da as SubdocumentMutationAuthorization, db as SubdocumentName, dc as SubdocumentOutputAuthorization, df as SubdocumentReadAuthorization, dg as SubdocumentReadOptions, di as SubdocumentUpdateOptions, dj as SubdocumentVirtuals, dk as SubdocumentVisibilityAuthorization, dl as SuperstructFailureLike, dm as SuperstructValidateLike, dA as ValibotIssueLike, dB as ValibotPathItemLike, dC as ValibotSafeParseLike, dD as ValibotSafeParseResult, dI as VineValidationErrorLike, dJ as VineValidationMessageLike, dK as VineValidatorLike, dL as VirtualSubModel, dM as WithVirtuals, dN as YupSchemaLike, dO as YupValidationErrorLike, ei as defaultRuntime, dP as defineRequestSchema, dQ as fromAjv, dR as fromArkType, dS as fromIoTs, dT as fromJoi, dU as fromStandardSchema, dV as fromSuperstruct, dW as fromValibot, dX as fromVine, dY as fromYup, dZ as fromZod } from './parsers-fSBARZSn.js';
5
5
  import JsonRouter from '@web-ts-toolkit/express-json-router';
6
6
  import 'zod';
7
7
  import 'node:buffer';
@@ -49,12 +49,12 @@ declare class DataRouter<TData = unknown> {
49
49
  private setDocumentRoutes;
50
50
  /**
51
51
  * Update live behavior with a typed key/path or an options object. Dotted paths
52
- * such as `operationAccess.basicRead` update one key; object assignment replaces
52
+ * such as `operationAccess.read.basic` update one key; object assignment replaces
53
53
  * supplied top-level values shallowly. The construction-time options snapshot stays fixed.
54
54
  */
55
55
  set<K extends keyof ExtendedDataRouterOptions<TData>>(key: K, value: ExtendedDataRouterOptions<TData>[K]): this;
56
56
  set(options: DataRouterOptions<TData>): this;
57
- /** Set one live option/path; `setOption('operationAccess.basicRead', undefined)` restores inheritance. */
57
+ /** Set one live option/path; `setOption('operationAccess.read.basic', undefined)` restores fallback. */
58
58
  setOption<K extends keyof ExtendedDataRouterOptions<TData>>(key: K, option: ExtendedDataRouterOptions<TData>[K]): this;
59
59
  /** Shallowly replace supplied top-level options; an operationAccess object replaces that entire rule object. */
60
60
  setOptions(options: DataRouterOptions<TData>): this;
@@ -63,13 +63,14 @@ declare class DataRouter<TData = unknown> {
63
63
  /** Base-operation field grants; basic/advanced route guards belong to operationAccess. */
64
64
  permissionSchema: SetTargetOption$1<DataRouter<TData>, DataRouterOptions<TData>['permissionSchema']>;
65
65
  /**
66
- * Live list/read guards plus basicList/advancedList/basicRead/advancedRead.
67
- * `operationAccess('basicRead', false)` updates one key and denies GET /:id
68
- * (and HEAD) with HTTP 401; registered POST reads still inherit `read`.
66
+ * Live scalar/default and independent basic/advanced/root list/read entry guards.
67
+ * `operationAccess('read.basic', false)` updates one member and denies GET /:id
68
+ * (and HEAD) with HTTP 401; registered POST reads use read.advanced then read.default.
69
69
  * `operationAccess({ list: true, read: true })` replaces the whole rule object,
70
- * not a deep merge. Use setOption with undefined to restore variant inheritance.
70
+ * not a deep merge. Two-argument member setters accept undefined to restore fallback.
71
+ * Data never inherits model defaults; updating beneath a scalar starts an object.
71
72
  */
72
- operationAccess: SetTargetOption$1<DataRouter<TData>, DataRouterOptions<TData>['operationAccess']>;
73
+ operationAccess: OperationAccessSetter<DataRouter<TData>>;
73
74
  baseFilter: SetTargetOption$1<DataRouter<TData>, DataRouterOptions<TData>['baseFilter']>;
74
75
  /**
75
76
  * Trusted filter replacements applied before base-filter composition.
@@ -150,14 +151,14 @@ declare class ModelRouter<TModel = unknown, TVirtuals extends object = Record<ne
150
151
  private logEndpoints;
151
152
  /**
152
153
  * Update live behavior with a typed key/path or an options object. Dotted paths
153
- * such as `operationAccess.basicRead` update one key; object assignment replaces
154
+ * such as `operationAccess.read.basic` update one key; object assignment replaces
154
155
  * supplied top-level values shallowly. The construction-time options snapshot stays fixed.
155
156
  */
156
157
  set<K extends Extract<keyof TVirtuals, string> & string, A extends ModelVirtualRecordAccess>(key: `virtuals.${K}.${A}`, value: ModelVirtualDescriptor<TModel, K extends keyof TVirtuals ? TVirtuals[K] : unknown> | ModelVirtualGetter<TModel, K extends keyof TVirtuals ? TVirtuals[K] : unknown>): this;
157
158
  set<K extends Extract<keyof TVirtuals, string> & string>(key: `virtuals.${K}`, value: ModelVirtualLeaf<TModel, K extends keyof TVirtuals ? TVirtuals[K] : unknown>): this;
158
159
  set<K extends keyof ExtendedModelRouterOptions<TModel, TVirtuals>>(key: K, value: ExtendedModelRouterOptions<TModel, TVirtuals>[K]): this;
159
160
  set(options: ModelRouterOptions<TModel, TVirtuals>): this;
160
- /** Set one live option/path; `setOption('operationAccess.basicRead', undefined)` restores inheritance. */
161
+ /** Set one live option/path; `setOption('operationAccess.read.basic', undefined)` restores fallback. */
161
162
  setOption<K extends keyof ExtendedModelRouterOptions<TModel, TVirtuals>>(key: K, option: ExtendedModelRouterOptions<TModel, TVirtuals>[K]): this;
162
163
  /** Shallowly replace supplied top-level options; an operationAccess object replaces that entire rule object. */
163
164
  setOptions(options: ModelRouterOptions<TModel, TVirtuals>): this;
@@ -236,22 +237,24 @@ declare class ModelRouter<TModel = unknown, TVirtuals extends object = Record<ne
236
237
  */
237
238
  documentPermissionField: SetTargetOption<ModelRouter<TModel, TVirtuals>, ModelRouterOptions<TModel, TVirtuals>['documentPermissionField']>;
238
239
  /**
239
- * The model fields always selected for ACL and response shaping.
240
+ * Configure a callable/descriptor directly, or replace one exact/default/custom
241
+ * access definition. Descriptor dependsOn adds private persisted inputs, not output grants.
242
+ * An undefined access restores default fallback; pass undefined alone to clear the option.
240
243
  */
241
- alwaysSelectFields: SetTargetOption<ModelRouter<TModel, TVirtuals>, ModelRouterOptions<TModel, TVirtuals>['alwaysSelectFields']>;
242
- /**
243
- * The function called in the process of generating document permissions.
244
- */
245
- docPermissions: SetTargetOption<ModelRouter<TModel, TVirtuals>, ModelRouterOptions<TModel, TVirtuals>['docPermissions']>;
244
+ docPermissions: {
245
+ (option: ModelRouterOptions<TModel, TVirtuals>['docPermissions']): ModelRouter<TModel, TVirtuals>;
246
+ (access: string, option: ModelDocPermissionsDefinition<TModel> | undefined): ModelRouter<TModel, TVirtuals>;
247
+ };
246
248
  /**
247
- * Configure live base and basic/advanced route guards. Only undefined inherits;
249
+ * Configure live scalar/default and independent basic/advanced/root entry guards. Only undefined inherits;
248
250
  * selected false denies with HTTP 401 without removing routes or OpenAPI entries.
249
- * `operationAccess('basicRead', false)` updates one key, and
250
- * `operationAccess('subs.comments.basicRead', false)` updates a field-specific key.
251
+ * `operationAccess('read.basic', false)` updates one member, and
252
+ * `operationAccess('subs.comments.read.basic', false)` updates a field-specific member.
251
253
  * `operationAccess({ list: true, read: true })` replaces the whole rule object,
252
- * not a deep merge. Use setOption with undefined to restore variant inheritance.
254
+ * not a deep merge. Two-argument member setters accept undefined to restore fallback.
255
+ * Updating beneath a scalar starts an object; retain the old guard in operation.default.
253
256
  */
254
- operationAccess: SetTargetOption<ModelRouter<TModel, TVirtuals>, ModelRouterOptions<TModel, TVirtuals>['operationAccess']>;
257
+ operationAccess: OperationAccessSetter<ModelRouter<TModel, TVirtuals>>;
255
258
  /**
256
259
  * The base filter definitions applied in every query transaction.
257
260
  * @operation `list`, `read`, `update`, `delete`
@@ -623,4 +626,4 @@ declare function createAccessRuntime(): AccessRuntimeApi;
623
626
  */
624
627
  declare const acl: AccessRuntimeApi;
625
628
 
626
- export { AccessRuntime, type AccessRuntimeApi, type CombinedRouteInput, DataRouter, DataRouterOptions, DefaultModelRouterOptions, ExtendedDataRouterOptions, ExtendedDefaultModelRouterOptions, ExtendedModelRouterOptions, GlobalOptions, GuardHook, type GuardModelCondition, type GuardModelConditionID, ModelRouter, ModelRouterOptions, ModelVirtualDescriptor, ModelVirtualGetter, ModelVirtualLeaf, ModelVirtualRecordAccess, type OpLogContext, OpenApiCollisionError, OpenApiDocumentOptions, OpenApiRegistry, OpenApiRegistryOptions, OpenApiRouteDescriptor, OpenApiRouterOptions, RootRouter, RootRouterOptions, Validation, acl, combineRoutes, createAccessRuntime, createOpenApiRouter, acl as default, getDefaultModelOption, getDefaultModelOptions, getGlobalOption, getGlobalOptions, getModelInstance, getModelJsonSchema, getModelNames, getModelOption, getModelOptions, guard, hasModelInstance, isLevelEnabled, permissionsPlugin, redactFilter, redactPayload, registerModelInstance, safeStringify, setDefaultModelOption, setDefaultModelOptions, setGlobalOption, setGlobalOptions, setModelOption, setModelOptions };
629
+ export { AccessRuntime, type AccessRuntimeApi, type CombinedRouteInput, DataRouter, DataRouterOptions, DefaultModelRouterOptions, ExtendedDataRouterOptions, ExtendedDefaultModelRouterOptions, ExtendedModelRouterOptions, GlobalOptions, GuardHook, type GuardModelCondition, type GuardModelConditionID, ModelDocPermissionsDefinition, ModelRouter, ModelRouterOptions, ModelVirtualDescriptor, ModelVirtualGetter, ModelVirtualLeaf, ModelVirtualRecordAccess, type OpLogContext, OpenApiCollisionError, OpenApiDocumentOptions, OpenApiRegistry, OpenApiRegistryOptions, OpenApiRouteDescriptor, OpenApiRouterOptions, OperationAccessSetter, RootRouter, RootRouterOptions, Validation, acl, combineRoutes, createAccessRuntime, createOpenApiRouter, acl as default, getDefaultModelOption, getDefaultModelOptions, getGlobalOption, getGlobalOptions, getModelInstance, getModelJsonSchema, getModelNames, getModelOption, getModelOptions, guard, hasModelInstance, isLevelEnabled, permissionsPlugin, redactFilter, redactPayload, registerModelInstance, safeStringify, setDefaultModelOption, setDefaultModelOptions, setGlobalOption, setGlobalOptions, setModelOption, setModelOptions };