@classytic/ledger 0.1.5 → 0.3.0

package/dist/{fiscal-period.schema-CbALaaKl.mjs → reconciliation.schema-BuetvZTd.mjs}

@@ -1,6 +1,24 @@
-import { i as getJournalTypeCodes, t as JOURNAL_CODES } from "./journals-CI3Wb4EF.mjs";
+import { i as getJournalTypeCodes, t as JOURNAL_CODES } from "./journals-oH-FK3g8.mjs";
 import mongoose from "mongoose";
-
+//#region src/schemas/currency-field.ts
+/**
+* Build the Mongoose currency field definition.
+* Returns `null` if multi-currency is not enabled.
+*/
+function buildCurrencyField(config) {
+	if (!config.multiCurrency?.enabled) return null;
+	const allowed = config.multiCurrency.currencies;
+	return {
+		type: String,
+		default: null,
+		...allowed?.length ? { enum: [
+			null,
+			config.currency,
+			...allowed
+		] } : {}
+	};
+}
+//#endregion
 //#region src/schemas/account.schema.ts
 /**
 * Account Schema Factory
@@ -40,9 +58,11 @@ function createAccountSchema(config, options = {}) {
 		isCashAccount: {
 			type: Boolean,
 			default: false
-		},
-		...extraFields
+		}
 	};
+	const currencyField = buildCurrencyField(config);
+	if (currencyField) fields.currency = currencyField;
+	Object.assign(fields, extraFields);
 	if (multiTenant) fields[multiTenant.orgField] = {
 		type: mongoose.Schema.Types.ObjectId,
 		ref: multiTenant.orgRef,
@@ -50,9 +70,8 @@ function createAccountSchema(config, options = {}) {
 	};
 	const schema = new mongoose.Schema(fields, { timestamps: true });
 	schema.pre("validate", function() {
-		const doc = this;
-		if (!doc.accountNumber && doc.accountTypeCode) doc.accountNumber = doc.accountTypeCode;
-		if (!doc.name && doc.accountTypeCode) doc.name = country.getAccountType(doc.accountTypeCode)?.name ?? doc.accountTypeCode;
+		if (!this.accountNumber && this.accountTypeCode) this.accountNumber = this.accountTypeCode;
+		if (!this.name && this.accountTypeCode) this.name = country.getAccountType(this.accountTypeCode)?.name ?? this.accountTypeCode;
 	});
 	if (indexes) if (multiTenant) {
 		const org = multiTenant.orgField;
@@ -76,7 +95,6 @@ function createAccountSchema(config, options = {}) {
 	for (const idx of extraIndexes) schema.index(idx.fields, idx.options);
 	return schema;
 }
-
 //#endregion
 //#region src/schemas/journal-entry.schema.ts
 /**
@@ -101,6 +119,31 @@ function createJournalEntrySchema(config, accountModelName, options = {}) {
 		validator: (v) => Number.isInteger(v) && v >= 0,
 		message: "{PATH} must be a non-negative integer (cents), got {VALUE}"
 	};
+	const currencyItemFields = {};
+	const currencyField = buildCurrencyField(config);
+	if (currencyField) {
+		currencyItemFields.currency = currencyField;
+		currencyItemFields.exchangeRate = {
+			type: Number,
+			default: null,
+			validate: {
+				validator: (v) => v === null || v > 0,
+				message: "exchangeRate must be greater than zero when set, got {VALUE}"
+			}
+		};
+		currencyItemFields.originalDebit = {
+			type: Number,
+			default: null,
+			min: 0,
+			validate: amountValidator
+		};
+		currencyItemFields.originalCredit = {
+			type: Number,
+			default: null,
+			min: 0,
+			validate: amountValidator
+		};
+	}
 	const JournalItemSchema = new mongoose.Schema({
 		account: {
 			type: mongoose.Schema.Types.ObjectId,
@@ -125,6 +168,7 @@ function createJournalEntrySchema(config, accountModelName, options = {}) {
 			type: [TaxDetailSchema],
 			default: []
 		},
+		...currencyItemFields,
 		...extraItemFields
 	}, { _id: false });
 	const fields = {
@@ -230,22 +274,21 @@ function createJournalEntrySchema(config, accountModelName, options = {}) {
 	};
 	const schema = new mongoose.Schema(fields, { timestamps: true });
 	schema.pre("validate", function() {
-		const doc = this;
-		for (const item of doc.journalItems) if (!item.date) item.date = doc.date;
-		for (let i = 0; i < doc.journalItems.length; i++) {
-			const d = doc.journalItems[i].debit || 0;
-			const c = doc.journalItems[i].credit || 0;
+		for (const item of this.journalItems) if (!item.date) item.date = this.date;
+		for (let i = 0; i < this.journalItems.length; i++) {
+			const d = this.journalItems[i].debit ?? 0;
+			const c = this.journalItems[i].credit ?? 0;
 			if (d > 0 && c > 0) throw new Error(`Journal item at index ${i}: cannot have both debit (${d}) and credit (${c}) greater than zero`);
-			if (doc.state === "posted" && d === 0 && c === 0) throw new Error(`Journal item at index ${i}: posted entries cannot have zero-value lines (both debit and credit are 0)`);
+			if (this.state === "posted" && d === 0 && c === 0) throw new Error(`Journal item at index ${i}: posted entries cannot have zero-value lines (both debit and credit are 0)`);
 		}
-		const totalDebit = doc.journalItems.reduce((s, i) => s + (i.debit || 0), 0);
-		const totalCredit = doc.journalItems.reduce((s, i) => s + (i.credit || 0), 0);
-		if (doc.state === "posted") {
-			if (doc.journalItems.length < 2) throw new Error("Posted entries must have at least 2 journal items");
+		const totalDebit = this.journalItems.reduce((s, item) => s + (item.debit ?? 0), 0);
+		const totalCredit = this.journalItems.reduce((s, item) => s + (item.credit ?? 0), 0);
+		if (this.state === "posted") {
+			if (this.journalItems.length < 2) throw new Error("Posted entries must have at least 2 journal items");
 			if (totalDebit !== totalCredit) throw new Error("Total debit must equal total credit for posted entries");
 		}
-		doc.totalDebit = totalDebit;
-		doc.totalCredit = totalCredit;
+		this.totalDebit = totalDebit;
+		this.totalCredit = totalCredit;
 	});
 	if (autoReference) {
 		const generateReferenceNumber = async (doc, Model, session) => {
@@ -267,12 +310,11 @@ function createJournalEntrySchema(config, accountModelName, options = {}) {
 			return `${prefix}${String(seq).padStart(4, "0")}`;
 		};
 		schema.pre("save", async function() {
-			const doc = this;
-			if (doc.isModified("journalType")) doc.referenceNumber = void 0;
-			if (!doc.referenceNumber) {
-				const session = doc.$session?.() ?? null;
-				const Model = doc.constructor;
-				doc.referenceNumber = await generateReferenceNumber(doc, Model, session);
+			if (this.isModified("journalType")) this.referenceNumber = void 0;
+			if (!this.referenceNumber) {
+				const session = this.$session?.() ?? null;
+				const Model = this.constructor;
+				this.referenceNumber = await generateReferenceNumber(this, Model, session);
 			}
 		});
 		const MAX_REF_RETRIES = 3;
@@ -378,7 +420,6 @@ function createJournalEntrySchema(config, accountModelName, options = {}) {
 	for (const idx of extraIndexes) schema.index(idx.fields, idx.options);
 	return schema;
 }
-
 //#endregion
 //#region src/schemas/fiscal-period.schema.ts
 /**
@@ -471,7 +512,154 @@ function createFiscalPeriodSchema(config, options = {}) {
 	});
 	return schema;
 }
-
 //#endregion
-export { createJournalEntrySchema as n, createAccountSchema as r, createFiscalPeriodSchema as t };
-//# sourceMappingURL=fiscal-period.schema-CbALaaKl.mjs.map
+//#region src/schemas/budget.schema.ts
+/**
+* Budget Schema Factory
+*
+* Creates a Mongoose schema for budget records.
+* Each record represents a budgeted amount for an account over a specific period.
+* All monetary amounts are in integer cents.
+*/
+function createBudgetSchema(config, options = {}) {
+	const { multiTenant } = config;
+	const { indexes = true, extraFields = {}, extraIndexes = [] } = options;
+	const fields = {
+		account: {
+			type: mongoose.Schema.Types.ObjectId,
+			ref: "Account",
+			required: true
+		},
+		periodStart: {
+			type: Date,
+			required: true
+		},
+		periodEnd: {
+			type: Date,
+			required: true
+		},
+		amount: {
+			type: Number,
+			required: true,
+			validate: {
+				validator: (v) => Number.isInteger(v),
+				message: "amount must be an integer (cents)."
+			}
+		},
+		label: {
+			type: String,
+			default: null
+		},
+		...extraFields
+	};
+	if (multiTenant) fields[multiTenant.orgField] = {
+		type: mongoose.Schema.Types.ObjectId,
+		ref: multiTenant.orgRef,
+		required: true
+	};
+	const schema = new mongoose.Schema(fields, { timestamps: true });
+	schema.pre("validate", function() {
+		const doc = this;
+		if (doc.periodStart && doc.periodEnd && doc.periodEnd <= doc.periodStart) doc.invalidate("periodEnd", "periodEnd must be after periodStart.", doc.periodEnd, "periodEnd");
+	});
+	if (indexes) if (multiTenant) {
+		const org = multiTenant.orgField;
+		schema.index({
+			[org]: 1,
+			account: 1,
+			periodStart: 1,
+			periodEnd: 1
+		}, { unique: true });
+		schema.index({
+			[org]: 1,
+			periodStart: 1,
+			periodEnd: 1
+		});
+	} else {
+		schema.index({
+			account: 1,
+			periodStart: 1,
+			periodEnd: 1
+		}, { unique: true });
+		schema.index({
+			periodStart: 1,
+			periodEnd: 1
+		});
+	}
+	for (const idx of extraIndexes) schema.index(idx.fields, idx.options);
+	return schema;
+}
+//#endregion
+//#region src/schemas/reconciliation.schema.ts
+/**
+* Reconciliation Schema Factory
+*
+* Creates a Mongoose schema for reconciliation records that link matched
+* debit/credit journal items. Used to track which journal entries have been
+* reconciled against each other for a given account.
+*/
+function createReconciliationSchema(config, accountModelName, journalEntryModelName, options = {}) {
+	const { multiTenant } = config;
+	const { indexes = true, extraFields = {}, extraIndexes = [] } = options;
+	const fields = {
+		account: {
+			type: mongoose.Schema.Types.ObjectId,
+			ref: accountModelName,
+			required: true
+		},
+		journalEntryIds: {
+			type: [{
+				type: mongoose.Schema.Types.ObjectId,
+				ref: journalEntryModelName
+			}],
+			required: true,
+			validate: {
+				validator: (v) => Array.isArray(v) && v.length > 0,
+				message: "journalEntryIds must contain at least one entry."
+			}
+		},
+		debitTotal: {
+			type: Number,
+			required: true
+		},
+		creditTotal: {
+			type: Number,
+			required: true
+		},
+		difference: {
+			type: Number,
+			default: 0
+		},
+		note: { type: String },
+		reconciledBy: { type: String },
+		reconciledAt: {
+			type: Date,
+			default: Date.now
+		},
+		...extraFields
+	};
+	if (multiTenant) fields[multiTenant.orgField] = {
+		type: mongoose.Schema.Types.ObjectId,
+		ref: multiTenant.orgRef,
+		required: true
+	};
+	const schema = new mongoose.Schema(fields, { timestamps: true });
+	if (indexes) {
+		if (multiTenant) {
+			const org = multiTenant.orgField;
+			schema.index({
+				[org]: 1,
+				account: 1,
+				reconciledAt: 1
+			});
+		} else schema.index({
+			account: 1,
+			reconciledAt: 1
+		});
+		schema.index({ journalEntryIds: 1 });
+	}
+	for (const idx of extraIndexes) schema.index(idx.fields, idx.options);
+	return schema;
+}
+//#endregion
+export { createAccountSchema as a, createJournalEntrySchema as i, createBudgetSchema as n, createFiscalPeriodSchema as r, createReconciliationSchema as t };

