ooxml-ui 1.22.0 → 1.23.0

package/dist/docx/events.d.ts

@@ -6,6 +6,12 @@ import type { FileCommandDetail } from './file-commands.js';
 import type { PageChangeDetail } from './page-sync.js';
 import type { PresenceMessage } from './presence.js';
 import type { RibbonAction } from './ribbon.js';
+/** The detail of `readonly-change`. */
+export interface ReadOnlyChangeDetail {
+    readOnly: boolean;
+    locked: boolean;
+    hostReadOnly: boolean;
+}
 /** Every CustomEvent the `<docx-editor>` element (and its controllers) dispatches, with its detail. */
 export interface DocxEditorEventMap {
     /** The document changed through editing, review actions or edits outside the main surface. */
@@ -14,8 +20,13 @@ export interface DocxEditorEventMap {
     'document-error': CustomEvent<Error>;
     /** Non-fatal notice, for example that a print layout could not be produced faithfully. */
     'document-warning': CustomEvent<string>;
-    /** The user toggled read-only from the editor chrome. */
-    'readonly-change': CustomEvent<boolean>;
+    /**
+     * Read-only changed: the user toggled it from the editor chrome, the host's switch changed or a
+     * collaboration role did. `readOnly` is the effective value, `locked` says a `viewer` role holds
+     * it, and `hostReadOnly` is the host's own switch. A controlled parent mirrors only
+     * `hostReadOnly`, so a role lock is never written into the host's setting.
+     */
+    'readonly-change': CustomEvent<ReadOnlyChangeDetail>;
     /** A ribbon control was activated. Bubbles from inside the shadow tree. */
     'ribbon-action': CustomEvent<RibbonAction>;
     /** The user changed which ribbon commands are shown (File > Customize Ribbon); persist the ids if you want them kept. */

package/dist/docx/file-commands.d.ts

@@ -1,9 +1,15 @@
-export type FileCommand = 'new' | 'open' | 'save' | 'saveAs' | 'export' | 'exportText' | 'print' | 'share';
-export interface FileCommandDetail {
-    command: FileCommand;
-    /** Save As: the name the user chose. */
-    fileName?: string;
-}
+/**
+ * File commands raised by the editor chrome (title bar, ribbon tab row and File backstage). Each
+ * command is first announced as a cancelable `file-command` event so hosts can take over file
+ * I/O; when no host cancels it, the editor performs a browser-only default (file picker, download,
+ * print). `share` (the tab row's Share button) has no default: starting a session needs the host's
+ * transport and authority (`startCollaboration`), so only a host that handles it does anything.
+ */
+import { type FileCommandDetail as SharedFileCommandDetail, type WordFileCommand } from 'ooxml-core/embedding';
+/** The File commands this editor announces (the shared `ooxml-core/embedding` type). */
+export type FileCommand = WordFileCommand;
+/** The detail of `file-command`; the shared `ooxml-core/embedding` shape. */
+export type FileCommandDetail = SharedFileCommandDetail<FileCommand>;
 export declare function announceFileCommand(host: HTMLElement, command: FileCommand, fileName?: string): boolean;
 /** Wraps saved bytes in a Blob typed from the file name's extension (docx unless `.doc`). */
 export declare function wordBlob(bytes: Uint8Array, fileName: string): Blob;

package/dist/docx/index.d.ts

@@ -27,3 +27,6 @@ export type { RevisionRange } from './review-commands.js';
 export { lightTheme, darkTheme, themeToCssVars } from 'ooxml-core/docx/ui';
 export type { EditorTheme, EditorThemeMode } from 'ooxml-core/docx/ui';
 export { RIBBON_ADD_IN_EVENT, type OfficeRibbonAddInEvent, type RibbonAddInCommand, type RibbonAddInCommandDetail, type RibbonAddInGroup, type RibbonAddInTab, } from '../ribbon/add-in-tabs.js';
+export type { WordBackstagePage, WordCustomization, WordMenuCommand, WordMenuContext, WordRegionContext, WordRegionRenderer, } from './customization.js';
+export { WORD_CAPABILITY_IDS } from 'ooxml-core/docx/ui';
+export type { WordCapabilities, WordCapabilityId } from 'ooxml-core/docx/ui';

package/dist/docx/keyboard.d.ts

@@ -20,6 +20,8 @@ export interface KeyEventLike {
 export interface ShortcutContext {
     readOnly: boolean;
     mac: boolean;
+    /** Shortcuts a host capability turned off; they are swallowed (`blocked`), never run. */
+    disabled?: ReadonlySet<string>;
 }
 export type ShortcutId = 'find' | 'replace' | 'save' | 'print' | 'next-region' | 'previous-region' | 'focus-ribbon' | 'context-menu' | 'escape' | 'help';
 export interface Shortcut {

package/dist/docx/shortcut-help.d.ts

@@ -6,7 +6,8 @@ export interface ShortcutRow {
 }
 /** Only bindings that exist in the editor's keymap are listed, grouped by action. */
 export declare function editorShortcutRows(mac: boolean, bindings?: Record<string, unknown>): ShortcutRow[];
-export declare function shortcutRows(registry: ShortcutRegistry, mac: boolean): ShortcutRow[];
+/** The rows of the shortcut help; `disabled` (shortcuts a host capability turned off) are left out. */
+export declare function shortcutRows(registry: ShortcutRegistry, mac: boolean, disabled?: ReadonlySet<string>): ShortcutRow[];
 export interface ShortcutHelp {
     element: HTMLElement;
     readonly isOpen: boolean;

package/dist/docx/title-bar.d.ts

@@ -11,6 +11,8 @@ export interface TitleBar {
     setFileName(name: string): void;
     setSaveState(state: SaveState): void;
     setReadOnly(readOnly: boolean): void;
+    /** Quick Access commands (`save`) a host capability removed. */
+    setHiddenCommands(ids: Iterable<string>): void;
     /** Redraws every label after the editor locale changed. */
     relocalize(): void;
 }

package/dist/docx/view-options.d.ts

@@ -1,10 +1,15 @@
 import type { EditorCore } from './editor-core.js';
 import type { RibbonActionId } from 'ooxml-core/docx/ui';
+import { type ResolvedWordCustomization, type WordCustomization } from './customization.js';
 /** Host-controlled UI customisation; each value maps to one element property and attribute. */
 export declare class ViewOptions {
     showThumbnails: boolean;
     showToolbar: boolean;
     hiddenActions: readonly RibbonActionId[];
+    /** The host's `customization` object, as given. */
+    customizationInput: WordCustomization | null;
+    /** `customizationInput` resolved for the render sites. */
+    customization: ResolvedWordCustomization;
 }
 /** Pushes the current options into the built shell; a no-op until the element connects. */
 export declare function applyViewOptions(core: EditorCore): void;