@pillar-ai/sdk 0.1.32 → 0.1.34

package/README.md

@@ -31,7 +31,7 @@ Pillar understands the intent, builds a multi-step plan, and executes it client-
 - **Multi-Step Plans** — Chain actions into workflows for complex tasks
 - **Context-Aware** — Knows current page, user state, and selected text
 - **Knowledge Sync** — Trained on your docs, Zendesk, Intercom, and more
-- **Custom Action Cards** — Render interactive UI for confirmations and data input
+- **Render Custom Components** — Render your own interactive UI in the chat
 - **Framework Bindings** — First-class support for React, Vue, and Svelte
 
 ## Why Pillar?
@@ -42,7 +42,7 @@ Pillar understands the intent, builds a multi-step plan, and executes it client-
 
 ## Documentation
 
-**[View Full Documentation](https://trypillar.com/docs)** | [Getting Started](https://trypillar.com/docs/get-started/quickstart) | [API Reference](https://trypillar.com/docs/reference/core)
+**[View Full Documentation](https://trypillar.com/docs)** | [Getting Started](https://trypillar.com/docs/get-started/quickstart) | [API Reference](https://trypillar.com/docs/reference)
 
 ## Installation
 
@@ -56,11 +56,9 @@ yarn add @pillar-ai/sdk
 
 ## Quick Start
 
-### 1. Get Your Product Key
+### 1. Get your product key
 
-> **⚠️ Beta Onboarding:** Cloud access is currently manual while we learn from early teams. Join the waitlist at [trypillar.com](https://trypillar.com), and we will reach out to onboard you.
->
-> By default, you'll get an engineer from Pillar to help with setup. If you prefer onboarding without engineering support, include that in your waitlist request and we will support that too.
+Sign up at [app.trypillar.com](https://app.trypillar.com) and grab your product key from the dashboard.
 
 ### 2. Initialize the SDK
 
@@ -144,29 +142,29 @@ const pillar = await Pillar.init({
 
 ## API Reference
 
-| Method | Description |
-|--------|-------------|
-| `Pillar.init(config)` | Initialize the SDK, returns the instance |
-| `Pillar.getInstance()` | Get the initialized SDK instance |
-| `pillar.open()` | Open the co-pilot panel |
-| `pillar.close()` | Close the co-pilot panel |
-| `pillar.toggle()` | Toggle the co-pilot panel |
-| `pillar.setContext(context)` | Update the user/product context |
-| `pillar.on(event, callback)` | Subscribe to SDK events |
+| Method                       | Description                              |
+| ---------------------------- | ---------------------------------------- |
+| `Pillar.init(config)`        | Initialize the SDK, returns the instance |
+| `Pillar.getInstance()`       | Get the initialized SDK instance         |
+| `pillar.open()`              | Open the co-pilot panel                  |
+| `pillar.close()`             | Close the co-pilot panel                 |
+| `pillar.toggle()`            | Toggle the co-pilot panel                |
+| `pillar.setContext(context)` | Update the user/product context          |
+| `pillar.on(event, callback)` | Subscribe to SDK events                  |
 
 > **Note:** `Pillar.init()` and `Pillar.getInstance()` are static methods on the class. All other methods (lowercase `pillar`) are instance methods - call them on the instance returned from `init()` or `getInstance()`.
 
-For complete API documentation, see the [API Reference](https://trypillar.com/docs/reference/core).
+For complete API documentation, see the [API Reference](https://trypillar.com/docs/reference).
 
 ## Framework Integrations
 
 For idiomatic integration with your framework, use our framework-specific packages:
 
-| Framework | Package | Installation |
-|-----------|---------|--------------|
-| React | [@pillar-ai/react](https://github.com/pillarhq/sdk-react) | `npm install @pillar-ai/react` |
-| Vue | [@pillar-ai/vue](https://github.com/pillarhq/sdk-vue) | `npm install @pillar-ai/vue` |
-| Svelte | [@pillar-ai/svelte](https://github.com/pillarhq/sdk-svelte) | `npm install @pillar-ai/svelte` |
+| Framework | Package                                                     | Installation                    |
+| --------- | ----------------------------------------------------------- | ------------------------------- |
+| React     | [@pillar-ai/react](https://github.com/pillarhq/sdk-react)   | `npm install @pillar-ai/react`  |
+| Vue       | [@pillar-ai/vue](https://github.com/pillarhq/sdk-vue)       | `npm install @pillar-ai/vue`    |
+| Svelte    | [@pillar-ai/svelte](https://github.com/pillarhq/sdk-svelte) | `npm install @pillar-ai/svelte` |
 
 ## License
 

package/dist/actions/definitions/analytics.d.ts

@@ -0,0 +1,18 @@
+export declare const analyticsActions: {
+    view_search_analytics: {
+        description: string;
+        type: "navigate";
+        path: string;
+        autoRun: true;
+        autoComplete: true;
+        handler: () => void;
+    };
+    view_ai_analytics: {
+        description: string;
+        type: "navigate";
+        path: string;
+        autoRun: true;
+        autoComplete: true;
+        handler: () => void;
+    };
+};

package/dist/actions/definitions/content.d.ts

@@ -0,0 +1,40 @@
+export declare const contentActions: {
+    view_all_articles: {
+        description: string;
+        type: "navigate";
+        path: string;
+        autoRun: true;
+        autoComplete: true;
+        handler: () => void;
+    };
+    view_article: {
+        description: string;
+        type: "trigger_action";
+        autoRun: false;
+        autoComplete: false;
+        defaultData: {
+            action: string;
+        };
+        handler: () => void;
+    };
+    filter_stale: {
+        description: string;
+        type: "trigger_action";
+        autoRun: false;
+        autoComplete: false;
+        defaultData: {
+            action: string;
+        };
+        handler: () => void;
+    };
+    view_categories: {
+        description: string;
+        type: "trigger_action";
+        autoRun: false;
+        autoComplete: false;
+        defaultData: {
+            action: string;
+        };
+        handler: () => void;
+    };
+};

package/dist/actions/definitions/index.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Action Definitions Index
+ *
+ * Imports and registers all action definitions for the Pillar Admin app.
+ * These are code-first action definitions that get synced to the backend
+ * during CI/CD builds.
+ *
+ * To use in your app:
+ * 1. Import this file early in your app initialization
+ * 2. Or create your own action definitions using defineActions()
+ *
+ * The action metadata is extracted via `npm run extract-actions` and
+ * synced to the backend via `npm run sync-actions`.
+ */
+import './navigation';
+import './settings';
+import './sources';
+import './analytics';
+import './team';
+import './support';
+export { navigationActions } from './navigation';
+export { settingsActions } from './settings';
+export { sourcesActions } from './sources';
+export { analyticsActions } from './analytics';
+export { teamActions } from './team';
+export { supportActions } from './support';

package/dist/actions/definitions/navigation.d.ts

@@ -0,0 +1,65 @@
+export declare const navigationActions: {
+    open_knowledge: {
+        description: string;
+        examples: string[];
+        type: "navigate";
+        path: string;
+        autoRun: true;
+        autoComplete: true;
+        handler: () => void;
+    };
+    open_settings: {
+        description: string;
+        examples: string[];
+        type: "navigate";
+        path: string;
+        autoRun: true;
+        autoComplete: true;
+        handler: () => void;
+    };
+    open_actions: {
+        description: string;
+        examples: string[];
+        type: "navigate";
+        path: string;
+        autoRun: true;
+        autoComplete: true;
+        handler: () => void;
+    };
+    open_analytics: {
+        description: string;
+        examples: string[];
+        type: "navigate";
+        path: string;
+        autoRun: true;
+        autoComplete: true;
+        handler: () => void;
+    };
+    open_ai_tester: {
+        description: string;
+        examples: string[];
+        type: "navigate";
+        path: string;
+        autoRun: true;
+        autoComplete: true;
+        handler: () => void;
+    };
+    open_configure: {
+        description: string;
+        examples: string[];
+        type: "navigate";
+        path: string;
+        autoRun: true;
+        autoComplete: true;
+        handler: () => void;
+    };
+    create_new_action: {
+        description: string;
+        examples: string[];
+        type: "navigate";
+        path: string;
+        autoRun: true;
+        autoComplete: true;
+        handler: () => void;
+    };
+};

package/dist/actions/definitions/settings.d.ts

@@ -0,0 +1,162 @@
+export declare const settingsActions: {
+    open_branding_settings: {
+        description: string;
+        examples: string[];
+        type: "navigate";
+        path: string;
+        autoRun: true;
+        autoComplete: true;
+        handler: () => void;
+    };
+    open_layout_settings: {
+        description: string;
+        examples: string[];
+        type: "navigate";
+        path: string;
+        autoRun: true;
+        autoComplete: true;
+        handler: () => void;
+    };
+    open_header_settings: {
+        description: string;
+        examples: string[];
+        type: "navigate";
+        path: string;
+        autoRun: true;
+        autoComplete: true;
+        handler: () => void;
+    };
+    open_footer_settings: {
+        description: string;
+        examples: string[];
+        type: "navigate";
+        path: string;
+        autoRun: true;
+        autoComplete: true;
+        handler: () => void;
+    };
+    open_features_settings: {
+        description: string;
+        examples: string[];
+        type: "navigate";
+        path: string;
+        autoRun: true;
+        autoComplete: true;
+        handler: () => void;
+    };
+    open_ai_settings: {
+        description: string;
+        examples: string[];
+        type: "navigate";
+        path: string;
+        autoRun: true;
+        autoComplete: true;
+        handler: () => void;
+    };
+    open_seo_settings: {
+        description: string;
+        examples: string[];
+        type: "navigate";
+        path: string;
+        autoRun: true;
+        autoComplete: true;
+        handler: () => void;
+    };
+    enable_ai_assistant: {
+        description: string;
+        type: "trigger_action";
+        autoRun: false;
+        autoComplete: false;
+        defaultData: {
+            action: string;
+            target: string;
+        };
+        handler: () => void;
+    };
+    disable_ai_assistant: {
+        description: string;
+        type: "trigger_action";
+        autoRun: false;
+        autoComplete: false;
+        defaultData: {
+            action: string;
+            target: string;
+        };
+        handler: () => void;
+    };
+    enable_dark_mode: {
+        description: string;
+        examples: string[];
+        type: "trigger_action";
+        autoRun: true;
+        autoComplete: true;
+        defaultData: {
+            action: string;
+            theme: string;
+        };
+        handler: () => void;
+    };
+    disable_dark_mode: {
+        description: string;
+        examples: string[];
+        type: "trigger_action";
+        autoRun: true;
+        autoComplete: true;
+        defaultData: {
+            action: string;
+            theme: string;
+        };
+        handler: () => void;
+    };
+    toggle_dark_mode: {
+        description: string;
+        examples: string[];
+        type: "trigger_action";
+        autoRun: true;
+        autoComplete: true;
+        defaultData: {
+            action: string;
+        };
+        handler: () => void;
+    };
+    change_theme: {
+        description: string;
+        type: "trigger_action";
+        autoRun: true;
+        autoComplete: true;
+        defaultData: {
+            action: string;
+        };
+        handler: () => void;
+    };
+    update_logo: {
+        description: string;
+        type: "trigger_action";
+        autoRun: true;
+        autoComplete: true;
+        defaultData: {
+            action: string;
+        };
+        handler: () => void;
+    };
+    add_footer_link: {
+        description: string;
+        type: "trigger_action";
+        autoRun: true;
+        autoComplete: true;
+        defaultData: {
+            action: string;
+        };
+        handler: () => void;
+    };
+    configure_suggested_questions: {
+        description: string;
+        type: "trigger_action";
+        autoRun: true;
+        autoComplete: true;
+        defaultData: {
+            action: string;
+        };
+        handler: () => void;
+    };
+};

package/dist/actions/definitions/sources.d.ts

@@ -0,0 +1,44 @@
+export declare const sourcesActions: {
+    add_new_source: {
+        description: string;
+        examples: string[];
+        type: "navigate";
+        path: string;
+        autoRun: true;
+        autoComplete: true;
+        dataSchema: {
+            type: "object";
+            properties: {
+                type: {
+                    type: "string";
+                    description: string;
+                };
+                url: {
+                    type: "string";
+                    description: string;
+                };
+                name: {
+                    type: "string";
+                    description: string;
+                };
+            };
+        };
+        handler: () => void;
+    };
+    crawl_website: {
+        description: string;
+        type: "navigate";
+        path: string;
+        autoRun: true;
+        autoComplete: true;
+        handler: () => void;
+    };
+    connect_cloud_storage: {
+        description: string;
+        type: "navigate";
+        path: string;
+        autoRun: true;
+        autoComplete: true;
+        handler: () => void;
+    };
+};

package/dist/actions/definitions/support.d.ts

@@ -0,0 +1,15 @@
+export declare const supportActions: {
+    escalate: {
+        description: string;
+        examples: string[];
+        type: "external_link";
+        externalUrl: string;
+        handler: () => void;
+    };
+    defer: {
+        description: string;
+        examples: string[];
+        type: "trigger_action";
+        handler: () => void;
+    };
+};

package/dist/actions/definitions/team.d.ts

@@ -0,0 +1,120 @@
+export declare const teamActions: {
+    open_team_settings: {
+        description: string;
+        type: "navigate";
+        path: string;
+        autoRun: true;
+        autoComplete: true;
+        handler: () => void;
+    };
+    invite_team_member: {
+        description: string;
+        type: "inline_ui";
+        autoRun: false;
+        autoComplete: false;
+        defaultData: {
+            card_type: string;
+            emails: never[];
+            role: string;
+        };
+        dataSchema: {
+            type: "object";
+            properties: {
+                emails: {
+                    type: "array";
+                    description: string;
+                };
+                role: {
+                    type: "string";
+                    description: string;
+                    enum: string[];
+                };
+            };
+            required: string[];
+        };
+        requiredContext: {
+            userRole: string;
+        };
+        handler: () => void;
+    };
+    view_pending_invitations: {
+        description: string;
+        type: "trigger_action";
+        autoRun: true;
+        autoComplete: true;
+        defaultData: {
+            action: string;
+        };
+        requiredContext: {
+            userRole: string;
+        };
+        handler: () => void;
+    };
+    resend_invitation: {
+        description: string;
+        type: "trigger_action";
+        autoRun: false;
+        autoComplete: false;
+        defaultData: {
+            action: string;
+        };
+        requiredContext: {
+            userRole: string;
+        };
+        handler: () => void;
+    };
+    cancel_invitation: {
+        description: string;
+        type: "trigger_action";
+        autoRun: false;
+        autoComplete: false;
+        defaultData: {
+            action: string;
+        };
+        requiredContext: {
+            userRole: string;
+        };
+        handler: () => void;
+    };
+    remove_team_member: {
+        description: string;
+        type: "trigger_action";
+        autoRun: false;
+        autoComplete: false;
+        defaultData: {
+            action: string;
+        };
+        requiredContext: {
+            userRole: string;
+        };
+        handler: () => void;
+    };
+    promote_to_admin: {
+        description: string;
+        type: "trigger_action";
+        autoRun: false;
+        autoComplete: false;
+        defaultData: {
+            action: string;
+            role: string;
+        };
+        requiredContext: {
+            userRole: string;
+        };
+        handler: () => void;
+    };
+    demote_to_member: {
+        description: string;
+        type: "trigger_action";
+        autoRun: false;
+        autoComplete: false;
+        defaultData: {
+            action: string;
+            role: string;
+        };
+        requiredContext: {
+            userRole: string;
+        };
+        handler: () => void;
+    };
+};

package/dist/api/ag-ui-adapter.d.ts

@@ -0,0 +1,76 @@
+/**
+ * AG-UI Client Adapter for Pillar SDK
+ *
+ * Bridges the new AGUIClient to existing chat store patterns.
+ * Allows gradual migration without changing all components at once.
+ *
+ * Copyright (C) 2025 Pillar Team
+ */
+import type { ResolvedConfig } from '../core/config';
+import type { ExecutionPlan } from '../core/plan';
+import type { TaskButtonData } from '../components/Panel/TaskButton';
+import type { UserContextItem } from '../types/user-context';
+import type { ArticleSummary, ChatMessage, ChatResponse, ProgressEvent } from './client';
+import type { QueryRequest, ChatImage } from './mcp-client';
+import { type ClientTool } from './ag-ui-client';
+export interface LegacyStreamCallbacks {
+    /** Called for each text token */
+    onToken?: (token: string) => void;
+    /** Called when sources are available */
+    onSources?: (sources: ArticleSummary[]) => void;
+    /** Called when actions are available */
+    onActions?: (actions: TaskButtonData[]) => void;
+    /** Called when a plan is created */
+    onPlan?: (plan: ExecutionPlan) => void;
+    /** Called for progress updates */
+    onProgress?: (progress: ProgressEvent) => void;
+    /** Called when conversation starts (early conversation_id) */
+    onConversationStarted?: (conversationId: string, messageId?: string) => void;
+    /** Called when agent requests data from host app */
+    onQueryRequest?: (request: QueryRequest) => Promise<void>;
+    /** Called on error */
+    onError?: (error: string) => void;
+    /** Called when stream is complete */
+    onComplete?: (conversationId?: string, queryLogId?: string) => void;
+}
+/**
+ * Wraps AGUIClient to provide the same interface as the legacy MCPClient.
+ * Used during migration to minimize component changes.
+ */
+export declare class AGUIClientAdapter {
+    private client;
+    private currentStep;
+    constructor(config: ResolvedConfig);
+    /**
+     * Register a client-side tool (query action).
+     */
+    registerTool(tool: ClientTool): void;
+    /**
+     * Unregister a client-side tool.
+     */
+    unregisterTool(toolName: string): void;
+    /**
+     * Chat with streaming, using legacy callback patterns.
+     */
+    chat(message: string, callbacks: LegacyStreamCallbacks, options?: {
+        history?: ChatMessage[];
+        userContext?: UserContextItem[];
+        images?: ChatImage[];
+        signal?: AbortSignal;
+    }): Promise<ChatResponse>;
+    /**
+     * Get current thread ID.
+     */
+    get threadId(): string;
+    /**
+     * Start a new conversation.
+     */
+    newThread(): string;
+    /**
+     * Send action result back to the agent (for query actions).
+     *
+     * @param actionName - The name of the action that was executed
+     * @param result - The result data to send back to the agent
+     */
+    sendActionResult(actionName: string, result: unknown): Promise<void>;
+}