adminmate-express-mongoose 1.2.5 → 1.3.0

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/index.js

@@ -7,6 +7,7 @@ const fnHelper = require('./src/helpers/functions');
 const { getAll } = require('./src/controllers/model-getall');
 const { getIn } = require('./src/controllers/model-getin');
 const { getOne } = require('./src/controllers/model-getone');
+const { getRefs } = require('./src/controllers/model-getrefs');
 const { postOne } = require('./src/controllers/model-postone');
 const { putOne } = require('./src/controllers/model-putone');
 const { deleteSome } = require('./src/controllers/model-deletesome');
@@ -15,15 +16,21 @@ const { customQuery } = require('./src/controllers/model-query');
 
 const Adminmate = ({ projectId, secretKey, authKey, masterPassword, models, charts, authorizedIps }) => {
   const api = {
+    // App config
+    getAppConfig: fnHelper.getAppConfig,
+
     // General
     getModelProperties: fnHelper.getModelProperties,
     getModelRealname: fnHelper.getModelRealname,
     getModelRelationships: fnHelper.getModelAssociations,
+    getModelPrimaryKeys: fnHelper.getModelPrimaryKeys,
+    getModelWhereClause: fnHelper.getModelWhereClause,
 
     // CRUD
     modelGetAll: getAll,
     modelGetIn: getIn,
     modelGetOne: getOne,
+    modelGetRefs: getRefs,
     modelPostOne: postOne,
     modelPutOne: putOne,
     modelDeleteSome: deleteSome,

package/jest.config.js

@@ -1,5 +1,4 @@
 module.exports = {
-  testEnvironment: 'node',
   projects: [
     {
       displayName: 'mongodb',

package/package.json

@@ -1,23 +1,32 @@
 {
   "name": "adminmate-express-mongoose",
-  "version": "1.2.5",
+  "version": "1.3.0",
   "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 --runInBand",
-    "reset-db": "node migration.js"
+    "test": "jest --runInBand"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/Adminmate/adminmate-express-mongoose.git"
   },
   "dependencies": {
-    "adminmate-express-core": "^1.1.4",
+    "adminmate-express-core": "^1.2.0",
     "lodash": "^4.17.21",
     "moment": "^2.29.1",
-    "mongoose": "^5.9.7",
-    "mongoose-legacy-pluralize": "^1.0.2",
+    "mongoose": "~5.9.7",
     "serialize-error": "^7.0.1"
   },
   "devDependencies": {

package/src/controllers/chart-ranking.js

@@ -1,9 +1,56 @@
+const fnHelper = require('../helpers/functions');
+
 module.exports = async (currentModel, data) => {
+  // Get relationship model
+  const relationshipModel = fnHelper.getModelObject(data.relationship_model);
+  if (!relationshipModel) {
+    return res.status(403).json({ message: 'Invalid request' });
+  }
+
+  // Default limit
+  let limit = data.limit || 10;
+
+  let _value = 1;
+  if (data.relationship_field && ['sum', 'avg'].includes(data.relationship_operation)) {
+    _value = `$${data.relationship_field}`;
+  }
+
+  const repartitionData = await relationshipModel
+    .aggregate([
+      {
+        $group: {
+          _id: `$${data.relationship_model_ref_field}`,
+          count: data.operation === 'avg' ? { $avg: _value } : { $sum: _value },
+        }
+      },
+      {
+        $project: {
+          key: '$_id',
+          value: '$count',
+          _id: false
+        }
+      }
+    ])
+    .limit(limit)
+    .sort({ value: -1 });
+
+  const parentIds = repartitionData.map(d => d.key);
+  const parentData = await currentModel.find({ _id: parentIds }).select(data.field).lean();
+
+  repartitionData.forEach(d => {
+    d.item_model = data.model;
+    d.item_id = d.key;
+    const parent = parentData.find(p => p._id.toString() === d.key.toString());
+    if (parent) {
+      d.key = parent[data.field];
+    }
+  });
+
   return {
-    success: false,
+    success: true,
     data: {
       config: null,
-      data: {}
+      data: repartitionData
     }
   };
 };

package/src/controllers/chart-time.js

@@ -12,12 +12,15 @@ module.exports = async (currentModel, data) => {
 
   const toSum = data.field && data.operation === 'sum' ? `$${data.field}` : 1;
 
+  // To set the max date
+  const toDate = data.to ? moment(data.to) : moment();
+
   let matchReq = {};
   let groupFormat = '';
 
   // Day timeframe
   if (data.timeframe === 'day') {
-    const startOfCurrentDay = moment().startOf('day');
+    const startOfCurrentDay = toDate.startOf('day');
     matchReq = {
       '$gte': new Date(startOfCurrentDay.clone().subtract(30, 'day').startOf('day').format()),
       '$lt': new Date(startOfCurrentDay.format())
@@ -26,7 +29,7 @@ module.exports = async (currentModel, data) => {
   }
   // Week timeframe
   else if (data.timeframe === 'week') {
-    const startOfCurrentWeek = moment().startOf('week');
+    const startOfCurrentWeek = toDate.startOf('week');
     matchReq = {
       '$gte': new Date(startOfCurrentWeek.clone().subtract(26, 'week').startOf('week').format()),
       '$lt': new Date(startOfCurrentWeek.format())
@@ -35,7 +38,7 @@ module.exports = async (currentModel, data) => {
   }
   // Month timeframe
   else if (data.timeframe === 'month') {
-    const startOfCurrentMonth = moment().startOf('month');
+    const startOfCurrentMonth = toDate.startOf('month');
     matchReq = {
       '$gte': new Date(startOfCurrentMonth.clone().subtract(12, 'month').startOf('month').format()),
       '$lt': new Date(startOfCurrentMonth.format())
@@ -44,7 +47,7 @@ module.exports = async (currentModel, data) => {
   }
   // Year timeframe
   else if (data.timeframe === 'year') {
-    const startOfCurrentYear = moment().startOf('year');
+    const startOfCurrentYear = toDate.startOf('year');
     matchReq = {
       '$gte': new Date(startOfCurrentYear.clone().subtract(8, 'year').startOf('year').format()),
       '$lt': new Date(startOfCurrentYear.format())
@@ -83,7 +86,7 @@ module.exports = async (currentModel, data) => {
   // Day timeframe
   if (data.timeframe === 'day') {
     for (let i = 1; i <= 30; i++) {
-      const currentDate = moment().subtract(i, 'day').startOf('day');
+      const currentDate = toDate.clone().subtract(i, 'day').startOf('day');
       const countForTheTimeframe = _.find(repartitionData, { key: currentDate.format('YYYY-MM-DD') });
       formattedData.push({
         key: currentDate.format('DD/MM'),
@@ -94,7 +97,7 @@ module.exports = async (currentModel, data) => {
   // Week timeframe
   else if (data.timeframe === 'week') {
     for (let i = 1; i <= 26; i++) {
-      const currentWeek = moment().subtract(i, 'week').startOf('week');
+      const currentWeek = toDate.clone().subtract(i, 'week').startOf('week');
       const countForTheTimeframe = _.find(repartitionData, { key: currentWeek.format('WW') });
       formattedData.push({
         key: currentWeek.startOf('week').format('DD/MM'),
@@ -105,7 +108,7 @@ module.exports = async (currentModel, data) => {
   // Month timeframe
   else if (data.timeframe === 'month') {
     for (let i = 1; i <= 12; i++) {
-      const currentMonth = moment().subtract(i, 'month').startOf('month');
+      const currentMonth = toDate.clone().subtract(i, 'month').startOf('month');
       const countForTheTimeframe = _.find(repartitionData, { key: currentMonth.format('MM') });
       formattedData.push({
         key: currentMonth.startOf('month').format('MMM'),
@@ -116,7 +119,7 @@ module.exports = async (currentModel, data) => {
   // Year timeframe
   else if (data.timeframe === 'year') {
     for (let i = 1; i <= 8; i++) {
-      const currentYear = moment().subtract(i, 'year').startOf('year');
+      const currentYear = toDate.clone().subtract(i, 'year').startOf('year');
       const countForTheTimeframe = _.find(repartitionData, { key: currentYear.format('YYYY') });
       formattedData.push({
         key: currentYear.startOf('year').format('YYYY'),

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.search_in_fields || [];
+  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-getrefs.js

@@ -0,0 +1,53 @@
+const fnHelper = require('../helpers/functions');
+
+module.exports.getRefs = async (req, res) => {
+  const modelName = req.params.model;
+  const ids = req.query.ids;
+  const refFields = req.headers['am-ref-fields'] || {};
+  const nbItemPerPage = 20;
+
+  if (!ids) {
+    return res.status(403).json({ message: 'Missing parameter ids' });
+  }
+
+  const fieldsToFetchSafe = refFields[modelName];
+
+  // If no ref fields, return default response
+  if (!fieldsToFetchSafe) {
+    return res.json({
+      data: ids.map(id => ({ value: id, label: id }))
+    });
+  }
+
+  const currentModel = fnHelper.getModelObject(modelName);
+  if (!currentModel) {
+    return res.status(403).json({ message: 'Invalid request' });
+  }
+
+  // Find parameters
+  const findParams = { _id: ids };
+
+  const data = await currentModel
+    .find(findParams)
+    .select(fieldsToFetchSafe)
+    .limit(nbItemPerPage)
+    .lean()
+    .catch(e => {
+      res.status(403).json({ message: e.message });
+    });
+
+  if (!data) {
+    return res.status(403).json();
+  }
+
+  // Format the response
+  const formattedData = ids.map(_id => {
+    const match = data.find(d => d._id.toString() === _id.toString());
+    const label = match ? fnHelper.fieldsToValues(fieldsToFetchSafe, match) : _id;
+    return { value: _id, label };
+  });
+
+  res.json({
+    data: formattedData
+  });
+};

package/src/helpers/functions.js

@@ -3,6 +3,8 @@ const { serializeError } = require('serialize-error');
 const _ = require('lodash');
 const moment = require('moment');
 
+const pjson = require('../../package.json');
+
 const getModelProperties = model => {
   let modelFields = [];
   const modelProps = model.schema.paths;
@@ -222,6 +224,12 @@ module.exports.constructQuery = jsonQuery => {
   return null;
 };
 
+module.exports.fieldsToValues = (string, values) => {
+  return string.replace(/[a-z._]+/gi, word => {
+    return _.get(values, word);
+  });
+};
+
 module.exports.refFields = (item, fieldsToPopulate) => {
   const attributes = Object.keys(item);
   attributes.forEach(attr => {
@@ -354,6 +362,14 @@ module.exports.constructSearch = (search, fieldsToSearchIn, fieldsToPopulate = [
   return params;
 };
 
+module.exports.getModelWhereClause = (model, idsArray) => {
+  return { _id: idsArray };
+};
+
+module.exports.getModelPrimaryKeys = model => {
+  return ['_id'];
+};
+
 module.exports.getModelAssociations = model => {
   // Get current model mongoose realname
   const currentModelRealName = getModelRealname(model);
@@ -462,4 +478,11 @@ module.exports.getCleanOrderStructure = orderConfig => {
     order[oc[0]] = oc[1];
   });
   return order;
+};
+
+module.exports.getAppConfig = () => {
+  return {
+    package: pjson.name,
+    version: pjson.version
+  };
 };

package/database.js

@@ -1,16 +0,0 @@
-const mongoose = require('mongoose');
-
-const User = require('./models/user');
-const Car = require('./models/car');
-const Blocked = require('./models/blocked');
-
-const connectDb = () => {
-  return mongoose.connect('mongodb://localhost:27017/node-express-mongodb-server', {
-    useNewUrlParser: true,
-    useUnifiedTopology: true
-  });
-};
-
-const models = { User, Car, Blocked };
-
-module.exports = { models, connectDb };

package/docker-compose.yml

@@ -1,12 +0,0 @@
-version: '3'
-
-services:
-  mongo:
-    container_name: adminmate-express-mongoose
-    environment:
-      - MONGO_INITDB_DATABASE=demo
-      - MONGO_DATA_DIR=/data/db
-      - MONGO_LOG_DIR=/dev/null
-    image: mongo
-    ports:
-      - '27017:27017'