@oinone/kunlun-meta 6.2.0

package/dist/types/src/metadata/types/view.d.ts

@@ -0,0 +1,170 @@
+import { BIGINT, EntityId } from './value';
+export declare type ViewId = EntityId;
+export declare enum DataClass {
+    List = "LIST",
+    Object = "OBJECT"
+}
+/**
+ * 视图客户端类型
+ */
+export declare enum ViewClientType {
+    /**
+     * PC端
+     */
+    PC = "PC",
+    /**
+     * 移动端
+     */
+    MOBILE = "MOBILE"
+}
+/**
+ * <h3>视图类型</h3>
+ * <p>
+ * 视图类型是描述数据类型、数据传递、数据交互的基本属性
+ * </p>
+ */
+export declare enum ViewType {
+    /**
+     * 表格
+     */
+    Table = "TABLE",
+    /**
+     * 表单
+     */
+    Form = "FORM",
+    /**
+     * 详情
+     */
+    Detail = "DETAIL",
+    /**
+     * 搜索
+     */
+    Search = "SEARCH",
+    /**
+     * 画廊
+     */
+    Gallery = "GALLERY",
+    /**
+     * 树
+     */
+    Tree = "TREE",
+    /**
+     * 多视图
+     */
+    Multiple = "MULTIPLE",
+    /**
+     * 自定义
+     */
+    Custom = "CUSTOM"
+}
+/**
+ * <h3>视图模式</h3>
+ * <p>
+ * 视图模式是视图类型更具备操作性的定义，相同的视图类型会有不同模式进行描述。
+ * <p>例如:</p>
+ * <ul>
+ *   <li>【表单】视图类型可能会存在【创建】和【编辑】两种不同的模式</li>
+ *   <li>【表单】视图类型可能会在某些情况下手动修改为【只读】状态</li>
+ * </ul>
+ * </p>
+ */
+export declare enum ViewMode {
+    /**
+     * 创建
+     */
+    Create = "CREATE",
+    /**
+     * 编辑
+     */
+    Editor = "EDITOR",
+    /**
+     * 查看
+     */
+    Lookup = "LOOKUP"
+}
+/**
+ * 跳转动作路由类型
+ */
+export declare enum ViewActionTarget {
+    /**
+     * 页面路由
+     */
+    Router = "ROUTER",
+    /**
+     * 页面弹窗
+     */
+    Dialog = "DIALOG",
+    /**
+     * 页面抽屉
+     */
+    Drawer = "DRAWER",
+    /**
+     * 页内路由
+     */
+    Inner = "INNER",
+    /**
+     * 打开新窗口
+     */
+    OpenWindow = "OPEN_WINDOW",
+    /**
+     * 页面嵌入
+     */
+    Frame = "iframe"
+}
+export declare enum SystemSource {
+    SYSTEM = "SYSTEM",
+    BASE = "BASE",
+    MANUAL = "MANUAL",
+    UI = "UI",
+    RELATION = "RELATION",
+    ABSTRACT_INHERITED = "ABSTRACT_INHERITED",
+    TRANSIENT_INHERITED = "TRANSIENT_INHERITED",
+    EXTEND_INHERITED = "EXTEND_INHERITED",
+    MULTI_TABLE_INHERITED = "MULTI_TABLE_INHERITED",
+    PROXY_INHERITED = "PROXY_INHERITED"
+}
+export interface IView {
+    id: ViewId;
+    name: string;
+    type: ViewType;
+    model: string;
+    priority: BIGINT;
+    template: string;
+    active?: any;
+    title?: string;
+    systemSource?: SystemSource;
+    moduleDisplayName?: SystemSource;
+    extension?: Record<string, string>;
+    modelDefinition?: {
+        model?: string;
+        name?: string;
+        moduleName?: string;
+        module?: string;
+    };
+    baseLayoutName?: string;
+    baseLayoutDefinition?: {
+        name: string;
+        template: string;
+    };
+}
+/**
+ * 组件的标签内的 <config /> 配置
+ */
+export interface IBaseWidgetConfig {
+}
+/**
+ * 视图组件基础配置
+ */
+export interface IViewWidgetConfig extends IBaseWidgetConfig {
+    submit?: string;
+    excludedActions?: string;
+    validateTip?: boolean;
+}
+/**
+ * select组件配置
+ */
+export interface IBaseSelectWidgetConfig extends IBaseWidgetConfig {
+    searchField?: string;
+    labelField?: string;
+    separator?: string;
+}

