ShipEngine Connect SDK
⚠WARNING: This is an internal package
This library contains TypeScript type definitions for ShipEngine Connect app developers, as well as internal classes, functions, etc. that's used by the ShipEngine Connect platform for testing, validation, and runtime.
To build/test the library locally on your computer:
Run the build script
npm run buildor
npm run watch
Run the tests
To release a new version of the SDK, use the command below.
npm run release
This will do the following:
- Display any outdated dependencies and prompt you to update them
- Run a security vulnerability audit
- Do a clean re-build
- Run all tests
- Run linter checks
- Prompt you for the version number to bump to
- Tag, commit, and push to GitHub
Once the commit is merged to the
master branch, the CI/CD script will publish it to NPM.