@angeloashmore/prismic-cli-poc 0.0.0-canary.1d36cd8

package/src/preview-add.ts

@@ -0,0 +1,126 @@
+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";
+
+const HELP = `
+Add a preview configuration to a Prismic repository.
+
+By default, this command reads the repository from prismic.config.json at the
+project root.
+
+USAGE
+  prismic preview add <url> [flags]
+
+ARGUMENTS
+  <url>   Preview URL (e.g. https://example.com/api/preview)
+
+FLAGS
+  -n, --name string   Display name (defaults to hostname)
+  -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 previewAdd(): Promise<void> {
+	const {
+		values: { help, name, repo = await safeGetRepositoryFromConfig() },
+		positionals: [previewUrl],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "preview", "add"
+		options: {
+			name: { type: "string", short: "n" },
+			repo: { type: "string", short: "r" },
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+	});
+
+	if (help) {
+		console.info(HELP);
+		return;
+	}
+
+	if (!previewUrl) {
+		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 parsed = parsePreviewUrl(previewUrl);
+	if (!parsed) {
+		console.error(`Invalid URL: ${previewUrl}`);
+		process.exitCode = 1;
+		return;
+	}
+
+	const displayName = name || parsed.hostname;
+
+	const response = await addPreview(repo, {
+		name: displayName,
+		websiteURL: parsed.websiteURL,
+		resolverPath: parsed.resolverPath,
+	});
+
+	if (!response.ok) {
+		if (response.error instanceof ForbiddenRequestError) {
+			handleUnauthenticated();
+		} else {
+			console.error(`Failed to add preview: ${stringify(response.value)}`);
+			process.exitCode = 1;
+		}
+		return;
+	}
+
+	console.info(`Preview added: ${previewUrl}`);
+}
+
+export function parsePreviewUrl(
+	url: string,
+): { websiteURL: string; resolverPath: string | undefined; hostname: string } | undefined {
+	try {
+		const parsed = new URL(url);
+		const websiteURL = `${parsed.protocol}//${parsed.host}`;
+		const resolverPath = parsed.pathname === "/" ? undefined : parsed.pathname;
+		return { websiteURL, resolverPath, hostname: parsed.hostname };
+	} catch {
+		return undefined;
+	}
+}
+
+async function addPreview(
+	repo: string,
+	config: { name: string; websiteURL: string; resolverPath: string | undefined },
+) {
+	const url = new URL("/previews/new", await getRepoUrl(repo));
+	return await request(url, {
+		method: "POST",
+		body: {
+			name: config.name,
+			websiteURL: config.websiteURL,
+			resolverPath: config.resolverPath,
+		},
+	});
+}
+
+function handleUnauthenticated() {
+	console.error("Not logged in. Run `prismic login` first.");
+	process.exitCode = 1;
+}

package/src/preview-get-simulator.ts

