@lpdjs/firestore-repo-service 2.6.6 → 2.6.7

package/dist/{openapi-ChZojCEO.d.ts → openapi-BnVlzg59.d.ts}

@@ -1,4 +1,4 @@
-import { d as CrudRepoRegistry, O as OpenAPISpecOptions } from './types-CeyFvYXO.js';
+import { d as CrudRepoRegistry, O as OpenAPISpecOptions } from './types-n7q6N_Zw.js';
 
 /**
  * OpenAPI 3.1 specification generator for the CRUD server.

package/dist/{openapi-DpMtzJGo.d.cts → openapi-Cci3oqin.d.cts}

@@ -1,4 +1,4 @@
-import { d as CrudRepoRegistry, O as OpenAPISpecOptions } from './types-KYdNUffK.cjs';
+import { d as CrudRepoRegistry, O as OpenAPISpecOptions } from './types-B7KFW9S9.cjs';
 
 /**
  * OpenAPI 3.1 specification generator for the CRUD server.

package/dist/servers/admin/index.d.cts

@@ -1,8 +1,8 @@
 import 'zod';
 import 'firebase-functions/v2/https';
-import '../../types-KYdNUffK.cjs';
+import '../../types-B7KFW9S9.cjs';
 export { h as Middleware, M as MiniRouter, R as RouteHandler } from '../../firebase-auth-BTclYg-c.cjs';
-export { a as AdminRepoConfig, b as AdminRepoEntry, A as AdminServerOptions, B as BasicAuthConfig, c as RepoRegistry, d as createAdminServer } from '../../index-BuxFmMV8.cjs';
+export { a as AdminRepoConfig, b as AdminRepoEntry, A as AdminServerOptions, B as BasicAuthConfig, c as RepoRegistry, d as createAdminServer } from '../../index-BOYhux7q.cjs';
 import '../../read-CTWZjxyh.cjs';
 import 'firebase-admin/firestore';
 import 'firebase-functions/v2/firestore';

package/dist/servers/admin/index.d.ts

@@ -1,8 +1,8 @@
 import 'zod';
 import 'firebase-functions/v2/https';
-import '../../types-CeyFvYXO.js';
+import '../../types-n7q6N_Zw.js';
 export { h as Middleware, M as MiniRouter, R as RouteHandler } from '../../firebase-auth-BTclYg-c.js';
-export { a as AdminRepoConfig, b as AdminRepoEntry, A as AdminServerOptions, B as BasicAuthConfig, c as RepoRegistry, d as createAdminServer } from '../../index-BM1mgnpJ.js';
+export { a as AdminRepoConfig, b as AdminRepoEntry, A as AdminServerOptions, B as BasicAuthConfig, c as RepoRegistry, d as createAdminServer } from '../../index-BRjxlxWa.js';
 import '../../read-CTWZjxyh.js';
 import 'firebase-admin/firestore';
 import 'firebase-functions/v2/firestore';

package/dist/servers/crud/index.d.cts

@@ -1,8 +1,8 @@
 import { HttpsOptions } from 'firebase-functions/v2/https';
-import { C as ConfiguredRepository, a as CrudServerOptions } from '../../types-KYdNUffK.cjs';
-export { A as ApiResponse, B as BasicAuthConfig, b as CrudRepoConfig, c as CrudRepoEntry, d as CrudRepoRegistry, F as FieldRole, L as ListResponseData, M as Middleware, O as OpenAPISpecOptions, Q as QueryRequestBody, R as RepoFieldPath, e as RepoRelationKeys, U as UserFieldPath } from '../../types-KYdNUffK.cjs';
-import { O as OpenAPIDocument } from '../../openapi-DpMtzJGo.cjs';
-export { g as generateOpenAPISpec } from '../../openapi-DpMtzJGo.cjs';
+import { C as ConfiguredRepository, a as CrudServerOptions } from '../../types-B7KFW9S9.cjs';
+export { A as ApiResponse, B as BasicAuthConfig, b as CrudRepoConfig, c as CrudRepoEntry, d as CrudRepoRegistry, F as FieldRole, L as ListResponseData, M as Middleware, O as OpenAPISpecOptions, Q as QueryRequestBody, R as RepoFieldPath, e as RepoRelationKeys, U as UserFieldPath } from '../../types-B7KFW9S9.cjs';
+import { O as OpenAPIDocument } from '../../openapi-Cci3oqin.cjs';
+export { g as generateOpenAPISpec } from '../../openapi-Cci3oqin.cjs';
 import '../../firebase-auth-BTclYg-c.cjs';
 import 'zod';
 import '../../read-CTWZjxyh.cjs';

package/dist/servers/crud/index.d.ts

@@ -1,8 +1,8 @@
 import { HttpsOptions } from 'firebase-functions/v2/https';
-import { C as ConfiguredRepository, a as CrudServerOptions } from '../../types-CeyFvYXO.js';
-export { A as ApiResponse, B as BasicAuthConfig, b as CrudRepoConfig, c as CrudRepoEntry, d as CrudRepoRegistry, F as FieldRole, L as ListResponseData, M as Middleware, O as OpenAPISpecOptions, Q as QueryRequestBody, R as RepoFieldPath, e as RepoRelationKeys, U as UserFieldPath } from '../../types-CeyFvYXO.js';
-import { O as OpenAPIDocument } from '../../openapi-ChZojCEO.js';
-export { g as generateOpenAPISpec } from '../../openapi-ChZojCEO.js';
+import { C as ConfiguredRepository, a as CrudServerOptions } from '../../types-n7q6N_Zw.js';
+export { A as ApiResponse, B as BasicAuthConfig, b as CrudRepoConfig, c as CrudRepoEntry, d as CrudRepoRegistry, F as FieldRole, L as ListResponseData, M as Middleware, O as OpenAPISpecOptions, Q as QueryRequestBody, R as RepoFieldPath, e as RepoRelationKeys, U as UserFieldPath } from '../../types-n7q6N_Zw.js';
+import { O as OpenAPIDocument } from '../../openapi-BnVlzg59.js';
+export { g as generateOpenAPISpec } from '../../openapi-BnVlzg59.js';
 import '../../firebase-auth-BTclYg-c.js';
 import 'zod';
 import '../../read-CTWZjxyh.js';

package/dist/servers/index.d.cts

@@ -1,7 +1,7 @@
-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-DoOU7VMv.cjs';
-import { P as PageOptions, C as ColumnMeta, F as FilterState, R as RelationalFieldMeta, S as SortState, Q as QueryError } from '../index-BuxFmMV8.cjs';
-export { a as AdminRepoConfig, b as AdminRepoEntry, A as AdminServerOptions, B as BasicAuthConfig, c as RepoRegistry } from '../index-BuxFmMV8.cjs';
-export { A as ApiResponse, b as CrudRepoConfig, c as CrudRepoEntry, d as CrudRepoRegistry, a as CrudServerOptions, D as DEFAULT_HTML_CSP, F as FieldRole, L as ListResponseData, Q as QueryRequestBody, R as RepoFieldPath, e as RepoRelationKeys, S as SecurityHeadersOptions, U as UserFieldPath, s as securityHeaders } from '../types-KYdNUffK.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-k4vH90mn.cjs';
+import { P as PageOptions, C as ColumnMeta, F as FilterState, R as RelationalFieldMeta, S as SortState, Q as QueryError } from '../index-BOYhux7q.cjs';
+export { a as AdminRepoConfig, b as AdminRepoEntry, A as AdminServerOptions, B as BasicAuthConfig, c as RepoRegistry } from '../index-BOYhux7q.cjs';
+export { A as ApiResponse, b as CrudRepoConfig, c as CrudRepoEntry, d as CrudRepoRegistry, a as CrudServerOptions, D as DEFAULT_HTML_CSP, F as FieldRole, L as ListResponseData, Q as QueryRequestBody, R as RepoFieldPath, e as RepoRelationKeys, S as SecurityHeadersOptions, U as UserFieldPath, s as securityHeaders } from '../types-B7KFW9S9.cjs';
 import { z } from 'zod';
 export { h as Middleware, M as MiniRouter, R as RouteHandler } from '../firebase-auth-BTclYg-c.cjs';
 import * as hono_jsx_jsx_dev_runtime from 'hono/jsx/jsx-dev-runtime';
@@ -10,7 +10,7 @@ import '../types-CCREogoy.cjs';
 import 'firebase-functions/v2/firestore';
 import 'firebase-functions/v2/https';
 import 'firebase-functions/v2/pubsub';
-import '../openapi-DpMtzJGo.cjs';
+import '../openapi-Cci3oqin.cjs';
 import '../read-CTWZjxyh.cjs';
 import 'firebase-admin/firestore';
 

package/dist/servers/index.d.ts

@@ -1,7 +1,7 @@
-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-BlxW-09M.js';
-import { P as PageOptions, C as ColumnMeta, F as FilterState, R as RelationalFieldMeta, S as SortState, Q as QueryError } from '../index-BM1mgnpJ.js';
-export { a as AdminRepoConfig, b as AdminRepoEntry, A as AdminServerOptions, B as BasicAuthConfig, c as RepoRegistry } from '../index-BM1mgnpJ.js';
-export { A as ApiResponse, b as CrudRepoConfig, c as CrudRepoEntry, d as CrudRepoRegistry, a as CrudServerOptions, D as DEFAULT_HTML_CSP, F as FieldRole, L as ListResponseData, Q as QueryRequestBody, R as RepoFieldPath, e as RepoRelationKeys, S as SecurityHeadersOptions, U as UserFieldPath, s as securityHeaders } from '../types-CeyFvYXO.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-DA8xV-aT.js';
+import { P as PageOptions, C as ColumnMeta, F as FilterState, R as RelationalFieldMeta, S as SortState, Q as QueryError } from '../index-BRjxlxWa.js';
+export { a as AdminRepoConfig, b as AdminRepoEntry, A as AdminServerOptions, B as BasicAuthConfig, c as RepoRegistry } from '../index-BRjxlxWa.js';
+export { A as ApiResponse, b as CrudRepoConfig, c as CrudRepoEntry, d as CrudRepoRegistry, a as CrudServerOptions, D as DEFAULT_HTML_CSP, F as FieldRole, L as ListResponseData, Q as QueryRequestBody, R as RepoFieldPath, e as RepoRelationKeys, S as SecurityHeadersOptions, U as UserFieldPath, s as securityHeaders } from '../types-n7q6N_Zw.js';
 import { z } from 'zod';
 export { h as Middleware, M as MiniRouter, R as RouteHandler } from '../firebase-auth-BTclYg-c.js';
 import * as hono_jsx_jsx_dev_runtime from 'hono/jsx/jsx-dev-runtime';
@@ -10,7 +10,7 @@ import '../types-CMrrjq1V.js';
 import 'firebase-functions/v2/firestore';
 import 'firebase-functions/v2/https';
 import 'firebase-functions/v2/pubsub';
-import '../openapi-ChZojCEO.js';
+import '../openapi-BnVlzg59.js';
 import '../read-CTWZjxyh.js';
 import 'firebase-admin/firestore';
 

package/dist/{types-KYdNUffK.d.cts → types-B7KFW9S9.d.cts}

@@ -330,6 +330,51 @@ declare function executePaginatedQuery<T>(baseQuery: Query, options: PaginationO
  */
 declare function createPaginationIterator<T>(baseQuery: Query, options: Omit<PaginationOptions<T>, "cursor" | "direction">): AsyncGenerator<PaginationResult<T>, void, unknown>;
 
