beancount 0.2.5 → 0.2.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "beancount",
-  "version": "0.2.5",
+  "version": "0.2.6",
   "description": "Parse and work with Beancount accounting files in TypeScript with full type safety",
   "type": "module",
   "sideEffects": false,
@@ -25,12 +25,12 @@
   },
   "homepage": "https://Boelensman1.github.io/node-beancount/",
   "devDependencies": {
-    "wtf-devconfigs": "^0.3.3",
-    "eslint-plugin-jsdoc": "^62.5.0",
-    "prettier": "^3.8.1",
+    "wtf-devconfigs": "^0.4.2",
+    "eslint-plugin-jsdoc": "^62.9.0",
+    "prettier": "^3.8.3",
     "tsx": "^4.21.0",
-    "typedoc": "^0.28.16",
-    "vitest": "^4.0.18"
+    "typedoc": "^0.28.19",
+    "vitest": "^4.1.5"
   },
   "engines": {
     "node": ">=22"
@@ -38,4 +38,4 @@
   "dependencies": {
     "@js-temporal/polyfill": "^0.5.1"
   }
-}
+}

package/build/src/classes/DateEntry.d.mts

@@ -1,47 +0,0 @@
-import { Temporal } from '@js-temporal/polyfill';
-import { Entry } from './Entry.mjs';
-import { Value } from './Value.mjs';
-import type { BeancountDatedEntryType } from '../entryTypeToClass.mjs';
-/**
- * Union type of all Beancount entry types that include a date field.
- * Excludes non-dated directives: include, option, plugin, pushtag, poptag.
- *
- * @deprecated This type is re-exported from entryTypeToClass.mjs for backward compatibility.
- * Use BeancountDatedEntryType instead.
- */
-export type BeancountDateEntryType = BeancountDatedEntryType;
-/**
- * Abstract base class for all Beancount entry types that have a date.
- *
- * Child classes must implement static `fromGenericParseResult` method
- */
-export declare abstract class DateEntry extends Entry {
-    /** The type of this dated entry */
-    abstract type: BeancountDatedEntryType;
-    /** The date of this entry as a Temporal.PlainDate object */
-    date: Temporal.PlainDate;
-    /** Optional metadata key-value pairs associated with this entry */
-    metadata?: Record<string, Value>;
-    /**
-     * Creates a new DateEntry instance.
-     * @param obj - Object containing entry properties
-     * @param obj.date - The date string in YYYY-MM-DD format
-     */
-    constructor(obj: {
-        date: string | Temporal.PlainDate;
-        [key: string]: unknown;
-    });
-    /**
-     * Returns the common prefix for all DateEntry toString methods.
-     * Format: "YYYY-MM-DD <type>"
-     * @returns The formatted date and type prefix string
-     */
-    protected getDateTypePrefix(): string;
-    /**
-     * Converts metadata and comment to a formatted string.
-     * If metadata exists, each key-value pair is formatted on separate indented lines.
-     *
-     * @returns The formatted metadata and comment string, or empty string if neither exists
-     */
-    getMetaDataString(): string;
-}

package/build/src/classes/DateEntry.mjs

@@ -1,60 +0,0 @@
-import { Temporal } from '@js-temporal/polyfill';
-import { Entry } from './Entry.mjs';
-import { Value } from './Value.mjs';
-/**
- * Abstract base class for all Beancount entry types that have a date.
- *
- * Child classes must implement static `fromGenericParseResult` method
- */
-export class DateEntry extends Entry {
-    /**
-     * Creates a new DateEntry instance.
-     * @param obj - Object containing entry properties
-     * @param obj.date - The date string in YYYY-MM-DD format
-     */
-    constructor(obj) {
-        const { date, metadata, ...props } = obj;
-        super(props);
-        if (date) {
-            if (date instanceof Temporal.PlainDate) {
-                this.date = date;
-            }
-            else if (typeof date === 'string') {
-                this.date = Temporal.PlainDate.from(date, { overflow: 'reject' });
-            }
-            else {
-                throw new Error('Could not parse date, should be either string of Temporal.PlainDate');
-            }
-        }
-        if (metadata) {
-            this.metadata = Object.fromEntries(Object.entries(metadata).map(([key, val]) => [
-                key,
-                new Value(val),
-            ]));
-        }
-    }
-    /**
-     * Returns the common prefix for all DateEntry toString methods.
-     * Format: "YYYY-MM-DD <type>"
-     * @returns The formatted date and type prefix string
-     */
-    getDateTypePrefix() {
-        return `${this.date.toJSON()} ${this.type}`;
-    }
-    /**
-     * Converts metadata and comment to a formatted string.
-     * If metadata exists, each key-value pair is formatted on separate indented lines.
-     *
-     * @returns The formatted metadata and comment string, or empty string if neither exists
-     */
-    getMetaDataString() {
-        const comment = this.comment ? ` ; ${this.comment}` : '';
-        if (!this.metadata) {
-            return comment;
-        }
-        return (`${comment}\n` +
-            Object.entries(this.metadata)
-                .map(([key, val]) => `  ${key}: ${val.toString()}`)
-                .join('\n'));
-    }
-}

