@innet/server 2.0.0-alpha.2 → 2.0.0-alpha.21

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>
+    <request>
+      <success>
+        Hello World!
+      </success>
+    </request>
+  </server>
+)
+```
+
+*Use `npm start` to run this server.*
+
+Open http://localhost:80
+You will see the `Hello Word!` string.
+
+---
+
+Here is the simplest [api](#api) example:
+
 *src/app.tsx*
 ```typescript jsx
 export default (
@@ -107,7 +129,9 @@ You will see a base Open API JSON structure.
 [← back](#index)
 
 [\<server>](#server)   
-[\<api>](#api)
+[\<api>](#api)  
+[\<request>](#request)  
+[\<preset>](#preset)
 
 ---
 
@@ -136,8 +160,8 @@ 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.
+- 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
 
@@ -309,6 +346,162 @@ export default (
 )
 ```
 
+#### 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>
+)
+```
+
+### \<request>
+
+[← back](#main)
+
+This element MUST be placed in [\<server>](#server) element.
+It defines run-time call handler for parent element.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <request>
+      <error status={404} />
+    </request>
+  </server>
+)
+```
+*Any request returns 404*
+
+Place [\<request>](#request) in [\<api>](#api) to handle any unknown request in the [\<api>](#api).
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <request>
+        <error status={404} />
+      </request>
+    </api>
+  </server>
+)
+```
+
+Place [\<request>](#request) in [\<endpoint>](#endpoint) to handle the [\<endpoint>](#endpoint) request.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <endpoint method='get' path='/my-endpoint'>
+        <request>
+          <success>
+            My Endpoint
+          </success>
+        </request>
+      </endpoint>
+    </api>
+    <request>
+      <success>
+        Any other request
+      </success>
+    </request>
+  </server>
+)
+```
+
+You can place a component inside [\<request>](#request).
+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'>
+        <request>
+          <GetPartners />
+        </request>
+      </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.
+
+*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>
+    </api>
+  </server>
+)
+```
+
 ## Utils
 
 This section contains elements of utils.
@@ -316,102 +509,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>
+### \<swagger>
+
+[← 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
 
-[← back](#utils)
+This prop is a secret string of protection value.
+User must provide a protection query param equals the `value`.
 
-Use `<swagger>` element to add Swagger UI documentation.
-`<swagger>` element MUST be placed in `<api>` element.
+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>
-      <swagger />
+      <protection value='secret'>
+        <error
+          code='protection'
+          status='forbidden'
+        />
+      </protection>
     </api>
   </server>
 )
 ```
 
-Open http://localhost:80/swagger-ui
-You will see Swagger UI documentation.
+#### maxAge
 
-You can change the Swagger UI URL path by `path` property of `<swagger>` element.
+This prop sets how much time protection is qualified.
+
+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 path='/swagger' />
+      <protection
+        maxAge={24 * 60 * 60}
+        value='secret'>
+        <error
+          code='protection'
+          status='forbidden'
+        />
+      </protection>
     </api>
   </server>
 )
 ```
 
-### \<dev>
+#### excludeIp
 
-[← back](#utils)
+This prop sets a list of IP addresses (split by `,`) to ignore the protection.
 
-Everything inside <dev> will work when `NODE_ENV` equals `development`.
+You can use `INNET_PROTECTED_IP` env to set default `excludeIp`.
 
 *src/app.tsx*
 ```typescript jsx
 export default (
   <server>
     <api>
-      <dev>
-        <swagger />
-      </dev>
+      <protection
+        excludeIp='0.0.0.0,127.0.0.0'
+        value='secret'>
+        <error
+          code='protection'
+          status='forbidden'
+        />
+      </protection>
     </api>
   </server>
 )
 ```
 
-### \<dts>
-
-[← back](#utils)
+#### cookieKey
 
-Use `<dts>` element to add types generation.
-`<dts>` element MUST be placed in `<api>` element.
+This prop sets a cookie field name used to store protection of a user.
 
-`<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_COOKIE_KEY` env to set default `cookieKey`.
 
 *src/app.tsx*
 ```typescript jsx
 export default (
   <server>
     <api>
-      <dev>
-        <dts path='src/api.d.ts' />
-      </dev>
+      <protection
+        cookieKey='secret'
+        value='secret'>
+        <error
+          code='protection'
+          status='forbidden'
+        />
+      </protection>
     </api>
   </server>
 )
 ```
 
-> You MUST add some [endpoint](#endpoint) with some schema otherwise you get the `Error: There is no schema in the input contents`.
+#### searchKey
 
-Here is an example of generated types usage.
+This prop sets a search query field name used to check protection.
 
-*src/GetPartner.tsx*
-```typescript jsx
-import { useParams } from '@innet/server'
+By default, it equals `protection`.
+You can use `INNET_PROTECTION_SEARCH_KEY` env to set default `searchKey`.
 
-export function GetPartner () {
-  const { id } = useParams<Paths.Partners$Id.Get.PathParameters>()
-  return <success>{{ id }}</success>
-}
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <protection
+        searchKey='secret'
+        value='secret'>
+        <error
+          code='protection'
+          status='forbidden'
+        />
+      </protection>
+    </api>
+  </server>
+)
 ```
 
-You do not need to import types, they generate as namespaces.
-
 ## API Info
 
 The API information elements are here.
@@ -980,6 +1470,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,10 +1504,130 @@ return (
 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)  
@@ -1026,6 +1637,142 @@ It defines response body for the endpoint.
 [\<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
+
+A description of the `null`.
+
+*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>
 
 [← back](#primitive-data)
@@ -2306,7 +3053,9 @@ export default (
     <api>
       <endpoint method='post' path='/users'>
         <body>
-          <object />
+          <object>
+            <string />
+          </object>
         </body>
       </endpoint>
     </api>
@@ -2385,7 +3134,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
@@ -2435,12 +3184,7 @@ 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)  
@@ -2452,94 +3196,6 @@ Children
 
 ---
 
-### \<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)
-
-This element MUST be placed in `<endpoint>` element.
-It defines run-time call handler for the endpoint.
-
-*src/app.tsx*
-```typescript jsx
-export default (
-  <server>
-    <api>
-      <endpoint method='get' path='/partners'>
-        <request>
-          <success>
-            {{partners: []}}
-          </success>
-        </request>
-      </endpoint>
-    </api>
-  </server>
-)
-```
-
-You can place a component inside it.
-The component will run when the endpoint will be triggered.
-
-*src/app.tsx*
-```typescript jsx
-import { GetPartners } from './GetPartners'
-
-export default (
-  <server>
-    <api>
-      <endpoint method='get' path='/partners'>
-        <request>
-          <GetPartners />
-        </request>
-      </endpoint>
-    </api>
-  </server>
-)
-```
-
-*src/GetPartners.tsx*
-```typescript jsx
-export const GetPartners = () => (
-  <success>
-    {{partners: []}}
-  </success>
-)
-```
-
 ### \<success>
 
 [← back](#run-time)
@@ -2550,11 +3206,9 @@ This is a base element to return a success data.
 ```typescript jsx
 export default (
   <server>
-    <api>
-      <fallback>
-        <success />
-      </fallback>
-    </api>
+    <response>
+      <success />
+    </response>
   </server>
 )
 ```
@@ -2569,13 +3223,11 @@ const data = {...}
 
 export default (
   <server>
-    <api>
-      <fallback>
-        <success>
-          {data}
-        </success>
-      </fallback>
-    </api>
+    <response>
+      <success>
+        {data}
+      </success>
+    </response>
   </server>
 )
 ```
@@ -2592,13 +3244,11 @@ const data = {...}
 
 export default (
   <server>
-    <api>
-      <fallback>
-        <success status='created'>
-          {data}
-        </success>
-      </fallback>
-    </api>
+    <response>
+      <success status='created'>
+        {data}
+      </success>
+    </response>
   </server>
 )
 ```
@@ -2613,13 +3263,29 @@ const data = {...}
 
 export default (
   <server>
-    <api>
-      <fallback>
-        <success status={201}>
-          {data}
-        </success>
-      </fallback>
-    </api>
+    <response>
+      <success status={201}>
+        {data}
+      </success>
+    </response>
+  </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>
+    <response>
+      <success contentType='text/html'>
+        Hello World!
+      </success>
+    </response>
   </server>
 )
 ```
@@ -2629,17 +3295,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 [\<request>](#request) or [\<response>](#response).
 
 *src/app.tsx*
 ```typescript jsx
 export default (
   <server>
-    <api>
-      <fallback>
-        <error />
-      </fallback>
-    </api>
+    <response>
+      <error />
+    </response>
   </server>
 )
 ```
@@ -2652,13 +3316,11 @@ const data = {...}
 
 export default (
   <server>
-    <api>
-      <fallback>
-        <error>
-          {data}
-        </error>
-      </fallback>
-    </api>
+    <response>
+      <error>
+        {data}
+      </error>
+    </response>
   </server>
 )
 ```
@@ -2674,13 +3336,11 @@ const data = {
 
 export default (
   <server>
-    <api>
-      <fallback>
-        <error status='notFound'>
-          {data}
-        </error>
-      </fallback>
-    </api>
+    <response>
+      <error status='notFound'>
+        {data}
+      </error>
+    </response>
   </server>
 )
 ```
@@ -2695,13 +3355,11 @@ const data = {
 
 export default (
   <server>
-    <api>
-      <fallback>
-        <error status={404}>
-          {data}
-        </error>
-      </fallback>
-    </api>
+    <response>
+      <error status={404}>
+        {data}
+      </error>
+    </response>
   </server>
 )
 ```
@@ -2729,15 +3387,13 @@ const data = {
 
 export default (
   <server>
-    <api>
-      <fallback>
-        <error
-          code='noUser'
-          status='notFound'>
-          {data}
-        </error>
-      </fallback>
-    </api>
+    <response>
+      <error
+        code='noUser'
+        status='notFound'>
+        {data}
+      </error>
+    </response>
   </server>
 )
 ```
@@ -2765,7 +3421,7 @@ There are some default errors:
 
 [← back](#run-time)
 
-MUST be placed in [\<request>](#request) or [\<fallback>](#fallback).
+MUST be placed in [\<request>](#request) or [\<response>](#response).
 
 You can easy proxy endpoints to another server/service.
 
@@ -2781,10 +3437,10 @@ export default (
           <proxy to='https://...' />
         </request>
       </endpoint>
-      <fallback>
-        <proxy to='https://...' />
-      </fallback>
     </api>
+    <response>
+      <proxy to='https://...' />
+    </response>
   </server>
 )
 ```
@@ -2793,7 +3449,7 @@ export default (
 
 [← back](#run-time)
 
-MUST be placed in [\<request>](#request) or [\<fallback>](#fallback).
+MUST be placed in [\<request>](#request) or [\<response>](#response).
 
 You can redirect users to another resource. It adds `Cache-Control` header by default.
 
@@ -2809,10 +3465,10 @@ export default (
           <redirect to='https://...' />
         </request>
       </endpoint>
-      <fallback>
-        <redirect to='https://...' />
-      </fallback>
     </api>
+    <response>
+      <redirect to='https://...' />
+    </response>
   </server>
 )
 ```
@@ -2837,13 +3493,13 @@ export default (
           />
         </request>
       </endpoint>
-      <fallback>
-        <redirect
-          status={303}
-          to='https://...'
-        />
-      </fallback>
     </api>
+    <response>
+      <redirect
+        status={303}
+        to='https://...'
+      />
+    </response>
   </server>
 )
 ```
@@ -2852,7 +3508,7 @@ export default (
 
 [← back](#run-time)
 
-MUST be placed in [\<request>](#request) or [\<fallback>](#fallback).
+MUST be placed in [\<request>](#request) or [\<response>](#response).
 
 `<cms>` helps to return files from a folder by path. It checks files run-time on the server.
 
@@ -2860,18 +3516,16 @@ MUST be placed in [\<request>](#request) or [\<fallback>](#fallback).
 ```typescript jsx
 export default (
   <server>
-    <api>
-      <fallback>
-        <cms />
-      </fallback>
-    </api>
+    <response>
+      <cms />
+    </response>
   </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.
 
@@ -2881,11 +3535,9 @@ You can change root folder by `dir` property.
 ```typescript jsx
 export default (
   <server>
-    <api>
-      <fallback>
-        <cms dir='src' />
-      </fallback>
-    </api>
+    <response>
+      <cms dir='src' />
+    </response>
   </server>
 )
 ```
@@ -2896,15 +3548,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>
+      <response>
         <cms />
-      </fallback>
+      </response>
     </api>
   </server>
 )
@@ -2920,9 +3573,9 @@ You can reduce the path for matching by prefix property of `<cms>`.
 export default (
   <server>
     <api prefix='/api'>
-      <fallback>
+      <response>
         <cms prefix='/api' />
-      </fallback>
+      </response>
     </api>
   </server>
 )
@@ -2938,13 +3591,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>
+    <response>
+      <cms>
+        <error status={404} />
+      </cms>
+    </response>
   </server>
 )
 ```
@@ -2953,7 +3604,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 [\<request>](#request) or [\<response>](#response).
 
 It adds `Content-Length` and `Content-Type` automatically.
 
@@ -2963,13 +3614,9 @@ It has a REQUIRED property of `path`.
 ```typescript jsx
 export default (
   <server>
-    <api>
-      <fallback>
-        <file
-          path='package.json'
-        />
-      </fallback>
-    </api>
+    <response>
+      <file path='package.json' />
+    </response>
   </server>
 )
 ```
@@ -2984,20 +3631,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>
+    <response>
+      <file path='file_is_not_exist.txt'>
+        <error status={404} />
+      </file>
+    </response>
   </server>
 )
 ```
 
 ### \<header>
 
-MUST be placed in [\<request>](#request) or [\<fallback>](#fallback).
+MUST be placed in [\<request>](#request) or [\<response>](#response).
 
 [← back](#run-time)
 
@@ -3007,22 +3652,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>
+    <response>
+      <header
+        key='Cache-Control'
+        value='no-cache, no-store, must-revalidate'
+      />
+      <success />
+    </response>
   </server>
 )
 ```
 
 ### \<cookie>
 
-MUST be placed in [\<request>](#request) or [\<fallback>](#fallback).
+MUST be placed in [\<request>](#request) or [\<response>](#response).
 
 [← back](#run-time)
 
@@ -3032,18 +3675,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>
+    <response>
+      <cookie
+        key='token'
+        value='...'
+      />
+      <cookie
+        key='removedCookie'
+      />
+      <success />
+    </response>
   </server>
 )
 ```
@@ -3057,16 +3698,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>
+    <response>
+      <cookie
+        domain='.example.com'
+        key='token'
+        value='...'
+      />
+      <success />
+    </response>
   </server>
 )
 ```
@@ -3085,16 +3724,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>
+    <response>
+      <cookie
+        expires={new Date('2050-01-01')}
+        key='token'
+        value='...'
+      />
+      <success />
+    </response>
   </server>
 )
 ```
@@ -3108,16 +3745,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>
+    <response>
+      <cookie
+        httpOnly
+        key='token'
+        value='...'
+      />
+      <success />
+    </response>
   </server>
 )
 ```
@@ -3131,17 +3766,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>
+    <response>
+      <cookie
+        httpOnly
+        maxAge={9999}
+        key='token'
+        value='...'
+      />
+      <success />
+    </response>
   </server>
 )
 ```
@@ -3155,18 +3788,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>
+    <response>
+      <cookie
+        httpOnly
+        maxAge={9999}
+        path='/src'
+        key='token'
+        value='...'
+      />
+      <success />
+    </response>
   </server>
 )
 ```
@@ -3185,18 +3816,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>
+    <response>
+      <cookie
+        httpOnly
+        priority='high'
+        path='/src'
+        key='token'
+        value='...'
+      />
+      <success />
+    </response>
   </server>
 )
 ```
@@ -3218,19 +3847,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>
+    <response>
+      <cookie
+        httpOnly
+        sameSite
+        priority='high'
+        path='/src'
+        key='token'
+        value='...'
+      />
+      <success />
+    </response>
   </server>
 )
 ```
@@ -3247,17 +3874,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>
+    <response>
+      <cookie
+        httpOnly
+        secure
+        key='token'
+        value='...'
+      />
+      <success />
+    </response>
   </server>
 )
 ```
@@ -3290,14 +3915,12 @@ import { SetToken } from './SetToken'
 
 export default (
   <server>
-    <api prefix='/src'>
-      <fallback>
-        <SetToken
-          value='...'
-        />
-        <success />
-      </fallback>
-    </api>
+    <response>
+      <SetToken
+        value='...'
+      />
+      <success />
+    </response>
   </server>
 )
 ```
@@ -3310,7 +3933,7 @@ Hook functions give you all features to control parent element functionality.
 
 [← back](#index)
 
-[useServer](#useserver)  
+Real-time  
 [useRequest](#userequest)  
 [useResponse](#useresponse)  
 [useHeaders](#useheaders)  
@@ -3319,35 +3942,22 @@ Hook functions give you all features to control parent element functionality.
 [useParams](#useparams)  
 [useSearch](#usesearch)  
 [useBody](#usebody)  
+[useClientIp](#useclientip)  
 
----
-
-### useServer
-
-[← back](#hooks)
-
-This hook MUST be used in a component placed in `<server>`.
-This hook returns current http(s) server instance.
-
-*src/Component.tsx*
-
-```typescript jsx
-import { useServer } from '@innet/sever'
-
-export function Component () {
-  const server = useServer()
+Server start  
+[useServerPlugin](#useserverplugin)
 
-  console.log(server)
+Both  
+[useServer](#useserver)  
+[useComponentName](#usecomponentname)
 
-  return <success />
-}
-```
+---
 
 ### useRequest
 
 [← 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 [\<request>](#request) or [\<response>](#response).
 This hook returns current request instance.
 
 *src/Component.tsx*
@@ -3368,7 +3978,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 [\<request>](#request) or [\<response>](#response).
 This hook returns current response instance.
 
 *src/Component.tsx*
@@ -3389,7 +3999,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 [\<request>](#request) or [\<response>](#response).
 This hook returns current request headers object.
 
 *src/Component.tsx*
@@ -3408,7 +4018,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 [\<request>](#request) or [\<response>](#response).
 This hook returns current request cookies object.
 
 *src/Component.tsx*
@@ -3427,7 +4037,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 [\<request>](#request) or [\<response>](#response).
 This hook returns current request URL path as a `string`.
 
 *src/Component.tsx*
@@ -3446,7 +4056,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 [\<request>](#request) or [\<response>](#response).
 This hook returns an object of URL params you set by [\<param>](#param).
 
 *src/Component.tsx*
@@ -3464,7 +4074,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 [\<request>](#request) or [\<response>](#response).
 This hook returns an object of URL query params.
 
 *src/Component.tsx*
@@ -3482,7 +4092,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 [\<request>](#request) or [\<response>](#response).
 This hook returns current request body.
 
 *src/Component.tsx*
@@ -3496,6 +4106,106 @@ export function Component () {
 }
 ```
 
+### useClientIp
+
+[← back](#hooks)
+
+This hook returns request user IP.
+This hook MUST be used in a component placed in [\<request>](#request) or [\<response>](#response).
+
+*src/Component.tsx*
+```typescript jsx
+import { useClientIp } from '@innet/sever'
+
+export function Component () {
+  const ip = useClientIp()
+  
+  return <success>{{ ip }}</success>
+}
+```
+
+### useServerPlugin
+
+[← back](#hooks)
+
+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 [\<server>](#server).
+
+*src/SecretEndpoint.tsx*
+```typescript jsx
+import { useRequestPlugin, useAction } from '@innet/sever'
+
+export function SecretEndpoint () {
+  useServerPlugin(() => {
+    const action = useAction()
+
+    if (action.path.startsWith('/secret-endpoint')) {
+      return <success>A secret message</success>
+    }
+  })
+}
+```
+
+Then use the plugin in [\<server>](#server) or [\<api>](#api).
+
+*src/app.tsx*
+```typescript jsx
+import { SecretEndpoint } from './SecretEndpoint'
+
+export default (
+  <server>
+    <SecretEndpoint />
+    <response>
+      <error />
+    </response>
+  </server>
+)
+```
+
+Any endpoint returns an error except for `/secret-endpoint`.
+Elements order does not matter.
+
+### useServer
+
+[← back](#hooks)
+
+This hook MUST be used in a component placed in [\<server>](#server).
+This hook returns current http(s) server instance.
+
+*src/Component.tsx*
+```typescript jsx
+import { useServer } from '@innet/sever'
+
+export function Component () {
+  const server = useServer()
+
+  console.log(server)
+
+  return <success />
+}
+```
+
+### useComponentName
+
+[← back](#hooks)
+
+This hook returns name of current component.
+
+*src/Component.tsx*
+```typescript jsx
+import { useComponentName } from '@innet/sever'
+
+export function Component () {
+// returns this ^-------^
+  const name = useComponentName()
+
+  return <success>{{ name }}</success>
+}
+```
+
 ## Issues
 If you find a bug or have a suggestion, please file an issue on [GitHub](https://github.com/d8corp/innet-server/issues).