@lpgroup/yup

Collection of yup validation and helper functions for projects based on feathersjs.

Install

Installation of the npm

1npm install @lpgroup/yup

Example

1const yup = require("@lpgroup/yup");
2
3const schema = { key: yup.string().required() };

Hooks

1/* xxx.yup.js */
2const cy = require("@lpgroup/yup");
3
4const requestSchema = {
5  _id: cy.uuid().required(),
6  alias: cy.string().required(),
7  name: cy.string().required(),
8  createdAt: cy.timestamp().defaultNull(),
9  changedAt: cy.timestamp().defaultNull(),
10};
11
12const dbSchema = {
13  added: cy.changed(),
14  changed: cy.changed(),
15  owner: cy.owner(),
16};
17
18module.exports = cy.buildValidationSchema(requestSchema, dbSchema);
19module.exports.requestSchema = requestSchema;

1/* xxx.service.js */
2const { Xxx } = require("./xxx.class");
3const hooks = require("./xxx.hooks");
4const schema = require("./xxx.yup");
5
6module.exports = (app) => {
7  const options = { id: "alias", schema };
8  app.use("/xxx", new Xxx(options, app));
9  const service = app.service("xxx");
10  service.hooks(hooks);
11};

1/* xxx.hooks.js */
2const { validReq } = require("@lpgroup/yup");
3const { validDB } = require("@lpgroup/yup");
4
5module.exports = {
6  before: {
7    create: [validReq(), changeData(), validDB()],
8    update: [validReq(), changeData(), validDB()],
9    patch: [validReq(), changeData(), validDB()],
10  },
11};

API

general

hooks

validReq(objSchema)

1validReq(xxx);

validDB(objSchema)

1validDB(xxx);

yup.array(objSchema)

1const schema = { key: yup.array({ key: yup.string() }).required() };

Development

When developing this NPM your can patch yup to give better error message.

1npm run patch-package

Contribute

See contribute

License

MIT - See licence