@cloudflare/autoconfig 0.2.9 → 0.4.0

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-import { PackageManager, RawConfig, PackageJSON, Config, FatalError, TelemetryMessage, UserError } from '@cloudflare/workers-utils';
+import { WorkerConfigInput } from '@cloudflare/config';
+import { PackageManager, PackageJSON, RawConfig, Config, FatalError, TelemetryMessage, UserError } from '@cloudflare/workers-utils';
 export { getInstalledPackageVersion } from '@cloudflare/workers-utils';
 
 /**
@@ -17,6 +18,7 @@ interface AutoConfigLogger {
     /** Logs an error message. */
     error(...args: unknown[]): void;
 }
+type AutoConfigTarget = "cf" | "wrangler";
 /**
  * Dialog interface for interactive prompts.
  * Callers provide their own implementation (e.g., using `prompts`, `inquirer`, or a custom UI).
@@ -130,9 +132,12 @@ declare abstract class Framework {
     #private;
     readonly id: FrameworkInfo["id"];
     readonly name: FrameworkInfo["name"];
+    readonly env?: Readonly<Record<string, string>>;
     get frameworkVersion(): string;
     constructor(frameworkInfo: Pick<FrameworkInfo, "id" | "name">);
-    isConfigured(_projectPath: string): boolean;
+    isConfigured(_projectPath: string, { target: _target, }?: {
+        target?: AutoConfigTarget;
+    }): boolean;
     abstract configure(options: ConfigurationOptions): Promise<ConfigurationResults> | ConfigurationResults;
     configurationDescription?: string;
     /**
@@ -149,6 +154,7 @@ declare abstract class Framework {
     validateFrameworkVersion(projectPath: string, frameworkPackageInfo: AutoConfigFrameworkPackageInfo, context: AutoConfigContext): void;
 }
 type ConfigurationOptions = {
+    target: AutoConfigTarget;
     outputDir: string;
     projectPath: string;
     workerName: string;
@@ -162,9 +168,16 @@ type PackageJsonScriptsOverrides = {
     deploy?: string;
     typegen?: string;
 };
+type BuildConfig = {
+    assetsDirectory?: string;
+};
 type ConfigurationResults = {
-    /** The wrangler configuration that the framework's `configure()` hook should generate. `null` if autoconfig should not create the wrangler file (in case an external tool already does that) */
-    wranglerConfig: RawConfig | null;
+    /** The tool that cf should delegate build and development commands to. */
+    buildTool?: "vite" | "wrangler";
+    /** Worker configuration generated by the framework. `null` if an external tool generates it. */
+    workerConfig: Partial<WorkerConfigInput> | null;
+    /** Build configuration that complements the Worker configuration. */
+    buildConfig?: BuildConfig;
     packageJsonScriptsOverrides?: PackageJsonScriptsOverrides;
     buildCommandOverride?: string;
     deployCommandOverride?: string;
