@next-core/next-docs 1.2.280 → 1.2.283

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.283](https://github.com/easyops-cn/next-core/compare/@next-core/next-docs@1.2.282...@next-core/next-docs@1.2.283) (2022-07-18)
+
+**Note:** Version bump only for package @next-core/next-docs
+
+
+
+
+
+## [1.2.282](https://github.com/easyops-cn/next-core/compare/@next-core/next-docs@1.2.281...@next-core/next-docs@1.2.282) (2022-07-18)
+
+**Note:** Version bump only for package @next-core/next-docs
+
+
+
+
+
+## [1.2.281](https://github.com/easyops-cn/next-core/compare/@next-core/next-docs@1.2.280...@next-core/next-docs@1.2.281) (2022-07-15)
+
+**Note:** Version bump only for package @next-core/next-docs
+
+
+
+
+
 ## [1.2.280](https://github.com/easyops-cn/next-core/compare/@next-core/next-docs@1.2.279...@next-core/next-docs@1.2.280) (2022-07-15)
 
 **Note:** Version bump only for package @next-core/next-docs

package/dist/brick-types.builtinbrickeventhandler.action.md

@@ -16,6 +16,6 @@ custom_edit_url: null
 **Signature:**
 
 ```typescript
-action: "history.push" | "history.replace" | "history.goBack" | "history.goForward" | "history.reload" | "history.pushQuery" | "history.replaceQuery" | "history.pushAnchor" | "history.block" | "history.unblock" | "segue.push" | "segue.replace" | "alias.push" | "alias.replace" | "localStorage.setItem" | "localStorage.removeItem" | "sessionStorage.setItem" | "sessionStorage.removeItem" | "legacy.go" | "location.reload" | "location.assign" | "window.open" | "event.preventDefault" | "console.log" | "console.error" | "console.warn" | "console.info" | "message.success" | "message.error" | "message.info" | "message.warn" | "handleHttpError" | "context.assign" | "context.replace" | "state.update" | "tpl.dispatchEvent" | "message.subscribe" | "message.unsubscribe" | "theme.setDarkTheme" | "theme.setLightTheme" | "theme.setTheme" | "mode.setDashboardMode" | "mode.setDefaultMode" | "menu.clearMenuTitleCache" | "menu.clearMenuCache" | "analytics.event";
+action: "history.push" | "history.replace" | "history.goBack" | "history.goForward" | "history.reload" | "history.pushQuery" | "history.replaceQuery" | "history.pushAnchor" | "history.block" | "history.unblock" | "segue.push" | "segue.replace" | "alias.push" | "alias.replace" | "localStorage.setItem" | "localStorage.removeItem" | "sessionStorage.setItem" | "sessionStorage.removeItem" | "legacy.go" | "location.reload" | "location.assign" | "window.open" | "event.preventDefault" | "console.log" | "console.error" | "console.warn" | "console.info" | "message.success" | "message.error" | "message.info" | "message.warn" | "handleHttpError" | "context.assign" | "context.replace" | "state.update" | "tpl.dispatchEvent" | "message.subscribe" | "message.unsubscribe" | "theme.setDarkTheme" | "theme.setLightTheme" | "theme.setTheme" | "mode.setDashboardMode" | "mode.setDefaultMode" | "menu.clearMenuTitleCache" | "menu.clearMenuCache" | "preview.debug" | "analytics.event";
 ```
 

package/dist/brick-types.builtinbrickeventhandler.md

@@ -23,7 +23,7 @@ export interface BuiltinBrickEventHandler
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [action](./brick-types.builtinbrickeventhandler.action.md) | "history.push" \| "history.replace" \| "history.goBack" \| "history.goForward" \| "history.reload" \| "history.pushQuery" \| "history.replaceQuery" \| "history.pushAnchor" \| "history.block" \| "history.unblock" \| "segue.push" \| "segue.replace" \| "alias.push" \| "alias.replace" \| "localStorage.setItem" \| "localStorage.removeItem" \| "sessionStorage.setItem" \| "sessionStorage.removeItem" \| "legacy.go" \| "location.reload" \| "location.assign" \| "window.open" \| "event.preventDefault" \| "console.log" \| "console.error" \| "console.warn" \| "console.info" \| "message.success" \| "message.error" \| "message.info" \| "message.warn" \| "handleHttpError" \| "context.assign" \| "context.replace" \| "state.update" \| "tpl.dispatchEvent" \| "message.subscribe" \| "message.unsubscribe" \| "theme.setDarkTheme" \| "theme.setLightTheme" \| "theme.setTheme" \| "mode.setDashboardMode" \| "mode.setDefaultMode" \| "menu.clearMenuTitleCache" \| "menu.clearMenuCache" \| "analytics.event" | 处理动作名。 |
+|  [action](./brick-types.builtinbrickeventhandler.action.md) | "history.push" \| "history.replace" \| "history.goBack" \| "history.goForward" \| "history.reload" \| "history.pushQuery" \| "history.replaceQuery" \| "history.pushAnchor" \| "history.block" \| "history.unblock" \| "segue.push" \| "segue.replace" \| "alias.push" \| "alias.replace" \| "localStorage.setItem" \| "localStorage.removeItem" \| "sessionStorage.setItem" \| "sessionStorage.removeItem" \| "legacy.go" \| "location.reload" \| "location.assign" \| "window.open" \| "event.preventDefault" \| "console.log" \| "console.error" \| "console.warn" \| "console.info" \| "message.success" \| "message.error" \| "message.info" \| "message.warn" \| "handleHttpError" \| "context.assign" \| "context.replace" \| "state.update" \| "tpl.dispatchEvent" \| "message.subscribe" \| "message.unsubscribe" \| "theme.setDarkTheme" \| "theme.setLightTheme" \| "theme.setTheme" \| "mode.setDashboardMode" \| "mode.setDefaultMode" \| "menu.clearMenuTitleCache" \| "menu.clearMenuCache" \| "preview.debug" \| "analytics.event" | 处理动作名。 |
 |  [args](./brick-types.builtinbrickeventhandler.args.md) | unknown\[\] | 传递的参数列表 |
 |  [callback](./brick-types.builtinbrickeventhandler.callback.md) | [BrickEventHandlerCallback](./brick-types.brickeventhandlercallback.md) | 事件处理回调。 |
 |  [if](./brick-types.builtinbrickeventhandler.if.md) | string \| boolean | 根据条件决定是否执行该动作。 |

package/dist/brick-types.contract.md

@@ -24,7 +24,8 @@ export interface Contract
 |  [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"; } |  |
+|  [request](./brick-types.contract.request.md) | [ContractRequest](./brick-types.contractrequest.md) |  |
+|  [response](./brick-types.contract.response.md) | [ContractResponse](./brick-types.contractresponse.md) |  |
 |  [serviceName](./brick-types.contract.servicename.md) | string |  |
 |  [version](./brick-types.contract.version.md) | string |  |
 

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

@@ -0,0 +1,21 @@
+---
+id: brick-types.contract.request
+title: Contract.request
+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; [request](./brick-types.contract.request.md)
+
+## Contract.request property
+
+**Signature:**
+
+```typescript
+request?: ContractRequest;
+```
+
+**Reference:** [ContractRequest](./brick-types.contractrequest.md)
+

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

@@ -14,9 +14,8 @@ custom_edit_url: null
 **Signature:**
 
 ```typescript
-response: {
-        wrapper?: boolean;
-        type?: "file" | "object";
-    };
+response?: ContractResponse;
 ```
 
+**Reference:** [ContractResponse](./brick-types.contractresponse.md)
+

package/dist/brick-types.contractfield.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.contractfield
+title: ContractField
+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; [ContractField](./brick-types.contractfield.md)
+
+## ContractField interface
+
+**Signature:**
+
+```typescript
+export declare type ContractField = ContractFieldItem | ContractFieldRefItem;
+```
+
+**Reference:** [ContractFieldItem](./brick-types.contractfielditem.md)<!-- -->, [ContractFieldRefItem](./brick-types.contractfieldrefitem.md)
+

package/dist/brick-types.contractfielditem.description.md

@@ -0,0 +1,19 @@
+---
+id: brick-types.contractfielditem.description
+title: ContractFieldItem.description
+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; [ContractFieldItem](./brick-types.contractfielditem.md) &gt; [description](./brick-types.contractfielditem.description.md)
+
+## ContractFieldItem.description property
+
+**Signature:**
+
+```typescript
+description: string;
+```
+

package/dist/brick-types.contractfielditem.fields.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.contractfielditem.fields
+title: ContractFieldItem.fields
+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; [ContractFieldItem](./brick-types.contractfielditem.md) &gt; [fields](./brick-types.contractfielditem.fields.md)
+
+## ContractFieldItem.fields property
+
+**Signature:**
+
+```typescript
+fields?: (ContractFieldItem | ContractFieldRefItem)[];
+```
+
+**Reference:** [ContractFieldItem](./brick-types.contractfielditem.md)<!-- -->, [ContractFieldRefItem](./brick-types.contractfieldrefitem.md)
+

package/dist/brick-types.contractfielditem.md

@@ -0,0 +1,28 @@
+---
+id: brick-types.contractfielditem
+title: ContractFieldItem
+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; [ContractFieldItem](./brick-types.contractfielditem.md)
+
+## ContractFieldItem interface
+
+**Signature:**
+
+```typescript
+export interface ContractFieldItem
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [description](./brick-types.contractfielditem.description.md) | string |  |
+|  [fields](./brick-types.contractfielditem.fields.md) | ([ContractFieldItem](./brick-types.contractfielditem.md) \| [ContractFieldRefItem](./brick-types.contractfieldrefitem.md)<!-- -->)\[\] |  |
+|  [name](./brick-types.contractfielditem.name.md) | string |  |
+|  [type](./brick-types.contractfielditem.type.md) | string |  |
+

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

@@ -0,0 +1,19 @@
+---
+id: brick-types.contractfielditem.name
+title: ContractFieldItem.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; [ContractFieldItem](./brick-types.contractfielditem.md) &gt; [name](./brick-types.contractfielditem.name.md)
+
+## ContractFieldItem.name property
+
+**Signature:**
+
+```typescript
+name: string;
+```
+

package/dist/brick-types.contractfielditem.type.md

@@ -0,0 +1,19 @@
+---
+id: brick-types.contractfielditem.type
+title: ContractFieldItem.type
+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; [ContractFieldItem](./brick-types.contractfielditem.md) &gt; [type](./brick-types.contractfielditem.type.md)
+
+## ContractFieldItem.type property
+
+**Signature:**
+
+```typescript
+type: string;
+```
+

package/dist/brick-types.contractfieldrefitem.md

@@ -0,0 +1,25 @@
+---
+id: brick-types.contractfieldrefitem
+title: ContractFieldRefItem
+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; [ContractFieldRefItem](./brick-types.contractfieldrefitem.md)
+
+## ContractFieldRefItem interface
+
+**Signature:**
+
+```typescript
+export interface ContractFieldRefItem
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [ref](./brick-types.contractfieldrefitem.ref.md) | string |  |
+

package/dist/brick-types.contractfieldrefitem.ref.md

@@ -0,0 +1,19 @@
+---
+id: brick-types.contractfieldrefitem.ref
+title: ContractFieldRefItem.ref
+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; [ContractFieldRefItem](./brick-types.contractfieldrefitem.md) &gt; [ref](./brick-types.contractfieldrefitem.ref.md)
+
+## ContractFieldRefItem.ref property
+
+**Signature:**
+
+```typescript
+ref: string;
+```
+

package/dist/brick-types.contractrequest.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.contractrequest
+title: ContractRequest
+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; [ContractRequest](./brick-types.contractrequest.md)
+
+## ContractRequest interface
+
+**Signature:**
+
+```typescript
+export declare type ContractRequest = Omit<ContractResponse, "wrapper">;
+```
+
+**Reference:** [ContractResponse](./brick-types.contractresponse.md)
+

package/dist/brick-types.contractresponse.default.md

@@ -0,0 +1,19 @@
+---
+id: brick-types.contractresponse.default
+title: ContractResponse.default
+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; [ContractResponse](./brick-types.contractresponse.md) &gt; [default](./brick-types.contractresponse.default.md)
+
+## ContractResponse.default property
+
+**Signature:**
+
+```typescript
+default?: Record<string, any>;
+```
+

package/dist/brick-types.contractresponse.description.md

@@ -0,0 +1,19 @@
+---
+id: brick-types.contractresponse.description
+title: ContractResponse.description
+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; [ContractResponse](./brick-types.contractresponse.md) &gt; [description](./brick-types.contractresponse.description.md)
+
+## ContractResponse.description property
+
+**Signature:**
+
+```typescript
+description?: string;
+```
+

package/dist/brick-types.contractresponse.fields.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.contractresponse.fields
+title: ContractResponse.fields
+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; [ContractResponse](./brick-types.contractresponse.md) &gt; [fields](./brick-types.contractresponse.fields.md)
+
+## ContractResponse.fields property
+
+**Signature:**
+
+```typescript
+fields?: ContractField[];
+```
+
+**Reference:** [ContractField](./brick-types.contractfield.md)
+

package/dist/brick-types.contractresponse.md

@@ -0,0 +1,30 @@
+---
+id: brick-types.contractresponse
+title: ContractResponse
+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; [ContractResponse](./brick-types.contractresponse.md)
+
+## ContractResponse interface
+
+**Signature:**
+
+```typescript
+export interface ContractResponse
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [default](./brick-types.contractresponse.default.md) | Record&lt;string, any&gt; |  |
+|  [description](./brick-types.contractresponse.description.md) | string |  |
+|  [fields](./brick-types.contractresponse.fields.md) | [ContractField](./brick-types.contractfield.md)<!-- -->\[\] |  |
+|  [required](./brick-types.contractresponse.required.md) | string\[\] |  |
+|  [type](./brick-types.contractresponse.type.md) | "file" \| "object" |  |
+|  [wrapper](./brick-types.contractresponse.wrapper.md) | boolean |  |
+

package/dist/brick-types.contractresponse.required.md

@@ -0,0 +1,19 @@
+---
+id: brick-types.contractresponse.required
+title: ContractResponse.required
+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; [ContractResponse](./brick-types.contractresponse.md) &gt; [required](./brick-types.contractresponse.required.md)
+
+## ContractResponse.required property
+
+**Signature:**
+
+```typescript
+required?: string[];
+```
+

package/dist/brick-types.contractresponse.type.md

@@ -0,0 +1,19 @@
+---
+id: brick-types.contractresponse.type
+title: ContractResponse.type
+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; [ContractResponse](./brick-types.contractresponse.md) &gt; [type](./brick-types.contractresponse.type.md)
+
+## ContractResponse.type property
+
+**Signature:**
+
+```typescript
+type?: "file" | "object";
+```
+

package/dist/brick-types.contractresponse.wrapper.md

@@ -0,0 +1,19 @@
+---
+id: brick-types.contractresponse.wrapper
+title: ContractResponse.wrapper
+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; [ContractResponse](./brick-types.contractresponse.md) &gt; [wrapper](./brick-types.contractresponse.wrapper.md)
+
+## ContractResponse.wrapper property
+
+**Signature:**
+
+```typescript
+wrapper?: boolean;
+```
+

package/dist/brick-types.md

@@ -42,6 +42,11 @@ The core types of Brick Next.
 |  [BuiltinBrickEventHandler](./brick-types.builtinbrickeventhandler.md) | 系统内置的事件处理器。 |
 |  [ContextConf](./brick-types.contextconf.md) | 上下文（数据）配置 |
 |  [Contract](./brick-types.contract.md) |  |
+|  [ContractField](./brick-types.contractfield.md) |  |
+|  [ContractFieldItem](./brick-types.contractfielditem.md) |  |
+|  [ContractFieldRefItem](./brick-types.contractfieldrefitem.md) |  |
+|  [ContractRequest](./brick-types.contractrequest.md) |  |
+|  [ContractResponse](./brick-types.contractresponse.md) |  |
 |  [CustomBrickEventHandler](./brick-types.custombrickeventhandler.md) | 使用指定构件进行事件处理的配置。 |
 |  [CustomTemplate](./brick-types.customtemplate.md) | 自定义模板配置。 |
 |  [CustomTemplateConstructor](./brick-types.customtemplateconstructor.md) | 自定义模板构造声明。 |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@next-core/next-docs",
-  "version": "1.2.280",
+  "version": "1.2.283",
   "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.122.13",
-    "@next-core/brick-types": "^2.64.3",
+    "@next-core/brick-kit": "^2.123.1",
+    "@next-core/brick-types": "^2.65.0",
     "fs-extra": "^10.1.0"
   },
-  "gitHead": "0d6a08eafd7c0969db0495a29bd1a99fb3913c07"
+  "gitHead": "63f396f1adcbdef549ce922cc9df40f983dd7f84"
 }