@angeloashmore/prismic-cli-poc 0.0.0-canary.1d36cd8

package/src/custom-type-set-name.ts

@@ -0,0 +1,144 @@
+import type { CustomType } from "@prismicio/types-internal/lib/customtypes";
+
+import { readFile, writeFile } from "node:fs/promises";
+import { parseArgs } from "node:util";
+import * as v from "valibot";
+
+import { buildTypes } from "./codegen-types";
+import { findUpward } from "./lib/file";
+import { stringify } from "./lib/json";
+
+const HELP = `
+Change a custom type's display name (label).
+
+USAGE
+  prismic custom-type set-name <type-id> <new-name> [flags]
+
+ARGUMENTS
+  type-id      Custom type identifier (required)
+  new-name     New display name (required)
+
+Types are generated by default after changes. Use --no-types to skip.
+
+FLAGS
+      --types string   Output file for generated types (default: "prismicio-types.d.ts")
+      --no-types       Skip type generation
+  -h, --help   Show help for command
+
+EXAMPLES
+  prismic custom-type set-name settings "Site Settings"
+  prismic custom-type set-name menu "Navigation Menu"
+`.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 customTypeSetName(): Promise<void> {
+	const {
+		values: { help, types, "no-types": noTypes },
+		positionals: [typeId, newName],
+	} = parseArgs({
+		args: process.argv.slice(4), // skip: node, script, "custom-type", "set-name"
+		options: {
+			types: { type: "string" },
+			"no-types": { 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 set-name <type-id> <new-name>");
+		process.exitCode = 1;
+		return;
+	}
+
+	if (!newName) {
+		console.error("Missing required argument: new-name\n");
+		console.error("Usage: prismic custom-type set-name <type-id> <new-name>");
+		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);
+
+	// Read and parse the model
+	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;
+	}
+
+	// Update the model
+	model.label = newName;
+
+	// Write updated model
+	try {
+		await writeFile(modelPath, stringify(model));
+	} catch (error) {
+		if (error instanceof Error) {
+			console.error(`Failed to update custom type: ${error.message}`);
+		} else {
+			console.error("Failed to update custom type");
+		}
+		process.exitCode = 1;
+		return;
+	}
+
+	console.info(`Renamed custom type "${typeId}" to "${newName}"`);
+
+	if (!noTypes) {
+		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}`);
+		}
+	}
+}

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,127 @@
+#!/usr/bin/env node
+
+import { parseArgs } from "node:util";
+
+import packageJson from "../package.json" with { type: "json" };
+import { codegen } from "./codegen";
+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 { pull } from "./pull";
+import { push } from "./push";
+import { repo } from "./repo";
+import { slice } from "./slice";
+import { status } from "./status";
+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
+  status      Show the status of the current project
+  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
+  pull        Pull types and slices from Prismic
+  push        Push types and slices to Prismic
+  codegen     Generate code from Prismic models
+  preview     Manage preview configurations
+  token       Manage API tokens in a repository
+  webhook     Manage webhooks in a repository
+
+FLAGS
+  -v, --version  Show CLI version
+  -h, --help     Show help for command
+
+LEARN MORE
+  Use \`prismic <command> --help\` for more information about a command.
+`.trim();
+
+const {
+	positionals,
+	values: { version },
+} = parseArgs({
+	options: {
+		help: { type: "boolean", short: "h" },
+		version: { type: "boolean", short: "v" },
+	},
+	allowPositionals: true,
+	strict: false,
+});
+
+if (version) {
+	console.info(packageJson.version);
+} else {
+	switch (positionals[0]) {
+		case "init":
+			await init();
+			break;
+		case "login":
+			await login();
+			break;
+		case "logout":
+			await logout();
+			break;
+		case "whoami":
+			await whoami();
+			break;
+		case "status":
+			await status();
+			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 "pull":
+			await pull();
+			break;
+		case "push":
+			await push();
+			break;
+		case "codegen":
+			await codegen();
+			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,64 @@
+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,83 @@
+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();
+	if (!token) return false;
+
+	// Verify token is still valid by calling the profile endpoint
+	try {
+		const host = await readHost();
+		host.hostname = `user-service.${host.hostname}`;
+		const url = new URL("profile", host);
+
+		const response = await fetch(url, {
+			headers: {
+				Accept: "application/json",
+				Cookie: `SESSION=fake_session; prismic-auth=${token}`,
+			},
+		});
+
+		if (!response.ok) {
+			await removeToken();
+			return false;
+		}
+
+		return true;
+	} catch {
+		return false;
+	}
+}
+
+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;
+}