@prismicio/types-internal 1.4.0 → 1.5.0

package/lib/customtypes/diff/Variation.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VariationComparator = void 0;
+const utils_1 = require("../../utils");
+const Changes_1 = require("./Changes");
+function compareVariationMeta(variationA, variationB) {
+    const zippedVariations = utils_1.Objects.zipObjects(variationA, variationB);
+    return Object.entries(zippedVariations).reduce((acc, [key, value]) => {
+        if (key === `primary` || key === "items")
+            return acc;
+        if ((value === null || value === void 0 ? void 0 : value.left) === (value === null || value === void 0 ? void 0 : value.right))
+            return acc;
+        return { ...acc, [key]: value === null || value === void 0 ? void 0 : value.right };
+    }, {});
+}
+function compareWidgets(widgetsA, widgetsB) {
+    const zippedWidgets = utils_1.Objects.zipObjects(widgetsA, widgetsB);
+    const diffWidgets = Object.entries(zippedWidgets).reduce((acc, [widgetKey, widgetValue]) => {
+        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 = (() => {
+            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)
+                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))
+                return {
+                    op: Changes_1.DiffOperation.Added,
+                    value: widgetValue.right,
+                };
+            return {
+                op: Changes_1.DiffOperation.Updated,
+                value: widgetValue.right,
+            };
+        })();
+        if (!changes)
+            return acc;
+        return {
+            ...acc,
+            [widgetKey]: changes,
+        };
+    }, {});
+    return utils_1.Objects.isNotEmpty(diffWidgets) ? diffWidgets : undefined;
+}
+exports.VariationComparator = {
+    compare(variationA, variationB) {
+        if (variationA && !variationB)
+            return {
+                op: Changes_1.DiffOperation.Removed,
+            };
+        if (!variationA && variationB) {
+            return {
+                op: Changes_1.DiffOperation.Added,
+                value: variationB,
+            };
+        }
+        const diffMeta = compareVariationMeta(variationA, variationB);
+        const diffPrimary = compareWidgets(variationA === null || variationA === void 0 ? void 0 : variationA.primary, variationB === null || variationB === void 0 ? void 0 : variationB.primary);
+        const diffItems = compareWidgets(variationA === null || variationA === void 0 ? void 0 : variationA.items, variationB === null || variationB === void 0 ? void 0 : variationB.items);
+        const diffVariation = {
+            ...diffMeta,
+            ...(diffPrimary ? { primary: diffPrimary } : {}),
+            ...(diffItems ? { items: diffItems } : {}),
+        };
+        if (utils_1.Objects.isNotEmpty(diffVariation)) {
+            return {
+                op: Changes_1.DiffOperation.Updated,
+                value: diffVariation,
+            };
+        }
+        return undefined;
+    },
+};

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

@@ -0,0 +1,3 @@
+export * from "./Changes";
+export * from "./SharedSlice";
+export * from "./Variation";

package/lib/customtypes/diff/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+(0, tslib_1.__exportStar)(require("./Changes"), exports);
+(0, tslib_1.__exportStar)(require("./SharedSlice"), exports);
+(0, tslib_1.__exportStar)(require("./Variation"), exports);

package/lib/customtypes/index.d.ts

@@ -1,4 +1,4 @@
-export * as Comparators from "./comparators";
 export * from "./CustomType";
+export * as Comparators from "./diff";
 export * as Section from "./Section";
 export * as Widgets from "./widgets";

package/lib/customtypes/index.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Widgets = exports.Section = exports.Comparators = void 0;
 const tslib_1 = require("tslib");
-exports.Comparators = (0, tslib_1.__importStar)(require("./comparators"));
 (0, tslib_1.__exportStar)(require("./CustomType"), exports);
