@forge/notification 0.1.1-next.0 → 0.2.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @forge/notification
 
+## 0.2.0-next.1
+
+### Minor Changes
+
+- 3b828b6: Cleanup unsupported API
+
 ## 0.1.1-next.0
 
 ### Patch Changes

package/out/fetch.d.ts

@@ -1,6 +1,4 @@
 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

@@ -1 +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"}
+{"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;AAE1F,eAAO,MAAM,IAAI,aAAoB,MAAM,QAAQ,OAAO,aAAa,WAAW,KAAG,QAAQ,WAAW,CAUvG,CAAC"}

package/out/fetch.js

@@ -1,8 +1,7 @@
 "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 = 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',
@@ -14,13 +13,3 @@ const post = async (endpoint, body, apiClient) => {
     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

@@ -1,6 +1,6 @@
 export { NotificationApi } from './notification-api';
 export { NotificationApi as default } from './notification-api';
-export { NotificationPayload, DeliveryChannel, RecipientType, StatusDetails, MessageTemplateContext, NotificationResponse, NotificationStatusResponse, EmailRecipient } from './types';
+export { NotificationPayload, DeliveryChannel, RecipientType, MessageTemplateContext, 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,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"}
+{"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"}

package/out/notification-api.d.ts

@@ -1,9 +1,8 @@
 import { FetchMethod } from '@forge/api';
-import { DeliveryChannel, NotificationPayload, NotificationResponse, NotificationStatusResponse, RecipientType } from './types';
+import { NotificationPayload, NotificationResponse } 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>;
 }
 //# 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,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"}
+{"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,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAIpE,qBAAa,eAAe;IACd,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,GAAE,WAAqC;IAEvE,gBAAgB,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAcpF"}

package/out/notification-api.js

@@ -4,7 +4,6 @@ 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 util_1 = require("./util");
 class NotificationApi {
@@ -17,27 +16,11 @@ class NotificationApi {
         const triggerId = (0, uuid_1.v4)();
         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');
+        await (0, validators_1.validateAPIResponse)(response);
         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 ? (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();
-        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
-        };
-    }
 }
 exports.NotificationApi = NotificationApi;

package/out/types.d.ts

@@ -52,17 +52,5 @@ 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

@@ -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;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"}
+{"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"}

package/out/validators.d.ts

@@ -1,6 +1,5 @@
-import { DeliveryChannel, NotificationPayload, RecipientType } from './types';
+import { NotificationPayload } 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>;
+export declare const validateAPIResponse: (response: APIResponse) => 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":"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"}
+{"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"}

package/out/validators.js

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateAPIResponse = exports.validateNotificationStatusParams = exports.validateNotificationPayload = void 0;
+exports.validateAPIResponse = 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');
@@ -47,38 +46,7 @@ const validateNotificationPayload = (payload) => {
     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) => {
+const validateAPIResponse = async (response) => {
     if (!response || typeof response !== 'object') {
         throw new errors_1.InternalServerError('Unexpected response object');
     }
@@ -86,7 +54,7 @@ const validateAPIResponse = async (response, method) => {
         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());
+        throw new errors_1.InternalServerError(`Failed to send notification: ${response.statusText}`, response.status, await response.text());
     }
 };
 exports.validateAPIResponse = validateAPIResponse;

package/package.json

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