@forge/events 1.1.0-next.0 → 2.0.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @forge/events
 
+## 2.0.0-next.2
+
+### Patch Changes
+
+- 882de38: Fix async events job progress operations
+
+## 2.0.0-next.1
+
+### Major Changes
+
+- a89e05a: Restrict async events payload to objects
+- 81174c3: Change `queue.push()` to accept events containing body and delay
+- 9227948: Simplify JobProgress.getStats to return stats directly and remove unneeded response from JobProgress.cancel
+
 ## 1.1.0-next.0
 
 ### Minor Changes

package/README.md

@@ -1,39 +1,45 @@
-Library for asynchronous data processing.
+# Forge Events
 
-Usage example:
+Library for [asynchronous data processing](https://developer.atlassian.com/platform/forge/runtime-reference/async-events-api/) in Forge.
 
-```javascript
-import fetch, { RequestInit } from 'node-fetch';
+## Requirements
 
-import { Queue } from './index';
+See [Set up Forge](https://developer.atlassian.com/platform/forge/set-up-forge/) for details of the software required to develop Forge apps.
 
-const API_BASE = 'https://api.atlassian.com';
+## Usage
 
-// For Async service auth
-const appContextAri = 'ari:cloud:jira::site/...';
-const token = '...';
+### Pushing events to the queue
 
-async function apiClient(path: string, init: RequestInit): Promise<APIResponse> {
-  const url = API_BASE + path;
+```typescript
 
-  const extraHeaders = {
-    // See add-forge-user-agent.ts
-    'X-Forge-Context': appContextAri,
+async function pushEvent() {
+  const { jobId } = await queue.push({
+    body: {
+      hello: 'world'
+    }
+  });
 
-    Authorization: `Bearer ${token}`
-  };
-
-  init.headers = Object.assign(init.headers!, extraHeaders);
-  return fetch(url, init);
+  const jobProgress = queue.getJob(jobId);
+  const { success, inProgress, failed } = await jobProgress.getStats();
 }
+```
+
+### Consuming events from the queue
+
+```typescript
+import { AsyncEvent } from '@forge/events';
 
-async function demo() {
-  const queue = new Queue({key: "queue-name"}, apiClient);
-  const payloads = {
-    page: 1
+export async function eventListener(event: AsyncEvent, context) {
+  const jobProgress = queue.getJob(event.jobId);
+
+  try {
+    // process the event
+  } catch (error) {
+    await jobProgress.cancel();
   }
-  await queue.push([payloads])
 }
-
-demo();
 ```
+
+## Support
+
+See [Get help](https://developer.atlassian.com/platform/forge/get-help/) for how to get help and provide feedback.

package/out/__test__/jobProgress.test.js

@@ -5,9 +5,10 @@ const errors_1 = require("../errors");
 const jobProgress_1 = require("../jobProgress");
 const api_1 = require("@forge/api");
 jest.mock('@forge/api', () => ({
-    __requestAtlassianAsApp: (0, utils_1.getMockFetchMethod)('done', 200)
+    __requestAtlassianAsApp: (0, utils_1.getMockFetchMethod)({ done: true }, 200)
 }));
-const getJobProgress = (jobId, apiClientMock) => new jobProgress_1.JobProgress(jobId, apiClientMock);
+const queueParams = { key: 'test-queue-name' };
+const getJobProgress = (jobId, apiClientMock) => new jobProgress_1.JobProgress(queueParams, jobId, apiClientMock);
 describe('JobProgress methods', () => {
     describe('getStats', () => {
         it('should call the queue/stats endpoint', async () => {
@@ -16,9 +17,8 @@ describe('JobProgress methods', () => {
                 inProgress: 50,
                 failed: 1
             }, 200);
-            const jobProgress = getJobProgress('test-queue-name#test-job-id', apiClientMock);
-            const response = await jobProgress.getStats();
-            const { success, inProgress, failed } = await response.json();
+            const jobProgress = getJobProgress('test-job-id', apiClientMock);
+            const { success, inProgress, failed } = await jobProgress.getStats();
             (0, utils_1.verifyApiClientCalledWith)(apiClientMock, '/webhook/queue/stats/{contextAri}/{environmentId}/{appId}/{appVersion}', {
                 queueName: 'test-queue-name',
                 jobId: 'test-job-id'
@@ -32,7 +32,7 @@ describe('JobProgress methods', () => {
                 message: 'Job Not Found',
                 code: 404
             }, 404);
-            const jobProgress = getJobProgress('test-queue-name#test-job-id', apiClientMock);
+            const jobProgress = getJobProgress('test-job-id', apiClientMock);
             await expect(jobProgress.getStats()).rejects.toThrow(new errors_1.JobDoesNotExistError(`The job test-job-id was not found for the queue test-queue-name.`));
             (0, utils_1.verifyApiClientCalledWith)(apiClientMock, '/webhook/queue/stats/{contextAri}/{environmentId}/{appId}/{appVersion}', {
                 queueName: 'test-queue-name',
@@ -41,7 +41,7 @@ describe('JobProgress methods', () => {
         });
         it('should throw RateLimitError', async () => {
             const apiClientMock = (0, utils_1.getMockFetchMethod)({}, 429);
-            const jobProgress = getJobProgress('test-queue-name#test-job-id', apiClientMock);
+            const jobProgress = getJobProgress('test-job-id', apiClientMock);
             await expect(jobProgress.getStats()).rejects.toThrow(new errors_1.RateLimitError(`Too many requests.`));
             (0, utils_1.verifyApiClientCalledWith)(apiClientMock, '/webhook/queue/stats/{contextAri}/{environmentId}/{appId}/{appVersion}', {
                 queueName: 'test-queue-name',
@@ -54,7 +54,7 @@ describe('JobProgress methods', () => {
                 code: 513,
                 details: 'The request processing has failed because of an unknown error, exception or failure'
             }, 513);
-            const jobProgress = getJobProgress('test-queue-name#test-job-id', apiClientMock);
+            const jobProgress = getJobProgress('test-job-id', apiClientMock);
             await expect(jobProgress.getStats()).rejects.toThrow(new errors_1.InternalServerError(`513 Status Text: Service is not available`, 513));
             (0, utils_1.verifyApiClientCalledWith)(apiClientMock, '/webhook/queue/stats/{contextAri}/{environmentId}/{appId}/{appVersion}', {
                 queueName: 'test-queue-name',
@@ -65,20 +65,19 @@ describe('JobProgress methods', () => {
     describe('cancel', () => {
         it('should call the queue/cancel endpoint', async () => {
             const apiClientMock = (0, utils_1.getMockFetchMethod)({}, 204);
-            const jobProgress = getJobProgress('test-queue-name#test-job-id', apiClientMock);
-            const response = await jobProgress.cancel();
+            const jobProgress = getJobProgress('test-job-id', apiClientMock);
+            await jobProgress.cancel();
             (0, utils_1.verifyApiClientCalledWith)(apiClientMock, '/webhook/queue/cancel/{contextAri}/{environmentId}/{appId}/{appVersion}', {
                 queueName: 'test-queue-name',
                 jobId: 'test-job-id'
             });
-            expect(response.status).toEqual(204);
         });
         it('should throw JobDoesNotExistError', async () => {
             const apiClientMock = (0, utils_1.getMockFetchMethod)({
                 message: 'Job Not Found',
                 code: 404
             }, 404);
-            const jobProgress = getJobProgress('test-queue-name#test-job-id', apiClientMock);
+            const jobProgress = getJobProgress('test-job-id', apiClientMock);
             await expect(jobProgress.cancel()).rejects.toThrow(new errors_1.JobDoesNotExistError(`The job test-job-id was not found for the queue test-queue-name.`));
             (0, utils_1.verifyApiClientCalledWith)(apiClientMock, '/webhook/queue/cancel/{contextAri}/{environmentId}/{appId}/{appVersion}', {
                 queueName: 'test-queue-name',
@@ -90,7 +89,7 @@ describe('JobProgress methods', () => {
         const apiClientMock = (0, utils_1.getMockFetchMethod)({
             errors: ['jobId must not be null', 'queueName must not be null']
         }, 422);
-        const jobProgress = getJobProgress('test-queue-name#test-job-id', apiClientMock);
+        const jobProgress = getJobProgress('test-job-id', apiClientMock);
         await expect(jobProgress.getStats()).rejects.toThrow(new errors_1.InternalServerError(`422 Status Text: jobId must not be null, queueName must not be null`));
         (0, utils_1.verifyApiClientCalledWith)(apiClientMock, '/webhook/queue/stats/{contextAri}/{environmentId}/{appId}/{appVersion}', {
             queueName: 'test-queue-name',
@@ -103,16 +102,16 @@ describe('JobProgress methods', () => {
             inProgress: 50,
             failed: 1
         }, 200);
-        const jobProgress1 = getJobProgress('test-queue-name#', apiClientMock);
+        const jobProgress1 = getJobProgress('', apiClientMock);
         await expect(jobProgress1.getStats()).rejects.toThrow(new errors_1.JobDoesNotExistError(`jobId cannot be empty.`));
-        const jobProgress2 = getJobProgress('#test-job-id', apiClientMock);
+        const jobProgress2 = new jobProgress_1.JobProgress({ key: '!' }, 'test-job-id', apiClientMock);
         await expect(jobProgress2.getStats()).rejects.toThrow(new errors_1.InvalidQueueNameError('Queue names can only contain alphanumeric characters, dashes and underscores.'));
         const jobProgress3 = getJobProgress('', apiClientMock);
         await expect(jobProgress3.getStats()).rejects.toThrow(new errors_1.JobDoesNotExistError(`jobId cannot be empty.`));
         expect(apiClientMock).toHaveBeenCalledTimes(0);
     });
     it('requests stargate if no api client is provided', async () => {
-        const jobProgress = getJobProgress('test-queue-name#job-id');
+        const jobProgress = getJobProgress('job-id');
         await jobProgress.getStats();
         expect(api_1.__requestAtlassianAsApp).toHaveBeenCalledTimes(1);
     });

package/out/__test__/queue.test.js

@@ -16,20 +16,51 @@ describe('Queue methods', () => {
             expect(() => getQueue('invalid name', apiClientMock)).toThrowError(new errors_1.InvalidQueueNameError('Queue names can only contain alphanumeric characters, dashes and underscores.'));
         });
     });
+    const PAYLOAD = { body: { page: 1 } };
     describe('push', () => {
-        it('should call the queue/publish endpoint', async () => {
+        it.each([
+            ['single payload', PAYLOAD, [PAYLOAD]],
+            ['payload array', [PAYLOAD, PAYLOAD], [PAYLOAD, PAYLOAD]]
+        ])('should call the queue/publish endpoint when given %s', async (_, payload, expectedPayload) => {
             const apiClientMock = (0, utils_1.getMockFetchMethod)();
             const queue = getQueue('name', apiClientMock);
-            const payload = {
-                page: 1
-            };
-            await queue.push([payload]);
-            (0, utils_1.verifyApiClientCalledPushPathWith)(apiClientMock, [payload], 'name');
+            await queue.push(payload);
+            (0, utils_1.verifyApiClientCalledPushPathWith)(apiClientMock, expectedPayload, 'name');
+        });
+        it.each([
+            ['number', 1],
+            ['string', 'test'],
+            ['boolean', true],
+            ['array', [1, 2, 3]],
+            ['null', null],
+            ['undefined', undefined],
+            ['array with non-object', [1]],
+            ['array with an array', [[2, 3]]]
+        ])('rejects non-object (%s) event', async (_, payload) => {
+            const apiClientMock = (0, utils_1.getMockFetchMethod)();
+            const queue = getQueue('name', apiClientMock);
+            await expect(queue.push(payload)).rejects.toThrow(new errors_1.InvalidPayloadError(`Event must be an object.`));
+            expect(apiClientMock).toHaveBeenCalledTimes(0);
+        });
+        it.each([
+            ['number', 1],
+            ['string', 'test'],
+            ['boolean', true],
+            ['array', [1, 2, 3]],
+            ['null', null],
+            ['undefined', undefined],
+            ['array with non-object', [1]],
+            ['array with an array', [[2, 3]]]
+        ])('rejects non-object (%s) event body', async (_, body) => {
+            const apiClientMock = (0, utils_1.getMockFetchMethod)();
+            const queue = getQueue('name', apiClientMock);
+            await expect(queue.push({ body })).rejects.toThrow(new errors_1.InvalidPayloadError(`Event body must be an object.`));
+            expect(apiClientMock).toHaveBeenCalledTimes(0);
         });
         it('should throw InvalidPushSettingsError for delay', async () => {
             const apiClientMock = (0, utils_1.getMockFetchMethod)();
             const queue = getQueue('name', apiClientMock);
-            await expect(queue.push(1, { delayInSeconds: 901 })).rejects.toThrow(new errors_1.InvalidPushSettingsError(`The delayInSeconds setting must be between 0 and 900.`));
+            await expect(queue.push({ ...PAYLOAD, delayInSeconds: 901 })).rejects.toThrow(new errors_1.InvalidPushSettingsError(`The delayInSeconds setting must be between 0 and 900.`));
             expect(apiClientMock).toHaveBeenCalledTimes(0);
         });
         it('should throw NoEventsToPushError', async () => {
@@ -41,28 +72,26 @@ describe('Queue methods', () => {
         it('should throw TooManyEventsError', async () => {
             const apiClientMock = (0, utils_1.getMockFetchMethod)();
             const queue = getQueue('name', apiClientMock);
-            await expect(queue.push([...Array(51).keys()])).rejects.toThrow(new errors_1.TooManyEventsError(`This push contains more than the 50 events allowed.`));
+            await expect(queue.push(Array(51).fill(PAYLOAD))).rejects.toThrow(new errors_1.TooManyEventsError(`This push contains more than the 50 events allowed.`));
             expect(apiClientMock).toHaveBeenCalledTimes(0);
         });
         it('should throw PayloadTooBigError', async () => {
             const apiClientMock = (0, utils_1.getMockFetchMethod)();
             const queue = getQueue('name', apiClientMock);
-            await expect(queue.push('x'.repeat(201 * 1024))).rejects.toThrow(new errors_1.PayloadTooBigError(`The maximum payload size is 200KB.`));
+            await expect(queue.push({ body: { content: 'x'.repeat(201 * 1024) } })).rejects.toThrow(new errors_1.PayloadTooBigError(`The maximum payload size is 200KB.`));
             expect(apiClientMock).toHaveBeenCalledTimes(0);
         });
         it('should throw RateLimitError', async () => {
             const apiClientMock = (0, utils_1.getMockFetchMethod)({}, 429);
             const queue = getQueue('name', apiClientMock);
-            const payload = [...Array(10).keys()];
-            await expect(queue.push(payload)).rejects.toThrow(new errors_1.RateLimitError(`Too many requests.`));
-            (0, utils_1.verifyApiClientCalledPushPathWith)(apiClientMock, payload, 'name');
+            await expect(queue.push(PAYLOAD)).rejects.toThrow(new errors_1.RateLimitError(`Too many requests.`));
+            (0, utils_1.verifyApiClientCalledPushPathWith)(apiClientMock, [PAYLOAD], 'name');
         });
         it('should throw InvocationLimitReachedError', async () => {
             const apiClientMock = (0, utils_1.getMockFetchMethod)({}, 405);
             const queue = getQueue('name', apiClientMock);
-            const payload = [...Array(5).keys()];
-            await expect(queue.push(payload)).rejects.toThrow(new errors_1.InvocationLimitReachedError(`The limit on cyclic invocation has been reached.`));
-            (0, utils_1.verifyApiClientCalledPushPathWith)(apiClientMock, payload, 'name');
+            await expect(queue.push(PAYLOAD)).rejects.toThrow(new errors_1.InvocationLimitReachedError(`The limit on cyclic invocation has been reached.`));
+            (0, utils_1.verifyApiClientCalledPushPathWith)(apiClientMock, [PAYLOAD], 'name');
         });
         it('should throw PartialSuccessError when there are failed events', async () => {
             const apiClientMock = (0, utils_1.getMockFetchMethod)({
@@ -80,26 +109,36 @@ describe('Queue methods', () => {
             const queue = getQueue('name', apiClientMock);
             const payload = [
                 {
-                    content: 'payload-1'
+                    body: {
+                        content: 'payload-1'
+                    }
                 },
                 {
-                    content: 'payload-2'
+                    body: {
+                        content: 'payload-2'
+                    }
                 },
                 {
-                    content: 'payload-3'
+                    body: {
+                        content: 'payload-3'
+                    }
                 }
             ];
-            await expect(queue.push(payload)).rejects.toThrow(new errors_1.PartialSuccessError(`Failed to process 2 event(s).`, [
+            await expect(queue.push(payload)).rejects.toThrow(new errors_1.PartialSuccessError(`Failed to process 2 event(s).`, { jobId: 'some-job-id' }, [
                 {
                     errorMessage: 'failed-1',
-                    payload: {
-                        content: 'payload-1'
+                    event: {
+                        body: {
+                            content: 'payload-1'
+                        }
                     }
                 },
                 {
                     errorMessage: 'failed-3',
-                    payload: {
-                        content: 'payload-3'
+                    event: {
+                        body: {
+                            content: 'payload-3'
+                        }
                     }
                 }
             ]));
@@ -112,16 +151,22 @@ describe('Queue methods', () => {
             const queue = getQueue('name', apiClientMock);
             const payload = [
                 {
-                    content: 'payload-1'
+                    body: {
+                        content: 'payload-1'
+                    }
                 },
                 {
-                    content: 'payload-2'
+                    body: {
+                        content: 'payload-2'
+                    }
                 },
                 {
-                    content: 'payload-3'
+                    body: {
+                        content: 'payload-3'
+                    }
                 }
             ];
-            await expect(queue.push(payload)).rejects.toThrow(new errors_1.PartialSuccessError(`Failed to create stats for job name#12345`, []));
+            await expect(queue.push(payload)).rejects.toThrow(new errors_1.PartialSuccessError(`Failed to create stats for job name#12345`, { jobId: 'some-job-id' }, []));
             (0, utils_1.verifyApiClientCalledPushPathWith)(apiClientMock, payload, 'name');
         });
         it('should throw PartialSuccessError when there are failed events and backend failed to create job stats', async () => {
@@ -137,17 +182,23 @@ describe('Queue methods', () => {
             const queue = getQueue('name', apiClientMock);
             const payload = [
                 {
-                    content: 'payload-1'
+                    body: {
+                        content: 'payload-1'
+                    }
                 },
                 {
-                    content: 'payload-2'
+                    body: {
+                        content: 'payload-2'
+                    }
                 }
             ];
-            await expect(queue.push(payload)).rejects.toThrow(new errors_1.PartialSuccessError(`Failed to process 1 event(s). Failed to create stats for job name#12345`, [
+            await expect(queue.push(payload)).rejects.toThrow(new errors_1.PartialSuccessError(`Failed to process 1 event(s). Failed to create stats for job name#12345`, { jobId: 'some-job-id' }, [
                 {
                     errorMessage: 'failed-1',
-                    payload: {
-                        content: 'payload-1'
+                    event: {
+                        body: {
+                            content: 'payload-1'
+                        }
                     }
                 }
             ]));
@@ -160,20 +211,18 @@ describe('Queue methods', () => {
                 details: 'The request processing has failed because of an unknown error, exception or failure'
             }, 500);
             const queue = getQueue('name', apiClientMock);
-            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'));
-            (0, utils_1.verifyApiClientCalledPushPathWith)(apiClientMock, payload, 'name');
+            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'));
+            (0, utils_1.verifyApiClientCalledPushPathWith)(apiClientMock, [PAYLOAD], 'name');
         });
         it('should throw InternalServerError for error response without response body', async () => {
             const apiClientMock = (0, utils_1.getApiClientMockWithoutResponseBody)(504, 'Gateway Timeout');
             const queue = getQueue('name', apiClientMock);
-            const payload = [1];
-            await expect(queue.push(1)).rejects.toThrow(new errors_1.InternalServerError(`504 Gateway Timeout`, 504));
-            (0, utils_1.verifyApiClientCalledPushPathWith)(apiClientMock, payload, 'name');
+            await expect(queue.push(PAYLOAD)).rejects.toThrow(new errors_1.InternalServerError(`504 Gateway Timeout`, 504));
+            (0, utils_1.verifyApiClientCalledPushPathWith)(apiClientMock, [PAYLOAD], 'name');
         });
         it('requests stargate if no api client is provided', async () => {
             const queue = getQueue('queue');
-            await queue.push({ test: 'stargate' });
+            await queue.push({ body: { test: 'stargate' } });
             expect(api_1.__requestAtlassianAsApp).toHaveBeenCalledTimes(1);
         });
     });
@@ -182,7 +231,7 @@ describe('Queue methods', () => {
             const apiClientMock = (0, utils_1.getMockFetchMethod)();
             const queue = getQueue('name', apiClientMock);
             const jobProgress = queue.getJob('test-job-id');
-            expect(jobProgress).toEqual(new jobProgress_1.JobProgress('test-job-id', apiClientMock));
+            expect(jobProgress).toEqual(new jobProgress_1.JobProgress({ key: 'name' }, 'test-job-id', apiClientMock));
         });
     });
 });

package/out/__test__/utils.js

@@ -33,7 +33,7 @@ exports.verifyApiClientCalledWith = verifyApiClientCalledWith;
 const verifyApiClientCalledPushPathWith = (apiClientMock, payloads, name) => {
     (0, exports.verifyApiClientCalledWith)(apiClientMock, '/webhook/queue/publish/{contextAri}/{environmentId}/{appId}/{appVersion}', {
         queueName: name,
-        schema: 'ari:cloud:ecosystem::forge/app-event',
+        schema: 'ari:cloud:ecosystem::forge/app-event-2',
         type: 'avi:forge:app:event',
         payload: payloads
     });

package/out/errors.d.ts

@@ -1,35 +1,33 @@
-import { FailedEvent } from './types';
-export declare class InvalidPushSettingsError extends Error {
+import { FailedEvent, PushResult } from './types';
+export declare class EventsError extends Error {
     constructor(message: string);
 }
-export declare class InvalidQueueNameError extends Error {
-    constructor(message: string);
+export declare class InvalidPushSettingsError extends EventsError {
 }
-export declare class TooManyEventsError extends Error {
-    constructor(message: string);
+export declare class InvalidQueueNameError extends EventsError {
 }
-export declare class PayloadTooBigError extends Error {
-    constructor(message: string);
+export declare class InvalidPayloadError extends EventsError {
 }
-export declare class NoEventsToPushError extends Error {
-    constructor(message: string);
+export declare class TooManyEventsError extends EventsError {
 }
-export declare class RateLimitError extends Error {
-    constructor(message: string);
+export declare class PayloadTooBigError extends EventsError {
 }
-export declare class PartialSuccessError extends Error {
-    constructor(message: string, failedEvents: FailedEvent[]);
+export declare class NoEventsToPushError extends EventsError {
+}
+export declare class RateLimitError extends EventsError {
+}
+export declare class PartialSuccessError extends EventsError {
+    result: PushResult;
     failedEvents: FailedEvent[];
+    constructor(message: string, result: PushResult, failedEvents: FailedEvent[]);
 }
-export declare class InternalServerError extends Error {
+export declare class InternalServerError extends EventsError {
     constructor(message: string, errorCode?: number, details?: string);
     errorCode?: number;
     details?: string;
 }
-export declare class JobDoesNotExistError extends Error {
-    constructor(message: string);
+export declare class JobDoesNotExistError extends EventsError {
 }
-export declare class InvocationLimitReachedError extends Error {
-    constructor(message: string);
+export declare class InvocationLimitReachedError extends EventsError {
 }
 //# 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;gBACxC,OAAO,EAAE,MAAM;CAG5B"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAElD,qBAAa,WAAY,SAAQ,KAAK;gBACxB,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,wBAAyB,SAAQ,WAAW;CAAG;AAE5D,qBAAa,qBAAsB,SAAQ,WAAW;CAAG;AAEzD,qBAAa,mBAAoB,SAAQ,WAAW;CAAG;AAEvD,qBAAa,kBAAmB,SAAQ,WAAW;CAAG;AAEtD,qBAAa,kBAAmB,SAAQ,WAAW;CAAG;AAEtD,qBAAa,mBAAoB,SAAQ,WAAW;CAAG;AAEvD,qBAAa,cAAe,SAAQ,WAAW;CAAG;AAElD,qBAAa,mBAAoB,SAAQ,WAAW;IAGzC,MAAM,EAAE,UAAU;IAClB,YAAY,EAAE,WAAW,EAAE;gBAFlC,OAAO,EAAE,MAAM,EACR,MAAM,EAAE,UAAU,EAClB,YAAY,EAAE,WAAW,EAAE;CAIrC;AAED,qBAAa,mBAAoB,SAAQ,WAAW;gBACtC,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,WAAW;CAAG;AAExD,qBAAa,2BAA4B,SAAQ,WAAW;CAAG"}

package/out/errors.js

@@ -1,51 +1,44 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvocationLimitReachedError = exports.JobDoesNotExistError = exports.InternalServerError = exports.PartialSuccessError = exports.RateLimitError = exports.NoEventsToPushError = exports.PayloadTooBigError = exports.TooManyEventsError = exports.InvalidQueueNameError = exports.InvalidPushSettingsError = void 0;
-class InvalidPushSettingsError extends Error {
+exports.InvocationLimitReachedError = exports.JobDoesNotExistError = exports.InternalServerError = exports.PartialSuccessError = exports.RateLimitError = exports.NoEventsToPushError = exports.PayloadTooBigError = exports.TooManyEventsError = exports.InvalidPayloadError = exports.InvalidQueueNameError = exports.InvalidPushSettingsError = exports.EventsError = void 0;
+class EventsError extends Error {
     constructor(message) {
         super(message);
     }
 }
+exports.EventsError = EventsError;
+class InvalidPushSettingsError extends EventsError {
+}
 exports.InvalidPushSettingsError = InvalidPushSettingsError;
-class InvalidQueueNameError extends Error {
-    constructor(message) {
-        super(message);
-    }
+class InvalidQueueNameError extends EventsError {
 }
 exports.InvalidQueueNameError = InvalidQueueNameError;
-class TooManyEventsError extends Error {
-    constructor(message) {
-        super(message);
-    }
+class InvalidPayloadError extends EventsError {
+}
+exports.InvalidPayloadError = InvalidPayloadError;
+class TooManyEventsError extends EventsError {
 }
 exports.TooManyEventsError = TooManyEventsError;
-class PayloadTooBigError extends Error {
-    constructor(message) {
-        super(message);
-    }
+class PayloadTooBigError extends EventsError {
 }
 exports.PayloadTooBigError = PayloadTooBigError;
-class NoEventsToPushError extends Error {
-    constructor(message) {
-        super(message);
-    }
+class NoEventsToPushError extends EventsError {
 }
 exports.NoEventsToPushError = NoEventsToPushError;
-class RateLimitError extends Error {
-    constructor(message) {
-        super(message);
-    }
+class RateLimitError extends EventsError {
 }
 exports.RateLimitError = RateLimitError;
-class PartialSuccessError extends Error {
-    constructor(message, failedEvents) {
+class PartialSuccessError extends EventsError {
+    result;
+    failedEvents;
+    constructor(message, result, failedEvents) {
         super(message);
+        this.result = result;
         this.failedEvents = failedEvents;
     }
-    failedEvents;
 }
 exports.PartialSuccessError = PartialSuccessError;
-class InternalServerError extends Error {
+class InternalServerError extends EventsError {
     constructor(message, errorCode, details) {
         super(message);
         this.errorCode = errorCode;
@@ -55,15 +48,9 @@ class InternalServerError extends Error {
     details;
 }
 exports.InternalServerError = InternalServerError;
-class JobDoesNotExistError extends Error {
-    constructor(message) {
-        super(message);
-    }
+class JobDoesNotExistError extends EventsError {
 }
 exports.JobDoesNotExistError = JobDoesNotExistError;
-class InvocationLimitReachedError extends Error {
-    constructor(message) {
-        super(message);
-    }
+class InvocationLimitReachedError extends EventsError {
 }
 exports.InvocationLimitReachedError = InvocationLimitReachedError;

package/out/index.d.ts

@@ -1,9 +1,10 @@
 export { Queue } from './queue';
 export { InvalidQueueNameError, TooManyEventsError, PayloadTooBigError, NoEventsToPushError, RateLimitError, PartialSuccessError, InternalServerError, JobDoesNotExistError, InvalidPushSettingsError, InvocationLimitReachedError } from './errors';
-export { JobProgress } from './jobProgress';
+export { JobProgress, JobStats } from './jobProgress';
 export { QueueResponse } from './queueResponse';
 export { InvocationError } from './invocationError';
 export { InvocationErrorCode } from './invocationErrorCode';
 export { RetryOptions } from './retryOptions';
+export { AsyncEvent, PushEvent, PushResult } from './types';
 export { appEvents, AppEvent, AppEventPublishResult, AppEventPublishSuccess, AppEventPublishFailure, AppEventPublishError, AppEventErrorType } from './appEvents';
 //# 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;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EACL,SAAS,EACT,QAAQ,EACR,qBAAqB,EACrB,sBAAsB,EACtB,sBAAsB,EACtB,oBAAoB,EACpB,iBAAiB,EAClB,MAAM,aAAa,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,QAAQ,EAAE,MAAM,eAAe,CAAC;AACtD,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;AAC9C,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAC5D,OAAO,EACL,SAAS,EACT,QAAQ,EACR,qBAAqB,EACrB,sBAAsB,EACtB,sBAAsB,EACtB,oBAAoB,EACpB,iBAAiB,EAClB,MAAM,aAAa,CAAC"}

package/out/jobProgress.d.ts

@@ -1,9 +1,16 @@
-import { FetchMethod, APIResponse } from '@forge/api';
+import { FetchMethod } from '@forge/api';
+import { QueueParams } from './types';
+export declare type JobStats = {
+    success: number;
+    inProgress: number;
+    failed: number;
+};
 export declare class JobProgress {
+    private readonly queueParams;
     private readonly id;
     private readonly apiClient;
-    constructor(id: string, apiClient?: FetchMethod);
-    getStats(): Promise<APIResponse>;
-    cancel(): Promise<APIResponse>;
+    constructor(queueParams: QueueParams, id: string, apiClient?: FetchMethod);
+    getStats(): Promise<JobStats>;
+    cancel(): Promise<void>;
 }
 //# 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":"AAAA,OAAO,EAA2B,WAAW,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAU/E,qBAAa,WAAW;IAEpB,OAAO,CAAC,QAAQ,CAAC,EAAE;IACnB,OAAO,CAAC,QAAQ,CAAC,SAAS;gBADT,EAAE,EAAE,MAAM,EACV,SAAS,GAAE,WAAqC;IAG7D,QAAQ,IAAI,OAAO,CAAC,WAAW,CAAC;IAehC,MAAM,IAAI,OAAO,CAAC,WAAW,CAAC;CAcrC"}
+{"version":3,"file":"jobProgress.d.ts","sourceRoot":"","sources":["../src/jobProgress.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2B,WAAW,EAAE,MAAM,YAAY,CAAC;AAQlE,OAAO,EAAqC,WAAW,EAAE,MAAM,SAAS,CAAC;AAEzE,oBAAY,QAAQ,GAAG;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,qBAAa,WAAW;IAEpB,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,EAAE;IACnB,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAFT,WAAW,EAAE,WAAW,EACxB,EAAE,EAAE,MAAM,EACV,SAAS,GAAE,WAAqC;IAG7D,QAAQ,IAAI,OAAO,CAAC,QAAQ,CAAC;IAe7B,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CAY9B"}