@prismicio/mock 0.0.4 → 0.0.8

package/src/types.ts

@@ -27,6 +27,8 @@ export type SetRequired<BaseType, Keys extends keyof BaseType> = Simplify<
 		Required<Pick<BaseType, Keys>>
 >;
 
+export type Seed = string | number | number[];
+
 export interface MockImageData {
 	url: string;
 	width: number;
@@ -43,11 +45,11 @@ export interface MockEmbedData {
 }
 
 export type MockRestApiConfig = {
-	seed?: number;
+	seed?: Seed;
 };
 
 export type MockModelConfig = {
-	seed?: number;
+	seed?: Seed;
 };
 
 // TODO: Add to @prismicio/types
@@ -58,45 +60,62 @@ export type PrismicModel =
 	| prismicT.SharedSliceModel
 	| prismicT.SharedSliceModelVariation;
 
+export type GroupFieldModelMap = Record<
+	string,
+	prismicT.CustomTypeModelFieldForGroup
+>;
+
 export type MockValueConfig<Model extends PrismicModel = PrismicModel> = {
-	seed?: number;
+	seed?: Seed;
 	model?: Model;
 };
 
-export type MockValueConfigForModel<Model extends PrismicModel> =
-	Model extends prismicT.CustomTypeModelBooleanField
-		? value.MockBooleanValueConfig
-		: Model extends prismicT.CustomTypeModelColorField
-		? value.MockColorValueConfig
-		: Model extends prismicT.CustomTypeModelContentRelationshipField
-		? value.MockContentRelationshipValueConfig
-		: Model extends prismicT.CustomTypeModelDateField
-		? value.MockDateValueConfig
-		: Model extends prismicT.CustomTypeModelEmbedField
-		? value.MockEmbedValueConfig
-		: Model extends prismicT.CustomTypeModelGeoPointField
-		? value.MockGeoPointValueConfig
-		: Model extends prismicT.CustomTypeModelImageField
-		? value.MockImageValueConfig
-		: Model extends prismicT.CustomTypeModelKeyTextField
-		? value.MockKeyTextValueConfig
-		: Model extends prismicT.CustomTypeModelLinkField
-		? value.MockLinkValueConfig
-		: Model extends prismicT.CustomTypeModelLinkToMediaField
-		? value.MockLinkToMediaValueConfig
-		: Model extends prismicT.CustomTypeModelNumberField
-		? value.MockNumberValueConfig
-		: Model extends prismicT.CustomTypeModelRichTextField
-		? value.MockRichTextValueConfig
-		: Model extends prismicT.CustomTypeModelSelectField
-		? value.MockSelectValueConfig
-		: Model extends prismicT.CustomTypeModelTimestampField
-		? value.MockTimestampValueConfig
-		: Model extends prismicT.CustomTypeModelTitleField
-		? value.MockTitleValueConfig
-		: Model extends prismicT.CustomTypeModelUIDField
-		? value.MockUIDValueConfig
-		: never;
+export type MockValueStateConfig<
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = {
+	state?: State;
+};
+
+export type MockValueConfigForModel<
+	Model extends PrismicModel,
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = Model extends prismicT.CustomTypeModelBooleanField
+	? value.MockBooleanValueConfig<Model>
+	: Model extends prismicT.CustomTypeModelColorField
+	? value.MockColorValueConfig<Model, State>
+	: Model extends prismicT.CustomTypeModelContentRelationshipField
+	? value.MockContentRelationshipValueConfig<Model, State>
+	: Model extends prismicT.CustomTypeModelDateField
+	? value.MockDateValueConfig<Model, State>
+	: Model extends prismicT.CustomTypeModelEmbedField
+	? value.MockEmbedValueConfig<Model, State>
+	: Model extends prismicT.CustomTypeModelGeoPointField
+	? value.MockGeoPointValueConfig<Model, State>
+	: Model extends prismicT.CustomTypeModelImageField
+	? value.MockImageValueConfig<Model, State>
+	: Model extends prismicT.CustomTypeModelKeyTextField
+	? value.MockKeyTextValueConfig<Model, State>
+	: Model extends prismicT.CustomTypeModelLinkField
+	? value.MockLinkValueConfig<
+			typeof prismicT.LinkType[keyof typeof prismicT.LinkType],
+			Model,
+			State
+	  >
+	: Model extends prismicT.CustomTypeModelLinkToMediaField
+	? value.MockLinkToMediaValueConfig<Model, State>
+	: Model extends prismicT.CustomTypeModelNumberField
+	? value.MockNumberValueConfig<Model, State>
+	: Model extends prismicT.CustomTypeModelRichTextField
+	? value.MockRichTextValueConfig
+	: Model extends prismicT.CustomTypeModelSelectField
+	? value.MockSelectValueConfig<Model, State>
+	: Model extends prismicT.CustomTypeModelTimestampField
+	? value.MockTimestampValueConfig<Model, State>
+	: Model extends prismicT.CustomTypeModelTitleField
+	? value.MockTitleValueConfig<Model, State>
+	: Model extends prismicT.CustomTypeModelUIDField
+	? value.MockUIDValueConfig<Model>
+	: never;
 
 type CustomTypeModelStructuredTextField =
 	| prismicT.CustomTypeModelRichTextField
@@ -105,7 +124,7 @@ type CustomTypeModelStructuredTextField =
 export type MockRichTextValueConfig<
 	Model extends CustomTypeModelStructuredTextField = CustomTypeModelStructuredTextField,
 > = {
-	seed?: number;
+	seed?: Seed;
 	model?: Model;
 };
 
@@ -115,77 +134,105 @@ export type ModelValueMap<
 	[P in keyof T]: ModelValue<T[P]>;
 };
 
