@nxgt/mongo-kit 0.1.0

package/dist/kit/types.d.ts

@@ -0,0 +1,92 @@
+import type { ActorOf, SyncOptions, SyncReport, TypedCollection } from '@nxgt/mongo';
+import type { ClientSession, Db, MongoClient, TransactionOptions } from 'mongodb';
+import type { CollectionsIn, CollectionsOf, DbName, KitConfig } from '../config/types';
+/**
+ * A database with its collections on it: `db.users` is the typed collection,
+ * and everything the driver's `Db` answers to is still there.
+ */
+export type DbScope<C> = {
+    readonly [K in keyof CollectionsOf<C>]: TypedCollection<CollectionsOf<C>[K]>;
+} & Db;
+/** Every definition the kit wires, whichever database it belongs to. */
+type WiredDefinition<C> = {
+    [N in DbName<C>]: CollectionsOf<CollectionsIn<C, N>>[keyof CollectionsOf<CollectionsIn<C, N>>];
+}[DbName<C>];
+type UnionToIntersection<U> = (U extends unknown ? (u: U) => void : never) extends (i: infer I) => void ? I : never;
+/**
+ * Who a kit writes as: the actor every collection that stamps one agrees on.
+ * A collection with no actor asks for nothing, and a kit whose collections
+ * all stamp none has no `as` to call. Two collections whose actors are of
+ * different types agree on nothing, so `as` cannot be called either — which
+ * is the honest answer, since one call could not stamp both.
+ */
+export type KitActor<C> = [ActorOf<WiredDefinition<C>>] extends [never] ? never : UnionToIntersection<ActorOf<WiredDefinition<C>>>;
+/**
+ * The scope of a kit that has exactly one database, and `never` for a kit
+ * that has several: with two, `kit.databases.main` is the one that says which.
+ */
+export type SoleScope<C> = DbName<C> extends infer N extends DbName<C> ? [Exclude<DbName<C>, N>] extends [never] ? DbScope<CollectionsIn<C, N>> : never : never;
+/** A transaction's options, and which database's client carries it. */
+export type KitTransactionOptions<C> = TransactionOptions & {
+    /** Required once the kit holds more than one client. */
+    on?: DbName<C>;
+};
+/**
+ * An application's MongoDB, wired: the collections on their database, the
+ * clients, and what a request adds to them.
+ */
+export interface MongoKit<C> extends AsyncDisposable {
+    /**
+     * The only database's scope. `never` when the kit has several, where
+     * reading it anyway — from JavaScript, or across an `any` — throws.
+     */
+    readonly db: SoleScope<C>;
+    /**
+     * Every database's scope, under the name the config gave it, or `default`
+     * when it named none.
+     */
+    readonly databases: {
+        readonly [N in DbName<C>]: DbScope<CollectionsIn<C, N>>;
+    };
+    /**
+     * The client of each database, under the same names; two databases on one
+     * URI share one, and must then be configured with the same `clientOptions`.
+     */
+    readonly clients: {
+        readonly [N in DbName<C>]: MongoClient;
+    };
+    /** What this kit stamps into the `*By` fields, if any. */
+    readonly actor: KitActor<C> | undefined;
+    /** The session every collection of this kit runs in, if any. */
+    readonly session: ClientSession | undefined;
+    /** The same kit, stamping this actor: one call for every collection. */
+    as(actor: KitActor<C>): MongoKit<C>;
+    /** The same kit, running in this session; `undefined` takes it away. */
+    withSession(session: ClientSession | undefined): MongoKit<C>;
+    /**
+     * Runs `fn` in a transaction, with a kit whose collections are all in it.
+     *
+     * The driver **retries `fn` from the start** on a transient error, so it
+     * must be safe to run twice. A transaction lives on one client: `on` says
+     * which database's, is required once the kit holds more than one, and only
+     * that client's databases can be used inside — the driver refuses a
+     * session another client owns. A call inside a transaction joins it, and
+     * takes no `on`.
+     */
+    transaction<T>(fn: (kit: MongoKit<C>) => Promise<T>, options?: KitTransactionOptions<C>): Promise<T>;
+    /**
+     * Syncs the wired collections, database by database, and reports each one
+     * under its name. The first database that throws stops the rest, so
+     * `dryRun` is the way to see everything at once.
+     */
+    sync(options?: SyncOptions): Promise<Record<DbName<C>, SyncReport[]>>;
+    /**
+     * Closes what this kit opened. Idempotent; a client the config gave is
+     * left alone, and only the kit `createKit` returned may be closed.
+     */
+    close(): Promise<void>;
+}
+/** What `createKit` takes: a config `defineConfig` checked. */
+export type KitOf<Config> = Config extends KitConfig<infer C> ? MongoKit<C> : never;
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/kit/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/kit/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,OAAO,EACP,WAAW,EACX,UAAU,EACV,eAAe,EACf,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EACX,aAAa,EACb,EAAE,EACF,WAAW,EACX,kBAAkB,EAClB,MAAM,SAAS,CAAC;AACjB,OAAO,KAAK,EACX,aAAa,EACb,aAAa,EACb,MAAM,EACN,SAAS,EACT,MAAM,iBAAiB,CAAC;AAEzB;;;GAGG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI;IACxB,QAAQ,EAAE,CAAC,IAAI,MAAM,aAAa,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC5E,GAAG,EAAE,CAAC;AAEP,wEAAwE;AACxE,KAAK,eAAe,CAAC,CAAC,IAAI;KACxB,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,aAAa,CACvE,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,CACnB,CAAC;CACF,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;AAEb,KAAK,mBAAmB,CAAC,CAAC,IAAI,CAC7B,CAAC,SAAS,OAAO,GACd,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,GACd,KAAK,CACR,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,IAAI,GAC3B,CAAC,GACD,KAAK,CAAC;AAET;;;;;;GAMG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GACpE,KAAK,GACL,mBAAmB,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAEpD;;;GAGG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,IACtB,MAAM,CAAC,CAAC,CAAC,SAAS,MAAM,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC,GACxC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GACtC,OAAO,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAC5B,KAAK,GACN,KAAK,CAAC;AAEV,uEAAuE;AACvE,MAAM,MAAM,qBAAqB,CAAC,CAAC,IAAI,kBAAkB,GAAG;IAC3D,wDAAwD;IACxD,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;CACf,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,QAAQ,CAAC,CAAC,CAAE,SAAQ,eAAe;IACnD;;;OAGG;IACH,QAAQ,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IAC1B;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE;QACnB,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;KACvD,CAAC;IACF;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE;QAAE,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,WAAW;KAAE,CAAC;IAC7D,0DAA0D;IAC1D,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IACxC,gEAAgE;IAChE,QAAQ,CAAC,OAAO,EAAE,aAAa,GAAG,SAAS,CAAC;IAE5C,wEAAwE;IACxE,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;IACpC,wEAAwE;IACxE,WAAW,CAAC,OAAO,EAAE,aAAa,GAAG,SAAS,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC7D;;;;;;;;;OASG;IACH,WAAW,CAAC,CAAC,EACZ,EAAE,EAAE,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,EACpC,OAAO,CAAC,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAChC,OAAO,CAAC,CAAC,CAAC,CAAC;IACd;;;;OAIG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;IACtE;;;OAGG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACvB;AAED,+DAA+D;AAC/D,MAAM,MAAM,KAAK,CAAC,MAAM,IACvB,MAAM,SAAS,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC"}

