@arbidocs/blocks 0.4.68 → 0.4.70

package/dist/document-tools/DocumentToolButtons.d.ts

@@ -0,0 +1,29 @@
+/**
+ * The viewer-header buttons of the PDF document tools: Annotate, Show original, Download with
+ * markup and Sign. Separate parts so a host can place them among its own header actions. On a
+ * narrow (`compact`) header each is icon-only; its accessible name stays.
+ */
+import type { ReactElement } from 'react';
+interface ToggleProps {
+    /** On (pressed). */
+    active: boolean;
+    onClick: () => void;
+    compact?: boolean;
+}
+/** Annotate mode: highlight, comment, stamp, redact. */
+export declare function AnnotateButton({ active, onClick, compact }: ToggleProps): ReactElement;
+/** The markup is the default view of a marked-up PDF; this shows the untouched file. */
+export declare function ShowOriginalButton({ active, onClick, compact }: ToggleProps): ReactElement;
+/**
+ * "Download with markup": the PDF with its annotations, which Acrobat and Preview show. With a
+ * `disabledReason` (a signed, locked version) it is off and says why.
+ */
+export declare function DownloadMarkupButton({ onClick, disabledReason, }: {
+    onClick: () => void;
+    disabledReason?: string;
+}): ReactElement;
+/** One line where a signed version's content can be edited: an edit is a new, unsigned version. */
+export declare function SignedEditNote(): ReactElement;
+/** Sign: choose where the signature goes, then sign. */
+export declare function SignButton({ active, onClick, compact }: ToggleProps): ReactElement;
+export {};

package/dist/document-tools/MarkupNotices.d.ts

@@ -0,0 +1,12 @@
+/**
+ * The one-line notices above the PDF about its markup: annotations found in this browser from
+ * before markup was saved on the server (for a shared document: add them to the shared markup, or
+ * discard), and markup that sits on an older version (open it, or copy its open comments here).
+ */
+import type { LegacyPrompt, OlderMarkupNote } from '@arbidocs/react/document-tools';
+export interface MarkupNoticesProps {
+    legacyPrompt: LegacyPrompt | null;
+    olderNote: OlderMarkupNote | null;
+    onOpenVersion: (version: number) => void;
+}
+export declare function MarkupNotices({ legacyPrompt, olderNote, onOpenVersion }: MarkupNoticesProps): import("react").JSX.Element;

package/dist/document-tools/MarkupViewNote.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Which view of a marked-up PDF is on screen, spelled out beside the title, with the switch to the
+ * other one. The narrow header's "Show original" is an unlabelled page icon, so on its own it read
+ * as no control at all, and nothing said whether the page showed the markup or the original.
+ */
+import type { ReactElement } from 'react';
+export interface MarkupViewNoteProps {
+    showOriginal: boolean;
+    onToggle: () => void;
+}
+export declare function MarkupViewNote({ showOriginal, onToggle }: MarkupViewNoteProps): ReactElement;

package/dist/document-tools/SignDocumentDialog.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Sign a document electronically: confirm the name, choose whether the date is shown, read the
+ * statement of intent, re-enter the password. Only the signature (and the date, if ticked) is drawn
+ * on the page; a role, a firm or a place go on as ordinary annotation text. Anyone can click the
+ * signature to check it. The signed copy is saved as a new version and opened, with an offer to
+ * email it when the host gives the tools an `emailDocument`. Needs a `<DocumentToolsProvider>` with
+ * a `user` (its email) and a `deploymentDomain`, inside a React Query `QueryClientProvider`.
+ */
+import { type ReactElement } from 'react';
+import { type SignatureAppearance } from '@arbidocs/react/document-tools';
+export interface SignDocumentDialogProps {
+    open: boolean;
+    onOpenChange: (open: boolean) => void;
+    documentId: string;
+    /** The PDF the viewer is showing. */
+    pdfBlob: Blob;
+    /** Where the signature goes; omitted = bottom of the last page. */
+    appearance?: SignatureAppearance;
+}
+export declare function SignDocumentDialog({ open, onOpenChange, documentId, pdfBlob, appearance, }: SignDocumentDialogProps): ReactElement;

package/dist/document-tools/SignatureCertificate.d.ts

