@gct-paas/core 0.1.6-dev.8 → 6.0.0-dev.1

package/es/modules/system-mqtt/system-mqtt.service.d.ts

@@ -0,0 +1,104 @@
+import { MqttCancelSub, IMqttClient } from '../mqtt';
+import { IInternalMessagePayload, IKickOutPayload, IToDoMessagePayload, MqttSubCallback } from './system-mqtt.interface';
+/**
+ * 系统级 MQTT 业务
+ *
+ * @export
+ * @class SystemMqttService
+ */
+export declare class SystemMqttService {
+    private static isInitialized;
+    protected static client: IMqttClient | undefined;
+    protected static fingerprint: string | undefined;
+    protected static readonly LOGOUT_CLIENT_TAG = "USER_LOGOUT";
+    /**
+     * 用户登出消息 topic
+     *
+     * @static
+     */
+    static readonly USER_LOGOUT_TOPIC = "users/logout/msg";
+    /**
+     * 踢出用户消息 topic
+     *
+     * @readonly
+     * @static
+     * @type {string}
+     */
+    static get KICK_OUT_TOPIC(): string;
+    /**
+     * 未读消息变化 topic
+     *
+     * @readonly
+     * @static
+     * @type {string}
+     */
+    static get INTERNAL_MESSAGE_TOPIC(): string;
+    /**
+     * 待办消息数量 topic
+     *
+     * @readonly
+     * @static
+     * @type {string}
+     */
+    static get TASK_TODO_COUNT_TOPIC(): string;
+    /**
+     * 强制刷新并清空缓存 topic
+     *
+     * @static
+     */
+    static readonly CLEAN_CACHE_TOPIC = "CLEAN_CACHE";
+    /**
+     * 初始化系统级 MQTT 客户端，需要在用户信息以及应用信息加载完成后调用
+     *
+     * @static
+     * @return {*}  {Promise<void>}
+     */
+    static init(): Promise<void>;
+    protected static createMqtt(): Promise<void>;
+    protected static subs(): void;
+    /**
+     * 订阅系统级 MQTT 消息
+     *
+     * @static
+     * @param {string} topic
+     */
+    protected static subscribe<T = IObject>(topic: string, callback: MqttSubCallback<T>): MqttCancelSub;
+    /**
+     * 订阅用户被踢出消息
+     *
+     * @static
+     * @param {MqttSubCallback<IKickOutPayload>} callback
+     * @return {*}  {MqttCancelSub}
+     */
+    protected static subKickOut(callback?: MqttSubCallback<IKickOutPayload>): MqttCancelSub;
+    /**
+     * 订阅未读消息变化
+     *
+     * @static
+     * @param {MqttSubCallback<IInternalMessagePayload>} callback
+     * @return {*}  {MqttCancelSub}
+     */
+    static subInternalMessage(callback: MqttSubCallback<IInternalMessagePayload>): MqttCancelSub;
+    /**
+     * 订阅待办消息数量变化
+     *
+     * @static
+     * @param {MqttSubCallback<IToDoMessagePayload>} callback
+     * @return {*}  {MqttCancelSub}
+     */
+    static subTaskTodoCount(callback: MqttSubCallback<IToDoMessagePayload>): MqttCancelSub;
+    /**
+     * 强制用户界面刷新
+     *
+     * @static
+     * @param {MqttSubCallback<void>} callback
+     * @return {*}  {MqttCancelSub}
+     */
+    static subCleanCache(): MqttCancelSub;
+    /**
+     * 发送用户登出消息
+     *
+     * @static
+     */
+    static pubLogout(): void;
+}

package/es/modules/system-mqtt/system-mqtt.service.mjs

