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

package/src/page-type-set-name.ts

@@ -0,0 +1,128 @@
+import type { CustomType } from "@prismicio/types-internal/lib/customtypes";
+
+import { readFile, writeFile } from "node:fs/promises";
+import { parseArgs } from "node:util";
+import * as v from "valibot";
+
+import { findUpward } from "./lib/file";
+import { stringify } from "./lib/json";
+
+const HELP = `
+Change a page type's display name (label).
+
+USAGE
+  prismic page-type set-name <type-id> <new-name> [flags]
+
+ARGUMENTS
+  type-id      Page type identifier (required)
+  new-name     New display name (required)
+
+FLAGS
+  -h, --help   Show help for command
+
+EXAMPLES
+  prismic page-type set-name homepage "Home Page"
+  prismic page-type set-name blog_post "Blog Post"
+`.trim();
+
+const CustomTypeSchema = v.object({
+	id: v.string(),
+	label: v.string(),
+	repeatable: v.boolean(),
+	status: v.boolean(),
+	format: v.optional(v.string()),
+	json: v.record(v.string(), v.record(v.string(), v.unknown())),
+});
+
+export async function pageTypeSetName(): Promise<void> {
+	const {
+		values: { help },
+		positionals: [typeId, newName],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "page-type", "set-name"
+		options: {
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+	});
+
+	if (help) {
+		console.info(HELP);
+		return;
+	}
+
+	if (!typeId) {
+		console.error("Missing required argument: type-id\n");
+		console.error("Usage: prismic page-type set-name <type-id> <new-name>");
+		process.exitCode = 1;
+		return;
+	}
+
+	if (!newName) {
+		console.error("Missing required argument: new-name\n");
+		console.error("Usage: prismic page-type set-name <type-id> <new-name>");
+		process.exitCode = 1;
+		return;
+	}
+
+	const projectRoot = await findUpward("package.json");
+	if (!projectRoot) {
+		console.error("Could not find project root (no package.json found)");
+		process.exitCode = 1;
+		return;
+	}
+
+	const modelPath = new URL(`customtypes/${typeId}/index.json`, projectRoot);
+
+	// Read and parse the model
+	let model: CustomType;
+	try {
+		const contents = await readFile(modelPath, "utf8");
+		const result = v.safeParse(CustomTypeSchema, JSON.parse(contents));
+		if (!result.success) {
+			console.error(`Invalid page type model: ${modelPath.href}`);
+			process.exitCode = 1;
+			return;
+		}
+		model = result.output as CustomType;
+	} catch (error) {
+		if (error instanceof Error && "code" in error && error.code === "ENOENT") {
+			console.error(`Page type not found: ${typeId}\n`);
+			console.error(`Create it first with: prismic page-type create ${typeId}`);
+			process.exitCode = 1;
+			return;
+		}
+		if (error instanceof Error) {
+			console.error(`Failed to read page type: ${error.message}`);
+		} else {
+			console.error("Failed to read page type");
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	// Check if this is actually a page type
+	if (model.format !== "page") {
+		console.error(`"${typeId}" is not a page type (format: ${model.format ?? "custom"})`);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Update the model
+	model.label = newName;
+
+	// Write updated model
+	try {
+		await writeFile(modelPath, stringify(model));
+	} catch (error) {
+		if (error instanceof Error) {
+			console.error(`Failed to update page type: ${error.message}`);
+		} else {
+			console.error("Failed to update page type");
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	console.info(`Renamed page type "${typeId}" to "${newName}"`);
+}

package/src/page-type-set-repeatable.ts

@@ -0,0 +1,137 @@
+import type { CustomType } from "@prismicio/types-internal/lib/customtypes";
+
+import { readFile, writeFile } from "node:fs/promises";
+import { parseArgs } from "node:util";
+import * as v from "valibot";
+
+import { findUpward } from "./lib/file";
+import { stringify } from "./lib/json";
+
+const HELP = `
+Set whether a page type is repeatable.
+
+USAGE
+  prismic page-type set-repeatable <type-id> <true|false> [flags]
+
+ARGUMENTS
+  type-id       Page type identifier (required)
+  true|false    Repeatable value (required)
+
+FLAGS
+  -h, --help   Show help for command
+
+EXAMPLES
+  prismic page-type set-repeatable homepage true
+  prismic page-type set-repeatable settings false
+`.trim();
+
+const CustomTypeSchema = v.object({
+	id: v.string(),
+	label: v.string(),
+	repeatable: v.boolean(),
+	status: v.boolean(),
+	format: v.optional(v.string()),
+	json: v.record(v.string(), v.record(v.string(), v.unknown())),
+});
+
+export async function pageTypeSetRepeatable(): Promise<void> {
+	const {
+		values: { help },
+		positionals: [typeId, repeatableValue],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "page-type", "set-repeatable"
+		options: {
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+	});
+
+	if (help) {
+		console.info(HELP);
+		return;
+	}
+
+	if (!typeId) {
+		console.error("Missing required argument: type-id\n");
+		console.error("Usage: prismic page-type set-repeatable <type-id> <true|false>");
+		process.exitCode = 1;
+		return;
+	}
+
+	if (!repeatableValue) {
+		console.error("Missing required argument: true|false\n");
+		console.error("Usage: prismic page-type set-repeatable <type-id> <true|false>");
+		process.exitCode = 1;
+		return;
+	}
+
+	if (repeatableValue !== "true" && repeatableValue !== "false") {
+		console.error(`Invalid value: "${repeatableValue}". Must be "true" or "false".`);
+		process.exitCode = 1;
+		return;
+	}
+
+	const repeatable = repeatableValue === "true";
+
+	const projectRoot = await findUpward("package.json");
+	if (!projectRoot) {
+		console.error("Could not find project root (no package.json found)");
+		process.exitCode = 1;
+		return;
+	}
+
+	const modelPath = new URL(`customtypes/${typeId}/index.json`, projectRoot);
+
+	// Read and parse the model
+	let model: CustomType;
+	try {
+		const contents = await readFile(modelPath, "utf8");
+		const result = v.safeParse(CustomTypeSchema, JSON.parse(contents));
+		if (!result.success) {
+			console.error(`Invalid page type model: ${modelPath.href}`);
+			process.exitCode = 1;
+			return;
+		}
+		model = result.output as CustomType;
+	} catch (error) {
+		if (error instanceof Error && "code" in error && error.code === "ENOENT") {
+			console.error(`Page type not found: ${typeId}\n`);
+			console.error(`Create it first with: prismic page-type create ${typeId}`);
+			process.exitCode = 1;
+			return;
+		}
+		if (error instanceof Error) {
+			console.error(`Failed to read page type: ${error.message}`);
+		} else {
+			console.error("Failed to read page type");
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	// Check if this is actually a page type
+	if (model.format !== "page") {
+		console.error(`"${typeId}" is not a page type (format: ${model.format ?? "custom"})`);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Update the model
+	model.repeatable = repeatable;
+
+	// Write updated model
+	try {
+		await writeFile(modelPath, stringify(model));
+	} catch (error) {
+		if (error instanceof Error) {
+			console.error(`Failed to update page type: ${error.message}`);
+		} else {
+			console.error("Failed to update page type");
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	const typeLabel = repeatable ? "repeatable" : "singleton";
+	console.info(`Set page type "${typeId}" to ${typeLabel}`);
+}

package/src/page-type-view.ts

@@ -0,0 +1,118 @@
+import type { CustomType } from "@prismicio/types-internal/lib/customtypes";
+
+import { readFile } from "node:fs/promises";
+import { parseArgs } from "node:util";
+import * as v from "valibot";
+
+import { findUpward } from "./lib/file";
+
+const HELP = `
+View details of a specific page type.
+
+USAGE
+  prismic page-type view <type-id> [flags]
+
+ARGUMENTS
+  type-id      Page type identifier (required)
+
+FLAGS
+  --json       Output as JSON
+  -h, --help   Show help for command
+
+EXAMPLES
+  prismic page-type view homepage
+  prismic page-type view homepage --json
+`.trim();
+
+const CustomTypeSchema = v.object({
+	id: v.string(),
+	label: v.string(),
+	repeatable: v.boolean(),
+	status: v.boolean(),
+	format: v.optional(v.string()),
+	json: v.record(v.string(), v.record(v.string(), v.unknown())),
+});
+
+export async function pageTypeView(): Promise<void> {
+	const {
+		values: { help, json },
+		positionals: [typeId],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "page-type", "view"
+		options: {
+			json: { type: "boolean" },
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+	});
+
+	if (help) {
+		console.info(HELP);
+		return;
+	}
+
+	if (!typeId) {
+		console.error("Missing required argument: type-id\n");
+		console.error("Usage: prismic page-type view <type-id>");
+		process.exitCode = 1;
+		return;
+	}
+
+	const projectRoot = await findUpward("package.json");
+	if (!projectRoot) {
+		console.error("Could not find project root (no package.json found)");
+		process.exitCode = 1;
+		return;
+	}
+
+	const modelPath = new URL(`customtypes/${typeId}/index.json`, projectRoot);
+
+	let model: CustomType;
+	try {
+		const contents = await readFile(modelPath, "utf8");
+		const result = v.safeParse(CustomTypeSchema, JSON.parse(contents));
+		if (!result.success) {
+			console.error(`Invalid page type model: ${modelPath.href}`);
+			process.exitCode = 1;
+			return;
+		}
+		model = result.output as CustomType;
+	} catch (error) {
+		if (error instanceof Error && "code" in error && error.code === "ENOENT") {
+			console.error(`Page type not found: ${typeId}\n`);
+			console.error(`Create it first with: prismic page-type create ${typeId}`);
+			process.exitCode = 1;
+			return;
+		}
+		if (error instanceof Error) {
+			console.error(`Failed to read page type: ${error.message}`);
+		} else {
+			console.error("Failed to read page type");
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	// Check if this is actually a page type
+	if (model.format !== "page") {
+		console.error(`"${typeId}" is not a page type (format: ${model.format ?? "custom"})`);
+		process.exitCode = 1;
+		return;
+	}
+
+	if (json) {
+		console.info(JSON.stringify(model, null, 2));
+		return;
+	}
+
+	console.info(`ID:         ${model.id}`);
+	console.info(`Label:      ${model.label}`);
+	console.info(`Repeatable: ${model.repeatable}`);
+
+	const tabs = Object.entries(model.json);
+	console.info(`\nTabs (${tabs.length}):`);
+	for (const [tabName, tabFields] of tabs) {
+		const fieldCount = Object.keys(tabFields).length;
+		console.info(`  - ${tabName}: ${fieldCount} fields`);
+	}
+}

package/src/page-type.ts

@@ -0,0 +1,90 @@
+import { parseArgs } from "node:util";
+
+import { pageTypeAddField } from "./page-type-add-field";
+import { pageTypeConnectSlice } from "./page-type-connect-slice";
+import { pageTypeCreate } from "./page-type-create";
+import { pageTypeDisconnectSlice } from "./page-type-disconnect-slice";
+import { pageTypeList } from "./page-type-list";
+import { pageTypeRemove } from "./page-type-remove";
+import { pageTypeRemoveField } from "./page-type-remove-field";
+import { pageTypeSetName } from "./page-type-set-name";
+import { pageTypeSetRepeatable } from "./page-type-set-repeatable";
+import { pageTypeView } from "./page-type-view";
+
+const HELP = `
+Manage page types in a Prismic repository.
+
+USAGE
+  prismic page-type <command> [flags]
+
+COMMANDS
+  create            Create a new page type
+  list              List all page types
+  view              View details of a page type
+  remove            Remove a page type
+  set-name          Change a page type's display name
+  set-repeatable    Set whether a page type is repeatable
+  add-field         Add a field to a page type
+  remove-field      Remove a field from a page type
+  connect-slice     Connect a shared slice to a page type
+  disconnect-slice  Disconnect a shared slice from a page type
+
+FLAGS
+  -h, --help   Show help for command
+
+LEARN MORE
+  Use \`prismic page-type <command> --help\` for more information about a command.
+`.trim();
+
+export async function pageType(): Promise<void> {
+	const {
+		positionals: [subcommand],
+	} = parseArgs({
+		args: process.argv.slice(3), // skip: node, script, "page-type"
+		options: {
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+		strict: false,
+	});
+
+	switch (subcommand) {
+		case "create":
+			await pageTypeCreate();
+			break;
+		case "list":
+			await pageTypeList();
+			break;
+		case "view":
+			await pageTypeView();
+			break;
+		case "remove":
+			await pageTypeRemove();
+			break;
+		case "set-name":
+			await pageTypeSetName();
+			break;
+		case "set-repeatable":
+			await pageTypeSetRepeatable();
+			break;
+		case "add-field":
+			await pageTypeAddField();
+			break;
+		case "remove-field":
+			await pageTypeRemoveField();
+			break;
+		case "connect-slice":
+			await pageTypeConnectSlice();
+			break;
+		case "disconnect-slice":
+			await pageTypeDisconnectSlice();
+			break;
+		default: {
+			if (subcommand) {
+				console.error(`Unknown page-type subcommand: ${subcommand}\n`);
+				process.exitCode = 1;
+			}
+			console.info(HELP);
+		}
+	}
+}

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-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;
+}