@flowcore/sdk 1.25.0 → 1.26.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## [1.26.0](https://github.com/flowcore-io/flowcore-sdk/compare/v1.25.0...v1.26.0) (2025-04-10)
+
+
+### Features
+
+* **ai-agent-coordinator:** :sparkles: add ArtifactGetCommand for fetching artifacts by ID ([1955ed9](https://github.com/flowcore-io/flowcore-sdk/commit/1955ed97102c5f6cbdd7a551f8d18fb0cb706e2f))
+
+
+### Bug Fixes
+
+* **ai-agent-coordinator:** :art: clean up import formatting in conversation test ([cb8a258](https://github.com/flowcore-io/flowcore-sdk/commit/cb8a258027409baa501a77141aef6a51009db2ec))
+* **ai-agent-coordinator:** :art: ensure artifactId is a string in ArtifactGetCommand ([4e88025](https://github.com/flowcore-io/flowcore-sdk/commit/4e880251dddbb9ee068a4cc195cfc7e71d371d03))
+* **ai-agent-coordinator:** :art: reorder import statements in artifact-get command ([54e4b8d](https://github.com/flowcore-io/flowcore-sdk/commit/54e4b8ddf88af4a755a62036e938dbe86c91ac72))
+* **ai-agent-coordinator:** :art: update artifact schema type and clean up imports ([c195c27](https://github.com/flowcore-io/flowcore-sdk/commit/c195c27ca5cde6d529cbc62492e0daa848837b8d))
+* **readme:** :memo: add documentation for retrieving specific artifacts by ID ([26a49a3](https://github.com/flowcore-io/flowcore-sdk/commit/26a49a363a4c490dbbb5b02199ccfc2738ccedc7))
+
 ## [1.25.0](https://github.com/flowcore-io/flowcore-sdk/compare/v1.24.4...v1.25.0) (2025-04-10)
 
 

package/README.md

@@ -730,6 +730,36 @@ try {
 }
 ```
 
+#### Get a Specific Artifact
+
+Retrieves the details (content, data, or url) for a specific artifact by its ID.
+
+```typescript
+import { ArtifactGetCommand, FlowcoreClient, NotFoundException } from "@flowcore/sdk"
+
+const command = new ArtifactGetCommand({ artifactId: "your-artifact-id" });
+
+try {
+  const artifact = await client.execute(command);
+  // Returns the Artifact object:
+  // {
+  //   artifactId: string;
+  //   artifactType: "code" | "markdown" | "table" | "visualization" | "html" | "mermaid";
+  //   title: string;
+  //   content?: string; // For text-based artifacts
+  //   data?: unknown;   // For JSON-based artifacts
+  //   url?: string;     // For URL-based artifacts
+  // }
+  console.log("Artifact details:", artifact);
+} catch (error) {
+  if (error instanceof NotFoundException) {
+    console.error("Artifact not found:", error.details);
+  } else {
+    console.error("Failed to get artifact:", error);
+  }
+}
+```
+
 #### Stream Conversation Events
 
 The `WebSocketClient` is used to establish a persistent connection for streaming conversation events (like AI responses, tool usage, etc.) for a specific conversation.

package/esm/commands/ai-agent-coordinator/artifact-get.command.d.ts

@@ -0,0 +1,22 @@
+import { type TObject } from "@sinclair/typebox";
+import { Command } from "../../common/command.js";
+import type { ClientError } from "../../exceptions/client-error.js";
+export interface ArtifactGetCommandInput {
+    artifactId: string;
+}
+/**
+ * Represents the structure of the artifact returned by the API.
+ * Based on the Swagger spec example.
+ */
+declare const ArtifactSchema: TObject;
+export type Artifact = typeof ArtifactSchema.static;
+export declare class ArtifactGetCommand extends Command<ArtifactGetCommandInput, Artifact> {
+    protected getMethod(): string;
+    protected getBaseUrl(): string;
+    protected getPath(): string;
+    protected getHeaders(): Record<string, string>;
+    protected parseResponse(rawResponse: unknown): Artifact;
+    protected handleClientError(error: ClientError): void;
+}
+export {};
+//# sourceMappingURL=artifact-get.command.d.ts.map

package/esm/commands/ai-agent-coordinator/artifact-get.command.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"artifact-get.command.d.ts","sourceRoot":"","sources":["../../../src/commands/ai-agent-coordinator/artifact-get.command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAQ,MAAM,mBAAmB,CAAA;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAA;AACjD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAA;AAInE,MAAM,WAAW,uBAAuB;IACtC,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;;GAGG;AACH,QAAA,MAAM,cAAc,EAAE,OAcpB,CAAA;AAEF,MAAM,MAAM,QAAQ,GAAG,OAAO,cAAc,CAAC,MAAM,CAAA;AAEnD,qBAAa,kBAAmB,SAAQ,OAAO,CAAC,uBAAuB,EAAE,QAAQ,CAAC;cAC7D,SAAS,IAAI,MAAM;cAInB,UAAU,IAAI,MAAM;cAKpB,OAAO,IAAI,MAAM;cAIjB,UAAU,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;cAQpC,aAAa,CAAC,WAAW,EAAE,OAAO,GAAG,QAAQ;cAK7C,iBAAiB,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;CAM/D"}

package/esm/commands/ai-agent-coordinator/artifact-get.command.js

@@ -0,0 +1,52 @@
+import { Type } from "@sinclair/typebox";
+import { Command } from "../../common/command.js";
+import { NotFoundException } from "../../exceptions/not-found.js";
+import { parseResponseHelper } from "../../utils/parse-response-helper.js";
+/**
+ * Represents the structure of the artifact returned by the API.
+ * Based on the Swagger spec example.
+ */
+const ArtifactSchema = Type.Object({
+    artifactId: Type.String({ example: "artifact_code_123" }),
+    artifactType: Type.Union([
+        Type.Literal("code"),
+        Type.Literal("markdown"),
+        Type.Literal("table"),
+        Type.Literal("visualization"),
+        Type.Literal("html"),
+        Type.Literal("mermaid"),
+    ], { description: "Type of artifact" }),
+    title: Type.String({ example: "Example Code Snippet" }),
+    content: Type.Optional(Type.String({ description: "String content" })),
+    data: Type.Optional(Type.Unknown({ description: "JSON data" })),
+    url: Type.Optional(Type.String({ format: "uri", description: "URL content" })),
+});
+export class ArtifactGetCommand extends Command {
+    getMethod() {
+        return "GET";
+    }
+    getBaseUrl() {
+        // Assuming the coordinator uses this base URL, adjust if needed
+        return "https://ai-coordinator.api.flowcore.io";
+    }
+    getPath() {
+        return `/api/v1/artifacts/${this.input.artifactId}`;
+    }
+    getHeaders() {
+        // GET requests typically don't need Content-Type
+        // Authorization header is handled by the FlowcoreClient
+        return {
+            "Accept": "application/json",
+        };
+    }
+    parseResponse(rawResponse) {
+        const response = parseResponseHelper(ArtifactSchema, rawResponse);
+        return response;
+    }
+    handleClientError(error) {
+        if (error.status === 404) {
+            throw new NotFoundException("Artifact", { id: this.input.artifactId });
+        }
+        throw error;
+    }
+}

package/esm/commands/ai-agent-coordinator/mod.d.ts

@@ -1,3 +1,4 @@
+export * from "./artifact-get.command.js";
 export * from "./context-add-item.command.js";
 export * from "./context-remove-item.command.js";
 export * from "./conversation-delete.command.js";

package/esm/commands/ai-agent-coordinator/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../../src/commands/ai-agent-coordinator/mod.ts"],"names":[],"mappings":"AAAA,cAAc,+BAA+B,CAAA;AAC7C,cAAc,kCAAkC,CAAA;AAChD,cAAc,kCAAkC,CAAA;AAChD,cAAc,+BAA+B,CAAA;AAC7C,cAAc,gCAAgC,CAAA;AAC9C,cAAc,kCAAkC,CAAA"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../../src/commands/ai-agent-coordinator/mod.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAA;AACzC,cAAc,+BAA+B,CAAA;AAC7C,cAAc,kCAAkC,CAAA;AAChD,cAAc,kCAAkC,CAAA;AAChD,cAAc,+BAA+B,CAAA;AAC7C,cAAc,gCAAgC,CAAA;AAC9C,cAAc,kCAAkC,CAAA"}

package/esm/commands/ai-agent-coordinator/mod.js

@@ -1,3 +1,4 @@
+export * from "./artifact-get.command.js";
 export * from "./context-add-item.command.js";
 export * from "./context-remove-item.command.js";
 export * from "./conversation-delete.command.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowcore/sdk",
-  "version": "1.25.0",
+  "version": "1.26.0",
   "description": "Flowcore SDK",
   "homepage": "https://github.com/flowcore-io/flowcore-sdk#readme",
   "repository": {

package/script/commands/ai-agent-coordinator/artifact-get.command.d.ts

@@ -0,0 +1,22 @@
+import { type TObject } from "@sinclair/typebox";
+import { Command } from "../../common/command.js";
+import type { ClientError } from "../../exceptions/client-error.js";
+export interface ArtifactGetCommandInput {
+    artifactId: string;
+}
+/**
+ * Represents the structure of the artifact returned by the API.
+ * Based on the Swagger spec example.
+ */
+declare const ArtifactSchema: TObject;
+export type Artifact = typeof ArtifactSchema.static;
+export declare class ArtifactGetCommand extends Command<ArtifactGetCommandInput, Artifact> {
+    protected getMethod(): string;
+    protected getBaseUrl(): string;
+    protected getPath(): string;
+    protected getHeaders(): Record<string, string>;
+    protected parseResponse(rawResponse: unknown): Artifact;
+    protected handleClientError(error: ClientError): void;
+}
+export {};
+//# sourceMappingURL=artifact-get.command.d.ts.map

package/script/commands/ai-agent-coordinator/artifact-get.command.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"artifact-get.command.d.ts","sourceRoot":"","sources":["../../../src/commands/ai-agent-coordinator/artifact-get.command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAQ,MAAM,mBAAmB,CAAA;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAA;AACjD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAA;AAInE,MAAM,WAAW,uBAAuB;IACtC,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;;GAGG;AACH,QAAA,MAAM,cAAc,EAAE,OAcpB,CAAA;AAEF,MAAM,MAAM,QAAQ,GAAG,OAAO,cAAc,CAAC,MAAM,CAAA;AAEnD,qBAAa,kBAAmB,SAAQ,OAAO,CAAC,uBAAuB,EAAE,QAAQ,CAAC;cAC7D,SAAS,IAAI,MAAM;cAInB,UAAU,IAAI,MAAM;cAKpB,OAAO,IAAI,MAAM;cAIjB,UAAU,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;cAQpC,aAAa,CAAC,WAAW,EAAE,OAAO,GAAG,QAAQ;cAK7C,iBAAiB,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;CAM/D"}

package/script/commands/ai-agent-coordinator/artifact-get.command.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArtifactGetCommand = void 0;
+const typebox_1 = require("@sinclair/typebox");
+const command_js_1 = require("../../common/command.js");
+const not_found_js_1 = require("../../exceptions/not-found.js");
+const parse_response_helper_js_1 = require("../../utils/parse-response-helper.js");
+/**
+ * Represents the structure of the artifact returned by the API.
+ * Based on the Swagger spec example.
+ */
+const ArtifactSchema = typebox_1.Type.Object({
+    artifactId: typebox_1.Type.String({ example: "artifact_code_123" }),
+    artifactType: typebox_1.Type.Union([
+        typebox_1.Type.Literal("code"),
+        typebox_1.Type.Literal("markdown"),
+        typebox_1.Type.Literal("table"),
+        typebox_1.Type.Literal("visualization"),
+        typebox_1.Type.Literal("html"),
+        typebox_1.Type.Literal("mermaid"),
+    ], { description: "Type of artifact" }),
+    title: typebox_1.Type.String({ example: "Example Code Snippet" }),
+    content: typebox_1.Type.Optional(typebox_1.Type.String({ description: "String content" })),
+    data: typebox_1.Type.Optional(typebox_1.Type.Unknown({ description: "JSON data" })),
+    url: typebox_1.Type.Optional(typebox_1.Type.String({ format: "uri", description: "URL content" })),
+});
+class ArtifactGetCommand extends command_js_1.Command {
+    getMethod() {
+        return "GET";
+    }
+    getBaseUrl() {
+        // Assuming the coordinator uses this base URL, adjust if needed
+        return "https://ai-coordinator.api.flowcore.io";
+    }
+    getPath() {
+        return `/api/v1/artifacts/${this.input.artifactId}`;
+    }
+    getHeaders() {
+        // GET requests typically don't need Content-Type
+        // Authorization header is handled by the FlowcoreClient
+        return {
+            "Accept": "application/json",
+        };
+    }
+    parseResponse(rawResponse) {
+        const response = (0, parse_response_helper_js_1.parseResponseHelper)(ArtifactSchema, rawResponse);
+        return response;
+    }
+    handleClientError(error) {
+        if (error.status === 404) {
+            throw new not_found_js_1.NotFoundException("Artifact", { id: this.input.artifactId });
+        }
+        throw error;
+    }
+}
+exports.ArtifactGetCommand = ArtifactGetCommand;

package/script/commands/ai-agent-coordinator/mod.d.ts

@@ -1,3 +1,4 @@
+export * from "./artifact-get.command.js";
 export * from "./context-add-item.command.js";
 export * from "./context-remove-item.command.js";
 export * from "./conversation-delete.command.js";

package/script/commands/ai-agent-coordinator/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../../src/commands/ai-agent-coordinator/mod.ts"],"names":[],"mappings":"AAAA,cAAc,+BAA+B,CAAA;AAC7C,cAAc,kCAAkC,CAAA;AAChD,cAAc,kCAAkC,CAAA;AAChD,cAAc,+BAA+B,CAAA;AAC7C,cAAc,gCAAgC,CAAA;AAC9C,cAAc,kCAAkC,CAAA"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../../src/commands/ai-agent-coordinator/mod.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAA;AACzC,cAAc,+BAA+B,CAAA;AAC7C,cAAc,kCAAkC,CAAA;AAChD,cAAc,kCAAkC,CAAA;AAChD,cAAc,+BAA+B,CAAA;AAC7C,cAAc,gCAAgC,CAAA;AAC9C,cAAc,kCAAkC,CAAA"}

package/script/commands/ai-agent-coordinator/mod.js

@@ -14,6 +14,7 @@ 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 });
+__exportStar(require("./artifact-get.command.js"), exports);
 __exportStar(require("./context-add-item.command.js"), exports);
 __exportStar(require("./context-remove-item.command.js"), exports);
 __exportStar(require("./conversation-delete.command.js"), exports);