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

package/src/custom-type-add-field-uid.ts

@@ -0,0 +1,158 @@
+import type { CustomType, UID } 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 = `
+Add a UID (unique identifier) field to an existing custom type.
+
+USAGE
+  prismic custom-type add-field uid <type-id> <field-id> [flags]
+
+ARGUMENTS
+  type-id                Custom type identifier (required)
+  field-id               Field identifier (required)
+
+FLAGS
+  -t, --tab string       Target tab (default: first existing tab, or "Main")
+  -l, --label string     Display label for the field
+  -p, --placeholder string Placeholder text
+  -h, --help             Show help for command
+
+EXAMPLES
+  prismic custom-type add-field uid page uid
+  prismic custom-type add-field uid article slug --label "URL Slug"
+  prismic custom-type add-field uid product sku --placeholder "Enter unique SKU"
+`.trim();
+
+const CustomTypeSchema = v.object({
+	id: v.string(),
+	label: v.string(),
+	repeatable: v.boolean(),
+	status: v.boolean(),
+	format: v.string(),
+	json: v.record(v.string(), v.record(v.string(), v.unknown())),
+});
+
+export async function customTypeAddFieldUid(): Promise<void> {
+	const {
+		values: { help, tab, label, placeholder },
+		positionals: [typeId, fieldId],
+	} = parseArgs({
+		args: process.argv.slice(5), // skip: node, script, "custom-type", "add-field", "uid"
+		options: {
+			tab: { type: "string", short: "t" },
+			label: { type: "string", short: "l" },
+			placeholder: { type: "string", short: "p" },
+			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 add-field uid <type-id> <field-id>");
+		process.exitCode = 1;
+		return;
+	}
+
+	if (!fieldId) {
+		console.error("Missing required argument: field-id\n");
+		console.error("Usage: prismic custom-type add-field uid <type-id> <field-id>");
+		process.exitCode = 1;
+		return;
+	}
+
+	// Find the custom type file
+	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;
+	}
+
+	// Determine target tab
+	const existingTabs = Object.keys(model.json);
+	const targetTab = tab ?? existingTabs[0] ?? "Main";
+
+	// Initialize tab if it doesn't exist
+	if (!model.json[targetTab]) {
+		model.json[targetTab] = {};
+	}
+
+	// Check if field already exists in any tab
+	for (const [tabName, tabFields] of Object.entries(model.json)) {
+		if (tabFields[fieldId]) {
+			console.error(`Field "${fieldId}" already exists in tab "${tabName}"`);
+			process.exitCode = 1;
+			return;
+		}
+	}
+
+	// Build field definition
+	const fieldDefinition: UID = {
+		type: "UID",
+		config: {
+			...(label && { label }),
+			...(placeholder && { placeholder }),
+		},
+	};
+
+	// Add field to model
+	model.json[targetTab][fieldId] = fieldDefinition;
+
+	// 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(
+		`Added field "${fieldId}" (UID) to "${targetTab}" tab in ${typeId}`,
+	);
+}

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

