@gct-paas/core 0.1.4-dev.1 → 0.1.4-dev.10

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

@@ -1,5 +1,6 @@
 import { StateTree } from 'pinia';
 import { ProjectName } from '../../enums';
+import { IAppContext } from '../i-app-context/i-app-context';
 /**
  * 全局 store 状态
  *
@@ -7,6 +8,12 @@ import { ProjectName } from '../../enums';
  * @interface IGlobalState
  */
 export interface IGlobalState extends StateTree {
+    /**
+     * 应用上下文
+     *
+     * @type {IAppContext}
+     */
+    context: IAppContext;
     /**
      * 项目名称
      *
@@ -18,14 +25,12 @@ export interface IGlobalState extends StateTree {
      *
      * @type {string}
      */
-    tenantId: string;
     /**
      * 多语言环境
      *
      * @default zh-CN
      * @type {string}
      */
-    lang: string;
     /**
      * 应用信息, todo: 等 api 包完成后，实际类型从 api 导入
      *

package/es/interface/index.d.ts

@@ -1,19 +1,18 @@
 export type * from './controller';
 export type * from './events';
 export type * from './form';
-export type * from './hooks';
+export type * from './i-app-context/i-app-context';
 export type { IDictionary } from './i-dictionary/i-dictionary';
 export type { IDictionaryItem } from './i-dictionary/i-dictionary-item';
-export type { IHttpResponse } from './i-http-response/i-http-response';
-export type { IMessageParams, IMessageUtil, } from './i-message-util/i-message-util';
-export type { IModal } from './i-modal/i-modal';
-export type { IModalData } from './i-modal-data/i-modal-data';
+export type { IFieldCodeChain } from './i-field-code-chain/i-field-code-chain';
+export type { GlobalVar } from './i-global-var/i-global-var';
+export type { IMobileHomeMenuItem } from './i-mobile-home-menu-item/i-mobile-home-menu-item';
 export type { IStyleIMportMap } from './i-import-style-map/i-import-style-map';
 export type { IGlobalActions } from './i-pinia-action/i-global-actions';
 export type { IGlobalGetters } from './i-pinia-getter/i-global-getters';
 export type { IGlobalState } from './i-pinia-state/i-global-state';
+export type * from './open-util';
 export type * from './layout';
-export type * from './low-code-types';
 export type * from './provider';
 export type * from './state';
 export type * from './style';

package/es/interface/open-util/i-message-util/i-message-util.d.ts

@@ -0,0 +1,54 @@
+/**
+ * 消息参数
+ *
+ * @export
+ * @interface IMessageParams
+ */
+export interface IMessageParams {
+    /**
+     * 持续时间，单位：秒，默认：1.5
+     *
+     * @type {number}
+     */
+    duration?: number;
+}
+/**
+ * 顶部居中显示，并自动消失
+ *
+ * @export
+ * @interface IMessageUtil
+ */
+export interface IMessageUtil {
+    /**
+     * 普通消息
+     *
+     * @param {string} msg
+     * @param {IMessageParams} [params]
+     * @return {*}  {Promise<void>}
+     */
+    info(msg: string, params?: IMessageParams): Promise<void>;
+    /**
+     * 成功消息
+     *
+     * @param {string} msg
+     * @param {IMessageParams} [params]
+     * @return {*}  {Promise<void>}
+     */
+    success(msg: string, params?: IMessageParams): Promise<void>;
+    /**
+     * 警告消息
+     *
+     * @param {string} msg
+     * @param {IMessageParams} [params]
+     * @return {*}  {Promise<void>}
+     */
+    warning(msg: string, params?: IMessageParams): Promise<void>;
+    /**
+     * 错误消息
+     *
+     * @param {string} msg
+     * @param {IMessageParams} [params]
+     * @return {*}  {Promise<void>}
+     */
+    error(msg: string, params?: IMessageParams): Promise<void>;
+}

package/es/interface/{i-modal → open-util/i-modal}/i-modal.d.ts

@@ -1,6 +1,6 @@
 import { AsyncSeriesHook } from 'qx-util';
 import { IModalData } from '../i-modal-data/i-modal-data';
-interface ModalHooks {
+export interface IModalHooks {
     shouldDismiss: AsyncSeriesHook<[
     ], {
         allowClose?: boolean;
@@ -29,22 +29,22 @@ export interface IModal {
      *
      * @author zhanghanrui
      * @date 2024-03-19 21:03:55
-     * @type {ModalHooks}
+     * @type {IModalHooks}
      */
-    hooks: ModalHooks;
+    hooks: IModalHooks;
     /**
      * 统一关闭入口
      *
-     * @author zhanghanrui
-     * @date 2024-03-19 21:03:04
+     * @param {IModalData} [data]
+     * @return {*}  {Promise<boolean>}
      */
-    dismiss: (data?: IModalData) => Promise<boolean>;
+    dismiss(data?: IModalData): Promise<boolean>;
     /**
      * 设置模态框属性
-     * @param options
-     * @returns
+     *
+     * @param {object} options
      */
-    setOptions: (options: object) => void;
+    setOptions?(options: object): void;
     /**
      * 确认操作
      *
@@ -68,4 +68,3 @@ export interface IModal {
      */
     cancel?: () => Promise<boolean>;
 }
-export {};

package/es/interface/{i-modal-data → open-util/i-modal-data}/i-modal-data.d.ts

@@ -15,6 +15,12 @@ export interface IModalData {
      * @type {boolean}
      */
     ok: boolean;
+    /**
+     * 是否关闭模态窗(当 close 为 true 时，ok=false 也会关闭模态窗)
+     *
+     * @type {boolean}
+     */
+    close?: boolean;
     /**
      * 返回的数据
      *

package/es/interface/open-util/i-modal-options/i-modal-options.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 模态打开参数，此为具体端实现，具体扩充参数由各端定义
+ *
+ * @export
+ * @interface IModalOptions
+ */
+export interface IModalOptions {
+    [key: string]: any;
+    title?: string;
+    width?: string | number;
+    zIndex?: number;
+}

package/es/interface/open-util/i-open-window-options/i-open-window-options.d.ts

@@ -0,0 +1,59 @@
+/**
+ * openWindow 函数的配置选项接口
+ *
+ * @export
+ * @interface IOpenWindowOptions
+ */
+export interface IOpenWindowOptions {
+    /**
+     * 窗口打开方式
+     *
+     * @type {HTMLAnchorElement['target']}
+     * @memberof IOpenWindowOptions
+     * @default '_blank'
+     */
+    target?: HTMLAnchorElement['target'];
+    /**
+     * 是否启用 noopener 特性
+     * 防止新页面访问 window.opener
+     *
+     * @type {boolean}
+     * @memberof IOpenWindowOptions
+     * @default true
+     */
+    noopener?: boolean;
+    /**
+     * 是否启用 noreferrer 特性
+     * 防止新页面获取来源页面信息
+     *
+     * @type {boolean}
+     * @memberof IOpenWindowOptions
+     * @default true
+     */
+    noreferrer?: boolean;
+    /**
+     * URL 参数数据
+     * 用于替换 URL 中的占位符，格式如 /path/{id}/{name?}
+     *
+     * @type {IObject}
+     * @memberof IOpenWindowOptions
+     */
+    genUrlData?: IObject;
+    /**
+     * 路由路径
+     * 将附加到 URL 末尾
+     *
+     * @type {string}
+     * @memberof IOpenWindowOptions
+     * @default ''
+     */
+    routePath?: string;
+    /**
+     * 额外的 window.open 特性字符串
+     * 如: 'width=800,height=600'
+     *
+     * @type {string}
+     * @memberof IOpenWindowOptions
+     */
+    optionStr?: string;
+}

package/es/interface/open-util/i-overlay-container/i-overlay-container.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 全局呈现容器
+ *
+ * @author zhanghanrui
+ * @date 2024-03-19 18:03:21
+ * @export
+ * @interface IOverlayContainer
+ */
+export interface IOverlayContainer {
+    /**
+     * 展示容器
+     *
+     * @author zhanghanrui
+     * @date 2024-03-19 18:03:02
+     * @return {*}  {Promise<void>}
+     */
+    present(): Promise<void>;
+    /**
+     * 关闭容器
+     *
+     * @author zhanghanrui
+     * @date 2024-03-19 18:03:08
+     * @param {unknown} [data]
+     * @return {*}  {Promise<void>}
+     */
+    dismiss(data?: unknown): Promise<void>;
+    /**
+     * 等待容器关闭并返回返回值
+     *
+     * @author zhanghanrui
+     * @date 2024-03-19 18:03:12
+     * @template T
+     * @return {*}  {Promise<T>}
+     */
+    onWillDismiss<T = unknown>(): Promise<T>;
+}

package/es/interface/open-util/i-overlay-controller/i-overlay-controller.d.ts

@@ -0,0 +1,36 @@
+import { IOverlayContainer } from '../i-overlay-container/i-overlay-container';
+import { IModalOptions } from '../i-modal-options/i-modal-options';
+import { IModalData } from '../i-modal-data/i-modal-data';
+/**
+ * 全局呈现容器控制器
+ *
+ * @author zhanghanrui
+ * @date 2024-03-19 19:03:18
+ * @export
+ * @interface IOverlayController
+ */
+export interface IOverlayController {
+    /**
+     * 模态打开组件
+     *
+     * @author zhanghanrui
+     * @date 2024-03-19 19:03:42
+     * @template T
+     * @param {unknown} component 组件名称，组件对象，或者绘制函数
+     * @param {IParams} [props] 组件props
+     * @param {IModalOptions} [opts]
+     * @return {*}  {Promise<T>}
+     */
+    modal<T = IModalData>(component: unknown, props?: IParams, opts?: IModalOptions): Promise<T>;
+    /**
+     * 创建全局模态容器
+     *
+     * @author zhanghanrui
+     * @date 2024-03-19 19:03:04
+     * @param {unknown} component 组件名称，组件对象，或者绘制函数
+     * @param {IParams} [props] 组件props
+     * @param {IModalOptions} [opts]
+     * @return {*}  {IOverlayContainer}
+     */
+    createModal(component: unknown, props?: IParams, opts?: IModalOptions): IOverlayContainer;
+}

package/es/interface/open-util/index.d.ts

@@ -0,0 +1,7 @@
+export type { IMessageParams, IMessageUtil, } from './i-message-util/i-message-util';
+export type { IModal } from './i-modal/i-modal';
+export type { IModalData } from './i-modal-data/i-modal-data';
+export type { IModalOptions } from './i-modal-options/i-modal-options';
+export type { IOpenWindowOptions } from './i-open-window-options/i-open-window-options';
+export type { IOverlayContainer } from './i-overlay-container/i-overlay-container';
+export type { IOverlayController } from './i-overlay-controller/i-overlay-controller';

package/es/interface/state/index.d.ts

@@ -1,4 +1,3 @@
-export type { IDesignerState } from './i-designer-state';
 export type { IFormState } from './form/form.state';
 export type { IFormCollapsePaneState } from './form-collapse-pane/form-collapse-pane.state';
 export type { IFormCollapseState } from './form-collapse/form-collapse.state';

package/es/locale/index.d.ts

@@ -0,0 +1,19 @@
+import { I18n } from 'vue-i18n';
+import { App } from 'vue';
+export declare class LocaleUtil {
+    i18n: I18n;
+    protected locale: string;
+    constructor();
+    protected init(): Promise<void>;
+    protected loadLocales(): Promise<void>;
+    protected loadMessages(url: string, locale?: string): Promise<void>;
+    getMessageUrl(payload: {
+        locale: string;
+    } | {
+        locale: string;
+        app: string;
+        env: 'dev' | 'test' | 'prod';
+        branch?: string;
+    }): string;
+}
+export declare function setupI18n(app: App): void;

package/es/locale/index.mjs

@@ -0,0 +1,60 @@
+import { createI18n } from 'vue-i18n';
+
+class LocaleUtil {
+  i18n = createI18n({
+    legacy: false,
+    locale: "zh-CN",
+    fallbackLocale: "en",
+    messages: {
+      en: {
+        message: {
+          hello: "hello world"
+        }
+      },
+      ja: {
+        message: {
+          hello: "こんにちは、世界"
+        }
+      }
+    }
+  });
+  locale = "zh-CN";
+  constructor() {
+    this.init();
+  }
+  async init() {
+    await this.loadLocales();
+    const platformUrl = this.getMessageUrl({ locale: this.locale });
+    await this.loadMessages(platformUrl);
+  }
+  async loadLocales() {
+    const res = await (await fetch("/gct-platform/api/i18n-config/list")).json();
+    if (res.code === 200) {
+      const defaultItem = res.data.find((item) => item.defaultLanguage);
+      this.locale = defaultItem.languageTag;
+    }
+  }
+  async loadMessages(url, locale = this.locale) {
+    const res = await fetch(url);
+    const text = await res.text();
+    const messages = text.split("\n").reduce((acc, item) => {
+      const [key, ...value] = item.split(":");
+      acc[key] = value.join(":");
+      return acc;
+    }, {});
+    this.i18n.global.mergeLocaleMessage(locale, messages);
+  }
+  getMessageUrl(payload) {
+    if ("app" in payload) {
+      const tag = payload.env === "dev" ? `dev_${payload.branch}` : payload.env;
+      return `minio/${payload.app}/locale-js/${tag}/${payload.locale}__.json`;
+    }
+    return `/minio/locale-js/${payload.locale}__platform__.json`;
+  }
+  // changeLocale(locale: string) {}
+}
+function setupI18n(app) {
+  app.use(_gct.i18n);
+}
+
+export { LocaleUtil, setupI18n };

package/es/modules/env-manager/env-manager.const.d.ts

@@ -0,0 +1,14 @@
+/** IP地址正则表达式 */
+export declare const IP_REG: RegExp;
+/** 域名正则表达式 */
+export declare const HOST_REG: RegExp;
+/** 应用运行时路径正则表达式 */
+export declare const APP_RUN_PATH_REG: RegExp;
+/** 应用生产环境路径正则表达式 */
+export declare const APP_PROD_PATH_REG: RegExp;
+/** 应用预览环境路径正则表达式 */
+export declare const APP_PREVIEW_PATH_REG: RegExp;
+/** dev环境单应用路径正则表达式 */
+export declare const DEV_SINGLE_PATH_REG: RegExp;
+/** 测试环境单应用路径正则表达式 */
+export declare const TEST_SINGLE_PATH_REG: RegExp;

package/es/modules/env-manager/env-manager.const.mjs

@@ -0,0 +1,9 @@
+const IP_REG = /^http:\/\/\d{1,3}(\.\d{1,3}){3}:(\d{1,5})$/;
+const HOST_REG = /^https?:\/\/([a-z0-9]+)-test\./;
+const APP_RUN_PATH_REG = /\/web-render|\/web\/|web-single\/|dev-single\/|test-single\//;
+const APP_PROD_PATH_REG = /\/web\/|\/web-single\//;
+const APP_PREVIEW_PATH_REG = /\/web-render\//;
+const DEV_SINGLE_PATH_REG = /\/dev-single\//;
+const TEST_SINGLE_PATH_REG = /\/test-single\//;
+
+export { APP_PREVIEW_PATH_REG, APP_PROD_PATH_REG, APP_RUN_PATH_REG, DEV_SINGLE_PATH_REG, HOST_REG, IP_REG, TEST_SINGLE_PATH_REG };

package/es/modules/env-manager/env-manager.d.ts

@@ -0,0 +1,59 @@
+import { Tenant } from '@gct-paas/api/platform';
+import { IEnvironmentManager, EnvironmentType } from './env-manager.interface';
+/**
+ * 环境管理器
+ *
+ * @description 负责检测和管理应用运行环境，包括测试环境检测、租户信息获取等功能
+ */
+export declare class EnvironmentManager implements IEnvironmentManager {
+    /** 测试环境标识 */
+    private _testEnv;
+    /** 测试环境租户数据 */
+    private readonly _testTenantData;
+    /** 平台地址 */
+    private readonly _platformOrigin;
+    /** 域名访问模式标识 */
+    private _isHostMode;
+    constructor();
+    /**
+     * 是否为应用前端运行时
+     */
+    get isAppRun(): boolean;
+    /**
+     * 是否为应用前端运行时生产环境包含测试环境
+     */
+    get isAppProd(): boolean;
+    /**
+     * 是否为应用前端运行时预览环境
+     */
+    get isAppPreview(): boolean;
+    /**
+     * 是否为dev环境单应用
+     */
+    get isDevSingleEnv(): boolean;
+    /**
+     * 是否为测试环境
+     */
+    get isTestEnv(): boolean;
+    /**
+     * 平台地址
+     */
+    get platformOrigin(): string;
+    /**
+     * 是否为域名访问模式
+     */
+    get isHostMode(): boolean;
+    /**
+     * 测试环境租户数据
+     */
+    get testTenantData(): Tenant;
+    /**
+     * 检测是否为测试环境
+     */
+    checkIsTestEnv(): Promise<void>;
+    /**
+     * 获取当前环境类型
+     * @returns 环境类型
+     */
+    getEnv(): EnvironmentType;
+}

package/es/modules/env-manager/env-manager.interface.d.ts

@@ -0,0 +1,43 @@
+import { Tenant } from '@gct-paas/api/platform';
+/**
+ * 环境类型枚举
+ */
+export declare enum EnvironmentType {
+    /** 开发环境 */
+    DEV = "dev",
+    /** 测试环境 */
+    TEST = "test",
+    /** 生产环境 */
+    PROD = "prod"
+}
+/**
+ * 环境管理器接口
+ */
+export interface IEnvironmentManager {
+    /** 是否为应用前端运行时 */
+    readonly isAppRun: boolean;
+    /** 是否为应用前端运行时生产环境 */
+    readonly isAppProd: boolean;
+    /** 是否为应用前端运行时预览环境 */
+    readonly isAppPreview: boolean;
+    /** 是否为dev环境单应用 */
+    readonly isDevSingleEnv: boolean;
+    /** 是否为测试环境 */
+    readonly isTestEnv: boolean;
+    /** 平台地址 */
+    readonly platformOrigin: string;
+    /** 是否为域名访问模式 */
+    readonly isHostMode: boolean;
+    /** 测试环境租户数据 */
+    readonly testTenantData: Tenant;
+    /**
+     * 检测是否为测试环境
+     * @param loadTenant 是否加载租户信息
+     */
+    checkIsTestEnv(loadTenant?: boolean): Promise<void>;
+    /**
+     * 获取当前环境类型
+     * @returns 环境类型
+     */
+    getEnv(): EnvironmentType;
+}

package/es/modules/env-manager/env-manager.interface.mjs

@@ -0,0 +1,8 @@
+var EnvironmentType = /* @__PURE__ */ ((EnvironmentType2) => {
+  EnvironmentType2["DEV"] = "dev";
+  EnvironmentType2["TEST"] = "test";
+  EnvironmentType2["PROD"] = "prod";
+  return EnvironmentType2;
+})(EnvironmentType || {});
+
+export { EnvironmentType };

package/es/modules/env-manager/env-manager.mjs

@@ -0,0 +1,108 @@
+import { EnvironmentType } from './env-manager.interface.mjs';
+import { HOST_REG, APP_RUN_PATH_REG, APP_PROD_PATH_REG, APP_PREVIEW_PATH_REG, DEV_SINGLE_PATH_REG, TEST_SINGLE_PATH_REG, IP_REG } from './env-manager.const.mjs';
+
+class EnvironmentManager {
+  /** 测试环境标识 */
+  _testEnv = false;
+  /** 测试环境租户数据 */
+  _testTenantData = {};
+  /** 平台地址 */
+  _platformOrigin;
+  /** 域名访问模式标识 */
+  _isHostMode = false;
+  constructor() {
+    this._platformOrigin = (location.origin) || "";
+    this._isHostMode = HOST_REG.test(this._platformOrigin);
+  }
+  /**
+   * 是否为应用前端运行时
+   */
+  get isAppRun() {
+    return APP_RUN_PATH_REG.test(location.pathname);
+  }
+  /**
+   * 是否为应用前端运行时生产环境包含测试环境
+   */
+  get isAppProd() {
+    return APP_PROD_PATH_REG.test(location.pathname);
+  }
+  /**
+   * 是否为应用前端运行时预览环境
+   */
+  get isAppPreview() {
+    return APP_PREVIEW_PATH_REG.test(location.pathname);
+  }
+  /**
+   * 是否为dev环境单应用
+   */
+  get isDevSingleEnv() {
+    return DEV_SINGLE_PATH_REG.test(location.pathname);
+  }
+  /**
+   * 是否为测试环境
+   */
+  get isTestEnv() {
+    return TEST_SINGLE_PATH_REG.test(location.pathname) || this._testEnv;
+  }
+  /**
+   * 平台地址
+   */
+  get platformOrigin() {
+    return this._platformOrigin;
+  }
+  /**
+   * 是否为域名访问模式
+   */
+  get isHostMode() {
+    return this._isHostMode;
+  }
+  /**
+   * 测试环境租户数据
+   */
+  get testTenantData() {
+    return this._testTenantData;
+  }
+  /**
+   * 检测是否为测试环境
+   */
+  async checkIsTestEnv() {
+    let matches = null;
+    if (this._isHostMode) {
+      matches = this._platformOrigin.match(HOST_REG);
+      this._testEnv = !!(matches && matches[1]);
+      if (this._testEnv) {
+        const data = await _api.platform.tenant.getInfoByPortOrDomain({
+          domain: matches[1]
+        });
+        Object.assign(this._testTenantData, data);
+      }
+    } else {
+      matches = this._platformOrigin.match(IP_REG);
+      const port = matches && matches[2];
+      if (port) {
+        const data = await _api.platform.tenant.getInfoByPortOrDomain({
+          port
+        });
+        if (data) {
+          Object.assign(this._testTenantData, data);
+          this._testEnv = data.testEnvPort === port;
+        }
+      }
+    }
+  }
+  /**
+   * 获取当前环境类型
+   * @returns 环境类型
+   */
+  getEnv() {
+    if (this.isTestEnv) {
+      return EnvironmentType.TEST;
+    } else if (this.isAppProd) {
+      return EnvironmentType.PROD;
+    } else {
+      return EnvironmentType.DEV;
+    }
+  }
+}
+
+export { EnvironmentManager };

package/es/modules/env-manager/index.d.ts

@@ -0,0 +1,3 @@
+export * from './env-manager.interface';
+export * from './env-manager.const';
+export { EnvironmentManager } from './env-manager';