adminmate-express-mongoose 1.2.3 → 1.2.7

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

@@ -15,10 +15,15 @@ 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,

package/jest.config.js

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

package/package.json

@@ -1,19 +1,29 @@
 {
   "name": "adminmate-express-mongoose",
-  "version": "1.2.3",
+  "version": "1.2.7",
   "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.1.6",
     "lodash": "^4.17.21",
     "moment": "^2.29.1",
     "mongoose": "^5.9.7",

package/src/controllers/chart-time.js

@@ -12,41 +12,44 @@ 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.subtract(30, 'day').startOf('day').format()),
+      '$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');
+    const startOfCurrentWeek = toDate.startOf('week');
     matchReq = {
-      '$gte': new Date(startOfCurrentWeek.subtract(26, 'week').startOf('week').format()),
+      '$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');
+    const startOfCurrentMonth = toDate.startOf('month');
     matchReq = {
-      '$gte': new Date(startOfCurrentMonth.subtract(12, 'month').startOf('month').format()),
+      '$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');
+    const startOfCurrentYear = toDate.startOf('year');
     matchReq = {
-      '$gte': new Date(startOfCurrentYear.subtract(8, 'year').startOf('year').format()),
+      '$gte': new Date(startOfCurrentYear.clone().subtract(8, 'year').startOf('year').format()),
       '$lt': new Date(startOfCurrentYear.format())
     };
     groupFormat = '%Y';
