@angeloashmore/prismic-cli-poc 0.0.0-canary.1d36cd8

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

@@ -0,0 +1,183 @@
+import type { RichText, SharedSlice } from "@prismicio/types-internal/lib/customtypes";
+
+import { writeFile } from "node:fs/promises";
+import { parseArgs } from "node:util";
+
+import { buildTypes } from "./codegen-types";
+import { stringify } from "./lib/json";
+import { findSliceModel } from "./lib/slice";
+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)
+
+Types are generated by default after changes. Use --no-types to skip.
+
+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")
+      --no-types       Skip type generation
+  -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,
+			"no-types": noTypes,
+		},
+		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" },
+			"no-types": { type: "boolean" },
+			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;
+	}
+
+	// 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 = {};
+	}
+
+	// Check if field already exists in any variation
+	for (const v of model.variations) {
+		if (v.primary?.[fieldId]) {
+			console.error(`Field "${fieldId}" already exists in variation "${v.id}"`);
+			process.exitCode = 1;
+			return;
+		}
+	}
+
+	// Build field definition
+	const fieldDefinition: RichText = {
+		type: "StructuredText",
+		config: {
+			label: label ?? humanReadable(fieldId),
+			...(placeholder && { placeholder }),
+			...(single && { single }),
+			...(multi && { multi }),
+			...(allowTargetBlank && { allowTargetBlank: true }),
+		},
+	};
+
+	// Add field to variation
+	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;
+	}
+
+	console.info(
+		`Added field "${fieldId}" (StructuredText) to "${targetVariation.id}" variation in ${sliceId}`,
+	);
+
+	if (!noTypes) {
+		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`");
+	console.info("      Run `prismic status` when done to find next steps");
+}

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

@@ -0,0 +1,173 @@
+import type { Select, SharedSlice } from "@prismicio/types-internal/lib/customtypes";
+
+import { writeFile } from "node:fs/promises";
+import { parseArgs } from "node:util";
+
+import { buildTypes } from "./codegen-types";
+import { stringify } from "./lib/json";
+import { findSliceModel } from "./lib/slice";
+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)
+
+Types are generated by default after changes. Use --no-types to skip.
+
+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")
+      --no-types       Skip type generation
+  -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,
+			"no-types": noTypes,
+		},
+		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" },
+			"no-types": { type: "boolean" },
+			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;
+	}
+
+	// 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 = {};
+	}
+
+	// Check if field already exists in any variation
+	for (const v of model.variations) {
+		if (v.primary?.[fieldId]) {
+			console.error(`Field "${fieldId}" already exists in variation "${v.id}"`);
+			process.exitCode = 1;
+			return;
+		}
+	}
+
+	// Build field definition
+	const fieldDefinition: Select = {
+		type: "Select",
+		config: {
+			label: label ?? humanReadable(fieldId),
+			...(placeholder && { placeholder }),
+			...(option && option.length > 0 && { options: option }),
+			...(defaultValue && { default_value: defaultValue }),
+		},
+	};
+
+	// Add field to variation
+	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;
+	}
+
+	console.info(
+		`Added field "${fieldId}" (Select) to "${targetVariation.id}" variation in ${sliceId}`,
+	);
+
+	if (!noTypes) {
+		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`");
+	console.info("      Run `prismic status` when done to find next steps");
+}

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

