@scriptdb/client 1.1.0 → 1.1.2

package/README.md

@@ -373,7 +373,7 @@ The CLI reads configuration from `~/.scriptdb/config.json`:
 
 ## Changelog
 
-### 1.1.0 (2025-01-16)
+### 1.1.2 (2025-01-16)
 
 **Added**
 - Native `scriptdb logs` command to view real-time logs

package/dist/index.d.mts

@@ -0,0 +1,192 @@
+import * as tls from 'tls';
+
+type Action = 'script-code' | 'save-db' | 'remove-db' | 'rename-db' | 'login' | 'logout' | 'get-info' | 'list-dbs' | 'create-db' | 'update-db' | 'get-db' | 'shell-command' | 'string';
+interface DataOptions {
+    code?: string | any;
+    databaseName?: string | any;
+    token?: string | any;
+    username?: string | any;
+    password?: string | any;
+    newName?: string | any;
+}
+interface Logger {
+    debug?: (...args: any[]) => void;
+    info?: (...args: any[]) => void;
+    warn?: (...args: any[]) => void;
+    error?: (...args: any[]) => void;
+}
+interface ClientOptions {
+    secure?: boolean;
+    logger?: Logger;
+    requestTimeout?: number;
+    socketTimeout?: number;
+    retries?: number;
+    retryDelay?: number;
+    tlsOptions?: tls.TlsOptions;
+    frame?: 'ndjson' | 'length-prefix';
+    preferLengthPrefix?: boolean;
+    maxPending?: number;
+    maxQueue?: number;
+    maxMessageSize?: number;
+    signing?: {
+        secret: string;
+        algorithm?: string;
+    };
+    stringify?: (obj: any) => string;
+    username?: string;
+    password?: string;
+    tokenRefresh?: () => Promise<{
+        token: string;
+        expiresAt?: number;
+    }>;
+}
+interface Message {
+    id?: number;
+    action?: Action;
+    command?: string;
+    message?: string;
+    data?: DataOptions;
+    token?: string;
+    signature?: string;
+    payload?: any;
+}
+declare class ScriptDBClient {
+    private options;
+    private socketTimeout;
+    private maxMessageSize;
+    private _mask;
+    private _maskArgs;
+    private logger?;
+    private secure;
+    private requestTimeout;
+    private retries;
+    private retryDelay;
+    private frame;
+    private uri;
+    private protocolName;
+    private username;
+    private password;
+    private host;
+    private port;
+    private database;
+    private client;
+    private buffer;
+    private _nextId;
+    private _pending;
+    private _maxPending;
+    private _maxQueue;
+    private _pendingQueue;
+    private _connected;
+    private _authenticating;
+    private token;
+    private _currentRetries;
+    private tokenExpiry;
+    private _destroyed;
+    private _reconnectTimer;
+    private signing;
+    private _stringify;
+    private ready;
+    private _resolveReadyFn;
+    private _rejectReadyFn;
+    private _connecting;
+    private _authPendingId;
+    /**
+     * Create a new client. Do NOT auto-connect in constructor — call connect()
+     * @param uri - Connection URI
+     * @param options - Client options
+     * @param options.secure - use TLS
+     * @param options.logger - { debug, info, warn, error }
+     * @param options.requestTimeout - Request timeout in ms
+     * @param options.retries - Reconnection retries
+     * @param options.retryDelay - Initial retry delay in ms
+     * @param options.tlsOptions - Passed to tls.connect when secure
+     */
+    constructor(uri: string, options?: ClientOptions);
+    _createReady(): void;
+    _resolveReady(value: any): void;
+    _rejectReady(err: Error): void;
+    /**
+     * Check if connected
+     */
+    get connected(): boolean;
+    /**
+     * Connect to server and authenticate. Returns a Promise that resolves when authenticated.
+     */
+    connect(): Promise<any>;
+    _setupListeners(): void;
+    _buildFinalBuffer(payloadBase: Message, id: number): Buffer<ArrayBuffer>;
+    _handleMessage(msg: Message): void;
+    authenticate(): Promise<any>;
+    _write(buf: any): Promise<unknown>;
+    _processQueue(): Promise<void>;
+    /**
+     * Execute a command. Supports concurrent requests via request id mapping.
+     * Returns a Promise resolved with response.data or rejected on ERROR/timeout.
+     */
+    execute(payload: Message): Promise<unknown>;
+    /**
+     * Attempt to refresh token using provided tokenRefresh option if token expired.
+     * options.tokenRefresh should be async function that returns { token, expiresAt }
+     */
+    _maybeRefreshToken(): Promise<boolean>;
+    destroy(): void;
+    _handleDisconnect(err: any): void;
+    close(): void;
+    /**
+     * Disconnect (alias for close)
+     */
+    disconnect(): void;
+    /**
+     * Send request helper (for public API methods)
+     */
+    sendRequest(action: Action, data?: any): Promise<any>;
+    /**
+     * Login with username and password
+     */
+    login(username: string, password: string): Promise<any>;
+    /**
+     * Logout from server
+     */
+    logout(): Promise<any>;
+    /**
+     * List all databases
+     */
+    listDatabases(): Promise<any>;
+    /**
+     * Create a new database
+     */
+    createDatabase(name: string): Promise<any>;
+    /**
+     * Remove a database
+     */
+    removeDatabase(name: string): Promise<any>;
+    /**
+     * Rename a database
+     */
+    renameDatabase(oldName: string, newName: string): Promise<any>;
+    /**
+     * Execute code in a database
+     */
+    run(code: string | Function, databaseName: string): Promise<any>;
+    /**
+     * Save a database to disk
+     */
+    saveDatabase(databaseName: string): Promise<any>;
+    /**
+     * Update database metadata
+     */
+    updateDatabase(databaseName: string, data: any): Promise<any>;
+    /**
+     * Get server information
+     */
+    getInfo(): Promise<any>;
+    /**
+     * Execute shell command on server
+     */
+    executeShell(command: string): Promise<{
+        stdout: string;
+        stderr: string;
+    }>;
+}
+
+export { ScriptDBClient, ScriptDBClient as default };