package/dist/types/src/plugin-loader/factory/PluginLoaderFactory.d.ts

@@ -0,0 +1,4 @@
+import { PluginLoader, PluginLoadType } from '../typing';
+export declare class PluginLoaderFactory {
+    static get(type: PluginLoadType): PluginLoader | undefined;
+}

package/dist/types/src/plugin-loader/factory/index.d.ts

@@ -0,0 +1 @@
+export * from './PluginLoaderFactory';

package/dist/types/src/plugin-loader/index.d.ts

@@ -0,0 +1,5 @@
+import { PluginLoadDependencies, PluginsLoaderConfig } from './typing';
+export declare class PluginsLoader {
+    static load(config: PluginsLoaderConfig, localDependencies?: PluginLoadDependencies): Promise<void>;
+}
+export * from './typing';

package/dist/types/src/plugin-loader/loader/CJSPluginLoader.d.ts

@@ -0,0 +1,7 @@
+import { PluginLoader, PluginLoadOption } from '../typing';
+export declare class CJSPluginLoader implements PluginLoader {
+    static readonly INSTANCE: CJSPluginLoader;
+    private constructor();
+    load(option: PluginLoadOption): Promise<void>;
+    loadDependencies(dependencies: Record<string, unknown>): Promise<void>;
+}

package/dist/types/src/plugin-loader/loader/CSSPluginLoader.d.ts

@@ -0,0 +1,7 @@
+import { PluginLoader, PluginLoadOption } from '../typing';
+export declare class CSSPluginLoader implements PluginLoader {
+    static readonly INSTANCE: CSSPluginLoader;
+    private constructor();
+    load(option: PluginLoadOption): Promise<void>;
+    loadDependencies(): Promise<void>;
+}

package/dist/types/src/plugin-loader/loader/ESMPluginLoader.d.ts

@@ -0,0 +1,7 @@
+import { PluginLoader, PluginLoadOption } from '../typing';
+export declare class ESMPluginLoader implements PluginLoader {
+    static readonly INSTANCE: ESMPluginLoader;
+    private constructor();
+    load(option: PluginLoadOption): Promise<void>;
+    loadDependencies(dependencies: Record<string, unknown>): Promise<void>;
+}

package/dist/types/src/plugin-loader/loader/IIFEPluginLoader.d.ts

@@ -0,0 +1,7 @@
+import { PluginLoader, PluginLoadOption } from '../typing';
+export declare class IIFEPluginLoader implements PluginLoader {
+    static readonly INSTANCE: IIFEPluginLoader;
+    private constructor();
+    load(option: PluginLoadOption): Promise<void>;
+    loadDependencies(dependencies: Record<string, unknown>): Promise<void>;
+}

package/dist/types/src/plugin-loader/loader/LoadedEvent.d.ts

@@ -0,0 +1,4 @@
+declare type ResolveFunction = () => void;
+export declare function bindScriptLoadedEvent(script: HTMLScriptElement, resolve: ResolveFunction): void;
+export declare function bindLinkLoadedEvent(link: HTMLLinkElement, resolve: ResolveFunction): void;
+export {};

package/dist/types/src/plugin-loader/loader/PluginLoader.d.ts

@@ -0,0 +1,5 @@
+import { PluginLoadOption, PluginLoadType } from '../typing';
+export declare class PluginLoader {
+    static load(options: PluginLoadOption[]): Promise<void>;
+    static loadDependencies(type: PluginLoadType, dependencies: Record<string, unknown>): Promise<void>;
+}

package/dist/types/src/plugin-loader/loader/RemotePluginLoader.d.ts

@@ -0,0 +1,5 @@
+export declare class RemotePluginLoader {
+    static readonly INSTANCE: RemotePluginLoader;
+    private cache;
+    load(): Promise<void>;
+}

package/dist/types/src/plugin-loader/loader/UMDPluginLoader.d.ts

@@ -0,0 +1,6 @@
+import { PluginLoader, PluginLoadOption } from '../typing';
+export declare class UMDPluginLoader implements PluginLoader {
+    static readonly INSTANCE: UMDPluginLoader;
+    load(option: PluginLoadOption): Promise<void>;
+    loadDependencies(dependencies: Record<string, unknown>): Promise<void>;
+}

package/dist/types/src/plugin-loader/loader/index.d.ts

@@ -0,0 +1 @@
+export * from './PluginLoader';

package/dist/types/src/plugin-loader/typing/index.d.ts

@@ -0,0 +1,2 @@
+export * from './load-option';
+export * from './loader-config';

