@josephomills/esign 0.7.1 → 0.9.0

package/dist/server/index.d.ts

@@ -1,5 +1,5 @@
-import { S as SubjectSelection, E as EsignChannel, R as ResendPolicy, P as PersistencePort, a as SubjectsPort, N as NotifierPort, C as Clock, b as SkippedSubject, c as StoragePort, H as HooksPort, d as SignatureField, e as SigningDocumentVersionDTO, f as SigningDocumentDTO, g as SigningRequestDTO, h as EsignConfig, V as VersionPolicy, i as SubjectSigningStatus, j as CoverageReport, k as CampaignStatsRow, D as DocumentStatsRow, l as StatsRange, m as ScopeStatsRow, O as OutstandingRequest, n as SubjectTypeDescriptor, o as Placement } from '../ports-CkBaAepo.js';
-export { A as ACTIVE_STATUSES, p as AffectedSubject, q as AuthPort, r as DeclineInput, s as DocumentDeletionContext, t as ESIGN_CHANNELS, u as ESIGN_STATUSES, v as EsignStatus, G as GroupBreakdown, w as NewAuditEventRow, x as NewRequestRow, y as NotifierAttachment, z as Recipient, B as RequestSummary, F as SigningAuditEventDTO, I as SigningCampaignDTO, J as StatusCountMap, K as SubjectFilter, L as SubjectFilterField, M as SubjectSigningState, Q as SubjectSummary, T as SubmitSignatureInput, U as TERMINAL_STATUSES, W as assertTransition, X as canTransition, Y as declineSchema, Z as esignChannelSchema, _ as isActive, $ as isTerminal, a0 as placementSchema, a1 as placementsSchema, a2 as signatureFieldSchema, a3 as subjectSelectionSchema, a4 as submitSignatureSchema } from '../ports-CkBaAepo.js';
+import { S as SubjectSelection, E as EsignChannel, R as ResendPolicy, P as PersistencePort, a as SubjectsPort, N as NotifierPort, C as Clock, b as SkippedSubject, c as StoragePort, H as HooksPort, d as SignatureField, e as SigningDocumentVersionDTO, f as SigningDocumentDTO, g as SigningRequestDTO, h as EsignConfig, V as VersionPolicy, i as SubjectSigningStatus, j as CoverageReport, k as CampaignStatsRow, D as DocumentStatsRow, l as StatsRange, m as ScopeStatsRow, O as OutstandingRequest, n as SubjectTypeDescriptor, o as DocumentField } from '../ports--YsOnh8H.js';
+export { A as ACTIVE_STATUSES, p as AffectedSubject, q as AuthPort, r as DATE_FORMATS, s as DATE_FORMAT_LABELS, t as DEFAULT_DATE_FORMAT, u as DateFormat, v as DeclineInput, w as DocumentDeletionContext, x as ESIGN_CHANNELS, y as ESIGN_STATUSES, z as EsignStatus, F as FieldType, G as GroupBreakdown, B as NewAuditEventRow, I as NewRequestRow, J as NotifierAttachment, K as Placement, L as Recipient, M as RequestSummary, Q as SigningAuditEventDTO, T as SigningCampaignDTO, U as StatusCountMap, W as SubjectFilter, X as SubjectFilterField, Y as SubjectSigningState, Z as SubjectSummary, _ as SubmitSignatureInput, $ as TERMINAL_STATUSES, a0 as assertTransition, a1 as canTransition, a2 as declineSchema, a3 as documentFieldSchema, a4 as esignChannelSchema, a5 as formatPickedDate, a6 as isActive, a7 as isTerminal, a8 as placementSchema, a9 as placementsSchema, aa as signatureFieldSchema, ab as subjectSelectionSchema, ac as submitSignatureSchema } from '../ports--YsOnh8H.js';
 import { PDFDocument } from 'pdf-lib';
 import { ZodType } from 'zod';
 
@@ -176,6 +176,8 @@ interface SubmitInput {
     token: string;
     signaturePng: Uint8Array;
     signerName: string;
+    /** Picked date per date-field id (ISO `yyyy-mm-dd`). */
+    dateValues?: Record<string, string>;
     ip: string | null;
     userAgent: string | null;
 }
