@elsikora/nestjs-crud-automator 3.0.2 → 4.0.0-dev.2

package/dist/esm/package.json

@@ -3,6 +3,7 @@
   "dependencies": {
     "@elsikora/pluralizer": "^2.0.0",
     "dotenv": "^17.4.2",
+    "path-to-regexp": "^8.4.2",
     "reflect-metadata": "^0.2.2",
     "rxjs": "^7.8.2"
   }

package/dist/esm/type/api-request-transformer.type.d.ts

@@ -1,11 +1,13 @@
 import { TRANSFORMER_VALUE_DTO_CONSTANT } from '../constant/dto';
 import { EApiControllerRequestTransformerType } from '../enum/decorator/api';
-import { IApiGetListResponseResult } from '../interface/decorator/api';
+import { IApiGetListCursorResponseResult, IApiGetListResponseResult } from '../interface/decorator/api';
 export type TApiRequestTransformer<E> = {
     key: keyof {
+        after: string;
+        before: string;
         limit: number;
         page: number;
-    } | keyof IApiGetListResponseResult<E> | keyof Partial<E>;
+    } | keyof IApiGetListCursorResponseResult<E> | keyof IApiGetListResponseResult<E> | keyof Partial<E>;
     shouldSetValueEvenIfMissing?: boolean;
 } & ({
     type: EApiControllerRequestTransformerType.DYNAMIC;

package/dist/esm/type/class/api/authorization/policy/before/get/list-result.type.d.ts

@@ -1,5 +1,6 @@
+import { EApiControllerGetListQueryPaginationMode } from '../../../../../../../enum/decorator/api';
 import { EApiRouteType } from '../../../../../../../enum/decorator/api/route';
 import { IApiBaseEntity } from '../../../../../../../interface/api-base-entity.interface';
 import { TApiAuthorizationPolicyHookResult } from '../../hook';
 import { TApiAuthorizationPolicySubscriberRuleResult } from '../../subscriber';
-export type TApiAuthorizationPolicyBeforeGetListResult<E extends IApiBaseEntity> = TApiAuthorizationPolicySubscriberRuleResult<E, TApiAuthorizationPolicyHookResult<EApiRouteType.GET_LIST, E>>;
+export type TApiAuthorizationPolicyBeforeGetListResult<E extends IApiBaseEntity, M extends EApiControllerGetListQueryPaginationMode = EApiControllerGetListQueryPaginationMode.PAGE> = TApiAuthorizationPolicySubscriberRuleResult<E, TApiAuthorizationPolicyHookResult<EApiRouteType.GET_LIST, E, M>>;

package/dist/esm/type/class/api/authorization/policy/context/before/get/list-context.type.d.ts

@@ -1,8 +1,9 @@
+import { EApiControllerGetListQueryPaginationMode } from '../../../../../../../../enum/decorator/api';
 import { IApiBaseEntity } from '../../../../../../../../interface/api-base-entity.interface';
 import { TApiAuthorizationPolicyContextWithRequestMetadata } from '../../with-request-metadata.type';
 import { TApiControllerGetListQuery } from '../../../../../../../decorator/api/controller';
-export type TApiAuthorizationPolicyBeforeGetListContext<E extends IApiBaseEntity> = TApiAuthorizationPolicyContextWithRequestMetadata<E, {
+export type TApiAuthorizationPolicyBeforeGetListContext<E extends IApiBaseEntity, M extends EApiControllerGetListQueryPaginationMode = EApiControllerGetListQueryPaginationMode.PAGE> = TApiAuthorizationPolicyContextWithRequestMetadata<E, {
     headers: Record<string, string>;
     ip: string;
-    query: TApiControllerGetListQuery<E>;
-}>;
+    query: TApiControllerGetListQuery<E, M>;
+}, M>;

package/dist/esm/type/class/api/authorization/policy/context/with-request-metadata.type.d.ts

@@ -1,7 +1,8 @@
+import { EApiControllerGetListQueryPaginationMode } from '../../../../../../enum/decorator/api';
 import { IApiBaseEntity } from '../../../../../../interface/api-base-entity.interface';
 import { IApiAuthorizationPolicySubscriberContextData } from '../../../../../../interface/class/api/authorization/policy/subscriber/context';
 import { IApiAuthorizationPolicySubscriberContext } from '../../../../../../interface/class/api/authorization/policy/subscriber/context/interface';
 import { IApiAuthorizationRequestMetadata } from '../../../../../../interface/class/api/authorization/request-metadata.interface';
-export type TApiAuthorizationPolicyContextWithRequestMetadata<E extends IApiBaseEntity, TRequestMetadata extends IApiAuthorizationRequestMetadata<E>> = {
-    readonly DATA: Omit<IApiAuthorizationPolicySubscriberContextData<E>, keyof TRequestMetadata> & TRequestMetadata;
-} & Omit<IApiAuthorizationPolicySubscriberContext<E>, "DATA" | keyof TRequestMetadata> & TRequestMetadata;
+export type TApiAuthorizationPolicyContextWithRequestMetadata<E extends IApiBaseEntity, TRequestMetadata extends IApiAuthorizationRequestMetadata<E, M>, M extends EApiControllerGetListQueryPaginationMode = EApiControllerGetListQueryPaginationMode.PAGE> = {
+    readonly DATA: Omit<IApiAuthorizationPolicySubscriberContextData<E, M>, keyof TRequestMetadata> & TRequestMetadata;
+} & Omit<IApiAuthorizationPolicySubscriberContext<E, M>, "DATA" | keyof TRequestMetadata> & TRequestMetadata;

package/dist/esm/type/class/api/authorization/policy/hook/execution-result.type.d.ts

@@ -0,0 +1,5 @@
+import { EApiControllerGetListQueryPaginationMode } from '../../../../../../enum/decorator/api';
+import { IApiBaseEntity } from '../../../../../../interface/api-base-entity.interface';
+import { TApiAuthorizationPolicyHookResult } from './result.type';
+import { TApiAuthorizationPolicySubscriberRuleResult } from '../subscriber';
+export type TApiAuthorizationPolicyHookExecutionResult<E extends IApiBaseEntity, TAction extends string, M extends EApiControllerGetListQueryPaginationMode> = Promise<TApiAuthorizationPolicySubscriberRuleResult<E, TApiAuthorizationPolicyHookResult<TAction, E, M>>> | TApiAuthorizationPolicySubscriberRuleResult<E, TApiAuthorizationPolicyHookResult<TAction, E, M>>;

package/dist/esm/type/class/api/authorization/policy/hook/result.type.d.ts

@@ -1,8 +1,9 @@
+import { EApiControllerGetListQueryPaginationMode } from '../../../../../../enum/decorator/api';
 import { EApiRouteType } from '../../../../../../enum/decorator/api/route';
 import { IApiBaseEntity } from '../../../../../../interface/api-base-entity.interface';
-import { IApiGetListResponseResult } from '../../../../../../interface/decorator/api/get-list-response-result.interface';
 import { TApiAuthorizationRuleTransformPayload } from '../../rule/transform-payload.type';
+import { TApiControllerGetListResponse } from '../../../../../decorator/api/controller';
 /**
  * Maps a policy hook/action to the payload type its transforms will receive.
  */
-export type TApiAuthorizationPolicyHookResult<TAction extends string, E extends IApiBaseEntity> = TAction extends EApiRouteType.CREATE ? E : TAction extends EApiRouteType.GET ? E : TAction extends EApiRouteType.GET_LIST ? IApiGetListResponseResult<E> : TAction extends EApiRouteType.PARTIAL_UPDATE ? E : TAction extends EApiRouteType.UPDATE ? E : TAction extends EApiRouteType.DELETE ? undefined : TApiAuthorizationRuleTransformPayload<E>;
+export type TApiAuthorizationPolicyHookResult<TAction extends string, E extends IApiBaseEntity, M extends EApiControllerGetListQueryPaginationMode = EApiControllerGetListQueryPaginationMode.PAGE> = TAction extends EApiRouteType.CREATE ? E : TAction extends EApiRouteType.GET ? E : TAction extends EApiRouteType.GET_LIST ? TApiControllerGetListResponse<E, M> : TAction extends EApiRouteType.PARTIAL_UPDATE ? E : TAction extends EApiRouteType.UPDATE ? E : TAction extends EApiRouteType.DELETE ? undefined : TApiAuthorizationRuleTransformPayload<E>;

package/dist/esm/type/class/api/authorization/policy/hook/type.d.ts

@@ -1,5 +1,6 @@
+import { EApiControllerGetListQueryPaginationMode } from '../../../../../../enum/decorator/api';
 import { IApiBaseEntity } from '../../../../../../interface/api-base-entity.interface';
 import { IApiAuthorizationPolicySubscriberContext } from '../../../../../../interface/class/api/authorization';
 import { TApiAuthorizationPolicyHookResult } from './result.type';
 import { TApiAuthorizationPolicySubscriberRuleResult } from '../subscriber';
-export type TApiAuthorizationPolicyHook<E extends IApiBaseEntity, TAction extends string> = (context: IApiAuthorizationPolicySubscriberContext<E>) => Promise<TApiAuthorizationPolicySubscriberRuleResult<E, TApiAuthorizationPolicyHookResult<TAction, E>>> | TApiAuthorizationPolicySubscriberRuleResult<E, TApiAuthorizationPolicyHookResult<TAction, E>>;
+export type TApiAuthorizationPolicyHook<E extends IApiBaseEntity, TAction extends string, M extends EApiControllerGetListQueryPaginationMode = EApiControllerGetListQueryPaginationMode.PAGE> = (context: IApiAuthorizationPolicySubscriberContext<E, M>) => Promise<TApiAuthorizationPolicySubscriberRuleResult<E, TApiAuthorizationPolicyHookResult<TAction, E, M>>> | TApiAuthorizationPolicySubscriberRuleResult<E, TApiAuthorizationPolicyHookResult<TAction, E, M>>;

package/dist/esm/type/class/api/authorization/rule/transform-payload.type.d.ts

@@ -1,3 +1,3 @@
 import { IApiBaseEntity } from '../../../../../interface/api-base-entity.interface';
-import { IApiGetListResponseResult } from '../../../../../interface/decorator/api/get-list-response-result.interface';
-export type TApiAuthorizationRuleTransformPayload<E extends IApiBaseEntity> = Array<unknown> | boolean | E | IApiGetListResponseResult<E> | null | number | object | Partial<E> | Record<string, unknown> | string | undefined;
+import { IApiGetListCursorResponseResult, IApiGetListResponseResult } from '../../../../../interface/decorator/api';
+export type TApiAuthorizationRuleTransformPayload<E extends IApiBaseEntity> = Array<unknown> | boolean | E | IApiGetListCursorResponseResult<E> | IApiGetListResponseResult<E> | null | number | object | Partial<E> | Record<string, unknown> | string | undefined;

package/dist/esm/type/class/api/controller/generated/function.type.d.ts

@@ -0,0 +1 @@
+export type TApiControllerGeneratedFunction = (...arguments_: Array<never>) => unknown;

package/dist/esm/type/class/api/controller/generated/index.d.ts

@@ -0,0 +1,2 @@
+export { type TApiControllerGeneratedFunction } from './function.type';
+export { type TApiControllerGeneratedScopeFunctionType } from './scope-function-type.type';

package/dist/esm/type/class/api/controller/generated/scope-function-type.type.d.ts

@@ -0,0 +1,2 @@
+import { EApiFunctionType } from '../../../../../enum/decorator/api';
+export type TApiControllerGeneratedScopeFunctionType = EApiFunctionType.DELETE | EApiFunctionType.GET | EApiFunctionType.GET_LIST | EApiFunctionType.GET_MANY | EApiFunctionType.UPDATE;

package/dist/esm/type/class/api/controller/get-list/compiled/index.d.ts

@@ -0,0 +1,3 @@
+export { type TApiControllerGetListQueryCompiledOrderField } from './order-field.type';
+export { type TApiControllerGetListQueryCompiledOrder } from './order.type';
+export { type TApiControllerGetListQueryCompiledPlan } from './plan.type';

package/dist/esm/type/class/api/controller/get-list/compiled/order-field.type.d.ts

@@ -0,0 +1,16 @@
+import { EApiPropertyDescribeType } from '../../../../../../enum/decorator/api';
+import { IApiControllerGetListQueryPlanOrderField } from '../../../../../../interface/class/api/controller/get-list/query';
+import { TApiPropertyDescribeProperties } from '../../../../../decorator/api/property';
+export type TApiControllerGetListQueryCompiledOrderField = {
+    columnMode: string;
+    columnType: string;
+    hasTransformer: boolean;
+    isColumnArray: boolean;
+    isNullable: boolean;
+    isSelected: boolean;
+    isUnsigned: boolean;
+    metadata: Readonly<TApiPropertyDescribeProperties>;
+    precision?: null | number;
+    scale?: number;
+    type: EApiPropertyDescribeType;
+} & IApiControllerGetListQueryPlanOrderField;

package/dist/esm/type/class/api/controller/get-list/compiled/order.type.d.ts

@@ -0,0 +1,6 @@
+import { IApiControllerGetListQueryPlanOrder } from '../../../../../../interface/class/api/controller/get-list/query';
+import { TApiControllerGetListQueryCompiledOrderField } from './order-field.type';
+export type TApiControllerGetListQueryCompiledOrder = {
+    fields: Readonly<Record<string, TApiControllerGetListQueryCompiledOrderField>>;
+    serverFields: Readonly<Record<string, TApiControllerGetListQueryCompiledOrderField>>;
+} & Omit<IApiControllerGetListQueryPlanOrder, "fields">;

package/dist/esm/type/class/api/controller/get-list/compiled/plan.type.d.ts

@@ -0,0 +1,8 @@
+import { EApiControllerGetListQueryPaginationMode } from '../../../../../../enum/decorator/api';
+import { IApiControllerGetListQueryPlan } from '../../../../../../interface/class/api/controller/get-list/query';
+import { IApiControllerGetListQueryPlanPagination } from '../../../../../../interface/class/api/controller/get-list/query/plan/pagination.interface';
+import { TApiControllerGetListQueryCompiledOrder } from './order.type';
+export type TApiControllerGetListQueryCompiledPlan<M extends EApiControllerGetListQueryPaginationMode = EApiControllerGetListQueryPaginationMode> = {
+    order: TApiControllerGetListQueryCompiledOrder;
+    pagination: IApiControllerGetListQueryPlanPagination<M>;
+} & Omit<IApiControllerGetListQueryPlan, "order">;

package/dist/esm/type/class/api/controller/get-list/cursor/execution-options.type.d.ts

@@ -0,0 +1,18 @@
+import { EApiControllerGetListQueryPaginationMode } from '../../../../../../enum/decorator/api';
+import { IApiBaseEntity } from '../../../../../../interface/api-base-entity.interface';
+import { IApiControllerGetListQueryPlanOrderEntry } from '../../../../../../interface/class/api/controller/get-list/query';
+import { TApiControllerGetListQueryCompiledOrderField } from '../compiled/order-field.type';
+import { TApiControllerGetListQueryCompiledPlan } from '../compiled/plan.type';
+import { TApiFunctionGetManyProperties } from '../../../../../decorator/api/function';
+export type TApiControllerGetListCursorExecutionOptions<E extends IApiBaseEntity> = {
+    baseProperties: TApiFunctionGetManyProperties<E>;
+    contextHash: string;
+    cursor?: string;
+    direction?: "after" | "before";
+    limit: number;
+    onBeforeQuery: () => void;
+    order: ReadonlyArray<IApiControllerGetListQueryPlanOrderEntry>;
+    plan: TApiControllerGetListQueryCompiledPlan<EApiControllerGetListQueryPaginationMode.CURSOR>;
+    run: (properties: TApiFunctionGetManyProperties<E>) => Promise<Array<E>>;
+    validateStorageValue: (field: TApiControllerGetListQueryCompiledOrderField, value: unknown) => void;
+};

package/dist/esm/type/class/api/controller/get-list/cursor/index.d.ts

@@ -0,0 +1,2 @@
+export { type TApiControllerGetListCursorExecutionOptions } from './execution-options.type';
+export { type TApiControllerGetListCursorQueryRuntimeResult } from './query-runtime-result.type';

package/dist/esm/type/class/api/controller/get-list/cursor/query-runtime-result.type.d.ts

@@ -0,0 +1,8 @@
+import { EApiControllerGetListQueryPaginationMode } from '../../../../../../enum/decorator/api';
+import { IApiControllerGetListQueryRuntimeResult } from '../../../../../../interface/class/api/controller/get-list/query';
+export type TApiControllerGetListCursorQueryRuntimeResult = {
+    after?: string;
+    before?: string;
+    page: undefined;
+    paginationMode: EApiControllerGetListQueryPaginationMode.CURSOR;
+} & Omit<IApiControllerGetListQueryRuntimeResult, "page">;

package/dist/esm/type/class/api/controller/get-list/index.d.ts

@@ -0,0 +1,2 @@
+export type * from './compiled';
+export type * from './cursor';

package/dist/esm/type/class/api/controller/index.d.ts

@@ -0,0 +1 @@
+export type * from './generated';

package/dist/esm/type/class/api/subscriber/route/after/get/list-context.type.d.ts

@@ -1,4 +1,5 @@
+import { EApiControllerGetListQueryPaginationMode } from '../../../../../../../enum/decorator/api';
 import { IApiBaseEntity } from '../../../../../../../interface/api-base-entity.interface';
 import { IApiSubscriberRouteExecutionContextDataExtended, IApiSubscriberRouteExecutionContext } from '../../../../../../../interface/class/api/subscriber/route/execution/context';
-import { IApiGetListResponseResult } from '../../../../../../../interface/decorator/api/get-list-response-result.interface';
-export type TApiSubscriberRouteAfterGetListContext<E extends IApiBaseEntity> = IApiSubscriberRouteExecutionContext<E, IApiGetListResponseResult<E>, IApiSubscriberRouteExecutionContextDataExtended<E, IApiGetListResponseResult<E>>>;
+import { TApiControllerGetListResponse } from '../../../../../../decorator/api/controller';
+export type TApiSubscriberRouteAfterGetListContext<E extends IApiBaseEntity, M extends EApiControllerGetListQueryPaginationMode = EApiControllerGetListQueryPaginationMode.PAGE> = IApiSubscriberRouteExecutionContext<E, TApiControllerGetListResponse<E, M>, IApiSubscriberRouteExecutionContextDataExtended<E, TApiControllerGetListResponse<E, M>, M>>;

package/dist/esm/type/class/api/subscriber/route/before/get/list-context.type.d.ts

@@ -1,13 +1,12 @@
-import { EApiRouteSubscriberAuthorizationExpectation } from '../../../../../../../enum/decorator/api';
+import { EApiControllerGetListQueryPaginationMode, EApiRouteSubscriberAuthorizationExpectation } from '../../../../../../../enum/decorator/api';
 import { IApiBaseEntity } from '../../../../../../../interface/api-base-entity.interface';
 import { IApiAuthenticationRequest } from '../../../../../../../interface/api/authentication-request.interface';
 import { IApiSubscriberRouteExecutionContextData, IApiSubscriberRouteExecutionContext } from '../../../../../../../interface/class/api/subscriber/route/execution/context';
-import { IApiGetListResponseResult } from '../../../../../../../interface/decorator/api';
 import { TApiSubscriberRouteAuthorizationResult } from '../../authorization';
-import { TApiControllerGetListQuery } from '../../../../../../decorator/api/controller';
-export type TApiSubscriberRouteBeforeGetListContext<E extends IApiBaseEntity, TAuthorizationExpectation extends EApiRouteSubscriberAuthorizationExpectation = EApiRouteSubscriberAuthorizationExpectation.OPTIONAL> = IApiSubscriberRouteExecutionContext<E, TApiSubscriberRouteAuthorizationResult<E, {
+import { TApiControllerGetListQuery, TApiControllerGetListResponse } from '../../../../../../decorator/api/controller';
+export type TApiSubscriberRouteBeforeGetListContext<E extends IApiBaseEntity, TAuthorizationExpectation extends EApiRouteSubscriberAuthorizationExpectation = EApiRouteSubscriberAuthorizationExpectation.OPTIONAL, M extends EApiControllerGetListQueryPaginationMode = EApiControllerGetListQueryPaginationMode.PAGE> = IApiSubscriberRouteExecutionContext<E, TApiSubscriberRouteAuthorizationResult<E, {
     authenticationRequest?: IApiAuthenticationRequest;
     headers: Record<string, string>;
     ip: string;
-    query: TApiControllerGetListQuery<E>;
-}, TAuthorizationExpectation, IApiGetListResponseResult<E>>, IApiSubscriberRouteExecutionContextData<E, IApiGetListResponseResult<E>>>;
+    query: TApiControllerGetListQuery<E, M>;
+}, TAuthorizationExpectation, TApiControllerGetListResponse<E, M>>, IApiSubscriberRouteExecutionContextData<E, TApiControllerGetListResponse<E, M>>>;

package/dist/esm/type/decorator/api/controller/get-list/index.d.ts

@@ -1 +1,2 @@
 export type * from './query';
+export { type TApiControllerGetListResponse } from './response.type';

package/dist/esm/type/decorator/api/controller/get-list/query/dto-contract.type.d.ts

@@ -7,6 +7,7 @@ export type TApiControllerGetListQueryDtoContract<E> = ({
         [EApiControllerRequestTarget.QUERY]?: {
             filter?: never;
             order?: never;
+            pagination?: never;
         } & IApiControllerPropertiesRouteBaseRequestTarget<E>;
     };
 } | {

package/dist/esm/type/decorator/api/controller/get-list/query/request-target.type.d.ts

@@ -0,0 +1,7 @@
+import { EApiControllerGetListQueryPaginationMode } from '../../../../../../enum/decorator/api';
+import { IApiControllerPropertiesRouteGetListQueryPagination, IApiControllerPropertiesRouteGetListQueryRequestTarget } from '../../../../../../interface/decorator/api';
+export type TApiControllerGetListQueryRequestTarget<E> = ({
+    pagination: IApiControllerPropertiesRouteGetListQueryPagination<EApiControllerGetListQueryPaginationMode.CURSOR>;
+} & Omit<IApiControllerPropertiesRouteGetListQueryRequestTarget<E, EApiControllerGetListQueryPaginationMode.CURSOR>, "pagination">) | ({
+    pagination?: IApiControllerPropertiesRouteGetListQueryPagination;
+} & Omit<IApiControllerPropertiesRouteGetListQueryRequestTarget<E>, "pagination">);

package/dist/esm/type/decorator/api/controller/get-list/query/type.d.ts

@@ -1,8 +1,28 @@
+import { EApiControllerGetListQueryPaginationMode } from '../../../../../../enum/decorator/api';
 import { EFilterOrderDirection } from '../../../../../../enum/filter';
 import { TFilterKeys } from '../../../../../utility';
-export type TApiControllerGetListQuery<E> = {
+export type TApiControllerGetListQuery<E, M extends EApiControllerGetListQueryPaginationMode = EApiControllerGetListQueryPaginationMode.PAGE> = {
     limit: number;
+} & (M extends EApiControllerGetListQueryPaginationMode.CURSOR ? ({
+    after: string;
+    before?: never;
+    page?: never;
+} | {
+    after?: never;
+    before: string;
+    page?: never;
+} | {
+    after?: never;
+    before?: never;
+    page?: never;
+}) & ({
+    orderBy: keyof E;
+    orderDirection: EFilterOrderDirection;
+} | {
+    orderBy?: never;
+    orderDirection?: never;
+}) : {
     orderBy?: keyof E;
     orderDirection?: EFilterOrderDirection;
     page: number;
-} & Partial<TFilterKeys<E>>;
+}) & Partial<TFilterKeys<E>>;

package/dist/esm/type/decorator/api/controller/get-list/response.type.d.ts

@@ -0,0 +1,3 @@
+import { EApiControllerGetListQueryPaginationMode } from '../../../../../enum/decorator/api';
+import { IApiGetListCursorResponseResult, IApiGetListResponseResult } from '../../../../../interface/decorator/api';
+export type TApiControllerGetListResponse<T, M extends EApiControllerGetListQueryPaginationMode = EApiControllerGetListQueryPaginationMode.PAGE> = M extends EApiControllerGetListQueryPaginationMode.CURSOR ? IApiGetListCursorResponseResult<T> : IApiGetListResponseResult<T>;

package/dist/esm/type/decorator/api/controller/index.d.ts

@@ -2,4 +2,5 @@ export { type TApiControllerConstructor } from './constructor.type';
 export type * from './get-list';
 export { type TApiControllerPropertiesRoute } from './properties-route.type';
 export type * from './properties/route';
+export type * from './read';
 export { type TApiControllerTransformerConfig } from './transformer-config.type';

package/dist/esm/type/decorator/api/controller/properties/route/contract.type.d.ts

@@ -0,0 +1,5 @@
+import { EApiRouteType } from '../../../../../../enum/decorator/api';
+import { IApiControllerPropertiesRouteWithAutoDto, IApiControllerPropertiesRouteWithDto } from '../../../../../../interface/decorator/api';
+import { TApiControllerGetListQueryDtoContract } from '../../get-list/query';
+import { TApiControllerPropertiesRouteWithoutRead, TApiControllerPropertiesRouteWithRead } from './read';
+export type TApiControllerPropertiesRouteContract<E, R extends EApiRouteType> = (R extends EApiRouteType.GET | EApiRouteType.GET_LIST ? TApiControllerPropertiesRouteWithRead<E, IApiControllerPropertiesRouteWithAutoDto<E, R> | (R extends EApiRouteType.GET_LIST ? TApiControllerGetListQueryDtoContract<E> : IApiControllerPropertiesRouteWithDto<E, R>)> : never) | TApiControllerPropertiesRouteWithoutRead<IApiControllerPropertiesRouteWithAutoDto<E, R>> | TApiControllerPropertiesRouteWithoutRead<R extends EApiRouteType.GET_LIST ? TApiControllerGetListQueryDtoContract<E> : IApiControllerPropertiesRouteWithDto<E, R>>;

package/dist/esm/type/decorator/api/controller/properties/route/identity/index.d.ts

@@ -0,0 +1,2 @@
+export { type TApiControllerPropertiesRouteWithIdentity } from './with.type';
+export { type TApiControllerPropertiesRouteWithoutIdentity } from './without.type';

package/dist/esm/type/decorator/api/controller/properties/route/identity/with.type.d.ts

@@ -0,0 +1,11 @@
+import { EApiControllerRequestTarget } from '../../../../../../../enum/decorator/api';
+import { IApiControllerPropertiesRouteIdentity, IApiControllerPropertiesRouteReadParametersRequestTarget } from '../../../../../../../interface/decorator/api';
+import { TApiControllerPropertiesRouteWithReadDto } from '../read';
+export type TApiControllerPropertiesRouteWithIdentity<E, T extends {
+    request?: unknown;
+}> = T extends unknown ? {
+    identity: IApiControllerPropertiesRouteIdentity;
+    request?: {
+        [EApiControllerRequestTarget.PARAMETERS]?: IApiControllerPropertiesRouteReadParametersRequestTarget<E>;
+    } & Omit<NonNullable<T["request"]>, EApiControllerRequestTarget.PARAMETERS>;
+} & Omit<T, "dto" | "identity" | "request"> & TApiControllerPropertiesRouteWithReadDto<T> : never;

package/dist/esm/type/decorator/api/controller/properties/route/identity/without.type.d.ts

@@ -0,0 +1,3 @@
+export type TApiControllerPropertiesRouteWithoutIdentity<T> = T extends unknown ? {
+    identity?: never;
+} & T : never;

package/dist/esm/type/decorator/api/controller/properties/route/read/dto.type.d.ts

@@ -0,0 +1,10 @@
+import { TApiControllerPropertiesRouteWithoutParametersDto } from '../without-parameters-dto.type';
+export type TApiControllerPropertiesRouteWithReadDto<T> = T extends {
+    dto: infer D;
+} ? {
+    dto: TApiControllerPropertiesRouteWithoutParametersDto<D>;
+} : T extends {
+    dto?: infer D;
+} ? {
+    dto?: TApiControllerPropertiesRouteWithoutParametersDto<D>;
+} : object;

package/dist/esm/type/decorator/api/controller/properties/route/read/index.d.ts

@@ -0,0 +1,3 @@
+export { type TApiControllerPropertiesRouteWithReadDto } from './dto.type';
+export { type TApiControllerPropertiesRouteWithRead } from './with.type';
+export { type TApiControllerPropertiesRouteWithoutRead } from './without.type';

package/dist/esm/type/decorator/api/controller/properties/route/read/with.type.d.ts

@@ -0,0 +1,11 @@
+import { EApiControllerRequestTarget } from '../../../../../../../enum/decorator/api';
+import { IApiControllerPropertiesRouteBaseRead, IApiControllerPropertiesRouteReadParametersRequestTarget } from '../../../../../../../interface/decorator/api';
+import { TApiControllerPropertiesRouteWithReadDto } from './dto.type';
+export type TApiControllerPropertiesRouteWithRead<E, T extends {
+    request?: unknown;
+}> = T extends unknown ? {
+    read: IApiControllerPropertiesRouteBaseRead<E>;
+    request?: {
+        [EApiControllerRequestTarget.PARAMETERS]?: IApiControllerPropertiesRouteReadParametersRequestTarget<E>;
+    } & Omit<NonNullable<T["request"]>, EApiControllerRequestTarget.PARAMETERS>;
+} & Omit<T, "dto" | "request"> & TApiControllerPropertiesRouteWithReadDto<T> : never;

package/dist/esm/type/decorator/api/controller/properties/route/read/without.type.d.ts

@@ -0,0 +1,3 @@
+export type TApiControllerPropertiesRouteWithoutRead<T> = T extends unknown ? {
+    read?: never;
+} & T : never;

package/dist/esm/type/decorator/api/controller/properties/route/without-parameters-dto.type.d.ts

@@ -0,0 +1,4 @@
+import { EApiDtoType } from '../../../../../../enum/decorator/api';
+export type TApiControllerPropertiesRouteWithoutParametersDto<D> = D extends object ? {
+    [EApiDtoType.PARAMETERS]?: never;
+} & Omit<D, EApiDtoType.PARAMETERS> : D;

package/dist/esm/type/decorator/api/controller/properties-route.type.d.ts

@@ -1,4 +1,4 @@
 import { EApiRouteType } from '../../../../enum/decorator/api';
-import { IApiControllerPropertiesRouteWithAutoDto, IApiControllerPropertiesRouteWithDto } from '../../../../interface/decorator/api';
-import { TApiControllerGetListQueryDtoContract } from './get-list/query';
-export type TApiControllerPropertiesRoute<E, R extends EApiRouteType> = IApiControllerPropertiesRouteWithAutoDto<E, R> | (R extends EApiRouteType.GET_LIST ? TApiControllerGetListQueryDtoContract<E> : IApiControllerPropertiesRouteWithDto<E, R>);
+import { TApiControllerPropertiesRouteContract } from './properties/route/contract.type';
+import { TApiControllerPropertiesRouteWithIdentity, TApiControllerPropertiesRouteWithoutIdentity } from './properties/route/identity';
+export type TApiControllerPropertiesRoute<E, R extends EApiRouteType> = (R extends EApiRouteType.GET ? TApiControllerPropertiesRouteWithIdentity<E, TApiControllerPropertiesRouteContract<E, R>> : never) | TApiControllerPropertiesRouteWithoutIdentity<TApiControllerPropertiesRouteContract<E, R>>;

package/dist/esm/type/decorator/api/controller/read/direct-scalar-field.type.d.ts

@@ -0,0 +1,2 @@
+import { TApiControllerGetListQueryDirectScalarPath } from '../get-list/query/path';
+export type TApiControllerReadDirectScalarField<E> = TApiControllerGetListQueryDirectScalarPath<E>;

package/dist/esm/type/decorator/api/controller/read/index.d.ts

@@ -0,0 +1,2 @@
+export { type TApiControllerReadDirectScalarField } from './direct-scalar-field.type';
+export { type TApiControllerReadParameterTransformer } from './parameter-transformer';

package/dist/esm/type/decorator/api/controller/read/parameter-transformer/index.d.ts

@@ -0,0 +1 @@
+export { type TApiControllerReadParameterTransformer } from './type';

package/dist/esm/type/decorator/api/controller/read/parameter-transformer/type.d.ts

@@ -0,0 +1,3 @@
+import { TApiRequestTransformer } from '../../../../../api-request-transformer.type';
+import { TApiControllerReadParameterTransformerWithStringKey } from './with-string-key.type';
+export type TApiControllerReadParameterTransformer<E> = TApiControllerReadParameterTransformerWithStringKey<TApiRequestTransformer<E>>;

package/dist/esm/type/decorator/api/controller/read/parameter-transformer/with-string-key.type.d.ts

@@ -0,0 +1,5 @@
+export type TApiControllerReadParameterTransformerWithStringKey<T> = T extends {
+    key: unknown;
+} ? {
+    key: string;
+} & Omit<T, "key"> : never;

package/dist/esm/type/decorator/api/property/describe/properties/base/properties.type.d.ts

@@ -3,7 +3,7 @@ import { TApiPropertyDescribePropertiesBaseDtoProperties } from '../../..';
 export type TApiPropertyDescribePropertiesBaseProperties = {
     [EApiRouteType.CREATE]?: Pick<TApiPropertyDescribePropertiesBaseDtoProperties, EApiDtoType.BODY | EApiDtoType.RESPONSE>;
     [EApiRouteType.DELETE]?: Pick<TApiPropertyDescribePropertiesBaseDtoProperties, EApiDtoType.PARAMETERS>;
-    [EApiRouteType.GET_LIST]?: Pick<TApiPropertyDescribePropertiesBaseDtoProperties, EApiDtoType.QUERY | EApiDtoType.RESPONSE>;
+    [EApiRouteType.GET_LIST]?: Pick<TApiPropertyDescribePropertiesBaseDtoProperties, EApiDtoType.PARAMETERS | EApiDtoType.QUERY | EApiDtoType.RESPONSE>;
     [EApiRouteType.GET]?: Pick<TApiPropertyDescribePropertiesBaseDtoProperties, EApiDtoType.PARAMETERS | EApiDtoType.RESPONSE>;
     [EApiRouteType.PARTIAL_UPDATE]?: Pick<TApiPropertyDescribePropertiesBaseDtoProperties, EApiDtoType.BODY | EApiDtoType.PARAMETERS | EApiDtoType.RESPONSE>;
     [EApiRouteType.UPDATE]?: Pick<TApiPropertyDescribePropertiesBaseDtoProperties, EApiDtoType.BODY | EApiDtoType.PARAMETERS | EApiDtoType.RESPONSE>;

package/dist/esm/type/factory/api/controller/method/map.type.d.ts

@@ -1,12 +1,11 @@
-import { EApiRouteType } from '../../../../../enum/decorator/api';
+import { EApiControllerGetListQueryPaginationMode, EApiRouteType } from '../../../../../enum/decorator/api';
 import { IApiAuthenticationRequest } from '../../../../../interface/api/authentication-request.interface';
-import { IApiGetListResponseResult } from '../../../../../interface/decorator/api';
-import { TApiControllerGetListQuery } from '../../../../decorator/api/controller';
+import { TApiControllerGetListQuery, TApiControllerGetListResponse } from '../../../../decorator/api/controller';
 import { DeepPartial } from 'typeorm';
-export type TApiControllerMethodMap<E> = {
+export type TApiControllerMethodMap<E, M extends EApiControllerGetListQueryPaginationMode = EApiControllerGetListQueryPaginationMode.PAGE> = {
     [EApiRouteType.CREATE]: (body: DeepPartial<E>, headers: Record<string, string>, ip: string, authenticationRequest?: IApiAuthenticationRequest) => Promise<E>;
     [EApiRouteType.DELETE]: (parameters: Partial<E>, headers: Record<string, string>, ip: string, authenticationRequest?: IApiAuthenticationRequest) => Promise<void>;
-    [EApiRouteType.GET_LIST]: (query: TApiControllerGetListQuery<E>, headers: Record<string, string>, ip: string, authenticationRequest?: IApiAuthenticationRequest) => Promise<IApiGetListResponseResult<E>>;
+    [EApiRouteType.GET_LIST]: (query: TApiControllerGetListQuery<E, M>, headers: Record<string, string>, ip: string, authenticationRequest?: IApiAuthenticationRequest) => Promise<TApiControllerGetListResponse<E, M>>;
     [EApiRouteType.GET]: (parameters: Partial<E>, headers: Record<string, string>, ip: string, authenticationRequest?: IApiAuthenticationRequest) => Promise<E>;
     [EApiRouteType.PARTIAL_UPDATE]: (parameters: Partial<E>, body: DeepPartial<E>, headers: Record<string, string>, ip: string, authenticationRequest?: IApiAuthenticationRequest) => Promise<E>;
     [EApiRouteType.UPDATE]: (parameters: Partial<E>, body: DeepPartial<E>, headers: Record<string, string>, ip: string, authenticationRequest?: IApiAuthenticationRequest) => Promise<E>;

package/dist/esm/type/factory/api/controller/target-methods.type.d.ts

@@ -1,8 +1,8 @@
 import { ApiServiceBase } from '../../../../class/api';
-import { EApiRouteType } from '../../../../enum/decorator/api';
+import { EApiControllerGetListQueryPaginationMode, EApiRouteType } from '../../../../enum/decorator/api';
 import { TApiControllerMethodMap, TApiControllerMethodName } from './method';
-export type TApiControllerTargetMethod<E> = new (...arguments_: Array<any>) => {
-    [K in EApiRouteType as TApiControllerMethodName<K>]: TApiControllerMethodMap<E>[K];
+export type TApiControllerTargetMethod<E, M extends EApiControllerGetListQueryPaginationMode = EApiControllerGetListQueryPaginationMode.PAGE> = new (...arguments_: Array<any>) => {
+    [K in EApiRouteType as TApiControllerMethodName<K>]: TApiControllerMethodMap<E, M>[K];
 } & {
     service: ApiServiceBase<E>;
 };

package/dist/esm/type/utility/api/controller/transform-data/is-validation-properties.type.d.ts

@@ -1,3 +1,4 @@
-import { IApiGetListResponseResult } from '../../../../../interface/decorator/api';
+import { EApiControllerGetListQueryPaginationMode } from '../../../../../enum/decorator/api';
+import { IApiGetListCursorResponseResult, IApiGetListResponseResult } from '../../../../../interface/decorator/api';
 import { TApiControllerGetListQuery } from '../../../../decorator/api/controller';
-export type TApiTransformDataIsValidationProperties<E> = IApiGetListResponseResult<E> | Partial<E> | TApiControllerGetListQuery<E>;
+export type TApiTransformDataIsValidationProperties<E> = IApiGetListCursorResponseResult<E> | IApiGetListResponseResult<E> | Partial<E> | TApiControllerGetListQuery<E, EApiControllerGetListQueryPaginationMode>;

package/dist/esm/type/utility/api/controller/transform-data/object-to-transform.type.d.ts

@@ -1,9 +1,10 @@
-import { IApiGetListResponseResult } from '../../../../../interface/decorator/api';
+import { EApiControllerGetListQueryPaginationMode } from '../../../../../enum/decorator/api';
+import { IApiGetListCursorResponseResult, IApiGetListResponseResult } from '../../../../../interface/decorator/api';
 import { TApiControllerGetListQuery } from '../../../../decorator/api/controller';
 import { DeepPartial } from 'typeorm';
 export type TApiControllerTransformDataObjectToTransform<E> = {
     body?: DeepPartial<E>;
     parameters?: Partial<E>;
-    query?: TApiControllerGetListQuery<E>;
-    response?: IApiGetListResponseResult<E> | Partial<E>;
+    query?: TApiControllerGetListQuery<E, EApiControllerGetListQueryPaginationMode>;
+    response?: IApiGetListCursorResponseResult<E> | IApiGetListResponseResult<E> | Partial<E>;
 };

package/dist/esm/type/utility/api/controller/transform-data/runtime-transformer.type.d.ts

@@ -0,0 +1,3 @@
+import { TApiRequestTransformer } from '../../../../api-request-transformer.type';
+import { TApiControllerReadParameterTransformer } from '../../../../decorator/api/controller';
+export type TApiControllerRuntimeTransformer<E> = TApiControllerReadParameterTransformer<E> | TApiRequestTransformer<E>;

package/dist/esm/type/utility/api/controller/transform-data/targets.type.d.ts

@@ -0,0 +1,17 @@
+import { EApiControllerRequestTarget, EApiControllerResponseTarget } from '../../../../../enum/decorator/api';
+import { TApiRequestTransformer } from '../../../../api-request-transformer.type';
+import { TApiControllerRuntimeTransformer } from './runtime-transformer.type';
+export type TApiControllerTransformDataTargets<E> = {
+    [EApiControllerRequestTarget.BODY]?: {
+        transformers?: Array<TApiRequestTransformer<E>>;
+    };
+    [EApiControllerRequestTarget.PARAMETERS]?: {
+        transformers?: Array<TApiControllerRuntimeTransformer<E>>;
+    };
+    [EApiControllerRequestTarget.QUERY]?: {
+        transformers?: Array<TApiRequestTransformer<E>>;
+    };
+    [EApiControllerResponseTarget.RESPONSE]?: {
+        transformers?: Array<TApiRequestTransformer<E>>;
+    };
+};

package/dist/esm/type/utility/dto/generate/allowed-combination.type.d.ts

@@ -2,7 +2,7 @@ import { EApiDtoType, EApiRouteType } from '../../../../enum/decorator/api';
 export type TDtoGenerateAllowedCombinations = {
     [EApiRouteType.CREATE]: EApiDtoType.BODY | EApiDtoType.RESPONSE;
     [EApiRouteType.DELETE]: EApiDtoType.PARAMETERS;
-    [EApiRouteType.GET_LIST]: EApiDtoType.QUERY | EApiDtoType.RESPONSE;
+    [EApiRouteType.GET_LIST]: EApiDtoType.PARAMETERS | EApiDtoType.QUERY | EApiDtoType.RESPONSE;
     [EApiRouteType.GET]: EApiDtoType.PARAMETERS | EApiDtoType.RESPONSE;
     [EApiRouteType.PARTIAL_UPDATE]: EApiDtoType.BODY | EApiDtoType.PARAMETERS | EApiDtoType.RESPONSE;
     [EApiRouteType.UPDATE]: EApiDtoType.BODY | EApiDtoType.PARAMETERS | EApiDtoType.RESPONSE;

package/dist/esm/utility/api/controller/apply/decorators.utility.d.ts

@@ -1,10 +1,11 @@
+import { EApiControllerGetListQueryPaginationMode, EApiRouteType } from '../../../../enum/decorator/api';
 import { IApiBaseEntity } from '../../../../interface/api-base-entity.interface';
 import { IApiControllerGetListQueryPlan } from '../../../../interface/class/api/controller/get-list/query';
+import { IApiControllerIdentityPlan } from '../../../../interface/class/api/controller/identity-plan.interface';
 import { IApiControllerProperties } from '../../../../interface/decorator/api';
 import { IApiEntity } from '../../../../interface/entity';
 import { TApiControllerPropertiesRoute } from '../../../../type/decorator/api/controller';
 import { TApiControllerMethodMap } from '../../../../type/factory/api/controller';
-import { EApiRouteType } from '../../../../enum/decorator/api';
 /**
  * Applies appropriate decorators to controller methods based on the route type.
  * Configures HTTP methods, status codes, paths, and response types for API endpoints.
@@ -20,4 +21,19 @@ import { EApiRouteType } from '../../../../enum/decorator/api';
  * @throws {Error} If the method type is not implemented
  * @template E - The entity type
  */
-export declare function ApiControllerApplyDecorators<E extends IApiBaseEntity>(targetMethod: TApiControllerMethodMap<E>[typeof method], entity: IApiEntity<E>, properties: IApiControllerProperties<E>, method: EApiRouteType, methodName: string, routeConfig: TApiControllerPropertiesRoute<E, typeof method>, decorators: Array<MethodDecorator> | Array<PropertyDecorator>, queryPlan?: IApiControllerGetListQueryPlan): void;
+export declare function ApiControllerApplyDecorators<E extends IApiBaseEntity, M extends EApiControllerGetListQueryPaginationMode = EApiControllerGetListQueryPaginationMode.PAGE>(targetMethod: TApiControllerMethodMap<E, M>[typeof method], entity: IApiEntity<E>, properties: IApiControllerProperties<E>, method: EApiRouteType, methodName: string, routeConfig: TApiControllerPropertiesRoute<E, typeof method>, decorators: Array<MethodDecorator> | Array<PropertyDecorator>, queryPlan?: IApiControllerGetListQueryPlan): void;
+/**
+ * Applies generated route decorators with an internal compiled identity plan.
+ * @template E - Entity type owned by the generated route.
+ * @param {TApiControllerMethodMap<E>[typeof method]} targetMethod - Generated controller method.
+ * @param {IApiEntity<E>} entity - Entity metadata.
+ * @param {IApiControllerProperties<E>} properties - Controller configuration.
+ * @param {EApiRouteType} method - Generated route type.
+ * @param {string} methodName - Generated controller method name.
+ * @param {TApiControllerPropertiesRoute<E, typeof method>} routeConfig - Route configuration.
+ * @param {Array<MethodDecorator> | Array<PropertyDecorator>} decorators - Additional decorators.
+ * @param {IApiControllerGetListQueryPlan} [queryPlan] - Internal compiled GET_LIST query plan.
+ * @param {IApiControllerIdentityPlan} [identityPlan] - Internal compiled GET identity alias plan.
+ * @returns {void}
+ */
+export declare function ApiControllerApplyDecoratorsWithIdentityPlan<E extends IApiBaseEntity, M extends EApiControllerGetListQueryPaginationMode = EApiControllerGetListQueryPaginationMode.PAGE>(targetMethod: TApiControllerMethodMap<E, M>[typeof method], entity: IApiEntity<E>, properties: IApiControllerProperties<E>, method: EApiRouteType, methodName: string, routeConfig: TApiControllerPropertiesRoute<E, typeof method>, decorators: Array<MethodDecorator> | Array<PropertyDecorator>, queryPlan?: IApiControllerGetListQueryPlan, identityPlan?: IApiControllerIdentityPlan): void;