feat: add support for text property in link fields

CHANGELOG.md

@@ -2,6 +2,25 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [7.9.0-alpha.2](https://github.com/prismicio/prismic-client/compare/v7.9.0-alpha.1...v7.9.0-alpha.2) (2024-08-27)
+
+
+### Chore
+
+* revert previous changes ([c53de86](https://github.com/prismicio/prismic-client/commit/c53de86a7ed749f0f9d8999b9e58564d9a8efe35))
+
+## [7.9.0-alpha.1](https://github.com/prismicio/prismic-client/compare/v7.9.0-alpha.0...v7.9.0-alpha.1) (2024-08-27)
+
+
+### Features
+
+* use KeyTextField for link text value definition ([1a4c51a](https://github.com/prismicio/prismic-client/commit/1a4c51a389ed4d06cf69c3edcb215559ba91fe99))
+
+
+### Chore
+
+* remove changelog for alpha ([50fc797](https://github.com/prismicio/prismic-client/commit/50fc797372726c0abc575b9f1b0a56d5db939bb1))
+
 ## [7.8.0](https://github.com/prismicio/prismic-client/compare/v7.7.4...v7.8.0) (2024-08-01)
 
 

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@prismicio/client",
-	"version": "7.8.0",
+	"version": "7.9.0-alpha.2",
 	"description": "The official JavaScript + TypeScript client library for Prismic",
 	"keywords": [
 		"typescript",

src/types/model/contentRelationship.ts

@@ -1,5 +1,6 @@
 import type { CustomTypeModelFieldType } from "./types"
 
+import type { CustomTypeModelKeyTextField } from "./keyText"
 import type { CustomTypeModelLinkSelectType } from "./link"
 
 /**
@@ -18,5 +19,6 @@ export interface CustomTypeModelContentRelationshipField<
 		select: typeof CustomTypeModelLinkSelectType.Document
 		customtypes?: readonly CustomTypeIDs[]
 		tags?: readonly Tags[]
+		text?: CustomTypeModelKeyTextField
 	}
 }

src/types/model/link.ts

@@ -1,5 +1,7 @@
 import type { CustomTypeModelFieldType } from "./types"
 
+import type { CustomTypeModelKeyTextField } from "./keyText"
+
 /**
  * A link custom type field.
  *
@@ -13,6 +15,7 @@ export interface CustomTypeModelLinkField {
 		select?:
 			| null
 			| (typeof CustomTypeModelLinkSelectType)[keyof typeof CustomTypeModelLinkSelectType]
+		text?: CustomTypeModelKeyTextField
 		allowTargetBlank?: boolean
 	}
 }

src/types/model/linkToMedia.ts

@@ -1,5 +1,6 @@
 import type { CustomTypeModelFieldType } from "./types"
 
+import type { CustomTypeModelKeyTextField } from "./keyText"
 import type { CustomTypeModelLinkSelectType } from "./link"
 
 /**
@@ -13,5 +14,6 @@ export interface CustomTypeModelLinkToMediaField {
 		label?: string | null
 		placeholder?: string
 		select: typeof CustomTypeModelLinkSelectType.Media
+		text?: CustomTypeModelKeyTextField
 	}
 }

src/types/value/contentRelationship.ts

@@ -44,4 +44,5 @@ export interface FilledContentRelationshipField<
 	slug?: string
 	isBroken?: boolean
 	data?: DataInterface
+	text?: string
 }

src/types/value/link.ts

@@ -33,6 +33,7 @@ export interface FilledLinkToWebField {
 	link_type: typeof LinkType.Web
 	url: string
 	target?: string
+	text?: string
 }
 
 /**

src/types/value/linkToMedia.ts

@@ -24,4 +24,5 @@ export interface FilledLinkToMediaField {
 	size: string
 	height?: string | null
 	width?: string | null
+	text?: string
 }

test/types/customType-contentRelationship.types.ts

@@ -96,6 +96,20 @@ expectType<prismic.CustomTypeModelContentRelationshipField<string, "foo">>({
 	},
 })
 
+/**
+ * Supports optional `text` property.
+ */
+expectType<prismic.CustomTypeModelContentRelationshipField>({
+	type: prismic.CustomTypeModelFieldType.Link,
+	config: {
+		label: "string",
+		select: prismic.CustomTypeModelLinkSelectType.Document,
+		text: {
+			type: prismic.CustomTypeModelFieldType.Text,
+		},
+	},
+})
+
 /**
  * `@prismicio/types` extends `@prismicio/types-internal`
  */

test/types/customType-link.types.ts

@@ -60,6 +60,19 @@ expectType<prismic.CustomTypeModelLinkField>({
 	},
 })
 
+/**
+ * Supports optional `text` property.
+ */
+expectType<prismic.CustomTypeModelLinkField>({
+	type: prismic.CustomTypeModelFieldType.Link,
+	config: {
+		label: "string",
+		text: {
+			type: prismic.CustomTypeModelFieldType.Text,
+		},
+	},
+})
+
 /**
  * `@prismicio/types` extends `@prismicio/types-internal`
  */

test/types/customType-linkToMedia.types.ts

@@ -40,6 +40,20 @@ expectType<prismic.CustomTypeModelLinkToMediaField>({
 	},
 })
 
+/**
+ * Supports optional `text` property.
+ */
+expectType<prismic.CustomTypeModelLinkToMediaField>({
+	type: prismic.CustomTypeModelFieldType.Link,
+	config: {
+		label: "string",
+		select: prismic.CustomTypeModelLinkSelectType.Media,
+		text: {
+			type: prismic.CustomTypeModelFieldType.Text,
+		},
+	},
+})
+
 /**
  * `@prismicio/types` extends `@prismicio/types-internal`
  */

test/types/fields-contentRelationship.types.ts

@@ -32,6 +32,7 @@ expectType<prismic.ContentRelationshipField>({
 	slug: "string",
 	isBroken: true,
 	data: undefined,
+	text: "string",
 })
 expectType<prismic.ContentRelationshipField<string, string, never, "filled">>({
 	link_type: prismic.LinkType.Document,
@@ -44,6 +45,7 @@ expectType<prismic.ContentRelationshipField<string, string, never, "filled">>({
 	slug: "string",
 	isBroken: true,
 	data: undefined,
+	text: "string",
 })
 expectType<prismic.ContentRelationshipField<string, string, never, "empty">>({
 	link_type: prismic.LinkType.Document,
@@ -57,6 +59,7 @@ expectType<prismic.ContentRelationshipField<string, string, never, "empty">>({
 	slug: "string",
 	isBroken: true,
 	data: undefined,
+	text: "string",
 })
 
 /**

test/types/fields-link.types.ts

@@ -41,6 +41,7 @@ expectType<prismic.LinkField>({
 	link_type: prismic.LinkType.Web,
 	url: "string",
 	target: "string",
+	text: "string",
 })
 // Content relationship link
 expectType<prismic.LinkField>({
@@ -54,6 +55,7 @@ expectType<prismic.LinkField>({
 	slug: "string",
 	isBroken: true,
 	data: undefined,
+	text: "string",
 })
 // Media link
 expectType<prismic.LinkField>({
@@ -64,17 +66,20 @@ expectType<prismic.LinkField>({
 	size: "string",
 	height: "string",
 	width: "string",
+	text: "string",
 })
 expectType<prismic.LinkField<string, string, never, "filled">>({
 	link_type: prismic.LinkType.Web,
 	url: "string",
 	target: "string",
+	text: "string",
 })
 expectType<prismic.LinkField<string, string, never, "empty">>({
 	link_type: prismic.LinkType.Web,
 	// @ts-expect-error - Empty fields cannot contain a filled value.
 	url: "string",
 	target: "string",
+	text: "string",
 })
 
 /**

test/types/fields-linkToMedia.types.ts

@@ -30,6 +30,7 @@ expectType<prismic.LinkToMediaField>({
 	size: "string",
 	height: "string",
 	width: "string",
+	text: "string",
 })
 expectType<prismic.LinkToMediaField<"filled">>({
 	id: "string",
@@ -40,6 +41,7 @@ expectType<prismic.LinkToMediaField<"filled">>({
 	size: "string",
 	height: "string",
 	width: "string",
+	text: "string",
 })
 expectType<prismic.LinkToMediaField<"empty">>({
 	link_type: prismic.LinkType.Media,
@@ -51,6 +53,7 @@ expectType<prismic.LinkToMediaField<"empty">>({
 	size: "string",
 	height: "string",
 	width: "string",
+	text: "string",
 })
 
 /**