@innet/server 2.0.0-alpha.8 → 2.0.0-beta.1

package/README.md

@@ -46,7 +46,7 @@ Customize
 
 [← back](#index)
 
-The simplest way to start working with `@innet/server`, it is `innetjs` usage.
+The simplest way to start working with `@innet/server`, it is [innetjs](https://www.npmjs.com/package/innetjs) usage.
 
 ```shell
 npx innetjs init my-app -t api
@@ -77,6 +77,28 @@ innet(app, server)
 
 Here is a **Hello World** example:
 
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <return>
+      <success>
+        Hello World!
+      </success>
+    </return>
+  </server>
+)
+```
+
+*Use `npm start` to run this server.*
+
+Open http://localhost
+You will see the `Hello Word!` string.
+
+---
+
+Here is the simplest [api](#api) example:
+
 *src/app.tsx*
 ```typescript jsx
 export default (
@@ -88,7 +110,7 @@ export default (
 
 *Use `npm start` to run this server.*
 
-Open http://localhost:80
+Open http://localhost
 You will see a base Open API JSON structure.
 
 ```json
@@ -107,7 +129,9 @@ You will see a base Open API JSON structure.
 [← back](#index)
 
 [\<server>](#server)   
-[\<api>](#api)
+[\<api>](#api)  
+[\<return>](#return)  
+[\<preset>](#preset)
 
 ---
 
@@ -135,9 +159,9 @@ export default (
 )
 ```
 
-- By default, it uses port `80` for `http` and port `442` for `https`.
-- You can use `PORT` environment variable to set it up on CI level.
-- [innetjs](https://www.npmjs.com/package/innetjs) allows you to use `PORT` in `.env` file of local environment.
+- By default, it uses port `80` for `http` and port `443` for `https`.
+- You can use `INNET_PORT` environment variable to set it up on CI level.
+- [innetjs](https://www.npmjs.com/package/innetjs) allows you to use `INNET_PORT` in `.env` file of local environment.
 
 #### ssl
 
@@ -155,8 +179,8 @@ export default (
 )
 ```
 
-- You can use `SSL_KEY` and `SSL_CRT` environment variables to set it up on CI level.
-- [innetjs](https://www.npmjs.com/package/innetjs) allows you to use `SSL_KEY` and `SSL_CRT` in `.env` file.
+- You can use `INNET_SSL_KEY` and `INNET_SSL_CRT` environment variables to set it up on CI level.
+- [innetjs](https://www.npmjs.com/package/innetjs) allows you to use `INNET_SSL_KEY` and `INNET_SSL_CRT` in `.env` file.
 - You can add `localhost.key` and `localhost.crt` files in your project folder.
 
 #### onStart
@@ -206,12 +230,25 @@ export default (
 )
 ```
 
+#### onClose
+
+Use `onClose` to handle server close action.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server
+    onClose={() => console.log('Close')}
+  />
+)
+```
+
 ### \<api>
 
 [← back](#main)
 
-`<api>` element MUST be placed in `<server>` element.  
 This element defines a REST API on the server.
+This element MUST be placed in [\<server>](#server) element.
 
 #### title
 
@@ -292,7 +329,7 @@ export default (
 )
 ```
 
-*default: 0.0.0*
+*default: `INNET_API_VERSION` || `'0.0.0'`*
 
 #### prefix
 
@@ -308,6 +345,235 @@ export default (
   </server>
 )
 ```
+*default: `INNET_API_PREFIX` || `''`*
+
+#### include
+
+A regular expression scopes the API.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api
+      include={/^\/(api|openapi)/}
+    />
+  </server>
+)
+```
+
+#### exclude
+
+A regular expression does not scope the API.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api prefix='/api' />
+    <api prefix='/openapi' />
+    <api exclude={/^\/(api|openapi)/} />
+  </server>
+)
+```
+
+### \<return>
+
+[← back](#main)
+
+This element MUST be placed in [\<server>](#server) element.
+It defines a run-time call handler for parent element.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <return>
+      <error status={404} />
+    </return>
+  </server>
+)
+```
+*Any request returns 404*
+
+The code runs from top to bottom and from left to right.
+You cannot use two [\<return>](#return) elements one by one,
+the same as you cannot use two `return` one by one for a JS `function`.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <return>
+      <error status={404} />
+    </return>
+    <return>
+      <success />
+    </return>
+  </server>
+)
+```
+
+like
+
+```javascript
+function server () {
+  return 'error'
+  return 'success'
+}
+```
+
+*The second [\<return>](#return) will newer run.*
+
+You can use [\<return>](#return) in some elements like you use `return` in `if` or `while`.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <env is='dev'>
+      <return>
+        <error status={404} />
+      </return>
+    </env>
+    <return>
+      <success />
+    </return>
+  </server>
+)
+```
+
+like
+
+```javascript
+function server () {
+  if (process.env.NODE_ENV === 'dev') {
+    return 'error'
+  }
+
+  return 'success'
+}
+```
+
+Place [\<return>](#return) in [\<api>](#api) to handle any unknown request in the [\<api>](#api).
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <return>
+        <error status={404} />
+      </return>
+    </api>
+  </server>
+)
+```
+
+Place [\<return>](#return) in [\<endpoint>](#endpoint) to handle the [\<endpoint>](#endpoint) request.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <endpoint method='get' path='/my-endpoint'>
+        <return>
+          <success>
+            My Endpoint
+          </success>
+        </return>
+      </endpoint>
+    </api>
+    <return>
+      <success>
+        Any other request
+      </success>
+    </return>
+  </server>
+)
+```
+
+You can place a component inside [\<return>](#return).
+The component will run when the request will be triggered.
+
+*src/app.tsx*
+```typescript jsx
+import { GetPartners } from './GetPartners'
+
+export default (
+  <server>
+    <api>
+      <endpoint method='get' path='/partners'>
+        <return>
+          <GetPartners />
+        </return>
+      </endpoint>
+    </api>
+  </server>
+)
+```
+
+*src/GetPartners.tsx*
+```typescript jsx
+export const GetPartners = () => (
+  <success>
+    {{partners: []}}
+  </success>
+)
+```
+
+### \<preset>
+
+[← back](#main)
+
+`<preset>` element MUST be placed in `<server>` element.  
+This element adds handling of each request.
+It works the same as [\<return>](#return), but do not interrupt the running.
+You can use it to add a `header` or `cookie` or some setup of a parent element.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <preset>
+      <header
+        key='Test'
+        value='Ok'
+      />
+    </preset>
+  </server>
+)
+```
+
+Place the element inside [\<api>](#api) to preset it on the api requests scope.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api prefix='/api'>
+      <preset>
+        <header
+          key='Cache-Control'
+          value='no-cache, no-store, must-revalidate'
+        />
+      </preset>
+      ...Endpoints
+      <return>
+        <success>
+          Header contains `Cache-Control`
+        </success>
+      </return>
+    </api>
+    <return>
+      <success>
+        Header do not contain `Cache-Control`
+      </success>
+    </return>
+  </server>
+)
+```
 
 ## Utils
 
@@ -316,109 +582,399 @@ This section contains elements of utils.
 [← back](#index)
 
 [\<swagger>](#swagger)  
-[\<dev>](#dev)  
-[\<dts>](#dts)
+[\<env>](#env)  
+[\<dts>](#dts)  
+[\<blacklist>](#blacklist)  
+[\<whitelist>](#whitelist)  
+[\<protection>](#protection)
 
 ---
 
 ### \<swagger>
 
-[← back](#utils)
+[← back](#utils)
+
+Use `<swagger>` element to add Swagger UI documentation.
+`<swagger>` element MUST be placed in `<api>` element.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <swagger />
+    </api>
+  </server>
+)
+```
+
+Open http://localhost:80/swagger-ui
+You will see Swagger UI documentation.
+
+You can change the Swagger UI URL path by `path` property of `<swagger>` element.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <swagger path='/swagger' />
+    </api>
+  </server>
+)
+```
+
+### \<env>
+
+[← back](#utils)
+
+This element helps to control content by `process.env`.
+
+There are a required field of `is`.
+If it's a `string` then an environment variable must be equal to the `string`.
+If it's an `array of string` then an environment variable must be included into the `array of string`.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <env is='dev'>
+        <swagger />
+      </env>
+    </api>
+  </server>
+)
+```
+
+*The `<swagger />` will work only if `NODE_ENV` equals `dev`*
+
+#### of
+
+By default `of` equals `NODE_ENV`. You can check eny other environment variable.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <env
+        of='PORT'
+        is={[
+          '3000',
+          '8080',
+        ]}>
+        <swagger />
+      </env>
+    </api>
+  </server>
+)
+```
+
+### \<dts>
+
+[← back](#utils)
+
+Use `<dts>` element to add types generation.
+`<dts>` element MUST be placed in `<api>` element.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <dts />
+    </api>
+  </server>
+)
+```
+
+You do not need to import types, use `Api` namespace everywhere.
+Here is an example of generated types usage.
+
+```typescript jsx
+import { useParams } from '@innet/server'
+
+import { todos } from '../todos'
+
+export function DeleteTodo () {
+  const { todoId } = useParams<Api.Endpoints['DELETE:/todos/{todoId}']['Params']>()
+
+  const todoIndex = todos.findIndex(({ id }) => id === todoId)
+
+  if (todoIndex === -1) {
+    return <error code='todoNotFound' status={404} />
+  }
+
+  todos.splice(todoIndex, 1)
+
+  return <success />
+}
+```
+
+#### path
+
+This is a path of api TypeScript types file, `<dts>` generates it.
+`'src/api.d.ts'` by default.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <dts path='src/types.d.ts' />
+    </api>
+  </server>
+)
+```
+
+#### namespace
+
+This prop changes namespace for generated types. `'Api'` by default.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <dts namespace='API' />
+    </api>
+  </server>
+)
+```
+
+### \<blacklist>
+
+This element MUST be placed in `<api>` element.
+
+[← back](#utils)
+
+This element returns own content for a user from IPs list.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <blacklist>
+        <error />
+      </blacklist>
+    </api>
+  </server>
+)
+```
+
+#### ip
+
+`ip` prop sets black IPs. By default, it equals `INNET_BLACKLIST_IP` node environment variable.
+
+You can split IPs by `,` char.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <blacklist
+        ip='0.1.2.3,3.2.1.0'>
+        <error />
+      </blacklist>
+    </api>
+  </server>
+)
+```
+
+### \<whitelist>
+
+This element MUST be placed in `<api>` element.
+
+[← back](#utils)
+
+This element returns own content for a user IP, which is not in a list.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <whitelist>
+        <error />
+      </whitelist>
+    </api>
+  </server>
+)
+```
+
+#### ip
+
+`ip` prop sets white IPs. By default, it equals `INNET_WHITELIST_IP` node environment variable.
+
+You can split IPs by `,` char.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <whitelist
+        ip='0.1.2.3,3.2.1.0'>
+        <error />
+      </whitelist>
+    </api>
+  </server>
+)
+```
+
+### \<protection>
+
+This element MUST be placed in `<api>` element.
+
+[← back](#utils)
+
+This element adds protection page.
+You can use it when you want to protect your application.
+
+If protection failed content of the element should be used.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <protection>
+        <error
+          code='protection'
+          status='forbidden'
+        />
+      </protection>
+    </api>
+  </server>
+)
+```
+
+#### value
+
+This prop is a secret string of protection value.
+User must provide a protection query param equals the `value`.
+
+By default, the value is `undefined` and protection does not work.
+You can use `PROTECTION` env to set default protection `value`.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <protection value='secret'>
+        <error
+          code='protection'
+          status='forbidden'
+        />
+      </protection>
+    </api>
+  </server>
+)
+```
+
+#### maxAge
+
+This prop sets how much time protection is qualified.
 
-Use `<swagger>` element to add Swagger UI documentation.
-`<swagger>` element MUST be placed in `<api>` element.
+By default, the prop equals a year.
+You can use `INNET_PROTECTION_MAX_AGE` env to set default `maxAge`.
 
 *src/app.tsx*
 ```typescript jsx
 export default (
   <server>
     <api>
-      <swagger />
+      <protection
+        maxAge={24 * 60 * 60}
+        value='secret'>
+        <error
+          code='protection'
+          status='forbidden'
+        />
+      </protection>
     </api>
   </server>
 )
 ```
 
-Open http://localhost:80/swagger-ui
-You will see Swagger UI documentation.
+#### excludeIp
 
-You can change the Swagger UI URL path by `path` property of `<swagger>` element.
+This prop sets a list of IP addresses (split by `,`) to ignore the protection.
+
+You can use `INNET_PROTECTED_IP` env to set default `excludeIp`.
 
 *src/app.tsx*
 ```typescript jsx
 export default (
   <server>
     <api>
-      <swagger path='/swagger' />
+      <protection
+        excludeIp='0.0.0.0,127.0.0.0'
+        value='secret'>
+        <error
+          code='protection'
+          status='forbidden'
+        />
+      </protection>
     </api>
   </server>
 )
 ```
 
-### \<dev>
+#### cookieKey
 
-[← back](#utils)
+This prop sets a cookie field name used to store protection of a user.
 
-Everything inside <dev> will work when `NODE_ENV` equals `development`.
+By default, it equals `protection`.
+You can use `INNET_PROTECTION_COOKIE_KEY` env to set default `cookieKey`.
 
 *src/app.tsx*
 ```typescript jsx
 export default (
   <server>
     <api>
-      <dev>
-        <swagger />
-      </dev>
+      <protection
+        cookieKey='secret'
+        value='secret'>
+        <error
+          code='protection'
+          status='forbidden'
+        />
+      </protection>
     </api>
   </server>
 )
 ```
 
-### \<dts>
-
-[← back](#utils)
+#### searchKey
 
-Use `<dts>` element to add types generation.
-`<dts>` element MUST be placed in `<api>` element.
+This prop sets a search query field name used to check protection.
 
-`<dts>` has a required prop of `path`. This is a path of api TypeScript types file, `<dts>` generates it.
+By default, it equals `protection`.
+You can use `INNET_PROTECTION_SEARCH_KEY` env to set default `searchKey`.
 
 *src/app.tsx*
 ```typescript jsx
 export default (
   <server>
     <api>
-      <dev>
-        <dts path='src/api.d.ts' />
-      </dev>
+      <protection
+        searchKey='secret'
+        value='secret'>
+        <error
+          code='protection'
+          status='forbidden'
+        />
+      </protection>
     </api>
   </server>
 )
 ```
 
-You do not need to import types, use `Api` namespace everywhere.
-Here is an example of generated types usage.
-
-```typescript jsx
-import { useParams } from '@innet/server'
-
-import { todos } from '../todos'
-
-export function DeleteTodo () {
-  const { todoId } = useParams<Api.Endpoints['DELETE:/todos/{todoId}']['Params']>()
-
-  const todoIndex = todos.findIndex(({ id }) => id === todoId)
-
-  if (todoIndex === -1) {
-    return <error code='todoNotFound' status={404} />
-  }
-
-  todos.splice(todoIndex, 1)
-
-  return <success />
-}
-```
-
 ## API Info
 
 The API information elements are here.
@@ -987,6 +1543,7 @@ This element MUST be placed inside `<endpoint>`.
 It defines request body for the endpoint.
 `@innet/server` formats and validate the value automatically (real-time).
 
+*src/app.tsx*
 ```typescript jsx
 return (
   <server>
@@ -1013,25 +1570,283 @@ return (
 )
 ```
 
-### \<response>
-
-[← back](#endpoints)
-
-This element MUST be placed inside `<endpoint>`.
-It defines response body for the endpoint.
-
-## Primitive Data
+### \<response>
+
+[← back](#endpoints)
+
+This element MUST be placed inside `<endpoint>`.
+It defines response body for the endpoint.
+
+*src/app.tsx*
+```typescript jsx
+return (
+  <server>
+    <api>
+      <endpoint method='get' path='/settings'>
+        <response>
+          <object />
+        </response>
+      </endpoint>
+    </api>
+  </server>
+)
+```
+
+#### status
+A status of the `<response>`.
+Any [HTTP status code](https://swagger.io/specification/#http-codes) can be used as a number of the property.
+
+By default, `status` equals `'default'`.
+
+*src/app.tsx*
+```typescript jsx
+return (
+  <server>
+    <api>
+      <endpoint method='get' path='/settings'>
+        <response status={200}>
+          <object />
+        </response>
+      </endpoint>
+    </api>
+  </server>
+)
+```
+
+To define a range of response codes, this field MAY contain the uppercase wildcard character `X`.
+For example, `2XX` represents all response codes between \[200-299].
+Only the following range definitions are allowed: `1XX`, `2XX`, `3XX`, `4XX` and `5XX`.
+
+*src/app.tsx*
+```typescript jsx
+return (
+  <server>
+    <api>
+      <endpoint method='get' path='/settings'>
+        <response status='2XX'>
+          <object />
+        </response>
+      </endpoint>
+    </api>
+  </server>
+)
+```
+
+Many number statuses have a string id you can use on the property.
+
+*src/app.tsx*
+```typescript jsx
+return (
+  <server>
+    <api>
+      <endpoint method='get' path='/settings'>
+        <response status='notFound'>
+          <object />
+        </response>
+      </endpoint>
+    </api>
+  </server>
+)
+```
+
+You can use many `<response>` elements in an endpoint.
+
+*src/app.tsx*
+```typescript jsx
+return (
+  <server>
+    <api>
+      <endpoint method='get' path='/settings'>
+        <response status='2XX'>
+          <object />
+        </response>
+        <response status='4XX'>
+          <object>
+            <field key='error'>
+              <string />
+            </field>
+            <field optional key='data'>
+              <object />
+            </field>
+          </object>
+        </response>
+      </endpoint>
+    </api>
+  </server>
+)
+```
+
+#### type
+A media type of the `<response>`.
+
+By default, `type` equals `'application/json'`.
+
+*src/app.tsx*
+```typescript jsx
+return (
+  <server>
+    <api>
+      <endpoint method='get' path='/hello'>
+        <response type='text/html'>
+          Hello World!
+        </response>
+      </endpoint>
+    </api>
+  </server>
+)
+```
+
+## Primitive Data
+
+[← back](#index)
+
+[\<any>](#any)  
+[\<null>](#null)  
+[\<boolean>](#boolean)  
+[\<string>](#string)  
+[\<number>](#number)  
+[\<integer>](#integer)  
+[\<date>](#date)  
+[\<uuid>](#uuid)  
+[\<binary>](#binary)
+
+---
+
+### \<any>
+
+[← back](#primitive-data)
+
+The element MUST be placed inside one of [\<response>](#response), [\<param>](#param), [\<body>](#body).
+It defines `any` value for a parent element.
+`@innet/server` formats and validate the value automatically (real-time).
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <endpoint method='get' path='/todos'>
+        <param
+          in='query'
+          name='search'>
+          <any />
+        </param>
+      </endpoint>
+    </api>
+  </server>
+)
+```
+
+#### default
+
+A default value for the `any`.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <endpoint method='get' path='/users'>
+        <param
+          in='query'
+          name='search'>
+          <any default={null} />
+        </param>
+      </endpoint>
+    </api>
+  </server>
+)
+```
+
+#### example
+
+An example value.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <endpoint method='get' path='/products'>
+        <param
+          in='query'
+          name='active'>
+          <any example={false} />
+        </param>
+      </endpoint>
+    </api>
+  </server>
+)
+```
+
+#### description
+
+A description of the `any`.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <endpoint method='get' path='/products'>
+        <param
+          in='query'
+          name='active'>
+          <any
+            description='Active products param'
+          />
+        </param>
+      </endpoint>
+    </api>
+  </server>
+)
+```
+
+### \<null>
+
+[← back](#primitive-data)
+
+The element MUST be placed inside one of [\<response>](#response), [\<param>](#param), [\<body>](#body).
+It defines `null` value for a parent element.
+`@innet/server` formats and validate the value automatically (real-time).
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <endpoint method='get' path='/todos'>
+        <param
+          in='query'
+          name='search'>
+          <null />
+        </param>
+      </endpoint>
+    </api>
+  </server>
+)
+```
+
+#### description
 
-[← back](#index)
+A description of the `null`.
 
-[\<null>](#null)  
-[\<boolean>](#boolean)  
-[\<string>](#string)  
-[\<number>](#number)  
-[\<integer>](#integer)  
-[\<date>](#date)  
-[\<uuid>](#uuid)  
-[\<binary>](#binary)
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <endpoint method='get' path='/products'>
+        <param
+          in='query'
+          name='active'>
+          <null description='FIXME!' />
+        </param>
+      </endpoint>
+    </api>
+  </server>
+)
+```
 
 ### \<boolean>
 
@@ -2313,7 +3128,9 @@ export default (
     <api>
       <endpoint method='post' path='/users'>
         <body>
-          <object />
+          <object>
+            <string />
+          </object>
         </body>
       </endpoint>
     </api>
@@ -2374,9 +3191,9 @@ export default (
     <api>
       <endpoint method='post' path='/users'>
         <body>
-        <object
-          description='The object of a user'
-        />
+          <object
+            description='The object of a user'
+          />
         </body>
       </endpoint>
     </api>
@@ -2392,7 +3209,7 @@ The element MUST be placed inside [\<object>](#object).
 It defines a `field` of an `object` value for a parent element.
 `@innet/server` formats and validate the value automatically (real-time).
 
-`key` is REQUIRED prop of `<field>`, it defines a field name of the `<object>`.
+`key` is REQUIRED prop of `<field>`, it defines a field name of the [\<object>](#object).
 
 *src/app.tsx*
 ```typescript jsx
@@ -2436,116 +3253,46 @@ export default (
 )
 ```
 
-## Run-Time
-
-Next elements relate to run-time action.
-This action calls on user request.
-
-[← back](#index)
-
-Parent  
-[\<fallback>](#fallback)  
-[\<request>](#request)
-
-Children  
-[\<success>](#success)  
-[\<error>](#error)  
-[\<proxy>](#proxy)  
-[\<redirect>](#redirect)  
-[\<cms>](#cms)  
-[\<file>](#file)  
-[\<header>](#header)  
-[\<cookie>](#cookie)
-
----
-
-### \<fallback>
-
-[← back](#run-time)
-
-By default, `<api>` server returns 404 with empty body.
-[\<fallback>](#fallback) element defines default server response.
-This element MUST be placed in `<api>`.
-You MUST use one [\<fallback>](#fallback) per `<api>`.
-Can contain elements available inside [\<request>](#request).
-
-*src/app.tsx*
-```typescript jsx
-export default (
-  <server>
-    <api>
-      <fallback>
-        <error
-          code='unknownEndpoint'
-        />
-      </fallback>
-    </api>
-  </server>
-)
-```
-
-If you open the application on any URL except for `/`, you can see the next response.
-
-```json
-{
-  "error": "unknownEndpoint"
-}
-```
-
-The next elements are placed in [\<request>](#request) or [\<fallback>](#fallback)
-
-### \<request>
-
-[← back](#run-time)
+#### deprecated
 
-This element MUST be placed in `<endpoint>` element.
-It defines run-time call handler for the endpoint.
+You can deprecate a field.
 
 *src/app.tsx*
 ```typescript jsx
 export default (
   <server>
     <api>
-      <endpoint method='get' path='/partners'>
-        <request>
-          <success>
-            {{partners: []}}
-          </success>
-        </request>
+      <endpoint method='post' path='/users'>
+        <body>
+        <object>
+          <field key='name' />
+          <field key='surname' />
+          <field deprecated optional key='birthbay' />
+        </object>
+        </body>
       </endpoint>
     </api>
   </server>
 )
 ```
 
-You can place a component inside it.
-The component will run when the endpoint will be triggered.
+## Run-Time
 
-*src/app.tsx*
-```typescript jsx
-import { GetPartners } from './GetPartners'
+Next elements relate to run-time action.
+This action calls on user request.
 
-export default (
-  <server>
-    <api>
-      <endpoint method='get' path='/partners'>
-        <request>
-          <GetPartners />
-        </request>
-      </endpoint>
-    </api>
-  </server>
-)
-```
+[← back](#index)
+  
+[\<success>](#success)  
+[\<error>](#error)  
+[\<proxy>](#proxy)  
+[\<redirect>](#redirect)  
+[\<cms>](#cms)  
+[\<file>](#file)  
+[\<header>](#header)  
+[\<cookie>](#cookie)
 
-*src/GetPartners.tsx*
-```typescript jsx
-export const GetPartners = () => (
-  <success>
-    {{partners: []}}
-  </success>
-)
-```
+---
 
 ### \<success>
 
@@ -2557,11 +3304,9 @@ This is a base element to return a success data.
 ```typescript jsx
 export default (
   <server>
-    <api>
-      <fallback>
-        <success />
-      </fallback>
-    </api>
+    <return>
+      <success />
+    </return>
   </server>
 )
 ```
@@ -2576,13 +3321,11 @@ const data = {...}
 
 export default (
   <server>
-    <api>
-      <fallback>
-        <success>
-          {data}
-        </success>
-      </fallback>
-    </api>
+    <return>
+      <success>
+        {data}
+      </success>
+    </return>
   </server>
 )
 ```
@@ -2599,13 +3342,11 @@ const data = {...}
 
 export default (
   <server>
-    <api>
-      <fallback>
-        <success status='created'>
-          {data}
-        </success>
-      </fallback>
-    </api>
+    <return>
+      <success status='created'>
+        {data}
+      </success>
+    </return>
   </server>
 )
 ```
@@ -2620,13 +3361,29 @@ const data = {...}
 
 export default (
   <server>
-    <api>
-      <fallback>
-        <success status={201}>
-          {data}
-        </success>
-      </fallback>
-    </api>
+    <return>
+      <success status={201}>
+        {data}
+      </success>
+    </return>
+  </server>
+)
+```
+
+#### contentType
+
+This props sets response content type.
+By default, it checks children element to define the prop.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <return>
+      <success contentType='text/html'>
+        Hello World!
+      </success>
+    </return>
   </server>
 )
 ```
@@ -2636,17 +3393,15 @@ export default (
 [← back](#run-time)
 
 Returns an error.
-This element MUST be placed in [\<request>](#request) or [\<fallback>](#fallback).
+This element MUST be placed in [\<return>](#return).
 
 *src/app.tsx*
 ```typescript jsx
 export default (
   <server>
-    <api>
-      <fallback>
-        <error />
-      </fallback>
-    </api>
+    <return>
+      <error />
+    </return>
   </server>
 )
 ```
@@ -2659,13 +3414,11 @@ const data = {...}
 
 export default (
   <server>
-    <api>
-      <fallback>
-        <error>
-          {data}
-        </error>
-      </fallback>
-    </api>
+    <return>
+      <error>
+        {data}
+      </error>
+    </return>
   </server>
 )
 ```
@@ -2681,13 +3434,11 @@ const data = {
 
 export default (
   <server>
-    <api>
-      <fallback>
-        <error status='notFound'>
-          {data}
-        </error>
-      </fallback>
-    </api>
+    <return>
+      <error status='notFound'>
+        {data}
+      </error>
+    </return>
   </server>
 )
 ```
@@ -2702,13 +3453,11 @@ const data = {
 
 export default (
   <server>
-    <api>
-      <fallback>
-        <error status={404}>
-          {data}
-        </error>
-      </fallback>
-    </api>
+    <return>
+      <error status={404}>
+        {data}
+      </error>
+    </return>
   </server>
 )
 ```
@@ -2736,15 +3485,13 @@ const data = {
 
 export default (
   <server>
-    <api>
-      <fallback>
-        <error
-          code='noUser'
-          status='notFound'>
-          {data}
-        </error>
-      </fallback>
-    </api>
+    <return>
+      <error
+        code='noUser'
+        status='notFound'>
+        {data}
+      </error>
+    </return>
   </server>
 )
 ```
@@ -2772,7 +3519,7 @@ There are some default errors:
 
 [← back](#run-time)
 
-MUST be placed in [\<request>](#request) or [\<fallback>](#fallback).
+MUST be placed in [\<return>](#return).
 
 You can easy proxy endpoints to another server/service.
 
@@ -2784,14 +3531,14 @@ export default (
       <endpoint
         path='/test'
         method='get'>
-        <request>
+        <return>
           <proxy to='https://...' />
-        </request>
+        </return>
       </endpoint>
-      <fallback>
-        <proxy to='https://...' />
-      </fallback>
     </api>
+    <return>
+      <proxy to='https://...' />
+    </return>
   </server>
 )
 ```
@@ -2800,7 +3547,7 @@ export default (
 
 [← back](#run-time)
 
-MUST be placed in [\<request>](#request) or [\<fallback>](#fallback).
+MUST be placed in [\<return>](#return).
 
 You can redirect users to another resource. It adds `Cache-Control` header by default.
 
@@ -2812,14 +3559,14 @@ export default (
       <endpoint
         path='/test'
         method='get'>
-        <request>
+        <return>
           <redirect to='https://...' />
-        </request>
+        </return>
       </endpoint>
-      <fallback>
-        <redirect to='https://...' />
-      </fallback>
     </api>
+    <return>
+      <redirect to='https://...' />
+    </return>
   </server>
 )
 ```
@@ -2837,20 +3584,20 @@ export default (
       <endpoint
         path='/test'
         method='get'>
-        <request>
+        <return>
           <redirect
             status='found'
             to='https://...'
           />
-        </request>
+        </return>
       </endpoint>
-      <fallback>
-        <redirect
-          status={303}
-          to='https://...'
-        />
-      </fallback>
     </api>
+    <return>
+      <redirect
+        status={303}
+        to='https://...'
+      />
+    </return>
   </server>
 )
 ```
@@ -2859,7 +3606,7 @@ export default (
 
 [← back](#run-time)
 
-MUST be placed in [\<request>](#request) or [\<fallback>](#fallback).
+MUST be placed in [\<return>](#return).
 
 `<cms>` helps to return files from a folder by path. It checks files run-time on the server.
 
@@ -2867,18 +3614,16 @@ MUST be placed in [\<request>](#request) or [\<fallback>](#fallback).
 ```typescript jsx
 export default (
   <server>
-    <api>
-      <fallback>
-        <cms />
-      </fallback>
-    </api>
+    <return>
+      <cms />
+    </return>
   </server>
 )
 ```
 
 #### dir
 
-By default, it looks at project folder.
+By default, it equals `INNET_CMS_DIR` node env variable or the project folder.
 If you try the previous example on [http://localhost/package.json](http://localhost/package.json)
 you get the project `package.json` file.
 
@@ -2888,11 +3633,9 @@ You can change root folder by `dir` property.
 ```typescript jsx
 export default (
   <server>
-    <api>
-      <fallback>
-        <cms dir='src' />
-      </fallback>
-    </api>
+    <return>
+      <cms dir='src' />
+    </return>
   </server>
 )
 ```
@@ -2903,15 +3646,16 @@ you get the index file in `src` folder.
 #### prefix
 
 `<cms>` matches full `path`, you should take it into account if you add `prefix` on `<api>`.
+By default, it equals `INNET_CMS_PREFIX` node env variable or `/`.
 
 *src/app.tsx*
 ```typescript jsx
 export default (
   <server>
     <api prefix='/src'>
-      <fallback>
+      <return>
         <cms />
-      </fallback>
+      </return>
     </api>
   </server>
 )
@@ -2927,9 +3671,9 @@ You can reduce the path for matching by prefix property of `<cms>`.
 export default (
   <server>
     <api prefix='/api'>
-      <fallback>
+      <return>
         <cms prefix='/api' />
-      </fallback>
+      </return>
     </api>
   </server>
 )
@@ -2945,13 +3689,11 @@ You can handle if a file was not found by children elements of `<cms>`.
 ```typescript jsx
 export default (
   <server>
-    <api prefix='/src'>
-      <fallback>
-        <cms>
-          <error status={404} />
-        </cms>
-      </fallback>
-    </api>
+    <return>
+      <cms>
+        <error status={404} />
+      </cms>
+    </return>
   </server>
 )
 ```
@@ -2960,7 +3702,7 @@ export default (
 
 [← back](#run-time)
 
-It returns a file. MUST be placed in [\<request>](#request) or [\<fallback>](#fallback).
+It returns a file. MUST be placed in [\<return>](#return).
 
 It adds `Content-Length` and `Content-Type` automatically.
 
@@ -2970,13 +3712,9 @@ It has a REQUIRED property of `path`.
 ```typescript jsx
 export default (
   <server>
-    <api>
-      <fallback>
-        <file
-          path='package.json'
-        />
-      </fallback>
-    </api>
+    <return>
+      <file path='package.json' />
+    </return>
   </server>
 )
 ```
@@ -2991,20 +3729,18 @@ You can handle if a file was not found by children elements of `<file>`.
 ```typescript jsx
 export default (
   <server>
-    <api prefix='/src'>
-      <fallback>
-        <file path='file_is_not_exist.txt'>
-          <error status={404} />
-        </file>
-      </fallback>
-    </api>
+    <return>
+      <file path='file_is_not_exist.txt'>
+        <error status={404} />
+      </file>
+    </return>
   </server>
 )
 ```
 
 ### \<header>
 
-MUST be placed in [\<request>](#request) or [\<fallback>](#fallback).
+MUST be placed in [\<return>](#return).
 
 [← back](#run-time)
 
@@ -3014,22 +3750,20 @@ You can add an HTTP header into response by `<header>` element.
 ```typescript jsx
 export default (
   <server>
-    <api prefix='/src'>
-      <fallback>
-        <header
-          key='Cache-Control'
-          value='no-cache, no-store, must-revalidate'
-        />
-        <success />
-      </fallback>
-    </api>
+    <return>
+      <header
+        key='Cache-Control'
+        value='no-cache, no-store, must-revalidate'
+      />
+      <success />
+    </return>
   </server>
 )
 ```
 
 ### \<cookie>
 
-MUST be placed in [\<request>](#request) or [\<fallback>](#fallback).
+MUST be placed in [\<return>](#return).
 
 [← back](#run-time)
 
@@ -3039,18 +3773,16 @@ You can add/remove a cookie into response by `<cookie>` element.
 ```typescript jsx
 export default (
   <server>
-    <api prefix='/src'>
-      <fallback>
-        <cookie
-          key='token'
-          value='...'
-        />
-        <cookie
-          key='removedCookie'
-        />
-        <success />
-      </fallback>
-    </api>
+    <return>
+      <cookie
+        key='token'
+        value='...'
+      />
+      <cookie
+        key='removedCookie'
+      />
+      <success />
+    </return>
   </server>
 )
 ```
@@ -3064,16 +3796,14 @@ By default, no domain is set, and most clients will consider the cookie to apply
 ```typescript jsx
 export default (
   <server>
-    <api prefix='/src'>
-      <fallback>
-        <cookie
-          domain='.example.com'
-          key='token'
-          value='...'
-        />
-        <success />
-      </fallback>
-    </api>
+    <return>
+      <cookie
+        domain='.example.com'
+        key='token'
+        value='...'
+      />
+      <success />
+    </return>
   </server>
 )
 ```
@@ -3092,16 +3822,14 @@ Note the [cookie storage model specification](https://datatracker.ietf.org/doc/h
 ```typescript jsx
 export default (
   <server>
-    <api prefix='/src'>
-      <fallback>
-        <cookie
-          expires={new Date('2050-01-01')}
-          key='token'
-          value='...'
-        />
-        <success />
-      </fallback>
-    </api>
+    <return>
+      <cookie
+        expires={new Date('2050-01-01')}
+        key='token'
+        value='...'
+      />
+      <success />
+    </return>
   </server>
 )
 ```
@@ -3115,16 +3843,14 @@ Note be careful when setting this to true, as compliant clients will not allow c
 ```typescript jsx
 export default (
   <server>
-    <api prefix='/src'>
-      <fallback>
-        <cookie
-          httpOnly
-          key='token'
-          value='...'
-        />
-        <success />
-      </fallback>
-    </api>
+    <return>
+      <cookie
+        httpOnly
+        key='token'
+        value='...'
+      />
+      <success />
+    </return>
   </server>
 )
 ```
@@ -3138,17 +3864,15 @@ Note the [cookie storage model specification](https://datatracker.ietf.org/doc/h
 ```typescript jsx
 export default (
   <server>
-    <api prefix='/src'>
-      <fallback>
-        <cookie
-          httpOnly
-          maxAge={9999}
-          key='token'
-          value='...'
-        />
-        <success />
-      </fallback>
-    </api>
+    <return>
+      <cookie
+        httpOnly
+        maxAge={9999}
+        key='token'
+        value='...'
+      />
+      <success />
+    </return>
   </server>
 )
 ```
@@ -3162,18 +3886,16 @@ By default, the path is considered the “default path”.
 ```typescript jsx
 export default (
   <server>
-    <api prefix='/src'>
-      <fallback>
-        <cookie
-          httpOnly
-          maxAge={9999}
-          path='/src'
-          key='token'
-          value='...'
-        />
-        <success />
-      </fallback>
-    </api>
+    <return>
+      <cookie
+        httpOnly
+        maxAge={9999}
+        path='/src'
+        key='token'
+        value='...'
+      />
+      <success />
+    </return>
   </server>
 )
 ```
@@ -3192,18 +3914,16 @@ note This is an attribute that has not yet been fully standardized, and may chan
 ```typescript jsx
 export default (
   <server>
-    <api prefix='/src'>
-      <fallback>
-        <cookie
-          httpOnly
-          priority='high'
-          path='/src'
-          key='token'
-          value='...'
-        />
-        <success />
-      </fallback>
-    </api>
+    <return>
+      <cookie
+        httpOnly
+        priority='high'
+        path='/src'
+        key='token'
+        value='...'
+      />
+      <success />
+    </return>
   </server>
 )
 ```
@@ -3225,19 +3945,17 @@ This also means many clients may ignore this attribute until they understand it.
 ```typescript jsx
 export default (
   <server>
-    <api prefix='/src'>
-      <fallback>
-        <cookie
-          httpOnly
-          sameSite
-          priority='high'
-          path='/src'
-          key='token'
-          value='...'
-        />
-        <success />
-      </fallback>
-    </api>
+    <return>
+      <cookie
+        httpOnly
+        sameSite
+        priority='high'
+        path='/src'
+        key='token'
+        value='...'
+      />
+      <success />
+    </return>
   </server>
 )
 ```
@@ -3254,17 +3972,15 @@ Note be careful when setting this to true, as compliant clients will not send th
 ```typescript jsx
 export default (
   <server>
-    <api prefix='/src'>
-      <fallback>
-        <cookie
-          httpOnly
-          secure
-          key='token'
-          value='...'
-        />
-        <success />
-      </fallback>
-    </api>
+    <return>
+      <cookie
+        httpOnly
+        secure
+        key='token'
+        value='...'
+      />
+      <success />
+    </return>
   </server>
 )
 ```
@@ -3297,14 +4013,12 @@ import { SetToken } from './SetToken'
 
 export default (
   <server>
-    <api prefix='/src'>
-      <fallback>
-        <SetToken
-          value='...'
-        />
-        <success />
-      </fallback>
-    </api>
+    <return>
+      <SetToken
+        value='...'
+      />
+      <success />
+    </return>
   </server>
 )
 ```
@@ -3329,10 +4043,12 @@ Real-time
 [useClientIp](#useclientip)  
 
 Server start  
-[useRequestPlugin](#userequestplugin)
+[useServerPlugin](#useserverplugin)
 
 Both  
 [useServer](#useserver)  
+[usePort](#useport)  
+[useIsServerHttps](#useisserverhttps)  
 [useComponentName](#usecomponentname)
 
 ---
@@ -3341,7 +4057,7 @@ Both
 
 [← back](#hooks)
 
-This hook MUST be used in a component placed in [\<request>](#request) or [\<fallback>](#fallback).
+This hook MUST be used in a component placed in [\<return>](#return).
 This hook returns current request instance.
 
 *src/Component.tsx*
@@ -3362,7 +4078,7 @@ export function Component () {
 
 [← back](#hooks)
 
-This hook MUST be used in a component placed in [\<request>](#request) or [\<fallback>](#fallback).
+This hook MUST be used in a component placed in [\<return>](#return).
 This hook returns current response instance.
 
 *src/Component.tsx*
@@ -3383,7 +4099,7 @@ export function Component () {
 
 [← back](#hooks)
 
-This hook MUST be used in a component placed in [\<request>](#request) or [\<fallback>](#fallback).
+This hook MUST be used in a component placed in [\<return>](#return).
 This hook returns current request headers object.
 
 *src/Component.tsx*
@@ -3402,7 +4118,7 @@ export function Component () {
 
 [← back](#hooks)
 
-This hook MUST be used in a component placed in [\<request>](#request) or [\<fallback>](#fallback).
+This hook MUST be used in a component placed in [\<return>](#return).
 This hook returns current request cookies object.
 
 *src/Component.tsx*
@@ -3421,7 +4137,7 @@ export function Component () {
 
 [← back](#hooks)
 
-This hook MUST be used in a component placed in [\<request>](#request) or [\<fallback>](#fallback).
+This hook MUST be used in a component placed in [\<return>](#return).
 This hook returns current request URL path as a `string`.
 
 *src/Component.tsx*
@@ -3440,7 +4156,7 @@ export function Component () {
 
 [← back](#hooks)
 
-This hook MUST be used in a component placed in [\<request>](#request) or [\<fallback>](#fallback).
+This hook MUST be used in a component placed in [\<return>](#return).
 This hook returns an object of URL params you set by [\<param>](#param).
 
 *src/Component.tsx*
@@ -3458,7 +4174,7 @@ export function Component () {
 
 [← back](#hooks)
 
-This hook MUST be used in a component placed in [\<request>](#request) or [\<fallback>](#fallback).
+This hook MUST be used in a component placed in [\<return>](#return).
 This hook returns an object of URL query params.
 
 *src/Component.tsx*
@@ -3476,7 +4192,7 @@ export function Component () {
 
 [← back](#hooks)
 
-This hook MUST be used in a component placed in [\<request>](#request) or [\<fallback>](#fallback).
+This hook MUST be used in a component placed in [\<return>](#return).
 This hook returns current request body.
 
 *src/Component.tsx*
@@ -3495,7 +4211,7 @@ export function Component () {
 [← back](#hooks)
 
 This hook returns request user IP.
-This hook MUST be used in a component placed in [\<request>](#request) or [\<fallback>](#fallback).
+This hook MUST be used in a component placed in [\<return>](#return).
 
 *src/Component.tsx*
 ```typescript jsx
@@ -3508,7 +4224,7 @@ export function Component () {
 }
 ```
 
-### useRequestPlugin
+### useServerPlugin
 
 [← back](#hooks)
 
@@ -3516,25 +4232,24 @@ This hook adds a request plugin function.
 The function runs before check endpoints.
 If the function returns `true` the request handling stops, and you get full control over the request.
 
-This hook MUST be used in a component placed in [\<api>](#api).
+This hook MUST be used in a component placed in [\<server>](#server).
 
 *src/SecretEndpoint.tsx*
 ```typescript jsx
-import { useRequestPlugin } from '@innet/sever'
+import { useRequestPlugin, useAction } from '@innet/sever'
 
 export function SecretEndpoint () {
-  useRequestPlugin((req, res) => {
-    if (req.url.startsWith('/secret-endpoint')) {
-      res.statusCode = 200
-      res.write('A secret message')
-      res.end()
-      return true
+  useServerPlugin(() => {
+    const action = useAction()
+
+    if (action.path.startsWith('/secret-endpoint')) {
+      return <success>A secret message</success>
     }
   })
 }
 ```
 
-Then use the plugin in [\<api>](#api).
+Then use the plugin in [\<server>](#server) or [\<api>](#api).
 
 *src/app.tsx*
 ```typescript jsx
@@ -3542,12 +4257,10 @@ import { SecretEndpoint } from './SecretEndpoint'
 
 export default (
   <server>
-    <api>
-      <fallback>
-        <error />
-      </fallback>
-      <SecretEndpoint />
-    </api>
+    <SecretEndpoint />
+    <return>
+      <error />
+    </return>
   </server>
 )
 ```
@@ -3575,6 +4288,53 @@ export function Component () {
 }
 ```
 
+### usePort
+
+[← back](#hooks)
+
+This hook MUST be used in a component placed in [\<server>](#server).
+This hook returns current http(s) server port.
+
+*src/LocalHost.tsx*
+```typescript jsx
+import { usePort } from '@innet/sever'
+
+export function LocalHost () {
+  const port = usePort()
+
+  return (
+    <host
+      description='Development'
+      url={`http://localhost:${port}/api`}
+    />
+  )
+}
+```
+
+### useIsServerHttps
+
+[← back](#hooks)
+
+This hook MUST be used in a component placed in [\<server>](#server).
+This hook returns `true` if it is https server and `false` if not.
+
+*src/LocalHost.tsx*
+```typescript jsx
+import { usePort, useIsServerHttps } from '@innet/sever'
+
+export function LocalHost () {
+  const https = useIsServerHttps() ? 'https' : 'http'
+  const port = usePort()
+
+  return (
+    <host
+      description='Development'
+      url={`${https}://localhost:${port}/api`}
+    />
+  )
+}
+```
+
 ### useComponentName
 
 [← back](#hooks)