@shhhum/simplex-chat 0.0.0-placeholder → 7.1.0-beta.6.1

package/docs/core.Function.chatMigrateInit.md

@@ -0,0 +1,37 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / chatMigrateInit
+
+# Function: chatMigrateInit()
+
+> **chatMigrateInit**(`dbPath`, `dbKey`, `confirm`, `queueSize?`): `Promise`\<`bigint`\>
+
+Defined in: [src/core.ts:30](../src/core.ts#L30)
+
+Initialize chat controller
+
+## Parameters
+
+### dbPath
+
+`string`
+
+### dbKey
+
+`string`
+
+### confirm
+
+[`MigrationConfirmation`](core.Enumeration.MigrationConfirmation.md)
+
+### queueSize?
+
+`number`
+
+Size of internal queues, the core default is used when omitted.
+
+## Returns
+
+`Promise`\<`bigint`\>

package/docs/core.Function.chatReadFile.md

@@ -0,0 +1,27 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / chatReadFile
+
+# Function: chatReadFile()
+
+> **chatReadFile**(`path`, `__namedParameters`): `Promise`\<`Buffer`\<`ArrayBufferLike`\>\>
+
+Defined in: [src/core.ts:83](../src/core.ts#L83)
+
+Read buffer from encrypted file
+
+## Parameters
+
+### path
+
+`string`
+
+### \_\_namedParameters
+
+[`CryptoArgs`](core.Interface.CryptoArgs.md)
+
+## Returns
+
+`Promise`\<`Buffer`\<`ArrayBufferLike`\>\>

package/docs/core.Function.chatRecvMsgWait.md

@@ -0,0 +1,27 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / chatRecvMsgWait
+
+# Function: chatRecvMsgWait()
+
+> **chatRecvMsgWait**(`ctrl`, `wait`): `Promise`\<`ChatEvent` \| `undefined`\>
+
+Defined in: [src/core.ts:62](../src/core.ts#L62)
+
+Receive chat event
+
+## Parameters
+
+### ctrl
+
+`bigint`
+
+### wait
+
+`number`
+
+## Returns
+
+`Promise`\<`ChatEvent` \| `undefined`\>

package/docs/core.Function.chatSendCmd.md

@@ -0,0 +1,27 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / chatSendCmd
+
+# Function: chatSendCmd()
+
+> **chatSendCmd**(`ctrl`, `cmd`): `Promise`\<`ChatResponse`\>
+
+Defined in: [src/core.ts:50](../src/core.ts#L50)
+
+Send chat command as string
+
+## Parameters
+
+### ctrl
+
+`bigint`
+
+### cmd
+
+`string`
+
+## Returns
+
+`Promise`\<`ChatResponse`\>

package/docs/core.Function.chatWriteFile.md

@@ -0,0 +1,31 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / chatWriteFile
+
+# Function: chatWriteFile()
+
+> **chatWriteFile**(`ctrl`, `path`, `buffer`): `Promise`\<[`CryptoArgs`](core.Interface.CryptoArgs.md)\>
+
+Defined in: [src/core.ts:75](../src/core.ts#L75)
+
+Write buffer to encrypted file
+
+## Parameters
+
+### ctrl
+
+`bigint`
+
+### path
+
+`string`
+
+### buffer
+
+`ArrayBuffer` \| `Uint8Array`\<`ArrayBufferLike`\>
+
+## Returns
+
+`Promise`\<[`CryptoArgs`](core.Interface.CryptoArgs.md)\>

package/docs/core.Function.loadLibrary.md

@@ -0,0 +1,24 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / loadLibrary
+
+# Function: loadLibrary()
+
+> **loadLibrary**(`backend`): `Promise`\<`void`\>
+
+Defined in: [src/core.ts:13](../src/core.ts#L13)
+
+Resolve (downloading on first use) and load libsimplex for the backend.
+One libsimplex per process: the Haskell runtime is initialized once, and another backend is rejected.
+
+## Parameters
+
+### backend
+
+[`Backend`](core.TypeAlias.Backend.md)
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/core.Interface.APIResult.md

@@ -0,0 +1,31 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / APIResult
+
+# Interface: APIResult\<R\>
+
+Defined in: [src/core.ts:112](../src/core.ts#L112)
+
+## Type Parameters
+
+### R
+
+`R`
+
+## Properties
+
+### error?
+
+> `optional` **error?**: `ChatError`
+
+Defined in: [src/core.ts:114](../src/core.ts#L114)
+
+***
+
+### result?
+
+> `optional` **result?**: `R`
+
+Defined in: [src/core.ts:113](../src/core.ts#L113)

package/docs/core.Interface.CryptoArgs.md

@@ -0,0 +1,27 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / CryptoArgs
+
+# Interface: CryptoArgs
+
+Defined in: [src/core.ts:136](../src/core.ts#L136)
+
+File encryption key and nonce
+
+## Properties
+
+### fileKey
+
+> **fileKey**: `string`
+
+Defined in: [src/core.ts:137](../src/core.ts#L137)
+
+***
+
+### fileNonce
+
+> **fileNonce**: `string`
+
+Defined in: [src/core.ts:138](../src/core.ts#L138)

package/docs/core.Interface.UpMigration.md

@@ -0,0 +1,25 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / UpMigration
+
+# Interface: UpMigration
+
+Defined in: [src/core.ts:215](../src/core.ts#L215)
+
+## Properties
+
+### upName
+
+> **upName**: `string`
+
+Defined in: [src/core.ts:216](../src/core.ts#L216)
+
+***
+
+### withDown
+
+> **withDown**: `boolean`
+
+Defined in: [src/core.ts:217](../src/core.ts#L217)

package/docs/core.MTRError.Interface.MTREDifferent.md

@@ -0,0 +1,33 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / [MTRError](core.Namespace.MTRError.md) / MTREDifferent
+
+# Interface: MTREDifferent
+
+Defined in: [src/core.ts:236](../src/core.ts#L236)
+
+## Extends
+
+- `Interface`
+
+## Properties
+
+### downMigrations
+
+> **downMigrations**: `string`[]
+
+Defined in: [src/core.ts:238](../src/core.ts#L238)
+
+***
+
+### type
+
+> **type**: `"different"`
+
+Defined in: [src/core.ts:237](../src/core.ts#L237)
+
+#### Overrides
+
+`Interface.type`

package/docs/core.MTRError.Interface.MTRENoDown.md

@@ -0,0 +1,33 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / [MTRError](core.Namespace.MTRError.md) / MTRENoDown
+
+# Interface: MTRENoDown
+
+Defined in: [src/core.ts:231](../src/core.ts#L231)
+
+## Extends
+
+- `Interface`
+
+## Properties
+
+### dbMigrations
+
+> **dbMigrations**: `string`[]
+
+Defined in: [src/core.ts:233](../src/core.ts#L233)
+
+***
+
+### type
+
+> **type**: `"noDown"`
+
+Defined in: [src/core.ts:232](../src/core.ts#L232)
+
+#### Overrides
+
+`Interface.type`

package/docs/core.MTRError.TypeAlias.Tag.md

@@ -0,0 +1,11 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / [MTRError](core.Namespace.MTRError.md) / Tag
+
+# Type Alias: Tag
+
+> **Tag** = `"noDown"` \| `"different"`
+
+Defined in: [src/core.ts:225](../src/core.ts#L225)

package/docs/core.MigrationError.Interface.MEDowngrade.md

@@ -0,0 +1,33 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / [MigrationError](core.Namespace.MigrationError.md) / MEDowngrade
+
+# Interface: MEDowngrade
+
+Defined in: [src/core.ts:204](../src/core.ts#L204)
+
+## Extends
+
+- `Interface`
+
+## Properties
+
+### downMigrations
+
+> **downMigrations**: `string`[]
+
+Defined in: [src/core.ts:206](../src/core.ts#L206)
+
+***
+
+### type
+
+> **type**: `"downgrade"`
+
+Defined in: [src/core.ts:205](../src/core.ts#L205)
+
+#### Overrides
+
+`Interface.type`

package/docs/core.MigrationError.Interface.MEUpgrade.md

@@ -0,0 +1,33 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / [MigrationError](core.Namespace.MigrationError.md) / MEUpgrade
+
+# Interface: MEUpgrade
+
+Defined in: [src/core.ts:199](../src/core.ts#L199)
+
+## Extends
+
+- `Interface`
+
+## Properties
+
+### type
+
+> **type**: `"upgrade"`
+
+Defined in: [src/core.ts:200](../src/core.ts#L200)
+
+#### Overrides
+
+`Interface.type`
+
+***
+
+### upMigrations
+
+> **upMigrations**: [`UpMigration`](core.Interface.UpMigration.md)[]
+
+Defined in: [src/core.ts:201](../src/core.ts#L201)

package/docs/core.MigrationError.Interface.MigrationError.md

@@ -0,0 +1,33 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / [MigrationError](core.Namespace.MigrationError.md) / MigrationError
+
+# Interface: MigrationError
+
+Defined in: [src/core.ts:209](../src/core.ts#L209)
+
+## Extends
+
+- `Interface`
+
+## Properties
+
+### mtrError
+
+> **mtrError**: [`MTRError`](core.TypeAlias.MTRError.md)
+
+Defined in: [src/core.ts:211](../src/core.ts#L211)
+
+***
+
+### type
+
+> **type**: `"migrationError"`
+
+Defined in: [src/core.ts:210](../src/core.ts#L210)
+
+#### Overrides
+
+`Interface.type`

package/docs/core.MigrationError.TypeAlias.Tag.md

@@ -0,0 +1,11 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / [MigrationError](core.Namespace.MigrationError.md) / Tag
+
+# Type Alias: Tag
+
+> **Tag** = `"upgrade"` \| `"downgrade"` \| `"migrationError"`
+
+Defined in: [src/core.ts:193](../src/core.ts#L193)

package/docs/core.Namespace.DBMigrationError.md

@@ -0,0 +1,19 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / DBMigrationError
+
+# DBMigrationError
+
+## Interfaces
+
+- [ErrorMigration](core.DBMigrationError.Interface.ErrorMigration.md)
+- [ErrorNotADatabase](core.DBMigrationError.Interface.ErrorNotADatabase.md)
+- [ErrorSQL](core.DBMigrationError.Interface.ErrorSQL.md)
+- [InvalidConfirmation](core.DBMigrationError.Interface.InvalidConfirmation.md)
+- [InvalidQueueSize](core.DBMigrationError.Interface.InvalidQueueSize.md)
+
+## Type Aliases
+
+- [Tag](core.DBMigrationError.TypeAlias.Tag.md)

package/docs/core.Namespace.MTRError.md

@@ -0,0 +1,16 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / MTRError
+
+# MTRError
+
+## Interfaces
+
+- [MTREDifferent](core.MTRError.Interface.MTREDifferent.md)
+- [MTRENoDown](core.MTRError.Interface.MTRENoDown.md)
+
+## Type Aliases
+
+- [Tag](core.MTRError.TypeAlias.Tag.md)

package/docs/core.Namespace.MigrationError.md

@@ -0,0 +1,17 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / MigrationError
+
+# MigrationError
+
+## Interfaces
+
+- [MEDowngrade](core.MigrationError.Interface.MEDowngrade.md)
+- [MEUpgrade](core.MigrationError.Interface.MEUpgrade.md)
+- [MigrationError](core.MigrationError.Interface.MigrationError.md)
+
+## Type Aliases
+
+- [Tag](core.MigrationError.TypeAlias.Tag.md)

package/docs/core.TypeAlias.Backend.md

@@ -0,0 +1,11 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / Backend
+
+# Type Alias: Backend
+
+> **Backend** = `"sqlite"` \| `"postgres"`
+
+Defined in: [src/core.ts:5](../src/core.ts#L5)

package/docs/core.TypeAlias.DBMigrationError.md

@@ -0,0 +1,11 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / DBMigrationError
+
+# Type Alias: DBMigrationError
+
+> **DBMigrationError** = [`InvalidConfirmation`](core.DBMigrationError.Interface.InvalidConfirmation.md) \| [`InvalidQueueSize`](core.DBMigrationError.Interface.InvalidQueueSize.md) \| [`ErrorNotADatabase`](core.DBMigrationError.Interface.ErrorNotADatabase.md) \| [`ErrorMigration`](core.DBMigrationError.Interface.ErrorMigration.md) \| [`ErrorSQL`](core.DBMigrationError.Interface.ErrorSQL.md)
+
+Defined in: [src/core.ts:147](../src/core.ts#L147)

package/docs/core.TypeAlias.MTRError.md

@@ -0,0 +1,11 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / MTRError
+
+# Type Alias: MTRError
+
+> **MTRError** = [`MTRENoDown`](core.MTRError.Interface.MTRENoDown.md) \| [`MTREDifferent`](core.MTRError.Interface.MTREDifferent.md)
+
+Defined in: [src/core.ts:220](../src/core.ts#L220)

package/docs/core.TypeAlias.MigrationError.md

@@ -0,0 +1,11 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / MigrationError
+
+# Type Alias: MigrationError
+
+> **MigrationError** = [`MEUpgrade`](core.MigrationError.Interface.MEUpgrade.md) \| [`MEDowngrade`](core.MigrationError.Interface.MEDowngrade.md) \| [`MigrationError`](core.MigrationError.Interface.MigrationError.md)
+
+Defined in: [src/core.ts:187](../src/core.ts#L187)

package/docs/util.Function.botAddressSettings.md

@@ -0,0 +1,21 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [util](Namespace.util.md) / botAddressSettings
+
+# Function: botAddressSettings()
+
+> **botAddressSettings**(`__namedParameters`): [`BotAddressSettings`](api.Interface.BotAddressSettings.md)
+
+Defined in: [src/util.ts:48](../src/util.ts#L48)
+
+## Parameters
+
+### \_\_namedParameters
+
+`UserContactLink`
+
+## Returns
+
+[`BotAddressSettings`](api.Interface.BotAddressSettings.md)

package/docs/util.Function.chatInfoName.md

@@ -0,0 +1,21 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [util](Namespace.util.md) / chatInfoName
+
+# Function: chatInfoName()
+
+> **chatInfoName**(`cInfo`): `string`
+
+Defined in: [src/util.ts:18](../src/util.ts#L18)
+
+## Parameters
+
+### cInfo
+
+`ChatInfo`
+
+## Returns
+
+`string`

package/docs/util.Function.chatInfoRef.md

@@ -0,0 +1,21 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [util](Namespace.util.md) / chatInfoRef
+
+# Function: chatInfoRef()
+
+> **chatInfoRef**(`cInfo`): `ChatRef` \| `undefined`
+
+Defined in: [src/util.ts:4](../src/util.ts#L4)
+
+## Parameters
+
+### cInfo
+
+`ChatInfo`
+
+## Returns
+
+`ChatRef` \| `undefined`

package/docs/util.Function.ciBotCommand.md

@@ -0,0 +1,21 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [util](Namespace.util.md) / ciBotCommand
+
+# Function: ciBotCommand()
+
+> **ciBotCommand**(`chatItem`): [`BotCommand`](util.Interface.BotCommand.md) \| `undefined`
+
+Defined in: [src/util.ts:78](../src/util.ts#L78)
+
+## Parameters
+
+### chatItem
+
+`ChatItem`
+
+## Returns
+
+[`BotCommand`](util.Interface.BotCommand.md) \| `undefined`

package/docs/util.Function.ciContentText.md

@@ -0,0 +1,21 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [util](Namespace.util.md) / ciContentText
+
+# Function: ciContentText()
+
+> **ciContentText**(`__namedParameters`): `string` \| `undefined`
+
+Defined in: [src/util.ts:64](../src/util.ts#L64)
+
+## Parameters
+
+### \_\_namedParameters
+
+`ChatItem`
+
+## Returns
+
+`string` \| `undefined`