yxorp 0.1.2 → 0.1.4

package/.editorconfig

@@ -1,16 +1,16 @@
-# Editor configuration, see http://editorconfig.org
-root = true
-
-[*]
-charset = utf-8
-indent_style = space
-indent_size = 2
-insert_final_newline = true
-trim_trailing_whitespace = true
-
-[*.ts]
-quote_type = single
-
-[*.md]
-max_line_length = off
+# Editor configuration, see http://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.ts]
+quote_type = single
+
+[*.md]
+max_line_length = off
 trim_trailing_whitespace = false

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2023 Kirill Suntsov
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2023 Kirill Suntsov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,81 +1,81 @@
-# Yxorp
-This is a simple CLI reverse proxy utility for rewriting or mocking API data. It is in early development and may contain many bugs 😊
-
-## Installation
-```
-npm i -g yxopr
-```
-## Usage
-Just run yxopr in folder which contains yxopr.json
-
-## Config
-Simple yxopr.json example:
-```json
-{
-  "#": "The site that will be proxied"
-  "target": "http://example.com/",
-  "port": 3002,
-  "#": "Makes static path with files in directory",
-  "staticRules": [
-    {
-      "path": "/some-path-on-server",
-      "directory": "./some-path-with-static-files",
-      "disable": false
-    }
-  ],
-  "#": "Scripts may be using for set some data for mock scripts",
-  "scripts": [
-    "./scripts/some-data.js"
-  ],
-  "#": "For matching paths in mockRules and rewriteRules uses https://www.npmjs.com/package/path-to-regex",
-  "#": "This rules uses to modify API data",
-  "mockRules": [
-    {
-      "method": "GET",
-      "path": "/api/example-one(.*)",
-      "script": "./mock/api/example-one.js",
-      "disable": false
-    }, {
-      "method": "GET",
-      "path": "/api/example-two(.*)",
-      "file": "./mock/api/example-two.json",
-      "statusCode": 200,
-      "disable": false
-    }
-  ]
-  "rewriteRules": [
-    {
-      "method": "GET",
-      "path": "/api/example-one(.*)",
-      "script": "./rewrite/api/example-one.js",
-      "disable": false
-    }, {
-      "method": "GET",
-      "path": "/api/example-two(.*)",
-      "file": "./rewrite/api/example-two.json",
-      "statusCode": 200,
-      "disable": false
-    }
-  ]
-}
-```
-
-## Mock script example
-```javascript
-var data = {
-  error: "some error",
-};
-
-res.statusCode = 500;
-res.end(Buffer.from(JSON.stringify(data)));
-```
-
-## Rewrite script example
-```javascript
-const data = JSON.parse(body.toString());
-
-data.modify = 'from js 123';
-
-result = Buffer.from(JSON.stringify(data));
-
-```
+# Yxorp
+This is a simple CLI reverse proxy utility for rewriting or mocking API data. It is in early development and may contain many bugs 😊
+
+## Installation
+```
+npm i -g yxopr
+```
+## Usage
+Just run yxopr in folder which contains yxopr.json
+
+## Config
+Simple yxopr.json example:
+```json
+{
+  "#": "The site that will be proxied"
+  "target": "http://example.com/",
+  "proxyPort": 3002,
+  "#": "Makes static path with files in directory",
+  "staticRules": [
+    {
+      "path": "/some-path-on-server",
+      "directory": "./some-path-with-static-files",
+      "disable": false
+    }
+  ],
+  "#": "Scripts may be using for set some data for mock scripts",
+  "scripts": [
+    "./scripts/some-data.js"
+  ],
+  "#": "For matching paths in mockRules and rewriteRules uses https://www.npmjs.com/package/path-to-regex",
+  "#": "This rules uses to modify API data",
+  "mockRules": [
+    {
+      "method": "GET",
+      "path": "/api/example-one(.*)",
+      "script": "./mock/api/example-one.js",
+      "disable": false
+    }, {
+      "method": "GET",
+      "path": "/api/example-two(.*)",
+      "file": "./mock/api/example-two.json",
+      "statusCode": 200,
+      "disable": false
+    }
+  ]
+  "rewriteRules": [
+    {
+      "method": "GET",
+      "path": "/api/example-one(.*)",
+      "script": "./rewrite/api/example-one.js",
+      "disable": false
+    }, {
+      "method": "GET",
+      "path": "/api/example-two(.*)",
+      "file": "./rewrite/api/example-two.json",
+      "statusCode": 200,
+      "disable": false
+    }
+  ]
+}
+```
+
+## Mock script example
+```javascript
+var data = {
+  error: "some error",
+};
+
+res.statusCode = 500;
+res.end(Buffer.from(JSON.stringify(data)));
+```
+
+## Rewrite script example
+```javascript
+const data = JSON.parse(body.toString());
+
+data.modify = 'from js 123';
+
+result = Buffer.from(JSON.stringify(data));
+
+```

package/bin/yxorp.js

@@ -1,22 +1,22 @@
 #!/usr/bin/env node
