@prismicio/mock 0.0.3 → 0.0.7

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>;
 };

package/src/value/linkToMedia.ts

@@ -2,31 +2,30 @@ import * as prismicT from "@prismicio/types";
 
 import { createFaker } from "../lib/createFaker";
 
-import { MockValueConfig } from "../types";
+import { MockValueStateConfig, MockValueConfig } from "../types";
 
 export type MockLinkToMediaValueConfig<
-	IsFilled extends boolean = true,
 	Model extends prismicT.CustomTypeModelLinkToMediaField = prismicT.CustomTypeModelLinkToMediaField,
-> = {
-	isFilled?: IsFilled;
-} & MockValueConfig<Model>;
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = MockValueConfig<Model> & MockValueStateConfig<State>;
 
-type MockLinkToMediaValue<IsFilled extends boolean = true> =
-	IsFilled extends true
-		? prismicT.FilledLinkToMediaField
-		: prismicT.EmptyLinkField<prismicT.LinkType.Media>;
+type MockLinkToMediaValue<
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = prismicT.LinkToMediaField<State>;
 
 export const linkToMedia = <
-	IsFilled extends boolean = true,
 	Model extends prismicT.CustomTypeModelLinkToMediaField = prismicT.CustomTypeModelLinkToMediaField,
+	State extends prismicT.FieldState = "filled",
 >(
-	config: MockLinkToMediaValueConfig<IsFilled, Model> = {},
-): MockLinkToMediaValue<IsFilled> => {
+	config: MockLinkToMediaValueConfig<Model, State> = {},
+): MockLinkToMediaValue<State> => {
 	const faker = createFaker(config.seed);
 
-	const isFilled = config.isFilled ?? true;
-
-	if (isFilled) {
+	if (config.state === "empty") {
+		return {
+			link_type: prismicT.LinkType.Media,
+		} as MockLinkToMediaValue<State>;
+	} else {
 		return {
 			link_type: prismicT.LinkType.Media,
 			name: faker.system.commonFileName(),
@@ -35,10 +34,6 @@ export const linkToMedia = <
 			size: faker.datatype.number().toString(),
 			height: faker.datatype.number().toString(),
 			width: faker.datatype.number().toString(),
-		} as prismicT.FilledLinkToMediaField;
-	} else {
-		return {
-			link_type: prismicT.LinkType.Media,
-		} as MockLinkToMediaValue<IsFilled>;
+		} as MockLinkToMediaValue<State>;
 	}
 };

package/src/value/number.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 MockNumberValueConfig<
 	Model extends prismicT.CustomTypeModelNumberField = prismicT.CustomTypeModelNumberField,
-> = MockValueConfig<Model>;
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = MockValueConfig<Model> & MockValueStateConfig<State>;
 
-export const number = (
-	config: MockNumberValueConfig = {},
-): prismicT.NumberField => {
+export type MockNumberValue<
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = prismicT.NumberField<State>;
+
+export const number = <
+	Model extends prismicT.CustomTypeModelNumberField = prismicT.CustomTypeModelNumberField,
+	State extends prismicT.FieldState = "filled",
+>(
+	config: MockNumberValueConfig<Model, State> = {},
+): MockNumberValue<State> => {
 	const faker = createFaker(config.seed);
 
-	return faker.datatype.number();
+	return (
+		config.state === "empty" ? null : faker.datatype.number()
+	) as MockNumberValue<State>;
 };

package/src/value/richText/heading.ts

@@ -8,12 +8,12 @@ import { MockRichTextValueConfig } from "../../types";
 import * as modelGen from "../../model";
 
 type RichTextNodeTitleType =
-	| prismicT.RichTextNodeType.heading1
-	| prismicT.RichTextNodeType.heading2
-	| prismicT.RichTextNodeType.heading3
-	| prismicT.RichTextNodeType.heading4
-	| prismicT.RichTextNodeType.heading5
-	| prismicT.RichTextNodeType.heading6;
+	| typeof prismicT.RichTextNodeType.heading1
+	| typeof prismicT.RichTextNodeType.heading2
+	| typeof prismicT.RichTextNodeType.heading3
+	| typeof prismicT.RichTextNodeType.heading4
+	| typeof prismicT.RichTextNodeType.heading5
+	| typeof prismicT.RichTextNodeType.heading6;
 
 type RTHeadingNode =
 	| prismicT.RTHeading1Node
@@ -61,7 +61,7 @@ export const heading = (
 				prismicT.RichTextNodeType.heading4,
 				prismicT.RichTextNodeType.heading5,
 				prismicT.RichTextNodeType.heading6,
-			].includes(type as prismicT.RichTextNodeType),
+			].includes(type as RichTextNodeTitleType),
 		) as RichTextNodeTitleType[];
 	const type = faker.random.arrayElement(types);
 

