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

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

@@ -25,42 +25,12 @@ export declare const ImportNestable: {
             value: Date | null;
         }, Date | undefined, unknown> | import("io-ts").Type<{
             type: "Embed";
-            value: ({
+            value: {
                 embed_url: string;
-                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;
-        }, ({
+            } | null;
+        }, {
             embed_url: string;
-            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<{
+        } | undefined, unknown> | import("io-ts").Type<{
             type: "GeoPoint";
             value: {
                 latitude: number;
@@ -75,12 +45,12 @@ export declare const ImportNestable: {
                 id: string;
             } & {
                 edit?: {
-                    x?: number;
-                    y?: number;
-                    width?: number;
-                    height?: number;
-                    zoom?: number;
-                    background?: string;
+                    x: number;
+                    y: number;
+                    width: number;
+                    height: number;
+                    zoom: number;
+                    background: string;
                 };
                 credit?: string | null;
                 alt?: string | null;
@@ -90,12 +60,12 @@ export declare const ImportNestable: {
                         id: string;
                     } & {
                         edit?: {
-                            x?: number;
-                            y?: number;
-                            width?: number;
-                            height?: number;
-                            zoom?: number;
-                            background?: string;
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                            zoom: number;
+                            background: string;
                         };
                         credit?: string | null;
                         alt?: string | null;
@@ -106,12 +76,12 @@ export declare const ImportNestable: {
             id: string;
         } & {
             edit?: {
-                x?: number;
-                y?: number;
-                width?: number;
-                height?: number;
-                zoom?: number;
-                background?: string;
+                x: number;
+                y: number;
+                width: number;
+                height: number;
+                zoom: number;
+                background: string;
             };
             credit?: string | null;
             alt?: string | null;
@@ -121,12 +91,12 @@ export declare const ImportNestable: {
                     id: string;
                 } & {
                     edit?: {
-                        x?: number;
-                        y?: number;
-                        width?: number;
-                        height?: number;
-                        zoom?: number;
-                        background?: string;
+                        x: number;
+                        y: number;
+                        width: number;
+                        height: number;
+                        zoom: number;
+                        background: string;
                     };
                     credit?: string | null;
                     alt?: string | null;
@@ -193,12 +163,12 @@ export declare const ImportNestable: {
                 id: string;
             } & {
                 edit?: {
-                    x?: number;
-                    y?: number;
-                    width?: number;
-                    height?: number;
-                    zoom?: number;
-                    background?: string;
+                    x: number;
+                    y: number;
+                    width: number;
+                    height: number;
+                    zoom: number;
+                    background: string;
                 };
                 credit?: string | null;
                 alt?: string | null;
@@ -208,12 +178,12 @@ export declare const ImportNestable: {
                         id: string;
                     } & {
                         edit?: {
-                            x?: number;
-                            y?: number;
-                            width?: number;
-                            height?: number;
-                            zoom?: number;
-                            background?: string;
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                            zoom: number;
+                            background: string;
                         };
                         credit?: string | null;
                         alt?: string | null;
@@ -228,24 +198,9 @@ export declare const ImportNestable: {
             } | null;
         }> | import("fp-ts/lib/Either").Right<{
             type: "Embed";
-            value: ({
+            value: {
                 embed_url: string;
-                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;
+            } | null;
         }> | import("fp-ts/lib/Either").Right<{
             type: "Date";
             value: Date | null;

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, key: string) => O): Record<string, O>;
+export declare function mapValues<T, O>(record: Record<string, T>, fn: (value: T) => 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, key) }), {});
+    return Object.entries(record).reduce((acc, [key, value]) => ({ ...acc, [key]: fn(value) }), {});
 }
 exports.mapValues = mapValues;

package/package.json

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

package/src/common/Asset.ts

@@ -1,7 +1,5 @@
-export type AssetId = string
-
 export type Asset = {
-	id: AssetId
+	id: string
 	last_modified: string
 	kind: "image" | "all"
 	filename?: string
@@ -17,10 +15,8 @@ export type Asset = {
 }
 
 export const getAssetOrThrow =
-	(assets: Record<AssetId, Asset>) => (assetId: AssetId) => {
+	(assets: Record<string, Asset>) => (assetId: string) => {
 		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/Embed.ts

@@ -0,0 +1,23 @@
+export type Embed = {
+	type: string
+	version?: string | null
+	author_name?: string | null
+	author_url?: string | null
+	provider_name?: string | null
+	provider_url?: string | null
+	cache_age?: string | null
+	thumbnail_url?: string | null
+	thumbnail_width?: number | null
+	thumbnail_height?: number | null
+	html?: string | null
+	title?: string | null
+}
+
+export type EmbedUrl = string
+
+export const getEmbedOrThrow =
+	(embeds: Record<string, Embed>) => (embedUrl: string) => {
+		const embed = embeds[embedUrl]
+		if (!embed) throw new Error(`Missing embed with url '${embedUrl}'`)
+		return embed
+	}

package/src/common/index.ts

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

package/src/customtypes/CustomType.ts

@@ -8,7 +8,6 @@ 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",
@@ -195,15 +194,3 @@ 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,24 +1,18 @@
-import type { Asset, AssetId } from "../../common"
+import type { Asset } from "../../common"
+import type { Embed } from "../../common/Embed"
 import type { Document, WidgetContent } from "../../content"
-import type { StaticCustomType } from "../../customtypes"
-import { flattenCustomTypeFields, StaticWidget } from "../../customtypes"
 import type { ImportDocument } from "../validators"
 import type { ImportField } from "../validators/fields/ImportField"
 import { convertNestableWidget, uidConverter } from "./fields"
 
 export function convertImportToContent(
 	document: ImportDocument,
-	assets: Record<AssetId, Asset>,
-	customType: StaticCustomType,
+	assets: Record<string, Asset>,
+	embeds: Record<string, Embed>,
 ): Document {
-	const fieldModels = flattenCustomTypeFields(customType)
 	return Object.entries(document).reduce<Document>(
 		(acc, [fieldKey, fieldValue]) => {
-			const newFieldValue = convertWidget(
-				fieldValue,
-				assets,
-				fieldModels[fieldKey],
-			)
+			const newFieldValue = convertWidget(fieldValue, assets, embeds)
 			return newFieldValue ? { ...acc, [fieldKey]: newFieldValue } : acc
 		},
 		{},
@@ -27,13 +21,13 @@ export function convertImportToContent(
 
 function convertWidget(
 	field: ImportField,
-	assets: Record<AssetId, Asset>,
-	model?: StaticWidget,
+	assets: Record<string, Asset>,
+	embeds: Record<string, Embed>,
 ): WidgetContent | undefined {
 	switch (field.type) {
 		case "UID":
 			return uidConverter(field.value)
 		default:
-			return convertNestableWidget(field, assets, model)
+			return convertNestableWidget(field, assets, embeds)
 	}
 }

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

@@ -1,15 +1,37 @@
+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
-
-	return {
-		...field,
-		__TYPE__: "EmbedContent",
-	}
-
-	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],
+		],
+	)
 }

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

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

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

@@ -1,6 +1,6 @@
-import type { Asset, AssetId } from "../../../../common"
+import type { Asset } from "../../../../common"
+import type { Embed } from "../../../../common/Embed"
 import type { WidgetContent } from "../../../../content"
-import type { StaticWidget } from "../../../../customtypes"
 import type { ImportNestable } from "../../../validators"
 import {
 	booleanConverter,
@@ -18,8 +18,8 @@ import {
 
 export function convertNestableWidget(
 	field: ImportNestable,
-	assets: Record<AssetId, Asset>,
-	model?: StaticWidget,
+	assets: Record<string, Asset>,
+	embeds: Record<string, Embed>,
 ): WidgetContent | undefined {
 	switch (field.type) {
 		case "Boolean":
@@ -37,13 +37,13 @@ export function convertNestableWidget(
 		case "Timestamp":
 			return timestampConverter(field.value)
 		case "Embed":
-			return embedConverter(field.value)
+			return embedConverter(field.value, embeds)
 		case "GeoPoint":
 			return geopointConverter(field.value)
 		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/Document.ts

@@ -6,7 +6,6 @@ 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"
 
@@ -15,6 +14,15 @@ 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/Embed.ts

@@ -1,14 +1,8 @@
-import * as Either from "fp-ts/lib/Either"
+import * as Either from "fp-ts/Either"
 import { pipe } from "fp-ts/lib/function"
 import * as t from "io-ts"
-import { withMessage } from "io-ts-types"
 
 import { EmptyObjectOrElse } from "../../../../validators"
-import {
-	NumberOrNull,
-	String,
-	StringOrNull,
-} from "../../../../validators/BasicTypes"
 import { ImportContent } from "../ImportContent"
 
 type URL = string
@@ -38,49 +32,23 @@ const EmbedUrl = new t.Type<URL, URL, unknown>(
 	t.identity,
 )
 
-const EmbedProto = t.exact(
-	t.intersection([
-		t.type({
-			embed_url: EmbedUrl,
-			type: String,
-		}),
-		t.partial({
-			version: withMessage(
-				t.union([t.string, t.number, t.null]),
-				() => "The value must be either string, number or null",
-			),
-			title: String,
-			author_name: StringOrNull,
-			author_url: StringOrNull,
-			provider_name: StringOrNull,
-			provider_url: StringOrNull,
-			cache_age: withMessage(
-				t.union([t.string, t.number, t.null]),
-				() => "The value must be either string, number or null",
-			),
-			thumbnail_url: StringOrNull,
-			thumbnail_width: NumberOrNull,
-			thumbnail_height: NumberOrNull,
-			html: StringOrNull,
-		}),
-	]),
-)
+const EmbedProto = t.type({
+	embed_url: EmbedUrl,
+})
 type EmbedProto = t.TypeOf<typeof EmbedProto>
 
-type Embed = EmbedProto & {
-	all: unknown
-}
-const embedValue = new t.Type<Embed>(
+type Embed = EmbedProto
+const Embed = new t.Type<Embed>(
 	"ImportEmbedValue",
-	(u: unknown): u is Embed => EmbedProto.is(u) && "all" in u,
+	(u: unknown): u is Embed => EmbedProto.is(u),
 	(u: unknown) => {
 		return pipe(
 			EmbedProto.decode(u),
-			Either.map((parsed) => ({ ...parsed, all: u })),
+			Either.map((parsed) => ({ embed_url: parsed.embed_url })),
 		)
 	},
 	t.identity,
 )
 
-export const ImportEmbed = ImportContent("Embed", EmptyObjectOrElse(embedValue))
+export const ImportEmbed = ImportContent("Embed", EmptyObjectOrElse(Embed))
 export type ImportEmbed = t.TypeOf<typeof ImportEmbed>

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

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