@prismicio/mock/src/api/createAPIMockFactory.ts

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

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

import { createFaker, Faker } from "../lib/createFaker";

import { Seed, WithoutFakerConfig } from "../types";

import { query, MockRestApiQueryConfig } from "./query";
import { ref, MockRestApiRefConfig } from "./ref";
import { repository, MockRestApiRepositoryConfig } from "./repository";
import { tags, MockRestApiTagsConfig } from "./tags";

export const createAPIMockFactory = (
	...args: ConstructorParameters<typeof APIMockFactory>
): APIMockFactory => {
	return new APIMockFactory(...args);
};

type APIMockFactoryConfig =
	| {
			seed: Seed;
	  }
	| {
			faker: Faker;
	  };

export class APIMockFactory {
	private faker: Faker;

	constructor(config: APIMockFactoryConfig) {
		this.faker = "faker" in config ? config.faker : createFaker(config.seed);
	}

	get seed() {
		return this.faker.seed;
	}

	query<Document extends prismic.PrismicDocument = prismic.PrismicDocument>(
		config?: WithoutFakerConfig<MockRestApiQueryConfig<Document>>,
	) {
		return query({ ...config, faker: this.faker });
	}

	ref<IsScheduled extends boolean = false>(
		config?: WithoutFakerConfig<MockRestApiRefConfig<IsScheduled>>,
	) {
		return ref({ ...config, faker: this.faker });
	}

	repository(config?: WithoutFakerConfig<MockRestApiRepositoryConfig>) {
		return repository({ ...config, faker: this.faker });
	}

	tags(config?: WithoutFakerConfig<MockRestApiTagsConfig>) {
		return tags({ ...config, faker: this.faker });
	}
}