@prismicio/types-internal 2.2.1-alpha.0 → 2.2.1

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

@@ -1,14 +0,0 @@
-import type { ColorContent } from "../../../../content"
-import type { ImportColor } from "../../../validators"
-
-export const colorConverter = (
-	field: ImportColor["value"],
-): ColorContent | undefined => {
-	if (field === null) return
-
-	return {
-		type: "Color",
-		value: field,
-		__TYPE__: "FieldContent",
-	}
-}

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

@@ -1,17 +0,0 @@
-import type { DateContent } from "../../../../content"
-import type { ImportDate } from "../../../validators"
-
-export const dateConverter = (
-	field: ImportDate["value"],
-): DateContent | undefined => {
-	if (field === null) return
-
-	const isoDate = field.toISOString()
-	const [withoutTime] = isoDate.split("T")
-
-	return {
-		type: "Date",
-		value: withoutTime || isoDate,
-		__TYPE__: "FieldContent",
-	}
-}

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

@@ -1,37 +0,0 @@
-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 | undefined>,
-): 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],
-		],
-	)
-}

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

@@ -1,16 +0,0 @@
-import type { GeoPointContent } from "../../../../content"
-import type { ImportGeoPoint } from "../../../validators"
-
-export const geopointConverter = (
-	field: ImportGeoPoint["value"],
-): GeoPointContent | undefined => {
-	if (field === null) return
-
-	return {
-		position: {
-			lat: field.latitude,
-			lng: field.longitude,
-		},
-		__TYPE__: "GeoPointContent",
-	}
-}

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

