@xyo-network/module-model-mongodb 5.3.24 → 5.3.26

package/README.md

@@ -1,23 +1,558 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/module-model-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}}
+```
 
-Version: 5.0.2
+Using yarn:
 
-Primary SDK for using XYO Protocol 2.0
+```sh
+yarn add {{name}}
+```
 
-## Documentation
+Using pnpm:
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__module-model-mongodb)
+```sh
+pnpm add {{name}}
+```
+
+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
+
+            ### packages
+
+              ### model
+
+                ### .temp-typedoc
+
+                  ### interfaces
+
+                    ### <a id="MongoDBModule"></a>MongoDBModule
+
+[**@xyo-network/module-model-mongodb**](#../README)
+
+***
+
+## Accessors
+
+### boundWitnessSdkConfig
+
+### Get Signature
+
+```ts
+get boundWitnessSdkConfig(): BaseMongoSdkConfig;
+```
+
+#### Returns
+
+`BaseMongoSdkConfig`
+
+***
+
+### boundWitnesses
+
+### Get Signature
+
+```ts
+get boundWitnesses(): BaseMongoSdk<BoundWitnessWithMongoMeta>;
+```
+
+#### Returns
+
+`BaseMongoSdk`\<`BoundWitnessWithMongoMeta`\>
+
+***
+
+### payloadSdkConfig
+
+### Get Signature
+
+```ts
+get payloadSdkConfig(): BaseMongoSdkConfig;
+```
+
+#### Returns
+
+`BaseMongoSdkConfig`
+
+***
+
+### payloads
+
+### Get Signature
+
+```ts
+get payloads(): BaseMongoSdk<PayloadWithMongoMeta>;
+```
+
+#### Returns
+
+`BaseMongoSdk`\<`PayloadWithMongoMeta`\>
+
+                    ### <a id="MongoDBModuleParams"></a>MongoDBModuleParams
+
+[**@xyo-network/module-model-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-model-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-model-mongodb**](#../README)
+
+***
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`MongoDBStorageClassLabels`](#MongoDBStorageClassLabels) = [`MongoDBStorageClassLabels`](#MongoDBStorageClassLabels)
+
+## Properties
+
+### labels
+
+```ts
+labels: T;
+```
+
+                    ### <a id="MongoDBModuleV2"></a>MongoDBModuleV2
+
+[**@xyo-network/module-model-mongodb**](#../README)
+
+***
+
+## Accessors
+
+### payloadSdkConfig
+
+### Get Signature
+
+```ts
+get payloadSdkConfig(): BaseMongoSdkConfig;
+```
+
+#### Returns
+
+`BaseMongoSdkConfig`
+
+***
+
+### payloads
+
+### Get Signature
+
+```ts
+get payloads(): BaseMongoSdk<PayloadWithMongoMeta>;
+```
+
+#### Returns
+
+`BaseMongoSdk`\<`PayloadWithMongoMeta`\>
+
+                    ### <a id="MongoDBStorageClassLabels"></a>MongoDBStorageClassLabels
+
+[**@xyo-network/module-model-mongodb**](#../README)
+
+***
+
+## Extends
+
+- `Labels`
+
+## Indexable
+
+```ts
+[key: string]: string | undefined
+```
+
+## Properties
+
+### network.xyo.storage.class
+
+```ts
+network.xyo.storage.class: "mongodb";
+```
+
+                  ### type-aliases
+
+                    ### <a id="MongoDBModuleConfig"></a>MongoDBModuleConfig
+
+[**@xyo-network/module-model-mongodb**](#../README)
+
+***
+
+```ts
+type MongoDBModuleConfig = ModuleConfig<{
+  boundWitnessSdkConfig?: Partial<BaseMongoSdkPublicConfig>;
+  payloadSdkConfig?: Partial<BaseMongoSdkPublicConfig>;
+  schema: MongoDBModuleConfigSchema;
+}>;
+```
+
+                    ### <a id="MongoDBModuleConfigSchema"></a>MongoDBModuleConfigSchema
+
+[**@xyo-network/module-model-mongodb**](#../README)
+
+***
+
+```ts
+type MongoDBModuleConfigSchema = typeof MongoDBModuleConfigSchema;
+```
+
+                    ### <a id="MongoDBModuleConfigV2"></a>MongoDBModuleConfigV2
+
+[**@xyo-network/module-model-mongodb**](#../README)
+
+***
+
+```ts
+type MongoDBModuleConfigV2 = ModuleConfig<{
+  max?: number;
+  payloadSdkConfig?: Partial<BaseMongoSdkPublicConfig>;
+  schema: MongoDBModuleConfigSchema;
+}>;
+```
+
+                  ### variables
+
+                    ### <a id="MongoDBModuleConfigSchema"></a>MongoDBModuleConfigSchema
+
+[**@xyo-network/module-model-mongodb**](#../README)
+
+***
+
+```ts
+const MongoDBModuleConfigSchema: "network.xyo.module.mongodb.config" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                    ### <a id="MongoDBStorageClassLabels"></a>MongoDBStorageClassLabels
+
+[**@xyo-network/module-model-mongodb**](#../README)
+
+***
 
-## Credits
+```ts
+MongoDBStorageClassLabels: MongoDBStorageClassLabels;
+```
 
-[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-model-mongodb.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/module-model-mongodb
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/module-model-mongodb.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/module-model-mongodb",
-  "version": "5.3.24",
+  "version": "5.3.26",
   "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,29 +36,29 @@
     "README.md"
   ],
   "dependencies": {
-    "@xyo-network/module-model": "~5.3.24",
-    "@xyo-network/shared": "~5.3.24",
-    "@xyo-network/payload-model": "~5.3.24",
-    "@xyo-network/payload-mongodb": "~5.3.24"
+    "@xyo-network/module-model": "~5.3.26",
+    "@xyo-network/payload-mongodb": "~5.3.26",
+    "@xyo-network/shared": "~5.3.26",
+    "@xyo-network/payload-model": "~5.3.26"
   },
   "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",
+    "@types/node": "^25.5.2",
+    "@xylabs/mongo": "^5.0.94",
+    "@xylabs/sdk-js": "^5.0.94",
+    "@xylabs/ts-scripts-common": "~7.7.5",
+    "@xylabs/ts-scripts-pnpm": "~7.7.5",
+    "@xylabs/tsconfig": "~7.7.5",
     "acorn": "^8.16.0",
     "axios": "^1.14.0",
     "esbuild": "^0.28.0",
     "mongodb": "~7.1.1",
     "typescript": "~5.9.3",
     "zod": "^4.3.6",
-    "@xyo-network/module-model": "~5.3.24",
-    "@xyo-network/payload-model": "~5.3.24",
-    "@xyo-network/shared": "~5.3.24",
-    "@xyo-network/payload-mongodb": "~5.3.24"
+    "@xyo-network/payload-model": "~5.3.26",
+    "@xyo-network/module-model": "~5.3.26",
+    "@xyo-network/payload-mongodb": "~5.3.26",
+    "@xyo-network/shared": "~5.3.26"
   },
   "peerDependencies": {
     "@xylabs/mongo": "^5",
@@ -69,9 +66,6 @@
     "mongodb": "^6 || ^7",
     "zod": "^4"
   },
-  "engines": {
-    "node": ">=16"
-  },
   "publishConfig": {
     "access": "public"
   }