@bendyline/squisq-editor-react 2.3.4 → 2.4.1

package/dist/{shell-C-KkTBz7.d.ts → shell-CU4GpGuq.d.ts}

@@ -1,6 +1,6 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { ReactNode } from 'react';
-import { Doc, MediaProvider, Theme } from '@bendyline/squisq/schemas';
+import { Doc, MediaProvider, ViewportPreset, Theme } from '@bendyline/squisq/schemas';
 import { MarkdownDocument } from '@bendyline/squisq/markdown';
 import { ContentContainer } from '@bendyline/squisq/storage';
 import { DocumentVersionManager, SaveVersionOptions, SaveVersionResult, PrunePolicy } from '@bendyline/squisq/versions';
@@ -205,6 +205,15 @@ interface EditorState {
      * host may allow the recorder modal but not want a prompter surface.
      */
     allowNarrate: boolean;
+    /**
+     * Whether the Write view transparently unwraps hard-wrapped paragraph
+     * prose for editing and re-applies the document's detected wrap
+     * convention when serializing (see `detectMarkdownWrapState`). Without
+     * it, a hard-wrapped document renders as one choppy paragraph per
+     * physical line in Write view — and the first edit persists that
+     * chopped structure. Defaults to true; document layout mode only.
+     */
+    preserveSourceWrapping: boolean;
     /**
      * Document layout mode. `'document'` (default) edits the whole document;
      * `'block'` activates the block-at-a-time card view. Initialized from the
@@ -357,6 +366,13 @@ interface EditorContextValue extends EditorState, EditorActions {
      * host DOES resolve is unsupported. Executable schemes stay refused.
      */
     linkSchemes: readonly string[] | undefined;
+    /**
+     * File name the host opened this document as (e.g. `Longview Plan.md`), if
+     * any. Used as a display-title fallback — for example, the header of a
+     * heading-less leading "preamble" block in the slideshow preview when the
+     * document has no frontmatter `title:`.
+     */
+    fileName: string | undefined;
 }
 type ImageDisplayMode = 'inline' | 'thumbnail';
 /**
@@ -440,6 +456,12 @@ interface EditorProviderProps {
      * frontmatter-forced `display-mode: narrate` clamps back to video.
      */
     allowNarrate?: boolean;
+    /**
+     * Whether the Write view transparently unwraps hard-wrapped prose and
+     * re-applies the detected wrap convention on save. Defaults to true;
+     * pass false for literal behavior (Tiptap sees the wrapped source).
+     */
+    preserveSourceWrapping?: boolean;
     /**
      * File name (e.g. `foo.ts`) or bare extension — used to pick a Monaco
      * language and decide between markdown vs. code mode.
@@ -533,7 +555,7 @@ interface ViewPreferences {
     /** Document vs. block-at-a-time layout. */
     layoutMode?: LayoutMode;
 }
-declare function EditorProvider({ initialMarkdown, initialView, articleId, colorScheme: initialColorScheme, workspaceContainer, allowVersioning, versionBasename, versioningPrunePolicy, versioningAutoSaveIdleMs, onSaveVersion, mediaProvider, imageDisplayMode, mentionProvider, documentLinkProvider, linkSchemes, allowRecording, allowNarrate, fileName, language, findMode: controlledFindMode, onFindModeChange, inlinePreview, showStatusBar, outline, blockTags, blockTagVisibility: initialBlockTagVisibility, themeInheritance, layoutMode, viewPreferences, onViewPreferencesChange, children, }: EditorProviderProps): react_jsx_runtime.JSX.Element;
+declare function EditorProvider({ initialMarkdown, initialView, articleId, colorScheme: initialColorScheme, workspaceContainer, allowVersioning, versionBasename, versioningPrunePolicy, versioningAutoSaveIdleMs, onSaveVersion, mediaProvider, imageDisplayMode, mentionProvider, documentLinkProvider, linkSchemes, allowRecording, allowNarrate, preserveSourceWrapping, fileName, language, findMode: controlledFindMode, onFindModeChange, inlinePreview, showStatusBar, outline, blockTags, blockTagVisibility: initialBlockTagVisibility, themeInheritance, layoutMode, viewPreferences, onViewPreferencesChange, children, }: EditorProviderProps): react_jsx_runtime.JSX.Element;
 
 /**
  * Host-supplied context sections rendered INSIDE the Monaco (raw/code)
@@ -617,14 +639,48 @@ interface WriteCanvasSettings {
     textSize?: number;
     /** Unitless line-height multiplier for body text. */
     lineSpacing?: number;
