@angeloashmore/prismic-cli-poc 0.0.0-canary.2ff9563

package/src/webhook-enable.ts

@@ -0,0 +1,132 @@
+import { parseArgs } from "node:util";
+
+import type { RequestResponse } from "./lib/request";
+
+import { isAuthenticated } from "./lib/auth";
+import { safeGetRepositoryFromConfig } from "./lib/config";
+import { stringify } from "./lib/json";
+import { ForbiddenRequestError, request } from "./lib/request";
+import { getRepoUrl } from "./lib/url";
+import { getWebhooks, type Webhook } from "./webhook-view";
+
+const HELP = `
+Enable a webhook in a Prismic repository.
+
+By default, this command reads the repository from prismic.config.json at the
+project root.
+
+USAGE
+  prismic webhook enable <url> [flags]
+
+ARGUMENTS
+  <url>   Webhook URL
+
+FLAGS
+  -r, --repo string   Repository domain
+  -h, --help          Show help for command
+
+LEARN MORE
+  Use \`prismic <command> <subcommand> --help\` for more information about a command.
+`.trim();
+
+export async function webhookEnable(): Promise<void> {
+	const {
+		values: { help, repo = await safeGetRepositoryFromConfig() },
+		positionals: [webhookUrl],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "webhook", "enable"
+		options: {
+			repo: { type: "string", short: "r" },
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+	});
+
+	if (help) {
+		console.info(HELP);
+		return;
+	}
+
+	if (!webhookUrl) {
+		console.error("Missing required argument: <url>");
+		process.exitCode = 1;
+		return;
+	}
+
+	if (!repo) {
+		console.error("Missing prismic.config.json or --repo option");
+		process.exitCode = 1;
+		return;
+	}
+
+	const authenticated = await isAuthenticated();
+	if (!authenticated) {
+		handleUnauthenticated();
+		return;
+	}
+
+	const webhooksResponse = await getWebhooks(repo);
+	if (!webhooksResponse.ok) {
+		if (webhooksResponse.error instanceof ForbiddenRequestError) {
+			handleUnauthenticated();
+		} else {
+			console.error(`Failed to enable webhook: ${stringify(webhooksResponse.value)}`);
+			process.exitCode = 1;
+		}
+		return;
+	}
+
+	const webhook = webhooksResponse.value.find((w) => w.config.url === webhookUrl);
+	if (!webhook) {
+		console.error(`Webhook not found: ${webhookUrl}`);
+		process.exitCode = 1;
+		return;
+	}
+
+	if (webhook.config.active) {
+		console.info(`Webhook already enabled: ${webhookUrl}`);
+		return;
+	}
+
+	const updatedConfig = structuredClone(webhook.config);
+	updatedConfig.active = true;
+
+	const response = await updateWebhook(repo, webhook.config._id, updatedConfig);
+	if (!response.ok) {
+		if (response.error instanceof ForbiddenRequestError) {
+			handleUnauthenticated();
+		} else {
+			console.error(`Failed to enable webhook: ${stringify(response.value)}`);
+			process.exitCode = 1;
+		}
+		return;
+	}
+
+	console.info(`Webhook enabled: ${webhookUrl}`);
+}
+
+export async function updateWebhook(
+	repo: string,
+	webhookId: string,
+	config: Omit<Webhook["config"], "_id">,
+): Promise<RequestResponse<unknown>> {
+	const url = new URL(`/app/settings/webhooks/${webhookId}`, await getRepoUrl(repo));
+	const body = new FormData();
+	body.set("url", config.url);
+	body.set("name", config.name ?? "");
+	body.set("secret", config.secret ?? "");
+	body.set("headers", JSON.stringify(config.headers ?? {}));
+	body.set("active", config.active ? "on" : "off");
+	body.set("documentsPublished", config.documentsUnpublished.toString());
+	body.set("documentsUnpublished", config.documentsUnpublished.toString());
+	body.set("releasesCreated", config.documentsUnpublished.toString());
+	body.set("releasesUpdated", config.documentsUnpublished.toString());
+	body.set("tagsCreated", config.documentsUnpublished.toString());
+	body.set("documentsPublished", config.documentsUnpublished.toString());
+	return await request(url, { method: "POST", body });
+}
+
+function handleUnauthenticated() {
+	console.error("Not logged in. Run `prismic login` first.");
+	process.exitCode = 1;
+}

