@mxpicture/gcp-functions-backend 1.3.58 → 1.3.60
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 -3
- package/dist/firebase/FirebaseTaskHandler.d.ts.map +1 -1
- package/dist/firebase/FirebaseTaskHandler.js +14 -11
- package/dist/firebase/FirebaseTaskHandler.js.map +1 -1
- package/dist/types/types.tasks.d.ts +3 -1
- package/dist/types/types.tasks.d.ts.map +1 -1
- package/dist/validation/Validation.d.ts +19 -5
- package/dist/validation/Validation.d.ts.map +1 -1
- package/dist/validation/Validation.js +34 -16
- package/dist/validation/Validation.js.map +1 -1
- package/package.json +2 -2
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { CloudTasksClient } from "@google-cloud/tasks";
|
|
2
|
-
import type { FirebaseTask, FirebaseTaskParams, FirebaseTaskScheduleResult
|
|
2
|
+
import type { FirebaseTask, FirebaseTaskParams, FirebaseTaskScheduleResult } from "../types/types.tasks.js";
|
|
3
3
|
import type { FirebaseEnv } from "../types/types.env.js";
|
|
4
4
|
/**
|
|
5
5
|
* Client wrapper around Google Cloud Tasks for scheduling, retrieving, and managing HTTP-targeted tasks.
|
|
@@ -24,7 +24,7 @@ export declare class FirebaseTaskHandler {
|
|
|
24
24
|
* @param scheduleTime - The new schedule timestamp.
|
|
25
25
|
* @returns The created task's resource name.
|
|
26
26
|
*/
|
|
27
|
-
reschedule(p: FirebaseTaskParams
|
|
27
|
+
reschedule(p: FirebaseTaskParams): Promise<FirebaseTaskScheduleResult>;
|
|
28
28
|
/**
|
|
29
29
|
* Create a new Cloud Task scheduled for the given time.
|
|
30
30
|
*
|
|
@@ -32,7 +32,7 @@ export declare class FirebaseTaskHandler {
|
|
|
32
32
|
* @param scheduleTime - When the task should be dispatched.
|
|
33
33
|
* @returns The created task's resource name.
|
|
34
34
|
*/
|
|
35
|
-
schedule(p: FirebaseTaskParams
|
|
35
|
+
schedule(p: FirebaseTaskParams): Promise<FirebaseTaskScheduleResult>;
|
|
36
36
|
/**
|
|
37
37
|
* List all tasks in a queue.
|
|
38
38
|
*
|
|
@@ -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,YAAY,EACZ,kBAAkB,EAClB,0BAA0B,
|
|
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,YAAY,EACZ,kBAAkB,EAClB,0BAA0B,EAC3B,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAGzD;;;;;;GAMG;AACH,qBAAa,mBAAmB;IAQX,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,WAAW;IAPtD,SAAS,CAAC,WAAW,EAAE,gBAAgB,CAAC;IAExC;;;;OAIG;gBACmC,GAAG,EAAE,WAAW;IAItD;;;;;;OAMG;IACU,UAAU,CACrB,CAAC,EAAE,kBAAkB,GACpB,OAAO,CAAC,0BAA0B,CAAC;IAiBtC;;;;;;OAMG;IACU,QAAQ,CACnB,CAAC,EAAE,kBAAkB,GACpB,OAAO,CAAC,0BAA0B,CAAC;IAiCtC;;;;;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,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAKvE;;;;;;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,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAQzC,SAAS,CAAC,mBAAmB,CAAC,IAAI,EAAE,YAAY,GAAG,YAAY;CAOhE"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { CloudTasksClient } from "@google-cloud/tasks";
|
|
2
2
|
import { fromTaskName } from "./firebase.tasks.js";
|
|
3
|
+
import * as uuid from "short-uuid";
|
|
3
4
|
/**
|
|
4
5
|
* Client wrapper around Google Cloud Tasks for scheduling, retrieving, and managing HTTP-targeted tasks.
|
|
5
6
|
*
|
|
@@ -26,16 +27,21 @@ export class FirebaseTaskHandler {
|
|
|
26
27
|
* @param scheduleTime - The new schedule timestamp.
|
|
27
28
|
* @returns The created task's resource name.
|
|
28
29
|
*/
|
|
29
|
-
async reschedule(p
|
|
30
|
+
async reschedule(p) {
|
|
30
31
|
try {
|
|
31
|
-
|
|
32
|
+
if (p.taskId)
|
|
33
|
+
await this.tasksClient.deleteTask({
|
|
34
|
+
name: this.taskPath(p.queueId, p.taskId),
|
|
35
|
+
});
|
|
32
36
|
}
|
|
33
37
|
catch { }
|
|
34
38
|
return await this.schedule({
|
|
35
|
-
|
|
39
|
+
queueId: p.queueId,
|
|
40
|
+
taskId: p.taskId,
|
|
36
41
|
targetUrl: p.targetUrl,
|
|
37
42
|
payload: p.targetUrl,
|
|
38
|
-
|
|
43
|
+
scheduleTime: p.scheduleTime,
|
|
44
|
+
});
|
|
39
45
|
}
|
|
40
46
|
/**
|
|
41
47
|
* Create a new Cloud Task scheduled for the given time.
|
|
@@ -44,12 +50,9 @@ export class FirebaseTaskHandler {
|
|
|
44
50
|
* @param scheduleTime - When the task should be dispatched.
|
|
45
51
|
* @returns The created task's resource name.
|
|
46
52
|
*/
|
|
47
|
-
async schedule(p
|
|
48
|
-
const
|
|
49
|
-
|
|
50
|
-
throw new Error(`Task name invalid. ${p.name}`);
|
|
51
|
-
const queuePath = this.queuePath(parts.queueId);
|
|
52
|
-
const taskPath = this.taskPath(parts.queueId, parts.taskId);
|
|
53
|
+
async schedule(p) {
|
|
54
|
+
const queuePath = this.queuePath(p.queueId);
|
|
55
|
+
const taskPath = this.taskPath(p.queueId, p.taskId ?? uuid.generate());
|
|
53
56
|
const headers = {};
|
|
54
57
|
let body = null;
|
|
55
58
|
if (p.payload) {
|
|
@@ -59,7 +62,7 @@ export class FirebaseTaskHandler {
|
|
|
59
62
|
const [task] = await this.tasksClient.createTask({
|
|
60
63
|
parent: queuePath,
|
|
61
64
|
task: {
|
|
62
|
-
scheduleTime,
|
|
65
|
+
scheduleTime: p.scheduleTime,
|
|
63
66
|
name: taskPath,
|
|
64
67
|
httpRequest: {
|
|
65
68
|
httpMethod: "POST",
|
|
@@ -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;AAMvD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC;;;;;;GAMG;AACH,MAAM,OAAO,mBAAmB;IAQQ;IAP5B,WAAW,CAAmB;IAExC;;;;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,UAAU,CACrB,CAAqB;QAErB,IAAI,CAAC;YACH,IAAI,CAAC,CAAC,MAAM;gBACV,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC;oBAChC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC;iBACzC,CAAC,CAAC;QACP,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;QAEV,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC;YACzB,OAAO,EAAE,CAAC,CAAC,OAAO;YAClB,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,CAAqB;QAErB,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAC5C,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEvE,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;;;;;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,UAAU,CAAC,OAAe,EAAE,MAAc;QACrD,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC5C,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;IAC9C,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,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;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"}
|
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
/** Parameters for creating or rescheduling a Cloud Task. */
|
|
2
2
|
export interface FirebaseTaskParams {
|
|
3
|
-
|
|
3
|
+
queueId: string;
|
|
4
|
+
taskId?: string;
|
|
4
5
|
targetUrl: string;
|
|
5
6
|
payload?: string;
|
|
7
|
+
scheduleTime: FirebaseTaskTimestamp;
|
|
6
8
|
}
|
|
7
9
|
/** Result of scheduling a task with optional callback metadata. */
|
|
8
10
|
export interface FirebaseTaskScheduleResult {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.tasks.d.ts","sourceRoot":"","sources":["../../src/types/types.tasks.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,MAAM,WAAW,kBAAkB;IACjC,
|
|
1
|
+
{"version":3,"file":"types.tasks.d.ts","sourceRoot":"","sources":["../../src/types/types.tasks.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,qBAAqB,CAAC;CACrC;AAED,mEAAmE;AACnE,MAAM,WAAW,0BAA0B;IACzC,iFAAiF;IACjF,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;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,kBAAmB,SAAQ,mBAAmB;IAC7D,MAAM,EAAE,MAAM,CAAC;CAChB;AACD,8EAA8E;AAC9E,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB;IACzD,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,SAAS,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACpC,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"}
|
|
@@ -15,7 +15,7 @@ export declare class Validation<DTO extends DocumentData> {
|
|
|
15
15
|
protected _createSchema?: ZodObject;
|
|
16
16
|
protected _updateSchema?: ZodObject;
|
|
17
17
|
protected _updateSchemaWithId?: ZodObject;
|
|
18
|
-
protected
|
|
18
|
+
protected _rawSchema?: ZodObject;
|
|
19
19
|
protected _shape?: ZodRawShape;
|
|
20
20
|
/**
|
|
21
21
|
* Create a new Validation instance.
|
|
@@ -47,7 +47,7 @@ export declare class Validation<DTO extends DocumentData> {
|
|
|
47
47
|
*
|
|
48
48
|
* @returns The Zod object schema for create operations.
|
|
49
49
|
*/
|
|
50
|
-
protected
|
|
50
|
+
protected getCreateSchema(): ZodObject;
|
|
51
51
|
/**
|
|
52
52
|
* Get or lazily build the Zod schema used for update validation.
|
|
53
53
|
*
|
|
@@ -57,14 +57,14 @@ export declare class Validation<DTO extends DocumentData> {
|
|
|
57
57
|
*
|
|
58
58
|
* @returns The Zod object schema for update operations.
|
|
59
59
|
*/
|
|
60
|
-
protected
|
|
60
|
+
protected getUpdateSchema(): ZodObject;
|
|
61
61
|
/**
|
|
62
62
|
* Get or lazily build the Zod schema used for update validation including `id`.
|
|
63
63
|
*
|
|
64
64
|
* @returns The Zod object schema for update operations with required `id`.
|
|
65
65
|
*/
|
|
66
|
-
protected
|
|
67
|
-
protected
|
|
66
|
+
protected getUpdateSchemaWithId(): ZodObject;
|
|
67
|
+
protected getRawSchema(): ZodObject;
|
|
68
68
|
/**
|
|
69
69
|
* Validate a complete document for creation.
|
|
70
70
|
*
|
|
@@ -81,6 +81,20 @@ export declare class Validation<DTO extends DocumentData> {
|
|
|
81
81
|
* @throws {@link HttpsError} with `invalid-argument` if validation fails.
|
|
82
82
|
*/
|
|
83
83
|
validateUpdate(doc: UpdateInput<DTO>): UpdateInput<DTO>;
|
|
84
|
+
/**
|
|
85
|
+
* Validate a document in raw format.
|
|
86
|
+
*
|
|
87
|
+
* @param doc - The partial document data to validate.
|
|
88
|
+
* @returns The parsed and validated partial document data.
|
|
89
|
+
*/
|
|
90
|
+
validateRaw(doc: DTO): {
|
|
91
|
+
data?: DTO | undefined;
|
|
92
|
+
error?: ValidationResult;
|
|
93
|
+
};
|
|
94
|
+
protected _validate<T extends DocumentData>(doc: T, schema: ZodObject): {
|
|
95
|
+
data?: T;
|
|
96
|
+
error?: ValidationResult;
|
|
97
|
+
};
|
|
84
98
|
/**
|
|
85
99
|
* Convert Zod validation issues into a structured validation result.
|
|
86
100
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Validation.d.ts","sourceRoot":"","sources":["../../src/validation/Validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAK,KAAK,QAAQ,EAAE,KAAK,SAAS,EAAE,KAAK,WAAW,EAAE,MAAM,KAAK,CAAC;AAEzE,OAAO,KAAK,EACV,WAAW,EACX,YAAY,EACZ,WAAW,EACX,gBAAgB,EACjB,MAAM,uCAAuC,CAAC;AAG/C;;;;;;;;;GASG;AACH,qBAAa,UAAU,CAAC,GAAG,SAAS,YAAY;aAYX,IAAI,EAAE,MAAM;IAX/C,SAAS,CAAC,aAAa,CAAC,EAAE,SAAS,CAAC;IACpC,SAAS,CAAC,aAAa,CAAC,EAAE,SAAS,CAAC;IACpC,SAAS,CAAC,mBAAmB,CAAC,EAAE,SAAS,CAAC;IAC1C,SAAS,CAAC,UAAU,CAAC,EAAE,SAAS,CAAC;IACjC,SAAS,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;IAE/B;;;;OAIG;gBACgC,IAAI,EAAE,MAAM;IAE/C;;;;OAIG;IACI,QAAQ,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;IAIzC;;;;;OAKG;IACH,SAAS,CAAC,KAAK,IAAI,WAAW;IAQ9B;;;;OAIG;IACH,SAAS,CAAC,YAAY,IAAI,WAAW;IAOrC;;;;OAIG;IACH,SAAS,CAAC,
|
|
1
|
+
{"version":3,"file":"Validation.d.ts","sourceRoot":"","sources":["../../src/validation/Validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAK,KAAK,QAAQ,EAAE,KAAK,SAAS,EAAE,KAAK,WAAW,EAAE,MAAM,KAAK,CAAC;AAEzE,OAAO,KAAK,EACV,WAAW,EACX,YAAY,EACZ,WAAW,EACX,gBAAgB,EACjB,MAAM,uCAAuC,CAAC;AAG/C;;;;;;;;;GASG;AACH,qBAAa,UAAU,CAAC,GAAG,SAAS,YAAY;aAYX,IAAI,EAAE,MAAM;IAX/C,SAAS,CAAC,aAAa,CAAC,EAAE,SAAS,CAAC;IACpC,SAAS,CAAC,aAAa,CAAC,EAAE,SAAS,CAAC;IACpC,SAAS,CAAC,mBAAmB,CAAC,EAAE,SAAS,CAAC;IAC1C,SAAS,CAAC,UAAU,CAAC,EAAE,SAAS,CAAC;IACjC,SAAS,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;IAE/B;;;;OAIG;gBACgC,IAAI,EAAE,MAAM;IAE/C;;;;OAIG;IACI,QAAQ,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;IAIzC;;;;;OAKG;IACH,SAAS,CAAC,KAAK,IAAI,WAAW;IAQ9B;;;;OAIG;IACH,SAAS,CAAC,YAAY,IAAI,WAAW;IAOrC;;;;OAIG;IACH,SAAS,CAAC,eAAe,IAAI,SAAS;IAKtC;;;;;;;;OAQG;IACH,SAAS,CAAC,eAAe,IAAI,SAAS;IAMtC;;;;OAIG;IACH,SAAS,CAAC,qBAAqB,IAAI,SAAS;IAQ5C,SAAS,CAAC,YAAY,IAAI,SAAS;IAKnC;;;;;;OAMG;IACI,cAAc,CAAC,GAAG,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC;IAa9D;;;;;;OAMG;IACI,cAAc,CAAC,GAAG,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC;IAa9D;;;;;OAKG;IACI,WAAW,CAAC,GAAG,EAAE,GAAG;;gBAOJ,gBAAgB;;IAHvC,SAAS,CAAC,SAAS,CAAC,CAAC,SAAS,YAAY,EACxC,GAAG,EAAE,CAAC,EACN,MAAM,EAAE,SAAS,GAChB;QAAE,IAAI,CAAC,EAAE,CAAC,CAAC;QAAC,KAAK,CAAC,EAAE,gBAAgB,CAAA;KAAE;IAUzC;;;;;OAKG;IACH,SAAS,CAAC,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,GAAG,gBAAgB;CAUvE"}
|
|
@@ -16,7 +16,7 @@ export class Validation {
|
|
|
16
16
|
_createSchema;
|
|
17
17
|
_updateSchema;
|
|
18
18
|
_updateSchemaWithId;
|
|
19
|
-
|
|
19
|
+
_rawSchema;
|
|
20
20
|
_shape;
|
|
21
21
|
/**
|
|
22
22
|
* Create a new Validation instance.
|
|
@@ -62,7 +62,7 @@ export class Validation {
|
|
|
62
62
|
*
|
|
63
63
|
* @returns The Zod object schema for create operations.
|
|
64
64
|
*/
|
|
65
|
-
|
|
65
|
+
getCreateSchema() {
|
|
66
66
|
if (!this._createSchema)
|
|
67
67
|
this._createSchema = z.object(this.shape4Create());
|
|
68
68
|
return this._createSchema;
|
|
@@ -76,9 +76,9 @@ export class Validation {
|
|
|
76
76
|
*
|
|
77
77
|
* @returns The Zod object schema for update operations.
|
|
78
78
|
*/
|
|
79
|
-
|
|
79
|
+
getUpdateSchema() {
|
|
80
80
|
if (!this._updateSchema)
|
|
81
|
-
this._updateSchema = this.
|
|
81
|
+
this._updateSchema = this.getCreateSchema().partial();
|
|
82
82
|
return this._updateSchema;
|
|
83
83
|
}
|
|
84
84
|
/**
|
|
@@ -86,15 +86,17 @@ export class Validation {
|
|
|
86
86
|
*
|
|
87
87
|
* @returns The Zod object schema for update operations with required `id`.
|
|
88
88
|
*/
|
|
89
|
-
|
|
89
|
+
getUpdateSchemaWithId() {
|
|
90
90
|
if (!this._updateSchemaWithId)
|
|
91
|
-
this._updateSchemaWithId = this.
|
|
91
|
+
this._updateSchemaWithId = this.getUpdateSchema().extend({
|
|
92
|
+
id: z.string(),
|
|
93
|
+
});
|
|
92
94
|
return this._updateSchemaWithId;
|
|
93
95
|
}
|
|
94
|
-
|
|
95
|
-
if (!this.
|
|
96
|
-
this.
|
|
97
|
-
return this.
|
|
96
|
+
getRawSchema() {
|
|
97
|
+
if (!this._rawSchema)
|
|
98
|
+
this._rawSchema = z.object(this.shape());
|
|
99
|
+
return this._rawSchema;
|
|
98
100
|
}
|
|
99
101
|
/**
|
|
100
102
|
* Validate a complete document for creation.
|
|
@@ -104,9 +106,9 @@ export class Validation {
|
|
|
104
106
|
* @throws {@link HttpsError} with `invalid-argument` if validation fails.
|
|
105
107
|
*/
|
|
106
108
|
validateCreate(doc) {
|
|
107
|
-
const result = this.
|
|
108
|
-
if (!result.
|
|
109
|
-
throw new HttpsError("invalid-argument", "Invalid request data",
|
|
109
|
+
const result = this._validate(doc, this.getCreateSchema());
|
|
110
|
+
if (result.error || !result.data)
|
|
111
|
+
throw new HttpsError("invalid-argument", "Invalid request data", result.error);
|
|
110
112
|
return result.data;
|
|
111
113
|
}
|
|
112
114
|
/**
|
|
@@ -117,11 +119,27 @@ export class Validation {
|
|
|
117
119
|
* @throws {@link HttpsError} with `invalid-argument` if validation fails.
|
|
118
120
|
*/
|
|
119
121
|
validateUpdate(doc) {
|
|
120
|
-
const result = this.
|
|
121
|
-
if (!result.
|
|
122
|
-
throw new HttpsError("invalid-argument", "Invalid request data",
|
|
122
|
+
const result = this._validate(doc, this.getUpdateSchemaWithId());
|
|
123
|
+
if (result.error || !result.data)
|
|
124
|
+
throw new HttpsError("invalid-argument", "Invalid request data", result.error);
|
|
123
125
|
return result.data;
|
|
124
126
|
}
|
|
127
|
+
/**
|
|
128
|
+
* Validate a document in raw format.
|
|
129
|
+
*
|
|
130
|
+
* @param doc - The partial document data to validate.
|
|
131
|
+
* @returns The parsed and validated partial document data.
|
|
132
|
+
*/
|
|
133
|
+
validateRaw(doc) {
|
|
134
|
+
return this._validate(doc, this.getRawSchema());
|
|
135
|
+
}
|
|
136
|
+
_validate(doc, schema) {
|
|
137
|
+
const result = schema.safeParse(doc);
|
|
138
|
+
const error = !result.success
|
|
139
|
+
? this.issuesToResult(result.error.issues)
|
|
140
|
+
: { errorFields: {} };
|
|
141
|
+
return { data: result.data, error };
|
|
142
|
+
}
|
|
125
143
|
/**
|
|
126
144
|
* Convert Zod validation issues into a structured validation result.
|
|
127
145
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Validation.js","sourceRoot":"","sources":["../../src/validation/Validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAmD,MAAM,KAAK,CAAC;AACzE,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAOtD,OAAO,EAAE,uBAAuB,EAAE,MAAM,wCAAwC,CAAC;AAEjF;;;;;;;;;GASG;AACH,MAAM,OAAO,UAAU;IAYc;IAXzB,aAAa,CAAa;IAC1B,aAAa,CAAa;IAC1B,mBAAmB,CAAa;IAChC,UAAU,CAAa;IACvB,MAAM,CAAe;IAE/B;;;;OAIG;IACH,YAAmC,IAAY;QAAZ,SAAI,GAAJ,IAAI,CAAQ;IAAG,CAAC;IAEnD;;;;OAIG;IACI,QAAQ,CAAC,KAAkB;QAChC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACO,KAAK;QACb,IAAI,CAAC,IAAI,CAAC,MAAM;YACd,MAAM,IAAI,KAAK,CACb,GAAG,IAAI,CAAC,IAAI,6CAA6C,CAC1D,CAAC;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACO,YAAY;QACpB,MAAM,KAAK,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;QAClC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;YAClC,IAAI,uBAAuB,CAAC,QAAQ,CAAC,GAAG,CAAC;gBAAE,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/D,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACO,
|
|
1
|
+
{"version":3,"file":"Validation.js","sourceRoot":"","sources":["../../src/validation/Validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAmD,MAAM,KAAK,CAAC;AACzE,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAOtD,OAAO,EAAE,uBAAuB,EAAE,MAAM,wCAAwC,CAAC;AAEjF;;;;;;;;;GASG;AACH,MAAM,OAAO,UAAU;IAYc;IAXzB,aAAa,CAAa;IAC1B,aAAa,CAAa;IAC1B,mBAAmB,CAAa;IAChC,UAAU,CAAa;IACvB,MAAM,CAAe;IAE/B;;;;OAIG;IACH,YAAmC,IAAY;QAAZ,SAAI,GAAJ,IAAI,CAAQ;IAAG,CAAC;IAEnD;;;;OAIG;IACI,QAAQ,CAAC,KAAkB;QAChC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACO,KAAK;QACb,IAAI,CAAC,IAAI,CAAC,MAAM;YACd,MAAM,IAAI,KAAK,CACb,GAAG,IAAI,CAAC,IAAI,6CAA6C,CAC1D,CAAC;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACO,YAAY;QACpB,MAAM,KAAK,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;QAClC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;YAClC,IAAI,uBAAuB,CAAC,QAAQ,CAAC,GAAG,CAAC;gBAAE,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/D,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACO,eAAe;QACvB,IAAI,CAAC,IAAI,CAAC,aAAa;YAAE,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;QAC5E,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED;;;;;;;;OAQG;IACO,eAAe;QACvB,IAAI,CAAC,IAAI,CAAC,aAAa;YACrB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC,OAAO,EAAE,CAAC;QACxD,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACO,qBAAqB;QAC7B,IAAI,CAAC,IAAI,CAAC,mBAAmB;YAC3B,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC,MAAM,CAAC;gBACvD,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;aACf,CAAC,CAAC;QACL,OAAO,IAAI,CAAC,mBAAmB,CAAC;IAClC,CAAC;IAES,YAAY;QACpB,IAAI,CAAC,IAAI,CAAC,UAAU;YAAE,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;QAC/D,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;;;;OAMG;IACI,cAAc,CAAC,GAAqB;QACzC,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC;QAE3D,IAAI,MAAM,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,IAAI;YAC9B,MAAM,IAAI,UAAU,CAClB,kBAAkB,EAClB,sBAAsB,EACtB,MAAM,CAAC,KAAK,CACb,CAAC;QAEJ,OAAO,MAAM,CAAC,IAAwB,CAAC;IACzC,CAAC;IAED;;;;;;OAMG;IACI,cAAc,CAAC,GAAqB;QACzC,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAC;QAEjE,IAAI,MAAM,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,IAAI;YAC9B,MAAM,IAAI,UAAU,CAClB,kBAAkB,EAClB,sBAAsB,EACtB,MAAM,CAAC,KAAK,CACb,CAAC;QAEJ,OAAO,MAAM,CAAC,IAAwB,CAAC;IACzC,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAAC,GAAQ;QACzB,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;IAClD,CAAC;IAES,SAAS,CACjB,GAAM,EACN,MAAiB;QAEjB,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAErC,MAAM,KAAK,GAAqB,CAAC,MAAM,CAAC,OAAO;YAC7C,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC;YAC1C,CAAC,CAAC,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC;QAExB,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,IAAqB,EAAE,KAAK,EAAE,CAAC;IACvD,CAAC;IAED;;;;;OAKG;IACO,cAAc,CAAC,MAA0B;QACjD,MAAM,MAAM,GAAqB,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC;QAErD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;YAChE,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACxD,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mxpicture/gcp-functions-backend",
|
|
3
|
-
"version": "1.3.
|
|
3
|
+
"version": "1.3.60",
|
|
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.3.
|
|
57
|
+
"@mxpicture/gcp-functions-common": "^1.3.60",
|
|
58
58
|
"express": "^5.2.1",
|
|
59
59
|
"firebase-admin": "^13.7.0",
|
|
60
60
|
"firebase-functions": "^7.0.6",
|