package/dist/reports/index.d.mts

@@ -1,2 +1,2 @@
-import { a as reopenFiscalPeriod, c as GeneralLedgerOptions, d as generateIncomeStatement, f as BalanceSheetOptions, h as generateTrialBalance, i as closeFiscalPeriod, l as generateGeneralLedger, m as TrialBalanceOptions, n as FiscalCloseResult, o as CashFlowOptions, p as generateBalanceSheet, r as FiscalReopenResult, s as generateCashFlow, t as FiscalCloseOptions, u as IncomeStatementOptions } from "../fiscal-close-CzUzpnMg.mjs";
-export { type BalanceSheetOptions, type CashFlowOptions, type FiscalCloseOptions, type FiscalCloseResult, type FiscalReopenResult, type GeneralLedgerOptions, type IncomeStatementOptions, type TrialBalanceOptions, closeFiscalPeriod, generateBalanceSheet, generateCashFlow, generateGeneralLedger, generateIncomeStatement, generateTrialBalance, reopenFiscalPeriod };
+import { $ as BudgetVsActualReport, A as generateGeneralLedger, C as FiscalCloseResult, D as CashFlowOptions, E as reopenFiscalPeriod, F as TrialBalanceOptions, I as generateTrialBalance, M as generateIncomeStatement, N as BalanceSheetOptions, O as generateCashFlow, P as generateBalanceSheet, Q as BudgetVsActualParams, S as FiscalCloseOptions, T as closeFiscalPeriod, Z as BudgetVsActualOptions, _ as DimensionBreakdownOptions, b as DimensionBreakdownRow, d as AgedBalanceParams, et as BudgetVsActualRow, f as AgedBalanceReport, g as generateAgedBalance, h as DEFAULT_BUCKETS, i as generateRevaluation, j as IncomeStatementOptions, k as GeneralLedgerOptions, m as AgedBucketConfig, n as RevaluationParams, p as AgedBalanceRow, r as RevaluationReport, t as RevaluationOptions, tt as generateBudgetVsActual, u as AgedBalanceOptions, v as DimensionBreakdownParams, w as FiscalReopenResult, x as generateDimensionBreakdown, y as DimensionBreakdownReport } from "../revaluation-D9x0NE8w.mjs";
+export { type AgedBalanceOptions, type AgedBalanceParams, type AgedBalanceReport, type AgedBalanceRow, type AgedBucketConfig, type BalanceSheetOptions, type BudgetVsActualOptions, type BudgetVsActualParams, type BudgetVsActualReport, type BudgetVsActualRow, type CashFlowOptions, DEFAULT_BUCKETS, type DimensionBreakdownOptions, type DimensionBreakdownParams, type DimensionBreakdownReport, type DimensionBreakdownRow, type FiscalCloseOptions, type FiscalCloseResult, type FiscalReopenResult, type GeneralLedgerOptions, type IncomeStatementOptions, type RevaluationOptions, type RevaluationParams, type RevaluationReport, type TrialBalanceOptions, closeFiscalPeriod, generateAgedBalance, generateBalanceSheet, generateBudgetVsActual, generateCashFlow, generateDimensionBreakdown, generateGeneralLedger, generateIncomeStatement, generateRevaluation, generateTrialBalance, reopenFiscalPeriod };

