@forge/events 1.0.3 → 2.0.0-next.1

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,8 +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"}
+{"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/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvocationErrorCode = exports.InvocationError = exports.QueueResponse = exports.JobProgress = exports.InvocationLimitReachedError = exports.InvalidPushSettingsError = exports.JobDoesNotExistError = exports.InternalServerError = exports.PartialSuccessError = exports.RateLimitError = exports.NoEventsToPushError = exports.PayloadTooBigError = exports.TooManyEventsError = exports.InvalidQueueNameError = exports.Queue = void 0;
+exports.appEvents = exports.InvocationErrorCode = exports.InvocationError = exports.QueueResponse = exports.JobProgress = exports.InvocationLimitReachedError = exports.InvalidPushSettingsError = exports.JobDoesNotExistError = exports.InternalServerError = exports.PartialSuccessError = exports.RateLimitError = exports.NoEventsToPushError = exports.PayloadTooBigError = exports.TooManyEventsError = exports.InvalidQueueNameError = exports.Queue = void 0;
 var queue_1 = require("./queue");
 Object.defineProperty(exports, "Queue", { enumerable: true, get: function () { return queue_1.Queue; } });
 var errors_1 = require("./errors");
@@ -22,3 +22,5 @@ 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 appEvents_1 = require("./appEvents");
+Object.defineProperty(exports, "appEvents", { enumerable: true, get: function () { return appEvents_1.appEvents; } });

package/out/jobProgress.d.ts

@@ -1,9 +1,14 @@
-import { FetchMethod, APIResponse } from '@forge/api';
+import { FetchMethod } from '@forge/api';
+export declare type JobStats = {
+    success: number;
+    inProgress: number;
+    failed: number;
+};
 export declare class JobProgress {
     private readonly id;
     private readonly apiClient;
     constructor(id: string, apiClient?: FetchMethod);
-    getStats(): Promise<APIResponse>;
-    cancel(): Promise<APIResponse>;
+    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;AAUlE,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,EAAE;IACnB,OAAO,CAAC,QAAQ,CAAC,SAAS;gBADT,EAAE,EAAE,MAAM,EACV,SAAS,GAAE,WAAqC;IAG7D,QAAQ,IAAI,OAAO,CAAC,QAAQ,CAAC;IAgB7B,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CAa9B"}

package/out/jobProgress.js

@@ -21,7 +21,8 @@ class JobProgress {
         (0, validators_1.validateGetStatsPayload)(getStatsRequest);
         const response = await (0, queries_1.post)(queries_1.GET_STATS_PATH, getStatsRequest, this.apiClient);
         await (0, validators_1.validateGetStatsAPIResponse)(response, getStatsRequest);
-        return response;
+        const { success, inProgress, failed } = await response.json();
+        return { success, inProgress, failed };
     }
     async cancel() {
         const [queueName, jobId] = this.id.split('#');
@@ -33,7 +34,6 @@ class JobProgress {
         (0, validators_1.validateCancelJobRequest)(cancelJobRequest);
         const response = await (0, queries_1.post)(queries_1.CANCEL_JOB_PATH, cancelJobRequest, this.apiClient);
         await (0, validators_1.validateCancelJobAPIResponse)(response, cancelJobRequest);
-        return response;
     }
 }
 exports.JobProgress = JobProgress;

package/out/queries.d.ts

@@ -1,7 +1,6 @@
 import { APIResponse, FetchMethod } from '@forge/api';
-import { APIRequest } from './types';
 export declare const PUSH_PATH = "/webhook/queue/publish/{contextAri}/{environmentId}/{appId}/{appVersion}";
 export declare const GET_STATS_PATH = "/webhook/queue/stats/{contextAri}/{environmentId}/{appId}/{appVersion}";
 export declare const CANCEL_JOB_PATH = "/webhook/queue/cancel/{contextAri}/{environmentId}/{appId}/{appVersion}";
-export declare const post: (endpoint: string, body: APIRequest, apiClient: FetchMethod) => Promise<APIResponse>;
+export declare const post: (endpoint: string, body: unknown, 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,WAAW,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,eAAO,MAAM,SAAS,6EAA6E,CAAC;AACpG,eAAO,MAAM,cAAc,2EAA2E,CAAC;AACvG,eAAO,MAAM,eAAe,4EAA4E,CAAC;AAEzG,eAAO,MAAM,IAAI,aAAoB,MAAM,QAAQ,UAAU,aAAa,WAAW,KAAG,QAAQ,WAAW,CAU1G,CAAC"}
+{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../src/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEtD,eAAO,MAAM,SAAS,6EAA6E,CAAC;AACpG,eAAO,MAAM,cAAc,2EAA2E,CAAC;AACvG,eAAO,MAAM,eAAe,4EAA4E,CAAC;AAEzG,eAAO,MAAM,IAAI,aAAoB,MAAM,QAAQ,OAAO,aAAa,WAAW,KAAG,QAAQ,WAAW,CAUvG,CAAC"}

package/out/queue.d.ts

@@ -1,11 +1,11 @@
 import { FetchMethod } from '@forge/api';
-import { Payload, QueueParams, PushSettings } from './types';
+import { QueueParams, PushEvent, PushResult } from './types';
 import { JobProgress } from './jobProgress';
 export declare class Queue {
     private readonly queueParams;
     private readonly apiClient;
     constructor(queueParams: QueueParams, apiClient?: FetchMethod);
-    push(payloads: Payload | Payload[], pushSettings?: PushSettings): Promise<string>;
+    push(events: PushEvent | PushEvent[]): Promise<PushResult>;
     getJob(jobId: string): JobProgress;
 }
 //# sourceMappingURL=queue.d.ts.map

package/out/queue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queue.d.ts","sourceRoot":"","sources":["../src/queue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAA2B,MAAM,YAAY,CAAC;AAGlE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,YAAY,EAAe,MAAM,SAAS,CAAC;AAE1E,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,qBAAa,KAAK;IAEd,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,SAAS;gBADT,WAAW,EAAE,WAAW,EACxB,SAAS,GAAE,WAAqC;IAK7D,IAAI,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,EAAE,EAAE,YAAY,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IA0BvF,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;CAGnC"}
+{"version":3,"file":"queue.d.ts","sourceRoot":"","sources":["../src/queue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAA2B,MAAM,YAAY,CAAC;AAGlE,OAAO,EAAE,WAAW,EAAE,SAAS,EAAe,UAAU,EAAE,MAAM,SAAS,CAAC;AAE1E,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,qBAAa,KAAK;IAEd,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,SAAS;gBADT,WAAW,EAAE,WAAW,EACxB,SAAS,GAAE,WAAqC;IAK7D,IAAI,CAAC,MAAM,EAAE,SAAS,GAAG,SAAS,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC;IAoBhE,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;CAGnC"}

package/out/queue.js

@@ -14,27 +14,22 @@ class Queue {
         this.apiClient = apiClient;
         (0, validators_1.validateQueueKey)(this.queueParams.key);
     }
-    async push(payloads, pushSettings) {
-        (0, validators_1.validatePushPayloads)(payloads);
+    async push(events) {
+        const validEvents = (0, validators_1.validatePushEvents)(events);
         const queueName = this.queueParams.key;
         const jobId = (0, uuid_1.v4)();
         const pushRequest = {
             queueName: queueName,
             jobId: jobId,
             type: 'avi:forge:app:event',
-            schema: 'ari:cloud:ecosystem::forge/app-event',
-            payload: Array.isArray(payloads) ? payloads : [payloads],
+            schema: 'ari:cloud:ecosystem::forge/app-event-2',
+            payload: validEvents,
             time: new Date().toISOString()
         };
-        if (pushSettings) {
-            (0, validators_1.validatePushSettings)(pushSettings);
-            if (pushSettings.delayInSeconds) {
-                pushRequest.delayInSeconds = pushSettings.delayInSeconds;
-            }
-        }
         const response = await (0, queries_1.post)(queries_1.PUSH_PATH, pushRequest, this.apiClient);
-        await (0, validators_1.validatePushAPIResponse)(response, pushRequest);
-        return `${queueName}#${jobId}`;
+        const result = { jobId };
+        await (0, validators_1.validatePushAPIResponse)(pushRequest, response, result);
+        return result;
     }
     getJob(jobId) {
         return new jobProgress_1.JobProgress(jobId, this.apiClient);

package/out/text.d.ts

@@ -1,6 +1,8 @@
 export declare const Text: {
     error: {
         invalidQueueName: string;
+        invalidEvent: string;
+        invalidEventBody: string;
         invalidDelayInSecondsSetting: string;
         maxEventsAllowed: (maxEventsCount: number) => string;
         maxPayloadAllowed: (maxPayloadSize: number) => 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;;;;;gCAK3B,MAAM,aAAa,MAAM,KAAG,MAAM;;CAG7D,CAAC"}
+{"version":3,"file":"text.d.ts","sourceRoot":"","sources":["../src/text.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,IAAI;;;;;;2CAMsB,MAAM,KAAG,MAAM;4CAEd,MAAM,KAAG,MAAM;;;;;gCAK3B,MAAM,aAAa,MAAM,KAAG,MAAM;;CAG7D,CAAC"}

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.0.3",
+  "version": "2.0.0-next.1",
   "description": "Forge Async Event methods",
   "author": "Atlassian",
   "license": "SEE LICENSE IN LICENSE.txt",

package/src/__test__/appEvents.test.ts

@@ -0,0 +1,201 @@
+import { appEvents, AppEvent } from '../appEvents';
+import { post } from '../queries';
+import { __requestAtlassianAsApp } from '@forge/api';
+
+// Mock the dependencies
+jest.mock('../queries', () => ({
+  post: jest.fn()
+}));
+
+jest.mock('@forge/api', () => ({
+  __requestAtlassianAsApp: jest.fn()
+}));
+
+describe('appEvents', () => {
+  beforeEach(() => {
+    // Clear all mocks before each test
+    jest.clearAllMocks();
+  });
+
+  describe('publishEvent', () => {
+    it('should call post with the correct parameters', async () => {
+      // Arrange
+      const event: AppEvent = { key: 'test-event' };
+      const mockResponse = {
+        ok: true,
+        json: jest.fn().mockResolvedValue({
+          failedEvents: []
+        })
+      };
+
+      // Mock the post function to return a successful response
+      (post as jest.Mock).mockResolvedValue(mockResponse);
+
+      // Act
+      const result = await appEvents.publish(event);
+
+      // Assert
+      expect(post).toHaveBeenCalledTimes(1);
+      expect(post).toHaveBeenCalledWith(
+        '/forge/events/v1/app-events',
+        {
+          events: [
+            {
+              key: event.key
+            }
+          ]
+        },
+        __requestAtlassianAsApp
+      );
+      expect(result).toEqual({ type: 'success', failedEvents: [] });
+    });
+
+    it('should return a success result for successful requests', async () => {
+      // Arrange
+      const event: AppEvent = { key: 'test-event' };
+      const mockResponse = {
+        ok: true,
+        json: jest.fn().mockResolvedValue({
+          failedEvents: []
+        })
+      };
+
+      // Mock the post function to return a successful response
+      (post as jest.Mock).mockResolvedValue(mockResponse);
+
+      // Act
+      const result = await appEvents.publish(event);
+
+      // Assert
+      expect(result).toEqual({ type: 'success', failedEvents: [] });
+    });
+
+    it('should return an error result for failed requests', async () => {
+      // Arrange
+      const event: AppEvent = { key: 'test-event' };
+      const mockResponse = {
+        ok: false,
+        status: 500,
+        json: jest.fn().mockResolvedValue({
+          errorMessages: ['Internal server error']
+        })
+      };
+
+      // Mock the post function to return a failed response
+      (post as jest.Mock).mockResolvedValue(mockResponse);
+
+      // Act
+      const result = await appEvents.publish(event);
+
+      // Assert
+      expect(result).toEqual({
+        type: 'error',
+        errorType: 'SERVICE_ERROR',
+        errorMessage: 'Internal server error'
+      });
+    });
+
+    it('should handle validation errors', async () => {
+      // Arrange
+      const event: AppEvent = { key: 'test-event' };
+      const mockResponse = {
+        ok: false,
+        status: 400,
+        json: jest.fn().mockResolvedValue({
+          errorMessages: ['Invalid event type']
+        })
+      };
+
+      // Mock the post function to return a validation error response
+      (post as jest.Mock).mockResolvedValue(mockResponse);
+
+      // Act
+      const result = await appEvents.publish(event);
+
+      // Assert
+      expect(result).toEqual({
+        type: 'error',
+        errorType: 'VALIDATION_ERROR',
+        errorMessage: 'Invalid event type'
+      });
+    });
+
+    it('should handle errors object in the error response', async () => {
+      // Arrange
+      const event: AppEvent = { key: 'test-event' };
+      const errorResponse = {
+        errorMessages: [],
+        errors: { key: 'Event key is required' }
+      };
+
+      const mockResponse = {
+        ok: false,
+        status: 400,
+        json: jest.fn().mockResolvedValue(errorResponse)
+      };
+
+      // Mock the post function to return an error response with errors object
+      (post as jest.Mock).mockResolvedValue(mockResponse);
+
+      // Act
+      const result = await appEvents.publish(event);
+
+      // Assert
+      expect(result).toEqual({
+        type: 'error',
+        errorType: 'VALIDATION_ERROR',
+        errorMessage: 'key: Event key is required'
+      });
+    });
+
+    it('should use OTHER as errorType for unknown status codes', async () => {
+      // Arrange
+      const event: AppEvent = { key: 'test-event' };
+      const mockResponse = {
+        ok: false,
+        status: 418, // I'm a teapot
+        json: jest.fn().mockResolvedValue({
+          errorMessages: ['I refuse to brew coffee']
+        })
+      };
+
+      // Mock the post function to return a response with unknown status code
+      (post as jest.Mock).mockResolvedValue(mockResponse);
+
+      // Act
+      const result = await appEvents.publish(event);
+
+      // Assert
+      expect(result).toEqual({
+        type: 'error',
+        errorType: 'OTHER',
+        errorMessage: 'I refuse to brew coffee'
+      });
+    });
+
+    it('should handle empty error messages', async () => {
+      // Arrange
+      const event: AppEvent = { key: 'test-event' };
+      const mockResponse = {
+        ok: false,
+        status: 500,
+        json: jest.fn().mockResolvedValue({
+          errorMessages: []
+        })
+      };
+
+      // Mock the post function to return a response with empty error messages
+      (post as jest.Mock).mockResolvedValue(mockResponse);
+
+      // Act
+      const result = await appEvents.publish(event);
+
+      // Assert
+      expect(result).toEqual({
+        type: 'error',
+        errorType: 'SERVICE_ERROR',
+        errorMessage: '{"errorMessages":[]}'
+      });
+    });
+  });
+});