@@ -0,0 +1,199 @@
+import { ProjectNameType } from "../../enums/globalEnum.mjs";
+import "../../enums/index.mjs";
+import { getTenant, getToken } from "../../utils/tools/tools.mjs";
+import { AuthUtil } from "../../utils/auth-util/auth-util.mjs";
+import { t } from "../../utils/i18n/index.mjs";
+import { getBrowserFingerprint, getPageIdentification } from "../../utils/deviceFingerprint.mjs";
+import "../../utils/index.mjs";
+import "../mqtt/index.mjs";
+//#region src/modules/system-mqtt/system-mqtt.service.ts
+/**
+* 系统级 MQTT 业务
+*
+* @export
+* @class SystemMqttService
+*/
+var SystemMqttService = class {
+	static isInitialized = false;
+	static client;
+	static fingerprint;
+	static LOGOUT_CLIENT_TAG = "USER_LOGOUT";
+	/**
+	* 用户登出消息 topic
+	*
+	* @static
+	*/
+	static USER_LOGOUT_TOPIC = `users/logout/msg`;
+	/**
+	* 踢出用户消息 topic
+	*
+	* @readonly
+	* @static
+	* @type {string}
+	*/
+	static get KICK_OUT_TOPIC() {
+		return `USER/${_gct.store.userInfo.userId}/KICK_OUT`;
+	}
+	/**
+	* 未读消息变化 topic
+	*
+	* @readonly
+	* @static
+	* @type {string}
+	*/
+	static get INTERNAL_MESSAGE_TOPIC() {
+		return `${_gct.env.getEnv().toUpperCase()}/USER/${getTenant()}/${_gct.store.userInfo.userId}/INTERNAL_MESSAGE`;
+	}
+	/**
+	* 待办消息数量 topic
+	*
+	* @readonly
+	* @static
+	* @type {string}
+	*/
+	static get TASK_TODO_COUNT_TOPIC() {
+		return `${_gct.env.getEnv().toUpperCase()}/USER/${getTenant()}/${_gct.store.userInfo.userId}/TASK_TODO_COUNT`;
+	}
+	/**
+	* 强制刷新并清空缓存 topic
+	*
+	* @static
+	*/
+	static CLEAN_CACHE_TOPIC = "CLEAN_CACHE";
+	/**
+	* 初始化系统级 MQTT 客户端，需要在用户信息以及应用信息加载完成后调用
+	*
+	* @static
+	* @return {*}  {Promise<void>}
+	*/
+	static async init() {
+		if (this.isInitialized) {
+			console.warn("SystemMqttService 已经初始化，请勿重复调用 init 方法");
+			return;
+		}
+		this.isInitialized = true;
+		this.fingerprint = await getBrowserFingerprint();
+		await this.createMqtt();
+		this.subs();
+	}
+	static async createMqtt() {
+		const willDelayInterval = 20;
+		const userInfo = _gct.store.userInfo;
+		const mqttProperties = userInfo.mqttProperties || {};
+		this.client = _gct.mqtt.create(this.LOGOUT_CLIENT_TAG, {
+			...mqttProperties,
+			clientId: "logout" + this.fingerprint + getPageIdentification(),
+			protocolVersion: 5,
+			clean: false,
+			will: {
+				topic: this.USER_LOGOUT_TOPIC,
+				payload: JSON.stringify({
+					appId: _gct.store.appInfo.id,
+					ipAddress: userInfo.ip,
+					signLog: `${userInfo.userId}.${_gct.env.getEnv()}.${this.fingerprint}.${ProjectNameType[_gct.store.projectName]}.web.${getPageIdentification()}`,
+					tenantId: getTenant()
+				}),
+				qos: 1,
+				retain: true,
+				properties: {
+					willDelayInterval,
+					messageExpiryInterval: willDelayInterval * 10
+				}
+			},
+			properties: { sessionExpiryInterval: willDelayInterval * 2 }
+		});
+	}
+	static subs() {
+		this.subCleanCache();
+		this.subKickOut();
+	}
+	/**
+	* 订阅系统级 MQTT 消息
+	*
+	* @static
+	* @param {string} topic
+	*/
+	static subscribe(topic, callback) {
+		if (!this.client) throw new Error("MQTT client is not initialized");
+		return this.client.subscribe(topic, (_topic, payload) => {
+			try {
+				const payloadStr = payload.toString();
+				callback(JSON.parse(payloadStr));
+			} catch (error) {
+				console.error("解析 MQTT 消息 payload 失败:", error);
+			}
+		});
+	}
+	/**
+	* 订阅用户被踢出消息
+	*
+	* @static
+	* @param {MqttSubCallback<IKickOutPayload>} callback
+	* @return {*}  {MqttCancelSub}
+	*/
+	static subKickOut(callback) {
+		return this.subscribe(this.KICK_OUT_TOPIC, (data) => {
+			const token = getToken();
+			if (token && token === data?.token) {
+				_gct.confirm.warning({
+					title: t("sys.loginWarning"),
+					content: t("sys.loginWarningContent"),
+					okText: t("sys.understood")
+				}).then(() => {
+					AuthUtil.getInstance().clearAuthAndGoLogin();
+				});
+				callback?.(data);
+			}
+		});
+	}
+	/**
+	* 订阅未读消息变化
+	*
+	* @static
+	* @param {MqttSubCallback<IInternalMessagePayload>} callback
+	* @return {*}  {MqttCancelSub}
+	*/
+	static subInternalMessage(callback) {
+		return this.subscribe(this.INTERNAL_MESSAGE_TOPIC, callback);
+	}
+	/**
+	* 订阅待办消息数量变化
+	*
+	* @static
+	* @param {MqttSubCallback<IToDoMessagePayload>} callback
+	* @return {*}  {MqttCancelSub}
+	*/
+	static subTaskTodoCount(callback) {
+		return this.subscribe(this.TASK_TODO_COUNT_TOPIC, callback);
+	}
+	/**
+	* 强制用户界面刷新
+	*
+	* @static
+	* @param {MqttSubCallback<void>} callback
+	* @return {*}  {MqttCancelSub}
+	*/
+	static subCleanCache() {
+		return this.subscribe(this.CLEAN_CACHE_TOPIC, () => {
+			const url = new URL(window.location.href);
+			url.searchParams.set("reloadTime", Date.now().toString());
+			window.location.replace(url.toString());
+			location.reload();
+		});
+	}
+	/**
+	* 发送用户登出消息
+	*
+	* @static
+	*/
+	static pubLogout() {
+		this.client?.publish(this.USER_LOGOUT_TOPIC, JSON.stringify({
+			appId: _gct.store.appInfo.id,
+			ipAddress: _gct.store.userInfo.ip,
+			signLog: `${_gct.store.userInfo.userId}.${_gct.env.getEnv()}.${this.fingerprint}.${ProjectNameType[_gct.store.projectName]}.web.${getPageIdentification()}`,
+			tenantId: getTenant()
+		}));
+	}
+};
+//#endregion
+export { SystemMqttService };

