quoin-editor 0.4.2 → 1.0.1

package/dist/view-controller-y4cb60ue.d.ts

@@ -0,0 +1,105 @@
+import { c as EditorState, D as Decoration, a as Editor, T as Transaction, b as Command } from './types-C6_QkXzy.js';
+import { a as Selection, b as AtomNode, P as Pos } from './types-DULc8wwg.js';
+
+type Spoken = {
+    readonly message: string;
+    readonly state: EditorState | undefined;
+    readonly serial: number;
+    readonly at: number;
+};
+type Announcer = {
+    announce(message: string): void;
+    current(): Spoken | null;
+    subscribe(listener: () => void): () => void;
+};
+
+type NodeReveal = {
+    /** Marks a block a press is selecting, which is under the pointer already. */
+    pressed(block: string): void;
+    /** Forgets the block shown once the selection leaves it, however it leaves, so coming back brings it into view. */
+    follow(selection: Selection | null): void;
+    /** Brings the block into view once; a change made here also brings in the block a settle left where it was. */
+    show(selection: Selection | null, local?: boolean): void;
+    /** Counts the block a selection holds as shown, and as owed to the next change made here if it was not shown yet. */
+    settle(selection: Selection | null): void;
+};
+
+type AtomRenderer = (node: AtomNode, doc: Document) => HTMLElement;
+type WidgetRenderer = (decoration: Extract<Decoration, {
+    kind: 'widget';
+}>, doc: Document) => HTMLElement;
+type RenderOptions = {
+    atoms?: Readonly<Record<string, AtomRenderer>>;
+    widgets?: Readonly<Record<string, WidgetRenderer>>;
+    atomText?: (node: AtomNode) => string;
+};
+
+type KeyInterceptor = (event: KeyboardEvent) => boolean;
+
+type FocusTarget = Pos | 'start' | 'end';
+
+type HostEntry = {
+    readonly block: string;
+    readonly region: string;
+    readonly element: HTMLElement;
+};
+type HostRegistry = {
+    register(block: string, region: string, element: HTMLElement): () => void;
+    get(block: string, region: string): HTMLElement | undefined;
+    locate(node: Node | null): HostEntry | null;
+    all(): IterableIterator<HostEntry>;
+};
+declare function hostKey(block: string, region: string): string;
+
+type ViewControllerOptions = {
+    editor: Editor;
+    flush?: (fn: () => void) => void;
+    render?: RenderOptions;
+    onFiles?: (files: File[], at: Pos | null) => void;
+    readOnly?: boolean;
+    /** Which key is Mod. Defaults to the platform, as the editor's own isMac does, and must agree with it. */
+    isMac?: boolean;
+};
+declare class ViewController {
+    #private;
+    readonly editor: Editor;
+    readonly registry: HostRegistry;
+    readonly keyInterceptors: Set<KeyInterceptor>;
+    readonly nodeReveal: NodeReveal;
+    readonly announcer: Announcer;
+    readonly isMac: boolean;
+    readonly onFiles: ViewControllerOptions['onFiles'];
+    goalX: number | null;
+    nativeVerticalMove: boolean;
+    dragging: boolean;
+    composingKey: string | null;
+    constructor(options: ViewControllerOptions);
+    get root(): HTMLElement | null;
+    get readOnly(): boolean;
+    get sink(): HTMLElement | null;
+    get emptyHost(): HTMLElement | null;
+    attach(root: HTMLElement): () => void;
+    registerBlockElement(id: string, element: HTMLElement): () => void;
+    blockElement(id: string): HTMLElement | undefined;
+    blockAt(node: Node): string | undefined;
+    registerSink(element: HTMLElement): () => void;
+    registerEmptyHost(element: HTMLElement): () => void;
+    isEditorElement(element: Element): boolean;
+    decorationsFor(block: string, region: string): readonly Decoration[];
+    dispatch(tr: Transaction): void;
+    edit(change: () => boolean): boolean;
+    afterRender(): void;
+    refreshHosts(): void;
+    run(command: Command): boolean;
+    announce(message: string): void;
+    renderHost(block: string, region: string): void;
+    domSelection(): globalThis.Selection | null;
+    syncSelectionToDom(local?: boolean): void;
+    readSelectionFromDom(): void;
+    focus(target?: FocusTarget): void;
+    setReadOnly(readOnly: boolean): void;
+    subscribeReadOnly(listener: () => void): () => void;
+    destroy(): void;
+}
+
+export { type AtomRenderer as A, type KeyInterceptor as K, type RenderOptions as R, ViewController as V, type WidgetRenderer as W, type ViewControllerOptions as a, hostKey as h };

