obi-sdk 0.23.0 → 0.23.2-beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -13
- package/dist/index.js +1 -1
- package/dist/obi-sdk.standalone.iife.js +1 -1
- package/dist/src/sdk.d.ts +0 -12
- package/dist/src/types.d.ts +2 -4
- package/package.json +1 -1
package/dist/src/sdk.d.ts
CHANGED
|
@@ -5,15 +5,6 @@ import { Command, CommandType, Config } from "./types";
|
|
|
5
5
|
export declare const PLAN_URL_PARAM = "49206C6F7665204F6269_session";
|
|
6
6
|
export declare const STORAGE_KEY = "obi-url-params";
|
|
7
7
|
export declare const HEARTBEAT_STORAGE_KEY = "obi-client-heartbeat";
|
|
8
|
-
/**
|
|
9
|
-
* TEMPORARY ROLLOUT GATE
|
|
10
|
-
*
|
|
11
|
-
* `update({ showMenu: true })` now defaults to opening Widget V3 (side panel).
|
|
12
|
-
* Keep specific hostnames on Widget V2 until rollout completes.
|
|
13
|
-
*
|
|
14
|
-
* Remove this gate once the V3 rollout is complete for all customers.
|
|
15
|
-
*/
|
|
16
|
-
export declare const LEGACY_SHOW_MENU_HOSTNAMES: Set<string>;
|
|
17
8
|
export type SidePanelStartIntent = "show_me_around" | "ask_a_question";
|
|
18
9
|
export type SidePanelStartRequest = {
|
|
19
10
|
requestId: number;
|
|
@@ -53,7 +44,6 @@ export type ObiSDKEvents = {
|
|
|
53
44
|
export type InitialiseArgs = {
|
|
54
45
|
queuedCommands?: Command[];
|
|
55
46
|
};
|
|
56
|
-
export declare function shouldRouteShowMenuToSidePanelForHostname(hostname?: string | null): boolean;
|
|
57
47
|
export declare class ObiSDK extends EventEmitter<ObiSDKEvents> {
|
|
58
48
|
client: ObiClient | null;
|
|
59
49
|
isActive: boolean;
|
|
@@ -119,9 +109,7 @@ export declare class ObiSDK extends EventEmitter<ObiSDKEvents> {
|
|
|
119
109
|
* but it is possible to update the configuration during a plan.
|
|
120
110
|
*/
|
|
121
111
|
updateConfig(config: Config): Promise<void>;
|
|
122
|
-
private shouldRouteShowMenuToSidePanel;
|
|
123
112
|
private autoRouteShowMenuToSidePanel;
|
|
124
|
-
private autoRouteStartSessionFallbackToSidePanel;
|
|
125
113
|
private requestSidePanelStart;
|
|
126
114
|
consumeAutoOpenPlanUuid(): string | null;
|
|
127
115
|
updateAppToken(appToken?: string): Promise<void>;
|
package/dist/src/types.d.ts
CHANGED
|
@@ -12,10 +12,8 @@ export type Config = {
|
|
|
12
12
|
primaryColour?: string;
|
|
13
13
|
user?: Identity;
|
|
14
14
|
/**
|
|
15
|
-
* Opens/closes the menu entry-point.
|
|
16
|
-
*
|
|
17
|
-
* defaults to V3 (side panel) except on hostnames listed in
|
|
18
|
-
* `sdk.ts` -> `LEGACY_SHOW_MENU_HOSTNAMES`.
|
|
15
|
+
* Opens/closes the menu entry-point. When `showSidePanel` is not provided, this
|
|
16
|
+
* opens/closes the side panel.
|
|
19
17
|
*/
|
|
20
18
|
showMenu?: boolean;
|
|
21
19
|
showSidePanel?: boolean;
|