@forge/events 0.0.0-experimental-d18f8dd → 0.0.0-experimental-64caa5a

package/CHANGELOG.md

@@ -1,12 +1,78 @@
 # @forge/events
 
-## 0.0.0-experimental-d18f8dd
+## 0.0.0-experimental-64caa5a
 
 ### Patch Changes
 
-- d18f8dd: Force bump
-- Updated dependencies [d18f8dd]
-  - @forge/api@0.0.0-experimental-d18f8dd
+- Updated dependencies [8571c05]
+  - @forge/api@0.0.0-experimental-64caa5a
+
+## 0.5.2-next.0
+
+### Patch Changes
+
+- Updated dependencies [8571c05]
+  - @forge/api@2.6.0-next.0
+
+## 0.5.1
+
+### Patch Changes
+
+- Updated dependencies [70e9c8c]
+- Updated dependencies [32d11d1]
+  - @forge/api@2.5.0
+
+## 0.5.1-next.0
+
+### Patch Changes
+
+- Updated dependencies [df2cd2f]
+  - @forge/api@2.5.0-next.0
+
+## 0.5.0
+
+### Minor Changes
+
+- 53e3fda: Create new API jobProgress.cancel() in forge-events package
+
+### Patch Changes
+
+- @forge/api@2.4.0
+
+## 0.5.0-next.1
+
+### Minor Changes
+
+- 53e3fda: Create new API jobProgress.cancel() in forge-events package
+
+## 0.4.1-next.0
+
+### Patch Changes
+
+- Updated dependencies [de02d45]
+  - @forge/api@2.4.0-next.0
+
+## 0.4.0
+
+### Minor Changes
+
+- d32350b: allow sending up to 50 events per queue.push()
+
+### Patch Changes
+
+- 8a8dccc: Update error messages
+
+## 0.4.0-next.1
+
+### Minor Changes
+
+- d32350b: allow sending up to 50 events per queue.push()
+
+## 0.3.1-next.0
+
+### Patch Changes
+
+- 8a8dccc: Update error messages
 
 ## 0.3.0
 

package/out/__test__/jobProgress.test.js

@@ -29,7 +29,7 @@ describe('JobProgress methods', () => {
                 code: 404
             }, 404);
             const jobProgress = getJobProgress(apiClientMock, 'test-queue-name#test-job-id');
-            await expect(jobProgress.getStats()).rejects.toThrow(new errors_1.JobDoesNotExistError(`The job test-job-id doesn't exist for the queue test-queue-name.`));
+            await expect(jobProgress.getStats()).rejects.toThrow(new errors_1.JobDoesNotExistError(`The job test-job-id was not found for the queue test-queue-name.`));
             utils_1.verifyApiClientCalledWith(apiClientMock, '/webhook/queue/stats/{cloudId}/{environmentId}/{appId}/{appVersion}', {
                 queueName: 'test-queue-name',
                 jobId: 'test-job-id'
@@ -58,6 +58,30 @@ describe('JobProgress methods', () => {
             });
         });
     });
