@ibiz-template/core 0.7.41-alpha.1 → 0.7.41-alpha.106

package/src/constant/http-status-message/http-status-message.ts

@@ -0,0 +1,18 @@
+// 请求状态码文本
+export const HttpStatusMessageConst: Record<number, string> = {
+  200: '服务器成功返回请求的数据。',
+  201: '新建或修改数据成功。',
+  202: '一个请求已经进入后台排队（异步任务）。',
+  204: '删除数据成功。',
+  400: '发出的请求有错误，服务器没有进行新建或修改数据的操作。',
+  401: '用户没有权限（令牌、用户名、密码错误）。',
+  403: '用户得到授权，但是访问是被禁止的。',
+  404: '发出的请求针对的是不存在的记录，服务器没有进行操作。',
+  406: '请求的格式不可得。',
+  410: '请求的资源被永久删除，且不会再得到的。',
+  422: '当创建一个对象时，发生一个验证错误。',
+  500: '服务器发生错误，请检查服务器。',
+  502: '网关错误。',
+  503: '服务不可用，服务器暂时过载或维护。',
+  504: '网关超时。',
+};

package/src/constant/index.ts

@@ -0,0 +1,4 @@
+export { CoreConst } from './core/core';
+export { NOOP } from './util/util';
+export { EMOJILIST, EMOJIMAP } from './emoji/emoji';
+export { HttpStatusMessageConst } from './http-status-message/http-status-message';

package/src/constant/util/util.ts

@@ -0,0 +1,3 @@
+/* eslint-disable @typescript-eslint/no-empty-function */
+// 无操作函数
+export const NOOP = (): void => {};

package/src/context/index.ts

