@forge/notification 0.0.2-next.0 → 0.1.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @forge/notification
 
+## 0.1.0-next.0
+
+### Minor Changes
+
+- e9d727f: Add implementation code for notification SDK
+
+## 0.0.2
+
+### Patch Changes
+
+- d5178f5: Forge Notification SDK skeleton
+
 ## 0.0.2-next.0
 
 ### Patch Changes

package/README.md

@@ -1,3 +1,71 @@
 # @forge/notification
 
 Library for Forge Notification
+
+## Usage example
+
+### Sending a notification
+
+```typescript
+import { 
+  NotificationApi, 
+  NotificationPayload,
+  InvalidPayloadError,
+  RateLimitError,
+  InternalServerError 
+} from '@forge/notification';
+
+const notificationApi = new NotificationApi();
+
+const payload: NotificationPayload = {
+  context: {
+    subject: 'Welcome to our app!',
+    htmlBody: '<h1>Welcome!</h1><p>Thank you for joining us.</p>',
+  },
+  recipientsUserIds: ['user1', 'user2', 'user3']
+};
+
+try {
+  const response = await notificationApi.sendNotification(payload);
+  console.log('Trigger ID:', response.triggerId);
+} catch (error) {
+  if (error instanceof InvalidPayloadError) {
+    console.error('Invalid payload:', error.message);
+  } else if (error instanceof RateLimitError) {
+    console.error('Rate limit exceeded:', error.message);
+  } else if (error instanceof InternalServerError) {
+    console.error('Server error:', error.message);
+  }
+}
+```
+
+### Check the status of a notification delivery
+
+```typescript
+import {
+  NotificationApi,
+  RecipientType,
+  DeliveryChannel,
+  InvalidPayloadError,
+  RateLimitError,
+  InternalServerError
+} from '@forge/notification';
+
+try {
+  const notificationApi = new NotificationApi();
+
+  const statusResponse = await notificationApi.getNotificationStatus('triggerId', 'userId', RecipientType.ACCOUNT_ID, DeliveryChannel.EMAIL);
+  console.log('Notification status:', statusResponse.latestStatus);
+} catch (error) {
+  if (error instanceof InvalidPayloadError) {
+    console.error('Invalid payload:', error.message);
+  } else if (error instanceof RateLimitError) {
+    console.error('Rate limit exceeded:', error.message);
+  } else if (error instanceof InternalServerError) {
+    console.error('Server error:', error.message);
+  }
+}
+```
+
+## Errors
+The SDK throws validation and API Errors.

package/out/errors.d.ts

@@ -0,0 +1,13 @@
+export declare class NotificationError extends Error {
+    constructor(message: string);
+}
+export declare class InvalidPayloadError extends NotificationError {
+}
+export declare class RateLimitError extends NotificationError {
+}
+export declare class InternalServerError extends NotificationError {
+    constructor(message: string, errorCode?: number, details?: string);
+    errorCode?: number;
+    details?: string;
+}
+//# sourceMappingURL=errors.d.ts.map

package/out/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,qBAAa,iBAAkB,SAAQ,KAAK;gBAC9B,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,mBAAoB,SAAQ,iBAAiB;CAAG;AAE7D,qBAAa,cAAe,SAAQ,iBAAiB;CAAG;AAExD,qBAAa,mBAAoB,SAAQ,iBAAiB;gBAC5C,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"}

package/out/errors.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InternalServerError = exports.RateLimitError = exports.InvalidPayloadError = exports.NotificationError = void 0;
+class NotificationError extends Error {
+    constructor(message) {
+        super(message);
+    }
+}
+exports.NotificationError = NotificationError;
+class InvalidPayloadError extends NotificationError {
+}
+exports.InvalidPayloadError = InvalidPayloadError;
+class RateLimitError extends NotificationError {
+}
+exports.RateLimitError = RateLimitError;
+class InternalServerError extends NotificationError {
+    constructor(message, errorCode, details) {
+        super(message);
+        this.errorCode = errorCode;
+        this.details = details;
+    }
+    errorCode;
+    details;
+}
+exports.InternalServerError = InternalServerError;

package/out/fetch.d.ts

