support link text with boolean config & empty link

prismicio · Sep 9, 2024 · 732816c · 732816c
1 parent 68ff687
commit 732816c
Show file tree

Hide file tree

Showing 10 changed files with 113 additions and 16 deletions.
diff --git a/src/types/model/contentRelationship.ts b/src/types/model/contentRelationship.ts
@@ -1,6 +1,5 @@
 import type { CustomTypeModelFieldType } from "./types"
 
-import type { CustomTypeModelKeyTextField } from "./keyText"
 import type { CustomTypeModelLinkSelectType } from "./link"
 
 /**
@@ -19,6 +18,5 @@ export interface CustomTypeModelContentRelationshipField<
 		select: typeof CustomTypeModelLinkSelectType.Document
 		customtypes?: readonly CustomTypeIDs[]
 		tags?: readonly Tags[]
-		text?: CustomTypeModelKeyTextField
 	}
 }
diff --git a/src/types/model/link.ts b/src/types/model/link.ts
@@ -1,7 +1,5 @@
 import type { CustomTypeModelFieldType } from "./types"
 
-import type { CustomTypeModelKeyTextField } from "./keyText"
-
 /**
  * A link custom type field.
  *
@@ -15,7 +13,7 @@ export interface CustomTypeModelLinkField {
 		select?:
 			| null
 			| (typeof CustomTypeModelLinkSelectType)[keyof typeof CustomTypeModelLinkSelectType]
-		text?: CustomTypeModelKeyTextField
+		allowText?: boolean
 		allowTargetBlank?: boolean
 	}
 }

diff --git a/src/types/model/linkToMedia.ts b/src/types/model/linkToMedia.ts
@@ -1,6 +1,5 @@
 import type { CustomTypeModelFieldType } from "./types"
 
-import type { CustomTypeModelKeyTextField } from "./keyText"
 import type { CustomTypeModelLinkSelectType } from "./link"
 
 /**
@@ -14,6 +13,6 @@ export interface CustomTypeModelLinkToMediaField {
 		label?: string | null
 		placeholder?: string
 		select: typeof CustomTypeModelLinkSelectType.Media
-		text?: CustomTypeModelKeyTextField
+		allowText?: boolean
 	}
 }
diff --git a/src/types/value/link.ts b/src/types/value/link.ts
@@ -24,6 +24,7 @@ export type EmptyLinkField<
 	Type extends (typeof LinkType)[keyof typeof LinkType] = typeof LinkType.Any,
 > = {
 	link_type: Type | string
+	text?: string
 }
 
 /**

diff --git a/test/types/customType-contentRelationship.types.ts b/test/types/customType-contentRelationship.types.ts
@@ -104,9 +104,6 @@ expectType<prismic.CustomTypeModelContentRelationshipField>({
 	config: {
 		label: "string",
 		select: prismic.CustomTypeModelLinkSelectType.Document,
-		text: {
-			type: prismic.CustomTypeModelFieldType.Text,
-		},
 	},
 })
 

diff --git a/test/types/customType-link.types.ts b/test/types/customType-link.types.ts
@@ -67,9 +67,7 @@ expectType<prismic.CustomTypeModelLinkField>({
 	type: prismic.CustomTypeModelFieldType.Link,
 	config: {
 		label: "string",
-		text: {
-			type: prismic.CustomTypeModelFieldType.Text,
-		},
+		allowText: true,
 	},
 })
 

diff --git a/test/types/customType-linkToMedia.types.ts b/test/types/customType-linkToMedia.types.ts
@@ -48,9 +48,7 @@ expectType<prismic.CustomTypeModelLinkToMediaField>({
 	config: {
 		label: "string",
 		select: prismic.CustomTypeModelLinkSelectType.Media,
-		text: {
-			type: prismic.CustomTypeModelFieldType.Text,
-		},
+		allowText: true,
 	},
 })
 

diff --git a/test/types/fields-contentRelationship.types.ts b/test/types/fields-contentRelationship.types.ts
@@ -78,6 +78,25 @@ expectType<prismic.ContentRelationshipField<string, string, never, "filled">>(
 	},
 )
 
+/**
+ * Empty state with text.
+ */
+expectType<prismic.ContentRelationshipField>({
+	link_type: prismic.LinkType.Document,
+	text: "string",
+})
+expectType<prismic.ContentRelationshipField<string, string, never, "empty">>({
+	link_type: prismic.LinkType.Document,
+	text: "string",
+})
+expectType<prismic.ContentRelationshipField<string, string, never, "filled">>(
+	// @ts-expect-error - Filled fields cannot contain an empty value.
+	{
+		link_type: prismic.LinkType.Document,
+		text: "string",
+	},
+)
+
 /**
  * Supports custom document type.
  */

