@prismicio/mock 0.0.6 → 0.0.7

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

@@ -5,59 +5,73 @@ 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";
 
 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;
-
-					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));
-					}
-
-					return shouldKeep;
-			  })
+			? 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.tags) {
+							shouldKeep =
+								shouldKeep &&
+								model.config.tags.some((tag) => document.tags.includes(tag));
+						}
+
+						return shouldKeep;
+					},
+			  )
 			: [
 					{
 						...documentGen({ seed: config.seed }),
@@ -67,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);
@@ -76,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/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>;
 };

package/src/value/group.ts

@@ -10,25 +10,10 @@ import { MockValueConfig, ModelValue } from "../types";
 
 import * as modelGen from "../model";
 
-const patterns = {
-	short: {
-		minItems: 1,
-		maxItems: 3,
-	},
-	medium: {
-		minItems: 3,
-		maxItems: 6,
-	},
-	long: {
-		minItems: 6,
-		maxItems: 12,
-	},
-} as const;
-
 export type MockGroupValueConfig<
 	Model extends prismicT.CustomTypeModelGroupField = prismicT.CustomTypeModelGroupField,
 > = {
-	pattern?: keyof typeof patterns;
+	itemsCount?: number;
 	configs?: ValueForModelMapConfigs;
 } & MockValueConfig<Model>;
 
@@ -41,17 +26,12 @@ export const group = <
 
 	const model = config.model || modelGen.group({ seed: config.seed });
 
-	const patternKey =
-		config.pattern ||
-		faker.random.arrayElement(
-			Object.keys(patterns) as (keyof typeof patterns)[],
-		);
-	const pattern = patterns[patternKey];
-
-	const itemsCount = faker.datatype.number({
-		min: pattern.minItems,
-		max: pattern.maxItems,
-	});
+	const itemsCount =
+		config.itemsCount ??
+		faker.datatype.number({
+			min: 1,
+			max: 6,
+		});
 
 	return Array(itemsCount)
 		.fill(undefined)

package/src/value/image.ts

@@ -1,36 +1,49 @@
 import * as prismicT from "@prismicio/types";
 
-import { buildImageField } from "../lib/buildImageField";
+import { buildImageFieldImage } from "../lib/buildImageFieldImage";
 import { getMockImageData } from "../lib/getMockImageData";
 
-import { MockValueConfig } from "../types";
+import { MockValueStateConfig, MockValueConfig } from "../types";
 
 import * as modelGen from "../model";
 
 export type MockImageValueConfig<
 	Model extends prismicT.CustomTypeModelImageField = prismicT.CustomTypeModelImageField,
-> = MockValueConfig<Model>;
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = MockValueConfig<Model> & MockValueStateConfig<State>;
 