package/dist/index.d.ts

@@ -0,0 +1,192 @@
+import * as tls from 'tls';
+
+type Action = 'script-code' | 'save-db' | 'remove-db' | 'rename-db' | 'login' | 'logout' | 'get-info' | 'list-dbs' | 'create-db' | 'update-db' | 'get-db' | 'shell-command' | 'string';
+interface DataOptions {
+    code?: string | any;
+    databaseName?: string | any;
+    token?: string | any;
+    username?: string | any;
+    password?: string | any;
+    newName?: string | any;
+}
+interface Logger {
+    debug?: (...args: any[]) => void;
+    info?: (...args: any[]) => void;
+    warn?: (...args: any[]) => void;
+    error?: (...args: any[]) => void;
+}
+interface ClientOptions {
+    secure?: boolean;
+    logger?: Logger;
+    requestTimeout?: number;
+    socketTimeout?: number;
+    retries?: number;
+    retryDelay?: number;
+    tlsOptions?: tls.TlsOptions;
+    frame?: 'ndjson' | 'length-prefix';
+    preferLengthPrefix?: boolean;
+    maxPending?: number;
+    maxQueue?: number;
+    maxMessageSize?: number;
+    signing?: {
+        secret: string;
+        algorithm?: string;
+    };
+    stringify?: (obj: any) => string;
+    username?: string;
+    password?: string;
+    tokenRefresh?: () => Promise<{
+        token: string;
+        expiresAt?: number;
+    }>;
+}
+interface Message {
+    id?: number;
+    action?: Action;
+    command?: string;
+    message?: string;
+    data?: DataOptions;
+    token?: string;
+    signature?: string;
+    payload?: any;
+}
+declare class ScriptDBClient {
+    private options;
+    private socketTimeout;
+    private maxMessageSize;
+    private _mask;
+    private _maskArgs;
+    private logger?;
+    private secure;
+    private requestTimeout;
+    private retries;
+    private retryDelay;
+    private frame;
+    private uri;
+    private protocolName;
+    private username;
+    private password;
+    private host;
+    private port;
+    private database;
+    private client;
+    private buffer;
+    private _nextId;
+    private _pending;
+    private _maxPending;
+    private _maxQueue;
+    private _pendingQueue;
+    private _connected;
+    private _authenticating;
+    private token;
+    private _currentRetries;
+    private tokenExpiry;
+    private _destroyed;
+    private _reconnectTimer;
+    private signing;
+    private _stringify;
+    private ready;
+    private _resolveReadyFn;
+    private _rejectReadyFn;
+    private _connecting;
+    private _authPendingId;
+    /**
+     * Create a new client. Do NOT auto-connect in constructor — call connect()
+     * @param uri - Connection URI
+     * @param options - Client options
+     * @param options.secure - use TLS
+     * @param options.logger - { debug, info, warn, error }
+     * @param options.requestTimeout - Request timeout in ms
+     * @param options.retries - Reconnection retries
+     * @param options.retryDelay - Initial retry delay in ms
+     * @param options.tlsOptions - Passed to tls.connect when secure
+     */
+    constructor(uri: string, options?: ClientOptions);
+    _createReady(): void;
+    _resolveReady(value: any): void;
+    _rejectReady(err: Error): void;
+    /**
+     * Check if connected
+     */
+    get connected(): boolean;
+    /**
+     * Connect to server and authenticate. Returns a Promise that resolves when authenticated.
+     */
+    connect(): Promise<any>;
+    _setupListeners(): void;
+    _buildFinalBuffer(payloadBase: Message, id: number): Buffer<ArrayBuffer>;
+    _handleMessage(msg: Message): void;
+    authenticate(): Promise<any>;
+    _write(buf: any): Promise<unknown>;
+    _processQueue(): Promise<void>;
+    /**
+     * Execute a command. Supports concurrent requests via request id mapping.
+     * Returns a Promise resolved with response.data or rejected on ERROR/timeout.
+     */
+    execute(payload: Message): Promise<unknown>;
+    /**
+     * Attempt to refresh token using provided tokenRefresh option if token expired.
+     * options.tokenRefresh should be async function that returns { token, expiresAt }
+     */
+    _maybeRefreshToken(): Promise<boolean>;
+    destroy(): void;
+    _handleDisconnect(err: any): void;
+    close(): void;
+    /**
+     * Disconnect (alias for close)
+     */
+    disconnect(): void;
+    /**
+     * Send request helper (for public API methods)
+     */
+    sendRequest(action: Action, data?: any): Promise<any>;
+    /**
+     * Login with username and password
+     */
+    login(username: string, password: string): Promise<any>;
+    /**
+     * Logout from server
+     */
+    logout(): Promise<any>;
+    /**
+     * List all databases
+     */
+    listDatabases(): Promise<any>;
+    /**
+     * Create a new database
+     */
+    createDatabase(name: string): Promise<any>;
+    /**
+     * Remove a database
+     */
+    removeDatabase(name: string): Promise<any>;
+    /**
+     * Rename a database
+     */
+    renameDatabase(oldName: string, newName: string): Promise<any>;
+    /**
+     * Execute code in a database
+     */
+    run(code: string | Function, databaseName: string): Promise<any>;
+    /**
+     * Save a database to disk
+     */
+    saveDatabase(databaseName: string): Promise<any>;
+    /**
+     * Update database metadata
+     */
+    updateDatabase(databaseName: string, data: any): Promise<any>;
+    /**
+     * Get server information
+     */
+    getInfo(): Promise<any>;
+    /**
+     * Execute shell command on server
+     */
+    executeShell(command: string): Promise<{
+        stdout: string;
+        stderr: string;
+    }>;
+}
+
+export { ScriptDBClient, ScriptDBClient as default };