@xmtp/node-bindings 0.0.15 → 0.0.17

package/dist/index.d.ts

@@ -1,57 +1,44 @@
 /* auto-generated by NAPI-RS */
 /* eslint-disable */
-export class NapiClient {
+export class Client {
   accountAddress: string
   inboxId(): string
   isRegistered(): boolean
   installationId(): string
   canMessage(accountAddresses: Array<string>): Promise<Record<string, boolean>>
   registerIdentity(): Promise<void>
-  createInboxSignatureText(): Promise<string | null>
-  conversations(): NapiConversations
-  requestHistorySync(): 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>>
+  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<NapiInboxState>
-  addressesFromInboxId(refreshFromNetwork: boolean, inboxIds: Array<string>): Promise<Array<NapiInboxState>>
-  getLatestInboxState(inboxId: string): Promise<NapiInboxState>
+  inboxState(refreshFromNetwork: boolean): Promise<InboxState>
+  getLatestInboxState(inboxId: string): Promise<InboxState>
+  createInboxSignatureText(): Promise<string | null>
   addWalletSignatureText(existingWalletAddress: string, newWalletAddress: string): Promise<string>
   revokeWalletSignatureText(walletAddress: string): Promise<string>
   revokeInstallationsSignatureText(): Promise<string>
-  addSignature(signatureType: NapiSignatureRequestType, signatureBytes: Uint8Array): Promise<void>
+  addSignature(signatureType: SignatureRequestType, signatureBytes: Uint8Array): Promise<void>
   applySignatureRequests(): Promise<void>
-  setConsentStates(records: Array<NapiConsent>): Promise<void>
-  getConsentState(entityType: NapiConsentEntityType, entity: string): Promise<NapiConsentState>
-}
-
-export class NapiConversations {
-  createGroup(accountAddresses: Array<string>, options?: NapiCreateGroupOptions | undefined | null): Promise<NapiGroup>
-  findGroupById(groupId: string): NapiGroup
-  findDmByTargetInboxId(targetInboxId: string): NapiGroup
-  findMessageById(messageId: string): NapiMessage
-  processStreamedWelcomeMessage(envelopeBytes: Uint8Array): Promise<NapiGroup>
-  sync(): Promise<void>
-  list(opts?: NapiListConversationsOptions | undefined | null): Promise<Array<NapiGroup>>
-  stream(callback: (err: null | Error, result: NapiGroup) => void): NapiStreamCloser
-  streamAllMessages(callback: (err: null | Error, result: NapiMessage) => void): NapiStreamCloser
 }
 
-export class NapiGroup {
+export class Conversation {
   id(): string
-  send(encodedContent: NapiEncodedContent): Promise<string>
-  /** send a message without immediately publishing to the delivery service. */
-  sendOptimistic(encodedContent: NapiEncodedContent): string
-  /** Publish all unpublished messages */
+  send(encodedContent: EncodedContent): Promise<string>
+  sendOptimistic(encodedContent: EncodedContent): string
   publishMessages(): Promise<void>
   sync(): Promise<void>
-  findMessages(opts?: NapiListMessagesOptions | undefined | null): Array<NapiMessage>
-  processStreamedGroupMessage(envelopeBytes: Uint8Array): Promise<NapiMessage>
-  listMembers(): Promise<Array<NapiGroupMember>>
+  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
@@ -61,7 +48,7 @@ export class NapiGroup {
   removeAdmin(inboxId: string): Promise<void>
   addSuperAdmin(inboxId: string): Promise<void>
   removeSuperAdmin(inboxId: string): Promise<void>
-  groupPermissions(): NapiGroupPermissions
+  groupPermissions(): GroupPermissions
   addMembersByInboxId(inboxIds: Array<string>): Promise<void>
   removeMembers(accountAddresses: Array<string>): Promise<void>
   removeMembersByInboxId(inboxIds: Array<string>): Promise<void>
@@ -73,44 +60,54 @@ export class NapiGroup {
   groupDescription(): string
   updateGroupPinnedFrameUrl(pinnedFrameUrl: string): Promise<void>
   groupPinnedFrameUrl(): string
-  stream(callback: (err: null | Error, result: NapiMessage) => void): NapiStreamCloser
+  stream(callback: (err: null | Error, result: Message | undefined) => void): StreamCloser
   createdAtNs(): number
   isActive(): boolean
   addedByInboxId(): string
-  groupMetadata(): NapiGroupMetadata
-  consentState(): NapiConsentState
-  updateConsentState(state: NapiConsentState): void
+  groupMetadata(): GroupMetadata
+  consentState(): ConsentState
+  updateConsentState(state: ConsentState): void
+  dmPeerInboxId(): string
 }
 
-export class NapiGroupMember {
+export 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>
+  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 class GroupMember {
   inboxId: string
   accountAddresses: Array<string>
   installationIds: Array<string>
-  permissionLevel: NapiPermissionLevel
-  consentState: NapiConsentState
+  permissionLevel: PermissionLevel
+  consentState: ConsentState
 }
 
-export class NapiGroupMetadata {
+export class GroupMetadata {
   creatorInboxId(): string
   conversationType(): string
 }
 
-export class NapiGroupPermissions {
-  policyType(): NapiGroupPermissionsOptions
-  policySet(): NapiPermissionPolicySet
-}
-
-export class NapiMessage {
-  id: string
-  sentAtNs: number
-  convoId: string
-  senderInboxId: string
-  content: NapiEncodedContent
-  kind: NapiGroupMessageKind
-  deliveryStatus: NapiDeliveryStatus
+export class GroupPermissions {
+  policyType(): GroupPermissionsOptions
+  policySet(): PermissionPolicySet
 }
 
-export class NapiStreamCloser {
+export class StreamCloser {
   /**
    * Signal the stream to end
    * Does not wait for the stream to end.
@@ -126,108 +123,134 @@ export class NapiStreamCloser {
   isClosed(): boolean
 }
 
-/**
- * Create an MLS 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 set to `info`. `off` completely disables logging.
- */
-export declare function createClient(host: string, isSecure: boolean, dbPath: string, inboxId: string, accountAddress: string, encryptionKey?: Uint8Array | undefined | null, historySyncUrl?: string | undefined | null, envFilter?: string | undefined | null): Promise<NapiClient>
-
-export declare function generateInboxId(accountAddress: string): string
-
-export declare function getInboxIdForAddress(host: string, isSecure: boolean, accountAddress: string): Promise<string | null>
-
-export interface NapiConsent {
-  entityType: NapiConsentEntityType
-  state: NapiConsentState
+export interface Consent {
+  entityType: ConsentEntityType
+  state: ConsentState
   entity: string
 }
 
-export const enum NapiConsentEntityType {
+export const enum ConsentEntityType {
   GroupId = 0,
   InboxId = 1,
   Address = 2
 }
 
-export const enum NapiConsentState {
+export const enum ConsentState {
   Unknown = 0,
   Allowed = 1,
   Denied = 2
 }
 
-export interface NapiContentTypeId {
+export interface ContentTypeId {
   authorityId: string
   typeId: string
   versionMajor: number
   versionMinor: number
 }
 
-export interface NapiCreateGroupOptions {
-  permissions?: NapiGroupPermissionsOptions
+export 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 function createClient(host: string, isSecure: boolean, dbPath: string, inboxId: string, accountAddress: string, encryptionKey?: Uint8Array | undefined | null, historySyncUrl?: string | undefined | null, envFilter?: "debug" | "info" | "warn" | "error" | "off" | undefined | null): Promise<Client>
+
+export interface CreateGroupOptions {
+  permissions?: GroupPermissionsOptions
   groupName?: string
   groupImageUrlSquare?: string
   groupDescription?: string
   groupPinnedFrameUrl?: string
 }
 
-export const enum NapiDeliveryStatus {
+export const enum DeliveryStatus {
   Unpublished = 0,
   Published = 1,
   Failed = 2
 }
 
-export interface NapiEncodedContent {
-  type?: NapiContentTypeId
+export interface EncodedContent {
+  type?: ContentTypeId
   parameters: Record<string, string>
   fallback?: string
   compression?: number
   content: Uint8Array
 }
 
-export const enum NapiGroupMessageKind {
+export declare function generateInboxId(accountAddress: string): string
+
+export declare function getInboxIdForAddress(host: string, isSecure: boolean, accountAddress: string): Promise<string | null>
+
+export const enum GroupMembershipState {
+  Allowed = 0,
+  Rejected = 1,
+  Pending = 2
+}
+
+export const enum GroupMessageKind {
   Application = 0,
   MembershipChange = 1
 }
 
-export const enum NapiGroupPermissionsOptions {
+export const enum GroupPermissionsOptions {
   AllMembers = 0,
   AdminOnly = 1,
   CustomPolicy = 2
 }
 
-export interface NapiInboxState {
+export interface InboxState {
   inboxId: string
   recoveryAddress: string
-  installations: Array<NapiInstallation>
+  installations: Array<Installation>
   accountAddresses: Array<string>
 }
 
-export interface NapiInstallation {
+export interface Installation {
   id: string
   clientTimestampNs?: bigint
 }
 
-export interface NapiListConversationsOptions {
+export interface ListConversationsOptions {
+  allowedStates?: Array<GroupMembershipState>
   createdAfterNs?: number
   createdBeforeNs?: number
   limit?: number
+  conversationType?: ConversationType
 }
 
-export interface NapiListMessagesOptions {
+export interface ListMessagesOptions {
   sentBeforeNs?: number
   sentAfterNs?: number
   limit?: number
-  deliveryStatus?: NapiDeliveryStatus
+  deliveryStatus?: DeliveryStatus
+  direction?: SortDirection
 }
 
-export const enum NapiPermissionLevel {
+export interface Message {
+  id: string
+  sentAtNs: number
+  convoId: string
+  senderInboxId: string
+  content: EncodedContent
+  kind: GroupMessageKind
+  deliveryStatus: DeliveryStatus
+}
+
+export const enum PermissionLevel {
   Member = 0,
   Admin = 1,
   SuperAdmin = 2
 }
 
-export const enum NapiPermissionPolicy {
+export const enum PermissionPolicy {
   Allow = 0,
   Deny = 1,
   Admin = 2,
@@ -236,18 +259,18 @@ export const enum NapiPermissionPolicy {
   Other = 5
 }
 
-export interface NapiPermissionPolicySet {
-  addMemberPolicy: NapiPermissionPolicy
-  removeMemberPolicy: NapiPermissionPolicy
-  addAdminPolicy: NapiPermissionPolicy
-  removeAdminPolicy: NapiPermissionPolicy
-  updateGroupNamePolicy: NapiPermissionPolicy
-  updateGroupDescriptionPolicy: NapiPermissionPolicy
-  updateGroupImageUrlSquarePolicy: NapiPermissionPolicy
-  updateGroupPinnedFrameUrlPolicy: NapiPermissionPolicy
+export interface PermissionPolicySet {
+  addMemberPolicy: PermissionPolicy
+  removeMemberPolicy: PermissionPolicy
+  addAdminPolicy: PermissionPolicy
+  removeAdminPolicy: PermissionPolicy
+  updateGroupNamePolicy: PermissionPolicy
+  updateGroupDescriptionPolicy: PermissionPolicy
+  updateGroupImageUrlSquarePolicy: PermissionPolicy
+  updateGroupPinnedFrameUrlPolicy: PermissionPolicy
 }
 
-export const enum NapiPermissionUpdateType {
+export const enum PermissionUpdateType {
   AddMember = 0,
   RemoveMember = 1,
   AddAdmin = 2,
@@ -255,10 +278,15 @@ export const enum NapiPermissionUpdateType {
   UpdateMetadata = 4
 }
 
-export const enum NapiSignatureRequestType {
+export const enum SignatureRequestType {
   AddWallet = 0,
   CreateInbox = 1,
   RevokeWallet = 2,
   RevokeInstallations = 3
 }
 
+export const enum SortDirection {
+  Ascending = 0,
+  Descending = 1
+}
+

package/dist/index.js

@@ -361,23 +361,25 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`)
 }
 
-module.exports.NapiClient = nativeBinding.NapiClient
-module.exports.NapiConversations = nativeBinding.NapiConversations
-module.exports.NapiGroup = nativeBinding.NapiGroup
-module.exports.NapiGroupMember = nativeBinding.NapiGroupMember
-module.exports.NapiGroupMetadata = nativeBinding.NapiGroupMetadata
-module.exports.NapiGroupPermissions = nativeBinding.NapiGroupPermissions
-module.exports.NapiMessage = nativeBinding.NapiMessage
-module.exports.NapiStreamCloser = nativeBinding.NapiStreamCloser
+module.exports.Client = nativeBinding.Client
+module.exports.Conversation = nativeBinding.Conversation
+module.exports.Conversations = nativeBinding.Conversations
+module.exports.GroupMember = nativeBinding.GroupMember
+module.exports.GroupMetadata = nativeBinding.GroupMetadata
+module.exports.GroupPermissions = nativeBinding.GroupPermissions
+module.exports.StreamCloser = nativeBinding.StreamCloser
+module.exports.ConsentEntityType = nativeBinding.ConsentEntityType
+module.exports.ConsentState = nativeBinding.ConsentState
+module.exports.ConversationType = nativeBinding.ConversationType
 module.exports.createClient = nativeBinding.createClient
+module.exports.DeliveryStatus = nativeBinding.DeliveryStatus
 module.exports.generateInboxId = nativeBinding.generateInboxId
 module.exports.getInboxIdForAddress = nativeBinding.getInboxIdForAddress
-module.exports.NapiConsentEntityType = nativeBinding.NapiConsentEntityType
-module.exports.NapiConsentState = nativeBinding.NapiConsentState
-module.exports.NapiDeliveryStatus = nativeBinding.NapiDeliveryStatus
-module.exports.NapiGroupMessageKind = nativeBinding.NapiGroupMessageKind
-module.exports.NapiGroupPermissionsOptions = nativeBinding.NapiGroupPermissionsOptions
-module.exports.NapiPermissionLevel = nativeBinding.NapiPermissionLevel
-module.exports.NapiPermissionPolicy = nativeBinding.NapiPermissionPolicy
-module.exports.NapiPermissionUpdateType = nativeBinding.NapiPermissionUpdateType
-module.exports.NapiSignatureRequestType = nativeBinding.NapiSignatureRequestType
+module.exports.GroupMembershipState = nativeBinding.GroupMembershipState
+module.exports.GroupMessageKind = nativeBinding.GroupMessageKind
+module.exports.GroupPermissionsOptions = nativeBinding.GroupPermissionsOptions
+module.exports.PermissionLevel = nativeBinding.PermissionLevel
+module.exports.PermissionPolicy = nativeBinding.PermissionPolicy
+module.exports.PermissionUpdateType = nativeBinding.PermissionUpdateType
+module.exports.SignatureRequestType = nativeBinding.SignatureRequestType
+module.exports.SortDirection = nativeBinding.SortDirection

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xmtp/node-bindings",
-  "version": "0.0.15",
+  "version": "0.0.17",
   "repository": {
     "type": "git",
     "url": "git+https://git@github.com/xmtp/libxmtp.git",
@@ -20,32 +20,35 @@
   ],
   "scripts": {
     "artifacts": "napi artifacts",
-    "build": "napi build --platform --release",
+    "build": "yarn build:clean && yarn build:release && yarn build:finish",
     "build:clean": "rm -rf dist",
     "build:debug": "napi build --platform",
     "build:finish": "mkdir dist && mv index.js dist && mv index.d.ts dist && mv *.node dist",
-    "build:release": "yarn build:clean && yarn build && yarn build:finish",
+    "build:release": "napi build --platform --release",
     "clean": "yarn build:clean && yarn test:clean",
     "format": "prettier -w .",
     "format:check": "prettier -c .",
+    "lint": "yarn lint:clippy && yarn lint:fmt",
+    "lint:clippy": "cargo clippy --all-features --all-targets --no-deps -- -Dwarnings",
+    "lint:fmt": "cargo fmt --check",
     "test": "vitest run",
     "test:clean": "rm -rf test/*.db3*"
   },
   "devDependencies": {
-    "@ianvs/prettier-plugin-sort-imports": "^4.2.1",
+    "@ianvs/prettier-plugin-sort-imports": "^4.4.0",
     "@napi-rs/cli": "^3.0.0-alpha.55",
-    "@types/node": "^20.14.2",
-    "@types/uuid": "^10",
-    "prettier": "^3.3.2",
-    "prettier-plugin-packagejson": "^2.5.0",
-    "typescript": "^5.4.5",
-    "uuid": "^10.0.0",
-    "viem": "^2.11.1",
-    "vite": "^5.2.13",
-    "vite-tsconfig-paths": "^4.3.2",
-    "vitest": "^1.6.0"
+    "@types/node": "^20.17.6",
+    "@types/uuid": "^10.0.0",
+    "prettier": "^3.3.3",
+    "prettier-plugin-packagejson": "^2.5.3",
+    "typescript": "^5.6.3",
+    "uuid": "^11.0.2",
+    "viem": "^2.21.41",
+    "vite": "^5.4.10",
+    "vite-tsconfig-paths": "^5.1.0",
+    "vitest": "^2.1.4"
   },
-  "packageManager": "yarn@4.2.2",
+  "packageManager": "yarn@4.5.1",
   "engines": {
     "node": ">=18"
   },