flowscale 1.0.15 → 1.0.16

package/README.md

@@ -11,14 +11,14 @@ When using this SDK in a browser environment, your API key will be exposed to en
 1. Using this SDK in a Node.js backend environment
 2. Creating a proxy API that securely handles the API key server-side
 
-If you understand the risks and still need to use the SDK directly in the browser, you must explicitly acknowledge this by setting the `allowDangerouslyExposeApiKey` parameter:
+If you understand the risks and still need to use the SDK directly in the browser, you must explicitly acknowledge this by setting the `allowDangerouslyExposeApiKey` option:
 
 ```javascript
-const flowscale = new FlowscaleAPI(
-  apiKey,
-  apiUrl,
-  true // allowDangerouslyExposeApiKey - Only set to true if you understand the security risks
-);
+const flowscale = new FlowscaleAPI({
+  apiKey: 'your-api-key',
+  baseUrl: 'your-api-url',
+  allowDangerouslyExposeApiKey: false // Only set to true if you understand the security risks
+});
 ```
 
 ---
@@ -51,14 +51,18 @@ import { FlowscaleAPI } from 'flowscale';
 // Node.js Environment (Recommended)
 const apiKey = process.env.FLOWSCALE_API_KEY;
 const apiUrl = process.env.FLOWSCALE_API_URL;
-const flowscale = new FlowscaleAPI(apiKey, apiUrl);
+
+const flowscale = new FlowscaleAPI({
+  apiKey,
+  baseUrl: apiUrl
+});
 
 // Browser Environment (Not Recommended)
-const flowscale = new FlowscaleAPI(
-  'your-api-key', // ⚠️ WARNING: This will be exposed to users
-  'https://your-api-url.pod.flowscale.ai',
-  true // Explicitly acknowledge the security risk
-);
+const flowscale = new FlowscaleAPI({
+  apiKey: 'your-api-key', // ⚠️ WARNING: This will be exposed to users
+  baseUrl: 'https://your-api-url.pod.flowscale.ai',
+  allowDangerouslyExposeApiKey: true // Explicitly acknowledge the security risk
+});
 ```
 
 ### Environment-Specific Considerations

package/dist/index.d.ts

@@ -1,10 +1,10 @@
-import { HealthCheckResponse, QueueResponse, ExecuteWorkflowResponse, GetOutputResponse, RunDetailResponse, RunListResponse, CancelRunResponse } from './types';
+import { HealthCheckResponse, QueueResponse, ExecuteWorkflowResponse, GetOutputResponse, RunDetailResponse, RunListResponse, CancelRunResponse, FlowscaleConfig } from './types';
 export declare class FlowscaleAPI {
     private apiKey;
     private baseUrl;
     private client;
     private isNode;
-    constructor(apiKey: string, baseUrl: string, allowDangerouslyExposeApiKey?: boolean);
+    constructor(config: FlowscaleConfig);
     /**
      * Checks the health status of all ComfyUI instances within the specified cluster.
      */

package/dist/index.js

@@ -42,22 +42,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.FlowscaleAPI = void 0;
 var axios_1 = __importDefault(require("axios"));
 var FlowscaleAPI = /** @class */ (function () {
-    function FlowscaleAPI(apiKey, baseUrl, allowDangerouslyExposeApiKey) {
-        if (allowDangerouslyExposeApiKey === void 0) { allowDangerouslyExposeApiKey = false; }
+    function FlowscaleAPI(config) {
         var _this = this;
         // Check if we're in a Node.js environment
         this.isNode = typeof process !== 'undefined' &&
             process.versions != null &&
             process.versions.node != null;
         // Warn about API key exposure in browser environment
-        if (!this.isNode && !allowDangerouslyExposeApiKey) {
+        if (!this.isNode && !config.allowDangerouslyExposeApiKey) {
             throw new Error('WARNING: Using FlowscaleAPI in a browser environment will expose your API key to end users. ' +
                 'This is a security risk. If you understand the risks and still want to proceed, ' +
                 'set allowDangerouslyExposeApiKey to true. ' +
                 'We strongly recommend using a backend proxy instead.');
         }
-        this.apiKey = apiKey;
-        this.baseUrl = baseUrl;
+        this.apiKey = config.apiKey;
+        this.baseUrl = config.baseUrl;
         this.client = axios_1.default.create({
             baseURL: this.baseUrl,
         });

package/dist/types.d.ts

@@ -70,3 +70,8 @@ export interface ErrorResponse {
     status: string;
     errors: string;
 }
+export interface FlowscaleConfig {
+    apiKey: string;
+    baseUrl: string;
+    allowDangerouslyExposeApiKey?: boolean;
+}

package/package.json

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