@angeloashmore/prismic-cli-poc 0.0.0-canary.1143872

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

@@ -0,0 +1,223 @@
+import type { Image, SharedSlice } from "@prismicio/types-internal/lib/customtypes";
+
+import { writeFile } from "node:fs/promises";
+import { parseArgs } from "node:util";
+
+import { buildTypes } from "./codegen-types";
+import { findGroupInVariation, isGroupField, parseFieldPath, validateNestedFieldPath } from "./lib/field-path";
+import { type Framework, detectFrameworkInfo } from "./lib/framework";
+import { stringify } from "./lib/json";
+import { findSliceModel } from "./lib/slice";
+import { humanReadable } from "./lib/string";
+
+const HELP = `
+Add an image field to an existing slice.
+
+USAGE
+  prismic slice add-field image <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)
+      --types string   Output file for generated types (default: "prismicio-types.d.ts")
+  -h, --help             Show help for command
+
+EXAMPLES
+  prismic slice add-field image my_slice background
+  prismic slice add-field image hero banner --label "Hero Banner"
+  prismic slice add-field image gallery thumbnail --variation "grid"
+`.trim();
+
+function getDocsPath(framework: Framework): string {
+	switch (framework) {
+		case "next":
+			return "nextjs/with-cli";
+		case "nuxt":
+			return "nuxt/with-cli";
+		case "sveltekit":
+			return "sveltekit/with-cli";
+	}
+}
+
+function getWriteComponentsAnchor(framework: Framework): string {
+	switch (framework) {
+		case "nuxt":
+			return "#write-vue-components";
+		case "sveltekit":
+			return "#write-svelte-components";
+		default:
+			return "#write-react-components";
+	}
+}
+
+export async function sliceAddFieldImage(): Promise<void> {
+	const {
+		values: { help, variation, label, types },
+		positionals: [sliceId, fieldId],
+	} = parseArgs({
+		args: process.argv.slice(5), // skip: node, script, "slice", "add-field", "image"
+		options: {
+			variation: { type: "string", short: "v" },
+			label: { type: "string", short: "l" },
+			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 image <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 image <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 result = await findSliceModel(sliceId);
+	if (!result.ok) {
+		console.error(result.error);
+		process.exitCode = 1;
+		return;
+	}
+
+	const { model, modelPath } = result;
+
+	// 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: Image = {
+		type: "Image",
+		config: {
+			label: label ?? humanReadable(fieldPath.type === "nested" ? fieldPath.nestedFieldId : fieldId),
+		},
+	};
+
+	// 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 writeFile(modelPath, stringify(model as SharedSlice));
+	} 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}" (Image) to group "${fieldPath.groupId}" in ${sliceId}`,
+		);
+	} else {
+		console.info(
+			`Added field "${fieldId}" (Image) 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`");
+
+	const frameworkInfo = await detectFrameworkInfo();
+	if (frameworkInfo?.framework) {
+		const docsPath = getDocsPath(frameworkInfo.framework);
+		const anchor = getWriteComponentsAnchor(frameworkInfo.framework);
+		console.info(
+			`      Run \`prismic docs fetch ${docsPath}${anchor}\` to learn how to implement the slice's component`,
+		);
+	}
+}

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

@@ -0,0 +1,226 @@
+import type { SharedSlice, Text } from "@prismicio/types-internal/lib/customtypes";
+
+import { writeFile } from "node:fs/promises";
+import { parseArgs } from "node:util";
+
+import { buildTypes } from "./codegen-types";
+import { findGroupInVariation, isGroupField, parseFieldPath, validateNestedFieldPath } from "./lib/field-path";
+import { type Framework, detectFrameworkInfo } from "./lib/framework";
+import { stringify } from "./lib/json";
+import { findSliceModel } from "./lib/slice";
+import { humanReadable } from "./lib/string";
+
+const HELP = `
+Add a key-text (single-line text) field to an existing slice.
+
+USAGE
+  prismic slice add-field key-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
+      --types string   Output file for generated types (default: "prismicio-types.d.ts")
+  -h, --help             Show help for command
+
+EXAMPLES
+  prismic slice add-field key-text my_slice title
+  prismic slice add-field key-text hero heading --label "Heading"
+  prismic slice add-field key-text cta button_text --placeholder "Enter button text"
+`.trim();
+
+function getDocsPath(framework: Framework): string {
+	switch (framework) {
+		case "next":
+			return "nextjs/with-cli";
+		case "nuxt":
+			return "nuxt/with-cli";
+		case "sveltekit":
+			return "sveltekit/with-cli";
+	}
+}
+
+function getWriteComponentsAnchor(framework: Framework): string {
+	switch (framework) {
+		case "nuxt":
+			return "#write-vue-components";
+		case "sveltekit":
+			return "#write-svelte-components";
+		default:
+			return "#write-react-components";
+	}
+}
+
+export async function sliceAddFieldKeyText(): Promise<void> {
+	const {
+		values: { help, variation, label, placeholder, types },
+		positionals: [sliceId, fieldId],
+	} = parseArgs({
+		args: process.argv.slice(5), // skip: node, script, "slice", "add-field", "key-text"
+		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 key-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 key-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 result = await findSliceModel(sliceId);
+	if (!result.ok) {
+		console.error(result.error);
+		process.exitCode = 1;
+		return;
+	}
+
+	const { model, modelPath } = result;
+
+	// 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: Text = {
+		type: "Text",
+		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 writeFile(modelPath, stringify(model as SharedSlice));
+	} 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}" (Text) to group "${fieldPath.groupId}" in ${sliceId}`,
+		);
+	} else {
+		console.info(
+			`Added field "${fieldId}" (Text) 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`");
+
+	const frameworkInfo = await detectFrameworkInfo();
+	if (frameworkInfo?.framework) {
+		const docsPath = getDocsPath(frameworkInfo.framework);
+		const anchor = getWriteComponentsAnchor(frameworkInfo.framework);
+		console.info(
+			`      Run \`prismic docs fetch ${docsPath}${anchor}\` to learn how to implement the slice's component`,
+		);
+	}
+}

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

@@ -0,0 +1,245 @@
+import type { Link, SharedSlice } from "@prismicio/types-internal/lib/customtypes";
+
+import { writeFile } from "node:fs/promises";
+import { parseArgs } from "node:util";
+
+import { buildTypes } from "./codegen-types";
+import { findGroupInVariation, isGroupField, parseFieldPath, validateNestedFieldPath } from "./lib/field-path";
+import { type Framework, detectFrameworkInfo } from "./lib/framework";
+import { stringify } from "./lib/json";
+import { findSliceModel } from "./lib/slice";
+import { humanReadable } from "./lib/string";
+
+const HELP = `
+Add a link field to an existing slice.
+
+USAGE
+  prismic slice add-field link <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
+      --allow-text         Allow text with link
+      --allow-target-blank Allow opening link in new tab
+      --repeatable         Allow multiple links
+      --types string   Output file for generated types (default: "prismicio-types.d.ts")
+  -h, --help               Show help for command
+
+EXAMPLES
+  prismic slice add-field link my_slice button
+  prismic slice add-field link cta primary_link --allow-text
+  prismic slice add-field link navigation links --repeatable
+  prismic slice add-field link hero cta --allow-text --allow-target-blank
+`.trim();
+
+function getDocsPath(framework: Framework): string {
+	switch (framework) {
+		case "next":
+			return "nextjs/with-cli";
+		case "nuxt":
+			return "nuxt/with-cli";
+		case "sveltekit":
+			return "sveltekit/with-cli";
+	}
+}
+
+function getWriteComponentsAnchor(framework: Framework): string {
+	switch (framework) {
+		case "nuxt":
+			return "#write-vue-components";
+		case "sveltekit":
+			return "#write-svelte-components";
+		default:
+			return "#write-react-components";
+	}
+}
+
+export async function sliceAddFieldLink(): Promise<void> {
+	const {
+		values: {
+			help,
+			variation,
+			label,
+			placeholder,
+			"allow-text": allowText,
+			"allow-target-blank": allowTargetBlank,
+			repeatable,
+			types,
+		},
+		positionals: [sliceId, fieldId],
+	} = parseArgs({
+		args: process.argv.slice(5), // skip: node, script, "slice", "add-field", "link"
+		options: {
+			variation: { type: "string", short: "v" },
+			label: { type: "string", short: "l" },
+			placeholder: { type: "string", short: "p" },
+			"allow-text": { type: "boolean" },
+			"allow-target-blank": { type: "boolean" },
+			repeatable: { 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 link <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 link <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 result = await findSliceModel(sliceId);
+	if (!result.ok) {
+		console.error(result.error);
+		process.exitCode = 1;
+		return;
+	}
+
+	const { model, modelPath } = result;
+
+	// 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: Link = {
+		type: "Link",
+		config: {
+			label: label ?? humanReadable(fieldPath.type === "nested" ? fieldPath.nestedFieldId : fieldId),
+			...(placeholder && { placeholder }),
+			...(allowText && { allowText: true }),
+			...(allowTargetBlank && { allowTargetBlank: true }),
+			...(repeatable && { repeat: 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 writeFile(modelPath, stringify(model as SharedSlice));
+	} 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}" (Link) to group "${fieldPath.groupId}" in ${sliceId}`,
+		);
+	} else {
+		console.info(
+			`Added field "${fieldId}" (Link) 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`");
+
+	const frameworkInfo = await detectFrameworkInfo();
+	if (frameworkInfo?.framework) {
+		const docsPath = getDocsPath(frameworkInfo.framework);
+		const anchor = getWriteComponentsAnchor(frameworkInfo.framework);
+		console.info(
+			`      Run \`prismic docs fetch ${docsPath}${anchor}\` to learn how to implement the slice's component`,
+		);
+	}
+}