prismic 1.2.1 → 1.3.0

package/src/commands/token-delete.ts

@@ -0,0 +1,61 @@
+import { getHost, getToken } from "../auth";
+import {
+	deleteOAuthAuthorization,
+	deleteWriteToken,
+	getOAuthApps,
+	getWriteTokens,
+} from "../clients/wroom";
+import { CommandError, createCommand, type CommandConfig } from "../lib/command";
+import { getRepositoryName } from "../project";
+
+const config = {
+	name: "prismic token delete",
+	description: `
+		Delete a token from a Prismic repository.
+
+		By default, this command reads the repository from prismic.config.json at the
+		project root.
+	`,
+	positionals: {
+		token: { description: "Token value" },
+	},
+	options: {
+		repo: { type: "string", short: "r", description: "Repository domain" },
+	},
+} satisfies CommandConfig;
+
+export default createCommand(config, async ({ positionals, values }) => {
+	const [tokenValue] = positionals;
+	const { repo = await getRepositoryName() } = values;
+
+	if (!tokenValue) {
+		throw new CommandError("Missing required argument: <token>");
+	}
+
+	const token = await getToken();
+	const host = await getHost();
+
+	const [apps, writeTokensInfo] = await Promise.all([
+		getOAuthApps({ repo, token, host }),
+		getWriteTokens({ repo, token, host }),
+	]);
+
+	// Search access tokens
+	const accessTokenAuths = apps.flatMap((app) => app.wroom_auths);
+	const accessToken = accessTokenAuths.find((auth) => auth.token === tokenValue);
+	if (accessToken) {
+		await deleteOAuthAuthorization(accessToken.id, { repo, token, host });
+		console.info("Token deleted");
+		return;
+	}
+
+	// Search write tokens
+	const writeToken = writeTokensInfo.tokens.find((t) => t.token === tokenValue);
+	if (writeToken) {
+		await deleteWriteToken(writeToken.token, { repo, token, host });
+		console.info("Token deleted");
+		return;
+	}
+
+	throw new CommandError(`Token not found: ${tokenValue}`);
+});

package/src/commands/token-list.ts

