@forge/events 2.0.19-next.1 → 2.1.0-next.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/CHANGELOG.md +6 -0
- package/out/queue.d.ts +6 -4
- package/out/queue.d.ts.map +1 -1
- package/out/queue.js +8 -0
- package/out/types.d.ts +7 -7
- package/out/types.d.ts.map +1 -1
- package/out/validators.d.ts +3 -3
- package/out/validators.d.ts.map +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
package/out/queue.d.ts
CHANGED
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
import { FetchMethod } from '@forge/api';
|
|
2
|
-
import { QueueParams, PushEvent, PushResult } from './types';
|
|
3
|
-
import { JobProgress } from './jobProgress';
|
|
4
|
-
export declare class Queue {
|
|
2
|
+
import { QueueParams, PushEvent, PushResult, Body } from './types';
|
|
3
|
+
import { JobProgress, JobStats } from './jobProgress';
|
|
4
|
+
export declare class Queue<T extends Body = Body> {
|
|
5
5
|
private readonly queueParams;
|
|
6
6
|
private readonly apiClient;
|
|
7
7
|
constructor(queueParams: QueueParams, apiClient?: FetchMethod);
|
|
8
|
-
push(events: PushEvent | PushEvent[]): Promise<PushResult>;
|
|
8
|
+
push(events: PushEvent<T> | PushEvent<T>[]): Promise<PushResult>;
|
|
9
9
|
getJob(jobId: string): JobProgress;
|
|
10
|
+
cancel(jobId: string): Promise<void>;
|
|
11
|
+
getStats(jobId: string): Promise<JobStats>;
|
|
10
12
|
}
|
|
11
13
|
//# sourceMappingURL=queue.d.ts.map
|
package/out/queue.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"queue.d.ts","sourceRoot":"","sources":["../src/queue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAA2B,MAAM,YAAY,CAAC;AAGlE,OAAO,EAAE,WAAW,EAAE,SAAS,EAAe,UAAU,EAAE,MAAM,SAAS,CAAC;
|
|
1
|
+
{"version":3,"file":"queue.d.ts","sourceRoot":"","sources":["../src/queue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAA2B,MAAM,YAAY,CAAC;AAGlE,OAAO,EAAE,WAAW,EAAE,SAAS,EAAe,UAAU,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAEhF,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEtD,qBAAa,KAAK,CAAC,CAAC,SAAS,IAAI,GAAG,IAAI;IAEpC,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,SAAS;gBADT,WAAW,EAAE,WAAW,EACxB,SAAS,GAAE,WAAqC;IAK7D,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC;IAoBtE,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAI5B,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAKpC,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;CAIjD"}
|
package/out/queue.js
CHANGED
|
@@ -34,5 +34,13 @@ class Queue {
|
|
|
34
34
|
getJob(jobId) {
|
|
35
35
|
return new jobProgress_1.JobProgress(this.queueParams, jobId, this.apiClient);
|
|
36
36
|
}
|
|
37
|
+
async cancel(jobId) {
|
|
38
|
+
const job = this.getJob(jobId);
|
|
39
|
+
await job.cancel();
|
|
40
|
+
}
|
|
41
|
+
async getStats(jobId) {
|
|
42
|
+
const job = this.getJob(jobId);
|
|
43
|
+
return job.getStats();
|
|
44
|
+
}
|
|
37
45
|
}
|
|
38
46
|
exports.Queue = Queue;
|
package/out/types.d.ts
CHANGED
|
@@ -2,8 +2,8 @@ export declare type Payload = Record<string, unknown>;
|
|
|
2
2
|
export interface QueueParams {
|
|
3
3
|
key: string;
|
|
4
4
|
}
|
|
5
|
-
export interface PushRequest extends APIRequest {
|
|
6
|
-
payload: PushEvent[];
|
|
5
|
+
export interface PushRequest<T extends Body = Body> extends APIRequest {
|
|
6
|
+
payload: PushEvent<T>[];
|
|
7
7
|
schema: string;
|
|
8
8
|
type: string;
|
|
9
9
|
jobId: string;
|
|
@@ -13,8 +13,8 @@ export interface APIRequest {
|
|
|
13
13
|
jobId: string;
|
|
14
14
|
time: string;
|
|
15
15
|
}
|
|
16
|
-
export interface PushEvent {
|
|
17
|
-
body:
|
|
16
|
+
export interface PushEvent<T extends Body = Body> {
|
|
17
|
+
body: T;
|
|
18
18
|
delayInSeconds?: number;
|
|
19
19
|
concurrency?: Concurrency;
|
|
20
20
|
}
|
|
@@ -26,11 +26,11 @@ export interface Concurrency {
|
|
|
26
26
|
export interface PushResult {
|
|
27
27
|
jobId: string;
|
|
28
28
|
}
|
|
29
|
-
export interface FailedEvent {
|
|
29
|
+
export interface FailedEvent<T extends Body = Body> {
|
|
30
30
|
errorMessage: string;
|
|
31
|
-
event: PushEvent
|
|
31
|
+
event: PushEvent<T>;
|
|
32
32
|
}
|
|
33
|
-
export interface AsyncEvent extends PushEvent {
|
|
33
|
+
export interface AsyncEvent<T extends Body = Body> extends PushEvent<T> {
|
|
34
34
|
queueName: string;
|
|
35
35
|
jobId: string;
|
|
36
36
|
eventId: string;
|
package/out/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,oBAAY,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE9C,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,oBAAY,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE9C,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,WAAW,CAAC,CAAC,SAAS,IAAI,GAAG,IAAI,CAAE,SAAQ,UAAU;IACpE,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,UAAU;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,SAAS,CAAC,CAAC,SAAS,IAAI,GAAG,IAAI;IAC9C,IAAI,EAAE,CAAC,CAAC;IACR,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED,oBAAY,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE3C,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,WAAW,CAAC,CAAC,SAAS,IAAI,GAAG,IAAI;IAChD,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;CACrB;AAED,MAAM,WAAW,UAAU,CAAC,CAAC,SAAS,IAAI,GAAG,IAAI,CAAE,SAAQ,SAAS,CAAC,CAAC,CAAC;IACrE,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B;AAED,MAAM,WAAW,YAAY;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,GAAG,CAAC;IACf,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC;AAED,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,oBAAY,eAAe,GAAG,UAAU,CAAC;AACzC,oBAAY,gBAAgB,GAAG,UAAU,CAAC"}
|
package/out/validators.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { APIResponse } from '@forge/api';
|
|
2
|
-
import { CancelJobRequest, GetStatsRequest, PushEvent, PushRequest, PushResult } from './types';
|
|
2
|
+
import { CancelJobRequest, GetStatsRequest, PushEvent, PushRequest, PushResult, Body } from './types';
|
|
3
3
|
export declare const validateQueueKey: (queueName: string) => void;
|
|
4
|
-
export declare const validatePushSettings: (event: PushEvent) => void;
|
|
5
|
-
export declare function validatePushEvents(arg: PushEvent | PushEvent[]): PushEvent[];
|
|
4
|
+
export declare const validatePushSettings: (event: PushEvent<Body>) => void;
|
|
5
|
+
export declare function validatePushEvents<T extends Body = Body>(arg: PushEvent<T> | PushEvent<T>[]): PushEvent<T>[];
|
|
6
6
|
export declare const validateGetStatsPayload: (getStatsRequest: GetStatsRequest) => void;
|
|
7
7
|
export declare const validateCancelJobRequest: (cancelJobRequest: CancelJobRequest) => void;
|
|
8
8
|
export declare const validateAPIResponse: (response: APIResponse, expectedSuccessStatus: number) => Promise<void>;
|
package/out/validators.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"validators.d.ts","sourceRoot":"","sources":["../src/validators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAezC,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,SAAS,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;
|
|
1
|
+
{"version":3,"file":"validators.d.ts","sourceRoot":"","sources":["../src/validators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAezC,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,SAAS,EAAE,WAAW,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAMtG,eAAO,MAAM,gBAAgB,cAAe,MAAM,SAIjD,CAAC;AAEF,eAAO,MAAM,oBAAoB,UAAW,UAAU,IAAI,CAAC,SAI1D,CAAC;AAEF,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,IAAI,GAAG,IAAI,EAAE,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC,EAAE,CA6B5G;AAED,eAAO,MAAM,uBAAuB,oBAAqB,eAAe,SAKvE,CAAC;AAEF,eAAO,MAAM,wBAAwB,qBAAsB,gBAAgB,SAK1E,CAAC;AAEF,eAAO,MAAM,mBAAmB,aAAoB,WAAW,yBAAyB,MAAM,kBA6B7F,CAAC;AAEF,eAAO,MAAM,uBAAuB,gBAAuB,WAAW,YAAY,WAAW,UAAU,UAAU,kBAkChH,CAAC;AAEF,eAAO,MAAM,2BAA2B,aAAoB,WAAW,mBAAmB,eAAe,kBAMxG,CAAC;AAEF,eAAO,MAAM,4BAA4B,aAAoB,WAAW,oBAAoB,eAAe,kBAM1G,CAAC"}
|