package/src/value/richText/image.ts

@@ -1,6 +1,6 @@
 import * as prismicT from "@prismicio/types";
 
-import { buildImageField } from "../../lib/buildImageField";
+import { buildImageFieldImage } from "../../lib/buildImageFieldImage";
 import { getMockImageData } from "../../lib/getMockImageData";
 
 import { MockRichTextValueConfig } from "../../types";
@@ -11,7 +11,11 @@ export const image = (
 	config: MockRichTextImageValueConfig = {},
 ): prismicT.RTImageNode | undefined => {
 	const imageData = getMockImageData({ seed: config.seed });
-	const imageField = buildImageField({ seed: config.seed, imageData });
+	const imageField = buildImageFieldImage({
+		seed: config.seed,
+		imageData,
+		state: false,
+	});
 
 	return {
 		type: prismicT.RichTextNodeType.image,

package/src/value/richText/index.ts

@@ -92,7 +92,7 @@ export const richText = (
 			})
 			.flat()
 			.filter((block): block is prismicT.RTNode => block !== undefined)
-			.slice(0, blockCount);
+			.slice(0, blockCount) as prismicT.RichTextField;
 	} else {
 		return [];
 	}

package/src/value/select.ts

@@ -2,23 +2,38 @@ 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";
 
 export type MockSelectValueConfig<
 	Model extends prismicT.CustomTypeModelSelectField = prismicT.CustomTypeModelSelectField,
-> = MockValueConfig<Model>;
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = MockValueConfig<Model> & MockValueStateConfig<State>;
 
