@bendyline/docblocks-react 2.6.1 → 2.7.0

package/dist/index.d.ts

@@ -1,21 +1,24 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { FileSystemEntry, FileSystemProvider, FsErrorCode } from '@bendyline/docblocks/filesystem';
+import { FileSystemEntry, FileSystemProvider, FileSystemEntryMoveOptions, FsErrorCode } from '@bendyline/docblocks/filesystem';
 import { WorkspaceDescriptor } from '@bendyline/docblocks/workspace';
 import { EditorColorScheme, CalcEngineFactory, ProofingCapability, ProofingIgnoreStore } from '@bendyline/squisq-editor-react';
 import { CodeBlockCopyHandler } from '@bendyline/squisq-react';
 import { FfmpegWasmLoadConfig } from '@bendyline/squisq-video';
 import { PrunePolicy, SaveVersionResult, DocumentVersionManager } from '@bendyline/squisq/versions';
-import { ThemePreference, AccentColor, WriteCanvasPreferences, ProofingPreferences } from './settings/index.js';
-export { AccentColorSettings, AccentColorSettingsProps, DEFAULT_PROOFING_PREFERENCES, DEFAULT_WRITE_CANVAS_FONT_SCHEME, ProofingSettingsControls, ProofingSettingsControlsProps, SettingsDialog, SettingsDialogProps, ThemeSettings, ThemeSettingsProps, WRITE_CANVAS_FONT_SCHEMES, WriteCanvasFontScheme, WriteCanvasFontSchemeGroup, WriteCanvasFontSchemeOption, WriteCanvasSettingsControls, WriteCanvasSettingsControlsProps, loadProofingPreferences, resolveWriteCanvasFonts, saveProofingPreferences } from './settings/index.js';
+import { DocBlocksHostAiAPI, DocBlocksHostSpeechAPI } from '@bendyline/docblocks/host';
+import { T as ThemePreference, A as AccentColor, I as InterfaceFontPreference, q as WriteCanvasPreferences, P as ProofingPreferences } from './Settings-DuXk6baH.js';
+export { a as AccentColorSettings, b as AccentColorSettingsProps, c as AiSettingsControls, d as AiSettingsControlsProps, D as DEFAULT_INTERFACE_FONT, e as DEFAULT_PROOFING_PREFERENCES, f as DEFAULT_WRITE_CANVAS_FONT_SCHEME, g as InterfaceFontSettings, h as InterfaceFontSettingsProps, i as ProofingSettingsControls, j as ProofingSettingsControlsProps, S as SettingsDialog, k as SettingsDialogProps, l as ThemeSettings, m as ThemeSettingsProps, W as WRITE_CANVAS_FONT_SCHEMES, n as WriteCanvasFontScheme, o as WriteCanvasFontSchemeGroup, p as WriteCanvasFontSchemeOption, r as WriteCanvasSettingsControls, s as WriteCanvasSettingsControlsProps, t as loadInterfaceFont, u as loadProofingPreferences, v as resolveWriteCanvasFonts, w as saveInterfaceFont, x as saveProofingPreferences } from './Settings-DuXk6baH.js';
 import { SharedDocumentMode } from '@bendyline/docblocks/share';
 import { MediaProvider } from '@bendyline/squisq/schemas';
 import { ContentContainer } from '@bendyline/squisq/storage';
 import { VideoExportModalProps } from '@bendyline/squisq-video-react';
+import { MediaEditRenderManager } from '@bendyline/squisq-video-react/media-edit';
 import { ExportBlobSaver } from './export/index.js';
 export { CoverImageSaveAdapter, CoverImageSaveOutput, DEFAULT_OPTIONS, CoverImageSaveAdapter as DashboardImageSaveAdapter, CoverImageSaveOutput as DashboardImageSaveOutput, ExportDestinationControl, ExportDialog, ExportDialogProps, ExportFormat, ExportOptions, HtmlBundle, HtmlStyle, CoverImageSaveAdapter as ImageSaveAdapter, CoverImageSaveOutput as ImageSaveOutput, buildExportFilename, createCoverImageSaveOutput, createCoverImageSaveOutput as createDashboardImageSaveOutput, createCoverImageSaveOutput as createImageSaveOutput, loadLastExportOptions, runExport, updateExportTargetExtension } from './export/index.js';
 import { DocumentSession, DocumentSessionSnapshot } from '@bendyline/docblocks/document';
 import 'react';
 import '@bendyline/squisq-formats/pptx';
