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

package/package.json

@@ -0,0 +1,53 @@
+{
+	"name": "@angeloashmore/prismic-cli-poc",
+	"version": "0.0.0-canary.1143872",
+	"description": "A proof-of-concept developer CLI for Prismic.",
+	"keywords": [
+		"prismic",
+		"typescript"
+	],
+	"license": "Apache-2.0",
+	"author": "Prismic <contact@prismic.io> (https://prismic.io)",
+	"repository": {
+		"type": "git",
+		"url": "ssh://git@github.com/prismicio-community/prismic-cli-poc.git"
+	},
+	"bin": {
+		"prismic": "./dist/index.mjs"
+	},
+	"files": [
+		"./dist",
+		"./src"
+	],
+	"type": "module",
+	"publishConfig": {
+		"access": "public"
+	},
+	"scripts": {
+		"build": "tsdown",
+		"dev": "tsdown --watch",
+		"format": "oxfmt",
+		"prepare": "npm run build",
+		"lint": "oxlint --deny-warnings",
+		"types": "tsc --noEmit",
+		"unit": "vitest run --coverage",
+		"unit:watch": "vitest watch",
+		"test": "npm run lint && npm run types && npm run unit && npm run build"
+	},
+	"devDependencies": {
+		"@prismicio/e2e-tests-utils": "1.15.0",
+		"@prismicio/types-internal": "3.16.1",
+		"@types/node": "25.0.9",
+		"@vitest/coverage-v8": "4.0.17",
+		"oxfmt": "^0.24.0",
+		"oxlint": "1.39.0",
+		"prismic-ts-codegen": "^0.1.28",
+		"tsdown": "0.19.0",
+		"typescript": "5.9.3",
+		"valibot": "^1.2.0",
+		"vitest": "4.0.17"
+	},
+	"engines": {
+		"node": ">=24"
+	}
+}

package/src/codegen-types.ts

@@ -0,0 +1,82 @@
+import type { CustomTypeModel, SharedSliceModel } from "@prismicio/client";
+
+import { writeFile } from "node:fs/promises";
+import { parseArgs } from "node:util";
+import { generateTypes, NON_EDITABLE_FILE_HEADER } from "prismic-ts-codegen";
+
+import { readLocalCustomTypes, readLocalSlices } from "./lib/custom-types-api";
+
+const HELP = `
+Generate TypeScript types from local custom type and slice models.
+
+USAGE
+  prismic codegen types [flags]
+
+FLAGS
+  -o, --output string   Output file path (default: "prismicio-types.d.ts")
+  -h, --help            Show help for command
+
+EXAMPLES
+  prismic codegen types
+  prismic codegen types --output custom.d.ts
+`.trim();
+
+export async function codegenTypes(): Promise<void> {
+	const {
+		values: { help, output },
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "codegen", "types"
+		options: {
+			output: { type: "string", short: "o" },
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: false,
+	});
+
+	if (help) {
+		console.info(HELP);
+		return;
+	}
+
+	try {
+		await buildTypes({ output });
+		console.info(`Generated types written to ${output ?? "prismicio-types.d.ts"}`);
+	} catch (error) {
+		console.error(error instanceof Error ? error.message : String(error));
+		process.exitCode = 1;
+	}
+}
+
+export async function buildTypes(args?: { output?: string }): Promise<void> {
+	const output = args?.output ?? "prismicio-types.d.ts";
+
+	const [customTypesResult, slicesResult] = await Promise.all([
+		readLocalCustomTypes(),
+		readLocalSlices(),
+	]);
+
+	if (!customTypesResult.ok) {
+		throw new Error(`failed to read local custom types: ${customTypesResult.error}`);
+	}
+
+	if (!slicesResult.ok) {
+		throw new Error(`failed to read local slices: ${slicesResult.error}`);
+	}
+
+	const customTypes = customTypesResult.value as unknown as CustomTypeModel[];
+	const slices = slicesResult.value as unknown as SharedSliceModel[];
+
+	const types = generateTypes({
+		customTypeModels: customTypes,
+		sharedSliceModels: slices,
+		typesProvider: "@prismicio/client",
+		clientIntegration: {
+			includeCreateClientInterface: customTypes.length > 0 || slices.length > 0,
+			includeContentNamespace: true,
+		},
+	});
+
+	const content = NON_EDITABLE_FILE_HEADER + "\n\n" + types;
+
+	await writeFile(output, content);
+}

