@geelato/gl-types 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export * from './types/plugin'
+export * from './types/schema/action'
+export * from './types/schema/method'
+export * from './types/schema/componentMeta'
+export * from './types/schema/componentInstance'
+export * from './types/schema/componentMaterial'
+export * from './types/schema/schema'
+export * from './types/ide/ide'

package/dist/types/ide/ide.d.ts

@@ -0,0 +1,70 @@
+export interface IPanel {
+  // 唯一标识
+  name: string;
+  // 显示名称
+  title: string;
+  // 面板图标
+  iconType: string;
+  // 面板对应的全局注册组件名
+  componentName: string;
+  // 面板的顺序，默认为0，值超小的排在前面，值大的排在后面
+  index?: number;
+  // 面板打开的位置，默认为"sidebar"
+  target?: "sidebar" | "blank";
+}
+
+export interface IPanelOptions {
+  title: string;
+  name: string;
+  iconType: string;
+  componentName: string;
+  showSetterPanels?: string[];
+}
+
+/**
+ * 插件接口
+ * 在IDE中，插件是用于扩展IDE功能的模块，可以包含sidebar、stage、setter等面板，以及页面类型与设置面板的映射
+ */
+export interface IIdePlugin {
+  // 插件的名称（唯一标识）
+  name: string;
+  // 插件的版本
+  version: string;
+  // 插件的描述
+  description?: string;
+  // 插件的作者
+  author?: string;
+  // 插件的类型
+  // type?: string
+  // 插件的sidebar面板
+  sidebar: Array<IPanel>;
+  // 插件的stage面板
+  stage: Array<IPanel>;
+  // 插件的setter面板
+  setter: Array<IPanel>;
+  // 页面类型与设置面板的映射，即选择什么页面类型时，相应的面板会被激活。key为pageType如flowPage
+  pageTypeSetterPanelNameMap: Record<string, string[]>;
+
+  // 获取面板
+  getPanels(panelType: string): Array<Panel> | undefined;
+
+  // 添加页面类型与设置面板的映射
+  pushPageTypeAndSetterPanelNames(pageType: string, panelNames: string[]): void;
+
+  // 获取页面类型对应的设置面板名称
+  getSetterPanelNamesByPageType(pageType: string): string[];
+}
+
+/**
+ *  ide.html中，打开idePlugin.html时，会传递一些参数给插件
+ */
+export interface IPluginSetupOptions {
+  // 插件中，作为展示的主组件名称
+  name: string;
+  // 当前应用的id
+  appId: string;
+  // 当前应用的名称
+  appName: string;
+  // 当前的租户编号
+  tenantCode: string;
+}

package/dist/types/plugin.d.ts

@@ -0,0 +1,48 @@
+import type { App } from 'vue'
+import type { AxiosStatic, AxiosInstance } from 'axios'
+
+export interface Item {
+  name: string;
+}
+
+export type ItemStatus = 'uninstalled' | 'installed'
+
+
+export interface IPlugin extends Item{
+  /**
+   *  获取插件名称，唯一标识
+   */
+  name: string
+
+  /**
+   * 插件的版本
+   */
+  version: string
+
+  /**
+   *  插件的加载地址，如果为空，表示采用默认的服务端加载地址
+   */
+  url?: string
+
+  getI18nMessages(): I18nMessages
+
+  install(app: App, options: PluginOptions): void
+
+  uninstall(): void
+}
+
+export interface PluginOptions {
+  axios: AxiosStatic | AxiosInstance
+  ctx?: Record<string, any>
+  router?: any
+  pinia?: any
+
+  [key: string]: any
+}
+
+
+export type I18nMessages = {
+  'zh-CN': Record<string, any>
+  'en-US': Record<string, any>
+  [key: string]: any
+}

package/dist/types/schema/action.d.ts

@@ -0,0 +1,33 @@
+import {IComponentInstance } from './componentInstance'
+
+export interface IAction {
+  id?: string;
+  eventName: string;
+  name: string;
+  title: string;
+  body?: string;
+  __commandBlock?: IComponentInstance;
+}
+
+// 动作、方法调用参数元数据定义
+export interface IParamMeta {
+  // 字段名
+  title: string;
+  // dataIndex
+  name: string;
+  // 是否必需
+  required: boolean;
+  // 类型
+  type: string;
+  // 需要求和的字段名称
+  description?: string;
+  // 详细介绍的文章id
+  docId?: string;
+}
+
+export interface IActionMeta {
+  name: string;                // 必填，类型为 string
+  title: string;               // 必填，类型为 string
+  description?: string;       // 可选，类型为 string
+  params?: IParamMeta[];        // 可选，类型为 ParamMeta[]
+}

package/dist/types/schema/componentInstance.d.ts

