zzz-pc-view 0.0.1 → 0.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zzz-pc-view",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "main": "src/index.umd.js",
   "module": "src/index.es.js",
   "types": "src/index.d.ts",

package/src/webUtils/WebSocketManager.d.ts

@@ -0,0 +1,160 @@
+import { EventType, Handler } from 'mitt';
+import { KeyValType } from '../utils';
+/**
+ * WebSocket消息选项接口
+ * 定义了WebSocket消息的相关配置选项
+ */
+export interface WebSocketMessageOption {
+    codeKey?: KeyValType;
+    commandKey?: string;
+    dataKey?: string;
+    msgKey?: string;
+    errorHandlerMap?: Record<number | string, (msg: string) => void>;
+    reconnectInterval?: number;
+}
+declare const WS_SYMBOL: unique symbol;
+declare const WS_MSG_OPTION_SYMBOL: unique symbol;
+declare const WS_PARAMS: unique symbol;
+declare const WS_EVENTS: unique symbol;
+declare const WS_CREATE: unique symbol;
+declare const WS_REMOVE: unique symbol;
+declare const WS_ON_OPEN: unique symbol;
+declare const WS_ON_MESSAGE: unique symbol;
+declare const WS_ON_CLOSE: unique symbol;
+declare const WS_DESTROY: unique symbol;
+declare const WS_READY: unique symbol;
+declare const RECONNECT_TIMER: unique symbol;
+/**
+ * WebSocketManager 类
+ * 管理 WebSocket 连接的生命周期，处理消息的发送和接收，以及错误处理和重连机制。
+ */
+export declare class WebSocketManager {
+    /**
+     * 注册一个回调函数，当 WebSocket 连接准备就绪时调用。
+     * @param onReady - 当 WebSocket 连接准备就绪时要调用的回调函数。
+     */
+    onReady(onReady: () => void): void;
+    /**
+     * 注册一个事件监听器，当指定类型的事件发生时调用。
+     * @param type - 要监听的事件类型。
+     * @param handler - 事件发生时要调用的回调函数。
+     */
+    on(type: EventType, handler: Handler): void;
+    /**
+     * 注册一个一次性的事件监听器，当指定类型的事件发生时调用。
+     * @param type - 要监听的事件类型。
+     * @param handler - 事件发生时要调用的回调函数。
+     */
+    once(type: EventType, handler: Handler): void;
+    /**
+     * 注销一个事件监听器，当指定类型的事件发生时不再调用。
+     * @param type - 要注销的事件类型。
+     * @param handler - 要注销的事件处理函数。
+     */
+    off(type: EventType, handler: Handler): void;
+    /**
+     * 发出一个事件，通知所有注册的监听器。
+     *
+     * @param type - 要发出的事件类型。
+     * @param event - 要传递给监听器的事件数据。
+     */
+    emit<T>(type: EventType, event: T): void;
+    /**
+     * 发送消息到 WebSocket 服务器。
+     *
+     * @param command - 要发送的命令字符串。
+     * @param data - 要发送的消息数据，可以是任何类型。
+     */
+    send(command: string, data: unknown): void;
+    /**
+     * 销毁 WebSocketManager 实例。
+     * 这个方法会关闭 WebSocket 连接，清除所有事件监听器，
+     * 并重置内部状态，确保 WebSocketManager 实例不再可用。
+     *
+     * @returns {void}
+     */
+    destroy(): void;
+    /**
+     * 私有属性 WS_SYMBOL，用于存储 WebSocket 实例。
+     * 这个属性是可选的，因为 WebSocket 实例可能在某些情况下不存在。
+     */
+    private [WS_SYMBOL]?;
+    /**
+     * 私有属性 WS_READY，用于表示 WebSocket 是否准备就绪。
+     * 这个属性是一个布尔值，初始值为 false，表示 WebSocket 尚未准备就绪。
+     * 当 WebSocket 连接成功并准备好发送和接收消息时，这个属性会被设置为 true。
+     */
+    private [WS_READY];
+    /**
+     * 私有属性 WS_MSG_OPTION_SYMBOL，用于存储 WebSocket 消息选项。
+     * 这个属性是只读的，并且所有选项都是必需的，因为它们在 WebSocket 通信中是必需的。
+     * 这个属性在构造函数中被初始化，并且在整个类的生命周期中保持不变。
+     */
+    private readonly [WS_MSG_OPTION_SYMBOL];
+    /**
+     * 私有只读属性，用于存储 WebSocket 构造函数的参数。
+     * 这个属性是在构造函数中初始化的，并且在整个类的生命周期中保持不变。
+     * 它的类型是 ConstructorParameters<typeof WebSocket>，表示 WebSocket 构造函数的参数类型。
+     */
+    private readonly [WS_PARAMS];
+    /**
+     * 私有只读属性，用于存储 WebSocket 事件发射器。
+     * 这个属性是在构造函数中初始化的，并且在整个类的生命周期中保持不变。
+     * 它的类型是 mitt.Emitter，是 mitt 库提供的事件发射器。
+     */
+    private readonly [WS_EVENTS];
+    /**
+     * 私有只读属性，用于存储 WebSocket 打开事件的处理函数。
+     * 这个属性是在构造函数中初始化的，并且在整个类的生命周期中保持不变。
+     * 它是一个箭头函数，当 WebSocket 连接成功打开时被调用。
+     */
+    private readonly [WS_ON_OPEN];
+    /**
+     * 私有属性，用于存储重连定时器的ID。
+     * 这个属性是可选的，因为重连定时器可能在某些情况下不存在。
+     */
+    private [RECONNECT_TIMER]?;
+    /**
+     * 私有只读属性，用于存储 WebSocket 关闭事件的处理函数。
+     * 这个属性是在构造函数中初始化的，并且在整个类的生命周期中保持不变。
+     * 它是一个箭头函数，当 WebSocket 连接关闭时被调用。
+     */
+    private readonly [WS_ON_CLOSE];
+    /**
+     * 私有只读属性，用于存储 WebSocket 消息事件的处理函数。
+     * 这个属性是在构造函数中初始化的，并且在整个类的生命周期中保持不变。
+     * 它是一个箭头函数，当 WebSocket 接收到消息时被调用。
+     *
+     * @param event - 接收到的消息事件对象。
+     */
+    private readonly [WS_ON_MESSAGE];
+    /**
+     * 私有方法，用于创建 WebSocket 连接。
+     * 这个方法会初始化一个新的 WebSocket 实例，并添加事件监听器来处理打开、消息和关闭事件。
+     */
+    private [WS_CREATE];
+    /**
+     * 私有方法，用于移除 WebSocket 实例并清理相关资源。
+     * 这个方法会关闭 WebSocket 连接，清除所有事件监听器，
+     * 并重置内部状态，确保 WebSocketManager 实例不再与任何 WebSocket 连接关联。
+     */
+    private [WS_REMOVE];
+    /**
+     * 私有方法，用于销毁 WebSocketManager 实例。
+     * 这个方法会关闭 WebSocket 连接，清除所有事件监听器，
+     * 并重置内部状态，确保 WebSocketManager 实例不再可用。
+     */
+    private [WS_DESTROY];
+    /**
+     * 构造函数，用于初始化 WebSocketManager 实例。
+     *
+     * @param option - 包含 WebSocket 消息选项和 WebSocket 构造函数参数的对象。
+     * @param option.msgOpt - 可选的 WebSocket 消息选项。
+     * @param option.wsOpts - WebSocket 构造函数的参数。
+     */
+    constructor(option: {
+        msgOpt?: WebSocketMessageOption;
+        wsOpts: ConstructorParameters<typeof WebSocket>;
+    });
+}
+export {};

