@phpsandbox/sdk 0.0.2

package/dist/socket/index.d.ts

@@ -0,0 +1,229 @@
+import type { CloseEvent, ErrorEvent as WsErrorEvent } from 'ws';
+import { EventDispatcher } from '../events/index.js';
+interface WsOptions {
+    debug?: boolean;
+    startClosed?: boolean;
+    pingInterval?: number;
+    connectionTimeout?: number;
+    maxRetries?: number;
+}
+export interface CallOption {
+    responseEvent?: string;
+    timeout?: number;
+    retries?: number | false;
+    buffer?: boolean;
+    abortSignal?: AbortSignal;
+}
+export type WebSocketStatus = 'OPEN' | 'CONNECTING' | 'CLOSED';
+export declare enum SocketEvent {
+    BootError = "Events.BootError",
+    Response = "response",
+    Error = "error",
+    ClientId = "App.Actions.GetClientId"
+}
+export declare class ConnectionTimeoutError extends Error {
+    constructor(message?: string);
+}
+export declare class ConnectionFailedError extends Error {
+    readonly originalError?: Event;
+    constructor(message: string, originalError?: Event);
+}
+export declare class InvalidMessageError extends Error {
+    readonly data?: unknown;
+    constructor(message: string, data?: unknown);
+}
+export declare class InvalidConfigurationError extends Error {
+    constructor(message: string);
+}
+export interface ConnectionStats {
+    connectTime: number;
+    reconnectCount: number;
+    lastPingTime: number;
+    lastPongTime: number;
+    avgResponseTime: number;
+    totalMessages: number;
+    totalErrors: number;
+    connectionStartTime: number;
+    connectionDuration: number;
+    uptime: number;
+    messagesPerSecond: string;
+    errorRate: string;
+    timeSinceLastPing: number;
+    timeSinceLastPong: number;
+}
+export interface MessageQueueInfo {
+    length: number;
+    maxSize: number;
+    oldestMessageAge: number;
+}
+export interface RateLimiterInfo {
+    currentRequests: number;
+    maxRequests: number;
+    windowMs: number;
+    isLimited: boolean;
+}
+export interface TransportConfig {
+    pingInterval: number;
+    queueTimeout: number;
+    url: string;
+}
+export interface ConnectionMetrics {
+    status: string | undefined;
+    clientId: string;
+    isConnected: boolean;
+    isConnecting: boolean;
+    connectionStats: ConnectionStats;
+    messageQueue: MessageQueueInfo;
+    rateLimiter: RateLimiterInfo;
+    config: TransportConfig;
+}
+export type HealthStatus = 'healthy' | 'degraded' | 'unhealthy';
+export interface TransportEvents {
+    'transport.error': {
+        type: string;
+        error: any;
+        rawMessage?: unknown;
+        timestamp: number;
+    };
+    'transport.closed': {
+        code?: number;
+        reason?: string;
+        metrics: ConnectionMetrics;
+        timestamp: number;
+    };
+}
+export declare class Transport {
+    #private;
+    private readonly eventEmitter;
+    private readonly options;
+    private readonly PING_INTERVAL;
+    private clientId;
+    private closed;
+    private readonly rws;
+    private disposables;
+    private connectPromise;
+    private readonly url;
+    private connectionStats;
+    private messageQueue;
+    private readonly MAX_QUEUE_SIZE;
+    private readonly QUEUE_TIMEOUT;
+    private rateLimiter;
+    constructor(url: string, eventEmitter: EventDispatcher, options?: WsOptions);
+    /**
+     * Validate configuration options
+     */
+    private validateConfiguration;
+    /**
+     * Internal logging utility for debugging
+     */
+    private log;
+    id(): string;
+    private registerWatchers;
+    private handleRawMessage;
+    private handleMessage;
+    listen(event: string, listener: (data: any) => void, _context?: any): import("../types.js").Disposable;
+    removeListener(event: string, listener?: (data: any) => void): void;
+    listenOnce(event: string, listener: (data: any) => void, context?: any): void;
+    emit(event: string, ...data: any): void;
+    get isConnected(): boolean;
+    get isConnecting(): boolean;
+    get isDisconnected(): boolean;
+    get isClosed(): boolean;
+    get status(): string | undefined;
+    call(action: string, data?: object | string, options?: CallOption): Promise<any>;
+    private pack;
+    private sendWithRetry;
+    invoke(action: string, data?: object | string, options?: CallOption): Promise<any>;
+    disconnect(): void;
+    close(code?: number, reason?: string): void;
+    onDidConnect(listener: () => void): void;
+    onDidClose(listener: (e: CloseEvent | WsErrorEvent) => void): void;
+    /**
+     * Setup connection health monitoring
+     */
+    private setupConnectionHealthMonitoring;
+    /**
+     * Handle different WebSocket close codes appropriately
+     */
+    private handleConnectionClose;
+    /**
+     * Process queued messages when connection is restored
+     */
+    private processMessageQueue;
+    /**
+     * Clear old queued messages to prevent memory leaks
+     */
+    private clearOldQueuedMessages;
+    /**
+     * Rate limiting check
+     */
+    private isRateLimited;
+    /**
+     * Calculate exponential backoff delay
+     */
+    private getBackoffDelay;
+    /**
+     * Get comprehensive connection metrics
+     */
+    getConnectionMetrics(): {
+        status: string;
+        clientId: string;
+        isConnected: boolean;
+        isConnecting: boolean;
+        connectionStats: {
+            connectionDuration: number;
+            uptime: number;
+            messagesPerSecond: string;
+            errorRate: string;
+            timeSinceLastPing: number;
+            timeSinceLastPong: number;
+            connectTime: number;
+            reconnectCount: number;
+            lastPingTime: number;
+            lastPongTime: number;
+            avgResponseTime: number;
+            totalMessages: number;
+            totalErrors: number;
+            connectionStartTime: number;
+        };
+        messageQueue: {
+            length: number;
+            maxSize: number;
+            oldestMessageAge: number;
+        };
+        rateLimiter: {
+            currentRequests: number;
+            maxRequests: number;
+            windowMs: number;
+            isLimited: boolean;
+        };
+        config: {
+            pingInterval: number;
+            queueTimeout: number;
+            url: string;
+        };
+    };
+    /**
+     * Get connection health status
+     */
+    getHealthStatus(): 'healthy' | 'degraded' | 'unhealthy';
+    /**
+     * Reset connection statistics
+     */
+    resetStats(): void;
+    /**
+     * Run connection diagnostics
+     */
+    runDiagnostics(): Promise<{
+        status: HealthStatus;
+        metrics: ConnectionMetrics;
+        issues: string[];
+        recommendations: string[];
+    }>;
+    /**
+     * Periodic maintenance - clean up old data, run health checks
+     */
+    private startPeriodicMaintenance;
+}
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/socket/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/socket/index.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,IAAI,YAAY,EAAE,MAAM,IAAI,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAKrD,UAAU,SAAS;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,UAAU;IACzB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IACzB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,YAAY,GAAG,QAAQ,CAAC;AAE/D,oBAAY,WAAW;IACrB,SAAS,qBAAqB;IAC9B,QAAQ,aAAa;IACrB,KAAK,UAAU;IACf,QAAQ,4BAA4B;CACrC;AAGD,qBAAa,sBAAuB,SAAQ,KAAK;gBACnC,OAAO,GAAE,MAAuC;CAI7D;AAED,qBAAa,qBAAsB,SAAQ,KAAK;aAG5B,aAAa,CAAC,EAAE,KAAK;gBADrC,OAAO,EAAE,MAAM,EACC,aAAa,CAAC,EAAE,KAAK;CAKxC;AAED,qBAAa,mBAAoB,SAAQ,KAAK;aAG1B,IAAI,CAAC,EAAE,OAAO;gBAD9B,OAAO,EAAE,MAAM,EACC,IAAI,CAAC,EAAE,OAAO;CAKjC;AAGD,qBAAa,yBAA0B,SAAQ,KAAK;gBACtC,OAAO,EAAE,MAAM;CAI5B;AAGD,MAAM,WAAW,eAAe;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,iBAAiB,EAAE,MAAM,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,eAAe;IAC9B,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,eAAe;IAC9B,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,OAAO,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,eAAe,EAAE,eAAe,CAAC;IACjC,YAAY,EAAE,gBAAgB,CAAC;IAC/B,WAAW,EAAE,eAAe,CAAC;IAC7B,MAAM,EAAE,eAAe,CAAC;CACzB;AAED,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,UAAU,GAAG,WAAW,CAAC;AAGhE,MAAM,WAAW,eAAe;IAC9B,iBAAiB,EAAE;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,GAAG,CAAC;QACX,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,kBAAkB,EAAE;QAClB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,iBAAiB,CAAC;QAC3B,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;CACH;AAED,qBAAa,SAAS;;IAkDlB,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,OAAO;IAlD1B,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IAEvC,OAAO,CAAC,QAAQ,CAAc;IAE9B,OAAO,CAAC,MAAM,CAAS;IAGvB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAwB;IAE5C,OAAO,CAAC,WAAW,CAA0C;IAE7D,OAAO,CAAC,cAAc,CAA8B;IAEpD,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAM;IAG1B,OAAO,CAAC,eAAe,CASrB;IAGF,OAAO,CAAC,YAAY,CAOZ;IAER,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAO;IACtC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IAGvC,OAAO,CAAC,WAAW,CAIjB;gBAGA,GAAG,EAAE,MAAM,EACM,YAAY,EAAE,eAAe,EAC7B,OAAO,GAAE,SAAc;IAqC1C;;OAEG;IACH,OAAO,CAAC,qBAAqB;IAc7B;;OAEG;IACH,OAAO,CAAC,GAAG;IAkHJ,EAAE,IAAI,MAAM;YAIL,gBAAgB;YAmBhB,gBAAgB;YAyFhB,aAAa;IAWpB,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,EAAE,QAAQ,CAAC,EAAE,GAAG;IAInE,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI;IAInE,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,EAAE,OAAO,CAAC,EAAE,GAAG,GAAG,IAAI;IAI7E,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,GAAG,IAAI;IAI9C,IAAW,WAAW,IAAI,OAAO,CAEhC;IAED,IAAW,YAAY,IAAI,OAAO,CAEjC;IAED,IAAW,cAAc,IAAI,OAAO,CAEnC;IAED,IAAW,QAAQ,IAAI,OAAO,CAE7B;IAED,IAAW,MAAM,IAAI,MAAM,GAAG,SAAS,CAOtC;IAEY,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,GAAE,MAAM,GAAG,MAAW,EAAE,OAAO,GAAE,UAAe,GAAG,OAAO,CAAC,GAAG,CAAC;IAsHrG,OAAO,CAAC,IAAI;IAIZ,OAAO,CAAC,aAAa;IAqDd,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,GAAE,MAAM,GAAG,MAAW,EAAE,OAAO,GAAE,UAAe,GAAG,OAAO,CAAC,GAAG,CAAC;IAQ1F,UAAU,IAAI,IAAI;IASlB,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI;IAkD3C,YAAY,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI;IASxC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,UAAU,GAAG,YAAY,KAAK,IAAI,GAAG,IAAI;IASzE;;OAEG;IACH,OAAO,CAAC,+BAA+B;IA6BvC;;OAEG;IACH,OAAO,CAAC,qBAAqB;IAqB7B;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAwB3B;;OAEG;IACH,OAAO,CAAC,sBAAsB;IAiB9B;;OAEG;IACH,OAAO,CAAC,aAAa;IAgBrB;;OAEG;IACH,OAAO,CAAC,eAAe;IASvB;;OAEG;IACI,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAyC3B;;OAEG;IACI,eAAe,IAAI,SAAS,GAAG,UAAU,GAAG,WAAW;IAqB9D;;OAEG;IACI,UAAU,IAAI,IAAI;IAezB;;OAEG;IACU,cAAc,IAAI,OAAO,CAAC;QACrC,MAAM,EAAE,YAAY,CAAC;QACrB,OAAO,EAAE,iBAAiB,CAAC;QAC3B,MAAM,EAAE,MAAM,EAAE,CAAC;QACjB,eAAe,EAAE,MAAM,EAAE,CAAC;KAC3B,CAAC;IAmDF;;OAEG;IACH,OAAO,CAAC,wBAAwB;CAmCjC"}