itrm-tools 1.0.0 → 1.0.1

package/README.md

@@ -1,2 +1,2 @@
 # itrm-tools
-Library developed by Intelligent Trading Machines for building robust APIs
+Library design for developing API Services

package/dist/api/APIService.d.ts

@@ -1,13 +1,16 @@
 import { Express } from 'express';
 import { APIRequest } from './APIRequest';
+import { ExpressConfiguration } from './ExpressConfiguration';
 export declare namespace ITRMAPIServiceGlobal {
     var memory: any;
     var service: APIService | undefined;
     var requests: any;
+    var whitelist: string[];
 }
 export interface APIServiceConfig {
     name: string;
     port: string | number;
+    express: ExpressConfiguration;
 }
 export interface APIServiceResponse {
     status: string;
@@ -15,9 +18,11 @@ export interface APIServiceResponse {
     error?: any;
 }
 export declare class APIService {
-    protected config: APIServiceConfig;
     protected server: any;
     protected app: Express;
+    protected name: string;
+    protected port: number | string;
+    protected config: ExpressConfiguration;
     constructor(config: APIServiceConfig);
     init(): void;
     addRequest(request: APIRequest): Promise<void>;

package/dist/api/APIService.js

@@ -19,17 +19,19 @@ var ITRMAPIServiceGlobal;
     ITRMAPIServiceGlobal.memory = {};
     ITRMAPIServiceGlobal.service = undefined;
     ITRMAPIServiceGlobal.requests = {};
+    ITRMAPIServiceGlobal.whitelist = [];
 })(ITRMAPIServiceGlobal = exports.ITRMAPIServiceGlobal || (exports.ITRMAPIServiceGlobal = {}));
 class APIService {
     constructor(config) {
         this.server = undefined;
         this.app = (0, express_1.default)();
-        this.config = config;
-        this.init();
+        this.name = config.name;
+        this.port = config.port;
+        this.config = config.express;
     }
     init() {
         ITRMAPIServiceGlobal.service = this;
-        this.app.use(express_1.default.json());
+        this.config.apply(this.app);
         this.app.get('/', (req, res) => {
             return res.send('Server working!');
         });
@@ -42,8 +44,8 @@ class APIService {
     }
     run(init) {
         return new Promise((resolve, reject) => {
-            this.server = this.app.listen(this.config.port, () => __awaiter(this, void 0, void 0, function* () {
-                console.log(`⚡️[server]: Server is running at http://localhost:${this.config.port}`);
+            this.server = this.app.listen(this.port, () => __awaiter(this, void 0, void 0, function* () {
+                console.log(`⚡️[server]: Server is running at http://localhost:${this.port}`);
                 try {
                     yield init();
                     resolve({ status: 'Ok', message: 'Server has been Initialized' });

package/dist/api/APIService.js.map

@@ -1 +1 @@
-{"version":3,"file":"APIService.js","sourceRoot":"","sources":["../../src/api/APIService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,sDAA8D;AAG9D,IAAiB,oBAAoB,CAIpC;AAJD,WAAiB,oBAAoB;IACtB,2BAAM,GAAQ,EAAE,CAAC;IACjB,4BAAO,GAA2B,SAAS,CAAC;IAC5C,6BAAQ,GAAQ,EAAE,CAAC;AAClC,CAAC,EAJgB,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAIpC;AAaD,MAAa,UAAU;IAKnB,YAAY,MAAwB;QAH1B,WAAM,GAAQ,SAAS,CAAC;QACxB,QAAG,GAAY,IAAA,iBAAO,GAAE,CAAC;QAG/B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,EAAE,CAAC;IAChB,CAAC;IAEM,IAAI;QACP,oBAAoB,CAAC,OAAO,GAAG,IAAI,CAAC;QACpC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,iBAAO,CAAC,IAAI,EAAE,CAAC,CAAC;QAC7B,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAY,EAAE,GAAa,EAAE,EAAE;YAC9C,OAAO,GAAG,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;IACP,CAAC;IAEY,UAAU,CAAC,OAAmB;;YACvC,oBAAoB,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,GAAG,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC;YAC7E,MAAM,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACjC,CAAC;KAAA;IAEM,GAAG,CAAC,IAAc;QACrB,OAAO,IAAI,OAAO,CAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACvD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,GAAS,EAAE;gBACvD,OAAO,CAAC,GAAG,CAAC,qDAAqD,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;gBACrF,IAAI;oBACA,MAAM,IAAI,EAAE,CAAC;oBACb,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,6BAA6B,EAAE,CAAC,CAAC;iBACrE;gBAAC,OAAO,GAAQ,EAAE;oBACf,MAAM,CAAC;wBACH,MAAM,EAAE,OAAO;wBACf,OAAO,EAAE,qDAAqD;wBAC9D,KAAK,EAAE,GAAG;qBACb,CAAC,CAAC;iBACN;YACL,CAAC,CAAA,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;IAEM,KAAK,CAAC,MAAgB;QACzB,OAAO,IAAI,OAAO,CAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACvD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAO,GAAQ,EAAE,EAAE;gBACjC,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;gBAChC,IAAI,GAAG;oBACH,MAAM,CAAC;wBACH,MAAM,EAAE,OAAO;wBACf,OAAO,EAAE,0CAA0C;wBACnD,KAAK,EAAE,GAAG;qBACb,CAAC,CAAC;gBACP,IAAI;oBACA,MAAM,MAAM,EAAE,CAAC;oBACf,OAAO,CAAC;wBACJ,MAAM,EAAE,IAAI;wBACZ,OAAO,EAAE,wBAAwB;qBACpC,CAAC,CAAC;iBACN;gBAAC,OAAM,GAAQ,EAAE;oBACd,MAAM,CAAC;wBACH,MAAM,EAAE,OAAO;wBACf,OAAO,EAAE,8CAA8C;wBACvD,KAAK,EAAE,GAAG;qBACb,CAAC,CAAC;iBACN;gBACD,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;YACnC,CAAC,CAAA,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AApED,gCAoEC"}
+{"version":3,"file":"APIService.js","sourceRoot":"","sources":["../../src/api/APIService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,sDAA8D;AAI9D,IAAiB,oBAAoB,CAKpC;AALD,WAAiB,oBAAoB;IACtB,2BAAM,GAAQ,EAAE,CAAC;IACjB,4BAAO,GAA2B,SAAS,CAAC;IAC5C,6BAAQ,GAAQ,EAAE,CAAC;IACnB,8BAAS,GAAa,EAAE,CAAC;AACxC,CAAC,EALgB,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAKpC;AAcD,MAAa,UAAU;IAOnB,YAAY,MAAwB;QAN1B,WAAM,GAAQ,SAAS,CAAC;QACxB,QAAG,GAAY,IAAA,iBAAO,GAAE,CAAC;QAM/B,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC;IACjC,CAAC;IAEM,IAAI;QACP,oBAAoB,CAAC,OAAO,GAAG,IAAI,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC5B,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAY,EAAE,GAAa,EAAE,EAAE;YAC9C,OAAO,GAAG,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;IACP,CAAC;IAEY,UAAU,CAAC,OAAmB;;YACvC,oBAAoB,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,GAAG,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC;YAC7E,MAAM,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACjC,CAAC;KAAA;IAEM,GAAG,CAAC,IAAc;QACrB,OAAO,IAAI,OAAO,CAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACvD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,GAAS,EAAE;gBAChD,OAAO,CAAC,GAAG,CAAC,qDAAqD,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;gBAC9E,IAAI;oBACA,MAAM,IAAI,EAAE,CAAC;oBACb,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,6BAA6B,EAAE,CAAC,CAAC;iBACrE;gBAAC,OAAO,GAAQ,EAAE;oBACf,MAAM,CAAC;wBACH,MAAM,EAAE,OAAO;wBACf,OAAO,EAAE,qDAAqD;wBAC9D,KAAK,EAAE,GAAG;qBACb,CAAC,CAAC;iBACN;YACL,CAAC,CAAA,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;IAEM,KAAK,CAAC,MAAgB;QACzB,OAAO,IAAI,OAAO,CAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACvD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAO,GAAQ,EAAE,EAAE;gBACjC,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;gBAChC,IAAI,GAAG;oBACH,MAAM,CAAC;wBACH,MAAM,EAAE,OAAO;wBACf,OAAO,EAAE,0CAA0C;wBACnD,KAAK,EAAE,GAAG;qBACb,CAAC,CAAC;gBACP,IAAI;oBACA,MAAM,MAAM,EAAE,CAAC;oBACf,OAAO,CAAC;wBACJ,MAAM,EAAE,IAAI;wBACZ,OAAO,EAAE,wBAAwB;qBACpC,CAAC,CAAC;iBACN;gBAAC,OAAM,GAAQ,EAAE;oBACd,MAAM,CAAC;wBACH,MAAM,EAAE,OAAO;wBACf,OAAO,EAAE,8CAA8C;wBACvD,KAAK,EAAE,GAAG;qBACb,CAAC,CAAC;iBACN;gBACD,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;YACnC,CAAC,CAAA,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AAvED,gCAuEC"}

package/dist/api/ExpressConfiguration.d.ts

@@ -0,0 +1,4 @@
+import { Express } from 'express';
+export interface ExpressConfiguration {
+    apply(app: Express): void;
+}

package/dist/api/{APIChecker.js → ExpressConfiguration.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=APIChecker.js.map
+//# sourceMappingURL=ExpressConfiguration.js.map

package/dist/api/ExpressConfiguration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExpressConfiguration.js","sourceRoot":"","sources":["../../src/api/ExpressConfiguration.ts"],"names":[],"mappings":""}

package/dist/api/express/ExpressStandardConfiguration.d.ts

@@ -0,0 +1,5 @@
+import { Express } from "express";
+import { ExpressConfiguration } from "../ExpressConfiguration";
+export declare class ExpressStandardConfiguration implements ExpressConfiguration {
+    apply(app: Express): void;
+}

package/dist/api/express/ExpressStandardConfiguration.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExpressStandardConfiguration = void 0;
+const cors_1 = __importDefault(require("cors"));
+const body_parser_1 = __importDefault(require("body-parser"));
+const APIService_1 = require("../APIService");
+class ExpressStandardConfiguration {
+    apply(app) {
+        app.use((0, cors_1.default)({
+            origin: function (origin, callback) {
+                let whitelist = APIService_1.ITRMAPIServiceGlobal.whitelist;
+                if (whitelist.length == 0 || (origin && whitelist.indexOf(origin) !== -1))
+                    callback(null, true);
+                else
+                    callback(new Error('Not allowed by CORS'), false);
+            }
+        }));
+        app.use(body_parser_1.default.json({ limit: '50mb' }));
+        app.use(body_parser_1.default.urlencoded({ limit: '50mb', extended: true }));
+    }
+}
+exports.ExpressStandardConfiguration = ExpressStandardConfiguration;
+//# sourceMappingURL=ExpressStandardConfiguration.js.map

package/dist/api/express/ExpressStandardConfiguration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExpressStandardConfiguration.js","sourceRoot":"","sources":["../../../src/api/express/ExpressStandardConfiguration.ts"],"names":[],"mappings":";;;;;;AACA,gDAAwB;AACxB,8DAAqC;AAErC,8CAAqD;AAErD,MAAa,4BAA4B;IAC9B,KAAK,CAAC,GAAY;QACrB,GAAG,CAAC,GAAG,CAAC,IAAA,cAAI,EAAC;YACT,MAAM,EAAE,UAAU,MAAM,EAAE,QAAQ;gBAC9B,IAAI,SAAS,GAAG,iCAAoB,CAAC,SAAS,CAAC;gBAC/C,IAAI,SAAS,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;oBACrE,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;;oBAErB,QAAQ,CAAC,IAAI,KAAK,CAAC,qBAAqB,CAAC,EAAE,KAAK,CAAC,CAAC;YAC1D,CAAC;SACJ,CAAC,CAAC,CAAC;QACJ,GAAG,CAAC,GAAG,CAAC,qBAAU,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;QAC5C,GAAG,CAAC,GAAG,CAAC,qBAAU,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACtE,CAAC;CACJ;AAdD,oEAcC"}

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-export { APIChecker as APIChecker } from './api/APIChecker';
+export { ExpressConfiguration as ExpressConfiguration } from './api/ExpressConfiguration';
+export { ExpressStandardConfiguration as ExpressStandardConfiguration } from './api/express/ExpressStandardConfiguration';
 export { APIRequest as APIRequest, RequestMethod as RequestMethod, RequestContext as RequestContext, GroupedParameters as GroupedParameters, APIRequestConfig as APIRequestConfig } from './api/APIRequest';
 export { APIServiceConfig as APIServiceConfig, APIService as APIService, APIServiceResponse as APIServiceResponse } from './api/APIService';
 export { GetRequest as GetRequest } from './api/request/GetRequest';

package/dist/index.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DeleteRequest = exports.PutRequest = exports.PostRequest = exports.GetRequest = exports.APIService = exports.RequestContext = exports.RequestMethod = exports.APIRequest = void 0;
+exports.DeleteRequest = exports.PutRequest = exports.PostRequest = exports.GetRequest = exports.APIService = exports.RequestContext = exports.RequestMethod = exports.APIRequest = exports.ExpressStandardConfiguration = void 0;
+var ExpressStandardConfiguration_1 = require("./api/express/ExpressStandardConfiguration");
+Object.defineProperty(exports, "ExpressStandardConfiguration", { enumerable: true, get: function () { return ExpressStandardConfiguration_1.ExpressStandardConfiguration; } });
 var APIRequest_1 = require("./api/APIRequest");
 Object.defineProperty(exports, "APIRequest", { enumerable: true, get: function () { return APIRequest_1.APIRequest; } });
 Object.defineProperty(exports, "RequestMethod", { enumerable: true, get: function () { return APIRequest_1.RequestMethod; } });

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AACA,+CAA4M;AAAnM,wGAAA,UAAU,OAAc;AAAE,2GAAA,aAAa,OAAiB;AAAE,4GAAA,cAAc,OAAkB;AACnG,+CAA4I;AAA7F,wGAAA,UAAU,OAAc;AACvE,uDAAoE;AAA3D,wGAAA,UAAU,OAAc;AACjC,yDAAuE;AAA9D,0GAAA,WAAW,OAAe;AACnC,uDAAoE;AAA3D,wGAAA,UAAU,OAAc;AACjC,6DAA6E;AAApE,8GAAA,aAAa,OAAiB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AACA,2FAA0H;AAAjH,4IAAA,4BAA4B,OAAgC;AACrE,+CAA4M;AAAnM,wGAAA,UAAU,OAAc;AAAE,2GAAA,aAAa,OAAiB;AAAE,4GAAA,cAAc,OAAkB;AACnG,+CAA4I;AAA7F,wGAAA,UAAU,OAAc;AACvE,uDAAoE;AAA3D,wGAAA,UAAU,OAAc;AACjC,yDAAuE;AAA9D,0GAAA,WAAW,OAAe;AACnC,uDAAoE;AAA3D,wGAAA,UAAU,OAAc;AACjC,6DAA6E;AAApE,8GAAA,aAAa,OAAiB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "itrm-tools",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -17,16 +17,17 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/itrm-team/itrm-tools.git"
+    "url": "git+https://github.com/ITRMachines/itrm-tools.git"
   },
   "keywords": [],
   "author": "",
   "license": "ISC",
   "bugs": {
-    "url": "https://github.com/itrm-team/itrm-tools/issues"
+    "url": "https://github.com/ITRMachines/itrm-tools/issues"
   },
-  "homepage": "https://github.com/itrm-team/itrm-tools#readme",
+  "homepage": "https://github.com/ITRMachines/itrm-tools#readme",
   "devDependencies": {
+    "@types/cors": "^2.8.13",
     "@types/jest": "^29.2.5",
     "jest": "^29.3.1",
     "ts-jest": "^29.0.3"
@@ -35,6 +36,7 @@
     "@types/express": "^4.17.15",
     "@types/node": "^18.11.18",
     "axios": "^1.2.2",
+    "body-parser": "^1.20.1",
     "cors": "^2.8.5",
     "express": "^4.18.2",
     "rimraf": "^3.0.2",

package/dist/api/APIChecker.d.ts

@@ -1,3 +0,0 @@
-export interface APIChecker {
-    initialize(): PromiseLike<any>;
-}

package/dist/api/APIChecker.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"APIChecker.js","sourceRoot":"","sources":["../../src/api/APIChecker.ts"],"names":[],"mappings":""}