prismic 0.0.0-pr.28.59bf330

package/src/slice-add-field-number.ts

@@ -0,0 +1,205 @@
+import type { Number, SharedSlice } from "@prismicio/types-internal/lib/customtypes";
+
+import { parseArgs } from "node:util";
+
+import { buildTypes } from "./codegen-types";
+import { findGroupInVariation, isGroupField, parseFieldPath, validateNestedFieldPath } from "./lib/field-path";
+import { getDocsPath, getWriteComponentsAnchor, requireFramework } from "./framework";
+import { humanReadable } from "./lib/string";
+
+const HELP = `
+Add a number field to an existing slice.
+
+USAGE
+  prismic slice add-field number <slice-id> <field-id> [flags]
+
+ARGUMENTS
+  slice-id               Slice identifier (required)
+  field-id               Field identifier (required)
+
+FLAGS
+  -v, --variation string Target variation (default: first variation)
+  -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 slice add-field number my_slice price
+  prismic slice add-field number product quantity --label "Quantity"
+  prismic slice add-field number stats count --variation "detailed"
+`.trim();
+
+
+
+export async function sliceAddFieldNumber(): Promise<void> {
+	const {
+		values: { help, variation, label, placeholder, types },
+		positionals: [sliceId, fieldId],
+	} = parseArgs({
+		args: process.argv.slice(5), // skip: node, script, "slice", "add-field", "number"
+		options: {
+			variation: { type: "string", short: "v" },
+			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 (!sliceId) {
+		console.error("Missing required argument: slice-id\n");
+		console.error("Usage: prismic slice add-field number <slice-id> <field-id>");
+		process.exitCode = 1;
+		return;
+	}
+
+	if (!fieldId) {
+		console.error("Missing required argument: field-id\n");
+		console.error("Usage: prismic slice add-field number <slice-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 slice model
+	const framework = await requireFramework();
+	if (!framework) return;
+
+	let model: SharedSlice;
+	try {
+		model = await framework.readSlice(sliceId);
+	} catch {
+		console.error(`Slice not found: ${sliceId}\n\nCreate it first with: prismic slice create ${sliceId}`);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Check for variations
+	if (model.variations.length === 0) {
+		console.error(`Slice "${sliceId}" has no variations.\n`);
+		console.error("Add a variation first before adding fields.");
+		process.exitCode = 1;
+		return;
+	}
+
+	// Find target variation
+	const targetVariation = variation
+		? model.variations.find((v) => v.id === variation)
+		: model.variations[0];
+
+	if (!targetVariation) {
+		console.error(`Variation "${variation}" not found in slice "${sliceId}"\n`);
+		console.error(`Available variations: ${model.variations.map((v) => v.id).join(", ")}`);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Initialize primary if it doesn't exist
+	if (!targetVariation.primary) {
+		targetVariation.primary = {};
+	}
+
+	// Build field definition
+	const fieldDefinition: Number = {
+		type: "Number",
+		config: {
+			label: label ?? humanReadable(fieldPath.type === "nested" ? fieldPath.nestedFieldId : fieldId),
+			...(placeholder && { placeholder }),
+		},
+	};
+
+	// Add field to variation (with nested field support)
+	if (fieldPath.type === "nested") {
+		const groupResult = findGroupInVariation(targetVariation.primary, fieldPath.groupId, targetVariation.id);
+		if (!groupResult.ok) {
+			console.error(groupResult.error);
+			process.exitCode = 1;
+			return;
+		}
+		// Check if nested field already exists
+		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 variation (at top level or in groups)
+		for (const v of model.variations) {
+			if (v.primary?.[fieldId]) {
+				console.error(`Field "${fieldId}" already exists in variation "${v.id}"`);
+				process.exitCode = 1;
+				return;
+			}
+			// Also check inside groups
+			for (const [groupFieldId, groupField] of Object.entries(v.primary ?? {})) {
+				if (isGroupField(groupField) && groupField.config.fields[fieldId]) {
+					console.error(
+						`Field "${fieldId}" already exists in group "${groupFieldId}" in variation "${v.id}"`,
+					);
+					process.exitCode = 1;
+					return;
+				}
+			}
+		}
+		targetVariation.primary[fieldId] = fieldDefinition;
+	}
+
+	// Write updated model
+	try {
+		await framework.updateSlice(model);
+	} catch (error) {
+		if (error instanceof Error) {
+			console.error(`Failed to update slice: ${error.message}`);
+		} else {
+			console.error("Failed to update slice");
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	if (fieldPath.type === "nested") {
+		console.info(
+			`Added field "${fieldPath.nestedFieldId}" (Number) to group "${fieldPath.groupId}" in ${sliceId}`,
+		);
+	} else {
+		console.info(
+			`Added field "${fieldId}" (Number) to "${targetVariation.id}" variation in ${sliceId}`,
+		);
+	}
+
+	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 slice add-field`");
+
+	if (framework) {
+		const docsPath = getDocsPath(framework.id);
+		const anchor = getWriteComponentsAnchor(framework.id);
+		console.info(
+			`      Run \`prismic docs fetch ${docsPath}${anchor}\` to learn how to implement the slice's component`,
+		);
+	}
+}

package/src/slice-add-field-rich-text.ts

@@ -0,0 +1,229 @@
+import type { RichText, SharedSlice } from "@prismicio/types-internal/lib/customtypes";
+
+import { parseArgs } from "node:util";
+
+import { buildTypes } from "./codegen-types";
+import { findGroupInVariation, isGroupField, parseFieldPath, validateNestedFieldPath } from "./lib/field-path";
+import { getDocsPath, getWriteComponentsAnchor, requireFramework } from "./framework";
+import { humanReadable } from "./lib/string";
+
+const HELP = `
+Add a rich text field to an existing slice.
+
+USAGE
+  prismic slice add-field rich-text <slice-id> <field-id> [flags]
+
+ARGUMENTS
+  slice-id               Slice identifier (required)
+  field-id               Field identifier (required)
+
+FLAGS
+  -v, --variation string Target variation (default: first variation)
+  -l, --label string     Display label for the field (inferred from field-id if omitted)
+  -p, --placeholder string Placeholder text
+      --single string    Allowed block types for single-line (comma-separated)
+      --multi string     Allowed block types for multi-line (comma-separated)
+      --allow-target-blank Allow opening links in new tab
+      --types string   Output file for generated types (default: "prismicio-types.d.ts")
+  -h, --help             Show help for command
+
+BLOCK TYPES
+  heading1, heading2, heading3, heading4, heading5, heading6,
+  paragraph, strong, em, preformatted, hyperlink, image, embed,
+  list-item, o-list-item, rtl
+
+EXAMPLES
+  prismic slice add-field rich-text my_slice body
+  prismic slice add-field rich-text article content --multi "paragraph,heading2,heading3,strong,em,hyperlink"
+  prismic slice add-field rich-text hero tagline --single "heading1"
+  prismic slice add-field rich-text blog post --multi "paragraph,strong,em,hyperlink" --allow-target-blank
+`.trim();
+
+
+
+export async function sliceAddFieldRichText(): Promise<void> {
+	const {
+		values: {
+			help,
+			variation,
+			label,
+			placeholder,
+			single,
+			multi,
+			"allow-target-blank": allowTargetBlank,
+			types,
+		},
+		positionals: [sliceId, fieldId],
+	} = parseArgs({
+		args: process.argv.slice(5), // skip: node, script, "slice", "add-field", "rich-text"
+		options: {
+			variation: { type: "string", short: "v" },
+			label: { type: "string", short: "l" },
+			placeholder: { type: "string", short: "p" },
+			single: { type: "string" },
+			multi: { type: "string" },
+			"allow-target-blank": { type: "boolean" },
+			types: { type: "string" },
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+	});
+
+	if (help) {
+		console.info(HELP);
+		return;
+	}
+
+	if (!sliceId) {
+		console.error("Missing required argument: slice-id\n");
+		console.error("Usage: prismic slice add-field rich-text <slice-id> <field-id>");
+		process.exitCode = 1;
+		return;
+	}
+
+	if (!fieldId) {
+		console.error("Missing required argument: field-id\n");
+		console.error("Usage: prismic slice add-field rich-text <slice-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 slice model
+	const framework = await requireFramework();
+	if (!framework) return;
+
+	let model: SharedSlice;
+	try {
+		model = await framework.readSlice(sliceId);
+	} catch {
+		console.error(`Slice not found: ${sliceId}\n\nCreate it first with: prismic slice create ${sliceId}`);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Check for variations
+	if (model.variations.length === 0) {
+		console.error(`Slice "${sliceId}" has no variations.\n`);
+		console.error("Add a variation first before adding fields.");
+		process.exitCode = 1;
+		return;
+	}
+
+	// Find target variation
+	const targetVariation = variation
+		? model.variations.find((v) => v.id === variation)
+		: model.variations[0];
+
+	if (!targetVariation) {
+		console.error(`Variation "${variation}" not found in slice "${sliceId}"\n`);
+		console.error(`Available variations: ${model.variations.map((v) => v.id).join(", ")}`);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Initialize primary if it doesn't exist
+	if (!targetVariation.primary) {
+		targetVariation.primary = {};
+	}
+
+	// Build field definition
+	const fieldDefinition: RichText = {
+		type: "StructuredText",
+		config: {
+			label: label ?? humanReadable(fieldPath.type === "nested" ? fieldPath.nestedFieldId : fieldId),
+			...(placeholder && { placeholder }),
+			...(single && { single }),
+			...(multi && { multi }),
+			...(allowTargetBlank && { allowTargetBlank: true }),
+		},
+	};
+
+	// Add field to variation (with nested field support)
+	if (fieldPath.type === "nested") {
+		const groupResult = findGroupInVariation(targetVariation.primary, fieldPath.groupId, targetVariation.id);
+		if (!groupResult.ok) {
+			console.error(groupResult.error);
+			process.exitCode = 1;
+			return;
+		}
+		// Check if nested field already exists
+		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 variation (at top level or in groups)
+		for (const v of model.variations) {
+			if (v.primary?.[fieldId]) {
+				console.error(`Field "${fieldId}" already exists in variation "${v.id}"`);
+				process.exitCode = 1;
+				return;
+			}
+			// Also check inside groups
+			for (const [groupFieldId, groupField] of Object.entries(v.primary ?? {})) {
+				if (isGroupField(groupField) && groupField.config.fields[fieldId]) {
+					console.error(
+						`Field "${fieldId}" already exists in group "${groupFieldId}" in variation "${v.id}"`,
+					);
+					process.exitCode = 1;
+					return;
+				}
+			}
+		}
+		targetVariation.primary[fieldId] = fieldDefinition;
+	}
+
+	// Write updated model
+	try {
+		await framework.updateSlice(model);
+	} catch (error) {
+		if (error instanceof Error) {
+			console.error(`Failed to update slice: ${error.message}`);
+		} else {
+			console.error("Failed to update slice");
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	if (fieldPath.type === "nested") {
+		console.info(
+			`Added field "${fieldPath.nestedFieldId}" (StructuredText) to group "${fieldPath.groupId}" in ${sliceId}`,
+		);
+	} else {
+		console.info(
+			`Added field "${fieldId}" (StructuredText) to "${targetVariation.id}" variation in ${sliceId}`,
+		);
+	}
+
+	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 slice add-field`");
+
+	if (framework) {
+		const docsPath = getDocsPath(framework.id);
+		const anchor = getWriteComponentsAnchor(framework.id);
+		console.info(
+			`      Run \`prismic docs fetch ${docsPath}${anchor}\` to learn how to implement the slice's component`,
+		);
+	}
+}

package/src/slice-add-field-select.ts

@@ -0,0 +1,211 @@
+import type { Select, SharedSlice } from "@prismicio/types-internal/lib/customtypes";
+
+import { parseArgs } from "node:util";
+
+import { buildTypes } from "./codegen-types";
+import { findGroupInVariation, isGroupField, parseFieldPath, validateNestedFieldPath } from "./lib/field-path";
+import { getDocsPath, getWriteComponentsAnchor, requireFramework } from "./framework";
+import { humanReadable } from "./lib/string";
+
+const HELP = `
+Add a select (dropdown) field to an existing slice.
+
+USAGE
+  prismic slice add-field select <slice-id> <field-id> [flags]
+
+ARGUMENTS
+  slice-id               Slice identifier (required)
+  field-id               Field identifier (required)
+
+FLAGS
+  -v, --variation string Target variation (default: first variation)
+  -l, --label string     Display label for the field (inferred from field-id if omitted)
+  -p, --placeholder string Placeholder text
+      --option string    Add an option (can be used multiple times)
+      --default string   Default selected value
+      --types string   Output file for generated types (default: "prismicio-types.d.ts")
+  -h, --help             Show help for command
+
+EXAMPLES
+  prismic slice add-field select my_slice layout --option "full" --option "sidebar"
+  prismic slice add-field select hero style --option "light" --option "dark" --default "light"
+  prismic slice add-field select product size --option "small" --option "medium" --option "large" --label "Size"
+`.trim();
+
+
+
+export async function sliceAddFieldSelect(): Promise<void> {
+	const {
+		values: { help, variation, label, placeholder, option, default: defaultValue, types },
+		positionals: [sliceId, fieldId],
+	} = parseArgs({
+		args: process.argv.slice(5), // skip: node, script, "slice", "add-field", "select"
+		options: {
+			variation: { type: "string", short: "v" },
+			label: { type: "string", short: "l" },
+			placeholder: { type: "string", short: "p" },
+			option: { type: "string", multiple: true },
+			default: { type: "string" },
+			types: { type: "string" },
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+	});
+
+	if (help) {
+		console.info(HELP);
+		return;
+	}
+
+	if (!sliceId) {
+		console.error("Missing required argument: slice-id\n");
+		console.error("Usage: prismic slice add-field select <slice-id> <field-id>");
+		process.exitCode = 1;
+		return;
+	}
+
+	if (!fieldId) {
+		console.error("Missing required argument: field-id\n");
+		console.error("Usage: prismic slice add-field select <slice-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 slice model
+	const framework = await requireFramework();
+	if (!framework) return;
+
+	let model: SharedSlice;
+	try {
+		model = await framework.readSlice(sliceId);
+	} catch {
+		console.error(`Slice not found: ${sliceId}\n\nCreate it first with: prismic slice create ${sliceId}`);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Check for variations
+	if (model.variations.length === 0) {
+		console.error(`Slice "${sliceId}" has no variations.\n`);
+		console.error("Add a variation first before adding fields.");
+		process.exitCode = 1;
+		return;
+	}
+
+	// Find target variation
+	const targetVariation = variation
+		? model.variations.find((v) => v.id === variation)
+		: model.variations[0];
+
+	if (!targetVariation) {
+		console.error(`Variation "${variation}" not found in slice "${sliceId}"\n`);
+		console.error(`Available variations: ${model.variations.map((v) => v.id).join(", ")}`);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Initialize primary if it doesn't exist
+	if (!targetVariation.primary) {
+		targetVariation.primary = {};
+	}
+
+	// Build field definition
+	const fieldDefinition: Select = {
+		type: "Select",
+		config: {
+			label: label ?? humanReadable(fieldPath.type === "nested" ? fieldPath.nestedFieldId : fieldId),
+			...(placeholder && { placeholder }),
+			...(option && option.length > 0 && { options: option }),
+			...(defaultValue && { default_value: defaultValue }),
+		},
+	};
+
+	// Add field to variation (with nested field support)
+	if (fieldPath.type === "nested") {
+		const groupResult = findGroupInVariation(targetVariation.primary, fieldPath.groupId, targetVariation.id);
+		if (!groupResult.ok) {
+			console.error(groupResult.error);
+			process.exitCode = 1;
+			return;
+		}
+		// Check if nested field already exists
+		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 variation (at top level or in groups)
+		for (const v of model.variations) {
+			if (v.primary?.[fieldId]) {
+				console.error(`Field "${fieldId}" already exists in variation "${v.id}"`);
+				process.exitCode = 1;
+				return;
+			}
+			// Also check inside groups
+			for (const [groupFieldId, groupField] of Object.entries(v.primary ?? {})) {
+				if (isGroupField(groupField) && groupField.config.fields[fieldId]) {
+					console.error(
+						`Field "${fieldId}" already exists in group "${groupFieldId}" in variation "${v.id}"`,
+					);
+					process.exitCode = 1;
+					return;
+				}
+			}
+		}
+		targetVariation.primary[fieldId] = fieldDefinition;
+	}
+
+	// Write updated model
+	try {
+		await framework.updateSlice(model);
+	} catch (error) {
+		if (error instanceof Error) {
+			console.error(`Failed to update slice: ${error.message}`);
+		} else {
+			console.error("Failed to update slice");
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	if (fieldPath.type === "nested") {
+		console.info(
+			`Added field "${fieldPath.nestedFieldId}" (Select) to group "${fieldPath.groupId}" in ${sliceId}`,
+		);
+	} else {
+		console.info(
+			`Added field "${fieldId}" (Select) to "${targetVariation.id}" variation in ${sliceId}`,
+		);
+	}
+
+	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 slice add-field`");
+
+	if (framework) {
+		const docsPath = getDocsPath(framework.id);
+		const anchor = getWriteComponentsAnchor(framework.id);
+		console.info(
+			`      Run \`prismic docs fetch ${docsPath}${anchor}\` to learn how to implement the slice's component`,
+		);
+	}
+}