@prismicio/types-internal 4.0.0-pr.6.09bccf8 → 4.0.0-pr.6.38cb7de

package/src/helpers/documentContent.ts

@@ -1,48 +1,43 @@
 import { z } from "zod/mini"
 
-import type { DocumentContent } from "../content/document";
-import { traverseDocumentContent } from "./traverseContent";
-import * as contentPath from "./contentPath";
-import type { WidgetContent } from "../content/widget";
-import type { DocumentLegacy } from "../content/legacy/document";
-import { DocumentLegacySchema } from "../content/legacy/document";
-import { DocumentLegacyCodec } from "../content/codec/document";
-import { defaultCtx } from "../content/codec/legacyContentCtx";
-import type { FieldOrSliceType } from "../model/widget";
-import { FieldOrSliceTypeSchema } from "../model/widget";
+import { DocumentLegacyCodec } from "../content/codec/document"
+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 type { WidgetContent } from "../content/widget"
+import type { FieldOrSliceType } from "../model/widget"
+import { FieldOrSliceTypeSchema } from "../model/widget"
+import * as contentPath from "./contentPath"
+import { traverseDocumentContent } from "./traverseContent"
 
 export function collectWidgets<TWidgetContent extends WidgetContent>(
 	document: DocumentContent,
-	test: (args: {
-		path: contentPath.Path;
-		key: string;
-		apiID: string;
-		content: WidgetContent;
-	}) => args is {
-		path: contentPath.Path;
-		key: string;
-		apiID: string;
-		content: TWidgetContent;
-	}
+	test: (
+		content: WidgetContent,
+		args: {
+			path: contentPath.Path
+			key: string
+			apiID: string
+		},
+	) => content is TWidgetContent,
 ): Record<string, TWidgetContent> {
 	const collected: Record<string, TWidgetContent> = {}
 
 	traverseDocumentContent(document, {
-		transformWidget: (args) => {
-			if (test(args)) {
-				collected[contentPath.serialize(args.path)] = args.content
+		transformWidget: ({ content, ...args }) => {
+			if (test(content, args)) {
+				collected[contentPath.serialize(args.path)] = content
 			}
 
-			return args.content
+			return content
 		},
 	})
 
 	return collected
 }
 
-export function fromLegacy(
-	legacy: DocumentLegacy,
-): DocumentContent | undefined {
+export function fromLegacy(legacy: DocumentLegacy): DocumentContent | undefined {
 	const parsed = DocumentLegacySchema.safeParse(legacy)
 	if (!parsed.success) {
 		return
@@ -67,7 +62,7 @@ export function fromLegacy(
 		}
 	}
 
-	const result = DocumentLegacyCodec(defaultCtx("", types, keys)).toContent(parsed.data)
+	const result = DocumentLegacyCodec(defaultCtx("", types, keys)).toContent(widgets)
 	if (!result.success) {
 		return
 	}

package/src/helpers/traverseContent.ts

@@ -1,16 +1,3 @@
-import type { StaticCustomTypeModel } from "../model/customType"
-import type { GroupModel, NestedGroupModel } from "../model/group"
-import type { LinkModel } from "../model/link"
-import type { NestableModel } from "../model/nestable"
-import type {
-	CompositeSliceModel,
-	LegacySliceModel,
-	SharedSliceVariationModel,
-} from "../model/slice"
-import type { StaticSlicesModel } from "../model/slices"
-import { TableCellModel } from "../model/table"
-import type { TableModel } from "../model/table"
-import type { StaticWidgetModel } from "../model/widget"
 import type { DocumentContent } from "../content/document"
 import { GroupContentType } from "../content/group"
 import type { GroupContent, GroupItemContent } from "../content/group"
@@ -30,6 +17,20 @@ 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 { GroupModel, NestedGroupModel } from "../model/group"
+import type { LinkModel } from "../model/link"
+import type { NestableModel } from "../model/nestable"
+import type {
+	CompositeSliceModel,
+	LegacySliceModel,
+	SharedSliceVariationContentModel,
+	SliceContentModel,
+} from "../model/slice"
+import type { StaticSlicesModel } from "../model/slices"
+import { TableCellModel } from "../model/table"
+import type { TableModel } from "../model/table"
+import type { StaticWidgetModel } from "../model/widget"
 import * as contentPath from "./contentPath"
 import * as customTypeModel from "./customTypeModel"
 
@@ -90,7 +91,7 @@ export function traverseSlicesContent(
 
 		let traversedSliceItemContent: SliceItemContent | undefined
 		if (sliceItemContent.widget.__TYPE__ === SharedSliceContentType) {
-			let model: SharedSliceVariationModel | undefined
+			let model: SharedSliceVariationContentModel | undefined
 			if (sliceModel?.type === "SharedSlice") {
 				const variationID = sliceItemContent.widget.variation
 				const variationModel = sliceModel.variations.find(
@@ -152,9 +153,9 @@ export function traverseSlicesContent(
 }
 
 type TraverseSharedSliceContentConfig = {
-	model?: SharedSliceVariationModel
-	transformWidget: TraverseWidgetContentFunction
-	transformSlice: TraverseSliceContentFunction
+	model?: SharedSliceVariationContentModel
+	transformWidget?: TraverseWidgetContentFunction
+	transformSlice?: TraverseSliceContentFunction
 }
 
 export function traverseSharedSliceContent(
@@ -164,7 +165,8 @@ export function traverseSharedSliceContent(
 	content: SharedSliceItemContent,
 	config: TraverseSharedSliceContentConfig,
 ): SharedSliceItemContent | undefined {
-	const { transformWidget, transformSlice } = config
+	const { transformWidget = (args) => args.content, transformSlice = (args) => args.content } =
+		config
 
 	const traversedPrimary: SharedSliceContent["primary"] = {}
 	for (const [key, fieldContent] of Object.entries(content.widget.primary)) {
@@ -206,8 +208,8 @@ export function traverseSharedSliceContent(
 
 type TraverseCompositeSliceContentConfig = {
 	model?: CompositeSliceModel
-	transformWidget: TraverseWidgetContentFunction
-	transformSlice: TraverseSliceContentFunction
+	transformWidget?: TraverseWidgetContentFunction
+	transformSlice?: TraverseSliceContentFunction
 }
 
 export function traverseCompositeSliceContent(
@@ -217,7 +219,8 @@ export function traverseCompositeSliceContent(
 	content: CompositeSliceItemContent,
 	config: TraverseCompositeSliceContentConfig,
 ): CompositeSliceItemContent | undefined {
-	const { transformWidget, transformSlice } = config
+	const { transformWidget = (args) => args.content, transformSlice = (args) => args.content } =
+		config
 
 	const traversedPrimary: CompositeSliceContent["nonRepeat"] = {}
 	for (const [key, fieldContent] of Object.entries(content.widget.nonRepeat)) {
@@ -256,8 +259,8 @@ export function traverseCompositeSliceContent(
 
 type TraverseLegacySliceContentConfig = {
 	model?: LegacySliceModel
-	transformWidget: TraverseWidgetContentFunction
-	transformSlice: TraverseSliceContentFunction
+	transformWidget?: TraverseWidgetContentFunction
+	transformSlice?: TraverseSliceContentFunction
 }
 
 export function traverseLegacySliceContent(
@@ -267,7 +270,11 @@ export function traverseLegacySliceContent(
 	content: LegacySliceItemContent,
 	config: TraverseLegacySliceContentConfig,
 ): LegacySliceItemContent | undefined {
-	const { model, transformWidget, transformSlice } = config
+	const {
+		model,
+		transformWidget = (args) => args.content,
+		transformSlice = (args) => args.content,
+	} = config
 
 	const traversedContent = traverseWidgetContent(path, key, apiID, content.widget, {
 		model,
@@ -459,7 +466,7 @@ export type TraverseSliceContentFunction = <TContent extends SliceItemContent>(a
 	key: string
 	apiID: string
 	content: TContent
-	model?: SliceModel
+	model?: SliceContentModel
 }) => TContent | undefined
 
 export type TraverseWidgetContentFunction<
@@ -473,8 +480,6 @@ export type TraverseWidgetContentFunction<
 }) => (TContentTransformMode extends "preserve" ? TContent : WidgetContent) | undefined
 
 // Internals
-type SliceModel = SharedSliceVariationModel | CompositeSliceModel | LegacySliceModel
-
 type TraverseWidgetContentConfig = {
 	model?: StaticWidgetModel
 	transformWidget?: TraverseWidgetContentFunction

package/src/helpers/traverseContentWithModel.ts

@@ -1,12 +1,3 @@
-import type { StaticCustomTypeModel } from "../model/customType"
-import type { GroupModel, NestedGroupModel } from "../model/group"
-import type { LinkModel } from "../model/link"
-import type { NestableModel } from "../model/nestable"
-import type { CompositeSliceModel, LegacySliceModel, SharedSliceVariationModel } from "../model/slice"
-import type { StaticSlicesModel } from "../model/slices"
-import { TableCellModel } from "../model/table"
-import type { TableModel } from "../model/table"
-import type { StaticWidgetModel } from "../model/widget"
 import type { DocumentContent } from "../content/document"
 import { GroupContentType } from "../content/group"
 import type { GroupContent, GroupItemContent } from "../content/group"
@@ -26,6 +17,20 @@ 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 { GroupModel, NestedGroupModel } from "../model/group"
+import type { LinkModel } from "../model/link"
+import type { NestableModel } from "../model/nestable"
+import type {
+	CompositeSliceModel,
+	LegacySliceModel,
+	SharedSliceVariationContentModel,
+	SliceContentModel,
+} from "../model/slice"
+import type { StaticSlicesModel } from "../model/slices"
+import { TableCellModel } from "../model/table"
+import type { TableModel } from "../model/table"
+import type { StaticWidgetModel } from "../model/widget"
 import * as contentPath from "./contentPath"
 import * as customTypeModel from "./customTypeModel"
 
@@ -101,7 +106,7 @@ export function traverseSlicesContentWithModel(
 			const variationID = sliceItemContent.widget.variation
 			const variationModel = model.variations.find((variation) => variation.id === variationID)
 			if (variationModel) {
-				const sharedSliceVariationModel: SharedSliceVariationModel = {
+				const sharedSliceVariationModel: SharedSliceVariationContentModel = {
 					type: "SharedSlice",
 					sliceName: model.id,
 					variationID,
@@ -161,9 +166,9 @@ export function traverseSlicesContentWithModel(
 }
 
 type TraverseSharedSliceContentWithModelConfig = {
-	model: SharedSliceVariationModel
-	transformWidget: TraverseWidgetContentWithModelFunction
-	transformSlice: TraverseSliceContentWithModelFunction
+	model: SharedSliceVariationContentModel
+	transformWidget?: TraverseWidgetContentWithModelFunction
+	transformSlice?: TraverseSliceContentWithModelFunction
 }
 
 export function traverseSharedSliceContentWithModel(
@@ -173,12 +178,13 @@ export function traverseSharedSliceContentWithModel(
 	content: SharedSliceItemContent | undefined,
 	config: TraverseSharedSliceContentWithModelConfig,
 ): SharedSliceItemContent | undefined {
-	const { transformWidget, transformSlice } = config
-
 	if (!content) {
 		return
 	}
 
+	const { transformWidget = (args) => args.content, transformSlice = (args) => args.content } =
+		config
+
 	const traversedPrimary: SharedSliceContent["primary"] = {}
 	for (const [key, model] of Object.entries(config.model.fields.primary ?? {})) {
 		const traversedContent = traverseWidgetContentWithModel(
@@ -217,8 +223,8 @@ export function traverseSharedSliceContentWithModel(
 
 type TraverseCompositeSliceContentWithModelConfig = {
 	model: CompositeSliceModel
-	transformWidget: TraverseWidgetContentWithModelFunction
-	transformSlice: TraverseSliceContentWithModelFunction
+	transformWidget?: TraverseWidgetContentWithModelFunction
+	transformSlice?: TraverseSliceContentWithModelFunction
 }
 
 export function traverseCompositeSliceContentWithModel(
@@ -228,12 +234,13 @@ export function traverseCompositeSliceContentWithModel(
 	content: CompositeSliceItemContent | undefined,
 	config: TraverseCompositeSliceContentWithModelConfig,
 ): CompositeSliceItemContent | undefined {
-	const { transformWidget, transformSlice } = config
-
 	if (!content) {
 		return
 	}
 
+	const { transformWidget = (args) => args.content, transformSlice = (args) => args.content } =
+		config
+
 	const traversedPrimary: CompositeSliceContent["nonRepeat"] = {}
 	for (const [key, model] of Object.entries(config.model?.["non-repeat"] ?? {})) {
 		const traversedContent = traverseWidgetContentWithModel(
@@ -269,8 +276,8 @@ export function traverseCompositeSliceContentWithModel(
 
 type TraverseLegacySliceContentWithModelConfig = {
 	model: LegacySliceModel
-	transformWidget: TraverseWidgetContentWithModelFunction
-	transformSlice: TraverseSliceContentWithModelFunction
+	transformWidget?: TraverseWidgetContentWithModelFunction
+	transformSlice?: TraverseSliceContentWithModelFunction
 }
 
 export function traverseLegacySliceContentWithModel(
@@ -280,12 +287,16 @@ export function traverseLegacySliceContentWithModel(
 	content: LegacySliceItemContent | undefined,
 	config: TraverseLegacySliceContentWithModelConfig,
 ): LegacySliceItemContent | undefined {
-	const { model, transformWidget, transformSlice } = config
-
 	if (!content) {
 		return
 	}
 
+	const {
+		model,
+		transformWidget = (args) => args.content,
+		transformSlice = (args) => args.content,
+	} = config
+
 	const traversedContent = traverseWidgetContentWithModel(path, key, apiID, content.widget, {
 		model,
 		transformWidget,
@@ -503,15 +514,12 @@ export function traverseTableContentWithModel(
 }
 
 // Internals
-
-type SliceModel = SharedSliceVariationModel | CompositeSliceModel | LegacySliceModel
-
 export type TraverseSliceContentWithModelFunction = <TContent extends SliceItemContent>(args: {
 	path: contentPath.Path
 	key: string
 	apiID: string
 	content?: TContent
-	model: SliceModel
+	model: SliceContentModel
 }) => TContent | undefined
 
 export type TraverseWidgetContentWithModelFunction<

package/src/index.ts

@@ -27,7 +27,7 @@ export type { IntegrationFieldContent } from "./content/integrationField"
 export type { LinkContent } from "./content/link"
 export type { NestableContent } from "./content/nestable"
 export type { RepeatableContent } from "./content/repeatable"
-export type { RichTextContent } from "./content/richText"
+export type { RichTextContent, RichTextContentBlock, RichTextContentSpan } from "./content/richText"
 export type { SeparatorContent } from "./content/separator"
 export type {
 	LegacySliceContent,
@@ -35,7 +35,13 @@ export type {
 	SharedSliceContent,
 	SliceContent,
 } from "./content/slice"
-export type { SliceItemContent, SlicesContent } from "./content/slices"
+export type {
+	LegacySliceItemContent,
+	CompositeSliceItemContent,
+	SharedSliceItemContent,
+	SliceItemContent,
+	SlicesContent,
+} from "./content/slices"
 export type { TableContent } from "./content/table"
 export type { UIDContent } from "./content/uid"
 export type { WidgetContent } from "./content/widget"
@@ -63,13 +69,15 @@ export type {
 	CompositeSliceModel,
 	SharedSliceModel,
 	SharedSliceRefModel,
-	SharedSliceVariationModel,
+	SharedSliceVariationContentModel as SharedSliceVariationModel,
 	StaticSliceModel,
 	DynamicSliceModel,
+	SliceContentModel,
 	SliceModelType,
 } from "./model/slice"
 export type { DynamicSlicesModel, StaticSlicesModel } from "./model/slices"
 export type { TableModel } from "./model/table"
+export { TableCellModelNodeTypes } from "./model/table"
 export type { TextModel } from "./model/text"
 export type { TimestampModel } from "./model/timestamp"
 export type { UIDModel } from "./model/uid"