@@ -344,8 +346,10 @@ interface SealInput {
     sourcePdf: Uint8Array;
     /** PNG bytes of the drawn or typed signature. */
     signaturePng: Uint8Array;
-    /** One or more boxes; the signature is stamped at each. */
-    placements: Placement[];
+    /** The version's fields. Signature fields get the signature; date fields the picked date. */
+    fields: DocumentField[];
+    /** Picked date per date-field id (ISO `yyyy-mm-dd`). */
+    dateValues: Record<string, string>;
     signerName: string;
     /** ISO instant — also pins the PDF metadata dates for reproducibility. */
     signedAt: string;
@@ -390,4 +394,4 @@ declare class EsignError extends Error {
 }
 declare function toErrorResponse(err: unknown): Response;
 
-export { type AddVersionInput, type AuditEventInput, type AuditLink, type CampaignContentBuilder, CampaignStatsRow, type CertInfo, type ChannelContent, Clock, type CoverageDeps, CoverageReport, type CreateCampaignArgs, type CreateCampaignDeps, type CreateCampaignResult, type CreateDocumentInput, type DeclineRequestInput, type DeleteDocumentDeps, type DeleteDocumentInput, type DeleteDocumentResult, type DeleteMode, DocumentStatsRow, EsignChannel, EsignConfig, EsignError, type EsignErrorCode, type EsignRuntime, HooksPort, NotifierPort, OutstandingRequest, PersistencePort, Placement, ResendPolicy, type ResolvedEsignConfig, ScopeStatsRow, type SealInput, type SealResult, type SignDeps, type SignServeDeps, SignatureField, SigningDocumentDTO, SigningDocumentVersionDTO, SigningRequestDTO, type SigningToken, type SigningView, SkippedSubject, StatsRange, StoragePort, SubjectSelection, SubjectSigningStatus, type SubjectSigningStatusArgs, SubjectTypeDescriptor, SubjectsPort, type SubmitInput, type SubmitResult, VersionPolicy, type VersionSource, addVersion, appendEvent, buildChain, canonicalize, clientIp, configureEsign, createCampaign, createDocument, createSignActionsRoute, createSignServeRoute, declineRequest, deleteDocument, documentCoverage, getSigningView, linkHash, newSigningToken, ok, parseBody, recordEvent, recordView, registerSubjectTypes, renderAuditCertificatePage, sealPdf, sha256Hex, submitSignature, toErrorResponse, uid, verifyChain };
+export { type AddVersionInput, type AuditEventInput, type AuditLink, type CampaignContentBuilder, CampaignStatsRow, type CertInfo, type ChannelContent, Clock, type CoverageDeps, CoverageReport, type CreateCampaignArgs, type CreateCampaignDeps, type CreateCampaignResult, type CreateDocumentInput, type DeclineRequestInput, type DeleteDocumentDeps, type DeleteDocumentInput, type DeleteDocumentResult, type DeleteMode, DocumentField, DocumentStatsRow, EsignChannel, EsignConfig, EsignError, type EsignErrorCode, type EsignRuntime, HooksPort, NotifierPort, OutstandingRequest, PersistencePort, ResendPolicy, type ResolvedEsignConfig, ScopeStatsRow, type SealInput, type SealResult, type SignDeps, type SignServeDeps, SignatureField, SigningDocumentDTO, SigningDocumentVersionDTO, SigningRequestDTO, type SigningToken, type SigningView, SkippedSubject, StatsRange, StoragePort, SubjectSelection, SubjectSigningStatus, type SubjectSigningStatusArgs, SubjectTypeDescriptor, SubjectsPort, type SubmitInput, type SubmitResult, VersionPolicy, type VersionSource, addVersion, appendEvent, buildChain, canonicalize, clientIp, configureEsign, createCampaign, createDocument, createSignActionsRoute, createSignServeRoute, declineRequest, deleteDocument, documentCoverage, getSigningView, linkHash, newSigningToken, ok, parseBody, recordEvent, recordView, registerSubjectTypes, renderAuditCertificatePage, sealPdf, sha256Hex, submitSignature, toErrorResponse, uid, verifyChain };

package/dist/server/index.js

@@ -111,6 +111,58 @@ function toErrorResponse(err) {
     { status: 500 }
   );
 }
