@arbidocs/react 0.5.111 → 0.5.113

package/dist/document-tools/saved-signature.js

@@ -0,0 +1,90 @@
+import {
+  getUserEncryptionKeypair,
+  initSodium,
+  sealedBoxDecrypt,
+  sealedBoxEncrypt
+} from "@arbidocs/client";
+import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
+import { useDocumentTools } from "./environment.js";
+import { arbiQueryKeys } from "../query-keys.js";
+const INFORMAL_SIGNATURE_NOTE = "Your saved signature or initials are placed as an image on the document.";
+async function keypair(source = getUserEncryptionKeypair) {
+  await initSodium();
+  const pair = await source();
+  if (!pair) throw new Error("Sign in again to use your saved signature.");
+  return pair;
+}
+function detail(error, fallback) {
+  const d = error?.detail;
+  return typeof d === "string" ? d : fallback;
+}
+async function fetchSavedSignature(client, source) {
+  const { data, error } = await client.GET("/v1/user/signature");
+  if (!data) throw new Error(detail(error, "Your saved signature could not be read"));
+  if (!data.sealed) return null;
+  const pair = await keypair(source);
+  const json = new TextDecoder().decode(sealedBoxDecrypt(data.sealed, pair.secretKey));
+  return JSON.parse(json);
+}
+async function storeSavedSignature(client, signature, source) {
+  const pair = await keypair(source);
+  const sealed = sealedBoxEncrypt(
+    Uint8Array.from(new TextEncoder().encode(JSON.stringify(signature))),
+    pair.publicKey
+  );
+  const { error, response } = await client.PUT("/v1/user/signature", { body: { sealed } });
+  if (!response.ok) throw new Error(detail(error, "Your signature could not be saved"));
+}
+async function deleteSavedSignature(client) {
+  const { error, response } = await client.DELETE("/v1/user/signature");
+  if (!response.ok) throw new Error(detail(error, "Your saved signature could not be deleted"));
+}
+function useSavedSignature(enabled = true) {
+  const { client } = useDocumentTools();
+  return useQuery({
+    queryKey: arbiQueryKeys.savedSignature(),
+    queryFn: () => fetchSavedSignature(client),
+    enabled,
+    staleTime: 6e4,
+    retry: false
+  });
+}
+function useStoreSavedSignature() {
+  const { client } = useDocumentTools();
+  const queryClient = useQueryClient();
+  return useMutation({
+    mutationFn: (signature) => storeSavedSignature(client, signature),
+    onSuccess: (_, signature) => queryClient.setQueryData(arbiQueryKeys.savedSignature(), signature)
+  });
+}
+function useDeleteSavedSignature() {
+  const { client } = useDocumentTools();
+  const queryClient = useQueryClient();
+  return useMutation({
+    mutationFn: () => deleteSavedSignature(client),
+    onSuccess: () => queryClient.setQueryData(arbiQueryKeys.savedSignature(), null)
+  });
+}
+function pngBytes(base64) {
+  const raw = atob(base64);
+  const out = new Uint8Array(raw.length);
+  for (let i = 0; i < raw.length; i++) out[i] = raw.charCodeAt(i);
+  return out;
+}
+function pngSize(base64) {
+  const bytes = pngBytes(base64.slice(0, 64));
+  const view = new DataView(bytes.buffer);
+  return { width: view.getUint32(16), height: view.getUint32(20) };
+}
+export {
+  INFORMAL_SIGNATURE_NOTE,
+  deleteSavedSignature,
+  fetchSavedSignature,
+  pngBytes,
+  pngSize,
+  storeSavedSignature,
+  useDeleteSavedSignature,
+  useSavedSignature,
+  useStoreSavedSignature
+};
+//# sourceMappingURL=saved-signature.js.map

package/dist/document-tools/saved-signature.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/document-tools/saved-signature.ts"],
+  "sourcesContent": ["/**\n * A signature saved to one's account, for informal use: inserted into a Word document as a picture,\n * or placed on a PDF as a stamp, and offered again the next time one adopts a signature to sign.\n *\n * It is sealed HERE, in the browser, to the user's own X25519 key (a SealedBox to the public half of\n * the keypair their signing key derives): the server keeps the sealed bytes (`/v1/user/signature`)\n * and can never read them. Only with the user's explicit consent (\"Save to my account for future\n * use\"); Delete removes it from the account completely. A typed mark is saved as its picture too,\n * so every use has an image to place.\n */\n\nimport {\n  getUserEncryptionKeypair,\n  initSodium,\n  sealedBoxDecrypt,\n  sealedBoxEncrypt,\n  type KeyPair,\n} from '@arbidocs/client'\nimport { useMutation, useQuery, useQueryClient } from '@tanstack/react-query'\nimport { useDocumentTools, type DocumentToolsClient } from './environment'\nimport { arbiQueryKeys } from '../query-keys'\n\nexport interface SavedSignature {\n  name: string\n  initials: string\n  /** How the signature was adopted (a typed one is saved as its picture as well). */\n  style: 'typed' | 'drawn' | 'uploaded'\n  initials_style: 'typed' | 'drawn'\n  /** Base64 PNGs, transparent around the ink. */\n  signature_png: string\n  initials_png: string\n}\n\n/** The one line shown wherever a saved signature is placed by hand. */\nexport const INFORMAL_SIGNATURE_NOTE =\n  'Your saved signature or initials are placed as an image on the document.'\n\n/** The user's own keypair (the session's); a host or a test may pass another. */\nexport type KeypairSource = () => Promise<KeyPair | null>\n\nasync function keypair(source: KeypairSource = getUserEncryptionKeypair): Promise<KeyPair> {\n  await initSodium()\n  const pair = await source()\n  if (!pair) throw new Error('Sign in again to use your saved signature.')\n  return pair\n}\n\nfunction detail(error: unknown, fallback: string): string {\n  const d = (error as { detail?: unknown } | undefined)?.detail\n  return typeof d === 'string' ? d : fallback\n}\n\n/** The saved signature, opened with the user's own key; null when none is saved. */\nexport async function fetchSavedSignature(\n  client: DocumentToolsClient,\n  source?: KeypairSource\n): Promise<SavedSignature | null> {\n  const { data, error } = await client.GET('/v1/user/signature')\n  if (!data) throw new Error(detail(error, 'Your saved signature could not be read'))\n  if (!data.sealed) return null\n  const pair = await keypair(source)\n  const json = new TextDecoder().decode(sealedBoxDecrypt(data.sealed, pair.secretKey))\n  return JSON.parse(json) as SavedSignature\n}\n\n/** Seal it to the user's own key and save it (replacing any saved before). */\nexport async function storeSavedSignature(\n  client: DocumentToolsClient,\n  signature: SavedSignature,\n  source?: KeypairSource\n): Promise<void> {\n  const pair = await keypair(source)\n  const sealed = sealedBoxEncrypt(\n    Uint8Array.from(new TextEncoder().encode(JSON.stringify(signature))),\n    pair.publicKey\n  )\n  const { error, response } = await client.PUT('/v1/user/signature', { body: { sealed } })\n  if (!response.ok) throw new Error(detail(error, 'Your signature could not be saved'))\n}\n\n/** Remove it from the account completely. */\nexport async function deleteSavedSignature(client: DocumentToolsClient): Promise<void> {\n  const { error, response } = await client.DELETE('/v1/user/signature')\n  if (!response.ok) throw new Error(detail(error, 'Your saved signature could not be deleted'))\n}\n\nexport function useSavedSignature(enabled = true) {\n  const { client } = useDocumentTools()\n  return useQuery({\n    queryKey: arbiQueryKeys.savedSignature(),\n    queryFn: () => fetchSavedSignature(client),\n    enabled,\n    staleTime: 60_000,\n    retry: false,\n  })\n}\n\nexport function useStoreSavedSignature() {\n  const { client } = useDocumentTools()\n  const queryClient = useQueryClient()\n  return useMutation({\n    mutationFn: (signature: SavedSignature) => storeSavedSignature(client, signature),\n    onSuccess: (_, signature) =>\n      queryClient.setQueryData(arbiQueryKeys.savedSignature(), signature),\n  })\n}\n\nexport function useDeleteSavedSignature() {\n  const { client } = useDocumentTools()\n  const queryClient = useQueryClient()\n  return useMutation({\n    mutationFn: () => deleteSavedSignature(client),\n    onSuccess: () => queryClient.setQueryData(arbiQueryKeys.savedSignature(), null),\n  })\n}\n\n/** Base64 PNG bytes, decoded (for an inline picture or an upload). */\nexport function pngBytes(base64: string): Uint8Array {\n  const raw = atob(base64)\n  const out = new Uint8Array(raw.length)\n  for (let i = 0; i < raw.length; i++) out[i] = raw.charCodeAt(i)\n  return out\n}\n\n/** A PNG's pixel size, read from its header (IHDR). */\nexport function pngSize(base64: string): { width: number; height: number } {\n  const bytes = pngBytes(base64.slice(0, 64))\n  const view = new DataView(bytes.buffer)\n  return { width: view.getUint32(16), height: view.getUint32(20) }\n}\n"],
+  "mappings": "AAWA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OAEK;AACP,SAAS,aAAa,UAAU,sBAAsB;AACtD,SAAS,wBAAkD;AAC3D,SAAS,qBAAqB;AAcvB,MAAM,0BACX;AAKF,eAAe,QAAQ,SAAwB,0BAA4C;AACzF,QAAM,WAAW;AACjB,QAAM,OAAO,MAAM,OAAO;AAC1B,MAAI,CAAC,KAAM,OAAM,IAAI,MAAM,4CAA4C;AACvE,SAAO;AACT;AAEA,SAAS,OAAO,OAAgB,UAA0B;AACxD,QAAM,IAAK,OAA4C;AACvD,SAAO,OAAO,MAAM,WAAW,IAAI;AACrC;AAGA,eAAsB,oBACpB,QACA,QACgC;AAChC,QAAM,EAAE,MAAM,MAAM,IAAI,MAAM,OAAO,IAAI,oBAAoB;AAC7D,MAAI,CAAC,KAAM,OAAM,IAAI,MAAM,OAAO,OAAO,wCAAwC,CAAC;AAClF,MAAI,CAAC,KAAK,OAAQ,QAAO;AACzB,QAAM,OAAO,MAAM,QAAQ,MAAM;AACjC,QAAM,OAAO,IAAI,YAAY,EAAE,OAAO,iBAAiB,KAAK,QAAQ,KAAK,SAAS,CAAC;AACnF,SAAO,KAAK,MAAM,IAAI;AACxB;AAGA,eAAsB,oBACpB,QACA,WACA,QACe;AACf,QAAM,OAAO,MAAM,QAAQ,MAAM;AACjC,QAAM,SAAS;AAAA,IACb,WAAW,KAAK,IAAI,YAAY,EAAE,OAAO,KAAK,UAAU,SAAS,CAAC,CAAC;AAAA,IACnE,KAAK;AAAA,EACP;AACA,QAAM,EAAE,OAAO,SAAS,IAAI,MAAM,OAAO,IAAI,sBAAsB,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;AACvF,MAAI,CAAC,SAAS,GAAI,OAAM,IAAI,MAAM,OAAO,OAAO,mCAAmC,CAAC;AACtF;AAGA,eAAsB,qBAAqB,QAA4C;AACrF,QAAM,EAAE,OAAO,SAAS,IAAI,MAAM,OAAO,OAAO,oBAAoB;AACpE,MAAI,CAAC,SAAS,GAAI,OAAM,IAAI,MAAM,OAAO,OAAO,2CAA2C,CAAC;AAC9F;AAEO,SAAS,kBAAkB,UAAU,MAAM;AAChD,QAAM,EAAE,OAAO,IAAI,iBAAiB;AACpC,SAAO,SAAS;AAAA,IACd,UAAU,cAAc,eAAe;AAAA,IACvC,SAAS,MAAM,oBAAoB,MAAM;AAAA,IACzC;AAAA,IACA,WAAW;AAAA,IACX,OAAO;AAAA,EACT,CAAC;AACH;AAEO,SAAS,yBAAyB;AACvC,QAAM,EAAE,OAAO,IAAI,iBAAiB;AACpC,QAAM,cAAc,eAAe;AACnC,SAAO,YAAY;AAAA,IACjB,YAAY,CAAC,cAA8B,oBAAoB,QAAQ,SAAS;AAAA,IAChF,WAAW,CAAC,GAAG,cACb,YAAY,aAAa,cAAc,eAAe,GAAG,SAAS;AAAA,EACtE,CAAC;AACH;AAEO,SAAS,0BAA0B;AACxC,QAAM,EAAE,OAAO,IAAI,iBAAiB;AACpC,QAAM,cAAc,eAAe;AACnC,SAAO,YAAY;AAAA,IACjB,YAAY,MAAM,qBAAqB,MAAM;AAAA,IAC7C,WAAW,MAAM,YAAY,aAAa,cAAc,eAAe,GAAG,IAAI;AAAA,EAChF,CAAC;AACH;AAGO,SAAS,SAAS,QAA4B;AACnD,QAAM,MAAM,KAAK,MAAM;AACvB,QAAM,MAAM,IAAI,WAAW,IAAI,MAAM;AACrC,WAAS,IAAI,GAAG,IAAI,IAAI,QAAQ,IAAK,KAAI,CAAC,IAAI,IAAI,WAAW,CAAC;AAC9D,SAAO;AACT;AAGO,SAAS,QAAQ,QAAmD;AACzE,QAAM,QAAQ,SAAS,OAAO,MAAM,GAAG,EAAE,CAAC;AAC1C,QAAM,OAAO,IAAI,SAAS,MAAM,MAAM;AACtC,SAAO,EAAE,OAAO,KAAK,UAAU,EAAE,GAAG,QAAQ,KAAK,UAAU,EAAE,EAAE;AACjE;",
+  "names": []
+}

