shipengine/connect-sdk

The official SDK for building a ShipEngine Connect app

⚠ This is an deprecated repository

Development has moved to @shipengine/connect

---

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
   npm install

2. Run the build script
   npm run build or npm run watch

3. Run the tests
   npm test

Releasing

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.