@innet/server 2.0.0-alpha.6 → 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,30 +3326,16 @@ Hook functions give you all features to control parent element functionality.
 [useParams](#useparams)  
 [useSearch](#usesearch)  
 [useBody](#usebody)  
-[useComponentName](#usecomponentname)  
-
----
-
-### 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*
+[useClientIp](#useclientip)  
 
-```typescript jsx
-import { useServer } from '@innet/sever'
-
-export function Component () {
-  const server = useServer()
+Server start  
+[useRequestPlugin](#userequestplugin)
 
-  console.log(server)
+Both  
+[useServer](#useserver)  
+[useComponentName](#usecomponentname)
 
-  return <success />
-}
-```
+---
 
 ### useRequest
 
@@ -3504,6 +3490,91 @@ 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)

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

package/hooks/index.js

@@ -25,4 +25,6 @@ require('./useRule/index.js');
 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/hooks/useRequestPlugin/index.d.ts

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

package/hooks/useRequestPlugin/index.es6.js

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

package/hooks/useRequestPlugin/index.js

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

package/hooks/useRequestPlugin/useRequestPlugin.d.ts

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

package/hooks/useRequestPlugin/useRequestPlugin.es6.js

@@ -0,0 +1,13 @@
+import { onDestroy } from 'watch-state';
+import '../useApi/index.es6.js';
+import { useApi } from '../useApi/useApi.es6.js';
+
+function useRequestPlugin(listener) {
+    const { requestPlugins } = useApi();
+    requestPlugins.add(listener);
+    onDestroy(() => {
+        requestPlugins.delete(listener);
+    });
+}
+
+export { useRequestPlugin };

package/hooks/useRequestPlugin/useRequestPlugin.js

@@ -0,0 +1,17 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var watchState = require('watch-state');
+require('../useApi/index.js');
+var useApi = require('../useApi/useApi.js');
+
+function useRequestPlugin(listener) {
+    const { requestPlugins } = useApi.useApi();
+    requestPlugins.add(listener);
+    watchState.onDestroy(() => {
+        requestPlugins.delete(listener);
+    });
+}
+
+exports.useRequestPlugin = useRequestPlugin;

package/index.es6.js

@@ -107,3 +107,5 @@ export { ruleContext, useRule, useSetRule } from './hooks/useRule/useRule.es6.js
 export { objectRuleContext, useObjectRule } from './hooks/useObjectRule/useObjectRule.es6.js';
 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

@@ -111,6 +111,8 @@ var useRule = require('./hooks/useRule/useRule.js');
 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');
 
 
 
@@ -246,3 +248,5 @@ exports.useObjectRule = useObjectRule.useObjectRule;
 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.6",
+  "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",

package/plugins/main/api/api.es6.js

@@ -46,6 +46,10 @@ const api = () => {
         if (!url.startsWith(prefix)) {
             return;
         }
+        for (const requestPlugin of requestPlugins) {
+            if (requestPlugin(req, res))
+                return;
+        }
         const method = ((_c = (_b = req.method) === null || _b === void 0 ? void 0 : _b.toLowerCase()) !== null && _c !== void 0 ? _c : 'get');
         const rawSplitPath = url.slice(prefix.length).split('/').slice(1);
         const splitPath = rawSplitPath.at(-1) ? rawSplitPath : rawSplitPath.slice(0, -1);
@@ -154,10 +158,6 @@ const api = () => {
                 }
             }
         }
-        for (const requestPlugin of requestPlugins) {
-            if (requestPlugin(req, res))
-                return;
-        }
         if (context.fallback) {
             const newHandler = Object.create(context.fallback.handler);
             responseContext.set(newHandler, res);

package/plugins/main/api/api.js

@@ -54,6 +54,10 @@ const api = () => {
         if (!url.startsWith(prefix)) {
             return;
         }
+        for (const requestPlugin of requestPlugins) {
+            if (requestPlugin(req, res))
+                return;
+        }
         const method = ((_c = (_b = req.method) === null || _b === void 0 ? void 0 : _b.toLowerCase()) !== null && _c !== void 0 ? _c : 'get');
         const rawSplitPath = url.slice(prefix.length).split('/').slice(1);
         const splitPath = rawSplitPath.at(-1) ? rawSplitPath : rawSplitPath.slice(0, -1);
@@ -162,10 +166,6 @@ const api = () => {
                 }
             }
         }
-        for (const requestPlugin of requestPlugins) {
-            if (requestPlugin(req, res))
-                return;
-        }
         if (context.fallback) {
             const newHandler = Object.create(context.fallback.handler);
             useResponse.responseContext.set(newHandler, res);

package/plugins/utils/swagger/swagger.es6.js

@@ -1,14 +1,14 @@
 import { useProps } from '@innet/jsx';
-import { onDestroy } from 'watch-state';
 import '../../../hooks/index.es6.js';
 import html from './swagger.html.es6.js';
 import { useApi } from '../../../hooks/useApi/useApi.es6.js';
+import { useRequestPlugin } from '../../../hooks/useRequestPlugin/useRequestPlugin.es6.js';
 
 const swagger = () => {
     const { path = '/swagger-ui' } = useProps() || {};
-    const { docs, requestPlugins, prefix } = useApi();
+    const { docs, prefix } = useApi();
     let swaggerResponse;
-    const listener = (req, res) => {
+    useRequestPlugin((req, res) => {
         if (req.url === prefix + path) {
             if (!swaggerResponse) {
                 swaggerResponse = html.replace('spec: {},', `spec: ${JSON.stringify(docs)},`);
@@ -18,10 +18,6 @@ const swagger = () => {
             res.end();
             return true;
         }
-    };
-    requestPlugins.add(listener);
-    onDestroy(() => {
-        requestPlugins.delete(listener);
     });
 };
 

package/plugins/utils/swagger/swagger.js

@@ -3,16 +3,16 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var jsx = require('@innet/jsx');
-var watchState = require('watch-state');
 require('../../../hooks/index.js');
 var swagger$1 = require('./swagger.html.js');
 var useApi = require('../../../hooks/useApi/useApi.js');
+var useRequestPlugin = require('../../../hooks/useRequestPlugin/useRequestPlugin.js');
 
 const swagger = () => {
     const { path = '/swagger-ui' } = jsx.useProps() || {};
-    const { docs, requestPlugins, prefix } = useApi.useApi();
+    const { docs, prefix } = useApi.useApi();
     let swaggerResponse;
-    const listener = (req, res) => {
+    useRequestPlugin.useRequestPlugin((req, res) => {
         if (req.url === prefix + path) {
             if (!swaggerResponse) {
                 swaggerResponse = swagger$1["default"].replace('spec: {},', `spec: ${JSON.stringify(docs)},`);
@@ -22,10 +22,6 @@ const swagger = () => {
             res.end();
             return true;
         }
-    };
-    requestPlugins.add(listener);
-    watchState.onDestroy(() => {
-        requestPlugins.delete(listener);
     });
 };