prismic 1.1.0 → 1.2.0

package/src/frameworks/nuxt.ts

@@ -1,252 +0,0 @@
-import type { SharedSlice } from "@prismicio/types-internal/lib/customtypes";
-
-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 type { Framework } from ".";
-
-import { FrameworkAdapter } from ".";
-import { readConfig, updateConfig } from "../config";
-import { exists, writeFileRecursive } from "../lib/file";
-import { getNpmPackageVersion } from "../lib/packageJson";
-import { dedent } from "../lib/string";
-import { sliceSimulatorPageTemplate, sliceTemplate } from "./nuxt.templates";
-
-const NUXT_PRISMIC = "@nuxtjs/prismic";
-
-export class NuxtFramework extends FrameworkAdapter {
-	readonly id: Framework = "nuxt";
-
-	async getDependencies(): Promise<Record<string, string>> {
-		return {
-			"@prismicio/client": `^${await getNpmPackageVersion("@prismicio/client")}`,
-			[NUXT_PRISMIC]: `^${await getNpmPackageVersion(NUXT_PRISMIC)}`,
-		};
-	}
-
-	async initProject(): Promise<void> {
-		await super.initProject();
-
-		await this.#configureNuxtModule();
-		await this.#createSliceSimulatorPage();
-		await this.#moveOrDeleteAppVue();
-		await this.#modifySliceLibraryPath();
-	}
-
-	async createSliceComponent(
-		model: SharedSlice,
-		sliceDirectory: URL,
-	): Promise<{ componentPath: URL }> {
-		const componentPath = new URL("index.vue", sliceDirectory);
-		const contents = sliceTemplate({
-			name: model.name,
-			typescript: await this.checkIsTypeScriptProject(),
-		});
-		await writeFileRecursive(componentPath, contents);
-		return { componentPath };
-	}
-
-	getSliceImportPath(relativeDirectory: string): string {
-		return `./${relativeDirectory}/index.vue`;
-	}
-
-	async getDefaultSliceLibraryPath(_projectRoot: URL): Promise<URL> {
-		const srcDir = await this.#getSrcDir();
-		return new URL("slices/", srcDir);
-	}
-
-	async getClientFilePath(): Promise<string | null> {
-		return null;
-	}
-
-	async getSlicesDirectoryPath(): Promise<string> {
-		const projectRoot = await this.getProjectRoot();
-		const appDir = new URL("app/", projectRoot);
-		if (await exists(appDir)) return "app/slices/";
-		const srcDir = new URL("src/", projectRoot);
-		if (await exists(srcDir)) return "src/slices/";
-		return "slices/";
-	}
-
-	getSliceComponentExtensions(): string[] {
-		return [".vue"];
-	}
-
-	async getRoutePath(route: string): Promise<{ path: string; extensions: string[] } | null> {
-		if (route === "/slice-simulator") {
-			return { path: "pages/slice-simulator", extensions: [".vue"] };
-		}
-		return null;
-	}
-
-	protected override async generateSliceLibraryIndexContents(
-		slices: { library: URL; directory: URL; model: SharedSlice }[],
-	): Promise<string> {
-		const componentLines = await Promise.all(
-			slices.map(async (slice) => {
-				const relativeDirectory = relative(
-					fileURLToPath(slice.library),
-					fileURLToPath(slice.directory),
-				);
-				return `${slice.model.id}: defineAsyncComponent(() => import("./${relativeDirectory}/index.vue"))`;
-			}),
-		);
-
-		return dedent`
-			// Code generated by Prismic. DO NOT EDIT.
-
-			import { defineAsyncComponent } from "vue";
-			import { defineSliceZoneComponents } from "@prismicio/vue";
-
-			export const components = defineSliceZoneComponents({
-				${componentLines.join(",\n")}
-			});
-		`;
-	}
-
-	async #getSrcDir(): Promise<URL> {
-		const projectRoot = await this.getProjectRoot();
-		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 #configureNuxtModule(): Promise<void> {
-		const projectRoot = await this.getProjectRoot();
-
-		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 #createSliceSimulatorPage(): Promise<void> {
-		const projectRoot = await this.getProjectRoot();
-		const typescript = await this.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 this.#getSrcDir());
-		}
-
-		const filePath = new URL("slice-simulator.vue", targetDir);
-
-		if (await exists(filePath)) {
-			return;
-		}
-
-		const contents = sliceSimulatorPageTemplate({ typescript });
-		await writeFileRecursive(filePath, contents);
-	}
-
-	async #moveOrDeleteAppVue(): Promise<void> {
-		const srcDir = await this.#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 #modifySliceLibraryPath(): Promise<void> {
-		const projectRoot = await this.getProjectRoot();
-		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 this.getSlices();
-		if (slices.length > 0) {
-			return;
-		}
-
-		const newLibrary = hasAppDir ? "./app/slices" : "./src/slices";
-		await updateConfig({ libraries: [newLibrary] });
-	}
-}

package/src/frameworks/sveltekit.ts

