@vroskus/library-health 1.0.0 → 1.0.2

package/.eslintrc

@@ -0,0 +1,77 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "requireConfigFile": false,
+    "project": ["tsconfig.json"]
+  },
+  "extends": [
+    "airbnb-base",
+    "airbnb-typescript",
+    "plugin:import/recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:sort/recommended"
+  ],
+  "plugins": [
+    "@typescript-eslint",
+    "import",
+    "import-newlines",
+    "react",
+    "sort"
+  ],
+  "rules": {
+    "complexity": ["error", 5],
+    "@typescript-eslint/ban-ts-comment": [1],
+    "@typescript-eslint/no-unused-vars": [2],
+    "curly": ["error", "all"],
+    "import/no-cycle": [0],
+    "no-await-in-loop": 0,
+    "no-console": "error",
+    "no-duplicate-imports": [0],
+    "no-loss-of-precision": [0],
+    "no-restricted-syntax": 0,
+    "no-unreachable-loop": [0],
+    "no-useless-backreference": [0],
+    "no-unused-private-class-members": [2],
+    "padding-line-between-statements": ["error", {
+      "blankLine": "always",
+      "prev": ["const", "let"],
+      "next": "*"
+    }, {
+      "blankLine": "any",
+      "prev": ["const", "let"],
+      "next": ["const", "let"]
+    }, {
+      "blankLine": "always",
+      "prev": ["if", "function", "for"],
+      "next": "*"
+    }, {
+      "blankLine": "always",
+      "prev": "*",
+      "next": "return"
+    }],
+    "object-curly-newline": ["error", {
+      "ObjectExpression": "always",
+      "ObjectPattern": "always",
+      "ImportDeclaration": "always",
+      "ExportDeclaration": "always"
+    }],
+    "function-call-argument-newline": ["error", "always"],
+    "object-property-newline": ["error", {
+      "allowMultiplePropertiesPerLine": false
+    }],
+    "import-newlines/enforce": ["error", {
+      "items": 1,
+      "forceSingleLine": false
+    }],
+    "sort/imports": [0],
+    "sort/exports": [0]
+  },
+  "env": {
+    "browser": true,
+    "node": true,
+    "jest": true,
+    "es6": true
+  }
+}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import type { Request as $Request, Response as $Response } from 'express';
+type $HealthRoute = (req: $Request, res: $Response) => Promise<void>;
+export declare const healthRoute: $HealthRoute;
+export {};

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAQA,4CAAoB;AACpB,kEAAoC;AA6BpC,MAAM,eAAe,GAAqB,GAAS,EAAE;IACnD,MAAM,IAAI,GAAG,MAAM,uBAAO,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IACzC,MAAM,IAAI,GAAG,MAAM,uBAAO,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IACxC,MAAM,GAAG,GAAG,MAAM,uBAAO,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;IACrC,MAAM,MAAM,GAAG;QACb,SAAS,EAAE,OAAO,CAAC,MAAM,EAAE;QAC3B,EAAE,EAAE,YAAE,CAAC,MAAM,EAAE;KAChB,CAAC;IAEF,OAAO;QACL,IAAI;QACJ,IAAI;QACJ,GAAG;QACH,MAAM;KACP,CAAC;AACJ,CAAC,CAAA,CAAC;AAIK,MAAM,WAAW,GAAiB,CAAO,GAAG,EAAE,GAAG,EAAE,EAAE;IAC1D,MAAM,MAAM,GAAG,MAAM,eAAe,EAAE,CAAC;IAEvC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACnB,CAAC,CAAA,CAAC;AAJW,QAAA,WAAW,eAItB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vroskus/library-health",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Health",
   "author": "Vilius Roškus <vilius@regattas.eu>",
   "license": "MIT",
@@ -9,9 +9,6 @@
     "url": "git+https://github.com/vroskus/library-health.git"
   },
   "main": "dist/index.js",
-  "files": [
-    "dist/index.js"
-  ],
   "scripts": {
     "postinstall": "npm run build",
     "build": "tsc",
@@ -24,18 +21,19 @@
     "node-os-utils": "1.3.7"
   },
   "devDependencies": {
+    "@types/express": "4.17.17",
     "@types/jest": "29.5.0",
     "@types/node": "18.15.11",
-    "@typescript-eslint/eslint-plugin": "5.53.0",
-    "@typescript-eslint/parser": "5.53.0",
-    "eslint": "8.34.0",
+    "@typescript-eslint/eslint-plugin": "5.58.0",
+    "@typescript-eslint/parser": "5.58.0",
+    "eslint": "8.38.0",
     "eslint-config-airbnb-base": "15.0.0",
     "eslint-config-airbnb-typescript": "17.0.0",
     "eslint-plugin-import": "2.27.5",
     "eslint-plugin-import-newlines": "1.3.1",
     "eslint-plugin-react": "7.32.2",
-    "eslint-plugin-sort": "2.4.0",
+    "eslint-plugin-sort": "2.7.1",
     "npm-check": "6.0.1",
     "typescript": "4.9.5"
   }
-}
+}

package/src/index.ts

@@ -0,0 +1,62 @@
+/* eslint-disable import/prefer-default-export */
+// Global Types
+import type {
+  Request as $Request,
+  Response as $Response,
+} from 'express';
+
+// Helpers
+import os from 'os';
+import osUtils from 'node-os-utils'; // Types
+
+type $LoadValue = Array<number>;
+type $DiskValue = {
+  freeGb: string;
+  freePercentage: string;
+  totalGb: string;
+  usedGb: string;
+  usedPercentage: string;
+};
+type $MemValue = {
+  freeMemMb: number;
+  freeMemPercentage: number;
+  totalMemMb: number;
+  usedMemMb: number;
+};
+type $UptimeValue = {
+  container: number;
+  os: number;
+};
+type $SystemValues = {
+  disk: $DiskValue;
+  load: $LoadValue;
+  mem: $MemValue;
+  uptime: $UptimeValue;
+};
+
+type $GetSystemValues = () => Promise<$SystemValues>;
+
+const getSystemValues: $GetSystemValues = async () => {
+  const load = await osUtils.cpu.loadavg();
+  const disk = await osUtils.drive.info();
+  const mem = await osUtils.mem.info();
+  const uptime = {
+    container: process.uptime(),
+    os: os.uptime(),
+  };
+
+  return {
+    disk,
+    load,
+    mem,
+    uptime,
+  };
+};
+
+type $HealthRoute = (req: $Request, res: $Response) => Promise<void>;
+
+export const healthRoute: $HealthRoute = async (req, res) => {
+  const output = await getSystemValues();
+
+  res.json(output);
+};

package/tsconfig.json

@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "outDir": "./dist/",
+    "types": ["node", "jest"],
+    "module": "commonjs",
+    "esModuleInterop": true,
+    "declaration": true,
+    "noImplicitAny": false,
+    "removeComments": true,
+    "noLib": false,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "target": "es6",
+    "sourceMap": true,
+    "lib": [
+      "es6"
+    ]
+  },
+  "exclude": [
+    "node_modules",
+    "./dist/**/*"
+  ],
+   "include": [
+    "./src"
+  ]
+}