BasicMongooseCrud

This repository contains a set of common utilities for creating CRUD (Create, Read, Update, Delete) routes and controllers using Mongoose with TypeScript.

Tests has been made using mongoose version 5.11.8.

Installation

$ npm install @ferracinitec/basic-mongoose-crud

Importing

import basicMongooseCrud from '@ferracinitec/basic-mongoose-crud'

import { CreateCommonController, createCommonRoute } from '@ferracinitec/basic-mongoose-crud'

Example

This example provides a URL <your site>/mobile with the HTTP verbs GET (all records using / or /[id] for a specific one), POST, PUT, DELETE, COPY, and PATCH.

import express from 'express'
import basicMongooseCrud from '@ferracinitec/basic-mongoose-crud'
import mobile from './mongoose-schemas/mobile.js'

// Create a public router
const publicRouter = express.Router()

// Create a controller and define a route for GET, POST, PUT, DELETE.
const mobileController = basicMongooseCrud.create(publicRouter, '/mobile', mobile)

import express from 'express'
import { CreateCommonController, createCommonRoute } from '@ferracinitec/basic-mongoose-crud'
import mobile from './mongoose-schemas/mobile.js'

// Create a public router
const publicRouter = express.Router()

// Create a controller
const mobileController = new CreateCommonController(mobile)

// Define a route for GET, POST, PUT, DELETE
createCommonRoute(publicRouter, '/mobile', mobileController)

Custom Controller

To create a custom controller, you should extend the CreateCommonController class and override the following methods:

verbGetMiddleware: Executed after the find in verbGet, receiving an array with mongoose models. The data can be modified and must be returned.
verbGetByIdMiddleware: Same as the verbGetMiddleware, but executed in verbGetById and receives and returns a single model.
preUpdateMiddleware: Before the update in verbPut. Receives the ID and the parameters. Must return the parameters to update.
postUpdateMiddleware: After the update in verbPut. Receives the updated model to execute other actions. Must return a model.
postInsertMiddleware: After the insert in verbPost. Receives the new model to execute other actions. Must return a model.
verbGet: Returns an array with the documents searched according to the provided filter.
verbGetById: Returns a single model, according to the ID given in the URL.
verbPost: Inserts a new model, according to the parameters in the body.
verbPut: Updates a model found according to the ID given in the URL with data in the body.
verbDelete: Deletes a model found according to the ID given in the URL.
verbCopy: Does nothing. Needs implementation.
verbPatch: Does nothing. Needs implementation.

Documentation

HTTP Verb GET

A filter can be executed by passing any field of the document in a URL.

const token = 'a Bearer token'
const headers: Headers = new Headers()
headers.append('Authorization', `Bearer ${token}`)

const config = {
	method: 'get',
	mode: 'cors',
	headers: headers,
	redirect: 'follow'
}

const params = new URLSearchParams()
params.append('manufacturer', 'motorola')

const url = `http://localhost/mobile?${params.toString()}`
fetch(url, config)
.then(response => response.json())
.then(data => {
	...
})
.catch(error => console.log('[getDevices]', error))

Regular expressions can be used like this:

const token = 'a Bearer token'
const headers: Headers = new Headers()
headers.append('Authorization', `Bearer ${token}`)

const config = {
	method: 'get',
	mode: 'cors',
	headers: headers,
	redirect: 'follow'
}

const params = new URLSearchParams()
params.append('manufacturer__regex', '[Mm]otorola')

const url = `http://localhost/mobile?${params.toString()}`
fetch(url, config)
.then(response => response.json())
.then(data => {
	...
})
.catch(error => console.log('[getDevices]', error))

Also JSON-specific commands:

const token = 'a Bearer token'
const headers: Headers = new Headers()
headers.append('Authorization', `Bearer ${token}`)

const config = {
	method: 'get',
	mode: 'cors',
	headers: headers,
	redirect: 'follow'
}

const params = new URLSearchParams()
params.append('manufacturer__json', JSON.stringify({
	"$in": [
		"motorola",
		"apple"
	]
}))

const url = `http://localhost/mobile?${params.toString()}`
fetch(url, config)
.then(response => response.json())
.then(data => {
	...
})
.catch(error => console.log('[getDevices]', error))

To populate submodels, use `__populate`:

const token = 'a Bearer token'
const headers: Headers = new Headers()
headers.append('Authorization', `Bearer ${token}`)

const config = {
	method: 'get',
	mode: 'cors',
	headers: headers,
	redirect: 'follow'
}

const params = new URLSearchParams()
params.append('manufacturer', 'motorola')
params.append('__populate', JSON.stringify([
	{path: "models"}
]))

const url = `http://localhost/mobile?${params.toString()}`
fetch(url, config)
.then(response => response.json())
.then(data => {
	...
})
.catch(error => console.log('[getDevices]', error))

Also use

__fields to determine a list of fields to display;
__sort for sorting results
__limit to limit the number of results. Should be used with __skip for pagination.
__skip to skip registers. Should be used with __limit for pagination.

To retrieve a specific document

Pass the document ID in the URL.

const token = 'a Bearer token'
const headers: Headers = new Headers()
headers.append('Authorization', `Bearer ${token}`)

const config = {
	method: 'get',
	mode: 'cors',
	headers: headers,
	redirect: 'follow'
}

const url = `http://localhost/mobile/${device._id}`
fetch(url, config)
.then(response => response.json())
.then(data => {
	...
})
.catch(error => console.log('[getDevices]', error))

HTTP Verb POST

To create a new document, perform a POST request to the URL and pass the document in the request body.

const url = 'http://localhost/mobile'
const token = 'a Bearer token'

const headers: Headers = new Headers()
headers.append('Authorization', `Bearer ${token}`)
headers.append('Content-Type', 'application/json')

const config = {
	method: 'post',
	mode: 'cors',
	headers: headers,
	redirect: 'follow',
	body: JSON.stringify({
		manufacture: 'motorola',
		model: 'Moto Gx',
	})
}

fetch(url, config)
.then(response => response.json())
.then(data => setDevice(data))
.catch(error => console.log('[saveDeviceInfo]', error))

HTTP Verb PUT

To update a document, perform a PUT request to the URL, passing the document ID in URL and the fields to be updated in the request body.

const id = device._id
const url = `http://localhost/mobile/${id}`
const token = 'a Bearer token'

const headers: Headers = new Headers()
headers.append('Authorization', `Bearer ${token}`)
headers.append('Content-Type', 'application/json')

const config = {
	method: 'put',
	mode: 'cors',
	headers: headers,
	redirect: 'follow',
	body: JSON.stringify({
		model: 'Moto Gxyz',
	})
}

fetch(url, config)
.then(response => response.json())
.then(data => setDevice(data))
.catch(error => console.log('[saveDeviceInfo]', error))

HTTP Verb DELETE

To delete a document, perform a DELETE request to the URL passing the document ID in the URL.

const id = device._id
const url = `http://localhost/mobile/${id}`
const token = 'a Bearer token'

const headers: Headers = new Headers()
headers.append('Authorization', `Bearer ${token}`)
headers.append('Content-Type', 'application/json')

const config = {
	method: 'delete',
	mode: 'cors',
	headers: headers,
	redirect: 'follow',
}

fetch(url, config)
.then(response => response.json())
.then(data => setDevice(data))
.catch(error => console.log('[saveDeviceInfo]', error))

frddrt / basic-mongoose-crud Goto Github PK