@xyo-network/archivist-model-mongodb 5.3.25 → 5.3.26

package/README.md

@@ -1,23 +1,320 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/archivist-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}}
+```
+
+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__archivist-model-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
+
+      ### archivist
+
+        ### packages
+
+          ### mongodb
+
+            ### packages
+
+              ### model
+
+                ### .temp-typedoc
+
+                  ### interfaces
+
+                    ### <a id="ArchivistLabels"></a>ArchivistLabels
+
+[**@xyo-network/archivist-model-mongodb**](#../README)
+
+***
+
+## Extends
+
+- `Labels`
+
+## Indexable
+
+```ts
+[key: string]: string | undefined
+```
+
+## Properties
+
+### network.xyo.archivist.persistence.scope
+
+```ts
+network.xyo.archivist.persistence.scope: "memory" | "thread" | "process" | "disk" | "network";
+```
+
+                    ### <a id="MongoDBArchivistParams"></a>MongoDBArchivistParams
+
+[**@xyo-network/archivist-model-mongodb**](#../README)
+
+***
+
+## Extends
+
+- `ArchivistParams`\<`AnyConfigSchema`\<[`MongoDBArchivistConfig`](#../type-aliases/MongoDBArchivistConfig)\>\>
+
+## Properties
+
+### keys?
+
+```ts
+optional keys?: ArchivistKeyParams<BrandedHash, Payload, BrandedHash>;
+```
+
+### Inherited from
+
+```ts
+ArchivistParams.keys
+```
+
+***
+
+### parents?
+
+```ts
+optional parents?: ArchivistParentInstances;
+```
+
+### Inherited from
+
+```ts
+ArchivistParams.parents
+```
+
+***
+
+### values?
+
+```ts
+optional values?: ArchivistValueParams<Payload, Payload>;
+```
+
+### Inherited from
+
+```ts
+ArchivistParams.values
+```
+
+***
+
+### boundWitnessSdkConfig
+
+```ts
+boundWitnessSdkConfig: BaseMongoSdkPrivateConfig & Partial<BaseMongoSdkPublicConfig>;
+```
+
+***
+
+### payloadSdkConfig
+
+```ts
+payloadSdkConfig: BaseMongoSdkPrivateConfig & Partial<BaseMongoSdkPublicConfig>;
+```
+
+***
+
+### account?
+
+```ts
+optional account?: AccountInstance | "random";
+```
+
+### Inherited from
+
+```ts
+ArchivistParams.account
+```
+
+***
+
+### addToResolvers?
+
+```ts
+optional addToResolvers?: boolean;
+```
+
+### Inherited from
+
+```ts
+ArchivistParams.addToResolvers
+```
+
+***
+
+### additionalSigners?
+
+```ts
+optional additionalSigners?: AccountInstance[];
+```
+
+### Inherited from
+
+```ts
+ArchivistParams.additionalSigners
+```
+
+***
+
+### allowNameResolution?
+
+```ts
+optional allowNameResolution?: boolean;
+```
+
+### Inherited from
+
+```ts
+ArchivistParams.allowNameResolution
+```
+
+***
+
+### config
+
+```ts
+config: Partial<TConfig>;
+```
+
+### Inherited from
+
+```ts
+ArchivistParams.config
+```
+
+***
+
+### ephemeralQueryAccountEnabled?
+
+```ts
+optional ephemeralQueryAccountEnabled?: boolean;
+```
+
+### Inherited from
+
+```ts
+ArchivistParams.ephemeralQueryAccountEnabled
+```
+
+***
+
+### moduleIdentifierTransformers?
+
+```ts
+optional moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
+```
+
+### Inherited from
+
+```ts
+ArchivistParams.moduleIdentifierTransformers
+```
+
+***
+
+### statusReporter?
+
+```ts
+optional statusReporter?: ModuleStatusReporter;
+```
+
+Optional reporter for broadcasting status changes.
+
+### Inherited from
+
+```ts
+ArchivistParams.statusReporter
+```
+
+                  ### type-aliases
+
+                    ### <a id="MongoDBArchivistConfig"></a>MongoDBArchivistConfig
+
+[**@xyo-network/archivist-model-mongodb**](#../README)
+
+***
+
+```ts
+type MongoDBArchivistConfig = ArchivistConfig<{
+  boundWitnessSdkConfig?: Partial<BaseMongoSdkPublicConfig>;
+  payloadSdkConfig?: Partial<BaseMongoSdkPublicConfig>;
+  schema: MongoDBArchivistConfigSchema;
+}>;
+```
+
+                    ### <a id="MongoDBArchivistConfigSchema"></a>MongoDBArchivistConfigSchema
+
+[**@xyo-network/archivist-model-mongodb**](#../README)
+
+***
+
+```ts
+type MongoDBArchivistConfigSchema = typeof MongoDBArchivistConfigSchema;
+```
+
+                  ### variables
+
+                    ### <a id="MongoDBArchivistConfigSchema"></a>MongoDBArchivistConfigSchema
+
+[**@xyo-network/archivist-model-mongodb**](#../README)
+
+***
+
+```ts
+const MongoDBArchivistConfigSchema: "network.xyo.archivist.mongodb.config" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
 
-## Credits
+```ts
+readonly __schema: true;
+```
 
-[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/archivist-model-mongodb.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/archivist-model-mongodb
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/archivist-model-mongodb.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/archivist-model-mongodb",
-  "version": "5.3.25",
+  "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,27 +36,27 @@
     "README.md"
   ],
   "dependencies": {
-    "@xyo-network/archivist-model": "~5.3.25",
-    "@xyo-network/payload-model": "~5.3.25",
-    "@xyo-network/module-model": "~5.3.25"
+    "@xyo-network/payload-model": "~5.3.26",
+    "@xyo-network/archivist-model": "~5.3.26",
+    "@xyo-network/module-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/archivist-model": "~5.3.25",
-    "@xyo-network/module-model": "~5.3.25",
-    "@xyo-network/payload-model": "~5.3.25"
+    "@xyo-network/payload-model": "~5.3.26",
+    "@xyo-network/module-model": "~5.3.26",
+    "@xyo-network/archivist-model": "~5.3.26"
   },
   "peerDependencies": {
     "@xylabs/mongo": "^5",
@@ -67,9 +64,6 @@
     "mongodb": "^6 || ^7",
     "zod": "^4"
   },
-  "engines": {
-    "node": ">=16"
-  },
   "publishConfig": {
     "access": "public"
   }