package/dist/types/src/plugin-loader/typing/load-option.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 插件加载类型
+ */
+export declare type PluginLoadType = 'esm' | 'cjs' | 'umd' | 'iife' | 'css';
+/**
+ * Javascript插件
+ * default type: umd
+ */
+export declare type JavascriptPlugin = string | {
+    type: PluginLoadType;
+    path: string;
+};
+/**
+ * CSS插件
+ * type: css
+ */
+export declare type CSSPlugin = string;
+/**
+ * key: module
+ * value: global name or module
+ */
+declare type PluginLoadDependencies = Record<string, unknown>;
+export interface PluginLoadOption {
+    id: string;
+    type: PluginLoadType;
+    path: string;
+    dependencies?: PluginLoadDependencies;
+}
+export interface RemoteLoadOption {
+    javascript?: JavascriptPlugin[];
+    css?: CSSPlugin[];
+}
+/**
+ * 加载器
+ */
+export interface PluginLoader {
+    /**
+     * 通过加载可选项进行加载
+     * @param option
+     */
+    load(option: PluginLoadOption): Promise<void>;
+    /**
+     * 依赖加载
+     * @param dependencies 加载依赖
+     */
+    loadDependencies(dependencies: PluginLoadDependencies): Promise<void>;
+}
+export {};

package/dist/types/src/plugin-loader/typing/loader-config.d.ts

@@ -0,0 +1,38 @@
+import { CSSPlugin, JavascriptPlugin, PluginLoadType } from './load-option';
+/**
+ * 插件加载依赖
+ */
+export declare type PluginLoadDependency = {
+    /**
+     * 插件加载类型
+     */
+    type: PluginLoadType;
+    /**
+     * 依赖项
+     */
+    dependencies: Record<string, unknown>;
+};
+/**
+ * 插件加载依赖
+ */
+export declare type PluginLoadDependencies = Record<string, unknown> | PluginLoadDependency[];
+/**
+ * 插件加载配置
+ */
+export interface PluginsLoaderConfig {
+    /**
+     * 动态指定依赖（未实现）
+     */
+    dependencies?: PluginLoadDependencies;
+    /**
+     * 挂载指定外部js和css；数组默认使用js加载
+     */
+    mounted?: JavascriptPlugin[] | {
+        js?: JavascriptPlugin[];
+        css?: CSSPlugin[];
+    };
+    /**
+     * 使用低无一体组件；默认为false
+     */
+    usingRemote?: boolean;
+}

package/dist/types/src/plugin-loader/util/PluginLoadHelper.d.ts

@@ -0,0 +1,7 @@
+import { CSSPlugin, JavascriptPlugin, PluginLoadDependencies } from '../typing';
+export declare class PluginLoadHelper {
+    private constructor();
+    static loadDependencies(dependencies: PluginLoadDependencies): Promise<void>;
+    static loadJavascript(plugins: JavascriptPlugin[]): Promise<void>;
+    static loadCSS(paths: CSSPlugin[]): Promise<void>;
+}

package/dist/types/src/plugin-loader/util/index.d.ts

@@ -0,0 +1 @@
+export * from './PluginLoadHelper';

package/dist/types/src/util/element.d.ts

@@ -0,0 +1,16 @@
+import { ActionElement, ApiElement, FieldElement, PropElement, ViewElement } from '../element';
+import { IModelField, IDslNode } from '../metadata';
+declare const createViewElement: (dslNode: IDslNode | undefined) => ViewElement | null;
+declare const createPropElements: (parentNode: IDslNode | undefined) => PropElement[];
+declare const createFieldElement: (fieldNode: IDslNode | undefined) => FieldElement;
+declare const createFieldElements: (parentNode: IDslNode | undefined) => FieldElement[];
+/**
+ * 创建action元素
+ * @param actionNode
+ * @param parentDslNode actionNode所在的父节点
+ */
+declare const createActionElement: (actionNode: IDslNode, parentDslNode: IDslNode) => ActionElement;
+declare const createApiElement: (parentDslNode: IDslNode, apiName: string, dslFields?: IModelField[] | undefined) => ApiElement | null;
+declare const fieldElement2ModelField: (fieldElement: FieldElement) => IModelField;
+declare const modelField2fieldElement: (modelField: IModelField) => FieldElement;
+export { createViewElement, createApiElement, createPropElements, createFieldElements, createActionElement, createFieldElement, fieldElement2ModelField, modelField2fieldElement };

package/dist/types/src/util/field.d.ts

