@classytic/mongokit 3.6.0 → 3.6.2

package/README.md

@@ -220,7 +220,7 @@ mongokit's job stops at "the hook has `context.session`." Everything else is com
 |---|---|
 | `methodRegistryPlugin` | Prerequisite for plugins that attach new methods |
 | `batchOperationsPlugin` | `updateMany`, `deleteMany`, `bulkWrite` with hook support |
-| `multiTenantPlugin` | Inject tenant scope at POLICY priority — impossible to forget |
+| `multiTenantPlugin` | Inject tenant scope at POLICY priority — supports `fieldType: 'objectId'` for `$lookup`/`.populate()` |
 | `softDeletePlugin` | `deletedAt` / custom field, `restore`, `getDeleted`, TTL, `before:restore` / `after:restore` hooks |
 | `cascadePlugin` | Cascade delete; prefer `{ repo: targetRepo, foreignKey, softDelete? }` to route through the target's hook pipeline |
 | `customIdPlugin` | Stripe-style prefixed public IDs (`txn_a7b3xk9m`) on top of `_id` |

package/dist/index.d.mts

@@ -1,7 +1,7 @@
 import { $ as ReadPreferenceType, A as InferDocument, At as LookupOptions, B as NonNullableFields, C as EventPayload, Ct as WithPlugins, D as GroupResult, Dt as IRequestContext, E as FieldRules, Et as IControllerResponse, F as KeysetPaginationResult, G as PaginationConfig, H as OffsetPaginationOptions, I as Logger, J as Plugin, K as PaginationResult, L as LookupPopulateOptions, M as JsonSchema, N as KeysOfType, O as HookMode, Ot as IResponseFormatter, P as KeysetPaginationOptions, Q as ReadOptions, R as LookupPopulateResult, S as EventHandlers, St as ValidatorDefinition, T as FieldPreset, Tt as IController, U as OffsetPaginationResult, V as ObjectId, W as OperationOptions, X as PluginType, Y as PluginFunction, Z as PopulateSpec, _ as CrudSchemas, _t as UpdateOptions, a as AnyDocument, at as RequiredBy, b as DeleteResult, bt as ValidationChainOptions, c as CacheOperationOptions, ct as SessionOptions, d as CacheableOptions, dt as SoftDeleteRepository, et as RepositoryContext, f as CascadeOptions, ft as SortDirection, g as CreateOptions, gt as UpdateManyResult, h as CreateInput, ht as UpdateInput, i as AllPluginMethods, it as RepositoryOptions, j as InferRawDoc, k as HttpError, kt as LookupBuilder, l as CacheOptions, lt as SoftDeleteFilterMode, m as CollationOptions, mt as Strict, n as AggregatePaginationOptions, nt as RepositoryInstance, o as AnyModel, ot as SchemaBuilderOptions, p as CascadeRelation, pt as SortSpec, q as PartialBy, r as AggregatePaginationResult, rt as RepositoryOperation, s as CacheAdapter, st as SelectSpec, t as AggregateOptions, tt as RepositoryEvent, u as CacheStats, ut as SoftDeleteOptions, v as DecodedCursor, vt as UpdateWithValidationResult, w as EventPhase, wt as WithTransactionOptions, x as DocField, xt as ValidationResult, y as DeepPartial, yt as UserContext, z as MinMaxResult } from "./types-DiQfDesD.mjs";
 import { t as index_d_exports } from "./index-BSRSsRRx.mjs";
 import { PaginationEngine } from "./pagination/PaginationEngine.mjs";
