@ada-support/embed-types

embed-types

What is this?

A public NPM package with types describing Embed public API.

Why is it needed?

• We want to call out breaking changes for our customers and colleagues.
• Embed interface must stay relatively unchanged. Having types defined in a separate package helps to track changes to the Embed public API.
• Types described in this package can be used across Ada frontend applications that communicate with Embed.

Installation

In your repository:

yarn add @ada-support/embed-types -D

Usage

import type { AdaEmbedAPI } from "@ada-support/embed-types";

Publishing changes

In your feature branch

• Update version in package.json.

After merge to main branch

• Run yarn compile to compile;
• Run npm publish to publish.

ESLint

1. Install dependencies:

   yarn
   

2. Run ESLint

   yarn lint