@prismicio/types-internal 3.17.0 → 4.0.0-canary.72def6d

package/src/content/codec/empty.ts

@@ -0,0 +1,49 @@
+import { z } from "zod/mini"
+
+import { EmptyContentSchema, EmptyContentType } from "../empty"
+import type { EmptyContent } from "../empty"
+import { EmptyLegacySchema } from "../legacy/empty"
+import type { EmptyLegacy } from "../legacy/empty"
+import type { LegacyContentCtx, LegacyCodec } from "./legacyContentCtx"
+
+const UnsupportedEmptyLegacySchema = z.never()
+
+export const EmptyLegacyCodec = (
+	ctx: LegacyContentCtx,
+): LegacyCodec<EmptyContent, EmptyLegacy> => ({
+	name: "EmptyLegacy",
+
+	is(input): input is EmptyContent {
+		return EmptyContentSchema.safeParse(input).success
+	},
+
+	decode(input) {
+		if (!ctx.fieldType) {
+			return UnsupportedEmptyLegacySchema.safeParse(
+				input,
+			) as z.core.util.SafeParseError<EmptyLegacy>
+		}
+
+		const parsed = EmptyLegacySchema.safeParse(input)
+		if (!parsed.success) {
+			return parsed
+		}
+
+		return {
+			success: true,
+			data: {
+				__TYPE__: EmptyContentType,
+				type: ctx.fieldType,
+			},
+		}
+	},
+
+	encode(input) {
+		const type = ctx.fieldType ?? input.type
+		return {
+			content: null,
+			types: { [ctx.keyOfType]: type },
+			keys: {},
+		} as ReturnType<LegacyCodec<EmptyContent, EmptyLegacy>["encode"]>
+	},
+})

package/src/content/codec/field.ts

@@ -0,0 +1,96 @@
+import type { z } from "zod/mini"
+
+import {
+	ColorContentSchema,
+	DateContentSchema,
+	FieldContentType,
+	NumberContentSchema,
+	RangeContentSchema,
+	SelectContentSchema,
+	TextContentSchema,
+	TimestampContentSchema,
+} from "../field"
+import type {
+	ColorContent,
+	DateContent,
+	NumberContent,
+	RangeContent,
+	SelectContent,
+	TextContent,
+	TimestampContent,
+} from "../field"
+import type { StringLegacy } from "../legacy/field"
+import { StringLegacySchema } from "../legacy/field"
+import type { LegacyContentCtx, LegacyCodec } from "./legacyContentCtx"
+
+type LegacyFieldContent =
+	| TextContent
+	| ColorContent
+	| DateContent
+	| TimestampContent
+	| NumberContent
+	| RangeContent
+	| SelectContent
+
+function createFieldLegacyCodec<TContent extends LegacyFieldContent>(
+	ctx: LegacyContentCtx,
+	name: string,
+	type: TContent["type"],
+	schema: z.ZodMiniType<TContent>,
+): LegacyCodec<TContent, StringLegacy> {
+	return {
+		name,
+		is(input): input is TContent {
+			return schema.safeParse(input).success
+		},
+		decode(input) {
+			const parsed = StringLegacySchema.safeParse(input)
+			if (!parsed.success) {
+				return parsed
+			}
+
+			return {
+				success: true,
+				data: {
+					__TYPE__: FieldContentType,
+					type,
+					value: parsed.data,
+				} as TContent,
+			}
+		},
+		encode(input) {
+			return {
+				content: input.value,
+				types: { [ctx.keyOfType]: type },
+				keys: {},
+			}
+		},
+	}
+}
+
+export const TextLegacyCodec = (ctx: LegacyContentCtx): LegacyCodec<TextContent, StringLegacy> =>
+	createFieldLegacyCodec(ctx, "TextLegacy", "Text", TextContentSchema)
+
+export const ColorLegacyCodec = (ctx: LegacyContentCtx): LegacyCodec<ColorContent, StringLegacy> =>
+	createFieldLegacyCodec(ctx, "ColorLegacy", "Color", ColorContentSchema)
+
+export const DateLegacyCodec = (ctx: LegacyContentCtx): LegacyCodec<DateContent, StringLegacy> =>
+	createFieldLegacyCodec(ctx, "DateLegacy", "Date", DateContentSchema)
+
+export const TimestampLegacyCodec = (
+	ctx: LegacyContentCtx,
+): LegacyCodec<TimestampContent, StringLegacy> =>
+	createFieldLegacyCodec(ctx, "TimestampLegacy", "Timestamp", TimestampContentSchema)
+
+export const NumberLegacyCodec = (
+	ctx: LegacyContentCtx,
+): LegacyCodec<NumberContent, StringLegacy> =>
+	createFieldLegacyCodec(ctx, "NumberLegacy", "Number", NumberContentSchema)
+
+export const RangeLegacyCodec = (ctx: LegacyContentCtx): LegacyCodec<RangeContent, StringLegacy> =>
+	createFieldLegacyCodec(ctx, "RangeLegacy", "Range", RangeContentSchema)
+
+export const SelectLegacyCodec = (
+	ctx: LegacyContentCtx,
+): LegacyCodec<SelectContent, StringLegacy> =>
+	createFieldLegacyCodec(ctx, "SelectLegacy", "Select", SelectContentSchema)

