@kevisual/query 0.0.19 → 0.0.20

package/dist/query-browser.d.ts

@@ -159,7 +159,9 @@ declare class Query {
      * 需要突然停止请求，比如401的时候
      */
     stop?: boolean;
+    qws: QueryWs;
     constructor(opts?: QueryOpts$1);
+    setQueryWs(qws: QueryWs): void;
     /**
      * 突然停止请求
      */
@@ -208,10 +210,13 @@ declare class BaseQuery<T extends Query = Query, R extends {
         queryDefine?: R;
         clientQuery?: T;
     });
-    get chain(): any;
+    get chain(): R['queryChain'];
     post<R = any, P = any>(data: P, options?: DataOpts): Promise<Result<R>>;
     get<R = any, P = any>(data: P, options?: DataOpts): Promise<Result<R>>;
 }
+declare class ClientQuery extends Query {
+    constructor(opts?: QueryOpts$1);
+}
 
 type QueryOpts = {
     url?: string;
@@ -220,13 +225,12 @@ type QueryOpts = {
     timeout?: number;
 };
 /**
- * 前端调用后端QueryRouter
+ * 前端调用后端QueryRouter, 封装 beforeRequest 和 wss
  */
 declare class QueryClient extends Query {
     tokenName: string;
     storage: Storage;
     token: string;
-    qws: QueryWs;
     constructor(opts?: QueryOpts & {
         tokenName?: string;
         storage?: Storage;
@@ -238,5 +242,5 @@ declare class QueryClient extends Query {
     removeToken(): void;
 }
 
-export { BaseQuery, Query, QueryClient, QueryWs, adapter, wrapperError };
+export { BaseQuery, ClientQuery, Query, QueryClient, QueryWs, adapter, wrapperError };
 export type { Data, DataOpts, QueryOpts, QueryWsOpts, Result };

package/dist/query-browser.js

@@ -326,6 +326,8 @@ class Query {
      * 需要突然停止请求，比如401的时候
      */
     stop;
+    // 默认不使用ws
+    qws;
     constructor(opts) {
         this.adapter = opts?.adapter || adapter;
         this.url = opts?.url || '/api/router';
@@ -334,6 +336,9 @@ class Query {
         };
         this.timeout = opts?.timeout || 60000 * 3; // 默认超时时间为 60s * 3
     }
+    setQueryWs(qws) {
+        this.qws = qws;
+    }
     /**
      * 突然停止请求
      */
@@ -469,16 +474,19 @@ class BaseQuery {
         return this.query.get(data, options);
     }
 }
+class ClientQuery extends Query {
+    constructor(opts) {
+        super({ ...opts, url: opts?.url || '/client/router' });
+    }
+}
 
 /**
- * 前端调用后端QueryRouter
+ * 前端调用后端QueryRouter, 封装 beforeRequest 和 wss
  */
 class QueryClient extends Query {
     tokenName;
     storage;
     token;
-    // 默认不使用ws
-    qws;
     constructor(opts) {
         super(opts);
         this.tokenName = opts?.tokenName || 'token';
@@ -513,4 +521,4 @@ class QueryClient extends Query {
 // 移除默认生成的实例
 // export const client = new QueryClient();
 
-export { BaseQuery, Query, QueryClient, QueryWs, adapter, wrapperError };
+export { BaseQuery, ClientQuery, Query, QueryClient, QueryWs, adapter, wrapperError };

package/dist/query.d.ts

@@ -1,3 +1,5 @@
+import { StoreApi } from 'zustand/vanilla';
+
 declare const methods: readonly ["GET", "POST"];
 type Method = (typeof methods)[number];
 type AdapterOpts = {
@@ -15,6 +17,67 @@ type AdapterOpts = {
  */
 declare const adapter: (opts: AdapterOpts, overloadOpts?: RequestInit) => Promise<any>;
 
+type QueryWsStore = {
+    connected: boolean;
+    status: 'connecting' | 'connected' | 'disconnected';
+    setConnected: (connected: boolean) => void;
+    setStatus: (status: QuerySelectState) => void;
+};
+type QuerySelectState = 'connecting' | 'connected' | 'disconnected';
+type QueryWsOpts = {
+    url?: string;
+    store?: StoreApi<QueryWsStore>;
+    ws?: WebSocket;
+};
+declare class QueryWs {
+    url: string;
+    store: StoreApi<QueryWsStore>;
+    ws: WebSocket;
+    constructor(opts?: QueryWsOpts);
+    /**
+     * 连接 WebSocket
+     */
+    connect(opts?: {
+        timeout?: number;
+    }): Promise<unknown>;
+    /**
+     * ws.onopen 必须用这个去获取，否者会丢失链接信息
+     * @param callback
+     * @returns
+     */
+    listenConnect(callback: () => void): () => void;
+    listenClose(callback: () => void): () => void;
+    onMessage<T = any, U = any>(fn: (data: U, event: MessageEvent) => void, opts?: {
+        /**
+         * 是否将数据转换为 JSON
+         */
+        isJson?: boolean;
+        /**
+         * 选择器
+         */
+        selector?: (data: T) => U;
+    }): () => void;
+    close(): void;
+    /**
+     * 发送消息
+     *
+     * @param data
+     * @param opts
+     * @returns
+     */
+    send<T = any, U = any>(data: T, opts?: {
+        /**
+         * 是否将数据转换为 JSON
+         */
+        isJson?: boolean;
+        /**
+         * 包装数据
+         */
+        wrapper?: (data: T) => U;
+    }): void;
+    getOpen(): boolean;
+}
+
 /**
  * 请求前处理函数
  * @param opts 请求配置
@@ -103,7 +166,9 @@ declare class Query {
      * 需要突然停止请求，比如401的时候
      */
     stop?: boolean;
+    qws: QueryWs;
     constructor(opts?: QueryOpts);
+    setQueryWs(qws: QueryWs): void;
     /**
      * 突然停止请求
      */
@@ -152,7 +217,7 @@ declare class BaseQuery<T extends Query = Query, R extends {
         queryDefine?: R;
         clientQuery?: T;
     });
-    get chain(): any;
+    get chain(): R['queryChain'];
     post<R = any, P = any>(data: P, options?: DataOpts): Promise<Result<R>>;
     get<R = any, P = any>(data: P, options?: DataOpts): Promise<Result<R>>;
 }

package/dist/query.js

@@ -110,6 +110,8 @@ class Query {
      * 需要突然停止请求，比如401的时候
      */
     stop;
+    // 默认不使用ws
+    qws;
     constructor(opts) {
         this.adapter = opts?.adapter || adapter;
         this.url = opts?.url || '/api/router';
@@ -118,6 +120,9 @@ class Query {
         };
         this.timeout = opts?.timeout || 60000 * 3; // 默认超时时间为 60s * 3
     }
+    setQueryWs(qws) {
+        this.qws = qws;
+    }
     /**
      * 突然停止请求
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kevisual/query",
-  "version": "0.0.19",
+  "version": "0.0.20",
   "main": "dist/index.js",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",