@xyo-network/sdk-js 4.3.0 → 5.0.1

package/docs/interfaces/ModuleResolver.md

@@ -1,243 +0,0 @@
-[@xyo-network/sdk-js](../README.md) / ModuleResolver
-
-# Interface: ModuleResolver\<TResult\>
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ModuleResolver.d.ts:18
-
-## Extends
-
-- [`ObjectResolver`](ObjectResolver.md)\<`TResult`\>
-
-## Extended by
-
-- [`ModuleResolverInstance`](ModuleResolverInstance.md)
-
-## Type Parameters
-
-### TResult
-
-`TResult` *extends* [`ModuleInstance`](ModuleInstance.md) = [`ModuleInstance`](ModuleInstance.md)
-
-## Properties
-
-### 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)
-
-## 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* [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`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* [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`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* [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`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* [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`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* [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`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* [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`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* [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`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/ModuleResolverInstance.md

@@ -1,317 +0,0 @@
-[@xyo-network/sdk-js](../README.md) / ModuleResolverInstance
-
-# Interface: ModuleResolverInstance\<TResult\>
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ModuleResolver.d.ts:24
-
-## Extends
-
-- [`ModuleResolver`](ModuleResolver.md)\<`TResult`\>.[`ModuleNameResolver`](ModuleNameResolver.md)
-
-## Extended by
-
-- [`ModuleRepository`](ModuleRepository.md)
-
-## Type Parameters
-
-### TResult
-
-`TResult` *extends* [`ModuleInstance`](ModuleInstance.md) = [`ModuleInstance`](ModuleInstance.md)
-
-## Properties
-
-### addResolver()
-
-> **addResolver**: (`resolver`) => `this`
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ModuleResolver.d.ts:25
-
-#### Parameters
-
-##### resolver
-
-`ModuleResolverInstance`\<`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
-
-[`ModuleResolver`](ModuleResolver.md).[`priority`](ModuleResolver.md#priority)
-
-***
-
-### removeResolver()
-
-> **removeResolver**: (`resolver`) => `this`
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ModuleResolver.d.ts:26
-
-#### Parameters
-
-##### resolver
-
-`ModuleResolverInstance`\<`TResult`\>
-
-#### Returns
-
-`this`
-
-***
-
-### root
-
-> `readonly` **root**: [`ModuleInstance`](ModuleInstance.md)
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ModuleResolver.d.ts:21
-
-#### Inherited from
-
-[`ModuleNameResolver`](ModuleNameResolver.md).[`root`](ModuleNameResolver.md#root)
-
-## 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* [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\> = `TResult`
-
-##### Returns
-
-`Promisable`\<`undefined` \| `T`\>
-
-##### Deprecated
-
-do not pass undefined.  If trying to get all, pass '*'
-
-##### Inherited from
-
-[`ModuleResolver`](ModuleResolver.md).[`resolve`](ModuleResolver.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* [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\> = `TResult`
-
-##### Parameters
-
-###### all
-
-`"*"`
-
-###### options?
-
-[`ObjectFilterOptions`](ObjectFilterOptions.md)\<`T`\>
-
-##### Returns
-
-`Promisable`\<`T`[]\>
-
-##### Inherited from
-
-[`ModuleResolver`](ModuleResolver.md).[`resolve`](ModuleResolver.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* [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\> = `TResult`
-
-##### Parameters
-
-###### id
-
-`string`
-
-###### options?
-
-[`ObjectFilterOptions`](ObjectFilterOptions.md)\<`T`\>
-
-##### Returns
-
-`Promisable`\<`undefined` \| `T`\>
-
-##### Inherited from
-
-[`ModuleResolver`](ModuleResolver.md).[`resolve`](ModuleResolver.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* [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\> = `TResult`
-
-##### Parameters
-
-###### id?
-
-`string`
-
-###### options?
-
-[`ObjectFilterOptions`](ObjectFilterOptions.md)\<`T`\>
-
-##### Returns
-
-`Promisable`\<`undefined` \| `T` \| `T`[]\>
-
-##### Inherited from
-
-[`ModuleResolver`](ModuleResolver.md).[`resolve`](ModuleResolver.md#resolve)
-
-***
-
-### resolveIdentifier()
-
-> **resolveIdentifier**(`id`, `options?`): `Promisable`\<`undefined` \| `Lowercase`\<`string`\>\>
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ModuleResolver.d.ts:22
-
-#### Parameters
-
-##### id
-
-`string`
-
-##### options?
-
-[`ObjectFilterOptions`](ObjectFilterOptions.md)\<`AnyObject`\>
-
-#### Returns
-
-`Promisable`\<`undefined` \| `Lowercase`\<`string`\>\>
-
-#### Inherited from
-
-[`ModuleNameResolver`](ModuleNameResolver.md).[`resolveIdentifier`](ModuleNameResolver.md#resolveidentifier)
-
-***
-
-### 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* [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\> = `TResult`
-
-##### Parameters
-
-###### all
-
-`"*"`
-
-###### options?
-
-[`ObjectFilterOptions`](ObjectFilterOptions.md)\<`T`\>
-
-##### Returns
-
-`Promise`\<`T`[]\>
-
-##### Inherited from
-
-[`ModuleResolver`](ModuleResolver.md).[`resolvePrivate`](ModuleResolver.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* [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\> = `TResult`
-
-##### Parameters
-
-###### id
-
-`string`
-
-###### options?
-
-[`ObjectFilterOptions`](ObjectFilterOptions.md)\<`T`\>
-
-##### Returns
-
-`Promise`\<`undefined` \| `T`\>
-
-##### Inherited from
-
-[`ModuleResolver`](ModuleResolver.md).[`resolvePrivate`](ModuleResolver.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* [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\> = `TResult`
-
-##### Parameters
-
-###### id
-
-`string`
-
-###### options?
-
-[`ObjectFilterOptions`](ObjectFilterOptions.md)\<`T`\>
-
-##### Returns
-
-`Promise`\<`undefined` \| `T` \| `T`[]\>
-
-##### Inherited from
-
-[`ModuleResolver`](ModuleResolver.md).[`resolvePrivate`](ModuleResolver.md#resolveprivate)

package/docs/interfaces/ModuleResolverParams.md

@@ -1,41 +0,0 @@
-[@xyo-network/sdk-js](../README.md) / ModuleResolverParams
-
-# Interface: ModuleResolverParams
-
-Defined in: packages/modules/packages/module/packages/resolver/dist/types/AbstractModuleResolver.d.ts:7
-
-## Extends
-
-- `BaseParams`
-
-## Extended by
-
-- [`CompositeModuleResolverParams`](CompositeModuleResolverParams.md)
-
-## Properties
-
-### logger?
-
-> `optional` **logger**: `Logger`
-
-Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:5
-
-#### Inherited from
-
-`BaseParams.logger`
-
-***
-
-### priority?
-
-> `optional` **priority**: [`ObjectResolverPriority`](../type-aliases/ObjectResolverPriority.md)
-
-Defined in: packages/modules/packages/module/packages/resolver/dist/types/AbstractModuleResolver.d.ts:8
-
-***
-
-### root
-
-> **root**: [`ModuleInstance`](ModuleInstance.md)
-
-Defined in: packages/modules/packages/module/packages/resolver/dist/types/AbstractModuleResolver.d.ts:9

package/docs/interfaces/ModuleSecurityConfig.md

@@ -1,41 +0,0 @@
-[@xyo-network/sdk-js](../README.md) / ModuleSecurityConfig
-
-# Interface: ModuleSecurityConfig
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/Config/Security.d.ts:4
-
-## Properties
-
-### allowAnonymous?
-
-> `readonly` `optional` **allowAnonymous**: `boolean`
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/Config/Security.d.ts:6
-
-#### Field
-
-Will the module process queries that have unsigned BoundWitness in query tuples
-
-***
-
-### allowed?
-
-> `readonly` `optional` **allowed**: `Record`\<`string`, (`Lowercase`\<`string`\> \| [`CosigningAddressSet`](../type-aliases/CosigningAddressSet.md))[]\>
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/Config/Security.d.ts:8
-
-#### Field
-
-If schema in record, then only these address sets can access query
-
-***
-
-### disallowed?
-
-> `readonly` `optional` **disallowed**: `Record`\<`string`, `Lowercase`\<`string`\>[]\>
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/Config/Security.d.ts:10
-
-#### Field
-
-If schema in record, then anyone except these addresses can access query

package/docs/interfaces/ModuleSubscribeFilter.md

@@ -1,17 +0,0 @@
-[@xyo-network/sdk-js](../README.md) / ModuleSubscribeFilter
-
-# Interface: ModuleSubscribeFilter
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/Queries/Subscribe.d.ts:5
-
-## Properties
-
-### schema?
-
-> `optional` **schema**: `string`[]
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/Queries/Subscribe.d.ts:7
-
-#### Field
-
-if specified, at least one of the schemas must be present in the boundwtness to generate a notification

package/docs/interfaces/ModuleTask.md

@@ -1,55 +0,0 @@
-[@xyo-network/sdk-js](../README.md) / ModuleTask
-
-# Interface: ModuleTask\<TEndpoints\>
-
-Defined in: packages/modules/packages/sentinel/packages/model/dist/types/Task.d.ts:2
-
-## Type Parameters
-
-### TEndpoints
-
-`TEndpoints` *extends* `string` = `string`
-
-## Properties
-
-### endPoint?
-
-> `optional` **endPoint**: `TEndpoints`
-
-Defined in: packages/modules/packages/sentinel/packages/model/dist/types/Task.d.ts:4
-
-#### Field
-
-the name of the endPoint that is being called.  If not specified, the default endPoint is used
-
-***
-
-### input?
-
-> `optional` **input**: `string` \| `boolean` \| `string`[]
-
-Defined in: packages/modules/packages/sentinel/packages/model/dist/types/Task.d.ts:6
-
-#### Field
-
-determines what inputs are sent to each module - if string, that is the output from other module (name/address)
-
-***
-
-### mod
-
-> **mod**: `string`
-
-Defined in: packages/modules/packages/sentinel/packages/model/dist/types/Task.d.ts:8
-
-#### Field
-
-the modules that performs the task
-
-***
-
-### required?
-
-> `optional` **required**: `boolean`
-
-Defined in: packages/modules/packages/sentinel/packages/model/dist/types/Task.d.ts:9