package/src/webhook-list.ts

@@ -0,0 +1,93 @@
+import { parseArgs } from "node:util";
+import * as v from "valibot";
+
+import { isAuthenticated } from "./lib/auth";
+import { safeGetRepositoryFromConfig } from "./lib/config";
+import { stringify } from "./lib/json";
+import { ForbiddenRequestError } from "./lib/request";
+import { getWebhooks } from "./webhook-view";
+
+const HELP = `
+List all webhooks in a Prismic repository.
+
+By default, this command reads the repository from prismic.config.json at the
+project root.
+
+USAGE
+  prismic webhook list [flags]
+
+FLAGS
+      --json          Output as JSON
+  -r, --repo string   Repository domain
+  -h, --help          Show help for command
+
+LEARN MORE
+  Use \`prismic <command> <subcommand> --help\` for more information about a command.
+`.trim();
+
+export async function webhookList(): Promise<void> {
+	const {
+		values: { help, repo = await safeGetRepositoryFromConfig(), json },
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "webhook", "list"
+		options: {
+			json: { type: "boolean" },
+			repo: { type: "string", short: "r" },
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: false,
+	});
+
+	if (help) {
+		console.info(HELP);
+		return;
+	}
+
+	if (!repo) {
+		console.error("Missing prismic.config.json or --repo option");
+		process.exitCode = 1;
+		return;
+	}
+
+	const authenticated = await isAuthenticated();
+	if (!authenticated) {
+		handleUnauthenticated();
+		return;
+	}
+
+	const response = await getWebhooks(repo);
+	if (!response.ok) {
+		if (response.error instanceof ForbiddenRequestError) {
+			handleUnauthenticated();
+		} else if (v.isValiError(response.error)) {
+			console.error(
+				`Failed to list webhooks: Invalid response: ${stringify(response.error.issues)}`,
+			);
+			process.exitCode = 1;
+		} else {
+			console.error(`Failed to list webhooks: ${stringify(response.value)}`);
+			process.exitCode = 1;
+		}
+		return;
+	}
+
+	const webhooks = response.value;
+	if (json) {
+		console.info(stringify(webhooks.map((w) => w.config)));
+	} else {
+		if (webhooks.length === 0) {
+			console.info("No webhooks configured.");
+			return;
+		}
+		for (const webhook of webhooks) {
+			const status = webhook.config.active ? "enabled" : "disabled";
+			const name = webhook.config.name ? ` (${webhook.config.name})` : "";
+			console.info(`${webhook.config.url}${name}  [${status}]`);
+		}
+	}
+}
+
+function handleUnauthenticated() {
+	console.error("Not logged in. Run `prismic login` first.");
+	process.exitCode = 1;
+}

package/src/webhook-remove-header.ts

