@prismicio/types-internal 3.12.0-alpha.1 → 3.12.0

package/lib/content/Document.d.ts

@@ -9,10 +9,7 @@ export declare const Document: t.RecordC<t.Type<string, string, unknown>, t.Unio
     __TYPE__: t.LiteralC<"EmptyContent">;
 }>>, t.ExactC<t.TypeC<{
     __TYPE__: t.LiteralC<"BooleanContent">;
-    value: t.BooleanC; /**
-     * `DocumentLegacyCodec` handles decoding and encoding documents to the legacy
-     * format used by Prismic DB, therefore, this function itself is not "legacy".
-     */
+    value: t.BooleanC;
 }>>, t.IntersectionC<[t.ExactC<t.IntersectionC<[t.TypeC<{
     embed_url: t.StringC;
     type: t.StringC;
@@ -786,10 +783,7 @@ export declare const Document: t.RecordC<t.Type<string, string, unknown>, t.Unio
                 __TYPE__: t.LiteralC<"EmptyContent">;
             }>>, t.ExactC<t.TypeC<{
                 __TYPE__: t.LiteralC<"BooleanContent">;
-                value: t.BooleanC; /**
-                 * `DocumentLegacyCodec` handles decoding and encoding documents to the legacy
-                 * format used by Prismic DB, therefore, this function itself is not "legacy".
-                 */
+                value: t.BooleanC;
             }>>, t.IntersectionC<[t.ExactC<t.IntersectionC<[t.TypeC<{
                 embed_url: t.StringC;
                 type: t.StringC;
@@ -1556,10 +1550,7 @@ export declare const Document: t.RecordC<t.Type<string, string, unknown>, t.Unio
                     __TYPE__: t.LiteralC<"EmptyContent">;
                 }>>, t.ExactC<t.TypeC<{
                     __TYPE__: t.LiteralC<"BooleanContent">;
-                    value: t.BooleanC; /**
-                     * `DocumentLegacyCodec` handles decoding and encoding documents to the legacy
-                     * format used by Prismic DB, therefore, this function itself is not "legacy".
-                     */
+                    value: t.BooleanC;
                 }>>, t.IntersectionC<[t.ExactC<t.IntersectionC<[t.TypeC<{
                     embed_url: t.StringC;
                     type: t.StringC;
@@ -2327,10 +2318,7 @@ export declare const Document: t.RecordC<t.Type<string, string, unknown>, t.Unio
                 __TYPE__: t.LiteralC<"EmptyContent">;
             }>>, t.ExactC<t.TypeC<{
                 __TYPE__: t.LiteralC<"BooleanContent">;
-                value: t.BooleanC; /**
-                 * `DocumentLegacyCodec` handles decoding and encoding documents to the legacy
-                 * format used by Prismic DB, therefore, this function itself is not "legacy".
-                 */
+                value: t.BooleanC;
             }>>, t.IntersectionC<[t.ExactC<t.IntersectionC<[t.TypeC<{
                 embed_url: t.StringC;
                 type: t.StringC;
@@ -3097,10 +3085,7 @@ export declare const Document: t.RecordC<t.Type<string, string, unknown>, t.Unio
                     __TYPE__: t.LiteralC<"EmptyContent">;
                 }>>, t.ExactC<t.TypeC<{
                     __TYPE__: t.LiteralC<"BooleanContent">;
-                    value: t.BooleanC; /**
-                     * `DocumentLegacyCodec` handles decoding and encoding documents to the legacy
-                     * format used by Prismic DB, therefore, this function itself is not "legacy".
-                     */
+                    value: t.BooleanC;
                 }>>, t.IntersectionC<[t.ExactC<t.IntersectionC<[t.TypeC<{
                     embed_url: t.StringC;
                     type: t.StringC;
@@ -3865,10 +3850,7 @@ export declare const Document: t.RecordC<t.Type<string, string, unknown>, t.Unio
             __TYPE__: t.LiteralC<"EmptyContent">;
         }>>, t.ExactC<t.TypeC<{
             __TYPE__: t.LiteralC<"BooleanContent">;
-            value: t.BooleanC; /**
-             * `DocumentLegacyCodec` handles decoding and encoding documents to the legacy
-             * format used by Prismic DB, therefore, this function itself is not "legacy".
-             */
+            value: t.BooleanC;
         }>>, t.IntersectionC<[t.ExactC<t.IntersectionC<[t.TypeC<{
             embed_url: t.StringC;
             type: t.StringC;

package/lib/content/Document.js

@@ -8,6 +8,7 @@ const function_1 = require("fp-ts/lib/function");
 const t = (0, tslib_1.__importStar)(require("io-ts"));
 const utils_1 = require("../_internal/utils");
 const common_1 = require("../common");
+const UUID_1 = require("../common/UUID");
 const customtypes_1 = require("../customtypes");
 const fields_1 = require("./fields");
 const LegacyContentCtx_1 = require("./LegacyContentCtx");
@@ -55,7 +56,7 @@ function extractMetadata(data) {
             }
         }
         if (k.endsWith("_KEY")) {
-            const decodedValue = t.string.decode(v);
+            const decodedValue = UUID_1.UUID.decode(v);
             if ((0, Either_1.isRight)(decodedValue)) {
                 return {
                     ...acc,

package/lib/customtypes/CustomType.js

@@ -165,17 +165,20 @@ function collectSharedSlices(customType) {
 exports.collectSharedSlices = collectSharedSlices;
 function traverseCustomType(args) {
     const { customType, onField } = args;
-    const json = {};
+    let json;
     for (const [key, section] of Object.entries(customType.json)) {
-        json[key] = (0, Section_1.traverseSection)({
+        const newSection = (0, Section_1.traverseSection)({
             path: [key],
             section,
             onField,
         });
+        if (newSection !== section) {
+            if (!json)
+                json = { ...customType.json };
+            json[key] = newSection;
+        }
     }
-    return {
-        ...customType,
-        json,
-    };
+    // returns the traversed model instead of a new one if it didn't change
+    return json ? { ...customType, json } : customType;
 }
 exports.traverseCustomType = traverseCustomType;

package/lib/customtypes/Section.js

@@ -22,7 +22,7 @@ exports.Sections = {
 };
 function traverseSection(args) {
     const { path: prevPath, section: prevSection, onField } = args;
-    const section = { ...prevSection };
+    let section;
     for (const [key, prevModel] of Object.entries(prevSection)) {
         const path = [...prevPath, key];
         let model;
@@ -54,8 +54,13 @@ function traverseSection(args) {
                 });
                 break;
         }
-        section[key] = model;
+        if (model !== prevModel) {
+            if (!section)
+                section = { ...prevSection };
+            section[key] = model;
+        }
     }
-    return section;
+    // returns the traversed model instead of a new one if it didn't change
+    return section !== null && section !== void 0 ? section : prevSection;
 }
 exports.traverseSection = traverseSection;

package/lib/customtypes/widgets/Group.js

@@ -36,22 +36,22 @@ function traverseNestedGroup(args) {
     const { path: prevPath, group, onField } = args;
     if (!((_a = group.config) === null || _a === void 0 ? void 0 : _a.fields))
         return group;
-    const fields = {};
-    for (const [key, prevField] of Object.entries(group.config.fields)) {
+    let fields;
+    for (const [key, field] of Object.entries(group.config.fields)) {
         const path = [...prevPath, key];
-        fields[key] = onField({
+        const newField = onField({
             path,
             key,
-            field: prevField,
+            field,
         });
+        if (field !== newField) {
+            if (!fields)
+                fields = { ...group.config.fields };
+            fields[key] = newField;
+        }
     }
-    return {
-        ...group,
-        config: {
-            ...group.config,
-            fields,
-        },
-    };
+    // returns the traversed model instead of a new one if it didn't change
+    return fields ? { ...group, config: { ...group.config, fields } } : group;
 }
 exports.traverseNestedGroup = traverseNestedGroup;
 function traverseGroup(args) {
@@ -59,7 +59,7 @@ function traverseGroup(args) {
     const { path: prevPath, group, onField } = args;
     if (!((_a = group.config) === null || _a === void 0 ? void 0 : _a.fields))
         return group;
-    const fields = {};
+    let fields;
     for (const [key, prevField] of Object.entries(group.config.fields)) {
         const path = [...prevPath, key];
         let field;
@@ -75,18 +75,18 @@ function traverseGroup(args) {
                 field = prevField;
                 break;
         }
-        fields[key] = onField({
+        const newField = onField({
             path,
             key,
             field,
         });
+        if (field !== newField) {
+            if (!fields)
+                fields = { ...group.config.fields };
+            fields[key] = newField;
+        }
     }
-    return {
-        ...group,
-        config: {
-            ...group.config,
-            fields,
-        },
-    };
+    // returns the traversed model instead of a new one if it didn't change
+    return fields ? { ...group, config: { ...group.config, fields } } : group;
 }
 exports.traverseGroup = traverseGroup;

package/lib/customtypes/widgets/slices/CompositeSlice.js

@@ -31,20 +31,33 @@ exports.isCompositeSlice = isCompositeSlice;
 function traverseCompositeSlice(args) {
     var _a, _b;
     const { path: prevPath, slice, onField } = args;
-    const nonRepeat = {};
+    let nonRepeat;
     for (const [key, field] of Object.entries((_a = slice["non-repeat"]) !== null && _a !== void 0 ? _a : {})) {
         const path = [...prevPath, "non-repeat", key];
-        nonRepeat[key] = onField({ path, key, field });
+        const newField = onField({ path, key, field });
+        if (field !== newField) {
+            if (!nonRepeat)
+                nonRepeat = { ...slice["non-repeat"] };
+            nonRepeat[key] = newField;
+        }
     }
-    const repeat = {};
+    let repeat;
     for (const [key, field] of Object.entries((_b = slice.repeat) !== null && _b !== void 0 ? _b : {})) {
         const path = [...prevPath, "repeat", key];
-        repeat[key] = onField({ path, key, field });
+        const newField = onField({ path, key, field });
+        if (field !== newField) {
+            if (!repeat)
+                repeat = { ...slice.repeat };
+            repeat[key] = newField;
+        }
     }
-    return {
-        ...slice,
-        ...(slice["non-repeat"] && { "non-repeat": nonRepeat }),
-        ...(slice.repeat && { repeat }),
-    };
+    // returns the traversed model instead of a new one if it didn't change
+    return repeat || nonRepeat
+        ? {
+            ...slice,
+            ...(nonRepeat && { "non-repeat": nonRepeat }),
+            ...(repeat && { repeat }),
+        }
+        : slice;
 }
 exports.traverseCompositeSlice = traverseCompositeSlice;

package/lib/customtypes/widgets/slices/SharedSlice.js

@@ -50,7 +50,7 @@ exports.isDynamicSharedSlice = isDynamicSharedSlice;
 function traverseVariation(args) {
     var _a, _b;
     const { path: prevPath, variation, onField } = args;
-    const primary = {};
+    let primary;
     for (const [key, prevField] of Object.entries((_a = variation.primary) !== null && _a !== void 0 ? _a : {})) {
         const path = [...prevPath, "primary", key];
         let field;
@@ -66,34 +66,53 @@ function traverseVariation(args) {
                 field = prevField;
                 break;
         }
-        primary[key] = onField({ path, key, field });
+        const newField = onField({ path, key, field });
+        if (field !== newField) {
+            if (!primary)
+                primary = { ...variation.primary };
+            primary[key] = newField;
+        }
     }
-    const items = {};
-    for (const [key, field] of Object.entries((_b = variation.items) !== null && _b !== void 0 ? _b : {})) {
+    let items;
+    for (const [key, prevField] of Object.entries((_b = variation.items) !== null && _b !== void 0 ? _b : {})) {
         const path = [...prevPath, "items", key];
-        items[key] = onField({ path, key, field });
+        const newField = onField({
+            path,
+            key,
+            field: prevField,
+        });
+        if (prevField !== newField) {
+            if (!items)
+                items = { ...variation.items };
+            items[key] = newField;
+        }
     }
-    return {
-        ...variation,
-        ...(variation.primary && { primary }),
-        ...(variation.items && { items }),
-    };
+    // returns the traversed model instead of a new one if it didn't change
+    return primary || items
+        ? { ...variation, ...(primary && { primary }), ...(items && { items }) }
+        : variation;
 }
 exports.traverseVariation = traverseVariation;
 function traverseSharedSlice(args) {
     const { path: prevPath, slice, onField } = args;
-    const variations = [];
-    for (const variation of slice.variations) {
+    let variations;
+    for (let i = 0; i < slice.variations.length; i++) {
+        const variation = slice.variations[i];
+        if (!variation)
+            continue;
         const path = [...prevPath, variation.id];
-        variations.push(traverseVariation({
+        const newVariation = traverseVariation({
             path,
             variation,
             onField,
-        }));
+        });
+        if (newVariation !== variation) {
+            if (!variations)
+                variations = [...slice.variations];
+            variations[i] = newVariation;
+        }
     }
-    return {
-        ...slice,
-        variations,
-    };
+    // returns the traversed model instead of a new one if it didn't change
+    return variations ? { ...slice, variations } : slice;
 }
 exports.traverseSharedSlice = traverseSharedSlice;

package/lib/customtypes/widgets/slices/Slices.js

@@ -84,7 +84,7 @@ function traverseSlices(args) {
     const { path: prevPath, slices, onField } = args;
     if (!((_a = slices.config) === null || _a === void 0 ? void 0 : _a.choices))
         return slices;
-    const choices = {};
+    let choices;
     for (const [key, prevModel] of Object.entries(slices.config.choices)) {
         const path = [...prevPath, key];
         let model;
@@ -126,14 +126,21 @@ function traverseSlices(args) {
                 });
                 break;
         }
-        choices[key] = model;
+        if (model !== prevModel) {
+            if (!choices)
+                choices = { ...slices.config.choices };
+            choices[key] = model;
+        }
     }
-    return {
-        ...slices,
-        config: {
-            ...slices.config,
-            choices,
-        },
-    };
+    // returns the traversed model instead of a new one if it didn't change
+    return choices
+        ? {
+            ...slices,
+            config: {
+                ...slices.config,
+                choices,
+            },
+        }
+        : slices;
 }
 exports.traverseSlices = traverseSlices;

package/package.json

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

package/src/content/Document.ts

@@ -9,6 +9,7 @@ import {
 	TraverseWidgetContentFn,
 } from "../_internal/utils"
 import { WidgetKey } from "../common"
+import { UUID } from "../common/UUID"
 import {
 	type StaticWidget,
 	collectSharedSlices,
@@ -114,7 +115,7 @@ function extractMetadata(data: { [p: string]: unknown }): {
 				}
 			}
 			if (k.endsWith("_KEY")) {
-				const decodedValue = t.string.decode(v)
+				const decodedValue = UUID.decode(v)
 				if (isRight(decodedValue)) {
 					return {
 						...acc,

package/src/customtypes/CustomType.ts

@@ -261,17 +261,20 @@ export function traverseCustomType<
 }): T {
 	const { customType, onField } = args
 
-	const json: Record<string, typeof customType.json[string]> = {}
+	let json: Record<string, typeof customType.json[string]> | undefined
 	for (const [key, section] of Object.entries(customType.json)) {
-		json[key] = traverseSection({
+		const newSection = traverseSection({
 			path: [key],
 			section,
 			onField,
 		})
-	}
 
-	return {
-		...customType,
-		json,
+		if (newSection !== section) {
+			if (!json) json = { ...customType.json }
+			json[key] = newSection
+		}
 	}
+
+	// returns the traversed model instead of a new one if it didn't change
+	return json ? { ...customType, json } : customType
 }

package/src/customtypes/Section.ts

@@ -52,7 +52,7 @@ export function traverseSection<
 }): T {
 	const { path: prevPath, section: prevSection, onField } = args
 
-	const section = { ...prevSection }
+	let section: T | undefined
 	for (const [key, prevModel] of Object.entries(prevSection)) {
 		const path = [...prevPath, key]
 		let model
@@ -84,7 +84,13 @@ export function traverseSection<
 				})
 				break
 		}
-		section[key] = model
+
+		if (model !== prevModel) {
+			if (!section) section = { ...prevSection }
+			section[key] = model
+		}
 	}
-	return section
+
+	// returns the traversed model instead of a new one if it didn't change
+	return section ?? prevSection
 }

package/src/customtypes/widgets/Group.ts

@@ -58,23 +58,23 @@ export function traverseNestedGroup(args: {
 
 	if (!group.config?.fields) return group
 
-	const fields: Record<string, NestableWidget> = {}
-	for (const [key, prevField] of Object.entries(group.config.fields)) {
+	let fields: Record<string, NestableWidget> | undefined
+	for (const [key, field] of Object.entries(group.config.fields)) {
 		const path = [...prevPath, key]
-		fields[key] = onField({
+		const newField = onField({
 			path,
 			key,
-			field: prevField,
+			field,
 		})
-	}
 
-	return {
-		...group,
-		config: {
-			...group.config,
-			fields,
-		},
+		if (field !== newField) {
+			if (!fields) fields = { ...group.config.fields }
+			fields[key] = newField
+		}
 	}
+
+	// returns the traversed model instead of a new one if it didn't change
+	return fields ? { ...group, config: { ...group.config, fields } } : group
 }
 
 export function traverseGroup(args: {
@@ -86,7 +86,7 @@ export function traverseGroup(args: {
 
 	if (!group.config?.fields) return group
 
-	const fields: Record<string, NestableWidget | NestedGroup> = {}
+	let fields: Record<string, NestableWidget | NestedGroup> | undefined
 	for (const [key, prevField] of Object.entries(group.config.fields)) {
 		const path = [...prevPath, key]
 		let field
@@ -102,18 +102,19 @@ export function traverseGroup(args: {
 				field = prevField
 				break
 		}
-		fields[key] = onField({
+
+		const newField = onField({
 			path,
 			key,
 			field,
 		})
-	}
 
-	return {
-		...group,
-		config: {
-			...group.config,
-			fields,
-		},
+		if (field !== newField) {
+			if (!fields) fields = { ...group.config.fields }
+			fields[key] = newField
+		}
 	}
+
+	// returns the traversed model instead of a new one if it didn't change
+	return fields ? { ...group, config: { ...group.config, fields } } : group
 }

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

@@ -46,21 +46,34 @@ export function traverseCompositeSlice(args: {
 }): CompositeSlice {
 	const { path: prevPath, slice, onField } = args
 
-	const nonRepeat: Record<string, NestableWidget> = {}
+	let nonRepeat: Record<string, NestableWidget> | undefined
 	for (const [key, field] of Object.entries(slice["non-repeat"] ?? {})) {
 		const path = [...prevPath, "non-repeat", key]
-		nonRepeat[key] = onField({ path, key, field })
+		const newField = onField({ path, key, field })
+
+		if (field !== newField) {
+			if (!nonRepeat) nonRepeat = { ...slice["non-repeat"] }
+			nonRepeat[key] = newField
+		}
 	}
 
-	const repeat: Record<string, NestableWidget> = {}
+	let repeat: Record<string, NestableWidget> | undefined
 	for (const [key, field] of Object.entries(slice.repeat ?? {})) {
 		const path = [...prevPath, "repeat", key]
-		repeat[key] = onField({ path, key, field })
-	}
+		const newField = onField({ path, key, field })
 
-	return {
-		...slice,
-		...(slice["non-repeat"] && { "non-repeat": nonRepeat }),
-		...(slice.repeat && { repeat }),
+		if (field !== newField) {
+			if (!repeat) repeat = { ...slice.repeat }
+			repeat[key] = newField
+		}
 	}
+
+	// returns the traversed model instead of a new one if it didn't change
+	return repeat || nonRepeat
+		? {
+				...slice,
+				...(nonRepeat && { "non-repeat": nonRepeat }),
+				...(repeat && { repeat }),
+		  }
+		: slice
 }

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

@@ -79,7 +79,7 @@ export function traverseVariation(args: {
 }): Variation {
 	const { path: prevPath, variation, onField } = args
 
-	const primary: Record<string, NestableWidget | Group> = {}
+	let primary: Record<string, NestableWidget | Group> | undefined
 	for (const [key, prevField] of Object.entries(variation.primary ?? {})) {
 		const path = [...prevPath, "primary", key]
 		let field
@@ -95,20 +95,32 @@ export function traverseVariation(args: {
 				field = prevField
 				break
 		}
-		primary[key] = onField({ path, key, field })
+
+		const newField = onField({ path, key, field })
+		if (field !== newField) {
+			if (!primary) primary = { ...variation.primary }
+			primary[key] = newField
+		}
 	}
 
-	const items: Record<string, NestableWidget> = {}
-	for (const [key, field] of Object.entries(variation.items ?? {})) {
+	let items: Record<string, NestableWidget> | undefined
+	for (const [key, prevField] of Object.entries(variation.items ?? {})) {
 		const path = [...prevPath, "items", key]
-		items[key] = (onField as OnFieldFn<NestableWidget>)({ path, key, field })
+		const newField = (onField as OnFieldFn<NestableWidget>)({
+			path,
+			key,
+			field: prevField,
+		})
+		if (prevField !== newField) {
+			if (!items) items = { ...variation.items }
+			items[key] = newField
+		}
 	}
 
-	return {
-		...variation,
-		...(variation.primary && { primary }),
-		...(variation.items && { items }),
-	}
+	// returns the traversed model instead of a new one if it didn't change
+	return primary || items
+		? { ...variation, ...(primary && { primary }), ...(items && { items }) }
+		: variation
 }
 
 export function traverseSharedSlice(args: {
@@ -118,20 +130,23 @@ export function traverseSharedSlice(args: {
 }): SharedSlice {
 	const { path: prevPath, slice, onField } = args
 
-	const variations: Variation[] = []
-	for (const variation of slice.variations) {
+	let variations: Variation[] | undefined
+	for (let i = 0; i < slice.variations.length; i++) {
+		const variation = slice.variations[i]
+		if (!variation) continue
 		const path = [...prevPath, variation.id]
-		variations.push(
-			traverseVariation({
-				path,
-				variation,
-				onField,
-			}),
-		)
+		const newVariation = traverseVariation({
+			path,
+			variation,
+			onField,
+		})
+
+		if (newVariation !== variation) {
+			if (!variations) variations = [...slice.variations]
+			variations[i] = newVariation
+		}
 	}
 
-	return {
-		...slice,
-		variations,
-	}
+	// returns the traversed model instead of a new one if it didn't change
+	return variations ? { ...slice, variations } : slice
 }