@prismicio/types-internal 2.2.0-traverse.alpha-7 → 2.2.0-traverse.alpha-8

package/lib/_internal/utils.d.ts

@@ -1,8 +1,5 @@
 import type { SharedSliceItemContent, SliceItemContent, WidgetContent } from "../content";
 import type { CompositeSlice, Group, NestableWidget, StaticSlices, UID, VariationFields } from "../customtypes";
-export declare type PickOnly<T, K extends keyof T> = Pick<T, K> & {
-    [P in Exclude<keyof T, K>]?: never;
-};
 export declare type TraverseSliceContentFn = <S extends SliceItemContent | SharedSliceItemContent, D extends VariationFields | CompositeSlice | Group | NestableWidget>({ path, key, apiId, model, content, }: {
     path: ContentPath;
     key: string;

package/lib/content/Document.js

@@ -157,7 +157,7 @@ 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)),
+        fields: Object.fromEntries((0, customtypes_1.flattenSections)(customType)),
     };
 }
 // /**

package/lib/content/fields/nestable/NestableContent.d.ts

@@ -1,5 +1,4 @@
 import * as t from "io-ts";
-import type { NestableWidget } from "../../../customtypes";
 import type { LegacyContentCtx } from "../../LegacyContentCtx";
 export declare const NestableContent: t.UnionC<[t.ExactC<t.TypeC<{
     type: t.StringC;
@@ -993,4 +992,3 @@ export declare const NestableLegacy: (ctx: LegacyContentCtx) => {
     }> | undefined;
     encode(value: NestableContent): import("../../LegacyContentCtx").WithTypes<unknown> | undefined;
 };
-export declare function isValidStaticNestableContent(content: NestableContent, model?: NestableWidget): boolean;

package/lib/content/fields/nestable/NestableContent.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isValidStaticNestableContent = exports.NestableLegacy = exports.isNestableContent = exports.NestableContent = void 0;
+exports.NestableLegacy = exports.isNestableContent = exports.NestableContent = void 0;
 const tslib_1 = require("tslib");
 const Either_1 = require("fp-ts/lib/Either");
 const t = (0, tslib_1.__importStar)(require("io-ts"));
@@ -140,31 +140,3 @@ const NestableLegacy = (ctx) => {
     };
 };
 exports.NestableLegacy = NestableLegacy;
-function isValidStaticNestableContent(content, model) {
-    if (!model)
-        return false;
-    switch (content.__TYPE__) {
-        // special case for no content so we can consider it valid no matter its model
-        case "EmptyContent":
-            return true;
-        case "BooleanContent":
-            return model.type === "Boolean";
-        case "EmbedContent":
-            return model.type === "Embed";
-        case "FieldContent":
-            return content.type === model.type;
-        case "GeoPointContent":
-            return model.type === "GeoPoint";
-        case "ImageContent":
-            return model.type === "Image";
-        case "IntegrationFieldsContent":
-            return model.type === "IntegrationFields";
-        case "LinkContent":
-            return model.type === "Link";
-        case "StructuredTextContent":
-            return model.type === "StructuredText";
-        case "SeparatorContent":
-            return model.type === "Separator";
-    }
-}
-exports.isValidStaticNestableContent = isValidStaticNestableContent;

package/lib/content/fields/slices/Slice/CompositeSliceContent.js

@@ -100,8 +100,12 @@ function traverseCompositeSliceContent({ path, sliceKey, sliceName, model, conte
                 content: fieldContent,
             });
             // Can happen if the transform function returns undefined to filter out a field
-            if (!transformedField || !(0, nestable_1.isNestableContent)(transformedField))
+            if (!transformedField)
                 return acc;