+/** Per-document failure surfaced by a system maintenance operation. */
+interface SystemBackfillFailure {
+    path: string;
+    error: Error;
+}
+/** Result returned by {@link SystemMethods.backfillKeys}. */
+interface SystemBackfillResult {
+    /** Documents inspected. */
+    scanned: number;
+    /** Documents that actually needed (and received) a patch. */
+    written: number;
+    /** Documents skipped because every managed key was already present. */
+    skipped: number;
+    /** Per-document permanent failures (after retries). Empty on full success. */
+    failures: SystemBackfillFailure[];
+}
+/** Options accepted by {@link SystemMethods.backfillKeys}. */
+interface SystemBackfillOptions {
+    /**
+     * Overwrite `createdKey` even when already present. Default `false` —
+     * existing creation timestamps are preserved.
+     */
+    overwriteCreated?: boolean;
+    /**
+     * Set `updatedKey` to now when missing. Existing values are preserved.
+     * Default `true`.
+     */
+    touchUpdated?: boolean;
+    /**
+     * Always rewrite `pathKey` from the document's live reference path, even if
+     * a value is already stored. Default `false` — only filled when missing.
+     */
+    overwritePath?: boolean;
+    /** Page size used to stream the collection. Default `300`. */
+    pageSize?: number;
+    /** Inspect and count only, without writing. Default `false`. */
+    dryRun?: boolean;
+    /** Called once per document that fails permanently (after retries). */
+    onError?: (failure: SystemBackfillFailure) => void;
+    /** Called once per document successfully patched. */
+    onSuccess?: (path: string) => void;
+    /** Max attempts per document for retryable errors. Default `5`. */
+    maxAttempts?: number;
+}
+
 /**
  * Extract the target model type from a relation config
  * @internal
@@ -521,6 +566,14 @@ type ConfiguredRepository<T extends RepositoryConfig<any, any, any, any, any, an
         }>) => Promise<void>;
         delete: (docRefs: DocumentReference[]) => Promise<void>;
     };
+    /**
+     * Collection-wide maintenance helpers. `backfillKeys` fills the auto-managed
+     * system fields (documentKey, pathKey, createdKey, updatedKey) on legacy
+     * documents written outside this package — idempotent and write-minimal.
+     */
+    system: {
+        backfillKeys: (options?: SystemBackfillOptions) => Promise<SystemBackfillResult>;
+    };
     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>>;
     }>;
