@xyo-network/payload-plugin 5.3.25 → 5.3.26

package/README.md

@@ -1,23 +1,440 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/payload-plugin
 
-[![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-plugin)
+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
+
+  ### sdk-utils
+
+    ### packages
+
+      ### payload-plugin
+
+        ### .temp-typedoc
+
+          ### classes
+
+            ### <a id="PayloadPluginResolver"></a>PayloadPluginResolver
+
+[**@xyo-network/payload-plugin**](#../README)
+
+***
+
+## Constructors
+
+### Constructor
+
+```ts
+new PayloadPluginResolver(plugins?, defaultPlugin?): PayloadPluginResolver;
+```
+
+### Parameters
+
+#### plugins?
+
+[`PayloadPlugin`](#../type-aliases/PayloadPlugin)\<`Payload`\>[]
+
+**Param**
+
+The initial set of plugins
+
+#### defaultPlugin?
+
+[`PayloadPlugin`](#../type-aliases/PayloadPlugin)\<`Payload`\> = `...`
+
+**Param**
+
+Specifies the plugin to be used if no plugins resolve
+
+### Returns
+
+`PayloadPluginResolver`
+
+## Properties
+
+### schema
+
+```ts
+schema: "network.xyo.payload" & object = PayloadSchema;
+```
+
+### Type Declaration
+
+#### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+***
+
+### \_plugins
+
+```ts
+protected _plugins: Record<string, PayloadPlugin> = {};
+```
+
+***
+
+### defaultPlugin
+
+```ts
+protected defaultPlugin: PayloadPlugin;
+```
+
+## Methods
+
+### plugins()
+
+```ts
+plugins(): PayloadPlugin[];
+```
+
+### Returns
+
+[`PayloadPlugin`](#../type-aliases/PayloadPlugin)[]
+
+### Description
+
+Create list of plugins, optionally filtered by ability to witness/divine
+
+***
+
+### register()
+
+```ts
+register<TPlugin>(plugin): PayloadPluginResolver;
+```
+
+### Type Parameters
+
+#### TPlugin
+
+`TPlugin` *extends* [`PayloadPlugin`](#../type-aliases/PayloadPlugin) = [`PayloadPlugin`](#../type-aliases/PayloadPlugin)
+
+### Parameters
+
+#### plugin
+
+`TPlugin`
+
+### Returns
+
+`PayloadPluginResolver`
+
+***
+
+### resolve()
+
+### Call Signature
+
+```ts
+resolve(schema?): PayloadPlugin;
+```
+
+#### Parameters
+
+##### schema?
+
+`string`
+
+#### Returns
+
+[`PayloadPlugin`](#../type-aliases/PayloadPlugin)
+
+### Call Signature
+
+```ts
+resolve(payload): PayloadPlugin;
+```
+
+#### Parameters
+
+##### payload
+
+`Payload`
+
+#### Returns
+
+[`PayloadPlugin`](#../type-aliases/PayloadPlugin)
+
+***
+
+### schemas()
+
+```ts
+schemas(): string[];
+```
+
+### Returns
+
+`string`[]
+
+### Description
+
+Create list of schema, optionally filtered by ability to witness/divine
+
+***
+
+### validate()
+
+```ts
+validate(payload): Validator<Payload> | undefined;
+```
+
+### Parameters
+
+#### payload
+
+`Payload`
+
+### Returns
+
+`Validator`\<`Payload`\> \| `undefined`
+
+***
+
+### wrap()
+
+```ts
+wrap(payload): PayloadWrapper<Payload> | undefined;
+```
+
+### Parameters
+
+#### payload
+
+`Payload`
+
+### Returns
+
+`PayloadWrapper`\<`Payload`\> \| `undefined`
+
+          ### functions
+
+            ### <a id="createPayloadPlugin"></a>createPayloadPlugin
+
+[**@xyo-network/payload-plugin**](#../README)
+
+***
+
+```ts
+function createPayloadPlugin<TPayload>(plugin): PayloadPlugin<TPayload>;
+```
+
+## Type Parameters
+
+### TPayload
+
+`TPayload` *extends* `Payload` = `Payload`
+
+## Parameters
+
+### plugin
+
+[`PayloadPlugin`](#../type-aliases/PayloadPlugin)\<`TPayload`\>
+
+## Returns
+
+[`PayloadPlugin`](#../type-aliases/PayloadPlugin)\<`TPayload`\>
+
+            ### <a id="defaultPayloadPluginFunctions"></a>defaultPayloadPluginFunctions
+
+[**@xyo-network/payload-plugin**](#../README)
+
+***
+
+```ts
+function defaultPayloadPluginFunctions<T>(schema): PayloadPlugin<T>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Payload`
+
+## Parameters
+
+### schema
+
+`Schema`
+
+## Returns
+
+[`PayloadPlugin`](#../type-aliases/PayloadPlugin)\<`T`\>
+
+          ### type-aliases
+
+            ### <a id="PayloadPlugin"></a>PayloadPlugin
+
+[**@xyo-network/payload-plugin**](#../README)
+
+***
+
+```ts
+type PayloadPlugin<TPayload> = object;
+```
+
+## Type Parameters
+
+### TPayload
+
+`TPayload` *extends* `Payload` = `Payload`
+
+## Properties
+
+### build?
+
+```ts
+optional build?: () => PayloadBuilder<TPayload>;
+```
+
+### Returns
+
+`PayloadBuilder`\<`TPayload`\>
+
+***
+
+### ~~jsonSchema?~~
+
+```ts
+optional jsonSchema?: SomeJSONSchema;
+```
+
+### Deprecated
+
+use zod instead
+
+***
+
+### schema
+
+```ts
+schema: TPayload["schema"];
+```
+
+***
+
+### ~~template?~~
+
+```ts
+optional template?: () => Partial<TPayload>;
+```
+
+### Returns
+
+`Partial`\<`TPayload`\>
+
+### Deprecated
+
+use zod defaults instead
+
+***
+
+### validate?
+
+```ts
+optional validate?: (payload) => Validator<Payload>;
+```
+
+### Parameters
+
+#### payload
+
+`Payload`
+
+### Returns
+
+`Validator`\<`Payload`\>
+
+***
+
+### wrap?
+
+```ts
+optional wrap?: (payload) => PayloadWrapper;
+```
+
+### Parameters
+
+#### payload
+
+`Payload`
+
+### Returns
+
+`PayloadWrapper`
+
+***
+
+### zod?
+
+```ts
+optional zod?: ZodType;
+```
+
+            ### <a id="PayloadPluginFunc"></a>PayloadPluginFunc
+
+[**@xyo-network/payload-plugin**](#../README)
+
+***
+
+```ts
+type PayloadPluginFunc<TPayload> = () => PayloadPlugin<TPayload>;
+```
+
+## Type Parameters
+
+### TPayload
+
+`TPayload` *extends* `Payload` = `Payload`
+
+## Returns
 
-## Credits
+[`PayloadPlugin`](#PayloadPlugin)\<`TPayload`\>
 
-[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-plugin.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/payload-plugin
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/payload-plugin.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/payload-plugin",
-  "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,28 +36,28 @@
     "README.md"
   ],
   "dependencies": {
-    "@xyo-network/payload-builder": "~5.3.25",
-    "@xyo-network/payload-model": "~5.3.25",
-    "@xyo-network/payload-wrapper": "~5.3.25",
-    "@xyo-network/payload-validator": "~5.3.25"
+    "@xyo-network/payload-builder": "~5.3.26",
+    "@xyo-network/payload-model": "~5.3.26",
+    "@xyo-network/payload-validator": "~5.3.26",
+    "@xyo-network/payload-wrapper": "~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",
     "ajv": "^8.18.0",
     "axios": "^1.14.0",
     "esbuild": "^0.28.0",
     "typescript": "~5.9.3",
     "zod": "^4.3.6",
-    "@xyo-network/payload-model": "~5.3.25",
-    "@xyo-network/payload-builder": "~5.3.25",
-    "@xyo-network/payload-validator": "~5.3.25",
-    "@xyo-network/payload-wrapper": "~5.3.25"
+    "@xyo-network/payload-model": "~5.3.26",
+    "@xyo-network/payload-builder": "~5.3.26",
+    "@xyo-network/payload-validator": "~5.3.26",
+    "@xyo-network/payload-wrapper": "~5.3.26"
   },
   "peerDependencies": {
     "@xylabs/sdk-js": "^5",