@@ -0,0 +1,6 @@
+import { APIResponse, FetchMethod } from '@forge/api';
+export declare const POST_OFFICE_FORGE_NOTIFICATION_PATH = "/post-office/api/v1/forge/notification/{contextAri}/{environmentId}/{appId}/{cloudId}";
+export declare const POST_OFFICE_FORGE_STATUS_PATH = "/post-office/api/v1/forge/notification/status/{contextAri}/{environmentId}/{appId}/{cloudId}";
+export declare const post: (endpoint: string, body: unknown, apiClient: FetchMethod) => Promise<APIResponse>;
+export declare const get: (endpoint: string, apiClient: FetchMethod) => Promise<APIResponse>;
+//# sourceMappingURL=fetch.d.ts.map

package/out/fetch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../src/fetch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEtD,eAAO,MAAM,mCAAmC,0FACyC,CAAC;AAC1F,eAAO,MAAM,6BAA6B,iGACsD,CAAC;AAEjG,eAAO,MAAM,IAAI,aAAoB,MAAM,QAAQ,OAAO,aAAa,WAAW,KAAG,QAAQ,WAAW,CAUvG,CAAC;AAEF,eAAO,MAAM,GAAG,aAAoB,MAAM,aAAa,WAAW,KAAG,QAAQ,WAAW,CASvF,CAAC"}

package/out/fetch.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.get = exports.post = exports.POST_OFFICE_FORGE_STATUS_PATH = exports.POST_OFFICE_FORGE_NOTIFICATION_PATH = void 0;
+exports.POST_OFFICE_FORGE_NOTIFICATION_PATH = '/post-office/api/v1/forge/notification/{contextAri}/{environmentId}/{appId}/{cloudId}';
+exports.POST_OFFICE_FORGE_STATUS_PATH = '/post-office/api/v1/forge/notification/status/{contextAri}/{environmentId}/{appId}/{cloudId}';
+const post = async (endpoint, body, apiClient) => {
+    const request = {
+        method: 'POST',
+        body: JSON.stringify(body),
+        headers: {
+            'content-type': 'application/json'
+        }
+    };
+    return await apiClient(endpoint, request);
+};
+exports.post = post;
+const get = async (endpoint, apiClient) => {
+    const request = {
+        method: 'GET',
+        headers: {
+            'content-type': 'application/json'
+        }
+    };
+    return await apiClient(endpoint, request);
+};
+exports.get = get;

package/out/index.d.ts

@@ -0,0 +1,8 @@
+export { NotificationApi } from './notification-api';
+export { NotificationApi as default } from './notification-api';
+export { NotificationPayload, DeliveryChannel, MessageTemplateData, MessageTemplateContext, NotificationPORequest, RecipientsToProcess, NotificationResponse, NotificationStatusResponse, EmailRecipient } from './types';
+export { NotificationError, InvalidPayloadError, RateLimitError, InternalServerError } from './errors';
+export { validateAPIResponse } from './validators';
+export { post, POST_OFFICE_FORGE_NOTIFICATION_PATH } from './fetch';
+export type { APIResponse, FetchMethod } from '@forge/api';
+//# sourceMappingURL=index.d.ts.map

package/out/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAGrD,OAAO,EAAE,eAAe,IAAI,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAGhE,OAAO,EACL,mBAAmB,EACnB,eAAe,EACf,mBAAmB,EACnB,sBAAsB,EACtB,qBAAqB,EACrB,mBAAmB,EACnB,oBAAoB,EACpB,0BAA0B,EAC1B,cAAc,EACf,MAAM,SAAS,CAAC;AAGjB,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAGvG,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAGnD,OAAO,EAAE,IAAI,EAAE,mCAAmC,EAAE,MAAM,SAAS,CAAC;AAGpE,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC"}