@@ -1037,4 +1090,4 @@ interface QueryRequestBody {
     })[];
 }
 
-export { type ApiResponse as A, type BasicAuthConfig as B, type ConfiguredRepository as C, DEFAULT_HTML_CSP as D, type ExtractDocumentRefSignature as E, type FieldRole as F, type GetOptions as G, type IncludeConfigTyped as I, type ListResponseData as L, type Middleware as M, type OpenAPISpecOptions as O, type PaginationOptions as P, type QueryRequestBody as Q, type RepoFieldPath as R, type SecurityHeadersOptions as S, type UserFieldPath as U, type WhereClause as W, type CrudServerOptions as a, type CrudRepoConfig as b, type CrudRepoEntry as c, type CrudRepoRegistry as d, type RepoRelationKeys as e, type RepositoryConfig as f, type FieldPath as g, type QueryOptions as h, type RelationConfig as i, type ExtractUpdateSignature as j, type GetResult as k, type RelationalKeys as l, createPaginationIterator as m, executePaginatedQuery as n, type PaginationResult as o, type GenerateGetMethods as p, type GenerateQueryMethods as q, type PaginationWithIncludeOptionsTyped as r, securityHeaders as s, type PopulateOptionsTyped as t };
+export { type ApiResponse as A, type BasicAuthConfig as B, type ConfiguredRepository as C, DEFAULT_HTML_CSP as D, type ExtractDocumentRefSignature as E, type FieldRole as F, type GetOptions as G, type IncludeConfigTyped as I, type ListResponseData as L, type Middleware as M, type OpenAPISpecOptions as O, type PaginationOptions as P, type QueryRequestBody as Q, type RepoFieldPath as R, type SecurityHeadersOptions as S, type UserFieldPath as U, type WhereClause as W, type CrudServerOptions as a, type CrudRepoConfig as b, type CrudRepoEntry as c, type CrudRepoRegistry as d, type RepoRelationKeys as e, type RepositoryConfig as f, type FieldPath as g, type QueryOptions as h, type RelationConfig as i, type ExtractUpdateSignature as j, type GetResult as k, type RelationalKeys as l, createPaginationIterator as m, executePaginatedQuery as n, type PaginationResult as o, type SystemBackfillFailure as p, type SystemBackfillOptions as q, type SystemBackfillResult as r, securityHeaders as s, type GenerateGetMethods as t, type GenerateQueryMethods as u, type PaginationWithIncludeOptionsTyped as v, type PopulateOptionsTyped as w };

