@prismicio/mock 0.0.6 → 0.0.7

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;
 

package/src/value/sliceZone.ts

@@ -10,26 +10,11 @@ import * as modelGen from "../model";
 import { slice } from "./slice";
 import { sharedSlice } from "./sharedSlice";
 
-const patterns = {
-	short: {
-		minItems: 1,
-		maxItems: 3,
-	},
-	medium: {
-		minItems: 3,
-		maxItems: 6,
-	},
-	long: {
-		minItems: 6,
-		maxItems: 12,
-	},
-} as const;
-
 export type MockSliceZoneValueConfig<
 	Model extends prismicT.CustomTypeModelSliceZoneField = prismicT.CustomTypeModelSliceZoneField,
 > = {
 	sharedSliceModels?: prismicT.SharedSliceModel[];
-	pattern?: keyof typeof patterns;
+	itemsCount?: number;
 	primaryFieldConfigs?: ValueForModelMapConfigs;
 	itemsFieldConfigs?: ValueForModelMapConfigs;
 } & MockValueConfig<Model>;
@@ -43,57 +28,56 @@ export const sliceZone = <
 
 	const model = config.model || modelGen.sliceZone({ 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,
-	});
-
-	return Array(itemsCount)
-		.fill(undefined)
-		.map(() => {
-			const choices = Object.entries(model.config.choices);
-			const [choiceType, choiceModel] = faker.random.arrayElement(choices);
-
-			const choiceLabels = model.config.labels[choiceType] || [];
-			const choiceLabel = faker.random.arrayElement(choiceLabels);
+	if (Object.keys(model.config.choices).length > 0) {
+		const itemsCount =
+			config.itemsCount ??
+			faker.datatype.number({
+				min: 1,
+				max: 6,
+			});
 
-			switch (choiceModel.type) {
-				case prismicT.CustomTypeModelSliceType.Slice: {
-					return slice({
-						seed: config.seed,
-						model: choiceModel,
-						type: choiceType,
-						label: choiceLabel ? choiceLabel.name : null,
-						primaryFieldConfigs: config.primaryFieldConfigs,
-						itemsFieldConfigs: config.itemsFieldConfigs,
-					});
-				}
+		return Array(itemsCount)
+			.fill(undefined)
+			.map(() => {
+				const choices = Object.entries(model.config.choices);
+				const [choiceType, choiceModel] = faker.random.arrayElement(choices);
 
-				case prismicT.CustomTypeModelSliceType.SharedSlice: {
-					const sharedSliceModel = config.sharedSliceModels?.find(
-						(sharedSliceModel) => sharedSliceModel.id === choiceType,
-					);
+				const choiceLabels = model.config.labels[choiceType] || [];
+				const choiceLabel = faker.random.arrayElement(choiceLabels);
 
-					if (sharedSliceModel) {
-						return sharedSlice({
+				switch (choiceModel.type) {
+					case prismicT.CustomTypeModelSliceType.Slice: {
+						return slice({
 							seed: config.seed,
-							model: sharedSliceModel,
+							model: choiceModel,
+							type: choiceType,
+							label: choiceLabel ? choiceLabel.name : null,
 							primaryFieldConfigs: config.primaryFieldConfigs,
 							itemsFieldConfigs: config.itemsFieldConfigs,
 						});
 					}
+
+					case prismicT.CustomTypeModelSliceType.SharedSlice: {
+						const sharedSliceModel = config.sharedSliceModels?.find(
+							(sharedSliceModel) => sharedSliceModel.id === choiceType,
+						);
+
+						if (sharedSliceModel) {
+							return sharedSlice({
+								seed: config.seed,
+								model: sharedSliceModel,
+								primaryFieldConfigs: config.primaryFieldConfigs,
+								itemsFieldConfigs: config.itemsFieldConfigs,
+							});
+						}
+					}
 				}
-			}
-		})
-		.filter(
-			(slice): slice is prismicT.Slice | prismicT.SharedSlice =>
-				slice !== undefined,
-		) as ModelValue<Model>;
+			})
+			.filter(
+				(slice): slice is prismicT.Slice | prismicT.SharedSlice =>
+					slice !== undefined,
+			) as ModelValue<Model>;
+	} else {
+		return [] as unknown as ModelValue<Model>;
+	}
 };

package/src/value/timestamp.ts

@@ -2,18 +2,27 @@ import * as prismicT from "@prismicio/types";
 
 import { createFaker } from "../lib/createFaker";
 
-import { MockValueConfig } from "../types";
+import { MockValueStateConfig, MockValueConfig } from "../types";
 
 export type MockTimestampValueConfig<
 	Model extends prismicT.CustomTypeModelTimestampField = prismicT.CustomTypeModelTimestampField,
+	State extends prismicT.FieldState = prismicT.FieldState,
 > = {
 	after?: Date;
 	before?: Date;
-} & MockValueConfig<Model>;
+} & MockValueConfig<Model> &
+	MockValueStateConfig<State>;
 
-export const timestamp = (
-	config: MockTimestampValueConfig = {},
-): prismicT.TimestampField => {
+export type MockTimestampValue<
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = prismicT.TimestampField<State>;
+
+export const timestamp = <
+	Model extends prismicT.CustomTypeModelTimestampField = prismicT.CustomTypeModelTimestampField,
+	State extends prismicT.FieldState = "filled",
+>(
+	config: MockTimestampValueConfig<Model, State> = {},
+): MockTimestampValue<State> => {
 	const faker = createFaker(config.seed);
 
 	// Faker seems to have problems accepting parameters for `faker.date.between`
@@ -26,5 +35,9 @@ export const timestamp = (
 		config.before ||
 		faker.date.future(20, new Date("2021-03-07")).toISOString().split("T")[0];
 
-	return faker.date.between(after, before).toISOString();
+	return (
+		config.state === "empty"
+			? null
+			: faker.date.between(after, before).toISOString()
+	) as MockTimestampValue<State>;
 };

package/src/value/title.ts

@@ -20,5 +20,5 @@ export const title = (
 			model: config.model,
 			pattern: config.pattern,
 		})!,
-	];
+	] as prismicT.TitleField;
 };

package/src/value/uid.ts

@@ -11,7 +11,7 @@ export type MockUIDValueConfig<
 
 export const uid = (
 	config: MockUIDValueConfig = {},
-): prismicT.PrismicDocument["uid"] => {
+): NonNullable<prismicT.PrismicDocument["uid"]> => {
 	const faker = createFaker(config.seed);
 
 	return changeCase.snakeCase(faker.lorem.words(2));