prismic 1.2.1 → 1.3.0

package/src/commands/locale-add.ts

@@ -0,0 +1,47 @@
+import { getHost, getToken } from "../auth";
+import { upsertLocale } from "../clients/locale";
+import { CommandError, createCommand, type CommandConfig } from "../lib/command";
+import { UnknownRequestError } from "../lib/request";
+import { getRepositoryName } from "../project";
+
+const config = {
+	name: "prismic locale add",
+	description: `
+		Add a locale to a Prismic repository.
+
+		By default, this command reads the repository from prismic.config.json at the
+		project root.
+	`,
+	positionals: {
+		code: { description: "Locale code (e.g. fr-fr, es-es)" },
+	},
+	options: {
+		master: { type: "boolean", description: "Set as the master locale" },
+		name: { type: "string", short: "n", description: "Custom display name (for custom locales)" },
+		repo: { type: "string", short: "r", description: "Repository domain" },
+	},
+} satisfies CommandConfig;
+
+export default createCommand(config, async ({ positionals, values }) => {
+	const [code] = positionals;
+	const { repo = await getRepositoryName(), master = false, name } = values;
+
+	if (!code) {
+		throw new CommandError("Missing required argument: <code>");
+	}
+
+	const token = await getToken();
+	const host = await getHost();
+
+	try {
+		await upsertLocale({ id: code, isMaster: master, customName: name }, { repo, token, host });
+	} catch (error) {
+		if (error instanceof UnknownRequestError) {
+			const message = await error.text();
+			throw new CommandError(`Failed to add locale: ${message}`);
+		}
+		throw error;
+	}
+
+	console.info(`Locale added: ${code}`);
+});

package/src/commands/locale-list.ts

@@ -0,0 +1,43 @@
+import { getHost, getToken } from "../auth";
+import { getLocales } from "../clients/locale";
+import { createCommand, type CommandConfig } from "../lib/command";
+import { stringify } from "../lib/json";
+import { getRepositoryName } from "../project";
+
+const config = {
+	name: "prismic locale list",
+	description: `
+		List all locales in a Prismic repository.
+
+		By default, this command reads the repository from prismic.config.json at the
+		project root.
+	`,
+	options: {
+		json: { type: "boolean", description: "Output as JSON" },
+		repo: { type: "string", short: "r", description: "Repository domain" },
+	},
+} satisfies CommandConfig;
+
+export default createCommand(config, async ({ values }) => {
+	const { repo = await getRepositoryName(), json } = values;
+
+	const token = await getToken();
+	const host = await getHost();
+
+	const locales = await getLocales({ repo, token, host });
+
+	if (json) {
+		console.info(stringify(locales));
+		return;
+	}
+
+	if (locales.length === 0) {
+		console.info("No locales found.");
+		return;
+	}
+
+	for (const locale of locales) {
+		const masterLabel = locale.isMaster ? " (master)" : "";
+		console.info(`${locale.id}  ${locale.label}${masterLabel}`);
+	}
+});

package/src/commands/locale-remove.ts

@@ -0,0 +1,45 @@
+import { getHost, getToken } from "../auth";
+import { removeLocale } from "../clients/locale";
+import { CommandError, createCommand, type CommandConfig } from "../lib/command";
+import { UnknownRequestError } from "../lib/request";
+import { getRepositoryName } from "../project";
+
+const config = {
+	name: "prismic locale remove",
+	description: `
+		Remove a locale from a Prismic repository.
+
+		By default, this command reads the repository from prismic.config.json at the
+		project root.
+	`,
+	positionals: {
+		code: { description: "Locale code (e.g. en-us, fr-fr)" },
+	},
+	options: {
+		repo: { type: "string", short: "r", description: "Repository domain" },
+	},
+} satisfies CommandConfig;
+
+export default createCommand(config, async ({ positionals, values }) => {
+	const [code] = positionals;
+	const { repo = await getRepositoryName() } = values;
+
+	if (!code) {
+		throw new CommandError("Missing required argument: <code>");
+	}
+
+	const token = await getToken();
+	const host = await getHost();
+
+	try {
+		await removeLocale(code, { repo, token, host });
+	} catch (error) {
+		if (error instanceof UnknownRequestError) {
+			const message = await error.text();
+			throw new CommandError(`Failed to remove locale: ${message}`);
+		}
+		throw error;
+	}
+
+	console.info(`Locale removed: ${code}`);
+});