package/src/content/codec/geopoint.ts

@@ -0,0 +1,40 @@
+import { GeoPointContentSchema } from "../geopoint"
+import type { GeoPointContent } from "../geopoint"
+import { GeoPointLegacySchema } from "../legacy/geopoint"
+import type { GeoPointLegacy } from "../legacy/geopoint"
+import type { LegacyCodec, LegacyContentCtx } from "./legacyContentCtx"
+
+const GeoPointContentType = "GeoPointContent"
+
+export const GeoPointLegacyCodec = (
+	ctx: LegacyContentCtx,
+): LegacyCodec<GeoPointContent, GeoPointLegacy> => ({
+	name: "GeoPointLegacy",
+
+	is(input): input is GeoPointContent {
+		return GeoPointContentSchema.safeParse(input).success
+	},
+
+	decode(input) {
+		const parsed = GeoPointLegacySchema.safeParse(input)
+		if (!parsed.success) {
+			return parsed
+		}
+
+		return {
+			success: true,
+			data: {
+				...parsed.data,
+				__TYPE__: GeoPointContentType,
+			},
+		}
+	},
+
+	encode(input) {
+		return {
+			content: { position: input.position },
+			types: { [ctx.keyOfType]: "GeoPoint" },
+			keys: {},
+		}
+	},
+})

package/src/content/codec/group.ts