+            if (!(0, nestable_1.isNestableContent)(transformedField)) {
+                console.warn(`Warn: Non nestable content with key [${fieldKey}] detected in a composite slice [${sliceName}] with key [${sliceKey}]`);
+                return acc;
+            }
             return {
                 ...acc,
                 [fieldKey]: transformedField,
@@ -139,18 +143,22 @@ function migrateCompositeSlice(model, content) {
             variation: model.variationId,
             primary: Object.entries(content.widget.nonRepeat).reduce((acc, [fieldKey, fieldContent]) => {
                 var _a;
-                return ((_a = model.fields.primary) === null || _a === void 0 ? void 0 : _a[fieldKey])
-                    ? { ...acc, [fieldKey]: fieldContent }
-                    : acc;
+                if (!((_a = model.fields.primary) === null || _a === void 0 ? void 0 : _a[fieldKey])) {
+                    console.warn(`The widget ${fieldKey} in the non-repeat zone of the composite slice [${model.sliceName}] with key [${content.key}] doesn't exist in the model.`);
+                    return acc;
+                }
+                return { ...acc, [fieldKey]: fieldContent };
             }, {}),
             items: content.widget.repeat.map((groupItem) => {
                 return {
                     __TYPE__: "GroupItemContent",
                     value: groupItem.value.reduce((acc, [fieldKey, fieldContent]) => {
                         var _a;
-                        return ((_a = model.fields.items) === null || _a === void 0 ? void 0 : _a[fieldKey])
-                            ? acc.concat([[fieldKey, fieldContent]])
-                            : acc;
+                        if (!((_a = model.fields.items) === null || _a === void 0 ? void 0 : _a[fieldKey])) {
+                            console.warn(`The widget ${fieldKey} in the repeat zone of the composite slice [${model.sliceName}] with key [${content.key}] doesn't exist in the model.`);
+                            return acc;
+                        }
+                        return acc.concat([[fieldKey, fieldContent]]);
                     }, []),
                 };
             }, []),

package/lib/content/fields/slices/Slice/SharedSliceContent.js

@@ -113,8 +113,12 @@ function traverseSharedSliceContent({ path, sliceKey, sliceName, model, content,
                 content: fieldContent,
             });
             // Can happen if the transform function returns undefined to filter out a field
-            if (!transformedField || !(0, nestable_1.isNestableContent)(transformedField))
+            if (!transformedField)
                 return acc;
+            if (!(0, nestable_1.isNestableContent)(transformedField)) {
+                console.warn(`Warn: Non nestable content with key [${fieldKey}] detected in a shared slice [${sliceName}] with key [${sliceKey}]`);
+                return acc;
+            }
             return {
                 ...acc,
                 [fieldKey]: transformedField,

package/lib/content/fields/slices/Slice/SimpleSliceContent.js

@@ -118,7 +118,7 @@ function migrateSimpleSlice(model, content) {
             __TYPE__: "SharedSliceContent",
             variation: model.variationId,
             primary: ((_a = model.fields.primary) === null || _a === void 0 ? void 0 : _a[content.name])
-                ? { [content.key]: content.widget }
+                ? { [content.name]: content.widget }
                 : {},
             items: [],
         },

package/lib/customtypes/CustomType.d.ts

@@ -2393,7 +2393,7 @@ export declare const CustomType: t.ExactC<t.IntersectionC<[t.TypeC<{
 }>]>>;
 export declare type CustomType = t.TypeOf<typeof CustomType>;
 export declare function flattenWidgets(customType: CustomType): Array<[string, DynamicWidget]>;
-export declare function flattenStaticWidgets(customType: StaticCustomType): Array<[string, StaticWidget]>;
+export declare function flattenSections(customType: StaticCustomType): Array<[string, StaticWidget]>;
 export declare function toStatic(customType: CustomType, sharedSlices: Map<string, SharedSlice>): StaticCustomType;
 export declare function validateSlices(customType: CustomType, sharedSlices: Map<string, SharedSlice>): Either<CustomTypeSlicesError, CustomType>;
 export declare function collectWidgets(customType: CustomType, f: (ref: string, widget: DynamicWidget) => DynamicWidget | undefined): CustomType;

package/lib/customtypes/CustomType.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.collectSharedSlices = exports.flattenCustomTypeFields = exports.filterMissingSharedSlices = exports.collectWidgets = exports.validateSlices = exports.toStatic = exports.flattenStaticWidgets = exports.flattenWidgets = exports.CustomType = exports.StaticCustomType = exports.CustomTypeFormat = void 0;
+exports.collectSharedSlices = exports.flattenCustomTypeFields = exports.filterMissingSharedSlices = exports.collectWidgets = exports.validateSlices = exports.toStatic = exports.flattenSections = exports.flattenWidgets = exports.CustomType = exports.StaticCustomType = exports.CustomTypeFormat = void 0;
 const tslib_1 = require("tslib");
 const Either_1 = require("fp-ts/lib/Either");
 const t = (0, tslib_1.__importStar)(require("io-ts"));
@@ -60,13 +60,13 @@ function flattenWidgets(customType) {
     }, []);
 }
 exports.flattenWidgets = flattenWidgets;
-function flattenStaticWidgets(customType) {
+function flattenSections(customType) {
     return Object.entries(customType.json).reduce((acc, [, section]) => {
         const sectionWidgets = Object.entries(section);
         return acc.concat(sectionWidgets);
     }, []);
 }
-exports.flattenStaticWidgets = flattenStaticWidgets;
+exports.flattenSections = flattenSections;
 function _retrieveSharedSlicesRef(customType) {
     const slicezones = flattenWidgets(customType).filter(([, widget]) => widget.type === "Slices");
     const allSharedRefs = slicezones.reduce((acc, [, slicezone]) => {

package/lib/customtypes/widgets/slices/SharedSlice.d.ts

@@ -1,5 +1,4 @@
 import * as t from "io-ts";
-import type { PickOnly } from "../../../_internal/utils";
 import type { SharedSliceRef } from "./SharedSliceRef";
 import type { DynamicSlice, StaticSlice } from "./Slice";
 export declare const Variation: t.ExactC<t.IntersectionC<[t.TypeC<{
@@ -331,7 +330,7 @@ export declare type VariationFields = {
     type: "SharedSlice";
     sliceName: string;
     variationId: string;
-    fields: PickOnly<Variation, "primary" | "items">;
+    fields: Pick<Variation, "primary" | "items">;
 };
 export declare const SharedSliceType = "SharedSlice";
 export declare const SharedSlice: t.ExactC<t.IntersectionC<[t.TypeC<{

package/package.json

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

package/src/_internal/utils.ts

@@ -12,10 +12,6 @@ import type {
 	VariationFields,
 } from "../customtypes"
 
-export type PickOnly<T, K extends keyof T> = Pick<T, K> & {
-	[P in Exclude<keyof T, K>]?: never
-}
-
 export type TraverseSliceContentFn = <
 	S extends SliceItemContent | SharedSliceItemContent,
 	D extends VariationFields | CompositeSlice | Group | NestableWidget,

package/src/content/Document.ts

@@ -12,7 +12,7 @@ import { WidgetKey } from "../common"
 import {
 	type StaticWidget,
 	collectSharedSlices,
-	flattenStaticWidgets,
+	flattenSections,
 	StaticCustomType,
 } from "../customtypes"
 import {
@@ -253,7 +253,7 @@ function simplifyCustomType(customType: StaticCustomType): {
 } {
 	return {
 		customTypeId: customType?.id,
-		fields: Object.fromEntries(flattenStaticWidgets(customType)),
+		fields: Object.fromEntries(flattenSections(customType)),
 	}
 }
 

package/src/content/fields/nestable/NestableContent.ts

@@ -1,7 +1,6 @@
 import { isRight } from "fp-ts/lib/Either"
 import * as t from "io-ts"
 
-import type { NestableWidget } from "../../../customtypes"
 import type { LegacyContentCtx } from "../../LegacyContentCtx"
 import { EmptyContent, EmptyLegacy, isEmptyContent } from "../EmptyContent"
 import {
@@ -201,34 +200,3 @@ export const NestableLegacy = (ctx: LegacyContentCtx) => {
 		},
 	}
 }
-
-export function isValidStaticNestableContent(
-	content: NestableContent,
-	model?: NestableWidget,
-) {
-	if (!model) return false
-
-	switch (content.__TYPE__) {
-		// special case for no content so we can consider it valid no matter its model
-		case "EmptyContent":
-			return true
-		case "BooleanContent":
-			return model.type === "Boolean"
-		case "EmbedContent":
-			return model.type === "Embed"
-		case "FieldContent":
-			return content.type === model.type
-		case "GeoPointContent":
-			return model.type === "GeoPoint"
-		case "ImageContent":
-			return model.type === "Image"
-		case "IntegrationFieldsContent":
-			return model.type === "IntegrationFields"
-		case "LinkContent":
-			return model.type === "Link"
-		case "StructuredTextContent":
-			return model.type === "StructuredText"
-		case "SeparatorContent":
-			return model.type === "Separator"
-	}
-}

package/src/content/fields/slices/Slice/CompositeSliceContent.ts

@@ -170,7 +170,13 @@ export function traverseCompositeSliceContent({
 				content: fieldContent,
 			})
 			// Can happen if the transform function returns undefined to filter out a field
-			if (!transformedField || !isNestableContent(transformedField)) return acc
+			if (!transformedField) return acc
+			if (!isNestableContent(transformedField)) {
+				console.warn(
+					`Warn: Non nestable content with key [${fieldKey}] detected in a composite slice [${sliceName}] with key [${sliceKey}]`,
+				)
+				return acc
+			}
 			return {
 				...acc,
 				[fieldKey]: transformedField,
@@ -214,9 +220,14 @@ export function migrateCompositeSlice(
 			variation: model.variationId,
 			primary: Object.entries(content.widget.nonRepeat).reduce(
 				(acc, [fieldKey, fieldContent]) => {
-					return model.fields.primary?.[fieldKey]
-						? { ...acc, [fieldKey]: fieldContent }
-						: acc
+					if (!model.fields.primary?.[fieldKey]) {
+						console.warn(
+							`The widget ${fieldKey} in the non-repeat zone of the composite slice [${model.sliceName}] with key [${content.key}] doesn't exist in the model.`,
+						)
+						return acc
+					}
+
+					return { ...acc, [fieldKey]: fieldContent }
 				},
 				{},
 			),
@@ -225,9 +236,13 @@ export function migrateCompositeSlice(
 					__TYPE__: "GroupItemContent",
 					value: groupItem.value.reduce<GroupItemContent["value"]>(
 						(acc, [fieldKey, fieldContent]) => {
-							return model.fields.items?.[fieldKey]
-								? acc.concat([[fieldKey, fieldContent]])
-								: acc
+							if (!model.fields.items?.[fieldKey]) {
+								console.warn(
+									`The widget ${fieldKey} in the repeat zone of the composite slice [${model.sliceName}] with key [${content.key}] doesn't exist in the model.`,
+								)
+								return acc
+							}
+							return acc.concat([[fieldKey, fieldContent]])
 						},
 						[],
 					),

package/src/content/fields/slices/Slice/SharedSliceContent.ts

@@ -174,7 +174,13 @@ export function traverseSharedSliceContent({
 				content: fieldContent,
 			})
 			// Can happen if the transform function returns undefined to filter out a field
-			if (!transformedField || !isNestableContent(transformedField)) return acc
+			if (!transformedField) return acc
+			if (!isNestableContent(transformedField)) {
+				console.warn(
+					`Warn: Non nestable content with key [${fieldKey}] detected in a shared slice [${sliceName}] with key [${sliceKey}]`,
+				)
+				return acc
+			}
 			return {
 				...acc,
 				[fieldKey]: transformedField,

package/src/content/fields/slices/Slice/SimpleSliceContent.ts

@@ -168,7 +168,7 @@ export function migrateSimpleSlice(
 			__TYPE__: "SharedSliceContent",
 			variation: model.variationId,
 			primary: model.fields.primary?.[content.name]
-				? { [content.key]: content.widget }
+				? { [content.name]: content.widget }
 				: {},
 			items: [],
 		},

package/src/customtypes/CustomType.ts

@@ -75,7 +75,7 @@ export function flattenWidgets(
 	)
 }
 
-export function flattenStaticWidgets(
+export function flattenSections(
 	customType: StaticCustomType,
 ): Array<[string, StaticWidget]> {
 	return Object.entries(customType.json).reduce(

package/src/customtypes/widgets/slices/SharedSlice.ts

@@ -1,7 +1,6 @@
 import * as t from "io-ts"
 import { withFallback } from "io-ts-types/lib/withFallback"
 
-import type { PickOnly } from "../../../_internal/utils"
 import { WidgetKey } from "../../../common"
 import { NestableWidget } from "../nestable/NestableWidget"
 import type { SharedSliceRef } from "./SharedSliceRef"
@@ -30,11 +29,12 @@ export const Variation = t.exact(
 
 export type Variation = t.TypeOf<typeof Variation>
 
+// VariationFields is used exclusively for the slices migration, LegacySlice -> SharedSlice
 export type VariationFields = {
 	type: "SharedSlice"
 	sliceName: string
 	variationId: string
-	fields: PickOnly<Variation, "primary" | "items">
+	fields: Pick<Variation, "primary" | "items">
 }
 
 export const SharedSliceType = "SharedSlice"