Releases: ShaggyTech/nhtsa-api-wrapper
v3.0.4
What's Changed
@shaggytools/nhtsa-api-wrapper
See - https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/packages/lib/CHANGELOG.md
Docs
See - https://github.com/ShaggyTech/nhtsa-api-wrapper/blob/main/apps/docs/CHANGELOG.md
v3.0.3
What's Changed
@shaggytools/nhtsa-api-wrapper
- refactor(api): rename useNHTSA.cacheUrl -> useNHTSA.createCachedUrl by @ShaggyTech in b428557
Docs
- docs: fix Vercel preview deployments by @ShaggyTech in #518
- fix(coverage): rename folder alias for .vitest folder to '.vitest' by @ShaggyTech in #519
- chore(deps): update dependency typedoc to v0.24.4 by @renovate in #493
Full Changelog: https://github.com/ShaggyTech/nhtsa-api-wrapper/compare/v3.0.2...@shaggytools/[email protected]
v3.0.2
3.0.2 (2023-04-15)
Version 3 release notes
Completely rewritten the entire project to be more modular and easier to maintain.
This is a major release and will require some changes to your code.
Please see the README for more information on how to use the latest version of this package.
@shaggytools/nhtsa-api-wrapper
- The @shaggytools/nhtsa-api-wrapper package is now part of a larger monorepo that includes the documentation and configiuration for the project.
- The package source can now be found in the packages/lib directory.
- We have switched to bundling with Vite and no longer use Rollup directly.
- Documentation has been moved to the apps/docs directory.
- Documentation is now built with Vitepress with help from the typedoc-plugin-markdown plugin.
Breaking Changes when upgrading from v2.x.x
- The 'actions' are now referred to in the documentation as 'endpoints'. (e.g. 'DecodeVin' and 'GetAllMakes', etc.)
The following changes are breaking and will require some changes to your code.
-
The package no longer exports a class that you can instantiate with all of the endpoint methods at once.
-
Each endpoint now has its own method that you can import and use directly.
import { DecodeVin, GetAllMakes } from "@shaggytools/nhtsa-api-wrapper";
const getAllMakesResponse = await GetAllMakes();
const decodeVinResponse = await DecodeVin("1G1YY22G965105609");
- The
fetch
method is no longer polyfilled by default. Node v18+ now supports thefetch
API natively and
the decision was made to not include a polyfill by default so that this package has no packaged dependencies.
If you are using an older version of Node or really old browsers, you will need to polyfill thefetch
API yourself or
use the package as a URL builder for the NHTSA API and use your own HTTP client to make the request.
Please see the documentation for more information on how to do this.
As the package was completely rewritten, there are likely to be other breaking changes that have not been documented here.
We suggest reading through the new documenation to get a better understanding of how to use the package.
Full Changelog: v2.0.3...v3.0.2
What's Changed
- Merge all version 3.0 changes with next branch by @ShaggyTech in #490
- chore(deps): update pnpm to v8 by @renovate in #508
- chore(deps): update actions/checkout action to v2.7.0 by @renovate in #497
- chore(deps): update jamesives/github-pages-deploy-action action to v4.4.1 by @renovate in #502
- chore(deps): update codecov/codecov-action action to v3 by @renovate in #506
- chore(deps): update dependency prettier to v2.8.7 by @renovate in #491
- refactor: complete refactor, breaking changes, merge next -> main in preparation for v3 release, switch to monorepo structure by @ShaggyTech in #514
v2.0.3
2.0.3 (2021-12-26)
What's Changed
- update dependencies
- refactor rollup.config
- build sourcemap files for all builds, excepting IIFE bundle. Erroneously removed in a previous version
- linting fixes after updating eslint to v8
- refactor a few API Action tests to more closely align them with all other action tests
Full Changelog: v2.0.2...v2.0.3