@@ -0,0 +1,163 @@
+import {
+	GroupContentSchema,
+	GroupContentType,
+	GroupItemContentSchema,
+	GroupItemContentType,
+	NestableAndGroupContentSchema,
+} from "../group"
+import type { GroupContent, GroupItemContent, NestableAndGroupContent } from "../group"
+import { GroupItemLegacySchema, GroupLegacySchema } from "../legacy/group"
+import type { GroupItemLegacy, GroupLegacy, NestableAndGroupLegacy } from "../legacy/group"
+import { type LegacyContentCtx, type LegacyCodec, getFieldCtx } from "./legacyContentCtx"
+import { NestableLegacyCodec } from "./nestable"
+
+export const GroupItemLegacyCodec = (
+	ctx: LegacyContentCtx,
+	index: number,
+): LegacyCodec<GroupItemContent, GroupItemLegacy> => ({
+	name: "GroupItemLegacy",
+
+	is(input): input is GroupItemContent {
+		return GroupItemContentSchema.safeParse(input).success
+	},
+
+	decode(input) {
+		const parsed = GroupItemLegacySchema.safeParse(input)
+		if (!parsed.success) {
+			return parsed
+		}
+
+		const groupItemCtx = ctx.withContentKey(index.toString())
+
+		const value: GroupItemContent["value"] = []
+		for (const [key, legacy] of Object.entries(parsed.data)) {
+			const itemCtx = getFieldCtx({
+				fieldKey: key,
+				contentKey: key,
+				ctx: groupItemCtx,
+			})
+
+			const result = NestableAndGroupLegacyCodec(itemCtx).decode(legacy)
+			if (result.success) {
+				value.push([key, result.data])
+			}
+		}
+
+		return {
+			success: true,
+			data: {
+				__TYPE__: GroupItemContentType,
+				key: groupItemCtx.fieldContentKey,
+				value,
+			},
+		}
+	},
+
+	encode(input) {
+		const groupItemCtx = ctx.withContentKey(index.toString())
+
+		const legacy: ReturnType<LegacyCodec<GroupItemContent, GroupItemLegacy>["encode"]> = {
+			content: {},
+			types: {},
+			keys: { [groupItemCtx.keyOfKey]: input.key },
+		}
+
+		for (const [key, content] of input.value) {
+			const itemCtx = getFieldCtx({ fieldKey: key, ctx })
+
+			const result = NestableAndGroupLegacyCodec(itemCtx).encode(content)
+			if (result) {
+				legacy.content[key] = result.content
+				legacy.types = { ...legacy.types, ...result.types }
+				legacy.keys = { ...legacy.keys, ...result.keys }
+			}
+		}
+
+		return legacy
+	},
+})
+
+export const GroupLegacyCodec = (
+	ctx: LegacyContentCtx,
+): LegacyCodec<GroupContent, GroupLegacy> => ({
+	name: "GroupLegacy",
+
+	is(input): input is GroupContent {
+		return GroupContentSchema.safeParse(input).success
+	},
+
+	decode(input) {
+		const parsed = GroupLegacySchema.safeParse(input)
+		if (!parsed.success) {
+			return parsed
+		}
+
+		const value: GroupContent["value"] = []
+		for (let index = 0; index < parsed.data.length; index++) {
+			const item = parsed.data[index]
+
+			// Replace null items with empty GroupItemContent
+			if (!item) {
+				value.push({
+					__TYPE__: GroupItemContentType,
+					key: ctx.withContentKey(index.toString()).fieldContentKey,
+					value: [],
+				})
+				continue
+			}
+
+			const result = GroupItemLegacyCodec(ctx, index).decode(item)
+			if (!result.success) {
+				return result
+			}
+
+			value.push(result.data)
+		}
+
+		return {
+			success: true,
+			data: { __TYPE__: GroupContentType, value },
+		}
+	},
+
+	encode(input) {
+		const legacy: ReturnType<LegacyCodec<GroupContent, GroupLegacy>["encode"]> = {
+			content: [],
+			types: { [ctx.keyOfType]: "Group" },
+			keys: {},
+		}
+
+		for (let index = 0; index < input.value.length; index++) {
+			const item = input.value[index]
+			const result = GroupItemLegacyCodec(ctx, index).encode(item)
+
+			legacy.content.push(result.content)
+			legacy.types = { ...legacy.types, ...result.types }
+			legacy.keys = { ...legacy.keys, ...result.keys }
+		}
+
+		return legacy
+	},
+})
+
+export const NestableAndGroupLegacyCodec = (
+	ctx: LegacyContentCtx,
+): LegacyCodec<NestableAndGroupContent, NestableAndGroupLegacy, true> => ({
+	name: "NestableAndGroupLegacy",
+
+	is(input): input is NestableAndGroupContent {
+		return NestableAndGroupContentSchema.safeParse(input).success
+	},
+
+	decode(input) {
+		return ctx.fieldType === "Group"
+			? GroupLegacyCodec(ctx).decode(input)
+			: NestableLegacyCodec(ctx).decode(input)
+	},
+
+	encode(input) {
+		return input.__TYPE__ === GroupContentType
+			? GroupLegacyCodec(ctx).encode(input)
+			: NestableLegacyCodec(ctx).encode(input)
+	},
+})

package/src/content/codec/image.ts

@@ -0,0 +1,50 @@
+import { ImageContentSchema, ImageContentType } from "../image"
+import type { ImageContent } from "../image"
+import type { ImageLegacy } from "../legacy/image"
+import { ImageLegacySchema } from "../legacy/image"
+import type { LegacyContentCtx, LegacyCodec } from "./legacyContentCtx"
+
+// Also used by content/codec/richText
+export function imageLegacyToContent(value: ImageLegacy): ImageContent {
+	return { ...value, __TYPE__: ImageContentType }
+}
+
+export const ImageLegacyCodec = (
+	ctx: LegacyContentCtx,
+): LegacyCodec<ImageContent, ImageLegacy> => ({
+	name: "ImageLegacy",
+
+	is(input): input is ImageContent {
+		return ImageContentSchema.safeParse(input).success
+	},
+
+	decode(input) {
+		const parsed = ImageLegacySchema.safeParse(input)
+		if (!parsed.success) {
+			return parsed
+		}
+
+		return {
+			success: true,
+			data: imageLegacyToContent(parsed.data),
+		}
+	},
+
+	encode(input) {
+		return {
+			content: {
+				edit: input.edit,
+				height: input.height,
+				origin: input.origin,
+				width: input.width,
+				...(input.alt ? { alt: input.alt } : {}),
+				...(input.credits ? { credits: input.credits } : {}),
+				...(input.provider ? { provider: input.provider } : {}),
+				...(input.thumbnails ? { thumbnails: input.thumbnails } : {}),
+				...(input.url ? { url: input.url } : {}),
+			},
+			types: { [ctx.keyOfType]: "Image" },
+			keys: {},
+		}
+	},
+})