@@ -0,0 +1,117 @@
+import { parseArgs } from "node:util";
+
+import { isAuthenticated } from "./lib/auth";
+import { safeGetRepositoryFromConfig } from "./lib/config";
+import { stringify } from "./lib/json";
+import { ForbiddenRequestError } from "./lib/request";
+import { updateWebhook } from "./webhook-enable";
+import { getWebhooks } from "./webhook-view";
+
+const HELP = `
+Remove a custom HTTP header from a webhook.
+
+By default, this command reads the repository from prismic.config.json at the
+project root.
+
+USAGE
+  prismic webhook remove-header <url> <key> [flags]
+
+ARGUMENTS
+  <url>   Webhook URL
+  <key>   Header name
+
+FLAGS
+  -r, --repo string   Repository domain
+  -h, --help          Show help for command
+
+LEARN MORE
+  Use \`prismic <command> <subcommand> --help\` for more information about a command.
+`.trim();
+
+export async function webhookRemoveHeader(): Promise<void> {
+	const {
+		values: { help, repo = await safeGetRepositoryFromConfig() },
+		positionals: [webhookUrl, headerKey],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "webhook", "remove-header"
+		options: {
+			repo: { type: "string", short: "r" },
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+	});
+
+	if (help) {
+		console.info(HELP);
+		return;
+	}
+
+	if (!webhookUrl) {
+		console.error("Missing required argument: <url>");
+		process.exitCode = 1;
+		return;
+	}
+
+	if (!headerKey) {
+		console.error("Missing required argument: <key>");
+		process.exitCode = 1;
+		return;
+	}
+
+	if (!repo) {
+		console.error("Missing prismic.config.json or --repo option");
+		process.exitCode = 1;
+		return;
+	}
+
+	const authenticated = await isAuthenticated();
+	if (!authenticated) {
+		handleUnauthenticated();
+		return;
+	}
+
+	const webhooksResponse = await getWebhooks(repo);
+	if (!webhooksResponse.ok) {
+		if (webhooksResponse.error instanceof ForbiddenRequestError) {
+			handleUnauthenticated();
+		} else {
+			console.error(`Failed to remove header: ${stringify(webhooksResponse.value)}`);
+			process.exitCode = 1;
+		}
+		return;
+	}
+
+	const webhook = webhooksResponse.value.find((w) => w.config.url === webhookUrl);
+	if (!webhook) {
+		console.error(`Webhook not found: ${webhookUrl}`);
+		process.exitCode = 1;
+		return;
+	}
+
+	if (!(headerKey in webhook.config.headers)) {
+		console.error(`Header not found: ${headerKey}`);
+		process.exitCode = 1;
+		return;
+	}
+
+	const updatedConfig = structuredClone(webhook.config);
+	delete updatedConfig.headers[headerKey];
+
+	const response = await updateWebhook(repo, webhook.config._id, updatedConfig);
+	if (!response.ok) {
+		if (response.error instanceof ForbiddenRequestError) {
+			handleUnauthenticated();
+		} else {
+			console.error(`Failed to remove header: ${stringify(response.value)}`);
+			process.exitCode = 1;
+		}
+		return;
+	}
+
+	console.info(`Header removed: ${headerKey}`);
+}
+
+function handleUnauthenticated() {
+	console.error("Not logged in. Run `prismic login` first.");
+	process.exitCode = 1;
+}

package/src/webhook-remove.ts

@@ -0,0 +1,106 @@
+import { parseArgs } from "node:util";
+
+import { isAuthenticated } from "./lib/auth";
+import { safeGetRepositoryFromConfig } from "./lib/config";
+import { stringify } from "./lib/json";
+import { ForbiddenRequestError, request } from "./lib/request";
+import { getRepoUrl } from "./lib/url";
+import { getWebhooks } from "./webhook-view";
+
+const HELP = `
+Delete a webhook from a Prismic repository.
+
+By default, this command reads the repository from prismic.config.json at the
+project root.
+
+USAGE
+  prismic webhook remove <url> [flags]
+
+ARGUMENTS
+  <url>   Webhook URL
+
+FLAGS
+  -r, --repo string   Repository domain
+  -h, --help          Show help for command
+
+LEARN MORE
+  Use \`prismic <command> <subcommand> --help\` for more information about a command.
+`.trim();
+
+export async function webhookRemove(): Promise<void> {
+	const {
+		values: { help, repo = await safeGetRepositoryFromConfig() },
+		positionals: [webhookUrl],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "webhook", "remove"
+		options: {
+			repo: { type: "string", short: "r" },
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+	});
+
+	if (help) {
+		console.info(HELP);
+		return;
+	}
+
+	if (!webhookUrl) {
+		console.error("Missing required argument: <url>");
+		process.exitCode = 1;
+		return;
+	}
+
+	if (!repo) {
+		console.error("Missing prismic.config.json or --repo option");
+		process.exitCode = 1;
+		return;
+	}
+
+	const authenticated = await isAuthenticated();
+	if (!authenticated) {
+		handleUnauthenticated();
+		return;
+	}
+
+	const webhooksResponse = await getWebhooks(repo);
+	if (!webhooksResponse.ok) {
+		if (webhooksResponse.error instanceof ForbiddenRequestError) {
+			handleUnauthenticated();
+		} else {
+			console.error(`Failed to remove webhook: ${stringify(webhooksResponse.value)}`);
+			process.exitCode = 1;
+		}
+		return;
+	}
+
+	const webhook = webhooksResponse.value.find((w) => w.config.url === webhookUrl);
+	if (!webhook) {
+		console.error(`Webhook not found: ${webhookUrl}`);
+		process.exitCode = 1;
+		return;
+	}
+
+	const response = await deleteWebhook(repo, webhook.config._id);
+	if (!response.ok) {
+		if (response.error instanceof ForbiddenRequestError) {
+			handleUnauthenticated();
+		} else {
+			console.error(`Failed to remove webhook: ${stringify(response.value)}`);
+			process.exitCode = 1;
+		}
+		return;
+	}
+
+	console.info(`Webhook removed: ${webhookUrl}`);
+}
+
+async function deleteWebhook(repo: string, webhookId: string) {
+	const url = new URL(`/app/settings/webhooks/${webhookId}/delete`, await getRepoUrl(repo));
+	return await request(url, { method: "POST" });
+}
+
+function handleUnauthenticated() {
+	console.error("Not logged in. Run `prismic login` first.");
+	process.exitCode = 1;
+}

