@cloudbase/cals 1.1.14 → 1.2.0

package/lib/esm/types/platform/component.d.ts

@@ -0,0 +1,166 @@
+import * as Basic from '../basic/component';
+import type { ICodeResource, IPlatformDataset, IPlatformListener } from './common';
+import type { IDataSourceVariable } from './datasource';
+type Values<T> = T[keyof T];
+/**
+ * 组件类型
+ */
+export declare const EComponentType: {
+    readonly BASIC: "BASIC";
+    readonly COMPLEX: "COMPLEX";
+    readonly PAGE: "PAGE";
+};
+/**
+ * @additionalProperties true
+ */
+export interface IPlatformAttributes extends Basic.IAttributes {
+    /**
+     * 可选, 皮肤
+     */
+    theme?: string;
+}
+/**
+ * 云开发低码平台组件
+ */
+export interface IPlatformComponent extends Omit<Basic.IBaseComponent, 'value' | 'valueFilterNam' | 'validity' | 'attributes' | 'events'> {
+    /**
+     * 可选, 组件控制属性
+     */
+    attributes?: IPlatformAttributes;
+    /**
+     * 选填, 组件类型
+     */
+    type?: Values<typeof EComponentType>;
+    /**
+     * 可选, 组件绑定的监听器
+     */
+    listeners?: IPlatformListener[];
+    /**
+     * 可选，平台实现有关字段
+     */
+    extra?: IPlatformComponentExtra;
+    items?: IPlatformComponent[];
+}
+export interface IPlatformComponentExtra {
+    /**
+     * 可选，样式分组配置
+     * @example { self: {}, margin: {}, text: {}, custom: [] }
+     */
+    commonStyle?: object;
+    /**
+     * @deprecated
+     * 可选，组件顺序 formily x-index
+     * https://github.com/alibaba/formily/blob/master/packages/react-schema-renderer/README.md
+     */
+    xIndex?: number;
+    staticResourceAttribute?: string[];
+    /**
+     * style bind path
+     */
+    styleBindPath?: string;
+    /**
+     * @deprecated
+     * 是否再门户网站中的菜单中隐藏页面对应的菜单项
+     * 菜单由单独的菜单配置管理，此处不再使用
+     */
+    hideAdminPortalMenu?: boolean;
+    /**
+     * 属性绑定的额外补充信息
+     */
+    attributeExtraData?: {
+        [key: string]: any;
+    };
+    /**
+     * 组件是否处于锚定状态？
+     *
+     * *针对非叶子节点的组件（如容器），如有 `anchored` 标记，则在预览区可优先被选中*
+     */
+    anchored?: boolean;
+    /**
+     * 自定义数据表单 JSON Schema
+     *
+     * *该字段会和组件库中对应组件声明的 dataForm 合并处理，同时覆盖同名字段配置，最终供 formily 消费*
+     */
+    dataForm?: {
+        [key: string]: {
+            type: string;
+            title: string;
+            [key: string]: any;
+        };
+    };
+    /**
+     * 表示当前节点源于开发态引用关系
+     */
+    ref?: string;
+    /**
+     * 引用节点的初始属性
+     * 冗余记录为了diff
+     */
+    refAttributes?: IPlatformAttributes;
+    /**
+     * 表示需要引用外部/本地资源
+     */
+    include?: string[];
+}
+/**
+ * 默认组件, 由平台提供的组件
+ */
+export interface IBasicComponent extends IPlatformComponent {
+    type?: 'BASIC';
+}
+/**
+ * 自定义组件, 开发者组合已有的默认组件, 得到的新组件
+ */
+export interface IComplexComponent extends IPlatformComponent {
+    type?: 'COMPLEX';
+    id: string;
+}
+/**
+ * 页面组件, 描述整个页面的组件
+ */
+export interface IPageComponent extends Omit<IPlatformComponent, 'events'> {
+    type: 'PAGE';
+    /** 页面 ID，对应页面 path */
+    id: string;
+    items?: IPlatformComponent[];
+    /**
+     * 可选, 变量集合
+     */
+    dataset?: IPlatformDataset;
+    /**
+     * 可选, 数据源变量集合
+     *
+     * @deprecated
+     */
+    dataVariables?: IDataSourceVariable[];
+    /**
+     * 可选, 页面的资源集合
+     *
+     * 页面级别只挂载了 code 资源
+     */
+    resources?: ICodeResource[];
+}
+export interface IPageComponentLifeCycle extends Basic.IEvents {
+    /**
+     * 可选，onShow 钩子函数名称
+     */
+    lifecycleOnShowEventName?: string;
+    /**
+     * 可选，onLoad 钩子函数名称
+     */
+    lifecycleOnLoadEventName?: string;
+    /**
+     * 可选，onReady 钩子函数名称
+     */
+    lifecycleOnReadyEventName?: string;
+    /**
+     * 可选，onHide 钩子函数名称
+     */
+    lifecycleOnHideEventName?: string;
+    /**
+     * 可选，onUnload 钩子函数名称
+     */
+    lifecycleOnUnloadEventName?: string;
+}
+export {};
+//# sourceMappingURL=component.d.ts.map

