@warlock.js/core 4.0.174 → 4.1.3

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

@@ -0,0 +1,332 @@
+import { RepositoryManager } from "../repository.manager.mjs";
+import { RepositoryAdapterContract } from "./repository-adapter.contract.mjs";
+import { QueryBuilderContract } from "./query-builder.contract.mjs";
+import { CacheDriver } from "@warlock.js/cache";
+
+//#region ../../@warlock.js/core/src/repositories/contracts/types.d.ts
+/**
+ * Pagination result structure returned by repository list methods
+ */
+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
+ */
+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
+ */
+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
+ */
+type ChunkCallback<T> = (documents: T[], chunkIndex: number) => Promise<false | any>;
+/**
+ * SQL-style where operators
+ */
+type WhereOperator = "=" | "!=" | "<>" | ">" | ">=" | "<" | "<=" | "like" | "not like" | "in" | "not in" | "between" | "not between";
+/**
+ * Repository-specific filter operators
+ */
+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
+ */
+type FilterFunction<M, Q = QueryBuilderContract<M>> = (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)
+ */
+type FilterRule<Q = QueryBuilderContract<any>> = FilterOperator | FilterFunction<Q> | [FilterOperator] | [FilterOperator, string | string[]];
+/**
+ * Filter rules mapping filter keys to their rules
+ */
+type FilterRules<Q = any> = {
+  [key: string]: FilterRule<Q>;
+};
+/**
+ * Options passed to filter application
+ */
+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
+ */
+type PaginationMode = "pages" | "cursor";
+/**
+ * Repository list options
+ */
+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
+ */
+interface RepositoryOptionsWithPages extends RepositoryOptions {
+  paginationMode?: "pages";
+}
+/**
+ * Discriminated union type for cursor-based pagination options
+ */
+interface RepositoryOptionsWithCursor extends RepositoryOptions {
+  paginationMode: "cursor";
+}
+/**
+ * Options for cached repository operations
+ */
+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)
+ */
+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
+ */
+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
+ */
+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
+ */
+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
+ */
+type TypedRepositoryOptionsWithCursor<F = Record<string, any>> = RepositoryOptionsWithCursor & Partial<F>;
+/**
+ * Repository event names
+ */
+type RepositoryEvent = "listing" | "list" | "creating" | "create" | "updating" | "update" | "saving" | "save" | "patching" | "patch" | "deleting" | "delete";
+/**
+ * Save mode for repository operations
+ */
+type SaveMode = "create" | "update" | "patch";
+/**
+ * Repositroy configurations
+ */
+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;
+};
+//#endregion
+export { AllRepositoryOptions, CachedRepositoryOptions, ChunkCallback, CursorPaginationOptions, CursorPaginationResult, FilterFunction, FilterOperator, FilterOptions, FilterRule, FilterRules, PaginationMode, PaginationResult, RepositoryConfigurations, RepositoryEvent, RepositoryOptions, RepositoryOptionsWithCursor, RepositoryOptionsWithPages, SaveMode, TypedAllRepositoryOptions, TypedRepositoryOptions, TypedRepositoryOptionsWithCursor, TypedRepositoryOptionsWithPages, WhereOperator };
+//# sourceMappingURL=types.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.mts","names":[],"sources":["../../../../../../../@warlock.js/core/src/repositories/contracts/types.ts"],"mappings":";;;;;;;;AAQA;KAAY,gBAAA;EAAgB;;;EAI1B,IAAA,EAAM,CAAC;EAAD;;;EAKN,UAAA;IAcE;;;IAVA,KAAA;IAoBK;AAQT;;IAvBI,MAAA;IA2BK;;;IAtBL,IAAA;IA2BF;;;IAtBE,KAAA;IAyCA;;;IApCA,KAAA;EAAA;AAAA;;;;;KAQQ,sBAAA;EA6DV;;AAAY;EAzDZ,IAAA,EAAM,CAAC;EAmEgB;;;EA9DvB,UAAA;IA8DyC;;;IA1DvC,KAAA;IA0D0E;AAAA;AAK9E;IA1DI,MAAA;IA0DqB;;AAAA;IArDrB,OAAA;IAuEsB;;;IAlEtB,UAAA;IA8GQ;;;IAzGR,UAAA;EAAA;AAAA;;;;KAOQ,uBAAA;EAkGkB;;;EA9F5B,KAAA;EAgGO;;;EA3FP,MAAA;EA4F4B;AAAA;AAU9B;;EAhGE,SAAA;EAgGyB;;;;EA1FzB,YAAA;AAAA;;;;;;;;KAUU,aAAA,OAAoB,SAAA,EAAW,CAAA,IAAK,UAAA,aAAuB,OAAO;;;AAoF3D;KA/EP,aAAA;;;;KAkBA,cAAA,ubAuCR,aAAa;;;;KAKL,cAAA,QAAsB,oBAAA,CAAqB,CAAA,MACrD,KAAA,OACA,KAAA,EAAO,CAAA,EACP,OAAA,EAAS,MAAA;AAoBkB;AAM7B;;;;;;AAN6B,KAVjB,UAAA,KAAe,oBAAA,SACvB,cAAA,GACA,cAAA,CAAe,CAAA,KACd,cAAA,KACA,cAAA;;AA0BS;AAMd;KA3BY,WAAA;EAAA,CACT,GAAA,WAAc,UAAU,CAAC,CAAA;AAAA;AA0BF;AAK1B;;AAL0B,KApBd,aAAA;EA8BO;;;EA1BjB,UAAA;EAsHuE;;;EAjHvE,cAAA;EAiCA;;;EAAA,CA5BC,GAAA;AAAA;;;;KAMS,cAAA;;;;KAKA,iBAAA;EA4FV;;;;EAvFA,cAAA,GAAiB,cAAA;EA4F4B;;AAA0B;AAMzE;EA5FE,QAAA;;;AA6Fc;AAMhB;EA7FE,IAAA;;;AA8Fc;EAzFd,KAAA;EA+FiC;;;;EAzFjC,YAAA;EAkGA;;;EA7FA,MAAA;EAkG0B;AAM5B;;;;EAjGE,YAAA;EA6GU;;;EAxGV,QAAA;EAwG4D;;;;;;;EA/F5D,OAAA;IAAA,CAIO,GAAA;EAAA;EA2FkF;AAAA;AAM3F;EA3FE,MAAA;EA2FmC;;;EAtFnC,aAAA;EAsFsF;;;;EAhFtF,MAAA;EAgF+D;;;;EA1E/D,SAAA;EAgFU;;;;EA1EV,YAAA;EA2EQ;;;EAtER,UAAA;EAqE0C;;;EAhE1C,OAAA,IAAW,KAAA,EAAO,oBAAA,OAA2B,OAAA,EAAS,iBAAA;AAAA;;AAiE7C;AAMX;UAjEiB,0BAAA,SAAmC,iBAAiB;EACnE,cAAc;AAAA;;;;UAMC,2BAAA,SAAoC,iBAAiB;EACpE,cAAc;AAAA;;;;KAMJ,uBAAA,GAA0B,iBAAA;EAoDG;AAAA;AAKzC;EArDE,KAAA;;;AAqDyB;EAhDzB,kBAAA;EAiEkB;;;EA5DlB,QAAA,YAAoB,MAAM;AAAA;;;;KAMhB,oBAAA,GAAuB,IAAI,CAAC,iBAAA;;;;;;;;;;;KAY5B,sBAAA,KAA2B,MAAA,iBAAuB,iBAAA,GAAoB,OAAA,CAAQ,CAAA;;;;;KAM9E,yBAAA,KAA8B,MAAA,iBAAuB,oBAAA,GAAuB,OAAA,CAAQ,CAAA;;AAiEjF;;;KA3DH,+BAAA,KAAoC,MAAA,iBAAuB,0BAAA,GACrE,OAAA,CAAQ,CAAA;;;;;KAME,gCAAA,KAAqC,MAAA,iBAC/C,2BAAA,GAA8B,OAAA,CAAQ,CAAA;;;;KAK5B,eAAA;;;;KAiBA,QAAA;;;;KAKA,wBAAA;;;;EAIV,WAAA,GAAc,WAAA;;;;EAKd,eAAA,IAAmB,UAAA,EAAY,iBAAA,UAA2B,yBAAA;;;;EAK1D,cAAA,GAAiB,OAAA,CAAQ,iBAAA;;;;EAKzB,cAAA;;;;EAKA,aAAA;AAAA"}

