@prismicio/types-internal 2.4.0 → 2.4.1-alpha.0

package/lib/customtypes/diff/Variation.d.ts

@@ -1,11 +1,10 @@
-import type { NestableWidget } from "../widgets/nestable";
-import type { SlicePrimaryWidget } from "../widgets/slices";
 import type { Variation } from "../widgets/slices";
 import { type DiffChange } from "./Changes";
+import type { NestableWidgetDiff, SlicePrimaryWidgetDiff } from "./Widgets";
 export declare type VariationMetadata = Omit<Variation, "primary" | "items">;
 export declare type VariationDiff = DiffChange<Variation, Partial<VariationMetadata> & {
-    primary?: Record<string, DiffChange<SlicePrimaryWidget, SlicePrimaryWidget>>;
-    items?: Record<string, DiffChange<NestableWidget, NestableWidget>>;
+    primary?: Record<string, SlicePrimaryWidgetDiff>;
+    items?: Record<string, NestableWidgetDiff>;
 }>;
 export declare const VariationComparator: {
     compare(variationA?: ({

package/lib/customtypes/diff/Variation.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VariationComparator = void 0;
 const utils_1 = require("../../utils");
+const Group_1 = require("../widgets/Group");
 const Changes_1 = require("./Changes");
 function compareVariationMeta(variationA, variationB) {
     const zippedVariations = utils_1.Objects.zipObjects(variationA, variationB);
@@ -19,17 +20,54 @@ function compareWidgets(widgetsA, widgetsB) {
         if (JSON.stringify(widgetValue === null || widgetValue === void 0 ? void 0 : widgetValue.left) === JSON.stringify(widgetValue === null || widgetValue === void 0 ? void 0 : widgetValue.right))
             return acc;
         const changes = (() => {
+            var _a, _b, _c, _d, _e, _f, _g;
             if (!(widgetValue === null || widgetValue === void 0 ? void 0 : widgetValue.left) && !(widgetValue === null || widgetValue === void 0 ? void 0 : widgetValue.right))
                 return;
-            if ((widgetValue === null || widgetValue === void 0 ? void 0 : widgetValue.left) && !widgetValue.right)
+            if ((widgetValue === null || widgetValue === void 0 ? void 0 : widgetValue.left) && !widgetValue.right) {
                 return {
                     op: Changes_1.DiffOperation.Removed,
                 };
-            if (!(widgetValue === null || widgetValue === void 0 ? void 0 : widgetValue.left) && (widgetValue === null || widgetValue === void 0 ? void 0 : widgetValue.right))
+            }
+            if (!(widgetValue === null || widgetValue === void 0 ? void 0 : widgetValue.left) && (widgetValue === null || widgetValue === void 0 ? void 0 : widgetValue.right)) {
+                if (((_a = widgetValue.right) === null || _a === void 0 ? void 0 : _a.type) === Group_1.GroupFieldType) {
+                    const group = {
+                        ...widgetValue.right,
+                        config: {
+                            ...widgetValue.right.config,
+                            fields: {},
+                        },
+                    };
+                    // On added groups, this basically marks all fields in the group as added
+                    group.config.fields =
+                        compareWidgets(undefined, (_b = widgetValue.right.config) === null || _b === void 0 ? void 0 : _b.fields) || {};
+                    return {
+                        op: Changes_1.DiffOperation.Added,
+                        value: group,
+                    };
+                }
                 return {
                     op: Changes_1.DiffOperation.Added,
                     value: widgetValue.right,
                 };
+            }
+            if (((_c = widgetValue.right) === null || _c === void 0 ? void 0 : _c.type) === Group_1.GroupFieldType) {
+                const group = {
+                    ...widgetValue.right,
+                    config: {
+                        ...widgetValue.right.config,
+                        fields: {},
+                    },
+                };
+                // On updated groups, this also compares the fields inside the group
+                group.config.fields =
+                    compareWidgets(((_d = widgetValue.left) === null || _d === void 0 ? void 0 : _d.type) === Group_1.GroupFieldType
+                        ? (_f = (_e = widgetValue.left) === null || _e === void 0 ? void 0 : _e.config) === null || _f === void 0 ? void 0 : _f.fields
+                        : undefined, (_g = widgetValue.right.config) === null || _g === void 0 ? void 0 : _g.fields) || {};
+                return {
+                    op: Changes_1.DiffOperation.Updated,
+                    value: group,
+                };
+            }
             return {
                 op: Changes_1.DiffOperation.Updated,
                 value: widgetValue.right,

package/lib/customtypes/diff/Widgets.d.ts

@@ -0,0 +1,11 @@
+import type { Group } from "../widgets";
+import type { NestableWidget } from "../widgets/nestable";
+import type { DiffChange } from "./Changes";
+export declare type NestableWidgetDiff = DiffChange<NestableWidget, NestableWidget>;
+export declare type GroupWidgetWithFieldsDiff = Omit<Group, "config"> & {
+    config: Omit<Group["config"], "fields"> & {
+        fields?: Record<string, NestableWidgetDiff>;
+    };
+};
+export declare type GroupWidgetDiff = DiffChange<GroupWidgetWithFieldsDiff, GroupWidgetWithFieldsDiff>;
+export declare type SlicePrimaryWidgetDiff = NestableWidgetDiff | GroupWidgetDiff;

package/lib/customtypes/diff/Widgets.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@prismicio/types-internal",
-	"version": "2.4.0",
+	"version": "2.4.1-alpha.0",
 	"description": "Prismic types for Custom Types and Prismic Data",
 	"keywords": [
 		"typescript",
@@ -25,8 +25,8 @@
 		"prepare": "npm run build",
 		"release": "npm run test && standard-version && git push --follow-tags && npm run build && npm publish",
 		"release:dry": "standard-version --dry-run",
-		"release:alpha": "npm run test && standard-version --prerelease alpha && git push --follow-tags && npm run build && npm publish --tag alpha",
-		"release:alpha:dry": "standard-version --prerelease alpha --dry-run",
+		"release:alpha": "npm run test && standard-version --prerelease alpha --release-as patch && git push --follow-tags && npm run build && npm publish --tag alpha",
+		"release:alpha:dry": "standard-version --prerelease alpha --release-as patch --dry-run",
 		"test": "jest --no-cache --silent=false --verbose=false --coverage",
 		"test:clear": "jest --clearCache",
 		"eslint": "eslint . --cache --cache-location .caches/eslint --cache-strategy content --ext js,ts,tsx --max-warnings 0",

package/src/customtypes/diff/Variation.ts

@@ -1,15 +1,20 @@
 import { Objects } from "../../utils"
+import { GroupFieldType } from "../widgets/Group"
 import type { NestableWidget } from "../widgets/nestable"
 import type { SlicePrimaryWidget } from "../widgets/slices"
 import type { Variation } from "../widgets/slices"
-import { type DiffChange, DiffOperation } from "./Changes"
+import {
+	type DiffChange,
+	DiffOperation
+} from "./Changes"
+import type { GroupWidgetWithFieldsDiff,NestableWidgetDiff, SlicePrimaryWidgetDiff } from "./Widgets"
 
 export type VariationMetadata = Omit<Variation, "primary" | "items">
 export type VariationDiff = DiffChange<
 	Variation,
 	Partial<VariationMetadata> & {
-		primary?: Record<string, DiffChange<SlicePrimaryWidget, SlicePrimaryWidget>>
-		items?: Record<string, DiffChange<NestableWidget, NestableWidget>>
+		primary?: Record<string, SlicePrimaryWidgetDiff>
+		items?: Record<string, NestableWidgetDiff>
 	}
 >
 
@@ -30,7 +35,14 @@ function compareVariationMeta(
 function compareWidgets<TWidget extends NestableWidget | SlicePrimaryWidget>(
 	widgetsA?: { [key: string]: TWidget },
 	widgetsB?: { [key: string]: TWidget },
-): Record<string, DiffChange<TWidget, TWidget>> | undefined {
+):
+	| Record<
+			string,
+			SlicePrimaryWidget extends TWidget
+				? SlicePrimaryWidgetDiff
+				: NestableWidgetDiff
+	  >
+	| undefined {
 	const zippedWidgets = Objects.zipObjects(widgetsA, widgetsB)
 
 	const diffWidgets = Object.entries(zippedWidgets).reduce(
@@ -42,15 +54,61 @@ function compareWidgets<TWidget extends NestableWidget | SlicePrimaryWidget>(
 
 			const changes = (() => {
 				if (!widgetValue?.left && !widgetValue?.right) return
-				if (widgetValue?.left && !widgetValue.right)
+
+				if (widgetValue?.left && !widgetValue.right) {
 					return {
 						op: DiffOperation.Removed,
 					}
-				if (!widgetValue?.left && widgetValue?.right)
+				}
+
+				if (!widgetValue?.left && widgetValue?.right) {
+					if (widgetValue.right?.type === GroupFieldType) {
+						const group: GroupWidgetWithFieldsDiff = {
+							...widgetValue.right,
+							config: {
+								...widgetValue.right.config,
+								fields: {},
+							},
+						}
+						// On added groups, this basically marks all fields in the group as added
+						group.config.fields =
+							compareWidgets(undefined, widgetValue.right.config?.fields) || {}
+
+						return {
+							op: DiffOperation.Added,
+							value: group,
+						}
+					}
+
 					return {
 						op: DiffOperation.Added,
 						value: widgetValue.right,
 					}
+				}
+
+				if (widgetValue.right?.type === GroupFieldType) {
+					const group: GroupWidgetWithFieldsDiff = {
+						...widgetValue.right,
+						config: {
+							...widgetValue.right.config,
+							fields: {},
+						},
+					}
+					// On updated groups, this also compares the fields inside the group
+					group.config.fields =
+						compareWidgets(
+							widgetValue.left?.type === GroupFieldType
+								? widgetValue.left?.config?.fields
+								: undefined,
+							widgetValue.right.config?.fields,
+						) || {}
+
+					return {
+						op: DiffOperation.Updated,
+						value: group,
+					}
+				}
+
 				return {
 					op: DiffOperation.Updated,
 					value: widgetValue.right,

package/src/customtypes/diff/Widgets.ts

@@ -0,0 +1,23 @@
+import type { Group } from "../widgets"
+import type { NestableWidget } from "../widgets/nestable"
+import type { DiffChange } from "./Changes"
+
+export type NestableWidgetDiff = DiffChange<NestableWidget, NestableWidget>
+
+export type GroupWidgetWithFieldsDiff = Omit<Group, "config"> & {
+	config: Omit<Group["config"], "fields"> & {
+		// This line may need to be updated if we support groups within
+		// groups in the future. The diff code is already recursive and
+		// should not need updates; inputs are restricted by types, not
+		// by code.
+		//
+		// Ensure tests are updated accordingly.
+		fields?: Record<string, NestableWidgetDiff>
+	}
+}
+export type GroupWidgetDiff = DiffChange<
+	GroupWidgetWithFieldsDiff,
+	GroupWidgetWithFieldsDiff
+>
+
+export type SlicePrimaryWidgetDiff = NestableWidgetDiff | GroupWidgetDiff