@lpdjs/firestore-repo-service 2.2.5 → 2.2.7

package/dist/{types-Z9Qy8Xmx.d.ts → types-CE1dws32.d.cts}

@@ -1,6 +1,7 @@
 import * as zod from 'zod';
 import { z } from 'zod';
 import { HttpsOptions } from 'firebase-functions/v2/https';
+import { H as HistoryConfigForModel, a as HistoryMethods } from './read-DMvxeFCg.cjs';
 import { DocumentReference, Firestore, DocumentSnapshot, WhereFilterOp, Query, CollectionReference, WriteBatch, Transaction } from 'firebase-admin/firestore';
 
 /**
@@ -165,7 +166,7 @@ type RelationalKeys<T = any, TMapping = any> = {
  * @template TCreatedKey - The field name to store the creation timestamp (optional)
  * @template TUpdatedKey - The field name to store the update timestamp (optional)
  */
-interface RepositoryConfig<T, TForeignKeys extends readonly (keyof T)[], TQueryKeys extends readonly (keyof T)[], TIsGroup extends boolean = boolean, TRefCb = any, TRelationalKeys = {}, TDocumentKey extends keyof T = keyof T, TPathKey extends keyof T | undefined = undefined, TCreatedKey extends keyof T | undefined = undefined, TUpdatedKey extends keyof T | undefined = undefined> {
+interface RepositoryConfig<T, TForeignKeys extends readonly (keyof T)[], TQueryKeys extends readonly (keyof T)[], TIsGroup extends boolean = boolean, TRefCb = any, TRelationalKeys = {}, TDocumentKey extends keyof T = keyof T, TPathKey extends keyof T | undefined = undefined, TCreatedKey extends keyof T | undefined = undefined, TUpdatedKey extends keyof T | undefined = undefined, THistoryEnabled extends boolean = false> {
     path: string;
     isGroup: TIsGroup;
     foreignKeys: TForeignKeys;
@@ -179,6 +180,16 @@ interface RepositoryConfig<T, TForeignKeys extends readonly (keyof T)[], TQueryK
     schema?: zod.ZodObject<any>;
     refCb?: TRefCb;
     relationalKeys?: TRelationalKeys;
+    /**
+     * Optional change-history configuration. When `enabled: true`, the
+     * `repo.history.*` read API is exposed and `createHistoryTriggers(...)`
+     * will register Firestore triggers for this repo.
+     *
+     * @see import("../history/types").HistoryConfigForModel
+     */
+    history?: HistoryConfigForModel<T> & {
+        enabled: THistoryEnabled;
+    };
     documentRef: TRefCb extends undefined ? TIsGroup extends true ? (...pathSegments: string[]) => DocumentReference : (docId: string) => DocumentReference : ExtractDocumentRefSignature<TRefCb>;
     update: TRefCb extends undefined ? TIsGroup extends true ? (...args: [...string[], Partial<T>]) => Promise<T> : (docId: string, data: Partial<T>) => Promise<T> : ExtractUpdateSignature<TRefCb, T>;
 }
@@ -428,7 +439,7 @@ type GenerateQueryMethods<TConfig extends RepositoryConfig<any, any, any, any, a
 /**
  * Configured repository with organized methods
  */
-type ConfiguredRepository<T extends RepositoryConfig<any, any, any, any, any, any, any, any, any, any>> = {
+type ConfiguredRepository<T extends RepositoryConfig<any, any, any, any, any, any, any, any, any, any, any>> = {
     /** @internal Phantom property to expose the model type for generic extraction */
     readonly _modelType: T["type"];
     /** @internal Whether this is a collectionGroup repository */
@@ -512,7 +523,13 @@ type ConfiguredRepository<T extends RepositoryConfig<any, any, any, any, any, an
     populate: <K extends keyof NonNullable<T["relationalKeys"]>, TDoc extends Pick<T["type"], K & keyof T["type"]>>(document: TDoc, relationKeyOrOptions: K | K[] | PopulateOptionsTyped<NonNullable<T["relationalKeys"]>, K>) => Promise<TDoc & {
         populated: UnionToIntersection<K extends keyof NonNullable<T["relationalKeys"]> ? ExtractPopulatedFromRelation<NonNullable<T["relationalKeys"]>[K], K & string> : Record<string, never>>;
     }>;
-};
+} & (T extends {
+    history: {
+        enabled: true;
+    };
+} ? {
+    history: HistoryMethods<T["type"]>;
+} : {});
 
 /**
  * Type definitions for the CRUD API server.

package/dist/{types-Z9Qy8Xmx.d.cts → types-CjexXskS.d.ts}

@@ -1,6 +1,7 @@
 import * as zod from 'zod';
 import { z } from 'zod';
 import { HttpsOptions } from 'firebase-functions/v2/https';
+import { H as HistoryConfigForModel, a as HistoryMethods } from './read-DMvxeFCg.js';
 import { DocumentReference, Firestore, DocumentSnapshot, WhereFilterOp, Query, CollectionReference, WriteBatch, Transaction } from 'firebase-admin/firestore';
 
 /**
@@ -165,7 +166,7 @@ type RelationalKeys<T = any, TMapping = any> = {
  * @template TCreatedKey - The field name to store the creation timestamp (optional)
  * @template TUpdatedKey - The field name to store the update timestamp (optional)
  */
-interface RepositoryConfig<T, TForeignKeys extends readonly (keyof T)[], TQueryKeys extends readonly (keyof T)[], TIsGroup extends boolean = boolean, TRefCb = any, TRelationalKeys = {}, TDocumentKey extends keyof T = keyof T, TPathKey extends keyof T | undefined = undefined, TCreatedKey extends keyof T | undefined = undefined, TUpdatedKey extends keyof T | undefined = undefined> {
+interface RepositoryConfig<T, TForeignKeys extends readonly (keyof T)[], TQueryKeys extends readonly (keyof T)[], TIsGroup extends boolean = boolean, TRefCb = any, TRelationalKeys = {}, TDocumentKey extends keyof T = keyof T, TPathKey extends keyof T | undefined = undefined, TCreatedKey extends keyof T | undefined = undefined, TUpdatedKey extends keyof T | undefined = undefined, THistoryEnabled extends boolean = false> {
     path: string;
     isGroup: TIsGroup;
     foreignKeys: TForeignKeys;
@@ -179,6 +180,16 @@ interface RepositoryConfig<T, TForeignKeys extends readonly (keyof T)[], TQueryK
     schema?: zod.ZodObject<any>;
     refCb?: TRefCb;
     relationalKeys?: TRelationalKeys;
+    /**
+     * Optional change-history configuration. When `enabled: true`, the
+     * `repo.history.*` read API is exposed and `createHistoryTriggers(...)`
+     * will register Firestore triggers for this repo.
+     *
+     * @see import("../history/types").HistoryConfigForModel
+     */
+    history?: HistoryConfigForModel<T> & {
+        enabled: THistoryEnabled;
+    };
     documentRef: TRefCb extends undefined ? TIsGroup extends true ? (...pathSegments: string[]) => DocumentReference : (docId: string) => DocumentReference : ExtractDocumentRefSignature<TRefCb>;
     update: TRefCb extends undefined ? TIsGroup extends true ? (...args: [...string[], Partial<T>]) => Promise<T> : (docId: string, data: Partial<T>) => Promise<T> : ExtractUpdateSignature<TRefCb, T>;
 }
@@ -428,7 +439,7 @@ type GenerateQueryMethods<TConfig extends RepositoryConfig<any, any, any, any, a
 /**
  * Configured repository with organized methods
  */
-type ConfiguredRepository<T extends RepositoryConfig<any, any, any, any, any, any, any, any, any, any>> = {
+type ConfiguredRepository<T extends RepositoryConfig<any, any, any, any, any, any, any, any, any, any, any>> = {
     /** @internal Phantom property to expose the model type for generic extraction */
     readonly _modelType: T["type"];
     /** @internal Whether this is a collectionGroup repository */
@@ -512,7 +523,13 @@ type ConfiguredRepository<T extends RepositoryConfig<any, any, any, any, any, an
     populate: <K extends keyof NonNullable<T["relationalKeys"]>, TDoc extends Pick<T["type"], K & keyof T["type"]>>(document: TDoc, relationKeyOrOptions: K | K[] | PopulateOptionsTyped<NonNullable<T["relationalKeys"]>, K>) => Promise<TDoc & {
         populated: UnionToIntersection<K extends keyof NonNullable<T["relationalKeys"]> ? ExtractPopulatedFromRelation<NonNullable<T["relationalKeys"]>[K], K & string> : Record<string, never>>;
     }>;
-};
+} & (T extends {
+    history: {
+        enabled: true;
+    };
+} ? {
+    history: HistoryMethods<T["type"]>;
+} : {});
 
 /**
  * Type definitions for the CRUD API server.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lpdjs/firestore-repo-service",
-  "version": "2.2.5",
+  "version": "2.2.7",
   "description": "⚡ Type-safe Firestore ORM with auto-generated repositories, advanced queries, relations with typed select, pagination with include, batch/bulk operations, aggregations and transactions.",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -37,6 +37,16 @@
         "default": "./dist/sync/bigquery.js"
       }
     },
+    "./history": {
+      "require": {
+        "types": "./dist/history/index.d.cts",
+        "default": "./dist/history/index.cjs"
+      },
+      "import": {
+        "types": "./dist/history/index.d.ts",
+        "default": "./dist/history/index.js"
+      }
+    },
     "./servers": {
       "require": {
         "types": "./dist/servers/index.d.cts",
@@ -84,6 +94,9 @@
       ],
       "sync/bigquery": [
         "./dist/sync/bigquery.d.ts"
+      ],
+      "history": [
+        "./dist/history/index.d.ts"
       ]
     }
   },