@bendyline/squisq-editor-react 2.8.0 → 2.10.0

package/dist/{recorder-DFP0Dw4v.d.ts → recorder-GrEh4xE8.d.ts}

@@ -1,7 +1,7 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { Doc, Theme, MediaProvider } from '@bendyline/squisq/schemas';
+import { Doc, Theme, ViewportConfig, MediaProvider } from '@bendyline/squisq/schemas';
 import { ContentContainer } from '@bendyline/squisq/storage';
-import { k as RecorderSource, o as TeleprompterRecordingDeps } from './useNarrationStage-Bk3mdW75.js';
+import { l as RecorderSource, o as TeleprompterRecordingDeps } from './useNarrationStage-B6r9Zlq-.js';
 import { CSSProperties, RefObject } from 'react';
 
 type RecordedMediaKind = 'audio' | 'video';
@@ -31,6 +31,35 @@ interface RecorderNarrationOptions {
     /** Editor plumbing for the narration save pipeline; null hides the checkbox. */
     recording: TeleprompterRecordingDeps | null;
 }
+/**
+ * Everything slides mode needs beyond the base recorder props. Supplying this
+ * with a non-null `doc` surfaces the "Show slides mode" checkbox; when
+ * checked, the dialog expands and the deck occupies the right column while
+ * capture controls stay on the left.
+ */
+interface RecorderSlidesOptions {
+    /** Parsed document the deck is built from. Null hides the checkbox. */
+    doc: Doc | null;
+    /** Theme the slides render with — the same one the preview uses. */
+    theme: Theme;
+    /** Viewport the slides compose at. Defaults to landscape. */
+    viewport?: ViewportConfig;
+    /** Resolves relative media inside slides. Defaults to the modal's own provider. */
+    mediaProvider?: MediaProvider | null;
+    /** Base path for media URLs in the slide renderer. */
+    basePath?: string;
+    /**
+     * Turn slide advances made during the take into an authoritative per-block
+     * v3 timing sidecar on save.
+     *
+     * Only meaningful when the host inserts the take as a DOCUMENT-ANCHORED clip
+     * (the "Record document narration" entry) — that is the only clip
+     * `applyNarrationTiming` reads a sidecar for, so for an ordinary block-level
+     * recording the file would be written and never read. This flag is
+     * therefore also how the dialog learns it is in document-narration mode.
+     */
+    captureTimings?: boolean;
+}
 interface RecorderModalProps {
     /** Required — recordings are written here. */
     mediaProvider: MediaProvider;
@@ -59,6 +88,14 @@ interface RecorderModalProps {
     onSave?: (result: RecorderSaveResult) => void;
     /** Enables the "Show narration mode" checkbox. Omit for the classic dialog. */
     narration?: RecorderNarrationOptions | null;
+    /** Enables the "Show slides mode" checkbox. Omit for the classic dialog. */
+    slides?: RecorderSlidesOptions | null;
+    /**
+     * Dialog heading (also its accessible name). Defaults to `'Record media'`;
+     * hosts that open the dialog for a specific purpose — e.g. "Record document
+     * narration" — pass their own so the dialog names what it is capturing.
+     */
+    title?: string;
 }
 /**
  * The camera companion of a `'screen+camera'` save. Present only on that
@@ -95,14 +132,30 @@ interface RecorderSaveResult {
     mimeType: string;
     /** Recording length in seconds. */
     duration: number;
-    /** Whether a narration sidecar was written. Always `false` for video sources. */
+    /**
+     * Whether a timing sidecar was written — either the v1 script sidecar for a
+     * mic take, or the v3 per-block sidecar from slide advances.
+     */
     hasTimingSidecar: boolean;
     /** Script text the user typed (narration only). */
     sourceText?: string;
     /** The paired camera file — present only for `source === 'screen+camera'`. */
     camera?: RecorderCameraSaveResult;
+    /** Present when slide advances were saved as a v3 per-block timing sidecar. */
+    slideTiming?: SlideTimingSaveResult;
+}
+/** What a presenter-advance timing write produced, for host status messaging. */
+interface SlideTimingSaveResult {
+    /** Container path the sidecar was written to. */
+    sidecarPath: string;
+    /** Renderable blocks written into the sidecar. */
+    blockCount: number;
+    /** Blocks never shown during the take — they save as zero-length ranges. */
+    unshownCount: number;
+    /** Take length the block ranges were normalized against. */
+    durationSec: number;
 }