@@ -1,91 +0,0 @@
-import type { Asset } from "../../../../common"
-import { getAssetOrThrow } from "../../../../common"
-import type { ImageContent, ImageContentView } from "../../../../content"
-import { withOptionals } from "../../../../utils/Objects"
-import type { ImageField, ImportImage } from "../../../validators"
-import type { ImportImageBlock } from "../../../validators/fields/nestable/ImportRichText/blocks"
-
-export function convertImageView<Input extends ImageField | ImportImageBlock>(
-	inputImage: Input,
-	image: Asset,
-) {
-	// We can do that because anyway all properties being read
-	const imageField: ImageField = {
-		...inputImage,
-		edit: {
-			x: 0,
-			y: 0,
-			zoom: 1,
-			...inputImage.edit,
-		},
-		dimensions: inputImage.dimensions ?? {},
-	}
-	return withOptionals<ImageContentView>(
-		{
-			origin: {
-				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,
-			},
-			// 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: imageField.edit?.zoom ?? 1,
-				crop: {
-					x: imageField.edit?.x ?? 0,
-					y: imageField.edit?.y ?? 0,
-				},
-				background:
-					imageField.edit?.background ??
-					(image.extension === "png" ? "transparent" : "#ffffff"),
-			},
-			url: image.url,
-		},
-		[
-			["alt", imageField?.alt || image.alt],
-			["credits", imageField?.copyright || image.credits],
-		],
-	)
-}
-
-function convertThumbnails(
-	imageField: Exclude<ImportImage["value"], null>,
-	assets: Record<Asset["id"], Asset | undefined>,
-) {
-	return Object.entries(imageField.thumbnails).reduce(
-		(acc, [thumbnailName, thumbnail]) => {
-			return {
-				...acc,
-				[thumbnailName]: convertImageView(
-					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 = (
-	imageField: ImportImage["value"],
-	assets: Record<Asset["id"], Asset | undefined>,
-): ImageContent | undefined => {
-	if (!imageField) return
-
-	return {
-		...convertImageView<ImageField>(
-			imageField,
-			getAssetOrThrow(assets)(imageField.id),
-		),
-		thumbnails: convertThumbnails(imageField, assets),
-		__TYPE__: "ImageContent" as const,
-	}
-}

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

@@ -1,77 +0,0 @@
-import type { Asset } from "../../../../common"
-import { getAssetOrThrow } from "../../../../common"
-import type { LinkContent } from "../../../../content"
-import type {
-	DocumentLink,
-	ImportLink,
-	MediaLink,
-	WebLink,
-} from "../../../validators"
-
-const webLinkConverter = (field: WebLink): LinkContent => ({
-	value: {
-		url: field.url,
-		target: field.target,
-		__TYPE__: "ExternalLink",
-	},
-	__TYPE__: "LinkContent",
-})
-
-const documentLinkConverter = (field: DocumentLink): LinkContent => ({
-	value: {
-		id: field.id,
-		__TYPE__: "DocumentLink",
-	},
-	__TYPE__: "LinkContent",
-})
-
-const fileLinkConverter = (field: MediaLink, asset: Asset): LinkContent => ({
-	value: {
-		id: field.id,
-		url: asset.origin_url,
-		name: asset.filename ?? "unknown.jpg",
-		kind: asset.kind,
-		size: asset.size ? String(asset.size) : "0",
-		__TYPE__: "FileLink",
-	},
-	__TYPE__: "LinkContent",
-})
-
-const imageLinkConverter = (field: MediaLink, asset: Asset): LinkContent => ({
-	value: {
-		id: field.id,
-		url: asset.origin_url,
-		height: String(asset.height ?? 1),
-		width: String(asset.width ?? 1),
-		name: asset.filename ?? "unknown.jpg",
-		kind: asset.kind,
-		size: asset.size ? String(asset.size) : "0",
-		__TYPE__: "ImageLink",
-	},
-	__TYPE__: "LinkContent",
-})
-
-export const linkConverter = (
-	field: ImportLink["value"],
-	assets: Record<string, Asset | undefined>,
-): LinkContent | undefined => {
-	if (field === null) {
-		return
-	}
-
-	switch (field.link_type) {
-		case "Web":
-			return webLinkConverter(field)
-		case "Document":
-			return documentLinkConverter(field)
-		case "Media": {
-			const asset = getAssetOrThrow(assets)(field.id)
-			switch (asset.kind) {
-				case "all":
-					return fileLinkConverter(field, asset)
-				case "image":
-					return imageLinkConverter(field, asset)
-			}
-		}
-	}
-}

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

@@ -1,55 +0,0 @@
-import type { Asset } from "../../../../common"
-import type { Embed } from "../../../../common/Embed"
-import type { NestableContent } from "../../../../content"
-import type { ImportNestable } from "../../../validators"
-import {
-	booleanConverter,
-	colorConverter,
-	dateConverter,
-	embedConverter,
-	geopointConverter,
-	imageConverter,
-	linkConverter,
-	numberConverter,
-	richTextConverter,
-	selectConverter,
-	textConverter,
-	timestampConverter,
-} from "."
-
-export function convertNestableWidget(
-	field: ImportNestable,
-	assets: Record<Asset["id"], Asset | undefined>,
-	embeds: Record<string, Embed | undefined>,
-): NestableContent | undefined {
-	switch (field.type) {
-		case "Boolean":
-			return booleanConverter(field.value)
-		case "Color":
-			return colorConverter(field.value)
-		case "Select":
-			return selectConverter(field.value)
-		case "Number":
-			return numberConverter(field.value)
-		case "Text":
-			return textConverter(field.value)
-		case "Date":
-			return dateConverter(field.value)
-		case "Timestamp":
-			return timestampConverter(field.value)
-		case "Embed":
-			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)
-		case "StructuredText":
-			return richTextConverter(field.value, assets, embeds)
-		default:
-			throw new Error(
-				`Unsupported type of nestable converter ${JSON.stringify(field)}`,
-			)
-	}
-}

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

@@ -1,14 +0,0 @@
-import type { NumberContent } from "../../../../content"
-import type { ImportNumber } from "../../../validators"
-
-export const numberConverter = (
-	field: ImportNumber["value"],
-): NumberContent | undefined => {
-	if (field === null) return
-
-	return {
-		type: "Number",
-		value: field.toString(),
-		__TYPE__: "FieldContent",
-	}
-}

package/src/import/converters/fields/nestable/RichText/embedBlock.ts

@@ -1,17 +0,0 @@
-import type { Embed } from "../../../../../common"
-import type { EmbedBlock } from "../../../../../content"
-import type { ImportEmbedBlock } from "../../../../validators/fields/nestable/ImportRichText/blocks"
-import { embedConverter } from "../Embed"
-
-export function embedBlockConverter(
-	block: ImportEmbedBlock,
-	embeds: Record<string, Embed | undefined>,
-): EmbedBlock {
-	const embedData = embedConverter(block.oembed, embeds)
-
-	if (!embedData) throw new Error("Failed to convert embed data")
-	return {
-		type: block.type,
-		data: embedData,
-	}
-}

package/src/import/converters/fields/nestable/RichText/imageBlock.ts

@@ -1,17 +0,0 @@
-import { Asset, getAssetOrThrow } from "../../../../../common"
-import type { ImageBlock } from "../../../../../content"
-import type { ImportImageBlock } from "../../../../validators/fields/nestable/ImportRichText/blocks"
-import { convertImageView } from "../Image"
-
-export function imageBlockConverter(
-	block: ImportImageBlock,
-	assets: Record<Asset["id"], Asset | undefined>,
-): ImageBlock {
-	return {
-		type: block.type,
-		data: convertImageView<ImportImageBlock>(
-			block,
-			getAssetOrThrow(assets)(block.id),
-		),
-	}
-}

package/src/import/converters/fields/nestable/RichText/index.ts

@@ -1,23 +0,0 @@
-import type { Asset, Embed } from "../../../../../common"
-import type { RichTextContent } from "../../../../../content"
-import { RichTextContentType } from "../../../../../content"
-import type { ImportRichText } from "../../../../validators"
-import { embedBlockConverter } from "./embedBlock"
-import { imageBlockConverter } from "./imageBlock"
-import { textBlockConverter } from "./textBlock"
-
-export const richTextConverter = (
-	richTextField: ImportRichText["value"],
-	assets: Record<Asset["id"], Asset | undefined>,
-	embeds: Record<string, Embed | undefined>,
-): RichTextContent | undefined => {
-	if (richTextField === null) return
-	return {
-		__TYPE__: RichTextContentType,
-		value: richTextField.map((block) => {
-			if (block.type === "image") return imageBlockConverter(block, assets)
-			else if (block.type === "embed") return embedBlockConverter(block, embeds)
-			return textBlockConverter(block, assets)
-		}),
-	}
-}

package/src/import/converters/fields/nestable/RichText/textBlock.ts

@@ -1,62 +0,0 @@
-import type { Asset } from "../../../../../common"
-import type { Span, TextBlock } from "../../../../../content"
-import type { ImportTextBlock } from "../../../../validators/fields/nestable/ImportRichText/blocks"
-import { linkConverter } from "../Link"
-
-export function textBlockConverter(
-	block: ImportTextBlock,
-	assets: Record<Asset["id"], Asset | undefined>,
-): TextBlock {
-	return {
-		type: block.type,
-		content: {
-			text: block.text,
-			...(() => {
-				if (block.spans) {
-					const convertedSpans = spansConverter(block.spans, assets)
-					if (!convertedSpans) return {}
-
-					return { spans: convertedSpans }
-				}
-				return {}
-			})(),
-		},
-		...(block.direction ? { direction: block.direction } : {}),
-	}
-}
-
-function spansConverter(
-	spans: NonNullable<ImportTextBlock["spans"]>,
-	assets: Record<Asset["id"], Asset | undefined>,
-): Span[] {
-	return spans.reduce<Span[]>((acc, span) => {
-		switch (span.type) {
-			case "em":
-			case "strong":
-				return [...acc, span]
-			case "label":
-				return [
-					...acc,
-					{
-						...span,
-						data: span.data.label,
-					},
-				]
-
-			case "hyperlink": {
-				const convertedLink = linkConverter(span.data, assets)
-				if (!convertedLink) return acc
-
-				return [
-					...acc,
-					{
-						type: span.type,
-						start: span.start,
-						end: span.end,
-						data: convertedLink.value,
-					},
-				]
-			}
-		}
-	}, [])
-}

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

@@ -1,14 +0,0 @@
-import type { SelectContent } from "../../../../content"
-import type { ImportSelect } from "../../../validators"
-
-export const selectConverter = (
-	field: ImportSelect["value"],
-): SelectContent | undefined => {
-	if (field === null) return
-
-	return {
-		type: "Select",
-		value: field,
-		__TYPE__: "FieldContent",
-	}
-}

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

@@ -1,14 +0,0 @@
-import type { TextContent } from "../../../../content"
-import type { ImportText } from "../../../validators"
-
-export const textConverter = (
-	field: ImportText["value"],
-): TextContent | undefined => {
-	if (field === null) return
-
-	return {
-		type: "Text",
-		value: field,
-		__TYPE__: "FieldContent",
-	}
-}

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

@@ -1,14 +0,0 @@
-import type { TimestampContent } from "../../../../content"
-import type { ImportTimestamp } from "../../../validators"
-
-export const timestampConverter = (
-	field: ImportTimestamp["value"],
-): TimestampContent | undefined => {
-	if (field === null) return
-
-	return {
-		type: "Timestamp",
-		value: field.toISOString(),
-		__TYPE__: "FieldContent",
-	}
-}

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

@@ -1,13 +0,0 @@
-export * from "./Boolean"
-export * from "./Color"
-export * from "./Date"
-export * from "./Embed"
-export * from "./GeoPoint"
-export * from "./Image"
-export * from "./Link"
-export * from "./Nestable"
-export * from "./Number"
-export * from "./RichText"
-export * from "./Select"
-export * from "./Text"
-export * from "./Timestamp"

package/src/import/converters/index.ts

@@ -1,2 +0,0 @@
-export * from "./Document"
-export * from "./fields"

package/src/import/index.ts

@@ -1,2 +0,0 @@
-export * from "./converters"
-export * from "./validators"

package/src/import/validators/Document.ts

@@ -1,103 +0,0 @@
-import { either } from "fp-ts"
-import { Either, isLeft } from "fp-ts/Either"
-import { pipe } from "fp-ts/lib/function"
-import * as t from "io-ts"
-
-import type { WidgetKey } from "../../common"
-import type { StaticCustomType, StaticWidget } from "../../customtypes"
-import { flattenCustomTypeFields } from "../../customtypes"
-import { isObject } from "../../utils/Objects"
-import { withCustomError } from "../../validators/function"
-import { ImportField } from "./fields/ImportField"
-
-const rawImportDocument = withCustomError(
-	t.UnknownRecord,
-	() => "document is not an object",
-)
-
-function validateField(
-	document: Record<string, unknown>,
-	customType: StaticCustomType,
-) {
-	return (
-		key: string,
-		content: unknown,
-		model?: StaticWidget,
-	): Either<t.Errors, ImportField> => {
-		// the field is not defined in the custom type -> extra field or typo
-		if (!model) {
-			const error: t.ValidationError = {
-				value: content,
-				context: [{ key: key, type: t.unknown }],
-				message: `The field ${key} is not part of the Custom type`,
-			}
-			return either.left([error])
-		}
-
-		// retrieving the right codec then testing out fieldValue with it.
-		const { result, codec } = ImportField.decode(model)(content)
-
-		// error.context is pointing at root when it should point to a `fieldKey`.
-		// We need to override the context to make it right.
-		if (isLeft(result)) {
-			const errors: t.Errors = result.left.map((error) => {
-				const contextHead = error.context[0]
-				const context = [
-					{ key: "", actual: document, type: ImportDocument(customType) },
-					contextHead
-						? { ...contextHead, key: key }
-						: { key: key, actual: content, type: codec },
-					...error.context.slice(1),
-				]
-
-				return { ...error, context }
-			})
-			return either.left(errors)
-		}
-		return either.right(result.right)
-	}
-}
-
-function validateDocument(
-	customType: StaticCustomType,
-	rawDoc: Record<string, unknown>,
-) {
-	const fieldModels = flattenCustomTypeFields(customType)
-	const { document, errors } = Object.entries(rawDoc).reduce<{
-		document: ImportDocument
-		errors: t.Errors
-	}>(
-		(acc, [fieldKey, fieldValue]) => {
-			const parsedField = validateField(rawDoc, customType)(
-				fieldKey,
-				fieldValue,
-				fieldModels[fieldKey],
-			)
-
-			if (isLeft(parsedField))
-				return { ...acc, errors: [...acc.errors, ...parsedField.left] }
-
-			return {
-				...acc,
-				document: { ...acc.document, [fieldKey]: parsedField.right },
-			}
-		},
-		{ document: {}, errors: [] },
-	)
-	if (errors.length > 0) return either.left(errors)
-	return either.right(document)
-}
-
-export type ImportDocument = Record<WidgetKey, ImportField>
-export const ImportDocument = (customType: StaticCustomType) =>
-	new t.Type<ImportDocument, ImportDocument, unknown>(
-		"ImportDocument",
-		(u): u is ImportDocument => isObject(u),
-		(raw: unknown) => {
-			return pipe(
-				rawImportDocument.decode(raw),
-				either.chain((doc) => validateDocument(customType, doc)),
-			)
-		},
-		t.identity,
-	)

package/src/import/validators/fields/ImportContent.ts

@@ -1,30 +0,0 @@
-import { either } from "fp-ts"
-import { pipe } from "fp-ts/lib/function"
-import * as t from "io-ts"
-
-import type { FieldType } from "../../../customtypes"
-import { isObject } from "../../../utils/Objects"
-
-export const ImportContent = <T extends FieldType, A, O = A>(
-	type: T,
-	valueCodec: t.Type<A, O>,
-) =>
-	new t.Type<{ type: T; value: A }, O>(
-		`ImportField: ${valueCodec.name}`,
-		(u: unknown): u is { type: T; value: A } => {
-			if (!isObject(u)) return false
-			return type === u["type"] && valueCodec.is(u["value"])
-		},
-		(u: unknown, c) => {
-			return pipe(
-				valueCodec.validate(u, c),
-				either.map((decodedValue) => {
-					return {
-						type,
-						value: decodedValue,
-					}
-				}),
-			)
-		},
-		(field) => field.value as unknown as O,
-	)