@walkeros/cli 0.0.0-next-20251219153324

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

@@ -0,0 +1,427 @@
+import { Flow, Elb } from '@walkeros/core';
+export { Flow } from '@walkeros/core';
+import { BuildOptions as BuildOptions$1 } from 'esbuild';
+
+/**
+ * CLI Build Configuration
+ *
+ * CLI-specific build options for walkerOS bundle generation.
+ * Uses Flow.Setup and Flow.Config from @walkeros/core for config structure.
+ *
+ * @packageDocumentation
+ */
+
+/**
+ * CLI-specific build options (public API).
+ *
+ * @remarks
+ * These are CLI-only options not part of the config file.
+ * The config file uses Flow.Setup from @walkeros/core.
+ *
+ * Platform-derived defaults:
+ * - web: format=iife, target=es2020, platform=browser
+ * - server: format=esm, target=node18, platform=node
+ */
+interface CLIBuildOptions extends Pick<BuildOptions$1, 'external'> {
+    /**
+     * Output file path (CLI argument, not in config).
+     * @default "./dist/walker.js" (web) or "./dist/bundle.mjs" (server)
+     */
+    output?: string;
+    /**
+     * Temporary directory for build artifacts.
+     * @default ".tmp"
+     */
+    tempDir?: string;
+    /**
+     * Enable package caching.
+     * @default true
+     */
+    cache?: boolean;
+    /**
+     * User code to include in bundle.
+     */
+    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 (required for bundler).
+     */
+    output: string;
+    /**
+     * Packages to include in the bundle.
+     */
+    packages: Flow.Packages;
+    /**
+     * Output format.
+     */
+    format: 'esm' | 'iife' | 'cjs';
+    /**
+     * Target platform.
+     */
+    platform: 'browser' | 'node';
+    /**
+     * Enable minification.
+     * @default true
+     */
+    minify?: boolean;
+    /**
+     * Enable source maps.
+     * @default false
+     */
+    sourcemap?: boolean;
+    /**
+     * ECMAScript target version.
+     */
+    target?: string;
+    /**
+     * Minification options.
+     */
+    minifyOptions?: MinifyOptions;
+    /**
+     * Window property name for collector (web platform only).
+     * @default "collector"
+     */
+    windowCollector?: string;
+    /**
+     * Window property name for elb function (web platform only).
+     * @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.
+ *
+ * @remarks
+ * Controls esbuild's minification behavior.
+ */
+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.
+     * @default false
+     */
+    keepNames?: boolean;
+    /**
+     * How to handle legal comments.
+     * @default "none"
+     */
+    legalComments?: 'none' | 'inline' | 'eof' | 'linked' | 'external';
+}
+
+/**
+ * Global CLI Options
+ *
+ * Options that apply to all commands.
+ */
+/**
+ * Global options available across all CLI commands
+ */
+interface GlobalOptions {
+    /**
+     * Show detailed execution logs
+     * @default false
+     */
+    verbose?: boolean;
+    /**
+     * Suppress all output except errors
+     * @default false
+     */
+    silent?: boolean;
+    /**
+     * Preview command without executing
+     * @default false
+     */
+    dryRun?: boolean;
+}
+
+interface BundleStats {
+    totalSize: number;
+    packages: {
+        name: string;
+        size: number;
+    }[];
+    buildTime: number;
+    treeshakingEffective: boolean;
+}
+
+interface BundleCommandOptions {
+    config: string;
+    flow?: string;
+    all?: boolean;
+    stats?: boolean;
+    json?: boolean;
+    cache?: boolean;
+    verbose?: boolean;
+    dryRun?: boolean;
+    silent?: boolean;
+}
+declare function bundleCommand(options: BundleCommandOptions): Promise<void>;
+/**
+ * High-level bundle function for programmatic usage.
+ *
+ * Handles configuration loading, parsing, and logger creation internally.
+ *
+ * @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 Flow.Setup config object
+ * await bundle({
+ *   version: 1,
+ *   flows: {
+ *     default: {
+ *       web: {},
+ *       packages: { '@walkeros/collector': { imports: ['startFlow'] } },
+ *       destinations: { api: { code: 'destinationApi' } },
+ *     }
+ *   }
+ * });
+ *
+ * // With config file
+ * await bundle('./walker.config.json', { stats: true });
+ * ```
+ */
+declare function bundle(configOrPath: unknown, options?: {
+    silent?: boolean;
+    verbose?: boolean;
+    stats?: boolean;
+    cache?: boolean;
+    flowName?: string;
+    buildOverrides?: Partial<BuildOptions>;
+}): Promise<BundleStats | void>;
+
+/**
+ * Call Tracker for Simulation
+ *
+ * Wraps mock environment functions to track API calls.
+ * Used with destination-provided examples/env.ts mocks.
+ */
+interface ApiCall {
+    type: 'call';
+    path: string;
+    args: unknown[];
+    timestamp: number;
+}
+
+interface SimulateCommandOptions {
+    config: string;
+    event?: string;
+    json?: boolean;
+    verbose?: boolean;
+    dryRun?: boolean;
+    silent?: boolean;
+}
+interface SimulationResult {
+    success: boolean;
+    error?: string;
+    collector?: unknown;
+    elbResult?: Elb.PushResult;
+    logs?: unknown[];
+    usage?: Record<string, ApiCall[]>;
+    duration?: number;
+}
+
+/**
+ * CLI command handler for simulate command
+ */
+declare function simulateCommand(options: SimulateCommandOptions): Promise<void>;
+/**
+ * High-level simulate function for programmatic usage.
+ *
+ * Handles configuration loading internally and returns structured results.
+ *
+ * @param configOrPath - Bundle configuration object or path to config file
+ * @param event - Event object to simulate
+ * @param options - Simulation options
+ * @param options.silent - Suppress all output (default: false)
+ * @param options.verbose - Enable verbose logging (default: false)
+ * @param options.json - Format output as JSON (default: false)
+ * @returns Simulation result with success status, elb result, and usage data
+ *
+ * @example
+ * ```typescript
+ * // With config file
+ * const result = await simulate('./walker.config.json', {
+ *   name: 'page view',
+ *   data: { title: 'Home Page', path: '/', url: 'https://example.com' }
+ * });
+ *
+ * // With config object
+ * const result = await simulate(
+ *   {
+ *     platform: 'web',
+ *     packages: { '@walkeros/collector': { imports: ['startFlow'] } },
+ *     code: '...',
+ *     output: './bundle.js'
+ *   },
+ *   { name: 'page view' },
+ *   { silent: true }
+ * );
+ * ```
+ */
+declare function simulate(configOrPath: string | unknown, event: unknown, options?: {
+    silent?: boolean;
+    verbose?: boolean;
+    json?: boolean;
+}): Promise<SimulationResult>;
+
+/**
+ * Push command options
+ */
+interface PushCommandOptions {
+    config: string;
+    event: string;
+    flow?: string;
+    json?: boolean;
+    verbose?: boolean;
+    silent?: boolean;
+}
+
+/**
+ * CLI command handler for push command
+ */
+declare function pushCommand(options: PushCommandOptions): Promise<void>;
+
+/**
+ * Run Command Types
+ *
+ * Types for running walkerOS flows via CLI using local runtime
+ */
+/**
+ * Run mode - determines which execution mode to use
+ */
+type RunMode = 'collect' | 'serve';
+/**
+ * CLI command options for `walkeros run`
+ */
+interface RunCommandOptions {
+    /** Flow configuration file path (.json or pre-built .mjs) */
+    config: string;
+    /** Server port (overrides flow config) */
+    port?: number;
+    /** Server host (default: 0.0.0.0) */
+    host?: string;
+    /** Serve path (URL directory path, e.g., 'libs/v1') */
+    servePath?: string;
+    /** Serve name (filename in URL, default: walker.js) */
+    serveName?: string;
+    /** Enable JSON output */
+    json?: boolean;
+    /** Verbose logging */
+    verbose?: boolean;
+    /** Dry-run mode */
+    dryRun?: boolean;
+    /** Suppress output */
+    silent?: boolean;
+}
+/**
+ * Programmatic run options (subset of CLI options)
+ */
+interface RunOptions {
+    /** Flow configuration file path (.json or pre-built .mjs) */
+    config: string | unknown;
+    /** Server port */
+    port?: number;
+    /** Server host */
+    host?: string;
+    /** Serve path (URL directory path, e.g., 'libs/v1') */
+    servePath?: string;
+    /** Serve name (filename in URL, default: walker.js) */
+    serveName?: string;
+    /** Suppress output */
+    silent?: boolean;
+    /** Verbose logging */
+    verbose?: boolean;
+}
+/**
+ * Result from running a flow
+ */
+interface RunResult {
+    /** Whether the flow ran successfully */
+    success: boolean;
+    /** Exit code */
+    exitCode: number;
+    /** Error message if failed */
+    error?: string;
+    /** Execution duration in milliseconds */
+    duration: number;
+}
+
+/**
+ * Run Command
+ *
+ * Runs walkerOS flows using local runtime
+ */
+
+/**
+ * CLI command function for `walkeros run`
+ *
+ * @param mode - Run mode (collect | serve)
+ * @param options - Command options
+ */
+declare function runCommand(mode: string, options: RunCommandOptions): Promise<void>;
+/**
+ * Programmatic run function
+ *
+ * @param mode - Run mode (collect | serve)
+ * @param options - Run options
+ * @returns Run result
+ *
+ * @example
+ * ```typescript
+ * // Run with JSON config (bundles automatically)
+ * await run('collect', {
+ *   config: './flow.json',
+ *   port: 8080
+ * });
+ *
+ * // Run with pre-built bundle
+ * await run('collect', {
+ *   config: './flow.mjs',
+ *   port: 8080
+ * });
+ * ```
+ */
+declare function run(mode: RunMode, options: RunOptions): Promise<RunResult>;
+
+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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,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;AAQrD,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"}