@happyvertical/smrt-ledgers 0.30.0

package/dist/types.d.ts

@@ -0,0 +1,179 @@
+import { SmrtClassOptions } from '@happyvertical/smrt-core';
+import { SmrtHierarchical } from '@happyvertical/smrt-core';
+
+declare class Account extends SmrtHierarchical {
+    /**
+     * Tenant ID for multi-tenancy support (nullable for global accounts)
+     */
+    tenantId: string | null;
+    /**
+     * Account number (e.g., "1000", "5030")
+     */
+    number: string;
+    /**
+     * Account name (e.g., "Cash", "Coffee Expense")
+     */
+    name: string;
+    /**
+     * Account description
+     */
+    description: string;
+    /**
+     * Account type - one of the 5 core types
+     */
+    type: AccountType;
+    /**
+     * Whether the account is active
+     */
+    active: boolean;
+    /**
+     * Extensible metadata
+     */
+    metadata: Record<string, unknown>;
+    constructor(options?: AccountOptions);
+    /**
+     * Check if this is a top-level account (no parent)
+     */
+    isTopLevel(): boolean;
+    /**
+     * Check if this is a debit-normal account (Asset, Expense)
+     * Debit-normal accounts increase with debits
+     */
+    isDebitNormal(): boolean;
+    /**
+     * Check if this is a credit-normal account (Liability, Equity, Revenue)
+     * Credit-normal accounts increase with credits
+     */
+    isCreditNormal(): boolean;
+    /**
+     * Get full account path (e.g., "Assets > Current > Cash")
+     */
+    getFullPath(): Promise<string>;
+    /**
+     * Build tree node for this account and its children
+     */
+    toTreeNode(): Promise<AccountTreeNode>;
+    /**
+     * Get the current balance of this account
+     */
+    getBalance(asOfDate?: Date): Promise<number>;
+    /**
+     * Create a sub-account under this account
+     */
+    createChild(options: Omit<AccountOptions, 'parentId' | 'type'>): Promise<Account>;
+}
+
+/**
+ * Options for creating an Account
+ */
+export declare interface AccountOptions extends SmrtClassOptions {
+    tenantId?: string | null;
+    number?: string;
+    name?: string;
+    description?: string;
+    type?: AccountType;
+    parentId?: string | null;
+    active?: boolean;
+    metadata?: Record<string, unknown>;
+}
+
+/**
+ * Account tree structure
+ */
+export declare interface AccountTree {
+    roots: AccountTreeNode[];
+}
+
+/**
+ * Account tree node for hierarchical display
+ */
+export declare interface AccountTreeNode {
+    account: Account;
+    children: AccountTreeNode[];
+}
+
+/**
+ * The five core account types in double-entry accounting
+ */
+export declare type AccountType = 'asset' | 'liability' | 'equity' | 'revenue' | 'expense';
+
+/**
+ * Epsilon value for floating-point balance comparisons.
+ * Used to determine if debits and credits are balanced.
+ */
+export declare const BALANCE_EPSILON = 0.001;
+
+/**
+ * Data for creating a complete journal with entries
+ */
+export declare interface CreateJournalData {
+    date?: Date;
+    description: string;
+    sourceModule?: string;
+    sourceRef?: string | null;
+    entries: JournalEntryData[];
+    metadata?: Record<string, unknown>;
+}
+
+/**
+ * Entry data for creating journal entries
+ */
+export declare interface JournalEntryData {
+    accountId: string;
+    debit?: number;
+    credit?: number;
+    currency?: string;
+    exchangeRate?: number;
+    memo?: string;
+}
+
+/**
+ * Options for creating a JournalEntry
+ */
+export declare interface JournalEntryOptions extends SmrtClassOptions {
+    tenantId?: string | null;
+    journalId?: string;
+    accountId?: string;
+    debit?: number;
+    credit?: number;
+    currency?: string;
+    exchangeRate?: number;
+    memo?: string;
+    metadata?: Record<string, unknown>;
+}
+
+/**
+ * Options for creating a Journal
+ */
+export declare interface JournalOptions extends SmrtClassOptions {
+    tenantId?: string | null;
+    number?: string;
+    date?: Date;
+    description?: string;
+    sourceModule?: string;
+    sourceRef?: string | null;
+    status?: JournalStatus;
+    postedAt?: Date | null;
+    voidedAt?: Date | null;
+    voidReason?: string | null;
+    metadata?: Record<string, unknown>;
+}
+
+/**
+ * Journal status lifecycle
+ */
+export declare type JournalStatus = 'draft' | 'posted' | 'voided';
+
+/**
+ * A row in the trial balance report
+ */
+export declare interface TrialBalanceRow {
+    accountId: string;
+    accountNumber: string;
+    accountName: string;
+    accountType: AccountType;
+    debitBalance: number;
+    creditBalance: number;
+}
+
+export { }

