feat: support link variants (#368)

* refactor: link types * refactor: clean up after self-review * feat: support link variants * test: remove unnecessary test * refactor: fix name of `getOptionalLinkProperties` file * fix(migration): only include optional link properties in links * docs: add `MaybeLink` description * test: update test * fix: add optional link fields to link to media migration fields * fix(migration): add missing `text` property on link to media * Revert "fix: add optional link fields to link to media migration fields" This reverts commit 6f89eee. * Revert "fix(migration): add missing `text` property on link to media" This reverts commit 27839cf. --------- Co-authored-by: Daniel Martín <danimartinprieto@gmail.com>
prismicio · Dec 23, 2024 · a9f4a25 · a9f4a25
1 parent f4bf4e6
commit a9f4a25
Show file tree

Hide file tree

Showing 7 changed files with 238 additions and 4 deletions.
diff --git a/src/lib/getOptionalLinkProperties.ts b/src/lib/getOptionalLinkProperties.ts
@@ -19,5 +19,9 @@ export const getOptionalLinkProperties = (
 		res.text = input.text
 	}
 
+	if ("variant" in input) {
+		res.variant = input.variant
+	}
+
 	return res
 }
diff --git a/src/types/model/link.ts b/src/types/model/link.ts
@@ -16,6 +16,7 @@ export interface CustomTypeModelLinkField {
 		allowText?: boolean
 		allowTargetBlank?: boolean
 		repeat?: boolean
+		variants?: string[]
 	}
 }
 

