@flowcore/sdk 1.24.3 → 1.25.0

package/script/common/websocket-command.d.ts

@@ -0,0 +1,54 @@
+import type { Observable } from "rxjs";
+import type { StreamChunk } from "../contracts/ai-agent-coordinator-stream.js";
+/**
+ * Interface for a command that configures a WebSocket stream connection.
+ * @template Config - The type of the configuration data needed to initiate the stream.
+ * @template SendPayload - The type of data that can be sent *to* the stream after connection.
+ */
+export interface WebSocketCommand<Config, SendPayload> {
+    /**
+     * Gets the configuration data needed to establish the connection.
+     */
+    getConfig(): Config;
+    /**
+     * Gets the base WebSocket URL (e.g., wss://server.api.flowcore.io).
+     * @returns The base WebSocket URL string.
+     */
+    getWebSocketBaseUrl(): string;
+    /**
+     * Gets the specific path segment for the WebSocket URL based on the config
+     * (e.g., /api/v1/stream/entity/{id}).
+     * @param config - The configuration object.
+     * @returns The path segment string.
+     */
+    getWebSocketPathSegment(config: Config): string;
+    /**
+     * Serializes the payload to be sent over the WebSocket.
+     * Default implementation might be JSON.stringify.
+     * @param payload - The payload object to send.
+     * @returns The serialized string representation.
+     */
+    serializeSendPayload?(payload: SendPayload): string;
+}
+/**
+ * Interface representing an active WebSocket stream connection.
+ * @template SendPayload - The type of data that can be sent to the stream.
+ */
+export interface ActiveStreamInterface<SendPayload> {
+    /**
+     * An Observable emitting the raw data chunks received from the WebSocket.
+     * Consumers should filter/map this observable based on the specific stream protocol.
+     */
+    output$: Observable<StreamChunk>;
+    /**
+     * Sends a payload to the WebSocket stream.
+     * @param payload - The data to send, conforming to the SendPayload type.
+     * @returns True if the message was queued to be sent, false otherwise (e.g., socket not open).
+     */
+    send(payload: SendPayload): boolean;
+    /**
+     * Disconnects the WebSocket stream gracefully.
+     */
+    disconnect(): void;
+}
+//# sourceMappingURL=websocket-command.d.ts.map

package/script/common/websocket-command.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket-command.d.ts","sourceRoot":"","sources":["../../src/common/websocket-command.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,MAAM,CAAA;AACtC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6CAA6C,CAAA;AAE9E;;;;GAIG;AACH,MAAM,WAAW,gBAAgB,CAAC,MAAM,EAAE,WAAW;IACnD;;OAEG;IACH,SAAS,IAAI,MAAM,CAAA;IAEnB;;;OAGG;IACH,mBAAmB,IAAI,MAAM,CAAA;IAE7B;;;;;OAKG;IACH,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAA;IAE/C;;;;;OAKG;IACH,oBAAoB,CAAC,CAAC,OAAO,EAAE,WAAW,GAAG,MAAM,CAAA;CACpD;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB,CAAC,WAAW;IAChD;;;OAGG;IACH,OAAO,EAAE,UAAU,CAAC,WAAW,CAAC,CAAA;IAEhC;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAA;IAEnC;;OAEG;IACH,UAAU,IAAI,IAAI,CAAA;CACnB"}

package/script/common/websocket-command.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/script/contracts/ai-agent-coordinator-stream.d.ts

