@arbidocs/react 0.5.111 → 0.5.113

package/dist/document-tools/document-pdf.js

@@ -0,0 +1,76 @@
+import { parseVersionRef } from "../artifacts/versions.js";
+class DocumentFetchError extends Error {
+  status;
+  constructor(message, status) {
+    super(message);
+    this.name = "DocumentFetchError";
+    this.status = status;
+  }
+}
+async function fetchDocumentBytes(client, endpoint, documentRef, options, headers, what) {
+  const ref = parseVersionRef(documentRef);
+  const version = options.version ?? ref.version;
+  const { data, response } = await client.GET(endpoint, {
+    params: {
+      path: { document_ext_id: ref.docId },
+      query: {
+        ...version ? { version } : {},
+        ...options.workspaceExtId ? { workspace_ext_id: options.workspaceExtId } : {}
+      }
+    },
+    headers,
+    parseAs: "blob",
+    signal: options.signal
+  });
+  if (!response.ok || !(data instanceof Blob)) {
+    throw new DocumentFetchError(
+      `${what} could not be loaded (${response.status})`,
+      response.status
+    );
+  }
+  return { blob: data, response };
+}
+function contentDispositionFileName(header) {
+  if (!header) return void 0;
+  const extended = /filename\*\s*=\s*(?:[\w-]+)?'[^']*'([^;]+)/i.exec(header);
+  if (extended) {
+    try {
+      return decodeURIComponent(extended[1].trim().replace(/^"|"$/g, "")) || void 0;
+    } catch {
+    }
+  }
+  const plain = /filename\s*=\s*("((?:[^"\\]|\\.)*)"|[^;]+)/i.exec(header);
+  if (!plain) return void 0;
+  const name = plain[2] !== void 0 ? plain[2].replace(/\\(.)/g, "$1") : plain[1].trim();
+  return name || void 0;
+}
+async function fetchDocumentPdf(client, documentRef, options = {}) {
+  const { blob } = await fetchDocumentBytes(
+    client,
+    "/v1/document/{document_ext_id}/view",
+    documentRef,
+    options,
+    { Accept: "application/pdf" },
+    "The PDF"
+  );
+  return blob;
+}
+async function fetchDocumentFile(client, documentRef, options = {}) {
+  const { blob, response } = await fetchDocumentBytes(
+    client,
+    "/v1/document/{document_ext_id}/download",
+    documentRef,
+    options,
+    {},
+    "The file"
+  );
+  const name = contentDispositionFileName(response.headers.get("Content-Disposition"));
+  return name ? new File([blob], name, { type: blob.type }) : blob;
+}
+export {
+  DocumentFetchError,
+  contentDispositionFileName,
+  fetchDocumentFile,
+  fetchDocumentPdf
+};
+//# sourceMappingURL=document-pdf.js.map

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

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/document-tools/document-pdf.ts"],
+  "sourcesContent": ["/**\n * A document's bytes, through the host's API client: the PDF the viewer and the tools draw on\n * (`/view`: the file itself for a PDF, its PDF rendering for a Word or text file) and the stored\n * file (`/download`). Either takes a document id or a version reference `doc-\u2026@v{n}`.\n */\n\nimport { parseVersionRef } from '../artifacts/versions'\nimport type { DocumentToolsClient } from './environment'\n\nexport interface DocumentFetchOptions {\n  /** The version to fetch. Default: the one `documentRef` names, else the current version. */\n  version?: number | null\n  workspaceExtId?: string\n  signal?: AbortSignal\n}\n\n/** A document's bytes could not be fetched; `status` is the HTTP status. */\nexport class DocumentFetchError extends Error {\n  readonly status: number\n  constructor(message: string, status: number) {\n    super(message)\n    this.name = 'DocumentFetchError'\n    this.status = status\n  }\n}\n\nasync function fetchDocumentBytes(\n  client: DocumentToolsClient,\n  endpoint: '/v1/document/{document_ext_id}/view' | '/v1/document/{document_ext_id}/download',\n  documentRef: string,\n  options: DocumentFetchOptions,\n  headers: Record<string, string>,\n  what: string\n): Promise<{ blob: Blob; response: Response }> {\n  const ref = parseVersionRef(documentRef)\n  const version = options.version ?? ref.version\n  const { data, response } = await client.GET(endpoint, {\n    params: {\n      path: { document_ext_id: ref.docId },\n      query: {\n        ...(version ? { version } : {}),\n        ...(options.workspaceExtId ? { workspace_ext_id: options.workspaceExtId } : {}),\n      },\n    },\n    headers,\n    parseAs: 'blob',\n    signal: options.signal,\n  })\n  if (!response.ok || !(data instanceof Blob)) {\n    throw new DocumentFetchError(\n      `${what} could not be loaded (${response.status})`,\n      response.status\n    )\n  }\n  return { blob: data, response }\n}\n\n/**\n * The file name a `Content-Disposition` header gives, or `undefined`. Prefers the RFC 5987\n * `filename*=UTF-8''\u2026` form (percent-encoded, any script) over the plain `filename=`.\n */\nexport function contentDispositionFileName(header: string | null | undefined): string | undefined {\n  if (!header) return undefined\n  const extended = /filename\\*\\s*=\\s*(?:[\\w-]+)?'[^']*'([^;]+)/i.exec(header)\n  if (extended) {\n    try {\n      return decodeURIComponent(extended[1].trim().replace(/^\"|\"$/g, '')) || undefined\n    } catch {\n      // A malformed escape: fall back to the plain parameter.\n    }\n  }\n  const plain = /filename\\s*=\\s*(\"((?:[^\"\\\\]|\\\\.)*)\"|[^;]+)/i.exec(header)\n  if (!plain) return undefined\n  const name = plain[2] !== undefined ? plain[2].replace(/\\\\(.)/g, '$1') : plain[1].trim()\n  return name || undefined\n}\n\n/**\n * The PDF of a document version: `GET /v1/document/{id}/view?version=` with\n * `Accept: application/pdf`. Throws a {@link DocumentFetchError} when there is none (yet).\n */\nexport async function fetchDocumentPdf(\n  client: DocumentToolsClient,\n  documentRef: string,\n  options: DocumentFetchOptions = {}\n): Promise<Blob> {\n  const { blob } = await fetchDocumentBytes(\n    client,\n    '/v1/document/{document_ext_id}/view',\n    documentRef,\n    options,\n    { Accept: 'application/pdf' },\n    'The PDF'\n  )\n  return blob\n}\n\n/**\n * The stored file of a document version, as uploaded: `GET /v1/document/{id}/download`. When the\n * server names the file (`Content-Disposition`), the result is a `File` carrying that name.\n */\nexport async function fetchDocumentFile(\n  client: DocumentToolsClient,\n  documentRef: string,\n  options: DocumentFetchOptions = {}\n): Promise<Blob | File> {\n  const { blob, response } = await fetchDocumentBytes(\n    client,\n    '/v1/document/{document_ext_id}/download',\n    documentRef,\n    options,\n    {},\n    'The file'\n  )\n  const name = contentDispositionFileName(response.headers.get('Content-Disposition'))\n  return name ? new File([blob], name, { type: blob.type }) : blob\n}\n"],
+  "mappings": "AAMA,SAAS,uBAAuB;AAWzB,MAAM,2BAA2B,MAAM;AAAA,EACnC;AAAA,EACT,YAAY,SAAiB,QAAgB;AAC3C,UAAM,OAAO;AACb,SAAK,OAAO;AACZ,SAAK,SAAS;AAAA,EAChB;AACF;AAEA,eAAe,mBACb,QACA,UACA,aACA,SACA,SACA,MAC6C;AAC7C,QAAM,MAAM,gBAAgB,WAAW;AACvC,QAAM,UAAU,QAAQ,WAAW,IAAI;AACvC,QAAM,EAAE,MAAM,SAAS,IAAI,MAAM,OAAO,IAAI,UAAU;AAAA,IACpD,QAAQ;AAAA,MACN,MAAM,EAAE,iBAAiB,IAAI,MAAM;AAAA,MACnC,OAAO;AAAA,QACL,GAAI,UAAU,EAAE,QAAQ,IAAI,CAAC;AAAA,QAC7B,GAAI,QAAQ,iBAAiB,EAAE,kBAAkB,QAAQ,eAAe,IAAI,CAAC;AAAA,MAC/E;AAAA,IACF;AAAA,IACA;AAAA,IACA,SAAS;AAAA,IACT,QAAQ,QAAQ;AAAA,EAClB,CAAC;AACD,MAAI,CAAC,SAAS,MAAM,EAAE,gBAAgB,OAAO;AAC3C,UAAM,IAAI;AAAA,MACR,GAAG,IAAI,yBAAyB,SAAS,MAAM;AAAA,MAC/C,SAAS;AAAA,IACX;AAAA,EACF;AACA,SAAO,EAAE,MAAM,MAAM,SAAS;AAChC;AAMO,SAAS,2BAA2B,QAAuD;AAChG,MAAI,CAAC,OAAQ,QAAO;AACpB,QAAM,WAAW,8CAA8C,KAAK,MAAM;AAC1E,MAAI,UAAU;AACZ,QAAI;AACF,aAAO,mBAAmB,SAAS,CAAC,EAAE,KAAK,EAAE,QAAQ,UAAU,EAAE,CAAC,KAAK;AAAA,IACzE,QAAQ;AAAA,IAER;AAAA,EACF;AACA,QAAM,QAAQ,8CAA8C,KAAK,MAAM;AACvE,MAAI,CAAC,MAAO,QAAO;AACnB,QAAM,OAAO,MAAM,CAAC,MAAM,SAAY,MAAM,CAAC,EAAE,QAAQ,UAAU,IAAI,IAAI,MAAM,CAAC,EAAE,KAAK;AACvF,SAAO,QAAQ;AACjB;AAMA,eAAsB,iBACpB,QACA,aACA,UAAgC,CAAC,GAClB;AACf,QAAM,EAAE,KAAK,IAAI,MAAM;AAAA,IACrB;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,EAAE,QAAQ,kBAAkB;AAAA,IAC5B;AAAA,EACF;AACA,SAAO;AACT;AAMA,eAAsB,kBACpB,QACA,aACA,UAAgC,CAAC,GACX;AACtB,QAAM,EAAE,MAAM,SAAS,IAAI,MAAM;AAAA,IAC/B;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,CAAC;AAAA,IACD;AAAA,EACF;AACA,QAAM,OAAO,2BAA2B,SAAS,QAAQ,IAAI,qBAAqB,CAAC;AACnF,SAAO,OAAO,IAAI,KAAK,CAAC,IAAI,GAAG,MAAM,EAAE,MAAM,KAAK,KAAK,CAAC,IAAI;AAC9D;",
+  "names": []
+}

