beancount 0.0.31 → 0.2.0

package/build/src/classes/nodes/Open.mjs

@@ -0,0 +1,66 @@
+import { assertNodeConstructor } from '../Node.mjs';
+import { DatedNode } from '../DatedNode.mjs';
+import { simpleParseLine } from '../../utils/simpleParseLine.mjs';
+import { parseString } from '../Value.mjs';
+import { defaultFormatOptions } from '../ParseResult.mjs';
+/**
+ * Represents an Open node that declares a new account.
+ * Open directives define the beginning of an account's lifespan.
+ */
+export class Open extends DatedNode {
+    constructor() {
+        super(...arguments);
+        /** @inheritdoc */
+        this.type = 'open';
+    }
+    /**
+     * Creates an Open instance from a generic parse result.
+     * @param genericParseResult - The parsed open node data
+     * @returns A new Open instance
+     */
+    static fromGenericParseResult(genericParseResult) {
+        const [account, ...other] = simpleParseLine(genericParseResult.header);
+        let constraintCurrencies, bookingMethod;
+        if (other.length === 2) {
+            constraintCurrencies = other[0];
+            bookingMethod = parseString(other[1]);
+        }
+        else if (other.length === 1) {
+            if (other[0].startsWith('"') && other[0].endsWith('"')) {
+                bookingMethod = parseString(other[0]);
+            }
+            else {
+                constraintCurrencies = other[0];
+            }
+        }
+        return new Open({
+            ...genericParseResult.props,
+            account,
+            constraintCurrencies: constraintCurrencies?.split(','),
+            bookingMethod,
+        });
+    }
+    /** @inheritdoc */
+    toString() {
+        return this.toFormattedString({ currencyColumn: 0 });
+    }
+    /** @inheritdoc */
+    toFormattedString(formatOptions = defaultFormatOptions) {
+        const parts = [`${this.getDateTypePrefix()} ${this.account}`];
+        if (this.constraintCurrencies !== undefined) {
+            const paddingLength = formatOptions.currencyColumn -
+                parts.join(' ').length -
+                this.constraintCurrencies.join(',').length;
+            if (paddingLength > 0) {
+                parts.push(' '.repeat(paddingLength));
+            }
+            parts.push(this.constraintCurrencies.join(','));
+        }
+        if (this.bookingMethod !== undefined) {
+            parts.push(`"${this.bookingMethod}"`);
+        }
+        return parts.join(' ') + this.getMetaDataString();
+    }
+}
+// Ensure class conforms to NodeConstructor pattern
+assertNodeConstructor(Open);

package/build/src/classes/nodes/Option.d.mts

@@ -0,0 +1,23 @@
+import type { GenericParseResult } from '../../genericParse.mjs';
+import { Value } from '../Value.mjs';
+import { Node } from '../Node.mjs';
+/**
+ * Represents an Option node that sets a Beancount configuration option.
+ * Option directives configure various aspects of Beancount's behavior.
+ */
+export declare class Option extends Node {
+    /** @inheritdoc */
+    type: "option";
+    /** The option name */
+    name: string;
+    /** The option value */
+    value: Value;
+    /**
+     * Creates an Option instance from a generic parse result.
+     * @param genericParseResult - The parsed option node data
+     * @returns A new Option instance
+     */
+    static fromGenericParseResult(genericParseResult: GenericParseResult): Option;
+    /** @inheritdoc */
+    toString(): string;
+}

package/build/src/classes/nodes/Option.mjs

@@ -0,0 +1,32 @@
+import { parseString, Value } from '../Value.mjs';
+import { stringAwareParseLine } from '../../utils/stringAwareParseLine.mjs';
+import { assertNodeConstructor, Node } from '../Node.mjs';
+/**
+ * Represents an Option node that sets a Beancount configuration option.
+ * Option directives configure various aspects of Beancount's behavior.
+ */
+export class Option extends Node {
+    constructor() {
+        super(...arguments);
+        /** @inheritdoc */
+        this.type = 'option';
+    }
+    /**
+     * Creates an Option instance from a generic parse result.
+     * @param genericParseResult - The parsed option node data
+     * @returns A new Option instance
+     */
+    static fromGenericParseResult(genericParseResult) {
+        const [name, value] = stringAwareParseLine(genericParseResult.header);
+        return new Option({
+            name: parseString(name),
+            value: Value.fromString(value),
+        });
+    }
+    /** @inheritdoc */
+    toString() {
+        return `${this.type} "${this.name}" ${this.value.toString()}`;
+    }
+}
+// Ensure class conforms to NodeConstructor pattern
+assertNodeConstructor(Option);