package/dist/view.cjs

@@ -0,0 +1,23 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+var _chunk6PKVJZQVcjs = require('./chunk-6PKVJZQV.cjs');
+
+
+var _chunkEH5KXQXYcjs = require('./chunk-EH5KXQXY.cjs');
+
+
+var _chunkBTBHHBVRcjs = require('./chunk-BTBHHBVR.cjs');
+
+// src/view-static/QuoinView.tsx
+var _react = require('react');
+function QuoinView({ blocks, blockTypes, highlight, className, ...options }) {
+  const slots = /* @__PURE__ */ new Map();
+  const nodes = _chunkBTBHHBVRcjs.documentNodes.call(void 0, blocks, options, _chunk6PKVJZQVcjs.viewRenderer.call(void 0, { blockTypes, highlight }, slots));
+  return _react.createElement.call(void 0, "div", { className: className ? `quoin-view ${className}` : "quoin-view" }, ..._chunk6PKVJZQVcjs.reactNodes.call(void 0, nodes, slots));
+}
+
+
+
+exports.QuoinView = QuoinView; exports.defineBlock = _chunkEH5KXQXYcjs.defineBlock;
+//# sourceMappingURL=view.cjs.map

package/dist/view.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["view.cjs","../src/view-static/QuoinView.tsx"],"names":[],"mappings":"AAAA;AACE;AACA;AACF,wDAA6B;AAC7B;AACE;AACF,wDAA6B;AAC7B;AACE;AACF,wDAA6B;AAC7B;AACA;ACXA,8BAA8C;AAuCvC,SAAS,SAAA,CAAU,EAAE,MAAA,EAAQ,UAAA,EAAY,SAAA,EAAW,SAAA,EAAW,GAAG,QAAQ,CAAA,EAAmB;AAClG,EAAA,MAAM,MAAA,kBAAQ,IAAI,GAAA,CAA4B,CAAA;AAC9C,EAAA,MAAM,MAAA,EAAQ,6CAAA,MAAc,EAAQ,OAAA,EAAS,4CAAA,EAAe,UAAA,EAAY,UAAU,CAAA,EAAG,KAAK,CAAC,CAAA;AAC3F,EAAA,OAAO,kCAAA,KAAc,EAAO,EAAE,SAAA,EAAW,UAAA,EAAY,CAAA,WAAA,EAAc,SAAS,CAAA,EAAA;AAC9E;ADzB+E;AACA;AACA;AACA","file":"/home/runner/work/quoin-editor/quoin-editor/dist/view.cjs"}

package/dist/view.d.cts

@@ -0,0 +1,40 @@
+import * as react from 'react';
+import { A as AnyBlockDefinition, C as CodeHighlighter } from './registry-CWBOSAHm.cjs';
+export { B as BlockDefinition, d as defineBlock } from './registry-CWBOSAHm.cjs';
+import { Q as QuoinBlock } from './types-DULc8wwg.cjs';
+import { H as HTMLOptions } from './to-html-CNCITCln.cjs';
+import './embed-provider-jXwlRmnp.cjs';
+
+type QuoinViewProps = {
+    blocks: readonly QuoinBlock[];
+    /**
+     * The definitions of the host's own block types, each drawn by its `preview`. Called during a server render, so a
+     * preview of a React Server Component tree must use no client hooks. A type Quoin draws itself keeps Quoin's drawing.
+     */
+    blockTypes?: readonly AnyBlockDefinition[];
+    /** The address of a stored picture or file. One that is no http, https, blob, data or relative address is left out. */
+    resolveAssetUrl?: HTMLOptions['resolveAssetUrl'];
+    /** Its markup is trusted and inserted as it is. */
+    renderMath?: HTMLOptions['renderMath'];
+    /** Highlights the code of code blocks; without it their code is plain text. */
+    highlight?: CodeHighlighter;
+    /** Embeds as links by default, or as sandboxed frames for the pages of known providers. */
+    embeds?: HTMLOptions['embeds'];
+    /** Tried before the built in providers, in order. Only used when `embeds` is `'iframe'`. */
+    embedProviders?: HTMLOptions['embedProviders'];
+    /** The title of a frame given its provider's name, the name itself by default. */
+    frameTitle?: HTMLOptions['frameTitle'];
+    /** The accessible name of a task checkbox whose item has no text, `'Task'` by default. */
+    taskLabel?: HTMLOptions['taskLabel'];
+    className?: string;
+};
+/**
+ * A read-only document drawn with the HTML `toHTML` writes, as React elements. It uses no hook, effect or browser API,
+ * so it renders in a React Server Component and in a static export. Toggles are native `details`. A canvas that is
+ * read-only stays the interactive way to show a document in the browser.
+ */
+declare function QuoinView({ blocks, blockTypes, highlight, className, ...options }: QuoinViewProps): react.DetailedReactHTMLElement<{
+    className: string;
+}, HTMLElement>;
+
+export { AnyBlockDefinition, QuoinView, type QuoinViewProps };

