@next-core/next-docs 1.2.232 → 1.2.235
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/CHANGELOG.md +24 -0
- package/dist/brick-types.contract.endpoint.md +25 -0
- package/dist/brick-types.contract.md +29 -0
- package/dist/brick-types.contract.name.md +19 -0
- package/dist/brick-types.contract.namespaceid.md +19 -0
- package/dist/brick-types.contract.response.md +22 -0
- package/dist/brick-types.contract.version.md +19 -0
- package/dist/brick-types.extfield.md +26 -0
- package/dist/brick-types.extfield.name.md +19 -0
- package/dist/brick-types.extfield.source.md +19 -0
- package/dist/brick-types.md +2 -0
- package/dist/brick-types.storyboardmeta.contracts.md +23 -0
- package/dist/brick-types.storyboardmeta.md +1 -0
- package/package.json +4 -4
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,30 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [1.2.235](https://github.com/easyops-cn/next-core/compare/@next-core/next-docs@1.2.234...@next-core/next-docs@1.2.235) (2022-04-06)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @next-core/next-docs
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
## [1.2.234](https://github.com/easyops-cn/next-core/compare/@next-core/next-docs@1.2.233...@next-core/next-docs@1.2.234) (2022-04-06)
|
|
15
|
+
|
|
16
|
+
**Note:** Version bump only for package @next-core/next-docs
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
## [1.2.233](https://github.com/easyops-cn/next-core/compare/@next-core/next-docs@1.2.232...@next-core/next-docs@1.2.233) (2022-04-01)
|
|
23
|
+
|
|
24
|
+
**Note:** Version bump only for package @next-core/next-docs
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
|
|
6
30
|
## [1.2.232](https://github.com/easyops-cn/next-core/compare/@next-core/next-docs@1.2.231...@next-core/next-docs@1.2.232) (2022-03-30)
|
|
7
31
|
|
|
8
32
|
**Note:** Version bump only for package @next-core/next-docs
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: brick-types.contract.endpoint
|
|
3
|
+
title: Contract.endpoint
|
|
4
|
+
hide_title: true
|
|
5
|
+
custom_edit_url: null
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
[API Reference](./index.md) > [@next-core/brick-types](./brick-types.md) > [Contract](./brick-types.contract.md) > [endpoint](./brick-types.contract.endpoint.md)
|
|
11
|
+
|
|
12
|
+
## Contract.endpoint property
|
|
13
|
+
|
|
14
|
+
**Signature:**
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
endpoint: {
|
|
18
|
+
method: "POST" | "post" | "PUT" | "put" | "GET" | "get" | "DELETE" | "delete" | "LIST" | "list" | "PATCH" | "patch" | "HEAD" | "head";
|
|
19
|
+
uri: string;
|
|
20
|
+
ext_fields?: ExtField[];
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
**Reference:** [ExtField](./brick-types.extfield.md)
|
|
25
|
+
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: brick-types.contract
|
|
3
|
+
title: Contract
|
|
4
|
+
hide_title: true
|
|
5
|
+
custom_edit_url: null
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
[API Reference](./index.md) > [@next-core/brick-types](./brick-types.md) > [Contract](./brick-types.contract.md)
|
|
11
|
+
|
|
12
|
+
## Contract interface
|
|
13
|
+
|
|
14
|
+
**Signature:**
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
export interface Contract
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Properties
|
|
21
|
+
|
|
22
|
+
| Property | Type | Description |
|
|
23
|
+
| --- | --- | --- |
|
|
24
|
+
| [endpoint](./brick-types.contract.endpoint.md) | { method: "POST" \| "post" \| "PUT" \| "put" \| "GET" \| "get" \| "DELETE" \| "delete" \| "LIST" \| "list" \| "PATCH" \| "patch" \| "HEAD" \| "head"; uri: string; ext\_fields?: [ExtField](./brick-types.extfield.md)<!-- -->\[\]; } | |
|
|
25
|
+
| [name](./brick-types.contract.name.md) | string | |
|
|
26
|
+
| [namespaceId](./brick-types.contract.namespaceid.md) | string | |
|
|
27
|
+
| [response](./brick-types.contract.response.md) | { wrapper?: boolean; type?: "file" \| "object"; } | |
|
|
28
|
+
| [version](./brick-types.contract.version.md) | string | |
|
|
29
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: brick-types.contract.name
|
|
3
|
+
title: Contract.name
|
|
4
|
+
hide_title: true
|
|
5
|
+
custom_edit_url: null
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
[API Reference](./index.md) > [@next-core/brick-types](./brick-types.md) > [Contract](./brick-types.contract.md) > [name](./brick-types.contract.name.md)
|
|
11
|
+
|
|
12
|
+
## Contract.name property
|
|
13
|
+
|
|
14
|
+
**Signature:**
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
name: string;
|
|
18
|
+
```
|
|
19
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: brick-types.contract.namespaceid
|
|
3
|
+
title: Contract.namespaceId
|
|
4
|
+
hide_title: true
|
|
5
|
+
custom_edit_url: null
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
[API Reference](./index.md) > [@next-core/brick-types](./brick-types.md) > [Contract](./brick-types.contract.md) > [namespaceId](./brick-types.contract.namespaceid.md)
|
|
11
|
+
|
|
12
|
+
## Contract.namespaceId property
|
|
13
|
+
|
|
14
|
+
**Signature:**
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
namespaceId: string;
|
|
18
|
+
```
|
|
19
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: brick-types.contract.response
|
|
3
|
+
title: Contract.response
|
|
4
|
+
hide_title: true
|
|
5
|
+
custom_edit_url: null
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
[API Reference](./index.md) > [@next-core/brick-types](./brick-types.md) > [Contract](./brick-types.contract.md) > [response](./brick-types.contract.response.md)
|
|
11
|
+
|
|
12
|
+
## Contract.response property
|
|
13
|
+
|
|
14
|
+
**Signature:**
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
response: {
|
|
18
|
+
wrapper?: boolean;
|
|
19
|
+
type?: "file" | "object";
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: brick-types.contract.version
|
|
3
|
+
title: Contract.version
|
|
4
|
+
hide_title: true
|
|
5
|
+
custom_edit_url: null
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
[API Reference](./index.md) > [@next-core/brick-types](./brick-types.md) > [Contract](./brick-types.contract.md) > [version](./brick-types.contract.version.md)
|
|
11
|
+
|
|
12
|
+
## Contract.version property
|
|
13
|
+
|
|
14
|
+
**Signature:**
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
version: string;
|
|
18
|
+
```
|
|
19
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: brick-types.extfield
|
|
3
|
+
title: ExtField
|
|
4
|
+
hide_title: true
|
|
5
|
+
custom_edit_url: null
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
[API Reference](./index.md) > [@next-core/brick-types](./brick-types.md) > [ExtField](./brick-types.extfield.md)
|
|
11
|
+
|
|
12
|
+
## ExtField interface
|
|
13
|
+
|
|
14
|
+
**Signature:**
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
export interface ExtField
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Properties
|
|
21
|
+
|
|
22
|
+
| Property | Type | Description |
|
|
23
|
+
| --- | --- | --- |
|
|
24
|
+
| [name](./brick-types.extfield.name.md) | string | |
|
|
25
|
+
| [source](./brick-types.extfield.source.md) | "body" \| "query" | |
|
|
26
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: brick-types.extfield.name
|
|
3
|
+
title: ExtField.name
|
|
4
|
+
hide_title: true
|
|
5
|
+
custom_edit_url: null
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
[API Reference](./index.md) > [@next-core/brick-types](./brick-types.md) > [ExtField](./brick-types.extfield.md) > [name](./brick-types.extfield.name.md)
|
|
11
|
+
|
|
12
|
+
## ExtField.name property
|
|
13
|
+
|
|
14
|
+
**Signature:**
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
name?: string;
|
|
18
|
+
```
|
|
19
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: brick-types.extfield.source
|
|
3
|
+
title: ExtField.source
|
|
4
|
+
hide_title: true
|
|
5
|
+
custom_edit_url: null
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
[API Reference](./index.md) > [@next-core/brick-types](./brick-types.md) > [ExtField](./brick-types.extfield.md) > [source](./brick-types.extfield.source.md)
|
|
11
|
+
|
|
12
|
+
## ExtField.source property
|
|
13
|
+
|
|
14
|
+
**Signature:**
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
source?: "body" | "query";
|
|
18
|
+
```
|
|
19
|
+
|
package/dist/brick-types.md
CHANGED
|
@@ -41,6 +41,7 @@ The core types of Brick Next.
|
|
|
41
41
|
| [BrickMenuConf](./brick-types.brickmenuconf.md) | 使用构件做数据代理的菜单配置。 |
|
|
42
42
|
| [BuiltinBrickEventHandler](./brick-types.builtinbrickeventhandler.md) | 系统内置的事件处理器。 |
|
|
43
43
|
| [ContextConf](./brick-types.contextconf.md) | 上下文(数据)配置 |
|
|
44
|
+
| [Contract](./brick-types.contract.md) | |
|
|
44
45
|
| [CustomBrickEventHandler](./brick-types.custombrickeventhandler.md) | 使用指定构件进行事件处理的配置。 |
|
|
45
46
|
| [CustomTemplate](./brick-types.customtemplate.md) | 自定义模板配置。 |
|
|
46
47
|
| [CustomTemplateConstructor](./brick-types.customtemplateconstructor.md) | 自定义模板构造声明。 |
|
|
@@ -69,6 +70,7 @@ The core types of Brick Next.
|
|
|
69
70
|
| [EntityResolveConf](./brick-types.entityresolveconf.md) | 实体类的异步数据处理配置。 |
|
|
70
71
|
| [ExecuteCustomBrickEventHandler](./brick-types.executecustombrickeventhandler.md) | 执行指定构件的指定方法的事件处理配置。 |
|
|
71
72
|
| [ExtendedHistory](./brick-types.extendedhistory.md) | 扩展的系统会话对象。 |
|
|
73
|
+
| [ExtField](./brick-types.extfield.md) | |
|
|
72
74
|
| [FaIcon](./brick-types.faicon.md) | FontAwesome 图标配置。 |
|
|
73
75
|
| [FeatureFlags](./brick-types.featureflags.md) | 特性开关字典。 |
|
|
74
76
|
| [GeneralTransform](./brick-types.generaltransform.md) | 数据转换配置。 |
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: brick-types.storyboardmeta.contracts
|
|
3
|
+
title: StoryboardMeta.contracts
|
|
4
|
+
hide_title: true
|
|
5
|
+
custom_edit_url: null
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
[API Reference](./index.md) > [@next-core/brick-types](./brick-types.md) > [StoryboardMeta](./brick-types.storyboardmeta.md) > [contracts](./brick-types.storyboardmeta.contracts.md)
|
|
11
|
+
|
|
12
|
+
## StoryboardMeta.contracts property
|
|
13
|
+
|
|
14
|
+
应用所用到的契约 \*
|
|
15
|
+
|
|
16
|
+
**Signature:**
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
contracts: Contract[];
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
**Reference:** [Contract](./brick-types.contract.md)
|
|
23
|
+
|
|
@@ -23,6 +23,7 @@ export interface StoryboardMeta
|
|
|
23
23
|
|
|
24
24
|
| Property | Type | Description |
|
|
25
25
|
| --- | --- | --- |
|
|
26
|
+
| [contracts](./brick-types.storyboardmeta.contracts.md) | [Contract](./brick-types.contract.md)<!-- -->\[\] | 应用所用到的契约 \* |
|
|
26
27
|
| [customTemplates](./brick-types.storyboardmeta.customtemplates.md) | [CustomTemplate](./brick-types.customtemplate.md)<!-- -->\[\] | 应用定义的自定义模板列表。 |
|
|
27
28
|
| [functions](./brick-types.storyboardmeta.functions.md) | [StoryboardFunction](./brick-types.storyboardfunction.md)<!-- -->\[\] | 应用定义的函数列表。 |
|
|
28
29
|
| [i18n](./brick-types.storyboardmeta.i18n.md) | [MetaI18n](./brick-types.metai18n.md) | 应用定义的国际化配置表。 |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@next-core/next-docs",
|
|
3
|
-
"version": "1.2.
|
|
3
|
+
"version": "1.2.235",
|
|
4
4
|
"description": "> TODO: description",
|
|
5
5
|
"homepage": "https://github.com/easyops-cn/next-core/tree/master/packages/next-docs",
|
|
6
6
|
"license": "GPL-3.0",
|
|
@@ -21,9 +21,9 @@
|
|
|
21
21
|
"sideEffects": false,
|
|
22
22
|
"devDependencies": {
|
|
23
23
|
"@easyops-cn/brick-next-pipes": "^0.3.12",
|
|
24
|
-
"@next-core/brick-kit": "^2.
|
|
25
|
-
"@next-core/brick-types": "^2.61.
|
|
24
|
+
"@next-core/brick-kit": "^2.117.0",
|
|
25
|
+
"@next-core/brick-types": "^2.61.1",
|
|
26
26
|
"fs-extra": "^10.0.1"
|
|
27
27
|
},
|
|
28
|
-
"gitHead": "
|
|
28
|
+
"gitHead": "073e810699d616b76f5ce2e99a5d2fddce75bf07"
|
|
29
29
|
}
|