@ai-matrx/office 0.8.49 → 0.8.51

package/dist/pdf.d.cts

@@ -2,6 +2,67 @@ import * as react from 'react';
 import { ComponentType, ReactNode } from 'react';
 import { ComingSoonEntry } from '@ai-matrx/kit/coming-soon';
 
+/**
+ * The markup session the workspace drives, as the workspace needs it. The implementation is
+ * `@ai-matrx/media/viewers/pdf` `createPdfMarkupEngine` (PDF.js's annotation editors over the
+ * windowed pages); this package does not import the PDF engine, so the contract is written here
+ * and the host hands media's engine through `PdfViewerState.onMarkupEngine`, where TypeScript
+ * checks the two agree. Change one, change the other (media `viewers/pdf/markup/markup-engine.ts`).
+ */
+type PdfMarkupTool = "none" | "highlight" | "freetext" | "ink" | "stamp";
+type PdfMarkupKind = "highlight" | "freetext" | "ink" | "stamp" | "signature";
+interface PdfMarkupStyle {
+    /** `#rrggbb`. */
+    color: string;
+    /** 0-1. */
+    opacity: number;
+    /** Font size (text box) or stroke width (draw), PDF points. */
+    size: number;
+}
+interface PdfMarkupSnapshot {
+    tool: PdfMarkupTool;
+    pending: number;
+    summary: string;
+    canUndo: boolean;
+    canRedo: boolean;
+    selection: {
+        kind: PdfMarkupKind;
+        rect: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        style: PdfMarkupStyle;
+        comment: string;
+    } | null;
+    styles: Record<Exclude<PdfMarkupTool, "none">, PdfMarkupStyle>;
+    textSelected: boolean;
+}
+type PdfMarkupHistoryEvent = {
+    type: "step";
+    label: string;
+} | {
+    type: "undo" | "redo";
+    external: boolean;
+};
+interface PdfMarkupEngine {
+    getSnapshot(): PdfMarkupSnapshot;
+    subscribe(listener: (snapshot: PdfMarkupSnapshot) => void): () => void;
+    onHistory(listener: (event: PdfMarkupHistoryEvent) => void): () => void;
+    setTool(tool: PdfMarkupTool): Promise<void>;
+    setStyle(patch: Partial<PdfMarkupStyle>): void;
+    setComment(text: string): void;
+    highlightSelection(): void;
+    addImage(image: Blob | string, kind: "stamp" | "signature"): Promise<void>;
+    deleteSelected(): void;
+    undo(): void;
+    redo(): void;
+    setCurrentPage(pageNumber: number): void;
+    save(): Promise<Uint8Array>;
+    destroy(): void;
+}
+
 /**
  * The page decisions of one workspace session: which pages are turned, left out, or moved. Pure.
  *
@@ -68,6 +129,12 @@ interface PdfViewerState {
     onDocumentLoad(pageCount: number): void;
     /** A page was measured, in PDF points (crop and fit-page need it). */
     onPageSize(page: number, widthPt: number, heightPt: number): void;