-export const select = (
-	config: MockSelectValueConfig = {},
-): prismicT.SelectField => {
+export type MockSelectValue<
+	Model extends prismicT.CustomTypeModelSelectField = prismicT.CustomTypeModelSelectField,
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = prismicT.SelectField<Model["config"]["options"][number], State>;
+
+export const select = <
+	Model extends prismicT.CustomTypeModelSelectField = prismicT.CustomTypeModelSelectField,
+	State extends prismicT.FieldState = "filled",
+>(
+	config: MockSelectValueConfig<Model, State> = {},
+): MockSelectValue<Model, State> => {
 	const faker = createFaker(config.seed);
 
 	const model = config.model || modelGen.select({ seed: config.seed });
 	const defaultValue = model.config.default_value;
 
-	return typeof defaultValue === "string" && faker.datatype.boolean()
-		? defaultValue
-		: faker.random.arrayElement(model.config.options);
+	if (config.state === "empty") {
+		return null as MockSelectValue<Model, State>;
+	} else {
+		return (
+			typeof defaultValue === "string" && faker.datatype.boolean()
+				? defaultValue
+				: faker.random.arrayElement(model.config.options)
+		) as MockSelectValue<Model, State>;
+	}
 };

package/src/value/sharedSlice.ts

@@ -14,7 +14,7 @@ export type MockSharedSliceValueConfig<
 	Model extends prismicT.SharedSliceModel = prismicT.SharedSliceModel,
 > = Pick<
 	MockSharedSliceVariationValueConfig,
-	"pattern" | "primaryFieldConfigs" | "itemsFieldConfigs"
+	"itemsCount" | "primaryFieldConfigs" | "itemsFieldConfigs"
 > &
 	MockValueConfig<Model>;
 
@@ -31,7 +31,7 @@ export const sharedSlice = <
 	return sharedSliceVariation({
 		seed: config.seed,
 		model: variationModel,
-		pattern: config.pattern,
+		itemsCount: config.itemsCount,
 		type: model.id,
 		primaryFieldConfigs: config.primaryFieldConfigs,
 		itemsFieldConfigs: config.itemsFieldConfigs,

package/src/value/sharedSliceVariation.ts

@@ -1,5 +1,4 @@
 import * as prismicT from "@prismicio/types";
-import * as changeCase from "change-case";
 
 import { MockValueConfig, ModelValue } from "../types";
 
@@ -12,31 +11,12 @@ import {
 
 import * as modelGen from "../model";
 
-const patterns = {
-	none: {
-		minItems: 0,
-		maxItems: 0,
-	},
-	short: {
-		minItems: 1,
-		maxItems: 3,
-	},
-	medium: {
-		minItems: 3,
-		maxItems: 6,
-	},
-	long: {
-		minItems: 6,
-		maxItems: 12,
-	},
-} as const;
-
 export type MockSharedSliceVariationValueConfig<
 	Model extends prismicT.SharedSliceModelVariation = prismicT.SharedSliceModelVariation,
 > = {
 	type?: string;
 	label?: string;
-	pattern?: keyof typeof patterns;
+	itemsCount?: number;
 	primaryFieldConfigs?: ValueForModelMapConfigs;
 	itemsFieldConfigs?: ValueForModelMapConfigs;
 } & MockValueConfig<Model>;
@@ -51,28 +31,20 @@ export const sharedSliceVariation = <
 	const model =
 		config.model || modelGen.sharedSliceVariation({ seed: config.seed });
 
-	const patternKey =
-		config.pattern ||
-		faker.random.arrayElement(
-			Object.keys(patterns) as (keyof typeof patterns)[],
-		);
-	const pattern = patterns[patternKey];
-
 	const sliceType = config.type ?? generateFieldId({ seed: config.seed });
-	const sliceLabel =
-		config.label ?? changeCase.capitalCase(faker.company.bsNoun());
 
 	const itemsCount =
 		Object.keys(model.items).length > 0
-			? faker.datatype.number({
-					min: pattern.minItems,
-					max: pattern.maxItems,
+			? config.itemsCount ??
+			  faker.datatype.number({
+					min: 1,
+					max: 6,
 			  })
 			: 0;
 
 	return {
 		slice_type: sliceType,
-		slice_label: sliceLabel,
+		slice_label: null,
 		variation: model.id,
 		version: faker.git.shortSha(),
 		primary: valueForModelMap({

package/src/value/slice.ts

@@ -12,31 +12,12 @@ import {
 
 import * as modelGen from "../model";
 
-const patterns = {
-	none: {
-		minItems: 0,
-		maxItems: 0,
-	},
-	short: {
-		minItems: 1,
-		maxItems: 3,
-	},
-	medium: {
-		minItems: 3,
-		maxItems: 6,
-	},
-	long: {
-		minItems: 6,
-		maxItems: 12,
-	},
-} as const;
-
 export type MockSliceValueConfig<
 	Model extends prismicT.CustomTypeModelSlice = prismicT.CustomTypeModelSlice,
 > = {
 	type?: string;
 	label?: string | null;
-	pattern?: keyof typeof patterns;
+	itemsCount?: number;
 	primaryFieldConfigs?: ValueForModelMapConfigs;
 	itemsFieldConfigs?: ValueForModelMapConfigs;
 } & MockValueConfig<Model>;
@@ -50,13 +31,6 @@ export const slice = <
 
 	const model = config.model || modelGen.slice({ seed: config.seed });
 
-	const patternKey =
-		config.pattern ||
-		faker.random.arrayElement(
-			Object.keys(patterns) as (keyof typeof patterns)[],
-		);
-	const pattern = patterns[patternKey];
-
 	const sliceType = config.type ?? generateFieldId({ seed: config.seed });
 	const sliceLabel =
 		config.label !== undefined
@@ -65,9 +39,10 @@ export const slice = <
 
 	const itemsCount =
 		Object.keys(model.repeat).length > 0
-			? faker.datatype.number({
-					min: pattern.minItems,
-					max: pattern.maxItems,
+			? config.itemsCount ??
+			  faker.datatype.number({
+					min: 1,
+					max: 6,
 			  })
 			: 0;