feat: add support for repeatable links in models (#355)

* chore: bump types-internal dep * feat: support repeatable links in models * Bump types internal * Remove repeat from content rel. and link to media * Add Repeatable (#360) * Add Repetable to index * chore(release): 7.13.0-alpha.0 * Use stable types internal --------- Co-authored-by: Daniel Martín <[email protected]>
prismicio · Dec 5, 2024 · ed120a8 · ed120a8
1 parent 0cf80dd
commit ed120a8
Show file tree

Hide file tree

Showing 10 changed files with 74 additions and 23 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,18 @@
 
 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.13.0-alpha.0](https://github.com/prismicio/prismic-client/compare/v7.12.0...v7.13.0-alpha.0) (2024-11-28)
+
+
+### Features
+
+* support repeatable links in models ([00f8524](https://github.com/prismicio/prismic-client/commit/00f8524d3df5034e263f74c884a9d78627a37dce))
+
+
+### Chore
+
+* bump types-internal dep ([6a5eb26](https://github.com/prismicio/prismic-client/commit/6a5eb26b1bd3cb26eb68150ce43c081630bcfbfd))
+
 ## [7.12.0](https://github.com/prismicio/prismic-client/compare/v7.11.1...v7.12.0) (2024-10-30)
 
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "@prismicio/client",
-	"version": "7.12.0",
+	"version": "7.13.0-alpha.0",
 	"description": "The official JavaScript + TypeScript client library for Prismic",
 	"keywords": [
 		"typescript",
@@ -83,7 +83,7 @@
 	},
 	"devDependencies": {
 		"@prismicio/mock": "^0.3.9",
-		"@prismicio/types-internal": "^2.8.0",
+		"@prismicio/types-internal": "3.1.0",
 		"@size-limit/preset-small-lib": "^11.1.6",
 		"@trivago/prettier-plugin-sort-imports": "^4.3.0",
 		"@typescript-eslint/eslint-plugin": "^6.21.0",

diff --git a/src/helpers/isFilled.ts b/src/helpers/isFilled.ts
@@ -17,7 +17,7 @@ import type { Slice } from "../types/value/slice"
 import type { SliceZone } from "../types/value/sliceZone"
 import type { TimestampField } from "../types/value/timestamp"
 import type { TitleField } from "../types/value/title"
-import type { AnyRegularField } from "../types/value/types"
+import type { AnyRegularField, Repeatable } from "../types/value/types"
 
 /**
  * Determines if a value is not nullish (i.e. not `null` or `undefined`). This
@@ -266,6 +266,20 @@ export const integrationField = isNonNullish as <
 // TODO: Remove when we remove support for deprecated `integrationFields` export.
 export const integrationFields = integrationField
 
+/**
+ * Determines if a repeatable field has at least one item.
+ *
+ * @param repeatable - Repeatable to check.
+ *
+ * @returns `true` if `repeatable` contains at least one item, `false`
+ *   otherwise.
+ */
+export const repeatable = <T extends LinkField>(
+	repeatable: Repeatable<T> | null | undefined,
+): repeatable is Repeatable<T, "filled"> => {
+	return isNonNullish(repeatable) && isNonEmptyArray(repeatable)
+}
+
 /**
  * Determines if a Group has at least one item.
  *

diff --git a/src/index.ts b/src/index.ts
@@ -246,6 +246,7 @@ export type {
 	FieldState,
 	AnyRegularField,
 	AnySlicePrimaryField,
+	Repeatable,
 } from "./types/value/types"
 
 // Models - Types representing Prismic content models.

diff --git a/src/types/model/link.ts b/src/types/model/link.ts
@@ -15,6 +15,7 @@ export interface CustomTypeModelLinkField {
 			| (typeof CustomTypeModelLinkSelectType)[keyof typeof CustomTypeModelLinkSelectType]
 		allowText?: boolean
 		allowTargetBlank?: boolean
+		repeat?: boolean
 	}
 }
 

diff --git a/src/types/value/types.ts b/src/types/value/types.ts
@@ -35,6 +35,7 @@ export type AnyRegularField =
 	| ImageField
 	| ContentRelationshipField
 	| LinkField
+	| Repeatable<LinkField>
 	| LinkToMediaField
 	| EmbedField
 	| DateField
@@ -52,6 +53,14 @@ export type AnyRegularField =
  */
 export type AnySlicePrimaryField = GroupField | AnyRegularField
 
+/**
+ * A list of repeatable fields.
+ */
+export type Repeatable<
+	Field extends LinkField,
+	State extends FieldState = FieldState,
+> = State extends "empty" ? [] : [Field, ...Field[]]
+
 /**
  * Useful to flatten the type output to improve type hints shown in editors. And
  * also to transform an interface into a type to aide with assignability.

diff --git a/test/types/customType-contentRelationship.types.ts b/test/types/customType-contentRelationship.types.ts
@@ -96,6 +96,18 @@ expectType<prismic.CustomTypeModelContentRelationshipField<string, "foo">>({
 	},
 })
 
+/**
+ * Supports optional `allowText` property.
+ */
+expectType<prismic.CustomTypeModelContentRelationshipField<string, "foo">>({
+	type: prismic.CustomTypeModelFieldType.Link,
+	config: {
+		label: "string",
+		select: prismic.CustomTypeModelLinkSelectType.Document,
+		allowText: true,
+	},
+})
+
 /**
  * `@prismicio/types` extends `@prismicio/types-internal`
  */

diff --git a/test/types/customType-link.types.ts b/test/types/customType-link.types.ts
@@ -61,7 +61,7 @@ expectType<prismic.CustomTypeModelLinkField>({
 })
 
 /**
- * Supports optional `text` property.
+ * Supports optional `allowText` property.
  */
 expectType<prismic.CustomTypeModelLinkField>({
 	type: prismic.CustomTypeModelFieldType.Link,
@@ -71,6 +71,17 @@ expectType<prismic.CustomTypeModelLinkField>({
 	},
 })
 
+/**
+ * Supports optional `repeat` property.
+ */
+expectType<prismic.CustomTypeModelLinkField>({
+	type: prismic.CustomTypeModelFieldType.Link,
+	config: {
+		label: "string",
+		repeat: true,
+	},
+})
+
 /**
  * `@prismicio/types` extends `@prismicio/types-internal`
  */

diff --git a/test/types/customType-linkToMedia.types.ts b/test/types/customType-linkToMedia.types.ts
@@ -41,7 +41,7 @@ expectType<prismic.CustomTypeModelLinkToMediaField>({
 })
 
 /**
- * Supports optional `text` property.
+ * Supports optional `allowText` property.
  */
 expectType<prismic.CustomTypeModelLinkToMediaField>({
 	type: prismic.CustomTypeModelFieldType.Link,