logisheets-formula-editor 1.1.0

package/dist/editor.d.ts

@@ -0,0 +1,57 @@
+import { EditorView } from '@codemirror/view';
+import { FormulaEditorConfig, FormulaFunction, GetDisplayUnitsFunc } from './types';
+/**
+ * Options for {@link createFormulaEditor}. These mirror the React component's
+ * props minus the React-only bits — the React `style` prop maps to `style`
+ * here (applied to the host element).
+ */
+export interface FormulaEditorOptions {
+    /** Initial value (with leading '='). */
+    value?: string;
+    /** Initial value when `value` is not given. */
+    defaultValue?: string;
+    /** Where to place the cursor on creation (default: 'end'). */
+    initialCursorPosition?: 'start' | 'end';
+    onChange?: (value: string) => void;
+    onBlur?: (value: string) => void;
+    onSubmit?: (value: string) => void;
+    onCancel?: () => void;
+    /** Fetch token / cell-ref info from the host (required). */
+    getDisplayUnits: GetDisplayUnitsFunc;
+    /** Functions offered by autocomplete + signature help. */
+    formulaFunctions?: FormulaFunction[];
+    /** Current sheet name (for local cell-ref coloring). */
+    sheetName?: string;
+    config?: FormulaEditorConfig;
+    /** Extra class(es) added to the host element. */
+    className?: string;
+    /** Extra inline styles merged onto the host element. */
+    style?: Partial<CSSStyleDeclaration>;
+}
+/** Imperative handle returned by {@link createFormulaEditor}. */
+export interface FormulaEditorHandle {
+    focus(): void;
+    blur(): void;
+    getValue(): string;
+    setValue(value: string): void;
+    /** Insert text at the current cursor position. */
+    insertText(text: string): void;
+    /** Replace a range — useful for swapping a previously-inserted ref. */
+    replaceRange(from: number, to: number, text: string): void;
+    getCursorPosition(): number;
+    getView(): EditorView | null;
+    /**
+     * Update live options without recreating the editor. Callback / function-
+     * list / sheet-name changes apply immediately; a changed `config` rebuilds
+     * the view (preserving text + cursor); a changed controlled `value` is
+     * dispatched into the document.
+     */
+    updateOptions(opts: Partial<FormulaEditorOptions>): void;
+    destroy(): void;
+}
+/**
+ * Create a formula editor mounted into `parent`. Returns an imperative handle;
+ * call `destroy()` when done.
+ */
+export declare function createFormulaEditor(parent: HTMLElement, options: FormulaEditorOptions): FormulaEditorHandle;
+//# sourceMappingURL=editor.d.ts.map

package/dist/editor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"editor.d.ts","sourceRoot":"","sources":["../src/lib/editor.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAGH,OAAO,EACH,UAAU,EAQb,MAAM,kBAAkB,CAAA;AAUzB,OAAO,KAAK,EAER,mBAAmB,EACnB,eAAe,EACf,mBAAmB,EACtB,MAAM,SAAS,CAAA;AAsUhB;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACjC,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,+CAA+C;IAC/C,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,8DAA8D;IAC9D,qBAAqB,CAAC,EAAE,OAAO,GAAG,KAAK,CAAA;IACvC,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IAClC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IAChC,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IAClC,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAA;IACrB,4DAA4D;IAC5D,eAAe,EAAE,mBAAmB,CAAA;IACpC,0DAA0D;IAC1D,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAA;IACpC,wDAAwD;IACxD,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE,mBAAmB,CAAA;IAC5B,iDAAiD;IACjD,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,wDAAwD;IACxD,KAAK,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAA;CACvC;AAED,iEAAiE;AACjE,MAAM,WAAW,mBAAmB;IAChC,KAAK,IAAI,IAAI,CAAA;IACb,IAAI,IAAI,IAAI,CAAA;IACZ,QAAQ,IAAI,MAAM,CAAA;IAClB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,kDAAkD;IAClD,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,uEAAuE;IACvE,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1D,iBAAiB,IAAI,MAAM,CAAA;IAC3B,OAAO,IAAI,UAAU,GAAG,IAAI,CAAA;IAC5B;;;;;OAKG;IACH,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAA;IACxD,OAAO,IAAI,IAAI,CAAA;CAClB;AAcD;;;GAGG;AACH,wBAAgB,mBAAmB,CAC/B,MAAM,EAAE,WAAW,EACnB,OAAO,EAAE,oBAAoB,GAC9B,mBAAmB,CA8drB"}