package/src/commands/locale-set-master.ts

@@ -0,0 +1,61 @@
+import { getHost, getToken } from "../auth";
+import { getLocales, upsertLocale } from "../clients/locale";
+import { CommandError, createCommand, type CommandConfig } from "../lib/command";
+import { UnknownRequestError } from "../lib/request";
+import { getRepositoryName } from "../project";
+
+const config = {
+	name: "prismic locale set-master",
+	description: `
+		Set the master locale for a Prismic repository.
+
+		By default, this command reads the repository from prismic.config.json at the
+		project root.
+	`,
+	positionals: {
+		code: { description: "Locale code (e.g. en-us, fr-fr)" },
+	},
+	options: {
+		repo: { type: "string", short: "r", description: "Repository domain" },
+	},
+} satisfies CommandConfig;
+
+export default createCommand(config, async ({ positionals, values }) => {
+	const [code] = positionals;
+	const { repo = await getRepositoryName() } = values;
+
+	if (!code) {
+		throw new CommandError("Missing required argument: <code>");
+	}
+
+	const token = await getToken();
+	const host = await getHost();
+
+	const locales = await getLocales({ repo, token, host });
+	const locale = locales.find((l) => l.id === code);
+
+	if (!locale) {
+		throw new CommandError(
+			`Locale "${code}" not found. Available locales: ${locales.map((l) => l.id).join(", ")}`,
+		);
+	}
+
+	if (locale.isMaster) {
+		throw new CommandError(`Locale "${code}" is already the master.`);
+	}
+
+	try {
+		await upsertLocale(
+			{ id: locale.id, isMaster: true, customName: locale.customName ?? undefined },
+			{ repo, token, host },
+		);
+	} catch (error) {
+		if (error instanceof UnknownRequestError) {
+			const message = await error.text();
+			throw new CommandError(`Failed to set master locale: ${message}`);
+		}
+		throw error;
+	}
+
+	console.info(`Master locale set: ${code}`);
+});

package/src/commands/locale.ts

@@ -0,0 +1,28 @@
+import { createCommandRouter } from "../lib/command";
+import localeAdd from "./locale-add";
+import localeList from "./locale-list";
+import localeRemove from "./locale-remove";
+import localeSetMaster from "./locale-set-master";
+
+export default createCommandRouter({
+	name: "prismic locale",
+	description: "Manage locales in a Prismic repository.",
+	commands: {
+		add: {
+			handler: localeAdd,
+			description: "Add a locale",
+		},
+		list: {
+			handler: localeList,
+			description: "List locales",
+		},
+		remove: {
+			handler: localeRemove,
+			description: "Remove a locale",
+		},
+		"set-master": {
+			handler: localeSetMaster,
+			description: "Set the master locale",
+		},
+	},
+});

package/src/commands/repo-create.ts

@@ -0,0 +1,60 @@
+import { getAdapter } from "../adapters";
+import { getHost, getToken } from "../auth";
+import { checkIsDomainAvailable, createRepository } from "../clients/wroom";
+import { CommandError, createCommand, type CommandConfig } from "../lib/command";
+import { UnknownRequestError } from "../lib/request";
+
+const MAX_DOMAIN_TRIES = 5;
+
+const config = {
+	name: "prismic repo create",
+	description: "Create a new Prismic repository.",
+	options: {
+		name: { type: "string", short: "n", description: "Display name for the repository" },
+	},
+} satisfies CommandConfig;
+
+export default createCommand(config, async ({ values }) => {
+	const { name } = values;
+
+	const token = await getToken();
+	const host = await getHost();
+
+	const domain = await findAvailableDomain({ token, host });
+	if (!domain) {
+		throw new CommandError("Failed to create a repository. Please try again.");
+	}
+
+	const adapter = await getAdapter().catch(() => undefined);
+	const framework = adapter?.id ?? "other";
+
+	try {
+		await createRepository({ domain, name: name ?? domain, framework, token, host });
+	} catch (error) {
+		if (error instanceof UnknownRequestError) {
+			const message = await error.text();
+			throw new CommandError(`Failed to create repository: ${message}`);
+		}
+		throw error;
+	}
+
+	console.info(`Repository created: ${domain}`);
+	console.info(`URL: https://${domain}.${host}/`);
+});
+
+async function findAvailableDomain(config: {
+	token: string | undefined;
+	host: string;
+}): Promise<string | undefined> {
+	const { token, host } = config;
+	let domain;
+	for (let i = 0; i < MAX_DOMAIN_TRIES; i++) {
+		const candidate = crypto.randomUUID().replace(/-/g, "").slice(0, 8);
+		const available = await checkIsDomainAvailable({ domain: candidate, token, host });
+		if (available) {
+			domain = candidate;
+			break;
+		}
+	}
+	return domain;
+}

