@clipboard-health/notifications 2.5.0 → 2.5.2

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@clipboard-health/notifications",
   "description": "Send notifications through third-party providers.",
-  "version": "2.5.0",
+  "version": "2.5.2",
   "bugs": "https://github.com/ClipboardHealth/core-utils/issues",
   "dependencies": {
-    "@clipboard-health/background-jobs-adapter": "1.5.0",
-    "@clipboard-health/phone-number": "1.5.0",
-    "@clipboard-health/util-ts": "4.5.0",
+    "@clipboard-health/background-jobs-adapter": "1.5.2",
+    "@clipboard-health/phone-number": "1.5.2",
+    "@clipboard-health/util-ts": "4.5.2",
     "@knocklabs/node": "1.24.0",
     "tslib": "2.8.1"
   },
   "devDependencies": {
-    "@clipboard-health/testing-core": "1.5.0",
+    "@clipboard-health/testing-core": "1.5.2",
     "type-fest": "5.3.1"
   },
   "keywords": [],

package/src/lib/internal/triggerIdempotencyKeyParamsToHash.js

@@ -5,16 +5,18 @@ const createDeterministicHash_1 = require("./createDeterministicHash");
 function triggerIdempotencyKeyParamsToHash(params) {
     return (0, createDeterministicHash_1.createDeterministicHash)(toSorted(params));
 }