@@ -0,0 +1,111 @@
+import { parseArgs } from "node:util";
+
+import { customTypeAddFieldBoolean } from "./custom-type-add-field-boolean";
+import { customTypeAddFieldColor } from "./custom-type-add-field-color";
+import { customTypeAddFieldDate } from "./custom-type-add-field-date";
+import { customTypeAddFieldEmbed } from "./custom-type-add-field-embed";
+import { customTypeAddFieldGeoPoint } from "./custom-type-add-field-geo-point";
+import { customTypeAddFieldImage } from "./custom-type-add-field-image";
+import { customTypeAddFieldKeyText } from "./custom-type-add-field-key-text";
+import { customTypeAddFieldLink } from "./custom-type-add-field-link";
+import { customTypeAddFieldNumber } from "./custom-type-add-field-number";
+import { customTypeAddFieldRichText } from "./custom-type-add-field-rich-text";
+import { customTypeAddFieldSelect } from "./custom-type-add-field-select";
+import { customTypeAddFieldTimestamp } from "./custom-type-add-field-timestamp";
+import { customTypeAddFieldUid } from "./custom-type-add-field-uid";
+
+const HELP = `
+Add a field to an existing custom type.
+
+USAGE
+  prismic custom-type add-field <field-type> <type-id> <field-id> [flags]
+
+FIELD TYPES
+  boolean                Boolean toggle
+  color                  Color picker
+  date                   Date picker
+  embed                  Embed (oEmbed)
+  geo-point              Geographic coordinates
+  image                  Image
+  key-text               Single-line text
+  link                   Any link type
+  number                 Number
+  rich-text              Rich text editor
+  select                 Dropdown select
+  timestamp              Date and time
+  uid                    Unique identifier
+
+FLAGS
+  -h, --help             Show help for command
+
+LEARN MORE
+  Use \`prismic custom-type add-field <field-type> --help\` for more information.
+
+EXAMPLES
+  prismic custom-type add-field key-text homepage meta_title --tab "SEO"
+  prismic custom-type add-field link homepage button --allow-text
+  prismic custom-type add-field rich-text homepage body --multi "paragraph,heading2,strong,em"
+  prismic custom-type add-field select homepage layout --option "full" --option "sidebar"
+`.trim();
+
+export async function customTypeAddField(): Promise<void> {
+	const {
+		positionals: [fieldType],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "custom-type", "add-field"
+		options: {
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+		strict: false,
+	});
+
+	switch (fieldType) {
+		case "boolean":
+			await customTypeAddFieldBoolean();
+			break;
+		case "color":
+			await customTypeAddFieldColor();
+			break;
+		case "date":
+			await customTypeAddFieldDate();
+			break;
+		case "embed":
+			await customTypeAddFieldEmbed();
+			break;
+		case "geo-point":
+			await customTypeAddFieldGeoPoint();
+			break;
+		case "image":
+			await customTypeAddFieldImage();
+			break;
+		case "key-text":
+			await customTypeAddFieldKeyText();
+			break;
+		case "link":
+			await customTypeAddFieldLink();
+			break;
+		case "number":
+			await customTypeAddFieldNumber();
+			break;
+		case "rich-text":
+			await customTypeAddFieldRichText();
+			break;
+		case "select":
+			await customTypeAddFieldSelect();
+			break;
+		case "timestamp":
+			await customTypeAddFieldTimestamp();
+			break;
+		case "uid":
+			await customTypeAddFieldUid();
+			break;
+		default: {
+			if (fieldType) {
+				console.error(`Unknown field type: ${fieldType}\n`);
+				process.exitCode = 1;
+			}
+			console.info(HELP);
+		}
+	}
+}

package/src/custom-type-connect-slice.ts

@@ -0,0 +1,221 @@
+import type {
+	CustomType,
+	DynamicSlices,
+	SharedSliceRef,
+} 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";
+import { findSliceModel } from "./lib/slice";
+
+const HELP = `
+Connect a shared slice to a custom type's slice zone.
+
+USAGE
+  prismic custom-type connect-slice <type-id> <slice-id> [flags]
+
+ARGUMENTS
+  type-id                Custom type identifier (required)
+  slice-id               Slice identifier (required)
+
+FLAGS
+  -z, --slice-zone string  Target slice zone field ID (default: "slices")
+  -h, --help               Show help for command
+
+EXAMPLES
+  prismic custom-type connect-slice homepage CallToAction
+  prismic custom-type connect-slice homepage CallToAction --slice-zone slices
+  prismic custom-type connect-slice article HeroSection -z body
+`.trim();
+
+const CustomTypeSchema = v.object({
+	id: v.string(),
+	label: v.string(),
+	repeatable: v.boolean(),
+	status: v.boolean(),
+	format: v.string(),
+	json: v.record(v.string(), v.record(v.string(), v.unknown())),
+});
+
+export async function customTypeConnectSlice(): Promise<void> {
+	const {
+		values: { help, "slice-zone": sliceZoneId },
+		positionals: [typeId, sliceId],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "custom-type", "connect-slice"
+		options: {
+			"slice-zone": { type: "string", short: "z" },
+			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 connect-slice <type-id> <slice-id>",
+		);
+		process.exitCode = 1;
+		return;
+	}
+
+	if (!sliceId) {
+		console.error("Missing required argument: slice-id\n");
+		console.error(
+			"Usage: prismic custom-type connect-slice <type-id> <slice-id>",
+		);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Verify the slice exists
+	const sliceResult = await findSliceModel(sliceId);
+	if (!sliceResult.ok) {
+		console.error(sliceResult.error);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Find the custom type file
+	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;
+	}
+
+	const targetSliceZoneId = sliceZoneId ?? "slices";
+
+	// Find existing slice zone or create a new one
+	let sliceZone: DynamicSlices | undefined;
+	let sliceZoneFieldId: string | undefined;
+
+	// Search all tabs for a Slices field matching the target ID
+	for (const [, tabFields] of Object.entries(model.json)) {
+		for (const [fieldId, field] of Object.entries(tabFields)) {
+			if (
+				(field as { type?: string }).type === "Slices" &&
+				fieldId === targetSliceZoneId
+			) {
+				sliceZone = field as DynamicSlices;
+				sliceZoneFieldId = fieldId;
+				break;
+			}
+		}
+		if (sliceZone) break;
+	}
+
+	// Handle slice zone not found
+	if (!sliceZone) {
+		if (sliceZoneId) {
+			// User specified a slice zone that doesn't exist
+			console.error(
+				`Slice zone "${sliceZoneId}" not found in custom type "${typeId}"`,
+			);
+			process.exitCode = 1;
+			return;
+		}
+
+		// Create a new slice zone in the first tab
+		const existingTabs = Object.keys(model.json);
+		const targetTab = existingTabs[0] ?? "Main";
+
+		// Initialize tab if it doesn't exist
+		if (!model.json[targetTab]) {
+			model.json[targetTab] = {};
+		}
+
+		const newSliceZone: DynamicSlices = {
+			type: "Slices",
+			fieldset: "Slice Zone",
+			config: {
+				choices: {},
+			},
+		};
+
+		model.json[targetTab][targetSliceZoneId] = newSliceZone;
+		sliceZone = newSliceZone;
+		sliceZoneFieldId = targetSliceZoneId;
+	}
+
+	// Ensure config and choices exist
+	if (!sliceZone.config) {
+		sliceZone.config = { choices: {} };
+	}
+	if (!sliceZone.config.choices) {
+		sliceZone.config.choices = {};
+	}
+
+	// Check if slice is already connected
+	if (sliceId in sliceZone.config.choices) {
+		console.info(
+			`Slice "${sliceId}" is already connected to slice zone "${sliceZoneFieldId}" in ${typeId}`,
+		);
+		return;
+	}
+
+	// Add the slice reference
+	const sliceRef: SharedSliceRef = { type: "SharedSlice" };
+	sliceZone.config.choices[sliceId] = sliceRef;
+
+	// 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(
+		`Connected slice "${sliceId}" to slice zone "${sliceZoneFieldId}" in ${typeId}`,
+	);
+}

