@forge/events 0.0.0-experimental-d18f8dd → 0.0.0-experimental-416047f

package/CHANGELOG.md

@@ -1,12 +1,102 @@
 # @forge/events
 
-## 0.0.0-experimental-d18f8dd
+## 0.0.0-experimental-416047f
+
+### Minor Changes
+
+- 0859c97: Allow app developers to return InvocationError on error from lambda function
+
+## 0.6.0-next.0
+
+### Minor Changes
+
+- 0859c971: Allow app developers to return InvocationError on error from lambda function
+
+## 0.5.3
+
+### Patch Changes
+
+- @forge/api@2.6.1
+
+## 0.5.3-next.0
+
+### Patch Changes
+
+- @forge/api@2.6.1-next.0
+
+## 0.5.2
+
+### Patch Changes
+
+- Updated dependencies [8571c05]
+  - @forge/api@2.6.0
+
+## 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
 
-- d18f8dd: Force bump
-- Updated dependencies [d18f8dd]
-  - @forge/api@0.0.0-experimental-d18f8dd
+- 8a8dccc: Update error messages
 
 ## 0.3.0
 

package/out/__test__/invocationError.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=invocationError.test.d.ts.map

package/out/__test__/invocationError.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"invocationError.test.d.ts","sourceRoot":"","sources":["../../src/__test__/invocationError.test.ts"],"names":[],"mappings":""}

package/out/__test__/invocationError.test.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const retryOptions_1 = require("../retryOptions");
+const invocationError_1 = require("../invocationError");
+const invocationErrorCode_1 = require("../invocationErrorCode");
+describe('InvocationError tests', () => {
+    const defaultRetryOption = new retryOptions_1.RetryOptions();
+    let target = new invocationError_1.InvocationError();
+    it('Populate invocationError with default retryOptions and expect default retry option', async () => {
+        expect(target.retryOptions.retryAfter).toEqual(defaultRetryOption.retryAfter);
+        expect(target.retryOptions.retryReason).toEqual(invocationErrorCode_1.InvocationErrorCode.FUNCTION_RETRY_REQUEST);
+        expect(target.hasOwnProperty('_retry')).toBe(true);
+    });
+    it('Populate InvocationError with custom RetryOptions and expect the custom value to set.', () => {
+        defaultRetryOption.retryAfter = 10;
+        defaultRetryOption.retryReason = invocationErrorCode_1.InvocationErrorCode.FUNCTION_OUT_OF_MEMORY;
+        target = new invocationError_1.InvocationError(defaultRetryOption);
+        expect(target.retryOptions).toEqual(defaultRetryOption);
+        expect(target.hasOwnProperty('_retry')).toBe(true);
+    });
+});

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/__test__/retryOptions.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=retryOptions.test.d.ts.map

package/out/__test__/retryOptions.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"retryOptions.test.d.ts","sourceRoot":"","sources":["../../src/__test__/retryOptions.test.ts"],"names":[],"mappings":""}

package/out/__test__/retryOptions.test.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const retryOptions_1 = require("../retryOptions");
+describe('RetryOptions tests', () => {
+    const target = new retryOptions_1.RetryOptions();
+    it.each([
+        [retryOptions_1.RetryOptions.MIN_RETRY_AFTER, retryOptions_1.RetryOptions.MIN_RETRY_AFTER],
+        [retryOptions_1.RetryOptions.MIN_RETRY_AFTER - 1, retryOptions_1.RetryOptions.MIN_RETRY_AFTER],
+        [retryOptions_1.RetryOptions.MIN_RETRY_AFTER + 1, retryOptions_1.RetryOptions.MIN_RETRY_AFTER + 1]
+    ])('try to set retryAfter to %p, expect retryAfter to be %p', (value, result) => {
+        target.retryAfter = value;
+        expect(target.retryAfter).toEqual(result);
+    });
+});

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/index.d.ts

@@ -2,4 +2,7 @@ export { Queue } from './queue';
 export { InvalidQueueNameError, TooManyEventsError, PayloadTooBigError, NoEventsToPushError, RateLimitError, PartialSuccessError, InternalServerError, JobDoesNotExistError, InvalidPushSettingsError, InvocationLimitReachedError } from './errors';
 export { JobProgress } from './jobProgress';
 export { QueueResponse } from './queueResponse';
