prismic 0.0.0-pr.28.59bf330

package/src/custom-type-remove-field.ts

@@ -0,0 +1,135 @@
+import type { CustomType } from "@prismicio/types-internal/lib/customtypes";
+
+import { parseArgs } from "node:util";
+
+import { buildTypes } from "./codegen-types";
+import { requireFramework } from "./framework";
+
+const HELP = `
+Remove a field from a custom type.
+
+USAGE
+  prismic custom-type remove-field <type-id> <field-id> [flags]
+
+ARGUMENTS
+  type-id      Custom type identifier (required)
+  field-id     Field identifier (required)
+
+FLAGS
+  --tab string  Specific tab (searches all tabs if not specified)
+      --types string   Output file for generated types (default: "prismicio-types.d.ts")
+  -h, --help    Show help for command
+
+EXAMPLES
+  prismic custom-type remove-field settings title
+  prismic custom-type remove-field settings description --tab "Content"
+`.trim();
+
+export async function customTypeRemoveField(): Promise<void> {
+	const {
+		values: { help, tab, types },
+		positionals: [typeId, fieldId],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "custom-type", "remove-field"
+		options: {
+			tab: { 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 custom-type remove-field <type-id> <field-id>");
+		process.exitCode = 1;
+		return;
+	}
+
+	if (!fieldId) {
+		console.error("Missing required argument: field-id\n");
+		console.error("Usage: prismic custom-type remove-field <type-id> <field-id>");
+		process.exitCode = 1;
+		return;
+	}
+
+	const framework = await requireFramework();
+	if (!framework) return;
+
+	let model: CustomType;
+	try {
+		model = await framework.readCustomType(typeId);
+	} catch {
+		console.error(`Custom type not found: ${typeId}\n\nCreate it first with: prismic custom-type create ${typeId}`);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Check if this is actually a custom type (not a page type)
+	if (model.format === "page") {
+		console.error(`"${typeId}" is not a custom type (format: page)`);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Find and remove the field
+	let foundTab: string | undefined;
+
+	if (tab) {
+		// Look in specific tab
+		if (!model.json[tab]) {
+			console.error(`Tab "${tab}" not found in custom type "${typeId}"`);
+			console.error(`Available tabs: ${Object.keys(model.json).join(", ")}`);
+			process.exitCode = 1;
+			return;
+		}
+		if (!(fieldId in model.json[tab])) {
+			console.error(`Field "${fieldId}" not found in tab "${tab}"`);
+			process.exitCode = 1;
+			return;
+		}
+		delete model.json[tab][fieldId];
+		foundTab = tab;
+	} else {
+		// Search all tabs
+		for (const [tabName, tabFields] of Object.entries(model.json)) {
+			if (fieldId in tabFields) {
+				delete tabFields[fieldId];
+				foundTab = tabName;
+				break;
+			}
+		}
+		if (!foundTab) {
+			console.error(`Field "${fieldId}" not found in any tab of custom type "${typeId}"`);
+			process.exitCode = 1;
+			return;
+		}
+	}
+
+	// Write updated model
+	try {
+		await framework.updateCustomType(model);
+	} catch (error) {
+		if (error instanceof Error) {
+			console.error(`Failed to update custom type: ${error.message}`);
+		} else {
+			console.error("Failed to update custom type");
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	console.info(`Removed field "${fieldId}" from tab "${foundTab}" in custom type "${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}`);
+	}
+}

package/src/custom-type-remove.ts

@@ -0,0 +1,103 @@
+import type { CustomType } from "@prismicio/types-internal/lib/customtypes";
+
+import { parseArgs } from "node:util";
+
+import { buildTypes } from "./codegen-types";
+import { requireFramework } from "./framework";
+
+const HELP = `
+Remove a custom type from the project.
+
+USAGE
+  prismic custom-type remove <type-id> [flags]
+
+ARGUMENTS
+  type-id      Custom type identifier (required)
+
+FLAGS
+  -y           Confirm removal
+      --types string   Output file for generated types (default: "prismicio-types.d.ts")
+  -h, --help   Show help for command
+
+EXAMPLES
+  prismic custom-type remove settings
+  prismic custom-type remove settings -y
+`.trim();
+
+export async function customTypeRemove(): Promise<void> {
+	const {
+		values: { help, y, types },
+		positionals: [typeId],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "custom-type", "remove"
+		options: {
+			y: { type: "boolean", short: "y" },
+			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 custom-type remove <type-id>");
+		process.exitCode = 1;
+		return;
+	}
+
+	const framework = await requireFramework();
+	if (!framework) return;
+
+	let model: CustomType;
+	try {
+		model = await framework.readCustomType(typeId);
+	} catch {
+		console.error(`Custom type not found: ${typeId}\n\nCreate it first with: prismic custom-type create ${typeId}`);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Check if this is actually a custom type (not a page type)
+	if (model.format === "page") {
+		console.error(`"${typeId}" is not a custom type (format: page)`);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Require -y flag to confirm deletion
+	if (!y) {
+		console.error(
+			`Refusing to remove custom type "${typeId}" (this will delete the entire directory).`,
+		);
+		console.error("Re-run with -y to confirm.");
+		process.exitCode = 1;
+		return;
+	}
+
+	// Delete the custom type directory
+	try {
+		await framework.deleteCustomType(typeId);
+	} catch (error) {
+		if (error instanceof Error) {
+			console.error(`Failed to remove custom type: ${error.message}`);
+		} else {
+			console.error("Failed to remove custom type");
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	console.info(`Removed custom type "${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}`);
+	}
+}

package/src/custom-type-set-name.ts

@@ -0,0 +1,102 @@
+import type { CustomType } from "@prismicio/types-internal/lib/customtypes";
+
+import { parseArgs } from "node:util";
+
+import { buildTypes } from "./codegen-types";
+import { requireFramework } from "./framework";
+
+const HELP = `
+Change a custom type's display name (label).
+
+USAGE
+  prismic custom-type set-name <type-id> <new-name> [flags]
+
+ARGUMENTS
+  type-id      Custom type identifier (required)
+  new-name     New display name (required)
+
+FLAGS
+      --types string   Output file for generated types (default: "prismicio-types.d.ts")
+  -h, --help   Show help for command
+
+EXAMPLES
+  prismic custom-type set-name settings "Site Settings"
+  prismic custom-type set-name menu "Navigation Menu"
+`.trim();
+
+export async function customTypeSetName(): Promise<void> {
+	const {
+		values: { help, types },
+		positionals: [typeId, newName],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "custom-type", "set-name"
+		options: {
+			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 custom-type set-name <type-id> <new-name>");
+		process.exitCode = 1;
+		return;
+	}
+
+	if (!newName) {
+		console.error("Missing required argument: new-name\n");
+		console.error("Usage: prismic custom-type set-name <type-id> <new-name>");
+		process.exitCode = 1;
+		return;
+	}
+
+	const framework = await requireFramework();
+	if (!framework) return;
+
+	let model: CustomType;
+	try {
+		model = await framework.readCustomType(typeId);
+	} catch {
+		console.error(`Custom type not found: ${typeId}\n\nCreate it first with: prismic custom-type create ${typeId}`);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Check if this is actually a custom type (not a page type)
+	if (model.format === "page") {
+		console.error(`"${typeId}" is not a custom type (format: page)`);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Update the model
+	model.label = newName;
+
+	// Write updated model
+	try {
+		await framework.updateCustomType(model);
+	} catch (error) {
+		if (error instanceof Error) {
+			console.error(`Failed to update custom type: ${error.message}`);
+		} else {
+			console.error("Failed to update custom type");
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	console.info(`Renamed custom type "${typeId}" to "${newName}"`);
+
+	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/custom-type-view.ts

@@ -0,0 +1,118 @@
+import type { CustomType } from "@prismicio/types-internal/lib/customtypes";
+
+import { readFile } from "node:fs/promises";
+import { parseArgs } from "node:util";
+import * as v from "valibot";
+
+import { findUpward } from "./lib/file";
+
+const HELP = `
+View details of a specific custom type.
+
+USAGE
+  prismic custom-type view <type-id> [flags]
+
+ARGUMENTS
+  type-id      Custom type identifier (required)
+
+FLAGS
+  --json       Output as JSON
+  -h, --help   Show help for command
+
+EXAMPLES
+  prismic custom-type view settings
+  prismic custom-type view settings --json
+`.trim();
+
+const CustomTypeSchema = v.object({
+	id: v.string(),
+	label: v.string(),
+	repeatable: v.boolean(),
+	status: v.boolean(),
+	format: v.optional(v.string()),
+	json: v.record(v.string(), v.record(v.string(), v.unknown())),
+});
+
+export async function customTypeView(): Promise<void> {
+	const {
+		values: { help, json },
+		positionals: [typeId],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "custom-type", "view"
+		options: {
+			json: { type: "boolean" },
+			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 custom-type view <type-id>");
+		process.exitCode = 1;
+		return;
+	}
+
+	const projectRoot = await findUpward("package.json");
+	if (!projectRoot) {
+		console.error("Could not find project root (no package.json found)");
+		process.exitCode = 1;
+		return;
+	}
+
+	const modelPath = new URL(`customtypes/${typeId}/index.json`, projectRoot);
+
+	let model: CustomType;
+	try {
+		const contents = await readFile(modelPath, "utf8");
+		const result = v.safeParse(CustomTypeSchema, JSON.parse(contents));
+		if (!result.success) {
+			console.error(`Invalid custom type model: ${modelPath.href}`);
+			process.exitCode = 1;
+			return;
+		}
+		model = result.output as CustomType;
+	} catch (error) {
+		if (error instanceof Error && "code" in error && error.code === "ENOENT") {
+			console.error(`Custom type not found: ${typeId}\n`);
+			console.error(`Create it first with: prismic custom-type create ${typeId}`);
+			process.exitCode = 1;
+			return;
+		}
+		if (error instanceof Error) {
+			console.error(`Failed to read custom type: ${error.message}`);
+		} else {
+			console.error("Failed to read custom type");
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	// Check if this is actually a custom type (not a page type)
+	if (model.format === "page") {
+		console.error(`"${typeId}" is not a custom type (format: page)`);
+		process.exitCode = 1;
+		return;
+	}
+
+	if (json) {
+		console.info(JSON.stringify(model, null, 2));
+		return;
+	}
+
+	console.info(`ID:         ${model.id}`);
+	console.info(`Label:      ${model.label}`);
+	console.info(`Repeatable: ${model.repeatable}`);
+
+	const tabs = Object.entries(model.json);
+	console.info(`\nTabs (${tabs.length}):`);
+	for (const [tabName, tabFields] of tabs) {
+		const fieldCount = Object.keys(tabFields).length;
+		console.info(`  - ${tabName}: ${fieldCount} fields`);
+	}
+}

package/src/custom-type.ts

@@ -0,0 +1,85 @@
+import { parseArgs } from "node:util";
+
+import { customTypeAddField } from "./custom-type-add-field";
+import { customTypeConnectSlice } from "./custom-type-connect-slice";
+import { customTypeCreate } from "./custom-type-create";
+import { customTypeDisconnectSlice } from "./custom-type-disconnect-slice";
+import { customTypeList } from "./custom-type-list";
+import { customTypeRemove } from "./custom-type-remove";
+import { customTypeRemoveField } from "./custom-type-remove-field";
+import { customTypeSetName } from "./custom-type-set-name";
+import { customTypeView } from "./custom-type-view";
+
+const HELP = `
+Manage custom types in a Prismic repository.
+
+USAGE
+  prismic custom-type <command> [flags]
+
+COMMANDS
+  create            Create a new custom type
+  list              List all custom types
+  view              View details of a custom type
+  remove            Remove a custom type
+  set-name          Change a custom type's display name
+  add-field         Add a field to a custom type
+  remove-field      Remove a field from a custom type
+  connect-slice     Connect a shared slice to a custom type
+  disconnect-slice  Disconnect a shared slice from a custom type
+
+FLAGS
+  -h, --help   Show help for command
+
+LEARN MORE
+  Use \`prismic custom-type <command> --help\` for more information about a command.
+`.trim();
+
+export async function customType(): Promise<void> {
+	const {
+		positionals: [subcommand],
+	} = parseArgs({
+		args: process.argv.slice(3), // skip: node, script, "custom-type"
+		options: {
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+		strict: false,
+	});
+
+	switch (subcommand) {
+		case "create":
+			await customTypeCreate();
+			break;
+		case "list":
+			await customTypeList();
+			break;
+		case "view":
+			await customTypeView();
+			break;
+		case "remove":
+			await customTypeRemove();
+			break;
+		case "set-name":
+			await customTypeSetName();
+			break;
+		case "add-field":
+			await customTypeAddField();
+			break;
+		case "remove-field":
+			await customTypeRemoveField();
+			break;
+		case "connect-slice":
+			await customTypeConnectSlice();
+			break;
+		case "disconnect-slice":
+			await customTypeDisconnectSlice();
+			break;
+		default: {
+			if (subcommand) {
+				console.error(`Unknown custom-type subcommand: ${subcommand}\n`);
+				process.exitCode = 1;
+			}
+			console.info(HELP);
+		}
+	}
+}

package/src/docs-fetch.ts

@@ -0,0 +1,146 @@
+import { parseArgs } from "node:util";
+
+const HELP = `
+Fetch and display documentation from Prismic's docs site.
+
+USAGE
+  prismic docs fetch <path> [flags]
+
+ARGUMENTS
+  path    Documentation path with optional anchor (e.g., "nextjs" or "nextjs#set-up-a-prismic-client")
+
+FLAGS
+  -h, --help   Show help for command
+
+EXAMPLES
+  prismic docs fetch nextjs
+  prismic docs fetch nextjs#set-up-a-prismic-client
+
+LEARN MORE
+  Visit https://prismic.io/docs for the full documentation.
+`.trim();
+
+function parsePathAndAnchor(input: string): { path: string; anchor?: string } {
+	const hashIndex = input.indexOf("#");
+	if (hashIndex === -1) {
+		return { path: input };
+	}
+	return {
+		path: input.slice(0, hashIndex),
+		anchor: input.slice(hashIndex + 1),
+	};
+}
+
+async function fetchMarkdown(
+	url: string,
+): Promise<{ ok: true; content: string } | { ok: false; error: string }> {
+	try {
+		const response = await fetch(url);
+		if (response.status === 404) {
+			return { ok: false, error: `Documentation not found: ${url}` };
+		}
+		if (!response.ok) {
+			return {
+				ok: false,
+				error: `Failed to fetch documentation: ${response.status}`,
+			};
+		}
+		const content = await response.text();
+		return { ok: true, content };
+	} catch (error) {
+		const message = error instanceof Error ? error.message : String(error);
+		return { ok: false, error: `Network error: ${message}` };
+	}
+}
+
+function anchorToHeadingPattern(anchor: string): RegExp {
+	// Convert kebab-case anchor to a pattern that matches the heading text.
+	const pattern = anchor
+		.split("-")
+		.map((word) => word.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"))
+		.join("[\\s-]+");
+	return new RegExp(`^(#{1,6})\\s+${pattern}\\s*$`, "im");
+}
+
+function extractSection(
+	markdown: string,
+	anchor: string,
+): { ok: true; content: string } | { ok: false; error: string } {
+	const lines = markdown.split("\n");
+	const headingPattern = anchorToHeadingPattern(anchor);
+
+	let startIndex = -1;
+	let headingLevel = 0;
+
+	for (let i = 0; i < lines.length; i++) {
+		const match = lines[i].match(headingPattern);
+		if (match) {
+			startIndex = i;
+			headingLevel = match[1].length;
+			break;
+		}
+	}
+
+	if (startIndex === -1) {
+		return { ok: false, error: `Anchor not found: #${anchor}` };
+	}
+
+	let endIndex = lines.length;
+	for (let i = startIndex + 1; i < lines.length; i++) {
+		const headingMatch = lines[i].match(/^(#{1,6})\s/);
+		if (headingMatch && headingMatch[1].length <= headingLevel) {
+			endIndex = i;
+			break;
+		}
+	}
+
+	const content = lines.slice(startIndex, endIndex).join("\n").trim();
+	return { ok: true, content };
+}
+
+export async function docsFetch(): Promise<void> {
+	const {
+		positionals: [pathArg],
+		values: { help },
+	} = parseArgs({
+		args: process.argv.slice(4),
+		options: {
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+	});
+
+	if (help) {
+		console.info(HELP);
+		return;
+	}
+
+	if (!pathArg) {
+		console.info(HELP);
+		return;
+	}
+
+	const { path, anchor } = parsePathAndAnchor(pathArg);
+	const url = `https://prismic.io/docs/${path}.md`;
+
+	const fetchResult = await fetchMarkdown(url);
+	if (!fetchResult.ok) {
+		console.error(fetchResult.error);
+		process.exitCode = 1;
+		return;
+	}
+
+	let output = fetchResult.content;
+
+	if (anchor) {
+		const extractResult = extractSection(output, anchor);
+		if (!extractResult.ok) {
+			console.error(extractResult.error);
+			process.exitCode = 1;
+			return;
+		}
+		output = extractResult.content;
+	}
+
+	console.info(output);
+}