@@ -0,0 +1,231 @@
+/* eslint-disable default-param-last */
+import { clone } from 'ramda';
+import { IIBizContext } from '../interface';
+
+/**
+ * @description 上下文处理类
+ * @export
+ * @class IBizContext
+ * @implements {IIBizContext}
+ */
+export class IBizContext implements IIBizContext {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  [key: string | symbol]: any;
+
+  /**
+   * @description 当前所归属的应用
+   * @type {string}
+   * @memberof IBizContext
+   */
+  declare srfappid: string;
+
+  /**
+   * @description 界面域标识，每个独立路由导航的视图生成
+   * @type {string}
+   * @memberof IBizContext
+   */
+  declare srfsessionid: string;
+
+  /**
+   * @description clone 后引用的上下文实例，需要在实例销毁时，同时销毁
+   * @protected
+   * @type {IBizContext[]}
+   * @memberof IBizContext
+   */
+  declare protected _associationContext: IBizContext[];
+
+  /**
+   * @description 修改的父上下文
+   * @protected
+   * @type {IData}
+   * @memberof IBizContext
+   */
+  declare protected _context: IData;
+
+  /**
+   * @description 父的上下文源对象
+   * @type {IContext}
+   * @memberof IBizContext
+   */
+  declare _parent?: IContext;
+
+  /**
+   * Creates an instance of IBizContext.
+   * @param {IData} [context={}] 自身的上下文
+   * @param {IContext} [parent] 父的上下文源对象
+   * @memberof IBizContext
+   */
+  private constructor(context: IData = {}, parent?: IContext) {
+    Object.defineProperty(this, '_associationContext', {
+      enumerable: false,
+      configurable: true,
+      value: [],
+    });
+
+    if (parent) {
+      this.initWithParent(parent);
+    }
+
+    // 合并给入上下文
+    Object.assign(this, context);
+  }
+
+  /**
+   * @description 初始化上下文，并关联父上下文
+   * @private
+   * @param {IContext} parent
+   * @memberof IBizContext
+   */
+  private initWithParent(parent: IContext): void {
+    // eslint-disable-next-line @typescript-eslint/no-this-alias
+    const self = this;
+
+    // 定义私有变量，存放父上下文源对象
+    Object.defineProperty(this, '_parent', {
+      enumerable: false,
+      writable: true,
+      value: parent,
+    });
+
+    // 定义私有变量，用于存储对父已有上下文的修改。
+    Object.defineProperty(this, '_context', {
+      enumerable: false,
+      writable: true,
+      value: {},
+    });
+    // 监控父上下文参数，自身不存在时从父取
+    const properties: { [key: string]: PropertyDescriptor } = {};
+    const keys = Object.keys(parent);
+    keys.forEach(key => {
+      if (Object.prototype.hasOwnProperty.call(this, key)) {
+        // !已经定义的不重复定义，会报错
+        return;
+      }
+      properties[key] = {
+        enumerable: true,
+        configurable: true,
+        set(val: unknown): void {
+          if (val == null) {
+            self._context[key] = null;
+          } else {
+            self._context[key] = val;
+          }
+        },
+        get(): string {
+          if (self._context[key] !== undefined) {
+            return self._context[key];
+          }
+          if (self._parent) {
+            return self._parent[key];
+          }
+          return '';
+        },
+      };
+    });
+    Object.defineProperties(this, properties);
+  }
+
+  /**
+   * @description 返回自身独有的上下文，和父有差异的
+   * @returns {*}  {IData}
+   * @memberof IBizContext
+   */
+  getOwnContext(): IData {
+    const result: IData = {};
+    Object.keys(this).forEach(key => {
+      // 父没有的，或者修改了父的上下文
+      // 父不存在则返回所有自身的属性
+      if (
+        !this._parent ||
+        !Object.prototype.hasOwnProperty.call(this._parent, key) ||
+        Object.prototype.hasOwnProperty.call(this._context, key)
+      ) {
+        result[key] = this[key];
+      }
+    });
+    return result;
+  }
+
+  /**
+   * @description 销毁当前上下文对象
+   * @memberof IBizContext
+   */
+  destroy(): void {
+    this._parent = undefined;
+    this._context = {};
+    this._associationContext.forEach(item => {
+      item.destroy();
+    });
+  }
+
+  /**
+   * @description 在非视图中，需要断开视图上下文联系时。只能使用 clone 创建新的局部上下文
+   * @returns {*}  {IBizContext}
+   * @memberof IBizContext
+   */
+  clone(): IBizContext {
+    const newContext = new IBizContext(
+      clone(this.getOwnContext()),
+      this._parent,
+    );
+    this._associationContext.push(newContext);
+    return newContext;
+  }
+
+  /**
+   * @description 深度克隆，只返回现有数据
+   * @returns {*}  {IData}
+   * @memberof IBizContext
+   */
+  deepClone(): IData {
+    const result: IData = {};
+    Object.keys(this).forEach(key => {
+      result[key] = this[key];
+    });
+    return result;
+  }
+
+  /**
+   * @description 在不改变对象引用的情况下，重置上下文,等效于重新实例化，但是引用不变
+   * @param {IData} [context={}]
+   * @param {IContext} [parent]
+   * @memberof IBizContext
+   */
+  reset(context: IData = {}, parent?: IContext): void {
+    // 清空_associationContext
+    this._associationContext.forEach(item => {
+      item.destroy();
+    });
+    // 置空parent相关属性
+    if (this._parent) {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      this._parent = {} as any;
+      this._context = {};
+    }
+    // 删除自身的属性，define的删不掉，上面置空了就不管了
+    Object.keys(this).forEach(key => {
+      try {
+        delete this[key];
+      } catch (error) {
+        // 删不掉的不管了，上面已经变成uneducated了
+      }
+    });
+    if (parent) {
+      this.initWithParent(parent);
+    }
+    // 合并默认值
+    Object.assign(this, context);
+  }
+
+  /**
+   * @description 上下文只有在视图初始化时，调用 create 方法
+   * @static
+   * @param {IData} [context]
+   * @param {IContext} [parent]
+   * @returns {*}  {IBizContext}
+   * @memberof IBizContext
+   */
+  static create(context?: IData, parent?: IContext): IBizContext {
+    return new IBizContext(context, parent);
+  }
+}

