flowscale 1.0.3

package/dist/index.d.ts

@@ -0,0 +1,52 @@
+import { HealthCheckResponse, QueueResponse, ExecuteWorkflowResponse, GetOutputResponse, RunDetailResponse, RunListResponse, CancelRunResponse } from './types';
+export declare class FlowscaleAPI {
+    private apiKey;
+    private baseUrl;
+    private client;
+    constructor(apiKey: string, baseUrl: string);
+    /**
+     * Checks the health status of all ComfyUI instances within the specified cluster.
+     */
+    checkHealth(): Promise<HealthCheckResponse>;
+    /**
+     * Retrieves the queue data for all ComfyUI instances in the cluster.
+     */
+    getQueue(): Promise<QueueResponse>;
+    /**
+     * Executes a specified workflow by processing dynamic form data.
+     * @param workflowId - The ID of the workflow to execute.
+     * @param data - Form data including text fields and file uploads.
+     * @param groupId - Optional group ID.
+     */
+    executeWorkflow(workflowId: string, data: {
+        [key: string]: any;
+    }, groupId?: string): Promise<ExecuteWorkflowResponse>;
+    /**
+     * Retrieves the output of a specific run by providing the filename.
+     * @param filename - The filename of the output to retrieve.
+     */
+    getOutput(filename: string): Promise<GetOutputResponse | null>;
+    /**
+     * Cancels a specific run using its unique run ID.
+     * @param runId - The ID of the run to cancel.
+     */
+    cancelRun(runId: string): Promise<CancelRunResponse>;
+    /**
+     * Retrieves detailed information about a specific run using its unique run ID.
+     * @param runId - The ID of the run to retrieve.
+     */
+    getRun(runId: string): Promise<RunDetailResponse>;
+    /**
+     * Retrieves a list of all runs associated with a specific group ID.
+     * @param groupId - The group ID to filter runs.
+     */
+    getRuns(groupId: string): Promise<RunListResponse>;
+    /**
+     * Helper method to append data to FormData.
+     */
+    private appendFormData;
+    /**
+     * Error handling helper.
+     */
+    private handleError;
+}

package/dist/index.js

