ooxml-ui 0.27.2 → 0.28.0

package/dist/visio/viewer-layers.d.ts

@@ -0,0 +1,22 @@
+import { type VisioDocument, type VisioShape } from 'ooxml-core/visio';
+/** UI limits. Visibility semantics and shape traversal remain in ooxml-core. */
+export declare const VIEWER_LAYER_LIMITS: Readonly<{
+    overrides: 25000;
+    controls: 200;
+}>;
+export interface LayerVisibilityOverride {
+    /** The source page owning the layer, including background pages. */
+    readonly pageId: string;
+    readonly layerId: string;
+    readonly visible: boolean;
+}
+export declare const EMPTY_LAYER_OVERRIDES: readonly LayerVisibilityOverride[];
+/** Validate before allocating indexes; never expose mutable maps as viewer state. */
+export declare function layerOverrideMaps(model: VisioDocument | null, overrides: readonly LayerVisibilityOverride[]): Map<string, Map<string, boolean>>;
+export declare function documentVisibility(model: VisioDocument | null, overrides?: readonly LayerVisibilityOverride[]): WeakMap<VisioShape, boolean>;
+export declare function visibleSelection(model: VisioDocument | null, pageIndex: number, selection: {
+    readonly id: string;
+    readonly pageId?: string;
+} | null, visible: WeakMap<VisioShape, boolean>): boolean;
+/** Rendering eligibility shared by selection and SVG containers; no format interpretation. */
+export declare function hasVisibleShapeContent(shape: VisioShape, visible: WeakMap<VisioShape, boolean> | undefined, cache?: WeakMap<VisioShape, boolean>): boolean;

package/dist/visio/viewer-options.d.ts

@@ -0,0 +1,22 @@
+import { type OfficeOptionCategory, type OfficeProfile } from '../controls';
+/**
+ * Visio's File > Options categories, in Visio's order. Only User name and Initials are honoured
+ * today (they are the local profile, also used as the identity in a shared session); every other
+ * setting is shown disabled with the capability it is waiting for.
+ */
+export declare const VISIO_OPTION_CATEGORIES: readonly OfficeOptionCategory[];
+/** The Options dialog element. Built once and appended to the viewer's shadow root. */
+export declare function createOptionsDialog(doc: Document): HTMLElement;
+/**
+ * File > Account and File > Options share one local profile. Edits in either are written to the
+ * suite-wide profile store, mirrored into the other and reported through `onProfile`.
+ */
+export declare class ViewerProfile {
+    #private;
+    private readonly onProfile;
+    constructor(root: ShadowRoot, onProfile?: (profile: OfficeProfile) => void);
+    get profile(): OfficeProfile;
+    /** Open Visio Options, on General as Visio does. */
+    showOptions(category?: string): void;
+    wire(): () => void;
+}

package/dist/visio/viewer-pan-zoom.d.ts

@@ -0,0 +1,19 @@
+import type { ViewerController } from './controller.js';
+/** Visio's Pan & Zoom window: a floating page thumbnail with the visible area outlined. */
+export declare function createPanZoom(doc: Document): HTMLElement;
+/**
+ * Keeps the thumbnail and the visible-area rectangle in step with the drawing window, and pans
+ * the drawing window from the thumbnail. The thumbnail is a DOM clone of the rendered page.
+ */
+export declare class ViewerPanZoom {
+    #private;
+    private readonly viewport;
+    private readonly controller;
+    private readonly checked;
+    constructor(root: ShadowRoot, viewport: HTMLElement, controller: ViewerController, checked: (open: boolean) => void);
+    get open(): boolean;
+    toggle(open?: boolean): void;
+    wire(): () => void;
+    /** Refresh the thumbnail when the page changed, then the visible-area rectangle. */
+    render(): void;
+}

package/dist/visio/viewer-ruler.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Visio's rulers: inch scales along the top and left of the drawing window with 0 at the page's
+ * left and bottom edges (vertical values grow upward, as in Visio). Drawn by the shared
+ * `office-ui-ruler`; this module only lays them out and says where zero is. Viewer-only
+ * presentation: nothing is read from or written to the document beyond the rendered page box.
+ */
+export interface Rulers {
+    element: HTMLElement;
+    render(visible: boolean, zoom: number): void;
+    wire(): () => void;
+}
+/** Wraps the viewport in a grid with a corner, a top ruler and a left ruler. */
+export declare function createRulers(viewport: HTMLElement): Rulers;

package/dist/visio/viewer-search.d.ts