-export const image = (
-	config: MockImageValueConfig = {},
-): prismicT.ImageField => {
+export type MockImageValue<
+	Model extends prismicT.CustomTypeModelImageField = prismicT.CustomTypeModelImageField,
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = prismicT.ImageField<Model["config"]["thumbnails"][number]["name"], State>;
+
+export const image = <
+	Model extends prismicT.CustomTypeModelImageField = prismicT.CustomTypeModelImageField,
+	State extends prismicT.FieldState = "filled",
+>(
+	config: MockImageValueConfig<Model, State> = {},
+): MockImageValue<Model, State> => {
 	const model = config.model || modelGen.image({ seed: config.seed });
 	const imageData = getMockImageData({ seed: config.seed });
 
-	const value = buildImageField({
+	const value = buildImageFieldImage({
 		seed: config.seed,
 		imageData,
 		constraint: model.config.constraint,
-	});
+		state: config.state,
+	}) as MockImageValue<Model, State>;
 
 	for (const thumbnail of model.config.thumbnails) {
-		value[thumbnail.name] = buildImageField({
+		// TODO: Resolve the following type error
+		// @ts-expect-error - Unsure how to fix this type mismatch
+		value[thumbnail.name as keyof typeof value] = buildImageFieldImage({
 			seed: config.seed,
 			imageData,
 			constraint: {
 				width: thumbnail.width,
 				height: thumbnail.height,
 			},
+			state: config.state,
 		});
 	}
 

package/src/value/integrationFields.ts

@@ -4,31 +4,43 @@ import * as changeCase from "change-case";
 import { createFaker } from "../lib/createFaker";
 import { getMockImageData } from "../lib/getMockImageData";
 
-import { MockValueConfig } from "../types";
+import { MockValueStateConfig, MockValueConfig } from "../types";
 
 export type MockIntegrationFieldsValueConfig<
 	Model extends prismicT.CustomTypeModelIntegrationFieldsField = prismicT.CustomTypeModelIntegrationFieldsField,
-	Blob extends unknown = unknown,
+	Blob = unknown,
+	State extends prismicT.FieldState = prismicT.FieldState,
 > = {
 	data?: Blob;
-} & MockValueConfig<Model>;
+} & MockValueConfig<Model> &
+	MockValueStateConfig<State>;
+
+export type MockIntegrationFieldsValue<
+	Blob = unknown,
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = prismicT.IntegrationFields<Blob, State>;
 
 export const integrationFields = <
 	Model extends prismicT.CustomTypeModelIntegrationFieldsField = prismicT.CustomTypeModelIntegrationFieldsField,
-	Blob extends unknown = unknown,
+	Blob = unknown,
+	State extends prismicT.FieldState = "filled",
 >(
-	config: MockIntegrationFieldsValueConfig<Model, Blob> = {},
-): prismicT.IntegrationFields<Blob> => {
+	config: MockIntegrationFieldsValueConfig<Model, Blob, State> = {},
+): MockIntegrationFieldsValue<Blob, State> => {
 	const faker = createFaker(config.seed);
 
 	const imageData = getMockImageData({ seed: config.seed });
 
-	return {
-		id: faker.git.shortSha(),
-		title: changeCase.capitalCase(faker.lorem.words(3)),
-		description: faker.lorem.sentence(),
-		image_url: imageData.url,
-		last_update: faker.date.past(20, new Date("2021-03-07")).getTime(),
-		blob: config.data as Blob,
-	};
+	return (
+		config.state === "empty"
+			? null
+			: {
+					id: faker.git.shortSha(),
+					title: changeCase.capitalCase(faker.lorem.words(3)),
+					description: faker.lorem.sentence(),
+					image_url: imageData.url,
+					last_update: faker.date.past(20, new Date("2021-03-07")).getTime(),
+					blob: config.data as Blob,
+			  }
+	) as MockIntegrationFieldsValue<Blob, State>;
 };

package/src/value/keyText.ts

@@ -3,16 +3,28 @@ import * as changeCase from "change-case";
 
 import { createFaker } from "../lib/createFaker";
 
-import { MockValueConfig } from "../types";
+import { MockValueStateConfig, MockValueConfig } from "../types";
 
 export type MockKeyTextValueConfig<
 	Model extends prismicT.CustomTypeModelKeyTextField = prismicT.CustomTypeModelKeyTextField,
-> = MockValueConfig<Model>;
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = MockValueConfig<Model> & MockValueStateConfig<State>;
 
-export const keyText = (
-	config: MockKeyTextValueConfig = {},
-): prismicT.KeyTextField => {
+export type MockKeyTextValue<
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = prismicT.KeyTextField<State>;
+
+export const keyText = <
+	Model extends prismicT.CustomTypeModelKeyTextField = prismicT.CustomTypeModelKeyTextField,
+	State extends prismicT.FieldState = "filled",
+>(
+	config: MockKeyTextValueConfig<Model, State> = {},
+): MockKeyTextValue<State> => {
 	const faker = createFaker(config.seed);
 
-	return changeCase.sentenceCase(faker.lorem.words(3));
+	return (
+		config.state === "empty"
+			? null
+			: changeCase.sentenceCase(faker.lorem.words(3))
+	) as MockKeyTextValue<State>;
 };

package/src/value/link.ts

@@ -2,7 +2,7 @@ import * as prismicT from "@prismicio/types";
 
 import { createFaker } from "../lib/createFaker";
 
-import { MockValueConfig } from "../types";
+import { MockValueStateConfig, MockValueConfig } from "../types";
 
 import * as modelGen from "../model";
 
@@ -10,47 +10,45 @@ import { contentRelationship } from "./contentRelationship";
 import { linkToMedia } from "./linkToMedia";
 
 export type MockLinkValueConfig<
-	LinkType extends prismicT.LinkType = prismicT.LinkType,
-	IsFilled extends boolean = true,
+	LinkType extends typeof prismicT.LinkType[keyof typeof prismicT.LinkType] = typeof prismicT.LinkType[keyof typeof prismicT.LinkType],
 	Model extends prismicT.CustomTypeModelLinkField = prismicT.CustomTypeModelLinkField,
+	State extends prismicT.FieldState = prismicT.FieldState,
 > = {
 	type?: LinkType;
-	isFilled?: IsFilled;
 	withTargetBlank?: Model["config"]["allowTargetBlank"] extends undefined
 		? false
 		: boolean;
 	/**
 	 * A list of potential documents to which the field can be linked.
 	 */
-	linkableDocuments?: LinkType extends prismicT.LinkType.Document
+	linkableDocuments?: LinkType extends typeof prismicT.LinkType.Document
 		? prismicT.PrismicDocument[]
 		: never;
-} & MockValueConfig<Model>;
+} & MockValueConfig<Model> &
+	MockValueStateConfig<State>;
 
 type MockLinkValue<
-	LinkType extends prismicT.LinkType = prismicT.LinkType,
-	IsFilled extends boolean = true,
-> = IsFilled extends true
-	? LinkType extends prismicT.LinkType.Web
-		? prismicT.FilledLinkToWebField
-		: LinkType extends prismicT.LinkType.Media
-		? prismicT.FilledLinkToMediaField
-		: LinkType extends prismicT.LinkType.Document
-		? prismicT.FilledLinkToDocumentField
-		: never
-	: prismicT.EmptyLinkField<LinkType>;
+	LinkType extends typeof prismicT.LinkType[keyof typeof prismicT.LinkType] = typeof prismicT.LinkType[keyof typeof prismicT.LinkType],
+	State extends prismicT.FieldState = "filled",
+> = State extends "empty"
+	? prismicT.EmptyLinkField<LinkType>
+	: LinkType extends typeof prismicT.LinkType.Web
+	? prismicT.FilledLinkToWebField
+	: LinkType extends typeof prismicT.LinkType.Media
+	? prismicT.FilledLinkToMediaField
+	: LinkType extends typeof prismicT.LinkType.Document
+	? prismicT.FilledLinkToDocumentField
+	: never;
 
 export const link = <
-	LinkType extends prismicT.LinkType = prismicT.LinkType,
-	IsFilled extends boolean = true,
+	LinkType extends typeof prismicT.LinkType[keyof typeof prismicT.LinkType] = typeof prismicT.LinkType[keyof typeof prismicT.LinkType],
 	Model extends prismicT.CustomTypeModelLinkField = prismicT.CustomTypeModelLinkField,
+	State extends prismicT.FieldState = "filled",
 >(
-	config: MockLinkValueConfig<LinkType, IsFilled, Model> = {},
-): MockLinkValue<LinkType, IsFilled> => {
+	config: MockLinkValueConfig<LinkType, Model, State> = {},
+): MockLinkValue<LinkType, State> => {
 	const faker = createFaker(config.seed);
 
-	const isFilled = config.isFilled ?? true;
-
 	const type =
 		config.type ||
 		faker.random.arrayElement([
@@ -59,24 +57,29 @@ export const link = <
 			prismicT.LinkType.Media,
 		]);
 
-	if (isFilled) {
+	if (config.state === "empty") {
+		return {
+			link_type: type,
+		} as MockLinkValue<LinkType, State>;
+	} else {
 		switch (type) {
 			case prismicT.LinkType.Document: {
 				return contentRelationship({
 					seed: config.seed,
-					isFilled,
+					state: config.state,
 					linkableDocuments: config.linkableDocuments,
-				}) as MockLinkValue<LinkType, IsFilled>;
+				}) as unknown as MockLinkValue<LinkType, State>;
 			}
 
 			case prismicT.LinkType.Media: {
 				return linkToMedia({
 					seed: config.seed,
-					isFilled,
-				}) as MockLinkValue<LinkType, IsFilled>;
+					state: config.state,
+				}) as MockLinkValue<LinkType, State>;
 			}
 
-			case prismicT.LinkType.Web: {
+			case prismicT.LinkType.Web:
+			default: {
 				const model = config.model || modelGen.link({ seed: config.seed });
 
 				return {
@@ -87,12 +90,8 @@ export const link = <
 						(model.config.allowTargetBlank && faker.datatype.boolean())
 							? "_blank"
 							: undefined,
-				} as MockLinkValue<LinkType, IsFilled>;
+				} as MockLinkValue<LinkType, State>;
 			}
 		}
 	}
-
-	return {
-		link_type: type,
-	} as MockLinkValue<LinkType, IsFilled>;
 };