@@ -184,8 +197,12 @@ type AutoConfigDetailsBase = {
     configured: boolean;
     /** Details about the detected framework. It can be a JS framework or 'Static' if no actual JS framework is used. */
     framework: Framework;
+    /** The dev command used to run the project locally (if any) */
+    devCommand?: string;
     /** The build command used to build the project (if any) */
     buildCommand?: string;
+    /** Environment required when running the detected dev or build commands. */
+    env?: Readonly<Record<string, string>>;
     /** The output directory (if no framework is used, points to the raw asset files) */
     outputDir: string;
     /** The detected package manager for the project */
@@ -201,6 +218,8 @@ type AutoConfigDetailsForNonConfiguredProject = AutoConfigDetailsBase & {
 };
 type AutoConfigDetails = AutoConfigDetailsForConfiguredProject | AutoConfigDetailsForNonConfiguredProject;
 type AutoConfigOptions = {
+    /** The configuration target, defaults to cf. */
+    target?: AutoConfigTarget;
     /** The autoconfig context providing logger, dialogs, and other dependencies. */
     context: AutoConfigContext;
     /** Whether to run autoconfig without actually applying any filesystem modification (default: false) */
@@ -218,13 +237,14 @@ type AutoConfigOptions = {
      */
     skipConfirmations?: boolean;
     /**
-     * Whether to install Wrangler during autoconfig
+     * Whether to install the selected target CLI during autoconfig.
      */
-    enableWranglerInstallation?: boolean;
+    enableTargetCliInstallation?: boolean;
 };
 type AutoConfigSummary = {
     scripts: Record<string, string>;
-    wranglerInstall: boolean;
+    workerConfig?: WorkerConfigInput;
+    buildConfig?: BuildConfig;
     wranglerConfig?: RawConfig;
     frameworkConfiguration?: string;
     outputDir: string;
@@ -236,16 +256,21 @@ type AutoConfigSummary = {
 
 /**
  * Detects project details needed for autoconfig: framework, package manager,
- * output directory, worker name, and whether the project is already configured.
+ * output directory, worker name, commands, and whether the project is already configured.
+ * By default, the project is considered configured when `cloudflare.config.ts`
+ * exists. Passing `target: "wrangler"` opts into Wrangler configuration
+ * detection instead.
  *
  * @param options - Detection options including project path, wrangler config, and context.
  * @returns The detected project details.
  */
-declare function getDetailsForAutoConfig({ projectPath, wranglerConfig, context, }: {
+declare function getDetailsForAutoConfig({ projectPath, wranglerConfig, target, context, }: {
     /** The path to the project, defaults to cwd. */
     projectPath?: string;
     /** The parsed wrangler configuration for the project (if any). */
     wranglerConfig?: Config;
+    /** The configuration target, defaults to cf. */
+    target?: AutoConfigTarget;
     /** The autoconfig context providing logger, dialogs, and other dependencies. */
     context: AutoConfigContext;
 }): Promise<AutoConfigDetails>;
@@ -270,7 +295,7 @@ declare function confirmAutoConfigDetails(autoConfigDetails: AutoConfigDetails,
 
 /**
  * Runs the full autoconfig flow: displays detected settings, confirms with the user,
- * validates the framework version, runs framework configuration, writes wrangler config,
+ * validates the framework version, runs framework configuration, writes configuration,
  * updates package.json scripts, and optionally runs the build command.
  *
  * @param autoConfigDetails - The detected project details from `getDetailsForAutoConfig()`.
@@ -280,23 +305,26 @@ declare function confirmAutoConfigDetails(autoConfigDetails: AutoConfigDetails,
 declare function runAutoConfig(autoConfigDetails: AutoConfigDetails, autoConfigOptions: AutoConfigOptions): Promise<AutoConfigSummary>;
 /**
  * Builds a summary of all operations that autoconfig will (or did) perform,
- * including package installation, package.json script updates, wrangler config
+ * including package installation, package.json script updates, configuration
  * creation, and framework-specific configuration.
  *
  * @param autoConfigDetails - The detected project details.
- * @param wranglerConfigToWrite - The wrangler config object to write, or `null` if not applicable.
+ * @param workerConfig - The resolved Worker configuration.
+ * @param configurationResults - The framework configuration results.
  * @param projectCommands - The build, deploy, and version commands for the project.
+ * @param enableTargetCliInstallation - Whether to install the selected target CLI package.
+ * @param target - The configuration target.
  * @param context - The autoconfig context providing logger and other dependencies.
  * @param packageJsonScriptsOverrides - Optional overrides for package.json script entries.
  * @returns A summary object describing all planned operations.
  */
 declare function buildOperationsSummary(autoConfigDetails: AutoConfigDetailsForNonConfiguredProject & {
     outputDir: NonNullable<AutoConfigDetails["outputDir"]>;
-}, wranglerConfigToWrite: RawConfig | null, projectCommands: {
+}, workerConfig: WorkerConfigInput | null, configurationResults: ConfigurationResults, projectCommands: {
     build?: string;
     deploy: string;
     version?: string;
-}, context: AutoConfigContext, packageJsonScriptsOverrides?: PackageJsonScriptsOverrides): Promise<AutoConfigSummary>;
+}, enableTargetCliInstallation: boolean, target: AutoConfigTarget, context: AutoConfigContext, packageJsonScriptsOverrides?: PackageJsonScriptsOverrides): Promise<AutoConfigSummary>;
 
 /**
  * Base class for errors where something in a autoconfig frameworks' configuration goes
@@ -326,4 +354,4 @@ declare class AutoConfigDetectionError extends FatalError {
     });
 }
 
-export { type AutoConfigContext, type AutoConfigDetails, type AutoConfigDetailsForConfiguredProject, type AutoConfigDetailsForNonConfiguredProject, AutoConfigDetectionError, type AutoConfigDialogs, AutoConfigFrameworkConfigurationError, type AutoConfigFrameworkPackageInfo, type AutoConfigLogger, type AutoConfigOptions, type AutoConfigSummary, type ConfigurationOptions, type ConfigurationResults, Framework, type FrameworkInfo, type PackageJsonScriptsOverrides, buildOperationsSummary, confirmAutoConfigDetails, displayAutoConfigDetails, getDetailsForAutoConfig, isFrameworkSupported, runAutoConfig };
+export { type AutoConfigContext, type AutoConfigDetails, type AutoConfigDetailsForConfiguredProject, type AutoConfigDetailsForNonConfiguredProject, AutoConfigDetectionError, type AutoConfigDialogs, AutoConfigFrameworkConfigurationError, type AutoConfigFrameworkPackageInfo, type AutoConfigLogger, type AutoConfigOptions, type AutoConfigSummary, type AutoConfigTarget, type BuildConfig, type ConfigurationOptions, type ConfigurationResults, Framework, type FrameworkInfo, type PackageJsonScriptsOverrides, buildOperationsSummary, confirmAutoConfigDetails, displayAutoConfigDetails, getDetailsForAutoConfig, isFrameworkSupported, runAutoConfig };