-export type ModelValue<T extends PrismicModel> =
-	T extends prismicT.CustomTypeModel
-		? CustomTypeModelValue<T>
-		: T extends prismicT.CustomTypeModelUIDField
-		? prismicT.PrismicDocument["uid"]
-		: T extends prismicT.CustomTypeModelFieldForGroup
-		? CustomTypeModelFieldForGroupValue<T>
-		: T extends prismicT.CustomTypeModelGroupField
-		? CustomTypeModelGroupFieldValue<T>
-		: T extends prismicT.CustomTypeModelSliceZoneField
-		? prismicT.SliceZone
-		: T extends prismicT.CustomTypeModelSlice
-		? CustomTypeModelSliceValue<T>
-		: T extends prismicT.CustomTypeModelSharedSlice
-		? // TODO: Allow providing a union of of Shared Slices
-		  prismicT.SharedSlice
-		: T extends prismicT.SharedSliceModel
-		? SharedSliceModelValue<T>
-		: T extends prismicT.SharedSliceModelVariation
-		? SharedSliceModelVariationValue<T>
-		: never;
+export type ModelValue<
+	T extends PrismicModel,
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = T extends prismicT.CustomTypeModel
+	? CustomTypeModelValue<T>
+	: T extends prismicT.CustomTypeModelUIDField
+	? prismicT.PrismicDocument["uid"]
+	: T extends prismicT.CustomTypeModelFieldForGroup
+	? CustomTypeModelFieldForGroupValue<T, State>
+	: T extends prismicT.CustomTypeModelGroupField
+	? CustomTypeModelGroupFieldValue<T, State>
+	: T extends prismicT.CustomTypeModelSliceZoneField
+	? prismicT.SliceZone<
+			ValueOf<{
+				[P in keyof T["config"]["choices"] as P extends string
+					? P
+					: never]: T["config"]["choices"][P] extends prismicT.CustomTypeModelSlice
+					? CustomTypeModelSliceValue<
+							T["config"]["choices"][P],
+							P extends string ? P : string
+					  >
+					: T["config"]["choices"][P] extends prismicT.CustomTypeModelSharedSlice
+					? prismicT.SharedSlice<P extends string ? P : string>
+					: never;
+			}>,
+			State
+	  >
+	: T extends prismicT.CustomTypeModelSlice
+	? CustomTypeModelSliceValue<T>
+	: T extends prismicT.CustomTypeModelSharedSlice
+	? // TODO: Allow providing a union of of Shared Slices
+	  prismicT.SharedSlice
+	: T extends prismicT.SharedSliceModel
+	? SharedSliceModelValue<T>
+	: T extends prismicT.SharedSliceModelVariation
+	? SharedSliceModelVariationValue<T>
+	: never;
 
 type CustomTypeModelValue<T extends prismicT.CustomTypeModel> =