-declare function RecorderModal({ mediaProvider, container, initialMode, colorScheme, onClose, onSave, narration, }: RecorderModalProps): react_jsx_runtime.JSX.Element;
+declare function RecorderModal({ mediaProvider, container, initialMode, colorScheme, onClose, onSave, narration, slides, title, }: RecorderModalProps): react_jsx_runtime.JSX.Element;
 
 interface RecorderButtonProps {
     /** Where to write the resulting recording. Required. */
@@ -117,6 +170,8 @@ interface RecorderButtonProps {
     onSave?: (result: RecorderSaveResult) => void;
     /** Enables the modal's "Show narration mode" checkbox. */
     narration?: RecorderNarrationOptions | null;
+    /** Enables the modal's "Show slides mode" checkbox. */
+    slides?: RecorderSlidesOptions | null;
     /** Button label. Defaults to `'Record'`. */
     label?: string;
     /** Optional inline button styles. */
@@ -124,7 +179,7 @@ interface RecorderButtonProps {
     /** Whether the button is disabled. */
     disabled?: boolean;
 }
-declare function RecorderButton({ mediaProvider, container, initialMode, colorScheme, onSave, narration, label, style, disabled, }: RecorderButtonProps): react_jsx_runtime.JSX.Element;
+declare function RecorderButton({ mediaProvider, container, initialMode, colorScheme, onSave, narration, slides, label, style, disabled, }: RecorderButtonProps): react_jsx_runtime.JSX.Element;
 
 interface RecorderPanelProps {
     mediaProvider: MediaProvider;
@@ -135,8 +190,12 @@ interface RecorderPanelProps {
     onSave?: (result: RecorderSaveResult) => void;
     /** Enables the modal's "Show narration mode" checkbox. */
     narration?: RecorderNarrationOptions | null;
+    /** Enables the modal's "Show slides mode" checkbox. */
+    slides?: RecorderSlidesOptions | null;
     /** ARIA / tooltip label. Defaults to `'Record media'`. */
     tooltip?: string;
+    /** Dialog heading / accessible name. Defaults to the modal's own `'Record media'`. */
+    title?: string;
     /** Optional className for the trigger button. */
     className?: string;
     /** Controlled modal state. Omit to let the panel manage its own state. */
@@ -146,7 +205,7 @@ interface RecorderPanelProps {
     /** Render the built-in trigger button. Defaults to true. */
     showTrigger?: boolean;
 }
-declare function RecorderPanel({ mediaProvider, container, initialMode, colorScheme, onSave, narration, tooltip, className, open: controlledOpen, onOpenChange, showTrigger, }: RecorderPanelProps): react_jsx_runtime.JSX.Element;
+declare function RecorderPanel({ mediaProvider, container, initialMode, colorScheme, onSave, narration, slides, tooltip, title, className, open: controlledOpen, onOpenChange, showTrigger, }: RecorderPanelProps): react_jsx_runtime.JSX.Element;
 
 /**
  * User-configurable recorder device/encoding settings.
@@ -470,6 +529,7 @@ declare function requestScreenStream(options?: ScreenStreamOptions): Promise<Scr
  * alongside its audio file and have the existing audio-mapping pipeline
  * pick them up with no schema changes.
  */
+
 /**
  * Word-level timing bookmark — same shape as `AudioBookmark` in
  * `@bendyline/squisq`. Recorder output produces an empty `bookmarks`
@@ -511,4 +571,4 @@ declare function encodeTimingJson(timing: TimingJson): Uint8Array;
  */
 declare function timingPathFor(audioRelativePath: string): string;
 
-export { buildRecorderScreenAudioConstraints as A, buildRecorderScreenConstraints as B, type CameraStreamOptions as C, DEFAULT_RECORDER_DEVICE_SETTINGS as D, buildTimingJson as E, encodeTimingJson as F, hasRecorderDeviceChoice as G, recordedMediaKind as H, recorderBitsPerSecond as I, recorderDeviceGroups as J, recorderDeviceOptions as K, requestCameraStream as L, type MediaDeviceInventory as M, requestMicStream as N, requestScreenStream as O, timingPathFor as P, useMediaDevices as Q, type RecordedBookmark as R, type ScreenStreamHandle as S, type TimingJson as T, useStreamPreview as U, type RecordedMediaKind as a, type RecorderAudioDeviceSettings as b, RecorderButton as c, type RecorderButtonProps as d, type RecorderCameraDeviceSettings as e, type RecorderCameraSaveResult as f, type RecorderColorScheme as g, type RecorderConstraintMode as h, type RecorderDeviceOption as i, RecorderDeviceQuickPicks as j, type RecorderDeviceQuickPicksProps as k, type RecorderDeviceSettings as l, RecorderDeviceSettingsPanel as m, type RecorderDeviceSettingsPanelProps as n, type RecorderEncodingSettings as o, RecorderModal as p, type RecorderModalProps as q, type RecorderNarrationOptions as r, RecorderPanel as s, type RecorderPanelProps as t, type RecorderSaveResult as u, type RecorderScreenAudioSettings as v, type RecorderScreenDeviceSettings as w, type ScreenStreamOptions as x, buildRecorderAudioConstraints as y, buildRecorderCameraConstraints as z };
+export { buildRecorderAudioConstraints as A, buildRecorderCameraConstraints as B, type CameraStreamOptions as C, DEFAULT_RECORDER_DEVICE_SETTINGS as D, buildRecorderScreenAudioConstraints as E, buildRecorderScreenConstraints as F, buildTimingJson as G, encodeTimingJson as H, hasRecorderDeviceChoice as I, recordedMediaKind as J, recorderBitsPerSecond as K, recorderDeviceGroups as L, type MediaDeviceInventory as M, recorderDeviceOptions as N, requestCameraStream as O, requestMicStream as P, requestScreenStream as Q, type RecordedBookmark as R, type ScreenStreamHandle as S, type TimingJson as T, timingPathFor as U, useMediaDevices as V, useStreamPreview as W, type RecordedMediaKind as a, type RecorderAudioDeviceSettings as b, RecorderButton as c, type RecorderButtonProps as d, type RecorderCameraDeviceSettings as e, type RecorderCameraSaveResult as f, type RecorderColorScheme as g, type RecorderConstraintMode as h, type RecorderDeviceOption as i, RecorderDeviceQuickPicks as j, type RecorderDeviceQuickPicksProps as k, type RecorderDeviceSettings as l, RecorderDeviceSettingsPanel as m, type RecorderDeviceSettingsPanelProps as n, type RecorderEncodingSettings as o, RecorderModal as p, type RecorderModalProps as q, type RecorderNarrationOptions as r, RecorderPanel as s, type RecorderPanelProps as t, type RecorderSaveResult as u, type RecorderScreenAudioSettings as v, type RecorderScreenDeviceSettings as w, type RecorderSlidesOptions as x, type ScreenStreamOptions as y, type SlideTimingSaveResult as z };

package/dist/shell/index.d.ts

@@ -1,10 +1,12 @@
-export { B as BlockTagVisibility, c as DocumentLinkCandidate, d as DocumentLinkProvider, e as EditorActions, f as EditorColorScheme, g as EditorContextValue, E as EditorHostMode, h as EditorMode, i as EditorProvider, j as EditorProviderProps, k as EditorShell, l as EditorShellProps, m as EditorState, n as EditorView, I as ImageDisplayMode, L as LayoutMode, M as MentionCandidate, o as MentionProvider, P as PreviewPanel, p as PreviewPanelProps, R as RawEditor, q as RawEditorProps, T as ThemeInheritance, V as ViewPreferences, r as WysiwygEditor, s as WysiwygEditorProps, u as useEditorContext } from '../shell-Bv6neeA6.js';
+export { B as BlockTagVisibility, c as DocumentLinkCandidate, d as DocumentLinkProvider, e as EditorActions, f as EditorColorScheme, g as EditorContextValue, E as EditorHostMode, h as EditorMode, i as EditorProvider, j as EditorProviderProps, k as EditorShell, l as EditorShellProps, m as EditorState, n as EditorView, I as ImageDisplayMode, L as LayoutMode, M as MentionCandidate, o as MentionProvider, P as PreviewPanel, p as PreviewPanelProps, R as RawEditor, q as RawEditorProps, T as ThemeInheritance, V as ViewPreferences, r as WysiwygEditor, s as WysiwygEditorProps, u as useEditorContext } from '../shell-Dlh-mkn9.js';
 import 'react/jsx-runtime';
 import 'react';
 import '@bendyline/squisq/schemas';
 import '@bendyline/squisq/fence';
 import '@bendyline/squisq/markdown';
 import '@bendyline/squisq/storage';
+import '../types-B_aHRuSc.js';
+import '@bendyline/squisq/proof';
 import '@bendyline/squisq/versions';
 import '@tiptap/core';
 import 'monaco-editor';

package/dist/shell/index.js

@@ -5,14 +5,14 @@ import {
   RawEditor,
   WysiwygEditor,
   useEditorContext
-} from "../chunk-SUXRSZ4Y.js";
+} from "../chunk-TQPZ6VVM.js";
 import "../chunk-V4NBQF5C.js";
-import "../chunk-K2WJYVS4.js";
+import "../chunk-TCLNRATG.js";
 import "../chunk-V44VP242.js";
-import "../chunk-V3J5S7X6.js";
+import "../chunk-JNJ7XO5L.js";
 import "../chunk-GS7QWYFT.js";
-import "../chunk-IQFPX2CE.js";
-import "../chunk-OWOKKZAU.js";
+import "../chunk-ZZTB6BEQ.js";
+import "../chunk-IRPOMTYK.js";
 export {
   EditorProvider,
   EditorShell,

package/dist/{shell-Bv6neeA6.d.ts → shell-Dlh-mkn9.d.ts}

@@ -4,6 +4,7 @@ import { Doc, MediaProvider, ViewportPreset, Theme } from '@bendyline/squisq/sch
 import { FenceRendererMap } from '@bendyline/squisq/fence';
 import { MarkdownDocument } from '@bendyline/squisq/markdown';
 import { ContentContainer } from '@bendyline/squisq/storage';
+import { P as ProofingCapability, b as ProofingIgnoreStore } from './types-B_aHRuSc.js';
 import { DocumentVersionManager, SaveVersionOptions, SaveVersionResult, PrunePolicy } from '@bendyline/squisq/versions';
 import { Editor } from '@tiptap/core';
 import { editor } from 'monaco-editor';
@@ -364,6 +365,27 @@ interface EditorContextValue extends EditorState, EditorActions {
      * the user types `@<query>`. When unset, `@` is just a literal character.
      */
     mentionProvider: MentionProvider | null;
+    /**
+     * Grammar/spellcheck capability injected by the host — a provider (or
+     * factory) from `@bendyline/squisq-editor-react/proofing`. `null`
+     * means the feature is off everywhere (the `ffmpegWasm` semantics:
+     * absent capability, absent feature).
+     */
+    proofing: ProofingCapability | null;
+    /**
+     * Host default for whether proofing checks documents when the
+     * capability is present. Per-doc frontmatter and the session toggle
+     * override it.
+     */
+    proofingDefaultEnabled: boolean;
+    /**
+     * Host-owned, per-document storage for dismissed findings. Ignores
+     * are never written into the document; without a store they last only
+     * for the session.
+     */
+    proofingIgnoreStore: ProofingIgnoreStore | null;
+    /** The document's article id — part of the proofing document ref. */
+    articleId: string;
     /**
      * Optional provider for sibling-document suggestions in the link
      * dialog. When set, the dialog shows a "Browse documents" picker that
@@ -455,6 +477,15 @@ interface EditorProviderProps {
      * entirely — typing `@` becomes just a literal character again.
      */
     mentionProvider?: MentionProvider | null;
+    /**
+     * Grammar/spellcheck capability. Omit for no proofing; see
+     * `EditorShellProps.proofing`.
+     */
+    proofing?: ProofingCapability | null;
+    /** Host default enable state for proofing (default true). */
+    proofingDefaultEnabled?: boolean;
+    /** Host-owned per-document storage for dismissed proofing findings. */
+    proofingIgnoreStore?: ProofingIgnoreStore | null;
     /**
      * Async provider for sibling-document suggestions in the link dialog.
      * Omit to fall back to URL-only link insertion.
@@ -587,7 +618,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, fenceRenderers, linkSchemes, allowRecording, allowNarrate, preserveSourceWrapping, fileName, saveCoverImageOutput, saveDashboardImageOutput, 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, proofing, proofingDefaultEnabled, proofingIgnoreStore, documentLinkProvider, fenceRenderers, linkSchemes, allowRecording, allowNarrate, preserveSourceWrapping, fileName, saveCoverImageOutput, saveDashboardImageOutput, 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)
@@ -959,6 +990,32 @@ interface EditorShellProps {
      * inline. Omit to disable mentions entirely.
      */
     mentionProvider?: MentionProvider | null;
+    /**
+     * Grammar/spellcheck capability — a `ProofingProvider` (or factory)
+     * from `@bendyline/squisq-editor-react/proofing`, typically backed by
+     * harper.js. Same semantics as `ffmpegWasm` in video export: omit and
+     * the feature is completely off — no engine bytes are ever fetched,
+     * and no proofing UI renders. Pass an *instance* to own its lifetime
+     * yourself (it survives shell remounts); pass a *factory* and the
+     * shell creates the provider on first use and disposes it on unmount.
+     */
+    proofing?: ProofingCapability | null;
+    /**
+     * Whether proofing checks documents by default when the capability is
+     * present (default `true`). Per-doc frontmatter (`squisq-proofing`)
+     * and the user's session toggle in the View menu override this.
+     */
+    proofingDefaultEnabled?: boolean;
+    /**
+     * Host-owned storage for findings the user dismissed with "Ignore",
+     * scoped per document (`load`/`save` receive a
+     * `ProofingDocumentRef` carrying `articleId` + `fileName`, so a host
+     * can key by file path). Ignores are deliberately NEVER written into
+     * the document — they are one person's editing preference, not
+     * content that should travel through git to everyone else. Omit the
+     * store and Ignore still works, lasting for the session only.
+     */
+    proofingIgnoreStore?: ProofingIgnoreStore | null;
     /**
      * Optional async provider for sibling-document suggestions in the
      * link insert dialog. When supplied, the dialog gains a "Browse
@@ -1136,7 +1193,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, hostMode, defaultViewportPreset, articleId, basePath, onChange, onLinkClick, showCodeCopyButton, onCopyCode, colorScheme, className, height, minHeight, maxHeight, mediaProvider, workspaceContainer, allowVersioning, versionBasename, versioningPrunePolicy, versioningAutoSaveIdleMs, onSaveVersion, showFilesToggle, showFormattingControls, showInsertControls, allowBinaryDownloads, toolbarSlotLeft, toolbarSlotAfterActions, toolbarSlotRight, statusBarSlotRight, showPlayTab, allowPresentationWindow, allowPresentationFullscreen, allowPrint, submitOnEnter, codeContext, fullWidth, uxFont, thinMargins, writeCanvasSettings, showStatusBar, imageDisplayMode, fileName, saveCoverImageOutput, saveDashboardImageOutput, language, findMode, onFindModeChange, mentionProvider, documentLinkProvider, fenceRenderers, 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;
+declare function EditorShell({ initialMarkdown, initialView, hostMode, defaultViewportPreset, articleId, basePath, onChange, onLinkClick, showCodeCopyButton, onCopyCode, colorScheme, className, height, minHeight, maxHeight, mediaProvider, workspaceContainer, allowVersioning, versionBasename, versioningPrunePolicy, versioningAutoSaveIdleMs, onSaveVersion, showFilesToggle, showFormattingControls, showInsertControls, allowBinaryDownloads, toolbarSlotLeft, toolbarSlotAfterActions, toolbarSlotRight, statusBarSlotRight, showPlayTab, allowPresentationWindow, allowPresentationFullscreen, allowPrint, submitOnEnter, codeContext, fullWidth, uxFont, thinMargins, writeCanvasSettings, showStatusBar, imageDisplayMode, fileName, saveCoverImageOutput, saveDashboardImageOutput, language, findMode, onFindModeChange, mentionProvider, proofing, proofingDefaultEnabled, proofingIgnoreStore, documentLinkProvider, fenceRenderers, 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