@lalternative/editor 0.9.0 → 0.10.0

package/dist/index.d.ts

@@ -1,8 +1,8 @@
-import { R as RichDoc } from './diff-uFiP8hD5.js';
-export { B as BlockChange, a as BlockShape, C as ChangeKind, b as RichNode, c as blocksFromDoc, d as diffBlocks, e as docFromBlocks, s as shapesFromDoc } from './diff-uFiP8hD5.js';
+import { R as RichDoc, a as RichNode } from './diff-9dRTXeJa.js';
+export { B as BlockChange, b as BlockShape, C as ChangeKind, c as blocksFromDoc, d as diffBlocks, e as docFromBlocks, s as shapesFromDoc } from './diff-9dRTXeJa.js';
 import * as react from 'react';
 import { Editor } from '@tiptap/react';
-import { Range, Extension } from '@tiptap/core';
+import { Range, Extension, Editor as Editor$1 } from '@tiptap/core';
 import { PluginKey } from '@tiptap/pm/state';
 import { DecorationSet } from '@tiptap/pm/view';
 
@@ -327,4 +327,141 @@ declare function splitRevision(before: string, after: string): RevisionPart[];
  */
 declare function docToMarkdown(doc: RichDoc): string;
 
-export { type BlockFormat, type DefaultSlashId, type DefaultSlashItemsOptions, EditorScreen, type EditorScreenProps, type FormatLabels, type InlineSuggestion, InlineSuggestions, type PlaceToolbarInput, type ReadViewportInput, type RevisionPart, RichDoc, type SaveLabels, type SaveState, type SelectionInfo, type SelectionRect, SelectionToolbar, type SelectionToolbarProps, SlashCommands, type SlashCommandsOptions, type SlashDescriptions, type SlashItem, type SlashLabels, SlashMenu, type SlashMenuHandle, type SlashMenuProps, type SuggestionActions, type TextRange, type ToolbarAction, type ToolbarPlacement, type ViewportMetrics, type VisualViewportLike, blockFormats, defaultFormatLabels, defaultSaveLabels, defaultSlashItems, defaultSlashLabels, docToMarkdown, expandToWords, filterSlashItems, inlineSuggestionsKey, placeToolbar, readViewport, splitRevision, useSelectionToolbar, useViewport };
+declare const MIN_PASSAGE_CHARS = 12;
+declare function canAssist(passage: string): boolean;
+/** Thrown by a host's callback when its backend has no model or search configured. */
+declare class WritingNotAvailableError extends Error {
+    constructor();
+}
+type Revise = (passage: string, instruction: string) => Promise<string>;
+declare const defaultRevisionPresets: readonly string[];
+declare function normalizeInstruction(instruction: string): string | null;
+declare function proposalChanges(passage: string, proposal: string): RevisionPart[];
+interface FoundSource {
+    title: string;
+    url: string;
+    excerpt: string;
+}
+type FindSources = (passage: string) => Promise<FoundSource[]>;
+declare function hostOf(url: string): string;
+
+interface RevisionPromptLabels {
+    title: string;
+    instruction: string;
+    placeholder: string;
+    submit: string;
+    busy: string;
+    proposal: string;
+    unchanged: string;
+    accept: string;
+    reject: string;
+    close: string;
+}
+declare const defaultRevisionPromptLabels: RevisionPromptLabels;
+interface RevisionPromptProps {
+    passage: string;
+    revise: Revise;
+    /** Called with the proposal once the author accepts it; the prompt never writes on its own. */
+    onAccept: (proposal: string) => void;
+    onClose: () => void;
+    presets?: readonly string[];
+    labels?: RevisionPromptLabels;
+    formatError?: (error: unknown) => string;
+}
+declare function RevisionPrompt({ passage, revise, onAccept, onClose, presets, labels, formatError, }: RevisionPromptProps): react.JSX.Element;
+
+interface SourcesPanelLabels {
+    title: string;
+    searching: string;
+    empty: string;
+    open: string;
+    insert: string;
+    close: string;
+}
+declare const defaultSourcesPanelLabels: SourcesPanelLabels;
+interface SourcesPanelProps {
+    passage: string;
+    findSources: FindSources;
+    onInsert: (source: FoundSource) => void;
+    onClose: () => void;
+    /** Extra per-source actions a host adds beside insert. */
+    renderActions?: (source: FoundSource) => React.ReactNode;
+    labels?: SourcesPanelLabels;
+    formatError?: (error: unknown) => string;
+}
+declare function SourcesPanel({ passage, findSources, onInsert, onClose, renderActions, labels, formatError, }: SourcesPanelProps): react.JSX.Element;
+
+interface DictationEnvironment {
+    hasGetUserMedia: boolean;
+    hasMediaRecorder: boolean;
+}
+declare function isDictationSupported(env?: DictationEnvironment): boolean;
+declare function pickMimeType(isTypeSupported?: ((type: string) => boolean) | undefined): string | undefined;
+declare function spacedTranscript(preceding: string, transcript: string): string;
+declare function insertTranscript(editor: Editor$1, transcript: string): boolean;
+
+type DictationState = "idle" | "recording" | "transcribing";
+interface UseDictationOptions {
+    transcribe: (audio: Blob) => Promise<string>;
+}
+interface UseDictation {
+    state: DictationState;
+    supported: boolean;
+    error: Error | null;
+    start: () => Promise<void>;
+    /** Stops recording and resolves with the transcript, or null when nothing was heard. */
+    stop: () => Promise<string | null>;
+    toggle: () => Promise<string | null>;
+}
+declare function useDictation({ transcribe }: UseDictationOptions): UseDictation;
+
+interface DictationLabels {
+    start: string;
+    stop: string;
+    transcribing: string;
+    unsupported: string;
+}
+declare const defaultDictationLabels: DictationLabels;
+interface DictationButtonProps {
+    transcribe: (audio: Blob) => Promise<string>;
+    onTranscript: (text: string) => void;
+    onError?: (error: Error) => void;
+    labels?: DictationLabels;
+    icon?: React.ReactNode;
+    disabled?: boolean;
+    className?: string;
+}
+declare function DictationButton({ transcribe, onTranscript, onError, labels, icon, disabled, className, }: DictationButtonProps): react.JSX.Element;
+
+interface Citation {
+    index: number;
+    title: string;
+    href?: string | null;
+}
+interface WebSource {
+    title: string;
+    url: string;
+    excerpt?: string;
+}
+interface ConversationTurn {
+    role: "user" | "assistant";
+    content: string;
+    /** A turn where the assistant asked back instead of answering. */
+    clarify?: boolean;
+    citations?: Citation[];
+}
+declare function linkMarkers(block: string, citations: Citation[]): RichNode[];
+declare function webSourceToNodes(source: WebSource): RichNode[];
+declare function answerToNodes(params: {
+    question: string;
+    answer: string;
+    citations: Citation[];
+    sourcesLabel: string;
+}): RichNode[];
+declare function headingFromQuestion(question: string): string;
+declare function conversationToNodes(params: {
+    turns: ConversationTurn[];
+    sourcesLabel: string;
+}): RichNode[];
+
+export { type BlockFormat, type Citation, type ConversationTurn, type DefaultSlashId, type DefaultSlashItemsOptions, DictationButton, type DictationButtonProps, type DictationEnvironment, type DictationLabels, type DictationState, EditorScreen, type EditorScreenProps, type FindSources, type FormatLabels, type FoundSource, type InlineSuggestion, InlineSuggestions, MIN_PASSAGE_CHARS, type PlaceToolbarInput, type ReadViewportInput, type Revise, type RevisionPart, RevisionPrompt, type RevisionPromptLabels, type RevisionPromptProps, RichDoc, RichNode, type SaveLabels, type SaveState, type SelectionInfo, type SelectionRect, SelectionToolbar, type SelectionToolbarProps, SlashCommands, type SlashCommandsOptions, type SlashDescriptions, type SlashItem, type SlashLabels, SlashMenu, type SlashMenuHandle, type SlashMenuProps, SourcesPanel, type SourcesPanelLabels, type SourcesPanelProps, type SuggestionActions, type TextRange, type ToolbarAction, type ToolbarPlacement, type UseDictation, type UseDictationOptions, type ViewportMetrics, type VisualViewportLike, type WebSource, WritingNotAvailableError, answerToNodes, blockFormats, canAssist, conversationToNodes, defaultDictationLabels, defaultFormatLabels, defaultRevisionPresets, defaultRevisionPromptLabels, defaultSaveLabels, defaultSlashItems, defaultSlashLabels, defaultSourcesPanelLabels, docToMarkdown, expandToWords, filterSlashItems, headingFromQuestion, hostOf, inlineSuggestionsKey, insertTranscript, isDictationSupported, linkMarkers, normalizeInstruction, pickMimeType, placeToolbar, proposalChanges, readViewport, spacedTranscript, splitRevision, useDictation, useSelectionToolbar, useViewport, webSourceToNodes };