-	prismicT.PrismicDocument<ModelValueMap<ValueOf<T["json"]>>>;
+	prismicT.PrismicDocument<
+		ModelValueMap<{
+			[P in keyof ValueOf<T["json"]> as ValueOf<
+				T["json"]
+			>[P]["type"] extends typeof prismicT.CustomTypeModelFieldType.UID
+				? never
+				: P]: ValueOf<T["json"]>[P];
+		}>
+	>;
 
 type CustomTypeModelFieldForGroupValue<
 	T extends prismicT.CustomTypeModelFieldForGroup,
+	State extends prismicT.FieldState = prismicT.FieldState,
 > = T extends prismicT.CustomTypeModelBooleanField
 	? prismicT.BooleanField
 	: T extends prismicT.CustomTypeModelColorField
-	? prismicT.ColorField
+	? prismicT.ColorField<State>
 	: T extends prismicT.CustomTypeModelTitleField
-	? prismicT.TitleField
+	? prismicT.TitleField<State>
 	: T extends prismicT.CustomTypeModelRichTextField
-	? prismicT.RichTextField
+	? prismicT.RichTextField<State>
 	: T extends prismicT.CustomTypeModelImageField
-	? prismicT.ImageField
+	? prismicT.ImageField<string | null, State>
 	: T extends prismicT.CustomTypeModelLinkField
-	? prismicT.LinkField
+	? prismicT.LinkField<string, string, never, State>
 	: T extends prismicT.CustomTypeModelLinkToMediaField
-	? prismicT.LinkToMediaField
+	? prismicT.LinkToMediaField<State>
 	: T extends prismicT.CustomTypeModelContentRelationshipField
-	? prismicT.RelationField
+	? prismicT.RelationField<string, string, never, State>
 	: T extends prismicT.CustomTypeModelDateField
-	? prismicT.DateField
+	? prismicT.DateField<State>
 	: T extends prismicT.CustomTypeModelTimestampField
-	? prismicT.TimestampField
+	? prismicT.TimestampField<State>
 	: T extends prismicT.CustomTypeModelNumberField
-	? prismicT.NumberField
+	? prismicT.NumberField<State>
 	: T extends prismicT.CustomTypeModelKeyTextField
-	? prismicT.KeyTextField
+	? prismicT.KeyTextField<State>
 	: T extends prismicT.CustomTypeModelSelectField
-	? prismicT.SelectField
+	? prismicT.SelectField<string, State>
 	: T extends prismicT.CustomTypeModelEmbedField
-	? prismicT.EmbedField
+	? prismicT.EmbedField<prismicT.AnyOEmbed & prismicT.OEmbedExtra, State>
 	: T extends prismicT.CustomTypeModelGeoPointField
-	? prismicT.GeoPointField
+	? prismicT.GeoPointField<State>
 	: T extends prismicT.CustomTypeModelIntegrationFieldsField
-	? prismicT.IntegrationFields
+	? prismicT.IntegrationFields<unknown, State>
 	: never;
 
 type CustomTypeModelGroupFieldValue<
 	T extends prismicT.CustomTypeModelGroupField,
-> = prismicT.GroupField<ModelValueMap<T["config"]["fields"]>>;
-
-type CustomTypeModelSliceValue<T extends prismicT.CustomTypeModelSlice> =
-	prismicT.Slice<
-		string,
-		ModelValueMap<T["non-repeat"]>,
-		ModelValueMap<T["repeat"]>
-	>;
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = prismicT.GroupField<ModelValueMap<T["config"]["fields"]>, State>;
+
+type CustomTypeModelSliceValue<
+	T extends prismicT.CustomTypeModelSlice,
+	SliceType = string,
+> = prismicT.Slice<
+	SliceType,
+	ModelValueMap<T["non-repeat"]>,
+	ModelValueMap<T["repeat"]>
+>;
 
 type SharedSliceModelValue<T extends prismicT.SharedSliceModel> =
 	prismicT.SharedSlice<

package/src/value/color.ts

@@ -2,16 +2,26 @@ import * as prismicT from "@prismicio/types";
 
 import { createFaker } from "../lib/createFaker";
 
-import { MockValueConfig } from "../types";
+import { MockValueStateConfig, MockValueConfig } from "../types";
 
 export type MockColorValueConfig<
 	Model extends prismicT.CustomTypeModelColorField = prismicT.CustomTypeModelColorField,