package/src/commands/repo-list.ts

@@ -0,0 +1,58 @@
+import { getHost, getToken } from "../auth";
+import { getProfile } from "../clients/user";
+import { CommandError, createCommand, type CommandConfig } from "../lib/command";
+import { stringify } from "../lib/json";
+import { UnknownRequestError } from "../lib/request";
+
+const config = {
+	name: "prismic repo list",
+	description: "List all Prismic repositories associated with your account.",
+	options: {
+		json: { type: "boolean", description: "Output as JSON" },
+	},
+} satisfies CommandConfig;
+
+export default createCommand(config, async ({ values }) => {
+	const { json } = values;
+
+	const token = await getToken();
+	const host = await getHost();
+
+	let profile;
+	try {
+		profile = await getProfile({ token, host });
+	} catch (error) {
+		if (error instanceof UnknownRequestError) {
+			const message = await error.text();
+			throw new CommandError(`Failed to list repositories: ${message}`);
+		}
+		throw error;
+	}
+
+	const repos = profile.repositories;
+
+	if (json) {
+		console.info(
+			stringify(
+				repos.map((repo) => ({
+					domain: repo.domain,
+					name: repo.name ?? null,
+					role: repo.role ?? null,
+					url: `https://${repo.domain}.${host}/`,
+				})),
+			),
+		);
+		return;
+	}
+
+	if (repos.length === 0) {
+		console.info("No repositories found.");
+		return;
+	}
+
+	for (const repo of repos) {
+		const name = repo.name || "(no name)";
+		const role = repo.role ? `  ${repo.role}` : "";
+		console.info(`${repo.domain}  ${name}${role}`);
+	}
+});

package/src/commands/repo-set-api-access.ts

@@ -0,0 +1,53 @@
+import { getHost, getToken } from "../auth";
+import { type RepositoryAccessLevel, setRepositoryAccess } from "../clients/wroom";
+import { CommandError, createCommand, type CommandConfig } from "../lib/command";
+import { UnknownRequestError } from "../lib/request";
+import { getRepositoryName } from "../project";
+
+const VALID_LEVELS: RepositoryAccessLevel[] = ["private", "public", "open"];
+
+const config = {
+	name: "prismic repo set-api-access",
+	description: `
+		Set the Content API access level of a Prismic repository.
+
+		By default, this command reads the repository from prismic.config.json at the
+		project root.
+	`,
+	positionals: {
+		level: { description: `Access level (${VALID_LEVELS.join(", ")})` },
+	},
+	options: {
+		repo: { type: "string", short: "r", description: "Repository domain" },
+	},
+} satisfies CommandConfig;
+
+export default createCommand(config, async ({ positionals, values }) => {
+	const [level] = positionals;
+	const { repo = await getRepositoryName() } = values;
+
+	if (!level) {
+		throw new CommandError("Missing required argument: <level>");
+	}
+
+	if (!VALID_LEVELS.includes(level as RepositoryAccessLevel)) {
+		throw new CommandError(
+			`Invalid access level: ${level}. Must be one of: ${VALID_LEVELS.join(", ")}`,
+		);
+	}
+
+	const token = await getToken();
+	const host = await getHost();
+
+	try {
+		await setRepositoryAccess(level as RepositoryAccessLevel, { repo, token, host });
+	} catch (error) {
+		if (error instanceof UnknownRequestError) {
+			const message = await error.text();
+			throw new CommandError(`Failed to set repository access: ${message}`);
+		}
+		throw error;
+	}
+
+	console.info(`Repository access set to: ${level}`);
+});

