@betterinternship/core 2.23.2 → 2.24.0

package/README.md

@@ -1,26 +1,26 @@
-# Package.Core
-
-Contains dependencies shared between the different services of the site.
-
-## How to update
-
-1. Build the package:
-
-```bash
-npm run build
-```
-
-2. Commit the build:
-
-```bash
-git add .
-git commit -m "<follow conventional commits, k thanks>"
-git push
-```
-
-3. Update the version and publish the package to NPM:
-
-```bash
-npm version <patch|minor|major>
-npm publish
-```
+# Package.Core
+
+Contains dependencies shared between the different services of the site.
+
+## How to update
+
+1. Build the package:
+
+```bash
+npm run build
+```
+
+2. Commit the build:
+
+```bash
+git add .
+git commit -m "<follow conventional commits, k thanks>"
+git push
+```
+
+3. Update the version and publish the package to NPM:
+
+```bash
+npm version <patch|minor|major>
+npm publish
+```

package/dist/lib/email/archive.d.ts

@@ -10,4 +10,4 @@ export interface IArchiveContext {
     tags?: Record<string, string>;
     configurationSetName?: string;
 }
-export declare const archiveSentEmail: (context: IArchiveContext, messageId: string | undefined, attempts: number) => Promise<void>;
+export declare const archiveSentEmail: (context: IArchiveContext, messageId: string | undefined, attempts: number, idempotencyKey?: string) => Promise<void>;

package/dist/lib/email/archive.js

@@ -55,19 +55,31 @@ const recordArchiveEvent = async (event) => {
             attempts: event.attempts,
             correlation_type: event.correlationDetail ? 'email_archive' : null,
             correlation_detail: event.correlationDetail,
+            message_id: event.idempotencyKey ?? null,
         })
             .execute();
     }
     catch (error) {
         console.error('[ERROR:EMAIL_ARCHIVE] Could not record archive event.', error);
+        if (event.idempotencyKey)
+            console.error(`[ERROR:EMAIL_ARCHIVE] Dedup record for key ${event.idempotencyKey} was NOT written; a redelivery of this message would send it again.`);
     }
 };
