@lpdjs/firestore-repo-service 2.2.6 → 2.2.8

package/dist/index.d.cts

@@ -1,15 +1,16 @@
+import { H as HistoryConfigForModel } from './read-DfXXxhO4.cjs';
 import { Query, QuerySnapshot, Firestore } from 'firebase-admin/firestore';
 import { z } from 'zod';
-import { Q as QueryOptions, P as PaginationOptions, R as RepositoryConfig, a as RelationConfig, C as ConfiguredRepository } from './types-Z9Qy8Xmx.cjs';
-export { A as ApiResponse, l as CrudRepoConfig, m as CrudServerOptions, E as ExtractDocumentRefSignature, b as ExtractUpdateSignature, F as FieldPath, n as FieldRole, h as GenerateGetMethods, i as GenerateQueryMethods, G as GetOptions, c as GetResult, I as IncludeConfigTyped, L as ListResponseData, g as PaginationResult, j as PaginationWithIncludeOptionsTyped, k as PopulateOptionsTyped, o as QueryRequestBody, d as RelationalKeys, p as RepoFieldPath, q as RepoRelationKeys, U as UserFieldPath, W as WhereClause, e as createPaginationIterator, f as executePaginatedQuery } from './types-Z9Qy8Xmx.cjs';
-export { B as BoundAdminRepoConfig, a as BoundAdminServerOptions, b as BoundCrudRepoConfig, d as BoundCrudServerOptions, e as BoundFirestoreSyncConfig, C as CreateServersDeps, c as createServers } from './create-servers-DmggzSb3.cjs';
-export { A as AdminRepoConfig, a as AdminRepoEntry, b as AdminServerOptions, B as BasicAuthConfig, M as MiniRouter } from './index-DpD4DEqH.cjs';
+import { Q as QueryOptions, P as PaginationOptions, R as RepositoryConfig, a as RelationConfig, C as ConfiguredRepository } from './types-BESS89Fu.cjs';
+export { A as ApiResponse, l as CrudRepoConfig, m as CrudServerOptions, E as ExtractDocumentRefSignature, b as ExtractUpdateSignature, F as FieldPath, n as FieldRole, h as GenerateGetMethods, i as GenerateQueryMethods, G as GetOptions, c as GetResult, I as IncludeConfigTyped, L as ListResponseData, g as PaginationResult, j as PaginationWithIncludeOptionsTyped, k as PopulateOptionsTyped, o as QueryRequestBody, d as RelationalKeys, p as RepoFieldPath, q as RepoRelationKeys, U as UserFieldPath, W as WhereClause, e as createPaginationIterator, f as executePaginatedQuery } from './types-BESS89Fu.cjs';
+export { B as BoundAdminRepoConfig, a as BoundAdminServerOptions, b as BoundCrudRepoConfig, d as BoundCrudServerOptions, e as BoundFirestoreSyncConfig, C as CreateServersDeps, c as createServers } from './create-servers-BGtAS0oG.cjs';
+export { A as AdminRepoConfig, a as AdminRepoEntry, b as AdminServerOptions, B as BasicAuthConfig, M as MiniRouter } from './index-D7oj3Pft.cjs';
+import 'firebase-functions/v2/firestore';
 import 'firebase-functions/v2/https';
 import './queue-Dk1Ezhkf.cjs';
 import './types-CX5AbZWV.cjs';
-import 'firebase-functions/v2/firestore';
 import 'firebase-functions/v2/pubsub';
-import './openapi-UJJ1aCFk.cjs';
+import './openapi-lY43PZXy.cjs';
 
 /**
  * Apply QueryOptions to a Firestore query.
@@ -111,7 +112,7 @@ declare function normalizeTimestamps<T>(value: T): T;
  * const repos = createRepositoryMapping(db, mapping);
  * ```
  */
