@slicemachine/adapter-next 0.3.10 → 0.3.11-dev-next-release.1

package/src/hooks/project-init.ts

@@ -1,16 +1,18 @@
-import * as fs from "node:fs/promises";
 import * as path from "node:path";
 import type {
 	ProjectInitHook,
 	ProjectInitHookData,
 	SliceMachineContext,
 } from "@slicemachine/plugin-kit";
+import {
+	checkHasProjectFile,
+	writeProjectFile,
+} from "@slicemachine/plugin-kit/fs";
 import { source } from "common-tags";
 
 import { checkHasAppRouter } from "../lib/checkHasAppRouter";
 import { checkHasSrcDirectory } from "../lib/checkHasSrcDirectory";
 import { checkIsTypeScriptProject } from "../lib/checkIsTypeScriptProject";
-import { checkPathExists } from "../lib/checkPathExists";
 import { getJSFileExtension } from "../lib/getJSFileExtension";
 import { rejectIfNecessary } from "../lib/rejectIfNecessary";
 
@@ -46,12 +48,13 @@ const createPrismicIOFile = async ({
 	const hasAppRouter = await checkHasAppRouter({ helpers });
 
 	const extension = await getJSFileExtension({ helpers, options });
-	const filename = `prismicio.${extension}`;
-	const filePath = hasSrcDirectory
-		? helpers.joinPathFromRoot("src", filename)
-		: helpers.joinPathFromRoot(filename);
+	const filename = path.join(
+		...[hasSrcDirectory ? "src" : undefined, `prismicio.${extension}`].filter(
+			(segment): segment is NonNullable<typeof segment> => Boolean(segment),
+		),
+	);
 
-	if (await checkPathExists(filePath)) {
+	if (await checkHasProjectFile({ filename, helpers })) {
 		return;
 	}
 
@@ -229,11 +232,12 @@ const createPrismicIOFile = async ({
 		`;
 	}
 
-	if (options.format) {
-		contents = await helpers.format(contents, filePath);
-	}
-
-	await fs.writeFile(filePath, contents);
+	await writeProjectFile({
+		filename,
+		contents,
+		format: options.format,
+		helpers,
+	});
 };
 
 type CreateSliceSimulatorPageArgs = SliceMachineContext<PluginOptions>;
@@ -246,7 +250,7 @@ const createSliceSimulatorPage = async ({
 	const hasAppRouter = await checkHasAppRouter({ helpers });
 
 	const extension = await getJSFileExtension({ helpers, options, jsx: true });
-	const filePath = helpers.joinPathFromRoot(
+	const filename = path.join(
 		...[
 			hasSrcDirectory ? "src" : undefined,
 			hasAppRouter
@@ -257,13 +261,11 @@ const createSliceSimulatorPage = async ({
 		),
 	);
 
-	if (await checkPathExists(filePath)) {
+	if (await checkHasProjectFile({ filename, helpers })) {
 		return;
 	}
 
-	await fs.mkdir(path.dirname(filePath), { recursive: true });
-
-	let contents = source`
+	const contents = source`
 		"use client"
 
 		import { SliceSimulator } from "@slicemachine/adapter-next/simulator";
@@ -280,11 +282,12 @@ const createSliceSimulatorPage = async ({
 		}
 	`;
 
-	if (options.format) {
-		contents = await helpers.format(contents, filePath);
-	}
-
-	await fs.writeFile(filePath, contents);
+	await writeProjectFile({
+		filename,
+		contents,
+		format: options.format,
+		helpers,
+	});
 };
 
 const createPreviewRoute = async ({
@@ -299,7 +302,7 @@ const createPreviewRoute = async ({
 	});
 
 	const extension = await getJSFileExtension({ helpers, options });
-	const filePath = helpers.joinPathFromRoot(
+	const filename = path.join(
 		...[
 			hasSrcDirectory ? "src" : undefined,
 			hasAppRouter
@@ -310,7 +313,7 @@ const createPreviewRoute = async ({
 		),
 	);
 
-	if (await checkPathExists(filePath)) {
+	if (await checkHasProjectFile({ filename, helpers })) {
 		return;
 	}
 
@@ -320,7 +323,6 @@ const createPreviewRoute = async ({
 		if (isTypeScriptProject) {
 			contents = source`
 				import { NextRequest } from "next/server";
-				import { draftMode } from "next/headers";
 				import { redirectToPreviewURL } from "@prismicio/next";
 
 				import { createClient } from "../../../prismicio";
@@ -328,14 +330,11 @@ const createPreviewRoute = async ({
 				export async function GET(request: NextRequest) {
 					const client = createClient();
 
-					draftMode().enable();
-
 					await redirectToPreviewURL({ client, request });
 				}
 			`;
 		} else {
 			contents = source`
-				import { draftMode } from "next/headers";
 				import { redirectToPreviewURL } from "@prismicio/next";
 
 				import { createClient } from "../../../prismicio";
@@ -343,8 +342,6 @@ const createPreviewRoute = async ({
 				export async function GET(request) {
 					const client = createClient();
 
-					draftMode().enable();
-
 					await redirectToPreviewURL({ client, request });
 				}
 			`;
@@ -382,12 +379,12 @@ const createPreviewRoute = async ({
 		}
 	}
 
-	if (options.format) {
-		contents = await helpers.format(contents, filePath);
-	}
-
-	await fs.mkdir(path.dirname(filePath), { recursive: true });
-	await fs.writeFile(filePath, contents);
+	await writeProjectFile({
+		filename,
+		contents,
+		format: options.format,
+		helpers,
+	});
 };
 
 const createExitPreviewRoute = async ({
@@ -402,7 +399,7 @@ const createExitPreviewRoute = async ({
 	});
 
 	const extension = await getJSFileExtension({ helpers, options });
-	const filePath = helpers.joinPathFromRoot(
+	const filename = path.join(
 		...[
 			hasSrcDirectory ? "src" : undefined,
 			hasAppRouter
@@ -413,14 +410,14 @@ const createExitPreviewRoute = async ({
 		),
 	);
 
-	if (await checkPathExists(filePath)) {
+	if (await checkHasProjectFile({ filename, helpers })) {
 		return;
 	}
 
 	let contents: string;
 
 	if (hasAppRouter) {
-		contents = `
+		contents = source`
 			import { exitPreview } from "@prismicio/next";
 
 			export async function GET() {
@@ -448,17 +445,18 @@ const createExitPreviewRoute = async ({
 		}
 	}
 
-	if (options.format) {
-		contents = await helpers.format(contents, filePath);
-	}
-
-	await fs.mkdir(path.dirname(filePath), { recursive: true });
-	await fs.writeFile(filePath, contents);
+	await writeProjectFile({
+		filename,
+		contents,
+		format: options.format,
+		helpers,
+	});
 };
 
 const modifySliceMachineConfig = async ({
 	helpers,
 	options,
+	actions,
 }: SliceMachineContext<PluginOptions>) => {
 	const hasSrcDirectory = await checkHasSrcDirectory({ helpers });
 	const project = await helpers.getProject();
@@ -471,24 +469,15 @@ const modifySliceMachineConfig = async ({
 	// is empty.
 	if (
 		hasSrcDirectory &&
+		project.config.libraries &&
 		JSON.stringify(project.config.libraries) === JSON.stringify(["./slices"])
 	) {
-		try {
-			const entries = await fs.readdir(helpers.joinPathFromRoot("slices"));
+		const sliceLibrary = await actions.readSliceLibrary({
+			libraryID: project.config.libraries[0],
+		});
 
-			if (!entries.map((entry) => path.parse(entry).name).includes("index")) {
-				project.config.libraries = ["./src/slices"];
-			}
-		} catch (error) {
-			if (
-				error instanceof Error &&
-				"code" in error &&
-				error.code === "ENOENT"
-			) {
-				// The directory does not exist, which means we
-				// can safely nest the library.
-				project.config.libraries = ["./src/slices"];
-			}
+		if (sliceLibrary.sliceIDs.length < 1) {
+			project.config.libraries = ["./src/slices"];
 		}
 	}
 
@@ -510,7 +499,7 @@ const createRevalidateRoute = async ({
 	const hasSrcDirectory = await checkHasSrcDirectory({ helpers });
 
 	const extension = await getJSFileExtension({ helpers, options });
-	const filePath = helpers.joinPathFromRoot(
+	const filename = path.join(
 		...[
 			hasSrcDirectory ? "src" : undefined,
 			`app/api/revalidate/route.${extension}`,
@@ -519,11 +508,11 @@ const createRevalidateRoute = async ({
 		),
 	);
 
-	if (await checkPathExists(filePath)) {
+	if (await checkHasProjectFile({ filename, helpers })) {
 		return;
 	}
 
-	let contents = source`
+	const contents = source`
 		import { NextResponse } from "next/server";
 		import { revalidateTag } from "next/cache";
 
@@ -534,12 +523,12 @@ const createRevalidateRoute = async ({
 		}
 	`;
 
-	if (options.format) {
-		contents = await helpers.format(contents, filePath);
-	}
-
-	await fs.mkdir(path.dirname(filePath), { recursive: true });
-	await fs.writeFile(filePath, contents);
+	await writeProjectFile({
+		filename,
+		contents,
+		format: options.format,
+		helpers,
+	});
 };
 
 export const projectInit: ProjectInitHook<PluginOptions> = async (

package/src/hooks/slice-create.ts

@@ -3,31 +3,34 @@ import type {
 	SliceCreateHookData,
 	SliceMachineContext,
 } from "@slicemachine/plugin-kit";
+import {
+	upsertGlobalTypeScriptTypes,
+	writeSliceFile,
+	writeSliceModel,
+} from "@slicemachine/plugin-kit/fs";
 import { stripIndent } from "common-tags";
-import * as fs from "node:fs/promises";
-import * as path from "node:path";
 
-import { buildSliceDirectoryPath } from "../lib/buildSliceDirectoryPath";
 import { checkIsTypeScriptProject } from "../lib/checkIsTypeScriptProject";
 import { getJSFileExtension } from "../lib/getJSFileExtension";
 import { pascalCase } from "../lib/pascalCase";
 import { rejectIfNecessary } from "../lib/rejectIfNecessary";
-import { updateSliceModelFile } from "../lib/updateSliceModelFile";
-import { upsertGlobalContentTypes } from "../lib/upsertGlobalContentTypes";
 import { upsertSliceLibraryIndexFile } from "../lib/upsertSliceLibraryIndexFile";
 
 import type { PluginOptions } from "../types";
 
 type Args = {
-	dir: string;
 	data: SliceCreateHookData;
 } & SliceMachineContext<PluginOptions>;
 
-const createComponentFile = async ({ dir, data, helpers, options }: Args) => {
+const createComponentFile = async ({
+	data,
+	helpers,
+	actions,
+	options,
+}: Args) => {
 	const extension = await getJSFileExtension({ helpers, options, jsx: true });
-	const filePath = path.join(dir, `index.${extension}`);
-	const model = data.model;
-	const pascalName = pascalCase(model.name);
+	const filename = `index.${extension}`;
+	const pascalName = pascalCase(data.model.name);
 
 	let contents: string;
 
@@ -47,7 +50,7 @@ const createComponentFile = async ({ dir, data, helpers, options }: Args) => {
 			export type ${pascalName}Props = SliceComponentProps<Content.${pascalName}Slice>;
 
 			/**
-			 * Component for "${model.name}" Slices.
+			 * Component for "${data.model.name}" Slices.
 			 */
 			const ${pascalName} = ({ slice }: ${pascalName}Props): JSX.Element => {
 				return (
@@ -55,7 +58,7 @@ const createComponentFile = async ({ dir, data, helpers, options }: Args) => {
 						data-slice-type={slice.slice_type}
 						data-slice-variation={slice.variation}
 					>
-						Placeholder component for ${model.id} (variation: {slice.variation}) Slices
+						Placeholder component for ${data.model.id} (variation: {slice.variation}) Slices
 					</section>
 				);
 			};
@@ -75,7 +78,7 @@ const createComponentFile = async ({ dir, data, helpers, options }: Args) => {
 						data-slice-type={slice.slice_type}
 						data-slice-variation={slice.variation}
 					>
-						Placeholder component for ${model.id} (variation: {slice.variation}) Slices
+						Placeholder component for ${data.model.id} (variation: {slice.variation}) Slices
 					</section>
 				);
 			};
@@ -84,40 +87,45 @@ const createComponentFile = async ({ dir, data, helpers, options }: Args) => {
 		`;
 	}
 
-	if (options.format) {
-		contents = await helpers.format(contents, filePath);
-	}
-
-	await fs.writeFile(filePath, contents);
+	await writeSliceFile({
+		libraryID: data.libraryID,
+		model: data.model,
+		filename,
+		contents,
+		format: options.format,
+		actions,
+		helpers,
+	});
 };
 
 export const sliceCreate: SliceCreateHook<PluginOptions> = async (
 	data,
 	context,
 ) => {
-	const dir = buildSliceDirectoryPath({
-		libraryID: data.libraryID,
-		model: data.model,
-		helpers: context.helpers,
-	});
-
-	await fs.mkdir(dir, { recursive: true });
-
 	rejectIfNecessary(
 		await Promise.allSettled([
-			updateSliceModelFile({
+			writeSliceModel({
 				libraryID: data.libraryID,
 				model: data.model,
-				...context,
+				format: context.options.format,
+				helpers: context.helpers,
 			}),
-			createComponentFile({ dir, data, ...context }),
+			createComponentFile({ data, ...context }),
 		]),
 	);
 
 	rejectIfNecessary(
 		await Promise.allSettled([
-			upsertGlobalContentTypes(context),
-			upsertSliceLibraryIndexFile({ libraryID: data.libraryID, ...context }),
+			upsertSliceLibraryIndexFile({
+				libraryID: data.libraryID,
+				...context,
+			}),
+			upsertGlobalTypeScriptTypes({
+				filename: context.options.generatedTypesFilePath,
+				format: context.options.format,
+				helpers: context.helpers,
+				actions: context.actions,
+			}),
 		]),
 	);
 };

package/src/lib/checkHasAppRouter.ts

@@ -1,8 +1,9 @@
 import { SliceMachineContext } from "@slicemachine/plugin-kit";
+import { checkHasProjectFile } from "@slicemachine/plugin-kit/fs";
+import * as path from "node:path";
 
 import { PluginOptions } from "../types";
 import { checkHasSrcDirectory } from "./checkHasSrcDirectory";
-import { checkPathExists } from "./checkPathExists";
 
 type CheckHasAppRouterArgs = Pick<
 	SliceMachineContext<PluginOptions>,
@@ -14,9 +15,8 @@ export async function checkHasAppRouter(
 ): Promise<boolean> {
 	const hasSrcDirectory = await checkHasSrcDirectory({ helpers: args.helpers });
 
-	return await checkPathExists(
-		hasSrcDirectory
-			? args.helpers.joinPathFromRoot("src", "app")
-			: args.helpers.joinPathFromRoot("app"),
-	);
+	return await checkHasProjectFile({
+		filename: hasSrcDirectory ? path.join("src", "app") : "app",
+		helpers: args.helpers,
+	});
 }

package/src/lib/checkHasSrcDirectory.ts

@@ -1,7 +1,7 @@
 import { SliceMachineContext } from "@slicemachine/plugin-kit";
+import { checkHasProjectFile } from "@slicemachine/plugin-kit/fs";
 
 import { PluginOptions } from "../types";
-import { checkPathExists } from "./checkPathExists";
 
 type CheckHasSrcDirectoryArgs = Pick<
 	SliceMachineContext<PluginOptions>,
@@ -11,5 +11,8 @@ type CheckHasSrcDirectoryArgs = Pick<
 export async function checkHasSrcDirectory(
 	args: CheckHasSrcDirectoryArgs,
 ): Promise<boolean> {
-	return await checkPathExists(args.helpers.joinPathFromRoot("src"));
+	return await checkHasProjectFile({
+		filename: "src",
+		helpers: args.helpers,
+	});
 }

package/src/lib/checkIsTypeScriptProject.ts

@@ -1,7 +1,7 @@
 import { SliceMachineContext } from "@slicemachine/plugin-kit";
+import { checkIsTypeScriptProject as baseCheckIsTypeScriptProject } from "@slicemachine/plugin-kit/fs";
 
 import { PluginOptions } from "../types";
-import { checkPathExists } from "./checkPathExists";
 
 type CheckIsTypeScriptProjectArgs = {
 	helpers: SliceMachineContext<PluginOptions>["helpers"];
@@ -11,7 +11,8 @@ type CheckIsTypeScriptProjectArgs = {
 export const checkIsTypeScriptProject = async (
 	args: CheckIsTypeScriptProjectArgs,
 ): Promise<boolean> => {
-	const tsConfigPath = args.helpers.joinPathFromRoot("tsconfig.json");
-
-	return args.options.typescript ?? (await checkPathExists(tsConfigPath));
+	return (
+		args.options.typescript ??
+		baseCheckIsTypeScriptProject({ helpers: args.helpers })
+	);
 };

package/src/lib/upsertSliceLibraryIndexFile.ts

@@ -1,13 +1,16 @@
 import { SliceMachineContext } from "@slicemachine/plugin-kit";
+import {
+	buildSliceDirectoryPath,
+	buildSliceLibraryDirectoryPath,
+	writeProjectFile,
+} from "@slicemachine/plugin-kit/fs";
 import { stripIndent } from "common-tags";
-import * as fs from "node:fs/promises";
 import * as path from "node:path";
 import { NON_EDITABLE_FILE_BANNER } from "../constants";
 
 import { PluginOptions } from "../types";
 
 import { pascalCase } from "./pascalCase";
-import { buildSliceLibraryDirectoryPath } from "./buildSliceLibraryDirectoryPath";
 import { getJSFileExtension } from "./getJSFileExtension";
 
 type UpsertSliceLibraryIndexFileArgs = {
@@ -17,18 +20,6 @@ type UpsertSliceLibraryIndexFileArgs = {
 export const upsertSliceLibraryIndexFile = async (
 	args: UpsertSliceLibraryIndexFileArgs,
 ): Promise<void> => {
-	const extension = await getJSFileExtension({
-		helpers: args.helpers,
-		options: args.options,
-	});
-	const filePath = path.join(
-		buildSliceLibraryDirectoryPath({
-			libraryID: args.libraryID,
-			helpers: args.helpers,
-		}),
-		`index.${extension}`,
-	);
-
 	const slices = await args.actions.readAllSliceModelsForLibrary({
 		libraryID: args.libraryID,
 	});
@@ -42,28 +33,44 @@ export const upsertSliceLibraryIndexFile = async (
 			import dynamic from 'next/dynamic'
 
 			export const components = {
-				${slices
-					.map((slice) => {
-						const id = slice.model.id;
-						const dirName = pascalCase(slice.model.name);
-
-						return `${id}: dynamic(() => import('./${dirName}'))`;
-					})
-					.join(",\n")}
+				${(
+					await Promise.all(
+						slices.map(async (slice) => {
+							const id = slice.model.id;
+							const dirName = path.basename(
+								await buildSliceDirectoryPath({
+									model: slice.model,
+									helpers: args.helpers,
+									libraryID: args.libraryID,
+								}),
+							);
+
+							return `${id}: dynamic(() => import('./${dirName}'))`;
+						}),
+					)
+				).join(",\n")}
 			}
 		`;
 	} else {
 		contents = stripIndent`
 			${NON_EDITABLE_FILE_BANNER}
 
-			${slices
-				.map((slice) => {
-					const componentName = pascalCase(slice.model.name);
-					const dirName = pascalCase(slice.model.name);
+			${(
+				await Promise.all(
+					slices.map(async (slice) => {
+						const dirName = path.basename(
+							await buildSliceDirectoryPath({
+								model: slice.model,
+								helpers: args.helpers,
+								libraryID: args.libraryID,
+							}),
+						);
+						const componentName = pascalCase(slice.model.name);
 
-					return `import ${componentName} from "./${dirName}";`;
-				})
-				.join("\n")}
+						return `import ${componentName} from "./${dirName}";`;
+					}),
+				)
+			).join("\n")}
 
 			export const components = {
 				${slices
@@ -78,9 +85,22 @@ export const upsertSliceLibraryIndexFile = async (
 		`;
 	}
 
-	if (args.options.format) {
-		contents = await args.helpers.format(contents, filePath);
-	}
+	const extension = await getJSFileExtension({
+		helpers: args.helpers,
+		options: args.options,
+	});
+	const filePath = path.join(
+		buildSliceLibraryDirectoryPath({
+			libraryID: args.libraryID,
+			helpers: args.helpers,
+		}),
+		`index.${extension}`,
+	);
 
-	await fs.writeFile(filePath, contents);
+	await writeProjectFile({
+		filename: filePath,
+		contents,
+		format: args.options.format,
+		helpers: args.helpers,
+	});
 };