@xyo-network/core-payload-plugins 5.3.24 → 5.3.26

package/README.md

@@ -1,23 +1,1499 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/core-payload-plugins
 
-[![logo][]](https://xyo.network)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
+
+> Typescript/Javascript Plugins for XYO Platform
+
+## Install
+
+Using npm:
+
+```sh
+npm install {{name}}
+```
+
+Using yarn:
 
-Version: 5.0.2
+```sh
+yarn add {{name}}
+```
 
-Typescript/Javascript Plugins for XYO Platform
+Using pnpm:
 
-## Documentation
+```sh
+pnpm add {{name}}
+```
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__core-payload-plugins)
+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
+
+    ### .temp-typedoc
+
+      ### classes
+
+        ### <a id="DomainPayloadWrapper"></a>DomainPayloadWrapper
+
+[**@xyo-network/core-payload-plugins**](#../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`
+
+### 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
+```
+
+      ### interfaces
+
+        ### <a id="Alias"></a>Alias
+
+[**@xyo-network/core-payload-plugins**](#../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/core-payload-plugins**](#../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="ConfigPayload"></a>ConfigPayload
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+type ConfigPayload<T> = WithAdditional<Payload<{
+  config: string;
+  schema: ConfigSchema;
+}>, T>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `AnyObject` \| `undefined` = `undefined`
+
+        ### <a id="ConfigSchema"></a>ConfigSchema
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+type ConfigSchema = typeof ConfigSchema;
+```
+
+        ### <a id="DomainPayload"></a>DomainPayload
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+type DomainPayload = Payload<{
+  additional?: string[];
+  aliases?: Record<string, Alias>;
+  networks?: NetworkPayload[];
+}, DomainSchema>;
+```
+
+        ### <a id="DomainSchema"></a>DomainSchema
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+type DomainSchema = typeof DomainSchema;
+```
+
+        ### <a id="Id"></a>Id
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+type Id = Payload<IdFields, IdSchema>;
+```
+
+The ID Payload
+
+        ### <a id="IdFields"></a>IdFields
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+type IdFields = object;
+```
+
+The fields of an ID Payload
+
+## Properties
+
+### salt
+
+```ts
+salt: string;
+```
+
+        ### <a id="IdPayload"></a>IdPayload
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+type IdPayload = Id;
+```
+
+## Deprecated
+
+Use `Id` instead
+
+        ### <a id="IdSchema"></a>IdSchema
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+type IdSchema = typeof IdSchema;
+```
+
+        ### <a id="QueryPayload"></a>QueryPayload
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+type QueryPayload = Payload<{
+  query: Schema;
+  schema: QuerySchema;
+}>;
+```
+
+        ### <a id="QuerySchema"></a>QuerySchema
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+type QuerySchema = typeof QuerySchema;
+```
+
+        ### <a id="SchemaPayload"></a>SchemaPayload
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+type SchemaPayload = Payload<{
+  definition: {
+   [key: string]: unknown;
+     $id?: string;
+  };
+  extends?: string;
+  name?: string;
+  version?: number;
+}, SchemaSchema>;
+```
+
+        ### <a id="SchemaSchema"></a>SchemaSchema
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+type SchemaSchema = typeof SchemaSchema;
+```
+
+        ### <a id="Value"></a>Value
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+type Value<T> = Payload<{
+  schema: ValueSchema;
+  value: T;
+}>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `JsonValue` = `JsonValue`
+
+        ### <a id="ValueSchema"></a>ValueSchema
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+type ValueSchema = typeof ValueSchema;
+```
+
+      ### variables
+
+        ### <a id="AddressPayloadPlugin"></a>AddressPayloadPlugin
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+const AddressPayloadPlugin: () => PayloadPlugin;
+```
+
+## Returns
+
+`PayloadPlugin`
+
+        ### <a id="ConfigPayloadPlugin"></a>ConfigPayloadPlugin
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+const ConfigPayloadPlugin: () => PayloadPlugin;
+```
+
+## Returns
+
+`PayloadPlugin`
+
+        ### <a id="ConfigSchema"></a>ConfigSchema
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+const ConfigSchema: "network.xyo.config" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+        ### <a id="DomainPayloadPlugin"></a>DomainPayloadPlugin
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+const DomainPayloadPlugin: () => PayloadPlugin;
+```
+
+## Returns
+
+`PayloadPlugin`
+
+        ### <a id="DomainSchema"></a>DomainSchema
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+const DomainSchema: "network.xyo.domain" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+        ### <a id="IdPayloadPlugin"></a>IdPayloadPlugin
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+const IdPayloadPlugin: () => PayloadPlugin;
+```
+
+## Returns
+
+`PayloadPlugin`
+
+        ### <a id="IdSchema"></a>IdSchema
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+const IdSchema: "network.xyo.id" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+        ### <a id="PayloadPlugins"></a>PayloadPlugins
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+const PayloadPlugins: PayloadPluginFunc<Payload>[];
+```
+
+        ### <a id="QueryPayloadPlugin"></a>QueryPayloadPlugin
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+const QueryPayloadPlugin: () => PayloadPlugin;
+```
+
+## Returns
+
+`PayloadPlugin`
+
+        ### <a id="QuerySchema"></a>QuerySchema
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+const QuerySchema: "network.xyo.query" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+        ### <a id="SchemaPayloadPlugin"></a>SchemaPayloadPlugin
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+const SchemaPayloadPlugin: () => PayloadPlugin;
+```
+
+## Returns
+
+`PayloadPlugin`
+
+        ### <a id="SchemaSchema"></a>SchemaSchema
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+const SchemaSchema: "network.xyo.schema" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+        ### <a id="ValuePayloadPlugin"></a>ValuePayloadPlugin
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+const ValuePayloadPlugin: () => PayloadPlugin;
+```
+
+## Returns
+
+`PayloadPlugin`
+
+        ### <a id="ValueSchema"></a>ValueSchema
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+const ValueSchema: "network.xyo.value" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+        ### <a id="addressPayloadTemplate"></a>addressPayloadTemplate
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+const addressPayloadTemplate: () => AddressPayload;
+```
+
+## Returns
+
+`AddressPayload`
+
+        ### <a id="asId"></a>asId
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+const asId: AsTypeFunction;
+```
+
+        ### <a id="asOptionalId"></a>asOptionalId
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+const asOptionalId: (value) => Id | undefined;
+```
+
+## Parameters
+
+### value
+
+`AnyNonPromise`
+
+## Returns
+
+[`Id`](#../type-aliases/Id) \| `undefined`
+
+        ### <a id="configPayloadTemplate"></a>configPayloadTemplate
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+const configPayloadTemplate: () => ConfigPayload;
+```
+
+## Returns
+
+[`ConfigPayload`](#../type-aliases/ConfigPayload)
+
+        ### <a id="domainConfigTemplate"></a>domainConfigTemplate
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+const domainConfigTemplate: () => DomainPayload;
+```
+
+## Returns
+
+[`DomainPayload`](#../type-aliases/DomainPayload)
+
+        ### <a id="idPayloadTemplate"></a>idPayloadTemplate
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+const idPayloadTemplate: () => Id;
+```
+
+## Returns
+
+[`Id`](#../type-aliases/Id)
+
+        ### <a id="isDomainPayload"></a>isDomainPayload
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+const isDomainPayload: (x?) => x is DomainPayload;
+```
+
+## Parameters
+
+### x?
+
+`unknown` \| `null`
+
+## Returns
+
+`x is DomainPayload`
+
+        ### <a id="isId"></a>isId
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+const isId: (x?) => x is Id;
+```
+
+Identity helper for ID Payload
+
+## Parameters
+
+### x?
+
+`unknown` \| `null`
+
+## Returns
+
+`x is Id`
+
+        ### <a id="isIdWithSources"></a>isIdWithSources
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+const isIdWithSources: (x?) => x is WithSources<WithSources<Id>>;
+```
+
+Identity helper for ID Payload with sources
+
+## Parameters
+
+### x?
+
+`unknown` \| `null`
+
+## Returns
+
+`x is WithSources<WithSources<Id>>`
+
+        ### <a id="isSchemaPayload"></a>isSchemaPayload
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+const isSchemaPayload: (x?) => x is SchemaPayload;
+```
+
+Identity function for determining if an object is an Schema
+
+## Parameters
+
+### x?
+
+`unknown` \| `null`
+
+## Returns
+
+`x is SchemaPayload`
+
+        ### <a id="isSchemaPayloadWithSources"></a>isSchemaPayloadWithSources
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+const isSchemaPayloadWithSources: (x?) => x is WithSources;
+```
+
+Identity function for determining if an object is an Schema with sources
+
+## Parameters
+
+### x?
+
+`unknown` \| `null`
+
+## Returns
+
+`x is WithSources`
+
+        ### <a id="isValuePayload"></a>isValuePayload
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+const isValuePayload: (x?) => x is Value<unknown>;
+```
+
+## Parameters
+
+### x?
+
+`unknown` \| `null`
+
+## Returns
+
+`x is Value<unknown>`
+
+        ### <a id="queryPayloadTemplate"></a>queryPayloadTemplate
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+const queryPayloadTemplate: () => QueryPayload;
+```
+
+## Returns
+
+[`QueryPayload`](#../type-aliases/QueryPayload)
+
+        ### <a id="schemaPayloadTemplate"></a>schemaPayloadTemplate
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+const schemaPayloadTemplate: () => SchemaPayload;
+```
+
+## Returns
+
+[`SchemaPayload`](#../type-aliases/SchemaPayload)
+
+        ### <a id="valuePayloadTemplate"></a>valuePayloadTemplate
+
+[**@xyo-network/core-payload-plugins**](#../README)
+
+***
+
+```ts
+const valuePayloadTemplate: () => Value;
+```
+
+## Returns
 
-## Credits
+[`Value`](#../type-aliases/Value)
 
-[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/core-payload-plugins.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/core-payload-plugins
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/core-payload-plugins.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE