@angeloashmore/prismic-cli-poc 0.0.0-canary.d96e685 → 0.0.0-pr.3.219652e

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@angeloashmore/prismic-cli-poc",
-	"version": "0.0.0-canary.d96e685",
+	"version": "0.0.0-pr.3.219652e",
 	"description": "A proof-of-concept developer CLI for Prismic.",
 	"keywords": [
 		"prismic",
@@ -41,6 +41,7 @@
 		"@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",

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

@@ -4,8 +4,10 @@ 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";
+import { humanReadable } from "./lib/string";
 
 const HELP = `
 Add a boolean (toggle) field to an existing custom type.
@@ -17,12 +19,16 @@ ARGUMENTS
   type-id                Custom type identifier (required)
   field-id               Field identifier (required)
 
+Types are generated by default after changes. Use --no-types to skip.
+
 FLAGS
   -t, --tab string       Target tab (default: first existing tab, or "Main")
-  -l, --label string     Display label for the field
+  -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")
+      --no-types       Skip type generation
   -h, --help             Show help for command
 
 EXAMPLES
@@ -49,6 +55,8 @@ export async function customTypeAddFieldBoolean(): Promise<void> {
 			default: defaultValue,
 			"true-label": trueLabel,
 			"false-label": falseLabel,
+			types,
+			"no-types": noTypes,
 		},
 		positionals: [typeId, fieldId],
 	} = parseArgs({
@@ -59,6 +67,8 @@ export async function customTypeAddFieldBoolean(): Promise<void> {
 			default: { type: "boolean" },
 			"true-label": { type: "string" },
 			"false-label": { type: "string" },
+			types: { type: "string" },
+			"no-types": { type: "boolean" },
 			help: { type: "boolean", short: "h" },
 		},
 		allowPositionals: true,
@@ -142,7 +152,7 @@ export async function customTypeAddFieldBoolean(): Promise<void> {
 	const fieldDefinition: BooleanField = {
 		type: "Boolean",
 		config: {
-			...(label && { label }),
+			label: label ?? humanReadable(fieldId),
 			...(defaultValue && { default_value: true }),
 			...(trueLabel && { placeholder_true: trueLabel }),
 			...(falseLabel && { placeholder_false: falseLabel }),
@@ -165,7 +175,14 @@ export async function customTypeAddFieldBoolean(): Promise<void> {
 		return;
 	}
 
-	console.info(
-		`Added field "${fieldId}" (Boolean) to "${targetTab}" tab in ${typeId}`,
-	);
+	console.info(`Added field "${fieldId}" (Boolean) to "${targetTab}" tab in ${typeId}`);
+
+	if (!noTypes) {
+		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-add-field-color.ts

@@ -4,8 +4,10 @@ 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";
+import { humanReadable } from "./lib/string";
 
 const HELP = `
 Add a color picker field to an existing custom type.
@@ -17,10 +19,14 @@ ARGUMENTS
   type-id                Custom type identifier (required)
   field-id               Field identifier (required)
 
+Types are generated by default after changes. Use --no-types to skip.
+
 FLAGS
   -t, --tab string       Target tab (default: first existing tab, or "Main")
-  -l, --label string     Display label for the field
+  -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")
+      --no-types       Skip type generation
   -h, --help             Show help for command
 
 EXAMPLES
@@ -40,7 +46,7 @@ const CustomTypeSchema = v.object({
 
 export async function customTypeAddFieldColor(): Promise<void> {
 	const {
-		values: { help, tab, label, placeholder },
+		values: { help, tab, label, placeholder, types, "no-types": noTypes },
 		positionals: [typeId, fieldId],
 	} = parseArgs({
 		args: process.argv.slice(5), // skip: node, script, "custom-type", "add-field", "color"
@@ -48,6 +54,8 @@ export async function customTypeAddFieldColor(): Promise<void> {
 			tab: { type: "string", short: "t" },
 			label: { type: "string", short: "l" },
 			placeholder: { type: "string", short: "p" },
+			types: { type: "string" },
+			"no-types": { type: "boolean" },
 			help: { type: "boolean", short: "h" },
 		},
 		allowPositionals: true,
@@ -131,7 +139,7 @@ export async function customTypeAddFieldColor(): Promise<void> {
 	const fieldDefinition: Color = {
 		type: "Color",
 		config: {
-			...(label && { label }),
+			label: label ?? humanReadable(fieldId),
 			...(placeholder && { placeholder }),
 		},
 	};
@@ -152,7 +160,14 @@ export async function customTypeAddFieldColor(): Promise<void> {
 		return;
 	}
 
-	console.info(
-		`Added field "${fieldId}" (Color) to "${targetTab}" tab in ${typeId}`,
-	);
+	console.info(`Added field "${fieldId}" (Color) to "${targetTab}" tab in ${typeId}`);
+
+	if (!noTypes) {
+		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-add-field-date.ts

@@ -4,8 +4,10 @@ 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";
+import { humanReadable } from "./lib/string";
 
 const HELP = `
 Add a date field to an existing custom type.
@@ -17,11 +19,15 @@ ARGUMENTS
   type-id                Custom type identifier (required)
   field-id               Field identifier (required)
 
+Types are generated by default after changes. Use --no-types to skip.
+
 FLAGS
   -t, --tab string       Target tab (default: first existing tab, or "Main")
-  -l, --label string     Display label for the field
+  -l, --label string     Display label for the field (inferred from field-id if omitted)
   -p, --placeholder string Placeholder text
       --default string   Default date value (YYYY-MM-DD format)
+      --types string   Output file for generated types (default: "prismicio-types.d.ts")
+      --no-types       Skip type generation
   -h, --help             Show help for command
 
 EXAMPLES
@@ -41,7 +47,7 @@ const CustomTypeSchema = v.object({
 
 export async function customTypeAddFieldDate(): Promise<void> {
 	const {
-		values: { help, tab, label, placeholder, default: defaultValue },
+		values: { help, tab, label, placeholder, default: defaultValue, types, "no-types": noTypes },
 		positionals: [typeId, fieldId],
 	} = parseArgs({
 		args: process.argv.slice(5), // skip: node, script, "custom-type", "add-field", "date"
@@ -50,6 +56,8 @@ export async function customTypeAddFieldDate(): Promise<void> {
 			label: { type: "string", short: "l" },
 			placeholder: { type: "string", short: "p" },
 			default: { type: "string" },
+			types: { type: "string" },
+			"no-types": { type: "boolean" },
 			help: { type: "boolean", short: "h" },
 		},
 		allowPositionals: true,
@@ -133,7 +141,7 @@ export async function customTypeAddFieldDate(): Promise<void> {
 	const fieldDefinition: DateField = {
 		type: "Date",
 		config: {
-			...(label && { label }),
+			label: label ?? humanReadable(fieldId),
 			...(placeholder && { placeholder }),
 			...(defaultValue && { default: defaultValue }),
 		},
@@ -155,7 +163,14 @@ export async function customTypeAddFieldDate(): Promise<void> {
 		return;
 	}
 
-	console.info(
-		`Added field "${fieldId}" (Date) to "${targetTab}" tab in ${typeId}`,
-	);
+	console.info(`Added field "${fieldId}" (Date) to "${targetTab}" tab in ${typeId}`);
+
+	if (!noTypes) {
+		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-add-field-embed.ts

@@ -4,8 +4,10 @@ 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";
+import { humanReadable } from "./lib/string";
 
 const HELP = `
 Add an embed field to an existing custom type.
@@ -17,10 +19,14 @@ ARGUMENTS
   type-id                Custom type identifier (required)
   field-id               Field identifier (required)
 
+Types are generated by default after changes. Use --no-types to skip.
+
 FLAGS
   -t, --tab string       Target tab (default: first existing tab, or "Main")
-  -l, --label string     Display label for the field
+  -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")
+      --no-types       Skip type generation
   -h, --help             Show help for command
 
 EXAMPLES
@@ -40,7 +46,7 @@ const CustomTypeSchema = v.object({
 
 export async function customTypeAddFieldEmbed(): Promise<void> {
 	const {
-		values: { help, tab, label, placeholder },
+		values: { help, tab, label, placeholder, types, "no-types": noTypes },
 		positionals: [typeId, fieldId],
 	} = parseArgs({
 		args: process.argv.slice(5), // skip: node, script, "custom-type", "add-field", "embed"
@@ -48,6 +54,8 @@ export async function customTypeAddFieldEmbed(): Promise<void> {
 			tab: { type: "string", short: "t" },
 			label: { type: "string", short: "l" },
 			placeholder: { type: "string", short: "p" },
+			types: { type: "string" },
+			"no-types": { type: "boolean" },
 			help: { type: "boolean", short: "h" },
 		},
 		allowPositionals: true,
@@ -131,7 +139,7 @@ export async function customTypeAddFieldEmbed(): Promise<void> {
 	const fieldDefinition: Embed = {
 		type: "Embed",
 		config: {
-			...(label && { label }),
+			label: label ?? humanReadable(fieldId),
 			...(placeholder && { placeholder }),
 		},
 	};
@@ -152,7 +160,14 @@ export async function customTypeAddFieldEmbed(): Promise<void> {
 		return;
 	}
 
-	console.info(
-		`Added field "${fieldId}" (Embed) to "${targetTab}" tab in ${typeId}`,
-	);
+	console.info(`Added field "${fieldId}" (Embed) to "${targetTab}" tab in ${typeId}`);
+
+	if (!noTypes) {
+		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-add-field-geo-point.ts

@@ -4,8 +4,10 @@ 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";
+import { humanReadable } from "./lib/string";
 
 const HELP = `
 Add a geo-point (location) field to an existing custom type.
@@ -17,9 +19,13 @@ ARGUMENTS
   type-id                Custom type identifier (required)
   field-id               Field identifier (required)
 
+Types are generated by default after changes. Use --no-types to skip.
+
 FLAGS
   -t, --tab string       Target tab (default: first existing tab, or "Main")
-  -l, --label string     Display label for the field
+  -l, --label string     Display label for the field (inferred from field-id if omitted)
+      --types string   Output file for generated types (default: "prismicio-types.d.ts")
+      --no-types       Skip type generation
   -h, --help             Show help for command
 
 EXAMPLES
@@ -39,13 +45,15 @@ const CustomTypeSchema = v.object({
 
 export async function customTypeAddFieldGeoPoint(): Promise<void> {
 	const {
-		values: { help, tab, label },
+		values: { help, tab, label, types, "no-types": noTypes },
 		positionals: [typeId, fieldId],
 	} = parseArgs({
 		args: process.argv.slice(5), // skip: node, script, "custom-type", "add-field", "geo-point"
 		options: {
 			tab: { type: "string", short: "t" },
 			label: { type: "string", short: "l" },
+			types: { type: "string" },
+			"no-types": { type: "boolean" },
 			help: { type: "boolean", short: "h" },
 		},
 		allowPositionals: true,
@@ -129,7 +137,7 @@ export async function customTypeAddFieldGeoPoint(): Promise<void> {
 	const fieldDefinition: GeoPoint = {
 		type: "GeoPoint",
 		config: {
-			...(label && { label }),
+			label: label ?? humanReadable(fieldId),
 		},
 	};
 
@@ -149,7 +157,14 @@ export async function customTypeAddFieldGeoPoint(): Promise<void> {
 		return;
 	}
 
-	console.info(
-		`Added field "${fieldId}" (GeoPoint) to "${targetTab}" tab in ${typeId}`,
-	);
+	console.info(`Added field "${fieldId}" (GeoPoint) to "${targetTab}" tab in ${typeId}`);
+
+	if (!noTypes) {
+		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-add-field-image.ts

@@ -4,8 +4,10 @@ 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";
+import { humanReadable } from "./lib/string";
 
 const HELP = `
 Add an image field to an existing custom type.
@@ -17,10 +19,14 @@ ARGUMENTS
   type-id                Custom type identifier (required)
   field-id               Field identifier (required)
 
+Types are generated by default after changes. Use --no-types to skip.
+
 FLAGS
   -t, --tab string       Target tab (default: first existing tab, or "Main")
-  -l, --label string     Display label for the field
+  -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")
+      --no-types       Skip type generation
   -h, --help             Show help for command
 
 EXAMPLES
@@ -40,7 +46,7 @@ const CustomTypeSchema = v.object({
 
 export async function customTypeAddFieldImage(): Promise<void> {
 	const {
-		values: { help, tab, label, placeholder },
+		values: { help, tab, label, placeholder, types, "no-types": noTypes },
 		positionals: [typeId, fieldId],
 	} = parseArgs({
 		args: process.argv.slice(5), // skip: node, script, "custom-type", "add-field", "image"
@@ -48,6 +54,8 @@ export async function customTypeAddFieldImage(): Promise<void> {
 			tab: { type: "string", short: "t" },
 			label: { type: "string", short: "l" },
 			placeholder: { type: "string", short: "p" },
+			types: { type: "string" },
+			"no-types": { type: "boolean" },
 			help: { type: "boolean", short: "h" },
 		},
 		allowPositionals: true,
@@ -131,7 +139,7 @@ export async function customTypeAddFieldImage(): Promise<void> {
 	const fieldDefinition: Image = {
 		type: "Image",
 		config: {
-			...(label && { label }),
+			label: label ?? humanReadable(fieldId),
 			...(placeholder && { placeholder }),
 		},
 	};
@@ -152,7 +160,14 @@ export async function customTypeAddFieldImage(): Promise<void> {
 		return;
 	}
 
-	console.info(
-		`Added field "${fieldId}" (Image) to "${targetTab}" tab in ${typeId}`,
-	);
+	console.info(`Added field "${fieldId}" (Image) to "${targetTab}" tab in ${typeId}`);
+
+	if (!noTypes) {
+		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-add-field-key-text.ts

@@ -4,8 +4,10 @@ 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";
+import { humanReadable } from "./lib/string";
 
 const HELP = `
 Add a key-text (single-line text) field to an existing custom type.
@@ -17,10 +19,14 @@ ARGUMENTS
   type-id                Custom type identifier (required)
   field-id               Field identifier (required)
 
+Types are generated by default after changes. Use --no-types to skip.
+
 FLAGS
   -t, --tab string       Target tab (default: first existing tab, or "Main")
-  -l, --label string     Display label for the field
+  -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")
+      --no-types       Skip type generation
   -h, --help             Show help for command
 
 EXAMPLES
@@ -40,7 +46,7 @@ const CustomTypeSchema = v.object({
 
 export async function customTypeAddFieldKeyText(): Promise<void> {
 	const {
-		values: { help, tab, label, placeholder },
+		values: { help, tab, label, placeholder, types, "no-types": noTypes },
 		positionals: [typeId, fieldId],
 	} = parseArgs({
 		args: process.argv.slice(5), // skip: node, script, "custom-type", "add-field", "key-text"
@@ -48,6 +54,8 @@ export async function customTypeAddFieldKeyText(): Promise<void> {
 			tab: { type: "string", short: "t" },
 			label: { type: "string", short: "l" },
 			placeholder: { type: "string", short: "p" },
+			types: { type: "string" },
+			"no-types": { type: "boolean" },
 			help: { type: "boolean", short: "h" },
 		},
 		allowPositionals: true,
@@ -131,7 +139,7 @@ export async function customTypeAddFieldKeyText(): Promise<void> {
 	const fieldDefinition: Text = {
 		type: "Text",
 		config: {
-			...(label && { label }),
+			label: label ?? humanReadable(fieldId),
 			...(placeholder && { placeholder }),
 		},
 	};
@@ -152,7 +160,14 @@ export async function customTypeAddFieldKeyText(): Promise<void> {
 		return;
 	}
 
-	console.info(
-		`Added field "${fieldId}" (Text) to "${targetTab}" tab in ${typeId}`,
-	);
+	console.info(`Added field "${fieldId}" (Text) to "${targetTab}" tab in ${typeId}`);
+
+	if (!noTypes) {
+		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}`);
+		}
+	}
 }