package/dist/document-tools/environment.js

@@ -0,0 +1,136 @@
+import { jsx } from "react/jsx-runtime";
+import { createContext, useCallback, useContext, useMemo, useRef } from "react";
+import { useDeploymentDomain } from "../useArbi.js";
+function uploadQueryString(query) {
+  const params = new URLSearchParams();
+  for (const [key, value] of Object.entries(query)) {
+    if (value === null || value === void 0) continue;
+    for (const item of Array.isArray(value) ? value : [value]) params.append(key, String(item));
+  }
+  return params.toString();
+}
+function downloadBlob(blob, fileName) {
+  const url = URL.createObjectURL(blob);
+  const a = document.createElement("a");
+  a.href = url;
+  a.download = fileName;
+  document.body.appendChild(a);
+  a.click();
+  a.remove();
+  setTimeout(() => URL.revokeObjectURL(url), 6e4);
+}
+function clientUpload(client) {
+  return async ({ file, query }) => {
+    const formData = new FormData();
+    formData.append("files", file);
+    const { data, response } = await client.POST("/v1/document/upload", {
+      params: { query },
+      // The schema types the multipart body as `{ files: string[] }`; the FormData is sent as is.
+      body: formData,
+      bodySerializer: () => formData
+    });
+    if (!response.ok) throw new Error(`Upload failed with status ${response.status}`);
+    return data;
+  };
+}
+function defaultCertificateUrl(reference) {
+  const origin = typeof location === "undefined" ? "" : location.origin;
+  return `${origin}/verify/${encodeURIComponent(reference)}`;
+}
+function certificateLink(signature, certificateUrl) {
+  if (certificateUrl) return certificateUrl(signature.reference);
+  return signature.certificate_url || defaultCertificateUrl(signature.reference);
+}
+const DocumentToolsContext = createContext(null);
+function DocumentToolsProvider({ children, ...env }) {
+  const arbiDeploymentDomain = useDeploymentDomain();
+  const guards = useRef(/* @__PURE__ */ new Map());
+  const pendingFlushes = useRef(/* @__PURE__ */ new Map());
+  const registerBeforeFileShare = useCallback((id, flush) => {
+    guards.current.set(id, flush);
+    return () => {
+      if (guards.current.get(id) !== flush) return;
+      guards.current.delete(id);
+      const pending = flush();
+      pendingFlushes.current.set(id, pending);
+      void pending.then(
+        () => {
+          if (pendingFlushes.current.get(id) === pending) pendingFlushes.current.delete(id);
+        },
+        () => {
+        }
+      );
+    };
+  }, []);
+  const prepareFileShare = useCallback(async (id) => {
+    const guard = guards.current.get(id);
+    if (guard) {
+      await guard();
+      pendingFlushes.current.delete(id);
+    } else await pendingFlushes.current.get(id);
+  }, []);
+  const {
+    client,
+    deploymentDomain,
+    user,
+    notify,
+    openDocument,
+    onDocumentsChanged,
+    uploadDocument,
+    saveFile,
+    emailDocument,
+    certificateUrl
+  } = env;
+  const value = useMemo(
+    () => ({
+      client,
+      prepareFileShare,
+      registerBeforeFileShare,
+      deploymentDomain: deploymentDomain ?? arbiDeploymentDomain,
+      user,
+      openDocument,
+      onDocumentsChanged,
+      emailDocument,
+      notify: notify ?? (() => {
+      }),
+      saveFile: saveFile ?? downloadBlob,
+      uploadDocument: uploadDocument ?? clientUpload(client),
+      certificateUrl
+    }),
+    [
+      client,
+      prepareFileShare,
+      registerBeforeFileShare,
+      deploymentDomain,
+      arbiDeploymentDomain,
+      user,
+      notify,
+      openDocument,
+      onDocumentsChanged,
+      uploadDocument,
+      saveFile,
+      emailDocument,
+      certificateUrl
+    ]
+  );
+  return /* @__PURE__ */ jsx(DocumentToolsContext.Provider, { value, children });
+}
+function useOptionalDocumentTools() {
+  return useContext(DocumentToolsContext);
+}
+function useDocumentTools() {
+  const env = useContext(DocumentToolsContext);
+  if (!env) throw new Error("The document tools must be used within a <DocumentToolsProvider>");
+  return env;
+}
+export {
+  DocumentToolsProvider,
+  certificateLink,
+  clientUpload,
+  defaultCertificateUrl,
+  downloadBlob,
+  uploadQueryString,
+  useDocumentTools,
+  useOptionalDocumentTools
+};
+//# sourceMappingURL=environment.js.map

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

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/document-tools/environment.tsx"],
+  "sourcesContent": ["/**\n * The host app's side of the document tools (markup, freeze, e-signing, versions): the one place\n * the tools reach the app. They never import a store, a router, a toast library or app API code;\n * the host passes what it has to `<DocumentToolsProvider>` and every optional field has a default.\n *\n * `client` is an openapi-fetch client for the ARBI API (`ArbiClient['fetch']` from\n * `@arbidocs/client`, or `arbi.getClient().fetch` from an `@arbidocs/sdk` `Arbi`), signed in with the\n * user's session; it carries the auth.\n */\n\nimport { createContext, useCallback, useContext, useMemo, useRef, type ReactNode } from 'react'\nimport type { ArbiClient, operations } from '@arbidocs/client'\nimport { useDeploymentDomain } from '../useArbi'\n\nexport type DocumentToolsClient = ArbiClient['fetch']\n\nexport type DocumentToolsNoticeKind = 'success' | 'error' | 'info' | 'warning'\n\nexport interface DocumentToolsNoticeOptions {\n  /** A second line under the message. */\n  description?: string\n  /** One action button on the notice (\"Email it\"). */\n  action?: { label: string; onClick: () => void }\n}\n\nexport type DocumentToolsNotify = (\n  message: string,\n  kind: DocumentToolsNoticeKind,\n  options?: DocumentToolsNoticeOptions\n) => void\n\nexport interface DocumentToolsUser {\n  /** The name marks are authored as and the signer's name is prefilled with. */\n  name: string\n  /** The sign-in email: signing re-derives the user's key from it and the password. */\n  email?: string | null\n  /** The user's id (usr-*): which fields of a signature request are theirs. */\n  externalId?: string | null\n}\n\n/** What changed about a document, so the host can refresh its own lists and caches. */\nexport type DocumentChange =\n  /** A version's markup got its first mark or lost its last one. */\n  | 'markup'\n  /** A signature was added: the document has a new current version. */\n  | 'signed'\n  /** A new document was made from it (a frozen copy). The ids are the NEW documents. */\n  | 'copy'\n  /** A new version was saved (the Word editor's Save version): the document's current version. */\n  | 'version'\n\n/**\n * The `/v1/document/upload` query, typed from the API schema: `derived_from` is a list (a\n * production set is derived from every document in it), `shared` a boolean.\n */\nexport type DocumentUploadQuery = NonNullable<operations['upload_documents']['parameters']['query']>\n\nexport interface DocumentUploadRequest {\n  file: File\n  /** `/v1/document/upload` query: `derived_from`, `derived_role`, `shared`, `folder`. */\n  query: DocumentUploadQuery\n}\n\n/**\n * The upload query as a URL query string, for a host that posts the upload itself (an XHR with\n * progress): a list repeats its key (`derived_from=a&derived_from=b`), empty values are left out.\n */\nexport function uploadQueryString(query: DocumentUploadQuery): string {\n  const params = new URLSearchParams()\n  for (const [key, value] of Object.entries(query)) {\n    if (value === null || value === undefined) continue\n    for (const item of Array.isArray(value) ? value : [value]) params.append(key, String(item))\n  }\n  return params.toString()\n}\n\nexport interface DocumentToolsEnvironment {\n  client: DocumentToolsClient\n  /**\n   * The deployment domain the user's keys are derived for. Needed for signing. Default: the one\n   * the host's `Arbi` computes (`arbi.getDeploymentDomain()`), if any.\n   */\n  deploymentDomain?: string\n  /** The signed-in user; marks are authored as \"You\" without one, and signing is unavailable. */\n  user?: DocumentToolsUser | null\n  /** Surface a transient message. Default: none (errors still show inline where they can). */\n  notify?: DocumentToolsNotify\n  /** Open a document or a version reference (`doc-\u2026@v2`): the copy just made, the signed copy. */\n  openDocument?: (documentRef: string) => void\n  /**\n   * Documents changed on the server (see {@link DocumentChange}); refresh the host's lists. The\n   * tools wait for it before opening the document, so a copy is listed when it opens.\n   */\n  onDocumentsChanged?: (documentIds: string[], change: DocumentChange) => void | Promise<void>\n  /** Upload a derived copy. Default: `POST /v1/document/upload` through `client`. */\n  uploadDocument?: (\n    request: DocumentUploadRequest\n  ) => Promise<{ doc_ext_ids?: string[] } | undefined>\n  /** Save a file to the user's computer. Default: a temporary download link. */\n  saveFile?: (blob: Blob, fileName: string) => void\n  /** Email a document (offered once it is signed). Omitted: no \"Email it\". */\n  emailDocument?: (documentRef: string) => void\n  /**\n   * The public page that checks a signature (the certificate) in this app. When given, \"View\n   * certificate\" opens it in preference to the backend's `certificate_url` (which is on the\n   * deployment domain, like the link embedded in the signed PDF). Without it: the backend's\n   * `certificate_url`, else `/verify/{reference}` on this origin.\n   */\n  certificateUrl?: (reference: string) => string\n}\n\n/** The environment with every default filled in. */\nexport interface ResolvedDocumentToolsEnvironment extends DocumentToolsEnvironment {\n  prepareFileShare: (documentId: string) => Promise<void>\n  registerBeforeFileShare: (documentId: string, flush: () => Promise<void>) => () => void\n  notify: DocumentToolsNotify\n  saveFile: (blob: Blob, fileName: string) => void\n  uploadDocument: (\n    request: DocumentUploadRequest\n  ) => Promise<{ doc_ext_ids?: string[] } | undefined>\n}\n\n/**\n * Save a blob through a temporary `<a download>`. The object URL is revoked a minute later, not at\n * once: revoking straight after `click()` can cancel the download (Safari, and large files\n * elsewhere) before the browser has read the blob.\n */\nexport function downloadBlob(blob: Blob, fileName: string): void {\n  const url = URL.createObjectURL(blob)\n  const a = document.createElement('a')\n  a.href = url\n  a.download = fileName\n  document.body.appendChild(a)\n  a.click()\n  a.remove()\n  setTimeout(() => URL.revokeObjectURL(url), 60_000)\n}\n\n/** The default upload: multipart `files` to `/v1/document/upload` through the API client. */\nexport function clientUpload(client: DocumentToolsClient) {\n  return async ({ file, query }: DocumentUploadRequest) => {\n    const formData = new FormData()\n    formData.append('files', file)\n    const { data, response } = await client.POST('/v1/document/upload', {\n      params: { query },\n      // The schema types the multipart body as `{ files: string[] }`; the FormData is sent as is.\n      body: formData as unknown as { files: string[] },\n      bodySerializer: () => formData,\n    })\n    if (!response.ok) throw new Error(`Upload failed with status ${response.status}`)\n    return data\n  }\n}\n\nexport function defaultCertificateUrl(reference: string): string {\n  const origin = typeof location === 'undefined' ? '' : location.origin\n  return `${origin}/verify/${encodeURIComponent(reference)}`\n}\n\n/**\n * Where \"View certificate\" goes for a signature: the host's `certificateUrl(reference)` when it\n * gives one, else the `certificate_url` the backend returned, else `/verify/{reference}` here.\n */\nexport function certificateLink(\n  signature: { reference: string; certificate_url?: string | null },\n  certificateUrl?: (reference: string) => string\n): string {\n  if (certificateUrl) return certificateUrl(signature.reference)\n  return signature.certificate_url || defaultCertificateUrl(signature.reference)\n}\n\nconst DocumentToolsContext = createContext<ResolvedDocumentToolsEnvironment | null>(null)\n\nexport interface DocumentToolsProviderProps extends DocumentToolsEnvironment {\n  children: ReactNode\n}\n\nexport function DocumentToolsProvider({ children, ...env }: DocumentToolsProviderProps) {\n  const arbiDeploymentDomain = useDeploymentDomain()\n  const guards = useRef(new Map<string, () => Promise<void>>())\n  const pendingFlushes = useRef(new Map<string, Promise<void>>())\n  const registerBeforeFileShare = useCallback((id: string, flush: () => Promise<void>) => {\n    guards.current.set(id, flush)\n    return () => {\n      if (guards.current.get(id) !== flush) return\n      guards.current.delete(id)\n      const pending = flush()\n      pendingFlushes.current.set(id, pending)\n      void pending.then(\n        () => {\n          if (pendingFlushes.current.get(id) === pending) pendingFlushes.current.delete(id)\n        },\n        () => {}\n      )\n    }\n  }, [])\n  const prepareFileShare = useCallback(async (id: string) => {\n    const guard = guards.current.get(id)\n    if (guard) {\n      await guard()\n      pendingFlushes.current.delete(id)\n    } else await pendingFlushes.current.get(id)\n  }, [])\n  const {\n    client,\n    deploymentDomain,\n    user,\n    notify,\n    openDocument,\n    onDocumentsChanged,\n    uploadDocument,\n    saveFile,\n    emailDocument,\n    certificateUrl,\n  } = env\n  const value = useMemo<ResolvedDocumentToolsEnvironment>(\n    () => ({\n      client,\n      prepareFileShare,\n      registerBeforeFileShare,\n      deploymentDomain: deploymentDomain ?? arbiDeploymentDomain,\n      user,\n      openDocument,\n      onDocumentsChanged,\n      emailDocument,\n      notify: notify ?? (() => {}),\n      saveFile: saveFile ?? downloadBlob,\n      uploadDocument: uploadDocument ?? clientUpload(client),\n      certificateUrl,\n    }),\n    [\n      client,\n      prepareFileShare,\n      registerBeforeFileShare,\n      deploymentDomain,\n      arbiDeploymentDomain,\n      user,\n      notify,\n      openDocument,\n      onDocumentsChanged,\n      uploadDocument,\n      saveFile,\n      emailDocument,\n      certificateUrl,\n    ]\n  )\n  return <DocumentToolsContext.Provider value={value}>{children}</DocumentToolsContext.Provider>\n}\n\n/** The host's environment, or `null` outside a `<DocumentToolsProvider>`. */\nexport function useOptionalDocumentTools(): ResolvedDocumentToolsEnvironment | null {\n  return useContext(DocumentToolsContext)\n}\n\n/** The host's environment; throws outside a `<DocumentToolsProvider>`. */\nexport function useDocumentTools(): ResolvedDocumentToolsEnvironment {\n  const env = useContext(DocumentToolsContext)\n  if (!env) throw new Error('The document tools must be used within a <DocumentToolsProvider>')\n  return env\n}\n"],
+  "mappings": "AAsPS;AA5OT,SAAS,eAAe,aAAa,YAAY,SAAS,cAA8B;AAExF,SAAS,2BAA2B;AAuD7B,SAAS,kBAAkB,OAAoC;AACpE,QAAM,SAAS,IAAI,gBAAgB;AACnC,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,KAAK,GAAG;AAChD,QAAI,UAAU,QAAQ,UAAU,OAAW;AAC3C,eAAW,QAAQ,MAAM,QAAQ,KAAK,IAAI,QAAQ,CAAC,KAAK,EAAG,QAAO,OAAO,KAAK,OAAO,IAAI,CAAC;AAAA,EAC5F;AACA,SAAO,OAAO,SAAS;AACzB;AAqDO,SAAS,aAAa,MAAY,UAAwB;AAC/D,QAAM,MAAM,IAAI,gBAAgB,IAAI;AACpC,QAAM,IAAI,SAAS,cAAc,GAAG;AACpC,IAAE,OAAO;AACT,IAAE,WAAW;AACb,WAAS,KAAK,YAAY,CAAC;AAC3B,IAAE,MAAM;AACR,IAAE,OAAO;AACT,aAAW,MAAM,IAAI,gBAAgB,GAAG,GAAG,GAAM;AACnD;AAGO,SAAS,aAAa,QAA6B;AACxD,SAAO,OAAO,EAAE,MAAM,MAAM,MAA6B;AACvD,UAAM,WAAW,IAAI,SAAS;AAC9B,aAAS,OAAO,SAAS,IAAI;AAC7B,UAAM,EAAE,MAAM,SAAS,IAAI,MAAM,OAAO,KAAK,uBAAuB;AAAA,MAClE,QAAQ,EAAE,MAAM;AAAA;AAAA,MAEhB,MAAM;AAAA,MACN,gBAAgB,MAAM;AAAA,IACxB,CAAC;AACD,QAAI,CAAC,SAAS,GAAI,OAAM,IAAI,MAAM,6BAA6B,SAAS,MAAM,EAAE;AAChF,WAAO;AAAA,EACT;AACF;AAEO,SAAS,sBAAsB,WAA2B;AAC/D,QAAM,SAAS,OAAO,aAAa,cAAc,KAAK,SAAS;AAC/D,SAAO,GAAG,MAAM,WAAW,mBAAmB,SAAS,CAAC;AAC1D;AAMO,SAAS,gBACd,WACA,gBACQ;AACR,MAAI,eAAgB,QAAO,eAAe,UAAU,SAAS;AAC7D,SAAO,UAAU,mBAAmB,sBAAsB,UAAU,SAAS;AAC/E;AAEA,MAAM,uBAAuB,cAAuD,IAAI;AAMjF,SAAS,sBAAsB,EAAE,UAAU,GAAG,IAAI,GAA+B;AACtF,QAAM,uBAAuB,oBAAoB;AACjD,QAAM,SAAS,OAAO,oBAAI,IAAiC,CAAC;AAC5D,QAAM,iBAAiB,OAAO,oBAAI,IAA2B,CAAC;AAC9D,QAAM,0BAA0B,YAAY,CAAC,IAAY,UAA+B;AACtF,WAAO,QAAQ,IAAI,IAAI,KAAK;AAC5B,WAAO,MAAM;AACX,UAAI,OAAO,QAAQ,IAAI,EAAE,MAAM,MAAO;AACtC,aAAO,QAAQ,OAAO,EAAE;AACxB,YAAM,UAAU,MAAM;AACtB,qBAAe,QAAQ,IAAI,IAAI,OAAO;AACtC,WAAK,QAAQ;AAAA,QACX,MAAM;AACJ,cAAI,eAAe,QAAQ,IAAI,EAAE,MAAM,QAAS,gBAAe,QAAQ,OAAO,EAAE;AAAA,QAClF;AAAA,QACA,MAAM;AAAA,QAAC;AAAA,MACT;AAAA,IACF;AAAA,EACF,GAAG,CAAC,CAAC;AACL,QAAM,mBAAmB,YAAY,OAAO,OAAe;AACzD,UAAM,QAAQ,OAAO,QAAQ,IAAI,EAAE;AACnC,QAAI,OAAO;AACT,YAAM,MAAM;AACZ,qBAAe,QAAQ,OAAO,EAAE;AAAA,IAClC,MAAO,OAAM,eAAe,QAAQ,IAAI,EAAE;AAAA,EAC5C,GAAG,CAAC,CAAC;AACL,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,IAAI;AACJ,QAAM,QAAQ;AAAA,IACZ,OAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA;AAAA,MACA,kBAAkB,oBAAoB;AAAA,MACtC;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,QAAQ,WAAW,MAAM;AAAA,MAAC;AAAA,MAC1B,UAAU,YAAY;AAAA,MACtB,gBAAgB,kBAAkB,aAAa,MAAM;AAAA,MACrD;AAAA,IACF;AAAA,IACA;AAAA,MACE;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,EACF;AACA,SAAO,oBAAC,qBAAqB,UAArB,EAA8B,OAAe,UAAS;AAChE;AAGO,SAAS,2BAAoE;AAClF,SAAO,WAAW,oBAAoB;AACxC;AAGO,SAAS,mBAAqD;AACnE,QAAM,MAAM,WAAW,oBAAoB;AAC3C,MAAI,CAAC,IAAK,OAAM,IAAI,MAAM,kEAAkE;AAC5F,SAAO;AACT;",
+  "names": []
+}