+    describe('cancel', () => {
+        it('should call the queue/cancel endpoint', async () => {
+            const apiClientMock = utils_1.getApiClientMock({}, 204);
+            const jobProgress = getJobProgress(apiClientMock, 'test-queue-name#test-job-id');
+            const response = await jobProgress.cancel();
+            utils_1.verifyApiClientCalledWith(apiClientMock, '/webhook/queue/cancel/{cloudId}/{environmentId}/{appId}/{appVersion}', {
+                queueName: 'test-queue-name',
+                jobId: 'test-job-id'
+            });
+            expect(response.status).toEqual(204);
+        });
+        it('should throw JobDoesNotExistError', async () => {
+            const apiClientMock = utils_1.getApiClientMock({
+                message: 'Job Not Found',
+                code: 404
+            }, 404);
+            const jobProgress = getJobProgress(apiClientMock, 'test-queue-name#test-job-id');
+            await expect(jobProgress.cancel()).rejects.toThrow(new errors_1.JobDoesNotExistError(`The job test-job-id was not found for the queue test-queue-name.`));
+            utils_1.verifyApiClientCalledWith(apiClientMock, '/webhook/queue/cancel/{cloudId}/{environmentId}/{appId}/{appVersion}', {
+                queueName: 'test-queue-name',
+                jobId: 'test-job-id'
+            });
+        });
+    });
     it('should throw InternalServerError when WHP returns 422 response', async () => {
         const apiClientMock = utils_1.getApiClientMock({
             errors: ['jobId must not be null', 'queueName must not be null']

package/out/__test__/queue.test.js

@@ -37,7 +37,7 @@ describe('Queue methods', () => {
         it('should throw TooManyEventsError', async () => {
             const apiClientMock = utils_1.getApiClientMock();
             const queue = getQueue(apiClientMock, 'name');
-            await expect(queue.push([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11])).rejects.toThrow(new errors_1.TooManyEventsError(`Maximum of 10 events allowed in a single push.`));
+            await expect(queue.push([...Array(51).keys()])).rejects.toThrow(new errors_1.TooManyEventsError(`This push contains more than the 50 events allowed.`));
             expect(apiClientMock).toHaveBeenCalledTimes(0);
         });
         it('should throw PayloadTooBigError', async () => {
@@ -49,15 +49,15 @@ describe('Queue methods', () => {
         it('should throw RateLimitError', async () => {
             const apiClientMock = utils_1.getApiClientMock({}, 429);
             const queue = getQueue(apiClientMock, 'name');
-            const payload = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
+            const payload = [...Array(10).keys()];
             await expect(queue.push(payload)).rejects.toThrow(new errors_1.RateLimitError(`Too many requests.`));
             utils_1.verifyApiClientCalledPushPathWith(apiClientMock, payload, 'name');
         });
         it('should throw InvocationLimitReachedError', async () => {
             const apiClientMock = utils_1.getApiClientMock({}, 405);
             const queue = getQueue(apiClientMock, 'name');
-            const payload = [1, 2, 3, 4, 5];
-            await expect(queue.push(payload)).rejects.toThrow(new errors_1.InvocationLimitReachedError());
+            const payload = [...Array(5).keys()];
+            await expect(queue.push(payload)).rejects.toThrow(new errors_1.InvocationLimitReachedError(`The limit on cyclic invocation has been reached.`));
             utils_1.verifyApiClientCalledPushPathWith(apiClientMock, payload, 'name');
         });
         it('should throw PartialSuccessError when there are failed events', async () => {
@@ -156,7 +156,7 @@ describe('Queue methods', () => {
                 details: 'The request processing has failed because of an unknown error, exception or failure'
             }, 500);
             const queue = getQueue(apiClientMock, 'name');
-            const payload = [1, 2, 3, 4, 5, 6, 7, 8, 9];
+            const payload = [...Array(9).keys()];
             await expect(queue.push(payload)).rejects.toThrow(new errors_1.InternalServerError(`500 Status Text: AWS SQS timed out`, 500, 'The request processing has failed because of an unknown error, exception or failure'));
             utils_1.verifyApiClientCalledPushPathWith(apiClientMock, payload, 'name');
         });

package/out/errors.d.ts

@@ -30,6 +30,6 @@ export declare class JobDoesNotExistError extends Error {
     constructor(message: string);
 }
 export declare class InvocationLimitReachedError extends Error {
-    constructor();
+    constructor(message: string);
 }
 //# sourceMappingURL=errors.d.ts.map

package/out/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC,qBAAa,wBAAyB,SAAQ,KAAK;gBACrC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,qBAAsB,SAAQ,KAAK;gBAClC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,kBAAmB,SAAQ,KAAK;gBAC/B,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,kBAAmB,SAAQ,KAAK;gBAC/B,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,mBAAoB,SAAQ,KAAK;gBAChC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,cAAe,SAAQ,KAAK;gBAC3B,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,mBAAoB,SAAQ,KAAK;gBAChC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE;IAKxD,YAAY,EAAE,WAAW,EAAE,CAAC;CAC7B;AAED,qBAAa,mBAAoB,SAAQ,KAAK;gBAChC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM;IAMjE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,qBAAa,oBAAqB,SAAQ,KAAK;gBACjC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,2BAA4B,SAAQ,KAAK;;CAIrD"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC,qBAAa,wBAAyB,SAAQ,KAAK;gBACrC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,qBAAsB,SAAQ,KAAK;gBAClC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,kBAAmB,SAAQ,KAAK;gBAC/B,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,kBAAmB,SAAQ,KAAK;gBAC/B,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,mBAAoB,SAAQ,KAAK;gBAChC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,cAAe,SAAQ,KAAK;gBAC3B,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,mBAAoB,SAAQ,KAAK;gBAChC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE;IAKxD,YAAY,EAAE,WAAW,EAAE,CAAC;CAC7B;AAED,qBAAa,mBAAoB,SAAQ,KAAK;gBAChC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM;IAMjE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,qBAAa,oBAAqB,SAAQ,KAAK;gBACjC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,2BAA4B,SAAQ,KAAK;gBACxC,OAAO,EAAE,MAAM;CAG5B"}

package/out/errors.js

@@ -59,8 +59,8 @@ class JobDoesNotExistError extends Error {
 }
 exports.JobDoesNotExistError = JobDoesNotExistError;
 class InvocationLimitReachedError extends Error {
-    constructor() {
-        super();
+    constructor(message) {
+        super(message);
     }
 }
 exports.InvocationLimitReachedError = InvocationLimitReachedError;

package/out/jobProgress.d.ts

@@ -4,5 +4,6 @@ export declare class JobProgress {
     private id;
     constructor(id: string, apiClient?: FetchMethod);
     getStats(): Promise<APIResponse>;
+    cancel(): Promise<APIResponse>;
 }
 //# sourceMappingURL=jobProgress.d.ts.map

package/out/jobProgress.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"jobProgress.d.ts","sourceRoot":"","sources":["../src/jobProgress.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,WAAW,EAAmB,MAAM,SAAS,CAAC;AAEpE,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAc;IACxC,OAAO,CAAC,EAAE,CAAS;gBAEP,EAAE,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,WAAW;IAKzC,QAAQ,IAAI,OAAO,CAAC,WAAW,CAAC;CAcvC"}
+{"version":3,"file":"jobProgress.d.ts","sourceRoot":"","sources":["../src/jobProgress.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,WAAW,EAAoB,WAAW,EAAmB,MAAM,SAAS,CAAC;AAEtF,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAc;IACxC,OAAO,CAAC,EAAE,CAAS;gBAEP,EAAE,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,WAAW;IAKzC,QAAQ,IAAI,OAAO,CAAC,WAAW,CAAC;IAehC,MAAM,IAAI,OAAO,CAAC,WAAW,CAAC;CAcrC"}

package/out/jobProgress.js

@@ -20,5 +20,17 @@ class JobProgress {
         await validators_1.validateGetStatsAPIResponse(response, getStatsRequest);
         return response;
     }
+    async cancel() {
+        const [queueName, jobId] = this.id.split('#');
+        const cancelJobRequest = {
+            queueName: queueName,
+            jobId: jobId,
+            time: new Date().toISOString()
+        };
+        validators_1.validateCancelJobRequest(cancelJobRequest);
+        const response = await queries_1.post(queries_1.CANCEL_JOB_PATH, cancelJobRequest, this.apiClient);
+        await validators_1.validateCancelJobAPIResponse(response, cancelJobRequest);
+        return response;
+    }
 }
 exports.JobProgress = JobProgress;

package/out/queries.d.ts

@@ -1,5 +1,6 @@
 import { APIRequest, APIResponse, FetchMethod } from './types';
 export declare const PUSH_PATH = "/webhook/queue/publish/{cloudId}/{environmentId}/{appId}/{appVersion}";
 export declare const GET_STATS_PATH = "/webhook/queue/stats/{cloudId}/{environmentId}/{appId}/{appVersion}";
+export declare const CANCEL_JOB_PATH = "/webhook/queue/cancel/{cloudId}/{environmentId}/{appId}/{appVersion}";
 export declare const post: (endpoint: string, body: APIRequest, apiClient: FetchMethod) => Promise<APIResponse>;
 //# sourceMappingURL=queries.d.ts.map

package/out/queries.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../src/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAE/D,eAAO,MAAM,SAAS,0EAA0E,CAAC;AACjG,eAAO,MAAM,cAAc,wEAAwE,CAAC;AAEpG,eAAO,MAAM,IAAI,aAAoB,MAAM,QAAQ,UAAU,aAAa,WAAW,KAAG,OAAO,CAAC,WAAW,CAU1G,CAAC"}
+{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../src/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAE/D,eAAO,MAAM,SAAS,0EAA0E,CAAC;AACjG,eAAO,MAAM,cAAc,wEAAwE,CAAC;AACpG,eAAO,MAAM,eAAe,yEAAyE,CAAC;AAEtG,eAAO,MAAM,IAAI,aAAoB,MAAM,QAAQ,UAAU,aAAa,WAAW,KAAG,OAAO,CAAC,WAAW,CAU1G,CAAC"}

package/out/queries.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.post = exports.GET_STATS_PATH = exports.PUSH_PATH = void 0;
+exports.post = exports.CANCEL_JOB_PATH = exports.GET_STATS_PATH = exports.PUSH_PATH = void 0;
 exports.PUSH_PATH = '/webhook/queue/publish/{cloudId}/{environmentId}/{appId}/{appVersion}';
 exports.GET_STATS_PATH = '/webhook/queue/stats/{cloudId}/{environmentId}/{appId}/{appVersion}';
+exports.CANCEL_JOB_PATH = '/webhook/queue/cancel/{cloudId}/{environmentId}/{appId}/{appVersion}';
 exports.post = async (endpoint, body, apiClient) => {
     const request = {
         method: 'POST',

package/out/text.d.ts

@@ -6,6 +6,7 @@ export declare const Text: {
         maxPayloadAllowed: (maxPayloadSize: number) => string;
         noEventsPushed: string;
         rateLimitError: string;
+        invocationLimitReachedError: string;
         jobIdEmpty: string;
         jobDoesNotExit: (jobId: string, queueName: string) => string;
     };

package/out/text.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"text.d.ts","sourceRoot":"","sources":["../src/text.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,IAAI;;;;2CAIsB,MAAM,KAAG,MAAM;4CAEd,MAAM,KAAG,MAAM;;;;gCAI3B,MAAM,aAAa,MAAM,KAAG,MAAM;;CAG7D,CAAC"}
+{"version":3,"file":"text.d.ts","sourceRoot":"","sources":["../src/text.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,IAAI;;;;2CAIsB,MAAM,KAAG,MAAM;4CAEd,MAAM,KAAG,MAAM;;;;;gCAK3B,MAAM,aAAa,MAAM,KAAG,MAAM;;CAG7D,CAAC"}

package/out/text.js

@@ -5,11 +5,12 @@ exports.Text = {
     error: {
         invalidQueueName: `Queue names can only contain alphanumeric characters, dashes and underscores.`,
         invalidDelayInSecondsSetting: `The delayInSeconds setting must be between 0 and 900.`,
-        maxEventsAllowed: (maxEventsCount) => `Maximum of ${maxEventsCount} events allowed in a single push.`,
+        maxEventsAllowed: (maxEventsCount) => `This push contains more than the ${maxEventsCount} events allowed.`,
         maxPayloadAllowed: (maxPayloadSize) => `The maximum payload size is ${maxPayloadSize}KB.`,
         noEventsPushed: `No events pushed.`,
         rateLimitError: `Too many requests.`,
+        invocationLimitReachedError: `The limit on cyclic invocation has been reached.`,
         jobIdEmpty: `jobId cannot be empty.`,
-        jobDoesNotExit: (jobId, queueName) => `The job ${jobId} doesn't exist for the queue ${queueName}.`
+        jobDoesNotExit: (jobId, queueName) => `The job ${jobId} was not found for the queue ${queueName}.`
     }
 };

package/out/types.d.ts

@@ -26,4 +26,5 @@ export interface FailedEvent {
     payload: Payload;
 }
 export declare type GetStatsRequest = APIRequest;
+export declare type CancelJobRequest = APIRequest;
 //# sourceMappingURL=types.d.ts.map

package/out/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEnD,oBAAY,WAAW,GAAG,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,aAAa,GAAG,IAAI,GAAG,QAAQ,GAAG,YAAY,CAAC,CAAC;AAC3G,oBAAY,WAAW,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;AACnF,oBAAY,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC;AAE7E,MAAM,WAAW,YAAY;IAC3B,cAAc,EAAE,MAAM,CAAC;CACxB;AACD,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,OAAO,EAAE,OAAO,EAAE,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,UAAU;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,WAAW;IAC1B,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,oBAAY,eAAe,GAAG,UAAU,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEnD,oBAAY,WAAW,GAAG,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,aAAa,GAAG,IAAI,GAAG,QAAQ,GAAG,YAAY,CAAC,CAAC;AAC3G,oBAAY,WAAW,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;AACnF,oBAAY,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC;AAE7E,MAAM,WAAW,YAAY;IAC3B,cAAc,EAAE,MAAM,CAAC;CACxB;AACD,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,OAAO,EAAE,OAAO,EAAE,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,UAAU;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,WAAW;IAC1B,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,oBAAY,eAAe,GAAG,UAAU,CAAC;AACzC,oBAAY,gBAAgB,GAAG,UAAU,CAAC"}

package/out/validators.d.ts

@@ -1,9 +1,11 @@
-import { APIResponse, GetStatsRequest, Payload, PushRequest, PushSettings } from './types';
+import { APIResponse, CancelJobRequest, GetStatsRequest, Payload, PushRequest, PushSettings } from './types';
 export declare const validateQueueKey: (queueName: string) => void;
 export declare const validatePushSettings: (settings: PushSettings) => void;
 export declare const validatePushPayloads: (payloads: Payload | Payload[]) => void;
 export declare const validateGetStatsPayload: (getStatsRequest: GetStatsRequest) => void;
+export declare const validateCancelJobRequest: (cancelJobRequest: CancelJobRequest) => void;
 export declare const validateAPIResponse: (response: APIResponse, expectedSuccessStatus: number) => Promise<void>;
 export declare const validatePushAPIResponse: (response: APIResponse, requestBody: PushRequest) => Promise<void>;
 export declare const validateGetStatsAPIResponse: (response: APIResponse, getStatsRequest: GetStatsRequest) => Promise<void>;
+export declare const validateCancelJobAPIResponse: (response: APIResponse, cancelJobRequest: GetStatsRequest) => Promise<void>;
 //# sourceMappingURL=validators.d.ts.map

package/out/validators.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validators.d.ts","sourceRoot":"","sources":["../src/validators.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAM3F,eAAO,MAAM,gBAAgB,cAAe,MAAM,SAIjD,CAAC;AAEF,eAAO,MAAM,oBAAoB,aAAc,YAAY,SAI1D,CAAC;AAEF,eAAO,MAAM,oBAAoB,aAAc,OAAO,GAAG,OAAO,EAAE,SAajE,CAAC;AAEF,eAAO,MAAM,uBAAuB,oBAAqB,eAAe,SAKvE,CAAC;AAEF,eAAO,MAAM,mBAAmB,aAAoB,WAAW,yBAAyB,MAAM,kBA6B7F,CAAC;AAEF,eAAO,MAAM,uBAAuB,aAAoB,WAAW,eAAe,WAAW,kBAkC5F,CAAC;AAEF,eAAO,MAAM,2BAA2B,aAAoB,WAAW,mBAAmB,eAAe,kBAMxG,CAAC"}
+{"version":3,"file":"validators.d.ts","sourceRoot":"","sources":["../src/validators.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,eAAe,EAAE,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAM7G,eAAO,MAAM,gBAAgB,cAAe,MAAM,SAIjD,CAAC;AAEF,eAAO,MAAM,oBAAoB,aAAc,YAAY,SAI1D,CAAC;AAEF,eAAO,MAAM,oBAAoB,aAAc,OAAO,GAAG,OAAO,EAAE,SAajE,CAAC;AAEF,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,aAAoB,WAAW,eAAe,WAAW,kBAkC5F,CAAC;AAEF,eAAO,MAAM,2BAA2B,aAAoB,WAAW,mBAAmB,eAAe,kBAMxG,CAAC;AAEF,eAAO,MAAM,4BAA4B,aAAoB,WAAW,oBAAoB,eAAe,kBAM1G,CAAC"}

package/out/validators.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateGetStatsAPIResponse = exports.validatePushAPIResponse = exports.validateAPIResponse = exports.validateGetStatsPayload = exports.validatePushPayloads = exports.validatePushSettings = exports.validateQueueKey = void 0;
+exports.validateCancelJobAPIResponse = exports.validateGetStatsAPIResponse = exports.validatePushAPIResponse = exports.validateAPIResponse = exports.validateCancelJobRequest = exports.validateGetStatsPayload = exports.validatePushPayloads = exports.validatePushSettings = exports.validateQueueKey = void 0;
 const errors_1 = require("./errors");
 const text_1 = require("./text");
 const VALID_QUEUE_NAME_PATTERN = /^[a-zA-Z0-9-_]+$/;
-const MAXIMUM_EVENTS = 10;
+const MAXIMUM_EVENTS = 50;
 const MAXIMUM_PAYLOAD_SIZE_KB = 200;
 exports.validateQueueKey = (queueName) => {
     if (!queueName || !VALID_QUEUE_NAME_PATTERN.test(queueName)) {
@@ -34,12 +34,18 @@ exports.validateGetStatsPayload = (getStatsRequest) => {
     }
     exports.validateQueueKey(getStatsRequest.queueName);
 };
+exports.validateCancelJobRequest = (cancelJobRequest) => {
+    if (!cancelJobRequest.jobId) {
+        throw new errors_1.JobDoesNotExistError(text_1.Text.error.jobIdEmpty);
+    }
+    exports.validateQueueKey(cancelJobRequest.queueName);
+};
 exports.validateAPIResponse = async (response, expectedSuccessStatus) => {
     if (response.status === 429) {
         throw new errors_1.RateLimitError(text_1.Text.error.rateLimitError);
     }
     if (response.status === 405) {
-        throw new errors_1.InvocationLimitReachedError();
+        throw new errors_1.InvocationLimitReachedError(text_1.Text.error.invocationLimitReachedError);
     }
     if (response.status != expectedSuccessStatus && response.status) {
         let internalServerError;
@@ -89,3 +95,9 @@ exports.validateGetStatsAPIResponse = async (response, getStatsRequest) => {
     }
     await exports.validateAPIResponse(response, 200);
 };
+exports.validateCancelJobAPIResponse = async (response, cancelJobRequest) => {
+    if (response.status === 404) {
+        throw new errors_1.JobDoesNotExistError(text_1.Text.error.jobDoesNotExit(cancelJobRequest.jobId, cancelJobRequest.queueName));
+    }
+    await exports.validateAPIResponse(response, 204);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/events",
-  "version": "0.0.0-experimental-d18f8dd",
+  "version": "0.0.0-experimental-64caa5a",
   "description": "Forge Async Event methods",
   "author": "Atlassian",
   "license": "UNLICENSED",
@@ -12,11 +12,11 @@
     "compile": "tsc -b -v"
   },
   "devDependencies": {
-    "@types/uuid": "^3.4.7",
-    "@types/node": "^12.12.63"
+    "@types/node": "^12.12.63",
+    "@types/uuid": "^3.4.7"
   },
   "dependencies": {
-    "uuid": "^3.4.0",
-    "@forge/api": "^0.0.0-experimental-d18f8dd"
+    "@forge/api": "^0.0.0-experimental-64caa5a",
+    "uuid": "^3.4.0"
   }
 }

package/src/__test__/jobProgress.test.ts

@@ -37,7 +37,7 @@ describe('JobProgress methods', () => {
       );
       const jobProgress = getJobProgress(apiClientMock, 'test-queue-name#test-job-id');
       await expect(jobProgress.getStats()).rejects.toThrow(
-        new JobDoesNotExistError(`The job test-job-id doesn't exist for the queue test-queue-name.`)
+        new JobDoesNotExistError(`The job test-job-id was not found for the queue test-queue-name.`)
       );
       verifyApiClientCalledWith(apiClientMock, '/webhook/queue/stats/{cloudId}/{environmentId}/{appId}/{appVersion}', {
         queueName: 'test-queue-name',
@@ -75,6 +75,37 @@ describe('JobProgress methods', () => {
     });
   });
 
+  describe('cancel', () => {
+    it('should call the queue/cancel endpoint', async () => {
+      const apiClientMock = getApiClientMock({}, 204);
+      const jobProgress = getJobProgress(apiClientMock, 'test-queue-name#test-job-id');
+      const response = await jobProgress.cancel();
+      verifyApiClientCalledWith(apiClientMock, '/webhook/queue/cancel/{cloudId}/{environmentId}/{appId}/{appVersion}', {
+        queueName: 'test-queue-name',
+        jobId: 'test-job-id'
+      });
+      expect(response.status).toEqual(204);
+    });
+
+    it('should throw JobDoesNotExistError', async () => {
+      const apiClientMock = getApiClientMock(
+        {
+          message: 'Job Not Found',
+          code: 404
+        },
+        404
+      );
+      const jobProgress = getJobProgress(apiClientMock, 'test-queue-name#test-job-id');
+      await expect(jobProgress.cancel()).rejects.toThrow(
+        new JobDoesNotExistError(`The job test-job-id was not found for the queue test-queue-name.`)
+      );
+      verifyApiClientCalledWith(apiClientMock, '/webhook/queue/cancel/{cloudId}/{environmentId}/{appId}/{appVersion}', {
+        queueName: 'test-queue-name',
+        jobId: 'test-job-id'
+      });
+    });
+  });
+
   it('should throw InternalServerError when WHP returns 422 response', async () => {
     const apiClientMock = getApiClientMock(
       {

package/src/__test__/queue.test.ts

@@ -55,8 +55,8 @@ describe('Queue methods', () => {
     it('should throw TooManyEventsError', async () => {
       const apiClientMock = getApiClientMock();
       const queue = getQueue(apiClientMock, 'name');
-      await expect(queue.push([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11])).rejects.toThrow(
-        new TooManyEventsError(`Maximum of 10 events allowed in a single push.`)
+      await expect(queue.push([...Array(51).keys()])).rejects.toThrow(
+        new TooManyEventsError(`This push contains more than the 50 events allowed.`)
       );
       expect(apiClientMock).toHaveBeenCalledTimes(0);
     });
@@ -73,7 +73,7 @@ describe('Queue methods', () => {
     it('should throw RateLimitError', async () => {
       const apiClientMock = getApiClientMock({}, 429);
       const queue = getQueue(apiClientMock, 'name');
-      const payload = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
+      const payload = [...Array(10).keys()];
       await expect(queue.push(payload)).rejects.toThrow(new RateLimitError(`Too many requests.`));
       verifyApiClientCalledPushPathWith(apiClientMock, payload, 'name');
     });
@@ -81,8 +81,10 @@ describe('Queue methods', () => {
     it('should throw InvocationLimitReachedError', async () => {
       const apiClientMock = getApiClientMock({}, 405);
       const queue = getQueue(apiClientMock, 'name');
-      const payload = [1, 2, 3, 4, 5];
-      await expect(queue.push(payload)).rejects.toThrow(new InvocationLimitReachedError());
+      const payload = [...Array(5).keys()];
+      await expect(queue.push(payload)).rejects.toThrow(
+        new InvocationLimitReachedError(`The limit on cyclic invocation has been reached.`)
+      );
       verifyApiClientCalledPushPathWith(apiClientMock, payload, 'name');
     });
 
@@ -203,7 +205,7 @@ describe('Queue methods', () => {
         500
       );
       const queue = getQueue(apiClientMock, 'name');
-      const payload = [1, 2, 3, 4, 5, 6, 7, 8, 9];
+      const payload = [...Array(9).keys()];
       await expect(queue.push(payload)).rejects.toThrow(
         new InternalServerError(
           `500 Status Text: AWS SQS timed out`,

package/src/errors.ts

@@ -63,7 +63,7 @@ export class JobDoesNotExistError extends Error {
 }
 
 export class InvocationLimitReachedError extends Error {
-  constructor() {
-    super();
+  constructor(message: string) {
+    super(message);
   }
 }

package/src/jobProgress.ts

@@ -1,6 +1,11 @@
-import { GET_STATS_PATH, post } from './queries';
-import { validateGetStatsAPIResponse, validateGetStatsPayload } from './validators';
-import { APIResponse, FetchMethod, GetStatsRequest } from './types';
+import { CANCEL_JOB_PATH, GET_STATS_PATH, post } from './queries';
+import {
+  validateCancelJobAPIResponse,
+  validateCancelJobRequest,
+  validateGetStatsAPIResponse,
+  validateGetStatsPayload
+} from './validators';
+import { APIResponse, CancelJobRequest, FetchMethod, GetStatsRequest } from './types';
 
 export class JobProgress {
   private readonly apiClient: FetchMethod;
@@ -25,4 +30,19 @@ export class JobProgress {
     await validateGetStatsAPIResponse(response, getStatsRequest);
     return response;
   }
+
+  async cancel(): Promise<APIResponse> {
+    const [queueName, jobId] = this.id.split('#');
+    const cancelJobRequest: CancelJobRequest = {
+      queueName: queueName,
+      jobId: jobId,
+      time: new Date().toISOString()
+    };
+
+    validateCancelJobRequest(cancelJobRequest);
+
+    const response = await post(CANCEL_JOB_PATH, cancelJobRequest, this.apiClient);
+    await validateCancelJobAPIResponse(response, cancelJobRequest);
+    return response;
+  }
 }

package/src/queries.ts

@@ -2,6 +2,7 @@ import { APIRequest, APIResponse, FetchMethod } from './types';
 
 export const PUSH_PATH = '/webhook/queue/publish/{cloudId}/{environmentId}/{appId}/{appVersion}';
 export const GET_STATS_PATH = '/webhook/queue/stats/{cloudId}/{environmentId}/{appId}/{appVersion}';
+export const CANCEL_JOB_PATH = '/webhook/queue/cancel/{cloudId}/{environmentId}/{appId}/{appVersion}';
 
 export const post = async (endpoint: string, body: APIRequest, apiClient: FetchMethod): Promise<APIResponse> => {
   const request = {

package/src/text.ts

@@ -3,12 +3,13 @@ export const Text = {
     invalidQueueName: `Queue names can only contain alphanumeric characters, dashes and underscores.`,
     invalidDelayInSecondsSetting: `The delayInSeconds setting must be between 0 and 900.`,
     maxEventsAllowed: (maxEventsCount: number): string =>
-      `Maximum of ${maxEventsCount} events allowed in a single push.`,
+      `This push contains more than the ${maxEventsCount} events allowed.`,
     maxPayloadAllowed: (maxPayloadSize: number): string => `The maximum payload size is ${maxPayloadSize}KB.`,
     noEventsPushed: `No events pushed.`,
     rateLimitError: `Too many requests.`,
+    invocationLimitReachedError: `The limit on cyclic invocation has been reached.`,
     jobIdEmpty: `jobId cannot be empty.`,
     jobDoesNotExit: (jobId: string, queueName: string): string =>
-      `The job ${jobId} doesn't exist for the queue ${queueName}.`
+      `The job ${jobId} was not found for the queue ${queueName}.`
   }
 };

package/src/types.ts

@@ -30,3 +30,4 @@ export interface FailedEvent {
 }
 
 export type GetStatsRequest = APIRequest;
+export type CancelJobRequest = APIRequest;

package/src/validators.ts

@@ -11,10 +11,10 @@ import {
   InvocationLimitReachedError
 } from './errors';
 import { Text } from './text';
-import { APIResponse, GetStatsRequest, Payload, PushRequest, PushSettings } from './types';
+import { APIResponse, CancelJobRequest, GetStatsRequest, Payload, PushRequest, PushSettings } from './types';
 
 const VALID_QUEUE_NAME_PATTERN = /^[a-zA-Z0-9-_]+$/;
-const MAXIMUM_EVENTS = 10;
+const MAXIMUM_EVENTS = 50;
 const MAXIMUM_PAYLOAD_SIZE_KB = 200;
 
 export const validateQueueKey = (queueName: string) => {
@@ -51,13 +51,20 @@ export const validateGetStatsPayload = (getStatsRequest: GetStatsRequest) => {
   validateQueueKey(getStatsRequest.queueName);
 };
 
+export const validateCancelJobRequest = (cancelJobRequest: CancelJobRequest) => {
+  if (!cancelJobRequest.jobId) {
+    throw new JobDoesNotExistError(Text.error.jobIdEmpty);
+  }
+  validateQueueKey(cancelJobRequest.queueName);
+};
+
 export const validateAPIResponse = async (response: APIResponse, expectedSuccessStatus: number) => {
   if (response.status === 429) {
     throw new RateLimitError(Text.error.rateLimitError);
   }
 
   if (response.status === 405) {
-    throw new InvocationLimitReachedError();
+    throw new InvocationLimitReachedError(Text.error.invocationLimitReachedError);
   }
 
   if (response.status != expectedSuccessStatus && response.status) {
@@ -125,3 +132,11 @@ export const validateGetStatsAPIResponse = async (response: APIResponse, getStat
 
   await validateAPIResponse(response, 200);
 };
+
+export const validateCancelJobAPIResponse = async (response: APIResponse, cancelJobRequest: GetStatsRequest) => {
+  if (response.status === 404) {
+    throw new JobDoesNotExistError(Text.error.jobDoesNotExit(cancelJobRequest.jobId, cancelJobRequest.queueName));
+  }
+
+  await validateAPIResponse(response, 204);
+};

package/tsconfig.tsbuildinfo

@@ -392,28 +392,28 @@
         "affectsGlobalScope": false
       },
       "./src/types.ts": {
-        "version": "c9a87ba3c74bfab165eb9297bd840e9aaab6be9fbb6cb0df4269dff6a84ef9ea",
-        "signature": "ef0271027a212c16d58061d84cab91205077d7cc8f9a6fc2024aef5e8f95fd5b",
+        "version": "d899396a1cd22fa15d0aa6157f0cfd2e2e6d4548a26bf78b1ab60f1df3f4a297",
+        "signature": "bd30bbb87257959ac77e41c2f1b05f36adc4df30395152b645663c4d27c47cb8",
         "affectsGlobalScope": false
       },
       "./src/errors.ts": {
-        "version": "337cdade564b6155936572ea9629417435fa23c264f0aeabafa96527f87df119",
-        "signature": "806b89b9f9cf0126cc50bdc2e5173eb1d6e4618b476c1493f6e15c66329b347a",
+        "version": "d851b9c7d9f3221bbef29df8237e3d4156ab8706950d6bdd6c4a57d8e55cc4c1",
+        "signature": "dbec5f26319c68d139585561f12341a720ab13880a4c040b438e892ae391d2c9",
         "affectsGlobalScope": false
       },
       "./src/queries.ts": {
-        "version": "b7e5caa29c0d2c345008aef17299592075b456624de7361b1186faa633ec2128",
-        "signature": "799be984f8fba263753f97c3bf0a68a22907b7bdbfa94a05ad59af426250bc5d",
+        "version": "37ef341ab46e3c19f69adca1eaa01e6d8718492817de0fd6d2ec8c8a12d08a53",
+        "signature": "f2c2560bfd355b9314099a4fbf9590389a05a631a0de38c45f58138b62de8373",
         "affectsGlobalScope": false
       },
       "./src/text.ts": {
-        "version": "0d1a499967f9e09fc760486fb487a251855a78d05b80d249729080ec98cccd66",
-        "signature": "090fd6968168da325d9e84ff968b77f62523775fb6154a0cc1facd35a4eb6702",
+        "version": "0b4ee00634da4bf5aa2fecf99443c7a886fee5619832b35c0e10513deecd3967",
+        "signature": "4c846733296e27a117c12a9bdf0311f5790125ddf1e1e01b54869b9c487630ba",
         "affectsGlobalScope": false
       },
       "./src/validators.ts": {
-        "version": "9a88390cc1009a9bcbb46136c1984eed7abba46ce4ead9f9bb8a52a8e54740c4",
-        "signature": "74384a84caa4d0e5679b15f8e72bad7b657d503e3178ed8b9b87c32f36e3573b",
+        "version": "80bad79d153f9cbadb49786888e0bf8afa8b1cade29ddb7a6abf41a549a7d189",
+        "signature": "1caad0a449141b7fb074e18fa2b8668551d6cff6b60ca3611b99e98a9269c1b2",
         "affectsGlobalScope": false
       },
       "../../node_modules/@types/uuid/interfaces.d.ts": {
@@ -427,8 +427,8 @@
         "affectsGlobalScope": false
       },
       "./src/jobProgress.ts": {
-        "version": "1db053b2616c239a60e6db36b3a2d265c468159cfb7e7686a4f6bdb1834cadf8",
-        "signature": "3c086f330a96725bd587b6a7a17b2b87404ef8a45a3626fd54e67f059a5e3ba3",
+        "version": "5e1a2c3330fa7dcfd92a4b12cddfba84ff23110637ed768a2a139568ea966364",
+        "signature": "34c50ef91fedd3e185ce8913f72f6aa106e52387267de30bfcc0f6dc61148085",
         "affectsGlobalScope": false
       },
       "./src/queue.ts": {
@@ -452,12 +452,12 @@
         "affectsGlobalScope": false
       },
       "./src/__test__/jobProgress.test.ts": {
-        "version": "9de7b4accb652b255005f603d951c15c2443ffd568e36dae00da18c2d1b92ea8",
+        "version": "21f544b34d81798a4c229e4b8834f69561400e56fb260b94cd533e4223a24740",
         "signature": "7870ceffd2c069795d2976c13017e1697f28e9a1c994dbd36dc48c21826db61b",
         "affectsGlobalScope": false
       },
       "./src/__test__/queue.test.ts": {
-        "version": "b38c9012b04685520db50576252eccc4f71d1cbdaeedfdab1b99df6323e51650",
+        "version": "23dea05f9460582f60526e93a77111cda92508c785087c54fa05995b9b6dd9df",
         "signature": "1302e8032e32981552bc73b7ef2f99ebf98990a704e26f51e70b1d96a4639fcf",
         "affectsGlobalScope": false
       },