@bendyline/docblocks-react 2.4.0 → 2.6.0

package/dist/export/index.js

@@ -2,17 +2,16 @@ import {
   createImageSaveOutput,
   updateExportTargetExtension
 } from "../chunk-FNSRCCBC.js";
-import {
-  ExportDialog
-} from "../chunk-SIIEGOHY.js";
 import {
   runExport
 } from "../chunk-ODYNOPC3.js";
-import "../chunk-YBEYTVU2.js";
-import "../chunk-LG6HAWCK.js";
 import {
   buildExportFilename
 } from "../chunk-M5Y5WO7Z.js";
+import {
+  ExportDialog
+} from "../chunk-FMDLZ4ZG.js";
+import "../chunk-YBEYTVU2.js";
 import {
   DEFAULT_OPTIONS,
   FORMAT_EXTENSIONS,
@@ -20,6 +19,7 @@ import {
   loadLastExportOptions,
   saveExportOptions
 } from "../chunk-EBWYGTN7.js";
+import "../chunk-LG6HAWCK.js";
 export {
   DEFAULT_OPTIONS,
   ExportDialog,

package/dist/index.d.ts

@@ -1,12 +1,12 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { FileSystemEntry, FileSystemProvider, FsErrorCode } from '@bendyline/docblocks/filesystem';
 import { WorkspaceDescriptor } from '@bendyline/docblocks/workspace';
-import { EditorColorScheme } from '@bendyline/squisq-editor-react';
+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 } from './settings/index.js';
-export { AccentColorSettings, AccentColorSettingsProps, DEFAULT_WRITE_CANVAS_FONT_SCHEME, SettingsDialog, SettingsDialogProps, ThemeSettings, ThemeSettingsProps, WRITE_CANVAS_FONT_SCHEMES, WriteCanvasFontScheme, WriteCanvasFontSchemeGroup, WriteCanvasFontSchemeOption, WriteCanvasSettingsControls, WriteCanvasSettingsControlsProps, resolveWriteCanvasFonts } from './settings/index.js';
+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 { SharedDocumentMode } from '@bendyline/docblocks/share';
 import { MediaProvider } from '@bendyline/squisq/schemas';
 import { ContentContainer } from '@bendyline/squisq/storage';
@@ -98,6 +98,7 @@ interface PinnedDocumentListItem extends PinnedDocument {
 
 type FileExplorerSortMode = 'name' | 'last-modified';
 
+type NewFileFormat = 'markdown' | 'docx' | 'xlsx' | 'pdf' | 'web-interactive' | 'web-static';
 type FileTreeChange = {
     type: 'create';
     path: string;
@@ -146,6 +147,8 @@ interface FileExplorerProps {
     onTogglePin?: (path: string) => void | Promise<void>;
     /** Called when any entry is selected (file or directory). */
     onSelect?: (path: string, kind: 'file' | 'directory') => void;
+    /** Opens the active native workspace root in the platform file manager. */
+    onOpenWorkspaceFolder?: () => void;
     /** Host-owned context actions for an entry. */
     actionsForEntry?: (entry: FileSystemEntry) => readonly FileTreeNodeAction[];
     /**
@@ -155,7 +158,7 @@ interface FileExplorerProps {
     onTreeMutation?: FileTreeMutationHandler;
     /** Called after any mutation, with move details when paths change. */
     onTreeChange?: (change?: FileTreeChange) => void;
-    /** Called when supported files are dropped onto the explorer. */
+    /** Called with every external file dropped onto the explorer. */
     onImportFiles?: (files: File[]) => void;
     /**
      * Ask the user to confirm an irreversible delete. Resolve `false` to abort.
@@ -170,7 +173,7 @@ interface FileExplorerProps {
     /** 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, 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, className, }: FileExplorerProps): react_jsx_runtime.JSX.Element;
 
 /**
  * useFileTree — hook that reads from a FileSystemProvider,
@@ -263,6 +266,36 @@ interface DocBlocksShellProps {
     appBuildDate?: string;
     /** Self-hosted ffmpeg.wasm core. Supplying it enables Animated GIF export. */
     ffmpegWasm?: FfmpegWasmLoadConfig;
+    /**
+     * Optional spreadsheet calculation backend. DocBlocks surfaces normally
+     * pass the lazy IronCalc factory from the `calculation` package subpath;
+     * omitting it keeps Squisq's in-house calculation tier.
+     */
+    calcEngineFactory?: CalcEngineFactory;
+    /**
+     * Grammar and spellcheck engine, normally a harper-backed provider pointed
+     * at the surface's self-hosted WASM. Omit it and no proofing UI renders and
+     * no engine bytes are ever fetched. Pass an *instance* to keep one warm
+     * engine alive across shell remounts; pass a factory to let the editor own
+     * its lifetime and dispose it on unmount.
+     */
+    proofing?: ProofingCapability | null;
+    /**
+     * Whether proofing checks documents by default once the capability is
+     * present (default `true`). The user's session toggle and a document's
+     * `squisq-proofing` frontmatter both outrank this.
+     */
+    proofingDefaultEnabled?: boolean;
+    /**
+     * Where dismissed ("Ignore") findings persist. Squisq never writes them into
+     * the document, so without a store they last only for the session.
+     *
+     * Omit it and the shell keeps them in browser-local storage, scoped by
+     * workspace and path like every other per-document preference. Pass `null`
+     * to deliberately make dismissals session-only, or a store of your own to
+     * put them somewhere else.
+     */
+    proofingIgnoreStore?: ProofingIgnoreStore | null;
     /** Stable host title used before a document opens and for the optional home document. */
     homeDocumentTitle?: string;
     /** Document path that represents the host's indexable home experience. */
@@ -315,7 +348,7 @@ interface DocBlocksShellProps {
      */
     offlineReady?: boolean;
 }
-declare function DocBlocksShell({ theme: hostTheme, logoUrl, issueReportVersion, appBuildDate, ffmpegWasm, 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, showCodeCopyButton, onCopyCode, allowRecording, allowPresentationWindow, allowPresentationFullscreen, offlineReady, }: DocBlocksShellProps): react_jsx_runtime.JSX.Element;
 
 /**
  * Versioning preferences — global default + per-workspace resolution.
@@ -347,6 +380,10 @@ interface AppMenuProps {
     writeCanvasSettings?: WriteCanvasPreferences;
     /** Called when the user changes the Write canvas typography. */
     onWriteCanvasSettingsChange?: (settings: WriteCanvasPreferences) => void;
+    /** Current inline spelling/grammar checking preferences. */
+    proofingPreferences?: ProofingPreferences;
+    /** Called when the user toggles inline spelling or grammar checking. */
+    onProofingPreferencesChange?: (settings: ProofingPreferences) => void;
     /** Current global versioning preference. */
     versioningPreference?: VersioningPreference;
     /** Called when the user changes the global versioning preference. */
@@ -383,7 +420,7 @@ interface AppMenuProps {
     /** ISO build date shown in About. */
     appBuildDate?: string;
 }
-declare function AppMenu({ logoUrl, themePreference, onThemeChange, accentColor, onAccentColorChange, writeCanvasSettings, onWriteCanvasSettingsChange, versioningPreference, onVersioningPreferenceChange, onDownloadAllWorkspaces, onKeepBrowserData, onInstallApp, getStorageEstimate, storagePersistent, appVersion, appBuildDate, }: AppMenuProps): react_jsx_runtime.JSX.Element;
+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;
 
 interface ExportToolbarControlsProps {
     /** Currently selected file path — used to derive the download filename. */
@@ -451,4 +488,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, 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, type NewFileFormat, ProofingPreferences, ThemePreference, type UseDocumentSessionResult, WorkspacePicker, type WorkspacePickerProps, WriteCanvasPreferences, useDocumentSession, useFileTree };