@@ -0,0 +1,104 @@
+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 = `
+Show the slice simulator URL for a Prismic repository.
+
+By default, this command reads the repository from prismic.config.json at the
+project root.
+
+USAGE
+  prismic preview get-simulator [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 previewGetSimulator(): Promise<void> {
+	const {
+		values: { help, repo = await safeGetRepositoryFromConfig(), json },
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "preview", "get-simulator"
+		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 getSimulatorUrl(repo);
+	if (!response.ok) {
+		if (response.error instanceof ForbiddenRequestError) {
+			handleUnauthenticated();
+		} else if (v.isValiError(response.error)) {
+			console.error(
+				`Failed to get simulator URL: Invalid response: ${stringify(response.error.issues)}`,
+			);
+			process.exitCode = 1;
+		} else {
+			console.error(`Failed to get simulator URL: ${stringify(response.value)}`);
+			process.exitCode = 1;
+		}
+		return;
+	}
+
+	const simulatorUrl = response.value.simulator_url;
+	if (!simulatorUrl) {
+		if (json) {
+			console.info(stringify({ simulator_url: null }));
+		} else {
+			console.info("No simulator URL configured.");
+		}
+		return;
+	}
+
+	if (json) {
+		console.info(stringify({ simulator_url: simulatorUrl }));
+	} else {
+		console.info(simulatorUrl);
+	}
+}
+
+const RepositoryResponseSchema = v.object({
+	simulator_url: v.optional(v.string()),
+});
+type RepositoryResponse = v.InferOutput<typeof RepositoryResponseSchema>;
+
+async function getSimulatorUrl(repo: string): Promise<ParsedRequestResponse<RepositoryResponse>> {
+	const url = new URL("/core/repository", await getRepoUrl(repo));
+	return await request(url, { schema: RepositoryResponseSchema });
+}
+
+function handleUnauthenticated() {
+	console.error("Not logged in. Run `prismic login` first.");
+	process.exitCode = 1;
+}

package/src/preview-list.ts

@@ -0,0 +1,106 @@
+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 = `
+List all preview configurations in a Prismic repository.
+
+By default, this command reads the repository from prismic.config.json at the
+project root.
+
+USAGE
+  prismic preview 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 previewList(): Promise<void> {
+	const {
+		values: { help, repo = await safeGetRepositoryFromConfig(), json },
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "preview", "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 getPreviews(repo);
+	if (!response.ok) {
+		if (response.error instanceof ForbiddenRequestError) {
+			handleUnauthenticated();
+		} else if (v.isValiError(response.error)) {
+			console.error(
+				`Failed to list previews: Invalid response: ${stringify(response.error.issues)}`,
+			);
+			process.exitCode = 1;
+		} else {
+			console.error(`Failed to list previews: ${stringify(response.value)}`);
+			process.exitCode = 1;
+		}
+		return;
+	}
+
+	const previews = response.value.results;
+	if (json) {
+		console.info(stringify(previews));
+	} else {
+		for (const preview of previews) {
+			console.info(`${preview.url}  ${preview.label}`);
+		}
+	}
+}
+
+const PreviewSchema = v.object({
+	id: v.string(),
+	label: v.string(),
+	url: v.string(),
+});
+export type Preview = v.InferOutput<typeof PreviewSchema>;
+
+const GetPreviewsResponseSchema = v.object({
+	results: v.array(PreviewSchema),
+});
+type GetPreviewsResponse = v.InferOutput<typeof GetPreviewsResponseSchema>;
+
+export async function getPreviews(
+	repo: string,
+): Promise<ParsedRequestResponse<GetPreviewsResponse>> {
+	const url = new URL("/core/repository/preview_configs", await getRepoUrl(repo));
+	return await request(url, { schema: GetPreviewsResponseSchema });
+}
+
+function handleUnauthenticated() {
+	console.error("Not logged in. Run `prismic login` first.");
+	process.exitCode = 1;
+}

package/src/preview-remove-simulator.ts

@@ -0,0 +1,80 @@
+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";
+
+const HELP = `
+Remove the slice simulator URL from a Prismic repository.
+
+By default, this command reads the repository from prismic.config.json at the
+project root.
+
+USAGE
+  prismic preview remove-simulator [flags]
+
+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 previewRemoveSimulator(): Promise<void> {
+	const {
+		values: { help, repo = await safeGetRepositoryFromConfig() },
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "preview", "remove-simulator"
+		options: {
+			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 removeSimulatorUrl(repo);
+	if (!response.ok) {
+		if (response.error instanceof ForbiddenRequestError) {
+			handleUnauthenticated();
+		} else {
+			console.error(`Failed to remove simulator URL: ${stringify(response.value)}`);
+			process.exitCode = 1;
+		}
+		return;
+	}
+
+	console.info("Simulator URL removed.");
+}
+
+async function removeSimulatorUrl(repo: string) {
+	const url = new URL("/core/repository", await getRepoUrl(repo));
+	return await request(url, {
+		method: "PATCH",
+		body: { simulator_url: "" },
+	});
+}
+
+function handleUnauthenticated() {
+	console.error("Not logged in. Run `prismic login` first.");
+	process.exitCode = 1;
+}

package/src/preview-remove.ts

@@ -0,0 +1,109 @@
+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 { getPreviews } from "./preview-list";
+
+const HELP = `
+Remove a preview configuration from a Prismic repository.
+
+By default, this command reads the repository from prismic.config.json at the
+project root.
+
+USAGE
+  prismic preview remove <url> [flags]
+
+ARGUMENTS
+  <url>   Preview URL to remove
+
+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 previewRemove(): Promise<void> {
+	const {
+		values: { help, repo = await safeGetRepositoryFromConfig() },
+		positionals: [previewUrl],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "preview", "remove"
+		options: {
+			repo: { type: "string", short: "r" },
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+	});
+
+	if (help) {
+		console.info(HELP);
+		return;
+	}
+
+	if (!previewUrl) {
+		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 previewsResponse = await getPreviews(repo);
+	if (!previewsResponse.ok) {
+		if (previewsResponse.error instanceof ForbiddenRequestError) {
+			handleUnauthenticated();
+		} else {
+			console.error(`Failed to fetch previews: ${stringify(previewsResponse.value)}`);
+			process.exitCode = 1;
+		}
+		return;
+	}
+
+	const preview = previewsResponse.value.results.find((p) => p.url === previewUrl);
+	if (!preview) {
+		console.error(`Preview not found: ${previewUrl}`);
+		process.exitCode = 1;
+		return;
+	}
+
+	const response = await removePreview(repo, preview.id);
+	if (!response.ok) {
+		if (response.error instanceof ForbiddenRequestError) {
+			handleUnauthenticated();
+		} else {
+			console.error(`Failed to remove preview: ${stringify(response.value)}`);
+			process.exitCode = 1;
+		}
+		return;
+	}
+
+	console.info(`Preview removed: ${previewUrl}`);
+}
+
+async function removePreview(repo: string, id: string) {
+	const url = new URL(`/previews/delete/${id}`, await getRepoUrl(repo));
+	return await request(url, {
+		method: "POST",
+		body: {},
+	});
+}
+
+function handleUnauthenticated() {
+	console.error("Not logged in. Run `prismic login` first.");
+	process.exitCode = 1;
+}

package/src/preview-set-name.ts

@@ -0,0 +1,137 @@
+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 { parsePreviewUrl } from "./preview-add";
+import { getPreviews } from "./preview-list";
+
+const HELP = `
+Update the name of a preview configuration.
+
+By default, this command reads the repository from prismic.config.json at the
+project root.
+
+USAGE
+  prismic preview set-name <url> <name> [flags]
+
+ARGUMENTS
+  <url>    Preview URL to update
+  <name>   New display 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 previewSetName(): Promise<void> {
+	const {
+		values: { help, repo = await safeGetRepositoryFromConfig() },
+		positionals: [previewUrl, name],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "preview", "set-name"
+		options: {
+			repo: { type: "string", short: "r" },
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+	});
+
+	if (help) {
+		console.info(HELP);
+		return;
+	}
+
+	if (!previewUrl) {
+		console.error("Missing required argument: <url>");
+		process.exitCode = 1;
+		return;
+	}
+
+	if (!name) {
+		console.error("Missing required argument: <name>");
+		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 parsed = parsePreviewUrl(previewUrl);
+	if (!parsed) {
+		console.error(`Invalid URL: ${previewUrl}`);
+		process.exitCode = 1;
+		return;
+	}
+
+	const previewsResponse = await getPreviews(repo);
+	if (!previewsResponse.ok) {
+		if (previewsResponse.error instanceof ForbiddenRequestError) {
+			handleUnauthenticated();
+		} else {
+			console.error(`Failed to fetch previews: ${stringify(previewsResponse.value)}`);
+			process.exitCode = 1;
+		}
+		return;
+	}
+
+	const preview = previewsResponse.value.results.find((p) => p.url === previewUrl);
+	if (!preview) {
+		console.error(`Preview not found: ${previewUrl}`);
+		process.exitCode = 1;
+		return;
+	}
+
+	const response = await updatePreview(repo, preview.id, {
+		name,
+		websiteURL: parsed.websiteURL,
+		resolverPath: parsed.resolverPath,
+	});
+
+	if (!response.ok) {
+		if (response.error instanceof ForbiddenRequestError) {
+			handleUnauthenticated();
+		} else {
+			console.error(`Failed to update preview: ${stringify(response.value)}`);
+			process.exitCode = 1;
+		}
+		return;
+	}
+
+	console.info(`Preview updated: ${previewUrl}`);
+}
+
+async function updatePreview(
+	repo: string,
+	id: string,
+	config: { name: string; websiteURL: string; resolverPath: string | undefined },
+) {
+	const url = new URL(`/previews/save/${id}`, await getRepoUrl(repo));
+	return await request(url, {
+		method: "POST",
+		body: {
+			name: config.name,
+			websiteURL: config.websiteURL,
+			resolverPath: config.resolverPath,
+		},
+	});
+}
+
+function handleUnauthenticated() {
+	console.error("Not logged in. Run `prismic login` first.");
+	process.exitCode = 1;
+}