@@ -0,0 +1,18 @@
+import type { ViewerController, ViewerState } from './controller.js';
+export type FindBar = HTMLElement & {
+    open: boolean;
+    value: string;
+    status: string;
+    statusTitle: string;
+    show(): void;
+    close(): void;
+};
+/**
+ * Visio opens Find from Home > Editing rather than keeping a box in the ribbon. The shared
+ * `office-ui-find-bar` sits under the ribbon, hidden until Find... or Ctrl+F; Enter and
+ * Shift+Enter step through matching shapes and Escape clears, then closes.
+ */
+export declare function createFindBar(doc: Document): FindBar;
+/** Route the find bar's queries and steps to the controller; `closed` restores focus. */
+export declare function wireFindBar(bar: FindBar, controller: ViewerController, closed: () => void): () => void;
+export declare function renderFindBar(bar: FindBar, state: ViewerState): void;

package/dist/visio/viewer-share.d.ts

@@ -0,0 +1,20 @@
+import type { OfficeProfile } from '../controls';
+import type { ViewerController } from './controller.js';
+type Collab = typeof import('ooxml-core/collab');
+/**
+ * File > Share: a live session over `ooxml-core/collab` (Yjs). Peers in other windows of this
+ * browser share the whole VSDX package through a BroadcastChannel; remote changes arrive as one
+ * undoable history step. The collab runtime loads only when sharing starts.
+ */
+export declare class ViewerShare {
+    #private;
+    private readonly controller;
+    private readonly profile;
+    private readonly loadCollab;
+    constructor(root: ShadowRoot, controller: ViewerController, profile: () => OfficeProfile, loadCollab?: () => Promise<Collab>);
+    get active(): boolean;
+    wire(): () => void;
+    start(roomId: string): Promise<void>;
+    stop(): void;
+}
+export {};

package/dist/visio/viewer-stencil.d.ts

@@ -0,0 +1,6 @@
+import type { ViewerController } from './controller.js';
+/**
+ * Shapes window interaction: drag a master onto the page to drop it there, or activate it to add
+ * it at the page centre. Only masters the core can create are draggable; the rest stay inert.
+ */
+export declare function wireStencil(pane: HTMLElement, viewport: HTMLElement, controller: ViewerController, announce: (message: string) => void): () => void;

package/dist/visio/viewer-tell-me.d.ts

@@ -0,0 +1,4 @@
+/** Visio's "Tell me what you want to do" box (the shared `office-ui-command-search`). */
+export declare function createTellMe(doc: Document): HTMLElement;
+/** The command list refreshes on focus, so enabled states always match the ribbon. */
+export declare function wireTellMe(root: ShadowRoot): () => void;

package/dist/visio/worker-editor.d.ts

@@ -0,0 +1,23 @@
+export { snapshotEdits } from 'ooxml-core/visio/ui';
+import type { VisioDocument, VisioEdit } from 'ooxml-core/visio';
+import type { EditDiagnostic } from 'ooxml-core/visio/ui';
+export interface EditWorkerRequest {
+    bytes: ArrayBuffer;
+    edits: readonly VisioEdit[];
+}
+export interface EditTransactionResult {
+    bytes: Uint8Array;
+    document: VisioDocument;
+    changedParts: readonly string[];
+    diagnostics: readonly EditDiagnostic[];
+}
+export type CancellableEditor = ((bytes: Uint8Array, edits: readonly VisioEdit[]) => Promise<EditTransactionResult>) & {
+    cancel?: () => void;
+};
+export interface EditWorkerLike {
+    onmessage: ((event: MessageEvent) => void) | null;
+    onerror: ((event: ErrorEvent) => void) | null;
+    postMessage(message: EditWorkerRequest, transfer: Transferable[]): void;
+    terminate(): void;
+}
+export declare function createWorkerEditor(factory?: () => EditWorkerLike, timeoutMs?: number): CancellableEditor;

package/dist/visio/worker-parser.d.ts

@@ -0,0 +1,13 @@
+import { type VisioDocument } from 'ooxml-core/visio';
+export type CancellableParser = ((bytes: Uint8Array | ArrayBuffer) => Promise<VisioDocument>) & {
+    cancel?: () => void;
+};
+export interface WorkerLike {
+    onmessage: ((event: MessageEvent) => void) | null;
+    onerror: ((event: ErrorEvent) => void) | null;
+    postMessage(message: ArrayBuffer, transfer: Transferable[]): void;
+    terminate(): void;
+}
+export type WorkerFactory = () => WorkerLike;
+/** One disposable worker per document prevents old parses and long CPU tasks from occupying the UI. */
+export declare function createWorkerParser(factory?: WorkerFactory, timeoutMs?: number): CancellableParser;