@josephomills/esign 0.5.0 → 0.6.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 SignatureField, d as StoragePort, e as SigningDocumentVersionDTO, f as SigningDocumentDTO, g as SigningRequestDTO, H as HooksPort, 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-DM0-2hQd.js';
-export { A as ACTIVE_STATUSES, p as AuthPort, q as DeclineInput, r as ESIGN_CHANNELS, s as ESIGN_STATUSES, t as EsignStatus, G as GroupBreakdown, u as NewAuditEventRow, v as NewRequestRow, w as NotifierAttachment, x as Recipient, y as RequestSummary, z as SigningAuditEventDTO, B as SigningCampaignDTO, F as StatusCountMap, I as SubjectFilter, J as SubjectFilterField, K as SubjectSigningState, L as SubjectSummary, M as SubmitSignatureInput, T as TERMINAL_STATUSES, Q as assertTransition, U as canTransition, W as declineSchema, X as esignChannelSchema, Y as isActive, Z as isTerminal, _ as placementSchema, $ as placementsSchema, a0 as signatureFieldSchema, a1 as subjectSelectionSchema, a2 as submitSignatureSchema } from '../ports-DM0-2hQd.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 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 { PDFDocument } from 'pdf-lib';
 import { ZodType } from 'zod';
 
@@ -85,6 +85,40 @@ interface CreateCampaignResult {
  */
 declare function createCampaign(deps: CreateCampaignDeps, args: CreateCampaignArgs): Promise<CreateCampaignResult>;
 
+type DeleteMode = "soft" | "purge";
+interface DeleteDocumentInput {
+    documentId: string;
+    /**
+     * "soft" (default) archives reversibly — hides the document + campaigns, revokes
+     * live links, keeps the sealed PDFs + audit trail. "purge" permanently removes
+     * all rows and the source/sealed objects, and is refused once anything is signed.
+     */
+    mode?: DeleteMode;
+}
+type DeleteDocumentResult = {
+    ok: true;
+    mode: DeleteMode;
+    documentId: string;
+    objectsPurged: number;
+} | {
+    ok: false;
+    reason: "not_found" | "has_signatures";
+};
+interface DeleteDocumentDeps {
+    persistence: PersistencePort;
+    storage: StoragePort;
+    clock: Clock;
+    hooks?: HooksPort;
+}
+/**
+ * Delete a logical document and everything under it. Soft by default (reversible,
+ * preserves signed evidence); purge permanently removes rows + storage objects but
+ * is refused when any request is SIGNED. Either way the affected subjects are
+ * reported through {@link HooksPort.onDocumentDeleted} so the host can react
+ * (milestone-grid retraction lives in the host, never in this package).
+ */
+declare function deleteDocument(deps: DeleteDocumentDeps, input: DeleteDocumentInput): Promise<DeleteDocumentResult>;
+
 interface CreateDocumentInput {
     scopeId?: string | null;
     documentType?: string | null;
@@ -235,6 +269,7 @@ interface EsignRuntime<S> {
     createDocument(input: CreateDocumentInput): Promise<SigningDocumentDTO>;
     addVersion(input: AddVersionInput): Promise<SigningDocumentVersionDTO>;
     createCampaign(args: CreateCampaignArgs): Promise<CreateCampaignResult>;
+    deleteDocument(input: DeleteDocumentInput): Promise<DeleteDocumentResult>;
     getSigningView(token: string): Promise<SigningView | null>;
     recordView(token: string): Promise<void>;
     submitSignature(input: SubmitInput): Promise<SubmitResult>;
@@ -355,4 +390,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, 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, 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, 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 };

package/dist/server/index.js

@@ -390,6 +390,41 @@ async function documentCoverage(deps, documentId) {
     departed
   };
 }
+
+// src/server/delete.ts
+async function deleteDocument(deps, input) {
+  const mode = input.mode ?? "soft";
+  const ctx = await deps.persistence.getDocumentDeletionContext(input.documentId);
+  if (!ctx) return { ok: false, reason: "not_found" };
+  if (mode === "purge" && ctx.signedCount > 0) {
+    return { ok: false, reason: "has_signatures" };
+  }
+  if (mode === "purge") {
+    await deps.persistence.hardDeleteDocument(input.documentId);
+    const keys = [...ctx.sourceKeys, ...ctx.sealedKeys];
+    for (const key of keys) {
+      await deps.storage.delete(key).catch(() => void 0);
+    }
+    await emitDeleted(deps.hooks, ctx, "purge");
+    return { ok: true, mode: "purge", documentId: input.documentId, objectsPurged: keys.length };
+  }
+  await deps.persistence.softDeleteDocument(input.documentId, deps.clock.now());
+  await emitDeleted(deps.hooks, ctx, "soft");
+  return { ok: true, mode: "soft", documentId: input.documentId, objectsPurged: 0 };
+}
+async function emitDeleted(hooks, ctx, mode) {
+  if (!hooks?.onDocumentDeleted) return;
+  try {
+    await hooks.onDocumentDeleted({
+      documentId: ctx.documentId,
+      documentType: ctx.documentType,
+      scopeId: ctx.scopeId,
+      mode,
+      affectedSubjects: ctx.affectedSubjects
+    });
+  } catch {
+  }
+}
 async function createDocument(persistence, input) {
   if (!input.title.trim()) {
     throw new EsignError("INVALID_INPUT", "A document title is required.");
@@ -949,6 +984,7 @@ function configureEsign(opts) {
       },
       args
     ),
+    deleteDocument: (input) => deleteDocument({ persistence, storage, clock, hooks }, input),
     getSigningView: (token) => getSigningView({ persistence, clock }, token),
     recordView: (token) => recordView({ persistence, clock, hooks }, token),
     submitSignature: (input) => submitSignature(signDeps, input),
@@ -975,6 +1011,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, 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, 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 };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map