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

package/README.md

@@ -317,7 +317,9 @@ This section contains elements of utils.
 
 [\<swagger>](#swagger)  
 [\<dev>](#dev)  
-[\<dts>](#dts)
+[\<prod>](#prod)  
+[\<dts>](#dts)  
+[\<protection>](#protection)
 
 ---
 
@@ -374,6 +376,25 @@ export default (
 )
 ```
 
+### \<prod>
+
+[← back](#utils)
+
+Everything inside <prod> will work when `NODE_ENV` equals `production`.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <prod>
+        <swagger />
+      </prod>
+    </api>
+  </server>
+)
+```
+
 ### \<dts>
 
 [← back](#utils)
@@ -396,21 +417,178 @@ export default (
 )
 ```
 
-> You MUST add some [endpoint](#endpoint) with some schema otherwise you get the `Error: There is no schema in the input contents`.
-
+You do not need to import types, use `Api` namespace everywhere.
 Here is an example of generated types usage.
 
-*src/GetPartner.tsx*
 ```typescript jsx
 import { useParams } from '@innet/server'
 
-export function GetPartner () {
-  const { id } = useParams<Paths.Partners$Id.Get.PathParameters>()
-  return <success>{{ id }}</success>
+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 />
 }
 ```
 
-You do not need to import types, they generate as namespaces.
+### \<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.
+
+By default, the prop equals a year.
+You can use `PROTECTION_MAX_AGE` env to set default `maxAge`.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <protection
+        maxAge={24 * 60 * 60}
+        value='secret'>
+        <error
+          code='protection'
+          status='forbidden'
+        />
+      </protection>
+    </api>
+  </server>
+)
+```
+
+#### excludeIp
+
+This prop sets a list of IP addresses (split by `,`) to ignore the protection.
+
+You can use `PROTECTED_IP` env to set default `excludeIp`.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <protection
+        excludeIp='0.0.0.0,127.0.0.0'
+        value='secret'>
+        <error
+          code='protection'
+          status='forbidden'
+        />
+      </protection>
+    </api>
+  </server>
+)
+```
+
+#### cookieKey
+
+This prop sets a cookie field name used to store protection of a user.
+
+By default, it equals `protection`.
+You can use `PROTECTION_COOKIE_KEY` env to set default `cookieKey`.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <protection
+        cookieKey='secret'
+        value='secret'>
+        <error
+          code='protection'
+          status='forbidden'
+        />
+      </protection>
+    </api>
+  </server>
+)
+```
+
+#### searchKey
+
+This prop sets a search query field name used to check protection.
+
+By default, it equals `protection`.
+You can use `PROTECTION_SEARCH_KEY` env to set default `searchKey`.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <protection
+        searchKey='secret'
+        value='secret'>
+        <error
+          code='protection'
+          status='forbidden'
+        />
+      </protection>
+    </api>
+  </server>
+)
+```
 
 ## API Info
 
@@ -980,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>
@@ -1013,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)
@@ -2624,6 +2902,26 @@ export default (
 )
 ```
 
+#### 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>
+    <api>
+      <fallback>
+        <success contentType='text/html'>
+          Hello World!
+        </success>
+      </fallback>
+    </api>
+  </server>
+)
+```
+
 ### \<error>
 
 [← back](#run-time)
@@ -3310,7 +3608,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,29 +3617,16 @@ 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*
+Server start  
+[useRequestPlugin](#userequestplugin)
 
-```typescript jsx
-import { useServer } from '@innet/sever'
-
-export function Component () {
-  const server = useServer()
-
-  console.log(server)
+Both  
+[useServer](#useserver)  
+[useComponentName](#usecomponentname)
 
-  return <success />
-}
-```
+---
 
 ### useRequest
 
@@ -3496,6 +3781,109 @@ 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 [\<fallback>](#fallback).
+
+*src/Component.tsx*
+```typescript jsx
+import { useClientIp } from '@innet/sever'
+
+export function Component () {
+  const ip = useClientIp()
+  
+  return <success>{{ ip }}</success>
+}
+```
+
+### useRequestPlugin
+
+[← 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 [\<api>](#api).
+
+*src/SecretEndpoint.tsx*
+```typescript jsx
+import { useRequestPlugin } 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
+    }
+  })
+}
+```
+
+Then use the plugin in [\<api>](#api).
+
+*src/app.tsx*
+```typescript jsx
+import { SecretEndpoint } from './SecretEndpoint'
+
+export default (
+  <server>
+    <api>
+      <fallback>
+        <error />
+      </fallback>
+      <SecretEndpoint />
+    </api>
+  </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).
 

package/example/requests/index.d.ts

@@ -1 +1 @@
-export * from './partners';
+export * from './todo';

package/example/requests/todo/AddTodo/AddTodo.d.ts

@@ -0,0 +1 @@
+export declare function AddTodo(): any;

package/example/requests/todo/AddTodo/index.d.ts

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

package/example/requests/todo/DeleteTodo/DeleteTodo.d.ts

@@ -0,0 +1 @@
+export declare function DeleteTodo(): any;

package/example/requests/todo/DeleteTodo/index.d.ts

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

package/example/requests/todo/EditTodo/EditTodo.d.ts

@@ -0,0 +1 @@
+export declare function EditTodo(): any;

package/example/requests/todo/EditTodo/index.d.ts

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

package/example/requests/todo/GetTodo/GetTodo.d.ts

@@ -0,0 +1 @@
+export declare function GetTodo(): any;

package/example/requests/todo/GetTodo/index.d.ts

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

package/example/requests/todo/GetTodos/GetTodos.d.ts

@@ -0,0 +1 @@
+export declare function GetTodos(): any;

package/example/requests/todo/GetTodos/index.d.ts

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

package/example/requests/todo/index.d.ts

@@ -0,0 +1,5 @@
+export * from './GetTodos';
+export * from './GetTodo';
+export * from './AddTodo';
+export * from './EditTodo';
+export * from './DeleteTodo';

package/example/requests/todo/todos.d.ts

@@ -0,0 +1 @@
+export declare const todos: Api.Schemas.TodoSchema[];

package/example/schemas/app/ListQueryParams/ListQueryParams.d.ts

@@ -0,0 +1 @@
+export declare function ListQueryParams(): any;

package/example/schemas/app/ListQueryParams/index.d.ts

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

package/example/schemas/app/ListSchema/ListSchema.d.ts

@@ -1 +1,4 @@
-export declare function ListSchema(): any;
+export interface ListSchemaProps {
+    key: string;
+}
+export declare function ListSchema({ key }: ListSchemaProps): any;

package/example/schemas/app/index.d.ts

@@ -1 +1,2 @@
 export * from './ListSchema';
+export * from './ListQueryParams';

package/example/schemas/index.d.ts

@@ -1,4 +1,2 @@
-export * from './location';
-export * from './address';
-export * from './partner';
 export * from './app';
+export * from './todo';

package/example/schemas/todo/TodoSchema/TodoSchema.d.ts

@@ -0,0 +1,4 @@
+export interface TodoSchemaProps {
+    body?: boolean;
+}
+export declare function TodoSchema({ body }?: TodoSchemaProps): any;

package/example/schemas/todo/TodoSchema/index.d.ts

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

package/example/schemas/todo/index.d.ts

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

package/example/tags/Todo/Todo.d.ts

@@ -0,0 +1 @@
+export declare function Todo(): any;

package/example/tags/Todo/index.d.ts

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

package/example/tags/index.d.ts

@@ -1 +1 @@
-export * from './Partner';
+export * from './Todo';

package/handler/handler.d.ts

@@ -1,6 +1,6 @@
 import { context, type ContextProps, slot, type SlotProps, slots, type SlotsProps } from '@innet/jsx';
 import { arraySync, async } from '@innet/utils';
-import { type ApiProps, type ArrayProps, type BinaryProps, type BodyProps, type BooleanProps, cms, type CmsProps, type ContactProps, type CookieProps, type DateProps, type DevProps, type DtsProps, type EndpointProps, type ErrorProps, type FallbackProps, type FieldProps, file, type FileProps, type HeaderProps, type HostProps, type IntegerProps, type LicenseProps, type NullProps, type NumberProps, type ObjectProps, type ParamProps, type ProdProps, type ProxyProps, type RedirectProps, type RequestProps, type ResponseProps, type ServerProps, type StringProps, type SuccessProps, type SwaggerProps, type TagProps, type TupleProps, type UuidProps, type VariableProps } from '../plugins';
+import { type ApiProps, type ArrayProps, type BinaryProps, type BodyProps, type BooleanProps, cms, type CmsProps, type ContactProps, type CookieProps, type DateProps, type DevProps, type DtsProps, type EndpointProps, type ErrorProps, type FallbackProps, type FieldProps, file, type FileProps, type HeaderProps, type HostProps, type IntegerProps, type LicenseProps, type NullProps, type NumberProps, type ObjectProps, type ParamProps, type ProdProps, protection, type ProtectionProps, type ProxyProps, type RedirectProps, type RequestProps, type ResponseProps, type ServerProps, type StringProps, type SuccessProps, type SwaggerProps, type TagProps, type TupleProps, type UuidProps, type VariableProps } from '../plugins';
 export declare const arrayPlugins: (typeof arraySync)[];
 export declare const JSXPlugins: {
     api: import("innet").HandlerPlugin;
@@ -29,6 +29,7 @@ export declare const JSXPlugins: {
     object: import("innet").HandlerPlugin;
     param: import("innet").HandlerPlugin;
     prod: import("innet").HandlerPlugin;
+    protection: typeof protection;
     proxy: import("innet").HandlerPlugin;
     redirect: import("innet").HandlerPlugin;
     request: import("innet").HandlerPlugin;
@@ -77,6 +78,7 @@ declare global {
             object: ObjectProps;
             param: ParamProps;
             prod: ProdProps;
+            protection: ProtectionProps;
             proxy: ProxyProps;
             redirect: RedirectProps;
             request: RequestProps;

package/handler/handler.es6.js

@@ -27,6 +27,7 @@ import { number } from '../plugins/schema/number/number.es6.js';
 import { object } from '../plugins/schema/object/object.es6.js';
 import { param } from '../plugins/main/param/param.es6.js';
 import { prod } from '../plugins/utils/prod/prod.es6.js';
+import { protection } from '../plugins/utils/protection/protection.es6.js';
 import { proxy } from '../plugins/request/proxy/proxy.es6.js';
 import { redirect } from '../plugins/request/redirect/redirect.es6.js';
 import { request } from '../plugins/main/request/request.es6.js';
@@ -71,6 +72,7 @@ const JSXPlugins = {
     object,
     param,
     prod,
+    protection,
     proxy,
     redirect,
     request,

package/handler/handler.js

@@ -31,6 +31,7 @@ var number = require('../plugins/schema/number/number.js');
 var object = require('../plugins/schema/object/object.js');
 var param = require('../plugins/main/param/param.js');
 var prod = require('../plugins/utils/prod/prod.js');
+var protection = require('../plugins/utils/protection/protection.js');
 var proxy = require('../plugins/request/proxy/proxy.js');
 var redirect = require('../plugins/request/redirect/redirect.js');
 var request = require('../plugins/main/request/request.js');
@@ -75,6 +76,7 @@ const JSXPlugins = {
     object: object.object,
     param: param.param,
     prod: prod.prod,
+    protection: protection.protection,
     proxy: proxy.proxy,
     redirect: redirect.redirect,
     request: request.request,

package/hooks/index.d.ts

@@ -23,3 +23,5 @@ export * from './useRule';
 export * from './useObjectRule';
 export * from './useBodyFile';
 export * from './usePath';
+export * from './useRequestPlugin';
+export * from './useClientIp';

package/hooks/index.es6.js

@@ -23,3 +23,5 @@ import './useRule/index.es6.js';
 import './useObjectRule/index.es6.js';
 import './useBodyFile/index.es6.js';
 import './usePath/index.es6.js';
+import './useRequestPlugin/index.es6.js';
+import './useClientIp/index.es6.js';