@@ -0,0 +1,7 @@
+import { IModelField, ModelFieldType } from '../metadata/types';
+declare const isSimpleField: (field: IModelField) => boolean;
+declare const isComplexTtype: (ttype: ModelFieldType) => boolean;
+declare const isDateTtype: (ttype: ModelFieldType) => boolean;
+declare const isNumberTtype: (ttype: ModelFieldType) => boolean;
+declare const isStringTtype: (ttype: ModelFieldType) => boolean;
+export { isSimpleField, isComplexTtype, isDateTtype, isNumberTtype, isStringTtype };

package/dist/types/src/util/helper.d.ts

@@ -0,0 +1,2 @@
+declare function deepClone(obj: any): any;
+export { deepClone };

package/dist/types/src/util/index.d.ts

@@ -0,0 +1,6 @@
+export * from './element';
+export * from './lang';
+export * from './field';
+export * from './helper';
+export * from './ke-common';
+export * from './validation-utils';

package/dist/types/src/util/ke-common.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 判断对象(特指除下划线外的属性的对象，所以取名为keObject)是否为空
+ * @param value
+ */
+declare const isEmptyKeObject: (value: any) => boolean;
+export { isEmptyKeObject };

package/dist/types/src/util/lang.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Determine if the argument is shaped like a Promise
+ */
+export declare function isPromise<T = unknown>(obj: unknown): obj is Promise<T>;

package/dist/types/src/util/validation-utils.d.ts

@@ -0,0 +1,3 @@
+declare const isValidateEmpty: (value: any) => boolean;
+declare const isEmptyValue: (value: any) => value is null;
+export { isValidateEmpty, isEmptyValue };

package/index.ts

@@ -0,0 +1 @@
+export * from './src';

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@oinone/kunlun-meta",
+  "version": "6.2.0",
+  "main": "index.ts",
+  "scripts": {
+    "prebuild": "rimraf dist",
+    "build": "rollup -c",
+    "dist": "npm run prepublishOnly",
+    "index": "npm run postpublish",
+    "x-prepublishOnly": "node ../../scripts/prepublish-only.js",
+    "x-postpublish": "node ../../scripts/postpublish.js"
+  },
+  "devDependencies": {
+    "@oinone/kunlun-request": "6.2.0"
+  },
+  "gitHead": "b65bbf1d649da1017810c5608473d5daa1a41f94"
+}

package/rollup.config.js

@@ -0,0 +1,4 @@
+import pkg from './package.json';
+import rollupConfig from '../../scripts/build.config.js';
+
+export default rollupConfig(pkg.name, ['@oinone/kunlun-request']);

package/src/element/ActionElement.ts

@@ -0,0 +1,20 @@
+import { IBaseElement } from './IBaseElement';
+import { ApiElement } from './ApiElement';
+
+/**
+ * 动作按钮
+ */
+
+interface ActionElement extends IBaseElement {
+  displayName: string;
+  model: string;
+  refs: string;
+  // 生效规则
+  rule: string;
+  // view
+  type: string;
+  // 提交数据的处理api
+  submitApi: string;
+  api: ApiElement;
+}
+export { ActionElement };

package/src/element/ApiElement.ts

@@ -0,0 +1,22 @@
+import { IBaseElement } from './IBaseElement';
+import { LoadType } from '../metadata';
+import { ContextElement } from './ContextElement';
+import { RequestElement } from './RequestElement';
+import { ResponseElement } from './ResponseElement';
+import { ClearElement } from './ClearElement';
+import { ValidationElement } from './ValidationElement';
+
+/**
+ * 自定义api
+ */
+interface ApiElement extends IBaseElement {
+  model: string;
+  fun: string;
+  type: LoadType;
+  context: ContextElement;
+  request: RequestElement;
+  response: ResponseElement;
+  clear: ClearElement;
+  validation: ValidationElement;
+}
+export { ApiElement };

package/src/element/ClearElement.ts

@@ -0,0 +1,10 @@
+import { IBaseElement } from './IBaseElement';
+import { FieldElement } from './FieldElement';
+
+/**
+ * 待响应后清理的字段
+ */
+interface ClearElement extends IBaseElement {
+  fields: FieldElement[];
+}
+export { ClearElement };

package/src/element/ConfigElement.ts

@@ -0,0 +1,7 @@
+import { IBaseElement } from './IBaseElement';
+
+/**
+ * 配置
+ */
+type ConfigElement = IBaseElement;
+export { ConfigElement };