package/out/index.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.POST_OFFICE_FORGE_NOTIFICATION_PATH = exports.post = exports.validateAPIResponse = exports.InternalServerError = exports.RateLimitError = exports.InvalidPayloadError = exports.NotificationError = exports.DeliveryChannel = exports.default = exports.NotificationApi = void 0;
+var notification_api_1 = require("./notification-api");
+Object.defineProperty(exports, "NotificationApi", { enumerable: true, get: function () { return notification_api_1.NotificationApi; } });
+var notification_api_2 = require("./notification-api");
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return notification_api_2.NotificationApi; } });
+var types_1 = require("./types");
+Object.defineProperty(exports, "DeliveryChannel", { enumerable: true, get: function () { return types_1.DeliveryChannel; } });
+var errors_1 = require("./errors");
+Object.defineProperty(exports, "NotificationError", { enumerable: true, get: function () { return errors_1.NotificationError; } });
+Object.defineProperty(exports, "InvalidPayloadError", { enumerable: true, get: function () { return errors_1.InvalidPayloadError; } });
+Object.defineProperty(exports, "RateLimitError", { enumerable: true, get: function () { return errors_1.RateLimitError; } });
+Object.defineProperty(exports, "InternalServerError", { enumerable: true, get: function () { return errors_1.InternalServerError; } });
+var validators_1 = require("./validators");
+Object.defineProperty(exports, "validateAPIResponse", { enumerable: true, get: function () { return validators_1.validateAPIResponse; } });
+var fetch_1 = require("./fetch");
+Object.defineProperty(exports, "post", { enumerable: true, get: function () { return fetch_1.post; } });
+Object.defineProperty(exports, "POST_OFFICE_FORGE_NOTIFICATION_PATH", { enumerable: true, get: function () { return fetch_1.POST_OFFICE_FORGE_NOTIFICATION_PATH; } });

package/out/notification-api.d.ts

@@ -0,0 +1,10 @@
+import { FetchMethod } from '@forge/api';
+import { DeliveryChannel, NotificationPayload, NotificationPORequest, NotificationResponse, NotificationStatusResponse, RecipientType } from './types';
+export declare class NotificationApi {
+    private readonly apiClient;
+    constructor(apiClient?: FetchMethod);
+    sendNotification(payload: NotificationPayload): Promise<NotificationResponse>;
+    getNotificationStatus(triggerId: string, recipient: string, recipientType: RecipientType, deliveryChannel: DeliveryChannel): Promise<NotificationStatusResponse>;
+    createNotificationPORequest(input: NotificationPayload, triggerId: string): NotificationPORequest;
+}
+//# sourceMappingURL=notification-api.d.ts.map

package/out/notification-api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification-api.d.ts","sourceRoot":"","sources":["../src/notification-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2B,WAAW,EAAE,MAAM,YAAY,CAAC;AAGlE,OAAO,EACL,eAAe,EAGf,mBAAmB,EACnB,qBAAqB,EACrB,oBAAoB,EACpB,0BAA0B,EAE1B,aAAa,EACd,MAAM,SAAS,CAAC;AAWjB,qBAAa,eAAe;IACd,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,GAAE,WAAqC;IAEvE,gBAAgB,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAe7E,qBAAqB,CACzB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,aAAa,EAAE,aAAa,EAC5B,eAAe,EAAE,eAAe,GAC/B,OAAO,CAAC,0BAA0B,CAAC;IAoBtC,2BAA2B,CAAC,KAAK,EAAE,mBAAmB,EAAE,SAAS,EAAE,MAAM,GAAG,qBAAqB;CAkClG"}