package/dist/document-tools/file-shares.js

@@ -0,0 +1,112 @@
+import { useQuery } from "@tanstack/react-query";
+import { arbiQueryKeys } from "../query-keys.js";
+import { signMessage, unlockIdentityWithPassword } from "@arbidocs/client";
+import { intentText, sha256Hex } from "./signing.js";
+function failure(error) {
+  const detail = error?.detail;
+  return new Error(typeof detail === "string" ? detail : "The shared file request failed");
+}
+async function createFileShare(client, documentId, body) {
+  const result = await client.POST("/v1/document/{document_ext_id}/file-shares", {
+    params: { path: { document_ext_id: documentId } },
+    body
+  });
+  if (!result.data) throw failure(result.error);
+  return result.data;
+}
+async function getFileShare(client, id) {
+  const result = await client.GET("/v1/file-shares/{share_id}", {
+    params: { path: { share_id: id } }
+  });
+  if (!result.data) throw failure(result.error);
+  return result.data;
+}
+async function fileShareBytes(client, id, kind) {
+  const result = await client.GET("/v1/file-shares/{share_id}/file", {
+    params: { path: { share_id: id }, query: { kind } },
+    parseAs: "blob"
+  });
+  if (!result.data) throw failure(result.error);
+  return result.data;
+}
+function fileShareSigningRequest(share) {
+  return {
+    external_id: share.external_id,
+    doc_ext_id: share.document_ext_id,
+    version: share.version,
+    source_sha256: share.source_sha256,
+    fields: share.fields,
+    message: share.message,
+    status: share.status === "signing" ? "sent" : share.status === "completed" ? "completed" : "voided",
+    signers: share.recipients.filter((r) => r.permission === "sign").map((r) => ({
+      external_id: r.email,
+      email: r.email,
+      name: r.email,
+      status: r.status === "signed" ? "signed" : "pending",
+      progress: r.status === "signed" ? "signed" : "registered",
+      fields: share.fields.filter((f) => f.signer === r.email).length
+    })),
+    created_at: (/* @__PURE__ */ new Date(0)).toISOString(),
+    stale: false
+  };
+}
+async function signFileShare(client, domain, vars) {
+  const path = { share_id: vars.request.external_id };
+  const body = { adopted: vars.adopted, fields: vars.fields };
+  const prepared = await client.POST("/v1/file-shares/{share_id}/sign/prepare", {
+    params: { path },
+    body
+  });
+  if (!prepared.data) throw failure(prepared.error);
+  const { statement, timestamp, source_sha256, intent } = prepared.data;
+  if (source_sha256 !== vars.request.source_sha256 || await sha256Hex(vars.pdfBlob) !== source_sha256)
+    throw new Error("The shared file changed. Ask the sender for a new request.");
+  if (intent !== intentText({ name: vars.adopted.name }))
+    throw new Error("Signing statement mismatch");
+  const identity = await unlockIdentityWithPassword(vars.email, vars.password, domain);
+  const result = await client.POST("/v1/file-shares/{share_id}/sign", {
+    params: { path },
+    body: { ...body, timestamp, signature: signMessage(statement, identity) }
+  });
+  if (!result.data) throw failure(result.error);
+  return {
+    request: fileShareSigningRequest(result.data),
+    completed: result.data.status === "completed"
+  };
+}
+function useFileShare(client, shareId, signing) {
+  return useQuery({
+    queryKey: arbiQueryKeys.fileShare(shareId),
+    queryFn: () => getFileShare(client, shareId),
+    refetchInterval: signing ? false : 5e3
+  });
+}
+function useFileSharePdf(client, shareId, share) {
+  return useQuery({
+    queryKey: arbiQueryKeys.fileSharePdf(shareId, share?.status),
+    queryFn: () => fileShareBytes(client, shareId, share?.status === "completed" ? "signed" : "view"),
+    enabled: !!share?.can_preview,
+    staleTime: Infinity
+  });
+}
+function useFileShares(client) {
+  return useQuery({
+    queryKey: arbiQueryKeys.fileShares(),
+    queryFn: async () => {
+      const result = await client.GET("/v1/file-shares");
+      if (!result.data) throw new Error("Could not load shared files");
+      return result.data;
+    }
+  });
+}
+export {
+  createFileShare,
+  fileShareBytes,
+  fileShareSigningRequest,
+  getFileShare,
+  signFileShare,
+  useFileShare,
+  useFileSharePdf,
+  useFileShares
+};
+//# sourceMappingURL=file-shares.js.map