-
-var path = require('path');
-var nodemon = require('nodemon');
-var nodemonDefaults = require('nodemon/lib/config/defaults');
-
-var pathToTsNode = path.normalize(__dirname + './../node_modules/.bin/ts-node');
-var filepath = path.normalize(__dirname + './../src/index.ts')
-
-nodemonDefaults.execMap.ts = pathToTsNode;
-
-nodemon({
-  script: filepath,
-  watch: ['yxopr.json']
-});
-
-nodemon.on('quit', function () {
-  console.log('Yxopr has quit');
-  process.exit();
-}).on('restart', function (files) {
-  console.log('Yxopr restarts...');
-});
+
+var path = require('path');
+var nodemon = require('nodemon');
+var nodemonDefaults = require('nodemon/lib/config/defaults');
+
+var pathToTsNode = path.normalize(__dirname + './../node_modules/.bin/ts-node');
+var filepath = path.normalize(__dirname + './../src/index.ts')
+
+nodemonDefaults.execMap.ts = pathToTsNode;
+
+nodemon({
+  script: filepath,
+  watch: ['yxorp.json']
+});
+
+nodemon.on('quit', function () {
+  console.log('Yxopr has quit');
+  process.exit();
+}).on('restart', function (files) {
+  console.log('Yxopr restarts...');
+});

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "yxorp",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Yxorp is a reverse proxy for rewriting or mocking API data.",
   "main": "src/index.ts",
   "bin": {
-    "yxorp": "./bin/yxorp.js"
+    "yxorp": "bin/yxorp.js"
   },
   "scripts": {
     "start": "nodemon src/index.ts"
@@ -20,17 +20,17 @@
     "qs": "^6.11.2",
     "reflect-metadata": "^0.1.13",
     "ts-node": "^10.9.1",
+    "tslib": "^2.6.2",
     "typedi": "^0.10.0",
+    "typescript": "^5.2.2",
+    "winston": "^3.11.0",
     "yargs": "^17.7.2"
   },
   "devDependencies": {
     "@types/http-proxy": "^1.17.11",
     "@types/mime": "^3.0.1",
     "@types/node": "^20.4.9",
-    "@types/qs": "^6.9.8",
-    "tslib": "^2.6.1",
-    "typescript": "^5.1.6",
-    "winston": "^3.10.0"
+    "@types/qs": "^6.9.8"
   },
   "engines": {
     "node": ">= 12"

package/src/index.ts

@@ -1,48 +1,48 @@
-import 'reflect-metadata';
-
-import fs from 'fs';
-import path from 'path';
-import { Container } from 'typedi';
-import { ServerOptions } from 'http-proxy';
-import { YxorpServer } from './services/yxorp-server.service';
-import { ConfigFile } from './types/yxorp-config';
-import { ProxyConfigToken } from './services/config.service';
-
-
-let config: ConfigFile;
-
-try {
-  config = JSON.parse(fs.readFileSync('./yxopr.json').toString()) as ConfigFile;
-} catch(e) {
-  console.error(e);
-  throw 'Can\'t read yxopr.json'
-}
-
-globalThis.require = require;
-
-const proxyOptions: ServerOptions = {
-  target: config.target,
-  changeOrigin: true,
-  followRedirects: true,
-  secure: false,
-  localAddress: '0.0.0.0',
-  ws: true,
-  selfHandleResponse: true,
-};
-
-const proxyConfig = {
-  ...config,
-  proxyOptions,
-}
-
-config?.scripts?.forEach(script => {
-  require(path.join(process.cwd(), script));
-});
-
-Container.set(ProxyConfigToken, proxyConfig);
-
-const server = Container.get(YxorpServer);
-
-server.listen(config.proxyPort, () => {
-  console.log(`Yxorp server started successfully on http://localhost:${config.proxyPort}`);
-});
+import 'reflect-metadata';
+
+import fs from 'fs';
+import path from 'path';
+import { Container } from 'typedi';
+import { ServerOptions } from 'http-proxy';
+import { YxorpServer } from './services/yxorp-server.service';
+import { ConfigFile } from './types/yxorp-config';
+import { ProxyConfigToken } from './services/config.service';
+
+
+let config: ConfigFile;
+
+try {
+  config = JSON.parse(fs.readFileSync('./yxorp.json').toString()) as ConfigFile;
+} catch(e) {
+  console.error(e);
+  throw 'Can\'t read yxorp.json'
+}
+
+globalThis.require = require;
+
+const proxyOptions: ServerOptions = {
+  target: config.target,
+  changeOrigin: true,
+  followRedirects: true,
+  secure: false,
+  localAddress: '0.0.0.0',
+  ws: true,
+  selfHandleResponse: true,
+};
+
+const proxyConfig = {
+  ...config,
+  proxyOptions,
+}
+
+config?.scripts?.forEach(script => {
+  require(path.join(process.cwd(), script));
+});
+
+Container.set(ProxyConfigToken, proxyConfig);
+
+const server = Container.get(YxorpServer);
+
+server.listen(config.proxyPort, () => {
+  console.log(`Yxorp server started successfully on http://localhost:${config.proxyPort}`);
+});

package/src/middleware/bootstrap.middleware.ts

@@ -1,87 +1,87 @@
-import { IncomingMessage } from 'http';
-import { Service } from 'typedi';
-import qs from 'qs';
-import { Middleware } from '../services/pipeline.service';
-import { RewriteRulesMatcher } from '../services/rules-matchers/rewrite-rules-matcher.service';
-import { MockRulesMatcher } from '../services/rules-matchers/mock-rules-matcher.service';
-import { LoggerService } from '../services/logger.service';
-
-
-@Service({
-  global: true
-})
-export class BootstrapMiddleware<T extends any[]> implements Middleware<T> {
-  constructor(
-    private rewriteRulesMatcher: RewriteRulesMatcher,
-    private mockRulesMatcher: MockRulesMatcher,
-    private logger: LoggerService,
-  ) {
-  }
-
-  public use(...args: [...T, () => void]): void {
-    const req: IncomingMessage = args[0] as IncomingMessage;
-    const next: () => void = args[args.length - 1];
-
-    try {
-      this.setRewriteRule(req);
-      this.setMockRule(req);
-      this.setQueryParams(req);
-
-      next();
-    } catch (e) {
-      this.logger.error(e);
-      next();
-    }
-  }
-
-  private setRewriteRule(req: IncomingMessage): void {
-    if (!req.url || !req.method) {
-      return;
-    }
-
-    const rewriteRule = this.rewriteRulesMatcher.match(req.url, req.method);
-
-    if (rewriteRule) {
-      req.rewriteRule = rewriteRule;
-
-      const rewriteRuleParams = this.rewriteRulesMatcher.params(req.url, rewriteRule);
-
-      if (rewriteRuleParams) {
-        req.rewriteRuleParams = rewriteRuleParams || {};
-      }
-    }
-  }
-
-  private setMockRule(req: IncomingMessage): void {
-    if (!req.url || !req.method) {
-      return;
-    }
-
-    const mockRule = this.mockRulesMatcher.match(req.url, req.method);
-
-    if (mockRule) {
-      req.mockRule = mockRule;
-
-      const mockRuleParams = this.mockRulesMatcher.params(req.url, mockRule);
-
-      if (mockRuleParams) {
-        req.mockRuleParams = mockRuleParams || {};
-      }
-    }
-  }
-
-  private setQueryParams(req: IncomingMessage): void {
-    if (!req.url) {
-      return;
-    }
-
-    const url = new URL(req.url, 'http://fake.com');
-    const query = qs.parse(url.search, {
-      ignoreQueryPrefix: true,
-    });
-
-    req.query = query;
-  }
-
-}
-
+import { IncomingMessage } from 'http';
+import { Service } from 'typedi';
+import qs from 'qs';
+import { Middleware } from '../services/pipeline.service';
+import { RewriteRulesMatcher } from '../services/rules-matchers/rewrite-rules-matcher.service';
+import { MockRulesMatcher } from '../services/rules-matchers/mock-rules-matcher.service';
+import { LoggerService } from '../services/logger.service';
+
+
+@Service({
+  global: true
+})
+export class BootstrapMiddleware<T extends any[]> implements Middleware<T> {
+  constructor(
+    private rewriteRulesMatcher: RewriteRulesMatcher,
+    private mockRulesMatcher: MockRulesMatcher,
+    private logger: LoggerService,
+  ) {
+  }
+
+  public use(...args: [...T, () => void]): void {
+    const req: IncomingMessage = args[0] as IncomingMessage;
+    const next: () => void = args[args.length - 1];
+
+    try {
+      this.setRewriteRule(req);
+      this.setMockRule(req);
+      this.setQueryParams(req);
+
+      next();
+    } catch (e) {
+      this.logger.error(e);
+      next();
+    }
+  }
+
+  private setRewriteRule(req: IncomingMessage): void {
+    if (!req.url || !req.method) {
+      return;
+    }
+
+    const rewriteRule = this.rewriteRulesMatcher.match(req.url, req.method);
+
+    if (rewriteRule) {
+      req.rewriteRule = rewriteRule;
+
+      const rewriteRuleParams = this.rewriteRulesMatcher.params(req.url, rewriteRule);
+
+      if (rewriteRuleParams) {
+        req.rewriteRuleParams = rewriteRuleParams || {};
+      }
+    }
+  }
+
+  private setMockRule(req: IncomingMessage): void {
+    if (!req.url || !req.method) {
+      return;
+    }
+
+    const mockRule = this.mockRulesMatcher.match(req.url, req.method);
+
+    if (mockRule) {
+      req.mockRule = mockRule;
+
+      const mockRuleParams = this.mockRulesMatcher.params(req.url, mockRule);
+
+      if (mockRuleParams) {
+        req.mockRuleParams = mockRuleParams || {};
+      }
+    }
+  }
+
+  private setQueryParams(req: IncomingMessage): void {
+    if (!req.url) {
+      return;
+    }
+
+    const url = new URL(req.url, 'http://fake.com');
+    const query = qs.parse(url.search, {
+      ignoreQueryPrefix: true,
+    });
+
+    req.query = query;
+  }
+
+}
+