@classytic/ledger 0.2.0 → 0.4.0

package/dist/{fiscal-period.schema-BQ5wsAq3.mjs → reconciliation.schema-KScbsXbY.mjs}

@@ -1,4 +1,4 @@
-import { i as getJournalTypeCodes, t as JOURNAL_CODES } from "./journals-oH-FK3g8.mjs";
+import { o as getJournalTypeCodes, r as _freezeJournalTypes, t as JOURNAL_CODES } from "./journals-BcMn71Cq.mjs";
 import mongoose from "mongoose";
 //#region src/schemas/currency-field.ts
 /**
@@ -70,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;
@@ -97,6 +96,175 @@ function createAccountSchema(config, options = {}) {
 	return schema;
 }
 //#endregion
+//#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/fiscal-period.schema.ts
+/**
+* Fiscal Period Schema Factory
+*
+* Creates a Mongoose schema for tracking fiscal periods (months, quarters, years).
+* Supports closing periods to lock entries.
+*/
+function createFiscalPeriodSchema(config, options = {}) {
+	const { multiTenant } = config;
+	const { indexes = true, extraFields = {}, extraIndexes = [] } = options;
+	const fields = {
+		name: {
+			type: String,
+			required: true
+		},
+		startDate: {
+			type: Date,
+			required: true
+		},
+		endDate: {
+			type: Date,
+			required: true
+		},
+		closed: {
+			type: Boolean,
+			default: false
+		},
+		closedAt: {
+			type: Date,
+			default: null
+		},
+		closedBy: {
+			type: String,
+			default: null
+		},
+		closingEntryId: {
+			type: mongoose.Schema.Types.ObjectId,
+			default: null
+		},
+		reopenedAt: {
+			type: Date,
+			default: null
+		},
+		reopenedBy: {
+			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 });
+	if (indexes) if (multiTenant) {
+		const org = multiTenant.orgField;
+		schema.index({
+			[org]: 1,
+			startDate: 1,
+			endDate: 1
+		}, { unique: true });
+		schema.index({
+			[org]: 1,
+			closed: 1
+		});
+	} else {
+		schema.index({
+			startDate: 1,
+			endDate: 1
+		}, { unique: true });
+		schema.index({ closed: 1 });
+	}
+	for (const idx of extraIndexes) schema.index(idx.fields, idx.options);
+	schema.pre("validate", async function() {
+		const doc = this;
+		if (!doc.startDate || !doc.endDate) return;
+		const overlapQuery = {
+			_id: { $ne: doc._id },
+			startDate: { $lt: doc.endDate },
+			endDate: { $gt: doc.startDate }
+		};
+		if (multiTenant) overlapQuery[multiTenant.orgField] = doc[multiTenant.orgField];
+		const overlap = await doc.collection.findOne(overlapQuery);
+		if (overlap) {
+			const msg = `Fiscal period overlaps with existing period "${overlap.name}" (${new Date(overlap.startDate).toISOString().split("T")[0]} – ${new Date(overlap.endDate).toISOString().split("T")[0]}).`;
+			doc.invalidate("startDate", msg, doc.startDate, "overlap");
+		}
+	});
+	return schema;
+}
+//#endregion
 //#region src/schemas/journal-entry.schema.ts
 /**
 * Journal Entry Schema Factory
@@ -172,11 +340,12 @@ function createJournalEntrySchema(config, accountModelName, options = {}) {
 		...currencyItemFields,
 		...extraItemFields
 	}, { _id: false });
+	_freezeJournalTypes();
 	const fields = {
 		journalType: {
 			type: String,
 			enum: getJournalTypeCodes(),
-			default: JOURNAL_CODES["MISC"],
+			default: JOURNAL_CODES.MISC,
 			required: true
 		},
 		referenceNumber: { type: String },
@@ -275,22 +444,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) => {
@@ -312,16 +480,15 @@ 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;
-		schema.post("save", async function(error, doc, next) {
+		schema.post("save", async (error, doc, next) => {
 			const mongoError = error;
 			if (mongoError.code === 11e3 && mongoError.keyPattern?.referenceNumber) {
 				const entry = doc;
@@ -424,52 +591,51 @@ function createJournalEntrySchema(config, accountModelName, options = {}) {
 	return schema;
 }
 //#endregion
-//#region src/schemas/fiscal-period.schema.ts
+//#region src/schemas/reconciliation.schema.ts
 /**
-* Fiscal Period Schema Factory
+* Reconciliation Schema Factory
 *
-* Creates a Mongoose schema for tracking fiscal periods (months, quarters, years).
-* Supports closing periods to lock entries.
+* 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 createFiscalPeriodSchema(config, options = {}) {
+function createReconciliationSchema(config, accountModelName, journalEntryModelName, options = {}) {
 	const { multiTenant } = config;
 	const { indexes = true, extraFields = {}, extraIndexes = [] } = options;
 	const fields = {
-		name: {
-			type: String,
+		account: {
+			type: mongoose.Schema.Types.ObjectId,
+			ref: accountModelName,
 			required: true
 		},
-		startDate: {
-			type: Date,
-			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."
+			}
 		},
-		endDate: {
-			type: Date,
+		debitTotal: {
+			type: Number,
 			required: true
 		},
-		closed: {
-			type: Boolean,
-			default: false
-		},
-		closedAt: {
-			type: Date,
-			default: null
-		},
-		closedBy: {
-			type: String,
-			default: null
+		creditTotal: {
+			type: Number,
+			required: true
 		},
-		closingEntryId: {
-			type: mongoose.Schema.Types.ObjectId,
-			default: null
+		difference: {
+			type: Number,
+			default: 0
 		},
-		reopenedAt: {
+		note: { type: String },
+		reconciledBy: { type: String },
+		reconciledAt: {
 			type: Date,
-			default: null
-		},
-		reopenedBy: {
-			type: String,
-			default: null
+			default: Date.now
 		},
 		...extraFields
 	};
@@ -479,43 +645,22 @@ function createFiscalPeriodSchema(config, options = {}) {
 		required: true
 	};
 	const schema = new mongoose.Schema(fields, { timestamps: true });
-	if (indexes) if (multiTenant) {
-		const org = multiTenant.orgField;
-		schema.index({
-			[org]: 1,
-			startDate: 1,
-			endDate: 1
-		}, { unique: true });
-		schema.index({
-			[org]: 1,
-			closed: 1
+	if (indexes) {
+		if (multiTenant) {
+			const org = multiTenant.orgField;
+			schema.index({
+				[org]: 1,
+				account: 1,
+				reconciledAt: 1
+			});
+		} else schema.index({
+			account: 1,
+			reconciledAt: 1
 		});
-	} else {
-		schema.index({
-			startDate: 1,
-			endDate: 1
-		}, { unique: true });
-		schema.index({ closed: 1 });
+		schema.index({ journalEntryIds: 1 });
 	}
 	for (const idx of extraIndexes) schema.index(idx.fields, idx.options);
-	schema.pre("validate", async function() {
-		const doc = this;
-		if (!doc.startDate || !doc.endDate) return;
-		const overlapQuery = {
-			_id: { $ne: doc._id },
-			startDate: { $lt: doc.endDate },
-			endDate: { $gt: doc.startDate }
-		};
-		if (multiTenant) overlapQuery[multiTenant.orgField] = doc[multiTenant.orgField];
-		const overlap = await doc.collection.findOne(overlapQuery);
-		if (overlap) {
-			const msg = `Fiscal period overlaps with existing period "${overlap.name}" (${new Date(overlap.startDate).toISOString().split("T")[0]} – ${new Date(overlap.endDate).toISOString().split("T")[0]}).`;
-			doc.invalidate("startDate", msg, doc.startDate, "overlap");
-		}
-	});
 	return schema;
 }
 //#endregion
-export { createJournalEntrySchema as n, createAccountSchema as r, createFiscalPeriodSchema as t };
-
-//# sourceMappingURL=fiscal-period.schema-BQ5wsAq3.mjs.map
+export { createAccountSchema as a, createBudgetSchema as i, createJournalEntrySchema 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-dNlzB37y.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 AgedBucketConfig, A as BudgetVsActualReport, C as DimensionBreakdownReport, D as generateCashFlow, E as CashFlowOptions, M as generateBudgetVsActual, N as BalanceSheetOptions, O as BudgetVsActualOptions, P as generateBalanceSheet, Q as AgedBalanceRow, S as DimensionBreakdownParams, T as generateDimensionBreakdown, X as AgedBalanceParams, Y as AgedBalanceOptions, Z as AgedBalanceReport, _ as FiscalCloseResult, a as RevaluationReport, b as reopenFiscalPeriod, et as DEFAULT_BUCKETS, f as IncomeStatementOptions, g as FiscalCloseOptions, h as generateGeneralLedger, i as RevaluationParams, j as BudgetVsActualRow, k as BudgetVsActualParams, m as GeneralLedgerOptions, n as generateTrialBalance, o as generateRevaluation, p as generateIncomeStatement, r as RevaluationOptions, t as TrialBalanceOptions, tt as generateAgedBalance, v as FiscalReopenResult, w as DimensionBreakdownRow, x as DimensionBreakdownOptions, y as closeFiscalPeriod } from "../trial-balance-DcQ0xj_4.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,2 +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-L631E3De.mjs";
-export { closeFiscalPeriod, generateBalanceSheet, generateCashFlow, generateGeneralLedger, generateIncomeStatement, generateTrialBalance, reopenFiscalPeriod };
+import { C as DEFAULT_BUCKETS, d as generateGeneralLedger, f as generateDimensionBreakdown, h as generateBalanceSheet, m as generateBudgetVsActual, n as reopenFiscalPeriod, o as generateTrialBalance, p as generateCashFlow, s as generateRevaluation, t as closeFiscalPeriod, u as generateIncomeStatement, w as generateAgedBalance } from "../fiscal-close-DmPV82e4.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-C7gwFLfM.mjs";
-export { wireAccountMethods, wireJournalEntryMethods };
+import { n as wireJournalEntryMethods, r as wireAccountMethods, t as wireReconciliationMethods } from "../reconciliation.repository-DEybU_Ok.mjs";
+export { wireAccountMethods, wireJournalEntryMethods, wireReconciliationMethods };

package/dist/repositories/index.mjs

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

package/dist/schemas/index.d.mts

@@ -1,2 +1,71 @@
-import { n as createJournalEntrySchema, r as createAccountSchema, t as createFiscalPeriodSchema } from "../fiscal-period.schema-BRdKAjrr.mjs";
-export { createAccountSchema, createFiscalPeriodSchema, createJournalEntrySchema };
+import { o as SchemaOptions, t as AccountingEngineConfig } from "../engine-DF-MtsEr.mjs";
+import { n as createFiscalPeriodSchema, r as createAccountSchema, t as createJournalEntrySchema } from "../journal-entry.schema-B1CzLwC3.mjs";
+import mongoose from "mongoose";
+
+//#region src/schemas/budget.schema.d.ts
+declare function createBudgetSchema(config: AccountingEngineConfig, options?: SchemaOptions): mongoose.Schema<any, mongoose.Model<any, any, any, any, any, any, any>, {}, {}, {}, {}, {
+  timestamps: true;
+}, {
+  [x: number]: any;
+  [x: string]: any;
+} & mongoose.DefaultTimestampProps, mongoose.Document<unknown, {}, {
+  [x: number]: any;
+  [x: string]: any;
+} & mongoose.DefaultTimestampProps, {
+  id: string;
+}, Omit<mongoose.DefaultSchemaOptions, "timestamps"> & {
+  timestamps: true;
+}> & Omit<{
+  [x: number]: any;
+  [x: string]: any;
+} & mongoose.DefaultTimestampProps & {
+  _id: mongoose.Types.ObjectId;
+} & {
+  __v: number;
+}, "id"> & {
+  id: string;
+}, unknown, {
+  [x: number]: any;
+  [x: string]: any;
+  createdAt: NativeDate;
+  updatedAt: NativeDate;
+} & {
+  _id: mongoose.Types.ObjectId;
+} & {
+  __v: number;
+}>;
+//#endregion
+//#region src/schemas/reconciliation.schema.d.ts
+declare function createReconciliationSchema(config: AccountingEngineConfig, accountModelName: string, journalEntryModelName: string, options?: SchemaOptions): mongoose.Schema<any, mongoose.Model<any, any, any, any, any, any, any>, {}, {}, {}, {}, {
+  timestamps: true;
+}, {
+  [x: number]: any;
+  [x: string]: any;
+} & mongoose.DefaultTimestampProps, mongoose.Document<unknown, {}, {
+  [x: number]: any;
+  [x: string]: any;
+} & mongoose.DefaultTimestampProps, {
+  id: string;
+}, Omit<mongoose.DefaultSchemaOptions, "timestamps"> & {
+  timestamps: true;
+}> & Omit<{
+  [x: number]: any;
+  [x: string]: any;
+} & mongoose.DefaultTimestampProps & {
+  _id: mongoose.Types.ObjectId;
+} & {
+  __v: number;
+}, "id"> & {
+  id: string;
+}, unknown, {
+  [x: number]: any;
+  [x: string]: any;
+  createdAt: NativeDate;
+  updatedAt: NativeDate;
+} & {
+  _id: mongoose.Types.ObjectId;
+} & {
+  __v: number;
+}>;
+//#endregion
+export { createAccountSchema, createBudgetSchema, createFiscalPeriodSchema, createJournalEntrySchema, createReconciliationSchema };

package/dist/schemas/index.mjs

@@ -1,2 +1,2 @@
-import { n as createJournalEntrySchema, r as createAccountSchema, t as createFiscalPeriodSchema } from "../fiscal-period.schema-BQ5wsAq3.mjs";
-export { createAccountSchema, createFiscalPeriodSchema, createJournalEntrySchema };
+import { a as createAccountSchema, i as createBudgetSchema, n as createJournalEntrySchema, r as createFiscalPeriodSchema, t as createReconciliationSchema } from "../reconciliation.schema-KScbsXbY.mjs";
+export { createAccountSchema, createBudgetSchema, createFiscalPeriodSchema, createJournalEntrySchema, createReconciliationSchema };

package/dist/tenant-guard-CAxXoWuS.mjs

@@ -0,0 +1,13 @@
+import { n as Errors } from "./errors-BoGUSUYL.mjs";
+//#region src/utils/tenant-guard.ts
+/**
+* Multi-tenant scope guard.
+*
+* Throws when orgField is configured (multi-tenant mode active) but
+* organizationId is missing — preventing unscoped cross-tenant queries.
+*/
+function requireOrgScope(orgField, organizationId) {
+	if (orgField && !organizationId) throw Errors.validation("organizationId is required when multi-tenant mode is configured (orgField: \"" + orgField + "\"). Refusing to run unscoped query.");
+}
+//#endregion
+export { requireOrgScope as t };