@innet/server 2.0.0-alpha.10 → 2.0.0-alpha.11

package/README.md

@@ -477,15 +477,15 @@ You can use `PROTECTION` env to set default protection `value`.
 
 *src/app.tsx*
 ```typescript jsx
-import html from './protection.html'
-
 export default (
   <server>
     <api>
-      <protection
-        value='secret'
-        html={html}
-      />
+      <protection value='secret'>
+        <error
+          code='protection'
+          status='forbidden'
+        />
+      </protection>
     </api>
   </server>
 )
@@ -500,15 +500,17 @@ You can use `PROTECTION_MAX_AGE` env to set default `maxAge`.
 
 *src/app.tsx*
 ```typescript jsx
-import html from './protection.html'
-
 export default (
   <server>
     <api>
       <protection
         maxAge={24 * 60 * 60}
-        html={html}
-      />
+        value='secret'>
+        <error
+          code='protection'
+          status='forbidden'
+        />
+      </protection>
     </api>
   </server>
 )
@@ -522,15 +524,17 @@ You can use `PROTECTED_IP` env to set default `excludeIp`.
 
 *src/app.tsx*
 ```typescript jsx
-import html from './protection.html'
-
 export default (
   <server>
     <api>
       <protection
         excludeIp='0.0.0.0,127.0.0.0'
-        html={html}
-      />
+        value='secret'>
+        <error
+          code='protection'
+          status='forbidden'
+        />
+      </protection>
     </api>
   </server>
 )
@@ -545,15 +549,17 @@ You can use `PROTECTION_COOKIE_KEY` env to set default `cookieKey`.
 
 *src/app.tsx*
 ```typescript jsx
-import html from './protection.html'
-
 export default (
   <server>
     <api>
       <protection
         cookieKey='secret'
-        html={html}
-      />
+        value='secret'>
+        <error
+          code='protection'
+          status='forbidden'
+        />
+      </protection>
     </api>
   </server>
 )
