@xyo-network/sdk-js 4.3.0 → 5.0.1

package/docs/interfaces/ObjectResolverInstance.md

@@ -1,275 +0,0 @@
-[@xyo-network/sdk-js](../README.md) / ObjectResolverInstance
-
-# Interface: ObjectResolverInstance\<TResult\>
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectResolver.d.ts:26
-
-## Extends
-
-- [`ObjectResolver`](ObjectResolver.md)\<`TResult`\>
-
-## Type Parameters
-
-### TResult
-
-`TResult` *extends* `EmptyObject`
-
-## Properties
-
-### addResolver()
-
-> **addResolver**: (`resolver`) => `this`
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectResolver.d.ts:27
-
-#### Parameters
-
-##### resolver
-
-`ObjectResolverInstance`\<`TResult`\>
-
-#### Returns
-
-`this`
-
-***
-
-### priority
-
-> **priority**: [`ObjectResolverPriority`](../type-aliases/ObjectResolverPriority.md)
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectResolver.d.ts:16
-
-#### Inherited from
-
-[`ObjectResolver`](ObjectResolver.md).[`priority`](ObjectResolver.md#priority)
-
-***
-
-### removeResolver()
-
-> **removeResolver**: (`resolver`) => `this`
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectResolver.d.ts:28
-
-#### Parameters
-
-##### resolver
-
-`ObjectResolverInstance`\<`TResult`\>
-
-#### Returns
-
-`this`
-
-## Methods
-
-### resolve()
-
-#### Call Signature
-
-> **resolve**\<`T`\>(): `Promisable`\<`undefined` \| `T`\>
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectResolver.d.ts:18
-
-##### Type Parameters
-
-###### T
-
-`T` *extends* `object` = `TResult`
-
-##### Returns
-
-`Promisable`\<`undefined` \| `T`\>
-
-##### Deprecated
-
-do not pass undefined.  If trying to get all, pass '*'
-
-##### Inherited from
-
-[`ObjectResolver`](ObjectResolver.md).[`resolve`](ObjectResolver.md#resolve)
-
-#### Call Signature
-
-> **resolve**\<`T`\>(`all`, `options?`): `Promisable`\<`T`[]\>
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectResolver.d.ts:19
-
-##### Type Parameters
-
-###### T
-
-`T` *extends* `object` = `TResult`
-
-##### Parameters
-
-###### all
-
-`"*"`
-
-###### options?
-
-[`ObjectFilterOptions`](ObjectFilterOptions.md)\<`T`\>
-
-##### Returns
-
-`Promisable`\<`T`[]\>
-
-##### Inherited from
-
-[`ObjectResolver`](ObjectResolver.md).[`resolve`](ObjectResolver.md#resolve)
-
-#### Call Signature
-
-> **resolve**\<`T`\>(`id`, `options?`): `Promisable`\<`undefined` \| `T`\>
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectResolver.d.ts:20
-
-##### Type Parameters
-
-###### T
-
-`T` *extends* `object` = `TResult`
-
-##### Parameters
-
-###### id
-
-`string`
-
-###### options?
-
-[`ObjectFilterOptions`](ObjectFilterOptions.md)\<`T`\>
-
-##### Returns
-
-`Promisable`\<`undefined` \| `T`\>
-
-##### Inherited from
-
-[`ObjectResolver`](ObjectResolver.md).[`resolve`](ObjectResolver.md#resolve)
-
-#### Call Signature
-
-> **resolve**\<`T`\>(`id?`, `options?`): `Promisable`\<`undefined` \| `T` \| `T`[]\>
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectResolver.d.ts:21
-
-##### Type Parameters
-
-###### T
-
-`T` *extends* `object` = `TResult`
-
-##### Parameters
-
-###### id?
-
-`string`
-
-###### options?
-
-[`ObjectFilterOptions`](ObjectFilterOptions.md)\<`T`\>
-
-##### Returns
-
-`Promisable`\<`undefined` \| `T` \| `T`[]\>
-
-##### Inherited from
-
-[`ObjectResolver`](ObjectResolver.md).[`resolve`](ObjectResolver.md#resolve)
-
-***
-
-### resolvePrivate()
-
-#### Call Signature
-
-> **resolvePrivate**\<`T`\>(`all`, `options?`): `Promise`\<`T`[]\>
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectResolver.d.ts:22
-
-##### Type Parameters
-
-###### T
-
-`T` *extends* `object` = `TResult`
-
-##### Parameters
-
-###### all
-
-`"*"`
-
-###### options?
-
-[`ObjectFilterOptions`](ObjectFilterOptions.md)\<`T`\>
-
-##### Returns
-
-`Promise`\<`T`[]\>
-
-##### Inherited from
-
-[`ObjectResolver`](ObjectResolver.md).[`resolvePrivate`](ObjectResolver.md#resolveprivate)
-
-#### Call Signature
-
-> **resolvePrivate**\<`T`\>(`id`, `options?`): `Promise`\<`undefined` \| `T`\>
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectResolver.d.ts:23
-
-##### Type Parameters
-
-###### T
-
-`T` *extends* `object` = `TResult`
-
-##### Parameters
-
-###### id
-
-`string`
-
-###### options?
-
-[`ObjectFilterOptions`](ObjectFilterOptions.md)\<`T`\>
-
-##### Returns
-
-`Promise`\<`undefined` \| `T`\>
-
-##### Inherited from
-
-[`ObjectResolver`](ObjectResolver.md).[`resolvePrivate`](ObjectResolver.md#resolveprivate)
-
-#### Call Signature
-
-> **resolvePrivate**\<`T`\>(`id`, `options?`): `Promise`\<`undefined` \| `T` \| `T`[]\>
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectResolver.d.ts:24
-
-##### Type Parameters
-
-###### T
-
-`T` *extends* `object` = `TResult`
-
-##### Parameters
-
-###### id
-
-`string`
-
-###### options?
-
-[`ObjectFilterOptions`](ObjectFilterOptions.md)\<`T`\>
-
-##### Returns
-
-`Promise`\<`undefined` \| `T` \| `T`[]\>
-
-##### Inherited from
-
-[`ObjectResolver`](ObjectResolver.md).[`resolvePrivate`](ObjectResolver.md#resolveprivate)

package/docs/interfaces/ObserveEndEventData.md

@@ -1,55 +0,0 @@
-[@xyo-network/sdk-js](../README.md) / ObserveEndEventData
-
-# Interface: ObserveEndEventData\<T, TIn, TOut\>
-
-Defined in: packages/modules/packages/witness/packages/model/dist/types/EventsModels/ObserveEnd.d.ts:9
-
-## Extends
-
-- [`EventData`](../type-aliases/EventData.md)
-
-## Type Parameters
-
-### T
-
-`T` *extends* [`ModuleInstance`](ModuleInstance.md) = [`ModuleInstance`](ModuleInstance.md)
-
-### TIn
-
-`TIn` *extends* [`Payload`](../type-aliases/Payload.md) = [`Payload`](../type-aliases/Payload.md)
-
-### TOut
-
-`TOut` *extends* [`Payload`](../type-aliases/Payload.md) = [`Payload`](../type-aliases/Payload.md)
-
-## Indexable
-
-\[`key`: `string` \| `number` \| `symbol`\]: [`EventArgs`](../type-aliases/EventArgs.md)
-
-## Properties
-
-### observeEnd
-
-> **observeEnd**: `object` & `object`
-
-Defined in: packages/modules/packages/witness/packages/model/dist/types/EventsModels/ObserveEnd.d.ts:10
-
-#### Type declaration
-
-##### mod
-
-> **mod**: `T`
-
-#### Type declaration
-
-##### errors?
-
-> `optional` **errors**: `Error`[]
-
-##### inPayloads?
-
-> `optional` **inPayloads**: `TIn`[]
-
-##### outPayloads?
-
-> `optional` **outPayloads**: `TOut`[]

package/docs/interfaces/ObserveStartEventData.md

@@ -1,43 +0,0 @@
-[@xyo-network/sdk-js](../README.md) / ObserveStartEventData
-
-# Interface: ObserveStartEventData\<T, TIn\>
-
-Defined in: packages/modules/packages/witness/packages/model/dist/types/EventsModels/ObserveStart.d.ts:7
-
-## Extends
-
-- [`EventData`](../type-aliases/EventData.md)
-
-## Type Parameters
-
-### T
-
-`T` *extends* [`ModuleInstance`](ModuleInstance.md) = [`ModuleInstance`](ModuleInstance.md)
-
-### TIn
-
-`TIn` *extends* [`Payload`](../type-aliases/Payload.md) = [`Payload`](../type-aliases/Payload.md)
-
-## Indexable
-
-\[`key`: `string` \| `number` \| `symbol`\]: [`EventArgs`](../type-aliases/EventArgs.md)
-
-## Properties
-
-### observeStart
-
-> **observeStart**: `object` & `object`
-
-Defined in: packages/modules/packages/witness/packages/model/dist/types/EventsModels/ObserveStart.d.ts:8
-
-#### Type declaration
-
-##### mod
-
-> **mod**: `T`
-
-#### Type declaration
-
-##### inPayloads?
-
-> `optional` **inPayloads**: `TIn`[]

package/docs/interfaces/PackageManifest.md

@@ -1,37 +0,0 @@
-[@xyo-network/sdk-js](../README.md) / PackageManifest
-
-# Interface: PackageManifest
-
-Defined in: packages/manifest/packages/model/dist/types/Manifest.d.ts:29
-
-## Extends
-
-- [`Manifest`](Manifest.md)
-
-## Properties
-
-### description?
-
-> `optional` **description**: `string`
-
-Defined in: packages/manifest/packages/model/dist/types/Manifest.d.ts:4
-
-#### Inherited from
-
-[`Manifest`](Manifest.md).[`description`](Manifest.md#description)
-
-***
-
-### modules?
-
-> `optional` **modules**: `Record`\<`string`, [`ModuleManifest`](ModuleManifest.md)\>
-
-Defined in: packages/manifest/packages/model/dist/types/Manifest.d.ts:30
-
-***
-
-### nodes
-
-> **nodes**: [`NodeManifest`](NodeManifest.md)[]
-
-Defined in: packages/manifest/packages/model/dist/types/Manifest.d.ts:31

package/docs/interfaces/PayloadBuilderOptions.md

@@ -1,21 +0,0 @@
-[@xyo-network/sdk-js](../README.md) / PayloadBuilderOptions
-
-# Interface: PayloadBuilderOptions
-
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Options.d.ts:3
-
-## Properties
-
-### logger?
-
-> `readonly` `optional` **logger**: `Logger`
-
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Options.d.ts:4
-
-***
-
-### schema
-
-> `readonly` **schema**: `string`
-
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Options.d.ts:5

package/docs/interfaces/PayloadFields.md

@@ -1,23 +0,0 @@
-[@xyo-network/sdk-js](../README.md) / PayloadFields
-
-# Interface: PayloadFields
-
-Defined in: packages/protocol/packages/payload/packages/model/dist/types/Payload.d.ts:8
-
-Additional fields for a payload
-
-## Extends
-
-- [`SchemaField`](SchemaField.md)
-
-## Properties
-
-### schema
-
-> **schema**: `string`
-
-Defined in: packages/protocol/packages/payload/packages/model/dist/types/Payload.d.ts:5
-
-#### Inherited from
-
-[`SchemaField`](SchemaField.md).[`schema`](SchemaField.md#schema)

package/docs/interfaces/PayloadFindFilter.md

@@ -1,29 +0,0 @@
-[@xyo-network/sdk-js](../README.md) / PayloadFindFilter
-
-# Interface: PayloadFindFilter
-
-Defined in: packages/protocol/packages/payload/packages/model/dist/types/PayloadFindFilter.d.ts:1
-
-## Properties
-
-### limit?
-
-> `optional` **limit**: `number`
-
-Defined in: packages/protocol/packages/payload/packages/model/dist/types/PayloadFindFilter.d.ts:2
-
-***
-
-### order?
-
-> `optional` **order**: `"asc"` \| `"desc"`
-
-Defined in: packages/protocol/packages/payload/packages/model/dist/types/PayloadFindFilter.d.ts:3
-
-***
-
-### schema?
-
-> `optional` **schema**: `string` \| `string`[]
-
-Defined in: packages/protocol/packages/payload/packages/model/dist/types/PayloadFindFilter.d.ts:4

package/docs/interfaces/PayloadMetaFields.md

@@ -1,21 +0,0 @@
-[@xyo-network/sdk-js](../README.md) / PayloadMetaFields
-
-# Interface: PayloadMetaFields
-
-Defined in: packages/protocol/packages/payload/packages/model/dist/types/Payload.d.ts:13
-
-## Extends
-
-- [`SourcesMetaField`](SourcesMetaField.md)
-
-## Properties
-
-### $sources
-
-> **$sources**: `Lowercase`\<`string`\>[]
-
-Defined in: packages/protocol/packages/payload/packages/model/dist/types/Payload.d.ts:11
-
-#### Inherited from
-
-[`SourcesMetaField`](SourcesMetaField.md).[`$sources`](SourcesMetaField.md#sources)

package/docs/interfaces/PayloadSet.md

@@ -1,21 +0,0 @@
-[@xyo-network/sdk-js](../README.md) / PayloadSet
-
-# Interface: PayloadSet
-
-Defined in: packages/protocol/packages/payload/packages/model/dist/types/PayloadSet/PayloadSetPayload.d.ts:3
-
-## Properties
-
-### optional?
-
-> `optional` **optional**: `Record`\<`string`, `number`\>
-
-Defined in: packages/protocol/packages/payload/packages/model/dist/types/PayloadSet/PayloadSetPayload.d.ts:4
-
-***
-
-### required?
-
-> `optional` **required**: `Record`\<`string`, `number`\>
-
-Defined in: packages/protocol/packages/payload/packages/model/dist/types/PayloadSet/PayloadSetPayload.d.ts:5

package/docs/interfaces/QueryFields.md

@@ -1,53 +0,0 @@
-[@xyo-network/sdk-js](../README.md) / QueryFields
-
-# Interface: QueryFields
-
-Defined in: packages/protocol/packages/payload/packages/model/dist/types/Query.d.ts:5
-
-## Properties
-
-### address?
-
-> `optional` **address**: `Lowercase`\<`string`\> \| `Lowercase`\<`string`\>[]
-
-Defined in: packages/protocol/packages/payload/packages/model/dist/types/Query.d.ts:7
-
-#### Field
-
-The addresses of the intended handlers
-
-***
-
-### budget?
-
-> `optional` **budget**: `number`
-
-Defined in: packages/protocol/packages/payload/packages/model/dist/types/Query.d.ts:9
-
-#### Field
-
-The maximum XYO that can be spent executing the query
-
-***
-
-### maxFrequency?
-
-> `optional` **maxFrequency**: `"once"` \| `"second"` \| `"minute"` \| `"hour"` \| `"day"` \| `"week"` \| `"month"` \| `"year"`
-
-Defined in: packages/protocol/packages/payload/packages/model/dist/types/Query.d.ts:11
-
-#### Field
-
-The frequency on which this query can be rerun
-
-***
-
-### minBid?
-
-> `optional` **minBid**: `number`
-
-Defined in: packages/protocol/packages/payload/packages/model/dist/types/Query.d.ts:13
-
-#### Field
-
-The starting point for the bidding on the query

package/docs/interfaces/QueryFulfillFinishedEventData.md

@@ -1,55 +0,0 @@
-[@xyo-network/sdk-js](../README.md) / QueryFulfillFinishedEventData
-
-# Interface: QueryFulfillFinishedEventData\<T\>
-
-Defined in: packages/modules/packages/bridge/packages/model/dist/types/Events/QueryFulfillFinished.d.ts:11
-
-## Extends
-
-- [`EventData`](../type-aliases/EventData.md)
-
-## Extended by
-
-- [`BridgeModuleEventData`](BridgeModuleEventData.md)
-
-## Type Parameters
-
-### T
-
-`T` *extends* [`Module`](Module.md) = [`Module`](Module.md)
-
-## Indexable
-
-\[`key`: `string` \| `number` \| `symbol`\]: [`EventArgs`](../type-aliases/EventArgs.md)
-
-## Properties
-
-### queryFulfillFinished
-
-> **queryFulfillFinished**: `object` & `object`
-
-Defined in: packages/modules/packages/bridge/packages/model/dist/types/Events/QueryFulfillFinished.d.ts:12
-
-#### Type declaration
-
-##### mod
-
-> **mod**: `T`
-
-#### Type declaration
-
-##### payloads?
-
-> `optional` **payloads**: [`Payload`](../type-aliases/Payload.md)[]
-
-##### query
-
-> **query**: [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md)
-
-##### result?
-
-> `optional` **result**: [`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)
-
-##### status
-
-> **status**: `"success"` \| `"failure"`

package/docs/interfaces/QueryFulfillStartedEventData.md

@@ -1,47 +0,0 @@
-[@xyo-network/sdk-js](../README.md) / QueryFulfillStartedEventData
-
-# Interface: QueryFulfillStartedEventData\<T\>
-
-Defined in: packages/modules/packages/bridge/packages/model/dist/types/Events/QueryFulfillStarted.d.ts:9
-
-## Extends
-
-- [`EventData`](../type-aliases/EventData.md)
-
-## Extended by
-
-- [`BridgeModuleEventData`](BridgeModuleEventData.md)
-
-## Type Parameters
-
-### T
-
-`T` *extends* [`Module`](Module.md) = [`Module`](Module.md)
-
-## Indexable
-
-\[`key`: `string` \| `number` \| `symbol`\]: [`EventArgs`](../type-aliases/EventArgs.md)
-
-## Properties
-
-### queryFulfillStarted
-
-> **queryFulfillStarted**: `object` & `object`
-
-Defined in: packages/modules/packages/bridge/packages/model/dist/types/Events/QueryFulfillStarted.d.ts:10
-
-#### Type declaration
-
-##### mod
-
-> **mod**: `T`
-
-#### Type declaration
-
-##### payloads?
-
-> `optional` **payloads**: [`Payload`](../type-aliases/Payload.md)[]
-
-##### query
-
-> **query**: [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md)