simplex-chat 6.5.0-beta.4.1 → 6.5.0-beta.4.2

package/docs/api.Class.ChatCommandError.md

@@ -0,0 +1,205 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [api](Namespace.api.md) / ChatCommandError
+
+# Class: ChatCommandError
+
+Defined in: [src/api.ts:5](../src/api.ts#L5)
+
+## Extends
+
+- `Error`
+
+## Constructors
+
+### Constructor
+
+> **new ChatCommandError**(`message`, `response`): `ChatCommandError`
+
+Defined in: [src/api.ts:6](../src/api.ts#L6)
+
+#### Parameters
+
+##### message
+
+`string`
+
+##### response
+
+`ChatResponse`
+
+#### Returns
+
+`ChatCommandError`
+
+#### Overrides
+
+`Error.constructor`
+
+## Properties
+
+### message
+
+> **message**: `string`
+
+Defined in: [src/api.ts:6](../src/api.ts#L6)
+
+#### Inherited from
+
+`Error.message`
+
+***
+
+### name
+
+> **name**: `string`
+
+Defined in: [node\_modules/typescript/lib/lib.es5.d.ts:1076](../node_modules/typescript/lib/lib.es5.d.ts#L1076)
+
+#### Inherited from
+
+`Error.name`
+
+***
+
+### response
+
+> **response**: `ChatResponse`
+
+Defined in: [src/api.ts:6](../src/api.ts#L6)
+
+***
+
+### stack?
+
+> `optional` **stack**: `string`
+
+Defined in: [node\_modules/typescript/lib/lib.es5.d.ts:1078](../node_modules/typescript/lib/lib.es5.d.ts#L1078)
+
+#### Inherited from
+
+`Error.stack`
+
+***
+
+### stackTraceLimit
+
+> `static` **stackTraceLimit**: `number`
+
+Defined in: [node\_modules/@types/node/globals.d.ts:67](../node_modules/@types/node/globals.d.ts#L67)
+
+The `Error.stackTraceLimit` property specifies the number of stack frames
+collected by a stack trace (whether generated by `new Error().stack` or
+`Error.captureStackTrace(obj)`).
+
+The default value is `10` but may be set to any valid JavaScript number. Changes
+will affect any stack trace captured _after_ the value has been changed.
+
+If set to a non-number value, or set to a negative number, stack traces will
+not capture any frames.
+
+#### Inherited from
+
+`Error.stackTraceLimit`
+
+## Methods
+
+### captureStackTrace()
+
+> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Defined in: [node\_modules/@types/node/globals.d.ts:51](../node_modules/@types/node/globals.d.ts#L51)
+
+Creates a `.stack` property on `targetObject`, which when accessed returns
+a string representing the location in the code at which
+`Error.captureStackTrace()` was called.
+
+```js
+const myObject = {};
+Error.captureStackTrace(myObject);
+myObject.stack;  // Similar to `new Error().stack`
+```
+
+The first line of the trace will be prefixed with
+`${myObject.name}: ${myObject.message}`.
+
+The optional `constructorOpt` argument accepts a function. If given, all frames
+above `constructorOpt`, including `constructorOpt`, will be omitted from the
+generated stack trace.
+
+The `constructorOpt` argument is useful for hiding implementation
+details of error generation from the user. For instance:
+
+```js
+function a() {
+  b();
+}
+
+function b() {
+  c();
+}
+
+function c() {
+  // Create an error without stack trace to avoid calculating the stack trace twice.
+  const { stackTraceLimit } = Error;
+  Error.stackTraceLimit = 0;
+  const error = new Error();
+  Error.stackTraceLimit = stackTraceLimit;
+
+  // Capture the stack trace above function b
+  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
+  throw error;
+}
+
+a();
+```
+
+#### Parameters
+
+##### targetObject
+
+`object`
+
+##### constructorOpt?
+
+`Function`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+`Error.captureStackTrace`
+
+***
+
+### prepareStackTrace()
+
+> `static` **prepareStackTrace**(`err`, `stackTraces`): `any`
+
+Defined in: [node\_modules/@types/node/globals.d.ts:55](../node_modules/@types/node/globals.d.ts#L55)
+
+#### Parameters
+
+##### err
+
+`Error`
+
+##### stackTraces
+
+`CallSite`[]
+
+#### Returns
+
+`any`
+
+#### See
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+#### Inherited from
+
+`Error.prepareStackTrace`

package/docs/api.Enumeration.ConnReqType.md

@@ -0,0 +1,27 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [api](Namespace.api.md) / ConnReqType
+
+# Enumeration: ConnReqType
+
+Defined in: [src/api.ts:15](../src/api.ts#L15)
+
+Connection request types.
+
+## Enumeration Members
+
+### Contact
+
+> **Contact**: `"contact"`
+
+Defined in: [src/api.ts:17](../src/api.ts#L17)
+
+***
+
+### Invitation
+
+> **Invitation**: `"invitation"`
+
+Defined in: [src/api.ts:16](../src/api.ts#L16)

package/docs/api.Interface.BotAddressSettings.md

@@ -0,0 +1,60 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [api](Namespace.api.md) / BotAddressSettings
+
+# Interface: BotAddressSettings
+
+Defined in: [src/api.ts:23](../src/api.ts#L23)
+
+Bot address settings.
+
+## Properties
+
+### autoAccept?
+
+> `optional` **autoAccept**: `boolean`
+
+Defined in: [src/api.ts:28](../src/api.ts#L28)
+
+Automatically accept contact requests.
+
+#### Default
+
+```ts
+true
+```
+
+***
+
+### businessAddress?
+
+> `optional` **businessAddress**: `boolean`
+
+Defined in: [src/api.ts:41](../src/api.ts#L41)
+
+Business contact address.
+For all requests business chats will be created where other participants can be added.
+
+#### Default
+
+```ts
+false
+```
+
+***
+
+### welcomeMessage?
+
+> `optional` **welcomeMessage**: `string` \| `MsgContent`
+
+Defined in: [src/api.ts:34](../src/api.ts#L34)
+
+Optional welcome message to show before connection to the users.
+
+#### Default
+
+```ts
+undefined (no welcome message)
+```

package/docs/api.TypeAlias.EventSubscriberFunc.md

@@ -0,0 +1,27 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [api](Namespace.api.md) / EventSubscriberFunc
+
+# Type Alias: EventSubscriberFunc()\<K\>
+
+> **EventSubscriberFunc**\<`K`\> = (`event`) => `void` \| `Promise`\<`void`\>
+
+Defined in: [src/api.ts:50](../src/api.ts#L50)
+
+## Type Parameters
+
+### K
+
+`K` *extends* `CEvt.Tag`
+
+## Parameters
+
+### event
+
+`ChatEvent` & \{ `type`: `K`; \}
+
+## Returns
+
+`void` \| `Promise`\<`void`\>

package/docs/api.TypeAlias.EventSubscribers.md

@@ -0,0 +1,11 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [api](Namespace.api.md) / EventSubscribers
+
+# Type Alias: EventSubscribers
+
+> **EventSubscribers** = `{ [K in CEvt.Tag]?: EventSubscriberFunc<K> }`
+
+Defined in: [src/api.ts:52](../src/api.ts#L52)

package/docs/api.Variable.defaultBotAddressSettings.md

@@ -0,0 +1,11 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [api](Namespace.api.md) / defaultBotAddressSettings
+
+# Variable: defaultBotAddressSettings
+
+> `const` **defaultBotAddressSettings**: [`BotAddressSettings`](api.Interface.BotAddressSettings.md)
+
+Defined in: [src/api.ts:44](../src/api.ts#L44)

package/docs/bot.Function.run.md

@@ -0,0 +1,21 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [bot](Namespace.bot.md) / run
+
+# Function: run()
+
+> **run**(`__namedParameters`): `Promise`\<\[[`ChatApi`](api.Class.ChatApi.md), `User`, `UserContactLink` \| `undefined`\]\>
+
+Defined in: [src/bot.ts:49](../src/bot.ts#L49)
+
+## Parameters
+
+### \_\_namedParameters
+
+[`BotConfig`](bot.Interface.BotConfig.md)
+
+## Returns
+
+`Promise`\<\[[`ChatApi`](api.Class.ChatApi.md), `User`, `UserContactLink` \| `undefined`\]\>

package/docs/bot.Interface.BotConfig.md

@@ -0,0 +1,75 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [bot](Namespace.bot.md) / BotConfig
+
+# Interface: BotConfig
+
+Defined in: [src/bot.ts:37](../src/bot.ts#L37)
+
+## Properties
+
+### dbOpts
+
+> **dbOpts**: [`BotDbOpts`](bot.Interface.BotDbOpts.md)
+
+Defined in: [src/bot.ts:39](../src/bot.ts#L39)
+
+***
+
+### events?
+
+> `optional` **events**: [`EventSubscribers`](api.TypeAlias.EventSubscribers.md)
+
+Defined in: [src/bot.ts:46](../src/bot.ts#L46)
+
+***
+
+### onCommands?
+
+> `optional` **onCommands**: \{\[`key`: `string`\]: (`chatItem`, `command`) => `void` \| `Promise`\<`void`\> \| `undefined`; \}
+
+Defined in: [src/bot.ts:43](../src/bot.ts#L43)
+
+#### Index Signature
+
+\[`key`: `string`\]: (`chatItem`, `command`) => `void` \| `Promise`\<`void`\> \| `undefined`
+
+***
+
+### onMessage()?
+
+> `optional` **onMessage**: (`chatItem`, `content`) => `void` \| `Promise`\<`void`\>
+
+Defined in: [src/bot.ts:41](../src/bot.ts#L41)
+
+#### Parameters
+
+##### chatItem
+
+`AChatItem`
+
+##### content
+
+`MsgContent`
+
+#### Returns
+
+`void` \| `Promise`\<`void`\>
+
+***
+
+### options
+
+> **options**: [`BotOptions`](bot.Interface.BotOptions.md)
+
+Defined in: [src/bot.ts:40](../src/bot.ts#L40)
+
+***
+
+### profile
+
+> **profile**: `Profile`
+
+Defined in: [src/bot.ts:38](../src/bot.ts#L38)

package/docs/bot.Interface.BotDbOpts.md

@@ -0,0 +1,33 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [bot](Namespace.bot.md) / BotDbOpts
+
+# Interface: BotDbOpts
+
+Defined in: [src/bot.ts:7](../src/bot.ts#L7)
+
+## Properties
+
+### confirmMigrations?
+
+> `optional` **confirmMigrations**: [`MigrationConfirmation`](core.Enumeration.MigrationConfirmation.md)
+
+Defined in: [src/bot.ts:10](../src/bot.ts#L10)
+
+***
+
+### dbFilePrefix
+
+> **dbFilePrefix**: `string`
+
+Defined in: [src/bot.ts:8](../src/bot.ts#L8)
+
+***
+
+### dbKey?
+
+> `optional` **dbKey**: `string`
+
+Defined in: [src/bot.ts:9](../src/bot.ts#L9)

package/docs/bot.Interface.BotOptions.md

@@ -0,0 +1,81 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [bot](Namespace.bot.md) / BotOptions
+
+# Interface: BotOptions
+
+Defined in: [src/bot.ts:13](../src/bot.ts#L13)
+
+## Properties
+
+### addressSettings?
+
+> `optional` **addressSettings**: [`BotAddressSettings`](api.Interface.BotAddressSettings.md)
+
+Defined in: [src/bot.ts:17](../src/bot.ts#L17)
+
+***
+
+### allowFiles?
+
+> `optional` **allowFiles**: `boolean`
+
+Defined in: [src/bot.ts:18](../src/bot.ts#L18)
+
+***
+
+### commands?
+
+> `optional` **commands**: `ChatBotCommand`[]
+
+Defined in: [src/bot.ts:19](../src/bot.ts#L19)
+
+***
+
+### createAddress?
+
+> `optional` **createAddress**: `boolean`
+
+Defined in: [src/bot.ts:14](../src/bot.ts#L14)
+
+***
+
+### logContacts?
+
+> `optional` **logContacts**: `boolean`
+
+Defined in: [src/bot.ts:21](../src/bot.ts#L21)
+
+***
+
+### logNetwork?
+
+> `optional` **logNetwork**: `boolean`
+
+Defined in: [src/bot.ts:22](../src/bot.ts#L22)
+
+***
+
+### updateAddress?
+
+> `optional` **updateAddress**: `boolean`
+
+Defined in: [src/bot.ts:15](../src/bot.ts#L15)
+
+***
+
+### updateProfile?
+
+> `optional` **updateProfile**: `boolean`
+
+Defined in: [src/bot.ts:16](../src/bot.ts#L16)
+
+***
+
+### useBotProfile?
+
+> `optional` **useBotProfile**: `boolean`
+
+Defined in: [src/bot.ts:20](../src/bot.ts#L20)