beancount 0.0.2 → 0.0.4

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

@@ -1,10 +1,20 @@
 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({
@@ -12,6 +22,7 @@ export class Close extends DateEntry {
             account,
         });
     }
+    /** @inheritdoc */
     toString() {
         return `${this.getDateTypePrefix()} ${this.account}${this.getMetaDataString()}`;
     }

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

@@ -1,8 +1,25 @@
 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,17 +1,34 @@
 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.props.comment,
         });
     }
+    /** @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({
             props: { comment: input },

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

@@ -1,8 +1,20 @@
 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,10 +1,20 @@
 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({
@@ -12,6 +22,7 @@ export class Commodity extends DateEntry {
             currency,
         });
     }
+    /** @inheritdoc */
     toString() {
         return `${this.getDateTypePrefix()} ${this.currency}${this.getMetaDataString()}`;
     }

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

@@ -1,10 +1,23 @@
 import type { GenericParseResultWithDate } from '../../genericParse.mjs';
 import { DateEntry } from '../DateEntry.mjs';
 import { Value } from '../Value.mjs';
+/**
+ * Represents a Custom entry for user-defined directives.
+ * Custom directives allow for extensibility with arbitrary types and values.
+ */
 export declare class Custom extends DateEntry {
+    /** @inheritdoc */
     type: "custom";
+    /** The custom directive type */
     customType: Value;
+    /** Optional array of values associated with the custom directive */
     values?: Value[];
+    /**
+     * Creates a Custom instance from a generic parse result.
+     * @param genericParseResult - The parsed custom entry data
+     * @returns A new Custom instance
+     */
     static fromGenericParseResult(genericParseResult: GenericParseResultWithDate): Custom;
+    /** @inheritdoc */
     toString(): string;
 }

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

@@ -2,11 +2,21 @@ import { assertEntryConstructor } from '../Entry.mjs';
 import { DateEntry } from '../DateEntry.mjs';
 import { simpleParseLine } from '../../utils/simpleParseLine.mjs';
 import { Value } from '../Value.mjs';
