@xmtp/node-bindings 0.0.25-internal-fix-forked-groups → 0.0.26

package/dist/index.d.ts

@@ -0,0 +1,325 @@
+/* auto-generated by NAPI-RS */
+/* eslint-disable */
+export declare class Client {
+  accountAddress: string
+  inboxId(): string
+  isRegistered(): boolean
+  installationId(): string
+  installationIdBytes(): Uint8Array
+  canMessage(accountAddresses: Array<string>): Promise<Record<string, boolean>>
+  registerIdentity(): Promise<void>
+  conversations(): Conversations
+  sendHistorySyncRequest(): Promise<void>
+  sendConsentSyncRequest(): Promise<void>
+  findInboxIdByAddress(address: string): Promise<string | null>
+  addressesFromInboxId(refreshFromNetwork: boolean, inboxIds: Array<string>): Promise<Array<InboxState>>
+  isAddressAuthorized(inboxId: string, address: string): Promise<boolean>
+  isInstallationAuthorized(inboxId: string, installationId: Uint8Array): Promise<boolean>
+  setConsentStates(records: Array<Consent>): Promise<void>
+  getConsentState(entityType: ConsentEntityType, entity: string): Promise<ConsentState>
+  /**
+   * Get the client's inbox state.
+   *
+   * If `refresh_from_network` is true, the client will go to the network first to refresh the state.
+   * Otherwise, the state will be read from the local database.
+   */
+  inboxState(refreshFromNetwork: boolean): Promise<InboxState>
+  getLatestInboxState(inboxId: string): Promise<InboxState>
+  createInboxSignatureText(): Promise<string | null>
+  addWalletSignatureText(newWalletAddress: string): Promise<string>
+  revokeWalletSignatureText(walletAddress: string): Promise<string>
+  revokeInstallationsSignatureText(): Promise<string>
+  addSignature(signatureType: SignatureRequestType, signatureBytes: Uint8Array): Promise<void>
+  addScwSignature(signatureType: SignatureRequestType, signatureBytes: Uint8Array, chainId: bigint, blockNumber?: bigint | undefined | null): Promise<void>
+  applySignatureRequests(): Promise<void>
+  signWithInstallationKey(signatureText: string): Uint8Array
+  verifySignedWithInstallationKey(signatureText: string, signatureBytes: Uint8Array): void
+}
+
+export declare class Conversation {
+  id(): string
+  send(encodedContent: EncodedContent): Promise<string>
+  sendOptimistic(encodedContent: EncodedContent): string
+  publishMessages(): Promise<void>
+  sync(): Promise<void>
+  findMessages(opts?: ListMessagesOptions | undefined | null): Array<Message>
+  processStreamedGroupMessage(envelopeBytes: Uint8Array): Promise<Message>
+  listMembers(): Promise<Array<GroupMember>>
+  adminList(): Array<string>
+  superAdminList(): Array<string>
+  isAdmin(inboxId: string): boolean
+  isSuperAdmin(inboxId: string): boolean
+  addMembers(accountAddresses: Array<string>): Promise<void>
+  addAdmin(inboxId: string): Promise<void>
+  removeAdmin(inboxId: string): Promise<void>
+  addSuperAdmin(inboxId: string): Promise<void>
+  removeSuperAdmin(inboxId: string): Promise<void>
+  groupPermissions(): GroupPermissions
+  addMembersByInboxId(inboxIds: Array<string>): Promise<void>
+  removeMembers(accountAddresses: Array<string>): Promise<void>
+  removeMembersByInboxId(inboxIds: Array<string>): Promise<void>
+  updateGroupName(groupName: string): Promise<void>
+  groupName(): string
+  updateGroupImageUrlSquare(groupImageUrlSquare: string): Promise<void>
+  groupImageUrlSquare(): string
+  updateGroupDescription(groupDescription: string): Promise<void>
+  groupDescription(): string
+  updateGroupPinnedFrameUrl(pinnedFrameUrl: string): Promise<void>
+  groupPinnedFrameUrl(): string
+  stream(callback: (err: null | Error, result: Message | undefined) => void): StreamCloser
+  createdAtNs(): number
+  isActive(): boolean
+  addedByInboxId(): string
+  groupMetadata(): GroupMetadata
+  consentState(): ConsentState
+  updateConsentState(state: ConsentState): void
+  dmPeerInboxId(): string
+}
+
+export declare class Conversations {
+  createGroup(accountAddresses: Array<string>, options?: CreateGroupOptions | undefined | null): Promise<Conversation>
+  createDm(accountAddress: string): Promise<Conversation>
+  findGroupById(groupId: string): Conversation
+  findDmByTargetInboxId(targetInboxId: string): Conversation
+  findMessageById(messageId: string): Message
+  processStreamedWelcomeMessage(envelopeBytes: Uint8Array): Promise<Conversation>
+  sync(): Promise<void>
+  syncAllConversations(): Promise<bigint>
+  list(opts?: ListConversationsOptions | undefined | null): Promise<Array<Conversation>>
+  listGroups(opts?: ListConversationsOptions | undefined | null): Promise<Array<Conversation>>
+  listDms(opts?: ListConversationsOptions | undefined | null): Promise<Array<Conversation>>
+  stream(callback: (err: null | Error, result: Conversation | undefined) => void): StreamCloser
+  streamGroups(callback: (err: null | Error, result: Conversation | undefined) => void): StreamCloser
+  streamDms(callback: (err: null | Error, result: Conversation | undefined) => void): StreamCloser
+  streamAllMessages(callback: (err: null | Error, result: Message | undefined) => void): StreamCloser
+  streamAllGroupMessages(callback: (err: null | Error, result: Message | undefined) => void): StreamCloser
+  streamAllDmMessages(callback: (err: null | Error, result: Message | undefined) => void): StreamCloser
+}
+
+export declare class GroupMember {
+  inboxId: string
+  accountAddresses: Array<string>
+  installationIds: Array<string>
+  permissionLevel: PermissionLevel
+  consentState: ConsentState
+}
+
+export declare class GroupMetadata {
+  creatorInboxId(): string
+  conversationType(): string
+}
+
+export declare class GroupPermissions {
+  policyType(): GroupPermissionsOptions
+  policySet(): PermissionPolicySet
+}
+
+export declare class StreamCloser {
+  /**
+   * Signal the stream to end
+   * Does not wait for the stream to end.
+   */
+  end(): void
+  /**
+   * End the stream and `await` for it to shutdown
+   * Returns the `Result` of the task.
+   * End the stream and asyncronously wait for it to shutdown
+   */
+  endAndWait(): Promise<void>
+  waitForReady(): Promise<void>
+  /** Checks if this stream is closed */
+  isClosed(): boolean
+}
+
+export interface Consent {
+  entityType: ConsentEntityType
+  state: ConsentState
+  entity: string
+}
+
+export declare const enum ConsentEntityType {
+  GroupId = 0,
+  InboxId = 1,
+  Address = 2
+}
+
+export declare const enum ConsentState {
+  Unknown = 0,
+  Allowed = 1,
+  Denied = 2
+}
+
+export interface ContentTypeId {
+  authorityId: string
+  typeId: string
+  versionMajor: number
+  versionMinor: number
+}
+
+export declare const enum ConversationType {
+  Dm = 0,
+  Group = 1,
+  Sync = 2
+}
+
+/**
+ * Create a client
+ *
+ * Optionally specify a filter for the log level as a string.
+ * It can be one of: `debug`, `info`, `warn`, `error` or 'off'.
+ * By default, logging is disabled.
+ */
+export declare export declare function createClient(host: string, isSecure: boolean, dbPath: string | undefined | null, inboxId: string, accountAddress: string, encryptionKey?: Uint8Array | undefined | null, historySyncUrl?: string | undefined | null, logOptions?: LogOptions | undefined | null): Promise<Client>
+
+export interface CreateGroupOptions {
+  permissions?: GroupPermissionsOptions
+  groupName?: string
+  groupImageUrlSquare?: string
+  groupDescription?: string
+  groupPinnedFrameUrl?: string
+}
+
+export declare const enum DeliveryStatus {
+  Unpublished = 0,
+  Published = 1,
+  Failed = 2
+}
+
+export interface EncodedContent {
+  type?: ContentTypeId
+  parameters: Record<string, string>
+  fallback?: string
+  compression?: number
+  content: Uint8Array
+}
+
+export declare export declare function generateInboxId(accountAddress: string): string
+
+export declare export declare function getInboxIdForAddress(host: string, isSecure: boolean, accountAddress: string): Promise<string | null>
+
+export declare const enum GroupMembershipState {
+  Allowed = 0,
+  Rejected = 1,
+  Pending = 2
+}
+
+export declare const enum GroupMessageKind {
+  Application = 0,
+  MembershipChange = 1
+}
+
+export declare const enum GroupPermissionsOptions {
+  AllMembers = 0,
+  AdminOnly = 1,
+  CustomPolicy = 2
+}
+
+export interface InboxState {
+  inboxId: string
+  recoveryAddress: string
+  installations: Array<Installation>
+  accountAddresses: Array<string>
+}
+
+export interface Installation {
+  id: string
+  clientTimestampNs?: bigint
+}
+
+export declare export declare function isAddressAuthorized(host: string, inboxId: string, address: string): Promise<boolean>
+
+export declare export declare function isInstallationAuthorized(host: string, inboxId: string, installationId: Uint8Array): Promise<boolean>
+
+export interface ListConversationsOptions {
+  allowedStates?: Array<GroupMembershipState>
+  createdAfterNs?: number
+  createdBeforeNs?: number
+  limit?: number
+  conversationType?: ConversationType
+}
+
+export interface ListMessagesOptions {
+  sentBeforeNs?: number
+  sentAfterNs?: number
+  limit?: number
+  deliveryStatus?: DeliveryStatus
+  direction?: SortDirection
+}
+
+export declare const enum LogLevel {
+  off = 'off',
+  error = 'error',
+  warn = 'warn',
+  info = 'info',
+  debug = 'debug',
+  trace = 'trace'
+}
+
+/** Specify options for the logger */
+export interface LogOptions {
+  /**
+   * enable structured JSON logging to stdout.Useful for third-party log viewers
+   * an option so that it does not require being specified in js object.
+   */
+  structured?: boolean
+  /** Filter logs by level */
+  level?: LogLevel
+}
+
+export interface Message {
+  id: string
+  sentAtNs: number
+  convoId: string
+  senderInboxId: string
+  content: EncodedContent
+  kind: GroupMessageKind
+  deliveryStatus: DeliveryStatus
+}
+
+export declare const enum PermissionLevel {
+  Member = 0,
+  Admin = 1,
+  SuperAdmin = 2
+}
+
+export declare const enum PermissionPolicy {
+  Allow = 0,
+  Deny = 1,
+  Admin = 2,
+  SuperAdmin = 3,
+  DoesNotExist = 4,
+  Other = 5
+}
+
+export interface PermissionPolicySet {
+  addMemberPolicy: PermissionPolicy
+  removeMemberPolicy: PermissionPolicy
+  addAdminPolicy: PermissionPolicy
+  removeAdminPolicy: PermissionPolicy
+  updateGroupNamePolicy: PermissionPolicy
+  updateGroupDescriptionPolicy: PermissionPolicy
+  updateGroupImageUrlSquarePolicy: PermissionPolicy
+  updateGroupPinnedFrameUrlPolicy: PermissionPolicy
+}
+
+export declare const enum PermissionUpdateType {
+  AddMember = 0,
+  RemoveMember = 1,
+  AddAdmin = 2,
+  RemoveAdmin = 3,
+  UpdateMetadata = 4
+}
+
+export declare const enum SignatureRequestType {
+  AddWallet = 0,
+  CreateInbox = 1,
+  RevokeWallet = 2,
+  RevokeInstallations = 3
+}
+
+export declare const enum SortDirection {
+  Ascending = 0,
+  Descending = 1
+}
+
+export declare export declare function verifySignedWithPublicKey(signatureText: string, signatureBytes: Uint8Array, publicKey: Uint8Array): void

