@prismicio/mock 0.7.0 → 0.7.1-canary.b078d42

package/src/createMockFactory.ts

@@ -1,52 +1,41 @@
-import { createFaker, Faker } from "./lib/createFaker";
-
-import { Seed } from "./types";
-
-import {
-	createModelMockFactory,
-	ModelMockFactory,
-} from "./model/createModelMockFactory";
-import {
-	createValueMockFactory,
-	ValueMockFactory,
-} from "./value/createValueMockFactory";
-import {
-	createAPIMockFactory,
-	APIMockFactory,
-} from "./api/createAPIMockFactory";
+import { createAPIMockFactory, type APIMockFactory } from "./api/createAPIMockFactory"
+import { createFaker, type Faker } from "./lib/createFaker"
+import { createModelMockFactory, type ModelMockFactory } from "./model/createModelMockFactory"
+import type { Seed } from "./types"
+import { createValueMockFactory, type ValueMockFactory } from "./value/createValueMockFactory"
 
 export const createMockFactory = (
 	...args: ConstructorParameters<typeof MockFactory>
 ): MockFactory => {
-	return new MockFactory(...args);
-};
+	return new MockFactory(...args)
+}
 
 type PrismicMockConfig =
 	| {
-			seed: Seed;
-			faker?: never;
+			seed: Seed
+			faker?: never
 	  }
 	| {
-			faker: Faker;
-			seed?: never;
-	  };
+			faker: Faker
+			seed?: never
+	  }
 
 export class MockFactory {
-	private faker: Faker;
+	private faker: Faker
 
-	api: APIMockFactory;
-	model: ModelMockFactory;
-	value: ValueMockFactory;
+	api: APIMockFactory
+	model: ModelMockFactory
+	value: ValueMockFactory
 
 	constructor(config: PrismicMockConfig) {
-		this.faker = config.faker || createFaker(config.seed);
+		this.faker = config.faker || createFaker(config.seed)
 
-		this.api = createAPIMockFactory({ faker: this.faker });
-		this.model = createModelMockFactory({ faker: this.faker });
-		this.value = createValueMockFactory({ faker: this.faker });
+		this.api = createAPIMockFactory({ faker: this.faker })
+		this.model = createModelMockFactory({ faker: this.faker })
+		this.value = createValueMockFactory({ faker: this.faker })
 	}
 
-	get seed() {
-		return this.faker.seed;
+	get seed(): Seed {
+		return this.faker.seed
 	}
 }

package/src/index.ts

@@ -1,18 +1,9 @@
-export * as api from "./api";
-export * as model from "./model";
-export * as value from "./value";
+export * as api from "./api"
+export * as model from "./model"
+export * as value from "./value"
 
-export { createMockFactory, MockFactory } from "./createMockFactory";
+export { createMockFactory, MockFactory } from "./createMockFactory"
 
-export {
-	createAPIMockFactory,
-	APIMockFactory,
-} from "./api/createAPIMockFactory";
-export {
-	createModelMockFactory,
-	ModelMockFactory,
-} from "./model/createModelMockFactory";
-export {
-	createValueMockFactory,
-	ValueMockFactory,
-} from "./value/createValueMockFactory";
+export { createAPIMockFactory, APIMockFactory } from "./api/createAPIMockFactory"
+export { createModelMockFactory, ModelMockFactory } from "./model/createModelMockFactory"
+export { createValueMockFactory, ValueMockFactory } from "./value/createValueMockFactory"

package/src/lib/PRNG.ts

@@ -1,77 +1,70 @@
 /**
- * The following code is a modified version of Prando from `zeh/prando` on
- * GitHub.
+ * The following code is a modified version of Prando from `zeh/prando` on GitHub.
  *
- * Source:
- * https://github.com/zeh/prando/blob/acc2a3c09df12a41b5c82fbf44e49e070e6f60ac/src/Prando.ts
+ * Source: https://github.com/zeh/prando/blob/acc2a3c09df12a41b5c82fbf44e49e070e6f60ac/src/Prando.ts
  *
  * The MIT License (MIT)
  *
  * Copyright (c) 2016 Zeh Fernando
  *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+ * associated documentation files (the "Software"), to deal in the Software without restriction,
+ * including without limitation the rights to use, copy, modify, merge, publish, distribute,
+ * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
  * furnished to do so, subject to the following conditions:
  *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
  *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+ * NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
-const MIN = -2147483648; // Int32 min
-const MAX = 2147483647; // Int32 max
+const MIN = -2147483648 // Int32 min
+const MAX = 2147483647 // Int32 max
 
 const xorshift = (value: number): number => {
 	// Xorshift*32
 	// Based on George Marsaglia's work: http://www.jstatsoft.org/v08/i14/paper
-	value ^= value << 13;
-	value ^= value >> 17;
-	value ^= value << 5;
+	value ^= value << 13
+	value ^= value >> 17
+	value ^= value << 5
 
-	return value;
-};
+	return value
+}
 
-/**
- * Pseudorandom number generator.
- */
+/** Pseudorandom number generator. */
 export class PRNG {
-	private _value: number;
+	private _value: number
 
 	/**
 	 * Generate a new pseudo-random number generator.
 	 *
-	 * @param seed - A number or string seed that determines which pseudo-random
-	 *   number sequence will be created.
+	 * @param seed - A number or string seed that determines which pseudo-random number sequence will
+	 *   be created.
 	 */
 	constructor(seed: number | string) {
 		if (typeof seed === "string") {
-			let hash = 0;
+			let hash = 0
 			if (seed) {
-				const l = seed.length;
+				const l = seed.length
 				for (let i = 0; i < l; i++) {
-					hash = (hash << 5) - hash + seed.charCodeAt(i);
-					hash |= 0;
-					hash = xorshift(hash);
+					hash = (hash << 5) - hash + seed.charCodeAt(i)
+					hash |= 0
+					hash = xorshift(hash)
 				}
 			}
 
-			this._value = hash;
+			this._value = hash
 		} else {
-			this._value = seed;
+			this._value = seed
 		}
 
 		if (this._value === 0) {
-			this._value = 1;
+			this._value = 1
 		}
 	}
 
@@ -81,8 +74,8 @@ export class PRNG {
 	 * @returns The generated pseudo-random number.
 	 */
 	public next(): number {
-		this._value = xorshift(this._value);
+		this._value = xorshift(this._value)
 
-		return (this._value - MIN) / (MAX - MIN);
+		return (this._value - MIN) / (MAX - MIN)
 	}
 }

package/src/lib/buildAlternativeLanguage.ts

@@ -1,12 +1,10 @@
-import * as prismic from "@prismicio/client";
+import type * as prismic from "@prismicio/client"
 
 type BuildEmbedFieldConfig<Document extends prismic.PrismicDocument> = {
-	document: Document;
-};
+	document: Document
+}
 
-export const buildAlternativeLanguage = <
-	Document extends prismic.PrismicDocument,
->(
+export const buildAlternativeLanguage = <Document extends prismic.PrismicDocument>(
 	config: BuildEmbedFieldConfig<Document>,
 ): prismic.AlternateLanguage<Document["type"], Document["lang"]> => {
 	return {
@@ -14,5 +12,5 @@ export const buildAlternativeLanguage = <
 		type: config.document.type,
 		lang: config.document.lang,
 		uid: config.document.uid || undefined,
-	};
-};
+	}
+}

