@slicemachine/manager 0.1.1-dev-plugins-m2.1 → 0.1.1-dev-plugins-m3.0

package/package.json

@@ -1,10 +1,11 @@
 {
 	"name": "@slicemachine/manager",
-	"version": "0.1.1-dev-plugins-m2.1",
+	"version": "0.1.1-dev-plugins-m3.0",
 	"description": "Manage all aspects of a Slice Machine project.",
 	"repository": {
 		"type": "git",
-		"url": "ssh://git@github.com/prismicio/slice-machine.git"
+		"url": "ssh://git@github.com/prismicio/slice-machine.git",
+		"directory": "packages/manager"
 	},
 	"license": "Apache-2.0",
 	"author": "Prismic <contact@prismic.io> (https://prismic.io)",
@@ -62,8 +63,9 @@
 	"dependencies": {
 		"@antfu/ni": "^0.20.0",
 		"@prismicio/custom-types-client": "^1.1.0",
-		"@prismicio/types-internal": "^1.5.3",
-		"@slicemachine/plugin-kit": "0.1.8-dev-plugins-m2.1",
+		"@prismicio/mocks": "2.0.0-alpha.2",
+		"@prismicio/types-internal": "2.0.0-alpha.9",
+		"@slicemachine/plugin-kit": "0.1.8-dev-plugins-m3.0",
 		"@wooorm/starry-night": "^1.6.0",
 		"analytics-node": "^6.2.0",
 		"cookie": "^0.5.0",
@@ -101,7 +103,7 @@
 		"@vitest/coverage-c8": "^0.27.3",
 		"better-npm-audit": "^3.7.3",
 		"depcheck": "^1.4.3",
-		"eslint": "^8.36.0",
+		"eslint": "^8.37.0",
 		"eslint-config-prettier": "^8.7.0",
 		"eslint-plugin-prettier": "^4.2.1",
 		"eslint-plugin-tsdoc": "^0.2.17",
@@ -136,5 +138,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "2c46488040b38e6324ac2dc926b84d95f00e8ddd"
+	"gitHead": "9223acb43eebf3f0e1731090b48c44ebd96f4aae"
 }

package/src/client/index.ts

@@ -1,10 +1,10 @@
 // This file defines the `@slicemachine/manager/client` export.
 // All exports must be designed for non-Node.js usage.
 
-export {
+export { createSliceMachineManagerClient } from "../managers/createSliceMachineManagerClient";
+export type {
 	CreateSliceMachineManagerClientArgs,
 	SliceMachineManagerClient,
-	createSliceMachineManagerClient,
 } from "../managers/createSliceMachineManagerClient";
 
 export type {

package/src/index.ts

@@ -3,23 +3,21 @@
 
 export type { PrismicRepository } from "./managers/prismicRepository/types";
 
-export { SliceMachineManager } from "./managers/SliceMachineManager";
+export type { SliceMachineManager } from "./managers/SliceMachineManager";
 export { createSliceMachineManager } from "./managers/createSliceMachineManager";
-export {
-	CreateSliceMachineManagerMiddlewareArgs,
-	createSliceMachineManagerMiddleware,
-} from "./managers/createSliceMachineManagerMiddleware";
+export { createSliceMachineManagerMiddleware } from "./managers/createSliceMachineManagerMiddleware";
+export type { CreateSliceMachineManagerMiddlewareArgs } from "./managers/createSliceMachineManagerMiddleware";
 
-export {
+export type {
 	PrismicAuthManager,
 	PrismicUserProfile,
 	PrismicAuthState,
 } from "./auth/PrismicAuthManager";
 export { createPrismicAuthManager } from "./auth/createPrismicAuthManager";
-export {
+export { createPrismicAuthManagerMiddleware } from "./auth/createPrismicAuthManagerMiddleware";
+export type {
 	CreatePrismicAuthManagerMiddlewareArgs,
 	PrismicAuthCheckStatusResponse,
-	createPrismicAuthManagerMiddleware,
 } from "./auth/createPrismicAuthManagerMiddleware";
 
 export { DecodeError } from "./lib/DecodeError";

package/src/lib/buildPrismicRepositoryAPIEndpoint.ts

@@ -10,7 +10,7 @@ export const buildPrismicRepositoryAPIEndpoint = (
 ): string => {
 	const baseEndpoint = new URL(API_ENDPOINTS.PrismicWroom);
 
-	return `${baseEndpoint.protocol}://${repositoryName}${
-		withCDN ? ".cdn" : ""
-	}.${baseEndpoint.host}/api/v2`;
+	return `${baseEndpoint.protocol}//${repositoryName}${withCDN ? ".cdn" : ""}.${
+		baseEndpoint.host
+	}/api/v2`;
 };

package/src/lib/mockSlice.ts

@@ -0,0 +1,44 @@
+import { SharedSliceMock } from "@prismicio/mocks";
+
+import { SharedSliceContent } from "@prismicio/types-internal/lib/content";
+import {
+	SharedSlice,
+	SliceDiff,
+} from "@prismicio/types-internal/lib/customtypes";
+
+type mockSliceArgs = {
+	model: SharedSlice;
+	mocks?: SharedSliceContent[];
+	diff?: SliceDiff;
+};
+
+export const mockSlice = (args: mockSliceArgs): SharedSliceContent[] => {
+	const { model, mocks, diff } = args;
+
+	return model.variations.map((variation) => {
+		const variationMock = mocks?.find((m) => m.variation === variation.id);
+
+		if (!variationMock) {
+			return SharedSliceMock.generate(model, {
+				type: "SharedSlice",
+				variation: variation.id,
+			});
+		}
+		if (!diff) {
+			return variationMock;
+		}
+
+		const patched = SharedSliceMock.patch(diff, variationMock);
+		if (!patched.ok) {
+			return variationMock;
+		}
+		if (!patched.result) {
+			return SharedSliceMock.generate(model, {
+				type: "SharedSlice",
+				variation: variation.id,
+			});
+		}
+
+		return patched.result;
+	});
+};

package/src/managers/SliceMachineManager.ts

@@ -1,4 +1,7 @@
-import { CustomTypes } from "@prismicio/types-internal";
+import {
+	SharedSlice,
+	CustomType,
+} from "@prismicio/types-internal/lib/customtypes";
 import { SharedSliceContent } from "@prismicio/types-internal/lib/content";
 import {
 	ForbiddenError,
@@ -60,7 +63,7 @@ type SliceMachineManagerGetStateReturnType = {
 			pathToSlice: string;
 			fileName: string | null;
 			extension: string | null;
-			model: CustomTypes.Widgets.Slices.SharedSlice;
+			model: SharedSlice;
 			screenshots: Record<
 				string,
 				{
@@ -68,7 +71,7 @@ type SliceMachineManagerGetStateReturnType = {
 					data: Buffer;
 				}
 			>;
-			mock?: SharedSliceContent[];
+			mocks?: SharedSliceContent[];
 		}[];
 		meta: {
 			name?: string;
@@ -78,9 +81,9 @@ type SliceMachineManagerGetStateReturnType = {
 			isManual: boolean;
 		};
 	}[];
-	customTypes: CustomTypes.CustomType[];
-	remoteCustomTypes: CustomTypes.CustomType[];
-	remoteSlices: CustomTypes.Widgets.Slices.SharedSlice[];
+	customTypes: CustomType[];
+	remoteCustomTypes: CustomType[];
+	remoteSlices: SharedSlice[];
 	clientError?: {
 		name: string;
 		message: string;
@@ -324,7 +327,7 @@ export class SliceMachineManager {
 										extension: "extension",
 										model,
 										screenshots,
-										mock: mocks,
+										mocks,
 									});
 								}
 							}),

package/src/managers/customTypes/CustomTypesManager.ts

@@ -1,7 +1,7 @@
 import * as t from "io-ts";
 import fetch from "node-fetch";
 import * as prismicCustomTypesClient from "@prismicio/custom-types-client";
-import { CustomTypes } from "@prismicio/types-internal";
+import { CustomType } from "@prismicio/types-internal/lib/customtypes";
 import {
 	CallHookReturnType,
 	CustomTypeCreateHook,
@@ -30,12 +30,12 @@ type SliceMachineManagerReadCustomTypeLibraryReturnType = {
 };
 
 type SliceMachineManagerReadAllCustomTypeReturnType = {
-	models: { model: CustomTypes.CustomType }[];
+	models: { model: CustomType }[];
 	errors: (DecodeError | HookError)[];
 };
 
 type SliceMachineManagerReadCustomTypeReturnType = {
-	model: CustomTypes.CustomType | undefined;
+	model: CustomType | undefined;
 	errors: (DecodeError | HookError)[];
 };
 
@@ -143,7 +143,7 @@ export class CustomTypesManager extends BaseManager {
 		);
 		const { data, errors } = decodeHookResult(
 			t.type({
-				model: CustomTypes.CustomType,
+				model: CustomType,
 			}),
 			hookResult,
 		);
@@ -302,7 +302,7 @@ export class CustomTypesManager extends BaseManager {
 		};
 	}
 
-	async fetchRemoteCustomTypes(): Promise<CustomTypes.CustomType[]> {
+	async fetchRemoteCustomTypes(): Promise<CustomType[]> {
 		const authenticationToken = await this.user.getAuthenticationToken();
 		const sliceMachineConfig = await this.project.getSliceMachineConfig();
 

package/src/managers/prismicRepository/types.ts

@@ -1,4 +1,7 @@
-import { CustomTypes } from "@prismicio/types-internal";
+import {
+	CustomType,
+	SharedSlice,
+} from "@prismicio/types-internal/lib/customtypes";
 import * as t from "io-ts";
 
 export const PrismicRepositoryUserAgent = {
@@ -50,22 +53,22 @@ interface DeleteChange extends Change {
 }
 export interface SliceInsertChange extends Change {
 	type: ChangeTypes.SLICE_INSERT;
-	payload: CustomTypes.Widgets.Slices.SharedSlice;
+	payload: SharedSlice;
 }
 export interface SliceUpdateChange extends Change {
 	type: ChangeTypes.SLICE_UPDATE;
-	payload: CustomTypes.Widgets.Slices.SharedSlice;
+	payload: SharedSlice;
 }
 export interface SliceDeleteChange extends DeleteChange {
 	type: ChangeTypes.SLICE_DELETE;
 }
 export interface CustomTypeInsertChange extends Change {
 	type: ChangeTypes.CUSTOM_TYPE_INSERT;
-	payload: CustomTypes.CustomType;
+	payload: CustomType;
 }
 export interface CustomTypeUpdateChange extends Change {
 	type: ChangeTypes.CUSTOM_TYPE_UPDATE;
-	payload: CustomTypes.CustomType;
+	payload: CustomType;
 }
 export interface CustomTypeDeleteChange extends DeleteChange {
 	type: ChangeTypes.CUSTOM_TYPE_DELETE;

package/src/managers/project/ProjectManager.ts

@@ -153,8 +153,14 @@ export class ProjectManager extends BaseManager {
 		try {
 			const contents = await fs.readFile(configFilePath, "utf8");
 			rawConfig = JSON.parse(contents);
-		} catch {
-			// noop
+		} catch (error) {
+			if (error instanceof SyntaxError) {
+				throw new SliceMachineError(
+					`Could not parse config file at ${configFilePath}.\n\nError Message: ${error.message}`,
+				);
+			}
+
+			// Noop, more specific error is thrown after
 		}
 
 		if (!rawConfig) {

package/src/managers/slices/SlicesManager.ts

@@ -1,7 +1,6 @@
 import * as t from "io-ts";
 import fetch from "node-fetch";
 import * as prismicCustomTypesClient from "@prismicio/custom-types-client";
-import { CustomTypes } from "@prismicio/types-internal";
 import { SharedSliceContent } from "@prismicio/types-internal/lib/content";
 import {
 	CallHookReturnType,
@@ -14,7 +13,6 @@ import {
 	SliceRenameHook,
 	SliceRenameHookData,
 	SliceUpdateHook,
-	SliceUpdateHookData,
 } from "@slicemachine/plugin-kit";
 
 import { DecodeError } from "../../lib/DecodeError";
@@ -29,6 +27,9 @@ import { UnauthenticatedError, UnauthorizedError } from "../../errors";
 
 import { BaseManager } from "../BaseManager";
 import { createContentDigest } from "../../lib/createContentDigest";
+import { mockSlice } from "../../lib/mockSlice";
+import { SliceComparator } from "@prismicio/types-internal/lib/customtypes/diff";
+import { SharedSlice } from "@prismicio/types-internal/lib/customtypes";
 
 type SlicesManagerReadSliceLibraryReturnType = {
 	sliceIDs: string[];
@@ -47,21 +48,27 @@ type SliceMachineManagerReadAllSlicesForLibraryArgs = {
 	libraryID: string;
 };
 
+type SliceMachineManagerUpdateSliceArgs = {
+	libraryID: string;
+	model: SharedSlice;
+	mocks?: SharedSliceContent[];
+};
+
 type SliceMachineManagerReadAllSlicesForLibraryReturnType = {
-	models: { model: CustomTypes.Widgets.Slices.SharedSlice }[];
+	models: { model: SharedSlice }[];
 	errors: (DecodeError | HookError)[];
 };
 
 type SliceMachineManagerReadAllSlicesReturnType = {
 	models: {
 		libraryID: string;
-		model: CustomTypes.Widgets.Slices.SharedSlice;
+		model: SharedSlice;
 	}[];
 	errors: (DecodeError | HookError)[];
 };
 
 type SliceMachineManagerReadSliceReturnType = {
-	model: CustomTypes.Widgets.Slices.SharedSlice | undefined;
+	model: SharedSlice | undefined;
 	errors: (DecodeError | HookError)[];
 };
 
@@ -129,7 +136,7 @@ type SliceMachineManagerUpdateSliceMocksArgsReturnType = {
 
 type SlicesManagerUpsertHostedSliceScrenshotsArgs = {
 	libraryID: string;
-	model: CustomTypes.Widgets.Slices.SharedSlice;
+	model: SharedSlice;
 };
 
 type SliceMachineManagerDeleteSliceArgs = {
@@ -264,8 +271,18 @@ export class SlicesManager extends BaseManager {
 			args,
 		);
 
+		const updateSliceMocksArgs: SliceMachineManagerUpdateSliceMocksArgs = {
+			libraryID: args.libraryID,
+			sliceID: args.model.id,
+			mocks: mockSlice({ model: args.model }),
+		};
+
+		const { errors: updateSliceHookErrors } = await this.updateSliceMocks(
+			updateSliceMocksArgs,
+		);
+
 		return {
-			errors: hookResult.errors,
+			errors: [...hookResult.errors, ...updateSliceHookErrors],
 		};
 	}
 
@@ -280,29 +297,56 @@ export class SlicesManager extends BaseManager {
 		);
 		const { data, errors } = decodeHookResult(
 			t.type({
-				model: CustomTypes.Widgets.Slices.SharedSlice,
+				model: SharedSlice,
 			}),
 			hookResult,
 		);
 
 		return {
 			model: data[0]?.model,
-			errors,
+			errors: errors.map((error) => {
+				error.message = `Failed to decode slice model with id '${args.sliceID}': ${error.message}`;
+
+				return error;
+			}),
 		};
 	}
 
 	async updateSlice(
-		args: SliceUpdateHookData,
+		args: SliceMachineManagerUpdateSliceArgs,
 	): Promise<OnlyHookErrors<CallHookReturnType<SliceUpdateHook>>> {
 		assertPluginsInitialized(this.sliceMachinePluginRunner);
 
+		const { mocks: previousMocks } = await this.readSliceMocks({
+			libraryID: args.libraryID,
+			sliceID: args.model.id,
+		});
+		const { model: previousModel } = await this.readSlice({
+			libraryID: args.libraryID,
+			sliceID: args.model.id,
+		});
 		const hookResult = await this.sliceMachinePluginRunner.callHook(
 			"slice:update",
 			args,
 		);
 
+		const updatedMocks = mockSlice({
+			model: args.model,
+			mocks: previousMocks,
+			diff: SliceComparator.compare(previousModel, args.model),
+		});
+		const updateSliceMocksArgs: SliceMachineManagerUpdateSliceMocksArgs = {
+			libraryID: args.libraryID,
+			sliceID: args.model.id,
+			mocks: updatedMocks,
+		};
+
+		const { errors: updateSliceMocksHookResult } = await this.updateSliceMocks(
+			updateSliceMocksArgs,
+		);
+
 		return {
-			errors: hookResult.errors,
+			errors: [...hookResult.errors, ...updateSliceMocksHookResult],
 		};
 	}
 
@@ -583,7 +627,7 @@ export class SlicesManager extends BaseManager {
 		}
 	}
 
-	async fetchRemoteSlices(): Promise<CustomTypes.Widgets.Slices.SharedSlice[]> {
+	async fetchRemoteSlices(): Promise<SharedSlice[]> {
 		const authenticationToken = await this.user.getAuthenticationToken();
 		const sliceMachineConfig = await this.project.getSliceMachineConfig();
 
@@ -599,7 +643,7 @@ export class SlicesManager extends BaseManager {
 
 	async updateSliceModelScreenshotsInPlace(
 		args: SlicesManagerUpsertHostedSliceScrenshotsArgs,
-	): Promise<CustomTypes.Widgets.Slices.SharedSlice> {
+	): Promise<SharedSlice> {
 		const sliceMachineConfig = await this.project.getSliceMachineConfig();
 
 		const variations = await Promise.all(

package/src/test/index.ts

@@ -1,4 +1,2 @@
-export {
-	createSliceMachineManagerMSWHandler,
-	CreateSliceMachineManagerMSWHandlerArgs,
-} from "./createSliceMachineManagerMSWHandler";
+export { createSliceMachineManagerMSWHandler } from "./createSliceMachineManagerMSWHandler";
+export type { CreateSliceMachineManagerMSWHandlerArgs } from "./createSliceMachineManagerMSWHandler";