prismic 1.1.0 → 1.2.0

package/src/adapters/nextjs.ts

@@ -0,0 +1,211 @@
+import type { SharedSlice } from "@prismicio/types-internal/lib/customtypes";
+
+import { pascalCase } from "change-case";
+import { createRequire } from "node:module";
+import { relative } from "node:path";
+import { fileURLToPath } from "node:url";
+
+import { Adapter } from ".";
+import { exists, writeFileRecursive } from "../lib/file";
+import { addDependencies, findPackageJson, getNpmPackageVersion } from "../lib/packageJson";
+import { dedent } from "../lib/string";
+import { appendTrailingSlash } from "../lib/url";
+import { checkIsTypeScriptProject, findProjectRoot } from "../project";
+import {
+	revalidateRouteTemplate,
+	exitPreviewRouteTemplate,
+	previewRouteTemplate,
+	prismicIOFileTemplate,
+	sliceSimulatorPageTemplate,
+	sliceTemplate,
+} from "./nextjs.templates";
+
+export class NextJsAdapter extends Adapter {
+	readonly id = "next";
+
+	async onProjectInitialized(): Promise<void> {
+		await addDependencies({
+			"@prismicio/client": `^${await getNpmPackageVersion("@prismicio/client")}`,
+			"@prismicio/react": `^${await getNpmPackageVersion("@prismicio/react")}`,
+			"@prismicio/next": `^${await getNpmPackageVersion("@prismicio/next")}`,
+		});
+		await createPrismicIoFile();
+		await createSliceSimulatorPage();
+		await createPreviewRoute();
+		await createExitPreviewRoute();
+		await createRevalidateRoute();
+	}
+
+	async onSliceCreated(model: SharedSlice, library: URL): Promise<void> {
+		const sliceDirectoryName = pascalCase(model.name);
+		const sliceDirectory = new URL(sliceDirectoryName, appendTrailingSlash(library));
+
+		const extension = await getJsFileExtension();
+		const componentPath = new URL(`index.${extension}x`, sliceDirectory);
+		const contents = sliceTemplate({
+			name: model.name,
+			typescript: await checkIsTypeScriptProject(),
+		});
+		await writeFileRecursive(componentPath, contents);
+	}
+
+	onSliceUpdated(): void {}
+
+	onSliceDeleted(): void {}
+
+	onCustomTypeCreated(): void {}
+
+	onCustomTypeUpdated(): void {}
+
+	onCustomTypeDeleted(): void {}
+
+	async createSliceIndexFile(library: URL): Promise<void> {
+		const allSlices = await this.getSlices();
+		const slices = allSlices.filter((slice) => slice.library.href === library.href);
+		const imports = slices.map((slice) => {
+			const componentName = pascalCase(slice.model.name);
+			const relativeDirectory = relative(fileURLToPath(library), fileURLToPath(slice.directory));
+			return `import ${componentName} from "./${relativeDirectory}";`;
+		});
+		const componentLines = slices.map((slice) => {
+			const componentName = pascalCase(slice.model.name);
+			return `${slice.model.id}: ${componentName}`;
+		});
+		const contents = dedent`
+			// Code generated by Prismic. DO NOT EDIT.
+
+			${imports.join("\n")}
+
+			export const components = {
+				${componentLines.join(",\n")}
+			};
+		`;
+		const extension = await getJsFileExtension();
+		const filename = `index.${extension}`;
+		const indexPath = new URL(filename, library);
+		await writeFileRecursive(indexPath, contents);
+	}
+
+	async getDefaultSliceLibrary(): Promise<URL> {
+		const projectRoot = await findProjectRoot();
+		const hasSrcDirectory = await checkHasSrc();
+		const defaultSliceLibrary = new URL(hasSrcDirectory ? "src/slices/" : "slices/", projectRoot);
+		return defaultSliceLibrary;
+	}
+}
+
+async function createRevalidateRoute(): Promise<void> {
+	const appRouter = await checkUsesAppRouter();
+	if (!appRouter) return;
+
+	const sourceRoot = await getSourceRoot();
+	const extension = await getJsFileExtension();
+	const filePath = new URL(`app/api/revalidate/route.${extension}`, sourceRoot);
+	if (await exists(filePath)) return;
+
+	const version = await getNextJsVersion();
+	const major = Number.parseInt(version.split(".")[0]);
+	const supportsCacheLife = major >= 16;
+
+	const contents = revalidateRouteTemplate({ supportsCacheLife });
+	await writeFileRecursive(filePath, contents);
+}
+
+async function createExitPreviewRoute(): Promise<void> {
+	const appRouter = await checkUsesAppRouter();
+	const sourceRoot = await getSourceRoot();
+	const extension = await getJsFileExtension();
+	const filePath = new URL(
+		appRouter ? `app/api/exit-preview/route.${extension}` : `pages/api/exit-preview.${extension}`,
+		sourceRoot,
+	);
+	if (await exists(filePath)) return;
+
+	const typescript = await checkIsTypeScriptProject();
+
+	const contents = exitPreviewRouteTemplate({ typescript, appRouter });
+	await writeFileRecursive(filePath, contents);
+}
+
+async function createPreviewRoute(): Promise<void> {
+	const appRouter = await checkUsesAppRouter();
+	const sourceRoot = await getSourceRoot();
+	const extension = await getJsFileExtension();
+	const filePath = new URL(
+		appRouter ? `app/api/preview/route.${extension}` : `pages/api/preview.${extension}`,
+		sourceRoot,
+	);
+	if (await exists(filePath)) return;
+
+	const typescript = await checkIsTypeScriptProject();
+
+	const contents = previewRouteTemplate({ typescript, appRouter });
+	await writeFileRecursive(filePath, contents);
+}
+
+async function createSliceSimulatorPage(): Promise<void> {
+	const appRouter = await checkUsesAppRouter();
+	const sourceRoot = await getSourceRoot();
+	const extension = `${await getJsFileExtension()}x`;
+	const filePath = new URL(
+		appRouter ? `app/slice-simulator/page.${extension}` : `pages/slice-simulator.${extension}`,
+		sourceRoot,
+	);
+	if (await exists(filePath)) return;
+
+	const typescript = await checkIsTypeScriptProject();
+
+	const contents = sliceSimulatorPageTemplate({ typescript, appRouter });
+	await writeFileRecursive(filePath, contents);
+}
+
+async function createPrismicIoFile(): Promise<void> {
+	const extension = await getJsFileExtension();
+	const sourceRoot = await getSourceRoot();
+	const filePath = new URL(`prismicio.${extension}`, sourceRoot);
+	if (await exists(filePath)) return;
+
+	const typescript = await checkIsTypeScriptProject();
+	const appRouter = await checkUsesAppRouter();
+	const hasSrcDirectory = await checkHasSrc();
+
+	const contents = prismicIOFileTemplate({
+		typescript,
+		appRouter,
+		hasSrcDirectory,
+	});
+	await writeFileRecursive(filePath, contents);
+}
+
+async function checkUsesAppRouter() {
+	const sourceDirectory = await getSourceRoot();
+	const appDirectory = new URL("app/", sourceDirectory);
+	const usesAppRouter = await exists(appDirectory);
+	return usesAppRouter;
+}
+
+async function getSourceRoot() {
+	const projectRoot = await findProjectRoot();
+	const hasSrcDirectory = await checkHasSrc();
+	if (hasSrcDirectory) return new URL("src/", projectRoot);
+	return projectRoot;
+}
+
+async function checkHasSrc(): Promise<boolean> {
+	const projectRoot = await findProjectRoot();
+	const srcDirectory = new URL("src/", projectRoot);
+	return exists(srcDirectory);
+}
+
+async function getJsFileExtension() {
+	const isTypeScriptProject = await checkIsTypeScriptProject();
+	const jsFileExtension = isTypeScriptProject ? "ts" : "js";
+	return jsFileExtension;
+}
+
+async function getNextJsVersion() {
+	const packageJsonPath = await findPackageJson();
+	const require = createRequire(packageJsonPath);
+	const { version } = require("next/package.json");
+	return version;
+}