+exports.Comparators = (0, tslib_1.__importStar)(require("./diff"));
 exports.Section = (0, tslib_1.__importStar)(require("./Section"));
 exports.Widgets = (0, tslib_1.__importStar)(require("./widgets"));

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@prismicio/types-internal",
-	"version": "1.4.0",
+	"version": "1.5.0",
 	"description": "Prismic types for Custom Types and Prismic Data",
 	"keywords": [
 		"typescript",
@@ -40,6 +40,7 @@
 		"tslib": "^2.3.1"
 	},
 	"devDependencies": {
+		"@fast-check/jest": "^1.4.0",
 		"@relmify/jest-fp-ts": "^1.1.1",
 		"@types/jest": "^27.4.0",
 		"@typescript-eslint/eslint-plugin": "^5.8.1",

package/src/content/CustomType.ts

@@ -0,0 +1,20 @@
+import * as t from "io-ts"
+
+import { WidgetKey as KeyForWidgetContent } from "../documents/widgets"
+import {
+	GroupContent,
+	NestableContent,
+	SlicesContent,
+	UIDContent,
+} from "./fields"
+
+export const WidgetKey = KeyForWidgetContent
+
+const WidgetContent = t.union([
+	SlicesContent,
+	UIDContent,
+	NestableContent,
+	GroupContent,
+])
+export const CustomTypeContent = t.record(WidgetKey, WidgetContent)
+export type CustomTypeContent = t.TypeOf<typeof CustomTypeContent>

package/src/content/fields/UIDContent.ts

@@ -0,0 +1,10 @@
+import * as t from "io-ts"
+
+import { UIDContentType } from "../../documents/widgets/UIDContent"
+
+export const UIDContent = t.type({
+	__TYPE__: t.literal(UIDContentType),
+	value: t.string,
+})
+
+export type UIDContent = t.TypeOf<typeof UIDContent>

package/src/content/fields/index.ts

@@ -1,3 +1,4 @@
 export * from "./GroupContent"
 export * from "./nestable"
 export * from "./slices"
+export * from "./UIDContent"

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

@@ -0,0 +1,12 @@
+import * as t from "io-ts"
+
+import { CompositeSliceContentType } from "../../../documents/widgets/slices"
+import { NestableContent } from "../nestable"
+
+export const CompositeSliceContent = t.type({
+	__TYPE__: t.literal(CompositeSliceContentType),
+	repeat: t.array(t.tuple([t.string, NestableContent])),
+	"non-repeat": t.record(t.string, NestableContent),
+})
+
+export type CompositeSliceContent = t.TypeOf<typeof CompositeSliceContent>

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

@@ -1,14 +1,13 @@
 import * as t from "io-ts"
 
 import { SharedSliceContentType as type } from "../../../documents/widgets/slices"
-import { GroupItemContent } from "../GroupContent"
 import { NestableContent } from "../nestable"
 
 export const SharedSliceContent = t.strict({
 	__TYPE__: t.literal(type),
 	variation: t.string,
 	primary: t.record(t.string, NestableContent),
-	items: t.array(GroupItemContent),
+	items: t.array(t.tuple([t.string, NestableContent])),
 })
 export type SharedSliceContent = t.TypeOf<typeof SharedSliceContent>
 export const SharedSliceContentType = type

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

@@ -0,0 +1,7 @@
+import * as t from "io-ts"
+
+import { GroupContent } from "../GroupContent"
+import { NestableContent } from "../nestable"
+
+export const SimpleSliceContent = t.union([NestableContent, GroupContent])
+export type SimpleSliceContent = t.TypeOf<typeof SimpleSliceContent>

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

@@ -0,0 +1,26 @@
+import * as t from "io-ts"
+
+import { SlicesContentType } from "../../../documents/widgets/slices"
+import { CompositeSliceContent } from "./CompositeSliceContent"
+import { SharedSliceContent } from "./SharedSliceContent"
+import { SimpleSliceContent } from "./SimpleSliceContent"
+
+export const SliceItemContent = t.type({
+	key: t.string,
+	name: t.string,
+	maybeLabel: t.union([t.string, t.undefined]),
+	widget: t.union([
+		CompositeSliceContent,
+		SharedSliceContent,
+		SimpleSliceContent,
+	]),
+})
+
+export type SliceContentItem = t.TypeOf<typeof SliceItemContent>
+
+export const SlicesContent = t.type({
+	__TYPE__: t.literal(SlicesContentType),
+	value: t.array(SliceItemContent),
+})
+
+export type SlicesContent = t.TypeOf<typeof SlicesContent>

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

@@ -1 +1,4 @@
+export * from "./CompositeSliceContent"
 export * from "./SharedSliceContent"
+export * from "./SimpleSliceContent"
+export * from "./SlicesContent"

package/src/content/index.ts

@@ -1 +1,2 @@
+export * from "./CustomType"
 export * from "./fields"

package/src/customtypes/index.ts

@@ -1,4 +1,4 @@
-export * as Comparators from "./comparators"
 export * from "./CustomType"
+export * as Comparators from "./diff"
 export * as Section from "./Section"
 export * as Widgets from "./widgets"