@prismicio/mock 0.7.0 → 0.7.1-canary.b078d42

package/src/model/timestamp.ts

@@ -1,16 +1,15 @@
-import * as prismic from "@prismicio/client";
+import * as prismic from "@prismicio/client"
 
-import { capitalCase, sentenceCase } from "../lib/changeCase";
-import { createFaker } from "../lib/createFaker";
+import { capitalCase, sentenceCase } from "../lib/changeCase"
+import { createFaker } from "../lib/createFaker"
+import type { MockModelConfig } from "../types"
 
-import { MockModelConfig } from "../types";
-
-export type MockTimestampModelConfig = MockModelConfig;
+export type MockTimestampModelConfig = MockModelConfig
 
 export const timestamp = (
 	config: MockTimestampModelConfig,
 ): prismic.CustomTypeModelTimestampField => {
-	const faker = config.faker || createFaker(config.seed);
+	const faker = config.faker || createFaker(config.seed)
 
 	return {
 		type: prismic.CustomTypeModelFieldType.Timestamp,
@@ -18,5 +17,5 @@ export const timestamp = (
 			label: capitalCase(faker.word()),
 			placeholder: sentenceCase(faker.words(3)),
 		},
-	};
-};
+	}
+}

package/src/model/title.ts

@@ -1,27 +1,17 @@
-import * as prismic from "@prismicio/client";
+import * as prismic from "@prismicio/client"
 
-import { capitalCase, sentenceCase } from "../lib/changeCase";
-import { createFaker } from "../lib/createFaker";
+import { capitalCase, sentenceCase } from "../lib/changeCase"
+import { createFaker } from "../lib/createFaker"
+import type { MockModelConfig } from "../types"
 
-import { MockModelConfig } from "../types";
+export type MockTitleModelConfig = MockModelConfig
 
-export type MockTitleModelConfig = MockModelConfig;
-
-export const title = (
-	config: MockTitleModelConfig,
-): prismic.CustomTypeModelTitleField => {
-	const faker = config.faker || createFaker(config.seed);
+export const title = (config: MockTitleModelConfig): prismic.CustomTypeModelTitleField => {
+	const faker = config.faker || createFaker(config.seed)
 
 	const single = faker
-		.randomElements([
-			"heading1",
-			"heading2",
-			"heading3",
-			"heading4",
-			"heading5",
-			"heading6",
-		])
-		.join(",");
+		.randomElements(["heading1", "heading2", "heading3", "heading4", "heading5", "heading6"])
+		.join(",")
 
 	return {
 		type: prismic.CustomTypeModelFieldType.StructuredText,
@@ -31,5 +21,5 @@ export const title = (
 			single,
 			allowTargetBlank: faker.boolean() || undefined,
 		},
-	};
-};
+	}
+}

package/src/model/uid.ts

@@ -1,16 +1,13 @@
-import * as prismic from "@prismicio/client";
+import * as prismic from "@prismicio/client"
 
-import { capitalCase, sentenceCase } from "../lib/changeCase";
-import { createFaker } from "../lib/createFaker";
+import { capitalCase, sentenceCase } from "../lib/changeCase"
+import { createFaker } from "../lib/createFaker"
+import type { MockModelConfig } from "../types"
 
-import { MockModelConfig } from "../types";
+export type MockUIDModelConfig = MockModelConfig
 
-export type MockUIDModelConfig = MockModelConfig;
-
-export const uid = (
-	config: MockUIDModelConfig,
-): prismic.CustomTypeModelUIDField => {
-	const faker = config.faker || createFaker(config.seed);
+export const uid = (config: MockUIDModelConfig): prismic.CustomTypeModelUIDField => {
+	const faker = config.faker || createFaker(config.seed)
 
 	return {
 		type: prismic.CustomTypeModelFieldType.UID,
@@ -18,5 +15,5 @@ export const uid = (
 			label: capitalCase(faker.word()),
 			placeholder: sentenceCase(faker.words(3)),
 		},
-	};
-};
+	}
+}

package/src/types.ts

