abranhe / normalize-mongoose

Normalize Mongoose JSON output

normalize-mongoose

Normalize Mongoose JSON output

This plugin removes the following fields _id, __v, and published virtuals id when the document is converted to JSON. Also it allows you to hide private fields like password.

Install

$ npm install normalize-mongoose

Using Github NPM Registry

$ npm install abranhe@normalize-mongoose

Usage

import mongoose from 'mongoose';
import normalize from 'normalize-mongoose';

const personSchema = mongoose.Schema({
    name: String,
    age: Number,
});

personSchema.plugin(normalize);

See how normalize-mongoose will clean the the JSON output:

From:

{
  "_id": "5dff03d3218b91425b9d6fab",
  "name": "Abraham",
  "__v": 0
}

To:

{
  "id": "5dff03d3218b91425b9d6fab",
  "name": "Abraham"
}

normalize-mongoose comes really handy on real word applications, allowing you to hide from the output any private field previously defined.

import mongoose from 'mongoose';
import normalize from 'normalize-mongoose';

const personSchema = mongoose.Schema({
    name: String,
    age: Number,
    email: String,
    password: { type: String, private: true },
});

personSchema.plugin(normalize);

const Person = mongoose.model('Person', personSchema);
const someone = new Person( {
  name: 'Abraham',
  age: 33,
  email: '[email protected]',
  password: 'my_awesome_password',
});

The above code will output:

{
  "id": "5dff03d3218b91425b9d6fab",
  "name": "Abraham",
  "age": 33,
  "email": "[email protected]"
}

License

MIT © Abraham Hernandez

normalize-mongoose's Issues

transpile exported code

would be easier to consume this package if you transpile it with babel before shipping.

right now I copy pasted it locally because jest is throwing syntax errors

Does not remove all `_ids`

Assume adding this (noted in bold) to your example:

const personSchema = mongoose.Schema({
  name: String,
  age: Number,
  email: String,
  password: { type: String, private: true },
  tracklist: {
    type: [
      {
        track: String,
          title: String,
      }
    ],
    validate: v => Array.isArray(v) && v.length > 0,
  }
});

personSchema.plugin(normalize);

const Person = mongoose.model('Person', personSchema);

const someone = new Person({
  name: 'Abraham',
  age: 33,
  email: '[email protected]',
  password: 'my_awesome_password',
  tracklist: [
    {
      track: "1",
      title: "1"
    },
    {
      track:"2",
      title:"2"
    }]
});

Then the output will still contain _ids:

{
  "name": "Abraham",
  "age": 33,
  "email": "[email protected]",
  "tracklist": [
    {
      "track": "1",
      "title": "1",
      "_id": "6361521b2b1edf8bd136a3f0"
    },
    {
      "track": "2",
      "title": "2",
      "_id": "6361521b2b1edf8bd136a3f1"
    }
  ],
  "id": "6361521b2b1edf8bd136a3ef"
}

Typescript definitions

Any chance of getting typescript definitions so we can use the import without errors. If they exist I can't locate them.
Thanks

Not work with CommonJS module system

const normalize = require("normalize-mongoose");
^

Error [ERR_REQUIRE_ESM]: require() of ES Module D:\Code\FullStack Todo\todo-backend\node_modules\normalize-mongoose\index.js from D:\Code\FullStack Todo\todo-backend\modal.js not supported.
Instead change the require of index.js in D:\Code\FullStack Todo\todo-backend\modal.js to a dynamic import() which is available
in all CommonJS modules.