@shipengine/connect-rendering-client

TypeScript Library

This package allows internal (Auctane) carrier implementers to use the internal Rendering Service for getting documents.

Example

This example shows you how to use the native rendering.

import { CreateLabelRequest, CreateLabelResponse } from "@shipengine/connect-carrier-api";
import { RenderingRequest, getDocuments } from "@shipengine/connect-rendering-client/lib"
import { DummyModule } from "../definitions/index"

export const CreateLabel = async (request: CreateLabelRequest): Promise<CreateLabelResponse> => {
    return await getDocuments(DummyModule.ApiCode, request);
}

⚠ Restrictions:

• Your app must contain a documents template file. Look at Documents Designer tool

• Envirionment variable RENDERING_HOST has to be set.

Building

From the repository root, navigate to this package directory.

Install dependencies yarn

Build yarn build