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

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

@@ -0,0 +1,226 @@
+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 { 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 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)
+
+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 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();
+
+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 sliceAddFieldTimestamp(): Promise<void> {
+	const {
+		values: { help, variation, label, placeholder, types },
+		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" },
+			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;
+	}
+
+	// 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: Timestamp = {
+		type: "Timestamp",
+		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}" (Timestamp) to group "${fieldPath.groupId}" in ${sliceId}`,
+		);
+	} else {
+		console.info(
+			`Added field "${fieldId}" (Timestamp) 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.ts

@@ -0,0 +1,111 @@
+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 { sliceAddFieldGroup } from "./slice-add-field-group";
+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
+  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
+
+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 "group":
+			await sliceAddFieldGroup();
+			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);
+		}
+	}
+}

package/src/slice-add-variation.ts

@@ -0,0 +1,139 @@
+import type { 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, pascalCase } from "./lib/slice";
+
+const HELP = `
+Add a new variation to a slice.
+
+USAGE
+  prismic slice add-variation <slice-id> <variation-id> [flags]
+
+ARGUMENTS
+  slice-id       Slice identifier (required)
+  variation-id   New variation identifier (required)
+
+FLAGS
+  --name string       Display name for the variation
+  --copy-from string  Copy fields from an existing variation
+      --types string   Output file for generated types (default: "prismicio-types.d.ts")
+  -h, --help          Show help for command
+
+EXAMPLES
+  prismic slice add-variation MySlice withImage
+  prismic slice add-variation MySlice withImage --name "With Image"
+  prismic slice add-variation MySlice withImage --copy-from default
+`.trim();
+
+export async function sliceAddVariation(): Promise<void> {
+	const {
+		values: { help, name, "copy-from": copyFrom, types },
+		positionals: [sliceId, variationId],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "slice", "add-variation"
+		options: {
+			name: { type: "string" },
+			"copy-from": { 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-variation <slice-id> <variation-id>");
+		process.exitCode = 1;
+		return;
+	}
+
+	if (!variationId) {
+		console.error("Missing required argument: variation-id\n");
+		console.error("Usage: prismic slice add-variation <slice-id> <variation-id>");
+		process.exitCode = 1;
+		return;
+	}
+
+	const result = await findSliceModel(sliceId);
+	if (!result.ok) {
+		console.error(result.error);
+		process.exitCode = 1;
+		return;
+	}
+
+	const { model, modelPath } = result;
+
+	// Check if variation already exists
+	if (model.variations.some((v) => v.id === variationId)) {
+		console.error(`Variation "${variationId}" already exists in slice "${sliceId}"`);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Build new variation
+	let newVariation: SharedSlice["variations"][number];
+
+	if (copyFrom) {
+		const sourceVariation = model.variations.find((v) => v.id === copyFrom);
+		if (!sourceVariation) {
+			console.error(`Source variation not found: ${copyFrom}`);
+			console.error(`Available variations: ${model.variations.map((v) => v.id).join(", ")}`);
+			process.exitCode = 1;
+			return;
+		}
+
+		newVariation = {
+			...structuredClone(sourceVariation),
+			id: variationId,
+			name: name ?? pascalCase(variationId),
+		};
+	} else {
+		newVariation = {
+			id: variationId,
+			name: name ?? pascalCase(variationId),
+			description: variationId,
+			imageUrl: "",
+			docURL: "",
+			version: "initial",
+			primary: {},
+			items: {},
+		};
+	}
+
+	// Add variation to model
+	const updatedModel = {
+		...model,
+		variations: [...model.variations, newVariation],
+	};
+
+	// Write updated model
+	try {
+		await writeFile(modelPath, stringify(updatedModel 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 variation "${variationId}" to slice "${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}`);
+	}
+}

package/src/slice-create.ts

