@xlcalc/vue 0.21.1 → 0.23.1

package/dist/local/types.d.ts

@@ -1,5 +1,6 @@
 import type { AsyncSessionOptions, BookInput, BookSnapshot, Calc, CalcPoolOptions, SessionHistory } from 'xlcalc';
 import type { SheetSource } from '../contract/source.js';
+import type { SpellChecker } from '../contract/workbook.js';
 export interface LocalSourceOptions {
     /**
      * Where the workbook is calculated: `pool`, in Web Workers of `xlcalc/worker` (the default where `Worker` exists);
@@ -15,9 +16,11 @@ export interface LocalSourceOptions {
     maxCells?: number;
     /** A notice included in every window (displayed above the grid), e.g. what the xlsx reader left out. */
     notice?: string;
+    /** The host's word checker for Excel's Spelling; without it the source has no `spelling`. */
+    spelling?: SpellChecker;
 }
 /** Methods of `SheetSource` that the local source always has. */
-type Given = 'edit' | 'paste' | 'fill' | 'pick' | 'end' | 'undo' | 'redo' | 'structure' | 'layout' | 'format' | 'replace' | 'outline' | 'freeze' | 'subscribe' | 'validation' | 'functionNames' | 'functionSignature' | 'explain' | 'stats' | 'find' | 'visibleRows' | 'columnValues';
+type Given = 'edit' | 'paste' | 'fill' | 'pick' | 'end' | 'undo' | 'redo' | 'structure' | 'layout' | 'format' | 'replace' | 'outline' | 'freeze' | 'subscribe' | 'validation' | 'functionNames' | 'functionSignature' | 'explain' | 'stats' | 'find' | 'visibleRows' | 'columnValues' | 'clear' | 'link' | 'note' | 'names' | 'setNames' | 'dependents' | 'rules' | 'setRules' | 'table' | 'autoSum';
 /** A sheet source over an xlcalc workbook: every method of `SheetSource`, plus the host's handles on the workbook. */
 export interface LocalSource extends Omit<SheetSource, Given | 'maxCells'>, Required<Pick<SheetSource, Given>> {
     readonly maxCells: number;

package/dist/local/workbook.d.ts

@@ -0,0 +1,25 @@
+import { type AsyncSession, type CellChange, type EditResult } from 'xlcalc';
+import type { EditOutcome } from '../contract/source.js';
+import type { ClearKind, SheetDependents, SheetLink, SheetName, SheetNote, SheetRules, SpellChecker, SpellingHit, SpellingRequest, TableOp } from '../contract/workbook.js';
+/** How the source completes a change: the windows re-read in place over ranges, or the sheets and windows read again. */
+export interface Completion {
+    repainted(got: EditResult, ranges: {
+        sheet: string;
+        range: string;
+    }[]): EditOutcome;
+    reloaded(changes: CellChange[]): EditOutcome;
+}
+/** The workbook methods of the local source over its session, completed by `done`, with formulas in `locale`. */
+export declare function workbookMethods(locale: string, done: Completion, checker?: SpellChecker): {
+    clear: (s: AsyncSession, sheet: string, ranges: string[], what: ClearKind) => Promise<EditOutcome>;
+    link: (s: AsyncSession, sheet: string, range: string, link: SheetLink | null) => Promise<EditOutcome>;
+    note: (s: AsyncSession, sheet: string, cell: string, note: SheetNote | null) => Promise<EditOutcome>;
+    names: (s: AsyncSession) => Promise<SheetName[]>;
+    setNames: (s: AsyncSession, list: SheetName[]) => Promise<EditOutcome>;
+    dependents: (s: AsyncSession, sheet: string, range: string, signal?: AbortSignal) => Promise<SheetDependents>;
+    rules: (s: AsyncSession, sheet: string) => Promise<SheetRules>;
+    setRules: (s: AsyncSession, sheet: string, next: Partial<SheetRules>) => Promise<EditOutcome>;
+    table: (s: AsyncSession, op: TableOp) => Promise<EditOutcome>;
+    spelling: (s: AsyncSession, req: SpellingRequest, signal?: AbortSignal) => Promise<SpellingHit | null>;
+    learnWord: (word: string) => Promise<void>;
+};