@@ -0,0 +1,145 @@
+import {IAction } from './action'
+
+export interface I18nItem {
+  [key: string]: any
+  'zh-CN': string
+  'en-US': string
+}
+
+export interface FieldRule<FieldValue = any> {
+  type?: 'string' | 'number' | 'boolean' | 'array' | 'object' | 'email' | 'url' | 'ip';
+  required?: boolean;
+  message?: string;
+  length?: number;
+  maxLength?: number;
+  minLength?: number;
+  match?: RegExp;
+  uppercase?: boolean;
+  lowercase?: boolean;
+  min?: number;
+  max?: number;
+  equal?: number;
+  positive?: boolean;
+  negative?: boolean;
+  true?: boolean;
+  false?: boolean;
+  includes?: any[];
+  deepEqual?: any;
+  empty?: boolean;
+  hasKeys?: string[];
+  validator?: (value: FieldValue | undefined, callback: (error?: string) => void) => void;
+}
+
+/**
+ * 绑定字段
+ */
+export interface IBindField {
+  appCode: string;
+  entityName: string;
+  fieldName: string;
+}
+
+/**
+ * 绑定实体
+ */
+export interface IBindEntity {
+  appCode: string;
+  entityName: string;
+}
+
+export interface  IComponentInstanceProps {
+  // 标题，如用于formItem的标题
+  label?: string;
+  // 绑定字段，对于输入组件，需要用到该属性
+  bindField?: IBindField;
+
+  // 组件个性化属性
+  [key: string]: any;
+
+  // 占位符
+  placeholder?: string;
+  // 描述
+  description?: string;
+  // 默认值表达式，在值为null或undefined时生效。注：应叫_defaultValue，名称上合理
+  _valueExpression?: any;
+  // 是否禁用
+  disabled?: boolean;
+  // 只读
+  readonly?: boolean;
+  // 是否渲染
+  unRender?: boolean;
+  // 是否隐藏(渲染但不可见)
+  _hidden?: boolean;
+  // 验证规则，适用于表单项组件，如AInput
+  rules?: FieldRule<any> | FieldRule<any>[];
+}
+
+/**
+ *  "__"开头的属性用于以下场景：
+ *  1、动态产生用于内部计算使用
+ *  2、作为源代码属性且不需要在发布运行版本中出现
+ *  在保存为release版本时，"__"开头的属性会被删除掉，以减小文件的大小
+ *  source版本，仍保存该属性信息
+ */
+export interface IComponentInstance {
+  id: string;
+  // 创建id时的id前缀
+  __idPrefix?: string;
+  title?: string;
+  // 子标题，用于在设置面板中展示，特别是用于脚本编排组件中，子标题用于展示该脚本块实例的概要意图用途
+  __subTitle?: string
+  // 备注信息，用于在设置面板中展示，特别是用于脚本编排组件中，描述信息用于展示该脚本块实例的详细用途
+  __remark?: string;
+  componentName: string;
+  // 如dataEntry，可以用来区分是否为表单输入项，在渲染时展示label
+  group?: string;
+  // 组件的值绑定属性名，默认为modelValue，特殊的，如tabs为activeKey
+  vModelName?: string;
+  // 组件属性
+  props: IComponentInstanceProps;
+  // 属性值表达式，通过变量绑定、函数计算等，动态计算属性的值
+  propsExpressions?: IComponentInstanceProps;
+  slots: { [key: string]: any; propsTarget?: string; propsName?: string };
+  // 插槽值表达式，通过变量绑定、函数计算等，动态计算属性的值
+  slotsExpressions?: IComponentInstanceProps;
+  children: IComponentInstance[];
+  actions: IAction[];
+  // 额外，如用于GlCard
+  extra?: IComponentInstance;
+  style?: Object;
+  propsWrapper?: string;
+  // 多语言，表单配置中默认的为zh-CN，这里只需配置en-US，如果需要繁体，则可配置增加zh-TW或zh-HK
+  i18n?: I18nItem[];
+  // 运行时的值，如对于input等表单组件，可用于v-model绑定值
+  value?: undefined | string | number | boolean | object | Array<any>;
+  // 禁用拖放 默认为false，不禁止
+  // 如在渲染工作流画布的场景中，禁止工作流画布可拖动，可设置为true
+  disabledDnd?: boolean;
+  // 如在渲染工作流画布的场景中，禁止选择该组件，如点击选择无效，避免子组件冒泡触发
+  disabledSelect?: boolean;
+  // 映射引用的组件id，这个属性用于图元映射到组件实例的场景，如设计页面是一个工作流程图，图元的id映射到组件refId
+  refId?: string;
+  // 用于组件映射到外部的组件或外部的图元素等。如组件实例为GlPage时，可以在此存储当前页面对应的graph对象
+  refObject?: Object;
+  // 是否禁用，默认为启用，用于设计时
+  _disabled?: boolean;
+  // 是否为模板实例
+  __isTemplateInst?: boolean;
+  // 是否为组件的内置组件
+  __isInnerComponent?: boolean;
+  // 运行时产生，用于指令块组件
+  // 是否为被调用的指令块
+  __isInvokeBlock?: boolean;
+  // 作为被调用的指令块占位符
+  __invokeBlockPlaceholder?: string;
+  // 字段验证之后的错误信息
+  __validateError?: any;
+  // 拖动标识，通过监控该标识的变化，可以判断整个页面是否有变化
+  __dragFlag?: string;
+  // 脚本块
+  __commandBlock?: IComponentInstance;
+  // 组件是否启用权限控制，用于在渲染时，确定是否需要检查权限，perms为空、为r为0或空、w为0或空都表示不需要检查
+  perms?: { r?: number; w?: number };
+  // 组件的权限控制配置，用于设计时配置
+  __perms?: { r: { id: string; name: string; enabled: number }; w: { id: string; name: string; enabled: number } };
+}

package/dist/types/schema/componentMaterial.d.ts