package/src/commands/repo-set-name.ts

@@ -0,0 +1,46 @@
+import { getHost, getToken } from "../auth";
+import { setRepositoryName } from "../clients/wroom";
+import { CommandError, createCommand, type CommandConfig } from "../lib/command";
+import { UnknownRequestError } from "../lib/request";
+import { getRepositoryName } from "../project";
+
+const config = {
+	name: "prismic repo set-name",
+	description: `
+		Set the display name of a Prismic repository.
+
+		By default, this command reads the repository from prismic.config.json at the
+		project root.
+	`,
+	positionals: {
+		name: { description: "Display name for the repository" },
+	},
+	options: {
+		repo: { type: "string", short: "r", description: "Repository domain" },
+	},
+} satisfies CommandConfig;
+
+export default createCommand(config, async ({ positionals, values }) => {
+	const [displayName] = positionals;
+	const { repo = await getRepositoryName() } = values;
+
+	if (!displayName) {
+		throw new CommandError("Missing required argument: <name>");
+	}
+
+	const token = await getToken();
+	const host = await getHost();
+
+	let confirmedName;
+	try {
+		confirmedName = await setRepositoryName(displayName, { repo, token, host });
+	} catch (error) {
+		if (error instanceof UnknownRequestError) {
+			const message = await error.text();
+			throw new CommandError(`Failed to set repository name: ${message}`);
+		}
+		throw error;
+	}
+
+	console.info(`Repository name set to: ${confirmedName}`);
+});

package/src/commands/repo-view.ts

@@ -0,0 +1,74 @@
+import { getHost, getToken } from "../auth";
+import { openBrowser } from "../lib/browser";
+import { getProfile } from "../clients/user";
+import { getRepositoryAccess } from "../clients/wroom";
+import { CommandError, createCommand, type CommandConfig } from "../lib/command";
+import { stringify } from "../lib/json";
+import { UnknownRequestError } from "../lib/request";
+import { getRepositoryName } from "../project";
+
+const config = {
+	name: "prismic repo view",
+	description: `
+		View details of a Prismic repository.
+
+		By default, this command reads the repository from prismic.config.json at the
+		project root.
+	`,
+	options: {
+		web: { type: "boolean", short: "w", description: "Open repository in browser" },
+		json: { type: "boolean", description: "Output as JSON" },
+		repo: { type: "string", short: "r", description: "Repository domain" },
+	},
+} satisfies CommandConfig;
+
+export default createCommand(config, async ({ values }) => {
+	const { repo = await getRepositoryName(), web, json } = values;
+
+	const token = await getToken();
+	const host = await getHost();
+	const url = `https://${repo}.${host}/`;
+
+	if (web) {
+		openBrowser(new URL(url));
+		console.info(`Opening ${url}`);
+		return;
+	}
+
+	let profile;
+	let access;
+	try {
+		[profile, access] = await Promise.all([
+			getProfile({ token, host }),
+			getRepositoryAccess({ repo, token, host }),
+		]);
+	} catch (error) {
+		if (error instanceof UnknownRequestError) {
+			const message = await error.text();
+			throw new CommandError(`Failed to fetch repository details: ${message}`);
+		}
+		throw error;
+	}
+
+	const repoData = profile.repositories.find((r) => r.domain === repo);
+	if (!repoData) {
+		throw new CommandError(`Repository not found: ${repo}`);
+	}
+
+	if (json) {
+		console.info(
+			stringify({
+				domain: repoData.domain,
+				name: repoData.name ?? null,
+				url,
+				apiAccess: access,
+			}),
+		);
+		return;
+	}
+
+	const name = repoData.name || "(no name)";
+	console.info(`Name: ${name}`);
+	console.info(`URL: ${url}`);
+	console.info(`Content API: ${access}`);
+});

package/src/commands/repo.ts

