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

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

@@ -1,53 +1,129 @@
-import type { Asset } from "../../../../common"
+import type { Asset, AssetId } from "../../../../common"
+import { getAssetOrThrow } from "../../../../common"
 import type { ImageContent } from "../../../../content"
-import { mapValues, withOptionals } from "../../../../utils/Objects"
+import type {
+	ImageConstraint,
+	StaticWidget,
+	Thumbnail,
+} from "../../../../customtypes"
+import { withOptionals } from "../../../../utils/Objects"
 import type { ImageField, ImportImage } from "../../../validators"
 
-function convertImage(field: ImageField, image: Asset) {
+function convertImage(
+	imageField: ImageField | undefined,
+	edit: ImageField["edit"] | undefined,
+	constraints: ImageConstraint | undefined,
+	image: Asset,
+) {
 	return withOptionals<Omit<ImageContent, "__TYPE__" | "thumbnails">>(
 		{
 			origin: {
-				id: field.id,
+				id: image.id,
 				url: image.origin_url,
+				// All images returned form Asset API should have width and height properties.
 				width: image.width ?? 0,
 				height: image.height ?? 0,
 			},
-			width: field.edit?.width ?? image.width ?? 0,
-			height: field.edit?.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,
+			// 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: field.edit?.zoom ?? 1,
+				zoom: edit?.zoom ?? 1,
 				crop: {
-					x: field.edit?.x ?? 0,
-					y: field.edit?.y ?? 0,
+					x: edit?.x ?? 0,
+					y: edit?.y ?? 0,
 				},
-				background: field.edit?.background ?? "transparent",
+				background:
+					edit?.background ??
+					(image.extension === "png" ? "transparent" : "#ffffff"),
 			},
 			url: image.url,
 		},
 		[
-			["alt", field.alt || image.alt],
-			["credits", field.credit || image.credits],
+			["alt", imageField?.alt || image.alt],
+			["credits", imageField?.credit || image.credits],
 		],
 	)
 }
 
+// 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),
+		}
+	}, {})
+}
+
+// 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
 export const imageConverter = (
-	field: ImportImage["value"],
-	assets: Record<string, Asset>,
+	imageField: ImportImage["value"],
+	assets: Record<AssetId, Asset>,
+	model?: StaticWidget,
 ): ImageContent | undefined => {
-	const getImageById = (id: string): Asset => {
-		const image = assets[id]
-		if (!image) throw new Error(`Missing asset with id '${id}'`)
-		return image
+	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 (!field) return
+	if (!imageField) return
 
 	return {
-		...convertImage(field, getImageById(field.id)),
-		thumbnails: mapValues(field.thumbnails, (thumbnail) =>
-			convertImage(thumbnail, getImageById(thumbnail.id)),
+		...convertImage(
+			imageField,
+			imageField.edit,
+			model.config?.constraint,
+			getAssetOrThrow(assets)(imageField.id),
+		),
+		thumbnails: convertThumbnails(
+			imageField,
+			assets,
+			model.config?.thumbnails ?? [],
 		),
-		__TYPE__: "ImageContent",
+		__TYPE__: "ImageContent" as const,
 	}
 }

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

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

package/src/import/validators/Document.ts

@@ -6,6 +6,7 @@ import { withMessage } from "io-ts-types"
 
 import type { WidgetKey } from "../../common"
 import type { StaticCustomType, StaticWidget } from "../../customtypes"
+import { flattenCustomTypeFields } from "../../customtypes"
 import { isObject } from "../../utils/Objects"
 import { ImportField } from "./fields/ImportField"
 
@@ -14,15 +15,6 @@ const rawImportDocument = withMessage(
 	() => "document is not an object",
 )
 
-function flattenCustomTypeFields(
-	customType: StaticCustomType,
-): Partial<Record<string, StaticWidget>> {
-	return Object.values(customType.json).reduce((acc, tab) => ({
-		...acc,
-		...tab,
-	}))
-}
-
 function validateField(
 	document: Record<string, unknown>,
 	customType: StaticCustomType,

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

@@ -15,7 +15,7 @@ const ImageFieldCodec = AnyObject.pipe(
 		}),
 		t.partial({
 			edit: AnyObject.pipe(
-				t.strict({
+				t.partial({
 					x: Number,
 					y: Number,
 					width: Number,

package/src/utils/Objects.ts

@@ -44,10 +44,10 @@ export function isObject(value: unknown): value is Record<string, unknown> {
 
 export function mapValues<T, O>(
 	record: Record<string, T>,
-	fn: (value: T) => O,
+	fn: (value: T, key: string) => O,
 ): Record<string, O> {
 	return Object.entries<T>(record).reduce<Record<string, O>>(
-		(acc, [key, value]) => ({ ...acc, [key]: fn(value) }),
+		(acc, [key, value]) => ({ ...acc, [key]: fn(value, key) }),
 		{},
 	)
 }