flowscale 2.0.0 → 2.1.0-beta.0

package/dist/index.d.ts

@@ -122,3 +122,5 @@ export declare class FlowscaleAPI {
     };
 }
 export * from './types';
+export { FlowscalePlatformAPI } from './platform';
+export * from './platform-types';

package/dist/index.js

@@ -73,7 +73,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FlowscaleAPI = void 0;
+exports.FlowscalePlatformAPI = exports.FlowscaleAPI = void 0;
 var axios_1 = __importDefault(require("axios"));
 var FlowscaleAPI = /** @class */ (function () {
     function FlowscaleAPI(config) {
@@ -1294,3 +1294,7 @@ if (typeof window !== 'undefined') {
 }
 // Export all types for TypeScript consumers
 __exportStar(require("./types"), exports);
+// Platform API — JWT-based control of the full Flowscale platform
+var platform_1 = require("./platform");
+Object.defineProperty(exports, "FlowscalePlatformAPI", { enumerable: true, get: function () { return platform_1.FlowscalePlatformAPI; } });
+__exportStar(require("./platform-types"), exports);

package/dist/platform-types.d.ts

@@ -0,0 +1,156 @@
+export interface FlowscalePlatformConfig {
+    /** Flowscale JWT access token (from OAuth or login) */
+    token: string;
+    /** Team UUID — required for all team-scoped endpoints */
+    teamId: string;
+    /** Platform API base URL. Defaults to https://api.flowscale.ai */
+    baseUrl?: string;
+    /** Request timeout in ms. Default: 30000 */
+    timeout?: number;
+}
+export interface PlatformResponse<T = unknown> {
+    status: string;
+    data: T;
+    errors?: string;
+}
+export interface ProjectWorkflow {
+    id: string;
+    name: string;
+    description: string;
+    inputs: string;
+    outputs: string;
+}
+export interface Project {
+    _id: string;
+    name: string;
+    description?: string;
+    team_id: string;
+    cluster_url?: string;
+    api_key?: string;
+    status?: string;
+    created_at: string;
+    updated_at?: string;
+}
+export interface CreateProjectRequest {
+    name: string;
+    description?: string;
+    comfyui_version?: string;
+    [key: string]: unknown;
+}
+export interface UpdateProjectRequest {
+    name?: string;
+    description?: string;
+    [key: string]: unknown;
+}
+export interface ProjectApiKeyRequest {
+    name: string;
+    scopes?: string[];
+}
+export interface ProjectContentItem {
+    id: string;
+    name: string;
+    type: 'file' | 'folder';
+    path?: string;
+    size?: number;
+    created_at?: string;
+}
+export interface Pod {
+    _id: string;
+    name: string;
+    team_id: string;
+    project_id?: string;
+    status?: string;
+    gpu_type?: string;
+    budget?: number;
+    created_at: string;
+}
+export interface CreatePodRequest {
+    name: string;
+    project_id?: string;
+    gpu_type?: string;
+    budget?: number;
+    [key: string]: unknown;
+}
+export interface UpdatePodRequest {
+    name?: string;
+    budget?: number;
+    [key: string]: unknown;
+}
+export interface Cluster {
+    _id: string;
+    pod_id: string;
+    project_id?: string;
+    status: string;
+    created_at: string;
+    started_at?: string;
+    stopped_at?: string;
+}
+export interface StartClusterRequest {
+    pod_id: string;
+    project_id?: string;
+    [key: string]: unknown;
+}
+export interface ClusterLogEntry {
+    timestamp: string;
+    message: string;
+    level?: string;
+}
+export interface ClusterAnalytics {
+    [key: string]: unknown;
+}
+export interface PlatformRun {
+    _id: string;
+    team_id: string;
+    project_id?: string;
+    workflow_id?: string;
+    status: string;
+    created_at: string;
+    completed_at?: string;
+}
+export interface CreatePlatformRunRequest {
+    workflow_id: string;
+    inputs?: Record<string, unknown>;
+    [key: string]: unknown;
+}
+export interface TeamApiKey {
+    _id: string;
+    name: string;
+    key_preview: string;
+    scopes?: string[];
+    created_at: string;
+}
+export interface CreateTeamApiKeyRequest {
+    name: string;
+    scopes?: string[];
+}
+export interface InviteLink {
+    _id: string;
+    token: string;
+    url: string;
+    role?: string;
+    expires_at?: string;
+    created_at: string;
+}
+export interface CreateInviteLinkRequest {
+    role?: string;
+    expires_in_hours?: number;
+}
+export interface AnalyticsOverview {
+    total_runs: number;
+    total_api_calls: number;
+    credits_used: number;
+    [key: string]: unknown;
+}
+export interface RunsAnalytics {
+    [key: string]: unknown;
+}
+export interface ApiCallsAnalytics {
+    [key: string]: unknown;
+}
+export interface UserProfile {
+    username: string;
+    email: string;
+    avatar?: string;
+    is_active: boolean;
+    created_at: string;
+}

package/dist/platform-types.js

@@ -0,0 +1,5 @@
+"use strict";
+// ============================================================
+// Platform API — configuration
+// ============================================================
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/platform.d.ts

@@ -0,0 +1,29 @@
+import { FlowscaleAPI } from './index';
+import type { FlowscalePlatformConfig } from './platform-types';
+export declare class FlowscalePlatformAPI {
+    private client;
+    private teamId;
+    readonly projects: ReturnType<FlowscalePlatformAPI['buildProjects']>;
+    readonly pods: ReturnType<FlowscalePlatformAPI['buildPods']>;
+    readonly clusters: ReturnType<FlowscalePlatformAPI['buildClusters']>;
+    readonly runs: ReturnType<FlowscalePlatformAPI['buildRuns']>;
+    readonly team: ReturnType<FlowscalePlatformAPI['buildTeam']>;
+    readonly analytics: ReturnType<FlowscalePlatformAPI['buildAnalytics']>;
+    readonly auth: ReturnType<FlowscalePlatformAPI['buildAuth']>;
+    constructor(config: FlowscalePlatformConfig);
+    /**
+     * Create a deployment-level FlowscaleAPI client for a specific project cluster.
+     * @param clusterUrl  The cluster base URL from the project (e.g. https://cluster-xyz.flowscale.ai)
+     * @param apiKey      A project-scoped API key from project.addApiKey()
+     */
+    getDeploymentClient(clusterUrl: string, apiKey: string): FlowscaleAPI;
+    private request;
+    private buildProjects;
+    private buildPods;
+    private buildClusters;
+    private buildRuns;
+    private buildTeam;
+    private buildAnalytics;
+    private buildAuth;
+}
+export * from './platform-types';

package/dist/platform.js

@@ -0,0 +1,380 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FlowscalePlatformAPI = void 0;
+var axios_1 = __importDefault(require("axios"));
+var index_1 = require("./index");
+var DEFAULT_BASE_URL = 'https://api.flowscale.ai';
+var FlowscalePlatformAPI = /** @class */ (function () {
+    function FlowscalePlatformAPI(config) {
+        var _this = this;
+        var _a, _b;
+        if (!config.token)
+            throw new Error('FlowscalePlatformAPI: token is required');
+        if (!config.teamId)
+            throw new Error('FlowscalePlatformAPI: teamId is required');
+        this.teamId = config.teamId;
+        this.client = axios_1.default.create({
+            baseURL: ((_a = config.baseUrl) !== null && _a !== void 0 ? _a : DEFAULT_BASE_URL).trimEnd().replace(/\/$/, ''),
+            timeout: (_b = config.timeout) !== null && _b !== void 0 ? _b : 30000,
+        });
+        this.client.interceptors.request.use(function (req) {
+            if (!req.headers)
+                req.headers = {};
+            req.headers['Authorization'] = "Bearer ".concat(config.token);
+            req.headers['X-Team'] = _this.teamId;
+            return req;
+        });
+        this.projects = this.buildProjects();
+        this.pods = this.buildPods();
+        this.clusters = this.buildClusters();
+        this.runs = this.buildRuns();
+        this.team = this.buildTeam();
+        this.analytics = this.buildAnalytics();
+        this.auth = this.buildAuth();
+    }
+    // ── Bridge to deployment client ─────────────────────────
+    /**
+     * Create a deployment-level FlowscaleAPI client for a specific project cluster.
+     * @param clusterUrl  The cluster base URL from the project (e.g. https://cluster-xyz.flowscale.ai)
+     * @param apiKey      A project-scoped API key from project.addApiKey()
+     */
+    FlowscalePlatformAPI.prototype.getDeploymentClient = function (clusterUrl, apiKey) {
+        return new index_1.FlowscaleAPI({ baseUrl: clusterUrl, apiKey: apiKey });
+    };
+    // ── Helper ───────────────────────────────────────────────
+    FlowscalePlatformAPI.prototype.request = function (method, path, data, params) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.client.request({ method: method, url: path, data: data, params: params })];
+                    case 1:
+                        response = _a.sent();
+                        return [2 /*return*/, response.data];
+                }
+            });
+        });
+    };
+    // ── Projects ─────────────────────────────────────────────
+    FlowscalePlatformAPI.prototype.buildProjects = function () {
+        var req = this.request.bind(this);
+        return {
+            /** List all projects for the team. */
+            list: function () {
+                return req('get', '/api/v2/project');
+            },
+            /** Get a single project by ID. */
+            get: function (projectId) {
+                return req('get', "/api/v2/project/".concat(enc(projectId)));
+            },
+            /** Get a public project (no auth required — skips team header). */
+            getPublic: function (projectId) {
+                return req('get', "/api/v2/project/public/".concat(enc(projectId)));
+            },
+            /** Create a new project. */
+            create: function (data) {
+                return req('post', '/api/v2/project', data);
+            },
+            /** Update a project. */
+            update: function (projectId, data) {
+                return req('put', "/api/v2/project/".concat(enc(projectId)), data);
+            },
+            /** Delete a project. */
+            delete: function (projectId) {
+                return req('delete', "/api/v2/project/".concat(enc(projectId)));
+            },
+            /** Fork a project into the current team. */
+            fork: function (projectId) {
+                return req('post', "/api/v2/project/".concat(enc(projectId), "/fork"));
+            },
+            /** List workflows for a project. */
+            listWorkflows: function (projectId) {
+                return req('get', "/api/v2/project/".concat(enc(projectId), "/workflows"));
+            },
+            /** Get a single workflow. */
+            getWorkflow: function (projectId, workflowId) {
+                return req('get', "/api/v2/project/".concat(enc(projectId), "/workflows/").concat(enc(workflowId)));
+            },
+            /** Add a project-scoped API key (use with getDeploymentClient). */
+            addApiKey: function (projectId, data) {
+                return req('post', "/api/v2/project/".concat(enc(projectId), "/api_key"), data);
+            },
+            /** Delete a project-scoped API key. */
+            deleteApiKey: function (projectId, data) {
+                return req('delete', "/api/v2/project/".concat(enc(projectId), "/api_key"), data);
+            },
+            /** List files and folders in a project. */
+            getContents: function (projectId) {
+                return req('get', "/api/v2/project/".concat(enc(projectId), "/contents"));
+            },
+            /** Create a folder inside a project. */
+            createFolder: function (projectId, data) {
+                return req('post', "/api/v2/project/".concat(enc(projectId), "/contents/folder"), data);
+            },
+            /** Download a file (returns download URL or content). */
+            downloadFile: function (projectId, fileId) {
+                return req('get', "/api/v2/project/".concat(enc(projectId), "/contents/file/").concat(enc(fileId), "/download"));
+            },
+            /** Delete a file from a project. */
+            deleteFile: function (projectId, fileId) {
+                return req('delete', "/api/v2/project/".concat(enc(projectId), "/contents/file/").concat(enc(fileId)));
+            },
+            /** Delete a folder from a project. */
+            deleteFolder: function (projectId, folderId) {
+                return req('delete', "/api/v2/project/".concat(enc(projectId), "/contents/folder/").concat(enc(folderId)));
+            },
+            /** Get ComfyUI compute balance for a project. */
+            getComfyBalance: function (projectId) {
+                return req('get', "/api/v2/project/".concat(enc(projectId), "/comfy/balance"));
+            },
+            /** Get storage usage analytics for a project. */
+            getStorageAnalytics: function (projectId) {
+                return req('get', "/api/v2/project/".concat(enc(projectId), "/storage-analytics"));
+            },
+            /** Get clusters deployed for a specific project. */
+            getDeployedClusters: function (projectId) {
+                return req('get', "/api/v2/project/".concat(enc(projectId), "/clusters/deployed"));
+            },
+        };
+    };
+    // ── Pods ─────────────────────────────────────────────────
+    FlowscalePlatformAPI.prototype.buildPods = function () {
+        var req = this.request.bind(this);
+        return {
+            /** List available GPU types. */
+            listGpus: function () {
+                return req('get', '/api/v2/pod/gpus');
+            },
+            /** List all pods for the team. */
+            list: function () {
+                return req('get', '/api/v2/pod');
+            },
+            /** Get a pod by ID. */
+            get: function (podId) {
+                return req('get', "/api/v2/pod/".concat(enc(podId)));
+            },
+            /** Create a new pod. */
+            create: function (data) {
+                return req('post', '/api/v2/pod', data);
+            },
+            /** Update pod settings. */
+            update: function (podId, data) {
+                return req('put', "/api/v2/pod/".concat(enc(podId)), data);
+            },
+            /** Update pod budget. */
+            updateBudget: function (podId, budget) {
+                return req('patch', "/api/v2/pod/".concat(enc(podId), "/budget"), { budget: budget });
+            },
+            /** Stop all running clusters for a pod. */
+            stop: function (podId) {
+                return req('post', "/api/v2/pod/".concat(enc(podId), "/stop"));
+            },
+            /** Delete a pod. */
+            delete: function (podId) {
+                return req('delete', "/api/v2/pod/".concat(enc(podId)));
+            },
+            /** List workflows attached to a pod. */
+            listWorkflows: function (podId) {
+                return req('get', "/api/v2/pod/".concat(enc(podId), "/workflows"));
+            },
+            /** List all clusters for a pod. */
+            listClusters: function (podId) {
+                return req('get', "/api/v2/pod/".concat(enc(podId), "/clusters"));
+            },
+            /** Get the currently active cluster for a pod. */
+            getActiveCluster: function (podId) {
+                return req('get', "/api/v2/pod/".concat(enc(podId), "/cluster/active"));
+            },
+        };
+    };
+    // ── Clusters ─────────────────────────────────────────────
+    FlowscalePlatformAPI.prototype.buildClusters = function () {
+        var req = this.request.bind(this);
+        return {
+            /** List all clusters for the team. */
+            list: function () {
+                return req('get', '/api/v2/cluster');
+            },
+            /** Get a cluster by ID. */
+            get: function (clusterId) {
+                return req('get', "/api/v2/cluster/".concat(enc(clusterId)));
+            },
+            /** Start (deploy) a new cluster. */
+            start: function (data) {
+                return req('post', '/api/v2/cluster', data);
+            },
+            /** Stop a running cluster. */
+            stop: function (clusterId) {
+                return req('post', "/api/v2/cluster/".concat(enc(clusterId), "/stop"));
+            },
+            /** Get logs for a cluster. */
+            getLogs: function (clusterId) {
+                return req('get', "/api/v2/cluster/".concat(enc(clusterId), "/logs"));
+            },
+            /** Get usage analytics for a cluster. */
+            getAnalytics: function (clusterId) {
+                return req('get', "/api/v2/cluster/".concat(enc(clusterId), "/analytics"));
+            },
+            /** Analyze init logs with AI. */
+            analyzeInitLogs: function (clusterId) {
+                return req('post', "/api/v2/cluster/".concat(enc(clusterId), "/analyze-init-logs"));
+            },
+            /** Get temp nodes for a cluster. */
+            getTempNodes: function (clusterId) {
+                return req('get', "/api/v2/cluster/".concat(enc(clusterId), "/tempnodes"));
+            },
+        };
+    };
+    // ── Runs (platform-level) ─────────────────────────────────
+    FlowscalePlatformAPI.prototype.buildRuns = function () {
+        var req = this.request.bind(this);
+        return {
+            /** List all runs for the team. */
+            list: function (params) {
+                return req('get', '/api/v2/run', undefined, params);
+            },
+            /** Create a new run. */
+            create: function (data) {
+                return req('post', '/api/v2/run', data);
+            },
+            /** Delete a single run. */
+            delete: function (runId) {
+                return req('delete', "/api/v2/run/".concat(enc(runId)));
+            },
+            /** List output filenames for recent runs. */
+            listOutputs: function () {
+                return req('get', '/api/v2/run/outputs/list');
+            },
+        };
+    };
+    // ── Team ─────────────────────────────────────────────────
+    FlowscalePlatformAPI.prototype.buildTeam = function () {
+        var req = this.request.bind(this);
+        return {
+            /** List team-level API keys. */
+            listApiKeys: function () {
+                return req('get', '/api/v2/team/api-keys');
+            },
+            /** Create a new team-level API key. */
+            createApiKey: function (data) {
+                return req('post', '/api/v2/team/api-keys', data);
+            },
+            /** Revoke a team-level API key. */
+            revokeApiKey: function (keyId) {
+                return req('delete', "/api/v2/team/api-keys/".concat(enc(keyId)));
+            },
+            /** List active invite links. */
+            listInviteLinks: function () {
+                return req('get', '/api/v2/team/invite-links');
+            },
+            /** Create a new invite link. */
+            createInviteLink: function (data) {
+                return req('post', '/api/v2/team/invite-link', data);
+            },
+            /** Delete an invite link. */
+            deleteInviteLink: function (linkId) {
+                return req('delete', "/api/v2/team/invite-link/".concat(enc(linkId)));
+            },
+        };
+    };
+    // ── Analytics ────────────────────────────────────────────
+    FlowscalePlatformAPI.prototype.buildAnalytics = function () {
+        var req = this.request.bind(this);
+        return {
+            /** Get all analytics for the team. */
+            get: function (params) {
+                return req('get', '/api/v2/analytics', undefined, params);
+            },
+            /** Get high-level overview metrics. */
+            getOverview: function () {
+                return req('get', '/api/v2/analytics/overview');
+            },
+            /** Get run-specific analytics. */
+            getRuns: function (params) {
+                return req('get', '/api/v2/analytics/runs', undefined, params);
+            },
+            /** Get API call analytics. */
+            getApiCalls: function (params) {
+                return req('get', '/api/v2/analytics/api-calls', undefined, params);
+            },
+        };
+    };
+    // ── Auth ─────────────────────────────────────────────────
+    FlowscalePlatformAPI.prototype.buildAuth = function () {
+        var req = this.request.bind(this);
+        return {
+            /** Get the current user's profile. */
+            getProfile: function () {
+                return req('get', '/api/v2/auth/profile');
+            },
+            /** Refresh the access token using the refresh token. */
+            refreshToken: function (refreshToken) {
+                return req('post', '/api/v2/auth/refresh', { refresh_token: refreshToken });
+            },
+            /** Logout (invalidate current token). */
+            logout: function () {
+                return req('post', '/api/v2/auth/logout');
+            },
+        };
+    };
+    return FlowscalePlatformAPI;
+}());
+exports.FlowscalePlatformAPI = FlowscalePlatformAPI;
+// ── Utility ───────────────────────────────────────────────
+function enc(value) {
+    return encodeURIComponent(value);
+}
+__exportStar(require("./platform-types"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flowscale",
-  "version": "2.0.0",
+  "version": "2.1.0-beta.0",
   "description": "An NPM library for communicating with the Flowscale APIs",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",