package/src/content/codec/integrationField.ts

@@ -0,0 +1,38 @@
+import { IntegrationFieldContentSchema, IntegrationFieldContentType } from "../integrationField"
+import type { IntegrationFieldContent } from "../integrationField"
+import { IntegrationFieldLegacySchema } from "../legacy/integrationField"
+import type { IntegrationFieldLegacy } from "../legacy/integrationField"
+import type { LegacyContentCtx, LegacyCodec } from "./legacyContentCtx"
+
+export const IntegrationFieldLegacyCodec = (
+	ctx: LegacyContentCtx,
+): LegacyCodec<IntegrationFieldContent, IntegrationFieldLegacy> => ({
+	name: "IntegrationFieldLegacy",
+
+	is(input): input is IntegrationFieldContent {
+		return IntegrationFieldContentSchema.safeParse(input).success
+	},
+
+	decode(input) {
+		const parsed = IntegrationFieldLegacySchema.safeParse(input)
+		if (!parsed.success) {
+			return parsed
+		}
+
+		return {
+			success: true,
+			data: {
+				__TYPE__: IntegrationFieldContentType,
+				value: parsed.data,
+			},
+		}
+	},
+
+	encode(input) {
+		return {
+			content: input.value,
+			types: { [ctx.keyOfType]: "IntegrationFields" },
+			keys: {},
+		}
+	},
+})

package/src/content/{LegacyContentCtx.ts → codec/legacyContentCtx.ts}

@@ -1,13 +1,16 @@
-import * as t from "io-ts"
-import { v4 as uuid } from "uuid"
+import { z } from "zod/mini"
 
-import { FieldType, SlicesTypes } from "../customtypes/widgets"
+import { SlicesTypesModelSchema } from "../../model/slice"
+import { FieldTypeSchema } from "../../model/widget"
 
