@walkeros/cli 2.2.0-next-1772811722420 → 2.2.0-next-1773136823705

package/dist/index.d.ts

@@ -8,7 +8,7 @@ import * as openapi_fetch from 'openapi-fetch';
  * CLI Build Configuration
  *
  * CLI-specific build options for walkerOS bundle generation.
- * Uses Flow.Setup and Flow.Config from @walkeros/core for config structure.
+ * Uses Flow.Config and Flow.Settings from @walkeros/core for config structure.
  *
  * @packageDocumentation
  */
@@ -18,7 +18,7 @@ import * as openapi_fetch from 'openapi-fetch';
  *
  * @remarks
  * These are CLI-only options not part of the config file.
- * The config file uses Flow.Setup from @walkeros/core.
+ * The config file uses Flow.Config from @walkeros/core.
  *
  * Platform-derived defaults:
  * - web: format=iife, target=es2020, platform=browser
@@ -171,7 +171,7 @@ declare function bundleCommand(options: BundleCommandOptions): Promise<void>;
  *
  * Handles configuration loading, parsing, and logger creation internally.
  *
- * @param configOrPath - Bundle configuration (Flow.Setup) or path to config file
+ * @param configOrPath - Bundle configuration (Flow.Config) or path to config file
  * @param options - Bundle options
  * @param options.silent - Suppress all output (default: false)
  * @param options.verbose - Enable verbose logging (default: false)