-> = MockValueConfig<Model>;
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = MockValueConfig<Model> & MockValueStateConfig<State>;
 
-export const color = (
-	config: MockColorValueConfig = {},
-): prismicT.ColorField => {
+export type MockColorValue<
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = prismicT.ColorField<State>;
+
+export const color = <
+	Model extends prismicT.CustomTypeModelColorField = prismicT.CustomTypeModelColorField,
+	State extends prismicT.FieldState = "filled",
+>(
+	config: MockColorValueConfig<Model, State> = {},
+): MockColorValue<State> => {
 	const faker = createFaker(config.seed);
 
-	return faker.internet.color().toUpperCase() as prismicT.ColorField;
+	return (
+		config.state === "empty" ? null : faker.internet.color().toUpperCase()
+	) as MockColorValue<State>;
 };

package/src/value/contentRelationship.ts

@@ -1,62 +1,77 @@
 import * as prismicT from "@prismicio/types";
 
+import { buildContentRelationshipField } from "../lib/buildContentRelationshipField";
 import { createFaker } from "../lib/createFaker";
+import { generateCustomTypeId } from "../lib/generateCustomTypeId";
+import { generateTags } from "../lib/generateTags";
 
-import { MockValueConfig } from "../types";
+import { MockValueStateConfig, MockValueConfig } from "../types";
 
 import * as modelGen from "../model";
+
 import { document as documentGen } from "./document";
-import { buildContentRelationshipField } from "../lib/buildContentRelationshipField";
-import { generateCustomTypeId } from "../lib/generateCustomTypeId";
-import { generateTags } from "../lib/generateTags";
 
 export type MockContentRelationshipValueConfig<
-	IsFilled extends boolean = boolean,
 	Model extends prismicT.CustomTypeModelContentRelationshipField = prismicT.CustomTypeModelContentRelationshipField,
+	State extends prismicT.FieldState = prismicT.FieldState,
 > = {
-	isFilled?: IsFilled;
 	/**
 	 * A list of potential documents to which the field can be linked.
 	 */
 	linkableDocuments?: prismicT.PrismicDocument[];
-} & MockValueConfig<Model>;
+} & MockValueConfig<Model> &
+	MockValueStateConfig<State>;
 
-type MockContentRelationshipValue<IsFilled extends boolean = boolean> =
-	IsFilled extends true
-		? prismicT.FilledLinkToDocumentField
-		: prismicT.EmptyLinkField<prismicT.LinkType.Document>;
+type MockContentRelationshipValue<
+	Model extends prismicT.CustomTypeModelContentRelationshipField = prismicT.CustomTypeModelContentRelationshipField,
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = prismicT.RelationField<
+	Model["config"]["customtypes"],
+	string,
+	never,
+	State
+>;
 
 export const contentRelationship = <
-	IsFilled extends boolean = true,
 	Model extends prismicT.CustomTypeModelContentRelationshipField = prismicT.CustomTypeModelContentRelationshipField,
