@geodedb/client 1.0.0-alpha.25 → 1.0.2

package/dist/index.d.ts

@@ -77,6 +77,8 @@ interface GeodeConfig {
     inlineTimeout?: number;
     /** Enable TLS for gRPC (default: true) */
     tls?: boolean;
+    /** Graph name for DSN graph binding. When set, the server binds the session to this graph. */
+    graph?: string;
 }
 /**
  * Connection pool configuration.
@@ -317,12 +319,15 @@ interface HelloRequest {
     clientName: string;
     clientVersion: string;
     wantedConformance: string;
+    graph?: string;
 }
 interface HelloResponse {
     success: boolean;
     sessionId: string;
     errorMessage: string;
     capabilities: string[];
+    passwordResetRequired?: boolean;
+    graph?: string;
 }
 interface Param {
     name: string;
@@ -605,7 +610,7 @@ declare function decodeLengthPrefix(data: Buffer): number;
 /**
  * Build a HelloRequest message.
  */
-declare function buildHelloRequest(username: string, password: string, clientName: string, clientVersion: string, conformance: string, tenantId?: string): QuicClientMessage;
+declare function buildHelloRequest(username: string, password: string, clientName: string, clientVersion: string, conformance: string, tenantId?: string, graph?: string): QuicClientMessage;
 /**
  * Build an ExecuteRequest message.
  */
@@ -703,6 +708,7 @@ declare class QuicTransport extends BaseTransport {
     private _maxMessageSize;
     private _maxBufferBytes;
     private _pendingProtoReads;
+    private _pendingResponses;
     constructor(address: string, maxMessageSize?: number, maxBufferBytes?: number);
     /**
      * Connect to the Geode server using QUIC.
@@ -1129,10 +1135,18 @@ declare class Transaction {
     exec(query: string, options?: QueryOptions): Promise<void>;
     /**
      * Create a savepoint.
+     *
+     * Savepoints are only supported over the QUIC transport. Over gRPC this
+     * rejects with a {@link DriverError} (statusClass `58000`) directing callers
+     * to use `quic://`.
      */
     savepoint(name: string, signal?: AbortSignal): Promise<void>;
     /**
      * Rollback to a savepoint.
+     *
+     * Savepoints are only supported over the QUIC transport. Over gRPC this
+     * rejects with a {@link DriverError} (statusClass `58000`) directing callers
+     * to use `quic://`.
      */
     rollbackTo(name: string, signal?: AbortSignal): Promise<void>;
     /**
@@ -1630,6 +1644,8 @@ declare class Connection {
     }>;
     /** Try to receive an inline response with short timeout. */
     private _tryReceiveInline;
+    /** Read inline execute responses until a page, error, heartbeat, or timeout arrives. */
+    private _readInlineExecute;
     /** Drain remaining data pages until final=true to prevent query corruption (QUAL-T7). */
     private _drainRemainingPages;
     /** @internal Release the active result, returning the connection to idle. */
@@ -1666,6 +1682,7 @@ declare class Connection {
     private _receiveWithTimeout;
     /** Create a combined abort signal from requestTimeout and optional caller signal (CWE-703). */
     private _withRequestTimeout;
+    private _closeOnTransportError;
 }
 
 /**
@@ -2204,6 +2221,7 @@ interface RateLimiterConfig {
 declare class ConnectionPool {
     private _config;
     private _connections;
+    private _pendingConnections;
     private _waitQueue;
     private _closed;
     private _maintenanceInterval?;
@@ -2274,12 +2292,56 @@ declare class ConnectionPool {
      * Remove a connection from the pool.
      */
     private removeConnection;
+    private fulfillWaiters;
     /**
      * Perform pool maintenance.
      */
     private maintenance;
 }
 
