beancount 0.2.4 → 0.2.6

package/build/src/classes/entryTypes/Transaction/Tag.d.mts

@@ -1,28 +0,0 @@
-/**
- * Represents a tag associated with a transaction.
- * Tags can be specified inline in the transaction or inherited from a tag stack (pushtag/poptag).
- */
-export declare class Tag {
-    /** The tag name/content (without the '#' prefix) */
-    content: string;
-    /** Whether this tag comes from the tag stack (pushtag) or is inline */
-    fromStack: boolean;
-    /**
-     * Creates a new Tag instance.
-     * @param obj - Object containing tag content and source information
-     * @param obj.content - The tag name/content
-     * @param obj.fromStack - Whether this tag is from the tag stack
-     */
-    constructor(obj: {
-        content: string;
-        fromStack: boolean;
-    });
-    /**
-     * Converts this tag to its string representation.
-     * Tags from the stack return an empty string (they're implicit),
-     * while inline tags return '#tagname' format.
-     *
-     * @returns The tag string with '#' prefix, or empty string if from stack
-     */
-    toString(): string;
-}

package/build/src/classes/entryTypes/Transaction/Tag.mjs

@@ -1,28 +0,0 @@
-/**
- * Represents a tag associated with a transaction.
- * Tags can be specified inline in the transaction or inherited from a tag stack (pushtag/poptag).
- */
-export class Tag {
-    /**
-     * Creates a new Tag instance.
-     * @param obj - Object containing tag content and source information
-     * @param obj.content - The tag name/content
-     * @param obj.fromStack - Whether this tag is from the tag stack
-     */
-    constructor(obj) {
-        Object.assign(this, obj);
-    }
-    /**
-     * Converts this tag to its string representation.
-     * Tags from the stack return an empty string (they're implicit),
-     * while inline tags return '#tagname' format.
-     *
-     * @returns The tag string with '#' prefix, or empty string if from stack
-     */
-    toString() {
-        if (this.fromStack) {
-            return '';
-        }
-        return `#${this.content}`;
-    }
-}

package/build/src/classes/entryTypes/Transaction/index.d.mts

@@ -1,70 +0,0 @@
-import { Temporal } from '@js-temporal/polyfill';
-import type { GenericParseResultTransaction } from '../../../genericParse.mjs';
-import { DateEntry } from '../../DateEntry.mjs';
-import { Posting } from './Posting.mjs';
-import { Tag } from './Tag.mjs';
-import { FormatOptions } from '../../ParseResult.mjs';
-export interface PostingComment {
-    order: number;
-    comment: string;
-}
-/**
- * Represents a Beancount transaction entry.
- * Transactions record financial movements between accounts with postings.
- */
-export declare class Transaction extends DateEntry {
-    /** @inheritdoc */
-    type: "transaction";
-    /** The payee of the transaction */
-    payee: string;
-    /** Optional narration/description of the transaction */
-    narration?: string;
-    /** Optional transaction flag (e.g., '*' for cleared, '!' for pending) */
-    flag?: string;
-    /** Array of postings (account movements) in this transaction */
-    postings: Posting[];
-    /** Array of comments under this transaction (mixed in with the postings) */
-    postingComments: PostingComment[];
-    /** Set of link identifiers associated with this transaction */
-    links: Set<string>;
-    /** Array of tags associated with this transaction (from inline tags and tag stack) */
-    tags: Tag[];
-    /**
-     * @inheritdoc
-     */
-    constructor(obj: {
-        date: string | Temporal.PlainDate;
-        [key: string]: unknown;
-    });
-    /**
-     * Creates a Transaction instance from a generic parse result.
-     * Parses payee, narration, links, tags, postings, and metadata.
-     *
-     * @param genericParseResult - The parsed transaction data
-     * @returns A new Transaction instance
-     */
-    static fromGenericParseResult(genericParseResult: GenericParseResultTransaction): Transaction;
-    /** @inheritdoc */
-    toString(): string;
-    /** @inheritdoc */
-    toFormattedString(formatOptions?: FormatOptions): string;
-    /**
-     * Converts this transaction to a JSON-serializable object.
-     * Ensures the links Set is properly serialized as an array.
-     *
-     * @returns A JSON-serializable representation of this transaction
-     */
-    toJSON(): Record<string, unknown>;
-    /**
-     * Transforms JSON data before creating a Transaction instance.
-     * Deserializes transaction-specific properties including postings, tags, links, and metadata.
-     *
-     * @param json - The JSON data to transform
-     * @returns The transformed data with:
-     *   - postings converted to Posting instances
-     *   - tags converted to Tag instances
-     *   - links converted from array to Set<string>
-     *   - metadata values converted to Value instances
-     */
-    protected parseJSONData(json: Record<string, unknown>): Record<string, unknown>;
-}