@@ -82,8 +85,8 @@ module.exports = async (currentModel, data) => {
 
   // Day timeframe
   if (data.timeframe === 'day') {
-    for (let i = 0; i < 30; i++) {
-      const currentDate = moment().subtract(i, 'day');
+    for (let i = 1; i <= 30; i++) {
+      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'),
@@ -93,9 +96,8 @@ module.exports = async (currentModel, data) => {
   }
   // Week timeframe
   else if (data.timeframe === 'week') {
-    for (let i = 0; i < 26; i++) {
-      const currentWeek = moment().subtract(i, 'week');
-
+    for (let i = 1; i <= 26; i++) {
+      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,9 +107,8 @@ module.exports = async (currentModel, data) => {
   }
   // Month timeframe
   else if (data.timeframe === 'month') {
-    for (let i = 0; i < 12; i++) {
-      const currentMonth = moment().subtract(i, 'month');
-
+    for (let i = 1; i <= 12; i++) {
+      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'),
@@ -117,9 +118,8 @@ module.exports = async (currentModel, data) => {
   }
   // Year timeframe
   else if (data.timeframe === 'year') {
-    for (let i = 0; i < 8; i++) {
-      const currentYear = moment().subtract(i, 'year');
-
+    for (let i = 1; i <= 8; i++) {
+      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.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/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;
@@ -354,6 +356,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 +472,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/migration.js

@@ -1,234 +0,0 @@
-const { models, connectDb } = require('./database');
-
-connectDb().then(async () => {
-  console.log('MongoDB connected');
-
-  // Remove all entries
-  await Promise.all([
-    models.User.deleteMany({}),
-    models.Car.deleteMany({}),
-    models.Blocked.deleteMany({})
-  ]);
-
-  // Create users
-  await models.User.insertMany([
-    {
-      _id: '5cd5308e695db945d3cc81a1',
-      firstname: 'John',
-      lastname: 'Doe',
-      birthdate: '2021-04-02T00:00:00.000Z',
-      rating: 4,
-      createdAt: '2021-04-02T00:00:00.000Z',
-      updatedAt: '2021-04-02T00:00:00.000Z'
-    },
-    {
-      _id: '5cd5308e695db945d3cc81a2',
-      firstname: 'Maria',
-      lastname: 'Doe',
-      birthdate: '2021-04-02T00:00:00.000Z',
-      rating: 5,
-      createdAt: '2021-04-02T00:00:00.000Z',
-      updatedAt: '2021-04-02T00:00:00.000Z'
-    }
-  ]);
-
-  // Create cars
-  await models.Car.insertMany([
-    {
-      _id: '5cd5308e695db945d3cc81b1',
-      name: 'Porsche 356',
-      manufacturer: 'Porsche',
-      year: 1948,
-      user_id: '5cd5308e695db945d3cc81a1',
-      createdAt: "2021-04-02T00:00:00.000Z",
-      updatedAt: "2021-04-02T00:00:00.000Z"
-    },
-    {
-      _id: '5cd5308e695db945d3cc81b2',
-      name: 'Porsche 550',
-      manufacturer: 'Porsche',
-      year: 1953,
-      user_id: '5cd5308e695db945d3cc81a2',
-      createdAt: "2021-04-02T00:00:00.000Z",
-      updatedAt: "2021-04-02T00:00:00.000Z"
-    },
-    {
-      _id: '5cd5308e695db945d3cc81b3',
-      name: 'Porsche 911',
-      manufacturer: 'Porsche',
-      year: 1963,
-      user_id: '5cd5308e695db945d3cc81a1',
-      createdAt: "2021-04-02T00:00:00.000Z",
-      updatedAt: "2021-04-02T00:00:00.000Z"
-    },
-    {
-      _id: '5cd5308e695db945d3cc81b4',
-      name: 'Porsche 904',
-      manufacturer: 'Porsche',
-      year: 1964,
-      user_id: '5cd5308e695db945d3cc81a2',
-      createdAt: "2021-04-02T00:00:00.000Z",
-      updatedAt: "2021-04-02T00:00:00.000Z"
-    },
-    {
-      _id: '5cd5308e695db945d3cc81b5',
-      name: 'Porsche 906',
-      manufacturer: 'Porsche',
-      year: 1966,
-      user_id: '5cd5308e695db945d3cc81a1',
-      createdAt: "2021-04-02T00:00:00.000Z",
-      updatedAt: "2021-04-02T00:00:00.000Z"
-    },
-    {
-      _id: '5cd5308e695db945d3cc81b6',
-      name: 'Porsche 908',
-      manufacturer: 'Porsche',
-      year: 1968,
-      user_id: '5cd5308e695db945d3cc81a2',
-      createdAt: "2021-04-02T00:00:00.000Z",
-      updatedAt: "2021-04-02T00:00:00.000Z"
-    },
-    {
-      _id: '5cd5308e695db945d3cc81b7',
-      name: 'Porsche 914',
-      manufacturer: 'Porsche',
-      year: 1969,
-      user_id: '5cd5308e695db945d3cc81a1',
-      createdAt: "2021-04-02T00:00:00.000Z",
-      updatedAt: "2021-04-02T00:00:00.000Z"
-    },
-    {
-      _id: '5cd5308e695db945d3cc81b8',
-      name: 'Porsche 917',
-      manufacturer: 'Porsche',
-      year: 1969,
-      user_id: '5cd5308e695db945d3cc81a2',
-      createdAt: "2021-04-02T00:00:00.000Z",
-      updatedAt: "2021-04-02T00:00:00.000Z"
-    },
-    {
-      _id: '5cd5308e695db945d3cc81b9',
-      name: 'Porsche 924',
-      manufacturer: 'Porsche',
-      year: 1976,
-      user_id: '5cd5308e695db945d3cc81a2',
-      createdAt: "2021-04-02T00:00:00.000Z",
-      updatedAt: "2021-04-02T00:00:00.000Z"
-    },
-    {
-      _id: '5cd5308e695db945d3cc81c1',
-      name: 'Porsche Macan',
-      manufacturer: 'Porsche',
-      year: 2014,
-      user_id: '5cd5308e695db945d3cc81a2',
-      createdAt: "2021-04-02T00:00:00.000Z",
-      updatedAt: "2021-04-02T00:00:00.000Z"
-    },
-    {
-      _id: '5cd5308e695db945d3cc81c2',
-      name: 'Ferrari 212 Inter',
-      manufacturer: 'Ferrari',
-      year: 1951,
-      user_id: '5cd5308e695db945d3cc81a1',
-      createdAt: "2021-04-02T00:00:00.000Z",
-      updatedAt: "2021-04-02T00:00:00.000Z"
-    },
-    {
-      _id: '5cd5308e695db945d3cc81c3',
-      name: 'Ferrari 250 MM',
-      manufacturer: 'Ferrari',
-      year: 1952,
-      user_id: '5cd5308e695db945d3cc81a2',
-      createdAt: "2021-04-02T00:00:00.000Z",
-      updatedAt: "2021-04-02T00:00:00.000Z"
-    },
-    {
-      _id: '5cd5308e695db945d3cc81c4',
-      name: 'Ferrari 250 GT Coupé',
-      manufacturer: 'Ferrari',
-      year: 1954,
-      user_id: '5cd5308e695db945d3cc81a1',
-      createdAt: "2021-04-02T00:00:00.000Z",
-      updatedAt: "2021-04-02T00:00:00.000Z"
-    },
-    {
-      _id: '5cd5308e695db945d3cc81c5',
-      name: 'Ferrari 250 GT Berlinetta SWB',
-      manufacturer: 'Ferrari',
-      year: 1959,
-      user_id: '5cd5308e695db945d3cc81a2',
-      createdAt: "2021-04-02T00:00:00.000Z",
-      updatedAt: "2021-04-02T00:00:00.000Z"
-    },
-    {
-      _id: '5cd5308e695db945d3cc81c6',
-      name: 'Ferrari 250 GT 2+2',
-      manufacturer: 'Ferrari',
-      year: 1960,
-      user_id: '5cd5308e695db945d3cc81a1',
-      createdAt: "2021-04-02T00:00:00.000Z",
-      updatedAt: "2021-04-02T00:00:00.000Z"
-    },
-    {
-      _id: '5cd5308e695db945d3cc81c7',
-      name: 'Ferrari 250 GTO',
-      manufacturer: 'Ferrari',
-      year: 1962,
-      user_id: '5cd5308e695db945d3cc81a2',
-      createdAt: "2021-04-02T00:00:00.000Z",
-      updatedAt: "2021-04-02T00:00:00.000Z"
-    },
-    {
-      _id: '5cd5308e695db945d3cc81c8',
-      name: 'Ferrari 250 GT Lusso',
-      manufacturer: 'Ferrari',
-      year: 1962,
-      user_id: '5cd5308e695db945d3cc81a1',
-      createdAt: "2021-04-02T00:00:00.000Z",
-      updatedAt: "2021-04-02T00:00:00.000Z"
-    },
-    {
-      _id: '5cd5308e695db945d3cc81c9',
-      name: 'Ferrari 488',
-      manufacturer: 'Ferrari',
-      year: 1969,
-      user_id: '5cd5308e695db945d3cc81a2',
-      createdAt: "2021-04-02T00:00:00.000Z",
-      updatedAt: "2021-04-02T00:00:00.000Z"
-    },
-    {
-      _id: '5cd5308e695db945d3cc81d1',
-      name: 'Ferrari 275',
-      manufacturer: 'Ferrari',
-      year: 1964,
-      user_id: '5cd5308e695db945d3cc81a2',
-      createdAt: "2021-04-02T00:00:00.000Z",
-      updatedAt: "2021-04-02T00:00:00.000Z"
-    },
-    {
-      _id: '5cd5308e695db945d3cc81d2',
-      name: 'Ferrari 250 LM',
-      manufacturer: 'Ferrari',
-      year: 1964,
-      user_id: '5cd5308e695db945d3cc81a2',
-      createdAt: "2021-04-02T00:00:00.000Z",
-      updatedAt: "2021-04-02T00:00:00.000Z"
-    }
-  ]);
-
-  // Create Blocked
-  await models.Blocked.insertMany([
-    {
-      _id: '5cd5308e695db945d3cc81c1',
-      blocked_id: '5cd5308e695db945d3cc81a1',
-      blocked_model: 'User'
-    },
-    {
-      _id: '5cd5308e695db945d3cc81c2',
-      blocked_id: '5cd5308e695db945d3cc81b1',
-      blocked_model: 'Car'
-    }
-  ]);
-
-  console.log('Done!');
-});

package/models/blocked.js

@@ -1,17 +0,0 @@
-const mongoose = require('mongoose');
-const Schema = mongoose.Schema;
-
-const BlockedSchema = new Schema({
-  blocked_id: {
-    type: Schema.Types.ObjectId,
-    required: true,
-    refPath: 'blocked_model'
-  },
-  blocked_model: {
-    type: String,
-    required: true,
-    enum: ['User', 'Car']
-  }
-});
-
-module.exports = mongoose.model('Blocked', BlockedSchema, 'blocked');

package/models/car.js

@@ -1,26 +0,0 @@
-const mongoose = require('mongoose');
-const Schema = mongoose.Schema;
-
-const CarSchema = new Schema({
-  user_id: {
-    type: Schema.Types.ObjectId,
-    ref: 'User'
-  },
-  name: {
-    type: String
-  },
-  manufacturer: {
-    type: String
-  },
-  year: {
-    type: Number
-  },
-  createdAt: {
-    type: Date
-  },
-  updatedAt: {
-    type: Date
-  }
-});
-
-module.exports = mongoose.model('Car', CarSchema, 'cars');

package/models/user.js

@@ -1,25 +0,0 @@
-const mongoose = require('mongoose');
-const Schema = mongoose.Schema;
-
-const UserSchema = new Schema({
-  firstname: {
-    type: String
-  },
-  lastname: {
-    type: String
-  },
-  birthdate: {
-    type: Date
-  },
-  rating: {
-    type: Number
-  },
-  createdAt: {
-    type: Date
-  },
-  updatedAt: {
-    type: Date
-  }
-});
-
-module.exports = mongoose.model('User', UserSchema, 'users');