package/dist/types.js

@@ -0,0 +1,5 @@
+const BALANCE_EPSILON = 1e-3;
+export {
+  BALANCE_EPSILON
+};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sources":["../src/types.ts"],"sourcesContent":["/**\n * Type definitions for smrt-ledgers\n */\n\nimport type { SmrtClassOptions } from '@happyvertical/smrt-core';\n\n/**\n * Epsilon value for floating-point balance comparisons.\n * Used to determine if debits and credits are balanced.\n */\nexport const BALANCE_EPSILON = 0.001;\n\n/**\n * The five core account types in double-entry accounting\n */\nexport type AccountType =\n  | 'asset'\n  | 'liability'\n  | 'equity'\n  | 'revenue'\n  | 'expense';\n\n/**\n * Journal status lifecycle\n */\nexport type JournalStatus = 'draft' | 'posted' | 'voided';\n\n/**\n * Options for creating an Account\n */\nexport interface AccountOptions extends SmrtClassOptions {\n  tenantId?: string | null;\n  number?: string;\n  name?: string;\n  description?: string;\n  type?: AccountType;\n  parentId?: string | null;\n  active?: boolean;\n  metadata?: Record<string, unknown>;\n}\n\n/**\n * Options for creating a Journal\n */\nexport interface JournalOptions extends SmrtClassOptions {\n  tenantId?: string | null;\n  number?: string;\n  date?: Date;\n  description?: string;\n  sourceModule?: string;\n  sourceRef?: string | null;\n  status?: JournalStatus;\n  postedAt?: Date | null;\n  voidedAt?: Date | null;\n  voidReason?: string | null;\n  metadata?: Record<string, unknown>;\n}\n\n/**\n * Options for creating a JournalEntry\n */\nexport interface JournalEntryOptions extends SmrtClassOptions {\n  tenantId?: string | null;\n  journalId?: string;\n  accountId?: string;\n  debit?: number;\n  credit?: number;\n  currency?: string;\n  exchangeRate?: number;\n  memo?: string;\n  metadata?: Record<string, unknown>;\n}\n\n/**\n * A row in the trial balance report\n */\nexport interface TrialBalanceRow {\n  accountId: string;\n  accountNumber: string;\n  accountName: string;\n  accountType: AccountType;\n  debitBalance: number;\n  creditBalance: number;\n}\n\n/**\n * Account tree node for hierarchical display\n */\nexport interface AccountTreeNode {\n  account: import('./models/Account').Account;\n  children: AccountTreeNode[];\n}\n\n/**\n * Account tree structure\n */\nexport interface AccountTree {\n  roots: AccountTreeNode[];\n}\n\n/**\n * Entry data for creating journal entries\n */\nexport interface JournalEntryData {\n  accountId: string;\n  debit?: number;\n  credit?: number;\n  currency?: string;\n  exchangeRate?: number;\n  memo?: string;\n}\n\n/**\n * Data for creating a complete journal with entries\n */\nexport interface CreateJournalData {\n  date?: Date;\n  description: string;\n  sourceModule?: string;\n  sourceRef?: string | null;\n  entries: JournalEntryData[];\n  metadata?: Record<string, unknown>;\n}\n"],"names":[],"mappings":"AAUO,MAAM,kBAAkB;"}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@happyvertical/smrt-ledgers",
+  "version": "0.30.0",
+  "description": "Double-entry accounting ledger for the SMRT framework",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./manifest": "./dist/manifest.json",
+    "./manifest.json": "./dist/manifest.json"
+  },
+  "files": [
+    "dist",
+    "CLAUDE.md",
+    "AGENTS.md"
+  ],
+  "keywords": [
+    "smrt",
+    "ledger",
+    "accounting",
+    "double-entry",
+    "journal",
+    "bookkeeping"
+  ],
+  "author": "HappyVertical",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/happyvertical/smrt.git",
+    "directory": "packages/ledgers"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  },
+  "dependencies": {
+    "@happyvertical/smrt-core": "0.30.0",
+    "@happyvertical/smrt-prompts": "0.30.0",
+    "@happyvertical/smrt-tenancy": "0.30.0"
+  },
+  "devDependencies": {
+    "@types/node": "25.0.9",
+    "fast-glob": "^3.3.3",
+    "typescript": "^5.9.3",
+    "vite": "^7.3.1",
+    "vitest": "^4.0.17",
+    "@happyvertical/smrt-vitest": "0.30.0"
+  },
+  "scripts": {
+    "build": "vite build --mode library",
+    "dev": "vite build --watch",
+    "test": "vitest run",
+    "typecheck": "tsc -p tsconfig.typecheck.json"
+  }
+}