@bendyline/squisq-editor-react 2.8.0 → 2.10.0

package/dist/types-B_aHRuSc.d.ts

@@ -0,0 +1,156 @@
+import { ProofFinding, ProofDialect } from '@bendyline/squisq/proof';
+
+/**
+ * The proofing capability contract between an editor host and the shell.
+ *
+ * A host that wants grammar/spellcheck passes a {@link ProofingProvider}
+ * (or a factory) to `EditorShell`'s `proofing` prop — the same
+ * capability-injection semantics as `ffmpegWasm`: absent means the
+ * feature is off, and there is no CDN fallback. The provider surface is
+ * plain data end to end, deliberately free of harper.js types so the
+ * engine stays an optional peer dependency that never appears in this
+ * package's published declarations.
+ */
+
+/** Markup mode for one lint call. */
+type ProofingLanguage = 'plaintext' | 'markdown';
+interface ProofingLintOptions {
+    /** Defaults to `plaintext`. */
+    language?: ProofingLanguage;
+}
+/**
+ * An engine adapter the editor drives. Implementations must serialize
+ * their own engine access (calls may arrive while a previous one is in
+ * flight) and keep `lint` results resolvable by finding id until the
+ * next `lint` call.
+ */
+interface ProofingProvider {
+    /**
+     * Load the engine (module + WASM). Idempotent and safe to call
+     * repeatedly; a rejection is retryable — a later call attempts a
+     * fresh load. All expensive work belongs here, never in construction.
+     */
+    setup(): Promise<void>;
+    /** Lint `text`; finding offsets index into `text` (UTF-16 units). */
+    lint(text: string, options?: ProofingLintOptions): Promise<ProofFinding[]>;
+    /**
+     * Persistently ignore the finding's underlying lint — including any
+     * stacked same-span lints other rules reveal once the first is
+     * suppressed. `findingId` must come from the most recent `lint` call.
+     */
+    ignoreFinding(findingId: string): Promise<void>;
+    /**
+     * Accept one word into the APP-level dictionary — fires the host's
+     * `onDictionaryWord` so it can persist wherever it keeps user
+     * settings. Backs the menu's "Add to dictionary".
+     */
+    addWord(word: string): Promise<void>;
+    /**
+     * Accept words for this session without notifying the host. Used both
+     * to load a document's own word list at setup and to back the menu's
+     * "Add to document word list" (where the DOC's frontmatter, not the
+     * app, is the store of record).
+     */
+    addWords(words: readonly string[]): Promise<void>;
+    /**
+     * Whether app-level additions actually persist — i.e. the host wired
+     * `onDictionaryWord`. When `false`, the editor hides "Add to
+     * dictionary" so a word can never appear to be saved app-wide and
+     * then silently come back. `undefined` (a provider that doesn't
+     * report) is treated as capable.
+     */
+    readonly hasAppDictionary?: boolean;
+    /**
+     * The engine's ignored-findings state as an OPAQUE string — it holds
+     * context hashes as integers above 2^53, so it must never be
+     * JSON-parsed or rebuilt, only stored and handed back verbatim.
+     */
+    exportIgnored(): Promise<string>;
+    /** Merge previously exported ignored-findings state into the engine. */
+    importIgnored(json: string): Promise<void>;
+    /**
+     * Drop all ignored findings. The editor calls this when the engine's
+     * ignore set belongs to a different document than the one about to be
+     * linted — ignores are per-document, but an engine instance may be
+     * shared across documents and shells.
+     */
+    clearIgnored(): Promise<void>;
+    /** Switch English dialect. The caller re-lints afterwards. */
+    setDialect(dialect: ProofDialect): Promise<void>;
+    /** Release engine resources. Further calls reject. */
+    dispose(): void;
+}
+/**
+ * Deferred construction. When the shell receives a factory it creates
+ * the provider on first activation and disposes it on unmount; a host
+ * that passes an instance owns its lifetime (letting one warm engine
+ * survive shell remounts).
+ */
+type ProofingProviderFactory = () => ProofingProvider;
+/** What the `proofing` shell prop accepts. */
+type ProofingCapability = ProofingProvider | ProofingProviderFactory;
+/**
+ * Identifies the document a set of ignored findings belongs to. Hosts
+ * key their storage off whichever field suits them — usually the file
+ * path, falling back to the article id for unsaved buffers.
+ */
+interface ProofingDocumentRef {
+    /** The document's `articleId` (always present; `'untitled'` default). */
+    articleId: string;
+    /** The document's file name / path, when the host supplied one. */
+    fileName?: string;
+}
+/**
+ * Host-owned persistence for dismissed ("Ignore") findings.
+ *
+ * Ignores are deliberately never written into the document — they are
+ * one person's editing preference, and a doc travelling through git
+ * shouldn't carry them. Instead the editor hands the state to the host,
+ * scoped per document, and the host stores it wherever its user data
+ * lives (a settings file, IndexedDB, a per-workspace record keyed by
+ * path…). The payload is the engine's OPAQUE export: store it as a
+ * string, never parse it.
+ *
+ * Omit the store and Ignore still works — it just lasts for the
+ * session, which is often the right behavior for a scratch buffer.
+ */
+interface ProofingIgnoreStore {
+    /** Previously saved state for this document, if any. */
+    load(doc: ProofingDocumentRef): string | undefined | Promise<string | undefined>;
+    /** Persist this document's state. Called after every Ignore. */
+    save(doc: ProofingDocumentRef, ignoredJson: string): void | Promise<void>;
+}
+/** Configuration for {@link createHarperProofingProvider}. */
+interface HarperProofingConfig {
+    /**
+     * Same-origin URL of harper's WASM binary (the host serves
+     * `harper.js/dist/harper_wasm_bg.wasm` itself — see docs/proofing.md).
+     * When omitted, the `harper.js/binary` module default is used, which
+     * relies on the host bundler resolving the WASM as an asset.
+     */
+    wasmUrl?: string;
+    /** Initial dialect (default American). */
+    dialect?: ProofDialect;
+    /** App-level dictionary loaded during setup. */
+    initialWords?: readonly string[];
+    /**
+     * Fired when the user adds a word app-wide — persist it host-side.
+     * Its absence reports `hasAppDictionary: false`, which hides the
+     * "Add to dictionary" menu item.
+     *
+     * Note the asymmetry with ignores: a dictionary word is app-global
+     * (a proper noun is spelled the same everywhere), so it belongs on
+     * the engine's config. Ignores are per-document and go through
+     * `EditorShell`'s `proofingIgnoreStore` instead.
+     */
+    onDictionaryWord?: (word: string) => void;
+    /**
+     * Escape hatch: a preconstructed harper `BinaryModule`. Typed
+     * `unknown` so harper types stay out of published declarations
+     * (Node tests pass `binaryInlined` here — harper's `file://` loader
+     * is broken on Windows).
+     */
+    binary?: unknown;
+}
+
+export type { HarperProofingConfig as H, ProofingCapability as P, ProofingDocumentRef as a, ProofingIgnoreStore as b, ProofingLanguage as c, ProofingLintOptions as d, ProofingProvider as e, ProofingProviderFactory as f };

