@mxpicture/gcp-functions-frontend 1.1.2 → 1.1.4

package/dist/api/FrontendApi.d.ts

@@ -1,19 +1,72 @@
 import type { DocumentData, WithKey, ApiFromRoutes, CrudRoutes, WithoutKey, DocumentKey, ApiFilter } from "@mxpicture/gcp-functions-common/types";
 import { IFrontendApi } from "./IFrontendApi.js";
 import { IFrontendFunction } from "../function/IFrontendFunction.js";
+/**
+ * Abstract base class providing CRUD operations for a frontend API backed by a cloud function.
+ *
+ * @remarks
+ * Subclasses must supply a concrete {@link IFrontendFunction} via {@link IFrontendApi.useFunc}
+ * before any operation is invoked. Every method delegates to the function's
+ * {@link IFrontendFunction.outgress | outgress} call with the appropriate route.
+ *
+ * @typeParam DTO - The document data transfer object shape.
+ * @typeParam FUNC - The concrete frontend function type used for remote calls.
+ */
 export declare abstract class FrontendApi<DTO extends DocumentData, FUNC extends IFrontendFunction> extends IFrontendApi<FUNC> implements ApiFromRoutes<CrudRoutes<DTO>> {
+    /**
+     * Delete a document by its key.
+     *
+     * @param request - The document key identifying the document to delete.
+     * @returns A promise resolving to an object confirming 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 A promise resolving to the document data including its key.
+     */
     get(request: DocumentKey): Promise<WithKey<DTO>>;
+    /**
+     * Query documents matching an optional filter.
+     *
+     * @param request - Optional filter criteria; pass `null` or omit to retrieve all documents.
+     * @returns A promise resolving to an array of matching documents with their keys.
+     */
     query(request?: ApiFilter | null): Promise<WithKey<DTO>[]>;
+    /**
+     * Count documents matching an optional filter.
+     *
+     * @param request - Optional filter criteria; pass `null` or omit to count all documents.
+     * @returns A promise resolving to an object containing the document count.
+     */
     count(request?: ApiFilter | null): Promise<{
         count: number;
     }>;
+    /**
+     * Check whether a document exists.
+     *
+     * @param request - The document key identifying the document to check.
+     * @returns A promise resolving to an object indicating existence.
+     */
     exists(request: DocumentKey): Promise<{
         exists: boolean;
     }>;
+    /**
+     * Create a new document.
+     *
+     * @param request - The document data without a key; the backend assigns one.
+     * @returns A promise resolving to the created document data including the assigned key.
+     */
     create(request: WithoutKey<DTO>): Promise<WithKey<DTO>>;
+    /**
+     * Update an existing document with a partial set of fields.
+     *
+     * @param request - The document key together with the fields to update.
+     * @returns A promise resolving to the fully updated document data including its key.
+     */
     update(request: WithKey<Partial<DTO>>): Promise<WithKey<DTO>>;
 }
 //# sourceMappingURL=FrontendApi.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"FrontendApi.d.ts","sourceRoot":"","sources":["../../src/api/FrontendApi.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,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAErE,8BAAsB,WAAW,CAC7B,GAAG,SAAS,YAAY,EACxB,IAAI,SAAS,iBAAiB,CAEhC,SAAQ,YAAY,CAAC,IAAI,CACzB,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;IAKhD,KAAK,CAAC,OAAO,CAAC,EAAE,SAAS,GAAG,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;IAK1D,KAAK,CAAC,OAAO,CAAC,EAAE,SAAS,GAAG,IAAI,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAK7D,MAAM,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,OAAO,CAAA;KAAE,CAAC;IAK1D,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":"FrontendApi.d.ts","sourceRoot":"","sources":["../../src/api/FrontendApi.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,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAErE;;;;;;;;;;GAUG;AACH,8BAAsB,WAAW,CAC7B,GAAG,SAAS,YAAY,EACxB,IAAI,SAAS,iBAAiB,CAEhC,SAAQ,YAAY,CAAC,IAAI,CACzB,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;IAK7D;;;;;OAKG;IACU,KAAK,CAAC,OAAO,CAAC,EAAE,SAAS,GAAG,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;IAKvE;;;;;OAKG;IACU,KAAK,CAAC,OAAO,CAAC,EAAE,SAAS,GAAG,IAAI,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAK1E;;;;;OAKG;IACU,MAAM,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,OAAO,CAAA;KAAE,CAAC;IAKvE;;;;;OAKG;IACU,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAKpE;;;;;OAKG;IACU,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;CAI3E"}

package/dist/api/FrontendApi.js

@@ -1,29 +1,82 @@
 import { IFrontendApi } from "./IFrontendApi.js";