+/**
+ * Client-level retry wrapper for transient errors.
+ *
+ * Mirrors the Go reference client's `RetryPolicy`/`Retry` (see
+ * `geode-client-go/retry.go`): retries only when {@link isRetryableError}
+ * returns true, with exponential backoff capped at `maxBackoffMs`.
+ */
+/**
+ * Configures retry behavior for transient errors.
+ */
+interface RetryPolicy {
+    /**
+     * Maximum number of attempts including the initial call.
+     * Values less than 1 are treated as 1.
+     */
+    maxAttempts: number;
+    /** Delay in milliseconds before the first retry. */
+    initialBackoffMs: number;
+    /**
+     * Maximum backoff in milliseconds. The exponential backoff is clamped to
+     * this value.
+     */
+    maxBackoffMs: number;
+    /** Exponential backoff multiplier applied on each retry. */
+    multiplier: number;
+}
+/**
+ * Returns a {@link RetryPolicy} with sensible defaults:
+ * 3 max attempts, 1000ms initial backoff, 30000ms max backoff, 2.0 multiplier.
+ */
+declare function defaultRetryPolicy(): RetryPolicy;
+/**
+ * Executes `fn` up to `policy.maxAttempts` times, retrying only when
+ * {@link isRetryableError} returns true for the rejection reason. Non-retryable
+ * errors and non-Geode errors are propagated immediately without further
+ * attempts. Between attempts the wrapper waits using exponential backoff
+ * clamped to `policy.maxBackoffMs`.
+ *
+ * @param fn The operation to run. Re-invoked on each retry.
+ * @param policy Optional retry policy. Defaults to {@link defaultRetryPolicy}.
+ */
+declare function withRetry<T>(fn: () => Promise<T>, policy?: RetryPolicy): Promise<T>;
+
 /**
  * gRPC Transport Layer
  *
@@ -2820,4 +2882,4 @@ declare function node(): NodePatternBuilder;
  */
 declare function edge(): EdgePatternBuilder;
 
