@miragon/modeler-shell 0.1.0 → 0.2.0

package/dist/keymap-DORzHnK-.d.ts

@@ -1,151 +0,0 @@
-import { c as ShellHost } from './types-B6NfkiUG.js';
-
-/**
- * Every text the shell shows or announces, in one table (guide §2, shared terms). English by
- * default; a localized modeler overrides the whole table in its language, numbers arrive already
- * formatted through `Intl` in that language.
- */
-interface ShellMessages {
-    /** Menu trigger `aria-label` and tooltip, dropdown `aria-label`. */
-    menu: string;
-    /** Palette `aria-label`. */
-    tools: string;
-    /** `aria-label` of the focusable canvas `<svg>` (`role="application"`); a modeler names its notation. */
-    canvas: string;
-    /** Zoom panel `aria-label`. */
-    zoom: string;
-    zoomOut: string;
-    zoomIn: string;
-    /** Tooltip of the readout, e.g. `(percent) => "Zoom to " + percent` with percent "100%". */
-    zoomToActual(percent: string): string;
-    /** `aria-label` of the readout: "Zoom to 100% (now 86%)". */
-    zoomToActualNow(percent: string, now: string): string;
-    fit: string;
-    /** Legend title and the Model-group checkbox. */
-    legend: string;
-    closeLegend: string;
-    /** Pill text: "1 problem", "2 problems". */
-    problems(count: number, formattedCount: string): string;
-    /** Pill `aria-label`: "2 problems, 1 error", "2 problems, no errors". */
-    problemsLabel(count: number, errors: number, formattedCount: string, formattedErrors: string): string;
-    /** Pill tooltip in the IDE host. */
-    showProblems: string;
-    /** Empty-file hint (guide §13.5). */
-    emptyHint: string;
-    insertExample: string;
-    /** Status box for an invalid file; `diagram` names the notation ("Event Storming board"). */
-    invalidFile(diagram: string): string;
-    /** Key names in shortcut chips outside macOS (German: Strg, Umschalt, Plus, Minus). */
-    keyNames: {
-        ctrl: string;
-        shift: string;
-        plus: string;
-        minus: string;
-    };
-}
-/** Every key optional; an `undefined` value keeps the default (a conditional override). */
-type ShellMessageOverrides = {
-    [Key in Exclude<keyof ShellMessages, "keyNames">]?: ShellMessages[Key] | undefined;
-} & {
-    keyNames?: {
-        [Key in keyof ShellMessages["keyNames"]]?: string | undefined;
-    } | undefined;
-};
-declare const defaultMessages: ShellMessages;
-/** `defaultMessages` with `overrides` applied (`keyNames` merged key by key). */
-declare function resolveMessages(overrides?: ShellMessageOverrides | undefined): ShellMessages;
-
-/** The only keys the chrome handles (guide §5.8). */
-type ChromeKey = "zoomIn" | "zoomOut" | "zoomToActual" | "fit";
-/** The `KeyboardEvent` fields the keymap reads. */
-interface KeyLike {
-    key: string;
-    code: string;
-    metaKey: boolean;
-    ctrlKey: boolean;
-    shiftKey: boolean;
-    altKey: boolean;
-    isComposing?: boolean | undefined;
-}
-/**
- * Which chrome key `event` is, ignoring where it was pressed:
- * - `zoomIn`: Cmd/Ctrl + `+` or `=` (by `key`, with or without Shift), or `NumpadAdd` (by `code`);
- * - `zoomOut`: Cmd/Ctrl + `-` or `_`, or `NumpadSubtract`;
- * - `zoomToActual`: Cmd/Ctrl + `0`, or `Numpad0` (also with NumLock off);
- * - `fit`: Shift + `Digit1` (by `code`, every layout) without Cmd, Ctrl or Alt.
- * Cmd/Ctrl is `metaKey || ctrlKey` on every platform; nothing matches with `altKey` (AltGr).
- */
-declare function matchChromeKey(event: KeyLike): ChromeKey | undefined;
-/**
- * Cmd/Ctrl + Z, Cmd/Ctrl + Shift + Z or Cmd/Ctrl + Y, without Alt (by `key`, `code` as fallback).
- * Cmd/Ctrl + Shift + Y is not redo (VS Code toggles its Debug Console with it).
- */
-declare function isUndoRedoKey(event: KeyLike): boolean;
-/** A text field: every input, select list and editable text (label editor, inspector, dialogs). */
-declare const TEXT_FIELD_SELECTOR = "input, textarea, select, [contenteditable]:not([contenteditable='false'])";
-/** Where a key was pressed, as the shell's one `keydown` listener sees it. */
-interface KeyContext {
-    host: ShellHost;
-    /** The event target matches `TEXT_FIELD_SELECTOR` or is `isContentEditable`. */
-    inTextField: boolean;
-    /** The shell's menu dropdown is open. */
-    menuOpen: boolean;
-    /** A popover or dialog (`[role="dialog"]`, modal or not) is open. */
-    dialogOpen: boolean;
-    /** A modal dialog (`[role="dialog"][aria-modal="true"]`) is open: chrome keys do not act. */
-    modalOpen: boolean;
-    /** `event.defaultPrevented` when the listener ran: the canvas (or the modeler) handled the key. */
-    defaultPrevented: boolean;
-}
-type KeyAction = ChromeKey | "closeMenu";
-interface KeyDecision {
-    /** What the shell executes; `undefined` = nothing. */
-    action?: KeyAction;
-    preventDefault: boolean;
-    stopPropagation: boolean;
-}
-/**
- * The key rules of guide §5.8 and §13.5 in one place:
- * 1. Escape with the menu open: `closeMenu`, prevented; in the IDE host stopped whenever the menu
- *    or a dialog/popover is open. During IME composition Escape belongs to the IME: no `closeMenu`.
- * 2. Zoom keys: executed and prevented unless composing, in a text field or with a modal dialog;
- *    in the IDE host always stopped, also when not executed (VS Code must never zoom the window).
- * 3. Shift+1: `fit` under the same conditions; otherwise untouched (it types "!").
- * 4. IDE host, text field, undo/redo key: stopped only (the field keeps its native undo).
- * 5. IDE host, `defaultPrevented`: stopped (the canvas handled it; VS Code must not run it again).
- * Everything else passes untouched. `stopPropagation` is only ever true in the IDE host.
- */
-declare function decideKey(event: KeyLike, context: KeyContext): KeyDecision;
-/** The keyboard the user sits at; decides the shortcut labels (guide §5.8). */
-type Platform = "mac" | "other";
-/** The `navigator` fields `detectPlatform` reads. */
-interface NavigatorLike {
-    platform?: string | undefined;
-    userAgentData?: {
-        platform?: string | undefined;
-    } | undefined;
-}
-/**
- * `mac` when `userAgentData.platform ?? platform` matches `/mac/i`, else `other`; `other` without a
- * navigator. Read it in the webview or page itself, never from the extension host (VS Code Remote).
- */
-declare function detectPlatform(navigator?: NavigatorLike | undefined): Platform;
-/**
- * The tooltip chip text: macOS `⌘+`, `⌘−` (U+2212), `⌘0`, `⇧1`; elsewhere `Ctrl+Plus`,
- * `Ctrl+Minus`, `Ctrl+0`, `Shift+1` with the key names of the messages table.
- */
-declare function shortcutLabel(key: ChromeKey, platform: Platform, keyNames: ShellMessages["keyNames"]): string;
-/**
- * The `aria-keyshortcuts` value (WAI-ARIA names): zoom in `Meta+= Meta+Plus`, zoom out `Meta+-`,
- * 100 % `Meta+0`, fit `Shift+1`; outside macOS `Control` instead of `Meta`.
- */
-declare function ariaKeyShortcuts(key: ChromeKey, platform: Platform): string;
-/**
- * The `aria-keyshortcuts` value (WAI-ARIA names, guide §5.6) for a shortcut chip label: `"L"` →
- * `"L"`, `"⇧L"` → `"Shift+L"`, `"⌘⇧Z"` → `"Meta+Shift+Z"`, `"Ctrl+Shift+E"` → `"Control+Shift+E"`,
- * `"Del"` → `"Delete"`, `"Ctrl++"` → `"Control+Plus"`. `undefined` for a label that is not one key
- * combination (`"G then D"`, `"1–9"`, empty).
- */
-declare function ariaKeyShortcutsFromLabel(label: string): string | undefined;
-
-export { type ChromeKey as C, type KeyAction as K, type NavigatorLike as N, type Platform as P, type ShellMessageOverrides as S, TEXT_FIELD_SELECTOR as T, type KeyContext as a, type KeyDecision as b, type KeyLike as c, type ShellMessages as d, ariaKeyShortcuts as e, ariaKeyShortcutsFromLabel as f, decideKey as g, defaultMessages as h, detectPlatform as i, isUndoRedoKey as j, matchChromeKey as m, resolveMessages as r, shortcutLabel as s };

