@prismicio/types-internal 2.2.0-alpha.7 → 2.2.0-alpha.9

package/lib/import/validators/fields/nestable/Image.js

@@ -5,41 +5,72 @@ const tslib_1 = require("tslib");
 const Either_1 = require("fp-ts/Either");
 const function_1 = require("fp-ts/lib/function");
 const t = (0, tslib_1.__importStar)(require("io-ts"));
-const Objects_1 = require("../../../../utils/Objects");
 const validators_1 = require("../../../../validators");
 const BasicTypes_1 = require("../../../../validators/BasicTypes");
 const ImportContent_1 = require("../ImportContent");
-const ImageFieldCodec = validators_1.AnyObject.pipe(t.intersection([
+const ImageFieldValidator = BasicTypes_1.AnyObject.pipe(t.intersection([
     t.type({
         id: BasicTypes_1.String,
     }),
     t.partial({
-        edit: validators_1.AnyObject.pipe(t.strict({
-            x: validators_1.Number,
-            y: validators_1.Number,
-            width: validators_1.Number,
-            height: validators_1.Number,
-            zoom: validators_1.Number,
+        dimensions: BasicTypes_1.AnyObject.pipe(t.partial({
+            width: BasicTypes_1.Number,
+            height: BasicTypes_1.Number,
+        })),
+        edit: BasicTypes_1.AnyObject.pipe(t.partial({
+            x: BasicTypes_1.Number,
+            y: BasicTypes_1.Number,
+            zoom: BasicTypes_1.Number,
             background: BasicTypes_1.String,
         })),
         credit: BasicTypes_1.StringOrNull,
         alt: BasicTypes_1.StringOrNull,
     }),
 ]));
-const ThumbnailsCodec = t.record(t.string, ImageFieldCodec);
-const ImageFieldWithThumbnails = new t.Type("ImageFieldWithThumbnails", (u) => ImageFieldCodec.is(u) &&
+const ThumbnailsValidator = t.record(t.string, ImageFieldValidator);
+const encodeImageField = (image, mainImage, constraints) => {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r;
+    const background = (_a = image === null || image === void 0 ? void 0 : image.edit) === null || _a === void 0 ? void 0 : _a.background;
+    const width = (_d = (_b = constraints === null || constraints === void 0 ? void 0 : constraints.width) !== null && _b !== void 0 ? _b : (_c = image === null || image === void 0 ? void 0 : image.dimensions) === null || _c === void 0 ? void 0 : _c.width) !== null && _d !== void 0 ? _d : (_e = mainImage.dimensions) === null || _e === void 0 ? void 0 : _e.width;
+    const height = (_h = (_f = constraints === null || constraints === void 0 ? void 0 : constraints.height) !== null && _f !== void 0 ? _f : (_g = image === null || image === void 0 ? void 0 : image.dimensions) === null || _g === void 0 ? void 0 : _g.height) !== null && _h !== void 0 ? _h : (_j = mainImage.dimensions) === null || _j === void 0 ? void 0 : _j.height;
+    const alt = image === null || image === void 0 ? void 0 : image.alt;
+    const credit = image === null || image === void 0 ? void 0 : image.credit;
+    return {
+        id: (_k = image === null || image === void 0 ? void 0 : image.id) !== null && _k !== void 0 ? _k : mainImage === null || mainImage === void 0 ? void 0 : mainImage.id,
+        edit: {
+            x: (_m = (_l = image === null || image === void 0 ? void 0 : image.edit) === null || _l === void 0 ? void 0 : _l.x) !== null && _m !== void 0 ? _m : 0,
+            y: (_p = (_o = image === null || image === void 0 ? void 0 : image.edit) === null || _o === void 0 ? void 0 : _o.y) !== null && _p !== void 0 ? _p : 0,
+            zoom: (_r = (_q = image === null || image === void 0 ? void 0 : image.edit) === null || _q === void 0 ? void 0 : _q.zoom) !== null && _r !== void 0 ? _r : 1,
+            ...(background !== undefined ? { background } : {}),
+        },
+        dimensions: {
+            ...(width !== undefined ? { width } : {}),
+            ...(height !== undefined ? { height } : {}),
+        },
+        ...(alt !== undefined ? { alt } : {}),
+        ...(credit !== undefined ? { credit } : {}),
+    };
+};
+const encodeThumbnails = (mainImage, thumbnails, field) => {
+    var _a, _b, _c;
+    return (_c = (_b = (_a = field === null || field === void 0 ? void 0 : field.config) === null || _a === void 0 ? void 0 : _a.thumbnails) === null || _b === void 0 ? void 0 : _b.reduce((acc, thumbnail) => ({
+        ...acc,
+        [thumbnail.name]: encodeImageField(thumbnails[thumbnail.name], mainImage, thumbnail),
+    }), {})) !== null && _c !== void 0 ? _c : {};
+};
+const ImageFieldWithThumbnails = (field) => new t.Type("ImageFieldWithThumbnails", (u) => ImageFieldValidator.is(u) &&
     "thumbnails" in u &&
-    ThumbnailsCodec.is(u["thumbnails"]), (u, ctx) => {
-    return (0, function_1.pipe)(ImageFieldCodec.validate(u, ctx), (0, Either_1.chain)((proto) => {
-        const { id, edit, credit, alt, ...maybeThumbnails } = proto;
-        return (0, function_1.pipe)(ThumbnailsCodec.validate(maybeThumbnails, ctx), (0, Either_1.map)((thumbnails) => (0, Objects_1.withOptionals)({
-            id,
-            thumbnails,
-        }, [
-            ["edit", edit],
-            ["credit", credit],
-            ["alt", alt],
-        ])));
+    ThumbnailsValidator.is(u["thumbnails"]), (u, ctx) => {
+    return (0, function_1.pipe)(ImageFieldValidator.validate(u, ctx), (0, Either_1.chain)((mainImage) => {
+        const { id, dimensions, edit, credit, alt, ...maybeThumbnails } = mainImage;
+        return (0, function_1.pipe)(ThumbnailsValidator.validate(maybeThumbnails, ctx), (0, Either_1.map)((thumbnails) => {
+            var _a;
+            return ({
+                ...encodeImageField(mainImage, mainImage, (_a = field === null || field === void 0 ? void 0 : field.config) === null || _a === void 0 ? void 0 : _a.constraint),
+                thumbnails: encodeThumbnails(mainImage, thumbnails, field),
+            });
+        }));
     }));
 }, t.identity);
-exports.ImportImage = (0, ImportContent_1.ImportContent)("Image", (0, validators_1.NullOrElse)(ImageFieldWithThumbnails));
+const ImportImage = (field) => (0, ImportContent_1.ImportContent)("Image", (0, validators_1.NullOrElse)(ImageFieldWithThumbnails(field)));
+exports.ImportImage = ImportImage;

package/lib/import/validators/fields/nestable/Nestable.d.ts

@@ -25,12 +25,42 @@ export declare const ImportNestable: {
             value: Date | null;
         }, Date | undefined, unknown> | import("io-ts").Type<{
             type: "Embed";
-            value: {
+            value: ({
                 embed_url: string;
-            } | null;
-        }, {
+                type: string;
+            } & {
+                version?: string | number | null;
+                title?: string;
+                author_name?: string | null;
+                author_url?: string | null;
+                provider_name?: string | null;
+                provider_url?: string | null;
+                cache_age?: string | number | null;
+                thumbnail_url?: string | null;
+                thumbnail_width?: number | null;
+                thumbnail_height?: number | null;
+                html?: string | null;
+            } & {
+                all: unknown;
+            }) | null;
+        }, ({
             embed_url: string;
-        } | undefined, unknown> | import("io-ts").Type<{
+            type: string;
+        } & {
+            version?: string | number | null;
+            title?: string;
+            author_name?: string | null;
+            author_url?: string | null;
+            provider_name?: string | null;
+            provider_url?: string | null;
+            cache_age?: string | number | null;
+            thumbnail_url?: string | null;
+            thumbnail_width?: number | null;
+            thumbnail_height?: number | null;
+            html?: string | null;
+        } & {
+            all: unknown;
+        }) | undefined, unknown> | import("io-ts").Type<{
             type: "GeoPoint";
             value: {
                 latitude: number;
@@ -41,67 +71,11 @@ export declare const ImportNestable: {
             longitude: number;
         } | undefined, unknown> | import("io-ts").Type<{
             type: "Image";
-            value: ({
-                id: string;
-            } & {
-                edit?: {
-                    x: number;
-                    y: number;
-                    width: number;
-                    height: number;
-                    zoom: number;
-                    background: string;
-                };
-                credit?: string | null;
-                alt?: string | null;
-            } & {
-                thumbnails: {
-                    [x: string]: {
-                        id: string;
-                    } & {
-                        edit?: {
-                            x: number;
-                            y: number;
-                            width: number;
-                            height: number;
-                            zoom: number;
-                            background: string;
-                        };
-                        credit?: string | null;
-                        alt?: string | null;
-                    };
-                };
+            value: (import("./Image").ImageField & {
+                thumbnails: Record<string, import("./Image").ImageField>;
             }) | null;
-        }, ({
-            id: string;
-        } & {
-            edit?: {
-                x: number;
-                y: number;
-                width: number;
-                height: number;
-                zoom: number;
-                background: string;
-            };
-            credit?: string | null;
-            alt?: string | null;
-        } & {
-            thumbnails: {
-                [x: string]: {
-                    id: string;
-                } & {
-                    edit?: {
-                        x: number;
-                        y: number;
-                        width: number;
-                        height: number;
-                        zoom: number;
-                        background: string;
-                    };
-                    credit?: string | null;
-                    alt?: string | null;
-                };
-            };
+        }, (import("./Image").ImageField & {
+            thumbnails: Record<string, import("./Image").ImageField>;
         }) | undefined, unknown> | import("io-ts").Type<{
             type: "Link";
             value: ({
@@ -159,36 +133,8 @@ export declare const ImportNestable: {
             } | null;
         }> | import("fp-ts/lib/Either").Right<{
             type: "Image";
-            value: ({
-                id: string;
-            } & {
-                edit?: {
-                    x: number;
-                    y: number;
-                    width: number;
-                    height: number;
-                    zoom: number;
-                    background: string;
-                };
-                credit?: string | null;
-                alt?: string | null;
-            } & {
-                thumbnails: {
-                    [x: string]: {
-                        id: string;
-                    } & {
-                        edit?: {
-                            x: number;
-                            y: number;
-                            width: number;
-                            height: number;
-                            zoom: number;
-                            background: string;
-                        };
-                        credit?: string | null;
-                        alt?: string | null;
-                    };
-                };
+            value: (import("./Image").ImageField & {
+                thumbnails: Record<string, import("./Image").ImageField>;
             }) | null;
         }> | import("fp-ts/lib/Either").Right<{
             type: "GeoPoint";
@@ -198,9 +144,24 @@ export declare const ImportNestable: {
             } | null;
         }> | import("fp-ts/lib/Either").Right<{
             type: "Embed";
-            value: {
+            value: ({
                 embed_url: string;
-            } | null;
+                type: string;
+            } & {
+                version?: string | number | null;
+                title?: string;
+                author_name?: string | null;
+                author_url?: string | null;
+                provider_name?: string | null;
+                provider_url?: string | null;
+                cache_age?: string | number | null;
+                thumbnail_url?: string | null;
+                thumbnail_width?: number | null;
+                thumbnail_height?: number | null;
+                html?: string | null;
+            } & {
+                all: unknown;
+            }) | null;
         }> | import("fp-ts/lib/Either").Right<{
             type: "Date";
             value: Date | null;

package/lib/import/validators/fields/nestable/Nestable.js

@@ -24,7 +24,7 @@ exports.ImportNestable = {
             Embed_1.ImportEmbed.is(u) ||
             Link_1.ImportLink.is(u) ||
             GeoPoint_1.ImportGeoPoint.is(u) ||
-            Image_1.ImportImage.is(u));
+            (0, Image_1.ImportImage)().is(u));
     },
     decode: (field) => {
         return (content) => {
@@ -49,7 +49,7 @@ exports.ImportNestable = {
                     case "Link":
                         return Link_1.ImportLink;
                     case "Image":
-                        return Image_1.ImportImage;
+                        return (0, Image_1.ImportImage)(field);
                     case "GeoPoint":
                         return GeoPoint_1.ImportGeoPoint;
                     default:

package/lib/utils/Objects.d.ts

@@ -5,4 +5,4 @@ export declare function zipObjects<A, B = A>(objLeft?: Partial<Record<string, A>
 export declare function isNotEmpty<A extends object>(obj: A): boolean;
 export declare function withOptionals<T extends object>(object: T, optionals: Array<[keyof T, T[keyof T] | null | undefined]>): T;
 export declare function isObject(value: unknown): value is Record<string, unknown>;
-export declare function mapValues<T, O>(record: Record<string, T>, fn: (value: T) => O): Record<string, O>;
+export declare function mapValues<T, O>(record: Record<string, T>, fn: (value: T, key: string) => O): Record<string, O>;

package/lib/utils/Objects.js

@@ -37,6 +37,6 @@ function isObject(value) {
 }
 exports.isObject = isObject;
 function mapValues(record, fn) {
-    return Object.entries(record).reduce((acc, [key, value]) => ({ ...acc, [key]: fn(value) }), {});
+    return Object.entries(record).reduce((acc, [key, value]) => ({ ...acc, [key]: fn(value, key) }), {});
 }
 exports.mapValues = mapValues;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@prismicio/types-internal",
-	"version": "2.2.0-alpha.7",
+	"version": "2.2.0-alpha.9",
 	"description": "Prismic types for Custom Types and Prismic Data",
 	"keywords": [
 		"typescript",

package/src/common/Asset.ts

@@ -1,5 +1,7 @@
+export type AssetId = string
+
 export type Asset = {
-	id: string
+	id: AssetId
 	last_modified: string
 	kind: "image" | "all"
 	filename?: string
@@ -15,8 +17,10 @@ export type Asset = {
 }
 
 export const getAssetOrThrow =
-	(assets: Record<string, Asset>) => (assetId: string) => {
+	(assets: Record<AssetId, Asset>) => (assetId: AssetId) => {
 		const asset = assets[assetId]
-		if (!asset) throw new Error(`Missing asset with id '${assetId}'`)
+		if (!asset) {
+			throw new Error(`Missing asset with id '${assetId}'!`)
+		}
 		return asset
 	}

package/src/common/index.ts

@@ -1,3 +1,2 @@
 export * from "./Asset"
-export * from "./Embed"
 export * from "./WidgetKey"

package/src/customtypes/CustomType.ts

@@ -8,6 +8,7 @@ import type { SharedSlice } from "./widgets/slices/SharedSlice"
 import type { DynamicSlice } from "./widgets/slices/Slice"
 import type { DynamicSlices } from "./widgets/slices/Slices"
 import type { DynamicWidget } from "./widgets/Widget"
+import type { StaticWidget } from "./widgets/Widget"
 
 export const CustomTypeFormat = {
 	page: "page",
@@ -194,3 +195,15 @@ export function filterMissingSharedSlices(
 		return widget
 	})
 }
+
+export function flattenCustomTypeFields(
+	customType: StaticCustomType,
+): Partial<Record<string, StaticWidget>> {
+	return Object.values(customType.json).reduce(
+		(acc, tab) => ({
+			...acc,
+			...tab,
+		}),
+		{},
+	)
+}

package/src/import/converters/Document.ts

@@ -1,5 +1,4 @@
-import type { Asset } from "../../common"
-import type { Embed } from "../../common/Embed"
+import type { Asset, AssetId } from "../../common"
 import type { Document, WidgetContent } from "../../content"
 import type { ImportDocument } from "../validators"
 import type { ImportField } from "../validators/fields/ImportField"
@@ -7,12 +6,11 @@ import { convertNestableWidget, uidConverter } from "./fields"
 
 export function convertImportToContent(
 	document: ImportDocument,
-	assets: Record<string, Asset>,
-	embeds: Record<string, Embed>,
+	assets: Record<AssetId, Asset>,
 ): Document {
 	return Object.entries(document).reduce<Document>(
 		(acc, [fieldKey, fieldValue]) => {
-			const newFieldValue = convertWidget(fieldValue, assets, embeds)
+			const newFieldValue = convertWidget(fieldValue, assets)
 			return newFieldValue ? { ...acc, [fieldKey]: newFieldValue } : acc
 		},
 		{},
@@ -21,13 +19,12 @@ export function convertImportToContent(
 
 function convertWidget(
 	field: ImportField,
-	assets: Record<string, Asset>,
-	embeds: Record<string, Embed>,
+	assets: Record<AssetId, Asset>,
 ): WidgetContent | undefined {
 	switch (field.type) {
 		case "UID":
 			return uidConverter(field.value)
 		default:
-			return convertNestableWidget(field, assets, embeds)
+			return convertNestableWidget(field, assets)
 	}
 }

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

@@ -1,37 +1,15 @@
-import type { Embed } from "../../../../common"
-import { getEmbedOrThrow } from "../../../../common"
 import type { EmbedContent } from "../../../../content"
-import { withOptionals } from "../../../../utils/Objects"
 import type { ImportEmbed } from "../../../validators"
 
 export const embedConverter = (
 	field: ImportEmbed["value"],
-	embeds: Record<string, Embed>,
 ): EmbedContent | undefined => {
 	if (field === null) return
-	const embed = getEmbedOrThrow(embeds)(field.embed_url)
-	return withOptionals<EmbedContent>(
-		{
-			embed_url: field.embed_url,
-			type: embed.type,
-			all: {
-				embed_url: field.embed_url,
-				...embed,
-			},
-			__TYPE__: "EmbedContent",
-		},
-		[
-			["version", embed.version],
-			["title", embed.title],
-			["author_name", embed.author_name],
-			["author_url", embed.author_url],
-			["provider_name", embed.provider_name],
-			["provider_url", embed.provider_url],
-			["cache_age", embed.cache_age],
-			["thumbnail_url", embed.thumbnail_url],
-			["thumbnail_width", embed.thumbnail_width],
-			["thumbnail_height", embed.thumbnail_height],
-			["html", embed.html],
-		],
-	)
+
+	return {
+		...field,
+		__TYPE__: "EmbedContent",
+	}
+
+	return
 }

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

@@ -1,53 +1,73 @@
-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 { withOptionals } from "../../../../utils/Objects"
 import type { ImageField, ImportImage } from "../../../validators"
 
-function convertImage(field: ImageField, image: Asset) {
+function convertImage(imageField: ImageField, 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.
+			// Image width and height will be only applied if there are no constraints and user didn't overwrite it
+			width: imageField?.dimensions?.width ?? image.width ?? 0,
+			height: imageField?.dimensions?.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: imageField.edit?.zoom ?? 1,
 				crop: {
-					x: field.edit?.x ?? 0,
-					y: field.edit?.y ?? 0,
+					x: imageField.edit?.x ?? 0,
+					y: imageField.edit?.y ?? 0,
 				},
-				background: field.edit?.background ?? "transparent",
+				background:
+					imageField.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],
 		],
 	)
 }
 
+function convertThumbnails(
+	imageField: Exclude<ImportImage["value"], null>,
+	assets: Record<AssetId, Asset>,
+) {
+	return Object.entries(imageField.thumbnails).reduce(
+		(acc, [thumbnailName, thumbnail]) => {
+			return {
+				...acc,
+				[thumbnailName]: convertImage(
+					thumbnail,
+					getAssetOrThrow(assets)(thumbnail.id),
+				),
+			}
+		},
+		{},
+	)
+}
+
+// All assets from `imageField` must be present in `assets`
+// If not then function will throw an error
 export const imageConverter = (
-	field: ImportImage["value"],
-	assets: Record<string, Asset>,
+	imageField: ImportImage["value"],
+	assets: Record<AssetId, Asset>,
 ): ImageContent | undefined => {
-	const getImageById = (id: string): Asset => {
-		const image = assets[id]
-		if (!image) throw new Error(`Missing asset with id '${id}'`)
-		return image
-	}
-
-	if (!field) return
+	if (!imageField) return
 
 	return {
-		...convertImage(field, getImageById(field.id)),
-		thumbnails: mapValues(field.thumbnails, (thumbnail) =>
-			convertImage(thumbnail, getImageById(thumbnail.id)),
-		),
-		__TYPE__: "ImageContent",
+		...convertImage(imageField, getAssetOrThrow(assets)(imageField.id)),
+		thumbnails: convertThumbnails(imageField, assets),
+		__TYPE__: "ImageContent" as const,
 	}
 }

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

@@ -1,5 +1,4 @@
-import type { Asset } from "../../../../common"
-import type { Embed } from "../../../../common/Embed"
+import type { Asset, AssetId } from "../../../../common"
 import type { WidgetContent } from "../../../../content"
 import type { ImportNestable } from "../../../validators"
 import {
@@ -18,8 +17,7 @@ import {
 
 export function convertNestableWidget(
 	field: ImportNestable,
-	assets: Record<string, Asset>,
-	embeds: Record<string, Embed>,
+	assets: Record<AssetId, Asset>,
 ): WidgetContent | undefined {
 	switch (field.type) {
 		case "Boolean":
@@ -37,7 +35,7 @@ export function convertNestableWidget(
 		case "Timestamp":
 			return timestampConverter(field.value)
 		case "Embed":
-			return embedConverter(field.value, embeds)
+			return embedConverter(field.value)
 		case "GeoPoint":
 			return geopointConverter(field.value)
 		case "Link":

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,