@walkeros/cli 0.4.1 → 0.5.0

package/dist/examples/web-serve.json

@@ -0,0 +1,74 @@
+{
+  "version": 1,
+  "flows": {
+    "default": {
+      "web": {
+        "windowCollector": "collector",
+        "windowElb": "elb"
+      },
+      "packages": {
+        "@walkeros/collector": {
+          "imports": ["startFlow"]
+        },
+        "@walkeros/source-demo": {
+          "imports": ["sourceDemo"]
+        },
+        "@walkeros/destination-demo": {
+          "imports": ["destinationDemo"]
+        },
+        "@walkeros/web-destination-api": {
+          "imports": ["destinationAPI"]
+        }
+      },
+      "sources": {
+        "demo": {
+          "package": "@walkeros/source-demo",
+          "config": {
+            "settings": {
+              "events": [
+                {
+                  "name": "page view",
+                  "data": { "title": "Home", "path": "/" },
+                  "delay": 0
+                },
+                {
+                  "name": "product view",
+                  "data": {
+                    "id": "P123",
+                    "name": "Test Product",
+                    "price": 99.99
+                  },
+                  "delay": 100
+                }
+              ]
+            }
+          }
+        }
+      },
+      "destinations": {
+        "demo": {
+          "package": "@walkeros/destination-demo",
+          "config": {
+            "settings": {
+              "name": "demo"
+            }
+          }
+        },
+        "api": {
+          "package": "@walkeros/web-destination-api",
+          "config": {
+            "settings": {
+              "url": "http://localhost:8080/collect"
+            }
+          }
+        }
+      },
+      "collector": {
+        "run": true,
+        "globals": {
+          "language": "en"
+        }
+      }
+    }
+  }
+}

package/dist/index.d.ts

@@ -1,156 +1,111 @@
 import { Flow, Elb } from '@walkeros/core';
+export { Flow } from '@walkeros/core';
 import { BuildOptions as BuildOptions$1 } from 'esbuild';
 
 /**
  * CLI Build Configuration
  *
- * Build-time options for the walkerOS CLI bundle generation.
- * Completely separate from Flow.Config (runtime configuration).
+ * CLI-specific build options for walkerOS bundle generation.
+ * Uses Flow.Setup and Flow.Config from @walkeros/core for config structure.
  *
  * @packageDocumentation
  */
 
 /**
- * Build options for bundle generation.
+ * CLI-specific build options (public API).
  *
  * @remarks
- * Contains all CLI-specific build settings including:
- * - Package management (NPM packages to bundle)
- * - Code injection (custom user code)
- * - Output configuration (file paths, formats)
- * - Esbuild settings (minification, source maps, etc.)
+ * These are CLI-only options not part of the config file.
+ * The config file uses Flow.Setup from @walkeros/core.
  *
- * Completely separate from Flow.Config which handles runtime event processing.
+ * Platform-derived defaults:
+ * - web: format=iife, target=es2020, platform=browser
+ * - server: format=esm, target=node18, platform=node
  */