-export const FieldOrSliceType = t.union([
-	t.union([FieldType, SlicesTypes]),
-	t.literal("Repeatable.Link"),
+// FieldOrSliceType - union of FieldType, SlicesTypes, and Repeatable.Link
+const FieldOrSliceTypeSchema = z.union([
+	FieldTypeSchema,
+	SlicesTypesModelSchema,
+	z.literal("Repeatable.Link"),
 ])
-export type FieldOrSliceType = t.TypeOf<typeof FieldOrSliceType>
+
+type FieldOrSliceType = z.infer<typeof FieldOrSliceTypeSchema>
 
 interface LegacyContentCtxParams {
 	fieldKey: string
@@ -46,19 +49,15 @@ export class LegacyContentCtx {
 		this.allTypes = allTypes || new Map<string, FieldOrSliceType>()
 		this.allKeys = allKeys || new Map<string, string>()
 
-		const prefixedKey = Array.of(this.fieldPath, [this.fieldKey])
-			.flat()
-			.join(".")
+		const prefixedKey = Array.of(this.fieldPath, [this.fieldKey]).flat().join(".")
 
-		const prefixedContentKey = Array.of(this.contentPath, [this.contentKey])
-			.flat()
-			.join(".")
+		const prefixedContentKey = Array.of(this.contentPath, [this.contentKey]).flat().join(".")
 
 		this.prefixedKey = prefixedKey
 		this.keyOfType = `${prefixedKey}_TYPE`
 		this.keyOfKey = `${prefixedContentKey}_KEY`
 		this.fieldType = this.allTypes.get(this.prefixedKey)
-		this.fieldContentKey = this.allKeys.get(prefixedContentKey) ?? uuid()
+		this.fieldContentKey = this.allKeys.get(prefixedContentKey) ?? crypto.randomUUID()
 	}
 
 	withContentKey(contentKey: string): LegacyContentCtx {
@@ -109,8 +108,19 @@ export function defaultCtx(
 	})
 }
 
-export type WithTypes<T> = {
+type WithTypes<T> = {
 	keys: Record<string, string>
 	types: Record<string, FieldOrSliceType>
 	content: T
 }
+
+export type LegacyCodec<A, LegacyRaw, AllowUndefined extends boolean = false> = {
+	name: string
+	is(input: unknown): input is A
+	decode(
+		input: unknown,
+	): z.core.util.SafeParseSuccess<A> | z.core.util.SafeParseError<LegacyRaw | unknown>
+	encode(
+		value: A,
+	): AllowUndefined extends false ? WithTypes<LegacyRaw> : WithTypes<LegacyRaw> | undefined
+}

package/src/content/codec/link.ts

@@ -0,0 +1,103 @@
+import type {
+	EmptyLinkValueLegacy,
+	FilledLinkValueLegacy,
+	LinkValueLegacy,
+	LinkLegacy,
+} from "../legacy/link"
+import { LinkKind, LinkType, LinkLegacySchema } from "../legacy/link"
+import { LinkContentSchema, LinkContentType } from "../link"
+import type {
+	EmptyLinkValueContent,
+	FilledLinkValueContent,
+	LinkContent,
+	LinkValueContent,
+} from "../link"
+import type { LegacyContentCtx, LegacyCodec } from "./legacyContentCtx"
+
+// Also used by content/codec/richText
+export function linkLegacyToValue(value: FilledLinkValueLegacy): FilledLinkValueContent
+export function linkLegacyToValue(value: EmptyLinkValueLegacy): EmptyLinkValueContent
+export function linkLegacyToValue(value: LinkValueLegacy): LinkValueContent
+export function linkLegacyToValue(
+	value: Omit<LinkLegacy, "text" | "variant" | "key">,
+): Omit<LinkContent["value"], "text" | "variant"> {
+	let encoded: Omit<LinkContent["value"], "text" | "variant">
+	switch (value.kind) {
+		case LinkKind.Image:
+			encoded = { __TYPE__: LinkType.Image, ...value }
+			break
+		case LinkKind.File:
+			encoded = { __TYPE__: LinkType.File, ...value }
+			break
+		case LinkKind.Document:
+			encoded = { __TYPE__: LinkType.Document, ...value }
+			break
+		case LinkKind.External:
+			encoded = { __TYPE__: LinkType.External, ...value }
+			break
+		case LinkKind.Media:
+			encoded = { __TYPE__: LinkType.Media, ...value }
+			break
+		case LinkKind.Any:
+		default:
+			encoded = { __TYPE__: LinkType.Any, ...value }
+			break
+	}
+
+	return encoded
+}
+
+// Also used by content/codec/repeatable
+export function linkLegacyToContent({ key, text, variant, ...legacy }: LinkLegacy): LinkContent {
+	return {
+		__TYPE__: LinkContentType,
+		key,
+		value: {
+			...(text ? { text } : {}),
+			...(variant ? { variant } : {}),
+			...linkLegacyToValue(legacy),
+		},
+	}
+}
+
+// Also used by content/codec/richText
+export function linkValueToLegacy(value: FilledLinkValueContent): FilledLinkValueLegacy
+export function linkValueToLegacy(value: EmptyLinkValueContent): EmptyLinkValueLegacy
+export function linkValueToLegacy(value: LinkValueContent): LinkValueLegacy {
+	const { __TYPE__, ...legacy } = value
+	return legacy
+}
+
+function linkContentToLegacy({ key, value }: LinkContent): LinkLegacy {
+	const { __TYPE__, ...legacy } = value
+
+	return { key, ...legacy }
+}
+
+export const LinkLegacyCodec = (ctx: LegacyContentCtx): LegacyCodec<LinkContent, LinkLegacy> => ({
+	name: "LinkLegacy",
+
+	is(input): input is LinkContent {
+		return LinkContentSchema.safeParse(input).success
+	},
+
+	decode(input) {
+		const parsed = LinkLegacySchema.safeParse(input)
+		if (!parsed.success) {
+			return parsed
+		}
+
+		return {
+			success: true,
+			data: linkLegacyToContent(parsed.data),
+		}
+	},
+
+	encode(input) {
+		return {
+			content: linkContentToLegacy(input),
+			types: { [ctx.keyOfType]: "Link" },
+			keys: {},
+		}
+	},
+})