@forge/notification 0.1.0-next.1 → 0.1.0-next.1-experimental-9065145

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @forge/notification
 
+## 0.1.0-next.1-experimental-9065145
+
+### Minor Changes
+
+- e9d727f: Add implementation code for notification SDK
+
+### Patch Changes
+
+- 7046f29: Fix types
+  - @forge/api@6.4.1-next.0-experimental-9065145
+
 ## 0.1.0-next.1
 
 ### Patch Changes

package/out/index.d.ts

@@ -1,8 +1,7 @@
 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 { NotificationPayload, DeliveryChannel, RecipientType, StatusDetails, MessageTemplateContext, 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

@@ -1 +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"}
+{"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,aAAa,EACb,aAAa,EACb,sBAAsB,EACtB,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,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC"}

package/out/index.js

@@ -1,12 +1,13 @@
 "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;
+exports.validateAPIResponse = exports.InternalServerError = exports.RateLimitError = exports.InvalidPayloadError = exports.NotificationError = exports.RecipientType = 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; } });
+Object.defineProperty(exports, "RecipientType", { enumerable: true, get: function () { return types_1.RecipientType; } });
 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; } });
@@ -14,6 +15,3 @@ Object.defineProperty(exports, "RateLimitError", { enumerable: true, get: functi
 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

@@ -1,10 +1,9 @@
 import { FetchMethod } from '@forge/api';
-import { DeliveryChannel, NotificationPayload, NotificationPORequest, NotificationResponse, NotificationStatusResponse, RecipientType } from './types';
+import { DeliveryChannel, NotificationPayload, 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

@@ -1 +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"}
+{"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,EACf,mBAAmB,EACnB,oBAAoB,EACpB,0BAA0B,EAC1B,aAAa,EACd,MAAM,SAAS,CAAC;AAIjB,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;CAmBvC"}

package/out/notification-api.js

@@ -6,12 +6,7 @@ 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}`
-});
+const util_1 = require("./util");
 class NotificationApi {
     apiClient;
     constructor(apiClient = api_1.__requestAtlassianAsApp) {
@@ -20,7 +15,7 @@ class NotificationApi {
     async sendNotification(payload) {
         (0, validators_1.validateNotificationPayload)(payload);
         const triggerId = (0, uuid_1.v4)();
-        const notificationPORequest = this.createNotificationPORequest(payload, triggerId);
+        const notificationPORequest = (0, util_1.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 {
@@ -30,7 +25,7 @@ class NotificationApi {
     }
     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 endpoint = `${fetch_1.POST_OFFICE_FORGE_STATUS_PATH}?triggerId=${encodeURIComponent(triggerId)}&recipient=${encodeURIComponent(recipientType === types_1.RecipientType.ACCOUNT_ID ? (0, util_1.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();
@@ -44,30 +39,5 @@ class NotificationApi {
             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/util.d.ts

@@ -0,0 +1,4 @@
+import { IdentityUserAri, NotificationPayload, NotificationPORequest } from './types';
+export declare const userIdToIdentityAri: (userId: string) => IdentityUserAri;
+export declare const createNotificationPORequest: (input: NotificationPayload, triggerId: string) => NotificationPORequest;
+//# sourceMappingURL=util.d.ts.map

package/out/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EAEf,mBAAmB,EACnB,qBAAqB,EAEtB,MAAM,SAAS,CAAC;AAKjB,eAAO,MAAM,mBAAmB,WAAY,MAAM,KAAG,eAGnD,CAAC;AAEH,eAAO,MAAM,2BAA2B,UAAW,mBAAmB,aAAa,MAAM,KAAG,qBAiC3F,CAAC"}

package/out/util.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createNotificationPORequest = exports.userIdToIdentityAri = void 0;
+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}`
+});
+exports.userIdToIdentityAri = userIdToIdentityAri;
+const createNotificationPORequest = (input, triggerId) => {
+    const recipientsToProcess = {};
+    if (input.recipientsUserIds && input.recipientsUserIds.length > 0) {
+        const userAriList = input.recipientsUserIds.map((userId) => (0, exports.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.createNotificationPORequest = createNotificationPORequest;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/notification",
-  "version": "0.1.0-next.1",
+  "version": "0.1.0-next.1-experimental-9065145",
   "description": "Forge Notification SDK",
   "main": "out/index.js",
   "types": "out/index.d.ts",
@@ -10,7 +10,7 @@
     "compile": "tsc -b -v"
   },
   "dependencies": {
-    "@forge/api": "^6.4.1-next.0",
+    "@forge/api": "^6.4.1-next.0-experimental-9065145",
     "uuid": "^9.0.1"
   },
   "devDependencies": {