package/src/lib/buildContentRelationshipField.ts

@@ -1,21 +1,12 @@
-import * as prismic from "@prismicio/client";
+import * as prismic from "@prismicio/client"
 
-type BuildContentRelationshipFieldConfig<
-	Document extends prismic.PrismicDocument,
-> = {
-	document: Document;
-};
+type BuildContentRelationshipFieldConfig<Document extends prismic.PrismicDocument> = {
+	document: Document
+}
 
-export const buildContentRelationshipField = <
-	Document extends prismic.PrismicDocument,
->(
+export const buildContentRelationshipField = <Document extends prismic.PrismicDocument>(
 	config: BuildContentRelationshipFieldConfig<Document>,
-): prismic.ContentRelationshipField<
-	Document["type"],
-	Document["lang"],
-	never,
-	"filled"
-> => {
+): prismic.ContentRelationshipField<Document["type"], Document["lang"], never, "filled"> => {
 	return {
 		link_type: prismic.LinkType.Document,
 		id: config.document.id,
@@ -26,5 +17,5 @@ export const buildContentRelationshipField = <
 		url: config.document.url || undefined,
 		slug: config.document.slugs[0],
 		isBroken: false,
-	};
-};
+	}
+}

package/src/lib/buildEmbedField.ts

@@ -1,35 +1,31 @@
-import * as prismic from "@prismicio/client";
+import type * as prismic from "@prismicio/client"
 