+	State extends prismicT.FieldState = "filled",
 >(
-	config: MockContentRelationshipValueConfig<IsFilled, Model> = {},
-): MockContentRelationshipValue<IsFilled> => {
+	config: MockContentRelationshipValueConfig<Model, State> = {},
+): MockContentRelationshipValue<Model, State> => {
 	const faker = createFaker(config.seed);
 
-	const isFilled = config.isFilled ?? true;
-
-	if (isFilled) {
+	if (config.state === "empty") {
+		return {
+			link_type: prismicT.LinkType.Document,
+		} as MockContentRelationshipValue<Model, State>;
+	} else {
 		const model =
 			config.model || modelGen.contentRelationship({ seed: config.seed });
 
 		const linkableDocuments = config.linkableDocuments
-			? config.linkableDocuments.filter((document) => {
-					let shouldKeep = true;
+			? config.linkableDocuments.filter(
+					(
+						document,
+					): document is prismicT.PrismicDocument<
+						never,
+						NonNullable<Model["config"]["customtypes"]>[number]
+					> => {
+						let shouldKeep = true;
 
-					if (model.config.customtypes) {
-						shouldKeep =
-							shouldKeep && model.config.customtypes.includes(document.type);
-					}
+						if (model.config.customtypes) {
+							shouldKeep =
+								shouldKeep && model.config.customtypes.includes(document.type);
+						}
 
-					if (model.config.tags) {
-						shouldKeep =
-							shouldKeep &&
-							model.config.tags.some((tag) => document.tags.includes(tag));
-					}
+						if (model.config.tags) {
+							shouldKeep =
+								shouldKeep &&
+								model.config.tags.some((tag) => document.tags.includes(tag));
+						}
 
-					return shouldKeep;
-			  })
+						return shouldKeep;
+					},
+			  )
 			: [
 					{
 						...documentGen({ seed: config.seed }),
@@ -66,7 +81,10 @@ export const contentRelationship = <
 						tags: model.config.tags
 							? faker.random.arrayElements(model.config.tags)
 							: generateTags({ seed: config.seed }),
-					},
+					} as prismicT.PrismicDocument<
+						never,
+						NonNullable<Model["config"]["customtypes"]>[number]
+					>,
 			  ];
 
 		const document = faker.random.arrayElement(linkableDocuments);
@@ -75,10 +93,8 @@ export const contentRelationship = <
 			throw new Error("A linkable document could not be found.");
 		}
 
-		return buildContentRelationshipField({ document });
-	} else {
-		return {
-			link_type: prismicT.LinkType.Document,
-		} as MockContentRelationshipValue<IsFilled>;
+		return buildContentRelationshipField({
+			document,
+		}) as unknown as MockContentRelationshipValue<Model, State>;
 	}
 };

package/src/value/customType.ts

@@ -13,12 +13,13 @@ import { MockValueConfig, ModelValue } from "../types";
 import * as modelGen from "../model";
 
 import { timestamp } from "./timestamp";
+import { buildAlternativeLanguage } from "../lib/buildAlternativeLanguage";
 
 export type MockCustomTypeValueConfig<
 	Model extends prismicT.CustomTypeModel = prismicT.CustomTypeModel,
 > = {
 	withURL?: boolean;
-	sharedSliceModels?: prismicT.SharedSliceModel[];
+	alternateLanguages?: prismicT.PrismicDocument[];
 	configs?: ValueForModelMapConfigs;
 } & MockValueConfig<Model>;
 
@@ -36,12 +37,30 @@ export const customType = <
 		...Object.values(model.json),
 	) as prismicT.CustomTypeModelTab;
 
+	const dataFieldModelsMap: prismicT.CustomTypeModelTab = {};
+	for (const key in fieldModelsMap) {
+		const fieldModel = fieldModelsMap[key];
+
+		// UID fields must be filtered out since they are not represented in
+		// the document's `data` field.
+		if (fieldModel.type !== prismicT.CustomTypeModelFieldType.UID) {
+			dataFieldModelsMap[key] = fieldModel;
+		}
+	}
+
 	const hasUID = Object.values(fieldModelsMap).some(
 		(fieldModel) => fieldModel.type === prismicT.CustomTypeModelFieldType.UID,
 	);
 
 	const withURL = config.withURL ?? true;
 
+	const alternateLanguages = (config.alternateLanguages || []).map(
+		(alternateLanguageDocument) =>
+			buildAlternativeLanguage({
+				document: alternateLanguageDocument,
+			}),
+	);
+
 	return {
 		type: model.id,
 		id: faker.git.shortSha(),
@@ -52,12 +71,12 @@ export const customType = <
 		tags: generateTags({ seed: config.seed }),
 		slugs: [] as prismicT.PrismicDocument["slugs"],
 		linked_documents: [] as prismicT.PrismicDocument["linked_documents"],
-		alternate_languages: [] as prismicT.PrismicDocument["alternate_languages"],
+		alternate_languages: alternateLanguages,
 		first_publication_date: timestamp({ seed: config.seed }),
 		last_publication_date: timestamp({ seed: config.seed }),
 		data: valueForModelMap({
 			seed: config.seed,
-			map: fieldModelsMap,
+			map: dataFieldModelsMap,
 			configs: config.configs,
 		}),
 	} as ModelValue<Model>;

package/src/value/date.ts

@@ -1,18 +1,34 @@
 import * as prismicT from "@prismicio/types";
 
-import { MockValueConfig } from "../types";
+import { MockValueStateConfig, MockValueConfig } from "../types";
 
 import { MockTimestampValueConfig, timestamp } from "./timestamp";
 
 export type MockDateValueConfig<
 	Model extends prismicT.CustomTypeModelDateField = prismicT.CustomTypeModelDateField,