@@ -1,69 +1,69 @@
-import * as prismic from "@prismicio/client";
-import { Faker } from "./lib/createFaker";
+import type * as prismic from "@prismicio/client"
 
-import * as value from "./value";
+import type { Faker } from "./lib/createFaker"
+import type * as value from "./value"
 
 export type IterableElement<TargetIterable> =
 	TargetIterable extends Iterable<infer ElementType>
 		? ElementType
 		: TargetIterable extends AsyncIterable<infer ElementType>
 			? ElementType
-			: never;
+			: never
 
 export type ValueOf<
 	ObjectType,
 	ValueType extends keyof ObjectType = keyof ObjectType,
-> = ObjectType[ValueType];
+> = ObjectType[ValueType]
 
-type Simplify<T> = { [KeyType in keyof T]: T[KeyType] };
+type Simplify<T> = { [KeyType in keyof T]: T[KeyType] }
 type Except<ObjectType, KeysType extends keyof ObjectType> = Pick<
 	ObjectType,
 	Exclude<keyof ObjectType, KeysType>
->;
+>
 export type SetRequired<BaseType, Keys extends keyof BaseType> = Simplify<
 	// Pick just the keys that are optional from the base type.
 	Except<BaseType, Keys> &
 		// Pick the keys that should be required from the base type and make them required.
 		Required<Pick<BaseType, Keys>>
->;
+>
 
-export type Seed = string | number;
+export type Seed = string | number
 
 export type WithoutFakerConfig<T> = {
-	[P in keyof T as P extends "seed" | "faker" ? never : P]: T[P];
-};
+	[P in keyof T as P extends "seed" | "faker" ? never : P]: T[P]
+}
 
 export interface MockImageData {
-	url: string;
-	width: number;
-	height: number;
+	url: string
+	width: number
+	height: number
 }
 
 export type MockEmbedData = prismic.AnyOEmbed &
 	prismic.OEmbedExtra & {
-		embed_url: string;
-		html: string;
-	};
+		embed_url: string
+		html: string
+	}
 
 export type MockRestApiConfig =
 	| {
-			seed: Seed;
-			faker?: never;
+			seed: Seed
+			faker?: never
 	  }
 	| {
-			faker: Faker;
-			seed?: never;
-	  };
+			faker: Faker
+			seed?: never
+	  }
 
 export type MockModelConfig =
 	| {
-			seed: Seed;
-			faker?: never;
+			seed: Seed
+			faker?: never
 	  }
 	| {
-			faker: Faker;
-			seed?: never;
-	  };
+			faker: Faker
+			seed?: never
+	  }
 
 // TODO: Add to @prismicio/types
 export type PrismicModel =
@@ -71,41 +71,30 @@ export type PrismicModel =
 	| prismic.CustomTypeModelField
 	| prismic.CustomTypeModelSlice
 	| prismic.SharedSliceModel
-	| prismic.SharedSliceModelVariation;
+	| prismic.SharedSliceModelVariation
 
-export type GroupFieldModelMap = Record<
-	string,
-	prismic.CustomTypeModelFieldForGroup
->;
+export type GroupFieldModelMap = Record<string, prismic.CustomTypeModelFieldForGroup>
 
-export type NestedGroupFieldModelMap = Record<
-	string,
-	prismic.CustomTypeModelFieldForNestedGroup
->;
+export type NestedGroupFieldModelMap = Record<string, prismic.CustomTypeModelFieldForNestedGroup>
 
-export type SlicePrimaryFieldModelMap = Record<
-	string,
-	prismic.CustomTypeModelFieldForSlicePrimary
->;
+export type SlicePrimaryFieldModelMap = Record<string, prismic.CustomTypeModelFieldForSlicePrimary>
 
 export type MockValueConfig<Model extends PrismicModel = PrismicModel> = {
-	model?: Model;
+	model?: Model
 } & (
 	| {
-			seed: Seed;
-			faker?: never;
+			seed: Seed
+			faker?: never
 	  }
 	| {
-			faker: Faker;
-			seed?: never;
+			faker: Faker
+			seed?: never
 	  }
-);
+)
 
