@pillar-ai/sdk 0.1.33 → 0.1.34
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -21
- package/dist/cli/sync.js +3 -0
- package/dist/core/config.d.ts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/pillar.esm.js +1 -1
- package/dist/store/chat.d.ts +10 -0
- package/dist/tools/index.d.ts +1 -1
- package/dist/tools/types.d.ts +100 -43
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -31,7 +31,7 @@ Pillar understands the intent, builds a multi-step plan, and executes it client-
|
|
|
31
31
|
- **Multi-Step Plans** — Chain actions into workflows for complex tasks
|
|
32
32
|
- **Context-Aware** — Knows current page, user state, and selected text
|
|
33
33
|
- **Knowledge Sync** — Trained on your docs, Zendesk, Intercom, and more
|
|
34
|
-
- **Custom
|
|
34
|
+
- **Render Custom Components** — Render your own interactive UI in the chat
|
|
35
35
|
- **Framework Bindings** — First-class support for React, Vue, and Svelte
|
|
36
36
|
|
|
37
37
|
## Why Pillar?
|
|
@@ -42,7 +42,7 @@ Pillar understands the intent, builds a multi-step plan, and executes it client-
|
|
|
42
42
|
|
|
43
43
|
## Documentation
|
|
44
44
|
|
|
45
|
-
**[View Full Documentation](https://trypillar.com/docs)** | [Getting Started](https://trypillar.com/docs/get-started/quickstart) | [API Reference](https://trypillar.com/docs/reference
|
|
45
|
+
**[View Full Documentation](https://trypillar.com/docs)** | [Getting Started](https://trypillar.com/docs/get-started/quickstart) | [API Reference](https://trypillar.com/docs/reference)
|
|
46
46
|
|
|
47
47
|
## Installation
|
|
48
48
|
|
|
@@ -56,11 +56,9 @@ yarn add @pillar-ai/sdk
|
|
|
56
56
|
|
|
57
57
|
## Quick Start
|
|
58
58
|
|
|
59
|
-
### 1. Get
|
|
59
|
+
### 1. Get your product key
|
|
60
60
|
|
|
61
|
-
|
|
62
|
-
>
|
|
63
|
-
> 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.
|
|
61
|
+
Sign up at [app.trypillar.com](https://app.trypillar.com) and grab your product key from the dashboard.
|
|
64
62
|
|
|
65
63
|
### 2. Initialize the SDK
|
|
66
64
|
|
|
@@ -144,29 +142,29 @@ const pillar = await Pillar.init({
|
|
|
144
142
|
|
|
145
143
|
## API Reference
|
|
146
144
|
|
|
147
|
-
| Method
|
|
148
|
-
|
|
149
|
-
| `Pillar.init(config)`
|
|
150
|
-
| `Pillar.getInstance()`
|
|
151
|
-
| `pillar.open()`
|
|
152
|
-
| `pillar.close()`
|
|
153
|
-
| `pillar.toggle()`
|
|
154
|
-
| `pillar.setContext(context)` | Update the user/product context
|
|
155
|
-
| `pillar.on(event, callback)` | Subscribe to SDK events
|
|
145
|
+
| Method | Description |
|
|
146
|
+
| ---------------------------- | ---------------------------------------- |
|
|
147
|
+
| `Pillar.init(config)` | Initialize the SDK, returns the instance |
|
|
148
|
+
| `Pillar.getInstance()` | Get the initialized SDK instance |
|
|
149
|
+
| `pillar.open()` | Open the co-pilot panel |
|
|
150
|
+
| `pillar.close()` | Close the co-pilot panel |
|
|
151
|
+
| `pillar.toggle()` | Toggle the co-pilot panel |
|
|
152
|
+
| `pillar.setContext(context)` | Update the user/product context |
|
|
153
|
+
| `pillar.on(event, callback)` | Subscribe to SDK events |
|
|
156
154
|
|
|
157
155
|
> **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()`.
|
|
158
156
|
|
|
159
|
-
For complete API documentation, see the [API Reference](https://trypillar.com/docs/reference
|
|
157
|
+
For complete API documentation, see the [API Reference](https://trypillar.com/docs/reference).
|
|
160
158
|
|
|
161
159
|
## Framework Integrations
|
|
162
160
|
|
|
163
161
|
For idiomatic integration with your framework, use our framework-specific packages:
|
|
164
162
|
|
|
165
|
-
| Framework | Package
|
|
166
|
-
|
|
167
|
-
| React
|
|
168
|
-
| Vue
|
|
169
|
-
| Svelte
|
|
163
|
+
| Framework | Package | Installation |
|
|
164
|
+
| --------- | ----------------------------------------------------------- | ------------------------------- |
|
|
165
|
+
| React | [@pillar-ai/react](https://github.com/pillarhq/sdk-react) | `npm install @pillar-ai/react` |
|
|
166
|
+
| Vue | [@pillar-ai/vue](https://github.com/pillarhq/sdk-vue) | `npm install @pillar-ai/vue` |
|
|
167
|
+
| Svelte | [@pillar-ai/svelte](https://github.com/pillarhq/sdk-svelte) | `npm install @pillar-ai/svelte` |
|
|
170
168
|
|
|
171
169
|
## License
|
|
172
170
|
|
package/dist/cli/sync.js
CHANGED
|
@@ -437,6 +437,9 @@ function buildManifestFromScan(tools, platform, version, gitSha, agentGuidance)
|
|
|
437
437
|
return manifest;
|
|
438
438
|
}
|
|
439
439
|
async function main() {
|
|
440
|
+
console.log(
|
|
441
|
+
"[pillar-sync] Note: pillar-sync in @pillar-ai/sdk is deprecated. Use pillar-cli instead: npx pillar-cli sync"
|
|
442
|
+
);
|
|
440
443
|
const args = parseArgs(process.argv.slice(2));
|
|
441
444
|
if (args.help) {
|
|
442
445
|
printUsage();
|
package/dist/core/config.d.ts
CHANGED
package/dist/index.d.ts
CHANGED
|
@@ -22,7 +22,7 @@ export { EventEmitter, type CardCallbacks, type CardRenderer, type PillarEvents,
|
|
|
22
22
|
export { Pillar, type ChatContext, type PillarState, type ToolInfo } from "./core/Pillar";
|
|
23
23
|
export { DEFAULT_SIDEBAR_TABS, type DOMScanningConfig, type EdgeTriggerConfig, type InteractionHighlightConfig, type MobileTriggerConfig, type MobileTriggerIcon, type MobileTriggerPosition, type MobileTriggerSize, type PanelConfig, type PanelMode, type PanelPosition, type PillarConfig, type ResolvedConfig, type ResolvedDOMScanningConfig, type ResolvedInteractionHighlightConfig, type ResolvedMobileTriggerConfig, type ResolvedPanelConfig, type ResolvedSuggestionsConfig, type ResolvedThemeConfig, type SidebarTabConfig, type SuggestionsConfig, type TextSelectionConfig, type ThemeColors, type ThemeConfig, type ThemeMode, type UrlParamsConfig, type ZIndexConfig, } from "./core/config";
|
|
24
24
|
export { type AssistantContext, type Context, type Suggestion, type UserProfile, } from "./core/context";
|
|
25
|
-
export { clearRegistry, getToolCount, getToolDefinition, getToolNames, getClientInfo, getHandler, getManifest, hasTool, setClientInfo, type ToolDataSchema, type ToolDataSchemaProperty, type ToolDataType, type ToolDefinition, type ToolDefinitions, type ToolManifest, type ToolManifestEntry, type ToolNames, type ToolType, type ToolTypeDataMap, type ToolExecuteResult, type ToolSchema, type ClientInfo, type CopyTextData, type ExternalLinkData, type InlineUIData, type NavigateToolData, type TriggerToolData, type QueryToolData, type Platform, type SyncToolDefinition, type SyncToolDefinitions, type TypedOnTask, type TypedPillarMethods, type TypedTaskHandler, getActionCount, getActionDefinition, getActionNames, hasAction, type ActionDataSchema, type ActionDataSchemaProperty, type ActionDataType, type ActionDefinition, type ActionDefinitions, type ActionManifest, type ActionManifestEntry, type ActionNames, type ActionType, type ActionTypeDataMap, type ActionResult, type ActionSchema, type NavigateActionData, type TriggerActionData, type QueryActionData, type SyncActionDefinition, type SyncActionDefinitions, } from "./tools";
|
|
25
|
+
export { clearRegistry, getToolCount, getToolDefinition, getToolNames, getClientInfo, getHandler, getManifest, hasTool, setClientInfo, type ToolDataSchema, type ToolDataSchemaProperty, type ToolDataType, type ToolDefinition, type ToolDefinitions, type ToolManifest, type ToolManifestEntry, type ToolNames, type ToolType, type ToolTypeDataMap, type ToolExecuteResult, type ToolSchemaBase, type InlineUIToolSchema, type ExecutableToolSchema, type ToolSchema, type ClientInfo, type CopyTextData, type ExternalLinkData, type InlineUIData, type NavigateToolData, type TriggerToolData, type QueryToolData, type Platform, type SyncToolDefinition, type SyncToolDefinitions, type TypedOnTask, type TypedPillarMethods, type TypedTaskHandler, getActionCount, getActionDefinition, getActionNames, hasAction, type ActionDataSchema, type ActionDataSchemaProperty, type ActionDataType, type ActionDefinition, type ActionDefinitions, type ActionManifest, type ActionManifestEntry, type ActionNames, type ActionType, type ActionTypeDataMap, type ActionResult, type ActionSchema, type NavigateActionData, type TriggerActionData, type QueryActionData, type SyncActionDefinition, type SyncActionDefinitions, } from "./tools";
|
|
26
26
|
export { APIClient, type ArticleSummary, type ChatMessage, type ChatResponse, type ProgressEvent, } from "./api/client";
|
|
27
27
|
export { type ToolRequest, type ToolData, type ChatImage, type ImageUploadResponse, type TokenUsage, toolToTaskButton, type ActionRequest, type ActionData, actionToTaskButton, } from "./api/mcp-client";
|
|
28
28
|
export { DEFAULT_SCAN_OPTIONS, INTERACTABLE_ROLES, INTERACTABLE_TAGS, SKIP_TAGS, type CompactScanResult, type InteractionType, type ScanOptions, } from "./types/dom-scanner";
|