@warlock.js/core 4.0.162 → 4.0.163

package/esm/repositories/contracts/types.d.ts

@@ -0,0 +1,328 @@
+import { CacheDriver } from "@warlock.js/cache";
+import { RepositoryManager } from "../repository.manager";
+import { QueryBuilderContract } from "./query-builder.contract";
+import { RepositoryAdapterContract } from "./repository-adapter.contract";
+/**
+ * Pagination result structure returned by repository list methods
+ */
+export type PaginationResult<T> = {
+    /**
+     * Array of documents/records in the current page
+     */
+    data: T[];
+    /**
+     * Pagination metadata
+     */
+    pagination: {
+        /**
+         * Number of items per page
+         */
+        limit: number;
+        /**
+         * Number of items in current page
+         */
+        result: number;
+        /**
+         * Current page number (1-indexed)
+         */
+        page: number;
+        /**
+         * Total number of items across all pages
+         */
+        total: number;
+        /**
+         * Total number of pages
+         */
+        pages: number;
+    };
+};
+/**
+ * Cursor pagination result structure
+ * More efficient for large datasets as it doesn't require counting total records
+ */
+export type CursorPaginationResult<T> = {
+    /**
+     * Array of documents/records in the current page
+     */
+    data: T[];
+    /**
+     * Cursor pagination metadata
+     */
+    pagination: {
+        /**
+         * Number of items per page
+         */
+        limit: number;
+        /**
+         * Number of items in current page
+         */
+        result: number;
+        /**
+         * Whether there are more results after this page
+         */
+        hasMore: boolean;
+        /**
+         * Cursor for the next page (typically the ID of the last item)
+         */
+        nextCursor?: string | number;
+        /**
+         * Cursor for the previous page (typically the ID of the first item)
+         */
+        prevCursor?: string | number;
+    };
+};
+/**
+ * Options for cursor-based pagination
+ */
+export type CursorPaginationOptions = {
+    /**
+     * Number of items per page
+     */
+    limit: number;
+    /**
+     * Cursor to start from (typically an ID)
+     */
+    cursor?: string | number;
+    /**
+     * Direction to paginate
+     * @default "next"
+     */
+    direction?: "next" | "prev";
+    /**
+     * Column to use for cursor (typically "id")
+     * @default "id"
+     */
+    cursorColumn?: string;
+};
+/**
+ * Callback function for chunking operations
+ *
+ * @param documents - Array of documents in current chunk
+ * @param chunkIndex - Index of current chunk (0-based)
+ * @returns Promise that resolves to false to stop chunking, or any other value to continue
+ */
+export type ChunkCallback<T> = (documents: T[], chunkIndex: number) => Promise<false | any>;
+/**
+ * SQL-style where operators
+ */
+export type WhereOperator = "=" | "!=" | "<>" | ">" | ">=" | "<" | "<=" | "like" | "not like" | "in" | "not in" | "between" | "not between";
+/**
+ * Repository-specific filter operators
+ */
+export type FilterOperator = "bool" | "boolean" | "number" | "inNumber" | "null" | "notNull" | "!null" | "int" | "int>" | "int>=" | "int<" | "int<=" | "in" | "!int" | "integer" | "inInt" | "float" | "double" | "inFloat" | "date" | "inDate" | "date>" | "date>=" | "date<" | "date<=" | "dateBetween" | "dateTime" | "inDateTime" | "dateTime>" | "dateTime>=" | "dateTime<" | "dateTime<=" | "dateTimeBetween" | "location" | "scope" | "with" | "joinWith" | "similarTo" | WhereOperator;
+/**
+ * Filter function that receives value, query builder, and context
+ */
+export type FilterFunction<Q = any> = (value: any, query: Q, context: Record<string, any>) => void;
+/**
+ * Filter rule definition
+ * Can be:
+ * - A filter operator string
+ * - A custom filter function
+ * - An array with operator and optional column name(s)
+ */
+export type FilterRule<Q = any> = FilterOperator | FilterFunction<Q> | [FilterOperator] | [FilterOperator, string | string[]];
+/**
+ * Filter rules mapping filter keys to their rules
+ */
+export type FilterRules<Q = any> = {
+    [key: string]: FilterRule<Q>;
+};
+/**
+ * Options passed to filter application
+ */
+export type FilterOptions = {
+    /**
+     * Date format for date filters
+     */
+    dateFormat?: string;
+    /**
+     * DateTime format for datetime filters
+     */
+    dateTimeFormat?: string;
+    /**
+     * Additional custom options
+     */
+    [key: string]: any;
+};
+/**
+ * Pagination mode type
+ */
+export type PaginationMode = "pages" | "cursor";
+/**
+ * Repository list options
+ */
+export type RepositoryOptions = {
+    /**
+     * Pagination mode - "pages" for traditional pagination, "cursor" for cursor-based
+     * @default "pages"
+     */
+    paginationMode?: PaginationMode;
+    /**
+     * Whether to paginate results
+     * @default true
+     */
+    paginate?: boolean;
+    /**
+     * Current page number (1-indexed)
+     * @default 1
+     */
+    page?: number;
+    /**
+     * Number of items per page
+     */
+    limit?: number;
+    /**
+     * Default limit when no limit is specified
+     * @default 15
+     */
+    defaultLimit?: number;
+    /**
+     * Columns to select
+     */
+    select?: string[];
+    /**
+     * Simple select flag
+     * If passed, then only data will be fetched is from simpleSelectColumns property
+     * If simpleSelectColumns is empty, this option will be ignored
+     */
+    simpleSelect?: true;
+    /**
+     * Columns to exclude from selection
+     */
+    deselect?: string[];
+    /**
+     * Order by configuration
+     * Can be:
+     * - "random" for random ordering
+     * - [column, direction] tuple
+     * - Object mapping columns to directions
+     */
+    orderBy?: "random" | [string, "asc" | "desc"] | {
+        [key: string]: "asc" | "desc";
+    };
+    /**
+     * Sort by column name
+     */
+    sortBy?: string;
+    /**
+     * Sort direction
+     */
+    sortDirection?: "asc" | "desc";
+    /**
+     * Cursor value for cursor-based pagination
+     * Used when paginationMode = "cursor"
+     */
+    cursor?: string | number;
+    /**
+     * Direction for cursor pagination
+     * @default "next"
+     */
+    direction?: "next" | "prev";
+    /**
+     * Column to use for cursor pagination
+     * @default "_id" for MongoDB, "id" for SQL
+     */
+    cursorColumn?: string;
+    /**
+     * Whether to purge cache after reading
+     */
+    purgeCache?: boolean;
+    /**
+     * Custom query modifications
+     */
+    perform?: (query: QueryBuilderContract<any>, options: RepositoryOptions) => void;
+};
+/**
+ * Discriminated union type for page-based pagination options
+ */
+export interface RepositoryOptionsWithPages extends RepositoryOptions {
+    paginationMode?: "pages";
+}
+/**
+ * Discriminated union type for cursor-based pagination options
+ */
+export interface RepositoryOptionsWithCursor extends RepositoryOptions {
+    paginationMode: "cursor";
+}
+/**
+ * Options for cached repository operations
+ */
+export type CachedRepositoryOptions = RepositoryOptions & {
+    /**
+     * Whether to use cache
+     */
+    cache?: boolean;
+    /**
+     * Whether to cache with current locale
+     */
+    cacheCurrentLocale?: boolean;
+    /**
+     * Custom cache key
+     */
+    cacheKey?: string | Record<string, any>;
+};
+/**
+ * Options for all() method (non-paginated listing)
+ */
+export type AllRepositoryOptions = Omit<RepositoryOptions, "paginate" | "page">;
+/**
+ * Typed repository options — merges base options with a repo-specific filter
+ * shape `F` so callers get full autocomplete on filter keys.
+ *
+ * @template F - The filter shape defined by the repository (e.g. `{ id?: number; status?: string }`)
+ *
+ * @example
+ * // In a service:
+ * repo.list({ organization_id: 1, status: "active" }); // ← autocompleted & type-checked
+ */
+export type TypedRepositoryOptions<F = Record<string, any>> = RepositoryOptions & Partial<F>;
+/**
+ * Typed version of AllRepositoryOptions (no paginate/page) with filter shape.
+ * @template F - The filter shape defined by the repository
+ */
+export type TypedAllRepositoryOptions<F = Record<string, any>> = AllRepositoryOptions & Partial<F>;
+/**
+ * Typed version of RepositoryOptionsWithPages with filter shape.
+ * @template F - The filter shape defined by the repository
+ */
+export type TypedRepositoryOptionsWithPages<F = Record<string, any>> = RepositoryOptionsWithPages & Partial<F>;
+/**
+ * Typed version of RepositoryOptionsWithCursor with filter shape.
+ * @template F - The filter shape defined by the repository
+ */
+export type TypedRepositoryOptionsWithCursor<F = Record<string, any>> = RepositoryOptionsWithCursor & Partial<F>;
+/**
+ * Repository event names
+ */
+export type RepositoryEvent = "listing" | "list" | "creating" | "create" | "updating" | "update" | "saving" | "save" | "patching" | "patch" | "deleting" | "delete";
+/**
+ * Save mode for repository operations
+ */
+export type SaveMode = "create" | "update" | "patch";
+/**
+ * Repositroy configurations
+ */
+export type RepositoryConfigurations = {
+    /**
+     * Default cache driver
+     */
+    cacheDriver?: CacheDriver<any, any>;
+    /**
+     * Default adapter resolver
+     */
+    adapterResolver?: (repository: RepositoryManager<any>) => RepositoryAdapterContract<any>;
+    /**
+     * Default repository options
+     */
+    defaultOptions?: Partial<RepositoryOptions>;
+    /**
+     * Default active column name
+     */
+    isActiveColumn?: string;
+    /**
+     * Default active column value
+     */
+    isActiveValue?: any;
+};
+//# sourceMappingURL=types.d.ts.map

