@forge/notification 0.2.2 → 0.3.0-next.0-experimental-5b18257

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @forge/notification
 
+## 0.3.0-next.0-experimental-5b18257
+
+### Minor Changes
+
+- ff1594c: Modified NotificationPayload type to support custom templates. Added more types to types.ts. Since users can now specify template id, removed hardcoded template id used inside util.ts to instead use the template id supplied by user. Also had to remove validation check for htmlBody since not all templates use this field anymore. Modified existing unit tests to include 'id' field in NotificationPayload and added some unit tests for each of the new templates.
+
+## 0.3.0-next.0
+
+### Minor Changes
+
+- ff1594c: Modified NotificationPayload type to support custom templates. Added more types to types.ts. Since users can now specify template id, removed hardcoded template id used inside util.ts to instead use the template id supplied by user. Also had to remove validation check for htmlBody since not all templates use this field anymore. Modified existing unit tests to include 'id' field in NotificationPayload and added some unit tests for each of the new templates.
+
 ## 0.2.2
 
 ### Patch Changes

package/out/index.d.ts

@@ -1,6 +1,6 @@
 export { NotificationApi } from './notification-api';
 export { NotificationApi as default } from './notification-api';
-export { NotificationPayload, DeliveryChannel, RecipientType, MessageTemplateContext, NotificationResponse, EmailRecipient } from './types';
+export { NotificationPayload, DeliveryChannel, RecipientType, NotificationResponse, EmailRecipient } from './types';
 export { NotificationError, InvalidPayloadError, RateLimitError, InternalServerError } from './errors';
 export { validateAPIResponse } from './validators';
 export type { APIResponse, FetchMethod } from '@forge/api';

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,aAAa,EACb,sBAAsB,EACtB,oBAAoB,EACpB,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"}
+{"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,EAAE,mBAAmB,EAAE,eAAe,EAAE,aAAa,EAAE,oBAAoB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAGpH,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/types.d.ts

@@ -14,10 +14,9 @@ export declare enum RecipientType {
 }
 export declare type NotificationPayload = {
     deliveryChannel?: DeliveryChannel;
-    context: MessageTemplateContext;
     recipientsUserIds?: string[];
     recipientEmails?: EmailRecipient[];
-};
+} & MessageTemplateData;
 export declare type EmailRecipient = {
     emailAddress: string;
     locale?: string;
@@ -30,17 +29,14 @@ export declare type RecipientsToProcess = {
         emailAddresses: EmailRecipient[];
     };
 };
