Shipwell Javascript SDK

A collection of API wrappers and validation schema utils.

Setup

Install package dependencies:

npm install

API

Shipwell SDK api is based off of our Swagger schema specifications and builds its routes calls and schemas off of this.

import {api} from 'shipwell-js-sdk';

Config

The api config exposes a couple important request settings:

|Property | Description | Default | |--------------|---|---| |basePath | The default api route base path. | https://dev-api.shipwell.com/v2 | |defaultHeaders| The default HTTP request headers for each api route. | Accept: 'application/json''Content-Type': 'application/json' |

Set default base path for api routes

api.config.basePath = 'https://dev-api.shipwell.com/v2'

Set default authorization header token

api.config.defaultHeaders['Authorization'] = 'Token ##################'

Usage

The api routes use the Fetch API as the default HTTP request api; providing the benefit of being a native api as well as using Promises.

const response = api.routes.shipmentsGet();

Validation

A Yup validation schema that consumes Shipwell's JSON api schema to build field level validation.

import {api, createValidationSchema} from 'shipwell-js-sdk';

Usage

const schema = api.schemas.carriersCarrierIdPowerUnitsPowerUnitId;

const validationSchema = createValidationSchema(schema);

Development Guidelines

In order to keep this library organized and stable, we request the following guidelines:

ESLint

This library enforces linting rules to help establish consistent code usage and formatting across all files. Enable your IDE or favorite text editor to show linting errors during development.

Shipwell's Javascript SDK currently conforms to a mix of Airbnb's style guide and prettier.

Run eslint command

npm run lint

Resources:

• Airbnb JS Style Guide - https://github.com/airbnb/javascript
• Prettier - https://github.com/prettier

Testing

In order to keep core component behavior predictable and consistent, tests are required for all new components, functionality changes and bug fixes.

Run tests command

npm run tests

Resources:

• Jest - https://jestjs.io/