@redplanethq/sdk 0.1.17 → 0.1.18

package/dist/index.d.mts

@@ -421,6 +421,58 @@ type WidgetComponent = WebWidgetComponent | TuiWidgetComponent;
 interface WidgetSpec extends WidgetMeta {
     render(context: WidgetRenderContext): Promise<WidgetComponent>;
 }
+/** Recursive JSON value type — covers all valid tool input shapes */
+type ToolInputPrimitive = string | number | boolean | null;
+type ToolInputValue = ToolInputPrimitive | ToolInputValue[] | {
+    [key: string]: ToolInputValue;
+};
+type ToolInput = Record<string, ToolInputValue>;
+/** A single content block in a tool result */
+interface ToolContent {
+    type: string;
+    text: string;
+}
+/** The result returned by a tool call */
+interface ToolResult {
+    content: ToolContent[];
+    isError?: boolean;
+}
+/** A pi-tui component rendering a tool result (tui placement) */
+interface TuiToolUIComponent {
+    render: (width: number) => string[];
+}
+/** A React component rendering a tool result (webapp placement) */
+type WebToolUIComponent = () => object;
+type ToolUIComponent = WebToolUIComponent | TuiToolUIComponent;
+/** Context passed to a ToolUI renderer */
+interface ToolUIRenderContext {
+    placement: 'tui' | 'webapp';
+    pat: string;
+    accounts: Array<{
+        id: string;
+        slug: string;
+        name?: string;
+    }>;
+    baseUrl: string;
+}
+/**
+ * Integration-defined UI for tool calls.
+ * render() is called in two phases:
+ *   Phase 1 — result is null: tool input is known, user can modify and call submitInput()
+ *   Phase 2 — result is present: tool has run, show rich result UI
+ */
+interface ToolUI {
+    supported_tools: string[];
+    render(toolName: string, input: ToolInput, result: ToolResult | null, context: ToolUIRenderContext, submitInput: (input: ToolInput) => void): Promise<ToolUIComponent>;
+}
+/**
+ * Shape exported by an integration's frontend.js bundle.
+ * Combines widgets (standalone) and toolUI (per-tool result renderer).
+ */
+interface FrontendExport {
+    widgets?: WidgetSpec[];
+    toolUI?: ToolUI;
+}
 declare enum IntegrationEventType {
     /**
      * Processes authentication data and returns tokens/credentials to be saved
@@ -481,6 +533,8 @@ declare class Spec {
         mcp?: McpAuthParams;
     };
     widgets?: WidgetMeta[];
+    /** Set to true when the integration's frontend bundle exports a ToolUI */
+    toolUISupported?: boolean;
 }
 interface Config {
     access_token: string;
@@ -1242,4 +1296,4 @@ declare class CoreClient {
     checkAuth(): Promise<MeResponse>;
 }
 
-export { APIKeyParams, ActionStatus, ActionStatusEnum, type AddEpisodeParams, type AddEpisodeResult, type AdjacentChunks, type AuthType, type AuthorizationCodeResponse, AuthorizationCodeResponseSchema, COMPACTED_SESSION_NODE_PROPERTIES, ClaudeModels, type CompactedSessionNode, type Config, CoreClient, CoreClientError, type CoreClientOptions, type CreatePatternParams, type DocumentNode, DocumentSchema, ENTITY_NODE_PROPERTIES, EPISODIC_NODE_PROPERTIES, EXPLICIT_PATTERN_TYPES, type EntityNode, type EntityType, EntityTypes, type EpisodeSearchResult, EpisodeType, EpisodeTypeEnum, type EpisodeWithProvenance, type EpisodicNode, type EpisodicNodeWithoutEmbeddings, type ExecuteGatewayInput, ExecuteGatewayInputSchema, type ExecuteGatewayResponse, ExecuteGatewayResponseSchema, type ExecuteGatewayToolInput, ExecuteGatewayToolInputSchema, type ExecuteIntegrationActionInput, ExecuteIntegrationActionInputSchema, type ExecuteIntegrationActionResponse, ExecuteIntegrationActionResponseSchema, type ExplicitPatternType, type ExtractedTripleData, GRAPH_ASPECTS, type GatewayAgentInfo, GatewayAgentInfoSchema, GeminiModels, type GetDocumentInput, GetDocumentInputSchema, type GetDocumentResponse, GetDocumentResponseSchema, type GetDocumentsInput, GetDocumentsInputSchema, type GetDocumentsResponse, GetDocumentsResponseSchema, type GetGatewaysResponse, GetGatewaysResponseSchema, type GetIntegrationActionsInput, GetIntegrationActionsInputSchema, type GetIntegrationActionsResponse, GetIntegrationActionsResponseSchema, type GetIntegrationsConnectedResponse, GetIntegrationsConnectedResponseSchema, type GraphAspect, IMPLICIT_PATTERN_TYPES, type Identifier, type ImplicitPatternType, type IngestInput, IngestInputSchema, type IngestResponse, IngestResponseSchema, IntegrationAccountSchema, IntegrationCLI, type IntegrationEventPayload, IntegrationEventType, LLMMappings, LLMModelEnum, LLMModelType, McpAuthParams, type MeResponse, MeResponseSchema, type Message, type MessageType, OAuth2Params, OpenAIModels, PATTERN_TYPES, type Param, type PatternConfirmationParams, type PatternDetectionResult, type PatternType, QUALITY_THRESHOLDS, type QualityFilterResult, type RerankConfig, STATEMENT_NODE_PROPERTIES, type SearchInput, SearchInputSchema, type SearchOptions, type SearchResponse, SearchResponseSchema, type SpaceAssignmentResult, type SpaceDeletionResult, type SpaceNode, type SpacePattern, Spec, type StatementAspect, StatementAspects, type StatementNode, type StatementWithSource, type TokenExchangeInput, TokenExchangeInputSchema, type TokenExchangeResponse, TokenExchangeResponseSchema, type Triple, type TuiWidgetComponent, type UserConfirmationStatus, UserTypeEnum, VOICE_ASPECTS, type VoiceAspect, type VoiceAspectNode, type WebWidgetComponent, type WidgetComponent, type WidgetMeta, type WidgetRenderContext, type WidgetSpec };
+export { APIKeyParams, ActionStatus, ActionStatusEnum, type AddEpisodeParams, type AddEpisodeResult, type AdjacentChunks, type AuthType, type AuthorizationCodeResponse, AuthorizationCodeResponseSchema, COMPACTED_SESSION_NODE_PROPERTIES, ClaudeModels, type CompactedSessionNode, type Config, CoreClient, CoreClientError, type CoreClientOptions, type CreatePatternParams, type DocumentNode, DocumentSchema, ENTITY_NODE_PROPERTIES, EPISODIC_NODE_PROPERTIES, EXPLICIT_PATTERN_TYPES, type EntityNode, type EntityType, EntityTypes, type EpisodeSearchResult, EpisodeType, EpisodeTypeEnum, type EpisodeWithProvenance, type EpisodicNode, type EpisodicNodeWithoutEmbeddings, type ExecuteGatewayInput, ExecuteGatewayInputSchema, type ExecuteGatewayResponse, ExecuteGatewayResponseSchema, type ExecuteGatewayToolInput, ExecuteGatewayToolInputSchema, type ExecuteIntegrationActionInput, ExecuteIntegrationActionInputSchema, type ExecuteIntegrationActionResponse, ExecuteIntegrationActionResponseSchema, type ExplicitPatternType, type ExtractedTripleData, type FrontendExport, GRAPH_ASPECTS, type GatewayAgentInfo, GatewayAgentInfoSchema, GeminiModels, type GetDocumentInput, GetDocumentInputSchema, type GetDocumentResponse, GetDocumentResponseSchema, type GetDocumentsInput, GetDocumentsInputSchema, type GetDocumentsResponse, GetDocumentsResponseSchema, type GetGatewaysResponse, GetGatewaysResponseSchema, type GetIntegrationActionsInput, GetIntegrationActionsInputSchema, type GetIntegrationActionsResponse, GetIntegrationActionsResponseSchema, type GetIntegrationsConnectedResponse, GetIntegrationsConnectedResponseSchema, type GraphAspect, IMPLICIT_PATTERN_TYPES, type Identifier, type ImplicitPatternType, type IngestInput, IngestInputSchema, type IngestResponse, IngestResponseSchema, IntegrationAccountSchema, IntegrationCLI, type IntegrationEventPayload, IntegrationEventType, LLMMappings, LLMModelEnum, LLMModelType, McpAuthParams, type MeResponse, MeResponseSchema, type Message, type MessageType, OAuth2Params, OpenAIModels, PATTERN_TYPES, type Param, type PatternConfirmationParams, type PatternDetectionResult, type PatternType, QUALITY_THRESHOLDS, type QualityFilterResult, type RerankConfig, STATEMENT_NODE_PROPERTIES, type SearchInput, SearchInputSchema, type SearchOptions, type SearchResponse, SearchResponseSchema, type SpaceAssignmentResult, type SpaceDeletionResult, type SpaceNode, type SpacePattern, Spec, type StatementAspect, StatementAspects, type StatementNode, type StatementWithSource, type TokenExchangeInput, TokenExchangeInputSchema, type TokenExchangeResponse, TokenExchangeResponseSchema, type ToolContent, type ToolInput, type ToolInputPrimitive, type ToolInputValue, type ToolResult, type ToolUI, type ToolUIComponent, type ToolUIRenderContext, type Triple, type TuiToolUIComponent, type TuiWidgetComponent, type UserConfirmationStatus, UserTypeEnum, VOICE_ASPECTS, type VoiceAspect, type VoiceAspectNode, type WebToolUIComponent, type WebWidgetComponent, type WidgetComponent, type WidgetMeta, type WidgetRenderContext, type WidgetSpec };

package/dist/index.d.ts

@@ -421,6 +421,58 @@ type WidgetComponent = WebWidgetComponent | TuiWidgetComponent;
 interface WidgetSpec extends WidgetMeta {
     render(context: WidgetRenderContext): Promise<WidgetComponent>;
 }
+/** Recursive JSON value type — covers all valid tool input shapes */
+type ToolInputPrimitive = string | number | boolean | null;
+type ToolInputValue = ToolInputPrimitive | ToolInputValue[] | {
+    [key: string]: ToolInputValue;
+};
+type ToolInput = Record<string, ToolInputValue>;
+/** A single content block in a tool result */
+interface ToolContent {
+    type: string;
+    text: string;
+}
+/** The result returned by a tool call */
+interface ToolResult {
+    content: ToolContent[];
+    isError?: boolean;
+}
+/** A pi-tui component rendering a tool result (tui placement) */
+interface TuiToolUIComponent {
+    render: (width: number) => string[];
+}
+/** A React component rendering a tool result (webapp placement) */
+type WebToolUIComponent = () => object;
+type ToolUIComponent = WebToolUIComponent | TuiToolUIComponent;
+/** Context passed to a ToolUI renderer */
+interface ToolUIRenderContext {
+    placement: 'tui' | 'webapp';
+    pat: string;
+    accounts: Array<{
+        id: string;
+        slug: string;
+        name?: string;
+    }>;
+    baseUrl: string;
+}
+/**
+ * Integration-defined UI for tool calls.
+ * render() is called in two phases:
+ *   Phase 1 — result is null: tool input is known, user can modify and call submitInput()
+ *   Phase 2 — result is present: tool has run, show rich result UI
+ */
+interface ToolUI {
+    supported_tools: string[];
+    render(toolName: string, input: ToolInput, result: ToolResult | null, context: ToolUIRenderContext, submitInput: (input: ToolInput) => void): Promise<ToolUIComponent>;
+}
+/**
+ * Shape exported by an integration's frontend.js bundle.
+ * Combines widgets (standalone) and toolUI (per-tool result renderer).
+ */
+interface FrontendExport {
+    widgets?: WidgetSpec[];
+    toolUI?: ToolUI;
+}
 declare enum IntegrationEventType {
     /**
      * Processes authentication data and returns tokens/credentials to be saved
@@ -481,6 +533,8 @@ declare class Spec {
         mcp?: McpAuthParams;
     };
     widgets?: WidgetMeta[];
+    /** Set to true when the integration's frontend bundle exports a ToolUI */
+    toolUISupported?: boolean;
 }
 interface Config {
     access_token: string;
@@ -1242,4 +1296,4 @@ declare class CoreClient {
     checkAuth(): Promise<MeResponse>;
 }
 
-export { APIKeyParams, ActionStatus, ActionStatusEnum, type AddEpisodeParams, type AddEpisodeResult, type AdjacentChunks, type AuthType, type AuthorizationCodeResponse, AuthorizationCodeResponseSchema, COMPACTED_SESSION_NODE_PROPERTIES, ClaudeModels, type CompactedSessionNode, type Config, CoreClient, CoreClientError, type CoreClientOptions, type CreatePatternParams, type DocumentNode, DocumentSchema, ENTITY_NODE_PROPERTIES, EPISODIC_NODE_PROPERTIES, EXPLICIT_PATTERN_TYPES, type EntityNode, type EntityType, EntityTypes, type EpisodeSearchResult, EpisodeType, EpisodeTypeEnum, type EpisodeWithProvenance, type EpisodicNode, type EpisodicNodeWithoutEmbeddings, type ExecuteGatewayInput, ExecuteGatewayInputSchema, type ExecuteGatewayResponse, ExecuteGatewayResponseSchema, type ExecuteGatewayToolInput, ExecuteGatewayToolInputSchema, type ExecuteIntegrationActionInput, ExecuteIntegrationActionInputSchema, type ExecuteIntegrationActionResponse, ExecuteIntegrationActionResponseSchema, type ExplicitPatternType, type ExtractedTripleData, GRAPH_ASPECTS, type GatewayAgentInfo, GatewayAgentInfoSchema, GeminiModels, type GetDocumentInput, GetDocumentInputSchema, type GetDocumentResponse, GetDocumentResponseSchema, type GetDocumentsInput, GetDocumentsInputSchema, type GetDocumentsResponse, GetDocumentsResponseSchema, type GetGatewaysResponse, GetGatewaysResponseSchema, type GetIntegrationActionsInput, GetIntegrationActionsInputSchema, type GetIntegrationActionsResponse, GetIntegrationActionsResponseSchema, type GetIntegrationsConnectedResponse, GetIntegrationsConnectedResponseSchema, type GraphAspect, IMPLICIT_PATTERN_TYPES, type Identifier, type ImplicitPatternType, type IngestInput, IngestInputSchema, type IngestResponse, IngestResponseSchema, IntegrationAccountSchema, IntegrationCLI, type IntegrationEventPayload, IntegrationEventType, LLMMappings, LLMModelEnum, LLMModelType, McpAuthParams, type MeResponse, MeResponseSchema, type Message, type MessageType, OAuth2Params, OpenAIModels, PATTERN_TYPES, type Param, type PatternConfirmationParams, type PatternDetectionResult, type PatternType, QUALITY_THRESHOLDS, type QualityFilterResult, type RerankConfig, STATEMENT_NODE_PROPERTIES, type SearchInput, SearchInputSchema, type SearchOptions, type SearchResponse, SearchResponseSchema, type SpaceAssignmentResult, type SpaceDeletionResult, type SpaceNode, type SpacePattern, Spec, type StatementAspect, StatementAspects, type StatementNode, type StatementWithSource, type TokenExchangeInput, TokenExchangeInputSchema, type TokenExchangeResponse, TokenExchangeResponseSchema, type Triple, type TuiWidgetComponent, type UserConfirmationStatus, UserTypeEnum, VOICE_ASPECTS, type VoiceAspect, type VoiceAspectNode, type WebWidgetComponent, type WidgetComponent, type WidgetMeta, type WidgetRenderContext, type WidgetSpec };
+export { APIKeyParams, ActionStatus, ActionStatusEnum, type AddEpisodeParams, type AddEpisodeResult, type AdjacentChunks, type AuthType, type AuthorizationCodeResponse, AuthorizationCodeResponseSchema, COMPACTED_SESSION_NODE_PROPERTIES, ClaudeModels, type CompactedSessionNode, type Config, CoreClient, CoreClientError, type CoreClientOptions, type CreatePatternParams, type DocumentNode, DocumentSchema, ENTITY_NODE_PROPERTIES, EPISODIC_NODE_PROPERTIES, EXPLICIT_PATTERN_TYPES, type EntityNode, type EntityType, EntityTypes, type EpisodeSearchResult, EpisodeType, EpisodeTypeEnum, type EpisodeWithProvenance, type EpisodicNode, type EpisodicNodeWithoutEmbeddings, type ExecuteGatewayInput, ExecuteGatewayInputSchema, type ExecuteGatewayResponse, ExecuteGatewayResponseSchema, type ExecuteGatewayToolInput, ExecuteGatewayToolInputSchema, type ExecuteIntegrationActionInput, ExecuteIntegrationActionInputSchema, type ExecuteIntegrationActionResponse, ExecuteIntegrationActionResponseSchema, type ExplicitPatternType, type ExtractedTripleData, type FrontendExport, GRAPH_ASPECTS, type GatewayAgentInfo, GatewayAgentInfoSchema, GeminiModels, type GetDocumentInput, GetDocumentInputSchema, type GetDocumentResponse, GetDocumentResponseSchema, type GetDocumentsInput, GetDocumentsInputSchema, type GetDocumentsResponse, GetDocumentsResponseSchema, type GetGatewaysResponse, GetGatewaysResponseSchema, type GetIntegrationActionsInput, GetIntegrationActionsInputSchema, type GetIntegrationActionsResponse, GetIntegrationActionsResponseSchema, type GetIntegrationsConnectedResponse, GetIntegrationsConnectedResponseSchema, type GraphAspect, IMPLICIT_PATTERN_TYPES, type Identifier, type ImplicitPatternType, type IngestInput, IngestInputSchema, type IngestResponse, IngestResponseSchema, IntegrationAccountSchema, IntegrationCLI, type IntegrationEventPayload, IntegrationEventType, LLMMappings, LLMModelEnum, LLMModelType, McpAuthParams, type MeResponse, MeResponseSchema, type Message, type MessageType, OAuth2Params, OpenAIModels, PATTERN_TYPES, type Param, type PatternConfirmationParams, type PatternDetectionResult, type PatternType, QUALITY_THRESHOLDS, type QualityFilterResult, type RerankConfig, STATEMENT_NODE_PROPERTIES, type SearchInput, SearchInputSchema, type SearchOptions, type SearchResponse, SearchResponseSchema, type SpaceAssignmentResult, type SpaceDeletionResult, type SpaceNode, type SpacePattern, Spec, type StatementAspect, StatementAspects, type StatementNode, type StatementWithSource, type TokenExchangeInput, TokenExchangeInputSchema, type TokenExchangeResponse, TokenExchangeResponseSchema, type ToolContent, type ToolInput, type ToolInputPrimitive, type ToolInputValue, type ToolResult, type ToolUI, type ToolUIComponent, type ToolUIRenderContext, type Triple, type TuiToolUIComponent, type TuiWidgetComponent, type UserConfirmationStatus, UserTypeEnum, VOICE_ASPECTS, type VoiceAspect, type VoiceAspectNode, type WebToolUIComponent, type WebWidgetComponent, type WidgetComponent, type WidgetMeta, type WidgetRenderContext, type WidgetSpec };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redplanethq/sdk",
-  "version": "0.1.17",
+  "version": "0.1.18",
   "description": "CORE Node.JS SDK",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",