-export type MockValueStateConfig<
-	State extends prismic.FieldState = prismic.FieldState,
-> = {
-	state?: State;
-};
+export type MockValueStateConfig<State extends prismic.FieldState = prismic.FieldState> = {
+	state?: State
+}
 
 export type MockValueConfigForModel<
 	Model extends PrismicModel,
@@ -146,33 +135,30 @@ export type MockValueConfigForModel<
 															? value.MockTitleValueConfig<Model, State>
 															: Model extends prismic.CustomTypeModelUIDField
 																? value.MockUIDValueConfig<Model>
-																: never;
+																: never
 
 type CustomTypeModelStructuredTextField =
 	| prismic.CustomTypeModelRichTextField
-	| prismic.CustomTypeModelTitleField;
+	| prismic.CustomTypeModelTitleField
 
 export type MockRichTextValueConfig<
-	Model extends
-		CustomTypeModelStructuredTextField = CustomTypeModelStructuredTextField,
+	Model extends CustomTypeModelStructuredTextField = CustomTypeModelStructuredTextField,
 > = {
-	model?: Model;
+	model?: Model
 } & (
 	| {
-			seed: Seed;
-			faker?: never;
+			seed: Seed
+			faker?: never
 	  }
 	| {
-			faker: Faker;
-			seed?: never;
+			faker: Faker
+			seed?: never
 	  }
-);
+)
 
-export type ModelValueMap<
-	T extends Record<string, prismic.CustomTypeModelField>,
-> = {
-	[P in keyof T]: ModelValue<T[P]>;
-};
+export type ModelValueMap<T extends Record<string, prismic.CustomTypeModelField>> = {
+	[P in keyof T]: ModelValue<T[P]>
+}
 
 export type ModelValue<
 	T extends PrismicModel,
@@ -188,9 +174,9 @@ export type ModelValue<
 				: T extends prismic.CustomTypeModelSliceZoneField
 					? prismic.SliceZone<
 							ValueOf<{
-								[P in keyof NonNullable<
-									NonNullable<T["config"]>["choices"]
-								> as P extends string ? P : never]: NonNullable<
+								[P in keyof NonNullable<NonNullable<T["config"]>["choices"]> as P extends string
+									? P
+									: never]: NonNullable<
 									NonNullable<T["config"]>["choices"]
 								>[P] extends prismic.CustomTypeModelSlice
 									? CustomTypeModelSliceValue<
@@ -201,7 +187,7 @@ export type ModelValue<
 												NonNullable<T["config"]>["choices"]
 										  >[P] extends prismic.CustomTypeModelSharedSlice
 										? prismic.SharedSlice<P extends string ? P : string>
-										: never;
+										: never
 							}>,
 							State
 						>
@@ -214,18 +200,17 @@ export type ModelValue<
 								? SharedSliceModelValue<T>
 								: T extends prismic.SharedSliceModelVariation
 									? SharedSliceModelVariationValue<T>
-									: never;
+									: never
 
-type CustomTypeModelValue<T extends prismic.CustomTypeModel> =
-	prismic.PrismicDocument<
-		ModelValueMap<{
-			[P in keyof ValueOf<T["json"]> as ValueOf<
-				T["json"]
-			>[P]["type"] extends typeof prismic.CustomTypeModelFieldType.UID
-				? never
-				: P]: ValueOf<T["json"]>[P];
-		}>
-	>;
+type CustomTypeModelValue<T extends prismic.CustomTypeModel> = prismic.PrismicDocument<
+	ModelValueMap<{
+		[P in keyof ValueOf<T["json"]> as ValueOf<
+			T["json"]
+		>[P]["type"] extends typeof prismic.CustomTypeModelFieldType.UID
+			? never
+			: P]: ValueOf<T["json"]>[P]
+	}>
+>
 
 type CustomTypeModelFieldForGroupValue<
 	T extends prismic.CustomTypeModelFieldForGroup,
