wrangler 0.0.0-e7a0cd5b → 0.0.0-e7cf0caa

package/src/{index.tsx → index.ts}

@@ -9,14 +9,17 @@ import { isBuildFailure } from "./bundle";
 import { loadDotEnv, readConfig } from "./config";
 import { d1 } from "./d1";
 import { deleteHandler, deleteOptions } from "./delete";
-import { deployments } from "./deployments";
+import {
+	deployments,
+	commonDeploymentCMDSetup,
+	rollbackDeployment,
+	viewDeployment,
+} from "./deployments";
 import {
 	buildHandler,
 	buildOptions,
 	configHandler,
 	noOpOptions,
-	generateHandler,
-	generateOptions,
 	previewHandler,
 	previewOptions,
 	route,
@@ -26,10 +29,13 @@ import {
 } from "./deprecated";
 import { devHandler, devOptions } from "./dev";
 import { workerNamespaceCommands } from "./dispatch-namespace";
+import { docsHandler, docsOptions } from "./docs";
+import { generateHandler, generateOptions } from "./generate";
 import { initHandler, initOptions } from "./init";
 import { kvNamespace, kvKey, kvBulk } from "./kv";
 import { logBuildFailure, logger } from "./logger";
 import * as metrics from "./metrics";
+import { mTlsCertificateCommands } from "./mtls-certificate/cli";
 import { pages } from "./pages";
 import { formatMessage, ParseError } from "./parse";
 import { publishOptions, publishHandler } from "./publish";
@@ -40,23 +46,13 @@ import { secret, secretBulkHandler, secretBulkOptions } from "./secret";
 import { tailOptions, tailHandler } from "./tail";
 import { generateTypes } from "./type-generation";
 import { updateCheck } from "./update-check";
-import {
-	listScopes,
-	login,
-	logout,
-	requireAuth,
-	validateScopeKeys,
-} from "./user";
+import { listScopes, login, logout, validateScopeKeys } from "./user";
 import { whoami } from "./whoami";
 
 import type { Config } from "./config";
-import type { PartialConfigToDTS } from "./type-generation";
-import type { CommonYargsOptions } from "./yargs-types";
-import type { ArgumentsCamelCase } from "yargs";
+import type { CommonYargsArgv, CommonYargsOptions } from "./yargs-types";
 import type Yargs from "yargs";
 
-export type ConfigPath = string | undefined;
-
 const resetColor = "\x1b[0m";
 const fgGreenColor = "\x1b[32m";
 export const DEFAULT_LOCAL_PORT = 8787;
@@ -114,7 +110,7 @@ export async function printWranglerBanner() {
 
 export function isLegacyEnv(config: Config): boolean {
 	// We only read from config here, because we've already accounted for
-	// args["legacy-env"] in https://github.com/cloudflare/wrangler2/blob/b24aeb5722370c2e04bce97a84a1fa1e55725d79/packages/wrangler/src/config/validation.ts#L94-L98
+	// args["legacy-env"] in https://github.com/cloudflare/workers-sdk/blob/b24aeb5722370c2e04bce97a84a1fa1e55725d79/packages/wrangler/src/config/validation.ts#L94-L98
 	return config.legacy_env;
 }
 
@@ -136,7 +132,7 @@ export function getScriptName(
 }
 
 /**
- * Alternative to the getScriptName() because special Legacy cases allowed "name", and "env" together in Wrangler1
+ * Alternative to the getScriptName() because special Legacy cases allowed "name", and "env" together in Wrangler v1
  */
 export function getLegacyScriptName(
 	args: { name: string | undefined; env: string | undefined },
@@ -177,7 +173,7 @@ export class CommandLineArgsError extends Error {}
 export function createCLIParser(argv: string[]) {
 	// Type check result against CommonYargsOptions to make sure we've included
 	// all common options
-	const wrangler: Yargs.Argv<CommonYargsOptions> = makeCLI(argv)
+	const wrangler: CommonYargsArgv = makeCLI(argv)
 		.strict()
 		// We handle errors ourselves in a try-catch around `yargs.parse`.
 		// If you want the "help info" to be displayed then throw an instance of `CommandLineArgsError`.
@@ -213,6 +209,11 @@ export function createCLIParser(argv: string[]) {
 			type: "string",
 			requiresArg: true,
 		})
+		.option("experimental-json-config", {
+			alias: "j",
+			describe: `Experimental: Support wrangler.json`,
+			type: "boolean",
+		})
 		.check((args) => {
 			// Grab locally specified env params from `.env` file
 			const loaded = loadDotEnv(".env", args.env);
@@ -222,7 +223,10 @@ export function createCLIParser(argv: string[]) {
 			return true;
 		});
 
-	wrangler.group(["config", "env", "help", "version"], "Flags:");
+	wrangler.group(
+		["experimental-json-config", "config", "env", "help", "version"],
+		"Flags:"
+	);
 	wrangler.help().alias("h", "help");
 
 	// Default help command that supports the subcommands
@@ -265,24 +269,30 @@ export function createCLIParser(argv: string[]) {
 	// I wish we could enforce this pattern, but this comment will have to do for now.
 	// (It's also annoying that choices[] doesn't get inferred as an enum. 🤷‍♂.)
 
-	// [DEPRECATED] generate
+	// docs
 	wrangler.command(
-		// we definitely want to move away from us cloning github templates
-		// we can do something better here, let's see
-		"generate [name] [template]",
-		false,
-		generateOptions,
-		generateHandler
+		"docs [command]",
+		"📚 Open wrangler's docs in your browser",
+		docsOptions,
+		docsHandler
 	);
 
 	// init
 	wrangler.command(
 		"init [name]",
-		"📥 Create a wrangler.toml configuration file",
+		"📥 Initialize a basic Worker project, including a wrangler.toml file",
 		initOptions,
 		initHandler
 	);
 
+	// generate
+	wrangler.command(
+		"generate [name] [template]",
+		"✨ Generate a new Worker project from an existing Worker template. See https://github.com/cloudflare/templates",
+		generateOptions,
+		generateHandler
+	);
+
 	// [DEPRECATED] build
 	wrangler.command("build", false, buildOptions, buildHandler);
 
@@ -398,7 +408,7 @@ export function createCLIParser(argv: string[]) {
 	});
 
 	// queues
-	wrangler.command("queues", "🆀 Configure Workers Queues", (queuesYargs) => {
+	wrangler.command("queues", "🇶 Configure Workers Queues", (queuesYargs) => {
 		return queues(queuesYargs.command(subHelp));
 	});
 
@@ -430,6 +440,15 @@ export function createCLIParser(argv: string[]) {
 		}
 	);
 
+	// mtls-certificate
+	wrangler.command(
+		"mtls-certificate",
+		"🪪 Manage certificates used for mTLS connections",
+		(mtlsYargs) => {
+			return mTlsCertificateCommands(mtlsYargs.command(subHelp));
+		}
+	);
+
 	/**
 	 * User Group: login, logout, and whoami
 	 * TODO: group commands into User group similar to .group() for flags in yargs
@@ -446,6 +465,11 @@ export function createCLIParser(argv: string[]) {
 				.option("scopes-list", {
 					describe: "List all the available OAuth scopes with descriptions",
 				})
+				.option("browser", {
+					default: true,
+					type: "boolean",
+					describe: "Automatically open the OAuth link in a browser",
+				})
 				.option("scopes", {
 					describe: "Pick the set of applicable OAuth scopes when logging in",
 					array: true,
@@ -472,11 +496,11 @@ export function createCLIParser(argv: string[]) {
 						`One of ${args.scopes} is not a valid authentication scope. Run "wrangler login --list-scopes" to see the valid scopes.`
 					);
 				}
-				await login({ scopes: args.scopes });
+				await login({ scopes: args.scopes, browser: args.browser });
 				return;
 			}
-			await login();
-			const config = readConfig(args.config as ConfigPath, args);
+			await login({ browser: args.browser });
+			const config = readConfig(args.config, args);
 			await metrics.sendMetricsEvent("login user", {
 				sendMetrics: config.send_metrics,
 			});
@@ -493,10 +517,10 @@ export function createCLIParser(argv: string[]) {
 		"logout",
 		"🚪 Logout from Cloudflare",
 		() => {},
-		async () => {
+		async (args) => {
 			await printWranglerBanner();
 			await logout();
-			const config = readConfig(undefined, {});
+			const config = readConfig(undefined, args);
 			await metrics.sendMetricsEvent("logout user", {
 				sendMetrics: config.send_metrics,
 			});
@@ -508,10 +532,10 @@ export function createCLIParser(argv: string[]) {
 		"whoami",
 		"🕵️  Retrieve your user info and test your auth config",
 		() => {},
-		async () => {
+		async (args) => {
 			await printWranglerBanner();
 			await whoami();
-			const config = readConfig(undefined, {});
+			const config = readConfig(undefined, args);
 			await metrics.sendMetricsEvent("view accounts", {
 				sendMetrics: config.send_metrics,
 			});
@@ -523,11 +547,11 @@ export function createCLIParser(argv: string[]) {
 		"types",
 		"📝 Generate types from bindings & module rules in config",
 		() => {},
-		async () => {
+		async (args) => {
 			await printWranglerBanner();
-			const config = readConfig(undefined, {});
+			const config = readConfig(undefined, args);
 
-			const configBindings: PartialConfigToDTS = {
+			const configBindings: Partial<Config> = {
 				kv_namespaces: config.kv_namespaces ?? [],
 				vars: { ...config.vars },
 				wasm_modules: config.wasm_modules,
@@ -537,13 +561,14 @@ export function createCLIParser(argv: string[]) {
 				data_blobs: config.data_blobs,
 				durable_objects: config.durable_objects,
 				r2_buckets: config.r2_buckets,
-				// @ts-expect-error - We don't want the type generated to inlcude the Beta prefix
 				d1_databases: config.d1_databases,
 				services: config.services,
+				analytics_engine_datasets: config.analytics_engine_datasets,
 				dispatch_namespaces: config.dispatch_namespaces,
 				logfwdr: config.logfwdr,
-				unsafe: config.unsafe?.bindings,
+				unsafe: config.unsafe,
 				rules: config.rules,
+				queues: config.queues,
 			};
 
 			await generateTypes(configBindings, config);
@@ -552,35 +577,84 @@ export function createCLIParser(argv: string[]) {
 
 	//deployments
 	const deploymentsWarning =
-		"🚧`wrangler deployments` is a beta command. Please report any issues to https://github.com/cloudflare/wrangler2/issues/new/choose";
+		"🚧`wrangler deployments` is a beta command. Please report any issues to https://github.com/cloudflare/workers-sdk/issues/new/choose";
 	wrangler.command(
 		"deployments",
-		false,
-		// "🚢 Logs the 10 most recent deployments with 'Version ID', 'Version number','Author email', 'Created on' and 'Latest deploy'",
-		(yargs) => {
+		"🚢 List and view details for deployments",
+		(yargs) =>
 			yargs
 				.option("name", {
 					describe: "The name of your worker",
 					type: "string",
 				})
-				.epilogue(deploymentsWarning);
-		},
-		async (deploymentsYargs: ArgumentsCamelCase<{ name: string }>) => {
-			await printWranglerBanner();
-			const config = readConfig(
-				deploymentsYargs.config as ConfigPath,
-				deploymentsYargs
-			);
-			const accountId = await requireAuth(config);
-			const scriptName = getScriptName(
-				{ name: deploymentsYargs.name, env: undefined },
-				config
-			);
-
-			logger.log(`${deploymentsWarning}\n`);
-			await deployments(accountId, scriptName);
-		}
+				.command(
+					"list",
+					"🚢 Displays the 10 most recent deployments for a worker",
+					async (listYargs) => listYargs,
+					async (listYargs) => {
+						const { accountId, scriptName, config } =
+							await commonDeploymentCMDSetup(listYargs, deploymentsWarning);
+						await deployments(accountId, scriptName, config);
+					}
+				)
+				.command(
+					"view [deployment-id]",
+					"🔍 View a deployment",
+					async (viewYargs) =>
+						viewYargs.positional("deployment-id", {
+							describe: "The ID of the deployment you want to inspect",
+							type: "string",
+							demandOption: false,
+						}),
+					async (viewYargs) => {
+						const { accountId, scriptName, config } =
+							await commonDeploymentCMDSetup(viewYargs, deploymentsWarning);
+
+						await viewDeployment(
+							accountId,
+							scriptName,
+							config,
+							viewYargs.deploymentId
+						);
+					}
+				)
+				.command(subHelp)
+				.epilogue(deploymentsWarning)
 	);
+	const rollbackWarning =
+		"🚧`wrangler rollback` is a beta command. Please report any issues to https://github.com/cloudflare/workers-sdk/issues/new/choose";
+	wrangler
+		.command(
+			"rollback [deployment-id]",
+			"🔙 Rollback a deployment",
+			(rollbackYargs) =>
+				rollbackYargs
+					.positional("deployment-id", {
+						describe: "The ID of the deployment to rollback to",
+						type: "string",
+						demandOption: false,
+					})
+					.option("message", {
+						alias: "m",
+						describe:
+							"Skip confirmation and message prompts, uses provided argument as message",
+						type: "string",
+						default: undefined,
+					}),
+			async (rollbackYargs) => {
+				const { accountId, scriptName, config } =
+					await commonDeploymentCMDSetup(rollbackYargs, rollbackWarning);
+
+				await rollbackDeployment(
+					accountId,
+					scriptName,
+					config,
+					rollbackYargs.deploymentId,
+					rollbackYargs.message
+				);
+			}
+		)
+		.epilogue(rollbackWarning);
 
 	// This set to false to allow overwrite of default behaviour
 	wrangler.version(false);
@@ -618,7 +692,7 @@ export async function main(argv: string[]): Promise<void> {
 			await createCLIParser([...argv, "--help"]).parse();
 		} else if (e instanceof ParseError) {
 			e.notes.push({
-				text: "\nIf you think this is a bug, please open an issue at: https://github.com/cloudflare/wrangler2/issues/new/choose",
+				text: "\nIf you think this is a bug, please open an issue at: https://github.com/cloudflare/workers-sdk/issues/new/choose",
 			});
 			logger.log(formatMessage(e));
 		} else if (
@@ -654,7 +728,7 @@ export async function main(argv: string[]): Promise<void> {
 			logger.error(e instanceof Error ? e.message : e);
 			logger.log(
 				`${fgGreenColor}%s${resetColor}`,
-				"If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new/choose"
+				"If you think this is a bug then please create an issue at https://github.com/cloudflare/workers-sdk/issues/new/choose"
 			);
 		}
 		throw e;