@@ -0,0 +1,44 @@
+import { IComponentInstance } from './componentInstance'
+import { IComponentMeta } from './componentMeta'
+
+export interface IComponentMaterial {
+  /**
+   * 物料全局id，material开头，16位
+   */
+  gid: string;
+
+  /**
+   * 组件名称，必填
+   */
+  componentName: string;
+
+  /**
+   * 图标类型，未设置时，默认取componentName对应组件元数据的值
+   */
+  iconType?: string;
+
+  /**
+   * 分组，未设置时，默认取componentName对应组件元数据的值
+   */
+  group?: string;
+
+  /**
+   * 标题，未设置时，默认取componentName对应组件元数据的值
+   */
+  title?: string;
+
+  /**
+   * 使用方，默认为空数组
+   */
+  useBy: string[];
+
+  /**
+   * 该物料的组件实例示例
+   */
+  instance: IComponentInstance | {};
+
+  /**
+   * 该物料的组件元数据定义
+   */
+  meta: IComponentMeta;
+}

package/dist/types/schema/componentMeta.d.ts

@@ -0,0 +1,219 @@
+import { IActionMeta, IParamMeta } from './action'
+import { IReturnInfoMeta } from './method'
+/**
+ *  记录组件中哪些信息需要进行多语言配置
+ *  同时定义多语言信息
+ */
+export interface IComponentI18nMeta {
+  props?: Record<string, string>
+}
+
+/**
+ *  组件的内置组件在整个组件实例配置文件中的位置定义
+ */
+export interface IInnerComponentPosition {
+  title: string
+  // 访问的属性路径如 x?.y?.z
+  propPath: string
+  // 通过一个函数来获取，输入为基于path获取的节点数据，用于处理复杂的内置组件场景，如果配置了该pathFn，则以此为准
+  // (data)=>{return []}
+  // propPathFn?: Function = undefined
+  // 如果没有组件时，该内置组件是否被忽略，如在列表的数据列中，有些列可能会有组件，有些列则没有，若没有可以忽略，而不报错。
+  ignoreWhenNoComponent?: boolean
+}
+
+export interface IStyleSetterMeta{
+
+}
+
+export interface ISetterComponentPropsMeta {
+  // 配置的数据内容
+  dataItems?: Array<any>
+  [key: string]: any;
+}
+
+export interface IPropertySetterMeta {
+  // 属性名
+  name: String
+
+  // 属性标题
+  title: String
+
+  // 分组,用于在设置面板中分组展示，包括：base 基础 | view 外观 | 数据 data
+  group: String
+
+  // 类型默认为normal， props 普通 | slots 插槽 | children 子组件 | innerHTML | JsonArray | JsonObject
+  type?: String
+
+  // 占位符
+  placeholder?: String
+  
+  // 配置器组件名称
+  setterComponentName: string
+
+  // 配置器组件属性
+  setterComponentProps: ISetterComponentPropsMeta
+
+  // 配置器组件样式
+  setterComponentStyle?: IStyleSetterMeta
+
+  // 配置器组件容器样式
+  setterContainerStyle?: IStyleSetterMeta
+
+  // 启用配置器级件容器默认的内边距，默认不需要启用，若启用，则配置器组件容器内边距为8px
+  enableSetterContainerPadding?: boolean
+
+  // 配置器组件默认值
+  setterDefaultValue?: any
+  
+  setterComponentDefaultValue?: any
+
+  // 是否在设置面板中展示，不显示时，常与默认值配合使用
+  show?: Boolean
+
+  // 展示模式 tile | collapse
+  displayMode?: String
+
+  // 绑定的值字段名称, 如 value、checked、modelValue
+  setterComponentVModelName?: String
+
+  // 样式
+  style?: IStyleSetterMeta
+
+  // 是否可以展开 TODO
+  expanded?: Boolean
+
+  // 配置的数据内容
+  dataItems?: Array<any>
+
+  // 属性描述，用于在配置属性时，可以了解该属性的详细信息
+  description?: String
+
+  // 子属性，适用于Json结构配置的组件，如echarts中的组件
+  properties?: Array<IPropertySetterMeta>
+
+  // 默认值，可用于压缩配置文件时，检查是否等于默认值，若等于默认值，则可以删除该配置的属性
+  defaultValue?: any
+
+  // 在属性设置器中，若该属性为数组对象属性时，指定数组中对象的某一属性作为标题
+  titleField?: String
+
+  // 子标题，与titleField配合使用
+  subTitleField?: String
+
+  // 配置了子标题字段，但获取不到子标题时告警
+  alarmIfNoSubTitle?: string;
+
+  // type为slots时有值
+  slotComponentName?: String
+
+  // 将配置该的结果绑定到槽渲染组件的v-model中还是v-bind中,默认为v-model
+  slotComponentBindTarget?: String
+
+  // 绑定的名称xxxName，结合slotComponentBindTarget使用，如v-bind:xxxName，v-model:xxxName
+  slotComponentBindName?: String
+
+  subComponentName?: String;
+
+  subComponentCount?: Number
+
+  // 是否启用值表达式，用于结合上下文的信息、相关逻辑计算得出value
+  enableValueExpress?: Boolean
+
+  // 是否为变量属性，脚本编排中使用
+  isBlockVarProp?:boolean
+
+  // 属性表达式，用于在配置属性时，在配置组件属性时，可以基于该属性表达式的值，来控制组件的属性值
+  // 如：{
+  //   "show": "$.aProp.value === '1'"
+  // }
+  // 其中$.aProp.value 表示获取aProp的value值，如果aProp的值为1，则show为true，否则为false
+  // 用应场景，如A属性选择了M类型时，B属性可以显示，否则隐藏等
+  propsExpressions?:Record<string,any>
+
+  // 规则，用于在配置属性时，可以控制属性是否为必填
+  // {
+  //   "type": "boolean",
+  //   "required": true,
+  //   "ruleName": "required",
+  //   "message": "必填"
+  // },
+  // {
+  //   "type": "string",
+  //   "_RuleExpression": "1=1",
+  //   "ruleName": "_RuleExpression"
+  // }
+  rules?:Array<any>
+
+}
+
+
+
+export interface IMethodMeta {
+  // 是否为异步的方法，异步方法返回类型为Promise<any>
+  async?: boolean;
+  name: string; // "fetchSuccess"
+  title: string; // "成功加载完数据"
+  description?: string; // 从服务端成功加数据（0到多条）后触发。
+  params?: IParamMeta[];
+  defaultValue?: any; // 默认值在接口中通常不指定具体类型，除非有必要
+  returnInfo?: IReturnInfoMeta;
+  // 是否动态参数，可用于控制配置页面，展示可添加参数的功能
+  isDynamicParams?: boolean;
+}
+
+export type TechType = 'h5pc' | 'h5mobile' | 'mpWechat' | 'mpAlipay' | 'mpBaidu';
+
+export interface IComponentMeta {
+  // 组件英文名称，注册到全局环境的名称GlButton
+  componentName: string;
+  // 组件中文名称
+  title: string;
+  // 组件类型，h5pc、h5mobile、mpWechat、mpAlipay、mpBaidu...，默认为h5pc
+  type?: TechType;
+  // 是否在组件选择栏中显示
+  show?: boolean;
+  // 组件的值绑定属性名，默认为modelValue,特殊的，如tabs为activeKey
+  vModelName?: string;
+  // 在舞台中是以块状还是行内样式进行展示
+  displayOnStage?: string;
+  // 在属性配置面板中，是以哪种模式来展示属性，值为：Tile|Collapse
+  displayMode: string;
+  // 组件图标
+  iconType: string;
+  // 组件分组，用于在组件选择栏目中进行区分，如form、base
+  group: string;
+  // 使用于哪些类型的页面，如Page、Dbm...，以便于在编辑相应的页面时从sidebar中过滤掉不合适的组件
+  useBy: string[];
+  // 属性数组
+  properties: IPropertySetterMeta[];
+  // 记录需要进行多语言翻译的字段
+  i18n?: IComponentI18nMeta;
+  // 事件动作
+  actions?: IActionMeta[];
+  // 组件方法，对应组件defineExpose的内容
+  methods?: IMethodMeta[];
+  // 引用的组件名称，如AButton
+  propsWrapper?: string;
+  // 别名简称，用于在生成id时作为前缀
+  alias?: string;
+  // 为作命令块组件时，在设计器中，展示的描述该命令块的。
+  // 如：打开第三方网页，地址为：{url}。其中url为属性properties中的其中一直属性，在展示时动态渲染
+  // 如果blockContent的默认以 @language开始，即格式为 @language:xxx 则需进行格式化显示
+  blockContent?: string;
+  // 块内容的语言，如javascript，默认为空，表示普通的文本
+  blockContentLanguage?: string;
+  // 块中表示变量名的属性，如：varsName，以便于配置时，可以依据该属性名，获取在真实的变量名
+  blockVarNameProps?: string[];
+  // 用于设计时，标识是否弃用true，默认为启用即false。弃用时，在sidebar中不可以选择，但在已应用的页面中还可以使用
+  deprecated?: boolean;
+  /**
+   *  该组件内置的组件说明
+   *
+   */
+  innerComponents?: IInnerComponentPosition[];
+  /**
+   *  组件的描述
+   */
+  description?: string;
+}

