@xmtp/node-bindings 0.0.17 → 0.0.18

package/README.md

@@ -1,17 +1,15 @@
-# Node bindings for the MLS client
+# Node bindings for the libXMTP rust library
 
-> **Important**  
-> These bindings are currently in **Alpha** status. Do not use in production as the API is not final and certain functionality may not work as intended.
+> [!CAUTION]
+> These bindings are currently in alpha and under heavy development. The API is subject to change and it is not yet recommended for production use.
 
 ## Useful commands
 
 - `yarn`: Installs all dependencies (required before building)
-- `yarn build:release`: Build a release version of the Node bindings for the current platform
+- `yarn build`: Build a release version of the Node bindings for the current platform
+- `yarn lint`: Run cargo clippy and fmt checks
+- `yarn test`: Run the test suite on Node
 
 ## Testing
 
-There are several test scripts written in Node located in the `/scripts` folder.
-
-Test users are available as exports in `users.mjs`. To register all users on the network, run the `setup.mjs` script.
-
-Before running any of the test scripts, a local XMTP node must be running. This can be achieved by running `./dev/up` at the root of this repository.
+Before running the test suite, a local XMTP node must be running. This can be achieved by running `./dev/up` at the root of this repository. Docker is required.

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 /* auto-generated by NAPI-RS */
 /* eslint-disable */
