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

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

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

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

import { MockModelConfig } from "../types";

export type MockCustomTypeModelConfig<
	Definition extends
		| prismic.CustomTypeModelTab
		| prismic.CustomTypeModelDefinition =
		| prismic.CustomTypeModelTab
		| prismic.CustomTypeModelDefinition,
> = {
	id?: string;
	label?: string;
	status?: boolean;
	repeatable?: boolean;
	format?: prismic.CustomTypeModel["format"];
} & (
	| {
			fields?: Definition;
			tabs?: never;
	  }
	| {
			tabs?: Definition;
			fields?: never;
	  }
) &
	MockModelConfig;

type MockCustomTypeModel<
	Definition extends
		| prismic.CustomTypeModelTab
		| prismic.CustomTypeModelDefinition,
> = (Definition extends prismic.CustomTypeModelTab
	? prismic.CustomTypeModel<string, Record<"Main", Definition>>
	: Definition extends prismic.CustomTypeModelDefinition
		? prismic.CustomTypeModel<string, Definition>
		: never) & {
	label: NonNullable<prismic.CustomTypeModel["label"]>;
};

export const customType = <
	Definition extends
		| prismic.CustomTypeModelTab
		| prismic.CustomTypeModelDefinition,
>(
	config: MockCustomTypeModelConfig<Definition>,
): MockCustomTypeModel<Definition> => {
	const faker = config.faker || createFaker(config.seed);

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

	if (config.id && !config.label) {
		label = capitalCase(config.id);
	} else if (config.label && !config.label) {
		id = snakeCase(config.label);
	}

	const format = config.format ?? faker.randomElement(["page", "custom"]);

	let json = {} as prismic.CustomTypeModelDefinition;

	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;
	}

	return {
		id,
		label,
		status: config.status ?? faker.boolean(),
		repeatable: config.repeatable ?? faker.boolean(),
		format,
		json,
	} as MockCustomTypeModel<Definition>;
};