package/build/src/classes/Entry.d.mts

@@ -1,92 +0,0 @@
-import type { BeancountEntryType } from '../entryTypeToClass.mjs';
-import { genericParse } from '../../src/genericParse.mjs';
-import { FormatOptions } from './ParseResult.mjs';
-/**
- * Type helper for Entry class constructors that enforce the static factory methods.
- * Child classes must implement static fromGenericParseResult and fromObject methods to create instances.
- * Note: The constructor is protected, so only the static factory methods are part of the public API.
- */
-export interface EntryConstructor<T extends Entry> {
-    /**
-     * Creates an Entry instance from a generic parse result.
-     * @param parsedStart - The result from genericParse containing parsed entry data
-     * @returns A new instance of the Entry subclass
-     */
-    fromGenericParseResult(parsedStart: ReturnType<typeof genericParse>): T;
-}
-/**
- * Abstract base class for all Beancount entry types.
- *
- * Child classes must implement static `fromGenericParseResult` method
- */
-export declare abstract class Entry {
-    /** Optional comment text associated with this entry */
-    comment?: string;
-    /** Internal metadata key-value pairs associated with this entry.
-     * These can be anything, are not used in the output, and are meant to be used
-     * to allow your pipeline to keep track of an internal property */
-    internalMetadata: Record<string, unknown>;
-    /** The type of this entry (e.g., 'open', 'close', 'transaction', 'comment', 'blankline') */
-    abstract type: BeancountEntryType | 'comment' | 'blankline';
-    /**
-     * Creates a new Entry instance.
-     * @param obj - Object containing entry properties
-     */
-    constructor(obj: Record<string, unknown>);
-    /**
-     * Creates an Entry instance from a Beancount string.
-     * Parses the input string and constructs the appropriate Entry subclass.
-     *
-     * @param input - A single Beancount entry as a string
-     * @returns A new instance of the Entry subclass
-     */
-    static fromString<T extends Entry>(this: EntryConstructor<T>, input: string): T;
-    /**
-     * Creates an Entry instance from JSON data.
-     * Calls fromJSONData to allow subclasses to transform the data before construction.
-     *
-     * @param jsonString - JSON data representing an entry
-     * @returns A new instance of the Entry subclass
-     * @remarks **Warning:** No validation is performed on the JSON input. We assume the JSON is valid and well-formed.
-     */
-    static fromJSON<T extends Entry>(this: new (obj: any) => T, jsonString: string): T;
-    /**
-     * Creates an Entry instance from JSON data.
-     * Calls fromJSONData to allow subclasses to transform the data before construction.
-     *
-     * @param jsonData - object representing an entry
-     * @returns A new instance of the Entry subclass
-     * @remarks **Warning:** No validation is performed on the input. We assume the input is valid and well-formed.
-     */
-    static fromJSONData<T extends Entry>(this: new (obj: any) => T, jsonData: Record<string, unknown>): T;
-    /**
-     * Converts this entry to a formatted string with aligned columns.
-     * Default implementation delegates to toString(). Subclasses can override for custom formatting.
-     *
-     * @param _formatOptions - Formatting options (unused in base implementation)
-     * @returns The formatted string representation of this entry
-     */
-    toFormattedString(_formatOptions?: FormatOptions): string;
-    /**
-     * Transforms JSON data before creating an Entry instance.
-     * Default implementation returns the input unchanged.
-     * Subclasses can override this to handle custom deserialization logic
-     * (e.g., converting nested objects, handling dates, etc.).
-     *
-     * @param json - The JSON data to transform
-     * @returns The transformed data ready for the constructor
-     */
-    protected parseJSONData(json: Record<string, unknown>): Record<string, unknown>;
-    /**
-     * Converts an entry to a JSON-serializable object.
-     * @returns A JSON-serializable representation of this entry
-     */
-    toJSON(): Record<string, unknown>;
-}
-/**
- * Type assertion helper to ensure a class conforms to EntryConstructor.
- * Usage: assertEntryConstructor(MyEntryClass)
- * @param _ctor - The constructor to validate (unused at runtime)
- * @internal
- */
-export declare function assertEntryConstructor<T extends Entry>(_ctor: EntryConstructor<T>): void;

