Initial commit

Adaptation of MySQL connector for Postgres

Author: AgustinSRG

.dockerignore

@@ -0,0 +1,3 @@
+node_modules
+dist
+temp

.eslintrc.js

@@ -0,0 +1,34 @@
+module.exports = {
+  root: true,
+  parser: '@typescript-eslint/parser',
+  plugins: [
+    '@typescript-eslint',
+  ],
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+  ],
+  "rules": {
+      "@typescript-eslint/no-var-requires": 0,
+      "@typescript-eslint/explicit-module-boundary-types": 0,
+      "no-console": 0,
+      "no-async-promise-executor": 0,
+      "only-arrow-functions": 0,
+      "interface-name": 0,
+      "no-empty": 0,
+      "max-line-length": 0,
+      "max-classes-per-file": 0,
+      "eqeqeq": 2,
+      "indent": ["error", 4],
+      "no-var-requires": 0,
+      "@typescript-eslint/explicit-function-return-type": 0,
+      "@typescript-eslint/no-explicit-any": 0,
+      "@typescript-eslint/no-empty-function": 0,
+      "@typescript-eslint/camelcase": 0,
+      "object-literal-sort-keys": 0,
+      "no-useless-escape": 0,
+      "@typescript-eslint/no-unused-vars": 0,
+      "@typescript-eslint/no-use-before-define": 0,
+  },
+};

.gitattributes

@@ -0,0 +1,4 @@
+# Text files configuration
+
+* text eol=lf
+

.gitignore

@@ -0,0 +1,17 @@
+# .gitignore file
+
+# Ignore downloaded dependencies
+
+node_modules
+
+# Ignore compiled files
+
+dist
+
+# Ignore temp files
+
+temp
+
+# Ignore .env
+
+.env

Dockerfile

@@ -0,0 +1,36 @@
+FROM node:alpine
+
+RUN mkdir /app
+
+WORKDIR /app
+
+# Install dependencies
+
+ADD package.json /app/package.json
+ADD package-lock.json /app/package-lock.json
+
+RUN npm install
+
+# Add source files
+
+ADD src /app/src 
+
+# Build
+
+ADD .eslintrc.js /app/.eslintrc.js
+ADD tsconfig.json /app/tsconfig.json
+
+RUN npm run build
+
+# Remove dev dependencies
+
+RUN npm prune --production
+
+# Expose ports
+
+EXPOSE 80
+EXPOSE 443
+
+# Entry point
+
+CMD ["npm", "start"]

README.md

@@ -0,0 +1,74 @@
+# Deep Intelligence External source: PostgreSQL + MQTT
+
+This is an external source manager based on PostgreSQL for data storage and MQTT for real-time data fetching.
+
+## Installation
+
+Install depedendencies
+
+```
+$ npm install
+```
+
+Requirements:
+
+ - Node JS
+
+To build the project type:
+
+```
+$ npm run build
+```
+
+To run the server type:
+
+```
+$ npm start
+```
+
+## Configuration
+
+In order to configure this module, you have to set the following environment variables:
+
+| Variable Name | Description |
+|---|---|
+| HTTP_PORT | HTTP listening port. Default is `80` |
+| SSL_PORT | HTTPS listening port. Default is `443` |
+| SSL_CERT | Path to SSL certificate. Required for HTTPS to work |
+| SSL_KEY | Path to SSL private key. Required for HTTPS to work |
+| LOG_MODE | Log Mode. values: DEFAULT, SILENT, DEBUG |
+| API_DOCS | Set it to `YES` to generate Swagger api documentation in the `/api-docs/` path. |
+| DEEPINT_API_URL | Deep Intelligence API URL, by default is `https://app.deepint.net/api/v1/` |
+
+In order to configure the source, set the following variables:
+
+| Variable Name | Description |
+|---|---|
+| PG_HOST | Postgre host |
+| PG_PORT | Postgre port. Default: `5432` |
+| PG_USER | Postgre username. |
+| PG_PASSWORD | Postgre password. |
+| PG_DB_NAME | Postgre database name. |
+| PG_MAX_CONNECTIONS | Max connections in the Postgre connection pool. |
+| TABLE_MAPPING_FILE | Path to the tables mapping file. Explained below. |
+
+In order to configure the table mapping rules, create a JSON file and set its path into the `TABLE_MAPPING_FILE` variable.
+
+The tables mapping file contains an array with the following structure:
+
+```json
+[
+    {
+        "table": "Table of the PostgreSQL table",
+
+        "publicKey": "Public Key for the source (An unique identifier)",
+        "secretKey": "Private Key to access the API for this source (A random string)",
+
+        "fields": [
+            "name": "Feature name. Name of the field in the database",
+            "type": "Feature type. Can be: NOMINAL, NUMERIC, LOGIC, DATE or TEXT"
+        ],
+    }
+]
+```
+