fix: value type

prismicio · Apr 10, 2024 · 650e0cd · 650e0cd
1 parent f65f07b
commit 650e0cd
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 16 deletions.
diff --git a/src/types/value/sharedSlice.ts b/src/types/value/sharedSlice.ts
@@ -1,4 +1,7 @@
-import type { SharedSliceVariation } from "./sharedSliceVariation";
+import type {
+	SharedSliceVariation,
+	SharedSliceVariationBase,
+} from "./sharedSliceVariation";
 
 /**
  * A shared Slice.
@@ -7,7 +10,7 @@ import type { SharedSliceVariation } from "./sharedSliceVariation";
  */
 export type SharedSlice<
 	SliceType = string,
-	Variations extends SharedSliceVariation = SharedSliceVariation,
+	Variations extends SharedSliceVariationBase = SharedSliceVariation,
 > = {
 	slice_type: SliceType;
 	slice_label: null;

diff --git a/src/types/value/sharedSliceVariation.ts b/src/types/value/sharedSliceVariation.ts
@@ -1,42 +1,51 @@
 import type { AnyRegularField, SliceField } from "./types";
 
+export type SharedSliceVariationBase<Variation extends string = string> = {
+	variation: Variation;
+	version: string;
+};
+
 /**
  * A shared Slice variation. Content is in the `primary` and `items` properties.
  */
 export type SharedSliceVariationWithPrimaryAndItems<
-	Variation = string,
-	PrimaryFields extends Record<string, AnyRegularField> = Record<
+	Variation extends string = string,
+	// SliceField is used to support a top-level SharedSliceVariation type.
+	// It must support `AnyRegularField` and `SliceField`.
+	PrimaryFields extends Record<string, SliceField> = Record<
 		string,
 		AnyRegularField
 	>,
 	ItemsFields extends Record<string, AnyRegularField> = Record<
 		string,
 		AnyRegularField
 	>,
-> = Omit<SharedSliceVariation<Variation, PrimaryFields, ItemsFields>, "data">;
+> = SharedSliceVariationBase<Variation> & {
+	primary: PrimaryFields;
+	items: ItemsFields[];
+};
 
 /**
  * A shared Slice variation. Content is in the `data` property.
  */
 export type SharedSliceVariationWithData<
-	Variation = string,
+	Variation extends string = string,
 	Fields extends Record<string, SliceField> = Record<string, SliceField>,
-> = Omit<SharedSliceVariation<Variation, Fields>, "primary" | "items">;
+> = SharedSliceVariationBase<Variation> & {
+	variation: Variation;
+	version: string;
+	data: Fields;
+};
 
 /**
  * A shared Slice variation.
  */
-export interface SharedSliceVariation<
-	Variation = string,
+export type SharedSliceVariation<
+	Variation extends string = string,
 	Fields extends Record<string, SliceField> = Record<string, SliceField>,
 	ItemsFields extends Record<string, AnyRegularField> = Record<
 		string,
 		AnyRegularField
 	>,
-> {
-	variation: Variation;
-	version: string;
-	data: Fields;
-	primary: Fields;
-	items: ItemsFields[];
-}
+> = SharedSliceVariationWithData<Variation, Fields> &
+	SharedSliceVariationWithPrimaryAndItems<Variation, Fields, ItemsFields>;
diff --git a/test/types/fields-sharedSlice.types.ts b/test/types/fields-sharedSlice.types.ts
@@ -24,6 +24,7 @@ expectType<prismic.SharedSlice>({
 	slice_label: null,
 	variation: "string",
 	version: "string",
+	data: {},
 	primary: {},
 	items: [],
 });
@@ -37,6 +38,7 @@ expectType<prismic.SharedSlice<"foo">>({
 	slice_label: null,
 	variation: "string",
 	version: "string",
+	data: {},
 	primary: {},
 	items: [],
 });
@@ -47,6 +49,7 @@ expectType<prismic.SharedSlice<"foo">>({
 	slice_label: null,
 	variation: "string",
 	version: "string",
+	data: {},
 	primary: {},
 	items: [],
 });
@@ -60,6 +63,7 @@ expectType<prismic.SharedSlice<string, prismic.SharedSliceVariation<"foo">>>({
 	slice_label: null,
 	variation: "foo",
 	version: "string",
+	data: {},
 	primary: {},
 	items: [],
 });
@@ -70,6 +74,7 @@ expectType<prismic.SharedSlice<string, prismic.SharedSliceVariation<"foo">>>({
 	// @ts-expect-error - Variation type must match the given type.
 	variation: "string",
 	version: "string",
+	data: {},
 	primary: {},
 	items: [],
 });