Gathering detailed insights and metrics for ajv-openapi-compile
Generate a compiled AJV validation module from an OpenAPI definition.
Installations
npm install ajv-openapi-compileDeveloper Guide
BETA
Typescript
No
Module System
ESM
Node Version
16.9.0
NPM Version
7.24.1
Score
64.1
Supply Chain
96.5
Quality
73.8
Maintenance
100
Vulnerability
85.1
License
Releases
Unable to fetch releases
Contributors
1
Unable to fetch Contributors
Languages
1
JavaScript
JavaScript (100%)
Developer
saibotsivad
Download Statistics
Total Downloads
2,078
Last Day
1
Last Week
6
Last Month
42
Last Year
286
GitHub Statistics
2 Stars
33 Commits
1 Forks
3 Watching
1 Branches
1 Contributors
Bundle Size
666.15 kB
Minified
194.06 kB
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
0.0.14
Package Id
ajv-openapi-compile@0.0.14
Unpacked Size
24.35 kB
Size
5.52 kB
File Count
9
NPM Version
7.24.1
Node Version
16.9.0
Total Downloads
Cumulative downloads
Total Downloads
2,078
Last day
0%
1
Compared to previous day
Last week
500%
6
Compared to previous week
Last month
425%
42
Compared to previous month
Last year
-44.8%
286
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
8
Dev Dependencies
3
Versions
ajv-openapi-compile
Given an OpenAPI definition, compile into AJV validation modules to be used in environments (like Cloudflare Workers) where eval is not available, or a single JavaScript file is desired.
Install
The normal way:
1npm install ajv-openapi-compile --save-dev
Build With It
You can use the CLI tool, as part of your build process:
1ajv-openapi-compile --definition=/path/to/openapi.json \ 2 --output=/path/to/compiled.js \ 3 --tree=/path/to/tree.js
You can also use in your build scripts:
1import { compile } from 'ajv-openapi-compile'
2import { readFile, writeFile } from 'node:fs'
3const definition = JSON.parse(await readFile('/path/to/openapi.json', 'utf8'))
4const { code, tree } = await compile(definition)
5await writeFile('/path/to/compiled.js', code, 'utf8')
6await writeFile('/path/to/tree.js', tree, 'utf8')The output from the compile function contains the code property, which has all imports/requires resolved and concatenated into the single string.
Use Built Code
The compiled code is an ES string, and exports schema as the default, which is a map of schema identifiers to validation functions.
If you know the fully-resolved schema id, you can access the validation function explicitly:
1import schemas from '/path/to/compiled.js' 2const validate = schemas['#/components/schema/error'] 3const valid = validate({ code: 404 }) 4if (!valid) console.log(validate.errors)
Note: The schema identifiers are escaped using the JSON Pointer (RFC6901) specs, which turns
~into~0and/into~1.
If you don't know the fully-resolved schema id, you can use something like pointer-props to navigate the structure and resolve to the correct id:
1import { resolve, toPointer } from 'pointer-props' 2import { readFile } from 'node:fs' 3import schemas from '/path/to/compiled.js' 4const definition = JSON.parse(await readFile('/path/to/openapi.json', 'utf8')) 5// lookup the id 6const id = resolve(definition, '#/path/to/schema') // => '/path/to/fully/resolved/schema' 7// note the relative reference requires "#" as the prefix 8const validate = schemas['#' + id] 9const valid = validate({ code: 404 }) 10if (!valid) console.log(validate.errors)
CLI ajv-openapi-compile
The CLI takes the following parameters:
---definition, -d(String) - The path to the definition JSON file.---output, -o(String) - The path to write the compiled AJV validation code.
For convenience and compatability with other tooling, the definition parameter also supports importing JavaScript files, and will follow this algorithm:
- If the file extension is
.jsonread and parse as JSON - If the file extension is
.yamlor.ymlread and parse as YAML (usingjs-yamlinternally) - Otherwise, attempt importing
* as schema - If
schema.definitionis set, use that - Otherwise, try using
schema - Otherwise, try importing the default as
schemaand try that
To be considered valid, the imported schema definition must have a paths object, with at least one "Path Object" defined.
API: function(definition: Object) => { code: String }
The function simply takes a valid OpenAPI 3.x object.
It returns an object with the following properties:
code: String- The compiled code, with allimportandrequirestatements resolved and placed inline.
License
Published and released under the Very Open License.
If you need a commercial license, contact me here.
No vulnerabilities found.
No security vulnerabilities found.