+export { InvocationError } from './invocationError';
+export { InvocationErrorCode } from './invocationErrorCode';
+export { RetryOptions } from './retryOptions';
 //# sourceMappingURL=index.d.ts.map

package/out/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EACL,qBAAqB,EACrB,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACnB,cAAc,EACd,mBAAmB,EACnB,mBAAmB,EACnB,oBAAoB,EACpB,wBAAwB,EACxB,2BAA2B,EAC5B,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EACL,qBAAqB,EACrB,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACnB,cAAc,EACd,mBAAmB,EACnB,mBAAmB,EACnB,oBAAoB,EACpB,wBAAwB,EACxB,2BAA2B,EAC5B,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC"}

package/out/index.js

@@ -17,3 +17,9 @@ var jobProgress_1 = require("./jobProgress");
 Object.defineProperty(exports, "JobProgress", { enumerable: true, get: function () { return jobProgress_1.JobProgress; } });
 var queueResponse_1 = require("./queueResponse");
 Object.defineProperty(exports, "QueueResponse", { enumerable: true, get: function () { return queueResponse_1.QueueResponse; } });
+var invocationError_1 = require("./invocationError");
+Object.defineProperty(exports, "InvocationError", { enumerable: true, get: function () { return invocationError_1.InvocationError; } });
+var invocationErrorCode_1 = require("./invocationErrorCode");
+Object.defineProperty(exports, "InvocationErrorCode", { enumerable: true, get: function () { return invocationErrorCode_1.InvocationErrorCode; } });
+var retryOptions_1 = require("./retryOptions");
+Object.defineProperty(exports, "RetryOptions", { enumerable: true, get: function () { return retryOptions_1.RetryOptions; } });

package/out/invocationError.d.ts

@@ -0,0 +1,7 @@
+import { RetryOptions } from './retryOptions';
+import { Response } from './queueResponse';
+export declare class InvocationError extends Response {
+    retryOptions: RetryOptions;
+    constructor(retryOptions?: RetryOptions);
+}
+//# sourceMappingURL=invocationError.d.ts.map

package/out/invocationError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"invocationError.d.ts","sourceRoot":"","sources":["../src/invocationError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAE3C,qBAAa,eAAgB,SAAQ,QAAQ;IACxB,YAAY,EAAE,YAAY;gBAA1B,YAAY,GAAE,YAAiC;CAGnE"}

package/out/invocationError.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InvocationError = void 0;
+const retryOptions_1 = require("./retryOptions");
+const queueResponse_1 = require("./queueResponse");
+class InvocationError extends queueResponse_1.Response {
+    constructor(retryOptions = new retryOptions_1.RetryOptions()) {
+        super(true);
+        this.retryOptions = retryOptions;
+    }
+}
+exports.InvocationError = InvocationError;

package/out/invocationErrorCode.d.ts

@@ -0,0 +1,9 @@
+export declare enum InvocationErrorCode {
+    FUNCTION_OUT_OF_MEMORY = 0,
+    FUNCTION_TIME_OUT = 1,
+    FUNCTION_PLATFORM_UNKNOWN_ERROR = 2,
+    FUNCTION_PLATFORM_RATE_LIMITED = 3,
+    FUNCTION_UPSTREAM_RATE_LIMITED = 4,
+    FUNCTION_RETRY_REQUEST = 5
+}
+//# sourceMappingURL=invocationErrorCode.d.ts.map

package/out/invocationErrorCode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"invocationErrorCode.d.ts","sourceRoot":"","sources":["../src/invocationErrorCode.ts"],"names":[],"mappings":"AAAA,oBAAY,mBAAmB;IAC7B,sBAAsB,IAAA;IACtB,iBAAiB,IAAA;IACjB,+BAA+B,IAAA;IAC/B,8BAA8B,IAAA;IAC9B,8BAA8B,IAAA;IAC9B,sBAAsB,IAAA;CACvB"}

