@prismicio/adapter-nuxt 0.0.1

package/src/lib/getJSFileExtension.ts

@@ -0,0 +1,22 @@
+import { PluginSystemContext } from "@prismicio/plugin-kit";
+
+import { PluginOptions } from "../types";
+
+import { checkIsTypeScriptProject } from "./checkIsTypeScriptProject";
+
+type GetJSFileExtensionArgs = Pick<
+	PluginSystemContext<PluginOptions>,
+	"helpers" | "options"
+>;
+
+export const getJSFileExtension = async ({
+	helpers,
+	options,
+}: GetJSFileExtensionArgs): Promise<string> => {
+	const isTypeScriptProject = await checkIsTypeScriptProject({
+		helpers,
+		options,
+	});
+
+	return isTypeScriptProject ? "ts" : "js";
+};

package/src/lib/pascalCase.ts

@@ -0,0 +1,12 @@
+import { pascalCase as basePascalCase } from "pascal-case";
+
+/**
+ * Converts a string to a Pascal cased string.
+ *
+ * @param input - String to convert into a Pascal cased string.
+ *
+ * @returns Pascal cased string version of `input`.
+ */
+export const pascalCase = (...input: (string | undefined)[]): string => {
+	return basePascalCase(input.filter(Boolean).join(" "));
+};

package/src/lib/rejectIfNecessary.ts

@@ -0,0 +1,16 @@
+export const rejectIfNecessary = <
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
+	TPromiseSettledResults extends readonly PromiseSettledResult<any>[],
+>(
+	promiseSettledResults: TPromiseSettledResults,
+): void => {
+	const rejectedReasons = promiseSettledResults
+		.filter(
+			(result): result is PromiseRejectedResult => result.status === "rejected",
+		)
+		.map((result) => result.reason);
+
+	if (rejectedReasons.length > 0) {
+		throw rejectedReasons[0];
+	}
+};

package/src/lib/upsertSliceLibraryIndexFile.ts