package/src/environment/environment.ts

@@ -0,0 +1,64 @@
+import { IEnvironment, LoginMode, MenuPermissionMode } from '../interface';
+// 默认环境变量配置
+export const Environment: IEnvironment = {
+  dev: false,
+  hub: true,
+  enableMqtt: false,
+  mqttUrl: '/portal/mqtt/mqtt',
+  isEnableMultiLan: false,
+  anonymousUser: '',
+  anonymousPwd: '',
+  enableAnonymous: false,
+  accessStoreArea: 'COOKIE',
+  logLevel: 'ERROR',
+  baseUrl: '/api',
+  appId: '',
+  pluginBaseUrl: 'http://172.16.240.221',
+  isLocalModel: false,
+  remoteModelUrl: '/remotemodel',
+  assetsUrl: './assets',
+  dcSystem: '',
+  // {cat} 会替换模型 IApplication的getDefaultOSSCat 参数 如果没有会截取掉/{cat}
+  // getDefaultOSSCat 配置方法 系统应用-高级设置-自定义参数：DefaultOSSCat
+  // 配置示例 DefaultOSSCat=cat
+  downloadFileUrl: '/ibizutil/download/{cat}',
+  uploadFileUrl: '/ibizutil/upload/{cat}',
+  defaultOSSCat: '',
+  casLoginUrl: '',
+  loginMode: LoginMode.DEFAULT,
+  menuPermissionMode: MenuPermissionMode.MIXIN,
+  enablePermission: true,
+  routePlaceholder: '-',
+  enableWfAllHistory: false,
+  isMob: false,
+  isSaaSMode: true,
+  AppTitle: '',
+  AppLabel: '',
+  favicon: './favicon.ico',
+  enableTitle: true,
+  tokenHeader: '',
+  tokenPrefix: '',
+  customParams: {},
+  oauthOpenAccessId: '',
+  enableEncryption: false,
+  cookieDomain: '',
+  appLoadingTheme: 'DEFAULT',
+  environmentTag: 'development',
+  mobMenuShowMode: 'DEFAULT',
+  appVersion: '',
+  devtoolConfig: {
+    studioBaseUrl: 'https://open.ibizlab.cn/modeldesign/#/',
+    v9Mode: false,
+    defaultMode: 'close',
+  },
+  enableAI: true,
+  aMapSecurityJsCode: '',
+  aMapKey: '',
+  runContainer: 'DYNAENGINE',
+  mobWeChatAppId: '',
+  isPortalApp: false,
+  isEnableMobLoading: false,
+  mobLoadingCaption: '',
+  mobLoadingDescription: '',
+  mobLoadingBackground: '',
+};

package/src/error/http-error/entity-error.ts

@@ -0,0 +1,29 @@
+import { HttpError } from '../http-error/http-error';
+import { detailMessage, InputError } from '../../interface';
+
+/**
+ * @description 请求异常
+ * @export
+ * @class EntityError
+ * @extends {HttpError}
+ */
+export class EntityError extends HttpError {
+  name: string = 'EntityError';
+
+  details: detailMessage[] = [];
+
+  constructor(err: InputError) {
+    super(err);
+    if (this.response) {
+      const { details = [] } = this.response.data;
+      this.details = details.map((detail: IData) => {
+        return {
+          name: detail.fieldname.toLowerCase(),
+          logicName: detail.fieldlogicname,
+          errorType: detail.fielderrortype,
+          errorInfo: detail.fielderrorinfo,
+        };
+      });
+    }
+  }
+}

package/src/error/http-error/http-error-factory.ts

