prismic 1.1.0 → 1.2.0

package/src/frameworks/index.ts

@@ -1,398 +0,0 @@
-import type { CustomType, SharedSlice } from "@prismicio/types-internal/lib/customtypes";
-
-import { pascalCase } from "change-case";
-import { readFile, rename, rm } from "node:fs/promises";
-import { relative } from "node:path";
-import { fileURLToPath, pathToFileURL } from "node:url";
-import { glob } from "tinyglobby";
-import * as z from "zod/mini";
-
-import { readConfig } from "../config";
-import { exists, findUpward, writeFileRecursive } from "../lib/file";
-import { stringify } from "../lib/json";
-import { addDependencies } from "../lib/packageJson";
-import { dedent } from "../lib/string";
-import { appendTrailingSlash } from "../lib/url";
-
-export abstract class FrameworkAdapter {
-	abstract readonly id: Framework;
-
-	abstract getDependencies(): Promise<Record<string, string>>;
-
-	abstract getClientFilePath(): Promise<string | null>;
-
-	abstract getSlicesDirectoryPath(): Promise<string>;
-
-	abstract getSliceComponentExtensions(): string[];
-
-	abstract getRoutePath(route: string): Promise<{ path: string; extensions: string[] } | null>;
-
-	abstract createSliceComponent(
-		model: SharedSlice,
-		sliceDirectory: URL,
-	): Promise<{ componentPath: URL }>;
-
-	abstract getSliceImportPath(relativeDirectory: string): string;
-
-	abstract getDefaultSliceLibraryPath(projectRoot: URL): Promise<URL>;
-
-	async initProject(): Promise<void> {
-		const deps = await this.getDependencies();
-		await addDependencies(deps);
-		const libraries = await this.#getSliceLibraries();
-		for (const library of libraries) {
-			await this.#updateSliceLibraryIndexFile(library);
-		}
-	}
-
-	async createSlice(
-		model: SharedSlice,
-		library: URL,
-	): Promise<{ modelPath: URL; componentPath: URL; indexPath: URL }> {
-		const { modelPath } = await this.#writeSliceModel(model, library);
-		const sliceDirectory = await this.#getSliceDirectory(model.name, library);
-		const { componentPath } = await this.createSliceComponent(model, sliceDirectory);
-		const { indexPath } = await this.#updateSliceLibraryIndexFile(library);
-		return { modelPath, componentPath, indexPath };
-	}
-
-	async readSlice(sliceId: string): Promise<SharedSlice> {
-		const slice = await this.#findSlice(sliceId);
-		return slice.model;
-	}
-
-	async updateSlice(model: SharedSlice): Promise<{ modelPath: URL; indexPath: URL }> {
-		const existingSlice = await this.#findSlice(model.id);
-		const { modelPath } = await this.#writeSliceModel(model, existingSlice.library);
-		const { indexPath } = await this.#updateSliceLibraryIndexFile(existingSlice.library);
-		return { modelPath, indexPath };
-	}
-
-	async renameSlice(model: SharedSlice): Promise<{ modelPath: URL; indexPath: URL }> {
-		const existingSlice = await this.#findSlice(model.id);
-		const newSliceDirectory = await this.#getSliceDirectory(model.name, existingSlice.library);
-		await rename(existingSlice.directory, newSliceDirectory);
-		const { modelPath } = await this.#writeSliceModel(model, existingSlice.library);
-		const { indexPath } = await this.#updateSliceLibraryIndexFile(existingSlice.library);
-		return { modelPath, indexPath };
-	}
-
-	async deleteSlice(sliceId: string): Promise<{ sliceDirectory: URL; indexPath: URL }> {
-		const slice = await this.#findSlice(sliceId);
-		await rm(slice.directory, { recursive: true });
-		const { indexPath } = await this.#updateSliceLibraryIndexFile(slice.library);
-		return { sliceDirectory: slice.directory, indexPath };
-	}
-
-	async getSlices(library?: URL): Promise<{ library: URL; directory: URL; model: SharedSlice }[]> {
-		const libraryDirs = library ? [library] : await this.#getSliceLibraries();
-		const allSlices: {
-			library: URL;
-			directory: URL;
-			model: SharedSlice;
-		}[] = [];
-
-		for (const libraryDir of libraryDirs) {
-			const modelGlob = new URL("*/model.json", libraryDir);
-			const sliceModelPaths = Array.from(
-				await glob(fileURLToPath(modelGlob), { absolute: true }),
-				(path) => pathToFileURL(path),
-			);
-			const slices = await Promise.all(
-				sliceModelPaths.map(async (sliceModelPath) => {
-					const directory = new URL(".", sliceModelPath);
-					const model = await readFile(sliceModelPath, "utf8");
-					return {
-						library: libraryDir,
-						directory,
-						model: JSON.parse(model),
-					};
-				}),
-			);
-			allSlices.push(...slices);
-		}
-
-		return allSlices.sort((a, b) =>
-			a.model.id.toLowerCase().localeCompare(b.model.id.toLowerCase()),
-		);
-	}
-
-	async getDefaultSliceLibrary(): Promise<URL> {
-		const dirs = await this.#getSliceLibraries();
-		return dirs[0];
-	}
-
-	async createCustomType(model: CustomType): Promise<{ modelPath: URL }> {
-		const { modelPath } = await this.#writeCustomType(model);
-		return { modelPath };
-	}
-
-	async readCustomType(customTypeId: string): Promise<CustomType> {
-		const customTypeDirectory = await this.#getCustomTypeDirectory(customTypeId);
-		const modelPath = new URL("index.json", customTypeDirectory);
-		const model = await readFile(modelPath, "utf8");
-		const json = JSON.parse(model);
-		return json;
-	}
-
-	async updateCustomType(model: CustomType): Promise<{ modelPath: URL }> {
-		const { modelPath } = await this.#writeCustomType(model);
-		return { modelPath };
-	}
-
-	async renameCustomType(model: CustomType): Promise<{ modelPath: URL }> {
-		const existingCustomTypeDirectory = await this.#getCustomTypeDirectory(model.id);
-		const newCustomTypeDirectory = await this.#getCustomTypeDirectory(model.id);
-		await rename(existingCustomTypeDirectory, newCustomTypeDirectory);
-		const { modelPath } = await this.#writeCustomType(model);
-		return { modelPath };
-	}
-
-	async deleteCustomType(customTypeId: string): Promise<{ customTypeDirectory: URL }> {
-		const customTypeDirectory = await this.#getCustomTypeDirectory(customTypeId);
-		await rm(customTypeDirectory, { recursive: true });
-		return { customTypeDirectory };
-	}
-
-	async getCustomTypes(): Promise<{ directory: URL; model: CustomType }[]> {
-		const customTypesDirectory = await this.#getCustomTypesDirectory();
-		const modelGlob = new URL("*/index.json", customTypesDirectory);
-		const customTypeModelPaths = Array.from(
-			await glob(fileURLToPath(modelGlob), { absolute: true }),
-			(path) => pathToFileURL(path),
-		);
-		const customTypes = await Promise.all(
-			customTypeModelPaths.map(async (customTypeModelPath) => {
-				const directory = new URL(".", customTypeModelPath);
-				const model = await readFile(customTypeModelPath, "utf8");
-				return {
-					directory,
-					model: JSON.parse(model),
-				};
-			}),
-		);
-		return customTypes.sort((a, b) =>
-			a.model.id.toLowerCase().localeCompare(b.model.id.toLowerCase()),
-		);
-	}
-
-	async getProjectRoot(): Promise<URL> {
-		const packageJsonPath = await findUpward("package.json");
-		if (!packageJsonPath) {
-			throw new Error("No package.json found");
-		}
-		const projectRoot = new URL("./", packageJsonPath);
-		return projectRoot;
-	}
-
-	protected async checkIsTypeScriptProject(): Promise<boolean> {
-		const projectRoot = await this.getProjectRoot();
-		const tsconfigPath = new URL("tsconfig.json", projectRoot);
-		const isTypeScriptProject = await exists(tsconfigPath);
-		return isTypeScriptProject;
-	}
-
-	protected async getJsFileExtension(): Promise<string> {
-		const isTypeScriptProject = await this.checkIsTypeScriptProject();
-		const jsFileExtension = isTypeScriptProject ? "ts" : "js";
-		return jsFileExtension;
-	}
-
-	async #findSlice(sliceId: string): Promise<{ library: URL; directory: URL; model: SharedSlice }> {
-		const slices = await this.getSlices();
-		const slice = slices.find((slice) => slice.model.id === sliceId);
-		if (!slice) throw new Error(`No slice found with ID: ${sliceId}`);
-		return slice;
-	}
-
-	async #writeSliceModel(model: SharedSlice, library: URL): Promise<{ modelPath: URL }> {
-		const sliceDirectory = await this.#getSliceDirectory(model.name, library);
-		const modelPath = new URL("model.json", sliceDirectory);
-		const formattedModel = this.#formatModel(model);
-		await writeFileRecursive(modelPath, formattedModel);
-		return { modelPath };
-	}
-
-	async #getSliceDirectory(sliceName: string, library: URL): Promise<URL> {
-		const sliceDirectoryName = pascalCase(sliceName);
-		const sliceDirectory = appendTrailingSlash(new URL(sliceDirectoryName, library));
-		return sliceDirectory;
-	}
-
-	async #getSliceLibraries(): Promise<URL[]> {
-		const projectRoot = await this.getProjectRoot();
-		const config = await readConfig();
-		const sliceLibraries = config.libraries ?? [];
-		if (sliceLibraries.length < 1) {
-			return [await this.getDefaultSliceLibraryPath(projectRoot)];
-		}
-		return sliceLibraries.map((sliceLibrary) => {
-			const withoutLeadingSlash = sliceLibrary.replace(/^\//, "");
-			return appendTrailingSlash(new URL(withoutLeadingSlash, projectRoot));
-		});
-	}
-
-	async #updateSliceLibraryIndexFile(library: URL): Promise<{ indexPath: URL }> {
-		const slices = await this.getSlices(library);
-		const contents = await this.generateSliceLibraryIndexContents(slices);
-		const extension = await this.getJsFileExtension();
-		const filename = `index.${extension}`;
-		const indexPath = new URL(filename, library);
-		await writeFileRecursive(indexPath, contents);
-		return { indexPath };
-	}
-
-	protected async generateSliceLibraryIndexContents(
-		slices: { library: URL; directory: URL; model: SharedSlice }[],
-	): Promise<string> {
-		const imports = slices.map((slice) => {
-			const componentName = pascalCase(slice.model.name);
-			const relativeDirectory = relative(
-				fileURLToPath(slice.library),
-				fileURLToPath(slice.directory),
-			);
-			return `import ${componentName} from "${this.getSliceImportPath(relativeDirectory)}";`;
-		});
-		const componentLines = slices.map((slice) => {
-			const componentName = pascalCase(slice.model.name);
-			return `${slice.model.id}: ${componentName}`;
-		});
-		return dedent`
-			// Code generated by Prismic. DO NOT EDIT.
-
-			${imports.join("\n")}
-
-			export const components = {
-				${componentLines.join(",\n")}
-			};
-		`;
-	}
-
-	async #writeCustomType(model: CustomType): Promise<{ modelPath: URL }> {
-		const customTypeDirectory = await this.#getCustomTypeDirectory(model.id);
-		const modelPath = new URL("index.json", customTypeDirectory);
-		const formattedModel = this.#formatModel(model);
-		await writeFileRecursive(modelPath, formattedModel);
-		return { modelPath };
-	}
-
-	async #getCustomTypeDirectory(customTypeId: string): Promise<URL> {
-		const customTypesDirectory = await this.#getCustomTypesDirectory();
-		const customTypeDirectoryName = customTypeId;
-		const customTypeDirectory = appendTrailingSlash(
-			new URL(customTypeDirectoryName, customTypesDirectory),
-		);
-		return customTypeDirectory;
-	}
-
-	async #getCustomTypesDirectory(): Promise<URL> {
-		const projectRoot = await this.getProjectRoot();
-		const customTypesDirectory = new URL(`customtypes/`, projectRoot);
-		return customTypesDirectory;
-	}
-
-	#formatModel(model: CustomType | SharedSlice): string {
-		const formattedModel = stringify(model);
-		return formattedModel;
-	}
-}
-
-export function getDocsPath(framework: Framework): string {
-	switch (framework) {
-		case "next":
-			return "nextjs/with-cli";
-		case "nuxt":
-			return "nuxt/with-cli";
-		case "sveltekit":
-			return "sveltekit/with-cli";
-	}
-}
-
-export function getWriteComponentsAnchor(framework: Framework): string {
-	switch (framework) {
-		case "nuxt":
-			return "#write-vue-components";
-		case "sveltekit":
-			return "#write-svelte-components";
-		default:
-			return "#write-react-components";
-	}
-}
-
-export function getClientSetupAnchor(framework: Framework): string {
-	switch (framework) {
-		case "nuxt":
-			return "#configure-the-modules-prismic-client";
-		default:
-			return "#set-up-a-prismic-client";
-	}
-}
-
-export function getPreviewSetupAnchor(framework: Framework): string {
-	switch (framework) {
-		case "next":
-			return "#set-up-previews-in-next-js";
-		case "sveltekit":
-			return "#set-up-previews-in-sveltekit";
-		default:
-			return "";
-	}
-}
-
-const PackageJsonSchema = z.object({
-	dependencies: z.optional(z.record(z.string(), z.string())),
-	devDependencies: z.optional(z.record(z.string(), z.string())),
-});
-
-export type Framework = "next" | "nuxt" | "sveltekit";
-
-export async function requireFramework(): Promise<FrameworkAdapter> {
-	const framework = await getFramework();
-	if (!framework) throw new NoSupportedFrameworkError();
-	return framework;
-}
-
-export class NoSupportedFrameworkError extends Error {
-	message = "No supported framework found (Next.js, Nuxt, or SvelteKit required)";
-}
-
-export async function getFramework(): Promise<FrameworkAdapter | undefined> {
-	const id = await detectFramework();
-	switch (id) {
-		case "next": {
-			const { NextJsFramework } = await import("./nextjs");
-			return new NextJsFramework();
-		}
-		case "nuxt": {
-			const { NuxtFramework } = await import("./nuxt");
-			return new NuxtFramework();
-		}
-		case "sveltekit": {
-			const { SvelteKitFramework } = await import("./sveltekit");
-			return new SvelteKitFramework();
-		}
-		default:
-			return undefined;
-	}
-}
-
-async function detectFramework(): Promise<Framework | undefined> {
-	const packageJsonPath = await findUpward("package.json");
-	if (!packageJsonPath) return undefined;
-
-	try {
-		const contents = await readFile(packageJsonPath, "utf8");
-		const { dependencies = {}, devDependencies = {} } = z.parse(
-			PackageJsonSchema,
-			JSON.parse(contents),
-		);
-		const allDeps = { ...dependencies, ...devDependencies };
-		if ("next" in allDeps) return "next";
-		if ("nuxt" in allDeps) return "nuxt";
-		if ("@sveltejs/kit" in allDeps) return "sveltekit";
-	} catch {
-		// Continue with undefined
-	}
-
-	return undefined;
-}

