@prismicio/types-internal 2.2.0-alpha.2 → 2.2.0-alpha.21

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

@@ -0,0 +1,77 @@
+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,13 +1,17 @@
-import type { WidgetContent } from "../../../../content"
+import type { Asset } from "../../../../common"
+import type { Embed } from "../../../../common/Embed"
+import type { NestableContent } from "../../../../content"
 import type { ImportNestable } from "../../../validators"
 import {
-	Asset,
 	booleanConverter,
 	colorConverter,
 	dateConverter,
 	embedConverter,
+	geopointConverter,
 	imageConverter,
+	linkConverter,
 	numberConverter,
+	richTextConverter,
 	selectConverter,
 	textConverter,
 	timestampConverter,
@@ -15,8 +19,9 @@ import {
 
 export function convertNestableWidget(
 	field: ImportNestable,
-	images: Map<string, Asset>,
-): WidgetContent | undefined {
+	assets: Record<Asset["id"], Asset | undefined>,
+	embeds: Record<string, Embed | undefined>,
+): NestableContent | undefined {
 	switch (field.type) {
 		case "Boolean":
 			return booleanConverter(field.value)
@@ -33,9 +38,15 @@ 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, images)
+			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/RichText/embedBlock.ts

@@ -0,0 +1,14 @@
+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

@@ -0,0 +1,14 @@
+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

@@ -0,0 +1,23 @@
+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

@@ -0,0 +1,35 @@
+import type { Asset } from "../../../../../common"
+import type { 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,
+      ...block.spans ? { spans: spansConverter(block.spans, assets) }: {}
+    },
+    ...block.direction ? { direction: block.direction } : {},
+  }
+}
+
+function spansConverter(spans: NonNullable<ImportTextBlock['spans']>, assets: Record<Asset["id"], Asset | undefined>): TextBlock['content']['spans'] {
+  return spans.map(span => {
+    if (span.type === 'hyperlink') {
+      const { __TYPE__, ...data } = linkConverter(span.data, assets)?.value || {}
+      return {
+        type: span.type,
+        start: span.start,
+        end: span.end,
+        data: data
+      }
+    }
+
+    return {
+      type: span.type,
+      start: span.start,
+      end: span.end
+    }
+  })
+}

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

@@ -2,9 +2,12 @@ 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/validators/Document.ts

@@ -2,27 +2,19 @@ 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 { 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 { withCustomError } from "../../validators/function"
 import { ImportField } from "./fields/ImportField"
 
-const rawImportDocument = withMessage(
-	t.record(t.string, t.unknown),
+const rawImportDocument = withCustomError(
+	t.UnknownRecord,
 	() => "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/ImportField.ts

@@ -1,20 +1,26 @@
 import type { StaticWidget } from "../../../customtypes"
+import { ImportSlices } from "./ImportSlices"
 import { ImportNestable } from "./nestable"
-import { ImportUID } from "./UID"
 
-export type ImportField = ImportUID | ImportNestable
+export type ImportField = ImportSlices | ImportNestable
 
 export const ImportField = {
-	is(u: unknown): u is ImportNestable {
-		return ImportUID.is(u) || ImportNestable.is(u)
+	is(u: unknown): u is ImportField {
+		return ImportField.is(u)
 	},
 	decode: (field: StaticWidget) => {
 		return (content: unknown) => {
 			switch (field.type) {
 				case "UID":
-					return { codec: ImportUID, result: ImportUID.decode(content) }
-				case "Choice":
+					throw new Error(
+						`The field '${field.type}' should be put at the root level of the document`,
+					)
 				case "Slices":
+					return {
+						codec: ImportSlices(field),
+						result: ImportSlices(field).decode(content),
+					}
+				case "Choice":
 				case "Group":
 					throw new Error(`Unsupported type of field ${field.type}`)
 				default:

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

@@ -0,0 +1,54 @@
+import * as E from "fp-ts/Either"
+import { pipe } from "fp-ts/function"
+import * as t from "io-ts"
+
+import type { StaticSlices } from "../../../../customtypes"
+import { EmptyObjectOrElse } from "../../../../validators"
+import { ImportContent } from "../ImportContent"
+import { SharedSlice } from "./SharedSlice"
+import {
+	extractSupportedSlices,
+	findImportSharedSliceDuplicateIds,
+} from "./utils"
+
+export const ImportSlices = (staticSlices: StaticSlices) => {
+	const supportedSlices = extractSupportedSlices(staticSlices)
+
+	// For now we only support the SharedSlice, however if we want to support more in the future
+	// we would have to change the codec here to something like this: t.array(t.union([ImportSharedSlice(sharedSlices), NewSliceCodec(newSliceCustomTypes)])).
+	const SlicesArrayCodec = t.array(SharedSlice(supportedSlices))
+
+	return ImportContent(
+		"Slices",
+		EmptyObjectOrElse(
+			new t.Type<SharedSlice[]>(
+				"ImportSlices",
+				(u): u is SharedSlice[] => SlicesArrayCodec.is(u),
+				(u, c) => {
+					return pipe(
+						SlicesArrayCodec.validate(u, c),
+						E.chain((slices) => {
+							// This part might not make sense for all Slice types in the future, but for now we only support the SharedSlice
+							// In case we support more in the future, we would have to filter only the relevant type for this check
+							const sharedSliceDuplicates =
+								findImportSharedSliceDuplicateIds(slices)
+							if (sharedSliceDuplicates.length > 0) {
+								return t.failure(
+									slices,
+									[],
+									`Duplicate slice IDs detected: ${sharedSliceDuplicates.join(
+										", ",
+									)}`,
+								)
+							}
+							return t.success(slices)
+						}),
+					)
+				},
+				t.identity,
+			),
+		),
+	)
+}
+
+export type ImportSlices = t.TypeOf<ReturnType<typeof ImportSlices>>

package/src/import/validators/fields/ImportSlices/SharedSlice/SharedSlice.ts

@@ -0,0 +1,116 @@
+import * as E from "fp-ts/Either"
+import { pipe } from "fp-ts/function"
+import * as t from "io-ts"
+
+import type { SharedSlice as SharedSliceCustomType } from "../../../../../customtypes"
+import { NonEmptyString, String } from "../../../../../validators"
+import { withCustomError } from "../../../../../validators/function"
+import {
+	OptionalSharedSliceId,
+	SharedSliceContent,
+	SharedSliceId,
+	SharedSliceType,
+	SharedSliceVariation,
+} from "./fields"
+
+export type SharedSlice = {
+	id: SharedSliceId | null | undefined
+	slice_type: string
+	name: string
+	variation: string
+	primary: SharedSliceContent | null | undefined
+	items: SharedSliceContent[] | null | undefined
+	slice_label: string | null | undefined
+	version: string | null | undefined
+}
+
+const SharedSliceShape = t.strict({
+	id: OptionalSharedSliceId,
+	slice_type: NonEmptyString,
+	name: String,
+	variation: NonEmptyString,
+	primary: t.union([t.undefined, t.null, t.record(NonEmptyString, t.unknown)]),
+	items: t.union([
+		t.undefined,
+		t.null,
+		t.array(t.record(NonEmptyString, t.unknown)),
+	]),
+	slice_label: t.union([t.undefined, t.null, String]),
+	version: t.union([t.undefined, t.null, String]),
+})
+
+export const SharedSlice = (sharedSlices: SharedSliceCustomType[]) =>
+	new t.Type<SharedSlice>(
+		"SharedSlice",
+		(u): u is SharedSlice => SharedSliceShape.is(u),
+		(u, c) =>
+			pipe(
+				// We validate the base fields that we can validate directly based on the provided 'sharedSlices'
+				t
+					.type({
+						id: OptionalSharedSliceId,
+						slice_type: SharedSliceType(sharedSlices),
+						slice_label: t.union([t.undefined, t.null, String]),
+						version: t.union([t.undefined, t.null, String]),
+					})
+					.validate(u, c),
+				E.chain((decoded) =>
+					pipe(
+						// We validate the 'variation' field, for which we need the SharedSlice custom type retrieved in the first step
+						t
+							.type({
+								variation: SharedSliceVariation(decoded.slice_type.data),
+							})
+							.validate(u, c),
+						E.map(({ variation }) => ({ ...decoded, variation })),
+					),
+				),
+				E.chain((decoded) =>
+					pipe(
+						// We validate the 'primary' and 'items' content fields, for which we need the Variation custom type retrieved in the previous step
+						t
+							.partial({
+								primary: SharedSliceContent(
+									decoded.slice_type.slice_type,
+									"primary",
+									decoded.variation.data.primary ?? {},
+								),
+								// We need to use this wrapper codec instead of using t.array(SharedSliceContent) directly in order to get proper custom error messages
+								items: withCustomError(
+									t.array(
+										SharedSliceContent(
+											decoded.slice_type.slice_type,
+											"items",
+											decoded.variation.data.items ?? {},
+										),
+									),
+									() => "The value must be an array",
+								),
+							})
+							.validate(u, c),
+						E.map(({ primary, items }) => ({ ...decoded, primary, items })),
+					),
+				),
+				E.map(
+					({
+						id,
+						slice_type,
+						variation,
+						primary,
+						items,
+						slice_label,
+						version,
+					}) => ({
+						id,
+						slice_type: slice_type.slice_type,
+						name: slice_type.data.name,
+						variation: variation.variation,
+						primary,
+						items,
+						slice_label,
+						version: version ?? variation.data.version,
+					}),
+				),
+			),
+		t.identity,
+	)

package/src/import/validators/fields/ImportSlices/SharedSlice/errors.ts

@@ -0,0 +1,6 @@
+export const SharedSliceErrors = {
+	SliceTypeNotFound: (slice_type: string) =>
+		`Shared slice '${slice_type}' not found in this slice zone in the document's custom type`,
+	VariationNotFound: (variation: string, slice_type: string) =>
+		`Variation '${variation}' not found for Slice '${slice_type}'`,
+} as const

package/src/import/validators/fields/ImportSlices/SharedSlice/fields/OptionalSharedSliceId.ts

@@ -0,0 +1,20 @@
+import * as t from "io-ts"
+
+import { SharedSliceId } from "./SharedSliceId"
+
+// Wrapping the 'SharedSliceId' codec in an optional codec here for the sake of error reporting.
+// When using t.union([t.undefined, t.null, SharedSliceId]) we get a nested error context
+// with the actual decoding error at position 2 in the context array.
+// To avoid mutating the error context we create this new wrapper codec so that  the error context will always have desired depth.
+export const OptionalSharedSliceId = new t.Type<
+	SharedSliceId | null | undefined
+>(
+	"OptionalSharedSliceId",
+	(u): u is SharedSliceId | null | undefined =>
+		u === null || u === undefined || SharedSliceId.is(u),
+	(u, c) => {
+		if (u === null || u === undefined) return t.success(u)
+		return SharedSliceId.validate(u, c)
+	},
+	t.identity,
+)

package/src/import/validators/fields/ImportSlices/SharedSlice/fields/SharedSliceContent/SharedSliceContent.ts

@@ -0,0 +1,64 @@
+import * as E from "fp-ts/Either"
+import { pipe } from "fp-ts/lib/function"
+import * as t from "io-ts"
+
+import { WidgetKey } from "../../../../../../../common"
+import type { NestableWidget } from "../../../../../../../customtypes"
+import { combineValidationResults } from "../../../../../../../utils/io-ts"
+import { withCustomError } from "../../../../../../../validators/function"
+import type { ImportNestable } from "../../../../nestable"
+import { SharedSliceContentEntry } from "./SharedSliceContentEntry"
+
+/**
+ * Represents the object in the 'primary' field or a single item in the 'items' array in the SharedSlice.
+ */
+export type SharedSliceContent = Record<WidgetKey, ImportNestable>
+
+/**
+ * Builds the decoder for a single entry in the 'primary' field or a single item in the 'items' array in the SharedSlice.
+ *
+ * @param sliceName name of the slice - used for error reporting in order to know which slice is being decoded
+ * @param sliceContentField 'primary' or 'items' - used for error reporting in order to know which field of the slice is being decoded
+ * @param sliceFieldModels models of the fields of the slice from custom type - used to know which codec to use for decoding each value of the object
+ * @constructor
+ */
+export const SharedSliceContent = (
+	sliceName: string,
+	sliceContentField: "primary" | "items",
+	sliceFieldModels: Record<WidgetKey, NestableWidget>,
+) =>
+	new t.Type<SharedSliceContent, SharedSliceContent, unknown>(
+		"SharedSliceContent",
+		(u): u is SharedSliceContent => t.record(WidgetKey, t.unknown).is(u),
+		(u, c) =>
+			pipe(
+				// We first decode the raw content object in the shape of Record<WidgetKey, unknown>
+				withCustomError(
+					t.UnknownRecord,
+					() => "The value must be an object",
+				).validate(u, c),
+				E.chain((rawContent) =>
+					pipe(
+						// We split the object into entries because there is no easy other way to decode each value with a different codec
+						Object.entries(rawContent).map((entry) =>
+							SharedSliceContentEntry(
+								sliceName,
+								sliceContentField,
+								sliceFieldModels,
+							).validate(entry, c),
+						),
+						// We get a validation result for each entry in the content object (t.Validation<SharedSliceContentEntry>[]),
+						// however we want to get a single validation result for the whole array of entries (t.Validation<SharedSliceContentEntry[]>).
+						combineValidationResults,
+						// We build the object back from entries if all decoded successfully
+						E.map((entries) =>
+							entries.reduce(
+								(acc, [key, value]) => ({ ...acc, [key]: value }),
+								{},
+							),
+						),
+					),
+				),
+			),
+		t.identity,
+	)

package/src/import/validators/fields/ImportSlices/SharedSlice/fields/SharedSliceContent/SharedSliceContentEntry.ts

@@ -0,0 +1,100 @@
+import * as E from "fp-ts/Either"
+import { pipe } from "fp-ts/function"
+import * as t from "io-ts"
+
+import { WidgetKey } from "../../../../../../../common"
+import type { NestableWidget } from "../../../../../../../customtypes"
+import { ImportNestable } from "../../../../nestable"
+import { SharedSliceContentErrors } from "./errors"
+
+export type SharedSliceContentEntry = [WidgetKey, ImportNestable]
+/**
+ * Represents a single entry in the 'primary' field or a single entry in an item in the 'items' array in the SharedSlice. It is used to build the SharedSliceContent type from entries of the import object.
+ *
+ * For example, given the following slice:
+ * 	{
+ *  	"slice_type": "my_slice",
+ *  	"variation": "default",
+ *      "primary": {
+ *      	"slice_text": "abc", // This is one entry
+ *          "slice_text2": "def: // This is another entry
+ *       },
+ *       "items": [
+ *       	   {
+ *             		"slice_number1": 0, // This is one entry
+ *             		"slice_number2": 1	// And this is yet another entry
+ *             }
+ *       ]
+ *  }
+ *
+ *  The 'primary' object is converted to following entries to be decoded:
+ *  [
+ *      ["slice_text", "abc"],
+ *      ["slice_text2", "def"]
+ *  ]
+ *  and the first item in the 'items' array is converted to following entries to be decoded:
+ *  [
+ *    ["slice_number1", 0],
+ *    ["slice_number2", 1]
+ *  ]
+ *
+ *  We decode them as separate entries because each of the values might require a different codec as per what is specified in the SharedSlice custom type.
+ *  In this way we save on the decoding performance in comparison to a scenario where we would decode the whole content object as a record with a union type decoder for each value.
+ *
+ *  @param sliceName name of the slice - used for error reporting in order to know which slice is being decoded
+ *  @param sliceContentField 'primary' or 'items' - used for error reporting in order to know which field of the slice is being decoded
+ *  @param sliceFieldModels models of the fields of the slice from custom type - used to know which codec to use for decoding each value of the object
+ */
+export const SharedSliceContentEntry = (
+	sliceName: string,
+	sliceContentField: "primary" | "items",
+	sliceFieldModels: Record<WidgetKey, NestableWidget>,
+) =>
+	new t.Type<SharedSliceContentEntry, SharedSliceContentEntry, unknown>(
+		"SharedSliceContentEntry",
+		(u): u is SharedSliceContentEntry =>
+			t.tuple([WidgetKey, t.unknown]).is(u) && ImportNestable.is(u[1]),
+		(u, c) => {
+			return pipe(
+				t.tuple([WidgetKey, t.unknown]).validate(u, c),
+				E.chain(([key, content]) => {
+					const model: NestableWidget | undefined = sliceFieldModels[key]
+					if (!model) {
+						return t.failure(
+							[key, content],
+							[...c, { key, actual: content, type: t.unknown }],
+							SharedSliceContentErrors.UnknownField(
+								sliceName,
+								sliceContentField,
+								key,
+							),
+						)
+					}
+					const { codec, result } = ImportNestable.decode(model)(content)
+
+					return pipe(
+						result,
+						E.map<ImportNestable, SharedSliceContentEntry>((decodedContent) => [
+							key,
+							decodedContent,
+						]),
+						E.mapLeft(
+							(errors): t.Errors =>
+								errors.map((error) => {
+									const context = [
+										...c,
+										...error.context.filter(({ key }) => !!key), // We replace the "" key coming from ImportNestable decoder
+										{ key, actual: content, type: codec },
+									]
+
+									const updatedError: t.ValidationError = { ...error, context }
+
+									return updatedError
+								}),
+						),
+					)
+				}),
+			)
+		},
+		t.identity,
+	)

package/src/import/validators/fields/ImportSlices/SharedSlice/fields/SharedSliceContent/errors.ts

@@ -0,0 +1,10 @@
+import type { SharedSliceContentField } from "./types"
+
+export const SharedSliceContentErrors = {
+	UnknownField: (
+		sliceName: string,
+		contentField: SharedSliceContentField,
+		fieldName: string,
+	) =>
+		`Unsupported field '${fieldName}'for '${contentField}' content in Shared Slice '${sliceName}'`,
+} as const

package/src/import/validators/fields/ImportSlices/SharedSlice/fields/SharedSliceContent/index.ts

@@ -0,0 +1,2 @@
+export * from "./errors"
+export * from "./SharedSliceContent"