package/dist/document-tools/file-shares.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/document-tools/file-shares.ts"],
+  "sourcesContent": ["import { useQuery } from '@tanstack/react-query'\nimport { arbiQueryKeys } from '../query-keys'\n/** Share one immutable file version with named recipients, independently of workspace membership. */\nimport { signMessage, unlockIdentityWithPassword, type components } from '@arbidocs/client'\nimport type { DocumentToolsClient } from './environment'\nimport { intentText, sha256Hex } from './signing'\nimport type {\n  SignatureRequest,\n  SignRequestVars,\n  SignRequestSignResponse,\n} from './signature-requests'\n\nexport type FileShare = components['schemas']['FileShareResponse']\nexport type CreateFileShare = components['schemas']['CreateFileShare']\n\nfunction failure(error: unknown): Error {\n  const detail = (error as { detail?: unknown } | undefined)?.detail\n  return new Error(typeof detail === 'string' ? detail : 'The shared file request failed')\n}\n\nexport async function createFileShare(\n  client: DocumentToolsClient,\n  documentId: string,\n  body: CreateFileShare\n) {\n  const result = await client.POST('/v1/document/{document_ext_id}/file-shares', {\n    params: { path: { document_ext_id: documentId } },\n    body,\n  })\n  if (!result.data) throw failure(result.error)\n  return result.data\n}\n\nexport async function getFileShare(client: DocumentToolsClient, id: string): Promise<FileShare> {\n  const result = await client.GET('/v1/file-shares/{share_id}', {\n    params: { path: { share_id: id } },\n  })\n  if (!result.data) throw failure(result.error)\n  return result.data\n}\n\nexport async function fileShareBytes(\n  client: DocumentToolsClient,\n  id: string,\n  kind: 'view' | 'original' | 'signed'\n) {\n  const result = await client.GET('/v1/file-shares/{share_id}/file', {\n    params: { path: { share_id: id }, query: { kind } },\n    parseAs: 'blob',\n  })\n  if (!result.data) throw failure(result.error)\n  return result.data\n}\n\n/** Adapt only the guided viewer's presentation data; sharing uses its own authorization endpoints. */\nexport function fileShareSigningRequest(share: FileShare): SignatureRequest {\n  return {\n    external_id: share.external_id,\n    doc_ext_id: share.document_ext_id,\n    version: share.version,\n    source_sha256: share.source_sha256,\n    fields: share.fields,\n    message: share.message,\n    status:\n      share.status === 'signing' ? 'sent' : share.status === 'completed' ? 'completed' : 'voided',\n    signers: share.recipients\n      .filter((r) => r.permission === 'sign')\n      .map((r) => ({\n        external_id: r.email,\n        email: r.email,\n        name: r.email,\n        status: r.status === 'signed' ? 'signed' : 'pending',\n        progress: r.status === 'signed' ? 'signed' : 'registered',\n        fields: share.fields.filter((f) => f.signer === r.email).length,\n      })),\n    created_at: new Date(0).toISOString(),\n    stale: false,\n  }\n}\n\nexport async function signFileShare(\n  client: DocumentToolsClient,\n  domain: string,\n  vars: SignRequestVars\n): Promise<SignRequestSignResponse> {\n  const path = { share_id: vars.request.external_id }\n  const body = { adopted: vars.adopted, fields: vars.fields }\n  const prepared = await client.POST('/v1/file-shares/{share_id}/sign/prepare', {\n    params: { path },\n    body,\n  })\n  if (!prepared.data) throw failure(prepared.error)\n  const { statement, timestamp, source_sha256, intent } = prepared.data\n  if (\n    source_sha256 !== vars.request.source_sha256 ||\n    (await sha256Hex(vars.pdfBlob)) !== source_sha256\n  )\n    throw new Error('The shared file changed. Ask the sender for a new request.')\n  if (intent !== intentText({ name: vars.adopted.name }))\n    throw new Error('Signing statement mismatch')\n  const identity = await unlockIdentityWithPassword(vars.email, vars.password, domain)\n  const result = await client.POST('/v1/file-shares/{share_id}/sign', {\n    params: { path },\n    body: { ...body, timestamp, signature: signMessage(statement, identity) },\n  })\n  if (!result.data) throw failure(result.error)\n  return {\n    request: fileShareSigningRequest(result.data),\n    completed: result.data.status === 'completed',\n  }\n}\n\nexport function useFileShare(client: DocumentToolsClient, shareId: string, signing: boolean) {\n  return useQuery({\n    queryKey: arbiQueryKeys.fileShare(shareId),\n    queryFn: () => getFileShare(client, shareId),\n    refetchInterval: signing ? false : 5000,\n  })\n}\n\nexport function useFileSharePdf(client: DocumentToolsClient, shareId: string, share?: FileShare) {\n  return useQuery({\n    queryKey: arbiQueryKeys.fileSharePdf(shareId, share?.status),\n    queryFn: () =>\n      fileShareBytes(client, shareId, share?.status === 'completed' ? 'signed' : 'view'),\n    enabled: !!share?.can_preview,\n    staleTime: Infinity,\n  })\n}\n\nexport function useFileShares(client: DocumentToolsClient) {\n  return useQuery({\n    queryKey: arbiQueryKeys.fileShares(),\n    queryFn: async () => {\n      const result = await client.GET('/v1/file-shares')\n      if (!result.data) throw new Error('Could not load shared files')\n      return result.data\n    },\n  })\n}\n"],
+  "mappings": "AAAA,SAAS,gBAAgB;AACzB,SAAS,qBAAqB;AAE9B,SAAS,aAAa,kCAAmD;AAEzE,SAAS,YAAY,iBAAiB;AAUtC,SAAS,QAAQ,OAAuB;AACtC,QAAM,SAAU,OAA4C;AAC5D,SAAO,IAAI,MAAM,OAAO,WAAW,WAAW,SAAS,gCAAgC;AACzF;AAEA,eAAsB,gBACpB,QACA,YACA,MACA;AACA,QAAM,SAAS,MAAM,OAAO,KAAK,8CAA8C;AAAA,IAC7E,QAAQ,EAAE,MAAM,EAAE,iBAAiB,WAAW,EAAE;AAAA,IAChD;AAAA,EACF,CAAC;AACD,MAAI,CAAC,OAAO,KAAM,OAAM,QAAQ,OAAO,KAAK;AAC5C,SAAO,OAAO;AAChB;AAEA,eAAsB,aAAa,QAA6B,IAAgC;AAC9F,QAAM,SAAS,MAAM,OAAO,IAAI,8BAA8B;AAAA,IAC5D,QAAQ,EAAE,MAAM,EAAE,UAAU,GAAG,EAAE;AAAA,EACnC,CAAC;AACD,MAAI,CAAC,OAAO,KAAM,OAAM,QAAQ,OAAO,KAAK;AAC5C,SAAO,OAAO;AAChB;AAEA,eAAsB,eACpB,QACA,IACA,MACA;AACA,QAAM,SAAS,MAAM,OAAO,IAAI,mCAAmC;AAAA,IACjE,QAAQ,EAAE,MAAM,EAAE,UAAU,GAAG,GAAG,OAAO,EAAE,KAAK,EAAE;AAAA,IAClD,SAAS;AAAA,EACX,CAAC;AACD,MAAI,CAAC,OAAO,KAAM,OAAM,QAAQ,OAAO,KAAK;AAC5C,SAAO,OAAO;AAChB;AAGO,SAAS,wBAAwB,OAAoC;AAC1E,SAAO;AAAA,IACL,aAAa,MAAM;AAAA,IACnB,YAAY,MAAM;AAAA,IAClB,SAAS,MAAM;AAAA,IACf,eAAe,MAAM;AAAA,IACrB,QAAQ,MAAM;AAAA,IACd,SAAS,MAAM;AAAA,IACf,QACE,MAAM,WAAW,YAAY,SAAS,MAAM,WAAW,cAAc,cAAc;AAAA,IACrF,SAAS,MAAM,WACZ,OAAO,CAAC,MAAM,EAAE,eAAe,MAAM,EACrC,IAAI,CAAC,OAAO;AAAA,MACX,aAAa,EAAE;AAAA,MACf,OAAO,EAAE;AAAA,MACT,MAAM,EAAE;AAAA,MACR,QAAQ,EAAE,WAAW,WAAW,WAAW;AAAA,MAC3C,UAAU,EAAE,WAAW,WAAW,WAAW;AAAA,MAC7C,QAAQ,MAAM,OAAO,OAAO,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE;AAAA,IAC3D,EAAE;AAAA,IACJ,aAAY,oBAAI,KAAK,CAAC,GAAE,YAAY;AAAA,IACpC,OAAO;AAAA,EACT;AACF;AAEA,eAAsB,cACpB,QACA,QACA,MACkC;AAClC,QAAM,OAAO,EAAE,UAAU,KAAK,QAAQ,YAAY;AAClD,QAAM,OAAO,EAAE,SAAS,KAAK,SAAS,QAAQ,KAAK,OAAO;AAC1D,QAAM,WAAW,MAAM,OAAO,KAAK,2CAA2C;AAAA,IAC5E,QAAQ,EAAE,KAAK;AAAA,IACf;AAAA,EACF,CAAC;AACD,MAAI,CAAC,SAAS,KAAM,OAAM,QAAQ,SAAS,KAAK;AAChD,QAAM,EAAE,WAAW,WAAW,eAAe,OAAO,IAAI,SAAS;AACjE,MACE,kBAAkB,KAAK,QAAQ,iBAC9B,MAAM,UAAU,KAAK,OAAO,MAAO;AAEpC,UAAM,IAAI,MAAM,4DAA4D;AAC9E,MAAI,WAAW,WAAW,EAAE,MAAM,KAAK,QAAQ,KAAK,CAAC;AACnD,UAAM,IAAI,MAAM,4BAA4B;AAC9C,QAAM,WAAW,MAAM,2BAA2B,KAAK,OAAO,KAAK,UAAU,MAAM;AACnF,QAAM,SAAS,MAAM,OAAO,KAAK,mCAAmC;AAAA,IAClE,QAAQ,EAAE,KAAK;AAAA,IACf,MAAM,EAAE,GAAG,MAAM,WAAW,WAAW,YAAY,WAAW,QAAQ,EAAE;AAAA,EAC1E,CAAC;AACD,MAAI,CAAC,OAAO,KAAM,OAAM,QAAQ,OAAO,KAAK;AAC5C,SAAO;AAAA,IACL,SAAS,wBAAwB,OAAO,IAAI;AAAA,IAC5C,WAAW,OAAO,KAAK,WAAW;AAAA,EACpC;AACF;AAEO,SAAS,aAAa,QAA6B,SAAiB,SAAkB;AAC3F,SAAO,SAAS;AAAA,IACd,UAAU,cAAc,UAAU,OAAO;AAAA,IACzC,SAAS,MAAM,aAAa,QAAQ,OAAO;AAAA,IAC3C,iBAAiB,UAAU,QAAQ;AAAA,EACrC,CAAC;AACH;AAEO,SAAS,gBAAgB,QAA6B,SAAiB,OAAmB;AAC/F,SAAO,SAAS;AAAA,IACd,UAAU,cAAc,aAAa,SAAS,OAAO,MAAM;AAAA,IAC3D,SAAS,MACP,eAAe,QAAQ,SAAS,OAAO,WAAW,cAAc,WAAW,MAAM;AAAA,IACnF,SAAS,CAAC,CAAC,OAAO;AAAA,IAClB,WAAW;AAAA,EACb,CAAC;AACH;AAEO,SAAS,cAAc,QAA6B;AACzD,SAAO,SAAS;AAAA,IACd,UAAU,cAAc,WAAW;AAAA,IACnC,SAAS,YAAY;AACnB,YAAM,SAAS,MAAM,OAAO,IAAI,iBAAiB;AACjD,UAAI,CAAC,OAAO,KAAM,OAAM,IAAI,MAAM,6BAA6B;AAC/D,aAAO,OAAO;AAAA,IAChB;AAAA,EACF,CAAC;AACH;",
+  "names": []
+}

