@slicemachine/adapter-next 0.3.10-dev-next-release.10 → 0.3.10-dev-next-release.11

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,
+	});
 };

package/src/plugin.ts

@@ -1,30 +1,35 @@
 import { defineSliceMachinePlugin } from "@slicemachine/plugin-kit";
+import {
+	deleteCustomTypeDirectory,
+	deleteCustomTypeFile,
+	deleteSliceDirectory,
+	deleteSliceFile,
+	readCustomTypeFile,
+	readCustomTypeLibrary,
+	readCustomTypeModel,
+	readSliceFile,
+	readSliceLibrary,
+	readSliceModel,
+	renameCustomType,
+	renameSlice,
+	upsertGlobalTypeScriptTypes,
+	writeCustomTypeFile,
+	writeCustomTypeModel,
+	writeSliceFile,
+	writeSliceModel,
+} from "@slicemachine/plugin-kit/fs";
+
+import { rejectIfNecessary } from "./lib/rejectIfNecessary";
+import { upsertSliceLibraryIndexFile } from "./lib/upsertSliceLibraryIndexFile";
 
 import { name as pkgName } from "../package.json";
 import { PluginOptions } from "./types";
 
+import { documentationRead } from "./hooks/documentation-read";
 import { projectInit } from "./hooks/project-init";
-import { customTypeAssetDelete } from "./hooks/customType-asset-delete";
-import { customTypeAssetRead } from "./hooks/customType-asset-read";
-import { customTypeAssetUpdate } from "./hooks/customType-asset-update";
-import { customTypeCreate } from "./hooks/customType-create";
-import { customTypeDelete } from "./hooks/customType-delete";
-import { customTypeLibraryRead } from "./hooks/customTypeLibrary-read";
-import { customTypeRead } from "./hooks/customType-read";
-import { customTypeRename } from "./hooks/customType-rename";
-import { customTypeUpdate } from "./hooks/customType-update";
-import { sliceAssetDelete } from "./hooks/slice-asset-delete";
-import { sliceAssetRead } from "./hooks/slice-asset-read";
-import { sliceAssetUpdate } from "./hooks/slice-asset-update";
 import { sliceCreate } from "./hooks/slice-create";
-import { sliceDelete } from "./hooks/slice-delete";
-import { sliceLibraryRead } from "./hooks/sliceLibrary-read";
-import { sliceRead } from "./hooks/slice-read";
-import { sliceRename } from "./hooks/slice-rename";
-import { sliceUpdate } from "./hooks/slice-update";
-import { snippetRead } from "./hooks/snippet-read";
-import { documentationRead } from "./hooks/documentation-read";
 import { sliceSimulatorSetupRead } from "./hooks/sliceSimulator-setup-read";
+import { snippetRead } from "./hooks/snippet-read";
 
 export const plugin = defineSliceMachinePlugin<PluginOptions>({
 	meta: {
@@ -35,32 +40,235 @@ export const plugin = defineSliceMachinePlugin<PluginOptions>({
 		lazyLoadSlices: true,
 	},
 	setup({ hook }) {
+		////////////////////////////////////////////////////////////////
+		// project:*
+		////////////////////////////////////////////////////////////////
+
 		hook("project:init", projectInit);
 
+		////////////////////////////////////////////////////////////////
+		// slice:*
+		////////////////////////////////////////////////////////////////
+
 		hook("slice:create", sliceCreate);
-		hook("slice:update", sliceUpdate);
-		hook("slice:rename", sliceRename);
-		hook("slice:delete", sliceDelete);
-		hook("slice:read", sliceRead);
-		hook("slice:asset:update", sliceAssetUpdate);
-		hook("slice:asset:delete", sliceAssetDelete);
-		hook("slice:asset:read", sliceAssetRead);
-		hook("slice-library:read", sliceLibraryRead);
-
-		hook("custom-type:create", customTypeCreate);
-		hook("custom-type:update", customTypeUpdate);
-		hook("custom-type:rename", customTypeRename);
-		hook("custom-type:delete", customTypeDelete);
-		hook("custom-type:read", customTypeRead);
-		hook("custom-type:asset:update", customTypeAssetUpdate);
-		hook("custom-type:asset:delete", customTypeAssetDelete);
-		hook("custom-type:asset:read", customTypeAssetRead);
-		hook("custom-type-library:read", customTypeLibraryRead);
+		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,
+			});
+		});
+		hook("slice:asset:update", async (data, context) => {
+			await writeSliceFile({
+				libraryID: data.libraryID,
+				sliceID: data.sliceID,
+				filename: data.asset.id,
+				contents: data.asset.data,
+				...context,
+			});
+		});
+		hook("slice:asset:delete", async (data, context) => {
+			await deleteSliceFile({
+				libraryID: data.libraryID,
+				sliceID: data.sliceID,
+				filename: data.assetID,
+				...context,
+			});
+		});
+		hook("slice:asset:read", async (data, context) => {
+			const file = await readSliceFile({
+				libraryID: data.libraryID,
+				sliceID: data.sliceID,
+				filename: data.assetID,
+				...context,
+			});
+
+			return {
+				data: file,
+			};
+		});
+
+		////////////////////////////////////////////////////////////////
+		// 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,
+			});
+		});
+		hook("custom-type:asset:update", async (data, context) => {
+			await writeCustomTypeFile({
+				customTypeID: data.customTypeID,
+				filename: data.asset.id,
+				contents: data.asset.data,
+				...context,
+			});
+		});
+		hook("custom-type:asset:delete", async (data, context) => {
+			await deleteCustomTypeFile({
+				customTypeID: data.customTypeID,
+				filename: data.assetID,
+				...context,
+			});
+		});
+		hook("custom-type:asset:read", async (data, context) => {
+			const file = await readCustomTypeFile({
+				customTypeID: data.customTypeID,
+				filename: data.assetID,
+				...context,
+			});
+
+			return {
+				data: file,
+			};
+		});
+
+		////////////////////////////////////////////////////////////////
+		// custom-type-library:*
+		////////////////////////////////////////////////////////////////
+
+		hook("custom-type-library:read", async (_data, context) => {
+			return await readCustomTypeLibrary({
+				helpers: context.helpers,
+			});
+		});
+
+		////////////////////////////////////////////////////////////////
+		// snippet:*
+		////////////////////////////////////////////////////////////////
 
 		hook("snippet:read", snippetRead);
 
