@prismicio/mock 0.0.7 → 0.0.8

package/src/model/integrationFields.ts

@@ -5,7 +5,9 @@ import { createFaker } from "../lib/createFaker";
 
 import { MockModelConfig } from "../types";
 
-export type MockIntegrationFieldsModelConfig = MockModelConfig;
+export type MockIntegrationFieldsModelConfig = {
+	catalog?: string;
+} & MockModelConfig;
 
 export const integrationFields = (
 	config: MockIntegrationFieldsModelConfig = {},
@@ -16,7 +18,7 @@ export const integrationFields = (
 		type: prismicT.CustomTypeModelFieldType.IntegrationFields,
 		config: {
 			label: changeCase.capitalCase(faker.company.bsNoun()),
-			catalog: changeCase.snakeCase(faker.lorem.words(4)),
+			catalog: config.catalog || changeCase.snakeCase(faker.lorem.words(4)),
 		},
 	};
 };

package/src/types.ts

@@ -10,8 +10,10 @@ export type IterableElement<TargetIterable> = TargetIterable extends Iterable<
 	? ElementType
 	: never;
 
-export type ValueOf<ObjectType extends Record<string, unknown>> =
-	ObjectType[string];
+export type ValueOf<
+	ObjectType,
+	ValueType extends keyof ObjectType = keyof ObjectType,
+> = ObjectType[ValueType];
 
 type Simplify<T> = { [KeyType in keyof T]: T[KeyType] };
 type Except<ObjectType, KeysType extends keyof ObjectType> = Pick<
@@ -74,40 +76,46 @@ export type MockValueStateConfig<
 	state?: State;
 };
 
-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 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
@@ -126,37 +134,43 @@ 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<
-				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>
-						: T["config"]["choices"][P] extends prismicT.CustomTypeModelSharedSlice
-						? prismicT.SharedSlice<P>
-						: never;
-				}>
-		  >
-		: 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<
@@ -171,43 +185,45 @@ type CustomTypeModelValue<T extends prismicT.CustomTypeModel> =
 
 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"]>>;
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = prismicT.GroupField<ModelValueMap<T["config"]["fields"]>, State>;
 
 type CustomTypeModelSliceValue<
 	T extends prismicT.CustomTypeModelSlice,

package/src/value/group.ts

@@ -6,40 +6,51 @@ 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,
+	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.datatype.number({
+				min: 1,
+				max: 6,
 			});
-		}) as ModelValue<Model>;
+
+		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/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,79 @@ 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.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>;
-	} else {
-		return [] as unknown as ModelValue<Model>;
+				})
+				.filter(
+					(slice): slice is prismicT.Slice | prismicT.SharedSlice =>
+						slice !== undefined,
+				) as ModelValue<Model, State>;
+		} else {
+			return [] as unknown as ModelValue<Model, State>;
+		}
 	}
 };

package/src/value/title.ts

@@ -1,24 +1,37 @@
 import * as prismicT from "@prismicio/types";
 
-import { MockValueConfig } from "../types";
+import { MockValueConfig, MockValueStateConfig } from "../types";
 
 import { heading, MockRichTextHeadingValueConfig } from "./richText/heading";
 
 export type MockTitleValueConfig<
 	Model extends prismicT.CustomTypeModelTitleField = prismicT.CustomTypeModelTitleField,
+	State extends prismicT.FieldState = prismicT.FieldState,
 > = {
 	pattern?: MockRichTextHeadingValueConfig["pattern"];
-} & MockValueConfig<Model>;
+} & MockValueConfig<Model> &
+	MockValueStateConfig<State>;
 
-export const title = (
-	config: MockTitleValueConfig = {},
-): prismicT.TitleField => {
-	return [
-		// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-		heading({
-			seed: config.seed,
-			model: config.model,
-			pattern: config.pattern,
-		})!,
-	] as prismicT.TitleField;
+export type MockTitleValue<
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = prismicT.TitleField<State>;
+
+export const title = <
+	Model extends prismicT.CustomTypeModelTitleField = prismicT.CustomTypeModelTitleField,
+	State extends prismicT.FieldState = prismicT.FieldState,
+>(
+	config: MockTitleValueConfig<Model, State> = {},
+): MockTitleValue<State> => {
+	if (config.state === "empty") {
+		return [] as MockTitleValue<State>;
+	} else {
+		return [
+			// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+			heading({
+				seed: config.seed,
+				model: config.model,
+				pattern: config.pattern,
+			})!,
+		] as MockTitleValue<State>;
+	}
 };