package/dist/document-tools/signature-requests.js

@@ -0,0 +1,310 @@
+import { signMessage, unlockIdentityWithPassword } from "@arbidocs/client";
+import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
+import { workspaces } from "@arbidocs/sdk/browser";
+import { useDocumentTools } from "./environment.js";
+import { intentText, sha256Hex, SigningError } from "./signing.js";
+import { arbiQueryKeys } from "../query-keys.js";
+import { useArbiHost } from "../host/config.js";
+function useOpenWorkspaceRead() {
+  const arbi = useArbiHost().arbi;
+  const workspaceId = arbi?.hasWorkspace ? arbi.getWorkspaceId() : void 0;
+  const read = (run) => arbi && workspaceId ? arbi.readInWorkspace(workspaceId, run) : run();
+  return { workspaceId, read };
+}
+const SIGNATURE_FIELD_TYPES = [
+  "signature",
+  "initials",
+  "date",
+  "name"
+];
+const FIELD_TYPE_LABELS = {
+  signature: "Signature",
+  initials: "Initials",
+  date: "Date signed",
+  name: "Name"
+};
+const DEFAULT_FIELD_SIZE = {
+  signature: { width: 0.28, height: 0.05 },
+  initials: { width: 0.1, height: 0.04 },
+  date: { width: 0.22, height: 0.028 },
+  name: { width: 0.28, height: 0.028 }
+};
+const SIGNER_PROGRESS_LABELS = {
+  invited: "Invited",
+  registered: "Not opened yet",
+  viewed: "Viewed",
+  signed: "Signed",
+  declined: "Declined"
+};
+const EMAIL = /^[^@\s<>,;]{1,64}@[^@\s<>,;]{1,255}\.[^@\s<>,;]{1,63}$/;
+const isEmailSigner = (signer) => EMAIL.test(signer.trim());
+const MARK_FIELD_TYPES = ["signature", "initials"];
+function detail(error, fallback) {
+  const d = error?.detail;
+  if (typeof d === "string") return d;
+  if (Array.isArray(d) && d[0] && typeof d[0] === "object" && "msg" in d[0]) {
+    return String(d[0].msg);
+  }
+  return fallback;
+}
+function newFieldId() {
+  return `f${Math.random().toString(36).slice(2, 10)}`;
+}
+function initialsOf(name) {
+  return name.split(/\s+/).filter(Boolean).map((part) => part[0].toUpperCase()).join("").slice(0, 4);
+}
+function fieldsInSigningOrder(fields, signer) {
+  return fields.filter((f) => f.signer === signer).sort((a, b) => a.page - b.page || a.y - b.y || a.x - b.x);
+}
+function sendBlocker(fields) {
+  if (fields.length === 0) return "Place at least one field.";
+  const signers = [...new Set(fields.map((f) => f.signer))];
+  for (const signer of signers) {
+    if (!fields.some((f) => f.signer === signer && MARK_FIELD_TYPES.includes(f.type))) {
+      return "Every signer needs a signature or initials field.";
+    }
+  }
+  return null;
+}
+function fieldsFromSuggestions(suggestions, assign, members = /* @__PURE__ */ new Map()) {
+  return suggestions.flatMap((s) => {
+    const email = s.signer_email?.toLowerCase();
+    const signer = email ? members.get(email) ?? email : assign[s.group];
+    if (!signer) return [];
+    return [
+      {
+        id: newFieldId(),
+        type: s.type,
+        page: s.page,
+        x: s.x,
+        y: s.y,
+        width: s.width,
+        height: s.height,
+        signer,
+        required: s.required ?? true
+      }
+    ];
+  });
+}
+function splitSuggestions(suggestions) {
+  return {
+    placed: suggestions.filter((s) => s.source === "anchor"),
+    extras: suggestions.filter((s) => s.source !== "anchor")
+  };
+}
+async function fetchDocumentSignatureRequests(client, documentId) {
+  const { data, error } = await client.GET("/v1/document/{document_ext_id}/signature-requests", {
+    params: { path: { document_ext_id: documentId } }
+  });
+  if (!data) throw new Error(detail(error, "The signature requests could not be read"));
+  return data;
+}
+function useDocumentSignatureRequests(documentId, enabled = true) {
+  const { client } = useDocumentTools();
+  return useQuery({
+    queryKey: arbiQueryKeys.signatureRequestsForDocument(documentId ?? ""),
+    queryFn: () => fetchDocumentSignatureRequests(client, documentId),
+    enabled: enabled && !!documentId,
+    staleTime: 15e3
+  });
+}
+async function signatureFieldSuggestions(client, documentId, version) {
+  const { data, error } = await client.GET(
+    "/v1/document/{document_ext_id}/signature-fields/suggest",
+    {
+      params: { path: { document_ext_id: documentId }, ...version ? { query: { version } } : {} }
+    }
+  );
+  if (!data) throw new Error(detail(error, "Signature blocks could not be read"));
+  return { fields: data.fields, signers: data.signers ?? [] };
+}
+async function suggestSignatureFields(client, documentId, version) {
+  return (await signatureFieldSuggestions(client, documentId, version)).fields;
+}
+async function saveSignatureRequest(client, { documentId, version, fields, message, requestId, send }) {
+  if (!requestId) {
+    const { data, error } = await client.POST("/v1/document/{document_ext_id}/signature-requests", {
+      params: { path: { document_ext_id: documentId } },
+      body: { fields, message: message || null, send, ...version ? { version } : {} }
+    });
+    if (!data) throw new Error(detail(error, "The signature request could not be saved"));
+    return data;
+  }
+  const path = { request_ext_id: requestId };
+  const updated = await client.PATCH("/v1/signature-requests/{request_ext_id}", {
+    params: { path },
+    body: { fields, message: message ?? null }
+  });
+  if (!updated.data) throw new Error(detail(updated.error, "The draft could not be saved"));
+  if (!send) return updated.data;
+  const sent = await client.POST("/v1/signature-requests/{request_ext_id}/send", {
+    params: { path }
+  });
+  if (!sent.data) throw new Error(detail(sent.error, "The request could not be sent"));
+  return sent.data;
+}
+function useInvalidateRequests() {
+  const queryClient = useQueryClient();
+  return () => queryClient.invalidateQueries({ queryKey: arbiQueryKeys.signatureRequests() });
+}
+function useSaveSignatureRequest() {
+  const { client } = useDocumentTools();
+  const invalidate = useInvalidateRequests();
+  return useMutation({
+    mutationFn: (vars) => saveSignatureRequest(client, vars),
+    onSuccess: invalidate
+  });
+}
+function useVoidSignatureRequest() {
+  const { client } = useDocumentTools();
+  const invalidate = useInvalidateRequests();
+  return useMutation({
+    mutationFn: async (requestId) => {
+      const { data, error } = await client.POST("/v1/signature-requests/{request_ext_id}/void", {
+        params: { path: { request_ext_id: requestId } }
+      });
+      if (!data) throw new Error(detail(error, "The request could not be voided"));
+      return data;
+    },
+    onSuccess: invalidate
+  });
+}
+function useDeclineSignatureRequest() {
+  const { client } = useDocumentTools();
+  const invalidate = useInvalidateRequests();
+  return useMutation({
+    mutationFn: async ({ requestId, reason }) => {
+      const { data, error } = await client.POST("/v1/signature-requests/{request_ext_id}/decline", {
+        params: { path: { request_ext_id: requestId } },
+        body: { reason: reason || null }
+      });
+      if (!data) throw new Error(detail(error, "Could not decline"));
+      return data;
+    },
+    onSuccess: invalidate
+  });
+}
+async function signSignatureRequest(client, deploymentDomain, { request, pdfBlob, email, password, adopted, fields }) {
+  const path = { request_ext_id: request.external_id };
+  const body = { adopted, fields };
+  const prepared = await client.POST("/v1/signature-requests/{request_ext_id}/sign/prepare", {
+    params: { path },
+    body
+  });
+  if (!prepared.data) {
+    throw new SigningError(detail(prepared.error, "Could not prepare signing"), "failed");
+  }
+  const { statement, intent, source_sha256, timestamp } = prepared.data;
+  if (source_sha256 !== request.source_sha256 || await sha256Hex(pdfBlob) !== source_sha256) {
+    throw new SigningError("The document changed since it was sent. Ask for it again.", "stale");
+  }
+  if (intent !== intentText({ name: adopted.name })) {
+    throw new Error("Signing statement mismatch; not signed.");
+  }
+  const identity = await unlockIdentityWithPassword(email, password, deploymentDomain);
+  const signed = await client.POST("/v1/signature-requests/{request_ext_id}/sign", {
+    params: { path },
+    body: { ...body, timestamp, signature: signMessage(statement, identity) }
+  });
+  if (!signed.data) throw new SigningError(detail(signed.error, "Signing failed"), "failed");
+  return signed.data;
+}
+function useSignSignatureRequest() {
+  const env = useDocumentTools();
+  const invalidate = useInvalidateRequests();
+  const queryClient = useQueryClient();
+  return useMutation({
+    mutationFn: (vars) => {
+      if (!env.deploymentDomain) throw new Error("Signing is not set up: no deployment domain");
+      return signSignatureRequest(env.client, env.deploymentDomain, vars);
+    },
+    onSuccess: async (result) => {
+      await invalidate();
+      if (result.completed && result.request.doc_ext_id) {
+        await env.onDocumentsChanged?.([result.request.doc_ext_id], "signed");
+        await queryClient.invalidateQueries({ queryKey: arbiQueryKeys.documentSignatures() });
+      }
+    }
+  });
+}
+function useSignerCandidates(enabled = true) {
+  const { client, user } = useDocumentTools();
+  const { workspaceId, read } = useOpenWorkspaceRead();
+  return useQuery({
+    queryKey: arbiQueryKeys.signatureCandidates(workspaceId ?? ""),
+    queryFn: async () => {
+      const { data, error } = await read(() => client.GET("/v1/workspace/users"));
+      if (!data) throw new Error(detail(error, "The workspace members could not be read"));
+      const people = data.filter((m) => m.user.external_id.startsWith("usr-")).map((m) => ({
+        externalId: m.user.external_id,
+        name: [m.user.given_name, m.user.family_name].filter(Boolean).join(" ") || m.user.email,
+        email: m.user.email,
+        role: String(m.role)
+      }));
+      const me = user?.email?.toLowerCase();
+      return [...people].sort(
+        (a, b) => Number(b.email.toLowerCase() === me) - Number(a.email.toLowerCase() === me)
+      );
+    },
+    enabled,
+    staleTime: 6e4
+  });
+}
+async function inviteSigners(client, documentId, emails) {
+  if (!emails.length) return;
+  const { error, response } = await client.POST("/v1/workspace/users", {
+    body: workspaces.addWorkspaceMembersBody({
+      emails,
+      role: "guest",
+      confirm_invite: true,
+      resource_type: "document",
+      resource_ext_id: documentId
+    })
+  });
+  if (response.status === 409) {
+    throw new Error("Share the document with the workspace before asking others to sign it.");
+  }
+  if (error && response.status !== 404) {
+    throw new Error(detail(error, "The signers could not be invited"));
+  }
+}
+function useInviteSigners() {
+  const { client } = useDocumentTools();
+  const invalidate = useInvalidateRequests();
+  const queryClient = useQueryClient();
+  return useMutation({
+    mutationFn: ({ documentId, emails }) => inviteSigners(client, documentId, emails),
+    onSuccess: async () => {
+      await invalidate();
+      await queryClient.invalidateQueries({ queryKey: arbiQueryKeys.signatureCandidates() });
+    }
+  });
+}
+export {
+  DEFAULT_FIELD_SIZE,
+  FIELD_TYPE_LABELS,
+  MARK_FIELD_TYPES,
+  SIGNATURE_FIELD_TYPES,
+  SIGNER_PROGRESS_LABELS,
+  fetchDocumentSignatureRequests,
+  fieldsFromSuggestions,
+  fieldsInSigningOrder,
+  initialsOf,
+  inviteSigners,
+  isEmailSigner,
+  newFieldId,
+  saveSignatureRequest,
+  sendBlocker,
+  signSignatureRequest,
+  signatureFieldSuggestions,
+  splitSuggestions,
+  suggestSignatureFields,
+  useDeclineSignatureRequest,
+  useDocumentSignatureRequests,
+  useInviteSigners,
+  useSaveSignatureRequest,
+  useSignSignatureRequest,
+  useSignerCandidates,
+  useVoidSignatureRequest
+};
+//# sourceMappingURL=signature-requests.js.map

