prismic 0.0.0-pr.28.59bf330

package/src/locale-list.ts

@@ -0,0 +1,107 @@
+import { parseArgs } from "node:util";
+import * as v from "valibot";
+
+import { isAuthenticated } from "./lib/auth";
+import { safeGetRepositoryFromConfig } from "./lib/config";
+import { stringify } from "./lib/json";
+import { ForbiddenRequestError, type ParsedRequestResponse, request } from "./lib/request";
+import { getInternalApiUrl } from "./lib/url";
+
+const HELP = `
+List all locales in a Prismic repository.
+
+By default, this command reads the repository from prismic.config.json at the
+project root.
+
+USAGE
+  prismic locale list [flags]
+
+FLAGS
+      --json          Output as JSON
+  -r, --repo string   Repository domain
+  -h, --help          Show help for command
+
+LEARN MORE
+  Use \`prismic <command> <subcommand> --help\` for more information about a command.
+`.trim();
+
+export async function localeList(): Promise<void> {
+	const {
+		values: { help, repo = await safeGetRepositoryFromConfig(), json },
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "locale", "list"
+		options: {
+			json: { type: "boolean" },
+			repo: { type: "string", short: "r" },
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: false,
+	});
+
+	if (help) {
+		console.info(HELP);
+		return;
+	}
+
+	if (!repo) {
+		console.error("Missing prismic.config.json or --repo option");
+		process.exitCode = 1;
+		return;
+	}
+
+	const authenticated = await isAuthenticated();
+	if (!authenticated) {
+		handleUnauthenticated();
+		return;
+	}
+
+	const response = await getLocales(repo);
+	if (!response.ok) {
+		if (response.error instanceof ForbiddenRequestError) {
+			handleUnauthenticated();
+		} else if (v.isValiError(response.error)) {
+			console.error(
+				`Failed to list locales: Invalid response: ${stringify(response.error.issues)}`,
+			);
+			process.exitCode = 1;
+		} else {
+			console.error(`Failed to list locales: ${stringify(response.value)}`);
+			process.exitCode = 1;
+		}
+		return;
+	}
+
+	const locales = response.value.results;
+	if (json) {
+		console.info(stringify(locales));
+	} else {
+		for (const locale of locales) {
+			const defaultLabel = locale.isMaster ? " (default)" : "";
+			console.info(`${locale.id}  ${locale.label}${defaultLabel}`);
+		}
+	}
+}
+
+const LocaleSchema = v.object({
+	id: v.string(),
+	label: v.string(),
+	customName: v.nullable(v.string()),
+	isMaster: v.boolean(),
+});
+export type Locale = v.InferOutput<typeof LocaleSchema>;
+
+const GetLocalesResponseSchema = v.object({
+	results: v.array(LocaleSchema),
+});
+type GetLocalesResponse = v.InferOutput<typeof GetLocalesResponseSchema>;
+
+export async function getLocales(repo: string): Promise<ParsedRequestResponse<GetLocalesResponse>> {
+	const url = new URL("/locale/repository/locales", await getInternalApiUrl());
+	url.searchParams.set("repository", repo);
+	return await request(url, { schema: GetLocalesResponseSchema });
+}
+
+function handleUnauthenticated() {
+	console.error("Not logged in. Run `prismic login` first.");
+	process.exitCode = 1;
+}

package/src/locale-remove.ts

@@ -0,0 +1,88 @@
+import { parseArgs } from "node:util";
+
+import { isAuthenticated } from "./lib/auth";
+import { safeGetRepositoryFromConfig } from "./lib/config";
+import { stringify } from "./lib/json";
+import { ForbiddenRequestError, request } from "./lib/request";
+import { getInternalApiUrl } from "./lib/url";
+
+const HELP = `
+Remove a locale from a Prismic repository.
+
+By default, this command reads the repository from prismic.config.json at the
+project root.
+
+USAGE
+  prismic locale remove <code> [flags]
+
+ARGUMENTS
+  <code>   Locale code (e.g. en-us, fr-fr)
+
+FLAGS
+  -r, --repo string   Repository domain
+  -h, --help          Show help for command
+
+LEARN MORE
+  Use \`prismic <command> <subcommand> --help\` for more information about a command.
+`.trim();
+
+export async function localeRemove(): Promise<void> {
+	const {
+		values: { repo = await safeGetRepositoryFromConfig(), help },
+		positionals: [code],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "locale", "remove"
+		options: {
+			repo: { type: "string", short: "r" },
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+	});
+
+	if (help) {
+		console.info(HELP);
+		return;
+	}
+
+	if (!code) {
+		console.error("Missing required argument: <code>");
+		process.exitCode = 1;
+		return;
+	}
+
+	if (!repo) {
+		console.error("Missing prismic.config.json or --repo option");
+		process.exitCode = 1;
+		return;
+	}
+
+	const authenticated = await isAuthenticated();
+	if (!authenticated) {
+		handleUnauthenticated();
+		return;
+	}
+
+	const response = await removeLocale(repo, code);
+	if (!response.ok) {
+		if (response.error instanceof ForbiddenRequestError) {
+			handleUnauthenticated();
+		} else {
+			console.error(`Failed to remove locale: ${stringify(response.value)}`);
+			process.exitCode = 1;
+		}
+		return;
+	}
+
+	console.info(`Removed locale: ${code}`);
+}
+
+async function removeLocale(repository: string, code: string) {
+	const url = new URL(`/locale/repository/locales/${code}`, await getInternalApiUrl());
+	url.searchParams.set("repository", repository);
+	return await request(url, { method: "DELETE" });
+}
+
+function handleUnauthenticated() {
+	console.error("Not logged in. Run `prismic login` first.");
+	process.exitCode = 1;
+}

