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

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/index.ts

@@ -0,0 +1,100 @@
+#!/usr/bin/env node
+
+import { parseArgs } from "node:util";
+
+import { customType } from "./custom-type";
+import { init } from "./init";
+import { locale } from "./locale";
+import { login } from "./login";
+import { logout } from "./logout";
+import { pageType } from "./page-type";
+import { preview } from "./preview";
+import { repo } from "./repo";
+import { slice } from "./slice";
+import { sync } from "./sync";
+import { token } from "./token";
+import { webhook } from "./webhook";
+import { whoami } from "./whoami";
+
+const HELP = `
+Prismic CLI for managing repositories and configurations.
+
+USAGE
+  prismic <command> [flags]
+
+COMMANDS
+  init        Initialize a Prismic project
+  login       Log in to Prismic
+  logout      Log out of Prismic
+  whoami      Show the currently logged in user
+  repo        Manage Prismic repositories
+  locale      Manage locales in a repository
+  page-type   Manage page types in a repository
+  custom-type Manage custom types in a repository
+  slice       Manage slices in a project
+  sync        Sync types and slices from Prismic
+  preview     Manage preview configurations
+  token       Manage API tokens in a repository
+  webhook     Manage webhooks in a repository
+
+FLAGS
+  -h, --help   Show help for command
+
+LEARN MORE
+  Use \`prismic <command> --help\` for more information about a command.
+`.trim();
+
+const { positionals } = parseArgs({
+	options: { help: { type: "boolean", short: "h" } },
+	allowPositionals: true,
+	strict: false,
+});
+
+switch (positionals[0]) {
+	case "init":
+		await init();
+		break;
+	case "login":
+		await login();
+		break;
+	case "logout":
+		await logout();
+		break;
+	case "whoami":
+		await whoami();
+		break;
+	case "repo":
+		await repo();
+		break;
+	case "locale":
+		await locale();
+		break;
+	case "page-type":
+		await pageType();
+		break;
+	case "custom-type":
+		await customType();
+		break;
+	case "slice":
+		await slice();
+		break;
+	case "sync":
+		await sync();
+		break;
+	case "preview":
+		await preview();
+		break;
+	case "token":
+		await token();
+		break;
+	case "webhook":
+		await webhook();
+		break;
+	default: {
+		if (positionals[0]) {
+			console.error(`Unknown command: ${positionals[0]}`);
+			process.exitCode = 1;
+		}
+		console.info(HELP);
+	}
+}

package/src/init.ts