@@ -0,0 +1,110 @@
+import * as path from "node:path";
+
+import { PluginSystemContext } from "@prismicio/plugin-kit";
+import {
+	buildSliceDirectoryPath,
+	buildSliceLibraryDirectoryPath,
+	writeProjectFile,
+} from "@prismicio/plugin-kit/fs";
+import { stripIndent } from "common-tags";
+
+import { NON_EDITABLE_FILE_BANNER } from "../constants";
+import { PluginOptions } from "../types";
+
+import { getJSFileExtension } from "./getJSFileExtension";
+import { pascalCase } from "./pascalCase";
+
+type UpsertSliceLibraryIndexFileArgs = {
+	libraryID: string;
+} & PluginSystemContext<PluginOptions>;
+
+export const upsertSliceLibraryIndexFile = async (
+	args: UpsertSliceLibraryIndexFileArgs,
+): Promise<void> => {
+	const slices = await args.actions.readAllSliceModelsForLibrary({
+		libraryID: args.libraryID,
+	});
+
+	let contents: string;
+
+	if (args.options.lazyLoadSlices) {
+		contents = stripIndent`
+			${NON_EDITABLE_FILE_BANNER}
+
+			import { defineAsyncComponent } from "vue";
+			import { defineSliceZoneComponents } from "@prismicio/vue";
+
+			export const components = defineSliceZoneComponents({
+				${(
+					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}: defineAsyncComponent(() => import("./${dirName}/index.vue"))`;
+						}),
+					)
+				).join(",\n")}
+			});
+		`;
+	} else {
+		contents = stripIndent`
+			${NON_EDITABLE_FILE_BANNER}
+
+			import { defineSliceZoneComponents } from "@prismicio/vue";
+
+			${(
+				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}/index.vue";`;
+					}),
+				)
+			).join("\n")}
+
+			export const components = defineSliceZoneComponents({
+				${slices
+					.map((slice) => {
+						const id = slice.model.id;
+						const componentName = pascalCase(slice.model.name);
+
+						return `${id}: ${componentName}`;
+					})
+					.join(",\n")}
+			});
+		`;
+	}
+
+	const extension = await getJSFileExtension({
+		helpers: args.helpers,
+		options: args.options,
+	});
+	const filePath = path.join(
+		buildSliceLibraryDirectoryPath({
+			libraryID: args.libraryID,
+			helpers: args.helpers,
+		}),
+		`index.${extension}`,
+	);
+
+	await writeProjectFile({
+		filename: filePath,
+		contents,
+		format: args.options.format,
+		helpers: args.helpers,
+	});
+};

package/src/plugin.ts

@@ -0,0 +1,191 @@
+import { definePlugin } from "@prismicio/plugin-kit";
+import {
+	deleteCustomTypeDirectory,
+	deleteSliceDirectory,
+	readCustomTypeLibrary,
+	readCustomTypeModel,
+	readSliceLibrary,
+	readSliceModel,
+	renameCustomType,
+	renameSlice,
+	upsertGlobalTypeScriptTypes,
+	writeCustomTypeModel,
+	writeSliceModel,
+} from "@prismicio/plugin-kit/fs";
+
+import { name as pkgName } from "../package.json";
+
+import { projectInit } from "./hooks/project-init";
+import { sliceCreate } from "./hooks/slice-create";
+import { rejectIfNecessary } from "./lib/rejectIfNecessary";
+import { upsertSliceLibraryIndexFile } from "./lib/upsertSliceLibraryIndexFile";
+import { PluginOptions } from "./types";
+
+export const plugin = definePlugin<PluginOptions>({
+	meta: {
+		name: pkgName,
+	},
+	defaultOptions: {
+		format: true,
+		lazyLoadSlices: true,
+	},
+	setup({ hook }) {
+		////////////////////////////////////////////////////////////////
+		// project:*
+		////////////////////////////////////////////////////////////////
+
+		hook("project:init", projectInit);
+
+		////////////////////////////////////////////////////////////////
+		// slice:*
+		////////////////////////////////////////////////////////////////
+
+		hook("slice:create", sliceCreate);
+		hook("slice:update", async (data, context) => {
+			await writeSliceModel({
+				libraryID: data.libraryID,
+				model: data.model,
+				...context,
+			});
+
+			await upsertGlobalTypeScriptTypes({
+				filename: context.options.generatedTypesFilePath,
+				format: context.options.format,
+				...context,
+			});
+		});
+		hook("slice:rename", async (data, context) => {
+			await renameSlice({
+				libraryID: data.libraryID,
+				model: data.model,
+				format: context.options.format,
+				...context,
+			});
+
+			rejectIfNecessary(
+				await Promise.allSettled([
+					upsertSliceLibraryIndexFile({
+						libraryID: data.libraryID,
+						...context,
+					}),
+					upsertGlobalTypeScriptTypes({
+						filename: context.options.generatedTypesFilePath,
+						format: context.options.format,
+						...context,
+					}),
+				]),
+			);
+		});
+		hook("slice:delete", async (data, context) => {
+			await deleteSliceDirectory({
+				libraryID: data.libraryID,
+				model: data.model,
+				...context,
+			});
+
+			rejectIfNecessary(
+				await Promise.allSettled([
+					upsertSliceLibraryIndexFile({
+						libraryID: data.libraryID,
+						...context,
+					}),
+					upsertGlobalTypeScriptTypes({
+						filename: context.options.generatedTypesFilePath,
+						format: context.options.format,
+						...context,
+					}),
+				]),
+			);
+		});
+		hook("slice:read", async (data, context) => {
+			return await readSliceModel({
+				libraryID: data.libraryID,
+				sliceID: data.sliceID,
+				...context,
+			});
+		});
+
+		////////////////////////////////////////////////////////////////
+		// slice-library:*
+		////////////////////////////////////////////////////////////////
+
+		hook("slice-library:read", async (data, context) => {
+			return await readSliceLibrary({
+				libraryID: data.libraryID,
+				...context,
+			});
+		});
+
+		////////////////////////////////////////////////////////////////
+		// custom-type:*
+		////////////////////////////////////////////////////////////////
+
+		hook("custom-type:create", async (data, context) => {
+			await writeCustomTypeModel({
+				model: data.model,
+				format: context.options.format,
+				...context,
+			});
+
+			await upsertGlobalTypeScriptTypes({
+				filename: context.options.generatedTypesFilePath,
+				format: context.options.format,
+				...context,
+			});
+		});
+		hook("custom-type:update", async (data, context) => {
+			await writeCustomTypeModel({
+				model: data.model,
+				format: context.options.format,
+				...context,
+			});
+
+			await upsertGlobalTypeScriptTypes({
+				filename: context.options.generatedTypesFilePath,
+				format: context.options.format,
+				...context,
+			});
+		});
+		hook("custom-type:rename", async (data, context) => {
+			await renameCustomType({
+				model: data.model,
+				format: context.options.format,
+				...context,
+			});
+
+			await upsertGlobalTypeScriptTypes({
+				filename: context.options.generatedTypesFilePath,
+				format: context.options.format,
+				...context,
+			});
+		});
+		hook("custom-type:delete", async (data, context) => {
+			await deleteCustomTypeDirectory({
+				customTypeID: data.model.id,
+				...context,
+			});
+
+			await upsertGlobalTypeScriptTypes({
+				filename: context.options.generatedTypesFilePath,
+				format: context.options.format,
+				...context,
+			});
+		});
+		hook("custom-type:read", async (data, context) => {
+			return await readCustomTypeModel({
+				customTypeID: data.id,
+				...context,
+			});
+		});
+
+		////////////////////////////////////////////////////////////////
+		// custom-type-library:*
+		////////////////////////////////////////////////////////////////
+
+		hook("custom-type-library:read", async (_data, context) => {
+			return await readCustomTypeLibrary({
+				helpers: context.helpers,
+			});
+		});
+	},
+});

package/src/types.ts

@@ -0,0 +1,38 @@
+export type PluginOptions = {
+	/**
+	 * Determines if generated files should be formatted using Prettier.
+	 *
+	 * @defaultValue `true`
+	 */
+	format?: boolean;
+
+	/**
+	 * Determines if Slice components should be lazy loaded when rendered.
+	 *
+	 * @defaultValue `true`
+	 */
+	lazyLoadSlices?: boolean;
+
+	/**
+	 * Determines if generated files should be written in TypeScript or
+	 * JavaScript.
+	 *
+	 * @defaultValue `true` if the project contains a `tsconfig.json`, `false` otherwise.
+	 */
+	typescript?: boolean;
+
+	/**
+	 * The filepath at which generated TypeScript types will be saved.
+	 *
+	 * @defaultValue `prismicio-types.d.ts`
+	 */
+	generatedTypesFilePath?: string;
+
+	/**
+	 * The filepath at which the active Prismic environment is stored as an
+	 * environment variable.
+	 *
+	 * @defaultValue `.env.local`
+	 */
+	environmentVariableFilePath?: string;
+};