@prismicio/mock 0.0.6 → 0.0.9

package/src/model/sliceZone.ts

@@ -1,71 +1,35 @@
 import * as prismicT from "@prismicio/types";
-import * as changeCase from "change-case";
-
-import { createFaker } from "../lib/createFaker";
-import { generateFieldId } from "../lib/generateFieldId";
 
 import { MockModelConfig } from "../types";
 
-import { sharedSliceChoice } from "./sharedSliceChoice";
-import { slice } from "./slice";
-
-type MockSliceZoneModelConfig = (
-	| {
-			choices?: Record<
-				string,
-				prismicT.CustomTypeModelSlice | prismicT.CustomTypeModelSharedSlice
-			>;
-			choicesCount?: never;
-			withSharedSlices?: never;
-	  }
-	| {
-			choices?: never;
-			choicesCount?: number;
-			withSharedSlices?: boolean;
-	  }
-) &
-	MockModelConfig;
-
-export const sliceZone = (
-	config: MockSliceZoneModelConfig = {},
-): prismicT.CustomTypeModelSliceZoneField => {
-	const faker = createFaker(config.seed);
-
-	let choices: Record<
+type MockSliceZoneModelConfig<
+	Slices extends Record<
 		string,
 		prismicT.CustomTypeModelSlice | prismicT.CustomTypeModelSharedSlice
-	> = {};
-
-	if ("choices" in config) {
-		choices = config.choices || {};
-	} else {
-		const choicesCount =
-			config.choicesCount ?? faker.datatype.number({ min: 2, max: 6 });
-
-		for (let i = 0; i < choicesCount; i++) {
-			const choiceId = generateFieldId({ seed: config.seed });
+	> = Record<
+		string,
+		prismicT.CustomTypeModelSlice | prismicT.CustomTypeModelSharedSlice
+	>,
+> = {
+	choices?: Slices;
+} & MockModelConfig;
 
-			choices[choiceId] = config.withSharedSlices
-				? sharedSliceChoice()
-				: slice({ seed: config.seed });
-		}
-	}
+export const sliceZone = <
+	Slices extends Record<
+		string,
+		prismicT.CustomTypeModelSlice | prismicT.CustomTypeModelSharedSlice
+	>,
+>(
+	config: MockSliceZoneModelConfig<Slices> = {},
+): prismicT.CustomTypeModelSliceZoneField<Slices> => {
+	const labels =
+		{} as prismicT.CustomTypeModelSliceZoneField<Slices>["config"]["labels"];
 
-	const labels: Record<string, prismicT.CustomTypeModelSliceLabel[]> = {};
-	for (const choiceId in choices) {
-		const choice = choices[choiceId];
+	for (const choiceId in config.choices) {
+		const choice = config.choices[choiceId];
 
 		if (choice.type === prismicT.CustomTypeModelSliceType.Slice) {
-			const labelsCount = faker.datatype.number({ min: 0, max: 3 });
-
-			labels[choiceId] = Array(labelsCount)
-				.fill(undefined)
-				.map(() => ({
-					name: changeCase.capitalCase(faker.company.bsNoun()),
-					display: faker.datatype.boolean()
-						? prismicT.CustomTypeModelSliceDisplay.Grid
-						: prismicT.CustomTypeModelSliceDisplay.List,
-				}));
+			labels[choiceId as unknown as keyof typeof labels] = [];
 		}
 	}
 
@@ -74,7 +38,7 @@ export const sliceZone = (
 		fieldset: "Slice zone",
 		config: {
 			labels,
-			choices,
+			choices: config.choices || ({} as Slices),
 		},
 	};
 };

package/src/model/timestamp.ts

@@ -15,8 +15,8 @@ export const timestamp = (
 	return {
 		type: prismicT.CustomTypeModelFieldType.Timestamp,
 		config: {
-			label: changeCase.capitalCase(faker.company.bsNoun()),
-			placeholder: changeCase.sentenceCase(faker.lorem.words(3)),
+			label: changeCase.capitalCase(faker.word()),
+			placeholder: changeCase.sentenceCase(faker.words(3)),
 		},
 	};
 };

package/src/model/title.ts

@@ -12,8 +12,8 @@ export const title = (
 ): prismicT.CustomTypeModelTitleField => {
 	const faker = createFaker(config.seed);
 
-	const single = faker.random
-		.arrayElements([
+	const single = faker
+		.randomElements([
 			"heading1",
 			"heading2",
 			"heading3",
@@ -26,10 +26,10 @@ export const title = (
 	return {
 		type: prismicT.CustomTypeModelFieldType.StructuredText,
 		config: {
-			label: changeCase.capitalCase(faker.company.bsNoun()),
-			placeholder: changeCase.sentenceCase(faker.lorem.words(3)),
+			label: changeCase.capitalCase(faker.word()),
+			placeholder: changeCase.sentenceCase(faker.words(3)),
 			single,
-			allowTargetBlank: faker.datatype.boolean() ? true : undefined,
+			allowTargetBlank: faker.boolean() || undefined,
 		},
 	};
 };

package/src/model/uid.ts

@@ -15,8 +15,8 @@ export const uid = (
 	return {
 		type: prismicT.CustomTypeModelFieldType.UID,
 		config: {
-			label: changeCase.capitalCase(faker.company.bsNoun()),
-			placeholder: changeCase.sentenceCase(faker.lorem.words(3)),
+			label: changeCase.capitalCase(faker.word()),
+			placeholder: changeCase.sentenceCase(faker.words(3)),
 		},
 	};
 };

package/src/types.ts

@@ -27,7 +27,7 @@ export type SetRequired<BaseType, Keys extends keyof BaseType> = Simplify<
 		Required<Pick<BaseType, Keys>>
 >;
 
-export type Seed = string | number | number[];
+export type Seed = string | number;
 
 export interface MockImageData {
 	url: string;
@@ -35,14 +35,11 @@ export interface MockImageData {
 	height: number;
 }
 
-export interface MockEmbedData {
-	url: string;
-	embed_url: string;
-	html: string;
-	thumbnail_url: string | null;
-	thumbnail_height: number | null;
-	thumbnail_width: number | null;
-}
+export type MockEmbedData = prismicT.AnyOEmbed &
+	prismicT.OEmbedExtra & {
+		embed_url: string;
+		html: string;
+	};
 
 export type MockRestApiConfig = {
 	seed?: Seed;
@@ -60,45 +57,62 @@ export type PrismicModel =
 	| prismicT.SharedSliceModel
 	| prismicT.SharedSliceModelVariation;
 
+export type GroupFieldModelMap = Record<
+	string,
+	prismicT.CustomTypeModelFieldForGroup
+>;
+
 export type MockValueConfig<Model extends PrismicModel = PrismicModel> = {
 	seed?: Seed;
 	model?: Model;
 };
 
-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 MockValueStateConfig<
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = {
+	state?: State;
+};
+
+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, prismicT.AnyOEmbed, 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
@@ -117,77 +131,105 @@ 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
-		: 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<ModelValueMap<ValueOf<T["json"]>>>;
+	prismicT.PrismicDocument<
+		ModelValueMap<{
+			[P in keyof ValueOf<T["json"]> as ValueOf<
+				T["json"]
+			>[P]["type"] extends typeof prismicT.CustomTypeModelFieldType.UID
+				? never
+				: P]: ValueOf<T["json"]>[P];
+		}>
+	>;
 
 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"]>>;
-
-type CustomTypeModelSliceValue<T extends prismicT.CustomTypeModelSlice> =
-	prismicT.Slice<
-		string,
-		ModelValueMap<T["non-repeat"]>,
-		ModelValueMap<T["repeat"]>
-	>;
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = prismicT.GroupField<ModelValueMap<T["config"]["fields"]>, State>;
+
+type CustomTypeModelSliceValue<
+	T extends prismicT.CustomTypeModelSlice,
+	SliceType = string,
+> = prismicT.Slice<
+	SliceType,
+	ModelValueMap<T["non-repeat"]>,
+	ModelValueMap<T["repeat"]>
+>;
 
 type SharedSliceModelValue<T extends prismicT.SharedSliceModel> =
 	prismicT.SharedSlice<

package/src/value/boolean.ts

@@ -15,5 +15,5 @@ export const boolean = <
 ): prismicT.BooleanField => {
 	const faker = createFaker(config.seed);
 
-	return faker.datatype.boolean();
+	return faker.boolean();
 };

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.hexColor().toUpperCase()
+	) as MockColorValue<State>;
 };

package/src/value/contentRelationship.ts

@@ -5,81 +5,96 @@ 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 }),
 						type: model.config.customtypes
-							? faker.random.arrayElement(model.config.customtypes)
+							? faker.randomElement(model.config.customtypes)
 							: generateCustomTypeId({ seed: config.seed }),
 						tags: model.config.tags
-							? faker.random.arrayElements(model.config.tags)
+							? faker.randomElements(model.config.tags)
 							: generateTags({ seed: config.seed }),
-					},
+					} as prismicT.PrismicDocument<
+						never,
+						NonNullable<Model["config"]["customtypes"]>[number]
+					>,
 			  ];
 
-		const document = faker.random.arrayElement(linkableDocuments);
+		const document = faker.randomElement(linkableDocuments);
 
 		if (!document) {
 			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/customType.ts

@@ -63,11 +63,11 @@ export const customType = <
 
 	return {
 		type: model.id,
-		id: faker.git.shortSha(),
-		uid: hasUID ? changeCase.snakeCase(faker.lorem.words(2)) : null,
-		url: withURL ? faker.internet.url() : null,
-		href: faker.internet.url(),
-		lang: faker.lorem.word(),
+		id: faker.hash(7),
+		uid: hasUID ? changeCase.snakeCase(faker.words(faker.range(1, 3))) : null,
+		url: withURL ? faker.url() : null,
+		href: faker.url(),
+		lang: faker.word(),
 		tags: generateTags({ seed: config.seed }),
 		slugs: [] as prismicT.PrismicDocument["slugs"],
 		linked_documents: [] as prismicT.PrismicDocument["linked_documents"],