@@ -182,7 +182,7 @@ declare function bundleCommand(options: BundleCommandOptions): Promise<void>;
  *
  * @example
  * ```typescript
- * // With Flow.Setup config object
+ * // With Flow.Config config object
  * await bundle({
  *   version: 1,
  *   flows: {
@@ -339,7 +339,7 @@ interface ExampleLookupResult {
  * @param stepTarget - Optional step target in "type.name" format
  * @returns The found example with its location
  */
-declare function findExample(config: Flow.Config, exampleName: string, stepTarget?: string): ExampleLookupResult;
+declare function findExample(config: Flow.Settings, exampleName: string, stepTarget?: string): ExampleLookupResult;
 
 /**
  * Compare simulation output against expected example output.
@@ -472,49 +472,47 @@ declare function push(configOrPath: string | unknown, event: unknown, options?:
 /**
  * Run Command Types
  *
- * Types for running walkerOS flows via CLI using local runtime
+ * Types for running walkerOS flows via CLI or Docker.
  */
 /**
  * CLI command options for `walkeros run`
  */
 interface RunCommandOptions {
     /** Flow configuration file path (.json or pre-built .mjs) */
-    config: string;
+    config?: string;
     /** Server port (overrides flow config) */
     port?: number;
-    /** Server host (default: 0.0.0.0) */
-    host?: string;
+    /** Flow name for multi-flow configs */
+    flow?: string;
+    /** API flow ID (enables heartbeat, polling, secrets) */
+    flowId?: string;
+    /** Project ID */
+    project?: string;
     /** Enable JSON output */
     json?: boolean;
     /** Verbose logging */
     verbose?: boolean;
     /** Suppress output */
     silent?: boolean;
-    /** Deployment slug (enables heartbeat to walkerOS app) */
-    deployment?: string;
-    /** Project ID (used with --deploy) */
-    project?: string;
-    /** Public URL of this server (used with --deploy) */
-    url?: string;
-    /** Health check endpoint path (used with --deploy, default: /health) */
-    healthEndpoint?: string;
-    /** Heartbeat interval in seconds (used with --deploy, default: 60) */
-    heartbeatInterval?: number;
 }
 /**
- * Programmatic run options (subset of CLI options)
+ * Programmatic run options
  */
 interface RunOptions {
     /** Flow configuration file path (.json or pre-built .mjs) */
-    config: string | unknown;
+    config?: string;
     /** Server port */
     port?: number;
-    /** Server host */
-    host?: string;
-    /** Suppress output */
-    silent?: boolean;
+    /** Flow name for multi-flow configs */
+    flow?: string;
+    /** API flow ID (enables heartbeat, polling, secrets) */
+    flowId?: string;
+    /** Project ID */
+    project?: string;
     /** Verbose logging */
     verbose?: boolean;
+    /** Suppress output */
+    silent?: boolean;
 }
 /**
  * Result from running a flow
@@ -533,35 +531,16 @@ interface RunResult {
 /**
  * Run Command
  *
- * Runs walkerOS flows using local runtime
+ * Unified entry point for running walkerOS flows.
+ * Used by both `walkeros run` (CLI) and Docker containers.
  */
 
 /**
  * CLI command function for `walkeros run`
- *
- * @param options - Command options
  */
 declare function runCommand(options: RunCommandOptions): Promise<void>;
 /**
  * Programmatic run function
- *
- * @param options - Run options
- * @returns Run result
- *
- * @example
- * ```typescript
- * // Run with JSON config (bundles automatically)
- * await run({
- *   config: './flow.json',
- *   port: 8080
- * });
- *
- * // Run with pre-built bundle
- * await run({
- *   config: './flow.mjs',
- *   port: 8080
- * });
- * ```
  */
 declare function run(options: RunOptions): Promise<RunResult>;
 
@@ -719,7 +698,7 @@ declare function listFlows(options?: ListFlowsOptions): Promise<{
         id: string;
         name: string;
         summary?: string | undefined;
-        configs?: {
+        settings?: {
             id: string;
             name: string;
             platform: "web" | "server";
@@ -739,7 +718,7 @@ declare function getFlow(options: {
 }): Promise<{
     id: string;
     name: string;
-    content: {
+    config: {
         version: 2;
         $schema?: string | undefined;
         include?: string[] | undefined;
@@ -756,7 +735,7 @@ declare function getFlow(options: {
             [x: string]: unknown;
         } | undefined;
     };
-    configs?: {
+    settings?: {
         id: string;
         name: string;
         platform: "web" | "server";
@@ -784,7 +763,7 @@ declare function createFlow(options: {
 }): Promise<{
     id: string;
     name: string;
-    content: {
+    config: {
         version: 2;
         $schema?: string | undefined;
         include?: string[] | undefined;
@@ -801,7 +780,7 @@ declare function createFlow(options: {
             [x: string]: unknown;
         } | undefined;
     };
-    configs?: {
+    settings?: {
         id: string;
         name: string;
         platform: "web" | "server";
@@ -821,7 +800,7 @@ declare function updateFlow(options: {
 }): Promise<{
     id: string;
     name: string;
-    content: {
+    config: {
         version: 2;
         $schema?: string | undefined;
         include?: string[] | undefined;
@@ -854,7 +833,7 @@ declare function duplicateFlow(options: {
 }): Promise<{
     id: string;
     name: string;
-    content: {
+    config: {
         version: 2;
         $schema?: string | undefined;
         include?: string[] | undefined;
@@ -871,7 +850,7 @@ declare function duplicateFlow(options: {
             [x: string]: unknown;
         } | undefined;
     };
-    configs?: {
+    settings?: {
         id: string;
         name: string;
         platform: "web" | "server";
@@ -2434,7 +2413,7 @@ interface paths {
     put?: never;
     /**
      * Start deployment
-     * @description Start a new deployment for a flow. Returns 400 AMBIGUOUS_CONFIG if the flow has multiple named configs — use the per-config deploy endpoint instead.
+     * @description Start a new deployment for a flow. Returns 400 AMBIGUOUS_CONFIG if the flow has multiple named settings — use the per-settings deploy endpoint instead.
      */
     post: {
       parameters: {
@@ -2703,7 +2682,7 @@ interface paths {
     patch?: never;
     trace?: never;
   };
-  '/api/projects/{projectId}/flows/{flowId}/configs': {
+  '/api/projects/{projectId}/flows/{flowId}/settings': {
     parameters: {
       query?: never;
       header?: never;
@@ -2711,8 +2690,8 @@ interface paths {
       cookie?: never;
     };
     /**
-     * List configs
-     * @description List active named configs for a flow.
+     * List settings
+     * @description List active named settings for a flow.
      */
     get: {
       parameters: {
@@ -2726,13 +2705,13 @@ interface paths {
       };
       requestBody?: never;
       responses: {
-        /** @description List of configs */
+        /** @description List of settings */
         200: {
           headers: {
             [name: string]: unknown;
           };
           content: {
-            'application/json': components['schemas']['ListConfigsResponse'];
+            'application/json': components['schemas']['ListSettingsResponse'];
           };
         };
         /** @description Unauthorized */
@@ -2763,7 +2742,7 @@ interface paths {
     patch?: never;
     trace?: never;
   };
-  '/api/projects/{projectId}/flows/{flowId}/configs/{configId}': {
+  '/api/projects/{projectId}/flows/{flowId}/settings/{settingsId}': {
     parameters: {
       query?: never;
       header?: never;
@@ -2771,8 +2750,8 @@ interface paths {
       cookie?: never;
     };
     /**
-     * Get config
-     * @description Get a single config with its latest deployment.
+     * Get settings
+     * @description Get a single settings entry with its latest deployment.
      */
     get: {
       parameters: {
@@ -2781,19 +2760,19 @@ interface paths {
         path: {
           projectId: string;
           flowId: string;
-          configId: string;
+          settingsId: string;
         };
         cookie?: never;
       };
       requestBody?: never;
       responses: {
-        /** @description Config details with deployment */
+        /** @description Settings details with deployment */
         200: {
           headers: {
             [name: string]: unknown;
           };
           content: {
-            'application/json': components['schemas']['FlowConfigDetail'];
+            'application/json': components['schemas']['FlowSettingsDetail'];
           };
         };
         /** @description Unauthorized */
@@ -2824,7 +2803,7 @@ interface paths {
     patch?: never;
     trace?: never;
   };
-  '/api/projects/{projectId}/flows/{flowId}/configs/{configId}/json': {
+  '/api/projects/{projectId}/flows/{flowId}/settings/{settingsId}/json': {
     parameters: {
       query?: never;
       header?: never;
@@ -2832,8 +2811,8 @@ interface paths {
       cookie?: never;
     };
     /**
-     * Download config JSON
-     * @description Download the named flow config as a self-contained Setup JSON file. Includes parent variables and definitions.
+     * Download settings JSON
+     * @description Download the named flow settings as a self-contained Setup JSON file. Includes parent variables and definitions.
      */
     get: {
       parameters: {
@@ -2842,7 +2821,7 @@ interface paths {
         path: {
           projectId: string;
           flowId: string;
-          configId: string;
+          settingsId: string;
         };
         cookie?: never;
       };
@@ -2885,7 +2864,7 @@ interface paths {
     patch?: never;
     trace?: never;
   };
-  '/api/projects/{projectId}/flows/{flowId}/configs/{configId}/bundle': {
+  '/api/projects/{projectId}/flows/{flowId}/settings/{settingsId}/bundle': {
     parameters: {
       query?: never;
       header?: never;
@@ -2893,8 +2872,8 @@ interface paths {
       cookie?: never;
     };
     /**
-     * Download config bundle
-     * @description Download the compiled JS/MJS for the config's latest deployment. Redirects to a presigned download URL.
+     * Download settings bundle
+     * @description Download the compiled JS/MJS for the settings' latest deployment. Redirects to a presigned download URL.
      */
     get: {
       parameters: {
@@ -2903,7 +2882,7 @@ interface paths {
         path: {
           projectId: string;
           flowId: string;
-          configId: string;
+          settingsId: string;
         };
         cookie?: never;
       };
@@ -2953,7 +2932,7 @@ interface paths {
     patch?: never;
     trace?: never;
   };
-  '/api/projects/{projectId}/flows/{flowId}/configs/{configId}/deploy': {
+  '/api/projects/{projectId}/flows/{flowId}/settings/{settingsId}/deploy': {
     parameters: {
       query?: never;
       header?: never;
@@ -2961,8 +2940,8 @@ interface paths {
       cookie?: never;
     };
     /**
-     * Get latest config deployment
-     * @description Get the latest deployment for a specific config.
+     * Get latest settings deployment
+     * @description Get the latest deployment for a specific settings entry.
      */
     get: {
       parameters: {
@@ -2971,7 +2950,7 @@ interface paths {
         path: {
           projectId: string;
           flowId: string;
-          configId: string;
+          settingsId: string;
         };
         cookie?: never;
       };
@@ -2983,7 +2962,7 @@ interface paths {
             [name: string]: unknown;
           };
           content: {
-            'application/json': components['schemas']['ConfigDeploymentResponse'];
+            'application/json': components['schemas']['SettingsDeploymentResponse'];
           };
         };
         /** @description Unauthorized */
@@ -3008,8 +2987,8 @@ interface paths {
     };
     put?: never;
     /**
-     * Deploy config
-     * @description Start a deployment for a specific config. Detects platform from the config.
+     * Deploy settings
+     * @description Start a deployment for a specific settings entry. Detects platform from the settings.
      */
     post: {
       parameters: {
@@ -3018,7 +2997,7 @@ interface paths {
         path: {
           projectId: string;
           flowId: string;
-          configId: string;
+          settingsId: string;
         };
         cookie?: never;
       };
@@ -3030,7 +3009,7 @@ interface paths {
             [name: string]: unknown;
           };
           content: {
-            'application/json': components['schemas']['DeployConfigResponse'];
+            'application/json': components['schemas']['DeploySettingsResponse'];
           };
         };
         /** @description Unauthorized */
@@ -3060,7 +3039,7 @@ interface paths {
             'application/json': components['schemas']['ErrorResponse'];
           };
         };
-        /** @description Config orphaned */
+        /** @description Settings orphaned */
         422: {
           headers: {
             [name: string]: unknown;
@@ -3086,7 +3065,7 @@ interface paths {
     patch?: never;
     trace?: never;
   };
-  '/api/projects/{projectId}/flows/{flowId}/configs/{configId}/deployments/{deploymentId}': {
+  '/api/projects/{projectId}/flows/{flowId}/settings/{settingsId}/deployments/{deploymentId}': {
     parameters: {
       query?: never;
       header?: never;
@@ -3094,8 +3073,8 @@ interface paths {
       cookie?: never;
     };
     /**
-     * Get config deployment detail
-     * @description Get a specific deployment by ID, scoped to a config.
+     * Get settings deployment detail
+     * @description Get a specific deployment by ID, scoped to a settings entry.
      */
     get: {
       parameters: {
@@ -3104,7 +3083,7 @@ interface paths {
         path: {
           projectId: string;
           flowId: string;
-          configId: string;
+          settingsId: string;
           deploymentId: string;
         };
         cookie?: never;
@@ -3117,7 +3096,7 @@ interface paths {
             [name: string]: unknown;
           };
           content: {
-            'application/json': components['schemas']['ConfigDeploymentDetailResponse'];
+            'application/json': components['schemas']['SettingsDeploymentDetailResponse'];
           };
         };
         /** @description Unauthorized */
@@ -3148,7 +3127,7 @@ interface paths {
     patch?: never;
     trace?: never;
   };
-  '/api/projects/{projectId}/flows/{flowId}/configs/{configId}/deployments/{deploymentId}/advance': {
+  '/api/projects/{projectId}/flows/{flowId}/settings/{settingsId}/deployments/{deploymentId}/advance': {
     parameters: {
       query?: never;
       header?: never;
@@ -3158,8 +3137,8 @@ interface paths {
     get?: never;
     put?: never;
     /**
-     * Advance config deployment
-     * @description Advance the deployment state machine for a per-config deployment.
+     * Advance settings deployment
+     * @description Advance the deployment state machine for a per-settings deployment.
      */
     post: {
       parameters: {
@@ -3168,7 +3147,7 @@ interface paths {
         path: {
           projectId: string;
           flowId: string;
-          configId: string;
+          settingsId: string;
           deploymentId: string;
         };
         cookie?: never;
@@ -3181,7 +3160,7 @@ interface paths {
             [name: string]: unknown;
           };
           content: {
-            'application/json': components['schemas']['AdvanceConfigDeploymentResponse'];
+            'application/json': components['schemas']['AdvanceSettingsDeploymentResponse'];
           };
         };
         /** @description Unauthorized */
@@ -3626,12 +3605,12 @@ interface paths {
     put?: never;
     /**
      * Trigger flow bundle
-     * @description Start a bundle job for a project flow. For multi-config flows, specify the named flow via ?flow= query parameter.
+     * @description Start a bundle job for a project flow. For multi-settings flows, specify the named flow via ?flow= query parameter.
      */
     post: {
       parameters: {
         query?: {
-          /** @description Named flow to bundle (required for multi-config flows) */
+          /** @description Named flow to bundle (required for multi-settings flows) */
           flow?: string;
         };
         header?: never;
@@ -3670,7 +3649,7 @@ interface paths {
             'application/json': components['schemas']['ErrorResponse'];
           };
         };
-        /** @description Flow selection required for multi-config flows */
+        /** @description Flow selection required for multi-settings flows */
         422: {
           headers: {
             [name: string]: unknown;
@@ -4335,8 +4314,8 @@ interface components {
       id: string;
       /** @example my-website-flow */
       name: string;
-      content: components['schemas']['FlowContent'];
-      configs?: components['schemas']['FlowConfigSummary'][];
+      config: components['schemas']['FlowContent'];
+      settings?: components['schemas']['FlowSettingsSummary'][];
       /**
        * Format: date-time
        * @example 2026-01-26T14:30:00.000Z
@@ -4350,7 +4329,7 @@ interface components {
       /** Format: date-time */
       deletedAt?: string | null;
     };
-    FlowConfigSummary: {
+    FlowSettingsSummary: {
       /** @example cfg_a1b2c3d4 */
       id: string;
       name: string;
@@ -4376,7 +4355,7 @@ interface components {
       /** @example my-website-flow */
       name: string;
       summary?: string;
-      configs?: components['schemas']['FlowConfigListItem'][];
+      settings?: components['schemas']['FlowSettingsListItem'][];
       /**
        * Format: date-time
        * @example 2026-01-26T14:30:00.000Z
@@ -4390,7 +4369,7 @@ interface components {
       /** Format: date-time */
       deletedAt: string | null;
     };
-    FlowConfigListItem: {
+    FlowSettingsListItem: {
       /** @example cfg_a1b2c3d4 */
       id: string;
       name: string;
@@ -4485,7 +4464,7 @@ interface components {
        */
       revokedAt: string | null;
     };
-    FlowConfigDetail: {
+    FlowSettingsDetail: {
       /** @example cfg_a1b2c3d4 */
       id: string;
       name: string;
@@ -4526,10 +4505,10 @@ interface components {
        */
       updatedAt: string;
     };
-    DeployConfigResponse: {
+    DeploySettingsResponse: {
       deploymentId: string;
       /** @example cfg_a1b2c3d4 */
-      configId: string;
+      settingsId: string;
       status: string;
     };
     FlowDetailResponse: {
@@ -4537,8 +4516,8 @@ interface components {
       id: string;
       /** @example my-website-flow */
       name: string;
-      content: components['schemas']['FlowContent'];
-      configs?: components['schemas']['FlowConfigEnriched'][];
+      config: components['schemas']['FlowContent'];
+      settings?: components['schemas']['FlowSettingsEnriched'][];
       /**
        * Format: date-time
        * @example 2026-01-26T14:30:00.000Z
@@ -4552,7 +4531,7 @@ interface components {
       /** Format: date-time */
       deletedAt: string | null;
     };
-    FlowConfigEnriched: {
+    FlowSettingsEnriched: {
       id: string;
       name: string;
       /** @enum {string} */
@@ -4587,7 +4566,7 @@ interface components {
       id: string;
       /** @example my-website-flow */
       name: string;
-      content: components['schemas']['FlowContent'];
+      config: components['schemas']['FlowContent'];
       /**
        * Format: date-time
        * @example 2026-01-26T14:30:00.000Z
@@ -4696,7 +4675,7 @@ interface components {
       source: {
         type: string;
         flowId?: string;
-        flowConfigId?: string;
+        flowSettingsId?: string;
         configHash?: string;
       };
       /** Format: date-time */
@@ -4805,7 +4784,7 @@ interface components {
             /** @enum {string} */
             type: 'flow';
             flowId: string;
-            flowConfigName: string;
+            flowSettingsName: string;
           }
         | {
             /** @enum {string} */
@@ -4821,7 +4800,7 @@ interface components {
         source: {
           type: string;
           flowId?: string;
-          flowConfigId?: string;
+          flowSettingsId?: string;
           configHash?: string;
         };
         bundlePath: string | null;
@@ -4944,12 +4923,12 @@ interface components {
     CreateFlowRequest: {
       /** @example my-website-flow */
       name: string;
-      content?: components['schemas']['FlowContent'];
+      config?: components['schemas']['FlowContent'];
     };
     UpdateFlowRequest: {
       /** @example my-website-flow */
       name?: string;
-      content?: components['schemas']['FlowContent'];
+      config?: components['schemas']['FlowContent'];
     };
     DuplicateFlowRequest: {
       /** @example my-website-flow */
@@ -4975,13 +4954,13 @@ interface components {
       type: 'web' | 'server';
       status: string;
     };
-    ListConfigsResponse: {
-      configs: components['schemas']['FlowConfigSummary'][];
+    ListSettingsResponse: {
+      settings: components['schemas']['FlowSettingsSummary'][];
     };
-    ConfigDeploymentResponse: {
+    SettingsDeploymentResponse: {
       id: string;
       flowId: string;
-      configId: string;
+      settingsId: string;
       /** @enum {string} */
       type: 'web' | 'server';
       status: string;
@@ -4993,10 +4972,10 @@ interface components {
       /** Format: date-time */
       updatedAt: string;
     } | null;
-    ConfigDeploymentDetailResponse: {
+    SettingsDeploymentDetailResponse: {
       id: string;
       flowId: string;
-      configId: string;
+      settingsId: string;
       status: string;
       /** @enum {string} */
       type: 'web' | 'server';
@@ -5008,7 +4987,7 @@ interface components {
       /** Format: date-time */
       updatedAt: string;
     };
-    AdvanceConfigDeploymentResponse: {
+    AdvanceSettingsDeploymentResponse: {
       id: string;
       flowId: string;
       /** @enum {string} */
@@ -5031,7 +5010,7 @@ interface components {
     GetVersionResponse: {
       /** @example 1 */
       version: number;
-      content: components['schemas']['FlowContent'];
+      config: components['schemas']['FlowContent'];
       /**
        * Format: date-time
        * @example 2026-01-26T14:30:00.000Z