feat: backport extended media API response (#58)

Co-authored-by: lihbr <[email protected]>
prismicio · May 24, 2024 · ef1d286 · ef1d286
1 parent 9971531
commit ef1d286
Show file tree

Hide file tree

Showing 6 changed files with 46 additions and 0 deletions.
diff --git a/src/value/image.ts b/src/value/image.ts
@@ -11,18 +11,27 @@ export type ImageFieldImage<State extends FieldState = FieldState> =
 	State extends "empty" ? EmptyImageFieldImage : FilledImageFieldImage;
 
 export interface FilledImageFieldImage {
+	id: string;
 	url: string;
 	dimensions: {
 		width: number;
 		height: number;
 	};
+	edit: {
+		x: number;
+		y: number;
+		zoom: number;
+		background: string;
+	};
 	alt: string | null;
 	copyright: string | null;
 }
 
 export interface EmptyImageFieldImage {
+	id?: null;
 	url?: null;
 	dimensions?: null;
+	edit?: null;
 	alt?: null;
 	copyright?: null;
 }

diff --git a/src/value/linkToMedia.ts b/src/value/linkToMedia.ts
@@ -15,6 +15,7 @@ export type LinkToMediaField<State extends FieldState = FieldState> =
  * Link that points to media
  */
 export interface FilledLinkToMediaField {
+	id: string;
 	link_type: typeof LinkType.Media;
 	name: string;
 	kind: string;

diff --git a/src/value/richText.ts b/src/value/richText.ts
@@ -152,13 +152,20 @@ export interface RTLabelNode extends RTSpanNodeBase {
  */
 export type RTImageNode = {
 	type: typeof RichTextNodeType.image;
+	id: string;
 	url: string;
 	alt: string | null;
 	copyright: string | null;
 	dimensions: {
 		width: number;
 		height: number;
 	};
+	edit: {
+		x: number;
+		y: number;
+		zoom: number;
+		background: string;
+	};
 	linkTo?:
 		| FilledContentRelationshipField
 		| FilledLinkToWebField

diff --git a/test/fields-image.types.ts b/test/fields-image.types.ts
@@ -22,23 +22,31 @@ import * as prismicT from "../src";
  * Filled state.
  */
 expectType<prismicT.ImageField>({
+	id: "id",
 	url: "url",
 	dimensions: { width: 1, height: 1 },
+	edit: { x: 0, y: 0, zoom: 1, background: "background" },
 	alt: "alt",
 	copyright: "copyright",
 });
 expectType<prismicT.ImageField<never, "filled">>({
+	id: "id",
 	url: "url",
 	dimensions: { width: 1, height: 1 },
+	edit: { x: 0, y: 0, zoom: 1, background: "background" },
 	alt: "alt",
 	copyright: "copyright",
 });
 expectType<prismicT.ImageField<never, "empty">>({
+	// @ts-expect-error - Empty fields cannot contain an empty value.
+	id: "id",
 	// @ts-expect-error - Empty fields cannot contain a filled value.
 	url: "url",
 	// @ts-expect-error - Empty fields cannot contain a filled value.
 	dimensions: { width: 1, height: 1 },
 	// @ts-expect-error - Empty fields cannot contain a filled value.
+	edit: { x: 0, y: 0, zoom: 1, background: "background" },
+	// @ts-expect-error - Empty fields cannot contain a filled value.
 	alt: "alt",
 	// @ts-expect-error - Empty fields cannot contain a filled value.
 	copyright: "copyright",
@@ -61,10 +69,14 @@ expectType<prismicT.ImageField<never, "empty">>({
 	copyright: null,
 });
 expectType<prismicT.ImageField<never, "filled">>({
+	// @ts-expect-error - Filled fields cannot contain an empty value.
+	id: null,
 	// @ts-expect-error - Filled fields cannot contain an empty value.
 	url: null,
 	// @ts-expect-error - Filled fields cannot contain an empty value.
 	dimensions: null,
+	// @ts-expect-error - Filled fields cannot contain an empty value.
+	edit: null,
 	alt: null,
 	copyright: null,
 });
@@ -73,8 +85,10 @@ expectType<prismicT.ImageField<never, "filled">>({
  * Allows null alt and copyright.
  */
 expectType<prismicT.ImageField>({
+	id: "id",
 	url: "url",
 	dimensions: { width: 1, height: 1 },
+	edit: { x: 0, y: 0, zoom: 1, background: "background" },
 	alt: null,
 	copyright: null,
 });
@@ -95,19 +109,25 @@ expectType<prismicT.ImageField>({
  * Supports thumbnails.
  */
 expectType<prismicT.ImageField<"Foo" | "Bar">>({
+	id: "id",
 	url: "url",
 	dimensions: { width: 1, height: 1 },
+	edit: { x: 0, y: 0, zoom: 1, background: "background" },
 	alt: "alt",
 	copyright: "copyright",
 	Foo: {
+		id: "id",
 		url: "url",
 		dimensions: { width: 1, height: 1 },
+		edit: { x: 0, y: 0, zoom: 1, background: "background" },
 		alt: "alt",
 		copyright: "copyright",
 	},
 	Bar: {
+		id: "id",
 		url: "url",
 		dimensions: { width: 1, height: 1 },
+		edit: { x: 0, y: 0, zoom: 1, background: "background" },
 		alt: "alt",
 		copyright: "copyright",
 	},
@@ -180,13 +200,17 @@ expectType<prismicT.ImageField>({
 	},
 });
 expectType<prismicT.ImageField<"length">>({
+	id: "id",
 	url: "url",
 	dimensions: { width: 1, height: 1 },
+	edit: { x: 0, y: 0, zoom: 1, background: "background" },
 	alt: "alt",
 	copyright: "copyright",
 	length: {
+		id: "id",
 		url: "url",
 		dimensions: { width: 1, height: 1 },
+		edit: { x: 0, y: 0, zoom: 1, background: "background" },
 		alt: "alt",
 		copyright: "copyright",
 	},

diff --git a/test/fields-linkToMedia.types.ts b/test/fields-linkToMedia.types.ts
@@ -23,6 +23,7 @@ import * as prismicT from "../src";
  */
 expectType<prismicT.LinkToMediaField>({
 	link_type: prismicT.LinkType.Media,
+	id: "string",
 	name: "string",
 	kind: "string",
 	url: "string",
@@ -32,6 +33,7 @@ expectType<prismicT.LinkToMediaField>({
 });
 expectType<prismicT.LinkToMediaField<"filled">>({
 	link_type: prismicT.LinkType.Media,
+	id: "string",
 	name: "string",
 	kind: "string",
 	url: "string",
@@ -42,6 +44,7 @@ expectType<prismicT.LinkToMediaField<"filled">>({
 expectType<prismicT.LinkToMediaField<"empty">>({
 	link_type: prismicT.LinkType.Media,
 	// @ts-expect-error - Empty fields cannot contain a filled value.
+	id: "string",
 	name: "string",
 	kind: "string",
 	url: "string",

diff --git a/test/fields-richText.types.ts b/test/fields-richText.types.ts
@@ -116,13 +116,15 @@ expectType<prismicT.RichTextField>([
 	{ type: prismicT.RichTextNodeType.oListItem, text: "string", spans: [] },
 	{
 		type: prismicT.RichTextNodeType.image,
+		id: "string",
 		alt: "string",
 		url: "string",
 		copyright: "string",
 		dimensions: {
 			width: 0,
 			height: 0,
 		},
+		edit: { x: 0, y: 0, zoom: 1, background: "background" },
 		linkTo: {
 			link_type: prismicT.LinkType.Web,
 			url: "string",