@prismicio/types-internal 1.1.0 → 1.2.0-alpha.0

package/lib/documents/widgets/index.js

@@ -26,7 +26,7 @@ exports.WidgetTypes = {
     slices: slices_1.SlicesContentType,
 };
 const widgetKeyRegex = new RegExp("^[^<>]+$");
-exports.WidgetKey = (0, function_1.refineType)(t.string, "WidgetKey", (s) => widgetKeyRegex.test(s));
+exports.WidgetKey = (0, function_1.refineType)(t.string, "WidgetKey", (s) => s.length === 0 || widgetKeyRegex.test(s));
 exports.Widget = {
     fromJson(widgetKey, widgetValue, widgetTypes, widgetPositions) {
         const fieldType = widgetTypes.get(widgetKey);

package/lib/documents/widgets/nestable/EmbedContent.d.ts

@@ -11,13 +11,13 @@ declare const EmbedContentC: t.Type<{
     embed_url: string;
     type: string;
 } & {
-    version?: string | number | null;
+    version?: string | number | null | undefined;
     title?: string | null | undefined;
     author_name?: string | null | undefined;
     author_url?: string | null | undefined;
     provider_name?: string | null | undefined;
     provider_url?: string | null | undefined;
-    cache_age?: string | number | null;
+    cache_age?: string | number | null | undefined;
     thumbnail_url?: string | null | undefined;
     thumbnail_width?: number | null | undefined;
     thumbnail_height?: number | null | undefined;
@@ -26,13 +26,13 @@ declare const EmbedContentC: t.Type<{
     embed_url: string;
     type: string;
 } & {
-    version?: string | number | null;
+    version?: string | number | null | undefined;
     title?: string | null | undefined;
     author_name?: string | null | undefined;
     author_url?: string | null | undefined;
     provider_name?: string | null | undefined;
     provider_url?: string | null | undefined;
-    cache_age?: string | number | null;
+    cache_age?: string | number | null | undefined;
     thumbnail_url?: string | null | undefined;
     thumbnail_width?: number | null | undefined;
     thumbnail_height?: number | null | undefined;

package/lib/documents/widgets/nestable/ImageContent.d.ts

@@ -42,9 +42,9 @@ export declare const ImageContent: t.Type<{
         background: string;
     };
 } & {
-    url?: string;
-    credits?: string | null;
-    alt?: string | null;
+    url?: string | undefined;
+    credits?: string | null | undefined;
+    alt?: string | null | undefined;
     provider?: string | null | undefined;
 } & {
     thumbnails?: {
@@ -66,12 +66,12 @@ export declare const ImageContent: t.Type<{
                 background: string;
             };
         } & {
-            url?: string;
-            credits?: string | null;
-            alt?: string | null;
+            url?: string | undefined;
+            credits?: string | null | undefined;
+            alt?: string | null | undefined;
             provider?: string | null | undefined;
         };
-    };
+    } | undefined;
 }, {
     origin: {
         id: string;
@@ -90,9 +90,9 @@ export declare const ImageContent: t.Type<{
         background: string;
     };
 } & {
-    url?: string;
-    credits?: string | null;
-    alt?: string | null;
+    url?: string | undefined;
+    credits?: string | null | undefined;
+    alt?: string | null | undefined;
     provider?: string | null | undefined;
 } & {
     thumbnails?: {
@@ -114,12 +114,12 @@ export declare const ImageContent: t.Type<{
                 background: string;
             };
         } & {
-            url?: string;
-            credits?: string | null;
-            alt?: string | null;
+            url?: string | undefined;
+            credits?: string | null | undefined;
+            alt?: string | null | undefined;
             provider?: string | null | undefined;
         };
-    };
+    } | undefined;
 } & {
     __TYPE__: "ImageContent";
 }, unknown>;

package/lib/documents/widgets/nestable/Link/ExternalLink.d.ts