package/dist/types/schema/method.d.ts

@@ -0,0 +1,46 @@
+import { IParamMeta } from './action';
+
+/**
+ * 方法参数元数据
+ */
+export interface IMethodParamMeta {
+  name: string;
+  title: string;
+  // 默认值
+  defaultValue?: any;
+  type: string;
+  description: string;
+}
+
+export interface IReturnInfoMeta {
+  // 如string | number | string[] 等
+  returnType: string;
+  // 对返回的内容进行补充描述
+  description: string;
+  // 内部的文档指引中的文档id
+  docId?: string;
+}
+
+export interface IMethodSetterMeta {
+  // 方法名
+  name: string;
+  title: string;
+  description?: string;
+  params: IMethodParamMeta[];
+  returnInfo: IReturnInfoMeta;
+}
+
+export interface IMethodDefinition {
+  // 是否为异步的方法，异步方法返回类型为Promise<any>
+  async?: boolean;
+  name: string;
+  title: string;
+  description?: string;
+  params?: IParamMeta[];
+  defaultValue?: any;
+  returnInfo?: IReturnInfoMeta;
+  // 是否动态参数，可用于控制配置页面，展示可添加参数的功能
+  isDynamicParams?: boolean;
+}
+
+export type ValueTypes = 'String' | 'Boolean' | 'Expression' | 'Number' | 'Array' | 'Object' | 'Dict';

package/dist/types/schema/schema.d.ts

@@ -0,0 +1,11 @@
+import {IComponentMeta } from './componentMeta'
+import {IComponentInstance } from './componentInstance'
+import { Item } from '../plugin'
+export interface ISchema extends Item{
+  /**
+   *  一般取和插件一致的名称
+   */
+  name: string
+  componentMetas: IComponentMeta[]
+  customInstances: IComponentInstance[]
+}

package/index.d.ts

