@cloudbase/cals 1.0.3-alpha.8 → 1.0.3-alpha.9

package/lib/types/lcds.d.ts

@@ -1,448 +1,335 @@
-import type * as CSS from 'csstype';
-/**
- * 低码组件库开发规范 (LCDS, Lowcode Components Development Specification)
- *
- * 基于 LCDS 开发的组件库, 可以在云开发低码平台内使用
- */
-/**
- * 低码的平台方法的开发配置
- */
-export interface IAction {
-    /**
-     * 选填, 平台方法的唯一标识
-     * @maxLength 214
-     * @minLength 1
-     */
-    name?: string;
-    /**
-     * 选填, 平台方法可以接收的数据
-     * 需要符合 JSON SCHEMA 规范
-     *
-     * @default {}
-     */
-    data?: any;
-    /**
-     * 选填, 组件对外开放的只读属性，可通过 $w.id1.xx 获取
-     * 需要符合 JSON SCHEMA 规范
-     */
-    properties?: any;
-    /**
-     * 选填, 平台方法适配的平台
-     *
-     * 如果该字段为空, 则进行智能推断
-     */
-    platforms?: string[];
-    /**
-     * 选填, 仅用于在低码平台的信息展示
-     */
-    meta?: {
-        /**
-         * 选填, 平台方法的别名, 建议用中文
-         */
-        title?: string;
-        /**
-         * 选填, 平台方法的简介, 建议用中文
-         */
-        description?: string;
-    };
-    /**
-     * 选填, 扩展字段, 尽量避免用
-     */
-    extra?: any;
-}
-/**
- * 低码组件开发配置
- */
-export interface IComponent {
-    /**
-     * 选填, 组件唯一标识
-     * @maxLength 214
-     * @minLength 1
-     */
-    name?: string;
-    /**
-     * 选填, 组件可以接收的数据, 用作组件props入参
-     * 需要符合 JSON SCHEMA 规范
-     *
-     * @default {}
-     */
-    data?: any;
-    /**
-     * 选填, 组件可以被捕获的事件信息
-     *
-     * @default []
-     */
-    events?: IEvent[];
-    /**
-     * 选填，组件样式 API
-     */
-    classes?: IClasses[];
-    /**
-     * 选填，组件属性 API
-     */
-    properties?: IClasses[];
-    /**
-     * 选填, 组件内定义的自定义方法
-     *
-     * @default []
-     */
-    methods?: IMethod[];
-    /**
-     * 选填, 组件需要在运行时获取的配置项
-     * @deprecated
-     */
-    compConfig?: {
-        /**
-         * 选填, 组件是否开启数据容器功能
-         * 默认为 false, 设置为 true 后, 在组件内可通过调用 onDataChange 事件将内部数据挂载到组件的 $context 上下文对象
-         */
-        isDataContainer?: boolean;
-        /**
-         * 选填, 组件类型
-         * 支持将表单类组件设置为 formField，即可在表单容器中收集值
-         */
-        componentType?: string;
-    };
-    /**
-     * 选填, 组件适配的平台
-     *
-     * 如果该字段为空, 则进行智能推断
-     */
-    platforms?: string[];
-    /**
-     * 选填, 仅用于在低码平台的信息展示
-     */
-    meta?: {
-        /**
-         * 选填, 组件英文标识
-         */
-        name?: string;
-        /**
-         * 选填, 用于生成组件 id 的前缀标识
-         */
-        componentName?: string;
-        /**
-         * 选填, 组件别名, 建议用中文
-         */
-        title?: string;
-        /**
-         * 选填, 组件简介, 建议用中文
-         */
-        description?: string;
-        /**
-         * 选填, 组件图标, 支持本地图片
-         */
-        icon?: string;
-        /**
-         * 选填, 组件分类, 建议用中文
-         */
-        category?: string;
-        /**
-         * 选填, 组件的排序权重
-         *
-         * @minimum 1
-         * @maximum 10000
-         */
-        componentOrder?: number;
-        /**
-         * 选填, 组件生效的平台
-         */
-        platform?: XPlatform[];
-        /**
-         * 选填, 组件可见性配置
-         * 默认均显示，[]表示隐藏, ['APP']表示只在应用编辑器显示，['COMPONENT']表示只在组件编辑器显示
-         */
-        visible?: VisibleItem[];
-        /**
-         * 选填，组件模板配置
-         * {@link https://tapd.woa.com/20422223/prong/stories/view/1020422223884227747 使用文档}
-         */
-        templates?: ITemplate[];
-        /**
-         * 选填, 标识旧组件废弃，控制单组件升级按钮显隐
-         * {@link https://tapd.woa.com/TCB_new/markdown_wikis/show/#1220422223002411487 使用文档}
-         */
-        deprecated?: boolean;
-        /**
-         * 选填, 单组件渲染模式[升级/替换]
-         * {@link https://tapd.woa.com/TCB_new/markdown_wikis/show/#1220422223002411487 使用文档}
-         */
-        renderMode?: IRenderMode[];
-        /**
-         * 选填, 组件说明文档的地址
-         */
-        docsUrl?: string;
-        /**
-         * 选填, 组件快捷编辑协议
-         */
-        shortcut?: IShortcut;
-        /**
-         * 选填，组件上下文协议，配置后可通过 $context.id.state.xx 读取属性值
-         * @deprecated
-         */
-        contextData?: {
-            extra?: Record<string, any>;
-        };
-        /**
-         * 选填，组件相对位置限制
-         * {@link https://tapd.woa.com/TCB_new/markdown_wikis/show/#1220422223002466153 使用文档}
-         */
-        positionConstraint?: {
-            /**
-             * 可选，允许子组件类型
-             */
-            allowChildren?: {
-                /**
-                 * 组件对应类型，对应 componentConfig.componentType
-                 */
-                componentType: string;
-                /**
-                 * 是否允许为隔代子组件
-                 */
-                recursive: boolean;
-            }[];
-            /**
-             * 可选，允许父组件类型
-             */
-            allowParent?: {
-                /**
-                 * 组件对应类型，对应 componentConfig.componentType
-                 */
-                componentType: string;
-                /**
-                 * 是否允许为隔代父组件
-                 */
-                recursive: boolean;
-            }[];
-        };
-        /**
-         * 选填，搜索关键词
-         * {@link https://tapd.woa.com/TCB_new/markdown_wikis/show/#1220422223002460167 使用文档}
-         */
-        keyWords?: string[];
-        /**
-         * 选填，属性面板提示，支持 markdown
-         * {@link https://tapd.woa.com/TCB_new/markdown_wikis/show/#1220422223002460139 使用文档}
-         */
-        propertyPanelTips?: string;
-        /**
-         * 选填，检查功能
-         * {@link https://tapd.woa.com/TCB_new/markdown_wikis/show/#1220422223002459983 使用文档}
-         */
-        validate?: {
-            /**
-             * 规则名称
-             */
-            rule: string;
-            /**
-             * 标题，支持 markdown
-             */
-            title: string;
-            /**
-             * 描述，支持 markdown
-             */
-            description: string;
-            /**
-             * 类型
-             */
-            type: string;
-            /**
-             * 选填，版本，版本，支持 markdown
-             */
-            version?: string;
-            /**
-             * 可选，是否允许失败
-             */
-            allowFailure?: boolean;
-            /**
-             * 可选，限制当前选中平台，不填不限制，默认为 null
-             */
-            matchedSelectedPlatform?: Array<'h5' | 'miniprogram' | 'pc'>;
-            /**
-             * 可选，限制当前发布平台，不填不限制，默认为 'all'
-             */
-            matchedPublishedPlatform?: 'web' | 'miniprogram' | 'all';
-            /**
-             * 特殊字段，因 rule 的不同而不同
-             */
-            extra?: any;
-            /**
-             * 选填，操作字段，组件无需填写
-             */
-            options?: {
-                /**
-                 * 名称
-                 */
-                name: string;
-                /**
-                 * 标签
-                 */
-                label: string;
-                /**
-                 * 点击事件
-                 */
-                click: Function;
-                /**
-                 * 提示
-                 */
-                tooltip: string;
-            };
-        };
-        /**
-         * 选填，样式配置属性屏蔽
-         * {@link https://tapd.woa.com/TCB_new/markdown_wikis/show/#1220422223002470249 使用文档}
-         */
-        inlineStyleForm?: {
-            [key: string]: {
-                visible: boolean;
-            };
-        };
-    };
-    /**
-     * 选填, 扩展字段, 尽量避免用
-     */
-    extra?: any;
-    /**
-     * 选填, 是否容器组件
-     *
-     * 容器可以包含子节点，但是不能配置插槽
-     */
-    isContainer?: boolean;
-    /**
-     * 默认样式
-     * defaultStyles 接收一个React.CSSProperties对象
-     */
-    defaultStyles?: CSS.Properties<string | number>;
-}
-/**
- * 低码组件可以被捕获的事件信息
- */
-export interface IEvent {
-    /**
-     * 必填, 用作抛出和捕获事件的唯一标识
-     */
-    name: string;
-    /**
-     * 选填, 事件别名, 用于低码平台展示
-     */
-    title: string;
-    /**
-     * 选填，事件生效的平台
-     */
-    'x-platforms'?: XPlatform;
-    /**
-     * 事件参数对象
-     */
-    detail?: Record<string, any>;
-}
-/**
- * 低码组件可以暴露的自定义方法
- */
-export interface IMethod {
-    /**
-     * 必填, 用作组件方法的唯一标识
-     */
-    name: string;
-    /**
-     * 必填, 组件方法别名, 用于低码平台展示
-     */
-    label: string;
-    /**
-     * 选填, 组件方法可以接收的数据
-     * 需要符合 JSON SCHEMA 规范
-     *
-     * @default {}
-     */
-    params?: any;
-    /**
-     * 选填, 组件自定义方法适配的平台
-     */
-    platforms?: string[];
-    /**
-     * 选填, 组件方法描述
-     */
-    description?: string;
-}
-export interface IRenderMode {
-    /**
-     * 必填, 转换的目标组件名称
-     */
-    component: string;
-    /**
-     * 必填, 表示升级还是替换
-     */
-    renderType: 'update' | 'replace';
-    /**
-     * 选填, [源组件的属性路径]:[转换目标组件的属性路径] 标记属性路径的映射关系
-     */
-    props?: {
-        [name: string]: string;
-    };
-    /**
-     * 选填, 表示升级组件所属组件库，默认与废弃组件同库
-     */
-    materialName?: string;
-    /**
-     * 选填, 升级说明
-     */
-    description?: string;
-}
-/** 组件/方法/属性所支持的平台 */
-export declare type XPlatform = 'MP' | 'WEB' | 'PCWEB' | 'MOBILEWEB';
-/** 组件在应用编辑器/低码编辑器的生效情况*/
-export declare type VisibleItem = 'APP' | 'COMPONENT';
-/** 组件模板配置 */
-export interface ITemplate {
-    /**
-     * 插入模板的节点或插槽
-     * 不设置或设置 $children 表示插入到当前组件，可配置多个节点或插槽并用逗号隔开
-     */
-    to?: '$children' | string;
-    /**
-     * 插入模板的时机
-     * 不设置或设置 $attached 表示刚拖入组件时执行，可配置多个属性名称并用逗号隔开
-     */
-    when?: '$attached' | string;
-    /**
-     * 插入的模板主体
-     * 目前仅支持 toml 配置语法，结构内容参考组件 CALS
-     */
-    body?: string;
-    /**
-     * 插入模板时自动选中的节点
-     * 如 template[0] 表示选中所插入模板的第1个节点
-     */
-    autoSelectPath?: `template${string}`;
-}
-/** 组件快捷编辑协议 */
-export interface IShortcut {
-    /**
-     * 选填，快捷编辑面板中支持的组件属性
-     */
-    props?: string[];
-    /**
-     * 选填，快捷编辑面板中支持拖入的组件
-     */
-    extra?: Record<string, {
-        'x-component': 'container';
-        'x-component-props'?: string[];
-        'x-index'?: number;
-        'x-insert-path'?: string;
-    }>;
-}
-/** 组件样式 API */
-export interface IClasses {
-    /**
-     * 样式名称
-     */
-    name?: string;
-    /**
-     * 样式选择器
-     */
-    selector?: string;
-    /**
-     * 样式说明
-     */
-    description?: string;
-}
+import type * as CSS from 'csstype';
+/**
+ * 低码组件库开发规范 (LCDS, Lowcode Components Development Specification)
+ *
+ * 基于 LCDS 开发的组件库, 可以在云开发低码平台内使用
+ */
+export declare namespace LCDS {
+    /**
+     * 低码的平台方法的开发配置
+     */
+    interface IAction {
+        /**
+         * 选填, 平台方法的唯一标识
+         * @maxLength 214
+         * @minLength 1
+         */
+        name?: string;
+        /**
+         * 选填, 平台方法可以接收的数据
+         * 需要符合 JSON SCHEMA 规范
+         *
+         * @default {}
+         */
+        data?: any;
+        /**
+         * 选填, 组件对外开放的只读属性，可通过 $w.id1.xx 获取
+         * 需要符合 JSON SCHEMA 规范
+         */
+        properties?: any;
+        /**
+         * 选填, 平台方法适配的平台
+         *
+         * 如果该字段为空, 则进行智能推断
+         */
+        platforms?: string[];
+        /**
+         * 选填, 仅用于在低码平台的信息展示
+         */
+        meta?: {
+            /**
+             * 选填, 平台方法的别名, 建议用中文
+             */
+            title?: string;
+            /**
+             * 选填, 平台方法的简介, 建议用中文
+             */
+            description?: string;
+        };
+        /**
+         * 选填, 扩展字段, 尽量避免用
+         */
+        extra?: any;
+    }
+    /**
+     * 低码组件开发配置
+     */
+    interface IComponent {
+        /**
+         * 选填, 组件唯一标识
+         * @maxLength 214
+         * @minLength 1
+         */
+        name?: string;
+        /**
+         * 选填, 组件可以被捕获的事件信息
+         *
+         * @default []
+         */
+        events?: IEvent[];
+        /**
+         * 选填，组件样式 API
+         */
+        classes?: IClasses[];
+        /**
+         * 选填, 组件内定义的自定义方法
+         *
+         * @default []
+         */
+        methods?: IMethod[];
+        /**
+         * 选填, 组件需要在运行时获取的配置项
+         */
+        compConfig?: {
+            /**
+             * 选填, 组件是否开启数据容器功能
+             * 默认为 false, 设置为 true 后, 在组件内可通过调用 onDataChange 事件将内部数据挂载到组件的 $context 上下文对象
+             */
+            isDataContainer?: boolean;
+            /**
+             * 选填, 组件类型
+             * 支持将表单类组件设置为 formField，即可在表单容器中收集值
+             */
+            componentType?: string;
+        };
+        /**
+         * 选填, 组件可以接收的数据, 用作组件props入参
+         * 需要符合 JSON SCHEMA 规范
+         *
+         * @default {}
+         */
+        data?: any;
+        /**
+         * 选填, 组件适配的平台
+         *
+         * 如果该字段为空, 则进行智能推断
+         */
+        platforms?: string[];
+        /**
+         * 选填, 仅用于在低码平台的信息展示
+         */
+        meta?: IConfigMeta & {
+            /**
+             * 选填, 组件英文标识
+             */
+            name?: string;
+            /**
+             * 选填, 用于生成组件 id 的前缀标识
+             */
+            componentName?: string;
+            /**
+             * 选填, 组件别名, 建议用中文
+             */
+            title?: string;
+            /**
+             * 选填, 组件简介, 建议用中文
+             */
+            description?: string;
+            /**
+             * 选填, 组件图标, 支持本地图片
+             */
+            icon?: string;
+            /**
+             * 选填, 组件分类, 建议用中文
+             */
+            category?: string;
+            /**
+             * 选填, 组件的排序权重
+             *
+             * @minimum 1
+             * @maximum 10000
+             */
+            componentOrder?: number;
+            /**
+             * 选填, 组件生效的平台
+             */
+            platform?: XPlatform[];
+            /**
+             * 选填, 组件可见性配置
+             * 默认均显示，[]表示隐藏, ['APP']表示只在应用编辑器显示，['COMPONENT']表示只在组件编辑器显示
+             */
+            visible?: VisibleItem[];
+            /**
+             * 选填，组件模板配置
+             */
+            templates?: ITemplate[];
+            /**
+             * 选填, 标识旧组件废弃，控制单组件升级按钮显隐
+             */
+            deprecated?: boolean;
+            /**
+             * 选填, 单组件渲染模式[升级/替换]
+             */
+            renderMode?: IRenderMode[];
+        };
+        /**
+         * 选填, 扩展字段, 尽量避免用
+         */
+        extra?: any;
+        /**
+         * 选填, 是否容器组件
+         *
+         * 容器可以包含子节点，但是不能配置插槽
+         */
+        isContainer?: boolean;
+        /**
+         * 默认样式
+         * defaultStyles 接收一个React.CSSProperties对象
+         */
+        defaultStyles?: CSS.Properties<string | number>;
+    }
+    /**
+     * 低码组件可以被捕获的事件信息
+     */
+    interface IEvent {
+        /**
+         * 必填, 用作抛出和捕获事件的唯一标识
+         */
+        name: string;
+        /**
+         * 选填, 事件别名, 用于低码平台展示
+         */
+        title: string;
+        /**
+         * 选填，事件生效的平台
+         */
+        'x-platforms'?: XPlatform;
+        /**
+         * 事件参数对象
+         */
+        detail?: Record<string, any>;
+    }
+    /**
+     * 低码组件可以暴露的自定义方法
+     */
+    interface IMethod {
+        /**
+         * 必填, 用作组件方法的唯一标识
+         */
+        name: string;
+        /**
+         * 必填, 组件方法别名, 用于低码平台展示
+         */
+        label: string;
+        /**
+         * 选填, 组件方法可以接收的数据
+         * 需要符合 JSON SCHEMA 规范
+         *
+         * @default {}
+         */
+        params?: any;
+        /**
+         * 选填, 组件自定义方法适配的平台
+         */
+        platforms?: string[];
+        /**
+         * 选填, 组件方法描述
+         */
+        description?: string;
+    }
+    interface IRenderMode {
+        /**
+         * 必填, 转换的目标组件名称
+         */
+        component: string;
+        /**
+         * 必填, 表示升级还是替换
+         */
+        renderType: 'update' | 'replace';
+        /**
+         * 选填, [源组件的属性路径]:[转换目标组件的属性路径] 标记属性路径的映射关系
+         */
+        props?: {
+            [name: string]: string;
+        };
+        /**
+         * 选填, 表示升级组件所属组件库，默认与废弃组件同库
+         */
+        materialName?: string;
+        /**
+         * 选填, 升级说明
+         */
+        description?: string;
+    }
+}
+/** 组件/方法/属性所支持的平台 */
+declare type XPlatform = 'MP' | 'WEB' | 'PCWEB' | 'MOBILEWEB';
+/** 组件在应用编辑器/低码编辑器的生效情况*/
+declare type VisibleItem = 'APP' | 'COMPONENT';
+/** 组件模板配置 */
+interface ITemplate {
+    /**
+     * 插入模板的节点或插槽
+     * 不设置或设置 $children 表示插入到当前组件，可配置多个节点或插槽并用逗号隔开
+     */
+    to?: '$children' | string;
+    /**
+     * 插入模板的时机
+     * 不设置或设置 $attached 表示刚拖入组件时执行，可配置多个属性名称并用逗号隔开
+     */
+    when?: '$attached' | string;
+    /**
+     * 插入的模板主体
+     * 目前仅支持 toml 配置语法，结构内容参考组件 CALS
+     */
+    body?: string;
+    /**
+     * 插入模板时自动选中的节点
+     * 如 template[0] 表示选中所插入模板的第1个节点
+     */
+    autoSelectPath?: `template${string}`;
+}
+/** 组件配置 */
+interface IConfigMeta {
+    /**
+     * 选填, 组件说明文档的地址
+     */
+    docsUrl?: string;
+    /**
+     * 选填, 组件可见性配置
+     */
+    visible?: VisibleItem[];
+    /**
+     * 选填, 组件快捷编辑协议
+     */
+    shortcut?: IShortcut;
+    /**
+     * 选填，组件上下文协议，配置后可通过 $context.id.state.xx 读取属性值
+     */
+    contextData?: {
+        extra?: Record<string, any>;
+    };
+}
+/** 组件快捷编辑协议 */
+interface IShortcut {
+    /**
+     * 选填，快捷编辑面板中支持的组件属性
+     */
+    props?: string[];
+    /**
+     * 选填，快捷编辑面板中支持拖入的组件
+     */
+    extra?: Record<string, {
+        'x-component': 'container';
+        'x-component-props'?: string[];
+        'x-index'?: number;
+        'x-insert-path'?: string;
+    }>;
+}
+/** 组件样式 API */
+interface IClasses {
+    /**
+     * 样式名称
+     */
+    name?: string;
+    /**
+     *  样式选择器
+     */
+    selector?: string;
+    /**
+     * 样式说明
+     */
+    description?: string;
+}
+export {};
 //# sourceMappingURL=lcds.d.ts.map