package/dist/engine.d.ts

@@ -0,0 +1,34 @@
+import { CellRef, FormulaFunction, GetDisplayUnitsFunc } from './types';
+/** The slice of a workbook client the source needs. */
+export interface FormulaWorkbook {
+    getDisplayUnitsOfFormula(formula: string): Promise<unknown>;
+}
+/** The slice of an engine `DataService` the source needs. */
+export interface EngineFormulaServices {
+    getWorkbook(): FormulaWorkbook;
+    checkFormula(formula: string): Promise<boolean>;
+}
+export interface EngineFormulaSourceOptions {
+    /**
+     * Functions for autocomplete + signature help. Defaults to the bundled
+     * {@link builtinFormulaFunctions}; pass a localized list to override.
+     */
+    formulaFunctions?: FormulaFunction[];
+    /**
+     * Called with the parsed cell references each time display units are
+     * fetched — wire this to your reference-highlight overlay.
+     */
+    onCellRefs?: (cellRefs: readonly CellRef[]) => void;
+}
+/** Props the editor consumes, derived from the engine. */
+export interface EngineFormulaSource {
+    getDisplayUnits: GetDisplayUnitsFunc;
+    checkFormula: (formula: string) => Promise<boolean>;
+    formulaFunctions: FormulaFunction[];
+}
+/**
+ * Build the editor's data props from an engine `DataService`. Spread the result
+ * into `createFormulaEditor` / `<FormulaEditor>`.
+ */
+export declare function createEngineFormulaSource(services: EngineFormulaServices, options?: EngineFormulaSourceOptions): EngineFormulaSource;
+//# sourceMappingURL=engine.d.ts.map

package/dist/engine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine.d.ts","sourceRoot":"","sources":["../src/lib/engine.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,KAAK,EACR,OAAO,EAEP,eAAe,EACf,mBAAmB,EACtB,MAAM,SAAS,CAAA;AAGhB,uDAAuD;AACvD,MAAM,WAAW,eAAe;IAC5B,wBAAwB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CAC9D;AAED,6DAA6D;AAC7D,MAAM,WAAW,qBAAqB;IAClC,WAAW,IAAI,eAAe,CAAA;IAC9B,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CAClD;AAED,MAAM,WAAW,0BAA0B;IACvC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAA;IACpC;;;OAGG;IACH,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,SAAS,OAAO,EAAE,KAAK,IAAI,CAAA;CACtD;AAED,0DAA0D;AAC1D,MAAM,WAAW,mBAAmB;IAChC,eAAe,EAAE,mBAAmB,CAAA;IACpC,YAAY,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;IACnD,gBAAgB,EAAE,eAAe,EAAE,CAAA;CACtC;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,CACrC,QAAQ,EAAE,qBAAqB,EAC/B,OAAO,GAAE,0BAA+B,GACzC,mBAAmB,CA8BrB"}

package/dist/engine.js

@@ -0,0 +1,23 @@
+import { b as f } from "./functions-Cxg5fTo6.js";
+function o(c, e = {}) {
+  const a = e.formulaFunctions ?? f;
+  return {
+    getDisplayUnits: async (t) => {
+      var l, n;
+      try {
+        const r = await c.getWorkbook().getDisplayUnitsOfFormula(t);
+        if (r && typeof r == "object" && "tokenUnits" in r) {
+          const u = r;
+          return (l = e.onCellRefs) == null || l.call(e, u.cellRefs), u;
+        }
+      } catch {
+      }
+      (n = e.onCellRefs) == null || n.call(e, []);
+    },
+    checkFormula: (t) => c.checkFormula(t),
+    formulaFunctions: a
+  };
+}
+export {
+  o as createEngineFormulaSource
+};