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 Embed consumers (e.g., customers and colleagues).
• The Embed interface should be stable. Having types defined in a separate package helps to track changes to the Embed public API with more scrutiny.
• Types described in this package can be used across Ada frontend applications that communicate with Embed.

Set up and development

Install dependencies: sh yarn Run ESLint sh yarn lint

Deployment

The NPM publish job will run automatically via Github actions upon merging your branch to main

Installation

In your repository:

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

Usage

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

You can also import any exported items exposed in our public API.