@@ -1,234 +0,0 @@
-import type { SharedSlice } from "@prismicio/types-internal/lib/customtypes";
-
-import { loadFile } from "magicast";
-import { writeFile } from "node:fs/promises";
-import { createRequire } from "node:module";
-
-import type { Framework } from ".";
-
-import { FrameworkAdapter } from ".";
-import { exists, writeFileRecursive } from "../lib/file";
-import { getNpmPackageVersion } from "../lib/packageJson";
-import { dedent } from "../lib/string";
-import {
-	previewAPIRouteTemplate,
-	prismicIOFileTemplate,
-	rootLayoutTemplate,
-	sliceSimulatorPageTemplate,
-	sliceTemplate,
-} from "./sveltekit.templates";
-
-export class SvelteKitFramework extends FrameworkAdapter {
-	readonly id: Framework = "sveltekit";
-
-	async getDependencies(): Promise<Record<string, string>> {
-		return {
-			"@prismicio/client": `^${await getNpmPackageVersion("@prismicio/client")}`,
-			"@prismicio/svelte": `^${await getNpmPackageVersion("@prismicio/svelte")}`,
-		};
-	}
-
-	async initProject(): Promise<void> {
-		await super.initProject();
-
-		await this.#createPrismicIOFile();
-		await this.#createSliceSimulatorPage();
-		await this.#createPreviewRouteMatcher();
-		await this.#createPreviewAPIRoute();
-		await this.#createPreviewRouteDirectory();
-		await this.#createRootLayoutServerFile();
-		await this.#createRootLayoutFile();
-		await this.#modifyViteConfig();
-	}
-
-	async createSliceComponent(
-		model: SharedSlice,
-		sliceDirectory: URL,
-	): Promise<{ componentPath: URL }> {
-		const componentPath = new URL("index.svelte", sliceDirectory);
-		const contents = sliceTemplate({
-			name: model.name,
-			typescript: await this.checkIsTypeScriptProject(),
-			version: await this.#getSvelteMajor(),
-		});
-		await writeFileRecursive(componentPath, contents);
-		return { componentPath };
-	}
-
-	getSliceImportPath(relativeDirectory: string): string {
-		return `./${relativeDirectory}/index.svelte`;
-	}
-
-	async getDefaultSliceLibraryPath(projectRoot: URL): Promise<URL> {
-		return new URL("src/lib/slices/", projectRoot);
-	}
-
-	async getClientFilePath(): Promise<string | null> {
-		return "src/lib/prismicio.ts";
-	}
-
-	async getSlicesDirectoryPath(): Promise<string> {
-		return "src/lib/slices/";
-	}
-
-	getSliceComponentExtensions(): string[] {
-		return [".svelte"];
-	}
-
-	async getRoutePath(route: string): Promise<{ path: string; extensions: string[] } | null> {
-		switch (route) {
-			case "/slice-simulator":
-				return { path: "src/routes/slice-simulator/+page", extensions: [".svelte"] };
-			case "/api/preview":
-				return { path: "src/routes/api/preview/+server", extensions: [".ts", ".js"] };
-			default:
-				return null;
-		}
-	}
-
-	async #createPrismicIOFile(): Promise<void> {
-		const extension = await this.getJsFileExtension();
-		const projectRoot = await this.getProjectRoot();
-		const filePath = new URL(`src/lib/prismicio.${extension}`, projectRoot);
-
-		if (await exists(filePath)) {
-			return;
-		}
-
-		const typescript = await this.checkIsTypeScriptProject();
-		const contents = prismicIOFileTemplate({ typescript });
-		await writeFileRecursive(filePath, contents);
-	}
-
-	async #createSliceSimulatorPage(): Promise<void> {
-		const projectRoot = await this.getProjectRoot();
-		const filePath = new URL("src/routes/slice-simulator/+page.svelte", projectRoot);
-
-		if (await exists(filePath)) {
-			return;
-		}
-
-		const contents = sliceSimulatorPageTemplate({
-			version: await this.#getSvelteMajor(),
-		});
-		await writeFileRecursive(filePath, contents);
-	}
-
-	async #createPreviewRouteMatcher(): Promise<void> {
-		const extension = await this.getJsFileExtension();
-		const projectRoot = await this.getProjectRoot();
-		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 #createPreviewAPIRoute(): Promise<void> {
-		const extension = await this.getJsFileExtension();
-		const projectRoot = await this.getProjectRoot();
-		const filePath = new URL(`src/routes/api/preview/+server.${extension}`, projectRoot);
-
-		if (await exists(filePath)) {
-			return;
-		}
-
-		const typescript = await this.checkIsTypeScriptProject();
-		const contents = previewAPIRouteTemplate({ typescript });
-		await writeFileRecursive(filePath, contents);
-	}
-
-	async #createPreviewRouteDirectory(): Promise<void> {
-		const projectRoot = await this.getProjectRoot();
-		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 #createRootLayoutServerFile(): Promise<void> {
-		const extension = await this.getJsFileExtension();
-		const projectRoot = await this.getProjectRoot();
-		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 #createRootLayoutFile(): Promise<void> {
-		const projectRoot = await this.getProjectRoot();
-		const filePath = new URL("src/routes/+layout.svelte", projectRoot);
-
-		if (await exists(filePath)) {
-			return;
-		}
-
-		const contents = rootLayoutTemplate({
-			version: await this.#getSvelteMajor(),
-		});
-		await writeFileRecursive(filePath, contents);
-	}
-
-	async #modifyViteConfig(): Promise<void> {
-		const projectRoot = await this.getProjectRoot();
-		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 #getSvelteMajor(): Promise<number> {
-		const projectRoot = await this.getProjectRoot();
-		const require = createRequire(new URL("package.json", projectRoot));
-		const { version } = require("svelte/package.json");
-		const major = Number.parseInt(version.split(".")[0]);
-		if (Number.isNaN(major)) return Infinity;
-		return major;
-	}
-}