package/build/src/classes/Entry.mjs

@@ -1,107 +0,0 @@
-import { genericParse } from '../../src/genericParse.mjs';
-import { stringAwareSplitLine } from '../utils/stringAwareSplitLine.mjs';
-import { defaultFormatOptions } from './ParseResult.mjs';
-/**
- * Abstract base class for all Beancount entry types.
- *
- * Child classes must implement static `fromGenericParseResult` method
- */
-export class Entry {
-    /**
-     * Creates a new Entry instance.
-     * @param obj - Object containing entry properties
-     */
-    constructor(obj) {
-        /** Internal metadata key-value pairs associated with this entry.
-         * These can be anything, are not used in the output, and are meant to be used
-         * to allow your pipeline to keep track of an internal property */
-        this.internalMetadata = {};
-        Object.assign(this, obj);
-    }
-    /**
-     * Creates an Entry instance from a Beancount string.
-     * Parses the input string and constructs the appropriate Entry subclass.
-     *
-     * @param input - A single Beancount entry as a string
-     * @returns A new instance of the Entry subclass
-     */
-    static fromString(input) {
-        const unparsedEntry = stringAwareSplitLine(input);
-        const genericParseResult = genericParse(unparsedEntry);
-        const result = this.fromGenericParseResult(genericParseResult);
-        if (result.type !== genericParseResult.type) {
-            console.warn('Parse result type is not equal to requested object type, make sure the correct class is initiated');
-        }
-        return result;
-    }
-    /**
-     * Creates an Entry instance from JSON data.
-     * Calls fromJSONData to allow subclasses to transform the data before construction.
-     *
-     * @param jsonString - JSON data representing an entry
-     * @returns A new instance of the Entry subclass
-     * @remarks **Warning:** No validation is performed on the JSON input. We assume the JSON is valid and well-formed.
-     */
-    static fromJSON(jsonString) {
-        const json = JSON.parse(jsonString);
-        // @ts-expect-error Not sure how to type this correctly
-        return this.fromJSONData(json); // eslint-disable-line
-    }
-    /**
-     * Creates an Entry instance from JSON data.
-     * Calls fromJSONData to allow subclasses to transform the data before construction.
-     *
-     * @param jsonData - object representing an entry
-     * @returns A new instance of the Entry subclass
-     * @remarks **Warning:** No validation is performed on the input. We assume the input is valid and well-formed.
-     */
-    static fromJSONData(jsonData) {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const instance = new this({});
-        const transformedData = instance.parseJSONData(jsonData);
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        return new this(transformedData);
-    }
-    /**
-     * Converts this entry to a formatted string with aligned columns.
-     * Default implementation delegates to toString(). Subclasses can override for custom formatting.
-     *
-     * @param _formatOptions - Formatting options (unused in base implementation)
-     * @returns The formatted string representation of this entry
-     */
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    toFormattedString(_formatOptions = defaultFormatOptions) {
-        // eslint-disable-next-line @typescript-eslint/no-base-to-string
-        return this.toString();
-    }
-    /**
-     * Transforms JSON data before creating an Entry instance.
-     * Default implementation returns the input unchanged.
-     * Subclasses can override this to handle custom deserialization logic
-     * (e.g., converting nested objects, handling dates, etc.).
-     *
-     * @param json - The JSON data to transform
-     * @returns The transformed data ready for the constructor
-     */
-    parseJSONData(json) {
-        return json;
-    }
-    /**
-     * Converts an entry to a JSON-serializable object.
-     * @returns A JSON-serializable representation of this entry
-     */
-    toJSON() {
-        return {
-            ...this,
-        };
-    }
-}
-/**
- * Type assertion helper to ensure a class conforms to EntryConstructor.
- * Usage: assertEntryConstructor(MyEntryClass)
- * @param _ctor - The constructor to validate (unused at runtime)
- * @internal
- */
-export function assertEntryConstructor(
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-_ctor) { }

