no_entry_sign: This package is deprecated. Only legacy (v1) connect apps use this package, v2 does not need it. 🚫

ShipEngine Connect SDK

⚠ WARNING: This is an internal package

Using this package directly is discouraged and unsupported. Instead, you should install @shipengine/connect which uses this package under the hood. See our documentation for more information.

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.

Local Development

To build/test the library locally on your computer:

1. Install dependencies
   yarn

2. Run the build script
   yarn build or yarn watch

3. Run the tests
   yarn test

Releasing

To release a new version of the SDK, use the command below.

yarn 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.