@mxpicture/gcp-functions-backend 2.1.34 → 2.1.35

package/dist/factory/IBackendStoreFactory.d.ts

@@ -4,13 +4,49 @@ import type { Validation } from "../validation/Validation.js";
 import type { BackendStoreApi } from "../api/BackendStoreApi.js";
 import { IBackendFactory } from "./IBackendFactory.js";
 import type { IBackendFunction } from "../function/IBackendFunction.js";
-export declare abstract class IBackendStoreFactory<STORE_DOC extends DocumentKeyAdmin, DTO extends STORE_DOC, API extends BackendStoreApi<STORE_DOC, DTO, SIDE_EFFECTS, STORE, VAL>, FUNC extends IBackendFunction<STORE_DOC, DTO, SIDE_EFFECTS, API>, SIDE_EFFECTS extends DocumentData = DocumentData, VAL extends Validation<DTO> = Validation<DTO>, STORE extends Store<STORE_DOC> = Store<STORE_DOC>> extends IBackendFactory<DTO, API, SIDE_EFFECTS, VAL> {
+/**
+ * Factory that extends {@link IBackendFactory} with a {@link Store} and an
+ * {@link IBackendFunction} wrapper, suitable for store-backed CRUD APIs.
+ *
+ * @remarks
+ * Adds two lazily-constructed singletons:
+ *
+ * - {@link store} — the persistence layer used by the API.
+ * - {@link func} — the cloud-function wrapper that exposes the API as an HTTPS endpoint.
+ *
+ * `api()` is overridden so the store is injected into the API on first use.
+ *
+ * @typeParam STORE_DOC - The shape stored in {@link Store}.
+ * @typeParam DTO - The shape returned to callers (extends `STORE_DOC`).
+ * @typeParam INPUT_DTO - The shape accepted on write operations.
+ * @typeParam API - The concrete store-backed API class produced by the factory.
+ * @typeParam FUNC - The function wrapper class produced by the factory.
+ * @typeParam SIDE_EFFECTS - Type of side-effect payloads supported by the API.
+ * @typeParam VAL - The validation implementation used by the API.
+ * @typeParam STORE - The store implementation used for persistence.
+ */
+export declare abstract class IBackendStoreFactory<STORE_DOC extends DocumentKeyAdmin, DTO extends STORE_DOC, INPUT_DTO extends DocumentData, API extends BackendStoreApi<STORE_DOC, DTO, INPUT_DTO, SIDE_EFFECTS, STORE, VAL>, FUNC extends IBackendFunction<STORE_DOC, DTO, INPUT_DTO, SIDE_EFFECTS, API>, SIDE_EFFECTS extends DocumentData = DocumentData, VAL extends Validation<INPUT_DTO> = Validation<INPUT_DTO>, STORE extends Store<STORE_DOC> = Store<STORE_DOC>> extends IBackendFactory<DTO, INPUT_DTO, API, SIDE_EFFECTS, VAL> {
     protected _func: FUNC | null;
     protected _store: STORE | null;
+    /**
+     * Returns the API, ensuring a store has been injected.
+     *
+     * @remarks
+     * If the underlying API doesn't yet have a store, this method injects the
+     * factory-managed {@link store} into it.
+     */
     api(): API;
+    /**
+     * Returns the function wrapper, constructing it on first call and caching afterwards.
+     */
     func(): FUNC;
+    /**
+     * Returns the store, constructing it on first call and caching afterwards.
+     */
     store(): STORE;
+    /** Subclass hook: build a fresh function wrapper. Called at most once per factory. */
     protected abstract _createFunc(): FUNC;
+    /** Subclass hook: build a fresh store instance. Called at most once per factory. */
     protected abstract _createStore(): STORE;
 }
 //# sourceMappingURL=IBackendStoreFactory.d.ts.map

package/dist/factory/IBackendStoreFactory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IBackendStoreFactory.d.ts","sourceRoot":"","sources":["../../src/factory/IBackendStoreFactory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,gBAAgB,EACjB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAExE,8BAAsB,oBAAoB,CACxC,SAAS,SAAS,gBAAgB,EAClC,GAAG,SAAS,SAAS,EACrB,GAAG,SAAS,eAAe,CAAC,SAAS,EAAE,GAAG,EAAE,YAAY,EAAE,KAAK,EAAE,GAAG,CAAC,EACrE,IAAI,SAAS,gBAAgB,CAAC,SAAS,EAAE,GAAG,EAAE,YAAY,EAAE,GAAG,CAAC,EAChE,YAAY,SAAS,YAAY,GAAG,YAAY,EAChD,GAAG,SAAS,UAAU,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC,EAC7C,KAAK,SAAS,KAAK,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC,CACjD,SAAQ,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,YAAY,EAAE,GAAG,CAAC;IACpD,SAAS,CAAC,KAAK,EAAE,IAAI,GAAG,IAAI,CAAQ;IACpC,SAAS,CAAC,MAAM,EAAE,KAAK,GAAG,IAAI,CAAQ;IAEtB,GAAG,IAAI,GAAG;IAUnB,IAAI,IAAI,IAAI;IAIZ,KAAK,IAAI,KAAK;IAIrB,SAAS,CAAC,QAAQ,CAAC,WAAW,IAAI,IAAI;IACtC,SAAS,CAAC,QAAQ,CAAC,YAAY,IAAI,KAAK;CACzC"}
+{"version":3,"file":"IBackendStoreFactory.d.ts","sourceRoot":"","sources":["../../src/factory/IBackendStoreFactory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,gBAAgB,EACjB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,8BAAsB,oBAAoB,CACxC,SAAS,SAAS,gBAAgB,EAClC,GAAG,SAAS,SAAS,EACrB,SAAS,SAAS,YAAY,EAC9B,GAAG,SAAS,eAAe,CACzB,SAAS,EACT,GAAG,EACH,SAAS,EACT,YAAY,EACZ,KAAK,EACL,GAAG,CACJ,EACD,IAAI,SAAS,gBAAgB,CAAC,SAAS,EAAE,GAAG,EAAE,SAAS,EAAE,YAAY,EAAE,GAAG,CAAC,EAC3E,YAAY,SAAS,YAAY,GAAG,YAAY,EAChD,GAAG,SAAS,UAAU,CAAC,SAAS,CAAC,GAAG,UAAU,CAAC,SAAS,CAAC,EACzD,KAAK,SAAS,KAAK,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC,CACjD,SAAQ,eAAe,CAAC,GAAG,EAAE,SAAS,EAAE,GAAG,EAAE,YAAY,EAAE,GAAG,CAAC;IAC/D,SAAS,CAAC,KAAK,EAAE,IAAI,GAAG,IAAI,CAAQ;IACpC,SAAS,CAAC,MAAM,EAAE,KAAK,GAAG,IAAI,CAAQ;IAEtC;;;;;;OAMG;IACa,GAAG,IAAI,GAAG;IAU1B;;OAEG;IACI,IAAI,IAAI,IAAI;IAInB;;OAEG;IACI,KAAK,IAAI,KAAK;IAIrB,sFAAsF;IACtF,SAAS,CAAC,QAAQ,CAAC,WAAW,IAAI,IAAI;IACtC,oFAAoF;IACpF,SAAS,CAAC,QAAQ,CAAC,YAAY,IAAI,KAAK;CACzC"}

package/dist/factory/IBackendStoreFactory.js

@@ -1,7 +1,35 @@
 import { IBackendFactory } from "./IBackendFactory.js";
+/**
+ * Factory that extends {@link IBackendFactory} with a {@link Store} and an
+ * {@link IBackendFunction} wrapper, suitable for store-backed CRUD APIs.
+ *
+ * @remarks
+ * Adds two lazily-constructed singletons:
+ *
+ * - {@link store} — the persistence layer used by the API.
+ * - {@link func} — the cloud-function wrapper that exposes the API as an HTTPS endpoint.
+ *
+ * `api()` is overridden so the store is injected into the API on first use.
+ *
+ * @typeParam STORE_DOC - The shape stored in {@link Store}.
+ * @typeParam DTO - The shape returned to callers (extends `STORE_DOC`).
+ * @typeParam INPUT_DTO - The shape accepted on write operations.
+ * @typeParam API - The concrete store-backed API class produced by the factory.
+ * @typeParam FUNC - The function wrapper class produced by the factory.
+ * @typeParam SIDE_EFFECTS - Type of side-effect payloads supported by the API.
+ * @typeParam VAL - The validation implementation used by the API.
+ * @typeParam STORE - The store implementation used for persistence.
+ */
 export class IBackendStoreFactory extends IBackendFactory {
     _func = null;
     _store = null;
+    /**
+     * Returns the API, ensuring a store has been injected.
+     *
+     * @remarks
+     * If the underlying API doesn't yet have a store, this method injects the
+     * factory-managed {@link store} into it.
+     */
     api() {
         const a = super.api();
         try {
@@ -12,9 +40,15 @@ export class IBackendStoreFactory extends IBackendFactory {
         }
         return a;
     }
+    /**
+     * Returns the function wrapper, constructing it on first call and caching afterwards.
+     */
     func() {
         return (this._func ??= this._createFunc().useApi(this.api()));
     }
+    /**
+     * Returns the store, constructing it on first call and caching afterwards.
+     */
     store() {
         return (this._store ??= this._createStore());
     }

package/dist/factory/IBackendStoreFactory.js.map

@@ -1 +1 @@
-{"version":3,"file":"IBackendStoreFactory.js","sourceRoot":"","sources":["../../src/factory/IBackendStoreFactory.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAGvD,MAAM,OAAgB,oBAQpB,SAAQ,eAA4C;IAC1C,KAAK,GAAgB,IAAI,CAAC;IAC1B,MAAM,GAAiB,IAAI,CAAC;IAEtB,GAAG;QACjB,MAAM,CAAC,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC;YACH,CAAC,CAAC,KAAK,EAAE,CAAC;QACZ,CAAC;QAAC,MAAM,CAAC;YACP,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;QAC3B,CAAC;QACD,OAAO,CAAC,CAAC;IACX,CAAC;IAEM,IAAI;QACT,OAAO,CAAC,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IAChE,CAAC;IAEM,KAAK;QACV,OAAO,CAAC,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;IAC/C,CAAC;CAIF"}
+{"version":3,"file":"IBackendStoreFactory.js","sourceRoot":"","sources":["../../src/factory/IBackendStoreFactory.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAGvD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,OAAgB,oBAgBpB,SAAQ,eAAuD;IACrD,KAAK,GAAgB,IAAI,CAAC;IAC1B,MAAM,GAAiB,IAAI,CAAC;IAEtC;;;;;;OAMG;IACa,GAAG;QACjB,MAAM,CAAC,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC;YACH,CAAC,CAAC,KAAK,EAAE,CAAC;QACZ,CAAC;QAAC,MAAM,CAAC;YACP,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;QAC3B,CAAC;QACD,OAAO,CAAC,CAAC;IACX,CAAC;IAED;;OAEG;IACI,IAAI;QACT,OAAO,CAAC,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACI,KAAK;QACV,OAAO,CAAC,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;IAC/C,CAAC;CAMF"}

package/dist/firebase/FirebaseTaskHandler.d.ts

@@ -19,20 +19,27 @@ export declare class FirebaseTaskHandler {
      * @param env - Environment configuration containing `projectId`, `region`, and `serviceAccount`.
      */
     constructor(env: FirebaseEnv);
+    /**
+     * Returns a cached {@link FirebaseTaskQueueHandler} for the given queue ID,
+     * constructing a new one on first access.
+     *
+     * @param queueId - The Cloud Tasks queue identifier.
+     * @returns A handler scoped to the named queue.
+     */
     queue(queueId: string): FirebaseTaskQueueHandler;
     /**
-     * Delete an existing task (if present) and create a new one with the same ID at a new schedule time.
+     * Reschedules a task by deleting it (if present) and re-creating it.
      *
-     * @param p - Task parameters including the mandatory `taskId` to reschedule.
-     * @param scheduleTime - The new schedule timestamp.
+     * @param p - Task parameters including the queue ID, target URL, schedule time,
+     *   and optional `taskId` to delete before re-creating.
      * @returns The created task's resource name.
      */
     reschedule(p: FirebaseTaskParams): Promise<FirebaseTaskScheduleResult>;
     /**
-     * Create a new Cloud Task scheduled for the given time.
+     * Schedules a new Cloud Task on the queue named by `p.queueId`.
      *
-     * @param p - Task parameters: target URL, optional payload, optional task ID, queue ID
-     * @param scheduleTime - When the task should be dispatched.
+     * @param p - Task parameters: queue ID, target URL, schedule time, and
+     *   optional payload / task ID.
      * @returns The created task's resource name.
      */
     schedule(p: FirebaseTaskParams): Promise<FirebaseTaskScheduleResult>;

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

@@ -1 +1 @@
-{"version":3,"file":"FirebaseTaskHandler.d.ts","sourceRoot":"","sources":["../../src/firebase/FirebaseTaskHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EACV,kBAAkB,EAClB,0BAA0B,EAC3B,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAEzE;;;;;;GAMG;AACH,qBAAa,mBAAmB;IAUX,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,WAAW;IATtD,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,gBAAgB,CAAC;IACjD,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,GAAG,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAC3D;IAEZ;;;;OAIG;gBACmC,GAAG,EAAE,WAAW;IAI/C,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,wBAAwB;IASvD;;;;;;OAMG;IACU,UAAU,CACrB,CAAC,EAAE,kBAAkB,GACpB,OAAO,CAAC,0BAA0B,CAAC;IAItC;;;;;;OAMG;IACU,QAAQ,CACnB,CAAC,EAAE,kBAAkB,GACpB,OAAO,CAAC,0BAA0B,CAAC;CAGvC"}
+{"version":3,"file":"FirebaseTaskHandler.d.ts","sourceRoot":"","sources":["../../src/firebase/FirebaseTaskHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EACV,kBAAkB,EAClB,0BAA0B,EAC3B,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAEzE;;;;;;GAMG;AACH,qBAAa,mBAAmB;IAUX,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,WAAW;IATtD,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,gBAAgB,CAAC;IACjD,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,GAAG,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAC3D;IAEZ;;;;OAIG;gBACmC,GAAG,EAAE,WAAW;IAItD;;;;;;OAMG;IACI,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,wBAAwB;IASvD;;;;;;OAMG;IACU,UAAU,CACrB,CAAC,EAAE,kBAAkB,GACpB,OAAO,CAAC,0BAA0B,CAAC;IAItC;;;;;;OAMG;IACU,QAAQ,CACnB,CAAC,EAAE,kBAAkB,GACpB,OAAO,CAAC,0BAA0B,CAAC;CAGvC"}

package/dist/firebase/FirebaseTaskHandler.js

@@ -20,6 +20,13 @@ export class FirebaseTaskHandler {
         this.env = env;
         this.tasksClient = new CloudTasksClient();
     }
+    /**
+     * Returns a cached {@link FirebaseTaskQueueHandler} for the given queue ID,
+     * constructing a new one on first access.
+     *
+     * @param queueId - The Cloud Tasks queue identifier.
+     * @returns A handler scoped to the named queue.
+     */
     queue(queueId) {
         let found = this.queueHandlers.get(queueId);
         if (!found) {
@@ -29,20 +36,20 @@ export class FirebaseTaskHandler {
         return found;
     }
     /**
-     * Delete an existing task (if present) and create a new one with the same ID at a new schedule time.
+     * Reschedules a task by deleting it (if present) and re-creating it.
      *
-     * @param p - Task parameters including the mandatory `taskId` to reschedule.
-     * @param scheduleTime - The new schedule timestamp.
+     * @param p - Task parameters including the queue ID, target URL, schedule time,
+     *   and optional `taskId` to delete before re-creating.
      * @returns The created task's resource name.
      */
     async reschedule(p) {
         return await this.queue(p.queueId).reschedule(p);
     }
     /**
-     * Create a new Cloud Task scheduled for the given time.
+     * Schedules a new Cloud Task on the queue named by `p.queueId`.
      *
-     * @param p - Task parameters: target URL, optional payload, optional task ID, queue ID
-     * @param scheduleTime - When the task should be dispatched.
+     * @param p - Task parameters: queue ID, target URL, schedule time, and
+     *   optional payload / task ID.
      * @returns The created task's resource name.
      */
     async schedule(p) {

package/dist/firebase/FirebaseTaskHandler.js.map

@@ -1 +1 @@
-{"version":3,"file":"FirebaseTaskHandler.js","sourceRoot":"","sources":["../../src/firebase/FirebaseTaskHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAMvD,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAEzE;;;;;;GAMG;AACH,MAAM,OAAO,mBAAmB;IAUQ;IATnB,WAAW,CAAmB;IAC9B,aAAa,GAC9B,IAAI,GAAG,EAAE,CAAC;IAEZ;;;;OAIG;IACH,YAAsC,GAAgB;QAAhB,QAAG,GAAH,GAAG,CAAa;QACpD,IAAI,CAAC,WAAW,GAAG,IAAI,gBAAgB,EAAE,CAAC;IAC5C,CAAC;IAEM,KAAK,CAAC,OAAe;QAC1B,IAAI,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC5C,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,KAAK,GAAG,IAAI,wBAAwB,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;YAC1E,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACzC,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,UAAU,CACrB,CAAqB;QAErB,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,QAAQ,CACnB,CAAqB;QAErB,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IACjD,CAAC;CACF"}
+{"version":3,"file":"FirebaseTaskHandler.js","sourceRoot":"","sources":["../../src/firebase/FirebaseTaskHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAMvD,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAEzE;;;;;;GAMG;AACH,MAAM,OAAO,mBAAmB;IAUQ;IATnB,WAAW,CAAmB;IAC9B,aAAa,GAC9B,IAAI,GAAG,EAAE,CAAC;IAEZ;;;;OAIG;IACH,YAAsC,GAAgB;QAAhB,QAAG,GAAH,GAAG,CAAa;QACpD,IAAI,CAAC,WAAW,GAAG,IAAI,gBAAgB,EAAE,CAAC;IAC5C,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,OAAe;QAC1B,IAAI,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC5C,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,KAAK,GAAG,IAAI,wBAAwB,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;YAC1E,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACzC,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,UAAU,CACrB,CAAqB;QAErB,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,QAAQ,CACnB,CAAqB;QAErB,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IACjD,CAAC;CACF"}

package/dist/firebase/FirebaseTaskQueueHandler.d.ts

@@ -2,74 +2,77 @@ import type { CloudTasksClient } from "@google-cloud/tasks";
 import type { FirebaseTask, FirebaseTaskQueueParams, FirebaseTaskScheduleResult } from "../types/types.tasks.js";
 import type { FirebaseEnv } from "../types/types.env.js";
 /**
- * Client wrapper around Google Cloud Tasks for scheduling, retrieving, and managing HTTP-targeted tasks.
+ * Per-queue wrapper around Google Cloud Tasks.
  *
  * @remarks
- * All queue and task paths are derived from the {@link FirebaseTaskEnv} provided at construction.
- * Task payloads are sent as base64-encoded JSON via `POST` with OIDC authentication.
+ * Manages tasks within a single queue. Task payloads are sent as base64-encoded
+ * JSON via `POST` with OIDC authentication. Build via {@link FirebaseTaskHandler.queue}
+ * rather than calling the constructor directly.
  */
 export declare class FirebaseTaskQueueHandler {
     readonly queueId: string;
     protected readonly tasksClient: CloudTasksClient;
     protected readonly env: FirebaseEnv;
+    /**
+     * Creates a new queue-scoped task handler.
+     *
+     * @param queueId - The Cloud Tasks queue identifier this handler is bound to.
+     * @param tasksClient - The underlying {@link CloudTasksClient}.
+     * @param env - GCP environment (project, region, service account).
+     */
     constructor(queueId: string, tasksClient: CloudTasksClient, env: FirebaseEnv);
     /**
-     * Delete an existing task (if present) and create a new one with the same ID at a new schedule time.
+     * Reschedules a task by deleting any existing task with the same `taskId`,
+     * then re-creating it via {@link schedule}.
      *
-     * @param p - Task parameters including the mandatory `taskId` to reschedule.
-     * @param scheduleTime - The new schedule timestamp.
+     * @param p - Task parameters; `taskId` selects the existing task to delete.
      * @returns The created task's resource name.
      */
     reschedule(p: FirebaseTaskQueueParams): Promise<FirebaseTaskScheduleResult>;
     /**
-     * Create a new Cloud Task scheduled for the given time.
+     * Creates a new Cloud Task on this queue.
      *
-     * @param p - Task parameters: target URL, optional payload, optional task ID, queue ID
-     * @param scheduleTime - When the task should be dispatched.
+     * @param p - Task parameters: target URL, schedule time, and optional
+     *   payload / task ID. A random task ID is generated when omitted.
      * @returns The created task's resource name.
      */
     schedule(p: FirebaseTaskQueueParams): Promise<FirebaseTaskScheduleResult>;
     /**
-     * List all tasks in a queue.
+     * Lists all tasks currently scheduled on this queue.
      *
      * @returns An array of tasks with parsed `nameParts`.
      */
     getTasks(): Promise<FirebaseTask[]>;
     /**
-     * Retrieve a single task by queue and task ID.
+     * Retrieves a single task on this queue by ID.
      *
      * @param taskId - The task identifier.
      * @returns The task with parsed `nameParts`.
      */
     getTask(taskId: string): Promise<FirebaseTask>;
     /**
-     * Delete a single task by queue and task ID.
+     * Deletes a task on this queue by ID.
      *
-     * @param queueId - The queue identifier.
      * @param taskId - The task identifier.
-     * @returns The task with parsed `nameParts`.
      */
     deleteTask(taskId: string): Promise<void>;
     /**
-     * Check whether a task exists (is currently scheduled) in a queue.
+     * Checks whether a task is currently scheduled on this queue.
      *
-     * @param queueId - The queue identifier.
      * @param taskId - The task identifier.
      * @returns `true` if the task exists, `false` otherwise.
      */
     isScheduled(taskId: string): Promise<boolean>;
     /**
-     * Build the fully-qualified Cloud Tasks task resource path.
+     * Builds the fully-qualified Cloud Tasks task resource path for this queue.
      *
-     * @param queueId - The queue identifier.
      * @param taskId - The task identifier.
      * @returns The resource path string.
      */
     taskPath(taskId: string): string;
     /**
-     * Build the fully-qualified Cloud Tasks queue resource path.
+     * Builds the fully-qualified Cloud Tasks queue resource path for this queue.
      *
-     * @param queueId - The queue identifier.
      * @returns The resource path string.
      */
     queuePath(): string;

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

@@ -1 +1 @@
-{"version":3,"file":"FirebaseTaskQueueHandler.d.ts","sourceRoot":"","sources":["../../src/firebase/FirebaseTaskQueueHandler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,KAAK,EACV,YAAY,EACZ,uBAAuB,EACvB,0BAA0B,EAC3B,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAIzD;;;;;;GAMG;AACH,qBAAa,wBAAwB;aAEjB,OAAO,EAAE,MAAM;IAC/B,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,gBAAgB;IAChD,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,WAAW;gBAFnB,OAAO,EAAE,MAAM,EACZ,WAAW,EAAE,gBAAgB,EAC7B,GAAG,EAAE,WAAW;IAGrC;;;;;;OAMG;IACU,UAAU,CACrB,CAAC,EAAE,uBAAuB,GACzB,OAAO,CAAC,0BAA0B,CAAC;IAgBtC;;;;;;OAMG;IACU,QAAQ,CACnB,CAAC,EAAE,uBAAuB,GACzB,OAAO,CAAC,0BAA0B,CAAC;IAiCtC;;;;OAIG;IACU,QAAQ,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;IAOhD;;;;;OAKG;IACU,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAS3D;;;;;;OAMG;IACU,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAKtD;;;;;;OAMG;IACU,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAS1D;;;;;;OAMG;IACI,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IASvC;;;;;OAKG;IACI,SAAS,IAAI,MAAM;IAQ1B,SAAS,CAAC,mBAAmB,CAAC,IAAI,EAAE,YAAY,GAAG,YAAY;CAOhE"}
+{"version":3,"file":"FirebaseTaskQueueHandler.d.ts","sourceRoot":"","sources":["../../src/firebase/FirebaseTaskQueueHandler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,KAAK,EACV,YAAY,EACZ,uBAAuB,EACvB,0BAA0B,EAC3B,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAIzD;;;;;;;GAOG;AACH,qBAAa,wBAAwB;aASjB,OAAO,EAAE,MAAM;IAC/B,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,gBAAgB;IAChD,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,WAAW;IAVrC;;;;;;OAMG;gBAEe,OAAO,EAAE,MAAM,EACZ,WAAW,EAAE,gBAAgB,EAC7B,GAAG,EAAE,WAAW;IAGrC;;;;;;OAMG;IACU,UAAU,CACrB,CAAC,EAAE,uBAAuB,GACzB,OAAO,CAAC,0BAA0B,CAAC;IAgBtC;;;;;;OAMG;IACU,QAAQ,CACnB,CAAC,EAAE,uBAAuB,GACzB,OAAO,CAAC,0BAA0B,CAAC;IAiCtC;;;;OAIG;IACU,QAAQ,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;IAOhD;;;;;OAKG;IACU,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAS3D;;;;OAIG;IACU,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAKtD;;;;;OAKG;IACU,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAS1D;;;;;OAKG;IACI,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IASvC;;;;OAIG;IACI,SAAS,IAAI,MAAM;IAQ1B,SAAS,CAAC,mBAAmB,CAAC,IAAI,EAAE,YAAY,GAAG,YAAY;CAOhE"}

package/dist/firebase/FirebaseTaskQueueHandler.js

@@ -1,26 +1,34 @@
 import * as uuid from "short-uuid";
 import { fromTaskName } from "./firebase.tasks.js";
 /**
- * Client wrapper around Google Cloud Tasks for scheduling, retrieving, and managing HTTP-targeted tasks.
+ * Per-queue wrapper around Google Cloud Tasks.
  *
  * @remarks
- * All queue and task paths are derived from the {@link FirebaseTaskEnv} provided at construction.
- * Task payloads are sent as base64-encoded JSON via `POST` with OIDC authentication.
+ * Manages tasks within a single queue. Task payloads are sent as base64-encoded
+ * JSON via `POST` with OIDC authentication. Build via {@link FirebaseTaskHandler.queue}
+ * rather than calling the constructor directly.
  */
 export class FirebaseTaskQueueHandler {
     queueId;
     tasksClient;
     env;
+    /**
+     * Creates a new queue-scoped task handler.
+     *
+     * @param queueId - The Cloud Tasks queue identifier this handler is bound to.
+     * @param tasksClient - The underlying {@link CloudTasksClient}.
+     * @param env - GCP environment (project, region, service account).
+     */
     constructor(queueId, tasksClient, env) {
         this.queueId = queueId;
         this.tasksClient = tasksClient;
         this.env = env;
     }
     /**
-     * Delete an existing task (if present) and create a new one with the same ID at a new schedule time.
+     * Reschedules a task by deleting any existing task with the same `taskId`,
+     * then re-creating it via {@link schedule}.
      *
-     * @param p - Task parameters including the mandatory `taskId` to reschedule.
-     * @param scheduleTime - The new schedule timestamp.
+     * @param p - Task parameters; `taskId` selects the existing task to delete.
      * @returns The created task's resource name.
      */
     async reschedule(p) {
@@ -39,10 +47,10 @@ export class FirebaseTaskQueueHandler {
         });
     }
     /**
-     * Create a new Cloud Task scheduled for the given time.
+     * Creates a new Cloud Task on this queue.
      *
-     * @param p - Task parameters: target URL, optional payload, optional task ID, queue ID
-     * @param scheduleTime - When the task should be dispatched.
+     * @param p - Task parameters: target URL, schedule time, and optional
+     *   payload / task ID. A random task ID is generated when omitted.
      * @returns The created task's resource name.
      */
     async schedule(p) {
@@ -75,7 +83,7 @@ export class FirebaseTaskQueueHandler {
         return { name: task.name ?? null };
     }
     /**
-     * List all tasks in a queue.
+     * Lists all tasks currently scheduled on this queue.
      *
      * @returns An array of tasks with parsed `nameParts`.
      */
@@ -84,7 +92,7 @@ export class FirebaseTaskQueueHandler {
         return tasks.map((task) => this.mapTaskFromFirebase(task));
     }
     /**
-     * Retrieve a single task by queue and task ID.
+     * Retrieves a single task on this queue by ID.
      *
      * @param taskId - The task identifier.
      * @returns The task with parsed `nameParts`.
@@ -96,20 +104,17 @@ export class FirebaseTaskQueueHandler {
         return this.mapTaskFromFirebase(task);
     }
     /**
-     * Delete a single task by queue and task ID.
+     * Deletes a task on this queue by ID.
      *
-     * @param queueId - The queue identifier.
      * @param taskId - The task identifier.
-     * @returns The task with parsed `nameParts`.
      */
     async deleteTask(taskId) {
         const name = this.taskPath(taskId);
         await this.tasksClient.deleteTask({ name });
     }
     /**
-     * Check whether a task exists (is currently scheduled) in a queue.
+     * Checks whether a task is currently scheduled on this queue.
      *
-     * @param queueId - The queue identifier.
      * @param taskId - The task identifier.
      * @returns `true` if the task exists, `false` otherwise.
      */
@@ -123,9 +128,8 @@ export class FirebaseTaskQueueHandler {
         }
     }
     /**
-     * Build the fully-qualified Cloud Tasks task resource path.
+     * Builds the fully-qualified Cloud Tasks task resource path for this queue.
      *
-     * @param queueId - The queue identifier.
      * @param taskId - The task identifier.
      * @returns The resource path string.
      */
@@ -133,9 +137,8 @@ export class FirebaseTaskQueueHandler {
         return this.tasksClient.taskPath(this.env.projectId, this.env.region, this.queueId, taskId);
     }
     /**
-     * Build the fully-qualified Cloud Tasks queue resource path.
+     * Builds the fully-qualified Cloud Tasks queue resource path for this queue.
      *
-     * @param queueId - The queue identifier.
      * @returns The resource path string.
      */
     queuePath() {

package/dist/firebase/FirebaseTaskQueueHandler.js.map

@@ -1 +1 @@
-{"version":3,"file":"FirebaseTaskQueueHandler.js","sourceRoot":"","sources":["../../src/firebase/FirebaseTaskQueueHandler.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD;;;;;;GAMG;AACH,MAAM,OAAO,wBAAwB;IAEjB;IACG;IACA;IAHrB,YACkB,OAAe,EACZ,WAA6B,EAC7B,GAAgB;QAFnB,YAAO,GAAP,OAAO,CAAQ;QACZ,gBAAW,GAAX,WAAW,CAAkB;QAC7B,QAAG,GAAH,GAAG,CAAa;IAClC,CAAC;IAEJ;;;;;;OAMG;IACI,KAAK,CAAC,UAAU,CACrB,CAA0B;QAE1B,IAAI,CAAC;YACH,IAAI,CAAC,CAAC,MAAM;gBACV,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC;oBAChC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;iBAC9B,CAAC,CAAC;QACP,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;QAEV,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC;YACzB,MAAM,EAAE,CAAC,CAAC,MAAM;YAChB,SAAS,EAAE,CAAC,CAAC,SAAS;YACtB,OAAO,EAAE,CAAC,CAAC,SAAS;YACpB,YAAY,EAAE,CAAC,CAAC,YAAY;SAC7B,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,QAAQ,CACnB,CAA0B;QAE1B,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QACnC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE5D,MAAM,OAAO,GAA4B,EAAE,CAAC;QAC5C,IAAI,IAAI,GAAkB,IAAI,CAAC;QAE/B,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC;YACd,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YACzD,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAC/C,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC;YAC/C,MAAM,EAAE,SAAS;YACjB,IAAI,EAAE;gBACJ,YAAY,EAAE,CAAC,CAAC,YAAY;gBAC5B,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE;oBACX,UAAU,EAAE,MAAM;oBAClB,GAAG,EAAE,CAAC,CAAC,SAAS;oBAChB,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI;oBACrD,IAAI;oBACJ,SAAS,EAAE;wBACT,mBAAmB,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc;wBAC5C,mGAAmG;wBACnG,+BAA+B;qBAChC;iBACF;aACF;SACF,CAAC,CAAC;QACH,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,QAAQ;QACnB,MAAM,KAAK,GAAG,CACZ,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC,CAC/D,CAAC,CAAC,CAAC,CAAC;QACL,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,OAAO,CAAC,MAAc;QACjC,MAAM,IAAI,GAAG,CACX,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;YAC7B,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;SAC5B,CAAC,CACH,CAAC,CAAC,CAAC,CAAC;QACL,OAAO,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,UAAU,CAAC,MAAc;QACpC,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACnC,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,WAAW,CAAC,MAAc;QACrC,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAC3B,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACI,QAAQ,CAAC,MAAc;QAC5B,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAC9B,IAAI,CAAC,GAAG,CAAC,SAAS,EAClB,IAAI,CAAC,GAAG,CAAC,MAAM,EACf,IAAI,CAAC,OAAO,EACZ,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,SAAS;QACd,OAAO,IAAI,CAAC,WAAW,CAAC,SAAS,CAC/B,IAAI,CAAC,GAAG,CAAC,SAAS,EAClB,IAAI,CAAC,GAAG,CAAC,MAAM,EACf,IAAI,CAAC,OAAO,CACb,CAAC;IACJ,CAAC;IAES,mBAAmB,CAAC,IAAkB;QAC9C,MAAM,MAAM,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;QACrC,IAAI,CAAC,MAAM,CAAC,IAAI;YAAE,OAAO,MAAM,CAAC;QAChC,MAAM,KAAK,GAAG,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,KAAK;YAAE,MAAM,CAAC,SAAS,GAAG,KAAK,CAAC;QACpC,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}
+{"version":3,"file":"FirebaseTaskQueueHandler.js","sourceRoot":"","sources":["../../src/firebase/FirebaseTaskQueueHandler.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD;;;;;;;GAOG;AACH,MAAM,OAAO,wBAAwB;IASjB;IACG;IACA;IAVrB;;;;;;OAMG;IACH,YACkB,OAAe,EACZ,WAA6B,EAC7B,GAAgB;QAFnB,YAAO,GAAP,OAAO,CAAQ;QACZ,gBAAW,GAAX,WAAW,CAAkB;QAC7B,QAAG,GAAH,GAAG,CAAa;IAClC,CAAC;IAEJ;;;;;;OAMG;IACI,KAAK,CAAC,UAAU,CACrB,CAA0B;QAE1B,IAAI,CAAC;YACH,IAAI,CAAC,CAAC,MAAM;gBACV,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC;oBAChC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;iBAC9B,CAAC,CAAC;QACP,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;QAEV,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC;YACzB,MAAM,EAAE,CAAC,CAAC,MAAM;YAChB,SAAS,EAAE,CAAC,CAAC,SAAS;YACtB,OAAO,EAAE,CAAC,CAAC,SAAS;YACpB,YAAY,EAAE,CAAC,CAAC,YAAY;SAC7B,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,QAAQ,CACnB,CAA0B;QAE1B,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QACnC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE5D,MAAM,OAAO,GAA4B,EAAE,CAAC;QAC5C,IAAI,IAAI,GAAkB,IAAI,CAAC;QAE/B,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC;YACd,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YACzD,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAC/C,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC;YAC/C,MAAM,EAAE,SAAS;YACjB,IAAI,EAAE;gBACJ,YAAY,EAAE,CAAC,CAAC,YAAY;gBAC5B,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE;oBACX,UAAU,EAAE,MAAM;oBAClB,GAAG,EAAE,CAAC,CAAC,SAAS;oBAChB,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI;oBACrD,IAAI;oBACJ,SAAS,EAAE;wBACT,mBAAmB,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc;wBAC5C,mGAAmG;wBACnG,+BAA+B;qBAChC;iBACF;aACF;SACF,CAAC,CAAC;QACH,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,QAAQ;QACnB,MAAM,KAAK,GAAG,CACZ,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC,CAC/D,CAAC,CAAC,CAAC,CAAC;QACL,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,OAAO,CAAC,MAAc;QACjC,MAAM,IAAI,GAAG,CACX,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;YAC7B,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;SAC5B,CAAC,CACH,CAAC,CAAC,CAAC,CAAC;QACL,OAAO,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,UAAU,CAAC,MAAc;QACpC,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACnC,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,WAAW,CAAC,MAAc;QACrC,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAC3B,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,QAAQ,CAAC,MAAc;QAC5B,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAC9B,IAAI,CAAC,GAAG,CAAC,SAAS,EAClB,IAAI,CAAC,GAAG,CAAC,MAAM,EACf,IAAI,CAAC,OAAO,EACZ,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,SAAS;QACd,OAAO,IAAI,CAAC,WAAW,CAAC,SAAS,CAC/B,IAAI,CAAC,GAAG,CAAC,SAAS,EAClB,IAAI,CAAC,GAAG,CAAC,MAAM,EACf,IAAI,CAAC,OAAO,CACb,CAAC;IACJ,CAAC;IAES,mBAAmB,CAAC,IAAkB;QAC9C,MAAM,MAAM,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;QACrC,IAAI,CAAC,MAAM,CAAC,IAAI;YAAE,OAAO,MAAM,CAAC;QAChC,MAAM,KAAK,GAAG,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,KAAK;YAAE,MAAM,CAAC,SAAS,GAAG,KAAK,CAAC;QACpC,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

package/dist/firebase/firebase.express.d.ts

@@ -28,17 +28,25 @@ declare global {
  */
 export declare const checkFirebaseAuth: ExpressAuthHandler;
 /**
- * Express middleware that verifies Google OIDC bearer tokens for service-to-service authentication.
+ * Builds an Express middleware that verifies Google OIDC bearer tokens for
+ * service-to-service authentication.
  *
  * @remarks
- * Only `POST` requests are allowed; all other methods receive a `405` response.
- * The token audience is read from the `INTERNAL_FUNCTION_URL` environment variable.
- * An optional `ALLOWED_CALLER_SA_EMAIL` environment variable can restrict access to
- * a single service account.
+ * The returned middleware:
  *
- * @param req - The incoming Express request.
- * @param res - The Express response object.
- * @param next - The next middleware function.
+ * - Allows only `POST`; other methods receive a `405` response.
+ * - Reads the expected audience from `audience` or, when omitted, the
+ *   `INTERNAL_FUNCTION_URL` environment variable.
+ * - When `routes` is provided, the audience is augmented per-request with the
+ *   matching `/<route>` suffix so multi-route functions verify against the
+ *   exact URL Cloud Scheduler / Cloud Tasks used.
+ * - When `ALLOWED_CALLER_SA_EMAIL` is set, only that service account is
+ *   accepted as the calling identity.
+ *
+ * @param audience - Override for the expected OIDC audience.
+ * @param routes - Optional list of valid route names used to refine the audience per request.
+ * @returns An Express middleware that populates `req.auth` on success and
+ *   responds with `401` / `403` / `405` on failure.
  */
 export declare const buildCheckServiceAuth: (audience?: string | null, routes?: string[] | null) => ExpressAuthHandler;
 //# sourceMappingURL=firebase.express.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"firebase.express.d.ts","sourceRoot":"","sources":["../../src/firebase/firebase.express.ts"],"names":[],"mappings":"AACA,OAAO,EAAW,KAAK,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAEpE,OAAO,CAAC,MAAM,CAAC;IAEb,UAAU,OAAO,CAAC;QAChB,UAAU,OAAO;YACf,IAAI,CAAC,EAAE;gBACL,GAAG,CAAC,EAAE,MAAM,CAAC;gBACb,OAAO,CAAC,EAAE,OAAO,CAAC;gBAClB,KAAK,CAAC,EAAE,MAAM,CAAC;gBACf,KAAK,CAAC,EAAE,cAAc,CAAC;aACxB,CAAC;SACH;KACF;CACF;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,iBAAiB,EAAE,kBAgB/B,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,qBAAqB,GAChC,WAAW,MAAM,GAAG,IAAI,EACxB,SAAS,MAAM,EAAE,GAAG,IAAI,KACvB,kBA0DF,CAAC"}
+{"version":3,"file":"firebase.express.d.ts","sourceRoot":"","sources":["../../src/firebase/firebase.express.ts"],"names":[],"mappings":"AACA,OAAO,EAAW,KAAK,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAEpE,OAAO,CAAC,MAAM,CAAC;IAEb,UAAU,OAAO,CAAC;QAChB,UAAU,OAAO;YACf,IAAI,CAAC,EAAE;gBACL,GAAG,CAAC,EAAE,MAAM,CAAC;gBACb,OAAO,CAAC,EAAE,OAAO,CAAC;gBAClB,KAAK,CAAC,EAAE,MAAM,CAAC;gBACf,KAAK,CAAC,EAAE,cAAc,CAAC;aACxB,CAAC;SACH;KACF;CACF;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,iBAAiB,EAAE,kBAgB/B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,qBAAqB,GAChC,WAAW,MAAM,GAAG,IAAI,EACxB,SAAS,MAAM,EAAE,GAAG,IAAI,KACvB,kBA0DF,CAAC"}

package/dist/firebase/firebase.express.js

@@ -29,17 +29,25 @@ export const checkFirebaseAuth = async (req, _res, next) => {
     next();
 };
 /**
- * Express middleware that verifies Google OIDC bearer tokens for service-to-service authentication.
+ * Builds an Express middleware that verifies Google OIDC bearer tokens for
+ * service-to-service authentication.
  *
  * @remarks
- * Only `POST` requests are allowed; all other methods receive a `405` response.
- * The token audience is read from the `INTERNAL_FUNCTION_URL` environment variable.
- * An optional `ALLOWED_CALLER_SA_EMAIL` environment variable can restrict access to
- * a single service account.
+ * The returned middleware:
  *
- * @param req - The incoming Express request.
- * @param res - The Express response object.
- * @param next - The next middleware function.
+ * - Allows only `POST`; other methods receive a `405` response.
+ * - Reads the expected audience from `audience` or, when omitted, the
+ *   `INTERNAL_FUNCTION_URL` environment variable.
+ * - When `routes` is provided, the audience is augmented per-request with the
+ *   matching `/<route>` suffix so multi-route functions verify against the
+ *   exact URL Cloud Scheduler / Cloud Tasks used.
+ * - When `ALLOWED_CALLER_SA_EMAIL` is set, only that service account is
+ *   accepted as the calling identity.
+ *
+ * @param audience - Override for the expected OIDC audience.
+ * @param routes - Optional list of valid route names used to refine the audience per request.
+ * @returns An Express middleware that populates `req.auth` on success and
+ *   responds with `401` / `403` / `405` on failure.
  */
 export const buildCheckServiceAuth = (audience, routes) => {
     const aud = audience?.substring(0);

package/dist/firebase/firebase.express.js.map

@@ -1 +1 @@
-{"version":3,"file":"firebase.express.js","sourceRoot":"","sources":["../../src/firebase/firebase.express.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,OAAO,EAAuB,MAAM,qBAAqB,CAAC;AAiBnE;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAuB,KAAK,EACxD,GAAG,EACH,IAAI,EACJ,IAAI,EACJ,EAAE;IACF,MAAM,UAAU,GAAG,GAAG,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC;IACrD,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACjD,IAAI,KAAK,EAAE,CAAC;QACV,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,OAAO,EAAE,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YACxD,GAAG,CAAC,IAAI,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;QACxE,CAAC;QAAC,MAAM,CAAC;YACP,gEAAgE;QAClE,CAAC;IACH,CAAC;IACD,IAAI,EAAE,CAAC;AACT,CAAC,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,QAAwB,EACxB,MAAwB,EACJ,EAAE;IACtB,MAAM,GAAG,GAAuB,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IACvD,MAAM,GAAG,GAAyB,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAE9D,OAAO,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QAC9B,uDAAuD;QACvD,IAAI,GAAG,CAAC,MAAM,KAAK,MAAM;YACvB,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAEpD,IAAI,CAAC;YACH,MAAM,UAAU,GAAG,GAAG,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC;YACrD,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;YACjD,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,OAAO,CAAC,KAAK,CAAC,6CAA6C,CAAC,CAAC;gBAC7D,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAC;YACvE,CAAC;YACD,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YAEzB,0DAA0D;YAC1D,iEAAiE;YACjE,MAAM,YAAY,GAAG,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC;YAC9D,IAAI,CAAC,YAAY,EAAE,CAAC;gBAClB,OAAO,CAAC,KAAK,CAAC,gDAAgD,CAAC,CAAC;gBAChE,OAAO,GAAG;qBACP,MAAM,CAAC,GAAG,CAAC;qBACX,IAAI,CAAC,gDAAgD,CAAC,CAAC;YAC5D,CAAC;YAED,MAAM,UAAU,GAAG,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,GAAG,CAAC,WAAW,CAAC,CAAC;YAC3D,MAAM,QAAQ,GAAG,UAAU;gBACzB,CAAC,CAAC,GAAG,YAAY,GAAG,UAAU,EAAE;gBAChC,CAAC,CAAC,YAAY,CAAC;YAEjB,MAAM,IAAI,GAAG,IAAI,UAAU,EAAE,CAAC;YAC9B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;YACrD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;YACjE,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC;YACpC,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,OAAO,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;gBAC7C,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;YACvD,CAAC;YAED,wEAAwE;YACxE,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC;YAC1D,IAAI,aAAa,IAAI,OAAO,CAAC,KAAK,KAAK,aAAa,EAAE,CAAC;gBACrD,OAAO,CAAC,KAAK,CAAC,0CAA0C,CAAC,CAAC;gBAC1D,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAC;YACpE,CAAC;YAED,GAAG,CAAC,IAAI,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;YACnD,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,CAAC,KAAK,CAAC,+BAA+B,EAAE,CAAC,CAAC,CAAC;YAClD,MAAM,OAAO,GACX,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YACzE,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,iBAAiB,OAAO,EAAE,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC,CAAC;AACJ,CAAC,CAAC"}
+{"version":3,"file":"firebase.express.js","sourceRoot":"","sources":["../../src/firebase/firebase.express.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,OAAO,EAAuB,MAAM,qBAAqB,CAAC;AAiBnE;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAuB,KAAK,EACxD,GAAG,EACH,IAAI,EACJ,IAAI,EACJ,EAAE;IACF,MAAM,UAAU,GAAG,GAAG,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC;IACrD,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACjD,IAAI,KAAK,EAAE,CAAC;QACV,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,OAAO,EAAE,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YACxD,GAAG,CAAC,IAAI,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;QACxE,CAAC;QAAC,MAAM,CAAC;YACP,gEAAgE;QAClE,CAAC;IACH,CAAC;IACD,IAAI,EAAE,CAAC;AACT,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,QAAwB,EACxB,MAAwB,EACJ,EAAE;IACtB,MAAM,GAAG,GAAuB,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IACvD,MAAM,GAAG,GAAyB,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAE9D,OAAO,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QAC9B,uDAAuD;QACvD,IAAI,GAAG,CAAC,MAAM,KAAK,MAAM;YACvB,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAEpD,IAAI,CAAC;YACH,MAAM,UAAU,GAAG,GAAG,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC;YACrD,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;YACjD,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,OAAO,CAAC,KAAK,CAAC,6CAA6C,CAAC,CAAC;gBAC7D,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAC;YACvE,CAAC;YACD,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YAEzB,0DAA0D;YAC1D,iEAAiE;YACjE,MAAM,YAAY,GAAG,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC;YAC9D,IAAI,CAAC,YAAY,EAAE,CAAC;gBAClB,OAAO,CAAC,KAAK,CAAC,gDAAgD,CAAC,CAAC;gBAChE,OAAO,GAAG;qBACP,MAAM,CAAC,GAAG,CAAC;qBACX,IAAI,CAAC,gDAAgD,CAAC,CAAC;YAC5D,CAAC;YAED,MAAM,UAAU,GAAG,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,GAAG,CAAC,WAAW,CAAC,CAAC;YAC3D,MAAM,QAAQ,GAAG,UAAU;gBACzB,CAAC,CAAC,GAAG,YAAY,GAAG,UAAU,EAAE;gBAChC,CAAC,CAAC,YAAY,CAAC;YAEjB,MAAM,IAAI,GAAG,IAAI,UAAU,EAAE,CAAC;YAC9B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;YACrD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;YACjE,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC;YACpC,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,OAAO,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;gBAC7C,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;YACvD,CAAC;YAED,wEAAwE;YACxE,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC;YAC1D,IAAI,aAAa,IAAI,OAAO,CAAC,KAAK,KAAK,aAAa,EAAE,CAAC;gBACrD,OAAO,CAAC,KAAK,CAAC,0CAA0C,CAAC,CAAC;gBAC1D,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAC;YACpE,CAAC;YAED,GAAG,CAAC,IAAI,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;YACnD,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,CAAC,KAAK,CAAC,+BAA+B,EAAE,CAAC,CAAC,CAAC;YAClD,MAAM,OAAO,GACX,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YACzE,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,iBAAiB,OAAO,EAAE,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC,CAAC;AACJ,CAAC,CAAC"}

package/dist/firebase/firebase.tasks.d.ts

@@ -1,6 +1,25 @@
 import type { FirebaseQueueFqName, FirebaseTaskDurationParams, FirebaseTaskFqName, FirebaseTaskName, FirebaseTaskTimestamp } from "../types/types.tasks.js";
+/**
+ * Pattern matching a fully-qualified Cloud Tasks task resource path.
+ *
+ * @remarks
+ * Capture groups (in order): project ID, region, queue ID, task ID.
+ * Used by {@link fromTaskPath}.
+ */
 export declare const taskPathRegex: RegExp;
+/**
+ * Pattern matching a fully-qualified Cloud Tasks queue resource path.
+ *
+ * @remarks
+ * Capture groups (in order): project ID, region, queue ID. Used by {@link fromQueuePath}.
+ */
 export declare const queuePathRegex: RegExp;
+/**
+ * Pattern matching the short `<queueId>-<taskId>` form used as a friendly task name.
+ *
+ * @remarks
+ * Used by {@link fromTaskName} and {@link toTaskName}.
+ */
 export declare const taskNameRegex: RegExp;
 /**
  * Compute a Cloud Tasks schedule timestamp from a duration specification or an absolute `Date`.
@@ -30,6 +49,18 @@ export declare const fromTaskPath: (path: string) => FirebaseTaskFqName | null;
  * @returns The parsed parts, or `null` if the path does not match the expected format.
  */
 export declare const fromQueuePath: (path: string) => FirebaseQueueFqName | null;
+/**
+ * Parses a short `<queueId>-<taskId>` task name into its parts.
+ *
+ * @param name - The short task name to parse.
+ * @returns The parsed parts, or `null` if `name` does not match {@link taskNameRegex}.
+ */
 export declare const fromTaskName: (name: string) => FirebaseTaskName | null;
+/**
+ * Formats a {@link FirebaseTaskName} back into its short `<queueId>-<taskId>` string form.
+ *
+ * @param name - The task name parts.
+ * @returns The joined `<queueId>-<taskId>` string.
+ */
 export declare const toTaskName: (name: FirebaseTaskName) => string;
 //# sourceMappingURL=firebase.tasks.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"firebase.tasks.d.ts","sourceRoot":"","sources":["../../src/firebase/firebase.tasks.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,mBAAmB,EACnB,0BAA0B,EAC1B,kBAAkB,EAClB,gBAAgB,EAChB,qBAAqB,EACtB,MAAM,yBAAyB,CAAC;AAEjC,eAAO,MAAM,aAAa,QACsF,CAAC;AAEjH,eAAO,MAAM,cAAc,QAC4D,CAAC;AAExF,eAAO,MAAM,aAAa,QAAsC,CAAC;AAEjE;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,qBAAqB,GAChC,eAAe,0BAA0B,GAAG,IAAI,KAC/C,qBAuBF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GAAI,MAAM,MAAM,KAAG,kBAAkB,GAAG,IAShE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,GAAI,MAAM,MAAM,KAAG,mBAAmB,GAAG,IAQlE,CAAC;AAEF,eAAO,MAAM,YAAY,GAAI,MAAM,MAAM,KAAG,gBAAgB,GAAG,IAO9D,CAAC;AAEF,eAAO,MAAM,UAAU,GAAI,MAAM,gBAAgB,KAAG,MAClB,CAAC"}
+{"version":3,"file":"firebase.tasks.d.ts","sourceRoot":"","sources":["../../src/firebase/firebase.tasks.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,mBAAmB,EACnB,0BAA0B,EAC1B,kBAAkB,EAClB,gBAAgB,EAChB,qBAAqB,EACtB,MAAM,yBAAyB,CAAC;AAEjC;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,QACsF,CAAC;AAEjH;;;;;GAKG;AACH,eAAO,MAAM,cAAc,QAC4D,CAAC;AAExF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,QAAsC,CAAC;AAEjE;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,qBAAqB,GAChC,eAAe,0BAA0B,GAAG,IAAI,KAC/C,qBAuBF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GAAI,MAAM,MAAM,KAAG,kBAAkB,GAAG,IAShE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,GAAI,MAAM,MAAM,KAAG,mBAAmB,GAAG,IAQlE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GAAI,MAAM,MAAM,KAAG,gBAAgB,GAAG,IAO9D,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,UAAU,GAAI,MAAM,gBAAgB,KAAG,MAClB,CAAC"}