@xyo-network/diviner-boundwitness-model 5.3.25 → 5.3.26

package/README.md

@@ -1,23 +1,262 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/diviner-boundwitness-model
 
-[![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__diviner-boundwitness-model)
+```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
+
+      ### diviner
+
+        ### packages
+
+          ### boundwitness
+
+            ### packages
+
+              ### model
+
+                ### .temp-typedoc
+
+                  ### type-aliases
+
+                    ### <a id="BoundWitnessDivinerConfig"></a>BoundWitnessDivinerConfig
+
+[**@xyo-network/diviner-boundwitness-model**](#../README)
+
+***
+
+```ts
+type BoundWitnessDivinerConfig<T> = DivinerConfig<T & object>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Payload` = `Payload`
+
+                    ### <a id="BoundWitnessDivinerConfigSchema"></a>BoundWitnessDivinerConfigSchema
+
+[**@xyo-network/diviner-boundwitness-model**](#../README)
+
+***
+
+```ts
+type BoundWitnessDivinerConfigSchema = typeof BoundWitnessDivinerConfigSchema;
+```
+
+                    ### <a id="BoundWitnessDivinerParams"></a>BoundWitnessDivinerParams
+
+[**@xyo-network/diviner-boundwitness-model**](#../README)
+
+***
+
+```ts
+type BoundWitnessDivinerParams = DivinerParams<AnyConfigSchema<BoundWitnessDivinerConfig>>;
+```
+
+                    ### <a id="BoundWitnessDivinerPredicate"></a>BoundWitnessDivinerPredicate
+
+[**@xyo-network/diviner-boundwitness-model**](#../README)
+
+***
+
+```ts
+type BoundWitnessDivinerPredicate = WithoutSchemas<PayloadDivinerPredicate & Partial<BoundWitness & BoundWitnessDivinerPredicateFields>>;
+```
+
+                    ### <a id="BoundWitnessDivinerPredicateFields"></a>BoundWitnessDivinerPredicateFields
+
+[**@xyo-network/diviner-boundwitness-model**](#../README)
+
+***
+
+```ts
+type BoundWitnessDivinerPredicateFields = object;
+```
+
+## Properties
+
+### destination
+
+```ts
+destination: string[];
+```
+
+***
+
+### sourceQuery
+
+```ts
+sourceQuery: string;
+```
+
+                    ### <a id="BoundWitnessDivinerQueryPayload"></a>BoundWitnessDivinerQueryPayload
+
+[**@xyo-network/diviner-boundwitness-model**](#../README)
+
+***
+
+```ts
+type BoundWitnessDivinerQueryPayload = Query<object & BoundWitnessDivinerPredicate>;
+```
+
+                    ### <a id="BoundWitnessDivinerQuerySchema"></a>BoundWitnessDivinerQuerySchema
+
+[**@xyo-network/diviner-boundwitness-model**](#../README)
+
+***
+
+```ts
+type BoundWitnessDivinerQuerySchema = typeof BoundWitnessDivinerQuerySchema;
+```
+
+                    ### <a id="BoundWitnessDivinerSchema"></a>BoundWitnessDivinerSchema
+
+[**@xyo-network/diviner-boundwitness-model**](#../README)
+
+***
+
+```ts
+type BoundWitnessDivinerSchema = typeof BoundWitnessDivinerSchema;
+```
+
+                    ### <a id="WithoutSchemas"></a>WithoutSchemas
+
+[**@xyo-network/diviner-boundwitness-model**](#../README)
+
+***
+
+```ts
+type WithoutSchemas<T> = Omit<Omit<T, "schema">, "schemas">;
+```
+
+## Type Parameters
+
+### T
+
+`T`
+
+                  ### variables
+
+                    ### <a id="BoundWitnessDivinerConfigSchema"></a>BoundWitnessDivinerConfigSchema
+
+[**@xyo-network/diviner-boundwitness-model**](#../README)
+
+***
+
+```ts
+const BoundWitnessDivinerConfigSchema: string & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                    ### <a id="BoundWitnessDivinerQuerySchema"></a>BoundWitnessDivinerQuerySchema
+
+[**@xyo-network/diviner-boundwitness-model**](#../README)
+
+***
+
+```ts
+const BoundWitnessDivinerQuerySchema: string & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                    ### <a id="BoundWitnessDivinerSchema"></a>BoundWitnessDivinerSchema
+
+[**@xyo-network/diviner-boundwitness-model**](#../README)
+
+***
+
+```ts
+const BoundWitnessDivinerSchema: "network.xyo.diviner.boundwitness" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                    ### <a id="isBoundWitnessDivinerQueryPayload"></a>isBoundWitnessDivinerQueryPayload
+
+[**@xyo-network/diviner-boundwitness-model**](#../README)
+
+***
+
+```ts
+const isBoundWitnessDivinerQueryPayload: (x?) => x is BoundWitnessDivinerQueryPayload;
+```
+
+## Parameters
+
+### x?
+
+`unknown`
+
+## Returns
 
-## Credits
+`x is BoundWitnessDivinerQueryPayload`
 
-[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/diviner-boundwitness-model.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/diviner-boundwitness-model
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/diviner-boundwitness-model.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/diviner-boundwitness-model",
-  "version": "5.3.25",
+  "version": "5.3.26",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -22,11 +22,11 @@
   "exports": {
     ".": {
       "types": "./dist/neutral/index.d.ts",
+      "import": "./dist/neutral/index.mjs",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
-  "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "files": [
     "dist",
@@ -36,29 +36,29 @@
     "README.md"
   ],
   "dependencies": {
-    "@xyo-network/boundwitness-model": "~5.3.25",
-    "@xyo-network/diviner-model": "~5.3.25",
-    "@xyo-network/module-model": "~5.3.25",
-    "@xyo-network/payload-model": "~5.3.25",
-    "@xyo-network/diviner-payload-model": "~5.3.25"
+    "@xyo-network/boundwitness-model": "~5.3.26",
+    "@xyo-network/diviner-model": "~5.3.26",
+    "@xyo-network/module-model": "~5.3.26",
+    "@xyo-network/payload-model": "~5.3.26",
+    "@xyo-network/diviner-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/diviner-model": "~5.3.25",
-    "@xyo-network/diviner-payload-model": "~5.3.25",
-    "@xyo-network/boundwitness-model": "~5.3.25",
-    "@xyo-network/payload-model": "~5.3.25",
-    "@xyo-network/module-model": "~5.3.25"
+    "@xyo-network/boundwitness-model": "~5.3.26",
+    "@xyo-network/diviner-model": "~5.3.26",
+    "@xyo-network/diviner-payload-model": "~5.3.26",
+    "@xyo-network/module-model": "~5.3.26",
+    "@xyo-network/payload-model": "~5.3.26"
   },
   "peerDependencies": {
     "@xylabs/sdk-js": "^5",