@prismicio/types-internal 2.5.0-alpha.3 → 2.5.0

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

@@ -0,0 +1,327 @@
+import * as t from "io-ts";
+export declare const SliceWidget: t.UnionC<[t.ExactC<t.IntersectionC<[t.TypeC<{
+    type: t.LiteralC<"Group">;
+}>, t.PartialC<{
+    fieldset: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+    icon: t.StringC;
+    description: t.StringC;
+    config: t.ExactC<t.PartialC<{
+        label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+        repeat: t.BooleanC;
+        fields: t.RecordC<t.Type<string, string, unknown>, t.UnionC<[t.ExactC<t.IntersectionC<[t.TypeC<{
+            type: t.LiteralC<"Color">;
+        }>, t.PartialC<{
+            fieldset: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+            config: t.ExactC<t.PartialC<{
+                label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+                placeholder: t.StringC;
+            }>>;
+        }>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+            type: t.LiteralC<"Boolean">;
+        }>, t.PartialC<{
+            config: t.ExactC<t.PartialC<{
+                label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+                default_value: t.BooleanC;
+                placeholder_true: t.StringC;
+                placeholder_false: t.StringC;
+            }>>;
+        }>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+            type: t.LiteralC<"Embed">;
+        }>, t.PartialC<{
+            fieldset: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+            config: t.ExactC<t.PartialC<{
+                label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+                placeholder: t.StringC;
+                useAsTitle: t.BooleanC;
+            }>>;
+        }>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+            type: t.LiteralC<"GeoPoint">;
+        }>, t.PartialC<{
+            fieldset: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+            config: t.ExactC<t.PartialC<{
+                label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+            }>>;
+        }>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+            type: t.LiteralC<"Date">;
+        }>, t.PartialC<{
+            fieldset: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+            config: t.ExactC<t.PartialC<{
+                label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+                placeholder: t.StringC;
+                default: t.StringC;
+            }>>;
+        }>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+            type: t.LiteralC<"Number">;
+        }>, t.PartialC<{
+            fieldset: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+            config: t.ExactC<t.PartialC<{
+                label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+                placeholder: t.StringC;
+                min: t.UnionC<[t.NumberC, import("io-ts-types").NumberFromStringC]>;
+                max: t.UnionC<[t.NumberC, import("io-ts-types").NumberFromStringC]>;
+                step: t.UnionC<[t.NumberC, import("io-ts-types").NumberFromStringC]>;
+            }>>;
+        }>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+            type: t.LiteralC<"Range">;
+        }>, t.PartialC<{
+            fieldset: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+            config: t.ExactC<t.PartialC<{
+                label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+                placeholder: t.StringC;
+                min: t.UnionC<[t.NumberC, import("io-ts-types").NumberFromStringC]>;
+                max: t.UnionC<[t.NumberC, import("io-ts-types").NumberFromStringC]>;
+                step: t.UnionC<[t.NumberC, import("io-ts-types").NumberFromStringC]>;
+            }>>;
+        }>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+            type: t.LiteralC<"StructuredText">;
+        }>, t.PartialC<{
+            fieldset: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+            config: t.ExactC<t.PartialC<{
+                label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+                placeholder: t.StringC;
+                useAsTitle: t.BooleanC;
+                single: t.Type<string, string, unknown>;
+                multi: t.Type<string, string, unknown>;
+                imageConstraint: t.PartialC<{
+                    width: t.Type<number | null, unknown, unknown>;
+                    height: t.Type<number | null, unknown, unknown>;
+                }>;
+                labels: t.Type<readonly string[], object, unknown>;
+                allowTargetBlank: t.BooleanC;
+            }>>;
+        }>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+            type: t.LiteralC<"Select">;
+        }>, t.PartialC<{
+            fieldset: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+            config: t.ExactC<t.PartialC<{
+                label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+                placeholder: t.StringC;
+                default_value: t.StringC;
+                options: t.ReadonlyArrayC<t.UnionC<[t.StringC, t.Type<string, string, unknown>, t.Type<string, string, unknown>]>>;
+            }>>;
+        }>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+            type: t.LiteralC<"Separator">;
+        }>, t.PartialC<{
+            config: t.ExactC<t.PartialC<{
+                label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+            }>>;
+        }>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+            type: t.LiteralC<"Text">;
+        }>, t.PartialC<{
+            fieldset: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+            config: t.ExactC<t.PartialC<{
+                label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+                useAsTitle: t.BooleanC;
+                placeholder: t.StringC;
+            }>>;
+        }>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+            type: t.LiteralC<"Timestamp">;
+        }>, t.PartialC<{
+            fieldset: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+            config: t.ExactC<t.PartialC<{
+                label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+                placeholder: t.StringC;
+                default: t.StringC;
+            }>>;
+        }>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+            type: t.LiteralC<"Link">;
+        }>, t.PartialC<{
+            fieldset: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+            config: t.ExactC<t.PartialC<{
+                label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+                useAsTitle: t.BooleanC;
+                placeholder: t.StringC;
+                select: t.UnionC<[t.LiteralC<"media">, t.LiteralC<"document">, t.LiteralC<"web">, t.NullC]>;
+                customtypes: t.ReadonlyArrayC<t.StringC>;
+                masks: t.Type<readonly string[], object, unknown>;
+                tags: t.Type<readonly string[], object, unknown>;
+                allowTargetBlank: t.BooleanC;
+            }>>;
+        }>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+            type: t.LiteralC<"Image">;
+        }>, t.PartialC<{
+            fieldset: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+            config: t.ExactC<t.PartialC<{
+                label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+                placeholder: t.StringC;
+                constraint: t.PartialC<{
+                    width: t.Type<number | null, unknown, unknown>;
+                    height: t.Type<number | null, unknown, unknown>;
+                }>;
+                thumbnails: t.ReadonlyArrayC<t.ExactC<t.IntersectionC<[t.TypeC<{
+                    name: t.StringC;
+                }>, t.PartialC<{
+                    width: t.Type<number | null, unknown, unknown>;
+                    height: t.Type<number | null, unknown, unknown>;
+                }>]>>>;
+            }>>;
+        }>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+            type: t.LiteralC<"IntegrationFields">;
+        }>, t.PartialC<{
+            fieldset: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+            config: t.ExactC<t.PartialC<{
+                label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+                placeholder: t.StringC;
+                catalog: t.StringC;
+            }>>;
+        }>]>>]>>;
+    }>>;
+}>]>>, t.UnionC<[t.ExactC<t.IntersectionC<[t.TypeC<{
+    type: t.LiteralC<"Color">;
+}>, t.PartialC<{
+    fieldset: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+    config: t.ExactC<t.PartialC<{
+        label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+        placeholder: t.StringC;
+    }>>;
+}>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+    type: t.LiteralC<"Boolean">;
+}>, t.PartialC<{
+    config: t.ExactC<t.PartialC<{
+        label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+        default_value: t.BooleanC;
+        placeholder_true: t.StringC;
+        placeholder_false: t.StringC;
+    }>>;
+}>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+    type: t.LiteralC<"Embed">;
+}>, t.PartialC<{
+    fieldset: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+    config: t.ExactC<t.PartialC<{
+        label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+        placeholder: t.StringC;
+        useAsTitle: t.BooleanC;
+    }>>;
+}>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+    type: t.LiteralC<"GeoPoint">;
+}>, t.PartialC<{
+    fieldset: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+    config: t.ExactC<t.PartialC<{
+        label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+    }>>;
+}>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+    type: t.LiteralC<"Date">;
+}>, t.PartialC<{
+    fieldset: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+    config: t.ExactC<t.PartialC<{
+        label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+        placeholder: t.StringC;
+        default: t.StringC;
+    }>>;
+}>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+    type: t.LiteralC<"Number">;
+}>, t.PartialC<{
+    fieldset: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+    config: t.ExactC<t.PartialC<{
+        label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+        placeholder: t.StringC;
+        min: t.UnionC<[t.NumberC, import("io-ts-types").NumberFromStringC]>;
+        max: t.UnionC<[t.NumberC, import("io-ts-types").NumberFromStringC]>;
+        step: t.UnionC<[t.NumberC, import("io-ts-types").NumberFromStringC]>;
+    }>>;
+}>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+    type: t.LiteralC<"Range">;
+}>, t.PartialC<{
+    fieldset: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+    config: t.ExactC<t.PartialC<{
+        label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+        placeholder: t.StringC;
+        min: t.UnionC<[t.NumberC, import("io-ts-types").NumberFromStringC]>;
+        max: t.UnionC<[t.NumberC, import("io-ts-types").NumberFromStringC]>;
+        step: t.UnionC<[t.NumberC, import("io-ts-types").NumberFromStringC]>;
+    }>>;
+}>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+    type: t.LiteralC<"StructuredText">;
+}>, t.PartialC<{
+    fieldset: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+    config: t.ExactC<t.PartialC<{
+        label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+        placeholder: t.StringC;
+        useAsTitle: t.BooleanC;
+        single: t.Type<string, string, unknown>;
+        multi: t.Type<string, string, unknown>;
+        imageConstraint: t.PartialC<{
+            width: t.Type<number | null, unknown, unknown>;
+            height: t.Type<number | null, unknown, unknown>;
+        }>;
+        labels: t.Type<readonly string[], object, unknown>;
+        allowTargetBlank: t.BooleanC;
+    }>>;
+}>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+    type: t.LiteralC<"Select">;
+}>, t.PartialC<{
+    fieldset: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+    config: t.ExactC<t.PartialC<{
+        label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+        placeholder: t.StringC;
+        default_value: t.StringC;
+        options: t.ReadonlyArrayC<t.UnionC<[t.StringC, t.Type<string, string, unknown>, t.Type<string, string, unknown>]>>;
+    }>>;
+}>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+    type: t.LiteralC<"Separator">;
+}>, t.PartialC<{
+    config: t.ExactC<t.PartialC<{
+        label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+    }>>;
+}>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+    type: t.LiteralC<"Text">;
+}>, t.PartialC<{
+    fieldset: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+    config: t.ExactC<t.PartialC<{
+        label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+        useAsTitle: t.BooleanC;
+        placeholder: t.StringC;
+    }>>;
+}>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+    type: t.LiteralC<"Timestamp">;
+}>, t.PartialC<{
+    fieldset: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+    config: t.ExactC<t.PartialC<{
+        label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+        placeholder: t.StringC;
+        default: t.StringC;
+    }>>;
+}>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+    type: t.LiteralC<"Link">;
+}>, t.PartialC<{
+    fieldset: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+    config: t.ExactC<t.PartialC<{
+        label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+        useAsTitle: t.BooleanC;
+        placeholder: t.StringC;
+        select: t.UnionC<[t.LiteralC<"media">, t.LiteralC<"document">, t.LiteralC<"web">, t.NullC]>;
+        customtypes: t.ReadonlyArrayC<t.StringC>;
+        masks: t.Type<readonly string[], object, unknown>;
+        tags: t.Type<readonly string[], object, unknown>;
+        allowTargetBlank: t.BooleanC;
+    }>>;
+}>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+    type: t.LiteralC<"Image">;
+}>, t.PartialC<{
+    fieldset: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+    config: t.ExactC<t.PartialC<{
+        label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+        placeholder: t.StringC;
+        constraint: t.PartialC<{
+            width: t.Type<number | null, unknown, unknown>;
+            height: t.Type<number | null, unknown, unknown>;
+        }>;
+        thumbnails: t.ReadonlyArrayC<t.ExactC<t.IntersectionC<[t.TypeC<{
+            name: t.StringC;
+        }>, t.PartialC<{
+            width: t.Type<number | null, unknown, unknown>;
+            height: t.Type<number | null, unknown, unknown>;
+        }>]>>>;
+    }>>;
+}>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+    type: t.LiteralC<"IntegrationFields">;
+}>, t.PartialC<{
+    fieldset: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+    config: t.ExactC<t.PartialC<{
+        label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+        placeholder: t.StringC;
+        catalog: t.StringC;
+    }>>;
+}>]>>]>]>;
+export declare type SliceWidget = t.TypeOf<typeof SliceWidget>;
+export declare type SliceFieldTypes = SliceWidget["type"];

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

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SliceWidget = void 0;
+const tslib_1 = require("tslib");
+const t = (0, tslib_1.__importStar)(require("io-ts"));
+const Group_1 = require("../Group");
+const nestable_1 = require("../nestable");
+exports.SliceWidget = t.union([Group_1.Group, nestable_1.NestableWidget]);

