@prismicio/types-internal 2.5.0-alpha.0 → 2.5.0-alpha.2

package/lib/customtypes/widgets/Group.d.ts

@@ -1,333 +1,17 @@
 import * as t from "io-ts";
+import { NestableWidget } from "./nestable/NestableWidget";
 export declare const GroupFieldType = "Group";
-export declare const GroupConfig: 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;
-        }>>;
-    }>]>>]>>;
-}>>;
-export declare type GroupConfig = t.TypeOf<typeof GroupConfig>;
-export declare const Group: 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;
-            }>>;
-        }>]>>]>>;
-    }>>;
-}>]>>;
-export declare type Group = t.TypeOf<typeof Group>;
+export declare const GroupConfig: t.Type<GroupConfig>;
+export declare type GroupConfig = {
+    label?: string | null | undefined;
+    repeat?: boolean;
+    fields?: Record<string, Group | NestableWidget>;
+};
+export declare const Group: t.Type<Group>;
+export declare type Group = {
+    type: typeof GroupFieldType;
+    fieldset?: string | null | undefined;
+    icon?: string;
+    description?: string;
+    config?: GroupConfig;
+};

package/lib/customtypes/widgets/Group.js

@@ -5,14 +5,29 @@ const tslib_1 = require("tslib");
 const t = (0, tslib_1.__importStar)(require("io-ts"));
 const common_1 = require("../../common");
 const validators_1 = require("../../validators");
+const function_1 = require("../../validators/function");
 const NestableWidget_1 = require("./nestable/NestableWidget");
 exports.GroupFieldType = "Group";
-exports.GroupConfig = t.exact(t.partial({
+exports.GroupConfig = t.recursion("GroupConfig", () => t.exact(t.partial({
     label: validators_1.StringOrNull,
     repeat: t.boolean,
-    fields: t.record(common_1.WidgetKey, NestableWidget_1.NestableWidget),
-}));
-exports.Group = t.exact(t.intersection([
+    fields: t.record(common_1.WidgetKey, t.union([exports.Group, NestableWidget_1.NestableWidget])),
+})));
+const MAX_GROUP_DEPTH = 1;
+const getGroupDepth = (group, depth = 0) => {
+    var _a, _b;
+    // Stop searching when we're over limit
+    if (depth > MAX_GROUP_DEPTH)
+        return depth;
+    for (const key in (_a = group.config) === null || _a === void 0 ? void 0 : _a.fields) {
+        const field = (_b = group.config) === null || _b === void 0 ? void 0 : _b.fields[key];
+        if ((field === null || field === void 0 ? void 0 : field.type) === exports.GroupFieldType) {
+            depth = Math.max(depth, getGroupDepth(field, depth + 1));
+        }
+    }
+    return depth;
+};
+exports.Group = (0, function_1.refineType)(t.recursion("Group", () => t.exact(t.intersection([
     t.type({
         type: t.literal(exports.GroupFieldType),
     }),
@@ -22,4 +37,9 @@ exports.Group = t.exact(t.intersection([
         description: t.string,
         config: exports.GroupConfig,
     }),
-]));
+]))), "Group", (g) => {
+    if (getGroupDepth(g) > MAX_GROUP_DEPTH) {
+        throw new Error(`Group is nested too deeply (max ${MAX_GROUP_DEPTH} level)`);
+    }
+    return true;
+});