package/dist/types-B6NfkiUG.d.cts

@@ -1,66 +0,0 @@
-/** A point in pixels or diagram coordinates, as the context says. */
-interface Point {
-    x: number;
-    y: number;
-}
-interface Size {
-    width: number;
-    height: number;
-}
-/** A rectangle; content bounds and viewboxes are in diagram coordinates. */
-interface Bounds {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-}
-/** A viewbox together with the scale diagram-js shows it at (`canvas.viewbox().scale`). */
-interface ScaledViewbox extends Bounds {
-    scale: number;
-}
-/** Distances in pixels from the edges of the modeler's container. */
-interface Insets {
-    top: number;
-    right: number;
-    bottom: number;
-    left: number;
-}
-/**
- * The host column of guide §5.2: `ide` is a VS Code webview (later IntelliJ), `web` a Miragon web
- * app that owns its page, `embedded` a modeler inside a foreign page (designIQ, modeler-api hosts).
- */
-type ShellHost = "ide" | "web" | "embedded";
-/** The `data-chrome` names of the islands (guide §5.2, §13.4). `primary` is reserved for the web app. */
-type ChromeIsland = "menu" | "palette" | "primary" | "zoom" | "problems" | "legend" | "inspector" | "status";
-declare const CHROME_ISLANDS: readonly ChromeIsland[];
-/** Where the palette sits: in the top row, or in the second row below it (guide §5.15). */
-type PaletteRow = "top" | "second-row";
-/**
- * What the zoom panel and the chrome keys act on. The diagram-js viewport implements it; the DOM
- * shell only talks to this interface.
- */
-interface ZoomTarget {
-    /** The current zoom, 1 = 100 % (diagram-js `canvas.zoom()`, rounded to three decimals). */
-    zoom(): number;
-    /** One step on the zoom raster around the container centre (diagram-js `zoomScroll.stepZoom`). */
-    stepZoom(direction: 1 | -1): void;
-    /** 100 % around the container centre. Counts as a user move. */
-    zoomToActual(): void;
-    /** Explicit fit (button, Shift+1, command): animated unless reduced motion, makes the view automatic. */
-    fit(): void;
-    /** False while there is nothing to fit (the content bounds are empty). */
-    canFit(): boolean;
-    /**
-     * Calls `listener` after every viewbox change and whenever `canFit()` may have changed, possibly
-     * several times per frame. Returns the unsubscribe function.
-     */
-    onChange(listener: () => void): () => void;
-}
-/** The persisted view (VS Code `setState`): JSON-serializable. */
-interface ViewportState {
-    viewbox: Bounds;
-    /** The user zoomed or panned since the last fit; a resize no longer refits. */
-    userMoved: boolean;
-}
-
-export { type Bounds as B, CHROME_ISLANDS as C, type Insets as I, type PaletteRow as P, type ScaledViewbox as S, type ViewportState as V, type ZoomTarget as Z, type ChromeIsland as a, type Point as b, type ShellHost as c, type Size as d };

