@web-ts-toolkit/access-router 0.38.0 → 0.40.0

package/{parsers--DZcTstL.d.ts → parsers-PMWujHUV.d.ts}

@@ -24,204 +24,8 @@ declare class Permission {
 type Permissions = Permission;
 type AccessRouterPermissions = Permission;
 
-type OpenApiMethod = 'get' | 'post' | 'put' | 'patch' | 'delete';
-type OpenApiSchema = Record<string, unknown>;
-type OpenApiSchemaSource = unknown;
-type OpenApiParameter = {
-    name: string;
-    in: 'path' | 'query';
-    required?: boolean;
-    description?: string;
-    schema?: OpenApiSchema;
-};
-type OpenApiResponse = {
-    description: string;
-    content?: Record<string, {
-        schema: OpenApiSchema;
-    }>;
-};
-type OpenApiResponses = Record<string, OpenApiResponse>;
-type OpenApiRouteDescriptor = {
-    method: OpenApiMethod;
-    path: string;
-    operationId?: string;
-    summary?: string;
-    description?: string;
-    tags?: string[];
-    acl?: string;
-    deprecated?: boolean;
-    query?: OpenApiSchemaSource;
-    body?: OpenApiSchemaSource;
-    pathParams?: Record<string, OpenApiSchemaSource>;
-    responses?: OpenApiResponses;
-    /**
-     * When true, replaces an existing registration with the same method/path
-     * even when the descriptors differ. When false (default), conflicting
-     * registrations throw at registration time so consumers can detect
-     * accidental route shadowing.
-     */
-    allowReplace?: boolean;
-    /**
-     * When true, this exact descriptor is idempotent and registering the same
-     * method/path with an equivalent descriptor again is silently accepted.
-     * Differing re-registrations still throw unless {@link allowReplace} is set.
-     * Additionally, an idempotent descriptor may share its operationId with
-     * another idempotent descriptor mounted at a different path on the same
-     * registry, so reserved operations (e.g. the root batch route) can be
-     * exposed from multiple base paths without triggering strict-mode
-     * duplicate-operationId rejection.
-     */
-    idempotent?: boolean;
-};
-type OpenApiRegistryOptions = {
-    /**
-     * Throw when the same method/path is registered twice with differing
-     * descriptors, instead of silently replacing. Default: true (strict).
-     * The {@link AccessRuntime} registry is constructed in strict mode by
-     * default; construct {@link OpenApiRegistry} directly with
-     * `rejectConflicts: false` for legacy replacement semantics.
-     */
-    rejectConflicts?: boolean;
-    /**
-     * Throw when the same operationId is registered more than once, including
-     * when {@link OpenApiRouteDescriptor.allowReplace} is set. Default: true.
-     */
-    rejectDuplicateOperationIds?: boolean;
-};
-type OpenApiDocumentOptions = {
-    title: string;
-    version: string;
-    description?: string;
-    servers?: Array<{
-        url: string;
-        description?: string;
-    }>;
-};
-type OpenApiRouterOptions = Partial<OpenApiDocumentOptions> & {
-    jsonPath?: string;
-    docsPath?: string | false;
-    swaggerUiCssUrl?: string;
-    swaggerUiBundleUrl?: string;
-};
-
-declare class AccessRuntime {
-    constructor();
-    private readonly globalOptions;
-    private readonly defaultModelOptions;
-    private readonly modelOptions;
-    private readonly modelJsonSchemas;
-    private readonly dataOptions;
-    private readonly modelRefs;
-    private readonly modelSubs;
-    private readonly modelAtts;
-    private readonly modelInstances;
-    private readonly openApiRegistry;
-    registerModelInstance(modelName: string, model: mongoose.Model<unknown>): void;
-    hasModelInstance(modelName: string): boolean;
-    getModelInstance(modelName: string): mongoose.Model<unknown> | null;
-    registerOpenApiRoute(route: OpenApiRouteDescriptor): void;
-    /**
-     * Enable strict OpenAPI collision detection for the remainder of this
-     * runtime's lifetime. After this call, conflicting method/path
-     * registrations and duplicate operationIds throw {@link OpenApiCollisionError}
-     * instead of silently replacing. Existing already-registered routes are
-     * not retroactively re-validated.
-     */
-    enableOpenApiCollisionDetection(): void;
-    getOpenApiRoutes(): OpenApiRouteDescriptor[];
-    clearOpenApiRoutes(): void;
-    getOpenApiSpec(info: OpenApiDocumentOptions): {
-        openapi: string;
-        info: Omit<OpenApiDocumentOptions, "servers">;
-        servers?: OpenApiDocumentOptions["servers"];
-        paths: Record<string, Record<string, {
-            [key: `x-${string}`]: unknown;
-            operationId?: string;
-            summary?: string;
-            description?: string;
-            tags?: string[];
-            deprecated?: boolean;
-            parameters?: OpenApiParameter[];
-            requestBody?: {
-                required?: boolean;
-                content: Record<string, {
-                    schema: OpenApiSchema;
-                }>;
-            };
-            responses: OpenApiResponses;
-        }>>;
-    };
-    setGlobalOptions(options: GlobalOptions): void;
-    setGlobalOption<K extends keyof GlobalOptions>(key: K, value: GlobalOptions[K]): void;
-    getGlobalOptions(): GlobalOptions;
-    getGlobalOption<K extends keyof GlobalOptions>(key: K, defaultValue?: GlobalOptions[K]): GlobalOptions[K];
-    setDefaultModelOptions(options: DefaultModelRouterOptions): void;
-    setDefaultModelOption<K extends keyof ExtendedDefaultModelRouterOptions>(key: K, value: ExtendedDefaultModelRouterOptions[K]): void;
-    getDefaultModelOptions(): DefaultModelRouterOptions<unknown>;
-    getDefaultModelOption<K extends keyof ExtendedDefaultModelRouterOptions>(key: K, defaultValue?: ExtendedDefaultModelRouterOptions[K]): ExtendedDefaultModelRouterOptions<unknown>[K];
-    private createModelOptions;
-    private getOrCreateModelOptions;
-    setModelOptions<TModel = unknown>(modelName: string, options: ModelRouterOptions<TModel>): void;
-    setModelOption<K extends keyof ExtendedModelRouterOptions<TModel>, TModel = unknown>(modelName: string, key: K, value: ExtendedModelRouterOptions<TModel>[K]): void;
-    getModelOptions<TModel = unknown>(modelName: string): ModelRouterOptions<TModel>;
-    getModelOption<K extends keyof ExtendedModelRouterOptions<TModel>, TModel = unknown>(modelName: string, key: K | string, defaultValue?: ExtendedModelRouterOptions<TModel>[K]): ExtendedModelRouterOptions<TModel>[K];
-    getExactModelOption<K extends keyof ExtendedModelRouterOptions<TModel>, TModel = unknown>(modelName: string, key: K | string): ExtendedModelRouterOptions<TModel>[K];
-    getModelNames(): string[];
-    hasModel(modelName: string): boolean;
-    getModelJsonSchema(modelName: string): Record<string, unknown>;
-    private createDataOptions;
-    private getOrCreateDataOptions;
-    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>;
-    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[];
-    ensureModelMeta(modelName: string): void;
-    getModelRef(modelName: string, refPath: string): string | null;
-    getModelSub(modelName: string): string[];
-    getModelAtt(modelName: string): string[];
-}
-declare const defaultRuntime: AccessRuntime;
-
-interface FindProps {
-    filter: Filter;
-    select?: Projection;
-    sort?: Sort;
-    populate?: Populate[] | string;
-    limit?: string | number;
-    hardLimit?: number;
-    skip?: string | number;
-    lean?: boolean;
-}
-interface FindOneProps {
-    filter: Filter;
-    select?: Projection;
-    sort?: Sort;
-    populate?: Populate[] | string;
-    lean?: boolean;
-}
-type SortValue = 1 | -1 | 'asc' | 'ascending' | 'desc' | 'descending';
-type SortType = string | [string, SortValue][] | {
-    [key: string]: SortValue;
-} | Map<string, SortValue> | null | undefined;
-declare class Model {
-    modelName: string;
-    model: mongoose.Model<any>;
-    runtime: AccessRuntime | null;
-    constructor(modelName: string, runtime?: AccessRuntime);
-    new(): any;
-    create(data: unknown): Promise<any>;
-    find({ filter, select, sort, populate, limit, hardLimit, skip, lean }: FindProps): mongoose.Query<any[], any, {}, any, "find", {}>;
-    validateSort(sort: SortType, logError?: (msg: string, ...args: unknown[]) => void): boolean;
-    findOne({ filter, select, sort, populate, lean }: FindOneProps): mongoose.Query<any, any, {}, any, "findOne", {}>;
-    exists(filter: Filter): ReturnType<typeof Model.prototype.findOne> | null;
-    countDocuments(filter?: {}): mongoose.Query<number, any, {}, any, "countDocuments", {}>;
-    distinct(field: string, conditions?: {}): mongoose.Query<any[], any, {}, any, "distinct", {}>;
-}
-
 declare class Service<TModel = unknown> extends Base<TModel> {
-    protected model: Model;
+    protected model: any;
     protected options: ModelRouterOptions<TModel>;
     defaults: Defaults<TModel>;
     protected baseFields: string[];
@@ -231,7 +35,9 @@ declare class Service<TModel = unknown> extends Base<TModel> {
         select: string;
         populate: unknown;
         lean: boolean;
-    }): ReturnType<Model['findOne']>;
+    }): any;
+    protected createModelAdapter(modelName: string): any;
+    protected getModelRouterOptions(modelName: string): ModelRouterOptions<TModel>;
     private asServiceHookContext;
     private beginOp;
     private completeOp;