@@ -0,0 +1,193 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FlowscaleAPI = void 0;
+const axios_1 = __importDefault(require("axios"));
+const form_data_1 = __importDefault(require("form-data"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+class FlowscaleAPI {
+    constructor(apiKey, baseUrl) {
+        this.apiKey = apiKey;
+        this.baseUrl = baseUrl;
+        this.client = axios_1.default.create({
+            baseURL: this.baseUrl,
+        });
+        // Add the API key to all requests
+        this.client.interceptors.request.use((config) => {
+            if (!config.headers) {
+                config.headers = {};
+            }
+            config.headers['X-API-KEY'] = this.apiKey;
+            return config;
+        });
+    }
+    /**
+     * Checks the health status of all ComfyUI instances within the specified cluster.
+     */
+    async checkHealth() {
+        try {
+            const response = await this.client.get('/api/v1/comfy/health');
+            return response.data;
+        }
+        catch (error) {
+            this.handleError(error);
+        }
+    }
+    /**
+     * Retrieves the queue data for all ComfyUI instances in the cluster.
+     */
+    async getQueue() {
+        try {
+            const response = await this.client.get('/api/v1/comfy/queue');
+            return response.data;
+        }
+        catch (error) {
+            this.handleError(error);
+        }
+    }
+    /**
+     * Executes a specified workflow by processing dynamic form data.
+     * @param workflowId - The ID of the workflow to execute.
+     * @param data - Form data including text fields and file uploads.
+     * @param groupId - Optional group ID.
+     */
+    async executeWorkflow(workflowId, data, groupId) {
+        try {
+            const formData = new form_data_1.default();
+            // Append data to formData
+            for (const key in data) {
+                if (data.hasOwnProperty(key)) {
+                    const value = data[key];
+                    if (Array.isArray(value)) {
+                        // Handle arrays (for multiple files)
+                        value.forEach((item) => {
+                            this.appendFormData(formData, key, item);
+                        });
+                    }
+                    else {
+                        this.appendFormData(formData, key, value);
+                    }
+                }
+            }
+            const headers = {
+                ...formData.getHeaders(),
+                'X-API-KEY': this.apiKey,
+            };
+            const url = `/api/v1/runs?workflow_id=${encodeURIComponent(workflowId)}${groupId ? `&group_id=${encodeURIComponent(groupId)}` : ''}`;
+            const response = await this.client.post(url, formData, { headers });
+            return response.data;
+        }
+        catch (error) {
+            this.handleError(error);
+        }
+    }
+    /**
+     * Retrieves the output of a specific run by providing the filename.
+     * @param filename - The filename of the output to retrieve.
+     */
+    async getOutput(filename) {
+        try {
+            const response = await this.client.get('/api/v1/runs/output', {
+                params: { filename },
+            });
+            return response.data;
+        }
+        catch (error) {
+            const axiosError = error;
+            if (axiosError.response && axiosError.response.status === 204) {
+                return null; // No output found
+            }
+            else if (axiosError.response &&
+                axiosError.response.status === 408) {
+                throw new Error('Run Timeout');
+            }
+            else {
+                this.handleError(error);
+            }
+        }
+    }
+    /**
+     * Cancels a specific run using its unique run ID.
+     * @param runId - The ID of the run to cancel.
+     */
+    async cancelRun(runId) {
+        try {
+            const response = await this.client.post(`/api/v1/runs/${encodeURIComponent(runId)}/cancel`);
+            return response.data;
+        }
+        catch (error) {
+            this.handleError(error);
+        }
+    }
+    /**
+     * Retrieves detailed information about a specific run using its unique run ID.
+     * @param runId - The ID of the run to retrieve.
+     */
+    async getRun(runId) {
+        try {
+            const response = await this.client.get(`/api/v1/runs/${encodeURIComponent(runId)}`);
+            return response.data;
+        }
+        catch (error) {
+            this.handleError(error);
+        }
+    }
+    /**
+     * Retrieves a list of all runs associated with a specific group ID.
+     * @param groupId - The group ID to filter runs.
+     */
+    async getRuns(groupId) {
+        try {
+            const response = await this.client.get('/api/v1/runs', {
+                params: { group_id: groupId },
+            });
+            return response.data;
+        }
+        catch (error) {
+            this.handleError(error);
+        }
+    }
+    /**
+     * Helper method to append data to FormData.
+     */
+    appendFormData(formData, key, value) {
+        if (value instanceof fs_1.default.ReadStream) {
+            // It's a file stream
+            formData.append(key, value);
+        }
+        else if (Buffer.isBuffer(value)) {
+            // It's a Buffer
+            formData.append(key, value, { filename: `${key}.dat` });
+        }
+        else if (typeof value === 'string' && fs_1.default.existsSync(value)) {
+            // If the value is a file path
+            const fileName = path_1.default.basename(value);
+            formData.append(key, fs_1.default.createReadStream(value), fileName);
+        }
+        else {
+            // Assume it's a string or other value
+            formData.append(key, value);
+        }
+    }
+    /**
+     * Error handling helper.
+     */
+    handleError(error) {
+        if (axios_1.default.isAxiosError(error)) {
+            if (error.response) {
+                // Server responded with a status code outside 2xx
+                throw new Error(`API Error: ${error.response.status} ${error.response.statusText} - ${JSON.stringify(error.response.data)}`);
+            }
+            else if (error.request) {
+                // Request was made but no response
+                throw new Error('No response received from API server');
+            }
+        }
+        // Something else happened
+        throw new Error(`Error: ${error.message}`);
+    }
+}
+exports.FlowscaleAPI = FlowscaleAPI;

package/dist/types.d.ts

@@ -0,0 +1,72 @@
+export interface HealthCheckResponse {
+    status: string;
+    data: Array<{
+        container: string;
+        status: string;
+    }>;
+}
+export interface QueueResponse {
+    status: string;
+    data: Array<{
+        container: string;
+        queue: {
+            queue_running: any[];
+            queue_pending: any[];
+        };
+    }>;
+}
+export interface ExecuteWorkflowResponse {
+    status: string;
+    data: {
+        output_names: string[];
+        run_id: string;
+    };
+}
+export interface GetOutputResponse {
+    status: string;
+    data: {
+        download_url: string;
+        generation_status: string;
+    };
+}
+export interface RunDetail {
+    _id: string;
+    team_id: string;
+    workflow_id: string;
+    group_id?: string;
+    status: string;
+    inputs: Array<{
+        path: string;
+        value: string;
+        s3_key?: string;
+        url?: string;
+    }>;
+    outputs: Array<{
+        filename: string;
+        s3_key?: string;
+        url?: string;
+    }>;
+    created_at: string;
+    started_at?: string;
+    completed_at?: string;
+}
+export interface RunDetailResponse {
+    status: string;
+    data: RunDetail;
+}
+export interface RunListResponse {
+    status: string;
+    data: {
+        group_id: string;
+        count: number;
+        runs: RunDetail[];
+    };
+}
+export interface CancelRunResponse {
+    status: string;
+    data: string;
+}
+export interface ErrorResponse {
+    status: string;
+    errors: string;
+}

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+// src/types.ts
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "flowscale",
+  "version": "1.0.3",
+  "description": "An NPM library for communicating with the Flowscale APIs",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "test": "echo \"No tests yet\""
+  },
+  "author": "Your Name",
+  "license": "MIT",
+  "dependencies": {
+    "axios": "^1.7.7",
+    "form-data": "^4.0.1",
+    "flowscale-test": "^1.0.1"
+  },
+  "devDependencies": {
+    "@types/form-data": "^2.5.2",
+    "@types/node": "^22.9.1",
+    "typescript": "^5.6.3"
+  }
+}

