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

package/src/webhook-test.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 = `
+Trigger a test webhook in a Prismic repository.
+
+By default, this command reads the repository from prismic.config.json at the
+project root.
+
+USAGE
+  prismic webhook test <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 webhookTest(): Promise<void> {
+	const {
+		values: { help, repo = await safeGetRepositoryFromConfig() },
+		positionals: [webhookUrl],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "webhook", "test"
+		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 test 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 triggerWebhook(repo, webhook.config._id);
+	if (!response.ok) {
+		if (response.error instanceof ForbiddenRequestError) {
+			handleUnauthenticated();
+		} else {
+			console.error(`Failed to test webhook: ${stringify(response.value)}`);
+			process.exitCode = 1;
+		}
+		return;
+	}
+
+	console.info(`Test webhook triggered: ${webhookUrl}`);
+}
+
+async function triggerWebhook(repo: string, webhookId: string) {
+	const url = new URL(`/app/settings/webhooks/${webhookId}/trigger`, 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-view.ts

@@ -0,0 +1,147 @@
+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, type ParsedRequestResponse, request } from "./lib/request";
+import { getRepoUrl } from "./lib/url";
+
+const HELP = `
+View details of a webhook in a Prismic repository.
+
+By default, this command reads the repository from prismic.config.json at the
+project root.
+
+USAGE
+  prismic webhook view <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 const TRIGGER_DISPLAY = {
+	documentsPublished: "document.published",
+	documentsUnpublished: "document.unpublished",
+	releasesCreated: "release.created",
+	releasesUpdated: "release.updated",
+	tagsCreated: "tag.created",
+	tagsDeleted: "tag.deleted",
+};
+
+export async function webhookView(): Promise<void> {
+	const {
+		values: { help, repo = await safeGetRepositoryFromConfig() },
+		positionals: [webhookUrl],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "webhook", "view"
+		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 view webhook: ${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 { config } = webhook;
+
+	console.info(`URL:     ${config.url}`);
+	console.info(`Name:    ${config.name || "(none)"}`);
+	console.info(`Status:  ${config.active ? "enabled" : "disabled"}`);
+	console.info(`Secret:  ${config.secret ? "(set)" : "(none)"}`);
+
+	// Show triggers
+	const enabledTriggers: string[] = [];
+	for (const [apiField, displayName] of Object.entries(TRIGGER_DISPLAY)) {
+		if (config[apiField as keyof typeof config]) {
+			enabledTriggers.push(displayName);
+		}
+	}
+	console.info(`Triggers: ${enabledTriggers.length > 0 ? enabledTriggers.join(", ") : "(none)"}`);
+
+	// Show headers
+	const headerKeys = Object.keys(config.headers);
+	if (headerKeys.length > 0) {
+		console.info("Headers:");
+		for (const [key, value] of Object.entries(config.headers)) {
+			console.info(`  ${key}: ${value}`);
+		}
+	} else {
+		console.info("Headers: (none)");
+	}
+}
+
+function handleUnauthenticated() {
+	console.error("Not logged in. Run `prismic login` first.");
+	process.exitCode = 1;
+}
+
+const WebhookSchema = v.object({
+	config: v.object({
+		_id: v.string(),
+		url: v.string(),
+		active: v.boolean(),
+		name: v.nullable(v.string()),
+		secret: v.nullable(v.string()),
+		headers: v.record(v.string(), v.string()),
+		documentsPublished: v.boolean(),
+		documentsUnpublished: v.boolean(),
+		releasesCreated: v.boolean(),
+		releasesUpdated: v.boolean(),
+		tagsCreated: v.boolean(),
+		tagsDeleted: v.boolean(),
+	}),
+});
+export type Webhook = v.InferOutput<typeof WebhookSchema>;
+
+export async function getWebhooks(repo: string): Promise<ParsedRequestResponse<Webhook[]>> {
+	const url = new URL("/app/settings/webhooks", await getRepoUrl(repo));
+	return await request(url, { schema: v.array(WebhookSchema) });
+}

package/src/webhook.ts

@@ -0,0 +1,95 @@
+import { parseArgs } from "node:util";
+
+import { webhookAddHeader } from "./webhook-add-header";
+import { webhookCreate } from "./webhook-create";
+import { webhookDisable } from "./webhook-disable";
+import { webhookEnable } from "./webhook-enable";
+import { webhookList } from "./webhook-list";
+import { webhookRemove } from "./webhook-remove";
+import { webhookRemoveHeader } from "./webhook-remove-header";
+import { webhookSetTriggers } from "./webhook-set-triggers";
+import { webhookStatus } from "./webhook-status";
+import { webhookTest } from "./webhook-test";
+import { webhookView } from "./webhook-view";
+
+const HELP = `
+Manage webhooks in a Prismic repository.
+
+USAGE
+  prismic webhook <command> [flags]
+
+COMMANDS
+  list           List all webhooks
+  create         Create a new webhook
+  view           View webhook details
+  remove         Delete a webhook
+  test           Trigger a test webhook
+  enable         Enable a webhook
+  disable        Disable a webhook
+  status         Show webhook enabled/disabled status
+  add-header     Add a custom HTTP header
+  remove-header  Remove a custom HTTP header
+  set-triggers   Update webhook triggers
+
+FLAGS
+  -h, --help     Show help for command
+
+LEARN MORE
+  Use \`prismic webhook <command> --help\` for more information about a command.
+`.trim();
+
+export async function webhook(): Promise<void> {
+	const {
+		positionals: [subcommand],
+	} = parseArgs({
+		args: process.argv.slice(3), // skip: node, script, "webhook"
+		options: {
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+		strict: false,
+	});
+
+	switch (subcommand) {
+		case "list":
+			await webhookList();
+			break;
+		case "create":
+			await webhookCreate();
+			break;
+		case "view":
+			await webhookView();
+			break;
+		case "remove":
+			await webhookRemove();
+			break;
+		case "test":
+			await webhookTest();
+			break;
+		case "enable":
+			await webhookEnable();
+			break;
+		case "disable":
+			await webhookDisable();
+			break;
+		case "status":
+			await webhookStatus();
+			break;
+		case "add-header":
+			await webhookAddHeader();
+			break;
+		case "remove-header":
+			await webhookRemoveHeader();
+			break;
+		case "set-triggers":
+			await webhookSetTriggers();
+			break;
+		default: {
+			if (subcommand) {
+				console.error(`Unknown webhook subcommand: ${subcommand}\n`);
+				process.exitCode = 1;
+			}
+			console.info(HELP);
+		}
+	}
+}

package/src/whoami.ts

@@ -0,0 +1,62 @@
+import { parseArgs } from "node:util";
+import * as v from "valibot";
+
+import { isAuthenticated } from "./lib/auth";
+import { ForbiddenRequestError, request } from "./lib/request";
+import { getUserServiceUrl } from "./lib/url";
+
+const HELP = `
+Show the currently logged in user.
+
+USAGE
+  prismic whoami [flags]
+
+FLAGS
+  -h, --help   Show help for command
+
+LEARN MORE
+  Use \`prismic <command> --help\` for more information about a command.
+`.trim();
+
+export async function whoami(): Promise<void> {
+	const {
+		values: { help },
+	} = parseArgs({
+		args: process.argv.slice(3),
+		options: { help: { type: "boolean", short: "h" } },
+	});
+
+	if (help) {
+		console.info(HELP);
+		return;
+	}
+
+	const authenticated = await isAuthenticated();
+	if (!authenticated) {
+		handleUnauthenticated();
+		return;
+	}
+
+	const response = await getProfile();
+	if (!response.ok) {
+		if (response.error instanceof ForbiddenRequestError) {
+			handleUnauthenticated();
+		} else {
+			console.error("Failed to fetch user profile.");
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	console.info(response.value.email);
+}
+
+async function getProfile() {
+	const url = new URL("profile", await getUserServiceUrl());
+	return await request(url, { schema: v.object({ email: v.string() }) });
+}
+
+function handleUnauthenticated() {
+	console.error("Not logged in. Run `prismic login` first.");
+	process.exitCode = 1;
+}