package/build/src/classes/nodes/Pad.d.mts

@@ -0,0 +1,22 @@
+import type { GenericParseResultWithDate } from '../../genericParse.mjs';
+import { DatedNode } from '../DatedNode.mjs';
+/**
+ * Represents a Pad node that automatically balances accounts.
+ * Pad directives insert transactions to bring an account to a specific balance.
+ */
+export declare class Pad extends DatedNode {
+    /** @inheritdoc */
+    type: "pad";
+    /** The account to be padded/balanced */
+    account: string;
+    /** The source account to use for padding */
+    accountPad: string;
+    /**
+     * Creates a Pad instance from a generic parse result.
+     * @param genericParseResult - The parsed pad node data
+     * @returns A new Pad instance
+     */
+    static fromGenericParseResult(genericParseResult: GenericParseResultWithDate): Pad;
+    /** @inheritdoc */
+    toString(): string;
+}

package/build/src/classes/nodes/Pad.mjs

@@ -0,0 +1,33 @@
+import { assertNodeConstructor } from '../Node.mjs';
+import { DatedNode } from '../DatedNode.mjs';
+import { simpleParseLine } from '../../utils/simpleParseLine.mjs';
+/**
+ * Represents a Pad node that automatically balances accounts.
+ * Pad directives insert transactions to bring an account to a specific balance.
+ */
+export class Pad extends DatedNode {
+    constructor() {
+        super(...arguments);
+        /** @inheritdoc */
+        this.type = 'pad';
+    }
+    /**
+     * Creates a Pad instance from a generic parse result.
+     * @param genericParseResult - The parsed pad node data
+     * @returns A new Pad instance
+     */
+    static fromGenericParseResult(genericParseResult) {
+        const [account, accountPad] = simpleParseLine(genericParseResult.header);
+        return new Pad({
+            ...genericParseResult.props,
+            account,
+            accountPad,
+        });
+    }
+    /** @inheritdoc */
+    toString() {
+        return `${this.getDateTypePrefix()} ${this.account} ${this.accountPad}${this.getMetaDataString()}`;
+    }
+}
+// Ensure class conforms to NodeConstructor pattern
+assertNodeConstructor(Pad);

package/build/src/classes/nodes/Plugin.d.mts

@@ -0,0 +1,22 @@
+import type { GenericParseResult } from '../../genericParse.mjs';
+import { Node } from '../Node.mjs';
+/**
+ * Represents a Plugin node that loads a Beancount plugin.
+ * Plugin directives enable plugins to process the ledger.
+ */
+export declare class Plugin extends Node {
+    /** @inheritdoc */
+    type: "plugin";
+    /** The Python module name of the plugin */
+    moduleName: string;
+    /** Optional configuration string for the plugin */
+    config?: string;
+    /**
+     * Creates a Plugin instance from a generic parse result.
+     * @param genericParseResult - The parsed plugin node data
+     * @returns A new Plugin instance
+     */
+    static fromGenericParseResult(genericParseResult: GenericParseResult): Plugin;
+    /** @inheritdoc */
+    toString(): string;
+}

package/build/src/classes/nodes/Plugin.mjs

@@ -0,0 +1,36 @@
+import { parseString } from '../Value.mjs';
+import { stringAwareParseLine } from '../../utils/stringAwareParseLine.mjs';
+import { assertNodeConstructor, Node } from '../Node.mjs';
+/**
+ * Represents a Plugin node that loads a Beancount plugin.
+ * Plugin directives enable plugins to process the ledger.
+ */
+export class Plugin extends Node {
+    constructor() {
+        super(...arguments);
+        /** @inheritdoc */
+        this.type = 'plugin';
+    }
+    /**
+     * Creates a Plugin instance from a generic parse result.
+     * @param genericParseResult - The parsed plugin node data
+     * @returns A new Plugin instance
+     */
+    static fromGenericParseResult(genericParseResult) {
+        const [moduleName, config] = stringAwareParseLine(genericParseResult.header);
+        return new Plugin({
+            moduleName: parseString(moduleName),
+            config: config ? parseString(config) : undefined,
+        });
+    }
+    /** @inheritdoc */
+    toString() {
+        const parts = [`${this.type} "${this.moduleName}"`];
+        if (this.config !== undefined) {
+            parts.push(`"${this.config}"`);
+        }
+        return parts.join(' ');
+    }
+}
+// Ensure class conforms to NodeConstructor pattern
+assertNodeConstructor(Plugin);