package/dist/document-tools/frozen-copy.js

@@ -0,0 +1,27 @@
+const baseName = (fileName) => (fileName || "document").replace(/\.pdf$/i, "");
+function frozenCopyName(fileName, redacted) {
+  return `${baseName(fileName)} (${redacted ? "redacted" : "annotated"}).pdf`;
+}
+function redactionLogName(fileName) {
+  return `${baseName(fileName)} (redaction log).csv`;
+}
+async function uploadFrozenCopy(upload, bytes, source, redacted) {
+  const file = new File([bytes], frozenCopyName(source.fileName, redacted), {
+    type: "application/pdf"
+  });
+  const query = {
+    derived_from: [source.documentId],
+    derived_role: redacted ? "redaction" : "annotated",
+    shared: source.shared
+  };
+  if (source.folder) query.folder = source.folder;
+  if (source.workspaceId) query.workspace_ext_id = source.workspaceId;
+  const response = await upload({ file, query });
+  return response?.doc_ext_ids?.[0];
+}
+export {
+  frozenCopyName,
+  redactionLogName,
+  uploadFrozenCopy
+};
+//# sourceMappingURL=frozen-copy.js.map

package/dist/document-tools/frozen-copy.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/document-tools/frozen-copy.ts"],
+  "sourcesContent": ["/**\n * Saving a frozen copy: a SEPARATE document derived from the version it was frozen from\n * (`derived_from`, role `redaction` or `annotated`), never a new version of it. The original keeps\n * its place in every list and stays the current version; the copy sits beside it, in the same\n * folder and with the same workspace sharing.\n */\n\nimport type { DocumentToolsEnvironment, DocumentUploadQuery } from './environment'\n\nexport interface FrozenCopySource {\n  /** The version on screen, which the copy is derived from. */\n  documentId: string\n  fileName: string | null | undefined\n  shared: boolean\n  folder?: string | null\n  /**\n   * The original's workspace, where the copy goes: named on the upload, so it never lands in\n   * whichever workspace the session has open (the server refuses one whose key it lacks).\n   */\n  workspaceId?: string | null\n}\n\nconst baseName = (fileName: string | null | undefined) =>\n  (fileName || 'document').replace(/\\.pdf$/i, '')\n\n/** \"Contract.pdf\" becomes \"Contract (redacted).pdf\"; a .txt or .docx keeps its extension inside. */\nexport function frozenCopyName(fileName: string | null | undefined, redacted: boolean): string {\n  return `${baseName(fileName)} (${redacted ? 'redacted' : 'annotated'}).pdf`\n}\n\nexport function redactionLogName(fileName: string | null | undefined): string {\n  return `${baseName(fileName)} (redaction log).csv`\n}\n\n/** Upload the frozen bytes as a new document derived from `source`; returns its id, if any. */\nexport async function uploadFrozenCopy(\n  upload: NonNullable<DocumentToolsEnvironment['uploadDocument']>,\n  bytes: Uint8Array,\n  source: FrozenCopySource,\n  redacted: boolean\n): Promise<string | undefined> {\n  const file = new File([bytes as BlobPart], frozenCopyName(source.fileName, redacted), {\n    type: 'application/pdf',\n  })\n  const query: DocumentUploadQuery = {\n    derived_from: [source.documentId],\n    derived_role: redacted ? 'redaction' : 'annotated',\n    shared: source.shared,\n  }\n  if (source.folder) query.folder = source.folder\n  if (source.workspaceId) query.workspace_ext_id = source.workspaceId\n  const response = await upload({ file, query })\n  return response?.doc_ext_ids?.[0]\n}\n"],
+  "mappings": "AAsBA,MAAM,WAAW,CAAC,cACf,YAAY,YAAY,QAAQ,WAAW,EAAE;AAGzC,SAAS,eAAe,UAAqC,UAA2B;AAC7F,SAAO,GAAG,SAAS,QAAQ,CAAC,KAAK,WAAW,aAAa,WAAW;AACtE;AAEO,SAAS,iBAAiB,UAA6C;AAC5E,SAAO,GAAG,SAAS,QAAQ,CAAC;AAC9B;AAGA,eAAsB,iBACpB,QACA,OACA,QACA,UAC6B;AAC7B,QAAM,OAAO,IAAI,KAAK,CAAC,KAAiB,GAAG,eAAe,OAAO,UAAU,QAAQ,GAAG;AAAA,IACpF,MAAM;AAAA,EACR,CAAC;AACD,QAAM,QAA6B;AAAA,IACjC,cAAc,CAAC,OAAO,UAAU;AAAA,IAChC,cAAc,WAAW,cAAc;AAAA,IACvC,QAAQ,OAAO;AAAA,EACjB;AACA,MAAI,OAAO,OAAQ,OAAM,SAAS,OAAO;AACzC,MAAI,OAAO,YAAa,OAAM,mBAAmB,OAAO;AACxD,QAAM,WAAW,MAAM,OAAO,EAAE,MAAM,MAAM,CAAC;AAC7C,SAAO,UAAU,cAAc,CAAC;AAClC;",
+  "names": []
+}