@@ -0,0 +1,8 @@
+export * from './types/plugin'
+export * from './types/schema/action'
+export * from './types/schema/method'
+export * from './types/schema/componentMeta'
+export * from './types/schema/componentInstance'
+export * from './types/schema/componentMaterial'
+export * from './types/schema/schema'
+export * from './types/ide/ide'

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@geelato/gl-types",
+  "version": "1.0.0",
+  "types": "dist/index.d.ts",
+  "main": "dist/index.d.ts",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "dependencies": {
+    "axios": "1.8.3",
+    "pinia": "3.0.1",
+    "vue": "3.5.13"
+  },
+  "devDependencies": {
+    "@types/node": "22.13.9",
+    "chokidar": "^4.0.3",
+    "dts-bundle-generator": "9.5.1",
+    "ts-node": "10.9.2"
+  },
+  "scripts": {
+    "build": "node scripts/build.js",
+    "watch": "node scripts/watch.js",
+    "dev": "node scripts/watch.js",
+    "type-check": "tsc --noEmit",
+    "test-types": "tsc --noEmit dist/__tests__/type-test.ts",
+    "test": "tsc --noEmit && echo '✅ 类型检查通过'"
+  }
+}

package/types/ide/ide.d.ts

@@ -0,0 +1,70 @@
+export interface IPanel {
+  // 唯一标识
+  name: string;
+  // 显示名称
+  title: string;
+  // 面板图标
+  iconType: string;
+  // 面板对应的全局注册组件名
+  componentName: string;
+  // 面板的顺序，默认为0，值超小的排在前面，值大的排在后面
+  index?: number;
+  // 面板打开的位置，默认为"sidebar"
+  target?: "sidebar" | "blank";
+}
+
+export interface IPanelOptions {
+  title: string;
+  name: string;
+  iconType: string;
+  componentName: string;
+  showSetterPanels?: string[];
+}
+
+/**
+ * 插件接口
+ * 在IDE中，插件是用于扩展IDE功能的模块，可以包含sidebar、stage、setter等面板，以及页面类型与设置面板的映射
+ */
+export interface IIdePlugin {
+  // 插件的名称（唯一标识）
+  name: string;
+  // 插件的版本
+  version: string;
+  // 插件的描述
+  description?: string;
+  // 插件的作者
+  author?: string;
+  // 插件的类型
+  // type?: string
+  // 插件的sidebar面板
+  sidebar: Array<IPanel>;
+  // 插件的stage面板
+  stage: Array<IPanel>;
+  // 插件的setter面板
+  setter: Array<IPanel>;
+  // 页面类型与设置面板的映射，即选择什么页面类型时，相应的面板会被激活。key为pageType如flowPage
+  pageTypeSetterPanelNameMap: Record<string, string[]>;
+
+  // 获取面板
+  getPanels(panelType: string): Array<Panel> | undefined;
+
+  // 添加页面类型与设置面板的映射
+  pushPageTypeAndSetterPanelNames(pageType: string, panelNames: string[]): void;
+
+  // 获取页面类型对应的设置面板名称
+  getSetterPanelNamesByPageType(pageType: string): string[];
+}
+
+/**
+ *  ide.html中，打开idePlugin.html时，会传递一些参数给插件
+ */
+export interface IPluginSetupOptions {
+  // 插件中，作为展示的主组件名称
+  name: string;
+  // 当前应用的id
+  appId: string;
+  // 当前应用的名称
+  appName: string;
+  // 当前的租户编号
+  tenantCode: string;
+}

package/types/plugin.d.ts

@@ -0,0 +1,48 @@
+import type { App } from 'vue'
+import type { AxiosStatic, AxiosInstance } from 'axios'
+
+export interface Item {
+  name: string;
+}
+
+export type ItemStatus = 'uninstalled' | 'installed'
+
+
+export interface IPlugin extends Item{
+  /**
+   *  获取插件名称，唯一标识
+   */
+  name: string
+
+  /**
+   * 插件的版本
+   */
+  version: string
+
+  /**
+   *  插件的加载地址，如果为空，表示采用默认的服务端加载地址
+   */
+  url?: string
+
+  getI18nMessages(): I18nMessages
+
+  install(app: App, options: PluginOptions): void
+
+  uninstall(): void
+}
+
+export interface PluginOptions {
+  axios: AxiosStatic | AxiosInstance
+  ctx?: Record<string, any>
+  router?: any
+  pinia?: any
+
+  [key: string]: any
+}
+
+
+export type I18nMessages = {
+  'zh-CN': Record<string, any>
+  'en-US': Record<string, any>
+  [key: string]: any
+}

package/types/schema/action.d.ts

@@ -0,0 +1,33 @@
+import {IComponentInstance } from './componentInstance'
+
+export interface IAction {
+  id?: string;
+  eventName: string;
+  name: string;
+  title: string;
+  body?: string;
+  __commandBlock?: IComponentInstance;
+}
+
+// 动作、方法调用参数元数据定义
+export interface IParamMeta {
+  // 字段名
+  title: string;
+  // dataIndex
+  name: string;
+  // 是否必需
+  required: boolean;
+  // 类型
+  type: string;
+  // 需要求和的字段名称
+  description?: string;
+  // 详细介绍的文章id
+  docId?: string;
+}
+
+export interface IActionMeta {
+  name: string;                // 必填，类型为 string
+  title: string;               // 必填，类型为 string
+  description?: string;       // 可选，类型为 string
+  params?: IParamMeta[];        // 可选，类型为 ParamMeta[]
+}

package/types/schema/componentInstance.d.ts