package/src/index.ts

@@ -0,0 +1,230 @@
+import axios, { AxiosInstance, AxiosError, AxiosRequestHeaders } from 'axios';
+import FormData from 'form-data';
+import fs from 'fs';
+import path from 'path';
+import {
+  HealthCheckResponse,
+  QueueResponse,
+  ExecuteWorkflowResponse,
+  GetOutputResponse,
+  RunDetailResponse,
+  RunListResponse,
+  CancelRunResponse,
+  ErrorResponse,
+} from './types';
+
+export class FlowscaleAPI {
+  private apiKey: string;
+  private baseUrl: string;
+  private client: AxiosInstance;
+
+  constructor(apiKey: string, baseUrl: string) {
+    this.apiKey = apiKey;
+    this.baseUrl = baseUrl;
+
+    this.client = axios.create({
+      baseURL: this.baseUrl,
+    });
+
+    // Add the API key to all requests
+    this.client.interceptors.request.use((config) => {
+      if (!config.headers) {
+        config.headers = {} as AxiosRequestHeaders
+      }
+      config.headers['X-API-KEY'] = this.apiKey;
+      return config;
+    });
+  }
+
+  /**
+   * Checks the health status of all ComfyUI instances within the specified cluster.
+   */
+  public async checkHealth(): Promise<HealthCheckResponse> {
+    try {
+      const response = await this.client.get<HealthCheckResponse>(
+        '/api/v1/comfy/health'
+      );
+      return response.data;
+    } catch (error) {
+      this.handleError(error);
+    }
+  }
+
+  /**
+   * Retrieves the queue data for all ComfyUI instances in the cluster.
+   */
+  public async getQueue(): Promise<QueueResponse> {
+    try {
+      const response = await this.client.get<QueueResponse>(
+        '/api/v1/comfy/queue'
+      );
+      return response.data;
+    } catch (error) {
+      this.handleError(error);
+    }
+  }
+
+  /**
+   * Executes a specified workflow by processing dynamic form data.
+   * @param workflowId - The ID of the workflow to execute.
+   * @param data - Form data including text fields and file uploads.
+   * @param groupId - Optional group ID.
+   */
+  public async executeWorkflow(
+    workflowId: string,
+    data: { [key: string]: any },
+    groupId?: string
+  ): Promise<ExecuteWorkflowResponse> {
+    try {
+      const formData = new FormData();
+
+      // Append data to formData
+      for (const key in data) {
+        if (data.hasOwnProperty(key)) {
+          const value = data[key];
+          if (Array.isArray(value)) {
+            // Handle arrays (for multiple files)
+            value.forEach((item: any) => {
+              this.appendFormData(formData, key, item);
+            });
+          } else {
+            this.appendFormData(formData, key, value);
+          }
+        }
+      }
+
+      const headers = {
+        ...formData.getHeaders(),
+        'X-API-KEY': this.apiKey,
+      };
+
+      const url = `/api/v1/runs?workflow_id=${encodeURIComponent(workflowId)}${
+        groupId ? `&group_id=${encodeURIComponent(groupId)}` : ''
+      }`;
+
+      const response = await this.client.post<ExecuteWorkflowResponse>(
+        url,
+        formData,
+        { headers }
+      );
+      return response.data;
+    } catch (error) {
+      this.handleError(error);
+    }
+  }
+
+  /**
+   * Retrieves the output of a specific run by providing the filename.
+   * @param filename - The filename of the output to retrieve.
+   */
+  public async getOutput(filename: string): Promise<GetOutputResponse | null> {
+    try {
+      const response = await this.client.get<GetOutputResponse>(
+        '/api/v1/runs/output',
+        {
+          params: { filename },
+        }
+      );
+      return response.data;
+    } catch (error) {
+      const axiosError = error as AxiosError;
+      if (axiosError.response && axiosError.response.status === 204) {
+        return null; // No output found
+      } else if (
+        axiosError.response &&
+        axiosError.response.status === 408
+      ) {
+        throw new Error('Run Timeout');
+      } else {
+        this.handleError(error);
+      }
+    }
+  }
+
+  /**
+   * Cancels a specific run using its unique run ID.
+   * @param runId - The ID of the run to cancel.
+   */
+  public async cancelRun(runId: string): Promise<CancelRunResponse> {
+    try {
+      const response = await this.client.post<CancelRunResponse>(
+        `/api/v1/runs/${encodeURIComponent(runId)}/cancel`
+      );
+      return response.data;
+    } catch (error) {
+      this.handleError(error);
+    }
+  }
+
+  /**
+   * Retrieves detailed information about a specific run using its unique run ID.
+   * @param runId - The ID of the run to retrieve.
+   */
+  public async getRun(runId: string): Promise<RunDetailResponse> {
+    try {
+      const response = await this.client.get<RunDetailResponse>(
+        `/api/v1/runs/${encodeURIComponent(runId)}`
+      );
+      return response.data;
+    } catch (error) {
+      this.handleError(error);
+    }
+  }
+
+  /**
+   * Retrieves a list of all runs associated with a specific group ID.
+   * @param groupId - The group ID to filter runs.
+   */
+  public async getRuns(groupId: string): Promise<RunListResponse> {
+    try {
+      const response = await this.client.get<RunListResponse>('/api/v1/runs', {
+        params: { group_id: groupId },
+      });
+      return response.data;
+    } catch (error) {
+      this.handleError(error);
+    }
+  }
+
+  /**
+   * Helper method to append data to FormData.
+   */
+  private appendFormData(formData: FormData, key: string, value: any) {
+    if (value instanceof fs.ReadStream) {
+      // It's a file stream
+      formData.append(key, value);
+    } else if (Buffer.isBuffer(value)) {
+      // It's a Buffer
+      formData.append(key, value, { filename: `${key}.dat` });
+    } else if (typeof value === 'string' && fs.existsSync(value)) {
+      // If the value is a file path
+      const fileName = path.basename(value);
+      formData.append(key, fs.createReadStream(value), fileName);
+    } else {
+      // Assume it's a string or other value
+      formData.append(key, value);
+    }
+  }
+
+  /**
+   * Error handling helper.
+   */
+  private handleError(error: any): never {
+    if (axios.isAxiosError(error)) {
+      if (error.response) {
+        // Server responded with a status code outside 2xx
+        throw new Error(
+          `API Error: ${error.response.status} ${error.response.statusText} - ${JSON.stringify(
+            error.response.data
+          )}`
+        );
+      } else if (error.request) {
+        // Request was made but no response
+        throw new Error('No response received from API server');
+      }
+    }
+    console.error(error);
+    // Something else happened
+    throw new Error(`Error: ${error.message}`);
+  }
+}