package/dist/document-tools/index.js

@@ -1,150 +1,28 @@
-export { DEFAULT_FIELD_SIZE, FIELD_TYPE_LABELS, INFORMAL_SIGNATURE_NOTE, LEGACY_LAYER_PREFIX, MARK_FIELD_TYPES, MAX_MERGE_ATTEMPTS, MarkupStoreError, SIGNATURE_FIELD_TYPES, SIGNED_UNCHANGED, SIGNER_PROGRESS_LABELS, SignatureVerificationError, SigningError, VERIFY_PATH, addToMarkup, canAnnotate, copyOpenThreads, createFileShare, createMarkupStore, deleteSavedSignature, fetchDocumentSignatureRequests, fetchDocumentSignatures, fetchSavedSignature, fetchSignatureVerification, fieldsFromSuggestions, fieldsInSigningOrder, fileShareBytes, fileShareSigningRequest, forgetLegacyLayer, frozenCopyName, getFileShare, initialsOf, intentText, inviteSigners, isEmailSigner, isLegibleSignatureBox, isSignatureReference, marksByVersion, matchSignedCopy, migrateLegacyLayer, newFieldId, openThreadsOf, pngBytes, pngSize, readLegacyLayer, redactionLogName, saveSignatureRequest, sendBlocker, sha256Hex, signDocument, signFileShare, signSignatureRequest, signatureFieldSuggestions, splitSuggestions, storeSavedSignature, suggestSignatureFields, toAppearance, uploadFrozenCopy, useDeclineSignatureRequest, useDeleteSavedSignature, useDocumentBytes, useDocumentMarkup, useDocumentSignatureRequests, useDocumentSignatures, useFileShare, useFileSharePdf, useFileShares, useInviteSigners, useIsOnline, useSaveSignatureRequest, useSavedSignature, useSignDocument, useSignSignatureRequest, useSignatureVerification, useSignerCandidates, useStoreSavedSignature, useVoidSignatureRequest, versionsWithMarkup } from '../chunk-LSU4UPS5.js';
-import { fetchDocumentFile, fetchDocumentPdf, DocumentFetchError } from '../chunk-QMY2JKBI.js';
-export { DocumentFetchError, DocumentToolsProvider, MarkupDownloadError, SIGNED_LOCKED_REASON, certificateLink, clientUpload, contentDispositionFileName, currentHasMarkup, defaultCertificateUrl, downloadBlob, fetchDocumentFile, fetchDocumentPdf, fetchMarkupPdf, isSignedVersion, uploadQueryString, useDocumentTools, useOptionalDocumentTools } from '../chunk-QMY2JKBI.js';
-import '../chunk-T4CLW3DN.js';
-import '../chunk-T3USOSVN.js';
-export { documentBytesKey } from '../chunk-ZM6N7YZH.js';
-import '../chunk-UW2SGTI5.js';
-import '../chunk-WUTL62MC.js';
-import '../chunk-YNNAJJ5Z.js';
-import '../chunk-47CCGUWR.js';
-import '../chunk-VSCU7K4V.js';
-import '../chunk-SN5YV6FF.js';
-
-// src/document-tools/production.ts
-var PRODUCTIONS_FOLDER = "Productions";
-var extensionOf = (fileName) => {
-  const name = (fileName ?? "").toLowerCase();
-  const dot = name.lastIndexOf(".");
-  return dot < 0 ? "" : name.slice(dot + 1);
+export * from "./core.js";
+import {
+  PRODUCTIONS_FOLDER,
+  buildProduction,
+  fetchProductionPdf,
+  hasNoRendition,
+  isPdfDocument,
+  productionDocumentName,
+  productionFileName,
+  productionFolder,
+  productionIndexCsv,
+  productionTitle,
+  saveProductionFiles
+} from "./production.js";
+export {
+  PRODUCTIONS_FOLDER,
+  buildProduction,
+  fetchProductionPdf,
+  hasNoRendition,
+  isPdfDocument,
+  productionDocumentName,
+  productionFileName,
+  productionFolder,
+  productionIndexCsv,
+  productionTitle,
+  saveProductionFiles
 };
-var 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(" ")
-);
-var isPdfDocument = (doc) => /pdf/i.test(doc.file_type ?? "") || extensionOf(doc.file_name) === "pdf";
-var hasNoRendition = (doc) => !isPdfDocument(doc) && NO_RENDITION_EXTENSIONS.has(extensionOf(doc.file_name));
-var productionDocumentName = (doc) => doc.doc_metadata?.title || doc.file_name || doc.external_id;
-var 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;
-}
-var 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`;
-}
-var 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('../bundle-YNOX7VIL.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=index.js.map
-//# sourceMappingURL=index.js.map