@@ -247,12 +232,7 @@ type CustomTypeModelFieldForGroupValue<
 							: T extends prismic.CustomTypeModelLinkToMediaField
 								? prismic.LinkToMediaField<State>
 								: T extends prismic.CustomTypeModelContentRelationshipField
-									? prismic.ContentRelationshipField<
-											string,
-											string,
-											never,
-											State
-										>
+									? prismic.ContentRelationshipField<string, string, never, State>
 									: T extends prismic.CustomTypeModelDateField
 										? prismic.DateField<State>
 										: T extends prismic.CustomTypeModelTimestampField
@@ -264,34 +244,22 @@ type CustomTypeModelFieldForGroupValue<
 													: T extends prismic.CustomTypeModelSelectField
 														? prismic.SelectField<string, State>
 														: T extends prismic.CustomTypeModelEmbedField
-															? prismic.EmbedField<
-																	prismic.AnyOEmbed & prismic.OEmbedExtra,
-																	State
-																>
+															? prismic.EmbedField<prismic.AnyOEmbed & prismic.OEmbedExtra, State>
 															: T extends prismic.CustomTypeModelGeoPointField
 																? prismic.GeoPointField<State>
 																: T extends prismic.CustomTypeModelIntegrationField
-																	? prismic.IntegrationField<
-																			Record<string, unknown>,
-																			State
-																		>
-																	: never;
+																	? prismic.IntegrationField<Record<string, unknown>, State>
+																	: never
 
 type CustomTypeModelGroupFieldValue<
 	T extends prismic.CustomTypeModelGroupField,
 	State extends prismic.FieldState = prismic.FieldState,
-> = prismic.GroupField<
-	ModelValueMap<NonNullable<NonNullable<T["config"]>["fields"]>>,
-	State
->;
+> = prismic.GroupField<ModelValueMap<NonNullable<NonNullable<T["config"]>["fields"]>>, State>
 
 type CustomTypeModelNestedGroupFieldValue<
 	T extends prismic.CustomTypeModelNestedGroupField,
 	State extends prismic.FieldState = prismic.FieldState,
-> = prismic.NestedGroupField<
-	ModelValueMap<NonNullable<NonNullable<T["config"]>["fields"]>>,
-	State
->;
+> = prismic.NestedGroupField<ModelValueMap<NonNullable<NonNullable<T["config"]>["fields"]>>, State>
 
 type CustomTypeModelSliceValue<
 	T extends prismic.CustomTypeModelSlice,
@@ -300,23 +268,19 @@ type CustomTypeModelSliceValue<
 	SliceType,
 	ModelValueMap<NonNullable<T["non-repeat"]>>,
 	ModelValueMap<NonNullable<T["repeat"]>>
->;
+>
+
+type SharedSliceModelValue<T extends prismic.SharedSliceModel> = prismic.SharedSlice<
+	T["id"],
+	SharedSliceModelVariationValue<IterableElement<NonNullable<T["variations"]>>>
+>
 
-type SharedSliceModelValue<T extends prismic.SharedSliceModel> =
+type SharedSliceModelVariationValue<T extends prismic.SharedSliceModelVariation> =
 	prismic.SharedSlice<
-		T["id"],
-		SharedSliceModelVariationValue<
-			IterableElement<NonNullable<T["variations"]>>
+		string,
+		prismic.SharedSliceVariation<
+			T["id"],
+			ModelValueMap<NonNullable<T["primary"]>>,
+			ModelValueMap<NonNullable<T["items"]>>
 		>
-	>;
-
-type SharedSliceModelVariationValue<
-	T extends prismic.SharedSliceModelVariation,
-> = prismic.SharedSlice<
-	string,
-	prismic.SharedSliceVariation<
-		T["id"],
-		ModelValueMap<NonNullable<T["primary"]>>,
-		ModelValueMap<NonNullable<T["items"]>>
 	>
->;

package/src/value/boolean.ts

@@ -1,18 +1,16 @@
-import * as prismic from "@prismicio/client";
+import type * as prismic from "@prismicio/client"
 