package/dist/{types-CeyFvYXO.d.ts → types-n7q6N_Zw.d.ts}

@@ -330,6 +330,51 @@ declare function executePaginatedQuery<T>(baseQuery: Query, options: PaginationO
  */
 declare function createPaginationIterator<T>(baseQuery: Query, options: Omit<PaginationOptions<T>, "cursor" | "direction">): AsyncGenerator<PaginationResult<T>, void, unknown>;
 
+/** Per-document failure surfaced by a system maintenance operation. */
+interface SystemBackfillFailure {
+    path: string;
+    error: Error;
+}
+/** Result returned by {@link SystemMethods.backfillKeys}. */
+interface SystemBackfillResult {
+    /** Documents inspected. */
+    scanned: number;
+    /** Documents that actually needed (and received) a patch. */
+    written: number;
+    /** Documents skipped because every managed key was already present. */
+    skipped: number;
+    /** Per-document permanent failures (after retries). Empty on full success. */
+    failures: SystemBackfillFailure[];
+}
+/** Options accepted by {@link SystemMethods.backfillKeys}. */
+interface SystemBackfillOptions {
+    /**
+     * Overwrite `createdKey` even when already present. Default `false` —
+     * existing creation timestamps are preserved.
+     */
+    overwriteCreated?: boolean;
+    /**
+     * Set `updatedKey` to now when missing. Existing values are preserved.
+     * Default `true`.
+     */
+    touchUpdated?: boolean;
+    /**
+     * Always rewrite `pathKey` from the document's live reference path, even if
+     * a value is already stored. Default `false` — only filled when missing.
+     */
+    overwritePath?: boolean;
+    /** Page size used to stream the collection. Default `300`. */
+    pageSize?: number;
+    /** Inspect and count only, without writing. Default `false`. */
+    dryRun?: boolean;
+    /** Called once per document that fails permanently (after retries). */
+    onError?: (failure: SystemBackfillFailure) => void;
+    /** Called once per document successfully patched. */
+    onSuccess?: (path: string) => void;
+    /** Max attempts per document for retryable errors. Default `5`. */
+    maxAttempts?: number;
+}
+
 /**
  * Extract the target model type from a relation config
  * @internal
@@ -521,6 +566,14 @@ type ConfiguredRepository<T extends RepositoryConfig<any, any, any, any, any, an
         }>) => Promise<void>;
         delete: (docRefs: DocumentReference[]) => Promise<void>;
     };
+    /**
+     * Collection-wide maintenance helpers. `backfillKeys` fills the auto-managed
+     * system fields (documentKey, pathKey, createdKey, updatedKey) on legacy
+     * documents written outside this package — idempotent and write-minimal.
+     */
+    system: {
+        backfillKeys: (options?: SystemBackfillOptions) => Promise<SystemBackfillResult>;
+    };
     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>>;
     }>;