package/src/webhook-set-triggers.ts

@@ -0,0 +1,148 @@
+import { parseArgs } from "node:util";
+
+import { isAuthenticated } from "./lib/auth";
+import { safeGetRepositoryFromConfig } from "./lib/config";
+import { stringify } from "./lib/json";
+import { ForbiddenRequestError } from "./lib/request";
+import { updateWebhook } from "./webhook-enable";
+import { getWebhooks, TRIGGER_DISPLAY } from "./webhook-view";
+
+const HELP = `
+Update which events trigger a webhook.
+
+By default, this command reads the repository from prismic.config.json at the
+project root.
+
+USAGE
+  prismic webhook set-triggers <url> [flags]
+
+ARGUMENTS
+  <url>   Webhook URL
+
+FLAGS
+  -t, --trigger string   Trigger events (can be repeated, at least one required)
+  -r, --repo string      Repository domain
+  -h, --help             Show help for command
+
+TRIGGERS
+  document.published    When documents are published
+  document.unpublished  When documents are unpublished
+  release.created       When a release is created
+  release.updated       When a release is edited or deleted
+  tag.created           When a tag is created
+  tag.deleted           When a tag is deleted
+
+LEARN MORE
+  Use \`prismic <command> <subcommand> --help\` for more information about a command.
+`.trim();
+
+const VALID_TRIGGERS = Object.values(TRIGGER_DISPLAY);
+
+export async function webhookSetTriggers(): Promise<void> {
+	const {
+		values: { help, repo = await safeGetRepositoryFromConfig(), trigger },
+		positionals: [webhookUrl],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "webhook", "set-triggers"
+		options: {
+			trigger: { type: "string", multiple: true, short: "t" },
+			repo: { type: "string", short: "r" },
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+	});
+
+	if (help) {
+		console.info(HELP);
+		return;
+	}
+
+	if (!webhookUrl) {
+		console.error("Missing required argument: <url>");
+		process.exitCode = 1;
+		return;
+	}
+
+	if (!repo) {
+		console.error("Missing prismic.config.json or --repo option");
+		process.exitCode = 1;
+		return;
+	}
+
+	if (!trigger || trigger.length === 0) {
+		console.error("Missing required option: --trigger");
+		process.exitCode = 1;
+		return;
+	}
+
+	// Validate triggers
+	for (const t of trigger) {
+		if (!VALID_TRIGGERS.includes(t)) {
+			console.error(`Invalid trigger: ${t}`);
+			console.error(`Valid triggers: ${VALID_TRIGGERS.join(", ")}`);
+			process.exitCode = 1;
+			return;
+		}
+	}
+
+	const authenticated = await isAuthenticated();
+	if (!authenticated) {
+		handleUnauthenticated();
+		return;
+	}
+
+	const webhooksResponse = await getWebhooks(repo);
+	if (!webhooksResponse.ok) {
+		if (webhooksResponse.error instanceof ForbiddenRequestError) {
+			handleUnauthenticated();
+		} else {
+			console.error(`Failed to update webhook triggers: ${stringify(webhooksResponse.value)}`);
+			process.exitCode = 1;
+		}
+		return;
+	}
+
+	const webhook = webhooksResponse.value.find((w) => w.config.url === webhookUrl);
+	if (!webhook) {
+		console.error(`Webhook not found: ${webhookUrl}`);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Build trigger settings: all false, then enable specified ones
+	const defaultValue = trigger.length > 0 ? false : true;
+	const triggers: Record<keyof typeof TRIGGER_DISPLAY, boolean> = {
+		documentsPublished: defaultValue,
+		documentsUnpublished: defaultValue,
+		releasesCreated: defaultValue,
+		releasesUpdated: defaultValue,
+		tagsCreated: defaultValue,
+		tagsDeleted: defaultValue,
+	};
+	for (const t of trigger) {
+		const [apiField] = Object.entries(TRIGGER_DISPLAY).find(([, display]) => t === display) ?? [];
+		if (!apiField) continue;
+		triggers[apiField as keyof typeof TRIGGER_DISPLAY] = true;
+	}
+
+	const response = await updateWebhook(repo, webhook.config._id, {
+		...webhook.config,
+		...triggers,
+	});
+	if (!response.ok) {
+		if (response.error instanceof ForbiddenRequestError) {
+			handleUnauthenticated();
+		} else {
+			console.error(`Failed to update webhook triggers: ${stringify(response.value)}`);
+			process.exitCode = 1;
+		}
+		return;
+	}
+
+	console.info(`Webhook triggers updated: ${trigger.join(", ")}`);
+}
+
+function handleUnauthenticated() {
+	console.error("Not logged in. Run `prismic login` first.");
+	process.exitCode = 1;
+}

package/src/webhook-status.ts

@@ -0,0 +1,90 @@
+import { parseArgs } from "node:util";
+
+import { isAuthenticated } from "./lib/auth";
+import { safeGetRepositoryFromConfig } from "./lib/config";
+import { stringify } from "./lib/json";
+import { ForbiddenRequestError } from "./lib/request";
+import { getWebhooks } from "./webhook-view";
+
+const HELP = `
+Show the enabled/disabled status of a webhook.
+
+By default, this command reads the repository from prismic.config.json at the
+project root.
+
+USAGE
+  prismic webhook status <url> [flags]
+
+ARGUMENTS
+  <url>   Webhook URL
+
+FLAGS
+  -r, --repo string   Repository domain
+  -h, --help          Show help for command
+
+LEARN MORE
+  Use \`prismic <command> <subcommand> --help\` for more information about a command.
+`.trim();
+
+export async function webhookStatus(): Promise<void> {
+	const {
+		values: { help, repo = await safeGetRepositoryFromConfig() },
+		positionals: [webhookUrl],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "webhook", "status"
+		options: {
+			repo: { type: "string", short: "r" },
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+	});
+
+	if (help) {
+		console.info(HELP);
+		return;
+	}
+
+	if (!webhookUrl) {
+		console.error("Missing required argument: <url>");
+		process.exitCode = 1;
+		return;
+	}
+
+	if (!repo) {
+		console.error("Missing prismic.config.json or --repo option");
+		process.exitCode = 1;
+		return;
+	}
+
+	const authenticated = await isAuthenticated();
+	if (!authenticated) {
+		handleUnauthenticated();
+		return;
+	}
+
+	const response = await getWebhooks(repo);
+	if (!response.ok) {
+		if (response.error instanceof ForbiddenRequestError) {
+			handleUnauthenticated();
+		} else {
+			console.error(`Failed to get webhook status: ${stringify(response.value)}`);
+			process.exitCode = 1;
+		}
+		return;
+	}
+
+	const webhook = response.value.find((w) => w.config.url === webhookUrl);
+	if (!webhook) {
+		console.error(`Webhook not found: ${webhookUrl}`);
+		process.exitCode = 1;
+		return;
+	}
+
+	const status = webhook.config.active ? "enabled" : "disabled";
+	console.info(status);
+}
+
+function handleUnauthenticated() {
+	console.error("Not logged in. Run `prismic login` first.");
+	process.exitCode = 1;
+}