package/dist/view.d.ts

@@ -0,0 +1,40 @@
+import * as react from 'react';
+import { A as AnyBlockDefinition, C as CodeHighlighter } from './registry-CWBOSAHm.js';
+export { B as BlockDefinition, d as defineBlock } from './registry-CWBOSAHm.js';
+import { Q as QuoinBlock } from './types-DULc8wwg.js';
+import { H as HTMLOptions } from './to-html-C5t7xyaM.js';
+import './embed-provider-jXwlRmnp.js';
+
+type QuoinViewProps = {
+    blocks: readonly QuoinBlock[];
+    /**
+     * The definitions of the host's own block types, each drawn by its `preview`. Called during a server render, so a
+     * preview of a React Server Component tree must use no client hooks. A type Quoin draws itself keeps Quoin's drawing.
+     */
+    blockTypes?: readonly AnyBlockDefinition[];
+    /** The address of a stored picture or file. One that is no http, https, blob, data or relative address is left out. */
+    resolveAssetUrl?: HTMLOptions['resolveAssetUrl'];
+    /** Its markup is trusted and inserted as it is. */
+    renderMath?: HTMLOptions['renderMath'];
+    /** Highlights the code of code blocks; without it their code is plain text. */
+    highlight?: CodeHighlighter;
+    /** Embeds as links by default, or as sandboxed frames for the pages of known providers. */
+    embeds?: HTMLOptions['embeds'];
+    /** Tried before the built in providers, in order. Only used when `embeds` is `'iframe'`. */
+    embedProviders?: HTMLOptions['embedProviders'];
+    /** The title of a frame given its provider's name, the name itself by default. */
+    frameTitle?: HTMLOptions['frameTitle'];
+    /** The accessible name of a task checkbox whose item has no text, `'Task'` by default. */
+    taskLabel?: HTMLOptions['taskLabel'];
+    className?: string;
+};
+/**
+ * A read-only document drawn with the HTML `toHTML` writes, as React elements. It uses no hook, effect or browser API,
+ * so it renders in a React Server Component and in a static export. Toggles are native `details`. A canvas that is
+ * read-only stays the interactive way to show a document in the browser.
+ */
+declare function QuoinView({ blocks, blockTypes, highlight, className, ...options }: QuoinViewProps): react.DetailedReactHTMLElement<{
+    className: string;
+}, HTMLElement>;
+
+export { AnyBlockDefinition, QuoinView, type QuoinViewProps };

package/dist/view.js

@@ -0,0 +1,23 @@
+import {
+  reactNodes,
+  viewRenderer
+} from "./chunk-26Q4LSIU.js";
+import {
+  defineBlock
+} from "./chunk-O4Z2WMFF.js";
+import {
+  documentNodes
+} from "./chunk-62WKUAQY.js";
+
+// src/view-static/QuoinView.tsx
+import { createElement } from "react";
+function QuoinView({ blocks, blockTypes, highlight, className, ...options }) {
+  const slots = /* @__PURE__ */ new Map();
+  const nodes = documentNodes(blocks, options, viewRenderer({ blockTypes, highlight }, slots));
+  return createElement("div", { className: className ? `quoin-view ${className}` : "quoin-view" }, ...reactNodes(nodes, slots));
+}
+export {
+  QuoinView,
+  defineBlock
+};
+//# sourceMappingURL=view.js.map

package/dist/view.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/view-static/QuoinView.tsx"],"mappings":";;;;;;;;;;;;AAAA,SAAS,qBAAqC;AAuCvC,SAAS,UAAU,EAAE,QAAQ,YAAY,WAAW,WAAW,GAAG,QAAQ,GAAmB;AAClG,QAAM,QAAQ,oBAAI,IAA4B;AAC9C,QAAM,QAAQ,cAAc,QAAQ,SAAS,aAAa,EAAE,YAAY,UAAU,GAAG,KAAK,CAAC;AAC3F,SAAO,cAAc,OAAO,EAAE,WAAW,YAAY,cAAc,SAAS,KAAK,aAAa,GAAG,GAAG,WAAW,OAAO,KAAK,CAAC;AAC9H;","names":[]}