Developer SDK

Introduction

Developer SDK is a JavaScript tool dedicated for software developers who aim to build apps with our Developer Program. The main purpose of this SDK is to arm your project with tooling that optimizes the usage of the Text Developer Platform ecosystem.

Use cases

• Easy implementation of authorization in your app (wrapper for Accounts SDK)
• Reporting errors that occur in your app to Developer Console

About Developer SDK

To read more about the Developer SDK, visit its official page on npm.

How to start

Create an app

First, you need to sign up to Text Developer Program and create an application in the Developer Console.

Install Developer SDK

Start by installing the SDK using npm or yarn:

npm install @livechat/developer-sdk

DeveloperApp class

DeveloperApp is a class that provides methods for initializing and configuring your developer application.

Config

In order to use the DeveloperApp class in your project, first, you need to define your DeveloperAppConfig according to the shape:

interface DeveloperAppConfig {
  /* 1 */ appId: string;
  /* 2 */ auth?: {
    clientId?: string;
    mode?: "popup" | "iframe" | "redirect";
  };
}

Config properties

We suggest that you should store the config in a dedicated file, livechat.config.json

// livechat.config.json
{
  ...
}

But storing it in a variable is also an option:

const config: DeveloperAppConfig = {
  // ...
};

Initialization

Use the DeveloperApp.init() method to initialize your DeveloperApp. It takes DeveloperAppConfig as its argument and returns a DeveloperApp instance:

import { DeveloperApp, DeveloperAppConfig } from "@livechat/developer-sdk";
import lcConfig from "./livechat.config.json";

const app = await DeveloperApp.init(config);

Usage

Authorization

If your application needs authorization (uses the App Authorization building block), you can use Developer SDK to process authorization for you.

authorize()

In order to trigger authorization you can use authorize method on your app instance:

await app.authorize();

Keep in mind that the authorize method's behavior varies, depending on the authorization strategy:

• For the popup and iframe flows: it resolves as soon as the login process is finished, and returns authorization data (also app.authorization is being filled).
• For redirect: it returns undefined, but it redirects to the login process, and when it's back, the authorize method has to be called again to finalize authorization.

React example

In React applications, you can build a custom hook to ensure proper app initialization and authorization.

function useDeveloperApp() {
  const [developerApp, setDeveloperApp] = useState<DeveloperApp | null>(null)

  useEffect(() => {
    const app = DeveloperApp.init(config)

    if (config.auth?.clientId) {
      app.authorize().then(() => setDeveloperApp(app))
    } else {
      setDeveloperApp(app)
    }
  }, [])

  return developerApp
}

Reporting

The DeveloperApp instance allows you to make use of the reporting feature. This way, you can log 4xx and 5xx errors that occur in your app. You'll see a visual representation of logged errors in the Developer Console.

sendError()

Definition:

interface ReportingFeature {
  sendError(type: "4xx" | "5xx", payload?: string): Promise<void>;
}

Usage:

await app.features.reporting.sendError("4xx");

Contact us

We're happy to provide our support in case you need it. If you have any questions or suggestions, feel free to contact us at developers@text.com or join our Discord for Developers.