+    /**
+     * CSS `font-family` value for Write-canvas headings. Applies only when no
+     * theme font override is active (the theme's title font always wins) — see
+     * the heading rule in `styles/editor.css`. Omit to inherit as before.
+     */
+    headerFont?: string;
+    /**
+     * CSS `font-family` value for Write-canvas body text. Applies only when no
+     * theme font override is active (the theme's body font always wins) — see
+     * the editor rule in `styles/editor.css`. Omit to inherit as before.
+     */
+    bodyFont?: string;
 }
 
+/**
+ * Semantic embedding mode for the editor shell.
+ *
+ * The default document mode exposes the full multi-view authoring surface.
+ * Chat mode keeps the composer in Write view and removes document-level
+ * authoring controls that do not belong in a message composer.
+ */
+type EditorHostMode = 'document' | 'chat';
+
 interface EditorShellProps {
     /** Initial markdown content */
     initialMarkdown?: string;
-    /** Initial active view */
     /** Initial active view (default: 'wysiwyg') */
     initialView?: EditorView;
+    /**
+     * Semantic mode for the surface embedding the editor. `'document'`
+     * (default) exposes the normal multi-view authoring shell. `'chat'`
+     * starts and stays in Write view through the shell's own controls, hides
+     * the view tabs, and removes document-level layout, transform, view, and
+     * settings controls from the toolbar.
+     */
+    hostMode?: EditorHostMode;
+    /**
+     * Viewport preset used by slideshow/video preview when neither the document
+     * nor the user has selected one. Defaults to landscape. Hosts may update it
+     * responsively; explicit document and user choices remain authoritative.
+     */
+    defaultViewportPreset?: ViewportPreset;
     /** Article ID for Doc generation */
     articleId?: string;
     /** Base path for media URLs in preview */
@@ -712,6 +768,11 @@ interface EditorShellProps {
     onSaveVersion?: (result: SaveVersionResult) => void;
     /** Show the Files toggle in the toolbar. Defaults to true when mediaProvider is passed. */
     showFilesToggle?: boolean;
+    /**
+     * Whether the Files panel offers browser downloads for its binary entries.
+     * Defaults to true. Pass false to remove the built-in download affordance.
+     */
+    allowBinaryDownloads?: boolean;
     /** Content rendered at the left edge of the toolbar, before the view tabs. */
     toolbarSlotLeft?: ReactNode;
     /** Content rendered after the formatting controls (in the middle area of the toolbar). */
@@ -733,7 +794,7 @@ interface EditorShellProps {
      */
     allowPresentationWindow?: boolean;
     /**
-     * Whether Use mode may enter browser full screen. Defaults to true. Disable
+     * Whether Use mode may enter native full screen. Defaults to true. Disable
      * this in embedded hosts whose webview does not support the Fullscreen API.
      */
     allowPresentationFullscreen?: boolean;
@@ -870,6 +931,15 @@ interface EditorShellProps {
      * `allowRecording` + a `mediaProvider`.
      */
     allowNarrate?: boolean;
+    /**
+     * Whether the Write view transparently unwraps hard-wrapped paragraph
+     * prose for editing and re-applies the document's detected wrap
+     * convention when serializing. Defaults to true — without it, a
+     * hard-wrapped document renders one choppy paragraph per physical line
+     * in Write view and the first edit persists that chopped structure.
+     * Pass `false` for literal behavior. Document layout mode only.
+     */
+    preserveSourceWrapping?: boolean;
     /**
      * Placeholder text shown in the WYSIWYG editor while the document is
      * empty. When omitted, the editor rotates through its own generic
@@ -995,7 +1065,7 @@ interface EditorShellProps {
  * Complete markdown editor shell with toolbar, view switcher, and three
  * editing modes: Raw (Monaco), WYSIWYG (Tiptap), and Preview.
  */
-declare function EditorShell({ initialMarkdown, initialView, articleId, basePath, onChange, onLinkClick, colorScheme, className, height, minHeight, maxHeight, mediaProvider, workspaceContainer, allowVersioning, versionBasename, versioningPrunePolicy, versioningAutoSaveIdleMs, onSaveVersion, showFilesToggle, toolbarSlotLeft, toolbarSlotAfterActions, toolbarSlotRight, statusBarSlotRight, showPlayTab, allowPresentationWindow, allowPresentationFullscreen, allowPrint, submitOnEnter, codeContext, fullWidth, uxFont, thinMargins, writeCanvasSettings, showStatusBar, imageDisplayMode, fileName, language, findMode, onFindModeChange, mentionProvider, documentLinkProvider, linkSchemes, allowRecording, allowNarrate, placeholder, readOnly, imageSrc, imageAlt, imageMode, imageEditorContainer, onImageExport, inlinePreview, inlinePreviewWidth, outline, outlineWidth, blockTags, blockTagVisibility, themeInheritance, viewPreferences, onViewPreferencesChange, themeOverride, }: EditorShellProps): react_jsx_runtime.JSX.Element;
+declare function EditorShell({ initialMarkdown, initialView, hostMode, defaultViewportPreset, articleId, basePath, onChange, onLinkClick, colorScheme, className, height, minHeight, maxHeight, mediaProvider, workspaceContainer, allowVersioning, versionBasename, versioningPrunePolicy, versioningAutoSaveIdleMs, onSaveVersion, showFilesToggle, allowBinaryDownloads, toolbarSlotLeft, toolbarSlotAfterActions, toolbarSlotRight, statusBarSlotRight, showPlayTab, allowPresentationWindow, allowPresentationFullscreen, allowPrint, submitOnEnter, codeContext, fullWidth, uxFont, thinMargins, writeCanvasSettings, showStatusBar, imageDisplayMode, fileName, language, findMode, onFindModeChange, mentionProvider, documentLinkProvider, linkSchemes, allowRecording, allowNarrate, preserveSourceWrapping, placeholder, readOnly, imageSrc, imageAlt, imageMode, imageEditorContainer, onImageExport, inlinePreview, inlinePreviewWidth, outline, outlineWidth, blockTags, blockTagVisibility, themeInheritance, viewPreferences, onViewPreferencesChange, themeOverride, }: EditorShellProps): react_jsx_runtime.JSX.Element;
 
 /**
  * RawEditor
@@ -1081,4 +1151,4 @@ interface PreviewPanelProps {
  */
 declare function PreviewPanel({ basePath, className, workspaceContainer, onLinkClick, }: PreviewPanelProps): react_jsx_runtime.JSX.Element;
 
-export { type BlockTagVisibility as B, type CodeContext as C, type DocumentLinkCandidate as D, type EditorActions as E, type ImageDisplayMode as I, type LayoutMode as L, type MentionCandidate as M, PreviewPanel as P, RawEditor as R, type SceneTextChannel as S, type ThemeInheritance as T, type ViewPreferences as V, type WriteCanvasSettings as W, type CodeContextSection as a, type DocumentLinkProvider as b, type EditorColorScheme as c, type EditorContextValue as d, type EditorMode as e, EditorProvider as f, type EditorProviderProps as g, EditorShell as h, type EditorShellProps as i, type EditorState as j, type EditorView as k, type MentionProvider as l, type PreviewPanelProps as m, type RawEditorProps as n, WysiwygEditor as o, type WysiwygEditorProps as p, useEditorContext as u };
+export { type BlockTagVisibility as B, type CodeContext as C, type DocumentLinkCandidate as D, type EditorHostMode as E, type ImageDisplayMode as I, type LayoutMode as L, type MentionCandidate as M, PreviewPanel as P, RawEditor as R, type SceneTextChannel as S, type ThemeInheritance as T, type ViewPreferences as V, type WriteCanvasSettings as W, type CodeContextSection as a, type DocumentLinkProvider as b, type EditorActions as c, type EditorColorScheme as d, type EditorContextValue as e, type EditorMode as f, EditorProvider as g, type EditorProviderProps as h, EditorShell as i, type EditorShellProps as j, type EditorState as k, type EditorView as l, type MentionProvider as m, type PreviewPanelProps as n, type RawEditorProps as o, WysiwygEditor as p, type WysiwygEditorProps as q, useEditorContext as u };