@angeloashmore/prismic-cli-poc 0.0.0-canary.1143872

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/docs-fetch.ts

@@ -0,0 +1,146 @@
+import { parseArgs } from "node:util";
+
+const HELP = `
+Fetch and display documentation from Prismic's docs site.
+
+USAGE
+  prismic docs fetch <path> [flags]
+
+ARGUMENTS
+  path    Documentation path with optional anchor (e.g., "nextjs" or "nextjs#set-up-a-prismic-client")
+
+FLAGS
+  -h, --help   Show help for command
+
+EXAMPLES
+  prismic docs fetch nextjs
+  prismic docs fetch nextjs#set-up-a-prismic-client
+
+LEARN MORE
+  Visit https://prismic.io/docs for the full documentation.
+`.trim();
+
+function parsePathAndAnchor(input: string): { path: string; anchor?: string } {
+	const hashIndex = input.indexOf("#");
+	if (hashIndex === -1) {
+		return { path: input };
+	}
+	return {
+		path: input.slice(0, hashIndex),
+		anchor: input.slice(hashIndex + 1),
+	};
+}
+
+async function fetchMarkdown(
+	url: string,
+): Promise<{ ok: true; content: string } | { ok: false; error: string }> {
+	try {
+		const response = await fetch(url);
+		if (response.status === 404) {
+			return { ok: false, error: `Documentation not found: ${url}` };
+		}
+		if (!response.ok) {
+			return {
+				ok: false,
+				error: `Failed to fetch documentation: ${response.status}`,
+			};
+		}
+		const content = await response.text();
+		return { ok: true, content };
+	} catch (error) {
+		const message = error instanceof Error ? error.message : String(error);
+		return { ok: false, error: `Network error: ${message}` };
+	}
+}
+
+function anchorToHeadingPattern(anchor: string): RegExp {
+	// Convert kebab-case anchor to a pattern that matches the heading text.
+	const pattern = anchor
+		.split("-")
+		.map((word) => word.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"))
+		.join("[\\s-]+");
+	return new RegExp(`^(#{1,6})\\s+${pattern}\\s*$`, "im");
+}
+
+function extractSection(
+	markdown: string,
+	anchor: string,
+): { ok: true; content: string } | { ok: false; error: string } {
+	const lines = markdown.split("\n");
+	const headingPattern = anchorToHeadingPattern(anchor);
+
+	let startIndex = -1;
+	let headingLevel = 0;
+
+	for (let i = 0; i < lines.length; i++) {
+		const match = lines[i].match(headingPattern);
+		if (match) {
+			startIndex = i;
+			headingLevel = match[1].length;
+			break;
+		}
+	}
+
+	if (startIndex === -1) {
+		return { ok: false, error: `Anchor not found: #${anchor}` };
+	}
+
+	let endIndex = lines.length;
+	for (let i = startIndex + 1; i < lines.length; i++) {
+		const headingMatch = lines[i].match(/^(#{1,6})\s/);
+		if (headingMatch && headingMatch[1].length <= headingLevel) {
+			endIndex = i;
+			break;
+		}
+	}
+
+	const content = lines.slice(startIndex, endIndex).join("\n").trim();
+	return { ok: true, content };
+}
+
+export async function docsFetch(): Promise<void> {
+	const {
+		positionals: [pathArg],
+		values: { help },
+	} = parseArgs({
+		args: process.argv.slice(4),
+		options: {
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+	});
+
+	if (help) {
+		console.info(HELP);
+		return;
+	}
+
+	if (!pathArg) {
+		console.info(HELP);
+		return;
+	}
+
+	const { path, anchor } = parsePathAndAnchor(pathArg);
+	const url = `https://prismic.io/docs/${path}.md`;
+
+	const fetchResult = await fetchMarkdown(url);
+	if (!fetchResult.ok) {
+		console.error(fetchResult.error);
+		process.exitCode = 1;
+		return;
+	}
+
+	let output = fetchResult.content;
+
+	if (anchor) {
+		const extractResult = extractSection(output, anchor);
+		if (!extractResult.ok) {
+			console.error(extractResult.error);
+			process.exitCode = 1;
+			return;
+		}
+		output = extractResult.content;
+	}
+
+	console.info(output);
+}

package/src/docs-list.ts

@@ -0,0 +1,131 @@
+import { parseArgs } from "node:util";
+
+const HELP = `
+List documentation pages from Prismic's docs site.
+
+USAGE
+  prismic docs list [flags]
+
+FLAGS
+  -h, --help   Show help for command
+
+EXAMPLES
+  prismic docs list
+`.trim();
+
+const ROOT_SITEMAP_URL = "https://prismic.io/docs/sitemap.xml";
+
+function decodeXmlEntities(input: string): string {
+	return input
+		.replaceAll("&", "&")
+		.replaceAll("&lt;", "<")
+		.replaceAll("&gt;", ">")
+		.replaceAll("&quot;", '"')
+		.replaceAll("&apos;", "'");
+}
+
+function extractLocEntries(xml: string): string[] {
+	const locPattern = /<loc>(.*?)<\/loc>/g;
+	const entries: string[] = [];
+	let match = locPattern.exec(xml);
+
+	while (match) {
+		entries.push(decodeXmlEntities(match[1]).trim());
+		match = locPattern.exec(xml);
+	}
+
+	return entries.filter(Boolean);
+}
+
+async function fetchXml(url: string): Promise<{ ok: true; xml: string } | { ok: false; error: string }> {
+	try {
+		const response = await fetch(url);
+		if (!response.ok) {
+			return {
+				ok: false,
+				error: `Failed to fetch sitemap: ${response.status} (${url})`,
+			};
+		}
+
+		return {
+			ok: true,
+			xml: await response.text(),
+		};
+	} catch (error) {
+		const message = error instanceof Error ? error.message : String(error);
+		return { ok: false, error: `Network error while fetching sitemap ${url}: ${message}` };
+	}
+}
+
+function toDocsPath(urlString: string): string | null {
+	try {
+		const url = new URL(urlString);
+		if (url.hostname !== "prismic.io") {
+			return null;
+		}
+
+		if (!url.pathname.startsWith("/docs/")) {
+			return null;
+		}
+
+		return url.pathname.replace(/^\/docs\//, "").replace(/^\/+|\/+$/g, "");
+	} catch {
+		return null;
+	}
+}
+
+export async function docsList(): Promise<void> {
+	const {
+		values: { help },
+	} = parseArgs({
+		args: process.argv.slice(4),
+		options: {
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+	});
+
+	if (help) {
+		console.info(HELP);
+		return;
+	}
+
+	const rootResult = await fetchXml(ROOT_SITEMAP_URL);
+	if (!rootResult.ok) {
+		console.error(rootResult.error);
+		process.exitCode = 1;
+		return;
+	}
+
+	const nestedSitemapUrls = extractLocEntries(rootResult.xml);
+	if (nestedSitemapUrls.length === 0) {
+		console.error(`No nested sitemaps found in ${ROOT_SITEMAP_URL}`);
+		process.exitCode = 1;
+		return;
+	}
+
+	const nestedResults = await Promise.all(nestedSitemapUrls.map((url) => fetchXml(url)));
+	const failedFetch = nestedResults.find((result) => !result.ok);
+	if (failedFetch && !failedFetch.ok) {
+		console.error(failedFetch.error);
+		process.exitCode = 1;
+		return;
+	}
+
+	const paths = new Set<string>();
+
+	for (const nestedResult of nestedResults) {
+		if (!nestedResult.ok) continue;
+
+		for (const url of extractLocEntries(nestedResult.xml)) {
+			const path = toDocsPath(url);
+			if (path) {
+				paths.add(path);
+			}
+		}
+	}
+
+	for (const path of [...paths].sort((a, b) => a.localeCompare(b))) {
+		console.info(path);
+	}
+}

package/src/docs.ts

@@ -0,0 +1,54 @@
+import { parseArgs } from "node:util";
+import { docsFetch } from "./docs-fetch";
+import { docsList } from "./docs-list";
+
+const HELP = `
+Fetch and list documentation from Prismic's docs site.
+
+USAGE
+  prismic docs <command> [flags]
+
+COMMANDS
+  fetch      Fetch and display a documentation page
+  list       List documentation pages
+
+FLAGS
+  -h, --help   Show help for command
+
+EXAMPLES
+  prismic docs fetch nextjs
+  prismic docs fetch nextjs#set-up-a-prismic-client
+  prismic docs list
+
+LEARN MORE
+  Use \`prismic docs <command> --help\` for more information about a command.
+`.trim();
+
+export async function docs(): Promise<void> {
+	const {
+		positionals: [subcommand],
+	} = parseArgs({
+		args: process.argv.slice(3),
+		options: {
+			help: { type: "boolean", short: "h" },
+		},
+		allowPositionals: true,
+		strict: false,
+	});
+
+	switch (subcommand) {
+		case "fetch":
+			await docsFetch();
+			break;
+		case "list":
+			await docsList();
+			break;
+		default: {
+			if (subcommand) {
+				console.error(`Unknown docs subcommand: ${subcommand}\n`);
+				process.exitCode = 1;
+			}
+			console.info(HELP);
+		}
+	}
+}

package/src/index.ts

@@ -0,0 +1,132 @@
+#!/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 { docs } from "./docs";
+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
+  docs        Fetch and list documentation from Prismic
+  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 "docs":
+			await docs();
+			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;
+}