package/package.json

@@ -0,0 +1,61 @@
+{
+	"name": "@nxgt/mongo-kit",
+	"version": "0.1.0",
+	"description": "An application's MongoDB wiring in one object: a validated config, the clients it opens from it, and every collection typed on the database it lives in",
+	"license": "MIT",
+	"type": "module",
+	"main": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"files": [
+		"dist",
+		"README.md",
+		"package.json",
+		"LICENSE"
+	],
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"import": "./dist/index.js",
+			"default": "./dist/index.js"
+		},
+		"./package.json": "./package.json"
+	},
+	"keywords": [
+		"mongodb",
+		"typescript",
+		"collections",
+		"configuration",
+		"transactions"
+	],
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/softistx/nxgt-data.git",
+		"directory": "packages/mongo-kit"
+	},
+	"publishConfig": {
+		"registry": "https://registry.npmjs.org",
+		"access": "public"
+	},
+	"scripts": {
+		"build": "bun run ../../build.ts",
+		"test": "bun test src",
+		"typecheck": "tsc --noEmit"
+	},
+	"nxgt": {
+		"entrypoints": [
+			"src/index.ts"
+		]
+	},
+	"devDependencies": {
+		"@nxgt/mongo": "^0.11.0",
+		"@types/bun": "^1.4.0",
+		"mongodb": "7.6.0",
+		"mongodb-memory-server-core": "11.2.0",
+		"zod": "4.6.5"
+	},
+	"peerDependencies": {
+		"@nxgt/mongo": "^0.11.0",
+		"mongodb": ">=7.0.0 <8",
+		"typescript": "^6.0.3"
+	}
+}