@prismicio/types-internal 2.2.0-alpha.6 → 2.2.0-alpha.8

package/src/import/converters/fields/nestable/Image.ts

@@ -1,20 +1,10 @@
 import type { Asset, AssetId } from "../../../../common"
 import { getAssetOrThrow } from "../../../../common"
 import type { ImageContent } from "../../../../content"
-import type {
-	ImageConstraint,
-	StaticWidget,
-	Thumbnail,
-} from "../../../../customtypes"
 import { withOptionals } from "../../../../utils/Objects"
 import type { ImageField, ImportImage } from "../../../validators"
 
-function convertImage(
-	imageField: ImageField | undefined,
-	edit: ImageField["edit"] | undefined,
-	constraints: ImageConstraint | undefined,
-	image: Asset,
-) {
+function convertImage(imageField: ImageField, image: Asset) {
 	return withOptionals<Omit<ImageContent, "__TYPE__" | "thumbnails">>(
 		{
 			origin: {
@@ -25,19 +15,19 @@ function convertImage(
 				height: image.height ?? 0,
 			},
 			// All images returned form Asset API should have width and height properties.
-			// Edit can only overwrite width and height if there are no constraints set
-			width: constraints?.width ?? edit?.width ?? image.width ?? 0,
-			height: constraints?.height ?? edit?.height ?? image.height ?? 0,
+			// Image width and height will be only applied if there are no constraints and user didn't overwrite it
+			width: imageField?.width ?? image.width ?? 0,
+			height: imageField?.height ?? image.height ?? 0,
 			// If edit is not provided, we crop constraint width and height from the left upper corner.
 			// WARN: If constraints are greater than image dimensions cut outside the image (background will fill extra space).
 			edit: {
-				zoom: edit?.zoom ?? 1,
+				zoom: imageField.edit?.zoom ?? 1,
 				crop: {
-					x: edit?.x ?? 0,
-					y: edit?.y ?? 0,
+					x: imageField.edit?.x ?? 0,
+					y: imageField.edit?.y ?? 0,
 				},
 				background:
-					edit?.background ??
+					imageField.edit?.background ??
 					(image.extension === "png" ? "transparent" : "#ffffff"),
 			},
 			url: image.url,
@@ -49,81 +39,35 @@ function convertImage(
 	)
 }
 
-// If image field contains thumbnailName definition use it to generate thumbnail
-// If image field is missing thumbnailName derive thumbnail from main image
-// WARN: edit is not inherited from main image as each thumbnail have different constraints
-function convertThumbnail(
-	thumbnailName: string,
-	thumbnailConstraints: ImageConstraint | undefined,
-	imageField: Exclude<ImportImage["value"], null>,
-	assets: Record<AssetId, Asset>,
-) {
-	const maybeThumbnail = imageField.thumbnails[thumbnailName]
-	if (maybeThumbnail) {
-		return convertImage(
-			maybeThumbnail,
-			maybeThumbnail.edit,
-			thumbnailConstraints,
-			getAssetOrThrow(assets)(maybeThumbnail.id),
-		)
-	} else {
-		return convertImage(
-			imageField,
-			undefined,
-			thumbnailConstraints,
-			getAssetOrThrow(assets)(imageField.id),
-		)
-	}
-}
-
 function convertThumbnails(
 	imageField: Exclude<ImportImage["value"], null>,
 	assets: Record<AssetId, Asset>,
-	thumbnailsModel: readonly Thumbnail[],
 ) {
-	return thumbnailsModel.reduce<
-		Record<string, ReturnType<typeof convertImage>>
-	>((acc, { name, ...constraints }) => {
-		return {
-			...acc,
-			[name]: convertThumbnail(name, constraints, imageField, assets),
-		}
-	}, {})
+	return Object.entries(imageField.thumbnails).reduce(
+		(acc, [thumbnailName, thumbnail]) => {
+			return {
+				...acc,
+				[thumbnailName]: convertImage(
+					thumbnail,
+					getAssetOrThrow(assets)(thumbnail.id),
+				),
+			}
+		},
+		{},
+	)
 }
 
-// Function constraints:
-// * `model` is required
-// * `mode` is of type Image
-// * All assets from `imageField` must be present in `assets`
-// If any of these constraints is not met, function will throw an error
+// All assets from `imageField` must be present in `assets`
+// If not then function will throw an error
 export const imageConverter = (
 	imageField: ImportImage["value"],
 	assets: Record<AssetId, Asset>,
-	model?: StaticWidget,
 ): ImageContent | undefined => {
-	if (!model) {
-		throw new Error(`'model' parameter is required!`)
-	}
-	if (model.type !== "Image") {
-		throw new Error(
-			`Wrong model type! Expected 'Image' but got '${model.type}'`,
-		)
-	}
-
 	if (!imageField) return
 
 	return {
-		...convertImage(
-			imageField,
-			imageField.edit,
-			model.config?.constraint,
-			getAssetOrThrow(assets)(imageField.id),
-		),
-		thumbnails: convertThumbnails(
-			imageField,
-			assets,
-			model.config?.thumbnails ?? [],
-		),
+		...convertImage(imageField, getAssetOrThrow(assets)(imageField.id)),
+		thumbnails: convertThumbnails(imageField, assets),
 		__TYPE__: "ImageContent" as const,
 	}
 }

package/src/import/converters/fields/nestable/Nestable.ts

@@ -1,6 +1,5 @@
 import type { Asset, AssetId } from "../../../../common"
 import type { WidgetContent } from "../../../../content"
-import type { StaticWidget } from "../../../../customtypes"
 import type { ImportNestable } from "../../../validators"
 import {
 	booleanConverter,
@@ -19,7 +18,6 @@ import {
 export function convertNestableWidget(
 	field: ImportNestable,
 	assets: Record<AssetId, Asset>,
-	model?: StaticWidget,
 ): WidgetContent | undefined {
 	switch (field.type) {
 		case "Boolean":
@@ -43,7 +41,7 @@ export function convertNestableWidget(
 		case "Link":
 			return linkConverter(field.value, assets)
 		case "Image":
-			return imageConverter(field.value, assets, model)
+			return imageConverter(field.value, assets)
 		default:
 			throw new Error(
 				`Unsupported type of nestable converter ${JSON.stringify(field)}`,

package/src/import/validators/fields/nestable/Image.ts

@@ -3,23 +3,24 @@ import { pipe } from "fp-ts/lib/function"
 import type { Validation } from "io-ts"
 import * as t from "io-ts"
 
-import { withOptionals } from "../../../../utils/Objects"
+import type { Image } from "../../../../customtypes"
+import type ImageConstraint from "../../../../customtypes/widgets/shared/ImageConstraint"
 import { AnyObject, NullOrElse, Number } from "../../../../validators"
-import { String, StringOrNull } from "../../../../validators/BasicTypes"
+import { String, StringOrNull } from "../../../../validators"
 import { ImportContent } from "../ImportContent"
 
-const ImageFieldCodec = AnyObject.pipe(
+const ImageFieldValidator = AnyObject.pipe(
 	t.intersection([
 		t.type({
 			id: String,
 		}),
 		t.partial({
+			width: Number,
+			height: Number,
 			edit: AnyObject.pipe(
 				t.partial({
 					x: Number,
 					y: Number,
-					width: Number,
-					height: Number,
 					zoom: Number,
 					background: String,
 				}),
@@ -30,48 +31,98 @@ const ImageFieldCodec = AnyObject.pipe(
 	]),
 )
 
-const ThumbnailsCodec = t.record(t.string, ImageFieldCodec)
-type Thumbnails = t.TypeOf<typeof ThumbnailsCodec>
+const ThumbnailsValidator = t.record(t.string, ImageFieldValidator)
 
-export type ImageField = t.TypeOf<typeof ImageFieldCodec>
+export type ImageField = {
+	id: string
+	width?: number
+	height?: number
+	edit: {
+		x: number
+		y: number
+		zoom: number
+		background?: string
+	}
+	credit?: string | null
+	alt?: string | null
+}
+type ImageFieldWithThumbnails = ImageField & {
+	thumbnails: Record<string, ImageField>
+}
 
-type ImageFieldWithThumbnails = ImageField & { thumbnails: Thumbnails }
+const encodeImageField = (
+	image: t.TypeOf<typeof ImageFieldValidator> | undefined,
+	mainImage: t.TypeOf<typeof ImageFieldValidator>,
+	constraints?: ImageConstraint,
+): ImageField => {
+	const background = image?.edit?.background
+	const width = constraints?.width ?? image?.width
+	const height = constraints?.height ?? image?.height
+	const alt = image?.alt
+	const credit = image?.credit
 
-const ImageFieldWithThumbnails = new t.Type(
-	"ImageFieldWithThumbnails",
-	(u: unknown): u is ImageFieldWithThumbnails =>
-		ImageFieldCodec.is(u) &&
-		"thumbnails" in u &&
-		ThumbnailsCodec.is(u["thumbnails"]),
-	(u: unknown, ctx): Validation<ImageFieldWithThumbnails> => {
-		return pipe(
-			ImageFieldCodec.validate(u, ctx),
-			chain((proto) => {
-				const { id, edit, credit, alt, ...maybeThumbnails } = proto
-				return pipe(
-					ThumbnailsCodec.validate(maybeThumbnails, ctx),
-					map((thumbnails) =>
-						withOptionals<ImageFieldWithThumbnails>(
-							{
-								id,
-								thumbnails,
-							},
-							[
-								["edit", edit],
-								["credit", credit],
-								["alt", alt],
-							],
-						),
-					),
-				)
-			}),
-		)
-	},
-	t.identity,
-)
+	return {
+		id: image?.id ?? mainImage?.id,
+		edit: {
+			x: image?.edit?.x ?? 0,
+			y: image?.edit?.y ?? 0,
+			zoom: image?.edit?.zoom ?? 1,
+			...(background !== undefined ? { background } : {}),
+		},
+		...(width !== undefined ? { width } : {}),
+		...(height !== undefined ? { height } : {}),
+		...(alt !== undefined ? { alt } : {}),
+		...(credit !== undefined ? { credit } : {}),
+	}
+}
 
-export const ImportImage = ImportContent(
-	"Image",
-	NullOrElse(ImageFieldWithThumbnails),
-)
-export type ImportImage = t.TypeOf<typeof ImportImage>
+const encodeThumbnails = (
+	mainImage: t.TypeOf<typeof ImageFieldValidator>,
+	thumbnails: t.TypeOf<typeof ThumbnailsValidator>,
+	field?: Image,
+) =>
+	field?.config?.thumbnails?.reduce(
+		(acc, thumbnail) => ({
+			...acc,
+			[thumbnail.name]: encodeImageField(
+				thumbnails[thumbnail.name],
+				mainImage,
+				thumbnail,
+			),
+		}),
+		{},
+	) ?? {}
+
+const ImageFieldWithThumbnails = (field?: Image) =>
+	new t.Type<ImageFieldWithThumbnails>(
+		"ImageFieldWithThumbnails",
+		(u: unknown): u is ImageFieldWithThumbnails =>
+			ImageFieldValidator.is(u) &&
+			"thumbnails" in u &&
+			ThumbnailsValidator.is(u["thumbnails"]),
+		(u: unknown, ctx): Validation<ImageFieldWithThumbnails> => {
+			return pipe(
+				ImageFieldValidator.validate(u, ctx),
+				chain((mainImage) => {
+					const { id, width, height, edit, credit, alt, ...maybeThumbnails } =
+						mainImage
+					return pipe(
+						ThumbnailsValidator.validate(maybeThumbnails, ctx),
+						map((thumbnails) => ({
+							...encodeImageField(
+								mainImage,
+								mainImage,
+								field?.config?.constraint,
+							),
+							thumbnails: encodeThumbnails(mainImage, thumbnails, field),
+						})),
+					)
+				}),
+			)
+		},
+		t.identity,
+	)
+
+export const ImportImage = (field?: Image) =>
+	ImportContent("Image", NullOrElse(ImageFieldWithThumbnails(field)))
+export type ImportImage = t.TypeOf<ReturnType<typeof ImportImage>>

package/src/import/validators/fields/nestable/Nestable.ts

@@ -37,7 +37,7 @@ export const ImportNestable = {
 			ImportEmbed.is(u) ||
 			ImportLink.is(u) ||
 			ImportGeoPoint.is(u) ||
-			ImportImage.is(u)
+			ImportImage().is(u)
 		)
 	},
 	decode: (field: NestableWidget) => {
@@ -63,7 +63,7 @@ export const ImportNestable = {
 					case "Link":
 						return ImportLink
 					case "Image":
-						return ImportImage
+						return ImportImage(field)
 					case "GeoPoint":
 						return ImportGeoPoint
 					default: