@cloudbase/cals 1.2.0 → 1.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/cjs/parser/cals/index.d.ts.map +1 -1
- package/lib/cjs/parser/cals/index.js +2 -1
- package/lib/cjs/parser/cals/utils/block/index.d.ts +2 -2
- package/lib/cjs/parser/cals/utils/block/index.d.ts.map +1 -1
- package/lib/cjs/parser/cals/utils/template.d.ts.map +1 -1
- package/lib/cjs/parser/cals/utils/template.js +2 -0
- package/lib/cjs/types/index.d.ts +1 -1
- package/lib/cjs/types/index.d.ts.map +1 -1
- package/lib/cjs/types/index.js +2 -13
- package/lib/cjs/types/lcds.d.ts +530 -528
- package/lib/cjs/types/lcds.d.ts.map +1 -1
- package/lib/cjs/types/lcds.js +29 -20
- package/lib/cjs/types/platform/app.d.ts +3 -1
- package/lib/cjs/types/platform/app.d.ts.map +1 -1
- package/lib/cjs/types/platform/theme.d.ts +2 -2
- package/lib/cjs/types/platform/theme.d.ts.map +1 -1
- package/lib/cjs/utils/dts/auto-generated.d.ts +1 -1
- package/lib/cjs/utils/dts/auto-generated.d.ts.map +1 -1
- package/lib/cjs/utils/dts/auto-generated.js +113 -0
- package/lib/cjs/utils/version/migrations/version4.js +4 -1
- package/lib/esm/parser/cals/index.d.ts.map +1 -1
- package/lib/esm/parser/cals/index.js +2 -1
- package/lib/esm/parser/cals/utils/block/index.d.ts +2 -2
- package/lib/esm/parser/cals/utils/block/index.d.ts.map +1 -1
- package/lib/esm/parser/cals/utils/template.d.ts.map +1 -1
- package/lib/esm/parser/cals/utils/template.js +2 -0
- package/lib/esm/types/index.d.ts +1 -1
- package/lib/esm/types/index.d.ts.map +1 -1
- package/lib/esm/types/index.js +1 -1
- package/lib/esm/types/lcds.d.ts +530 -528
- package/lib/esm/types/lcds.d.ts.map +1 -1
- package/lib/esm/types/lcds.js +28 -19
- package/lib/esm/types/platform/app.d.ts +3 -1
- package/lib/esm/types/platform/app.d.ts.map +1 -1
- package/lib/esm/types/platform/theme.d.ts +2 -2
- package/lib/esm/types/platform/theme.d.ts.map +1 -1
- package/lib/esm/utils/dts/auto-generated.d.ts +1 -1
- package/lib/esm/utils/dts/auto-generated.d.ts.map +1 -1
- package/lib/esm/utils/dts/auto-generated.js +113 -0
- package/lib/esm/utils/version/migrations/version4.js +4 -1
- package/lib/schema/lcds_component.json +1 -1
- package/lib/schema/platform_application.json +1 -1
- package/lib/schema/platform_template.json +1 -1
- package/lib/tsconfig.tsbuildinfo +1 -1
- package/package.json +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"description":"布局组件模板","additionalProperties":false,"type":"object","properties":{"name":{"description":"选填, 组件唯一标识","maxLength":214,"minLength":1,"type":"string"},"data":{"description":"选填, 组件可以接收的数据, 用作组件props入参\n需要符合 JSON SCHEMA 规范","default":{}},"events":{"description":"选填, 组件可以被捕获的事件信息","default":[],"type":"array","items":{"$ref":"#/definitions/IEvent"}},"classes":{"description":"选填,组件样式 API","type":"array","items":{"$ref":"#/definitions/IClasses"}},"properties":{"description":"选填,组件属性 API, Object 类型 json schema"},"methods":{"description":"选填,组件内定义的自定义方法","default":[],"type":"array","items":{"$ref":"#/definitions/IMethod"}},"compConfig":{"description":"选填, 组件需要在运行时获取的配置项","type":"object","properties":{"isDataContainer":{"description":"选填, 组件是否开启数据容器功能\n- 默认为 false\n- 设置为 true 后,在组件内可通过调用 `onDataChange` 事件将内部数据挂载到组件的 `$context` 上下文对象","type":"boolean"},"componentType":{"description":"选填, 组件类型\n\n支持将表单类组件设置为 `formField`,即可在表单容器中收集值","type":"string"}},"additionalProperties":false},"platforms":{"description":"选填, 组件适配的平台\n\n如果该字段为空, 则进行智能推断","type":"array","items":{"type":"string"}},"meta":{"description":"选填, 仅用于在低码平台的信息展示","type":"object","properties":{"name":{"description":"选填, 组件英文标识","type":"string"},"componentName":{"description":"选填, 用于生成组件 id 的前缀标识","type":"string"},"title":{"description":"选填, 组件别名, 建议用中文","type":"string"},"description":{"description":"选填, 组件简介, 建议用中文","type":"string"},"icon":{"description":"选填, 组件图标, 支持本地图片(大纲树里面用的)","type":"string"},"figureIcon":{"description":"选填, 组件大图标 (组件列表里用的)","type":"string"},"category":{"description":"必填, 组件分类, 建议用中文","type":"string"},"componentOrder":{"description":"选填, 组件的排序权重","minimum":1,"maximum":10000,"type":"number"},"platform":{"description":"选填, 组件生效的平台","type":"array","items":{"enum":["MOBILE","MOBILEWEB","MP","PCWEB","WEB"],"type":"string"}},"visible":{"description":"选填, 组件可见性配置\n\n默认均显示\n- `[]` 表示隐藏\n- `['APP']` 表示只在应用编辑器显示\n- `['COMPONENT']` 表示只在组件编辑器显示","type":"array","items":{"$ref":"#/definitions/VisibleItem"}},"templates":{"description":"选填,组件模板配置\n{@link https://tapd.woa.com/20422223/prong/stories/view/1020422223884227747 使用文档}","type":"array","items":{"$ref":"#/definitions/ITemplate"}},"deprecated":{"description":"选填, 标识旧组件废弃,控制单组件升级按钮显隐\n{@link https://tapd.woa.com/TCB_new/markdown_wikis/show/#1220422223002411487 使用文档}","type":"boolean"},"renderMode":{"description":"选填, 单组件渲染模式[升级/替换]\n{@link https://tapd.woa.com/TCB_new/markdown_wikis/show/#1220422223002411487 使用文档}","type":"array","items":{"$ref":"#/definitions/IRenderMode"}},"docsUrl":{"description":"选填, 组件说明文档的地址","type":"string"},"shortcut":{"description":"选填, 组件快捷编辑协议","$ref":"#/definitions/IShortcut"},"contextData":{"description":"选填,组件上下文协议\n\n配置后可通过 `$context.id.state.xx` 读取属性值","type":"object","additionalProperties":{}},"positionConstraint":{"description":"选填,组件相对位置限制\n{@link https://tapd.woa.com/TCB_new/markdown_wikis/show/#1220422223002466153 使用文档}","type":"object","properties":{"allowChildren":{"description":"可选,允许子组件类型","type":"array","items":{"type":"object","properties":{"componentType":{"description":"组件对应类型,对应 `componentConfig.componentType`","type":"string"},"recursive":{"description":"是否允许为隔代子组件","type":"boolean"},"tip":{"description":"用户犯错提示","type":"string"}},"additionalProperties":false,"required":["componentType"]}},"allowParent":{"description":"可选,允许父组件类型","type":"array","items":{"type":"object","properties":{"componentType":{"description":"组件对应类型,对应` componentConfig.componentType`","type":"string"},"recursive":{"description":"是否允许为隔代父组件","type":"boolean"},"tip":{"description":"用户犯错提示","type":"string"}},"additionalProperties":false,"required":["componentType","recursive"]}}},"additionalProperties":false},"keyWords":{"description":"选填,搜索关键词\n{@link https://tapd.woa.com/TCB_new/markdown_wikis/show/#1220422223002460167 使用文档}","type":"array","items":{"type":"string"}},"propertyPanelTips":{"description":"选填,属性面板提示,支持 markdown\n{@link https://tapd.woa.com/TCB_new/markdown_wikis/show/#1220422223002460139 使用文档}","type":"string"},"stylePanelTips":{"description":"选填,样式面板提示","type":"string"},"disableUpgradeAll":{"description":"选填,禁用升级应用内所有的组件","type":"boolean"},"validate":{"description":"选填,检查功能\n{@link https://tapd.woa.com/TCB_new/markdown_wikis/show/#1220422223002459983 使用文档}","type":"array","items":{"type":"object","properties":{"rule":{"description":"规则名称","type":"string"},"options":{"type":"object","additionalProperties":{},"properties":{"title":{"description":"标题,支持 markdown","type":"string"},"description":{"description":"描述,支持 markdown","type":"string"},"type":{"description":"类型","type":"string"},"name":{"description":"名称","type":"string"},"label":{"description":"标签","type":"string"},"tooltip":{"description":"提示","type":"string"},"version":{"description":"选填,版本,版本,支持 markdown","type":"string"},"allowFailure":{"description":"可选,是否允许失败","type":"boolean"},"matchedSelectedPlatform":{"description":"可选,限制当前选中平台,不填不限制,默认为 null","type":"array","items":{"enum":["h5","miniprogram","pc"],"type":"string"}},"matchedPublishedPlatform":{"description":"可选,限制当前发布平台,不填不限制,默认为 'all'","type":"array","items":{"enum":["all","miniprogram","web"],"type":"string"}},"extra":{"description":"特殊字段,因 rule 的不同而不同"},"action":{"type":"object","additionalProperties":{}}},"required":["description","title","type"]}},"additionalProperties":false,"required":["rule"]}},"inlineStyleForm":{"description":"选填,样式配置属性屏蔽\n{@link https://tapd.woa.com/TCB_new/markdown_wikis/show/#1220422223002470249 使用文档}","anyOf":[{"type":"object","additionalProperties":{"anyOf":[{"type":"object","properties":{"visible":{"type":"boolean"}},"additionalProperties":false,"required":["visible"]},{"type":"boolean"}]}},{"type":"object","properties":{"$blockedAll":{"type":"boolean","const":true}},"additionalProperties":false,"required":["$blockedAll"]}]},"group":{"description":"选填,属性分组信息","type":"object","additionalProperties":{"type":"object","properties":{"x-index":{"type":"number"},"expand":{"type":"boolean"}},"additionalProperties":false,"required":["expand","x-index"]}},"previewImageUrl":{"description":"组件使用示例缩略图","type":"string"},"componentType":{"description":"组件类型","type":"string"},"previewOperation":{"description":"preview 配置按钮\n{@link https://tapd.woa.com/TCB_new/markdown_wikis/show/#1220422223002676991 使用文档}","type":"object","properties":{"headerIcon":{"description":"选填,头部图标","type":"string"},"operation":{"description":"操作配置","type":"array","items":{"type":"object","properties":{"icon":{"description":"图标","type":"string"},"title":{"description":"标题","type":"string"},"action":{"description":"行为,由编辑器提供","type":"string"}},"additionalProperties":false,"required":["action","icon","title"]}},"previewSlotName":{"description":"操作区域会插入的插槽名称","type":"string"},"insertSlotName":{"description":"选填,插入插槽名称\n\n- 指定拖动时插入的插槽名称\n- 比如 指定为 `contentSlot`,如果 `form` 指定了值为 `contentSlot`,则会插入到 `contentSlot` 中,而不是 `form` 里","type":"string"}},"additionalProperties":false,"required":["operation"]},"queryGeneratorConfig":{"type":"object","properties":{"sceneConfig":{"type":"object","properties":{"scenes":{"type":"array","items":{"$ref":"#/definitions/Scene"}},"availableScenes":{"type":"array","items":{"$ref":"#/definitions/Scene"}},"validCombinations":{"type":"array","items":{"type":"array","items":{"$ref":"#/definitions/Scene"}}},"enableSelectMultiple":{"type":"boolean"}},"additionalProperties":false,"required":["availableScenes","scenes","validCombinations"]},"fieldsConfig":{"type":"object","properties":{"enableConfigFormat":{"description":"是否支持配置 format?","type":"boolean"},"showFieldTypeColumn":{"description":"是否显示字段标识的列?","type":"boolean"},"enableSelectFieldFormType":{"type":"boolean"}},"additionalProperties":false},"apisConfig":{"type":"object","properties":{"enableConfigRecordAndTotalKey":{"description":"是否配置 record 和 total 的键值?","type":"boolean"}},"additionalProperties":false,"required":["enableConfigRecordAndTotalKey"]},"mysqlConfig":{"type":"object","properties":{"autoGenerateCountQuery":{"description":"是否自动生成查询总条数语句?","type":"boolean"},"countName":{"description":"计数名字\n\n表示 `SELECT COUNT(*) as count FROM xxx;` 的 `count`,如果指定 `countName` 为 `abc`,则输出 `sql SELECT COUNT(*) as abc FROM xxx;`","type":"string"}},"additionalProperties":false},"bindParamsPath":{"description":"绑定路径配置\n\n如果没有配置,默认就是 `params`,举例说明:\n- 配置 `select.condition` 为 `'params.abc'`,则输出的 SQL 为 `SELECT aa FROM xxx WHERE key={{params.abc}}`\n- 配置 `create.value` 为 `'params.hello'`,则输出的 SQL 为 `INSERT INTO xxx (a, b) VALUES ({{params.hello.a}}, {{params.hello.b }})`","$ref":"#/definitions/Partial<Record<Scene,Partial<Record<SceneTarget,string>>>>"},"quickOperateButton":{"type":"array","items":{"type":"object","properties":{"icon":{"type":"string"},"targetField":{"type":"string"},"content":{"type":"string"}},"additionalProperties":false,"required":["content","icon","targetField"]}}},"additionalProperties":false,"required":["sceneConfig"]},"globalConfig":{"type":"object","additionalProperties":{}}},"additionalProperties":false,"required":["category"]},"extra":{"description":"选填, 扩展字段, 尽量避免用"},"isContainer":{"description":"选填, 是否容器组件\n\n容器可以包含子节点,但是不能配置插槽","type":"boolean"},"defaultStyles":{"description":"默认样式\ndefaultStyles 接收一个React.CSSProperties对象","type":"object","additionalProperties":{}},"items":{"description":"可选, 可递归结构, 子级对应","type":"array","items":{"$ref":"#/definitions/IPlatformComponent"}},"label":{"description":"可选, 对用户可读的名称, 如 \"用户名\"","type":"string"},"id":{"description":"选填, 当前页面内的唯一 ID","type":"string"},"resources":{"description":"可选, 应用的资源集合\n\n例如, 代码片段、组件库、静态资源","type":"array","items":{"$ref":"#/definitions/IResource"}},"listeners":{"description":"可选, 组件绑定的监听器","type":"array","items":{"$ref":"#/definitions/IPlatformListener"}},"dataset":{"description":"可选, 变量集合","$ref":"#/definitions/IDataset"}},"required":["id"],"definitions":{"IEvent":{"description":"低码组件可以被捕获的事件信息","type":"object","properties":{"name":{"description":"必填, 用作抛出和捕获事件的唯一标识","type":"string"},"title":{"description":"选填, 事件别名, 用于低码平台展示","type":"string"},"description":{"description":"选填 事件描述","type":"string"},"x-platforms":{"description":"选填,事件生效的平台","type":"array","items":{"enum":["MOBILE","MOBILEWEB","MP","PCWEB","WEB"],"type":"string"}},"detail":{"description":"事件参数对象","type":"object","additionalProperties":{}}},"additionalProperties":false,"required":["name","title"]},"IClasses":{"description":"组件样式 API","type":"object","properties":{"name":{"description":"样式名称","type":"string"},"selector":{"description":"样式选择器","type":"string"},"code":{"description":"样式片段代码(需要填写完整的样式代码)","type":"string"},"description":{"description":"样式说明","type":"string"}},"additionalProperties":false,"required":["name","selector"]},"IMethod":{"description":"低码组件可以暴露的自定义方法","type":"object","properties":{"name":{"description":"必填, 用作组件方法的唯一标识","type":"string"},"label":{"description":"必填, 组件方法别名, 用于低码平台展示","type":"string"},"params":{"description":"选填, 组件方法可以接收的数据\n需要符合 JSON SCHEMA 规范","default":{}},"x-platforms":{"description":"选填, 组件自定义方法适配的平台","type":"array","items":{"type":"string"}},"description":{"description":"选填, 组件方法描述","type":"string"}},"additionalProperties":false,"required":["label","name"]},"VisibleItem":{"description":"组件在应用编辑器/低码编辑器的生效情况","enum":["APP","COMPONENT"],"type":"string"},"ITemplate":{"description":"组件模板配置","type":"object","properties":{"to":{"description":"插入模板的节点或插槽\n不设置或设置 $children 表示插入到当前组件,可配置多个节点或插槽并用逗号隔开","type":"string"},"when":{"description":"插入模板的时机\n不设置或设置 $attached 表示刚拖入组件时执行,可配置多个属性名称并用逗号隔开","type":"string"},"body":{"description":"插入的模板主体\n目前仅支持 toml 配置语法,结构内容参考组件 CALS","type":"string"},"autoSelectPath":{"description":"插入模板时自动选中的节点\n如 template[0] 表示选中所插入模板的第1个节点","type":"string","pattern":"^template.*$"},"remain":{"description":"见文档 https://iwiki.woa.com/p/4009680778#templatesindexremain","type":"string"}},"additionalProperties":false},"IRenderMode":{"type":"object","properties":{"component":{"description":"必填, 转换的目标组件名称","type":"string"},"renderType":{"description":"必填, 表示升级还是替换","enum":["replace","update"],"type":"string"},"props":{"description":"选填, [源组件的属性路径]:[转换目标组件的属性路径] 标记属性路径的映射关系","type":"object","additionalProperties":{"type":"string"}},"materialName":{"description":"选填, 表示升级组件所属组件库,默认与废弃组件同库","type":"string"},"description":{"description":"选填, 升级说明","type":"string"}},"additionalProperties":false,"required":["component","renderType"]},"IShortcut":{"description":"组件快捷编辑协议","type":"object","properties":{"props":{"description":"选填,快捷编辑面板中支持的组件属性","type":"array","items":{"type":"string"}},"extra":{"description":"选填,快捷编辑面板中支持拖入的组件","type":"object","additionalProperties":{"type":"object","properties":{"x-component":{"type":"string","const":"container"},"x-component-props":{"type":"array","items":{"type":"string"}},"x-index":{"type":"number"},"x-insert-path":{"type":"string"}},"additionalProperties":false,"required":["x-component"]}}},"additionalProperties":false},"Scene":{"enum":["batchCreate","batchDelete","batchSelect","create","select","update"],"type":"string"},"Partial<Record<Scene,Partial<Record<SceneTarget,string>>>>":{"type":"object","properties":{"select":{"$ref":"#/definitions/Partial<Record<SceneTarget,string>>"},"batchCreate":{"$ref":"#/definitions/Partial<Record<SceneTarget,string>>"},"batchSelect":{"$ref":"#/definitions/Partial<Record<SceneTarget,string>>"},"batchDelete":{"$ref":"#/definitions/Partial<Record<SceneTarget,string>>"},"create":{"$ref":"#/definitions/Partial<Record<SceneTarget,string>>"},"update":{"$ref":"#/definitions/Partial<Record<SceneTarget,string>>"}},"additionalProperties":false},"Partial<Record<SceneTarget,string>>":{"type":"object","properties":{"value":{"type":"string"},"condition":{"type":"string"},"limit":{"type":"string"},"offset":{"type":"string"}},"additionalProperties":false},"IPlatformComponent":{"description":"云开发低码平台组件","type":"object","properties":{"attributes":{"additionalProperties":true,"description":"可选, 组件控制属性","$ref":"#/definitions/IPlatformAttributes"},"type":{"description":"选填, 组件类型","enum":["BASIC","COMPLEX","PAGE"],"type":"string"},"listeners":{"description":"可选, 组件绑定的监听器","type":"array","items":{"$ref":"#/definitions/IPlatformListener"}},"extra":{"description":"可选,平台实现有关字段","$ref":"#/definitions/IPlatformComponentExtra"},"items":{"description":"可选, 可递归结构, 子级对应","type":"array","items":{"$ref":"#/definitions/IPlatformComponent"}},"label":{"description":"可选, 对用户可读的名称, 如 \"用户名\"","type":"string"},"module":{"description":"所属组件库","type":"string"},"name":{"description":"可选, 数据字段名, 作为向后台传值的名称约定, 如 \"user_name\"","type":"string"},"id":{"description":"选填, 当前页面内的唯一 ID","type":"string"},"component":{"description":"必填, 组件名, 一般首字母大写的大驼峰形式, 如 Image","type":"string"},"resources":{"description":"可选, 应用的资源集合\n\n例如, 代码片段、组件库、静态资源","type":"array","items":{"$ref":"#/definitions/IResource"}},"dataset":{"description":"可选, 变量集合","$ref":"#/definitions/IDataset"},":class":{"description":"可选,动态绑定 class,字符串表达式\n'[\"1\", \"2\"]'","type":"string"},":style":{"description":"可选,动态绑定 style, 与静态合并,字符表达式\n'{width: 17}'","type":"string"},"scopedStyle":{"description":"可选,组件局部样式","type":"string"},"directives":{"description":"选填,指令属性","type":"object","properties":{":if":{"description":"选填,动态 if 指令\nboolean 或 字符串表达式","default":true,"type":["string","boolean"]},":display":{"description":"选填,动态 display 指令\nboolean 或 字符串表达式","default":true,"type":["string","boolean"]},":for":{"description":"选填,动态 for 指令\n字符串表达式 (item, index) in list","type":"string"},"key":{"description":"选填,静态 for key\n字符串,表示 for item 的 key","type":"string"}},"additionalProperties":false}},"additionalProperties":false},"IPlatformAttributes":{"additionalProperties":true,"type":"object","properties":{"theme":{"description":"可选, 皮肤","type":"string"},"class":{"description":"可选, 样式名","type":"string"},"style":{"description":"可选, 标准 CSS 属性, 由于过多不宜下钻定义","type":"object","properties":{},"additionalProperties":true},"hide":{"description":"可选, 是否隐藏","type":"boolean"}}},"IPlatformListener":{"description":"组件绑定的监听器","type":"object","properties":{"id":{"description":"监听器唯一标识","type":"string"},"description":{"description":"可选,用于标注额外的事件流","type":"string"},"extra":{"type":"object","properties":{"handlerParamExtraData":{"type":"object","additionalProperties":{}},"handlerAragsExtraData":{"type":"object","additionalProperties":{}}},"additionalProperties":false},"isCapturePhase":{"description":"可选,是否在捕获阶段响应","default":false,"type":"boolean"},"noPropagation":{"description":"可选,是否附上事件传播","type":"boolean"},"type":{"description":"可选, 监听器类型","type":"string"},"handler":{"description":"可选, 绑定的处理器","$ref":"#/definitions/IHandler"},"eventName":{"description":"必填, 监听的事件名, 来源于 IEvents 定义的事件","type":"string"}},"additionalProperties":false,"required":["eventName","id"]},"IHandler":{"description":"监听器触发的处理器 handler中可查询 诸如数据源信息以及各种事件信息","type":"object","properties":{"name":{"description":"必填, 处理器的名称","type":"string"},"module":{"description":"可选, 处理器所属的模块","type":"string"},"code":{"type":"string"},":code":{"description":"可选,handler inline 代码表达式\n因为主要作为引用来使用,使用表达式更合适","type":"string"},"params":{"description":"可选, 处理器的入参","anyOf":[{"type":"object","properties":{},"additionalProperties":true},{"type":"array","items":{}}]}},"additionalProperties":false,"required":["name"]},"IPlatformComponentExtra":{"type":"object","properties":{"commonStyle":{"description":"可选,样式分组配置","type":"object","properties":{},"additionalProperties":true},"xIndex":{"type":"number"},"staticResourceAttribute":{"type":"array","items":{"type":"string"}},"styleBindPath":{"description":"style bind path","type":"string"},"hideAdminPortalMenu":{"type":"boolean"},"attributeExtraData":{"description":"属性绑定的额外补充信息","type":"object","additionalProperties":{}},"anchored":{"description":"组件是否处于锚定状态?\n\n*针对非叶子节点的组件(如容器),如有 `anchored` 标记,则在预览区可优先被选中*","type":"boolean"},"dataForm":{"description":"自定义数据表单 JSON Schema\n\n*该字段会和组件库中对应组件声明的 dataForm 合并处理,同时覆盖同名字段配置,最终供 formily 消费*","type":"object","additionalProperties":{"type":"object","additionalProperties":{},"properties":{"type":{"type":"string"},"title":{"type":"string"}},"required":["title","type"]}},"ref":{"description":"表示当前节点源于开发态引用关系","type":"string"},"refAttributes":{"additionalProperties":true,"description":"引用节点的初始属性\n冗余记录为了diff","$ref":"#/definitions/IPlatformAttributes"},"include":{"description":"表示需要引用外部/本地资源","type":"array","items":{"type":"string"}}},"additionalProperties":false},"IResource":{"type":"object","additionalProperties":{},"properties":{"name":{"description":"必填,资源名","type":"string"},"type":{"description":"必填,资源类型","type":"string"}},"required":["name","type"]},"IDataset":{"description":"变量","type":"object","properties":{"state":{"description":"状态","type":"object","additionalProperties":{}},"params":{"description":"页面/应用 参数","type":"object","additionalProperties":{"$ref":"#/definitions/IParamsVariable"}},"pageName":{"description":"可选,页面配置名称","type":"string"}},"additionalProperties":false},"IParamsVariable":{"description":"页面参数定义","type":"object","properties":{"name":{"description":"参数名称","type":"string"},"varType":{"description":"变量类型","type":"string","const":"params"},"label":{"description":"中文名","type":"string"},"required":{"description":"是否必填, 默认 false","type":"boolean"},"initialValue":{"description":"默认值","type":"string"},"sampleValue":{"description":"示例值, ide 开发时使用","type":"string"}},"additionalProperties":false,"required":["name","varType"]}},"$schema":"http://json-schema.org/draft-07/schema#"}
|
|
1
|
+
{"description":"布局组件模板","additionalProperties":false,"type":"object","properties":{"name":{"description":"选填, 组件唯一标识","maxLength":214,"minLength":1,"type":"string"},"data":{"description":"选填, 组件可以接收的数据, 用作组件props入参\n需要符合 JSON SCHEMA 规范","default":{}},"events":{"description":"选填, 组件可以被捕获的事件信息","default":[],"type":"array","items":{"$ref":"#/definitions/LCDS.IEvent"}},"classes":{"description":"选填,组件样式 API","type":"array","items":{"$ref":"#/definitions/LCDS.IClasses"}},"properties":{"description":"选填,组件属性 API, Object 类型 json schema"},"methods":{"description":"选填,组件内定义的自定义方法","default":[],"type":"array","items":{"$ref":"#/definitions/LCDS.IMethod"}},"compConfig":{"description":"选填, 组件需要在运行时获取的配置项","type":"object","properties":{"isDataContainer":{"description":"选填, 组件是否开启数据容器功能\n- 默认为 false\n- 设置为 true 后,在组件内可通过调用 `onDataChange` 事件将内部数据挂载到组件的 `$context` 上下文对象","type":"boolean"},"componentType":{"description":"选填, 组件类型\n\n支持将表单类组件设置为 `formField`,即可在表单容器中收集值","type":"string"}},"additionalProperties":false},"platforms":{"description":"选填, 组件适配的平台\n\n如果该字段为空, 则进行智能推断","type":"array","items":{"type":"string"}},"meta":{"description":"选填, 仅用于在低码平台的信息展示","type":"object","properties":{"name":{"description":"选填, 组件英文标识","type":"string"},"componentName":{"description":"选填, 用于生成组件 id 的前缀标识","type":"string"},"title":{"description":"选填, 组件别名, 建议用中文","type":"string"},"description":{"description":"选填, 组件简介, 建议用中文","type":"string"},"icon":{"description":"选填, 组件图标, 支持本地图片(大纲树里面用的)","type":"string"},"figureIcon":{"description":"选填, 组件大图标 (组件列表里用的)","type":"string"},"category":{"description":"必填, 组件分类, 建议用中文","type":"string"},"componentOrder":{"description":"选填, 组件的排序权重","minimum":1,"maximum":10000,"type":"number"},"platform":{"description":"选填, 组件生效的平台","type":"array","items":{"enum":["MOBILE","MOBILEWEB","MP","PCWEB","WEB"],"type":"string"}},"visible":{"description":"选填, 组件可见性配置\n\n默认均显示\n- `[]` 表示隐藏\n- `['APP']` 表示只在应用编辑器显示\n- `['COMPONENT']` 表示只在组件编辑器显示","type":"array","items":{"$ref":"#/definitions/LCDS.VisibleItem"}},"templates":{"description":"选填,组件模板配置\n{@link https://tapd.woa.com/20422223/prong/stories/view/1020422223884227747 使用文档}","type":"array","items":{"$ref":"#/definitions/LCDS.ITemplate"}},"deprecated":{"description":"选填, 标识旧组件废弃,控制单组件升级按钮显隐\n{@link https://tapd.woa.com/TCB_new/markdown_wikis/show/#1220422223002411487 使用文档}","type":"boolean"},"renderMode":{"description":"选填, 单组件渲染模式[升级/替换]\n{@link https://tapd.woa.com/TCB_new/markdown_wikis/show/#1220422223002411487 使用文档}","type":"array","items":{"$ref":"#/definitions/LCDS.IRenderMode"}},"docsUrl":{"description":"选填, 组件说明文档的地址","type":"string"},"shortcut":{"description":"选填, 组件快捷编辑协议","$ref":"#/definitions/LCDS.IShortcut"},"contextData":{"description":"选填,组件上下文协议\n\n配置后可通过 `$context.id.state.xx` 读取属性值","type":"object","additionalProperties":{}},"positionConstraint":{"description":"选填,组件相对位置限制\n{@link https://tapd.woa.com/TCB_new/markdown_wikis/show/#1220422223002466153 使用文档}","type":"object","properties":{"allowChildren":{"description":"可选,允许子组件类型","type":"array","items":{"type":"object","properties":{"componentType":{"description":"组件对应类型,对应 `componentConfig.componentType`","type":"string"},"recursive":{"description":"是否允许为隔代子组件","type":"boolean"},"tip":{"description":"用户犯错提示","type":"string"}},"additionalProperties":false,"required":["componentType"]}},"allowParent":{"description":"可选,允许父组件类型","type":"array","items":{"type":"object","properties":{"componentType":{"description":"组件对应类型,对应` componentConfig.componentType`","type":"string"},"recursive":{"description":"是否允许为隔代父组件","type":"boolean"},"tip":{"description":"用户犯错提示","type":"string"}},"additionalProperties":false,"required":["componentType","recursive"]}}},"additionalProperties":false},"keyWords":{"description":"选填,搜索关键词\n{@link https://tapd.woa.com/TCB_new/markdown_wikis/show/#1220422223002460167 使用文档}","type":"array","items":{"type":"string"}},"propertyPanelTips":{"description":"选填,属性面板提示,支持 markdown\n{@link https://tapd.woa.com/TCB_new/markdown_wikis/show/#1220422223002460139 使用文档}","type":"string"},"stylePanelTips":{"description":"选填,样式面板提示","type":"string"},"disableUpgradeAll":{"description":"选填,禁用升级应用内所有的组件","type":"boolean"},"validate":{"description":"选填,检查功能\n{@link https://tapd.woa.com/TCB_new/markdown_wikis/show/#1220422223002459983 使用文档}","type":"array","items":{"type":"object","properties":{"rule":{"description":"规则名称","type":"string"},"options":{"type":"object","additionalProperties":{},"properties":{"title":{"description":"标题,支持 markdown","type":"string"},"description":{"description":"描述,支持 markdown","type":"string"},"type":{"description":"类型","type":"string"},"name":{"description":"名称","type":"string"},"label":{"description":"标签","type":"string"},"tooltip":{"description":"提示","type":"string"},"version":{"description":"选填,版本,版本,支持 markdown","type":"string"},"allowFailure":{"description":"可选,是否允许失败","type":"boolean"},"matchedSelectedPlatform":{"description":"可选,限制当前选中平台,不填不限制,默认为 null","type":"array","items":{"enum":["h5","miniprogram","pc"],"type":"string"}},"matchedPublishedPlatform":{"description":"可选,限制当前发布平台,不填不限制,默认为 'all'","type":"array","items":{"enum":["all","miniprogram","web"],"type":"string"}},"extra":{"description":"特殊字段,因 rule 的不同而不同"},"action":{"type":"object","additionalProperties":{}}},"required":["description","title","type"]}},"additionalProperties":false,"required":["rule"]}},"inlineStyleForm":{"description":"选填,样式配置属性屏蔽\n{@link https://tapd.woa.com/TCB_new/markdown_wikis/show/#1220422223002470249 使用文档}","anyOf":[{"type":"object","additionalProperties":{"anyOf":[{"type":"object","properties":{"visible":{"type":"boolean"}},"additionalProperties":false,"required":["visible"]},{"type":"boolean"}]}},{"type":"object","properties":{"$blockedAll":{"type":"boolean","const":true}},"additionalProperties":false,"required":["$blockedAll"]}]},"group":{"description":"选填,属性分组信息","type":"object","additionalProperties":{"type":"object","properties":{"x-index":{"type":"number"},"expand":{"type":"boolean"}},"additionalProperties":false,"required":["expand","x-index"]}},"previewImageUrl":{"description":"组件使用示例缩略图","type":"string"},"componentType":{"description":"组件类型","type":"string"},"previewOperation":{"description":"preview 配置按钮\n{@link https://tapd.woa.com/TCB_new/markdown_wikis/show/#1220422223002676991 使用文档}","type":"object","properties":{"headerIcon":{"description":"选填,头部图标","type":"string"},"operation":{"description":"操作配置","type":"array","items":{"type":"object","properties":{"icon":{"description":"图标","type":"string"},"title":{"description":"标题","type":"string"},"action":{"description":"行为,由编辑器提供","type":"string"}},"additionalProperties":false,"required":["action","icon","title"]}},"previewSlotName":{"description":"操作区域会插入的插槽名称","type":"string"},"insertSlotName":{"description":"选填,插入插槽名称\n\n- 指定拖动时插入的插槽名称\n- 比如 指定为 `contentSlot`,如果 `form` 指定了值为 `contentSlot`,则会插入到 `contentSlot` 中,而不是 `form` 里","type":"string"}},"additionalProperties":false,"required":["operation"]},"queryGeneratorConfig":{"type":"object","properties":{"sceneConfig":{"type":"object","properties":{"scenes":{"type":"array","items":{"$ref":"#/definitions/Scene"}},"availableScenes":{"type":"array","items":{"$ref":"#/definitions/Scene"}},"validCombinations":{"type":"array","items":{"type":"array","items":{"$ref":"#/definitions/Scene"}}},"enableSelectMultiple":{"type":"boolean"}},"additionalProperties":false,"required":["availableScenes","scenes","validCombinations"]},"fieldsConfig":{"type":"object","properties":{"enableConfigFormat":{"description":"是否支持配置 format?","type":"boolean"},"showFieldTypeColumn":{"description":"是否显示字段标识的列?","type":"boolean"},"enableSelectFieldFormType":{"type":"boolean"}},"additionalProperties":false},"apisConfig":{"type":"object","properties":{"enableConfigRecordAndTotalKey":{"description":"是否配置 record 和 total 的键值?","type":"boolean"}},"additionalProperties":false,"required":["enableConfigRecordAndTotalKey"]},"mysqlConfig":{"type":"object","properties":{"autoGenerateCountQuery":{"description":"是否自动生成查询总条数语句?","type":"boolean"},"countName":{"description":"计数名字\n\n表示 `SELECT COUNT(*) as count FROM xxx;` 的 `count`,如果指定 `countName` 为 `abc`,则输出 `sql SELECT COUNT(*) as abc FROM xxx;`","type":"string"}},"additionalProperties":false},"bindParamsPath":{"description":"绑定路径配置\n\n如果没有配置,默认就是 `params`,举例说明:\n- 配置 `select.condition` 为 `'params.abc'`,则输出的 SQL 为 `SELECT aa FROM xxx WHERE key={{params.abc}}`\n- 配置 `create.value` 为 `'params.hello'`,则输出的 SQL 为 `INSERT INTO xxx (a, b) VALUES ({{params.hello.a}}, {{params.hello.b }})`","$ref":"#/definitions/Partial<Record<Scene,Partial<Record<SceneTarget,string>>>>"},"quickOperateButton":{"type":"array","items":{"type":"object","properties":{"icon":{"type":"string"},"targetField":{"type":"string"},"content":{"type":"string"}},"additionalProperties":false,"required":["content","icon","targetField"]}}},"additionalProperties":false,"required":["sceneConfig"]},"globalConfig":{"type":"object","additionalProperties":{}}},"additionalProperties":false,"required":["category"]},"extra":{"description":"选填, 扩展字段, 尽量避免用"},"isContainer":{"description":"选填, 是否容器组件\n\n容器可以包含子节点,但是不能配置插槽","type":"boolean"},"defaultStyles":{"description":"默认样式\ndefaultStyles 接收一个React.CSSProperties对象","type":"object","additionalProperties":{}},"items":{"description":"可选, 可递归结构, 子级对应","type":"array","items":{"$ref":"#/definitions/IPlatformComponent"}},"label":{"description":"可选, 对用户可读的名称, 如 \"用户名\"","type":"string"},"id":{"description":"选填, 当前页面内的唯一 ID","type":"string"},"resources":{"description":"可选, 应用的资源集合\n\n例如, 代码片段、组件库、静态资源","type":"array","items":{"$ref":"#/definitions/IResource"}},"listeners":{"description":"可选, 组件绑定的监听器","type":"array","items":{"$ref":"#/definitions/IPlatformListener"}},"dataset":{"description":"变量","$ref":"#/definitions/IPlatformDataset"}},"required":["id"],"definitions":{"LCDS.IEvent":{"description":"低码组件可以被捕获的事件信息","type":"object","properties":{"name":{"description":"必填, 用作抛出和捕获事件的唯一标识","type":"string"},"title":{"description":"选填, 事件别名, 用于低码平台展示","type":"string"},"description":{"description":"选填 事件描述","type":"string"},"x-platforms":{"description":"选填,事件生效的平台","type":"array","items":{"enum":["MOBILE","MOBILEWEB","MP","PCWEB","WEB"],"type":"string"}},"detail":{"description":"事件参数对象","type":"object","additionalProperties":{}}},"additionalProperties":false,"required":["name","title"]},"LCDS.IClasses":{"description":"组件样式 API","type":"object","properties":{"name":{"description":"样式名称","type":"string"},"selector":{"description":"样式选择器","type":"string"},"code":{"description":"样式片段代码(需要填写完整的样式代码)","type":"string"},"description":{"description":"样式说明","type":"string"}},"additionalProperties":false,"required":["name","selector"]},"LCDS.IMethod":{"description":"低码组件可以暴露的自定义方法","type":"object","properties":{"name":{"description":"必填, 用作组件方法的唯一标识","type":"string"},"label":{"description":"必填, 组件方法别名, 用于低码平台展示","type":"string"},"params":{"description":"选填, 组件方法可以接收的数据\n需要符合 JSON SCHEMA 规范","default":{}},"x-platforms":{"description":"选填, 组件自定义方法适配的平台","type":"array","items":{"type":"string"}},"description":{"description":"选填, 组件方法描述","type":"string"}},"additionalProperties":false,"required":["label","name"]},"LCDS.VisibleItem":{"description":"组件在应用编辑器/低码编辑器的生效情况","enum":["APP","COMPONENT"],"type":"string"},"LCDS.ITemplate":{"description":"组件模板配置","type":"object","properties":{"to":{"description":"插入模板的节点或插槽\n不设置或设置 $children 表示插入到当前组件,可配置多个节点或插槽并用逗号隔开","type":"string"},"when":{"description":"插入模板的时机\n不设置或设置 $attached 表示刚拖入组件时执行,可配置多个属性名称并用逗号隔开","type":"string"},"body":{"description":"插入的模板主体\n目前仅支持 toml 配置语法,结构内容参考组件 CALS","type":"string"},"autoSelectPath":{"description":"插入模板时自动选中的节点\n如 template[0] 表示选中所插入模板的第1个节点","type":"string","pattern":"^template.*$"},"remain":{"description":"见文档 https://iwiki.woa.com/p/4009680778#templatesindexremain","type":"string"}},"additionalProperties":false},"LCDS.IRenderMode":{"type":"object","properties":{"component":{"description":"必填, 转换的目标组件名称","type":"string"},"renderType":{"description":"必填, 表示升级还是替换","enum":["replace","update"],"type":"string"},"props":{"description":"选填, [源组件的属性路径]:[转换目标组件的属性路径] 标记属性路径的映射关系","type":"object","additionalProperties":{"type":"string"}},"materialName":{"description":"选填, 表示升级组件所属组件库,默认与废弃组件同库","type":"string"},"description":{"description":"选填, 升级说明","type":"string"}},"additionalProperties":false,"required":["component","renderType"]},"LCDS.IShortcut":{"description":"组件快捷编辑协议","type":"object","properties":{"props":{"description":"选填,快捷编辑面板中支持的组件属性","type":"array","items":{"type":"string"}},"extra":{"description":"选填,快捷编辑面板中支持拖入的组件","type":"object","additionalProperties":{"type":"object","properties":{"x-component":{"type":"string","const":"container"},"x-component-props":{"type":"array","items":{"type":"string"}},"x-index":{"type":"number"},"x-insert-path":{"type":"string"}},"additionalProperties":false,"required":["x-component"]}}},"additionalProperties":false},"Scene":{"enum":["batchCreate","batchDelete","batchSelect","create","select","update"],"type":"string"},"Partial<Record<Scene,Partial<Record<SceneTarget,string>>>>":{"type":"object","properties":{"select":{"$ref":"#/definitions/Partial<Record<SceneTarget,string>>"},"batchCreate":{"$ref":"#/definitions/Partial<Record<SceneTarget,string>>"},"batchSelect":{"$ref":"#/definitions/Partial<Record<SceneTarget,string>>"},"batchDelete":{"$ref":"#/definitions/Partial<Record<SceneTarget,string>>"},"create":{"$ref":"#/definitions/Partial<Record<SceneTarget,string>>"},"update":{"$ref":"#/definitions/Partial<Record<SceneTarget,string>>"}},"additionalProperties":false},"Partial<Record<SceneTarget,string>>":{"type":"object","properties":{"value":{"type":"string"},"condition":{"type":"string"},"limit":{"type":"string"},"offset":{"type":"string"}},"additionalProperties":false},"IPlatformComponent":{"description":"云开发低码平台组件","type":"object","properties":{"attributes":{"additionalProperties":true,"description":"可选, 组件控制属性","$ref":"#/definitions/IPlatformAttributes"},"type":{"description":"选填, 组件类型","enum":["BASIC","COMPLEX","PAGE"],"type":"string"},"listeners":{"description":"可选, 组件绑定的监听器","type":"array","items":{"$ref":"#/definitions/IPlatformListener"}},"extra":{"description":"可选,平台实现有关字段","$ref":"#/definitions/IPlatformComponentExtra"},"items":{"description":"可选, 可递归结构, 子级对应","type":"array","items":{"$ref":"#/definitions/IPlatformComponent"}},"label":{"description":"可选, 对用户可读的名称, 如 \"用户名\"","type":"string"},"module":{"description":"所属组件库","type":"string"},"name":{"description":"可选, 数据字段名, 作为向后台传值的名称约定, 如 \"user_name\"","type":"string"},"id":{"description":"选填, 当前页面内的唯一 ID","type":"string"},"component":{"description":"必填, 组件名, 一般首字母大写的大驼峰形式, 如 Image","type":"string"},"resources":{"description":"可选, 应用的资源集合\n\n例如, 代码片段、组件库、静态资源","type":"array","items":{"$ref":"#/definitions/IResource"}},"dataset":{"description":"可选, 变量集合","$ref":"#/definitions/IDataset"},":class":{"description":"可选,动态绑定 class,字符串表达式\n'[\"1\", \"2\"]'","type":"string"},":style":{"description":"可选,动态绑定 style, 与静态合并,字符表达式\n'{width: 17}'","type":"string"},"scopedStyle":{"description":"可选,组件局部样式","type":"string"},"directives":{"description":"选填,指令属性","type":"object","properties":{":if":{"description":"选填,动态 if 指令\nboolean 或 字符串表达式","default":true,"type":["string","boolean"]},":display":{"description":"选填,动态 display 指令\nboolean 或 字符串表达式","default":true,"type":["string","boolean"]},":for":{"description":"选填,动态 for 指令\n字符串表达式 (item, index) in list","type":"string"},"key":{"description":"选填,静态 for key\n字符串,表示 for item 的 key","type":"string"}},"additionalProperties":false}},"additionalProperties":false},"IPlatformAttributes":{"additionalProperties":true,"type":"object","properties":{"theme":{"description":"可选, 皮肤","type":"string"},"class":{"description":"可选, 样式名","type":"string"},"style":{"description":"可选, 标准 CSS 属性, 由于过多不宜下钻定义","type":"object","properties":{},"additionalProperties":true},"hide":{"description":"可选, 是否隐藏","type":"boolean"}}},"IPlatformListener":{"description":"组件绑定的监听器","type":"object","properties":{"id":{"description":"监听器唯一标识","type":"string"},"description":{"description":"可选,用于标注额外的事件流","type":"string"},"extra":{"type":"object","properties":{"handlerParamExtraData":{"type":"object","additionalProperties":{}},"handlerAragsExtraData":{"type":"object","additionalProperties":{}}},"additionalProperties":false},"isCapturePhase":{"description":"可选,是否在捕获阶段响应","default":false,"type":"boolean"},"noPropagation":{"description":"可选,是否附上事件传播","type":"boolean"},"type":{"description":"可选, 监听器类型","type":"string"},"handler":{"description":"可选, 绑定的处理器","$ref":"#/definitions/IHandler"},"eventName":{"description":"必填, 监听的事件名, 来源于 IEvents 定义的事件","type":"string"}},"additionalProperties":false,"required":["eventName","id"]},"IHandler":{"description":"监听器触发的处理器 handler中可查询 诸如数据源信息以及各种事件信息","type":"object","properties":{"name":{"description":"必填, 处理器的名称","type":"string"},"module":{"description":"可选, 处理器所属的模块","type":"string"},"code":{"type":"string"},":code":{"description":"可选,handler inline 代码表达式\n因为主要作为引用来使用,使用表达式更合适","type":"string"},"params":{"description":"可选, 处理器的入参","anyOf":[{"type":"object","properties":{},"additionalProperties":true},{"type":"array","items":{}}]}},"additionalProperties":false,"required":["name"]},"IPlatformComponentExtra":{"type":"object","properties":{"commonStyle":{"description":"可选,样式分组配置","type":"object","properties":{},"additionalProperties":true},"xIndex":{"type":"number"},"staticResourceAttribute":{"type":"array","items":{"type":"string"}},"styleBindPath":{"description":"style bind path","type":"string"},"hideAdminPortalMenu":{"type":"boolean"},"attributeExtraData":{"description":"属性绑定的额外补充信息","type":"object","additionalProperties":{}},"anchored":{"description":"组件是否处于锚定状态?\n\n*针对非叶子节点的组件(如容器),如有 `anchored` 标记,则在预览区可优先被选中*","type":"boolean"},"dataForm":{"description":"自定义数据表单 JSON Schema\n\n*该字段会和组件库中对应组件声明的 dataForm 合并处理,同时覆盖同名字段配置,最终供 formily 消费*","type":"object","additionalProperties":{"type":"object","additionalProperties":{},"properties":{"type":{"type":"string"},"title":{"type":"string"}},"required":["title","type"]}},"ref":{"description":"表示当前节点源于开发态引用关系","type":"string"},"refAttributes":{"additionalProperties":true,"description":"引用节点的初始属性\n冗余记录为了diff","$ref":"#/definitions/IPlatformAttributes"},"include":{"description":"表示需要引用外部/本地资源","type":"array","items":{"type":"string"}}},"additionalProperties":false},"IResource":{"type":"object","additionalProperties":{},"properties":{"name":{"description":"必填,资源名","type":"string"},"type":{"description":"必填,资源类型","type":"string"}},"required":["name","type"]},"IDataset":{"description":"变量","type":"object","properties":{"state":{"description":"状态","type":"object","additionalProperties":{}},"params":{"description":"页面/应用 参数","type":"object","additionalProperties":{"$ref":"#/definitions/IParamsVariable"}},"pageName":{"description":"可选,页面配置名称","type":"string"}},"additionalProperties":false},"IParamsVariable":{"description":"页面参数定义","type":"object","properties":{"name":{"description":"参数名称","type":"string"},"varType":{"description":"变量类型","type":"string","const":"params"},"label":{"description":"中文名","type":"string"},"required":{"description":"是否必填, 默认 false","type":"boolean"},"initialValue":{"description":"默认值","type":"string"},"sampleValue":{"description":"示例值, ide 开发时使用","type":"string"}},"additionalProperties":false,"required":["name","varType"]},"IPlatformDataset":{"description":"变量","type":"object","properties":{"state":{"description":"状态","type":"object","additionalProperties":{"anyOf":[{"$ref":"#/definitions/IStateVariable"},{"$ref":"#/definitions/IDataSourceVariable"}]}},"params":{"description":"页面/应用 参数","type":"object","additionalProperties":{"$ref":"#/definitions/IParamsVariable"}},"query":{"description":"可选, query集合","type":"object","additionalProperties":{"$ref":"#/definitions/IDataSourceQuery"}},"pageName":{"description":"可选,页面配置名称","type":"string"}},"additionalProperties":false},"IStateVariable":{"type":"object","additionalProperties":{},"properties":{"label":{"description":"中文名","type":"string"},"varType":{"description":"变量类型","type":"string","const":"state"},"dataType":{"description":"原始数据类型\n string, number, object, array, boolean","type":"string"},"initialValue":{"description":"初始值"},"enableSyncLocal":{"description":"是否启用本地同步?","type":"boolean"}},"required":["dataType","varType"]},"IDataSourceVariable":{"description":"数据源变量的描述","type":"object","properties":{"name":{"description":"必填, 数据源变量的英文标识","type":"string"},"label":{"description":"选填, 数据源变量的中文标识","type":"string"},"varType":{"description":"变量类型","type":"string","const":"datasource"},"dataType":{"description":"选填, 数据源变量的类型\n- `record-collection` - 集合类型, 对应数据源 get-list 类型的方法\n- `new-record` - 新纪录类型, 用于表单, 对应数据源 create 类型的方法\n- `single-record` - 单条记录类型, 对应数据源 get-item 类型的方法\n- `single-record-edit` - 单条记录·编辑类型, 对应数据源 get-item/update 类型的方法\n若数据源无对应方法, 则不能选择相应类型变量\n- `object` - 对象类型, 数据源变量类型下线过渡期所用类型\n- `array` - 数组类型, 数据源变量类型下线过渡期所用类型","enum":["array","new-record","object","record-collection","single-record","single-record-edit"],"type":"string"},"dataSourceName":{"description":"必填, 绑定的数据源名称","type":"string"},"initMethod":{"description":"变量初始化的方法, 集合/单条记录类型变量需有该方法","$ref":"#/definitions/IDataVarMethod"},"updateMethod":{"description":"变量更新时候的方法, 新纪录/单条记录·编辑类型需有该方法","$ref":"#/definitions/IDataVarMethod"},"properties":{"description":"已知字段,但可能无意义","type":"object","additionalProperties":{}}},"additionalProperties":false,"required":["dataSourceName","name","varType"]},"IDataVarMethod":{"description":"数据源变量关联的方法","type":"object","properties":{"name":{"description":"数据源的方法名称","type":"string"},"params":{"description":"方法入参","type":"object","properties":{},"additionalProperties":true}},"additionalProperties":false,"required":["name"]},"IDataSourceQuery":{"description":"数据源类型查询时定义","type":"object","properties":{"dataSourceName":{"type":"string"},"method":{"description":"数据源类型查询时 调用方法内部定义","$ref":"#/definitions/IQueryMethod"},"id":{"description":"必填, 唯一标识","type":"string"},"name":{"description":"必填, code区的英文标识","type":"string"},"label":{"description":"选填, code区的中文标识","type":"string"},"description":{"description":"选填, 额外描述","type":"string"},"type":{"$ref":"#/definitions/EQueryType","description":"子类型 内置数据模型model 连接器类型apis sql语句类型"},"handler":{"description":"触发响应动作","$ref":"#/definitions/IHandler"},"trigger":{"description":"必选, 触发时机 自动指当前事件因change等事件自动触发 手动指被其他事件带着触发","enum":["auto","manual"],"type":"string"},"listeners":{"description":"选填 如果设定了多个监听器需要此逻辑运行","type":"array","items":{"$ref":"#/definitions/IPlatformListener"}}},"additionalProperties":false,"required":["id","name","trigger","type"]},"IQueryMethod":{"description":"数据源类型查询时 调用方法内部定义","type":"object","properties":{"name":{"description":"数据源的方法名称","type":"string"},"sqlTemplateId":{"description":"如果是sql语句 此处为sql语句模版id","type":"string"},"params":{"description":"方法入参","type":"object","properties":{},"additionalProperties":true}},"additionalProperties":false,"required":["name"]},"EQueryType":{"description":"query类型枚举","type":"string","enum":["model","apis","general-func","sql","sqlserver","cloud-connector"]}},"$schema":"http://json-schema.org/draft-07/schema#"}
|