@ada-support/ada-widget-sdk

2.7.1 • Public • Published

Widget SDK

This repository contains a JS SDK and helpful documentation for building widgets for Ada.

Changelog

[2.7.0] - 2023-04-17

  • returning false from callback passed to #setWidgetCloseHandler no longer closes the widget automatically

[2.6.1] - 2023-04-14

  • Removed babel from compilation; IE 11 is no longer supported

[2.6.0] - 2023-04-12

  • New SDK method #setWidgetCloseHandler added for overriding widget close behaviour
  • Updated #sendUserData to return a promise that resolves after the input callback executes

[2.5.0] - 2022-12-12

  • New SDK method #setWidgetClose added for closing the widget container.

[2.4.2] - 2022-06-08

  • Bump eventsource from 1.0.7 to 1.1.1
  • Bump minimist from 1.2.3 to 1.2.6

[2.4.1] - 2022-06-01

  • Bump karma from 4.4.1 to 6.3.16
  • Bump url-parse from 1.4.7 to 1.5.10

[2.4.0] - 2022-04-07

  • Added new function getContrastingBrandTextColour that is available to all widgets using the Widget SDK

[2.3.0] - 2022-02-15

  • Improve UI feedback for widgets rendered in sheets view.

[2.2.0] - 2022-01-19

  • isRTL is added to <obj>.metaData.

[2.1.0] - 2021-12-17

  • brandColour and darkMode are added to <obj>.metaData.
  • New SDK method #setContainerHeight added for resizing the widget container

[2.0.1] - 2021-04-12

This version contains breaking changes.

  • Security improvements around sending and receiving widget data
  • Inputs and metadata are no longer parsed from query parameters in the URL
  • Widget inputs are no longer included in <obj>.metaData, and are now found inside <obj>.widgetInputs
  • The language property, <obj>.metaData.lang has been renamed to <obj>.metaData.language

[1.0.1] - 2021-02-02

  • Widget constructor now takes appId as first argument, with _window being deferred to second
  • Widget initialization success and failures are now being logged to Datadog, before firing the "WIDGET_INTIALIZED" and "WIDGET_INITIALIZATION_FAILED" events respectively.

[1.0.0] - 2020-07-15

  • #init will now return the "WIDGET_INITIALIZED" event when the Widget is not in the "active" state. Previously, #init would return a "WIDGET_INITIALIZATION_FAILED" event.

Widget Setup

Initialize the Widget SDK on your page by calling widgetSDK.init and registering all required callbacks.

Importing the SDK

import AdaWidgetSDK from "@ada-support/ada-widget-sdk";
const widgetSDK = new AdaWidgetSDK();

API

Widget SDK Methods

#init

Must be called before user data can be submitted.

Performs setup steps:

  1. Builds the metaData and widgetInput objects, consisting of information about the widget instance as well as the "input data" configured on the Widget Block respectively.
  2. Checks whether the Widget is active or inactive (Widgets can only be used once).
widgetSDK.init((event) => {
    // Perform additional setup steps in here.
    // event.type will be one of "WIDGET_INITIALIZED" or "WIDGET_INITIALIZATION_FAILED"
    // event.widgetInputs contains the input parameters for the widget
});

#sendUserData

Used to submit user data from the Widget. Accepts an object of data to send, and a callback that is invoked when it completes. Returns a PromiseLike which will resolve after the given callback has run.

Note: User data can only be sent once.

const callback = (event) => {
    // Execute additional logic after user data is submitted.
    // event.type will be one of "SEND_USER_DATA_SUCCESS" or "SEND_USER_DATA_FAILED"
}
await widgetSDK.sendUserData({
    userSelectedData: "2019-01-01 12:00:00"
}, callback);

// This code only executes after data is submitted and `callback` function has executed

#setContainerHeight

Used to set the height of the widget container. Accepts the given height to be in pixels. This is most commonly used to configure the widget container to match the height of the widget content.

widgetSDK.setContainerHeight(document.documentElement.offsetHeight);

#setWidgetClose

Used to close the widget container.

widgetSDK.setWidgetClose();

#setWidgetCloseHandler

Used to supply a callback function to perform any cleanup when the chat user closes the sheet view. The callback can be a regular or async function. The SDK will automatically call #setWidgetClose after the given callback resolves, unless the callback returns false.

Note: callback will only be called when a user closes the widget sheet view. It is not called if the sheet is closed programmatically through #setWidgetClose.

widgetSDK.setWidgetCloseHandler(
    async () => {
        if (!widgetSDK.widgetIsActive) {
            return; // Only performs cleanup if the widget is still active and interactible
        }

        if (!confirm("Are you sure you would like to close?")) {
            return false; // Prevents sheet from automatically closing
        }

        // Execute additional cleanup logic to perform before the sheet view tears down
    }
);

#getContrastingBrandTextColour

Checks if the brand colour contrasts with a given background enough to be used as text colour. Returns the brand colour if so; otherwise, returns a sufficiently contrasting fallback colour (black or white)

widgetSDK.getContrastingBrandTextColour(backgroundColour);

Widget SDK Events

WIDGET_INITIALIZED

Properties:

  • type: WIDGET_INITIALIZED
  • widgetActive: true|false
  • metaData: An object containing information about the widget instance
  • widgetInput: An object containing the widget input data as configured in the Widget Block

WIDGET_INITIALIZATION_FAILED

Properties:

  • type: WIDGET_INITIALIZATION_FAILED
  • error: The error that caused initialization to fail (ex. a network error is encountered).

SEND_USER_DATA_SUCCESS

Properties:

  • type: SEND_USER_DATA_SUCCESS

SEND_USER_DATA_FAILED

Properties:

  • type: SEND_USER_DATA_FAILED
  • error: The error that caused sendUserData to fail (ex. the Widget is not active).

Widget SDK Properties

widgetSDK.widgetIsActive

Returns boolean indicating whether Widget is "active".

A value of true indicates the Widget can be used to submit user Data. The Widget be in an "active" state.

A value of false indicated the Widget is "inactive" or expired and can no longer be used to submit user data. The Widget should be in an "inactive" state (ie. it should be clear to the user that they cannot perform any action on the Widget).

widgetSDK.metaData

Returns information about the widget instance. These can be used by the Widget to modify its behavior.

widgetSDK.metaData

{
    platform: "chat",
    language: "en",
    brandColour: "#101820",
    darkMode: false,
    isRTL: false,
}
  • platform: A string indicating what chat platform this widget is being displayed on (e.g. chat, messenger, etc)
  • language: A language string indicating what language the chatter is speaking in
  • brandColour: A hex colour string indicating the brand colour of the bot
  • darkMode: A boolean indicating whether or not the chat window is being viewed using a dark colour scheme
  • isRTL: A boolean indicating whether or not the chatter language is in a right-to-left writing system.

widgetSDK.widgetInputs

Contains the inputs to the widget as configured in the Widget Block. For example, the Date Picker App may be configured with a custom date format when presenting the picked date back to the user:

widgetSDK.widgetInputs

{
    dateFormat: "YY-MM-DD"
}

Readme

Keywords

none

Package Sidebar

Install

npm i @ada-support/ada-widget-sdk

Weekly Downloads

72

Version

2.7.1

License

ISC

Unpacked Size

119 kB

Total Files

3

Last publish

Collaborators

  • msa-npm
  • leahbelyea
  • lucaimbrogno
  • ebumbulis-ada
  • oswaldog
  • michaellazz
  • wole-ada
  • seva.rubbo
  • adashajesh