@prismicio/mock 0.0.10 → 0.1.0

package/src/model/image.ts

@@ -5,15 +5,15 @@ import { createFaker } from "../lib/createFaker";
 
 import { MockModelConfig } from "../types";
 
-type MockImageModelConfig<ThumbnailNames extends string = string> = {
+export type MockImageModelConfig<ThumbnailNames extends string = string> = {
 	withConstraint?: boolean;
 	thumbnailNames?: readonly ThumbnailNames[];
 } & MockModelConfig;
 
 export const image = <ThumbnailNames extends string = string>(
-	config: MockImageModelConfig<ThumbnailNames> = {},
+	config: MockImageModelConfig<ThumbnailNames>,
 ): prismicT.CustomTypeModelImageField<ThumbnailNames> => {
-	const faker = createFaker(config.seed);
+	const faker = config.faker || createFaker(config.seed);
 
 	const thumbnails = (config.thumbnailNames || []).map((name) => {
 		return {

package/src/model/index.ts

@@ -24,3 +24,5 @@ export { title } from "./title";
 export { uid } from "./uid";
 
 export { buildMockGroupFieldMap } from "./buildMockGroupFieldMap";
+
+export { createModelMockFactory as createModelFactory } from "./createModelMockFactory";

package/src/model/integrationFields.ts

@@ -10,9 +10,9 @@ export type MockIntegrationFieldsModelConfig = {
 } & MockModelConfig;
 
 export const integrationFields = (
-	config: MockIntegrationFieldsModelConfig = {},
+	config: MockIntegrationFieldsModelConfig,
 ): prismicT.CustomTypeModelIntegrationFieldsField => {
-	const faker = createFaker(config.seed);
+	const faker = config.faker || createFaker(config.seed);
 
 	return {
 		type: prismicT.CustomTypeModelFieldType.IntegrationFields,

package/src/model/keyText.ts

@@ -8,9 +8,9 @@ import { MockModelConfig } from "../types";
 export type MockKeyTextModelConfig = MockModelConfig;
 
 export const keyText = (
-	config: MockKeyTextModelConfig = {},
+	config: MockKeyTextModelConfig,
 ): prismicT.CustomTypeModelKeyTextField => {
-	const faker = createFaker(config.seed);
+	const faker = config.faker || createFaker(config.seed);
 
 	return {
 		type: prismicT.CustomTypeModelFieldType.Text,

package/src/model/link.ts

@@ -5,7 +5,7 @@ import { createFaker } from "../lib/createFaker";
 
 import { MockModelConfig } from "../types";
 
-type MockLinkModel<AllowTargetBlank extends boolean = boolean> =
+export type MockLinkModel<AllowTargetBlank extends boolean = boolean> =
 	prismicT.CustomTypeModelLinkField & {
 		config: AllowTargetBlank extends true
 			? {
@@ -21,9 +21,9 @@ export type MockLinkModelConfig<AllowTargetBlank extends boolean = boolean> = {
 } & MockModelConfig;
 
 export const link = <AllowTargetBlank extends boolean = boolean>(
-	config: MockLinkModelConfig<AllowTargetBlank> = {},
+	config: MockLinkModelConfig<AllowTargetBlank>,
 ): MockLinkModel<AllowTargetBlank> => {
-	const faker = createFaker(config.seed);
+	const faker = config.faker || createFaker(config.seed);
 
 	return {
 		type: prismicT.CustomTypeModelFieldType.Link,

package/src/model/linkToMedia.ts

@@ -5,12 +5,12 @@ import { createFaker } from "../lib/createFaker";
 
 import { MockModelConfig } from "../types";
 
-export type MockLinkTomediaModelConfig = MockModelConfig;
+export type MockLinkToMediaModelConfig = MockModelConfig;
 
 export const linkToMedia = (
-	config: MockLinkTomediaModelConfig = {},
+	config: MockLinkToMediaModelConfig,
 ): prismicT.CustomTypeModelLinkToMediaField => {
-	const faker = createFaker(config.seed);
+	const faker = config.faker || createFaker(config.seed);
 
 	return {
 		type: prismicT.CustomTypeModelFieldType.Link,

package/src/model/number.ts

@@ -8,9 +8,9 @@ import { MockModelConfig } from "../types";
 export type MockNumberModelConfig = MockModelConfig;
 
 export const number = (
-	config: MockNumberModelConfig = {},
+	config: MockNumberModelConfig,
 ): prismicT.CustomTypeModelNumberField => {
-	const faker = createFaker(config.seed);
+	const faker = config.faker || createFaker(config.seed);
 
 	return {
 		type: prismicT.CustomTypeModelFieldType.Number,

package/src/model/richText.ts

@@ -12,11 +12,11 @@ export type MockRichTextModelConfig<
 } & MockModelConfig;
 
 export const richText = <WithMultipleBlocks extends boolean = boolean>(
-	config: MockRichTextModelConfig<WithMultipleBlocks> = {},
+	config: MockRichTextModelConfig<WithMultipleBlocks>,
 ): WithMultipleBlocks extends true
 	? prismicT.CustomTypeModelRichTextMultiField
 	: prismicT.CustomTypeModelRichTextSingleField => {
-	const faker = createFaker(config.seed);
+	const faker = config.faker || createFaker(config.seed);
 
 	const blockTypes = faker
 		.randomElements([

package/src/model/select.ts

@@ -5,7 +5,7 @@ import { createFaker } from "../lib/createFaker";
 
 import { MockModelConfig } from "../types";
 
-type MockSelectModelConfig<
+export type MockSelectModelConfig<
 	Option extends string = string,
 	DefaultOption extends Option = Option,
 > = {
@@ -14,9 +14,9 @@ type MockSelectModelConfig<
 } & MockModelConfig;
 
 export const select = <Option extends string, DefaultOption extends Option>(
-	config: MockSelectModelConfig<Option, DefaultOption> = {},
+	config: MockSelectModelConfig<Option, DefaultOption>,
 ): prismicT.CustomTypeModelSelectField<Option, DefaultOption> => {
-	const faker = createFaker(config.seed);
+	const faker = config.faker || createFaker(config.seed);
 
 	return {
 		type: prismicT.CustomTypeModelFieldType.Select,

package/src/model/sharedSlice.ts

@@ -5,7 +5,7 @@ import { createFaker } from "../lib/createFaker";
 
 import { MockModelConfig } from "../types";
 
-type MockSharedSliceModelConfig<
+export type MockSharedSliceModelConfig<
 	Variation extends prismicT.SharedSliceModelVariation,
 > = {
 	id?: string;
@@ -16,9 +16,9 @@ type MockSharedSliceModelConfig<
 export const sharedSlice = <
 	Variation extends prismicT.SharedSliceModelVariation,
 >(
-	config: MockSharedSliceModelConfig<Variation> = {},
+	config: MockSharedSliceModelConfig<Variation>,
 ): prismicT.SharedSliceModel<string, Variation> => {
-	const faker = createFaker(config.seed);
+	const faker = config.faker || createFaker(config.seed);
 
 	let name: string =
 		config.name || changeCase.capitalCase(faker.words(faker.range(1, 2)));

package/src/model/sharedSliceVariation.ts

@@ -2,6 +2,7 @@ import * as prismicT from "@prismicio/types";
 import * as changeCase from "change-case";
 
 import { createFaker } from "../lib/createFaker";
+import { getMockImageData } from "../lib/getMockImageData";
 
 import { GroupFieldModelMap, MockModelConfig } from "../types";
 
@@ -21,13 +22,9 @@ export const sharedSliceVariation = <
 	PrimaryFields extends GroupFieldModelMap,
 	ItemsFields extends GroupFieldModelMap,
 >(
-	config: MockSharedSliceVariationModelConfig<
-		ID,
-		PrimaryFields,
-		ItemsFields
-	> = {},
+	config: MockSharedSliceVariationModelConfig<ID, PrimaryFields, ItemsFields>,
 ): prismicT.SharedSliceModelVariation<ID, PrimaryFields, ItemsFields> => {
-	const faker = createFaker(config.seed);
+	const faker = config.faker || createFaker(config.seed);
 
 	let name: string =
 		config.name || changeCase.capitalCase(faker.words(faker.range(1, 2)));
@@ -39,6 +36,8 @@ export const sharedSliceVariation = <
 		id = changeCase.snakeCase(config.name) as ID;
 	}
 
+	const imageData = getMockImageData({ faker });
+
 	return {
 		id,
 		name,
@@ -47,5 +46,6 @@ export const sharedSliceVariation = <
 		version: faker.hash(7),
 		primary: config.primaryFields || ({} as PrimaryFields),
 		items: config.itemsFields || ({} as ItemsFields),
+		imageUrl: imageData.url,
 	};
 };

package/src/model/slice.ts

@@ -5,7 +5,7 @@ import { createFaker } from "../lib/createFaker";
 
 import { GroupFieldModelMap, MockModelConfig } from "../types";
 
-type MockSliceModelConfig<
+export type MockSliceModelConfig<
 	NonRepeatFields extends GroupFieldModelMap = GroupFieldModelMap,
 	RepeatFields extends GroupFieldModelMap = GroupFieldModelMap,
 > = {
@@ -17,9 +17,9 @@ export const slice = <
 	NonRepeatFields extends GroupFieldModelMap,
 	RepeatFields extends GroupFieldModelMap,
 >(
-	config: MockSliceModelConfig<NonRepeatFields, RepeatFields> = {},
+	config: MockSliceModelConfig<NonRepeatFields, RepeatFields>,
 ): prismicT.CustomTypeModelSlice<NonRepeatFields, RepeatFields> => {
-	const faker = createFaker(config.seed);
+	const faker = config.faker || createFaker(config.seed);
 
 	return {
 		type: prismicT.CustomTypeModelSliceType.Slice,

package/src/model/sliceZone.ts

@@ -2,7 +2,7 @@ import * as prismicT from "@prismicio/types";
 
 import { MockModelConfig } from "../types";
 
-type MockSliceZoneModelConfig<
+export type MockSliceZoneModelConfig<
 	Slices extends Record<
 		string,
 		prismicT.CustomTypeModelSlice | prismicT.CustomTypeModelSharedSlice
@@ -20,10 +20,13 @@ export const sliceZone = <
 		prismicT.CustomTypeModelSlice | prismicT.CustomTypeModelSharedSlice
 	>,
 >(
-	config: MockSliceZoneModelConfig<Slices> = {},
+	config: MockSliceZoneModelConfig<Slices>,
 ): prismicT.CustomTypeModelSliceZoneField<Slices> => {
-	const labels =
-		{} as prismicT.CustomTypeModelSliceZoneField<Slices>["config"]["labels"];
+	const labels = {} as NonNullable<
+		NonNullable<
+			prismicT.CustomTypeModelSliceZoneField<Slices>["config"]
+		>["labels"]
+	>;
 
 	for (const choiceId in config.choices) {
 		const choice = config.choices[choiceId];

package/src/model/timestamp.ts

@@ -8,9 +8,9 @@ import { MockModelConfig } from "../types";
 export type MockTimestampModelConfig = MockModelConfig;
 
 export const timestamp = (
-	config: MockTimestampModelConfig = {},
+	config: MockTimestampModelConfig,
 ): prismicT.CustomTypeModelTimestampField => {
-	const faker = createFaker(config.seed);
+	const faker = config.faker || createFaker(config.seed);
 
 	return {
 		type: prismicT.CustomTypeModelFieldType.Timestamp,

package/src/model/title.ts

@@ -8,9 +8,9 @@ import { MockModelConfig } from "../types";
 export type MockTitleModelConfig = MockModelConfig;
 
 export const title = (
-	config: MockTitleModelConfig = {},
+	config: MockTitleModelConfig,
 ): prismicT.CustomTypeModelTitleField => {
-	const faker = createFaker(config.seed);
+	const faker = config.faker || createFaker(config.seed);
 
 	const single = faker
 		.randomElements([

package/src/model/uid.ts

@@ -8,9 +8,9 @@ import { MockModelConfig } from "../types";
 export type MockUIDModelConfig = MockModelConfig;
 
 export const uid = (
-	config: MockUIDModelConfig = {},
+	config: MockUIDModelConfig,
 ): prismicT.CustomTypeModelUIDField => {
-	const faker = createFaker(config.seed);
+	const faker = config.faker || createFaker(config.seed);
 
 	return {
 		type: prismicT.CustomTypeModelFieldType.UID,

package/src/types.ts

@@ -1,4 +1,5 @@
 import * as prismicT from "@prismicio/types";
+import { Faker } from "./lib/createFaker";
 
 import * as value from "./value";
 
@@ -29,6 +30,10 @@ export type SetRequired<BaseType, Keys extends keyof BaseType> = Simplify<
 
 export type Seed = string | number;
 
+export type WithoutFakerConfig<T> = {
+	[P in keyof T as P extends "seed" | "faker" ? never : P]: T[P];
+};
+
 export interface MockImageData {
 	url: string;
 	width: number;
@@ -41,13 +46,25 @@ export type MockEmbedData = prismicT.AnyOEmbed &
 		html: string;
 	};
 
-export type MockRestApiConfig = {
-	seed?: Seed;
-};
+export type MockRestApiConfig =
+	| {
+			seed: Seed;
+			faker?: never;
+	  }
+	| {
+			faker: Faker;
+			seed?: never;
+	  };
 
-export type MockModelConfig = {
-	seed?: Seed;
-};
+export type MockModelConfig =
+	| {
+			seed: Seed;
+			faker?: never;
+	  }
+	| {
+			faker: Faker;
+			seed?: never;
+	  };
 
 // TODO: Add to @prismicio/types
 export type PrismicModel =
@@ -63,9 +80,17 @@ export type GroupFieldModelMap = Record<
 >;
 
 export type MockValueConfig<Model extends PrismicModel = PrismicModel> = {
-	seed?: Seed;
 	model?: Model;
-};
+} & (
+	| {
+			seed: Seed;
+			faker?: never;
+	  }
+	| {
+			faker: Faker;
+			seed?: never;
+	  }
+);
 
 export type MockValueStateConfig<
 	State extends prismicT.FieldState = prismicT.FieldState,
@@ -121,9 +146,17 @@ type CustomTypeModelStructuredTextField =
 export type MockRichTextValueConfig<
 	Model extends CustomTypeModelStructuredTextField = CustomTypeModelStructuredTextField,
 > = {
-	seed?: Seed;
 	model?: Model;
-};
+} & (
+	| {
+			seed: Seed;
+			faker?: never;
+	  }
+	| {
+			faker: Faker;
+			seed?: never;
+	  }
+);
 
 export type ModelValueMap<
 	T extends Record<string, prismicT.CustomTypeModelField>,
@@ -145,14 +178,18 @@ export type ModelValue<
 	: T extends prismicT.CustomTypeModelSliceZoneField
 	? prismicT.SliceZone<
 			ValueOf<{
-				[P in keyof T["config"]["choices"] as P extends string
+				[P in keyof NonNullable<T["config"]>["choices"] as P extends string
 					? P
-					: never]: T["config"]["choices"][P] extends prismicT.CustomTypeModelSlice
+					: never]: NonNullable<
+					T["config"]
+				>["choices"][P] extends prismicT.CustomTypeModelSlice
 					? CustomTypeModelSliceValue<
-							T["config"]["choices"][P],
+							NonNullable<T["config"]>["choices"][P],
 							P extends string ? P : string
 					  >
-					: T["config"]["choices"][P] extends prismicT.CustomTypeModelSharedSlice
+					: NonNullable<
+							T["config"]
+					  >["choices"][P] extends prismicT.CustomTypeModelSharedSlice
 					? prismicT.SharedSlice<P extends string ? P : string>
 					: never;
 			}>,
@@ -214,27 +251,32 @@ type CustomTypeModelFieldForGroupValue<
 	: T extends prismicT.CustomTypeModelGeoPointField
 	? prismicT.GeoPointField<State>
 	: T extends prismicT.CustomTypeModelIntegrationFieldsField
-	? prismicT.IntegrationFields<unknown, State>
+	? prismicT.IntegrationFields<Record<string, unknown>, State>
 	: never;
 
 type CustomTypeModelGroupFieldValue<
 	T extends prismicT.CustomTypeModelGroupField,
 	State extends prismicT.FieldState = prismicT.FieldState,
-> = prismicT.GroupField<ModelValueMap<T["config"]["fields"]>, State>;
+> = prismicT.GroupField<
+	ModelValueMap<NonNullable<NonNullable<T["config"]>["fields"]>>,
+	State
+>;
 
 type CustomTypeModelSliceValue<
 	T extends prismicT.CustomTypeModelSlice,
 	SliceType = string,
 > = prismicT.Slice<
 	SliceType,
-	ModelValueMap<T["non-repeat"]>,
-	ModelValueMap<T["repeat"]>
+	ModelValueMap<NonNullable<T["non-repeat"]>>,
+	ModelValueMap<NonNullable<T["repeat"]>>
 >;
 
 type SharedSliceModelValue<T extends prismicT.SharedSliceModel> =
 	prismicT.SharedSlice<
 		T["id"],
-		SharedSliceModelVariationValue<IterableElement<T["variations"]>>
+		SharedSliceModelVariationValue<
+			IterableElement<NonNullable<T["variations"]>>
+		>
 	>;
 
 type SharedSliceModelVariationValue<
@@ -243,7 +285,7 @@ type SharedSliceModelVariationValue<
 	string,
 	prismicT.SharedSliceVariation<
 		T["id"],
-		ModelValueMap<T["primary"]>,
-		ModelValueMap<T["items"]>
+		ModelValueMap<NonNullable<T["primary"]>>,
+		ModelValueMap<NonNullable<T["items"]>>
 	>
 >;

package/src/value/boolean.ts

@@ -8,12 +8,10 @@ export type MockBooleanValueConfig<
 	Model extends prismicT.CustomTypeModelBooleanField = prismicT.CustomTypeModelBooleanField,
 > = MockValueConfig<Model>;
 
-export const boolean = <
-	Model extends prismicT.CustomTypeModelBooleanField = prismicT.CustomTypeModelBooleanField,
->(
-	config: MockBooleanValueConfig<Model> = {},
+export const boolean = <Model extends prismicT.CustomTypeModelBooleanField>(
+	config: MockBooleanValueConfig<Model>,
 ): prismicT.BooleanField => {
-	const faker = createFaker(config.seed);
+	const faker = config.faker || createFaker(config.seed);
 
 	return faker.boolean();
 };

package/src/value/color.ts

@@ -17,9 +17,9 @@ export const color = <
 	Model extends prismicT.CustomTypeModelColorField = prismicT.CustomTypeModelColorField,
 	State extends prismicT.FieldState = "filled",
 >(
-	config: MockColorValueConfig<Model, State> = {},
+	config: MockColorValueConfig<Model, State>,
 ): MockColorValue<State> => {
-	const faker = createFaker(config.seed);
+	const faker = config.faker || createFaker(config.seed);
 
 	return (
 		config.state === "empty" ? null : faker.hexColor().toUpperCase()

package/src/value/contentRelationship.ts

@@ -5,7 +5,11 @@ import { createFaker } from "../lib/createFaker";
 import { generateCustomTypeId } from "../lib/generateCustomTypeId";
 import { generateTags } from "../lib/generateTags";
 
-import { MockValueStateConfig, MockValueConfig } from "../types";
+import {
+	MockValueStateConfig,
+	MockValueConfig,
+	IterableElement,
+} from "../types";
 
 import * as modelGen from "../model";
 
@@ -26,7 +30,7 @@ type MockContentRelationshipValue<
 	Model extends prismicT.CustomTypeModelContentRelationshipField = prismicT.CustomTypeModelContentRelationshipField,
 	State extends prismicT.FieldState = prismicT.FieldState,
 > = prismicT.RelationField<
-	Model["config"]["customtypes"],
+	IterableElement<NonNullable<Model["config"]>["customtypes"]>,
 	string,
 	never,
 	State
@@ -36,17 +40,16 @@ export const contentRelationship = <
 	Model extends prismicT.CustomTypeModelContentRelationshipField = prismicT.CustomTypeModelContentRelationshipField,
 	State extends prismicT.FieldState = "filled",
 >(
-	config: MockContentRelationshipValueConfig<Model, State> = {},
+	config: MockContentRelationshipValueConfig<Model, State>,
 ): MockContentRelationshipValue<Model, State> => {
-	const faker = createFaker(config.seed);
+	const faker = config.faker || createFaker(config.seed);
 
 	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 model = config.model || modelGen.contentRelationship({ faker });
 
 		const linkableDocuments = config.linkableDocuments
 			? config.linkableDocuments.filter(
@@ -54,16 +57,16 @@ export const contentRelationship = <
 						document,
 					): document is prismicT.PrismicDocument<
 						never,
-						NonNullable<Model["config"]["customtypes"]>[number]
+						NonNullable<NonNullable<Model["config"]>["customtypes"]>[number]
 					> => {
 						let shouldKeep = true;
 
-						if (model.config.customtypes) {
+						if (model.config?.customtypes) {
 							shouldKeep =
 								shouldKeep && model.config.customtypes.includes(document.type);
 						}
 
-						if (model.config.tags) {
+						if (model.config?.tags) {
 							shouldKeep =
 								shouldKeep &&
 								model.config.tags.some((tag) => document.tags.includes(tag));
@@ -74,16 +77,16 @@ export const contentRelationship = <
 			  )
 			: [
 					{
-						...documentGen({ seed: config.seed }),
-						type: model.config.customtypes
+						...documentGen({ faker }),
+						type: model.config?.customtypes
 							? faker.randomElement(model.config.customtypes)
-							: generateCustomTypeId({ seed: config.seed }),
-						tags: model.config.tags
+							: generateCustomTypeId({ faker }),
+						tags: model.config?.tags
 							? faker.randomElements(model.config.tags)
-							: generateTags({ seed: config.seed }),
+							: generateTags({ faker }),
 					} as prismicT.PrismicDocument<
 						never,
-						NonNullable<Model["config"]["customtypes"]>[number]
+						NonNullable<NonNullable<Model["config"]>["customtypes"]>[number]
 					>,
 			  ];