-import { A as dateSequentialId, B as AuditEntry, C as elasticSearchPlugin, D as PrefixedIdOptions, E as IdGenerator, F as CacheMethods, G as AuditTrailOptions, H as AuditQueryOptions, I as cachePlugin, J as auditLogPlugin, K as AuditTrailQuery, L as BatchOperationsMethods, M as prefixedId, N as sequentialId, O as SequentialIdOptions, P as cascadePlugin, R as BulkWriteResult, S as ElasticSearchOptions, T as DateSequentialIdOptions, U as AuditQueryResult, V as AuditOperation, W as AuditTrailMethods, X as aggregateHelpersPlugin, Y as AggregateHelpersMethods, _ as MongoOperationsMethods, a as uniqueField, b as methodRegistryPlugin, c as SubdocumentMethods, d as softDeletePlugin, f as ObservabilityOptions, g as multiTenantPlugin, h as MultiTenantOptions, i as requireField, j as getNextSequence, k as customIdPlugin, l as subdocumentPlugin, m as observabilityPlugin, n as blockIf, o as validationChainPlugin, p as OperationMetric, q as auditTrailPlugin, r as immutableField, s as timestampPlugin, t as autoInject, u as SoftDeleteMethods, v as mongoOperationsPlugin, w as CustomIdOptions, x as fieldFilterPlugin, z as batchOperationsPlugin } from "./validation-chain.plugin-COKNRAwp.mjs";
+import { A as dateSequentialId, B as AuditEntry, C as elasticSearchPlugin, D as PrefixedIdOptions, E as IdGenerator, F as CacheMethods, G as AuditTrailOptions, H as AuditQueryOptions, I as cachePlugin, J as auditLogPlugin, K as AuditTrailQuery, L as BatchOperationsMethods, M as prefixedId, N as sequentialId, O as SequentialIdOptions, P as cascadePlugin, R as BulkWriteResult, S as ElasticSearchOptions, T as DateSequentialIdOptions, U as AuditQueryResult, V as AuditOperation, W as AuditTrailMethods, X as aggregateHelpersPlugin, Y as AggregateHelpersMethods, _ as MongoOperationsMethods, a as uniqueField, b as methodRegistryPlugin, c as SubdocumentMethods, d as softDeletePlugin, f as ObservabilityOptions, g as multiTenantPlugin, h as MultiTenantOptions, i as requireField, j as getNextSequence, k as customIdPlugin, l as subdocumentPlugin, m as observabilityPlugin, n as blockIf, o as validationChainPlugin, p as OperationMetric, q as auditTrailPlugin, r as immutableField, s as timestampPlugin, t as autoInject, u as SoftDeleteMethods, v as mongoOperationsPlugin, w as CustomIdOptions, x as fieldFilterPlugin, z as batchOperationsPlugin } from "./validation-chain.plugin-BsFzKVnO.mjs";
 import { n as SchemaPathsLike, t as FieldType$1 } from "./coercion-B19MD38s.mjs";
 import { n as SchemaIndexes } from "./indexes-qIBCZ3mY.mjs";
 import { a as isFieldUpdateAllowed, c as configureLogger, d as getFieldsForUser, f as getMongooseProjection, i as getSystemManagedFields, l as createFieldPreset, m as parseDuplicateKeyError, n as buildCrudSchemasFromMongooseSchema, o as validateUpdateBody, p as createError, r as getImmutableFields, s as createMemoryCache, t as buildCrudSchemasFromModel, u as filterResponseData } from "./mongooseToJsonSchema-D2YjHo7W.mjs";

package/dist/index.mjs

