@pillar-ai/sdk 0.1.0

package/README.md

@@ -0,0 +1,129 @@
+# @pillar-ai/sdk
+
+Pillar Embedded Help SDK - Add contextual help, tooltips, and AI chat to your application.
+
+## Installation
+
+```bash
+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';
+
+await Pillar.init({
+  helpCenter: 'your-help-center',
+  publicKey: 'pk_live_xxx',
+});
+```
+
+## Configuration
+
+```javascript
+Pillar.init({
+  // Required
+  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',
+    },
+
+    // Tooltips
+    tooltips: {
+      enabled: true,
+      trigger: 'hover', // 'hover' | 'click'
+    },
+
+    // Theme
+    theme: {
+      mode: 'system', // 'light' | 'dark' | 'system'
+      colors: {
+        primary: '#6366f1',
+      },
+    },
+  },
+});
+```
+
+## Features
+
+- **AI Chat**: Embedded AI assistant that understands your product
+- **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
+
+## API Reference
+
+### Pillar.init(config)
+
+Initialize the SDK with your configuration.
+
+### Pillar.open()
+
+Open the help panel.
+
+### Pillar.close()
+
+Close the help panel.
+
+### Pillar.toggle()
+
+Toggle the help panel open/closed.
+
+### Pillar.setContext(context)
+
+Update the user/product context.
+
+### Pillar.on(event, callback)
+
+Subscribe to SDK events.
+
+## React Integration
+
+For React applications, use the `@pillar-ai/react` package for a more idiomatic integration with hooks and components.
+
+```bash
+npm install @pillar-ai/react
+```
+
+## License
+
+MIT

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/actions/index.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Actions Module - Code-first action definitions for Pillar SDK.
+ *
+ * This module enables developers to define actions in their application code
+ * rather than in the admin UI. Action metadata is synced to the server during
+ * CI/CD builds via the `pillar-sync` CLI.
+ *
+ * @example
+ * ```ts
+ * // 1. Define actions in your app (e.g., lib/pillar/actions.ts)
+ * import type { SyncActionDefinitions } from '@pillar-ai/sdk';
+ *
+ * export const actions: SyncActionDefinitions = {
+ *   open_settings: {
+ *     description: 'Navigate to settings page',
+ *     type: 'navigate',
+ *     path: '/settings',
+ *     autoRun: true,
+ *   },
+ * };
+ *
+ * // 2. Sync actions via CI/CD
+ * // npx pillar-sync --actions ./lib/pillar/actions.ts
+ *
+ * // 3. Register handlers at runtime
+ * pillar.onTask('open_settings', () => router.push('/settings'));
+ * pillar.onTask('navigate', ({ path }) => router.push(path));
+ * ```
+ *
+ * @module actions
+ */
+export type { ActionType, ActionDataSchema, ActionDefinition, ActionDefinitions, ActionManifest, ActionManifestEntry, ClientInfo, Platform, SyncActionDefinition, SyncActionDefinitions, ActionTypeDataMap, NavigateActionData, TriggerActionData, InlineUIData, ExternalLinkData, CopyTextData, ActionDataType, ActionNames, TypedTaskHandler, TypedOnTask, TypedPillarMethods, } from './types';
+export { defineActions, setClientInfo, getClientInfo, getHandler, getActionDefinition, hasAction, getActionNames, getManifest, clearRegistry, getActionCount, } from './registry';