npmpackage.info

Gathering detailed insights and metrics for @apideck/better-ajv-errors

@apideck/better-ajv-errors

Human-friendly JSON Schema validation for APIs 👮‍♀️

0.3.6

MIT

TypeScript

382,408,273 2.6

Installations

npm install @apideck/better-ajv-errors

Score

97.5

Supply Chain

89.5

Quality

81.5

Maintenance

100

Vulnerability

99.6

License

Pull Requests

Open

5

Total

21

Closed

5

Merged

11

Issues

Open

1

Total

8

Closed

7

Releases

v0.3.6

Published on 28 Jun 2022

v0.3.4

Published on 25 May 2022

v0.3.3

Published on 09 Feb 2022

v0.3.2

Published on 23 Dec 2021

v0.3.1

Published on 30 Nov 2021

v0.3.0

Published on 23 Nov 2021

View all 14 releases

Developer

apideck-libraries

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=10

Typescript Support

No

Node Version

14.17.0

NPM Version

8.6.0 Statistics

41 Stars

61 Commits

6 Forks

6 Watching

9 Branches

6 Contributors

Updated on 18 Mar 2024

Languages

TypeScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

382,408,273

Last day

-4.1%

542,911

Compared to previous day

Last week

0.7%

3,042,057

Compared to previous week

Last month

3.1%

13,047,332

Compared to previous month

Last year

8.4%

155,151,524

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

@apideck/better-ajv-errors 👮‍♀️

Human-friendly JSON Schema validation for APIs

Readable and helpful ajv errors
API-friendly format
Suggestions for spelling mistakes
Minimal footprint: 1.56 kB (gzip + minified)

better-ajv-errors output Example

Install

1$ yarn add @apideck/better-ajv-errors

1$ npm i @apideck/better-ajv-errors

Also make sure that you've installed ajv at version 8 or higher.

Usage

After validating some data with ajv, pass the errors to betterAjvErrors

1import Ajv from 'ajv';
2import { betterAjvErrors } from '@apideck/better-ajv-errors';
3
4// Without allErrors: true, ajv will only return the first error
5const ajv = new Ajv({ allErrors: true });
6
7const valid = ajv.validate(schema, data);
8
9if (!valid) {
10  const betterErrors = betterAjvErrors({ schema, data, errors: ajv.errors });
11}

API

betterAjvErrors

Function that formats ajv validation errors in a human-friendly format.

Parameters

options: BetterAjvErrorsOptions
- errors: ErrorObject[] | null | undefined Your ajv errors, you will find these in the errors property of your ajv instance (ErrorObject is a type from the ajv package).
- data: Object The data you passed to ajv to be validated.
- schema: JSONSchema The schema you passed to ajv to validate against.
- basePath?: string An optional base path to prefix paths returned by betterAjvErrors. For example, in APIs, it could be useful to use '{requestBody}' or '{queryParemeters}' as a basePath. This will make it clear to users where exactly the error occurred.

Return Value

ValidationError[] Array of formatted errors (properties of ValidationError below)
- message: string Formatted error message
- suggestion?: string Optional suggestion based on provided data and schema
- path: string Object path where the error occurred (example: .foo.bar.0.quz)
- context: { errorType: DefinedError['keyword']; [additionalContext: string]: unknown } errorType is error.keyword proxied from ajv. errorType can be used as a key for i18n if needed. There might be additional properties on context, based on the type of error.

atlassian/better-ajv-errors was the inspiration for this library. Atlassian's library is more focused on CLI errors, this library is focused on developer-friendly API error messages.

No vulnerabilities found.

10

Binary-Artifacts

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

10

Dangerous-Workflow

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

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

Token-Permissions

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

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

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.6

/10

Last Scanned on 2024-11-25

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

@apideck/better-ajv-errors

Installations

Score

Pull Requests

5

21

5

11

Issues

1

8

7

Releases

Developer

apideck-libraries

Developer Guide

CommonJS

>=10

No

14.17.0

8.6.0

Statistics

Languages

Total Downloads

382,408,273

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

@apideck/better-ajv-errors 👮‍♀️

Install

Usage

API

betterAjvErrors

Parameters

Return Value

Related

10

10

10

1

0

0

0

0

0

0

0

0

0

2.6

/10