@classytic/ledger 0.3.0 → 0.4.1

package/dist/{revaluation-D9x0NE8w.d.mts → trial-balance-DcQ0xj_4.d.mts}

@@ -1,47 +1,50 @@
 import { c as DateRange } from "./core-8Xfnpn6g.mjs";
 import { t as CountryPack } from "./index-CxZqRaOU.mjs";
-import { t as Logger } from "./logger-CbHWZl7v.mjs";
+import { t as Logger } from "./logger-UbTdBb1x.mjs";
 import { ClientSession, Model } from "mongoose";
 
-//#region src/reports/budget-vs-actual.d.ts
-interface BudgetVsActualOptions {
+//#region src/reports/aged-balance.d.ts
+interface AgedBucketConfig {
+  label: string;
+  minDays: number;
+  maxDays: number;
+}
+declare const DEFAULT_BUCKETS: AgedBucketConfig[];
+interface AgedBalanceOptions {
   AccountModel: Model<unknown>;
   JournalEntryModel: Model<unknown>;
-  BudgetModel: Model<unknown>;
   country: CountryPack;
   orgField?: string;
 }
-interface BudgetVsActualParams {
+interface AgedBalanceParams {
   organizationId?: unknown;
-  dateOption: 'month' | 'quarter' | 'year' | 'custom';
-  dateValue: unknown;
+  asOfDate?: Date;
+  type: 'receivable' | 'payable';
   accountIds?: unknown[];
-  filters?: Record<string, unknown>;
+  dueDateField?: string;
+  contactField?: string;
+  buckets?: AgedBucketConfig[];
 }
-interface BudgetVsActualRow {
+interface AgedBalanceRow {
   accountId: unknown;
   accountName: string;
   accountCode: string;
-  category: string;
-  budgetAmount: number;
-  actualAmount: number;
-  variance: number;
-  variancePercent: number;
+  contactId?: unknown;
+  total: number;
+  buckets: Record<string, number>;
 }
-interface BudgetVsActualReport {
+interface AgedBalanceReport {
   metadata: {
     generatedAt: string;
-    periodStart: string;
-    periodEnd: string;
-  };
-  rows: BudgetVsActualRow[];
-  summary: {
-    totalBudget: number;
-    totalActual: number;
-    totalVariance: number;
+    asOfDate: string;
+    type: string;
   };
+  bucketLabels: string[];
+  rows: AgedBalanceRow[];
+  totals: Record<string, number>;
+  grandTotal: number;
 }
-declare function generateBudgetVsActual(opts: BudgetVsActualOptions, params: BudgetVsActualParams): Promise<BudgetVsActualReport>;
+declare function generateAgedBalance(opts: AgedBalanceOptions, params: AgedBalanceParams): Promise<AgedBalanceReport>;
 //#endregion
 //#region src/types/report.d.ts
 interface ReportMetadata {
@@ -195,23 +198,6 @@ interface TaxReport {
   calculatedAt: string;
 }
 //#endregion
-//#region src/reports/trial-balance.d.ts
-interface TrialBalanceOptions {
-  AccountModel: Model<unknown>;
-  JournalEntryModel: Model<unknown>;
-  country: CountryPack;
-  orgField?: string;
-  fiscalYearStartMonth?: number;
-}
-declare function generateTrialBalance(opts: TrialBalanceOptions, params: {
-  organizationId?: unknown;
-  dateOption: 'month' | 'quarter' | 'year' | 'custom';
-  dateValue: unknown;
-  accountId?: string;
-  businessName?: string;
-  filters?: Record<string, unknown>;
-}): Promise<TrialBalanceReport>;
-//#endregion
 //#region src/reports/balance-sheet.d.ts
 interface BalanceSheetOptions {
   AccountModel: Model<unknown>;
@@ -238,52 +224,100 @@ declare function generateBalanceSheet(opts: BalanceSheetOptions, params: {
   filters?: Record<string, unknown>;
 }): Promise<BalanceSheetReport>;
 //#endregion
-//#region src/reports/income-statement.d.ts
-interface IncomeStatementOptions {
+//#region src/reports/budget-vs-actual.d.ts
+interface BudgetVsActualOptions {
   AccountModel: Model<unknown>;
   JournalEntryModel: Model<unknown>;
+  BudgetModel: Model<unknown>;
   country: CountryPack;
   orgField?: string;
 }
-declare function generateIncomeStatement(opts: IncomeStatementOptions, params: {
+interface BudgetVsActualParams {
   organizationId?: unknown;
   dateOption: 'month' | 'quarter' | 'year' | 'custom';
   dateValue: unknown;
-  businessName?: string;
+  accountIds?: unknown[];
   filters?: Record<string, unknown>;
-}): Promise<IncomeStatementReport>;
+}
+interface BudgetVsActualRow {
+  accountId: unknown;
+  accountName: string;
+  accountCode: string;
+  category: string;
+  budgetAmount: number;
+  actualAmount: number;
+  variance: number;
+  variancePercent: number;
+}
+interface BudgetVsActualReport {
+  metadata: {
+    generatedAt: string;
+    periodStart: string;
+    periodEnd: string;
+  };
+  rows: BudgetVsActualRow[];
+  summary: {
+    totalBudget: number;
+    totalActual: number;
+    totalVariance: number;
+  };
+}
+declare function generateBudgetVsActual(opts: BudgetVsActualOptions, params: BudgetVsActualParams): Promise<BudgetVsActualReport>;
 //#endregion
-//#region src/reports/general-ledger.d.ts
-interface GeneralLedgerOptions {
+//#region src/reports/cash-flow.d.ts
+interface CashFlowOptions {
   AccountModel: Model<unknown>;
   JournalEntryModel: Model<unknown>;
   country: CountryPack;
   orgField?: string;
-  fiscalYearStartMonth?: number;
 }
-declare function generateGeneralLedger(opts: GeneralLedgerOptions, params: {
+declare function generateCashFlow(opts: CashFlowOptions, params: {
   organizationId?: unknown;
   dateOption: 'month' | 'quarter' | 'year' | 'custom';
   dateValue: unknown;
-  accountId?: string;
   businessName?: string;
   filters?: Record<string, unknown>;
-}): Promise<GeneralLedgerReport>;
+}): Promise<CashFlowReport>;
 //#endregion
-//#region src/reports/cash-flow.d.ts
-interface CashFlowOptions {
+//#region src/reports/dimension-breakdown.d.ts
+interface DimensionBreakdownOptions {
   AccountModel: Model<unknown>;
   JournalEntryModel: Model<unknown>;
   country: CountryPack;
   orgField?: string;
 }
-declare function generateCashFlow(opts: CashFlowOptions, params: {
+interface DimensionBreakdownParams {
   organizationId?: unknown;
   dateOption: 'month' | 'quarter' | 'year' | 'custom';
   dateValue: unknown;
-  businessName?: string;
+  /** Field on journalItems to group by, e.g. 'departmentId' */
+  dimension: string;
+  /** Filter accounts by category, e.g. 'Income Statement-Expense' */
+  accountCategory?: string;
+  /** Additional item-level filters */
   filters?: Record<string, unknown>;
-}): Promise<CashFlowReport>;
+}
+interface DimensionBreakdownRow {
+  dimensionValue: unknown;
+  accounts: Array<{
+    id: unknown;
+    name: string;
+    code: string;
+    balance: number;
+  }>;
+  total: number;
+}
+interface DimensionBreakdownReport {
+  metadata: {
+    generatedAt: string;
+    dimension: string;
+    periodStart: string;
+    periodEnd: string;
+  };
+  rows: DimensionBreakdownRow[];
+  grandTotal: number;
+}
+declare function generateDimensionBreakdown(opts: DimensionBreakdownOptions, params: DimensionBreakdownParams): Promise<DimensionBreakdownReport>;
 //#endregion
 //#region src/reports/fiscal-close.d.ts
 interface FiscalCloseOptions {
@@ -325,88 +359,37 @@ declare function reopenFiscalPeriod(opts: Pick<FiscalCloseOptions, 'JournalEntry
   session?: ClientSession;
 }): Promise<FiscalReopenResult>;
 //#endregion
-//#region src/reports/dimension-breakdown.d.ts
-interface DimensionBreakdownOptions {
+//#region src/reports/general-ledger.d.ts
+interface GeneralLedgerOptions {
   AccountModel: Model<unknown>;
   JournalEntryModel: Model<unknown>;
   country: CountryPack;
   orgField?: string;
+  fiscalYearStartMonth?: number;
 }
-interface DimensionBreakdownParams {
+declare function generateGeneralLedger(opts: GeneralLedgerOptions, params: {
   organizationId?: unknown;
   dateOption: 'month' | 'quarter' | 'year' | 'custom';
   dateValue: unknown;
-  /** Field on journalItems to group by, e.g. 'departmentId' */
-  dimension: string;
-  /** Filter accounts by category, e.g. 'Income Statement-Expense' */
-  accountCategory?: string;
-  /** Additional item-level filters */
+  accountId?: string;
+  businessName?: string;
   filters?: Record<string, unknown>;
-}
-interface DimensionBreakdownRow {
-  dimensionValue: unknown;
-  accounts: Array<{
-    id: unknown;
-    name: string;
-    code: string;
-    balance: number;
-  }>;
-  total: number;
-}
-interface DimensionBreakdownReport {
-  metadata: {
-    generatedAt: string;
-    dimension: string;
-    periodStart: string;
-    periodEnd: string;
-  };
-  rows: DimensionBreakdownRow[];
-  grandTotal: number;
-}
-declare function generateDimensionBreakdown(opts: DimensionBreakdownOptions, params: DimensionBreakdownParams): Promise<DimensionBreakdownReport>;
+}): Promise<GeneralLedgerReport>;
 //#endregion
-//#region src/reports/aged-balance.d.ts
-interface AgedBucketConfig {
-  label: string;
-  minDays: number;
-  maxDays: number;
-}
-declare const DEFAULT_BUCKETS: AgedBucketConfig[];
-interface AgedBalanceOptions {
+//#region src/reports/income-statement.d.ts
+interface IncomeStatementOptions {
   AccountModel: Model<unknown>;
   JournalEntryModel: Model<unknown>;
   country: CountryPack;
   orgField?: string;
 }
-interface AgedBalanceParams {
+declare function generateIncomeStatement(opts: IncomeStatementOptions, params: {
   organizationId?: unknown;
-  asOfDate?: Date;
-  type: 'receivable' | 'payable';
-  accountIds?: unknown[];
-  dueDateField?: string;
-  contactField?: string;
-  buckets?: AgedBucketConfig[];
-}
-interface AgedBalanceRow {
-  accountId: unknown;
-  accountName: string;
-  accountCode: string;
-  contactId?: unknown;
-  total: number;
-  buckets: Record<string, number>;
-}
-interface AgedBalanceReport {
-  metadata: {
-    generatedAt: string;
-    asOfDate: string;
-    type: string;
-  };
-  bucketLabels: string[];
-  rows: AgedBalanceRow[];
-  totals: Record<string, number>;
-  grandTotal: number;
-}
-declare function generateAgedBalance(opts: AgedBalanceOptions, params: AgedBalanceParams): Promise<AgedBalanceReport>;
+  dateOption: 'month' | 'quarter' | 'year' | 'custom';
+  dateValue: unknown;
+  businessName?: string;
+  filters?: Record<string, unknown>;
+}): Promise<IncomeStatementReport>;
 //#endregion
 //#region src/utils/revaluation.d.ts
 /**
@@ -527,4 +510,21 @@ interface RevaluationReport {
  */
 declare function generateRevaluation(opts: RevaluationOptions, params: RevaluationParams): Promise<RevaluationReport>;
 //#endregion
-export { BudgetVsActualReport as $, generateGeneralLedger as A, GeneralLedgerAccount as B, FiscalCloseResult as C, CashFlowOptions as D, reopenFiscalPeriod as E, TrialBalanceOptions as F, ReportCategory as G, IncomeStatementReport as H, generateTrialBalance as I, TaxReturnSummary as J, ReportGroup as K, BalanceSheetReport as L, generateIncomeStatement as M, BalanceSheetOptions as N, generateCashFlow as O, generateBalanceSheet as P, BudgetVsActualParams as Q, CashFlowReport as R, FiscalCloseOptions as S, closeFiscalPeriod as T, LedgerEntry as U, GeneralLedgerReport as V, ReportAccount as W, TrialBalanceRow as X, TrialBalanceReport as Y, BudgetVsActualOptions as Z, DimensionBreakdownOptions as _, AccountForeignBalance as a, DimensionBreakdownRow as b, buildRevaluationEntry as c, AgedBalanceParams as d, BudgetVsActualRow as et, AgedBalanceReport as f, generateAgedBalance as g, DEFAULT_BUCKETS as h, generateRevaluation as i, IncomeStatementOptions as j, GeneralLedgerOptions as k, computeRevaluation as l, AgedBucketConfig as m, RevaluationParams as n, RevaluationRate as o, AgedBalanceRow as p, TaxReport as q, RevaluationReport as r, RevaluationResult as s, RevaluationOptions as t, generateBudgetVsActual as tt, AgedBalanceOptions as u, DimensionBreakdownParams as v, FiscalReopenResult as w, generateDimensionBreakdown as x, DimensionBreakdownReport as y, CashFlowSection as z };
+//#region src/reports/trial-balance.d.ts
+interface TrialBalanceOptions {
+  AccountModel: Model<unknown>;
+  JournalEntryModel: Model<unknown>;
+  country: CountryPack;
+  orgField?: string;
+  fiscalYearStartMonth?: number;
+}
+declare function generateTrialBalance(opts: TrialBalanceOptions, params: {
+  organizationId?: unknown;
+  dateOption: 'month' | 'quarter' | 'year' | 'custom';
+  dateValue: unknown;
+  accountId?: string;
+  businessName?: string;
+  filters?: Record<string, unknown>;
+}): Promise<TrialBalanceReport>;
+//#endregion
+export { AgedBucketConfig as $, BudgetVsActualReport as A, IncomeStatementReport as B, DimensionBreakdownReport as C, generateCashFlow as D, CashFlowOptions as E, BalanceSheetReport as F, TaxReport as G, ReportAccount as H, CashFlowReport as I, TrialBalanceRow as J, TaxReturnSummary as K, CashFlowSection as L, generateBudgetVsActual as M, BalanceSheetOptions as N, BudgetVsActualOptions as O, generateBalanceSheet as P, AgedBalanceRow as Q, GeneralLedgerAccount as R, DimensionBreakdownParams as S, generateDimensionBreakdown as T, ReportCategory as U, LedgerEntry as V, ReportGroup as W, AgedBalanceParams as X, AgedBalanceOptions as Y, AgedBalanceReport as Z, FiscalCloseResult as _, RevaluationReport as a, reopenFiscalPeriod as b, RevaluationRate as c, computeRevaluation as d, DEFAULT_BUCKETS as et, IncomeStatementOptions as f, FiscalCloseOptions as g, generateGeneralLedger as h, RevaluationParams as i, BudgetVsActualRow as j, BudgetVsActualParams as k, RevaluationResult as l, GeneralLedgerOptions as m, generateTrialBalance as n, generateRevaluation as o, generateIncomeStatement as p, TrialBalanceReport as q, RevaluationOptions as r, AccountForeignBalance as s, TrialBalanceOptions as t, generateAgedBalance as tt, buildRevaluationEntry as u, FiscalReopenResult as v, DimensionBreakdownRow as w, DimensionBreakdownOptions as x, closeFiscalPeriod as y, GeneralLedgerReport as z };

package/docs/schemas.md

@@ -52,8 +52,8 @@ const JournalEntry = mongoose.model('JournalEntry', JournalEntrySchema);
 
 | Field | Type | Required | Description |
 |---|---|---|---|
-| `journalType` | String | Yes | One of: `GENERAL`, `SALES`, `PURCHASE`, `CASH_RECEIPT`, `CASH_DISBURSEMENT`, `PAYROLL`, `ADJUSTMENT`, `YEAR_END`, `MISC` |
-| `referenceNumber` | String | Auto | Auto-generated (e.g. `GJ-0001`). Unique per org |
+| `journalType` | String | Yes | Built-in: `SALES`, `PURCHASES`, `CASH_RECEIPTS`, `CASH_PAYMENTS`, `PAYROLL`, `GENERAL`, `INVENTORY`, `FIXED_ASSETS`, `BANK_RECONCILIATION`, `DEPRECIATION`, `YEAR_END`, `ACCOUNTS_RECEIVABLE`, `ACCOUNTS_PAYABLE`, `TAX`, `MISC`. Extensible via `registerJournalType()` before schema creation. |
+| `referenceNumber` | String | Auto | Auto-generated as `{JOURNAL_TYPE}/{YYYY}/{MM}/{NNNN}` (e.g. `SALES/2025/03/0001`). Unique per org. Sequence increments per journal type per month. |
 | `label` | String | No | Description/memo |
 | `date` | Date | No | Defaults to `new Date()` |
 | `state` | String | No | `draft` (default), `posted`, or `archived` |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@classytic/ledger",
-  "version": "0.3.0",
+  "version": "0.4.1",
   "description": "Production-grade double-entry accounting engine for MongoDB — schemas, reports, tax, multi-tenant",
   "type": "module",
   "sideEffects": false,
@@ -88,8 +88,8 @@
     "url": "git+https://github.com/classytic/accounting.git"
   },
   "peerDependencies": {
-    "@classytic/mongokit": ">=3.4.3",
-    "mongoose": ">=9.0.0"
+    "@classytic/mongokit": ">=3.5.3",
+    "mongoose": ">=9.4.1"
   },
   "engines": {
     "node": ">=22"
@@ -101,14 +101,22 @@
     "test:watch": "vitest",
     "test:coverage": "vitest run --coverage",
     "typecheck": "tsc --noEmit",
-    "prepublishOnly": "npm run build && npm run typecheck",
-    "release": "npm run build && npm run typecheck && npm publish --access public"
+    "lint": "biome check src/",
+    "lint:fix": "biome check src/ --write",
+    "format": "biome format src/ --write",
+    "check": "biome ci src/ --diagnostic-level=error",
+    "knip": "knip",
+    "prepublishOnly": "npm run check && npm run build && npm run typecheck && npm test",
+    "release": "npm run check && npm run build && npm run typecheck && npm test && npm publish --access public"
   },
   "devDependencies": {
+    "@biomejs/biome": "^2.4.10",
+    "@classytic/mongokit": "^3.5.3",
     "@types/node": "^22.0.0",
     "@vitest/coverage-v8": "^3.2.4",
+    "knip": "^6.3.0",
     "mongodb-memory-server": "^10.2.3",
-    "mongoose": "^9.3.1",
+    "mongoose": "^9.4.1",
     "tsdown": "^0.21.5",
     "typescript": "^5.7.0",
     "vitest": "^3.0.0"