@@ -1037,4 +1090,4 @@ interface QueryRequestBody {
     })[];
 }
 
-export { type ApiResponse as A, type BasicAuthConfig as B, type ConfiguredRepository as C, DEFAULT_HTML_CSP as D, type ExtractDocumentRefSignature as E, type FieldRole as F, type GetOptions as G, type IncludeConfigTyped as I, type ListResponseData as L, type Middleware as M, type OpenAPISpecOptions as O, type PaginationOptions as P, type QueryRequestBody as Q, type RepoFieldPath as R, type SecurityHeadersOptions as S, type UserFieldPath as U, type WhereClause as W, type CrudServerOptions as a, type CrudRepoConfig as b, type CrudRepoEntry as c, type CrudRepoRegistry as d, type RepoRelationKeys as e, type RepositoryConfig as f, type FieldPath as g, type QueryOptions as h, type RelationConfig as i, type ExtractUpdateSignature as j, type GetResult as k, type RelationalKeys as l, createPaginationIterator as m, executePaginatedQuery as n, type PaginationResult as o, type GenerateGetMethods as p, type GenerateQueryMethods as q, type PaginationWithIncludeOptionsTyped as r, securityHeaders as s, type PopulateOptionsTyped as t };
+export { type ApiResponse as A, type BasicAuthConfig as B, type ConfiguredRepository as C, DEFAULT_HTML_CSP as D, type ExtractDocumentRefSignature as E, type FieldRole as F, type GetOptions as G, type IncludeConfigTyped as I, type ListResponseData as L, type Middleware as M, type OpenAPISpecOptions as O, type PaginationOptions as P, type QueryRequestBody as Q, type RepoFieldPath as R, type SecurityHeadersOptions as S, type UserFieldPath as U, type WhereClause as W, type CrudServerOptions as a, type CrudRepoConfig as b, type CrudRepoEntry as c, type CrudRepoRegistry as d, type RepoRelationKeys as e, type RepositoryConfig as f, type FieldPath as g, type QueryOptions as h, type RelationConfig as i, type ExtractUpdateSignature as j, type GetResult as k, type RelationalKeys as l, createPaginationIterator as m, executePaginatedQuery as n, type PaginationResult as o, type SystemBackfillFailure as p, type SystemBackfillOptions as q, type SystemBackfillResult as r, securityHeaders as s, type GenerateGetMethods as t, type GenerateQueryMethods as u, type PaginationWithIncludeOptionsTyped as v, type PopulateOptionsTyped as w };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lpdjs/firestore-repo-service",
-  "version": "2.6.6",
+  "version": "2.6.7",
   "workspaces": [
     "test/functions"
   ],