@@ -0,0 +1,85 @@
+import type { ContextItem } from "./ai-agent-coordinator.js";
+/**
+ * Configuration for initiating an AI Agent Coordinator stream.
+ */
+export interface AiStreamConfig {
+    /** The ID of the conversation to stream. */
+    conversationId: string;
+}
+export interface MarkdownDeltaChunk {
+    type: "markdown_delta";
+    /** The chunk of markdown text. */
+    content: string;
+}
+export interface ToolStartChunk {
+    type: "tool_start";
+    /** The name of the tool being executed. */
+    tool_name: string;
+}
+export interface ToolInputChunk {
+    type: "tool_input";
+    /** The input provided to the tool (can be any JSON structure). */
+    content: unknown;
+}
+export interface ToolOutputChunk {
+    type: "tool_output";
+    /** The output received from the tool (can be any JSON structure). */
+    content: unknown;
+}
+export interface ToolErrorChunk {
+    type: "tool_error";
+    content: {
+        /** A summary error message. */
+        error_message: string;
+        /** Optional additional details about the error. */
+        details?: string | unknown;
+    };
+}
+export interface ContextAddItemChunk {
+    type: "context_add_item";
+    /** The full context item that was added. */
+    item: ContextItem;
+}
+export interface TitleUpdateChunk {
+    type: "title_update";
+    /** The new suggested title for the conversation. */
+    title: string;
+}
+export interface ArtifactStartChunk {
+    type: "artifact_start";
+    artifactId: string;
+    artifactType: string;
+    title: string;
+}
+export interface ArtifactContentDeltaChunk {
+    type: "artifact_content_delta";
+    artifactId: string;
+    /** The chunk of artifact text content. */
+    content: string;
+}
+export interface ArtifactDataChunk {
+    type: "artifact_data";
+    artifactId: string;
+    /** The complete JSON data for the artifact. */
+    data: unknown;
+}
+export interface ArtifactUrlChunk {
+    type: "artifact_url";
+    artifactId: string;
+    /** The URL pointing to the artifact content. */
+    url: string;
+}
+export interface ArtifactEndChunk {
+    type: "artifact_end";
+    artifactId: string;
+}
+export interface ConversationCreatedChunk {
+    type: "conversation_created";
+    /** The ID of the newly created conversation. */
+    conversationId: string;
+}
+/**
+ * A discriminated union of all possible chunk types streamed from the backend.
+ */
+export type StreamChunk = MarkdownDeltaChunk | ToolStartChunk | ToolInputChunk | ToolOutputChunk | ToolErrorChunk | ContextAddItemChunk | TitleUpdateChunk | ArtifactStartChunk | ArtifactContentDeltaChunk | ArtifactDataChunk | ArtifactUrlChunk | ArtifactEndChunk | ConversationCreatedChunk;
+//# sourceMappingURL=ai-agent-coordinator-stream.d.ts.map

package/script/contracts/ai-agent-coordinator-stream.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ai-agent-coordinator-stream.d.ts","sourceRoot":"","sources":["../../src/contracts/ai-agent-coordinator-stream.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAA;AAI5D;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,4CAA4C;IAC5C,cAAc,EAAE,MAAM,CAAA;CAEvB;AAID,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,gBAAgB,CAAA;IACtB,kCAAkC;IAClC,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,YAAY,CAAA;IAClB,2CAA2C;IAC3C,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,YAAY,CAAA;IAClB,kEAAkE;IAClE,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,aAAa,CAAA;IACnB,qEAAqE;IACrE,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,YAAY,CAAA;IAClB,OAAO,EAAE;QACP,+BAA+B;QAC/B,aAAa,EAAE,MAAM,CAAA;QACrB,mDAAmD;QACnD,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;KAC3B,CAAA;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,kBAAkB,CAAA;IACxB,4CAA4C;IAC5C,IAAI,EAAE,WAAW,CAAA;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,cAAc,CAAA;IACpB,oDAAoD;IACpD,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,gBAAgB,CAAA;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,EAAE,MAAM,CAAA;IACpB,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,wBAAwB,CAAA;IAC9B,UAAU,EAAE,MAAM,CAAA;IAClB,0CAA0C;IAC1C,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,eAAe,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;IAClB,+CAA+C;IAC/C,IAAI,EAAE,OAAO,CAAA;CACd;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,cAAc,CAAA;IACpB,UAAU,EAAE,MAAM,CAAA;IAClB,gDAAgD;IAChD,GAAG,EAAE,MAAM,CAAA;CACZ;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,cAAc,CAAA;IACpB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,sBAAsB,CAAA;IAC5B,gDAAgD;IAChD,cAAc,EAAE,MAAM,CAAA;CACvB;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB,kBAAkB,GAClB,cAAc,GACd,cAAc,GACd,eAAe,GACf,cAAc,GACd,mBAAmB,GACnB,gBAAgB,GAChB,kBAAkB,GAClB,yBAAyB,GACzB,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,wBAAwB,CAAA"}

package/script/contracts/ai-agent-coordinator-stream.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/script/contracts/ai-agent-coordinator.d.ts

@@ -0,0 +1,41 @@
+export interface ContextItem {
+    type: "tenant" | "dataCore" | "flowType" | "eventType" | string;
+    id: string;
+    name: string;
+    description: string;
+}
+export interface Message {
+    id: string;
+    role: "user" | "ai";
+    content: string;
+    timestamp: string;
+}
+export interface ConversationMetadata {
+    id: string;
+    title: string;
+    lastUpdated: string;
+}
+export interface Conversation extends ConversationMetadata {
+    context: ContextItem[];
+    messages: Message[];
+}
+export interface ConversationListResponse {
+    conversations: ConversationMetadata[];
+}
+export interface ConversationDeleteResponse {
+    message: string;
+}
+export interface ContextUpdateResponse {
+    context: ContextItem[];
+}
+export interface AddContextItem {
+    type: string;
+    id: string;
+}
+export interface AddContextItemsRequest {
+    items: AddContextItem[];
+}
+export interface RemoveContextItemRequest {
+    itemId: string;
+}
+//# sourceMappingURL=ai-agent-coordinator.d.ts.map

