prismic 0.0.0-pr.28.59bf330

package/src/page-type-add-field-timestamp.ts

@@ -0,0 +1,168 @@
+import type { CustomType, Timestamp } from "@prismicio/types-internal/lib/customtypes";
+
+import { parseArgs } from "node:util";
+
+import { buildTypes } from "./codegen-types";
+import { findGroupInTab, isGroupField, parseFieldPath, validateNestedFieldPath } from "./lib/field-path";
+import { getDocsPath, requireFramework } from "./framework";
+import { humanReadable } from "./lib/string";
+
+const HELP = `
+Add a timestamp (date and time) field to an existing page type.
+
+USAGE
+  prismic page-type add-field timestamp <type-id> <field-id> [flags]
+
+ARGUMENTS
+  type-id                Page 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
+      --default string   Default timestamp value (ISO 8601 format)
+      --types string   Output file for generated types (default: "prismicio-types.d.ts")
+  -h, --help             Show help for command
+
+EXAMPLES
+  prismic page-type add-field timestamp homepage event_time
+  prismic page-type add-field timestamp event start --tab "Schedule"
+  prismic page-type add-field timestamp article published_at --label "Published At"
+`.trim();
+
+
+export async function pageTypeAddFieldTimestamp(): Promise<void> {
+	const {
+		values: { help, tab, label, placeholder, default: defaultValue, types },
+		positionals: [typeId, fieldId],
+	} = parseArgs({
+		args: process.argv.slice(5), // skip: node, script, "page-type", "add-field", "timestamp"
+		options: {
+			tab: { type: "string", short: "t" },
+			label: { type: "string", short: "l" },
+			placeholder: { type: "string", short: "p" },
+			default: { 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 add-field timestamp <type-id> <field-id>");
+		process.exitCode = 1;
+		return;
+	}
+
+	if (!fieldId) {
+		console.error("Missing required argument: field-id\n");
+		console.error("Usage: prismic page-type add-field timestamp <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;
+	}
+
+	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;
+	}
+
+	// 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: Timestamp = {
+		type: "Timestamp",
+		config: {
+			label: label ?? humanReadable(fieldPath.type === "nested" ? fieldPath.nestedFieldId : fieldId),
+			...(placeholder && { placeholder }),
+			...(defaultValue && { default: defaultValue }),
+		},
+	};
+
+	// 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
+	await framework.updateCustomType(model);
+
+	if (fieldPath.type === "nested") {
+		console.info(`Added field "${fieldPath.nestedFieldId}" (Timestamp) to group "${fieldPath.groupId}" in ${typeId}`);
+	} else {
+		console.info(`Added field "${fieldId}" (Timestamp) 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 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-add-field-uid.ts

@@ -0,0 +1,148 @@
+import type { CustomType, UID } from "@prismicio/types-internal/lib/customtypes";
+
+import { parseArgs } from "node:util";
+
+import { buildTypes } from "./codegen-types";
+import { parseFieldPath, validateNestedFieldPath } from "./lib/field-path";
+import { getDocsPath, requireFramework } from "./framework";
+import { humanReadable } from "./lib/string";
+
+const HELP = `
+Add a UID (unique identifier) field to an existing page type.
+
+USAGE
+  prismic page-type add-field uid <type-id> <field-id> [flags]
+
+ARGUMENTS
+  type-id                Page 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 page-type add-field uid page uid
+  prismic page-type add-field uid article slug --label "URL Slug"
+  prismic page-type add-field uid product sku --placeholder "Enter unique SKU"
+`.trim();
+
+
+export async function pageTypeAddFieldUid(): Promise<void> {
+	const {
+		values: { help, tab, label, placeholder, types },
+		positionals: [typeId, fieldId],
+	} = parseArgs({
+		args: process.argv.slice(5), // skip: node, script, "page-type", "add-field", "uid"
+		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 page-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 page-type add-field uid <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;
+	}
+
+	// UID fields cannot be nested in groups
+	if (fieldPath.type === "nested") {
+		console.error("UID fields cannot be nested inside groups");
+		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;
+	}
+
+	// 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 ?? humanReadable(fieldId),
+			...(placeholder && { placeholder }),
+		},
+	};
+
+	// Add field to model
+	model.json[targetTab][fieldId] = fieldDefinition;
+
+	// Write updated model
+	await framework.updateCustomType(model);
+
+	console.info(`Added field "${fieldId}" (UID) 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 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-add-field.ts

@@ -0,0 +1,116 @@
+import { parseArgs } from "node:util";
+
+import { pageTypeAddFieldBoolean } from "./page-type-add-field-boolean";
+import { pageTypeAddFieldColor } from "./page-type-add-field-color";
+import { pageTypeAddFieldDate } from "./page-type-add-field-date";
+import { pageTypeAddFieldEmbed } from "./page-type-add-field-embed";
+import { pageTypeAddFieldGeoPoint } from "./page-type-add-field-geo-point";
+import { pageTypeAddFieldGroup } from "./page-type-add-field-group";
+import { pageTypeAddFieldImage } from "./page-type-add-field-image";
+import { pageTypeAddFieldKeyText } from "./page-type-add-field-key-text";
+import { pageTypeAddFieldLink } from "./page-type-add-field-link";
+import { pageTypeAddFieldNumber } from "./page-type-add-field-number";
+import { pageTypeAddFieldRichText } from "./page-type-add-field-rich-text";
+import { pageTypeAddFieldSelect } from "./page-type-add-field-select";
+import { pageTypeAddFieldTimestamp } from "./page-type-add-field-timestamp";
+import { pageTypeAddFieldUid } from "./page-type-add-field-uid";
+
+const HELP = `
+Add a field to an existing page type.
+
+USAGE
+  prismic page-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 page-type add-field <field-type> --help\` for more information.
+
+EXAMPLES
+  prismic page-type add-field key-text homepage meta_title --tab "SEO"
+  prismic page-type add-field link homepage button --allow-text
+  prismic page-type add-field rich-text homepage body --multi "paragraph,heading2,strong,em"
+  prismic page-type add-field select homepage layout --option "full" --option "sidebar"
+`.trim();
+
+export async function pageTypeAddField(): Promise<void> {
+	const {
+		positionals: [fieldType],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "page-type", "add-field"
+		options: {
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+		strict: false,
+	});
+
+	switch (fieldType) {
+		case "boolean":
+			await pageTypeAddFieldBoolean();
+			break;
+		case "color":
+			await pageTypeAddFieldColor();
+			break;
+		case "date":
+			await pageTypeAddFieldDate();
+			break;
+		case "embed":
+			await pageTypeAddFieldEmbed();
+			break;
+		case "geo-point":
+			await pageTypeAddFieldGeoPoint();
+			break;
+		case "group":
+			await pageTypeAddFieldGroup();
+			break;
+		case "image":
+			await pageTypeAddFieldImage();
+			break;
+		case "key-text":
+			await pageTypeAddFieldKeyText();
+			break;
+		case "link":
+			await pageTypeAddFieldLink();
+			break;
+		case "number":
+			await pageTypeAddFieldNumber();
+			break;
+		case "rich-text":
+			await pageTypeAddFieldRichText();
+			break;
+		case "select":
+			await pageTypeAddFieldSelect();
+			break;
+		case "timestamp":
+			await pageTypeAddFieldTimestamp();
+			break;
+		case "uid":
+			await pageTypeAddFieldUid();
+			break;
+		default: {
+			if (fieldType) {
+				console.error(`Unknown field type: ${fieldType}\n`);
+				process.exitCode = 1;
+			}
+			console.info(HELP);
+		}
+	}
+}

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