package/build/src/classes/entryTypes/Balance.d.mts

@@ -1,32 +0,0 @@
-import type { GenericParseResultWithDate } from '../../genericParse.mjs';
-import { DateEntry } from '../DateEntry.mjs';
-import { FormatOptions } from '../ParseResult.mjs';
-/**
- * Represents a Balance assertion entry.
- * Balance directives assert that an account has a specific balance at a given date.
- */
-export declare class Balance extends DateEntry {
-    /** @inheritdoc */
-    type: "balance";
-    /** The account name for the balance assertion */
-    account: string;
-    /** The expected amount */
-    amount: string;
-    /** The currency of the amount */
-    currency: string;
-    /**
-     * Gets the formatted price string (amount + currency).
-     * @returns The formatted price string
-     */
-    get price(): string | undefined;
-    /**
-     * Creates a Balance instance from a generic parse result.
-     * @param genericParseResult - The parsed balance entry data
-     * @returns A new Balance instance
-     */
-    static fromGenericParseResult(genericParseResult: GenericParseResultWithDate): Balance;
-    /** @inheritdoc */
-    toString(): string;
-    /** @inheritdoc */
-    toFormattedString(formatOptions?: FormatOptions): string;
-}

package/build/src/classes/entryTypes/Balance.mjs

@@ -1,50 +0,0 @@
-import { assertEntryConstructor } from '../Entry.mjs';
-import { DateEntry } from '../DateEntry.mjs';
-import { simpleParseLine } from '../../utils/simpleParseLine.mjs';
-import { formatPrice } from '../../utils/formatPrice.mjs';
-import { defaultFormatOptions } from '../ParseResult.mjs';
-/**
- * Represents a Balance assertion entry.
- * Balance directives assert that an account has a specific balance at a given date.
- */
-export class Balance extends DateEntry {
-    constructor() {
-        super(...arguments);
-        /** @inheritdoc */
-        this.type = 'balance';
-    }
-    /**
-     * Gets the formatted price string (amount + currency).
-     * @returns The formatted price string
-     */
-    get price() {
-        return formatPrice(this.amount, this.currency);
-    }
-    /**
-     * Creates a Balance instance from a generic parse result.
-     * @param genericParseResult - The parsed balance entry data
-     * @returns A new Balance instance
-     */
-    static fromGenericParseResult(genericParseResult) {
-        const [account, amount, currency] = simpleParseLine(genericParseResult.header);
-        return new Balance({
-            ...genericParseResult.props,
-            account,
-            amount,
-            currency,
-        });
-    }
-    /** @inheritdoc */
-    toString() {
-        return this.toFormattedString({ currencyColumn: 0 });
-    }
-    /** @inheritdoc */
-    toFormattedString(formatOptions = defaultFormatOptions) {
-        const firstPart = `${this.getDateTypePrefix()} ${this.account}`;
-        const paddingLength = formatOptions.currencyColumn - firstPart.length - this.amount.length - 2; // not sure what this is for
-        const padding = ' '.repeat(Math.max(1, paddingLength));
-        return [firstPart, padding, this.price, this.getMetaDataString()].join('');
-    }
-}
-// Ensure class conforms to EntryConstructor pattern
-assertEntryConstructor(Balance);

package/build/src/classes/entryTypes/Blankline.d.mts