-declare function createRepositoryConfig<TSchema extends z.ZodObject<any>>(schema: TSchema): <const TForeignKeys extends readonly (keyof z.infer<TSchema>)[], const TQueryKeys extends readonly (keyof z.infer<TSchema>)[], const TIsGroup extends boolean, const TDocumentKey extends keyof z.infer<TSchema>, const TPathKey extends keyof z.infer<TSchema> | undefined = undefined, const TCreatedKey extends keyof z.infer<TSchema> | undefined = undefined, const TUpdatedKey extends keyof z.infer<TSchema> | undefined = undefined, TRefCb = undefined>(config: {
+declare function createRepositoryConfig<TSchema extends z.ZodObject<any>>(schema: TSchema): <const TForeignKeys extends readonly (keyof z.infer<TSchema>)[], const TQueryKeys extends readonly (keyof z.infer<TSchema>)[], const TIsGroup extends boolean, const TDocumentKey extends keyof z.infer<TSchema>, const TPathKey extends keyof z.infer<TSchema> | undefined = undefined, const TCreatedKey extends keyof z.infer<TSchema> | undefined = undefined, const TUpdatedKey extends keyof z.infer<TSchema> | undefined = undefined, const THistoryEnabled extends boolean = false, TRefCb = undefined>(config: {
     path: string;
     isGroup: TIsGroup;
     foreignKeys: TForeignKeys;
@@ -121,7 +122,15 @@ declare function createRepositoryConfig<TSchema extends z.ZodObject<any>>(schema
     createdKey?: TCreatedKey;
     updatedKey?: TUpdatedKey;
     refCb: TRefCb;
-}) => RepositoryConfig<z.infer<TSchema>, TForeignKeys, TQueryKeys, TIsGroup, TRefCb, {}, TDocumentKey, TPathKey, TCreatedKey, TUpdatedKey> & {
+    /**
+     * Optional change-history configuration. Set `enabled: true` to expose
+     * `repo.history.*` and have `createHistoryTriggers(...)` register a trigger
+     * for this repo.
+     */
+    history?: HistoryConfigForModel<z.infer<TSchema>> & {
+        enabled: THistoryEnabled;
+    };
+}) => RepositoryConfig<z.infer<TSchema>, TForeignKeys, TQueryKeys, TIsGroup, TRefCb, {}, TDocumentKey, TPathKey, TCreatedKey, TUpdatedKey, THistoryEnabled> & {
     schema: TSchema;
 };
 /**
@@ -160,9 +169,9 @@ type ResolveRelation<TMapping, TRelationConfig> = TRelationConfig extends {
  * ```
  */
 declare function buildRepositoryRelations<TMapping extends Record<string, any>, const TRelations extends {
-    [K in keyof TMapping]?: TMapping[K] extends RepositoryConfig<infer T, any, any, any, any, any, any, any, any, any> ? {
+    [K in keyof TMapping]?: TMapping[K] extends RepositoryConfig<infer T, any, any, any, any, any, any, any, any, any, any> ? {
         [RK in keyof T]?: {
-            [R in keyof TMapping]: TMapping[R] extends RepositoryConfig<infer TTargetModel, infer TForeignKeys, any, any, any, any, any, any, any, any> ? {
+            [R in keyof TMapping]: TMapping[R] extends RepositoryConfig<infer TTargetModel, infer TForeignKeys, any, any, any, any, any, any, any, any, any> ? {
                 repo: R;
                 key: TForeignKeys[number];
                 type: "one" | "many";
@@ -170,9 +179,9 @@ declare function buildRepositoryRelations<TMapping extends Record<string, any>,
         }[keyof TMapping];
     } : never;
 }>(mapping: TMapping, relations: TRelations): {
-    [K in keyof TMapping]: K extends keyof TRelations ? TMapping[K] extends RepositoryConfig<infer T, infer TForeignKeys, infer TQueryKeys, infer TIsGroup, infer TRefCb, any, infer TDocumentKey, infer TPathKey, infer TCreatedKey, infer TUpdatedKey> ? RepositoryConfig<T, TForeignKeys, TQueryKeys, TIsGroup, TRefCb, {
+    [K in keyof TMapping]: K extends keyof TRelations ? TMapping[K] extends RepositoryConfig<infer T, infer TForeignKeys, infer TQueryKeys, infer TIsGroup, infer TRefCb, any, infer TDocumentKey, infer TPathKey, infer TCreatedKey, infer TUpdatedKey, infer THistoryEnabled> ? RepositoryConfig<T, TForeignKeys, TQueryKeys, TIsGroup, TRefCb, {
         [RK in keyof TRelations[K]]: ResolveRelation<TMapping, TRelations[K][RK]>;
-    }, TDocumentKey, TPathKey, TCreatedKey, TUpdatedKey> : TMapping[K] : TMapping[K];
+    }, TDocumentKey, TPathKey, TCreatedKey, TUpdatedKey, THistoryEnabled> : TMapping[K] : TMapping[K];
 };
 /**
  * Repository mapping class that manages Firestore repositories with type safety

package/dist/index.d.ts

@@ -1,15 +1,16 @@
+import { H as HistoryConfigForModel } from './read-DfXXxhO4.js';
 import { Query, QuerySnapshot, Firestore } from 'firebase-admin/firestore';
 import { z } from 'zod';
-import { Q as QueryOptions, P as PaginationOptions, R as RepositoryConfig, a as RelationConfig, C as ConfiguredRepository } from './types-Z9Qy8Xmx.js';
-export { A as ApiResponse, l as CrudRepoConfig, m as CrudServerOptions, E as ExtractDocumentRefSignature, b as ExtractUpdateSignature, F as FieldPath, n as FieldRole, h as GenerateGetMethods, i as GenerateQueryMethods, G as GetOptions, c as GetResult, I as IncludeConfigTyped, L as ListResponseData, g as PaginationResult, j as PaginationWithIncludeOptionsTyped, k as PopulateOptionsTyped, o as QueryRequestBody, d as RelationalKeys, p as RepoFieldPath, q as RepoRelationKeys, U as UserFieldPath, W as WhereClause, e as createPaginationIterator, f as executePaginatedQuery } from './types-Z9Qy8Xmx.js';
-export { B as BoundAdminRepoConfig, a as BoundAdminServerOptions, b as BoundCrudRepoConfig, d as BoundCrudServerOptions, e as BoundFirestoreSyncConfig, C as CreateServersDeps, c as createServers } from './create-servers-D4-NGpKm.js';
-export { A as AdminRepoConfig, a as AdminRepoEntry, b as AdminServerOptions, B as BasicAuthConfig, M as MiniRouter } from './index-Cvip2Sgt.js';
+import { Q as QueryOptions, P as PaginationOptions, R as RepositoryConfig, a as RelationConfig, C as ConfiguredRepository } from './types-BVUFVcpl.js';
+export { A as ApiResponse, l as CrudRepoConfig, m as CrudServerOptions, E as ExtractDocumentRefSignature, b as ExtractUpdateSignature, F as FieldPath, n as FieldRole, h as GenerateGetMethods, i as GenerateQueryMethods, G as GetOptions, c as GetResult, I as IncludeConfigTyped, L as ListResponseData, g as PaginationResult, j as PaginationWithIncludeOptionsTyped, k as PopulateOptionsTyped, o as QueryRequestBody, d as RelationalKeys, p as RepoFieldPath, q as RepoRelationKeys, U as UserFieldPath, W as WhereClause, e as createPaginationIterator, f as executePaginatedQuery } from './types-BVUFVcpl.js';
+export { B as BoundAdminRepoConfig, a as BoundAdminServerOptions, b as BoundCrudRepoConfig, d as BoundCrudServerOptions, e as BoundFirestoreSyncConfig, C as CreateServersDeps, c as createServers } from './create-servers-DMszgNtg.js';
+export { A as AdminRepoConfig, a as AdminRepoEntry, b as AdminServerOptions, B as BasicAuthConfig, M as MiniRouter } from './index-BSZP0Gz9.js';
+import 'firebase-functions/v2/firestore';
 import 'firebase-functions/v2/https';
 import './queue-D_-aMf4H.js';
 import './types-CX5AbZWV.js';
-import 'firebase-functions/v2/firestore';
 import 'firebase-functions/v2/pubsub';
-import './openapi-B3P2F8op.js';
+import './openapi-BdqIkSjO.js';
 
 /**
  * Apply QueryOptions to a Firestore query.
@@ -111,7 +112,7 @@ declare function normalizeTimestamps<T>(value: T): T;
  * const repos = createRepositoryMapping(db, mapping);
  * ```
  */
-declare function createRepositoryConfig<TSchema extends z.ZodObject<any>>(schema: TSchema): <const TForeignKeys extends readonly (keyof z.infer<TSchema>)[], const TQueryKeys extends readonly (keyof z.infer<TSchema>)[], const TIsGroup extends boolean, const TDocumentKey extends keyof z.infer<TSchema>, const TPathKey extends keyof z.infer<TSchema> | undefined = undefined, const TCreatedKey extends keyof z.infer<TSchema> | undefined = undefined, const TUpdatedKey extends keyof z.infer<TSchema> | undefined = undefined, TRefCb = undefined>(config: {
+declare function createRepositoryConfig<TSchema extends z.ZodObject<any>>(schema: TSchema): <const TForeignKeys extends readonly (keyof z.infer<TSchema>)[], const TQueryKeys extends readonly (keyof z.infer<TSchema>)[], const TIsGroup extends boolean, const TDocumentKey extends keyof z.infer<TSchema>, const TPathKey extends keyof z.infer<TSchema> | undefined = undefined, const TCreatedKey extends keyof z.infer<TSchema> | undefined = undefined, const TUpdatedKey extends keyof z.infer<TSchema> | undefined = undefined, const THistoryEnabled extends boolean = false, TRefCb = undefined>(config: {
     path: string;
     isGroup: TIsGroup;
     foreignKeys: TForeignKeys;
@@ -121,7 +122,15 @@ declare function createRepositoryConfig<TSchema extends z.ZodObject<any>>(schema
     createdKey?: TCreatedKey;
     updatedKey?: TUpdatedKey;
     refCb: TRefCb;
-}) => RepositoryConfig<z.infer<TSchema>, TForeignKeys, TQueryKeys, TIsGroup, TRefCb, {}, TDocumentKey, TPathKey, TCreatedKey, TUpdatedKey> & {
+    /**
+     * Optional change-history configuration. Set `enabled: true` to expose
+     * `repo.history.*` and have `createHistoryTriggers(...)` register a trigger
+     * for this repo.
+     */
+    history?: HistoryConfigForModel<z.infer<TSchema>> & {
+        enabled: THistoryEnabled;
+    };
+}) => RepositoryConfig<z.infer<TSchema>, TForeignKeys, TQueryKeys, TIsGroup, TRefCb, {}, TDocumentKey, TPathKey, TCreatedKey, TUpdatedKey, THistoryEnabled> & {
     schema: TSchema;
 };
 /**
@@ -160,9 +169,9 @@ type ResolveRelation<TMapping, TRelationConfig> = TRelationConfig extends {
  * ```
  */
 declare function buildRepositoryRelations<TMapping extends Record<string, any>, const TRelations extends {
-    [K in keyof TMapping]?: TMapping[K] extends RepositoryConfig<infer T, any, any, any, any, any, any, any, any, any> ? {
+    [K in keyof TMapping]?: TMapping[K] extends RepositoryConfig<infer T, any, any, any, any, any, any, any, any, any, any> ? {
         [RK in keyof T]?: {
-            [R in keyof TMapping]: TMapping[R] extends RepositoryConfig<infer TTargetModel, infer TForeignKeys, any, any, any, any, any, any, any, any> ? {
+            [R in keyof TMapping]: TMapping[R] extends RepositoryConfig<infer TTargetModel, infer TForeignKeys, any, any, any, any, any, any, any, any, any> ? {
                 repo: R;
                 key: TForeignKeys[number];
                 type: "one" | "many";
@@ -170,9 +179,9 @@ declare function buildRepositoryRelations<TMapping extends Record<string, any>,
         }[keyof TMapping];
     } : never;
 }>(mapping: TMapping, relations: TRelations): {
-    [K in keyof TMapping]: K extends keyof TRelations ? TMapping[K] extends RepositoryConfig<infer T, infer TForeignKeys, infer TQueryKeys, infer TIsGroup, infer TRefCb, any, infer TDocumentKey, infer TPathKey, infer TCreatedKey, infer TUpdatedKey> ? RepositoryConfig<T, TForeignKeys, TQueryKeys, TIsGroup, TRefCb, {
+    [K in keyof TMapping]: K extends keyof TRelations ? TMapping[K] extends RepositoryConfig<infer T, infer TForeignKeys, infer TQueryKeys, infer TIsGroup, infer TRefCb, any, infer TDocumentKey, infer TPathKey, infer TCreatedKey, infer TUpdatedKey, infer THistoryEnabled> ? RepositoryConfig<T, TForeignKeys, TQueryKeys, TIsGroup, TRefCb, {
         [RK in keyof TRelations[K]]: ResolveRelation<TMapping, TRelations[K][RK]>;
-    }, TDocumentKey, TPathKey, TCreatedKey, TUpdatedKey> : TMapping[K] : TMapping[K];
+    }, TDocumentKey, TPathKey, TCreatedKey, TUpdatedKey, THistoryEnabled> : TMapping[K] : TMapping[K];
 };
 /**
  * Repository mapping class that manages Firestore repositories with type safety