package/lib/esm/types/platform/component.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"component.d.ts","sourceRoot":"","sources":["../../../../src/types/platform/component.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,oBAAoB,CAAC;AAC5C,OAAO,KAAK,EAAE,aAAa,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AACnF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAExD,KAAK,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AAE5B;;GAEG;AACH,eAAO,MAAM,cAAc;;;;CAIjB,CAAC;AAEX;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,KAAK,CAAC,WAAW;IAC5D;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,kBACf,SAAQ,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,OAAO,GAAG,gBAAgB,GAAG,UAAU,GAAG,YAAY,GAAG,QAAQ,CAAC;IACrG;;OAEG;IACH,UAAU,CAAC,EAAE,mBAAmB,CAAC;IAEjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,OAAO,cAAc,CAAC,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAEhC;;OAEG;IACH,KAAK,CAAC,EAAE,uBAAuB,CAAC;IAEhC,KAAK,CAAC,EAAE,kBAAkB,EAAE,CAAC;CAC9B;AAED,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,uBAAuB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,kBAAkB,CAAC,EAAE;QACnB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;IAEF;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;OAIG;IACH,QAAQ,CAAC,EAAE;QACT,CAAC,GAAG,EAAE,MAAM,GAAG;YACb,IAAI,EAAE,MAAM,CAAC;YACb,KAAK,EAAE,MAAM,CAAC;YACd,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;SACpB,CAAC;KACH,CAAC;IAEF;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,aAAa,CAAC,EAAE,mBAAmB,CAAC;IAEpC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,kBAAkB;IACzD,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,kBAAkB;IAC3D,IAAI,CAAC,EAAE,SAAS,CAAC;IAEjB,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAC;IACxE,IAAI,EAAE,MAAM,CAAC;IAEb,sBAAsB;IACtB,EAAE,EAAE,MAAM,CAAC;IAEX,KAAK,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAE7B;;OAEG;IACH,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAE3B;;;;OAIG;IACH,aAAa,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAEtC;;;;OAIG;IACH,SAAS,CAAC,EAAE,aAAa,EAAE,CAAC;CAM7B;AAED,MAAM,WAAW,uBAAwB,SAAQ,KAAK,CAAC,OAAO;IAC5D;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC"}

package/lib/esm/types/platform/component.js

@@ -0,0 +1,8 @@
+/**
+ * 组件类型
+ */
+export const EComponentType = {
+    BASIC: 'BASIC',
+    COMPLEX: 'COMPLEX',
+    PAGE: 'PAGE',
+};

package/lib/esm/types/platform/datasource.d.ts