-interface BuildOptions extends Pick<BuildOptions$1, 'format' | 'target' | 'minify' | 'sourcemap' | 'platform' | 'external'> {
+interface CLIBuildOptions extends Pick<BuildOptions$1, 'external'> {
     /**
-     * NPM packages to bundle.
-     *
-     * @remarks
-     * Maps package name to version and imports configuration.
-     * Packages are downloaded from npm and bundled into the output.
-     *
-     * @example
-     * ```json
-     * {
-     *   "@walkeros/core": {
-     *     "version": "^0.2.0",
-     *     "imports": ["getId", "tryCatch"]
-     *   }
-     * }
-     * ```
+     * Output file path (CLI argument, not in config).
+     * @default "./dist/walker.js" (web) or "./dist/bundle.mjs" (server)
      */
-    packages: Record<string, {
-        version?: string;
-        imports?: string[];
-    }>;
+    output?: string;
+    /**
+     * Temporary directory for build artifacts.
+     * @default ".tmp"
+     */
+    tempDir?: string;
+    /**
+     * Enable package caching.
+     * @default true
+     */
+    cache?: boolean;
     /**
      * User code to include in bundle.
-     *
-     * @remarks
-     * Optional custom JavaScript/TypeScript code that will be included in the bundle.
-     * Can reference imported packages and will be executed when bundle loads.
-     * If omitted, the template's default behavior will be used.
-     *
-     * @default ""
-     *
-     * @example
-     * ```typescript
-     * "export default () => startFlow({ sources: {...}, destinations: {...} })"
-     * ```
      */
     code?: string;
+}
+/**
+ * Internal build options used by the bundler.
+ *
+ * @remarks
+ * Combines CLI options with resolved esbuild settings.
+ * This is populated after processing config and CLI arguments.
+ */
+interface BuildOptions extends CLIBuildOptions {
     /**
-     * Output file path.
-     *
-     * @remarks
-     * Absolute or relative path for the generated bundle.
-     * Directory will be created if it doesn't exist.
-     *
-     * @default "./dist/walker.js" (web) or "./dist/bundle.js" (server)
-     *
-     * @example
-     * "./dist/walker.min.js"
+     * Output file path (required for bundler).
      */
     output: string;
     /**
-     * Temporary directory for build artifacts.
-     *
-     * @remarks
-     * Used for:
-     * - Downloaded packages
-     * - Generated entry points
-     * - Intermediate build files
-     *
-     * Cleaned up after successful build unless shared with simulator.
-     *
-     * @default ".tmp"
+     * Packages to include in the bundle.
      */
-    tempDir?: string;
+    packages: Flow.Packages;
     /**
-     * Custom template file path.
-     *
-     * @remarks
-     * Override the default template (base.hbs or server.hbs).
-     * Template receives variables: {{sources}}, {{destinations}}, {{collector}}, {{{CODE}}}
-     *
-     * @default undefined (uses platform-specific default)
-     *
-     * @example
-     * "./templates/custom.hbs"
+     * Output format.
      */
-    template?: string;
+    format: 'esm' | 'iife' | 'cjs';
     /**
-     * Enable package caching.
-     *
-     * @remarks
-     * When enabled, downloaded packages are cached for faster subsequent builds.
-     *
+     * Target platform.
+     */
+    platform: 'browser' | 'node';
+    /**
+     * Enable minification.
      * @default true
      */
-    cache?: boolean;
+    minify?: boolean;
+    /**
+     * Enable source maps.
+     * @default false
+     */
+    sourcemap?: boolean;
+    /**
+     * ECMAScript target version.
+     */
+    target?: string;
     /**
      * Minification options.
-     *
-     * @remarks
-     * Fine-tune minification behavior.
-     * Only applies when minify=true.
      */
     minifyOptions?: MinifyOptions;
     /**
-     * Window property name for collector instance (web platform only).
-     *
-     * @remarks
-     * Only used when platform=browser and format=iife.
-     * The collector instance will be assigned to window[windowCollector].
-     * Ignored for server platform.
-     *
+     * Window property name for collector (web platform only).
      * @default "collector"
-     *
-     * @example
-     * ```json
-     * {
-     *   "build": {
-     *     "windowCollector": "tracker",
-     *     "windowElb": "track"
-     *   }
-     * }
-     * ```
-     *
-     * Results in: `window.tracker = collector; window.track = elb;`
      */
     windowCollector?: string;
     /**
      * Window property name for elb function (web platform only).
-     *
-     * @remarks
-     * Only used when platform=browser and format=iife.
-     * The elb function will be assigned to window[windowElb].
-     * Ignored for server platform.
-     *
      * @default "elb"
      */
     windowElb?: string;
+    /**
+     * Folders to include in the output directory.
+     * These folders are copied alongside the bundle for runtime access.
+     * @default ["./shared"] if folder exists
+     */
+    include?: string[];
+    /**
+     * Base directory for resolving include paths.
+     * Typically the directory containing the config file.
+     */
+    configDir?: string;
 }
 /**
  * Minification options.
@@ -161,112 +116,30 @@ interface BuildOptions extends Pick<BuildOptions$1, 'format' | 'target' | 'minif
 interface MinifyOptions {
     /**
      * Minify identifiers (variable names).
-     *
      * @default true
      */
     identifiers?: boolean;
     /**
      * Minify syntax (shorten code).
-     *
      * @default true
      */
     syntax?: boolean;
     /**
      * Minify whitespace.
-     *
      * @default true
      */
     whitespace?: boolean;
     /**
      * Keep original function/class names.
-     *
-     * @remarks
-     * Useful for debugging production bundles.
-     *
      * @default false
      */
     keepNames?: boolean;
     /**
      * How to handle legal comments.
-     *
      * @default "none"
      */
     legalComments?: 'none' | 'inline' | 'eof' | 'linked' | 'external';
 }
