@classytic/mongokit 3.12.0 → 3.13.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +126 -4
- package/dist/{PaginationEngine-BDaAsyPn.mjs → PaginationEngine-CfQRM1yz.mjs} +16 -16
- package/dist/Repository-d5gWSROf.mjs +3603 -0
- package/dist/actions/index.d.mts +1 -1
- package/dist/actions/index.mjs +1 -1
- package/dist/adapter/index.d.mts +190 -0
- package/dist/adapter/index.mjs +2 -0
- package/dist/adapter-DTDMnUOH.mjs +158 -0
- package/dist/ai/index.d.mts +1 -1
- package/dist/ai/index.mjs +1 -1
- package/dist/better-auth/index.d.mts +149 -0
- package/dist/better-auth/index.mjs +81 -0
- package/dist/field-selection-Br3WPOEb.mjs +99 -0
- package/dist/{index-D9cORR-o.d.mts → index-BbHaKwi5.d.mts} +33 -13
- package/dist/index.d.mts +690 -30
- package/dist/index.mjs +240 -17
- package/dist/{logger-8-VS1za6.mjs → logger-DprijP5h.mjs} +1 -5
- package/dist/{mongooseToJsonSchema-B187ufOP.mjs → mongooseToJsonSchema-BYbG894y.mjs} +1 -1
- package/dist/{mongooseToJsonSchema-rtkdbBhf.d.mts → mongooseToJsonSchema-BgRAaXX-.d.mts} +2 -1
- package/dist/pagination/PaginationEngine.d.mts +2 -2
- package/dist/pagination/PaginationEngine.mjs +1 -1
- package/dist/plugins/index.d.mts +2 -2
- package/dist/plugins/index.mjs +2 -2
- package/dist/query/primitives/coercion.d.mts +1 -1
- package/dist/query/primitives/coercion.mjs +1 -1
- package/dist/query/primitives/indexes.d.mts +1 -1
- package/dist/{types-DXscZnLu.d.mts → types-BbaPZleN.d.mts} +371 -112
- package/dist/{update-CDxPtpsk.mjs → update-C-3viiw1.mjs} +112 -28
- package/dist/utils/index.d.mts +2 -91
- package/dist/utils/index.mjs +5 -5
- package/dist/validation-chain.plugin-BLVp_Pw2.mjs +2399 -0
- package/dist/{validation-chain.plugin-CH-xPoKM.d.mts → validation-chain.plugin-CAPYCj_T.d.mts} +212 -80
- package/package.json +20 -3
- package/dist/field-selection-dI0m4RBs.mjs +0 -221
- package/dist/validation-chain.plugin-BicIgzzt.mjs +0 -4970
- /package/dist/{coercion-oM8G4b6m.d.mts → coercion-TRMmR49h.d.mts} +0 -0
- /package/dist/{id-resolution-e4BT9zAV.mjs → id-resolution-B0Odvvou.mjs} +0 -0
- /package/dist/{indexes-C26GNZRU.d.mts → indexes-CgOF7Wjd.d.mts} +0 -0
package/dist/{validation-chain.plugin-CH-xPoKM.d.mts → validation-chain.plugin-CAPYCj_T.d.mts}
RENAMED
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { B as ObjectId, C as FieldPreset, G as Plugin, J as PopulateSpec, Q as RepositoryContext, _t as ValidationChainOptions, et as RepositoryInstance, it as SelectSpec, j as Logger, l as CascadeOptions, st as SoftDeleteOptions, ut as SortSpec, vt as ValidatorDefinition } from "./types-BbaPZleN.mjs";
|
|
2
2
|
import mongoose from "mongoose";
|
|
3
|
+
import { CacheAdapter as CacheAdapter$1, CacheOptions, RepositoryCacheHandle, RepositoryCachePluginOptions, cachePlugin } from "@classytic/repo-core/cache";
|
|
3
4
|
import { BulkWriteResult } from "@classytic/repo-core/repository";
|
|
4
5
|
import { AsyncLocalStorage } from "node:async_hooks";
|
|
5
6
|
import { OffsetPaginationResult } from "@classytic/repo-core/pagination";
|
|
@@ -91,12 +92,6 @@ interface AggregateHelpersMethods {
|
|
|
91
92
|
}
|
|
92
93
|
//#endregion
|
|
93
94
|
//#region src/plugins/audit-log.plugin.d.ts
|
|
94
|
-
/**
|
|
95
|
-
* Audit log plugin that logs all repository operations
|
|
96
|
-
*
|
|
97
|
-
* @example
|
|
98
|
-
* const repo = new Repository(Model, [auditLogPlugin(console)]);
|
|
99
|
-
*/
|
|
100
95
|
declare function auditLogPlugin(logger: Logger): Plugin;
|
|
101
96
|
//#endregion
|
|
102
97
|
//#region src/plugins/audit-trail.plugin.d.ts
|
|
@@ -121,6 +116,22 @@ interface AuditTrailOptions {
|
|
|
121
116
|
* These fields are redacted in the `changes` diff.
|
|
122
117
|
*/
|
|
123
118
|
excludeFields?: string[];
|
|
119
|
+
/**
|
|
120
|
+
* Custom callback fired when an audit write fails. Receives the error
|
|
121
|
+
* and the entry that failed to land. Default: `console.warn` only.
|
|
122
|
+
*
|
|
123
|
+
* **Use this for compliance-grade audit trails (SOC 2 / PCI / HIPAA)
|
|
124
|
+
* where missing entries must be surfaced upstream** — e.g. forward to
|
|
125
|
+
* a dead-letter queue, page on-call, or short-circuit the request.
|
|
126
|
+
* The default `warn` log is appropriate for development and
|
|
127
|
+
* eventually-consistent observability use cases but is invisible to
|
|
128
|
+
* compliance review.
|
|
129
|
+
*
|
|
130
|
+
* The callback runs on the same fire-and-forget microtask that wrote
|
|
131
|
+
* the entry, so throwing from here will surface as an unhandled
|
|
132
|
+
* rejection — handle (or rethrow into your error reporter) inside.
|
|
133
|
+
*/
|
|
134
|
+
onWriteError?: (error: Error, entry: Omit<AuditEntry, 'timestamp'>) => void;
|
|
124
135
|
}
|
|
125
136
|
type AuditOperation = 'create' | 'update' | 'delete' | 'findOneAndUpdate';
|
|
126
137
|
interface AuditEntry {
|
|
@@ -150,7 +161,7 @@ interface AuditQueryOptions {
|
|
|
150
161
|
limit?: number;
|
|
151
162
|
}
|
|
152
163
|
interface AuditQueryResult {
|
|
153
|
-
|
|
164
|
+
data: AuditEntry[];
|
|
154
165
|
page: number;
|
|
155
166
|
limit: number;
|
|
156
167
|
total: number;
|
|
@@ -286,64 +297,6 @@ interface BatchOperationsMethods {
|
|
|
286
297
|
}): Promise<BulkWriteResult>;
|
|
287
298
|
}
|
|
288
299
|
//#endregion
|
|
289
|
-
//#region src/plugins/cache.plugin.d.ts
|
|
290
|
-
/**
|
|
291
|
-
* Cache plugin factory
|
|
292
|
-
*
|
|
293
|
-
* @param options - Cache configuration
|
|
294
|
-
* @returns Plugin instance
|
|
295
|
-
*/
|
|
296
|
-
declare function cachePlugin(options: CacheOptions): Plugin;
|
|
297
|
-
/**
|
|
298
|
-
* TypeScript interface for cache plugin methods
|
|
299
|
-
*
|
|
300
|
-
* @example
|
|
301
|
-
* ```typescript
|
|
302
|
-
* import type { CacheMethods } from '@classytic/mongokit';
|
|
303
|
-
*
|
|
304
|
-
* type ProductRepoWithCache = ProductRepo & CacheMethods;
|
|
305
|
-
*
|
|
306
|
-
* const productRepo = new ProductRepo(ProductModel, [
|
|
307
|
-
* methodRegistryPlugin(),
|
|
308
|
-
* cachePlugin({ adapter: redisAdapter, ttl: 60 }),
|
|
309
|
-
* ]) as ProductRepoWithCache;
|
|
310
|
-
*
|
|
311
|
-
* // TypeScript autocomplete for cache methods
|
|
312
|
-
* await productRepo.invalidateCache(productId);
|
|
313
|
-
* await productRepo.invalidateListCache();
|
|
314
|
-
* await productRepo.invalidateAllCache();
|
|
315
|
-
* const stats = productRepo.getCacheStats();
|
|
316
|
-
* productRepo.resetCacheStats();
|
|
317
|
-
* ```
|
|
318
|
-
*/
|
|
319
|
-
interface CacheMethods {
|
|
320
|
-
/**
|
|
321
|
-
* Invalidate cache for a specific document
|
|
322
|
-
* Use when document was updated outside this service
|
|
323
|
-
* @param id - Document ID to invalidate
|
|
324
|
-
*/
|
|
325
|
-
invalidateCache(id: string): Promise<void>;
|
|
326
|
-
/**
|
|
327
|
-
* Invalidate all list caches for this model
|
|
328
|
-
* Use when bulk changes happened outside this service
|
|
329
|
-
*/
|
|
330
|
-
invalidateListCache(): Promise<void>;
|
|
331
|
-
/**
|
|
332
|
-
* Invalidate ALL cache entries for this model
|
|
333
|
-
* Nuclear option - use sparingly
|
|
334
|
-
*/
|
|
335
|
-
invalidateAllCache(): Promise<void>;
|
|
336
|
-
/**
|
|
337
|
-
* Get cache statistics for monitoring
|
|
338
|
-
* @returns Cache statistics (hits, misses, sets, invalidations)
|
|
339
|
-
*/
|
|
340
|
-
getCacheStats(): CacheStats;
|
|
341
|
-
/**
|
|
342
|
-
* Reset cache statistics
|
|
343
|
-
*/
|
|
344
|
-
resetCacheStats(): void;
|
|
345
|
-
}
|
|
346
|
-
//#endregion
|
|
347
300
|
//#region src/plugins/cascade.plugin.d.ts
|
|
348
301
|
/**
|
|
349
302
|
* Cascade delete plugin.
|
|
@@ -535,6 +488,85 @@ declare function elasticSearchPlugin(options: ElasticSearchOptions): Plugin;
|
|
|
535
488
|
*/
|
|
536
489
|
declare function fieldFilterPlugin(fieldPreset: FieldPreset): Plugin;
|
|
537
490
|
//#endregion
|
|
491
|
+
//#region src/plugins/lease.plugin.d.ts
|
|
492
|
+
interface LeasePluginOptions {
|
|
493
|
+
/** Field carrying the row's status. @default `'status'` */
|
|
494
|
+
statusField?: string;
|
|
495
|
+
/** Field stamping the lease holder. @default `'leasedBy'` */
|
|
496
|
+
leasedByField?: string;
|
|
497
|
+
/** Field carrying the lease expiry timestamp. @default `'leaseExpiresAt'` */
|
|
498
|
+
leaseExpiresAtField?: string;
|
|
499
|
+
/** Status value an unleased row carries. @default `'pending'` */
|
|
500
|
+
pendingStatus?: string;
|
|
501
|
+
/** Status value a leased row carries. @default `'processing'` */
|
|
502
|
+
processingStatus?: string;
|
|
503
|
+
/** Status value a successfully released row carries. @default `'done'` */
|
|
504
|
+
doneStatus?: string;
|
|
505
|
+
/** Sort fields used to pick the FIFO winner from the lease pool. @default `{ createdAt: 1 }` */
|
|
506
|
+
sort?: Record<string, 1 | -1>;
|
|
507
|
+
}
|
|
508
|
+
/**
|
|
509
|
+
* Methods contributed by `leasePlugin()`. Use as a type assertion when
|
|
510
|
+
* constructing the repo so call sites get autocomplete:
|
|
511
|
+
*
|
|
512
|
+
* ```ts
|
|
513
|
+
* type OutboxRepo = Repository<IOutboxRow> & LeaseMethods<IOutboxRow>;
|
|
514
|
+
* const repo = new Repository(OutboxModel, [
|
|
515
|
+
* methodRegistryPlugin(),
|
|
516
|
+
* leasePlugin({ pendingStatus: 'queued' }),
|
|
517
|
+
* ]) as OutboxRepo;
|
|
518
|
+
* ```
|
|
519
|
+
*/
|
|
520
|
+
interface LeaseMethods<TDoc> {
|
|
521
|
+
/**
|
|
522
|
+
* Atomically claim the next available row. Matches rows that are
|
|
523
|
+
* either in `pendingStatus` OR have an expired `leaseExpiresAt` (dead
|
|
524
|
+
* lease recovery). Sets status to `processingStatus`, stamps
|
|
525
|
+
* `leasedBy`, and pushes `leaseExpiresAt = now + leaseFor`.
|
|
526
|
+
*
|
|
527
|
+
* @returns The leased doc, or `null` when no row matches.
|
|
528
|
+
*/
|
|
529
|
+
lease(opts: {
|
|
530
|
+
filter?: Record<string, unknown>;
|
|
531
|
+
leaseFor: number;
|
|
532
|
+
leasedBy: string;
|
|
533
|
+
options?: Record<string, unknown>;
|
|
534
|
+
}): Promise<TDoc | null>;
|
|
535
|
+
/**
|
|
536
|
+
* Push a held lease's expiry further. Only succeeds when the lease
|
|
537
|
+
* is still ours (`leasedBy === leasedBy && leaseExpiresAt > now`).
|
|
538
|
+
* Returns `null` if the lease was lost — caller should drop the
|
|
539
|
+
* work, since someone else has already started replaying it.
|
|
540
|
+
*/
|
|
541
|
+
extend(id: string | ObjectId, opts: {
|
|
542
|
+
leasedBy: string;
|
|
543
|
+
leaseFor: number;
|
|
544
|
+
options?: Record<string, unknown>;
|
|
545
|
+
}): Promise<TDoc | null>;
|
|
546
|
+
/**
|
|
547
|
+
* Release a held lease. CAS-checks `leasedBy === opts.leasedBy` AND
|
|
548
|
+
* `leaseExpiresAt > now` so only the live lease holder may finalise
|
|
549
|
+
* the row — symmetrical with `extend()`. A worker whose lease has
|
|
550
|
+
* been recovered (lease lost) MUST NOT mark someone else's
|
|
551
|
+
* in-progress work as `done` / `failed`; this method returns `null`
|
|
552
|
+
* in that race rather than overwriting.
|
|
553
|
+
*
|
|
554
|
+
* Sets status to `opts.finalStatus` (default `doneStatus`), clears
|
|
555
|
+
* `leasedBy` and `leaseExpiresAt`. Use `{ finalStatus: 'failed' }`
|
|
556
|
+
* for error paths so terminal-status filters (next caller's
|
|
557
|
+
* `lease()` predicate) skip this row.
|
|
558
|
+
*
|
|
559
|
+
* Returns the released doc, or `null` when the CAS lost (lease
|
|
560
|
+
* expired / held by another worker / row gone).
|
|
561
|
+
*/
|
|
562
|
+
release(id: string | ObjectId, opts: {
|
|
563
|
+
leasedBy: string;
|
|
564
|
+
finalStatus?: string;
|
|
565
|
+
options?: Record<string, unknown>;
|
|
566
|
+
}): Promise<TDoc | null>;
|
|
567
|
+
}
|
|
568
|
+
declare function leasePlugin(options?: LeasePluginOptions): Plugin;
|
|
569
|
+
//#endregion
|
|
538
570
|
//#region src/plugins/method-registry.plugin.d.ts
|
|
539
571
|
/**
|
|
540
572
|
* Extended repository interface with method registry
|
|
@@ -752,6 +784,33 @@ interface MongoOperationsMethods<TDoc> {
|
|
|
752
784
|
* });
|
|
753
785
|
*/
|
|
754
786
|
atomicUpdate(id: string | ObjectId, operators: Record<string, Record<string, unknown>>, options?: Record<string, unknown>): Promise<TDoc>;
|
|
787
|
+
/**
|
|
788
|
+
* Atomic conditional increment — increments the field only when it is
|
|
789
|
+
* strictly below `ceiling`. Returns the updated document on success,
|
|
790
|
+
* `null` when already at/above the ceiling.
|
|
791
|
+
*
|
|
792
|
+
* Single-round-trip CAS via `findOneAndUpdate({ _id, field: { $lt:
|
|
793
|
+
* ceiling }}, { $inc: { field: by }})`. Use for per-document
|
|
794
|
+
* concurrency limits, quotas, and capacity caps where a read-then-
|
|
795
|
+
* write loop would race.
|
|
796
|
+
*
|
|
797
|
+
* @param id - Document ID
|
|
798
|
+
* @param field - Numeric field to increment
|
|
799
|
+
* @param ceiling - Increment only when the field is `< ceiling`
|
|
800
|
+
* @param by - Increment delta (default `1`; pass negative to decrement-with-floor by inverting the predicate via the call site)
|
|
801
|
+
* @param options - Operation options (session, etc.)
|
|
802
|
+
* @returns The updated document, or `null` when at/above ceiling
|
|
803
|
+
*
|
|
804
|
+
* @example Per-tenant concurrency limit
|
|
805
|
+
* ```ts
|
|
806
|
+
* const claimed = await repo.incrementIfBelow(tenantId, 'activeRuns', 10);
|
|
807
|
+
* if (!claimed) throw new ConcurrencyLimitExceeded();
|
|
808
|
+
* try { await runWorkflow(); } finally {
|
|
809
|
+
* await repo.decrement(tenantId, 'activeRuns');
|
|
810
|
+
* }
|
|
811
|
+
* ```
|
|
812
|
+
*/
|
|
813
|
+
incrementIfBelow(id: string | ObjectId, field: string, ceiling: number, by?: number, options?: Record<string, unknown>): Promise<TDoc | null>;
|
|
755
814
|
}
|
|
756
815
|
//#endregion
|
|
757
816
|
//#region src/plugins/multi-tenant.plugin.d.ts
|
|
@@ -794,28 +853,101 @@ interface MultiTenantOptions extends Pick<TenantConfig, 'tenantField' | 'context
|
|
|
794
853
|
*/
|
|
795
854
|
resolveContext?: () => string | undefined;
|
|
796
855
|
/**
|
|
797
|
-
* When `true
|
|
798
|
-
*
|
|
799
|
-
*
|
|
856
|
+
* When `true`, bypass the `required` throw if the operation's policy
|
|
857
|
+
* target already carries the tenant field. This lets hosts that stamp
|
|
858
|
+
* the tenant into the payload themselves (e.g., `data[tenantField]`
|
|
800
859
|
* on writes, `filters[tenantField]` on paginated reads) use the plugin
|
|
801
860
|
* without having to hand-roll a `skipWhen` that duplicates this check.
|
|
802
861
|
*
|
|
803
|
-
*
|
|
804
|
-
*
|
|
805
|
-
*
|
|
862
|
+
* **Default: `false` (secure / fail-closed).** Tenant scope MUST come
|
|
863
|
+
* from `context` or `resolveContext`, otherwise the plugin throws
|
|
864
|
+
* (when `required: true`). This is the right posture for a security-
|
|
865
|
+
* sensitive boundary: caller-supplied scope on the payload cannot be
|
|
866
|
+
* trusted as authentication. If a host control-plane has already
|
|
867
|
+
* authenticated the tenant out-of-band and stamps it onto every
|
|
868
|
+
* write/read, set this to `true` explicitly — making the trust model
|
|
869
|
+
* visible at the call site.
|
|
806
870
|
*
|
|
807
|
-
*
|
|
808
|
-
*
|
|
809
|
-
*
|
|
871
|
+
* **Migration from < 4.0:** the prior default was `true`. To preserve
|
|
872
|
+
* the old behavior verbatim, set `allowDataInjection: true`. To get
|
|
873
|
+
* the new secure default, leave it unset.
|
|
810
874
|
*
|
|
811
|
-
*
|
|
812
|
-
*
|
|
813
|
-
*
|
|
814
|
-
*
|
|
875
|
+
* Composition: a user-supplied `skipWhen` still runs first and can
|
|
876
|
+
* always opt out. This option controls the behavior after `skipWhen`
|
|
877
|
+
* and `resolveContext` have had their turn.
|
|
878
|
+
*
|
|
879
|
+
* Safety: when the payload supplies the tenant AND this is `true`,
|
|
880
|
+
* the plugin skips its own injection (it does not overwrite). Cross-
|
|
881
|
+
* tenant isolation is therefore only as strong as the caller's own
|
|
882
|
+
* stamping — same guarantee as a hand-rolled `skipWhen`.
|
|
815
883
|
*/
|
|
816
884
|
allowDataInjection?: boolean;
|
|
817
885
|
}
|
|
818
886
|
declare function multiTenantPlugin(options?: MultiTenantOptions): Plugin;
|
|
887
|
+
/**
|
|
888
|
+
* Build the canonical `skipWhen` callback for role-based tenant
|
|
889
|
+
* bypass — replaces the hand-rolled
|
|
890
|
+
* `(ctx) => ctx.role === 'superadmin'` callback that ~6 packages
|
|
891
|
+
* across the classytic codebase carry as boilerplate. Eliminates the
|
|
892
|
+
* "I forgot to include 'platform_admin'" drift class — the role
|
|
893
|
+
* vocabulary lives in one place.
|
|
894
|
+
*
|
|
895
|
+
* **Composes with `bypassTenant: true` per-call**, doesn't replace
|
|
896
|
+
* it. `bypassTenant` is the deliberate per-call form for migration
|
|
897
|
+
* scripts and one-off admin queries; `adminBypass` is the
|
|
898
|
+
* always-on role-based bypass for users whose JWT / session carries
|
|
899
|
+
* a privileged role.
|
|
900
|
+
*
|
|
901
|
+
* **NOT a substitute for authentication or RBAC.** This factory only
|
|
902
|
+
* answers "should the tenant scope hook fire for this call?" — it
|
|
903
|
+
* does NOT validate that the caller is authenticated, that their
|
|
904
|
+
* role claim is genuine, or that the requested operation is
|
|
905
|
+
* permitted. Always run auth + RBAC before the call reaches the
|
|
906
|
+
* repository layer; this is the LAST gate, not the only one.
|
|
907
|
+
*
|
|
908
|
+
* @example Single role
|
|
909
|
+
* ```ts
|
|
910
|
+
* import { adminBypass, multiTenantPlugin } from '@classytic/mongokit';
|
|
911
|
+
*
|
|
912
|
+
* const repo = new Repository(InvoiceModel, [
|
|
913
|
+
* multiTenantPlugin({
|
|
914
|
+
* tenantField: 'organizationId',
|
|
915
|
+
* skipWhen: adminBypass({ adminRoles: ['superadmin'] }),
|
|
916
|
+
* }),
|
|
917
|
+
* ]);
|
|
918
|
+
*
|
|
919
|
+
* await repo.getAll({}, { role: 'superadmin' }); // sees all orgs
|
|
920
|
+
* await repo.getAll({}, { role: 'user', organizationId: 'org-1' }); // scoped
|
|
921
|
+
* ```
|
|
922
|
+
*
|
|
923
|
+
* @example Multiple admin roles + custom field name
|
|
924
|
+
* ```ts
|
|
925
|
+
* skipWhen: adminBypass({
|
|
926
|
+
* roleField: 'principalRole', // ctx.principalRole, not ctx.role
|
|
927
|
+
* adminRoles: ['superadmin', 'platform_admin', 'support'],
|
|
928
|
+
* }),
|
|
929
|
+
* ```
|
|
930
|
+
*
|
|
931
|
+
* @example Composing with custom logic
|
|
932
|
+
* ```ts
|
|
933
|
+
* // adminBypass for the role check, then your own additional logic:
|
|
934
|
+
* const adminCheck = adminBypass({ adminRoles: ['superadmin'] });
|
|
935
|
+
* skipWhen: (ctx, op) => adminCheck(ctx, op) || ctx.internalSystemFlag === true,
|
|
936
|
+
* ```
|
|
937
|
+
*
|
|
938
|
+
* @param options.roleField - Path on the context to read the role
|
|
939
|
+
* from. Defaults to `'role'`. Top-level keys only — for nested
|
|
940
|
+
* shapes (e.g. `ctx.user.role`), wrap your own `(ctx) => …` callback
|
|
941
|
+
* instead.
|
|
942
|
+
* @param options.adminRoles - Role values that grant the bypass. The
|
|
943
|
+
* factory does an exact-match `includes` check — case-sensitive,
|
|
944
|
+
* no fuzzy matching. Lowercase your role vocabulary upstream.
|
|
945
|
+
* @returns A `skipWhen`-compatible callback `(ctx, op) → boolean`.
|
|
946
|
+
*/
|
|
947
|
+
declare function adminBypass(options: {
|
|
948
|
+
roleField?: string;
|
|
949
|
+
adminRoles: readonly string[];
|
|
950
|
+
}): (context: RepositoryContext, operation: string) => boolean;
|
|
819
951
|
//#endregion
|
|
820
952
|
//#region src/plugins/observability.plugin.d.ts
|
|
821
953
|
interface OperationMetric {
|
|
@@ -1088,4 +1220,4 @@ declare function immutableField(field: string): ValidatorDefinition;
|
|
|
1088
1220
|
*/
|
|
1089
1221
|
declare function uniqueField(field: string, errorMessage?: string): ValidatorDefinition;
|
|
1090
1222
|
//#endregion
|
|
1091
|
-
export {
|
|
1223
|
+
export { AuditQueryResult as $, elasticSearchPlugin as A, sequentialId as B, MethodRegistryRepository as C, leasePlugin as D, LeasePluginOptions as E, SequentialIdOptions as F, RepositoryCachePluginOptions as G, CacheAdapter$1 as H, customIdPlugin as I, BulkWriteResult as J, cachePlugin as K, dateSequentialId as L, DateSequentialIdOptions as M, IdGenerator as N, fieldFilterPlugin as O, PrefixedIdOptions as P, AuditQueryOptions as Q, getNextSequence as R, mongoOperationsPlugin as S, LeaseMethods as T, CacheOptions as U, cascadePlugin as V, RepositoryCacheHandle as W, AuditEntry as X, batchOperationsPlugin as Y, AuditOperation as Z, observabilityPlugin as _, uniqueField as a, AggregateHelpersMethods as at, multiTenantPlugin as b, TenantContext as c, SubdocumentMethods as d, AuditTrailMethods as et, subdocumentPlugin as f, OperationMetric as g, ObservabilityOptions as h, requireField as i, auditLogPlugin as it, CustomIdOptions as j, ElasticSearchOptions as k, TenantStore as l, softDeletePlugin as m, blockIf as n, AuditTrailQuery as nt, validationChainPlugin as o, aggregateHelpersPlugin as ot, SoftDeleteMethods as p, BatchOperationsMethods as q, immutableField as r, auditTrailPlugin as rt, timestampPlugin as s, autoInject as t, AuditTrailOptions as tt, createTenantContext as u, MultiTenantOptions as v, methodRegistryPlugin as w, MongoOperationsMethods as x, adminBypass as y, prefixedId as z };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@classytic/mongokit",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.13.1",
|
|
4
4
|
"description": "Production-grade MongoDB repositories - smart pagination, events, and plugins. Built on @classytic/repo-core.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"sideEffects": false,
|
|
@@ -32,6 +32,14 @@
|
|
|
32
32
|
"types": "./dist/ai/index.d.mts",
|
|
33
33
|
"default": "./dist/ai/index.mjs"
|
|
34
34
|
},
|
|
35
|
+
"./adapter": {
|
|
36
|
+
"types": "./dist/adapter/index.d.mts",
|
|
37
|
+
"default": "./dist/adapter/index.mjs"
|
|
38
|
+
},
|
|
39
|
+
"./better-auth": {
|
|
40
|
+
"types": "./dist/better-auth/index.d.mts",
|
|
41
|
+
"default": "./dist/better-auth/index.mjs"
|
|
42
|
+
},
|
|
35
43
|
"./query/primitives/geo": {
|
|
36
44
|
"types": "./dist/query/primitives/geo.d.mts",
|
|
37
45
|
"default": "./dist/query/primitives/geo.mjs"
|
|
@@ -93,9 +101,15 @@
|
|
|
93
101
|
},
|
|
94
102
|
"homepage": "https://github.com/classytic/mongokit#readme",
|
|
95
103
|
"peerDependencies": {
|
|
96
|
-
"@classytic/repo-core": ">=0.
|
|
104
|
+
"@classytic/repo-core": ">=0.4.0",
|
|
105
|
+
"better-auth": ">=1.6.0",
|
|
97
106
|
"mongoose": ">=9.4.1"
|
|
98
107
|
},
|
|
108
|
+
"peerDependenciesMeta": {
|
|
109
|
+
"better-auth": {
|
|
110
|
+
"optional": true
|
|
111
|
+
}
|
|
112
|
+
},
|
|
99
113
|
"engines": {
|
|
100
114
|
"node": ">=22"
|
|
101
115
|
},
|
|
@@ -127,13 +141,16 @@
|
|
|
127
141
|
},
|
|
128
142
|
"devDependencies": {
|
|
129
143
|
"@arethetypeswrong/cli": "^0.18.2",
|
|
144
|
+
"@better-auth/api-key": "^1.6.9",
|
|
145
|
+
"@better-auth/mongo-adapter": "^1.6.9",
|
|
130
146
|
"@biomejs/biome": "^2.4.10",
|
|
131
147
|
"@classytic/dev-tools": "^0.2.0",
|
|
132
|
-
"@classytic/repo-core": "^0.
|
|
148
|
+
"@classytic/repo-core": "^0.4.0",
|
|
133
149
|
"@types/node": "^22.0.0",
|
|
134
150
|
"@vitest/coverage-v8": "^3.2.4",
|
|
135
151
|
"ajv": "^8.18.0",
|
|
136
152
|
"ajv-formats": "^3.0.1",
|
|
153
|
+
"better-auth": "^1.6.9",
|
|
137
154
|
"dotenv": "^17.4.2",
|
|
138
155
|
"knip": "^6.3.0",
|
|
139
156
|
"mongodb-memory-server": "^10.4.3",
|
|
@@ -1,221 +0,0 @@
|
|
|
1
|
-
//#region src/utils/cache-keys.ts
|
|
2
|
-
/**
|
|
3
|
-
* Simple hash function for query parameters
|
|
4
|
-
* Using djb2 algorithm - fast and good distribution
|
|
5
|
-
*/
|
|
6
|
-
function hashString(str) {
|
|
7
|
-
let hash = 5381;
|
|
8
|
-
for (let i = 0; i < str.length; i++) hash = (hash << 5) + hash ^ str.charCodeAt(i);
|
|
9
|
-
return (hash >>> 0).toString(16);
|
|
10
|
-
}
|
|
11
|
-
/**
|
|
12
|
-
* Normalize and stringify an object for hashing
|
|
13
|
-
* Ensures deterministic key generation regardless of property order
|
|
14
|
-
*/
|
|
15
|
-
function stableStringify(obj) {
|
|
16
|
-
if (obj === null || obj === void 0) return "";
|
|
17
|
-
if (typeof obj !== "object") return String(obj);
|
|
18
|
-
if (Array.isArray(obj)) return `[${obj.map(stableStringify).join(",")}]`;
|
|
19
|
-
return `{${Object.keys(obj).sort().map((key) => `${key}:${stableStringify(obj[key])}`).join(",")}}`;
|
|
20
|
-
}
|
|
21
|
-
/**
|
|
22
|
-
* Generate cache key for getById operations
|
|
23
|
-
*
|
|
24
|
-
* Includes select/populate/lean in the key so different query shapes
|
|
25
|
-
* (e.g., plain vs populated, lean vs hydrated) never collide.
|
|
26
|
-
*
|
|
27
|
-
* Format: {prefix}:id:{model}:{documentId} (no options)
|
|
28
|
-
* Format: {prefix}:id:{model}:{documentId}:{optionsHash} (with options)
|
|
29
|
-
*
|
|
30
|
-
* @example
|
|
31
|
-
* byIdKey('mk', 'User', '507f1f77bcf86cd799439011')
|
|
32
|
-
* // => 'mk:id:User:507f1f77bcf86cd799439011'
|
|
33
|
-
* byIdKey('mk', 'User', '507f1f77bcf86cd799439011', { select: 'name email' })
|
|
34
|
-
* // => 'mk:id:User:507f1f77bcf86cd799439011:a1b2c3d4'
|
|
35
|
-
*/
|
|
36
|
-
function byIdKey(prefix, model, id, options) {
|
|
37
|
-
const base = `${prefix}:id:${model}:${id}`;
|
|
38
|
-
if (!options || options.select == null && options.populate == null && options.lean == null) return base;
|
|
39
|
-
return `${base}:${hashString(stableStringify({
|
|
40
|
-
s: options.select,
|
|
41
|
-
p: options.populate,
|
|
42
|
-
l: options.lean
|
|
43
|
-
}))}`;
|
|
44
|
-
}
|
|
45
|
-
/**
|
|
46
|
-
* Generate cache key for single-document queries
|
|
47
|
-
*
|
|
48
|
-
* Format: {prefix}:one:{model}:{queryHash}
|
|
49
|
-
*
|
|
50
|
-
* @example
|
|
51
|
-
* byQueryKey('mk', 'User', { email: 'john@example.com' })
|
|
52
|
-
* // => 'mk:one:User:a1b2c3d4'
|
|
53
|
-
*/
|
|
54
|
-
function byQueryKey(prefix, model, version, query, options) {
|
|
55
|
-
return `${prefix}:one:${model}:${version}:${hashString(stableStringify({
|
|
56
|
-
q: query,
|
|
57
|
-
s: options?.select,
|
|
58
|
-
p: options?.populate
|
|
59
|
-
}))}`;
|
|
60
|
-
}
|
|
61
|
-
/**
|
|
62
|
-
* Generate cache key for paginated list queries
|
|
63
|
-
*
|
|
64
|
-
* Format: {prefix}:list:{model}:{version}:{queryHash}
|
|
65
|
-
*
|
|
66
|
-
* The version component enables efficient bulk invalidation:
|
|
67
|
-
* - On any mutation, bump the version
|
|
68
|
-
* - All list cache keys become invalid without scanning/deleting each
|
|
69
|
-
*
|
|
70
|
-
* @example
|
|
71
|
-
* listQueryKey('mk', 'User', 1, { filters: { status: 'active' }, page: 1, limit: 20 })
|
|
72
|
-
* // => 'mk:list:User:1:e5f6g7h8'
|
|
73
|
-
*/
|
|
74
|
-
function listQueryKey(prefix, model, version, params) {
|
|
75
|
-
return `${prefix}:list:${model}:${version}:${hashString(stableStringify({
|
|
76
|
-
f: params.filters,
|
|
77
|
-
s: params.sort,
|
|
78
|
-
pg: params.page,
|
|
79
|
-
lm: params.limit,
|
|
80
|
-
af: params.after,
|
|
81
|
-
sl: params.select,
|
|
82
|
-
pp: params.populate,
|
|
83
|
-
sr: params.search,
|
|
84
|
-
md: params.mode,
|
|
85
|
-
ln: params.lean,
|
|
86
|
-
rp: params.readPreference,
|
|
87
|
-
hn: params.hint,
|
|
88
|
-
mt: params.maxTimeMS,
|
|
89
|
-
cs: params.countStrategy
|
|
90
|
-
}))}`;
|
|
91
|
-
}
|
|
92
|
-
/**
|
|
93
|
-
* Generate cache key for collection version tag
|
|
94
|
-
*
|
|
95
|
-
* Format: {prefix}:ver:{model}
|
|
96
|
-
*
|
|
97
|
-
* Used to track mutation version for list invalidation
|
|
98
|
-
*/
|
|
99
|
-
function versionKey(prefix, model) {
|
|
100
|
-
return `${prefix}:ver:${model}`;
|
|
101
|
-
}
|
|
102
|
-
/**
|
|
103
|
-
* Generate pattern for clearing all cache keys for a model
|
|
104
|
-
*
|
|
105
|
-
* Format: {prefix}:*:{model}:*
|
|
106
|
-
*
|
|
107
|
-
* @example
|
|
108
|
-
* modelPattern('mk', 'User')
|
|
109
|
-
* // => 'mk:*:User:*'
|
|
110
|
-
*/
|
|
111
|
-
function modelPattern(prefix, model) {
|
|
112
|
-
return `${prefix}:*:${model}:*`;
|
|
113
|
-
}
|
|
114
|
-
/**
|
|
115
|
-
* Generate pattern for clearing all list cache keys for a model
|
|
116
|
-
*
|
|
117
|
-
* Format: {prefix}:list:{model}:*
|
|
118
|
-
*/
|
|
119
|
-
function listPattern(prefix, model) {
|
|
120
|
-
return `${prefix}:list:${model}:*`;
|
|
121
|
-
}
|
|
122
|
-
//#endregion
|
|
123
|
-
//#region src/utils/field-selection.ts
|
|
124
|
-
/**
|
|
125
|
-
* Get allowed fields for a user based on their context
|
|
126
|
-
*
|
|
127
|
-
* @param user - User object from request.user (or null for public)
|
|
128
|
-
* @param preset - Field preset configuration
|
|
129
|
-
* @returns Array of allowed field names
|
|
130
|
-
*
|
|
131
|
-
* @example
|
|
132
|
-
* const fields = getFieldsForUser(request.user, {
|
|
133
|
-
* public: ['id', 'name', 'price'],
|
|
134
|
-
* authenticated: ['description', 'features'],
|
|
135
|
-
* admin: ['createdAt', 'internalNotes']
|
|
136
|
-
* });
|
|
137
|
-
*/
|
|
138
|
-
function getFieldsForUser(user, preset) {
|
|
139
|
-
if (!preset) throw new Error("Field preset is required");
|
|
140
|
-
const fields = [...preset.public || []];
|
|
141
|
-
if (user) {
|
|
142
|
-
fields.push(...preset.authenticated || []);
|
|
143
|
-
const roles = Array.isArray(user.roles) ? user.roles : user.roles ? [user.roles] : [];
|
|
144
|
-
if (roles.includes("admin") || roles.includes("superadmin")) fields.push(...preset.admin || []);
|
|
145
|
-
}
|
|
146
|
-
return [...new Set(fields)];
|
|
147
|
-
}
|
|
148
|
-
/**
|
|
149
|
-
* Get Mongoose projection string for query .select()
|
|
150
|
-
*
|
|
151
|
-
* @param user - User object from request.user
|
|
152
|
-
* @param preset - Field preset configuration
|
|
153
|
-
* @returns Space-separated field names for Mongoose .select()
|
|
154
|
-
*
|
|
155
|
-
* @example
|
|
156
|
-
* const projection = getMongooseProjection(request.user, fieldPresets.gymPlans);
|
|
157
|
-
* const plans = await GymPlan.find({ organizationId }).select(projection).lean();
|
|
158
|
-
*/
|
|
159
|
-
function getMongooseProjection(user, preset) {
|
|
160
|
-
return getFieldsForUser(user, preset).join(" ");
|
|
161
|
-
}
|
|
162
|
-
/**
|
|
163
|
-
* Filter a single object to include only allowed fields
|
|
164
|
-
*/
|
|
165
|
-
function filterObject(obj, allowedFields) {
|
|
166
|
-
if (!obj || typeof obj !== "object" || Array.isArray(obj)) return obj;
|
|
167
|
-
const filtered = {};
|
|
168
|
-
for (const field of allowedFields) if (field in obj) filtered[field] = obj[field];
|
|
169
|
-
return filtered;
|
|
170
|
-
}
|
|
171
|
-
/**
|
|
172
|
-
* Filter response data to include only allowed fields
|
|
173
|
-
*
|
|
174
|
-
* Use this for complex responses where Mongoose projections aren't applicable:
|
|
175
|
-
* - Aggregation pipeline results
|
|
176
|
-
* - Data from multiple sources
|
|
177
|
-
* - Custom computed fields
|
|
178
|
-
*
|
|
179
|
-
* For simple DB queries, prefer getMongooseProjection() (10x faster)
|
|
180
|
-
*
|
|
181
|
-
* @param data - Data to filter
|
|
182
|
-
* @param preset - Field preset configuration
|
|
183
|
-
* @param user - User object from request.user
|
|
184
|
-
* @returns Filtered data
|
|
185
|
-
*
|
|
186
|
-
* @example
|
|
187
|
-
* const stats = await calculateComplexStats();
|
|
188
|
-
* const filtered = filterResponseData(stats, fieldPresets.dashboard, request.user);
|
|
189
|
-
* return reply.send(filtered);
|
|
190
|
-
*/
|
|
191
|
-
function filterResponseData(data, preset, user = null) {
|
|
192
|
-
const allowedFields = getFieldsForUser(user, preset);
|
|
193
|
-
if (Array.isArray(data)) return data.map((item) => filterObject(item, allowedFields));
|
|
194
|
-
return filterObject(data, allowedFields);
|
|
195
|
-
}
|
|
196
|
-
/**
|
|
197
|
-
* Helper to create field presets (module-level)
|
|
198
|
-
*
|
|
199
|
-
* Each module should define its own field preset in its own directory.
|
|
200
|
-
* This keeps modules independent and self-contained.
|
|
201
|
-
*
|
|
202
|
-
* @param config - Field configuration
|
|
203
|
-
* @returns Field preset
|
|
204
|
-
*
|
|
205
|
-
* @example
|
|
206
|
-
* // In modules/gym-plan/gym-plan.fields.ts
|
|
207
|
-
* export const gymPlanFieldPreset = createFieldPreset({
|
|
208
|
-
* public: ['id', 'name', 'price'],
|
|
209
|
-
* authenticated: ['features', 'description'],
|
|
210
|
-
* admin: ['createdAt', 'updatedAt', 'internalNotes']
|
|
211
|
-
* });
|
|
212
|
-
*/
|
|
213
|
-
function createFieldPreset(config) {
|
|
214
|
-
return {
|
|
215
|
-
public: config.public || [],
|
|
216
|
-
authenticated: config.authenticated || [],
|
|
217
|
-
admin: config.admin || []
|
|
218
|
-
};
|
|
219
|
-
}
|
|
220
|
-
//#endregion
|
|
221
|
-
export { byIdKey as a, listQueryKey as c, getMongooseProjection as i, modelPattern as l, filterResponseData as n, byQueryKey as o, getFieldsForUser as r, listPattern as s, createFieldPreset as t, versionKey as u };
|