@@ -0,0 +1,24 @@
+import { AxiosError } from 'axios';
+import { HttpError } from './http-error';
+import { EntityError } from './entity-error';
+
+/**
+ * @description 错误工厂
+ * @export
+ * @class HttpErrorFactory
+ */
+export class HttpErrorFactory {
+  public static getInstance(error: AxiosError): HttpError {
+    const { response } = error;
+    if (!response || !response.data) {
+      return new HttpError(error);
+    }
+    const { type } = response.data as IData;
+    switch (type) {
+      case 'EntityException':
+        return new EntityError(error);
+      default:
+        return new HttpError(error);
+    }
+  }
+}

package/src/error/http-error/http-error.ts

@@ -0,0 +1,52 @@
+import { AxiosResponse } from 'axios';
+import { IApiHttpError, InputError } from '../../interface';
+
+/**
+ * @description 请求异常
+ * @export
+ * @class HttpError
+ * @extends {Error}
+ */
+export class HttpError extends Error implements IApiHttpError {
+  name: string = 'HttpError';
+
+  message: string;
+
+  status: number;
+
+  // 错误标识
+  tag: string;
+
+  response?: AxiosResponse;
+
+  constructor(err: InputError) {
+    super('HttpError');
+    const res = err.response;
+    this.response = err.response;
+    this.tag = '';
+    if (res) {
+      if (res.data) {
+        const data = res.data as IData;
+        this.message = data.message;
+        if (!this.message && data.status === 404) {
+          this.message = ibiz.i18n.t('core.error.serviceResNotExist');
+        }
+        if (!this.message && data.status === 403) {
+          this.message = ibiz.i18n.t('core.error.serviceResNotPermission');
+        }
+        if (!this.message) {
+          this.message = ibiz.i18n.t('core.error.serviceException');
+        }
+      } else {
+        this.message = res.statusText;
+      }
+      if (!this.message) {
+        this.message = ibiz.i18n.t('core.error.networkAbnormality');
+      }
+      this.status = res.status;
+    } else {
+      this.message = err.message || '';
+      this.status = 500;
+    }
+  }
+}

package/src/error/index.ts

@@ -0,0 +1,7 @@
+export { HttpError } from './http-error/http-error';
+export { ModelError } from './model-error/model-error';
+export { RuntimeError } from './runtime-error/runtime-error';
+export { RuntimeModelError } from './runtime-model-error/runtime-model-error';
+export { NoticeError } from './notice-error/notice-error';
+export { EntityError } from './http-error/entity-error';
+export { HttpErrorFactory } from './http-error/http-error-factory';

package/src/error/model-error/model-error.ts

@@ -0,0 +1,27 @@
+/**
+ * @description 未支持的模型错误
+ * @export
+ * @class ModelError
+ * @extends {Error}
+ */
+export class ModelError extends Error {
+  name: string = ibiz.i18n.t('core.error.unsupportedModels');
+
+  /**
+   * Creates an instance of ModelError.
+   * @param {IData} model 模板未支持的模型
+   * @param {string} [msg] 错误信息
+   * @memberof ModelError
+   */
+  constructor(
+    public model: IData,
+    msg?: string,
+  ) {
+    super(
+      ibiz.i18n.t('core.error.modelMsg', {
+        id: model.id,
+        msg: msg ? `： ${msg}` : '',
+      }),
+    );
+  }
+}

package/src/error/notice-error/notice-error.ts

@@ -0,0 +1,16 @@
+/**
+ * @description 纯输出通知信息的异常
+ * @export
+ * @class NoticeError
+ * @extends {Error}
+ */
+export class NoticeError extends Error {
+  name: string = 'notice Error';
+
+  constructor(
+    public message: string,
+    public duration?: number,
+  ) {
+    super(message);
+  }
+}

package/src/error/runtime-error/runtime-error.ts

@@ -0,0 +1,13 @@
+/**
+ * @description 运行时错误
+ * @export
+ * @class RuntimeError
+ * @extends {Error}
+ */
+export class RuntimeError extends Error {
+  name: string = 'Runtime Error';
+
+  constructor(public message: string) {
+    super(message);
+  }
+}