@@ -0,0 +1,33 @@
+import { createCommandRouter } from "../lib/command";
+import repoCreate from "./repo-create";
+import repoList from "./repo-list";
+import repoSetApiAccess from "./repo-set-api-access";
+import repoSetName from "./repo-set-name";
+import repoView from "./repo-view";
+
+export default createCommandRouter({
+	name: "prismic repo",
+	description: "Manage Prismic repositories.",
+	commands: {
+		create: {
+			handler: repoCreate,
+			description: "Create a new repository",
+		},
+		list: {
+			handler: repoList,
+			description: "List repositories",
+		},
+		view: {
+			handler: repoView,
+			description: "View repository details",
+		},
+		"set-name": {
+			handler: repoSetName,
+			description: "Set repository display name",
+		},
+		"set-api-access": {
+			handler: repoSetApiAccess,
+			description: "Set Content API access level",
+		},
+	},
+});

package/src/commands/sync.ts

@@ -4,6 +4,7 @@ import { setTimeout } from "node:timers/promises";
 import { getAdapter, type Adapter } from "../adapters";
 import { getHost, getToken } from "../auth";
 import { getCustomTypes, getSlices } from "../clients/custom-types";
+import { env } from "../env";
 import { generateAndWriteTypes } from "../lib/codegen";
 import { createCommand, type CommandConfig } from "../lib/command";
 import { segmentTrackEnd, segmentTrackStart } from "../lib/segment";
@@ -11,7 +12,7 @@ import { dedent } from "../lib/string";
 import { findProjectRoot, getRepositoryName } from "../project";
 
 // 5 seconds balances responsiveness with API load
-const POLL_INTERVAL_MS = 5000;
+const POLL_INTERVAL_MS = env.TEST ? 500 : 5000;
 const MAX_BACKOFF_MS = 60000; // Cap backoff at 1 minute
 const MAX_CONSECUTIVE_ERRORS = 10;
 
@@ -226,9 +227,10 @@ async function regenerateTypes(adapter: Adapter): Promise<void> {
 	const slices = await adapter.getSlices();
 	const customTypes = await adapter.getCustomTypes();
 	const projectRoot = await findProjectRoot();
+	const output = new URL("prismicio-types.d.ts", projectRoot);
 	await generateAndWriteTypes({
 		customTypes: customTypes.map((customType) => customType.model),
 		slices: slices.map((slice) => slice.model),
-		projectRoot,
+		output,
 	});
 }

package/src/commands/token-create.ts

@@ -0,0 +1,55 @@
+import { getHost, getToken } from "../auth";
+import {
+	createOAuthAuthorization,
+	createOAuthApp,
+	createWriteToken,
+	getOAuthApps,
+} from "../clients/wroom";
+import { CommandError, createCommand, type CommandConfig } from "../lib/command";
+import { getRepositoryName } from "../project";
+
+const CLI_APP_NAME = "Prismic CLI";
+
+const config = {
+	name: "prismic token create",
+	description: `
+		Create a new API token for a Prismic repository.
+
+		By default, this command reads the repository from prismic.config.json at the
+		project root.
+	`,
+	options: {
+		write: { type: "boolean", description: "Create a write token" },
+		"allow-releases": {
+			type: "boolean",
+			description: "Allow access to releases (read tokens only)",
+		},
+		repo: { type: "string", short: "r", description: "Repository domain" },
+	},
+} satisfies CommandConfig;
+
+export default createCommand(config, async ({ values }) => {
+	const { repo = await getRepositoryName(), write, "allow-releases": allowReleases } = values;
+
+	if (write && allowReleases) {
+		throw new CommandError("--allow-releases is only valid for access tokens (not with --write)");
+	}
+
+	const token = await getToken();
+	const host = await getHost();
+
+	if (write) {
+		const writeToken = await createWriteToken(CLI_APP_NAME, { repo, token, host });
+		console.info(`Token created: ${writeToken.token}`);
+	} else {
+		const scope = allowReleases ? "master+releases" : "master";
+
+		// Find or create the CLI OAuth app.
+		const apps = await getOAuthApps({ repo, token, host });
+		let app = apps.find((a) => a.name === CLI_APP_NAME);
+		if (!app) app = await createOAuthApp(CLI_APP_NAME, { repo, token, host });
+
+		const accessToken = await createOAuthAuthorization(app.id, scope, { repo, token, host });
+		console.info(`Token created: ${accessToken.token}`);
+	}
+});