Gathering detailed insights and metrics for @apideck/better-ajv-errors
Gathering detailed insights and metrics for @apideck/better-ajv-errors
Human-friendly JSON Schema validation for APIs 👮♀️
Installations
npm install @apideck/better-ajv-errorsDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Min. Node Version
>=10
Node Version
14.17.0
NPM Version
8.6.0
Score
98.6
Supply Chain
89.5
Quality
82.2
Maintenance
100
Vulnerability
99.6
License
Releases
14
Languages
1
TypeScript
TypeScript (100%)
Developer
apideck-libraries
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
43 Stars
62 Commits
9 Forks
5 Watchers
8 Branches
6 Contributors
Updated on Apr 22, 2025
Maintainers
7
Package Meta Information
Latest Version
0.3.6
Package Id
@apideck/better-ajv-errors@0.3.6
Unpacked Size
75.72 kB
Size
13.53 kB
File Count
23
NPM Version
8.6.0
Node Version
14.17.0
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
3
Peer Dependencies
1
@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)
Install
1$ yarn add @apideck/better-ajv-errors
or
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: BetterAjvErrorsOptionserrors: ErrorObject[] | null | undefinedYour ajv errors, you will find these in theerrorsproperty of your ajv instance (ErrorObjectis a type from the ajv package).data: ObjectThe data you passed to ajv to be validated.schema: JSONSchemaThe schema you passed to ajv to validate against.basePath?: stringAn optional base path to prefix paths returned bybetterAjvErrors. 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 ofValidationErrorbelow)message: stringFormatted error messagesuggestion?: stringOptional suggestion based on provided data and schemapath: stringObject path where the error occurred (example:.foo.bar.0.quz)context: { errorType: DefinedError['keyword']; [additionalContext: string]: unknown }errorTypeiserror.keywordproxied fromajv.errorTypecan be used as a key for i18n if needed. There might be additional properties on context, based on the type of error.
Related
- 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.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
Found 2/18 approved changesets -- score normalized to 1
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/main.yml:1
- Warn: no topLevel permission defined: .github/workflows/size.yml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/apideck-libraries/better-ajv-errors/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/apideck-libraries/better-ajv-errors/main.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/apideck-libraries/better-ajv-errors/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/size.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/apideck-libraries/better-ajv-errors/size.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/size.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/apideck-libraries/better-ajv-errors/size.yml/main?enable=pin
- Info: 0 out of 3 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 2 third-party GitHubAction dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'main'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 17 are checked with a SAST tool
Reason
20 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
- Warn: Project is vulnerable to: GHSA-67mh-4wv8-2f99
- Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
- Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
- Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Score
2.6
/10
Last Scanned on 2025-07-07
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