@xyo-network/module-mongodb 5.3.25 → 5.3.27

package/README.md

@@ -1,23 +1,1314 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/module-mongodb
 
-[![logo][]](https://xyo.network)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
+
+> Primary SDK for using XYO Protocol 2.0
+
+## Install
+
+Using npm:
+
+```sh
+npm install {{name}}
+```
+
+Using yarn:
 
-Version: 5.0.2
+```sh
+yarn add {{name}}
+```
 
-Primary SDK for using XYO Protocol 2.0
+Using pnpm:
 
-## Documentation
+```sh
+pnpm add {{name}}
+```
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__module-mongodb)
+Using bun:
+
+```sh
+bun add {{name}}
+```
 
-Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
 
 ## License
 
-> See the [LICENSE](LICENSE) file for license details
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
+
+## Reference
+
+### packages
+
+  ### modules
+
+    ### packages
+
+      ### module
+
+        ### packages
+
+          ### mongodb
+
+            ### .temp-typedoc
+
+              ### functions
+
+                ### <a id="boundWitnessFromDbRepresentation"></a>boundWitnessFromDbRepresentation
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+function boundWitnessFromDbRepresentation<T>(value): WithStorageMeta<T>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object` = \{
+  `schema`: `"network.xyo.boundwitness"` & `object`;
+  `addresses`: `Lowercase`\<`string`\> & `object` & `object`[];
+  `payload_hashes`: `BrandedHash`[];
+  `payload_schemas`: `BrandedSchema`\<`string`\>[];
+  `previous_hashes`: (`BrandedHash` \| `null`)[];
+  `$destination?`: `Lowercase`\<`string`\> & `object` & `object`;
+  `$sourceQuery?`: `BrandedHash`;
+  `$signatures`: (`BrandedHex` \| `null`)[];
+\}
+
+## Parameters
+
+### value
+
+[`BoundWitnessWithMongoMeta`](#../type-aliases/BoundWitnessWithMongoMeta)\<`T`\>
+
+## Returns
+
+`WithStorageMeta`\<`T`\>
+
+                ### <a id="fromDbRepresentation"></a>fromDbRepresentation
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+function fromDbRepresentation<T>(value): WithStorageMeta<T>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Payload` = `Payload`
+
+## Parameters
+
+### value
+
+[`PayloadWithMongoMeta`](#../type-aliases/PayloadWithMongoMeta)\<`T`\>
+
+## Returns
+
+`WithStorageMeta`\<`T`\>
+
+                ### <a id="payloadFromDbRepresentation"></a>payloadFromDbRepresentation
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+function payloadFromDbRepresentation<T>(value): WithStorageMeta<T>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Payload` = \{
+\[`key`: `string`\]: `unknown`;
+  `schema`: `BrandedSchema`\<`string`\>;
+\}
+
+## Parameters
+
+### value
+
+[`PayloadWithMongoMeta`](#../type-aliases/PayloadWithMongoMeta)\<`T`\>
+
+## Returns
+
+`WithStorageMeta`\<`T`\>
+
+              ### interfaces
+
+                ### <a id="MongoDBModule"></a>MongoDBModule
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+## Accessors
+
+### boundWitnessSdkConfig
+
+### Get Signature
+
+```ts
+get boundWitnessSdkConfig(): BaseMongoSdkConfig;
+```
+
+#### Returns
+
+`BaseMongoSdkConfig`
+
+***
+
+### boundWitnesses
+
+### Get Signature
+
+```ts
+get boundWitnesses(): BaseMongoSdk<BoundWitnessWithMongoMeta>;
+```
+
+#### Returns
+
+`BaseMongoSdk`\<[`BoundWitnessWithMongoMeta`](#../type-aliases/BoundWitnessWithMongoMeta)\>
+
+***
+
+### payloadSdkConfig
+
+### Get Signature
+
+```ts
+get payloadSdkConfig(): BaseMongoSdkConfig;
+```
+
+#### Returns
+
+`BaseMongoSdkConfig`
+
+***
+
+### payloads
+
+### Get Signature
+
+```ts
+get payloads(): BaseMongoSdk<PayloadWithMongoMeta>;
+```
+
+#### Returns
+
+`BaseMongoSdk`\<[`PayloadWithMongoMeta`](#../type-aliases/PayloadWithMongoMeta)\>
+
+                ### <a id="MongoDBModuleParams"></a>MongoDBModuleParams
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+## Extends
+
+- `QueryableModuleParams`\<`AnyConfigSchema`\<[`MongoDBModuleConfig`](#../type-aliases/MongoDBModuleConfig)\>\>
+
+## Properties
+
+### account?
+
+```ts
+optional account?: AccountInstance | "random";
+```
+
+### Inherited from
+
+[`MongoDBModuleParamsV2`](#MongoDBModuleParamsV2).[`account`](MongoDBModuleParamsV2.md#account)
+
+***
+
+### addToResolvers?
+
+```ts
+optional addToResolvers?: boolean;
+```
+
+### Inherited from
+
+[`MongoDBModuleParamsV2`](#MongoDBModuleParamsV2).[`addToResolvers`](MongoDBModuleParamsV2.md#addtoresolvers)
+
+***
+
+### additionalSigners?
+
+```ts
+optional additionalSigners?: AccountInstance[];
+```
+
+### Inherited from
+
+[`MongoDBModuleParamsV2`](#MongoDBModuleParamsV2).[`additionalSigners`](MongoDBModuleParamsV2.md#additionalsigners)
+
+***
+
+### allowNameResolution?
+
+```ts
+optional allowNameResolution?: boolean;
+```
+
+### Inherited from
+
+[`MongoDBModuleParamsV2`](#MongoDBModuleParamsV2).[`allowNameResolution`](MongoDBModuleParamsV2.md#allownameresolution)
+
+***
+
+### config
+
+```ts
+config: Partial<TConfig>;
+```
+
+### Inherited from
+
+```ts
+QueryableModuleParams.config
+```
+
+***
+
+### ephemeralQueryAccountEnabled?
+
+```ts
+optional ephemeralQueryAccountEnabled?: boolean;
+```
+
+### Inherited from
+
+[`MongoDBModuleParamsV2`](#MongoDBModuleParamsV2).[`ephemeralQueryAccountEnabled`](MongoDBModuleParamsV2.md#ephemeralqueryaccountenabled)
+
+***
+
+### moduleIdentifierTransformers?
+
+```ts
+optional moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
+```
+
+### Inherited from
+
+[`MongoDBModuleParamsV2`](#MongoDBModuleParamsV2).[`moduleIdentifierTransformers`](MongoDBModuleParamsV2.md#moduleidentifiertransformers)
+
+***
+
+### statusReporter?
+
+```ts
+optional statusReporter?: ModuleStatusReporter;
+```
+
+Optional reporter for broadcasting status changes.
+
+### Inherited from
+
+[`MongoDBModuleParamsV2`](#MongoDBModuleParamsV2).[`statusReporter`](MongoDBModuleParamsV2.md#statusreporter)
+
+***
+
+### boundWitnessSdkConfig?
+
+```ts
+optional boundWitnessSdkConfig?: BaseMongoSdkPrivateConfig & Partial<BaseMongoSdkPublicConfig>;
+```
+
+***
+
+### jobQueue?
+
+```ts
+optional jobQueue?: JobQueue;
+```
+
+***
+
+### payloadSdkConfig?
+
+```ts
+optional payloadSdkConfig?: BaseMongoSdkPrivateConfig & Partial<BaseMongoSdkPublicConfig>;
+```
+
+                ### <a id="MongoDBModuleParamsV2"></a>MongoDBModuleParamsV2
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+## Extends
+
+- `QueryableModuleParams`\<`TConfig`\>
+
+## Type Parameters
+
+### TConfig
+
+`TConfig` *extends* `AnyConfigSchema`\<[`MongoDBModuleConfigV2`](#../type-aliases/MongoDBModuleConfigV2)\> = `AnyConfigSchema`\<[`MongoDBModuleConfigV2`](#../type-aliases/MongoDBModuleConfigV2)\>
+
+## Properties
+
+### account?
+
+```ts
+optional account?: AccountInstance | "random";
+```
+
+### Inherited from
+
+```ts
+QueryableModuleParams.account
+```
+
+***
+
+### addToResolvers?
+
+```ts
+optional addToResolvers?: boolean;
+```
+
+### Inherited from
+
+```ts
+QueryableModuleParams.addToResolvers
+```
+
+***
+
+### additionalSigners?
+
+```ts
+optional additionalSigners?: AccountInstance[];
+```
+
+### Inherited from
+
+```ts
+QueryableModuleParams.additionalSigners
+```
+
+***
+
+### allowNameResolution?
+
+```ts
+optional allowNameResolution?: boolean;
+```
+
+### Inherited from
+
+```ts
+QueryableModuleParams.allowNameResolution
+```
+
+***
+
+### config
+
+```ts
+config: Partial<TConfig>;
+```
+
+### Inherited from
+
+```ts
+QueryableModuleParams.config
+```
+
+***
+
+### ephemeralQueryAccountEnabled?
+
+```ts
+optional ephemeralQueryAccountEnabled?: boolean;
+```
+
+### Inherited from
+
+```ts
+QueryableModuleParams.ephemeralQueryAccountEnabled
+```
+
+***
+
+### moduleIdentifierTransformers?
+
+```ts
+optional moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
+```
+
+### Inherited from
+
+```ts
+QueryableModuleParams.moduleIdentifierTransformers
+```
+
+***
+
+### statusReporter?
+
+```ts
+optional statusReporter?: ModuleStatusReporter;
+```
+
+Optional reporter for broadcasting status changes.
+
+### Inherited from
+
+```ts
+QueryableModuleParams.statusReporter
+```
+
+***
+
+### jobQueue?
+
+```ts
+optional jobQueue?: JobQueue;
+```
+
+***
+
+### payloadSdkConfig?
+
+```ts
+optional payloadSdkConfig?: BaseMongoSdkPrivateConfig & Partial<BaseMongoSdkPublicConfig>;
+```
+
+                ### <a id="MongoDBModuleStatic"></a>MongoDBModuleStatic
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`MongoDBStorageClassLabels`](#MongoDBStorageClassLabels) = [`MongoDBStorageClassLabels`](#MongoDBStorageClassLabels)
+
+## Properties
+
+### labels
+
+```ts
+labels: T;
+```
+
+                ### <a id="MongoDBModuleV2"></a>MongoDBModuleV2
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+## Accessors
+
+### payloadSdkConfig
+
+### Get Signature
+
+```ts
+get payloadSdkConfig(): BaseMongoSdkConfig;
+```
+
+#### Returns
+
+`BaseMongoSdkConfig`
+
+***
+
+### payloads
+
+### Get Signature
+
+```ts
+get payloads(): BaseMongoSdk<PayloadWithMongoMeta>;
+```
+
+#### Returns
+
+`BaseMongoSdk`\<[`PayloadWithMongoMeta`](#../type-aliases/PayloadWithMongoMeta)\>
+
+                ### <a id="MongoDBStorageClassLabels"></a>MongoDBStorageClassLabels
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+## Extends
+
+- `Labels`
+
+## Indexable
+
+```ts
+[key: string]: string | undefined
+```
+
+## Properties
+
+### network.xyo.storage.class
+
+```ts
+network.xyo.storage.class: "mongodb";
+```
+
+                ### <a id="PayloadMongoMeta"></a>PayloadMongoMeta
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+## Extends
+
+- `StorageMeta`
+
+## Properties
+
+### \_hash
+
+```ts
+_hash: BrandedHash;
+```
+
+### Inherited from
+
+```ts
+StorageMeta._hash
+```
+
+***
+
+### \_dataHash
+
+```ts
+_dataHash: BrandedHash;
+```
+
+### Inherited from
+
+```ts
+StorageMeta._dataHash
+```
+
+***
+
+### \_sequence
+
+```ts
+_sequence: LocalSequence | QualifiedSequence;
+```
+
+### Inherited from
+
+```ts
+StorageMeta._sequence
+```
+
+***
+
+### \_\_archive?
+
+```ts
+optional __archive?: string;
+```
+
+***
+
+### \_\_client?
+
+```ts
+optional __client?: string;
+```
+
+***
+
+### \_\_observeDuration?
+
+```ts
+optional __observeDuration?: number;
+```
+
+***
+
+### \_\_schemaValid?
+
+```ts
+optional __schemaValid?: boolean;
+```
+
+***
+
+### \_\_sources?
+
+```ts
+optional __sources?: Payload[];
+```
+
+***
+
+### \_\_timestamp
+
+```ts
+__timestamp: number;
+```
+
+***
+
+### \_\_user\_agent?
+
+```ts
+optional __user_agent?: string;
+```
+
+              ### type-aliases
+
+                ### <a id="BoundWitnessMongoMeta"></a>BoundWitnessMongoMeta
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+type BoundWitnessMongoMeta<P> = PayloadWithMongoMeta<P & object>;
+```
+
+## Type Parameters
+
+### P
+
+`P` *extends* `Payload` = `Payload`
+
+                ### <a id="BoundWitnessWithMongoMeta"></a>BoundWitnessWithMongoMeta
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+type BoundWitnessWithMongoMeta<T, P> = T & BoundWitnessMongoMeta<P>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `BoundWitness` = `BoundWitness`
+
+### P
+
+`P` *extends* [`PayloadWithPartialMongoMeta`](#PayloadWithPartialMongoMeta)\<`T`\> = [`PayloadWithPartialMongoMeta`](#PayloadWithPartialMongoMeta)\<`T`\>
+
+                ### <a id="BoundWitnessWithPartialMongoMeta"></a>BoundWitnessWithPartialMongoMeta
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+type BoundWitnessWithPartialMongoMeta<T, P> = T & Partial<BoundWitnessMongoMeta<P>>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `BoundWitness` = `BoundWitness`
+
+### P
+
+`P` *extends* [`PayloadWithPartialMongoMeta`](#PayloadWithPartialMongoMeta)\<`T`\> = [`PayloadWithPartialMongoMeta`](#PayloadWithPartialMongoMeta)\<`T`\>
+
+                ### <a id="CollectionIndexFunction"></a>CollectionIndexFunction
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+type CollectionIndexFunction = (collectionName) => IndexDescription[];
+```
+
+## Parameters
+
+### collectionName
+
+`string`
+
+## Returns
+
+`IndexDescription`[]
+
+                ### <a id="IndexDescription"></a>IndexDescription
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+type IndexDescription = object;
+```
+
+Description of index(es) to be created on a store
+
+## Properties
+
+### key
+
+```ts
+key: 
+  | {
+[key: string]: IndexDirection;
+}
+| Map<string, IndexDirection>;
+```
+
+The key(s) to index
+
+***
+
+### name?
+
+```ts
+optional name?: string;
+```
+
+The name of the index
+
+***
+
+### unique?
+
+```ts
+optional unique?: boolean;
+```
+
+If true, the index must enforce uniqueness on the key
+
+                ### <a id="IndexDirection"></a>IndexDirection
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+type IndexDirection = -1 | 1;
+```
+
+The index direction (1 for ascending, -1 for descending)
+
+                ### <a id="MongoDBModuleConfig"></a>MongoDBModuleConfig
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+type MongoDBModuleConfig = ModuleConfig<{
+  boundWitnessSdkConfig?: Partial<BaseMongoSdkPublicConfig>;
+  payloadSdkConfig?: Partial<BaseMongoSdkPublicConfig>;
+  schema: MongoDBModuleConfigSchema;
+}>;
+```
+
+                ### <a id="MongoDBModuleConfigSchema"></a>MongoDBModuleConfigSchema
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+type MongoDBModuleConfigSchema = typeof MongoDBModuleConfigSchema;
+```
+
+                ### <a id="MongoDBModuleConfigV2"></a>MongoDBModuleConfigV2
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+type MongoDBModuleConfigV2 = ModuleConfig<{
+  max?: number;
+  payloadSdkConfig?: Partial<BaseMongoSdkPublicConfig>;
+  schema: MongoDBModuleConfigSchema;
+}>;
+```
+
+                ### <a id="MongoDbConnectionStringEnvVar"></a>MongoDbConnectionStringEnvVar
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+type MongoDbConnectionStringEnvVar = "MONGO_CONNECTION_STRING";
+```
+
+                ### <a id="MongoDbEnvVars"></a>MongoDbEnvVars
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+type MongoDbEnvVars = "MONGO_DATABASE" | "MONGO_DOMAIN" | "MONGO_PASSWORD" | "MONGO_USERNAME";
+```
+
+                ### <a id="MongoEnv"></a>MongoEnv
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+type MongoEnv = Record<
+  | MongoDbEnvVars
+| MongoDbConnectionStringEnvVar, string | undefined>;
+```
+
+                ### <a id="PayloadWithMongoMeta"></a>PayloadWithMongoMeta
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+type PayloadWithMongoMeta<T> = T & PayloadMongoMeta;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Payload` = `Payload`
+
+                ### <a id="PayloadWithPartialMongoMeta"></a>PayloadWithPartialMongoMeta
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+type PayloadWithPartialMongoMeta<T> = T & Partial<PayloadMongoMeta>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Payload` = `Payload`
+
+              ### variables
+
+                ### <a id="COLLECTIONS"></a>COLLECTIONS
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+const COLLECTIONS: object;
+```
+
+## Type Declaration
+
+### AddressInfo
+
+```ts
+AddressInfo: "address_info";
+```
+
+### ArchivistStats
+
+```ts
+ArchivistStats: "archivist_stats";
+```
+
+### BoundWitnesses
+
+```ts
+BoundWitnesses: "bound_witnesses";
+```
+
+### Payloads
+
+```ts
+Payloads: "payloads";
+```
+
+### Thumbnails
+
+```ts
+Thumbnails: "thumbnails";
+```
+
+### Users
+
+```ts
+Users: "users";
+```
+
+                ### <a id="DATABASES"></a>DATABASES
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+const DATABASES: object;
+```
+
+## Type Declaration
+
+### Archivist
+
+```ts
+Archivist: "archivist";
+```
+
+                ### <a id="DefaultAggregateTimeoutMs"></a>DefaultAggregateTimeoutMs
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+const DefaultAggregateTimeoutMs: 10000 = 10000;
+```
+
+                ### <a id="DefaultLimit"></a>DefaultLimit
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+const DefaultLimit: 20 = 20;
+```
+
+                ### <a id="DefaultMaxTimeMS"></a>DefaultMaxTimeMS
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+const DefaultMaxTimeMS: 2000 = 2000;
+```
+
+                ### <a id="DefaultOrder"></a>DefaultOrder
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+const DefaultOrder: "desc" = "desc";
+```
+
+                ### <a id="MongoDBModuleConfigSchema"></a>MongoDBModuleConfigSchema
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+const MongoDBModuleConfigSchema: "network.xyo.module.mongodb.config" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                ### <a id="MongoDBModuleMixin"></a>MongoDBModuleMixin
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+const MongoDBModuleMixin: <TParams, TModule>(ModuleBase) => (...args) => object & object & TModule;
+```
+
+## Type Parameters
+
+### TParams
+
+`TParams` *extends* [`MongoDBModuleParams`](#../interfaces/MongoDBModuleParams) = [`MongoDBModuleParams`](#../interfaces/MongoDBModuleParams)
+
+### TModule
+
+`TModule` *extends* `AnyAbstractModule`\<`TParams`\> = `AnyAbstractModule`\<`TParams`\>
+
+## Parameters
+
+### ModuleBase
+
+`TModule`
+
+## Returns
+
+(...`args`) => `object` & `object` & `TModule`
+
+                ### <a id="MongoDBModuleMixinV2"></a>MongoDBModuleMixinV2
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+const MongoDBModuleMixinV2: <TParams, TModule>(ModuleBase) => (...args) => object & object & TModule;
+```
+
+## Type Parameters
+
+### TParams
+
+`TParams` *extends* [`MongoDBModuleParamsV2`](#../interfaces/MongoDBModuleParamsV2) = [`MongoDBModuleParamsV2`](#../interfaces/MongoDBModuleParamsV2)
+
+### TModule
+
+`TModule` *extends* `AnyAbstractModule`\<`TParams`\> = `AnyAbstractModule`\<`TParams`\>
+
+## Parameters
+
+### ModuleBase
+
+`TModule`
+
+## Returns
+
+(...`args`) => `object` & `object` & `TModule`
+
+                ### <a id="MongoDBStorageClassLabels"></a>MongoDBStorageClassLabels
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+MongoDBStorageClassLabels: MongoDBStorageClassLabels;
+```
+
+                ### <a id="boundWitnessToDbRepresentation"></a>boundWitnessToDbRepresentation
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+const boundWitnessToDbRepresentation: <T>(bw) => BoundWitnessMongoMeta<WithStorageMeta<T>>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `BoundWitness`
+
+## Parameters
+
+### bw
+
+`WithStorageMeta`\<`T`\>
+
+## Returns
+
+[`BoundWitnessMongoMeta`](#../type-aliases/BoundWitnessMongoMeta)\<`WithStorageMeta`\<`T`\>\>
+
+                ### <a id="escapeChar"></a>escapeChar
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+const escapeChar: "#" = "#";
+```
+
+                ### <a id="fromDbProperty"></a>fromDbProperty
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+const fromDbProperty: (value) => string;
+```
+
+## Parameters
+
+### value
+
+`string`
+
+## Returns
+
+`string`
+
+                ### <a id="getBaseMongoSdk"></a>getBaseMongoSdk
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+const getBaseMongoSdk: <T>(collection) => BaseMongoSdk<T>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Document`
+
+## Parameters
+
+### collection
+
+`string`
+
+## Returns
+
+`BaseMongoSdk`\<`T`\>
+
+                ### <a id="getBaseMongoSdkPrivateConfig"></a>getBaseMongoSdkPrivateConfig
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+const getBaseMongoSdkPrivateConfig: () => BaseMongoSdkPrivateConfig;
+```
+
+## Returns
+
+`BaseMongoSdkPrivateConfig`
+
+                ### <a id="getMongoDBConfig"></a>getMongoDBConfig
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+const getMongoDBConfig: () => MongoEnv;
+```
+
+## Returns
+
+[`MongoEnv`](#../type-aliases/MongoEnv)
+
+                ### <a id="hasMongoDBConfig"></a>hasMongoDBConfig
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+const hasMongoDBConfig: () => boolean;
+```
+
+## Returns
+
+`boolean`
+
+                ### <a id="payloadToDbRepresentation"></a>payloadToDbRepresentation
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+const payloadToDbRepresentation: <T>(payload) => PayloadWithMongoMeta<WithStorageMeta<T>>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Payload`
+
+## Parameters
+
+### payload
+
+`WithStorageMeta`\<`T`\>
+
+## Returns
+
+[`PayloadWithMongoMeta`](#../type-aliases/PayloadWithMongoMeta)\<`WithStorageMeta`\<`T`\>\>
+
+                ### <a id="toDbProperty"></a>toDbProperty
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+const toDbProperty: (value) => string;
+```
+
+## Parameters
+
+### value
+
+`string`
+
+## Returns
+
+`string`
+
+                ### <a id="toDbRepresentation"></a>toDbRepresentation
+
+[**@xyo-network/module-mongodb**](#../README)
+
+***
+
+```ts
+const toDbRepresentation: <T>(value) => PayloadWithMongoMeta<WithStorageMeta<T>>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Payload` \| `BoundWitness`
+
+## Parameters
+
+### value
+
+`WithStorageMeta`\<`T`\>
+
+## Returns
 
-## Credits
+[`PayloadWithMongoMeta`](#../type-aliases/PayloadWithMongoMeta)\<`WithStorageMeta`\<`T`\>\>
 
-[Made with 🔥 and ❄️ by XYO](https://xyo.network)
 
-[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[npm-badge]: https://img.shields.io/npm/v/@xyo-network/module-mongodb.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/module-mongodb
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/module-mongodb.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/module-mongodb",
-  "version": "5.3.25",
+  "version": "5.3.27",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -21,7 +21,6 @@
   "type": "module",
   "exports": {
     ".": {
-      "browser": {},
       "node": {
         "types": "./dist/node/index.d.ts",
         "default": "./dist/node/index.mjs"
@@ -29,8 +28,6 @@
     },
     "./package.json": "./package.json"
   },
-  "module": "dist/node/index.mjs",
-  "types": "dist/node/index.d.ts",
   "files": [
     "dist",
     "!**/*.bench.*",
@@ -39,41 +36,30 @@
     "README.md"
   ],
   "dependencies": {
-    "@xyo-network/module-model-mongodb": "~5.3.25",
-    "@xyo-network/payload-mongodb": "~5.3.25",
-    "@xyo-network/module-abstract-mongodb": "~5.3.25"
+    "@xyo-network/module-abstract-mongodb": "~5.3.27",
+    "@xyo-network/payload-mongodb": "~5.3.27",
+    "@xyo-network/module-model-mongodb": "~5.3.27"
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.9.1",
-    "@types/node": "^25.5.0",
-    "@xylabs/mongo": "^5.0.93",
-    "@xylabs/sdk-js": "^5.0.93",
-    "@xylabs/ts-scripts-common": "~7.6.16",
-    "@xylabs/ts-scripts-pnpm": "~7.6.16",
-    "@xylabs/tsconfig": "~7.6.16",
-    "acorn": "^8.16.0",
+    "@xylabs/mongo": "^5.0.94",
+    "@xylabs/sdk-js": "^5.0.94",
+    "@xylabs/ts-scripts-common": "~7.7.15",
+    "@xylabs/ts-scripts-pnpm": "~7.7.15",
+    "@xylabs/tsconfig": "~7.7.15",
     "axios": "^1.14.0",
-    "esbuild": "^0.28.0",
     "mongodb": "~7.1.1",
     "tslib": "^2.8.1",
     "typescript": "~5.9.3",
     "zod": "^4.3.6",
-    "@xyo-network/module-abstract-mongodb": "~5.3.25",
-    "@xyo-network/boundwitness-model": "~5.3.25",
-    "@xyo-network/module-model-mongodb": "~5.3.25",
-    "@xyo-network/payload-builder": "~5.3.25",
-    "@xyo-network/module-model": "~5.3.25",
-    "@xyo-network/payload-mongodb": "~5.3.25",
-    "@xyo-network/shared": "~5.3.25",
-    "@xyo-network/payload-model": "~5.3.25"
-  },
-  "peerDependencies": {
-    "@xylabs/sdk-js": "^5",
-    "tslib": "^2.8.1",
-    "zod": "^4"
-  },
-  "engines": {
-    "node": ">=16"
+    "@xyo-network/boundwitness-model": "~5.3.27",
+    "@xyo-network/module-abstract-mongodb": "~5.3.27",
+    "@xyo-network/module-model": "~5.3.27",
+    "@xyo-network/module-model-mongodb": "~5.3.27",
+    "@xyo-network/payload-builder": "~5.3.27",
+    "@xyo-network/payload-mongodb": "~5.3.27",
+    "@xyo-network/payload-model": "~5.3.27",
+    "@xyo-network/shared": "~5.3.27"
   },
   "publishConfig": {
     "access": "public"