@prismicio/types-internal 2.2.0-traverse.alpha-3 → 2.2.0-traverse.alpha-5

package/lib/content/Document.d.ts

@@ -1,7 +1,7 @@
 import * as t from "io-ts";
 import { ContentPath, TraverseSliceContentFn, TraverseWidgetContentFn } from "../_internal/utils";
 import { WidgetKey } from "../common";
-import { type StaticWidget } from "../customtypes";
+import { type StaticWidget, StaticCustomType } from "../customtypes";
 import { WidgetContent } from "./fields";
 import { FieldOrSliceType, WithTypes } from "./LegacyContentCtx";
 export declare const Document: t.RecordC<t.Type<string, string, unknown>, t.UnionC<[t.ExactC<t.TypeC<{
@@ -4646,18 +4646,18 @@ export declare const DocumentLegacy: {
  * @param transform: A user function that provides a way to transform any kind of content wherever it is in a structured Prismic object content.
  * @returns a transformed document with the user's transformation applied with the transform function
  */
-export declare function traverseDocument({ document, model, }: {
+export declare function traverseDocument({ document, customType, }: {
     document: Document;
-    model?: {
+    customType?: StaticCustomType | {
         customTypeId: string;
         fields: Record<string, StaticWidget>;
-    };
+    } | undefined;
 }): ({ transformWidget, transformSlice, }: {
     transformWidget?: TraverseWidgetContentFn;
     transformSlice?: TraverseSliceContentFn;
 }) => Document;
 export declare function collectWidgets<W extends WidgetContent>(document: Document, is: (content: WidgetContent, path: ContentPath) => content is W): Record<string, W>;
-export declare function migrateDocument(document: Document, customType: {
+export declare function migrateDocument(document: Document, customType: StaticCustomType | {
     customTypeId: string;
     fields: Record<string, StaticWidget>;
 }): {

package/lib/content/Document.js

@@ -100,7 +100,10 @@ exports.DocumentLegacy = {
  * @param transform: A user function that provides a way to transform any kind of content wherever it is in a structured Prismic object content.
  * @returns a transformed document with the user's transformation applied with the transform function
  */
-function traverseDocument({ document, model, }) {
+function traverseDocument({ document, customType, }) {
+    const model = customType && customtypes_1.StaticCustomType.is(customType)
+        ? simplifyCustomType(customType)
+        : customType;
     return ({ transformWidget = ({ content }) => content, transformSlice = ({ content }) => content, }) => {
         const fieldModels = model &&
             Object.entries(model.fields).reduce((acc, [key, def]) => ({ ...acc, [key]: def }), {});
@@ -151,6 +154,12 @@ function traverseDocument({ document, model, }) {
     };
 }
 exports.traverseDocument = traverseDocument;
+function simplifyCustomType(customType) {
+    return {
+        customTypeId: customType === null || customType === void 0 ? void 0 : customType.id,
+        fields: Object.fromEntries((0, customtypes_1.flattenStaticWidgets)(customType)),
+    };
+}
 // /**
 //  * The goal is to be able to collect all widgets or slices of a given type at any level of nesting inside a prismic content
 //  *
@@ -172,20 +181,17 @@ function collectWidgets(document, is) {
 }
 exports.collectWidgets = collectWidgets;
 function migrateDocument(document, customType) {
-    const needsMigration = Object.values((0, customtypes_1.collectSharedSlices)(customType)).some((slice) => Boolean(slice.legacyPaths));
+    const model = customtypes_1.StaticCustomType.is(customType)
+        ? simplifyCustomType(customType)
+        : customType;
+    const needsMigration = Object.values((0, customtypes_1.collectSharedSlices)(model)).some((slice) => Boolean(slice.legacyPaths));
     if (!needsMigration)
         return document;
     return traverseDocument({
         document,
-        model: customType,
+        customType,
     })({
-        transformSlice: ({ content, model }) => {
-            if ((0, fields_1.isCompositeSliceItemContent)(content) && (model === null || model === void 0 ? void 0 : model.type) === "SharedSlice")
-                return (0, fields_1.migrateCompositeSlice)(model, content);
-            if ((0, fields_1.isSimpleSliceItemContent)(content) && (model === null || model === void 0 ? void 0 : model.type) === "SharedSlice")
-                return (0, fields_1.migrateSimpleSlice)(model, content);
-            return content;
-        },
+        transformSlice: fields_1.migrateSliceItem,
     });
 }
 exports.migrateDocument = migrateDocument;

package/lib/content/fields/slices/SliceItem.d.ts

@@ -1,4 +1,5 @@
 import * as t from "io-ts";
+import type { TraverseSliceContentFn } from "../../../_internal/utils";
 import { LegacyContentCtx, WithTypes } from "../../LegacyContentCtx";
 import { CompositeSliceContent } from "./Slice/CompositeSliceContent";
 import { SharedSliceContent } from "./Slice/SharedSliceContent";
@@ -3475,3 +3476,4 @@ export declare const SlicesItemLegacy: (ctx: LegacyContentCtx) => t.Type<{
 } & {
     label?: string | null | undefined;
 }>, unknown>;
+export declare const migrateSliceItem: TraverseSliceContentFn;

package/lib/content/fields/slices/SliceItem.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SlicesItemLegacy = exports.isSimpleSliceItemContent = exports.isCompositeSliceItemContent = exports.isSharedSliceItemContent = exports.SliceItemContent = void 0;
+exports.migrateSliceItem = exports.SlicesItemLegacy = exports.isSimpleSliceItemContent = exports.isCompositeSliceItemContent = exports.isSharedSliceItemContent = exports.SliceItemContent = void 0;
 const tslib_1 = require("tslib");
 const fp_ts_1 = require("fp-ts");
 const Either_1 = require("fp-ts/lib/Either");
@@ -74,3 +74,11 @@ const SlicesItemLegacy = (ctx) => {
     });
 };
 exports.SlicesItemLegacy = SlicesItemLegacy;
+const migrateSliceItem = ({ model, content, }) => {
+    if (isCompositeSliceItemContent(content) && (model === null || model === void 0 ? void 0 : model.type) === "SharedSlice")
+        return (0, CompositeSliceContent_1.migrateCompositeSlice)(model, content);
+    if (isSimpleSliceItemContent(content) && (model === null || model === void 0 ? void 0 : model.type) === "SharedSlice")
+        return (0, SimpleSliceContent_1.migrateSimpleSlice)(model, content);
+    return content;
+};
+exports.migrateSliceItem = migrateSliceItem;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@prismicio/types-internal",
-	"version": "2.2.0-traverse.alpha-3",
+	"version": "2.2.0-traverse.alpha-5",
 	"description": "Prismic types for Custom Types and Prismic Data",
 	"keywords": [
 		"typescript",

package/src/content/Document.ts

@@ -9,12 +9,14 @@ import {
 	TraverseWidgetContentFn,
 } from "../_internal/utils"
 import { WidgetKey } from "../common"
-import { type StaticWidget, collectSharedSlices } from "../customtypes"
 import {
-	isCompositeSliceItemContent,
-	isSimpleSliceItemContent,
-	migrateCompositeSlice,
-	migrateSimpleSlice,
+	type StaticWidget,
+	collectSharedSlices,
+	flattenStaticWidgets,
+	StaticCustomType,
+} from "../customtypes"
+import {
+	migrateSliceItem,
 	traverseGroupContent,
 	traverseSlices,
 	WidgetContent,
@@ -164,14 +166,21 @@ export const DocumentLegacy = {
  */
 export function traverseDocument({
 	document,
-	model,
+	customType,
 }: {
 	document: Document
-	model?: {
-		customTypeId: string
-		fields: Record<string, StaticWidget>
-	}
+	customType?:
+		| StaticCustomType
+		| {
+				customTypeId: string
+				fields: Record<string, StaticWidget>
+		  }
+		| undefined
 }) {
+	const model =
+		customType && StaticCustomType.is(customType)
+			? simplifyCustomType(customType)
+			: customType
 	return ({
 		transformWidget = ({ content }) => content,
 		transformSlice = ({ content }) => content,
@@ -238,6 +247,16 @@ export function traverseDocument({
 	}
 }
 
+function simplifyCustomType(customType: StaticCustomType): {
+	customTypeId: string
+	fields: Record<string, StaticWidget>
+} {
+	return {
+		customTypeId: customType?.id,
+		fields: Object.fromEntries(flattenStaticWidgets(customType)),
+	}
+}
+
 // /**
 //  * The goal is to be able to collect all widgets or slices of a given type at any level of nesting inside a prismic content
 //  *
@@ -263,12 +282,17 @@ export function collectWidgets<W extends WidgetContent>(
 
 export function migrateDocument(
 	document: Document,
-	customType: {
-		customTypeId: string
-		fields: Record<string, StaticWidget>
-	},
+	customType:
+		| StaticCustomType
+		| {
+				customTypeId: string
+				fields: Record<string, StaticWidget>
+		  },
 ) {
-	const needsMigration = Object.values(collectSharedSlices(customType)).some(
+	const model = StaticCustomType.is(customType)
+		? simplifyCustomType(customType)
+		: customType
+	const needsMigration = Object.values(collectSharedSlices(model)).some(
 		(slice) => Boolean(slice.legacyPaths),
 	)
 
@@ -276,14 +300,8 @@ export function migrateDocument(
 
 	return traverseDocument({
 		document,
-		model: customType,
+		customType,
 	})({
-		transformSlice: ({ content, model }) => {
-			if (isCompositeSliceItemContent(content) && model?.type === "SharedSlice")
-				return migrateCompositeSlice(model, content)
-			if (isSimpleSliceItemContent(content) && model?.type === "SharedSlice")
-				return migrateSimpleSlice(model, content)
-			return content
-		},
+		transformSlice: migrateSliceItem,
 	})
 }

package/src/content/fields/slices/SliceItem.ts

@@ -3,6 +3,7 @@ import { isLeft } from "fp-ts/lib/Either"
 import { pipe } from "fp-ts/lib/function"
 import * as t from "io-ts"
 
+import type { TraverseSliceContentFn } from "../../../_internal/utils"
 import { nullable } from "../../../validators/function"
 import {
 	getFieldCtx,
@@ -15,6 +16,7 @@ import { SliceContent, SliceLegacy } from "./Slice"
 import {
 	CompositeSliceContent,
 	isCompositeSliceContent,
+	migrateCompositeSlice,
 } from "./Slice/CompositeSliceContent"
 import {
 	isSharedSliceContent,
@@ -22,6 +24,7 @@ import {
 } from "./Slice/SharedSliceContent"
 import {
 	isSimpleSliceContent,
+	migrateSimpleSlice,
 	SimpleSliceContent,
 } from "./Slice/SimpleSliceContent"
 
@@ -117,3 +120,14 @@ export const SlicesItemLegacy = (ctx: LegacyContentCtx) => {
 		},
 	)
 }
+
+export const migrateSliceItem: TraverseSliceContentFn = ({
+	model,
+	content,
+}) => {
+	if (isCompositeSliceItemContent(content) && model?.type === "SharedSlice")
+		return migrateCompositeSlice(model, content)
+	if (isSimpleSliceItemContent(content) && model?.type === "SharedSlice")
+		return migrateSimpleSlice(model, content)
+	return content
+}