package/dist/index.js

@@ -0,0 +1,394 @@
+// prettier-ignore
+/* eslint-disable */
+// @ts-nocheck
+/* auto-generated by NAPI-RS */
+
+import { createRequire } from 'node:module'
+const require = createRequire(import.meta.url)
+const __dirname = new URL('.', import.meta.url).pathname
+
+const { readFileSync } = require('node:fs')
+let nativeBinding = null
+const loadErrors = []
+
+const isMusl = () => {
+  let musl = false
+  if (process.platform === 'linux') {
+    musl = isMuslFromFilesystem()
+    if (musl === null) {
+      musl = isMuslFromReport()
+    }
+    if (musl === null) {
+      musl = isMuslFromChildProcess()
+    }
+  }
+  return musl
+}
+
+const isFileMusl = (f) => f.includes('libc.musl-') || f.includes('ld-musl-')
+
+const isMuslFromFilesystem = () => {
+  try {
+    return readFileSync('/usr/bin/ldd', 'utf-8').includes('musl')
+  } catch {
+    return null
+  }
+}
+
+const isMuslFromReport = () => {
+  const report = typeof process.report.getReport === 'function' ? process.report.getReport() : null
+  if (!report) {
+    return null
+  }
+  if (report.header && report.header.glibcVersionRuntime) {
+    return false
+  }
+  if (Array.isArray(report.sharedObjects)) {
+    if (report.sharedObjects.some(isFileMusl)) {
+      return true
+    }
+  }
+  return false
+}
+
+const isMuslFromChildProcess = () => {
+  try {
+    return require('child_process').execSync('ldd --version', { encoding: 'utf8' }).includes('musl')
+  } catch (e) {
+    // If we reach this case, we don't know if the system is musl or not, so is better to just fallback to false
+    return false
+  }
+}
+
+function requireNative() {
+  if (process.platform === 'android') {
+    if (process.arch === 'arm64') {
+      try {
+        return require('./bindings_node.android-arm64.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@xmtp/node-bindings-android-arm64')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+    } else if (process.arch === 'arm') {
+      try {
+        return require('./bindings_node.android-arm-eabi.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@xmtp/node-bindings-android-arm-eabi')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+    } else {
+      loadErrors.push(new Error(`Unsupported architecture on Android ${process.arch}`))
+    }
+  } else if (process.platform === 'win32') {
+    if (process.arch === 'x64') {
+      try {
+        return require('./bindings_node.win32-x64-msvc.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@xmtp/node-bindings-win32-x64-msvc')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+    } else if (process.arch === 'ia32') {
+      try {
+        return require('./bindings_node.win32-ia32-msvc.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@xmtp/node-bindings-win32-ia32-msvc')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+    } else if (process.arch === 'arm64') {
+      try {
+        return require('./bindings_node.win32-arm64-msvc.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@xmtp/node-bindings-win32-arm64-msvc')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+    } else {
+      loadErrors.push(new Error(`Unsupported architecture on Windows: ${process.arch}`))
+    }
+  } else if (process.platform === 'darwin') {
+    try {
+        return require('./bindings_node.darwin-universal.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@xmtp/node-bindings-darwin-universal')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+    if (process.arch === 'x64') {
+      try {
+        return require('./bindings_node.darwin-x64.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@xmtp/node-bindings-darwin-x64')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+    } else if (process.arch === 'arm64') {
+      try {
+        return require('./bindings_node.darwin-arm64.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@xmtp/node-bindings-darwin-arm64')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+    } else {
+      loadErrors.push(new Error(`Unsupported architecture on macOS: ${process.arch}`))
+    }
+  } else if (process.platform === 'freebsd') {
+    if (process.arch === 'x64') {
+      try {
+        return require('./bindings_node.freebsd-x64.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@xmtp/node-bindings-freebsd-x64')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+    } else if (process.arch === 'arm64') {
+      try {
+        return require('./bindings_node.freebsd-arm64.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@xmtp/node-bindings-freebsd-arm64')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+    } else {
+      loadErrors.push(new Error(`Unsupported architecture on FreeBSD: ${process.arch}`))
+    }
+  } else if (process.platform === 'linux') {
+    if (process.arch === 'x64') {
+      if (isMusl()) {
+        try {
+        return require('./bindings_node.linux-x64-musl.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@xmtp/node-bindings-linux-x64-musl')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+      } else {
+        try {
+        return require('./bindings_node.linux-x64-gnu.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@xmtp/node-bindings-linux-x64-gnu')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+      }
+    } else if (process.arch === 'arm64') {
+      if (isMusl()) {
+        try {
+        return require('./bindings_node.linux-arm64-musl.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@xmtp/node-bindings-linux-arm64-musl')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+      } else {
+        try {
+        return require('./bindings_node.linux-arm64-gnu.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@xmtp/node-bindings-linux-arm64-gnu')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+      }
+    } else if (process.arch === 'arm') {
+      if (isMusl()) {
+        try {
+        return require('./bindings_node.linux-arm-musleabihf.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@xmtp/node-bindings-linux-arm-musleabihf')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+      } else {
+        try {
+        return require('./bindings_node.linux-arm-gnueabihf.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@xmtp/node-bindings-linux-arm-gnueabihf')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+      }
+    } else if (process.arch === 'riscv64') {
+      if (isMusl()) {
+        try {
+        return require('./bindings_node.linux-riscv64-musl.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@xmtp/node-bindings-linux-riscv64-musl')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+      } else {
+        try {
+        return require('./bindings_node.linux-riscv64-gnu.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@xmtp/node-bindings-linux-riscv64-gnu')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+      }
+    } else if (process.arch === 'ppc64') {
+      try {
+        return require('./bindings_node.linux-ppc64-gnu.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@xmtp/node-bindings-linux-ppc64-gnu')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+    } else if (process.arch === 's390x') {
+      try {
+        return require('./bindings_node.linux-s390x-gnu.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@xmtp/node-bindings-linux-s390x-gnu')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+    } else {
+      loadErrors.push(new Error(`Unsupported architecture on Linux: ${process.arch}`))
+    }
+  } else {
+    loadErrors.push(new Error(`Unsupported OS: ${process.platform}, architecture: ${process.arch}`))
+  }
+}
+
+nativeBinding = requireNative()
+
+if (!nativeBinding || process.env.NAPI_RS_FORCE_WASI) {
+  try {
+    nativeBinding = require('./bindings_node.wasi.cjs')
+  } catch (err) {
+    if (process.env.NAPI_RS_FORCE_WASI) {
+      loadErrors.push(err)
+    }
+  }
+  if (!nativeBinding) {
+    try {
+      nativeBinding = require('@xmtp/node-bindings-wasm32-wasi')
+    } catch (err) {
+      if (process.env.NAPI_RS_FORCE_WASI) {
+        loadErrors.push(err)
+      }
+    }
+  }
+}
+
+if (!nativeBinding) {
+  if (loadErrors.length > 0) {
+    // TODO Link to documentation with potential fixes
+    //  - The package owner could build/publish bindings for this arch
+    //  - The user may need to bundle the correct files
+    //  - The user may need to re-install node_modules to get new packages
+    throw new Error('Failed to load native binding', { cause: loadErrors })
+  }
+  throw new Error(`Failed to load native binding`)
+}
+
+const { Client, Conversation, Conversations, GroupMember, GroupMetadata, GroupPermissions, StreamCloser, ConsentEntityType, ConsentState, ConversationType, createClient, DeliveryStatus, generateInboxId, getInboxIdForAddress, GroupMembershipState, GroupMessageKind, GroupPermissionsOptions, isAddressAuthorized, isInstallationAuthorized, LogLevel, PermissionLevel, PermissionPolicy, PermissionUpdateType, SignatureRequestType, SortDirection, verifySignedWithPublicKey } = nativeBinding
+export { Client }
+export { Conversation }
+export { Conversations }
+export { GroupMember }
+export { GroupMetadata }
+export { GroupPermissions }
+export { StreamCloser }
+export { ConsentEntityType }
+export { ConsentState }
+export { ConversationType }
+export { createClient }
+export { DeliveryStatus }
+export { generateInboxId }
+export { getInboxIdForAddress }
+export { GroupMembershipState }
+export { GroupMessageKind }
+export { GroupPermissionsOptions }
+export { isAddressAuthorized }
+export { isInstallationAuthorized }
+export { LogLevel }
+export { PermissionLevel }
+export { PermissionPolicy }
+export { PermissionUpdateType }
+export { SignatureRequestType }
+export { SortDirection }
+export { verifySignedWithPublicKey }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xmtp/node-bindings",
-  "version": "0.0.25-internal-fix-forked-groups",
+  "version": "0.0.26",
   "repository": {
     "type": "git",
     "url": "git+https://git@github.com/xmtp/libxmtp.git",