@xyo-network/diviner-range-model 5.3.24 → 5.3.26

package/README.md

@@ -1,23 +1,351 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/diviner-range-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}}
+```
+
+Using yarn:
+
+```sh
+yarn add {{name}}
+```
 
-Version: 5.0.2
+Using pnpm:
 
-Primary SDK for using XYO Protocol 2.0
+```sh
+pnpm add {{name}}
+```
 
-## Documentation
+Using bun:
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__diviner-range-model)
+```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
+
+          ### range
+
+            ### packages
+
+              ### model
+
+                ### .temp-typedoc
+
+                  ### functions
+
+                    ### <a id="isBigIntRangePayload"></a>isBigIntRangePayload
+
+[**@xyo-network/diviner-range-model**](#../README)
+
+***
+
+```ts
+function isBigIntRangePayload(payload?): payload is BigIntRangePayload;
+```
+
+## Parameters
+
+### payload?
+
+`unknown`
+
+## Returns
+
+`payload is BigIntRangePayload`
+
+                    ### <a id="isNumberRangePayload"></a>isNumberRangePayload
+
+[**@xyo-network/diviner-range-model**](#../README)
+
+***
+
+```ts
+function isNumberRangePayload(payload?): payload is NumberRangePayload;
+```
+
+## Parameters
+
+### payload?
+
+`unknown`
+
+## Returns
+
+`payload is NumberRangePayload`
+
+                  ### type-aliases
+
+                    ### <a id="BigIntPayload"></a>BigIntPayload
+
+[**@xyo-network/diviner-range-model**](#../README)
+
+***
+
+```ts
+type BigIntPayload = Payload<{
+  value: Hex;
+}, BigIntSchema>;
+```
+
+                    ### <a id="BigIntRangePayload"></a>BigIntRangePayload
+
+[**@xyo-network/diviner-range-model**](#../README)
+
+***
+
+```ts
+type BigIntRangePayload = RangePayloadBase<Hex>;
+```
+
+                    ### <a id="BigIntSchema"></a>BigIntSchema
+
+[**@xyo-network/diviner-range-model**](#../README)
+
+***
+
+```ts
+type BigIntSchema = typeof BigIntSchema;
+```
+
+                    ### <a id="NumberPayload"></a>NumberPayload
+
+[**@xyo-network/diviner-range-model**](#../README)
+
+***
+
+```ts
+type NumberPayload = Payload<{
+  value: number;
+}, NumberSchema>;
+```
+
+                    ### <a id="NumberRangePayload"></a>NumberRangePayload
+
+[**@xyo-network/diviner-range-model**](#../README)
+
+***
+
+```ts
+type NumberRangePayload = RangePayloadBase<number>;
+```
+
+                    ### <a id="NumberSchema"></a>NumberSchema
+
+[**@xyo-network/diviner-range-model**](#../README)
+
+***
+
+```ts
+type NumberSchema = typeof NumberSchema;
+```
+
+                    ### <a id="RangeDivinerConfig"></a>RangeDivinerConfig
+
+[**@xyo-network/diviner-range-model**](#../README)
+
+***
+
+```ts
+type RangeDivinerConfig = DivinerConfig<{
+  ranges?: RangePayload[];
+}, RangeDivinerConfigSchema>;
+```
+
+                    ### <a id="RangeDivinerConfigSchema"></a>RangeDivinerConfigSchema
+
+[**@xyo-network/diviner-range-model**](#../README)
+
+***
+
+```ts
+type RangeDivinerConfigSchema = typeof RangeDivinerConfigSchema;
+```
+
+                    ### <a id="RangePayload"></a>RangePayload
+
+[**@xyo-network/diviner-range-model**](#../README)
+
+***
+
+```ts
+type RangePayload = 
+  | NumberRangePayload
+  | BigIntRangePayload;
+```
+
+                    ### <a id="RangePayloadBase"></a>RangePayloadBase
+
+[**@xyo-network/diviner-range-model**](#../README)
+
+***
+
+```ts
+type RangePayloadBase<T> = Payload<{
+  count: number;
+  start: T;
+}, RangeSchema>;
+```
+
+## Type Parameters
+
+### T
+
+`T`
+
+                    ### <a id="RangeSchema"></a>RangeSchema
+
+[**@xyo-network/diviner-range-model**](#../README)
+
+***
+
+```ts
+type RangeSchema = typeof RangeSchema;
+```
+
+                  ### variables
+
+                    ### <a id="BigIntSchema"></a>BigIntSchema
+
+[**@xyo-network/diviner-range-model**](#../README)
+
+***
+
+```ts
+const BigIntSchema: "network.xyo.bigint" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                    ### <a id="NumberSchema"></a>NumberSchema
+
+[**@xyo-network/diviner-range-model**](#../README)
+
+***
+
+```ts
+const NumberSchema: "network.xyo.number" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                    ### <a id="RangeDivinerConfigSchema"></a>RangeDivinerConfigSchema
+
+[**@xyo-network/diviner-range-model**](#../README)
+
+***
+
+```ts
+const RangeDivinerConfigSchema: "network.xyo.diviner.range.config" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                    ### <a id="RangeSchema"></a>RangeSchema
+
+[**@xyo-network/diviner-range-model**](#../README)
+
+***
+
+```ts
+const RangeSchema: "network.xyo.range" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                    ### <a id="isRangeDivinerConfig"></a>isRangeDivinerConfig
+
+[**@xyo-network/diviner-range-model**](#../README)
+
+***
+
+```ts
+const isRangeDivinerConfig: (x?) => x is RangeDivinerConfig;
+```
+
+## Parameters
+
+### x?
+
+`unknown`
+
+## Returns
+
+`x is RangeDivinerConfig`
+
+                    ### <a id="isRangePayload"></a>isRangePayload
+
+[**@xyo-network/diviner-range-model**](#../README)
+
+***
+
+```ts
+const isRangePayload: (x?) => x is RangePayload;
+```
+
+## Parameters
+
+### x?
+
+`unknown`
+
+## Returns
 
-## Credits
+`x is RangePayload`
 
-[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-range-model.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/diviner-range-model
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/diviner-range-model.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/diviner-range-model",
-  "version": "5.3.24",
+  "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,23 +36,23 @@
     "README.md"
   ],
   "dependencies": {
-    "@xyo-network/diviner-model": "~5.3.24",
-    "@xyo-network/payload-model": "~5.3.24"
+    "@xyo-network/diviner-model": "~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/diviner-model": "~5.3.24",
-    "@xyo-network/payload-model": "~5.3.24"
+    "@xyo-network/diviner-model": "~5.3.26",
+    "@xyo-network/payload-model": "~5.3.26"
   },
   "peerDependencies": {
     "@xylabs/sdk-js": "^5",