-export const archiveSentEmail = async (context, messageId, attempts) => {
+export const archiveSentEmail = async (context, messageId, attempts, idempotencyKey) => {
     const bucketName = getArchiveBucketName();
-    if (!bucketName)
-        return;
     const sentAt = new Date();
     const idForKey = messageId ?? randomUUID();
+    if (!bucketName) {
+        if (idempotencyKey)
+            await recordArchiveEvent({
+                recipient: context.to[0],
+                feedbackId: idForKey,
+                attempts,
+                correlationDetail: null,
+                idempotencyKey,
+            });
+        return;
+    }
     const key = buildObjectKey(sentAt, idForKey);
     const payload = {
         message_id: messageId ?? null,
@@ -102,6 +114,7 @@ export const archiveSentEmail = async (context, messageId, attempts) => {
         feedbackId: idForKey,
         attempts,
         correlationDetail: uploadedKey,
+        idempotencyKey,
     });
 };
 //# sourceMappingURL=archive.js.map

package/dist/lib/email/archive.js.map

@@ -1 +1 @@
-{"version":3,"file":"archive.js","sourceRoot":"","sources":["../../../lib/email/archive.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAgBhC,IAAI,mBAAmB,GAAG,KAAK,CAAC;AAChC,IAAI,wBAAwB,GAAG,KAAK,CAAC;AAGrC,MAAM,oBAAoB,GAAG,GAAuB,EAAE;IACpD,MAAM,UAAU,GAAG,GAAG,CAAC,oBAAoB,CAAC;IAC5C,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACzB,OAAO,CAAC,IAAI,CACV,iFAAiF,CAClF,CAAC;YACF,mBAAmB,GAAG,IAAI,CAAC;QAC7B,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,CAAC,GAAG,CAAC,wBAAwB,IAAI,CAAC,GAAG,CAAC,uBAAuB,EAAE,CAAC;QAClE,IAAI,CAAC,wBAAwB,EAAE,CAAC;YAC9B,OAAO,CAAC,KAAK,CACX,uJAAuJ,CACxJ,CAAC;YACF,wBAAwB,GAAG,IAAI,CAAC;QAClC,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AASF,IAAI,OAAO,GAAkD,IAAI,CAAC;AAClE,MAAM,gBAAgB,GAAG,KAAK,EAAE,UAAkB,EAAE,EAAE;IACpD,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,MAAM,CAAC,uBAAuB,CAAC,CAAC;QAC1D,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,wBAAyB,CAG3D,CAAC;QACF,OAAO,GAAG,IAAI,OAAO,CAAC;YACpB,SAAS,EAAE,GAAG,CAAC,uBAAuB;YACtC,WAAW;SACZ,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IACxB,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAGF,MAAM,cAAc,GAAG,CAAC,MAAY,EAAE,QAAgB,EAAE,EAAE;IACxD,MAAM,GAAG,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;IACjC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACvD,MAAM,kBAAkB,GAAG,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IACrD,MAAM,GAAG,GAAG,iBAAiB,IAAI,IAAI,KAAK,IAAI,GAAG,IAAI,kBAAkB,IAAI,QAAQ,OAAO,CAAC;IAE3F,OAAO,GAAG,CAAC,QAAQ,KAAK,YAAY,CAAC,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;AAC9D,CAAC,CAAC;AAMF,MAAM,kBAAkB,GAAG,KAAK,EAAE,KAKjC,EAAE,EAAE;IACH,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC;QACtB,OAAO,CAAC,IAAI,CACV,mEAAmE,CACpE,CAAC;QACF,OAAO;IACT,CAAC;IACD,IAAI,CAAC;QAKH,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,MAAM,CAAC,0BAA0B,CAAC,CAAC;QAChE,MAAM,UAAU;aACb,UAAU,CAAC,gCAAgC,CAAC;aAC5C,MAAM,CAAC;YACN,UAAU,EAAE,cAAc;YAC1B,eAAe,EAAE,KAAK,CAAC,SAAS;YAChC,WAAW,EAAE,KAAK,CAAC,UAAU;YAC7B,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,gBAAgB,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI;YAClE,kBAAkB,EAAE,KAAK,CAAC,iBAAiB;SAC5C,CAAC;aACD,OAAO,EAAE,CAAC;IACf,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CACX,uDAAuD,EACvD,KAAK,CACN,CAAC;IACJ,CAAC;AACH,CAAC,CAAC;AAMF,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,EACnC,OAAwB,EACxB,SAA6B,EAC7B,QAAgB,EACD,EAAE;IACjB,MAAM,UAAU,GAAG,oBAAoB,EAAE,CAAC;IAC1C,IAAI,CAAC,UAAU;QAAE,OAAO;IAExB,MAAM,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;IAC1B,MAAM,QAAQ,GAAG,SAAS,IAAI,UAAU,EAAE,CAAC;IAC3C,MAAM,GAAG,GAAG,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAE7C,MAAM,OAAO,GAAG;QACd,UAAU,EAAE,SAAS,IAAI,IAAI;QAC7B,OAAO,EAAE,MAAM,CAAC,WAAW,EAAE;QAC7B,OAAO,EAAE,GAAG,CAAC,qBAAqB;QAClC,QAAQ;QACR,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,IAAI;QAC9B,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,EAAE,EAAE,OAAO,CAAC,EAAE;QACd,EAAE,EAAE,OAAO,CAAC,EAAE;QACd,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,sBAAsB,EAAE,OAAO,CAAC,oBAAoB,IAAI,IAAI;KAC7D,CAAC;IAEF,IAAI,WAAW,GAAkB,IAAI,CAAC;IACtC,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,UAAU,CAAC,CAAC;QAClD,MAAM,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE;YAC5D,WAAW,EAAE,kBAAkB;YAC/B,SAAS,EAAE,KAAK;SACjB,CAAC,CAAC;QACH,WAAW,GAAG,GAAG,CAAC;IACpB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CACX,wDAAwD,EACxD,KAAK,CACN,CAAC;IACJ,CAAC;IAED,MAAM,kBAAkB,CAAC;QACvB,SAAS,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;QACxB,UAAU,EAAE,QAAQ;QACpB,QAAQ;QACR,iBAAiB,EAAE,WAAW;KAC/B,CAAC,CAAC;AACL,CAAC,CAAC"}
+{"version":3,"file":"archive.js","sourceRoot":"","sources":["../../../lib/email/archive.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAgBhC,IAAI,mBAAmB,GAAG,KAAK,CAAC;AAChC,IAAI,wBAAwB,GAAG,KAAK,CAAC;AAGrC,MAAM,oBAAoB,GAAG,GAAuB,EAAE;IACpD,MAAM,UAAU,GAAG,GAAG,CAAC,oBAAoB,CAAC;IAC5C,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACzB,OAAO,CAAC,IAAI,CACV,iFAAiF,CAClF,CAAC;YACF,mBAAmB,GAAG,IAAI,CAAC;QAC7B,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,CAAC,GAAG,CAAC,wBAAwB,IAAI,CAAC,GAAG,CAAC,uBAAuB,EAAE,CAAC;QAClE,IAAI,CAAC,wBAAwB,EAAE,CAAC;YAC9B,OAAO,CAAC,KAAK,CACX,uJAAuJ,CACxJ,CAAC;YACF,wBAAwB,GAAG,IAAI,CAAC;QAClC,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AASF,IAAI,OAAO,GAAkD,IAAI,CAAC;AAClE,MAAM,gBAAgB,GAAG,KAAK,EAAE,UAAkB,EAAE,EAAE;IACpD,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,MAAM,CAAC,uBAAuB,CAAC,CAAC;QAC1D,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,wBAAyB,CAG3D,CAAC;QACF,OAAO,GAAG,IAAI,OAAO,CAAC;YACpB,SAAS,EAAE,GAAG,CAAC,uBAAuB;YACtC,WAAW;SACZ,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IACxB,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAGF,MAAM,cAAc,GAAG,CAAC,MAAY,EAAE,QAAgB,EAAE,EAAE;IACxD,MAAM,GAAG,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;IACjC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACvD,MAAM,kBAAkB,GAAG,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IACrD,MAAM,GAAG,GAAG,iBAAiB,IAAI,IAAI,KAAK,IAAI,GAAG,IAAI,kBAAkB,IAAI,QAAQ,OAAO,CAAC;IAE3F,OAAO,GAAG,CAAC,QAAQ,KAAK,YAAY,CAAC,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;AAC9D,CAAC,CAAC;AAMF,MAAM,kBAAkB,GAAG,KAAK,EAAE,KAMjC,EAAE,EAAE;IACH,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC;QACtB,OAAO,CAAC,IAAI,CACV,mEAAmE,CACpE,CAAC;QACF,OAAO;IACT,CAAC;IACD,IAAI,CAAC;QAKH,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,MAAM,CAAC,0BAA0B,CAAC,CAAC;QAChE,MAAM,UAAU;aACb,UAAU,CAAC,gCAAgC,CAAC;aAC5C,MAAM,CAAC;YACN,UAAU,EAAE,cAAc;YAC1B,eAAe,EAAE,KAAK,CAAC,SAAS;YAChC,WAAW,EAAE,KAAK,CAAC,UAAU;YAC7B,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,gBAAgB,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI;YAClE,kBAAkB,EAAE,KAAK,CAAC,iBAAiB;YAC3C,UAAU,EAAE,KAAK,CAAC,cAAc,IAAI,IAAI;SACzC,CAAC;aACD,OAAO,EAAE,CAAC;IACf,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CACX,uDAAuD,EACvD,KAAK,CACN,CAAC;QAOF,IAAI,KAAK,CAAC,cAAc;YACtB,OAAO,CAAC,KAAK,CACX,8CAA8C,KAAK,CAAC,cAAc,qEAAqE,CACxI,CAAC;IACN,CAAC;AACH,CAAC,CAAC;AAMF,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,EACnC,OAAwB,EACxB,SAA6B,EAC7B,QAAgB,EAChB,cAAuB,EACR,EAAE;IACjB,MAAM,UAAU,GAAG,oBAAoB,EAAE,CAAC;IAC1C,MAAM,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;IAC1B,MAAM,QAAQ,GAAG,SAAS,IAAI,UAAU,EAAE,CAAC;IAI3C,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,IAAI,cAAc;YAChB,MAAM,kBAAkB,CAAC;gBACvB,SAAS,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;gBACxB,UAAU,EAAE,QAAQ;gBACpB,QAAQ;gBACR,iBAAiB,EAAE,IAAI;gBACvB,cAAc;aACf,CAAC,CAAC;QACL,OAAO;IACT,CAAC;IAED,MAAM,GAAG,GAAG,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAE7C,MAAM,OAAO,GAAG;QACd,UAAU,EAAE,SAAS,IAAI,IAAI;QAC7B,OAAO,EAAE,MAAM,CAAC,WAAW,EAAE;QAC7B,OAAO,EAAE,GAAG,CAAC,qBAAqB;QAClC,QAAQ;QACR,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,IAAI;QAC9B,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,EAAE,EAAE,OAAO,CAAC,EAAE;QACd,EAAE,EAAE,OAAO,CAAC,EAAE;QACd,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,sBAAsB,EAAE,OAAO,CAAC,oBAAoB,IAAI,IAAI;KAC7D,CAAC;IAEF,IAAI,WAAW,GAAkB,IAAI,CAAC;IACtC,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,UAAU,CAAC,CAAC;QAClD,MAAM,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE;YAC5D,WAAW,EAAE,kBAAkB;YAC/B,SAAS,EAAE,KAAK;SACjB,CAAC,CAAC;QACH,WAAW,GAAG,GAAG,CAAC;IACpB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CACX,wDAAwD,EACxD,KAAK,CACN,CAAC;IACJ,CAAC;IAED,MAAM,kBAAkB,CAAC;QACvB,SAAS,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;QACxB,UAAU,EAAE,QAAQ;QACpB,QAAQ;QACR,iBAAiB,EAAE,WAAW;QAC9B,cAAc;KACf,CAAC,CAAC;AACL,CAAC,CAAC"}

package/dist/lib/email/email.d.ts

@@ -1,5 +1,8 @@
 type EmailAlias = 'otp' | 'applications' | 'sign' | 'hello' | 'apply';
-export interface IEmailParams {
+interface IIdempotency {
+    idempotencyKey?: string;
+}
+export interface IEmailParams extends IIdempotency {
     sender?: string;
     subject: string;
     recipient: string;
@@ -8,7 +11,7 @@ export interface IEmailParams {
     configurationSetName?: string;
     tags?: Record<string, string>;
 }
-export interface IMultiEmailParams {
+export interface IMultiEmailParams extends IIdempotency {
     sender?: string;
     subject: string;
     to: string | string[];
@@ -19,12 +22,11 @@ export interface IMultiEmailParams {
     configurationSetName?: string;
     tags?: Record<string, string>;
 }
-export declare const sendMultiEmail: ({ sender, subject, to, cc, bcc, content, alias, configurationSetName, tags, }: IMultiEmailParams) => Promise<{
-    messageId: string | undefined;
-    response: string;
-} | undefined>;
-export declare const sendSingleEmail: (params: IEmailParams) => Promise<{
-    messageId: string | undefined;
+export interface ISendResult {
+    messageId?: string;
     response: string;
-} | undefined>;
+    deduplicated?: boolean;
+}
+export declare const sendMultiEmail: ({ sender, subject, to, cc, bcc, content, alias, configurationSetName, tags, idempotencyKey, }: IMultiEmailParams) => Promise<ISendResult | undefined>;
+export declare const sendSingleEmail: (params: IEmailParams) => Promise<ISendResult | undefined>;
 export {};

package/dist/lib/email/email.js

@@ -53,6 +53,7 @@ const recordSendFailure = async (failure) => {
             feedback_id: randomUUID(),
             attempts: failure.attempts,
             error_message: describeError(failure.error),
+            message_id: failure.idempotencyKey ?? null,
         })
             .execute();
     }
@@ -60,6 +61,19 @@ const recordSendFailure = async (failure) => {
         console.error('[ERROR:EMAIL] Could not record send failure.', error);
     }
 };
+const hasAlreadyBeenSent = async (idempotencyKey) => {
+    if (!ENV.DATABASE_URL)
+        throw new Error('[ERROR:EMAIL] DATABASE_URL is not set; cannot honour an idempotency key.');
+    const { internalDb } = await import('@betterinternship/schema');
+    const existing = await internalDb
+        .selectFrom('internal.email_delivery_events')
+        .select('id')
+        .where('message_id', '=', idempotencyKey)
+        .where('event_type', '=', 'send_success')
+        .limit(1)
+        .executeTakeFirst();
+    return !!existing;
+};
 const normalizeRecipients = (value) => {
     if (!value)
         return [];
@@ -72,14 +86,18 @@ const toSesTags = (tags) => Object.entries(tags).map(([name, value]) => ({
     Name: name,
     Value: value.trim().slice(0, 256).replaceAll(' ', ''),
 }));
-const sendWithRetries = async (params, logRecipients, archiveContext) => {
+const sendWithRetries = async (params, logRecipients, archiveContext, idempotencyKey) => {
     const maxAttempts = getMaxAttempts();
     for (let attempt = 1; attempt <= maxAttempts; attempt++) {
         try {
             const command = new SendEmailCommand(params);
             const result = await getSesClient().send(command);
             console.warn('[AWSSES] Email sent to ' + logRecipients.join(', '));
-            void archiveSentEmail(archiveContext, result.MessageId, attempt).catch((error) => console.error('[ERROR:EMAIL_ARCHIVE] Archive failed.', error));
+            const archived = archiveSentEmail(archiveContext, result.MessageId, attempt, idempotencyKey).catch((error) => console.error('[ERROR:EMAIL_ARCHIVE] Archive failed.', error));
+            if (idempotencyKey)
+                await archived;
+            else
+                void archived;
             return {
                 messageId: result.MessageId,
                 response: 'Successfully sent via Amazon SES.',
@@ -97,16 +115,24 @@ const sendWithRetries = async (params, logRecipients, archiveContext) => {
                 recipient: logRecipients[0],
                 attempts: attempt,
                 error,
+                idempotencyKey,
             });
             return undefined;
         }
     }
     return undefined;
 };
-export const sendMultiEmail = async ({ sender, subject, to, cc, bcc, content, alias = 'hello', configurationSetName, tags, }) => {
+export const sendMultiEmail = async ({ sender, subject, to, cc, bcc, content, alias = 'hello', configurationSetName, tags, idempotencyKey, }) => {
     const toRecipients = normalizeRecipients(to);
     if (!toRecipients.length)
         throw Error('[ERROR:EMAIL] No recipients provided for email.');
+    if (idempotencyKey && (await hasAlreadyBeenSent(idempotencyKey))) {
+        console.warn(`[AWSSES] Skipping duplicate send for idempotency key ${idempotencyKey}.`);
+        return {
+            response: 'Already sent; skipped as a duplicate.',
+            deduplicated: true,
+        };
+    }
     const ccRecipients = normalizeRecipients(cc);
     const bccRecipients = normalizeRecipients(bcc);
     const logRecipients = [...toRecipients, ...ccRecipients, ...bccRecipients];
@@ -139,7 +165,7 @@ export const sendMultiEmail = async ({ sender, subject, to, cc, bcc, content, al
         tags,
         configurationSetName,
     };
-    return await sendWithRetries(params, logRecipients, archiveContext);
+    return await sendWithRetries(params, logRecipients, archiveContext, idempotencyKey);
 };
 export const sendSingleEmail = async (params) => {
     if (!normalizeRecipients(params.recipient).length) {

package/dist/lib/email/email.js.map

@@ -1 +1 @@
-{"version":3,"file":"email.js","sourceRoot":"","sources":["../../../lib/email/email.ts"],"names":[],"mappings":"AAcA,OAAO,EAEL,gBAAgB,EAEhB,SAAS,GACV,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAChC,OAAO,EAAE,gBAAgB,EAAmB,MAAM,cAAc,CAAC;AAmCjE,IAAI,UAAU,GAAqB,IAAI,CAAC;AACxC,MAAM,YAAY,GAAG,GAAc,EAAE;IACnC,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,IAAI,CAAC,GAAG,CAAC,iBAAiB,IAAI,CAAC,GAAG,CAAC,qBAAqB,IAAI,CAAC,GAAG,CAAC,UAAU;YACzE,OAAO,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAC;QACtD,UAAU,GAAG,IAAI,SAAS,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,UAAU,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC,CAAC;IACzE,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,GAAG,CAAC;AAChC,MAAM,kBAAkB,GAAG,CAAC,CAAC;AAE7B,MAAM,cAAc,GAAG,GAAG,EAAE;IAC1B,MAAM,MAAM,GAAG,QAAQ,CAAC,GAAG,CAAC,uBAAuB,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;IAC/D,OAAO,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;AAC7D,CAAC,CAAC;AAGF,MAAM,eAAe,GAAG,CAAC,OAAe,EAAE,EAAE;IAC1C,MAAM,IAAI,GAAG,mBAAmB,GAAG,kBAAkB,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC;IACvE,MAAM,MAAM,GAAG,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IACrD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,MAAM,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF,MAAM,KAAK,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AAMhF,MAAM,oBAAoB,GAAG,CAAC,KAAc,EAAE,EAAE;IAC9C,MAAM,GAAG,GAAG,KAGX,CAAC;IACF,IAAI,GAAG,CAAC,IAAI,KAAK,qBAAqB;QAAE,OAAO,IAAI,CAAC;IACpD,IAAI,GAAG,CAAC,IAAI,KAAK,0BAA0B;QAAE,OAAO,IAAI,CAAC;IACzD,MAAM,MAAM,GAAG,GAAG,CAAC,SAAS,EAAE,cAAc,CAAC;IAE7C,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IACtC,OAAO,MAAM,KAAK,GAAG,IAAI,MAAM,IAAI,GAAG,CAAC;AACzC,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,KAAc,EAAE,EAAE;IACvC,MAAM,GAAG,GAAG,KAA4C,CAAC;IACzD,OAAO,GAAG,GAAG,CAAC,IAAI,IAAI,OAAO,KAAK,GAAG,CAAC,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;AACnE,CAAC,CAAC;AASF,MAAM,iBAAiB,GAAG,KAAK,EAAE,OAIhC,EAAE,EAAE;IACH,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC;QACtB,OAAO,CAAC,IAAI,CAAC,0DAA0D,CAAC,CAAC;QACzE,OAAO;IACT,CAAC;IACD,IAAI,CAAC;QAKH,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,MAAM,CAAC,0BAA0B,CAAC,CAAC;QAChE,MAAM,UAAU;aACb,UAAU,CAAC,gCAAgC,CAAC;aAC5C,MAAM,CAAC;YACN,UAAU,EAAE,cAAc;YAC1B,eAAe,EAAE,OAAO,CAAC,SAAS;YAClC,WAAW,EAAE,UAAU,EAAE;YACzB,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,aAAa,EAAE,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC;SAC5C,CAAC;aACD,OAAO,EAAE,CAAC;IACf,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,8CAA8C,EAAE,KAAK,CAAC,CAAC;IACvE,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,KAAyB,EAAE,EAAE;IACxD,IAAI,CAAC,KAAK;QAAE,OAAO,EAAE,CAAC;IAEtB,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IACpD,OAAO;QACL,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;KACtE,CAAC;AACJ,CAAC,CAAC;AAGF,MAAM,SAAS,GAAG,CAAC,IAA4B,EAAgB,EAAE,CAC/D,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;IAC3C,IAAI,EAAE,IAAI;IACV,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC;CACtD,CAAC,CAAC,CAAC;AAEN,MAAM,eAAe,GAAG,KAAK,EAC3B,MAA6B,EAC7B,aAAuB,EACvB,cAA+B,EAC/B,EAAE;IACF,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IAErC,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,IAAI,WAAW,EAAE,OAAO,EAAE,EAAE,CAAC;QACxD,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,IAAI,gBAAgB,CAAC,MAAM,CAAC,CAAC;YAC7C,MAAM,MAAM,GAAG,MAAM,YAAY,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAClD,OAAO,CAAC,IAAI,CAAC,yBAAyB,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YACnE,KAAK,gBAAgB,CAAC,cAAc,EAAE,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,KAAK,CACpE,CAAC,KAAK,EAAE,EAAE,CACR,OAAO,CAAC,KAAK,CAAC,uCAAuC,EAAE,KAAK,CAAC,CAChE,CAAC;YACF,OAAO;gBACL,SAAS,EAAE,MAAM,CAAC,SAAS;gBAC3B,QAAQ,EAAE,mCAAmC;aAC9C,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,oBAAoB,CAAC,KAAK,CAAC,IAAI,OAAO,GAAG,WAAW,EAAE,CAAC;gBACzD,MAAM,KAAK,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;gBACvC,OAAO,CAAC,KAAK,CACX,uCAAuC,OAAO,IAAI,WAAW,kBAAkB,KAAK,OAAO,aAAa,CAAC,KAAK,CAAC,EAAE,CAClH,CAAC;gBACF,MAAM,KAAK,CAAC,KAAK,CAAC,CAAC;gBACnB,SAAS;YACX,CAAC;YAED,OAAO,CAAC,KAAK,CACX,gDAAgD,OAAO,kBAAkB,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,aAAa,CAAC,KAAK,CAAC,EAAE,CAC7H,CAAC;YACF,MAAM,iBAAiB,CAAC;gBACtB,SAAS,EAAE,aAAa,CAAC,CAAC,CAAC;gBAC3B,QAAQ,EAAE,OAAO;gBACjB,KAAK;aACN,CAAC,CAAC;YACH,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAQF,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,EAAE,EACnC,MAAM,EACN,OAAO,EACP,EAAE,EACF,EAAE,EACF,GAAG,EACH,OAAO,EACP,KAAK,GAAG,OAAO,EACf,oBAAoB,EACpB,IAAI,GACc,EAAE,EAAE;IACtB,MAAM,YAAY,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAC;IAC7C,IAAI,CAAC,YAAY,CAAC,MAAM;QACtB,MAAM,KAAK,CAAC,iDAAiD,CAAC,CAAC;IAEjE,MAAM,YAAY,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAC;IAC7C,MAAM,aAAa,GAAG,mBAAmB,CAAC,GAAG,CAAC,CAAC;IAC/C,MAAM,aAAa,GAAG,CAAC,GAAG,YAAY,EAAE,GAAG,YAAY,EAAE,GAAG,aAAa,CAAC,CAAC;IAC3E,MAAM,MAAM,GAAG,IAAI,MAAM,IAAI,kBAAkB,MAAM,KAAK,wBAAwB,CAAC;IAEnF,MAAM,MAAM,GAA0B;QACpC,WAAW,EAAE;YACX,WAAW,EAAE,YAAY;YACzB,WAAW,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS;YAC3D,YAAY,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS;SAC/D;QACD,OAAO,EAAE;YACP,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;YAC1B,IAAI,EAAE;gBACJ,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;aACxB;SACF;QACD,MAAM,EAAE,MAAM;QACd,oBAAoB,EAAE,oBAAoB;QAC1C,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;KACzC,CAAC;IAEF,MAAM,cAAc,GAAoB;QACtC,MAAM;QACN,KAAK;QACL,MAAM;QACN,EAAE,EAAE,YAAY;QAChB,EAAE,EAAE,YAAY;QAChB,GAAG,EAAE,aAAa;QAClB,OAAO;QACP,OAAO;QACP,IAAI;QACJ,oBAAoB;KACrB,CAAC;IAEF,OAAO,MAAM,eAAe,CAAC,MAAM,EAAE,aAAa,EAAE,cAAc,CAAC,CAAC;AACtE,CAAC,CAAC;AAQF,MAAM,CAAC,MAAM,eAAe,GAAG,KAAK,EAAE,MAAoB,EAAE,EAAE;IAG5D,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,CAAC;QAClD,OAAO,CAAC,KAAK,CAAC,gDAAgD,CAAC,CAAC;QAChE,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,MAAM,cAAc,CAAC,EAAE,GAAG,MAAM,EAAE,EAAE,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;AACnE,CAAC,CAAC"}
+{"version":3,"file":"email.js","sourceRoot":"","sources":["../../../lib/email/email.ts"],"names":[],"mappings":"AAkBA,OAAO,EAEL,gBAAgB,EAEhB,SAAS,GACV,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAChC,OAAO,EAAE,gBAAgB,EAAmB,MAAM,cAAc,CAAC;AAwDjE,IAAI,UAAU,GAAqB,IAAI,CAAC;AACxC,MAAM,YAAY,GAAG,GAAc,EAAE;IACnC,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,IAAI,CAAC,GAAG,CAAC,iBAAiB,IAAI,CAAC,GAAG,CAAC,qBAAqB,IAAI,CAAC,GAAG,CAAC,UAAU;YACzE,OAAO,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAC;QACtD,UAAU,GAAG,IAAI,SAAS,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,UAAU,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC,CAAC;IACzE,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,GAAG,CAAC;AAChC,MAAM,kBAAkB,GAAG,CAAC,CAAC;AAE7B,MAAM,cAAc,GAAG,GAAG,EAAE;IAC1B,MAAM,MAAM,GAAG,QAAQ,CAAC,GAAG,CAAC,uBAAuB,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;IAC/D,OAAO,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;AAC7D,CAAC,CAAC;AAGF,MAAM,eAAe,GAAG,CAAC,OAAe,EAAE,EAAE;IAC1C,MAAM,IAAI,GAAG,mBAAmB,GAAG,kBAAkB,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC;IACvE,MAAM,MAAM,GAAG,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IACrD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,MAAM,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF,MAAM,KAAK,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AAMhF,MAAM,oBAAoB,GAAG,CAAC,KAAc,EAAE,EAAE;IAC9C,MAAM,GAAG,GAAG,KAGX,CAAC;IACF,IAAI,GAAG,CAAC,IAAI,KAAK,qBAAqB;QAAE,OAAO,IAAI,CAAC;IACpD,IAAI,GAAG,CAAC,IAAI,KAAK,0BAA0B;QAAE,OAAO,IAAI,CAAC;IACzD,MAAM,MAAM,GAAG,GAAG,CAAC,SAAS,EAAE,cAAc,CAAC;IAE7C,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IACtC,OAAO,MAAM,KAAK,GAAG,IAAI,MAAM,IAAI,GAAG,CAAC;AACzC,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,KAAc,EAAE,EAAE;IACvC,MAAM,GAAG,GAAG,KAA4C,CAAC;IACzD,OAAO,GAAG,GAAG,CAAC,IAAI,IAAI,OAAO,KAAK,GAAG,CAAC,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;AACnE,CAAC,CAAC;AASF,MAAM,iBAAiB,GAAG,KAAK,EAAE,OAKhC,EAAE,EAAE;IACH,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC;QACtB,OAAO,CAAC,IAAI,CAAC,0DAA0D,CAAC,CAAC;QACzE,OAAO;IACT,CAAC;IACD,IAAI,CAAC;QAKH,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,MAAM,CAAC,0BAA0B,CAAC,CAAC;QAChE,MAAM,UAAU;aACb,UAAU,CAAC,gCAAgC,CAAC;aAC5C,MAAM,CAAC;YACN,UAAU,EAAE,cAAc;YAC1B,eAAe,EAAE,OAAO,CAAC,SAAS;YAClC,WAAW,EAAE,UAAU,EAAE;YACzB,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,aAAa,EAAE,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC;YAC3C,UAAU,EAAE,OAAO,CAAC,cAAc,IAAI,IAAI;SAC3C,CAAC;aACD,OAAO,EAAE,CAAC;IACf,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,8CAA8C,EAAE,KAAK,CAAC,CAAC;IACvE,CAAC;AACH,CAAC,CAAC;AASF,MAAM,kBAAkB,GAAG,KAAK,EAAE,cAAsB,EAAoB,EAAE;IAC5E,IAAI,CAAC,GAAG,CAAC,YAAY;QACnB,MAAM,IAAI,KAAK,CACb,0EAA0E,CAC3E,CAAC;IAIJ,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,MAAM,CAAC,0BAA0B,CAAC,CAAC;IAChE,MAAM,QAAQ,GAAG,MAAM,UAAU;SAC9B,UAAU,CAAC,gCAAgC,CAAC;SAC5C,MAAM,CAAC,IAAI,CAAC;SACZ,KAAK,CAAC,YAAY,EAAE,GAAG,EAAE,cAAc,CAAC;SACxC,KAAK,CAAC,YAAY,EAAE,GAAG,EAAE,cAAc,CAAC;SACxC,KAAK,CAAC,CAAC,CAAC;SACR,gBAAgB,EAAE,CAAC;IAEtB,OAAO,CAAC,CAAC,QAAQ,CAAC;AACpB,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,KAAyB,EAAE,EAAE;IACxD,IAAI,CAAC,KAAK;QAAE,OAAO,EAAE,CAAC;IAEtB,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IACpD,OAAO;QACL,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;KACtE,CAAC;AACJ,CAAC,CAAC;AAGF,MAAM,SAAS,GAAG,CAAC,IAA4B,EAAgB,EAAE,CAC/D,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;IAC3C,IAAI,EAAE,IAAI;IACV,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC;CACtD,CAAC,CAAC,CAAC;AAEN,MAAM,eAAe,GAAG,KAAK,EAC3B,MAA6B,EAC7B,aAAuB,EACvB,cAA+B,EAC/B,cAAuB,EACW,EAAE;IACpC,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IAErC,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,IAAI,WAAW,EAAE,OAAO,EAAE,EAAE,CAAC;QACxD,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,IAAI,gBAAgB,CAAC,MAAM,CAAC,CAAC;YAC7C,MAAM,MAAM,GAAG,MAAM,YAAY,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAClD,OAAO,CAAC,IAAI,CAAC,yBAAyB,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YAEnE,MAAM,QAAQ,GAAG,gBAAgB,CAC/B,cAAc,EACd,MAAM,CAAC,SAAS,EAChB,OAAO,EACP,cAAc,CACf,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAChB,OAAO,CAAC,KAAK,CAAC,uCAAuC,EAAE,KAAK,CAAC,CAC9D,CAAC;YAKF,IAAI,cAAc;gBAAE,MAAM,QAAQ,CAAC;;gBAC9B,KAAK,QAAQ,CAAC;YAEnB,OAAO;gBACL,SAAS,EAAE,MAAM,CAAC,SAAS;gBAC3B,QAAQ,EAAE,mCAAmC;aAC9C,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,oBAAoB,CAAC,KAAK,CAAC,IAAI,OAAO,GAAG,WAAW,EAAE,CAAC;gBACzD,MAAM,KAAK,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;gBACvC,OAAO,CAAC,KAAK,CACX,uCAAuC,OAAO,IAAI,WAAW,kBAAkB,KAAK,OAAO,aAAa,CAAC,KAAK,CAAC,EAAE,CAClH,CAAC;gBACF,MAAM,KAAK,CAAC,KAAK,CAAC,CAAC;gBACnB,SAAS;YACX,CAAC;YAED,OAAO,CAAC,KAAK,CACX,gDAAgD,OAAO,kBAAkB,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,aAAa,CAAC,KAAK,CAAC,EAAE,CAC7H,CAAC;YACF,MAAM,iBAAiB,CAAC;gBACtB,SAAS,EAAE,aAAa,CAAC,CAAC,CAAC;gBAC3B,QAAQ,EAAE,OAAO;gBACjB,KAAK;gBACL,cAAc;aACf,CAAC,CAAC;YACH,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAQF,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,EAAE,EACnC,MAAM,EACN,OAAO,EACP,EAAE,EACF,EAAE,EACF,GAAG,EACH,OAAO,EACP,KAAK,GAAG,OAAO,EACf,oBAAoB,EACpB,IAAI,EACJ,cAAc,GACI,EAAoC,EAAE;IACxD,MAAM,YAAY,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAC;IAC7C,IAAI,CAAC,YAAY,CAAC,MAAM;QACtB,MAAM,KAAK,CAAC,iDAAiD,CAAC,CAAC;IAEjE,IAAI,cAAc,IAAI,CAAC,MAAM,kBAAkB,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC;QACjE,OAAO,CAAC,IAAI,CACV,wDAAwD,cAAc,GAAG,CAC1E,CAAC;QACF,OAAO;YACL,QAAQ,EAAE,uCAAuC;YACjD,YAAY,EAAE,IAAI;SACnB,CAAC;IACJ,CAAC;IAED,MAAM,YAAY,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAC;IAC7C,MAAM,aAAa,GAAG,mBAAmB,CAAC,GAAG,CAAC,CAAC;IAC/C,MAAM,aAAa,GAAG,CAAC,GAAG,YAAY,EAAE,GAAG,YAAY,EAAE,GAAG,aAAa,CAAC,CAAC;IAC3E,MAAM,MAAM,GAAG,IAAI,MAAM,IAAI,kBAAkB,MAAM,KAAK,wBAAwB,CAAC;IAEnF,MAAM,MAAM,GAA0B;QACpC,WAAW,EAAE;YACX,WAAW,EAAE,YAAY;YACzB,WAAW,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS;YAC3D,YAAY,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS;SAC/D;QACD,OAAO,EAAE;YACP,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;YAC1B,IAAI,EAAE;gBACJ,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;aACxB;SACF;QACD,MAAM,EAAE,MAAM;QACd,oBAAoB,EAAE,oBAAoB;QAC1C,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;KACzC,CAAC;IAEF,MAAM,cAAc,GAAoB;QACtC,MAAM;QACN,KAAK;QACL,MAAM;QACN,EAAE,EAAE,YAAY;QAChB,EAAE,EAAE,YAAY;QAChB,GAAG,EAAE,aAAa;QAClB,OAAO;QACP,OAAO;QACP,IAAI;QACJ,oBAAoB;KACrB,CAAC;IAEF,OAAO,MAAM,eAAe,CAC1B,MAAM,EACN,aAAa,EACb,cAAc,EACd,cAAc,CACf,CAAC;AACJ,CAAC,CAAC;AAQF,MAAM,CAAC,MAAM,eAAe,GAAG,KAAK,EAAE,MAAoB,EAAE,EAAE;IAG5D,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,CAAC;QAClD,OAAO,CAAC,KAAK,CAAC,gDAAgD,CAAC,CAAC;QAChE,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,MAAM,cAAc,CAAC,EAAE,GAAG,MAAM,EAAE,EAAE,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;AACnE,CAAC,CAAC"}

package/dist/lib/forms/field-preset-templates.js

@@ -5,14 +5,14 @@ const LONG_TEXT_VALIDATOR = `${TEXT_PREPROCESS}z.string().describe("textarea"))`
 const NUMBER_VALIDATOR = 'z.number()';
 const SIGNATURE_VALIDATOR = `${TEXT_PREPROCESS}z.string().nonempty({ message: "This field is required." }))`;
 const DROPDOWN_VALIDATOR = `z.enum(["Option 1", "Option 2"], {message:"This field is required."})`;
-const MULTISELECT_VALIDATOR = `z.array(
-  z.enum(
-    [
-      "Option 1",
-      "Option 2"
-    ],
-    { message: "This field is required." }
-  )
+const MULTISELECT_VALIDATOR = `z.array(
+  z.enum(
+    [
+      "Option 1",
+      "Option 2"
+    ],
+    { message: "This field is required." }
+  )
 ).describe("multiselect")`;
 const DATE_VALIDATOR = 'z.coerce.date()';
 const TIME_VALIDATOR = 'z.string().describe("time")';

package/dist/lib/forms/form-metadata.d.ts

@@ -1,140 +1,141 @@
-import { ZodType } from 'zod';
-import { ClientBlock, ClientField, ClientPhantomField } from './fields.client.js';
-import { ServerField } from './fields.server.js';
-import { FontName } from './constants/fonts.js';
-import type { ValidatorIRv0 } from './validator-ir.js';
-export type FormValues = Record<string, string>;
-export type FormErrors = Record<string, string>;
-export declare const SCHEMA_VERSION = 1;
-export declare const FIELD_TYPES: string[];
-export declare const BLOCK_TYPES: string[];
-export declare const ALIGN_H: string[];
-export declare const ALIGN_V: string[];
-export declare const SOURCES: string[];
-export type { ValidatorIRv0, ValidatorBaseType } from './validator-ir.js';
-export interface IFormMetadata {
-    name: string;
-    label: string;
-    schema_version: number;
-    schema: IForm;
-    signing_parties: IFormSigningParty[];
-    subscribers?: IFormSubscriber[];
-}
-export type IFormSubscriber = {
-    email: string;
-};
-export interface IFormSignatory {
-    name?: string;
-    email: string;
-    title?: string;
-    honorific?: string;
-}
-export interface IFormSigningParty {
-    _id: string;
-    order: number;
-    signatory_title: string;
-    signatory_account?: IFormSignatory;
-    signatory_source?: {
-        _id: string;
-        label: string;
-        tooltip_label: string;
-    };
-    signed?: boolean;
-}
-export interface IFormSignee {
-    name: string;
-    sourceEmail: string;
-    title?: string;
-    honorific?: string;
-    signedDate?: number;
-}
-export interface IForm {
-    blocks: IFormBlock[];
-}
-export interface IFormBlock {
-    _id: string;
-    block_type: (typeof BLOCK_TYPES)[number];
-    order: number;
-    signing_party_id: IFormSigningParty['_id'];
-    text_content?: string;
-    field_schema?: IFormField;
-    phantom_field_schema?: IFormPhantomField;
-}
-export interface IFormField {
-    field: string;
-    type: 'text' | 'signature' | 'image';
-    x: number;
-    y: number;
-    w: number;
-    h: number;
-    page: number;
-    align_h?: (typeof ALIGN_H)[number];
-    align_v?: (typeof ALIGN_V)[number];
-    label: string;
-    tooltip_label: string;
-    shared: boolean;
-    source: (typeof SOURCES)[number];
-    prefiller?: string;
-    validator?: string;
-    validator_ir?: ValidatorIRv0 | null;
-    size?: number;
-    wrap?: boolean;
-    font?: FontName;
-    radio_group_id?: string;
-    radio_option_label?: string;
-}
-export interface IFormPhantomField {
-    field: string;
-    type: 'text' | 'signature' | 'image';
-    label: string;
-    tooltip_label: string;
-    shared: boolean;
-    source: (typeof SOURCES)[number];
-    prefiller?: string;
-    validator?: string;
-    validator_ir?: ValidatorIRv0 | null;
-    radio_group_id?: string;
-    radio_option_label?: string;
-}
-export interface IFormParameters {
-    [key: string]: string | ZodType;
-}
-export type IFormSourceDomains<SourceDomains extends any[]> = Record<string, SourceDomains[number]>;
-export type IFormFieldValidator = ZodType;
-export type IFormFieldPrefiller<SourceDomains extends any[]> = (sourceDomains: IFormSourceDomains<SourceDomains>) => string;
-export declare class FormMetadata<SourceDomains extends any[]> {
-    private readonly formMetadata;
-    private readonly blocks;
-    constructor(formMetadata: IFormMetadata);
-    getBlocksForClientService(signingPartyId?: string): ClientBlock<SourceDomains>[];
-    getSigningPartyFieldName(signingPartyId: string): string;
-    getSigningPartyTitleFromFieldName(signingPartyFieldName: string): string | undefined;
-    getSigningPartyBlocks(sourceSigningPartyId: string): ClientBlock<SourceDomains>[];
-    getSigningPartyFields(signingPartyId: string): (ClientField<SourceDomains> | ClientPhantomField<SourceDomains>)[];
-    static getSigningPartyValues(signingParties: IFormSigningParty[], values: FormValues): Record<string, IFormSignatory>;
-    private getFields;
-    private getField;
-    private getPhantomFields;
-    private getPhantomField;
-    encodeAsJSON(): string;
-    static decodeFromJSON<SourceDomains extends any[]>(json: string): FormMetadata<SourceDomains>;
-    getLabel(): string;
-    private getFieldForClientService;
-    getFieldsForClientService(signingPartyId?: string, sourceDomains?: IFormSourceDomains<SourceDomains>, derivationBase?: IFormParameters): (ClientField<SourceDomains> | ClientPhantomField<SourceDomains>)[];
-    getSignatureFieldsForClientService(signingPartyId: string): (ClientField<SourceDomains> | ClientPhantomField<SourceDomains>)[];
-    getSignatureValueForSigningParty(values: FormValues, signingPartyId: string): string;
-    setSignatureValueForSigningParty(values: FormValues, signatureString: string, signingPartyId: string): FormValues;
-    getFieldsForEditorService(): IFormField[];
-    getPhantomFieldsForEditorService(): IFormPhantomField[];
-    getBlocksForEditorService(): IFormBlock[];
-    getFieldsForSigningService(): ServerField[];
-    inferParams(): string[];
-    private parseValidator;
-    private parsePrefiller;
-    private enumerateParams;
-    private populateParams;
-    getSchemaVersion(): number;
-    getSubscribers(): IFormSubscriber[];
-    getSigningParties(): IFormSigningParty[];
-    mayInvolveEsign(): boolean;
-}
+import { ZodType } from 'zod';
+import { ClientBlock, ClientField, ClientPhantomField } from './fields.client.js';
+import { ServerField } from './fields.server.js';
+import { FontName } from './constants/fonts.js';
+import type { ValidatorIRv0 } from './validator-ir.js';
+export type FormValues = Record<string, string>;
+export type FormErrors = Record<string, string>;
+export declare const SCHEMA_VERSION = 1;
+export declare const FIELD_TYPES: string[];
+export declare const BLOCK_TYPES: string[];
+export declare const ALIGN_H: string[];
+export declare const ALIGN_V: string[];
+export declare const SOURCES: string[];
+export type { ValidatorIRv0, ValidatorBaseType } from './validator-ir.js';
+export interface IFormMetadata {
+    name: string;
+    label: string;
+    schema_version: number;
+    schema: IForm;
+    signing_parties: IFormSigningParty[];
+    subscribers?: IFormSubscriber[];
+}
+export type IFormSubscriber = {
+    email: string;
+};
+export interface IFormSignatory {
+    name?: string;
+    email: string;
+    title?: string;
+    honorific?: string;
+}
+export interface IFormSigningParty {
+    _id: string;
+    order: number;
+    signatory_title: string;
+    signatory_account?: IFormSignatory;
+    signatory_source?: {
+        _id: string;
+        label: string;
+        tooltip_label: string;
+    };
+    signed?: boolean;
+    signed_ip_address?: string;
+}
+export interface IFormSignee {
+    name: string;
+    sourceEmail: string;
+    title?: string;
+    honorific?: string;
+    signedDate?: number;
+}
+export interface IForm {
+    blocks: IFormBlock[];
+}
+export interface IFormBlock {
+    _id: string;
+    block_type: (typeof BLOCK_TYPES)[number];
+    order: number;
+    signing_party_id: IFormSigningParty['_id'];
+    text_content?: string;
+    field_schema?: IFormField;
+    phantom_field_schema?: IFormPhantomField;
+}
+export interface IFormField {
+    field: string;
+    type: 'text' | 'signature' | 'image';
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+    page: number;
+    align_h?: (typeof ALIGN_H)[number];
+    align_v?: (typeof ALIGN_V)[number];
+    label: string;
+    tooltip_label: string;
+    shared: boolean;
+    source: (typeof SOURCES)[number];
+    prefiller?: string;
+    validator?: string;
+    validator_ir?: ValidatorIRv0 | null;
+    size?: number;
+    wrap?: boolean;
+    font?: FontName;
+    radio_group_id?: string;
+    radio_option_label?: string;
+}
+export interface IFormPhantomField {
+    field: string;
+    type: 'text' | 'signature' | 'image';
+    label: string;
+    tooltip_label: string;
+    shared: boolean;
+    source: (typeof SOURCES)[number];
+    prefiller?: string;
+    validator?: string;
+    validator_ir?: ValidatorIRv0 | null;
+    radio_group_id?: string;
+    radio_option_label?: string;
+}
+export interface IFormParameters {
+    [key: string]: string | ZodType;
+}
+export type IFormSourceDomains<SourceDomains extends any[]> = Record<string, SourceDomains[number]>;
+export type IFormFieldValidator = ZodType;
+export type IFormFieldPrefiller<SourceDomains extends any[]> = (sourceDomains: IFormSourceDomains<SourceDomains>) => string;
+export declare class FormMetadata<SourceDomains extends any[]> {
+    private readonly formMetadata;
+    private readonly blocks;
+    constructor(formMetadata: IFormMetadata);
+    getBlocksForClientService(signingPartyId?: string): ClientBlock<SourceDomains>[];
+    getSigningPartyFieldName(signingPartyId: string): string;
+    getSigningPartyTitleFromFieldName(signingPartyFieldName: string): string | undefined;
+    getSigningPartyBlocks(sourceSigningPartyId: string): ClientBlock<SourceDomains>[];
+    getSigningPartyFields(signingPartyId: string): (ClientField<SourceDomains> | ClientPhantomField<SourceDomains>)[];
+    static getSigningPartyValues(signingParties: IFormSigningParty[], values: FormValues): Record<string, IFormSignatory>;
+    private getFields;
+    private getField;
+    private getPhantomFields;
+    private getPhantomField;
+    encodeAsJSON(): string;
+    static decodeFromJSON<SourceDomains extends any[]>(json: string): FormMetadata<SourceDomains>;
+    getLabel(): string;
+    private getFieldForClientService;
+    getFieldsForClientService(signingPartyId?: string, sourceDomains?: IFormSourceDomains<SourceDomains>, derivationBase?: IFormParameters): (ClientField<SourceDomains> | ClientPhantomField<SourceDomains>)[];
+    getSignatureFieldsForClientService(signingPartyId: string): (ClientField<SourceDomains> | ClientPhantomField<SourceDomains>)[];
+    getSignatureValueForSigningParty(values: FormValues, signingPartyId: string): string;
+    setSignatureValueForSigningParty(values: FormValues, signatureString: string, signingPartyId: string): FormValues;
+    getFieldsForEditorService(): IFormField[];
+    getPhantomFieldsForEditorService(): IFormPhantomField[];
+    getBlocksForEditorService(): IFormBlock[];
+    getFieldsForSigningService(): ServerField[];
+    inferParams(): string[];
+    private parseValidator;
+    private parsePrefiller;
+    private enumerateParams;
+    private populateParams;
+    getSchemaVersion(): number;
+    getSubscribers(): IFormSubscriber[];
+    getSigningParties(): IFormSigningParty[];
+    mayInvolveEsign(): boolean;
+}