prismic 0.0.0-pr.28.59bf330

package/src/page-type-create.ts

@@ -0,0 +1,128 @@
+import type { CustomType } from "@prismicio/types-internal/lib/customtypes";
+
+import { pascalCase } from "change-case";
+import { parseArgs } from "node:util";
+
+import { buildTypes } from "./codegen-types";
+import { getDocsPath, requireFramework } from "./framework";
+
+const HELP = `
+Create a new page type in a Prismic repository.
+
+USAGE
+  prismic page-type create <id> [flags]
+
+ARGUMENTS
+  id       Page type identifier (required)
+
+FLAGS
+  -n, --name string   Display name for the page 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 page-type <command> --help\` for more information about a command.
+`.trim();
+
+export async function pageTypeCreate(): Promise<void> {
+	const {
+		values: { help, name, single, types },
+		positionals: [id],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "page-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: "page",
+		json: {
+			Main: single
+				? {}
+				: {
+						uid: {
+							type: "UID",
+							config: { label: "UID", placeholder: "" },
+						},
+					},
+			"SEO & Metadata": {
+				meta_title: {
+					type: "Text",
+					config: {
+						label: "Meta Title",
+						placeholder: "A title of the page used for social media and search engines",
+					},
+				},
+				meta_description: {
+					type: "Text",
+					config: {
+						label: "Meta Description",
+						placeholder: "A brief summary of the page",
+					},
+				},
+				meta_image: {
+					type: "Image",
+					config: {
+						label: "Meta Image",
+						constraint: { width: 2400, height: 1260 },
+						thumbnails: [],
+					},
+				},
+			},
+		},
+	};
+
+	try {
+		const { modelPath } = await framework.createCustomType(model as CustomType);
+		console.info(`Created page type at ${modelPath.href}`);
+	} catch (error) {
+		if (error instanceof Error) {
+			console.error(`Failed to create page type: ${error.message}`);
+		} else {
+			console.error(`Failed to create page type`);
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	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 page-type add-field`");
+
+	if (framework) {
+		const docsPath = getDocsPath(framework.id);
+		console.info(
+			`      Run \`prismic docs fetch ${docsPath}#write-page-components\` to learn how to implement a page file`,
+		);
+	}
+}

