@prismicio/mock 0.0.7 → 0.0.10

package/src/value/embed.ts

@@ -7,24 +7,37 @@ import { MockValueStateConfig, MockValueConfig } from "../types";
 
 export type MockEmbedValueConfig<
 	Model extends prismicT.CustomTypeModelEmbedField = prismicT.CustomTypeModelEmbedField,
+	Data extends prismicT.AnyOEmbed = prismicT.AnyOEmbed,
 	State extends prismicT.FieldState = prismicT.FieldState,
-> = MockValueConfig<Model> & MockValueStateConfig<State>;
+> = {
+	url?: string;
+	html?: string;
+	data?: Data;
+} & MockValueConfig<Model> &
+	MockValueStateConfig<State>;
 
 export type MockEmbedValue<
+	Data extends prismicT.AnyOEmbed = prismicT.AnyOEmbed,
 	State extends prismicT.FieldState = prismicT.FieldState,
-> = prismicT.EmbedField<prismicT.AnyOEmbed & prismicT.OEmbedExtra, State>;
+> = prismicT.EmbedField<Data, State>;
 
 export const embed = <
 	Model extends prismicT.CustomTypeModelEmbedField = prismicT.CustomTypeModelEmbedField,
+	Data extends prismicT.AnyOEmbed = prismicT.AnyOEmbed,
 	State extends prismicT.FieldState = "filled",
 >(
-	config: MockEmbedValueConfig<Model, State> = {},
-): MockEmbedValue<State> => {
-	const embedData = getMockEmbedData({ seed: config.seed });
+	config: MockEmbedValueConfig<Model, Data, State> = {},
+): MockEmbedValue<Data, State> => {
+	const data = config.data ?? getMockEmbedData({ seed: config.seed });
 
 	return (
 		config.state === "empty"
 			? {}
-			: buildEmbedField({ seed: config.seed, embedData })
-	) as MockEmbedValue<State>;
+			: buildEmbedField({
+					seed: config.seed,
+					url: config.url ?? ("embed_url" in data ? data.embed_url : undefined),
+					html: config.html ?? ("html" in data ? data.html : undefined),
+					data,
+			  })
+	) as MockEmbedValue<Data, State>;
 };

package/src/value/geoPoint.ts

@@ -21,14 +21,12 @@ export const geoPoint = <
 ): MockGeoPointValue<State> => {
 	const faker = createFaker(config.seed);
 
-	const coordinates = faker.address.nearbyGPSCoordinate();
-
 	return (
 		config.state === "empty"
 			? {}
 			: {
-					longitude: Number.parseFloat(coordinates[0]),
-					latitude: Number.parseFloat(coordinates[1]),
+					longitude: faker.rangeFloat(-180, 180),
+					latitude: faker.rangeFloat(-90, 90),
 			  }
 	) as MockGeoPointValue<State>;
 };

package/src/value/group.ts

@@ -6,40 +6,46 @@ import {
 	ValueForModelMapConfigs,
 } from "../lib/valueForModelMap";
 
-import { MockValueConfig, ModelValue } from "../types";
+import { MockValueConfig, MockValueStateConfig, ModelValue } from "../types";
 
 import * as modelGen from "../model";
 
 export type MockGroupValueConfig<
 	Model extends prismicT.CustomTypeModelGroupField = prismicT.CustomTypeModelGroupField,
+	State extends prismicT.FieldState = prismicT.FieldState,
 > = {
-	itemsCount?: number;
+	itemsCount?: State extends "empty" ? 0 : number;
 	configs?: ValueForModelMapConfigs;
-} & MockValueConfig<Model>;
+} & MockValueConfig<Model> &
+	MockValueStateConfig<State>;
+
+export type MockGroupValue<
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = prismicT.DateField<State>;
 
 export const group = <
 	Model extends prismicT.CustomTypeModelGroupField = prismicT.CustomTypeModelGroupField,