@@ -0,0 +1,62 @@
+import { parseArgs } from "node:util";
+
+import { createConfig, readConfig, UnknownProjectRoot } from "./lib/config";
+
+const HELP = `
+Initialize a Prismic project by creating a prismic.config.json file.
+
+Use this command to connect an existing Prismic repository to your project.
+To create a new repository, use \`prismic repo create\` instead.
+
+USAGE
+  prismic init [flags]
+
+FLAGS
+  -r, --repo   Repository name (required)
+  -h, --help   Show help for command
+
+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" },
+		},
+	});
+
+	if (values.help) {
+		console.info(HELP);
+		return;
+	}
+
+	if (!values.repo) {
+		console.error("Missing required flag: --repo");
+		process.exitCode = 1;
+		return;
+	}
+
+	const existingConfig = await readConfig();
+	if (existingConfig.ok) {
+		console.error("A prismic.config.json file already exists.");
+		process.exitCode = 1;
+		return;
+	}
+
+	const result = await createConfig({ repositoryName: values.repo });
+
+	if (!result.ok) {
+		if (result.error instanceof UnknownProjectRoot) {
+			console.error("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;
+	}
+
+	console.info(`Created prismic.config.json for repository "${values.repo}"`);
+}

package/src/lib/auth.ts

@@ -0,0 +1,60 @@
+import { access, readFile, rm, writeFile } from "node:fs/promises";
+import { homedir } from "node:os";
+import { pathToFileURL } from "node:url";
+
+import { appendTrailingSlash } from "./url";
+
+const AUTH_FILE_PATH = new URL(".prismic", appendTrailingSlash(pathToFileURL(homedir())));
+const DEFAULT_HOST = "https://prismic.io";
+
+type AuthContents = {
+	token?: string;
+	host?: string;
+};
+
+export async function saveToken(token: string, options?: { host?: string }): Promise<void> {
+	const contents: AuthContents = { token, host: options?.host };
+	await writeFile(AUTH_FILE_PATH, JSON.stringify(contents, null, 2));
+}
+
+export async function isAuthenticated(): Promise<boolean> {
+	const token = await readToken();
+	return Boolean(token);
+}
+
+export async function readToken(): Promise<string | undefined> {
+	const auth = await readAuthFile();
+	return auth?.token;
+}
+
+export async function readHost(): Promise<URL> {
+	try {
+		const auth = await readAuthFile();
+		if (!auth?.host) return new URL(DEFAULT_HOST);
+		return new URL(auth.host);
+	} catch {
+		return new URL(DEFAULT_HOST);
+	}
+}
+
+async function readAuthFile(): Promise<AuthContents | undefined> {
+	try {
+		const contents = await readFile(AUTH_FILE_PATH, "utf-8");
+		return JSON.parse(contents);
+	} catch {
+		return undefined;
+	}
+}
+
+export async function removeToken(): Promise<boolean> {
+	try {
+		await access(AUTH_FILE_PATH);
+	} catch {
+		return true;
+	}
+
+	const auth = await readAuthFile();
+	if (!auth) return false;
+	await rm(AUTH_FILE_PATH);
+	return true;
+}

package/src/lib/config.ts

@@ -0,0 +1,111 @@
+import { writeFile } from "node:fs/promises";
+import { readFile } from "node:fs/promises";
+import { pathToFileURL } from "node:url";
+import * as v from "valibot";
+
+import { findUpward } from "./file";
+import { stringify } from "./json";
+
+const CONFIG_FILENAME = "prismic.config.json";
+
+const ConfigSchema = v.object({
+	repositoryName: v.string(),
+	apiEndpoint: v.optional(v.pipe(v.string(), v.url())),
+	localSliceMachineSimulatorURL: v.optional(v.pipe(v.string(), v.url())),
+	libraries: v.optional(v.array(v.string())),
+	adapter: v.optional(v.string()),
+	labs: v.optional(
+		v.object({
+			legacySliceUpgrader: v.optional(v.boolean()),
+		}),
+	),
+});
+type Config = v.InferOutput<typeof ConfigSchema>;
+
+export type ConfigResult = SuccessfulConfigResult | FailedConfigResult;
+export type SuccessfulConfigResult = { ok: true; config: Config };
+export type FailedConfigResult = {
+	ok: false;
+	error: InvalidPrismicConfig | MissingPrismicConfig;
+};
+export type UnknownProjectRootConfigResult = {
+	ok: false;
+	error: UnknownProjectRoot;
+};
+
+export async function createConfig(
+	config: Config,
+	cwd = pathToFileURL(process.cwd()),
+): Promise<ConfigResult | UnknownProjectRootConfigResult> {
+	const result = await findSuggestedConfigPath(cwd);
+	if (!result.ok) return result;
+	await writeFile(result.path, stringify(config));
+	return { ok: true, config };
+}
+
+export async function safeGetRepositoryFromConfig(
+	cwd = pathToFileURL(process.cwd()),
+): Promise<string | undefined> {
+	const result = await readConfig(cwd);
+	if (result.ok) return result.config.repositoryName;
+}
+
+export async function readConfig(cwd = pathToFileURL(process.cwd())): Promise<ConfigResult> {
+	const findResult = await findConfig(cwd);
+	if (!findResult.ok) return findResult;
+
+	try {
+		const contents = await readFile(findResult.path, "utf8");
+		const result = v.safeParse(ConfigSchema, JSON.parse(contents));
+		if (!result.success) {
+			return { ok: false, error: new InvalidPrismicConfig(result.issues) };
+		}
+		return { ok: true, config: result.output };
+	} catch {
+		return { ok: false, error: new InvalidPrismicConfig() };
+	}
+}
+
+export class InvalidPrismicConfig extends Error {
+	issues: v.InferIssue<typeof ConfigSchema>[];
+
+	constructor(issues: v.InferIssue<typeof ConfigSchema>[] = []) {
+		super("prismic.config.json is invalid.");
+		this.issues = issues;
+	}
+}
+
+export async function updateConfig(
+	config: Partial<Config>,
+	cwd = pathToFileURL(process.cwd()),
+): Promise<ConfigResult> {
+	const findResult = await findConfig(cwd);
+	if (!findResult.ok) return findResult;
+
+	const readResult = await readConfig(cwd);
+	if (!readResult.ok) return readResult;
+
+	const updatedConfig = { ...readResult.config, ...config };
+	await writeFile(findResult.path, stringify(updatedConfig));
+	return { ok: true, config: updatedConfig };
+}
+
+async function findConfig(cwd = pathToFileURL(process.cwd())) {
+	const path = await findUpward(CONFIG_FILENAME, { start: cwd, stop: "package.json" });
+	if (!path) return { ok: false, error: new MissingPrismicConfig() } as const;
+	return { ok: true, path } as const;
+}
+
+async function findSuggestedConfigPath(cwd = pathToFileURL(process.cwd())) {
+	const path = await findUpward("package.json", { start: cwd });
+	if (!path) return { ok: false, error: new UnknownProjectRoot() } as const;
+	return { ok: true, path: new URL(CONFIG_FILENAME, path) } as const;
+}
+
+export class MissingPrismicConfig extends Error {
+	message = "Could not find a prismic.config.json file.";
+}
+
+export class UnknownProjectRoot extends Error {
+	message = "Could not find a package.json file.";
+}

package/src/lib/file.ts

@@ -0,0 +1,49 @@
+import { access } from "node:fs/promises";
+import { pathToFileURL } from "node:url";
+
+import { appendTrailingSlash } from "./url";
+
+export async function findUpward(
+	name: string,
+	config: { start?: URL; stop?: URL | string } = {},
+): Promise<URL | undefined> {
+	const { start = pathToFileURL(process.cwd()), stop } = config;
+
+	let dir = appendTrailingSlash(start);
+
+	while (true) {
+		const path = new URL(name, dir);
+		try {
+			await access(path);
+			return path;
+		} catch {}
+
+		if (typeof stop === "string") {
+			const stopPath = new URL(stop, dir);
+			try {
+				await access(stopPath);
+				return;
+			} catch {}
+		} else if (stop instanceof URL) {
+			if (stop.href === dir.href) {
+				return;
+			}
+		}
+
+		const parent = new URL("..", dir);
+		if (parent.href === dir.href) {
+			return undefined;
+		}
+
+		dir = parent;
+	}
+}
+
+export async function exists(path: URL): Promise<boolean> {
+	try {
+		await access(path);
+		return true;
+	} catch {
+		return false;
+	}
+}

package/src/lib/json.ts

@@ -0,0 +1,3 @@
+export function stringify(input: unknown): string {
+	return JSON.stringify(input, null, 2);
+}

package/src/lib/request.ts

@@ -0,0 +1,116 @@
+import * as v from "valibot";
+
+import { readToken } from "./auth";
+
+type CustomRequestInit = Omit<RequestInit, "body"> & {
+	body?: RequestInit["body"] | Record<PropertyKey, unknown>;
+};
+
+export type RequestResponse<T> = SuccessfulRequestResponse<T> | FailedRequestResponse;
+export type ParsedRequestResponse<T> =
+	| RequestResponse<T>
+	| { ok: false; value: unknown; error: v.ValiError<v.GenericSchema<T>> };
+export type SuccessfulRequestResponse<T> = { ok: true; value: T };
+export type FailedRequestResponse = {
+	ok: false;
+	value: unknown;
+	error: RequestError | ForbiddenRequestError | UnauthorizedRequestError;
+};
+export type FailedParsedRequestResponse<T> =
+	| FailedRequestResponse
+	| { ok: false; value: unknown; error: v.ValiError<v.GenericSchema<T>> };
+
+export async function request<T>(
+	input: RequestInfo | URL,
+	init?: CustomRequestInit,
+): Promise<RequestResponse<T>>;
+export async function request<T>(
+	input: RequestInfo | URL,
+	init: CustomRequestInit & { schema: v.GenericSchema<T> },
+): Promise<ParsedRequestResponse<T>>;
+export async function request<T>(
+	input: RequestInfo | URL,
+	init: CustomRequestInit & { schema?: v.GenericSchema<T> } = {},
+): Promise<ParsedRequestResponse<T>> {
+	const { credentials = "include" } = init;
+
+	const headers = new Headers(init.headers);
+	headers.set("Accept", "application/json");
+	if (credentials === "include") {
+		const token = await readToken();
+		if (token) headers.set("Cookie", `SESSION=fake_session; prismic-auth=${token}`);
+	}
+	if (!headers.has("Content-Type") && init.body) {
+		headers.set("Content-Type", "application/json");
+	}
+	if (init.body instanceof FormData) {
+		headers.delete("Content-Type");
+	}
+
+	const body =
+		headers.get("Content-Type") === "application/json"
+			? JSON.stringify(init.body)
+			: (init.body as RequestInit["body"]);
+
+	const response = await fetch(input, { ...init, body, headers });
+
+	const value = await response
+		.clone()
+		.json()
+		.catch(() => response.clone().text());
+
+	if (response.ok) {
+		if (!init?.schema) return { ok: true, value };
+
+		try {
+			const parsed = v.parse(init.schema, value);
+			return { ok: true, value: parsed };
+		} catch (error) {
+			if (v.isValiError<v.GenericSchema<T>>(error)) {
+				return { ok: false, value, error };
+			}
+			throw error;
+		}
+	} else {
+		if (response.status === 401) {
+			const error = new UnauthorizedRequestError(response);
+			return { ok: false, value, error };
+		} else if (response.status === 403) {
+			const error = new ForbiddenRequestError(response);
+			return { ok: false, value, error };
+		} else {
+			const error = new RequestError(response);
+			return { ok: false, value, error };
+		}
+	}
+}
+
+export class RequestError extends Error {
+	name = "RequestError" as const;
+	response: Response;
+
+	constructor(response: Response) {
+		super(`fetch failed: ${response.url}`);
+		this.response = response;
+	}
+
+	async text(): Promise<string> {
+		return this.response.clone().text();
+	}
+
+	async json(): Promise<unknown> {
+		return this.response.clone().json();
+	}
+
+	get status(): number {
+		return this.response.status;
+	}
+
+	get statusText(): string {
+		return this.response.statusText;
+	}
+}
+
+export class ForbiddenRequestError extends RequestError {}
+
+export class UnauthorizedRequestError extends RequestError {}