@@ -0,0 +1,145 @@
+import {IAction } from './action'
+
+export interface I18nItem {
+  [key: string]: any
+  'zh-CN': string
+  'en-US': string
+}
+
+export interface FieldRule<FieldValue = any> {
+  type?: 'string' | 'number' | 'boolean' | 'array' | 'object' | 'email' | 'url' | 'ip';
+  required?: boolean;
+  message?: string;
+  length?: number;
+  maxLength?: number;
+  minLength?: number;
+  match?: RegExp;
+  uppercase?: boolean;
+  lowercase?: boolean;
+  min?: number;
+  max?: number;
+  equal?: number;
+  positive?: boolean;
+  negative?: boolean;
+  true?: boolean;
+  false?: boolean;
+  includes?: any[];
+  deepEqual?: any;
+  empty?: boolean;
+  hasKeys?: string[];
+  validator?: (value: FieldValue | undefined, callback: (error?: string) => void) => void;
+}
+
+/**
+ * 绑定字段
+ */
+export interface IBindField {
+  appCode: string;
+  entityName: string;
+  fieldName: string;
+}
+
+/**
+ * 绑定实体
+ */
+export interface IBindEntity {
+  appCode: string;
+  entityName: string;
+}
+
+export interface  IComponentInstanceProps {
+  // 标题，如用于formItem的标题
+  label?: string;
+  // 绑定字段，对于输入组件，需要用到该属性
+  bindField?: IBindField;
+
+  // 组件个性化属性
+  [key: string]: any;
+
+  // 占位符
+  placeholder?: string;
+  // 描述
+  description?: string;
+  // 默认值表达式，在值为null或undefined时生效。注：应叫_defaultValue，名称上合理
+  _valueExpression?: any;
+  // 是否禁用
+  disabled?: boolean;
+  // 只读
+  readonly?: boolean;
+  // 是否渲染
+  unRender?: boolean;
+  // 是否隐藏(渲染但不可见)
+  _hidden?: boolean;
+  // 验证规则，适用于表单项组件，如AInput
+  rules?: FieldRule<any> | FieldRule<any>[];
+}
+
+/**
+ *  "__"开头的属性用于以下场景：
+ *  1、动态产生用于内部计算使用
+ *  2、作为源代码属性且不需要在发布运行版本中出现
+ *  在保存为release版本时，"__"开头的属性会被删除掉，以减小文件的大小
+ *  source版本，仍保存该属性信息
+ */
+export interface IComponentInstance {
+  id: string;
+  // 创建id时的id前缀
+  __idPrefix?: string;
+  title?: string;
+  // 子标题，用于在设置面板中展示，特别是用于脚本编排组件中，子标题用于展示该脚本块实例的概要意图用途
+  __subTitle?: string
+  // 备注信息，用于在设置面板中展示，特别是用于脚本编排组件中，描述信息用于展示该脚本块实例的详细用途
+  __remark?: string;
+  componentName: string;
+  // 如dataEntry，可以用来区分是否为表单输入项，在渲染时展示label
+  group?: string;
+  // 组件的值绑定属性名，默认为modelValue，特殊的，如tabs为activeKey
+  vModelName?: string;
+  // 组件属性
+  props: IComponentInstanceProps;
+  // 属性值表达式，通过变量绑定、函数计算等，动态计算属性的值
+  propsExpressions?: IComponentInstanceProps;
+  slots: { [key: string]: any; propsTarget?: string; propsName?: string };
+  // 插槽值表达式，通过变量绑定、函数计算等，动态计算属性的值
+  slotsExpressions?: IComponentInstanceProps;
+  children: IComponentInstance[];
+  actions: IAction[];
+  // 额外，如用于GlCard
+  extra?: IComponentInstance;
+  style?: Object;
+  propsWrapper?: string;
+  // 多语言，表单配置中默认的为zh-CN，这里只需配置en-US，如果需要繁体，则可配置增加zh-TW或zh-HK
+  i18n?: I18nItem[];
+  // 运行时的值，如对于input等表单组件，可用于v-model绑定值
+  value?: undefined | string | number | boolean | object | Array<any>;
+  // 禁用拖放 默认为false，不禁止
+  // 如在渲染工作流画布的场景中，禁止工作流画布可拖动，可设置为true
+  disabledDnd?: boolean;
+  // 如在渲染工作流画布的场景中，禁止选择该组件，如点击选择无效，避免子组件冒泡触发
+  disabledSelect?: boolean;
+  // 映射引用的组件id，这个属性用于图元映射到组件实例的场景，如设计页面是一个工作流程图，图元的id映射到组件refId
+  refId?: string;
+  // 用于组件映射到外部的组件或外部的图元素等。如组件实例为GlPage时，可以在此存储当前页面对应的graph对象
+  refObject?: Object;
+  // 是否禁用，默认为启用，用于设计时
+  _disabled?: boolean;
+  // 是否为模板实例
+  __isTemplateInst?: boolean;
+  // 是否为组件的内置组件
+  __isInnerComponent?: boolean;
+  // 运行时产生，用于指令块组件
+  // 是否为被调用的指令块
+  __isInvokeBlock?: boolean;
+  // 作为被调用的指令块占位符
+  __invokeBlockPlaceholder?: string;
+  // 字段验证之后的错误信息
+  __validateError?: any;
+  // 拖动标识，通过监控该标识的变化，可以判断整个页面是否有变化
+  __dragFlag?: string;
+  // 脚本块
+  __commandBlock?: IComponentInstance;
+  // 组件是否启用权限控制，用于在渲染时，确定是否需要检查权限，perms为空、为r为0或空、w为0或空都表示不需要检查
+  perms?: { r?: number; w?: number };
+  // 组件的权限控制配置，用于设计时配置
+  __perms?: { r: { id: string; name: string; enabled: number }; w: { id: string; name: string; enabled: number } };
+}

package/types/schema/componentMaterial.d.ts