package/out/notification-api.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationApi = void 0;
+const api_1 = require("@forge/api");
+const uuid_1 = require("uuid");
+const fetch_1 = require("./fetch");
+const types_1 = require("./types");
+const validators_1 = require("./validators");
+const CLIENT_FORGE_NOTIFICATION_SDK = 'forge-notification-sdk';
+const ECOSYSTEM_FORGE_NOTIFICATION_TEMPLATE = 'ecosystem-forge-notifications-spike';
+const userIdToIdentityAri = (userId) => ({
+    userId,
+    toString: () => `ari:cloud:identity::user/${userId}`
+});
+class NotificationApi {
+    apiClient;
+    constructor(apiClient = api_1.__requestAtlassianAsApp) {
+        this.apiClient = apiClient;
+    }
+    async sendNotification(payload) {
+        (0, validators_1.validateNotificationPayload)(payload);
+        const triggerId = (0, uuid_1.v4)();
+        const notificationPORequest = this.createNotificationPORequest(payload, triggerId);
+        const response = await (0, fetch_1.post)(fetch_1.POST_OFFICE_FORGE_NOTIFICATION_PATH, notificationPORequest, this.apiClient);
+        await (0, validators_1.validateAPIResponse)(response, 'notification');
+        return {
+            ...(await response.json()),
+            triggerId
+        };
+    }
+    async getNotificationStatus(triggerId, recipient, recipientType, deliveryChannel) {
+        (0, validators_1.validateNotificationStatusParams)(triggerId, recipient, recipientType, deliveryChannel);
+        const endpoint = `${fetch_1.POST_OFFICE_FORGE_STATUS_PATH}?triggerId=${encodeURIComponent(triggerId)}&recipient=${encodeURIComponent(recipientType === types_1.RecipientType.ACCOUNT_ID ? userIdToIdentityAri(recipient).toString() : recipient)}&recipientType=${encodeURIComponent(recipientType)}&deliveryChannel=${encodeURIComponent(deliveryChannel)}`;
+        const response = await (0, fetch_1.get)(endpoint, this.apiClient);
+        await (0, validators_1.validateAPIResponse)(response, 'status');
+        const responseData = await response.json();
+        const allStatuses = Array.isArray(responseData.allStatuses) ? responseData.allStatuses : [];
+        return {
+            triggerId: responseData.triggerId,
+            recipient: responseData.recipient,
+            deliveryChannel: responseData.deliveryChannel,
+            latestStatus: allStatuses.length > 0 ? allStatuses[0].status : responseData.deliveryStatus,
+            allStatuses,
+            errors: responseData.errors
+        };
+    }
+    createNotificationPORequest(input, triggerId) {
+        const recipientsToProcess = {};
+        if (input.recipientsUserIds && input.recipientsUserIds.length > 0) {
+            const userAriList = input.recipientsUserIds.map((userId) => userIdToIdentityAri(userId).toString());
+            recipientsToProcess.users = {
+                userAri: userAriList
+            };
+        }
+        if (input.recipientEmails && input.recipientEmails.length > 0) {
+            recipientsToProcess.emails = {
+                emailAddresses: input.recipientEmails
+            };
+        }
+        const messageTemplateData = {
+            id: ECOSYSTEM_FORGE_NOTIFICATION_TEMPLATE,
+            context: input.context
+        };
+        return {
+            triggerId,
+            messageTemplateData,
+            recipientsToProcess: recipientsToProcess,
+            eventTime: new Date().toISOString(),
+            client: CLIENT_FORGE_NOTIFICATION_SDK
+        };
+    }
+}
+exports.NotificationApi = NotificationApi;

package/out/types.d.ts

@@ -0,0 +1,68 @@
+interface Ari {
+    toString: () => string;
+    toJSON?: () => string;
+}
+export declare type IdentityUserAri = Ari & {
+    userId: string;
+};
+export declare enum DeliveryChannel {
+    EMAIL = "email"
+}
+export declare enum RecipientType {
+    EMAIL_ADDRESS = "EmailAddress",
+    ACCOUNT_ID = "AccountId"
+}
+export declare type NotificationPayload = {
+    deliveryChannel?: DeliveryChannel;
+    context: MessageTemplateContext;
+    recipientsUserIds?: string[];
+    recipientEmails?: EmailRecipient[];
+};
+export declare type EmailRecipient = {
+    emailAddress: string;
+    locale?: string;
+};
+export declare type RecipientsToProcess = {
+    users?: {
+        userAri: string[];
+    };
+    emails?: {
+        emailAddresses: EmailRecipient[];
+    };
+};
+export declare type MessageTemplateData = {
+    id: string;
+    context: MessageTemplateContext;
+};
+export declare type MessageTemplateContext = {
+    subject: string;
+    htmlBody: string;
+};
+export declare type NotificationPORequest = {
+    triggerId: string;
+    messageTemplateData: MessageTemplateData;
+    recipientsToProcess: RecipientsToProcess;
+    client: string;
+    eventTime?: string;
+    entity?: Record<string, any>;
+    shardingContextId?: string;
+    actors?: IdentityUserAri[];
+};
+export interface NotificationResponse {
+    triggerId?: string;
+    errors?: string[];
+}
+export interface StatusDetails {
+    status: string;
+    timestamp: number;
+}
+export interface NotificationStatusResponse {
+    triggerId: string;
+    recipient: string;
+    deliveryChannel: string;
+    latestStatus: string;
+    allStatuses: StatusDetails[];
+    errors?: string[];
+}
+export {};
+//# sourceMappingURL=types.d.ts.map

