courier-web

A monorepo that contains all packages for Courier's browser SDKs.

Getting Started

In VSCode IDEs

1. Open the .vscode folder, click courier-web.code-workspace then click the blue "Open Workspace" button in the bottom right

2. Click the "Sync Packages" button to install all dependencies

This will set up your development environment with all the necessary packages and configurations.

You may need to click "Sync Packages" during development if some local packages get out of sync with each other.

In the console

The Courier Web monorepo uses Yarn workspaces to manage dependencies.

1. Get setup with Node (using nvm) and Yarn

   nvm use
   

2. From the courier-web directory, install workspace dependencies. This will:

   • Install top-level dependencies
   • symlink each workspace into the top-level node_modules
   • Install workspaces' dependencies in their respective node_modules.

   yarn install
   

3. Build the packages

   yarn build-packages
   

Packages

Package	Description
courier-js	The base API client and shared instance singleton for Courier's JavaScript Browser SDK
courier-ui-core	Web components used in UI level packages
courier-ui-inbox	Web components for Courier Inbox
courier-ui-toast	Web components for Courier Toast
courier-ui-preferences	Web components for Courier Preferences
courier-react-components	Shared package of React components for courier-react and courier-react-17
courier-react	React 18+ components for Courier Inbox
courier-react-17	React 17 components for Courier Inbox
courier-vue	Vue 3 components for Courier Inbox

Architecture

%%{init: {'flowchart': {'curve': 'linear'}}}%%
graph BT
    subgraph foundation["Foundation"]
        js["courier-js<br/><i>API client</i>"]
        core["courier-ui-core<br/><i>base web components</i>"]
    end

    subgraph webcomponents["Web Component UI"]
        inbox["courier-ui-inbox"]
        toast["courier-ui-toast"]
        prefs["courier-ui-preferences"]
    end

    subgraph reactsdks["React SDKs"]
        rc["courier-react-components<br/><i>shared</i>"]
        r18["courier-react<br/><i>React 18+</i>"]
        r17["courier-react-17<br/><i>React 17</i>"]
    end

    subgraph nativesdks["Native Framework SDKs"]
        vue["courier-vue<br/><i>Vue 3</i>"]
        ng["courier-angular<br/><i>Angular 17+</i>"]
    end

    foundation --> webcomponents
    webcomponents --> rc
    webcomponents --> nativesdks
    rc --> r18 & r17

The courier-js API client and courier-ui-core web components form the foundation. The courier-ui-* packages build the framework-agnostic web component UI on top of them. Framework SDKs wrap those web components: the React SDKs share logic through courier-react-components, while courier-vue and courier-angular wrap the web components directly.

API Extractor

Each package's public API is tracked in api via API Extractor, and CI fails if the committed spec is out of date. If you change a public API, regenerate the spec in the same PR:

yarn generate-api-docs

Versioning and releasing

Versions and changelogs are managed by changesets. Add a changeset to your PR:

yarn changeset

Changesets maintains a "Version Packages" PR that bumps versions and updates changelogs. Merging it publishes the packages to npm automatically via trusted publishing.