diff --git a/src/types/value/link.ts b/src/types/value/link.ts
@@ -89,4 +89,5 @@ export type FilledLinkToWebField = {
 // this type. The function should check for every property.
 export type OptionalLinkProperties = {
 	text?: string
+	variant?: string
 }
diff --git a/test/__snapshots__/writeClient-migrate-patch-contentRelationship.test.ts.snap b/test/__snapshots__/writeClient-migrate-patch-contentRelationship.test.ts.snap
@@ -266,6 +266,97 @@ exports[`patches content relationship fields (from Prismic) > withText > static
 }
 `;
 
+exports[`patches content relationship fields (from Prismic) > withVariant > group 1`] = `
+{
+  "group": [
+    {
+      "field": {
+        "id": "other.id-fromPrismic",
+        "link_type": "Document",
+        "variant": "Secondary",
+      },
+    },
+  ],
+}
+`;
+
+exports[`patches content relationship fields (from Prismic) > withVariant > shared slice 1`] = `
+{
+  "slices": [
+    {
+      "id": "9b9dd0f2c3f",
+      "items": [
+        {
+          "field": {
+            "id": "other.id-fromPrismic",
+            "link_type": "Document",
+            "variant": "Secondary",
+          },
+        },
+      ],
+      "primary": {
+        "field": {
+          "id": "other.id-fromPrismic",
+          "link_type": "Document",
+          "variant": "Secondary",
+        },
+        "group": [
+          {
+            "field": {
+              "id": "other.id-fromPrismic",
+              "link_type": "Document",
+              "variant": "Secondary",
+            },
+          },
+        ],
+      },
+      "slice_label": null,
+      "slice_type": "nunc",
+      "variation": "ullamcorper",
+      "version": "8bfc905",
+    },
+  ],
+}
+`;
+
+exports[`patches content relationship fields (from Prismic) > withVariant > slice 1`] = `
+{
+  "slices": [
+    {
+      "id": "5306297c5ed",
+      "items": [
+        {
+          "field": {
+            "id": "other.id-fromPrismic",
+            "link_type": "Document",
+            "variant": "Secondary",
+          },
+        },
+      ],
+      "primary": {
+        "field": {
+          "id": "other.id-fromPrismic",
+          "link_type": "Document",
+          "variant": "Secondary",
+        },
+      },
+      "slice_label": "Vel",
+      "slice_type": "hac_habitasse",
+    },
+  ],
+}
+`;
+
+exports[`patches content relationship fields (from Prismic) > withVariant > static zone 1`] = `
+{
+  "field": {
+    "id": "other.id-fromPrismic",
+    "link_type": "Document",
+    "variant": "Secondary",
+  },
+}
+`;
+
 exports[`patches content relationship fields > existing > group 1`] = `
 {
   "group": [
@@ -525,6 +616,97 @@ exports[`patches content relationship fields > existingLongFormWithText > static
 }
 `;
 
+exports[`patches content relationship fields > existingLongFormWithVariant > group 1`] = `
+{
+  "group": [
+    {
+      "field": {
+        "id": "other.id-existing",
+        "link_type": "Document",
+        "variant": "Secondary",
+      },
+    },
+  ],
+}
+`;
+
+exports[`patches content relationship fields > existingLongFormWithVariant > shared slice 1`] = `
+{
+  "slices": [
+    {
+      "id": "9b9dd0f2c3f",
+      "items": [
+        {
+          "field": {
+            "id": "other.id-existing",
+            "link_type": "Document",
+            "variant": "Secondary",
+          },
+        },
+      ],
+      "primary": {
+        "field": {
+          "id": "other.id-existing",
+          "link_type": "Document",
+          "variant": "Secondary",
+        },
+        "group": [
+          {
+            "field": {
+              "id": "other.id-existing",
+              "link_type": "Document",
+              "variant": "Secondary",
+            },
+          },
+        ],
+      },
+      "slice_label": null,
+      "slice_type": "nunc",
+      "variation": "ullamcorper",
+      "version": "8bfc905",
+    },
+  ],
+}
+`;
+
+exports[`patches content relationship fields > existingLongFormWithVariant > slice 1`] = `
+{
+  "slices": [
+    {
+      "id": "5306297c5ed",
+      "items": [
+        {
+          "field": {
+            "id": "other.id-existing",
+            "link_type": "Document",
+            "variant": "Secondary",
+          },
+        },
+      ],
+      "primary": {
+        "field": {
+          "id": "other.id-existing",
+          "link_type": "Document",
+          "variant": "Secondary",
+        },
+      },
+      "slice_label": "Vel",
+      "slice_type": "hac_habitasse",
+    },
+  ],
+}
+`;
+
+exports[`patches content relationship fields > existingLongFormWithVariant > static zone 1`] = `
+{
+  "field": {
+    "id": "other.id-existing",
+    "link_type": "Document",
+    "variant": "Secondary",
+  },
+}
+`;
+
 exports[`patches content relationship fields > lazyExisting > group 1`] = `
 {
   "group": [

diff --git a/test/types/customType-link.types.ts b/test/types/customType-link.types.ts
@@ -82,6 +82,16 @@ expectType<prismic.CustomTypeModelLinkField>({
 	},
 })
 
+/**
+ * Supports optional `variants` property.
+ */
+expectType<prismic.CustomTypeModelLinkField>({
+	type: prismic.CustomTypeModelFieldType.Link,
+	config: {
+		variants: ["string"],
+	},
+})
+
 /**
  * `@prismicio/types` extends `@prismicio/types-internal`
  */

diff --git a/test/types/fields-link.types.ts b/test/types/fields-link.types.ts
@@ -41,6 +41,7 @@ expectType<prismic.LinkField>({
 	url: "string",
 	target: "string",
 	text: "string",
+	variant: "string",
 })
 expectType<prismic.LinkField>({
 	link_type: prismic.LinkType.Document,
@@ -54,6 +55,7 @@ expectType<prismic.LinkField>({
 	isBroken: true,
 	data: undefined,
 	text: "string",
+	variant: "string",
 })
 expectType<prismic.LinkField>({
 	link_type: prismic.LinkType.Media,
@@ -65,19 +67,22 @@ expectType<prismic.LinkField>({
 	height: "string",
 	width: "string",
 	text: "string",
+	variant: "string",
 })
 expectType<prismic.LinkField<string, string, never, "filled">>({
 	link_type: prismic.LinkType.Web,
 	url: "string",
 	target: "string",
 	text: "string",
+	variant: "string",
 })
 expectType<prismic.LinkField<string, string, never, "empty">>({
 	// @ts-expect-error - Empty fields cannot contain a filled link type.
 	link_type: prismic.LinkType.Web,
 	url: "string",
 	target: "string",
 	text: "string",
+	variant: "string",
 })
 
 /**
@@ -144,6 +149,18 @@ expectType<prismic.LinkField<string, string, never, "filled">>({
 	text: "string",
 })
 
+/**
+ * Empty state with variant.
+ */
+expectType<prismic.LinkField>({
+	link_type: prismic.LinkType.Any,
+	variant: "string",
+})
+expectType<prismic.LinkField<string, string, never, "empty">>({
+	link_type: prismic.LinkType.Any,
+	variant: "string",
+})
+
 /**
  * Supports custom document type for document links.
  */

diff --git a/test/writeClient-migrate-patch-contentRelationship.test.ts b/test/writeClient-migrate-patch-contentRelationship.test.ts
@@ -25,6 +25,13 @@ testMigrationFieldPatching<
 			text: "foo",
 		}
 	},
+	existingLongFormWithVariant: ({ existingDocuments }) => {
+		return {
+			link_type: LinkType.Document,
+			id: existingDocuments[0],
+			variant: "Secondary",
+		}
+	},
 	otherCreate: ({ otherCreateDocument }) => otherCreateDocument,
 	lazyExisting: ({ existingDocuments }) => {
 		return () => existingDocuments[0]
@@ -86,11 +93,23 @@ testMigrationFieldPatching<ContentRelationshipField>(
 			contentRelationship.id =
 				otherFromPrismicDocument.originalPrismicDocument!.id
 
-			// TODO: Remove when link text PR is merged
-			// @ts-expect-error - Future-proofing for link text
-			contentRelationship.text = "foo"
+			return {
+				...contentRelationship,
+				text: "foo",
+			}
+		},
+		withVariant: ({ ctx, otherFromPrismicDocument }) => {
+			const contentRelationship = ctx.mock.value.link({
+				type: LinkType.Document,
+			})
+			// `migrationDocuments` contains documents from "another repository"
+			contentRelationship.id =
+				otherFromPrismicDocument.originalPrismicDocument!.id
 
-			return contentRelationship
+			return {
+				...contentRelationship,
+				variant: "Secondary",
+			}
 		},
 		broken: () => {
 			return {