package/src/error/runtime-model-error/runtime-model-error.ts

@@ -0,0 +1,27 @@
+/**
+ * @description 模型配置缺失错误
+ * @export
+ * @class RuntimeModelError
+ * @extends {Error}
+ */
+export class RuntimeModelError extends Error {
+  name: string = ibiz.i18n.t('core.error.modelConfigurationMissing');
+
+  /**
+   * Creates an instance of RuntimeModelError.
+   * @param {IData} model 丢失配置的模型
+   * @param {string} [msg] 缺失配置描述
+   * @memberof RuntimeModelError
+   */
+  constructor(
+    public model: IData,
+    msg?: string,
+  ) {
+    super(
+      ibiz.i18n.t('core.error.modelMsg', {
+        id: model.id,
+        msg: msg ? `： ${msg}` : '',
+      }),
+    );
+  }
+}

package/src/ibizsys.ts

@@ -0,0 +1,82 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
+import { Logger } from 'loglevel';
+import { CommandController } from './command';
+import { Environment } from './environment/environment';
+import { I18n, IIBizsys, OrgData } from './interface';
+import { MessageCenter, Net } from './utils';
+import { logger } from './utils/logger/logger';
+
+/**
+ * @description 全局对象
+ * @export
+ * @class IBizSys
+ * @implements {IIBizsys}
+ */
+export class IBizSys implements IIBizsys {
+  /**
+   * @description 环境变量
+   * @memberof IBizSys
+   */
+  env = Environment;
+
+  /**
+   * @description 日志输出工具类
+   * @type {Logger}
+   * @memberof IBizSys
+   */
+  log: Logger = logger;
+
+  /**
+   * @description 网络请求工具类(发送默认请求)
+   * @type {Net}
+   * @memberof IBizSys
+   */
+  net: Net = new Net();
+
+  /**
+   * @description 指令工具类
+   * @type {CommandController}
+   * @memberof IBizSys
+   */
+  commands: CommandController = new CommandController();
+
+  /**
+   * @description 消息中心
+   * @type {MessageCenter}
+   * @memberof IBizSys
+   */
+  mc: MessageCenter = new MessageCenter();
+
+  /**
+   * @description 国际化工具类
+   * @type {I18n}
+   * @memberof IBizSys
+   */
+  i18n!: I18n;
+
+  /**
+   * @description 组织数据
+   * @type {OrgData}
+   * @memberof IBizSys
+   */
+  orgData?: OrgData;
+
+  /**
+   * @description 应用数据
+   * @type {IData}
+   * @memberof IBizSys
+   */
+  appData?: IData;
+
+  /**
+   * @description 注册全局扩展，用于替换预置能力
+   * @param {keyof IBizSys} key
+   * @param {*} value
+   * @memberof IBizSys
+   */
+  registerExtension(key: keyof IBizSys, value: any): void {
+    const self = this as IData;
+    self[key] = value;
+  }
+}

package/src/index.ts

@@ -0,0 +1,14 @@
+import './types';
+
+export * from '@microsoft/fetch-event-source';
+export * from './command';
+export * from './constant';
+export { IBizContext } from './context';
+export { IBizParams } from './params/params';
+export { Environment } from './environment/environment';
+export * from './error';
+export * from './interface';
+export * from './utils';
+export * from './locale';
+export { IBizSys } from './ibizsys';
+export { install } from './install';

package/src/install.ts

@@ -0,0 +1,12 @@
+import { IBizSys } from './ibizsys';
+
+/**
+ * @description 初始化全局对象
+ * @export
+ */
+export function install(): void {
+  if (window.ibiz) {
+    throw new Error(ibiz.i18n.t('core.noReInstall'));
+  }
+  window.ibiz = new IBizSys();
+}