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

package/{parsers-PMWujHUV.d.ts → parsers-DppKW-Fd.d.ts}

@@ -65,6 +65,13 @@ declare class Service<TModel = unknown> extends Base<TModel> {
     protected authorizeDistinctField(field: string): Promise<ErrorResult | null>;
     distinct(field: string, args?: DistinctArgs<TModel>): Promise<ListResult<unknown> | ErrorResult>;
     count(filter: Filter<TModel>, access?: BaseFilterAccess): Promise<SingleResult<number> | ErrorResult>;
+    /**
+     * Trusted count for correlated includes (ACI-03): the caller already
+     * resolved parent references, revalidated expanded operands, and applied
+     * explicit `count` access via `genFilter`. This skips client-filter
+     * validation and subquery parsing so substituted parent data stays inert.
+     */
+    countTrusted(authorizedFilter: Filter<TModel>): Promise<SingleResult<number> | ErrorResult>;
     countByFieldValues(foreignField: string, values: unknown[], filter?: Filter<TModel>, access?: BaseFilterAccess): Promise<SingleResult<Map<string, Set<string>>> | ErrorResult>;
     getDocPermissions(doc: unknown): Record<string, unknown>;
     private resolveFindOneArgs;
@@ -196,7 +203,9 @@ type StandardSchemaV1<Input = unknown, Output = Input> = {
 type StandardSchemaInferOutput<TSchema extends StandardSchemaV1> = NonNullable<TSchema['~standard']['types']>['output'];
 type RequestSchemaLike<T = unknown> = RequestSchemaValidator<T> | RequestSchemaAdapter<T> | StandardSchemaV1;
 type YupValidationErrorLike = {
+    name: 'ValidationError';
     message: string;
+    errors: ReadonlyArray<string>;
     path?: string;
     inner?: ReadonlyArray<YupValidationErrorLike>;
 };
@@ -234,9 +243,13 @@ type AjvErrorObjectLike = {
         missingProperty?: string;
     };
 };
+type AjvValidationErrorLike = {
+    errors?: ReadonlyArray<AjvErrorObjectLike> | null;
+};
 type AjvValidatorLike<T = unknown> = {
-    (value: unknown): boolean | Promise<boolean>;
+    (value: unknown): boolean | Promise<T | boolean>;
     errors?: ReadonlyArray<AjvErrorObjectLike> | null;
+    $async?: boolean;
 };
 type ValibotPathItemLike = {
     key?: unknown;
@@ -264,10 +277,13 @@ type ArkTypeProblemLike = {
 };
 type ArkTypeErrorsLike = ReadonlyArray<ArkTypeProblemLike> & {
     summary?: string;
+    readonly arkKind?: string;
+    readonly ' arkKind'?: string;
 };
 type ArkTypeLike<T = unknown> = {
-    (value: unknown): T | ArkTypeErrorsLike;
+    (value: unknown): T | ArkTypeErrorsLike | Promise<T | ArkTypeErrorsLike>;
     errors?: unknown;
+    readonly '~standard'?: StandardSchemaV1['~standard'];
 };
 type IoTsContextEntryLike = {
     key: string;
@@ -299,6 +315,9 @@ type VineValidationMessageLike = {
     index?: number;
 };
 type VineValidationErrorLike = {
+    name?: string;
+    code?: string;
+    status?: number;
     messages: ReadonlyArray<VineValidationMessageLike>;
 };
 type VineValidatorLike<T = unknown> = {
@@ -430,6 +449,8 @@ interface RequestComplexityOptions {
     maxSubQueryCount?: number;
     maxBulkConcurrency?: number;
     maxHookConcurrency?: number;
+    maxCorrelatedQueries?: number;
+    maxCorrelatedDepth?: number;
 }
 
 declare class RequestConcurrencyScheduler {
@@ -440,6 +461,10 @@ declare class RequestConcurrencyScheduler {
 }
 
 type CrossResourceModelOperation = 'list' | 'read' | 'count';
+interface CorrelatedExecState {
+    totalQueries: number;
+    scheduler: RequestConcurrencyScheduler;
+}
 declare class Base<TModel = unknown> {
     protected req: ModelRequest;
     protected modelName: string;
@@ -476,9 +501,11 @@ declare class Base<TModel = unknown> {
     protected throwClientRequestError(code: ErrorResult['code'], detail: string): never;
     protected getAuthorizedTargetService(modelName: string, op: CrossResourceModelOperation): Promise<PublicService<unknown>>;
     protected processInclude(include: Include | Include[]): {
-        includes: Include[];
+        includes: LegacyInclude[];
+        correlatedIncludes: CorrelatedInclude[];
         includeLocalFields: string[];
         includePaths: string[];
+        correlatedReferenceFields: string[];
     };
     private getForeignKeyValues;
     private getForeignKey;
@@ -491,6 +518,13 @@ declare class Base<TModel = unknown> {
     private includeDocsRead;
     private includeDocsList;
     private includeDocsCount;
+    protected getCorrelatedExecState(): CorrelatedExecState;
+    protected claimCorrelatedQuerySlot(): void;
+    private sanitizeCorrelatedArgs;
+    protected includeCorrelatedDocs<TDoc>(docs: TDoc[], correlatedIncludes: CorrelatedInclude[], snapshots?: unknown[], depth?: number): Promise<TDoc[]>;
+    private includeCorrelatedRead;
+    private includeCorrelatedList;
+    private includeCorrelatedCount;
     protected parseClientData<TValue>(filter: TValue, scheduler?: RequestConcurrencyScheduler, scheduled?: boolean): Promise<TValue>;
     private handleSubQuery;
     private handleDate;
@@ -526,6 +560,7 @@ type InternalModelHookContext = ModelHookContext & {
 declare class Core {
     private req;
     private caches;
+    private cachedPermissions;
     constructor(req: AccessRouterBaseRequest);
     getIdentifier(modelName: string): string;
     genIDFilter<TModel = unknown>(modelName: string, id: string): Promise<Filter<TModel>>;
@@ -565,6 +600,7 @@ declare class Core {
 declare class DataCore {
     private req;
     private caches;
+    private cachedPermissions;
     constructor(req: AccessRouterBaseRequest);
     genIDFilter<TData = unknown>(dataName: string, id: string): Promise<Filter<TData>>;
     genFilter<TData = unknown>(dataName: string, access?: BaseFilterAccess, _filter?: Filter<TData>): Promise<Filter<TData>>;
@@ -789,10 +825,11 @@ type PopulateEntryShape<T, TPath extends string, TValue> = TPath extends `${infe
 type PopulateOutputShape<T, TPopulateEntry> = PopulatePath<TPopulateEntry> extends infer TPath extends string ? PopulateEntryShape<T, TPath, PopulateLeafValue<PathValue<WithDefaultId<T>, TPath>, TPopulateEntry>> : {};
 type PopulateOutput<T, TPopulate> = string extends PopulatePath<PopulateInputs<TPopulate>> ? {} : [PopulatePath<PopulateInputs<TPopulate>>] extends [never] ? {} : Simplify<UnionToIntersection<PopulateOutputShape<T, Extract<PopulateInputs<TPopulate>, PopulateInput>>>>;
 type SelectedPopulatedPublicOutput<T, TProjection, TPopulate> = Simplify<SelectedPublicOutput<T, TProjection> & PopulateOutput<T, TPopulate>>;
-type DeepFieldPath<T, Depth extends number = 4> = [Depth] extends [never] ? never : Descend<T> extends NonTraversable ? never : {
-    [K in Extract<keyof Descend<T>, string>]: K | (Descend<T>[K] extends NonTraversable ? never : Descend<T>[K] extends readonly (infer U)[] ? U extends NonTraversable ? never : `${K}.${DeepFieldPath<U, PrevDepth[Depth]>}` : Descend<T>[K] extends object ? `${K}.${DeepFieldPath<Descend<T>[K], PrevDepth[Depth]>}` : never);
-}[Extract<keyof Descend<T>, string>];
-type PathValue<T, TPath extends string> = TPath extends `${infer Head}.${infer Tail}` ? Head extends Extract<keyof Descend<T>, string> ? PathValue<Descend<Descend<T>[Head]>, Tail> : unknown : TPath extends Extract<keyof Descend<T>, string> ? Descend<T>[TPath] : unknown;
+type Unwrap<T> = NonNullable<Descend<T>>;
+type DeepFieldPath<T, Depth extends number = 4> = [Depth] extends [never] ? never : Unwrap<T> extends NonTraversable ? never : {
+    [K in Extract<keyof Unwrap<T>, string>]: K | (NonNullable<Unwrap<T>[K]> extends NonTraversable ? never : NonNullable<Unwrap<T>[K]> extends readonly (infer U)[] ? Unwrap<U> extends NonTraversable ? never : `${K}.${DeepFieldPath<U, PrevDepth[Depth]>}` : NonNullable<Unwrap<T>[K]> extends object ? `${K}.${DeepFieldPath<NonNullable<Unwrap<T>[K]>, PrevDepth[Depth]>}` : never);
+}[Extract<keyof Unwrap<T>, string>];
+type PathValue<T, TPath extends string> = TPath extends `${infer Head}.${infer Tail}` ? Head extends Extract<keyof Unwrap<T>, string> ? PathValue<Unwrap<Unwrap<T>[Head]>, Tail> : unknown : TPath extends Extract<keyof Unwrap<T>, string> ? Unwrap<T>[TPath] : unknown;
 type FieldFilterOperators<T> = {
     $eq?: T;
     $ne?: T;
@@ -824,7 +861,8 @@ type TypedFilterObject<T> = {
 };
 type TypedFilter<T> = false | TypedFilterObject<WithDefaultId<T>>;
 type Filter<T = unknown> = IsUnknown<T> extends true ? LooseFilter : TypedFilter<T>;
-interface Include {
+interface LegacyInclude {
+    mode?: 'legacy';
     model: string;
     op: 'list' | 'read' | 'count';
     path: string;
@@ -834,6 +872,56 @@ interface Include {
     args?: unknown;
     options?: unknown;
 }
+/**
+ * Explicit structural marker referencing a field of the immediate parent
+ * document (ACI-01 D2.1). Recognized only in filter/id value positions of
+ * correlated includes; magic `$field` strings are never markers.
+ */
+interface ParentRef {
+    $parent: string;
+}
+/** Filter template for correlated includes; values may carry {@link ParentRef} markers. */
+type CorrelatedFilter = Record<string, unknown>;
+interface CorrelatedIncludeArgs {
+    select?: Projection;
+    sort?: Sort;
+    skip?: number | string;
+    limit?: number | string;
+    page?: number | string;
+    pageSize?: number | string;
+    include?: Include | Include[];
+}
+interface CorrelatedIncludeBase {
+    mode: 'correlated';
+    model: string;
+    op: 'list' | 'read' | 'count';
+    path: string;
+    args?: CorrelatedIncludeArgs;
+    options?: Record<string, never>;
+}
+/** Identifier read: exactly one of `id` / `filter` must be present. */
+interface CorrelatedReadByIdInclude extends CorrelatedIncludeBase {
+    op: 'read';
+    id: string | ParentRef;
+    filter?: never;
+}
+interface CorrelatedReadByFilterInclude extends CorrelatedIncludeBase {
+    op: 'read';
+    filter: CorrelatedFilter;
+    id?: never;
+}
+interface CorrelatedListInclude extends CorrelatedIncludeBase {
+    op: 'list';
+    filter: CorrelatedFilter;
+    id?: never;
+}
+interface CorrelatedCountInclude extends CorrelatedIncludeBase {
+    op: 'count';
+    filter: CorrelatedFilter;
+    id?: never;
+}
+type CorrelatedInclude = CorrelatedReadByIdInclude | CorrelatedReadByFilterInclude | CorrelatedListInclude | CorrelatedCountInclude;
+type Include = LegacyInclude | CorrelatedInclude;
 type FindAccess = 'list' | 'read';
 type PopulateAccess = 'list' | 'read';
 interface Populate {
@@ -1041,10 +1129,11 @@ interface SubQueryEntry {
         compact?: boolean;
     };
 }
+type TaskType = 'COPY_AND_DEPOPULATE' | 'COPY' | 'MOVE' | 'SLICE' | 'COUNT' | 'MASK' | string;
 interface Task {
-    type: string;
+    type: TaskType;
     args: unknown;
-    options: Record<string, unknown>;
+    options?: Record<string, unknown>;
 }
 interface AccessRouterBaseRequest extends AccessRouterRequest {
     query: Record<'skip' | 'limit' | 'page' | 'page_size' | 'try_list' | 'skim' | 'include_permissions' | 'include_count' | 'include_extra_headers' | 'returning_all', string>;
@@ -1402,24 +1491,24 @@ interface ExtendedModelRouterOptions<TModel = unknown> extends ModelRouterOption
     'overrideFilter.read'?: ModelOverrideFilterHook;
     'overrideFilter.update'?: ModelOverrideFilterHook;
     'overrideFilter.delete'?: ModelOverrideFilterHook;
-    'decorate.default'?: ModelHook;
-    'decorate.list'?: ModelHook;
-    'decorate.create'?: ModelHook;
-    'decorate.read'?: ModelHook;
-    'decorate.update'?: ModelHook;
-    'decorateAll.default'?: ModelListHook;
-    'decorateAll.list'?: ModelListHook;
+    'decorate.default'?: ModelHook<TModel>;
+    'decorate.list'?: ModelHook<TModel>;
+    'decorate.create'?: ModelHook<TModel>;
+    'decorate.read'?: ModelHook<TModel>;
+    'decorate.update'?: ModelHook<TModel>;
+    'decorateAll.default'?: ModelListHook<TModel>;
+    'decorateAll.list'?: ModelListHook<TModel>;
     'validate.default'?: ValidateRule | ModelValidateHook;
     'validate.create'?: ValidateRule | ModelValidateHook;
     'validate.update'?: ValidateRule | ModelValidateHook;
-    'prepare.default'?: ModelHook;
-    'prepare.create'?: ModelHook;
-    'prepare.update'?: ModelHook;
-    'transform.default'?: ModelDocumentHook;
-    'transform.update'?: ModelDocumentHook;
-    'afterPersist.default'?: ModelDocumentHook;
-    'afterPersist.create'?: ModelDocumentHook;
-    'afterPersist.update'?: ModelDocumentHook;
+    'prepare.default'?: ModelHook<TModel>;
+    'prepare.create'?: ModelHook<TModel>;
+    'prepare.update'?: ModelHook<TModel>;
+    'transform.default'?: ModelDocumentHook<TModel>;
+    'transform.update'?: ModelDocumentHook<TModel>;
+    'afterPersist.default'?: ModelDocumentHook<TModel>;
+    'afterPersist.create'?: ModelDocumentHook<TModel>;
+    'afterPersist.update'?: ModelDocumentHook<TModel>;
     onChange?: Record<string, ModelChangeHook>;
     'requestSchemas.create'?: RequestSchema;
     'requestSchemas.update'?: RequestSchema;
@@ -1515,6 +1604,11 @@ declare function defineRequestSchema<T = unknown>(validator: RequestSchemaValida
 /**
  * Adapts a Zod schema into a `RequestSchemaValidator` for `access-router`.
  *
+ * Supports both synchronous schemas and schemas with async refinements or
+ * transforms via `safeParseAsync` when available. Synchronous schemas keep
+ * their existing output values and issue paths. Operational exceptions thrown
+ * by `safeParseAsync` itself propagate unchanged.
+ *
  * @example
  * const validator = fromZod(z.object({ name: z.string() }));
  */
@@ -1522,11 +1616,37 @@ declare function fromZod<TSchema extends z.ZodTypeAny>(schema: TSchema): Request
 declare function fromStandardSchema<TSchema extends StandardSchemaV1>(schema: TSchema): RequestSchemaValidator<StandardSchemaInferOutput<TSchema>>;
 declare function fromYup<TSchema extends YupSchemaLike>(schema: TSchema): RequestSchemaValidator;
 declare function fromJoi<TSchema extends JoiSchemaLike>(schema: TSchema): RequestSchemaValidator;
+/**
+ * Adapts an AJV validator into a `RequestSchemaValidator`.
+ *
+ * Contract: synchronous validators return a boolean and expose input-local
+ * diagnostics via mutable `validator.errors`; those errors are snapshotted
+ * synchronously before any suspension so concurrent same-turn validations do
+ * not observe another input's diagnostics. Asynchronous AJV schemas
+ * (`$async: true`) return a promise that resolves with validated data on
+ * success or rejects with a `ValidationError` carrying an `errors` array on
+ * failure; rejection-carried errors are normalized, while any other rejection
+ * propagates unchanged as an operational exception.
+ */
 declare function fromAjv<TValue = unknown>(validator: AjvValidatorLike<TValue>): RequestSchemaValidator<TValue>;
 declare function fromValibot<TSchema, TOutput = unknown>(schema: TSchema, safeParse: ValibotSafeParseLike): RequestSchemaValidator<TOutput>;
+/**
+ * Adapts an ArkType type into a `RequestSchemaValidator`.
+ *
+ * Success/failure is discriminated via the supported ArkErrors brand key
+ * (`hasArkKind(result, "errors")`, stored at runtime as `' arkKind'` with a
+ * leading space; the unspaced `arkKind` alias is also accepted) or, when the
+ * type exposes a Standard Schema `~standard.validate` contract, via that
+ * contract. ArkType's Standard Schema `validate` returns `{ value }` on
+ * success but returns raw `ArkErrors` on failure instead of `{ issues }`, so
+ * both shapes are handled. Array shape and `message`/`path`-like record
+ * fields are never used as discriminators, so valid empty/scalar/record/
+ * nullable arrays pass through unchanged. Unexpected exceptions thrown by the
+ * type propagate unchanged.
+ */
 declare function fromArkType<TValue = unknown>(type: ArkTypeLike<TValue>): RequestSchemaValidator<TValue>;
 declare function fromIoTs<TValue = unknown>(decoder: IoTsDecoderLike<TValue>): RequestSchemaValidator<TValue>;
 declare function fromSuperstruct<TStruct, TOutput = unknown>(struct: TStruct, validate: SuperstructValidateLike): RequestSchemaValidator<TOutput>;
 declare function fromVine<TValue = unknown>(validator: VineValidatorLike<TValue>): RequestSchemaValidator<TValue>;
 
-export { type Filter as $, type AccessRouterBaseRequest as A, type BaseFilterAccess as B, type Change as C, DATA_MIDDLEWARE as D, type DataFindOneOptions as E, type DataFindOptions as F, type DataHook as G, type DataHookContext as H, type DataIdentifierHook as I, type DataListHook as J, type DataOverrideFilterHook as K, type DataRequest as L, type DataRequestSchemas as M, type DataRouterOptions as N, type DecorateAccess as O, type DecorateAllAccess as P, type DeepFieldPath as Q, type DefaultModelRouterOptions as R, type Defaults as S, type DistinctArgs as T, type DistinctBody as U, type DocPermissionsAccess as V, type ErrorResult as W, type ExistsOptions as X, type ExtendedDataRouterOptions as Y, type ExtendedDefaultModelRouterOptions as Z, type ExtendedModelRouterOptions as _, type AccessRouterFieldKey as a, type RequestSchemaFailure as a$, FilterOperator as a0, type FindAccess as a1, type FindArgs as a2, type FindByIdArgs as a3, type FindByIdOptions as a4, type FindOneArgs as a5, type FindOneOptions as a6, type FindOptions as a7, type GlobalOptions as a8, type GlobalPermissionValue as a9, type ModelValidateHook as aA, PERMISSIONS as aB, PERMISSION_KEYS as aC, type PathValue as aD, type PermissionSchema as aE, type Populate as aF, type PopulateAccess as aG, type PrepareAccess as aH, type Projection as aI, type PublicCreateArgs as aJ, type PublicCreateOptions as aK, type PublicErrorResult as aL, type PublicListArgs as aM, type PublicListOptions as aN, type PublicListResult as aO, type PublicOutput as aP, type PublicReadArgs as aQ, type PublicReadOptions as aR, type PublicServiceResult as aS, type PublicSingleResult as aT, type PublicUpdateArgs as aU, type PublicUpdateOptions as aV, type PublicUpsertArgs as aW, type PublicUpsertOptions as aX, type ReadQueryInput as aY, type Request as aZ, type RequestSchemaAdapter as a_, type GuardHook as aa, type IdentifierHook as ab, type Include as ac, type IoTsContextEntryLike as ad, type IoTsDecodeErrorLike as ae, type IoTsDecoderLike as af, type JoiSchemaLike as ag, type JoiValidationErrorDetailLike as ah, type KeyValueProjection as ai, type ListQueryInput as aj, type ListResult as ak, MIDDLEWARE as al, type MaybePromise as am, type ModelBaseFilterHook as an, type ModelChangeHook as ao, type ModelDeleteHook as ap, type ModelDocPermissionsHook as aq, type ModelDocument as ar, type ModelDocumentHook as as, type ModelHook as at, type ModelHookContext as au, type ModelIdentifierHook as av, type ModelListHook as aw, type ModelOverrideFilterHook as ax, type ModelRequest as ay, type ModelRouterOptions as az, type AccessRouterLogger as b, type SubdocumentRecord as b$, type RequestSchemaIssue as b0, type RequestSchemaLike as b1, type RequestSchemaOptions as b2, type RequestSchemaResult as b3, type RequestSchemaSuccess as b4, type RequestSchemaValidator as b5, type RequestSchemas as b6, type RootDataListQueryEntry as b7, type RootDataOperation as b8, type RootDataReadByFilterQueryEntry as b9, type SelectedPublicOutput as bA, type ServiceResult as bB, type SingleResult as bC, type Sort as bD, type SortOrder as bE, type StandardSchemaFailure as bF, type StandardSchemaInferOutput as bG, type StandardSchemaIssue as bH, type StandardSchemaPathSegment as bI, type StandardSchemaResult as bJ, type StandardSchemaSuccess as bK, type StandardSchemaV1 as bL, StatusCodes as bM, type SubListBody as bN, type SubPopulate as bO, type SubQueryEntry as bP, type SubReadBody as bQ, type SubdocumentBulkRecord as bR, type SubdocumentBulkUpdateInput as bS, type SubdocumentCreateInput as bT, type SubdocumentCreateOptions as bU, type SubdocumentId as bV, type SubdocumentListOptions as bW, type SubdocumentName as bX, type SubdocumentParentArgs as bY, type SubdocumentParentOptions as bZ, type SubdocumentReadOptions as b_, type RootDataReadByIdQueryEntry as ba, type RootModelCountQueryEntry as bb, type RootModelCreateQueryEntry as bc, type RootModelDeleteQueryEntry as bd, type RootModelDistinctQueryEntry as be, type RootModelListQueryEntry as bf, type RootModelNewQueryEntry as bg, type RootModelOperation as bh, type RootModelReadByFilterQueryEntry as bi, type RootModelReadByIdQueryEntry as bj, type RootModelSubBulkUpdateQueryEntry as bk, type RootModelSubCreateQueryEntry as bl, type RootModelSubDeleteQueryEntry as bm, type RootModelSubListQueryEntry as bn, type RootModelSubReadQueryEntry as bo, type RootModelSubUpdateQueryEntry as bp, type RootModelUpdateQueryEntry as bq, type RootModelUpsertQueryEntry as br, type RootOperationResult as bs, type RootQueryEntry as bt, type RootRouterOptions as bu, type RootSubOperation as bv, type RootTarget as bw, type RouteGuardAccess as bx, type SelectAccess as by, type SelectedPopulatedPublicOutput as bz, type AccessRouterRequest as c, type SuperstructFailureLike as c0, type SuperstructValidateLike as c1, type Task as c2, type TransformAccess as c3, type TypedFilter as c4, type UpdateByIdArgs as c5, type UpdateByIdOptions as c6, type UpdateOneArgs as c7, type UpdateOneOptions as c8, type UpdateQueryInput as c9, fromZod as cA, parseBody as cB, parseBodyWithSchema as cC, parseNestedBodyWithSchema as cD, parsePathParam as cE, parseQuery as cF, DataService as cG, Service as cH, PublicService as cI, type AccessRouterPermissionMap as cJ, type AccessRouterPermissions as cK, type Permissions as cL, type UpsertArgs as ca, type UpsertOptions as cb, type UpsertQueryInput as cc, type ValibotIssueLike as cd, type ValibotPathItemLike as ce, type ValibotSafeParseLike as cf, type ValibotSafeParseResult as cg, type ValidateAccess as ch, type ValidateRule as ci, type Validation as cj, type ValidationError as ck, type VineValidationErrorLike as cl, type VineValidationMessageLike as cm, type VineValidatorLike as cn, type YupSchemaLike as co, type YupValidationErrorLike as cp, defineRequestSchema as cq, fromAjv as cr, fromArkType as cs, fromIoTs as ct, fromJoi as cu, fromStandardSchema as cv, fromSuperstruct as cw, fromValibot as cx, fromVine as cy, fromYup as cz, type AccessRouterRequestExtensions as d, type AdvancedCreateBody as e, type AdvancedListBody as f, type AdvancedReadBody as g, type AdvancedReadFilterBody as h, type AdvancedUpdateBody as i, type AdvancedUpsertBody as j, type AfterPersistAccess as k, type AjvErrorObjectLike as l, type AjvValidatorLike as m, type ArkTypeErrorsLike as n, type ArkTypeLike as o, type ArkTypeProblemLike as p, Codes as q, type CountBody as r, type CreateArgs as s, type CreateOptions as t, type CreateQueryInput as u, CustomHeaders as v, type DataBaseFilterHook as w, type DataFilter as x, type DataFindArgs as y, type DataFindOneArgs as z };
+export { type DistinctArgs as $, type AccessRouterBaseRequest as A, type BaseFilterAccess as B, type Change as C, type CreateArgs as D, type CreateOptions as E, type CreateQueryInput as F, CustomHeaders as G, DATA_MIDDLEWARE as H, type DataBaseFilterHook as I, type DataFilter as J, type DataFindArgs as K, type DataFindOneArgs as L, type DataFindOneOptions as M, type DataFindOptions as N, type DataHook as O, type DataHookContext as P, type DataIdentifierHook as Q, type DataListHook as R, type DataOverrideFilterHook as S, type DataRequest as T, type DataRequestSchemas as U, type DataRouterOptions as V, type DecorateAccess as W, type DecorateAllAccess as X, type DeepFieldPath as Y, type DefaultModelRouterOptions as Z, type Defaults as _, type AccessRouterFieldKey as a, type PublicReadOptions as a$, type DistinctBody as a0, type DocPermissionsAccess as a1, type ErrorResult as a2, type ExistsOptions as a3, type ExtendedDataRouterOptions as a4, type ExtendedDefaultModelRouterOptions as a5, type ExtendedModelRouterOptions as a6, type Filter as a7, FilterOperator as a8, type FindAccess as a9, type ModelDocument as aA, type ModelDocumentHook as aB, type ModelHook as aC, type ModelHookContext as aD, type ModelIdentifierHook as aE, type ModelListHook as aF, type ModelOverrideFilterHook as aG, type ModelRequest as aH, type ModelRouterOptions as aI, type ModelValidateHook as aJ, PERMISSIONS as aK, PERMISSION_KEYS as aL, type ParentRef as aM, type PathValue as aN, type PermissionSchema as aO, type Populate as aP, type PopulateAccess as aQ, type PrepareAccess as aR, type Projection as aS, type PublicCreateArgs as aT, type PublicCreateOptions as aU, type PublicErrorResult as aV, type PublicListArgs as aW, type PublicListOptions as aX, type PublicListResult as aY, type PublicOutput as aZ, type PublicReadArgs as a_, type FindArgs as aa, type FindByIdArgs as ab, type FindByIdOptions as ac, type FindOneArgs as ad, type FindOneOptions as ae, type FindOptions as af, type GlobalOptions as ag, type GlobalPermissionValue as ah, type GuardHook as ai, type IdentifierHook as aj, type Include as ak, type IoTsContextEntryLike as al, type IoTsDecodeErrorLike as am, type IoTsDecoderLike as an, type JoiSchemaLike as ao, type JoiValidationErrorDetailLike as ap, type KeyValueProjection as aq, type LegacyInclude as ar, type ListQueryInput as as, type ListResult as at, MIDDLEWARE as au, type MaybePromise as av, type ModelBaseFilterHook as aw, type ModelChangeHook as ax, type ModelDeleteHook as ay, type ModelDocPermissionsHook as az, type AccessRouterLogger as b, type SubdocumentBulkRecord as b$, type PublicServiceResult as b0, type PublicSingleResult as b1, type PublicUpdateArgs as b2, type PublicUpdateOptions as b3, type PublicUpsertArgs as b4, type PublicUpsertOptions as b5, type ReadQueryInput as b6, type Request as b7, type RequestSchemaAdapter as b8, type RequestSchemaFailure as b9, type RootModelUpdateQueryEntry as bA, type RootModelUpsertQueryEntry as bB, type RootOperationResult as bC, type RootQueryEntry as bD, type RootRouterOptions as bE, type RootSubOperation as bF, type RootTarget as bG, type RouteGuardAccess as bH, type SelectAccess as bI, type SelectedPopulatedPublicOutput as bJ, type SelectedPublicOutput as bK, type ServiceResult as bL, type SingleResult as bM, type Sort as bN, type SortOrder as bO, type StandardSchemaFailure as bP, type StandardSchemaInferOutput as bQ, type StandardSchemaIssue as bR, type StandardSchemaPathSegment as bS, type StandardSchemaResult as bT, type StandardSchemaSuccess as bU, type StandardSchemaV1 as bV, StatusCodes as bW, type SubListBody as bX, type SubPopulate as bY, type SubQueryEntry as bZ, type SubReadBody as b_, type RequestSchemaIssue as ba, type RequestSchemaLike as bb, type RequestSchemaOptions as bc, type RequestSchemaResult as bd, type RequestSchemaSuccess as be, type RequestSchemaValidator as bf, type RequestSchemas as bg, type RootDataListQueryEntry as bh, type RootDataOperation as bi, type RootDataReadByFilterQueryEntry as bj, type RootDataReadByIdQueryEntry as bk, type RootModelCountQueryEntry as bl, type RootModelCreateQueryEntry as bm, type RootModelDeleteQueryEntry as bn, type RootModelDistinctQueryEntry as bo, type RootModelListQueryEntry as bp, type RootModelNewQueryEntry as bq, type RootModelOperation as br, type RootModelReadByFilterQueryEntry as bs, type RootModelReadByIdQueryEntry as bt, type RootModelSubBulkUpdateQueryEntry as bu, type RootModelSubCreateQueryEntry as bv, type RootModelSubDeleteQueryEntry as bw, type RootModelSubListQueryEntry as bx, type RootModelSubReadQueryEntry as by, type RootModelSubUpdateQueryEntry as bz, type AccessRouterRequest as c, type SubdocumentBulkUpdateInput as c0, type SubdocumentCreateInput as c1, type SubdocumentCreateOptions as c2, type SubdocumentId as c3, type SubdocumentListOptions as c4, type SubdocumentName as c5, type SubdocumentParentArgs as c6, type SubdocumentParentOptions as c7, type SubdocumentReadOptions as c8, type SubdocumentRecord as c9, type YupValidationErrorLike as cA, defineRequestSchema as cB, fromAjv as cC, fromArkType as cD, fromIoTs as cE, fromJoi as cF, fromStandardSchema as cG, fromSuperstruct as cH, fromValibot as cI, fromVine as cJ, fromYup as cK, fromZod as cL, parseBody as cM, parseBodyWithSchema as cN, parseNestedBodyWithSchema as cO, parsePathParam as cP, parseQuery as cQ, DataService as cR, Service as cS, PublicService as cT, type AccessRouterPermissionMap as cU, type AccessRouterPermissions as cV, type Permissions as cW, type SuperstructFailureLike as ca, type SuperstructValidateLike as cb, type Task as cc, type TaskType as cd, type TransformAccess as ce, type TypedFilter as cf, type UpdateByIdArgs as cg, type UpdateByIdOptions as ch, type UpdateOneArgs as ci, type UpdateOneOptions as cj, type UpdateQueryInput as ck, type UpsertArgs as cl, type UpsertOptions as cm, type UpsertQueryInput as cn, type ValibotIssueLike as co, type ValibotPathItemLike as cp, type ValibotSafeParseLike as cq, type ValibotSafeParseResult as cr, type ValidateAccess as cs, type ValidateRule as ct, type Validation as cu, type ValidationError as cv, type VineValidationErrorLike as cw, type VineValidationMessageLike as cx, type VineValidatorLike as cy, type YupSchemaLike as cz, type AccessRouterRequestExtensions as d, type AdvancedCreateBody as e, type AdvancedListBody as f, type AdvancedReadBody as g, type AdvancedReadFilterBody as h, type AdvancedUpdateBody as i, type AdvancedUpsertBody as j, type AfterPersistAccess as k, type AjvErrorObjectLike as l, type AjvValidationErrorLike as m, type AjvValidatorLike as n, type ArkTypeErrorsLike as o, type ArkTypeLike as p, type ArkTypeProblemLike as q, Codes as r, type CorrelatedCountInclude as s, type CorrelatedFilter as t, type CorrelatedInclude as u, type CorrelatedIncludeArgs as v, type CorrelatedListInclude as w, type CorrelatedReadByFilterInclude as x, type CorrelatedReadByIdInclude as y, type CountBody as z };

package/processors.d.mts

@@ -47,6 +47,97 @@ interface CopyAndDepopulateOptions {
      */
     idField?: string;
 }
+/**
+ * A path copy operation consumed by {@link copyPaths} and the `COPY` task.
+ * Reuses the same `{ src, dest }` shape as {@link ProcessCopy}.
+ */
+type ProcessPathCopy = ProcessCopy;
+/**
+ * A path move operation consumed by {@link movePaths} and the `MOVE` task.
+ * Reuses the same `{ src, dest }` shape as {@link ProcessCopy}.
+ */
+type ProcessPathMove = ProcessCopy;
+/**
+ * A slice operation consumed by {@link sliceArrays} and the `SLICE` task.
+ */
+interface ProcessSlice {
+    /**
+     * Dotted source path of the array to slice. Intermediate segments fan out
+     * across arrays like {@link copyAndDepopulate}. Missing, null, or
+     * non-array leaves are safe no-ops.
+     */
+    src: string;
+    /**
+     * Dotted destination path (relative to the leaf parent) where the sliced
+     * window is written. When omitted, the slice is applied in place at `src`.
+     * Empty-string destinations are safe no-ops.
+     */
+    dest?: string;
+    /**
+     * Number of leading array members to skip. Defaults to `0`. Must be a
+     * non-negative safe integer when present.
+     */
+    skip?: number;
+    /**
+     * Maximum number of array members to keep from `skip`. When omitted, the
+     * tail from `skip` to the end is kept. When present it is clamped to
+     * `maxSlice` (default `1000`). Must be a non-negative safe integer.
+     */
+    limit?: number;
+}
+/**
+ * A count operation consumed by {@link countPaths} and the `COUNT` task.
+ */
+interface ProcessCount {
+    /**
+     * Dotted source path whose size is measured. Arrays measure length, plain
+     * objects measure key count, present scalars count as `1`, and
+     * null/undefined leaves count as `0`. Missing leaves are safe no-ops.
+     */
+    src: string;
+    /**
+     * Dotted destination path (relative to the leaf parent) where the numeric
+     * count is written. Empty destinations are safe no-ops.
+     */
+    dest: string;
+}
+/**
+ * A mask operation consumed by {@link maskPaths} and the `MASK` task.
+ */
+interface ProcessMask {
+    /**
+     * Dotted source path to redact. Each resolved leaf present on its parent
+     * is replaced with `replacement`. Missing leaves are safe no-ops.
+     */
+    src: string;
+    /**
+     * Replacement value written at `src`. Defaults to `'***'` when the key is
+     * absent. An explicitly provided value (including `null`) is used as-is.
+     */
+    replacement?: unknown;
+}
+/**
+ * Shared mutable/clone option for path processors.
+ */
+interface ProcessorOptions {
+    /**
+     * When `true` (default), `docObject` is mutated in place and returned.
+     * When `false`, a deep clone is produced via `cloneDeep` and the input is
+     * left untouched.
+     */
+    mutable?: boolean;
+}
+/**
+ * Options for {@link sliceArrays}.
+ */
+interface SliceProcessorOptions extends ProcessorOptions {
+    /**
+     * Upper bound applied to a client-requested `limit`. Defaults to `1000`,
+     * matching the `listHardLimit` default. Must be a non-negative safe
+     * integer when present.
+     */
+    maxSlice?: number;
+}
 /**
  * Conservative default output for {@link copyAndDepopulate}.
  *
@@ -90,5 +181,64 @@ type CopyAndDepopulateOutput = Record<string, unknown>;
  * `constructor`, or when a populated record is missing the configured id field.
  */
 declare const copyAndDepopulate: <Output extends object = CopyAndDepopulateOutput>(docObject: object, operations: ProcessCopy[], options?: CopyAndDepopulateOptions) => Output;
+/**
+ * Conservative default output for path processors.
+ */
+type ProcessorOutput = Record<string, unknown>;
+/**
+ * Copy the value at `src` to `dest` without modifying `src`.
+ *
+ * Semantics mirror {@link copyAndDepopulate} traversal: intermediate segments
+ * fan out across arrays, missing/null/scalar intermediates are safe no-ops,
+ * and unsafe (`__proto__`, `prototype`, `constructor`) or empty paths are
+ * handled the same way. The copied value is deep-cloned so later tasks in
+ * the chain cannot alias `src` through `dest`. Copying a path onto itself
+ * is a safe no-op.
+ *
+ * @throws Error when a path contains an unsafe segment.
+ */
+declare const copyPaths: <Output extends object = ProcessorOutput>(docObject: object, operations: ProcessCopy[], options?: ProcessorOptions) => Output;
+/**
+ * Move the value at `src` to `dest` and delete `src`.
+ *
+ * Traversal and safety semantics match {@link copyPaths}. Moving a path onto
+ * itself is a safe no-op. A `dest` nested under the moved leaf (for example
+ * `src: 'a'`, `dest: 'a.b'`) copies without deleting `src` so the freshly
+ * written destination is not removed.
+ *
+ * @throws Error when a path contains an unsafe segment.
+ */
+declare const movePaths: <Output extends object = ProcessorOutput>(docObject: object, operations: ProcessCopy[], options?: ProcessorOptions) => Output;
+/**
+ * Slice the array at `src` to `[skip, skip + limit)` and write the window to
+ * `dest` (default: in place at `src`).
+ *
+ * Missing, null, or non-array leaves are safe no-ops. `skip` defaults to `0`;
+ * an omitted `limit` keeps the tail from `skip`. A present `limit` is clamped
+ * to `maxSlice` (default `1000`) so client-requested windows stay bounded.
+ *
+ * @throws Error when a path contains an unsafe segment or when
+ * `skip`/`limit`/`maxSlice` is not a non-negative safe integer.
+ */
+declare const sliceArrays: <Output extends object = ProcessorOutput>(docObject: object, operations: ProcessSlice[], options?: SliceProcessorOptions) => Output;
+/**
+ * Write the size of `src` to `dest`: array length, plain-object key count,
+ * `0` for null/undefined leaves, and `1` for other present scalars.
+ *
+ * Missing leaves are safe no-ops (no destination is created).
+ *
+ * @throws Error when a path contains an unsafe segment.
+ */
+declare const countPaths: <Output extends object = ProcessorOutput>(docObject: object, operations: ProcessCount[], options?: ProcessorOptions) => Output;
+/**
+ * Replace the value at `src` with `replacement` (default `'***'`).
+ *
+ * Only existing leaves are redacted; missing paths are safe no-ops and no
+ * new keys are created. Intermediate segments fan out across arrays like
+ * {@link copyAndDepopulate}.
+ *
+ * @throws Error when a path contains an unsafe segment.
+ */
+declare const maskPaths: <Output extends object = ProcessorOutput>(docObject: object, operations: ProcessMask[], options?: ProcessorOptions) => Output;
 
-export { type CopyAndDepopulateOptions, type CopyAndDepopulateOutput, type ProcessCopy, copyAndDepopulate };
+export { type CopyAndDepopulateOptions, type CopyAndDepopulateOutput, type ProcessCopy, type ProcessCount, type ProcessMask, type ProcessPathCopy, type ProcessPathMove, type ProcessSlice, type ProcessorOptions, type ProcessorOutput, type SliceProcessorOptions, copyAndDepopulate, copyPaths, countPaths, maskPaths, movePaths, sliceArrays };