@@ -0,0 +1,44 @@
+import { IComponentInstance } from './componentInstance'
+import { IComponentMeta } from './componentMeta'
+
+export interface IComponentMaterial {
+  /**
+   * 物料全局id，material开头，16位
+   */
+  gid: string;
+
+  /**
+   * 组件名称，必填
+   */
+  componentName: string;
+
+  /**
+   * 图标类型，未设置时，默认取componentName对应组件元数据的值
+   */
+  iconType?: string;
+
+  /**
+   * 分组，未设置时，默认取componentName对应组件元数据的值
+   */
+  group?: string;
+
+  /**
+   * 标题，未设置时，默认取componentName对应组件元数据的值
+   */
+  title?: string;
+
+  /**
+   * 使用方，默认为空数组
+   */
+  useBy: string[];
+
+  /**
+   * 该物料的组件实例示例
+   */
+  instance: IComponentInstance | {};
+
+  /**
+   * 该物料的组件元数据定义
+   */
+  meta: IComponentMeta;
+}

package/types/schema/componentMeta.d.ts

@@ -0,0 +1,219 @@
+import { IActionMeta, IParamMeta } from './action'
+import { IReturnInfoMeta } from './method'
+/**
+ *  记录组件中哪些信息需要进行多语言配置
+ *  同时定义多语言信息
+ */
+export interface IComponentI18nMeta {
+  props?: Record<string, string>
+}
+
+/**
+ *  组件的内置组件在整个组件实例配置文件中的位置定义
+ */
+export interface IInnerComponentPosition {
+  title: string
+  // 访问的属性路径如 x?.y?.z
+  propPath: string
+  // 通过一个函数来获取，输入为基于path获取的节点数据，用于处理复杂的内置组件场景，如果配置了该pathFn，则以此为准
+  // (data)=>{return []}
+  // propPathFn?: Function = undefined
+  // 如果没有组件时，该内置组件是否被忽略，如在列表的数据列中，有些列可能会有组件，有些列则没有，若没有可以忽略，而不报错。
+  ignoreWhenNoComponent?: boolean
+}
+
+export interface IStyleSetterMeta{
+
+}
+
+export interface ISetterComponentPropsMeta {
+  // 配置的数据内容
+  dataItems?: Array<any>
+  [key: string]: any;
+}
+
+export interface IPropertySetterMeta {
+  // 属性名
+  name: String
+
+  // 属性标题
+  title: String
+
+  // 分组,用于在设置面板中分组展示，包括：base 基础 | view 外观 | 数据 data
+  group: String
+
+  // 类型默认为normal， props 普通 | slots 插槽 | children 子组件 | innerHTML | JsonArray | JsonObject
+  type?: String
+
+  // 占位符
+  placeholder?: String
+  
+  // 配置器组件名称
+  setterComponentName: string
+
+  // 配置器组件属性
+  setterComponentProps: ISetterComponentPropsMeta
+
+  // 配置器组件样式
+  setterComponentStyle?: IStyleSetterMeta
+
+  // 配置器组件容器样式
+  setterContainerStyle?: IStyleSetterMeta
+
+  // 启用配置器级件容器默认的内边距，默认不需要启用，若启用，则配置器组件容器内边距为8px
+  enableSetterContainerPadding?: boolean
+
+  // 配置器组件默认值
+  setterDefaultValue?: any
+  
+  setterComponentDefaultValue?: any
+
+  // 是否在设置面板中展示，不显示时，常与默认值配合使用
+  show?: Boolean
+
+  // 展示模式 tile | collapse
+  displayMode?: String
+
+  // 绑定的值字段名称, 如 value、checked、modelValue
+  setterComponentVModelName?: String
+
+  // 样式
+  style?: IStyleSetterMeta
+
+  // 是否可以展开 TODO
+  expanded?: Boolean
+
+  // 配置的数据内容
+  dataItems?: Array<any>
+
+  // 属性描述，用于在配置属性时，可以了解该属性的详细信息
+  description?: String
+
+  // 子属性，适用于Json结构配置的组件，如echarts中的组件
+  properties?: Array<IPropertySetterMeta>
+
+  // 默认值，可用于压缩配置文件时，检查是否等于默认值，若等于默认值，则可以删除该配置的属性
+  defaultValue?: any
+
+  // 在属性设置器中，若该属性为数组对象属性时，指定数组中对象的某一属性作为标题
+  titleField?: String
+
+  // 子标题，与titleField配合使用
+  subTitleField?: String
+
+  // 配置了子标题字段，但获取不到子标题时告警
+  alarmIfNoSubTitle?: string;
+
+  // type为slots时有值
+  slotComponentName?: String
+
+  // 将配置该的结果绑定到槽渲染组件的v-model中还是v-bind中,默认为v-model
+  slotComponentBindTarget?: String
+
+  // 绑定的名称xxxName，结合slotComponentBindTarget使用，如v-bind:xxxName，v-model:xxxName
+  slotComponentBindName?: String
+
+  subComponentName?: String;
+
+  subComponentCount?: Number
+
+  // 是否启用值表达式，用于结合上下文的信息、相关逻辑计算得出value
+  enableValueExpress?: Boolean
+
+  // 是否为变量属性，脚本编排中使用
+  isBlockVarProp?:boolean
+
+  // 属性表达式，用于在配置属性时，在配置组件属性时，可以基于该属性表达式的值，来控制组件的属性值
+  // 如：{
+  //   "show": "$.aProp.value === '1'"
+  // }
+  // 其中$.aProp.value 表示获取aProp的value值，如果aProp的值为1，则show为true，否则为false
+  // 用应场景，如A属性选择了M类型时，B属性可以显示，否则隐藏等
+  propsExpressions?:Record<string,any>
+
+  // 规则，用于在配置属性时，可以控制属性是否为必填
+  // {
+  //   "type": "boolean",
+  //   "required": true,
+  //   "ruleName": "required",
+  //   "message": "必填"
+  // },
+  // {
+  //   "type": "string",
+  //   "_RuleExpression": "1=1",
+  //   "ruleName": "_RuleExpression"
+  // }
+  rules?:Array<any>
+
+}
+
+
+
+export interface IMethodMeta {
+  // 是否为异步的方法，异步方法返回类型为Promise<any>
+  async?: boolean;
+  name: string; // "fetchSuccess"
+  title: string; // "成功加载完数据"
+  description?: string; // 从服务端成功加数据（0到多条）后触发。
+  params?: IParamMeta[];
+  defaultValue?: any; // 默认值在接口中通常不指定具体类型，除非有必要
+  returnInfo?: IReturnInfoMeta;
+  // 是否动态参数，可用于控制配置页面，展示可添加参数的功能
+  isDynamicParams?: boolean;
+}
+
+export type TechType = 'h5pc' | 'h5mobile' | 'mpWechat' | 'mpAlipay' | 'mpBaidu';
+
+export interface IComponentMeta {
+  // 组件英文名称，注册到全局环境的名称GlButton
+  componentName: string;
+  // 组件中文名称
+  title: string;
+  // 组件类型，h5pc、h5mobile、mpWechat、mpAlipay、mpBaidu...，默认为h5pc
+  type?: TechType;
+  // 是否在组件选择栏中显示
+  show?: boolean;
+  // 组件的值绑定属性名，默认为modelValue,特殊的，如tabs为activeKey
+  vModelName?: string;
+  // 在舞台中是以块状还是行内样式进行展示
+  displayOnStage?: string;
+  // 在属性配置面板中，是以哪种模式来展示属性，值为：Tile|Collapse
+  displayMode: string;
+  // 组件图标
+  iconType: string;
+  // 组件分组，用于在组件选择栏目中进行区分，如form、base
+  group: string;
+  // 使用于哪些类型的页面，如Page、Dbm...，以便于在编辑相应的页面时从sidebar中过滤掉不合适的组件
+  useBy: string[];
+  // 属性数组
+  properties: IPropertySetterMeta[];
+  // 记录需要进行多语言翻译的字段
+  i18n?: IComponentI18nMeta;
+  // 事件动作
+  actions?: IActionMeta[];
+  // 组件方法，对应组件defineExpose的内容
+  methods?: IMethodMeta[];
+  // 引用的组件名称，如AButton
+  propsWrapper?: string;
+  // 别名简称，用于在生成id时作为前缀
+  alias?: string;
+  // 为作命令块组件时，在设计器中，展示的描述该命令块的。
+  // 如：打开第三方网页，地址为：{url}。其中url为属性properties中的其中一直属性，在展示时动态渲染
+  // 如果blockContent的默认以 @language开始，即格式为 @language:xxx 则需进行格式化显示
+  blockContent?: string;
+  // 块内容的语言，如javascript，默认为空，表示普通的文本
+  blockContentLanguage?: string;
+  // 块中表示变量名的属性，如：varsName，以便于配置时，可以依据该属性名，获取在真实的变量名
+  blockVarNameProps?: string[];
+  // 用于设计时，标识是否弃用true，默认为启用即false。弃用时，在sidebar中不可以选择，但在已应用的页面中还可以使用
+  deprecated?: boolean;
+  /**
+   *  该组件内置的组件说明
+   *
+   */
+  innerComponents?: IInnerComponentPosition[];
+  /**
+   *  组件的描述
+   */
+  description?: string;
+}