+		////////////////////////////////////////////////////////////////
+		// documentation:*
+		////////////////////////////////////////////////////////////////
+
 		hook("documentation:read", documentationRead);
 
+		////////////////////////////////////////////////////////////////
+		// slice-simulator:*
+		////////////////////////////////////////////////////////////////
+
 		hook("slice-simulator:setup:read", sliceSimulatorSetupRead);
 	},
 });

package/dist/hooks/customType-asset-delete.cjs

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const fs = require("node:fs/promises");
-const buildCustomTypeAssetPath = require("../lib/buildCustomTypeAssetPath.cjs");
-function _interopNamespaceDefault(e) {
-  const n = Object.create(null, { [Symbol.toStringTag]: { value: "Module" } });
-  if (e) {
-    for (const k in e) {
-      if (k !== "default") {
-        const d = Object.getOwnPropertyDescriptor(e, k);
-        Object.defineProperty(n, k, d.get ? d : {
-          enumerable: true,
-          get: () => e[k]
-        });
-      }
-    }
-  }
-  n.default = e;
-  return Object.freeze(n);
-}
-const fs__namespace = /* @__PURE__ */ _interopNamespaceDefault(fs);
-const customTypeAssetDelete = async (data, context) => {
-  const filePath = buildCustomTypeAssetPath.buildCustomTypeAssetPath({
-    customTypeID: data.customTypeID,
-    assetID: data.assetID,
-    helpers: context.helpers
-  });
-  await fs__namespace.rm(filePath);
-};
-exports.customTypeAssetDelete = customTypeAssetDelete;
-//# sourceMappingURL=customType-asset-delete.cjs.map

package/dist/hooks/customType-asset-delete.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"customType-asset-delete.cjs","sources":["../../../src/hooks/customType-asset-delete.ts"],"sourcesContent":["import type { CustomTypeAssetDeleteHook } from \"@slicemachine/plugin-kit\";\nimport * as fs from \"node:fs/promises\";\n\nimport { buildCustomTypeAssetPath } from \"../lib/buildCustomTypeAssetPath\";\n\nimport type { PluginOptions } from \"../types\";\n\nexport const customTypeAssetDelete: CustomTypeAssetDeleteHook<\n\tPluginOptions\n> = async (data, context) => {\n\tconst filePath = buildCustomTypeAssetPath({\n\t\tcustomTypeID: data.customTypeID,\n\t\tassetID: data.assetID,\n\t\thelpers: context.helpers,\n\t});\n\n\tawait fs.rm(filePath);\n};\n"],"names":["buildCustomTypeAssetPath","fs"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAOa,MAAA,wBAET,OAAO,MAAM,YAAW;AAC3B,QAAM,WAAWA,yBAAAA,yBAAyB;AAAA,IACzC,cAAc,KAAK;AAAA,IACnB,SAAS,KAAK;AAAA,IACd,SAAS,QAAQ;AAAA,EAAA,CACjB;AAEK,QAAAC,cAAG,GAAG,QAAQ;AACrB;;"}

package/dist/hooks/customType-asset-delete.d.ts

@@ -1,3 +0,0 @@
-import type { CustomTypeAssetDeleteHook } from "@slicemachine/plugin-kit";
-import type { PluginOptions } from "../types";
-export declare const customTypeAssetDelete: CustomTypeAssetDeleteHook<PluginOptions>;