@next-core/next-docs 1.2.233 → 1.2.236

package/CHANGELOG.md

@@ -3,6 +3,30 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.2.236](https://github.com/easyops-cn/next-core/compare/@next-core/next-docs@1.2.235...@next-core/next-docs@1.2.236) (2022-04-07)
+
+**Note:** Version bump only for package @next-core/next-docs
+
+
+
+
+
+## [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)
+
+**Note:** Version bump only for package @next-core/next-docs
+
+
+
+
+
+## [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)
+
+**Note:** Version bump only for package @next-core/next-docs
+
+
+
+
+
 ## [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)
 
 **Note:** Version bump only for package @next-core/next-docs

package/dist/brick-types.contract.endpoint.md

@@ -0,0 +1,25 @@
+---
+id: brick-types.contract.endpoint
+title: Contract.endpoint
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-types](./brick-types.md) &gt; [Contract](./brick-types.contract.md) &gt; [endpoint](./brick-types.contract.endpoint.md)
+
+## Contract.endpoint property
+
+**Signature:**
+
+```typescript
+endpoint: {
+        method: "POST" | "post" | "PUT" | "put" | "GET" | "get" | "DELETE" | "delete" | "LIST" | "list" | "PATCH" | "patch" | "HEAD" | "head";
+        uri: string;
+        ext_fields?: ExtField[];
+    };
+```
+
+**Reference:** [ExtField](./brick-types.extfield.md)
+

package/dist/brick-types.contract.md

@@ -0,0 +1,29 @@
+---
+id: brick-types.contract
+title: Contract
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-types](./brick-types.md) &gt; [Contract](./brick-types.contract.md)
+
+## Contract interface
+
+**Signature:**
+
+```typescript
+export interface Contract
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [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)<!-- -->\[\]; } |  |
+|  [name](./brick-types.contract.name.md) | string |  |
+|  [namespaceId](./brick-types.contract.namespaceid.md) | string |  |
+|  [response](./brick-types.contract.response.md) | { wrapper?: boolean; type?: "file" \| "object"; } |  |
+|  [version](./brick-types.contract.version.md) | string |  |
+

package/dist/brick-types.contract.name.md

@@ -0,0 +1,19 @@
+---
+id: brick-types.contract.name
+title: Contract.name
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-types](./brick-types.md) &gt; [Contract](./brick-types.contract.md) &gt; [name](./brick-types.contract.name.md)
+
+## Contract.name property
+
+**Signature:**
+
+```typescript
+name: string;
+```
+

package/dist/brick-types.contract.namespaceid.md

@@ -0,0 +1,19 @@
+---
+id: brick-types.contract.namespaceid
+title: Contract.namespaceId
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-types](./brick-types.md) &gt; [Contract](./brick-types.contract.md) &gt; [namespaceId](./brick-types.contract.namespaceid.md)
+
+## Contract.namespaceId property
+
+**Signature:**
+
+```typescript
+namespaceId: string;
+```
+

package/dist/brick-types.contract.response.md

@@ -0,0 +1,22 @@
+---
+id: brick-types.contract.response
+title: Contract.response
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-types](./brick-types.md) &gt; [Contract](./brick-types.contract.md) &gt; [response](./brick-types.contract.response.md)
+
+## Contract.response property
+
+**Signature:**
+
+```typescript
+response: {
+        wrapper?: boolean;
+        type?: "file" | "object";
+    };
+```
+

package/dist/brick-types.contract.version.md

@@ -0,0 +1,19 @@
+---
+id: brick-types.contract.version
+title: Contract.version
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-types](./brick-types.md) &gt; [Contract](./brick-types.contract.md) &gt; [version](./brick-types.contract.version.md)
+
+## Contract.version property
+
+**Signature:**
+
+```typescript
+version: string;
+```
+

package/dist/brick-types.extfield.md

@@ -0,0 +1,26 @@
+---
+id: brick-types.extfield
+title: ExtField
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-types](./brick-types.md) &gt; [ExtField](./brick-types.extfield.md)
+
+## ExtField interface
+
+**Signature:**
+
+```typescript
+export interface ExtField
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [name](./brick-types.extfield.name.md) | string |  |
+|  [source](./brick-types.extfield.source.md) | "body" \| "query" |  |
+

package/dist/brick-types.extfield.name.md

@@ -0,0 +1,19 @@
+---
+id: brick-types.extfield.name
+title: ExtField.name
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-types](./brick-types.md) &gt; [ExtField](./brick-types.extfield.md) &gt; [name](./brick-types.extfield.name.md)
+
+## ExtField.name property
+
+**Signature:**
+
+```typescript
+name?: string;
+```
+

