adminmate-express-mongoose 1.2.2 → 1.2.6

package/README.md

@@ -0,0 +1,40 @@
+# Adminmate (Express.js + Mongoose)
+
+Adminmate is a powerful & flexible back-office solution build for small to big teams. ✌️
+
+It provides an extremely flexible API developed in NodeJS that communicate with a powerful frontend back-office we host.
+
+As the security & privacy of your data is our main focus, the Data API is host by yourself and secured by your own credentials.
+
+## Getting started
+
+[https://adminmate.io](https://adminmate.io)
+
+## Databases compatibility
+
+Adminmate is compatible with the most famous database systems like **MySQL**, **PostgreSQL**, **SQLite** and **MongoDB**. We are working hard on adding more soon!
+
+## Features
+
+Adminmate comes with all the features you need for your back-office:
+* **Data**: Data Explorer, CRUD, Filters, Segments, Actions
+* **Dashboards & Charts**: Unlimited Dashboards & Charts
+* **Collaboration**: Powerful collaboration tool
+* **Activity**: Track everything that happening on your database data
+* **Access Control**: Team-based Access Control
+
+### Data explorer
+
+![Alt text](https://adminmate.io/github/list-screen.svg)
+
+### Dashboards & Charts
+
+![Alt text](https://adminmate.io/github/homepage-screen.svg)
+
+### Activity
+
+![Alt text](https://adminmate.io/github/activity-screen.svg)
+
+## Who are the contributors ?
+
+Adminmate is a bootstrapped project tailored by **Marc Delalonde** and aims to stay an *independent project, driven by the community*.

package/jest.config.js

@@ -1,3 +1,9 @@
 module.exports = {
-  testEnvironment: 'node'
+  testEnvironment: 'node',
+  projects: [
+    {
+      displayName: 'mongodb',
+      testMatch: ['<rootDir>/test/mongodb.test.js']
+    }
+  ]
 };

package/package.json

@@ -1,11 +1,22 @@
 {
   "name": "adminmate-express-mongoose",
-  "version": "1.2.2",
+  "version": "1.2.6",
   "description": "Adminmate Express/Mongoose connector",
   "author": "Marc Delalonde",
+  "homepage": "http://adminmate.io",
+  "license": "GPL-3.0",
+  "keywords": [
+    "adminmate",
+    "admin",
+    "panel",
+    "interface",
+    "back-office",
+    "mongodb",
+    "mongoose"
+  ],
   "scripts": {
     "start": "node ./index",
-    "test": "jest --testTimeout=10000 --verbose",
+    "test": "jest --runInBand",
     "reset-db": "node migration.js"
   },
   "repository": {
@@ -13,7 +24,7 @@
     "url": "https://github.com/Adminmate/adminmate-express-mongoose.git"
   },
   "dependencies": {
-    "adminmate-express-core": "^1.1.2",
+    "adminmate-express-core": "^1.1.5",
     "lodash": "^4.17.21",
     "moment": "^2.29.1",
     "mongoose": "^5.9.7",
@@ -21,8 +32,8 @@
     "serialize-error": "^7.0.1"
   },
   "devDependencies": {
-    "jest": "^26.6.3",
-    "jwt-simple": "^0.5.6",
-    "supertest": "^6.1.3"
+    "jest": "^27.3.1",
+    "jest-specific-snapshot": "^5.0.0",
+    "node-mocks-http": "^1.11.0"
   }
 }

package/src/controllers/chart-pie.js

@@ -0,0 +1,32 @@
+module.exports = async (currentModel, data) => {
+  let _value = 1;
+  if (data.field && ['sum', 'avg'].includes(data.operation)) {
+    _value = `$${data.field}`;
+  }
+
+  const repartitionData = await currentModel
+    .aggregate([
+      {
+        $group: {
+          _id: `$${data.group_by}`,
+          count: data.operation === 'avg' ? { $avg: _value } : { $sum: _value },
+        }
+      },
+      {
+        $project: {
+          key: '$_id',
+          value: '$count',
+          _id: false
+        }
+      }
+    ])
+    .sort({ key: 1 });
+
+  return {
+    success: true,
+    data: {
+      config: null,
+      data: repartitionData
+    }
+  };
+};

package/src/controllers/chart-ranking.js

@@ -0,0 +1,9 @@
+module.exports = async (currentModel, data) => {
+  return {
+    success: false,
+    data: {
+      config: null,
+      data: {}
+    }
+  };
+};

package/src/controllers/chart-time.js

@@ -0,0 +1,147 @@
+
+const _ = require('lodash');
+const moment = require('moment');
+
+module.exports = async (currentModel, data) => {
+  if (!['day', 'week', 'month', 'year'].includes(data.timeframe)) {
+    return {
+      success: false,
+      message: 'Invalid timeframe'
+    };
+  }
+
+  const toSum = data.field && data.operation === 'sum' ? `$${data.field}` : 1;
+
+  let matchReq = {};
+  let groupFormat = '';
+
+  // Day timeframe
+  if (data.timeframe === 'day') {
+    const startOfCurrentDay = moment().startOf('day');
+    matchReq = {
+      '$gte': new Date(startOfCurrentDay.clone().subtract(30, 'day').startOf('day').format()),
+      '$lt': new Date(startOfCurrentDay.format())
+    };
+    groupFormat = '%Y-%m-%d';
+  }
+  // Week timeframe
+  else if (data.timeframe === 'week') {
+    const startOfCurrentWeek = moment().startOf('week');
+    matchReq = {
+      '$gte': new Date(startOfCurrentWeek.clone().subtract(26, 'week').startOf('week').format()),
+      '$lt': new Date(startOfCurrentWeek.format())
+    };
+    groupFormat = '%V';
+  }
+  // Month timeframe
+  else if (data.timeframe === 'month') {
+    const startOfCurrentMonth = moment().startOf('month');
+    matchReq = {
+      '$gte': new Date(startOfCurrentMonth.clone().subtract(12, 'month').startOf('month').format()),
+      '$lt': new Date(startOfCurrentMonth.format())
+    };
+    groupFormat = '%m';
+  }
+  // Year timeframe
+  else if (data.timeframe === 'year') {
+    const startOfCurrentYear = moment().startOf('year');
+    matchReq = {
+      '$gte': new Date(startOfCurrentYear.clone().subtract(8, 'year').startOf('year').format()),
+      '$lt': new Date(startOfCurrentYear.format())
+    };
+    groupFormat = '%Y';
+  }
+
+  if (!groupFormat) {
+    return res.status(403).json({ message: 'Invalid request' });
+  }
+
+  const repartitionData = await currentModel
+    .aggregate([
+      {
+        $match: {
+          [data.group_by]: matchReq
+        }
+      },
+      {
+        $group: {
+          _id: { $dateToString: { format: groupFormat, date: `$${data.group_by}` } },
+          count: { $sum: toSum }
+        }
+      },
+      {
+        $project: {
+          key: '$_id',
+          value: '$count',
+          _id: false
+        }
+      }
+    ]);
+
+  const formattedData = [];
+
+  // Day timeframe
+  if (data.timeframe === 'day') {
+    for (let i = 1; i <= 30; i++) {
+      const currentDate = moment().subtract(i, 'day').startOf('day');
+      const countForTheTimeframe = _.find(repartitionData, { key: currentDate.format('YYYY-MM-DD') });
+      formattedData.push({
+        key: currentDate.format('DD/MM'),
+        value: countForTheTimeframe ? countForTheTimeframe.value : 0
+      });
+    }
+  }
+  // Week timeframe
+  else if (data.timeframe === 'week') {
+    for (let i = 1; i <= 26; i++) {
+      const currentWeek = moment().subtract(i, 'week').startOf('week');
+      const countForTheTimeframe = _.find(repartitionData, { key: currentWeek.format('WW') });
+      formattedData.push({
+        key: currentWeek.startOf('week').format('DD/MM'),
+        value: countForTheTimeframe ? countForTheTimeframe.value : 0
+      });
+    }
+  }
+  // Month timeframe
+  else if (data.timeframe === 'month') {
+    for (let i = 1; i <= 12; i++) {
+      const currentMonth = moment().subtract(i, 'month').startOf('month');
+      const countForTheTimeframe = _.find(repartitionData, { key: currentMonth.format('MM') });
+      formattedData.push({
+        key: currentMonth.startOf('month').format('MMM'),
+        value: countForTheTimeframe ? countForTheTimeframe.value : 0
+      });
+    }
+  }
+  // Year timeframe
+  else if (data.timeframe === 'year') {
+    for (let i = 1; i <= 8; i++) {
+      const currentYear = moment().subtract(i, 'year').startOf('year');
+      const countForTheTimeframe = _.find(repartitionData, { key: currentYear.format('YYYY') });
+      formattedData.push({
+        key: currentYear.startOf('year').format('YYYY'),
+        value: countForTheTimeframe ? countForTheTimeframe.value : 0
+      });
+    }
+  }
+
+  const formattedDataOrdered = formattedData.reverse();
+
+  const chartConfig = {
+    xaxis: [
+      { dataKey: 'key' }
+    ],
+    yaxis: [
+      { dataKey: 'value' },
+      // { dataKey: 'test', orientation: 'right' }
+    ]
+  };
+
+  return {
+    success: true,
+    data: {
+      config: chartConfig,
+      data: formattedDataOrdered
+    }
+  };
+};

package/src/controllers/chart-value.js

@@ -0,0 +1,55 @@
+module.exports = async (currentModel, data) => {
+  if (data.operation === 'sum') {
+    const sumData = await currentModel
+      .aggregate([{
+        $group: {
+          _id: `$${data.group_by}`,
+          count: { $sum: `$${data.field}` },
+        }
+      }]);
+
+    if (!sumData || !sumData[0] || typeof sumData[0].count !== 'number') {
+      return res.status(403).json();
+    }
+
+    return {
+      success: true,
+      data: {
+        config: null,
+        data: sumData[0].count
+      }
+    };
+  }
+  else if (data.operation === 'avg') {
+    const avgData = await currentModel
+      .aggregate([{
+        $group: {
+          _id: `$${data.group_by}`,
+          avg: { $avg: `$${data.field}` },
+        }
+      }]);
+
+    if (!avgData || !avgData[0] || typeof avgData[0].avg !== 'number') {
+      return res.status(403).json();
+    }
+
+    return {
+      success: true,
+      data: {
+        config: null,
+        data: avgData[0].avg
+      }
+    };
+  }
+  else {
+    const dataCount = await currentModel.countDocuments({});
+
+    return {
+      success: true,
+      data: {
+        config: null,
+        data: dataCount
+      }
+    };
+  }
+};

package/src/controllers/model-autocomplete.js

@@ -3,8 +3,8 @@ const fnHelper = require('../helpers/functions');
 
 module.exports.getAutocomplete = async (req, res) => {
   const modelName = req.params.model;
-  const search = (req.body.search || '').trim();
-  const refFields = req.body.refFields;
+  const search = (req.query.s || '').trim();
+  const refFields = req.headers['am-ref-fields'] || {};
   const maxItem = 10;
 
   const currentModel = fnHelper.getModelObject(modelName);

package/src/controllers/model-getall.js

@@ -3,16 +3,16 @@ const fnHelper = require('../helpers/functions');
 
 module.exports.getAll = async (req, res) => {
   const modelName = req.params.model;
-  const segment = req.body.segment;
-  const search = (req.body.search || '').trim();
-  const filters = req.body.filters;
-  const fieldsToFetch = req.body.fields || [];
-  const refFields = req.body.refFields;
-  const fieldsToSearchIn = req.body.fieldsToSearchIn || [];
-  const page = parseInt(req.body.page || 1);
+  const segment = req.query.segment;
+  const search = (req.query.search || '').trim();
+  const filters = req.query.filters;
+  const fieldsToFetch = req.headers['am-model-fields'] || [];
+  const refFields = req.headers['am-ref-fields'] || {};
+  const fieldsToSearchIn = req.query.fieldsToSearchIn || [];
+  const page = parseInt(req.query.page || 1);
   const nbItemPerPage = 10;
   const defaultOrdering = [ ['_id', 'DESC'] ];
-  const order = req.body.order || null;
+  const order = req.query.order || null;
 
   const currentModel = fnHelper.getModelObject(modelName);
   if (!currentModel) {

package/src/controllers/model-getone.js

@@ -4,7 +4,8 @@ const fnHelper = require('../helpers/functions');
 module.exports.getOne = async (req, res) => {
   const modelName = req.params.model;
   const modelItemId = req.params.id;
-  const refFields = req.body.refFields || {};
+  const fieldsToFetch = req.headers['am-model-fields'] || [];
+  const refFields = req.headers['am-ref-fields'] || {};
 
   const currentModel = fnHelper.getModelObject(modelName);
   if (!currentModel) {
@@ -13,14 +14,14 @@ module.exports.getOne = async (req, res) => {
 
   const keys = fnHelper.getModelProperties(currentModel);
   const defaultFieldsToFetch = keys.map(key => key.path);
-  const fieldsToFetch = req.body.fields ? req.body.fields : defaultFieldsToFetch;
+  const fieldsToFetchSafe = Array.isArray(fieldsToFetch) && fieldsToFetch.length ? fieldsToFetch : defaultFieldsToFetch;
 
   // Build ref fields for the model (for mongoose population purpose)
-  const fieldsToPopulate = fnHelper.getFieldsToPopulate(keys, fieldsToFetch, refFields);
+  const fieldsToPopulate = fnHelper.getFieldsToPopulate(keys, fieldsToFetchSafe, refFields);
 
   let data = await currentModel
     .findById(modelItemId)
-    .select(fieldsToFetch)
+    .select(fieldsToFetchSafe)
     .populate(fieldsToPopulate)
     .lean()
     .catch(e => {

package/src/controllers/model-query.js

@@ -1,6 +1,8 @@
-const _ = require('lodash');
-const moment = require('moment');
 const fnHelper = require('../helpers/functions');
+const chartPie = require('./chart-pie');
+const chartValue = require('./chart-value');
+const chartTime = require('./chart-time');
+const chartRanking = require('./chart-ranking');
 
 module.exports.customQuery = async (req, res) => {
   const data = req.body.data;
@@ -11,201 +13,39 @@ module.exports.customQuery = async (req, res) => {
     return res.status(403).json({ message: 'Invalid request' });
   }
 
-  if (data.type === 'pie') {
-    let _value = 1;
-    if (data.field && ['sum', 'avg'].includes(data.operation)) {
-      _value = `$${data.field}`;
-    }
-
-    const repartitionData = await currentModel
-      .aggregate([
-        {
-          $group: {
-            _id: `$${data.group_by}`,
-            count: data.operation === 'avg' ? { $avg: _value } : { $sum: _value },
-          }
-        },
-        {
-          $project: {
-            key: '$_id',
-            value: '$count',
-            _id: false
-          }
-        }
-      ])
-      .sort({ key: 1 });
-
-    res.json({ data: repartitionData });
+  let result = {
+    success: false,
+    message: ''
+  };
+
+  switch(data.type) {
+    case 'pie':
+      result = await chartPie(currentModel, data);
+      break;
+
+    case 'single_value':
+    case 'objective':
+      result = await chartValue(currentModel, data);
+      break;
+
+    case 'bar':
+    case 'line':
+      result = await chartTime(currentModel, data);
+      break;
+
+    case 'ranking':
+      result = await chartRanking(currentModel, data);
+      break;
   }
-  else if (data.type === 'single_value' || data.type === 'objective') {
-    if (data.operation === 'sum') {
-      const sumData = await currentModel
-        .aggregate([{
-          $group: {
-            _id: `$${data.group_by}`,
-            count: { $sum: `$${data.field}` },
-          }
-        }]);
-
-      if (!sumData || !sumData[0] || typeof sumData[0].count !== 'number') {
-        return res.status(403).json();
-      }
-
-      res.json({ data: sumData[0].count });
-    }
-    else if (data.operation === 'avg') {
-      const avgData = await currentModel
-        .aggregate([{
-          $group: {
-            _id: `$${data.group_by}`,
-            avg: { $avg: `$${data.field}` },
-          }
-        }]);
-
-      if (!avgData || !avgData[0] || typeof avgData[0].avg !== 'number') {
-        return res.status(403).json();
-      }
 
-      res.json({ data: avgData[0].avg });
-    }
-    else {
-      const dataCount = await currentModel.countDocuments({});
-      res.json({ data: dataCount });
-    }
+  // Response
+  if (result.success === true) {
+    return res.json({
+      chart: result.data
+    });
   }
-  else if (data.type === 'bar' || data.type === 'line') {
-    const toSum = data.field && data.operation === 'sum' ? `$${data.field}` : 1;
-
-    let matchReq = {};
-    let groupFormat = '';
-
-    // Day timeframe
-    if (data.timeframe === 'day') {
-      matchReq = {
-        '$gte': new Date(moment().subtract(30, 'day').startOf('day').format()),
-        '$lte': new Date(moment().endOf('day').format())
-      };
-      groupFormat = '%Y-%m-%d';
-    }
-    // Week timeframe
-    else if (data.timeframe === 'week') {
-      matchReq = {
-        '$gte': new Date(moment().subtract(26, 'week').startOf('week').format()),
-        '$lte': new Date(moment().endOf('week').format())
-      };
-      groupFormat = '%V';
-    }
-    // Month timeframe
-    else if (data.timeframe === 'month') {
-      matchReq = {
-        '$gte': new Date(moment().subtract(12, 'month').startOf('month').format()),
-        '$lte': new Date(moment().endOf('month').format())
-      };
-      groupFormat = '%m';
-    }
-    // Year timeframe
-    else if (data.timeframe === 'year') {
-      matchReq = {
-        '$gte': new Date(moment().subtract(8, 'year').startOf('year').format()),
-        '$lte': new Date(moment().endOf('year').format())
-      };
-      groupFormat = '%Y';
-    }
-
-    if (!groupFormat) {
-      return res.status(403).json({ message: 'Invalid request' });
-    }
-
-    const repartitionData = await currentModel
-      .aggregate([
-        {
-          $match: {
-            [data.group_by]: matchReq
-          }
-        },
-        {
-          $group: {
-            _id: { $dateToString: { format: groupFormat, date: `$${data.group_by}` } },
-            count: { $sum: toSum }
-          }
-        },
-        {
-          $project: {
-            key: '$_id',
-            value: '$count',
-            _id: false
-          }
-        }
-      ]);
 
-    const formattedData = [];
-
-    // Day timeframe
-    if (data.timeframe === 'day') {
-      for (let i = 0; i < 30; i++) {
-        const currentDate = moment().subtract(i, 'day');
-        const countForTheTimeframe = _.find(repartitionData, { key: currentDate.format('YYYY-MM-DD') });
-        formattedData.push({
-          key: currentDate.format('DD/MM'),
-          value: countForTheTimeframe ? countForTheTimeframe.value : 0
-        });
-      }
-    }
-    // Week timeframe
-    else if (data.timeframe === 'week') {
-      for (let i = 0; i < 26; i++) {
-        const currentWeek = moment().subtract(i, 'week');
-
-        const countForTheTimeframe = _.find(repartitionData, { key: currentWeek.format('WW') });
-        formattedData.push({
-          key: currentWeek.startOf('week').format('DD/MM'),
-          value: countForTheTimeframe ? countForTheTimeframe.value : 0
-        });
-      }
-    }
-    // Month timeframe
-    else if (data.timeframe === 'month') {
-      for (let i = 0; i < 12; i++) {
-        const currentMonth = moment().subtract(i, 'month');
-
-        const countForTheTimeframe = _.find(repartitionData, { key: currentMonth.format('MM') });
-        formattedData.push({
-          key: currentMonth.startOf('month').format('MMM'),
-          value: countForTheTimeframe ? countForTheTimeframe.value : 0
-        });
-      }
-    }
-    // Year timeframe
-    else if (data.timeframe === 'year') {
-      for (let i = 0; i < 8; i++) {
-        const currentYear = moment().subtract(i, 'year');
-
-        const countForTheTimeframe = _.find(repartitionData, { key: currentYear.format('YYYY') });
-        formattedData.push({
-          key: currentYear.startOf('year').format('YYYY'),
-          value: countForTheTimeframe ? countForTheTimeframe.value : 0
-        });
-      }
-    }
-
-    formattedDataOrdered = formattedData.reverse();
-
-    const finalData = {
-      config: {
-        xaxis: [
-          { dataKey: 'key' }
-        ],
-        yaxis: [
-          { dataKey: 'value' },
-          // { dataKey: 'test', orientation: 'right' }
-        ]
-      },
-      data: formattedDataOrdered
-    };
-
-    res.json({ data: finalData });
-  }
-  else {
-    res.json({ data: null });
-  }
+  res.status(403).json({
+    message: result.message || 'Invalid request'
+  });
 };