package/dist/document-tools/signature-requests.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/document-tools/signature-requests.ts"],
+  "sourcesContent": ["/**\n * Signature requests: an author places fields (signature, initials, date, name) on the PDF of one\n * exact document version and assigns each to a signer: a workspace member (a guest too), or anyone\n * by email, who is invited to the workspace and signs once they join. A Word document's own\n * signature fields (Insert \u203A Signature field) come back from `suggest` placed exactly, with their\n * signer (`source: 'anchor'`). Each signer is then walked\n * through their fields, adopts a signature once and applies it at each. They sign ONCE for all of\n * their fields: the server's statement binds the PDF they were shown, every field they applied and\n * what they adopted. The last signature draws every field and seals the signed copy as the\n * document's next version (see `src/core/signature_requests.py` in ARBI).\n */\n\nimport { signMessage, unlockIdentityWithPassword, type components } from '@arbidocs/client'\nimport { useMutation, useQuery, useQueryClient } from '@tanstack/react-query'\nimport { workspaces } from '@arbidocs/sdk/browser'\nimport { useDocumentTools, type DocumentToolsClient } from './environment'\nimport { intentText, sha256Hex, SigningError } from './signing'\nimport { arbiQueryKeys } from '../query-keys'\nimport { useArbiHost } from '../host/config'\n\n/**\n * The open workspace, when the host has an `Arbi` with one, and a guard that keeps a read made for\n * it only if that workspace stayed open on the server meanwhile (these lists are the open\n * workspace's there): a read that crosses a switch is dropped, never cached as another's.\n */\nfunction useOpenWorkspaceRead() {\n  const arbi = useArbiHost().arbi\n  const workspaceId = arbi?.hasWorkspace ? arbi.getWorkspaceId() : undefined\n  const read = <T>(run: () => Promise<T>): Promise<T> =>\n    arbi && workspaceId ? arbi.readInWorkspace(workspaceId, run) : run()\n  return { workspaceId, read }\n}\n\nexport type SignatureField = components['schemas']['SignatureField']\nexport type SignatureFieldType = SignatureField['type']\nexport type SignatureRequest = components['schemas']['SignatureRequestResponse']\nexport type SignatureRequestSigner = components['schemas']['SignatureRequestSigner']\nexport type SignerProgress = components['schemas']['SignerProgress']\nexport type SuggestedSignatureField = components['schemas']['SuggestedSignatureField']\nexport type AdoptedSignature = components['schemas']['AdoptedSignature']\nexport type SignRequestSignResponse = components['schemas']['SignRequestSignResponse']\n\n/** Field types in the order the editor offers them. */\nexport const SIGNATURE_FIELD_TYPES: readonly SignatureFieldType[] = [\n  'signature',\n  'initials',\n  'date',\n  'name',\n]\n\nexport const FIELD_TYPE_LABELS: Record<SignatureFieldType, string> = {\n  signature: 'Signature',\n  initials: 'Initials',\n  date: 'Date signed',\n  name: 'Name',\n}\n\n/**\n * Default size of a new field, as fractions of the page (the backend draws to fit the box). The\n * same sizes the server's suggester places fields in (`esign_suggest._SIZE`).\n */\nexport const DEFAULT_FIELD_SIZE: Record<SignatureFieldType, { width: number; height: number }> = {\n  signature: { width: 0.28, height: 0.05 },\n  initials: { width: 0.1, height: 0.04 },\n  date: { width: 0.22, height: 0.028 },\n  name: { width: 0.28, height: 0.028 },\n}\n\n/** How far each signer has got, as the request's sender sees it. */\nexport const SIGNER_PROGRESS_LABELS: Record<SignerProgress, string> = {\n  invited: 'Invited',\n  registered: 'Not opened yet',\n  viewed: 'Viewed',\n  signed: 'Signed',\n  declined: 'Declined',\n}\n\nconst EMAIL = /^[^@\\s<>,;]{1,64}@[^@\\s<>,;]{1,255}\\.[^@\\s<>,;]{1,63}$/\n\n/** Whether a field's signer is an email (someone to invite) rather than a member or request signer. */\nexport const isEmailSigner = (signer: string) => EMAIL.test(signer.trim())\n\n/** The fields carrying a signer's mark: every signer needs at least one to be sent the request. */\nexport const MARK_FIELD_TYPES: readonly SignatureFieldType[] = ['signature', 'initials']\n\nfunction detail(error: unknown, fallback: string): string {\n  const d = (error as { detail?: unknown } | undefined)?.detail\n  if (typeof d === 'string') return d\n  if (Array.isArray(d) && d[0] && typeof d[0] === 'object' && 'msg' in d[0]) {\n    return String((d[0] as { msg: unknown }).msg)\n  }\n  return fallback\n}\n\n/** A short unique id for a new field (the server only needs it unique within the request). */\nexport function newFieldId(): string {\n  return `f${Math.random().toString(36).slice(2, 10)}`\n}\n\n/** Initials from a name: \"Olive M. Owner\" -> \"OMO\". */\nexport function initialsOf(name: string): string {\n  return name\n    .split(/\\s+/)\n    .filter(Boolean)\n    .map((part) => part[0]!.toUpperCase())\n    .join('')\n    .slice(0, 4)\n}\n\n/** The fields a signer completes, in the order they are walked through: page, then top to bottom. */\nexport function fieldsInSigningOrder(fields: SignatureField[], signer: string): SignatureField[] {\n  return fields\n    .filter((f) => f.signer === signer)\n    .sort((a, b) => a.page - b.page || a.y - b.y || a.x - b.x)\n}\n\n/** Why a draft cannot be sent yet, or null when it can. Mirrors the server's checks. */\nexport function sendBlocker(fields: SignatureField[]): string | null {\n  if (fields.length === 0) return 'Place at least one field.'\n  const signers = [...new Set(fields.map((f) => f.signer))]\n  for (const signer of signers) {\n    if (!fields.some((f) => f.signer === signer && MARK_FIELD_TYPES.includes(f.type))) {\n      return 'Every signer needs a signature or initials field.'\n    }\n  }\n  return null\n}\n\n/**\n * Suggested fields grouped by signature block; `assign` maps a block (`group`) to the signer its\n * fields go to. A field placed in the Word document that names its signer goes to them: the\n * member with that email (`members`, by lowercased email), else the email itself (an invitee).\n * Unassigned blocks are left out.\n */\nexport function fieldsFromSuggestions(\n  suggestions: SuggestedSignatureField[],\n  assign: Record<number, string | undefined>,\n  members: ReadonlyMap<string, string> = new Map()\n): SignatureField[] {\n  return suggestions.flatMap((s) => {\n    const email = s.signer_email?.toLowerCase()\n    const signer = email ? (members.get(email) ?? email) : assign[s.group]\n    if (!signer) return []\n    return [\n      {\n        id: newFieldId(),\n        type: s.type,\n        page: s.page,\n        x: s.x,\n        y: s.y,\n        width: s.width,\n        height: s.height,\n        signer,\n        required: s.required ?? true,\n      },\n    ]\n  })\n}\n\n/** The Word document's own fields (found by their anchors) and the optional layout suggestions. */\nexport function splitSuggestions(suggestions: SuggestedSignatureField[]) {\n  return {\n    placed: suggestions.filter((s) => s.source === 'anchor'),\n    extras: suggestions.filter((s) => s.source !== 'anchor'),\n  }\n}\n\n// \u2500\u2500 Reads \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\n\nexport async function fetchDocumentSignatureRequests(\n  client: DocumentToolsClient,\n  documentId: string\n): Promise<SignatureRequest[]> {\n  const { data, error } = await client.GET('/v1/document/{document_ext_id}/signature-requests', {\n    params: { path: { document_ext_id: documentId } },\n  })\n  if (!data) throw new Error(detail(error, 'The signature requests could not be read'))\n  return data\n}\n\n/** A document's signature requests, newest first. */\nexport function useDocumentSignatureRequests(\n  documentId: string | null | undefined,\n  enabled = true\n) {\n  const { client } = useDocumentTools()\n  return useQuery({\n    queryKey: arbiQueryKeys.signatureRequestsForDocument(documentId ?? ''),\n    queryFn: () => fetchDocumentSignatureRequests(client, documentId!),\n    enabled: enabled && !!documentId,\n    staleTime: 15_000,\n  })\n}\n\n/** A signer the Word document's placed fields name, with the name they give. */\nexport interface NamedSigner {\n  email: string\n  name: string\n}\n\n/** What a document asks to be signed: the fields found, and the signers its Word fields name. */\nexport interface SignatureFieldSuggestions {\n  fields: SuggestedSignatureField[]\n  /**\n   * Named even when the PDF shows none of the Word fields' anchors (the fields are then placed by\n   * hand): who each email belongs to. Empty from a server that does not report them.\n   */\n  signers: NamedSigner[]\n}\n\nexport async function signatureFieldSuggestions(\n  client: DocumentToolsClient,\n  documentId: string,\n  version?: number\n): Promise<SignatureFieldSuggestions> {\n  const { data, error } = await client.GET(\n    '/v1/document/{document_ext_id}/signature-fields/suggest',\n    {\n      params: { path: { document_ext_id: documentId }, ...(version ? { query: { version } } : {}) },\n    }\n  )\n  if (!data) throw new Error(detail(error, 'Signature blocks could not be read'))\n  return { fields: data.fields, signers: (data as { signers?: NamedSigner[] }).signers ?? [] }\n}\n\nexport async function suggestSignatureFields(\n  client: DocumentToolsClient,\n  documentId: string,\n  version?: number\n): Promise<SuggestedSignatureField[]> {\n  return (await signatureFieldSuggestions(client, documentId, version)).fields\n}\n\n// \u2500\u2500 Prepare \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\n\nexport interface SaveSignatureRequestVars {\n  documentId: string\n  /** The version the fields were placed on (the PDF shown). Omitted = current. */\n  version?: number\n  fields: SignatureField[]\n  message?: string\n  /** Existing draft to update instead of creating a new request. */\n  requestId?: string\n  /** Send it to the signers (else it is saved as a draft). */\n  send: boolean\n}\n\nexport async function saveSignatureRequest(\n  client: DocumentToolsClient,\n  { documentId, version, fields, message, requestId, send }: SaveSignatureRequestVars\n): Promise<SignatureRequest> {\n  if (!requestId) {\n    const { data, error } = await client.POST('/v1/document/{document_ext_id}/signature-requests', {\n      params: { path: { document_ext_id: documentId } },\n      body: { fields, message: message || null, send, ...(version ? { version } : {}) },\n    })\n    if (!data) throw new Error(detail(error, 'The signature request could not be saved'))\n    return data\n  }\n  const path = { request_ext_id: requestId }\n  const updated = await client.PATCH('/v1/signature-requests/{request_ext_id}', {\n    params: { path },\n    body: { fields, message: message ?? null },\n  })\n  if (!updated.data) throw new Error(detail(updated.error, 'The draft could not be saved'))\n  if (!send) return updated.data\n  const sent = await client.POST('/v1/signature-requests/{request_ext_id}/send', {\n    params: { path },\n  })\n  if (!sent.data) throw new Error(detail(sent.error, 'The request could not be sent'))\n  return sent.data\n}\n\nfunction useInvalidateRequests() {\n  const queryClient = useQueryClient()\n  return () => queryClient.invalidateQueries({ queryKey: arbiQueryKeys.signatureRequests() })\n}\n\nexport function useSaveSignatureRequest() {\n  const { client } = useDocumentTools()\n  const invalidate = useInvalidateRequests()\n  return useMutation({\n    mutationFn: (vars: SaveSignatureRequestVars) => saveSignatureRequest(client, vars),\n    onSuccess: invalidate,\n  })\n}\n\nexport function useVoidSignatureRequest() {\n  const { client } = useDocumentTools()\n  const invalidate = useInvalidateRequests()\n  return useMutation({\n    mutationFn: async (requestId: string) => {\n      const { data, error } = await client.POST('/v1/signature-requests/{request_ext_id}/void', {\n        params: { path: { request_ext_id: requestId } },\n      })\n      if (!data) throw new Error(detail(error, 'The request could not be voided'))\n      return data\n    },\n    onSuccess: invalidate,\n  })\n}\n\nexport function useDeclineSignatureRequest() {\n  const { client } = useDocumentTools()\n  const invalidate = useInvalidateRequests()\n  return useMutation({\n    mutationFn: async ({ requestId, reason }: { requestId: string; reason?: string }) => {\n      const { data, error } = await client.POST('/v1/signature-requests/{request_ext_id}/decline', {\n        params: { path: { request_ext_id: requestId } },\n        body: { reason: reason || null },\n      })\n      if (!data) throw new Error(detail(error, 'Could not decline'))\n      return data\n    },\n    onSuccess: invalidate,\n  })\n}\n\n// \u2500\u2500 Sign \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\n\nexport interface SignRequestVars {\n  request: SignatureRequest\n  /** The PDF the signer was walked through (`GET /view?version=` of the request's version). */\n  pdfBlob: Blob\n  email: string\n  password: string\n  adopted: AdoptedSignature\n  /** The ids of the fields the signer applied: every required one of theirs. */\n  fields: string[]\n}\n\n/**\n * Sign all of the signer's fields at once: the server prepares the statement, the browser checks\n * it covers the PDF on screen under the wording the signer read, re-derives the Ed25519 key from\n * the password and signs. Resolves with `completed` when this was the last signature.\n */\nexport async function signSignatureRequest(\n  client: DocumentToolsClient,\n  deploymentDomain: string,\n  { request, pdfBlob, email, password, adopted, fields }: SignRequestVars\n): Promise<SignRequestSignResponse> {\n  const path = { request_ext_id: request.external_id }\n  const body = { adopted, fields }\n  const prepared = await client.POST('/v1/signature-requests/{request_ext_id}/sign/prepare', {\n    params: { path },\n    body,\n  })\n  if (!prepared.data) {\n    throw new SigningError(detail(prepared.error, 'Could not prepare signing'), 'failed')\n  }\n  const { statement, intent, source_sha256, timestamp } = prepared.data\n  if (source_sha256 !== request.source_sha256 || (await sha256Hex(pdfBlob)) !== source_sha256) {\n    throw new SigningError('The document changed since it was sent. Ask for it again.', 'stale')\n  }\n  if (intent !== intentText({ name: adopted.name })) {\n    throw new Error('Signing statement mismatch; not signed.')\n  }\n  const identity = await unlockIdentityWithPassword(email, password, deploymentDomain)\n  const signed = await client.POST('/v1/signature-requests/{request_ext_id}/sign', {\n    params: { path },\n    body: { ...body, timestamp, signature: signMessage(statement, identity) },\n  })\n  if (!signed.data) throw new SigningError(detail(signed.error, 'Signing failed'), 'failed')\n  return signed.data\n}\n\nexport function useSignSignatureRequest() {\n  const env = useDocumentTools()\n  const invalidate = useInvalidateRequests()\n  const queryClient = useQueryClient()\n  return useMutation({\n    mutationFn: (vars: SignRequestVars) => {\n      if (!env.deploymentDomain) throw new Error('Signing is not set up: no deployment domain')\n      return signSignatureRequest(env.client, env.deploymentDomain, vars)\n    },\n    onSuccess: async (result) => {\n      await invalidate()\n      if (result.completed && result.request.doc_ext_id) {\n        await env.onDocumentsChanged?.([result.request.doc_ext_id], 'signed')\n        await queryClient.invalidateQueries({ queryKey: arbiQueryKeys.documentSignatures() })\n      }\n    },\n  })\n}\n\n// \u2500\u2500 Who can sign \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\n\nexport interface SignerCandidate {\n  externalId: string\n  name: string\n  email: string\n  role: string\n}\n\n/**\n * The people in the active workspace who may sign: owners, collaborators and guests (an agent never\n * does). The first one listed is the current user when they are a member.\n */\nexport function useSignerCandidates(enabled = true) {\n  const { client, user } = useDocumentTools()\n  const { workspaceId, read } = useOpenWorkspaceRead()\n  return useQuery({\n    queryKey: arbiQueryKeys.signatureCandidates(workspaceId ?? ''),\n    queryFn: async (): Promise<SignerCandidate[]> => {\n      const { data, error } = await read(() => client.GET('/v1/workspace/users'))\n      if (!data) throw new Error(detail(error, 'The workspace members could not be read'))\n      const people = data\n        .filter((m) => m.user.external_id.startsWith('usr-'))\n        .map((m) => ({\n          externalId: m.user.external_id,\n          name: [m.user.given_name, m.user.family_name].filter(Boolean).join(' ') || m.user.email,\n          email: m.user.email,\n          role: String(m.role),\n        }))\n      const me = user?.email?.toLowerCase()\n      return [...people].sort(\n        (a, b) => Number(b.email.toLowerCase() === me) - Number(a.email.toLowerCase() === me)\n      )\n    },\n    enabled,\n    staleTime: 60_000,\n  })\n}\n\n// \u2500\u2500 Invite \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\n\n/**\n * Invite signers who are not in the workspace yet, as guests, through the workspace's own invite\n * (`POST /v1/workspace/users` with `confirm_invite`): a registered person is added at once, anyone\n * else is emailed an invitation that lands on the document. Each is asked to sign when they join.\n * Only a workspace owner can invite.\n */\nexport async function inviteSigners(\n  client: DocumentToolsClient,\n  documentId: string,\n  emails: string[]\n): Promise<void> {\n  if (!emails.length) return\n  const { error, response } = await client.POST('/v1/workspace/users', {\n    body: workspaces.addWorkspaceMembersBody({\n      emails,\n      role: 'guest',\n      confirm_invite: true,\n      resource_type: 'document',\n      resource_ext_id: documentId,\n    }),\n  })\n  if (response.status === 409) {\n    throw new Error('Share the document with the workspace before asking others to sign it.')\n  }\n  // 404 \"No users found to add\": everyone is a member already (nothing to do).\n  if (error && response.status !== 404) {\n    throw new Error(detail(error, 'The signers could not be invited'))\n  }\n}\n\nexport function useInviteSigners() {\n  const { client } = useDocumentTools()\n  const invalidate = useInvalidateRequests()\n  const queryClient = useQueryClient()\n  return useMutation({\n    mutationFn: ({ documentId, emails }: { documentId: string; emails: string[] }) =>\n      inviteSigners(client, documentId, emails),\n    onSuccess: async () => {\n      await invalidate()\n      await queryClient.invalidateQueries({ queryKey: arbiQueryKeys.signatureCandidates() })\n    },\n  })\n}\n"],
+  "mappings": "AAYA,SAAS,aAAa,kCAAmD;AACzE,SAAS,aAAa,UAAU,sBAAsB;AACtD,SAAS,kBAAkB;AAC3B,SAAS,wBAAkD;AAC3D,SAAS,YAAY,WAAW,oBAAoB;AACpD,SAAS,qBAAqB;AAC9B,SAAS,mBAAmB;AAO5B,SAAS,uBAAuB;AAC9B,QAAM,OAAO,YAAY,EAAE;AAC3B,QAAM,cAAc,MAAM,eAAe,KAAK,eAAe,IAAI;AACjE,QAAM,OAAO,CAAI,QACf,QAAQ,cAAc,KAAK,gBAAgB,aAAa,GAAG,IAAI,IAAI;AACrE,SAAO,EAAE,aAAa,KAAK;AAC7B;AAYO,MAAM,wBAAuD;AAAA,EAClE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAEO,MAAM,oBAAwD;AAAA,EACnE,WAAW;AAAA,EACX,UAAU;AAAA,EACV,MAAM;AAAA,EACN,MAAM;AACR;AAMO,MAAM,qBAAoF;AAAA,EAC/F,WAAW,EAAE,OAAO,MAAM,QAAQ,KAAK;AAAA,EACvC,UAAU,EAAE,OAAO,KAAK,QAAQ,KAAK;AAAA,EACrC,MAAM,EAAE,OAAO,MAAM,QAAQ,MAAM;AAAA,EACnC,MAAM,EAAE,OAAO,MAAM,QAAQ,MAAM;AACrC;AAGO,MAAM,yBAAyD;AAAA,EACpE,SAAS;AAAA,EACT,YAAY;AAAA,EACZ,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,UAAU;AACZ;AAEA,MAAM,QAAQ;AAGP,MAAM,gBAAgB,CAAC,WAAmB,MAAM,KAAK,OAAO,KAAK,CAAC;AAGlE,MAAM,mBAAkD,CAAC,aAAa,UAAU;AAEvF,SAAS,OAAO,OAAgB,UAA0B;AACxD,QAAM,IAAK,OAA4C;AACvD,MAAI,OAAO,MAAM,SAAU,QAAO;AAClC,MAAI,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,EAAE,CAAC,MAAM,YAAY,SAAS,EAAE,CAAC,GAAG;AACzE,WAAO,OAAQ,EAAE,CAAC,EAAuB,GAAG;AAAA,EAC9C;AACA,SAAO;AACT;AAGO,SAAS,aAAqB;AACnC,SAAO,IAAI,KAAK,OAAO,EAAE,SAAS,EAAE,EAAE,MAAM,GAAG,EAAE,CAAC;AACpD;AAGO,SAAS,WAAW,MAAsB;AAC/C,SAAO,KACJ,MAAM,KAAK,EACX,OAAO,OAAO,EACd,IAAI,CAAC,SAAS,KAAK,CAAC,EAAG,YAAY,CAAC,EACpC,KAAK,EAAE,EACP,MAAM,GAAG,CAAC;AACf;AAGO,SAAS,qBAAqB,QAA0B,QAAkC;AAC/F,SAAO,OACJ,OAAO,CAAC,MAAM,EAAE,WAAW,MAAM,EACjC,KAAK,CAAC,GAAG,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AAC7D;AAGO,SAAS,YAAY,QAAyC;AACnE,MAAI,OAAO,WAAW,EAAG,QAAO;AAChC,QAAM,UAAU,CAAC,GAAG,IAAI,IAAI,OAAO,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACxD,aAAW,UAAU,SAAS;AAC5B,QAAI,CAAC,OAAO,KAAK,CAAC,MAAM,EAAE,WAAW,UAAU,iBAAiB,SAAS,EAAE,IAAI,CAAC,GAAG;AACjF,aAAO;AAAA,IACT;AAAA,EACF;AACA,SAAO;AACT;AAQO,SAAS,sBACd,aACA,QACA,UAAuC,oBAAI,IAAI,GAC7B;AAClB,SAAO,YAAY,QAAQ,CAAC,MAAM;AAChC,UAAM,QAAQ,EAAE,cAAc,YAAY;AAC1C,UAAM,SAAS,QAAS,QAAQ,IAAI,KAAK,KAAK,QAAS,OAAO,EAAE,KAAK;AACrE,QAAI,CAAC,OAAQ,QAAO,CAAC;AACrB,WAAO;AAAA,MACL;AAAA,QACE,IAAI,WAAW;AAAA,QACf,MAAM,EAAE;AAAA,QACR,MAAM,EAAE;AAAA,QACR,GAAG,EAAE;AAAA,QACL,GAAG,EAAE;AAAA,QACL,OAAO,EAAE;AAAA,QACT,QAAQ,EAAE;AAAA,QACV;AAAA,QACA,UAAU,EAAE,YAAY;AAAA,MAC1B;AAAA,IACF;AAAA,EACF,CAAC;AACH;AAGO,SAAS,iBAAiB,aAAwC;AACvE,SAAO;AAAA,IACL,QAAQ,YAAY,OAAO,CAAC,MAAM,EAAE,WAAW,QAAQ;AAAA,IACvD,QAAQ,YAAY,OAAO,CAAC,MAAM,EAAE,WAAW,QAAQ;AAAA,EACzD;AACF;AAIA,eAAsB,+BACpB,QACA,YAC6B;AAC7B,QAAM,EAAE,MAAM,MAAM,IAAI,MAAM,OAAO,IAAI,qDAAqD;AAAA,IAC5F,QAAQ,EAAE,MAAM,EAAE,iBAAiB,WAAW,EAAE;AAAA,EAClD,CAAC;AACD,MAAI,CAAC,KAAM,OAAM,IAAI,MAAM,OAAO,OAAO,0CAA0C,CAAC;AACpF,SAAO;AACT;AAGO,SAAS,6BACd,YACA,UAAU,MACV;AACA,QAAM,EAAE,OAAO,IAAI,iBAAiB;AACpC,SAAO,SAAS;AAAA,IACd,UAAU,cAAc,6BAA6B,cAAc,EAAE;AAAA,IACrE,SAAS,MAAM,+BAA+B,QAAQ,UAAW;AAAA,IACjE,SAAS,WAAW,CAAC,CAAC;AAAA,IACtB,WAAW;AAAA,EACb,CAAC;AACH;AAkBA,eAAsB,0BACpB,QACA,YACA,SACoC;AACpC,QAAM,EAAE,MAAM,MAAM,IAAI,MAAM,OAAO;AAAA,IACnC;AAAA,IACA;AAAA,MACE,QAAQ,EAAE,MAAM,EAAE,iBAAiB,WAAW,GAAG,GAAI,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAG;AAAA,IAC9F;AAAA,EACF;AACA,MAAI,CAAC,KAAM,OAAM,IAAI,MAAM,OAAO,OAAO,oCAAoC,CAAC;AAC9E,SAAO,EAAE,QAAQ,KAAK,QAAQ,SAAU,KAAqC,WAAW,CAAC,EAAE;AAC7F;AAEA,eAAsB,uBACpB,QACA,YACA,SACoC;AACpC,UAAQ,MAAM,0BAA0B,QAAQ,YAAY,OAAO,GAAG;AACxE;AAgBA,eAAsB,qBACpB,QACA,EAAE,YAAY,SAAS,QAAQ,SAAS,WAAW,KAAK,GAC7B;AAC3B,MAAI,CAAC,WAAW;AACd,UAAM,EAAE,MAAM,MAAM,IAAI,MAAM,OAAO,KAAK,qDAAqD;AAAA,MAC7F,QAAQ,EAAE,MAAM,EAAE,iBAAiB,WAAW,EAAE;AAAA,MAChD,MAAM,EAAE,QAAQ,SAAS,WAAW,MAAM,MAAM,GAAI,UAAU,EAAE,QAAQ,IAAI,CAAC,EAAG;AAAA,IAClF,CAAC;AACD,QAAI,CAAC,KAAM,OAAM,IAAI,MAAM,OAAO,OAAO,0CAA0C,CAAC;AACpF,WAAO;AAAA,EACT;AACA,QAAM,OAAO,EAAE,gBAAgB,UAAU;AACzC,QAAM,UAAU,MAAM,OAAO,MAAM,2CAA2C;AAAA,IAC5E,QAAQ,EAAE,KAAK;AAAA,IACf,MAAM,EAAE,QAAQ,SAAS,WAAW,KAAK;AAAA,EAC3C,CAAC;AACD,MAAI,CAAC,QAAQ,KAAM,OAAM,IAAI,MAAM,OAAO,QAAQ,OAAO,8BAA8B,CAAC;AACxF,MAAI,CAAC,KAAM,QAAO,QAAQ;AAC1B,QAAM,OAAO,MAAM,OAAO,KAAK,gDAAgD;AAAA,IAC7E,QAAQ,EAAE,KAAK;AAAA,EACjB,CAAC;AACD,MAAI,CAAC,KAAK,KAAM,OAAM,IAAI,MAAM,OAAO,KAAK,OAAO,+BAA+B,CAAC;AACnF,SAAO,KAAK;AACd;AAEA,SAAS,wBAAwB;AAC/B,QAAM,cAAc,eAAe;AACnC,SAAO,MAAM,YAAY,kBAAkB,EAAE,UAAU,cAAc,kBAAkB,EAAE,CAAC;AAC5F;AAEO,SAAS,0BAA0B;AACxC,QAAM,EAAE,OAAO,IAAI,iBAAiB;AACpC,QAAM,aAAa,sBAAsB;AACzC,SAAO,YAAY;AAAA,IACjB,YAAY,CAAC,SAAmC,qBAAqB,QAAQ,IAAI;AAAA,IACjF,WAAW;AAAA,EACb,CAAC;AACH;AAEO,SAAS,0BAA0B;AACxC,QAAM,EAAE,OAAO,IAAI,iBAAiB;AACpC,QAAM,aAAa,sBAAsB;AACzC,SAAO,YAAY;AAAA,IACjB,YAAY,OAAO,cAAsB;AACvC,YAAM,EAAE,MAAM,MAAM,IAAI,MAAM,OAAO,KAAK,gDAAgD;AAAA,QACxF,QAAQ,EAAE,MAAM,EAAE,gBAAgB,UAAU,EAAE;AAAA,MAChD,CAAC;AACD,UAAI,CAAC,KAAM,OAAM,IAAI,MAAM,OAAO,OAAO,iCAAiC,CAAC;AAC3E,aAAO;AAAA,IACT;AAAA,IACA,WAAW;AAAA,EACb,CAAC;AACH;AAEO,SAAS,6BAA6B;AAC3C,QAAM,EAAE,OAAO,IAAI,iBAAiB;AACpC,QAAM,aAAa,sBAAsB;AACzC,SAAO,YAAY;AAAA,IACjB,YAAY,OAAO,EAAE,WAAW,OAAO,MAA8C;AACnF,YAAM,EAAE,MAAM,MAAM,IAAI,MAAM,OAAO,KAAK,mDAAmD;AAAA,QAC3F,QAAQ,EAAE,MAAM,EAAE,gBAAgB,UAAU,EAAE;AAAA,QAC9C,MAAM,EAAE,QAAQ,UAAU,KAAK;AAAA,MACjC,CAAC;AACD,UAAI,CAAC,KAAM,OAAM,IAAI,MAAM,OAAO,OAAO,mBAAmB,CAAC;AAC7D,aAAO;AAAA,IACT;AAAA,IACA,WAAW;AAAA,EACb,CAAC;AACH;AAoBA,eAAsB,qBACpB,QACA,kBACA,EAAE,SAAS,SAAS,OAAO,UAAU,SAAS,OAAO,GACnB;AAClC,QAAM,OAAO,EAAE,gBAAgB,QAAQ,YAAY;AACnD,QAAM,OAAO,EAAE,SAAS,OAAO;AAC/B,QAAM,WAAW,MAAM,OAAO,KAAK,wDAAwD;AAAA,IACzF,QAAQ,EAAE,KAAK;AAAA,IACf;AAAA,EACF,CAAC;AACD,MAAI,CAAC,SAAS,MAAM;AAClB,UAAM,IAAI,aAAa,OAAO,SAAS,OAAO,2BAA2B,GAAG,QAAQ;AAAA,EACtF;AACA,QAAM,EAAE,WAAW,QAAQ,eAAe,UAAU,IAAI,SAAS;AACjE,MAAI,kBAAkB,QAAQ,iBAAkB,MAAM,UAAU,OAAO,MAAO,eAAe;AAC3F,UAAM,IAAI,aAAa,6DAA6D,OAAO;AAAA,EAC7F;AACA,MAAI,WAAW,WAAW,EAAE,MAAM,QAAQ,KAAK,CAAC,GAAG;AACjD,UAAM,IAAI,MAAM,yCAAyC;AAAA,EAC3D;AACA,QAAM,WAAW,MAAM,2BAA2B,OAAO,UAAU,gBAAgB;AACnF,QAAM,SAAS,MAAM,OAAO,KAAK,gDAAgD;AAAA,IAC/E,QAAQ,EAAE,KAAK;AAAA,IACf,MAAM,EAAE,GAAG,MAAM,WAAW,WAAW,YAAY,WAAW,QAAQ,EAAE;AAAA,EAC1E,CAAC;AACD,MAAI,CAAC,OAAO,KAAM,OAAM,IAAI,aAAa,OAAO,OAAO,OAAO,gBAAgB,GAAG,QAAQ;AACzF,SAAO,OAAO;AAChB;AAEO,SAAS,0BAA0B;AACxC,QAAM,MAAM,iBAAiB;AAC7B,QAAM,aAAa,sBAAsB;AACzC,QAAM,cAAc,eAAe;AACnC,SAAO,YAAY;AAAA,IACjB,YAAY,CAAC,SAA0B;AACrC,UAAI,CAAC,IAAI,iBAAkB,OAAM,IAAI,MAAM,6CAA6C;AACxF,aAAO,qBAAqB,IAAI,QAAQ,IAAI,kBAAkB,IAAI;AAAA,IACpE;AAAA,IACA,WAAW,OAAO,WAAW;AAC3B,YAAM,WAAW;AACjB,UAAI,OAAO,aAAa,OAAO,QAAQ,YAAY;AACjD,cAAM,IAAI,qBAAqB,CAAC,OAAO,QAAQ,UAAU,GAAG,QAAQ;AACpE,cAAM,YAAY,kBAAkB,EAAE,UAAU,cAAc,mBAAmB,EAAE,CAAC;AAAA,MACtF;AAAA,IACF;AAAA,EACF,CAAC;AACH;AAeO,SAAS,oBAAoB,UAAU,MAAM;AAClD,QAAM,EAAE,QAAQ,KAAK,IAAI,iBAAiB;AAC1C,QAAM,EAAE,aAAa,KAAK,IAAI,qBAAqB;AACnD,SAAO,SAAS;AAAA,IACd,UAAU,cAAc,oBAAoB,eAAe,EAAE;AAAA,IAC7D,SAAS,YAAwC;AAC/C,YAAM,EAAE,MAAM,MAAM,IAAI,MAAM,KAAK,MAAM,OAAO,IAAI,qBAAqB,CAAC;AAC1E,UAAI,CAAC,KAAM,OAAM,IAAI,MAAM,OAAO,OAAO,yCAAyC,CAAC;AACnF,YAAM,SAAS,KACZ,OAAO,CAAC,MAAM,EAAE,KAAK,YAAY,WAAW,MAAM,CAAC,EACnD,IAAI,CAAC,OAAO;AAAA,QACX,YAAY,EAAE,KAAK;AAAA,QACnB,MAAM,CAAC,EAAE,KAAK,YAAY,EAAE,KAAK,WAAW,EAAE,OAAO,OAAO,EAAE,KAAK,GAAG,KAAK,EAAE,KAAK;AAAA,QAClF,OAAO,EAAE,KAAK;AAAA,QACd,MAAM,OAAO,EAAE,IAAI;AAAA,MACrB,EAAE;AACJ,YAAM,KAAK,MAAM,OAAO,YAAY;AACpC,aAAO,CAAC,GAAG,MAAM,EAAE;AAAA,QACjB,CAAC,GAAG,MAAM,OAAO,EAAE,MAAM,YAAY,MAAM,EAAE,IAAI,OAAO,EAAE,MAAM,YAAY,MAAM,EAAE;AAAA,MACtF;AAAA,IACF;AAAA,IACA;AAAA,IACA,WAAW;AAAA,EACb,CAAC;AACH;AAUA,eAAsB,cACpB,QACA,YACA,QACe;AACf,MAAI,CAAC,OAAO,OAAQ;AACpB,QAAM,EAAE,OAAO,SAAS,IAAI,MAAM,OAAO,KAAK,uBAAuB;AAAA,IACnE,MAAM,WAAW,wBAAwB;AAAA,MACvC;AAAA,MACA,MAAM;AAAA,MACN,gBAAgB;AAAA,MAChB,eAAe;AAAA,MACf,iBAAiB;AAAA,IACnB,CAAC;AAAA,EACH,CAAC;AACD,MAAI,SAAS,WAAW,KAAK;AAC3B,UAAM,IAAI,MAAM,wEAAwE;AAAA,EAC1F;AAEA,MAAI,SAAS,SAAS,WAAW,KAAK;AACpC,UAAM,IAAI,MAAM,OAAO,OAAO,kCAAkC,CAAC;AAAA,EACnE;AACF;AAEO,SAAS,mBAAmB;AACjC,QAAM,EAAE,OAAO,IAAI,iBAAiB;AACpC,QAAM,aAAa,sBAAsB;AACzC,QAAM,cAAc,eAAe;AACnC,SAAO,YAAY;AAAA,IACjB,YAAY,CAAC,EAAE,YAAY,OAAO,MAChC,cAAc,QAAQ,YAAY,MAAM;AAAA,IAC1C,WAAW,YAAY;AACrB,YAAM,WAAW;AACjB,YAAM,YAAY,kBAAkB,EAAE,UAAU,cAAc,oBAAoB,EAAE,CAAC;AAAA,IACvF;AAAA,EACF,CAAC;AACH;",
+  "names": []
+}