-export class Client {
+export declare class Client {
   accountAddress: string
   inboxId(): string
   isRegistered(): boolean
@@ -27,10 +27,11 @@ export class Client {
   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>
 }
 
-export class Conversation {
+export declare class Conversation {
   id(): string
   send(encodedContent: EncodedContent): Promise<string>
   sendOptimistic(encodedContent: EncodedContent): string
@@ -70,7 +71,7 @@ export class Conversation {
   dmPeerInboxId(): string
 }
 
-export class Conversations {
+export declare class Conversations {
   createGroup(accountAddresses: Array<string>, options?: CreateGroupOptions | undefined | null): Promise<Conversation>
   createDm(accountAddress: string): Promise<Conversation>
   findGroupById(groupId: string): Conversation
@@ -89,7 +90,7 @@ export class Conversations {
   streamAllDmMessages(callback: (err: null | Error, result: Message | undefined) => void): StreamCloser
 }
 
-export class GroupMember {
+export declare class GroupMember {
   inboxId: string
   accountAddresses: Array<string>
   installationIds: Array<string>
@@ -97,17 +98,17 @@ export class GroupMember {
   consentState: ConsentState
 }
 
-export class GroupMetadata {
+export declare class GroupMetadata {
   creatorInboxId(): string
   conversationType(): string
 }
 
-export class GroupPermissions {
+export declare class GroupPermissions {
   policyType(): GroupPermissionsOptions
   policySet(): PermissionPolicySet
 }
 
-export class StreamCloser {
+export declare class StreamCloser {
   /**
    * Signal the stream to end
    * Does not wait for the stream to end.
@@ -129,13 +130,13 @@ export interface Consent {
   entity: string
 }
 
-export const enum ConsentEntityType {
+export declare const enum ConsentEntityType {
   GroupId = 0,
   InboxId = 1,
   Address = 2
 }
 
-export const enum ConsentState {
+export declare const enum ConsentState {
   Unknown = 0,
   Allowed = 1,
   Denied = 2
@@ -148,7 +149,7 @@ export interface ContentTypeId {
   versionMinor: number
 }
 
-export const enum ConversationType {
+export declare const enum ConversationType {
   Dm = 0,
   Group = 1,
   Sync = 2
@@ -161,7 +162,7 @@ export const enum ConversationType {
  * 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 declare export declare function createClient(host: string, isSecure: boolean, dbPath: string, inboxId: string, accountAddress: string, encryptionKey?: Uint8Array | undefined | null, historySyncUrl?: string | undefined | null, logOptions?: LogOptions | undefined | null): Promise<Client>
 
 export interface CreateGroupOptions {
   permissions?: GroupPermissionsOptions
@@ -171,7 +172,7 @@ export interface CreateGroupOptions {
   groupPinnedFrameUrl?: string
 }
 
-export const enum DeliveryStatus {
+export declare const enum DeliveryStatus {
   Unpublished = 0,
   Published = 1,
   Failed = 2
@@ -185,22 +186,22 @@ export interface EncodedContent {
   content: Uint8Array
 }
 
-export declare function generateInboxId(accountAddress: string): string
+export declare export declare function generateInboxId(accountAddress: string): string
 
-export declare function getInboxIdForAddress(host: string, isSecure: boolean, accountAddress: string): Promise<string | null>
+export declare export declare function getInboxIdForAddress(host: string, isSecure: boolean, accountAddress: string): Promise<string | null>
 
-export const enum GroupMembershipState {
+export declare const enum GroupMembershipState {
   Allowed = 0,
   Rejected = 1,
   Pending = 2
 }
 
-export const enum GroupMessageKind {
+export declare const enum GroupMessageKind {
   Application = 0,
   MembershipChange = 1
 }
 
-export const enum GroupPermissionsOptions {
+export declare const enum GroupPermissionsOptions {
   AllMembers = 0,
   AdminOnly = 1,
   CustomPolicy = 2
@@ -218,6 +219,15 @@ export interface Installation {
   clientTimestampNs?: bigint
 }
 
+export declare const enum Level {
+  off = 'off',
+  error = 'error',
+  warn = 'warn',
+  info = 'info',
+  debug = 'debug',
+  trace = 'trace'
+}
+
 export interface ListConversationsOptions {
   allowedStates?: Array<GroupMembershipState>
   createdAfterNs?: number
@@ -234,6 +244,17 @@ export interface ListMessagesOptions {
   direction?: SortDirection
 }
 
+/** 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?: Level
+}
+
 export interface Message {
   id: string
   sentAtNs: number
@@ -244,13 +265,13 @@ export interface Message {
   deliveryStatus: DeliveryStatus
 }
 
-export const enum PermissionLevel {
+export declare const enum PermissionLevel {
   Member = 0,
   Admin = 1,
   SuperAdmin = 2
 }
 
-export const enum PermissionPolicy {
+export declare const enum PermissionPolicy {
   Allow = 0,
   Deny = 1,
   Admin = 2,
@@ -270,7 +291,7 @@ export interface PermissionPolicySet {
   updateGroupPinnedFrameUrlPolicy: PermissionPolicy
 }
 
-export const enum PermissionUpdateType {
+export declare const enum PermissionUpdateType {
   AddMember = 0,
   RemoveMember = 1,
   AddAdmin = 2,
@@ -278,15 +299,14 @@ export const enum PermissionUpdateType {
   UpdateMetadata = 4
 }
 
-export const enum SignatureRequestType {
+export declare const enum SignatureRequestType {
   AddWallet = 0,
   CreateInbox = 1,
   RevokeWallet = 2,
   RevokeInstallations = 3
 }
 
-export const enum SortDirection {
+export declare const enum SortDirection {
   Ascending = 0,
   Descending = 1
 }
-

package/dist/index.js

@@ -1,9 +1,13 @@
 // prettier-ignore
 /* eslint-disable */
+// @ts-nocheck
 /* auto-generated by NAPI-RS */
 
-const { readFileSync } = require('fs')
+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 = []
 
@@ -336,7 +340,7 @@ if (!nativeBinding || process.env.NAPI_RS_FORCE_WASI) {
     nativeBinding = require('./bindings_node.wasi.cjs')
   } catch (err) {
     if (process.env.NAPI_RS_FORCE_WASI) {
-      console.error(err)
+      loadErrors.push(err)
     }
   }
   if (!nativeBinding) {
@@ -344,7 +348,7 @@ if (!nativeBinding || process.env.NAPI_RS_FORCE_WASI) {
       nativeBinding = require('@xmtp/node-bindings-wasm32-wasi')
     } catch (err) {
       if (process.env.NAPI_RS_FORCE_WASI) {
-        console.error(err)
+        loadErrors.push(err)
       }
     }
   }
@@ -361,25 +365,27 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`)
 }
 
-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.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
+const { Client, Conversation, Conversations, GroupMember, GroupMetadata, GroupPermissions, StreamCloser, ConsentEntityType, ConsentState, ConversationType, createClient, DeliveryStatus, generateInboxId, getInboxIdForAddress, GroupMembershipState, GroupMessageKind, GroupPermissionsOptions, Level, PermissionLevel, PermissionPolicy, PermissionUpdateType, SignatureRequestType, SortDirection } = 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 { Level }
+export { PermissionLevel }
+export { PermissionPolicy }
+export { PermissionUpdateType }
+export { SignatureRequestType }
+export { SortDirection }

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@xmtp/node-bindings",
-  "version": "0.0.17",
+  "version": "0.0.18",
   "repository": {
     "type": "git",
     "url": "git+https://git@github.com/xmtp/libxmtp.git",
     "directory": "bindings_node"
   },
   "license": "MIT",
+  "type": "module",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -22,9 +23,9 @@
     "artifacts": "napi artifacts",
     "build": "yarn build:clean && yarn build:release && yarn build:finish",
     "build:clean": "rm -rf dist",
-    "build:debug": "napi build --platform",
+    "build:debug": "napi build --platform --esm",
     "build:finish": "mkdir dist && mv index.js dist && mv index.d.ts dist && mv *.node dist",
-    "build:release": "napi build --platform --release",
+    "build:release": "napi build --platform --release --esm",
     "clean": "yarn build:clean && yarn test:clean",
     "format": "prettier -w .",
     "format:check": "prettier -c .",
@@ -36,16 +37,16 @@
   },
   "devDependencies": {
     "@ianvs/prettier-plugin-sort-imports": "^4.4.0",
-    "@napi-rs/cli": "^3.0.0-alpha.55",
+    "@napi-rs/cli": "^3.0.0-alpha.64",
     "@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",
+    "uuid": "^11.0.3",
+    "viem": "^2.21.44",
+    "vite": "^5.4.11",
+    "vite-tsconfig-paths": "^5.1.2",
     "vitest": "^2.1.4"
   },
   "packageManager": "yarn@4.5.1",