diff --git a/test/types/fields-link.types.ts b/test/types/fields-link.types.ts
@@ -88,12 +88,82 @@ expectType<prismic.LinkField<string, string, never, "empty">>({
 expectType<prismic.LinkField>({
 	link_type: prismic.LinkType.Any,
 })
+expectType<prismic.LinkField<string, string, never, "filled">>({
+	// @ts-expect-error - Filled fields cannot contain an empty value.
+	link_type: prismic.LinkType.Any,
+})
+expectType<prismic.LinkField>({
+	link_type: prismic.LinkType.Web,
+})
+expectType<prismic.LinkField<string, string, never, "filled">>(
+	// @ts-expect-error - Filled fields cannot contain an empty value.
+	{
+		link_type: prismic.LinkType.Web,
+	},
+)
+expectType<prismic.LinkField>({
+	link_type: prismic.LinkType.Document,
+})
+expectType<prismic.LinkField<string, string, never, "filled">>(
+	// @ts-expect-error - Filled fields cannot contain an empty value.
+	{
+		link_type: prismic.LinkType.Document,
+	},
+)
+expectType<prismic.LinkField>({
+	link_type: prismic.LinkType.Media,
+})
+expectType<prismic.LinkField<string, string, never, "filled">>(
+	// @ts-expect-error - Filled fields cannot contain an empty value.
+	{
+		link_type: prismic.LinkType.Media,
+	},
+)
+
+/**
+ * Empty state with text.
+ */
+expectType<prismic.LinkField<string, string, never, "empty">>({
+	link_type: prismic.LinkType.Web,
+	text: "string",
+})
+expectType<prismic.LinkField<string, string, never, "filled">>(
+	// @ts-expect-error - Filled fields cannot contain an empty value.
+	{
+		link_type: prismic.LinkType.Web,
+		text: "string",
+	},
+)
+expectType<prismic.LinkField<string, string, never, "empty">>({
+	link_type: prismic.LinkType.Document,
+	text: "string",
+})
+expectType<prismic.LinkField<string, string, never, "filled">>(
+	// @ts-expect-error - Filled fields cannot contain an empty value.
+	{
+		link_type: prismic.LinkType.Document,
+		text: "string",
+	},
+)
+expectType<prismic.LinkField<string, string, never, "empty">>({
+	link_type: prismic.LinkType.Media,
+	text: "string",
+})
+expectType<prismic.LinkField<string, string, never, "filled">>(
+	// @ts-expect-error - Filled fields cannot contain an empty value.
+	{
+		link_type: prismic.LinkType.Media,
+		text: "string",
+	},
+)
 expectType<prismic.LinkField<string, string, never, "empty">>({
 	link_type: prismic.LinkType.Any,
+	text: "string",
 })
 expectType<prismic.LinkField<string, string, never, "filled">>({
 	// @ts-expect-error - Filled fields cannot contain an empty value.
 	link_type: prismic.LinkType.Any,
+	text: "string",
 })
 
 /**

diff --git a/test/types/fields-linkToMedia.types.ts b/test/types/fields-linkToMedia.types.ts
@@ -71,3 +71,22 @@ expectType<prismic.LinkToMediaField<"filled">>(
 		link_type: prismic.LinkType.Media,
 	},
 )
+
+/**
+ * Empty state with text.
+ */
+expectType<prismic.LinkToMediaField>({
+	link_type: prismic.LinkType.Media,
+	text: "string",
+})
+expectType<prismic.LinkToMediaField<"empty">>({
+	link_type: prismic.LinkType.Media,
+	text: "string",
+})
+expectType<prismic.LinkToMediaField<"filled">>(
+	// @ts-expect-error - Filled fields cannot contain an empty value.
+	{
+		link_type: prismic.LinkType.Media,
+		text: "string",
+	},
+)
-Original file line number
+Diff line change
@@ Expand Up / @@ -24,6 +24,7 @@ export type EmptyLinkField< @@
     	Type extends (typeof LinkType)[keyof typeof LinkType] = typeof LinkType.Any,
     > = {
     	link_type: Type | string
+    	text?: string
     }
     /**
@@ Expand Down @@