@angeloashmore/prismic-cli-poc 0.0.0-canary.1143872

package/src/custom-type-list.ts

@@ -0,0 +1,110 @@
+import { readdir, readFile } from "node:fs/promises";
+import { parseArgs } from "node:util";
+import * as v from "valibot";
+
+import { findUpward } from "./lib/file";
+
+const HELP = `
+List all custom types in a Prismic project.
+
+USAGE
+  prismic custom-type list [flags]
+
+FLAGS
+  --json       Output as JSON
+  -h, --help   Show help for command
+
+EXAMPLES
+  prismic custom-type list
+  prismic custom-type list --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 customTypeList(): Promise<void> {
+	const {
+		values: { help, json },
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "custom-type", "list"
+		options: {
+			json: { type: "boolean" },
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+	});
+
+	if (help) {
+		console.info(HELP);
+		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 customTypesDirectory = new URL("customtypes/", projectRoot);
+
+	let entries: string[];
+	try {
+		entries = (await readdir(customTypesDirectory, {
+			withFileTypes: false,
+		})) as unknown as string[];
+	} catch {
+		if (json) {
+			console.info(JSON.stringify([]));
+		} else {
+			console.info("No custom types found.");
+		}
+		return;
+	}
+
+	const customTypes: { id: string; label: string; repeatable: boolean }[] = [];
+
+	for (const entry of entries) {
+		const modelPath = new URL(`${entry}/index.json`, customTypesDirectory);
+		try {
+			const contents = await readFile(modelPath, "utf8");
+			const parsed = JSON.parse(contents);
+			const result = v.safeParse(CustomTypeSchema, parsed);
+			// Custom types have format !== "page" (either "custom" or undefined)
+			if (result.success && result.output.format !== "page") {
+				customTypes.push({
+					id: result.output.id,
+					label: result.output.label,
+					repeatable: result.output.repeatable,
+				});
+			}
+		} catch {
+			// Skip directories without valid index.json
+		}
+	}
+
+	if (customTypes.length === 0) {
+		if (json) {
+			console.info(JSON.stringify([]));
+		} else {
+			console.info("No custom types found.");
+		}
+		return;
+	}
+
+	if (json) {
+		console.info(JSON.stringify(customTypes, null, 2));
+	} else {
+		console.info("ID\tLABEL\tTYPE");
+		for (const customType of customTypes) {
+			const typeLabel = customType.repeatable ? "repeatable" : "singleton";
+			console.info(`${customType.id}\t${customType.label}\t${typeLabel}`);
+		}
+	}
+}

package/src/custom-type-remove-field.ts

@@ -0,0 +1,171 @@
+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 { buildTypes } from "./codegen-types";
+import { findUpward } from "./lib/file";
+import { stringify } from "./lib/json";
+
+const HELP = `
+Remove a field from a custom type.
+
+USAGE
+  prismic custom-type remove-field <type-id> <field-id> [flags]
+
+ARGUMENTS
+  type-id      Custom type identifier (required)
+  field-id     Field identifier (required)
+
+FLAGS
+  --tab string  Specific tab (searches all tabs if not specified)
+      --types string   Output file for generated types (default: "prismicio-types.d.ts")
+  -h, --help    Show help for command
+
+EXAMPLES
+  prismic custom-type remove-field settings title
+  prismic custom-type remove-field settings description --tab "Content"
+`.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 customTypeRemoveField(): Promise<void> {
+	const {
+		values: { help, tab, types },
+		positionals: [typeId, fieldId],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "custom-type", "remove-field"
+		options: {
+			tab: { type: "string" },
+			types: { type: "string" },
+			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 custom-type remove-field <type-id> <field-id>");
+		process.exitCode = 1;
+		return;
+	}
+
+	if (!fieldId) {
+		console.error("Missing required argument: field-id\n");
+		console.error("Usage: prismic custom-type remove-field <type-id> <field-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);
+
+	// 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 custom 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(`Custom type not found: ${typeId}\n`);
+			console.error(`Create it first with: prismic custom-type create ${typeId}`);
+			process.exitCode = 1;
+			return;
+		}
+		if (error instanceof Error) {
+			console.error(`Failed to read custom type: ${error.message}`);
+		} else {
+			console.error("Failed to read custom type");
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	// Check if this is actually a custom type (not a page type)
+	if (model.format === "page") {
+		console.error(`"${typeId}" is not a custom type (format: page)`);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Find and remove the field
+	let foundTab: string | undefined;
+
+	if (tab) {
+		// Look in specific tab
+		if (!model.json[tab]) {
+			console.error(`Tab "${tab}" not found in custom type "${typeId}"`);
+			console.error(`Available tabs: ${Object.keys(model.json).join(", ")}`);
+			process.exitCode = 1;
+			return;
+		}
+		if (!(fieldId in model.json[tab])) {
+			console.error(`Field "${fieldId}" not found in tab "${tab}"`);
+			process.exitCode = 1;
+			return;
+		}
+		delete model.json[tab][fieldId];
+		foundTab = tab;
+	} else {
+		// Search all tabs
+		for (const [tabName, tabFields] of Object.entries(model.json)) {
+			if (fieldId in tabFields) {
+				delete tabFields[fieldId];
+				foundTab = tabName;
+				break;
+			}
+		}
+		if (!foundTab) {
+			console.error(`Field "${fieldId}" not found in any tab of custom type "${typeId}"`);
+			process.exitCode = 1;
+			return;
+		}
+	}
+
+	// Write updated model
+	try {
+		await writeFile(modelPath, stringify(model));
+	} catch (error) {
+		if (error instanceof Error) {
+			console.error(`Failed to update custom type: ${error.message}`);
+		} else {
+			console.error("Failed to update custom type");
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	console.info(`Removed field "${fieldId}" from tab "${foundTab}" in custom type "${typeId}"`);
+
+	try {
+		await buildTypes({ output: types });
+		console.info(`Updated types in ${types ?? "prismicio-types.d.ts"}`);
+	} catch (error) {
+		console.warn(`Could not generate types: ${error instanceof Error ? error.message : error}`);
+	}
+}

package/src/custom-type-remove.ts

@@ -0,0 +1,138 @@
+import type { CustomType } from "@prismicio/types-internal/lib/customtypes";
+
+import { readFile, rm } from "node:fs/promises";
+import { parseArgs } from "node:util";
+import * as v from "valibot";
+
+import { buildTypes } from "./codegen-types";
+import { findUpward } from "./lib/file";
+
+const HELP = `
+Remove a custom type from the project.
+
+USAGE
+  prismic custom-type remove <type-id> [flags]
+
+ARGUMENTS
+  type-id      Custom type identifier (required)
+
+FLAGS
+  -y           Confirm removal
+      --types string   Output file for generated types (default: "prismicio-types.d.ts")
+  -h, --help   Show help for command
+
+EXAMPLES
+  prismic custom-type remove settings
+  prismic custom-type remove settings -y
+`.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 customTypeRemove(): Promise<void> {
+	const {
+		values: { help, y, types },
+		positionals: [typeId],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "custom-type", "remove"
+		options: {
+			y: { type: "boolean", short: "y" },
+			types: { type: "string" },
+			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 custom-type remove <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 typeDirectory = new URL(`customtypes/${typeId}/`, projectRoot);
+	const modelPath = new URL("index.json", typeDirectory);
+
+	// Verify the custom type exists and is actually a custom type
+	let model: CustomType;
+	try {
+		const contents = await readFile(modelPath, "utf8");
+		const result = v.safeParse(CustomTypeSchema, JSON.parse(contents));
+		if (!result.success) {
+			console.error(`Invalid custom 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(`Custom type not found: ${typeId}`);
+			process.exitCode = 1;
+			return;
+		}
+		if (error instanceof Error) {
+			console.error(`Failed to read custom type: ${error.message}`);
+		} else {
+			console.error("Failed to read custom type");
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	// Check if this is actually a custom type (not a page type)
+	if (model.format === "page") {
+		console.error(`"${typeId}" is not a custom type (format: page)`);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Require -y flag to confirm deletion
+	if (!y) {
+		console.error(
+			`Refusing to remove custom type "${typeId}" (this will delete the entire directory).`,
+		);
+		console.error("Re-run with -y to confirm.");
+		process.exitCode = 1;
+		return;
+	}
+
+	// Delete the custom type directory
+	try {
+		await rm(typeDirectory, { recursive: true });
+	} catch (error) {
+		if (error instanceof Error) {
+			console.error(`Failed to remove custom type: ${error.message}`);
+		} else {
+			console.error("Failed to remove custom type");
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	console.info(`Removed custom type "${typeId}"`);
+
+	try {
+		await buildTypes({ output: types });
+		console.info(`Updated types in ${types ?? "prismicio-types.d.ts"}`);
+	} catch (error) {
+		console.warn(`Could not generate types: ${error instanceof Error ? error.message : error}`);
+	}
+}

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

@@ -0,0 +1,138 @@
+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 { buildTypes } from "./codegen-types";
+import { findUpward } from "./lib/file";
+import { stringify } from "./lib/json";
+
+const HELP = `
+Change a custom type's display name (label).
+
+USAGE
+  prismic custom-type set-name <type-id> <new-name> [flags]
+
+ARGUMENTS
+  type-id      Custom type identifier (required)
+  new-name     New display name (required)
+
+FLAGS
+      --types string   Output file for generated types (default: "prismicio-types.d.ts")
+  -h, --help   Show help for command
+
+EXAMPLES
+  prismic custom-type set-name settings "Site Settings"
+  prismic custom-type set-name menu "Navigation Menu"
+`.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 customTypeSetName(): Promise<void> {
+	const {
+		values: { help, types },
+		positionals: [typeId, newName],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "custom-type", "set-name"
+		options: {
+			types: { type: "string" },
+			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 custom-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 custom-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 custom 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(`Custom type not found: ${typeId}\n`);
+			console.error(`Create it first with: prismic custom-type create ${typeId}`);
+			process.exitCode = 1;
+			return;
+		}
+		if (error instanceof Error) {
+			console.error(`Failed to read custom type: ${error.message}`);
+		} else {
+			console.error("Failed to read custom type");
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	// Check if this is actually a custom type (not a page type)
+	if (model.format === "page") {
+		console.error(`"${typeId}" is not a custom type (format: page)`);
+		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 custom type: ${error.message}`);
+		} else {
+			console.error("Failed to update custom type");
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	console.info(`Renamed custom type "${typeId}" to "${newName}"`);
+
+	try {
+		await buildTypes({ output: types });
+		console.info(`Updated types in ${types ?? "prismicio-types.d.ts"}`);
+	} catch (error) {
+		console.warn(`Could not generate types: ${error instanceof Error ? error.message : error}`);
+	}
+}

package/src/custom-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 custom type.
+
+USAGE
+  prismic custom-type view <type-id> [flags]
+
+ARGUMENTS
+  type-id      Custom type identifier (required)
+
+FLAGS
+  --json       Output as JSON
+  -h, --help   Show help for command
+
+EXAMPLES
+  prismic custom-type view settings
+  prismic custom-type view settings --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 customTypeView(): Promise<void> {
+	const {
+		values: { help, json },
+		positionals: [typeId],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "custom-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 custom-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 custom 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(`Custom type not found: ${typeId}\n`);
+			console.error(`Create it first with: prismic custom-type create ${typeId}`);
+			process.exitCode = 1;
+			return;
+		}
+		if (error instanceof Error) {
+			console.error(`Failed to read custom type: ${error.message}`);
+		} else {
+			console.error("Failed to read custom type");
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	// Check if this is actually a custom type (not a page type)
+	if (model.format === "page") {
+		console.error(`"${typeId}" is not a custom type (format: page)`);
+		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`);
+	}
+}