mossmd 0.8.1

package/dist/editor.d.ts

@@ -0,0 +1,219 @@
+import { type MutableRefObject } from 'react';
+import { type Extension } from '@codemirror/state';
+import { type LanguageDescription } from '@codemirror/language';
+import { type MossImageIcons, type MossImagesConfig as ImagesConfig } from './features/image';
+import { type MossFileBlockIcons, type MossFileBlocksConfig } from './features/file-blocks';
+import { type WikiLinksConfig } from './features/wiki-links';
+import { type MossSlashCommandsConfig } from './features/slash-commands';
+import { type CollabAdapter } from './collab';
+import { type MossCustomSyntax } from './syntax';
+import { type MossSearchPanelPosition } from './features/search';
+import type { InlinePreviewConfig } from './core/inline-preview';
+import type { MossTablesConfig as TablesConfig } from './features/table';
+import { type MossFileUploadConfig, type MossUploadIcons } from './features/upload';
+export interface MossMDHandle {
+    focus: () => void;
+    undo: () => void;
+    redo: () => void;
+    openSearch: (query?: string) => void;
+    closeSearch: () => void;
+    /**
+     * Scroll the first match of `query` into view with a brief fade-out
+     * highlight — no search panel, no cursor movement. Designed for
+     * navigation cases like "open this atom from a search result and
+     * take me to the relevant paragraph". Matches the behavior of
+     * `initialRevealText` but as an imperative action after mount.
+     */
+    revealText: (query: string) => void;
+    isSearchOpen: () => boolean;
+    getMarkdown: () => string;
+    getContentDOM: () => HTMLElement | null;
+    /**
+     * Toggle read-only ("reading") mode imperatively. Equivalent to
+     * flipping the `readOnly` prop, but usable from outside React's
+     * render cycle (e.g. a toolbar button wired through the handle). The
+     * change is applied via a CM6 `Compartment` reconfigure — no remount,
+     * so scroll position and search state are preserved.
+     */
+    setReadOnly: (readOnly: boolean) => void;
+    setCollabAdapter: (adapter: CollabAdapter) => Promise<void>;
+}
+export interface MossMDIconsConfig {
+    /** Icons rendered by image blocks and their inline controls. */
+    image?: Partial<MossImageIcons>;
+    /** Icons rendered by standalone file link blocks. */
+    file?: Partial<MossFileBlockIcons>;
+    /** Icons rendered by transient upload progress blocks. */
+    upload?: Partial<MossUploadIcons>;
+}
+export interface MossMDProps {
+    /**
+     * Opaque identity for the document. Swapping `documentId` tears down
+     * and re-mounts the view so cursor / undo state from a previous
+     * document doesn't leak. If omitted, the initial `markdownSource`
+     * value is used as the identity — which means mounting a different
+     * string produces a fresh editor.
+     */
+    documentId?: string;
+    /**
+     * The markdown document to open the editor on. Used only at mount
+     * time — the editor is the source of truth for the doc after that.
+     * To swap documents, change `documentId`.
+     */
+    markdownSource: string;
+    /**
+     * If set, opens the search panel on mount with this query pre-filled.
+     * Useful for landing the reader on a search hit — the user sees their
+     * query already active without re-typing.
+     */
+    initialSearchText?: string | null;
+    /**
+     * Where the find-in-document controls appear inside the CodeMirror
+     * editor chrome. Defaults to `top`.
+     */
+    searchPanelPosition?: MossSearchPanelPosition;
+    /**
+     * If set, reveals the first match of this query in the document with
+     * a brief scroll-into-view and fade-out highlight — no search panel,
+     * no cursor movement. Less intrusive alternative to
+     * `initialSearchText` for "open an atom from a search result and take
+     * me to the relevant paragraph" flows.
+     *
+     * The matcher falls back progressively — exact string, whitespace-
+     * collapsed variant, individual lines, then truncated prefixes (140
+     * and 80 chars) — so hits from LLM-generated snippets or chunked
+     * search excerpts still resolve even when they don't match the
+     * source byte-for-byte.
+     */
+    initialRevealText?: string | null;
+    /**
+     * Skip any implicit focus behavior on mount. Defaults to `false`;
+     * the CM6 view doesn't auto-focus today, but consumers wiring this
+     * into a larger reader often want an explicit escape hatch in case
+     * a future extension or keymap does.
+     */
+    blurEditorOnMount?: boolean;
+    /**
+     * Render the editor in read-only ("reading") mode: the whole document
+     * stays rendered (no source ever reveals under a caret), typing /
+     * paste / table editing are disabled, and clicking a link opens it
+     * instead of placing a caret. Checkboxes remain toggleable, and
+     * find-in-document still works.
+     *
+     * Unlike `extensions`, this is NOT captured at mount — it's backed by
+     * a CM6 `Compartment`, so toggling it reconfigures the live view in
+     * place (scroll position preserved) rather than remounting. Defaults
+     * to `false`.
+     */
+    readOnly?: boolean;
+    /**
+     * Called on every doc change with the current markdown. Fires for
+     * both user edits and any dispatches the editor produces internally
+     * (e.g. checkbox toggles, tight-list continuations).
+     */
+    onMarkdownChange?: (markdown: string) => void;
+    /**
+     * Called when an IME composition session starts or ends. `true` means
+     * composition is active; `false` is sent for both normal completion and
+     * cancellation. The callback observes the input lifecycle and does not
+     * change the editor's composition handling.
+     */
+    onCompositionChange?: (composing: boolean) => void;
+    /**
+     * Called when the user plain-clicks a rendered link in the
+     * inline-preview output. Receives the link's URL as written in the
+     * source markdown. Defaults to `window.open(url, '_blank',
+     * 'noopener,noreferrer')`. Provide your own handler to route opens
+     * through a platform shell (Tauri, Capacitor, Electron).
+     */
+    onLinkClick?: (url: string) => void;
+    /**
+     * A mutable ref the editor attaches its imperative handle to. Use
+     * this for side-effectful ops that don't fit a prop/callback model
+     * — keyboard-driven undo/redo, opening the search panel on Ctrl+F
+     * from outside the editor, pulling the current markdown on demand.
+     */
+    editorHandleRef?: MutableRefObject<MossMDHandle | null>;
+    /**
+     * Grammars to load for fenced code blocks whose info string matches.
+     * `@codemirror/lang-markdown` lazy-imports each grammar on first use
+     * (no cost until a matching fence appears), so passing a large list
+     * is fine. Defaults to `[]` — fences render as plain monospace.
+     *
+     * For a curated ~20-language default, install the peers and import
+     * the registry:
+     *
+     * ```ts
+     * import { MOSS_CODE_LANGUAGES } from 'mossmd/code-languages';
+     * <MossMD codeLanguages={MOSS_CODE_LANGUAGES} ... />
+     * ```
+     *
+     * Or build your own list from the `LanguageDescription` factory
+     * exported by `@codemirror/language`.
+     */
+    codeLanguages?: readonly LanguageDescription[];
+    /**
+     * Extra CodeMirror 6 extensions appended to the built-in set.
+     * This is the hook for layering in additional plugins — autocomplete
+     * sources, custom decorations (wiki-links, block refs, footnotes),
+     * domain-specific keymaps, collaboration (yjs), vim mode, etc.
+     *
+     * Order matters for CM6 precedence. Use `Prec.high/default/low` from
+     * `@codemirror/state` to explicitly position an extension relative
+     * to the built-ins when it matters (e.g., custom keybindings that
+     * need to beat the default keymap).
+     *
+     * Extensions are captured once at mount time (keyed on
+     * `documentId ?? markdownSource`). Changing the array reference
+     * without changing the document identity does NOT re-apply — pass
+     * a stable reference (via `useMemo` or a module-level constant)
+     * unless you intend a remount.
+     *
+     * @example
+     * ```ts
+     * import { autocompletion, CompletionContext } from '@codemirror/autocomplete';
+     *
+     * const wikiLinkCompletion = autocompletion({
+     *   override: [(ctx: CompletionContext) => {
+     *     const match = ctx.matchBefore(/\[\[\w*$/);
+     *     if (!match) return null;
+     *     return {
+     *       from: match.from + 2,
+     *       options: atomStore.list().map(a => ({ label: a.title })),
+     *     };
+     *   }],
+     * });
+     *
+     * <MossMD extensions={[wikiLinkCompletion]} ... />
+     * ```
+     */
+    extensions?: readonly Extension[];
+    customSyntax?: readonly MossCustomSyntax[];
+    inlinePreviewConfig?: InlinePreviewConfig;
+    /**
+     * Unified icon overrides for the built-in React editor surface.
+     * Feature-level icon configs still work and take precedence.
+     */
+    icons?: MossMDIconsConfig;
+    /** Configure the floating edit control rendered on image blocks. */
+    imagesConfig?: ImagesConfig;
+    /** Configure rendered file link blocks. */
+    fileBlocksConfig?: MossFileBlocksConfig;
+    tablesConfig?: TablesConfig;
+    wikiLinksConfig?: WikiLinksConfig;
+    slashCommandsConfig?: MossSlashCommandsConfig;
+    fileUpload?: MossFileUploadConfig;
+    collabAdapter?: CollabAdapter;
+}
+/**
+ * React wrapper around a CodeMirror 6 editor configured for markdown
+ * editing with Obsidian-style inline live preview.
+ *
+ * Remember to import the accompanying CSS:
+ *
+ * ```ts
+ * import 'mossmd/editor.css';
+ * ```
+ */
+export declare function MossMD({ markdownSource, documentId, initialSearchText, searchPanelPosition, initialRevealText, blurEditorOnMount, readOnly, onMarkdownChange, onCompositionChange, onLinkClick, editorHandleRef, codeLanguages, extensions, customSyntax, inlinePreviewConfig, icons, imagesConfig, fileBlocksConfig, tablesConfig, wikiLinksConfig, slashCommandsConfig, fileUpload, collabAdapter, }: MossMDProps): import("react").JSX.Element;
+//# sourceMappingURL=editor.d.ts.map

