@schematichq/schematic-typescript-node 1.3.0 → 1.4.0

package/dist/datastream/websocket-client.d.ts

@@ -0,0 +1,127 @@
+import { EventEmitter } from 'events';
+import { DataStreamResp, DataStreamBaseReq } from './types';
+import { Logger } from '../logger';
+/**
+ * MessageHandlerFunc is a function type for handling incoming datastream messages
+ * Expects parsed DataStreamResp messages
+ */
+export type MessageHandlerFunc = (message: DataStreamResp) => Promise<void>;
+/**
+ * ConnectionReadyHandlerFunc is a function type for functions that need to be called before connection is considered ready
+ */
+export type ConnectionReadyHandlerFunc = () => Promise<void>;
+/**
+ * ClientOptions contains configuration for the datastream client
+ */
+export interface ClientOptions {
+    /** HTTP API URL or WebSocket URL - HTTP URLs will be automatically converted to WebSocket URLs */
+    url: string;
+    /** Schematic API key for authentication */
+    apiKey: string;
+    /** Handler for incoming messages */
+    messageHandler: MessageHandlerFunc;
+    /** Handler called when connection is ready */
+    connectionReadyHandler?: ConnectionReadyHandlerFunc;
+    /** Logger for debug/info/error messages */
+    logger: Logger;
+    /** Maximum number of reconnection attempts */
+    maxReconnectAttempts?: number;
+    /** Minimum delay between reconnection attempts */
+    minReconnectDelay?: number;
+    /** Maximum delay between reconnection attempts */
+    maxReconnectDelay?: number;
+}
+/**
+ * DatastreamWSClient represents a Schematic datastream websocket client with automatic reconnection
+ */
+export declare class DatastreamWSClient extends EventEmitter {
+    private readonly url;
+    private readonly headers;
+    private readonly logger;
+    private readonly messageHandler;
+    private readonly connectionReadyHandler?;
+    private readonly maxReconnectAttempts;
+    private readonly minReconnectDelay;
+    private readonly maxReconnectDelay;
+    private ws?;
+    private connected;
+    private ready;
+    private shouldReconnect;
+    private reconnectAttempts;
+    private pingInterval?;
+    private pongTimeout?;
+    private reconnectTimeout?;
+    constructor(options: ClientOptions);
+    /**
+     * Start begins the WebSocket connection and message handling
+     */
+    start(): void;
+    /**
+     * IsConnected returns whether the WebSocket is currently connected
+     */
+    isConnected(): boolean;
+    /**
+     * IsReady returns whether the datastream client is ready (connected + initialized)
+     */
+    isReady(): boolean;
+    /**
+     * SendMessage sends a message through the WebSocket connection
+     */
+    sendMessage(message: DataStreamBaseReq): Promise<void>;
+    /**
+     * Close gracefully closes the WebSocket connection
+     */
+    close(): void;
+    /**
+     * connectAndRead handles the main connection lifecycle
+     */
+    private connectAndRead;
+    /**
+     * connect establishes the WebSocket connection
+     */
+    private connect;
+    /**
+     * setupWebSocketHandlers sets up message and error handlers for the WebSocket
+     */
+    private setupWebSocketHandlers;
+    /**
+     * handleMessage processes incoming WebSocket messages
+     */
+    private handleMessage;
+    /**
+     * handleClose processes WebSocket close events
+     */
+    private handleClose;
+    /**
+     * handleError processes WebSocket error events
+     */
+    private handleError;
+    /**
+     * startPingPong initiates the ping/pong keepalive mechanism
+     */
+    private startPingPong;
+    /**
+     * sendPing sends a ping message to keep the connection alive
+     */
+    private sendPing;
+    /**
+     * handlePong handles pong responses from the server
+     */
+    private handlePong;
+    /**
+     * calculateBackoffDelay calculates exponential backoff delay with jitter
+     */
+    private calculateBackoffDelay;
+    /**
+     * setConnected updates the connection state
+     */
+    private setConnected;
+    /**
+     * setReady updates the ready state
+     */
+    private setReady;
+    /**
+     * cleanup clears timeouts and intervals
+     */
+    private cleanup;
+}

package/dist/index.d.ts

@@ -1,6 +1,8 @@
 export * as Schematic from "./api";
-export { LocalCache } from "./cache";
-export { SchematicClient } from "./wrapper";
+export { LocalCache } from "./cache/local";
+export { RedisCacheProvider, type RedisClient } from "./cache/redis";
+export { SchematicClient, type CheckFlagWithEntitlementResponse } from "./wrapper";
 export { SchematicEnvironment } from "./environments";
 export { SchematicError, SchematicTimeoutError } from "./errors";
+export { RulesEngineClient } from "./rules-engine";
 export { verifyWebhookSignature, verifySignature, computeSignature, computeHexSignature, WebhookSignatureError, WEBHOOK_SIGNATURE_HEADER, WEBHOOK_TIMESTAMP_HEADER } from "./webhooks";