🚀 A RESTful API generator for Node.js

I have a requirement, where I want to allow the users of my service to input any data into my model. Some metadata.

I have tried using Types.Mixed and Types.Object to get past this, but when I make a request, rest-hapi says key is not allowed. I think this was working uptil v 0.20, I recently updated to 0.33.

Thanks in advance.

1. Minor commit to include code-cov as part of dev dependency
2. Support for baseUrl in REST-HAPI
3. pass through hapi-swagger configuration as an option.
4. Support all legacy options, but those get overridden when config.swaggerOptions is set (as per hapi-swagger documentation).
5. Additionally some swaggerOptions are over-written.

Using the recent changes/additions to the middleware, I've been able to have my create, list and find endpoints use the authenticated user's credentials. For example:

      create: {
        pre: function(payload, request, Log) {
          payload.account = request.auth.credentials.account;
          return Promise.resolve(payload);
        },
      },
      list: {
        pre: function(query, request, Log) {
          query.account = request.auth.credentials.account;
          return Promise.resolve(query);
        },
      },

Now I'm working on adding the same functionality to the update endpoint. Currently the update handler simply calls model.findByIdAndUpdate(_id, payload). I propose changing this to:

mongooseQuery = model.findById(_id);
mongooseQuery = QueryHelper.createMongooseQuery(model, query, mongooseQuery, Log);
mongooseQuery.findOneAndUpdate(payload)

This way, the document specified by _id will only be found and updated if it also matches any additional constraints in the query.

I have a proof-of-concept implementation at https://github.com/pangeamedia/rest-hapi/commit/fea600d713dce4f59b92bcb2ac7637399039b017#diff-cae92e718d9d94bbd9debab4fbf43095L734 I've tested this POC in my app, and it works as expected.

The main difficulty is that the update.pre middleware function currently only returns the payload, but I need it to return the query. For the proof-of-concept, I have update.pre return the query as payload.$query. This is not ideal, but it maintains backwards compatibility.

Other ideas I had include update.pre returning an object like { payload: payload, query: query } or an array like [ payload, query ], possibly maintaining backwards compatibility in either case by having the update handler introspect the returned value. I don't know what approach is best.

Thoughts?

Describe the bug I want to get '_MANY' association and rest-hapi return all datas of the model of association

To Reproduce Steps to reproduce the behavior:

1. Create '_MANY' association

associations: {
	companies: {
		type: '_MANY',
		alias: 'companies',
		model: 'companies',
	},
},

2. I am creating companies in the model companies

3. I post an id company in my companies association

4. I get the association companies and response contains all the companies whereas in the companies association i have only one company

{
  "docs": [
    {
      "_id": "5d5cae2e3356752c4f2d4414",
      "subsidiaries": [
        {
          "_id": "5d5cae373356752c4f2d4416",
          "subsidiaries": [],
          "name": "string",
          "naf": "string",
          "siret": "string",
          "createdBy": "5d5c9e1a6b233e246ad4f611",
          "createdAt": "2019-08-21T02:36:39.450Z",
          "institutions": []
        }
      ],
      "name": "string",
      "naf": "string",
      "siret": "string",
      "createdBy": "5d5c9e1a6b233e246ad4f611",
      "createdAt": "2019-08-21T02:36:30.548Z",
      "institutions": []
    },
    {
      "_id": "5d5cae373356752c4f2d4416",
      "subsidiaries": [],
      "name": "string",
      "naf": "string",
      "siret": "string",
      "createdBy": "5d5c9e1a6b233e246ad4f611",
      "createdAt": "2019-08-21T02:36:39.450Z",
      "institutions": []
    },
    {
      "_id": "5d5ebd0207b9b804f763dc2a",
      "subsidiaries": [],
      "name": "Hey",
      "naf": "string",
      "siret": "string",
      "createdBy": "5d5db71b1c99220acc90ae45",
      "createdAt": "2019-08-22T16:04:18.189Z",
      "institutions": []
    }
  ],
  "pages": {
    "current": 1,
    "prev": 0,
    "hasPrev": false,
    "next": 2,
    "hasNext": false,
    "total": null
  },
  "items": {
    "begin": null,
    "end": null,
    "total": 3
  }
}

Expected behavior getAll request on '_MANY' association should return only the id's of the association and not fulld datas of the corresponding model.

Desktop (please complete the following information):