-import { createFaker, Faker } from "../lib/createFaker";
+import { createFaker, type Faker } from "../lib/createFaker"
+import type { Seed } from "../types"
 
-import { Seed } from "../types";
+type BuildEmbedFieldConfig<Data extends prismic.AnyOEmbed = prismic.AnyOEmbed> = {
+	url?: string
+	html?: string
+	data: Data
+} & (
+	| {
+			seed: Seed
+			faker?: never
+	  }
+	| {
+			faker: Faker
+			seed?: never
+	  }
+)
 
-type BuildEmbedFieldConfig<Data extends prismic.AnyOEmbed = prismic.AnyOEmbed> =
-	{
-		url?: string;
-		html?: string;
-		data: Data;
-	} & (
-		| {
-				seed: Seed;
-				faker?: never;
-		  }
-		| {
-				faker: Faker;
-				seed?: never;
-		  }
-	);
-
-export const buildEmbedField = <
-	Data extends prismic.AnyOEmbed = prismic.AnyOEmbed,
->(
+export const buildEmbedField = <Data extends prismic.AnyOEmbed = prismic.AnyOEmbed>(
 	config: BuildEmbedFieldConfig<Data>,
 ): prismic.EmbedField<Data, "filled"> => {
-	const faker = config.faker || createFaker(config.seed);
+	const faker = config.faker || createFaker(config.seed)
 
 	return {
 		embed_url: config.url ?? faker.url(),
 		html: `<div>embed html</div>`,
 		...config.data,
-	} as prismic.EmbedField<Data, "filled">;
-};
+	} as prismic.EmbedField<Data, "filled">
+}

package/src/lib/buildImageFieldImage.ts

@@ -1,32 +1,25 @@
-import * as prismic from "@prismicio/client";
+import type * as prismic from "@prismicio/client"
 
-import { sentenceCase } from "../lib/changeCase";
-import { createFaker, Faker } from "../lib/createFaker";
+import { sentenceCase } from "../lib/changeCase"
+import { createFaker, type Faker } from "../lib/createFaker"
+import type { MockValueStateConfig, MockImageData, Seed } from "../types"
 
-import { MockValueStateConfig, MockImageData, Seed } from "../types";
-
-type BuildImageFieldConfig<
-	State extends prismic.FieldState = prismic.FieldState,
-> = {
-	imageData: MockImageData;
-	constraint?: NonNullable<
-		prismic.CustomTypeModelImageField["config"]
-	>["constraint"];
+type BuildImageFieldConfig<State extends prismic.FieldState = prismic.FieldState> = {
+	imageData: MockImageData
+	constraint?: NonNullable<prismic.CustomTypeModelImageField["config"]>["constraint"]
 } & (
 	| {
-			seed: Seed;
-			faker?: never;
+			seed: Seed
+			faker?: never
 	  }
 	| {
-			faker: Faker;
-			seed?: never;
+			faker: Faker
+			seed?: never
 	  }
 ) &
-	Pick<MockValueStateConfig<State>, "state">;
+	Pick<MockValueStateConfig<State>, "state">
 
-export const buildImageFieldImage = <
-	State extends prismic.FieldState = prismic.FieldState,
->(
+export const buildImageFieldImage = <State extends prismic.FieldState = prismic.FieldState>(
 	config: BuildImageFieldConfig<State>,
 ): prismic.ImageFieldImage<State> => {
 	if (config.state === "empty") {
@@ -36,20 +29,20 @@ export const buildImageFieldImage = <
 			dimensions: null,
 			alt: null,
 			copyright: null,
-		} as prismic.ImageFieldImage<State>;
+		} as prismic.ImageFieldImage<State>
 	} else {
-		const faker = config.faker || createFaker(config.seed);
+		const faker = config.faker || createFaker(config.seed)
 
-		const url = new URL(config.imageData.url);
+		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");
+		url.searchParams.set("w", dimensions.width.toString())
+		url.searchParams.set("h", dimensions.height.toString())
+		url.searchParams.set("fit", "crop")
 
 		return {
 			id: faker.hash(11),
@@ -63,6 +56,6 @@ export const buildImageFieldImage = <
 				zoom: faker.rangeFloat(1, 2),
 				background: faker.hexColor(),
 			},
-		} as prismic.ImageFieldImage<State>;
+		} as prismic.ImageFieldImage<State>
 	}