@@ -0,0 +1,158 @@
+import type { SharedSlice, Timestamp } from "@prismicio/types-internal/lib/customtypes";
+
+import { writeFile } from "node:fs/promises";
+import { parseArgs } from "node:util";
+
+import { buildTypes } from "./codegen-types";
+import { stringify } from "./lib/json";
+import { findSliceModel } from "./lib/slice";
+import { humanReadable } from "./lib/string";
+
+const HELP = `
+Add a timestamp (date and time) field to an existing slice.
+
+USAGE
+  prismic slice add-field timestamp <slice-id> <field-id> [flags]
+
+ARGUMENTS
+  slice-id               Slice identifier (required)
+  field-id               Field identifier (required)
+
+Types are generated by default after changes. Use --no-types to skip.
+
+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")
+      --no-types       Skip type generation
+  -h, --help             Show help for command
+
+EXAMPLES
+  prismic slice add-field timestamp my_slice created_at
+  prismic slice add-field timestamp event start_time --label "Event Start"
+  prismic slice add-field timestamp schedule meeting_time --variation "detailed"
+`.trim();
+
+export async function sliceAddFieldTimestamp(): Promise<void> {
+	const {
+		values: { help, variation, label, placeholder, types, "no-types": noTypes },
+		positionals: [sliceId, fieldId],
+	} = parseArgs({
+		args: process.argv.slice(5), // skip: node, script, "slice", "add-field", "timestamp"
+		options: {
+			variation: { type: "string", short: "v" },
+			label: { type: "string", short: "l" },
+			placeholder: { type: "string", short: "p" },
+			types: { type: "string" },
+			"no-types": { type: "boolean" },
+			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 timestamp <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 timestamp <slice-id> <field-id>");
+		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 = {};
+	}
+
+	// Check if field already exists in any variation
+	for (const v of model.variations) {
+		if (v.primary?.[fieldId]) {
+			console.error(`Field "${fieldId}" already exists in variation "${v.id}"`);
+			process.exitCode = 1;
+			return;
+		}
+	}
+
+	// Build field definition
+	const fieldDefinition: Timestamp = {
+		type: "Timestamp",
+		config: {
+			label: label ?? humanReadable(fieldId),
+			...(placeholder && { placeholder }),
+		},
+	};
+
+	// Add field to variation
+	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;
+	}
+
+	console.info(
+		`Added field "${fieldId}" (Timestamp) to "${targetVariation.id}" variation in ${sliceId}`,
+	);
+
+	if (!noTypes) {
+		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`");
+	console.info("      Run `prismic status` when done to find next steps");
+}

package/src/slice-add-field.ts

@@ -0,0 +1,106 @@
+import { parseArgs } from "node:util";
+
+import { sliceAddFieldBoolean } from "./slice-add-field-boolean";
+import { sliceAddFieldColor } from "./slice-add-field-color";
+import { sliceAddFieldDate } from "./slice-add-field-date";
+import { sliceAddFieldEmbed } from "./slice-add-field-embed";
+import { sliceAddFieldGeoPoint } from "./slice-add-field-geo-point";
+import { sliceAddFieldImage } from "./slice-add-field-image";
+import { sliceAddFieldKeyText } from "./slice-add-field-key-text";
+import { sliceAddFieldLink } from "./slice-add-field-link";
+import { sliceAddFieldNumber } from "./slice-add-field-number";
+import { sliceAddFieldRichText } from "./slice-add-field-rich-text";
+import { sliceAddFieldSelect } from "./slice-add-field-select";
+import { sliceAddFieldTimestamp } from "./slice-add-field-timestamp";
+
+const HELP = `
+Add a field to an existing slice.
+
+USAGE
+  prismic slice add-field <field-type> <slice-id> <field-id> [flags]
+
+FIELD TYPES
+  boolean                Boolean toggle
+  color                  Color picker
+  date                   Date picker
+  embed                  Embed (oEmbed)
+  geo-point              Geographic coordinates
+  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
+
+FLAGS
+  -h, --help             Show help for command
+
+LEARN MORE
+  Use \`prismic slice add-field <field-type> --help\` for more information.
+
+EXAMPLES
+  prismic slice add-field key-text my_slice title --label "Title"
+  prismic slice add-field link my_slice cta --allow-text
+  prismic slice add-field rich-text my_slice body --multi "paragraph,heading2,strong,em"
+  prismic slice add-field select my_slice layout --option "full" --option "sidebar"
+`.trim();
+
+export async function sliceAddField(): Promise<void> {
+	const {
+		positionals: [fieldType],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "slice", "add-field"
+		options: {
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+		strict: false,
+	});
+
+	switch (fieldType) {
+		case "boolean":
+			await sliceAddFieldBoolean();
+			break;
+		case "color":
+			await sliceAddFieldColor();
+			break;
+		case "date":
+			await sliceAddFieldDate();
+			break;
+		case "embed":
+			await sliceAddFieldEmbed();
+			break;
+		case "geo-point":
+			await sliceAddFieldGeoPoint();
+			break;
+		case "image":
+			await sliceAddFieldImage();
+			break;
+		case "key-text":
+			await sliceAddFieldKeyText();
+			break;
+		case "link":
+			await sliceAddFieldLink();
+			break;
+		case "number":
+			await sliceAddFieldNumber();
+			break;
+		case "rich-text":
+			await sliceAddFieldRichText();
+			break;
+		case "select":
+			await sliceAddFieldSelect();
+			break;
+		case "timestamp":
+			await sliceAddFieldTimestamp();
+			break;
+		default: {
+			if (fieldType) {
+				console.error(`Unknown field type: ${fieldType}\n`);
+				process.exitCode = 1;
+			}
+			console.info(HELP);
+		}
+	}
+}