@mxpicture/gcp-functions-backend 1.2.129 → 1.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/firebase/FirebaseTaskHandler.d.ts +3 -0
- package/dist/firebase/FirebaseTaskHandler.d.ts.map +1 -1
- package/dist/firebase/FirebaseTaskHandler.js +11 -0
- package/dist/firebase/FirebaseTaskHandler.js.map +1 -1
- package/dist/firebase/FirebaseTaskQueueHandler.d.ts +58 -0
- package/dist/firebase/FirebaseTaskQueueHandler.d.ts.map +1 -0
- package/dist/firebase/FirebaseTaskQueueHandler.js +72 -0
- package/dist/firebase/FirebaseTaskQueueHandler.js.map +1 -0
- package/dist/firebase/index.d.ts +1 -0
- package/dist/firebase/index.d.ts.map +1 -1
- package/dist/firebase/index.js +1 -0
- package/dist/firebase/index.js.map +1 -1
- package/dist/types/types.tasks.d.ts +5 -0
- package/dist/types/types.tasks.d.ts.map +1 -1
- package/package.json +2 -2
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { CloudTasksClient } from "@google-cloud/tasks";
|
|
2
2
|
import type { FirebaseQueueNameParts, FirebaseTask, FirebaseTaskEnv, FirebaseTaskNameParts, FirebaseTaskParams, FirebaseTaskTimestamp } from "../types/types.tasks.js";
|
|
3
|
+
import { FirebaseTaskQueueHandler } from "./FirebaseTaskQueueHandler.js";
|
|
3
4
|
/**
|
|
4
5
|
* Client wrapper around Google Cloud Tasks for scheduling, retrieving, and managing HTTP-targeted tasks.
|
|
5
6
|
*
|
|
@@ -10,12 +11,14 @@ import type { FirebaseQueueNameParts, FirebaseTask, FirebaseTaskEnv, FirebaseTas
|
|
|
10
11
|
export declare class FirebaseTaskHandler {
|
|
11
12
|
protected readonly env: FirebaseTaskEnv;
|
|
12
13
|
protected tasksClient: CloudTasksClient;
|
|
14
|
+
protected queueHandlers: FirebaseTaskQueueHandler[];
|
|
13
15
|
/**
|
|
14
16
|
* Create a new task handler.
|
|
15
17
|
*
|
|
16
18
|
* @param env - Environment configuration containing `projectId`, `region`, and `serviceAccount`.
|
|
17
19
|
*/
|
|
18
20
|
constructor(env: FirebaseTaskEnv);
|
|
21
|
+
getQueueHandler(queueId: string): FirebaseTaskQueueHandler;
|
|
19
22
|
/**
|
|
20
23
|
* Delete an existing task (if present) and create a new one with the same ID at a new schedule time.
|
|
21
24
|
*
|
|
@@ -1 +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,sBAAsB,EACtB,YAAY,EACZ,eAAe,EACf,qBAAqB,EACrB,kBAAkB,EAClB,qBAAqB,EACtB,MAAM,yBAAyB,CAAC;
|
|
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,sBAAsB,EACtB,YAAY,EACZ,eAAe,EACf,qBAAqB,EACrB,kBAAkB,EAClB,qBAAqB,EACtB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAOzE;;;;;;GAMG;AACH,qBAAa,mBAAmB;IASX,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,eAAe;IAR1D,SAAS,CAAC,WAAW,EAAE,gBAAgB,CAAC;IACxC,SAAS,CAAC,aAAa,EAAE,wBAAwB,EAAE,CAAM;IAEzD;;;;OAIG;gBACmC,GAAG,EAAE,eAAe;IAInD,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,wBAAwB;IAYjE;;;;;;OAMG;IACU,UAAU,CACrB,CAAC,EAAE,kBAAkB,GAAG;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,EAC1C,YAAY,EAAE,qBAAqB,GAClC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAgBzB;;;;;;OAMG;IACU,QAAQ,CACnB,CAAC,EAAE,kBAAkB,EACrB,YAAY,EAAE,qBAAqB,GAClC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAmCzB;;;;;OAKG;IACU,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAO/D;;;;;;OAMG;IACU,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAO5E;;;;;;OAMG;IACU,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAS3E;;;;;;OAMG;IACI,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM;IASxD;;;;;OAKG;IACI,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,GAAG,IAAI;IAW/D;;;;;OAKG;IACI,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAQzC;;;;;OAKG;IACI,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,sBAAsB,GAAG,IAAI;IAUjE,SAAS,CAAC,mBAAmB,CAAC,IAAI,EAAE,YAAY,GAAG,YAAY;CAOhE"}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { CloudTasksClient } from "@google-cloud/tasks";
|
|
2
|
+
import { FirebaseTaskQueueHandler } from "./FirebaseTaskQueueHandler.js";
|
|
2
3
|
const taskPathRegex = /^projects\/([a-zA-Z0-9-_]+)\/locations\/([a-zA-Z0-9-_]+)\/queues\/([a-zA-Z0-9-_]+)\/tasks\/([a-zA-Z0-9-_]+)$/;
|
|
3
4
|
const queuePathRegex = /^projects\/([a-zA-Z0-9-_]+)\/locations\/([a-zA-Z0-9-_]+)\/queues\/([a-zA-Z0-9-_]+)$/;
|
|
4
5
|
/**
|
|
@@ -11,6 +12,7 @@ const queuePathRegex = /^projects\/([a-zA-Z0-9-_]+)\/locations\/([a-zA-Z0-9-_]+)
|
|
|
11
12
|
export class FirebaseTaskHandler {
|
|
12
13
|
env;
|
|
13
14
|
tasksClient;
|
|
15
|
+
queueHandlers = [];
|
|
14
16
|
/**
|
|
15
17
|
* Create a new task handler.
|
|
16
18
|
*
|
|
@@ -20,6 +22,15 @@ export class FirebaseTaskHandler {
|
|
|
20
22
|
this.env = env;
|
|
21
23
|
this.tasksClient = new CloudTasksClient();
|
|
22
24
|
}
|
|
25
|
+
getQueueHandler(queueId) {
|
|
26
|
+
let handler = this.queueHandlers.find((handler) => handler.queueId === queueId);
|
|
27
|
+
if (!handler) {
|
|
28
|
+
handler = new FirebaseTaskQueueHandler(queueId);
|
|
29
|
+
this.queueHandlers.push(handler);
|
|
30
|
+
}
|
|
31
|
+
handler.__taskHandler = this;
|
|
32
|
+
return handler;
|
|
33
|
+
}
|
|
23
34
|
/**
|
|
24
35
|
* Delete an existing task (if present) and create a new one with the same ID at a new schedule time.
|
|
25
36
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"FirebaseTaskHandler.js","sourceRoot":"","sources":["../../src/firebase/FirebaseTaskHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;
|
|
1
|
+
{"version":3,"file":"FirebaseTaskHandler.js","sourceRoot":"","sources":["../../src/firebase/FirebaseTaskHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AASvD,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAEzE,MAAM,aAAa,GACjB,8GAA8G,CAAC;AACjH,MAAM,cAAc,GAClB,qFAAqF,CAAC;AAExF;;;;;;GAMG;AACH,MAAM,OAAO,mBAAmB;IASQ;IAR5B,WAAW,CAAmB;IAC9B,aAAa,GAA+B,EAAE,CAAC;IAEzD;;;;OAIG;IACH,YAAsC,GAAoB;QAApB,QAAG,GAAH,GAAG,CAAiB;QACxD,IAAI,CAAC,WAAW,GAAG,IAAI,gBAAgB,EAAE,CAAC;IAC5C,CAAC;IAEM,eAAe,CAAC,OAAe;QACpC,IAAI,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CACnC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,KAAK,OAAO,CACzC,CAAC;QACF,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,GAAG,IAAI,wBAAwB,CAAC,OAAO,CAAC,CAAC;YAChD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnC,CAAC;QACD,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC;QAC7B,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,UAAU,CACrB,CAA0C,EAC1C,YAAmC;QAEnC,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;YACpD,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;QACxD,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;QACV,OAAO,IAAI,CAAC,QAAQ,CAClB;YACE,SAAS,EAAE,CAAC,CAAC,SAAS;YACtB,OAAO,EAAE,CAAC,CAAC,OAAO;YAClB,MAAM,EAAE,CAAC,CAAC,MAAM;YAChB,OAAO,EAAE,CAAC,CAAC,OAAO;SACnB,EACD,YAAY,CACb,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,QAAQ,CACnB,CAAqB,EACrB,YAAmC;QAEnC,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAC5C,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAEtE,IAAI,IAAI,GAAkB,IAAI,CAAC;QAC/B,IAAI,OAAO,GAAmC,IAAI,CAAC;QAEnD,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,GAAG;gBACR,cAAc,EAAE,kBAAkB;aACnC,CAAC;QACJ,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC;YAC/C,MAAM,EAAE,SAAS;YACjB,IAAI,EAAE;gBACJ,YAAY;gBACZ,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE;oBACX,UAAU,EAAE,MAAM;oBAClB,GAAG,EAAE,CAAC,CAAC,SAAS;oBAChB,OAAO;oBACP,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,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,QAAQ,CAAC,OAAe;QACnC,MAAM,KAAK,GAAG,CACZ,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CACtE,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;;;;;;OAMG;IACI,KAAK,CAAC,OAAO,CAAC,OAAe,EAAE,MAAc;QAClD,MAAM,IAAI,GAAG,CACX,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC,CACzE,CAAC,CAAC,CAAC,CAAC;QACL,OAAO,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,WAAW,CAAC,OAAe,EAAE,MAAc;QACtD,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YACpC,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACI,QAAQ,CAAC,OAAe,EAAE,MAAc;QAC7C,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAC9B,IAAI,CAAC,GAAG,CAAC,SAAS,EAClB,IAAI,CAAC,GAAG,CAAC,MAAM,EACf,OAAO,EACP,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,YAAY,CAAC,IAAY;QAC9B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QACxC,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC;QACxB,OAAO;YACL,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;YACnB,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;YAChB,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;YACjB,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;SACjB,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,SAAS,CAAC,OAAe;QAC9B,OAAO,IAAI,CAAC,WAAW,CAAC,SAAS,CAC/B,IAAI,CAAC,GAAG,CAAC,SAAS,EAClB,IAAI,CAAC,GAAG,CAAC,MAAM,EACf,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAAC,IAAY;QAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QACzC,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC;QACxB,OAAO;YACL,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;YACnB,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;YAChB,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;SAClB,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,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,KAAK;YAAE,MAAM,CAAC,SAAS,GAAG,KAAK,CAAC;QACpC,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
import type { FirebaseTask, FirebaseTaskQueueParams, FirebaseTaskTimestamp } from "../types/types.tasks.js";
|
|
2
|
+
import type { FirebaseTaskHandler } from "./FirebaseTaskHandler.js";
|
|
3
|
+
/**
|
|
4
|
+
* Client wrapper around Google Cloud Tasks for scheduling, retrieving, and managing HTTP-targeted tasks.
|
|
5
|
+
*
|
|
6
|
+
* @remarks
|
|
7
|
+
* All queue and task paths are derived from the {@link FirebaseTaskEnv} provided at construction.
|
|
8
|
+
* Task payloads are sent as base64-encoded JSON via `POST` with OIDC authentication.
|
|
9
|
+
*/
|
|
10
|
+
export declare class FirebaseTaskQueueHandler {
|
|
11
|
+
readonly queueId: string;
|
|
12
|
+
protected _taskHandler: FirebaseTaskHandler | null;
|
|
13
|
+
protected queueHandlers: FirebaseTaskQueueHandler[];
|
|
14
|
+
constructor(queueId: string);
|
|
15
|
+
set __taskHandler(handler: FirebaseTaskHandler);
|
|
16
|
+
get taskHandler(): FirebaseTaskHandler;
|
|
17
|
+
/**
|
|
18
|
+
* Delete an existing task (if present) and create a new one with the same ID at a new schedule time.
|
|
19
|
+
*
|
|
20
|
+
* @param p - Task parameters including the mandatory `taskId` to reschedule.
|
|
21
|
+
* @param scheduleTime - The new schedule timestamp.
|
|
22
|
+
* @returns The full task resource name, or `null` if the task has no name.
|
|
23
|
+
*/
|
|
24
|
+
reschedule(p: FirebaseTaskQueueParams & {
|
|
25
|
+
taskId: string;
|
|
26
|
+
}, scheduleTime: FirebaseTaskTimestamp): Promise<string | null>;
|
|
27
|
+
/**
|
|
28
|
+
* Create a new Cloud Task scheduled for the given time.
|
|
29
|
+
*
|
|
30
|
+
* @param p - Task parameters: target URL, optional payload, optional task ID, and queue ID.
|
|
31
|
+
* @param scheduleTime - When the task should be dispatched.
|
|
32
|
+
* @returns The full task resource name, or `null` if the created task has no name.
|
|
33
|
+
*/
|
|
34
|
+
schedule(p: FirebaseTaskQueueParams, scheduleTime: FirebaseTaskTimestamp): Promise<string | null>;
|
|
35
|
+
/**
|
|
36
|
+
* List all tasks in a queue.
|
|
37
|
+
*
|
|
38
|
+
* @param queueId - The queue identifier.
|
|
39
|
+
* @returns An array of tasks with parsed `nameParts`.
|
|
40
|
+
*/
|
|
41
|
+
getTasks(): Promise<FirebaseTask[]>;
|
|
42
|
+
/**
|
|
43
|
+
* Retrieve a single task by queue and task ID.
|
|
44
|
+
*
|
|
45
|
+
* @param taskId - The task identifier.
|
|
46
|
+
* @returns The task with parsed `nameParts`.
|
|
47
|
+
*/
|
|
48
|
+
getTask(taskId: string): Promise<FirebaseTask>;
|
|
49
|
+
/**
|
|
50
|
+
* Check whether a task exists (is currently scheduled) in a queue.
|
|
51
|
+
*
|
|
52
|
+
* @param queueId - The queue identifier.
|
|
53
|
+
* @param taskId - The task identifier.
|
|
54
|
+
* @returns `true` if the task exists, `false` otherwise.
|
|
55
|
+
*/
|
|
56
|
+
isScheduled(queueId: string, taskId: string): Promise<boolean>;
|
|
57
|
+
}
|
|
58
|
+
//# sourceMappingURL=FirebaseTaskQueueHandler.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"FirebaseTaskQueueHandler.d.ts","sourceRoot":"","sources":["../../src/firebase/FirebaseTaskQueueHandler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,uBAAuB,EACvB,qBAAqB,EACtB,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAEpE;;;;;;GAMG;AACH,qBAAa,wBAAwB;aAIA,OAAO,EAAE,MAAM;IAHlD,SAAS,CAAC,YAAY,EAAE,mBAAmB,GAAG,IAAI,CAAQ;IAC1D,SAAS,CAAC,aAAa,EAAE,wBAAwB,EAAE,CAAM;gBAEtB,OAAO,EAAE,MAAM;IAElD,IAAW,aAAa,CAAC,OAAO,EAAE,mBAAmB,EAEpD;IAED,IAAW,WAAW,IAAI,mBAAmB,CAI5C;IAED;;;;;;OAMG;IACU,UAAU,CACrB,CAAC,EAAE,uBAAuB,GAAG;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,EAC/C,YAAY,EAAE,qBAAqB,GAClC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAOzB;;;;;;OAMG;IACU,QAAQ,CACnB,CAAC,EAAE,uBAAuB,EAC1B,YAAY,EAAE,qBAAqB,GAClC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAOzB;;;;;OAKG;IACU,QAAQ,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;IAIhD;;;;;OAKG;IACU,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAI3D;;;;;;OAMG;IACU,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;CAG5E"}
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Client wrapper around Google Cloud Tasks for scheduling, retrieving, and managing HTTP-targeted tasks.
|
|
3
|
+
*
|
|
4
|
+
* @remarks
|
|
5
|
+
* All queue and task paths are derived from the {@link FirebaseTaskEnv} provided at construction.
|
|
6
|
+
* Task payloads are sent as base64-encoded JSON via `POST` with OIDC authentication.
|
|
7
|
+
*/
|
|
8
|
+
export class FirebaseTaskQueueHandler {
|
|
9
|
+
queueId;
|
|
10
|
+
_taskHandler = null;
|
|
11
|
+
queueHandlers = [];
|
|
12
|
+
constructor(queueId) {
|
|
13
|
+
this.queueId = queueId;
|
|
14
|
+
}
|
|
15
|
+
set __taskHandler(handler) {
|
|
16
|
+
this._taskHandler = handler;
|
|
17
|
+
}
|
|
18
|
+
get taskHandler() {
|
|
19
|
+
if (!this._taskHandler)
|
|
20
|
+
throw new Error(`No task handler provided. Queue ID ${this.queueId}`);
|
|
21
|
+
return this._taskHandler;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Delete an existing task (if present) and create a new one with the same ID at a new schedule time.
|
|
25
|
+
*
|
|
26
|
+
* @param p - Task parameters including the mandatory `taskId` to reschedule.
|
|
27
|
+
* @param scheduleTime - The new schedule timestamp.
|
|
28
|
+
* @returns The full task resource name, or `null` if the task has no name.
|
|
29
|
+
*/
|
|
30
|
+
async reschedule(p, scheduleTime) {
|
|
31
|
+
return await this.taskHandler.reschedule({ ...p, queueId: this.queueId }, scheduleTime);
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Create a new Cloud Task scheduled for the given time.
|
|
35
|
+
*
|
|
36
|
+
* @param p - Task parameters: target URL, optional payload, optional task ID, and queue ID.
|
|
37
|
+
* @param scheduleTime - When the task should be dispatched.
|
|
38
|
+
* @returns The full task resource name, or `null` if the created task has no name.
|
|
39
|
+
*/
|
|
40
|
+
async schedule(p, scheduleTime) {
|
|
41
|
+
return await this.taskHandler.schedule({ ...p, queueId: this.queueId }, scheduleTime);
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* List all tasks in a queue.
|
|
45
|
+
*
|
|
46
|
+
* @param queueId - The queue identifier.
|
|
47
|
+
* @returns An array of tasks with parsed `nameParts`.
|
|
48
|
+
*/
|
|
49
|
+
async getTasks() {
|
|
50
|
+
return await this.taskHandler.getTasks(this.queueId);
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* Retrieve a single task by queue and task ID.
|
|
54
|
+
*
|
|
55
|
+
* @param taskId - The task identifier.
|
|
56
|
+
* @returns The task with parsed `nameParts`.
|
|
57
|
+
*/
|
|
58
|
+
async getTask(taskId) {
|
|
59
|
+
return await this.taskHandler.getTask(this.queueId, taskId);
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Check whether a task exists (is currently scheduled) in a queue.
|
|
63
|
+
*
|
|
64
|
+
* @param queueId - The queue identifier.
|
|
65
|
+
* @param taskId - The task identifier.
|
|
66
|
+
* @returns `true` if the task exists, `false` otherwise.
|
|
67
|
+
*/
|
|
68
|
+
async isScheduled(queueId, taskId) {
|
|
69
|
+
return await this.taskHandler.isScheduled(queueId, taskId);
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
//# sourceMappingURL=FirebaseTaskQueueHandler.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"FirebaseTaskQueueHandler.js","sourceRoot":"","sources":["../../src/firebase/FirebaseTaskQueueHandler.ts"],"names":[],"mappings":"AAOA;;;;;;GAMG;AACH,MAAM,OAAO,wBAAwB;IAIA;IAHzB,YAAY,GAA+B,IAAI,CAAC;IAChD,aAAa,GAA+B,EAAE,CAAC;IAEzD,YAAmC,OAAe;QAAf,YAAO,GAAP,OAAO,CAAQ;IAAG,CAAC;IAEtD,IAAW,aAAa,CAAC,OAA4B;QACnD,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC;IAC9B,CAAC;IAED,IAAW,WAAW;QACpB,IAAI,CAAC,IAAI,CAAC,YAAY;YACpB,MAAM,IAAI,KAAK,CAAC,sCAAsC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QACxE,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,UAAU,CACrB,CAA+C,EAC/C,YAAmC;QAEnC,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CACtC,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,EAC/B,YAAY,CACb,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,QAAQ,CACnB,CAA0B,EAC1B,YAAmC;QAEnC,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,QAAQ,CACpC,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,EAC/B,YAAY,CACb,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,QAAQ;QACnB,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,OAAO,CAAC,MAAc;QACjC,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,WAAW,CAAC,OAAe,EAAE,MAAc;QACtD,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC7D,CAAC;CACF"}
|
package/dist/firebase/index.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/firebase/index.ts"],"names":[],"mappings":"AACA,cAAc,0BAA0B,CAAC;AACzC,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/firebase/index.ts"],"names":[],"mappings":"AACA,cAAc,0BAA0B,CAAC;AACzC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC"}
|
package/dist/firebase/index.js
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
// This file is auto-generated by build-cli. Do not edit manually.
|
|
2
2
|
export * from "./FirebaseTaskHandler.js";
|
|
3
|
+
export * from "./FirebaseTaskQueueHandler.js";
|
|
3
4
|
export * from "./FirebaseTaskSetup.js";
|
|
4
5
|
export * from "./firebase.backend.js";
|
|
5
6
|
export * from "./firebase.express.js";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/firebase/index.ts"],"names":[],"mappings":"AAAA,kEAAkE;AAClE,cAAc,0BAA0B,CAAC;AACzC,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/firebase/index.ts"],"names":[],"mappings":"AAAA,kEAAkE;AAClE,cAAc,0BAA0B,CAAC;AACzC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC"}
|
|
@@ -13,6 +13,11 @@ export interface FirebaseTaskParams {
|
|
|
13
13
|
taskId?: string;
|
|
14
14
|
queueId: string;
|
|
15
15
|
}
|
|
16
|
+
export interface FirebaseTaskQueueParams {
|
|
17
|
+
targetUrl: string;
|
|
18
|
+
payload?: string;
|
|
19
|
+
taskId?: string;
|
|
20
|
+
}
|
|
16
21
|
/** Relative time offset parameters used by {@link taskScheduleTimestamp}. */
|
|
17
22
|
export interface FirebaseTaskDurationParams {
|
|
18
23
|
days?: number;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.tasks.d.ts","sourceRoot":"","sources":["../../src/types/types.tasks.ts"],"names":[],"mappings":"AAAA,yEAAyE;AACzE,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,qDAAqD;IACrD,MAAM,EAAE,MAAM,CAAC;IACf,6DAA6D;IAC7D,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,4DAA4D;AAC5D,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,6EAA6E;AAC7E,MAAM,WAAW,0BAA0B;IACzC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAMD,6EAA6E;AAC7E,MAAM,WAAW,qBAAsB,SAAQ,sBAAsB;IACnE,MAAM,EAAE,MAAM,CAAC;CAChB;AACD,8EAA8E;AAC9E,MAAM,WAAW,sBAAsB;IACrC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,SAAS,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IACzC,gBAAgB;IAChB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,wBAAwB;IACxB,YAAY,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAC5C,sBAAsB;IACtB,UAAU,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAC1C,4BAA4B;IAC5B,gBAAgB,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAC/C,yBAAyB;IACzB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,yBAAyB;IACzB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,wBAAwB;IACxB,YAAY,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAC1C,uBAAuB;IACvB,WAAW,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAC;CAC1C;AAED,mDAAmD;AACnD,MAAM,WAAW,mBAAmB;IAClC,YAAY,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAC5C,YAAY,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAC5C,YAAY,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAC5C,cAAc,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;CAC5C;AAED,+EAA+E;AAC/E,MAAM,WAAW,qBAAqB;IACpC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC;IACxC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,gFAAgF;AAChF,MAAM,MAAM,oBAAoB,GAAG,qBAAqB,CAAC;AAEzD,kEAAkE;AAClE,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB"}
|
|
1
|
+
{"version":3,"file":"types.tasks.d.ts","sourceRoot":"","sources":["../../src/types/types.tasks.ts"],"names":[],"mappings":"AAAA,yEAAyE;AACzE,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,qDAAqD;IACrD,MAAM,EAAE,MAAM,CAAC;IACf,6DAA6D;IAC7D,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,4DAA4D;AAC5D,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,6EAA6E;AAC7E,MAAM,WAAW,0BAA0B;IACzC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAMD,6EAA6E;AAC7E,MAAM,WAAW,qBAAsB,SAAQ,sBAAsB;IACnE,MAAM,EAAE,MAAM,CAAC;CAChB;AACD,8EAA8E;AAC9E,MAAM,WAAW,sBAAsB;IACrC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,SAAS,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IACzC,gBAAgB;IAChB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,wBAAwB;IACxB,YAAY,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAC5C,sBAAsB;IACtB,UAAU,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAC1C,4BAA4B;IAC5B,gBAAgB,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAC/C,yBAAyB;IACzB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,yBAAyB;IACzB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,wBAAwB;IACxB,YAAY,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAC1C,uBAAuB;IACvB,WAAW,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAC;CAC1C;AAED,mDAAmD;AACnD,MAAM,WAAW,mBAAmB;IAClC,YAAY,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAC5C,YAAY,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAC5C,YAAY,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAC5C,cAAc,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;CAC5C;AAED,+EAA+E;AAC/E,MAAM,WAAW,qBAAqB;IACpC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC;IACxC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,gFAAgF;AAChF,MAAM,MAAM,oBAAoB,GAAG,qBAAqB,CAAC;AAEzD,kEAAkE;AAClE,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mxpicture/gcp-functions-backend",
|
|
3
|
-
"version": "1.2
|
|
3
|
+
"version": "1.3.2",
|
|
4
4
|
"description": "Utils for google cloud functions, publishing both CommonJS and ESM builds",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"author": "MXPicture",
|
|
@@ -54,7 +54,7 @@
|
|
|
54
54
|
},
|
|
55
55
|
"dependencies": {
|
|
56
56
|
"@google-cloud/tasks": "^6.2.1",
|
|
57
|
-
"@mxpicture/gcp-functions-common": "^1.2
|
|
57
|
+
"@mxpicture/gcp-functions-common": "^1.3.2",
|
|
58
58
|
"express": "^5.2.1",
|
|
59
59
|
"firebase-admin": "^13.7.0",
|
|
60
60
|
"firebase-functions": "^7.0.6",
|