# joigoose

> Joi validation for your Mongoose models without the hassle of maintaining two schemas

Latest version **8.0.2** (published 2021-06-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install joigoose
pnpm add joigoose
yarn add joigoose
bun add joigoose
```

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 8.0.2 |
| Published | 2021-06-10 |
| First published | 2015-05-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/joigoose) |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 2 |
| Unpacked size | 18.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 178 |
| Author | Ro Ramtohul |
| Maintainers | yoitsro |
| Keywords | joi, mongoose, validation, schema, model, hapi |

## Links

- npm: https://www.npmjs.com/package/joigoose
- Repository: https://github.com/yoitsro/joigoose
- Issues: https://github.com/yoitsro/joigoose/issues
- npm.io page: https://npm.io/package/joigoose

## Dependencies (2)

- [joi](https://npm.io/package/joi.md) ^17.3.0
- [@hapi/hoek](https://npm.io/package/@hapi/hoek.md) ^9.1.1

## Alternatives

- [angular-pipes](https://npm.io/package/angular-pipes.md) — 5.6K weekly downloads
- [@ng-web-apis/midi](https://npm.io/package/@ng-web-apis/midi.md) — 2.6K weekly downloads
- [happn-3](https://npm.io/package/happn-3.md) — 1.6K weekly downloads
- [@opensip-cli/lang-go](https://npm.io/package/@opensip-cli/lang-go.md) — 1.2K weekly downloads
- [mongoose-typescript](https://npm.io/package/mongoose-typescript.md) — 85 weekly downloads

## Recent versions

- 8.0.2 (latest) — 2021-06-10
- 8.0.1 — 2021-01-13
- 8.0.0 — 2020-08-10
- 7.1.2 — 2020-08-10
- 7.1.1 — 2020-07-07
- 7.1.0 — 2020-06-16
- 7.0.0 — 2020-02-19
- 6.2.0 — 2019-12-11
- 6.1.1 — 2019-12-11
- 6.1.0 — 2019-12-11
- 6.0.0 — 2019-12-11
- 5.0.0 — 2019-12-11
- 4.0.8 — 2019-04-29
- 4.0.6 — 2019-04-29
- 4.0.5 — 2019-04-17
- … 26 more at https://npm.io/package/joigoose/versions

## README

# joigoose

[![npm version](http://img.shields.io/npm/v/joigoose.svg)](https://npmjs.org/package/joigoose)
[![Build Status](https://travis-ci.org/yoitsro/joigoose.svg)](https://travis-ci.org/yoitsro/joigoose)
[![Dependencies Status](https://david-dm.org/yoitsro/joigoose.svg)](https://david-dm.org/yoitsro/joigoose)

> [Joi](https://github.com/hapijs/joi) and [Mongoose](http://mongoosejs.com/) sitting in a tree K-I-S-S-I-N-G...

Joi validation for your Mongoose models without the hassle of maintaining two schemas.

## Installation

⚠️ WARNING! Use the [v7.x.x branch](https://github.com/yoitsro/joigoose/tree/v7.x.x) of Joigoose if you're still using the scoped version of [Joi](https://www.npmjs.com/package/@hapi/joi).

```
npm install joigoose
```

## Usage

### 1. Import Mongoose and Joi

We must pass Mongoose into Joigoose so it knows about ObjectIds and other Mongoose specific stuff:

```javascript
const Mongoose = require("mongoose");
const Joigoose = require("joigoose")(Mongoose);
```

#### With Joi options which apply to all validators:

```javascript
const Mongoose = require("mongoose");
const Joigoose = require("joigoose")(Mongoose, { convert: false });
```

#### With subdocument options to all subdocuments:

```javascript
const Mongoose = require("mongoose");
const Joigoose = require("joigoose")(Mongoose, null, {
  _id: false,
  timestamps: false,
});
```

### 2. Write your Joi schema (see here about how to specify ObjectIds!)

#### Things to know!

Mongoose specific options can be specified in the `meta` object (see below).

Arrays with items of different types will end up with the Mongoose type `Mixed`.
Ideally, Joi schemas shouldn't have to contain Mongoose specific types, such as `Mongoose.Schema.Types.ObjectId` because these Joi schemas may be required to work on frontend clients too.

```javascript
var joiUserSchema = Joi.object({
  name: Joi.object({
    first: Joi.string().required(),
    last: Joi.string().required(),
  }),
  email: Joi.string().email().required(),
  bestFriend: Joi.string().meta({
    _mongoose: { type: "ObjectId", ref: "User" },
  }),
  metaInfo: Joi.any(),
  addresses: Joi.array()
    .items({
      line1: Joi.string().required(),
      line2: Joi.string(),
    })
    .meta({ _mongoose: { _id: false, timestamps: true } }),
});
```

### 3. Convert your Joi schema to a Mongoose-style schema

```javascript
var mongooseUserSchema = new Mongoose.Schema(
  Joigoose.convert(joiUserSchema, options)
);
```

#### Conversion options

Options can be passed to the convert method as an object. Valid options are described below.

| Key     | Type   | Default | Description                                                                                                                 |
| ------- | ------ | ------- | --------------------------------------------------------------------------------------------------------------------------- |
| typeKey | String | "type"  | The name of the key used for [specifying the type](https://mongoosejs.com/docs/guide.html#typeKey) in the generated schema. |

##### Example:

```javascript
{
  typeKey: '$type',
}
```

### 4. Create your model

```javascript
User = Mongoose.model("User", mongooseUserSchema);
```

### 5. Enjoy!

```javascript
var aGoodUser = new User({
  name: {
    first: "Barry",
    last: "White",
  },
  email: "barry@white.com",
  metaInfo: {
    hobbies: ["cycling", "dancing", "listening to Shpongle"],
  },
});

aGoodUser.save(function (err, result) {
  // -> Success!
});

var aBadUser = new User({
  name: {
    first: "Barry",
    last: "White",
  },
  email: "Im not an email address!",
});

aBadUser.save(function (err, result) {
  // -> Error!
  // {
  //     "message": "User validation failed",
  //     "name": "ValidationError",
  //     "errors": {
  //         "email": {
  //             "properties": {
  //                 "type": "user defined",
  //                 "message": "Validator failed for path `{PATH}` with value `{VALUE}`",
  //                 "path": "email",
  //                 "value": "Im not an email address!"
  //             },
  //             "message": "Validator failed for path `email` with value `Im not an email address!`",
  //             "name": "ValidatorError",
  //             "kind": "user defined",
  //             "path": "email",
  //             "value": "Im not an email address!"
  //         }
  //     }
  // }
});
```

## Known Limitations

I didn't spend long writing this, but I've aimed for 100% code coverage. It can be so much better, so help me out!
Submit your [issues and pull requests](https://github.com/yoitsro/joigoose/issues) on [GitHub](https://github.com/yoitsro/joigoose).

- No peer based validation (`and`, `nand`, `or`, `xor`, `with`, `without`, `ref`, `assert`, `alternatives`, `when` etc)
- No `Joi.binary` object type
- No `Joi.func` object type
- No `Joi.in` object type

---
_Source: https://npm.io/package/joigoose · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._