@prismicio/mock 0.0.3 → 0.0.7

package/src/lib/buildImageFieldImage.ts

@@ -0,0 +1,48 @@
+import * as prismicT from "@prismicio/types";
+
+import { createFaker } from "../lib/createFaker";
+
+import { MockValueStateConfig, MockImageData, MockValueConfig } from "../types";
+
+type BuildImageFieldConfig<
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = {
+	imageData: MockImageData;
+	constraint?: prismicT.CustomTypeModelImageField["config"]["constraint"];
+} & Pick<MockValueConfig, "seed"> &
+	Pick<MockValueStateConfig<State>, "state">;
+
+export const buildImageFieldImage = <
+	State extends prismicT.FieldState = prismicT.FieldState,
+>(
+	config: BuildImageFieldConfig<State>,
+): prismicT.ImageFieldImage<State> => {
+	if (config.state === "empty") {
+		return {
+			url: null,
+			dimensions: null,
+			alt: null,
+			copyright: null,
+		} as prismicT.ImageFieldImage<State>;
+	} else {
+		const faker = createFaker(config.seed);
+
+		const url = new URL(config.imageData.url);
+
+		const dimensions = {
+			width: config.constraint?.width ?? config.imageData.width,
+			height: config.constraint?.height ?? config.imageData.height,
+		};
+
+		url.searchParams.set("w", dimensions.width.toString());
+		url.searchParams.set("h", dimensions.height.toString());
+		url.searchParams.set("fit", "crop");
+
+		return {
+			url: url.toString(),
+			dimensions,
+			alt: faker.lorem.sentence(),
+			copyright: faker.lorem.sentence(),
+		} as prismicT.ImageFieldImage<State>;
+	}
+};

package/src/lib/createFaker.ts

@@ -1,22 +1,31 @@
 import * as fakerStatic from "faker";
 // @ts-expect-error - Missing .d.ts
-import * as fakerLocaleEN from "faker/lib/locales/en";
+import * as fakerLocaleEN from "faker/lib/locales/en/index.js";
 // @ts-expect-error - Missing .d.ts