package/es/modules/user-stores/store/permission.store.d.ts

@@ -16,6 +16,7 @@ export declare const usePermissionStore: import('pinia').StoreDefinition<"permis
         };
     }>): boolean;
 }, {
+    initPremission(): Promise<void>;
     getPermissionByKey(pageId: string, key?: string): boolean;
     initPermission(): Promise<void>;
 }>;

package/es/modules/user-stores/store/permission.store.mjs

@@ -9,6 +9,16 @@ var usePermissionStore = defineStore("permission", {
 		return !!state.userPermissions.appSuperAdmin || !!state.userPermissions.permissions["POINT.*"];
 	} },
 	actions: {
+		async initPremission() {
+			const res = await _api.apaas.designerCommon.getUserInfo();
+			Object.assign(this.userPermissions, {
+				...res,
+				permissions: res?.permissions ? res?.permissions.reduce((map, item) => {
+					map[item] = true;
+					return map;
+				}, {}) : {}
+			});
+		},
 		getPermissionByKey(pageId, key) {
 			if (this.hasAllPermissions) return true;
 			if (!key) return this.userPermissions.permissions[pageId];

package/es/modules/user-stores/store/user.store.mjs

@@ -1,4 +1,4 @@
-import { getToken, setToken, tenantRef } from "../../../utils/tools/tools.mjs";
+import { getToken, setTenant, setToken, tenantRef } from "../../../utils/tools/tools.mjs";
 import { sha256 } from "../../../utils/uuid/uuid.mjs";
 import { getDeviceFingerprint, getPageIdentification } from "../../../utils/deviceFingerprint.mjs";
 import "../../../utils/index.mjs";
@@ -63,7 +63,8 @@ var useUserStore = defineStore("user", {
 		*/
 		async appLoginOut() {
 			setToken();
-			this.setUserInfo({});
+			setTenant();
+			await this.setUserInfo({});
 		},
 		async setUserInfo(info) {
 			this.userInfo = {
@@ -103,6 +104,7 @@ async function loginApi(params, { hasError = true } = {}) {
 * 登出
 */
 async function doLogout() {
+	if (!getToken()) return;
 	const session = sessionStorage.getItem("currentPlatOrAppId");
 	const env = _gct.env.getEnv();
 	const fingerprint = await getDeviceFingerprint();

package/es/router/guard/index.d.ts

@@ -0,0 +1,4 @@
+import { Router } from 'vue-router';
+export declare function createPageLoadingGuard(router: Router): void;
+export declare function createProgressGuard(router: Router): void;
+export declare function createGuard(router: Router): void;

package/es/router/guard/index.mjs

@@ -0,0 +1,41 @@
+import { getToken } from "../../utils/tools/tools.mjs";
+import "../../utils/index.mjs";
+import { usePlatformConfigStore } from "../../modules/platform-config/store.mjs";
+import "../../modules/platform-config/index.mjs";
+import nProgress from "nprogress";
+//#region src/router/guard/index.ts
+function createPageLoadingGuard(router) {
+	const platformStore = usePlatformConfigStore();
+	router.beforeEach(async (to) => {
+		if (!getToken() || to.meta.loaded) return true;
+		if (platformStore.themeSetting.pageLoading == true) {
+			_gct.store.setPageLoading(true);
+			return true;
+		}
+		return true;
+	});
+	router.afterEach(async () => {
+		setTimeout(() => {
+			_gct.store.setPageLoading(false);
+		}, 220);
+		return true;
+	});
+}
+function createProgressGuard(router) {
+	const platformStore = usePlatformConfigStore();
+	router.beforeEach(async (to) => {
+		if (to.meta.loaded) return true;
+		if (platformStore.themeSetting.pageProgress == true) nProgress.start();
+		return true;
+	});
+	router.afterEach(async () => {
+		nProgress.done();
+		return true;
+	});
+}
+function createGuard(router) {
+	createPageLoadingGuard(router);
+	createProgressGuard(router);
+}
+//#endregion
+export { createGuard };

package/es/router/index.mjs

@@ -1,3 +1,4 @@
+import { createGuard } from "./guard/index.mjs";
 import "vue";
 import { createRouter, createWebHashHistory } from "vue-router";
 //#region src/router/index.ts
@@ -9,6 +10,7 @@ var RouterUtil = class {
 			history: createWebHashHistory(),
 			routes
 		});
+		createGuard(this.router);
 	}
 	/**
 	* 添加路由

package/es/setup-app.mjs

@@ -1,10 +1,8 @@
-import { getToken } from "./utils/tools/tools.mjs";
 import { interceptors } from "./utils/axios/interceptors.mjs";
 import "./utils/index.mjs";
 import { usePlatformConfigStore } from "./modules/platform-config/store.mjs";
 import "./modules/platform-config/index.mjs";
-import { useUserStore } from "./modules/user-stores/store/user.store.mjs";
-import "./modules/user-stores/index.mjs";
+import { registerCoreLocale } from "./locale/auto-register.mjs";
 import { HttpUtil } from "@gct-paas/api";
 //#region src/setup-app.ts
 /**
@@ -16,13 +14,8 @@ import { HttpUtil } from "@gct-paas/api";
 async function setupApp(_app) {
 	HttpUtil.use(interceptors);
 	await _gct.init();
+	registerCoreLocale();
 	await usePlatformConfigStore().init();
-	const token = getToken();
-	if (token) try {
-		await useUserStore().getUserInfoAction(token);
-	} catch (error) {
-		console.error("获取用户信息失败", error);
-	}
 }
 //#endregion
 export { setupApp };

package/es/state/global-pinia-state/global-pinia-state.d.ts

@@ -17,6 +17,12 @@ export declare class GlobalPiniaState implements IGlobalState {
         /**运行时空值显示 */
         emptyDisplay: emptyDisplayType;
     };
+    /**
+     * 是否出发路由全局设置中开启的 loading
+     *
+     * @type {boolean}
+     */
+    pageLoading: boolean;
     /**
      * 应用信息
      *

package/es/state/global-pinia-state/global-pinia-state.mjs

@@ -23,6 +23,12 @@ var GlobalPiniaState = class {
 	globalSetting = { 
 	/**运行时空值显示 */
 emptyDisplay: "--" };
+	/**
+	* 是否出发路由全局设置中开启的 loading
+	*
+	* @type {boolean}
+	*/
+	pageLoading = false;
 	/**
 	* 应用信息
 	*

package/es/store/global-store.mjs

@@ -4,6 +4,7 @@ import { GlobalPiniaState } from "../state/global-pinia-state/global-pinia-state
 import "../state/index.mjs";
 import { parseMatrixParams } from "../utils/tools/tools.mjs";
 import "../utils/index.mjs";
+import { normalizeEnv } from "../modules/env-manager/env-manager.util.mjs";
 import { defineStore } from "pinia";
 //#region src/store/global-store.ts
 var useGlobalStore = defineStore("global-store", {
@@ -19,6 +20,9 @@ var useGlobalStore = defineStore("global-store", {
 		},
 		getEmptyDisplay() {
 			return nullDisplayEnum[this.globalSetting.emptyDisplay];
+		},
+		getPageLoading() {
+			return this.pageLoading;
 		}
 	},
 	actions: {
@@ -32,8 +36,9 @@ var useGlobalStore = defineStore("global-store", {
 			const paramStr = location.pathname.split("/")[2];
 			if (paramStr) {
 				const params = parseMatrixParams(paramStr);
-				if (params) this.context = params;
+				if (params && Object.keys(params).length) Object.assign(this.context, params);
 			}
+			this.context.env = normalizeEnv(this.context.env);
 		},
 		async loadAppInfo() {
 			const res = await _api.apaas.designerCommon.getGetApp();
@@ -47,6 +52,15 @@ var useGlobalStore = defineStore("global-store", {
 		},
 		setProjectName(name) {
 			this.projectName = name;
+		},
+		setPageLoading(loading) {
+			this.pageLoading = loading;
+		},
+		updateUserInfo(data) {
+			this.userInfo = {
+				...this.userInfo,
+				...data
+			};
 		}
 	}
 });

package/es/types/index.d.ts

@@ -2,6 +2,7 @@
 import '@gct-paas/api/global-type';
 import 'systemjs';
 import 'vite/types/importMeta.d.ts';
+import type { Composer } from 'vue-i18n';
 import type { GctGlobal } from '../global';
 import type { ApiManage as APaasApiManage } from '@gct-paas/api/apaas';
 import type { ApiManage as PlatformApiManage } from '@gct-paas/api/platform';
@@ -49,6 +50,12 @@ declare global {
      * @type {GlobalApi}
      */
     _api: GlobalApi;
+    /**
+     * 多语言转换函数
+     *
+     * @type {Composer['t']}
+     */
+    $t: Composer['t'];
     /**
      * wujie 微前端对象，当作为微前端子应用运行时可用
      *

package/es/utils/auth-util/auth-util.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 认证工具类
+ *
+ * @export
+ * @class AuthUtil
+ */
+export declare class AuthUtil {
+    private static instance;
+    private constructor();
+    /**
+     * 加载用户信息
+     *
+     * @description 现阶段的认证在 paas-front 系统中登录，此处直接获取 token 并加载用户信息，无认证信息或者登录过期直接跳转到登录页
+     * @return {*}  {Promise<void>}
+     */
+    loadUser(): Promise<void>;
+    logout(goLogin?: boolean): Promise<void>;
+    /**
+     * 清除认证信息并跳转到登录页
+     *
+     * @return {*}  {Promise<void>}
+     */
+    clearAuthAndGoLogin(): Promise<void>;
+    /**
+     * 跳转到首页
+     *
+     * @return {*}  {Promise<void>}
+     */
+    goHome(): Promise<void>;
+    /**
+     * 跳转到租户选择页
+     *
+     * @return {*}  {Promise<void>}
+     */
+    goTenantSelect(): Promise<void>;
+    static getInstance(): AuthUtil;
+}

package/es/utils/auth-util/auth-util.mjs

@@ -0,0 +1,79 @@
+import { useUserStore } from "../../modules/user-stores/store/user.store.mjs";
+import "../../modules/user-stores/index.mjs";
+import { getToken, setTenant, setToken } from "../tools/tools.mjs";
+//#region src/utils/auth-util/auth-util.ts
+/**
+* 认证工具类
+*
+* @export
+* @class AuthUtil
+*/
+var AuthUtil = class AuthUtil {
+	static instance;
+	constructor() {}
+	/**
+	* 加载用户信息
+	*
+	* @description 现阶段的认证在 paas-front 系统中登录，此处直接获取 token 并加载用户信息，无认证信息或者登录过期直接跳转到登录页
+	* @return {*}  {Promise<void>}
+	*/
+	async loadUser() {
+		const token = getToken();
+		if (token) try {
+			await useUserStore().getUserInfoAction(token);
+		} catch (error) {
+			console.error("获取用户信息失败", error);
+		}
+	}
+	async logout(goLogin) {
+		await useUserStore().submitLoginOut();
+		if (goLogin) {
+			const url = new URL(`${location.origin}/paas-front/portal`);
+			if (_gct.env.isSandbox || _gct.env.isAppSingle) {
+				if (_gct.store.context.aid) url.searchParams.set("aid", _gct.store.context.aid);
+				url.searchParams.set("env", _gct.env.getEnv());
+				if (_gct.env.isAppSingle) url.searchParams.set("mode", "single");
+			}
+			url.hash = `/login`;
+			window.location.href = url.toString();
+		}
+	}
+	/**
+	* 清除认证信息并跳转到登录页
+	*
+	* @return {*}  {Promise<void>}
+	*/
+	async clearAuthAndGoLogin() {
+		setToken();
+		setTenant();
+		const url = new URL(`${location.origin}/paas-front/portal`);
+		url.hash = `/login`;
+		window.location.href = url.toString();
+	}
+	/**
+	* 跳转到首页
+	*
+	* @return {*}  {Promise<void>}
+	*/
+	async goHome() {
+		const url = new URL(`${location.origin}/paas-front/portal`);
+		url.hash = `/home`;
+		window.location.href = url.toString();
+	}
+	/**
+	* 跳转到租户选择页
+	*
+	* @return {*}  {Promise<void>}
+	*/
+	async goTenantSelect() {
+		const url = new URL(`${location.origin}/paas-front/portal`);
+		url.hash = `/tenant`;
+		window.location.href = url.toString();
+	}
+	static getInstance() {
+		if (!AuthUtil.instance) AuthUtil.instance = new AuthUtil();
+		return AuthUtil.instance;
+	}
+};
+//#endregion
+export { AuthUtil };

package/es/utils/axios/check-status.d.ts

@@ -0,0 +1 @@
+export declare function checkStatus(status: number, msg: string, errorMessageMode?: string): void;