package/dist/types-B6NfkiUG.d.ts

@@ -1,66 +0,0 @@
-/** A point in pixels or diagram coordinates, as the context says. */
-interface Point {
-    x: number;
-    y: number;
-}
-interface Size {
-    width: number;
-    height: number;
-}
-/** A rectangle; content bounds and viewboxes are in diagram coordinates. */
-interface Bounds {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-}
-/** A viewbox together with the scale diagram-js shows it at (`canvas.viewbox().scale`). */
-interface ScaledViewbox extends Bounds {
-    scale: number;
-}
-/** Distances in pixels from the edges of the modeler's container. */
-interface Insets {
-    top: number;
-    right: number;
-    bottom: number;
-    left: number;
-}
-/**
- * The host column of guide §5.2: `ide` is a VS Code webview (later IntelliJ), `web` a Miragon web
- * app that owns its page, `embedded` a modeler inside a foreign page (designIQ, modeler-api hosts).
- */
-type ShellHost = "ide" | "web" | "embedded";
-/** The `data-chrome` names of the islands (guide §5.2, §13.4). `primary` is reserved for the web app. */
-type ChromeIsland = "menu" | "palette" | "primary" | "zoom" | "problems" | "legend" | "inspector" | "status";
-declare const CHROME_ISLANDS: readonly ChromeIsland[];
-/** Where the palette sits: in the top row, or in the second row below it (guide §5.15). */
-type PaletteRow = "top" | "second-row";
-/**
- * What the zoom panel and the chrome keys act on. The diagram-js viewport implements it; the DOM
- * shell only talks to this interface.
- */
-interface ZoomTarget {
-    /** The current zoom, 1 = 100 % (diagram-js `canvas.zoom()`, rounded to three decimals). */
-    zoom(): number;
-    /** One step on the zoom raster around the container centre (diagram-js `zoomScroll.stepZoom`). */
-    stepZoom(direction: 1 | -1): void;
-    /** 100 % around the container centre. Counts as a user move. */
-    zoomToActual(): void;
-    /** Explicit fit (button, Shift+1, command): animated unless reduced motion, makes the view automatic. */
-    fit(): void;
-    /** False while there is nothing to fit (the content bounds are empty). */
-    canFit(): boolean;
-    /**
-     * Calls `listener` after every viewbox change and whenever `canFit()` may have changed, possibly
-     * several times per frame. Returns the unsubscribe function.
-     */
-    onChange(listener: () => void): () => void;
-}
-/** The persisted view (VS Code `setState`): JSON-serializable. */
-interface ViewportState {
-    viewbox: Bounds;
-    /** The user zoomed or panned since the last fit; a resize no longer refits. */
-    userMoved: boolean;
-}
-
-export { type Bounds as B, CHROME_ISLANDS as C, type Insets as I, type PaletteRow as P, type ScaledViewbox as S, type ViewportState as V, type ZoomTarget as Z, type ChromeIsland as a, type Point as b, type ShellHost as c, type Size as d };