-import Faker from "faker/lib";
+import Faker from "faker/lib/index.js";
 
 import { FAKER_SEED } from "../constants";
 
 export const createFaker = (seed = FAKER_SEED): typeof fakerStatic => {
-	if (createFaker.cache[seed]) {
-		return createFaker.cache[seed];
+	let normalizedSeed: number | number[];
+	if (typeof seed === "string") {
+		normalizedSeed = seed.split("").map((char) => char.charCodeAt(0));
+	} else {
+		normalizedSeed = seed;
 	}
 
-	const seededFaker = new Faker();
-	seededFaker.seed(seed);
-	seededFaker.locales["en"] = fakerLocaleEN;
+	const cacheKey = JSON.stringify(normalizedSeed);
 
-	createFaker.cache[seed] = seededFaker;
+	if (createFaker.cache[cacheKey]) {
+		return createFaker.cache[cacheKey];
+	}
+
+	const fakerInstance = new Faker();
+	fakerInstance.locales["en"] = fakerLocaleEN;
+	fakerInstance.seed(normalizedSeed);
+
+	createFaker.cache[cacheKey] = fakerInstance;
 
-	return seededFaker;
+	return fakerInstance;
 };
-createFaker.cache = {} as Record<number, typeof fakerStatic>;
+createFaker.cache = {} as Record<string, typeof fakerStatic>;

package/src/lib/generateTags.ts

@@ -4,12 +4,20 @@ import { createFaker } from "../lib/createFaker";
 
 import { MockValueConfig } from "../types";
 
-type GenerateTagsConfig = Pick<MockValueConfig, "seed">;
+type GenerateTagsConfig = {
+	min?: number;
+	max?: number;
+} & Pick<MockValueConfig, "seed">;
 
 export const generateTags = (config: GenerateTagsConfig): string[] => {
 	const faker = createFaker(config.seed);
 
-	return Array(faker.datatype.number(2))
+	return Array(
+		faker.datatype.number({
+			min: config.min ?? 0,
+			max: config.max ?? 2,
+		}),
+	)
 		.fill(undefined)
 		.map(() =>
 			changeCase.capitalCase(

package/src/lib/valueForModelMap.ts

@@ -93,7 +93,7 @@ const getValueConfigType = <Model extends prismicT.CustomTypeModelField>(
 			return "integrationFields";
 
 		case prismicT.CustomTypeModelFieldType.Slices:
-			return "slices";
+			return "sliceZone";
 	}
 };
 
@@ -113,7 +113,7 @@ export type ValueForModelMapConfigs = {
 	number?: MockNumberValueConfig;
 	richText?: MockRichTextValueConfig;
 	select?: MockSelectValueConfig;
-	slices?: MockSliceZoneValueConfig;
+	sliceZone?: MockSliceZoneValueConfig;
 	timestamp?: MockTimestampValueConfig;
 	title?: MockTitleValueConfig;
 	uid?: MockUIDValueConfig;

package/src/model/buildMockGroupFieldMap.ts

@@ -0,0 +1,65 @@
+import { GroupFieldModelMap, MockModelConfig, ValueOf } from "../types";
+
+import { boolean } from "../model/boolean";
+import { color } from "../model/color";
+import { contentRelationship } from "../model/contentRelationship";
+import { date } from "../model/date";
+import { embed } from "../model/embed";
+import { geoPoint } from "../model/geoPoint";
+import { image } from "../model/image";
+import { integrationFields } from "../model/integrationFields";
+import { keyText } from "../model/keyText";
+import { link } from "../model/link";
+import { linkToMedia } from "../model/linkToMedia";
+import { number } from "../model/number";
+import { richText } from "../model/richText";
+import { select } from "../model/select";
+import { timestamp } from "../model/timestamp";
+import { title } from "../model/title";
+
+import { createFaker } from "../lib/createFaker";
+import { generateFieldId } from "../lib/generateFieldId";
+
+const mockModelFns = {
+	boolean,
+	color,
+	contentRelationship,
+	date,
+	embed,
+	geoPoint,
+	image,
+	integrationFields,
+	keyText,
+	link,
+	linkToMedia,
+	number,
+	richText,
+	select,
+	timestamp,
+	title,
+};
+
+export type BuildMockGroupFieldMapConfig = MockModelConfig;
+
+export const buildMockGroupFieldMap = (
+	config: BuildMockGroupFieldMapConfig = {},
+): GroupFieldModelMap => {
+	const faker = createFaker(config.seed);
+
+	const fields: GroupFieldModelMap = {};
+
+	const fieldTypes = faker.random.arrayElements(
+		Object.keys(mockModelFns) as (keyof typeof mockModelFns)[],
+	);
+
+	for (const fieldType of fieldTypes) {
+		const fieldId = generateFieldId({ seed: config.seed });
+		const mockModelFn = mockModelFns[fieldType] as (
+			config: MockModelConfig,
+		) => ValueOf<GroupFieldModelMap>;
+
+		fields[fieldId] = mockModelFn({ seed: config.seed });
+	}
+
+	return fields;
+};

package/src/model/contentRelationship.ts

@@ -2,18 +2,23 @@ import * as prismicT from "@prismicio/types";
 import * as changeCase from "change-case";
 
 import { createFaker } from "../lib/createFaker";
-import { generateCustomTypeId } from "../lib/generateCustomTypeId";
 
 import { MockModelConfig } from "../types";
 
-export type MockContentRelationshipModelConfig = {
-	constrainCustomTypes?: boolean;
-	constrainTags?: boolean;
+export type MockContentRelationshipModelConfig<
+	CustomTypeIDs extends string = string,
+	Tags extends string = string,
+> = {
+	customTypeIDs?: readonly CustomTypeIDs[];
+	tags?: readonly Tags[];
 } & MockModelConfig;
 
-export const contentRelationship = (
-	config: MockContentRelationshipModelConfig = {},
-): prismicT.CustomTypeModelContentRelationshipField => {
+export const contentRelationship = <
+	CustomTypeIDs extends string,
+	Tags extends string,
+>(
+	config: MockContentRelationshipModelConfig<CustomTypeIDs, Tags> = {},
+): prismicT.CustomTypeModelContentRelationshipField<CustomTypeIDs, Tags> => {
 	const faker = createFaker(config.seed);
 
 	return {
@@ -22,20 +27,8 @@ export const contentRelationship = (
 			label: changeCase.capitalCase(faker.company.bsNoun()),
 			placeholder: changeCase.sentenceCase(faker.lorem.words(3)),
 			select: prismicT.CustomTypeModelLinkSelectType.Document,
-			customtypes: config.constrainCustomTypes
-				? Array(faker.datatype.number({ min: 1, max: 3 }))
-						.fill(undefined)
-						.map(() => generateCustomTypeId({ seed: config.seed }))
-				: undefined,
-			tags: config.constrainTags
-				? Array(faker.datatype.number({ min: 1, max: 3 }))
-						.fill(undefined)
-						.map(() =>
-							changeCase.capitalCase(
-								faker.lorem.words(faker.datatype.number({ min: 1, max: 3 })),
-							),
-						)
-				: undefined,
+			customtypes: config.customTypeIDs,
+			tags: config.tags,
 		},
 	};
 };

package/src/model/customType.ts

@@ -1,74 +1,75 @@
 import * as prismicT from "@prismicio/types";
 import * as changeCase from "change-case";
 
-import {
-	buildMockGroupFieldMap,
-	BuildMockGroupFieldMapConfig,
-} from "../lib/buildMockGroupFieldMap";
 import { createFaker } from "../lib/createFaker";
-import { generateCustomTypeId } from "../lib/generateCustomTypeId";
-import { generateFieldId } from "../lib/generateFieldId";
 
 import { MockModelConfig } from "../types";
 
-import { uid } from "./uid";
-import { sliceZone } from "./sliceZone";
-
-type MockCustomTypeModelConfig = {
-	tabsCount?: number;
-	withUID?: boolean;
-	configs?: BuildMockGroupFieldMapConfig["configs"];
+type MockCustomTypeModelConfig<
+	Definition extends
+		| prismicT.CustomTypeModelTab
+		| prismicT.CustomTypeModelDefinition =
+		| prismicT.CustomTypeModelTab
+		| prismicT.CustomTypeModelDefinition,
+> = {
+	id?: string;
+	label?: string;
+	status?: boolean;
+	repeatable?: boolean;
 } & (
 	| {
-			withSliceZones?: false;
+			fields?: Definition;
+			tabs?: never;
 	  }
 	| {
-			withSliceZones: true;
-			withSharedSlices?: boolean;
+			tabs?: Definition;
+			fields?: never;
 	  }
 ) &
 	MockModelConfig;
 
-export const customType = (
-	config: MockCustomTypeModelConfig = {},
-): prismicT.CustomTypeModel => {
-	const faker = createFaker(config.seed);
-
-	const tabsCount =
-		config.tabsCount ?? faker.datatype.number({ min: 1, max: 3 });
-
-	const json: prismicT.CustomTypeModelDefinition = {};
-	for (let i = 0; i < tabsCount; i++) {
-		const tabName = changeCase.capitalCase(faker.company.bsNoun());
-		const tabFields: prismicT.CustomTypeModelTab = buildMockGroupFieldMap({
-			seed: config.seed,
-			configs: config.configs,
-		});
+type MockCustomTypeModel<
+	Definition extends
+		| prismicT.CustomTypeModelTab
+		| prismicT.CustomTypeModelDefinition,
+> = Definition extends prismicT.CustomTypeModelTab
+	? prismicT.CustomTypeModel<string, Record<"Main", Definition>>
+	: Definition extends prismicT.CustomTypeModelDefinition
+	? prismicT.CustomTypeModel<string, Definition>
+	: never;
 
-		if (i === 0 && config.withUID) {
-			const fieldId = generateFieldId({ seed: config.seed });
+export const customType = <
+	Definition extends
+		| prismicT.CustomTypeModelTab
+		| prismicT.CustomTypeModelDefinition,
+>(
+	config: MockCustomTypeModelConfig<Definition> = {},
+): MockCustomTypeModel<Definition> => {
+	const faker = createFaker(config.seed);
 
-			tabFields[fieldId] = uid();
-		}
+	let label: string =
+		config.label || changeCase.capitalCase(faker.company.bsNoun());
+	let id: string = config.id || changeCase.snakeCase(label);
 
-		if (config.withSliceZones) {
-			const sliceZoneId = generateFieldId({ seed: config.seed });
+	if (config.id && !config.label) {
+		label = changeCase.capitalCase(config.id);
+	} else if (config.label && !config.label) {
+		id = changeCase.snakeCase(config.label);
+	}
 
-			tabFields[sliceZoneId] = sliceZone({
-				withSharedSlices: config.withSharedSlices,
-			});
-		}
+	let json = {} as MockCustomTypeModel<Definition>["json"];
 
-		json[tabName] = tabFields;
+	if ("fields" in config && config.fields) {
+		json = { Main: config.fields } as typeof json;
+	} else if ("tabs" in config && config.tabs) {
+		json = config.tabs as typeof json;
 	}
 
-	const id = generateCustomTypeId({ seed: config.seed });
-
 	return {
 		id,
-		label: changeCase.capitalCase(id),
-		status: faker.datatype.boolean(),
-		repeatable: faker.datatype.boolean(),
+		label,
+		status: config.status ?? faker.datatype.boolean(),
+		repeatable: config.repeatable ?? faker.datatype.boolean(),
 		json,
-	};
+	} as MockCustomTypeModel<Definition>;
 };

package/src/model/group.ts

@@ -1,31 +1,24 @@
 import * as prismicT from "@prismicio/types";
 import * as changeCase from "change-case";
 
-import {
-	buildMockGroupFieldMap,
-	BuildMockGroupFieldMapConfig,
-} from "../lib/buildMockGroupFieldMap";
 import { createFaker } from "../lib/createFaker";
 
-import { MockModelConfig } from "../types";
+import { GroupFieldModelMap, MockModelConfig } from "../types";
 
-type MockGroupModelConfig = BuildMockGroupFieldMapConfig & MockModelConfig;
+type MockGroupModelConfig<Fields extends GroupFieldModelMap> = {
+	fields?: Fields;
+} & MockModelConfig;
 
-export const group = (
-	config: MockGroupModelConfig = {},
-): prismicT.CustomTypeModelGroupField => {
+export const group = <Fields extends GroupFieldModelMap>(
+	config: MockGroupModelConfig<Fields> = {},
+): prismicT.CustomTypeModelGroupField<Fields> => {
 	const faker = createFaker(config.seed);
 
-	const fields = buildMockGroupFieldMap({
-		seed: config.seed,
-		configs: config.configs,
-	});
-
 	return {
 		type: prismicT.CustomTypeModelFieldType.Group,
 		config: {
 			label: changeCase.capitalCase(faker.company.bsNoun()),
-			fields,
+			fields: config.fields || ({} as Fields),
 		},
 	};
 };

package/src/model/image.ts

@@ -5,17 +5,23 @@ import { createFaker } from "../lib/createFaker";
 
 import { MockModelConfig } from "../types";
 
-type MockImageModelConfig = {
+type MockImageModelConfig<ThumbnailNames extends string = string> = {
 	withConstraint?: boolean;
-	thumbnailsCount?: number;
+	thumbnailNames?: readonly ThumbnailNames[];
 } & MockModelConfig;
 
-export const image = (
-	config: MockImageModelConfig = {},
-): prismicT.CustomTypeModelImageField => {
+export const image = <ThumbnailNames extends string = string>(
+	config: MockImageModelConfig<ThumbnailNames> = {},
+): prismicT.CustomTypeModelImageField<ThumbnailNames> => {
 	const faker = createFaker(config.seed);
 
-	const thumbnailsCount = config.thumbnailsCount ?? faker.datatype.number(3);
+	const thumbnails = (config.thumbnailNames || []).map((name) => {
+		return {
+			name,
+			width: faker.datatype.number({ min: 500, max: 2000 }),
+			height: faker.datatype.number({ min: 500, max: 2000 }),
+		};
+	});
 
 	return {
 		type: prismicT.CustomTypeModelFieldType.Image,
@@ -29,13 +35,7 @@ export const image = (
 					? faker.datatype.number({ min: 500, max: 2000 })
 					: null,
 			},
-			thumbnails: Array(thumbnailsCount)
-				.fill(undefined)
-				.map(() => ({
-					name: changeCase.capitalCase(faker.company.bsNoun()),
-					width: faker.datatype.number({ min: 500, max: 2000 }),
-					height: faker.datatype.number({ min: 500, max: 2000 }),
-				})),
+			thumbnails,
 		},
 	};
 };

package/src/model/index.ts

@@ -22,3 +22,5 @@ export { sliceZone } from "./sliceZone";
 export { timestamp } from "./timestamp";
 export { title } from "./title";
 export { uid } from "./uid";
+
+export { buildMockGroupFieldMap } from "./buildMockGroupFieldMap";

package/src/model/select.ts

@@ -5,31 +5,26 @@ import { createFaker } from "../lib/createFaker";
 
 import { MockModelConfig } from "../types";
 
-type MockSelectModelConfig = {
-	optionsCount?: number;
-	withDefaultValue?: boolean;
+type MockSelectModelConfig<
+	Option extends string = string,
+	DefaultOption extends Option = Option,
+> = {
+	options?: Option[];
+	defaultValue?: DefaultOption;
 } & MockModelConfig;
 
-export const select = (
-	config: MockSelectModelConfig = {},
-): prismicT.CustomTypeModelSelectField => {
+export const select = <Option extends string, DefaultOption extends Option>(
+	config: MockSelectModelConfig<Option, DefaultOption> = {},
+): prismicT.CustomTypeModelSelectField<Option, DefaultOption> => {
 	const faker = createFaker(config.seed);
 
-	const optionsCount =
-		config.optionsCount ?? faker.datatype.number({ min: 1, max: 5 });
-	const options = Array(optionsCount)
-		.fill(undefined)
-		.map(() => changeCase.capitalCase(faker.company.bsBuzz()));
-
 	return {
 		type: prismicT.CustomTypeModelFieldType.Select,
 		config: {
 			label: changeCase.capitalCase(faker.company.bsNoun()),
 			placeholder: changeCase.sentenceCase(faker.lorem.words(3)),
-			options,
-			default_value: config.withDefaultValue
-				? faker.random.arrayElement(options)
-				: undefined,
+			options: config.options || [],
+			default_value: config.defaultValue || undefined,
 		},
 	};
 };

package/src/model/sharedSlice.ts

@@ -5,43 +5,36 @@ import { createFaker } from "../lib/createFaker";
 
 import { MockModelConfig } from "../types";
 
-import {
-	MockSharedSliceVariationModelConfig,
-	sharedSliceVariation,
-} from "./sharedSliceVariation";
-
-type MockSharedSliceModelConfig = {
-	variationsCount?: number;
-} & Pick<
-	MockSharedSliceVariationModelConfig,
-	"itemsFieldConfig" | "primaryFieldConfig"
-> &
-	MockModelConfig;
-
-export const sharedSlice = (
-	config: MockSharedSliceModelConfig = {},
-): prismicT.SharedSliceModel => {
+type MockSharedSliceModelConfig<
+	Variation extends prismicT.SharedSliceModelVariation,
+> = {
+	id?: string;
+	name?: string;
+	variations?: Variation[];
+} & MockModelConfig;
+
+export const sharedSlice = <
+	Variation extends prismicT.SharedSliceModelVariation,
+>(
+	config: MockSharedSliceModelConfig<Variation> = {},
+): prismicT.SharedSliceModel<string, Variation> => {
 	const faker = createFaker(config.seed);
 
-	const variationsCount =
-		config.variationsCount ?? faker.datatype.number({ min: 1, max: 3 });
+	let name: string =
+		config.name || changeCase.capitalCase(faker.company.bsNoun());
+	let id: string = config.id || changeCase.snakeCase(name);
 
-	const name = changeCase.capitalCase(faker.company.bsNoun());
-	const variations = Array(variationsCount)
-		.fill(undefined)
-		.map(() =>
-			sharedSliceVariation({
-				seed: config.seed,
-				itemsFieldConfig: config.itemsFieldConfig,
-				primaryFieldConfig: config.primaryFieldConfig,
-			}),
-		);
+	if (config.id && !config.name) {
+		name = changeCase.pascalCase(config.id);
+	} else if (config.name && !config.name) {
+		id = changeCase.snakeCase(config.name);
+	}
 
 	return {
 		type: prismicT.CustomTypeModelSliceType.SharedSlice,
-		id: changeCase.snakeCase(name),
+		id,
 		name,
 		description: faker.lorem.sentence(),
-		variations,
+		variations: config.variations || ([] as Variation[]),
 	};
 };

package/src/model/sharedSliceVariation.ts

@@ -2,38 +2,50 @@ import * as prismicT from "@prismicio/types";
 import * as changeCase from "change-case";
 
 import { createFaker } from "../lib/createFaker";
-import {
-	buildMockGroupFieldMap,
-	BuildMockGroupFieldMapConfig,
-} from "../lib/buildMockGroupFieldMap";
 
-import { MockModelConfig } from "../types";
+import { GroupFieldModelMap, MockModelConfig } from "../types";
 
-export type MockSharedSliceVariationModelConfig = {
-	primaryFieldConfig?: BuildMockGroupFieldMapConfig;
-	itemsFieldConfig?: BuildMockGroupFieldMapConfig;
+export type MockSharedSliceVariationModelConfig<
+	ID extends string = string,
+	PrimaryFields extends GroupFieldModelMap = GroupFieldModelMap,
+	ItemsFields extends GroupFieldModelMap = GroupFieldModelMap,
+> = {
+	id?: ID;
+	name?: string;
+	primaryFields?: PrimaryFields;
+	itemsFields?: ItemsFields;
 } & MockModelConfig;
 
-export const sharedSliceVariation = (
-	config: MockSharedSliceVariationModelConfig = {},
-): prismicT.SharedSliceModelVariation => {
+export const sharedSliceVariation = <
+	ID extends string,
+	PrimaryFields extends GroupFieldModelMap,
+	ItemsFields extends GroupFieldModelMap,
+>(
+	config: MockSharedSliceVariationModelConfig<
+		ID,
+		PrimaryFields,
+		ItemsFields
+	> = {},
+): prismicT.SharedSliceModelVariation<ID, PrimaryFields, ItemsFields> => {
 	const faker = createFaker(config.seed);
 
-	const name = changeCase.capitalCase(faker.company.bsNoun());
+	let name: string =
+		config.name || changeCase.capitalCase(faker.company.bsNoun());
+	let id: ID = config.id || (changeCase.snakeCase(name) as ID);
+
+	if (config.id && !config.name) {
+		name = changeCase.pascalCase(config.id);
+	} else if (config.name && !config.name) {
+		id = changeCase.snakeCase(config.name) as ID;
+	}
 
 	return {
-		id: changeCase.snakeCase(name),
+		id,
 		name,
 		description: faker.lorem.sentence(),
 		docURL: faker.internet.url(),
 		version: faker.git.shortSha(),
-		primary: buildMockGroupFieldMap({
-			seed: config.primaryFieldConfig?.seed ?? config.seed,
-			configs: config.primaryFieldConfig?.configs,
-		}),
-		items: buildMockGroupFieldMap({
-			seed: config.itemsFieldConfig?.seed ?? config.seed,
-			configs: config.itemsFieldConfig?.configs,
-		}),
+		primary: config.primaryFields || ({} as PrimaryFields),
+		items: config.itemsFields || ({} as ItemsFields),
 	};
 };