obi-sdk 0.18.24 → 0.18.26

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

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

package/dist/src/index.d.ts

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

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,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/dist/src/sentry.d.ts

@@ -0,0 +1,39 @@
+interface SentryContext {
+    sessionId?: string;
+    apiKey?: string;
+    widgetState?: string;
+    componentName?: string;
+    userId?: string;
+    userEmail?: string;
+    userMetadata?: any;
+    handlerName?: string;
+    lifecycle?: string;
+    changedProperties?: string[];
+    eventType?: string;
+    eventData?: Record<string, any>;
+    userJourney?: string[];
+    [key: string]: any;
+}
+export declare function captureException(error: any, context?: SentryContext): void;
+export declare function captureMessage(message: string, level?: "info" | "warning" | "error", context?: SentryContext): void;
+export declare function trackEvent(eventType: string, eventData?: Record<string, any>, componentName?: string): void;
+export declare function setGlobalContext(context: Partial<SentryContext>): void;
+/**
+ * Wraps an async function to automatically capture any exceptions
+ */
+export declare function withSentryAsyncHandler<T extends (...args: any[]) => Promise<any>>(fn: T, handlerName: string, componentName?: string): T;
+/**
+ * Wraps a synchronous function to automatically capture any exceptions
+ */
+export declare function withSentryHandler<T extends (...args: any[]) => any>(fn: T, handlerName: string, componentName?: string): T;
+/**
+ * Simple wrapper to add Sentry error tracking to component lifecycle methods
+ * Use this in your component's connectedCallback, disconnectedCallback, etc.
+ */
+export declare function withComponentErrorTracking(componentName: string): {
+    trackLifecycle: (lifecycleMethod: string, fn: () => void) => void;
+    trackRender: (renderFn: () => any) => any;
+    setContext: () => void;
+};
+export { captureException as default };
+export type { SentryContext };

package/dist/src/types.d.ts

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

package/dist/src/url-matcher.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Utility for matching URLs against glob patterns
+ */
+/**
+ * Check if a URL matches any of the provided glob patterns
+ * @param url The URL to check
+ * @param patterns Array of glob patterns to match against
+ * @returns true if the URL matches any pattern, false otherwise
+ */
+export declare function matchesUrlPattern(url: string, patterns: string[]): boolean;
+/**
+ * Check if the current page URL is blacklisted
+ * @param blacklist Array of URL glob patterns
+ * @returns true if current URL is blacklisted, false otherwise
+ */
+export declare function isCurrentUrlBlacklisted(blacklist?: string[]): boolean;

package/dist/src/url-matcher.test.d.ts

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

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 | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "obi-sdk",
-  "version": "0.18.24",
+  "version": "0.18.26",
   "description": "JavaScript SDK for Obi",
   "type": "module",
   "main": "dist/obi-sdk.umd.js",
@@ -16,6 +16,26 @@
   "files": [
     "dist"
   ],
+  "scripts": {
+    "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",
+    "types": "tsc --emitDeclarationOnly",
+    "types:check": "tsc --noEmit",
+    "prepublishOnly": "pnpm build:publish && pnpm types",
+    "clean": "rimraf dist",
+    "storybook": "storybook dev -p 6006",
+    "build-storybook": "storybook build",
+    "test": "vitest run",
+    "test:ui": "vitest --ui",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage"
+  },
   "keywords": [
     "obi",
     "sdk",
@@ -31,18 +51,19 @@
   "homepage": "https://www.iamobi.ai",
   "dependencies": {
     "@lit/react": "^1.0.7",
+    "@obi/obi-client": "workspace:*",
+    "@obi/obi-components": "workspace:*",
+    "@obi/utils": "workspace:*",
     "@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",
+    "mixpanel-browser": "^2.68.0",
     "preact": ">=10.0.0",
     "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"
+    "zod": "^3.22.0"
   },
   "devDependencies": {
     "@chromatic-com/storybook": "^4.0.0-0",
@@ -72,23 +93,5 @@
     "vite": "^4.5.0",
     "vitest": "^2.1.8"
   },
-  "scripts": {
-    "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",
-    "types": "tsc --emitDeclarationOnly",
-    "types:check": "tsc --noEmit",
-    "clean": "rimraf dist",
-    "storybook": "storybook dev -p 6006",
-    "build-storybook": "storybook build",
-    "test": "vitest run",
-    "test:ui": "vitest --ui",
-    "test:watch": "vitest",
-    "test:coverage": "vitest run --coverage"
-  }
-}
+  "packageManager": "pnpm@10.5.2"
+}