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

package/out/text.js

@@ -4,6 +4,8 @@ exports.Text = void 0;
 exports.Text = {
     error: {
         invalidQueueName: `Queue names can only contain alphanumeric characters, dashes and underscores.`,
+        invalidEvent: `Event must be an object.`,
+        invalidEventBody: `Event body must be an object.`,
         invalidDelayInSecondsSetting: `The delayInSeconds setting must be between 0 and 900.`,
         maxEventsAllowed: (maxEventsCount) => `This push contains more than the ${maxEventsCount} events allowed.`,
         maxPayloadAllowed: (maxPayloadSize) => `The maximum payload size is ${maxPayloadSize}KB.`,

package/out/types.d.ts

@@ -1,26 +1,41 @@
-export declare type Payload = string | number | boolean | {
-    [key: string]: Payload;
-};
-export interface PushSettings {
-    delayInSeconds: number;
-}
+import { InvocationErrorCode } from './invocationErrorCode';
+export declare type Payload = Record<string, unknown>;
 export interface QueueParams {
     key: string;
 }
 export interface PushRequest extends APIRequest {
-    payload: Payload[];
+    payload: PushEvent[];
     schema: string;
     type: string;
-    delayInSeconds?: number;
+    jobId: string;
 }
 export interface APIRequest {
     queueName: string;
     jobId: string;
     time: string;
 }
+export interface PushEvent {
+    body: Body;
+    delayInSeconds?: number;
+}
+export declare type Body = Record<string, unknown>;
+export interface PushResult {
+    jobId: string;
+}
 export interface FailedEvent {
     errorMessage: string;
-    payload: Payload;
+    event: PushEvent;
+}
+export interface AsyncEvent extends PushEvent {
+    queueName: string;
+    jobId: string;
+    eventId: string;
+    retryContext?: RetryContext;
+}
+export interface RetryContext {
+    retryCount: number;
+    retryReason: InvocationErrorCode;
+    retryData: any;
 }
 export declare type GetStatsRequest = APIRequest;
 export declare type CancelJobRequest = APIRequest;

package/out/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,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"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,oBAAY,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE9C,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,OAAO,EAAE,SAAS,EAAE,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,UAAU;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,IAAI,CAAC;IACX,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,oBAAY,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE3C,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,SAAS,CAAC;CAClB;AAED,MAAM,WAAW,UAAW,SAAQ,SAAS;IAC3C,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B;AAED,MAAM,WAAW,YAAY;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,mBAAmB,CAAC;IACjC,SAAS,EAAE,GAAG,CAAC;CAChB;AAED,oBAAY,eAAe,GAAG,UAAU,CAAC;AACzC,oBAAY,gBAAgB,GAAG,UAAU,CAAC"}

package/out/validators.d.ts

@@ -1,12 +1,12 @@
 import { APIResponse } from '@forge/api';
-import { CancelJobRequest, GetStatsRequest, Payload, PushRequest, PushSettings } from './types';
+import { CancelJobRequest, GetStatsRequest, PushEvent, PushRequest, PushResult } 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 validatePushSettings: (event: PushEvent) => void;
+export declare function validatePushEvents(arg: PushEvent | PushEvent[]): PushEvent[];
 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 validatePushAPIResponse: (requestBody: PushRequest, response: APIResponse, result: PushResult) => 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,MAAM,YAAY,CAAC;AAczC,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAMhG,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"}
+{"version":3,"file":"validators.d.ts","sourceRoot":"","sources":["../src/validators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAezC,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,SAAS,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAMhG,eAAO,MAAM,gBAAgB,cAAe,MAAM,SAIjD,CAAC;AAEF,eAAO,MAAM,oBAAoB,UAAW,SAAS,SAIpD,CAAC;AAEF,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,SAAS,GAAG,SAAS,EAAE,GAAG,SAAS,EAAE,CA6B5E;AAED,eAAO,MAAM,uBAAuB,oBAAqB,eAAe,SAKvE,CAAC;AAEF,eAAO,MAAM,wBAAwB,qBAAsB,gBAAgB,SAK1E,CAAC;AAEF,eAAO,MAAM,mBAAmB,aAAoB,WAAW,yBAAyB,MAAM,kBA6B7F,CAAC;AAEF,eAAO,MAAM,uBAAuB,gBAAuB,WAAW,YAAY,WAAW,UAAU,UAAU,kBAkChH,CAAC;AAEF,eAAO,MAAM,2BAA2B,aAAoB,WAAW,mBAAmB,eAAe,kBAMxG,CAAC;AAEF,eAAO,MAAM,4BAA4B,aAAoB,WAAW,oBAAoB,eAAe,kBAM1G,CAAC"}

package/out/validators.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateCancelJobAPIResponse = exports.validateGetStatsAPIResponse = exports.validatePushAPIResponse = exports.validateAPIResponse = exports.validateCancelJobRequest = exports.validateGetStatsPayload = exports.validatePushPayloads = exports.validatePushSettings = exports.validateQueueKey = void 0;
+exports.validateCancelJobAPIResponse = exports.validateGetStatsAPIResponse = exports.validatePushAPIResponse = exports.validateAPIResponse = exports.validateCancelJobRequest = exports.validateGetStatsPayload = exports.validatePushEvents = 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-_]+$/;
@@ -12,25 +12,36 @@ const validateQueueKey = (queueName) => {
     }
 };
 exports.validateQueueKey = validateQueueKey;