+/**
+ * Represents a Custom entry for user-defined directives.
+ * Custom directives allow for extensibility with arbitrary types and values.
+ */
 export class Custom extends DateEntry {
     constructor() {
         super(...arguments);
+        /** @inheritdoc */
         this.type = 'custom';
     }
+    /**
+     * Creates a Custom instance from a generic parse result.
+     * @param genericParseResult - The parsed custom entry data
+     * @returns A new Custom instance
+     */
     static fromGenericParseResult(genericParseResult) {
         const [customType, ...others] = simpleParseLine(genericParseResult.header);
         return new Custom({
@@ -15,6 +25,7 @@ export class Custom extends DateEntry {
             values: others.length > 0 ? others.map((o) => Value.fromString(o)) : undefined,
         });
     }
+    /** @inheritdoc */
     toString() {
         const parts = [`${this.getDateTypePrefix()} ${this.customType.toString()}`];
         if (this.values !== undefined) {

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

@@ -1,9 +1,22 @@
 import type { GenericParseResultWithDate } from '../../genericParse.mjs';
 import { DateEntry } from '../DateEntry.mjs';
+/**
+ * Represents a Document entry that links an external file to an account.
+ * Document directives associate receipts, statements, or other files with accounts.
+ */
 export declare class Document extends DateEntry {
+    /** @inheritdoc */
     type: "document";
+    /** The account the document is associated with */
     account: string;
+    /** The file path to the document */
     pathToDocument: string;
+    /**
+     * Creates a Document instance from a generic parse result.
+     * @param genericParseResult - The parsed document entry data
+     * @returns A new Document instance
+     */
     static fromGenericParseResult(genericParseResult: GenericParseResultWithDate): Document;
+    /** @inheritdoc */
     toString(): string;
 }

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

@@ -2,11 +2,21 @@ import { assertEntryConstructor } from '../Entry.mjs';
 import { DateEntry } from '../DateEntry.mjs';
 import { parseString } from '../Value.mjs';
 import { simpleParseLine } from '../../utils/simpleParseLine.mjs';
+/**
+ * Represents a Document entry that links an external file to an account.
+ * Document directives associate receipts, statements, or other files with accounts.
+ */
 export class Document extends DateEntry {
     constructor() {
         super(...arguments);
+        /** @inheritdoc */
         this.type = 'document';
     }
+    /**
+     * Creates a Document instance from a generic parse result.
+     * @param genericParseResult - The parsed document entry data
+     * @returns A new Document instance
+     */
     static fromGenericParseResult(genericParseResult) {
         const [account, pathToDocument] = simpleParseLine(genericParseResult.header);
         return new Document({
@@ -15,6 +25,7 @@ export class Document extends DateEntry {
             pathToDocument: parseString(pathToDocument),
         });
     }
+    /** @inheritdoc */
     toString() {
         return `${this.getDateTypePrefix()} ${this.account} "${this.pathToDocument}"${this.getMetaDataString()}`;
     }

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

@@ -1,10 +1,23 @@
 import type { GenericParseResultWithDate } from '../../genericParse.mjs';
 import { DateEntry } from '../DateEntry.mjs';
 import { Value } from '../Value.mjs';
+/**
+ * Represents an Event entry that records a named event with a value.
+ * Event directives track occurrences of specific events over time.
+ */
 export declare class Event extends DateEntry {
+    /** @inheritdoc */
     type: "event";
+    /** The name of the event */
     name: string;
+    /** The value associated with the event */
     value: Value;
+    /**
+     * Creates an Event instance from a generic parse result.
+     * @param genericParseResult - The parsed event entry data
+     * @returns A new Event instance
+     */
     static fromGenericParseResult(genericParseResult: GenericParseResultWithDate): Event;
+    /** @inheritdoc */
     toString(): string;
 }

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

@@ -2,11 +2,21 @@ import { assertEntryConstructor } from '../Entry.mjs';
 import { DateEntry } from '../DateEntry.mjs';
 import { parseString, Value } from '../Value.mjs';
 import { stringAwareParseLine } from '../../utils/stringAwareParseLine.mjs';
+/**
+ * Represents an Event entry that records a named event with a value.
+ * Event directives track occurrences of specific events over time.
+ */
 export class Event extends DateEntry {
     constructor() {
         super(...arguments);
+        /** @inheritdoc */
         this.type = 'event';
     }
+    /**
+     * Creates an Event instance from a generic parse result.
+     * @param genericParseResult - The parsed event entry data
+     * @returns A new Event instance
+     */
     static fromGenericParseResult(genericParseResult) {
         const [name, value] = stringAwareParseLine(genericParseResult.header);
         return new Event({
@@ -15,6 +25,7 @@ export class Event extends DateEntry {
             value: Value.fromString(value),
         });
     }
+    /** @inheritdoc */
     toString() {
         return `${this.getDateTypePrefix()} "${this.name}" ${this.value.toString()}${this.getMetaDataString()}`;
     }

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

@@ -1,8 +1,20 @@
 import type { GenericParseResult } from '../../genericParse.mjs';
 import { Entry } from '../Entry.mjs';
+/**
+ * Represents an Include entry that includes another Beancount file.
+ * Include directives allow splitting ledgers across multiple files.
+ */
 export declare class Include extends Entry {
+    /** @inheritdoc */
     type: "include";
+    /** The filename/path of the file to include */
     filename: string;
+    /**
+     * Creates an Include instance from a generic parse result.
+     * @param genericParseResult - The parsed include entry data
+     * @returns A new Include instance
+     */
     static fromGenericParseResult(genericParseResult: GenericParseResult): Include;
+    /** @inheritdoc */
     toString(): string;
 }

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

@@ -1,17 +1,28 @@
 import { parseString } from '../Value.mjs';
 import { stringAwareParseLine } from '../../utils/stringAwareParseLine.mjs';
 import { assertEntryConstructor, Entry } from '../Entry.mjs';
+/**
+ * Represents an Include entry that includes another Beancount file.
+ * Include directives allow splitting ledgers across multiple files.
+ */
 export class Include extends Entry {
     constructor() {
         super(...arguments);
+        /** @inheritdoc */
         this.type = 'include';
     }
+    /**
+     * Creates an Include instance from a generic parse result.
+     * @param genericParseResult - The parsed include entry data
+     * @returns A new Include instance
+     */
     static fromGenericParseResult(genericParseResult) {
         const [filename] = stringAwareParseLine(genericParseResult.header);
         return new Include({
             filename: parseString(filename),
         });
     }
+    /** @inheritdoc */
     toString() {
         return `${this.type} "${this.filename}"`;
     }

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

@@ -1,9 +1,22 @@
 import type { GenericParseResultWithDate } from '../../genericParse.mjs';
 import { DateEntry } from '../DateEntry.mjs';
+/**
+ * Represents a Note entry that attaches a comment to an account.
+ * Note directives associate free-form text descriptions with accounts at specific dates.
+ */
 export declare class Note extends DateEntry {
+    /** @inheritdoc */
     type: "note";
+    /** The account the note is attached to */
     account: string;
+    /** The note description text */
     description: string;
+    /**
+     * Creates a Note instance from a generic parse result.
+     * @param genericParseResult - The parsed note entry data
+     * @returns A new Note instance
+     */
     static fromGenericParseResult(genericParseResult: GenericParseResultWithDate): Note;
+    /** @inheritdoc */
     toString(): string;
 }

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

@@ -2,11 +2,21 @@ import { assertEntryConstructor } from '../Entry.mjs';
 import { DateEntry } from '../DateEntry.mjs';
 import { parseString } from '../Value.mjs';
 import { stringAwareParseLine } from '../../utils/stringAwareParseLine.mjs';
+/**
+ * Represents a Note entry that attaches a comment to an account.
+ * Note directives associate free-form text descriptions with accounts at specific dates.
+ */
 export class Note extends DateEntry {
     constructor() {
         super(...arguments);
+        /** @inheritdoc */
         this.type = 'note';
     }
+    /**
+     * Creates a Note instance from a generic parse result.
+     * @param genericParseResult - The parsed note entry data
+     * @returns A new Note instance
+     */
     static fromGenericParseResult(genericParseResult) {
         const [account, description] = stringAwareParseLine(genericParseResult.header);
         return new Note({
@@ -15,6 +25,7 @@ export class Note extends DateEntry {
             description: parseString(description),
         });
     }
+    /** @inheritdoc */
     toString() {
         return `${this.getDateTypePrefix()} ${this.account} "${this.description}"${this.getMetaDataString()}`;
     }

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

@@ -1,12 +1,27 @@
 import type { GenericParseResultWithDate } from '../../genericParse.mjs';
 import { FormatOptions } from '../Entry.mjs';
 import { DateEntry } from '../DateEntry.mjs';
+/**
+ * Represents an Open entry that declares a new account.
+ * Open directives define the beginning of an account's lifespan.
+ */
 export declare class Open extends DateEntry {
+    /** @inheritdoc */
     type: "open";
+    /** The account name being opened */
     account: string;
+    /** Optional list of allowed currencies for this account */
     constraintCurrencies?: string[];
+    /** Optional booking method specification */
     bookingMethod?: string;
+    /**
+     * Creates an Open instance from a generic parse result.
+     * @param genericParseResult - The parsed open entry data
+     * @returns A new Open instance
+     */
     static fromGenericParseResult(genericParseResult: GenericParseResultWithDate): Open;
+    /** @inheritdoc */
     toString(): string;
+    /** @inheritdoc */
     toFormattedString(formatOptions: FormatOptions): string;
 }

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

@@ -2,11 +2,21 @@ import { assertEntryConstructor } from '../Entry.mjs';
 import { DateEntry } from '../DateEntry.mjs';
 import { simpleParseLine } from '../../utils/simpleParseLine.mjs';
 import { parseString } from '../Value.mjs';
+/**
+ * Represents an Open entry that declares a new account.
+ * Open directives define the beginning of an account's lifespan.
+ */
 export class Open extends DateEntry {
     constructor() {
         super(...arguments);
+        /** @inheritdoc */
         this.type = 'open';
     }
+    /**
+     * Creates an Open instance from a generic parse result.
+     * @param genericParseResult - The parsed open entry data
+     * @returns A new Open instance
+     */
     static fromGenericParseResult(genericParseResult) {
         const [account, ...other] = simpleParseLine(genericParseResult.header);
         let constraintCurrencies, bookingMethod;
@@ -29,9 +39,11 @@ export class Open extends DateEntry {
             bookingMethod,
         });
     }
+    /** @inheritdoc */
     toString() {
         return this.toFormattedString({ currencyColumn: 0 });
     }
+    /** @inheritdoc */
     toFormattedString(formatOptions) {
         const parts = [`${this.getDateTypePrefix()} ${this.account}`];
         if (this.constraintCurrencies !== undefined) {

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

@@ -1,10 +1,23 @@
 import type { GenericParseResult } from '../../genericParse.mjs';
 import { Value } from '../Value.mjs';
 import { Entry } from '../Entry.mjs';
+/**
+ * Represents an Option entry that sets a Beancount configuration option.
+ * Option directives configure various aspects of Beancount's behavior.
+ */
 export declare class Option extends Entry {
+    /** @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 entry data
+     * @returns A new Option instance
+     */
     static fromGenericParseResult(genericParseResult: GenericParseResult): Option;
+    /** @inheritdoc */
     toString(): string;
 }

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

@@ -1,11 +1,21 @@
 import { parseString, Value } from '../Value.mjs';
 import { stringAwareParseLine } from '../../utils/stringAwareParseLine.mjs';
 import { assertEntryConstructor, Entry } from '../Entry.mjs';
+/**
+ * Represents an Option entry that sets a Beancount configuration option.
+ * Option directives configure various aspects of Beancount's behavior.
+ */
 export class Option extends Entry {
     constructor() {
         super(...arguments);
+        /** @inheritdoc */
         this.type = 'option';
     }
+    /**
+     * Creates an Option instance from a generic parse result.
+     * @param genericParseResult - The parsed option entry data
+     * @returns A new Option instance
+     */
     static fromGenericParseResult(genericParseResult) {
         const [name, value] = stringAwareParseLine(genericParseResult.header);
         return new Option({
@@ -13,6 +23,7 @@ export class Option extends Entry {
             value: Value.fromString(value),
         });
     }
+    /** @inheritdoc */
     toString() {
         return `${this.type} "${this.name}" ${this.value.toString()}`;
     }

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

@@ -1,9 +1,22 @@
 import type { GenericParseResultWithDate } from '../../genericParse.mjs';
 import { DateEntry } from '../DateEntry.mjs';
+/**
+ * Represents a Pad entry that automatically balances accounts.
+ * Pad directives insert transactions to bring an account to a specific balance.
+ */
 export declare class Pad extends DateEntry {
+    /** @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 entry data
+     * @returns A new Pad instance
+     */
     static fromGenericParseResult(genericParseResult: GenericParseResultWithDate): Pad;
+    /** @inheritdoc */
     toString(): string;
 }

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

@@ -1,11 +1,21 @@
 import { assertEntryConstructor } from '../Entry.mjs';
 import { DateEntry } from '../DateEntry.mjs';
 import { simpleParseLine } from '../../utils/simpleParseLine.mjs';
+/**
+ * Represents a Pad entry that automatically balances accounts.
+ * Pad directives insert transactions to bring an account to a specific balance.
+ */
 export class Pad extends DateEntry {
     constructor() {
         super(...arguments);
+        /** @inheritdoc */
         this.type = 'pad';
     }
+    /**
+     * Creates a Pad instance from a generic parse result.
+     * @param genericParseResult - The parsed pad entry data
+     * @returns A new Pad instance
+     */
     static fromGenericParseResult(genericParseResult) {
         const [account, accountPad] = simpleParseLine(genericParseResult.header);
         return new Pad({
@@ -14,6 +24,7 @@ export class Pad extends DateEntry {
             accountPad,
         });
     }
+    /** @inheritdoc */
     toString() {
         return `${this.getDateTypePrefix()} ${this.account} ${this.accountPad}${this.getMetaDataString()}`;
     }

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

@@ -1,9 +1,22 @@
 import type { GenericParseResult } from '../../genericParse.mjs';
 import { Entry } from '../Entry.mjs';
+/**
+ * Represents a Plugin entry that loads a Beancount plugin.
+ * Plugin directives enable plugins to process the ledger.
+ */
 export declare class Plugin extends Entry {
+    /** @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 entry data
+     * @returns A new Plugin instance
+     */
     static fromGenericParseResult(genericParseResult: GenericParseResult): Plugin;
+    /** @inheritdoc */
     toString(): string;
 }

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

@@ -1,11 +1,21 @@
 import { parseString } from '../Value.mjs';
 import { stringAwareParseLine } from '../../utils/stringAwareParseLine.mjs';
 import { assertEntryConstructor, Entry } from '../Entry.mjs';
+/**
+ * Represents a Plugin entry that loads a Beancount plugin.
+ * Plugin directives enable plugins to process the ledger.
+ */
 export class Plugin extends Entry {
     constructor() {
         super(...arguments);
+        /** @inheritdoc */
         this.type = 'plugin';
     }
+    /**
+     * Creates a Plugin instance from a generic parse result.
+     * @param genericParseResult - The parsed plugin entry data
+     * @returns A new Plugin instance
+     */
     static fromGenericParseResult(genericParseResult) {
         const [moduleName, config] = stringAwareParseLine(genericParseResult.header);
         return new Plugin({
@@ -13,6 +23,7 @@ export class Plugin extends Entry {
             config: config ? parseString(config) : undefined,
         });
     }
+    /** @inheritdoc */
     toString() {
         const parts = [`${this.type} "${this.moduleName}"`];
         if (this.config !== undefined) {

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

@@ -1,9 +1,21 @@
 import type { GenericParseResult } from '../../genericParse.mjs';
 import { Entry } from '../Entry.mjs';
 import { Tag } from './Transaction/Tag.mjs';
+/**
+ * Represents a Poptag entry that removes a tag from the tag stack.
+ * Transactions after this will no longer inherit the popped tag.
+ */
 export declare class Poptag extends Entry {
+    /** @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 entry data
+     * @returns A new Poptag instance
+     */
     static fromGenericParseResult(genericParseResult: GenericParseResult): Poptag;
+    /** @inheritdoc */
     toString(): string;
 }