@@ -259,6 +65,7 @@ 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>;
+    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;
     private resolveFindOneOptions;
@@ -622,6 +429,14 @@ interface RequestComplexityOptions {
     maxIncludeCount?: number;
     maxSubQueryCount?: number;
     maxBulkConcurrency?: number;
+    maxHookConcurrency?: number;
+}
+
+declare class RequestConcurrencyScheduler {
+    readonly limit: number;
+    constructor(limit: number);
+    map<TInput, TOutput>(items: TInput[], iteratee: (item: TInput, index: number, scheduled: true) => Promise<TOutput>): Promise<TOutput[]>;
+    run<TOutput>(iteratee: (scheduled: true) => Promise<TOutput>): Promise<TOutput>;
 }
 
 type CrossResourceModelOperation = 'list' | 'read' | 'count';
@@ -636,7 +451,7 @@ declare class Base<TModel = unknown> {
     genFilter(access?: BaseFilterAccess, filter?: Filter<TModel>): Promise<Filter<TModel>>;
     getIdentifier(): string | null;
     genIDFilter(id: string): Promise<Filter<TModel>>;
-    genPopulate(access?: SelectAccess, populate?: Populate | Populate[] | string | null): Promise<Populate[]>;
+    genPopulate(access?: SelectAccess, populate?: Populate | Populate[] | string | null, subPaths?: string[]): Promise<Populate[]>;
     genSelect(access: SelectAccess, targetFields?: Projection, skipChecks?: boolean, subPaths?: string[]): Promise<string[]>;
     genQuerySelect(access: SelectAccess, targetFields?: Projection, skipChecks?: boolean, subPaths?: string[]): Promise<string[]>;
     addEmptyPermissions<T>(doc: T): T;
@@ -665,10 +480,18 @@ declare class Base<TModel = unknown> {
         includeLocalFields: string[];
         includePaths: string[];
     };
+    private getForeignKeyValues;
+    private getForeignKey;
+    private buildForeignKeyIndex;
+    private getIndexedMatches;
+    private getIndexedCount;
+    private sanitizeIncludeArgs;
+    private assertIncludeForeignField;
     protected includeDocs<TDoc>(docs: TDoc | TDoc[], include: Include | Include[]): Promise<TDoc | TDoc[]>;
+    private includeDocsRead;
     private includeDocsList;
     private includeDocsCount;
-    protected parseClientData<TValue>(filter: TValue): Promise<TValue>;
+    protected parseClientData<TValue>(filter: TValue, scheduler?: RequestConcurrencyScheduler, scheduled?: boolean): Promise<TValue>;
     private handleSubQuery;
     private handleDate;
 }