package/dist/{useNarrationStage-Bk3mdW75.d.ts → useNarrationStage-B6r9Zlq-.d.ts}

@@ -188,6 +188,16 @@ interface UseMediaRecorderResult {
     directory: 'audio' | 'video' | null;
     /** Milliseconds elapsed since `start()` was called. Updates ~10× per second while recording. */
     durationMs: number;
+    /**
+     * Milliseconds since `start()`, read at the moment of the call — or null
+     * when no take is rolling.
+     *
+     * The companion of `durationMs`, for callers that need to STAMP an event
+     * rather than display a clock. `durationMs` is a 10 Hz state value and so
+     * lags by up to one tick, which is fine for a readout but not for recording
+     * when the presenter advanced a slide.
+     */
+    getElapsedMs: () => number | null;
     /** Most recent error, if any. */
     error: Error | null;
     /**
@@ -557,4 +567,4 @@ interface NarrationStageHandle {
 }
 declare function useNarrationStage(opts: UseNarrationStageOptions): NarrationStageHandle;
 
-export { useMediaRecorder as A, useMicAnalysis as B, type CanvasSink as C, DEFAULT_TELEPROMPTER_PREFS as D, useNarrationRecorder as E, type FloatOpenOptions as F, useNarrationStage as G, useTeleprompter as H, vadConfigForSensitivity as I, TELEPROMPTER_PREF_LIMITS as J, normalizeTeleprompterPrefs as K, type MicAnalysisHandle as M, type NarrationRecorderController as N, type PrompterTransport as P, type RecorderAudioBitrateMode as R, type TeleprompterController as T, type UseMediaRecorderOptions as U, type CaptureKind as a, type FloatTier as b, type FloatingWindowHandle as c, type FloatingWindowManager as d, type MicAnalysisStatus as e, type NarrationRecorderState as f, type NarrationStageHandle as g, type NarrationTake as h, type RecorderCameraLane as i, type RecorderExtendedMediaOptions as j, type RecorderSource as k, type RecorderState as l, type ResolvedFormat as m, type TeleprompterPrefs as n, type TeleprompterRecordingDeps as o, type UseMediaRecorderResult as p, type UseNarrationStageOptions as q, buildFilename as r, createFloatingWindowManager as s, detectFloatTiers as t, getCaptureKind as u, resolveFormat as v, supportsDisplayMedia as w, supportsMediaRecorder as x, supportsUserMedia as y, useFloatingWindow as z };
+export { useMediaRecorder as A, useMicAnalysis as B, type CanvasSink as C, DEFAULT_TELEPROMPTER_PREFS as D, useNarrationRecorder as E, type FloatOpenOptions as F, useNarrationStage as G, useTeleprompter as H, vadConfigForSensitivity as I, TELEPROMPTER_PREF_LIMITS as J, normalizeTeleprompterPrefs as K, type MicAnalysisHandle as M, type NarrationRecorderController as N, type PrompterTransport as P, type RecorderState as R, type TeleprompterController as T, type UseMediaRecorderOptions as U, type CaptureKind as a, type FloatTier as b, type FloatingWindowHandle as c, type FloatingWindowManager as d, type MicAnalysisStatus as e, type NarrationRecorderState as f, type NarrationStageHandle as g, type NarrationTake as h, type RecorderAudioBitrateMode as i, type RecorderCameraLane as j, type RecorderExtendedMediaOptions as k, type RecorderSource as l, type ResolvedFormat as m, type TeleprompterPrefs as n, type TeleprompterRecordingDeps as o, type UseMediaRecorderResult as p, type UseNarrationStageOptions as q, buildFilename as r, createFloatingWindowManager as s, detectFloatTiers as t, getCaptureKind as u, resolveFormat as v, supportsDisplayMedia as w, supportsMediaRecorder as x, supportsUserMedia as y, useFloatingWindow as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bendyline/squisq-editor-react",
-  "version": "2.8.0",
+  "version": "2.10.0",
   "description": "React editor shell with raw/WYSIWYG/preview modes for Squisq documents",
   "license": "MIT",
   "author": "Bendyline",
@@ -68,6 +68,10 @@
       "types": "./dist/teleprompter/index.d.ts",
       "import": "./dist/teleprompter/index.js"
     },
+    "./proofing": {
+      "types": "./dist/proofing/index.d.ts",
+      "import": "./dist/proofing/index.js"
+    },
     "./styles": {
       "types": "./dist/styles/index.d.ts",
       "default": "./dist/styles/index.css"
@@ -79,15 +83,21 @@
     "typecheck": "tsc --noEmit"
   },
   "peerDependencies": {
+    "harper.js": "^2.7.0",
     "monaco-editor": "~0.50.0",
     "react": "^18.0.0 || ^19.0.0",
     "react-dom": "^18.0.0 || ^19.0.0"
   },
+  "peerDependenciesMeta": {
+    "harper.js": {
+      "optional": true
+    }
+  },
   "dependencies": {
-    "@bendyline/squisq": "2.8.0",
-    "@bendyline/squisq-formats": "2.4.5",
-    "@bendyline/squisq-react": "2.8.0",
-    "@bendyline/squisq-video-react": "2.4.0",
+    "@bendyline/squisq": "2.10.0",
+    "@bendyline/squisq-formats": "2.5.0",
+    "@bendyline/squisq-react": "2.10.0",
+    "@bendyline/squisq-video-react": "2.4.2",
     "@fortawesome/fontawesome-free": "7.2.0",
     "@tiptap/core": "2.27.2",
     "@tiptap/extension-heading": "2.27.2",
@@ -112,6 +122,7 @@
     "@monaco-editor/react": "4.7.0",
     "@types/react": "18.3.28",
     "@types/react-dom": "18.3.7",
+    "harper.js": "2.7.0",
     "monaco-editor": "0.50.0",
     "react": "18.3.1",
     "react-dom": "18.3.1",