+/**
+ * Abstract base class providing CRUD operations for a frontend API backed by a cloud function.
+ *
+ * @remarks
+ * Subclasses must supply a concrete {@link IFrontendFunction} via {@link IFrontendApi.useFunc}
+ * before any operation is invoked. Every method delegates to the function's
+ * {@link IFrontendFunction.outgress | outgress} call with the appropriate route.
+ *
+ * @typeParam DTO - The document data transfer object shape.
+ * @typeParam FUNC - The concrete frontend function type used for remote calls.
+ */
 export class FrontendApi extends IFrontendApi {
+    /**
+     * Delete a document by its key.
+     *
+     * @param request - The document key identifying the document to delete.
+     * @returns A promise resolving to an object confirming deletion.
+     */
     async delete(request) {
         return (await this.func().outgress({ route: "delete", data: request }))
             .data;
     }
+    /**
+     * Retrieve a single document by its key.
+     *
+     * @param request - The document key identifying the document to retrieve.
+     * @returns A promise resolving to the document data including its key.
+     */
     async get(request) {
         return (await this.func().outgress({ route: "get", data: request }))
             .data;
     }
+    /**
+     * Query documents matching an optional filter.
+     *
+     * @param request - Optional filter criteria; pass `null` or omit to retrieve all documents.
+     * @returns A promise resolving to an array of matching documents with their keys.
+     */
     async query(request) {
         return (await this.func().outgress({ route: "query", data: request }))
             .data;
     }
+    /**
+     * Count documents matching an optional filter.
+     *
+     * @param request - Optional filter criteria; pass `null` or omit to count all documents.
+     * @returns A promise resolving to an object containing the document count.
+     */
     async count(request) {
         return (await this.func().outgress({ route: "count", data: request }))
             .data;
     }
+    /**
+     * Check whether a document exists.
+     *
+     * @param request - The document key identifying the document to check.
+     * @returns A promise resolving to an object indicating existence.
+     */
     async exists(request) {
         return (await this.func().outgress({ route: "exists", data: request }))
             .data;
     }
+    /**
+     * Create a new document.
+     *
+     * @param request - The document data without a key; the backend assigns one.
+     * @returns A promise resolving to the created document data including the assigned key.
+     */
     async create(request) {
         return (await this.func().outgress({ route: "create", data: request }))
             .data;
     }
+    /**
+     * Update an existing document with a partial set of fields.
+     *
+     * @param request - The document key together with the fields to update.
+     * @returns A promise resolving to the fully updated document data including its key.
+     */
     async update(request) {
         return (await this.func().outgress({ route: "update", data: request }))
             .data;

package/dist/api/FrontendApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"FrontendApi.js","sourceRoot":"","sources":["../../src/api/FrontendApi.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAGjD,MAAM,OAAgB,WAIpB,SAAQ,YAAkB;IAGnB,KAAK,CAAC,MAAM,CAAC,OAAoB;QACtC,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;aACpE,IAAyB,CAAC;IAC/B,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,OAAoB;QACnC,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;aACjE,IAAoB,CAAC;IAC1B,CAAC;IAEM,KAAK,CAAC,KAAK,CAAC,OAA0B;QAC3C,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;aACnE,IAAsB,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,KAAK,CAAC,OAA0B;QAC3C,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;aACnE,IAAyB,CAAC;IAC/B,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,OAAoB;QACtC,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;aACpE,IAA2B,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,OAAwB;QAC1C,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;aACpE,IAAoB,CAAC;IAC1B,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,OAA8B;QAChD,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;aACpE,IAAoB,CAAC;IAC1B,CAAC;CACF"}
+{"version":3,"file":"FrontendApi.js","sourceRoot":"","sources":["../../src/api/FrontendApi.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAGjD;;;;;;;;;;GAUG;AACH,MAAM,OAAgB,WAIpB,SAAQ,YAAkB;IAG1B;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,OAAoB;QACtC,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;aACpE,IAAyB,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,GAAG,CAAC,OAAoB;QACnC,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;aACjE,IAAoB,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,KAAK,CAAC,OAA0B;QAC3C,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;aACnE,IAAsB,CAAC;IAC5B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,KAAK,CAAC,OAA0B;QAC3C,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;aACnE,IAAyB,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,OAAoB;QACtC,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;aACpE,IAA2B,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,OAAwB;QAC1C,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;aACpE,IAAoB,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,OAA8B;QAChD,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;aACpE,IAAoB,CAAC;IAC1B,CAAC;CACF"}

package/dist/api/IFrontendApi.d.ts

@@ -1,9 +1,34 @@
 import { IFrontendFunction } from "../function/IFrontendFunction.js";
+/**
+ * Abstract base class that binds a frontend API to an {@link IFrontendFunction}.
+ *
+ * @remarks
+ * Consumers must call {@link useFunc} before invoking any operation so the API
+ * knows which cloud function to delegate to.
+ *
+ * @typeParam FUNC - The concrete frontend function type this API delegates to.
+ */
 export declare abstract class IFrontendApi<FUNC extends IFrontendFunction> {
     readonly name: string;
     protected _func?: FUNC;
+    /**
+     * Create a new frontend API instance.
+     *
+     * @param name - A human-readable name used in error messages.
+     */
     constructor(name: string);
+    /**
+     * Bind a frontend function to this API.
+     *
+     * @param func - The function instance to use for outgoing requests.
+     */
     useFunc(func: FUNC): void;
+    /**
+     * Return the bound frontend function.
+     *
+     * @returns The currently bound function instance.
+     * @throws {Error} If {@link useFunc} has not been called yet.
+     */
     protected func(): FUNC;
 }
 //# sourceMappingURL=IFrontendApi.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"IFrontendApi.d.ts","sourceRoot":"","sources":["../../src/api/IFrontendApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAErE,8BAAsB,YAAY,CAAC,IAAI,SAAS,iBAAiB;aAG5B,IAAI,EAAE,MAAM;IAF/C,SAAS,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC;gBAEY,IAAI,EAAE,MAAM;IAExC,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAIhC,SAAS,CAAC,IAAI,IAAI,IAAI;CAKvB"}
+{"version":3,"file":"IFrontendApi.d.ts","sourceRoot":"","sources":["../../src/api/IFrontendApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAErE;;;;;;;;GAQG;AACH,8BAAsB,YAAY,CAAC,IAAI,SAAS,iBAAiB;aAQ5B,IAAI,EAAE,MAAM;IAP/C,SAAS,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC;IAEvB;;;;OAIG;gBACgC,IAAI,EAAE,MAAM;IAE/C;;;;OAIG;IACI,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAIhC;;;;;OAKG;IACH,SAAS,CAAC,IAAI,IAAI,IAAI;CAKvB"}

package/dist/api/IFrontendApi.js

@@ -1,12 +1,37 @@
+/**
+ * Abstract base class that binds a frontend API to an {@link IFrontendFunction}.
+ *
+ * @remarks
+ * Consumers must call {@link useFunc} before invoking any operation so the API
+ * knows which cloud function to delegate to.
+ *
+ * @typeParam FUNC - The concrete frontend function type this API delegates to.
+ */
 export class IFrontendApi {
     name;
     _func;
+    /**
+     * Create a new frontend API instance.
+     *
+     * @param name - A human-readable name used in error messages.
+     */
     constructor(name) {
         this.name = name;
     }
+    /**
+     * Bind a frontend function to this API.
+     *
+     * @param func - The function instance to use for outgoing requests.
+     */
     useFunc(func) {
         this._func = func;
     }
+    /**
+     * Return the bound frontend function.
+     *
+     * @returns The currently bound function instance.
+     * @throws {Error} If {@link useFunc} has not been called yet.
+     */
     func() {
         if (!this._func)
             throw new Error(`${this.name}: func not provided. Use "useFunc" method`);

package/dist/api/IFrontendApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"IFrontendApi.js","sourceRoot":"","sources":["../../src/api/IFrontendApi.ts"],"names":[],"mappings":"AAEA,MAAM,OAAgB,YAAY;IAGG;IAFzB,KAAK,CAAQ;IAEvB,YAAmC,IAAY;QAAZ,SAAI,GAAJ,IAAI,CAAQ;IAAG,CAAC;IAE5C,OAAO,CAAC,IAAU;QACvB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAES,IAAI;QACZ,IAAI,CAAC,IAAI,CAAC,KAAK;YACb,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,IAAI,2CAA2C,CAAC,CAAC;QAC3E,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;CACF"}
+{"version":3,"file":"IFrontendApi.js","sourceRoot":"","sources":["../../src/api/IFrontendApi.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,MAAM,OAAgB,YAAY;IAQG;IAPzB,KAAK,CAAQ;IAEvB;;;;OAIG;IACH,YAAmC,IAAY;QAAZ,SAAI,GAAJ,IAAI,CAAQ;IAAG,CAAC;IAEnD;;;;OAIG;IACI,OAAO,CAAC,IAAU;QACvB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACO,IAAI;QACZ,IAAI,CAAC,IAAI,CAAC,KAAK;YACb,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,IAAI,2CAA2C,CAAC,CAAC;QAC3E,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;CACF"}

package/dist/config/firebase.config.d.ts

@@ -2,12 +2,36 @@ import { GoogleAuthProvider, type Auth } from "firebase/auth";
 import { type FirebaseApp } from "firebase/app";
 import { type Functions } from "firebase/functions";
 import type { FirebaseConfig, FirebaseEmulatorConfig } from "../types/firebase.types.js";
+/**
+ * Initialize Firebase with the given configuration and optional emulator settings.
+ *
+ * @remarks
+ * This function may only be called once. Subsequent calls throw an error.
+ * After storing the configuration it delegates to {@link configFirebase} to
+ * create the Firebase service instances.
+ *
+ * @param config - The Firebase project configuration.
+ * @param emu - Optional emulator connection settings for local development.
+ * @returns The initialized Firebase service instances (app, auth, functions, googleProvider).
+ * @throws {Error} If Firebase has already been initialized.
+ */
 export declare const initializeFirebase: (config: FirebaseConfig, emu?: FirebaseEmulatorConfig) => {
     app: FirebaseApp;
     auth: Auth;
     functions: Functions;
     googleProvider: GoogleAuthProvider;
 };
+/**
+ * Return the shared Firebase service instances, creating them on first call.
+ *
+ * @remarks
+ * {@link initializeFirebase} must be called before this function.
+ * On the first invocation the Firebase app, auth, functions, and Google auth
+ * provider are created and optionally connected to emulators.
+ *
+ * @returns The Firebase service instances (app, auth, functions, googleProvider).
+ * @throws {Error} If {@link initializeFirebase} has not been called yet.
+ */
 export declare const configFirebase: () => {
     app: FirebaseApp;
     auth: Auth;

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

@@ -1 +1 @@
-{"version":3,"file":"firebase.config.d.ts","sourceRoot":"","sources":["../../src/config/firebase.config.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,kBAAkB,EAClB,KAAK,IAAI,EACV,MAAM,eAAe,CAAC;AACvB,OAAO,EAAiB,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AAC/D,OAAO,EAGL,KAAK,SAAS,EACf,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EACV,cAAc,EACd,sBAAsB,EACvB,MAAM,4BAA4B,CAAC;AAYpC,eAAO,MAAM,kBAAkB,GAC7B,QAAQ,cAAc,EACtB,MAAM,sBAAsB;SAXvB,WAAW;UACV,IAAI;eACC,SAAS;oBACJ,kBAAkB;CAcnC,CAAC;AAEF,eAAO,MAAM,cAAc;SAnBpB,WAAW;UACV,IAAI;eACC,SAAS;oBACJ,kBAAkB;CAgDnC,CAAC"}
+{"version":3,"file":"firebase.config.d.ts","sourceRoot":"","sources":["../../src/config/firebase.config.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,kBAAkB,EAClB,KAAK,IAAI,EACV,MAAM,eAAe,CAAC;AACvB,OAAO,EAAiB,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AAC/D,OAAO,EAGL,KAAK,SAAS,EACf,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EACV,cAAc,EACd,sBAAsB,EACvB,MAAM,4BAA4B,CAAC;AAYpC;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,kBAAkB,GAC7B,QAAQ,cAAc,EACtB,MAAM,sBAAsB;SAxBvB,WAAW;UACV,IAAI;eACC,SAAS;oBACJ,kBAAkB;CA2BnC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,cAAc;SA3CpB,WAAW;UACV,IAAI;eACC,SAAS;oBACJ,kBAAkB;CAwEnC,CAAC"}

package/dist/config/firebase.config.js

@@ -4,6 +4,19 @@ import { connectFunctionsEmulator, getFunctions, } from "firebase/functions";
 let _inst = null;
 let _config = null;
 let _emu = null;
+/**
+ * Initialize Firebase with the given configuration and optional emulator settings.
+ *
+ * @remarks
+ * This function may only be called once. Subsequent calls throw an error.
+ * After storing the configuration it delegates to {@link configFirebase} to
+ * create the Firebase service instances.
+ *
+ * @param config - The Firebase project configuration.
+ * @param emu - Optional emulator connection settings for local development.
+ * @returns The initialized Firebase service instances (app, auth, functions, googleProvider).
+ * @throws {Error} If Firebase has already been initialized.
+ */
 export const initializeFirebase = (config, emu) => {
     if (_config)
         throw new Error("Firebase config already present");
@@ -12,6 +25,17 @@ export const initializeFirebase = (config, emu) => {
         _emu = { ...emu };
     return configFirebase();
 };
+/**
+ * Return the shared Firebase service instances, creating them on first call.
+ *
+ * @remarks
+ * {@link initializeFirebase} must be called before this function.
+ * On the first invocation the Firebase app, auth, functions, and Google auth
+ * provider are created and optionally connected to emulators.
+ *
+ * @returns The Firebase service instances (app, auth, functions, googleProvider).
+ * @throws {Error} If {@link initializeFirebase} has not been called yet.
+ */
 export const configFirebase = () => {
     if (!_inst) {
         if (!_config)

package/dist/config/firebase.config.js.map

@@ -1 +1 @@
-{"version":3,"file":"firebase.config.js","sourceRoot":"","sources":["../../src/config/firebase.config.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,OAAO,EACP,kBAAkB,GAEnB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,aAAa,EAAoB,MAAM,cAAc,CAAC;AAC/D,OAAO,EACL,wBAAwB,EACxB,YAAY,GAEb,MAAM,oBAAoB,CAAC;AAM5B,IAAI,KAAK,GAKE,IAAI,CAAC;AAEhB,IAAI,OAAO,GAA0B,IAAI,CAAC;AAC1C,IAAI,IAAI,GAAkC,IAAI,CAAC;AAE/C,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,MAAsB,EACtB,GAA4B,EAC5B,EAAE;IACF,IAAI,OAAO;QAAE,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;IAChE,OAAO,GAAG,EAAE,GAAG,MAAM,EAAE,CAAC;IACxB,IAAI,GAAG;QAAE,IAAI,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC;IAC3B,OAAO,cAAc,EAAE,CAAC;AAC1B,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAG,GAAG,EAAE;IACjC,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,IAAI,CAAC,OAAO;YACV,MAAM,IAAI,KAAK,CACb,+DAA+D,CAChE,CAAC;QAEJ,sBAAsB;QACtB,MAAM,GAAG,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;QAEnC,+BAA+B;QAC/B,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;QAC1B,IAAI,IAAI,EAAE,QAAQ;YAChB,mBAAmB,CACjB,IAAI,EACJ,UAAU,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,EAAE,EAClD,EAAE,eAAe,EAAE,IAAI,EAAE,CAC1B,CAAC;QAEJ,MAAM,SAAS,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,IAAI,EAAE,aAAa;YACrB,wBAAwB,CACtB,SAAS,EACT,IAAI,CAAC,aAAa,EAClB,IAAI,CAAC,aAAa,IAAI,IAAI,CAC3B,CAAC;QAEJ,MAAM,cAAc,GAAG,IAAI,kBAAkB,EAAE,CAAC;QAChD,KAAK,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,cAAc,EAAE,CAAC;IACnD,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC"}
+{"version":3,"file":"firebase.config.js","sourceRoot":"","sources":["../../src/config/firebase.config.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,OAAO,EACP,kBAAkB,GAEnB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,aAAa,EAAoB,MAAM,cAAc,CAAC;AAC/D,OAAO,EACL,wBAAwB,EACxB,YAAY,GAEb,MAAM,oBAAoB,CAAC;AAM5B,IAAI,KAAK,GAKE,IAAI,CAAC;AAEhB,IAAI,OAAO,GAA0B,IAAI,CAAC;AAC1C,IAAI,IAAI,GAAkC,IAAI,CAAC;AAE/C;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,MAAsB,EACtB,GAA4B,EAC5B,EAAE;IACF,IAAI,OAAO;QAAE,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;IAChE,OAAO,GAAG,EAAE,GAAG,MAAM,EAAE,CAAC;IACxB,IAAI,GAAG;QAAE,IAAI,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC;IAC3B,OAAO,cAAc,EAAE,CAAC;AAC1B,CAAC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,GAAG,EAAE;IACjC,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,IAAI,CAAC,OAAO;YACV,MAAM,IAAI,KAAK,CACb,+DAA+D,CAChE,CAAC;QAEJ,sBAAsB;QACtB,MAAM,GAAG,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;QAEnC,+BAA+B;QAC/B,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;QAC1B,IAAI,IAAI,EAAE,QAAQ;YAChB,mBAAmB,CACjB,IAAI,EACJ,UAAU,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,EAAE,EAClD,EAAE,eAAe,EAAE,IAAI,EAAE,CAC1B,CAAC;QAEJ,MAAM,SAAS,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,IAAI,EAAE,aAAa;YACrB,wBAAwB,CACtB,SAAS,EACT,IAAI,CAAC,aAAa,EAClB,IAAI,CAAC,aAAa,IAAI,IAAI,CAC3B,CAAC;QAEJ,MAAM,cAAc,GAAG,IAAI,kBAAkB,EAAE,CAAC;QAChD,KAAK,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,cAAc,EAAE,CAAC;IACnD,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC"}

package/dist/function/IFrontendFunction.d.ts

@@ -1,16 +1,49 @@
 import type { DocumentData, FunctionRequest, FunctionResponse } from "@mxpicture/gcp-functions-common/types";
 import { HttpsCallable } from "firebase/functions";
+/**
+ * Abstract base class for invoking a Firebase HTTPS callable cloud function.
+ *
+ * @remarks
+ * Subclasses represent a single cloud function endpoint. Callers must register
+ * the available routes via {@link useRoutes} before calling {@link outgress}.
+ * Date fields in responses are automatically converted using `toDatesDeep`.
+ */
 export declare abstract class IFrontendFunction {
     readonly name: string;
     protected readonly datePaths: string[];
     protected _routes?: string[];
     protected _func?: HttpsCallable<FunctionRequest<any>, Promise<FunctionResponse<any>>, unknown>;
+    /**
+     * Create a new frontend function instance.
+     *
+     * @param name - The cloud function name as deployed in Firebase.
+     * @param datePaths - Dot-notation paths within the response data that should be converted to `Date` objects.
+     */
     constructor(name: string, datePaths: string[]);
+    /**
+     * Register the routes this function supports.
+     *
+     * @param routes - An array of route names or a record whose values are route names.
+     */
     useRoutes(routes: {
         [key: string]: string;
     } | string[]): void;
     protected routes(): string[];
     protected hasRoute(name: string): boolean;
+    /**
+     * Send a request to the cloud function and return the transformed response.
+     *
+     * @remarks
+     * The method validates that the requested route is registered, invokes the
+     * callable function, and converts date-typed fields in the response using
+     * the configured {@link datePaths}.
+     *
+     * @typeParam REQ - The request payload type.
+     * @typeParam RES - The expected response data type.
+     * @param request - The function request containing a route name and optional data.
+     * @returns A promise resolving to the function response with date fields converted.
+     * @throws {Error} If the requested route has not been registered via {@link useRoutes}.
+     */
     outgress<REQ, RES extends DocumentData>(request: FunctionRequest<REQ>): Promise<FunctionResponse<RES>>;
     protected func(): HttpsCallable<FunctionRequest<any>, Promise<FunctionResponse<any>>, unknown>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"IFrontendFunction.d.ts","sourceRoot":"","sources":["../../src/function/IFrontendFunction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,eAAe,EACf,gBAAgB,EACjB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAiB,MAAM,oBAAoB,CAAC;AAIlE,8BAAsB,iBAAiB;aAYnB,IAAI,EAAE,MAAM;IAC5B,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE;IAZxC,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAE7B,SAAS,CAAC,KAAK,CAAC,EAAE,aAAa,CAE7B,eAAe,CAAC,GAAG,CAAC,EAEpB,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,EAC9B,OAAO,CACR,CAAC;gBAGgB,IAAI,EAAE,MAAM,EACT,SAAS,EAAE,MAAM,EAAE;IAGjC,SAAS,CAAC,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,MAAM,EAAE,GAAG,IAAI;IAIpE,SAAS,CAAC,MAAM,IAAI,MAAM,EAAE;IAQ5B,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI5B,QAAQ,CAAC,GAAG,EAAE,GAAG,SAAS,YAAY,EACjD,OAAO,EAAE,eAAe,CAAC,GAAG,CAAC,GAC5B,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;IAQjC,SAAS,CAAC,IAAI,IAAI,aAAa,CAE7B,eAAe,CAAC,GAAG,CAAC,EAEpB,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,EAC9B,OAAO,CACR;CAKF"}
+{"version":3,"file":"IFrontendFunction.d.ts","sourceRoot":"","sources":["../../src/function/IFrontendFunction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,eAAe,EACf,gBAAgB,EACjB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAiB,MAAM,oBAAoB,CAAC;AAIlE;;;;;;;GAOG;AACH,8BAAsB,iBAAiB;aAkBnB,IAAI,EAAE,MAAM;IAC5B,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE;IAlBxC,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAE7B,SAAS,CAAC,KAAK,CAAC,EAAE,aAAa,CAE7B,eAAe,CAAC,GAAG,CAAC,EAEpB,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,EAC9B,OAAO,CACR,CAAC;IAEF;;;;;OAKG;gBAEe,IAAI,EAAE,MAAM,EACT,SAAS,EAAE,MAAM,EAAE;IAGxC;;;;OAIG;IACI,SAAS,CAAC,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,MAAM,EAAE,GAAG,IAAI;IAIpE,SAAS,CAAC,MAAM,IAAI,MAAM,EAAE;IAQ5B,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAIzC;;;;;;;;;;;;;OAaG;IACU,QAAQ,CAAC,GAAG,EAAE,GAAG,SAAS,YAAY,EACjD,OAAO,EAAE,eAAe,CAAC,GAAG,CAAC,GAC5B,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;IAQjC,SAAS,CAAC,IAAI,IAAI,aAAa,CAE7B,eAAe,CAAC,GAAG,CAAC,EAEpB,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,EAC9B,OAAO,CACR;CAKF"}

package/dist/function/IFrontendFunction.js

@@ -1,15 +1,34 @@
 import { httpsCallable } from "firebase/functions";
 import { configFirebase } from "../config/firebase.config.js";
 import { toDatesDeep } from "@mxpicture/gcp-functions-common/helper";
+/**
+ * Abstract base class for invoking a Firebase HTTPS callable cloud function.
+ *
+ * @remarks
+ * Subclasses represent a single cloud function endpoint. Callers must register
+ * the available routes via {@link useRoutes} before calling {@link outgress}.
+ * Date fields in responses are automatically converted using `toDatesDeep`.
+ */
 export class IFrontendFunction {
     name;
     datePaths;
     _routes;
     _func;
+    /**
+     * Create a new frontend function instance.
+     *
+     * @param name - The cloud function name as deployed in Firebase.
+     * @param datePaths - Dot-notation paths within the response data that should be converted to `Date` objects.
+     */
     constructor(name, datePaths) {
         this.name = name;
         this.datePaths = datePaths;
     }
+    /**
+     * Register the routes this function supports.
+     *
+     * @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);
     }
@@ -21,6 +40,20 @@ export class IFrontendFunction {
     hasRoute(name) {
         return !!this.routes().find((m) => m === name);
     }
+    /**
+     * Send a request to the cloud function and return the transformed response.
+     *
+     * @remarks
+     * The method validates that the requested route is registered, invokes the
+     * callable function, and converts date-typed fields in the response using
+     * the configured {@link datePaths}.
+     *
+     * @typeParam REQ - The request payload type.
+     * @typeParam RES - The expected response data type.
+     * @param request - The function request containing a route name and optional data.
+     * @returns A promise resolving to the function response with date fields converted.
+     * @throws {Error} If the requested route has not been registered via {@link useRoutes}.
+     */
     async outgress(request) {
         if (!this.hasRoute(request.route))
             throw new Error(`Route ${request.route} not available`);

package/dist/function/IFrontendFunction.js.map

@@ -1 +1 @@
-{"version":3,"file":"IFrontendFunction.js","sourceRoot":"","sources":["../../src/function/IFrontendFunction.ts"],"names":[],"mappings":"AAKA,OAAO,EAAiB,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAClE,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,wCAAwC,CAAC;AAErE,MAAM,OAAgB,iBAAiB;IAYnB;IACG;IAZX,OAAO,CAAY;IAEnB,KAAK,CAMb;IAEF,YACkB,IAAY,EACT,SAAmB;QADtB,SAAI,GAAJ,IAAI,CAAQ;QACT,cAAS,GAAT,SAAS,CAAU;IACrC,CAAC;IAEG,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,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;IAES,QAAQ,CAAC,IAAY;QAC7B,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;IACjD,CAAC;IAEM,KAAK,CAAC,QAAQ,CACnB,OAA6B;QAE7B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,SAAS,OAAO,CAAC,KAAK,gBAAgB,CAAC,CAAC;QAE1D,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;QACxD,OAAO,EAAE,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;IAC7D,CAAC;IAES,IAAI;QAOZ,IAAI,CAAC,IAAI,CAAC,KAAK;YACb,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC,cAAc,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACpE,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;CACF"}
+{"version":3,"file":"IFrontendFunction.js","sourceRoot":"","sources":["../../src/function/IFrontendFunction.ts"],"names":[],"mappings":"AAKA,OAAO,EAAiB,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAClE,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,wCAAwC,CAAC;AAErE;;;;;;;GAOG;AACH,MAAM,OAAgB,iBAAiB;IAkBnB;IACG;IAlBX,OAAO,CAAY;IAEnB,KAAK,CAMb;IAEF;;;;;OAKG;IACH,YACkB,IAAY,EACT,SAAmB;QADtB,SAAI,GAAJ,IAAI,CAAQ;QACT,cAAS,GAAT,SAAS,CAAU;IACrC,CAAC;IAEJ;;;;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;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;IAES,QAAQ,CAAC,IAAY;QAC7B,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,KAAK,CAAC,QAAQ,CACnB,OAA6B;QAE7B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,SAAS,OAAO,CAAC,KAAK,gBAAgB,CAAC,CAAC;QAE1D,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;QACxD,OAAO,EAAE,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;IAC7D,CAAC;IAES,IAAI;QAOZ,IAAI,CAAC,IAAI,CAAC,KAAK;YACb,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC,cAAc,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACpE,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;CACF"}

package/dist/helper/auth.helper.d.ts

@@ -1,2 +1,11 @@
+/**
+ * Translate a Firebase Auth error code into a human-readable message.
+ *
+ * @remarks
+ * If no matching code is found the original code string is returned as-is.
+ *
+ * @param code - The Firebase Auth error code (e.g. `"auth/email-already-in-use"`), or `undefined`.
+ * @returns The friendly error text, the original code when unrecognised, or `undefined` when `code` is `undefined`.
+ */
 export declare const authErrorText: (code: string | undefined) => string | undefined;
 //# sourceMappingURL=auth.helper.d.ts.map

package/dist/helper/auth.helper.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"auth.helper.d.ts","sourceRoot":"","sources":["../../src/helper/auth.helper.ts"],"names":[],"mappings":"AAiQA,eAAO,MAAM,aAAa,GAAI,MAAM,MAAM,GAAG,SAAS,KAAG,MAAM,GAAG,SACR,CAAC"}
+{"version":3,"file":"auth.helper.d.ts","sourceRoot":"","sources":["../../src/helper/auth.helper.ts"],"names":[],"mappings":"AAiQA;;;;;;;;GAQG;AACH,eAAO,MAAM,aAAa,GAAI,MAAM,MAAM,GAAG,SAAS,KAAG,MAAM,GAAG,SACR,CAAC"}

package/dist/helper/auth.helper.js

@@ -248,5 +248,14 @@ const errorMessages = [
         text: "Invalid Hosting Link Domain",
     },
 ];
+/**
+ * Translate a Firebase Auth error code into a human-readable message.
+ *
+ * @remarks
+ * If no matching code is found the original code string is returned as-is.
+ *
+ * @param code - The Firebase Auth error code (e.g. `"auth/email-already-in-use"`), or `undefined`.
+ * @returns The friendly error text, the original code when unrecognised, or `undefined` when `code` is `undefined`.
+ */
 export const authErrorText = (code) => errorMessages.find((e) => e.code === code)?.text ?? code;
 //# sourceMappingURL=auth.helper.js.map

package/dist/helper/auth.helper.js.map

@@ -1 +1 @@
-{"version":3,"file":"auth.helper.js","sourceRoot":"","sources":["../../src/helper/auth.helper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,CAAC,EAAE,MAAM,eAAe,CAAC;AAOpD,MAAM,aAAa,GAAe;IAChC;QACE,IAAI,EAAE,CAAC,CAAC,oBAAoB;QAC5B,IAAI,EAAE,4BAA4B;KACnC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,cAAc,EAAE,IAAI,EAAE,gBAAgB,EAAE;IAClD,EAAE,IAAI,EAAE,CAAC,CAAC,kBAAkB,EAAE,IAAI,EAAE,oBAAoB,EAAE;IAC1D,EAAE,IAAI,EAAE,CAAC,CAAC,iBAAiB,EAAE,IAAI,EAAE,mBAAmB,EAAE;IACxD,EAAE,IAAI,EAAE,CAAC,CAAC,oBAAoB,EAAE,IAAI,EAAE,sBAAsB,EAAE;IAC9D,EAAE,IAAI,EAAE,CAAC,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE;IAC9C,EAAE,IAAI,EAAE,CAAC,CAAC,iBAAiB,EAAE,IAAI,EAAE,mBAAmB,EAAE;IACxD,EAAE,IAAI,EAAE,CAAC,CAAC,gBAAgB,EAAE,IAAI,EAAE,kBAAkB,EAAE;IACtD;QACE,IAAI,EAAE,CAAC,CAAC,yBAAyB;QACjC,IAAI,EAAE,2BAA2B;KAClC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,mBAAmB,EAAE,IAAI,EAAE,uBAAuB,EAAE;IAC9D;QACE,IAAI,EAAE,CAAC,CAAC,8BAA8B;QACtC,IAAI,EAAE,uBAAuB;KAC9B;IACD;QACE,IAAI,EAAE,CAAC,CAAC,8BAA8B;QACtC,IAAI,EAAE,uCAAuC;KAC9C;IACD;QACE,IAAI,EAAE,CAAC,CAAC,0BAA0B;QAClC,IAAI,EAAE,4BAA4B;KACnC;IACD;QACE,IAAI,EAAE,CAAC,CAAC,+BAA+B;QACvC,IAAI,EAAE,iCAAiC;KACxC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,YAAY,EAAE,IAAI,EAAE,sBAAsB,EAAE;IACtD;QACE,IAAI,EAAE,CAAC,CAAC,sBAAsB;QAC9B,IAAI,EAAE,wBAAwB;KAC/B;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,gBAAgB,EAAE,IAAI,EAAE,qBAAqB,EAAE;IACzD;QACE,IAAI,EAAE,CAAC,CAAC,qBAAqB;QAC7B,IAAI,EAAE,yBAAyB;KAChC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,cAAc,EAAE,IAAI,EAAE,gBAAgB,EAAE;IAClD,EAAE,IAAI,EAAE,CAAC,CAAC,eAAe,EAAE,IAAI,EAAE,iBAAiB,EAAE;IACpD;QACE,IAAI,EAAE,CAAC,CAAC,sBAAsB;QAC9B,IAAI,EAAE,wBAAwB;KAC/B;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,cAAc,EAAE,IAAI,EAAE,gBAAgB,EAAE;IAClD,EAAE,IAAI,EAAE,CAAC,CAAC,YAAY,EAAE,IAAI,EAAE,oBAAoB,EAAE;IACpD,EAAE,IAAI,EAAE,CAAC,CAAC,kBAAkB,EAAE,IAAI,EAAE,oBAAoB,EAAE;IAC1D,EAAE,IAAI,EAAE,CAAC,CAAC,iBAAiB,EAAE,IAAI,EAAE,mBAAmB,EAAE;IACxD,EAAE,IAAI,EAAE,CAAC,CAAC,YAAY,EAAE,IAAI,EAAE,2BAA2B,EAAE;IAC3D,EAAE,IAAI,EAAE,CAAC,CAAC,oBAAoB,EAAE,IAAI,EAAE,sBAAsB,EAAE;IAC9D;QACE,IAAI,EAAE,CAAC,CAAC,6BAA6B;QACrC,IAAI,EAAE,+BAA+B;KACtC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,oBAAoB,EAAE,IAAI,EAAE,sBAAsB,EAAE;IAC9D;QACE,IAAI,EAAE,CAAC,CAAC,2BAA2B;QACnC,IAAI,EAAE,6BAA6B;KACpC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,aAAa,EAAE,IAAI,EAAE,eAAe,EAAE;IAChD;QACE,IAAI,EAAE,CAAC,CAAC,uBAAuB;QAC/B,IAAI,EAAE,yBAAyB;KAChC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,oBAAoB,EAAE,IAAI,EAAE,oBAAoB,EAAE;IAC5D;QACE,IAAI,EAAE,CAAC,CAAC,yBAAyB;QACjC,IAAI,EAAE,oBAAoB;KAC3B;IACD;QACE,IAAI,EAAE,CAAC,CAAC,uBAAuB;QAC/B,IAAI,EAAE,yBAAyB;KAChC;IACD;QACE,IAAI,EAAE,CAAC,CAAC,mBAAmB;QAC3B,IAAI,EAAE,8BAA8B;KACrC;IACD;QACE,IAAI,EAAE,CAAC,CAAC,uBAAuB;QAC/B,IAAI,EAAE,yBAAyB;KAChC;IACD;QACE,IAAI,EAAE,CAAC,CAAC,sBAAsB;QAC9B,IAAI,EAAE,wBAAwB;KAC/B;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,gBAAgB,EAAE,IAAI,EAAE,qBAAqB,EAAE;IACzD,EAAE,IAAI,EAAE,CAAC,CAAC,cAAc,EAAE,IAAI,EAAE,qBAAqB,EAAE;IACvD,EAAE,IAAI,EAAE,CAAC,CAAC,gBAAgB,EAAE,IAAI,EAAE,gBAAgB,EAAE;IACpD;QACE,IAAI,EAAE,CAAC,CAAC,mBAAmB;QAC3B,IAAI,EAAE,0BAA0B;KACjC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,oBAAoB,EAAE,IAAI,EAAE,sBAAsB,EAAE;IAC9D,EAAE,IAAI,EAAE,CAAC,CAAC,mBAAmB,EAAE,IAAI,EAAE,qBAAqB,EAAE;IAC5D;QACE,IAAI,EAAE,CAAC,CAAC,uBAAuB;QAC/B,IAAI,EAAE,yBAAyB;KAChC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,cAAc,EAAE,IAAI,EAAE,gBAAgB,EAAE;IAClD;QACE,IAAI,EAAE,CAAC,CAAC,oBAAoB;QAC5B,IAAI,EAAE,yBAAyB;KAChC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,iBAAiB,EAAE,IAAI,EAAE,mBAAmB,EAAE;IACxD;QACE,IAAI,EAAE,CAAC,CAAC,kBAAkB;QAC1B,IAAI,EAAE,6BAA6B;KACpC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,YAAY,EAAE,IAAI,EAAE,4BAA4B,EAAE;IAC5D;QACE,IAAI,EAAE,CAAC,CAAC,4BAA4B;QACpC,IAAI,EAAE,0BAA0B;KACjC;IACD;QACE,IAAI,EAAE,CAAC,CAAC,sBAAsB;QAC9B,IAAI,EAAE,wBAAwB;KAC/B;IACD;QACE,IAAI,EAAE,CAAC,CAAC,mBAAmB;QAC3B,IAAI,EAAE,6BAA6B;KACpC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,YAAY,EAAE,IAAI,EAAE,2BAA2B,EAAE;IAC3D,EAAE,IAAI,EAAE,CAAC,CAAC,oBAAoB,EAAE,IAAI,EAAE,sBAAsB,EAAE;IAC9D,EAAE,IAAI,EAAE,CAAC,CAAC,oBAAoB,EAAE,IAAI,EAAE,sBAAsB,EAAE;IAC9D,EAAE,IAAI,EAAE,CAAC,CAAC,qBAAqB,EAAE,IAAI,EAAE,uBAAuB,EAAE;IAChE;QACE,IAAI,EAAE,CAAC,CAAC,wBAAwB;QAChC,IAAI,EAAE,0BAA0B;KACjC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,gBAAgB,EAAE,IAAI,EAAE,2BAA2B,EAAE;IAC/D;QACE,IAAI,EAAE,CAAC,CAAC,mBAAmB;QAC3B,IAAI,EAAE,8BAA8B;KACrC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,oBAAoB,EAAE,IAAI,EAAE,sBAAsB,EAAE;IAC9D,EAAE,IAAI,EAAE,CAAC,CAAC,gBAAgB,EAAE,IAAI,EAAE,kBAAkB,EAAE;IACtD;QACE,IAAI,EAAE,CAAC,CAAC,oBAAoB;QAC5B,IAAI,EAAE,yBAAyB;KAChC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,gBAAgB,EAAE,IAAI,EAAE,aAAa,EAAE;IACjD;QACE,IAAI,EAAE,CAAC,CAAC,iBAAiB;QACzB,IAAI,EAAE,0CAA0C;KACjD;IACD;QACE,IAAI,EAAE,CAAC,CAAC,sBAAsB;QAC9B,IAAI,EAAE,wBAAwB;KAC/B;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE;IACxC,EAAE,IAAI,EAAE,CAAC,CAAC,aAAa,EAAE,IAAI,EAAE,eAAe,EAAE;IAChD,EAAE,IAAI,EAAE,CAAC,CAAC,gBAAgB,EAAE,IAAI,EAAE,kBAAkB,EAAE;IACtD,EAAE,IAAI,EAAE,CAAC,CAAC,qBAAqB,EAAE,IAAI,EAAE,uBAAuB,EAAE;IAChE;QACE,IAAI,EAAE,CAAC,CAAC,uBAAuB;QAC/B,IAAI,EAAE,6CAA6C;KACpD;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,aAAa,EAAE,IAAI,EAAE,eAAe,EAAE;IAChD,EAAE,IAAI,EAAE,CAAC,CAAC,oBAAoB,EAAE,IAAI,EAAE,sBAAsB,EAAE;IAC9D;QACE,IAAI,EAAE,CAAC,CAAC,uBAAuB;QAC/B,IAAI,EAAE,yBAAyB;KAChC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,cAAc,EAAE,IAAI,EAAE,gBAAgB,EAAE;IAClD;QACE,IAAI,EAAE,CAAC,CAAC,0BAA0B;QAClC,IAAI,EAAE,4BAA4B;KACnC;IACD;QACE,IAAI,EAAE,CAAC,CAAC,0BAA0B;QAClC,IAAI,EAAE,4BAA4B;KACnC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,mBAAmB,EAAE,IAAI,EAAE,qBAAqB,EAAE;IAC5D;QACE,IAAI,EAAE,CAAC,CAAC,8BAA8B;QACtC,IAAI,EAAE,8BAA8B;KACrC;IACD;QACE,IAAI,EAAE,CAAC,CAAC,4BAA4B;QACpC,IAAI,EAAE,sCAAsC;KAC7C;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,kBAAkB,EAAE,IAAI,EAAE,oBAAoB,EAAE;IAC1D,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE;IACpC,EAAE,IAAI,EAAE,CAAC,CAAC,aAAa,EAAE,IAAI,EAAE,oBAAoB,EAAE;IACrD;QACE,IAAI,EAAE,CAAC,CAAC,2BAA2B;QACnC,IAAI,EAAE,mBAAmB;KAC1B;IACD;QACE,IAAI,EAAE,CAAC,CAAC,mBAAmB;QAC3B,IAAI,EAAE,2BAA2B;KAClC;IACD;QACE,IAAI,EAAE,CAAC,CAAC,wBAAwB;QAChC,IAAI,EAAE,0BAA0B;KACjC;IACD;QACE,IAAI,EAAE,CAAC,CAAC,uBAAuB;QAC/B,IAAI,EAAE,8BAA8B;KACrC;IACD;QACE,IAAI,EAAE,CAAC,CAAC,4BAA4B;QACpC,IAAI,EAAE,8BAA8B;KACrC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,gBAAgB,EAAE,IAAI,EAAE,kBAAkB,EAAE;IACtD,EAAE,IAAI,EAAE,CAAC,CAAC,cAAc,EAAE,IAAI,EAAE,gBAAgB,EAAE;IAClD,EAAE,IAAI,EAAE,CAAC,CAAC,YAAY,EAAE,IAAI,EAAE,gBAAgB,EAAE;IAChD,EAAE,IAAI,EAAE,CAAC,CAAC,aAAa,EAAE,IAAI,EAAE,eAAe,EAAE;IAChD,EAAE,IAAI,EAAE,CAAC,CAAC,aAAa,EAAE,IAAI,EAAE,eAAe,EAAE;IAChD,EAAE,IAAI,EAAE,CAAC,CAAC,eAAe,EAAE,IAAI,EAAE,iBAAiB,EAAE;IACpD,EAAE,IAAI,EAAE,CAAC,CAAC,aAAa,EAAE,IAAI,EAAE,eAAe,EAAE;IAChD;QACE,IAAI,EAAE,CAAC,CAAC,uBAAuB;QAC/B,IAAI,EAAE,yBAAyB;KAChC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,mBAAmB,EAAE,IAAI,EAAE,qBAAqB,EAAE;IAC5D,EAAE,IAAI,EAAE,CAAC,CAAC,qBAAqB,EAAE,IAAI,EAAE,uBAAuB,EAAE;IAChE;QACE,IAAI,EAAE,CAAC,CAAC,uBAAuB;QAC/B,IAAI,EAAE,yBAAyB;KAChC;IACD;QACE,IAAI,EAAE,CAAC,CAAC,uBAAuB;QAC/B,IAAI,EAAE,yBAAyB;KAChC;IACD;QACE,IAAI,EAAE,CAAC,CAAC,wBAAwB;QAChC,IAAI,EAAE,0BAA0B;KACjC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,mBAAmB,EAAE,IAAI,EAAE,qBAAqB,EAAE;IAC5D;QACE,IAAI,EAAE,CAAC,CAAC,yBAAyB;QACjC,IAAI,EAAE,2BAA2B;KAClC;IACD;QACE,IAAI,EAAE,CAAC,CAAC,yBAAyB;QACjC,IAAI,EAAE,2BAA2B;KAClC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,gBAAgB,EAAE,IAAI,EAAE,kBAAkB,EAAE;IACtD;QACE,IAAI,EAAE,CAAC,CAAC,2BAA2B;QACnC,IAAI,EAAE,6BAA6B;KACpC;CACF,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,IAAwB,EAAsB,EAAE,CAC5E,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,IAAI,IAAI,IAAI,CAAC"}
+{"version":3,"file":"auth.helper.js","sourceRoot":"","sources":["../../src/helper/auth.helper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,CAAC,EAAE,MAAM,eAAe,CAAC;AAOpD,MAAM,aAAa,GAAe;IAChC;QACE,IAAI,EAAE,CAAC,CAAC,oBAAoB;QAC5B,IAAI,EAAE,4BAA4B;KACnC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,cAAc,EAAE,IAAI,EAAE,gBAAgB,EAAE;IAClD,EAAE,IAAI,EAAE,CAAC,CAAC,kBAAkB,EAAE,IAAI,EAAE,oBAAoB,EAAE;IAC1D,EAAE,IAAI,EAAE,CAAC,CAAC,iBAAiB,EAAE,IAAI,EAAE,mBAAmB,EAAE;IACxD,EAAE,IAAI,EAAE,CAAC,CAAC,oBAAoB,EAAE,IAAI,EAAE,sBAAsB,EAAE;IAC9D,EAAE,IAAI,EAAE,CAAC,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE;IAC9C,EAAE,IAAI,EAAE,CAAC,CAAC,iBAAiB,EAAE,IAAI,EAAE,mBAAmB,EAAE;IACxD,EAAE,IAAI,EAAE,CAAC,CAAC,gBAAgB,EAAE,IAAI,EAAE,kBAAkB,EAAE;IACtD;QACE,IAAI,EAAE,CAAC,CAAC,yBAAyB;QACjC,IAAI,EAAE,2BAA2B;KAClC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,mBAAmB,EAAE,IAAI,EAAE,uBAAuB,EAAE;IAC9D;QACE,IAAI,EAAE,CAAC,CAAC,8BAA8B;QACtC,IAAI,EAAE,uBAAuB;KAC9B;IACD;QACE,IAAI,EAAE,CAAC,CAAC,8BAA8B;QACtC,IAAI,EAAE,uCAAuC;KAC9C;IACD;QACE,IAAI,EAAE,CAAC,CAAC,0BAA0B;QAClC,IAAI,EAAE,4BAA4B;KACnC;IACD;QACE,IAAI,EAAE,CAAC,CAAC,+BAA+B;QACvC,IAAI,EAAE,iCAAiC;KACxC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,YAAY,EAAE,IAAI,EAAE,sBAAsB,EAAE;IACtD;QACE,IAAI,EAAE,CAAC,CAAC,sBAAsB;QAC9B,IAAI,EAAE,wBAAwB;KAC/B;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,gBAAgB,EAAE,IAAI,EAAE,qBAAqB,EAAE;IACzD;QACE,IAAI,EAAE,CAAC,CAAC,qBAAqB;QAC7B,IAAI,EAAE,yBAAyB;KAChC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,cAAc,EAAE,IAAI,EAAE,gBAAgB,EAAE;IAClD,EAAE,IAAI,EAAE,CAAC,CAAC,eAAe,EAAE,IAAI,EAAE,iBAAiB,EAAE;IACpD;QACE,IAAI,EAAE,CAAC,CAAC,sBAAsB;QAC9B,IAAI,EAAE,wBAAwB;KAC/B;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,cAAc,EAAE,IAAI,EAAE,gBAAgB,EAAE;IAClD,EAAE,IAAI,EAAE,CAAC,CAAC,YAAY,EAAE,IAAI,EAAE,oBAAoB,EAAE;IACpD,EAAE,IAAI,EAAE,CAAC,CAAC,kBAAkB,EAAE,IAAI,EAAE,oBAAoB,EAAE;IAC1D,EAAE,IAAI,EAAE,CAAC,CAAC,iBAAiB,EAAE,IAAI,EAAE,mBAAmB,EAAE;IACxD,EAAE,IAAI,EAAE,CAAC,CAAC,YAAY,EAAE,IAAI,EAAE,2BAA2B,EAAE;IAC3D,EAAE,IAAI,EAAE,CAAC,CAAC,oBAAoB,EAAE,IAAI,EAAE,sBAAsB,EAAE;IAC9D;QACE,IAAI,EAAE,CAAC,CAAC,6BAA6B;QACrC,IAAI,EAAE,+BAA+B;KACtC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,oBAAoB,EAAE,IAAI,EAAE,sBAAsB,EAAE;IAC9D;QACE,IAAI,EAAE,CAAC,CAAC,2BAA2B;QACnC,IAAI,EAAE,6BAA6B;KACpC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,aAAa,EAAE,IAAI,EAAE,eAAe,EAAE;IAChD;QACE,IAAI,EAAE,CAAC,CAAC,uBAAuB;QAC/B,IAAI,EAAE,yBAAyB;KAChC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,oBAAoB,EAAE,IAAI,EAAE,oBAAoB,EAAE;IAC5D;QACE,IAAI,EAAE,CAAC,CAAC,yBAAyB;QACjC,IAAI,EAAE,oBAAoB;KAC3B;IACD;QACE,IAAI,EAAE,CAAC,CAAC,uBAAuB;QAC/B,IAAI,EAAE,yBAAyB;KAChC;IACD;QACE,IAAI,EAAE,CAAC,CAAC,mBAAmB;QAC3B,IAAI,EAAE,8BAA8B;KACrC;IACD;QACE,IAAI,EAAE,CAAC,CAAC,uBAAuB;QAC/B,IAAI,EAAE,yBAAyB;KAChC;IACD;QACE,IAAI,EAAE,CAAC,CAAC,sBAAsB;QAC9B,IAAI,EAAE,wBAAwB;KAC/B;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,gBAAgB,EAAE,IAAI,EAAE,qBAAqB,EAAE;IACzD,EAAE,IAAI,EAAE,CAAC,CAAC,cAAc,EAAE,IAAI,EAAE,qBAAqB,EAAE;IACvD,EAAE,IAAI,EAAE,CAAC,CAAC,gBAAgB,EAAE,IAAI,EAAE,gBAAgB,EAAE;IACpD;QACE,IAAI,EAAE,CAAC,CAAC,mBAAmB;QAC3B,IAAI,EAAE,0BAA0B;KACjC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,oBAAoB,EAAE,IAAI,EAAE,sBAAsB,EAAE;IAC9D,EAAE,IAAI,EAAE,CAAC,CAAC,mBAAmB,EAAE,IAAI,EAAE,qBAAqB,EAAE;IAC5D;QACE,IAAI,EAAE,CAAC,CAAC,uBAAuB;QAC/B,IAAI,EAAE,yBAAyB;KAChC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,cAAc,EAAE,IAAI,EAAE,gBAAgB,EAAE;IAClD;QACE,IAAI,EAAE,CAAC,CAAC,oBAAoB;QAC5B,IAAI,EAAE,yBAAyB;KAChC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,iBAAiB,EAAE,IAAI,EAAE,mBAAmB,EAAE;IACxD;QACE,IAAI,EAAE,CAAC,CAAC,kBAAkB;QAC1B,IAAI,EAAE,6BAA6B;KACpC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,YAAY,EAAE,IAAI,EAAE,4BAA4B,EAAE;IAC5D;QACE,IAAI,EAAE,CAAC,CAAC,4BAA4B;QACpC,IAAI,EAAE,0BAA0B;KACjC;IACD;QACE,IAAI,EAAE,CAAC,CAAC,sBAAsB;QAC9B,IAAI,EAAE,wBAAwB;KAC/B;IACD;QACE,IAAI,EAAE,CAAC,CAAC,mBAAmB;QAC3B,IAAI,EAAE,6BAA6B;KACpC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,YAAY,EAAE,IAAI,EAAE,2BAA2B,EAAE;IAC3D,EAAE,IAAI,EAAE,CAAC,CAAC,oBAAoB,EAAE,IAAI,EAAE,sBAAsB,EAAE;IAC9D,EAAE,IAAI,EAAE,CAAC,CAAC,oBAAoB,EAAE,IAAI,EAAE,sBAAsB,EAAE;IAC9D,EAAE,IAAI,EAAE,CAAC,CAAC,qBAAqB,EAAE,IAAI,EAAE,uBAAuB,EAAE;IAChE;QACE,IAAI,EAAE,CAAC,CAAC,wBAAwB;QAChC,IAAI,EAAE,0BAA0B;KACjC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,gBAAgB,EAAE,IAAI,EAAE,2BAA2B,EAAE;IAC/D;QACE,IAAI,EAAE,CAAC,CAAC,mBAAmB;QAC3B,IAAI,EAAE,8BAA8B;KACrC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,oBAAoB,EAAE,IAAI,EAAE,sBAAsB,EAAE;IAC9D,EAAE,IAAI,EAAE,CAAC,CAAC,gBAAgB,EAAE,IAAI,EAAE,kBAAkB,EAAE;IACtD;QACE,IAAI,EAAE,CAAC,CAAC,oBAAoB;QAC5B,IAAI,EAAE,yBAAyB;KAChC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,gBAAgB,EAAE,IAAI,EAAE,aAAa,EAAE;IACjD;QACE,IAAI,EAAE,CAAC,CAAC,iBAAiB;QACzB,IAAI,EAAE,0CAA0C;KACjD;IACD;QACE,IAAI,EAAE,CAAC,CAAC,sBAAsB;QAC9B,IAAI,EAAE,wBAAwB;KAC/B;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE;IACxC,EAAE,IAAI,EAAE,CAAC,CAAC,aAAa,EAAE,IAAI,EAAE,eAAe,EAAE;IAChD,EAAE,IAAI,EAAE,CAAC,CAAC,gBAAgB,EAAE,IAAI,EAAE,kBAAkB,EAAE;IACtD,EAAE,IAAI,EAAE,CAAC,CAAC,qBAAqB,EAAE,IAAI,EAAE,uBAAuB,EAAE;IAChE;QACE,IAAI,EAAE,CAAC,CAAC,uBAAuB;QAC/B,IAAI,EAAE,6CAA6C;KACpD;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,aAAa,EAAE,IAAI,EAAE,eAAe,EAAE;IAChD,EAAE,IAAI,EAAE,CAAC,CAAC,oBAAoB,EAAE,IAAI,EAAE,sBAAsB,EAAE;IAC9D;QACE,IAAI,EAAE,CAAC,CAAC,uBAAuB;QAC/B,IAAI,EAAE,yBAAyB;KAChC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,cAAc,EAAE,IAAI,EAAE,gBAAgB,EAAE;IAClD;QACE,IAAI,EAAE,CAAC,CAAC,0BAA0B;QAClC,IAAI,EAAE,4BAA4B;KACnC;IACD;QACE,IAAI,EAAE,CAAC,CAAC,0BAA0B;QAClC,IAAI,EAAE,4BAA4B;KACnC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,mBAAmB,EAAE,IAAI,EAAE,qBAAqB,EAAE;IAC5D;QACE,IAAI,EAAE,CAAC,CAAC,8BAA8B;QACtC,IAAI,EAAE,8BAA8B;KACrC;IACD;QACE,IAAI,EAAE,CAAC,CAAC,4BAA4B;QACpC,IAAI,EAAE,sCAAsC;KAC7C;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,kBAAkB,EAAE,IAAI,EAAE,oBAAoB,EAAE;IAC1D,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE;IACpC,EAAE,IAAI,EAAE,CAAC,CAAC,aAAa,EAAE,IAAI,EAAE,oBAAoB,EAAE;IACrD;QACE,IAAI,EAAE,CAAC,CAAC,2BAA2B;QACnC,IAAI,EAAE,mBAAmB;KAC1B;IACD;QACE,IAAI,EAAE,CAAC,CAAC,mBAAmB;QAC3B,IAAI,EAAE,2BAA2B;KAClC;IACD;QACE,IAAI,EAAE,CAAC,CAAC,wBAAwB;QAChC,IAAI,EAAE,0BAA0B;KACjC;IACD;QACE,IAAI,EAAE,CAAC,CAAC,uBAAuB;QAC/B,IAAI,EAAE,8BAA8B;KACrC;IACD;QACE,IAAI,EAAE,CAAC,CAAC,4BAA4B;QACpC,IAAI,EAAE,8BAA8B;KACrC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,gBAAgB,EAAE,IAAI,EAAE,kBAAkB,EAAE;IACtD,EAAE,IAAI,EAAE,CAAC,CAAC,cAAc,EAAE,IAAI,EAAE,gBAAgB,EAAE;IAClD,EAAE,IAAI,EAAE,CAAC,CAAC,YAAY,EAAE,IAAI,EAAE,gBAAgB,EAAE;IAChD,EAAE,IAAI,EAAE,CAAC,CAAC,aAAa,EAAE,IAAI,EAAE,eAAe,EAAE;IAChD,EAAE,IAAI,EAAE,CAAC,CAAC,aAAa,EAAE,IAAI,EAAE,eAAe,EAAE;IAChD,EAAE,IAAI,EAAE,CAAC,CAAC,eAAe,EAAE,IAAI,EAAE,iBAAiB,EAAE;IACpD,EAAE,IAAI,EAAE,CAAC,CAAC,aAAa,EAAE,IAAI,EAAE,eAAe,EAAE;IAChD;QACE,IAAI,EAAE,CAAC,CAAC,uBAAuB;QAC/B,IAAI,EAAE,yBAAyB;KAChC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,mBAAmB,EAAE,IAAI,EAAE,qBAAqB,EAAE;IAC5D,EAAE,IAAI,EAAE,CAAC,CAAC,qBAAqB,EAAE,IAAI,EAAE,uBAAuB,EAAE;IAChE;QACE,IAAI,EAAE,CAAC,CAAC,uBAAuB;QAC/B,IAAI,EAAE,yBAAyB;KAChC;IACD;QACE,IAAI,EAAE,CAAC,CAAC,uBAAuB;QAC/B,IAAI,EAAE,yBAAyB;KAChC;IACD;QACE,IAAI,EAAE,CAAC,CAAC,wBAAwB;QAChC,IAAI,EAAE,0BAA0B;KACjC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,mBAAmB,EAAE,IAAI,EAAE,qBAAqB,EAAE;IAC5D;QACE,IAAI,EAAE,CAAC,CAAC,yBAAyB;QACjC,IAAI,EAAE,2BAA2B;KAClC;IACD;QACE,IAAI,EAAE,CAAC,CAAC,yBAAyB;QACjC,IAAI,EAAE,2BAA2B;KAClC;IACD,EAAE,IAAI,EAAE,CAAC,CAAC,gBAAgB,EAAE,IAAI,EAAE,kBAAkB,EAAE;IACtD;QACE,IAAI,EAAE,CAAC,CAAC,2BAA2B;QACnC,IAAI,EAAE,6BAA6B;KACpC;CACF,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,IAAwB,EAAsB,EAAE,CAC5E,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,IAAI,IAAI,IAAI,CAAC"}

package/dist/helper/validation.helper.d.ts

@@ -1,4 +1,23 @@
 import { ValidationResult, ValidationResultFields } from "@mxpicture/gcp-functions-common/types";
+/**
+ * Attempt to extract a {@link ValidationResult} from an unknown value.
+ *
+ * @remarks
+ * If `data` is a `FunctionsError`, its `details` property is inspected recursively.
+ * The function returns `null` when the value does not conform to the expected shape.
+ *
+ * @param data - The value to inspect, typically an error or raw response payload.
+ * @returns The extracted validation result, or `null` if the value is not a valid result.
+ */
 export declare const guardValidationResult: (data: unknown) => ValidationResult | null;
+/**
+ * Attempt to extract {@link ValidationResultFields} from an unknown value.
+ *
+ * @remarks
+ * Only string array entries are kept for each field name; non-string values are silently skipped.
+ *
+ * @param fields - The value to inspect, expected to be a record of field names to string arrays.
+ * @returns The extracted validation result fields, or `null` if the value is not a valid fields object.
+ */
 export declare const guardValidationResultFields: (fields: unknown) => ValidationResultFields | null;
 //# sourceMappingURL=validation.helper.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"validation.helper.d.ts","sourceRoot":"","sources":["../../src/helper/validation.helper.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,sBAAsB,EACvB,MAAM,uCAAuC,CAAC;AAG/C,eAAO,MAAM,qBAAqB,GAChC,MAAM,OAAO,KACZ,gBAAgB,GAAG,IAerB,CAAC;AAEF,eAAO,MAAM,2BAA2B,GACtC,QAAQ,OAAO,KACd,sBAAsB,GAAG,IAc3B,CAAC"}
+{"version":3,"file":"validation.helper.d.ts","sourceRoot":"","sources":["../../src/helper/validation.helper.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,sBAAsB,EACvB,MAAM,uCAAuC,CAAC;AAG/C;;;;;;;;;GASG;AACH,eAAO,MAAM,qBAAqB,GAChC,MAAM,OAAO,KACZ,gBAAgB,GAAG,IAerB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,2BAA2B,GACtC,QAAQ,OAAO,KACd,sBAAsB,GAAG,IAc3B,CAAC"}

package/dist/helper/validation.helper.js

@@ -1,4 +1,14 @@
 import { FunctionsError } from "firebase/functions";
+/**
+ * Attempt to extract a {@link ValidationResult} from an unknown value.
+ *
+ * @remarks
+ * If `data` is a `FunctionsError`, its `details` property is inspected recursively.
+ * The function returns `null` when the value does not conform to the expected shape.
+ *
+ * @param data - The value to inspect, typically an error or raw response payload.
+ * @returns The extracted validation result, or `null` if the value is not a valid result.
+ */
 export const guardValidationResult = (data) => {
     if (data instanceof FunctionsError)
         return guardValidationResult(data.details);
@@ -14,6 +24,15 @@ export const guardValidationResult = (data) => {
         }
         : null;
 };
+/**
+ * Attempt to extract {@link ValidationResultFields} from an unknown value.
+ *
+ * @remarks
+ * Only string array entries are kept for each field name; non-string values are silently skipped.
+ *
+ * @param fields - The value to inspect, expected to be a record of field names to string arrays.
+ * @returns The extracted validation result fields, or `null` if the value is not a valid fields object.
+ */
 export const guardValidationResultFields = (fields) => {
     if (!fields || typeof fields !== "object" || Array.isArray(fields))
         return null;

package/dist/helper/validation.helper.js.map

@@ -1 +1 @@
-{"version":3,"file":"validation.helper.js","sourceRoot":"","sources":["../../src/helper/validation.helper.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,IAAa,EACY,EAAE;IAC3B,IAAI,IAAI,YAAY,cAAc;QAChC,OAAO,qBAAqB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAE7C,IAAI,CAAC,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IAE9C,MAAM,QAAQ,GAAG,IAAiC,CAAC;IACnD,IAAI,CAAC,QAAQ,CAAC,WAAW;QAAE,OAAO,IAAI,CAAC;IAEvC,MAAM,WAAW,GAAG,2BAA2B,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IACtE,OAAO,WAAW;QAChB,CAAC,CAAC;YACE,WAAW;SACZ;QACH,CAAC,CAAC,IAAI,CAAC;AACX,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,MAAe,EACgB,EAAE;IACjC,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;QAChE,OAAO,IAAI,CAAC;IAEd,MAAM,MAAM,GAA2B,EAAE,CAAC;IAE1C,KAAK,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3D,IAAI,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC;YAAE,SAAS;QAEpD,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC;QACvB,KAAK,MAAM,OAAO,IAAI,QAAQ;YAC5B,IAAI,OAAO,OAAO,KAAK,QAAQ;gBAAE,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACrE,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}
+{"version":3,"file":"validation.helper.js","sourceRoot":"","sources":["../../src/helper/validation.helper.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,IAAa,EACY,EAAE;IAC3B,IAAI,IAAI,YAAY,cAAc;QAChC,OAAO,qBAAqB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAE7C,IAAI,CAAC,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IAE9C,MAAM,QAAQ,GAAG,IAAiC,CAAC;IACnD,IAAI,CAAC,QAAQ,CAAC,WAAW;QAAE,OAAO,IAAI,CAAC;IAEvC,MAAM,WAAW,GAAG,2BAA2B,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IACtE,OAAO,WAAW;QAChB,CAAC,CAAC;YACE,WAAW;SACZ;QACH,CAAC,CAAC,IAAI,CAAC;AACX,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,MAAe,EACgB,EAAE;IACjC,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;QAChE,OAAO,IAAI,CAAC;IAEd,MAAM,MAAM,GAA2B,EAAE,CAAC;IAE1C,KAAK,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3D,IAAI,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC;YAAE,SAAS;QAEpD,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC;QACvB,KAAK,MAAM,OAAO,IAAI,QAAQ;YAC5B,IAAI,OAAO,OAAO,KAAK,QAAQ;gBAAE,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACrE,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}

package/dist/loader/firebase.loader.d.ts

@@ -1,4 +1,28 @@
+/**
+ * Lazily load the `firebase/auth` module.
+ *
+ * @remarks
+ * The import is cached so subsequent calls return the same promise.
+ *
+ * @returns A promise resolving to the `firebase/auth` module.
+ */
 export declare const loadFirebaseAuth: () => Promise<typeof import("firebase/auth")>;
+/**
+ * Lazily load the `firebase/app` module.
+ *
+ * @remarks
+ * The import is cached so subsequent calls return the same promise.
+ *
+ * @returns A promise resolving to the `firebase/app` module.
+ */
 export declare const loadFirebaseApp: () => Promise<typeof import("firebase/app")>;
+/**
+ * Lazily load the `firebase/functions` module.
+ *
+ * @remarks
+ * The import is cached so subsequent calls return the same promise.
+ *
+ * @returns A promise resolving to the `firebase/functions` module.
+ */
 export declare const loadFirebaseFunctions: () => Promise<typeof import("firebase/functions")>;
 //# sourceMappingURL=firebase.loader.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"firebase.loader.d.ts","sourceRoot":"","sources":["../../src/loader/firebase.loader.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,gBAAgB,+CAG5B,CAAC;AAEF,eAAO,MAAM,eAAe,8CAG3B,CAAC;AAEF,eAAO,MAAM,qBAAqB,oDAGjC,CAAC"}
+{"version":3,"file":"firebase.loader.d.ts","sourceRoot":"","sources":["../../src/loader/firebase.loader.ts"],"names":[],"mappings":"AAKA;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,+CAG5B,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,eAAe,8CAG3B,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB,oDAGjC,CAAC"}

package/dist/loader/firebase.loader.js

@@ -1,16 +1,40 @@
 let authPromise = null;
 let appPromise = null;
 let functionsPromise = null;
+/**
+ * Lazily load the `firebase/auth` module.
+ *
+ * @remarks
+ * The import is cached so subsequent calls return the same promise.
+ *
+ * @returns A promise resolving to the `firebase/auth` module.
+ */
 export const loadFirebaseAuth = () => {
     if (!authPromise)
         authPromise = import("firebase/auth");
     return authPromise;
 };
+/**
+ * Lazily load the `firebase/app` module.
+ *
+ * @remarks
+ * The import is cached so subsequent calls return the same promise.
+ *
+ * @returns A promise resolving to the `firebase/app` module.
+ */
 export const loadFirebaseApp = () => {
     if (!appPromise)
         appPromise = import("firebase/app");
     return appPromise;
 };
+/**
+ * Lazily load the `firebase/functions` module.
+ *
+ * @remarks
+ * The import is cached so subsequent calls return the same promise.
+ *
+ * @returns A promise resolving to the `firebase/functions` module.
+ */
 export const loadFirebaseFunctions = () => {
     if (!functionsPromise)
         functionsPromise = import("firebase/functions");

package/dist/loader/firebase.loader.js.map

@@ -1 +1 @@
-{"version":3,"file":"firebase.loader.js","sourceRoot":"","sources":["../../src/loader/firebase.loader.ts"],"names":[],"mappings":"AAAA,IAAI,WAAW,GAAmD,IAAI,CAAC;AACvE,IAAI,UAAU,GAAkD,IAAI,CAAC;AACrE,IAAI,gBAAgB,GAClB,IAAI,CAAC;AAEP,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAG,EAAE;IACnC,IAAI,CAAC,WAAW;QAAE,WAAW,GAAG,MAAM,CAAC,eAAe,CAAC,CAAC;IACxD,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAG,GAAG,EAAE;IAClC,IAAI,CAAC,UAAU;QAAE,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,CAAC;IACrD,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,qBAAqB,GAAG,GAAG,EAAE;IACxC,IAAI,CAAC,gBAAgB;QAAE,gBAAgB,GAAG,MAAM,CAAC,oBAAoB,CAAC,CAAC;IACvE,OAAO,gBAAgB,CAAC;AAC1B,CAAC,CAAC"}
+{"version":3,"file":"firebase.loader.js","sourceRoot":"","sources":["../../src/loader/firebase.loader.ts"],"names":[],"mappings":"AAAA,IAAI,WAAW,GAAmD,IAAI,CAAC;AACvE,IAAI,UAAU,GAAkD,IAAI,CAAC;AACrE,IAAI,gBAAgB,GAClB,IAAI,CAAC;AAEP;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAG,EAAE;IACnC,IAAI,CAAC,WAAW;QAAE,WAAW,GAAG,MAAM,CAAC,eAAe,CAAC,CAAC;IACxD,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,GAAG,EAAE;IAClC,IAAI,CAAC,UAAU;QAAE,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,CAAC;IACrD,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,GAAG,EAAE;IACxC,IAAI,CAAC,gBAAgB;QAAE,gBAAgB,GAAG,MAAM,CAAC,oBAAoB,CAAC,CAAC;IACvE,OAAO,gBAAgB,CAAC;AAC1B,CAAC,CAAC"}

package/dist/services/firebase/auth.service.d.ts

@@ -1,15 +1,65 @@
 import type { AuthUser, LoginCredentials, RegisterCredentials } from "../../types/auth.types.js";
+/**
+ * Service encapsulating Firebase Authentication operations.
+ *
+ * @remarks
+ * All methods translate Firebase-specific errors into plain `Error` instances
+ * with human-readable messages via {@link authErrorText}.
+ */
 declare class AuthService {
+    /**
+     * Sign in a user with email and password credentials.
+     *
+     * @param credentials - The login credentials containing email and password.
+     * @returns A promise resolving to the authenticated user.
+     * @throws {Error} If authentication fails (e.g. wrong password, user not found).
+     */
     login(credentials: LoginCredentials): Promise<AuthUser>;
+    /**
+     * Sign in a user via a Google sign-in popup.
+     *
+     * @returns A promise resolving to the authenticated user.
+     * @throws {Error} If the popup is closed or authentication fails.
+     */
     loginWithGoogle(): Promise<AuthUser>;
+    /**
+     * Register a new user with email and password.
+     *
+     * @param credentials - The registration credentials including email, password, and profile info.
+     * @returns A promise resolving to the newly created authenticated user.
+     * @throws {Error} If registration fails (e.g. email already in use, weak password).
+     */
     register(credentials: RegisterCredentials): Promise<AuthUser>;
+    /**
+     * Sign out the currently authenticated user.
+     *
+     * @throws {Error} If sign-out fails.
+     */
     logout(): Promise<void>;
+    /**
+     * Send a password-reset email to the specified address.
+     *
+     * @param email - The email address of the user requesting a password reset.
+     * @throws {Error} If the reset email cannot be sent.
+     */
     resetPassword(email: string): Promise<void>;
+    /**
+     * Subscribe to authentication state changes.
+     *
+     * @param callback - Invoked with the current {@link AuthUser} or `null` on sign-out.
+     * @returns A promise resolving to an unsubscribe function.
+     */
     onAuthStateChanged(callback: (user: AuthUser | null) => void): Promise<() => void>;
+    /**
+     * Return the currently signed-in user, if any.
+     *
+     * @returns The current {@link AuthUser}, or `null` if no user is signed in.
+     */
     getCurrentUser(): Promise<AuthUser | null>;
     private mapFirebaseUserToAuthUser;
     private handleAuthError;
 }
+/** Shared singleton instance of the {@link AuthService}. */
 export declare const authService: AuthService;
 export {};
 //# sourceMappingURL=auth.service.d.ts.map

package/dist/services/firebase/auth.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"auth.service.d.ts","sourceRoot":"","sources":["../../../src/services/firebase/auth.service.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EACV,QAAQ,EACR,gBAAgB,EAChB,mBAAmB,EACpB,MAAM,2BAA2B,CAAC;AAInC,cAAM,WAAW;IACT,KAAK,CAAC,WAAW,EAAE,gBAAgB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAavD,eAAe,IAAI,OAAO,CAAC,QAAQ,CAAC;IAapC,QAAQ,CAAC,WAAW,EAAE,mBAAmB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAkB7D,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAQvB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ3C,kBAAkB,CACtB,QAAQ,EAAE,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI,KAAK,IAAI,GACxC,OAAO,CAAC,MAAM,IAAI,CAAC;IAMhB,cAAc,IAAI,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAKhD,OAAO,CAAC,yBAAyB;IAcjC,OAAO,CAAC,eAAe;CAMxB;AAED,eAAO,MAAM,WAAW,aAAoB,CAAC"}
+{"version":3,"file":"auth.service.d.ts","sourceRoot":"","sources":["../../../src/services/firebase/auth.service.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EACV,QAAQ,EACR,gBAAgB,EAChB,mBAAmB,EACpB,MAAM,2BAA2B,CAAC;AAInC;;;;;;GAMG;AACH,cAAM,WAAW;IACf;;;;;;OAMG;IACG,KAAK,CAAC,WAAW,EAAE,gBAAgB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAa7D;;;;;OAKG;IACG,eAAe,IAAI,OAAO,CAAC,QAAQ,CAAC;IAa1C;;;;;;OAMG;IACG,QAAQ,CAAC,WAAW,EAAE,mBAAmB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAkBnE;;;;OAIG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAQ7B;;;;;OAKG;IACG,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQjD;;;;;OAKG;IACG,kBAAkB,CACtB,QAAQ,EAAE,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI,KAAK,IAAI,GACxC,OAAO,CAAC,MAAM,IAAI,CAAC;IAMtB;;;;OAIG;IACG,cAAc,IAAI,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAKhD,OAAO,CAAC,yBAAyB;IAcjC,OAAO,CAAC,eAAe;CAMxB;AAED,4DAA4D;AAC5D,eAAO,MAAM,WAAW,aAAoB,CAAC"}

package/dist/services/firebase/auth.service.js

@@ -1,7 +1,21 @@
 import { createUserWithEmailAndPassword, onAuthStateChanged, sendPasswordResetEmail, signInWithEmailAndPassword, signInWithPopup, signOut, } from "firebase/auth";
 import { configFirebase } from "../../config/firebase.config.js";
 import { authErrorText } from "../../helper/auth.helper.js";
+/**
+ * Service encapsulating Firebase Authentication operations.
+ *
+ * @remarks
+ * All methods translate Firebase-specific errors into plain `Error` instances
+ * with human-readable messages via {@link authErrorText}.
+ */
 class AuthService {
+    /**
+     * Sign in a user with email and password credentials.
+     *
+     * @param credentials - The login credentials containing email and password.
+     * @returns A promise resolving to the authenticated user.
+     * @throws {Error} If authentication fails (e.g. wrong password, user not found).
+     */
     async login(credentials) {
         try {
             const { user } = await signInWithEmailAndPassword(configFirebase().auth, credentials.email, credentials.password);
@@ -11,6 +25,12 @@ class AuthService {
             throw this.handleAuthError(error);
         }
     }
+    /**
+     * Sign in a user via a Google sign-in popup.
+     *
+     * @returns A promise resolving to the authenticated user.
+     * @throws {Error} If the popup is closed or authentication fails.
+     */
     async loginWithGoogle() {
         try {
             const config = configFirebase();
@@ -21,6 +41,13 @@ class AuthService {
             throw this.handleAuthError(error);
         }
     }
+    /**
+     * Register a new user with email and password.
+     *
+     * @param credentials - The registration credentials including email, password, and profile info.
+     * @returns A promise resolving to the newly created authenticated user.
+     * @throws {Error} If registration fails (e.g. email already in use, weak password).
+     */
     async register(credentials) {
         try {
             const { user } = await createUserWithEmailAndPassword(configFirebase().auth, credentials.email, credentials.password);
@@ -33,6 +60,11 @@ class AuthService {
             throw this.handleAuthError(error);
         }
     }
+    /**
+     * Sign out the currently authenticated user.
+     *
+     * @throws {Error} If sign-out fails.
+     */
     async logout() {
         try {
             await signOut(configFirebase().auth);
@@ -41,6 +73,12 @@ class AuthService {
             throw this.handleAuthError(error);
         }
     }
+    /**
+     * Send a password-reset email to the specified address.
+     *
+     * @param email - The email address of the user requesting a password reset.
+     * @throws {Error} If the reset email cannot be sent.
+     */
     async resetPassword(email) {
         try {
             await sendPasswordResetEmail(configFirebase().auth, email);
@@ -49,11 +87,22 @@ class AuthService {
             throw this.handleAuthError(error);
         }
     }
+    /**
+     * Subscribe to authentication state changes.
+     *
+     * @param callback - Invoked with the current {@link AuthUser} or `null` on sign-out.
+     * @returns A promise resolving to an unsubscribe function.
+     */
     async onAuthStateChanged(callback) {
         return onAuthStateChanged(configFirebase().auth, (user) => {
             callback(user ? this.mapFirebaseUserToAuthUser(user) : null);
         });
     }
+    /**
+     * Return the currently signed-in user, if any.
+     *
+     * @returns The current {@link AuthUser}, or `null` if no user is signed in.
+     */
     async getCurrentUser() {
         const user = configFirebase().auth.currentUser;
         return user ? this.mapFirebaseUserToAuthUser(user) : null;
@@ -77,5 +126,6 @@ class AuthService {
         return new Error(message);
     }
 }
+/** Shared singleton instance of the {@link AuthService}. */
 export const authService = new AuthService();
 //# sourceMappingURL=auth.service.js.map

package/dist/services/firebase/auth.service.js.map

@@ -1 +1 @@
-{"version":3,"file":"auth.service.js","sourceRoot":"","sources":["../../../src/services/firebase/auth.service.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,8BAA8B,EAC9B,kBAAkB,EAClB,sBAAsB,EACtB,0BAA0B,EAC1B,eAAe,EACf,OAAO,GAER,MAAM,eAAe,CAAC;AAMvB,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAE5D,MAAM,WAAW;IACf,KAAK,CAAC,KAAK,CAAC,WAA6B;QACvC,IAAI,CAAC;YACH,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,0BAA0B,CAC/C,cAAc,EAAE,CAAC,IAAI,EACrB,WAAW,CAAC,KAAK,EACjB,WAAW,CAAC,QAAQ,CACrB,CAAC;YACF,OAAO,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC;QAC9C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,eAAe;QACnB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,cAAc,EAAE,CAAC;YAChC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,eAAe,CACpC,MAAM,CAAC,IAAI,EACX,MAAM,CAAC,cAAc,CACtB,CAAC;YACF,OAAO,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC;QAC9C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,WAAgC;QAC7C,IAAI,CAAC;YACH,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,8BAA8B,CACnD,cAAc,EAAE,CAAC,IAAI,EACrB,WAAW,CAAC,KAAK,EACjB,WAAW,CAAC,QAAQ,CACrB,CAAC;YAEF,0CAA0C;YAC1C,wCAAwC;YACxC,6DAA6D;YAE7D,OAAO,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC;QAC9C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,MAAM;QACV,IAAI,CAAC;YACH,MAAM,OAAO,CAAC,cAAc,EAAE,CAAC,IAAI,CAAC,CAAC;QACvC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,KAAa;QAC/B,IAAI,CAAC;YACH,MAAM,sBAAsB,CAAC,cAAc,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC7D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,kBAAkB,CACtB,QAAyC;QAEzC,OAAO,kBAAkB,CAAC,cAAc,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE;YACxD,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC/D,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,cAAc;QAClB,MAAM,IAAI,GAAG,cAAc,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC;QAC/C,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC5D,CAAC;IAEO,yBAAyB,CAAC,IAAU;QAC1C,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,YAAY;gBACpC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;gBACtC,CAAC,CAAC,SAAS;SACd,CAAC;IACJ,CAAC;IAED,8DAA8D;IACtD,eAAe,CAAC,KAAU;QAChC,qDAAqD;QACrD,MAAM,OAAO,GACX,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,IAAI,mBAAmB,CAAC;QACrE,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;IAC5B,CAAC;CACF;AAED,MAAM,CAAC,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC"}
+{"version":3,"file":"auth.service.js","sourceRoot":"","sources":["../../../src/services/firebase/auth.service.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,8BAA8B,EAC9B,kBAAkB,EAClB,sBAAsB,EACtB,0BAA0B,EAC1B,eAAe,EACf,OAAO,GAER,MAAM,eAAe,CAAC;AAMvB,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAE5D;;;;;;GAMG;AACH,MAAM,WAAW;IACf;;;;;;OAMG;IACH,KAAK,CAAC,KAAK,CAAC,WAA6B;QACvC,IAAI,CAAC;YACH,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,0BAA0B,CAC/C,cAAc,EAAE,CAAC,IAAI,EACrB,WAAW,CAAC,KAAK,EACjB,WAAW,CAAC,QAAQ,CACrB,CAAC;YACF,OAAO,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC;QAC9C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,eAAe;QACnB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,cAAc,EAAE,CAAC;YAChC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,eAAe,CACpC,MAAM,CAAC,IAAI,EACX,MAAM,CAAC,cAAc,CACtB,CAAC;YACF,OAAO,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC;QAC9C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,QAAQ,CAAC,WAAgC;QAC7C,IAAI,CAAC;YACH,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,8BAA8B,CACnD,cAAc,EAAE,CAAC,IAAI,EACrB,WAAW,CAAC,KAAK,EACjB,WAAW,CAAC,QAAQ,CACrB,CAAC;YAEF,0CAA0C;YAC1C,wCAAwC;YACxC,6DAA6D;YAE7D,OAAO,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC;QAC9C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM;QACV,IAAI,CAAC;YACH,MAAM,OAAO,CAAC,cAAc,EAAE,CAAC,IAAI,CAAC,CAAC;QACvC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,KAAa;QAC/B,IAAI,CAAC;YACH,MAAM,sBAAsB,CAAC,cAAc,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC7D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,kBAAkB,CACtB,QAAyC;QAEzC,OAAO,kBAAkB,CAAC,cAAc,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE;YACxD,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC/D,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,cAAc;QAClB,MAAM,IAAI,GAAG,cAAc,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC;QAC/C,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC5D,CAAC;IAEO,yBAAyB,CAAC,IAAU;QAC1C,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,YAAY;gBACpC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;gBACtC,CAAC,CAAC,SAAS;SACd,CAAC;IACJ,CAAC;IAED,8DAA8D;IACtD,eAAe,CAAC,KAAU;QAChC,qDAAqD;QACrD,MAAM,OAAO,GACX,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,IAAI,mBAAmB,CAAC;QACrE,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;IAC5B,CAAC;CACF;AAED,4DAA4D;AAC5D,MAAM,CAAC,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC"}

package/dist/types/auth.types.d.ts

@@ -1,28 +1,63 @@
+/**
+ * Credentials required for email/password login.
+ */
 export interface LoginCredentials {
+    /** The user's email address. */
     email: string;
+    /** The user's password. */
     password: string;
+    /** When `true`, the session is persisted across browser restarts. */
     rememberMe?: boolean;
 }
+/**
+ * Credentials required for new user registration.
+ *
+ * @remarks
+ * Extends {@link LoginCredentials} with additional profile and confirmation fields.
+ */
 export interface RegisterCredentials extends LoginCredentials {
+    /** The user's first name. */
     firstName: string;
+    /** The user's last name. */
     lastName: string;
+    /** Must match {@link LoginCredentials.password} for confirmation. */
     confirmPassword: string;
 }
+/**
+ * Represents an authenticated user's profile information.
+ */
 export interface AuthUser {
+    /** The unique Firebase user identifier. */
     uid: string;
+    /** The user's email address, or `null` if unavailable. */
     email: string | null;
+    /** The user's display name, or `null` if not set. */
     displayName: string | null;
+    /** URL of the user's profile photo, or `null` if not set. */
     photoURL: string | null;
+    /** Whether the user's email address has been verified. */
     emailVerified: boolean;
+    /** The date the user account was created. */
     createdAt?: Date;
 }
+/**
+ * Represents the current authentication state of the application.
+ */
 export interface AuthState {
+    /** The currently signed-in user, or `null` if unauthenticated. */
     user: AuthUser | null;
+    /** Whether a user is currently authenticated. */
     isAuthenticated: boolean;
+    /** Whether an authentication operation is in progress. */
     isLoading: boolean;
+    /** The most recent authentication error message, or `null`. */
     error: string | null;
 }
+/**
+ * Payload for a password-reset request.
+ */
 export interface PasswordReset {
+    /** The email address to send the password-reset link to. */
     email: string;
 }
 //# sourceMappingURL=auth.types.d.ts.map

package/dist/types/auth.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"auth.types.d.ts","sourceRoot":"","sources":["../../src/types/auth.types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,aAAa,EAAE,OAAO,CAAC;IACvB,SAAS,CAAC,EAAE,IAAI,CAAC;CAClB;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,QAAQ,GAAG,IAAI,CAAC;IACtB,eAAe,EAAE,OAAO,CAAC;IACzB,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;CACf"}
+{"version":3,"file":"auth.types.d.ts","sourceRoot":"","sources":["../../src/types/auth.types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,2BAA2B;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,qEAAqE;IACrE,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D,6BAA6B;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,4BAA4B;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,qEAAqE;IACrE,eAAe,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,2CAA2C;IAC3C,GAAG,EAAE,MAAM,CAAC;IACZ,0DAA0D;IAC1D,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,qDAAqD;IACrD,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,6DAA6D;IAC7D,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,0DAA0D;IAC1D,aAAa,EAAE,OAAO,CAAC;IACvB,6CAA6C;IAC7C,SAAS,CAAC,EAAE,IAAI,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,kEAAkE;IAClE,IAAI,EAAE,QAAQ,GAAG,IAAI,CAAC;IACtB,iDAAiD;IACjD,eAAe,EAAE,OAAO,CAAC;IACzB,0DAA0D;IAC1D,SAAS,EAAE,OAAO,CAAC;IACnB,+DAA+D;IAC/D,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,4DAA4D;IAC5D,KAAK,EAAE,MAAM,CAAC;CACf"}

package/dist/types/firebase.types.d.ts

@@ -1,20 +1,42 @@
+/**
+ * Configuration object for initializing a Firebase application.
+ */
 export interface FirebaseConfig {
+    /** The Firebase Web API key. */
     apiKey: string;
+    /** The Auth domain used for OAuth redirects (e.g. `"my-app.firebaseapp.com"`). */
     authDomain: string;
+    /** The Firebase project identifier. */
     projectId: string;
+    /** The Cloud Storage bucket name. */
     storageBucket: string;
+    /** The sender ID for Firebase Cloud Messaging. */
     messagingSenderId: string;
+    /** The Firebase application identifier. */
     appId: string;
 }
+/**
+ * Base shape for a Firestore document including common metadata fields.
+ */
 export interface FirestoreDocument {
+    /** The unique document identifier. */
     id: string;
+    /** Timestamp when the document was created. */
     createdAt: Date;
+    /** Timestamp when the document was last updated. */
     updatedAt: Date;
 }
+/**
+ * Configuration for connecting to Firebase emulators during local development.
+ */
 export interface FirebaseEmulatorConfig {
+    /** Hostname of the Auth emulator (e.g. `"localhost"`). */
     authHost?: string;
+    /** Port of the Auth emulator. Defaults to `9099` when omitted. */
     authPort?: number;
+    /** Hostname of the Functions emulator (e.g. `"localhost"`). */
     functionsHost?: string;
+    /** Port of the Functions emulator. Defaults to `5001` when omitted. */
     functionsPort?: number;
 }
 //# sourceMappingURL=firebase.types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"firebase.types.d.ts","sourceRoot":"","sources":["../../src/types/firebase.types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;CACjB;AAED,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB"}
+{"version":3,"file":"firebase.types.d.ts","sourceRoot":"","sources":["../../src/types/firebase.types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,gCAAgC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,kFAAkF;IAClF,UAAU,EAAE,MAAM,CAAC;IACnB,uCAAuC;IACvC,SAAS,EAAE,MAAM,CAAC;IAClB,qCAAqC;IACrC,aAAa,EAAE,MAAM,CAAC;IACtB,kDAAkD;IAClD,iBAAiB,EAAE,MAAM,CAAC;IAC1B,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,sCAAsC;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,+CAA+C;IAC/C,SAAS,EAAE,IAAI,CAAC;IAChB,oDAAoD;IACpD,SAAS,EAAE,IAAI,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,0DAA0D;IAC1D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kEAAkE;IAClE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,+DAA+D;IAC/D,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,uEAAuE;IACvE,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mxpicture/gcp-functions-frontend",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "description": "Utils for google cloud functions, publishing both CommonJS and ESM builds",
   "type": "module",
   "author": "MXPicture",
@@ -27,13 +27,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.2",
+    "@mxpicture/gcp-functions-common": "^1.1.4",
     "firebase": "^12.9.0"
   },
   "devDependencies": {