@arbidocs/react 0.5.111 → 0.5.113

package/dist/document-tools/index.d.cts

@@ -1,90 +0,0 @@
-import { DocumentToolsClient, DocumentToolsEnvironment } from './core.cjs';
-export { AdoptedSignature, AnnotatableState, CopyMatch, CreateFileShare, DEFAULT_FIELD_SIZE, DocumentChange, DocumentFetchError, DocumentFetchOptions, DocumentToolsNoticeKind, DocumentToolsNoticeOptions, DocumentToolsNotify, DocumentToolsProvider, DocumentToolsProviderProps, DocumentToolsUser, DocumentUploadQuery, DocumentUploadRequest, FIELD_TYPE_LABELS, FileShare, FrozenCopySource, INFORMAL_SIGNATURE_NOTE, KeypairSource, LEGACY_LAYER_PREFIX, LegacyPrompt, MARK_FIELD_TYPES, MAX_MERGE_ATTEMPTS, MarkupDocument, MarkupDownloadError, MarkupSnapshot, MarkupStore, MarkupStoreError, MarkupStoreOptions, NamedSigner, OlderMarkupNote, ResolvedDocumentToolsEnvironment, SIGNATURE_FIELD_TYPES, SIGNED_LOCKED_REASON, SIGNED_UNCHANGED, SIGNER_PROGRESS_LABELS, SaveSignatureRequestVars, SavedSignature, SignDocumentResponse, SignDocumentVars, SignRequestSignResponse, SignRequestVars, SignatureAppearance, SignatureField, SignatureFieldSuggestions, SignatureFieldType, SignatureRecord, SignatureRequest, SignatureRequestSigner, SignatureStatusResponse, SignatureVerification, SignatureVerificationError, SignerCandidate, SignerDetails, SignerProgress, SigningError, SigningErrorReason, SuggestedSignatureField, UseDocumentBytesOptions, VERIFY_PATH, VerifiedSignature, VersionInfo, addToMarkup, canAnnotate, certificateLink, clientUpload, contentDispositionFileName, copyOpenThreads, createFileShare, createMarkupStore, currentHasMarkup, defaultCertificateUrl, deleteSavedSignature, downloadBlob, fetchDocumentFile, fetchDocumentPdf, fetchDocumentSignatureRequests, fetchDocumentSignatures, fetchMarkupPdf, fetchSavedSignature, fetchSignatureVerification, fieldsFromSuggestions, fieldsInSigningOrder, fileShareBytes, fileShareSigningRequest, forgetLegacyLayer, frozenCopyName, getFileShare, initialsOf, intentText, inviteSigners, isEmailSigner, isLegibleSignatureBox, isSignatureReference, isSignedVersion, marksByVersion, matchSignedCopy, migrateLegacyLayer, newFieldId, openThreadsOf, pngBytes, pngSize, readLegacyLayer, redactionLogName, saveSignatureRequest, sendBlocker, sha256Hex, signDocument, signFileShare, signSignatureRequest, signatureFieldSuggestions, splitSuggestions, storeSavedSignature, suggestSignatureFields, toAppearance, uploadFrozenCopy, uploadQueryString, useDeclineSignatureRequest, useDeleteSavedSignature, useDocumentBytes, useDocumentMarkup, useDocumentSignatureRequests, useDocumentSignatures, useDocumentTools, useFileShare, useFileSharePdf, useFileShares, useInviteSigners, useIsOnline, useOptionalDocumentTools, useSaveSignatureRequest, useSavedSignature, useSignDocument, useSignSignatureRequest, useSignatureVerification, useSignerCandidates, useStoreSavedSignature, useVoidSignatureRequest, versionsWithMarkup } from './core.cjs';
-import { components } from '@arbidocs/client';
-import { P as ProductionChoices } from '../ProductionDialog.d-CpzslFn0.cjs';
-import { a as BundleFile, b as BundleIndexEntry } from '../bundle.d-BnCSbHy2.cjs';
-export { D as DocumentBytesKind, f as documentBytesKey } from '../query-keys.d-B1Am9tIF.cjs';
-import 'react';
-import '../store.d-GADDvC7w.cjs';
-import '../model.d-CNtRWKVK.cjs';
-import '@tanstack/react-query';
-import '@arbidocs/sdk/browser';
-
-/**
- * Production sets: number the selected documents with Bates labels (optionally a QR code back to
- * each document and an index page) and save the result back to the workspace. The dialog is
- * `ProductionSetDialog` in `@arbidocs/blocks/document-tools`; this is its data side.
- *
- * A PDF is numbered as stored (`/download`). Any other document is numbered through its PDF
- * rendition (`/view`, what the viewer shows for a Word or text file); one without a rendition is
- * left out. Saved results are new documents derived from their sources (role `production`) in a
- * Productions folder, shared with the workspace only if every source is. The originals never
- * change.
- *
- * pdf-lib (the numbering) is loaded only when a production is built, so importing this module
- * stays as light as the rest of the document tools.
- */
-
-/** The fields of a document record (`DocResponse`) a production uses. */
-type ProductionSource = Pick<components['schemas']['DocResponse'], 'external_id' | 'file_name' | 'file_type' | 'shared'> & {
-    doc_metadata?: {
-        title?: string | null;
-    } | null;
-    /** The document's workspace: the produced files are saved there, named on the upload. */
-    workspace_ext_id?: string | null;
-};
-declare const PRODUCTIONS_FOLDER = "Productions";
-declare const isPdfDocument: (doc: ProductionSource) => boolean;
-/** True for a document with no PDF version to number (media, archives and the like). */
-declare const hasNoRendition: (doc: ProductionSource) => boolean;
-/** The name a document goes by in the dialog and the index: its title, else its file name. */
-declare const productionDocumentName: (doc: ProductionSource) => string;
-/**
- * The PDF to number for `doc`: the file itself, or the PDF version of anything else. `null` when a
- * non-PDF has no PDF version (yet), so it is left out; a PDF that cannot be downloaded throws.
- */
-declare function fetchProductionPdf(client: DocumentToolsClient, doc: ProductionSource): Promise<Uint8Array | null>;
-/** "Production ACME-000001-ACME-000042": names the files and folder of one production. */
-declare function productionTitle(firstLabel: string, lastLabel: string): string;
-/** Where a production is saved: the Productions folder, or a folder of its own per document. */
-declare function productionFolder(title: string, merged: boolean): string;
-/** In the workspace a per-document file says which range it holds, beside its original. */
-declare function productionFileName(file: BundleFile, title: string): string;
-/** The `index.csv` of a per-document production: every document with its file and range. */
-declare function productionIndexCsv(index: readonly BundleIndexEntry[]): string;
-interface ProductionUpload {
-    name: string;
-    bytes: Uint8Array;
-    /** The documents this file was made from. */
-    sources: ProductionSource[];
-}
-/** Save each file as a new workspace document derived from its sources; returns the new ids. */
-declare function saveProductionFiles(upload: NonNullable<DocumentToolsEnvironment['uploadDocument']>, files: readonly ProductionUpload[], folder: string): Promise<string[]>;
-interface BuildProductionOptions {
-    /** The link a document's QR code opens (the document in the host app). */
-    documentUrl: (documentId: string) => string;
-    /** Who produced the set; recorded in a merged file's metadata. */
-    author?: string;
-    onProgress?: (done: number, total: number) => void;
-}
-interface BuiltProduction {
-    title: string;
-    merged: boolean;
-    /** The numbered files: one merged PDF (named after its range), or one per document (+ index). */
-    files: BundleFile[];
-    index: BundleIndexEntry[];
-    /** The documents numbered, in order. */
-    included: ProductionSource[];
-    /** Documents left out because they have no PDF version yet. */
-    noRendition: ProductionSource[];
-    /** The files as they are saved to the workspace, each with the documents it was made from. */
-    uploads: ProductionUpload[];
-    folder: string;
-}
-/**
- * Fetch each document's PDF (in `choices.order`) and number the set. Throws when none of the
- * documents has a PDF version, or when a PDF cannot be fetched.
- */
-declare function buildProduction(client: DocumentToolsClient, documents: readonly ProductionSource[], choices: ProductionChoices, options: BuildProductionOptions): Promise<BuiltProduction>;
-
-export { type BuildProductionOptions, type BuiltProduction, DocumentToolsClient, DocumentToolsEnvironment, PRODUCTIONS_FOLDER, type ProductionSource, type ProductionUpload, buildProduction, fetchProductionPdf, hasNoRendition, isPdfDocument, productionDocumentName, productionFileName, productionFolder, productionIndexCsv, productionTitle, saveProductionFiles };