-};
+}

package/src/lib/changeCase.ts

@@ -1,14 +1,13 @@
-export const capitalCase = (input: string) =>
-	stripPunctuation(input).replace(/(^\w|\s\w)/g, (char) => char.toUpperCase());
+export const capitalCase = (input: string): string =>
+	stripPunctuation(input).replace(/(^\w|\s\w)/g, (char) => char.toUpperCase())
 
-export const snakeCase = (input: string) =>
-	stripPunctuation(input).toLowerCase().replace(/\s/g, "_");
+export const snakeCase = (input: string): string =>
+	stripPunctuation(input).toLowerCase().replace(/\s/g, "_")
 
-export const sentenceCase = (input: string) =>
-	stripPunctuation(input).replace(/^./, (char) => char.toUpperCase());
+export const sentenceCase = (input: string): string =>
+	stripPunctuation(input).replace(/^./, (char) => char.toUpperCase())
 
-export const pascalCase = (input: string) =>
-	capitalCase(stripPunctuation(input.replace(/-|_/, " "))).replace(/ /g, "");
+export const pascalCase = (input: string): string =>
+	capitalCase(stripPunctuation(input.replace(/-|_/, " "))).replace(/ /g, "")
 
-const stripPunctuation = (input: string) =>
-	input.replace(/[^\p{L}\p{N}\s]/gu, "");
+const stripPunctuation = (input: string) => input.replace(/[^\p{L}\p{N}\s]/gu, "")

package/src/lib/createFaker.ts

@@ -1,107 +1,104 @@
-import { Seed } from "../types";
-
-import { lorem, loremWords } from "./lorem";
-import { PRNG } from "./PRNG";
+import type { Seed } from "../types"
+import { lorem, loremWords } from "./lorem"
+import { PRNG } from "./PRNG"
 
 export const createFaker = (seed: Seed): Faker => {
-	return new Faker(seed);
-};
+	return new Faker(seed)
+}
 