package/script/contracts/ai-agent-coordinator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ai-agent-coordinator.d.ts","sourceRoot":"","sources":["../../src/contracts/ai-agent-coordinator.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,QAAQ,GAAG,UAAU,GAAG,UAAU,GAAG,WAAW,GAAG,MAAM,CAAA;IAC/D,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,YAAa,SAAQ,oBAAoB;IACxD,OAAO,EAAE,WAAW,EAAE,CAAA;IACtB,QAAQ,EAAE,OAAO,EAAE,CAAA;CACpB;AAED,MAAM,WAAW,wBAAwB;IACvC,aAAa,EAAE,oBAAoB,EAAE,CAAA;CACtC;AAED,MAAM,WAAW,0BAA0B;IACzC,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,WAAW,EAAE,CAAA;CACvB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;CACX;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,cAAc,EAAE,CAAA;CACxB;AAED,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,MAAM,CAAA;CACf"}

package/script/contracts/ai-agent-coordinator.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/script/mod.d.ts

@@ -1,9 +1,15 @@
+export * from "./commands/ai-agent-coordinator/mod.js";
 export * from "./commands/index.js";
-export * from "./common/command.js";
 export * from "./common/command-custom.js";
 export * from "./common/command-graphql.js";
+export * from "./common/command.js";
 export * from "./common/flowcore-client.js";
-export * from "./common/notification-client.js";
+export { NotificationClient, type NotificationClientOptions, type NotificationEvent, } from "./common/notification-client.js";
+export * from "./common/websocket-client.js";
+export { type OidcClient, WebSocketClient, type WebSocketClientOptions } from "./common/websocket-client.js";
+export * from "./common/websocket-command.js";
+export * from "./contracts/ai-agent-coordinator-stream.js";
+export * from "./contracts/ai-agent-coordinator.js";
 export * from "./contracts/index.js";
 export * from "./exceptions/index.js";
 export * from "./utils/parse-response-helper.js";

package/script/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAA;AACnC,cAAc,qBAAqB,CAAA;AACnC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,6BAA6B,CAAA;AAC3C,cAAc,6BAA6B,CAAA;AAC3C,cAAc,iCAAiC,CAAA;AAC/C,cAAc,sBAAsB,CAAA;AACpC,cAAc,uBAAuB,CAAA;AACrC,cAAc,kCAAkC,CAAA"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,cAAc,wCAAwC,CAAA;AACtD,cAAc,qBAAqB,CAAA;AACnC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,6BAA6B,CAAA;AAC3C,cAAc,qBAAqB,CAAA;AACnC,cAAc,6BAA6B,CAAA;AAC3C,OAAO,EACL,kBAAkB,EAClB,KAAK,yBAAyB,EAC9B,KAAK,iBAAiB,GACvB,MAAM,iCAAiC,CAAA;AACxC,cAAc,8BAA8B,CAAA;AAC5C,OAAO,EAAE,KAAK,UAAU,EAAE,eAAe,EAAE,KAAK,sBAAsB,EAAE,MAAM,8BAA8B,CAAA;AAC5G,cAAc,+BAA+B,CAAA;AAC7C,cAAc,4CAA4C,CAAA;AAC1D,cAAc,qCAAqC,CAAA;AACnD,cAAc,sBAAsB,CAAA;AACpC,cAAc,uBAAuB,CAAA;AACrC,cAAc,kCAAkC,CAAA"}

package/script/mod.js

@@ -14,12 +14,21 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebSocketClient = exports.NotificationClient = void 0;
+__exportStar(require("./commands/ai-agent-coordinator/mod.js"), exports);
 __exportStar(require("./commands/index.js"), exports);
-__exportStar(require("./common/command.js"), exports);
 __exportStar(require("./common/command-custom.js"), exports);
 __exportStar(require("./common/command-graphql.js"), exports);
+__exportStar(require("./common/command.js"), exports);
 __exportStar(require("./common/flowcore-client.js"), exports);
-__exportStar(require("./common/notification-client.js"), exports);
+var notification_client_js_1 = require("./common/notification-client.js");
+Object.defineProperty(exports, "NotificationClient", { enumerable: true, get: function () { return notification_client_js_1.NotificationClient; } });
+__exportStar(require("./common/websocket-client.js"), exports);
+var websocket_client_js_1 = require("./common/websocket-client.js");
+Object.defineProperty(exports, "WebSocketClient", { enumerable: true, get: function () { return websocket_client_js_1.WebSocketClient; } });
+__exportStar(require("./common/websocket-command.js"), exports);
+__exportStar(require("./contracts/ai-agent-coordinator-stream.js"), exports);
+__exportStar(require("./contracts/ai-agent-coordinator.js"), exports);
 __exportStar(require("./contracts/index.js"), exports);
 __exportStar(require("./exceptions/index.js"), exports);
 __exportStar(require("./utils/parse-response-helper.js"), exports);