package/dist/reports/index.mjs

@@ -1,3 +1,2 @@
-import { a as generateIncomeStatement, d as generateTrialBalance, i as generateGeneralLedger, n as reopenFiscalPeriod, o as generateBalanceSheet, r as generateCashFlow, t as closeFiscalPeriod } from "../fiscal-close-DuXDgVvb.mjs";
-
-export { closeFiscalPeriod, generateBalanceSheet, generateCashFlow, generateGeneralLedger, generateIncomeStatement, generateTrialBalance, reopenFiscalPeriod };
+import { d as DEFAULT_BUCKETS, f as generateAgedBalance, g as generateBalanceSheet, h as generateIncomeStatement, l as generateBudgetVsActual, m as generateGeneralLedger, n as reopenFiscalPeriod, o as generateRevaluation, p as generateCashFlow, t as closeFiscalPeriod, u as generateDimensionBreakdown, x as generateTrialBalance } from "../fiscal-close-B6LhQ10f.mjs";
+export { DEFAULT_BUCKETS, closeFiscalPeriod, generateAgedBalance, generateBalanceSheet, generateBudgetVsActual, generateCashFlow, generateDimensionBreakdown, generateGeneralLedger, generateIncomeStatement, generateRevaluation, generateTrialBalance, reopenFiscalPeriod };

package/dist/repositories/index.d.mts

@@ -1,2 +1,2 @@
-import { n as wireJournalEntryMethods, t as wireAccountMethods } from "../account.repository-1C2sZvB2.mjs";
-export { wireAccountMethods, wireJournalEntryMethods };
+import { n as wireAccountMethods, r as wireJournalEntryMethods, t as wireReconciliationMethods } from "../reconciliation.repository-CW4-8q90.mjs";
+export { wireAccountMethods, wireJournalEntryMethods, wireReconciliationMethods };

package/dist/repositories/index.mjs

@@ -1,3 +1,2 @@
-import { n as wireJournalEntryMethods, t as wireAccountMethods } from "../account.repository-Crf5DGO4.mjs";
-
-export { wireAccountMethods, wireJournalEntryMethods };
+import { n as wireJournalEntryMethods, r as wireReconciliationMethods, t as wireAccountMethods } from "../account.repository-BpkSd6q3.mjs";
+export { wireAccountMethods, wireJournalEntryMethods, wireReconciliationMethods };