obi-sdk 0.17.0 → 0.18.0

package/dist/src/loader.d.ts

@@ -0,0 +1,11 @@
+import { ObiSDK } from "./sdk";
+/**
+ * Load the Obi SDK onto the current window. This takes care of any queued commands that may have
+ * been added to the window object by the loader script, and assigns the SDK class instance to the
+ * window object at "ObiSDK".
+ */
+export declare function loadObiSDK(appToken?: string): Promise<ObiSDK | undefined>;
+export declare function loadObiSDKWithWindow({ appToken, window, }: {
+    appToken?: string;
+    window: any;
+}): Promise<ObiSDK | undefined>;

package/dist/src/mount.d.ts

@@ -0,0 +1 @@
+export declare function mountWidget(sdk?: any): void;

package/dist/src/sdk.d.ts

@@ -0,0 +1,77 @@
+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;
+};
+export type InitialiseArgs = {
+    queuedCommands?: Command[];
+};
+export declare class ObiSDK extends EventEmitter {
+    client: ObiClient;
+    isActive: boolean;
+    primaryColour: string;
+    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);
+    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): 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): 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.
+     */
+    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(): string | null;
+    mountWidget(): void;
+    captureScreen(): Promise<string>;
+    save(): void;
+    load(): string | null;
+}

package/dist/src/types.d.ts

@@ -0,0 +1,12 @@
+import { Identity } from "@obi/obi-client";
+export type CommandType = "update" | "say" | "endSession";
+export type Command = {
+    type: CommandType;
+    args: any[];
+};
+export type Config = {
+    apiKey?: string;
+    isActive?: boolean;
+    primaryColour?: string;
+    user?: Identity;
+};

package/dist/src/widget.d.ts

@@ -0,0 +1,6 @@
+import { ObiSDK } from "./sdk";
+export type WidgetProps = {
+    sdk: ObiSDK;
+    shadowHost: HTMLDivElement;
+};
+export declare function Widget(props: WidgetProps): import("preact").JSX.Element;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "obi-sdk",
-  "version": "0.17.0",
+  "version": "0.18.0",
   "description": "JavaScript SDK for Obi",
   "type": "module",
   "main": "dist/obi-sdk.umd.js",
