prismic 0.0.0-pr.28.59bf330

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

@@ -0,0 +1,116 @@
+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 { customTypeAddFieldGroup } from "./custom-type-add-field-group";
+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
+  group                  Repeatable group of fields
+  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 "group":
+			await customTypeAddFieldGroup();
+			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,178 @@
+import type {
+	CustomType,
+	DynamicSlices,
+	SharedSliceRef,
+} from "@prismicio/types-internal/lib/customtypes";
+
+import { parseArgs } from "node:util";
+
+import { buildTypes } from "./codegen-types";
+import { requireFramework } from "./framework";
+
+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")
+      --types string   Output file for generated types (default: "prismicio-types.d.ts")
+  -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();
+
+export async function customTypeConnectSlice(): Promise<void> {
+	const {
+		values: { help, "slice-zone": sliceZoneId, types },
+		positionals: [typeId, sliceId],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "custom-type", "connect-slice"
+		options: {
+			"slice-zone": { type: "string", short: "z" },
+			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 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;
+	}
+
+	const framework = await requireFramework();
+	if (!framework) return;
+
+	// Verify the slice exists
+	try {
+		await framework.readSlice(sliceId);
+	} catch {
+		console.error(`Slice not found: ${sliceId}`);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Read the custom type model
+	let model: CustomType;
+	try {
+		model = await framework.readCustomType(typeId);
+	} catch {
+		console.error(`Custom type not found: ${typeId}\n\nCreate it first with: prismic custom-type create ${typeId}`);
+		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 framework.updateCustomType(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}`);
+
+	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-create.ts

@@ -0,0 +1,98 @@
+import type { CustomType } from "@prismicio/types-internal/lib/customtypes";
+
+import { parseArgs } from "node:util";
+import { pascalCase } from "change-case";
+
+import { buildTypes } from "./codegen-types";
+import { requireFramework } from "./framework";
+
+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
+      --types string   Output file for generated types (default: "prismicio-types.d.ts")
+  -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, types },
+		positionals: [id],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "custom-type", "create"
+		options: {
+			name: { type: "string", short: "n" },
+			single: { type: "boolean" },
+			types: { type: "string" },
+			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 framework = await requireFramework();
+	if (!framework) return;
+
+	const model = {
+		id,
+		label: name ?? pascalCase(id),
+		repeatable: !single,
+		status: true,
+		format: "custom",
+		json: {
+			Main: single
+				? {}
+				: {
+						uid: {
+							type: "UID",
+							config: { label: "UID", placeholder: "" },
+						},
+					},
+		},
+	};
+
+	try {
+		await framework.createCustomType(model as CustomType);
+	} 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 "${id}"`);
+
+	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 fields with `prismic custom-type add-field`");
+}

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

@@ -0,0 +1,134 @@
+import type { CustomType, DynamicSlices } from "@prismicio/types-internal/lib/customtypes";
+
+import { parseArgs } from "node:util";
+
+import { buildTypes } from "./codegen-types";
+import { requireFramework } from "./framework";
+
+const HELP = `
+Disconnect a shared slice from a custom type's slice zone.
+
+USAGE
+  prismic custom-type disconnect-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")
+      --types string   Output file for generated types (default: "prismicio-types.d.ts")
+  -h, --help               Show help for command
+
+EXAMPLES
+  prismic custom-type disconnect-slice homepage CallToAction
+  prismic custom-type disconnect-slice homepage CallToAction --slice-zone slices
+  prismic custom-type disconnect-slice article HeroSection -z body
+`.trim();
+
+export async function customTypeDisconnectSlice(): Promise<void> {
+	const {
+		values: { help, "slice-zone": sliceZoneId, types },
+		positionals: [typeId, sliceId],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "custom-type", "disconnect-slice"
+		options: {
+			"slice-zone": { type: "string", short: "z" },
+			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 disconnect-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 disconnect-slice <type-id> <slice-id>");
+		process.exitCode = 1;
+		return;
+	}
+
+	const framework = await requireFramework();
+	if (!framework) return;
+
+	let model: CustomType;
+	try {
+		model = await framework.readCustomType(typeId);
+	} catch {
+		console.error(`Custom type not found: ${typeId}\n\nCreate it first with: prismic custom-type create ${typeId}`);
+		process.exitCode = 1;
+		return;
+	}
+
+	const targetSliceZoneId = sliceZoneId ?? "slices";
+
+	// Find existing slice zone
+	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;
+	}
+
+	// Slice zone must exist for disconnect
+	if (!sliceZone) {
+		console.error(`Slice zone "${targetSliceZoneId}" not found in custom type "${typeId}"`);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Check if slice is connected
+	if (!sliceZone.config?.choices || !(sliceId in sliceZone.config.choices)) {
+		console.error(
+			`Slice "${sliceId}" is not connected to slice zone "${sliceZoneFieldId}" in ${typeId}`,
+		);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Remove the slice reference
+	delete sliceZone.config.choices[sliceId];
+
+	// Write updated model
+	try {
+		await framework.updateCustomType(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(
+		`Disconnected slice "${sliceId}" from slice zone "${sliceZoneFieldId}" 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}`);
+	}
+}

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