@kevisual/api 0.0.41 → 0.0.43

package/dist/query-proxy.d.ts

@@ -0,0 +1,213 @@
+import { QueryClient, Result } from '@kevisual/query';
+import { QueryRouterServer, Route } from '@kevisual/router/browser';
+import { EventEmitter } from 'eventemitter3';
+import { QueryRouterServer as QueryRouterServer$1, App } from '@kevisual/router';
+
+declare const RouteTypeList: readonly ["api", "context", "worker", "page"];
+type RouterViewItemInfo = RouterViewApi | RouterViewContext | RouterViewWorker | RouteViewPage;
+type RouterViewItem<T = {}> = RouterViewItemInfo & T;
+type RouteViewBase = {
+    /**
+     * _id 用于纯本地存储标识
+     */
+    _id?: string;
+    id?: string;
+    title?: string;
+    description?: string;
+    enabled?: boolean;
+    /**
+     *  响应数据
+     */
+    response?: any;
+    /**
+     * 默认动作配置
+     */
+    action?: {
+        path?: string;
+        key?: string;
+        id?: string;
+        payload?: any;
+        [key: string]: any;
+    };
+};
+type RouterViewApi = {
+    type: 'api';
+    api: {
+        url: string;
+        query?: QueryClient;
+    };
+} & RouteViewBase;
+type RouterViewContext = {
+    type: 'context';
+    context: {
+        key: string;
+        router?: QueryRouterServer;
+    };
+} & RouteViewBase;
+type RouterViewWorker = {
+    type: 'worker';
+    worker: {
+        type: 'Worker' | 'SharedWorker' | 'serviceWorker';
+        url: string;
+        worker?: Worker | SharedWorker | ServiceWorker;
+        /**
+         * worker选项
+         * default: { type: 'module' }
+         */
+        workerOptions?: {
+            type: 'module' | 'classic';
+        };
+    };
+} & RouteViewBase;
+/**
+ * 去掉不需要保存都服务器的数据
+ * @param item
+ * @returns
+ */
+declare const pickRouterViewData: (item: RouterViewItem) => {
+    type: "api";
+    api: {
+        url: string;
+        query?: QueryClient;
+    };
+    id?: string;
+    title?: string;
+    description?: string;
+    enabled?: boolean;
+} | {
+    type: "context";
+    context: {
+        key: string;
+        router?: QueryRouterServer;
+    };
+    id?: string;
+    title?: string;
+    description?: string;
+    enabled?: boolean;
+} | {
+    type: "worker";
+    worker: {
+        type: "Worker" | "SharedWorker" | "serviceWorker";
+        url: string;
+        worker?: Worker | SharedWorker | ServiceWorker;
+        /**
+         * worker选项
+         * default: { type: 'module' }
+         */
+        workerOptions?: {
+            type: "module" | "classic";
+        };
+    };
+    id?: string;
+    title?: string;
+    description?: string;
+    enabled?: boolean;
+} | {
+    type: "page";
+    page: {
+        url: string;
+    };
+    id?: string;
+    title?: string;
+    description?: string;
+    enabled?: boolean;
+};
+/**
+ * 注入 js 的url地址，使用importScripts加载
+ */
+type RouteViewPage = {
+    type: 'page';
+    page: {
+        url: string;
+    };
+} & RouteViewBase;
+type RouterViewQuery = {
+    id: string;
+    query: string;
+    title: string;
+};
+type RouterViewData = {
+    data: {
+        items: RouterViewItem[];
+    };
+    views: RouterViewQuery[];
+    viewId?: string;
+    [key: string]: any;
+};
+declare class QueryProxy {
+    router: QueryRouterServer;
+    token?: string;
+    routerViewItems: RouterViewItem[];
+    views: RouterViewQuery[];
+    emitter: EventEmitter;
+    constructor(opts?: {
+        router?: QueryRouterServer;
+        token?: string;
+        routerViewData?: RouterViewData;
+    });
+    getDefulatToken(): string;
+    initRouterViewQuery(): void;
+    initRouterView(item: RouterViewItem): RouterViewItem<{}>;
+    /**
+     * 初始化路由
+     * @returns
+     */
+    init(): Promise<void>;
+    /**
+     * 监听初始化完成
+     * @returns
+     */
+    listenInitComplete(): Promise<boolean>;
+    initApi(item?: RouterViewApi): Promise<void>;
+    initContext(item?: RouterViewContext): Promise<void>;
+    generateId(): string;
+    callWorker(msg: any, viewItem: RouterViewWorker['worker']): Promise<Result>;
+    initWorker(item?: RouterViewWorker, initRoutes?: boolean): Promise<void>;
+    initPage(item?: RouteViewPage): Promise<void>;
+    /**
+     * 列出路由
+     * @param filter
+     * @param query WHERE metadata.tags CONTAINS 'premium'
+     * @returns
+     */
+    listRoutes(filterFn?: (item: Route) => boolean, opts?: {
+        viewId?: string;
+        query?: string;
+    }): Promise<any>;
+    getViewQuery(viewId: string): Promise<string>;
+    /**
+     * 运行路由
+     * @param msg
+     * @returns
+     */
+    run(msg: {
+        id?: string;
+        path?: string;
+        key?: string;
+    }): Promise<any>;
+    runByRouteView(routeView: RouterViewItem): Promise<RouterViewItem<{}>>;
+}
+type RouterItem = {
+    id?: string;
+    path?: string;
+    key?: string;
+    description?: string;
+    middleware?: string[];
+    metadata?: Record<string, any>;
+};
+
+declare const initApi: (opts: {
+    item?: RouterViewApi;
+    router: QueryRouterServer$1 | App;
+    token?: string;
+    /**
+     * WHERE path = 'auth' OR path = 'router' OR path = 'call'
+     */
+    exclude?: string;
+}) => Promise<{
+    code: any;
+    message: string;
+}>;
+
+export { QueryProxy, RouteTypeList, initApi, pickRouterViewData };
+export type { RouteViewPage, RouterItem, RouterViewApi, RouterViewContext, RouterViewData, RouterViewItem, RouterViewItemInfo, RouterViewQuery, RouterViewWorker };