@xyo-network/payload-mongodb 5.3.24 → 5.3.26

package/README.md

@@ -1,23 +1,447 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/payload-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:
 
-Version: 5.0.2
+```sh
+npm install {{name}}
+```
 
-Primary SDK for using XYO Protocol 2.0
+Using yarn:
 
-## Documentation
+```sh
+yarn add {{name}}
+```
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__payload-mongodb)
+Using pnpm:
+
+```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
+
+              ### payload
+
+                ### .temp-typedoc
+
+                  ### functions
+
+                    ### <a id="boundWitnessFromDbRepresentation"></a>boundWitnessFromDbRepresentation
+
+[**@xyo-network/payload-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="boundWitnessToDbRepresentation"></a>boundWitnessToDbRepresentation
+
+[**@xyo-network/payload-mongodb**](#../README)
+
+***
+
+```ts
+function boundWitnessToDbRepresentation<T>(bw): BoundWitnessMongoMeta<WithStorageMeta<T>>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object`
+
+## Parameters
+
+### bw
+
+`WithStorageMeta`\<`T`\>
+
+## Returns
+
+[`BoundWitnessMongoMeta`](#../type-aliases/BoundWitnessMongoMeta)\<`WithStorageMeta`\<`T`\>\>
+
+                    ### <a id="fromDbRepresentation"></a>fromDbRepresentation
+
+[**@xyo-network/payload-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/payload-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`\>
+
+                    ### <a id="payloadToDbRepresentation"></a>payloadToDbRepresentation
+
+[**@xyo-network/payload-mongodb**](#../README)
+
+***
+
+```ts
+function 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="toDbRepresentation"></a>toDbRepresentation
+
+[**@xyo-network/payload-mongodb**](#../README)
+
+***
+
+```ts
+function toDbRepresentation<T>(value): PayloadWithMongoMeta<WithStorageMeta<T>>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* 
+  \| `Payload`
+  \| \{
+  `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
+
+`WithStorageMeta`\<`T`\>
+
+## Returns
+
+[`PayloadWithMongoMeta`](#../type-aliases/PayloadWithMongoMeta)\<`WithStorageMeta`\<`T`\>\>
+
+                  ### interfaces
+
+                    ### <a id="PayloadMongoMeta"></a>PayloadMongoMeta
+
+[**@xyo-network/payload-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/payload-mongodb**](#../README)
+
+***
+
+```ts
+type BoundWitnessMongoMeta<P> = PayloadWithMongoMeta<P & object>;
+```
+
+## Type Parameters
+
+### P
+
+`P` *extends* `Payload` = `Payload`
+
+                    ### <a id="BoundWitnessWithMongoMeta"></a>BoundWitnessWithMongoMeta
+
+[**@xyo-network/payload-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/payload-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="PayloadWithMongoMeta"></a>PayloadWithMongoMeta
+
+[**@xyo-network/payload-mongodb**](#../README)
+
+***
+
+```ts
+type PayloadWithMongoMeta<T> = T & PayloadMongoMeta;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Payload` = `Payload`
+
+                    ### <a id="PayloadWithPartialMongoMeta"></a>PayloadWithPartialMongoMeta
+
+[**@xyo-network/payload-mongodb**](#../README)
+
+***
+
+```ts
+type PayloadWithPartialMongoMeta<T> = T & Partial<PayloadMongoMeta>;
+```
+
+## Type Parameters
+
+### T
 
-## Credits
+`T` *extends* `Payload` = `Payload`
 
-[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/payload-mongodb.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/payload-mongodb
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/payload-mongodb.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/payload-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,33 +36,30 @@
     "README.md"
   ],
   "dependencies": {
-    "@xyo-network/boundwitness-model": "~5.3.24",
-    "@xyo-network/payload-builder": "~5.3.24",
-    "@xyo-network/payload-model": "~5.3.24"
+    "@xyo-network/boundwitness-model": "~5.3.26",
+    "@xyo-network/payload-builder": "~5.3.26",
+    "@xyo-network/payload-model": "~5.3.26"
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.9.1",
-    "@types/node": "^25.5.0",
-    "@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/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",
     "typescript": "~5.9.3",
     "zod": "^4.3.6",
-    "@xyo-network/boundwitness-model": "~5.3.24",
-    "@xyo-network/payload-builder": "~5.3.24",
-    "@xyo-network/payload-model": "~5.3.24"
+    "@xyo-network/payload-builder": "~5.3.26",
+    "@xyo-network/payload-model": "~5.3.26",
+    "@xyo-network/boundwitness-model": "~5.3.26"
   },
   "peerDependencies": {
     "@xylabs/sdk-js": "^5",
     "zod": "^4"
   },
-  "engines": {
-    "node": ">=16"
-  },
   "publishConfig": {
     "access": "public"
   }