@@ -3,18 +3,18 @@ export declare const ExternalLinkType = "ExternalLink";
 export declare const ExternalLink: t.Type<{
     url: string;
 } & {
-    kind?: "web";
+    kind?: "web" | undefined;
     target?: string | null | undefined;
     preview?: {
-        title?: string;
+        title?: string | undefined;
     } | null | undefined;
 }, {
     url: string;
 } & {
-    kind?: "web";
+    kind?: "web" | undefined;
     target?: string | null | undefined;
     preview?: {
-        title?: string;
+        title?: string | undefined;
     } | null | undefined;
 } & {
     __TYPE__: "ExternalLink";

package/lib/documents/widgets/nestable/Link/LinkContent.d.ts

@@ -10,10 +10,10 @@ export declare const LinkContent: t.Type<LinkContent, {
 } | ({
     url: string;
 } & {
-    kind?: "web";
+    kind?: "web" | undefined;
     target?: string | null | undefined;
     preview?: {
-        title?: string;
+        title?: string | undefined;
     } | null | undefined;
 }) | ({
     id: string;

package/lib/documents/widgets/nestable/Link/index.d.ts

@@ -50,18 +50,18 @@ export declare const Link: t.UnionC<[t.Type<{
 }, unknown>, t.Type<{
     url: string;
 } & {
-    kind?: "web";
+    kind?: "web" | undefined;
     target?: string | null | undefined;
     preview?: {
-        title?: string;
+        title?: string | undefined;
     } | null | undefined;
 }, {
     url: string;
 } & {
-    kind?: "web";
+    kind?: "web" | undefined;
     target?: string | null | undefined;
     preview?: {
-        title?: string;
+        title?: string | undefined;
     } | null | undefined;
 } & {
     __TYPE__: "ExternalLink";

package/lib/documents/widgets/nestable/StructuredTextContent/Block.d.ts

@@ -92,10 +92,10 @@ export declare const ImageBlock: t.ExactC<t.IntersectionC<[t.TypeC<{
         } | ({
             url: string;
         } & {
-            kind?: "web";
+            kind?: "web" | undefined;
             target?: string | null | undefined;
             preview?: {
-                title?: string;
+                title?: string | undefined;
             } | null | undefined;
         }) | ({
             id: string;
@@ -122,10 +122,10 @@ export declare const ImageBlock: t.ExactC<t.IntersectionC<[t.TypeC<{
         }) | ({
             url: string;
         } & {
-            kind?: "web";
+            kind?: "web" | undefined;
             target?: string | null | undefined;
             preview?: {
-                title?: string;
+                title?: string | undefined;
             } | null | undefined;
         } & {
             __TYPE__: "ExternalLink";
@@ -220,10 +220,10 @@ export declare const Block: t.UnionC<[t.ExactC<t.IntersectionC<[t.TypeC<{
         } | ({
             url: string;
         } & {
-            kind?: "web";
+            kind?: "web" | undefined;
             target?: string | null | undefined;
             preview?: {
-                title?: string;
+                title?: string | undefined;
             } | null | undefined;
         }) | ({
             id: string;
@@ -250,10 +250,10 @@ export declare const Block: t.UnionC<[t.ExactC<t.IntersectionC<[t.TypeC<{
         }) | ({
             url: string;
         } & {
-            kind?: "web";
+            kind?: "web" | undefined;
             target?: string | null | undefined;
             preview?: {
-                title?: string;
+                title?: string | undefined;
             } | null | undefined;
         } & {
             __TYPE__: "ExternalLink";

package/lib/utils/Arrays.d.ts

@@ -0,0 +1 @@
+export declare function toRecord<A extends object>(arr: ReadonlyArray<A>, key: (obj: A) => string): {};

package/lib/utils/Arrays.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toRecord = void 0;
+function toRecord(arr, key) {
+    return arr.reduce((acc, entry) => {
+        const k = key(entry);
+        return {
+            ...acc,
+            [k]: entry,
+        };
+    }, {});
+}
+exports.toRecord = toRecord;

package/lib/utils/Objects.d.ts

@@ -0,0 +1,5 @@
+export declare function zipObjects<A, B = A>(objLeft?: Partial<Record<string, A>>, objRight?: Partial<Record<string, B>>): Partial<Record<string, {
+    left?: A;
+    right?: B;
+}>>;
+export declare function isNotEmpty<A extends object>(obj: A): boolean;

package/lib/utils/Objects.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isNotEmpty = exports.zipObjects = void 0;
+function zipObjects(objLeft, objRight) {
+    const allKeys = [
+        ...new Set(Object.keys(objLeft || {}).concat(Object.keys(objRight || {}))),
+    ];
+    return allKeys.reduce((acc, key) => {
+        const left = objLeft === null || objLeft === void 0 ? void 0 : objLeft[key];
+        const right = objRight === null || objRight === void 0 ? void 0 : objRight[key];
+        return {
+            ...acc,
+            [key]: { left, right },
+        };
+    }, {});
+}
+exports.zipObjects = zipObjects;
+function isNotEmpty(obj) {
+    return Boolean(Object.keys(obj).length);
+}
+exports.isNotEmpty = isNotEmpty;

package/lib/utils/index.d.ts

@@ -0,0 +1,2 @@
+export * as Arrays from "./Arrays";
+export * as Objects from "./Objects";

package/lib/utils/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Objects = exports.Arrays = void 0;
+const tslib_1 = require("tslib");
+exports.Arrays = (0, tslib_1.__importStar)(require("./Arrays"));
+exports.Objects = (0, tslib_1.__importStar)(require("./Objects"));

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@prismicio/types-internal",
-	"version": "1.1.0",
+	"version": "1.2.0-alpha.0",
 	"description": "Prismic types for Custom Types and Prismic Data",
 	"keywords": [
 		"typescript",
@@ -55,7 +55,7 @@
 		"io-ts-types": "^0.5.16",
 		"jest": "^27.5.1",
 		"nyc": "^15.1.0",
-		"prettier": "^2.5.1",
+		"prettier": "^2.7.1",
 		"prettier-plugin-jsdoc": "^0.3.30",
 		"standard-version": "^9.3.2",
 		"ts-eager": "^2.0.2",

package/src/customtypes/comparators/Changes.ts

@@ -0,0 +1,21 @@
+export enum DiffOperation {
+	Added = "added",
+	Removed = "removed",
+	Updated = "updated",
+}
+
+export type AddChange<A> = {
+	op: DiffOperation.Added
+	value: A
+}
+
+export type RemovedChange = {
+	op: DiffOperation.Removed
+}
+
+export type UpdatedChange<A> = {
+	op: DiffOperation.Updated
+	value: A
+}
+
+export type DiffChange<A, U> = AddChange<A> | UpdatedChange<U> | RemovedChange

package/src/customtypes/comparators/SharedSlice.ts

@@ -0,0 +1,77 @@
+import { Arrays, Objects } from "../../utils"
+import type { SharedSlice, Variation } from "../widgets/slices"
+import { type DiffChange, DiffOperation } from "./Changes"
+import { VariationComparator, VariationDiff } from "./Variation"
+
+type SliceMetadata = Omit<SharedSlice, "variations">
+type SliceDiff = DiffChange<
+	SharedSlice,
+	Partial<
+		SliceMetadata & {
+			variations?: Partial<Record<string, VariationDiff>>
+		}
+	>
+>
+
+function compareSliceMeta(
+	sliceA?: SharedSlice,
+	sliceB?: SharedSlice,
+): Partial<SliceMetadata> {
+	const zippedSlices = Objects.zipObjects(sliceA, sliceB)
+
+	return Object.entries(zippedSlices).reduce((acc, [key, value]) => {
+		if (key === `variations`) return acc
+
+		if (value?.left === value?.right) return acc
+		return { ...acc, [key]: value?.right }
+	}, {})
+}
+
+export const SliceComparator = {
+	compare(sliceA?: SharedSlice, sliceB?: SharedSlice): SliceDiff | undefined {
+		if (!sliceA && sliceB)
+			return {
+				op: DiffOperation.Added,
+				value: sliceB,
+			}
+		if (sliceA && !sliceB)
+			return {
+				op: DiffOperation.Removed,
+			}
+
+		const diffMeta = compareSliceMeta(sliceA, sliceB)
+
+		const zippedSlices = Objects.zipObjects<Variation>(
+			sliceA && Arrays.toRecord(sliceA.variations, (v) => v.id),
+			sliceB && Arrays.toRecord(sliceB.variations, (v) => v.id),
+		)
+
+		const diffVariations = Object.entries(zippedSlices).reduce<
+			Partial<Record<string, VariationDiff>>
+		>((acc, [variationId, value]) => {
+			if (!value) return acc
+
+			const vDiff = VariationComparator.compare(value.left, value.right)
+			if (!vDiff) return acc
+			return {
+				...acc,
+				[variationId]: vDiff,
+			}
+		}, {})
+
+		const diffSlice = {
+			...diffMeta,
+			...(Objects.isNotEmpty(diffVariations)
+				? { variations: diffVariations }
+				: {}),
+		}
+
+		if (Objects.isNotEmpty(diffSlice)) {
+			return {
+				op: DiffOperation.Updated,
+				value: diffSlice,
+			}
+		}
+		return undefined
+	},
+}

package/src/customtypes/comparators/Variation.ts

@@ -0,0 +1,101 @@
+import { Objects } from "../../utils"
+import type { NestableWidget } from "../widgets/nestable"
+import type { Variation } from "../widgets/slices"
+import { type DiffChange, DiffOperation } from "./Changes"
+
+type VariationMetadata = Omit<Variation, "primary" | "items">
+export type VariationDiff = DiffChange<Variation, Partial<VariationMetadata>>
+
+function compareVariationMeta(
+	variationA?: Variation,
+	variationB?: Variation,
+): Partial<VariationMetadata> {
+	const zippedVariations = Objects.zipObjects(variationA, variationB)
+
+	return Object.entries(zippedVariations).reduce((acc, [key, value]) => {
+		if (key === `primary` || key === "items") return acc
+
+		if (value?.left === value?.right) return acc
+		return { ...acc, [key]: value?.right }
+	}, {})
+}
+
+function compareWidgets(
+	widgetsA?: { [key: string]: NestableWidget },
+	widgetsB?: { [key: string]: NestableWidget },
+): Record<string, DiffChange<NestableWidget, NestableWidget>> | undefined {
+	const zippedWidgets = Objects.zipObjects(widgetsA, widgetsB)
+
+	const diffWidgets = Object.entries(zippedWidgets).reduce(
+		(acc, [widgetKey, widgetValue]) => {
+			if (
+				JSON.stringify(widgetValue?.left) === JSON.stringify(widgetValue?.right)
+			)
+				return acc
+
+			const changes = (() => {
+				if (!widgetValue?.left && !widgetValue?.right) return
+				if (widgetValue?.left && !widgetValue.right)
+					return {
+						op: DiffOperation.Removed,
+					}
+				if (!widgetValue?.left && widgetValue?.right)
+					return {
+						op: DiffOperation.Added,
+						value: widgetValue.right,
+					}
+				return {
+					op: DiffOperation.Updated,
+					value: widgetValue.right,
+				}
+			})()
+
+			if (!changes) return acc
+
+			return {
+				...acc,
+				[widgetKey]: changes,
+			}
+		},
+		{},
+	)
+
+	return Objects.isNotEmpty(diffWidgets) ? diffWidgets : undefined
+}
+
+export const VariationComparator = {
+	compare(
+		variationA?: Variation,
+		variationB?: Variation,
+	): VariationDiff | undefined {
+		if (variationA && !variationB)
+			return {
+				op: DiffOperation.Removed,
+			}
+		if (!variationA && variationB) {
+			return {
+				op: DiffOperation.Added,
+				value: variationB,
+			}
+		}
+
+		const diffMeta = compareVariationMeta(variationA, variationB)
+
+		const diffPrimary = compareWidgets(variationA?.primary, variationB?.primary)
+		const diffItems = compareWidgets(variationA?.items, variationB?.items)
+
+		const diffVariation = {
+			...diffMeta,
+			...(diffPrimary ? { primary: diffPrimary } : {}),
+			...(diffItems ? { items: diffItems } : {}),
+		}
+
+		if (Objects.isNotEmpty(diffVariation)) {
+			return {
+				op: DiffOperation.Updated,
+				value: diffVariation,
+			}
+		}
+		return undefined
+	},
+}

package/src/customtypes/comparators/index.ts

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

package/src/customtypes/index.ts

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

package/src/documents/widgets/index.ts

@@ -31,8 +31,10 @@ export type WidgetTypes = typeof WidgetTypes[keyof typeof WidgetTypes]
 
 const widgetKeyRegex = new RegExp("^[^<>]+$")
 
-export const WidgetKey = refineType(t.string, "WidgetKey", (s: string) =>
-	widgetKeyRegex.test(s),
+export const WidgetKey = refineType(
+	t.string,
+	"WidgetKey",
+	(s: string) => s.length === 0 || widgetKeyRegex.test(s),
 )
 
 export type WidgetKey = t.TypeOf<typeof WidgetKey>

package/src/utils/Arrays.ts

@@ -0,0 +1,12 @@
+export function toRecord<A extends object>(
+	arr: ReadonlyArray<A>,
+	key: (obj: A) => string,
+) {
+	return arr.reduce((acc, entry) => {
+		const k = key(entry)
+		return {
+			...acc,
+			[k]: entry,
+		}
+	}, {})
+}

package/src/utils/Objects.ts

@@ -0,0 +1,24 @@
+export function zipObjects<A, B = A>(
+	objLeft?: Partial<Record<string, A>>,
+	objRight?: Partial<Record<string, B>>,
+): Partial<Record<string, { left?: A; right?: B }>> {
+	const allKeys = [
+		...new Set(Object.keys(objLeft || {}).concat(Object.keys(objRight || {}))),
+	]
+
+	return allKeys.reduce<Record<string, { left?: A; right?: B } | undefined>>(
+		(acc, key) => {
+			const left = objLeft?.[key]
+			const right = objRight?.[key]
+			return {
+				...acc,
+				[key]: { left, right },
+			}
+		},
+		{},
+	)
+}
+
+export function isNotEmpty<A extends object>(obj: A): boolean {
+	return Boolean(Object.keys(obj).length)
+}

package/src/utils/index.ts

@@ -0,0 +1,2 @@
+export * as Arrays from "./Arrays"
+export * as Objects from "./Objects"

package/CHANGELOG.md

@@ -1,13 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
-
-### [0.3.1](https://github.com/prismicio/prismic-types-internal/compare/v0.3.1-beta.0...v0.3.1) (2022-07-06)
-
-### [0.3.1-beta.0](https://github.com/prismicio/prismic-types-internal/compare/v0.3.0...v0.3.1-beta.0) (2022-06-23)
-
-
-### Bug Fixes
-
-* test StructuredTextContent ([62405b5](https://github.com/prismicio/prismic-types-internal/commit/62405b538e7db959f79fa6933129bb7f9ca008e1))
-* validate widget id format ([fe0fbec](https://github.com/prismicio/prismic-types-internal/commit/fe0fbec5287178b9d7ae5f97c4b4c3edbf364c21))