package/src/frameworks/nextjs.ts

@@ -1,211 +0,0 @@
-import type { SharedSlice } from "@prismicio/types-internal/lib/customtypes";
-
-import { createRequire } from "node:module";
-
-import type { Framework } from ".";
-
-import { FrameworkAdapter } from ".";
-import { exists, writeFileRecursive } from "../lib/file";
-import { getNpmPackageVersion } from "../lib/packageJson";
-import {
-	exitPreviewRouteTemplate,
-	previewRouteTemplate,
-	prismicIOFileTemplate,
-	revalidateRouteTemplate,
-	sliceSimulatorPageTemplate,
-	sliceTemplate,
-} from "./nextjs.templates";
-
-export class NextJsFramework extends FrameworkAdapter {
-	readonly id: Framework = "next";
-
-	async getDependencies(): Promise<Record<string, string>> {
-		return {
-			"@prismicio/client": `^${await getNpmPackageVersion("@prismicio/client")}`,
-			"@prismicio/react": `^${await getNpmPackageVersion("@prismicio/react")}`,
-			"@prismicio/next": `^${await getNpmPackageVersion("@prismicio/next")}`,
-		};
-	}
-
-	async initProject(): Promise<void> {
-		await super.initProject();
-
-		await this.#createPrismicIOFile();
-		await this.#createSliceSimulatorPage();
-		await this.#createPreviewRoute();
-		await this.#createExitPreviewRoute();
-		await this.#createRevalidateRoute();
-	}
-
-	async createSliceComponent(
-		model: SharedSlice,
-		sliceDirectory: URL,
-	): Promise<{ componentPath: URL }> {
-		const extension = await this.getJsFileExtension();
-		const componentPath = new URL(`index.${extension}x`, sliceDirectory);
-		const contents = sliceTemplate({
-			name: model.name,
-			typescript: await this.checkIsTypeScriptProject(),
-		});
-		await writeFileRecursive(componentPath, contents);
-		return { componentPath };
-	}
-
-	getSliceImportPath(relativeDirectory: string): string {
-		return `./${relativeDirectory}`;
-	}
-
-	async getDefaultSliceLibraryPath(projectRoot: URL): Promise<URL> {
-		const srcDirectory = new URL("src/", projectRoot);
-		const hasSrcDirectory = await exists(srcDirectory);
-		const sourceFilesRoot = hasSrcDirectory ? srcDirectory : projectRoot;
-		return new URL("slices/", sourceFilesRoot);
-	}
-
-	async getClientFilePath(): Promise<string | null> {
-		const hasSrcDirectory = await this.#checkHasSrcDirectory();
-		return hasSrcDirectory ? "src/prismicio.ts" : "prismicio.ts";
-	}
-
-	async getSlicesDirectoryPath(): Promise<string> {
-		const hasSrcDirectory = await this.#checkHasSrcDirectory();
-		return hasSrcDirectory ? "src/slices/" : "slices/";
-	}
-
-	getSliceComponentExtensions(): string[] {
-		return [".tsx", ".ts", ".jsx", ".js"];
-	}
-
-	async getRoutePath(route: string): Promise<{ path: string; extensions: string[] } | null> {
-		const hasSrcDirectory = await this.#checkHasSrcDirectory();
-		const base = hasSrcDirectory ? "src/app" : "app";
-		switch (route) {
-			case "/slice-simulator":
-				return { path: `${base}/slice-simulator/page`, extensions: [".tsx", ".ts", ".jsx", ".js"] };
-			case "/api/preview":
-				return { path: `${base}/api/preview/route`, extensions: [".ts", ".js"] };
-			case "/api/exit-preview":
-				return { path: `${base}/api/exit-preview/route`, extensions: [".ts", ".js"] };
-			case "/api/revalidate":
-				return { path: `${base}/api/revalidate/route`, extensions: [".ts", ".js"] };
-			default:
-				return null;
-		}
-	}
-
-	async #checkHasAppRouter(): Promise<boolean> {
-		const appPath = await this.#buildSrcPath("app");
-		return await exists(appPath);
-	}
-
-	async #checkHasSrcDirectory(): Promise<boolean> {
-		const projectRoot = await this.getProjectRoot();
-		return await exists(new URL("src/", projectRoot));
-	}
-
-	async #getNextJSVersion(): Promise<string> {
-		const projectRoot = await this.getProjectRoot();
-		const require = createRequire(new URL("package.json", projectRoot));
-		const { version } = require("next/package.json");
-		return version;
-	}
-
-	async #buildSrcPath(filename: string): Promise<URL> {
-		const projectRoot = await this.getProjectRoot();
-		const hasSrcDirectory = await this.#checkHasSrcDirectory();
-		const prefix = hasSrcDirectory ? "src/" : "";
-		return new URL(`${prefix}${filename}`, projectRoot);
-	}
-
-	async #createPrismicIOFile(): Promise<void> {
-		const extension = await this.getJsFileExtension();
-		const filePath = await this.#buildSrcPath(`prismicio.${extension}`);
-
-		if (await exists(filePath)) {
-			return;
-		}
-
-		const typescript = await this.checkIsTypeScriptProject();
-		const appRouter = await this.#checkHasAppRouter();
-		const hasSrcDirectory = await this.#checkHasSrcDirectory();
-
-		const contents = prismicIOFileTemplate({
-			typescript,
-			appRouter,
-			hasSrcDirectory,
-		});
-		await writeFileRecursive(filePath, contents);
-	}
-
-	async #createSliceSimulatorPage(): Promise<void> {
-		const appRouter = await this.#checkHasAppRouter();
-		const typescript = await this.checkIsTypeScriptProject();
-		const extension = `${await this.getJsFileExtension()}x`;
-		const filename = appRouter
-			? `app/slice-simulator/page.${extension}`
-			: `pages/slice-simulator.${extension}`;
-		const filePath = await this.#buildSrcPath(filename);
-
-		if (await exists(filePath)) {
-			return;
-		}
-
-		const contents = sliceSimulatorPageTemplate({ typescript, appRouter });
-		await writeFileRecursive(filePath, contents);
-	}
-
-	async #createPreviewRoute(): Promise<void> {
-		const appRouter = await this.#checkHasAppRouter();
-		const typescript = await this.checkIsTypeScriptProject();
-		const extension = await this.getJsFileExtension();
-		const filename = appRouter
-			? `app/api/preview/route.${extension}`
-			: `pages/api/preview.${extension}`;
-		const filePath = await this.#buildSrcPath(filename);
-
-		if (await exists(filePath)) {
-			return;
-		}
-
-		const contents = previewRouteTemplate({ typescript, appRouter });
-		await writeFileRecursive(filePath, contents);
-	}
-
-	async #createExitPreviewRoute(): Promise<void> {
-		const appRouter = await this.#checkHasAppRouter();
-		const typescript = await this.checkIsTypeScriptProject();
-		const extension = await this.getJsFileExtension();
-		const filename = appRouter
-			? `app/api/exit-preview/route.${extension}`
-			: `pages/api/exit-preview.${extension}`;
-		const filePath = await this.#buildSrcPath(filename);
-
-		if (await exists(filePath)) {
-			return;
-		}
-
-		const contents = exitPreviewRouteTemplate({ typescript, appRouter });
-		await writeFileRecursive(filePath, contents);
-	}
-
-	async #createRevalidateRoute(): Promise<void> {
-		const appRouter = await this.#checkHasAppRouter();
-		if (!appRouter) {
-			return;
-		}
-
-		const extension = await this.getJsFileExtension();
-		const filePath = await this.#buildSrcPath(`app/api/revalidate/route.${extension}`);
-
-		if (await exists(filePath)) {
-			return;
-		}
-
-		const version = await this.#getNextJSVersion();
-		const major = Number.parseInt(version.split(".")[0]);
-		const supportsCacheLife = major >= 16;
-
-		const contents = revalidateRouteTemplate({ supportsCacheLife });
-		await writeFileRecursive(filePath, contents);
-	}
-}