package/types/schema/method.d.ts

@@ -0,0 +1,46 @@
+import { IParamMeta } from './action';
+
+/**
+ * 方法参数元数据
+ */
+export interface IMethodParamMeta {
+  name: string;
+  title: string;
+  // 默认值
+  defaultValue?: any;
+  type: string;
+  description: string;
+}
+
+export interface IReturnInfoMeta {
+  // 如string | number | string[] 等
+  returnType: string;
+  // 对返回的内容进行补充描述
+  description: string;
+  // 内部的文档指引中的文档id
+  docId?: string;
+}
+
+export interface IMethodSetterMeta {
+  // 方法名
+  name: string;
+  title: string;
+  description?: string;
+  params: IMethodParamMeta[];
+  returnInfo: IReturnInfoMeta;
+}
+
+export interface IMethodDefinition {
+  // 是否为异步的方法，异步方法返回类型为Promise<any>
+  async?: boolean;
+  name: string;
+  title: string;
+  description?: string;
+  params?: IParamMeta[];
+  defaultValue?: any;
+  returnInfo?: IReturnInfoMeta;
+  // 是否动态参数，可用于控制配置页面，展示可添加参数的功能
+  isDynamicParams?: boolean;
+}
+
+export type ValueTypes = 'String' | 'Boolean' | 'Expression' | 'Number' | 'Array' | 'Object' | 'Dict';

package/types/schema/schema.d.ts

@@ -0,0 +1,11 @@
+import {IComponentMeta } from './componentMeta'
+import {IComponentInstance } from './componentInstance'
+import { Item } from '../plugin'
+export interface ISchema extends Item{
+  /**
+   *  一般取和插件一致的名称
+   */
+  name: string
+  componentMetas: IComponentMeta[]
+  customInstances: IComponentInstance[]
+}