package/src/types.ts

@@ -0,0 +1,82 @@
+// src/types.ts
+
+export interface HealthCheckResponse {
+  status: string;
+  data: Array<{
+    container: string;
+    status: string;
+  }>;
+}
+
+export interface QueueResponse {
+  status: string;
+  data: Array<{
+    container: string;
+    queue: {
+      queue_running: any[];
+      queue_pending: any[];
+    };
+  }>;
+}
+
+export interface ExecuteWorkflowResponse {
+  status: string;
+  data: {
+    output_names: string[];
+    run_id: string;
+  };
+}
+
+export interface GetOutputResponse {
+  status: string;
+  data: {
+    download_url: string;
+    generation_status: string;
+  };
+}
+
+export interface RunDetail {
+  _id: string;
+  team_id: string;
+  workflow_id: string;
+  group_id?: string;
+  status: string;
+  inputs: Array<{
+    path: string;
+    value: string;
+    s3_key?: string;
+    url?: string;
+  }>;
+  outputs: Array<{
+    filename: string;
+    s3_key?: string;
+    url?: string;
+  }>;
+  created_at: string;
+  started_at?: string;
+  completed_at?: string;
+}
+
+export interface RunDetailResponse {
+  status: string;
+  data: RunDetail;
+}
+
+export interface RunListResponse {
+  status: string;
+  data: {
+    group_id: string;
+    count: number;
+    runs: RunDetail[];
+  };
+}
+
+export interface CancelRunResponse {
+  status: string;
+  data: string;
+}
+
+export interface ErrorResponse {
+  status: string;
+  errors: string;
+}

package/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "target": "ES2019",
+    "module": "CommonJS",
+    "declaration": true,
+    "outDir": "./dist",
+    "strict": true,
+    "esModuleInterop": true
+  },
+  "include": ["src/**/*"]
+}