-export declare type MessageTemplateData = {
+export declare type MessageTemplateData = Basic | Action | Confirmation | Custom;
+export declare type InternalMessageTemplateData = {
     id: string;
-    context: MessageTemplateContext;
-};
-export declare type MessageTemplateContext = {
-    subject: string;
-    htmlBody: string;
+    context: BasicContext | ActionContext | ConfirmationContext | CustomContext;
 };
 export declare type NotificationPORequest = {
     triggerId: string;
-    messageTemplateData: MessageTemplateData;
+    messageTemplateData: InternalMessageTemplateData;
     recipientsToProcess: RecipientsToProcess;
     client: string;
     eventTime?: string;
@@ -52,5 +48,55 @@ export interface NotificationResponse {
     triggerId?: string;
     errors?: string[];
 }
+declare type Basic = {
+    id: 'basic';
+    context: BasicContext;
+};
+declare type Action = {
+    id: 'action';
+    context: ActionContext;
+};
+declare type Confirmation = {
+    id: 'confirmation';
+    context: ConfirmationContext;
+};
+declare type Custom = {
+    id: 'custom';
+    context: CustomContext;
+};
+declare type BasicContext = {
+    subject: string;
+    headline: string;
+    copy: string;
+    supportUrl: string;
+    footerLinkItems: LinkItem[];
+    disclaimer: string;
+};
+declare type ActionContext = {
+    subject: string;
+    headline: string;
+    copy: string;
+    ctaLinkItem: LinkItem;
+    supportUrl: string;
+    footerLinkItems: LinkItem[];
+    disclaimer: string;
+};
+declare type ConfirmationContext = {
+    subject: string;
+    headline: string;
+    copy: string;
+    ctaLinkItem: LinkItem;
+    supportUrl: string;
+    footerLinkItems: LinkItem[];
+    disclaimer: string;
+};
+declare type CustomContext = {
+    subject: string;
+    htmlBody: string;
+};
+declare type LinkItem = {
+    text: string;
+    link: string;
+};
 export {};
 //# sourceMappingURL=types.d.ts.map

package/out/types.d.ts.map

@@ -1 +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"}
+{"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;AAED,oBAAY,mBAAmB,GAAG;IAChC,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,eAAe,CAAC,EAAE,cAAc,EAAE,CAAC;CACpC,GAAG,mBAAmB,CAAC;AAExB,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,KAAK,GAAG,MAAM,GAAG,YAAY,GAAG,MAAM,CAAC;AAEzE,oBAAY,2BAA2B,GAAG;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,YAAY,GAAG,aAAa,GAAG,mBAAmB,GAAG,aAAa,CAAC;CAC7E,CAAC;AAEF,oBAAY,qBAAqB,GAAG;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,mBAAmB,EAAE,2BAA2B,CAAC;IACjD,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,aAAK,KAAK,GAAG;IACX,EAAE,EAAE,OAAO,CAAC;IACZ,OAAO,EAAE,YAAY,CAAC;CACvB,CAAC;AAEF,aAAK,MAAM,GAAG;IACZ,EAAE,EAAE,QAAQ,CAAC;IACb,OAAO,EAAE,aAAa,CAAC;CACxB,CAAC;AAEF,aAAK,YAAY,GAAG;IAClB,EAAE,EAAE,cAAc,CAAC;IACnB,OAAO,EAAE,mBAAmB,CAAC;CAC9B,CAAC;AAEF,aAAK,MAAM,GAAG;IACZ,EAAE,EAAE,QAAQ,CAAC;IACb,OAAO,EAAE,aAAa,CAAC;CACxB,CAAC;AAEF,aAAK,YAAY,GAAG;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,QAAQ,EAAE,CAAC;IAC5B,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,aAAK,aAAa,GAAG;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,QAAQ,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,QAAQ,EAAE,CAAC;IAC5B,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,aAAK,mBAAmB,GAAG;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,QAAQ,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,QAAQ,EAAE,CAAC;IAC5B,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,aAAK,aAAa,GAAG;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,aAAK,QAAQ,GAAG;IACd,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}

package/out/util.d.ts.map

@@ -1 +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"}
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,qBAAqB,EAAuB,MAAM,SAAS,CAAC;AAI3G,eAAO,MAAM,mBAAmB,WAAY,MAAM,KAAG,eAGnD,CAAC;AAEH,eAAO,MAAM,2BAA2B,UAAW,mBAAmB,aAAa,MAAM,KAAG,qBA4B3F,CAAC"}

package/out/util.js

@@ -2,7 +2,6 @@
 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}`
@@ -21,16 +20,25 @@ const createNotificationPORequest = (input, triggerId) => {
             emailAddresses: input.recipientEmails
         };
     }
-    const messageTemplateData = {
-        id: ECOSYSTEM_FORGE_NOTIFICATION_TEMPLATE,
-        context: input.context
-    };
     return {
         triggerId,
-        messageTemplateData,
+        messageTemplateData: { id: mapping(input.id), context: input.context },
         recipientsToProcess: recipientsToProcess,
         eventTime: new Date().toISOString(),
         client: CLIENT_FORGE_NOTIFICATION_SDK
     };
 };
 exports.createNotificationPORequest = createNotificationPORequest;
+const mapping = (id) => {
+    switch (id) {
+        case 'basic':
+            return 'forge-basic-notification';
+        case 'action':
+            return 'forge-action-notification';
+        case 'confirmation':
+            return 'forge-confirmation-notification';
+        case 'custom':
+        default:
+            return 'ecosystem-forge-notifications-spike';
+    }
+};

package/out/validators.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validators.d.ts","sourceRoot":"","sources":["../src/validators.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAGzC,eAAO,MAAM,2BAA2B,YAAa,mBAAmB,YAqDvE,CAAC;AAEF,eAAO,MAAM,mBAAmB,aAAoB,WAAW,kBAe9D,CAAC"}
+{"version":3,"file":"validators.d.ts","sourceRoot":"","sources":["../src/validators.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAGzC,eAAO,MAAM,2BAA2B,YAAa,mBAAmB,YA8GvE,CAAC;AAEF,eAAO,MAAM,mBAAmB,aAAoB,WAAW,kBAe9D,CAAC"}

package/out/validators.js

@@ -37,11 +37,63 @@ const validateNotificationPayload = (payload) => {
     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');
+    const validIds = ['custom', 'confirmation', 'action', 'basic'];
+    if (!payload.id || typeof payload.id !== 'string' || !validIds.includes(payload.id)) {
+        throw new errors_1.InvalidPayloadError('Missing or invalid id');
     }
-    if (!payload.context?.htmlBody || typeof payload.context?.htmlBody !== 'string') {
-        throw new errors_1.InvalidPayloadError('Missing or invalid htmlBody');
+    if (!payload.context || typeof payload.context !== 'object') {
+        throw new errors_1.InvalidPayloadError('Missing or invalid context');
+    }
+    switch (payload.id) {
+        case 'custom':
+            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');
+            }
+            break;
+        case 'confirmation':
+        case 'action':
+        case 'basic':
+            if (!payload.context.subject || typeof payload.context.subject !== 'string') {
+                throw new errors_1.InvalidPayloadError('Missing or invalid subject');
+            }
+            if (!payload.context.headline || typeof payload.context.headline !== 'string') {
+                throw new errors_1.InvalidPayloadError('Missing or invalid headline');
+            }
+            if (!payload.context.copy || typeof payload.context.copy !== 'string') {
+                throw new errors_1.InvalidPayloadError('Missing or invalid copy');
+            }
+            if (!payload.context.supportUrl || typeof payload.context.supportUrl !== 'string') {
+                throw new errors_1.InvalidPayloadError('Missing or invalid supportUrl');
+            }
+            if (!payload.context.footerLinkItems || !Array.isArray(payload.context.footerLinkItems)) {
+                throw new errors_1.InvalidPayloadError('Missing or invalid footerLinkItems');
+            }
+            for (const footerLinkItem of payload.context.footerLinkItems) {
+                if (!footerLinkItem.text || typeof footerLinkItem.text !== 'string') {
+                    throw new errors_1.InvalidPayloadError('Missing or invalid footerLinkItem text');
+                }
+                if (!footerLinkItem.link || typeof footerLinkItem.link !== 'string') {
+                    throw new errors_1.InvalidPayloadError('Missing or invalid footerLinkItem link');
+                }
+            }
+            if (!payload.context.disclaimer || typeof payload.context.disclaimer !== 'string') {
+                throw new errors_1.InvalidPayloadError('Missing or invalid disclaimer');
+            }
+            break;
+    }
+    if (payload.id === 'action' || payload.id === 'confirmation') {
+        if (!payload.context.ctaLinkItem || typeof payload.context.ctaLinkItem !== 'object') {
+            throw new errors_1.InvalidPayloadError('Missing or invalid ctaLinkItem');
+        }
+        if (!payload.context.ctaLinkItem.text || typeof payload.context.ctaLinkItem.text !== 'string') {
+            throw new errors_1.InvalidPayloadError('Missing or invalid ctaLinkItem text');
+        }
+        if (!payload.context.ctaLinkItem.link || typeof payload.context.ctaLinkItem.link !== 'string') {
+            throw new errors_1.InvalidPayloadError('Missing or invalid ctaLinkItem link');
+        }
     }
     return true;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/notification",
-  "version": "0.2.2",
+  "version": "0.3.0-next.0-experimental-5b18257",
   "description": "Forge Notification SDK",
   "main": "out/index.js",
   "types": "out/index.d.ts",