@xylabs/mongo 5.0.95 → 5.0.97

package/README.md

@@ -1,51 +1,52 @@
 # @xylabs/mongo
 
-[![logo][]](https://xylabs.com)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
 
-[![main-build][]][main-build-link]
-[![npm-badge][]][npm-link]
-[![npm-downloads-badge][]][npm-link]
-[![jsdelivr-badge][]][jsdelivr-link]
-[![npm-license-badge][]](LICENSE)
-[![codacy-badge][]][codacy-link]
-[![codeclimate-badge][]][codeclimate-link]
-[![snyk-badge][]][snyk-link]
-[![socket-badge][]][socket-link]
+> Base functionality used throughout XYO TypeScript/JavaScript libraries that access Mongo DB
 
+## Install
 
-Base functionality used throughout XYO TypeScript/JavaScript libraries that access Mongo DB
+Using npm:
 
+```sh
+npm install {{name}}
+```
 
+Using yarn:
 
-## Reference
+```sh
+yarn add {{name}}
+```
 
-**@xylabs/mongo**
+Using pnpm:
 
-***
+```sh
+pnpm add {{name}}
+```
 
-## Classes
+Using bun:
+
+```sh
+bun add {{name}}
+```
 
-| Class | Description |
-| ------ | ------ |
-| [BaseMongoSdk](#classes/BaseMongoSdk) | Provides a typed wrapper around common MongoDB collection operations. |
-| [MongoClientWrapper](#classes/MongoClientWrapper) | Manages a shared pool of MongoClient instances, reusing connections by URI. |
 
-## Interfaces
+## License
 
-| Interface | Description |
-| ------ | ------ |
-| [BaseMongoSdkPublicConfig](#interfaces/BaseMongoSdkPublicConfig) | Public configuration options for the Mongo SDK, safe to expose to clients. |
-| [BaseMongoSdkPrivateConfig](#interfaces/BaseMongoSdkPrivateConfig) | Private configuration options for the Mongo SDK containing connection credentials. |
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
 
-## Type Aliases
+## Reference
 
-| Type Alias | Description |
-| ------ | ------ |
-| [BaseMongoSdkConfig](#type-aliases/BaseMongoSdkConfig) | Combined public and private MongoDB SDK configuration. |
+### packages
 
-### classes
+  ### mongo
 
-  ### <a id="BaseMongoSdk"></a>BaseMongoSdk
+    ### .temp-typedoc
+
+      ### classes
+
+        ### <a id="BaseMongoSdk"></a>BaseMongoSdk
 
 [**@xylabs/mongo**](#../README)
 
@@ -55,23 +56,23 @@ Provides a typed wrapper around common MongoDB collection operations.
 
 ## Type Parameters
 
-| Type Parameter |
-| ------ |
-| `T` *extends* `Document` |
+### T
+
+`T` *extends* `Document`
 
 ## Constructors
 
 ### Constructor
 
 ```ts
-new BaseMongoSdk<T>(config: BaseMongoSdkConfig): BaseMongoSdk<T>;
+new BaseMongoSdk<T>(config): BaseMongoSdk<T>;
 ```
 
 ### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `config` | [`BaseMongoSdkConfig`](#../type-aliases/BaseMongoSdkConfig) |
+#### config
+
+[`BaseMongoSdkConfig`](#../type-aliases/BaseMongoSdkConfig)
 
 ### Returns
 
@@ -79,9 +80,13 @@ new BaseMongoSdk<T>(config: BaseMongoSdkConfig): BaseMongoSdk<T>;
 
 ## Properties
 
-| Property | Type | Description |
-| ------ | ------ | ------ |
-| <a id="config"></a> `config` | [`BaseMongoSdkConfig`](#../type-aliases/BaseMongoSdkConfig) | The MongoDB SDK configuration for this instance. |
+### config
+
+```ts
+config: BaseMongoSdkConfig;
+```
+
+The MongoDB SDK configuration for this instance.
 
 ## Accessors
 
@@ -104,16 +109,18 @@ Returns the MongoDB connection URI, either from the config or constructed from i
 ### deleteMany()
 
 ```ts
-deleteMany(filter: Filter<T>): Promise<DeleteResult>;
+deleteMany(filter): Promise<DeleteResult>;
 ```
 
 Deletes all documents matching the filter.
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `filter` | `Filter`\<`T`\> | The query filter to match documents for deletion |
+#### filter
+
+`Filter`\<`T`\>
+
+The query filter to match documents for deletion
 
 ### Returns
 
@@ -124,16 +131,18 @@ Deletes all documents matching the filter.
 ### deleteOne()
 
 ```ts
-deleteOne(filter: Filter<T>): Promise<DeleteResult>;
+deleteOne(filter): Promise<DeleteResult>;
 ```
 
 Deletes the first document matching the filter.
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `filter` | `Filter`\<`T`\> | The query filter to match a document for deletion |
+#### filter
+
+`Filter`\<`T`\>
+
+The query filter to match a document for deletion
 
 ### Returns
 
@@ -144,16 +153,18 @@ Deletes the first document matching the filter.
 ### find()
 
 ```ts
-find(filter: Filter<T>): Promise<FindCursor<WithId<T>>>;
+find(filter): Promise<FindCursor<WithId<T>>>;
 ```
 
 Finds all documents matching the filter and returns a cursor.
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `filter` | `Filter`\<`T`\> | The query filter |
+#### filter
+
+`Filter`\<`T`\>
+
+The query filter
 
 ### Returns
 
@@ -164,16 +175,18 @@ Finds all documents matching the filter and returns a cursor.
 ### findOne()
 
 ```ts
-findOne(filter: Filter<T>): Promise<WithId<T> | null>;
+findOne(filter): Promise<WithId<T> | null>;
 ```
 
 Finds a single document matching the filter.
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `filter` | `Filter`\<`T`\> | The query filter |
+#### filter
+
+`Filter`\<`T`\>
+
+The query filter
 
 ### Returns
 
@@ -186,17 +199,24 @@ The matched document, or `null` if not found
 ### insertMany()
 
 ```ts
-insertMany(items: OptionalUnlessRequiredId<T>[], options?: BulkWriteOptions): Promise<InsertManyResult<T>>;
+insertMany(items, options?): Promise<InsertManyResult<T>>;
 ```
 
 Inserts multiple documents into the collection.
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `items` | `OptionalUnlessRequiredId`\<`T`\>[] | The documents to insert |
-| `options?` | `BulkWriteOptions` | Optional bulk write options |
+#### items
+
+`OptionalUnlessRequiredId`\<`T`\>[]
+
+The documents to insert
+
+#### options?
+
+`BulkWriteOptions`
+
+Optional bulk write options
 
 ### Returns
 
@@ -207,17 +227,24 @@ Inserts multiple documents into the collection.
 ### insertOne()
 
 ```ts
-insertOne(item: OptionalUnlessRequiredId<T>, options?: InsertOneOptions): Promise<InsertOneResult<T>>;
+insertOne(item, options?): Promise<InsertOneResult<T>>;
 ```
 
 Inserts a single document into the collection.
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `item` | `OptionalUnlessRequiredId`\<`T`\> | The document to insert |
-| `options?` | `InsertOneOptions` | Optional insert options |
+#### item
+
+`OptionalUnlessRequiredId`\<`T`\>
+
+The document to insert
+
+#### options?
+
+`InsertOneOptions`
+
+Optional insert options
 
 ### Returns
 
@@ -229,20 +256,32 @@ Inserts a single document into the collection.
 
 ```ts
 replaceOne(
-   filter: Filter<T>, 
-   item: OptionalUnlessRequiredId<T>, 
-options?: ReplaceOptions): Promise<UpdateResult<T>>;
+   filter, 
+   item, 
+options?): Promise<UpdateResult<T>>;
 ```
 
 Replaces a single document matching the filter.
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `filter` | `Filter`\<`T`\> | The query filter to match the document |
-| `item` | `OptionalUnlessRequiredId`\<`T`\> | The replacement document |
-| `options?` | `ReplaceOptions` | Optional replace options |
+#### filter
+
+`Filter`\<`T`\>
+
+The query filter to match the document
+
+#### item
+
+`OptionalUnlessRequiredId`\<`T`\>
+
+The replacement document
+
+#### options?
+
+`ReplaceOptions`
+
+Optional replace options
 
 ### Returns
 
@@ -253,17 +292,24 @@ Replaces a single document matching the filter.
 ### updateOne()
 
 ```ts
-updateOne(filter: Filter<T>, fields: UpdateFilter<T>): Promise<UpdateResult<T>>;
+updateOne(filter, fields): Promise<UpdateResult<T>>;
 ```
 
 Updates a single document matching the filter without upserting.
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `filter` | `Filter`\<`T`\> | The query filter to match the document |
-| `fields` | `UpdateFilter`\<`T`\> | The update operations to apply |
+#### filter
+
+`Filter`\<`T`\>
+
+The query filter to match the document
+
+#### fields
+
+`UpdateFilter`\<`T`\>
+
+The update operations to apply
 
 ### Returns
 
@@ -274,17 +320,24 @@ Updates a single document matching the filter without upserting.
 ### upsertOne()
 
 ```ts
-upsertOne(filter: Filter<T>, fields: UpdateFilter<T>): Promise<UpdateResult<T>>;
+upsertOne(filter, fields): Promise<UpdateResult<T>>;
 ```
 
 Updates a single document matching the filter, inserting it if it does not exist.
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `filter` | `Filter`\<`T`\> | The query filter to match the document |
-| `fields` | `UpdateFilter`\<`T`\> | The update operations to apply |
+#### filter
+
+`Filter`\<`T`\>
+
+The query filter to match the document
+
+#### fields
+
+`UpdateFilter`\<`T`\>
+
+The update operations to apply
 
 ### Returns
 
@@ -295,22 +348,24 @@ Updates a single document matching the filter, inserting it if it does not exist
 ### useCollection()
 
 ```ts
-useCollection<R>(func: (collection: Collection<T>) => R | Promise<R>): Promise<R>;
+useCollection<R>(func): Promise<R>;
 ```
 
 Executes a callback with access to the configured MongoDB collection.
 
 ### Type Parameters
 
-| Type Parameter |
-| ------ |
-| `R` |
+#### R
+
+`R`
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `func` | (`collection`: `Collection`\<`T`\>) => `R` \| `Promise`\<`R`\> | A callback receiving the typed collection |
+#### func
+
+(`collection`) => `R` \| `Promise`\<`R`\>
+
+A callback receiving the typed collection
 
 ### Returns
 
@@ -323,22 +378,24 @@ The result of the callback
 ### useMongo()
 
 ```ts
-useMongo<R>(func: (client: MongoClient) => R | Promise<R>): Promise<R>;
+useMongo<R>(func): Promise<R>;
 ```
 
 Executes a callback with a connected MongoClient, handling connection and disconnection.
 
 ### Type Parameters
 
-| Type Parameter |
-| ------ |
-| `R` |
+#### R
+
+`R`
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `func` | (`client`: `MongoClient`) => `R` \| `Promise`\<`R`\> | A callback receiving the connected MongoClient |
+#### func
+
+(`client`) => `R` \| `Promise`\<`R`\>
+
+A callback receiving the connected MongoClient
 
 ### Returns
 
@@ -346,7 +403,7 @@ Executes a callback with a connected MongoClient, handling connection and discon
 
 The result of the callback
 
-  ### <a id="MongoClientWrapper"></a>MongoClientWrapper
+        ### <a id="MongoClientWrapper"></a>MongoClientWrapper
 
 [**@xylabs/mongo**](#../README)
 
@@ -360,18 +417,24 @@ Manages a shared pool of MongoClient instances, reusing connections by URI.
 
 ```ts
 new MongoClientWrapper(
-   uri: string, 
-   maxPoolSize?: number, 
-   closeDelay?: number): MongoClientWrapper;
+   uri, 
+   maxPoolSize?, 
+   closeDelay?): MongoClientWrapper;
 ```
 
 ### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `uri` | `string` |
-| `maxPoolSize?` | `number` |
-| `closeDelay?` | `number` |
+#### uri
+
+`string`
+
+#### maxPoolSize?
+
+`number`
+
+#### closeDelay?
+
+`number`
 
 ### Returns
 
@@ -379,9 +442,13 @@ new MongoClientWrapper(
 
 ## Properties
 
-| Property | Modifier | Type | Description |
-| ------ | ------ | ------ | ------ |
-| <a id="clients"></a> `clients` | `readonly` | `Map`\<`string`, `MongoClientWrapper`\> | Global cache of wrapper instances keyed by connection URI. |
+### clients
+
+```ts
+readonly static clients: Map<string, MongoClientWrapper>;
+```
+
+Global cache of wrapper instances keyed by connection URI.
 
 ## Methods
 
@@ -389,20 +456,32 @@ new MongoClientWrapper(
 
 ```ts
 static get(
-   uri: string, 
-   poolSize?: number, 
-   closeDelay?: number): MongoClientWrapper;
+   uri, 
+   poolSize?, 
+   closeDelay?): MongoClientWrapper;
 ```
 
 Gets or creates a cached MongoClientWrapper for the given URI.
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `uri` | `string` | The MongoDB connection URI |
-| `poolSize?` | `number` | Maximum connection pool size |
-| `closeDelay?` | `number` | Delay in milliseconds before closing idle connections |
+#### uri
+
+`string`
+
+The MongoDB connection URI
+
+#### poolSize?
+
+`number`
+
+Maximum connection pool size
+
+#### closeDelay?
+
+`number`
+
+Delay in milliseconds before closing idle connections
 
 ### Returns
 
@@ -452,9 +531,9 @@ Initiates a graceful close of the connection.
 
 `Promise`\<`void`\>
 
-### interfaces
+      ### interfaces
 
-  ### <a id="BaseMongoSdkPrivateConfig"></a>BaseMongoSdkPrivateConfig
+        ### <a id="BaseMongoSdkPrivateConfig"></a>BaseMongoSdkPrivateConfig
 
 [**@xylabs/mongo**](#../README)
 
@@ -464,80 +543,108 @@ Private configuration options for the Mongo SDK containing connection credential
 
 ## Properties
 
-| Property | Type | Description |
-| ------ | ------ | ------ |
-| <a id="dbconnectionstring"></a> `dbConnectionString?` | `string` | A full MongoDB connection string, used instead of individual credential fields. |
-| <a id="dbdomain"></a> `dbDomain?` | `string` | The MongoDB Atlas cluster domain. |
-| <a id="dbname"></a> `dbName?` | `string` | The database name to connect to. |
-| <a id="dbpassword"></a> `dbPassword?` | `string` | The password for MongoDB authentication. |
-| <a id="dbusername"></a> `dbUserName?` | `string` | The username for MongoDB authentication. |
+### dbConnectionString?
 
-  ### <a id="BaseMongoSdkPublicConfig"></a>BaseMongoSdkPublicConfig
+```ts
+optional dbConnectionString?: string;
+```
 
-[**@xylabs/mongo**](#../README)
+A full MongoDB connection string, used instead of individual credential fields.
 
 ***
 
-Public configuration options for the Mongo SDK, safe to expose to clients.
+### dbDomain?
 
-## Properties
+```ts
+optional dbDomain?: string;
+```
+
+The MongoDB Atlas cluster domain.
+
+***
+
+### dbName?
+
+```ts
+optional dbName?: string;
+```
+
+The database name to connect to.
+
+***
+
+### dbPassword?
+
+```ts
+optional dbPassword?: string;
+```
 
-| Property | Type | Description |
-| ------ | ------ | ------ |
-| <a id="closedelay"></a> `closeDelay?` | `number` | Delay in milliseconds before closing idle connections. |
-| <a id="collection"></a> `collection` | `string` | The MongoDB collection name to operate on. |
-| <a id="maxpoolsize"></a> `maxPoolSize?` | `number` | Maximum number of connections in the connection pool. |
+The password for MongoDB authentication.
 
-### type-aliases
+***
+
+### dbUserName?
+
+```ts
+optional dbUserName?: string;
+```
 
-  ### <a id="BaseMongoSdkConfig"></a>BaseMongoSdkConfig
+The username for MongoDB authentication.
+
+        ### <a id="BaseMongoSdkPublicConfig"></a>BaseMongoSdkPublicConfig
 
 [**@xylabs/mongo**](#../README)
 
 ***
 
+Public configuration options for the Mongo SDK, safe to expose to clients.
+
+## Properties
+
+### closeDelay?
+
 ```ts
-type BaseMongoSdkConfig = BaseMongoSdkPublicConfig & BaseMongoSdkPrivateConfig;
+optional closeDelay?: number;
 ```
 
-Combined public and private MongoDB SDK configuration.
+Delay in milliseconds before closing idle connections.
 
+***
 
-Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
+### collection
 
-## Maintainers
+```ts
+collection: string;
+```
 
--   [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
--   [Matt Jones](https://github.com/jonesmac)
--   [Joel Carter](https://github.com/JoelBCarter)
--   [Jordan Trouw](https://github.com/jordantrouw)
+The MongoDB collection name to operate on.
 
-## License
+***
 
-> See the [LICENSE](LICENSE) file for license details
+### maxPoolSize?
 
-## Credits
+```ts
+optional maxPoolSize?: number;
+```
 
-[Made with 🔥 and ❄️ by XYLabs](https://xylabs.com)
+Maximum number of connections in the connection pool.
 
-[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
+      ### type-aliases
 
-[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
-[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
-[npm-badge]: https://img.shields.io/npm/v/@xylabs/mongo.svg
-[npm-link]: https://www.npmjs.com/package/@xylabs/mongo
-[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
-[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
-[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
-[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
-[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
-[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json
+        ### <a id="BaseMongoSdkConfig"></a>BaseMongoSdkConfig
+
+[**@xylabs/mongo**](#../README)
+
+***
+
+```ts
+type BaseMongoSdkConfig = BaseMongoSdkPublicConfig & BaseMongoSdkPrivateConfig;
+```
 
-[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/mongo
-[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/mongo
+Combined public and private MongoDB SDK configuration.
 
-[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/mongo/badge
-[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/mongo
 
-[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/mongo
-[socket-link]: https://socket.dev/npm/package/@xylabs/mongo
+[npm-badge]: https://img.shields.io/npm/v/@xylabs/mongo.svg
+[npm-link]: https://www.npmjs.com/package/@xylabs/mongo
+[license-badge]: https://img.shields.io/npm/l/@xylabs/mongo.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/mongo",
-  "version": "5.0.95",
+  "version": "5.0.97",
   "description": "Base functionality used throughout XYO TypeScript/JavaScript libraries that access Mongo DB",
   "keywords": [
     "mongo",
@@ -33,12 +33,10 @@
         "types": "./dist/node/index.d.ts",
         "default": "./dist/node/index.mjs"
       },
-      "import": "./dist/node/index.mjs",
       "default": "./dist/node/index.mjs"
     },
     "./package.json": "./package.json"
   },
-  "types": "./dist/node/index.d.ts",
   "files": [
     "dist",
     "!**/*.bench.*",
@@ -47,18 +45,21 @@
     "README.md"
   ],
   "dependencies": {
-    "@xylabs/assert": "~5.0.95"
+    "@xylabs/assert": "~5.0.97"
   },
   "devDependencies": {
-    "@xylabs/tsconfig": "~7.8.4",
+    "@xylabs/tsconfig": "~7.10.4",
     "mongodb": "^7.1.1",
     "typescript": "^5",
-    "vite": "^8.0.5",
-    "vitest": "^4.1.2"
+    "vite": "^8.0.8",
+    "vitest": "^4.1.4"
   },
   "peerDependencies": {
     "mongodb": "^6 || ^7"
   },
+  "engines": {
+    "node": ">=18"
+  },
   "publishConfig": {
     "access": "public"
   }