package/dist/brick-types.extfield.source.md

@@ -0,0 +1,19 @@
+---
+id: brick-types.extfield.source
+title: ExtField.source
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-types](./brick-types.md) &gt; [ExtField](./brick-types.extfield.md) &gt; [source](./brick-types.extfield.source.md)
+
+## ExtField.source property
+
+**Signature:**
+
+```typescript
+source?: "body" | "query";
+```
+

package/dist/brick-types.md

@@ -41,6 +41,7 @@ The core types of Brick Next.
 |  [BrickMenuConf](./brick-types.brickmenuconf.md) | 使用构件做数据代理的菜单配置。 |
 |  [BuiltinBrickEventHandler](./brick-types.builtinbrickeventhandler.md) | 系统内置的事件处理器。 |
 |  [ContextConf](./brick-types.contextconf.md) | 上下文（数据）配置 |
+|  [Contract](./brick-types.contract.md) |  |
 |  [CustomBrickEventHandler](./brick-types.custombrickeventhandler.md) | 使用指定构件进行事件处理的配置。 |
 |  [CustomTemplate](./brick-types.customtemplate.md) | 自定义模板配置。 |
 |  [CustomTemplateConstructor](./brick-types.customtemplateconstructor.md) | 自定义模板构造声明。 |
@@ -69,6 +70,7 @@ The core types of Brick Next.
 |  [EntityResolveConf](./brick-types.entityresolveconf.md) | 实体类的异步数据处理配置。 |
 |  [ExecuteCustomBrickEventHandler](./brick-types.executecustombrickeventhandler.md) | 执行指定构件的指定方法的事件处理配置。 |
 |  [ExtendedHistory](./brick-types.extendedhistory.md) | 扩展的系统会话对象。 |
+|  [ExtField](./brick-types.extfield.md) |  |
 |  [FaIcon](./brick-types.faicon.md) | FontAwesome 图标配置。 |
 |  [FeatureFlags](./brick-types.featureflags.md) | 特性开关字典。 |
 |  [GeneralTransform](./brick-types.generaltransform.md) | 数据转换配置。 |

package/dist/brick-types.storyboardmeta.contracts.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.storyboardmeta.contracts
+title: StoryboardMeta.contracts
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-types](./brick-types.md) &gt; [StoryboardMeta](./brick-types.storyboardmeta.md) &gt; [contracts](./brick-types.storyboardmeta.contracts.md)
+
+## StoryboardMeta.contracts property
+
+应用所用到的契约 \*
+
+**Signature:**
+
+```typescript
+contracts: Contract[];
+```
+
+**Reference:** [Contract](./brick-types.contract.md)
+

package/dist/brick-types.storyboardmeta.md

@@ -23,6 +23,7 @@ export interface StoryboardMeta
 
 |  Property | Type | Description |
 |  --- | --- | --- |
+|  [contracts](./brick-types.storyboardmeta.contracts.md) | [Contract](./brick-types.contract.md)<!-- -->\[\] | 应用所用到的契约 \* |
 |  [customTemplates](./brick-types.storyboardmeta.customtemplates.md) | [CustomTemplate](./brick-types.customtemplate.md)<!-- -->\[\] | 应用定义的自定义模板列表。 |
 |  [functions](./brick-types.storyboardmeta.functions.md) | [StoryboardFunction](./brick-types.storyboardfunction.md)<!-- -->\[\] | 应用定义的函数列表。 |
 |  [i18n](./brick-types.storyboardmeta.i18n.md) | [MetaI18n](./brick-types.metai18n.md) | 应用定义的国际化配置表。 |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@next-core/next-docs",
-  "version": "1.2.233",
+  "version": "1.2.236",
   "description": "> TODO: description",
   "homepage": "https://github.com/easyops-cn/next-core/tree/master/packages/next-docs",
   "license": "GPL-3.0",
@@ -21,9 +21,9 @@
   "sideEffects": false,
   "devDependencies": {
     "@easyops-cn/brick-next-pipes": "^0.3.12",
-    "@next-core/brick-kit": "^2.116.0",
-    "@next-core/brick-types": "^2.61.0",
+    "@next-core/brick-kit": "^2.117.1",
+    "@next-core/brick-types": "^2.61.1",
     "fs-extra": "^10.0.1"
   },
-  "gitHead": "c63b557c174b0b04364d3b1e604a285bdee087c3"
+  "gitHead": "ada9d7a8103eccb26c213e3964fd6d66efa13461"
 }