@innet/server 2.0.0-beta.3 → 2.0.0-beta.5

package/README.md

@@ -2176,6 +2176,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 +2345,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 +2578,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 +3256,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 +3461,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

@@ -50,7 +50,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;

package/hooks/index.d.ts

@@ -1,32 +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 './useTag';
+export * from './useThrow';

package/hooks/index.es6.js

@@ -1,32 +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 './useTag/index.es6.js';
+import './useThrow/index.es6.js';

package/hooks/index.js

@@ -1,35 +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('./useTag/index.js');
+require('./useThrow/index.js');
 

package/hooks/useEffect/index.d.ts

@@ -0,0 +1 @@
+export * from './useEffect';

package/hooks/useEffect/index.es6.js

@@ -0,0 +1 @@
+export { useEffect } from './useEffect.es6.js';

package/hooks/useEffect/index.js

@@ -0,0 +1,9 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var useEffect = require('./useEffect.js');
+
+
+
+exports.useEffect = useEffect.useEffect;

package/hooks/useEffect/useEffect.d.ts

@@ -0,0 +1,2 @@
+import { type Effect } from '../../types';
+export declare function useEffect(effect: Effect): void;

package/hooks/useEffect/useEffect.es6.js

@@ -0,0 +1,8 @@
+import { innet } from 'innet';
+import { callHandler } from '@innet/utils';
+
+function useEffect(effect) {
+    innet(effect, callHandler, 1, true);
+}
+
+export { useEffect };

package/hooks/useEffect/useEffect.js

@@ -0,0 +1,12 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var innet = require('innet');
+var utils = require('@innet/utils');
+
+function useEffect(effect) {
+    innet.innet(effect, utils.callHandler, 1, true);
+}
+
+exports.useEffect = useEffect;

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';