@prismicio/mock/src/model/sharedSliceVariation.ts

Generate mock Prismic documents, fields, Slices, and models for development and testing environments

import * as prismic from "@prismicio/client";

import {
	capitalCase,
	pascalCase,
	sentenceCase,
	snakeCase,
} from "../lib/changeCase";
import { createFaker } from "../lib/createFaker";
import { getMockImageData } from "../lib/getMockImageData";

import {
	MockModelConfig,
	NestedGroupFieldModelMap,
	SlicePrimaryFieldModelMap,
} from "../types";

export type MockSharedSliceVariationModelConfig<
	ID extends string = string,
	PrimaryFields extends SlicePrimaryFieldModelMap = SlicePrimaryFieldModelMap,
	ItemsFields extends NestedGroupFieldModelMap = NestedGroupFieldModelMap,
> = {
	id?: ID;
	name?: string;
	primaryFields?: PrimaryFields;
	itemsFields?: ItemsFields;
} & MockModelConfig;

export const sharedSliceVariation = <
	ID extends string,
	PrimaryFields extends SlicePrimaryFieldModelMap,
	ItemsFields extends NestedGroupFieldModelMap,
>(
	config: MockSharedSliceVariationModelConfig<ID, PrimaryFields, ItemsFields>,
): prismic.SharedSliceModelVariation<ID, PrimaryFields, ItemsFields> => {
	const faker = config.faker || createFaker(config.seed);

	let name: string = config.name || capitalCase(faker.words(faker.range(1, 2)));
	let id: ID = config.id || (snakeCase(name) as ID);

	if (config.id && !config.name) {
		name = pascalCase(config.id);
	} else if (config.name && !config.name) {
		id = snakeCase(config.name) as ID;
	}

	const imageData = getMockImageData({ faker });

	return {
		id,
		name,
		description: sentenceCase(faker.words(faker.range(5, 10))),
		docURL: faker.url(),
		version: faker.hash(7),
		primary: config.primaryFields || ({} as PrimaryFields),
		items: config.itemsFields || ({} as ItemsFields),
		imageUrl: imageData.url,
	};
};