-> = Pick<MockTimestampValueConfig, "after" | "before"> & MockValueConfig<Model>;
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = Pick<MockTimestampValueConfig, "after" | "before"> &
+	MockValueConfig<Model> &
+	MockValueStateConfig<State>;
 
-export const date = (config: MockDateValueConfig = {}): prismicT.DateField => {
-	// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-	return timestamp({
-		seed: config.seed,
-		after: config.after,
-		before: config.before,
-	})!.split("T")[0];
+export type MockDateValue<
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = prismicT.DateField<State>;
+
+export const date = <
+	Model extends prismicT.CustomTypeModelDateField = prismicT.CustomTypeModelDateField,
+	State extends prismicT.FieldState = "filled",
+>(
+	config: MockDateValueConfig<Model, State> = {},
+): MockDateValue<State> => {
+	return (
+		config.state === "empty"
+			? null
+			: timestamp({
+					seed: config.seed,
+					after: config.after,
+					before: config.before,
+					state: "filled",
+			  }).split("T")[0]
+	) as MockDateValue<State>;
 };

package/src/value/embed.ts

@@ -3,16 +3,28 @@ import * as prismicT from "@prismicio/types";
 import { buildEmbedField } from "../lib/buildEmbedField";
 import { getMockEmbedData } from "../lib/getMockEmbedData";
 
-import { MockValueConfig } from "../types";
+import { MockValueStateConfig, MockValueConfig } from "../types";
 
 export type MockEmbedValueConfig<
 	Model extends prismicT.CustomTypeModelEmbedField = prismicT.CustomTypeModelEmbedField,
-> = MockValueConfig<Model>;
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = MockValueConfig<Model> & MockValueStateConfig<State>;
 
-export const embed = (
-	config: MockEmbedValueConfig = {},
-): prismicT.EmbedField => {
+export type MockEmbedValue<
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = prismicT.EmbedField<prismicT.AnyOEmbed & prismicT.OEmbedExtra, State>;
+
+export const embed = <
+	Model extends prismicT.CustomTypeModelEmbedField = prismicT.CustomTypeModelEmbedField,
+	State extends prismicT.FieldState = "filled",
+>(
+	config: MockEmbedValueConfig<Model, State> = {},
+): MockEmbedValue<State> => {
 	const embedData = getMockEmbedData({ seed: config.seed });
 
-	return buildEmbedField({ seed: config.seed, embedData });
+	return (
+		config.state === "empty"
+			? {}
+			: buildEmbedField({ seed: config.seed, embedData })
+	) as MockEmbedValue<State>;
 };

package/src/value/geoPoint.ts

@@ -2,21 +2,33 @@ import * as prismicT from "@prismicio/types";
 
 import { createFaker } from "../lib/createFaker";
 
-import { MockValueConfig } from "../types";
+import { MockValueStateConfig, MockValueConfig } from "../types";
 
 export type MockGeoPointValueConfig<
 	Model extends prismicT.CustomTypeModelGeoPointField = prismicT.CustomTypeModelGeoPointField,
-> = MockValueConfig<Model>;
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = MockValueConfig<Model> & MockValueStateConfig<State>;
 
-export const geoPoint = (
-	config: MockGeoPointValueConfig = {},
-): prismicT.GeoPointField => {
+export type MockGeoPointValue<
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = prismicT.GeoPointField<State>;
+
+export const geoPoint = <
+	Model extends prismicT.CustomTypeModelGeoPointField = prismicT.CustomTypeModelGeoPointField,
+	State extends prismicT.FieldState = "filled",
+>(
+	config: MockGeoPointValueConfig<Model, State> = {},
+): MockGeoPointValue<State> => {
 	const faker = createFaker(config.seed);
 
 	const coordinates = faker.address.nearbyGPSCoordinate();
 
-	return {
-		longitude: Number.parseFloat(coordinates[0]),
-		latitude: Number.parseFloat(coordinates[1]),
-	};
+	return (
+		config.state === "empty"
+			? {}
+			: {
+					longitude: Number.parseFloat(coordinates[0]),
+					latitude: Number.parseFloat(coordinates[1]),
+			  }
+	) as MockGeoPointValue<State>;
 };