obi-sdk 0.18.19 → 0.18.20

package/dist/src/sdk.d.ts

@@ -0,0 +1,84 @@
+import { EventEmitter } from "eventemitter3";
+import type { Identity } from "@obi/obi-client";
+import { ObiClient } from "@obi/obi-client";
+import { Command, CommandType, Config } from "./types";
+export declare const PLAN_URL_PARAM = "49206C6F7665204F6269_session";
+export declare const STORAGE_KEY = "obi-url-params";
+export type ObiSDKEvents = {
+    initialised: () => void;
+    error: (err: Error) => void;
+    showMenu: (showMenu: boolean) => void;
+    configUpdated: () => void;
+};
+export type InitialiseArgs = {
+    queuedCommands?: Command[];
+};
+export declare class ObiSDK extends EventEmitter<ObiSDKEvents> {
+    client: ObiClient | null;
+    isActive: boolean;
+    primaryColour: string;
+    passivePlanUuid: string | null;
+    private commandQueue;
+    /** HACK: Need to prevent initialisation from being called if resumed. */
+    private _resumed;
+    /**
+     * Creates a client that should persist for the lifetime of the SDK.
+     * Resumes an ongoing session if one exists.
+     */
+    constructor(appToken?: string);
+    createClient(appToken: string): Promise<void>;
+    initialise(args?: InitialiseArgs): Promise<void>;
+    /**
+     * Update the SDK configuration. This is typically called before a plan starts,
+     * but it is possible to update the configuration during a plan.
+     */
+    updateConfig(config: Config): Promise<void>;
+    updateAppToken(appToken?: string): Promise<void>;
+    /**
+     * Update the SDK activity state. Activity controls whether the SDK is continuously
+     * visible or not.
+     * Ignores updates if the active state is undefined or the same as the current active state.
+     */
+    updateActive(isActive?: boolean): void;
+    /**
+     * Update the SDK primary colour. This is typically called before a plan starts,
+     * but it is possible to update the primary colour during a plan.
+     * Ignores updates if the primary colour is undefined or the same as the current primary colour.
+     */
+    updatePrimaryColour(primaryColour?: string): void;
+    /**
+     * Update the identity of the onboardee. This is typically called before a plan starts,
+     * but it is possible to update the identity during a plan.
+     * Ignores updates if the identity is undefined or the same as the current identity.
+     */
+    updateIdentity(identity?: Identity | null): Promise<void>;
+    updateShowMenu(showMenu?: boolean): void;
+    /**
+     * Say a message to the onboardee.
+     */
+    say(message: string): Promise<void>;
+    /**
+     * Start a new session.
+     */
+    startSession(): Promise<void>;
+    /**
+     * Dispatch all queued commands in the order they were added.
+     * TODO: Passing in the planuuid is not cool.
+     */
+    dispatchCommandQueue(): void;
+    /**
+     * This gets set on the window object by the loader script. It is used as an abstraction to allow
+     * users to call commands without having to wait for the client to be ready. This works in tandem
+     * with the loader script, which will queue any commands that are called before the client is ready.
+     */
+    dispatchCommand: (commandType: CommandType, args: any) => void;
+    /**
+     * Parse passive initiation parameters from the URL and/or local storage.
+     * Passive initiation parameters are values that indicate a plan & app token to use immediately.
+     */
+    parsePassiveParams(): null | undefined;
+    mountWidget(): void;
+    captureScreen(): Promise<string>;
+    save(): void;
+    load(): string | null;
+}

package/dist/src/sdk.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "obi-sdk",
-  "version": "0.18.19",
+  "version": "0.18.20",
   "description": "JavaScript SDK for Obi",
   "type": "module",
   "main": "dist/obi-sdk.umd.js",
@@ -41,8 +41,8 @@
     "ts-pattern": "^5.7.0",
     "zod": "^3.22.0",
     "@obi/obi-client": "0.7.0",
-    "@obi/obi-components": "0.1.0",
-    "@obi/utils": "0.2.0"
+    "@obi/utils": "0.2.0",
+    "@obi/obi-components": "0.1.0"
   },
   "devDependencies": {
     "@chromatic-com/storybook": "^4.0.0-0",