package/build/src/classes/nodes/Poptag.d.mts

@@ -0,0 +1,21 @@
+import type { GenericParseResult } from '../../genericParse.mjs';
+import { Node } from '../Node.mjs';
+import { Tag } from './Transaction/Tag.mjs';
+/**
+ * Represents a Poptag node that removes a tag from the tag stack.
+ * Transactions after this will no longer inherit the popped tag.
+ */
+export declare class Poptag extends Node {
+    /** @inheritdoc */
+    type: "poptag";
+    /** The tag being popped from the stack */
+    tag: Tag;
+    /**
+     * Creates a Poptag instance from a generic parse result.
+     * @param genericParseResult - The parsed poptag node data
+     * @returns A new Poptag instance
+     */
+    static fromGenericParseResult(genericParseResult: GenericParseResult): Poptag;
+    /** @inheritdoc */
+    toString(): string;
+}

package/build/src/classes/nodes/Poptag.mjs

@@ -0,0 +1,34 @@
+import { simpleParseLine } from '../../utils/simpleParseLine.mjs';
+import { assertNodeConstructor, Node } from '../Node.mjs';
+import { Tag } from './Transaction/Tag.mjs';
+/**
+ * Represents a Poptag node that removes a tag from the tag stack.
+ * Transactions after this will no longer inherit the popped tag.
+ */
+export class Poptag extends Node {
+    constructor() {
+        super(...arguments);
+        /** @inheritdoc */
+        this.type = 'poptag';
+    }
+    /**
+     * Creates a Poptag instance from a generic parse result.
+     * @param genericParseResult - The parsed poptag node data
+     * @returns A new Poptag instance
+     */
+    static fromGenericParseResult(genericParseResult) {
+        const [tagContent] = simpleParseLine(genericParseResult.header);
+        return new Poptag({
+            tag: new Tag({
+                content: tagContent.trim().replace(/^#/, ''),
+                fromStack: true,
+            }),
+        });
+    }
+    /** @inheritdoc */
+    toString() {
+        return `poptag #${this.tag.content}`;
+    }
+}
+// Ensure class conforms to NodeConstructor pattern
+assertNodeConstructor(Poptag);

package/build/src/classes/nodes/Price.d.mts

@@ -0,0 +1,32 @@
+import type { GenericParseResultWithDate } from '../../genericParse.mjs';
+import { DatedNode } from '../DatedNode.mjs';
+import { FormatOptions } from '../ParseResult.mjs';
+/**
+ * Represents a Price node that records the price of a commodity.
+ * Price directives establish the exchange rate between a commodity and a currency.
+ */
+export declare class Price extends DatedNode {
+    /** @inheritdoc */
+    type: "price";
+    /** The commodity being priced */
+    commodity: string;
+    /** The currency the price is expressed in */
+    currency: string;
+    /** The price amount */
+    amount: string;
+    /**
+     * Gets the formatted price string (amount + currency).
+     * @returns The formatted price string
+     */
+    get price(): string | undefined;
+    /**
+     * Creates a Price instance from a generic parse result.
+     * @param genericParseResult - The parsed price node data
+     * @returns A new Price instance
+     */
+    static fromGenericParseResult(genericParseResult: GenericParseResultWithDate): Price;
+    /** @inheritdoc */
+    toString(): string;
+    /** @inheritdoc */
+    toFormattedString(formatOptions?: FormatOptions): string;
+}

package/build/src/classes/nodes/Price.mjs

@@ -0,0 +1,57 @@
+import { assertNodeConstructor } from '../Node.mjs';
+import { DatedNode } from '../DatedNode.mjs';
+import { simpleParseLine } from '../../utils/simpleParseLine.mjs';
+import { formatPrice } from '../../utils/formatPrice.mjs';
+import { defaultFormatOptions } from '../ParseResult.mjs';
+/**
+ * Represents a Price node that records the price of a commodity.
+ * Price directives establish the exchange rate between a commodity and a currency.
+ */
+export class Price extends DatedNode {
+    constructor() {
+        super(...arguments);
+        /** @inheritdoc */
+        this.type = 'price';
+    }
+    /**
+     * Gets the formatted price string (amount + currency).
+     * @returns The formatted price string
+     */
+    get price() {
+        return formatPrice(this.amount, this.currency);
+    }
+    /**
+     * Creates a Price instance from a generic parse result.
+     * @param genericParseResult - The parsed price node data
+     * @returns A new Price instance
+     */
+    static fromGenericParseResult(genericParseResult) {
+        const [commodity, amount, currency] = simpleParseLine(genericParseResult.header);
+        return new Price({
+            ...genericParseResult.props,
+            commodity,
+            currency,
+            amount,
+        });
+    }
+    /** @inheritdoc */
+    toString() {
+        return this.toFormattedString({ currencyColumn: 0 });
+    }
+    /** @inheritdoc */
+    toFormattedString(formatOptions = defaultFormatOptions) {
+        const parts = [this.getDateTypePrefix(), this.commodity];
+        const paddingLength = formatOptions.currencyColumn -
+            parts.join(' ').length -
+            this.amount.length -
+            2 - // indent
+            2; // spacing
+        if (paddingLength > 0) {
+            parts.push(' '.repeat(paddingLength));
+        }
+        parts.push(this.amount, `${this.currency}${this.getMetaDataString()}`);
+        return parts.join(' ');
+    }
+}
+// Ensure class conforms to NodeConstructor pattern
+assertNodeConstructor(Price);

package/build/src/classes/nodes/Pushtag.d.mts

@@ -0,0 +1,21 @@
+import type { GenericParseResult } from '../../genericParse.mjs';
+import { Node } from '../Node.mjs';
+import { Tag } from './Transaction/Tag.mjs';
+/**
+ * Represents a Pushtag node that pushes a tag onto the tag stack.
+ * Subsequent transactions will automatically inherit this tag until it's popped.
+ */
+export declare class Pushtag extends Node {
+    /** @inheritdoc */
+    type: "pushtag";
+    /** The tag being pushed onto the stack */
+    tag: Tag;
+    /**
+     * Creates a Pushtag instance from a generic parse result.
+     * @param genericParseResult - The parsed pushtag node data
+     * @returns A new Pushtag instance
+     */
+    static fromGenericParseResult(genericParseResult: GenericParseResult): Pushtag;
+    /** @inheritdoc */
+    toString(): string;
+}

package/build/src/classes/nodes/Pushtag.mjs

@@ -0,0 +1,34 @@
+import { simpleParseLine } from '../../utils/simpleParseLine.mjs';
+import { assertNodeConstructor, Node } from '../Node.mjs';
+import { Tag } from './Transaction/Tag.mjs';
+/**
+ * Represents a Pushtag node that pushes a tag onto the tag stack.
+ * Subsequent transactions will automatically inherit this tag until it's popped.
+ */
+export class Pushtag extends Node {
+    constructor() {
+        super(...arguments);
+        /** @inheritdoc */
+        this.type = 'pushtag';
+    }
+    /**
+     * Creates a Pushtag instance from a generic parse result.
+     * @param genericParseResult - The parsed pushtag node data
+     * @returns A new Pushtag instance
+     */
+    static fromGenericParseResult(genericParseResult) {
+        const [tagContent] = simpleParseLine(genericParseResult.header);
+        return new Pushtag({
+            tag: new Tag({
+                content: tagContent.trim().replace(/^#/, ''),
+                fromStack: true,
+            }),
+        });
+    }
+    /** @inheritdoc */
+    toString() {
+        return `${this.type} #${this.tag.content}`;
+    }
+}
+// Ensure class conforms to NodeConstructor pattern
+assertNodeConstructor(Pushtag);

package/build/src/classes/nodes/Query.d.mts

@@ -0,0 +1,22 @@
+import type { GenericParseResultWithDate } from '../../genericParse.mjs';
+import { DatedNode } from '../DatedNode.mjs';
+/**
+ * Represents a Query node that defines a named SQL query.
+ * Query directives allow defining reusable queries in the Beancount file.
+ */
+export declare class Query extends DatedNode {
+    /** @inheritdoc */
+    type: "query";
+    /** The name of the query */
+    name: string;
+    /** The SQL query contents */
+    sqlContents: string;
+    /**
+     * Creates a Query instance from a generic parse result.
+     * @param genericParseResult - The parsed query node data
+     * @returns A new Query instance
+     */
+    static fromGenericParseResult(genericParseResult: GenericParseResultWithDate): Query;
+    /** @inheritdoc */
+    toString(): string;
+}

package/build/src/classes/nodes/Query.mjs

@@ -0,0 +1,34 @@
+import { assertNodeConstructor } from '../Node.mjs';
+import { DatedNode } from '../DatedNode.mjs';
+import { stringAwareParseLine } from '../../utils/stringAwareParseLine.mjs';
+import { parseString } from '../Value.mjs';
+/**
+ * Represents a Query node that defines a named SQL query.
+ * Query directives allow defining reusable queries in the Beancount file.
+ */
+export class Query extends DatedNode {
+    constructor() {
+        super(...arguments);
+        /** @inheritdoc */
+        this.type = 'query';
+    }
+    /**
+     * Creates a Query instance from a generic parse result.
+     * @param genericParseResult - The parsed query node data
+     * @returns A new Query instance
+     */
+    static fromGenericParseResult(genericParseResult) {
+        const [name, sqlContents] = stringAwareParseLine(genericParseResult.header);
+        return new Query({
+            ...genericParseResult.props,
+            name: parseString(name),
+            sqlContents: parseString(sqlContents).trim(),
+        });
+    }
+    /** @inheritdoc */
+    toString() {
+        return `${this.getDateTypePrefix()} "${this.name}" "${this.sqlContents}"${this.getMetaDataString()}`;
+    }
+}
+// Ensure class conforms to NodeConstructor pattern
+assertNodeConstructor(Query);

package/build/src/classes/nodes/Transaction/Posting.d.mts

@@ -0,0 +1,59 @@
+import { FormatOptions } from '../../ParseResult.mjs';
+/**
+ * Represents a single posting (account movement) within a transaction.
+ * Each posting records an amount moving to/from an account.
+ */
+export declare class Posting {
+    /** Optional posting flag (e.g., '*' for cleared) */
+    flag?: string;
+    /** The account name for this posting */
+    account: string;
+    /** The amount as a string (may be omitted for auto-calculated postings) */
+    amount?: string;
+    /** The currency code for the amount */
+    currency?: string;
+    /** Optional cost specification (e.g., for currency conversions) */
+    cost?: string;
+    /** Currency for the price annotation */
+    priceCurrency?: string;
+    /** Amount for the price annotation */
+    priceAmount?: string;
+    /** Optional comment for this posting */
+    comment?: string;
+    /** When a cost is given, defines the amount of at signs (1 for unit price, 2 for total price) */
+    atSigns?: number;
+    /**
+     * Creates a new Posting instance.
+     * @param obj - Object containing posting properties
+     */
+    constructor(obj: Record<string, unknown>);
+    /**
+     * Parses a posting line string into a Posting instance.
+     * Expected format: [Flag] Account [Amount Currency] [{Cost}] [@ PriceAmount PriceCurrency] [; Comment]
+     *
+     * @param unparsedline - The posting line string to parse
+     * @returns A new Posting instance
+     * @throws {Error} If the posting line cannot be parsed
+     */
+    static fromString(unparsedline: string): Posting;
+    /**
+     * Gets the formatted price string combining amount, currency, cost, and price annotation.
+     * @returns The formatted price string, or undefined if no price components exist
+     */
+    get price(): string | undefined;
+    /**
+     * Converts this posting to a string representation.
+     * Delegates to toFormattedString with zero currency column alignment.
+     *
+     * @returns The string representation of this posting
+     */
+    toString(): string;
+    /**
+     * Converts this posting to a formatted string with aligned currency column.
+     * Adds padding before the price to align at the specified column.
+     *
+     * @param formatOptions - Formatting options including currency column position
+     * @returns The formatted string representation of this posting
+     */
+    toFormattedString(formatOptions?: FormatOptions): string;
+}

package/build/src/classes/nodes/Transaction/Posting.mjs

@@ -0,0 +1,97 @@
+import { currencyPattern } from '../../../patterns.mjs';
+import { formatPrice } from '../../../utils/formatPrice.mjs';
+import { defaultFormatOptions } from '../../ParseResult.mjs';
+/**
+ * Represents a single posting (account movement) within a transaction.
+ * Each posting records an amount moving to/from an account.
+ */
+export class Posting {
+    /**
+     * Creates a new Posting instance.
+     * @param obj - Object containing posting properties
+     */
+    constructor(obj) {
+        Object.assign(this, obj);
+    }
+    /**
+     * Parses a posting line string into a Posting instance.
+     * Expected format: [Flag] Account [Amount Currency] [{Cost}] [@ PriceAmount PriceCurrency] [; Comment]
+     *
+     * @param unparsedline - The posting line string to parse
+     * @returns A new Posting instance
+     * @throws {Error} If the posting line cannot be parsed
+     */
+    static fromString(unparsedline) {
+        // [Flag] Account Amount [Currency] [{Cost}] [@ Price]
+        const flagPattern = `([^ ]) +`;
+        const accountPattern = `([^ ]*)`;
+        const amountPattern = `([^A-Z;]*)`;
+        const costPattern = `{(.*)}`;
+        const pricePattern = `+(@|@@) +(?:(\\d+\\.?\\d*) ${currencyPattern})`;
+        const amountCurrenyCostPattern = `${amountPattern}(?: +${currencyPattern})?(?: +${costPattern})?(?: ${pricePattern})?`;
+        const commentPattern = `( *;.*)?`;
+        const pattern = `^(?:${flagPattern})?${accountPattern}(?: +${amountCurrenyCostPattern})?${commentPattern}$`;
+        const matches = RegExp(pattern).exec(unparsedline);
+        if (!matches) {
+            throw new Error(`Could not parse posting: ${unparsedline}`);
+        }
+        const [, flag, account, amount, currency, cost, atSigns, priceAmount, priceCurrency, comment,] = matches;
+        return new Posting({
+            flag: flag,
+            account: account?.trim(),
+            amount: amount?.trim().length > 0 ? amount.trim() : undefined,
+            currency: currency?.trim(),
+            cost: cost?.trim(),
+            priceAmount: priceAmount?.trim(),
+            priceCurrency: priceCurrency?.trim(),
+            atSigns: atSigns ? atSigns.length : undefined,
+            comment: comment?.replace(/^ *;/, '').trim(),
+        });
+    }
+    /**
+     * Gets the formatted price string combining amount, currency, cost, and price annotation.
+     * @returns The formatted price string, or undefined if no price components exist
+     */
+    get price() {
+        return formatPrice(this.amount, this.currency, this.cost, this.priceAmount, this.priceCurrency, this.atSigns);
+    }
+    /**
+     * Converts this posting to a string representation.
+     * Delegates to toFormattedString with zero currency column alignment.
+     *
+     * @returns The string representation of this posting
+     */
+    toString() {
+        return this.toFormattedString({ currencyColumn: 0 });
+    }
+    /**
+     * Converts this posting to a formatted string with aligned currency column.
+     * Adds padding before the price to align at the specified column.
+     *
+     * @param formatOptions - Formatting options including currency column position
+     * @returns The formatted string representation of this posting
+     */
+    toFormattedString(formatOptions = defaultFormatOptions) {
+        const parts = [];
+        if (this.flag !== undefined) {
+            parts.push(this.flag);
+        }
+        parts.push(this.account);
+        if (this.price !== undefined) {
+            const paddingLength = formatOptions.currencyColumn -
+                parts.join(' ').length -
+                this.amount.length -
+                2 - // indent
+                2 - // spacing
+                2; // not sure what this is for
+            if (paddingLength > 0) {
+                parts.push(' '.repeat(paddingLength));
+            }
+            parts.push(this.price);
+        }
+        if (this.comment !== undefined) {
+            parts.push(';', this.comment);
+        }
+        return parts.join(' ');
+    }
+}