package/lib/validators/function.js

@@ -12,14 +12,7 @@ function nullable(c) {
 }
 exports.nullable = nullable;
 function refineType(type, newName, pred) {
-    return new t.Type(newName, type.is, (u, c) => (0, function_1.pipe)(type.validate(u, c), fp_ts_1.either.chain((v) => {
-        try {
-            return pred(v) ? t.success(v) : t.failure(u, c);
-        }
-        catch (error) {
-            return t.failure(u, c, error instanceof Error ? error.message : String(error));
-        }
-    })), type.encode);
+    return new t.Type(newName, type.is, (u, c) => (0, function_1.pipe)(type.validate(u, c), fp_ts_1.either.chain((v) => (pred(v) ? t.success(v) : t.failure(u, c)))), type.encode);
 }
 exports.refineType = refineType;
 function filterDouble(value) {

package/package.json

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

package/src/_internal/utils.ts

@@ -7,6 +7,7 @@ import type {
 	CompositeSlice,
 	Group,
 	NestableWidget,
+	NestedGroup,
 	StaticSlices,
 	UID,
 	VariationFields,
@@ -88,4 +89,4 @@ export type SliceModel =
 	| VariationFields
 	| NestableWidget
 	| CompositeSlice
-	| Group
+	| NestedGroup

package/src/content/fields/GroupContent.ts

@@ -53,10 +53,7 @@ export type GroupContent = {
 	value: GroupItemContent[]
 }
 
-export const isGroupContent = (u: unknown): u is GroupContent =>
-	hasContentType(u) &&
-	u.__TYPE__ === GroupContentType &&
-	GroupContent.decode(u)._tag === "Right"
+export const isGroupContent = GroupContent.is
 
 export const GroupContentDefaultValue: GroupContent = {
 	__TYPE__: GroupContentType,

package/src/content/fields/nestable/RichTextContent/Blocks.ts

@@ -79,9 +79,12 @@ export const ValidatedSpans = <C extends typeof Span | typeof SpanLegacy>(
 	)
 }
 
-// We allow any `t.Type` here and let TypeScript infer the exact codec.
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-const ImageBlockCodec = <T extends t.Type<any>>(linkCodec: T) =>
+// We allow any codec here and let TypeScript infer the resulting codec.
+// Typing it more precisely creates conflicts.
+//
+// Using `t.Mixed` rather than `t.Type<A, O>` causes `data.linkTo` to be
+// typed as `any`. It seems to be an issue with the `nullable` helper.
+const ImageBlockCodec = <A, O>(linkCodec: t.Type<A, O>) =>
 	t.exact(
 		t.intersection([
 			t.type({

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

@@ -15,7 +15,6 @@ import {
 	WithTypes,
 } from "../../../LegacyContentCtx"
 import { hasContentType } from "../../../utils"
-import { GroupItemContent, traverseGroupItemsContent } from "../../GroupContent"
 import {
 	isNestableContent,
 	NestableContent,
@@ -29,7 +28,12 @@ import type {
 	CompositeSliceItemContent,
 	SharedSliceItemContent,
 } from "../SliceItem"
-import { RepeatableWidgets, RepeatableWidgetsLegacy } from "./RepeatableContent"
+import {
+	RepeatableWidgetItemContent,
+	RepeatableWidgets,
+	RepeatableWidgetsLegacy,
+	traverseRepeatableWidgetItemsContent,
+} from "./RepeatableContent"
 
 export const CompositeSliceContentType = "CompositeSliceContent"
 
@@ -208,7 +212,7 @@ export function traverseCompositeSliceContent({
 			}
 		}, {})
 
-		const items = traverseGroupItemsContent({
+		const items = traverseRepeatableWidgetItemsContent({
 			path: path.concat([{ key: "repeat", type: "items" }]),
 			model:
 				model?.type === "SharedSlice" ? model?.fields.items : model?.repeat,
@@ -260,7 +264,7 @@ export function migrateCompositeSlice(
 			items: content.widget.repeat.map((groupItem) => {
 				return {
 					__TYPE__: "GroupItemContent",
-					value: groupItem.value.reduce<GroupItemContent["value"]>(
+					value: groupItem.value.reduce<RepeatableWidgetItemContent["value"]>(
 						(acc, [fieldKey, fieldContent]) => {
 							if (!model.fields.items?.[fieldKey]) {
 								console.warn(