@@ -1,24 +0,0 @@
-import type { GenericParseResult } from '../../genericParse.mjs';
-import { Entry, EntryConstructor } from '../Entry.mjs';
-/**
- * Represents a blank line in a Beancount file.
- * Blank lines are used to separate entries for readability.
- */
-export declare class Blankline extends Entry {
-    /** @inheritdoc */
-    type: "blankline";
-    /**
-     * Creates a Blankline instance from a generic parse result.
-     * @param _genericParseResult - Unused, blank lines have no content
-     * @returns A new Blankline instance
-     */
-    static fromGenericParseResult(_genericParseResult: GenericParseResult): Blankline;
-    /** @inheritdoc */
-    toString(): string;
-    /**
-     * Creates a Blankline instance from a string.
-     * @param _input - Unused, blank lines have no content
-     * @returns A new Blankline instance
-     */
-    static fromString<T extends Entry>(this: EntryConstructor<T>, _input: string): T;
-}

package/build/src/classes/entryTypes/Blankline.mjs

@@ -1,38 +0,0 @@
-import { assertEntryConstructor, Entry } from '../Entry.mjs';
-/**
- * Represents a blank line in a Beancount file.
- * Blank lines are used to separate entries for readability.
- */
-export class Blankline extends Entry {
-    constructor() {
-        super(...arguments);
-        /** @inheritdoc */
-        this.type = 'blankline';
-    }
-    /**
-     * Creates a Blankline instance from a generic parse result.
-     * @param _genericParseResult - Unused, blank lines have no content
-     * @returns A new Blankline instance
-     */
-    static fromGenericParseResult(
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    _genericParseResult) {
-        return new Blankline({});
-    }
-    /** @inheritdoc */
-    toString() {
-        return '';
-    }
-    /**
-     * Creates a Blankline instance from a string.
-     * @param _input - Unused, blank lines have no content
-     * @returns A new Blankline instance
-     */
-    static fromString(
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    _input) {
-        return this.fromGenericParseResult({});
-    }
-}
-// Ensure class conforms to EntryConstructor pattern
-assertEntryConstructor(Blankline);

package/build/src/classes/entryTypes/Close.d.mts

@@ -1,20 +0,0 @@
-import type { GenericParseResultWithDate } from '../../genericParse.mjs';
-import { DateEntry } from '../DateEntry.mjs';
-/**
- * Represents a Close entry that closes an account.
- * Close directives mark the end of an account's lifespan.
- */
-export declare class Close extends DateEntry {
-    /** @inheritdoc */
-    type: "close";
-    /** The account name being closed */
-    account: string;
-    /**
-     * Creates a Close instance from a generic parse result.
-     * @param genericParseResult - The parsed close entry data
-     * @returns A new Close instance
-     */
-    static fromGenericParseResult(genericParseResult: GenericParseResultWithDate): Close;
-    /** @inheritdoc */
-    toString(): string;
-}

package/build/src/classes/entryTypes/Close.mjs

@@ -1,31 +0,0 @@
-import { assertEntryConstructor } from '../Entry.mjs';
-import { DateEntry } from '../DateEntry.mjs';
-/**
- * Represents a Close entry that closes an account.
- * Close directives mark the end of an account's lifespan.
- */
-export class Close extends DateEntry {
-    constructor() {
-        super(...arguments);
-        /** @inheritdoc */
-        this.type = 'close';
-    }
-    /**
-     * Creates a Close instance from a generic parse result.
-     * @param genericParseResult - The parsed close entry data
-     * @returns A new Close instance
-     */
-    static fromGenericParseResult(genericParseResult) {
-        const account = genericParseResult.header.trim();
-        return new Close({
-            ...genericParseResult.props,
-            account,
-        });
-    }
-    /** @inheritdoc */
-    toString() {
-        return `${this.getDateTypePrefix()} ${this.account}${this.getMetaDataString()}`;
-    }
-}
-// Ensure class conforms to EntryConstructor pattern
-assertEntryConstructor(Close);

package/build/src/classes/entryTypes/Comment.d.mts

