@ignex/ninox 0.1.3 → 0.1.4

package/README.md

@@ -195,7 +195,7 @@ A quick tour — each entry links to the full guide further down.
 | 🔄 | [Background refresh](#background-refresh-system) | Self-updating standalone cache — reads never block |
 | 🧹 | [Data invalidation](#data-invalidation-react-query-style) | React Query-style — invalidate by name, params, or collection |
 | 🛡️ | [Error handling](#error-handling) | `BadRequest` / `DomainError` / `InfraError` + HTTP mapping |
-| ✅ | [Validation & drift](#validation) | DB `$jsonSchema` (strict) + opt-in drift detection |
+| ✅ | [Validation & drift](#error-handling) | DB `$jsonSchema` (strict) + opt-in drift detection |
 | 🪝 | [Mongo hooks](#hooks) | `before/after` create/update/delete + `afterRead` |
 | 🩺 | [Health & multi-DB](#operations-health--multi-db) | Per-DB pings, multi-client services, change-stream watch |
 
@@ -465,7 +465,7 @@ const users = defineCollection('users', userSchema, {
 const runner = createMongoMigrationRunner(service, { migrationDir: './migrations' });
 await runner.up();                 // apply pending migrations in numeric order
 await runner.down('001_seed');     // roll back to a target migration
-await runner.scaffold('add_tags'); // create a new NNN_add_tags.ts template
+await runner.create('add_tags');   // create a new NNN_add_tags.ts template
 ```
 
 ## Performance by default
@@ -937,14 +937,11 @@ and a perf-by-default comparison. Run any of them with
 
 ## Performance
 
-| scenario | naive | optimized |
-| --- | --- | --- |
-| populate 100 orders | 17,000 queries (N+1) | **340 queries** (~50× fewer round trips) |
-| paginate | count + find (2 round trips) | `$facet` **1 round trip** |
-| cache hit | 1 driver call | **0 driver calls** |
-| 50 concurrent identical reads | 50 server queries, 17 ms | **1 server query**, 1.5 ms |
+The headline numbers are in the ["ninox vs native MongoDB vs Mongoose" table](#ninox-vs-native-mongodb-vs-mongoose)
+above (N+1 population, concurrent-read dedup, cache hits, aggregation).
 
-Run the full harness (requires local MongoDB, see `.env`):
+Run the full harness (requires local MongoDB, see `.env`) to reproduce or
+extend them:
 
 ```bash
 bun run bench     # → bench/results/summary.json

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import * as mongodb from 'mongodb';
 import { Db, MongoClient, ClientSession, Document, Filter, Hint, CollationOptions, ReadPreferenceLike, ReadConcern, WriteConcern, WithId, Condition, RootFilterOperators, Collection, FindOptions, Sort, FindCursor, ObjectId, Decimal128, ReadConcernLike, AggregateOptions, AggregationCursor, CreateCollectionOptions, TransactionOptions, InsertOneOptions, InsertOneResult, InsertManyResult, UpdateOptions, UpdateResult, FindOneAndUpdateOptions, DeleteResult, ChangeStreamOptions, ChangeStream } from 'mongodb';
-import { L as LoggerLike } from './timeout-BgrqtMnd.js';
-export { C as CacheOptions, a as LRU, b as LRUOptions, c as LogFn, d as LogLevel, e as createCachedAsyncFactory, f as createCachedFactory, g as createConsoleLogger, h as createNoopLogger, i as hashString, s as sleep, j as sleepJittered, k as stableHash, l as stableStringify, w as withTimeout } from './timeout-BgrqtMnd.js';
+import { L as LoggerLike } from './timeout-BE_ULjdG.js';
+export { C as CacheOptions, a as LRU, b as LRUOptions, c as LogFn, d as LogLevel, e as createCachedAsyncFactory, f as createCachedFactory, g as createConsoleLogger, h as createNoopLogger, i as hashString, s as sleep, j as sleepJittered, k as stableHash, l as stableStringify, w as withTimeout } from './timeout-BE_ULjdG.js';
 import * as bson from 'bson';
 
 /**
@@ -150,7 +150,7 @@ declare class HotCache {
     private startAttempted;
     private stopped;
     private disposed;
-    private startPromise?;
+    private startPromise;
     constructor(options?: HotCacheOptions);
     /** Number of cached entries across all registered queries. */
     get size(): number;
@@ -2144,7 +2144,7 @@ interface PaginationConfig {
     postPipeline?: Document[];
     queryOptions?: QueryOptions;
 }
-interface CursorPaginationConfig<T = Document> {
+interface CursorPaginationConfig {
     limit?: number;
     /**
      * Sort keys (1 ascending / -1 descending). MUST include a unique tiebreaker —
@@ -2190,7 +2190,7 @@ interface PaginationOpsOptions {
  * and stays uncached (its opaque cursor pages are largely unique).
  */
 declare const makePaginationOps: <TClients extends DbClientsDefinition, TDb extends ExtractDbNames<TClients>>(client: Db, dbLabel: string, logger: LoggerLike, opts: PaginationOpsOptions) => {
-    paginateCursor: <X extends ExtractCollectionNames<TClients, TDb>>(collection: X, baseFilter: FilterInput<CollectionDoc<TClients[TDb]["collections"][X]>>, config: CursorPaginationConfig<CollectionDoc<TClients[TDb]["collections"][X]>>) => Promise<CursorPage<CollectionDoc<TClients[TDb]["collections"][X]>>>;
+    paginateCursor: <X extends ExtractCollectionNames<TClients, TDb>>(collection: X, baseFilter: FilterInput<CollectionDoc<TClients[TDb]["collections"][X]>>, config: CursorPaginationConfig) => Promise<CursorPage<CollectionDoc<TClients[TDb]["collections"][X]>>>;
     paginateFlexible: <X extends ExtractCollectionNames<TClients, TDb>>(collection: X, baseFilter: FilterInput<CollectionDoc<TClients[TDb]["collections"][X]>>, config?: PaginationConfig) => Promise<PaginationResult<CollectionDoc<TClients[TDb]["collections"][X]>>>;
 };
 
@@ -2467,7 +2467,7 @@ type RepositoryFor<TClients extends DbClientsDefinition, TDb extends ExtractDbNa
     /** `$facet` pagination with totals (one round trip). */
     page(filter: FilterInput<Doc>, config?: PaginationConfig): Promise<PaginationResult<Doc>>;
     /** Keyset/cursor pagination (O(log n), no totals). */
-    pageCursor(filter: FilterInput<Doc>, config: CursorPaginationConfig<Doc>): Promise<CursorPage<Doc>>;
+    pageCursor(filter: FilterInput<Doc>, config: CursorPaginationConfig): Promise<CursorPage<Doc>>;
     /** Type-safe chained aggregation builder. */
     pipeline(options?: QueryOptions): PipelineBuilder<TClients, TDb, Doc>;
     /** Callback aggregation over a typed stage builder. */