@rstmdb/client 0.1.0 → 0.2.0

package/README.md

@@ -110,18 +110,18 @@ await client.connect();
 
 ### Configuration Options
 
-| Option                 | Default  | Description                                 |
-| ---------------------- | -------- | ------------------------------------------- |
-| `host`                 | required | Server hostname                             |
-| `port`                 | `7401`   | Server port                                 |
-| `connectTimeout`       | `10000`  | Connection timeout (ms)                     |
-| `requestTimeout`       | `30000`  | Request timeout (ms)                        |
-| `authToken`            | -        | Bearer token for authentication             |
-| `tls`                  | -        | `true` for system CA, or `TlsConfig` object |
-| `reconnect`            | `true`   | Auto-reconnect on disconnect                |
-| `reconnectInterval`    | `1000`   | Initial reconnect delay (ms)                |
-| `reconnectMaxAttempts` | `10`     | Max reconnection attempts                   |
-| `clientName`           | -        | Client identifier sent in handshake         |
+| Option | Default | Description |
+| ------ | ------- | ----------- |
+| `host` | required | Server hostname |
+| `port` | `7401` | Server port |
+| `connectTimeout` | `10000` | Connection timeout (ms) |
+| `requestTimeout` | `30000` | Request timeout (ms) |
+| `authToken` | - | Bearer token for authentication |
+| `tls` | - | `true` for system CA, or TlsConfig |
+| `reconnect` | `true` | Auto-reconnect on disconnect |
+| `reconnectInterval` | `1000` | Initial reconnect delay (ms) |
+| `reconnectMaxAttempts` | `10` | Max reconnection attempts |
+| `clientName` | - | Client identifier in handshake |
 
 ## API Reference
 

package/dist/index.d.cts

