@innet/server 2.0.0-beta.4 → 2.0.0-beta.6

package/README.md

@@ -581,7 +581,7 @@ This section contains elements of utils.
 
 [← back](#index)
 
-[\<swagger>](#swagger)  
+[\<ui>](#ui)  
 [\<env>](#env)  
 [\<dts>](#dts)  
 [\<blacklist>](#blacklist)  
@@ -590,40 +590,151 @@ This section contains elements of utils.
 
 ---
 
-### \<swagger>
+### \<ui>
 
 [← back](#utils)
 
-Use `<swagger>` element to add Swagger UI documentation.
-`<swagger>` element MUST be placed in `<api>` element.
+Use `<ui>` element to add API documentation UI. This element supports multiple documentation viewers including Swagger UI, RapiDoc, ReDoc, and Scalar.
+`<ui>` element MUST be placed in `<api>` element.
 
 *src/app.tsx*
 ```typescript jsx
 export default (
   <server>
     <api>
-      <swagger />
+      <ui />
     </api>
   </server>
 )
 ```
 
-Open http://localhost:80/swagger-ui
-You will see Swagger UI documentation.
+Open http://localhost:80/ui
+You will see Swagger UI documentation by default.
 
-You can change the Swagger UI URL path by `path` property of `<swagger>` element.
+#### html
+
+You can provide custom HTML template for the documentation viewer.
+Built-in presets are available: `uiPresets.swagger`, `uiPresets.rapidoc`, `uiPresets.redoc`, `uiPresets.scalar`.
+
+*src/app.tsx*
+```typescript jsx
+import { uiPresets } from '@innet/server'
+
+export default (
+  <server>
+    <api>
+      <ui html={uiPresets.rapidoc} />
+    </api>
+  </server>
+)
+```
+
+#### params
+
+You can pass additional parameters to the documentation viewer. Parameters depend on the selected UI library.
+
+For **Swagger UI** (default):
 
 *src/app.tsx*
 ```typescript jsx
 export default (
   <server>
     <api>
-      <swagger path='/swagger' />
+      <ui
+        params={{
+          docExpansion: 'full',
+          filter: true,
+          showExtensions: true,
+        }}
+      />
     </api>
   </server>
 )
 ```
 
+For **Scalar**:
+
+*src/app.tsx*
+```typescript jsx
+import { uiPresets } from '@innet/server'
+
+export default (
+  <server>
+    <api>
+      <ui
+        html={uiPresets.scalar}
+        params={{
+          theme: 'moon',
+          layout: 'classic',
+        }}
+      />
+    </api>
+  </server>
+)
+```
+
+For **RapiDoc**:
+
+*src/app.tsx*
+```typescript jsx
+import { uiPresets } from '@innet/server'
+
+export default (
+  <server>
+    <api>
+      <ui
+        html={uiPresets.rapidoc}
+        params={{
+          theme: 'dark',
+          layout: 'row',
+          showHeader: 'false',
+        }}
+      />
+    </api>
+  </server>
+)
+```
+
+For **ReDoc**:
+
+*src/app.tsx*
+```typescript jsx
+import { uiPresets } from '@innet/server'
+
+export default (
+  <server>
+    <api>
+      <ui
+        html={uiPresets.redoc}
+        params={{
+          disableSearch: 'true',
+          hideDownloadButton: 'true',
+          nativeScrollbars: 'true',
+          theme: '{"sidebar": {"backgroundColor": "#d1e5ef"}}',
+        }}
+      />
+    </api>
+  </server>
+)
+```
+
+#### path
+
+You can change the documentation UI URL path by `path` property of `<ui>` element.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <ui path='/docs' />
+    </api>
+  </server>
+)
+```
+
+*default: `INNET_UI_PATH` || `'/ui'`*
+
 ### \<env>
 
 [← back](#utils)
@@ -2176,6 +2287,26 @@ you get an error:
 }
 ```
 
+#### format
+
+An optional format modifier serves as a hint at the contents and format of the string.
+Available formats include: `email`, `date-time`, `date`, `uri`, `hostname`, `ipv4`, `ipv6`, `uuid`, `byte`, `binary`, `password` or custom string.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <endpoint method='get' path='/users'>
+        <param in='query' name='email'>
+          <string format='email' />
+        </param>
+      </endpoint>
+    </api>
+  </server>
+)
+```
+
 ### \<number>
 
 [← back](#primitive-data)
@@ -2325,6 +2456,66 @@ export default (
 
 *In this example `/products?rating=5` is valid and `/products?rating=6` is not*
 
+#### exclusiveMinimum, exclusiveMaximum
+
+These props restrict the value to be strictly greater than or less than the specified number.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <endpoint method='get' path='/products'>
+        <param in='query' name='rating'>
+          <number 
+            exclusiveMinimum={0}
+            exclusiveMaximum={5}
+          />
+        </param>
+      </endpoint>
+    </api>
+  </server>
+)
+```
+
+#### multipleOf
+
+This prop restricts the value to be a multiple of the specified number.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <endpoint method='get' path='/products'>
+        <param in='query' name='quantity'>
+          <number multipleOf={10} />
+        </param>
+      </endpoint>
+    </api>
+  </server>
+)
+```
+
+#### format
+
+An optional format modifier serves as a hint at the contents and format of the number.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <endpoint method='get' path='/products'>
+        <param in='query' name='price'>
+          <number format='float' />
+        </param>
+      </endpoint>
+    </api>
+  </server>
+)
+```
+
 ### \<integer>
 
 [← back](#primitive-data)
@@ -2498,6 +2689,47 @@ export default (
 
 *In this example `/products?rating=5` is valid and `/products?rating=6` is not*
 
+#### exclusiveMinimum, exclusiveMaximum
+
+These props restrict the value to be strictly greater than or less than the specified number.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <endpoint method='get' path='/products'>
+        <param in='query' name='count'>
+          <integer 
+            exclusiveMinimum={0}
+            exclusiveMaximum={100}
+          />
+        </param>
+      </endpoint>
+    </api>
+  </server>
+)
+```
+
+#### multipleOf
+
+This prop restricts the value to be a multiple of the specified number.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <endpoint method='get' path='/products'>
+        <param in='query' name='quantity'>
+          <integer multipleOf={5} />
+        </param>
+      </endpoint>
+    </api>
+  </server>
+)
+```
+
 ### \<date>
 
 [← back](#primitive-data)
@@ -3135,6 +3367,48 @@ export default (
 )
 ```
 
+#### minItems, maxItems
+
+Those two props validate the array by minimum and maximum number of items.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <endpoint method='get' path='/products'>
+        <param in='query' name='tags'>
+          <array minItems={1} maxItems={10}>
+            <string />
+          </array>
+        </param>
+      </endpoint>
+    </api>
+  </server>
+)
+```
+
+#### uniqueItems
+
+This prop validates that all items in the array are unique.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <endpoint method='get' path='/products'>
+        <param in='query' name='ids'>
+          <array uniqueItems>
+            <number />
+          </array>
+        </param>
+      </endpoint>
+    </api>
+  </server>
+)
+```
+
 ### \<object>
 
 [← back](#list-of-data)
@@ -3298,6 +3572,58 @@ export default (
 )
 ```
 
+#### readOnly
+
+You can mark a field as read-only, meaning it can only be returned in responses, not sent in requests.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <endpoint method='get' path='/users'>
+        <response>
+          <object>
+            <field key='id' readOnly>
+              <uuid />
+            </field>
+            <field key='name'>
+              <string />
+            </field>
+          </object>
+        </response>
+      </endpoint>
+    </api>
+  </server>
+)
+```
+
+#### writeOnly
+
+You can mark a field as write-only, meaning it can only be sent in requests, not returned in responses.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <endpoint method='post' path='/users'>
+        <body>
+          <object>
+            <field key='password' writeOnly>
+              <string />
+            </field>
+            <field key='name'>
+              <string />
+            </field>
+          </object>
+        </body>
+      </endpoint>
+    </api>
+  </server>
+)
+```
+
 ## Run-Time
 
 Next elements relate to run-time action.

package/handler/handler.d.ts

@@ -1,6 +1,6 @@
 import { type JSXElement } from '@innet/jsx';
 import { arraySync, async } from '@innet/utils';
-import { type AnyProps, type ApiProps, type ArrayProps, type BinaryProps, blacklist, type BlacklistProps, type BodyProps, type BooleanProps, cms, type CmsProps, type ContactProps, type CookieProps, type DateProps, type DtsProps, type EndpointProps, type EnvProps, type ErrorProps, type FieldProps, file, type FileProps, type HeaderProps, type HostProps, type IntegerProps, type LicenseProps, type NullProps, type NumberProps, type ObjectProps, type ParamProps, preset, type PresetProps, protection, type ProtectionProps, type ProxyProps, type RedirectProps, type ResponseProps, type ReturnProps, type ServerProps, type StringProps, type SuccessProps, type SwaggerProps, type TagProps, type TupleProps, type UuidProps, type VariableProps, whitelist, type WhitelistProps } from '../plugins';
+import { type AnyProps, type ApiProps, type ArrayProps, type BinaryProps, blacklist, type BlacklistProps, type BodyProps, type BooleanProps, cms, type CmsProps, type ContactProps, type CookieProps, type DateProps, type DtsProps, type EndpointProps, type EnvProps, type ErrorProps, type FieldProps, file, type FileProps, type HeaderProps, type HostProps, type IntegerProps, type LicenseProps, type NullProps, type NumberProps, type ObjectProps, type ParamProps, preset, type PresetProps, protection, type ProtectionProps, type ProxyProps, type RedirectProps, type ResponseProps, type ReturnProps, type ServerProps, type StringProps, type SuccessProps, type SwaggerProps, type TagProps, type TupleProps, type UiProps, type UuidProps, type VariableProps, whitelist, type WhitelistProps } from '../plugins';
 export declare const arrayPlugins: (typeof arraySync)[];
 export declare const JSXPlugins: {
     any: import("innet").HandlerPlugin;
@@ -40,6 +40,7 @@ export declare const JSXPlugins: {
     swagger: import("innet").HandlerPlugin;
     tag: import("innet").HandlerPlugin;
     tuple: import("innet").HandlerPlugin;
+    ui: import("innet").HandlerPlugin;
     uuid: import("innet").HandlerPlugin;
     variable: import("innet").HandlerPlugin;
     whitelist: typeof whitelist;
@@ -50,7 +51,7 @@ export declare const promisePlugins: (typeof async)[];
 export declare const handler: import("innet").Handler;
 declare global {
     namespace JSX {
-        type Element = ArrayElement | FunctionElement | JSXElement | boolean | null | number | (string & {}) | undefined;
+        type Element = ({} & string) | ArrayElement | FunctionElement | JSXElement | boolean | null | number | undefined;
         interface ArrayElement extends Array<Element> {
         }
         type FunctionElement = () => Element;
@@ -92,9 +93,11 @@ declare global {
             server: ServerProps;
             string: StringProps;
             success: SuccessProps;
+            /** @deprecated Use <ui> */
             swagger: SwaggerProps;
             tag: TagProps;
             tuple: TupleProps;
+            ui: UiProps;
             uuid: UuidProps;
             variable: VariableProps;
             whitelist: WhitelistProps;

package/handler/handler.es6.js

@@ -39,6 +39,7 @@ import { success } from '../plugins/request/success/success.es6.js';
 import { swagger } from '../plugins/utils/swagger/swagger.es6.js';
 import { tag } from '../plugins/main/tag/tag.es6.js';
 import { tuple } from '../plugins/schema/tuple/tuple.es6.js';
+import { ui } from '../plugins/utils/ui/ui.es6.js';
 import { uuid } from '../plugins/schema/uuid/uuid.es6.js';
 import { variable } from '../plugins/main/variable/variable.es6.js';
 import { whitelist } from '../plugins/utils/whitelist/whitelist.es6.js';
@@ -85,6 +86,7 @@ const JSXPlugins = {
     swagger,
     tag,
     tuple,
+    ui,
     uuid,
     variable,
     whitelist,

package/handler/handler.js

@@ -43,6 +43,7 @@ var success = require('../plugins/request/success/success.js');
 var swagger = require('../plugins/utils/swagger/swagger.js');
 var tag = require('../plugins/main/tag/tag.js');
 var tuple = require('../plugins/schema/tuple/tuple.js');
+var ui = require('../plugins/utils/ui/ui.js');
 var uuid = require('../plugins/schema/uuid/uuid.js');
 var variable = require('../plugins/main/variable/variable.js');
 var whitelist = require('../plugins/utils/whitelist/whitelist.js');
@@ -89,6 +90,7 @@ const JSXPlugins = {
     swagger: swagger.swagger,
     tag: tag.tag,
     tuple: tuple.tuple,
+    ui: ui.ui,
     uuid: uuid.uuid,
     variable: variable.variable,
     whitelist: whitelist.whitelist,

package/hooks/index.d.ts

@@ -1,33 +1,33 @@
-export * from './useServer';
+export * from './useAction';
 export * from './useApi';
-export * from './useHost';
-export * from './useTag';
-export * from './useComponentName';
-export * from './useOneElementError';
-export * from './useSchemaContext';
-export * from './useSchemaType';
-export * from './useNewSchema';
-export * from './useRequest';
-export * from './useResponse';
-export * from './useParams';
+export * from './useBlock';
 export * from './useBody';
-export * from './useSearch';
-export * from './useParam';
+export * from './useBodyFile';
+export * from './useClientIp';
+export * from './useComponentName';
+export * from './useCookies';
+export * from './useEffect';
 export * from './useEndpoint';
-export * from './useBlock';
 export * from './useHeaders';
-export * from './useCookies';
-export * from './useAction';
-export * from './useThrow';
-export * from './useRule';
+export * from './useHost';
+export * from './useIsServerHttps';
+export * from './useNewSchema';
 export * from './useObjectRule';
-export * from './useBodyFile';
+export * from './useObjectSchemaContext';
+export * from './useOneElementError';
+export * from './useParam';
+export * from './useParams';
 export * from './usePath';
+export * from './useRequest';
+export * from './useRequestHandler';
+export * from './useResponse';
+export * from './useRule';
+export * from './useSchemaContext';
+export * from './useSchemaType';
+export * from './useSearch';
+export * from './useServer';
 export * from './useServerPlugin';
-export * from './useClientIp';
 export * from './useServerPlugins';
-export * from './useObjectSchemaContext';
 export * from './useServerPort';
-export * from './useIsServerHttps';
-export * from './useRequestHandler';
-export * from './useEffect';
+export * from './useTag';
+export * from './useThrow';

package/hooks/index.es6.js

@@ -1,33 +1,33 @@
-import './useServer/index.es6.js';
+import './useAction/index.es6.js';
 import './useApi/index.es6.js';
-import './useHost/index.es6.js';
-import './useTag/index.es6.js';
-import './useComponentName/index.es6.js';
-import './useOneElementError/index.es6.js';
-import './useSchemaContext/index.es6.js';
-import './useSchemaType/index.es6.js';
-import './useNewSchema/index.es6.js';
-import './useRequest/index.es6.js';
-import './useResponse/index.es6.js';
-import './useParams/index.es6.js';
+import './useBlock/index.es6.js';
 import './useBody/index.es6.js';
-import './useSearch/index.es6.js';
-import './useParam/index.es6.js';
+import './useBodyFile/index.es6.js';
+import './useClientIp/index.es6.js';
+import './useComponentName/index.es6.js';
+import './useCookies/index.es6.js';
+import './useEffect/index.es6.js';
 import './useEndpoint/index.es6.js';
-import './useBlock/index.es6.js';
 import './useHeaders/index.es6.js';
-import './useCookies/index.es6.js';
-import './useAction/index.es6.js';
-import './useThrow/index.es6.js';
-import './useRule/index.es6.js';
+import './useHost/index.es6.js';
+import './useIsServerHttps/index.es6.js';
+import './useNewSchema/index.es6.js';
 import './useObjectRule/index.es6.js';
-import './useBodyFile/index.es6.js';
+import './useObjectSchemaContext/index.es6.js';
+import './useOneElementError/index.es6.js';
+import './useParam/index.es6.js';
+import './useParams/index.es6.js';
 import './usePath/index.es6.js';
+import './useRequest/index.es6.js';
+import './useRequestHandler/index.es6.js';
+import './useResponse/index.es6.js';
+import './useRule/index.es6.js';
+import './useSchemaContext/index.es6.js';
+import './useSchemaType/index.es6.js';
+import './useSearch/index.es6.js';
+import './useServer/index.es6.js';
 import './useServerPlugin/index.es6.js';
-import './useClientIp/index.es6.js';
 import './useServerPlugins/index.es6.js';
-import './useObjectSchemaContext/index.es6.js';
 import './useServerPort/index.es6.js';
-import './useIsServerHttps/index.es6.js';
-import './useRequestHandler/index.es6.js';
-import './useEffect/index.es6.js';
+import './useTag/index.es6.js';
+import './useThrow/index.es6.js';

package/hooks/index.js

@@ -1,36 +1,36 @@
 'use strict';
 
-require('./useServer/index.js');
+require('./useAction/index.js');
 require('./useApi/index.js');
-require('./useHost/index.js');
-require('./useTag/index.js');
-require('./useComponentName/index.js');
-require('./useOneElementError/index.js');
-require('./useSchemaContext/index.js');
-require('./useSchemaType/index.js');
-require('./useNewSchema/index.js');
-require('./useRequest/index.js');
-require('./useResponse/index.js');
-require('./useParams/index.js');
+require('./useBlock/index.js');
 require('./useBody/index.js');
-require('./useSearch/index.js');
-require('./useParam/index.js');
+require('./useBodyFile/index.js');
+require('./useClientIp/index.js');
+require('./useComponentName/index.js');
+require('./useCookies/index.js');
+require('./useEffect/index.js');
 require('./useEndpoint/index.js');
-require('./useBlock/index.js');
 require('./useHeaders/index.js');
-require('./useCookies/index.js');
-require('./useAction/index.js');
-require('./useThrow/index.js');
-require('./useRule/index.js');
+require('./useHost/index.js');
+require('./useIsServerHttps/index.js');
+require('./useNewSchema/index.js');
 require('./useObjectRule/index.js');
-require('./useBodyFile/index.js');
+require('./useObjectSchemaContext/index.js');
+require('./useOneElementError/index.js');
+require('./useParam/index.js');
+require('./useParams/index.js');
 require('./usePath/index.js');
+require('./useRequest/index.js');
+require('./useRequestHandler/index.js');
+require('./useResponse/index.js');
+require('./useRule/index.js');
+require('./useSchemaContext/index.js');
+require('./useSchemaType/index.js');
+require('./useSearch/index.js');
+require('./useServer/index.js');
 require('./useServerPlugin/index.js');
-require('./useClientIp/index.js');
 require('./useServerPlugins/index.js');
-require('./useObjectSchemaContext/index.js');
 require('./useServerPort/index.js');
-require('./useIsServerHttps/index.js');
-require('./useRequestHandler/index.js');
-require('./useEffect/index.js');
+require('./useTag/index.js');
+require('./useThrow/index.js');
 

package/index.d.ts

@@ -1,6 +1,6 @@
 export { handler as default } from './handler';
-export * from './plugins';
 export * from './handler';
-export * from './utils';
 export * from './hooks';
+export * from './plugins';
 export * from './types';
+export * from './utils';