package/out/invocationErrorCode.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InvocationErrorCode = void 0;
+var InvocationErrorCode;
+(function (InvocationErrorCode) {
+    InvocationErrorCode[InvocationErrorCode["FUNCTION_OUT_OF_MEMORY"] = 0] = "FUNCTION_OUT_OF_MEMORY";
+    InvocationErrorCode[InvocationErrorCode["FUNCTION_TIME_OUT"] = 1] = "FUNCTION_TIME_OUT";
+    InvocationErrorCode[InvocationErrorCode["FUNCTION_PLATFORM_UNKNOWN_ERROR"] = 2] = "FUNCTION_PLATFORM_UNKNOWN_ERROR";
+    InvocationErrorCode[InvocationErrorCode["FUNCTION_PLATFORM_RATE_LIMITED"] = 3] = "FUNCTION_PLATFORM_RATE_LIMITED";
+    InvocationErrorCode[InvocationErrorCode["FUNCTION_UPSTREAM_RATE_LIMITED"] = 4] = "FUNCTION_UPSTREAM_RATE_LIMITED";
+    InvocationErrorCode[InvocationErrorCode["FUNCTION_RETRY_REQUEST"] = 5] = "FUNCTION_RETRY_REQUEST";
+})(InvocationErrorCode = exports.InvocationErrorCode || (exports.InvocationErrorCode = {}));

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/queueResponse.d.ts

@@ -1,5 +1,9 @@
-export declare class QueueResponse {
+export declare class Response {
     protected _retry: boolean;
+    constructor(_retry: boolean);
+}
+export declare class QueueResponse extends Response {
+    constructor();
     retry(): void;
 }
 //# sourceMappingURL=queueResponse.d.ts.map

package/out/queueResponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queueResponse.d.ts","sourceRoot":"","sources":["../src/queueResponse.ts"],"names":[],"mappings":"AAAA,qBAAa,aAAa;IACxB,SAAS,CAAC,MAAM,UAAS;IAEzB,KAAK,IAAI,IAAI;CAGd"}
+{"version":3,"file":"queueResponse.d.ts","sourceRoot":"","sources":["../src/queueResponse.ts"],"names":[],"mappings":"AAAA,qBAAa,QAAQ;IACP,SAAS,CAAC,MAAM,EAAE,OAAO;gBAAf,MAAM,EAAE,OAAO;CACtC;AAED,qBAAa,aAAc,SAAQ,QAAQ;;IAKzC,KAAK,IAAI,IAAI;CAGd"}

package/out/queueResponse.js

@@ -1,9 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.QueueResponse = void 0;
-class QueueResponse {
+exports.QueueResponse = exports.Response = void 0;
+class Response {
+    constructor(_retry) {
+        this._retry = _retry;
+    }
+}
+exports.Response = Response;
+class QueueResponse extends Response {
     constructor() {
-        this._retry = false;
+        super(false);
     }
     retry() {
         this._retry = true;

package/out/retryOptions.d.ts

@@ -0,0 +1,9 @@
+import { InvocationErrorCode } from './invocationErrorCode';
+export declare class RetryOptions {
+    static readonly MIN_RETRY_AFTER = 1;
+    private _retryAfter;
+    retryReason: InvocationErrorCode;
+    set retryAfter(valueInSeconds: number);
+    get retryAfter(): number;
+}
+//# sourceMappingURL=retryOptions.d.ts.map

package/out/retryOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"retryOptions.d.ts","sourceRoot":"","sources":["../src/retryOptions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,qBAAa,YAAY;IACvB,MAAM,CAAC,QAAQ,CAAC,eAAe,KAAK;IAEpC,OAAO,CAAC,WAAW,CAAgC;IAE5C,WAAW,EAAE,mBAAmB,CAA8C;IAMrF,IAAI,UAAU,CAAC,cAAc,EAAE,MAAM,EAIpC;IAKD,IAAI,UAAU,IAAI,MAAM,CAEvB;CACF"}

package/out/retryOptions.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RetryOptions = void 0;
+const invocationErrorCode_1 = require("./invocationErrorCode");
+class RetryOptions {
+    constructor() {
+        this._retryAfter = RetryOptions.MIN_RETRY_AFTER;
+        this.retryReason = invocationErrorCode_1.InvocationErrorCode.FUNCTION_RETRY_REQUEST;
+    }
+    set retryAfter(valueInSeconds) {
+        if (valueInSeconds >= RetryOptions.MIN_RETRY_AFTER) {
+            this._retryAfter = valueInSeconds;
+        }
+    }
+    get retryAfter() {
+        return this._retryAfter;
+    }
+}
+exports.RetryOptions = RetryOptions;
+RetryOptions.MIN_RETRY_AFTER = 1;

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-416047f",
   "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": "^2.6.1",
+    "uuid": "^3.4.0"
   }
 }