@arbidocs/react 0.5.110 → 0.5.112

package/dist/document-tools/production.js

@@ -0,0 +1,147 @@
+import { DocumentFetchError, fetchDocumentFile, fetchDocumentPdf } from "./document-pdf.js";
+const PRODUCTIONS_FOLDER = "Productions";
+const extensionOf = (fileName) => {
+  const name = (fileName ?? "").toLowerCase();
+  const dot = name.lastIndexOf(".");
+  return dot < 0 ? "" : name.slice(dot + 1);
+};
+const NO_RENDITION_EXTENSIONS = new Set(
+  [
+    // images
+    "jpg jpeg png gif bmp tiff tif webp heic",
+    // video and audio
+    "mp4 mpeg mpg webm mov avi mkv mp3 wav m4a aac ogg flac",
+    // archives, binaries, design files
+    "zip rar 7z tar gz exe bin dmg iso apk msi dll so psd ai sketch"
+  ].join(" ").split(" ")
+);
+const isPdfDocument = (doc) => /pdf/i.test(doc.file_type ?? "") || extensionOf(doc.file_name) === "pdf";
+const hasNoRendition = (doc) => !isPdfDocument(doc) && NO_RENDITION_EXTENSIONS.has(extensionOf(doc.file_name));
+const productionDocumentName = (doc) => doc.doc_metadata?.title || doc.file_name || doc.external_id;
+const isPdfBytes = (bytes) => bytes.length > 4 && String.fromCharCode(...bytes.subarray(0, 5)) === "%PDF-";
+async function fetchProductionPdf(client, doc) {
+  const pdf = isPdfDocument(doc);
+  let blob;
+  try {
+    blob = await (pdf ? fetchDocumentFile : fetchDocumentPdf)(client, doc.external_id);
+  } catch (e) {
+    if (!pdf && e instanceof DocumentFetchError) return null;
+    throw e;
+  }
+  const bytes = new Uint8Array(await blob.arrayBuffer());
+  return pdf || isPdfBytes(bytes) ? bytes : null;
+}
+const safeName = (name) => name.replace(/[\\/:*?"<>|]+/g, "_").trim();
+function productionTitle(firstLabel, lastLabel) {
+  return safeName(`Production ${firstLabel}-${lastLabel}`);
+}
+function productionFolder(title, merged) {
+  return merged ? PRODUCTIONS_FOLDER : `${PRODUCTIONS_FOLDER}/${title}`;
+}
+function productionFileName(file, title) {
+  if (!file.firstLabel) return `${title} index.pdf`;
+  return `${file.name.replace(/\.pdf$/i, "")} (${file.firstLabel}-${file.lastLabel}).pdf`;
+}
+const csvCell = (value) => `"${String(value).replace(/"/g, '""')}"`;
+function productionIndexCsv(index) {
+  const rows = index.map(
+    (e) => [e.documentId, e.name, e.file, e.pages, e.firstLabel, e.lastLabel].map(csvCell).join(",")
+  );
+  return ["document_id,name,file,pages,first_label,last_label", ...rows].join("\n");
+}
+async function saveProductionFiles(upload, files, folder) {
+  const ids = [];
+  for (const file of files) {
+    const query = {
+      derived_from: file.sources.map((doc) => doc.external_id),
+      derived_role: "production",
+      shared: file.sources.every((doc) => doc.shared),
+      folder
+    };
+    const workspaces = new Set(file.sources.map((doc) => doc.workspace_ext_id).filter(Boolean));
+    if (workspaces.size === 1) query.workspace_ext_id = [...workspaces][0];
+    const response = await upload({
+      file: new File([file.bytes], file.name, { type: "application/pdf" }),
+      query
+    });
+    ids.push(...response?.doc_ext_ids ?? []);
+  }
+  return ids;
+}
+async function buildProduction(client, documents, choices, options) {
+  const byId = new Map(documents.map((doc) => [doc.external_id, doc]));
+  const included = [];
+  const noRendition = [];
+  const items = [];
+  for (const doc of choices.order.flatMap((id) => byId.get(id) ?? [])) {
+    const bytes = await fetchProductionPdf(client, doc);
+    if (!bytes) {
+      noRendition.push(doc);
+      continue;
+    }
+    included.push(doc);
+    items.push({
+      name: productionDocumentName(doc),
+      documentId: doc.external_id,
+      bytes,
+      qrUrl: options.documentUrl(doc.external_id)
+    });
+  }
+  if (items.length === 0) {
+    throw new Error("None of these documents has a PDF version to number yet.");
+  }
+  const { buildBundle } = await import("../annotations/freeze/bundle.js");
+  const result = await buildBundle(items, {
+    layout: choices.layout,
+    bates: {
+      prefix: choices.prefix,
+      start: choices.start,
+      digits: choices.digits,
+      corner: choices.corner
+    },
+    qr: choices.qr,
+    // The QR code sits in the bottom corner the label is not in.
+    qrCorner: choices.corner.endsWith("left") ? "bottom-right" : "bottom-left",
+    indexPage: choices.indexPage,
+    author: options.author,
+    onProgress: options.onProgress
+  });
+  const title = productionTitle(
+    result.index[0].firstLabel,
+    result.index[result.index.length - 1].lastLabel
+  );
+  const merged = choices.layout === "merged";
+  const files = merged ? [{ ...result.files[0], name: `${title}.pdf` }] : result.files;
+  const sourceOf = new Map(result.index.map((e) => [e.file, byId.get(e.documentId)]));
+  const uploads = files.map((file) => ({
+    name: merged ? file.name : productionFileName(file, title),
+    bytes: file.bytes,
+    // The merged file (and a separate index) is made from every document; each per-document
+    // file from its own.
+    sources: merged || !sourceOf.has(file.name) ? included : [sourceOf.get(file.name)]
+  }));
+  return {
+    title,
+    merged,
+    files,
+    index: result.index,
+    included,
+    noRendition,
+    uploads,
+    folder: productionFolder(title, merged)
+  };
+}
+export {
+  PRODUCTIONS_FOLDER,
+  buildProduction,
+  fetchProductionPdf,
+  hasNoRendition,
+  isPdfDocument,
+  productionDocumentName,
+  productionFileName,
+  productionFolder,
+  productionIndexCsv,
+  productionTitle,
+  saveProductionFiles
+};
+//# sourceMappingURL=production.js.map

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

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/document-tools/production.ts"],
+  "sourcesContent": ["/**\n * Production sets: number the selected documents with Bates labels (optionally a QR code back to\n * each document and an index page) and save the result back to the workspace. The dialog is\n * `ProductionSetDialog` in `@arbidocs/blocks/document-tools`; this is its data side.\n *\n * A PDF is numbered as stored (`/download`). Any other document is numbered through its PDF\n * rendition (`/view`, what the viewer shows for a Word or text file); one without a rendition is\n * left out. Saved results are new documents derived from their sources (role `production`) in a\n * Productions folder, shared with the workspace only if every source is. The originals never\n * change.\n *\n * pdf-lib (the numbering) is loaded only when a production is built, so importing this module\n * stays as light as the rest of the document tools.\n */\n\nimport type { components } from '@arbidocs/client'\nimport type { ProductionChoices } from '../annotations/ProductionDialog'\nimport type { BundleFile, BundleIndexEntry, BundleItem } from '../annotations/freeze/bundle'\nimport { DocumentFetchError, fetchDocumentFile, fetchDocumentPdf } from './document-pdf'\nimport type {\n  DocumentToolsClient,\n  DocumentToolsEnvironment,\n  DocumentUploadQuery,\n} from './environment'\n\n/** The fields of a document record (`DocResponse`) a production uses. */\nexport type ProductionSource = Pick<\n  components['schemas']['DocResponse'],\n  'external_id' | 'file_name' | 'file_type' | 'shared'\n> & {\n  doc_metadata?: { title?: string | null } | null\n  /** The document's workspace: the produced files are saved there, named on the upload. */\n  workspace_ext_id?: string | null\n}\n\nexport const PRODUCTIONS_FOLDER = 'Productions'\n\nconst extensionOf = (fileName: string | null | undefined) => {\n  const name = (fileName ?? '').toLowerCase()\n  const dot = name.lastIndexOf('.')\n  return dot < 0 ? '' : name.slice(dot + 1)\n}\n\n/** Media, archives and design files: no PDF version to number. */\nconst NO_RENDITION_EXTENSIONS = new Set(\n  [\n    // images\n    'jpg jpeg png gif bmp tiff tif webp heic',\n    // video and audio\n    'mp4 mpeg mpg webm mov avi mkv mp3 wav m4a aac ogg flac',\n    // archives, binaries, design files\n    'zip rar 7z tar gz exe bin dmg iso apk msi dll so psd ai sketch',\n  ]\n    .join(' ')\n    .split(' ')\n)\n\nexport const isPdfDocument = (doc: ProductionSource) =>\n  /pdf/i.test(doc.file_type ?? '') || extensionOf(doc.file_name) === 'pdf'\n\n/** True for a document with no PDF version to number (media, archives and the like). */\nexport const hasNoRendition = (doc: ProductionSource) =>\n  !isPdfDocument(doc) && NO_RENDITION_EXTENSIONS.has(extensionOf(doc.file_name))\n\n/** The name a document goes by in the dialog and the index: its title, else its file name. */\nexport const productionDocumentName = (doc: ProductionSource) =>\n  doc.doc_metadata?.title || doc.file_name || doc.external_id\n\nconst isPdfBytes = (bytes: Uint8Array) =>\n  bytes.length > 4 && String.fromCharCode(...bytes.subarray(0, 5)) === '%PDF-'\n\n/**\n * The PDF to number for `doc`: the file itself, or the PDF version of anything else. `null` when a\n * non-PDF has no PDF version (yet), so it is left out; a PDF that cannot be downloaded throws.\n */\nexport async function fetchProductionPdf(\n  client: DocumentToolsClient,\n  doc: ProductionSource\n): Promise<Uint8Array | null> {\n  const pdf = isPdfDocument(doc)\n  let blob: Blob\n  try {\n    blob = await (pdf ? fetchDocumentFile : fetchDocumentPdf)(client, doc.external_id)\n  } catch (e) {\n    if (!pdf && e instanceof DocumentFetchError) return null\n    throw e\n  }\n  const bytes = new Uint8Array(await blob.arrayBuffer())\n  return pdf || isPdfBytes(bytes) ? bytes : null\n}\n\nconst safeName = (name: string) => name.replace(/[\\\\/:*?\"<>|]+/g, '_').trim()\n\n/** \"Production ACME-000001-ACME-000042\": names the files and folder of one production. */\nexport function productionTitle(firstLabel: string, lastLabel: string): string {\n  return safeName(`Production ${firstLabel}-${lastLabel}`)\n}\n\n/** Where a production is saved: the Productions folder, or a folder of its own per document. */\nexport function productionFolder(title: string, merged: boolean): string {\n  return merged ? PRODUCTIONS_FOLDER : `${PRODUCTIONS_FOLDER}/${title}`\n}\n\n/** In the workspace a per-document file says which range it holds, beside its original. */\nexport function productionFileName(file: BundleFile, title: string): string {\n  if (!file.firstLabel) return `${title} index.pdf`\n  return `${file.name.replace(/\\.pdf$/i, '')} (${file.firstLabel}-${file.lastLabel}).pdf`\n}\n\nconst csvCell = (value: string | number) => `\"${String(value).replace(/\"/g, '\"\"')}\"`\n\n/** The `index.csv` of a per-document production: every document with its file and range. */\nexport function productionIndexCsv(index: readonly BundleIndexEntry[]): string {\n  const rows = index.map((e) =>\n    [e.documentId, e.name, e.file, e.pages, e.firstLabel, e.lastLabel].map(csvCell).join(',')\n  )\n  return ['document_id,name,file,pages,first_label,last_label', ...rows].join('\\n')\n}\n\nexport interface ProductionUpload {\n  name: string\n  bytes: Uint8Array\n  /** The documents this file was made from. */\n  sources: ProductionSource[]\n}\n\n/** Save each file as a new workspace document derived from its sources; returns the new ids. */\nexport async function saveProductionFiles(\n  upload: NonNullable<DocumentToolsEnvironment['uploadDocument']>,\n  files: readonly ProductionUpload[],\n  folder: string\n): Promise<string[]> {\n  const ids: string[] = []\n  for (const file of files) {\n    const query: DocumentUploadQuery = {\n      derived_from: file.sources.map((doc) => doc.external_id),\n      derived_role: 'production',\n      shared: file.sources.every((doc) => doc.shared),\n      folder,\n    }\n    // Saved in the sources' workspace, named on the upload (never whichever one is open now).\n    const workspaces = new Set(file.sources.map((doc) => doc.workspace_ext_id).filter(Boolean))\n    if (workspaces.size === 1) query.workspace_ext_id = [...workspaces][0]\n    const response = await upload({\n      file: new File([file.bytes as BlobPart], file.name, { type: 'application/pdf' }),\n      query,\n    })\n    ids.push(...(response?.doc_ext_ids ?? []))\n  }\n  return ids\n}\n\nexport interface BuildProductionOptions {\n  /** The link a document's QR code opens (the document in the host app). */\n  documentUrl: (documentId: string) => string\n  /** Who produced the set; recorded in a merged file's metadata. */\n  author?: string\n  onProgress?: (done: number, total: number) => void\n}\n\nexport interface BuiltProduction {\n  title: string\n  merged: boolean\n  /** The numbered files: one merged PDF (named after its range), or one per document (+ index). */\n  files: BundleFile[]\n  index: BundleIndexEntry[]\n  /** The documents numbered, in order. */\n  included: ProductionSource[]\n  /** Documents left out because they have no PDF version yet. */\n  noRendition: ProductionSource[]\n  /** The files as they are saved to the workspace, each with the documents it was made from. */\n  uploads: ProductionUpload[]\n  folder: string\n}\n\n/**\n * Fetch each document's PDF (in `choices.order`) and number the set. Throws when none of the\n * documents has a PDF version, or when a PDF cannot be fetched.\n */\nexport async function buildProduction(\n  client: DocumentToolsClient,\n  documents: readonly ProductionSource[],\n  choices: ProductionChoices,\n  options: BuildProductionOptions\n): Promise<BuiltProduction> {\n  const byId = new Map(documents.map((doc) => [doc.external_id, doc]))\n  const included: ProductionSource[] = []\n  const noRendition: ProductionSource[] = []\n  const items: BundleItem[] = []\n  for (const doc of choices.order.flatMap((id) => byId.get(id) ?? [])) {\n    const bytes = await fetchProductionPdf(client, doc)\n    if (!bytes) {\n      noRendition.push(doc)\n      continue\n    }\n    included.push(doc)\n    items.push({\n      name: productionDocumentName(doc),\n      documentId: doc.external_id,\n      bytes,\n      qrUrl: options.documentUrl(doc.external_id),\n    })\n  }\n  if (items.length === 0) {\n    throw new Error('None of these documents has a PDF version to number yet.')\n  }\n\n  const { buildBundle } = await import('../annotations/freeze/bundle')\n  const result = await buildBundle(items, {\n    layout: choices.layout,\n    bates: {\n      prefix: choices.prefix,\n      start: choices.start,\n      digits: choices.digits,\n      corner: choices.corner,\n    },\n    qr: choices.qr,\n    // The QR code sits in the bottom corner the label is not in.\n    qrCorner: choices.corner.endsWith('left') ? 'bottom-right' : 'bottom-left',\n    indexPage: choices.indexPage,\n    author: options.author,\n    onProgress: options.onProgress,\n  })\n\n  const title = productionTitle(\n    result.index[0].firstLabel,\n    result.index[result.index.length - 1].lastLabel\n  )\n  const merged = choices.layout === 'merged'\n  // A merged file is named after its range; per-document files keep their document names.\n  const files = merged ? [{ ...result.files[0], name: `${title}.pdf` }] : result.files\n  const sourceOf = new Map(result.index.map((e) => [e.file, byId.get(e.documentId)!]))\n  const uploads = files.map((file) => ({\n    name: merged ? file.name : productionFileName(file, title),\n    bytes: file.bytes,\n    // The merged file (and a separate index) is made from every document; each per-document\n    // file from its own.\n    sources: merged || !sourceOf.has(file.name) ? included : [sourceOf.get(file.name)!],\n  }))\n  return {\n    title,\n    merged,\n    files,\n    index: result.index,\n    included,\n    noRendition,\n    uploads,\n    folder: productionFolder(title, merged),\n  }\n}\n"],
+  "mappings": "AAkBA,SAAS,oBAAoB,mBAAmB,wBAAwB;AAiBjE,MAAM,qBAAqB;AAElC,MAAM,cAAc,CAAC,aAAwC;AAC3D,QAAM,QAAQ,YAAY,IAAI,YAAY;AAC1C,QAAM,MAAM,KAAK,YAAY,GAAG;AAChC,SAAO,MAAM,IAAI,KAAK,KAAK,MAAM,MAAM,CAAC;AAC1C;AAGA,MAAM,0BAA0B,IAAI;AAAA,EAClC;AAAA;AAAA,IAEE;AAAA;AAAA,IAEA;AAAA;AAAA,IAEA;AAAA,EACF,EACG,KAAK,GAAG,EACR,MAAM,GAAG;AACd;AAEO,MAAM,gBAAgB,CAAC,QAC5B,OAAO,KAAK,IAAI,aAAa,EAAE,KAAK,YAAY,IAAI,SAAS,MAAM;AAG9D,MAAM,iBAAiB,CAAC,QAC7B,CAAC,cAAc,GAAG,KAAK,wBAAwB,IAAI,YAAY,IAAI,SAAS,CAAC;AAGxE,MAAM,yBAAyB,CAAC,QACrC,IAAI,cAAc,SAAS,IAAI,aAAa,IAAI;AAElD,MAAM,aAAa,CAAC,UAClB,MAAM,SAAS,KAAK,OAAO,aAAa,GAAG,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM;AAMvE,eAAsB,mBACpB,QACA,KAC4B;AAC5B,QAAM,MAAM,cAAc,GAAG;AAC7B,MAAI;AACJ,MAAI;AACF,WAAO,OAAO,MAAM,oBAAoB,kBAAkB,QAAQ,IAAI,WAAW;AAAA,EACnF,SAAS,GAAG;AACV,QAAI,CAAC,OAAO,aAAa,mBAAoB,QAAO;AACpD,UAAM;AAAA,EACR;AACA,QAAM,QAAQ,IAAI,WAAW,MAAM,KAAK,YAAY,CAAC;AACrD,SAAO,OAAO,WAAW,KAAK,IAAI,QAAQ;AAC5C;AAEA,MAAM,WAAW,CAAC,SAAiB,KAAK,QAAQ,kBAAkB,GAAG,EAAE,KAAK;AAGrE,SAAS,gBAAgB,YAAoB,WAA2B;AAC7E,SAAO,SAAS,cAAc,UAAU,IAAI,SAAS,EAAE;AACzD;AAGO,SAAS,iBAAiB,OAAe,QAAyB;AACvE,SAAO,SAAS,qBAAqB,GAAG,kBAAkB,IAAI,KAAK;AACrE;AAGO,SAAS,mBAAmB,MAAkB,OAAuB;AAC1E,MAAI,CAAC,KAAK,WAAY,QAAO,GAAG,KAAK;AACrC,SAAO,GAAG,KAAK,KAAK,QAAQ,WAAW,EAAE,CAAC,KAAK,KAAK,UAAU,IAAI,KAAK,SAAS;AAClF;AAEA,MAAM,UAAU,CAAC,UAA2B,IAAI,OAAO,KAAK,EAAE,QAAQ,MAAM,IAAI,CAAC;AAG1E,SAAS,mBAAmB,OAA4C;AAC7E,QAAM,OAAO,MAAM;AAAA,IAAI,CAAC,MACtB,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,IAAI,OAAO,EAAE,KAAK,GAAG;AAAA,EAC1F;AACA,SAAO,CAAC,sDAAsD,GAAG,IAAI,EAAE,KAAK,IAAI;AAClF;AAUA,eAAsB,oBACpB,QACA,OACA,QACmB;AACnB,QAAM,MAAgB,CAAC;AACvB,aAAW,QAAQ,OAAO;AACxB,UAAM,QAA6B;AAAA,MACjC,cAAc,KAAK,QAAQ,IAAI,CAAC,QAAQ,IAAI,WAAW;AAAA,MACvD,cAAc;AAAA,MACd,QAAQ,KAAK,QAAQ,MAAM,CAAC,QAAQ,IAAI,MAAM;AAAA,MAC9C;AAAA,IACF;AAEA,UAAM,aAAa,IAAI,IAAI,KAAK,QAAQ,IAAI,CAAC,QAAQ,IAAI,gBAAgB,EAAE,OAAO,OAAO,CAAC;AAC1F,QAAI,WAAW,SAAS,EAAG,OAAM,mBAAmB,CAAC,GAAG,UAAU,EAAE,CAAC;AACrE,UAAM,WAAW,MAAM,OAAO;AAAA,MAC5B,MAAM,IAAI,KAAK,CAAC,KAAK,KAAiB,GAAG,KAAK,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAAA,MAC/E;AAAA,IACF,CAAC;AACD,QAAI,KAAK,GAAI,UAAU,eAAe,CAAC,CAAE;AAAA,EAC3C;AACA,SAAO;AACT;AA6BA,eAAsB,gBACpB,QACA,WACA,SACA,SAC0B;AAC1B,QAAM,OAAO,IAAI,IAAI,UAAU,IAAI,CAAC,QAAQ,CAAC,IAAI,aAAa,GAAG,CAAC,CAAC;AACnE,QAAM,WAA+B,CAAC;AACtC,QAAM,cAAkC,CAAC;AACzC,QAAM,QAAsB,CAAC;AAC7B,aAAW,OAAO,QAAQ,MAAM,QAAQ,CAAC,OAAO,KAAK,IAAI,EAAE,KAAK,CAAC,CAAC,GAAG;AACnE,UAAM,QAAQ,MAAM,mBAAmB,QAAQ,GAAG;AAClD,QAAI,CAAC,OAAO;AACV,kBAAY,KAAK,GAAG;AACpB;AAAA,IACF;AACA,aAAS,KAAK,GAAG;AACjB,UAAM,KAAK;AAAA,MACT,MAAM,uBAAuB,GAAG;AAAA,MAChC,YAAY,IAAI;AAAA,MAChB;AAAA,MACA,OAAO,QAAQ,YAAY,IAAI,WAAW;AAAA,IAC5C,CAAC;AAAA,EACH;AACA,MAAI,MAAM,WAAW,GAAG;AACtB,UAAM,IAAI,MAAM,0DAA0D;AAAA,EAC5E;AAEA,QAAM,EAAE,YAAY,IAAI,MAAM,OAAO,8BAA8B;AACnE,QAAM,SAAS,MAAM,YAAY,OAAO;AAAA,IACtC,QAAQ,QAAQ;AAAA,IAChB,OAAO;AAAA,MACL,QAAQ,QAAQ;AAAA,MAChB,OAAO,QAAQ;AAAA,MACf,QAAQ,QAAQ;AAAA,MAChB,QAAQ,QAAQ;AAAA,IAClB;AAAA,IACA,IAAI,QAAQ;AAAA;AAAA,IAEZ,UAAU,QAAQ,OAAO,SAAS,MAAM,IAAI,iBAAiB;AAAA,IAC7D,WAAW,QAAQ;AAAA,IACnB,QAAQ,QAAQ;AAAA,IAChB,YAAY,QAAQ;AAAA,EACtB,CAAC;AAED,QAAM,QAAQ;AAAA,IACZ,OAAO,MAAM,CAAC,EAAE;AAAA,IAChB,OAAO,MAAM,OAAO,MAAM,SAAS,CAAC,EAAE;AAAA,EACxC;AACA,QAAM,SAAS,QAAQ,WAAW;AAElC,QAAM,QAAQ,SAAS,CAAC,EAAE,GAAG,OAAO,MAAM,CAAC,GAAG,MAAM,GAAG,KAAK,OAAO,CAAC,IAAI,OAAO;AAC/E,QAAM,WAAW,IAAI,IAAI,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,KAAK,IAAI,EAAE,UAAU,CAAE,CAAC,CAAC;AACnF,QAAM,UAAU,MAAM,IAAI,CAAC,UAAU;AAAA,IACnC,MAAM,SAAS,KAAK,OAAO,mBAAmB,MAAM,KAAK;AAAA,IACzD,OAAO,KAAK;AAAA;AAAA;AAAA,IAGZ,SAAS,UAAU,CAAC,SAAS,IAAI,KAAK,IAAI,IAAI,WAAW,CAAC,SAAS,IAAI,KAAK,IAAI,CAAE;AAAA,EACpF,EAAE;AACF,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA,OAAO,OAAO;AAAA,IACd;AAAA,IACA;AAAA,IACA;AAAA,IACA,QAAQ,iBAAiB,OAAO,MAAM;AAAA,EACxC;AACF;",
+  "names": []
+}

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