-const DAY_MS = 1000 * 60 * 60 * 24;
-const YEAR_MS = DAY_MS * 365;
-const YEAR_2022_MS = 52 * (YEAR_MS + DAY_MS / 4);
+const DAY_MS = 1000 * 60 * 60 * 24
+const YEAR_MS = DAY_MS * 365
+const YEAR_2022_MS = 52 * (YEAR_MS + DAY_MS / 4)
 
 export class Faker {
-	seed: Seed;
+	seed: Seed
 
-	private prng: PRNG;
+	private prng: PRNG
 
 	constructor(seed: Seed) {
-		this.seed = seed;
+		this.seed = seed
 
-		this.prng = new PRNG(seed.toString());
+		this.prng = new PRNG(seed.toString())
 	}
 
 	random(): number {
-		return this.prng.next();
+		return this.prng.next()
 	}
 
 	boolean(): boolean {
-		return this.random() >= 0.5;
+		return this.random() >= 0.5
 	}
 
 	randomElement<T>(elements: readonly T[]): T {
-		return elements[this.range(0, elements.length)];
+		return elements[this.range(0, elements.length)]
 	}
 
 	randomElements<T>(elements: readonly T[]): T[] {
-		const alwaysInclude = this.randomElement(elements);
+		const alwaysInclude = this.randomElement(elements)
 
-		return elements.filter(
-			(element) => element === alwaysInclude || this.boolean(),
-		);
+		return elements.filter((element) => element === alwaysInclude || this.boolean())
 	}
 
 	range(min: number, max: number): number {
-		return Math.floor(this.rangeFloat(Math.ceil(min), Math.floor(max)));
+		return Math.floor(this.rangeFloat(Math.ceil(min), Math.floor(max)))
 	}
 
 	rangeFloat(min: number, max: number): number {
-		return this.random() * (max - min) + min;
+		return this.random() * (max - min) + min
 	}
 
 	words(length: number, wordOffset = this.range(0, loremWords.length)): string {
-		return lorem(`${length}w`, wordOffset);
+		return lorem(`${length}w`, wordOffset)
 	}
 
 	word(): string {
-		return this.randomElement(loremWords);
+		return this.randomElement(loremWords)
 	}
 
 	lorem(
 		length: Parameters<typeof lorem>[0],
 		wordOffset = this.range(0, loremWords.length),
 	): string {
-		return lorem(length, wordOffset);
+		return lorem(length, wordOffset)
 	}
 
 	url(): string {
-		return `https://${this.word()}.example`;
+		return `https://${this.word()}.example`
 	}
 
 	hexColor(): string {
-		return `#${this.hash(6)}`;
+		return `#${this.hash(6)}`
 	}
 
 	hash(length: number): string {
-		let hash = "";
+		let hash = ""
 
 		for (let i = 0; i < length; i++) {
-			const chars = this.boolean() ? "abcdef" : "0123456789";
+			const chars = this.boolean() ? "abcdef" : "0123456789"
 
-			hash += chars[this.range(0, chars.length)];
+			hash += chars[this.range(0, chars.length)]
 		}
 
-		return hash;
+		return hash
 	}
 
 	date(): Date {
-		return new Date(YEAR_2022_MS + this.range(-YEAR_MS * 3, YEAR_MS * 3));
+		return new Date(YEAR_2022_MS + this.range(-YEAR_MS * 3, YEAR_MS * 3))
 	}
 
 	dateAfter(date: Date): Date {
-		const timestamp = date.getTime();
+		const timestamp = date.getTime()
 
-		return new Date(this.range(timestamp, timestamp + YEAR_MS * 3));
+		return new Date(this.range(timestamp, timestamp + YEAR_MS * 3))
 	}
 
 	dateBefore(date: Date): Date {
-		const timestamp = date.getTime();
+		const timestamp = date.getTime()
 
-		return new Date(this.range(timestamp - YEAR_MS * 3, timestamp));
+		return new Date(this.range(timestamp - YEAR_MS * 3, timestamp))
 	}
 
 	dateBetween(min: Date, max: Date): Date {
-		return new Date(this.range(min.getTime(), max.getTime()));
+		return new Date(this.range(min.getTime(), max.getTime()))
 	}
 }

package/src/lib/generateCustomTypeId.ts

@@ -1,20 +1,19 @@
-import { snakeCase } from "../lib/changeCase";
-import { createFaker, Faker } from "../lib/createFaker";
-
-import { Seed } from "../types";
+import { snakeCase } from "../lib/changeCase"
+import { createFaker, type Faker } from "../lib/createFaker"
+import type { Seed } from "../types"
 
 type GenerateFieldIdConfig =
 	| {
-			seed: Seed;
-			faker?: never;
+			seed: Seed
+			faker?: never
 	  }
 	| {
-			faker: Faker;
-			seed?: never;
-	  };
+			faker: Faker
+			seed?: never
+	  }
 
 export const generateCustomTypeId = (config: GenerateFieldIdConfig): string => {
-	const faker = config.faker || createFaker(config.seed);
+	const faker = config.faker || createFaker(config.seed)
 
-	return snakeCase(faker.words(faker.range(1, 3)));
-};
+	return snakeCase(faker.words(faker.range(1, 3)))
+}

package/src/lib/generateFieldId.ts

@@ -1,20 +1,19 @@
-import { snakeCase } from "../lib/changeCase";
-import { createFaker, Faker } from "../lib/createFaker";
-
-import { Seed } from "../types";
+import { snakeCase } from "../lib/changeCase"
+import { createFaker, type Faker } from "../lib/createFaker"
+import type { Seed } from "../types"
 
 type GenerateFieldIdConfig =
 	| {
-			seed: Seed;
-			faker?: never;
+			seed: Seed
+			faker?: never
 	  }
 	| {
-			faker: Faker;
-			seed?: never;
-	  };
+			faker: Faker
+			seed?: never
+	  }
 
 export const generateFieldId = (config: GenerateFieldIdConfig): string => {
-	const faker = config.faker || createFaker(config.seed);
+	const faker = config.faker || createFaker(config.seed)
 
-	return snakeCase(faker.words(faker.range(1, 3)));
-};
+	return snakeCase(faker.words(faker.range(1, 3)))
+}