+
+// src/shared/fields.ts
+var DATE_FORMATS = [
+  "DD/MM/YYYY",
+  "MM/DD/YYYY",
+  "YYYY-MM-DD",
+  "D MMM YYYY",
+  "Do MMM YYYY",
+  "Do MMMM YYYY",
+  "MMMM D, YYYY"
+];
+var DEFAULT_DATE_FORMAT = "Do MMMM YYYY";
+var MONTHS_SHORT = ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"];
+var MONTHS_LONG = ["January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"];
+function ordinal(n) {
+  const s = ["th", "st", "nd", "rd"];
+  const v = n % 100;
+  return `${n}${s[(v - 20) % 10] ?? s[v] ?? s[0]}`;
+}
+function formatPickedDate(iso, format) {
+  const [y, m, d] = iso.split("-").map(Number);
+  if (!y || !m || !d) return iso;
+  const dd = String(d).padStart(2, "0");
+  const mm = String(m).padStart(2, "0");
+  switch (format) {
+    case "DD/MM/YYYY":
+      return `${dd}/${mm}/${y}`;
+    case "MM/DD/YYYY":
+      return `${mm}/${dd}/${y}`;
+    case "YYYY-MM-DD":
+      return `${y}-${mm}-${dd}`;
+    case "D MMM YYYY":
+      return `${d} ${MONTHS_SHORT[m - 1]} ${y}`;
+    case "Do MMM YYYY":
+      return `${ordinal(d)} ${MONTHS_SHORT[m - 1]} ${y}`;
+    case "Do MMMM YYYY":
+      return `${ordinal(d)} ${MONTHS_LONG[m - 1]} ${y}`;
+    case "MMMM D, YYYY":
+      return `${MONTHS_LONG[m - 1]} ${d}, ${y}`;
+  }
+}
+var DATE_FORMAT_LABELS = {
+  "DD/MM/YYYY": "02/10/2026",
+  "MM/DD/YYYY": "10/02/2026",
+  "YYYY-MM-DD": "2026-10-02",
+  "D MMM YYYY": "2 Oct 2026",
+  "Do MMM YYYY": "2nd Oct 2026",
+  "Do MMMM YYYY": "2nd October 2026",
+  "MMMM D, YYYY": "October 2, 2026"
+};
+
+// src/server/types.ts
 var ESIGN_CHANNELS = [
   "EMAIL",
   "TELEGRAM",
@@ -126,11 +178,18 @@ var placementSchema = z.object({
   w: z.number().min(0.01).max(1),
   h: z.number().min(0.01).max(1)
 }).strict();
-var signatureFieldSchema = placementSchema.extend({
+var isoDate = z.string().regex(/^\d{4}-\d{2}-\d{2}$/);
+var documentFieldSchema = placementSchema.extend({
   id: z.string().min(1).max(64),
-  label: z.string().trim().max(80)
+  label: z.string().trim().max(80),
+  type: z.enum(["signature", "date"]).default("signature"),
+  dateFormat: z.enum(DATE_FORMATS).optional(),
+  minDate: isoDate.nullable().optional()
+}).strict();
+var signatureFieldSchema = documentFieldSchema;
+var placementsSchema = z.array(documentFieldSchema).min(1).max(20).refine((fields) => fields.some((f) => f.type === "signature"), {
+  message: "A document needs at least one signature field."
 });
-var placementsSchema = z.array(signatureFieldSchema).min(1).max(20);
 function addressFor(recipient, channel) {
   switch (channel) {
     case "EMAIL":
@@ -160,7 +219,8 @@ var submitSignatureSchema = z.object({
   signaturePng: z.string().min(1).max(15e5),
   // ~1MB cap on the data URL
   signerName: z.string().trim().min(1).max(200),
-  consent: z.literal(true)
+  consent: z.literal(true),
+  dateValues: z.record(z.string().min(1).max(64), isoDate).optional()
 }).strict();
 var declineSchema = z.object({ reason: z.string().trim().max(500).optional() }).strict();
 var ALPHABET = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
@@ -650,15 +710,35 @@ async function sealPdf(input) {
   const png = await pdf.embedPng(input.signaturePng);
   const font = await pdf.embedFont(StandardFonts.Helvetica);
   const caption = `Signed by ${input.signerName} \xB7 ${input.signedAt}${input.signerIp ? ` \xB7 IP ${input.signerIp}` : ""}`;
-  input.placements.forEach((placement, i) => {
-    const pageIndex = Math.min(Math.max(placement.page - 1, 0), pages.length - 1);
+  let captionDrawn = false;
+  input.fields.forEach((field) => {
+    const pageIndex = Math.min(Math.max(field.page - 1, 0), pages.length - 1);
     const page = pages[pageIndex];
     const pageW = page.getWidth();
     const pageH = page.getHeight();
-    const boxX = placement.x * pageW;
-    const boxW = placement.w * pageW;
-    const boxH = placement.h * pageH;
-    const boxBottomY = pageH * (1 - placement.y - placement.h);
+    const boxX = field.x * pageW;
+    const boxW = field.w * pageW;
+    const boxH = field.h * pageH;
+    const boxBottomY = pageH * (1 - field.y - field.h);
+    if (field.type === "date") {
+      const iso = input.dateValues[field.id];
+      if (!iso) return;
+      const text = formatPickedDate(iso, field.dateFormat ?? DEFAULT_DATE_FORMAT);
+      let size = Math.min(boxH * 0.62, 15);
+      let textW = font.widthOfTextAtSize(text, size);
+      if (textW > boxW && textW > 0) {
+        size *= boxW / textW;
+        textW = font.widthOfTextAtSize(text, size);
+      }
+      page.drawText(text, {
+        x: boxX + Math.max(0, (boxW - textW) / 2),
+        y: boxBottomY + (boxH - size) / 2 + size * 0.22,
+        size,
+        font,
+        color: rgb(0.1, 0.1, 0.12)
+      });
+      return;
+    }
     const scale = Math.min(boxW / png.width, boxH / png.height);
     const drawW = png.width * scale;
     const drawH = png.height * scale;
@@ -668,7 +748,8 @@ async function sealPdf(input) {
       width: drawW,
       height: drawH
     });
-    if (i === 0) {
+    if (!captionDrawn) {
+      captionDrawn = true;
       page.drawText(caption, {
         x: boxX,
         y: Math.max(boxBottomY - 11, 4),
@@ -784,6 +865,18 @@ async function submitSignature(deps, input) {
   const src = await storage.get(version.sourceObjectKey);
   if (!src) throw new EsignError("INTERNAL", "Source document missing.");
   const document = await persistence.getDocument(request.documentId);
+  const dateValues = input.dateValues ?? {};
+  const createdFloor = document?.createdAt ? document.createdAt.slice(0, 10) : null;
+  for (const field of version.placements) {
+    if (field.type !== "date") continue;
+    const value = dateValues[field.id];
+    const name = field.label || "date";
+    if (!value) throw new EsignError("INVALID_INPUT", `Please fill in the "${name}" date.`);
+    const floor = field.minDate ?? createdFloor;
+    if (floor && value < floor) {
+      throw new EsignError("INVALID_INPUT", `The "${name}" date can't be before ${floor}.`);
+    }
+  }
   const existing = (await persistence.listAuditEvents(request.id)).map(toLink);
   const nowIso = now.toISOString();
   const consented = await recordEvent(persistence, request.id, existing.at(-1) ?? null, {
@@ -798,7 +891,8 @@ async function submitSignature(deps, input) {
   const seal = await sealPdf({
     sourcePdf: src.bytes,
     signaturePng: input.signaturePng,
-    placements: version.placements,
+    fields: version.placements,
+    dateValues,
     signerName: input.signerName,
     signedAt: nowIso,
     signerIp: input.ip,
@@ -919,6 +1013,7 @@ function createSignActionsRoute(deps) {
         token,
         signaturePng: pngFromDataUrl(body.signaturePng),
         signerName: body.signerName,
+        dateValues: body.dateValues,
         ip: clientIp(req),
         userAgent: req.headers.get("user-agent")
       });
@@ -1011,6 +1106,6 @@ function registerSubjectTypes(types) {
   };
 }
 
-export { ACTIVE_STATUSES, ESIGN_CHANNELS, ESIGN_STATUSES, EsignError, TERMINAL_STATUSES, addVersion, appendEvent, assertTransition, buildChain, canTransition, canonicalize, clientIp, configureEsign, createCampaign, createDocument, createSignActionsRoute, createSignServeRoute, declineRequest, declineSchema, deleteDocument, documentCoverage, esignChannelSchema, getSigningView, isActive, isTerminal, linkHash, newSigningToken, ok, parseBody, placementSchema, placementsSchema, recordEvent, recordView, registerSubjectTypes, renderAuditCertificatePage, sealPdf, sha256Hex, signatureFieldSchema, subjectSelectionSchema, submitSignature, submitSignatureSchema, toErrorResponse, uid, verifyChain };
+export { ACTIVE_STATUSES, DATE_FORMATS, DATE_FORMAT_LABELS, DEFAULT_DATE_FORMAT, ESIGN_CHANNELS, ESIGN_STATUSES, EsignError, TERMINAL_STATUSES, addVersion, appendEvent, assertTransition, buildChain, canTransition, canonicalize, clientIp, configureEsign, createCampaign, createDocument, createSignActionsRoute, createSignServeRoute, declineRequest, declineSchema, deleteDocument, documentCoverage, documentFieldSchema, esignChannelSchema, formatPickedDate, getSigningView, isActive, isTerminal, linkHash, newSigningToken, ok, parseBody, placementSchema, placementsSchema, recordEvent, recordView, registerSubjectTypes, renderAuditCertificatePage, sealPdf, sha256Hex, signatureFieldSchema, subjectSelectionSchema, submitSignature, submitSignatureSchema, toErrorResponse, uid, verifyChain };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map