+    /**
+     * Present only when the host can save markup (`saveMarkup`): the viewer turns on PDF.js's
+     * annotation editors and hands their session up here (`null` when the document closes).
+     * `@ai-matrx/media/viewers/pdf` takes it as `PdfDocumentViewer.onMarkupEngine`.
+     */
+    onMarkupEngine?(engine: PdfMarkupEngine | null): void;
 }
 type PdfRunRequest = {
     tool: "apply-pages";
@@ -162,6 +229,8 @@ interface PdfWorkspaceHost {
     renderViewer(state: PdfViewerState): ReactNode;
     /** One page thumbnail (the left panel). Absent: the panel numbers its pages only. */
     renderThumbnail?(page: number, widthPx: number): ReactNode;
+    /** A small badge drawn in the corner of one page's thumbnail (the app's annotation count, for example). Null or absent: none. */
+    renderPageBadge?(page: number): ReactNode;
     /** Run one tool on the server. Rejects with a sentence on failure. */
     run(request: PdfRunRequest): Promise<PdfRunResult>;
     /** Open another page of the app for the same file (Scan, Sign). */
@@ -195,6 +264,24 @@ interface PdfWorkspaceHost {
     online?: boolean;
     /** Show a failure to the person (the host's toast). Defaults to an inline banner. */
     notify?(message: string, tone: "error" | "info"): void;
+    /**
+     * Save the file's bytes with markup written in (PDF.js `saveDocument`) as a NEW VERSION of the
+     * same file. `summary` is "2 highlights, 1 text box". A markup-only change never re-extracts the
+     * text (PDF-PLAN rule R1). Absent: no markup tools.
+     */
+    saveMarkup?(bytes: Uint8Array, summary: string): Promise<PdfRunResult>;
+    /** The annotations already in the file (Acrobat's, Preview's, ours), for the markup panel's list. */
+    existingAnnotations?(): Promise<Array<{
+        page: number;
+        subtype: string;
+        contents: string;
+        author: string;
+    }>>;
+    /** The platform's one signature pad (`@ai-matrx/records-ui` SignaturePad). Absent: no Signature tool. */
+    signaturePad?: ComponentType<{
+        value: unknown;
+        onChange: (value: string | null) => void;
+    }>;
 }
 
 interface PdfWorkspaceProps {
@@ -214,7 +301,7 @@ declare function PdfWorkspace({ host, className }: PdfWorkspaceProps): react.JSX
  * third state, so no dead button.
  */
 
-type PdfToolId = "browse" | "organize" | "extract-pages" | "split" | "crop" | "redact" | "compress" | "scan" | "sign" | "extract-data" | "edit" | "forms" | "protect" | "ocr" | "convert" | "compare" | "stamp";
+type PdfToolId = "browse" | "markup" | "organize" | "extract-pages" | "split" | "crop" | "redact" | "compress" | "scan" | "sign" | "extract-data" | "edit" | "forms" | "protect" | "ocr" | "convert" | "compare" | "stamp";
 interface PdfToolDef {
     id: PdfToolId;
     label: string;
@@ -236,15 +323,98 @@ declare const comingSoonIdOf: (id: PdfToolId) => string;
 /** One row per unbuilt tool, ready for `registerComingSoon` or the host's registry table. */
 declare const PDF_COMING_SOON: Record<string, ComingSoonEntry>;
 
+/**
+ * The workspace's markup model (PDF-PLAN U10). Pure: the markup tools as data (which are built,
+ * which are coming and why), their keys, the palette, and the ONE session history that holds both
+ * page decisions and markup steps, so Undo takes back whichever came last.
+ *
+ * What is built rides PDF.js's own annotation editors (highlight, text box, draw, image; a
+ * signature is an image made on the platform's signature pad; a comment is the note on a piece of
+ * markup). What PDF.js's writer cannot make yet is a "Coming soon" row with its reason, never a
+ * dead button: underline and strike-out, shapes, a free-standing sticky note, links, editing the
+ * page's own text.
+ */
+
+type PdfMarkupToolId = "highlight" | "freetext" | "ink" | "image" | "signature" | "underline" | "shapes" | "note" | "links" | "edit-text";
+interface PdfMarkupToolDef {
+    id: PdfMarkupToolId;
+    label: string;
+    /** Single key, while the markup tool is open. */
+    key?: string;
+    status: "ready" | "soon";
+    /** The PDF.js editor a ready tool turns on. */
+    engineTool?: Exclude<PdfMarkupTool, "none">;
+    /** Ready only when the host brings this port. */
+    needs?: "signaturePad";
+    /** Why a coming tool is not built (shown under its name, and in its Coming-soon promise). */
+    reason?: string;
+}
+declare const PDF_MARKUP_TOOLS: readonly PdfMarkupToolDef[];
+declare const pdfMarkupTool: (id: string) => PdfMarkupToolDef | undefined;
+/** The palette markup offers (Acrobat's comment colors). Literal colors are data: they are written into the PDF. */
+declare const MARKUP_SWATCHES: ReadonlyArray<{
+    value: string;
+    label: string;
+}>;
+/** Which look controls a kind of markup has (the floating toolbar and the panel show only these). */
+declare const MARKUP_STYLE_FIELDS: Record<PdfMarkupKind, ReadonlyArray<keyof PdfMarkupStyle>>;
+/** Sizes offered: font sizes for a text box, stroke widths for a drawing (PDF points). */
+declare const MARKUP_SIZES: Record<"freetext" | "ink", readonly number[]>;
+declare const MARKUP_KIND_LABEL: Record<PdfMarkupKind, string>;
+declare const markupComingSoonId: (id: PdfMarkupToolId) => string;
+/** One Coming-soon row per markup tool not built yet (merged into `PDF_COMING_SOON`). */
+declare const PDF_MARKUP_COMING_SOON: Record<string, ComingSoonEntry>;
+type StepOrigin = "page" | "markup";
+interface SessionTimeline {
+    past: Array<{
+        origin: StepOrigin;
+        label: string;
+    }>;
+    future: Array<{
+        origin: StepOrigin;
+        label: string;
+    }>;
+}
+declare const TIMELINE_LIMIT = 100;
+declare const emptyTimeline: () => SessionTimeline;
+declare function recordStep(t: SessionTimeline, origin: StepOrigin, label: string): SessionTimeline;
+/** The step Undo would take back, or null. */
+declare const nextUndo: (t: SessionTimeline) => {
+    origin: StepOrigin;
+    label: string;
+} | null;
+declare const nextRedo: (t: SessionTimeline) => {
+    origin: StepOrigin;
+    label: string;
+} | null;
+declare function stepBack(t: SessionTimeline): SessionTimeline;
+declare function stepForward(t: SessionTimeline): SessionTimeline;
+/** PDF.js undid a markup step on its own (its keys, focus outside the workspace): move the newest markup step back. */
+declare function markupUndoneElsewhere(t: SessionTimeline): SessionTimeline;
+declare function markupRedoneElsewhere(t: SessionTimeline): SessionTimeline;
+/** Saving (or discarding) one kind of change ends its steps: the file's versions are the durable undo. */
+declare function dropOrigin(t: SessionTimeline, origin: StepOrigin): SessionTimeline;
+
 type PdfActionId = "undo" | "redo" | "find" | "print" | "save" | "zoom-in" | "zoom-out" | "zoom-fit-width" | "zoom-fit-page" | "page-next" | "page-prev" | "page-first" | "page-last" | "rotate-right" | "rotate-left" | "delete-pages" | "select-all-pages" | "toggle-pages" | "toggle-properties" | "read-mode" | "two-up" | "shortcuts" | `tool:${string}`;
 interface PdfShortcut {
     action: PdfActionId;
     label: string;
     /** Display keys: "Mod+Z" shows as Cmd+Z on a Mac and Ctrl+Z elsewhere. */
     keys: string;
-    section: "Edit" | "View" | "Pages" | "Tools";
+    section: "Edit" | "View" | "Pages" | "Tools" | "Markup";
 }
 declare const PDF_SHORTCUTS: readonly PdfShortcut[];
+/**
+ * Keys that work only while "Comment and mark up" is open (they pick a markup tool). Listed in the
+ * shortcut map under Markup; Delete, the arrows and Escape act on the selected markup there.
+ */
+declare const PDF_MARKUP_SHORTCUTS: ReadonlyArray<{
+    tool: PdfMarkupToolId;
+    label: string;
+    keys: string;
+}>;
+/** The markup tool a plain key picks while markup is open, or null. */
+declare function matchMarkupKey(e: KeyLike, typing: boolean): PdfMarkupToolId | null;
 interface KeyLike {
     key: string;
     ctrlKey: boolean;
@@ -288,4 +458,4 @@ declare const canRedo: (h: History<unknown>) => boolean;
 declare const undoLabel: (h: History<unknown>) => string;
 declare const redoLabel: (h: History<unknown>) => string;
 
-export { HISTORY_LIMIT, type History, type KeyLike, PDF_COMING_SOON, PDF_SHORTCUTS, PDF_TOOLS, type PageDecisions, type PageOp, type PdfActionId, type PdfHostTool, type PdfHostToolContext, type PdfRunRequest, type PdfRunResult, type PdfShortcut, type PdfToolDef, type PdfToolId, type PdfViewerState, PdfWorkspace, type PdfWorkspaceHost, type PdfWorkspaceProps, type Turn, canRedo, canUndo, comingSoonIdOf, compilePageOps, deletePages, formatKeys, freshDecisions, isDirty, keptOrder, matchShortcut, pdfTool, pushStep, redo, redoLabel, reorderPages, restorePages, startHistory, turnPages, undo, undoLabel };
+export { HISTORY_LIMIT, type History, type KeyLike, MARKUP_KIND_LABEL, MARKUP_SIZES, MARKUP_STYLE_FIELDS, MARKUP_SWATCHES, PDF_COMING_SOON, PDF_MARKUP_COMING_SOON, PDF_MARKUP_SHORTCUTS, PDF_MARKUP_TOOLS, PDF_SHORTCUTS, PDF_TOOLS, type PageDecisions, type PageOp, type PdfActionId, type PdfHostTool, type PdfHostToolContext, type PdfMarkupEngine, type PdfMarkupHistoryEvent, type PdfMarkupKind, type PdfMarkupSnapshot, type PdfMarkupStyle, type PdfMarkupTool, type PdfMarkupToolDef, type PdfMarkupToolId, type PdfRunRequest, type PdfRunResult, type PdfShortcut, type PdfToolDef, type PdfToolId, type PdfViewerState, PdfWorkspace, type PdfWorkspaceHost, type PdfWorkspaceProps, type SessionTimeline, type StepOrigin, TIMELINE_LIMIT, type Turn, canRedo, canUndo, comingSoonIdOf, compilePageOps, deletePages, dropOrigin, emptyTimeline, formatKeys, freshDecisions, isDirty, keptOrder, markupComingSoonId, markupRedoneElsewhere, markupUndoneElsewhere, matchMarkupKey, matchShortcut, nextRedo, nextUndo, pdfMarkupTool, pdfTool, pushStep, recordStep, redo, redoLabel, reorderPages, restorePages, startHistory, stepBack, stepForward, turnPages, undo, undoLabel };

package/dist/pdf.d.ts

@@ -2,6 +2,67 @@ import * as react from 'react';
 import { ComponentType, ReactNode } from 'react';
 import { ComingSoonEntry } from '@ai-matrx/kit/coming-soon';
 
+/**
+ * The markup session the workspace drives, as the workspace needs it. The implementation is
+ * `@ai-matrx/media/viewers/pdf` `createPdfMarkupEngine` (PDF.js's annotation editors over the
+ * windowed pages); this package does not import the PDF engine, so the contract is written here
+ * and the host hands media's engine through `PdfViewerState.onMarkupEngine`, where TypeScript
+ * checks the two agree. Change one, change the other (media `viewers/pdf/markup/markup-engine.ts`).
+ */
+type PdfMarkupTool = "none" | "highlight" | "freetext" | "ink" | "stamp";
+type PdfMarkupKind = "highlight" | "freetext" | "ink" | "stamp" | "signature";
+interface PdfMarkupStyle {
+    /** `#rrggbb`. */
+    color: string;
+    /** 0-1. */
+    opacity: number;
+    /** Font size (text box) or stroke width (draw), PDF points. */
+    size: number;
+}
+interface PdfMarkupSnapshot {
+    tool: PdfMarkupTool;
+    pending: number;
+    summary: string;
+    canUndo: boolean;
+    canRedo: boolean;
+    selection: {
+        kind: PdfMarkupKind;
+        rect: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        style: PdfMarkupStyle;
+        comment: string;
+    } | null;
+    styles: Record<Exclude<PdfMarkupTool, "none">, PdfMarkupStyle>;
+    textSelected: boolean;
+}
+type PdfMarkupHistoryEvent = {
+    type: "step";
+    label: string;
+} | {
+    type: "undo" | "redo";
+    external: boolean;
+};
+interface PdfMarkupEngine {
+    getSnapshot(): PdfMarkupSnapshot;
+    subscribe(listener: (snapshot: PdfMarkupSnapshot) => void): () => void;
+    onHistory(listener: (event: PdfMarkupHistoryEvent) => void): () => void;
+    setTool(tool: PdfMarkupTool): Promise<void>;
+    setStyle(patch: Partial<PdfMarkupStyle>): void;
+    setComment(text: string): void;
+    highlightSelection(): void;
+    addImage(image: Blob | string, kind: "stamp" | "signature"): Promise<void>;
+    deleteSelected(): void;
+    undo(): void;
+    redo(): void;
+    setCurrentPage(pageNumber: number): void;
+    save(): Promise<Uint8Array>;
+    destroy(): void;
+}
+
 /**
  * The page decisions of one workspace session: which pages are turned, left out, or moved. Pure.
  *
@@ -68,6 +129,12 @@ interface PdfViewerState {
     onDocumentLoad(pageCount: number): void;
     /** A page was measured, in PDF points (crop and fit-page need it). */
     onPageSize(page: number, widthPt: number, heightPt: number): void;
+    /**
+     * Present only when the host can save markup (`saveMarkup`): the viewer turns on PDF.js's
+     * annotation editors and hands their session up here (`null` when the document closes).
+     * `@ai-matrx/media/viewers/pdf` takes it as `PdfDocumentViewer.onMarkupEngine`.
+     */
+    onMarkupEngine?(engine: PdfMarkupEngine | null): void;
 }
 type PdfRunRequest = {
     tool: "apply-pages";
@@ -162,6 +229,8 @@ interface PdfWorkspaceHost {
     renderViewer(state: PdfViewerState): ReactNode;
     /** One page thumbnail (the left panel). Absent: the panel numbers its pages only. */
     renderThumbnail?(page: number, widthPx: number): ReactNode;
+    /** A small badge drawn in the corner of one page's thumbnail (the app's annotation count, for example). Null or absent: none. */
+    renderPageBadge?(page: number): ReactNode;
     /** Run one tool on the server. Rejects with a sentence on failure. */
     run(request: PdfRunRequest): Promise<PdfRunResult>;
     /** Open another page of the app for the same file (Scan, Sign). */
@@ -195,6 +264,24 @@ interface PdfWorkspaceHost {
     online?: boolean;
     /** Show a failure to the person (the host's toast). Defaults to an inline banner. */
     notify?(message: string, tone: "error" | "info"): void;
+    /**
+     * Save the file's bytes with markup written in (PDF.js `saveDocument`) as a NEW VERSION of the
+     * same file. `summary` is "2 highlights, 1 text box". A markup-only change never re-extracts the
+     * text (PDF-PLAN rule R1). Absent: no markup tools.
+     */
+    saveMarkup?(bytes: Uint8Array, summary: string): Promise<PdfRunResult>;
+    /** The annotations already in the file (Acrobat's, Preview's, ours), for the markup panel's list. */
+    existingAnnotations?(): Promise<Array<{
+        page: number;
+        subtype: string;
+        contents: string;
+        author: string;
+    }>>;
+    /** The platform's one signature pad (`@ai-matrx/records-ui` SignaturePad). Absent: no Signature tool. */
+    signaturePad?: ComponentType<{
+        value: unknown;
+        onChange: (value: string | null) => void;
+    }>;
 }
 
 interface PdfWorkspaceProps {
@@ -214,7 +301,7 @@ declare function PdfWorkspace({ host, className }: PdfWorkspaceProps): react.JSX
  * third state, so no dead button.
  */
 
-type PdfToolId = "browse" | "organize" | "extract-pages" | "split" | "crop" | "redact" | "compress" | "scan" | "sign" | "extract-data" | "edit" | "forms" | "protect" | "ocr" | "convert" | "compare" | "stamp";
+type PdfToolId = "browse" | "markup" | "organize" | "extract-pages" | "split" | "crop" | "redact" | "compress" | "scan" | "sign" | "extract-data" | "edit" | "forms" | "protect" | "ocr" | "convert" | "compare" | "stamp";
 interface PdfToolDef {
     id: PdfToolId;
     label: string;
@@ -236,15 +323,98 @@ declare const comingSoonIdOf: (id: PdfToolId) => string;
 /** One row per unbuilt tool, ready for `registerComingSoon` or the host's registry table. */
 declare const PDF_COMING_SOON: Record<string, ComingSoonEntry>;
 
+/**
+ * The workspace's markup model (PDF-PLAN U10). Pure: the markup tools as data (which are built,
+ * which are coming and why), their keys, the palette, and the ONE session history that holds both
+ * page decisions and markup steps, so Undo takes back whichever came last.
+ *
+ * What is built rides PDF.js's own annotation editors (highlight, text box, draw, image; a
+ * signature is an image made on the platform's signature pad; a comment is the note on a piece of
+ * markup). What PDF.js's writer cannot make yet is a "Coming soon" row with its reason, never a
+ * dead button: underline and strike-out, shapes, a free-standing sticky note, links, editing the
+ * page's own text.
+ */
+
+type PdfMarkupToolId = "highlight" | "freetext" | "ink" | "image" | "signature" | "underline" | "shapes" | "note" | "links" | "edit-text";
+interface PdfMarkupToolDef {
+    id: PdfMarkupToolId;
+    label: string;
+    /** Single key, while the markup tool is open. */
+    key?: string;
+    status: "ready" | "soon";
+    /** The PDF.js editor a ready tool turns on. */
+    engineTool?: Exclude<PdfMarkupTool, "none">;
+    /** Ready only when the host brings this port. */
+    needs?: "signaturePad";
+    /** Why a coming tool is not built (shown under its name, and in its Coming-soon promise). */
+    reason?: string;
+}
+declare const PDF_MARKUP_TOOLS: readonly PdfMarkupToolDef[];
+declare const pdfMarkupTool: (id: string) => PdfMarkupToolDef | undefined;
+/** The palette markup offers (Acrobat's comment colors). Literal colors are data: they are written into the PDF. */
+declare const MARKUP_SWATCHES: ReadonlyArray<{
+    value: string;
+    label: string;
+}>;
+/** Which look controls a kind of markup has (the floating toolbar and the panel show only these). */
+declare const MARKUP_STYLE_FIELDS: Record<PdfMarkupKind, ReadonlyArray<keyof PdfMarkupStyle>>;
+/** Sizes offered: font sizes for a text box, stroke widths for a drawing (PDF points). */
+declare const MARKUP_SIZES: Record<"freetext" | "ink", readonly number[]>;
+declare const MARKUP_KIND_LABEL: Record<PdfMarkupKind, string>;
+declare const markupComingSoonId: (id: PdfMarkupToolId) => string;
+/** One Coming-soon row per markup tool not built yet (merged into `PDF_COMING_SOON`). */
+declare const PDF_MARKUP_COMING_SOON: Record<string, ComingSoonEntry>;
+type StepOrigin = "page" | "markup";
+interface SessionTimeline {
+    past: Array<{
+        origin: StepOrigin;
+        label: string;
+    }>;
+    future: Array<{
+        origin: StepOrigin;
+        label: string;
+    }>;
+}
+declare const TIMELINE_LIMIT = 100;
+declare const emptyTimeline: () => SessionTimeline;
+declare function recordStep(t: SessionTimeline, origin: StepOrigin, label: string): SessionTimeline;
+/** The step Undo would take back, or null. */
+declare const nextUndo: (t: SessionTimeline) => {
+    origin: StepOrigin;
+    label: string;
+} | null;
+declare const nextRedo: (t: SessionTimeline) => {
+    origin: StepOrigin;
+    label: string;
+} | null;
+declare function stepBack(t: SessionTimeline): SessionTimeline;
+declare function stepForward(t: SessionTimeline): SessionTimeline;
+/** PDF.js undid a markup step on its own (its keys, focus outside the workspace): move the newest markup step back. */
+declare function markupUndoneElsewhere(t: SessionTimeline): SessionTimeline;
+declare function markupRedoneElsewhere(t: SessionTimeline): SessionTimeline;
+/** Saving (or discarding) one kind of change ends its steps: the file's versions are the durable undo. */
+declare function dropOrigin(t: SessionTimeline, origin: StepOrigin): SessionTimeline;
+
 type PdfActionId = "undo" | "redo" | "find" | "print" | "save" | "zoom-in" | "zoom-out" | "zoom-fit-width" | "zoom-fit-page" | "page-next" | "page-prev" | "page-first" | "page-last" | "rotate-right" | "rotate-left" | "delete-pages" | "select-all-pages" | "toggle-pages" | "toggle-properties" | "read-mode" | "two-up" | "shortcuts" | `tool:${string}`;
 interface PdfShortcut {
     action: PdfActionId;
     label: string;
     /** Display keys: "Mod+Z" shows as Cmd+Z on a Mac and Ctrl+Z elsewhere. */
     keys: string;
-    section: "Edit" | "View" | "Pages" | "Tools";
+    section: "Edit" | "View" | "Pages" | "Tools" | "Markup";
 }
 declare const PDF_SHORTCUTS: readonly PdfShortcut[];
+/**
+ * Keys that work only while "Comment and mark up" is open (they pick a markup tool). Listed in the
+ * shortcut map under Markup; Delete, the arrows and Escape act on the selected markup there.
+ */
+declare const PDF_MARKUP_SHORTCUTS: ReadonlyArray<{
+    tool: PdfMarkupToolId;
+    label: string;
+    keys: string;
+}>;
+/** The markup tool a plain key picks while markup is open, or null. */
+declare function matchMarkupKey(e: KeyLike, typing: boolean): PdfMarkupToolId | null;
 interface KeyLike {
     key: string;
     ctrlKey: boolean;
@@ -288,4 +458,4 @@ declare const canRedo: (h: History<unknown>) => boolean;
 declare const undoLabel: (h: History<unknown>) => string;
 declare const redoLabel: (h: History<unknown>) => string;
 
-export { HISTORY_LIMIT, type History, type KeyLike, PDF_COMING_SOON, PDF_SHORTCUTS, PDF_TOOLS, type PageDecisions, type PageOp, type PdfActionId, type PdfHostTool, type PdfHostToolContext, type PdfRunRequest, type PdfRunResult, type PdfShortcut, type PdfToolDef, type PdfToolId, type PdfViewerState, PdfWorkspace, type PdfWorkspaceHost, type PdfWorkspaceProps, type Turn, canRedo, canUndo, comingSoonIdOf, compilePageOps, deletePages, formatKeys, freshDecisions, isDirty, keptOrder, matchShortcut, pdfTool, pushStep, redo, redoLabel, reorderPages, restorePages, startHistory, turnPages, undo, undoLabel };
+export { HISTORY_LIMIT, type History, type KeyLike, MARKUP_KIND_LABEL, MARKUP_SIZES, MARKUP_STYLE_FIELDS, MARKUP_SWATCHES, PDF_COMING_SOON, PDF_MARKUP_COMING_SOON, PDF_MARKUP_SHORTCUTS, PDF_MARKUP_TOOLS, PDF_SHORTCUTS, PDF_TOOLS, type PageDecisions, type PageOp, type PdfActionId, type PdfHostTool, type PdfHostToolContext, type PdfMarkupEngine, type PdfMarkupHistoryEvent, type PdfMarkupKind, type PdfMarkupSnapshot, type PdfMarkupStyle, type PdfMarkupTool, type PdfMarkupToolDef, type PdfMarkupToolId, type PdfRunRequest, type PdfRunResult, type PdfShortcut, type PdfToolDef, type PdfToolId, type PdfViewerState, PdfWorkspace, type PdfWorkspaceHost, type PdfWorkspaceProps, type SessionTimeline, type StepOrigin, TIMELINE_LIMIT, type Turn, canRedo, canUndo, comingSoonIdOf, compilePageOps, deletePages, dropOrigin, emptyTimeline, formatKeys, freshDecisions, isDirty, keptOrder, markupComingSoonId, markupRedoneElsewhere, markupUndoneElsewhere, matchMarkupKey, matchShortcut, nextRedo, nextUndo, pdfMarkupTool, pdfTool, pushStep, recordStep, redo, redoLabel, reorderPages, restorePages, startHistory, stepBack, stepForward, turnPages, undo, undoLabel };