@@ -0,0 +1,67 @@
+import { getHost, getToken } from "../auth";
+import { getOAuthApps, getWriteTokens } from "../clients/wroom";
+import { createCommand, type CommandConfig } from "../lib/command";
+import { stringify } from "../lib/json";
+import { getRepositoryName } from "../project";
+
+const config = {
+	name: "prismic token list",
+	description: `
+		List all API tokens for 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 [apps, writeTokensInfo] = await Promise.all([
+		getOAuthApps({ repo, token, host }),
+		getWriteTokens({ repo, token, host }),
+	]);
+
+	const accessTokens = apps.flatMap((app) =>
+		app.wroom_auths.map((auth) => ({
+			name: app.name,
+			scope: auth.scope,
+			token: auth.token,
+			createdAt: new Date(auth.created_at.$date).toISOString().split("T")[0],
+		})),
+	);
+	const writeTokens = writeTokensInfo.tokens;
+
+	if (json) {
+		console.info(stringify({ accessTokens, writeTokens }));
+		return;
+	}
+
+	if (accessTokens.length > 0) {
+		console.info("ACCESS TOKENS");
+		for (const accessToken of accessTokens) {
+			console.info(`  ${accessToken.name}  ${accessToken.scope}  ${accessToken.token}  ${accessToken.createdAt}`);
+		}
+	} else {
+		console.info("ACCESS TOKENS  (none)");
+	}
+
+	console.info("");
+
+	if (writeTokens.length > 0) {
+		console.info("WRITE TOKENS");
+		for (const writeToken of writeTokens) {
+			const date = new Date(writeToken.timestamp * 1000).toISOString().split("T")[0];
+			console.info(`  ${writeToken.app_name}  ${writeToken.token}  ${date}`);
+		}
+	} else {
+		console.info("WRITE TOKENS  (none)");
+	}
+});

package/src/commands/token.ts

@@ -0,0 +1,23 @@
+import { createCommandRouter } from "../lib/command";
+import tokenCreate from "./token-create";
+import tokenDelete from "./token-delete";
+import tokenList from "./token-list";
+
+export default createCommandRouter({
+	name: "prismic token",
+	description: "Manage API tokens for a Prismic repository.",
+	commands: {
+		list: {
+			handler: tokenList,
+			description: "List all tokens",
+		},
+		create: {
+			handler: tokenCreate,
+			description: "Create a new token",
+		},
+		delete: {
+			handler: tokenDelete,
+			description: "Delete a token",
+		},
+	},
+});

package/src/config.ts

@@ -1,3 +1,5 @@
+import type { CustomType } from "@prismicio/types-internal/lib/customtypes";
+
 import { readFile, rm, writeFile } from "node:fs/promises";
 import * as z from "zod/mini";
 
@@ -8,9 +10,20 @@ import { findPackageJson, MissingPackageJson } from "./lib/packageJson";
 const CONFIG_FILENAME = "prismic.config.json";
 const LEGACY_SLICE_MACHINE_CONFIG_FILENAME = "slicemachine.config.json";
 
+const RouteSchema = z.object({
+	type: z.string(),
+	path: z.string(),
+	uid: z.optional(z.string()),
+	lang: z.optional(z.string()),
+	resolvers: z.optional(z.record(z.string(), z.string())),
+});
+export type Route = z.infer<typeof RouteSchema>;
+
 const ConfigSchema = z.object({
 	repositoryName: z.string(),
+	documentAPIEndpoint: z.optional(z.url()),
 	libraries: z.optional(z.array(z.string())),
+	routes: z.optional(z.array(RouteSchema)),
 });
 export type Config = z.infer<typeof ConfigSchema>;
 
@@ -87,6 +100,46 @@ export class UnknownProjectRoot extends Error {
 	name = "UnknownProjectRoot";
 }
 
+export async function addRoute(pageType: CustomType): Promise<void> {
+	const { routes = [] } = await readConfig();
+	const hasRoute = routes.some((r) => r.type === pageType.id);
+	if (hasRoute) return;
+	const path = buildRoutePath(pageType);
+	const newRoute: Route = { type: pageType.id, path };
+	const newRoutes = [...routes, newRoute].sort((a, b) => a.type.localeCompare(b.type));
+	await updateConfig({ routes: newRoutes });
+}
+
+export async function updateRoute(pageType: CustomType): Promise<void> {
+	if (pageType.format === "page") {
+		const { routes = [] } = await readConfig();
+		const hasRoute = routes.some((r) => r.type === pageType.id);
+		if (hasRoute) return;
+		await addRoute(pageType);
+	} else {
+		await removeRoute(pageType.id);
+	}
+}
+
+export async function removeRoute(id: string): Promise<void> {
+	const { routes = [] } = await readConfig();
+	const newRoutes = routes.filter((r) => r.type !== id);
+	if (routes.length === newRoutes.length) return;
+	await updateConfig({ routes: newRoutes });
+}
+
+export function buildRoutePath(pageType: CustomType): string {
+	const { id, repeatable } = pageType;
+	const namespace = id.replaceAll("_", "-").toLowerCase();
+	if (repeatable) {
+		if (id === "page") return "/:uid";
+		return `/${namespace}/:uid`;
+	} else {
+		if (id === "homepage") return "/";
+		return `/${namespace}`;
+	}
+}
+
 export async function readLegacySliceMachineConfig(): Promise<LegacySliceMachineConfig> {
 	const configPath = await findLegacySliceMachineConfigPath();
 	try {

package/src/env.ts

@@ -3,6 +3,8 @@ import * as z from "zod/mini";
 const DEFAULT_PRISMIC_SENTRY_DSN =
 	"https://e1886b1775bd397cd1afc60bfd2ebfc8@o146123.ingest.us.sentry.io/4510445143588864";
 
+export const DEFAULT_PRISMIC_HOST = "prismic.io";
+
 const Env = z.object({
 	MODE: z.string(),
 	DEV: z.stringbool(),

package/src/index.ts

@@ -6,11 +6,15 @@ import packageJson from "../package.json" with { type: "json" };
 import { getAdapter, NoSupportedFrameworkError } from "./adapters";
 import { getHost, refreshToken } from "./auth";
 import { getProfile } from "./clients/user";
+import gen from "./commands/gen";
 import init from "./commands/init";
+import locale from "./commands/locale";
 import login from "./commands/login";
 import logout from "./commands/logout";
 import preview from "./commands/preview";
+import repo from "./commands/repo";
 import sync from "./commands/sync";
+import token from "./commands/token";
 import webhook from "./commands/webhook";
 import whoami from "./commands/whoami";
 import { InvalidPrismicConfig, MissingPrismicConfig } from "./config";
@@ -43,14 +47,30 @@ const router = createCommandRouter({
 			handler: init,
 			description: "Initialize a Prismic project",
 		},
+		gen: {
+			handler: gen,
+			description: "Generate files from local models",
+		},
 		sync: {
 			handler: sync,
 			description: "Sync types and slices from Prismic",
 		},
+		locale: {
+			handler: locale,
+			description: "Manage locales",
+		},
+		repo: {
+			handler: repo,
+			description: "Manage repositories",
+		},
 		preview: {
 			handler: preview,
 			description: "Manage preview configurations",
 		},
+		token: {
+			handler: token,
+			description: "Manage API tokens",
+		},
 		webhook: {
 			handler: webhook,
 			description: "Manage webhooks",

package/src/lib/codegen.ts

@@ -6,11 +6,13 @@ import { generateTypes } from "prismic-ts-codegen";
 export async function generateAndWriteTypes(args: {
 	customTypes: CustomType[];
 	slices: SharedSlice[];
-	projectRoot: URL;
+	output: URL;
 }): Promise<void> {
+	const { customTypes, slices, output } = args;
+
 	const types = generateTypes({
-		customTypeModels: args.customTypes,
-		sharedSliceModels: args.slices,
+		customTypeModels: customTypes,
+		sharedSliceModels: slices,
 		clientIntegration: {
 			includeContentNamespace: true,
 			includeCreateClientInterface: true,
@@ -18,6 +20,5 @@ export async function generateAndWriteTypes(args: {
 		cache: true,
 		typesProvider: "@prismicio/client",
 	});
-	const outputPath = new URL("prismicio-types.d.ts", args.projectRoot);
-	await writeFile(outputPath, types);
+	await writeFile(output, types);
 }

package/src/lib/url.ts

@@ -1,5 +1,12 @@
+import { relative } from "node:path";
+import { fileURLToPath } from "node:url";
+
 export function appendTrailingSlash(url: string | URL): URL {
 	const newURL = new URL(url);
 	if (!newURL.pathname.endsWith("/")) newURL.pathname += "/";
 	return newURL;
 }
+
+export function relativePathname(a: URL, b: URL): string {
+	return relative(fileURLToPath(a), fileURLToPath(b));
+}

package/dist/nextjs-DrbOdw3q.mjs

@@ -1,318 +0,0 @@
-import{C as e,T as t,a as n,b as r,n as i,o as a,t as o,v as s,w as c,y as l,z as u}from"./string-CnZrLYLV.mjs";import{createRequire as d}from"node:module";import{fileURLToPath as f}from"node:url";import{relative as p}from"node:path";const m=o`
-	return (
-		<section
-			data-slice-type={slice.slice_type}
-			data-slice-variation={slice.variation}
-		>
-			Placeholder component for {slice.slice_type} (variation: {slice.variation}) slices.
-			<br />
-			<strong>You can edit this slice directly in your code editor.</strong>
-		</section>
-	)
-`;function h(e){let{name:t,typescript:n}=e,r=u(t),i=o`
-		import { FC } from "react";
-		import { Content } from "@prismicio/client";
-		import { SliceComponentProps } from "@prismicio/react";
-
-		/**
-		 * Props for \`${r}\`.
-		 */
-		export type ${r}Props = SliceComponentProps<Content.${r}Slice>;
-
-		/**
-		 * Component for "${t}" Slices.
-		 */
-		const ${r}: FC<${r}Props> = ({ slice }) => {
-			${m}
-		};
-
-		export default ${r}
-	`,a=o`
-		/**
-		 * @typedef {import("@prismicio/client").Content.${r}Slice} ${r}Slice
-		 * @typedef {import("@prismicio/react").SliceComponentProps<${r}Slice>} ${r}Props
-		 * @type {import("react").FC<${r}Props>}
-		 */
-		const ${r} = ({ slice }) => {
-			${m}
-		};
-
-		export default ${r};
-	`;return n?i:a}function g(e){let{typescript:t,appRouter:n,hasSrcDirectory:r}=e,i=`${r?`..`:`.`}/prismic.config.json`,a,s;return n?t?(a=o`
-				import {
-					createClient as baseCreateClient,
-					type ClientConfig,
-					type Route,
-				} from "@prismicio/client";
-				import { enableAutoPreviews } from "@prismicio/next";
-				import prismicConfig from "${i}";
-			`,s=o`
-				/**
-				 * Creates a Prismic client for the project's repository. The client is used to
-				 * query content from the Prismic API.
-				 *
-				 * @param config - Configuration for the Prismic client.
-				 */
-				export const createClient = (config: ClientConfig = {}) => {
-					const client = baseCreateClient(repositoryName, {
-						routes,
-						fetchOptions:
-							process.env.NODE_ENV === 'production'
-								? { next: { tags: ['prismic'] }, cache: 'force-cache' }
-								: { next: { revalidate: 5 } },
-						...config,
-					});
-
-					enableAutoPreviews({ client });
-
-					return client;
-				};
-			`):(a=o`
-				import { createClient as baseCreateClient } from "@prismicio/client";
-				import { enableAutoPreviews } from "@prismicio/next";
-				import prismicConfig from "${i}";
-			`,s=o`
-				/**
-				 * Creates a Prismic client for the project's repository. The client is used to
-				 * query content from the Prismic API.
-				 *
-				 * @param {import("@prismicio/client").ClientConfig} config - Configuration for the Prismic client.
-				 */
-				export const createClient = (config = {}) => {
-					const client = baseCreateClient(repositoryName, {
-						routes,
-						fetchOptions:
-							process.env.NODE_ENV === 'production'
-								? { next: { tags: ['prismic'] }, cache: 'force-cache' }
-								: { next: { revalidate: 5 } },
-						...config,
-					});
-
-					enableAutoPreviews({ client });
-
-					return client;
-				};
-			`):t?(a=o`
-				import { createClient as baseCreateClient, type Routes } from "@prismicio/client";
-				import { enableAutoPreviews, type CreateClientConfig } from "@prismicio/next/pages";
-				import prismicConfig from "${i}";
-			`,s=o`
-				/**
-				 * Creates a Prismic client for the project's repository. The client is used to
-				 * query content from the Prismic API.
-				 *
-				 * @param config - Configuration for the Prismic client.
-				 */
-				export const createClient = ({ previewData, req, ...config }: CreateClientConfig = {}) => {
-					const client = baseCreateClient(repositoryName, {
-						routes,
-						...config,
-					});
-
-					enableAutoPreviews({ client, previewData, req });
-
-					return client;
-				};
-			`):(a=o`
-				import { createClient as baseCreateClient } from "@prismicio/client";
-				import { enableAutoPreviews } from "@prismicio/next/pages";
-				import prismicConfig from "${i}";
-			`,s=o`
-				/**
-				 * Creates a Prismic client for the project's repository. The client is used to
-				 * query content from the Prismic API.
-				 *
-				 * @param {import("@prismicio/next/pages").CreateClientConfig} config - Configuration for the Prismic client.
-				 */
-				export const createClient = ({ previewData, req, ...config } = {}) => {
-					const client = baseCreateClient(repositoryName, {
-						routes,
-						...config,
-					});
-
-					enableAutoPreviews({ client, previewData, req });
-
-					return client;
-				};
-			`),t?o`
-			${a}
-
-			/**
-			 * The project's Prismic repository name.
-			 */
-			export const repositoryName = prismicConfig.repositoryName;
-
-			/**
-			 * A list of Route Resolver objects that define how a document's \`url\` field is resolved.
-			 *
-			 * {@link https://prismic.io/docs/route-resolver#route-resolver}
-			 *
-			 * Note: \`prismic sync\` may append new default routes for Page Types. Feel free
-			 * to edit these to match your site's routing structure.
-			 */
-			// TODO: Update the routes array to match your project's route structure.
-			const routes: Route[] = [
-				// Examples:
-				// { type: "homepage", path: "/" },
-				// { type: "page", path: "/:uid" },
-			];
-
-			${s}
-		`:o`
-		${a}
-
-		/**
-		 * The project's Prismic repository name.
-		 */
-		export const repositoryName = prismicConfig.repositoryName;
-
-		/**
-		 * A list of Route Resolver objects that define how a document's \`url\` field is resolved.
-		 *
-		 * {@link https://prismic.io/docs/route-resolver#route-resolver}
-		 *
-		 * Note: \`prismic sync\` may append new default routes for Page Types. Feel free
-		 * to edit these to match your site's routing structure.
-		 *
-		 * @type {import("@prismicio/client").Route[]}
-		 */
-		// TODO: Update the routes array to match your project's route structure.
-		const routes = [
-			// Examples:
-			// { type: "homepage", path: "/" },
-			// { type: "page", path: "/:uid" },
-		];
-
-		${s}
-	`}function _(e){let{typescript:t,appRouter:n}=e,r=o`
-		import { SliceSimulator, SliceSimulatorParams, getSlices } from "@prismicio/next";
-		import { SliceZone } from "@prismicio/react";
-
-		import { components } from "../../slices";
-
-		export default async function SliceSimulatorPage({
-			searchParams,
-		}: SliceSimulatorParams) {
-			const { state } = await searchParams
-			const slices = getSlices(state);
-
-			return (
-				<SliceSimulator>
-					<SliceZone slices={slices} components={components} />
-				</SliceSimulator>
-			);
-		}
-	`,i=o`
-		import { SliceSimulator, getSlices } from "@prismicio/next";
-		import { SliceZone } from "@prismicio/react";
-
-		import { components } from "../../slices";
-
-		export default async function SliceSimulatorPage({ searchParams }) {
-			const { state } = await searchParams
-			const slices = getSlices(state);
-
-			return (
-				<SliceSimulator>
-					<SliceZone slices={slices} components={components} />
-				</SliceSimulator>
-			);
-		}
-	`,a=o`
-		import { SliceSimulator } from "@prismicio/next/pages";
-		import { SliceZone } from "@prismicio/react";
-
-		import { components } from "../slices";
-
-		export default function SliceSimulatorPage() {
-			return (
-				<SliceSimulator
-					sliceZone={(props) => <SliceZone {...props} components={components} />}
-				/>
-			);
-		}
-	`;return n?t?r:i:a}function v(e){let{typescript:t,appRouter:n}=e,r=o`
-		import { NextRequest } from "next/server";
-		import { redirectToPreviewURL } from "@prismicio/next";
-
-		import { createClient } from "../../../prismicio";
-
-		export async function GET(request: NextRequest) {
-			const client = createClient();
-
-			return await redirectToPreviewURL({ client, request });
-		}
-	`,i=o`
-		import { redirectToPreviewURL } from "@prismicio/next";
-
-		import { createClient } from "../../../prismicio";
-
-		export async function GET(request) {
-			const client = createClient();
-
-			return await redirectToPreviewURL({ client, request });
-		}
-	`,a=o`
-		import { NextApiRequest, NextApiResponse } from "next";
-		import { setPreviewData, redirectToPreviewURL } from "@prismicio/next/pages";
-
-		import { createClient } from "../../prismicio";
-
-		export default async function handler(req: NextApiRequest, res: NextApiResponse) {
-			const client = createClient({ req });
-
-			setPreviewData({ req, res });
-
-			return await redirectToPreviewURL({ req, res, client });
-		};
-	`,s=o`
-		import { setPreviewData, redirectToPreviewURL } from "@prismicio/next/pages";
-
-		import { createClient } from "../../prismicio";
-
-		export default async function handler(req, res) {
-			const client = createClient({ req });
-
-			setPreviewData({ req, res });
-
-			return await redirectToPreviewURL({ req, res, client });
-		};
-	`;return n?t?r:i:t?a:s}function y(e){let{typescript:t,appRouter:n}=e,r=o`
-		import { exitPreview } from "@prismicio/next";
-
-		export function GET() {
-			return exitPreview();
-		}
-	`,i=o`
-		import { NextApiRequest, NextApiResponse } from "next";
-		import { exitPreview } from "@prismicio/next/pages";
-
-		export default function handler(req: NextApiRequest, res: NextApiResponse) {
-			return exitPreview({ req, res });
-		}
-	`,a=o`
-		import { exitPreview } from "@prismicio/next/pages";
-
-		export default function handler(req, res) {
-			return exitPreview({ req, res });
-		}
-	`;return n?r:t?i:a}function b(e){let{supportsCacheLife:t}=e;return o`
-		import { NextResponse } from "next/server";
-		import { revalidateTag } from "next/cache";
-
-		export async function POST() {
-			revalidateTag("prismic"${t?`, "max"`:``});
-
-			return NextResponse.json({ revalidated: true, now: Date.now() });
-		}
-	`}var x=class extends i{id=`next`;async onProjectInitialized(){await s({"@prismicio/client":`^${await r(`@prismicio/client`)}`,"@prismicio/react":`^${await r(`@prismicio/react`)}`,"@prismicio/next":`^${await r(`@prismicio/next`)}`}),await E(),await T(),await w(),await C(),await S()}async onSliceCreated(e,r){let i=u(e.name),a=new URL(i,t(r)),o=await A();await c(new URL(`index.${o}x`,t(a)),h({name:e.name,typescript:await n()}))}onSliceUpdated(){}onSliceDeleted(){}onCustomTypeCreated(){}onCustomTypeUpdated(){}onCustomTypeDeleted(){}async createSliceIndexFile(e){let t=(await this.getSlices()).filter(t=>t.library.href===e.href),n=t.map(t=>`import ${u(t.model.name)} from "./${p(f(e),f(t.directory))}";`),r=t.map(e=>{let t=u(e.model.name);return`${e.model.id}: ${t}`}),i=o`
-			// Code generated by Prismic. DO NOT EDIT.
-
-			${n.join(`
-`)}
-
-			export const components = {
-				${r.join(`,
-`)}
-			};
-		`,a=`index.${await A()}`;await c(new URL(a,e),i)}async getDefaultSliceLibrary(){let e=await a(),t=await k();return new URL(t?`src/slices/`:`slices/`,e)}};async function S(){if(!await D())return;let t=await O(),n=await A(),r=new URL(`app/api/revalidate/route.${n}`,t);if(await e(r))return;let i=await j();await c(r,b({supportsCacheLife:Number.parseInt(i.split(`.`)[0])>=16}))}async function C(){let t=await D(),r=await O(),i=await A(),a=new URL(t?`app/api/exit-preview/route.${i}`:`pages/api/exit-preview.${i}`,r);await e(a)||await c(a,y({typescript:await n(),appRouter:t}))}async function w(){let t=await D(),r=await O(),i=await A(),a=new URL(t?`app/api/preview/route.${i}`:`pages/api/preview.${i}`,r);await e(a)||await c(a,v({typescript:await n(),appRouter:t}))}async function T(){let t=await D(),r=await O(),i=`${await A()}x`,a=new URL(t?`app/slice-simulator/page.${i}`:`pages/slice-simulator.${i}`,r);await e(a)||await c(a,_({typescript:await n(),appRouter:t}))}async function E(){let t=await A(),r=await O(),i=new URL(`prismicio.${t}`,r);await e(i)||await c(i,g({typescript:await n(),appRouter:await D(),hasSrcDirectory:await k()}))}async function D(){let t=await O();return await e(new URL(`app/`,t))}async function O(){let e=await a();return await k()?new URL(`src/`,e):e}async function k(){let t=await a();return e(new URL(`src/`,t))}async function A(){return await n()?`ts`:`js`}async function j(){let{version:e}=d(await l())(`next/package.json`);return e}export{x as NextJsAdapter};