package/esm/repositories/contracts/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/repositories/contracts/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAE1E;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI;IAChC;;OAEG;IACH,IAAI,EAAE,CAAC,EAAE,CAAC;IAEV;;OAEG;IACH,UAAU,EAAE;QACV;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,sBAAsB,CAAC,CAAC,IAAI;IACtC;;OAEG;IACH,IAAI,EAAE,CAAC,EAAE,CAAC;IAEV;;OAEG;IACH,UAAU,EAAE;QACV;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,OAAO,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAE7B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;KAC9B,CAAC;CACH,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAEzB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAE5B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,EAAE,EAAE,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC;AAE5F;;GAEG;AACH,MAAM,MAAM,aAAa,GACrB,GAAG,GACH,IAAI,GACJ,IAAI,GACJ,GAAG,GACH,IAAI,GACJ,GAAG,GACH,IAAI,GACJ,MAAM,GACN,UAAU,GACV,IAAI,GACJ,QAAQ,GACR,SAAS,GACT,aAAa,CAAC;AAElB;;GAEG;AACH,MAAM,MAAM,cAAc,GACtB,MAAM,GACN,SAAS,GACT,QAAQ,GACR,UAAU,GACV,MAAM,GACN,SAAS,GACT,OAAO,GACP,KAAK,GACL,MAAM,GACN,OAAO,GACP,MAAM,GACN,OAAO,GACP,IAAI,GACJ,MAAM,GACN,SAAS,GACT,OAAO,GACP,OAAO,GACP,QAAQ,GACR,SAAS,GACT,MAAM,GACN,QAAQ,GACR,OAAO,GACP,QAAQ,GACR,OAAO,GACP,QAAQ,GACR,aAAa,GACb,UAAU,GACV,YAAY,GACZ,WAAW,GACX,YAAY,GACZ,WAAW,GACX,YAAY,GACZ,iBAAiB,GACjB,UAAU,GACV,OAAO,GACP,MAAM,GACN,UAAU,GACV,WAAW,GACX,aAAa,CAAC;AAElB;;GAEG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,IAAI,CAAC;AAEnG;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,GAAG,GAAG,IAC1B,cAAc,GACd,cAAc,CAAC,CAAC,CAAC,GACjB,CAAC,cAAc,CAAC,GAChB,CAAC,cAAc,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAC;AAExC;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,GAAG,GAAG,IAAI;IACjC,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;CAC9B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,QAAQ,CAAC;AAEhD;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;;OAGG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;;;OAIG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpB;;;;;;OAMG;IACH,OAAO,CAAC,EACJ,QAAQ,GACR,CAAC,MAAM,EAAE,KAAK,GAAG,MAAM,CAAC,GACxB;QACE,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,CAAC;KAC/B,CAAC;IAEN;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAE/B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAEzB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAE5B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,oBAAoB,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,iBAAiB,KAAK,IAAI,CAAC;CAClF,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,iBAAiB;IACnE,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,iBAAiB;IACpE,cAAc,EAAE,QAAQ,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,iBAAiB,GAAG;IACxD;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CACzC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,iBAAiB,EAAE,UAAU,GAAG,MAAM,CAAC,CAAC;AAEhF;;;;;;;;;GASG;AACH,MAAM,MAAM,sBAAsB,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,iBAAiB,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAE7F;;;GAGG;AACH,MAAM,MAAM,yBAAyB,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,oBAAoB,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAEnG;;;GAGG;AACH,MAAM,MAAM,+BAA+B,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,0BAA0B,GAC/F,OAAO,CAAC,CAAC,CAAC,CAAC;AAEb;;;GAGG;AACH,MAAM,MAAM,gCAAgC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAClE,2BAA2B,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,eAAe,GACvB,SAAS,GACT,MAAM,GACN,UAAU,GACV,QAAQ,GACR,UAAU,GACV,QAAQ,GACR,QAAQ,GACR,MAAM,GACN,UAAU,GACV,OAAO,GACP,UAAU,GACV,QAAQ,CAAC;AAEb;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,OAAO,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAEpC;;OAEG;IACH,eAAe,CAAC,EAAE,CAAC,UAAU,EAAE,iBAAiB,CAAC,GAAG,CAAC,KAAK,yBAAyB,CAAC,GAAG,CAAC,CAAC;IAEzF;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAE5C;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,aAAa,CAAC,EAAE,GAAG,CAAC;CACrB,CAAC"}

package/esm/repositories/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Repository v2 - ORM-agnostic repository layer
+ * @module @warlock.js/core/repositories2
+ */
+export * from "./contracts";
+export * from "./adapters/cascade";
+export * from "./repository.manager";
+//# sourceMappingURL=index.d.ts.map

package/esm/repositories/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/repositories/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,cAAc,aAAa,CAAC;AAG5B,cAAc,oBAAoB,CAAC;AAGnC,cAAc,sBAAsB,CAAC"}