+	State extends prismicT.FieldState = "filled",
 >(
-	config: MockGroupValueConfig<Model> = {},
-): ModelValue<Model> => {
-	const faker = createFaker(config.seed);
-
-	const model = config.model || modelGen.group({ seed: config.seed });
-
-	const itemsCount =
-		config.itemsCount ??
-		faker.datatype.number({
-			min: 1,
-			max: 6,
-		});
-
-	return Array(itemsCount)
-		.fill(undefined)
-		.map(() => {
-			return valueForModelMap({
-				seed: config.seed,
-				map: model.config.fields,
-				configs: config.configs,
-			});
-		}) as ModelValue<Model>;
+	config: MockGroupValueConfig<Model, State> = {},
+): ModelValue<Model, State> => {
+	if (config.state === "empty") {
+		return [] as ModelValue<Model, State>;
+	} else {
+		const faker = createFaker(config.seed);
+
+		const model = config.model || modelGen.group({ seed: config.seed });
+
+		const itemsCount = config.itemsCount ?? faker.range(1, 6);
+
+		return Array(itemsCount)
+			.fill(undefined)
+			.map(() => {
+				return valueForModelMap({
+					seed: config.seed,
+					map: model.config.fields,
+					configs: config.configs,
+				});
+			}) as ModelValue<Model, State>;
+	}
 };

package/src/value/integrationFields.ts

@@ -35,11 +35,11 @@ export const integrationFields = <
 		config.state === "empty"
 			? null
 			: {
-					id: faker.git.shortSha(),
-					title: changeCase.capitalCase(faker.lorem.words(3)),
-					description: faker.lorem.sentence(),
+					id: faker.hash(7),
+					title: changeCase.capitalCase(faker.words(faker.range(1, 3))),
+					description: changeCase.sentenceCase(faker.words(faker.range(5, 10))),
 					image_url: imageData.url,
-					last_update: faker.date.past(20, new Date("2021-03-07")).getTime(),
+					last_update: faker.date().getTime(),
 					blob: config.data as Blob,
 			  }
 	) as MockIntegrationFieldsValue<Blob, State>;

package/src/value/keyText.ts

@@ -23,8 +23,6 @@ export const keyText = <
 	const faker = createFaker(config.seed);
 
 	return (
-		config.state === "empty"
-			? null
-			: changeCase.sentenceCase(faker.lorem.words(3))
+		config.state === "empty" ? null : changeCase.sentenceCase(faker.words(3))
 	) as MockKeyTextValue<State>;
 };

package/src/value/link.ts

@@ -51,7 +51,7 @@ export const link = <
 
 	const type =
 		config.type ||
