wrangler 0.0.0-e1b8ac4 → 0.0.0-e1c2f5b9

package/src/dialogs.tsx

@@ -4,132 +4,165 @@ import SelectInput from "ink-select-input";
 import TextInput from "ink-text-input";
 import * as React from "react";
 import { useState } from "react";
+
+import { CI } from "./is-ci";
+import isInteractive from "./is-interactive";
 import { logger } from "./logger";
+
 type ConfirmProps = {
-  text: string;
-  onConfirm: (answer: boolean) => void;
+	text: string;
+	onConfirm: (answer: boolean) => void;
 };
 function Confirm(props: ConfirmProps) {
-  useInput((input: string, key) => {
-    if (input === "y" || key.return === true) {
-      props.onConfirm(true);
-    } else if (input === "n") {
-      props.onConfirm(false);
-    } else {
-      logger.warn("Unrecognised input:", input);
-    }
-  });
-  return (
-    <Box>
-      <Text>
-        {props.text} ({chalk.bold("y")}/n)
-      </Text>
-    </Box>
-  );
+	useInput((input: string, key) => {
+		if (input === "y" || key.return === true) {
+			props.onConfirm(true);
+		} else if (input === "n") {
+			props.onConfirm(false);
+		} else {
+			logger.warn("Unrecognised input:", input);
+		}
+	});
+	return (
+		<Box>
+			<Text>
+				{props.text} ({chalk.bold("y")}/n)
+			</Text>
+		</Box>
+	);
 }
 