package/dist/document-tools/signing.js

@@ -0,0 +1,127 @@
+import { signMessage, unlockIdentityWithPassword } from "@arbidocs/client";
+import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
+import { parseVersionRef } from "../artifacts/versions.js";
+import { useDocumentTools } from "./environment.js";
+import { arbiQueryKeys } from "../query-keys.js";
+function intentText(signer) {
+  return `I, ${signer.name.trim()}, sign this document electronically. I intend this electronic signature to have the same effect as my handwritten signature.`;
+}
+async function sha256Hex(blob) {
+  const digest = await crypto.subtle.digest("SHA-256", new Uint8Array(await blob.arrayBuffer()));
+  return Array.from(new Uint8Array(digest), (b) => b.toString(16).padStart(2, "0")).join("");
+}
+function toAppearance(box) {
+  return { page: box.page - 1, x: box.rect.x, y: box.rect.y, width: box.rect.w, height: box.rect.h };
+}
+const MIN_SIGNATURE_BOX = { width: 0.3, height: 0.07 };
+function isLegibleSignatureBox(rect) {
+  return rect.w >= MIN_SIGNATURE_BOX.width && rect.h >= MIN_SIGNATURE_BOX.height;
+}
+const SIGNATURES_PATH = "/v1/document/{document_ext_id}/signatures";
+function errorDetail(error, fallback) {
+  const detail = error?.detail;
+  return typeof detail === "string" ? detail : fallback;
+}
+async function fetchDocumentSignatures(client, documentRef) {
+  const { docId, version } = parseVersionRef(documentRef);
+  const { data, error } = await client.GET(SIGNATURES_PATH, {
+    params: { path: { document_ext_id: docId }, ...version ? { query: { version } } : {} }
+  });
+  if (!data) throw new Error(errorDetail(error, "The signatures could not be read"));
+  return data;
+}
+function useDocumentSignatures(documentId, enabled = true) {
+  const { client } = useDocumentTools();
+  const { docId, version } = parseVersionRef(documentId);
+  return useQuery({
+    queryKey: arbiQueryKeys.documentSignatures(docId ?? "", version),
+    queryFn: () => fetchDocumentSignatures(client, documentId),
+    enabled: enabled && !!docId,
+    staleTime: 6e4
+  });
+}
+class SigningError extends Error {
+  reason;
+  constructor(message, reason) {
+    super(message);
+    this.name = "SigningError";
+    this.reason = reason;
+  }
+}
+function signingErrorReason(detail) {
+  if (/still being prepared/i.test(detail)) return "preparing";
+  if (/no longer the current version/i.test(detail)) return "stale";
+  return "failed";
+}
+function signingError(error, fallback) {
+  const detail = errorDetail(error, fallback);
+  return new SigningError(detail, signingErrorReason(detail));
+}
+const PREPARE_RETRIES = 3;
+const PREPARE_RETRY_DELAY_MS = 1500;
+const wait = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+async function signDocument(client, deploymentDomain, {
+  documentId,
+  pdfBlob,
+  email,
+  password,
+  signer,
+  appearance,
+  includeDate = false,
+  version
+}) {
+  const path = { document_ext_id: documentId };
+  const body = {
+    signer: { name: signer.name },
+    ...appearance ? { appearance } : {},
+    include_date: includeDate,
+    ...version ? { version } : {}
+  };
+  const prepare = () => client.POST("/v1/document/{document_ext_id}/sign/prepare", { params: { path }, body });
+  let prepared = await prepare();
+  for (let attempt = 0; !prepared.data && attempt < PREPARE_RETRIES; attempt++) {
+    if (signingError(prepared.error, "").reason !== "preparing") break;
+    await wait(PREPARE_RETRY_DELAY_MS);
+    prepared = await prepare();
+  }
+  if (!prepared.data) throw signingError(prepared.error, "Could not prepare signing");
+  const { statement, intent, source_sha256, timestamp } = prepared.data;
+  if (await sha256Hex(pdfBlob) !== source_sha256) {
+    throw new Error("The document changed since it was opened. Reopen it and sign again.");
+  }
+  if (intent !== intentText(signer)) throw new Error("Signing statement mismatch; not signed.");
+  const identity = await unlockIdentityWithPassword(email, password, deploymentDomain);
+  const signed = await client.POST("/v1/document/{document_ext_id}/sign", {
+    params: { path },
+    body: { ...body, timestamp, signature: signMessage(statement, identity) }
+  });
+  if (!signed.data) throw signingError(signed.error, "Signing failed");
+  return signed.data;
+}
+function useSignDocument() {
+  const env = useDocumentTools();
+  const queryClient = useQueryClient();
+  return useMutation({
+    mutationFn: (vars) => {
+      if (!env.deploymentDomain) throw new Error("Signing is not set up: no deployment domain");
+      return signDocument(env.client, env.deploymentDomain, vars);
+    },
+    onSuccess: async (result) => {
+      await env.onDocumentsChanged?.([result.doc_ext_id], "signed");
+      await queryClient.invalidateQueries({ queryKey: arbiQueryKeys.documentSignatures() });
+    }
+  });
+}
+export {
+  PREPARE_RETRIES,
+  SigningError,
+  fetchDocumentSignatures,
+  intentText,
+  isLegibleSignatureBox,
+  sha256Hex,
+  signDocument,
+  toAppearance,
+  useDocumentSignatures,
+  useSignDocument
+};
+//# sourceMappingURL=signing.js.map