@@ -0,0 +1,203 @@
+import type { SharedSlice } from "@prismicio/types-internal/lib/customtypes";
+
+import { mkdir, readFile, writeFile } from "node:fs/promises";
+import { parseArgs } from "node:util";
+import * as v from "valibot";
+
+import { buildTypes } from "./codegen-types";
+import { isAuthenticated } from "./lib/auth";
+import { safeGetRepositoryFromConfig } from "./lib/config";
+import { exists, findUpward } from "./lib/file";
+import { stringify } from "./lib/json";
+import { uploadScreenshot } from "./slice-set-screenshot";
+
+const HELP = `
+Create a new slice in a Prismic project.
+
+USAGE
+  prismic slice create <id> [flags]
+
+ARGUMENTS
+  id       Slice identifier (required)
+
+FLAGS
+  -n, --name string        Display name for the slice
+      --screenshot string  Path to screenshot image for default variation
+  -r, --repo string        Repository name (required for screenshot)
+      --types string       Output file for generated types (default: "prismicio-types.d.ts")
+  -h, --help               Show help for command
+
+LEARN MORE
+  Use \`prismic slice <command> --help\` for more information about a command.
+`.trim();
+
+export async function sliceCreate(): Promise<void> {
+	const {
+		values: { help, name, types, screenshot, repo: repoFlag },
+		positionals: [id],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "slice", "create"
+		options: {
+			name: { type: "string", short: "n" },
+			screenshot: { type: "string" },
+			repo: { type: "string", short: "r" },
+			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;
+	}
+
+	// Handle screenshot upload if provided
+	let screenshotUrl: string | undefined;
+	if (screenshot) {
+		// Check authentication
+		const authenticated = await isAuthenticated();
+		if (!authenticated) {
+			console.error("You must be logged in to upload a screenshot.");
+			console.error("Run `prismic login` to authenticate.");
+			process.exitCode = 1;
+			return;
+		}
+
+		// Resolve repository
+		const repo = repoFlag ?? (await safeGetRepositoryFromConfig());
+		if (!repo) {
+			console.error("Could not determine repository for screenshot upload.");
+			console.error("Use --repo flag or run from a directory with prismic.config.json");
+			process.exitCode = 1;
+			return;
+		}
+
+		// Read and upload the screenshot
+		let imageData: Buffer;
+		try {
+			imageData = await readFile(screenshot);
+		} catch (error) {
+			if (error instanceof Error) {
+				console.error(`Failed to read screenshot file: ${error.message}`);
+			} else {
+				console.error("Failed to read screenshot file");
+			}
+			process.exitCode = 1;
+			return;
+		}
+
+		try {
+			screenshotUrl = await uploadScreenshot({
+				data: imageData,
+				repo,
+				sliceId: id,
+				variationId: "default",
+				filename: screenshot,
+			});
+		} catch (error) {
+			if (error instanceof Error) {
+				console.error(`Failed to upload screenshot: ${error.message}`);
+			} else {
+				console.error("Failed to upload screenshot");
+			}
+			process.exitCode = 1;
+			return;
+		}
+	}
+
+	const model: SharedSlice = {
+		id,
+		type: "SharedSlice",
+		name: name ?? pascalCase(id),
+		description: "",
+		variations: [
+			{
+				id: "default",
+				name: "Default",
+				description: "Default",
+				imageUrl: screenshotUrl ?? "",
+				docURL: "",
+				version: "initial",
+				primary: {},
+				items: {},
+			},
+		],
+	};
+
+	const slicesDirectory = await getSlicesDirectory();
+	const sliceDirectory = new URL(pascalCase(model.name) + "/", slicesDirectory);
+	const modelPath = new URL("model.json", sliceDirectory);
+
+	try {
+		await mkdir(new URL(".", modelPath), { recursive: true });
+		await writeFile(modelPath, stringify(model));
+	} catch (error) {
+		if (error instanceof Error) {
+			console.error(`Failed to create slice: ${error.message}`);
+		} else {
+			console.error(`Failed to create slice`);
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	console.info(`Created slice at ${modelPath.href}`);
+
+	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 slice add-field`");
+}
+
+async function getSlicesDirectory(): Promise<URL> {
+	const framework = await detectFramework();
+	const projectRoot = await findUpward("package.json");
+	switch (framework) {
+		case "next": {
+			const hasSrcDir = await exists(new URL("src", projectRoot));
+			if (hasSrcDir) return new URL("src/slices/", projectRoot);
+		}
+		case "nuxt": {
+			const hasAppDir = await exists(new URL("app", projectRoot));
+			if (hasAppDir) return new URL("app/slices/", projectRoot);
+		}
+		case "sveltekit": {
+			return new URL("src/slices/", projectRoot);
+		}
+	}
+	return new URL("slices/", projectRoot);
+}
+
+const PackageJsonSchema = v.object({
+	dependencies: v.optional(v.record(v.string(), v.string())),
+});
+
+type Framework = "next" | "nuxt" | "sveltekit";
+
+async function detectFramework(): Promise<Framework | undefined> {
+	const packageJsonPath = await findUpward("package.json");
+	if (!packageJsonPath) return;
+	try {
+		const contents = await readFile(packageJsonPath, "utf8");
+		const { dependencies = {} } = v.parse(PackageJsonSchema, JSON.parse(contents));
+		if ("next" in dependencies) return "next";
+		if ("nuxt" in dependencies) return "nuxt";
+		if ("@sveltejs/kit" in dependencies) return "sveltekit";
+	} catch {}
+}
+
+function pascalCase(input: string): string {
+	return input.toLowerCase().replace(/(^|[-_\s]+)(.)?/g, (_, __, c) => c?.toUpperCase() ?? "");
+}