package/dist/editor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"editor.d.ts","sourceRoot":"","sources":["../src/editor.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAqB,KAAK,gBAAgB,EAAE,MAAM,OAAO,CAAC;AAWjE,OAAO,EAML,KAAK,SAAS,EACf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAGL,KAAK,mBAAmB,EACzB,MAAM,sBAAsB,CAAC;AA4B9B,OAAO,EAEL,KAAK,cAAc,EACnB,KAAK,gBAAgB,IAAI,YAAY,EACtC,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAEL,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EAC1B,MAAM,wBAAwB,CAAC;AAKhC,OAAO,EAEL,KAAK,eAAe,EACrB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAEL,KAAK,uBAAuB,EAC7B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAqB,KAAK,aAAa,EAAE,MAAM,UAAU,CAAC;AACjE,OAAO,EAAsB,KAAK,gBAAgB,EAAE,MAAM,UAAU,CAAC;AACrE,OAAO,EAEL,KAAK,uBAAuB,EAC7B,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,gBAAgB,IAAI,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACzE,OAAO,EAEL,KAAK,oBAAoB,EACzB,KAAK,eAAe,EACrB,MAAM,mBAAmB,CAAC;AAe3B,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,IAAI,EAAE,MAAM,IAAI,CAAC;IACjB,IAAI,EAAE,MAAM,IAAI,CAAC;IACjB,UAAU,EAAE,CAAC,KAAK,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IACrC,WAAW,EAAE,MAAM,IAAI,CAAC;IACxB;;;;;;OAMG;IACH,UAAU,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACpC,YAAY,EAAE,MAAM,OAAO,CAAC;IAC5B,WAAW,EAAE,MAAM,MAAM,CAAC;IAC1B,aAAa,EAAE,MAAM,WAAW,GAAG,IAAI,CAAC;IACxC;;;;;;OAMG;IACH,WAAW,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,CAAC;IACzC,gBAAgB,EAAE,CAAC,OAAO,EAAE,aAAa,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7D;AAED,MAAM,WAAW,iBAAiB;IAChC,gEAAgE;IAChE,KAAK,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;IAChC,qDAAqD;IACrD,IAAI,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACnC,0DAA0D;IAC1D,MAAM,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,WAAW;IAC1B;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,mBAAmB,CAAC,EAAE,uBAAuB,CAAC;IAE9C;;;;;;;;;;;;OAYG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;IAE9C;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,CAAC,SAAS,EAAE,OAAO,KAAK,IAAI,CAAC;IAEnD;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IAEpC;;;;;OAKG;IACH,eAAe,CAAC,EAAE,gBAAgB,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;IAExD;;;;;;;;;;;;;;;;OAgBG;IACH,aAAa,CAAC,EAAE,SAAS,mBAAmB,EAAE,CAAC;IAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,UAAU,CAAC,EAAE,SAAS,SAAS,EAAE,CAAC;IAClC,YAAY,CAAC,EAAE,SAAS,gBAAgB,EAAE,CAAC;IAC3C,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAC1C;;;OAGG;IACH,KAAK,CAAC,EAAE,iBAAiB,CAAC;IAC1B,oEAAoE;IACpE,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,2CAA2C;IAC3C,gBAAgB,CAAC,EAAE,oBAAoB,CAAC;IACxC,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,mBAAmB,CAAC,EAAE,uBAAuB,CAAC;IAC9C,UAAU,CAAC,EAAE,oBAAoB,CAAC;IAClC,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B;AAED;;;;;;;;;GASG;AACH,wBAAgB,MAAM,CAAC,EACrB,cAAc,EACd,UAAU,EACV,iBAAiB,EACjB,mBAA2B,EAC3B,iBAAiB,EACjB,iBAAiB,EACjB,QAAgB,EAChB,gBAAgB,EAChB,mBAAmB,EACnB,WAAW,EACX,eAAe,EACf,aAAoC,EACpC,UAA6B,EAC7B,YAAiB,EACjB,mBAAwB,EACxB,KAAU,EACV,YAAiB,EACjB,gBAAqB,EACrB,YAAiB,EACjB,eAAoB,EACpB,mBAAmB,EACnB,UAAU,EACV,aAAiC,GAClC,EAAE,WAAW,+BAkYb"}