package/src/locale-set-default.ts

@@ -0,0 +1,131 @@
+import { parseArgs } from "node:util";
+import * as v from "valibot";
+
+import { isAuthenticated } from "./lib/auth";
+import { safeGetRepositoryFromConfig } from "./lib/config";
+import { stringify } from "./lib/json";
+import { ForbiddenRequestError, request } from "./lib/request";
+import { getInternalApiUrl } from "./lib/url";
+import { type Locale, getLocales } from "./locale-list";
+
+const HELP = `
+Set the default locale for a Prismic repository.
+
+By default, this command reads the repository from prismic.config.json at the
+project root.
+
+USAGE
+  prismic locale set-default <code> [flags]
+
+ARGUMENTS
+  <code>   Locale code (e.g. en-us, fr-fr)
+
+FLAGS
+  -r, --repo string   Repository domain
+  -h, --help          Show help for command
+
+LEARN MORE
+  Use \`prismic <command> <subcommand> --help\` for more information about a command.
+`.trim();
+
+export async function localeSetDefault(): Promise<void> {
+	const {
+		values: { help, repo = await safeGetRepositoryFromConfig() },
+		positionals: [code],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "locale", "set-default"
+		options: {
+			repo: { type: "string", short: "r" },
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+	});
+
+	if (help) {
+		console.info(HELP);
+		return;
+	}
+
+	if (!code) {
+		console.error("Missing required argument: <code>");
+		process.exitCode = 1;
+		return;
+	}
+
+	if (!repo) {
+		console.error("Missing prismic.config.json or --repo option");
+		process.exitCode = 1;
+		return;
+	}
+
+	const authenticated = await isAuthenticated();
+	if (!authenticated) {
+		handleUnauthenticated();
+		return;
+	}
+
+	const localesResponse = await getLocales(repo);
+	if (!localesResponse.ok) {
+		if (localesResponse.error instanceof ForbiddenRequestError) {
+			handleUnauthenticated();
+		} else if (v.isValiError(localesResponse.error)) {
+			console.error(
+				`Failed to set default locale: Invalid response: ${stringify(localesResponse.error.issues)}`,
+			);
+			process.exitCode = 1;
+		} else {
+			console.error(`Failed to set default locale: ${stringify(localesResponse.value)}`);
+			process.exitCode = 1;
+		}
+
+		return;
+	}
+
+	const locales = localesResponse.value.results;
+	const locale = locales.find((l) => l.id === code);
+	if (!locale) {
+		console.error(
+			`Locale "${code}" not found in repository. Available locales: ${locales.map((l) => l.id).join(", ")}`,
+		);
+		process.exitCode = 1;
+		return;
+	}
+
+	if (locale.isMaster) {
+		console.error(`Locale "${code}" is already the default.`);
+		process.exitCode = 1;
+		return;
+	}
+
+	const response = await setDefaultLocale(repo, locale);
+	if (!response.ok) {
+		if (response.error instanceof ForbiddenRequestError) {
+			handleUnauthenticated();
+		} else {
+			console.error(`Failed to set default locale: ${stringify(response.value)}`);
+			process.exitCode = 1;
+		}
+		return;
+	}
+
+	console.info(`Default locale set: ${code}`);
+}
+
+async function setDefaultLocale(repo: string, locale: Locale) {
+	const url = new URL("/locale/repository/locales", await getInternalApiUrl());
+	url.searchParams.set("repository", repo);
+	return await request(url, {
+		method: "POST",
+		body: {
+			id: locale.id,
+			label: locale.label,
+			customName: locale.customName,
+			isMaster: true,
+		},
+	});
+}
+
+function handleUnauthenticated() {
+	console.error("Not logged in. Run `prismic login` first.");
+	process.exitCode = 1;
+}

