prismic 1.1.0 → 1.2.0

package/src/clients/core.ts

@@ -0,0 +1,104 @@
+import * as z from "zod/mini";
+
+import { request } from "../lib/request";
+
+const PreviewSchema = z.object({
+	id: z.string(),
+	label: z.string(),
+	url: z.string(),
+});
+
+const GetPreviewsResponseSchema = z.object({
+	results: z.array(PreviewSchema),
+});
+
+export type Preview = z.infer<typeof PreviewSchema>;
+
+export async function getPreviews(config: {
+	repo: string;
+	token: string | undefined;
+	host: string;
+}): Promise<Preview[]> {
+	const { repo, token, host } = config;
+	const url = new URL(
+		"core/repository/preview_configs",
+		getCoreBaseUrl(repo, host),
+	);
+	const response = await request(url, {
+		credentials: { "prismic-auth": token },
+		schema: GetPreviewsResponseSchema,
+	});
+	return response.results;
+}
+
+export async function addPreview(
+	previewConfig: {
+		name: string;
+		websiteURL: string;
+		resolverPath: string | undefined;
+	},
+	config: { repo: string; token: string | undefined; host: string },
+): Promise<void> {
+	const { repo, token, host } = config;
+	const url = new URL("previews/new", getCoreBaseUrl(repo, host));
+	await request(url, {
+		method: "POST",
+		body: {
+			name: previewConfig.name,
+			websiteURL: previewConfig.websiteURL,
+			resolverPath: previewConfig.resolverPath,
+		},
+		credentials: { "prismic-auth": token },
+	});
+}
+
+export async function removePreview(
+	id: string,
+	config: { repo: string; token: string | undefined; host: string },
+): Promise<void> {
+	const { repo, token, host } = config;
+	const url = new URL(
+		`previews/delete/${id}`,
+		getCoreBaseUrl(repo, host),
+	);
+	await request(url, {
+		method: "POST",
+		body: {},
+		credentials: { "prismic-auth": token },
+	});
+}
+
+const RepositoryResponseSchema = z.object({
+	simulator_url: z.optional(z.string()),
+});
+
+export async function getSimulatorUrl(config: {
+	repo: string;
+	token: string | undefined;
+	host: string;
+}): Promise<string | undefined> {
+	const { repo, token, host } = config;
+	const url = new URL("core/repository", getCoreBaseUrl(repo, host));
+	const response = await request(url, {
+		credentials: { "prismic-auth": token },
+		schema: RepositoryResponseSchema,
+	});
+	return response.simulator_url;
+}
+
+export async function setSimulatorUrl(
+	simulatorUrl: string,
+	config: { repo: string; token: string | undefined; host: string },
+): Promise<void> {
+	const { repo, token, host } = config;
+	const url = new URL("core/repository", getCoreBaseUrl(repo, host));
+	await request(url, {
+		method: "PATCH",
+		body: { simulator_url: simulatorUrl },
+		credentials: { "prismic-auth": token },
+	});
+}
+
+function getCoreBaseUrl(repo: string, host: string): URL {
+	return new URL(`https://${repo}.${host}/`);
+}

package/src/clients/wroom.ts