@@ -0,0 +1,500 @@
+/**
+ * 微搭数据源结构
+ */
+export type IPlatformDataSource = IDatabaseDataSource | ICloudIntegrationDataSource;
+/**
+ * 数据源基本通用信息
+ */
+export interface IDataSourceBase {
+    /** 数据源 ID */
+    id: string;
+    /**
+     * 数据源描述名称
+     */
+    title: string;
+    /**
+     * 数据源标识
+     */
+    name: string;
+    /**
+     * 数据源类型
+     */
+    type: string;
+    /** 数据源子类型 */
+    subType?: string;
+    /** 数据源描述信息 */
+    description: string;
+    /** 数据源模型信息 */
+    schema: any;
+    /**
+     * 数据源的公共配置
+     */
+    configuration: any;
+    /**
+     * 数据源自定义方法
+     */
+    methods: IDataSourceMethod[];
+    /**
+     * 数据源描述信息的版本号
+     */
+    version: string;
+    /**
+     * 数据源描述使用的schema版本
+     */
+    schemaVersion: string;
+}
+export interface IConfigurationBase {
+    /** 公共变量 */
+    vars?: ISimpleField;
+}
+/** 云端集成数据源 */
+export interface ICloudIntegrationDataSource extends IDataSourceBase {
+    /**
+     * 数据源类型: 连接器(原第三方数据源)
+     */
+    type: 'cloud-integration';
+    /**
+     * 子类型, 默认为 `custom-connector`
+     * - `custom-database`: 用户自定义模型, 模型内的方法的出参入参与 database 一致, 但是方法内容由用户自己实现
+     * - `custom-connector`: 自定义连接器
+     * - `connector`: 标准连接器, 由微搭提供功能实现, 用户只需要进行简单的授权设置
+     */
+    subType?: 'custom-database' | 'custom-connector' | 'connector';
+    /** 第三方数据源基础配置 */
+    configuration: ICloudIntegrationConfig;
+}
+/**
+ * 云端集成类型的数据源配置
+ */
+export interface ICloudIntegrationConfig extends IConfigurationBase {
+    /**
+     * 第三方数据源提供者
+     * - `tencent-meeting`: 腾讯会议
+     * - `tencent-docs`: 腾讯文档
+     */
+    provider?: string;
+    /**
+     * 基准URL
+     */
+    baseUrl?: string;
+    /**
+     * 公共请求头
+     */
+    header?: {
+        values: IHttpField;
+    };
+}
+/** 数据模型对应的db类型 */
+export declare enum IDatabaseDataSourceDbType {
+    MYSQL = "MYSQL",
+    FLEXDB = "FLEXDB"
+}
+/**
+ * 内建数据源
+ */
+export interface IDatabaseDataSource extends IDataSourceBase {
+    /**
+     * 数据源类型: 模型数据源
+     */
+    type: 'database';
+    /**
+     * 子类型, 默认值为 `database`:
+     * - `database`: 即原来的自建数据源, 依赖云开发自身的云数据库做数据存储
+     * - `system`: 系统模型, 微搭系统自带的数据源, 如 用户、组织架构等等
+     */
+    subType?: 'database' | 'system';
+    configuration: IConfigurationBase;
+    schema: IDatabaseSchema;
+    /**
+     * 当前模型所在的 db 类型
+     *
+     * 系统模型由于中心化问题，该字段无效，后端传值为为空
+     */
+    dbInstanceType?: IDatabaseDataSourceDbType;
+}
+/** 自建数据源模型信息 */
+export interface IDatabaseSchema extends IJsonSchemaObject {
+    /** 数据库类型, 默认 tcb */
+    'x-kind'?: string;
+    /**
+     * 启用的内置方法名称
+     *
+     * 内置方法名称均需使用 weda 前缀, 自定义方法名称则不允许以 weda 开头，支鬼地方
+     *
+     * 当前支持的内置方法名称有：
+     * - `wedaCreate`
+     * - `wedaDelete`
+     * - `wedaUpdate`
+     * - `wedaGetItem`
+     * - `wedaGetList`
+     * - `wedaGetRecords`
+     */
+    'x-defaultMethods': string[];
+    /**
+     * 新建/编辑 数据源不需要该字段
+     *
+     * 后续优化，用于告诉服务端是否创建表格
+     *
+     * - `create` - 标识创建表格
+     * - `exist` - 表示搜索确定表格
+     * @deprecated
+     */
+    'x-relatedType': 'exist' | 'create';
+    /**
+     * 新建/编辑数据源时不需要该字段, 运行态需要使用 `viewId`
+     *
+     * 当 `x-relatedType` 为 `exist` 时有效，对应模型的视图 id
+     * @deprecated
+     */
+    'x-viewId': string;
+}
+/**
+ * 字段schema字段基础信息
+ */
+interface IJsonSchemaBase {
+    /** 字段类型: object */
+    type: string;
+    /** 字段中文名称 */
+    title?: string;
+    /** 字段描述 */
+    description?: string;
+    /** 默认值, 与当前字段类型结构应当保持一致 */
+    default?: any;
+    'x-required'?: boolean;
+    /** 前端UI冗余字段 */
+    'x-id'?: string;
+    /** http 方法的出参中, 用于描述原始响应结果与出参的字段映射关系 */
+    'x-keyPath'?: string;
+    /**
+     * 属性排序，用于前端展示字段的顺序，或者其他字段顺序相关操作，从1开始
+     */
+    'x-index'?: number;
+    /**
+     * 是否唯一
+     */
+    'x-unique'?: boolean;
+    /**
+     * 枚举值, 只列出值, 方便利用 json schema 特性校验
+     *  这里需要注意, enum 需要与 x-enumObj 的信息对应:
+     *     若有枚举, 两个字段的内容应当匹配
+     *     若无枚举, 则无这两字段
+     */
+    enum?: any[];
+    /** 枚举值, 详细描述对象, 供前端使用 */
+    'x-enumObj'?: IEnumOption[];
+}
+/**
+ * 单个枚举成员
+ */
+export interface IEnumOption {
+    /** 枚举显示的文字 */
+    label: string;
+    /** 内部存储的值 */
+    value: any;
+    /** 详细描述 */
+    description?: string;
+}
+/** 字段关联信息 */
+export interface IJsonSchemaLinkage {
+    /**
+     * 关联父数据源内容
+     * 必须string，number。（当前消息 id 是 string，_id: mongo string）
+     * 需求相关：https://qxhe1g.axshare.com/#g=1&p=%E4%B8%BB%E5%AD%90%E6%98%8E%E7%BB%86%E5%AD%97%E6%AE%B5
+     */
+    'x-parent'?: {
+        /**
+         * 关联父数据源关系 related | father-son
+         */
+        type: 'related' | 'father-son';
+        /**
+         * 关联的数据源viewID, 设计态不使用, 运行态使用
+         * @deprecated
+         */
+        parentViewId: string;
+        parentDataSourceName: string;
+        /**
+         * father-son 关系下有效
+         *  prompt-not-delete（提示不允许删除）
+         *  judge（）
+         */
+        fatherAction?: 'prompt-not-delete' | 'judge';
+    };
+}
+/** 任意类型的 schema 定义 */
+export type IJsonSchemaAny = IJsonSchemaObject | IJsonSchemaString | IJsonSchemaNumber | IJsonSchemaBool | IJsonSchemaArray;
+/** 对象 */
+export interface IJsonSchemaObject extends IJsonSchemaBase {
+    type: 'object';
+    /** 对象的属性 */
+    properties: {
+        [key: string]: IJsonSchemaAny;
+    };
+    /**
+     * 是否允许 properties 中未声明的字段, 可不传, 默认 true
+     *  https://json-schema.org/understanding-json-schema/reference/object.html#id5
+     */
+    additionalProperties?: true;
+    /** 必填属性列表 */
+    required?: string[];
+}
+/** 数组 */
+export interface IJsonSchemaArray extends IJsonSchemaBase {
+    type: 'array';
+    /** 数组成员 */
+    items: IJsonSchemaAny;
+}
+/** 字符串 */
+export interface IJsonSchemaString extends IJsonSchemaBase, IJsonSchemaLinkage {
+    type: 'string';
+    /**
+     * 字段格式
+     *  目前支持的有
+     *  email, tel, phone, cnName, url
+     */
+    format?: string;
+    pattern?: string;
+    minLength?: number;
+    maxLength?: number;
+}
+/** 数字 */
+export interface IJsonSchemaNumber extends IJsonSchemaBase, IJsonSchemaLinkage {
+    type: 'number';
+    /**
+     * 字段格式
+     * date, time, age
+     */
+    format?: string;
+    minimum?: number;
+    maximum?: number;
+}
+/** 布尔 */
+export interface IJsonSchemaBool extends IJsonSchemaBase {
+    type: 'boolean';
+}
+/**
+ * 云开发云函数字段, 其值为云函数名称
+ * !!! 该字段目前仅内部使用, 用户在新建字段、入参数出参时不可选该类型
+ */
+export interface IJsonSchemaScf extends IJsonSchemaBase {
+    type: '_scf_';
+}
+/**
+ * 数据源方法
+ */
+export type IDataSourceMethod = IHttpMethod | ICloudMethod | IScfMethod;
+/**
+ * 数据源方法基本信息
+ */
+export interface IDataMethodBase {
+    /**
+     * 必填, 操作方法名, 在数据源中唯一
+     *
+     * 以下为默认预置的方法名, 作为默认方法
+     * - `getList`
+     * - `getRecords`
+     * - `getItem`
+     * - `update`
+     * - `create`
+     * - `delete`
+     */
+    name: string;
+    /**
+     * 选填, 数据源方法别名
+     */
+    title: string;
+    /** 方法类型 */
+    type: string;
+    /**
+     * 必填, 方法分类
+     * - `get-list`
+     * - `get-item`
+     * - `update`
+     * - `create`
+     * - `delete`
+     */
+    intent: 'get-list' | 'get-item' | 'update' | 'create' | 'delete';
+    /**
+     * 选填, 数据源方法的描述
+     */
+    description?: string;
+    /**
+     * 方法是否禁用，留空则默认启用
+     * - 为 true 则方法定义后不实际使用
+     */
+    disabled?: boolean;
+    /**
+     * 选填, 数据源方法的实现
+     */
+    calleeBody?: any;
+    /**
+     * 数据源方法的额外入参结构描述对象
+     * - 作为数据源的固定入参，不可修改。需要用户在定义数据源时自行填写内容，值的结果存入 `calleeBody.presetParams` 中
+     * - 该字段用户不可编辑修改，正常应当只在基于模版创建的数据源中会预制该值
+     */
+    presetParams?: {
+        [key: string]: IJsonSchemaScf | IJsonSchemaAny;
+    };
+    /**
+     * 选填, 入参结构
+     */
+    inParams?: IJsonSchemaObject;
+    /** 出参 */
+    outParams: IJsonSchemaObject;
+}
+/**
+ * http类型的数据源方法
+ */
+export interface IHttpMethod extends IDataMethodBase {
+    /**
+     * 方法实现类型
+     */
+    type: 'http';
+    /** 请求核心信息 */
+    calleeBody: {
+        /** 请求地址 */
+        url: string;
+        /** 请求方法 */
+        method: string;
+        /** 自定义头 */
+        header?: {
+            values: IHttpField;
+        };
+        /** query 查询参数 */
+        query?: {
+            values: IHttpField;
+        };
+        /** 请求body, 仅 post 和 get 方法有  */
+        body?: {
+            contentType: 'json' | 'form' | 'xml' | 'none';
+            values: IHttpField;
+        };
+    };
+}
+/**
+ * 云函数类型的数据源方法
+ */
+export interface ICloudMethod extends IDataMethodBase {
+    /**
+     * 必填, 方法的实现类型
+     *  cloud-function 云函数
+     */
+    type: 'cloud-function';
+    /**
+     * 必填, 数据源方法的实现
+     */
+    calleeBody: {
+        /**
+         * 即函数源码
+         */
+        callee: string;
+        /**
+         * 其他配置项, 如云函数执行环境配置, 函数依赖的包信息(需注意: 同一数据源同一类型 云函数/本地函数 的数据源实现方法中的依赖版本需兼容匹配)
+         *  config: {deps: {'lodash': '*', 'request': '2.88'}}
+         */
+        config?: object;
+    };
+}
+/**
+ * 云开发(tcb)云函数类型的数据源方法
+ */
+export interface IScfMethod extends IDataMethodBase {
+    /**
+     * 必填, 方法的实现类型
+     *  scf 云函数
+     */
+    type: 'scf';
+    /**
+     * 必填, 数据源方法的实现
+     */
+    calleeBody: {
+        /**
+         * scf 函数名称
+         */
+        fnName: string;
+    };
+}
+/**
+ * 简单字段结构
+ */
+export type ISimpleField = IHttpField;
+/** http 配置的字段 */
+export interface IHttpField {
+    /**
+     * 字段名称
+     *  仅根节点可选, 其他节点必填
+     */
+    key?: string | number;
+    /**
+     * 字段数据类型
+     *  在 http body 中, 字段数据类型可以是 string, number, null, boolean, array, object
+     *  在 header 和 query中, 字段数据类型则只能是 string
+     */
+    type: string;
+    /**
+     * 字段值, 若使用入参中的值, 则使用 {{xxx}} 形式
+     *  非 array 和 object 类型应必须有 value
+     *  array 和 object 类型的, 若有绑定入参, 则有该值
+     */
+    value?: any;
+    /**
+     * 字段类型若为 array 或 object 且无入参绑定, 则有该字段
+     *  若type为 array, IHttpField 的key为 number, 即数组索引
+     *  若type为 array, IHttpField 的key为 string, 即对象的key
+     **/
+    items?: IHttpField[];
+}
+/**
+ * 数据源变量的描述
+ */
+export interface IDataSourceVariable {
+    /**
+     * 必填, 数据源变量的英文标识
+     */
+    name: string;
+    /**
+     * 选填, 数据源变量的中文标识
+     */
+    label?: string;
+    /** 变量类型 */
+    varType: 'datasource';
+    /**
+     * 选填, 数据源变量的类型
+     * - `record-collection` - 集合类型, 对应数据源 get-list 类型的方法
+     * - `new-record` - 新纪录类型, 用于表单, 对应数据源 create 类型的方法
+     * - `single-record` - 单条记录类型, 对应数据源 get-item 类型的方法
+     * - `single-record-edit` - 单条记录·编辑类型, 对应数据源 get-item/update 类型的方法
+     * 若数据源无对应方法, 则不能选择相应类型变量
+     * - `object` - 对象类型, 数据源变量类型下线过渡期所用类型
+     * - `array` - 数组类型, 数据源变量类型下线过渡期所用类型
+     */
+    dataType?: 'record-collection' | 'new-record' | 'single-record' | 'single-record-edit' | 'object' | 'array';
+    /**
+     * 必填, 绑定的数据源名称
+     */
+    dataSourceName: string;
+    /**
+     * 变量初始化的方法, 集合/单条记录类型变量需有该方法
+     */
+    initMethod?: IDataVarMethod;
+    /**
+     * 变量更新时候的方法, 新纪录/单条记录·编辑类型需有该方法
+     */
+    updateMethod?: IDataVarMethod;
+    /**
+     * 已知字段，但可能无意义
+     */
+    properties?: {
+        [key: string]: any;
+    };
+}
+/**
+ * 数据源变量关联的方法
+ */
+export interface IDataVarMethod {
+    /** 数据源的方法名称 */
+    name: string;
+    /** 方法入参 */
+    params?: object;
+}
+export {};
+//# sourceMappingURL=datasource.d.ts.map