-export { AuthClient, BaseTransport, type BatchOptions, type BatchQuery, type BatchResult, type BatchSummary, type BeginRequest, type BeginResponse, type ClientOptions, type ColumnDef, type ColumnDefinition, type ColumnInfo, type CommitRequest, type CommitResponse, ConfigError, Connection, ConnectionPool, type ConnectionState, type CreateRLSPolicyOptions, type CreateRoleOptions, type CreateUserOptions, DEFAULT_CONFORMANCE, DEFAULT_GRPC_PORT, DEFAULT_HELLO_NAME, DEFAULT_HELLO_VERSION, DEFAULT_PAGE_SIZE, DEFAULT_PORT, type DSNScheme, type DataPage, DriverError, ERR_BAD_CONN_MESSAGE, ERR_CLOSED_MESSAGE, ERR_NO_TX_MESSAGE, ERR_QUERY_IN_PROGRESS_MESSAGE, ERR_ROWS_CLOSED_MESSAGE, ERR_TX_DONE_MESSAGE, ERR_TX_IN_PROGRESS_MESSAGE, type EdgeDirection, type EdgePattern, EdgePatternBuilder, ErrBadConn, ErrClosed, ErrNoTx, ErrQueryInProgress, ErrRowsClosed, ErrTxDone, ErrTxInProgress, type ExecuteRequest, type ExecutionResponse, type ExplainOptions, type GQLEdge, type GQLId, type GQLNode, type GQLPath, type GQLRange, type GQLType, GQLValue, type GQLValueKind, GeodeClient, type GeodeConfig, type GeodeError, GrpcTransport, type HelloRequest, type HelloResponse, MAX_PAGE_SIZE, MAX_QUERY_LENGTH, MockTransport, type NodePattern, NodePatternBuilder, type OperationTiming, type Param, type ParameterInfo, PatternBuilder, type PatternElement, type Permission, type PingRequest, type PingResponse, type PlanOperation, type PoolConfig, PredicateBuilder, type PredicateOp, PreparedStatement, type ProtoError, type Row$1 as ProtoRow, type ProtoValue, type PullRequest, type PullResponse, QueryBuilder, type QueryOptions, type QueryParams, type QueryPlan, type QueryProfile, QueryResult, QueryResultIterator, type QuicClientMessage, type QuicServerMessage, QuicTransport, QuicTransport as QuicheTransport, type RLSPolicy, type RawEdge, type Role, type RollbackRequest, type RollbackResponse, type Row, SUPPORTED_SCHEMES, type SchemaDefinition, SecurityError, type SortDirection, StateError, type Status, StatusClass, type StatusClassType, Transaction, type Transport, TransportError, type TransportType, type User, batch, batchAll, batchFirst, batchMap, batchParallel, buildBeginRequest, buildCommitRequest, buildExecuteRequest, buildHelloRequest, buildPingRequest, buildPullRequest, buildRollbackRequest, buildRollbackToRequest, buildSavepointRequest, buildTLSConfig, cloneConfig, createAuthClient, createClient, createClientWithConfig, createTransport, decodeLengthPrefix, decodeQuicServerMessage, defaultConfig, edge, encodeQuicClientMessage, encodeWithLengthPrefix, ensureProtoInitialized, explain, extractParameters, formatPlan, formatProfile, fromJSON, getAddress, getProtoPath, initProtoSync, isDriverError, isGeodeError, isRetryableError, isSentinelError, jsToProtoValue, node, parseDSN, parseGQLType, parseRow, pattern, predicate, prepare, profile, protoValueToJS, query, redactConfig, redactDSN, rowToObject, rowToRecord, sanitizeForLog, validateConfig, validateHostname, validatePageSize, validateParamName, validateParamValue, validatePort, validateQuery, validateSavepointName, withTransaction };
+export { AuthClient, BaseTransport, type BatchOptions, type BatchQuery, type BatchResult, type BatchSummary, type BeginRequest, type BeginResponse, type ClientOptions, type ColumnDef, type ColumnDefinition, type ColumnInfo, type CommitRequest, type CommitResponse, ConfigError, Connection, ConnectionPool, type ConnectionState, type CreateRLSPolicyOptions, type CreateRoleOptions, type CreateUserOptions, DEFAULT_CONFORMANCE, DEFAULT_GRPC_PORT, DEFAULT_HELLO_NAME, DEFAULT_HELLO_VERSION, DEFAULT_PAGE_SIZE, DEFAULT_PORT, type DSNScheme, type DataPage, DriverError, ERR_BAD_CONN_MESSAGE, ERR_CLOSED_MESSAGE, ERR_NO_TX_MESSAGE, ERR_QUERY_IN_PROGRESS_MESSAGE, ERR_ROWS_CLOSED_MESSAGE, ERR_TX_DONE_MESSAGE, ERR_TX_IN_PROGRESS_MESSAGE, type EdgeDirection, type EdgePattern, EdgePatternBuilder, ErrBadConn, ErrClosed, ErrNoTx, ErrQueryInProgress, ErrRowsClosed, ErrTxDone, ErrTxInProgress, type ExecuteRequest, type ExecutionResponse, type ExplainOptions, type GQLEdge, type GQLId, type GQLNode, type GQLPath, type GQLRange, type GQLType, GQLValue, type GQLValueKind, GeodeClient, type GeodeConfig, type GeodeError, GrpcTransport, type HelloRequest, type HelloResponse, MAX_PAGE_SIZE, MAX_QUERY_LENGTH, MockTransport, type NodePattern, NodePatternBuilder, type OperationTiming, type Param, type ParameterInfo, PatternBuilder, type PatternElement, type Permission, type PingRequest, type PingResponse, type PlanOperation, type PoolConfig, PredicateBuilder, type PredicateOp, PreparedStatement, type ProtoError, type Row$1 as ProtoRow, type ProtoValue, type PullRequest, type PullResponse, QueryBuilder, type QueryOptions, type QueryParams, type QueryPlan, type QueryProfile, QueryResult, QueryResultIterator, type QuicClientMessage, type QuicServerMessage, QuicTransport, QuicTransport as QuicheTransport, type RLSPolicy, type RawEdge, type RetryPolicy, type Role, type RollbackRequest, type RollbackResponse, type Row, SUPPORTED_SCHEMES, type SchemaDefinition, SecurityError, type SortDirection, StateError, type Status, StatusClass, type StatusClassType, Transaction, type Transport, TransportError, type TransportType, type User, batch, batchAll, batchFirst, batchMap, batchParallel, buildBeginRequest, buildCommitRequest, buildExecuteRequest, buildHelloRequest, buildPingRequest, buildPullRequest, buildRollbackRequest, buildRollbackToRequest, buildSavepointRequest, buildTLSConfig, cloneConfig, createAuthClient, createClient, createClientWithConfig, createTransport, decodeLengthPrefix, decodeQuicServerMessage, defaultConfig, defaultRetryPolicy, edge, encodeQuicClientMessage, encodeWithLengthPrefix, ensureProtoInitialized, explain, extractParameters, formatPlan, formatProfile, fromJSON, getAddress, getProtoPath, initProtoSync, isDriverError, isGeodeError, isRetryableError, isSentinelError, jsToProtoValue, node, parseDSN, parseGQLType, parseRow, pattern, predicate, prepare, profile, protoValueToJS, query, redactConfig, redactDSN, rowToObject, rowToRecord, sanitizeForLog, validateConfig, validateHostname, validatePageSize, validateParamName, validateParamValue, validatePort, validateQuery, validateSavepointName, withRetry, withTransaction };