@innet/server 2.0.0-alpha.7 → 2.0.0-alpha.8

package/README.md

@@ -3317,7 +3317,7 @@ Hook functions give you all features to control parent element functionality.
 
 [← back](#index)
 
-[useServer](#useserver)  
+Real-time  
 [useRequest](#userequest)  
 [useResponse](#useresponse)  
 [useHeaders](#useheaders)  
@@ -3326,31 +3326,16 @@ Hook functions give you all features to control parent element functionality.
 [useParams](#useparams)  
 [useSearch](#usesearch)  
 [useBody](#usebody)  
-[useComponentName](#usecomponentname)  
-[useRequestPlugin](#userequestplugin)  
+[useClientIp](#useclientip)  
 
----
+Server start  
+[useRequestPlugin](#userequestplugin)
 
-### 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()
-
-  console.log(server)
+Both  
+[useServer](#useserver)  
+[useComponentName](#usecomponentname)
 
-  return <success />
-}
-```
+---
 
 ### useRequest
 
@@ -3505,21 +3490,21 @@ export function Component () {
 }
 ```
 
-### useComponentName
+### useClientIp
 
 [← back](#hooks)
 
-This hook returns name of current component.
+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 { useComponentName } from '@innet/sever'
+import { useClientIp } from '@innet/sever'
 
 export function Component () {
-// returns this ^-------^
-  const name = useComponentName()
-
-  return <success>{{ name }}</success>
+  const ip = useClientIp()
+  
+  return <success>{{ ip }}</success>
 }
 ```
 
@@ -3531,6 +3516,8 @@ 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'
@@ -3568,6 +3555,44 @@ export default (
 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/hooks/index.d.ts

@@ -24,3 +24,4 @@ export * from './useObjectRule';
 export * from './useBodyFile';
 export * from './usePath';
 export * from './useRequestPlugin';
+export * from './useClientIp';

package/hooks/index.es6.js

@@ -24,3 +24,4 @@ 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';

package/hooks/index.js

@@ -26,4 +26,5 @@ require('./useObjectRule/index.js');
 require('./useBodyFile/index.js');
 require('./usePath/index.js');
 require('./useRequestPlugin/index.js');
+require('./useClientIp/index.js');
 

package/hooks/useClientIp/index.d.ts

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

package/hooks/useClientIp/index.es6.js

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

package/hooks/useClientIp/index.js

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

package/hooks/useClientIp/useClientIp.d.ts

@@ -0,0 +1 @@
+export declare function useClientIp(): string | null;

package/hooks/useClientIp/useClientIp.es6.js

@@ -0,0 +1,15 @@
+import { getClientIp } from 'request-ip';
+import '../useRequest/index.es6.js';
+import '../useThrow/index.es6.js';
+import { useRequest } from '../useRequest/useRequest.es6.js';
+import { useThrow } from '../useThrow/useThrow.es6.js';
+
+function useClientIp() {
+    const req = useRequest();
+    if (!req) {
+        useThrow('<{type}> MUST be in <request> or <fallback>');
+    }
+    return getClientIp(req);
+}
+
+export { useClientIp };

package/hooks/useClientIp/useClientIp.js

@@ -0,0 +1,19 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var requestIp = require('request-ip');
+require('../useRequest/index.js');
+require('../useThrow/index.js');
+var useRequest = require('../useRequest/useRequest.js');
+var useThrow = require('../useThrow/useThrow.js');
+
+function useClientIp() {
+    const req = useRequest.useRequest();
+    if (!req) {
+        useThrow.useThrow('<{type}> MUST be in <request> or <fallback>');
+    }
+    return requestIp.getClientIp(req);
+}
+
+exports.useClientIp = useClientIp;

package/index.es6.js

@@ -108,3 +108,4 @@ export { objectRuleContext, useObjectRule } from './hooks/useObjectRule/useObjec
 export { bodyFileContext, useBodyFile } from './hooks/useBodyFile/useBodyFile.es6.js';
 export { usePath } from './hooks/usePath/usePath.es6.js';
 export { useRequestPlugin } from './hooks/useRequestPlugin/useRequestPlugin.es6.js';
+export { useClientIp } from './hooks/useClientIp/useClientIp.es6.js';

package/index.js

@@ -112,6 +112,7 @@ var useObjectRule = require('./hooks/useObjectRule/useObjectRule.js');
 var useBodyFile = require('./hooks/useBodyFile/useBodyFile.js');
 var usePath = require('./hooks/usePath/usePath.js');
 var useRequestPlugin = require('./hooks/useRequestPlugin/useRequestPlugin.js');
+var useClientIp = require('./hooks/useClientIp/useClientIp.js');
 
 
 
@@ -248,3 +249,4 @@ exports.bodyFileContext = useBodyFile.bodyFileContext;
 exports.useBodyFile = useBodyFile.useBodyFile;
 exports.usePath = usePath.usePath;
 exports.useRequestPlugin = useRequestPlugin.useRequestPlugin;
+exports.useClientIp = useClientIp.useClientIp;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@innet/server",
-  "version": "2.0.0-alpha.7",
+  "version": "2.0.0-alpha.8",
   "description": "Create server-side application with innet",
   "main": "index.js",
   "module": "index.es6.js",
@@ -49,6 +49,7 @@
     "multiparty": "^4.2.3",
     "openapi-types": "^12.1.3",
     "qs": "^6.11.2",
+    "request-ip": "^3.3.0",
     "string_decoder": "^1.3.0",
     "tslib": "^2.6.1",
     "uuid": "^9.0.0",