@@ -0,0 +1,111 @@
+import * as z from "zod/mini";
+
+import { request } from "../lib/request";
+
+const WebhookTriggersSchema = z.object({
+	documentsPublished: z.boolean(),
+	documentsUnpublished: z.boolean(),
+	releasesCreated: z.boolean(),
+	releasesUpdated: z.boolean(),
+	tagsCreated: z.boolean(),
+	tagsDeleted: z.boolean(),
+});
+
+export const WEBHOOK_TRIGGERS = Object.keys(WebhookTriggersSchema.shape);
+
+const WebhookSchema = z.object({
+	config: z.extend(WebhookTriggersSchema, {
+		_id: z.string(),
+		url: z.string(),
+		active: z.boolean(),
+		name: z.nullable(z.string()),
+		secret: z.nullable(z.string()),
+		headers: z.record(z.string(), z.string()),
+	}),
+});
+type Webhook = z.infer<typeof WebhookSchema>;
+
+export async function getWebhooks(config: {
+	repo: string;
+	token: string | undefined;
+	host: string;
+}): Promise<Webhook[]> {
+	const { repo, token, host } = config;
+	const wroomUrl = getWroomUrl(repo, host);
+	const url = new URL("app/settings/webhooks", wroomUrl);
+	const response = await request(url, {
+		credentials: { "prismic-auth": token },
+		schema: z.array(WebhookSchema),
+	});
+	return response;
+}
+
+export async function createWebhook(
+	webhookConfig: Omit<Webhook["config"], "_id" | "active" | "headers">,
+	config: { repo: string; token: string | undefined; host: string },
+): Promise<void> {
+	const { repo, token, host } = config;
+	const wroomUrl = getWroomUrl(repo, host);
+	const url = new URL(`app/settings/webhooks/create`, wroomUrl);
+	const body = new FormData();
+	body.set("url", webhookConfig.url);
+	body.set("name", webhookConfig.name ?? "");
+	body.set("secret", webhookConfig.secret ?? "");
+	body.set("headers", JSON.stringify({}));
+	body.set("active", "on");
+	body.set("documentsPublished", webhookConfig.documentsPublished.toString());
+	body.set("documentsUnpublished", webhookConfig.documentsUnpublished.toString());
+	body.set("releasesCreated", webhookConfig.releasesCreated.toString());
+	body.set("releasesUpdated", webhookConfig.releasesUpdated.toString());
+	body.set("tagsCreated", webhookConfig.tagsCreated.toString());
+	body.set("tagsDeleted", webhookConfig.tagsDeleted.toString());
+	await request(url, {
+		method: "POST",
+		body,
+		credentials: { "prismic-auth": token },
+	});
+}
+
+export async function updateWebhook(
+	id: string,
+	webhookConfig: Omit<Webhook["config"], "_id">,
+	config: { repo: string; token: string | undefined; host: string },
+): Promise<void> {
+	const { repo, token, host } = config;
+	const wroomUrl = getWroomUrl(repo, host);
+	const url = new URL(`app/settings/webhooks/${id}`, wroomUrl);
+	const body = new FormData();
+	body.set("url", webhookConfig.url);
+	body.set("name", webhookConfig.name ?? "");
+	body.set("secret", webhookConfig.secret ?? "");
+	body.set("headers", JSON.stringify(webhookConfig.headers ?? {}));
+	body.set("active", webhookConfig.active ? "on" : "off");
+	body.set("documentsPublished", webhookConfig.documentsPublished.toString());
+	body.set("documentsUnpublished", webhookConfig.documentsUnpublished.toString());
+	body.set("releasesCreated", webhookConfig.releasesCreated.toString());
+	body.set("releasesUpdated", webhookConfig.releasesUpdated.toString());
+	body.set("tagsCreated", webhookConfig.tagsCreated.toString());
+	body.set("tagsDeleted", webhookConfig.tagsDeleted.toString());
+	await request(url, {
+		method: "POST",
+		body,
+		credentials: { "prismic-auth": token },
+	});
+}
+
+export async function deleteWebhook(
+	id: string,
+	config: { repo: string; token: string | undefined; host: string },
+): Promise<void> {
+	const { repo, token, host } = config;
+	const wroomUrl = getWroomUrl(repo, host);
+	const url = new URL(`app/settings/webhooks/${id}/delete`, wroomUrl);
+	await request(url, {
+		method: "POST",
+		credentials: { "prismic-auth": token },
+	});
+}
+
+function getWroomUrl(repo: string, host: string): URL {
+	return new URL(`https://${repo}.${host}/`);
+}

package/src/commands/init.ts

@@ -1,66 +1,58 @@
-import { parseArgs } from "node:util";
-
 import type { Profile } from "../clients/user";
 
+import { getAdapter } from "../adapters";
 import { createLoginSession, getHost, getToken } from "../auth";
 import { getProfile } from "../clients/user";
 import {
 	createConfig,
 	deleteLegacySliceMachineConfig,
 	InvalidLegacySliceMachineConfig,
+	MissingPrismicConfig,
 	readConfig,
 	readLegacySliceMachineConfig,
 	UnknownProjectRoot,
 } from "../config";
-import { getFramework } from "../frameworks";
 import { openBrowser } from "../lib/browser";
 import { generateAndWriteTypes } from "../lib/codegen";
