@pillar-ai/sdk 0.1.5 → 0.1.7

package/README.md

@@ -1,6 +1,6 @@
 # @pillar-ai/sdk
 
-Pillar Embedded Help SDK - Add contextual help, tooltips, and AI chat to your application.
+Pillar Embedded Help SDK - Add contextual help and AI chat to your application.
 
 ## Installation
 
@@ -10,36 +10,12 @@ npm install @pillar-ai/sdk
 
 ## Quick Start
 
-### Script Tag (CDN)
-
-```html
-<script src="https://cdn.trypillar.com/sdk/pillar.min.js"></script>
-<script>
-  Pillar.init({
-    helpCenter: 'your-help-center',
-    publicKey: 'pk_live_xxx',
-  });
-</script>
-```
-
-Or with auto-initialization via data attributes:
-
-```html
-<script
-  src="https://cdn.trypillar.com/sdk/pillar.min.js"
-  data-help-center="your-help-center"
-  data-public-key="pk_live_xxx"
-></script>
-```
-
-### ES Modules
-
 ```javascript
-import { Pillar } from '@pillar-ai/sdk';
+import { Pillar } from "@pillar-ai/sdk";
 
 await Pillar.init({
-  helpCenter: 'your-help-center',
-  publicKey: 'pk_live_xxx',
+  helpCenter: "your-help-center",
+  publicKey: "pk_live_xxx",
 });
 ```
 