• OS: OSX
• Browser: Chrome
• Version: 76.0.3809.100

Additional context Sorry for my deplorable English, i hope its comprehensive ! Thanks for your answer.

Hi, First of all thanks for providing awesome module like rest-hapi. I required so many time that if there is somehow i can change or modify the auto created API according to my requirement. Like if i add one flag, if that flag value is true than i call one of my method and than append the result of my method with the result we are going to send to the client. Is this functionality currently exists or not and if exists than would appreciate if you please let me know.

Thanks

Is your feature request related to a problem? Please describe. I'm trying to build a frontend with searchable and sortable tables having one "main" collection with where many of the tables columns are many_one associations.

Simplified example:

MainName | sub1.name | sub1.sub2.name -------------|-------------|------------- name1 |sub1Name1| sub2Name1 name2 |sub1Name2| sub2Name1 name3 |sub1Name1| sub2Name2

I need to be able to filter on the sub fields for now I have to move the data of sub fields to the main collection to accomplish this.

This means that I have a fields in the main collection that has to be updated if the associations name filed is updated and in my project there are even worse nested associations that needs to be accessible from the main field like:

Main.sub1.sub2.sub3.name

And every sub doc has its own table on the frontend. In my solution if sub3.name is updated I now need to update every parent after each other in order and doing this in with the update: {post: () => RestHapi.update() } and update: {pre: () => payloade.subName = ... } middleware on each layer.

sub3.model

update: {
  post: async function (request, result, Log) {
    // get sub2s that has sub3s
    const sub2s = await mongoose
      .model("sub2")
      .find({ sub3: result._id });
    
    // uppdate sub2
    await Promise.all(
      sub2s.map(sub2=> 
        RestHapi.update('sub2', sub2._id, {sub3: result._id})
      )
    )
  }
}

sub2.model

update: {
  pre: async function(_id, payload, request, Log) {
    // uppdates sub3 name
    if(payload.sub3) {
      const sub3= await mongoose
        .model("sub3")
        .findOne({ _id: payload.sub3});

      payload.sub3Name = sub3.name;
    }

    return payload
  },
  post: async function (request, result, Log) {
    // get sub1s that has sub2s
    const sub1s = await mongoose
      .model("sub1")
      .find({ sub2: result._id });
    
    // uppdate sub1
    await Promise.all(
      sub1s.map(sub1=> 
        RestHapi.update('sub1', sub1._id, { sub2: result._id })
      )
    )
  }
}

sub1.model

update: {
  pre: async function(_id, payload, request, Log) {
    // uppdates sub2 and sub3 name
    if(payload.sub2) {
      const sub2= await mongoose
        .model("sub2")
        .findOne({ _id: payload.sub2});

      payload.sub3Name = sub2.sub3Name;
      payload.sub2Name = sub2.name;
    }

    return payload
  },
  post: async function (request, result, Log) {
    // get mains that has sub1s
    const mains = await mongoose
      .model("main")
      .find({ sub1: result._id });
    
    // uppdate sub1
    await Promise.all(
      mains.map(main => 
        RestHapi.update('main ', main ._id, { sub1: result._id })
      )
    )
  }
}

main.model

update: {
  pre: async function(_id, payload, request, Log) {
    // uppdates sub1, sub2 and sub3 name
    if(payload.sub1) {
      const sub1= await mongoose
        .model("sub1")
        .findOne({ _id: payload.sub1});

      payload.sub3Name = sub1.sub3Name;
      payload.sub2Name = sub1.sub2Name;
      payload.sub1Name = sub1.name;
    }

    return payload
  },
  post: async function (request, result, Log) {
    // get mains that has sub1s
    const mains = await mongoose
      .model("main")
      .find({ sub1: result._id });
    
    // uppdate sub1
    await Promise.all(
      mains.map(main => 
        RestHapi.update('main ', main ._id, { sub1: result._id })
      )
    )
  }
}

I'm also setting the "moved fields" on create manually in the create middleware on each layer. and now I'm able to filter and search even on sub3Name from my main collection.

Performance wise this is bad really bad if I have many main documents.. and if any fails I'm screwed.

Describe the solution you'd like I need to be able to search and sort by sub1.name I'm not sure if this is doable at all even on a lower level..

