From 084e70f9114b6bd11e4d0f73df249aecafc2e205 Mon Sep 17 00:00:00 2001 From: 2betop <2betop.cn@gmail.com> Date: Tue, 8 Sep 2020 17:39:14 +0800 Subject: [PATCH] =?UTF-8?q?=E6=96=B0=E7=89=88=20JSON=20Schema=20=E5=88=9D?= =?UTF-8?q?=E7=A8=BF?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 1 + fis-conf.js | 7 +- package.json | 9 +- scripts/build-schemas.ts | 119 +++++++++++++++++ {build => scripts}/embed-packager.js | 0 {build => scripts}/generate-search-data.js | 0 {build => scripts}/md-parser.js | 0 scripts/schema-tools/OptionalTypeFormatter.ts | 34 +++++ scripts/schema-tools/RestTypeFormatter.ts | 35 +++++ scripts/schema-tools/UnionTypeFormatter.ts | 19 +++ scripts/schema-tools/VoidTypeFormatter.ts | 19 +++ {build => scripts}/upload2cdn.js | 0 src/renderers/Tpl.tsx | 7 +- src/schemas/Action.ts | 104 +++++++++++++++ src/schemas/Form/BaseItem.ts | 27 ++++ src/schemas/Form/Text.ts | 21 +++ src/schemas/Form/index.ts | 30 +++++ src/schemas/Page.ts | 101 ++++++++++++++ src/schemas/Remark.ts | 0 src/schemas/Schema.ts | 123 ++++++++++++++++++ src/schemas/Tpl.ts | 18 +++ src/schemas/index.ts | 3 + tsconfig.json | 9 +- 23 files changed, 668 insertions(+), 18 deletions(-) create mode 100644 scripts/build-schemas.ts rename {build => scripts}/embed-packager.js (100%) rename {build => scripts}/generate-search-data.js (100%) rename {build => scripts}/md-parser.js (100%) create mode 100644 scripts/schema-tools/OptionalTypeFormatter.ts create mode 100644 scripts/schema-tools/RestTypeFormatter.ts create mode 100644 scripts/schema-tools/UnionTypeFormatter.ts create mode 100644 scripts/schema-tools/VoidTypeFormatter.ts rename {build => scripts}/upload2cdn.js (100%) create mode 100644 src/schemas/Action.ts create mode 100644 src/schemas/Form/BaseItem.ts create mode 100644 src/schemas/Form/Text.ts create mode 100644 src/schemas/Form/index.ts create mode 100644 src/schemas/Page.ts create mode 100644 src/schemas/Remark.ts create mode 100644 src/schemas/Schema.ts create mode 100644 src/schemas/Tpl.ts create mode 100644 src/schemas/index.ts diff --git a/.gitignore b/.gitignore index 61e9eda6a..004ce8cfc 100644 --- a/.gitignore +++ b/.gitignore @@ -21,3 +21,4 @@ node_modules /toolkit/output /coverage /package-lock.json +/schema.json diff --git a/fis-conf.js b/fis-conf.js index b54df50fd..9d86cfaaf 100644 --- a/fis-conf.js +++ b/fis-conf.js @@ -4,7 +4,7 @@ const path = require('path'); const fs = require('fs'); const package = require('./package.json'); -const parserMarkdown = require('./build/md-parser'); +const parserMarkdown = require('./scripts/md-parser'); fis.get('project.ignore').push('public/**', 'gh-pages/**', '.*/**'); // 配置只编译哪些文件。 @@ -35,7 +35,8 @@ fis.set('project.files', [ '/examples/*.tpl', '/src/**.html', 'mock/**', - 'schemas/**' + 'schemas/**', + '/schema.json' ]); fis.match('/mock/**', { @@ -414,7 +415,7 @@ if (fis.project.currentMedia() === 'publish') { resourceType: 'mod' }), - require('./build/embed-packager') + require('./scripts/embed-packager') ] }); diff --git a/package.json b/package.json index 8a1569b86..8b9a7503f 100644 --- a/package.json +++ b/package.json @@ -12,7 +12,8 @@ "publish2npm": "sh publish.sh && npm publish", "build": "sh publish.sh", "prettier": "prettier --write '{src,examples,scss}/**/*.{tsx,ts,jsx,scss}'", - "deploy-gh-page": "sh ./deploy-gh-pages.sh" + "deploy-gh-page": "sh ./deploy-gh-pages.sh", + "build-schemas": "ts-node -O '{\"target\":\"es6\"}' scripts/build-schemas.ts" }, "repository": { "type": "git", @@ -87,6 +88,7 @@ "@types/jest": "^24.0.11", "@types/jquery": "^3.3.1", "@types/lodash": "^4.14.76", + "@types/mkdirp": "^1.0.1", "@types/node": "^12.7.1", "@types/pretty-bytes": "^4.0.0", "@types/prop-types": "^15.5.2", @@ -136,6 +138,7 @@ "js-yaml": "^3.10.0", "lint-staged": "^8.1.6", "marked": "^0.3.7", + "mkdirp": "^1.0.4", "mobx-wiretap": "^0.12.0", "prettier": "^2.0.5", "prismjs": "^1.20.0", @@ -145,7 +148,9 @@ "react-testing-library": "6.0.4", "strip-json-comments": "^2.0.1", "ts-jest": "^24.0.0", - "typescript": "^3.9.5" + "ts-json-schema-generator": "^0.73.0", + "ts-node": "^9.0.0", + "typescript": "^4.0.2" }, "jest": { "testEnvironment": "jsdom", diff --git a/scripts/build-schemas.ts b/scripts/build-schemas.ts new file mode 100644 index 000000000..492462ae5 --- /dev/null +++ b/scripts/build-schemas.ts @@ -0,0 +1,119 @@ +/** + * @file 用来生成 json-schemas + */ + +import fs = require('fs'); +import path = require('path'); +import tsj = require('ts-json-schema-generator'); +import mkdirp = require('mkdirp'); +import { + ChainTypeFormatter, + CircularReferenceTypeFormatter, + AnnotatedTypeFormatter, + StringTypeFormatter, + NumberTypeFormatter, + BooleanTypeFormatter, + NullTypeFormatter, + AnyTypeFormatter, + UndefinedTypeFormatter, + UnknownTypeFormatter, + LiteralTypeFormatter, + EnumTypeFormatter, + ReferenceTypeFormatter, + Config, + DefinitionTypeFormatter, + ObjectTypeFormatter, + AliasTypeFormatter, + PrimitiveUnionTypeFormatter, + LiteralUnionTypeFormatter, + ArrayTypeFormatter, + TupleTypeFormatter, + IntersectionTypeFormatter +} from 'ts-json-schema-generator'; +import {OptionalTypeFormatter} from './schema-tools/OptionalTypeFormatter'; +import {VoidTypeFormatter} from './schema-tools/VoidTypeFormatter'; +import {RestTypeFormatter} from './schema-tools/RestTypeFormatter'; +import {UnionTypeFormatter} from './schema-tools/UnionTypeFormatter'; + +function createFormatter(config: Config) { + const chainTypeFormatter = new ChainTypeFormatter([]); + const circularReferenceTypeFormatter = new CircularReferenceTypeFormatter( + chainTypeFormatter + ); + + chainTypeFormatter + .addTypeFormatter( + new AnnotatedTypeFormatter(circularReferenceTypeFormatter) + ) + + .addTypeFormatter(new StringTypeFormatter()) + .addTypeFormatter(new NumberTypeFormatter()) + .addTypeFormatter(new BooleanTypeFormatter()) + .addTypeFormatter(new NullTypeFormatter()) + + .addTypeFormatter(new AnyTypeFormatter()) + .addTypeFormatter(new UndefinedTypeFormatter()) + .addTypeFormatter(new UnknownTypeFormatter()) + .addTypeFormatter(new VoidTypeFormatter()) + + .addTypeFormatter(new LiteralTypeFormatter()) + .addTypeFormatter(new EnumTypeFormatter()) + + .addTypeFormatter( + new ReferenceTypeFormatter( + circularReferenceTypeFormatter, + config.encodeRefs ?? true + ) + ) + .addTypeFormatter( + new DefinitionTypeFormatter( + circularReferenceTypeFormatter, + config.encodeRefs ?? true + ) + ) + .addTypeFormatter(new ObjectTypeFormatter(circularReferenceTypeFormatter)) + .addTypeFormatter(new AliasTypeFormatter(circularReferenceTypeFormatter)) + + .addTypeFormatter(new PrimitiveUnionTypeFormatter()) + .addTypeFormatter(new LiteralUnionTypeFormatter()) + + .addTypeFormatter(new OptionalTypeFormatter(circularReferenceTypeFormatter)) + .addTypeFormatter(new RestTypeFormatter(circularReferenceTypeFormatter)) + + .addTypeFormatter(new ArrayTypeFormatter(circularReferenceTypeFormatter)) + .addTypeFormatter(new TupleTypeFormatter(circularReferenceTypeFormatter)) + .addTypeFormatter(new UnionTypeFormatter(circularReferenceTypeFormatter)) + .addTypeFormatter( + new IntersectionTypeFormatter(circularReferenceTypeFormatter) + ); + + return circularReferenceTypeFormatter; +} + +/** + * 程序主入口 + */ +async function main() { + const dir = path.join(__dirname, '../src/schemas'); + const outDir = path.join(__dirname, '../'); + const tsConfig = path.join(__dirname, '../tsconfig.json'); + + const config = { + path: path.join(dir, 'index.ts'), + tsconfig: tsConfig, + type: 'PageSchema' + }; + + const program = tsj.createProgram(config); + const parser = tsj.createParser(program, config); + const formatter = createFormatter(config); + + const generator = new tsj.SchemaGenerator(program, parser, formatter, config); + const schema = generator.createSchema(config.type); + + const outputFile = path.join(outDir, 'schema.json'); + mkdirp(path.dirname(outputFile)); + fs.writeFileSync(outputFile, JSON.stringify(schema, null, 2)); +} + +main().catch(e => console.error(e)); diff --git a/build/embed-packager.js b/scripts/embed-packager.js similarity index 100% rename from build/embed-packager.js rename to scripts/embed-packager.js diff --git a/build/generate-search-data.js b/scripts/generate-search-data.js similarity index 100% rename from build/generate-search-data.js rename to scripts/generate-search-data.js diff --git a/build/md-parser.js b/scripts/md-parser.js similarity index 100% rename from build/md-parser.js rename to scripts/md-parser.js diff --git a/scripts/schema-tools/OptionalTypeFormatter.ts b/scripts/schema-tools/OptionalTypeFormatter.ts new file mode 100644 index 000000000..336d88061 --- /dev/null +++ b/scripts/schema-tools/OptionalTypeFormatter.ts @@ -0,0 +1,34 @@ +import { + SubTypeFormatter, + TypeFormatter, + BaseType, + Definition +} from 'ts-json-schema-generator'; + +export class OptionalType extends BaseType { + public constructor(private item: BaseType) { + super(); + } + + public getId(): string { + return this.item.getId() + '?'; + } + + public getType(): BaseType { + return this.item; + } +} + +export class OptionalTypeFormatter implements SubTypeFormatter { + public constructor(private childTypeFormatter: TypeFormatter) {} + + public supportsType(type: OptionalType): boolean { + return type instanceof OptionalType; + } + public getDefinition(type: OptionalType): Definition { + return this.childTypeFormatter.getDefinition(type.getType()); + } + public getChildren(type: OptionalType): BaseType[] { + return this.childTypeFormatter.getChildren(type.getType()); + } +} diff --git a/scripts/schema-tools/RestTypeFormatter.ts b/scripts/schema-tools/RestTypeFormatter.ts new file mode 100644 index 000000000..76026351b --- /dev/null +++ b/scripts/schema-tools/RestTypeFormatter.ts @@ -0,0 +1,35 @@ +import { + SubTypeFormatter, + TypeFormatter, + Definition, + BaseType, + ArrayType +} from 'ts-json-schema-generator'; + +export class RestType extends BaseType { + public constructor(private item: ArrayType) { + super(); + } + + public getId(): string { + return '...' + this.item.getId(); + } + + public getType(): ArrayType { + return this.item; + } +} + +export class RestTypeFormatter implements SubTypeFormatter { + public constructor(private childTypeFormatter: TypeFormatter) {} + + public supportsType(type: RestType): boolean { + return type instanceof RestType; + } + public getDefinition(type: RestType): Definition { + return this.childTypeFormatter.getDefinition(type.getType()); + } + public getChildren(type: RestType): BaseType[] { + return this.childTypeFormatter.getChildren(type.getType()); + } +} diff --git a/scripts/schema-tools/UnionTypeFormatter.ts b/scripts/schema-tools/UnionTypeFormatter.ts new file mode 100644 index 000000000..95f3b7451 --- /dev/null +++ b/scripts/schema-tools/UnionTypeFormatter.ts @@ -0,0 +1,19 @@ +import { + UnionTypeFormatter as BaseUnionTypeFormatter, + UnionType, + Definition, + TypeFormatter +} from 'ts-json-schema-generator'; + +export class UnionTypeFormatter extends BaseUnionTypeFormatter { + public constructor(protected _childTypeFormatter: TypeFormatter) { + super(_childTypeFormatter); + } + + getDefinition(type: UnionType): Definition { + // toDo + // 目前这块生成的 anyOf + // 既然 json-schema-draft-07 已经支持 if else 了，改成那样应该更加精准。 + return super.getDefinition(type); + } +} diff --git a/scripts/schema-tools/VoidTypeFormatter.ts b/scripts/schema-tools/VoidTypeFormatter.ts new file mode 100644 index 000000000..99431bb67 --- /dev/null +++ b/scripts/schema-tools/VoidTypeFormatter.ts @@ -0,0 +1,19 @@ +import {BaseType, SubTypeFormatter, Definition} from 'ts-json-schema-generator'; + +export class VoidType extends BaseType { + public getId(): string { + return 'void'; + } +} + +export class VoidTypeFormatter implements SubTypeFormatter { + public supportsType(type: VoidType): boolean { + return type instanceof VoidType; + } + public getDefinition(type: VoidType): Definition { + return {type: 'null'}; + } + public getChildren(type: VoidType): BaseType[] { + return []; + } +} diff --git a/build/upload2cdn.js b/scripts/upload2cdn.js similarity index 100% rename from build/upload2cdn.js rename to scripts/upload2cdn.js diff --git a/src/renderers/Tpl.tsx b/src/renderers/Tpl.tsx index 7631718b4..faa18296b 100644 --- a/src/renderers/Tpl.tsx +++ b/src/renderers/Tpl.tsx @@ -4,13 +4,10 @@ import {filter} from '../utils/tpl'; import cx from 'classnames'; import {anyChanged} from '../utils/helper'; import {escapeHtml} from '../utils/tpl-builtin'; +import {TplSchema} from '../schemas/Tpl'; -export interface TplProps extends RendererProps { +export interface TplProps extends RendererProps, TplSchema { className?: string; - tpl?: string; - html?: string; - text?: string; - raw?: string; value?: string; wrapperComponent?: any; inline?: boolean; diff --git a/src/schemas/Action.ts b/src/schemas/Action.ts new file mode 100644 index 000000000..d3231d4ca --- /dev/null +++ b/src/schemas/Action.ts @@ -0,0 +1,104 @@ +import { + SchemaClassName, + SchemaExpression, + SchemaApi, + SchemaReload, + SchemaTpl +} from './Schema'; + +export type ButtonSchema = { + block?: boolean; + className?: SchemaClassName; + + disabled?: boolean; + disabledOn?: SchemaExpression; + + hidden?: boolean; + hiddenOn?: SchemaExpression; + + icon?: string; + iconClassName?: SchemaClassName; + + label?: string; + + level?: 'info' | 'success' | 'warning' | 'danger' | 'link' | 'primary'; + + primary?: boolean; + + size?: 'xs' | 'sm' | 'md' | 'lg'; + + tooltip?: string; + tooltipPlacement?: 'top' | 'right' | 'bottom' | 'left'; + + type: 'button' | 'submit' | 'reset'; + + visible?: boolean; + visibleOn?: SchemaExpression; + + confirmText?: string; +}; + +export interface AjaxActionSchema extends ButtonSchema { + actionType: 'ajax'; + api: SchemaApi; + + // todo + feedback?: any; + + reload?: SchemaReload; +} + +export interface UrlActionSchema extends ButtonSchema { + actionType: 'url'; + blank?: boolean; + + url: string; +} + +export interface DialogActionSchema extends ButtonSchema { + actionType: 'dialog'; + // todo + dialog: any; + + nextCondition?: SchemaExpression; + reload?: SchemaReload; +} + +export interface DrawerActionSchema extends ButtonSchema { + actionType: 'drawer'; + // todo + drawer: any; + + nextCondition?: SchemaExpression; + reload?: SchemaReload; +} + +export interface CopyActionSchema extends ButtonSchema { + actionType: 'copy'; + copy: SchemaTpl; +} + +export interface LinkActionSchema extends ButtonSchema { + actionType: 'link'; + link: string; +} + +export interface ReloadActionSchema extends ButtonSchema { + actionType: 'reload'; + target: SchemaReload; +} + +export interface OtherActionSchema extends ButtonSchema { + actionType: 'prev' | 'next' | 'cancel' | 'close' | 'submit' | 'confirm'; + [propName: string]: any; +} + +export type ActionSchema = + | AjaxActionSchema + | UrlActionSchema + | LinkActionSchema + | DialogActionSchema + | DrawerActionSchema + | CopyActionSchema + | ReloadActionSchema + | OtherActionSchema; diff --git a/src/schemas/Form/BaseItem.ts b/src/schemas/Form/BaseItem.ts new file mode 100644 index 000000000..48e997c21 --- /dev/null +++ b/src/schemas/Form/BaseItem.ts @@ -0,0 +1,27 @@ +export interface FormBaseControl { + size?: 'xs' | 'sm' | 'md' | 'lg'; + + label?: string; + + name?: string; + + // todo + remark?: string; + + // todo + labelRemark?: string; + + /** + * 输入提示，聚焦的时候显示 + */ + hint?: string; + + /** + * 当修改完的时候是否提交表单。 + */ + submitOnChange?: boolean; + + readOnly?: boolean; + + disabled?: boolean; +} diff --git a/src/schemas/Form/Text.ts b/src/schemas/Form/Text.ts new file mode 100644 index 000000000..a5680a472 --- /dev/null +++ b/src/schemas/Form/Text.ts @@ -0,0 +1,21 @@ +import {FormBaseControl} from './BaseItem'; +import {ActionSchema} from '../Action'; + +export interface TextControlSchema extends FormBaseControl { + type: 'text' | 'email' | 'password' | 'url'; + + /** + * 是否去除首尾空白 + */ + trimContents?: string; + + addOn?: ( + | ActionSchema + | { + type: 'text'; + label: string; + } + ) & { + position?: 'left' | 'right'; + }; +} diff --git a/src/schemas/Form/index.ts b/src/schemas/Form/index.ts new file mode 100644 index 000000000..35eef3767 --- /dev/null +++ b/src/schemas/Form/index.ts @@ -0,0 +1,30 @@ +import {ActionSchema} from '../Action'; +import {SchemaDefaultData, SchemaApi} from '../Schema'; + +// todo +export type FormControlSchema = any; + +/** + * amis Form 渲染器，格式说明。https://baidu.gitee.io/amis/docs/components/form/index + */ +export interface FormSchema { + type: 'form'; + title?: string; + + actions?: Array; + controls?: Array; + + data?: SchemaDefaultData; + + debug?: boolean; + + /** + * Form 用来保存数据的 api。 + */ + api?: SchemaApi; + + /** + * 用来初始化表单数据 + */ + initApi?: SchemaApi; +} diff --git a/src/schemas/Page.ts b/src/schemas/Page.ts new file mode 100644 index 000000000..74e86ac96 --- /dev/null +++ b/src/schemas/Page.ts @@ -0,0 +1,101 @@ +import { + SchemaContainer, + SchemaClassName, + SchemaApi, + SchemaExpression, + SchemaName, + SchemaDefaultData, + SchemaSchema, + BaseSchema +} from './Schema'; + +/** + * amis Page 渲染器。详情请见：https://baidu.gitee.io/amis/docs/components/page + */ +export interface PageSchema extends BaseSchema { + /** + * 指定为 page 渲染器。 + */ + type: 'page'; + + /** + * 页面标题 + */ + title?: string; + + /** + * 页面副标题 + */ + subTitle?: string; + + /** + * 页面描述, 标题旁边会出现个小图标，放上去会显示这个属性配置的内容。 + */ + remark?: string; // todo + + /** + * 内容区域 + */ + body?: SchemaContainer; + + /** + * 内容区 css 类名 + */ + bodyClassName?: SchemaClassName; + + /** + * 边栏区域 + */ + aside?: SchemaContainer; + + /** + * 边栏区 css 类名 + */ + asideClassName?: SchemaClassName; + + /** + * 配置容器 className + */ + className?: SchemaClassName; + + data?: SchemaDefaultData; + + /** + * 配置 header 容器 className + */ + headerClassName?: SchemaClassName; + + /** + * 页面初始化的时候，可以设置一个 API 让其取拉取，发送数据会携带当前 data 数据（包含地址栏参数），获取得数据会合并到 data 中，供组件内使用。 + */ + initApi?: SchemaApi; + + /** + * 是否默认就拉取？ + */ + initFetch?: boolean; + + /** + * 是否默认就拉取表达式 + */ + initFetchOn?: SchemaExpression; + + messages?: { + fetchFailed?: string; + fetchSuccess?: string; + }; + + name?: SchemaName; + + /** + * 页面顶部区域，当存在 title 时在右上角显示。 + */ + toolbar?: SchemaContainer; + + /** + * 配置 toolbar 容器 className + */ + toolbarClassName?: SchemaClassName; + + definitions?: any; +} diff --git a/src/schemas/Remark.ts b/src/schemas/Remark.ts new file mode 100644 index 000000000..e69de29bb diff --git a/src/schemas/Schema.ts b/src/schemas/Schema.ts new file mode 100644 index 000000000..6d314ea31 --- /dev/null +++ b/src/schemas/Schema.ts @@ -0,0 +1,123 @@ +import {PageSchema} from './Page'; +import {FormSchema} from './Form'; +import {TplSchema} from './Tpl'; + +// 每加个类型，这补充一下。 +export type SchemaType = 'page' | 'form' | 'tpl' | 'html'; +export type SchemaObject = PageSchema | FormSchema | TplSchema; + +export type SchemaContainer = SchemaObject | Array | SchemaTpl; + +/** + * 表达式，语法 `data.xxx > 5`。 + */ +export type SchemaExpression = string; + +// /** +// * css类名，配置字符串，或者对象。 +// * +// * className: "red" +// * +// * 用对象配置时意味着你能跟表达式一起搭配使用，如： +// * +// * className: { +// * "red": "data.progress > 80", +// * "blue": "data.progress > 60" +// * } +// */ +// export type SchemaClassName = +// | string +// | { +// [propName: string]: true | false | null | SchemaExpression; +// }; + +/** + * css类名，字符串格式 + */ +export type SchemaClassName = string; // todo 支持上面那种格式。 + +export type SchemaApi = + | string + | { + /** + * API 发送类型 + */ + method?: 'get' | 'post' | 'put' | 'delete' | 'patch'; + + /** + * API 发送目标地址 + */ + url: string; + + /** + * 用来控制携带数据. 当key 为 `&` 值为 `$$` 时, 将所有原始数据打平设置到 data 中. 当值为 $$ 将所有原始数据赋值到对应的 key 中. 当值为 $ 打头时, 将变量值设置到 key 中. + */ + data?: { + [propName: string]: any; + }; + + /** + * 发送体的格式 + */ + dataType?: 'json' | 'form-data' | 'form'; + + /** + * 如果是文件下载接口，请配置这个。 + */ + responseType?: 'blob'; + + /** + * 携带 headers，用法和 data 一样，可以用变量。 + */ + headers?: { + [propName: string]: string; + }; + + /** + * 设置发送条件 + */ + sendOn?: SchemaExpression; + }; + +/** + * 组件名字，这个名字可以用来定位，用于组件通信 + */ +export type SchemaName = string; + +/** + * 配置刷新动作，这个动作通常在完成渲染器本省的固定动作后出发。 + * + * 一般用来配置目标组件的 name 属性。多个目标可以用逗号隔开。 + * + * 当目标是 windows 时表示刷新整个页面。 + * + * 刷新目标的同时还支持传递参数如： `foo?a=${a}&b=${b},boo?c=${c}` + */ +export type SchemaReload = string; + +/** + * 支持两种语法，但是不能混着用。分别是： + * + * 1. `${xxx}` 或者 `${xxx|upperCase}` + * 2. `<%= data.xxx %>` + * + * + * 更多文档：https://baidu.gitee.io/amis/docs/concepts/template + */ +export type SchemaTpl = string; + +/** + * 初始数据，设置得值可用于组件内部模板使用。 + */ +export type SchemaDefaultData = object; + +/** + * 用来关联 json schema 的，不用管。 + */ +export type SchemaSchema = string; + +export interface BaseSchema { + $schema?: SchemaSchema; + type: SchemaType; + className?: SchemaClassName; +} diff --git a/src/schemas/Tpl.ts b/src/schemas/Tpl.ts new file mode 100644 index 000000000..6ab7c244c --- /dev/null +++ b/src/schemas/Tpl.ts @@ -0,0 +1,18 @@ +import {SchemaSchema, SchemaTpl, BaseSchema} from './Schema'; + +/** + * tpl 渲染器 + */ +export interface TplSchema extends BaseSchema { + /** + * 指定为模板渲染器。 + * + * 文档：https://baidu.gitee.io/amis/docs/concepts/template + */ + type: 'tpl' | 'html'; + + tpl?: SchemaTpl; + html?: SchemaTpl; + text?: SchemaTpl; + raw?: string; +} diff --git a/src/schemas/index.ts b/src/schemas/index.ts new file mode 100644 index 000000000..6683b8340 --- /dev/null +++ b/src/schemas/index.ts @@ -0,0 +1,3 @@ +import {PageSchema} from './Page'; + +export default PageSchema; diff --git a/tsconfig.json b/tsconfig.json index ca4a4c137..6775daa80 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -22,13 +22,6 @@ "skipLibCheck": true }, "include": ["src/**/*"], - "exclude": [ - "node_modules", - "build", - "scripts", - "acceptance-tests", - "webpack", - "jest" - ], + "exclude": ["node_modules", "acceptance-tests", "webpack", "jest"], "types": ["typePatches"] }