@rustledger/wasm 0.1.0 → 0.4.0

package/rustledger_wasm.d.ts

@@ -73,18 +73,18 @@ export interface CloseDirective extends BaseDirective {
 
 /** All directive types. */
 export type Directive =
-    | TransactionDirective
-    | BalanceDirective
-    | OpenDirective
-    | CloseDirective
-    | { type: 'commodity'; date: string; currency: string }
-    | { type: 'pad'; date: string; account: string; source_account: string }
-    | { type: 'event'; date: string; event_type: string; value: string }
-    | { type: 'note'; date: string; account: string; comment: string }
-    | { type: 'document'; date: string; account: string; path: string }
-    | { type: 'price'; date: string; currency: string; amount: Amount }
-    | { type: 'query'; date: string; name: string; query_string: string }
-    | { type: 'custom'; date: string; custom_type: string };
+| TransactionDirective
+| BalanceDirective
+| OpenDirective
+| CloseDirective
+| { type: 'commodity'; date: string; currency: string }
+| { type: 'pad'; date: string; account: string; source_account: string }
+| { type: 'event'; date: string; event_type: string; value: string }
+| { type: 'note'; date: string; account: string; comment: string }
+| { type: 'document'; date: string; account: string; path: string }
+| { type: 'price'; date: string; currency: string; amount: Amount }
+| { type: 'query'; date: string; name: string; query_string: string }
+| { type: 'custom'; date: string; custom_type: string };
 
 /** Ledger options. */
 export interface LedgerOptions {
@@ -112,14 +112,14 @@ export interface ValidationResult {
 
 /** Cell value in query results. */
 export type CellValue =
-    | null
-    | string
-    | number
-    | boolean
-    | Amount
-    | { units: Amount; cost?: { number: string; currency: string; date?: string; label?: string } }
-    | { positions: Array<{ units: Amount }> }
-    | string[];
+| null
+| string
+| number
+| boolean
+| Amount
+| { units: Amount; cost?: { number: string; currency: string; date?: string; label?: string } }
+| { positions: Array<{ units: Amount }> }
+| string[];
 
 /** Result of a BQL query. */
 export interface QueryResult {
@@ -166,6 +166,60 @@ export interface CompletionResult {
     context: string;
 }
 
+// =============================================================================
+// Editor Integration Types (LSP-like features)
+// =============================================================================
+
+/** The kind of a completion item. */
+export type EditorCompletionKind = 'keyword' | 'account' | 'accountsegment' | 'currency' | 'payee' | 'date' | 'text';
+
+/** A completion item for Beancount source editing. */
+export interface EditorCompletion {
+    label: string;
+    kind: EditorCompletionKind;
+    detail?: string;
+    insertText?: string;
+}
+
+/** Result of an editor completion request. */
+export interface EditorCompletionResult {
+    completions: EditorCompletion[];
+    context: string;
+}
+
+/** A range in the document. */
+export interface EditorRange {
+    start_line: number;
+    start_character: number;
+    end_line: number;
+    end_character: number;
+}
+
+/** Hover information for a symbol. */
+export interface EditorHoverInfo {
+    contents: string;
+    range?: EditorRange;
+}
+
+/** A location in the document. */
+export interface EditorLocation {
+    line: number;
+    character: number;
+}
+
+/** The kind of a symbol. */
+export type SymbolKind = 'transaction' | 'account' | 'balance' | 'commodity' | 'posting' | 'pad' | 'event' | 'note' | 'document' | 'price' | 'query' | 'custom';
+
+/** A document symbol for the outline view. */
+export interface EditorDocumentSymbol {
+    name: string;
+    detail?: string;
+    kind: SymbolKind;
+    range: EditorRange;
+    children?: EditorDocumentSymbol[];
+    deprecated?: boolean;
+}
+
 /**
  * A parsed and validated ledger that caches the parse result.
  * Use this class when you need to perform multiple operations on the same
@@ -210,67 +264,126 @@ export class ParsedLedger {
 
     /** Run a native plugin on this ledger. */
     runPlugin(pluginName: string): PluginResult;
+
+    // =========================================================================
+    // Editor Integration (LSP-like features)
+    // =========================================================================
+
+    /** Get completions at the given position. */
+    getCompletions(line: number, character: number): EditorCompletionResult;
+
+    /** Get hover information at the given position. */
+    getHoverInfo(line: number, character: number): EditorHoverInfo | null;
+
+    /** Get the definition location for the symbol at the given position. */
+    getDefinition(line: number, character: number): EditorLocation | null;
+
+    /** Get all document symbols for the outline view. */
+    getDocumentSymbols(): EditorDocumentSymbol[];
 }
 
 
 
+/**
+ * A parsed and validated ledger that caches the parse result.
+ *
+ * Use this class when you need to perform multiple operations on the same
+ * source without re-parsing each time.
+ *
+ * # Example (JavaScript)
+ *
+ * ```javascript
+ * const ledger = new ParsedLedger(source);
+ * if (ledger.isValid()) {
+ *     const balances = ledger.query("BALANCES");
+ *     const formatted = ledger.format();
+ * }
+ * ```
+ */
 export class ParsedLedger {
-  free(): void;
-  [Symbol.dispose](): void;
-  /**
-   * Get all errors (parse + validation).
-   */
-  getErrors(): any;
-  /**
-   * Run a native plugin on this ledger.
-   */
-  runPlugin(plugin_name: string): any;
-  /**
-   * Expand pad directives.
-   */
-  expandPads(): any;
-  /**
-   * Get the ledger options.
-   */
-  getOptions(): any;
-  /**
-   * Get the parsed directives.
-   */
-  getDirectives(): any;
-  /**
-   * Get the number of directives.
-   */
-  directiveCount(): number;
-  /**
-   * Get parse errors only.
-   */
-  getParseErrors(): any;
-  /**
-   * Get validation errors only.
-   */
-  getValidationErrors(): any;
-  /**
-   * Create a new `ParsedLedger` from source text.
-   *
-   * Parses, interpolates, and validates the source. Call `isValid()` to check for errors.
-   */
-  constructor(source: string);
-  /**
-   * Run a BQL query on this ledger.
-   */
-  query(query_str: string): any;
-  /**
-   * Format the ledger source.
-   */
-  format(): any;
-  /**
-   * Get account balances (shorthand for query("BALANCES")).
-   */
-  balances(): any;
-  /**
-   * Check if the ledger is valid (no parse or validation errors).
-   */
-  isValid(): boolean;
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Get account balances (shorthand for query("BALANCES")).
+     */
+    balances(): any;
+    /**
+     * Get the number of directives.
+     */
+    directiveCount(): number;
+    /**
+     * Expand pad directives.
+     */
+    expandPads(): any;
+    /**
+     * Format the ledger source.
+     */
+    format(): any;
+    /**
+     * Get completions at the given position.
+     *
+     * Returns context-aware completions for accounts, currencies, directives, etc.
+     * Uses cached account/currency/payee data for efficiency.
+     */
+    getCompletions(line: number, character: number): any;
+    /**
+     * Get the definition location for the symbol at the given position.
+     *
+     * Returns the location of the `open` or `commodity` directive for accounts/currencies.
+     * Uses cached `LineIndex` for O(log n) position lookups.
+     */
+    getDefinition(line: number, character: number): any;
+    /**
+     * Get the parsed directives.
+     */
+    getDirectives(): any;
+    /**
+     * Get all document symbols for the outline view.
+     *
+     * Returns a hierarchical list of all directives with their positions.
+     * Uses cached `LineIndex` for O(log n) position lookups.
+     */
+    getDocumentSymbols(): any;
+    /**
+     * Get all errors (parse + validation).
+     */
+    getErrors(): any;
+    /**
+     * Get hover information at the given position.
+     *
+     * Returns documentation for accounts, currencies, and directive keywords.
+     */
+    getHoverInfo(line: number, character: number): any;
+    /**
+     * Get the ledger options.
+     */
+    getOptions(): any;
+    /**
+     * Get parse errors only.
+     */
+    getParseErrors(): any;
+    /**
+     * Get validation errors only.
+     */
+    getValidationErrors(): any;
+    /**
+     * Check if the ledger is valid (no parse or validation errors).
+     */
+    isValid(): boolean;
+    /**
+     * Create a new `ParsedLedger` from source text.
+     *
+     * Parses, interpolates, and validates the source. Call `isValid()` to check for errors.
+     */
+    constructor(source: string);
+    /**
+     * Run a BQL query on this ledger.
+     */
+    query(query_str: string): any;
+    /**
+     * Run a native plugin on this ledger.
+     */
+    runPlugin(plugin_name: string): any;
 }
 
 /**
@@ -357,57 +470,61 @@ export function version(): string;
 export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
 
 export interface InitOutput {
-  readonly memory: WebAssembly.Memory;
-  readonly __wbg_parsedledger_free: (a: number, b: number) => void;
-  readonly balances: (a: number, b: number, c: number) => void;
-  readonly bqlCompletions: (a: number, b: number, c: number, d: number) => void;
-  readonly expandPads: (a: number, b: number, c: number) => void;
-  readonly format: (a: number, b: number, c: number) => void;
-  readonly listPlugins: (a: number) => void;
-  readonly parse: (a: number, b: number, c: number) => void;
-  readonly parsedledger_balances: (a: number, b: number) => void;
-  readonly parsedledger_directiveCount: (a: number) => number;
-  readonly parsedledger_expandPads: (a: number, b: number) => void;
-  readonly parsedledger_format: (a: number, b: number) => void;
-  readonly parsedledger_getDirectives: (a: number, b: number) => void;
-  readonly parsedledger_getErrors: (a: number, b: number) => void;
-  readonly parsedledger_getOptions: (a: number, b: number) => void;
-  readonly parsedledger_getParseErrors: (a: number, b: number) => void;
-  readonly parsedledger_getValidationErrors: (a: number, b: number) => void;
-  readonly parsedledger_isValid: (a: number) => number;
-  readonly parsedledger_new: (a: number, b: number) => number;
-  readonly parsedledger_query: (a: number, b: number, c: number, d: number) => void;
-  readonly parsedledger_runPlugin: (a: number, b: number, c: number, d: number) => void;
-  readonly query: (a: number, b: number, c: number, d: number, e: number) => void;
-  readonly runPlugin: (a: number, b: number, c: number, d: number, e: number) => void;
-  readonly validateSource: (a: number, b: number, c: number) => void;
-  readonly version: (a: number) => void;
-  readonly init: () => void;
-  readonly __wbindgen_export: (a: number, b: number) => number;
-  readonly __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
-  readonly __wbindgen_export3: (a: number, b: number, c: number) => void;
-  readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
-  readonly __wbindgen_start: () => void;
+    readonly memory: WebAssembly.Memory;
+    readonly __wbg_parsedledger_free: (a: number, b: number) => void;
+    readonly balances: (a: number, b: number, c: number) => void;
+    readonly bqlCompletions: (a: number, b: number, c: number, d: number) => void;
+    readonly expandPads: (a: number, b: number, c: number) => void;
+    readonly format: (a: number, b: number, c: number) => void;
+    readonly listPlugins: (a: number) => void;
+    readonly parse: (a: number, b: number, c: number) => void;
+    readonly parsedledger_balances: (a: number, b: number) => void;
+    readonly parsedledger_directiveCount: (a: number) => number;
+    readonly parsedledger_expandPads: (a: number, b: number) => void;
+    readonly parsedledger_format: (a: number, b: number) => void;
+    readonly parsedledger_getCompletions: (a: number, b: number, c: number, d: number) => void;
+    readonly parsedledger_getDefinition: (a: number, b: number, c: number, d: number) => void;
+    readonly parsedledger_getDirectives: (a: number, b: number) => void;
+    readonly parsedledger_getDocumentSymbols: (a: number, b: number) => void;
+    readonly parsedledger_getErrors: (a: number, b: number) => void;
+    readonly parsedledger_getHoverInfo: (a: number, b: number, c: number, d: number) => void;
+    readonly parsedledger_getOptions: (a: number, b: number) => void;
+    readonly parsedledger_getParseErrors: (a: number, b: number) => void;
+    readonly parsedledger_getValidationErrors: (a: number, b: number) => void;
+    readonly parsedledger_isValid: (a: number) => number;
+    readonly parsedledger_new: (a: number, b: number) => number;
+    readonly parsedledger_query: (a: number, b: number, c: number, d: number) => void;
+    readonly parsedledger_runPlugin: (a: number, b: number, c: number, d: number) => void;
+    readonly query: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly runPlugin: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly validateSource: (a: number, b: number, c: number) => void;
+    readonly version: (a: number) => void;
+    readonly init: () => void;
+    readonly __wbindgen_export: (a: number, b: number) => number;
+    readonly __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
+    readonly __wbindgen_export3: (a: number, b: number, c: number) => void;
+    readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
+    readonly __wbindgen_start: () => void;
 }
 
 export type SyncInitInput = BufferSource | WebAssembly.Module;
 
 /**
-* Instantiates the given `module`, which can either be bytes or
-* a precompiled `WebAssembly.Module`.
-*
-* @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
-*
-* @returns {InitOutput}
-*/
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
 export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
 
 /**
-* If `module_or_path` is {RequestInfo} or {URL}, makes a request and
-* for everything else, calls `WebAssembly.instantiate` directly.
-*
-* @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
-*
-* @returns {Promise<InitOutput>}
-*/
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
 export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;