@xyo-network/sdk-js 3.14.16 → 3.14.18

package/docs/interfaces/Module.md

@@ -0,0 +1,492 @@
+[@xyo-network/sdk-js](../README.md) / Module
+
+# Interface: Module\<TParams, TEventData\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/Module.d.ts:5
+
+## Extends
+
+- [`ModuleFields`](ModuleFields.md)\<`TParams`\>.[`EventFunctions`](EventFunctions.md)\<`TEventData`\>
+
+## Extended by
+
+- [`ArchivistModuleInstance`](ArchivistModuleInstance.md)
+- [`BridgeModule`](BridgeModule.md)
+- [`DivinerModule`](DivinerModule.md)
+- [`ModuleInstance`](ModuleInstance.md)
+- [`NodeModule`](NodeModule.md)
+- [`SentinelModule`](SentinelModule.md)
+- [`CustomSentinelModule`](CustomSentinelModule.md)
+- [`WitnessModule`](WitnessModule.md)
+
+## Type Parameters
+
+### TParams
+
+`TParams` *extends* [`ModuleParams`](../type-aliases/ModuleParams.md) = [`ModuleParams`](../type-aliases/ModuleParams.md)
+
+### TEventData
+
+`TEventData` *extends* [`ModuleEventData`](ModuleEventData.md)\<`object`\> = [`ModuleEventData`](ModuleEventData.md)\<`object`\>
+
+## Properties
+
+### address
+
+> **address**: `Lowercase`\<`string`\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:10
+
+#### Inherited from
+
+[`ModuleFields`](ModuleFields.md).[`address`](ModuleFields.md#address)
+
+***
+
+### config
+
+> **config**: `TParams`\[`"config"`\]
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:11
+
+#### Inherited from
+
+[`ModuleFields`](ModuleFields.md).[`config`](ModuleFields.md#config)
+
+***
+
+### eventData
+
+> **eventData**: `TEventData`
+
+Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:11
+
+#### Inherited from
+
+[`EventFunctions`](EventFunctions.md).[`eventData`](EventFunctions.md#eventdata)
+
+***
+
+### id
+
+> **id**: `string`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:13
+
+The name (if specified) or address of the module
+
+#### Inherited from
+
+[`ModuleFields`](ModuleFields.md).[`id`](ModuleFields.md#id)
+
+***
+
+### modName?
+
+> `optional` **modName**: `string`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:14
+
+#### Inherited from
+
+[`ModuleFields`](ModuleFields.md).[`modName`](ModuleFields.md#modname)
+
+***
+
+### params
+
+> **params**: `TParams`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:15
+
+#### Inherited from
+
+[`ModuleFields`](ModuleFields.md).[`params`](ModuleFields.md#params)
+
+***
+
+### previousHash()
+
+> **previousHash**: () => `Promisable`\<`undefined` \| `string`\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:16
+
+#### Returns
+
+`Promisable`\<`undefined` \| `string`\>
+
+#### Inherited from
+
+[`ModuleFields`](ModuleFields.md).[`previousHash`](ModuleFields.md#previoushash)
+
+***
+
+### queries
+
+> **queries**: `string`[]
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:17
+
+#### Inherited from
+
+[`ModuleFields`](ModuleFields.md).[`queries`](ModuleFields.md#queries)
+
+***
+
+### query()
+
+> **query**: \<`T`, `TConf`\>(`query`, `payloads?`, `queryConfig?`) => `Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:18
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md) = [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md)
+
+##### TConf
+
+`TConf` *extends* [`ModuleConfig`](../type-aliases/ModuleConfig.md) = [`ModuleConfig`](../type-aliases/ModuleConfig.md)
+
+#### Parameters
+
+##### query
+
+`T`
+
+##### payloads?
+
+[`Payload`](../type-aliases/Payload.md)[]
+
+##### queryConfig?
+
+`TConf`
+
+#### Returns
+
+`Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
+
+#### Inherited from
+
+[`ModuleFields`](ModuleFields.md).[`query`](ModuleFields.md#query)
+
+***
+
+### queryable()
+
+> **queryable**: \<`T`, `TConf`\>(`query`, `payloads?`, `queryConfig?`) => `Promisable`\<`boolean`\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:19
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md) = [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md)
+
+##### TConf
+
+`TConf` *extends* [`ModuleConfig`](../type-aliases/ModuleConfig.md) = [`ModuleConfig`](../type-aliases/ModuleConfig.md)
+
+#### Parameters
+
+##### query
+
+`T`
+
+##### payloads?
+
+[`Payload`](../type-aliases/Payload.md)[]
+
+##### queryConfig?
+
+`TConf`
+
+#### Returns
+
+`Promisable`\<`boolean`\>
+
+#### Inherited from
+
+[`ModuleFields`](ModuleFields.md).[`queryable`](ModuleFields.md#queryable)
+
+***
+
+### start()?
+
+> `optional` **start**: () => `Promisable`\<`boolean`\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:20
+
+#### Returns
+
+`Promisable`\<`boolean`\>
+
+#### Inherited from
+
+[`ModuleFields`](ModuleFields.md).[`start`](ModuleFields.md#start)
+
+***
+
+### stop()?
+
+> `optional` **stop**: () => `Promisable`\<`boolean`\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:21
+
+#### Returns
+
+`Promisable`\<`boolean`\>
+
+#### Inherited from
+
+[`ModuleFields`](ModuleFields.md).[`stop`](ModuleFields.md#stop)
+
+## Methods
+
+### clearListeners()
+
+> **clearListeners**(`eventNames`): `void`
+
+Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:12
+
+#### Parameters
+
+##### eventNames
+
+keyof `TEventData` | keyof `TEventData`[]
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`EventFunctions`](EventFunctions.md).[`clearListeners`](EventFunctions.md#clearlisteners)
+
+***
+
+### emit()
+
+> **emit**\<`TEventName`\>(`eventName`, `eventArgs`): `Promise`\<`void`\>
+
+Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:13
+
+#### Type Parameters
+
+##### TEventName
+
+`TEventName` *extends* `string` \| `number` \| `symbol`
+
+#### Parameters
+
+##### eventName
+
+`TEventName`
+
+##### eventArgs
+
+`TEventData`\[`TEventName`\]
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Inherited from
+
+[`EventFunctions`](EventFunctions.md).[`emit`](EventFunctions.md#emit)
+
+***
+
+### emitSerial()
+
+> **emitSerial**\<`TEventName`\>(`eventName`, `eventArgs`): `Promise`\<`void`\>
+
+Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:14
+
+#### Type Parameters
+
+##### TEventName
+
+`TEventName` *extends* `string` \| `number` \| `symbol`
+
+#### Parameters
+
+##### eventName
+
+`TEventName`
+
+##### eventArgs
+
+`TEventData`\[`TEventName`\]
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Inherited from
+
+[`EventFunctions`](EventFunctions.md).[`emitSerial`](EventFunctions.md#emitserial)
+
+***
+
+### listenerCount()
+
+> **listenerCount**(`eventNames`): `number`
+
+Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:15
+
+#### Parameters
+
+##### eventNames
+
+keyof `TEventData` | keyof `TEventData`[]
+
+#### Returns
+
+`number`
+
+#### Inherited from
+
+[`EventFunctions`](EventFunctions.md).[`listenerCount`](EventFunctions.md#listenercount)
+
+***
+
+### off()
+
+> **off**\<`TEventName`\>(`eventNames`, `listener`): `void`
+
+Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:16
+
+#### Type Parameters
+
+##### TEventName
+
+`TEventName` *extends* `string` \| `number` \| `symbol`
+
+#### Parameters
+
+##### eventNames
+
+`TEventName` | `TEventName`[]
+
+##### listener
+
+[`EventListener`](../type-aliases/EventListener.md)\<`TEventData`\[`TEventName`\]\>
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`EventFunctions`](EventFunctions.md).[`off`](EventFunctions.md#off)
+
+***
+
+### offAny()
+
+> **offAny**(`listener`): `void`
+
+Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:17
+
+#### Parameters
+
+##### listener
+
+`Promise`\<`void`\> | [`EventAnyListener`](../type-aliases/EventAnyListener.md)\<[`EventArgs`](../type-aliases/EventArgs.md)\>
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`EventFunctions`](EventFunctions.md).[`offAny`](EventFunctions.md#offany)
+
+***
+
+### on()
+
+> **on**\<`TEventName`\>(`eventNames`, `listener`): [`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
+
+Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:18
+
+#### Type Parameters
+
+##### TEventName
+
+`TEventName` *extends* `string` \| `number` \| `symbol`
+
+#### Parameters
+
+##### eventNames
+
+`TEventName` | `TEventName`[]
+
+##### listener
+
+[`EventListener`](../type-aliases/EventListener.md)\<`TEventData`\[`TEventName`\]\>
+
+#### Returns
+
+[`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
+
+#### Inherited from
+
+[`EventFunctions`](EventFunctions.md).[`on`](EventFunctions.md#on)
+
+***
+
+### onAny()
+
+> **onAny**(`listener`): [`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
+
+Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:19
+
+#### Parameters
+
+##### listener
+
+[`EventAnyListener`](../type-aliases/EventAnyListener.md)
+
+#### Returns
+
+[`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
+
+#### Inherited from
+
+[`EventFunctions`](EventFunctions.md).[`onAny`](EventFunctions.md#onany)
+
+***
+
+### once()
+
+> **once**\<`TEventName`\>(`eventName`, `listener`): [`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
+
+Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:20
+
+#### Type Parameters
+
+##### TEventName
+
+`TEventName` *extends* `string` \| `number` \| `symbol`
+
+#### Parameters
+
+##### eventName
+
+`TEventName`
+
+##### listener
+
+[`EventListener`](../type-aliases/EventListener.md)\<`TEventData`\[`TEventName`\]\>
+
+#### Returns
+
+[`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
+
+#### Inherited from
+
+[`EventFunctions`](EventFunctions.md).[`once`](EventFunctions.md#once)

package/docs/interfaces/ModuleAttachedEventData.md

@@ -0,0 +1,29 @@
+[@xyo-network/sdk-js](../README.md) / ModuleAttachedEventData
+
+# Interface: ModuleAttachedEventData
+
+Defined in: packages/modules/packages/node/packages/model/dist/types/EventsModels/ModuleAttached.d.ts:4
+
+## Extends
+
+- [`EventData`](../type-aliases/EventData.md)
+
+## Extended by
+
+- [`NodeModuleEventData`](NodeModuleEventData.md)
+
+## Indexable
+
+\[`key`: `string` \| `number` \| `symbol`\]: [`EventArgs`](../type-aliases/EventArgs.md)
+
+## Properties
+
+### moduleAttached
+
+> **moduleAttached**: `object`
+
+Defined in: packages/modules/packages/node/packages/model/dist/types/EventsModels/ModuleAttached.d.ts:5
+
+#### mod
+
+> **mod**: [`Module`](Module.md)

package/docs/interfaces/ModuleBusyEventData.md

@@ -0,0 +1,43 @@
+[@xyo-network/sdk-js](../README.md) / ModuleBusyEventData
+
+# Interface: ModuleBusyEventData\<TModule\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/EventsModels/ModuleBusy.d.ts:6
+
+## Extends
+
+- [`EventData`](../type-aliases/EventData.md)
+
+## Extended by
+
+- [`ModuleEventData`](ModuleEventData.md)
+
+## Type Parameters
+
+### TModule
+
+`TModule` *extends* `object` = `object`
+
+## Indexable
+
+\[`key`: `string` \| `number` \| `symbol`\]: [`EventArgs`](../type-aliases/EventArgs.md)
+
+## Properties
+
+### moduleBusy
+
+> **moduleBusy**: `object` & `object`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/EventsModels/ModuleBusy.d.ts:7
+
+#### Type declaration
+
+##### mod
+
+> **mod**: `TModule`
+
+#### Type declaration
+
+##### busy
+
+> **busy**: `boolean`

package/docs/interfaces/ModuleConfigFields.md

@@ -0,0 +1,130 @@
+[@xyo-network/sdk-js](../README.md) / ModuleConfigFields
+
+# Interface: ModuleConfigFields
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/Config/Fields.d.ts:7
+
+## Properties
+
+### allowedQueries?
+
+> `readonly` `optional` **allowedQueries**: `string`[]
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/Config/Fields.d.ts:9
+
+Limit to only these allowed queries
+
+***
+
+### archivist?
+
+> `readonly` `optional` **archivist**: `string`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/Config/Fields.d.ts:11
+
+#### Field
+
+The name/address of the Archivist to use for this module
+
+***
+
+### labels?
+
+> `readonly` `optional` **labels**: [`Labels`](Labels.md)
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/Config/Fields.d.ts:17
+
+#### Field
+
+The labels used for this module. If a label is specified, then the
+ModuleFactoryLocator will attempt to find a ModuleFactory with the corresponding
+labels to construct this module.
+
+***
+
+### logLevel?
+
+> `readonly` `optional` **logLevel**: `LogLevel`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/Config/Fields.d.ts:18
+
+***
+
+### name?
+
+> `readonly` `optional` **name**: `string`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/Config/Fields.d.ts:20
+
+#### Field
+
+Friendly name of module (not collision resistant). Can be used to resolve module when registered/attached to Node.
+
+***
+
+### paging?
+
+> `readonly` `optional` **paging**: `Record`\<`string`, \{ `size?`: `number`; \}\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/Config/Fields.d.ts:22
+
+#### Field
+
+paging settings for queries
+
+***
+
+### retry?
+
+> `readonly` `optional` **retry**: `RetryConfig`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/Config/Fields.d.ts:25
+
+***
+
+### security?
+
+> `readonly` `optional` **security**: [`ModuleSecurityConfig`](ModuleSecurityConfig.md)
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/Config/Fields.d.ts:28
+
+#### Field
+
+The query schemas and allowed/disallowed addresses which are allowed to issue them against the module.
+If both allowed and disallowed is specified, then disallowed takes priority.
+
+***
+
+### sign?
+
+> `readonly` `optional` **sign**: `boolean`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/Config/Fields.d.ts:30
+
+#### Field
+
+sign every query
+
+***
+
+### storeQueries?
+
+> `readonly` `optional` **storeQueries**: `boolean`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/Config/Fields.d.ts:32
+
+#### Field
+
+Store the queries made to the module in an archivist if possible
+
+***
+
+### timestamp?
+
+> `readonly` `optional` **timestamp**: `boolean`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/Config/Fields.d.ts:34
+
+#### Field
+
+add a timestamp payload to every query