Hi, I want to define indexes in a rest-hapi schema. In ExpressJs we have to define indexes in the schema like that:- var userSchema = new Schema({ name: String, location: { type: {type: String}, coordinates: [] } // field level }); userSchema.index({ location: '2dsphere' }); // schema level

Hi JKHeadley, I am just wondering to know that you create linking models for many to many relationship . And the relationship stores as an array on the same model, so what i am thinking because so many relationship would be there so that document size become heavy. So that will create issue after some time because maximum size of an document we have in Mongo is of 16 MB.

According to me there should be separate collection for the linking models.

So i just want to know your view on this means you are working on it or you see this differently, or i am wrong here please correct me.

Thanks

Describe the bug I am creating a model with an array of string as one of it's properties but I can't insert data there.

To Reproduce Steps to reproduce the behavior:

1. Create a model with one properties as an Array of String

//...
new mongoose.Schema({
    name: Types.String,
    tags: [Types.String]
  });

2. Try to insert some data like

//...
"tags": ["one", "two"]

3. A 400 status code is received :

{
	"statusCode": 400,
	"error": "Bad Request",
	"message": "Invalid request payload input"
}

Expected behavior Tags data should be inserted

Screenshots

Desktop (please complete the following information):

• OS: OSX
• Browser Firefox
• Version 1.3.3

I tried for two hours to start rest-hapi demo project, but failed. Maybe I missed something. Would appreciate help. When node api.js get error:

TypeError: Cannot set property 'Promise' of undefined
    at module.exports (/Users/mike/projects/a_learn/rest-hapi_test/node_modules/rest-hapi/components/mongoose-init.js:11:20)
    at Object.register (/Users/mike/projects/a_learn/rest-hapi_test/node_modules/rest-hapi/rest-hapi.js:67:57)
    at internals.Server.register (/Users/mike/projects/a_learn/rest-hapi_test/node_modules/hapi/lib/server.js:427:35)
    at api (/Users/mike/projects/a_learn/rest-hapi_test/api.js:31:18)
    at Object.<anonymous> (/Users/mike/projects/a_learn/rest-hapi_test/api.js:41:1)
    at Module._compile (module.js:652:30)
    at Object.Module._extensions..js (module.js:663:10)
    at Module.load (module.js:565:32)
    at tryModuleLoad (module.js:505:12)
    at Function.Module._load (module.js:497:3)
    at Function.Module.runMain (module.js:693:10)
    at startup (bootstrap_node.js:188:16)
    at bootstrap_node.js:609:3

My package.json

{
  "name": "rest-hapi_test",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC",
  "dependencies": {
    "hapi": "^17.4.0",
    "mongoose": "^5.1.0",
    "rest-hapi": "^0.43.1"
  }
}

My api.js

'use strict';

let Hapi = require('hapi');
let mongoose = require('mongoose');
let restHapi = require('rest-hapi');

async function api(){

    const server = new Hapi.Server(restHapi.config.server.connection);

    const plugins = [
        {
            name: 'restHapi',
            version: '1.0.0',
            register: restHapi.register,
            options: {
                mongoose: mongoose
            }
        }
    ]

    await server.register(plugins);
    await server.start();
    console.log(`Server running at: ${server.info.uri}`); // eslint-disable-line
}

process.on('unhandledRejection', (err) => {
    console.error(err); // eslint-disable-line
    process.exit(1);
});

api();

P.S. Also tried with canonical example from docs it does not work as well.

Hi there. I keep running into this error when trying to startup my application. I've looked for help in Google, with no luck. Unfortunately i can't share much of the code, but here's the stacktrace:

[18:18:32.087] 47383 NOTE     api/layout/List — Generating List endpoint for layout
[18:18:32.093] 47383 ERROR    node_modules/rest-hapi/utilities/rest-helper-factory.js:98:16 api — Error: TypeError: Cannot read property 'schemaName' of undefined
[18:18:32.093] 47383 ERROR    node_modules/rest-hapi/utilities/rest-helper-factory.js:98:16 api —     at Object.generateJoiModelFromFieldType (/var/www/private/node_modules/rest-hapi/utilities/joi-mongoose-helper.js:213:27)
[18:18:32.093] 47383 ERROR    node_modules/rest-hapi/utilities/rest-helper-factory.js:98:16 api —     at /var/www/private/node_modules/rest-hapi/utilities/rest-helper-factory.js:169:46
[18:18:32.093] 47383 ERROR    node_modules/rest-hapi/utilities/rest-helper-factory.js:98:16 api —     at arrayEach (/var/www/private/node_modules/rest-hapi/node_modules/lodash/index.js:1289:13)
[18:18:32.093] 47383 ERROR    node_modules/rest-hapi/utilities/rest-helper-factory.js:98:16 api —     at Function.<anonymous> (/var/www/private/node_modules/rest-hapi/node_modules/lodash/index.js:3345:13)
[18:18:32.093] 47383 ERROR    node_modules/rest-hapi/utilities/rest-helper-factory.js:98:16 api —     at Object.generateListEndpoint (/var/www/private/node_modules/rest-hapi/utilities/rest-helper-factory.js:168:11)
[18:18:32.093] 47383 ERROR    node_modules/rest-hapi/utilities/rest-helper-factory.js:98:16 api —     at Object.generateRoutes (/var/www/private/node_modules/rest-hapi/utilities/rest-helper-factory.js:51:16)
[18:18:32.093] 47383 ERROR    node_modules/rest-hapi/utilities/rest-helper-factory.js:98:16 api —     at /var/www/private/node_modules/rest-hapi/rest-hapi.js:92:36
[18:18:32.093] 47383 ERROR    node_modules/rest-hapi/utilities/rest-helper-factory.js:98:16 api —     at process.nextTick (/var/www/private/node_modules/hapi/node_modules/hoek/lib/index.js:858:22)
[18:18:32.093] 47383 ERROR    node_modules/rest-hapi/utilities/rest-helper-factory.js:98:16 api —     at _combinedTickCallback (internal/process/next_tick.js:73:7)
[18:18:32.093] 47383 ERROR    node_modules/rest-hapi/utilities/rest-helper-factory.js:98:16 api —     at process._tickCallback (internal/process/next_tick.js:104:9)

Tell me if you need more details. I'm using the latest version of rest-hapi. Thanks.

Bumps json5 from 2.2.1 to 2.2.3.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Bumps qs from 6.5.2 to 6.5.3.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Bumps decode-uri-component from 0.2.0 to 0.2.2.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Bumps decode-uri-component from 0.2.0 to 0.2.2.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Hi @JKHeadley ! 👋

Firstly, thanks for your work on this project! 🙂

Regarding the issue #296. Today I used patch-package to patch [email protected] for the project I'm working on.

Here is the diff that solved my problem:

diff --git a/node_modules/rest-hapi/utilities/handler-helper.js b/node_modules/rest-hapi/utilities/handler-helper.js
index e0334e5..a13b2ed 100644
--- a/node_modules/rest-hapi/utilities/handler-helper.js
+++ b/node_modules/rest-hapi/utilities/handler-helper.js
@@ -148,6 +148,23 @@ async function _listHandler(model, request, Log) {
     if (query.$flatten) {
       flatten = true
     }
+
+    if ( query.$startDate || query.$endDate ) {
+      query.createdAt = {}
+      
+      if ( query.$startDate ) {
+        query.createdAt.$gte = new Date( query.$startDate )
+
+        delete query.$startDate;
+      }
+
+      if ( query.$endDate ) {
+        query.createdAt.$lte = new Date( query.$endDate )
+
+        delete query.$endDate;
+      }
+    }
+
     delete query.$flatten
     const { $embed } = query
     if (query.$count) {
diff --git a/node_modules/rest-hapi/utilities/joi-mongoose-helper.js b/node_modules/rest-hapi/utilities/joi-mongoose-helper.js
index 1a076eb..e230021 100644
--- a/node_modules/rest-hapi/utilities/joi-mongoose-helper.js
+++ b/node_modules/rest-hapi/utilities/joi-mongoose-helper.js
@@ -337,6 +337,8 @@ internals.generateJoiListQueryModel = function(model, logger) {
         .optional()
         .description('An optional field for raw mongoose queries.')
     }
+    queryModel.$startDate = Joi.date().description( 'The start of the date range.' ).optional()
+    queryModel.$endDate = Joi.date().description( 'The end of the date range.' ).optional()
     
     _.each(queryableFields, function(fieldName) {
       const joiModel = internals.generateJoiModelFromFieldType(

This issue body was partially generated by patch-package.

Hello, I've been trying to add the dateRange to rest-hapi querying. And I was wondering if you've had already implemented it or it exists to query with date range for field attribute like "createdAt".