-import { createFaker } from "../lib/createFaker";
-
-import { MockValueConfig } from "../types";
+import { createFaker } from "../lib/createFaker"
+import type { MockValueConfig } from "../types"
 
 export type MockBooleanValueConfig<
-	Model extends
-		prismic.CustomTypeModelBooleanField = prismic.CustomTypeModelBooleanField,
-> = MockValueConfig<Model>;
+	Model extends prismic.CustomTypeModelBooleanField = prismic.CustomTypeModelBooleanField,
+> = MockValueConfig<Model>
 
 export const boolean = <Model extends prismic.CustomTypeModelBooleanField>(
 	config: MockBooleanValueConfig<Model>,
 ): prismic.BooleanField => {
-	const faker = config.faker || createFaker(config.seed);
+	const faker = config.faker || createFaker(config.seed)
 
-	return faker.boolean();
-};
+	return faker.boolean()
+}

package/src/value/color.ts

@@ -1,29 +1,23 @@
-import * as prismic from "@prismicio/client";
+import type * as prismic from "@prismicio/client"
 
-import { createFaker } from "../lib/createFaker";
-
-import { MockValueStateConfig, MockValueConfig } from "../types";
+import { createFaker } from "../lib/createFaker"
+import type { MockValueStateConfig, MockValueConfig } from "../types"
 
 export type MockColorValueConfig<
-	Model extends
-		prismic.CustomTypeModelColorField = prismic.CustomTypeModelColorField,
+	Model extends prismic.CustomTypeModelColorField = prismic.CustomTypeModelColorField,
 	State extends prismic.FieldState = prismic.FieldState,
-> = MockValueConfig<Model> & MockValueStateConfig<State>;
+> = MockValueConfig<Model> & MockValueStateConfig<State>
 
-export type MockColorValue<
-	State extends prismic.FieldState = prismic.FieldState,
-> = prismic.ColorField<State>;
+export type MockColorValue<State extends prismic.FieldState = prismic.FieldState> =
+	prismic.ColorField<State>
 
 export const color = <
-	Model extends
-		prismic.CustomTypeModelColorField = prismic.CustomTypeModelColorField,
+	Model extends prismic.CustomTypeModelColorField = prismic.CustomTypeModelColorField,
 	State extends prismic.FieldState = "filled",
 >(
 	config: MockColorValueConfig<Model, State>,
 ): MockColorValue<State> => {
-	const faker = config.faker || createFaker(config.seed);
+	const faker = config.faker || createFaker(config.seed)
 
-	return (
-		config.state === "empty" ? null : faker.hexColor().toUpperCase()
-	) as MockColorValue<State>;
-};
+	return (config.state === "empty" ? null : faker.hexColor().toUpperCase()) as MockColorValue<State>
+}

package/src/value/contentRelationship.ts

@@ -1,83 +1,64 @@
-import * as prismic from "@prismicio/client";
+import * as prismic from "@prismicio/client"
 
-import { buildContentRelationshipField } from "../lib/buildContentRelationshipField";
-import { createFaker } from "../lib/createFaker";
-import { generateCustomTypeId } from "../lib/generateCustomTypeId";
-import { generateTags } from "../lib/generateTags";
-
-import {
-	MockValueStateConfig,
-	MockValueConfig,
-	IterableElement,
-} from "../types";
-
-import * as modelGen from "../model";
-
-import { document as documentGen } from "./document";
+import { buildContentRelationshipField } from "../lib/buildContentRelationshipField"
+import { createFaker } from "../lib/createFaker"
+import { generateCustomTypeId } from "../lib/generateCustomTypeId"
+import { generateTags } from "../lib/generateTags"
+import * as modelGen from "../model"
+import type { MockValueStateConfig, MockValueConfig, IterableElement } from "../types"
+import { document as documentGen } from "./document"
 
 export type MockContentRelationshipValueConfig<