package/src/adapters/nuxt.ts

@@ -0,0 +1,232 @@
+import type { SharedSlice } from "@prismicio/types-internal/lib/customtypes";
+
+import { pascalCase } from "change-case";
+import { builders, loadFile, writeFile as magicastWriteFile } from "magicast";
+import { readFile, rm } from "node:fs/promises";
+import { relative } from "node:path";
+import { fileURLToPath } from "node:url";
+
+import { Adapter } from ".";
+import { readConfig, updateConfig } from "../config";
+import { exists, writeFileRecursive } from "../lib/file";
+import { addDependencies, getNpmPackageVersion } from "../lib/packageJson";
+import { dedent } from "../lib/string";
+import { appendTrailingSlash } from "../lib/url";
+import { checkIsTypeScriptProject, findProjectRoot } from "../project";
+import { sliceSimulatorPageTemplate, sliceTemplate } from "./nuxt.templates";
+
+const NUXT_PRISMIC = "@nuxtjs/prismic";
+
+export class NuxtAdapter extends Adapter {
+	readonly id = "nuxt";
+
+	async onProjectInitialized(): Promise<void> {
+		await addDependencies({
+			"@prismicio/client": `^${await getNpmPackageVersion("@prismicio/client")}`,
+			[NUXT_PRISMIC]: `^${await getNpmPackageVersion(NUXT_PRISMIC)}`,
+		});
+		await configureNuxtModule();
+		await createSliceSimulatorPage();
+		await moveOrDeleteAppVue();
+		await modifySliceLibraryPath(this);
+	}
+
+	async onSliceCreated(model: SharedSlice, library: URL): Promise<void> {
+		const sliceDirectoryName = pascalCase(model.name);
+		const sliceDirectory = new URL(sliceDirectoryName, appendTrailingSlash(library));
+
+		const componentPath = new URL("index.vue", sliceDirectory);
+		const contents = sliceTemplate({
+			name: model.name,
+			typescript: await checkIsTypeScriptProject(),
+		});
+		await writeFileRecursive(componentPath, contents);
+	}
+
+	onSliceUpdated(): void {}
+
+	onSliceDeleted(): void {}
+
+	onCustomTypeCreated(): void {}
+
+	onCustomTypeUpdated(): void {}
+
+	onCustomTypeDeleted(): void {}
+
+	async createSliceIndexFile(library: URL): Promise<void> {
+		const allSlices = await this.getSlices();
+		const slices = allSlices.filter((slice) => slice.library.href === library.href);
+		const componentLines = slices.map((slice) => {
+			const relativeDirectory = relative(fileURLToPath(library), fileURLToPath(slice.directory));
+			return `${slice.model.id}: defineAsyncComponent(() => import("./${relativeDirectory}/index.vue"))`;
+		});
+		const contents = dedent`
+			// Code generated by Prismic. DO NOT EDIT.
+
+			import { defineAsyncComponent } from "vue";
+			import { defineSliceZoneComponents } from "@prismicio/vue";
+
+			export const components = defineSliceZoneComponents({
+				${componentLines.join(",\n")}
+			});
+		`;
+		const extension = await getJsFileExtension();
+		const filename = `index.${extension}`;
+		const indexPath = new URL(filename, library);
+		await writeFileRecursive(indexPath, contents);
+	}
+
+	async getDefaultSliceLibrary(): Promise<URL> {
+		const srcDir = await getSrcDir();
+		return new URL("slices/", srcDir);
+	}
+}
+
+async function getSrcDir(): Promise<URL> {
+	const projectRoot = await findProjectRoot();
+	const appDir = new URL("app/", projectRoot);
+	if (await exists(appDir)) return appDir;
+	const srcDir = new URL("src/", projectRoot);
+	if (await exists(srcDir)) return srcDir;
+	return projectRoot;
+}
+
+async function configureNuxtModule(): Promise<void> {
+	const projectRoot = await findProjectRoot();
+
+	let configUrl = new URL("nuxt.config.js", projectRoot);
+	if (!(await exists(configUrl))) {
+		configUrl = new URL("nuxt.config.ts", projectRoot);
+	}
+	if (!(await exists(configUrl))) {
+		return;
+	}
+
+	const filepath = fileURLToPath(configUrl);
+	const mod = await loadFile(filepath);
+	const config =
+		mod.exports.default.$type === "function-call"
+			? mod.exports.default.$args[0]
+			: mod.exports.default;
+
+	// Check if @nuxtjs/prismic is already registered
+	let hasInlinedConfiguration = false;
+	const hasPrismicModuleRegistered = (config.modules || []).find(
+		(registration: string | [string, unknown]) => {
+			if (typeof registration === "string") {
+				return registration === NUXT_PRISMIC;
+			} else if (Array.isArray(registration)) {
+				hasInlinedConfiguration = !!registration[1];
+				return registration[0] === NUXT_PRISMIC;
+			}
+			return false;
+		},
+	);
+
+	if (!hasPrismicModuleRegistered) {
+		config.modules ||= [];
+		config.modules.push(NUXT_PRISMIC);
+	}
+
+	// Append Prismic module configuration if not inlined
+	if (!hasInlinedConfiguration) {
+		mod.imports.$prepend({
+			from: "./prismic.config.json",
+			imported: "repositoryName",
+		});
+
+		config.prismic ||= {};
+		config.prismic.endpoint = builders.raw("repositoryName");
+	}
+
+	await magicastWriteFile(mod, filepath);
+}
+
+async function createSliceSimulatorPage(): Promise<void> {
+	const projectRoot = await findProjectRoot();
+	const typescript = await checkIsTypeScriptProject();
+
+	// Check for existing pages directories in priority order
+	const appPagesDir = new URL("app/pages/", projectRoot);
+	const srcPagesDir = new URL("src/pages/", projectRoot);
+	const pagesDir = new URL("pages/", projectRoot);
+
+	let targetDir: URL;
+	if (await exists(appPagesDir)) {
+		targetDir = appPagesDir;
+	} else if (await exists(srcPagesDir)) {
+		targetDir = srcPagesDir;
+	} else if (await exists(pagesDir)) {
+		targetDir = pagesDir;
+	} else {
+		targetDir = new URL("pages/", await getSrcDir());
+	}
+
+	const filePath = new URL("slice-simulator.vue", targetDir);
+
+	if (await exists(filePath)) {
+		return;
+	}
+
+	const contents = sliceSimulatorPageTemplate({ typescript });
+	await writeFileRecursive(filePath, contents);
+}
+
+async function moveOrDeleteAppVue(): Promise<void> {
+	const srcDir = await getSrcDir();
+	const appVuePath = new URL("app.vue", srcDir);
+
+	if (!(await exists(appVuePath))) {
+		return;
+	}
+
+	const contents = await readFile(appVuePath, "utf8");
+
+	if (!contents.includes("<NuxtWelcome")) {
+		return;
+	}
+
+	const indexVuePath = new URL("pages/index.vue", srcDir);
+
+	if (!(await exists(indexVuePath))) {
+		await writeFileRecursive(indexVuePath, contents);
+	}
+
+	await rm(appVuePath);
+}
+
+async function modifySliceLibraryPath(adapter: NuxtAdapter): Promise<void> {
+	const projectRoot = await findProjectRoot();
+	const hasAppDir = await exists(new URL("app/", projectRoot));
+	const hasSrcDir = await exists(new URL("src/", projectRoot));
+
+	if (!hasAppDir && !hasSrcDir) {
+		return;
+	}
+
+	let config;
+	try {
+		config = await readConfig();
+	} catch {
+		return;
+	}
+
+	const libraries = config.libraries;
+	if (!libraries || JSON.stringify(libraries) !== JSON.stringify(["./slices"])) {
+		return;
+	}
+
+	// Only modify if the default library has no slices yet
+	const slices = await adapter.getSlices();
+	if (slices.length > 0) {
+		return;
+	}
+
+	const newLibrary = hasAppDir ? "./app/slices" : "./src/slices";
+	await updateConfig({ libraries: [newLibrary] });
+}
+
+async function getJsFileExtension(): Promise<string> {
+	const isTypeScriptProject = await checkIsTypeScriptProject();
+	return isTypeScriptProject ? "ts" : "js";
+}

