picker-db 3.4.0

package/.editorconfig

@@ -0,0 +1,8 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

package/.eslintignore

@@ -0,0 +1,9 @@
+# /node_modules/* and /bower_components/* in the project root are ignored by default
+# Ignore built files except build/index.js
+
+build/*
+!build/index.js
+dist/*
+bundle.js
+.*/*
+.*

package/.eslintrc.json

@@ -0,0 +1,35 @@
+{
+    "extends": [
+      "standard"
+    ],
+    "parserOptions": {
+      "ecmaVersion": 2018
+    },
+    "env": {
+      "es6": true,
+      "node": true,
+      "mocha": true
+    },
+    "parser": "babel-eslint",
+    "rules": {
+      "no-console": "warn",
+      "no-use-before-define": "warn",
+      "spaced-comment": "warn",
+      "comma-dangle": [
+        "error",
+        {
+          "arrays": "always-multiline",
+          "objects": "always-multiline",
+          "imports": "always-multiline",
+          "exports": "always-multiline",
+          "functions": "always-multiline"
+        }
+      ],
+      "quotes": ["error", "double"],
+      "semi": ["error", "always"],
+      "capitalized-comments": ["error", "always"],
+      "no-var": "error",
+      "prefer-const": "error"
+    }
+  }
+  

package/.nvmrc

@@ -0,0 +1 @@
+v16.13.1

package/.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+    "eslint.codeAction.showDocumentation": {
+      "enable": true
+    },
+    "editor.formatOnSave": false,
+    "editor.codeActionsOnSave": {
+      "source.fixAll.eslint": true
+    },
+    "eslint.alwaysShowStatus": true,
+  }
+  

package/README.md