package/esm/repositories/index.d.mts

@@ -0,0 +1,6 @@
+import { RepositoryManager } from "./repository.manager.mjs";
+import { RepositoryAdapterContract } from "./contracts/repository-adapter.contract.mjs";
+import { AllRepositoryOptions, CachedRepositoryOptions, ChunkCallback, CursorPaginationOptions, CursorPaginationResult, FilterFunction, FilterOperator, FilterOptions, FilterRule, FilterRules, PaginationMode, PaginationResult, RepositoryConfigurations, RepositoryEvent, RepositoryOptions, RepositoryOptionsWithCursor, RepositoryOptionsWithPages, SaveMode, TypedAllRepositoryOptions, TypedRepositoryOptions, TypedRepositoryOptionsWithCursor, TypedRepositoryOptionsWithPages, WhereOperator } from "./contracts/types.mjs";
+import { QueryBuilderContract } from "./contracts/query-builder.contract.mjs";
+import { CascadeAdapter } from "./adapters/cascade/cascade-adapter.mjs";
+import { CascadeQueryBuilder } from "./adapters/cascade/cascade-query-builder.mjs";

package/esm/repositories/index.mjs

@@ -0,0 +1,6 @@
+import { CascadeQueryBuilder } from "./adapters/cascade/cascade-query-builder.mjs";
+import { CascadeAdapter } from "./adapters/cascade/cascade-adapter.mjs";
+import "./adapters/cascade/index.mjs";
+import { RepositoryManager } from "./repository.manager.mjs";
+
+export {  };