@angeloashmore/prismic-cli-poc 0.0.0-canary.2ff9563

package/src/lib/slice.ts

@@ -0,0 +1,112 @@
+import type { SharedSlice } from "@prismicio/types-internal/lib/customtypes";
+
+import { readdir, readFile } from "node:fs/promises";
+import * as v from "valibot";
+
+import { exists, findUpward } from "./file";
+
+export const SharedSliceSchema = v.object({
+	id: v.string(),
+	type: v.literal("SharedSlice"),
+	name: v.string(),
+	description: v.optional(v.string()),
+	variations: v.array(
+		v.object({
+			id: v.string(),
+			name: v.string(),
+			description: v.optional(v.string()),
+			docURL: v.optional(v.string()),
+			version: v.optional(v.string()),
+			imageUrl: v.optional(v.string()),
+			primary: v.optional(v.record(v.string(), v.unknown())),
+			items: v.optional(v.record(v.string(), v.unknown())),
+		}),
+	),
+});
+
+type SliceModelResult =
+	| { ok: true; model: SharedSlice; modelPath: URL }
+	| { ok: false; error: string };
+
+export async function findSliceModel(sliceId: string): Promise<SliceModelResult> {
+	const projectRoot = await findUpward("package.json");
+	if (!projectRoot) {
+		return { ok: false, error: "Could not find project root (no package.json found)" };
+	}
+
+	const slicesDirectory = await getSlicesDirectory();
+
+	// List all directories in slices folder
+	let entries: string[];
+	try {
+		entries = await readdir(slicesDirectory, { withFileTypes: false }) as unknown as string[];
+	} catch {
+		return { ok: false, error: `No slices directory found at ${slicesDirectory.href}` };
+	}
+
+	// Search for a slice with matching ID
+	for (const entry of entries) {
+		const modelPath = new URL(`${entry}/model.json`, slicesDirectory);
+		try {
+			const contents = await readFile(modelPath, "utf8");
+			const parsed = JSON.parse(contents);
+			if (parsed.id === sliceId) {
+				const result = v.safeParse(SharedSliceSchema, parsed);
+				if (!result.success) {
+					return { ok: false, error: `Invalid slice model at ${modelPath.href}` };
+				}
+				return { ok: true, model: result.output as SharedSlice, modelPath };
+			}
+		} catch {
+			// Skip directories without valid model.json
+		}
+	}
+
+	return { ok: false, error: `Slice not found: ${sliceId}\n\nCreate it first with: prismic slice create ${sliceId}` };
+}
+
+export async function getSlicesDirectory(): Promise<URL> {
+	const framework = await detectFramework();
+	const projectRoot = await findUpward("package.json");
+	if (!projectRoot) {
+		throw new Error("Could not find project root (no package.json found)");
+	}
+	const projectDir = new URL(".", projectRoot);
+
+	switch (framework) {
+		case "next": {
+			const hasSrcDir = await exists(new URL("src", projectDir));
+			if (hasSrcDir) return new URL("src/slices/", projectDir);
+		}
+		case "nuxt": {
+			const hasAppDir = await exists(new URL("app", projectDir));
+			if (hasAppDir) return new URL("app/slices/", projectDir);
+		}
+		case "sveltekit": {
+			return new URL("src/slices/", projectDir);
+		}
+	}
+	return new URL("slices/", projectDir);
+}
+
+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 {}
+}
+
+export function pascalCase(input: string): string {
+	return input.toLowerCase().replace(/(^|[-_\s]+)(.)?/g, (_, __, c) => c?.toUpperCase() ?? "");
+}

package/src/lib/url.ts

@@ -0,0 +1,25 @@
+import { readHost } from "./auth";
+
+export async function getRepoUrl(repo: string): Promise<URL> {
+	const host = await readHost();
+	host.hostname = `${repo}.${host.hostname}`;
+	return appendTrailingSlash(host);
+}
+
+export async function getInternalApiUrl(): Promise<URL> {
+	const host = await readHost();
+	host.hostname = `api.internal.${host.hostname}`;
+	return appendTrailingSlash(host);
+}
+
+export async function getUserServiceUrl(): Promise<URL> {
+	const host = await readHost();
+	host.hostname = `user-service.${host.hostname}`;
+	return appendTrailingSlash(host);
+}
+
+export function appendTrailingSlash(url: string | URL): URL {
+	const newURL = new URL(url);
+	if (!newURL.pathname.endsWith("/")) newURL.pathname += "/";
+	return newURL;
+}

package/src/locale-add.ts

@@ -0,0 +1,116 @@
+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 { getRepoUrl } from "./lib/url";
+
+const HELP = `
+Add a new locale to a Prismic repository.
+
+By default, this command reads the repository from prismic.config.json at the
+project root.
+
+USAGE
+  prismic locale add <code> [flags]
+
+ARGUMENTS
+  <code>   Locale code (e.g. fr-fr, es-es)
+
+FLAGS
+  -n, --name string   Custom display name (creates custom locale)
+  -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 localeAdd(): Promise<void> {
+	const {
+		values: { help, name, repo = await safeGetRepositoryFromConfig() },
+		positionals: [code],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "locale", "add"
+		options: {
+			name: { type: "string", short: "n" },
+			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 = name
+		? await addCustomLocale(repo, code, name)
+		: await addStandardLocale(repo, code);
+	if (!response.ok) {
+		if (
+			typeof response.value === "string" &&
+			response.value.includes("already existing languages")
+		) {
+			// Treat as success
+			return;
+		}
+
+		if (response.error instanceof ForbiddenRequestError) {
+			handleUnauthenticated();
+		} else {
+			console.error(`Failed to add locale: ${stringify(response.value)}`);
+			process.exitCode = 1;
+		}
+
+		return;
+	}
+
+	console.info(`Locale added: ${code}`);
+}
+
+async function addStandardLocale(repo: string, code: string) {
+	const url = new URL("/app/settings/multilanguages", await getRepoUrl(repo));
+	return await request(url, {
+		method: "POST",
+		body: { languages: [code] },
+	});
+}
+
+async function addCustomLocale(repo: string, code: string, name: string) {
+	const [langPart, regionPart] = code.split("-");
+	const url = new URL("/app/settings/multilanguages/custom", await getRepoUrl(repo));
+	return await request(url, {
+		method: "POST",
+		body: {
+			lang: { label: name, id: langPart || code },
+			region: { label: name, id: regionPart || langPart || code },
+		},
+	});
+}
+
+function handleUnauthenticated() {
+	console.error("Not logged in. Run `prismic login` first.");
+	process.exitCode = 1;
+}

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);
+		}
+	}
+}