simplex-chat 6.5.0-beta.4.4 → 6.5.1

package/docs/api.Class.ChatCommandError.md

@@ -74,7 +74,7 @@ Defined in: [src/api.ts:6](../src/api.ts#L6)
 
 ### stack?
 
-> `optional` **stack**: `string`
+> `optional` **stack?**: `string`
 
 Defined in: [node\_modules/typescript/lib/lib.es5.d.ts:1078](../node_modules/typescript/lib/lib.es5.d.ts#L1078)
 

package/docs/api.Interface.BotAddressSettings.md

@@ -14,7 +14,7 @@ Bot address settings.
 
 ### autoAccept?
 
-> `optional` **autoAccept**: `boolean`
+> `optional` **autoAccept?**: `boolean`
 
 Defined in: [src/api.ts:28](../src/api.ts#L28)
 
@@ -30,7 +30,7 @@ true
 
 ### businessAddress?
 
-> `optional` **businessAddress**: `boolean`
+> `optional` **businessAddress?**: `boolean`
 
 Defined in: [src/api.ts:41](../src/api.ts#L41)
 
@@ -47,7 +47,7 @@ false
 
 ### welcomeMessage?
 
-> `optional` **welcomeMessage**: `string` \| `MsgContent`
+> `optional` **welcomeMessage?**: `string` \| `MsgContent`
 
 Defined in: [src/api.ts:34](../src/api.ts#L34)
 

package/docs/api.TypeAlias.DbConfig.md

@@ -0,0 +1,64 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [api](Namespace.api.md) / DbConfig
+
+# Type Alias: DbConfig
+
+> **DbConfig** = \{ `encryptionKey?`: `string`; `filePrefix`: `string`; `type`: `"sqlite"`; \} \| \{ `connectionString`: `string`; `schemaPrefix?`: `string`; `type`: `"postgres"`; \}
+
+Defined in: [src/api.ts:65](../src/api.ts#L65)
+
+Database configuration. The native library is built against exactly one
+backend (see `simplex_backend` / `SIMPLEX_BACKEND` at install time); this
+type makes the caller state which one they are targeting so field names
+can't lie about their meaning.
+
+## Union Members
+
+### Type Literal
+
+\{ `encryptionKey?`: `string`; `filePrefix`: `string`; `type`: `"sqlite"`; \}
+
+#### encryptionKey?
+
+> `optional` **encryptionKey?**: `string`
+
+Optional SQLCipher encryption key. Empty/omitted = unencrypted.
+
+#### filePrefix
+
+> **filePrefix**: `string`
+
+File prefix — two schema files are named `<prefix>_chat.db` and `<prefix>_agent.db`.
+
+#### type
+
+> **type**: `"sqlite"`
+
+SQLite backend (default).
+
+***
+
+### Type Literal
+
+\{ `connectionString`: `string`; `schemaPrefix?`: `string`; `type`: `"postgres"`; \}
+
+#### connectionString
+
+> **connectionString**: `string`
+
+PostgreSQL connection string (e.g. `postgres://user:pass@host/db`).
+
+#### schemaPrefix?
+
+> `optional` **schemaPrefix?**: `string`
+
+Schema prefix used to namespace tables. Defaults to `"simplex_v1"` when omitted.
+
+#### type
+
+> **type**: `"postgres"`
+
+PostgreSQL backend (Linux x86_64 only, libpq5 required).

package/docs/api.TypeAlias.EventSubscriberFunc.md

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

package/docs/bot.Function.run.md

@@ -8,7 +8,7 @@
 
 > **run**(`__namedParameters`): `Promise`\<\[[`ChatApi`](api.Class.ChatApi.md), `User`, `UserContactLink` \| `undefined`\]\>
 
-Defined in: [src/bot.ts:49](../src/bot.ts#L49)
+Defined in: [src/bot.ts:47](../src/bot.ts#L47)
 
 ## Parameters
 

package/docs/bot.Interface.BotConfig.md

@@ -6,43 +6,43 @@
 
 # Interface: BotConfig
 
-Defined in: [src/bot.ts:37](../src/bot.ts#L37)
+Defined in: [src/bot.ts:35](../src/bot.ts#L35)
 
 ## Properties
 
 ### dbOpts
 
-> **dbOpts**: [`BotDbOpts`](bot.Interface.BotDbOpts.md)
+> **dbOpts**: [`BotDbOpts`](bot.TypeAlias.BotDbOpts.md)
 
-Defined in: [src/bot.ts:39](../src/bot.ts#L39)
+Defined in: [src/bot.ts:37](../src/bot.ts#L37)
 
 ***
 
 ### events?
 
-> `optional` **events**: [`EventSubscribers`](api.TypeAlias.EventSubscribers.md)
+> `optional` **events?**: [`EventSubscribers`](api.TypeAlias.EventSubscribers.md)
 
-Defined in: [src/bot.ts:46](../src/bot.ts#L46)
+Defined in: [src/bot.ts:44](../src/bot.ts#L44)
 
 ***
 
 ### onCommands?
 
-> `optional` **onCommands**: \{\[`key`: `string`\]: (`chatItem`, `command`) => `void` \| `Promise`\<`void`\> \| `undefined`; \}
+> `optional` **onCommands?**: `object`
 
-Defined in: [src/bot.ts:43](../src/bot.ts#L43)
+Defined in: [src/bot.ts:41](../src/bot.ts#L41)
 
 #### Index Signature
 
-\[`key`: `string`\]: (`chatItem`, `command`) => `void` \| `Promise`\<`void`\> \| `undefined`
+\[`key`: `string`\]: ((`chatItem`, `command`) => `void` \| `Promise`\<`void`\>) \| `undefined`
 
 ***
 
-### onMessage()?
+### onMessage?
 
-> `optional` **onMessage**: (`chatItem`, `content`) => `void` \| `Promise`\<`void`\>
+> `optional` **onMessage?**: (`chatItem`, `content`) => `void` \| `Promise`\<`void`\>
 
-Defined in: [src/bot.ts:41](../src/bot.ts#L41)
+Defined in: [src/bot.ts:39](../src/bot.ts#L39)
 
 #### Parameters
 
@@ -64,7 +64,7 @@ Defined in: [src/bot.ts:41](../src/bot.ts#L41)
 
 > **options**: [`BotOptions`](bot.Interface.BotOptions.md)
 
-Defined in: [src/bot.ts:40](../src/bot.ts#L40)
+Defined in: [src/bot.ts:38](../src/bot.ts#L38)
 
 ***
 
@@ -72,4 +72,4 @@ Defined in: [src/bot.ts:40](../src/bot.ts#L40)
 
 > **profile**: `Profile`
 
-Defined in: [src/bot.ts:38](../src/bot.ts#L38)
+Defined in: [src/bot.ts:36](../src/bot.ts#L36)

package/docs/bot.Interface.BotOptions.md

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

package/docs/bot.TypeAlias.BotDbOpts.md

@@ -0,0 +1,17 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [bot](Namespace.bot.md) / BotDbOpts
+
+# Type Alias: BotDbOpts
+
+> **BotDbOpts** = [`DbConfig`](api.TypeAlias.DbConfig.md) & `object`
+
+Defined in: [src/bot.ts:7](../src/bot.ts#L7)
+
+## Type Declaration
+
+### confirmMigrations?
+
+> `optional` **confirmMigrations?**: [`MigrationConfirmation`](core.Enumeration.MigrationConfirmation.md)

package/docs/core.Class.ChatAPIError.md

@@ -16,7 +16,7 @@ Defined in: [src/core.ts:92](../src/core.ts#L92)
 
 ### Constructor
 
-> **new ChatAPIError**(`message`, `chatError`): `ChatAPIError`
+> **new ChatAPIError**(`message`, `chatError?`): `ChatAPIError`
 
 Defined in: [src/core.ts:93](../src/core.ts#L93)
 
@@ -26,9 +26,9 @@ Defined in: [src/core.ts:93](../src/core.ts#L93)
 
 `string`
 
-##### chatError
+##### chatError?
 
-`ChatError` | `undefined`
+`ChatError` \| `undefined`
 
 #### Returns
 
@@ -74,7 +74,7 @@ Defined in: [node\_modules/typescript/lib/lib.es5.d.ts:1076](../node_modules/typ
 
 ### stack?
 
-> `optional` **stack**: `string`
+> `optional` **stack?**: `string`
 
 Defined in: [node\_modules/typescript/lib/lib.es5.d.ts:1078](../node_modules/typescript/lib/lib.es5.d.ts#L1078)
 

package/docs/core.Class.ChatInitError.md

@@ -74,7 +74,7 @@ Defined in: [node\_modules/typescript/lib/lib.es5.d.ts:1076](../node_modules/typ
 
 ### stack?
 
-> `optional` **stack**: `string`
+> `optional` **stack?**: `string`
 
 Defined in: [node\_modules/typescript/lib/lib.es5.d.ts:1078](../node_modules/typescript/lib/lib.es5.d.ts#L1078)
 

package/docs/core.Interface.APIResult.md

@@ -18,7 +18,7 @@ Defined in: [src/core.ts:87](../src/core.ts#L87)
 
 ### error?
 
-> `optional` **error**: `ChatError`
+> `optional` **error?**: `ChatError`
 
 Defined in: [src/core.ts:89](../src/core.ts#L89)
 
@@ -26,6 +26,6 @@ Defined in: [src/core.ts:89](../src/core.ts#L89)
 
 ### result?
 
-> `optional` **result**: `R`
+> `optional` **result?**: `R`
 
 Defined in: [src/core.ts:88](../src/core.ts#L88)

package/examples/squaring-bot-readme.js

@@ -2,7 +2,7 @@
   const {bot} = await import("../dist/index.js")
   const [chat, _user, _address] = await bot.run({
     profile: {displayName: "Squaring bot example", fullName: ""},
-    dbOpts: {dbFilePrefix: "./squaring_bot", dbKey: ""},
+    dbOpts: {type: "sqlite", filePrefix: "./squaring_bot"},
     options: {
       addressSettings: {welcomeMessage: "Send a number, I will square it."},
     },

package/examples/squaring-bot.ts

@@ -5,7 +5,7 @@ import {bot, util} from "../dist"
   const welcomeMessage = "Hello! I am a simple squaring bot.\n\nIf you send me a number, I will calculate its square."
   const [chat, _user, _address] = await bot.run({
     profile: {displayName: "Squaring bot example", fullName: ""},
-    dbOpts: {dbFilePrefix: "./squaring_bot", dbKey: ""},
+    dbOpts: {type: "sqlite", filePrefix: "./squaring_bot"},
     options: {
       addressSettings: {autoAccept: true, welcomeMessage, businessAddress: false},
       commands: [ // commands to show in client UI

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "simplex-chat",
-  "version": "6.5.0-beta.4.4",
+  "version": "6.5.1",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
@@ -24,7 +24,7 @@
     "docs": "typedoc"
   },
   "dependencies": {
-    "@simplex-chat/types": "^0.3.0",
+    "@simplex-chat/types": "^0.6.0",
     "extract-zip": "^2.0.1",
     "fast-deep-equal": "^3.1.3",
     "node-addon-api": "^8.5.0"

package/src/api.ts

@@ -56,6 +56,41 @@ interface EventSubscriber<K extends CEvt.Tag> {
   once: boolean
 }
 
+/**
+ * Database configuration. The native library is built against exactly one
+ * backend (see `simplex_backend` / `SIMPLEX_BACKEND` at install time); this
+ * type makes the caller state which one they are targeting so field names
+ * can't lie about their meaning.
+ */
+export type DbConfig =
+  | {
+      /** SQLite backend (default). */
+      type: "sqlite"
+      /** File prefix — two schema files are named `<prefix>_chat.db` and `<prefix>_agent.db`. */
+      filePrefix: string
+      /** Optional SQLCipher encryption key. Empty/omitted = unencrypted. */
+      encryptionKey?: string
+    }
+  | {
+      /** PostgreSQL backend (Linux x86_64 only, libpq5 required). */
+      type: "postgres"
+      /** Schema prefix used to namespace tables. Defaults to `"simplex_v1"` when omitted. */
+      schemaPrefix?: string
+      /** PostgreSQL connection string (e.g. `postgres://user:pass@host/db`). */
+      connectionString: string
+    }
+
+function dbConfigToMigrateArgs(db: DbConfig): [string, string] {
+  switch (db.type) {
+    case "sqlite":
+      return [db.filePrefix, db.encryptionKey ?? ""]
+    case "postgres":
+      return [db.schemaPrefix ?? "", db.connectionString]
+    default:
+      throw new Error(`Invalid DbConfig: ${JSON.stringify(db satisfies never)}`)
+  }
+}
+
 /**
  * Main API class for interacting with the chat core library.
  */
@@ -64,21 +99,20 @@ export class ChatApi {
   private eventsLoop: Promise<void> | undefined = undefined
   private subscribers: {[K in CEvt.Tag]?: EventSubscriber<K>[]} = {}
   private receivers: EventSubscriberFunc<CEvt.Tag>[] = []
-  
+
   private constructor(protected ctrl_: bigint | undefined) {}
 
   /**
    * Initializes the ChatApi.
-   * @param {string} dbFilePrefix - File prefix for the database files.
-   * @param {string} [dbKey=""] - Database encryption key.
+   * @param {DbConfig} db - Database configuration (sqlite or postgres).
    * @param {core.MigrationConfirmation} [confirm=core.MigrationConfirmation.YesUp] - Migration confirmation mode.
    */
   static async init(
-    dbFilePrefix: string,
-    dbKey: string = "",
+    db: DbConfig,
     confirm = core.MigrationConfirmation.YesUp
   ): Promise<ChatApi> {
-    const ctrl = await core.chatMigrateInit(dbFilePrefix, dbKey, confirm)
+    const [path, key] = dbConfigToMigrateArgs(db)
+    const ctrl = await core.chatMigrateInit(path, key, confirm)
     return new ChatApi(ctrl)
   }
 
@@ -654,7 +688,7 @@ export class ChatApi {
    * Network usage: interactive.
    */
   async apiConnectPlan(userId: number, connectionLink: string): Promise<[T.ConnectionPlan, T.CreatedConnLink]> {
-    const r = await this.sendChatCmd(CC.APIConnectPlan.cmdString({userId, connectionLink}))
+    const r = await this.sendChatCmd(CC.APIConnectPlan.cmdString({userId, connectionLink, resolveKnown: false}))
     if (r.type === "connectionPlan") return [r.connectionPlan, r.connLink]
     throw new ChatCommandError("error getting connect plan", r)
   }
@@ -730,6 +764,25 @@ export class ChatApi {
     throw new ChatCommandError("error listing groups", r)
   }
 
+  /**
+   * Get chat previews (paginated).
+   * Network usage: no.
+   *
+   * Prefer this over apiListContacts / apiListGroups for any scan: those
+   * methods load every record into memory in a single response and will fail
+   * on large databases.
+   */
+  async apiGetChats(
+    userId: number,
+    pagination: T.PaginationByTime,
+    query: T.ChatListQuery = {type: "filters", favorite: false, unread: false},
+    pendingConnections = false,
+  ): Promise<T.AChat[]> {
+    const r = await this.sendChatCmd(CC.APIGetChats.cmdString({userId, pendingConnections, pagination, query}))
+    if (r.type === "apiChats") return r.chats
+    throw new ChatCommandError("error getting chats", r)
+  }
+
   /**
    * Delete chat.
    * Network usage: background.
@@ -747,6 +800,47 @@ export class ChatApi {
     throw new ChatCommandError("error deleting chat", r)
   }
 
+  /**
+   * Set group custom data.
+   * Network usage: no.
+   */
+  async apiSetGroupCustomData(groupId: number, customData?: object): Promise<void> {
+    const r = await this.sendChatCmd(CC.APISetGroupCustomData.cmdString({groupId, customData}))
+    if (r.type === "cmdOk") return
+    throw new ChatCommandError("error setting group custom data", r)
+  }
+
+  /**
+   * Set contact custom data.
+   * Network usage: no.
+   */
+  async apiSetContactCustomData(contactId: number, customData?: object): Promise<void> {
+    const r = await this.sendChatCmd(CC.APISetContactCustomData.cmdString({contactId, customData}))
+    if (r.type === "cmdOk") return
+    throw new ChatCommandError("error setting contact custom data", r)
+  }
+
+  /**
+   * Set auto-accept member contacts.
+   * Network usage: no.
+   */
+  async apiSetAutoAcceptMemberContacts(userId: number, onOff: boolean): Promise<void> {
+    const r = await this.sendChatCmd(CC.APISetUserAutoAcceptMemberContacts.cmdString({userId, onOff}))
+    if (r.type === "cmdOk") return
+    throw new ChatCommandError("error setting auto-accept member contacts", r)
+  }
+
+  /**
+   * Get chat items.
+   * Network usage: no.
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  async apiGetChat(chatType: T.ChatType, chatId: number, count: number): Promise<any> {
+    const r: any = await this.sendChatCmd(`/_get chat ${T.ChatType.cmdString(chatType)}${chatId} count=${count}`)
+    if (r.type === "apiChat") return r.chat
+    throw new ChatCommandError("error getting chat", r)
+  }
+
   /**
    * Get active user profile
    * Network usage: no.
@@ -772,7 +866,7 @@ export class ChatApi {
    * Network usage: no.
    */
   async apiCreateActiveUser(profile?: T.Profile): Promise<T.User> {
-    const r = await this.sendChatCmd(CC.CreateActiveUser.cmdString({newUser: {profile, pastTimestamp: false}}))
+    const r = await this.sendChatCmd(CC.CreateActiveUser.cmdString({newUser: {profile, pastTimestamp: false, userChatRelay: false}}))
     if (r.type === "activeUser") return r.user
     throw new ChatCommandError("unexpected response", r)
   }
@@ -831,4 +925,34 @@ export class ChatApi {
     const r = await this.sendChatCmd(CC.APISetContactPrefs.cmdString({contactId, preferences}))
     if (r.type !== "contactPrefsUpdated") throw new ChatCommandError("error setting contact prefs", r)
   }
+
+  /**
+   * Create a direct message contact with a group member.
+   * Returns the created contact.
+   * Network usage: interactive.
+   */
+  async apiCreateMemberContact(groupId: number, groupMemberId: number): Promise<T.Contact> {
+    const r: any = await this.sendChatCmd(`/_create member contact #${groupId} ${groupMemberId}`)
+    if (r.type === "newMemberContact") return r.contact
+    throw new ChatCommandError("error creating member contact", r)
+  }
+
+  /**
+   * Send a direct message invitation to a group member contact.
+   * The contact must have been created with {@link apiCreateMemberContact}.
+   * Network usage: interactive.
+   */
+  async apiSendMemberContactInvitation(contactId: number, message?: T.MsgContent | string): Promise<T.Contact> {
+    let cmd = `/_invite member contact @${contactId}`
+    if (message !== undefined) {
+      if (typeof message === "string") {
+        cmd += ` text ${message}`
+      } else {
+        cmd += ` json ${JSON.stringify(message)}`
+      }
+    }
+    const r: any = await this.sendChatCmd(cmd)
+    if (r.type === "newMemberContactSentInv") return r.contact
+    throw new ChatCommandError("error sending member contact invitation", r)
+  }
 }

package/src/bot.ts

@@ -4,9 +4,7 @@ import * as core from "./core"
 import * as util from "./util"
 import equal = require("fast-deep-equal")
 
-export interface BotDbOpts {
-  dbFilePrefix: string // two schema files will be named <prefix>_chat.db and <prefix>_agent.db
-  dbKey?: string
+export type BotDbOpts = api.DbConfig & {
   confirmMigrations?: core.MigrationConfirmation
 }
 
@@ -47,7 +45,7 @@ export interface BotConfig {
 }
 
 export async function run({profile, dbOpts, options = defaultOpts, onMessage, onCommands = {}, events = {}}: BotConfig): Promise<[api.ChatApi, T.User, T.UserContactLink | undefined]> {
-  const bot = await api.ChatApi.init(dbOpts.dbFilePrefix, dbOpts.dbKey || "", dbOpts.confirmMigrations || core.MigrationConfirmation.YesUp)
+  const bot = await api.ChatApi.init(dbOpts, dbOpts.confirmMigrations || core.MigrationConfirmation.YesUp)
   const opts = fullOptions(options)
   if (onMessage) subscribeMessages(bot, onMessage)
   if (Object.keys(onCommands).length > 0) subscribeCommands(bot, onCommands)