@@ -346,6 +346,7 @@ declare enum ErrorCode {
     NOT_FOUND = "NOT_FOUND",
     MACHINE_NOT_FOUND = "MACHINE_NOT_FOUND",
     MACHINE_VERSION_EXISTS = "MACHINE_VERSION_EXISTS",
+    MACHINE_VERSION_LIMIT_EXCEEDED = "MACHINE_VERSION_LIMIT_EXCEEDED",
     INSTANCE_NOT_FOUND = "INSTANCE_NOT_FOUND",
     INSTANCE_EXISTS = "INSTANCE_EXISTS",
     INVALID_TRANSITION = "INVALID_TRANSITION",
@@ -533,6 +534,79 @@ interface CompactResult {
     /** Bytes reclaimed */
     bytesReclaimed: bigint;
 }
+/**
+ * Options for LIST_INSTANCES operation.
+ */
+interface ListInstancesOptions {
+    /** Filter by machine name */
+    machine?: string;
+    /** Filter by current state */
+    state?: string;
+    /** Maximum number of instances to return */
+    limit?: number;
+    /** Number of instances to skip (for pagination) */
+    offset?: number;
+}
+/**
+ * Instance summary for list responses (excludes ctx for efficiency).
+ */
+interface InstanceSummary {
+    /** Instance ID */
+    id: string;
+    /** Machine name */
+    machine: string;
+    /** Machine version */
+    version: number;
+    /** Current state */
+    state: string;
+    /** Creation timestamp (Unix ms) */
+    createdAt: number;
+    /** Last update timestamp (Unix ms) */
+    updatedAt: number;
+    /** Last WAL offset */
+    lastWalOffset: bigint;
+}
+/**
+ * Result of LIST_INSTANCES operation.
+ */
+interface ListInstancesResult {
+    /** List of instance summaries */
+    instances: InstanceSummary[];
+    /** Total number of matching instances */
+    total: number;
+    /** Whether more instances exist beyond the limit */
+    hasMore: boolean;
+}
+/**
+ * WAL I/O statistics.
+ */
+interface WalIoStats {
+    /** Total bytes written */
+    bytesWritten: number;
+    /** Total bytes read */
+    bytesRead: number;
+    /** Number of write operations */
+    writes: number;
+    /** Number of read operations */
+    reads: number;
+    /** Number of fsync calls */
+    fsyncs: number;
+}
+/**
+ * Result of WAL_STATS operation.
+ */
+interface WalStatsResult {
+    /** Total number of entries in WAL */
+    entryCount: number;
+    /** Number of WAL segments */
+    segmentCount: number;
+    /** Total size of WAL in bytes */
+    totalSizeBytes: number;
+    /** Latest WAL offset */
+    latestOffset?: bigint;
+    /** I/O statistics */
+    ioStats: WalIoStats;
+}
 
 /**
  * Client events.
@@ -646,6 +720,10 @@ declare class Client extends EventEmitter {
      * Delete an instance.
      */
     deleteInstance(instanceId: string, options?: DeleteInstanceOptions): Promise<void>;
+    /**
+     * List instances with optional filtering and pagination.
+     */
+    listInstances(options?: ListInstancesOptions): Promise<ListInstancesResult>;
     /**
      * Apply an event to an instance.
      */
@@ -658,6 +736,10 @@ declare class Client extends EventEmitter {
      * Read entries from the write-ahead log.
      */
     walRead(fromOffset: bigint, options?: WalReadOptions): Promise<WalReadResult>;
+    /**
+     * Get WAL statistics.
+     */
+    walStats(): Promise<WalStatsResult>;
     /**
      * Create a snapshot of an instance.
      */
@@ -874,10 +956,12 @@ declare enum Operation {
     LIST_MACHINES = "LIST_MACHINES",
     CREATE_INSTANCE = "CREATE_INSTANCE",
     GET_INSTANCE = "GET_INSTANCE",
+    LIST_INSTANCES = "LIST_INSTANCES",
     DELETE_INSTANCE = "DELETE_INSTANCE",
     APPLY_EVENT = "APPLY_EVENT",
     BATCH = "BATCH",
     WAL_READ = "WAL_READ",
+    WAL_STATS = "WAL_STATS",
     SNAPSHOT_INSTANCE = "SNAPSHOT_INSTANCE",
     COMPACT = "COMPACT",
     WATCH_INSTANCE = "WATCH_INSTANCE",
@@ -885,4 +969,4 @@ declare enum Operation {
     UNWATCH = "UNWATCH"
 }
 
-export { type ApplyEventOptions, type ApplyEventResult, AuthenticationError, type BatchOperation, type BatchOptions, type BatchResult, type BatchResultItem, Client, type ClientConfig, type ClientEvents, ClientOptions, type CompactOptions, type CompactResult, ConflictError, ConnectionError, type CreateInstanceOptions, type CreateInstanceResult, DEFAULT_CONFIG, type DeleteInstanceOptions, ErrorCode, FRAME_MAGIC, type Frame, FrameDecoder, FrameEncoder, FrameFlags, type GetInstanceResult, type GetMachineResult, GuardFailedError, HEADER_SIZE, InvalidTransitionError, type ListMachinesOptions, type ListMachinesResult, type MachineDefinition, type MachineListItem, NotFoundError, Operation, PROTOCOL_VERSION, ProtocolError, type PutMachineResult, type ResolvedConfig, RstmdbError, ServerError, type ServerInfo, type SnapshotResult, type StreamEvent, type Subscription, TimeoutError, type TlsConfig, type Transition, type WalEntry, type WalReadOptions, type WalReadResult, type WatchAllOptions, type WatchOptions };
+export { type ApplyEventOptions, type ApplyEventResult, AuthenticationError, type BatchOperation, type BatchOptions, type BatchResult, type BatchResultItem, Client, type ClientConfig, type ClientEvents, ClientOptions, type CompactOptions, type CompactResult, ConflictError, ConnectionError, type CreateInstanceOptions, type CreateInstanceResult, DEFAULT_CONFIG, type DeleteInstanceOptions, ErrorCode, FRAME_MAGIC, type Frame, FrameDecoder, FrameEncoder, FrameFlags, type GetInstanceResult, type GetMachineResult, GuardFailedError, HEADER_SIZE, type InstanceSummary, InvalidTransitionError, type ListInstancesOptions, type ListInstancesResult, type ListMachinesOptions, type ListMachinesResult, type MachineDefinition, type MachineListItem, NotFoundError, Operation, PROTOCOL_VERSION, ProtocolError, type PutMachineResult, type ResolvedConfig, RstmdbError, ServerError, type ServerInfo, type SnapshotResult, type StreamEvent, type Subscription, TimeoutError, type TlsConfig, type Transition, type WalEntry, type WalIoStats, type WalReadOptions, type WalReadResult, type WalStatsResult, type WatchAllOptions, type WatchOptions };

package/dist/index.d.ts

@@ -346,6 +346,7 @@ declare enum ErrorCode {
     NOT_FOUND = "NOT_FOUND",
     MACHINE_NOT_FOUND = "MACHINE_NOT_FOUND",
     MACHINE_VERSION_EXISTS = "MACHINE_VERSION_EXISTS",
+    MACHINE_VERSION_LIMIT_EXCEEDED = "MACHINE_VERSION_LIMIT_EXCEEDED",
     INSTANCE_NOT_FOUND = "INSTANCE_NOT_FOUND",
     INSTANCE_EXISTS = "INSTANCE_EXISTS",
     INVALID_TRANSITION = "INVALID_TRANSITION",
@@ -533,6 +534,79 @@ interface CompactResult {
     /** Bytes reclaimed */
     bytesReclaimed: bigint;
 }
+/**
+ * Options for LIST_INSTANCES operation.
+ */
+interface ListInstancesOptions {
+    /** Filter by machine name */
+    machine?: string;
+    /** Filter by current state */
+    state?: string;
+    /** Maximum number of instances to return */
+    limit?: number;
+    /** Number of instances to skip (for pagination) */
+    offset?: number;
+}
+/**
+ * Instance summary for list responses (excludes ctx for efficiency).
+ */
+interface InstanceSummary {
+    /** Instance ID */
+    id: string;
+    /** Machine name */
+    machine: string;
+    /** Machine version */
+    version: number;
+    /** Current state */
+    state: string;
+    /** Creation timestamp (Unix ms) */
+    createdAt: number;
+    /** Last update timestamp (Unix ms) */
+    updatedAt: number;
+    /** Last WAL offset */
+    lastWalOffset: bigint;
+}
+/**
+ * Result of LIST_INSTANCES operation.
+ */
+interface ListInstancesResult {
+    /** List of instance summaries */
+    instances: InstanceSummary[];
+    /** Total number of matching instances */
+    total: number;
+    /** Whether more instances exist beyond the limit */
+    hasMore: boolean;
+}
+/**
+ * WAL I/O statistics.
+ */
+interface WalIoStats {
+    /** Total bytes written */
+    bytesWritten: number;
+    /** Total bytes read */
+    bytesRead: number;
+    /** Number of write operations */
+    writes: number;
+    /** Number of read operations */
+    reads: number;
+    /** Number of fsync calls */
+    fsyncs: number;
+}
+/**
+ * Result of WAL_STATS operation.
+ */
+interface WalStatsResult {
+    /** Total number of entries in WAL */
+    entryCount: number;
+    /** Number of WAL segments */
+    segmentCount: number;
+    /** Total size of WAL in bytes */
+    totalSizeBytes: number;
+    /** Latest WAL offset */
+    latestOffset?: bigint;
+    /** I/O statistics */
+    ioStats: WalIoStats;
+}
 
 /**
  * Client events.
@@ -646,6 +720,10 @@ declare class Client extends EventEmitter {
      * Delete an instance.
      */
     deleteInstance(instanceId: string, options?: DeleteInstanceOptions): Promise<void>;
+    /**
+     * List instances with optional filtering and pagination.
+     */
+    listInstances(options?: ListInstancesOptions): Promise<ListInstancesResult>;
     /**
      * Apply an event to an instance.
      */
@@ -658,6 +736,10 @@ declare class Client extends EventEmitter {
      * Read entries from the write-ahead log.
      */
     walRead(fromOffset: bigint, options?: WalReadOptions): Promise<WalReadResult>;
+    /**
+     * Get WAL statistics.
+     */
+    walStats(): Promise<WalStatsResult>;
     /**
      * Create a snapshot of an instance.
      */
@@ -874,10 +956,12 @@ declare enum Operation {
     LIST_MACHINES = "LIST_MACHINES",
     CREATE_INSTANCE = "CREATE_INSTANCE",
     GET_INSTANCE = "GET_INSTANCE",
+    LIST_INSTANCES = "LIST_INSTANCES",
     DELETE_INSTANCE = "DELETE_INSTANCE",
     APPLY_EVENT = "APPLY_EVENT",
     BATCH = "BATCH",
     WAL_READ = "WAL_READ",
+    WAL_STATS = "WAL_STATS",
     SNAPSHOT_INSTANCE = "SNAPSHOT_INSTANCE",
     COMPACT = "COMPACT",
     WATCH_INSTANCE = "WATCH_INSTANCE",
@@ -885,4 +969,4 @@ declare enum Operation {
     UNWATCH = "UNWATCH"
 }
 
-export { type ApplyEventOptions, type ApplyEventResult, AuthenticationError, type BatchOperation, type BatchOptions, type BatchResult, type BatchResultItem, Client, type ClientConfig, type ClientEvents, ClientOptions, type CompactOptions, type CompactResult, ConflictError, ConnectionError, type CreateInstanceOptions, type CreateInstanceResult, DEFAULT_CONFIG, type DeleteInstanceOptions, ErrorCode, FRAME_MAGIC, type Frame, FrameDecoder, FrameEncoder, FrameFlags, type GetInstanceResult, type GetMachineResult, GuardFailedError, HEADER_SIZE, InvalidTransitionError, type ListMachinesOptions, type ListMachinesResult, type MachineDefinition, type MachineListItem, NotFoundError, Operation, PROTOCOL_VERSION, ProtocolError, type PutMachineResult, type ResolvedConfig, RstmdbError, ServerError, type ServerInfo, type SnapshotResult, type StreamEvent, type Subscription, TimeoutError, type TlsConfig, type Transition, type WalEntry, type WalReadOptions, type WalReadResult, type WatchAllOptions, type WatchOptions };
+export { type ApplyEventOptions, type ApplyEventResult, AuthenticationError, type BatchOperation, type BatchOptions, type BatchResult, type BatchResultItem, Client, type ClientConfig, type ClientEvents, ClientOptions, type CompactOptions, type CompactResult, ConflictError, ConnectionError, type CreateInstanceOptions, type CreateInstanceResult, DEFAULT_CONFIG, type DeleteInstanceOptions, ErrorCode, FRAME_MAGIC, type Frame, FrameDecoder, FrameEncoder, FrameFlags, type GetInstanceResult, type GetMachineResult, GuardFailedError, HEADER_SIZE, type InstanceSummary, InvalidTransitionError, type ListInstancesOptions, type ListInstancesResult, type ListMachinesOptions, type ListMachinesResult, type MachineDefinition, type MachineListItem, NotFoundError, Operation, PROTOCOL_VERSION, ProtocolError, type PutMachineResult, type ResolvedConfig, RstmdbError, ServerError, type ServerInfo, type SnapshotResult, type StreamEvent, type Subscription, TimeoutError, type TlsConfig, type Transition, type WalEntry, type WalIoStats, type WalReadOptions, type WalReadResult, type WalStatsResult, type WatchAllOptions, type WatchOptions };

package/dist/index.js

@@ -65,6 +65,7 @@ var ErrorCode = /* @__PURE__ */ ((ErrorCode2) => {
   ErrorCode2["NOT_FOUND"] = "NOT_FOUND";
   ErrorCode2["MACHINE_NOT_FOUND"] = "MACHINE_NOT_FOUND";
   ErrorCode2["MACHINE_VERSION_EXISTS"] = "MACHINE_VERSION_EXISTS";
+  ErrorCode2["MACHINE_VERSION_LIMIT_EXCEEDED"] = "MACHINE_VERSION_LIMIT_EXCEEDED";
   ErrorCode2["INSTANCE_NOT_FOUND"] = "INSTANCE_NOT_FOUND";
   ErrorCode2["INSTANCE_EXISTS"] = "INSTANCE_EXISTS";
   ErrorCode2["INVALID_TRANSITION"] = "INVALID_TRANSITION";
@@ -343,10 +344,12 @@ var Operation = /* @__PURE__ */ ((Operation2) => {
   Operation2["LIST_MACHINES"] = "LIST_MACHINES";
   Operation2["CREATE_INSTANCE"] = "CREATE_INSTANCE";
   Operation2["GET_INSTANCE"] = "GET_INSTANCE";
+  Operation2["LIST_INSTANCES"] = "LIST_INSTANCES";
   Operation2["DELETE_INSTANCE"] = "DELETE_INSTANCE";
   Operation2["APPLY_EVENT"] = "APPLY_EVENT";
   Operation2["BATCH"] = "BATCH";
   Operation2["WAL_READ"] = "WAL_READ";
+  Operation2["WAL_STATS"] = "WAL_STATS";
   Operation2["SNAPSHOT_INSTANCE"] = "SNAPSHOT_INSTANCE";
   Operation2["COMPACT"] = "COMPACT";
   Operation2["WATCH_INSTANCE"] = "WATCH_INSTANCE";
@@ -1143,6 +1146,30 @@ var Client = class _Client extends events.EventEmitter {
     if (options?.idempotencyKey) params["idempotency_key"] = options.idempotencyKey;
     await this.connection.request("DELETE_INSTANCE" /* DELETE_INSTANCE */, params);
   }
+  /**
+   * List instances with optional filtering and pagination.
+   */
+  async listInstances(options) {
+    const params = {};
+    if (options?.machine) params["machine"] = options.machine;
+    if (options?.state) params["state"] = options.state;
+    if (options?.limit !== void 0) params["limit"] = options.limit;
+    if (options?.offset !== void 0) params["offset"] = options.offset;
+    const result = await this.connection.request("LIST_INSTANCES" /* LIST_INSTANCES */, params);
+    return {
+      instances: result.instances.map((inst) => ({
+        id: inst.id,
+        machine: inst.machine,
+        version: inst.version,
+        state: inst.state,
+        createdAt: inst.created_at,
+        updatedAt: inst.updated_at,
+        lastWalOffset: BigInt(inst.last_wal_offset)
+      })),
+      total: result.total,
+      hasMore: result.has_more
+    };
+  }
   // ─────────────────────────────────────────────────────────────────────────
   // Event Operations
   // ─────────────────────────────────────────────────────────────────────────
@@ -1216,6 +1243,25 @@ var Client = class _Client extends events.EventEmitter {
       nextOffset: result.nextOffset ? BigInt(result.nextOffset) : void 0
     };
   }
+  /**
+   * Get WAL statistics.
+   */
+  async walStats() {
+    const result = await this.connection.request("WAL_STATS" /* WAL_STATS */);
+    return {
+      entryCount: result.entry_count,
+      segmentCount: result.segment_count,
+      totalSizeBytes: result.total_size_bytes,
+      latestOffset: result.latest_offset !== void 0 ? BigInt(result.latest_offset) : void 0,
+      ioStats: {
+        bytesWritten: result.io_stats.bytes_written,
+        bytesRead: result.io_stats.bytes_read,
+        writes: result.io_stats.writes,
+        reads: result.io_stats.reads,
+        fsyncs: result.io_stats.fsyncs
+      }
+    };
+  }
   /**
    * Create a snapshot of an instance.
    */