npmpackage.info

Gathering detailed insights and metrics for joi-key-extensions

Other packages similar to joi-key-extensions

jke-next

2.0.2

Joi Key Extensions provides extensions to the [Joi](https://github.com/hapijs/joi) validation library that allow validation of: * Foreign key style relationships, where a value must be a reference to a value elsewhere in an object tree. Unlike the Joi

joi-key-extensions

Joi Key Extensions provides extensions to the Joi validation library for foreign key style references and primary key integrity

2.0.2

MIT

JavaScript

1.84 kB

4,239 2.1

Installations

npm install joi-key-extensions

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

10.24.1

NPM Version

6.14.12 Score

73.9

Supply Chain

98.9

Quality

75.7

Maintenance

100

Vulnerability

99.6

License

Pull Requests

Open

0

Total

4

Closed

2

Merged

2

Issues

Open

1

Total

3

Closed

2

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View All 1 Contributors

Languages

JavaScript

JavaScript (100%)

validate.email 🚀

Verify real, reachable, and deliverable emails with instant MX records, SMTP checks, and disposable email detection.

Developer

hermetic-architecture-portal

Download Statistics

Total Downloads

4,239

Last Day

Last Week

Last Month

Last Year

564

GitHub Statistics

MIT License

1 Stars

15 Commits

2 Watchers

5 Branches

1 Contributors

Updated on Sep 01, 2021

Bundle Size

5.65 kB

Minified

1.84 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

2.0.2

Package Id

joi-key-extensions@2.0.2

Unpacked Size

49.49 kB

Size

10.47 kB

File Count

NPM Version

6.14.12

Node Version

10.24.1

Total Downloads

Cumulative downloads

Total Downloads

4,239

Last Day

Compared to previous day

Last Week

33.3%

Compared to previous week

Last Month

-68.8%

Compared to previous month

Last Year

-13.1%

564

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@babel/cli @babel/core @babel/preset-env eslint eslint-config-airbnb-base eslint-plugin-import eslint-plugin-jest jest joi

Joi Key Extensions

Joi Key Extensions provides extensions to the Joi validation library that allow validation of:

Foreign key style relationships, where a value must be a reference to a value elsewhere in an object tree. Unlike the Joi built in built in ref validation, it can traverse arrays to look up references
Primary key values, validating that a set of keys are unique within an array of objects

fkExtension

Usage

1npm install --save joi-key-extensions

1const VanillaJoi = require('joi');
2const { fkExtension } = require('joi-key-extensions');
3
4// add the extension to Joi
5const Joi = VanillaJoi.extend(fkExtension.string);
6
7const makeSchema = Joi.object({
8  makeId: Joi.string(),
9  name: Joi.string(),
10});
11
12const modelSchema = Joi.object({
13  modelId: Joi.string(),
14  name: Joi.string(),
15  makeId: Joi.string()
16    // define the foreign key reference
17    .fk('makes.[].makeId'),
18});
19
20const schema = Joi.object({
21  makes: Joi.array().items(makeSchema),
22  models: Joi.array().items(modelSchema),
23});
24
25console.log('Examples with valid data');
26
27const data = {
28  makes: [
29    { makeId: 'ford', name: 'Ford' },
30    { makeId: 'mazda', name: 'Mazda' },
31  ],
32  models: [
33    { modelId: 'laser', name: 'Laser', makeId: 'ford' },
34    { modelId: 'familia', name: 'Familia', makeId: 'mazda' },
35  ],
36};
37
38console.log('Validating whole object tree');
39let validationResult = schema.validate(data, {
40  context: {
41    data, // pass whole object tree as context.data
42    schema, // pass schema of whole object tree as context.schema
43  },
44});
45
46console.log(validationResult.error);
47// null - no error
48
49console.log('Validating one model out of the object tree');
50validationResult = modelSchema.validate(data.models[0], {
51  context: {
52    data,
53    schema,
54  },
55});
56
57console.log(validationResult.error);
58// null - no error
59
60console.log('Examples with invalid data');
61
62data.models[0].makeId = 'fnord';
63
64console.log('Validating whole object tree');
65validationResult = schema.validate(data, {
66  context: {
67    data,
68    schema,
69  },
70});
71
72console.log(validationResult.error);
73// { ValidationError: child "models" fails because
74// ["models" at position 0 fails because
75//   [child "makeId" fails because
76//     ["makeId" "fnord" could not be found as a reference to "makes.[].makeId"]]]...
77
78console.log('Validating one model out of the object tree');
79validationResult = modelSchema.validate(data.models[0], {
80  context: {
81    data,
82    schema,
83  },
84});
85
86console.log(validationResult.error);
87// { ValidationError: child "makeId" fails because
88// ["makeId" "fnord" could not be found as a reference to "makes.[].makeId"]...
89
90

API

`Joi.string().fk(args)`

`Joi.date().fk(args)`

`Joi.number().fk(args)`

Requires that a field value must be a reference to a value elsewhere in the object tree.

In the simplest case args is a string with a dot seperated list of object fields, with search across an array identified by square brackets ([]).

E.g. Joi.number().fk('species.[].speciesId') requires that the value must match the speciesId field in one of the items in the species array field.

The extension also supports multi-part foreign keys. E.g.

1const animalSchema = Joi.object({
2  animalId: Joi.string(),
3  // genusId must correspond to an element in the genus array, matching on the genusId field
4  genusId: Joi.string().fk('genus.[].genusId'),
5  // speciesId must correspond to an element in the species array belonging to the genus element
6  // identified by the genusId field
7  speciesId: Joi.string().fk('genus.[].species.[].speciesId', { parentFieldName: 'genusId' }),
8});

Refer to __tests__ /fkExtension.text.js for more examples

pkExtension

Usage

1npm install --save joi-key-extensions

1const VanillaJoi = require('joi');
2const { pkExtension } = require('joi-key-extensions');
3
4// add the extension to Joi
5const Joi = VanillaJoi
6  .extend(pkExtension.number)
7  .extend(pkExtension.array);
8
9const countrySchema = Joi.object({
10  countryId: Joi.number().pk(),
11  countryName: Joi.string(),
12});
13
14const schema = Joi.object({
15  countries: Joi.array()
16    .items(countrySchema)
17    .uniqueOnPks(),
18});
19
20const data = {
21  countries: [
22    { countryId: 1, countryName: 'Estonia' },
23    { countryId: 2, countryName: 'Uruguay' },
24  ],
25};
26
27console.log('Example with valid data');
28
29let validationResult = schema.validate(data, {
30  context: {
31    data, // pass whole object tree as context.data
32    schema, // pass schema of whole object tree as context.schema
33  },
34});
35
36console.log(validationResult.error);
37// null - no error
38
39console.log('Example with invalid data');
40
41data.countries.push({ countryId: 1, countryName: 'Fiji' });
42
43validationResult = schema.validate(data, {
44  context: {
45    data,
46    schema,
47  },
48});
49
50console.log(validationResult.error);
51// null - no error
52// { ValidationError: child "countries" fails because
53// ["countries" There is a duplicate value at path countries for keys {"countryId":1}]
54

API

`Joi.string().pk()`

`Joi.number().pk()`

`Joi.date().pk()`

Identifies that the field is part of a primary key (composed of one or more fields).

`Joi.array().uniqueOnPks()`

Requires that the elements of the array must be unique with respect to their primary key fields

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.1

/10

Last Scanned on 2025-03-10

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More