package/build/src/classes/entryTypes/Transaction/index.mjs

@@ -1,193 +0,0 @@
-import { assertEntryConstructor } from '../../Entry.mjs';
-import { DateEntry } from '../../DateEntry.mjs';
-import { stringAwareParseLine } from '../../../utils/stringAwareParseLine.mjs';
-import { parseString, Value } from '../../Value.mjs';
-import { parseMetadata } from '../../../utils/parseMetadata.mjs';
-import { Posting } from './Posting.mjs';
-import { Tag } from './Tag.mjs';
-import { defaultFormatOptions } from '../../ParseResult.mjs';
-/**
- * Valid Beancount account type prefixes.
- * @internal
- */
-const AccountTypes = ['Assets', 'Liabilities', 'Equity', 'Income', 'Expenses'];
-/**
- * Parses a string to extract narration/payee, links, and tags.
- * Links are prefixed with '^' and tags with '#'.
- *
- * @param input - The string to parse (may contain narration in quotes, links, and tags)
- * @returns An object containing extracted links, tags, and the remaining string (narration/payee)
- * @internal
- */
-const getStringLinksAndTags = (input) => {
-    let links = new Set();
-    let tags = [];
-    // default if no narration
-    let strRemaining = '';
-    let linksAndTags = input;
-    // check for narration
-    const match = /^(".*")(.*)/.exec(input);
-    if (match) {
-        // strRemaining = narration
-        strRemaining = match[1];
-        linksAndTags = match[2];
-    }
-    const linksMatch = linksAndTags.matchAll(/\^([\w-_.]*)/g);
-    if (linksMatch) {
-        links = new Set(linksMatch.map((m) => m[1]));
-    }
-    const tagsMatch = linksAndTags.matchAll(/#([\w-_.]*)/g);
-    if (tagsMatch) {
-        tags = tagsMatch
-            .map((m) => new Tag({ content: m[1], fromStack: false }))
-            .toArray();
-    }
-    return { links, tags, string: strRemaining };
-};
-/**
- * Represents a Beancount transaction entry.
- * Transactions record financial movements between accounts with postings.
- */
-export class Transaction extends DateEntry {
-    /**
-     * @inheritdoc
-     */
-    constructor(obj) {
-        /*
-         * This constructor exists to provide a default value for some values.
-         * Class field initializers (e.g., `postingComments = []`) run after
-         * `super()` returns, which would overwrite values set by `Object.assign`
-         * in the parent constructor.
-         */
-        super(obj);
-        /** @inheritdoc */
-        this.type = 'transaction';
-        this.postingComments ??= [];
-        this.postings ??= [];
-        this.links ??= new Set();
-        this.tags ??= [];
-    }
-    /**
-     * Creates a Transaction instance from a generic parse result.
-     * Parses payee, narration, links, tags, postings, and metadata.
-     *
-     * @param genericParseResult - The parsed transaction data
-     * @returns A new Transaction instance
-     */
-    static fromGenericParseResult(genericParseResult) {
-        // eslint-disable-next-line prefer-const
-        let [payee, ...rest] = stringAwareParseLine(genericParseResult.header);
-        let links = new Set();
-        let tags = [];
-        let narration;
-        if (rest.length === 0) {
-            // no narration
-            const payeeParsed = getStringLinksAndTags(payee);
-            payee = payeeParsed.string;
-            links = payeeParsed.links;
-            tags = payeeParsed.tags;
-        }
-        else {
-            const payeeParsed = getStringLinksAndTags(rest.join(' '));
-            narration = payeeParsed.string;
-            links = payeeParsed.links;
-            tags = payeeParsed.tags;
-        }
-        const unparsedPostings = [];
-        const unparsedMetadata = [];
-        const postingComments = [];
-        genericParseResult.body.forEach((line) => {
-            //                           V remove flag,       V get account type
-            const accountType = line.replace(/^[^ ] /, '').split(':')[0];
-            if (AccountTypes.includes(accountType)) {
-                unparsedPostings.push(line);
-            }
-            else if (line.startsWith(';')) {
-                postingComments.push({
-                    comment: line,
-                    order: unparsedPostings.length + postingComments.length,
-                });
-            }
-            else {
-                unparsedMetadata.push(line);
-            }
-        });
-        const postings = unparsedPostings.map((p) => Posting.fromString(p));
-        const metadata = parseMetadata(unparsedMetadata);
-        return new Transaction({
-            ...genericParseResult.props,
-            payee: parseString(payee),
-            narration: narration ? parseString(narration) : undefined,
-            postings,
-            postingComments,
-            metadata,
-            links,
-            tags,
-        });
-    }
-    /** @inheritdoc */
-    toString() {
-        return this.toFormattedString({ currencyColumn: 0 });
-    }
-    /** @inheritdoc */
-    toFormattedString(formatOptions = defaultFormatOptions) {
-        const firstLine = [
-            this.date.toJSON(),
-            this.flag ?? 'txn',
-            `"${this.payee}"`,
-        ];
-        if (this.narration !== undefined) {
-            firstLine.push(`"${this.narration}"`);
-        }
-        firstLine.push(...this.links.values().map((l) => `^${l}`));
-        firstLine.push(...this.tags.map((t) => t.toString()));
-        const lines = [firstLine.join(' ') + this.getMetaDataString()];
-        const postingLines = this.postings.map((p) => `  ${p.toFormattedString(formatOptions)}`);
-        this.postingComments.forEach((comment) => {
-            postingLines.splice(comment.order, 0, `  ${comment.comment}`);
-        });
-        lines.push(...postingLines);
-        return lines.join('\n');
-    }
-    /**
-     * Converts this transaction to a JSON-serializable object.
-     * Ensures the links Set is properly serialized as an array.
-     *
-     * @returns A JSON-serializable representation of this transaction
-     */
-    toJSON() {
-        return {
-            ...this,
-            links: Array.from(this.links),
-        };
-    }
-    /**
-     * Transforms JSON data before creating a Transaction instance.
-     * Deserializes transaction-specific properties including postings, tags, links, and metadata.
-     *
-     * @param json - The JSON data to transform
-     * @returns The transformed data with:
-     *   - postings converted to Posting instances
-     *   - tags converted to Tag instances
-     *   - links converted from array to Set<string>
-     *   - metadata values converted to Value instances
-     */
-    parseJSONData(json) {
-        const { postings, postingComments, tags, links, metadata, ...rest } = json;
-        return {
-            ...rest,
-            postings: postings?.map((p) => new Posting(p)),
-            postingComments: postingComments ?? [],
-            tags: tags?.map((t) => new Tag(t)),
-            links: links ? new Set(links) : new Set(),
-            metadata: metadata
-                ? Object.fromEntries(Object.entries(metadata).map(([key, val]) => [
-                    key,
-                    new Value(val),
-                ]))
-                : undefined,
-        };
-    }
-}
-// Ensure class conforms to EntryConstructor pattern
-assertEntryConstructor(Transaction);

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

@@ -1,19 +0,0 @@
-export { Transaction } from './Transaction/index.mjs';
-export { Balance } from './Balance.mjs';
-export { Blankline } from './Blankline.mjs';
-export { Close } from './Close.mjs';
-export { Comment } from './Comment.mjs';
-export { Commodity } from './Commodity.mjs';
-export { Custom } from './Custom.mjs';
-export { Document } from './Document.mjs';
-export { Event } from './Event.mjs';
-export { Include } from './Include.mjs';
-export { Note } from './Note.mjs';
-export { Open } from './Open.mjs';
-export { Option } from './Option.mjs';
-export { Pad } from './Pad.mjs';
-export { Plugin } from './Plugin.mjs';
-export { Price } from './Price.mjs';
-export { Poptag } from './Poptag.mjs';
-export { Pushtag } from './Pushtag.mjs';
-export { Query } from './Query.mjs';

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

@@ -1,19 +0,0 @@
-export { Transaction } from './Transaction/index.mjs';
-export { Balance } from './Balance.mjs';
-export { Blankline } from './Blankline.mjs';
-export { Close } from './Close.mjs';
-export { Comment } from './Comment.mjs';
-export { Commodity } from './Commodity.mjs';
-export { Custom } from './Custom.mjs';
-export { Document } from './Document.mjs';
-export { Event } from './Event.mjs';
-export { Include } from './Include.mjs';
-export { Note } from './Note.mjs';
-export { Open } from './Open.mjs';
-export { Option } from './Option.mjs';
-export { Pad } from './Pad.mjs';
-export { Plugin } from './Plugin.mjs';
-export { Price } from './Price.mjs';
-export { Poptag } from './Poptag.mjs';
-export { Pushtag } from './Pushtag.mjs';
-export { Query } from './Query.mjs';

package/build/src/entryTypeToClass.d.mts

@@ -1,73 +0,0 @@
-import { Transaction, Balance, Close, Comment, Commodity, Custom, Document, Event, Include, Note, Open, Option, Pad, Plugin, Poptag, Price, Pushtag, Query, Blankline } from './classes/entryTypes/index.mjs';
-import type { DATED_ENTRY_TYPES, NON_DATED_ENTRY_TYPES } from './entryTypes.mjs';
-/**
- * Union type of all Beancount entry types that include a date field.
- * Derived from {@link DATED_ENTRY_TYPES}.
- */
-export type BeancountDatedEntryType = (typeof DATED_ENTRY_TYPES)[number];
-/**
- * Union type of all Beancount entry types that do NOT include a date field.
- * Derived from {@link NON_DATED_ENTRY_TYPES}.
- */
-export type BeancountNonDatedEntryType = (typeof NON_DATED_ENTRY_TYPES)[number];
-/**
- * Union type of all valid Beancount entry type names.
- * EntryTypes derived from https://beancount.github.io/docs/beancount_language_syntax.html#directives-1
- * Entries can have two additional 'fake' types: 'comment' and 'blankline', see {@link EntryType}
- *
- * Derived from {@link DATED_ENTRY_TYPES} and {@link NON_DATED_ENTRY_TYPES}.
- */
-export type BeancountEntryType = BeancountDatedEntryType | BeancountNonDatedEntryType;
-export type FakeEntryType = 'comment' | 'blankline';
-/**
- * Union type of all valid entry type names, including the 'fake' entry types of comment and blankline.
- */
-export type EntryType = BeancountEntryType | FakeEntryType;
-/**
- * Mapping of Beancount entry type names to their corresponding class constructors.
- * @internal
- */
-export declare const beancountEntryToClass: {
-    transaction: typeof Transaction;
-    balance: typeof Balance;
-    close: typeof Close;
-    commodity: typeof Commodity;
-    custom: typeof Custom;
-    document: typeof Document;
-    event: typeof Event;
-    include: typeof Include;
-    note: typeof Note;
-    open: typeof Open;
-    option: typeof Option;
-    pad: typeof Pad;
-    plugin: typeof Plugin;
-    poptag: typeof Poptag;
-    price: typeof Price;
-    pushtag: typeof Pushtag;
-    query: typeof Query;
-};
-/**
- * Mapping of all entry type names (including 'comment' and 'blankline') to their corresponding class constructors.
- * @internal
- */
-export declare const entryTypeToClass: {
-    comment: typeof Comment;
-    blankline: typeof Blankline;
-    transaction: typeof Transaction;
-    balance: typeof Balance;
-    close: typeof Close;
-    commodity: typeof Commodity;
-    custom: typeof Custom;
-    document: typeof Document;
-    event: typeof Event;
-    include: typeof Include;
-    note: typeof Note;
-    open: typeof Open;
-    option: typeof Option;
-    pad: typeof Pad;
-    plugin: typeof Plugin;
-    poptag: typeof Poptag;
-    price: typeof Price;
-    pushtag: typeof Pushtag;
-    query: typeof Query;
-};

package/build/src/entryTypeToClass.mjs

@@ -1,37 +0,0 @@
-import { Transaction, Balance, Close, Comment, Commodity, Custom, Document, Event, Include, Note, Open, Option, Pad, Plugin, Poptag, Price, Pushtag, Query, Blankline, } from './classes/entryTypes/index.mjs';
-/**
- * Mapping of Beancount entry type names to their corresponding class constructors.
- * @internal
- */
-export const beancountEntryToClass = {
-    transaction: Transaction,
-    balance: Balance,
-    close: Close,
-    commodity: Commodity,
-    custom: Custom,
-    document: Document,
-    event: Event,
-    include: Include,
-    note: Note,
-    open: Open,
-    option: Option,
-    pad: Pad,
-    plugin: Plugin,
-    poptag: Poptag,
-    price: Price,
-    pushtag: Pushtag,
-    query: Query,
-};
-// Compile-time assertion: beancountEntryToClass must have all BeancountEntryType keys
-beancountEntryToClass;
-/**
- * Mapping of all entry type names (including 'comment' and 'blankline') to their corresponding class constructors.
- * @internal
- */
-export const entryTypeToClass = {
-    ...beancountEntryToClass,
-    comment: Comment,
-    blankline: Blankline,
-};
-// Compile-time assertion: entryTypeToClass must have all EntryType keys
-beancountEntryToClass;

package/build/src/entryTypes.d.mts

@@ -1,10 +0,0 @@
-/**
- * Array of all Beancount entry types that start with a date (YYYY-MM-DD format).
- * These entries follow the pattern: `YYYY-MM-DD <type> ...`
- */
-export declare const DATED_ENTRY_TYPES: readonly ["balance", "close", "commodity", "custom", "document", "event", "note", "open", "pad", "price", "query", "transaction"];
-/**
- * Array of all Beancount entry types that do NOT start with a date.
- * These entries follow the pattern: `<type> ...`
- */
-export declare const NON_DATED_ENTRY_TYPES: readonly ["include", "option", "plugin", "poptag", "pushtag"];

package/build/src/entryTypes.mjs

@@ -1,29 +0,0 @@
-/**
- * Array of all Beancount entry types that start with a date (YYYY-MM-DD format).
- * These entries follow the pattern: `YYYY-MM-DD <type> ...`
- */
-export const DATED_ENTRY_TYPES = [
-    'balance',
-    'close',
-    'commodity',
-    'custom',
-    'document',
-    'event',
-    'note',
-    'open',
-    'pad',
-    'price',
-    'query',
-    'transaction',
-];
-/**
- * Array of all Beancount entry types that do NOT start with a date.
- * These entries follow the pattern: `<type> ...`
- */
-export const NON_DATED_ENTRY_TYPES = [
-    'include',
-    'option',
-    'plugin',
-    'poptag',
-    'pushtag',
-];

package/build/src/utils/splitStringIntoUnparsedEntries.d.ts

@@ -1,14 +0,0 @@
-/**
- * Splits a Beancount file string into an array of unparsed entry arrays.
- * Each entry is represented as an array of strings (tokens).
- *
- * This function handles:
- * - Splitting on blank lines between entries
- * - Detecting new entries based on indentation
- * - Preserving multi-line strings that span lines
- *
- * @param input - The complete Beancount file content as a string
- * @returns An array where each element is an array of string tokens representing one entry
- * @internal
- */
-export declare const splitStringIntoUnparsedEntries: (input: string) => string[][];

package/build/src/utils/splitStringIntoUnparsedEntries.js

@@ -1,48 +0,0 @@
-import { countChar } from './countChar.mjs';
-import { stringAwareSplitLine } from './stringAwareSplitLine.mjs';
-/**
- * Splits a Beancount file string into an array of unparsed entry arrays.
- * Each entry is represented as an array of strings (tokens).
- *
- * This function handles:
- * - Splitting on blank lines between entries
- * - Detecting new entries based on indentation
- * - Preserving multi-line strings that span lines
- *
- * @param input - The complete Beancount file content as a string
- * @returns An array where each element is an array of string tokens representing one entry
- * @internal
- */
-export const splitStringIntoUnparsedEntries = (input) => {
-    const lines = input.split('\n');
-    // split up the file into entries
-    let inEntry = false;
-    let inString = false;
-    const unparsedEntries = lines.reduce((acc, line) => {
-        if (!inString) {
-            if (line.trim() === '') {
-                // empty newline, next entry starts
-                inEntry = false;
-            }
-            if (!line.startsWith(' ') && inEntry) {
-                // no indent, new entry
-                inEntry = false;
-            }
-            if (!inEntry) {
-                acc.push([]);
-                inEntry = true;
-            }
-        }
-        acc[acc.length - 1].push(line);
-        // After a blank line, ensure next line starts a new entry
-        if (!inString && line.trim() === '') {
-            inEntry = false;
-        }
-        // odd number of ", we're in an unclosed string
-        if (countChar(line, '"') % 2 === 1) {
-            inString = !inString;
-        }
-        return acc;
-    }, []);
-    return unparsedEntries.map((lines) => stringAwareSplitLine(lines.join('\n')));
-};