-/**
- * Single environment configuration.
- *
- * @remarks
- * Combines Flow.Config (runtime) with BuildOptions (build-time).
- * This is the structure stored in config files for each environment.
- */
-interface EnvironmentConfig {
-    /**
-     * Runtime event processing configuration.
-     *
-     * @remarks
-     * Defines sources, destinations, collector settings.
-     * From @walkeros/core - platform-agnostic.
-     */
-    flow: Flow.Config;
-    /**
-     * Build-time configuration.
-     *
-     * @remarks
-     * Defines how to bundle the flow configuration.
-     * CLI-specific settings.
-     */
-    build: BuildOptions;
-}
-/**
- * Multi-environment setup configuration.
- *
- * @remarks
- * Top-level config file format supporting multiple deployment environments.
- * Each environment has separate flow and build configurations.
- *
- * @example
- * ```json
- * {
- *   "version": 1,
- *   "variables": {
- *     "GA_ID": "G-XXXXXXXXXX"
- *   },
- *   "environments": {
- *     "production": {
- *       "flow": { "platform": "web", ... },
- *       "build": { "packages": {...}, "output": "./dist/prod.js" }
- *     },
- *     "staging": {
- *       "flow": { "platform": "web", ... },
- *       "build": { "packages": {...}, "output": "./dist/staging.js" }
- *     }
- *   }
- * }
- * ```
- */
-interface Setup {
-    /**
-     * Configuration schema version.
-     */
-    version: 1;
-    /**
-     * JSON Schema reference for IDE validation.
-     */
-    $schema?: string;
-    /**
-     * Shared variables for interpolation across all environments.
-     */
-    variables?: Record<string, string | number | boolean>;
-    /**
-     * Reusable configuration definitions.
-     */
-    definitions?: Record<string, unknown>;
-    /**
-     * Environments with flow and build configurations.
-     */
-    environments: Record<string, EnvironmentConfig>;
-}
 
 /**
  * Global CLI Options
@@ -311,7 +184,7 @@ interface BundleStats {
 
 interface BundleCommandOptions extends GlobalOptions {
     config: string;
-    env?: string;
+    flow?: string;
     all?: boolean;
     stats?: boolean;
     json?: boolean;
@@ -323,24 +196,27 @@ declare function bundleCommand(options: BundleCommandOptions): Promise<void>;
  *
  * Handles configuration loading, parsing, and logger creation internally.
  *
- * @param configOrPath - Bundle configuration object or path to config file
+ * @param configOrPath - Bundle configuration (Flow.Setup) 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)
  * @param options.stats - Collect and return bundle statistics (default: false)
  * @param options.cache - Enable package caching (default: true)
+ * @param options.flowName - Flow to use (required for multi-flow configs)
  * @returns Bundle statistics if stats option is true, otherwise void
  *
  * @example
  * ```typescript
- * // With config object
+ * // With Flow.Setup config object
  * await bundle({
- *   platform: 'web',
- *   packages: { '@walkeros/collector': { imports: ['startFlow'] } },
- *   sources: { browser: { code: 'sourceBrowser' } },
- *   destinations: { api: { code: 'destinationApi' } },
- *   code: 'export default startFlow({ sources, destinations })',
- *   output: './dist/walker.js'
+ *   version: 1,
+ *   flows: {
+ *     default: {
+ *       web: {},
+ *       packages: { '@walkeros/collector': { imports: ['startFlow'] } },
+ *       destinations: { api: { code: 'destinationApi' } },
+ *     }
+ *   }
  * });
  *
  * // With config file
@@ -352,6 +228,8 @@ declare function bundle(configOrPath: unknown, options?: {
     verbose?: boolean;
     stats?: boolean;
     cache?: boolean;
+    flowName?: string;
+    buildOverrides?: Partial<BuildOptions>;
 }): Promise<BundleStats | void>;
 
 /**
@@ -432,7 +310,7 @@ declare function simulate(configOrPath: string | unknown, event: unknown, option
 interface PushCommandOptions extends GlobalOptions {
     config: string;
     event: string;
-    env?: string;
+    flow?: string;
     json?: boolean;
 }
 
@@ -539,112 +417,4 @@ declare function runCommand(mode: string, options: RunCommandOptions): Promise<v
  */
 declare function run(mode: RunMode, options: RunOptions): Promise<RunResult>;
 