package/src/webUtils/index.d.ts

@@ -0,0 +1,2 @@
+export * from './WebSocketManager';
+export * from './useNavStore';

package/src/webUtils/useNavStore.d.ts

@@ -0,0 +1,261 @@
+import { RouteComponent, RouteLocationNormalizedLoaded, Router } from 'vue-router';
+import { WithPrototype, KeyValType } from '../utils';
+/**
+ * 定义导航类型的枚举。
+ * 该枚举用于表示不同类型的导航项，如目录、菜单和按钮。
+ * @enum {number}
+ */
+export declare enum ZNavTypeEnum {
+    /**
+     * 表示导航项是一个目录。
+     */
+    DIR = 1,
+    /**
+     * 表示导航项是一个菜单。
+     */
+    MENU = 2,
+    /**
+     * 表示导航项是一个按钮。
+     */
+    BUTTON = 3
+}
+/**
+ * 基础导航类，继承自 WithPrototype。
+ * 该类定义了导航项的基本属性，如 ID、标题、图标和父级 ID。
+ * @class
+ * @extends WithPrototype
+ */
+export declare class ZBaseNav extends WithPrototype {
+    /**
+     * 导航项的唯一标识符。
+     * @type {KeyValType}
+     */
+    id: KeyValType;
+    /**
+     * 导航项的标题。
+     * @type {string}
+     */
+    title: string;
+    /**
+     * 导航项的图标（可选）。
+     * @type {string}
+     */
+    icon?: string;
+    /**
+     * 导航项的父级 ID（可选）。
+     * @type {null | KeyValType}
+     */
+    parentId?: null | KeyValType;
+}
+/**
+ * 表示导航目录的类，继承自 ZBaseNav。
+ * 该类定义了导航目录的特定属性，如排序号和子导航项。
+ * @class
+ * @extends ZBaseNav
+ */
+export declare class ZNavDir extends ZBaseNav {
+    /**
+     * 导航目录的类型，固定为 ZNavTypeEnum.DIR。
+     * @readonly
+     * @type {ZNavTypeEnum.DIR}
+     */
+    readonly type: ZNavTypeEnum.DIR;
+    /**
+     * 导航目录的排序号。
+     * @type {number}
+     */
+    orderNo: number;
+    /**
+     * 导航目录的子导航项数组。
+     * 子导航项可以是导航目录、导航菜单或导航链接。
+     * @type {(this | ZNavMenu | ZNavLink)[]}
+     */
+    children: (this | ZNavMenu | ZNavLink)[];
+}
+/**
+ * 表示导航菜单的基类，继承自 ZBaseNav。
+ * 该类定义了导航菜单的特定属性，如排序号。
+ * @class
+ * @extends ZBaseNav
+ */
+export declare class ZBaseNavMenu extends ZBaseNav {
+    /**
+     * 导航菜单的类型，固定为 ZNavTypeEnum.MENU。
+     * @readonly
+     * @type {ZNavTypeEnum.MENU}
+     */
+    readonly type: ZNavTypeEnum.MENU;
+    /**
+     * 导航菜单的排序号（可选）。
+     * @type {number}
+     */
+    orderNo: number;
+}
+/**
+ * 表示导航菜单的类，继承自 ZBaseNavMenu。
+ * 该类定义了导航菜单的特定属性，如名称、路径、是否固定、是否隐藏和是否保持激活状态。
+ * @class
+ * @extends ZBaseNavMenu
+ */
+export declare class ZNavMenu extends ZBaseNavMenu {
+    /**
+     * 导航菜单的名称。
+     * @type {string}
+     */
+    name: string;
+    /**
+     * 导航菜单的路径。
+     * @type {string}
+     */
+    path: string;
+    /**
+     * 导航菜单是否固定在页面上。
+     * @type {boolean}
+     */
+    isAffix: boolean;
+    /**
+     * 导航菜单是否隐藏。
+     * @type {boolean}
+     */
+    isHide: boolean;
+    /**
+     * 导航菜单是否保持激活状态。
+     * @type {boolean}
+     */
+    isKeepAlive: boolean;
+    /**
+     * 声明一个名为 `outLink` 的属性，其类型为 `never`。
+     * `never` 类型表示该属性永远不会被赋值，通常用于表示一个不可能存在的值。
+     * 在这个上下文中，`outLink` 可能是一个导航链接的外部链接，但由于某种原因，它被声明为 `never`，
+     * 这意味着在当前的设计中，导航菜单不应该有外部链接。
+     * @type {never}
+     */
+    outLink: never;
+}
+/**
+ * 表示导航链接的类，继承自 ZBaseNavMenu。
+ * 该类定义了导航链接的特定属性，如名称和外部链接。
+ * @class
+ * @extends ZBaseNavMenu
+ */
+export declare class ZNavLink extends ZBaseNavMenu {
+    /**
+     * 导航链接的外部链接。
+     * @type {string}
+     */
+    outLink: string;
+    /**
+     * 声明一个名为 `name` 的属性，其类型为 `never`。
+     * `never` 类型表示该属性永远不会被赋值，通常用于表示一个不可能存在的值。
+     * 在这个上下文中，`name` 可能是一个导航链接的名称，但由于某种原因，它被声明为 `never`，
+     * 这意味着在当前的设计中，导航链接不应该有名称。
+     * @type {never}
+     */
+    name: never;
+}
+/**
+ * 定义HTTP请求方法的枚举。
+ * 该枚举用于表示不同类型的HTTP请求方法，如GET、POST、PUT和DELETE。
+ * @enum {string}
+ */
+export declare enum HttpRequestMethodEnum {
+    /**
+     * 表示HTTP GET请求方法。
+     */
+    GET = "GET",
+    /**
+     * 表示HTTP POST请求方法。
+     */
+    POST = "POST",
+    /**
+     * 表示HTTP PUT请求方法。
+     */
+    PUT = "PUT",
+    /**
+     * 表示HTTP DELETE请求方法。
+     */
+    DELETE = "DELETE"
+}
+/**
+ * 表示导航按钮的类，继承自 ZBaseNav。
+ * 该类定义了导航按钮的特定属性，如名称、权限和父级 ID。
+ * @class
+ * @extends ZBaseNav
+ */
+export declare class ZNavButton extends ZBaseNav {
+    /**
+     * 导航按钮的类型，固定为 ZNavTypeEnum.BUTTON。
+     * @readonly
+     * @type {ZNavTypeEnum.BUTTON}
+     */
+    readonly type: ZNavTypeEnum.BUTTON;
+    /**
+     * 导航按钮的名称。
+     * @type {string}
+     */
+    name: string;
+    /**
+     * 导航按钮的权限字符串，格式为 `${HttpRequestMethodEnum}:${string}`。
+     * 例如：'GET:/api/users' 表示该按钮需要 GET 请求权限才能访问 /api/users 路径。
+     * @type {`${HttpRequestMethodEnum}:${string}`}
+     */
+    permission: `${HttpRequestMethodEnum}:${string}`;
+    /**
+     * 导航按钮的父级 ID。
+     * @type {KeyValType}
+     */
+    parentId: KeyValType;
+}
+/**
+ * 定义一个类型别名 `ZNav`，它可以是 `ZNavDir`、`ZNavMenu`、`ZNavLink` 或 `ZNavButton` 中的任意一种。
+ * 这个类型别名用于表示导航项的通用类型，使得在处理导航项时可以使用统一的类型。
+ * @typedef {ZNavDir | ZNavMenu | ZNavLink | ZNavButton} ZNav
+ */
+export type ZNav = ZNavDir | ZNavMenu | ZNavLink | ZNavButton;
+/**
+ * 定义一个泛型类型 `Lazy<T>`，它是一个函数类型，返回一个 `Promise<T>`。
+ * 这个类型通常用于表示懒加载的组件或模块，只有在需要时才会加载。
+ * @template T
+ * @typedef {() => Promise<T>} Lazy
+ */
+type Lazy<T> = () => Promise<T>;
+/**
+ * 定义一个类型别名 `RawRouteComponent`，它可以是 `RouteComponent` 类型或 `Lazy<RouteComponent>` 类型。
+ * `RouteComponent` 类型通常是一个组件，而 `Lazy<RouteComponent>` 类型是一个返回 `Promise<RouteComponent>` 的函数，用于懒加载组件。
+ * 这个类型别名用于表示路由组件的原始类型，使得在处理路由组件时可以使用统一的类型。
+ * @typedef {RouteComponent | Lazy<RouteComponent>} RawRouteComponent
+ */
+type RawRouteComponent = RouteComponent | Lazy<RouteComponent>;
+/**
+ * 定义一个类型别名 `PageViewMap`，它是一个记录类型，键为字符串，值为 `RawRouteComponent` 类型。
+ * `RawRouteComponent` 类型通常是一个返回 `Promise<unknown>` 的函数，用于表示路由组件的原始类型。
+ * 这个类型别名用于表示页面视图的映射，其中键是页面的路径，值是对应的路由组件。
+ * @typedef {Record<string, RawRouteComponent>} PageViewMap
+ */
+type PageViewMap = Record<string, RawRouteComponent>;
+/**
+ * 定义一个类型别名 `ZNavWithoutButton`，它是 `ZNav` 类型中排除 `ZNavButton` 类型后的结果。
+ * 这个类型别名用于表示不包含按钮的导航项，通常用于构建导航树或处理导航项的层级结构。
+ * @typedef {Exclude<ZNav, ZNavButton>} ZNavWithoutButton
+ */
+type ZNavWithoutButton = Exclude<ZNav, ZNavButton>;
+export declare const useNavStore: () => {
+    readonly ROOT_ROUTE_NAME: "ROOT_ROUTE";
+    readonly setNavs: (option: {
+        navs: ZNav[];
+        pageViewMap: PageViewMap;
+        pageViewPathIgnore?: RegExp;
+        RootPageView: RawRouteComponent;
+        NotFoundPageView?: RawRouteComponent;
+        router: Router;
+        route: RouteLocationNormalizedLoaded;
+    }) => void;
+    readonly clear: (option?: {
+        router: Router;
+        PageView: RawRouteComponent;
+        path: string;
+    }) => void;
+    readonly navTree: ZNavWithoutButton[];
+    readonly navChildrenMap: Record<KeyValType, ZNavWithoutButton[]>;
+};
+export {};