@xyo-network/sdk-js 3.14.16 → 3.14.18

package/docs/interfaces/QueryObjectFilter.md

@@ -0,0 +1,95 @@
+[@xyo-network/sdk-js](../README.md) / QueryObjectFilter
+
+# Interface: QueryObjectFilter\<T\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectFilter.d.ts:24
+
+## Extends
+
+- [`ObjectFilterOptions`](ObjectFilterOptions.md)\<`T`\>
+
+## Type Parameters
+
+### T
+
+`T` *extends* `EmptyObject` = `AnyObject`
+
+## Properties
+
+### direction?
+
+> `optional` **direction**: [`Direction`](../type-aliases/Direction.md)
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectFilter.d.ts:13
+
+#### Inherited from
+
+[`ObjectFilterOptions`](ObjectFilterOptions.md).[`direction`](ObjectFilterOptions.md#direction)
+
+***
+
+### identity?
+
+> `optional` **identity**: `TypeCheck`\<`T`\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectFilter.d.ts:14
+
+#### Inherited from
+
+[`ObjectFilterOptions`](ObjectFilterOptions.md).[`identity`](ObjectFilterOptions.md#identity)
+
+***
+
+### maxDepth?
+
+> `optional` **maxDepth**: `number`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectFilter.d.ts:7
+
+#### Inherited from
+
+[`ObjectFilterOptions`](ObjectFilterOptions.md).[`maxDepth`](ObjectFilterOptions.md#maxdepth)
+
+***
+
+### query
+
+> **query**: `string`[][]
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectFilter.d.ts:25
+
+***
+
+### required?
+
+> `optional` **required**: `boolean` \| `"warn"` \| `"log"`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectFilter.d.ts:8
+
+#### Inherited from
+
+[`ObjectFilterOptions`](ObjectFilterOptions.md).[`required`](ObjectFilterOptions.md#required)
+
+***
+
+### retry?
+
+> `optional` **retry**: `number`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectFilter.d.ts:9
+
+#### Inherited from
+
+[`ObjectFilterOptions`](ObjectFilterOptions.md).[`retry`](ObjectFilterOptions.md#retry)
+
+***
+
+### timeout?
+
+> `optional` **timeout**: `number`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectFilter.d.ts:10
+
+#### Inherited from
+
+[`ObjectFilterOptions`](ObjectFilterOptions.md).[`timeout`](ObjectFilterOptions.md#timeout)

package/docs/interfaces/QuerySendFinishedEventData.md

@@ -0,0 +1,55 @@
+[@xyo-network/sdk-js](../README.md) / QuerySendFinishedEventData
+
+# Interface: QuerySendFinishedEventData\<T\>
+
+Defined in: packages/modules/packages/bridge/packages/model/dist/types/Events/QuerySendFinished.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
+
+### querySendFinished
+
+> **querySendFinished**: `object` & `object`
+
+Defined in: packages/modules/packages/bridge/packages/model/dist/types/Events/QuerySendFinished.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/QuerySendStartedEventData.md

@@ -0,0 +1,47 @@
+[@xyo-network/sdk-js](../README.md) / QuerySendStartedEventData
+
+# Interface: QuerySendStartedEventData\<T\>
+
+Defined in: packages/modules/packages/bridge/packages/model/dist/types/Events/QuerySendStarted.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
+
+### querySendStarted
+
+> **querySendStarted**: `object` & `object`
+
+Defined in: packages/modules/packages/bridge/packages/model/dist/types/Events/QuerySendStarted.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)

package/docs/interfaces/ReadArchivist.md

@@ -0,0 +1,68 @@
+[@xyo-network/sdk-js](../README.md) / ReadArchivist
+
+# Interface: ReadArchivist\<TReadResponse, TId\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/PayloadArchivist.d.ts:6
+
+## Extends
+
+- [`ReadArchivistFunctions`](ReadArchivistFunctions.md)\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`TReadResponse`\>, `TId`\>
+
+## Extended by
+
+- [`ReadWriteArchivist`](ReadWriteArchivist.md)
+- [`Archivist`](Archivist.md)
+
+## Type Parameters
+
+### TReadResponse
+
+`TReadResponse` *extends* [`Payload`](../type-aliases/Payload.md) = [`Payload`](../type-aliases/Payload.md)
+
+### TId
+
+`TId` = `Hash`
+
+## Methods
+
+### get()
+
+> **get**(`ids`): `PromisableArray`\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`TReadResponse`\>\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/ArchivistFunctions.d.ts:7
+
+#### Parameters
+
+##### ids
+
+`TId`[]
+
+#### Returns
+
+`PromisableArray`\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`TReadResponse`\>\>
+
+#### Inherited from
+
+[`ReadArchivistFunctions`](ReadArchivistFunctions.md).[`get`](ReadArchivistFunctions.md#get)
+
+***
+
+### next()
+
+> **next**(`options?`): `PromisableArray`\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`TReadResponse`\>\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/ArchivistFunctions.d.ts:8
+
+#### Parameters
+
+##### options?
+
+[`NextOptions`](NextOptions.md)\<`TId`\>
+
+#### Returns
+
+`PromisableArray`\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`TReadResponse`\>\>
+
+#### Inherited from
+
+[`ReadArchivistFunctions`](ReadArchivistFunctions.md).[`next`](ReadArchivistFunctions.md#next)

package/docs/interfaces/ReadArchivistFunctions.md

@@ -0,0 +1,55 @@
+[@xyo-network/sdk-js](../README.md) / ReadArchivistFunctions
+
+# Interface: ReadArchivistFunctions\<TReadResponse, TId\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/ArchivistFunctions.d.ts:6
+
+## Extended by
+
+- [`ReadArchivist`](ReadArchivist.md)
+
+## Type Parameters
+
+### TReadResponse
+
+`TReadResponse`
+
+### TId
+
+`TId` = `string`
+
+## Methods
+
+### get()
+
+> **get**(`ids`): `PromisableArray`\<`TReadResponse`\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/ArchivistFunctions.d.ts:7
+
+#### Parameters
+
+##### ids
+
+`TId`[]
+
+#### Returns
+
+`PromisableArray`\<`TReadResponse`\>
+
+***
+
+### next()
+
+> **next**(`options?`): `PromisableArray`\<`TReadResponse`\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/ArchivistFunctions.d.ts:8
+
+#### Parameters
+
+##### options?
+
+[`NextOptions`](NextOptions.md)\<`TId`\>
+
+#### Returns
+
+`PromisableArray`\<`TReadResponse`\>

package/docs/interfaces/ReadWriteArchivist.md

@@ -0,0 +1,135 @@
+[@xyo-network/sdk-js](../README.md) / ReadWriteArchivist
+
+# Interface: ReadWriteArchivist\<TReadResponse, TWriteResponse, TWrite, TId\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/PayloadArchivist.d.ts:10
+
+## Extends
+
+- [`WriteArchivist`](WriteArchivist.md)\<`TReadResponse`, `TWriteResponse`, `TWrite`, `TId`\>.[`ReadArchivist`](ReadArchivist.md)\<`TReadResponse`, `TId`\>
+
+## Extended by
+
+- [`FullArchivist`](FullArchivist.md)
+
+## Type Parameters
+
+### TReadResponse
+
+`TReadResponse` *extends* [`Payload`](../type-aliases/Payload.md) = [`Payload`](../type-aliases/Payload.md)
+
+### TWriteResponse
+
+`TWriteResponse` *extends* [`Payload`](../type-aliases/Payload.md) = `TReadResponse`
+
+### TWrite
+
+`TWrite` *extends* [`Payload`](../type-aliases/Payload.md) = `TReadResponse`
+
+### TId
+
+`TId` = `Hash`
+
+## Methods
+
+### clear()
+
+> **clear**(): `Promisable`\<`void`\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/ArchivistFunctions.d.ts:11
+
+#### Returns
+
+`Promisable`\<`void`\>
+
+#### Inherited from
+
+[`WriteArchivist`](WriteArchivist.md).[`clear`](WriteArchivist.md#clear)
+
+***
+
+### delete()
+
+> **delete**(`ids`): `PromisableArray`\<`TId`\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/ArchivistFunctions.d.ts:12
+
+#### Parameters
+
+##### ids
+
+`TId`[]
+
+#### Returns
+
+`PromisableArray`\<`TId`\>
+
+#### Inherited from
+
+[`WriteArchivist`](WriteArchivist.md).[`delete`](WriteArchivist.md#delete)
+
+***
+
+### get()
+
+> **get**(`ids`): `PromisableArray`\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`TReadResponse`\>\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/ArchivistFunctions.d.ts:7
+
+#### Parameters
+
+##### ids
+
+`TId`[]
+
+#### Returns
+
+`PromisableArray`\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`TReadResponse`\>\>
+
+#### Inherited from
+
+[`ReadArchivist`](ReadArchivist.md).[`get`](ReadArchivist.md#get)
+
+***
+
+### insert()
+
+> **insert**(`item`): `PromisableArray`\<`TWriteResponse`\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/ArchivistFunctions.d.ts:13
+
+#### Parameters
+
+##### item
+
+`TWrite`[]
+
+#### Returns
+
+`PromisableArray`\<`TWriteResponse`\>
+
+#### Inherited from
+
+[`WriteArchivist`](WriteArchivist.md).[`insert`](WriteArchivist.md#insert)
+
+***
+
+### next()
+
+> **next**(`options?`): `PromisableArray`\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`TReadResponse`\>\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/ArchivistFunctions.d.ts:8
+
+#### Parameters
+
+##### options?
+
+[`NextOptions`](NextOptions.md)\<`TId`\>
+
+#### Returns
+
+`PromisableArray`\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`TReadResponse`\>\>
+
+#### Inherited from
+
+[`ReadArchivist`](ReadArchivist.md).[`next`](ReadArchivist.md#next)

package/docs/interfaces/ReportEndEventData.md

@@ -0,0 +1,51 @@
+[@xyo-network/sdk-js](../README.md) / ReportEndEventData
+
+# Interface: ReportEndEventData\<T\>
+
+Defined in: packages/modules/packages/sentinel/packages/model/dist/types/EventsModels/ReportEnd.d.ts:10
+
+## Extends
+
+- [`EventData`](../type-aliases/EventData.md)
+
+## Extended by
+
+- [`SentinelModuleEventData`](SentinelModuleEventData.md)
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Module`](Module.md) = [`Module`](Module.md)
+
+## Indexable
+
+\[`key`: `string` \| `number` \| `symbol`\]: [`EventArgs`](../type-aliases/EventArgs.md)
+
+## Properties
+
+### reportEnd
+
+> **reportEnd**: `object` & `object`
+
+Defined in: packages/modules/packages/sentinel/packages/model/dist/types/EventsModels/ReportEnd.d.ts:11
+
+#### Type declaration
+
+##### mod
+
+> **mod**: `T`
+
+#### Type declaration
+
+##### boundwitness?
+
+> `optional` **boundwitness**: [`BoundWitness`](../type-aliases/BoundWitness.md)
+
+##### inPayloads?
+
+> `optional` **inPayloads**: [`Payload`](../type-aliases/Payload.md)[]
+
+##### outPayloads?
+
+> `optional` **outPayloads**: [`Payload`](../type-aliases/Payload.md)[]

package/docs/interfaces/ReportStartEventData.md

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

package/docs/interfaces/ResolveHelperConfig.md

@@ -0,0 +1,69 @@
+[@xyo-network/sdk-js](../README.md) / ResolveHelperConfig
+
+# Interface: ResolveHelperConfig
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/ResolveHelper/ResolveHelper.d.ts:7
+
+## Properties
+
+### address
+
+> **address**: `Lowercase`\<`string`\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/ResolveHelper/ResolveHelper.d.ts:8
+
+***
+
+### dead?
+
+> `optional` **dead**: `boolean`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/ResolveHelper/ResolveHelper.d.ts:9
+
+***
+
+### downResolver?
+
+> `optional` **downResolver**: [`ModuleResolver`](ModuleResolver.md)\<[`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/ResolveHelper/ResolveHelper.d.ts:10
+
+***
+
+### logger?
+
+> `optional` **logger**: `Logger`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/ResolveHelper/ResolveHelper.d.ts:11
+
+***
+
+### mod
+
+> **mod**: [`ModuleInstance`](ModuleInstance.md)
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/ResolveHelper/ResolveHelper.d.ts:12
+
+***
+
+### privateResolver?
+
+> `optional` **privateResolver**: [`ModuleResolver`](ModuleResolver.md)\<[`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/ResolveHelper/ResolveHelper.d.ts:13
+
+***
+
+### transformers
+
+> **transformers**: [`ModuleIdentifierTransformer`](ModuleIdentifierTransformer.md)[]
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/ResolveHelper/ResolveHelper.d.ts:14
+
+***
+
+### upResolver?
+
+> `optional` **upResolver**: [`ModuleResolver`](ModuleResolver.md)\<[`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/ResolveHelper/ResolveHelper.d.ts:15

package/docs/interfaces/ResolveStrategy.md

@@ -0,0 +1,41 @@
+[@xyo-network/sdk-js](../README.md) / ResolveStrategy
+
+# Interface: ResolveStrategy
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectFilter.d.ts:6
+
+## Extended by
+
+- [`ObjectFilterOptions`](ObjectFilterOptions.md)
+
+## Properties
+
+### maxDepth?
+
+> `optional` **maxDepth**: `number`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectFilter.d.ts:7
+
+***
+
+### required?
+
+> `optional` **required**: `boolean` \| `"warn"` \| `"log"`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectFilter.d.ts:8
+
+***
+
+### retry?
+
+> `optional` **retry**: `number`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectFilter.d.ts:9
+
+***
+
+### timeout?
+
+> `optional` **timeout**: `number`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectFilter.d.ts:10

package/docs/interfaces/ResolverEventEmitter.md

@@ -0,0 +1,27 @@
+[@xyo-network/sdk-js](../README.md) / ResolverEventEmitter
+
+# Interface: ResolverEventEmitter
+
+Defined in: packages/modules/packages/module/packages/resolver/dist/types/ResolverEventEmitter.d.ts:6
+
+## Methods
+
+### on()
+
+> **on**(`event`, `listener`): `void`
+
+Defined in: packages/modules/packages/module/packages/resolver/dist/types/ResolverEventEmitter.d.ts:7
+
+#### Parameters
+
+##### event
+
+`"moduleResolved"`
+
+##### listener
+
+(`args`) => `void`
+
+#### Returns
+
+`void`