@@ -1,25 +0,0 @@
-import type { GenericParseResult } from '../../genericParse.mjs';
-import { Entry, EntryConstructor } from '../Entry.mjs';
-/**
- * Represents a Comment line in a Beancount file.
- * Comments are lines that start with a semicolon or hash and are ignored by the parser.
- */
-export declare class Comment extends Entry {
-    /** @inheritdoc */
-    type: "comment";
-    /**
-     * Creates a Comment instance from a generic parse result.
-     * Note: This doesn't use a real GenericParseResult structure.
-     * @param genericParseResult - The parsed comment data
-     * @returns A new Comment instance
-     */
-    static fromGenericParseResult(genericParseResult: GenericParseResult): Comment;
-    /** @inheritdoc */
-    toString(): string | undefined;
-    /**
-     * Creates a Comment instance directly from a string.
-     * @param input - The comment text
-     * @returns A new Comment instance
-     */
-    static fromString<T extends Entry>(this: EntryConstructor<T>, input: string): T;
-}

package/build/src/classes/entryTypes/Comment.mjs

@@ -1,42 +0,0 @@
-import { assertEntryConstructor, Entry } from '../Entry.mjs';
-/**
- * Represents a Comment line in a Beancount file.
- * Comments are lines that start with a semicolon or hash and are ignored by the parser.
- */
-export class Comment extends Entry {
-    constructor() {
-        super(...arguments);
-        /** @inheritdoc */
-        this.type = 'comment';
-    }
-    /**
-     * Creates a Comment instance from a generic parse result.
-     * Note: This doesn't use a real GenericParseResult structure.
-     * @param genericParseResult - The parsed comment data
-     * @returns A new Comment instance
-     */
-    static fromGenericParseResult(genericParseResult) {
-        return new Comment({
-            comment: genericParseResult.header,
-        });
-    }
-    /** @inheritdoc */
-    toString() {
-        return this.comment;
-    }
-    /**
-     * Creates a Comment instance directly from a string.
-     * @param input - The comment text
-     * @returns A new Comment instance
-     */
-    static fromString(input) {
-        return this.fromGenericParseResult({
-            type: 'comment',
-            header: input,
-            props: {},
-            fake: true,
-        });
-    }
-}
-// Ensure class conforms to EntryConstructor pattern
-assertEntryConstructor(Comment);

package/build/src/classes/entryTypes/Commodity.d.mts

@@ -1,20 +0,0 @@
-import type { GenericParseResultWithDate } from '../../genericParse.mjs';
-import { DateEntry } from '../DateEntry.mjs';
-/**
- * Represents a Commodity declaration entry.
- * Commodity directives declare the existence of a commodity/currency with metadata.
- */
-export declare class Commodity extends DateEntry {
-    /** @inheritdoc */
-    type: "commodity";
-    /** The currency/commodity code being declared */
-    currency: string;
-    /**
-     * Creates a Commodity instance from a generic parse result.
-     * @param genericParseResult - The parsed commodity entry data
-     * @returns A new Commodity instance
-     */
-    static fromGenericParseResult(genericParseResult: GenericParseResultWithDate): Commodity;
-    /** @inheritdoc */
-    toString(): string;
-}

package/build/src/classes/entryTypes/Commodity.mjs

@@ -1,31 +0,0 @@
-import { assertEntryConstructor } from '../Entry.mjs';
-import { DateEntry } from '../DateEntry.mjs';
-/**
- * Represents a Commodity declaration entry.
- * Commodity directives declare the existence of a commodity/currency with metadata.
- */
-export class Commodity extends DateEntry {
-    constructor() {
-        super(...arguments);
-        /** @inheritdoc */
-        this.type = 'commodity';
-    }
-    /**
-     * Creates a Commodity instance from a generic parse result.
-     * @param genericParseResult - The parsed commodity entry data
-     * @returns A new Commodity instance
-     */
-    static fromGenericParseResult(genericParseResult) {
-        const currency = genericParseResult.header.trim();
-        return new Commodity({
-            ...genericParseResult.props,
-            currency,
-        });
-    }
-    /** @inheritdoc */
-    toString() {
-        return `${this.getDateTypePrefix()} ${this.currency}${this.getMetaDataString()}`;
-    }
-}
-// Ensure class conforms to EntryConstructor pattern
-assertEntryConstructor(Commodity);