@@ -0,0 +1,26 @@
+/**
+ * The certificate of an ARBI signature: the page the link on a signed PDF's signature opens, for
+ * anyone, signed in or not. Plain English and short: who signed and when, what ARBI checks, the
+ * result, any counter-signatures, and "Check your copy", which hashes a PDF in the browser and
+ * compares it with the signed document and each signed revision (the file never leaves the
+ * device). No email addresses and no
+ * document content. Presentational: `verification` comes from `useSignatureVerification` in
+ * `@arbidocs/react/document-tools`.
+ */
+import { type ReactElement } from 'react';
+import { type SignatureVerification } from '@arbidocs/react/document-tools';
+export interface SignatureCertificateProps {
+    /** The signature reference (`sig-…`), shown at the foot of the page. */
+    reference?: string;
+    verification?: SignatureVerification;
+    isLoading?: boolean;
+    /** Why the signature could not be checked. */
+    error?: string | null;
+    /** The error is a passing one (too many checks): say it calmly, not as a failure. */
+    isErrorTransient?: boolean;
+    /** How signing times are shown. Default: {@link formatSignedAt}. */
+    formatDate?: (iso: string) => string;
+    /** Offer "Check your copy". Default on. */
+    allowCopyCheck?: boolean;
+}
+export declare function SignatureCertificate({ reference, verification, isLoading, error, isErrorTransient, formatDate, allowCopyCheck, }: SignatureCertificateProps): ReactElement;

package/dist/document-tools/SignatureStatus.d.ts

@@ -0,0 +1,22 @@
+/**
+ * The "Signed — locked" note in the viewer header (a signed version changes only by a further
+ * signature), which opens the signature details: who signed and when,
+ * whether the document is unchanged since, and "View certificate", the public page anyone can
+ * check the signature on (the same page the signature on the PDF links to). Read from the PDF
+ * itself (GET .../signatures). A counter-signed copy lists every signature, oldest first.
+ */
+import type { ReactElement } from 'react';
+import { type SignatureStatusResponse } from '@arbidocs/react/document-tools';
+/** "14 Oct 2026, 12:00" in the reader's locale and time zone. */
+export declare function formatSignedAt(iso: string): string;
+export interface SignatureStatusProps {
+    status: SignatureStatusResponse;
+    /** How the signing time is shown. Default: {@link formatSignedAt}. */
+    formatDate?: (iso: string) => string;
+    /**
+     * The certificate page of a signature, only for a record without the `certificate_url` the API
+     * returns. Default: `/verify/{reference}` on this origin.
+     */
+    certificateUrl?: (reference: string) => string;
+}
+export declare function SignatureStatus({ status, formatDate, certificateUrl, }: SignatureStatusProps): ReactElement;

package/dist/document-tools/VersionSnapshotBar.d.ts

@@ -0,0 +1,27 @@
+/**
+ * The bar above an older version opened read-only: which version it is, "Ask about this version"
+ * (when the host has an assistant) and the way back to the current version. Put it in the viewer's
+ * sticky header, not the content area: a PDF view scrolls its first page into view, which would
+ * scroll a bar above it out of sight.
+ */
+import type { ReactElement } from 'react';
+export interface VersionSnapshotBarLabels {
+    /** `Version 2 · read only`; `number` is undefined when the version is not known. */
+    title: (number: number | undefined) => string;
+    ask: string;
+    returnToCurrent: string;
+    /** For documents edited live (Word, artifacts), where "current" is the live document. */
+    returnToLive: string;
+}
+export declare const DEFAULT_VERSION_SNAPSHOT_BAR_LABELS: VersionSnapshotBarLabels;
+export interface VersionSnapshotBarProps {
+    /** The version's number, when known. */
+    versionNumber?: number;
+    /** The document is edited live: the way back says "live document". */
+    live?: boolean;
+    /** Ask the assistant about this version. Omitted: no ask action. */
+    onAsk?: () => void;
+    onReturn: () => void;
+    labels?: Partial<VersionSnapshotBarLabels>;
+}
+export declare function VersionSnapshotBar({ versionNumber, live, onAsk, onReturn, labels: overrides, }: VersionSnapshotBarProps): ReactElement;