-	Model extends
-		prismic.CustomTypeModelContentRelationshipField = prismic.CustomTypeModelContentRelationshipField,
+	Model extends prismic.CustomTypeModelContentRelationshipField =
+		prismic.CustomTypeModelContentRelationshipField,
 	State extends prismic.FieldState = prismic.FieldState,
 > = {
-	/**
-	 * A list of potential documents to which the field can be linked.
-	 */
-	linkableDocuments?: prismic.PrismicDocument[];
+	/** A list of potential documents to which the field can be linked. */
+	linkableDocuments?: prismic.PrismicDocument[]
 } & MockValueConfig<Model> &
-	MockValueStateConfig<State>;
+	MockValueStateConfig<State>
 
-type MockContentRelationshipValue<
-	Model extends
-		prismic.CustomTypeModelContentRelationshipField = prismic.CustomTypeModelContentRelationshipField,
+export type MockContentRelationshipValue<
+	Model extends prismic.CustomTypeModelContentRelationshipField =
+		prismic.CustomTypeModelContentRelationshipField,
 	State extends prismic.FieldState = prismic.FieldState,
 > = prismic.ContentRelationshipField<
 	IterableElement<NonNullable<Model["config"]>["customtypes"]>,
 	string,
 	never,
 	State
->;
+>
 
 export const contentRelationship = <
-	Model extends
-		prismic.CustomTypeModelContentRelationshipField = prismic.CustomTypeModelContentRelationshipField,
+	Model extends prismic.CustomTypeModelContentRelationshipField =
+		prismic.CustomTypeModelContentRelationshipField,
 	State extends prismic.FieldState = "filled",
 >(
 	config: MockContentRelationshipValueConfig<Model, State>,
 ): MockContentRelationshipValue<Model, State> => {
-	const faker = config.faker || createFaker(config.seed);
+	const faker = config.faker || createFaker(config.seed)
 
 	if (config.state === "empty") {
 		return {
 			link_type: prismic.LinkType.Document,
-		} as MockContentRelationshipValue<Model, State>;
+		} as MockContentRelationshipValue<Model, State>
 	} else {
-		const model = config.model || modelGen.contentRelationship({ faker });
+		const model = config.model || modelGen.contentRelationship({ faker })
 
 		const linkableDocuments = config.linkableDocuments
-			? config.linkableDocuments.filter(
-					(
-						document,
-					): document is prismic.PrismicDocument<
-						never,
-						NonNullable<NonNullable<Model["config"]>["customtypes"]>[number]
-					> => {
-						let shouldKeep = true;
+			? config.linkableDocuments.filter((document) => {
+					let shouldKeep = true
 
-						if (model.config?.customtypes) {
-							shouldKeep =
-								shouldKeep && model.config.customtypes.includes(document.type);
-						}
+					if (model.config?.customtypes) {
+						shouldKeep = shouldKeep && model.config.customtypes.includes(document.type)
+					}
 
-						if (model.config?.tags) {
-							shouldKeep =
-								shouldKeep &&
-								model.config.tags.some((tag) => document.tags.includes(tag));
-						}
+					if (model.config?.tags) {
+						shouldKeep = shouldKeep && model.config.tags.some((tag) => document.tags.includes(tag))
+					}
 
-						return shouldKeep;
-					},
-				)
+					return shouldKeep
+				})
 			: [
 					{
 						...documentGen({ faker }),
@@ -87,20 +68,17 @@ export const contentRelationship = <
 						tags: model.config?.tags
 							? faker.randomElements(model.config.tags)
 							: generateTags({ faker }),
-					} as prismic.PrismicDocument<
-						never,
-						NonNullable<NonNullable<Model["config"]>["customtypes"]>[number]
-					>,
-				];
+					} as prismic.PrismicDocument,
+				]
 
-		const document = faker.randomElement(linkableDocuments);
+		const document = faker.randomElement(linkableDocuments as prismic.PrismicDocument[])
 
 		if (!document) {
-			throw new Error("A linkable document could not be found.");
+			throw new Error("A linkable document could not be found.")
 		}
 
 		return buildContentRelationshipField({
 			document,
-		}) as unknown as MockContentRelationshipValue<Model, State>;
+		}) as unknown as MockContentRelationshipValue<Model, State>
 	}
-};
+}