@@ -2,7 +2,7 @@ import { a as warn, n as parseDuplicateKeyError, r as configureLogger, t as crea
 import { y as LookupBuilder } from "./update-AVfKWNGt.mjs";
 import { t as actions_exports } from "./actions/index.mjs";
 import { t as PaginationEngine } from "./PaginationEngine-CunXkR9p.mjs";
-import { A as auditTrailPlugin, C as HOOK_PRIORITY, D as AggregationBuilder, E as withTransaction, M as aggregateHelpersPlugin, O as batchOperationsPlugin, S as cachePlugin, T as isTransactionUnsupported, _ as dateSequentialId, a as uniqueField, b as sequentialId, c as subdocumentPlugin, d as multiTenantPlugin, f as mongoOperationsPlugin, g as customIdPlugin, h as elasticSearchPlugin, i as requireField, j as auditLogPlugin, k as AuditTrailQuery, l as softDeletePlugin, m as fieldFilterPlugin, n as blockIf, o as validationChainPlugin, p as methodRegistryPlugin, r as immutableField, s as timestampPlugin, t as autoInject, u as observabilityPlugin, v as getNextSequence, w as Repository, x as cascadePlugin, y as prefixedId } from "./validation-chain.plugin-3rr7dlw6.mjs";
+import { A as auditTrailPlugin, C as HOOK_PRIORITY, D as AggregationBuilder, E as withTransaction, M as aggregateHelpersPlugin, O as batchOperationsPlugin, S as cachePlugin, T as isTransactionUnsupported, _ as dateSequentialId, a as uniqueField, b as sequentialId, c as subdocumentPlugin, d as multiTenantPlugin, f as mongoOperationsPlugin, g as customIdPlugin, h as elasticSearchPlugin, i as requireField, j as auditLogPlugin, k as AuditTrailQuery, l as softDeletePlugin, m as fieldFilterPlugin, n as blockIf, o as validationChainPlugin, p as methodRegistryPlugin, r as immutableField, s as timestampPlugin, t as autoInject, u as observabilityPlugin, v as getNextSequence, w as Repository, x as cascadePlugin, y as prefixedId } from "./validation-chain.plugin-7A5qGEQq.mjs";
 import { isGeoOperator, parseGeoFilter } from "./query/primitives/geo.mjs";
 import { i as getMongooseProjection, n as filterResponseData, r as getFieldsForUser, t as createFieldPreset } from "./field-selection-C5o7jyyA.mjs";
 import { buildFieldTypeMap, coerceFieldValue, coerceHeuristic } from "./query/primitives/coercion.mjs";

package/dist/plugins/index.d.mts

@@ -1,2 +1,2 @@
-import { A as dateSequentialId, B as AuditEntry, C as elasticSearchPlugin, D as PrefixedIdOptions, E as IdGenerator, F as CacheMethods, G as AuditTrailOptions, H as AuditQueryOptions, I as cachePlugin, J as auditLogPlugin, K as AuditTrailQuery, L as BatchOperationsMethods, M as prefixedId, N as sequentialId, O as SequentialIdOptions, P as cascadePlugin, S as ElasticSearchOptions, T as DateSequentialIdOptions, U as AuditQueryResult, V as AuditOperation, W as AuditTrailMethods, X as aggregateHelpersPlugin, Y as AggregateHelpersMethods, _ as MongoOperationsMethods, a as uniqueField, b as methodRegistryPlugin, c as SubdocumentMethods, d as softDeletePlugin, f as ObservabilityOptions, g as multiTenantPlugin, h as MultiTenantOptions, i as requireField, j as getNextSequence, k as customIdPlugin, l as subdocumentPlugin, m as observabilityPlugin, n as blockIf, o as validationChainPlugin, p as OperationMetric, q as auditTrailPlugin, r as immutableField, s as timestampPlugin, t as autoInject, u as SoftDeleteMethods, v as mongoOperationsPlugin, w as CustomIdOptions, x as fieldFilterPlugin, y as MethodRegistryRepository, z as batchOperationsPlugin } from "../validation-chain.plugin-COKNRAwp.mjs";
+import { A as dateSequentialId, B as AuditEntry, C as elasticSearchPlugin, D as PrefixedIdOptions, E as IdGenerator, F as CacheMethods, G as AuditTrailOptions, H as AuditQueryOptions, I as cachePlugin, J as auditLogPlugin, K as AuditTrailQuery, L as BatchOperationsMethods, M as prefixedId, N as sequentialId, O as SequentialIdOptions, P as cascadePlugin, S as ElasticSearchOptions, T as DateSequentialIdOptions, U as AuditQueryResult, V as AuditOperation, W as AuditTrailMethods, X as aggregateHelpersPlugin, Y as AggregateHelpersMethods, _ as MongoOperationsMethods, a as uniqueField, b as methodRegistryPlugin, c as SubdocumentMethods, d as softDeletePlugin, f as ObservabilityOptions, g as multiTenantPlugin, h as MultiTenantOptions, i as requireField, j as getNextSequence, k as customIdPlugin, l as subdocumentPlugin, m as observabilityPlugin, n as blockIf, o as validationChainPlugin, p as OperationMetric, q as auditTrailPlugin, r as immutableField, s as timestampPlugin, t as autoInject, u as SoftDeleteMethods, v as mongoOperationsPlugin, w as CustomIdOptions, x as fieldFilterPlugin, y as MethodRegistryRepository, z as batchOperationsPlugin } from "../validation-chain.plugin-BsFzKVnO.mjs";
 export { type AggregateHelpersMethods, type AuditEntry, type AuditOperation, type AuditQueryOptions, type AuditQueryResult, type AuditTrailMethods, type AuditTrailOptions, AuditTrailQuery, type BatchOperationsMethods, type CacheMethods, type CustomIdOptions, type DateSequentialIdOptions, type ElasticSearchOptions, type IdGenerator, type MethodRegistryRepository, type MongoOperationsMethods, type MultiTenantOptions, type ObservabilityOptions, type OperationMetric, type PrefixedIdOptions, type SequentialIdOptions, type SoftDeleteMethods, type SubdocumentMethods, aggregateHelpersPlugin, auditLogPlugin, auditTrailPlugin, autoInject, batchOperationsPlugin, blockIf, cachePlugin, cascadePlugin, customIdPlugin, dateSequentialId, elasticSearchPlugin, fieldFilterPlugin, getNextSequence, immutableField, methodRegistryPlugin, mongoOperationsPlugin, multiTenantPlugin, observabilityPlugin, prefixedId, requireField, sequentialId, softDeletePlugin, subdocumentPlugin, timestampPlugin, uniqueField, validationChainPlugin };

package/dist/plugins/index.mjs

@@ -1,2 +1,2 @@
-import { A as auditTrailPlugin, M as aggregateHelpersPlugin, O as batchOperationsPlugin, S as cachePlugin, _ as dateSequentialId, a as uniqueField, b as sequentialId, c as subdocumentPlugin, d as multiTenantPlugin, f as mongoOperationsPlugin, g as customIdPlugin, h as elasticSearchPlugin, i as requireField, j as auditLogPlugin, k as AuditTrailQuery, l as softDeletePlugin, m as fieldFilterPlugin, n as blockIf, o as validationChainPlugin, p as methodRegistryPlugin, r as immutableField, s as timestampPlugin, t as autoInject, u as observabilityPlugin, v as getNextSequence, x as cascadePlugin, y as prefixedId } from "../validation-chain.plugin-3rr7dlw6.mjs";
+import { A as auditTrailPlugin, M as aggregateHelpersPlugin, O as batchOperationsPlugin, S as cachePlugin, _ as dateSequentialId, a as uniqueField, b as sequentialId, c as subdocumentPlugin, d as multiTenantPlugin, f as mongoOperationsPlugin, g as customIdPlugin, h as elasticSearchPlugin, i as requireField, j as auditLogPlugin, k as AuditTrailQuery, l as softDeletePlugin, m as fieldFilterPlugin, n as blockIf, o as validationChainPlugin, p as methodRegistryPlugin, r as immutableField, s as timestampPlugin, t as autoInject, u as observabilityPlugin, v as getNextSequence, x as cascadePlugin, y as prefixedId } from "../validation-chain.plugin-7A5qGEQq.mjs";
 export { AuditTrailQuery, aggregateHelpersPlugin, auditLogPlugin, auditTrailPlugin, autoInject, batchOperationsPlugin, blockIf, cachePlugin, cascadePlugin, customIdPlugin, dateSequentialId, elasticSearchPlugin, fieldFilterPlugin, getNextSequence, immutableField, methodRegistryPlugin, mongoOperationsPlugin, multiTenantPlugin, observabilityPlugin, prefixedId, requireField, sequentialId, softDeletePlugin, subdocumentPlugin, timestampPlugin, uniqueField, validationChainPlugin };

package/dist/{validation-chain.plugin-3rr7dlw6.mjs → validation-chain.plugin-7A5qGEQq.mjs}

@@ -3154,6 +3154,11 @@ function getCounterModel(connection) {
 *
 * @param counterKey - Unique key identifying this counter (e.g., "Invoice" or "Invoice:2026-02")
 * @param increment - Value to increment by (default: 1)
+* @param connection - Mongoose connection to use (defaults to the default connection)
+* @param session - Optional client session. When provided, the counter bump
+*   participates in the caller's transaction — if the surrounding transaction
+*   aborts, the counter does NOT advance. Without a session, the bump commits
+*   immediately and is not rolled back if a sibling write fails.
 * @returns The next sequence number (after increment)
 *
 * @example
@@ -3163,11 +3168,19 @@ function getCounterModel(connection) {
 * @example Batch increment for createMany
 * const startSeq = await getNextSequence('invoices', 5);
 * // If current was 10, returns 15 (you use 11, 12, 13, 14, 15)
+*
+* @example Transactional counter bump
+* await withTransaction(conn, async (session) => {
+*   const seq = await getNextSequence('invoices', 1, conn, session);
+*   await invoiceRepo.create({ invoiceNumber: `INV-${seq}` }, { session });
+*   // if this throws, the counter is rolled back with the insert
+* });
 */
-async function getNextSequence(counterKey, increment = 1, connection) {
+async function getNextSequence(counterKey, increment = 1, connection, session) {
 	const result = await getCounterModel(connection).findOneAndUpdate({ _id: counterKey }, { $inc: { seq: increment } }, {
 		upsert: true,
-		returnDocument: "after"
+		returnDocument: "after",
+		session
 	});
 	if (!result) throw new Error(`Failed to increment counter '${counterKey}'`);
 	return result.seq;
@@ -3190,7 +3203,7 @@ function sequentialId(options) {
 	const { prefix, model, padding = 4, separator = "-", counterKey } = options;
 	const key = counterKey || model.modelName;
 	return async (context) => {
-		const seq = await getNextSequence(key, 1, context._counterConnection);
+		const seq = await getNextSequence(key, 1, context._counterConnection, context.session);
 		return `${prefix}${separator}${String(seq).padStart(padding, "0")}`;
 	};
 }
@@ -3238,7 +3251,7 @@ function dateSequentialId(options) {
 				counterKey = `${model.modelName}:${year}-${month}`;
 				break;
 		}
-		const seq = await getNextSequence(counterKey, 1, context._counterConnection);
+		const seq = await getNextSequence(counterKey, 1, context._counterConnection, context.session);
 		return `${prefix}${separator}${datePart}${separator}${String(seq).padStart(padding, "0")}`;
 	};
 }
@@ -3706,7 +3719,7 @@ function mongoOperationsPlugin() {
 * ```
 */
 function multiTenantPlugin(options = {}) {
-	const { tenantField = "organizationId", contextKey = "organizationId", required = true, skipOperations = [], skipWhen, resolveContext } = options;
+	const { tenantField = "organizationId", contextKey = "organizationId", required = true, skipOperations = [], skipWhen, resolveContext, fieldType = "string" } = options;
 	const filterOps = [
 		"getAll",
 		"findAll",
@@ -3755,25 +3768,26 @@ function multiTenantPlugin(options = {}) {
 					}
 					if (!tenantId && required) throw new Error(`[mongokit] Multi-tenant: Missing '${contextKey}' in context for '${op}'. Pass it via options or set required: false.`);
 					if (!tenantId) return;
+					const castId = fieldType === "objectId" ? new mongoose.Types.ObjectId(tenantId) : tenantId;
 					if (filterOps.includes(op) || filterReadOps.includes(op)) context.filters = {
 						...context.filters,
-						[tenantField]: tenantId
+						[tenantField]: castId
 					};
 					if (queryReadOps.includes(op)) context.query = {
 						...context.query,
-						[tenantField]: tenantId
+						[tenantField]: castId
 					};
-					if (op === "create" && context.data) context.data[tenantField] = tenantId;
+					if (op === "create" && context.data) context.data[tenantField] = castId;
 					if (op === "createMany" && context.dataArray) {
-						for (const doc of context.dataArray) if (doc && typeof doc === "object") doc[tenantField] = tenantId;
+						for (const doc of context.dataArray) if (doc && typeof doc === "object") doc[tenantField] = castId;
 					}
 					if (constrainedWriteOps.includes(op)) context.query = {
 						...context.query,
-						[tenantField]: tenantId
+						[tenantField]: castId
 					};
 					if (batchQueryOps.includes(op)) context.query = {
 						...context.query,
-						[tenantField]: tenantId
+						[tenantField]: castId
 					};
 					if (op === "bulkWrite" && context.operations) {
 						const ops = context.operations;
@@ -3788,11 +3802,11 @@ function multiTenantPlugin(options = {}) {
 								const opBody = subOp[key];
 								if (opBody?.filter) opBody.filter = {
 									...opBody.filter,
-									[tenantField]: tenantId
+									[tenantField]: castId
 								};
 							}
 							const insertBody = subOp.insertOne;
-							if (insertBody?.document) insertBody.document[tenantField] = tenantId;
+							if (insertBody?.document) insertBody.document[tenantField] = castId;
 						}
 					}
 				}, { priority: HOOK_PRIORITY.POLICY });

package/dist/{validation-chain.plugin-COKNRAwp.d.mts → validation-chain.plugin-BsFzKVnO.d.mts}

@@ -432,6 +432,11 @@ interface CustomIdOptions {
  *
  * @param counterKey - Unique key identifying this counter (e.g., "Invoice" or "Invoice:2026-02")
  * @param increment - Value to increment by (default: 1)
+ * @param connection - Mongoose connection to use (defaults to the default connection)
+ * @param session - Optional client session. When provided, the counter bump
+ *   participates in the caller's transaction — if the surrounding transaction
+ *   aborts, the counter does NOT advance. Without a session, the bump commits
+ *   immediately and is not rolled back if a sibling write fails.
  * @returns The next sequence number (after increment)
  *
  * @example
@@ -441,8 +446,15 @@ interface CustomIdOptions {
  * @example Batch increment for createMany
  * const startSeq = await getNextSequence('invoices', 5);
  * // If current was 10, returns 15 (you use 11, 12, 13, 14, 15)
+ *
+ * @example Transactional counter bump
+ * await withTransaction(conn, async (session) => {
+ *   const seq = await getNextSequence('invoices', 1, conn, session);
+ *   await invoiceRepo.create({ invoiceNumber: `INV-${seq}` }, { session });
+ *   // if this throws, the counter is rolled back with the insert
+ * });
  */
-declare function getNextSequence(counterKey: string, increment?: number, connection?: mongoose.Connection): Promise<number>;
+declare function getNextSequence(counterKey: string, increment?: number, connection?: mongoose.Connection, session?: mongoose.ClientSession): Promise<number>;
 interface SequentialIdOptions {
   /** Prefix string (e.g., 'INV', 'ORD') */
   prefix: string;
@@ -835,6 +847,17 @@ interface MultiTenantOptions {
    * ```
    */
   resolveContext?: () => string | undefined;
+  /**
+   * How to store/query the tenant ID.
+   *
+   * - `'string'` (default): inject the tenant ID as-is (raw string).
+   * - `'objectId'`: cast to `mongoose.Types.ObjectId` before injecting.
+   *
+   * Choose `'objectId'` when the schema declares the tenant field as
+   * `Schema.Types.ObjectId` (e.g., Flow, accounting). This enables
+   * `$lookup` and `.populate()` against the referenced collection.
+   */
+  fieldType?: 'string' | 'objectId';
 }
 declare function multiTenantPlugin(options?: MultiTenantOptions): Plugin;
 //#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@classytic/mongokit",
-  "version": "3.6.0",
+  "version": "3.6.2",
   "description": "Production-grade MongoDB repositories with zero dependencies - smart pagination, events, and plugins",
   "type": "module",
   "sideEffects": false,
@@ -118,13 +118,15 @@
     "release:major": "npm version major && npm run release"
   },
   "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.2",
     "@biomejs/biome": "^2.4.10",
     "@types/node": "^22.0.0",
     "@vitest/coverage-v8": "^3.2.4",
     "knip": "^6.3.0",
     "mongodb-memory-server": "^10.4.3",
     "mongoose": "^9.4.1",
-    "tsdown": "^0.21.7",
+    "publint": "^0.3.18",
+    "tsdown": "^0.21.8",
     "typescript": "^5.7.0",
     "vitest": "^3.2.4"
   }