package/out/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,UAAU,GAAG;IACX,QAAQ,EAAE,MAAM,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,MAAM,CAAC;CACvB;AAED,oBAAY,eAAe,GAAG,GAAG,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAEvD,oBAAY,eAAe;IACzB,KAAK,UAAU;CAChB;AAED,oBAAY,aAAa;IACvB,aAAa,iBAAiB;IAC9B,UAAU,cAAc;CACzB;AACD,oBAAY,mBAAmB,GAAG;IAChC,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,OAAO,EAAE,sBAAsB,CAAC;IAChC,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,eAAe,CAAC,EAAE,cAAc,EAAE,CAAC;CACpC,CAAC;AAEF,oBAAY,cAAc,GAAG;IAC3B,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,oBAAY,mBAAmB,GAAG;IAChC,KAAK,CAAC,EAAE;QACN,OAAO,EAAE,MAAM,EAAE,CAAC;KACnB,CAAC;IACF,MAAM,CAAC,EAAE;QACP,cAAc,EAAE,cAAc,EAAE,CAAC;KAClC,CAAC;CACH,CAAC;AAEF,oBAAY,mBAAmB,GAAG;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,sBAAsB,CAAC;CACjC,CAAC;AAEF,oBAAY,sBAAsB,GAAG;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,oBAAY,qBAAqB,GAAG;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC7B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,MAAM,CAAC,EAAE,eAAe,EAAE,CAAC;CAC5B,CAAC;AAEF,MAAM,WAAW,oBAAoB;IACnC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACnB;AAGD,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,aAAa,EAAE,CAAC;IAC7B,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB"}

package/out/types.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RecipientType = exports.DeliveryChannel = void 0;
+var DeliveryChannel;
+(function (DeliveryChannel) {
+    DeliveryChannel["EMAIL"] = "email";
+})(DeliveryChannel = exports.DeliveryChannel || (exports.DeliveryChannel = {}));
+var RecipientType;
+(function (RecipientType) {
+    RecipientType["EMAIL_ADDRESS"] = "EmailAddress";
+    RecipientType["ACCOUNT_ID"] = "AccountId";
+})(RecipientType = exports.RecipientType || (exports.RecipientType = {}));

package/out/validators.d.ts

@@ -0,0 +1,6 @@
+import { DeliveryChannel, NotificationPayload, RecipientType } from './types';
+import { APIResponse } from '@forge/api';
+export declare const validateNotificationPayload: (payload: NotificationPayload) => boolean;
+export declare const validateNotificationStatusParams: (triggerId: string, recipient: string, recipientType: RecipientType, deliveryChannel: DeliveryChannel) => void;
+export declare const validateAPIResponse: (response: APIResponse, method: 'notification' | 'status') => Promise<void>;
+//# sourceMappingURL=validators.d.ts.map

package/out/validators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validators.d.ts","sourceRoot":"","sources":["../src/validators.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAC9E,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAGzC,eAAO,MAAM,2BAA2B,YAAa,mBAAmB,YAqDvE,CAAC;AAEF,eAAO,MAAM,gCAAgC,cAChC,MAAM,aACN,MAAM,iBACF,aAAa,mBACX,eAAe,SAoCjC,CAAC;AAEF,eAAO,MAAM,mBAAmB,aAAoB,WAAW,UAAU,cAAc,GAAG,QAAQ,kBAejG,CAAC"}