@@ -0,0 +1,21 @@
+# picker-db
+
+[![npm version](https://img.shields.io/npm/v/picker-db.svg)](https://www.npmjs.com/package/picker-db)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+`picker-db` is a JavaScript library that provides models and schemas for connecting to various Picker databases. It enables code reuse across microservices by providing a common interface and reusable components for database interactions.
+
+## Installation
+
+```shell
+npm install picker-db
+```
+
+## Features
+
+* Common database models and schemas for Picker databases.
+* Simplified API for connecting to and interacting with databases.
+* Promotes code reuse and consistency across microservices.
+
+## Contributing
+Contributions are welcome! Please see the contribution guidelines for more information.

package/bitbucket-pipelines.yml

@@ -0,0 +1,24 @@
+#  Template NodeJS build
+
+#  This template allows you to validate your NodeJS code.
+#  The workflow allows running tests and code linting on the default branch.
+
+image: node:16.13.1
+
+pipelines:
+  pull-requests:
+    '**':
+      - step:
+          name: Install
+          caches:
+            - node
+          script:
+            - npm install
+  tags:
+    'v*':
+      - step:
+          name: NPM publish
+          script:
+            - pipe: atlassian/npm-publish:0.3.3
+              variables:
+                NPM_TOKEN: $NPM_TOKEN

package/constants.js

@@ -0,0 +1,420 @@
+module.exports = {
+  MONGO_DB: {
+    RECONNECT_INTERVAL: 500,
+    RECONECT_TRIES: Number.MAX_VALUE,
+    USE_MONGO_CLIENT: true,
+  },
+  VEHICLE_TYPES: {
+    LITE: {
+      INDEX: 0,
+      TEXT: "LITE",
+    },
+    BIKE: {
+      INDEX: 1,
+      TEXT: "BIKE",
+    },
+    NONE: {
+      INDEX: 2,
+      TEXT: "NONE",
+    },
+    BOTH: {
+      INDEX: 3,
+      TEXT: "BOTH",
+    },
+  },
+  PAYMENT_METHODS: {
+    BOTH: {
+      INDEX: 0,
+      TEXT: "BOTH",
+    },
+    CARD: {
+      INDEX: 1,
+      TEXT: "CARD",
+    },
+    CASH: {
+      INDEX: 2,
+      TEXT: "CASH",
+    },
+    NONE: {
+      INDEX: 3,
+      TEXT: "NONE",
+    },
+    BILLING_CARD: {
+      INDEX: 4,
+      TEXT: "BILLING_CARD",
+    },
+    BILLING_TRANSFER: {
+      INDEX: 5,
+      TEXT: "BILLING_TRANSFER",
+    },
+  },
+  BOOKING_TYPES: {
+    PICKUP_AND_DELIVER: {
+      INDEX: 0,
+      TEXT: "PICKUP_AND_DELIVER",
+    },
+    BUY_AND_DELIVER: {
+      INDEX: 1,
+      TEXT: "BUY_AND_DELIVER",
+    },
+    MARKETPLACE: {
+      INDEX: 2,
+      TEXT: "MARKETPLACE",
+    },
+    SHOP_ORDER: {
+      INDEX: 3,
+      TEXT: "SHOP_ORDER",
+    },
+    CORPORATE: {
+      INDEX: 4,
+      TEXT: "CORPORATE",
+    },
+    WHITE_LABEL: {
+      INDEX: 5,
+      TEXT: "WHITE_LABEL",
+    },
+    MASS_DELIVERY: {
+      INDEX: 6,
+      TEXT: "MASS_DELIVERY",
+    },
+  },
+  BOOKING_STATUS: {
+    PENDING: {
+      INDEX: 0,
+      TEXT: "PENDING",
+    },
+    ACCEPTED: {
+      INDEX: 1,
+      TEXT: "ACCEPTED",
+    },
+    ARRIVED_AT_PICKUP: {
+      INDEX: 2,
+      TEXT: "ARRIVED_AT_PICKUP",
+    },
+    AMOUNT_REQUESTED: {
+      INDEX: 0,
+      TEXT: "AMOUNT_REQUESTED",
+    },
+    AMOUNT_ACCEPTED: {
+      INDEX: 1,
+      TEXT: "AMOUNT_ACCEPTED",
+    },
+    AMOUNT_REJECTED: {
+      INDEX: 2,
+      TEXT: "AMOUNT_REJECTED",
+    },
+    WAY_TO_DELIVER: {
+      INDEX: 3,
+      TEXT: "WAY_TO_DELIVER",
+    },
+    ARRIVED_AT_DELIVERY: {
+      INDEX: 4,
+      TEXT: "ARRIVED_AT_DELIVERY",
+    },
+    COMPLETED: {
+      INDEX: 5,
+      TEXT: "COMPLETED",
+    },
+    CANCELLED_BY_ADMIN: {
+      INDEX: 6,
+      TEXT: "CANCELLED_BY_ADMIN",
+    },
+    CANCELLED: {
+      INDEX: 7,
+      TEXT: "CANCELLED",
+    },
+    CANCELLED_BY_DRIVER: {
+      INDEX: 8,
+      TEXT: "CANCELLED_BY_DRIVER",
+    },
+    REJECTED_BY_DRIVER: {
+      INDEX: 9,
+      TEXT: "REJECTED_BY_DRIVER",
+    },
+    CANCELLED_REQUEST: {
+      INDEX: 10,
+      TEXT: "CANCELLED_REQUEST",
+    },
+    NOT_DELIVERED: {
+      INDEX: 11,
+      TEXT: "NOT_DELIVERED",
+    },
+    NOT_FOUND: {
+      INDEX: 12,
+      TEXT: "DRIVER_NOT_FOUND",
+    },
+    NO_PICKERS_IN_AREA: {
+      INDEX: 13,
+      TEXT: "NO_PICKERS_IN_AREA",
+    },
+    EXPIRED: {
+      INDEX: 14,
+      TEXT: "EXPIRED",
+    },
+    ADMIN_NOTIFICATION: {
+      INDEX: 15,
+      TEXT: "ADMIN_NOTIFICATION",
+    },
+    CANCEL_BOOKING: {
+      INDEX: 16,
+      TEXT: "CANCEL_BOOKING",
+    },
+    RE_ASSIGN_DRIVER: {
+      INDEX: 17,
+      TEXT: "RE_ASSIGN_DRIVER",
+    },
+    RE_ASSIGN_BOOKING: {
+      INDEX: 18,
+      TEXT: "RE_ASSIGN_BOOKING",
+    },
+    OUT_OF_REGIONS: {
+      INDEX: 19,
+      TEXT: "OUT_OF_REGIONS",
+    },
+    ON_HOLD: {
+      INDEX: 20,
+      TEXT: "ON_HOLD",
+    },
+    ON_DECK: {
+      INDEX: 21,
+      TEXT: "ON_DECK",
+    },
+    READY_FOR_PICKUP: {
+      INDEX: 22,
+      TEXT: "READY_FOR_PICKUP",
+    },
+    CANCELLED_BY_BUSINESS: {
+      INDEX: 23,
+      TEXT: "CANCELLED_BY_BUSINESS",
+    },
+    BUSINESS_NOT_FOUND: {
+      INDEX: 24,
+      TEXT: "BUSINESS_NOT_FOUND",
+    },
+    NOT_SHOW: {
+      INDEX: 25,
+      TEXT: "NOT_SHOW",
+    },
+    REJECTED_BY_BUSINESS: {
+      INDEX: 27,
+      TEXT: "REJECTED_BY_BUSINESS",
+    },
+    REJECTED_BY_ADMIN: {
+      INDEX: 28,
+      TEXT: "REJECTED_BY_ADMIN",
+    },
+    PAYMENT_FAILED: {
+      INDEX: 29,
+      TEXT: "PAYMENT_FAILED",
+    },
+    CANCELLED_BY_DELIVERY_PROVIDER: {
+      INDEX: 30,
+      TEXT: "CANCELLED_BY_DELIVERY_PROVIDER",
+    },
+    PROVIDER_NOT_FOUND: {
+      INDEX: 31,
+      TEXT: "PROVIDER_NOT_FOUND",
+    },
+    RETURNING: {
+      index: 32,
+      text: "RETURNING",
+    },
+    RETURNED: {
+      index: 33,
+      text: "RETURNED",
+    },
+    RETURNED_TO_PICKUP: {
+      INDEX: 34,
+      TEXT: "RETURNED_TO_PICKUP",
+    },
+  },
+  SOCIAL_ACCOUNTS: {
+    FACEBOOK: "facebook",
+    GOOGLE: "google",
+    APPLE: "apple",
+  },
+  API_USER: {
+    BILLING_METHOD: {
+      CARD: "BILLING_CARD",
+      TRANSFER: "BILLING_TRANSFER",
+    },
+  },
+  USER: {
+    DEVICE_TYPES: {
+      IOS: "IOS",
+      ANDROID: "ANDROID",
+      WEB: "WEB",
+    },
+  },
+  BUSINESS: {
+    TYPES: {
+      MARKETPLACE: "MARKETPLACE",
+      SHOP_ORDER: "SHOP_ORDER",
+      EXTERNAL: "EXTERNAL",
+    },
+  },
+  DRIVER: {
+    PAYMENT: {
+      PERCENTAGE: "PERCENTAGE",
+      ABSOLUTE: "ABSOLUTE",
+      OVER_MINIMUM: "OVER_MINIMUM",
+      PERCENTAGE_MINIMUM: "PERCENTAGE_MINIMUM",
+      ABSOLUTE_MINIMUM: "ABSOLUTE_MINIMUM",
+    },
+    TYPE: {
+      STARTER: "STARTER",
+      SENIOR: "SENIOR",
+      MCGYVER: "MCGYVER",
+      PREMIUM: "PREMIUM",
+    },
+    ACCOUNTING_TYPE: {
+      OLD: "OLD",
+      NEW: "NEW",
+    },
+  },
+  NOTIFICATION: {
+    VIA: {
+      SMS: "SMS",
+      EMAIL: "EMAIL",
+      PUSH: "PUSH",
+      WHATSAPP: "WHATSAPP",
+    },
+    PROVIDERS: {
+      FCM: "FCM",
+      APNS: "APNS",
+      TWILIO: "TWILIO",
+      NODEMAILER: "NODEMAILER",
+      AWS_SES: "AWS_SES",
+    },
+  },
+  TRANSACTION: {
+    TYPE: {
+      BONUS: "BONUS",
+      PENALTY: "PENALTY",
+      RESIDUE: "RESIDUE",
+      DELIVERY: "DELIVERY",
+      ITEM: "ITEM",
+      DEPOSIT: "DEPOSIT",
+      PAYMENT: "PAYMENT",
+      BILL: "BILL",
+      BALANCE_ADJUSTMENT: "BALANCE_ADJUSTMENT",
+      ADVANCE_PAYMENT: "ADVANCE_PAYMENT",
+      ALL: "ALL",
+      MARKETPLACE: "MARKETPLACE",
+      RECHARGE: "RECHARGE",
+      RECHARGE_EARNINGS: "RECHARGE_EARNINGS",
+      RECHARGE_CARD: "RECHARGE_CARD",
+      RECHARGE_BANK: "RECHARGE_BANK",
+      CORPORATE: "CORPORATE",
+      CORPORATE_PAYMENT: "CORPORATE_PAYMENT",
+      MARKETPLACE_PAYMENT: "MARKETPLACE_PAYMENT",
+      ITEM_REFUND: "ITEM_REFUND",
+      DELIVERY_REFUND: "DELIVERY_REFUND",
+    },
+    STATUS: {
+      REALIZED: "REALIZED",
+      APPROVED: "APPROVED",
+      PAID: "PAID",
+      FAILED: "FAILED",
+    },
+    SELECTED_REASONS: {
+      MANUAL_BOOKING: "MANUAL_BOOKING",
+      PAYMENT_ERROR: "PAYMENT_ERROR",
+      SPECIAL_BOOKING: "SPECIAL_BOOKING",
+      BAD_ORDER_CHARGE: "BAD_ORDER_CHARGE",
+      FRAUD: "FRAUD",
+      THEFT: "THEFT",
+      BAD_SERVICE: "BAD_SERVICE",
+    },
+  },
+  RIDE_TYPES: {
+    NOW: {
+      INDEX: 1,
+      TEXT: "RIDE NOW",
+    },
+    LATER: {
+      INDEX: 2,
+      TEXT: "RIDE LATER",
+    },
+    BOTH: {
+      INDEX: 3,
+      TEXT: "BOTH",
+    },
+  },
+  ADDRESS_TYPES: {
+    SELF: "SELF",
+    PICKUP: "PICKUP",
+    DELIVERY: "DELIVERY",
+    HOME: "HOME",
+    OFFICE: "OFFICE",
+    OTHERS: "OTHERS",
+  },
+  MASS_DELIVERY: {
+    STATUSES: {
+      PENDING: {
+        INDEX: 0,
+        TEXT: "PENDING",
+      },
+      ONGOING: {
+        INDEX: 1,
+        TEXT: "ONGOING",
+      },
+      COMPLETED: {
+        INDEX: 2,
+        TEXT: "COMPLETED",
+      },
+      CANCELLED: {
+        INDEX: 3,
+        TEXT: "CANCELLED",
+      },
+    },
+  },
+  BILL: {
+    TYPE: {
+      DRIVER: "DRIVER",
+      BUSINESS: "BUSINESS",
+      CUSTOMER: "CUSTOMER",
+    },
+    STATUS: {
+      CREATED: "CREATED",
+      APPROVED: "APPROVED",
+      SENT: "SENT",
+      ERROR: "ERROR",
+      AUTHORIZED: "AUTHORIZED",
+      NOT_AUTHORIZED: "NOT_AUTHORIZED",
+      RETURNED: "RETURNED",
+    },
+  },
+  FARE: {
+    RUSH_HOUR_INCREASE_TYPES: {
+      PERCENTAGE: "PERCENTAGE",
+      FIXED: "FIXED",
+    },
+  },
+  CALIFICATION: {
+    RUDE: {
+      index: -1,
+      text: "RUDE",
+    },
+    LATE: {
+      index: -2,
+      text: "LATE",
+    },
+    INEFFICIENT: {
+      index: -3,
+      text: "INEFFICIENT",
+    },
+    KIND: {
+      index: 1,
+      text: "KIND",
+    },
+    FAST: {
+      index: 2,
+      text: "FAST",
+    },
+    EFFICIENT: {
+      index: 3,
+      text: "EFFICIENT",
+    },
+  },
+};

package/index.js

@@ -0,0 +1,5 @@
+const PickerMongoDBService = require("./modules/picker");
+
+module.exports = {
+  PickerMongoDBService,
+};

package/lib/Logger/index.js

@@ -0,0 +1,45 @@
+const fs = require("fs");
+const winston = require("winston");
+const _ = require("lodash");
+
+const { printf, combine, timestamp, colorize, errors } = winston.format;
+
+const logDir = "log";
+if (!fs.existsSync(logDir)) {
+  fs.mkdirSync(logDir);
+}
+
+// Converts the date object to local time string
+const myFormat = printf(({ message, level, label, timestamp, stack }) => {
+  if (!_.isEmpty(stack)) {
+    return `${timestamp} ${level} - ${stack}`;
+  }
+  if (_.isObject(message)) {
+    message = JSON.stringify(message, null, 2);
+  }
+  return `${timestamp} [${label}] ${level} - ${message}`;
+});
+
+const logger = winston.createLogger({
+  level: "debug",
+  format: combine(
+    errors({ stack: true }),
+    timestamp(),
+    myFormat,
+  ),
+  transports: [
+    new winston.transports.Console({
+      format: combine(
+        errors({ stack: true }),
+        colorize(),
+        timestamp(),
+        myFormat,
+      ),
+    }),
+    new winston.transports.File({ filename: "log/error.log", level: "error" }),
+    new winston.transports.File({ filename: "log/info.log", level: "info" }),
+    new winston.transports.File({ filename: "log/debug.log", level: "debug" }),
+  ],
+});
+
+module.exports = logger;

package/lib/Mongo/index.js

@@ -0,0 +1,126 @@
+const mongoose = require("mongoose");
+const _ = require("lodash");
+
+const logger = require("../Logger");
+
+/**
+ * Class representing a connection to any mongoDB database
+ */
+class MongoDB {
+  /**
+   * Sets up the configuration for the mongo connection
+   * @param {object} config
+   * @param {string} config.dbName
+   * @param {boolean} [config.isLoggingEnabled]
+   * @param {boolean} [config.isDebugEnabled]
+   * @param {object} config.auth
+   * @param {string} config.auth.username
+   * @param {string} config.auth.password
+   * @param {string} [config.auth.host]
+   * @param {string} [config.auth.port]
+   * @param {string} [config.auth.environment]
+   * @param {boolean} [config.useMongoClient]
+   * @param {boolean} [config.useUnifiedTopology]
+   */
+  constructor (config = {}) {
+    this.config = _.defaults(
+      _.pick(config, ["isLoggingEnabled", "dbName", "isDebugEnabled"]),
+      {
+        isLoggingEnabled: false,
+      },
+    );
+    this.options = _.defaults(
+      _.pick(config, ["useMongoClient", "useUnifiedTopology"]),
+      {
+        useNewUrlParser: true,
+        useUnifiedTopology: true,
+      },
+    );
+    const auth = _.defaults(config.auth, {
+      host: "localhost",
+      port: "27017",
+    });
+    this.uri = this.getUri(auth);
+  }
+
+  /**
+   * Returns connection uri based on environment
+   * @param {object} auth
+   * @param {string} auth.username
+   * @param {string} auth.password
+   * @param {string} [auth.host]
+   * @param {string} [auth.port]
+   */
+  getUri (auth) {
+    let uri = "";
+    switch (auth.environment) {
+      case "local":
+        uri = `mongodb://${auth.host}:${auth.port}/${this.config.dbName}`;
+        break;
+      default:
+        uri = `mongodb://${auth.username}:${auth.password}@${auth.host}:${auth.port}/${this.config.dbName}`;
+        break;
+    }
+    return uri;
+  }
+
+  /**
+   * Create a connection to the database selected in the constructor
+   */
+  connect () {
+    return new Promise((resolve, reject) => {
+      if (this.isConnected) {
+        return resolve(this.connection);
+      }
+      this.connection = mongoose.createConnection(this.uri, this.options);
+
+      if (this.config.isDebugEnabled) {
+        mongoose.set("debug", true);
+      }
+
+      this.connection.on("error", (err) => {
+        if (this.config.isLoggingEnabled) {
+          logger.error({ message: `Connection error: ${JSON.stringify(err, null, 2)}`, label: this.config.dbName.toUpperCase() });
+        }
+        this.isConnected = false;
+        return reject(err);
+      });
+      this.connection.on("connected", () => {
+        if (this.config.isLoggingEnabled) {
+          logger.info({ message: "Connection open", label: this.config.dbName.toUpperCase() });
+        }
+        this.isConnected = true;
+        return resolve(this.connection);
+      });
+      this.connection.on("disconnected", () => {
+        if (this.config.isLoggingEnabled) {
+          logger.info({ message: "Disconnected", label: this.config.dbName.toUpperCase() });
+        }
+        this.isConnected = false;
+      });
+      this.connection.on("reconnected", () => {
+        if (this.config.isLoggingEnabled) {
+          logger.info({ message: "Reconnected", label: this.config.dbName.toUpperCase() });
+        }
+        this.isConnected = true;
+      });
+    });
+  }
+
+  async getConnection () {
+    await this.connect();
+    if (this.isConnected) {
+      return this.connection;
+    }
+    return null;
+  }
+
+  /**
+   * Closes the connection to the selected database
+   */
+  disconnect () {
+    return this.connection.close();
+  }
+};
+
+module.exports = MongoDB;