package/src/locale.ts

@@ -0,0 +1,60 @@
+import { parseArgs } from "node:util";
+
+import { localeAdd } from "./locale-add";
+import { localeList } from "./locale-list";
+import { localeRemove } from "./locale-remove";
+import { localeSetDefault } from "./locale-set-default";
+
+const HELP = `
+Manage locales in a Prismic repository.
+
+USAGE
+  prismic locale <command> [flags]
+
+COMMANDS
+  add           Add a locale to a repository
+  list          List locales in a repository
+  remove        Remove a locale from a repository
+  set-default   Set the default locale for a repository
+
+FLAGS
+  -h, --help    Show help for command
+
+LEARN MORE
+  Use \`prismic locale <command> --help\` for more information about a command.
+`.trim();
+
+export async function locale(): Promise<void> {
+	const {
+		positionals: [subcommand],
+	} = parseArgs({
+		args: process.argv.slice(3), // skip: node, script, "locale"
+		options: {
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+		strict: false,
+	});
+
+	switch (subcommand) {
+		case "add":
+			await localeAdd();
+			break;
+		case "list":
+			await localeList();
+			break;
+		case "remove":
+			await localeRemove();
+			break;
+		case "set-default":
+			await localeSetDefault();
+			break;
+		default: {
+			if (subcommand) {
+				console.error(`Unknown locale subcommand: ${subcommand}\n`);
+				process.exitCode = 1;
+			}
+			console.info(HELP);
+		}
+	}
+}

package/src/login.ts

@@ -0,0 +1,45 @@
+import { exec } from "node:child_process";
+import { parseArgs } from "node:util";
+
+import { createLoginSession } from "./lib/auth";
+
+const HELP = `
+Log in to Prismic via browser.
+
+USAGE
+  prismic login [flags]
+
+FLAGS
+  -h, --help   Show help for command
+
+LEARN MORE
+  Use \`prismic <command> --help\` for more information about a command.
+`.trim();
+
+export async function login(): Promise<void> {
+	const { values } = parseArgs({
+		args: process.argv.slice(3),
+		options: { help: { type: "boolean", short: "h" } },
+	});
+
+	if (values.help) {
+		console.info(HELP);
+		return;
+	}
+
+	const { email } = await createLoginSession({
+		onReady: (url) => {
+			console.info("Opening browser to complete login...");
+			console.info(`If the browser doesn't open, visit: ${url}`);
+			openBrowser(url);
+		},
+	});
+
+	console.info(`Logged in to Prismic as ${email}`);
+}
+
+function openBrowser(url: URL): void {
+	const cmd =
+		process.platform === "darwin" ? "open" : process.platform === "win32" ? "start" : "xdg-open";
+	exec(`${cmd} "${url.toString()}"`);
+}

package/src/logout.ts

@@ -0,0 +1,36 @@
+import { parseArgs } from "node:util";
+
+import { removeToken } from "./lib/auth";
+
+const HELP = `
+Log out of Prismic.
+
+USAGE
+  prismic logout [flags]
+
+FLAGS
+  -h, --help   Show help for command
+
+LEARN MORE
+  Use \`prismic <command> --help\` for more information about a command.
+`.trim();
+
+export async function logout(): Promise<void> {
+	const { values } = parseArgs({
+		args: process.argv.slice(3),
+		options: { help: { type: "boolean", short: "h" } },
+	});
+
+	if (values.help) {
+		console.info(HELP);
+		return;
+	}
+
+	const ok = await removeToken();
+	if (ok) {
+		console.info("Logged out of Prismic");
+	} else {
+		console.error("Logout failed. You can log out manually by deleting the file.");
+		process.exitCode = 1;
+	}
+}

package/src/page-type-add-field-boolean.ts

@@ -0,0 +1,179 @@
+import type { BooleanField, CustomType } from "@prismicio/types-internal/lib/customtypes";
+
+import { parseArgs } from "node:util";
+
+import { buildTypes } from "./codegen-types";
+import { findGroupInTab, isGroupField, parseFieldPath, validateNestedFieldPath } from "./lib/field-path";
+import { getDocsPath, requireFramework } from "./framework";
+import { humanReadable } from "./lib/string";
+
+const HELP = `
+Add a boolean (toggle) field to an existing page type.
+
+USAGE
+  prismic page-type add-field boolean <type-id> <field-id> [flags]
+
+ARGUMENTS
+  type-id                Page type identifier (required)
+  field-id               Field identifier (required)
+
+FLAGS
+  -t, --tab string       Target tab (default: first existing tab, or "Main")
+  -l, --label string     Display label for the field (inferred from field-id if omitted)
+      --default          Set default value to true
+      --true-label string Label shown when toggle is on
+      --false-label string Label shown when toggle is off
+      --types string   Output file for generated types (default: "prismicio-types.d.ts")
+  -h, --help             Show help for command
+
+EXAMPLES
+  prismic page-type add-field boolean homepage featured
+  prismic page-type add-field boolean article published --default
+  prismic page-type add-field boolean product available --true-label "In Stock" --false-label "Out of Stock"
+`.trim();
+
+
+export async function pageTypeAddFieldBoolean(): Promise<void> {
+	const {
+		values: {
+			help,
+			tab,
+			label,
+			default: defaultValue,
+			"true-label": trueLabel,
+			"false-label": falseLabel,
+			types,
+		},
+		positionals: [typeId, fieldId],
+	} = parseArgs({
+		args: process.argv.slice(5), // skip: node, script, "page-type", "add-field", "boolean"
+		options: {
+			tab: { type: "string", short: "t" },
+			label: { type: "string", short: "l" },
+			default: { type: "boolean" },
+			"true-label": { type: "string" },
+			"false-label": { 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 page-type add-field boolean <type-id> <field-id>");
+		process.exitCode = 1;
+		return;
+	}
+
+	if (!fieldId) {
+		console.error("Missing required argument: field-id\n");
+		console.error("Usage: prismic page-type add-field boolean <type-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;
+	}
+
+	const framework = await requireFramework();
+	if (!framework) return;
+
+	let model: CustomType;
+	try {
+		model = await framework.readCustomType(typeId);
+	} catch {
+		console.error(`Page type not found: ${typeId}\n\nCreate it first with: prismic page-type create ${typeId}`);
+		process.exitCode = 1;
+		return;
+	}
+
+	// Determine target tab
+	const existingTabs = Object.keys(model.json);
+	const targetTab = tab ?? existingTabs[0] ?? "Main";
+
+	// Initialize tab if it doesn't exist
+	if (!model.json[targetTab]) {
+		model.json[targetTab] = {};
+	}
+
+	// Build field definition
+	const fieldDefinition: BooleanField = {
+		type: "Boolean",
+		config: {
+			label: label ?? humanReadable(fieldPath.type === "nested" ? fieldPath.nestedFieldId : fieldId),
+			...(defaultValue && { default_value: true }),
+			...(trueLabel && { placeholder_true: trueLabel }),
+			...(falseLabel && { placeholder_false: falseLabel }),
+		},
+	};
+
+	// Add field to model
+	if (fieldPath.type === "nested") {
+		const groupResult = findGroupInTab(model.json[targetTab], fieldPath.groupId, targetTab);
+		if (!groupResult.ok) {
+			console.error(groupResult.error);
+			process.exitCode = 1;
+			return;
+		}
+		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 {
+		for (const [tabName, tabFields] of Object.entries(model.json)) {
+			if (tabFields[fieldId]) {
+				console.error(`Field "${fieldId}" already exists in tab "${tabName}"`);
+				process.exitCode = 1;
+				return;
+			}
+			for (const [groupFieldId, groupField] of Object.entries(tabFields)) {
+				if (isGroupField(groupField) && groupField.config.fields[fieldId]) {
+					console.error(`Field "${fieldId}" already exists in group "${groupFieldId}" in tab "${tabName}"`);
+					process.exitCode = 1;
+					return;
+				}
+			}
+		}
+		model.json[targetTab][fieldId] = fieldDefinition;
+	}
+
+	// Write updated model
+	await framework.updateCustomType(model);
+
+	if (fieldPath.type === "nested") {
+		console.info(`Added field "${fieldPath.nestedFieldId}" (Boolean) to group "${fieldPath.groupId}" in ${typeId}`);
+	} else {
+		console.info(`Added field "${fieldId}" (Boolean) to "${targetTab}" tab in ${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}`);
+	}
+
+	console.info();
+	console.info("Next: Add more fields with `prismic page-type add-field`");
+
+	if (framework) {
+		const docsPath = getDocsPath(framework.id);
+		console.info(
+			`      Run \`prismic docs fetch ${docsPath}#write-page-components\` to learn how to implement a page file`,
+		);
+	}
+}