@xyo-network/diviner-payload-pointer-model 5.3.24 → 5.3.26

package/README.md

@@ -1,23 +1,499 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/diviner-payload-pointer-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-payload-pointer-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
+
+          ### payloadpointer
+
+            ### packages
+
+              ### model
+
+                ### .temp-typedoc
+
+                  ### functions
+
+                    ### <a id="isBoundWitnessPointer"></a>isBoundWitnessPointer
+
+[**@xyo-network/diviner-payload-pointer-model**](#../README)
+
+***
+
+```ts
+function isBoundWitnessPointer(x?): x is BoundWitnessPointerPayload;
+```
+
+Identity function for determining if an object is a BoundWitness Pointer
+
+## Parameters
+
+### x?
+
+`Payload` \| `null`
+
+The object to check
+
+## Returns
+
+`x is BoundWitnessPointerPayload`
+
+                    ### <a id="isPayloadAddressRule"></a>isPayloadAddressRule
+
+[**@xyo-network/diviner-payload-pointer-model**](#../README)
+
+***
+
+```ts
+function isPayloadAddressRule(rule): rule is PayloadAddressRule;
+```
+
+## Parameters
+
+### rule
+
+[`PayloadRule`](#../type-aliases/PayloadRule)
+
+## Returns
+
+`rule is PayloadAddressRule`
+
+                    ### <a id="isPayloadPointer"></a>isPayloadPointer
+
+[**@xyo-network/diviner-payload-pointer-model**](#../README)
+
+***
+
+```ts
+function isPayloadPointer(x?): x is PayloadPointerPayload;
+```
+
+Identity function for determining if an object is a Payload Pointer
+
+## Parameters
+
+### x?
+
+`Payload` \| `null`
+
+The object to check
+
+## Returns
+
+`x is PayloadPointerPayload`
+
+                    ### <a id="isPayloadSchemaRule"></a>isPayloadSchemaRule
+
+[**@xyo-network/diviner-payload-pointer-model**](#../README)
+
+***
+
+```ts
+function isPayloadSchemaRule(rule): rule is PayloadSchemaRule;
+```
+
+## Parameters
+
+### rule
+
+[`PayloadRule`](#../type-aliases/PayloadRule)
+
+## Returns
+
+`rule is PayloadSchemaRule`
+
+                    ### <a id="isPayloadSequenceOrderRule"></a>isPayloadSequenceOrderRule
+
+[**@xyo-network/diviner-payload-pointer-model**](#../README)
+
+***
+
+```ts
+function isPayloadSequenceOrderRule(rule): rule is PayloadSequenceOrderRule;
+```
+
+## Parameters
+
+### rule
+
+[`PayloadRule`](#../type-aliases/PayloadRule)
+
+## Returns
+
+`rule is PayloadSequenceOrderRule`
+
+                    ### <a id="isPointerPayload"></a>isPointerPayload
+
+[**@xyo-network/diviner-payload-pointer-model**](#../README)
+
+***
+
+```ts
+function isPointerPayload(x?): x is PointerPayload;
+```
+
+Identity function for determining if an object is a Pointer Payload (PayloadPointer or BoundWitnessPointer)
+
+## Parameters
+
+### x?
+
+`Payload` \| `null`
+
+The object to check
+
+## Returns
+
+`x is PointerPayload`
+
+                  ### interfaces
+
+                    ### <a id="PayloadAddressRule"></a>PayloadAddressRule
+
+[**@xyo-network/diviner-payload-pointer-model**](#../README)
+
+***
+
+## Properties
+
+### address
+
+```ts
+address: string;
+```
+
+                    ### <a id="PayloadSchemaRule"></a>PayloadSchemaRule
+
+[**@xyo-network/diviner-payload-pointer-model**](#../README)
+
+***
+
+## Properties
+
+### schema
+
+```ts
+schema: Schema;
+```
+
+                    ### <a id="PayloadSearchCriteria"></a>PayloadSearchCriteria
+
+[**@xyo-network/diviner-payload-pointer-model**](#../README)
+
+***
+
+## Properties
+
+### addresses
+
+```ts
+addresses: BrandedAddress[];
+```
+
+***
+
+### cursor?
+
+```ts
+optional cursor?: Sequence;
+```
+
+***
+
+### order
+
+```ts
+order: Order;
+```
+
+***
+
+### schemas
+
+```ts
+schemas: Schema[];
+```
+
+                    ### <a id="PayloadSequenceOrderRule"></a>PayloadSequenceOrderRule
+
+[**@xyo-network/diviner-payload-pointer-model**](#../README)
+
+***
+
+## Properties
+
+### order?
+
+```ts
+optional order?: Order;
+```
+
+***
+
+### sequence?
+
+```ts
+optional sequence?: Sequence;
+```
+
+                  ### type-aliases
+
+                    ### <a id="BoundWitnessPointerPayload"></a>BoundWitnessPointerPayload
+
+[**@xyo-network/diviner-payload-pointer-model**](#../README)
+
+***
+
+```ts
+type BoundWitnessPointerPayload = PointerPayload & object;
+```
+
+## Type Declaration
+
+### schema
+
+```ts
+schema: BoundWitnessPointerSchema;
+```
+
+                    ### <a id="BoundWitnessPointerSchema"></a>BoundWitnessPointerSchema
+
+[**@xyo-network/diviner-payload-pointer-model**](#../README)
+
+***
+
+```ts
+type BoundWitnessPointerSchema = typeof BoundWitnessPointerSchema;
+```
+
+                    ### <a id="PayloadPointerDivinerConfig"></a>PayloadPointerDivinerConfig
+
+[**@xyo-network/diviner-payload-pointer-model**](#../README)
+
+***
+
+```ts
+type PayloadPointerDivinerConfig = DivinerConfig<object & object>;
+```
+
+The configuration for the Payload Pointer Diviner
+
+                    ### <a id="PayloadPointerDivinerConfigSchema"></a>PayloadPointerDivinerConfigSchema
+
+[**@xyo-network/diviner-payload-pointer-model**](#../README)
+
+***
+
+```ts
+type PayloadPointerDivinerConfigSchema = typeof PayloadPointerDivinerConfigSchema;
+```
+
+The config schema type for the Payload Pointer Diviner
+
+                    ### <a id="PayloadPointerDivinerParams"></a>PayloadPointerDivinerParams
+
+[**@xyo-network/diviner-payload-pointer-model**](#../README)
+
+***
+
+```ts
+type PayloadPointerDivinerParams = DivinerParams<AnyConfigSchema<PayloadPointerDivinerConfig>>;
+```
+
+The params type of the Payload Pointer diviner
+
+                    ### <a id="PayloadPointerDivinerSchema"></a>PayloadPointerDivinerSchema
+
+[**@xyo-network/diviner-payload-pointer-model**](#../README)
+
+***
+
+```ts
+type PayloadPointerDivinerSchema = typeof PayloadPointerDivinerSchema;
+```
+
+The schema type used for the Payload Pointer Diviner.
+
+                    ### <a id="PayloadPointerPayload"></a>PayloadPointerPayload
+
+[**@xyo-network/diviner-payload-pointer-model**](#../README)
+
+***
+
+```ts
+type PayloadPointerPayload = PointerPayload & object;
+```
+
+## Type Declaration
+
+### schema
+
+```ts
+schema: PayloadPointerSchema;
+```
+
+                    ### <a id="PayloadPointerSchema"></a>PayloadPointerSchema
+
+[**@xyo-network/diviner-payload-pointer-model**](#../README)
+
+***
+
+```ts
+type PayloadPointerSchema = typeof PayloadPointerSchema;
+```
+
+                    ### <a id="PayloadRule"></a>PayloadRule
+
+[**@xyo-network/diviner-payload-pointer-model**](#../README)
+
+***
+
+```ts
+type PayloadRule = 
+  | PayloadAddressRule
+  | PayloadSequenceOrderRule
+  | PayloadSchemaRule;
+```
+
+                    ### <a id="PointerPayload"></a>PointerPayload
+
+[**@xyo-network/diviner-payload-pointer-model**](#../README)
+
+***
+
+```ts
+type PointerPayload = Payload<{
+  reference: PayloadRule[][];
+}>;
+```
+
+                  ### variables
+
+                    ### <a id="BoundWitnessPointerSchema"></a>BoundWitnessPointerSchema
+
+[**@xyo-network/diviner-payload-pointer-model**](#../README)
+
+***
+
+```ts
+const BoundWitnessPointerSchema: string & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                    ### <a id="PayloadPointerDivinerConfigSchema"></a>PayloadPointerDivinerConfigSchema
+
+[**@xyo-network/diviner-payload-pointer-model**](#../README)
+
+***
+
+```ts
+const PayloadPointerDivinerConfigSchema: string & object;
+```
+
+The config schema for the Payload Pointer Diviner
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                    ### <a id="PayloadPointerDivinerSchema"></a>PayloadPointerDivinerSchema
+
+[**@xyo-network/diviner-payload-pointer-model**](#../README)
+
+***
+
+```ts
+const PayloadPointerDivinerSchema: "network.xyo.diviner.payload.pointer" & object;
+```
+
+The schema used for the Payload Pointer Diviner.
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                    ### <a id="PayloadPointerSchema"></a>PayloadPointerSchema
+
+[**@xyo-network/diviner-payload-pointer-model**](#../README)
+
+***
+
+```ts
+const PayloadPointerSchema: string & 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/diviner-payload-pointer-model.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/diviner-payload-pointer-model
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/diviner-payload-pointer-model.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

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