package/out/validators.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateAPIResponse = exports.validateNotificationStatusParams = exports.validateNotificationPayload = void 0;
+const errors_1 = require("./errors");
+const types_1 = require("./types");
+const validateNotificationPayload = (payload) => {
+    if (!payload || typeof payload !== 'object') {
+        throw new errors_1.InvalidPayloadError('Payload must be an object');
+    }
+    if (payload.recipientsUserIds !== undefined) {
+        if (!Array.isArray(payload.recipientsUserIds)) {
+            throw new errors_1.InvalidPayloadError('recipientsUserIds must be an array');
+        }
+        for (const userId of payload.recipientsUserIds) {
+            if (typeof userId !== 'string') {
+                throw new errors_1.InvalidPayloadError(`Invalid userId: ${JSON.stringify(userId)}`);
+            }
+        }
+    }
+    if (payload.recipientEmails !== undefined) {
+        if (!Array.isArray(payload.recipientEmails)) {
+            throw new errors_1.InvalidPayloadError('recipientEmails must be an array');
+        }
+        for (const email of payload.recipientEmails) {
+            if (!email || typeof email !== 'object') {
+                throw new errors_1.InvalidPayloadError('Invalid email recipient object');
+            }
+            if (!email.emailAddress || typeof email.emailAddress !== 'string') {
+                throw new errors_1.InvalidPayloadError('Invalid email address');
+            }
+            if (email.locale !== undefined && typeof email.locale !== 'string') {
+                throw new errors_1.InvalidPayloadError('Invalid email locale');
+            }
+        }
+    }
+    const hasValidUserIds = payload.recipientsUserIds && Array.isArray(payload.recipientsUserIds) && payload.recipientsUserIds.length > 0;
+    const hasValidEmails = payload.recipientEmails && Array.isArray(payload.recipientEmails) && payload.recipientEmails.length > 0;
+    if (!hasValidUserIds && !hasValidEmails) {
+        throw new errors_1.InvalidPayloadError('Either recipientsUserIds or recipientEmails must be provided');
+    }
+    if (!payload.context?.subject || typeof payload.context?.subject !== 'string') {
+        throw new errors_1.InvalidPayloadError('Missing or invalid subject');
+    }
+    if (!payload.context?.htmlBody || typeof payload.context?.htmlBody !== 'string') {
+        throw new errors_1.InvalidPayloadError('Missing or invalid htmlBody');
+    }
+    return true;
+};
+exports.validateNotificationPayload = validateNotificationPayload;
+const validateNotificationStatusParams = (triggerId, recipient, recipientType, deliveryChannel) => {
+    if (triggerId !== undefined) {
+        if (typeof triggerId !== 'string' || triggerId.trim() === '') {
+            throw new errors_1.InvalidPayloadError('Invalid triggerId: must be a non-empty string when provided');
+        }
+    }
+    if (recipient !== undefined) {
+        if (typeof recipient !== 'string' || recipient.trim() === '') {
+            throw new errors_1.InvalidPayloadError('Invalid recipient: must be a non-empty string when provided');
+        }
+    }
+    if (recipientType !== undefined) {
+        if (typeof recipientType !== 'string' || recipientType.trim() === '') {
+            throw new errors_1.InvalidPayloadError('Invalid recipientType: must be a non-empty string when provided');
+        }
+        const allowedRecipientTypes = Object.values(types_1.RecipientType);
+        if (!allowedRecipientTypes.includes(recipientType)) {
+            throw new errors_1.InvalidPayloadError(`Invalid recipientType: must be one of ${allowedRecipientTypes.join(', ')}`);
+        }
+    }
+    if (deliveryChannel !== undefined) {
+        if (typeof deliveryChannel !== 'string' || deliveryChannel.trim() === '') {
+            throw new errors_1.InvalidPayloadError('Invalid deliveryChannel: must be a non-empty string when provided');
+        }
+    }
+    const allowedChannels = Object.values(types_1.DeliveryChannel);
+    if (!allowedChannels.includes(deliveryChannel)) {
+        throw new errors_1.InvalidPayloadError(`Invalid deliveryChannel: must be one of ${allowedChannels.join(', ')}`);
+    }
+};
+exports.validateNotificationStatusParams = validateNotificationStatusParams;
+const validateAPIResponse = async (response, method) => {
+    if (!response || typeof response !== 'object') {
+        throw new errors_1.InternalServerError('Unexpected response object');
+    }
+    if (response.status === 429) {
+        throw new errors_1.RateLimitError(`Rate limit exceeded ${response.statusText}`);
+    }
+    if (!response.ok) {
+        throw new errors_1.InternalServerError(`Failed to ${method === 'status' ? 'fetch status' : 'send notification'}: ${response.statusText}`, response.status, await response.text());
+    }
+};
+exports.validateAPIResponse = validateAPIResponse;

package/package.json

@@ -1,13 +1,24 @@
 {
   "name": "@forge/notification",
-  "version": "0.0.2-next.0",
+  "version": "0.1.0-next.0",
   "description": "Forge Notification SDK",
   "main": "out/index.js",
+  "types": "out/index.d.ts",
   "scripts": {
     "build": "yarn run clean && yarn run compile",
     "clean": "rm -rf ./out && rm -f tsconfig.tsbuildinfo",
     "compile": "tsc -b -v"
   },
+  "dependencies": {
+    "@forge/api": "^6.4.1-next.0",
+    "uuid": "^9.0.1"
+  },
+  "devDependencies": {
+    "@types/node": "20.19.1",
+    "@types/uuid": "^9.0.8",
+    "expect-type": "^0.17.3",
+    "jest-when": "^3.6.0"
+  },
   "author": "Atlassian",
   "license": "SEE LICENSE IN LICENSE.txt",
   "publishConfig": {