@@ -568,15 +574,17 @@ You can use `PROTECTION_SEARCH_KEY` env to set default `searchKey`.
 
 *src/app.tsx*
 ```typescript jsx
-import html from './protection.html'
-
 export default (
   <server>
     <api>
       <protection
         searchKey='secret'
-        html={html}
-      />
+        value='secret'>
+        <error
+          code='protection'
+          status='forbidden'
+        />
+      </protection>
     </api>
   </server>
 )
@@ -1150,6 +1158,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>
@@ -1183,6 +1192,105 @@ 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>
+)
+```
+
 ## Primitive Data
 
 [← back](#index)

package/index.es6.js

@@ -12,7 +12,7 @@ export { host } from './plugins/main/host/host.es6.js';
 export { variable } from './plugins/main/variable/variable.es6.js';
 export { tag } from './plugins/main/tag/tag.es6.js';
 export { endpoint } from './plugins/main/endpoint/endpoint.es6.js';
-export { response } from './plugins/main/response/response.es6.js';
+export { response, statuses } from './plugins/main/response/response.es6.js';
 export { request } from './plugins/main/request/request.es6.js';
 export { param } from './plugins/main/param/param.es6.js';
 export { body } from './plugins/main/body/body.es6.js';

package/index.js

@@ -133,6 +133,7 @@ exports.variable = variable.variable;
 exports.tag = tag.tag;
 exports.endpoint = endpoint.endpoint;
 exports.response = response.response;
+exports.statuses = response.statuses;
 exports.request = request.request;
 exports.param = param.param;
 exports.body = body.body;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@innet/server",
-  "version": "2.0.0-alpha.10",
+  "version": "2.0.0-alpha.11",
   "description": "Create server-side application with innet",
   "main": "index.js",
   "module": "index.es6.js",

package/plugins/main/response/index.es6.js

@@ -1 +1 @@
-export { response } from './response.es6.js';
+export { response, statuses } from './response.es6.js';

package/plugins/main/response/index.js

@@ -7,3 +7,4 @@ var response = require('./response.js');
 
 
 exports.response = response.response;
+exports.statuses = response.statuses;

package/plugins/main/response/response.d.ts

@@ -1,4 +1,6 @@
 import { type HandlerPlugin } from 'innet';
+import { type ErrorStatuses, type RedirectStatuses, type SuccessStatuses } from '../../request';
+export type StatusKey = ErrorStatuses | RedirectStatuses | SuccessStatuses;
 export interface ResponseProps {
     /**
      * A description of the response.
@@ -11,6 +13,7 @@ export interface ResponseProps {
      * For example, 2XX represents all response codes between [200-299].
      * Only the following range definitions are allowed: 1XX, 2XX, 3XX, 4XX, and 5XX.
      * */
-    status?: number | 'default';
+    status?: number | `${1 | 2 | 3 | 4 | 5}XX` | 'default' | StatusKey;
 }
+export declare const statuses: Record<StatusKey, number>;
 export declare const response: HandlerPlugin;

package/plugins/main/response/response.es6.js

@@ -2,18 +2,26 @@ import innet, { useNewHandler } from 'innet';
 import { useProps, useChildren, useContext } from '@innet/jsx';
 import '../../../hooks/index.es6.js';
 import '../../../utils/index.es6.js';
+import '../../request/index.es6.js';
+import { errorStatuses } from '../../request/error/error.es6.js';
+import { redirectStatuses } from '../../request/redirect/redirect.es6.js';
+import { successStatuses } from '../../request/success/success.es6.js';
 import { useEndpoint, endpointContext } from '../../../hooks/useEndpoint/useEndpoint.es6.js';
 import { useThrow } from '../../../hooks/useThrow/useThrow.es6.js';
 import { schemaContext } from '../../../hooks/useSchemaContext/useSchemaContext.es6.js';
 import { getOrAdd } from '../../../utils/getOrAdd/getOrAdd.es6.js';
 import { ruleContext } from '../../../hooks/useRule/useRule.es6.js';
 
+const statuses = Object.assign(Object.assign(Object.assign({}, errorStatuses), redirectStatuses), successStatuses);
 const response = () => {
-    const { description = '', status = 'default' } = useProps() || {};
+    let { description = '', status = 'default' } = useProps() || {};
     const { operation, props: { path } } = useEndpoint();
     const children = useChildren();
     const handler = useNewHandler();
     const endpoint = useContext(endpointContext);
+    if (status in statuses) {
+        status = statuses[status];
+    }
     if (!endpoint) {
         useThrow('<{type}> MUST be placed in <endpoint> element');
     }
@@ -41,4 +49,4 @@ const response = () => {
     innet(children, handler);
 };
 
-export { response };
+export { response, statuses };

package/plugins/main/response/response.js

@@ -6,6 +6,10 @@ var innet = require('innet');
 var jsx = require('@innet/jsx');
 require('../../../hooks/index.js');
 require('../../../utils/index.js');
+require('../../request/index.js');
+var error = require('../../request/error/error.js');
+var redirect = require('../../request/redirect/redirect.js');
+var success = require('../../request/success/success.js');
 var useEndpoint = require('../../../hooks/useEndpoint/useEndpoint.js');
 var useThrow = require('../../../hooks/useThrow/useThrow.js');
 var useSchemaContext = require('../../../hooks/useSchemaContext/useSchemaContext.js');
@@ -16,12 +20,16 @@ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'defau
 
 var innet__default = /*#__PURE__*/_interopDefaultLegacy(innet);
 
+const statuses = Object.assign(Object.assign(Object.assign({}, error.errorStatuses), redirect.redirectStatuses), success.successStatuses);
 const response = () => {
-    const { description = '', status = 'default' } = jsx.useProps() || {};
+    let { description = '', status = 'default' } = jsx.useProps() || {};
     const { operation, props: { path } } = useEndpoint.useEndpoint();
     const children = jsx.useChildren();
     const handler = innet.useNewHandler();
     const endpoint = jsx.useContext(useEndpoint.endpointContext);
+    if (status in statuses) {
+        status = statuses[status];
+    }
     if (!endpoint) {
         useThrow.useThrow('<{type}> MUST be placed in <endpoint> element');
     }
@@ -50,3 +58,4 @@ const response = () => {
 };
 
 exports.response = response;
+exports.statuses = statuses;

package/plugins/request/redirect/redirect.d.ts

@@ -9,9 +9,10 @@ export declare const redirectStatuses: {
     temporaryRedirect: number;
     permanentRedirect: number;
 };
+export type RedirectStatuses = keyof typeof redirectStatuses;
 export interface RedirectProps {
     to: string;
     encode?: boolean;
-    status?: number | keyof typeof redirectStatuses;
+    status?: number | RedirectStatuses;
 }
 export declare const redirect: HandlerPlugin;