-/**
- * Template Configuration Types
- *
- * Type definitions for template processing and serialization.
- * Used by the template engine and serializer.
- *
- * @packageDocumentation
- */
-/**
- * Source or Destination configuration item for templates.
- *
- * @remarks
- * This type is used in template processing where config objects
- * are serialized to JavaScript code.
- */
-interface SourceDestinationItem {
-    /**
-     * JavaScript code reference (variable name or expression)
-     */
-    code: string;
-    /**
-     * Configuration object for the source/destination
-     */
-    config?: unknown;
-    /**
-     * Environment-specific variables
-     */
-    env?: unknown;
-    /**
-     * Allow additional properties for extensibility
-     */
-    [key: string]: unknown;
-}
-/**
- * Template variables that can be used in Handlebars templates.
- *
- * @remarks
- * These variables are available in template files for customization.
- */
-interface TemplateVariables {
-    /**
-     * Serialized sources configuration
-     */
-    sources: string;
-    /**
-     * Serialized destinations configuration
-     */
-    destinations: string;
-    /**
-     * Serialized collector configuration
-     */
-    collector: string;
-    /**
-     * User-provided code to be inserted
-     */
-    CODE: string;
-    /**
-     * Build configuration (optional)
-     */
-    build?: Record<string, unknown>;
-}
-/**
- * Processed template variables after serialization.
- *
- * @remarks
- * Internal type used by the serializer to represent processed configs.
- */
-interface ProcessedTemplateVariables {
-    /**
-     * Processed sources with serialized configs
-     */
-    sources?: Record<string, TemplateSource>;
-    /**
-     * Processed destinations with serialized configs
-     */
-    destinations?: Record<string, TemplateDestination>;
-    /**
-     * Processed collector configuration
-     */
-    collector?: Record<string, unknown> | string;
-    /**
-     * Allow additional properties
-     */
-    [key: string]: unknown;
-}
-/**
- * Template source after processing.
- *
- * @internal
- */
-interface TemplateSource {
-    code: string;
-    config?: unknown | string;
-    env?: unknown;
-    [key: string]: unknown;
-}
-/**
- * Template destination after processing.
- *
- * @internal
- */
-interface TemplateDestination {
-    code: string;
-    config?: unknown | string;
-    env?: unknown;
-    [key: string]: unknown;
-}
-
-export { type BuildOptions, type BundleStats, type EnvironmentConfig, type GlobalOptions, type ProcessedTemplateVariables, type RunCommandOptions, type RunMode, type RunOptions, type RunResult, type Setup, type SimulationResult, type SourceDestinationItem, type TemplateDestination, type TemplateSource, type TemplateVariables, bundle, bundleCommand, pushCommand, run, runCommand, simulate, simulateCommand };
+export { type BuildOptions, type BundleStats, type CLIBuildOptions, type GlobalOptions, type MinifyOptions, type RunCommandOptions, type RunMode, type RunOptions, type RunResult, type SimulationResult, bundle, bundleCommand, pushCommand, run, runCommand, simulate, simulateCommand };

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAYrD,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC;AAInE,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,GAAG,EAAE,MAAM,yBAAyB,CAAC;AAI9C,YAAY,EAAE,YAAY,EAAE,iBAAiB,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAChF,YAAY,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAChE,YAAY,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AACrE,YAAY,EACV,qBAAqB,EACrB,iBAAiB,EACjB,0BAA0B,EAC1B,cAAc,EACd,mBAAmB,GACpB,MAAM,qBAAqB,CAAC;AAC7B,YAAY,EACV,OAAO,EACP,iBAAiB,EACjB,UAAU,EACV,SAAS,GACV,MAAM,yBAAyB,CAAC;AACjC,YAAY,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAarD,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC;AAInE,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,GAAG,EAAE,MAAM,yBAAyB,CAAC;AAK9C,YAAY,EACV,IAAI,EACJ,eAAe,EACf,YAAY,EACZ,aAAa,GACd,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAChE,YAAY,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AACrE,YAAY,EACV,OAAO,EACP,iBAAiB,EACjB,UAAU,EACV,SAAS,GACV,MAAM,yBAAyB,CAAC;AACjC,YAAY,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC"}