package/dist/document-tools/signing.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/document-tools/signing.ts"],
+  "sourcesContent": ["/**\n * Electronic signing. The backend (`src/core/esign.py` in ARBI) defines what a signature binds;\n * the helpers mirror the two pieces the browser must reproduce exactly: the statement of intent\n * shown to the signer, and the SHA-256 of the PDF the viewer displayed.\n */\n\nimport { signMessage, unlockIdentityWithPassword, type components } from '@arbidocs/client'\nimport { useMutation, useQuery, useQueryClient } from '@tanstack/react-query'\nimport { parseVersionRef } from '../artifacts/versions'\nimport { useDocumentTools, type DocumentToolsClient } from './environment'\nimport { arbiQueryKeys } from '../query-keys'\n\n/**\n * Who signs: the name only. A role, a firm or a place go on the page as ordinary annotation text,\n * which is not part of the signature.\n */\nexport type SignerDetails = components['schemas']['SignerDetails']\n\n/** Same sentence as `esign.intent_text`; the dialog refuses to sign if the server's differs. */\nexport function intentText(signer: SignerDetails): string {\n  return `I, ${signer.name.trim()}, sign this document electronically. I intend this electronic signature to have the same effect as my handwritten signature.`\n}\n\nexport async function sha256Hex(blob: Blob): Promise<string> {\n  const digest = await crypto.subtle.digest('SHA-256', new Uint8Array(await blob.arrayBuffer()))\n  return Array.from(new Uint8Array(digest), (b) => b.toString(16).padStart(2, '0')).join('')\n}\n\n/** A signature box drawn on the annotation overlay, as the signing API's placement. */\nexport function toAppearance(box: {\n  page: number\n  rect: { x: number; y: number; w: number; h: number }\n}): { page: number; x: number; y: number; width: number; height: number } {\n  // The layer counts pages from 1, the signing API from 0. Both use fractions of the page as\n  // displayed, origin top-left.\n  return { page: box.page - 1, x: box.rect.x, y: box.rect.y, width: box.rect.w, height: box.rect.h }\n}\n\n/**\n * The smallest box the backend can draw a legible signature in: the signer's name and the\n * details line shrink to fit, so a box under these fractions of the page is shrunk to near\n * unreadable size. The backend's own default box is 0.40 x 0.10.\n */\nconst MIN_SIGNATURE_BOX = { width: 0.3, height: 0.07 }\n\nexport function isLegibleSignatureBox(rect: { w: number; h: number }): boolean {\n  return rect.w >= MIN_SIGNATURE_BOX.width && rect.h >= MIN_SIGNATURE_BOX.height\n}\n\n// \u2500\u2500 Signing through the API \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\n\nexport type SignatureAppearance = components['schemas']['SignatureAppearance']\nexport type SignatureStatusResponse = components['schemas']['SignatureStatusResponse']\nexport type SignatureRecord = components['schemas']['SignatureRecord']\nexport type SignDocumentResponse = components['schemas']['SignDocumentResponse']\n\nconst SIGNATURES_PATH = '/v1/document/{document_ext_id}/signatures'\n/**\n * The same key openapi-react-query gives this request (`['get', path, init]`), so a host that\n * reads or persists the API cache by path treats it like its own queries.\n */\n\nfunction errorDetail(error: unknown, fallback: string): string {\n  const detail = (error as { detail?: unknown } | undefined)?.detail\n  return typeof detail === 'string' ? detail : fallback\n}\n\n/** Whether a document version is a signed copy, and its signatures. */\nexport async function fetchDocumentSignatures(\n  client: DocumentToolsClient,\n  documentRef: string\n): Promise<SignatureStatusResponse> {\n  const { docId, version } = parseVersionRef(documentRef)\n  const { data, error } = await client.GET(SIGNATURES_PATH, {\n    params: { path: { document_ext_id: docId }, ...(version ? { query: { version } } : {}) },\n  })\n  if (!data) throw new Error(errorDetail(error, 'The signatures could not be read'))\n  return data\n}\n\n/**\n * Is a document version a signed copy? `documentId` is a document id (its current version) or a\n * version reference `doc-\u2026@v{n}`. Needs a React Query `QueryClientProvider`.\n */\nexport function useDocumentSignatures(documentId: string | null | undefined, enabled = true) {\n  const { client } = useDocumentTools()\n  const { docId, version } = parseVersionRef(documentId)\n  return useQuery({\n    queryKey: arbiQueryKeys.documentSignatures(docId ?? '', version),\n    queryFn: () => fetchDocumentSignatures(client, documentId!),\n    enabled: enabled && !!docId,\n    staleTime: 60_000,\n  })\n}\n\n/**\n * Why the server would not sign: the PDF of a Word or text document is still being rendered\n * (`preparing`, worth another try in a moment), or the version on screen is no longer the current\n * one (`stale`: only the current version can be signed, so the signer reopens it).\n */\nexport type SigningErrorReason = 'preparing' | 'stale' | 'failed'\n\nexport class SigningError extends Error {\n  readonly reason: SigningErrorReason\n  constructor(message: string, reason: SigningErrorReason) {\n    super(message)\n    this.name = 'SigningError'\n    this.reason = reason\n  }\n}\n\n/** The 409s the backend's signing router raises, told apart by their wording. */\nfunction signingErrorReason(detail: string): SigningErrorReason {\n  if (/still being prepared/i.test(detail)) return 'preparing'\n  if (/no longer the current version/i.test(detail)) return 'stale'\n  return 'failed'\n}\n\nfunction signingError(error: unknown, fallback: string): SigningError {\n  const detail = errorDetail(error, fallback)\n  return new SigningError(detail, signingErrorReason(detail))\n}\n\n/** How often, and how long apart, a prepare is retried while the PDF is still being rendered. */\nexport const PREPARE_RETRIES = 3\nconst PREPARE_RETRY_DELAY_MS = 1500\n\nconst wait = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms))\n\nexport interface SignDocumentVars {\n  documentId: string\n  /**\n   * The PDF bytes the viewer is showing (`GET /view?version=`, never the original's download): the\n   * signer signs exactly these.\n   */\n  pdfBlob: Blob\n  /**\n   * The version `pdfBlob` is of. The server signs only the current version and refuses\n   * (`SigningError` `stale`) when this one has been superseded. Omitted = the current version.\n   */\n  version?: number\n  email: string\n  password: string\n  signer: SignerDetails\n  /** Where the signature goes; omitted = the backend default (bottom of the last page). */\n  appearance?: SignatureAppearance\n  /** Draw the signing date under the signature. Default off: only the signature is drawn. */\n  includeDate?: boolean\n}\n\n/**\n * Sign a document: the server prepares the statement, the browser checks that it covers the PDF\n * on screen under the wording the signer read, re-derives the user's Ed25519 key from their\n * password and signs it, and the server seals the signed copy as a new version.\n *\n * What is drawn on the page is only the signature (the signer's name as the signature mark) and,\n * with `includeDate`, the date; anyone can click it to open its certificate. A role, a firm or a\n * place go on the page as ordinary annotation text, which is not part of the signature.\n */\nexport async function signDocument(\n  client: DocumentToolsClient,\n  deploymentDomain: string,\n  {\n    documentId,\n    pdfBlob,\n    email,\n    password,\n    signer,\n    appearance,\n    includeDate = false,\n    version,\n  }: SignDocumentVars\n): Promise<SignDocumentResponse> {\n  const path = { document_ext_id: documentId }\n  // One body for both calls: the server refuses a /sign whose include_date (or placement) differs\n  // from what was prepared, since what the signature shows is part of what is signed.\n  const body = {\n    signer: { name: signer.name },\n    ...(appearance ? { appearance } : {}),\n    include_date: includeDate,\n    ...(version ? { version } : {}),\n  }\n\n  // A Word or text document's PDF is rendered after upload: while it is, prepare says so, and a\n  // short wait usually sees it ready.\n  const prepare = () =>\n    client.POST('/v1/document/{document_ext_id}/sign/prepare', { params: { path }, body })\n  let prepared = await prepare()\n  for (let attempt = 0; !prepared.data && attempt < PREPARE_RETRIES; attempt++) {\n    if (signingError(prepared.error, '').reason !== 'preparing') break\n    await wait(PREPARE_RETRY_DELAY_MS)\n    prepared = await prepare()\n  }\n  if (!prepared.data) throw signingError(prepared.error, 'Could not prepare signing')\n  const { statement, intent, source_sha256, timestamp } = prepared.data\n  // Sign only what was on screen, under the wording the signer read.\n  if ((await sha256Hex(pdfBlob)) !== source_sha256) {\n    throw new Error('The document changed since it was opened. Reopen it and sign again.')\n  }\n  if (intent !== intentText(signer)) throw new Error('Signing statement mismatch; not signed.')\n\n  // The re-typed password must open the session's identity, which is the key the server verifies.\n  const identity = await unlockIdentityWithPassword(email, password, deploymentDomain)\n  const signed = await client.POST('/v1/document/{document_ext_id}/sign', {\n    params: { path },\n    body: { ...body, timestamp, signature: signMessage(statement, identity) },\n  })\n  if (!signed.data) throw signingError(signed.error, 'Signing failed')\n  return signed.data\n}\n\n/** The signing mutation. On success the host hears the document changed (`'signed'`). */\nexport function useSignDocument() {\n  const env = useDocumentTools()\n  const queryClient = useQueryClient()\n  return useMutation({\n    mutationFn: (vars: SignDocumentVars) => {\n      if (!env.deploymentDomain) throw new Error('Signing is not set up: no deployment domain')\n      return signDocument(env.client, env.deploymentDomain, vars)\n    },\n    onSuccess: async (result) => {\n      // The signed copy is the document's new current version: the host refreshes its row,\n      // versions and rendered PDF, and the signature badge reads again.\n      await env.onDocumentsChanged?.([result.doc_ext_id], 'signed')\n      await queryClient.invalidateQueries({ queryKey: arbiQueryKeys.documentSignatures() })\n    },\n  })\n}\n"],
+  "mappings": "AAMA,SAAS,aAAa,kCAAmD;AACzE,SAAS,aAAa,UAAU,sBAAsB;AACtD,SAAS,uBAAuB;AAChC,SAAS,wBAAkD;AAC3D,SAAS,qBAAqB;AASvB,SAAS,WAAW,QAA+B;AACxD,SAAO,MAAM,OAAO,KAAK,KAAK,CAAC;AACjC;AAEA,eAAsB,UAAU,MAA6B;AAC3D,QAAM,SAAS,MAAM,OAAO,OAAO,OAAO,WAAW,IAAI,WAAW,MAAM,KAAK,YAAY,CAAC,CAAC;AAC7F,SAAO,MAAM,KAAK,IAAI,WAAW,MAAM,GAAG,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,SAAS,GAAG,GAAG,CAAC,EAAE,KAAK,EAAE;AAC3F;AAGO,SAAS,aAAa,KAG6C;AAGxE,SAAO,EAAE,MAAM,IAAI,OAAO,GAAG,GAAG,IAAI,KAAK,GAAG,GAAG,IAAI,KAAK,GAAG,OAAO,IAAI,KAAK,GAAG,QAAQ,IAAI,KAAK,EAAE;AACnG;AAOA,MAAM,oBAAoB,EAAE,OAAO,KAAK,QAAQ,KAAK;AAE9C,SAAS,sBAAsB,MAAyC;AAC7E,SAAO,KAAK,KAAK,kBAAkB,SAAS,KAAK,KAAK,kBAAkB;AAC1E;AASA,MAAM,kBAAkB;AAMxB,SAAS,YAAY,OAAgB,UAA0B;AAC7D,QAAM,SAAU,OAA4C;AAC5D,SAAO,OAAO,WAAW,WAAW,SAAS;AAC/C;AAGA,eAAsB,wBACpB,QACA,aACkC;AAClC,QAAM,EAAE,OAAO,QAAQ,IAAI,gBAAgB,WAAW;AACtD,QAAM,EAAE,MAAM,MAAM,IAAI,MAAM,OAAO,IAAI,iBAAiB;AAAA,IACxD,QAAQ,EAAE,MAAM,EAAE,iBAAiB,MAAM,GAAG,GAAI,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAG;AAAA,EACzF,CAAC;AACD,MAAI,CAAC,KAAM,OAAM,IAAI,MAAM,YAAY,OAAO,kCAAkC,CAAC;AACjF,SAAO;AACT;AAMO,SAAS,sBAAsB,YAAuC,UAAU,MAAM;AAC3F,QAAM,EAAE,OAAO,IAAI,iBAAiB;AACpC,QAAM,EAAE,OAAO,QAAQ,IAAI,gBAAgB,UAAU;AACrD,SAAO,SAAS;AAAA,IACd,UAAU,cAAc,mBAAmB,SAAS,IAAI,OAAO;AAAA,IAC/D,SAAS,MAAM,wBAAwB,QAAQ,UAAW;AAAA,IAC1D,SAAS,WAAW,CAAC,CAAC;AAAA,IACtB,WAAW;AAAA,EACb,CAAC;AACH;AASO,MAAM,qBAAqB,MAAM;AAAA,EAC7B;AAAA,EACT,YAAY,SAAiB,QAA4B;AACvD,UAAM,OAAO;AACb,SAAK,OAAO;AACZ,SAAK,SAAS;AAAA,EAChB;AACF;AAGA,SAAS,mBAAmB,QAAoC;AAC9D,MAAI,wBAAwB,KAAK,MAAM,EAAG,QAAO;AACjD,MAAI,iCAAiC,KAAK,MAAM,EAAG,QAAO;AAC1D,SAAO;AACT;AAEA,SAAS,aAAa,OAAgB,UAAgC;AACpE,QAAM,SAAS,YAAY,OAAO,QAAQ;AAC1C,SAAO,IAAI,aAAa,QAAQ,mBAAmB,MAAM,CAAC;AAC5D;AAGO,MAAM,kBAAkB;AAC/B,MAAM,yBAAyB;AAE/B,MAAM,OAAO,CAAC,OAAe,IAAI,QAAQ,CAAC,YAAY,WAAW,SAAS,EAAE,CAAC;AAgC7E,eAAsB,aACpB,QACA,kBACA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA,cAAc;AAAA,EACd;AACF,GAC+B;AAC/B,QAAM,OAAO,EAAE,iBAAiB,WAAW;AAG3C,QAAM,OAAO;AAAA,IACX,QAAQ,EAAE,MAAM,OAAO,KAAK;AAAA,IAC5B,GAAI,aAAa,EAAE,WAAW,IAAI,CAAC;AAAA,IACnC,cAAc;AAAA,IACd,GAAI,UAAU,EAAE,QAAQ,IAAI,CAAC;AAAA,EAC/B;AAIA,QAAM,UAAU,MACd,OAAO,KAAK,+CAA+C,EAAE,QAAQ,EAAE,KAAK,GAAG,KAAK,CAAC;AACvF,MAAI,WAAW,MAAM,QAAQ;AAC7B,WAAS,UAAU,GAAG,CAAC,SAAS,QAAQ,UAAU,iBAAiB,WAAW;AAC5E,QAAI,aAAa,SAAS,OAAO,EAAE,EAAE,WAAW,YAAa;AAC7D,UAAM,KAAK,sBAAsB;AACjC,eAAW,MAAM,QAAQ;AAAA,EAC3B;AACA,MAAI,CAAC,SAAS,KAAM,OAAM,aAAa,SAAS,OAAO,2BAA2B;AAClF,QAAM,EAAE,WAAW,QAAQ,eAAe,UAAU,IAAI,SAAS;AAEjE,MAAK,MAAM,UAAU,OAAO,MAAO,eAAe;AAChD,UAAM,IAAI,MAAM,qEAAqE;AAAA,EACvF;AACA,MAAI,WAAW,WAAW,MAAM,EAAG,OAAM,IAAI,MAAM,yCAAyC;AAG5F,QAAM,WAAW,MAAM,2BAA2B,OAAO,UAAU,gBAAgB;AACnF,QAAM,SAAS,MAAM,OAAO,KAAK,uCAAuC;AAAA,IACtE,QAAQ,EAAE,KAAK;AAAA,IACf,MAAM,EAAE,GAAG,MAAM,WAAW,WAAW,YAAY,WAAW,QAAQ,EAAE;AAAA,EAC1E,CAAC;AACD,MAAI,CAAC,OAAO,KAAM,OAAM,aAAa,OAAO,OAAO,gBAAgB;AACnE,SAAO,OAAO;AAChB;AAGO,SAAS,kBAAkB;AAChC,QAAM,MAAM,iBAAiB;AAC7B,QAAM,cAAc,eAAe;AACnC,SAAO,YAAY;AAAA,IACjB,YAAY,CAAC,SAA2B;AACtC,UAAI,CAAC,IAAI,iBAAkB,OAAM,IAAI,MAAM,6CAA6C;AACxF,aAAO,aAAa,IAAI,QAAQ,IAAI,kBAAkB,IAAI;AAAA,IAC5D;AAAA,IACA,WAAW,OAAO,WAAW;AAG3B,YAAM,IAAI,qBAAqB,CAAC,OAAO,UAAU,GAAG,QAAQ;AAC5D,YAAM,YAAY,kBAAkB,EAAE,UAAU,cAAc,mBAAmB,EAAE,CAAC;AAAA,IACtF;AAAA,EACF,CAAC;AACH;",
+  "names": []
+}