@classytic/ledger 0.5.0 → 0.5.1

package/README.md

@@ -2,6 +2,8 @@
 
 Embeddable double-entry accounting engine for MongoDB. Integer-cents arithmetic, plugin-based, country-agnostic, multi-tenant at every layer. Framework-agnostic — works with Express, Fastify, Nest, Arc, or any plain Mongoose app.
 
+> **0.5.1** — Critical plugin-pipeline fixes. `post()`, `unpost()`, `archive()`, and the `reverse()` mark-as-reversed step now route through `repository.update()` so `before:update` / `after:update` hooks fire on every state transition (period locks, audit, observability are no longer silently bypassed). `reverse()` and `duplicate()` propagate every consumer-defined top-level field (`departmentId`, `projectId`, `sourceRef`, `branchTag`, `organizationId`, …). New typed `_ledgerInternal` flag on `RepositoryContext` lets plugin authors observe internal transitions without casts. See [CHANGELOG.md](CHANGELOG.md).
+
 ## Install
 
 ```bash

package/dist/{date-lock.plugin-B2Jy0ukX.mjs → date-lock.plugin-B6WyvqNG.mjs}

@@ -100,7 +100,8 @@ function doubleEntryPlugin(options = {}) {
 			const validateUpdate = async (context) => {
 				const data = context.data;
 				if (!data) return;
-				if (JournalEntryModel) {
+				const internalOp = context._ledgerInternal;
+				if (JournalEntryModel && !internalOp) {
 					const id = context.id;
 					if (id) {
 						if ((await JournalEntryModel.findById(id).select("state").session(context.session ?? null).lean())?.state === "posted") {

package/dist/{idempotency.plugin-CK7LHnBn.d.mts → idempotency.plugin-WcQLZU9n.d.mts}

@@ -15,6 +15,44 @@ declare function dateLockPlugin(options: DateLockPluginOptions): {
   apply(repo: RepositoryInstance): void;
 };
 //#endregion
+//#region src/types/mongokit-augmentation.d.ts
+/**
+ * Module augmentation for `@classytic/mongokit`.
+ *
+ * Ledger's state-transition methods (post, unpost, archive, reverseMark) tag
+ * their `repository.update()` call with a `_ledgerInternal` flag so the
+ * double-entry immutability guard can distinguish legitimate transitions from
+ * arbitrary edits. This file types that flag onto both `RepositoryContext`
+ * (what plugins observe) and `SessionOptions` (what callers pass) so consumers
+ * and plugin authors get full IntelliSense without casts.
+ *
+ * This file is side-effect only — importing it anywhere in the package is
+ * enough to activate the augmentation. `src/types/index.ts` re-exports it.
+ */
+type LedgerInternalOp = 'post' | 'unpost' | 'archive' | 'reverseMark';
+declare module '@classytic/mongokit' {
+  interface RepositoryContext {
+    /**
+     * Set by ledger's repository methods (post, unpost, archive, reverseMark)
+     * to signal a legitimate internal state transition. Plugins observing
+     * `before:update` can read this to distinguish from arbitrary edits.
+     *
+     * External `repository.update()` callers cannot spoof this flag because
+     * it is only set by ledger's own repo methods, never surfaced in the
+     * public API.
+     */
+    _ledgerInternal?: LedgerInternalOp;
+  }
+  interface SessionOptions {
+    /**
+     * Ledger-internal flag — see `RepositoryContext._ledgerInternal`.
+     * Typed here so ledger's repo methods can pass it without casts.
+     * Consumers should never set this directly.
+     */
+    _ledgerInternal?: LedgerInternalOp;
+  }
+}
+//#endregion
 //#region src/plugins/double-entry.plugin.d.ts
 interface DoubleEntryPluginOptions {
   /** Only enforce on posted entries (default: true) */

package/dist/index.d.mts

@@ -4,7 +4,7 @@ import { a as TaxReportLine, i as TaxCodesByRegion, n as CountryPackInput, o as
 import { _ as PopulatedJournalEntry, a as exportToCsv, h as FlatJournalRow, i as quickbooksFieldMap, m as ExportFieldMap, p as ExportField, r as universalFieldMap, t as flattenJournalEntries } from "./index-D1ZjgVxn.mjs";
 import { Money, abs, add, allocate, equals, format, formatPlain, fromDecimal, isNegative, isPositive, isValid, isZero, max, min, multiply, negate, parseCents, percentage, round, splitTaxExclusive, splitTaxInclusive, subtract, toDecimal } from "./money.mjs";
 import { $ as AgedBucketConfig, A as BudgetVsActualReport, B as IncomeStatementReport, C as DimensionBreakdownReport, D as generateCashFlow, F as BalanceSheetReport, G as TaxReport, H as ReportAccount, I as CashFlowReport, J as TrialBalanceRow, K as TaxReturnSummary, L as CashFlowSection, M as generateBudgetVsActual, O as BudgetVsActualOptions, P as generateBalanceSheet, Q as AgedBalanceRow, R as GeneralLedgerAccount, S as DimensionBreakdownParams, T as generateDimensionBreakdown, U as ReportCategory, V as LedgerEntry, W as ReportGroup, X as AgedBalanceParams, Y as AgedBalanceOptions, Z as AgedBalanceReport, a as RevaluationReport, b as reopenFiscalPeriod, c as RevaluationRate, d as computeRevaluation, et as DEFAULT_BUCKETS, h as generateGeneralLedger, i as RevaluationParams, j as BudgetVsActualRow, k as BudgetVsActualParams, l as RevaluationResult, n as generateTrialBalance, nt as Logger, o as generateRevaluation, p as generateIncomeStatement, q as TrialBalanceReport, r as RevaluationOptions, rt as defaultLogger, s as AccountForeignBalance, tt as generateAgedBalance, u as buildRevaluationEntry, w as DimensionBreakdownRow, x as DimensionBreakdownOptions, y as closeFiscalPeriod, z as GeneralLedgerReport } from "./trial-balance-BZ7yOOFD.mjs";
-import { c as dateLockPlugin, i as fiscalLockPlugin, n as idempotencyPlugin, o as doubleEntryPlugin } from "./idempotency.plugin-CK7LHnBn.mjs";
+import { c as dateLockPlugin, i as fiscalLockPlugin, n as idempotencyPlugin, o as doubleEntryPlugin } from "./idempotency.plugin-WcQLZU9n.mjs";
 import { ClientSession, Connection, Model } from "mongoose";
 import { PaginationConfig, PluginType, Repository } from "@classytic/mongokit";
 

package/dist/index.mjs

@@ -3,7 +3,7 @@ import { Money, add, allocate, format, formatPlain, fromDecimal, multiply, parse
 import { n as Errors, t as AccountingError } from "./errors-BmRjW38t.mjs";
 import { C as DEFAULT_BUCKETS, S as isVirtualTaxAccount, T as requireOrgScope, _ as getDateRange, a as defaultLogger, b as calculateTotal, c as buildRevaluationEntry, d as generateGeneralLedger, f as generateDimensionBreakdown, g as buildItemFilters, h as generateBalanceSheet, i as finalizeSession, l as computeRevaluation, m as generateBudgetVsActual, n as reopenFiscalPeriod, o as generateTrialBalance, p as generateCashFlow, r as acquireSession, s as generateRevaluation, t as closeFiscalPeriod, u as generateIncomeStatement, v as getFiscalYearStart, w as generateAgedBalance, x as computeEndingBalance, y as buildAccountTypeMap } from "./fiscal-close-Dk3yRT9i.mjs";
 import { c as getNormalBalance, d as isValidCategory, l as isBalanceSheet, n as CATEGORY_KEYS, t as CATEGORIES, u as isIncomeStatement } from "./categories-BkKdv16V.mjs";
-import { i as doubleEntryPlugin, n as idempotencyPlugin, r as fiscalLockPlugin, t as dateLockPlugin } from "./date-lock.plugin-B2Jy0ukX.mjs";
+import { i as doubleEntryPlugin, n as idempotencyPlugin, r as fiscalLockPlugin, t as dateLockPlugin } from "./date-lock.plugin-B6WyvqNG.mjs";
 import { defineCountryPack } from "./country/index.mjs";
 import { a as exportToCsv, i as quickbooksFieldMap, r as universalFieldMap, t as flattenJournalEntries } from "./exports-BP-0Ni5W.mjs";
 import mongoose, { Schema } from "mongoose";
@@ -927,7 +927,43 @@ const ITEM_CORE_KEYS = new Set([
 function wireJournalEntryMethods(repository, _JournalEntryModel, orgField, strictness) {
 	const getByQuery = repository.getByQuery.bind(repository);
 	const create = repository.create.bind(repository);
+	const update = repository.update.bind(repository);
 	const withTransaction = repository.withTransaction.bind(repository);
+	const RESERVED_TOPLEVEL = new Set([
+		"_id",
+		"__v",
+		"id",
+		"journalType",
+		"state",
+		"date",
+		"label",
+		"journalItems",
+		"totalDebit",
+		"totalCredit",
+		"reversalOf",
+		"reversedBy",
+		"reversedByUser",
+		"reversed",
+		"stateChangedAt",
+		"createdAt",
+		"updatedAt",
+		"referenceNumber",
+		"idempotencyKey",
+		"postedBy",
+		"approvedBy",
+		"approvedAt"
+	]);
+	/** Copy non-reserved top-level fields from `source` onto `target`. */
+	function copyExtraTopLevel(source, target) {
+		const obj = typeof source.toObject === "function" ? source.toObject() : source;
+		for (const key of Object.keys(obj)) {
+			if (RESERVED_TOPLEVEL.has(key)) continue;
+			if (key in target) continue;
+			const value = obj[key];
+			if (value === void 0 || value === null) continue;
+			target[key] = value;
+		}
+	}
 	/** Build a tenant-scoped query for a single entry by ID (injection-safe) */
 	function buildQuery(id, orgId) {
 		validateScalarId(id, "entry ID");
@@ -993,11 +1029,16 @@ function wireJournalEntryMethods(repository, _JournalEntryModel, orgField, stric
 		const totalDebit = entry.journalItems.reduce((s, i) => s + (i.debit || 0), 0);
 		const totalCredit = entry.journalItems.reduce((s, i) => s + (i.credit || 0), 0);
 		if (totalDebit !== totalCredit) throw Errors.validation(`Entry is not balanced. Debit: ${totalDebit}, Credit: ${totalCredit}`);
-		entry.state = "posted";
-		entry.stateChangedAt = /* @__PURE__ */ new Date();
-		if (options.actorId) entry.postedBy = options.actorId;
-		await entry.save({ session: options.session });
-		return entry;
+		const patch = {
+			state: "posted",
+			stateChangedAt: /* @__PURE__ */ new Date()
+		};
+		if (options.actorId) patch.postedBy = options.actorId;
+		const updateOptions = {
+			_ledgerInternal: "post",
+			...options.session ? { session: options.session } : {}
+		};
+		return await update(entry._id, patch, updateOptions) ?? entry;
 	};
 	/**
 	* Unpost an entry (posted → draft).
@@ -1012,10 +1053,14 @@ function wireJournalEntryMethods(repository, _JournalEntryModel, orgField, stric
 		if (!entry) throw Errors.notFound("Entry not found");
 		if (entry.state !== "posted") throw Errors.validation("Only posted entries can be unposted");
 		if (entry.reversed) throw Errors.validation("Cannot unpost a reversed entry. The reversal entry is still posted and linked to this entry. Reverse the reversal entry first, or create a new correcting entry instead.");
-		entry.state = "draft";
-		entry.stateChangedAt = /* @__PURE__ */ new Date();
-		await entry.save({ session: options.session });
-		return entry;
+		const updateOptions = {
+			_ledgerInternal: "unpost",
+			...options.session ? { session: options.session } : {}
+		};
+		return await update(entry._id, {
+			state: "draft",
+			stateChangedAt: /* @__PURE__ */ new Date()
+		}, updateOptions) ?? entry;
 	};
 	/**
 	* Archive a draft entry (draft → archived).
@@ -1028,10 +1073,14 @@ function wireJournalEntryMethods(repository, _JournalEntryModel, orgField, stric
 		const entry = await findEntry(buildQuery(id, orgId), { session: options.session });
 		if (!entry) throw Errors.notFound("Entry not found");
 		if (entry.state !== "draft") throw Errors.validation("Only draft entries can be archived");
-		entry.state = "archived";
-		entry.stateChangedAt = /* @__PURE__ */ new Date();
-		await entry.save({ session: options.session });
-		return entry;
+		const updateOptions = {
+			_ledgerInternal: "archive",
+			...options.session ? { session: options.session } : {}
+		};
+		return await update(entry._id, {
+			state: "archived",
+			stateChangedAt: /* @__PURE__ */ new Date()
+		}, updateOptions) ?? entry;
 	};
 	/**
 	* Duplicate an entry as a new draft.
@@ -1061,7 +1110,7 @@ function wireJournalEntryMethods(repository, _JournalEntryModel, orgField, stric
 				};
 			})
 		};
-		if (orgField && entry[orgField] != null) duplicateData[orgField] = entry[orgField];
+		copyExtraTopLevel(entry, duplicateData);
 		return await create(duplicateData, options.session ? { session: options.session } : {});
 	};
 	/**
@@ -1113,15 +1162,20 @@ function wireJournalEntryMethods(repository, _JournalEntryModel, orgField, stric
 				reversalOf: entry._id,
 				stateChangedAt: /* @__PURE__ */ new Date()
 			};
-			if (orgField && entry[orgField] != null) reversalData[orgField] = entry[orgField];
+			copyExtraTopLevel(entry, reversalData);
 			if (options.actorId) reversalData.postedBy = options.actorId;
 			const reversalEntry = await create(reversalData, session ? { session } : {});
-			entry.reversed = true;
-			entry.reversedBy = reversalEntry._id;
-			if (options.actorId) entry.reversedByUser = options.actorId;
-			await entry.save({ session });
+			const markPatch = {
+				reversed: true,
+				reversedBy: reversalEntry._id
+			};
+			if (options.actorId) markPatch.reversedByUser = options.actorId;
+			const markOptions = {
+				_ledgerInternal: "reverseMark",
+				...session ? { session } : {}
+			};
 			return {
-				original: entry,
+				original: await update(entry._id, markPatch, markOptions) ?? entry,
 				reversal: reversalEntry
 			};
 		};

package/dist/plugins/index.d.mts

@@ -1,4 +1,4 @@
-import { a as DoubleEntryPluginOptions, c as dateLockPlugin, i as fiscalLockPlugin, n as idempotencyPlugin, o as doubleEntryPlugin, r as FiscalLockPluginOptions, s as DateLockPluginOptions, t as IdempotencyPluginOptions } from "../idempotency.plugin-CK7LHnBn.mjs";
+import { a as DoubleEntryPluginOptions, c as dateLockPlugin, i as fiscalLockPlugin, n as idempotencyPlugin, o as doubleEntryPlugin, r as FiscalLockPluginOptions, s as DateLockPluginOptions, t as IdempotencyPluginOptions } from "../idempotency.plugin-WcQLZU9n.mjs";
 import { RepositoryInstance } from "@classytic/mongokit";
 
 //#region src/utils/tax-hooks.d.ts

package/dist/plugins/index.mjs

@@ -1,4 +1,4 @@
-import { i as doubleEntryPlugin, n as idempotencyPlugin, r as fiscalLockPlugin, t as dateLockPlugin } from "../date-lock.plugin-B2Jy0ukX.mjs";
+import { i as doubleEntryPlugin, n as idempotencyPlugin, r as fiscalLockPlugin, t as dateLockPlugin } from "../date-lock.plugin-B6WyvqNG.mjs";
 //#region src/utils/tax-hooks.ts
 /**
 * Apply a tax hook to journal items.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@classytic/ledger",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "Production-grade double-entry accounting engine for MongoDB — schemas, reports, tax, multi-tenant",
   "type": "module",
   "sideEffects": false,