package/src/codegen.ts

@@ -0,0 +1,45 @@
+import { parseArgs } from "node:util";
+
+import { codegenTypes } from "./codegen-types";
+
+const HELP = `
+Generate code from Prismic models.
+
+USAGE
+  prismic codegen <command> [flags]
+
+COMMANDS
+  types       Generate TypeScript types from models pushed to Prismic
+
+FLAGS
+  -h, --help   Show help for command
+
+LEARN MORE
+  Use \`prismic codegen <command> --help\` for more information about a command.
+`.trim();
+
+export async function codegen(): Promise<void> {
+	const {
+		positionals: [subcommand],
+	} = parseArgs({
+		args: process.argv.slice(3), // skip: node, script, "codegen"
+		options: {
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+		strict: false,
+	});
+
+	switch (subcommand) {
+		case "types":
+			await codegenTypes();
+			break;
+		default: {
+			if (subcommand) {
+				console.error(`Unknown codegen subcommand: ${subcommand}\n`);
+				process.exitCode = 1;
+			}
+			console.info(HELP);
+		}
+	}
+}

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

@@ -0,0 +1,222 @@
+import type { BooleanField, 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 { findGroupInTab, isGroupField, parseFieldPath, validateNestedFieldPath } from "./lib/field-path";
+import { stringify } from "./lib/json";
+import { humanReadable } from "./lib/string";
+
+const HELP = `
+Add a boolean (toggle) field to an existing custom type.
+
+USAGE
+  prismic custom-type add-field boolean <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 (inferred from field-id if omitted)
+      --default          Set default value to true
+      --true-label string Label shown when toggle is on
+      --false-label string Label shown when toggle is off
+      --types string   Output file for generated types (default: "prismicio-types.d.ts")
+  -h, --help             Show help for command
+
+EXAMPLES
+  prismic custom-type add-field boolean homepage featured
+  prismic custom-type add-field boolean article published --default
+  prismic custom-type add-field boolean product available --true-label "In Stock" --false-label "Out of Stock"
+`.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 customTypeAddFieldBoolean(): Promise<void> {
+	const {
+		values: {
+			help,
+			tab,
+			label,
+			default: defaultValue,
+			"true-label": trueLabel,
+			"false-label": falseLabel,
+			types,
+		},
+		positionals: [typeId, fieldId],
+	} = parseArgs({
+		args: process.argv.slice(5), // skip: node, script, "custom-type", "add-field", "boolean"
+		options: {
+			tab: { type: "string", short: "t" },
+			label: { type: "string", short: "l" },
+			default: { type: "boolean" },
+			"true-label": { type: "string" },
+			"false-label": { 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 add-field boolean <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 boolean <type-id> <field-id>");
+		process.exitCode = 1;
+		return;
+	}
+
+	// Parse and validate field path
+	const fieldPath = parseFieldPath(fieldId);
+	const pathValidation = validateNestedFieldPath(fieldPath);
+	if (!pathValidation.ok) {
+		console.error(pathValidation.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;
+	}
+
+	// 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] = {};
+	}
+
+	// Build field definition
+	const fieldDefinition: BooleanField = {
+		type: "Boolean",
+		config: {
+			label: label ?? humanReadable(fieldPath.type === "nested" ? fieldPath.nestedFieldId : fieldId),
+			...(defaultValue && { default_value: true }),
+			...(trueLabel && { placeholder_true: trueLabel }),
+			...(falseLabel && { placeholder_false: falseLabel }),
+		},
+	};
+
+	// Add field to model
+	if (fieldPath.type === "nested") {
+		const groupResult = findGroupInTab(model.json[targetTab], fieldPath.groupId, targetTab);
+		if (!groupResult.ok) {
+			console.error(groupResult.error);
+			process.exitCode = 1;
+			return;
+		}
+		// Check if field already exists in the group
+		if (groupResult.group.config.fields[fieldPath.nestedFieldId]) {
+			console.error(`Field "${fieldPath.nestedFieldId}" already exists in group "${fieldPath.groupId}"`);
+			process.exitCode = 1;
+			return;
+		}
+		groupResult.group.config.fields[fieldPath.nestedFieldId] = fieldDefinition;
+	} else {
+		// 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;
+			}
+			// Also check inside groups
+			for (const [groupFieldId, groupField] of Object.entries(tabFields)) {
+				if (isGroupField(groupField) && groupField.config.fields[fieldId]) {
+					console.error(`Field "${fieldId}" already exists in group "${groupFieldId}" in tab "${tabName}"`);
+					process.exitCode = 1;
+					return;
+				}
+			}
+		}
+		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;
+	}
+
+	if (fieldPath.type === "nested") {
+		console.info(`Added field "${fieldPath.nestedFieldId}" (Boolean) to group "${fieldPath.groupId}" in ${typeId}`);
+	} else {
+		console.info(`Added field "${fieldId}" (Boolean) to "${targetTab}" tab in ${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}`);
+	}
+
+	console.info();
+	console.info("Next: Add more fields with `prismic custom-type add-field`");
+	console.info("      Run `prismic status` when done to find next steps");
+}

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

@@ -0,0 +1,205 @@
+import type { Color, 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 { findGroupInTab, isGroupField, parseFieldPath, validateNestedFieldPath } from "./lib/field-path";
+import { stringify } from "./lib/json";
+import { humanReadable } from "./lib/string";
+
+const HELP = `
+Add a color picker field to an existing custom type.
+
+USAGE
+  prismic custom-type add-field color <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 (inferred from field-id if omitted)
+  -p, --placeholder string Placeholder text
+      --types string   Output file for generated types (default: "prismicio-types.d.ts")
+  -h, --help             Show help for command
+
+EXAMPLES
+  prismic custom-type add-field color homepage bg_color
+  prismic custom-type add-field color homepage accent --tab "Design"
+  prismic custom-type add-field color homepage text_color --label "Text Color"
+`.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 customTypeAddFieldColor(): Promise<void> {
+	const {
+		values: { help, tab, label, placeholder, types },
+		positionals: [typeId, fieldId],
+	} = parseArgs({
+		args: process.argv.slice(5), // skip: node, script, "custom-type", "add-field", "color"
+		options: {
+			tab: { type: "string", short: "t" },
+			label: { type: "string", short: "l" },
+			placeholder: { type: "string", short: "p" },
+			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 add-field color <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 color <type-id> <field-id>");
+		process.exitCode = 1;
+		return;
+	}
+
+	// Parse and validate field path
+	const fieldPath = parseFieldPath(fieldId);
+	const pathValidation = validateNestedFieldPath(fieldPath);
+	if (!pathValidation.ok) {
+		console.error(pathValidation.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;
+	}
+
+	// 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] = {};
+	}
+
+	// Build field definition
+	const fieldDefinition: Color = {
+		type: "Color",
+		config: {
+			label: label ?? humanReadable(fieldPath.type === "nested" ? fieldPath.nestedFieldId : fieldId),
+			...(placeholder && { placeholder }),
+		},
+	};
+
+	// Add field to model
+	if (fieldPath.type === "nested") {
+		const groupResult = findGroupInTab(model.json[targetTab], fieldPath.groupId, targetTab);
+		if (!groupResult.ok) {
+			console.error(groupResult.error);
+			process.exitCode = 1;
+			return;
+		}
+		if (groupResult.group.config.fields[fieldPath.nestedFieldId]) {
+			console.error(`Field "${fieldPath.nestedFieldId}" already exists in group "${fieldPath.groupId}"`);
+			process.exitCode = 1;
+			return;
+		}
+		groupResult.group.config.fields[fieldPath.nestedFieldId] = fieldDefinition;
+	} else {
+		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;
+			}
+			for (const [groupFieldId, groupField] of Object.entries(tabFields)) {
+				if (isGroupField(groupField) && groupField.config.fields[fieldId]) {
+					console.error(`Field "${fieldId}" already exists in group "${groupFieldId}" in tab "${tabName}"`);
+					process.exitCode = 1;
+					return;
+				}
+			}
+		}
+		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;
+	}
+
+	if (fieldPath.type === "nested") {
+		console.info(`Added field "${fieldPath.nestedFieldId}" (Color) to group "${fieldPath.groupId}" in ${typeId}`);
+	} else {
+		console.info(`Added field "${fieldId}" (Color) to "${targetTab}" tab in ${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}`);
+	}
+
+	console.info();
+	console.info("Next: Add more fields with `prismic custom-type add-field`");
+	console.info("      Run `prismic status` when done to find next steps");
+}