@oox/ws-client 1.0.0

package/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from './adapter.js';
+export * from './socket.js';
+export * from './utils.js';

package/types/socket.d.ts

@@ -0,0 +1,59 @@
+import { SampleKeepAliveNativeConnection } from '@oox/client';
+import EventEmitter from 'events';
+export type WebSocketEventType = keyof WebSocketEventMap;
+export declare const WebsocketEvents: WebSocketEventType[];
+export declare const MessagePackEncodeOptions: {
+    ignoreUndefined: boolean;
+};
+export declare enum RPCType {
+    Request = 1,
+    Response = 2
+}
+export interface RPCMessage {
+    type: RPCType;
+    id?: number;
+    event?: string;
+    args: any[];
+}
+export declare class RPCEvent extends Event {
+    data: any[];
+    constructor(type: string, data: any[]);
+}
+export declare const MAX_REQUEST_ID = 4294967295;
+export type Callback = (...args: any[]) => void;
+export declare class Socket extends EventEmitter implements SampleKeepAliveNativeConnection {
+    private callbacks;
+    private requestId;
+    private eventHub;
+    native: WebSocket | null;
+    connected: boolean;
+    url: URL;
+    protocols?: string | string[];
+    constructor(address: string | URL, protocols?: string | string[]);
+    isNativeEvent(event: string): boolean;
+    off(event: WebSocketEventType | string, listener?: (...args: any[]) => void): this;
+    emit(event: WebSocketEventType | string, ...args: any[]): boolean;
+    /**
+     * 生成自增请求ID
+     */
+    private generateRequestId;
+    disconnect(): void;
+    connect(): void;
+    send(data: string | Uint8Array): void;
+    /**
+     * 发送RPC消息
+     */
+    sendRPCMessage(message: RPCMessage): void;
+    /**
+     * 处理消息
+     */
+    private handleMessage;
+    /**
+     * 处理RPC消息
+     */
+    private handleRPC;
+    /**
+     * RPC调用
+     */
+    rpc(event: string, ...args: any[]): void;
+}

package/types/utils.d.ts

@@ -0,0 +1,14 @@
+export declare const OOXEvent: {
+    CONNECT: string;
+    DISCONNECT: string;
+    ERROR: string;
+    CALL: string;
+    READY: string;
+    ENABLED: string;
+    DISABLED: string;
+    REGISTRY_SYNC_CONNECTIONS: string;
+    REGISTRY_SUBSCRIBE: string;
+    REGISTRY_NOTIFY: string;
+};
+export declare function isWebSocketURL(url: string | URL): boolean;
+export declare function genWebSocketURL(url: string): URL;

package/utils.js

@@ -0,0 +1,44 @@
+export const OOXEvent = {
+    CONNECT: 'open',
+    DISCONNECT: 'close',
+    ERROR: 'socket:error',
+    CALL: 'call',
+    READY: 'oox:ready',
+    ENABLED: 'oox:enabled',
+    DISABLED: 'oox:disabled',
+    REGISTRY_SYNC_CONNECTIONS: 'oox:registry:sync_connections',
+    REGISTRY_SUBSCRIBE: 'oox:registry:subscribe',
+    REGISTRY_NOTIFY: 'oox:registry:notify',
+};
+export function isWebSocketURL(url) {
+    if ('string' === typeof url) {
+        return /^wss?:\/\/.+$/.test(url);
+    }
+    else {
+        return url.protocol === 'ws:' || url.protocol === 'wss:';
+    }
+}
+export function genWebSocketURL(url) {
+    // :6000
+    if (url.startsWith(':'))
+        url = 'ws://localhost' + url;
+    // 127.0.0.1:6000
+    if (!/^\w+?:\/.+$/.test(url))
+        url = 'ws://' + url;
+    const urlObject = new URL(url);
+    // :8000 => :8000/ws
+    const notSetPath = !urlObject.pathname || (urlObject.pathname === '/'
+        && !url.endsWith('/')
+        && !urlObject.search
+        && !urlObject.hash);
+    if (notSetPath) {
+        urlObject.pathname = '/ws';
+    }
+    if (urlObject.protocol !== 'wss:') {
+        if (urlObject.port === '443')
+            urlObject.protocol = 'wss:';
+        else
+            urlObject.protocol = 'ws:';
+    }
+    return urlObject;
+}