@@ -48,45 +24,55 @@ await Pillar.init({
 ```javascript
 Pillar.init({
   // Required
-  helpCenter: 'your-help-center',
-  publicKey: 'pk_live_xxx',
+  helpCenter: "your-help-center",
+  publicKey: "pk_live_xxx",
 
   // Optional configuration
   config: {
     // Panel configuration
     panel: {
-      position: 'right', // 'left' | 'right'
-      mode: 'overlay', // 'overlay' | 'push'
-    },
-
-    // Floating button
-    floatingButton: {
-      enabled: true,
-      position: 'bottom-right',
+      position: "right", // 'left' | 'right'
+      mode: "push", // 'overlay' | 'push'
     },
 
-    // Tooltips
-    tooltips: {
-      enabled: true,
-      trigger: 'hover', // 'hover' | 'click'
+    // Edge trigger (sidebar tab that opens the panel)
+    edgeTrigger: {
+      enabled: true, // Set to false to use your own custom button
     },
 
     // Theme
     theme: {
-      mode: 'system', // 'light' | 'dark' | 'system'
+      mode: "auto", // 'light' | 'dark' | 'auto'
       colors: {
-        primary: '#6366f1',
+        primary: "#6366f1",
       },
     },
   },
 });
 ```
 
+## Custom Trigger Button
+
+To use your own button instead of the built-in edge trigger:
+
+```javascript
+Pillar.init({
+  helpCenter: "your-help-center",
+  publicKey: "pk_live_xxx",
+  edgeTrigger: { enabled: false },
+});
+
+// Then control the panel programmatically
+document.getElementById("my-help-button").addEventListener("click", () => {
+  Pillar.toggle();
+});
+```
+
 ## Features
 
 - **AI Chat**: Embedded AI assistant that understands your product
+- **Edge Trigger**: Built-in sidebar tab to open the help panel (or use your own button)
 - **Contextual Help**: Show relevant help based on user context
-- **Tooltips**: Attach interactive tooltips to any element
 - **Text Selection**: Allow users to ask questions about selected text
 - **Customizable UI**: Full control over positioning, theming, and behavior
 

package/dist/api/client.d.ts

@@ -52,17 +52,6 @@ export interface ServerEmbedConfig {
         position?: string;
         label?: string;
     };
-    features?: {
-        aiChatEnabled?: boolean;
-        searchEnabled?: boolean;
-        tooltipsEnabled?: boolean;
-    };
-    sidebarTabs?: Array<{
-        id: string;
-        label: string;
-        enabled: boolean;
-        order: number;
-    }>;
     theme?: {
         colors?: {
             primary?: string;

package/dist/components/Button/EdgeTrigger.d.ts

@@ -3,13 +3,16 @@
  * A sidebar-style trigger that reserves space in the layout and slides out with the panel.
  * The trigger stays visible when panel opens, positioned at the panel's outer edge.
  */
-import type { FloatingButtonPosition, ResolvedConfig } from "../../core/config";
+import type { ResolvedConfig } from "../../core/config";
+import type { EventEmitter } from "../../core/events";
+export type EdgeTriggerPosition = "left" | "right";
 /**
  * EdgeTrigger class that manages the edge trigger lifecycle
  * The trigger stays visible when panel opens, sliding out with it
  */
 export declare class EdgeTrigger {
     private config;
+    private events;
     private onClick;
     private rootContainer;
     private container;
@@ -22,13 +25,14 @@ export declare class EdgeTrigger {
     private unsubscribeActiveTab;
     private themeObserver;
     private currentTheme;
-    constructor(config: ResolvedConfig, onClick: () => void, rootContainer?: HTMLElement | null);
+    constructor(config: ResolvedConfig, events: EventEmitter, onClick: () => void, rootContainer?: HTMLElement | null);
     /**
      * Handle tab click - sets active tab and opens panel
+     * For non-assistant tabs, emits event for customer's code to handle (e.g., Intercom, Zendesk)
      */
     private handleTabClick;
     /**
-     * Get position as 'left' or 'right' from the floating button position config
+     * Get position as 'left' or 'right' from the panel position config
      */
     private getEdgePosition;
     /**
@@ -65,11 +69,7 @@ export declare class EdgeTrigger {
     /**
      * Update trigger position
      */
-    setPosition(position: FloatingButtonPosition): void;
-    /**
-     * Update trigger label
-     */
-    setLabel(label: string): void;
+    setPosition(position: EdgeTriggerPosition): void;
     /**
      * Destroy the trigger
      */

package/dist/components/Button/index.d.ts

@@ -1,5 +1,4 @@
 /**
  * Button Components Index
  */
-export { FloatingButton } from './FloatingButton';
-export { EdgeTrigger } from './EdgeTrigger';
+export { EdgeTrigger, type EdgeTriggerPosition } from './EdgeTrigger';

package/dist/components/index.d.ts

@@ -2,7 +2,6 @@
  * Components Index
  */
 export { Panel, PanelContent, Header, ChatInput, PANEL_STYLES } from './Panel';
-export { FloatingButton } from './Button';
 export { PillarProvider, usePillar, useAPI, useEvents } from './context';
 export * from './shared';
 export * from './Views';

package/dist/core/Pillar.d.ts

@@ -18,7 +18,7 @@ export declare class Pillar {
     private _planExecutor;
     private _textSelectionManager;
     private _panel;
-    private _floatingButton;
+    private _edgeTrigger;
     private _initPromise;
     private _rootContainer;
     private _unsubscribeHoverMode;

package/dist/core/config.d.ts

@@ -4,8 +4,6 @@
 import type { Platform } from '../actions/types';
 export type PanelPosition = 'left' | 'right';
 export type PanelMode = 'overlay' | 'push';
-export type FloatingButtonPosition = 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left';
-export type FloatingButtonStyle = 'floating' | 'edge';
 export type ThemeMode = 'light' | 'dark' | 'auto';
 /**
  * Sidebar tab configuration
@@ -15,6 +13,8 @@ export interface SidebarTabConfig {
     label: string;
     enabled: boolean;
     order: number;
+    /** Preset icon for this tab */
+    icon?: 'help' | 'support' | 'settings' | 'feedback' | 'chat' | 'calendar' | 'mail';
 }
 export declare const DEFAULT_SIDEBAR_TABS: SidebarTabConfig[];
 /**
@@ -91,18 +91,6 @@ export interface PanelConfig {
      */
     hoverBackdrop?: boolean;
 }
-export interface FloatingButtonConfig {
-    enabled?: boolean;
-    position?: FloatingButtonPosition;
-    label?: string;
-    /**
-     * Button style:
-     * - 'edge': Slim vertical tab on screen edge, expands on hover (default)
-     * - 'floating': Traditional floating pill button
-     * @default 'edge'
-     */
-    style?: FloatingButtonStyle;
-}
 export interface UrlParamsConfig {
     /** Whether to check URL params for auto-opening the panel (default: true) */
     enabled?: boolean;
@@ -117,6 +105,14 @@ export interface TextSelectionConfig {
     /** Label for the popover button (default: 'Ask AI') */
     label?: string;
 }
+export interface EdgeTriggerConfig {
+    /**
+     * Whether to show the edge trigger sidebar tab.
+     * When enabled, a slim vertical tab appears on the screen edge that opens the panel.
+     * @default true
+     */
+    enabled?: boolean;
+}
 export interface UserContext {
     id?: string;
     persona?: string;
@@ -138,7 +134,7 @@ export interface PillarConfig {
      */
     version?: string;
     panel?: PanelConfig;
-    floatingButton?: FloatingButtonConfig;
+    edgeTrigger?: EdgeTriggerConfig;
     urlParams?: UrlParamsConfig;
     textSelection?: TextSelectionConfig;
     sidebarTabs?: SidebarTabConfig[];
@@ -189,7 +185,7 @@ export interface ResolvedConfig {
     /** App version for code-first actions (optional) */
     version?: string;
     panel: ResolvedPanelConfig;
-    floatingButton: Required<FloatingButtonConfig>;
+    edgeTrigger: Required<EdgeTriggerConfig>;
     urlParams: Required<UrlParamsConfig>;
     textSelection: Required<TextSelectionConfig>;
     sidebarTabs: SidebarTabConfig[];
@@ -218,12 +214,6 @@ export interface ServerEmbedConfig {
         position?: string;
         label?: string;
     };
-    features?: {
-        aiChatEnabled?: boolean;
-        searchEnabled?: boolean;
-        tooltipsEnabled?: boolean;
-    };
-    sidebarTabs?: SidebarTabConfig[];
     theme?: {
         colors?: {
             primary?: string;

package/dist/core/events.d.ts

@@ -209,6 +209,14 @@ export interface PillarEvents {
     'textSelection:change': {
         enabled: boolean;
     };
+    'sidebar:click': {
+        tabId: string;
+        label: string;
+    };
+    /** @deprecated Use 'sidebar:click' instead. Will be removed in next major version. */
+    'support:request': {
+        tabId: string;
+    };
 }
 export declare class EventEmitter {
     private listeners;

package/dist/index.d.ts

@@ -22,7 +22,7 @@
  */
 export { Pillar, type PillarState } from './core/Pillar';
 export { EventEmitter, type PillarEvents, type TaskExecutePayload, type CardRenderer, type CardCallbacks } from './core/events';
-export { type PillarConfig, type ResolvedConfig, type ResolvedPanelConfig, type PanelConfig, type FloatingButtonConfig, type UrlParamsConfig, type TextSelectionConfig, type UserContext, type PanelPosition, type PanelMode, type FloatingButtonPosition, type FloatingButtonStyle, type ThemeMode, type ThemeColors, type ThemeConfig, type ResolvedThemeConfig, type SidebarTabConfig, DEFAULT_SIDEBAR_TABS, } from './core/config';
+export { type PillarConfig, type ResolvedConfig, type ResolvedPanelConfig, type PanelConfig, type EdgeTriggerConfig, type UrlParamsConfig, type TextSelectionConfig, type UserContext, type PanelPosition, type PanelMode, type ThemeMode, type ThemeColors, type ThemeConfig, type ResolvedThemeConfig, type SidebarTabConfig, DEFAULT_SIDEBAR_TABS, } from './core/config';
 export { type ProductContext, type UserProfile, type Suggestion, type AssistantContext, } from './core/context';
 export { type PlanStatus, type StepStatus, type ExecutionLocation, type ExecutionPlan, type ExecutionStep, type PlanEvents, } from './core/plan';
 export { defineActions, setClientInfo, getClientInfo, getHandler, getActionDefinition, hasAction, getActionNames, getManifest, clearRegistry, getActionCount, type ActionType, type ActionDataSchema, type ActionDefinition, type ActionDefinitions, type ActionManifest, type ActionManifestEntry, type ClientInfo, type Platform, type SyncActionDefinition, type SyncActionDefinitions, type ActionTypeDataMap, type NavigateActionData, type TriggerActionData, type InlineUIData, type ExternalLinkData, type CopyTextData, type ActionDataType, type ActionNames, type TypedTaskHandler, type TypedOnTask, type TypedPillarMethods, } from './actions';