@prismicio/mock/src/value/sliceZone.ts

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

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

import { createFaker } from "../lib/createFaker";
import { ValueForModelMapConfigs } from "../lib/valueForModelMap";

import { MockValueConfig, MockValueStateConfig, ModelValue } from "../types";

import * as modelGen from "../model";

import { slice } from "./slice";
import { sharedSlice } from "./sharedSlice";

export type MockSliceZoneValueConfig<
	Model extends
		prismic.CustomTypeModelSliceZoneField = prismic.CustomTypeModelSliceZoneField,
	State extends prismic.FieldState = prismic.FieldState,
> = {
	sharedSliceModels?: prismic.SharedSliceModel[];
	itemsCount?: State extends "empty" ? 0 : number;
	primaryFieldConfigs?: ValueForModelMapConfigs;
	itemsFieldConfigs?: ValueForModelMapConfigs;
} & MockValueConfig<Model> &
	MockValueStateConfig<State>;

export const sliceZone = <
	Model extends
		prismic.CustomTypeModelSliceZoneField = prismic.CustomTypeModelSliceZoneField,
	State extends prismic.FieldState = prismic.FieldState,
>(
	config: MockSliceZoneValueConfig<Model, State>,
): ModelValue<Model, State> => {
	if (config.state === "empty") {
		return [] as ModelValue<Model, State>;
	} else {
		const faker = config.faker || createFaker(config.seed);

		const model = config.model || modelGen.sliceZone({ faker });

		if (model.config?.choices && Object.keys(model.config.choices).length > 0) {
			const itemsCount = config.itemsCount ?? faker.range(1, 6);

			return Array(itemsCount)
				.fill(undefined)
				.map(() => {
					const choices =
						(model.config?.choices && Object.entries(model.config.choices)) ||
						[];
					const [choiceType, choiceModel] = faker.randomElement(choices);

					const choiceLabels = model.config?.labels?.[choiceType] || [];
					const choiceLabel = faker.randomElement(choiceLabels);

					switch (choiceModel.type) {
						case prismic.CustomTypeModelSliceType.Slice: {
							return slice({
								faker,
								model: choiceModel,
								type: choiceType,
								label: choiceLabel ? choiceLabel.name : null,
								primaryFieldConfigs: config.primaryFieldConfigs,
								itemsFieldConfigs: config.itemsFieldConfigs,
							});
						}

						case prismic.CustomTypeModelSliceType.SharedSlice: {
							const sharedSliceModel = config.sharedSliceModels?.find(
								(sharedSliceModel) => sharedSliceModel.id === choiceType,
							);

							if (sharedSliceModel) {
								return sharedSlice({
									faker,
									model: sharedSliceModel,
									primaryFieldConfigs: config.primaryFieldConfigs,
									itemsFieldConfigs: config.itemsFieldConfigs,
								});
							}
						}
					}
				})
				.filter(
					(slice): slice is NonNullable<typeof slice> => slice !== undefined,
				) as ModelValue<Model, State>;
		} else {
			return [] as unknown as ModelValue<Model, State>;
		}
	}
};