@prismicio/types-internal 4.7.0 → 4.8.0-canary.6451918

package/src/content/codec/group.ts

@@ -63,7 +63,7 @@ export const GroupItemLegacyCodec = (
 		}
 
 		for (const [key, content] of input.value) {
-			const itemCtx = getFieldCtx({ fieldKey: key, ctx })
+			const itemCtx = getFieldCtx({ fieldKey: key, ctx: groupItemCtx })
 
 			const result = NestableAndGroupLegacyCodec(itemCtx).fromContent(content)
 			if (result) {

package/src/content/codec/legacyContentCtx.ts

@@ -1,7 +1,12 @@
+import { v5 as uuidV5 } from "uuid"
 import type { z } from "zod/mini"
 
 import type { FieldOrSliceType } from "../../model/widget"
 
+function uuidV5ForPath(path: string[]): string {
+	return uuidV5(JSON.stringify(path), uuidV5.URL)
+}
+
 interface LegacyContentCtxParams {
 	fieldKey: string
 	contentKey?: string
@@ -47,7 +52,8 @@ export class LegacyContentCtx {
 		this.keyOfType = `${prefixedKey}_TYPE`
 		this.keyOfKey = `${prefixedContentKey}_KEY`
 		this.fieldType = this.allTypes.get(this.prefixedKey)
-		this.fieldContentKey = this.allKeys.get(prefixedContentKey) ?? crypto.randomUUID()
+		this.fieldContentKey =
+			this.allKeys.get(prefixedContentKey) ?? uuidV5ForPath([...this.contentPath, this.contentKey])
 	}
 
 	withContentKey(contentKey: string): LegacyContentCtx {

package/src/content/embed.ts

@@ -6,7 +6,7 @@ export const EmbedContentType = "EmbedContent" as const
 
 export const EmbedContentSchema = z.extend(EmbedLegacySchema, {
 	__TYPE__: z.literal(EmbedContentType),
-	all: z.unknown(),
+	all: z.optional(z.unknown()),
 })
 
 export type EmbedContent = z.infer<typeof EmbedContentSchema>

package/src/content/legacy/image.ts

@@ -29,8 +29,8 @@ export const ImageLegacyViewSchema = z.object({
 	height: z.number(),
 	edit: EditSchema,
 	url: z.optional(z.string()),
-	credits: z.optional(NonEmptyStringOrNullSchema),
-	alt: z.optional(NonEmptyStringOrNullSchema),
+	credits: z.optional(z._default(NonEmptyStringOrNullSchema, null)),
+	alt: z.optional(z._default(NonEmptyStringOrNullSchema, null)),
 	provider: z.nullish(z.string()),
 })
 

package/src/content/legacy/richText.ts

@@ -55,7 +55,7 @@ const LabelSpanSchema = z.object({
 	start: z.number(),
 	end: z.number(),
 	data: z.pipe(
-		z.unknown(),
+		z.optional(z.unknown()),
 		z.transform((value) => (typeof value === "string" && value.length > 0 ? value : "")),
 	),
 })

package/src/helpers/customTypeModel.ts

@@ -1,6 +1,7 @@
 import type {
 	DynamicCustomTypeModel,
 	DynamicCustomTypeModelTab,
+	FlattenedStaticCustomTypeModel,
 	StaticCustomTypeModel,
 	StaticCustomTypeModelTab,
 } from "../model/customType"
@@ -92,11 +93,11 @@ export function flatten(
 }
 
 export function collectSharedSlices(
-	customType: StaticCustomTypeModel,
+	customType: StaticCustomTypeModel | FlattenedStaticCustomTypeModel,
 ): Record<string, SharedSliceModel> {
 	const sharedSlices: Record<string, SharedSliceModel> = {}
 
-	const flattened = flatten(customType)
+	const flattened = "fields" in customType ? customType.fields : flatten(customType)
 	for (const widget of Object.values(flattened)) {
 		if (widget.type === "Slices" || widget.type === "Choice") {
 			for (const [id, model] of Object.entries(widget.config?.choices || {})) {

package/src/helpers/documentContent.ts

@@ -5,10 +5,8 @@ import { defaultCtx } from "../content/codec/legacyContentCtx"
 import type { DocumentContent } from "../content/document"
 import type { DocumentLegacy } from "../content/legacy/document"
 import { DocumentLegacySchema } from "../content/legacy/document"
-import { isNestableContent } from "../content/nestable"
-import type { CompositeSliceItemContent, LegacySliceItemContent } from "../content/slices"
 import type { WidgetContent } from "../content/widget"
-import type { StaticCustomTypeModel } from "../model/customType"
+import type { FlattenedStaticCustomTypeModel, StaticCustomTypeModel } from "../model/customType"
 import type { FieldOrSliceType } from "../model/widget"
 import { FieldOrSliceTypeSchema } from "../model/widget"
 import * as contentPath from "./contentPath"
@@ -42,6 +40,24 @@ export function collectWidgets<TWidgetContent extends WidgetContent>(
 	return collected
 }
 
+export function migrateDocument(
+	document: DocumentContent,
+	model: StaticCustomTypeModel | FlattenedStaticCustomTypeModel,
+): DocumentContent {
+	const needsMigration = Object.values(customTypeModel.collectSharedSlices(model)).some((slice) =>
+		Boolean(slice.legacyPaths),
+	)
+
+	if (needsMigration) {
+		return traverseDocumentContent(document, {
+			model,
+			transformSlice: sliceContent.migrateSliceItem,
+		})
+	}
+
+	return document
+}
+
 export function fromLegacy(
 	legacy: DocumentLegacy,
 	model: StaticCustomTypeModel,
@@ -61,7 +77,7 @@ export function fromLegacy(
 				types.set(key.substring(0, key.length - 5), parsed.data)
 			}
 		} else if (key.endsWith("_KEY")) {
-			const parsed = z.uuidv4().safeParse(value)
+			const parsed = z.union([z.uuidv4(), z.uuid({ version: "v5" })]).safeParse(value)
 			if (parsed.success) {
 				keys.set(key.substring(0, key.length - 4), parsed.data)
 			}
@@ -75,30 +91,7 @@ export function fromLegacy(
 		return
 	}
 
-	const needsMigration = Object.values(customTypeModel.collectSharedSlices(model)).some((slice) =>
-		Boolean(slice.legacyPaths),
-	)
-
-	if (needsMigration) {
-		return traverseDocumentContent(result.data, {
-			model,
-			transformSlice: ({ content, model }) => {
-				if (model?.type === "SharedSlice") {
-					if (content.widget.__TYPE__ === "CompositeSliceContent") {
-						return sliceContent.compositeToShared(content as CompositeSliceItemContent, model)
-					} else if (
-						content.widget.__TYPE__ === "GroupContentType" ||
-						isNestableContent(content.widget)
-					) {
-						return sliceContent.legacyToShared(content as LegacySliceItemContent, model)
-					}
-				}
-				return content
-			},
-		})
-	}
-
-	return result.data
+	return migrateDocument(result.data, model)
 }
 
 export function toLegacy(document: DocumentContent): DocumentLegacy {

package/src/helpers/sliceContent.ts

@@ -1,4 +1,5 @@
 import type { GroupItemContent } from "../content/group"
+import { isNestableContent } from "../content/nestable"
 import type { SharedSliceContent } from "../content/slice"
 import type {
 	CompositeSliceItemContent,
@@ -6,6 +7,21 @@ import type {
 	SharedSliceItemContent,
 } from "../content/slices"
 import type { SharedSliceVariationContentModel } from "../model/slice"
+import type { TraverseSliceContentFunction } from "./traverseContent"
+
+export const migrateSliceItem: TraverseSliceContentFunction = ({ content, model }) => {
+	if (model?.type === "SharedSlice") {
+		if (content.widget.__TYPE__ === "CompositeSliceContent") {
+			return compositeToShared(content as CompositeSliceItemContent, model)
+		} else if (
+			content.widget.__TYPE__ === "GroupContentType" ||
+			isNestableContent(content.widget)
+		) {
+			return legacyToShared(content as LegacySliceItemContent, model)
+		}
+	}
+	return content
+}
 
 export const legacyToShared = (
 	content: LegacySliceItemContent,

package/src/helpers/traverseContent.ts

@@ -17,7 +17,7 @@ import {
 } from "../content/slices"
 import { TableContentType, type TableContent } from "../content/table"
 import type { WidgetContent } from "../content/widget"
-import type { StaticCustomTypeModel } from "../model/customType"
+import type { FlattenedStaticCustomTypeModel, StaticCustomTypeModel } from "../model/customType"
 import type { GroupModel, NestedGroupModel } from "../model/group"
 import type { LinkModel } from "../model/link"
 import type { NestableModel } from "../model/nestable"
@@ -36,7 +36,7 @@ import * as contentPath from "./contentPath"
 import * as customTypeModel from "./customTypeModel"
 
 type TraverseDocumentContentConfig = {
-	model?: StaticCustomTypeModel
+	model?: StaticCustomTypeModel | FlattenedStaticCustomTypeModel
 	transformWidget?: TraverseWidgetContentFunction
 	transformSlice?: TraverseSliceContentFunction
 }
@@ -48,17 +48,20 @@ export function traverseDocumentContent(
 	const { model, transformWidget, transformSlice } = config
 
 	// Remove tabs from custom type model
-	const flatModel = model ? customTypeModel.flatten(model) : {}
+	const flatModel =
+		model && !("fields" in model)
+			? { customTypeId: model.id, fields: customTypeModel.flatten(model) }
+			: model
 
 	const traversed: DocumentContent = {}
 	for (const [key, content] of Object.entries(document)) {
 		const path = contentPath.make(
-			{ key: config.model?.id, type: "CustomType" },
+			{ key: flatModel?.customTypeId, type: "CustomType" },
 			{ key, type: "Widget" },
 		)
 
 		const traversedContent = traverseWidgetContent(path, key, key, content, {
-			model: flatModel[key],
+			model: flatModel?.fields[key],
 			transformWidget,
 			transformSlice,
 		})

package/src/index.ts

@@ -64,6 +64,7 @@ export type {
 	CustomTypeModel,
 	StaticCustomTypeModelTab,
 	DynamicCustomTypeModelTab,
+	FlattenedStaticCustomTypeModel,
 } from "./model/customType"
 export type { DateModel } from "./model/date"
 export type { AddedDiff, RemovedDiff, UpdatedDiff, Diff } from "./model/diff/changes"
@@ -83,7 +84,7 @@ export type { GeoPointModel } from "./model/geopoint"
 export type { GroupModel, NestedGroupModel } from "./model/group"
 export type { ImageModel } from "./model/image"
 export type { IntegrationFieldModel } from "./model/integrationField"
-export type { LinkModel } from "./model/link"
+export type { LinkModel, LinkConfigCustomtypes } from "./model/link"
 export type { NestableModel } from "./model/nestable"
 export type { NumberModel } from "./model/number"
 export type { RangeModel } from "./model/range"
@@ -105,11 +106,16 @@ export type {
 } from "./model/slice"
 export type { DynamicSlicesModel, StaticSlicesModel } from "./model/slices"
 export type { TableModel } from "./model/table"
-export { TableCellModelNodeTypes } from "./model/table"
+export { TableCellModel, TableCellModelNodeTypes } from "./model/table"
 export type { TextModel } from "./model/text"
 export type { TimestampModel } from "./model/timestamp"
 export type { UIDModel } from "./model/uid"
-export type { StaticWidgetModel, DynamicWidgetModel, FieldModelType } from "./model/widget"
+export type {
+	StaticWidgetModel,
+	DynamicWidgetModel,
+	FieldModelType,
+	FieldOrSliceType,
+} from "./model/widget"
 
 // Legacy
 export { LegacyContentCtx, getFieldCtx, defaultCtx } from "./content/codec/legacyContentCtx"

package/src/io-ts.ts

@@ -112,7 +112,10 @@ import {
 } from "./model/group"
 import { ImageModelSchema as rawImageModelSchema } from "./model/image"
 import { IntegrationFieldModelSchema as rawIntegrationFieldModelSchema } from "./model/integrationField"
-import { LinkModelSchema as rawLinkModelSchema } from "./model/link"
+import {
+	LinkModelSchema as rawLinkModelSchema,
+	LinkConfigCustomtypesSchema as rawLinkConfigCustomtypesSchema,
+} from "./model/link"
 import { NestableModelSchema as rawNestableModelSchema } from "./model/nestable"
 import { NumberModelSchema as rawNumberModelSchema } from "./model/number"
 import { RangeModelSchema as rawRangeModelSchema } from "./model/range"
@@ -140,6 +143,7 @@ import { UIDModelSchema as rawUIDModelSchema } from "./model/uid"
 import {
 	StaticWidgetModelSchema as rawStaticWidgetModelSchema,
 	DynamicWidgetModelSchema as rawDynamicWidgetModelSchema,
+	FieldOrSliceTypeSchema as rawFieldOrSliceTypeSchema,
 } from "./model/widget"
 
 // Common
@@ -231,6 +235,7 @@ export const GeoPointModelSchema = toIOTS(rawGeoPointModelSchema)
 export const ImageModelSchema = toIOTS(rawImageModelSchema)
 export const IntegrationFieldModelSchema = toIOTS(rawIntegrationFieldModelSchema)
 export const LinkModelSchema = toIOTS(rawLinkModelSchema)
+export const LinkConfigCustomtypesSchema = toIOTS(rawLinkConfigCustomtypesSchema)
 export const NestableModelSchema = toIOTS(rawNestableModelSchema)
 export const NumberModelSchema = toIOTS(rawNumberModelSchema)
 export const RangeModelSchema = toIOTS(rawRangeModelSchema)
@@ -255,6 +260,7 @@ export const DynamicSlicesModelSchema = toIOTS(rawDynamicSlicesModelSchema)
 export const StaticSlicesModelSchema = toIOTS(rawStaticSlicesModelSchema)
 export const StaticWidgetModelSchema = toIOTS(rawStaticWidgetModelSchema)
 export const DynamicWidgetModelSchema = toIOTS(rawDynamicWidgetModelSchema)
+export const FieldOrSliceTypeSchema = toIOTS(rawFieldOrSliceTypeSchema)
 export const StaticCustomTypeModelTabSchema = toIOTS(rawStaticCustomTypeModelTabSchema)
 export const DynamicCustomTypeModelTabSchema = toIOTS(rawDynamicCustomTypeModelTabSchema)
 export const StaticCustomTypeModelSchema = toIOTS(rawStaticCustomTypeModelSchema)

package/src/model/customType.ts

@@ -78,6 +78,11 @@ const createCustomTypeSchema = <
 export const StaticCustomTypeModelSchema = createCustomTypeSchema(StaticCustomTypeModelTabSchema)
 export type StaticCustomTypeModel = z.infer<typeof StaticCustomTypeModelSchema>
 
+export type FlattenedStaticCustomTypeModel = {
+	customTypeId: string
+	fields: StaticCustomTypeModelTab
+}
+
 export const DynamicCustomTypeModelSchema = createCustomTypeSchema(DynamicCustomTypeModelTabSchema)
 export type DynamicCustomTypeModel = z.infer<typeof DynamicCustomTypeModelSchema>
 

package/src/model/link.ts

@@ -75,7 +75,7 @@ const CustomTypeLevel1Schema = z.union([
 	z.object({ id: z.string(), fields: CustomTypeLevel1FieldsSchema }),
 ])
 
-const CustomTypesSchema = z.array(CustomTypeLevel1Schema).check(({ value, issues }) => {
+export const LinkConfigCustomtypesSchema = z.array(CustomTypeLevel1Schema).check(({ value, issues }) => {
 	const cts = value as ({ id: string } | string)[]
 	const push = (message: string) => issues.push({ code: "custom", input: value, message })
 	const strings = new Set<string>()
@@ -104,6 +104,8 @@ const CustomTypesSchema = z.array(CustomTypeLevel1Schema).check(({ value, issues
 	}
 })
 
+export type LinkConfigCustomtypes = z.infer<typeof LinkConfigCustomtypesSchema>
+
 // --- Select with fallback to null ---
 
 const SelectWithFallbackSchema = z.pipe(
@@ -123,7 +125,7 @@ const LinkConfigSchema = z.object({
 	useAsTitle: z.optional(z.boolean()),
 	placeholder: z.optional(z.string()),
 	select: z.optional(SelectWithFallbackSchema),
-	customtypes: z.optional(CustomTypesSchema),
+	customtypes: z.optional(LinkConfigCustomtypesSchema),
 	masks: z.optional(MasksArrayStringSchema),
 	tags: z.optional(MasksArrayStringSchema),
 	allowTargetBlank: z.optional(z.boolean()),

package/src/zod4.ts

@@ -76,7 +76,10 @@ import {
 } from "./model/group"
 import { ImageModelSchema as rawImageModelSchema } from "./model/image"
 import { IntegrationFieldModelSchema as rawIntegrationFieldModelSchema } from "./model/integrationField"
-import { LinkModelSchema as rawLinkModelSchema } from "./model/link"
+import {
+	LinkModelSchema as rawLinkModelSchema,
+	LinkConfigCustomtypesSchema as rawLinkConfigCustomtypesSchema,
+} from "./model/link"
 import { NestableModelSchema as rawNestableModelSchema } from "./model/nestable"
 import { NumberModelSchema as rawNumberModelSchema } from "./model/number"
 import { RangeModelSchema as rawRangeModelSchema } from "./model/range"
@@ -104,6 +107,7 @@ import { UIDModelSchema as rawUIDModelSchema } from "./model/uid"
 import {
 	StaticWidgetModelSchema as rawStaticWidgetModelSchema,
 	DynamicWidgetModelSchema as rawDynamicWidgetModelSchema,
+	FieldOrSliceTypeSchema as rawFieldOrSliceTypeSchema,
 } from "./model/widget"
 
 // Common
@@ -163,6 +167,7 @@ export const GeoPointModelSchema = toZod4(rawGeoPointModelSchema)
 export const ImageModelSchema = toZod4(rawImageModelSchema)
 export const IntegrationFieldModelSchema = toZod4(rawIntegrationFieldModelSchema)
 export const LinkModelSchema = toZod4(rawLinkModelSchema)
+export const LinkConfigCustomtypesSchema = toZod4(rawLinkConfigCustomtypesSchema)
 export const NestableModelSchema = toZod4(rawNestableModelSchema)
 export const NumberModelSchema = toZod4(rawNumberModelSchema)
 export const RangeModelSchema = toZod4(rawRangeModelSchema)
@@ -187,6 +192,7 @@ export const DynamicSlicesModelSchema = toZod4(rawDynamicSlicesModelSchema)
 export const StaticSlicesModelSchema = toZod4(rawStaticSlicesModelSchema)
 export const StaticWidgetModelSchema = toZod4(rawStaticWidgetModelSchema)
 export const DynamicWidgetModelSchema = toZod4(rawDynamicWidgetModelSchema)
+export const FieldOrSliceTypeSchema = toZod4(rawFieldOrSliceTypeSchema)
 export const StaticCustomTypeModelTabSchema = toZod4(rawStaticCustomTypeModelTabSchema)
 export const DynamicCustomTypeModelTabSchema = toZod4(rawDynamicCustomTypeModelTabSchema)
 export const StaticCustomTypeModelSchema = toZod4(rawStaticCustomTypeModelSchema)