package/src/element/ContextElement.ts

@@ -0,0 +1,10 @@
+import { IBaseElement } from './IBaseElement';
+import { PropElement } from './PropElement';
+
+/**
+ * 上下文，提交数据的时候会转换为variables参数放在请求中
+ */
+interface ContextElement extends IBaseElement {
+  props: PropElement[];
+}
+export { ContextElement };

package/src/element/CustomElement.ts

@@ -0,0 +1,22 @@
+import { IBaseElement } from './IBaseElement';
+
+export abstract class CustomElement {
+  private static nameMap: Map<string, IBaseElement> = new Map();
+
+  private static attributeMap: Map<string, string[]> = new Map();
+
+  public static Name(elementName: string) {
+    return <T extends IBaseElement>(target: T, name: string) => {
+      CustomElement.nameMap.set(elementName, target);
+    };
+  }
+
+  public static AttributeName(attributeName: string) {
+    return <T extends IBaseElement>(target: T, name: string) => {
+      const attrs: string[] = CustomElement.attributeMap.get('elementName') as string[];
+      if (!attrs.includes(attributeName)) {
+        attrs.push(attributeName);
+      }
+    };
+  }
+}

package/src/element/FieldElement.ts

@@ -0,0 +1,41 @@
+import { DataType, LoadType, QueryType } from '../metadata';
+import { WidgetElement } from './WidgetElement';
+
+/**
+ * 字段
+ */
+interface FieldElement extends WidgetElement {
+  // 内容数据的类型
+  dataType: DataType;
+
+  // 绑定内容数据加载函数。
+  load: string;
+  loadType: LoadType;
+  // 列表查询不使用queryPage接口，直传当前选中行数据
+  queryType: QueryType;
+
+  // load函数api定义,可裁剪请求报文 loadApi优先级最高，没有的情况下再找load和loadType
+  loadApi: string;
+
+  // 页面加载时，从页面加载数据load data中获取组件所需可选项数据
+  options: string;
+  optionsLoad: string;
+  optionsLoadType: LoadType;
+  optionsLoadApi: string;
+  // list类型组件调用options-load函数加载数据时作为追加数量限制
+  optionsLimit: number;
+
+  // 正则校验
+  pattern: string;
+  // 校验表达式
+  validation: string;
+  // 校验结果提示
+  tips: string;
+  // 对齐方式
+  align: string;
+  width: string;
+  height: string;
+  // children和textContext只能二选一存在，主要是用再requestElement/responseElement/ClearElement内
+  children: FieldElement[];
+}
+export { FieldElement };

package/src/element/IBaseElement.ts

@@ -0,0 +1,5 @@
+interface IBaseElement {
+  name?: string;
+  textContent?: string;
+}
+export { IBaseElement };

package/src/element/PropElement.ts

@@ -0,0 +1,7 @@
+import { IBaseElement } from './IBaseElement';
+
+/**
+ * 通用属性
+ */
+type PropElement = IBaseElement;
+export { PropElement };

package/src/element/RequestElement.ts

@@ -0,0 +1,10 @@
+import { IBaseElement } from './IBaseElement';
+import { FieldElement } from './FieldElement';
+
+/**
+ * 自定义api的请求
+ */
+interface RequestElement extends IBaseElement {
+  fields: FieldElement[];
+}
+export { RequestElement };

package/src/element/ResponseElement.ts

@@ -0,0 +1,10 @@
+import { IBaseElement } from './IBaseElement';
+import { FieldElement } from './FieldElement';
+
+/**
+ * 自定义api的响应
+ */
+interface ResponseElement extends IBaseElement {
+  fields: FieldElement[];
+}
+export { ResponseElement };

package/src/element/SubscribeElement.ts

@@ -0,0 +1,10 @@
+import { IBaseElement } from './IBaseElement';
+
+/**
+ * 事件订阅
+ */
+interface SubscribeElement extends IBaseElement {
+  api: string;
+  event: string;
+}
+export { SubscribeElement };

package/src/element/ValidationElement.ts

@@ -0,0 +1,17 @@
+import { IBaseElement } from './IBaseElement';
+import { ValidationScope } from '../metadata';
+
+/**
+ * 验证器
+ */
+interface ValidationElement extends IBaseElement {
+  // 校验类型
+  scope: ValidationScope;
+  // 函数校验，出入参为视图当前模型数据
+  fun: string;
+  // 校验表达式
+  expression: string;
+  // 校验结果提示信息
+  tips: string;
+}
+export { ValidationElement };