@xyo-network/domain-payload-plugin 5.3.25 → 5.3.26

package/README.md

@@ -1,23 +1,934 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/domain-payload-plugin
 
-[![logo][]](https://xyo.network)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
+
+> Typescript/Javascript Plugins for XYO Platform
+
+## Install
+
+Using npm:
 
-Version: 5.0.2
+```sh
+npm install {{name}}
+```
 
-Typescript/Javascript Plugins for XYO Platform
+Using yarn:
 
-## Documentation
+```sh
+yarn add {{name}}
+```
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__domain-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
+
+  ### core-payload-plugins
+
+    ### packages
+
+      ### domain
+
+        ### .temp-typedoc
+
+          ### classes
+
+            ### <a id="DomainPayloadWrapper"></a>DomainPayloadWrapper
+
+[**@xyo-network/domain-payload-plugin**](#../README)
+
+***
+
+## Extends
+
+- `PayloadWrapper`\<`T`\>
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`DomainPayload`](#../type-aliases/DomainPayload) = [`DomainPayload`](#../type-aliases/DomainPayload)
+
+## Constructors
+
+### Constructor
+
+```ts
+protected new DomainPayloadWrapper<T>(payload): DomainPayloadWrapper<T>;
+```
+
+### Parameters
+
+#### payload
+
+`T`
+
+### Returns
+
+`DomainPayloadWrapper`\<`T`\>
+
+### Inherited from
+
+```ts
+PayloadWrapper<T>.constructor
+```
+
+## Properties
+
+### aliases?
+
+```ts
+optional aliases?: FetchedAlias[] | null;
+```
+
+***
+
+### loaderFactory
+
+```ts
+protected static loaderFactory: PayloadLoaderFactory | null;
+```
+
+### Inherited from
+
+```ts
+PayloadWrapper.loaderFactory
+```
+
+***
+
+### payload
+
+```ts
+payload: T;
+```
+
+### Inherited from
+
+```ts
+PayloadWrapper.payload
+```
+
+## Methods
+
+### discover()
+
+```ts
+static discover(reverseDomainName, proxy?): Promise<
+  | DomainPayloadWrapper<DomainPayload>
+| undefined>;
+```
+
+### Parameters
+
+#### reverseDomainName
+
+`string`
+
+#### proxy?
+
+`string`
+
+### Returns
+
+`Promise`\<
+  \| `DomainPayloadWrapper`\<[`DomainPayload`](#../type-aliases/DomainPayload)\>
+  \| `undefined`\>
+
+***
+
+### discoverDNSEntry()
+
+```ts
+static discoverDNSEntry(domain): Promise<
+  | DomainPayloadWrapper<DomainPayload>
+| undefined>;
+```
+
+### Parameters
+
+#### domain
+
+`string`
+
+### Returns
+
+`Promise`\<
+  \| `DomainPayloadWrapper`\<[`DomainPayload`](#../type-aliases/DomainPayload)\>
+  \| `undefined`\>
+
+***
+
+### discoverRootFile()
+
+```ts
+static discoverRootFile(domain, proxy?): Promise<
+  | DomainPayloadWrapper<DomainPayload>
+| undefined>;
+```
+
+### Parameters
+
+#### domain
+
+`string`
+
+#### proxy?
+
+`string`
+
+### Returns
+
+`Promise`\<
+  \| `DomainPayloadWrapper`\<[`DomainPayload`](#../type-aliases/DomainPayload)\>
+  \| `undefined`\>
+
+***
+
+### discoverRootFileDirect()
+
+```ts
+static discoverRootFileDirect(domain): Promise<
+  | DomainPayloadWrapper<DomainPayload>
+| undefined>;
+```
+
+### Parameters
+
+#### domain
+
+`string`
+
+### Returns
+
+`Promise`\<
+  \| `DomainPayloadWrapper`\<[`DomainPayload`](#../type-aliases/DomainPayload)\>
+  \| `undefined`\>
+
+***
+
+### discoverRootFileWithProxy()
+
+```ts
+static discoverRootFileWithProxy(domain, proxy?): Promise<
+  | DomainPayloadWrapper<DomainPayload>
+| undefined>;
+```
+
+### Parameters
+
+#### domain
+
+`string`
+
+#### proxy?
+
+`string` = `'https://api.archivist.xyo.network/domain'`
+
+### Returns
+
+`Promise`\<
+  \| `DomainPayloadWrapper`\<[`DomainPayload`](#../type-aliases/DomainPayload)\>
+  \| `undefined`\>
+
+***
+
+### fetch()
+
+```ts
+fetch(networkSlug?): Promise<void>;
+```
+
+### Parameters
+
+#### networkSlug?
+
+`BrandedHash`
+
+### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### fetchAliases()
+
+```ts
+fetchAliases(networkSlug?): Promise<void>;
+```
+
+### Parameters
+
+#### networkSlug?
+
+`BrandedHash`
+
+### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### as()
+
+```ts
+static as<T>(value): PayloadDataWrapper<T> | null;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload` = `Payload`
+
+### Parameters
+
+#### value
+
+`unknown`
+
+### Returns
+
+`PayloadDataWrapper`\<`T`\> \| `null`
+
+### Inherited from
+
+```ts
+PayloadWrapper.as
+```
+
+***
+
+### load()
+
+```ts
+static load(address): Promise<PayloadDataWrapper<Payload> | null>;
+```
+
+### Parameters
+
+#### address
+
+`BrandedAddress`
+
+### Returns
+
+`Promise`\<`PayloadDataWrapper`\<`Payload`\> \| `null`\>
+
+### Inherited from
+
+```ts
+PayloadWrapper.load
+```
+
+***
+
+### parse()
+
+```ts
+static parse<T>(payload?): PayloadDataWrapper<T> | undefined;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### payload?
+
+`unknown`
+
+### Returns
+
+`PayloadDataWrapper`\<`T`\> \| `undefined`
+
+### Inherited from
+
+```ts
+PayloadWrapper.parse
+```
+
+***
+
+### setLoaderFactory()
+
+```ts
+static setLoaderFactory(factory): void;
+```
+
+### Parameters
+
+#### factory
+
+`PayloadLoaderFactory` \| `null`
+
+### Returns
+
+`void`
+
+### Inherited from
+
+```ts
+PayloadWrapper.setLoaderFactory
+```
+
+***
+
+### tryParse()
+
+```ts
+static tryParse<T>(obj): PayloadDataWrapper<T> | undefined;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### obj
+
+`unknown`
+
+### Returns
+
+`PayloadDataWrapper`\<`T`\> \| `undefined`
+
+### Inherited from
+
+```ts
+PayloadWrapper.tryParse
+```
+
+***
+
+### wrap()
+
+```ts
+static wrap<T>(payload?): PayloadDataWrapper<T>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### payload?
+
+`T` \| `PayloadDataWrapper`\<`T`\>
+
+### Returns
+
+`PayloadDataWrapper`\<`T`\>
+
+### Inherited from
+
+```ts
+PayloadWrapper.wrap
+```
+
+***
+
+### wrappedMap()
+
+```ts
+static wrappedMap<T>(payloads): Promise<Record<string, PayloadDataWrapper<T>>>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### payloads
+
+(`T` \| `PayloadDataWrapper`\<`T`\>)[]
+
+### Returns
+
+`Promise`\<`Record`\<`string`, `PayloadDataWrapper`\<`T`\>\>\>
+
+### Inherited from
+
+```ts
+PayloadWrapper.wrappedMap
+```
+
+***
+
+### validate()
+
+```ts
+validate(): Promise<Error[]>;
+```
+
+### Returns
+
+`Promise`\<`Error`[]\>
+
+### Inherited from
+
+```ts
+PayloadWrapper.validate
+```
+
+***
+
+### unwrap()
+
+### Call Signature
+
+```ts
+static unwrap<TPayload>(payload?): TPayload | undefined;
+```
+
+#### Type Parameters
+
+##### TPayload
+
+`TPayload` *extends* `Payload` = `Payload`
+
+#### Parameters
+
+##### payload?
+
+`TPayload`
+
+#### Returns
+
+`TPayload` \| `undefined`
+
+#### Inherited from
+
+```ts
+PayloadWrapper.unwrap
+```
+
+### Call Signature
+
+```ts
+static unwrap<TPayload, TWrapper>(payload): TPayload;
+```
+
+#### Type Parameters
+
+##### TPayload
+
+`TPayload` *extends* `Payload` = `Payload`
+
+##### TWrapper
+
+`TWrapper` *extends* `PayloadWrapperBase`\<`TPayload`\> = `PayloadWrapperBase`\<`TPayload`\>
+
+#### Parameters
+
+##### payload
+
+`TPayload` \| `TWrapper`
+
+#### Returns
+
+`TPayload`
+
+#### Inherited from
+
+```ts
+PayloadWrapper.unwrap
+```
+
+### Call Signature
+
+```ts
+static unwrap<TPayload, TWrapper>(payload): TPayload[];
+```
+
+#### Type Parameters
+
+##### TPayload
+
+`TPayload` *extends* `Payload` = `Payload`
+
+##### TWrapper
+
+`TWrapper` *extends* `PayloadWrapperBase`\<`TPayload`\> = `PayloadWrapperBase`\<`TPayload`\>
+
+#### Parameters
+
+##### payload
+
+(`TPayload` \| `TWrapper`)[]
+
+#### Returns
+
+`TPayload`[]
+
+#### Inherited from
+
+```ts
+PayloadWrapper.unwrap
+```
+
+***
+
+### unwrapSinglePayload()
+
+### Call Signature
+
+```ts
+static unwrapSinglePayload<TPayload>(payload?): TPayload | undefined;
+```
+
+#### Type Parameters
+
+##### TPayload
+
+`TPayload` *extends* `Payload` = `Payload`
+
+#### Parameters
+
+##### payload?
+
+`TPayload`
+
+#### Returns
+
+`TPayload` \| `undefined`
+
+#### Inherited from
+
+```ts
+PayloadWrapper.unwrapSinglePayload
+```
+
+### Call Signature
+
+```ts
+static unwrapSinglePayload<TPayload, TWrapper>(payload): TPayload;
+```
+
+#### Type Parameters
+
+##### TPayload
+
+`TPayload` *extends* `Payload` = `Payload`
+
+##### TWrapper
+
+`TWrapper` *extends* `PayloadWrapperBase`\<`TPayload`\> = `PayloadWrapperBase`\<`TPayload`\>
+
+#### Parameters
+
+##### payload
+
+`TPayload` \| `TWrapper`
+
+#### Returns
+
+`TPayload`
+
+#### Inherited from
+
+```ts
+PayloadWrapper.unwrapSinglePayload
+```
+
+***
+
+### dataHash()
+
+```ts
+dataHash(): Promise<BrandedHash>;
+```
+
+### Returns
+
+`Promise`\<`BrandedHash`\>
+
+### Inherited from
+
+```ts
+PayloadWrapper.dataHash
+```
+
+***
+
+### getErrors()
+
+```ts
+getErrors(): Promise<Error[]>;
+```
+
+### Returns
+
+`Promise`\<`Error`[]\>
+
+### Inherited from
+
+```ts
+PayloadWrapper.getErrors
+```
+
+***
+
+### getValid()
+
+```ts
+getValid(): Promise<boolean>;
+```
+
+### Returns
+
+`Promise`\<`boolean`\>
+
+### Inherited from
+
+```ts
+PayloadWrapper.getValid
+```
+
+***
+
+### hash()
+
+```ts
+hash(): Promise<BrandedHash>;
+```
+
+### Returns
+
+`Promise`\<`BrandedHash`\>
+
+### Inherited from
+
+```ts
+PayloadWrapper.hash
+```
+
+***
+
+### schema()
+
+```ts
+schema(): string;
+```
+
+### Returns
+
+`string`
+
+### Inherited from
+
+```ts
+PayloadWrapper.schema
+```
+
+          ### functions
+
+            ### <a id="DomainPayloadPlugin"></a>DomainPayloadPlugin
+
+[**@xyo-network/domain-payload-plugin**](#../README)
+
+***
+
+```ts
+function DomainPayloadPlugin(): PayloadPlugin<DomainPayload>;
+```
+
+## Returns
+
+`PayloadPlugin`\<[`DomainPayload`](#../type-aliases/DomainPayload)\>
+
+            ### <a id="domainConfigTemplate"></a>domainConfigTemplate
+
+[**@xyo-network/domain-payload-plugin**](#../README)
+
+***
+
+```ts
+function domainConfigTemplate(): DomainPayload;
+```
+
+## Returns
+
+[`DomainPayload`](#../type-aliases/DomainPayload)
+
+          ### interfaces
+
+            ### <a id="Alias"></a>Alias
+
+[**@xyo-network/domain-payload-plugin**](#../README)
+
+***
+
+## Properties
+
+### huri
+
+```ts
+huri: string;
+```
+
+### Field
+
+huri to the aliased payload
+
+***
+
+### name?
+
+```ts
+optional name?: string;
+```
+
+### Field
+
+canonical name (ex. network.xyo.example)
+
+            ### <a id="FetchedAlias"></a>FetchedAlias
+
+[**@xyo-network/domain-payload-plugin**](#../README)
+
+***
+
+## Extends
+
+- `FetchedPayload`
+
+## Properties
+
+### alias
+
+```ts
+alias: Alias;
+```
+
+***
+
+### huri?
+
+```ts
+optional huri?: Huri<Payload>;
+```
+
+### Inherited from
+
+```ts
+FetchedPayload.huri
+```
+
+***
+
+### payload
+
+```ts
+payload: Payload;
+```
+
+### Inherited from
+
+```ts
+FetchedPayload.payload
+```
+
+          ### type-aliases
+
+            ### <a id="DomainPayload"></a>DomainPayload
+
+[**@xyo-network/domain-payload-plugin**](#../README)
+
+***
+
+```ts
+type DomainPayload = Payload<{
+  additional?: string[];
+  aliases?: Record<string, Alias>;
+  networks?: NetworkPayload[];
+}, DomainSchema>;
+```
+
+            ### <a id="DomainSchema"></a>DomainSchema
+
+[**@xyo-network/domain-payload-plugin**](#../README)
+
+***
+
+```ts
+type DomainSchema = typeof DomainSchema;
+```
+
+          ### variables
+
+            ### <a id="DomainSchema"></a>DomainSchema
+
+[**@xyo-network/domain-payload-plugin**](#../README)
+
+***
+
+```ts
+const DomainSchema: "network.xyo.domain" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+            ### <a id="isDomainPayload"></a>isDomainPayload
+
+[**@xyo-network/domain-payload-plugin**](#../README)
+
+***
+
+```ts
+const isDomainPayload: (x?) => x is DomainPayload;
+```
+
+## Parameters
+
+### x?
+
+`unknown`
+
+## Returns
 
-## Credits
+`x is DomainPayload`
 
-[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/domain-payload-plugin.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/domain-payload-plugin
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/domain-payload-plugin.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/domain-payload-plugin",
-  "version": "5.3.25",
+  "version": "5.3.26",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "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,22 +36,22 @@
     "README.md"
   ],
   "dependencies": {
-    "@xyo-network/dns": "~5.3.25",
-    "@xyo-network/network": "~5.3.25",
-    "@xyo-network/huri": "~5.3.25",
-    "@xyo-network/payload-builder": "~5.3.25",
-    "@xyo-network/payload-model": "~5.3.25",
-    "@xyo-network/payload-plugin": "~5.3.25",
-    "@xyo-network/payload-wrapper": "~5.3.25"
+    "@xyo-network/dns": "~5.3.26",
+    "@xyo-network/huri": "~5.3.26",
+    "@xyo-network/payload-builder": "~5.3.26",
+    "@xyo-network/payload-model": "~5.3.26",
+    "@xyo-network/network": "~5.3.26",
+    "@xyo-network/payload-plugin": "~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",
-    "@xylabs/vitest-extended": "~5.0.93",
+    "@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",
+    "@xylabs/vitest-extended": "~5.0.94",
     "acorn": "^8.16.0",
     "axios": "^1.14.0",
     "esbuild": "^0.28.0",
@@ -61,7 +61,7 @@
     "vite": "^8.0.3",
     "vitest": "~4.1.2",
     "zod": "^4.3.6",
-    "@xyo-network/api-models": "~5.3.25"
+    "@xyo-network/api-models": "~5.3.26"
   },
   "peerDependencies": {
     "@xylabs/sdk-js": "^5",