package/src/page-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 page type's slice zone.
+
+USAGE
+  prismic page-type disconnect-slice <type-id> <slice-id> [flags]
+
+ARGUMENTS
+  type-id                Page 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 page-type disconnect-slice homepage CallToAction
+  prismic page-type disconnect-slice homepage CallToAction --slice-zone slices
+  prismic page-type disconnect-slice article HeroSection -z body
+`.trim();
+
+export async function pageTypeDisconnectSlice(): Promise<void> {
+	const {
+		values: { help, "slice-zone": sliceZoneId, types },
+		positionals: [typeId, sliceId],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "page-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 page-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 page-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(`Page type not found: ${typeId}\n\nCreate it first with: prismic page-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 page 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 page type: ${error.message}`);
+		} else {
+			console.error("Failed to update page 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/page-type-list.ts

@@ -0,0 +1,109 @@
+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 page types in a Prismic project.
+
+USAGE
+  prismic page-type list [flags]
+
+FLAGS
+  --json       Output as JSON
+  -h, --help   Show help for command
+
+EXAMPLES
+  prismic page-type list
+  prismic page-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 pageTypeList(): Promise<void> {
+	const {
+		values: { help, json },
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "page-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 page types found.");
+		}
+		return;
+	}
+
+	const pageTypes: { 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);
+			if (result.success && result.output.format === "page") {
+				pageTypes.push({
+					id: result.output.id,
+					label: result.output.label,
+					repeatable: result.output.repeatable,
+				});
+			}
+		} catch {
+			// Skip directories without valid index.json
+		}
+	}
+
+	if (pageTypes.length === 0) {
+		if (json) {
+			console.info(JSON.stringify([]));
+		} else {
+			console.info("No page types found.");
+		}
+		return;
+	}
+
+	if (json) {
+		console.info(JSON.stringify(pageTypes, null, 2));
+	} else {
+		console.info("ID\tLABEL\tTYPE");
+		for (const pageType of pageTypes) {
+			const typeLabel = pageType.repeatable ? "repeatable" : "singleton";
+			console.info(`${pageType.id}\t${pageType.label}\t${typeLabel}`);
+		}
+	}
+}

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

@@ -0,0 +1,135 @@
+import type { CustomType } from "@prismicio/types-internal/lib/customtypes";
+
+import { parseArgs } from "node:util";
+
+import { buildTypes } from "./codegen-types";
+import { requireFramework } from "./framework";
+
+const HELP = `
+Remove a field from a page type.
+
+USAGE
+  prismic page-type remove-field <type-id> <field-id> [flags]
+
+ARGUMENTS
+  type-id      Page 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 page-type remove-field homepage title
+  prismic page-type remove-field homepage meta_title --tab "SEO & Metadata"
+`.trim();
+
+export async function pageTypeRemoveField(): Promise<void> {
+	const {
+		values: { help, tab, types },
+		positionals: [typeId, fieldId],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "page-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 page-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 page-type remove-field <type-id> <field-id>");
+		process.exitCode = 1;
+		return;
+	}
+
+	const framework = await requireFramework();
+	if (!framework) return;
+
+	let model: CustomType;
+	try {
+		model = await framework.readCustomType(typeId);
+	} catch {
+		console.error(`Page type not found: ${typeId}\n\nCreate it first with: prismic page-type create ${typeId}`);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Check if this is actually a page type
+	if (model.format !== "page") {
+		console.error(`"${typeId}" is not a page type (format: ${model.format ?? "custom"})`);
+		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 page 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 page type "${typeId}"`);
+			process.exitCode = 1;
+			return;
+		}
+	}
+
+	// Write updated model
+	try {
+		await framework.updateCustomType(model);
+	} catch (error) {
+		if (error instanceof Error) {
+			console.error(`Failed to update page type: ${error.message}`);
+		} else {
+			console.error("Failed to update page type");
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	console.info(`Removed field "${fieldId}" from tab "${foundTab}" in page 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/page-type-remove.ts

@@ -0,0 +1,103 @@
+import type { CustomType } from "@prismicio/types-internal/lib/customtypes";
+
+import { parseArgs } from "node:util";
+
+import { buildTypes } from "./codegen-types";
+import { requireFramework } from "./framework";
+
+const HELP = `
+Remove a page type from the project.
+
+USAGE
+  prismic page-type remove <type-id> [flags]
+
+ARGUMENTS
+  type-id      Page 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 page-type remove homepage
+  prismic page-type remove homepage -y
+`.trim();
+
+export async function pageTypeRemove(): Promise<void> {
+	const {
+		values: { help, y, types },
+		positionals: [typeId],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "page-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 page-type remove <type-id>");
+		process.exitCode = 1;
+		return;
+	}
+
+	const framework = await requireFramework();
+	if (!framework) return;
+
+	let model: CustomType;
+	try {
+		model = await framework.readCustomType(typeId);
+	} catch {
+		console.error(`Page type not found: ${typeId}\n\nCreate it first with: prismic page-type create ${typeId}`);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Check if this is actually a page type
+	if (model.format !== "page") {
+		console.error(`"${typeId}" is not a page type (format: ${model.format ?? "custom"})`);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Require -y flag to confirm deletion
+	if (!y) {
+		console.error(
+			`Refusing to remove page type "${typeId}" (this will delete the entire directory).`,
+		);
+		console.error("Re-run with -y to confirm.");
+		process.exitCode = 1;
+		return;
+	}
+
+	// Delete the page type directory
+	try {
+		await framework.deleteCustomType(typeId);
+	} catch (error) {
+		if (error instanceof Error) {
+			console.error(`Failed to remove page type: ${error.message}`);
+		} else {
+			console.error("Failed to remove page type");
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	console.info(`Removed page 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/page-type-set-name.ts

@@ -0,0 +1,102 @@
+import type { CustomType } from "@prismicio/types-internal/lib/customtypes";
+
+import { parseArgs } from "node:util";
+
+import { buildTypes } from "./codegen-types";
+import { requireFramework } from "./framework";
+
+const HELP = `
+Change a page type's display name (label).
+
+USAGE
+  prismic page-type set-name <type-id> <new-name> [flags]
+
+ARGUMENTS
+  type-id      Page 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 page-type set-name homepage "Home Page"
+  prismic page-type set-name blog_post "Blog Post"
+`.trim();
+
+export async function pageTypeSetName(): Promise<void> {
+	const {
+		values: { help, types },
+		positionals: [typeId, newName],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "page-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 page-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 page-type set-name <type-id> <new-name>");
+		process.exitCode = 1;
+		return;
+	}
+
+	const framework = await requireFramework();
+	if (!framework) return;
+
+	let model: CustomType;
+	try {
+		model = await framework.readCustomType(typeId);
+	} catch {
+		console.error(`Page type not found: ${typeId}\n\nCreate it first with: prismic page-type create ${typeId}`);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Check if this is actually a page type
+	if (model.format !== "page") {
+		console.error(`"${typeId}" is not a page type (format: ${model.format ?? "custom"})`);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Update the model
+	model.label = newName;
+
+	// Write updated model
+	try {
+		await framework.updateCustomType(model);
+	} catch (error) {
+		if (error instanceof Error) {
+			console.error(`Failed to update page type: ${error.message}`);
+		} else {
+			console.error("Failed to update page type");
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	console.info(`Renamed page 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}`);
+	}
+}