-export function confirm(text: string): Promise<boolean> {
-  return new Promise((resolve) => {
-    const { unmount } = render(
-      <Confirm
-        text={text}
-        onConfirm={(answer: boolean) => {
-          unmount();
-          resolve(answer);
-        }}
-      />
-    );
-  });
+export function confirm(
+	text: string,
+	beforeConfirm?: JSX.Element
+): Promise<boolean> {
+	return new Promise((resolve) => {
+		const { unmount } = render(
+			<Box flexDirection="column">
+				{beforeConfirm}
+				<Confirm
+					text={text}
+					onConfirm={(answer: boolean) => {
+						unmount();
+						resolve(answer);
+					}}
+				/>
+			</Box>
+		);
+	});
 }
 
 type PromptProps = {
-  text: string;
-  defaultValue?: string;
-  type?: "text" | "password";
-  onSubmit: (text: string) => void;
+	text: string;
+	defaultValue?: string;
+	type?: "text" | "password";
+	onSubmit: (text: string) => void;
 };
 
 function Prompt(props: PromptProps) {
-  const [value, setValue] = useState(props.defaultValue || "");
-
-  return (
-    <Box>
-      <Text>{props.text} </Text>
-      <Box>
-        <TextInput
-          mask={props.type === "password" ? "*" : undefined}
-          value={value}
-          onChange={setValue}
-          onSubmit={props.onSubmit}
-        />
-      </Box>
-    </Box>
-  );
+	const [value, setValue] = useState(props.defaultValue || "");
+
+	return (
+		<Box>
+			<Text>{props.text} </Text>
+			<Box>
+				<TextInput
+					mask={props.type === "password" ? "*" : undefined}
+					value={value}
+					onChange={setValue}
+					onSubmit={props.onSubmit}
+				/>
+			</Box>
+		</Box>
+	);
 }
 
 export async function prompt(
-  text: string,
-  type: "text" | "password" = "text",
-  defaultValue?: string
+	text: string,
+	type: "text" | "password" = "text",
+	defaultValue?: string
 ): Promise<string> {
-  return new Promise((resolve) => {
-    const { unmount } = render(
-      <Prompt
-        text={text}
-        defaultValue={defaultValue}
-        type={type}
-        onSubmit={(inputText) => {
-          unmount();
-          resolve(inputText);
-        }}
-      />
-    );
-  });
+	return new Promise((resolve) => {
+		const { unmount } = render(
+			<Prompt
+				text={text}
+				defaultValue={defaultValue}
+				type={type}
+				onSubmit={(inputText) => {
+					unmount();
+					resolve(inputText);
+				}}
+			/>
+		);
+	});
 }
 
 type SelectOption = {
-  value: string;
-  label: string;
+	value: string;
+	label: string;
 };
 
 type SelectProps = {
-  text: string;
-  options: SelectOption[];
-  initialIndex: number;
-  onSelect: (value: string) => void;
+	text: string;
+	options: SelectOption[];
+	initialIndex: number;
+	onSelect: (value: string) => void;
 };
 
 function Select(props: SelectProps) {
-  return (
-    <Box flexDirection="column">
-      <Text>{props.text}</Text>
-      <SelectInput
-        initialIndex={props.initialIndex}
-        items={props.options}
-        onSelect={async (selected) => {
-          props.onSelect(selected.value);
-        }}
-      />
-    </Box>
-  );
+	return (
+		<Box flexDirection="column">
+			<Text>{props.text}</Text>
+			<SelectInput
+				initialIndex={props.initialIndex}
+				items={props.options}
+				onSelect={async (selected) => {
+					props.onSelect(selected.value);
+				}}
+			/>
+		</Box>
+	);
 }
 
 export function select(
-  text: string,
-  options: SelectOption[],
-  initialIndex: number
+	text: string,
+	options: SelectOption[],
+	initialIndex: number
 ): Promise<string> {
-  return new Promise((resolve) => {
-    const { unmount } = render(
-      <Select
-        text={text}
-        options={options}
-        initialIndex={initialIndex}
-        onSelect={(option: string) => {
-          unmount();
-          resolve(option);
-        }}
-      />
-    );
-  });
+	return new Promise((resolve) => {
+		const { unmount } = render(
+			<Select
+				text={text}
+				options={options}
+				initialIndex={initialIndex}
+				onSelect={(option: string) => {
+					unmount();
+					resolve(option);
+				}}
+			/>
+		);
+	});
+}
+
+export function logDim(msg: string) {
+	console.log(chalk.gray(msg));
+}
+
+export async function fromDashMessagePrompt(
+	deploySource: "dash" | "wrangler" | "api"
+): Promise<boolean | void> {
+	if (deploySource === "dash") {
+		logger.warn(
+			`You are about to publish a Workers Service that was last published via the Cloudflare Dashboard.\nEdits that have been made via the dashboard will be overridden by your local code and config.`
+		);
+
+		if (!isInteractive() || CI.isCI()) return true;
+
+		return await confirm("Would you like to continue?");
+	}
+}
+export async function tailDOLogPrompt(): Promise<boolean | void> {
+	if (!isInteractive() || CI.isCI()) return true;
+
+	return await confirm("Would you like to continue?");
 }

package/src/dispatch-namespace.ts

@@ -0,0 +1,207 @@
+import { fetchResult } from "./cfetch";
+import { readConfig } from "./config";
+import { logger } from "./logger";
+import * as metrics from "./metrics";
+import { requireAuth } from "./user";
+import { printWranglerBanner } from ".";
+import type { ConfigPath } from ".";
+import type { CommonYargsOptions } from "./yargs-types";
+import type { Argv, CommandModule } from "yargs";
+
+type Namespace = {
+	namespace_id: string;
+	namespace_name: string;
+	created_on: string;
+	created_by: string;
+	modified_on: string;
+	modified_by: string;
+};
+
+// Supporting Workers For Platforms
+// More details at https://blog.cloudflare.com/workers-for-platforms/
+
+/**
+ * Create a dynamic dispatch namespace.
+ */
+async function createWorkerNamespace(accountId: string, name: string) {
+	const namespace = await fetchResult<Namespace>(
+		`/accounts/${accountId}/workers/dispatch/namespaces`,
+		{
+			method: "POST",
+			headers: {
+				"Content-Type": "application/json",
+			},
+			body: JSON.stringify({ name }),
+		}
+	);
+	logger.log(
+		`Created dispatch namespace "${name}" with ID "${namespace.namespace_id}"`
+	);
+}
+
+/**
+ * Delete a dynamic dispatch namespace.
+ */
+async function deleteWorkerNamespace(accountId: string, name: string) {
+	await fetchResult(
+		`/accounts/${accountId}/workers/dispatch/namespaces/${name}`,
+		{ method: "DELETE" }
+	);
+	logger.log(`Deleted dispatch namespace "${name}"`);
+}
+
+/**
+ * List all created dynamic dispatch namespaces for an account
+ */
+async function listWorkerNamespaces(accountId: string) {
+	logger.log(
+		await fetchResult<Namespace>(
+			`/accounts/${accountId}/workers/dispatch/namespaces`,
+			{
+				headers: {
+					"Content-Type": "application/json",
+				},
+			}
+		)
+	);
+}
+
+/**
+ * Get info for a specific dynamic dispatch namespace
+ */
+async function getWorkerNamespaceInfo(accountId: string, name: string) {
+	logger.log(
+		await fetchResult<Namespace>(
+			`/accounts/${accountId}/workers/dispatch/namespaces/${name}`,
+			{
+				headers: {
+					"Content-Type": "application/json",
+				},
+			}
+		)
+	);
+}
+
+/**
+ * Rename a dynamic dispatch namespace
+ */
+async function renameWorkerNamespace(
+	accountId: string,
+	oldName: string,
+	newName: string
+) {
+	void printWranglerBanner();
+
+	await fetchResult(
+		`/accounts/${accountId}/workers/dispatch/namespaces/${oldName}`,
+		{
+			method: "PUT",
+			headers: {
+				"Content-Type": "application/json",
+			},
+			body: JSON.stringify({ name: newName }),
+		}
+	);
+	logger.log(`Renamed dispatch namespace "${oldName}" to "${newName}"`);
+}
+
+export function workerNamespaceCommands(
+	workerNamespaceYargs: Argv<CommonYargsOptions>,
+	subHelp: CommandModule<CommonYargsOptions, CommonYargsOptions>
+) {
+	return workerNamespaceYargs
+		.command(subHelp)
+		.command("list", "List all dispatch namespaces", {}, async (args) => {
+			const config = readConfig(args.config as ConfigPath, args);
+			const accountId = await requireAuth(config);
+			await listWorkerNamespaces(accountId);
+			await metrics.sendMetricsEvent("list dispatch namespaces", {
+				sendMetrics: config.send_metrics,
+			});
+		})
+		.command(
+			"get <name>",
+			"Get information about a dispatch namespace",
+			(yargs) => {
+				return yargs.positional("name", {
+					describe: "Name of the dispatch namespace",
+					type: "string",
+					demandOption: true,
+				});
+			},
+			async (args) => {
+				const config = readConfig(args.config as ConfigPath, args);
+				const accountId = await requireAuth(config);
+				await getWorkerNamespaceInfo(accountId, args.name);
+				await metrics.sendMetricsEvent("view dispatch namespace", {
+					sendMetrics: config.send_metrics,
+				});
+			}
+		)
+		.command(
+			"create <name>",
+			"Create a dispatch namespace",
+			(yargs) => {
+				return yargs.positional("name", {
+					describe: "Name of the dispatch namespace",
+					type: "string",
+					demandOption: true,
+				});
+			},
+			async (args) => {
+				await printWranglerBanner();
+				const config = readConfig(args.config as ConfigPath, args);
+				const accountId = await requireAuth(config);
+				await createWorkerNamespace(accountId, args.name);
+				await metrics.sendMetricsEvent("create dispatch namespace", {
+					sendMetrics: config.send_metrics,
+				});
+			}
+		)
+		.command(
+			"delete <name>",
+			"Delete a dispatch namespace",
+			(yargs) => {
+				return yargs.positional("name", {
+					describe: "Name of the dispatch namespace",
+					type: "string",
+					demandOption: true,
+				});
+			},
+			async (args) => {
+				await printWranglerBanner();
+				const config = readConfig(args.config as ConfigPath, args);
+				const accountId = await requireAuth(config);
+				await deleteWorkerNamespace(accountId, args.name);
+				await metrics.sendMetricsEvent("delete dispatch namespace", {
+					sendMetrics: config.send_metrics,
+				});
+			}
+		)
+		.command(
+			"rename <old-name> <new-name>",
+			"Rename a dispatch namespace",
+			(yargs) => {
+				return yargs
+					.positional("old-name", {
+						describe: "Name of the dispatch namespace",
+						type: "string",
+						demandOption: true,
+					})
+					.positional("new-name", {
+						describe: "New name of the dispatch namespace",
+						type: "string",
+						demandOption: true,
+					});
+			},
+			async (args) => {
+				await printWranglerBanner();
+				const config = readConfig(args.config as ConfigPath, args);
+				const accountId = await requireAuth(config);
+				await renameWorkerNamespace(accountId, args.oldName, args.newName);
+				await metrics.sendMetricsEvent("rename dispatch namespace", {
+					sendMetrics: config.send_metrics,
+				});
+			}
+		);
+}

package/src/docs/index.ts

@@ -0,0 +1,97 @@
+import { printWranglerBanner } from "..";
+import { readConfig } from "../config";
+import { logger } from "../logger";
+import * as metrics from "../metrics";
+import openInBrowser from "../open-in-browser";
+
+import type {
+	CommonYargsOptions,
+	YargsOptionsToInterface,
+} from "../yargs-types";
+import type { ArgumentsCamelCase, Argv } from "yargs";
+
+const argToUrlHash = {
+	docs: "docs",
+	init: "init",
+	generate: "generate",
+	dev: "dev",
+	publish: "publish",
+	delete: "delete",
+	"kv:namespace": "kvnamespace",
+	"kv:key": "kvkey",
+	"kv:bulk": "kvbulk",
+	"r2 bucket": "r2-bucket",
+	"r2 object": "r2-object",
+	secret: "secret",
+	"secret:bulk": "secretbulk",
+	tail: "tail",
+	pages: "pages",
+	login: "login",
+	logout: "logout",
+	whoami: "whoami",
+	types: "types",
+	deployments: "deployments",
+};
+
+export function docsOptions(yargs: Argv<CommonYargsOptions>) {
+	return yargs.positional("command", {
+		describe: "Enter the wrangler command you want to know more about",
+		type: "string",
+		// requiresArg: true,
+		choices: [
+			"docs",
+			"init",
+			"generate",
+			"dev",
+			"publish",
+			"delete",
+			"tail",
+			"secret",
+			"secret:bulk",
+			"kv:namespace",
+			"kv:key",
+			"kv:bulk",
+			"pages",
+			// "queues", //TODO: Undocumented
+			"r2 object",
+			"r2 bucket",
+			// "dispatch-namespace", // TODO: Undocumented - Workers for Platforms
+			// "d1", //TODO: Undocumented
+			// "pubsub", //TODO: Undocumented
+			"login",
+			"logout",
+			"whoami",
+			"types",
+			"deployments",
+			"api",
+		],
+	});
+}
+
+type DocsArgs = YargsOptionsToInterface<typeof docsOptions>;
+
+function isValidParam(k: string): k is keyof typeof argToUrlHash {
+	return k in argToUrlHash;
+}
+
+export async function docsHandler(args: ArgumentsCamelCase<DocsArgs>) {
+	let urlToOpen =
+		"https://developers.cloudflare.com/workers/wrangler/commands/";
+
+	if (args.command === "api") {
+		//if api, take them to the API docs
+		urlToOpen = "https://developers.cloudflare.com/workers/wrangler/api/";
+	} else if (args.command && isValidParam(args.command)) {
+		//otherwise, they get the wrangler commands page
+		urlToOpen += `#${argToUrlHash[args.command]}`;
+	}
+
+	await printWranglerBanner();
+
+	logger.log(`Opening a link in your default browser: ${urlToOpen}`);
+	await openInBrowser(urlToOpen);
+	const config = readConfig(undefined, {});
+	await metrics.sendMetricsEvent("view docs", {
+		sendMetrics: config.send_metrics,
+	});
+}