feat: support groups in slices (#19)

* feat: support groups in slices * test: verify groups are supported in slices
prismicio · Apr 18, 2024 · 56e7670 · 56e7670
1 parent 63d1e17
commit 56e7670
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 5 deletions.
diff --git a/src/model/createModelMockFactory.ts b/src/model/createModelMockFactory.ts
@@ -2,7 +2,12 @@ import * as prismic from "@prismicio/client";
 
 import { createFaker, Faker } from "../lib/createFaker";
 
-import { GroupFieldModelMap, Seed, WithoutFakerConfig } from "../types";
+import {
+	GroupFieldModelMap,
+	Seed,
+	SlicePrimaryFieldModelMap,
+	WithoutFakerConfig,
+} from "../types";
 
 import { boolean, MockBooleanModelConfig } from "./boolean";
 import {
@@ -164,7 +169,7 @@ export class ModelMockFactory {
 
 	sharedSliceVariation<
 		ID extends string,
-		PrimaryFields extends GroupFieldModelMap,
+		PrimaryFields extends SlicePrimaryFieldModelMap,
 		ItemsFields extends GroupFieldModelMap,
 	>(
 		config?: WithoutFakerConfig<

diff --git a/src/model/sharedSliceVariation.ts b/src/model/sharedSliceVariation.ts
@@ -4,11 +4,15 @@ import * as changeCase from "change-case";
 import { createFaker } from "../lib/createFaker";
 import { getMockImageData } from "../lib/getMockImageData";
 
-import { GroupFieldModelMap, MockModelConfig } from "../types";
+import {
+	GroupFieldModelMap,
+	MockModelConfig,
+	SlicePrimaryFieldModelMap,
+} from "../types";
 
 export type MockSharedSliceVariationModelConfig<
 	ID extends string = string,
-	PrimaryFields extends GroupFieldModelMap = GroupFieldModelMap,
+	PrimaryFields extends SlicePrimaryFieldModelMap = SlicePrimaryFieldModelMap,
 	ItemsFields extends GroupFieldModelMap = GroupFieldModelMap,
 > = {
 	id?: ID;
@@ -19,7 +23,7 @@ export type MockSharedSliceVariationModelConfig<
 
 export const sharedSliceVariation = <
 	ID extends string,
-	PrimaryFields extends GroupFieldModelMap,
+	PrimaryFields extends SlicePrimaryFieldModelMap,
 	ItemsFields extends GroupFieldModelMap,
 >(
 	config: MockSharedSliceVariationModelConfig<ID, PrimaryFields, ItemsFields>,

diff --git a/src/types.ts b/src/types.ts
@@ -78,6 +78,11 @@ export type GroupFieldModelMap = Record<
 	prismic.CustomTypeModelFieldForGroup
 >;
 
+export type SlicePrimaryFieldModelMap = Record<
+	string,
+	prismic.CustomTypeModelFieldForSlicePrimary
+>;
+
 export type MockValueConfig<Model extends PrismicModel = PrismicModel> = {
 	model?: Model;
 } & (

diff --git a/test/model-sharedSliceVariation.test.ts b/test/model-sharedSliceVariation.test.ts
@@ -51,12 +51,23 @@ test("can be configured for specific primary and items fields", (t) => {
 		seed: t.title,
 		primaryFields: {
 			boolean: prismicM.model.boolean({ seed: t.title }),
+			group: prismicM.model.group({
+				seed: t.title,
+				fields: {
+					boolean: prismicM.model.boolean({ seed: t.title }),
+				},
+			}),
 		},
 		itemsFields: {
 			keyText: prismicM.model.keyText({ seed: t.title }),
 		},
 	});
 
 	t.is(actual.primary?.boolean.type, prismic.CustomTypeModelFieldType.Boolean);
+	t.is(actual.primary?.group.type, prismic.CustomTypeModelFieldType.Group);
+	t.is(
+		actual.primary?.group.config?.fields?.boolean.type,
+		prismic.CustomTypeModelFieldType.Boolean,
+	);
 	t.is(actual.items?.keyText.type, prismic.CustomTypeModelFieldType.Text);
 });
diff --git a/test/value-sharedSliceVariation.test.ts b/test/value-sharedSliceVariation.test.ts
@@ -20,6 +20,12 @@ test("supports custom model", (t) => {
 		seed: t.title,
 		primaryFields: {
 			boolean: model.boolean({ seed: t.title }),
+			group: model.group({
+				seed: t.title,
+				fields: {
+					boolean: model.boolean({ seed: t.title }),
+				},
+			}),
 		},
 		itemsFields: {
 			keyText: model.keyText({ seed: t.title }),
@@ -32,6 +38,10 @@ test("supports custom model", (t) => {
 	});
 
 	t.is(typeof actual.primary.boolean, "boolean");
+	t.is(Array.isArray(actual.primary.group), true);
+	for (const item of actual.primary.group) {
+		t.is(typeof item.boolean, "boolean");
+	}
 
 	for (const item of actual.items) {
 		t.is(typeof item.keyText, "string");