package/src/adapters/sveltekit.ts

@@ -0,0 +1,226 @@
+import type { SharedSlice } from "@prismicio/types-internal/lib/customtypes";
+
+import { pascalCase } from "change-case";
+import { loadFile } from "magicast";
+import { writeFile } from "node:fs/promises";
+import { createRequire } from "node:module";
+import { relative } from "node:path";
+import { fileURLToPath } from "node:url";
+
+import { Adapter } from ".";
+import { exists, writeFileRecursive } from "../lib/file";
+import { addDependencies, findPackageJson, getNpmPackageVersion } from "../lib/packageJson";
+import { dedent } from "../lib/string";
+import { appendTrailingSlash } from "../lib/url";
+import { checkIsTypeScriptProject, findProjectRoot } from "../project";
+import {
+	previewAPIRouteTemplate,
+	prismicIOFileTemplate,
+	rootLayoutTemplate,
+	sliceSimulatorPageTemplate,
+	sliceTemplate,
+} from "./sveltekit.templates";
+
+export class SvelteKitAdapter extends Adapter {
+	readonly id = "sveltekit";
+
+	async onProjectInitialized(): Promise<void> {
+		await addDependencies({
+			"@prismicio/client": `^${await getNpmPackageVersion("@prismicio/client")}`,
+			"@prismicio/svelte": `^${await getNpmPackageVersion("@prismicio/svelte")}`,
+		});
+		await createPrismicIoFile();
+		await createSliceSimulatorPage();
+		await createPreviewRouteMatcher();
+		await createPreviewAPIRoute();
+		await createPreviewRouteDirectory();
+		await createRootLayoutServerFile();
+		await createRootLayoutFile();
+		await modifyViteConfig();
+	}
+
+	async onSliceCreated(model: SharedSlice, library: URL): Promise<void> {
+		const sliceDirectoryName = pascalCase(model.name);
+		const sliceDirectory = new URL(sliceDirectoryName, appendTrailingSlash(library));
+
+		const componentPath = new URL("index.svelte", sliceDirectory);
+		const contents = sliceTemplate({
+			name: model.name,
+			typescript: await checkIsTypeScriptProject(),
+			version: await getSvelteMajor(),
+		});
+		await writeFileRecursive(componentPath, contents);
+	}
+
+	onSliceUpdated(): void {}
+
+	onSliceDeleted(): void {}
+
+	onCustomTypeCreated(): void {}
+
+	onCustomTypeUpdated(): void {}
+
+	onCustomTypeDeleted(): void {}
+
+	async createSliceIndexFile(library: URL): Promise<void> {
+		const allSlices = await this.getSlices();
+		const slices = allSlices.filter((slice) => slice.library.href === library.href);
+		const imports = slices.map((slice) => {
+			const componentName = pascalCase(slice.model.name);
+			const relativeDirectory = relative(fileURLToPath(library), fileURLToPath(slice.directory));
+			return `import ${componentName} from "./${relativeDirectory}/index.svelte";`;
+		});
+		const componentLines = slices.map((slice) => {
+			const componentName = pascalCase(slice.model.name);
+			return `${slice.model.id}: ${componentName}`;
+		});
+		const contents = dedent`
+			// Code generated by Prismic. DO NOT EDIT.
+
+			${imports.join("\n")}
+
+			export const components = {
+				${componentLines.join(",\n")}
+			};
+		`;
+		const extension = await getJsFileExtension();
+		const filename = `index.${extension}`;
+		const indexPath = new URL(filename, library);
+		await writeFileRecursive(indexPath, contents);
+	}
+
+	async getDefaultSliceLibrary(): Promise<URL> {
+		const projectRoot = await findProjectRoot();
+		return new URL("src/lib/slices/", projectRoot);
+	}
+}
+
+async function createPrismicIoFile(): Promise<void> {
+	const extension = await getJsFileExtension();
+	const projectRoot = await findProjectRoot();
+	const filePath = new URL(`src/lib/prismicio.${extension}`, projectRoot);
+	if (await exists(filePath)) return;
+
+	const typescript = await checkIsTypeScriptProject();
+	const contents = prismicIOFileTemplate({ typescript });
+	await writeFileRecursive(filePath, contents);
+}
+
+async function createSliceSimulatorPage(): Promise<void> {
+	const projectRoot = await findProjectRoot();
+	const filePath = new URL("src/routes/slice-simulator/+page.svelte", projectRoot);
+	if (await exists(filePath)) return;
+
+	const contents = sliceSimulatorPageTemplate({
+		version: await getSvelteMajor(),
+	});
+	await writeFileRecursive(filePath, contents);
+}
+
+async function createPreviewRouteMatcher(): Promise<void> {
+	const extension = await getJsFileExtension();
+	const projectRoot = await findProjectRoot();
+	const filePath = new URL(`src/params/preview.${extension}`, projectRoot);
+	if (await exists(filePath)) return;
+
+	const contents = dedent`
+		export function match(param) {
+			return param === 'preview';
+		}
+	`;
+	await writeFileRecursive(filePath, contents);
+}
+
+async function createPreviewAPIRoute(): Promise<void> {
+	const extension = await getJsFileExtension();
+	const projectRoot = await findProjectRoot();
+	const filePath = new URL(`src/routes/api/preview/+server.${extension}`, projectRoot);
+	if (await exists(filePath)) return;
+
+	const typescript = await checkIsTypeScriptProject();
+	const contents = previewAPIRouteTemplate({ typescript });
+	await writeFileRecursive(filePath, contents);
+}
+
+async function createPreviewRouteDirectory(): Promise<void> {
+	const projectRoot = await findProjectRoot();
+	const filePath = new URL("src/routes/[[preview=preview]]/README.md", projectRoot);
+	if (await exists(filePath)) return;
+
+	const contents = dedent`
+		This directory adds support for optional \`/preview\` routes. Do not remove this directory.
+
+		All routes within this directory will be served using the following URLs:
+
+		- \`/example-route\` (prerendered)
+		- \`/preview/example-route\` (server-rendered)
+
+		See <https://prismic.io/docs/svelte-preview> for more information.
+	`;
+	await writeFileRecursive(filePath, contents);
+}
+
+async function createRootLayoutServerFile(): Promise<void> {
+	const extension = await getJsFileExtension();
+	const projectRoot = await findProjectRoot();
+	const filePath = new URL(`src/routes/+layout.server.${extension}`, projectRoot);
+	if (await exists(filePath)) return;
+
+	const contents = dedent`
+		export const prerender = "auto";
+	`;
+	await writeFileRecursive(filePath, contents);
+}
+
+async function createRootLayoutFile(): Promise<void> {
+	const projectRoot = await findProjectRoot();
+	const filePath = new URL("src/routes/+layout.svelte", projectRoot);
+	if (await exists(filePath)) return;
+
+	const contents = rootLayoutTemplate({
+		version: await getSvelteMajor(),
+	});
+	await writeFileRecursive(filePath, contents);
+}
+
+async function modifyViteConfig(): Promise<void> {
+	const projectRoot = await findProjectRoot();
+	let configUrl = new URL("vite.config.js", projectRoot);
+	if (!(await exists(configUrl))) {
+		configUrl = new URL("vite.config.ts", projectRoot);
+	}
+	if (!(await exists(configUrl))) {
+		return;
+	}
+
+	const filepath = configUrl.pathname;
+	const mod = await loadFile(filepath);
+	if (mod.exports.default.$type !== "function-call") {
+		return;
+	}
+
+	const config = mod.exports.default.$args[0];
+	config.server ??= {};
+	config.server.fs ??= {};
+	config.server.fs.allow ??= [];
+	if (!config.server.fs.allow.includes("./prismic.config.json")) {
+		config.server.fs.allow.push("./prismic.config.json");
+	}
+
+	const contents = mod.generate().code.replace(/\n\s*\n(?=\s*server:)/, "\n");
+	await writeFile(configUrl, contents);
+}
+
+async function getJsFileExtension(): Promise<string> {
+	const isTypeScriptProject = await checkIsTypeScriptProject();
+	return isTypeScriptProject ? "ts" : "js";
+}
+
+async function getSvelteMajor(): Promise<number> {
+	const packageJsonPath = await findPackageJson();
+	const require = createRequire(packageJsonPath);
+	const { version } = require("svelte/package.json");
+	const major = Number.parseInt(version.split(".")[0]);
+	if (Number.isNaN(major)) return Infinity;
+	return major;
+}