-const validatePushSettings = (settings) => {
-    if ((settings.delayInSeconds && settings.delayInSeconds > 900) || settings.delayInSeconds < 0) {
+const validatePushSettings = (event) => {
+    if ((event.delayInSeconds && event.delayInSeconds > 900) || (event.delayInSeconds && event.delayInSeconds < 0)) {
         throw new errors_1.InvalidPushSettingsError(text_1.Text.error.invalidDelayInSecondsSetting);
     }
 };
 exports.validatePushSettings = validatePushSettings;
-const validatePushPayloads = (payloads) => {
-    if (!payloads || (Array.isArray(payloads) && payloads.length === 0)) {
+function validatePushEvents(arg) {
+    const events = Array.isArray(arg) ? arg : [arg];
+    if (events.length === 0) {
         throw new errors_1.NoEventsToPushError(text_1.Text.error.noEventsPushed);
     }
-    if (Array.isArray(payloads) && payloads.length > MAXIMUM_EVENTS) {
+    if (events.length > MAXIMUM_EVENTS) {
         throw new errors_1.TooManyEventsError(text_1.Text.error.maxEventsAllowed(MAXIMUM_EVENTS));
     }
-    const payloadSizeKB = Buffer.byteLength(JSON.stringify(payloads)) / 1024;
+    for (const event of events) {
+        if (typeof event !== 'object' || Array.isArray(event) || event === null) {
+            throw new errors_1.InvalidPayloadError(text_1.Text.error.invalidEvent);
+        }
+        if (typeof event.body !== 'object' || Array.isArray(event.body) || event.body === null) {
+            throw new errors_1.InvalidPayloadError(text_1.Text.error.invalidEventBody);
+        }
+        (0, exports.validatePushSettings)(event);
+    }
+    const payloadSizeKB = Buffer.byteLength(JSON.stringify(events)) / 1024;
     if (payloadSizeKB > MAXIMUM_PAYLOAD_SIZE_KB) {
         throw new errors_1.PayloadTooBigError(text_1.Text.error.maxPayloadAllowed(MAXIMUM_PAYLOAD_SIZE_KB));
     }
-};
-exports.validatePushPayloads = validatePushPayloads;
+    return events;
+}
+exports.validatePushEvents = validatePushEvents;
 const validateGetStatsPayload = (getStatsRequest) => {
     if (!getStatsRequest.jobId) {
         throw new errors_1.JobDoesNotExistError(text_1.Text.error.jobIdEmpty);
@@ -67,7 +78,7 @@ const validateAPIResponse = async (response, expectedSuccessStatus) => {
     }
 };
 exports.validateAPIResponse = validateAPIResponse;
-const validatePushAPIResponse = async (response, requestBody) => {
+const validatePushAPIResponse = async (requestBody, response, result) => {
     if (response.status === 413) {
         const responseBody = await response.json();
         throw new errors_1.PayloadTooBigError(responseBody.errorMessage);
@@ -75,7 +86,7 @@ const validatePushAPIResponse = async (response, requestBody) => {
     if (response.status === 202) {
         const responseBody = await response.json();
         const defaultErrorMessage = 'Failed to process some events.';
-        const partialSuccessError = new errors_1.PartialSuccessError(defaultErrorMessage, []);
+        const partialSuccessError = new errors_1.PartialSuccessError(defaultErrorMessage, result, []);
         if (responseBody.failedEvents && responseBody.failedEvents.length > 0) {
             partialSuccessError.message = `Failed to process ${responseBody.failedEvents.length} event(s).`;
             partialSuccessError.failedEvents = responseBody.failedEvents.map((failedEvent) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/events",
-  "version": "1.1.0-next.0",
+  "version": "2.0.0-next.1",
   "description": "Forge Async Event methods",
   "author": "Atlassian",
   "license": "SEE LICENSE IN LICENSE.txt",

package/src/__test__/jobProgress.test.ts

@@ -4,7 +4,7 @@ import { JobProgress } from '../jobProgress';
 import { __requestAtlassianAsApp } from '@forge/api';
 
 jest.mock('@forge/api', () => ({
-  __requestAtlassianAsApp: getMockFetchMethod('done', 200)
+  __requestAtlassianAsApp: getMockFetchMethod({ done: true }, 200)
 }));
 
 const getJobProgress = (jobId: string, apiClientMock?: any) => new JobProgress(jobId, apiClientMock);
@@ -21,8 +21,7 @@ describe('JobProgress methods', () => {
         200
       );
       const jobProgress = getJobProgress('test-queue-name#test-job-id', apiClientMock);
-      const response = await jobProgress.getStats();
-      const { success, inProgress, failed } = await response.json();
+      const { success, inProgress, failed } = await jobProgress.getStats();
       verifyApiClientCalledWith(
         apiClientMock,
         '/webhook/queue/stats/{contextAri}/{environmentId}/{appId}/{appVersion}',
@@ -100,7 +99,7 @@ describe('JobProgress methods', () => {
     it('should call the queue/cancel endpoint', async () => {
       const apiClientMock = getMockFetchMethod({}, 204);
       const jobProgress = getJobProgress('test-queue-name#test-job-id', apiClientMock);
-      const response = await jobProgress.cancel();
+      await jobProgress.cancel();
       verifyApiClientCalledWith(
         apiClientMock,
         '/webhook/queue/cancel/{contextAri}/{environmentId}/{appId}/{appVersion}',
@@ -109,7 +108,6 @@ describe('JobProgress methods', () => {
           jobId: 'test-job-id'
         }
       );
-      expect(response.status).toEqual(204);
     });
 
     it('should throw JobDoesNotExistError', async () => {

package/src/__test__/queue.test.ts

@@ -1,6 +1,7 @@
 import {
   InternalServerError,
   InvalidQueueNameError,
+  InvalidPayloadError,
   NoEventsToPushError,
   PartialSuccessError,
   PayloadTooBigError,
@@ -30,21 +31,57 @@ describe('Queue methods', () => {
     });
   });
 
+  const PAYLOAD = { body: { page: 1 } } as const;
+
   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 = getMockFetchMethod();
+      const queue = getQueue('name', apiClientMock);
+      await queue.push(payload);
+      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 = getMockFetchMethod();
+      const queue = getQueue('name', apiClientMock);
+      // @ts-expect-error Testing invalid payload type on purpose
+      await expect(queue.push(payload)).rejects.toThrow(new 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 = getMockFetchMethod();
       const queue = getQueue('name', apiClientMock);
-      const payload = {
-        page: 1
-      };
-      await queue.push([payload]);
-      verifyApiClientCalledPushPathWith(apiClientMock, [payload], 'name');
+      // @ts-expect-error Testing invalid payload type on purpose
+      await expect(queue.push({ body })).rejects.toThrow(new InvalidPayloadError(`Event body must be an object.`));
+      expect(apiClientMock).toHaveBeenCalledTimes(0);
     });
 
     it('should throw InvalidPushSettingsError for delay', async () => {
       const apiClientMock = getMockFetchMethod();
       const queue = getQueue('name', apiClientMock);
-      await expect(queue.push(1, { delayInSeconds: 901 })).rejects.toThrow(
+      await expect(queue.push({ ...PAYLOAD, delayInSeconds: 901 })).rejects.toThrow(
         new InvalidPushSettingsError(`The delayInSeconds setting must be between 0 and 900.`)
       );
       expect(apiClientMock).toHaveBeenCalledTimes(0);
@@ -60,7 +97,7 @@ describe('Queue methods', () => {
     it('should throw TooManyEventsError', async () => {
       const apiClientMock = getMockFetchMethod();
       const queue = getQueue('name', apiClientMock);
-      await expect(queue.push([...Array(51).keys()])).rejects.toThrow(
+      await expect(queue.push(Array(51).fill(PAYLOAD))).rejects.toThrow(
         new TooManyEventsError(`This push contains more than the 50 events allowed.`)
       );
       expect(apiClientMock).toHaveBeenCalledTimes(0);
@@ -69,7 +106,7 @@ describe('Queue methods', () => {
     it('should throw PayloadTooBigError', async () => {
       const apiClientMock = getMockFetchMethod();
       const queue = getQueue('name', apiClientMock);
-      await expect(queue.push('x'.repeat(201 * 1024))).rejects.toThrow(
+      await expect(queue.push({ body: { content: 'x'.repeat(201 * 1024) } })).rejects.toThrow(
         new PayloadTooBigError(`The maximum payload size is 200KB.`)
       );
       expect(apiClientMock).toHaveBeenCalledTimes(0);
@@ -78,19 +115,17 @@ describe('Queue methods', () => {
     it('should throw RateLimitError', async () => {
       const apiClientMock = getMockFetchMethod({}, 429);
       const queue = getQueue('name', apiClientMock);
-      const payload = [...Array(10).keys()];
-      await expect(queue.push(payload)).rejects.toThrow(new RateLimitError(`Too many requests.`));
-      verifyApiClientCalledPushPathWith(apiClientMock, payload, 'name');
+      await expect(queue.push(PAYLOAD)).rejects.toThrow(new RateLimitError(`Too many requests.`));
+      verifyApiClientCalledPushPathWith(apiClientMock, [PAYLOAD], 'name');
     });
 
     it('should throw InvocationLimitReachedError', async () => {
       const apiClientMock = getMockFetchMethod({}, 405);
       const queue = getQueue('name', apiClientMock);
-      const payload = [...Array(5).keys()];
-      await expect(queue.push(payload)).rejects.toThrow(
+      await expect(queue.push(PAYLOAD)).rejects.toThrow(
         new InvocationLimitReachedError(`The limit on cyclic invocation has been reached.`)
       );
-      verifyApiClientCalledPushPathWith(apiClientMock, payload, 'name');
+      verifyApiClientCalledPushPathWith(apiClientMock, [PAYLOAD], 'name');
     });
 
     it('should throw PartialSuccessError when there are failed events', async () => {
@@ -112,27 +147,37 @@ 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 PartialSuccessError(`Failed to process 2 event(s).`, [
+        new 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'
+              }
             }
           }
         ])
@@ -150,17 +195,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'
+          }
         },
         {
-          content: 'payload-3'
+          body: {
+            content: 'payload-3'
+          }
         }
       ];
       await expect(queue.push(payload)).rejects.toThrow(
-        new PartialSuccessError(`Failed to create stats for job name#12345`, [])
+        new PartialSuccessError(`Failed to create stats for job name#12345`, { jobId: 'some-job-id' }, [])
       );
       verifyApiClientCalledPushPathWith(apiClientMock, payload, 'name');
     });
@@ -181,21 +232,31 @@ 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 PartialSuccessError(`Failed to process 1 event(s). Failed to create stats for job name#12345`, [
-          {
-            errorMessage: 'failed-1',
-            payload: {
-              content: 'payload-1'
+        new PartialSuccessError(
+          `Failed to process 1 event(s). Failed to create stats for job name#12345`,
+          { jobId: 'some-job-id' },
+          [
+            {
+              errorMessage: 'failed-1',
+              event: {
+                body: {
+                  content: 'payload-1'
+                }
+              }
             }
-          }
-        ])
+          ]
+        )
       );
       verifyApiClientCalledPushPathWith(apiClientMock, payload, 'name');
     });
@@ -210,28 +271,26 @@ describe('Queue methods', () => {
         500
       );
       const queue = getQueue('name', apiClientMock);
-      const payload = [...Array(9).keys()];
-      await expect(queue.push(payload)).rejects.toThrow(
+      await expect(queue.push(PAYLOAD)).rejects.toThrow(
         new InternalServerError(
           `500 Status Text: AWS SQS timed out`,
           500,
           'The request processing has failed because of an unknown error, exception or failure'
         )
       );
-      verifyApiClientCalledPushPathWith(apiClientMock, payload, 'name');
+      verifyApiClientCalledPushPathWith(apiClientMock, [PAYLOAD], 'name');
     });
 
     it('should throw InternalServerError for error response without response body', async () => {
       const apiClientMock = getApiClientMockWithoutResponseBody(504, 'Gateway Timeout');
       const queue = getQueue('name', apiClientMock);
-      const payload = [1];
-      await expect(queue.push(1)).rejects.toThrow(new InternalServerError(`504 Gateway Timeout`, 504));
-      verifyApiClientCalledPushPathWith(apiClientMock, payload, 'name');
+      await expect(queue.push(PAYLOAD)).rejects.toThrow(new InternalServerError(`504 Gateway Timeout`, 504));
+      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(__requestAtlassianAsApp).toHaveBeenCalledTimes(1);
     });
   });

package/src/__test__/utils.ts

@@ -40,7 +40,7 @@ export const verifyApiClientCalledPushPathWith = (
 ) => {
   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/src/errors.ts

@@ -1,51 +1,36 @@
-import { FailedEvent } from './types';
+import { FailedEvent, PushResult } from './types';
 
-export class InvalidPushSettingsError extends Error {
+export class EventsError extends Error {
   constructor(message: string) {
     super(message);
   }
 }
 
-export class InvalidQueueNameError extends Error {
-  constructor(message: string) {
-    super(message);
-  }
-}
+export class InvalidPushSettingsError extends EventsError {}
 
-export class TooManyEventsError extends Error {
-  constructor(message: string) {
-    super(message);
-  }
-}
+export class InvalidQueueNameError extends EventsError {}
 
-export class PayloadTooBigError extends Error {
-  constructor(message: string) {
-    super(message);
-  }
-}
+export class InvalidPayloadError extends EventsError {}
 
-export class NoEventsToPushError extends Error {
-  constructor(message: string) {
-    super(message);
-  }
-}
+export class TooManyEventsError extends EventsError {}
 
-export class RateLimitError extends Error {
-  constructor(message: string) {
-    super(message);
-  }
-}
+export class PayloadTooBigError extends EventsError {}
 
-export class PartialSuccessError extends Error {
-  constructor(message: string, failedEvents: FailedEvent[]) {
+export class NoEventsToPushError extends EventsError {}
+
+export class RateLimitError extends EventsError {}
+
+export class PartialSuccessError extends EventsError {
+  constructor(
+    message: string,
+    public result: PushResult,
+    public failedEvents: FailedEvent[]
+  ) {
     super(message);
-    this.failedEvents = failedEvents;
   }
-
-  failedEvents: FailedEvent[];
 }
 
-export class InternalServerError extends Error {
+export class InternalServerError extends EventsError {
   constructor(message: string, errorCode?: number, details?: string) {
     super(message);
     this.errorCode = errorCode;
@@ -56,14 +41,6 @@ export class InternalServerError extends Error {
   details?: string;
 }
 
-export class JobDoesNotExistError extends Error {
-  constructor(message: string) {
-    super(message);
-  }
-}
+export class JobDoesNotExistError extends EventsError {}
 
-export class InvocationLimitReachedError extends Error {
-  constructor(message: string) {
-    super(message);
-  }
-}
+export class InvocationLimitReachedError extends EventsError {}

package/src/index.ts

@@ -11,11 +11,12 @@ export {
   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,

package/src/jobProgress.ts

@@ -1,4 +1,4 @@
-import { __requestAtlassianAsApp, FetchMethod, APIResponse } from '@forge/api';
+import { __requestAtlassianAsApp, FetchMethod } from '@forge/api';
 import { CANCEL_JOB_PATH, GET_STATS_PATH, post } from './queries';
 import {
   validateCancelJobAPIResponse,
@@ -8,13 +8,19 @@ import {
 } from './validators';
 import { CancelJobRequest, GetStatsRequest } from './types';
 
+export type JobStats = {
+  success: number;
+  inProgress: number;
+  failed: number;
+};
+
 export class JobProgress {
   constructor(
     private readonly id: string,
     private readonly apiClient: FetchMethod = __requestAtlassianAsApp
   ) {}
 
-  async getStats(): Promise<APIResponse> {
+  async getStats(): Promise<JobStats> {
     const [queueName, jobId] = this.id.split('#');
     const getStatsRequest: GetStatsRequest = {
       queueName: queueName,
@@ -26,10 +32,11 @@ export class JobProgress {
 
     const response = await post(GET_STATS_PATH, getStatsRequest, this.apiClient);
     await validateGetStatsAPIResponse(response, getStatsRequest);
-    return response;
+    const { success, inProgress, failed } = await response.json();
+    return { success, inProgress, failed };
   }
 
-  async cancel(): Promise<APIResponse> {
+  async cancel(): Promise<void> {
     const [queueName, jobId] = this.id.split('#');
     const cancelJobRequest: CancelJobRequest = {
       queueName: queueName,
@@ -41,6 +48,5 @@ export class JobProgress {
 
     const response = await post(CANCEL_JOB_PATH, cancelJobRequest, this.apiClient);
     await validateCancelJobAPIResponse(response, cancelJobRequest);
-    return response;
   }
 }