Replace api-schema-builder with AJV to fix lodash.get deprecation #2209
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The api-schema-builder package depends on z-schema which uses the deprecated lodash.get. Replace it with a custom OpenAPI validator built on AJV, which is already a transitive dependency and actively maintained. - Add src/api/validation/openapi-validator.ts with buildSchemaSync() - Update imports in resources/validate.ts and course/index.ts - Add ajv and ajv-formats as direct dependencies - Remove api-schema-builder dependency - Delete obsolete api-schema-builder type declaration
Contributor
Author
|
Forgot to mention - also removes |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR eliminates the
lodash.getdeprecation warning that appears duringnpm install. The warning comes fromapi-schema-builder → z-schema → lodash.get. Rather than waiting for upstream fixes, I replaced api-schema-builder with a lightweight custom validator built on AJV. AJV is already used elsewhere in Signal K (the admin UI uses it via@rjsf/validator-ajv8), so this doesn't introduce any new dependencies to the overall project - it just makes the existing AJV dependency explicit in the server's package.json. The new validator insrc/api/validation/openapi-validator.tsprovides the same interface as api-schema-builder, so the changes to the actual validation code are minimal - just import path updates.Changes
src/api/validation/openapi-validator.ts- custom OpenAPI validator using AJVsrc/api/resources/validate.tsandsrc/api/course/index.tsajvandajv-formatsas direct dependenciesapi-schema-builderdependencyapi-schema-buildertype declaration fileTested with manual API requests to confirms validation still works correctly