+import '@bendyline/squisq-formats/diagrams';
 
 /** Git decoration for a row — precomputed by FileExplorer so this node stays context-free. */
 interface FileTreeNodeBadge {
@@ -98,7 +101,24 @@ interface PinnedDocumentListItem extends PinnedDocument {
 
 type FileExplorerSortMode = 'name' | 'last-modified';
 
+/** Host-supplied rendering context for regenerated outside-in files. */
+interface OutsideInRenderOptions {
+    /**
+     * The workspace default theme, read at render time. Applied only to
+     * documents whose frontmatter names no theme of their own: every Squisq
+     * exporter lets an explicit theme beat the document's frontmatter.
+     */
+    defaultThemeId?: () => string | undefined;
+}
+
+/**
+ * The types a new document can be created as. Shared by the explorer's inline
+ * new-file form and the shell's New document dialog so both name the result
+ * the same way; `NewFileFormatOptions` renders the matching choices.
+ */
+
 type NewFileFormat = 'markdown' | 'docx' | 'xlsx' | 'pdf' | 'web-interactive' | 'web-static';
+
 type FileTreeChange = {
     type: 'create';
     path: string;
@@ -113,7 +133,7 @@ type FileTreeChange = {
     newPath: string;
     kind: 'file' | 'directory';
 };
-type FileTreeMutationHandler = (change: FileTreeChange, mutate: () => Promise<void>) => Promise<void>;
+type FileTreeMutationHandler = (change: FileTreeChange, mutate: (options?: FileSystemEntryMoveOptions) => Promise<void>) => Promise<void>;
 interface WorkspaceMoveDestination {
     id: string;
     name: string;
@@ -170,10 +190,20 @@ interface FileExplorerProps {
     moveDestinations?: readonly WorkspaceMoveDestination[];
     /** When provided, shows the transient-workspace move action above the tree. */
     onMoveToWorkspace?: (workspaceId: string) => Promise<void>;
+    /** Rendering context (e.g. the workspace default theme) for new rendered documents. */
+    outsideInRender?: OutsideInRenderOptions;
+    /** The type the New File form preselects. Defaults to Markdown. */
+    defaultNewFileFormat?: NewFileFormat;
+    /** Called with the type of each file the New File form creates. */
+    onNewFileFormatUsed?: (format: NewFileFormat) => void;
+    /** Shows a Search button that switches the sidebar to workspace search. */
+    onShowSearch?: () => void;
+    /** Tooltip shortcut for the Search button, e.g. `Ctrl+Shift+F`. */
+    searchShortcutLabel?: string;
     /** Optional className for the root element. */
     className?: string;
 }
-declare function FileExplorer({ provider, metadataRefreshKey, activeFilePath, sortMode, onSortModeChange, activeWorkspaceId, pinnedDocuments, pinnedPaths, onPinnedDocumentSelect, onPinnedDocumentUnpin, onPinnedDocumentRename, onPinnedDocumentDelete, onTogglePin, onSelect, onOpenWorkspaceFolder, actionsForEntry, onTreeMutation, onTreeChange, onImportFiles, confirmDelete, moveDestinations, onMoveToWorkspace, className, }: FileExplorerProps): react_jsx_runtime.JSX.Element;
+declare function FileExplorer({ provider, metadataRefreshKey, activeFilePath, sortMode, onSortModeChange, activeWorkspaceId, pinnedDocuments, pinnedPaths, onPinnedDocumentSelect, onPinnedDocumentUnpin, onPinnedDocumentRename, onPinnedDocumentDelete, onTogglePin, onSelect, onOpenWorkspaceFolder, actionsForEntry, onTreeMutation, onTreeChange, onImportFiles, confirmDelete, moveDestinations, onMoveToWorkspace, outsideInRender, defaultNewFileFormat, onNewFileFormatUsed, onShowSearch, searchShortcutLabel, className, }: FileExplorerProps): react_jsx_runtime.JSX.Element;
 
 /**
  * useFileTree — hook that reads from a FileSystemProvider,
@@ -224,7 +254,7 @@ interface FileTreeActions {
     /** Delete a file or directory. */
     deleteEntry: (path: string) => Promise<void>;
     /** Rename or move a file or directory, including a markdown companion folder. */
-    renameEntry: (oldPath: string, newPath: string, kind?: 'file' | 'directory') => Promise<void>;
+    renameEntry: (oldPath: string, newPath: string, kind?: 'file' | 'directory', options?: FileSystemEntryMoveOptions) => Promise<void>;
     /** Force refresh the tree. */
     refresh: () => Promise<void>;
     /** Retry one failed directory without treating it as a workspace-root failure. */
@@ -244,12 +274,33 @@ interface WorkspacePickerProps {
      * the desktop when git is available — omitted, the item is hidden.
      */
     onCloneRepository?: () => void;
+    /**
+     * Called when the user chooses "Remove workspace" from a row's actions menu
+     * (its ⋯ button, a right-click, or Shift+F10). The host confirms and does
+     * the removal. Omitted, rows have no actions menu.
+     */
+    onRemoveWorkspace?: (descriptor: WorkspaceDescriptor) => void;
     /** Forces a list refresh after an external workspace-registry mutation. */
     refreshKey?: number;
     /** Optional className. */
     className?: string;
 }
-declare function WorkspacePicker({ activeWorkspaceId, onSelect, onOpenFolder, onCloneRepository, refreshKey, className, }: WorkspacePickerProps): react_jsx_runtime.JSX.Element;
+declare function WorkspacePicker({ activeWorkspaceId, onSelect, onOpenFolder, onCloneRepository, onRemoveWorkspace, refreshKey, className, }: WorkspacePickerProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Owns the active workspace's index: one per provider instance, disposed
+ * (cancelling any in-flight walk) when the workspace changes.
+ *
+ * The index module is loaded on demand so it stays out of the startup bundle,
+ * and indexing starts once the browser is idle so it never competes with the
+ * explorer's first listing.
+ */
+
+/**
+ * `eager` indexes once the browser is idle; `on-demand` waits until a feature
+ * needs it (quick-open, search); `off` never indexes.
+ */
+type WorkspaceIndexMode = 'eager' | 'on-demand' | 'off';
 
 interface DocBlocksShellProps {
     /**
@@ -329,6 +380,12 @@ interface DocBlocksShellProps {
     onApplyUpdate?: () => void;
     /** Host-supplied content rendered at the right edge of the editor status bar. */
     statusBarSlotRight?: React.ReactNode;
+    /**
+     * When the shared workspace index (link picker, quick-open, search) reads
+     * the workspace: `eager` once the app is idle (default), `on-demand` when a
+     * feature first needs it (hosts whose listings are expensive), `off` never.
+     */
+    workspaceIndex?: WorkspaceIndexMode;
     /** Show Copy controls on ordinary fenced code blocks (default: true). */
     showCodeCopyButton?: boolean;
     /**
@@ -348,7 +405,7 @@ interface DocBlocksShellProps {
      */
     offlineReady?: boolean;
 }
-declare function DocBlocksShell({ theme: hostTheme, logoUrl, issueReportVersion, appBuildDate, ffmpegWasm, calcEngineFactory, proofing, proofingDefaultEnabled, proofingIgnoreStore, homeDocumentTitle, homeDocumentPath, allowVersioning, versionBasename, versioningPrunePolicy, versioningAutoSaveIdleMs, onSaveVersion, versioningRef, updateAvailable, onApplyUpdate, statusBarSlotRight, showCodeCopyButton, onCopyCode, allowRecording, allowPresentationWindow, allowPresentationFullscreen, offlineReady, }: DocBlocksShellProps): react_jsx_runtime.JSX.Element;
+declare function DocBlocksShell({ theme: hostTheme, logoUrl, issueReportVersion, appBuildDate, ffmpegWasm, calcEngineFactory, proofing, proofingDefaultEnabled, proofingIgnoreStore, homeDocumentTitle, homeDocumentPath, allowVersioning, versionBasename, versioningPrunePolicy, versioningAutoSaveIdleMs, onSaveVersion, versioningRef, updateAvailable, onApplyUpdate, statusBarSlotRight, workspaceIndex: workspaceIndexMode, showCodeCopyButton, onCopyCode, allowRecording, allowPresentationWindow, allowPresentationFullscreen, offlineReady, }: DocBlocksShellProps): react_jsx_runtime.JSX.Element;
 
 /**
  * Versioning preferences — global default + per-workspace resolution.
@@ -358,9 +415,12 @@ declare function DocBlocksShell({ theme: hostTheme, logoUrl, issueReportVersion,
  * default is `'browser-only'` so local-folder workspaces stay clean by
  * default and only IndexedDB workspaces accumulate version history.
  *
- * Each workspace can override the global default with its own setting
- * stored on the WorkspaceDescriptor. `'inherit'` (or absent) defers to
- * the global preference; `'on'` / `'off'` force the behavior regardless.
+ * Each workspace can override the global default. The override lives in
+ * the folder's `.docblocks/workspace.json` (`versionHistory.enabled`) so it
+ * travels with the folder; an older override stored on the
+ * WorkspaceDescriptor is still honored until the next workspace-settings
+ * save moves it into the file. Absent (or `'inherit'`) defers to the global
+ * preference; `'on'` / `'off'` force the behavior regardless.
  */
 
 type VersioningPreference = 'on' | 'browser-only' | 'off';
@@ -374,8 +434,11 @@ interface AppMenuProps {
     onThemeChange?: (theme: ThemePreference) => void;
     /** Current accent color. */
     accentColor?: AccentColor;
+    /** Chrome typeface: follow the OS, or use the bundled face. */
+    interfaceFont?: InterfaceFontPreference;
     /** Called when the user changes the accent color. */
     onAccentColorChange?: (color: AccentColor) => void;
+    onInterfaceFontChange?: (font: InterfaceFontPreference) => void;
     /** Current typography preferences for the editor's Write canvas. */
     writeCanvasSettings?: WriteCanvasPreferences;
     /** Called when the user changes the Write canvas typography. */
@@ -388,6 +451,8 @@ interface AppMenuProps {
     versioningPreference?: VersioningPreference;
     /** Called when the user changes the global versioning preference. */
     onVersioningPreferenceChange?: (pref: VersioningPreference) => void;
+    /** Opens the active workspace's own settings (`.docblocks/workspace.json`). */
+    onOpenWorkspaceSettings?: () => void;
     /**
      * Called when the user clicks "Download all workspaces". When omitted,
      * the menu item is hidden.
@@ -419,8 +484,20 @@ interface AppMenuProps {
     appVersion?: string;
     /** ISO build date shown in About. */
     appBuildDate?: string;
+    /**
+     * The host's AI API. When present, Settings offers an AI section; when
+     * omitted — a host without AI — the section is hidden.
+     */
+    ai?: DocBlocksHostAiAPI;
+    /**
+     * The host's speech API. When present, Settings offers a Speech section for
+     * dictation and narration models; when omitted the section is hidden.
+     */
+    speech?: DocBlocksHostSpeechAPI;
+    /** Opens Settings whenever it changes to a new non-zero value. */
+    settingsRequest?: number;
 }
-declare function AppMenu({ logoUrl, themePreference, onThemeChange, accentColor, onAccentColorChange, writeCanvasSettings, onWriteCanvasSettingsChange, proofingPreferences, onProofingPreferencesChange, versioningPreference, onVersioningPreferenceChange, onDownloadAllWorkspaces, onKeepBrowserData, onInstallApp, getStorageEstimate, storagePersistent, appVersion, appBuildDate, }: AppMenuProps): react_jsx_runtime.JSX.Element;
+declare function AppMenu({ logoUrl, themePreference, onThemeChange, accentColor, onAccentColorChange, interfaceFont, onInterfaceFontChange, writeCanvasSettings, onWriteCanvasSettingsChange, proofingPreferences, onProofingPreferencesChange, versioningPreference, onVersioningPreferenceChange, onOpenWorkspaceSettings, onDownloadAllWorkspaces, onKeepBrowserData, onInstallApp, getStorageEstimate, storagePersistent, appVersion, appBuildDate, ai, speech, settingsRequest, }: AppMenuProps): react_jsx_runtime.JSX.Element;
 
 interface ExportToolbarControlsProps {
     /** Currently selected file path — used to derive the download filename. */
@@ -435,6 +512,15 @@ interface ExportToolbarControlsProps {
     workspaceContainer?: ContentContainer | null;
     /** Active document media provider used to preload audio and video export assets. */
     mediaProvider?: MediaProvider | null;
+    /**
+     * Processed-audio renders for media-edit recipes. Video export waits for
+     * pending renders and mixes the processed audio in place of the original.
+     */
+    mediaEditRenders?: MediaEditRenderManager | null;
+    /** The host's speech API; when present the menu offers "Export audio…". */
+    speech?: DocBlocksHostSpeechAPI;
+    /** Workspace default theme, pre-selected for documents without their own. */
+    defaultThemeId?: string;
     /** Override the default browser download behavior for host-provided save flows. */
     saveBlob?: ExportBlobSaver;
     /** Optional host adapter for displaying, picking, and saving to a native target path. */
@@ -460,6 +546,7 @@ interface ExportDestinationTarget {
     displayPath: string;
 }
 interface ExportDestinationAdapter {
+    shareBlob?: (blob: Blob, filename: string) => Promise<'shared' | 'presented' | 'cancelled'>;
     resolveTarget: (filename: string) => Promise<ExportDestinationTarget>;
     pickTarget: (filename: string, currentTarget?: ExportDestinationTarget | null) => Promise<ExportDestinationTarget | null>;
     saveBlob: (blob: Blob, filename: string, target?: ExportDestinationTarget | null) => Promise<ExportDestinationTarget | null>;
@@ -488,4 +575,4 @@ interface UseDocumentSessionResult {
  */
 declare function useDocumentSession(autoSaveDelayMs?: number): UseDocumentSessionResult;
 
-export { AccentColor, AppMenu, type AppMenuProps, DocBlocksShell, type DocBlocksShellProps, ExportBlobSaver, type ExportDestinationAdapter, type ExportDestinationTarget, ExportToolbarControls, type ExportToolbarControlsProps, FileExplorer, type FileExplorerProps, type FileExplorerSortMode, type FileTreeActions, type FileTreeChange, type FileTreeMutationHandler, FileTreeNode, type FileTreeNodeProps, type FileTreeReadIssue, type FileTreeState, type NewFileFormat, ProofingPreferences, ThemePreference, type UseDocumentSessionResult, WorkspacePicker, type WorkspacePickerProps, WriteCanvasPreferences, useDocumentSession, useFileTree };
+export { AccentColor, AppMenu, type AppMenuProps, DocBlocksShell, type DocBlocksShellProps, ExportBlobSaver, type ExportDestinationAdapter, type ExportDestinationTarget, ExportToolbarControls, type ExportToolbarControlsProps, FileExplorer, type FileExplorerProps, type FileExplorerSortMode, type FileTreeActions, type FileTreeChange, type FileTreeMutationHandler, FileTreeNode, type FileTreeNodeProps, type FileTreeReadIssue, type FileTreeState, InterfaceFontPreference, type NewFileFormat, ProofingPreferences, ThemePreference, type UseDocumentSessionResult, WorkspacePicker, type WorkspacePickerProps, WriteCanvasPreferences, useDocumentSession, useFileTree };