+/**
+ * Sort the object keys to ensure a deterministic hash.
+ */
 function toSorted(params) {
     return {
         chunk: params.chunk,
         eventOccurredAt: params.eventOccurredAt,
         recipients: [...params.recipients].sort(),
-        resourceId: "resourceId" in params
-            ? params.resourceId
-            : "resource" in params && params.resource && "id" in params.resource
-                ? params.resource.id
-                : undefined,
+        resource: {
+            id: params.resource?.id,
+            type: params.resource?.type,
+        },
         workflowKey: params.workflowKey,
         workplaceId: params.workplaceId,
     };

package/src/lib/internal/triggerIdempotencyKeyParamsToHash.js.map

@@ -1 +1 @@
-{"version":3,"file":"triggerIdempotencyKeyParamsToHash.js","sourceRoot":"","sources":["../../../../../../packages/notifications/src/lib/internal/triggerIdempotencyKeyParamsToHash.ts"],"names":[],"mappings":";;AAOA,8EAEC;AARD,uEAAoE;AAMpE,SAAgB,iCAAiC,CAAC,MAAkB;IAClE,OAAO,IAAA,iDAAuB,EAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;AACnD,CAAC;AAED,SAAS,QAAQ,CAAC,MAAkB;IAClC,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,eAAe,EAAE,MAAM,CAAC,eAAe;QACvC,UAAU,EAAE,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE;QACzC,UAAU,EACR,YAAY,IAAI,MAAM;YACpB,CAAC,CAAC,MAAM,CAAC,UAAU;YACnB,CAAC,CAAC,UAAU,IAAI,MAAM,IAAI,MAAM,CAAC,QAAQ,IAAI,IAAI,IAAI,MAAM,CAAC,QAAQ;gBAClE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE;gBACpB,CAAC,CAAC,SAAS;QACjB,WAAW,EAAE,MAAM,CAAC,WAAW;QAC/B,WAAW,EAAE,MAAM,CAAC,WAAW;KAChC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"triggerIdempotencyKeyParamsToHash.js","sourceRoot":"","sources":["../../../../../../packages/notifications/src/lib/internal/triggerIdempotencyKeyParamsToHash.ts"],"names":[],"mappings":";;AAOA,8EAEC;AARD,uEAAoE;AAMpE,SAAgB,iCAAiC,CAAC,MAAkB;IAClE,OAAO,IAAA,iDAAuB,EAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;AACnD,CAAC;AAED;;GAEG;AACH,SAAS,QAAQ,CAAC,MAAkB;IAClC,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,eAAe,EAAE,MAAM,CAAC,eAAe;QACvC,UAAU,EAAE,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE;QACzC,QAAQ,EAAE;YACR,EAAE,EAAE,MAAM,CAAC,QAAQ,EAAE,EAAE;YACvB,IAAI,EAAE,MAAM,CAAC,QAAQ,EAAE,IAAI;SAC5B;QACD,WAAW,EAAE,MAAM,CAAC,WAAW;QAC/B,WAAW,EAAE,MAAM,CAAC,WAAW;KAChC,CAAC;AACJ,CAAC"}

package/src/lib/notificationJobEnqueuer.d.ts

@@ -1,14 +1,7 @@
 import { type BackgroundJobsAdapter, type EnqueueOptions, type MongoEnqueueOptions, type PostgresEnqueueOptions } from "@clipboard-health/background-jobs-adapter";
 import { type TriggerIdempotencyKey } from "./triggerIdempotencyKey";
 type EnqueueParameters = Parameters<BackgroundJobsAdapter["enqueue"]>;
-/**
- * @deprecated Use `IdempotencyKeyParts` instead.
- */
-export interface IdempotencyKey {
-    eventOccurredAt?: string | undefined;
-    resourceId?: string | undefined;
-}
-export type IdempotencyKeyParts = {
+export interface IdempotencyKeyParts {
     /**
      * Prefer `resourceId` over `eventOccurredAt`; it's harder to misuse.
      *
@@ -17,10 +10,7 @@ export type IdempotencyKeyParts = {
      *
      * Use `.toISOString()`.
      */
-    eventOccurredAt: string;
-    resource?: undefined;
-} | {
-    eventOccurredAt?: undefined;
+    eventOccurredAt?: string;
     /**
      * Do not include `workflowKey`, `recipients`, or `workplaceId`; they are included
      * automatically.
@@ -31,16 +21,12 @@ export type IdempotencyKeyParts = {
      * 1. For a "meeting starts in one hour" notification, set resourceId to the meeting ID.
      * 2. For a payout notification, set resourceId to the payment ID.
      */
-    resource: {
+    resource?: {
         type: string;
         id: string;
     };
-};
+}
 export interface NotificationEnqueueData {
-    /**
-     * @deprecated Use `idempotencyKeyParts` instead.
-     */
-    idempotencyKey?: IdempotencyKey;
     /**
      * Do not include `workflowKey`, `recipients`, or `workplaceId`; they are included
      * automatically.
@@ -59,7 +45,7 @@ export interface NotificationEnqueueData {
      * same notification multiple times within the idempotency key's validity window, the recipient
      * will only receive the first notification.
      */
-    idempotencyKeyParts?: IdempotencyKeyParts;
+    idempotencyKeyParts: IdempotencyKeyParts;
     /** @see {@link TriggerRequest.expiresAt} */
     expiresAt: string;
     /** @see {@link TriggerBody.recipients} */
@@ -67,7 +53,7 @@ export interface NotificationEnqueueData {
     /** @see {@link TriggerRequest.workflowKey} */
     workflowKey: string;
 }
-export interface NotificationJobData extends Omit<NotificationEnqueueData, "idempotencyKey"> {
+export interface NotificationJobData extends Omit<NotificationEnqueueData, "idempotencyKeyParts"> {
     idempotencyKey: TriggerIdempotencyKey;
 }
 /**
@@ -103,7 +89,7 @@ export interface NotificationData<T> {
  * There are valid use cases for `startAt`, however. For example, if you do checks in your job (or
  * in a service the job calls) to validate the notification is still valid prior to triggering it.
  */
-export type EnqueueOneOrMoreOptions = Pick<EnqueueOptions, "startAt"> & (Pick<MongoEnqueueOptions, "session" | "startAt"> | Pick<PostgresEnqueueOptions, "transaction" | "startAt">);
+export type EnqueueOneOrMoreOptions = Pick<EnqueueOptions, "startAt"> & (Pick<MongoEnqueueOptions, "session"> | Pick<PostgresEnqueueOptions, "transaction">);
 interface NotificationJobEnqueuerParams {
     adapter: BackgroundJobsAdapter;
 }

package/src/lib/notificationJobEnqueuer.js

@@ -86,7 +86,6 @@ class NotificationJobEnqueuer {
     async enqueueOneOrMore(handlerClassOrInstance, data, options) {
         await Promise.all((0, chunkRecipients_1.chunkRecipients)({ recipients: data.recipients }).map(async ({ number, recipients }) => {
             const idempotencyKeyParams = {
-                ...data.idempotencyKey,
                 ...data.idempotencyKeyParts,
                 chunk: number,
                 recipients,

package/src/lib/notificationJobEnqueuer.js.map

@@ -1 +1 @@
-{"version":3,"file":"notificationJobEnqueuer.js","sourceRoot":"","sources":["../../../../../packages/notifications/src/lib/notificationJobEnqueuer.ts"],"names":[],"mappings":";;;AAAA,uFAMmD;AAEnD,gEAA6D;AAC7D,oGAAiG;AACjG,mEAIiC;AAoIjC,MAAa,uBAAuB;IACjB,OAAO,CAA2C;IAEnE,YAAY,MAAqC;QAC/C,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAE3B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuEG;IACH,KAAK,CAAC,gBAAgB,CACpB,sBAA4C,EAC5C,IAAkB,EAClB,OAAiC;QAEjC,MAAM,OAAO,CAAC,GAAG,CACf,IAAA,iCAAe,EAAC,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,EAAE;YACpF,MAAM,oBAAoB,GAAgC;gBACxD,GAAG,IAAI,CAAC,cAAc;gBACtB,GAAG,IAAI,CAAC,mBAAmB;gBAC3B,KAAK,EAAE,MAAM;gBACb,UAAU;gBACV,WAAW,EAAE,IAAI,CAAC,WAAW;aAC9B,CAAC;YAEF,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CACxB,sBAAsB,EACtB;gBACE,GAAG,IAAI;gBACP,UAAU;gBACV,cAAc,EAAE,IAAA,yDAAiC,EAAC,oBAAoB,CAAC;aACxE,EACD;gBACE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAClC,CAAC,6CAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,cAAc,CAAC,EAC/D,IAAA,qEAAiC,EAAC,oBAAoB,CAAC;aAC1D,CACF,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;CACF;AAhHD,0DAgHC"}
+{"version":3,"file":"notificationJobEnqueuer.js","sourceRoot":"","sources":["../../../../../packages/notifications/src/lib/notificationJobEnqueuer.ts"],"names":[],"mappings":";;;AAAA,uFAMmD;AAEnD,gEAA6D;AAC7D,oGAAiG;AACjG,mEAIiC;AA8GjC,MAAa,uBAAuB;IACjB,OAAO,CAA2C;IAEnE,YAAY,MAAqC;QAC/C,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAE3B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuEG;IACH,KAAK,CAAC,gBAAgB,CACpB,sBAA4C,EAC5C,IAAkB,EAClB,OAAiC;QAEjC,MAAM,OAAO,CAAC,GAAG,CACf,IAAA,iCAAe,EAAC,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,EAAE;YACpF,MAAM,oBAAoB,GAAgC;gBACxD,GAAG,IAAI,CAAC,mBAAmB;gBAC3B,KAAK,EAAE,MAAM;gBACb,UAAU;gBACV,WAAW,EAAE,IAAI,CAAC,WAAW;aAC9B,CAAC;YAEF,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CACxB,sBAAsB,EACtB;gBACE,GAAG,IAAI;gBACP,UAAU;gBACV,cAAc,EAAE,IAAA,yDAAiC,EAAC,oBAAoB,CAAC;aACxE,EACD;gBACE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAClC,CAAC,6CAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,cAAc,CAAC,EAC/D,IAAA,qEAAiC,EAAC,oBAAoB,CAAC;aAC1D,CACF,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;CACF;AA/GD,0DA+GC"}

package/src/lib/triggerIdempotencyKey.d.ts

@@ -1,5 +1,5 @@
 import { type Tagged } from "type-fest";
-import { type IdempotencyKey, type IdempotencyKeyParts } from "./notificationJobEnqueuer";
+import { type IdempotencyKeyParts } from "./notificationJobEnqueuer";
 /**
  * Idempotency keys prevent duplicate notifications. `NotificationClient.trigger` should be called
  * after properly enqueuing a job using `NotificationJobEnqueuer.enqueueOneOrMore` to help ensure
@@ -10,7 +10,7 @@ import { type IdempotencyKey, type IdempotencyKeyParts } from "./notificationJob
  * unnecessary.
  */
 export type TriggerIdempotencyKey = Tagged<string, "TriggerIdempotencyKey">;
-export type TriggerIdempotencyKeyParams = (IdempotencyKey | IdempotencyKeyParts) & {
+export type TriggerIdempotencyKeyParams = IdempotencyKeyParts & {
     /**
      * The recipient chunk number.
      */

package/src/lib/triggerIdempotencyKey.js

@@ -23,6 +23,6 @@ function isTriggerIdempotencyKeyParams(value) {
  */
 function DO_NOT_CALL_THIS_OUTSIDE_OF_TESTS(params) {
     // eslint-disable-next-line no-restricted-syntax -- allow test casts
-    return JSON.stringify(params);
+    return (0, util_ts_1.stringify)(params);
 }
 //# sourceMappingURL=triggerIdempotencyKey.js.map

package/src/lib/triggerIdempotencyKey.js.map

@@ -1 +1 @@
-{"version":3,"file":"triggerIdempotencyKey.js","sourceRoot":"","sources":["../../../../../packages/notifications/src/lib/triggerIdempotencyKey.ts"],"names":[],"mappings":";;AAyCA,sEAeC;AAMD,8EAKC;AAnED,uDAAkD;AAsClD;;GAEG;AACH,SAAgB,6BAA6B,CAC3C,KAAc;IAEd,IAAI,IAAA,eAAK,EAAC,KAAK,CAAC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,MAAM,GAAG,KAAoC,CAAC;IACpD,OAAO,CACL,OAAO,IAAI,MAAM;QACjB,aAAa,IAAI,MAAM;QACvB,YAAY,IAAI,MAAM;QACtB,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC;QAChC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,OAAO,SAAS,KAAK,QAAQ,CAAC,CACtE,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAgB,iCAAiC,CAC/C,MAAmC;IAEnC,oEAAoE;IACpE,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAA0B,CAAC;AACzD,CAAC"}
+{"version":3,"file":"triggerIdempotencyKey.js","sourceRoot":"","sources":["../../../../../packages/notifications/src/lib/triggerIdempotencyKey.ts"],"names":[],"mappings":";;AAwCA,sEAeC;AAMD,8EAKC;AAlED,uDAA6D;AAqC7D;;GAEG;AACH,SAAgB,6BAA6B,CAC3C,KAAc;IAEd,IAAI,IAAA,eAAK,EAAC,KAAK,CAAC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,MAAM,GAAG,KAAoC,CAAC;IACpD,OAAO,CACL,OAAO,IAAI,MAAM;QACjB,aAAa,IAAI,MAAM;QACvB,YAAY,IAAI,MAAM;QACtB,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC;QAChC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,OAAO,SAAS,KAAK,QAAQ,CAAC,CACtE,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAgB,iCAAiC,CAC/C,MAAmC;IAEnC,oEAAoE;IACpE,OAAO,IAAA,mBAAS,EAAC,MAAM,CAA0B,CAAC;AACpD,CAAC"}