Installations

npm install joi-openapi

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=14.16.1

Node Version

18.12.1

NPM Version

8.19.2 Score

76.4

Supply Chain

90.3

Quality

76

Maintenance

100

Vulnerability

99.3

License

Pull Requests

Open

1

Total

9

Closed

0

Merged

8

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Contributors

4

Unable to fetch Contributors

View all 4 contributors

Languages

1

JavaScript

JavaScript (100%)

Developer

sdrubolo

Download Statistics

Total Downloads

156,943

Last Day

79

Last Week

276

Last Month

1,459

Last Year

23,449

GitHub Statistics

6 Stars

77 Commits

5 Forks

1 Watching

1 Branches

4 Contributors

Bundle Size

264.74 kB

Minified

81.42 kB

Minified + Gzipped

Bundlephobia

Maintainers

1

Package Meta Information

Latest Version

3.2.1

Package Id

joi-openapi@3.2.1

Unpacked Size

245.36 kB

Size

34.02 kB

File Count

52

NPM Version

8.19.2

Node Version

18.12.1

Publised On

14 Feb 2023

Total Downloads

Cumulative downloads

Total Downloads

156,943

Last day

41.1%

79

Compared to previous day

Last week

-15.1%

276

Compared to previous week

Last month

2%

1,459

Compared to previous month

Last year

-21.9%

23,449

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

4

joi deepcopy lodash lodash.find

Dev Dependencies

16

chai chai-as-promised chai-subset sinon sinon-chai mocha mocha-steps eslint eslint-config-airbnb-base eslint-config-prettier eslint-plugin-chai-friendly eslint-plugin-import eslint-plugin-mocha eslint-plugin-prettier prettier prettier-eslint

Versions

joi-openapi

This is a fork of joi-to-openapi with some new options. In short, in this package I've added joi extensions as supported type.

Now the library support to outputs for converted joi: standard output and file.

examples

1const Joi = require("joi");
2const { convert } = require("joi-openapi");
3
4let joi = Joi.extend((joi) => ({
5  base: joi
6    .string()
7    .isoDate()
8    .description("Date in ISO format"),
9  name: "date_start",
10  language: {},
11  rules: [],
12}));
13
14console.log(convert(joi.date_start()));

will output

1{
2  "type": "string",
3  "format": "date-time",
4  "description": "Date in ISO format"
5}

to write the output on a file

1const Joi = require("joi");
2const { convertToFile } = require("joi-openapi");
3
4let joi = Joi.extend((joi) => ({
5  base: joi
6    .string()
7    .isoDate()
8    .description("Date in ISO format"),
9  name: "date_start",
10  language: {},
11  rules: [],
12}));
13
14convertToFile(joi.date_start(), "./");

will output

1{
2  "type": "string",
3  "format": "date-time",
4  "description": "Date in ISO format"
5}

in the date_start.json file (the file will be created by joi type plust json format).

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

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.

2

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Code-Review

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

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

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.

Score

3

/10

Last Scanned on 2025-01-27

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

joi-openapi

Installations

Developer Guide

No

CommonJS

>=14.16.1

18.12.1

8.19.2

Score

Pull Requests

1

9

0

8

Issues

0

0

0

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

Languages

Developer

sdrubolo

Download Statistics

GitHub Statistics

Bundle Size

264.74 kB

81.42 kB

Maintainers

Package Meta Information

Total Downloads

156,943

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

joi-openapi

examples

10

10

10

2

0

0

0

0

0

0

0

0

3

/10

Other packages similar to joi-openapi