+import { CommandError, createCommand, type CommandConfig } from "../lib/command";
+import { installDependencies } from "../lib/packageJson";
 import { ForbiddenRequestError, UnauthorizedRequestError } from "../lib/request";
+import { findProjectRoot } from "../project";
 import { syncCustomTypes, syncSlices } from "./sync";
 
-const HELP = `
-Initialize a Prismic project by creating a prismic.config.json file.
-
-Detects the project framework, installs dependencies, and syncs models
-from Prismic. If a slicemachine.config.json exists, it will be migrated.
-
-USAGE
-  prismic init [flags]
-
-FLAGS
-  -r, --repo string   Repository name
-      --no-browser     Skip opening the browser automatically during login
-  -h, --help          Show help for command
-
-EXAMPLES
-  prismic init --repo my-repo
-
-LEARN MORE
-  Use \`prismic <command> --help\` for more information about a command.
-`.trim();
-
-export async function init(): Promise<void> {
-	const { values } = parseArgs({
-		args: process.argv.slice(3),
-		options: {
-			help: { type: "boolean", short: "h" },
-			repo: { type: "string", short: "r" },
-			"no-browser": { type: "boolean" },
+const config = {
+	name: "prismic init",
+	description: `
+		Initialize a Prismic project by creating a prismic.config.json file.
+
+		Detects the project framework, installs dependencies, and syncs models
+		from Prismic. If a slicemachine.config.json exists, it will be migrated.
+	`,
+	options: {
+		repo: { type: "string", short: "r", description: "Repository name" },
+		"no-browser": {
+			type: "boolean",
+			description: "Skip opening the browser automatically during login",
 		},
-	});
+	},
+} satisfies CommandConfig;
 
-	if (values.help) {
-		console.info(HELP);
-		return;
-	}
+export default createCommand(config, async ({ values }) => {
+	const { repo: explicitRepo, "no-browser": noBrowser } = values;
 
 	// Check for existing prismic.config.json
 	try {
 		await readConfig();
-		console.error("A prismic.config.json file exists. This project is already initialized.");
-		process.exitCode = 1;
-		return;
-	} catch {}
+		throw new CommandError(
+			"A prismic.config.json file exists. This project is already initialized.",
+		);
+	} catch (error) {
+		if (error instanceof MissingPrismicConfig) {
+			// No config found — proceed with initialization.
+		} else {
+			throw error;
+		}
+	}
 
 	// Load legacy slicemachine.config.json
 	let legacySliceMachineConfig;
@@ -72,11 +64,9 @@ export async function init(): Promise<void> {
 		}
 	}
 
-	const repo = values.repo ?? legacySliceMachineConfig?.repositoryName;
+	const repo = explicitRepo ?? legacySliceMachineConfig?.repositoryName;
 	if (!repo) {
-		console.error("Missing required flag: --repo");
-		process.exitCode = 1;
-		return;
+		throw new CommandError("Missing required flag: --repo");
 	}
 
 	// Validate repo membership
@@ -90,7 +80,7 @@ export async function init(): Promise<void> {
 			console.info("Not logged in. Starting login...");
 			const { email } = await createLoginSession({
 				onReady: (url) => {
-					if (values["no-browser"]) {
+					if (noBrowser) {
 						console.info(`Open this URL to log in: ${url}`);
 					} else {
 						console.info("Opening browser to complete login...");
@@ -109,19 +99,12 @@ export async function init(): Promise<void> {
 
 	const repoMeta = profile.repositories.find((repository) => repository.domain === repo);
 	if (!repoMeta) {
-		console.error(
+		throw new CommandError(
 			`Repository "${repo}" not found in your account. Check the name or request access to the repository.`,
 		);
-		process.exitCode = 1;
-		return;
 	}
 
-	const framework = await getFramework();
-	if (!framework) {
-		console.error("No supported framework found (Next.js, Nuxt, or SvelteKit required)");
-		process.exitCode = 1;
-		return;
-	}
+	const adapter = await getAdapter();
 
 	// Create prismic.config.json
 	try {
@@ -131,14 +114,11 @@ export async function init(): Promise<void> {
 		});
 	} catch (error) {
 		if (error instanceof UnknownProjectRoot) {
-			console.error(
+			throw new CommandError(
 				"Could not find a package.json file. Run this command from a project directory.",
 			);
-		} else {
-			console.error("Failed to create config file.");
 		}
-		process.exitCode = 1;
-		return;
+		throw new CommandError("Failed to create prismic.config.json.");
 	}
 
 	if (legacySliceMachineConfig) {
@@ -149,23 +129,31 @@ export async function init(): Promise<void> {
 	}
 
 	// Install dependencies and create framework files
-	await framework.initProject();
+	await adapter.initProject();
+
+	// Run package manager install
+	try {
+		console.info("Installing dependencies...");
+		await installDependencies();
+	} catch {
+		console.warn(
+			"Could not install dependencies automatically. Please install them manually (i.e. `npm install`).",
+		);
+	}
 
 	// Sync models from remote
-	await syncSlices(repo, framework);
-	await syncCustomTypes(repo, framework);
+	await syncSlices(repo, adapter);
+	await syncCustomTypes(repo, adapter);
 
 	// Generate TypeScript types from synced models
-	const slices = await framework.getSlices();
-	const customTypes = await framework.getCustomTypes();
-	const projectRoot = await framework.getProjectRoot();
+	const slices = await adapter.getSlices();
+	const customTypes = await adapter.getCustomTypes();
+	const projectRoot = await findProjectRoot();
 	await generateAndWriteTypes({
 		customTypes: customTypes.map((customType) => customType.model),
 		slices: slices.map((slice) => slice.model),
 		projectRoot,
 	});
 
-	console.info(
-		`Initialized Prismic for repository "${repo}". Run \`npm install\` to install new dependencies.`,
-	);
-}
+	console.info(`\nInitialized Prismic for repository "${repo}".`);
+});

package/src/commands/login.ts

@@ -1,39 +1,22 @@
 import { exec } from "node:child_process";
-import { parseArgs } from "node:util";
 
 import { createLoginSession } from "../auth";
+import { createCommand, type CommandConfig } from "../lib/command";
 
-const HELP = `
-Log in to Prismic via browser.
+const config = {
+	name: "prismic login",
+	description: "Log in to Prismic via browser.",
+	options: {
+		"no-browser": { type: "boolean", description: "Skip opening the browser automatically" },
+	},
+} satisfies CommandConfig;
 
-USAGE
-  prismic login [flags]
-
-FLAGS
-      --no-browser   Skip opening the browser automatically
-  -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" },
-			"no-browser": { type: "boolean" },
-		},
-	});
-
-	if (values.help) {
-		console.info(HELP);
-		return;
-	}
+export default createCommand(config, async ({ values }) => {
+	const { "no-browser": noBrowser } = values;
 
 	const { email } = await createLoginSession({
 		onReady: (url) => {
-			if (values["no-browser"]) {
+			if (noBrowser) {
 				console.info(`Open this URL to log in: ${url}`);
 			} else {
 				console.info("Opening browser to complete login...");
@@ -44,7 +27,7 @@ export async function login(): Promise<void> {
 	});
 
 	console.info(`Logged in to Prismic as ${email}`);
-}
+});
 
 function openBrowser(url: URL): void {
 	const cmd =

package/src/commands/logout.ts

@@ -1,36 +1,16 @@
-import { parseArgs } from "node:util";
-
 import { logout as baseLogout } from "../auth";
+import { CommandError, createCommand, type CommandConfig } from "../lib/command";
 
-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 config = {
+	name: "prismic logout",
+	description: "Log out of Prismic.",
+} satisfies CommandConfig;
 
+export default createCommand(config, async () => {
 	const ok = await baseLogout();
 	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;
+		throw new CommandError("Logout failed. You can log out manually by deleting the file.");
 	}
-}
+});

package/src/commands/preview-add.ts

@@ -0,0 +1,57 @@
+import { getHost, getToken } from "../auth";
+import { addPreview } from "../clients/core";
+import { CommandError, createCommand, type CommandConfig } from "../lib/command";
+import { UnknownRequestError } from "../lib/request";
+import { getRepositoryName } from "../project";
+
+const config = {
+	name: "prismic preview add",
+	description: `
+		Add a preview configuration to a Prismic repository.
+
+		By default, this command reads the repository from prismic.config.json at the
+		project root.
+	`,
+	positionals: {
+		url: { description: "Preview URL (e.g. https://example.com/api/preview)" },
+	},
+	options: {
+		name: { type: "string", short: "n", description: "Display name (defaults to hostname)" },
+		repo: { type: "string", short: "r", description: "Repository domain" },
+	},
+} satisfies CommandConfig;
+
+export default createCommand(config, async ({ positionals, values }) => {
+	const [previewUrl] = positionals;
+	const { repo = await getRepositoryName(), name } = values;
+
+	if (!previewUrl) {
+		throw new CommandError("Missing required argument: <url>");
+	}
+
+	let parsed: URL;
+	try {
+		parsed = new URL(previewUrl);
+	} catch {
+		throw new CommandError(`Invalid URL: ${previewUrl}`);
+	}
+
+	const displayName = name || parsed.hostname;
+	const websiteURL = `${parsed.protocol}//${parsed.host}`;
+	const resolverPath = parsed.pathname === "/" ? undefined : parsed.pathname;
+
+	const token = await getToken();
+	const host = await getHost();
+
+	try {
+		await addPreview({ name: displayName, websiteURL, resolverPath }, { repo, token, host });
+	} catch (error) {
+		if (error instanceof UnknownRequestError) {
+			const message = await error.text();
+			throw new CommandError(`Failed to add preview: ${message}`);
+		}
+		throw error;
+	}
+
+	console.info(`Preview added: ${previewUrl}`);
+});

package/src/commands/preview-list.ts

@@ -0,0 +1,54 @@
+import { getHost, getToken } from "../auth";
+import { getPreviews, getSimulatorUrl } from "../clients/core";
+import { createCommand, type CommandConfig } from "../lib/command";
+import { stringify } from "../lib/json";
+import { getRepositoryName } from "../project";
+
+const config = {
+	name: "prismic preview list",
+	description: `
+		List all preview configurations 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 [previews, simulatorUrl] = await Promise.all([
+		getPreviews({ repo, token, host }),
+		getSimulatorUrl({ repo, token, host }),
+	]);
+
+	if (json) {
+		console.info(
+			stringify({
+				previews,
+				simulatorUrl: simulatorUrl ?? null,
+			}),
+		);
+		return;
+	}
+
+	if (previews.length === 0 && !simulatorUrl) {
+		console.info("No preview configurations found.");
+		return;
+	}
+
+	for (const preview of previews) {
+		console.info(`${preview.url}  ${preview.label}`);
+	}
+
+	if (simulatorUrl) {
+		console.info(`\nSimulator: ${simulatorUrl}`);
+	}
+});

package/src/commands/preview-remove.ts

@@ -0,0 +1,51 @@
+import { getHost, getToken } from "../auth";
+import { getPreviews, removePreview } from "../clients/core";
+import { CommandError, createCommand, type CommandConfig } from "../lib/command";
+import { UnknownRequestError } from "../lib/request";
+import { getRepositoryName } from "../project";
+
+const config = {
+	name: "prismic preview remove",
+	description: `
+		Remove a preview configuration from a Prismic repository.
+
+		By default, this command reads the repository from prismic.config.json at the
+		project root.
+	`,
+	positionals: {
+		url: { description: "Preview URL to remove" },
+	},
+	options: {
+		repo: { type: "string", short: "r", description: "Repository domain" },
+	},
+} satisfies CommandConfig;
+
+export default createCommand(config, async ({ positionals, values }) => {
+	const [previewUrl] = positionals;
+	const { repo = await getRepositoryName() } = values;
+
+	if (!previewUrl) {
+		throw new CommandError("Missing required argument: <url>");
+	}
+
+	const token = await getToken();
+	const host = await getHost();
+
+	const previews = await getPreviews({ repo, token, host });
+	const preview = previews.find((p) => p.url === previewUrl);
+	if (!preview) {
+		throw new CommandError(`Preview not found: ${previewUrl}`);
+	}
+
+	try {
+		await removePreview(preview.id, { repo, token, host });
+	} catch (error) {
+		if (error instanceof UnknownRequestError) {
+			const message = await error.text();
+			throw new CommandError(`Failed to remove preview: ${message}`);
+		}
+		throw error;
+	}
+
+	console.info(`Preview removed: ${previewUrl}`);
+});