@@ -684,6 +507,7 @@ declare class DataService<T> {
     find<TSelect extends Projection | undefined = undefined>(filter: DataFilter<T>, args?: DataFindArgs<T, TSelect>, options?: DataFindOptions): Promise<ListResult<SelectedPublicOutput<T, TSelect>> | ErrorResult>;
     decorate<TDoc>(doc: TDoc, access: DecorateAccess, context?: DataHookContext): Promise<TDoc>;
     decorateAll<TDoc>(docs: TDoc[], access: DecorateAllAccess, context?: DataHookContext): Promise<TDoc[]>;
+    getRequestComplexity(): Required<RequestComplexityOptions>;
     genAllowedFields(doc: unknown, access: SelectAccess, baseFields?: string[]): Promise<string[]>;
     genFilter(access?: BaseFilterAccess, filter?: DataFilter<T>): Promise<DataFilter<T>>;
     genIDFilter(id: string): Promise<DataFilter<T>>;
@@ -691,7 +515,6 @@ declare class DataService<T> {
     genQuerySelect(access: SelectAccess, targetFields?: Projection, skipChecks?: boolean, subPaths?: string[]): Promise<string[]>;
     pickAllowedFields<TDoc>(doc: TDoc, access: SelectAccess, baseFields?: string[]): Promise<TDoc>;
     trimOutputFields<TDoc>(doc: TDoc, access: SelectAccess, baseFields?: string[]): Promise<TDoc>;
-    private validateSortFields;
 }
 
 type InternalModelHookContext = ModelHookContext & {
@@ -711,7 +534,7 @@ declare class Core {
     genAllowedFields(modelName: string, doc: unknown, access: SelectAccess, baseFields?: string[]): Promise<string[]>;
     pickAllowedFields<T>(modelName: string, doc: T, access: SelectAccess, baseFields?: string[]): Promise<T>;
     genSelect(modelName: string, access: SelectAccess, targetFields?: Projection, skipChecks?: boolean, subPaths?: string[]): Promise<string[]>;
-    genPopulate(modelName: string, access?: SelectAccess | BaseFilterAccess, _populate?: Populate | Populate[] | string | null): Promise<(string | Populate)[]>;
+    genPopulate(modelName: string, access?: SelectAccess | BaseFilterAccess, _populate?: Populate | Populate[] | string | null, subPaths?: string[]): Promise<(string | Populate)[]>;
     validate(modelName: string, allowedData: unknown, access: ValidateAccess, context: ModelHookContext): Promise<boolean | unknown[]>;
     prepare<T>(modelName: string, allowedData: T, access: PrepareAccess, context: ModelHookContext): Promise<T>;
     transform<T>(modelName: string, doc: T, access: TransformAccess, context: ModelHookContext): Promise<T>;
@@ -901,7 +724,7 @@ interface DataFindOneOptions {
 }
 interface DataFindArgs<T = unknown, TSelect extends Projection | undefined = Projection | undefined> {
     select?: TSelect;
-    sort?: string;
+    sort?: Sort;
     skip?: string | number;
     limit?: string | number;
     page?: string | number;
@@ -1536,6 +1359,11 @@ interface ModelRouterOptions<TModel = unknown> extends DefaultModelRouterOptions
     defaults?: Defaults<TModel>;
 }
 interface DataRouterOptions<TData = unknown> {
+    /**
+     * In-memory records are owned by the router as an immutable configured snapshot.
+     * Mutating this array or its records after configuration does not change served data;
+     * use `setDataOption(name, 'data', nextRecords)` or `router.data(nextRecords)` to replace it.
+     */
     data?: TData[];
     listHardLimit?: number;
     idParam?: string;
@@ -1701,4 +1529,4 @@ declare function fromIoTs<TValue = unknown>(decoder: IoTsDecoderLike<TValue>): R
 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, AccessRuntime as cG, DataService as cH, Model as cI, Service as cJ, PublicService as cK, type OpenApiRouterOptions as cL, type OpenApiRegistryOptions as cM, type OpenApiRouteDescriptor as cN, type OpenApiDocumentOptions as cO, type OpenApiParameter as cP, type OpenApiSchema as cQ, type OpenApiResponses as cR, type AccessRouterPermissionMap as cS, type AccessRouterPermissions as cT, type OpenApiMethod as cU, type Permissions as cV, defaultRuntime as cW, 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 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 };

package/processors.d.mts

@@ -14,15 +14,14 @@ interface ProcessCopy {
      *   `src: 'pear.items'`   -> depopulate `docObject.pear.items`
      *
      * Empty strings are treated as safe no-ops. Unsafe segments
-     * (`__proto__`, `prototype`, `constructor`) throw a descriptive
-     * `ProcessorPathError`.
+     * (`__proto__`, `prototype`, `constructor`) throw a descriptive `Error`.
      */
     src: string;
     /**
      * Dotted destination path on `docObject` where the moved objects will be
      * written. Unsafe segments (`__proto__`, `prototype`, `constructor`)
-     * throw a descriptive `ProcessorPathError`. Empty and missing
-     * destinations are safe no-ops.
+     * throw a descriptive `Error`. Empty and missing destinations are safe
+     * no-ops.
      */
     dest: string;
 }
@@ -42,12 +41,21 @@ interface CopyAndDepopulateOptions {
      * original populated value. Defaults to `'_id'`.
      *
      * For nested populated arrays, every leaf record must carry this field.
-     * Records missing the id field throw a descriptive `ProcessorPathError`.
+     * Records missing the id field throw a descriptive `Error`.
      * Primitive array members (non-record scalars) cannot be depopulated and
      * are left in place as a safe no-op.
      */
     idField?: string;
 }
+/**
+ * Conservative default output for {@link copyAndDepopulate}.
+ *
+ * The exact transformed shape depends on runtime path strings, so the default
+ * type intentionally does not claim that populated input leaves still have
+ * their original object shape. Provide an explicit output type argument when
+ * the operation set is known by the caller.
+ */
+type CopyAndDepopulateOutput = Record<string, unknown>;
 /**
  * Hardened processor that relocates populated documents to a destination
  * path and replaces the original location with their proposed
@@ -75,8 +83,12 @@ interface CopyAndDepopulateOptions {
  *   `Object.prototype` or any object's prototype.
  * - Empty `src` or `dest` strings are safe no-ops.
  *
- * @typeParam T - Object shape produced by the depopulation.
+ * @typeParam Output - Object shape produced by the depopulation. Defaults to a
+ * conservative record because `src` and `dest` are runtime paths.
+ *
+ * @throws Error when an operation path contains `__proto__`, `prototype`, or
+ * `constructor`, or when a populated record is missing the configured id field.
  */
-declare const copyAndDepopulate: <T extends object>(docObject: T, operations: ProcessCopy[], options?: CopyAndDepopulateOptions) => T;
+declare const copyAndDepopulate: <Output extends object = CopyAndDepopulateOutput>(docObject: object, operations: ProcessCopy[], options?: CopyAndDepopulateOptions) => Output;
 
-export { type CopyAndDepopulateOptions, type ProcessCopy, copyAndDepopulate };
+export { type CopyAndDepopulateOptions, type CopyAndDepopulateOutput, type ProcessCopy, copyAndDepopulate };

package/processors.d.ts

@@ -14,15 +14,14 @@ interface ProcessCopy {
      *   `src: 'pear.items'`   -> depopulate `docObject.pear.items`
      *
      * Empty strings are treated as safe no-ops. Unsafe segments
-     * (`__proto__`, `prototype`, `constructor`) throw a descriptive
-     * `ProcessorPathError`.
+     * (`__proto__`, `prototype`, `constructor`) throw a descriptive `Error`.
      */
     src: string;
     /**
      * Dotted destination path on `docObject` where the moved objects will be
      * written. Unsafe segments (`__proto__`, `prototype`, `constructor`)
-     * throw a descriptive `ProcessorPathError`. Empty and missing
-     * destinations are safe no-ops.
+     * throw a descriptive `Error`. Empty and missing destinations are safe
+     * no-ops.
      */
     dest: string;
 }
@@ -42,12 +41,21 @@ interface CopyAndDepopulateOptions {
      * original populated value. Defaults to `'_id'`.
      *
      * For nested populated arrays, every leaf record must carry this field.
-     * Records missing the id field throw a descriptive `ProcessorPathError`.
+     * Records missing the id field throw a descriptive `Error`.
      * Primitive array members (non-record scalars) cannot be depopulated and
      * are left in place as a safe no-op.
      */
     idField?: string;
 }
+/**
+ * Conservative default output for {@link copyAndDepopulate}.
+ *
+ * The exact transformed shape depends on runtime path strings, so the default
+ * type intentionally does not claim that populated input leaves still have
+ * their original object shape. Provide an explicit output type argument when
+ * the operation set is known by the caller.
+ */
+type CopyAndDepopulateOutput = Record<string, unknown>;
 /**
  * Hardened processor that relocates populated documents to a destination
  * path and replaces the original location with their proposed
@@ -75,8 +83,12 @@ interface CopyAndDepopulateOptions {
  *   `Object.prototype` or any object's prototype.
  * - Empty `src` or `dest` strings are safe no-ops.
  *
- * @typeParam T - Object shape produced by the depopulation.
+ * @typeParam Output - Object shape produced by the depopulation. Defaults to a
+ * conservative record because `src` and `dest` are runtime paths.
+ *
+ * @throws Error when an operation path contains `__proto__`, `prototype`, or
+ * `constructor`, or when a populated record is missing the configured id field.
  */
-declare const copyAndDepopulate: <T extends object>(docObject: T, operations: ProcessCopy[], options?: CopyAndDepopulateOptions) => T;
+declare const copyAndDepopulate: <Output extends object = CopyAndDepopulateOutput>(docObject: object, operations: ProcessCopy[], options?: CopyAndDepopulateOptions) => Output;
 
-export { type CopyAndDepopulateOptions, type ProcessCopy, copyAndDepopulate };
+export { type CopyAndDepopulateOptions, type CopyAndDepopulateOutput, type ProcessCopy, copyAndDepopulate };