feat: return alternative language documents for mock documents

src/lib/buildAlternativeLanguage.ts

@@ -0,0 +1,18 @@
+import * as prismicT from "@prismicio/types";
+
+type BuildEmbedFieldConfig<Document extends prismicT.PrismicDocument> = {
+	document: Document;
+};
+
+export const buildAlternativeLanguage = <
+	Document extends prismicT.PrismicDocument,
+>(
+	config: BuildEmbedFieldConfig<Document>,
+): prismicT.AlternateLanguage<Document["type"], Document["lang"]> => {
+	return {
+		id: config.document.id,
+		type: config.document.type,
+		lang: config.document.lang,
+		uid: config.document.uid || undefined,
+	};
+};

src/lib/buildContentRelationshipField.ts

@@ -1,12 +1,14 @@
 import * as prismicT from "@prismicio/types";
 
-type BuildEmbedFieldConfig = {
-	document: prismicT.PrismicDocument;
+type BuildEmbedFieldConfig<Document extends prismicT.PrismicDocument> = {
+	document: Document;
 };
 
-export const buildContentRelationshipField = (
-	config: BuildEmbedFieldConfig,
-): prismicT.FilledLinkToDocumentField => {
+export const buildContentRelationshipField = <
+	Document extends prismicT.PrismicDocument,
+>(
+	config: BuildEmbedFieldConfig<Document>,
+): prismicT.FilledLinkToDocumentField<Document["type"], Document["lang"]> => {
 	return {
 		link_type: prismicT.LinkType.Document,
 		id: config.document.id,

src/value/customType.ts

@@ -13,12 +13,13 @@ import { MockValueConfig, ModelValue } from "../types";
 import * as modelGen from "../model";
 
 import { timestamp } from "./timestamp";
+import { buildAlternativeLanguage } from "../lib/buildAlternativeLanguage";
 
 export type MockCustomTypeValueConfig<
 	Model extends prismicT.CustomTypeModel = prismicT.CustomTypeModel,
 > = {
 	withURL?: boolean;
-	sharedSliceModels?: prismicT.SharedSliceModel[];
+	alternateLanguages?: prismicT.PrismicDocument[];
 	configs?: ValueForModelMapConfigs;
 } & MockValueConfig<Model>;
 
@@ -53,6 +54,13 @@ export const customType = <
 
 	const withURL = config.withURL ?? true;
 
+	const alternateLanguages = (config.alternateLanguages || []).map(
+		(alternateLanguageDocument) =>
+			buildAlternativeLanguage({
+				document: alternateLanguageDocument,
+			}),
+	);
+
 	return {
 		type: model.id,
 		id: faker.git.shortSha(),
@@ -63,7 +71,7 @@ export const customType = <
 		tags: generateTags({ seed: config.seed }),
 		slugs: [] as prismicT.PrismicDocument["slugs"],
 		linked_documents: [] as prismicT.PrismicDocument["linked_documents"],
-		alternate_languages: [] as prismicT.PrismicDocument["alternate_languages"],
+		alternate_languages: alternateLanguages,
 		first_publication_date: timestamp({ seed: config.seed }),
 		last_publication_date: timestamp({ seed: config.seed }),
 		data: valueForModelMap({

test/value-customType.test.ts

@@ -83,3 +83,21 @@ test("uid field is not included in data field", (t) => {
 	t.is(typeof actual.uid, "string");
 	t.false(uidFieldName in actual.data);
 });
+
+test("can be configured to return value with alternative languages", (t) => {
+	const customModel = model.customType();
+	const alternateLanguages = [
+		value.customType({ model: customModel }),
+		value.customType({ model: customModel }),
+	];
+
+	const actual = value.customType({
+		model: customModel,
+		alternateLanguages,
+	});
+
+	t.deepEqual(
+		actual.alternate_languages.map((item) => item.id),
+		alternateLanguages.map((alternateLanguage) => alternateLanguage.id),
+	);
+});