package/src/custom-type-create.ts

@@ -0,0 +1,92 @@
+import type { CustomType } from "@prismicio/types-internal/lib/customtypes";
+
+import { mkdir, writeFile } from "node:fs/promises";
+import { parseArgs } from "node:util";
+
+import { findUpward } from "./lib/file";
+import { stringify } from "./lib/json";
+
+const HELP = `
+Create a new custom type in a Prismic repository.
+
+USAGE
+  prismic custom-type create <id> [flags]
+
+ARGUMENTS
+  id       Custom type identifier (required)
+
+FLAGS
+  -n, --name string   Display name for the custom type
+      --single        Create as a singleton (non-repeatable) type
+  -h, --help          Show help for command
+
+LEARN MORE
+  Use \`prismic custom-type <command> --help\` for more information about a command.
+`.trim();
+
+export async function customTypeCreate(): Promise<void> {
+	const {
+		values: { help, name, single },
+		positionals: [id],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "custom-type", "create"
+		options: {
+			name: { type: "string", short: "n" },
+			single: { type: "boolean" },
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+	});
+
+	if (help) {
+		console.info(HELP);
+		return;
+	}
+
+	if (!id) {
+		console.error("Missing required argument: id");
+		process.exitCode = 1;
+		return;
+	}
+
+	const model = {
+		id,
+		label: name ?? pascalCase(id),
+		repeatable: !single,
+		status: true,
+		format: "custom",
+		json: {
+			Main: {},
+		},
+	} satisfies CustomType;
+
+	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);
+	const typeDirectory = new URL(id + "/", customTypesDirectory);
+	const modelPath = new URL("index.json", typeDirectory);
+
+	try {
+		await mkdir(new URL(".", modelPath), { recursive: true });
+		await writeFile(modelPath, stringify(model));
+	} catch (error) {
+		if (error instanceof Error) {
+			console.error(`Failed to create custom type: ${error.message}`);
+		} else {
+			console.error(`Failed to create custom type`);
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	console.info(`Created custom type at ${modelPath.href}`);
+}
+
+export function pascalCase(input: string): string {
+	return input.toLowerCase().replace(/(^|[-_\s]+)(.)?/g, (_, __, c) => c?.toUpperCase() ?? "");
+}