@mxpicture/gcp-functions-backend 1.1.3 → 1.1.5

package/dist/api/BackendApi.d.ts

@@ -2,19 +2,74 @@ import type { DocumentData, WithKey, ApiFromRoutes, CrudRoutes, WithoutKey, Docu
 import { Store } from "../store/Store.js";
 import type { Validation } from "../validation/Validation.js";
 import { IBackendApi } from "./IBackendApi.js";
+/**
+ * Backend API providing standard CRUD operations for a document type.
+ *
+ * @remarks
+ * Extends {@link IBackendApi} and implements all routes defined by {@link CrudRoutes}.
+ * Delegates persistence to a {@link Store} and input validation to a {@link Validation} instance.
+ *
+ * @typeParam DTO - The document data transfer object type.
+ * @typeParam STORE - The store implementation used for persistence.
+ * @typeParam VAL - The validation implementation used for input validation.
+ */
 export declare class BackendApi<DTO extends DocumentData, STORE extends Store<DTO> = Store<DTO>, VAL extends Validation<DTO> = Validation<DTO>> extends IBackendApi<DTO, STORE, VAL> implements ApiFromRoutes<CrudRoutes<DTO>> {
+    /**
+     * Delete a document by its key.
+     *
+     * @param request - The document key identifying the document to delete.
+     * @returns An object confirming the deletion.
+     */
     delete(request: DocumentKey): Promise<{
         deleted: true;
     }>;
+    /**
+     * Retrieve a single document by its key.
+     *
+     * @param request - The document key identifying the document to retrieve.
+     * @returns The document including its key metadata.
+     */
     get(request: DocumentKey): Promise<WithKey<DTO>>;
+    /**
+     * Query documents with optional filters.
+     *
+     * @param request - Optional filter criteria to narrow the query results.
+     * @returns An array of documents matching the filter criteria.
+     */
     query(request?: ApiFilter | null): Promise<WithKey<DTO>[]>;
+    /**
+     * Count documents matching optional filter criteria.
+     *
+     * @param request - Optional filter criteria to narrow the count.
+     * @returns An object containing the count of matching documents.
+     */
     count(request?: ApiFilter | null): Promise<{
         count: number;
     }>;
+    /**
+     * Check whether a document exists by its key.
+     *
+     * @param request - The document key identifying the document to check.
+     * @returns An object indicating whether the document exists.
+     */
     exists(request: DocumentKey): Promise<{
         exists: boolean;
     }>;
+    /**
+     * Create a new document after validating the input.
+     *
+     * @param request - The document data without key metadata.
+     * @returns The newly created document including its generated key.
+     * @throws {@link HttpsError} if validation fails.
+     */
     create(request: WithoutKey<DTO>): Promise<WithKey<DTO>>;
+    /**
+     * Update an existing document after validating the partial input.
+     *
+     * @param request - The partial document data including the key of the document to update.
+     * @returns The updated document including its key metadata.
+     * @throws {@link HttpsError} if validation fails.
+     */
     update(request: WithKey<Partial<DTO>>): Promise<WithKey<DTO>>;
 }
 //# sourceMappingURL=BackendApi.d.ts.map

package/dist/api/BackendApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BackendApi.d.ts","sourceRoot":"","sources":["../../src/api/BackendApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,OAAO,EACP,aAAa,EACb,UAAU,EACV,UAAU,EACV,WAAW,EACX,SAAS,EACV,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC1C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,qBAAa,UAAU,CACnB,GAAG,SAAS,YAAY,EACxB,KAAK,SAAS,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,EACrC,GAAG,SAAS,UAAU,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC,CAE/C,SAAQ,WAAW,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,CACnC,YAAW,aAAa,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAE5B,MAAM,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,IAAI,CAAA;KAAE,CAAC;IAKxD,GAAG,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAIhD,KAAK,CAAC,OAAO,CAAC,EAAE,SAAS,GAAG,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;IAI1D,KAAK,CAAC,OAAO,CAAC,EAAE,SAAS,GAAG,IAAI,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAI7D,MAAM,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,OAAO,CAAA;KAAE,CAAC;IAI1D,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAKvD,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;CAI3E"}
+{"version":3,"file":"BackendApi.d.ts","sourceRoot":"","sources":["../../src/api/BackendApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,OAAO,EACP,aAAa,EACb,UAAU,EACV,UAAU,EACV,WAAW,EACX,SAAS,EACV,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC1C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;;;;;;;;;GAUG;AACH,qBAAa,UAAU,CACnB,GAAG,SAAS,YAAY,EACxB,KAAK,SAAS,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,EACrC,GAAG,SAAS,UAAU,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC,CAE/C,SAAQ,WAAW,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,CACnC,YAAW,aAAa,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAEzC;;;;;OAKG;IACU,MAAM,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,IAAI,CAAA;KAAE,CAAC;IAKrE;;;;;OAKG;IACU,GAAG,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAI7D;;;;;OAKG;IACU,KAAK,CAAC,OAAO,CAAC,EAAE,SAAS,GAAG,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;IAIvE;;;;;OAKG;IACU,KAAK,CAAC,OAAO,CAAC,EAAE,SAAS,GAAG,IAAI,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAI1E;;;;;OAKG;IACU,MAAM,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,OAAO,CAAA;KAAE,CAAC;IAIvE;;;;;;OAMG;IACU,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAKpE;;;;;;OAMG;IACU,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;CAI3E"}

package/dist/api/BackendApi.js

@@ -1,25 +1,80 @@
 import { IBackendApi } from "./IBackendApi.js";
+/**
+ * Backend API providing standard CRUD operations for a document type.
+ *
+ * @remarks
+ * Extends {@link IBackendApi} and implements all routes defined by {@link CrudRoutes}.
+ * Delegates persistence to a {@link Store} and input validation to a {@link Validation} instance.
+ *
+ * @typeParam DTO - The document data transfer object type.
+ * @typeParam STORE - The store implementation used for persistence.
+ * @typeParam VAL - The validation implementation used for input validation.
+ */
 export class BackendApi extends IBackendApi {
+    /**
+     * Delete a document by its key.
+     *
+     * @param request - The document key identifying the document to delete.
+     * @returns An object confirming the deletion.
+     */
     async delete(request) {
         await this.store().delete(request.id);
         return { deleted: true };
     }
+    /**
+     * Retrieve a single document by its key.
+     *
+     * @param request - The document key identifying the document to retrieve.
+     * @returns The document including its key metadata.
+     */
     async get(request) {
         return this.store().get(request.id);
     }
+    /**
+     * Query documents with optional filters.
+     *
+     * @param request - Optional filter criteria to narrow the query results.
+     * @returns An array of documents matching the filter criteria.
+     */
     async query(request) {
         return this.store().query(request?.filters);
     }
+    /**
+     * Count documents matching optional filter criteria.
+     *
+     * @param request - Optional filter criteria to narrow the count.
+     * @returns An object containing the count of matching documents.
+     */
     async count(request) {
         return { count: await this.store().count(request?.filters) };
     }
+    /**
+     * Check whether a document exists by its key.
+     *
+     * @param request - The document key identifying the document to check.
+     * @returns An object indicating whether the document exists.
+     */
     async exists(request) {
         return { exists: await this.store().exists(request.id) };
     }
+    /**
+     * Create a new document after validating the input.
+     *
+     * @param request - The document data without key metadata.
+     * @returns The newly created document including its generated key.
+     * @throws {@link HttpsError} if validation fails.
+     */
     async create(request) {
         const result = this.validation().validate(request);
         return this.store().create(result);
     }
+    /**
+     * Update an existing document after validating the partial input.
+     *
+     * @param request - The partial document data including the key of the document to update.
+     * @returns The updated document including its key metadata.
+     * @throws {@link HttpsError} if validation fails.
+     */
     async update(request) {
         const result = this.validation().validatePartial(request);
         return this.store().update(request.id, result);

package/dist/api/BackendApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"BackendApi.js","sourceRoot":"","sources":["../../src/api/BackendApi.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,MAAM,OAAO,UAKX,SAAQ,WAA4B;IAG7B,KAAK,CAAC,MAAM,CAAC,OAAoB;QACtC,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACtC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAC3B,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,OAAoB;QACnC,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACtC,CAAC;IAEM,KAAK,CAAC,KAAK,CAAC,OAA0B;QAC3C,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;IAEM,KAAK,CAAC,KAAK,CAAC,OAA0B;QAC3C,OAAO,EAAE,KAAK,EAAE,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,CAAC;IAC/D,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,OAAoB;QACtC,OAAO,EAAE,MAAM,EAAE,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC;IAC3D,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,OAAwB;QAC1C,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,OAA8B;QAChD,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;IACjD,CAAC;CACF"}
+{"version":3,"file":"BackendApi.js","sourceRoot":"","sources":["../../src/api/BackendApi.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;;;;;;;;;GAUG;AACH,MAAM,OAAO,UAKX,SAAQ,WAA4B;IAGpC;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,OAAoB;QACtC,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACtC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,GAAG,CAAC,OAAoB;QACnC,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACtC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,KAAK,CAAC,OAA0B;QAC3C,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,KAAK,CAAC,OAA0B;QAC3C,OAAO,EAAE,KAAK,EAAE,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,CAAC;IAC/D,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,OAAoB;QACtC,OAAO,EAAE,MAAM,EAAE,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC;IAC3D,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CAAC,OAAwB;QAC1C,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CAAC,OAA8B;QAChD,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;IACjD,CAAC;CACF"}

package/dist/api/IBackendApi.d.ts

@@ -1,14 +1,53 @@
 import type { DocumentData } from "@mxpicture/gcp-functions-common/types";
 import { Store } from "../store/Store.js";
 import type { Validation } from "../validation/Validation.js";
+/**
+ * Abstract base class for backend API implementations.
+ *
+ * @remarks
+ * Provides dependency-injection points for a {@link Store} and {@link Validation} instance.
+ * Subclasses implement the concrete API methods while relying on the injected store and
+ * validation via {@link IBackendApi.useStore} and {@link IBackendApi.useValidation}.
+ *
+ * @typeParam DTO - The document data transfer object type.
+ * @typeParam STORE - The store implementation used for persistence.
+ * @typeParam VAL - The validation implementation used for input validation.
+ */
 export declare abstract class IBackendApi<DTO extends DocumentData, STORE extends Store<DTO> = Store<DTO>, VAL extends Validation<DTO> = Validation<DTO>> {
     readonly name: string;
     protected _store?: STORE;
     protected _validation?: VAL;
+    /**
+     * Create a new backend API instance.
+     *
+     * @param name - A descriptive name for this API, used in error messages.
+     */
     constructor(name: string);
+    /**
+     * Inject the store instance used for data persistence.
+     *
+     * @param store - The store to use for persistence operations.
+     */
     useStore(store: STORE): void;
+    /**
+     * Inject the validation instance used for input validation.
+     *
+     * @param validation - The validation to use for input checking.
+     */
     useValidation(validation: VAL): void;
+    /**
+     * Retrieve the injected store instance.
+     *
+     * @returns The store instance.
+     * @throws {@link Error} if no store has been provided via {@link useStore}.
+     */
     protected store(): STORE;
+    /**
+     * Retrieve the injected validation instance.
+     *
+     * @returns The validation instance.
+     * @throws {@link Error} if no validation has been provided via {@link useValidation}.
+     */
     protected validation(): VAL;
 }
 //# sourceMappingURL=IBackendApi.d.ts.map

package/dist/api/IBackendApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IBackendApi.d.ts","sourceRoot":"","sources":["../../src/api/IBackendApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uCAAuC,CAAC;AAC1E,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC1C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAE9D,8BAAsB,WAAW,CAC/B,GAAG,SAAS,YAAY,EACxB,KAAK,SAAS,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,EACrC,GAAG,SAAS,UAAU,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;aAKV,IAAI,EAAE,MAAM;IAH/C,SAAS,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC;IACzB,SAAS,CAAC,WAAW,CAAC,EAAE,GAAG,CAAC;gBAEO,IAAI,EAAE,MAAM;IAExC,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAI5B,aAAa,CAAC,UAAU,EAAE,GAAG,GAAG,IAAI;IAI3C,SAAS,CAAC,KAAK,IAAI,KAAK;IAQxB,SAAS,CAAC,UAAU,IAAI,GAAG;CAO5B"}
+{"version":3,"file":"IBackendApi.d.ts","sourceRoot":"","sources":["../../src/api/IBackendApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uCAAuC,CAAC;AAC1E,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC1C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAE9D;;;;;;;;;;;GAWG;AACH,8BAAsB,WAAW,CAC/B,GAAG,SAAS,YAAY,EACxB,KAAK,SAAS,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,EACrC,GAAG,SAAS,UAAU,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;aAUV,IAAI,EAAE,MAAM;IAR/C,SAAS,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC;IACzB,SAAS,CAAC,WAAW,CAAC,EAAE,GAAG,CAAC;IAE5B;;;;OAIG;gBACgC,IAAI,EAAE,MAAM;IAE/C;;;;OAIG;IACI,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAInC;;;;OAIG;IACI,aAAa,CAAC,UAAU,EAAE,GAAG,GAAG,IAAI;IAI3C;;;;;OAKG;IACH,SAAS,CAAC,KAAK,IAAI,KAAK;IAQxB;;;;;OAKG;IACH,SAAS,CAAC,UAAU,IAAI,GAAG;CAO5B"}

package/dist/api/IBackendApi.js

@@ -1,21 +1,60 @@
+/**
+ * Abstract base class for backend API implementations.
+ *
+ * @remarks
+ * Provides dependency-injection points for a {@link Store} and {@link Validation} instance.
+ * Subclasses implement the concrete API methods while relying on the injected store and
+ * validation via {@link IBackendApi.useStore} and {@link IBackendApi.useValidation}.
+ *
+ * @typeParam DTO - The document data transfer object type.
+ * @typeParam STORE - The store implementation used for persistence.
+ * @typeParam VAL - The validation implementation used for input validation.
+ */
 export class IBackendApi {
     name;
     _store;
     _validation;
+    /**
+     * Create a new backend API instance.
+     *
+     * @param name - A descriptive name for this API, used in error messages.
+     */
     constructor(name) {
         this.name = name;
     }
+    /**
+     * Inject the store instance used for data persistence.
+     *
+     * @param store - The store to use for persistence operations.
+     */
     useStore(store) {
         this._store = store;
     }
+    /**
+     * Inject the validation instance used for input validation.
+     *
+     * @param validation - The validation to use for input checking.
+     */
     useValidation(validation) {
         this._validation = validation;
     }
+    /**
+     * Retrieve the injected store instance.
+     *
+     * @returns The store instance.
+     * @throws {@link Error} if no store has been provided via {@link useStore}.
+     */
     store() {
         if (!this._store)
             throw new Error(`${this.name}: store not provided. Use "useStore" method`);
         return this._store;
     }
+    /**
+     * Retrieve the injected validation instance.
+     *
+     * @returns The validation instance.
+     * @throws {@link Error} if no validation has been provided via {@link useValidation}.
+     */
     validation() {
         if (!this._validation)
             throw new Error(`${this.name}: validation not provided. Use "useValidation" method`);

package/dist/api/IBackendApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"IBackendApi.js","sourceRoot":"","sources":["../../src/api/IBackendApi.ts"],"names":[],"mappings":"AAIA,MAAM,OAAgB,WAAW;IAQI;IAHzB,MAAM,CAAS;IACf,WAAW,CAAO;IAE5B,YAAmC,IAAY;QAAZ,SAAI,GAAJ,IAAI,CAAQ;IAAG,CAAC;IAE5C,QAAQ,CAAC,KAAY;QAC1B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAEM,aAAa,CAAC,UAAe;QAClC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAES,KAAK;QACb,IAAI,CAAC,IAAI,CAAC,MAAM;YACd,MAAM,IAAI,KAAK,CACb,GAAG,IAAI,CAAC,IAAI,6CAA6C,CAC1D,CAAC;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAES,UAAU;QAClB,IAAI,CAAC,IAAI,CAAC,WAAW;YACnB,MAAM,IAAI,KAAK,CACb,GAAG,IAAI,CAAC,IAAI,uDAAuD,CACpE,CAAC;QACJ,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;CACF"}
+{"version":3,"file":"IBackendApi.js","sourceRoot":"","sources":["../../src/api/IBackendApi.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;GAWG;AACH,MAAM,OAAgB,WAAW;IAaI;IARzB,MAAM,CAAS;IACf,WAAW,CAAO;IAE5B;;;;OAIG;IACH,YAAmC,IAAY;QAAZ,SAAI,GAAJ,IAAI,CAAQ;IAAG,CAAC;IAEnD;;;;OAIG;IACI,QAAQ,CAAC,KAAY;QAC1B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,UAAe;QAClC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED;;;;;OAKG;IACO,KAAK;QACb,IAAI,CAAC,IAAI,CAAC,MAAM;YACd,MAAM,IAAI,KAAK,CACb,GAAG,IAAI,CAAC,IAAI,6CAA6C,CAC1D,CAAC;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;;OAKG;IACO,UAAU;QAClB,IAAI,CAAC,IAAI,CAAC,WAAW;YACnB,MAAM,IAAI,KAAK,CACb,GAAG,IAAI,CAAC,IAAI,uDAAuD,CACpE,CAAC;QACJ,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;CACF"}

package/dist/firebase/firebase.backend.d.ts

@@ -1,3 +1,5 @@
+/** The default Firebase Admin application instance. */
 export declare const app: import("firebase-admin/app").App;
+/** The default Firestore database instance. */
 export declare const db: FirebaseFirestore.Firestore;
 //# sourceMappingURL=firebase.backend.d.ts.map

package/dist/firebase/firebase.backend.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"firebase.backend.d.ts","sourceRoot":"","sources":["../../src/firebase/firebase.backend.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,GAAG,kCAAkB,CAAC;AACnC,eAAO,MAAM,EAAE,6BAAiB,CAAC"}
+{"version":3,"file":"firebase.backend.d.ts","sourceRoot":"","sources":["../../src/firebase/firebase.backend.ts"],"names":[],"mappings":"AAGA,uDAAuD;AACvD,eAAO,MAAM,GAAG,kCAAkB,CAAC;AAEnC,+CAA+C;AAC/C,eAAO,MAAM,EAAE,6BAAiB,CAAC"}

package/dist/firebase/firebase.backend.js

@@ -1,5 +1,7 @@
 import { getFirestore } from "firebase-admin/firestore";
 import { initializeApp } from "firebase-admin/app";
+/** The default Firebase Admin application instance. */
 export const app = initializeApp();
+/** The default Firestore database instance. */
 export const db = getFirestore();
 //# sourceMappingURL=firebase.backend.js.map

package/dist/firebase/firebase.backend.js.map

@@ -1 +1 @@
-{"version":3,"file":"firebase.backend.js","sourceRoot":"","sources":["../../src/firebase/firebase.backend.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,MAAM,CAAC,MAAM,GAAG,GAAG,aAAa,EAAE,CAAC;AACnC,MAAM,CAAC,MAAM,EAAE,GAAG,YAAY,EAAE,CAAC"}
+{"version":3,"file":"firebase.backend.js","sourceRoot":"","sources":["../../src/firebase/firebase.backend.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,uDAAuD;AACvD,MAAM,CAAC,MAAM,GAAG,GAAG,aAAa,EAAE,CAAC;AAEnC,+CAA+C;AAC/C,MAAM,CAAC,MAAM,EAAE,GAAG,YAAY,EAAE,CAAC"}

package/dist/function/IBackendFunction.d.ts

@@ -1,6 +1,17 @@
 import type { DocumentData, FunctionRequest, FunctionResponse } from "@mxpicture/gcp-functions-common/types";
 import { BackendApi } from "../api/BackendApi.js";
 import { CallableFunction } from "firebase-functions/v2/https";
+/**
+ * Abstract base class for Firebase callable backend functions.
+ *
+ * @remarks
+ * Encapsulates the wiring between an incoming callable request and a {@link BackendApi}.
+ * Subclasses configure the API, routes, region, and service account, then call
+ * {@link IBackendFunction.buildFunction} to produce a deployable Cloud Function.
+ *
+ * @typeParam DTO - The document data transfer object type.
+ * @typeParam API - The backend API implementation that handles route logic.
+ */
 export declare abstract class IBackendFunction<DTO extends DocumentData, API extends BackendApi<DTO>> {
     readonly name: string;
     readonly region: string;
@@ -8,14 +19,67 @@ export declare abstract class IBackendFunction<DTO extends DocumentData, API ext
     protected readonly datePaths: string[];
     protected _api?: API;
     protected _routes?: string[];
+    /**
+     * Create a new backend function instance.
+     *
+     * @param name - A descriptive name for this function, used in error messages.
+     * @param region - The GCP region in which the function is deployed.
+     * @param serviceAccount - The service account email used to run the function.
+     * @param datePaths - JSON paths within the response payload that contain date values to convert to Firestore Timestamps.
+     */
     constructor(name: string, region: string, serviceAccount: string, datePaths: string[]);
+    /**
+     * Inject the backend API instance that handles route logic.
+     *
+     * @param api - The API instance to delegate requests to.
+     */
     useApi(api: API): void;
+    /**
+     * Register the allowed route names for this function.
+     *
+     * @param routes - An array of route names or a record whose values are route names.
+     */
     useRoutes(routes: {
         [key: string]: string;
     } | string[]): void;
+    /**
+     * Retrieve the injected API instance.
+     *
+     * @returns The API instance.
+     * @throws {@link Error} if no API has been provided via {@link useApi}.
+     */
     protected api(): API;
+    /**
+     * Retrieve the registered route names.
+     *
+     * @returns The array of allowed route names.
+     * @throws {@link Error} if no routes have been provided via {@link useRoutes}.
+     */
     protected routes(): string[];
+    /**
+     * Route an incoming function request to the appropriate API method.
+     *
+     * @remarks
+     * Validates that the requested route is registered, delegates to the API, and
+     * converts date fields in the response payload to Firestore Timestamps.
+     *
+     * @typeParam REQ - The request payload type.
+     * @typeParam RES - The response document data type.
+     * @param request - The incoming function request containing route and data.
+     * @returns The function response wrapping the API result.
+     * @throws {@link HttpsError} with `invalid-argument` if the route is not registered.
+     * @throws {@link HttpsError} with `internal` if the API method throws an unexpected error.
+     */
     ingress<REQ, RES extends DocumentData>(request: FunctionRequest<REQ>): Promise<FunctionResponse<RES>>;
+    /**
+     * Build and return a Firebase callable Cloud Function.
+     *
+     * @remarks
+     * Wraps {@link ingress} in a Firebase `onCall` handler configured with the
+     * specified region and service account.
+     *
+     * @returns A Firebase {@link CallableFunction} ready for deployment.
+     */
     buildFunction(): CallableFunction<FunctionRequest<any>, Promise<FunctionResponse<any>>>;
 }
 //# sourceMappingURL=IBackendFunction.d.ts.map

package/dist/function/IBackendFunction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IBackendFunction.d.ts","sourceRoot":"","sources":["../../src/function/IBackendFunction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,eAAe,EACf,gBAAgB,EACjB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAEL,gBAAgB,EAEjB,MAAM,6BAA6B,CAAC;AAGrC,8BAAsB,gBAAgB,CACpC,GAAG,SAAS,YAAY,EACxB,GAAG,SAAS,UAAU,CAAC,GAAG,CAAC;aAMT,IAAI,EAAE,MAAM;aACZ,MAAM,EAAE,MAAM;aACd,cAAc,EAAE,MAAM;IACtC,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE;IAPxC,SAAS,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC;IACrB,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;gBAGX,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,cAAc,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,EAAE;IAGjC,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI;IAItB,SAAS,CAAC,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,MAAM,EAAE,GAAG,IAAI;IAIpE,SAAS,CAAC,GAAG,IAAI,GAAG;IAMpB,SAAS,CAAC,MAAM,IAAI,MAAM,EAAE;IAQf,OAAO,CAAC,GAAG,EAAE,GAAG,SAAS,YAAY,EAChD,OAAO,EAAE,eAAe,CAAC,GAAG,CAAC,GAC5B,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;IAoB1B,aAAa,IAAI,gBAAgB,CAEtC,eAAe,CAAC,GAAG,CAAC,EAEpB,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAC/B;CAMF"}
+{"version":3,"file":"IBackendFunction.d.ts","sourceRoot":"","sources":["../../src/function/IBackendFunction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,eAAe,EACf,gBAAgB,EACjB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAEL,gBAAgB,EAEjB,MAAM,6BAA6B,CAAC;AAMrC;;;;;;;;;;GAUG;AACH,8BAAsB,gBAAgB,CACpC,GAAG,SAAS,YAAY,EACxB,GAAG,SAAS,UAAU,CAAC,GAAG,CAAC;aAcT,IAAI,EAAE,MAAM;aACZ,MAAM,EAAE,MAAM;aACd,cAAc,EAAE,MAAM;IACtC,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE;IAfxC,SAAS,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC;IACrB,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAE7B;;;;;;;OAOG;gBAEe,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,cAAc,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,EAAE;IAGxC;;;;OAIG;IACI,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI;IAI7B;;;;OAIG;IACI,SAAS,CAAC,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,MAAM,EAAE,GAAG,IAAI;IAIpE;;;;;OAKG;IACH,SAAS,CAAC,GAAG,IAAI,GAAG;IAMpB;;;;;OAKG;IACH,SAAS,CAAC,MAAM,IAAI,MAAM,EAAE;IAQ5B;;;;;;;;;;;;;OAaG;IACU,OAAO,CAAC,GAAG,EAAE,GAAG,SAAS,YAAY,EAChD,OAAO,EAAE,eAAe,CAAC,GAAG,CAAC,GAC5B,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;IAsBjC;;;;;;;;OAQG;IACI,aAAa,IAAI,gBAAgB,CAEtC,eAAe,CAAC,GAAG,CAAC,EAEpB,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAC/B;CAMF"}

package/dist/function/IBackendFunction.js

@@ -1,5 +1,16 @@
 import { onCall, HttpsError, } from "firebase-functions/v2/https";
-import { toTimestampsDeep } from "@mxpicture/gcp-functions-common/helper";
+import { toDatesDeep, toTimestampsDeep, } from "@mxpicture/gcp-functions-common/helper";
+/**
+ * Abstract base class for Firebase callable backend functions.
+ *
+ * @remarks
+ * Encapsulates the wiring between an incoming callable request and a {@link BackendApi}.
+ * Subclasses configure the API, routes, region, and service account, then call
+ * {@link IBackendFunction.buildFunction} to produce a deployable Cloud Function.
+ *
+ * @typeParam DTO - The document data transfer object type.
+ * @typeParam API - The backend API implementation that handles route logic.
+ */
 export class IBackendFunction {
     name;
     region;
@@ -7,35 +18,80 @@ export class IBackendFunction {
     datePaths;
     _api;
     _routes;
+    /**
+     * Create a new backend function instance.
+     *
+     * @param name - A descriptive name for this function, used in error messages.
+     * @param region - The GCP region in which the function is deployed.
+     * @param serviceAccount - The service account email used to run the function.
+     * @param datePaths - JSON paths within the response payload that contain date values to convert to Firestore Timestamps.
+     */
     constructor(name, region, serviceAccount, datePaths) {
         this.name = name;
         this.region = region;
         this.serviceAccount = serviceAccount;
         this.datePaths = datePaths;
     }
+    /**
+     * Inject the backend API instance that handles route logic.
+     *
+     * @param api - The API instance to delegate requests to.
+     */
     useApi(api) {
         this._api = api;
     }
+    /**
+     * Register the allowed route names for this function.
+     *
+     * @param routes - An array of route names or a record whose values are route names.
+     */
     useRoutes(routes) {
         this._routes = Array.isArray(routes) ? routes : Object.values(routes);
     }
+    /**
+     * Retrieve the injected API instance.
+     *
+     * @returns The API instance.
+     * @throws {@link Error} if no API has been provided via {@link useApi}.
+     */
     api() {
         if (!this._api)
             throw new Error(`${this.name}: api not provided. Use "useApi" method`);
         return this._api;
     }
+    /**
+     * Retrieve the registered route names.
+     *
+     * @returns The array of allowed route names.
+     * @throws {@link Error} if no routes have been provided via {@link useRoutes}.
+     */
     routes() {
         if (!this._routes)
             throw new Error(`${this.name}: routes not provided. Use "useRoutes" method`);
         return this._routes;
     }
+    /**
+     * Route an incoming function request to the appropriate API method.
+     *
+     * @remarks
+     * Validates that the requested route is registered, delegates to the API, and
+     * converts date fields in the response payload to Firestore Timestamps.
+     *
+     * @typeParam REQ - The request payload type.
+     * @typeParam RES - The response document data type.
+     * @param request - The incoming function request containing route and data.
+     * @returns The function response wrapping the API result.
+     * @throws {@link HttpsError} with `invalid-argument` if the route is not registered.
+     * @throws {@link HttpsError} with `internal` if the API method throws an unexpected error.
+     */
     async ingress(request) {
         const routes = this.routes();
         if (!routes.find((m) => m === request.route))
             throw new HttpsError("invalid-argument", `Route ${request.route} not available`);
         try {
+            const requestData = toDatesDeep(request.data, this.datePaths);
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            const payload = await this.api()[request.route](request.data);
+            const payload = await this.api()[request.route](requestData);
             return { data: toTimestampsDeep(payload, this.datePaths) };
         }
         catch (error) {
@@ -46,6 +102,15 @@ export class IBackendFunction {
             // }
         }
     }
+    /**
+     * Build and return a Firebase callable Cloud Function.
+     *
+     * @remarks
+     * Wraps {@link ingress} in a Firebase `onCall` handler configured with the
+     * specified region and service account.
+     *
+     * @returns A Firebase {@link CallableFunction} ready for deployment.
+     */
     buildFunction() {
         return onCall({ region: this.region, serviceAccount: this.serviceAccount }, async (req) => this.ingress(req.data));
     }

package/dist/function/IBackendFunction.js.map

@@ -1 +1 @@
-{"version":3,"file":"IBackendFunction.js","sourceRoot":"","sources":["../../src/function/IBackendFunction.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,MAAM,EAEN,UAAU,GACX,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,gBAAgB,EAAE,MAAM,wCAAwC,CAAC;AAE1E,MAAM,OAAgB,gBAAgB;IAQlB;IACA;IACA;IACG;IAPX,IAAI,CAAO;IACX,OAAO,CAAY;IAE7B,YACkB,IAAY,EACZ,MAAc,EACd,cAAsB,EACnB,SAAmB;QAHtB,SAAI,GAAJ,IAAI,CAAQ;QACZ,WAAM,GAAN,MAAM,CAAQ;QACd,mBAAc,GAAd,cAAc,CAAQ;QACnB,cAAS,GAAT,SAAS,CAAU;IACrC,CAAC;IAEG,MAAM,CAAC,GAAQ;QACpB,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;IAClB,CAAC;IAEM,SAAS,CAAC,MAA4C;QAC3D,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACxE,CAAC;IAES,GAAG;QACX,IAAI,CAAC,IAAI,CAAC,IAAI;YACZ,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,IAAI,yCAAyC,CAAC,CAAC;QACzE,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAES,MAAM;QACd,IAAI,CAAC,IAAI,CAAC,OAAO;YACf,MAAM,IAAI,KAAK,CACb,GAAG,IAAI,CAAC,IAAI,+CAA+C,CAC5D,CAAC;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEM,KAAK,CAAC,OAAO,CAClB,OAA6B;QAE7B,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAC7B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,OAAO,CAAC,KAAK,CAAC;YAC1C,MAAM,IAAI,UAAU,CAClB,kBAAkB,EAClB,SAAS,OAAO,CAAC,KAAK,gBAAgB,CACvC,CAAC;QAEJ,IAAI,CAAC;YACH,8DAA8D;YAC9D,MAAM,OAAO,GAAG,MAAO,IAAI,CAAC,GAAG,EAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACvE,OAAO,EAAE,IAAI,EAAE,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QAC7D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,UAAU;gBAAE,MAAM,KAAK,CAAC;YAC7C,8DAA8D;YAC9D,MAAM,IAAI,UAAU,CAAC,UAAU,EAAG,KAAa,EAAE,OAAO,IAAI,SAAS,CAAC,CAAC;YACvE,IAAI;QACN,CAAC;IACH,CAAC;IAEM,aAAa;QAMlB,OAAO,MAAM,CACX,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,cAAc,EAAE,IAAI,CAAC,cAAc,EAAE,EAC5D,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CACtC,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"IBackendFunction.js","sourceRoot":"","sources":["../../src/function/IBackendFunction.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,MAAM,EAEN,UAAU,GACX,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,WAAW,EACX,gBAAgB,GACjB,MAAM,wCAAwC,CAAC;AAEhD;;;;;;;;;;GAUG;AACH,MAAM,OAAgB,gBAAgB;IAgBlB;IACA;IACA;IACG;IAfX,IAAI,CAAO;IACX,OAAO,CAAY;IAE7B;;;;;;;OAOG;IACH,YACkB,IAAY,EACZ,MAAc,EACd,cAAsB,EACnB,SAAmB;QAHtB,SAAI,GAAJ,IAAI,CAAQ;QACZ,WAAM,GAAN,MAAM,CAAQ;QACd,mBAAc,GAAd,cAAc,CAAQ;QACnB,cAAS,GAAT,SAAS,CAAU;IACrC,CAAC;IAEJ;;;;OAIG;IACI,MAAM,CAAC,GAAQ;QACpB,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACI,SAAS,CAAC,MAA4C;QAC3D,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACxE,CAAC;IAED;;;;;OAKG;IACO,GAAG;QACX,IAAI,CAAC,IAAI,CAAC,IAAI;YACZ,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,IAAI,yCAAyC,CAAC,CAAC;QACzE,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACO,MAAM;QACd,IAAI,CAAC,IAAI,CAAC,OAAO;YACf,MAAM,IAAI,KAAK,CACb,GAAG,IAAI,CAAC,IAAI,+CAA+C,CAC5D,CAAC;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,KAAK,CAAC,OAAO,CAClB,OAA6B;QAE7B,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAC7B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,OAAO,CAAC,KAAK,CAAC;YAC1C,MAAM,IAAI,UAAU,CAClB,kBAAkB,EAClB,SAAS,OAAO,CAAC,KAAK,gBAAgB,CACvC,CAAC;QAEJ,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YAE9D,8DAA8D;YAC9D,MAAM,OAAO,GAAG,MAAO,IAAI,CAAC,GAAG,EAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,CAAC;YACtE,OAAO,EAAE,IAAI,EAAE,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QAC7D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,UAAU;gBAAE,MAAM,KAAK,CAAC;YAC7C,8DAA8D;YAC9D,MAAM,IAAI,UAAU,CAAC,UAAU,EAAG,KAAa,EAAE,OAAO,IAAI,SAAS,CAAC,CAAC;YACvE,IAAI;QACN,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACI,aAAa;QAMlB,OAAO,MAAM,CACX,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,cAAc,EAAE,IAAI,CAAC,cAAc,EAAE,EAC5D,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CACtC,CAAC;IACJ,CAAC;CACF"}

package/dist/store/Store.d.ts

@@ -1,24 +1,114 @@
 import { CollectionReference, DocumentReference, FirestoreDataConverter, Query, QuerySnapshot } from "firebase-admin/firestore";
 import type { ApiFilterItems, DocumentData, WithKey } from "@mxpicture/gcp-functions-common/types";
+/**
+ * Firestore-backed data store for a document type.
+ *
+ * @remarks
+ * Provides CRUD operations and query helpers against a namespaced Firestore collection.
+ * The collection path is derived as `{namespace}.{collectionName}`.
+ *
+ * @typeParam DTO - The document data transfer object type.
+ */
 export declare class Store<DTO extends DocumentData> {
     readonly collectionName: string;
     readonly namespace: string;
     protected readonly converter?: FirestoreDataConverter<DTO> | undefined;
     protected _db?: CollectionReference<DTO>;
+    /**
+     * Create a new Store instance.
+     *
+     * @param collectionName - The Firestore collection name.
+     * @param namespace - A namespace prefix for the collection path.
+     * @param converter - An optional Firestore data converter for custom serialization.
+     */
     constructor(collectionName: string, namespace: string, converter?: FirestoreDataConverter<DTO> | undefined);
+    /**
+     * Get or lazily initialize the Firestore collection reference.
+     *
+     * @returns The typed Firestore collection reference.
+     */
     db(): CollectionReference<DTO>;
+    /**
+     * Query documents, optionally filtered by parent ID.
+     *
+     * @param p - Optional filter items; when `parentId` is set, queries by parent.
+     * @returns An array of documents with key metadata.
+     */
     query(p?: ApiFilterItems): Promise<WithKey<DTO>[]>;
+    /**
+     * Execute a Firestore query and return the raw snapshot.
+     *
+     * @remarks
+     * Supports filtering by `parentId` or by arbitrary field-level filters.
+     *
+     * @param p - Optional filter items to apply.
+     * @returns The Firestore query snapshot.
+     */
     protected querySnapshot(p?: ApiFilterItems): Promise<QuerySnapshot<DTO>>;
+    /**
+     * Count documents, optionally filtered by parent ID.
+     *
+     * @param p - Optional object with a `parentId` to scope the count.
+     * @returns The number of matching documents.
+     */
     count(p?: {
         parentId?: string;
     }): Promise<number>;
+    /**
+     * Get a Firestore document reference by ID.
+     *
+     * @param id - The document ID.
+     * @returns The typed Firestore document reference.
+     */
     ref(id: string): DocumentReference<DTO>;
+    /**
+     * Retrieve a single document by ID.
+     *
+     * @param id - The document ID.
+     * @returns The document data including key metadata.
+     * @throws {@link Error} if the document does not exist or its data is invalid.
+     */
     get(id: string): Promise<WithKey<DTO>>;
+    /**
+     * Check whether a document exists by ID.
+     *
+     * @param id - The document ID.
+     * @returns `true` if the document exists, `false` otherwise.
+     */
     exists(id: string): Promise<boolean>;
+    /**
+     * Create a new document with an auto-generated short UUID.
+     *
+     * @param doc - The document data to persist.
+     * @returns The persisted document including its generated key metadata.
+     */
     create(doc: DTO): Promise<WithKey<DTO>>;
+    /**
+     * Update an existing document by merging partial data.
+     *
+     * @param id - The document ID to update.
+     * @param doc - The partial document data to merge.
+     * @returns The updated document including its key metadata.
+     */
     update(id: string, doc: Partial<DTO>): Promise<WithKey<DTO>>;
+    /**
+     * Delete one or more documents by their IDs.
+     *
+     * @param ids - The document IDs to delete.
+     */
     delete(...ids: string[]): Promise<void>;
+    /**
+     * Delete all documents that belong to a given parent.
+     *
+     * @param parentId - The parent document ID whose children should be deleted.
+     */
     deleteByParent(parentId: string): Promise<void>;
+    /**
+     * Build a Firestore query scoped to a specific parent document.
+     *
+     * @param parentId - The parent document ID to filter by.
+     * @returns A Firestore query filtering documents where `parentId` matches.
+     */
     refByParent(parentId: string): Query<DTO, FirebaseFirestore.DocumentData>;
 }
 //# sourceMappingURL=Store.d.ts.map

package/dist/store/Store.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Store.d.ts","sourceRoot":"","sources":["../../src/store/Store.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,mBAAmB,EACnB,iBAAiB,EACjB,sBAAsB,EACtB,KAAK,EACL,aAAa,EACd,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EACV,cAAc,EACd,YAAY,EACZ,OAAO,EACR,MAAM,uCAAuC,CAAC;AAE/C,qBAAa,KAAK,CAAC,GAAG,SAAS,YAAY;aAIvB,cAAc,EAAE,MAAM;aACtB,SAAS,EAAE,MAAM;IACjC,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,sBAAsB,CAAC,GAAG,CAAC;IAL5D,SAAS,CAAC,GAAG,CAAC,EAAE,mBAAmB,CAAC,GAAG,CAAC,CAAC;gBAGvB,cAAc,EAAE,MAAM,EACtB,SAAS,EAAE,MAAM,EACd,SAAS,CAAC,EAAE,sBAAsB,CAAC,GAAG,CAAC,YAAA;IAGrD,EAAE,IAAI,mBAAmB,CAAC,GAAG,CAAC;IAaxB,KAAK,CAAC,CAAC,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;cAc/C,aAAa,CAC3B,CAAC,CAAC,EAAE,cAAc,GACjB,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAcjB,KAAK,CAAC,CAAC,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IASvD,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,iBAAiB,CAAC,GAAG,CAAC;IAIjC,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAWtC,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIpC,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAOvC,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAM5D,MAAM,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvC,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAKrD,WAAW,CAAC,QAAQ,EAAE,MAAM;CAGpC"}
+{"version":3,"file":"Store.d.ts","sourceRoot":"","sources":["../../src/store/Store.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,mBAAmB,EACnB,iBAAiB,EACjB,sBAAsB,EACtB,KAAK,EACL,aAAa,EACd,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EACV,cAAc,EACd,YAAY,EACZ,OAAO,EACR,MAAM,uCAAuC,CAAC;AAE/C;;;;;;;;GAQG;AACH,qBAAa,KAAK,CAAC,GAAG,SAAS,YAAY;aAWvB,cAAc,EAAE,MAAM;aACtB,SAAS,EAAE,MAAM;IACjC,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,sBAAsB,CAAC,GAAG,CAAC;IAZ5D,SAAS,CAAC,GAAG,CAAC,EAAE,mBAAmB,CAAC,GAAG,CAAC,CAAC;IAEzC;;;;;;OAMG;gBAEe,cAAc,EAAE,MAAM,EACtB,SAAS,EAAE,MAAM,EACd,SAAS,CAAC,EAAE,sBAAsB,CAAC,GAAG,CAAC,YAAA;IAG5D;;;;OAIG;IACI,EAAE,IAAI,mBAAmB,CAAC,GAAG,CAAC;IAarC;;;;;OAKG;IACU,KAAK,CAAC,CAAC,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;IAc/D;;;;;;;;OAQG;cACa,aAAa,CAC3B,CAAC,CAAC,EAAE,cAAc,GACjB,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAc9B;;;;;OAKG;IACU,KAAK,CAAC,CAAC,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAS9D;;;;;OAKG;IACI,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,iBAAiB,CAAC,GAAG,CAAC;IAI9C;;;;;;OAMG;IACU,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAWnD;;;;;OAKG;IACU,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIjD;;;;;OAKG;IACU,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAOpD;;;;;;OAMG;IACU,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAMzE;;;;OAIG;IACU,MAAM,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAIpD;;;;OAIG;IACU,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAK5D;;;;;OAKG;IACI,WAAW,CAAC,QAAQ,EAAE,MAAM;CAGpC"}

package/dist/store/Store.js

@@ -1,15 +1,36 @@
 import { db as firestore } from "../firebase/firebase.backend.js";
 import * as uuid from "short-uuid";
+/**
+ * Firestore-backed data store for a document type.
+ *
+ * @remarks
+ * Provides CRUD operations and query helpers against a namespaced Firestore collection.
+ * The collection path is derived as `{namespace}.{collectionName}`.
+ *
+ * @typeParam DTO - The document data transfer object type.
+ */
 export class Store {
     collectionName;
     namespace;
     converter;
     _db;
+    /**
+     * Create a new Store instance.
+     *
+     * @param collectionName - The Firestore collection name.
+     * @param namespace - A namespace prefix for the collection path.
+     * @param converter - An optional Firestore data converter for custom serialization.
+     */
     constructor(collectionName, namespace, converter) {
         this.collectionName = collectionName;
         this.namespace = namespace;
         this.converter = converter;
     }
+    /**
+     * Get or lazily initialize the Firestore collection reference.
+     *
+     * @returns The typed Firestore collection reference.
+     */
     db() {
         if (!this._db)
             if (this.converter)
@@ -20,6 +41,12 @@ export class Store {
                 this._db = firestore.collection(`${this.namespace}.${this.collectionName}`);
         return this._db;
     }
+    /**
+     * Query documents, optionally filtered by parent ID.
+     *
+     * @param p - Optional filter items; when `parentId` is set, queries by parent.
+     * @returns An array of documents with key metadata.
+     */
     async query(p) {
         const snapshot = p && p.parentId
             ? await this.refByParent(p.parentId).get()
@@ -31,6 +58,15 @@ export class Store {
             updateTime: doc.updateTime.toDate(),
         }));
     }
+    /**
+     * Execute a Firestore query and return the raw snapshot.
+     *
+     * @remarks
+     * Supports filtering by `parentId` or by arbitrary field-level filters.
+     *
+     * @param p - Optional filter items to apply.
+     * @returns The Firestore query snapshot.
+     */
     async querySnapshot(p) {
         if (!p)
             return this.db().get();
@@ -47,15 +83,34 @@ export class Store {
         }
         return (query ?? this.db()).get();
     }
+    /**
+     * Count documents, optionally filtered by parent ID.
+     *
+     * @param p - Optional object with a `parentId` to scope the count.
+     * @returns The number of matching documents.
+     */
     async count(p) {
         const snapshot = p && p.parentId
             ? await this.refByParent(p.parentId).count().get()
             : await this.db().count().get();
         return snapshot.data().count;
     }
+    /**
+     * Get a Firestore document reference by ID.
+     *
+     * @param id - The document ID.
+     * @returns The typed Firestore document reference.
+     */
     ref(id) {
         return this.db().doc(id);
     }
+    /**
+     * Retrieve a single document by ID.
+     *
+     * @param id - The document ID.
+     * @returns The document data including key metadata.
+     * @throws {@link Error} if the document does not exist or its data is invalid.
+     */
     async get(id) {
         const snapshot = await this.ref(id).get();
         if (!snapshot.exists)
@@ -68,27 +123,62 @@ export class Store {
         data.createTime = snapshot.createTime?.toDate();
         return data;
     }
+    /**
+     * Check whether a document exists by ID.
+     *
+     * @param id - The document ID.
+     * @returns `true` if the document exists, `false` otherwise.
+     */
     async exists(id) {
         return (await this.ref(id).get()).exists;
     }
+    /**
+     * Create a new document with an auto-generated short UUID.
+     *
+     * @param doc - The document data to persist.
+     * @returns The persisted document including its generated key metadata.
+     */
     async create(doc) {
         const id = uuid.generate();
         const ref = this.ref(id);
         await ref.set(doc);
         return this.get(id);
     }
+    /**
+     * Update an existing document by merging partial data.
+     *
+     * @param id - The document ID to update.
+     * @param doc - The partial document data to merge.
+     * @returns The updated document including its key metadata.
+     */
     async update(id, doc) {
         const entry = this.ref(id);
         await entry.update({ ...doc });
         return this.get(id);
     }
+    /**
+     * Delete one or more documents by their IDs.
+     *
+     * @param ids - The document IDs to delete.
+     */
     async delete(...ids) {
         await Promise.all(ids.map((id) => this.ref(id).delete()));
     }
+    /**
+     * Delete all documents that belong to a given parent.
+     *
+     * @param parentId - The parent document ID whose children should be deleted.
+     */
     async deleteByParent(parentId) {
         const snapshot = await this.refByParent(parentId).get();
         await this.delete(...snapshot.docs.map((doc) => doc.id));
     }
+    /**
+     * Build a Firestore query scoped to a specific parent document.
+     *
+     * @param parentId - The parent document ID to filter by.
+     * @returns A Firestore query filtering documents where `parentId` matches.
+     */
     refByParent(parentId) {
         return this.db().where("parentId", "==", parentId);
     }

package/dist/store/Store.js.map

@@ -1 +1 @@
-{"version":3,"file":"Store.js","sourceRoot":"","sources":["../../src/store/Store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,IAAI,SAAS,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAcnC,MAAM,OAAO,KAAK;IAIE;IACA;IACG;IALX,GAAG,CAA4B;IAEzC,YACkB,cAAsB,EACtB,SAAiB,EACd,SAAuC;QAF1C,mBAAc,GAAd,cAAc,CAAQ;QACtB,cAAS,GAAT,SAAS,CAAQ;QACd,cAAS,GAAT,SAAS,CAA8B;IACzD,CAAC;IAEG,EAAE;QACP,IAAI,CAAC,IAAI,CAAC,GAAG;YACX,IAAI,IAAI,CAAC,SAAS;gBAChB,IAAI,CAAC,GAAG,GAAG,SAAS;qBACjB,UAAU,CAAC,GAAG,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;qBACtD,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;;gBAEjC,IAAI,CAAC,GAAG,GAAG,SAAS,CAAC,UAAU,CAC7B,GAAG,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,cAAc,EAAE,CACf,CAAC;QAClC,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAEM,KAAK,CAAC,KAAK,CAAC,CAAkB;QACnC,MAAM,QAAQ,GACZ,CAAC,IAAI,CAAC,CAAC,QAAQ;YACb,CAAC,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,GAAG,EAAE;YAC1C,CAAC,CAAC,MAAM,IAAI,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC;QAE5B,OAAO,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YACjC,GAAG,GAAG,CAAC,IAAI,EAAE;YACb,EAAE,EAAE,GAAG,CAAC,EAAE;YACV,UAAU,EAAE,GAAG,CAAC,UAAU,CAAC,MAAM,EAAE;YACnC,UAAU,EAAE,GAAG,CAAC,UAAU,CAAC,MAAM,EAAE;SACpC,CAAC,CAAmB,CAAC;IACxB,CAAC;IAES,KAAK,CAAC,aAAa,CAC3B,CAAkB;QAElB,IAAI,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC;QAC/B,IAAI,CAAC,CAAC,QAAQ;YAAE,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,GAAG,EAAE,CAAC;QAE1D,IAAI,KAAK,GAAsB,IAAI,CAAC;QACpC,KAAK,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;YAChD,IAAI,OAAO,MAAM,KAAK,QAAQ;gBAAE,SAAS;YACzC,IAAI,CAAC,KAAK;gBAAE,KAAK,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;;gBAC/D,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;QAC3D,CAAC;QAED,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC;IACpC,CAAC;IAEM,KAAK,CAAC,KAAK,CAAC,CAAyB;QAC1C,MAAM,QAAQ,GACZ,CAAC,IAAI,CAAC,CAAC,QAAQ;YACb,CAAC,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE;YAClD,CAAC,CAAC,MAAM,IAAI,CAAC,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,CAAC;QAEpC,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC;IAC/B,CAAC;IAEM,GAAG,CAAC,EAAU;QACnB,OAAO,IAAI,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC3B,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,EAAU;QACzB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC;QAC1C,IAAI,CAAC,QAAQ,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;QACjE,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,EAAkB,CAAC;QAC7C,IAAI,CAAC,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;QACrD,IAAI,CAAC,EAAE,GAAG,QAAQ,CAAC,EAAE,CAAC;QACtB,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;QAChD,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;QAChD,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,EAAU;QAC5B,OAAO,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC;IAC3C,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,GAAQ;QAC1B,MAAM,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACzB,MAAM,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACnB,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACtB,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,GAAiB;QAC/C,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC3B,MAAM,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,CAAC;QAC/B,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACtB,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,GAAG,GAAa;QAClC,MAAM,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAC5D,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,QAAgB;QAC1C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,GAAG,EAAE,CAAC;QACxD,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3D,CAAC;IAEM,WAAW,CAAC,QAAgB;QACjC,OAAO,IAAI,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IACrD,CAAC;CACF"}
+{"version":3,"file":"Store.js","sourceRoot":"","sources":["../../src/store/Store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,IAAI,SAAS,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAcnC;;;;;;;;GAQG;AACH,MAAM,OAAO,KAAK;IAWE;IACA;IACG;IAZX,GAAG,CAA4B;IAEzC;;;;;;OAMG;IACH,YACkB,cAAsB,EACtB,SAAiB,EACd,SAAuC;QAF1C,mBAAc,GAAd,cAAc,CAAQ;QACtB,cAAS,GAAT,SAAS,CAAQ;QACd,cAAS,GAAT,SAAS,CAA8B;IACzD,CAAC;IAEJ;;;;OAIG;IACI,EAAE;QACP,IAAI,CAAC,IAAI,CAAC,GAAG;YACX,IAAI,IAAI,CAAC,SAAS;gBAChB,IAAI,CAAC,GAAG,GAAG,SAAS;qBACjB,UAAU,CAAC,GAAG,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;qBACtD,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;;gBAEjC,IAAI,CAAC,GAAG,GAAG,SAAS,CAAC,UAAU,CAC7B,GAAG,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,cAAc,EAAE,CACf,CAAC;QAClC,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,KAAK,CAAC,CAAkB;QACnC,MAAM,QAAQ,GACZ,CAAC,IAAI,CAAC,CAAC,QAAQ;YACb,CAAC,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,GAAG,EAAE;YAC1C,CAAC,CAAC,MAAM,IAAI,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC;QAE5B,OAAO,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YACjC,GAAG,GAAG,CAAC,IAAI,EAAE;YACb,EAAE,EAAE,GAAG,CAAC,EAAE;YACV,UAAU,EAAE,GAAG,CAAC,UAAU,CAAC,MAAM,EAAE;YACnC,UAAU,EAAE,GAAG,CAAC,UAAU,CAAC,MAAM,EAAE;SACpC,CAAC,CAAmB,CAAC;IACxB,CAAC;IAED;;;;;;;;OAQG;IACO,KAAK,CAAC,aAAa,CAC3B,CAAkB;QAElB,IAAI,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC;QAC/B,IAAI,CAAC,CAAC,QAAQ;YAAE,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,GAAG,EAAE,CAAC;QAE1D,IAAI,KAAK,GAAsB,IAAI,CAAC;QACpC,KAAK,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;YAChD,IAAI,OAAO,MAAM,KAAK,QAAQ;gBAAE,SAAS;YACzC,IAAI,CAAC,KAAK;gBAAE,KAAK,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;;gBAC/D,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;QAC3D,CAAC;QAED,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC;IACpC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,KAAK,CAAC,CAAyB;QAC1C,MAAM,QAAQ,GACZ,CAAC,IAAI,CAAC,CAAC,QAAQ;YACb,CAAC,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE;YAClD,CAAC,CAAC,MAAM,IAAI,CAAC,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,CAAC;QAEpC,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACI,GAAG,CAAC,EAAU;QACnB,OAAO,IAAI,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,GAAG,CAAC,EAAU;QACzB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC;QAC1C,IAAI,CAAC,QAAQ,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;QACjE,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,EAAkB,CAAC;QAC7C,IAAI,CAAC,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;QACrD,IAAI,CAAC,EAAE,GAAG,QAAQ,CAAC,EAAE,CAAC;QACtB,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;QAChD,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;QAChD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,EAAU;QAC5B,OAAO,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,GAAQ;QAC1B,MAAM,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACzB,MAAM,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACnB,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACtB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,GAAiB;QAC/C,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC3B,MAAM,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,CAAC;QAC/B,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,MAAM,CAAC,GAAG,GAAa;QAClC,MAAM,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,cAAc,CAAC,QAAgB;QAC1C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,GAAG,EAAE,CAAC;QACxD,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAAC,QAAgB;QACjC,OAAO,IAAI,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IACrD,CAAC;CACF"}

package/dist/validation/Validation.d.ts

@@ -1,18 +1,83 @@
 import { type ZodError, type ZodObject, type ZodRawShape } from "zod";
 import type { DocumentData, ValidationResult, WithKey, WithoutKey } from "@mxpicture/gcp-functions-common/types";
+/**
+ * Zod-based validation for document data transfer objects.
+ *
+ * @remarks
+ * Uses a Zod shape to build create and update schemas. Admin-managed keys
+ * (e.g. `id`, `createTime`, `updateTime`) are automatically stripped from the
+ * create schema. The update schema is a partial version of the create schema.
+ *
+ * @typeParam DTO - The document data transfer object type.
+ */
 export declare class Validation<DTO extends DocumentData> {
     readonly name: string;
     protected _createSchema?: ZodObject;
     protected _updateSchema?: ZodObject;
     protected _shape?: ZodRawShape;
+    /**
+     * Create a new Validation instance.
+     *
+     * @param name - A descriptive name for this validator, used in error messages.
+     */
     constructor(name: string);
+    /**
+     * Inject the Zod shape used to build validation schemas.
+     *
+     * @param shape - The Zod raw shape describing the document fields.
+     */
     useShape(shape: ZodRawShape): void;
+    /**
+     * Retrieve the injected Zod shape.
+     *
+     * @returns The Zod raw shape.
+     * @throws {@link Error} if no shape has been provided via {@link useShape}.
+     */
     protected shape(): ZodRawShape;
+    /**
+     * Derive the Zod shape for create operations by removing admin-managed keys.
+     *
+     * @returns A copy of the base shape with admin keys removed.
+     */
     protected shape4Create(): ZodRawShape;
+    /**
+     * Get or lazily build the Zod schema used for create validation.
+     *
+     * @returns The Zod object schema for create operations.
+     */
     protected createSchema(): ZodObject;
+    /**
+     * Get or lazily build the Zod schema used for update validation.
+     *
+     * @remarks
+     * The update schema is the partial version of the create schema,
+     * making all fields optional.
+     *
+     * @returns The Zod object schema for update operations.
+     */
     protected updateSchema(): ZodObject;
+    /**
+     * Validate a complete document for creation.
+     *
+     * @param doc - The document data to validate.
+     * @returns The parsed and validated document data.
+     * @throws {@link HttpsError} with `invalid-argument` if validation fails.
+     */
     validate(doc: Partial<WithoutKey<DTO>>): WithKey<DTO>;
+    /**
+     * Validate a partial document for update operations.
+     *
+     * @param doc - The partial document data to validate.
+     * @returns The parsed and validated partial document data.
+     * @throws {@link HttpsError} with `invalid-argument` if validation fails.
+     */
     validatePartial(doc: Partial<WithKey<DTO>>): Partial<WithKey<DTO>>;
+    /**
+     * Convert Zod validation issues into a structured validation result.
+     *
+     * @param issues - The array of Zod issues to transform.
+     * @returns A {@link ValidationResult} mapping field paths to their error messages.
+     */
     protected issuesToResult(issues: ZodError["issues"]): ValidationResult;
 }
 //# sourceMappingURL=Validation.d.ts.map

package/dist/validation/Validation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Validation.d.ts","sourceRoot":"","sources":["../../src/validation/Validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAK,KAAK,QAAQ,EAAE,KAAK,SAAS,EAAE,KAAK,WAAW,EAAE,MAAM,KAAK,CAAC;AAEzE,OAAO,KAAK,EACV,YAAY,EACZ,gBAAgB,EAChB,OAAO,EACP,UAAU,EACX,MAAM,uCAAuC,CAAC;AAG/C,qBAAa,UAAU,CAAC,GAAG,SAAS,YAAY;aAKX,IAAI,EAAE,MAAM;IAJ/C,SAAS,CAAC,aAAa,CAAC,EAAE,SAAS,CAAC;IACpC,SAAS,CAAC,aAAa,CAAC,EAAE,SAAS,CAAC;IACpC,SAAS,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;gBAEI,IAAI,EAAE,MAAM;IAExC,QAAQ,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;IAIzC,SAAS,CAAC,KAAK,IAAI,WAAW;IAQ9B,SAAS,CAAC,YAAY,IAAI,WAAW;IAOrC,SAAS,CAAC,YAAY,IAAI,SAAS;IAKnC,SAAS,CAAC,YAAY,IAAI,SAAS;IAK5B,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC;IAWrD,eAAe,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAWzE,SAAS,CAAC,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,GAAG,gBAAgB;CAUvE"}
+{"version":3,"file":"Validation.d.ts","sourceRoot":"","sources":["../../src/validation/Validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAK,KAAK,QAAQ,EAAE,KAAK,SAAS,EAAE,KAAK,WAAW,EAAE,MAAM,KAAK,CAAC;AAEzE,OAAO,KAAK,EACV,YAAY,EACZ,gBAAgB,EAChB,OAAO,EACP,UAAU,EACX,MAAM,uCAAuC,CAAC;AAG/C;;;;;;;;;GASG;AACH,qBAAa,UAAU,CAAC,GAAG,SAAS,YAAY;aAUX,IAAI,EAAE,MAAM;IAT/C,SAAS,CAAC,aAAa,CAAC,EAAE,SAAS,CAAC;IACpC,SAAS,CAAC,aAAa,CAAC,EAAE,SAAS,CAAC;IACpC,SAAS,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;IAE/B;;;;OAIG;gBACgC,IAAI,EAAE,MAAM;IAE/C;;;;OAIG;IACI,QAAQ,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;IAIzC;;;;;OAKG;IACH,SAAS,CAAC,KAAK,IAAI,WAAW;IAQ9B;;;;OAIG;IACH,SAAS,CAAC,YAAY,IAAI,WAAW;IAOrC;;;;OAIG;IACH,SAAS,CAAC,YAAY,IAAI,SAAS;IAKnC;;;;;;;;OAQG;IACH,SAAS,CAAC,YAAY,IAAI,SAAS;IAKnC;;;;;;OAMG;IACI,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC;IAW5D;;;;;;OAMG;IACI,eAAe,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAWzE;;;;;OAKG;IACH,SAAS,CAAC,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,GAAG,gBAAgB;CAUvE"}

package/dist/validation/Validation.js

@@ -1,22 +1,53 @@
 import { z } from "zod";
 import { HttpsError } from "firebase-functions/https";
 import { DOCUMENT_KEY_ADMIN_KEYS } from "@mxpicture/gcp-functions-common/helper";
+/**
+ * Zod-based validation for document data transfer objects.
+ *
+ * @remarks
+ * Uses a Zod shape to build create and update schemas. Admin-managed keys
+ * (e.g. `id`, `createTime`, `updateTime`) are automatically stripped from the
+ * create schema. The update schema is a partial version of the create schema.
+ *
+ * @typeParam DTO - The document data transfer object type.
+ */
 export class Validation {
     name;
     _createSchema;
     _updateSchema;
     _shape;
+    /**
+     * Create a new Validation instance.
+     *
+     * @param name - A descriptive name for this validator, used in error messages.
+     */
     constructor(name) {
         this.name = name;
     }
+    /**
+     * Inject the Zod shape used to build validation schemas.
+     *
+     * @param shape - The Zod raw shape describing the document fields.
+     */
     useShape(shape) {
         this._shape = shape;
     }
+    /**
+     * Retrieve the injected Zod shape.
+     *
+     * @returns The Zod raw shape.
+     * @throws {@link Error} if no shape has been provided via {@link useShape}.
+     */
     shape() {
         if (!this._shape)
             throw new Error(`${this.name}: shape not provided. Use "useShape" method`);
         return this._shape;
     }
+    /**
+     * Derive the Zod shape for create operations by removing admin-managed keys.
+     *
+     * @returns A copy of the base shape with admin keys removed.
+     */
     shape4Create() {
         const shape = { ...this.shape() };
         for (const key of Object.keys(shape))
@@ -24,28 +55,62 @@ export class Validation {
                 delete shape[key];
         return shape;
     }
+    /**
+     * Get or lazily build the Zod schema used for create validation.
+     *
+     * @returns The Zod object schema for create operations.
+     */
     createSchema() {
         if (!this._createSchema)
             this._createSchema = z.object(this.shape4Create());
         return this._createSchema;
     }
+    /**
+     * Get or lazily build the Zod schema used for update validation.
+     *
+     * @remarks
+     * The update schema is the partial version of the create schema,
+     * making all fields optional.
+     *
+     * @returns The Zod object schema for update operations.
+     */
     updateSchema() {
         if (!this._updateSchema)
             this._updateSchema = this.createSchema().partial();
         return this._updateSchema;
     }
+    /**
+     * Validate a complete document for creation.
+     *
+     * @param doc - The document data to validate.
+     * @returns The parsed and validated document data.
+     * @throws {@link HttpsError} with `invalid-argument` if validation fails.
+     */
     validate(doc) {
         const result = this.createSchema().safeParse(doc);
         if (!result.success)
             throw new HttpsError("invalid-argument", "Invalid request data", this.issuesToResult(result.error.issues));
         return result.data;
     }
+    /**
+     * Validate a partial document for update operations.
+     *
+     * @param doc - The partial document data to validate.
+     * @returns The parsed and validated partial document data.
+     * @throws {@link HttpsError} with `invalid-argument` if validation fails.
+     */
     validatePartial(doc) {
         const result = this.updateSchema().safeParse(doc);
         if (!result.success)
             throw new HttpsError("invalid-argument", "Invalid request data", this.issuesToResult(result.error.issues));
         return result.data;
     }
+    /**
+     * Convert Zod validation issues into a structured validation result.
+     *
+     * @param issues - The array of Zod issues to transform.
+     * @returns A {@link ValidationResult} mapping field paths to their error messages.
+     */
     issuesToResult(issues) {
         const result = { errorFields: {} };
         for (const issue of issues) {

package/dist/validation/Validation.js.map

@@ -1 +1 @@
-{"version":3,"file":"Validation.js","sourceRoot":"","sources":["../../src/validation/Validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAmD,MAAM,KAAK,CAAC;AACzE,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAOtD,OAAO,EAAE,uBAAuB,EAAE,MAAM,wCAAwC,CAAC;AAEjF,MAAM,OAAO,UAAU;IAKc;IAJzB,aAAa,CAAa;IAC1B,aAAa,CAAa;IAC1B,MAAM,CAAe;IAE/B,YAAmC,IAAY;QAAZ,SAAI,GAAJ,IAAI,CAAQ;IAAG,CAAC;IAE5C,QAAQ,CAAC,KAAkB;QAChC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAES,KAAK;QACb,IAAI,CAAC,IAAI,CAAC,MAAM;YACd,MAAM,IAAI,KAAK,CACb,GAAG,IAAI,CAAC,IAAI,6CAA6C,CAC1D,CAAC;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAES,YAAY;QACpB,MAAM,KAAK,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;QAClC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;YAClC,IAAI,uBAAuB,CAAC,QAAQ,CAAC,GAAG,CAAC;gBAAE,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/D,OAAO,KAAK,CAAC;IACf,CAAC;IAES,YAAY;QACpB,IAAI,CAAC,IAAI,CAAC,aAAa;YAAE,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;QAC5E,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAES,YAAY;QACpB,IAAI,CAAC,IAAI,CAAC,aAAa;YAAE,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC,OAAO,EAAE,CAAC;QAC5E,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAEM,QAAQ,CAAC,GAA6B;QAC3C,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM,CAAC,OAAO;YACjB,MAAM,IAAI,UAAU,CAClB,kBAAkB,EAClB,sBAAsB,EACtB,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CACzC,CAAC;QACJ,OAAO,MAAM,CAAC,IAAoB,CAAC;IACrC,CAAC;IAEM,eAAe,CAAC,GAA0B;QAC/C,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM,CAAC,OAAO;YACjB,MAAM,IAAI,UAAU,CAClB,kBAAkB,EAClB,sBAAsB,EACtB,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CACzC,CAAC;QACJ,OAAO,MAAM,CAAC,IAA6B,CAAC;IAC9C,CAAC;IAES,cAAc,CAAC,MAA0B;QACjD,MAAM,MAAM,GAAqB,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC;QAErD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;YAChE,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACxD,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}
+{"version":3,"file":"Validation.js","sourceRoot":"","sources":["../../src/validation/Validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAmD,MAAM,KAAK,CAAC;AACzE,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAOtD,OAAO,EAAE,uBAAuB,EAAE,MAAM,wCAAwC,CAAC;AAEjF;;;;;;;;;GASG;AACH,MAAM,OAAO,UAAU;IAUc;IATzB,aAAa,CAAa;IAC1B,aAAa,CAAa;IAC1B,MAAM,CAAe;IAE/B;;;;OAIG;IACH,YAAmC,IAAY;QAAZ,SAAI,GAAJ,IAAI,CAAQ;IAAG,CAAC;IAEnD;;;;OAIG;IACI,QAAQ,CAAC,KAAkB;QAChC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACO,KAAK;QACb,IAAI,CAAC,IAAI,CAAC,MAAM;YACd,MAAM,IAAI,KAAK,CACb,GAAG,IAAI,CAAC,IAAI,6CAA6C,CAC1D,CAAC;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACO,YAAY;QACpB,MAAM,KAAK,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;QAClC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;YAClC,IAAI,uBAAuB,CAAC,QAAQ,CAAC,GAAG,CAAC;gBAAE,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/D,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACO,YAAY;QACpB,IAAI,CAAC,IAAI,CAAC,aAAa;YAAE,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;QAC5E,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED;;;;;;;;OAQG;IACO,YAAY;QACpB,IAAI,CAAC,IAAI,CAAC,aAAa;YAAE,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC,OAAO,EAAE,CAAC;QAC5E,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED;;;;;;OAMG;IACI,QAAQ,CAAC,GAA6B;QAC3C,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM,CAAC,OAAO;YACjB,MAAM,IAAI,UAAU,CAClB,kBAAkB,EAClB,sBAAsB,EACtB,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CACzC,CAAC;QACJ,OAAO,MAAM,CAAC,IAAoB,CAAC;IACrC,CAAC;IAED;;;;;;OAMG;IACI,eAAe,CAAC,GAA0B;QAC/C,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM,CAAC,OAAO;YACjB,MAAM,IAAI,UAAU,CAClB,kBAAkB,EAClB,sBAAsB,EACtB,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CACzC,CAAC;QACJ,OAAO,MAAM,CAAC,IAA6B,CAAC;IAC9C,CAAC;IAED;;;;;OAKG;IACO,cAAc,CAAC,MAA0B;QACjD,MAAM,MAAM,GAAqB,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC;QAErD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;YAChE,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACxD,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mxpicture/gcp-functions-backend",
-  "version": "1.1.3",
+  "version": "1.1.5",
   "description": "Utils for google cloud functions, publishing both CommonJS and ESM builds",
   "type": "module",
   "author": "MXPicture",
@@ -25,13 +25,15 @@
   },
   "scripts": {
     "lint": "eslint \"src/**/*.{ts,tsx}\" --ext .ts,.tsx",
-    "build": "tsc -b ."
+    "build": "tsc -b .",
+    "docs": "typedoc",
+    "docs:clean": "rm -rf docs"
   },
   "publishConfig": {
     "access": "public"
   },
   "dependencies": {
-    "@mxpicture/gcp-functions-common": "^1.1.3",
+    "@mxpicture/gcp-functions-common": "^1.1.5",
     "firebase-admin": "^13.7.0",
     "firebase-functions": "^7.0.6",
     "short-uuid": "^6.0.3",