@@ -8,18 +8,13 @@
   "types": "index.d.ts",
   "exports": {
     ".": {
-      "types": "./index.d.ts",
+      "types": "./dist/index.d.ts",
       "import": "./dist/obi-sdk.es.js",
       "require": "./dist/obi-sdk.umd.js"
-    },
-    "./react": {
-      "types": "./dist/react.d.ts",
-      "import": "./dist/react.es.js"
     }
   },
   "files": [
-    "dist",
-    "index.d.ts"
+    "dist"
   ],
   "keywords": [
     "obi",
@@ -39,30 +34,20 @@
     "@sentry/browser": "^9.23.0",
     "@sentry/vite-plugin": "^3.5.0",
     "@types/jsdom": "^21.1.7",
+    "eventemitter3": "^5.0.1",
     "html2canvas-pro": "^1.5.11",
     "lit": "^3.0.0",
+    "preact": ">=10.0.0",
     "ts-pattern": "^5.7.0",
     "zod": "^3.22.0",
     "@obi/obi-client": "0.7.0",
-    "@obi/obi-session": "0.3.8",
-    "@obi/obi-components": "0.1.0",
-    "@obi/utils": "0.2.0"
-  },
-  "peerDependencies": {
-    "react": "^16.8.0 || ^17.0.0 || ^18.0.0",
-    "react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0"
-  },
-  "peerDependenciesMeta": {
-    "react": {
-      "optional": true
-    },
-    "react-dom": {
-      "optional": true
-    }
+    "@obi/utils": "0.2.0",
+    "@obi/obi-components": "0.1.0"
   },
   "devDependencies": {
     "@chromatic-com/storybook": "^4.0.0-0",
     "@eslint/js": "^8.56.0",
+    "@preact/preset-vite": "^2.10.1",
     "@storybook/addon-docs": "^9.0.0",
     "@storybook/web-components-vite": "^9.0.0",
     "@types/node": "^22.15.18",
@@ -70,7 +55,6 @@
     "@types/react-dom": "^18.0.0",
     "@typescript-eslint/eslint-plugin": "^6.0.0",
     "@typescript-eslint/parser": "^6.0.0",
-    "@vitejs/plugin-react": "^4.0.3",
     "@vitest/coverage-v8": "^2.1.8",
     "@vitest/ui": "^2.1.8",
     "eslint": "^8.45.0",
@@ -89,13 +73,11 @@
     "vitest": "^2.1.8"
   },
   "scripts": {
-    "dev": "vite",
-    "build": "pnpm build:old && pnpm build:react && pnpm build:modular && pnpm build:standalone",
-    "build:old": "vite build",
-    "build:standalone": "vite build --config vite.standalone.config.js",
-    "build:modular": "vite build --config vite.modular.config.js",
-    "build:react": "vite build --config vite.react.config.ts",
-    "build:publish": "pnpm build && pnpm build:react && pnpm build:modular && pnpm build:standalone",
+    "dev": "vite --mode development",
+    "dev:staging": "VITE_API_BASE_URL=https://staging.coragents.ai vite --mode staging",
+    "build": "vite build --mode production",
+    "build:staging": "VITE_API_BASE_URL=https://staging.coragents.ai vite build --mode staging",
+    "build:publish": "pnpm build --mode production",
     "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
     "format": "prettier --write \"src/**/*.{ts,tsx}\"",
     "preview": "vite preview",

package/dist/core/config-logger.d.ts

@@ -1,30 +0,0 @@
-import { ObiAssistantConfig } from "../types/sdk";
-export interface ConfigLogEntry {
-    timestamp: number;
-    source: 'initial' | 'update';
-    previousConfig: ObiAssistantConfig | null;
-    newConfig: ObiAssistantConfig;
-    diff: ConfigDiff;
-}
-export interface ConfigDiff {
-    added: Record<string, any>;
-    modified: Record<string, {
-        from: any;
-        to: any;
-    }>;
-    removed: Record<string, any>;
-}
-export declare class ConfigLogger {
-    private history;
-    private currentConfig;
-    logInitialConfig(config: ObiAssistantConfig): void;
-    logConfigUpdate(newConfig: ObiAssistantConfig): void;
-    getHistory(): ConfigLogEntry[];
-    getLatest(): ObiAssistantConfig | null;
-    getDiff(index: number): ConfigDiff | null;
-    clear(): void;
-    getFormattedHistory(): string;
-    private deepClone;
-    private calculateDiff;
-    private isEqual;
-}

package/dist/core/constants.d.ts

@@ -1 +0,0 @@
-export declare const API_BASE_URL: string;

package/dist/core/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./types";
-export * from "./constants";
-export { SDKState } from "@obi/obi-session";

package/dist/core/init.d.ts

@@ -1 +0,0 @@
-export declare const initializeObiWidget: () => Promise<void>;

package/dist/core/types.d.ts

@@ -1,46 +0,0 @@
-import { z } from "zod";
-export declare const ObiSDKConfigSchema: z.ZodObject<{
-    apiKey: z.ZodOptional<z.ZodString>;
-    enableVoice: z.ZodDefault<z.ZodBoolean>;
-    enableScreenCapture: z.ZodDefault<z.ZodBoolean>;
-    debug: z.ZodDefault<z.ZodBoolean>;
-    user: z.ZodOptional<z.ZodObject<{
-        id: z.ZodString;
-        email: z.ZodOptional<z.ZodString>;
-        metadata: z.ZodOptional<z.ZodAny>;
-    }, "strip", z.ZodTypeAny, {
-        id: string;
-        email?: string | undefined;
-        metadata?: any;
-    }, {
-        id: string;
-        email?: string | undefined;
-        metadata?: any;
-    }>>;
-}, "strip", z.ZodTypeAny, {
-    debug: boolean;
-    enableVoice: boolean;
-    enableScreenCapture: boolean;
-    apiKey?: string | undefined;
-    user?: {
-        id: string;
-        email?: string | undefined;
-        metadata?: any;
-    } | undefined;
-}, {
-    apiKey?: string | undefined;
-    debug?: boolean | undefined;
-    enableVoice?: boolean | undefined;
-    enableScreenCapture?: boolean | undefined;
-    user?: {
-        id: string;
-        email?: string | undefined;
-        metadata?: any;
-    } | undefined;
-}>;
-export type ObiSDKConfig = z.infer<typeof ObiSDKConfigSchema>;
-export interface ObiError {
-    code: string;
-    message: string;
-    details?: unknown;
-}

package/dist/empty-loader.d.ts

@@ -1,5 +0,0 @@
-/**
- * @deprecated The loader functionality has been moved to a separate package.
- * Please install and use the 'obi-loader' package instead.
- */
-export declare const initObi: () => never;

package/dist/index.d.ts

@@ -1,2 +0,0 @@
-export { ObiWidget } from "./ui/components/obi-widget";
-import "./core/init";

package/dist/loader.d.ts

@@ -1,33 +0,0 @@
-/**
- * Obi Widget Loader Script
- *
- * This script dynamically loads the Obi Widget web component on any webpage
- * with a simple script tag inclusion.
- */
-interface ObiWidgetConfig {
-    apiKey: string;
-    position?: "bottom-right" | "bottom-left" | "bottom-center" | "top-right" | "top-left" | "top-center" | "middle-left" | "middle-right";
-    user?: {
-        id: string;
-        email?: string;
-        metadata?: Record<string, any>;
-    } | null;
-    isActive?: boolean;
-    linkOnlyAccess?: boolean;
-    showMenu?: boolean;
-    primaryColor?: string;
-    urlBlacklist?: string[];
-}
-declare class ObiWidgetLoader {
-    private config;
-    private widget;
-    constructor(config?: Partial<ObiWidgetConfig>);
-    private init;
-    private loadScript;
-    private fetchLatestVersion;
-    private createWidget;
-    private initializeWidget;
-    initialize(): void;
-    getWidget(): HTMLElement | null;
-}
-export { ObiWidgetLoader };

package/dist/modular/chunks/index-a481947c.js

@@ -1,6 +0,0 @@
-import { O } from "./obi-widget-eab5da7a.js";
-import "./types-f38a47f6.js";
-export {
-  O as ObiWidget
-};
-//# sourceMappingURL=index-a481947c.js.map

package/dist/modular/chunks/index-a481947c.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index-a481947c.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}