-		faker.random.arrayElement([
+		faker.randomElement([
 			prismicT.LinkType.Web,
 			prismicT.LinkType.Document,
 			prismicT.LinkType.Media,
@@ -84,10 +84,10 @@ export const link = <
 
 				return {
 					link_type: prismicT.LinkType.Web,
-					url: faker.internet.url(),
+					url: faker.url(),
 					target:
 						config.withTargetBlank ??
-						(model.config.allowTargetBlank && faker.datatype.boolean())
+						(model.config.allowTargetBlank && faker.boolean())
 							? "_blank"
 							: undefined,
 				} as MockLinkValue<LinkType, State>;

package/src/value/linkToMedia.ts

@@ -1,4 +1,5 @@
 import * as prismicT from "@prismicio/types";
+import * as changeCase from "change-case";
 
 import { createFaker } from "../lib/createFaker";
 
@@ -28,12 +29,12 @@ export const linkToMedia = <
 	} else {
 		return {
 			link_type: prismicT.LinkType.Media,
-			name: faker.system.commonFileName(),
-			kind: faker.system.commonFileType(),
-			url: faker.internet.url(),
-			size: faker.datatype.number().toString(),
-			height: faker.datatype.number().toString(),
-			width: faker.datatype.number().toString(),
+			name: `${changeCase.snakeCase(faker.words(faker.range(1, 2)))}.example`,
+			kind: changeCase.snakeCase(faker.word()),
+			url: faker.url(),
+			size: faker.range(500, 3000).toString(),
+			height: faker.range(500, 3000).toString(),
+			width: faker.range(500, 3000).toString(),
 		} as MockLinkToMediaValue<State>;
 	}
 };

package/src/value/number.ts

@@ -22,6 +22,6 @@ export const number = <
 	const faker = createFaker(config.seed);
 
 	return (
-		config.state === "empty" ? null : faker.datatype.number()
+		config.state === "empty" ? null : faker.range(1, 100)
 	) as MockNumberValue<State>;
 };

package/src/value/richText/embed.ts

@@ -10,8 +10,8 @@ type MockRichTextEmbedValueConfig = MockRichTextValueConfig;
 export const embed = (
 	config: MockRichTextEmbedValueConfig = {},
 ): prismicT.RTEmbedNode | undefined => {
-	const embedData = getMockEmbedData({ seed: config.seed });
-	const embedField = buildEmbedField({ seed: config.seed, embedData });
+	const data = getMockEmbedData({ seed: config.seed });
+	const embedField = buildEmbedField({ seed: config.seed, data });
 
 	return {
 		type: prismicT.RichTextNodeType.embed,

package/src/value/richText/heading.ts

@@ -63,25 +63,18 @@ export const heading = (
 				prismicT.RichTextNodeType.heading6,
 			].includes(type as RichTextNodeTitleType),
 		) as RichTextNodeTitleType[];
-	const type = faker.random.arrayElement(types);
+	const type = faker.randomElement(types);
 
 	if (type) {
 		const patternKey =
 			config.pattern ||
-			faker.random.arrayElement(
-				Object.keys(patterns) as (keyof typeof patterns)[],
-			);
+			faker.randomElement(Object.keys(patterns) as (keyof typeof patterns)[]);
 		const pattern = patterns[patternKey];
 
 		return {
 			type,
 			text: changeCase.capitalCase(
-				faker.lorem.words(
-					faker.datatype.number({
-						min: pattern.minWords,
-						max: pattern.maxWords,
-					}),
-				),
+				faker.words(faker.range(pattern.minWords, pattern.maxWords)),
 			),
 			spans: [],
 		};

package/src/value/richText/image.ts

@@ -14,16 +14,14 @@ export const image = (
 	const imageField = buildImageFieldImage({
 		seed: config.seed,
 		imageData,
-		state: false,
+		state: "filled",
 	});
 
 	return {
 		type: prismicT.RichTextNodeType.image,
 		alt: imageField.alt,
-		// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-		url: imageField.url!,
+		url: imageField.url,
 		copyright: imageField.copyright,
-		// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-		dimensions: imageField.dimensions!,
+		dimensions: imageField.dimensions,
 	};
 };

package/src/value/richText/index.ts

@@ -70,22 +70,17 @@ export const richText = (
 	if (types.length > 0) {
 		const patternKey =
 			config.pattern ||
-			faker.random.arrayElement(
-				Object.keys(patterns) as (keyof typeof patterns)[],
-			);
+			faker.randomElement(Object.keys(patterns) as (keyof typeof patterns)[]);
 		const pattern = patterns[patternKey];
 
 		const blockCount = supportsMultipleBlocks
-			? faker.datatype.number({
-					min: pattern.blockCountMin,
-					max: pattern.blockCountMax,
-			  })
+			? faker.range(pattern.blockCountMin, pattern.blockCountMax)
 			: 1;
 
 		return Array(blockCount)
 			.fill(undefined)
 			.map(() => {
-				const type = faker.random.arrayElement(types);
+				const type = faker.randomElement(types);
 				const generator = generators[type];
 
 				return generator({ seed: config.seed, model });

package/src/value/richText/list.ts

@@ -1,4 +1,5 @@
 import * as prismicT from "@prismicio/types";
+import * as changeCase from "change-case";
 
 import { createFaker } from "../../lib/createFaker";
 
@@ -30,22 +31,17 @@ export const list = (
 
 	const patternKey =
 		config.pattern ||
-		faker.random.arrayElement(
-			Object.keys(patterns) as (keyof typeof patterns)[],
-		);
+		faker.randomElement(Object.keys(patterns) as (keyof typeof patterns)[]);
 	const pattern = patterns[patternKey];
 
-	const itemsCount = faker.datatype.number({
-		min: pattern.minItems,
-		max: pattern.maxItems,
-	});
+	const itemsCount = faker.range(pattern.minItems, pattern.maxItems);
 
 	return Array(itemsCount)
 		.fill(undefined)
 		.map(() => {
 			return {
 				type: prismicT.RichTextNodeType.listItem,
-				text: faker.lorem.sentence(),
+				text: changeCase.sentenceCase(faker.words(faker.range(5, 15))),
 				spans: [],
 			};
 		});

package/src/value/richText/oList.ts

@@ -1,4 +1,5 @@
 import * as prismicT from "@prismicio/types";
+import * as changeCase from "change-case";
 
 import { createFaker } from "../../lib/createFaker";
 
@@ -30,22 +31,17 @@ export const oList = (
 
 	const patternKey =
 		config.pattern ||
-		faker.random.arrayElement(
-			Object.keys(patterns) as (keyof typeof patterns)[],
-		);
+		faker.randomElement(Object.keys(patterns) as (keyof typeof patterns)[]);
 	const pattern = patterns[patternKey];
 
-	const itemsCount = faker.datatype.number({
-		min: pattern.minItems,
-		max: pattern.maxItems,
-	});
+	const itemsCount = faker.range(pattern.minItems, pattern.maxItems);
 
 	return Array(itemsCount)
 		.fill(undefined)
 		.map(() => {
 			return {
 				type: prismicT.RichTextNodeType.oListItem,
-				text: faker.lorem.sentence(),
+				text: changeCase.sentenceCase(faker.words(faker.range(5, 15))),
 				spans: [],
 			};
 		});

package/src/value/richText/paragraph.ts

@@ -1,4 +1,5 @@
 import * as prismicT from "@prismicio/types";
+import * as changeCase from "change-case";
 
 import { createFaker } from "../../lib/createFaker";
 
@@ -27,14 +28,17 @@ export const paragraph = (
 
 	const patternKey =
 		config.pattern ||
-		faker.random.arrayElement(
-			Object.keys(patterns) as (keyof typeof patterns)[],
-		);
+		faker.randomElement(Object.keys(patterns) as (keyof typeof patterns)[]);
 	const pattern = patterns[patternKey];
 
+	const text = Array.from(
+		{ length: pattern.sentenceCount },
+		() => changeCase.sentenceCase(faker.words(faker.range(5, 15))) + ".",
+	).join(" ");
+
 	return {
 		type: prismicT.RichTextNodeType.paragraph,
-		text: faker.lorem.paragraph(pattern.sentenceCount),
+		text,
 		spans: [],
 	};
 };

package/src/value/richText/preformatted.ts

@@ -1,4 +1,5 @@
 import * as prismicT from "@prismicio/types";
+import * as changeCase from "change-case";
 
 import { createFaker } from "../../lib/createFaker";
 
@@ -27,15 +28,18 @@ export const preformatted = (
 
 	const patternKey =
 		config.pattern ||
-		faker.random.arrayElement(
-			Object.keys(patterns) as (keyof typeof patterns)[],
-		);
+		faker.randomElement(Object.keys(patterns) as (keyof typeof patterns)[]);
 	const pattern = patterns[patternKey];
 
+	// TODO: Use code, not lorem ipsum.
+	const text = Array.from(
+		{ length: pattern.sentenceCount },
+		() => changeCase.sentenceCase(faker.words(faker.range(5, 15))) + ".",
+	).join(" ");
+
 	return {
 		type: prismicT.RichTextNodeType.preformatted,
-		// TODO: Use code, not lorem ipsum.
-		text: faker.lorem.paragraph(pattern.sentenceCount),
+		text,
 		spans: [],
 	};
 };

package/src/value/select.ts

@@ -31,9 +31,9 @@ export const select = <
 		return null as MockSelectValue<Model, State>;
 	} else {
 		return (
-			typeof defaultValue === "string" && faker.datatype.boolean()
+			typeof defaultValue === "string" && faker.boolean()
 				? defaultValue
-				: faker.random.arrayElement(model.config.options)
+				: faker.randomElement(model.config.options)
 		) as MockSelectValue<Model, State>;
 	}
 };

package/src/value/sharedSlice.ts

@@ -26,7 +26,7 @@ export const sharedSlice = <
 	const faker = createFaker(config.seed);
 
 	const model = config.model || modelGen.sharedSlice({ seed: config.seed });
-	const variationModel = faker.random.arrayElement(model.variations);
+	const variationModel = faker.randomElement(model.variations);
 
 	return sharedSliceVariation({
 		seed: config.seed,

package/src/value/sharedSliceVariation.ts

@@ -35,18 +35,14 @@ export const sharedSliceVariation = <
 
 	const itemsCount =
 		Object.keys(model.items).length > 0
-			? config.itemsCount ??
-			  faker.datatype.number({
-					min: 1,
-					max: 6,
-			  })
+			? config.itemsCount ?? faker.range(1, 6)
 			: 0;
 
 	return {
 		slice_type: sliceType,
 		slice_label: null,
 		variation: model.id,
-		version: faker.git.shortSha(),
+		version: faker.hash(7),
 		primary: valueForModelMap({
 			seed: config.seed,
 			map: model.primary,

package/src/value/slice.ts

@@ -35,15 +35,11 @@ export const slice = <
 	const sliceLabel =
 		config.label !== undefined
 			? config.label
-			: changeCase.capitalCase(faker.company.bsNoun());
+			: changeCase.capitalCase(faker.words(faker.range(1, 2)));
 
 	const itemsCount =
 		Object.keys(model.repeat).length > 0
-			? config.itemsCount ??
-			  faker.datatype.number({
-					min: 1,
-					max: 6,
-			  })
+			? config.itemsCount ?? faker.range(1, 6)
 			: 0;
 
 	return {

package/src/value/sliceZone.ts

@@ -3,7 +3,7 @@ import * as prismicT from "@prismicio/types";
 import { createFaker } from "../lib/createFaker";
 import { ValueForModelMapConfigs } from "../lib/valueForModelMap";
 
-import { MockValueConfig, ModelValue } from "../types";
+import { MockValueConfig, MockValueStateConfig, ModelValue } from "../types";
 
 import * as modelGen from "../model";
 
@@ -12,72 +12,73 @@ import { sharedSlice } from "./sharedSlice";
 
 export type MockSliceZoneValueConfig<
 	Model extends prismicT.CustomTypeModelSliceZoneField = prismicT.CustomTypeModelSliceZoneField,
+	State extends prismicT.FieldState = prismicT.FieldState,
 > = {
 	sharedSliceModels?: prismicT.SharedSliceModel[];
-	itemsCount?: number;
+	itemsCount?: State extends "empty" ? 0 : number;
 	primaryFieldConfigs?: ValueForModelMapConfigs;
 	itemsFieldConfigs?: ValueForModelMapConfigs;
-} & MockValueConfig<Model>;
+} & MockValueConfig<Model> &
+	MockValueStateConfig<State>;
 
 export const sliceZone = <
 	Model extends prismicT.CustomTypeModelSliceZoneField = prismicT.CustomTypeModelSliceZoneField,
+	State extends prismicT.FieldState = prismicT.FieldState,
 >(
-	config: MockSliceZoneValueConfig<Model> = {},
-): ModelValue<Model> => {
-	const faker = createFaker(config.seed);
-
-	const model = config.model || modelGen.sliceZone({ seed: config.seed });
-
-	if (Object.keys(model.config.choices).length > 0) {
-		const itemsCount =
-			config.itemsCount ??
-			faker.datatype.number({
-				min: 1,
-				max: 6,
-			});
+	config: MockSliceZoneValueConfig<Model, State> = {},
+): ModelValue<Model, State> => {
+	if (config.state === "empty") {
+		return [] as ModelValue<Model, State>;
+	} else {
+		const faker = createFaker(config.seed);
 
-		return Array(itemsCount)
-			.fill(undefined)
-			.map(() => {
-				const choices = Object.entries(model.config.choices);
-				const [choiceType, choiceModel] = faker.random.arrayElement(choices);
+		const model = config.model || modelGen.sliceZone({ seed: config.seed });
 
-				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.range(1, 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.randomElement(choices);
 
-					case prismicT.CustomTypeModelSliceType.SharedSlice: {
-						const sharedSliceModel = config.sharedSliceModels?.find(
-							(sharedSliceModel) => sharedSliceModel.id === choiceType,
-						);
+					const choiceLabels = model.config.labels[choiceType] || [];
+					const choiceLabel = faker.randomElement(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>;
-	} else {
-		return [] as unknown as ModelValue<Model>;
+				})
+				.filter(
+					(slice): slice is NonNullable<typeof slice> => slice !== undefined,
+				) as ModelValue<Model, State>;
+		} else {
+			return [] as unknown as ModelValue<Model, State>;
+		}
 	}
 };