package/lib/esm/types/platform/datasource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"datasource.d.ts","sourceRoot":"","sources":["../../../../src/types/platform/datasource.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,mBAAmB,GAAG,2BAA2B,CAAC;AAEpF;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,aAAa;IACb,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,aAAa;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,cAAc;IACd,WAAW,EAAE,MAAM,CAAC;IAEpB,cAAc;IACd,MAAM,EAAE,GAAG,CAAC;IAEZ;;OAEG;IACH,aAAa,EAAE,GAAG,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,iBAAiB,EAAE,CAAC;IAE7B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC,WAAW;IACX,IAAI,CAAC,EAAE,YAAY,CAAC;CACrB;AAED,cAAc;AACd,MAAM,WAAW,2BAA4B,SAAQ,eAAe;IAClE;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC;IAE1B;;;;;OAKG;IACH,OAAO,CAAC,EAAE,iBAAiB,GAAG,kBAAkB,GAAG,WAAW,CAAC;IAE/D,iBAAiB;IACjB,aAAa,EAAE,uBAAuB,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,kBAAkB;IACjE;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE;QACP,MAAM,EAAE,UAAU,CAAC;KACpB,CAAC;CACH;AAED,kBAAkB;AAClB,oBAAY,yBAAyB;IACnC,KAAK,UAAU;IACf,MAAM,WAAW;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IAEjB;;;;OAIG;IACH,OAAO,CAAC,EAAE,UAAU,GAAG,QAAQ,CAAC;IAEhC,aAAa,EAAE,kBAAkB,CAAC;IAElC,MAAM,EAAE,eAAe,CAAC;IAExB;;;;OAIG;IACH,cAAc,CAAC,EAAE,yBAAyB,CAAC;CAC5C;AAED,gBAAgB;AAChB,MAAM,WAAW,eAAgB,SAAQ,iBAAiB;IACxD,oBAAoB;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;;;;;;OAYG;IACH,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAE7B;;;;;;;;OAQG;IACH,eAAe,EAAE,OAAO,GAAG,QAAQ,CAAC;IAEpC;;;;;OAKG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,UAAU,eAAe;IACvB,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IAEb,aAAa;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,WAAW;IACX,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,2BAA2B;IAC3B,OAAO,CAAC,EAAE,GAAG,CAAC;IAEd,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,eAAe;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,wCAAwC;IACxC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IAEb,yBAAyB;IACzB,WAAW,CAAC,EAAE,WAAW,EAAE,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,cAAc;IACd,KAAK,EAAE,MAAM,CAAC;IAEd,aAAa;IACb,KAAK,EAAE,GAAG,CAAC;IAEX,WAAW;IACX,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,aAAa;AACb,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,UAAU,CAAC,EAAE;QACX;;WAEG;QACH,IAAI,EAAE,SAAS,GAAG,YAAY,CAAC;QAE/B;;;WAGG;QACH,YAAY,EAAE,MAAM,CAAC;QAKrB,oBAAoB,EAAE,MAAM,CAAC;QAE7B;;;;WAIG;QACH,YAAY,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC;KAC9C,CAAC;CACH;AAED,sBAAsB;AACtB,MAAM,MAAM,cAAc,GACtB,iBAAiB,GACjB,iBAAiB,GACjB,iBAAiB,GACjB,eAAe,GACf,gBAAgB,CAAC;AAErB,SAAS;AACT,MAAM,WAAW,iBAAkB,SAAQ,eAAe;IACxD,IAAI,EAAE,QAAQ,CAAC;IAEf,YAAY;IACZ,UAAU,EAAE;QACV,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAC;KAC/B,CAAC;IAEF;;;OAGG;IACH,oBAAoB,CAAC,EAAE,IAAI,CAAC;IAE5B,aAAa;IACb,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,SAAS;AACT,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACvD,IAAI,EAAE,OAAO,CAAC;IAEd,WAAW;IACX,KAAK,EAAE,cAAc,CAAC;CACvB;AAED,UAAU;AACV,MAAM,WAAW,iBAAkB,SAAQ,eAAe,EAAE,kBAAkB;IAC5E,IAAI,EAAE,QAAQ,CAAC;IAEf;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,SAAS;AACT,MAAM,WAAW,iBAAkB,SAAQ,eAAe,EAAE,kBAAkB;IAC5E,IAAI,EAAE,QAAQ,CAAC;IAEf;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,SAAS;AACT,MAAM,WAAW,eAAgB,SAAQ,eAAe;IACtD,IAAI,EAAE,SAAS,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAe,SAAQ,eAAe;IACrD,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG,YAAY,GAAG,UAAU,CAAC;AAExE;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;;;;;;OAUG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,WAAW;IACX,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;OAOG;IACH,MAAM,EAAE,UAAU,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAEjE;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,GAAG,CAAC;IAEjB;;;;OAIG;IACH,YAAY,CAAC,EAAE;QACb,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,GAAG,cAAc,CAAC;KAChD,CAAC;IAEF;;OAEG;IACH,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IAE7B,SAAS;IACT,SAAS,EAAE,iBAAiB,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,eAAe;IAClD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,aAAa;IACb,UAAU,EAAE;QACV,WAAW;QACX,GAAG,EAAE,MAAM,CAAC;QAEZ,WAAW;QACX,MAAM,EAAE,MAAM,CAAC;QAEf,WAAW;QACX,MAAM,CAAC,EAAE;YACP,MAAM,EAAE,UAAU,CAAC;SACpB,CAAC;QAEF,iBAAiB;QACjB,KAAK,CAAC,EAAE;YACN,MAAM,EAAE,UAAU,CAAC;SACpB,CAAC;QAEF,gCAAgC;QAChC,IAAI,CAAC,EAAE;YACL,WAAW,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,CAAC;YAC9C,MAAM,EAAE,UAAU,CAAC;SACpB,CAAC;KACH,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,eAAe;IACnD;;;OAGG;IACH,IAAI,EAAE,gBAAgB,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE;QACV;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,UAAW,SAAQ,eAAe;IACjD;;;OAGG;IACH,IAAI,EAAE,KAAK,CAAC;IAEZ;;OAEG;IACH,UAAU,EAAE;QACV;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC;AAEtC,iBAAiB;AACjB,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAEtB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,KAAK,CAAC,EAAE,GAAG,CAAC;IAEZ;;;;QAII;IACJ,KAAK,CAAC,EAAE,UAAU,EAAE,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,WAAW;IACX,OAAO,EAAE,YAAY,CAAC;IAEtB;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,mBAAmB,GAAG,YAAY,GAAG,eAAe,GAAG,oBAAoB,GAAG,QAAQ,GAAG,OAAO,CAAC;IAE5G;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,cAAc,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC;IAE9B;;OAEG;IACH,UAAU,CAAC,EAAE;QACX,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,eAAe;IACf,IAAI,EAAE,MAAM,CAAC;IAEb,WAAW;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}

package/lib/esm/types/platform/datasource.js

@@ -0,0 +1,6 @@
+/** 数据模型对应的db类型 */
+export var IDatabaseDataSourceDbType;
+(function (IDatabaseDataSourceDbType) {
+    IDatabaseDataSourceDbType["MYSQL"] = "MYSQL";
+    IDatabaseDataSourceDbType["FLEXDB"] = "FLEXDB";
+})(IDatabaseDataSourceDbType || (IDatabaseDataSourceDbType = {}));