@prismicio/types-internal 3.1.0-alpha.5 → 3.1.0

package/lib/_internal/utils.d.ts

@@ -1,5 +1,4 @@
-import type { SharedSliceItemContent, SliceItemContent, WidgetContent } from "../content";
-import type { RepeatableContent } from "../content/fields/RepeatableContent";
+import type { RepeatableContent, SharedSliceItemContent, SliceItemContent, WidgetContent } from "../content";
 import type { CompositeSlice, Group, NestableWidget, StaticSlices, UID, VariationFields } from "../customtypes";
 export declare type TraverseSliceContentFn = <S extends SliceItemContent | SharedSliceItemContent, D extends VariationFields | CompositeSlice | Group | NestableWidget>({ path, key, apiId, model, content, }: {
     path: ContentPath;

package/lib/content/fields/GroupContent.js

@@ -10,7 +10,6 @@ const customtypes_1 = require("../../customtypes");
 const LegacyContentCtx_1 = require("../LegacyContentCtx");
 const utils_1 = require("../utils");
 const nestable_1 = require("./nestable");
-const RepeatableContent_1 = require("./RepeatableContent");
 const withDefaultValues_1 = require("./withDefaultValues");
 exports.GroupItemContentType = "GroupItemContent";
 exports.GroupContentType = "GroupContentType";
@@ -146,7 +145,7 @@ function traverseGroupItemsContent({ path, model, content, }) {
                 else if ((!fieldDef ||
                     ((fieldDef === null || fieldDef === void 0 ? void 0 : fieldDef.type) === "Link" && ((_a = fieldDef.config) === null || _a === void 0 ? void 0 : _a.repeat))) &&
                     fieldContent.__TYPE__ === "RepeatableContent") {
-                    transformedField = (0, RepeatableContent_1.traverseRepeatableContent)({
+                    transformedField = (0, nestable_1.traverseRepeatableContent)({
                         path: groupItemPath.concat([{ key: fieldKey, type: "Widget" }]),
                         key: fieldKey,
                         apiId: fieldKey,

package/lib/content/fields/RepeatableContent.d.ts

@@ -5,14 +5,12 @@ import type { LegacyContentCtx, WithTypes } from "../LegacyContentCtx";
 export declare const RepeatableContent: t.ExactC<t.TypeC<{
     __TYPE__: t.LiteralC<"RepeatableContent">;
     type: t.LiteralC<"Link">;
-    value: t.ArrayC<t.IntersectionC<[t.ExactC<t.TypeC<{
-        key: t.Type<string, string, unknown>;
-    }>>, t.ExactC<t.TypeC<{
+    value: t.ArrayC<t.ExactC<t.TypeC<{
         __TYPE__: t.LiteralC<"LinkContent">;
         value: t.UnionC<[t.IntersectionC<[t.ExactC<t.TypeC<{
             __TYPE__: t.LiteralC<"ImageLink">;
-        }>>, t.IntersectionC<[t.UnionC<[t.IntersectionC<[t.ExactC<t.TypeC<{
-            kind: t.Type<"image", "image", unknown>;
+        }>>, t.UnionC<[t.IntersectionC<[t.IntersectionC<[t.ExactC<t.TypeC<{
+            kind: t.StringC;
             id: t.StringC;
             url: t.StringC;
             height: t.StringC;
@@ -21,35 +19,38 @@ export declare const RepeatableContent: t.ExactC<t.TypeC<{
             name: t.StringC;
         }>>, t.ExactC<t.PartialC<{
             date: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+        }>>]>, t.ExactC<t.PartialC<{
+            text: t.StringC;
         }>>]>, t.ExactC<t.TypeC<{
             kind: t.LiteralC<"image">;
-        }>>]>, t.ExactC<t.PartialC<{
             text: t.StringC;
         }>>]>]>, t.IntersectionC<[t.ExactC<t.TypeC<{
             __TYPE__: t.LiteralC<"FileLink">;
-        }>>, t.IntersectionC<[t.UnionC<[t.ExactC<t.IntersectionC<[t.TypeC<{
-            kind: t.Type<"file", "file", unknown>;
+        }>>, t.UnionC<[t.IntersectionC<[t.ExactC<t.IntersectionC<[t.TypeC<{
+            kind: t.StringC;
             id: t.StringC;
             url: t.StringC;
             name: t.StringC;
             size: t.StringC;
         }>, t.PartialC<{
             date: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
-        }>]>>, t.ExactC<t.TypeC<{
+        }>]>>, t.ExactC<t.PartialC<{
+            text: t.StringC;
+        }>>]>, t.ExactC<t.TypeC<{
             kind: t.LiteralC<"file">;
-        }>>]>, t.ExactC<t.PartialC<{
             text: t.StringC;
         }>>]>]>, t.IntersectionC<[t.ExactC<t.TypeC<{
             __TYPE__: t.LiteralC<"DocumentLink">;
-        }>>, t.IntersectionC<[t.UnionC<[t.ExactC<t.TypeC<{
+        }>>, t.UnionC<[t.IntersectionC<[t.ExactC<t.TypeC<{
             id: t.Type<string, string, unknown>;
-        }>>, t.ExactC<t.TypeC<{
+        }>>, t.ExactC<t.PartialC<{
+            text: t.StringC;
+        }>>]>, t.ExactC<t.TypeC<{
             kind: t.LiteralC<"document">;
-        }>>]>, t.ExactC<t.PartialC<{
             text: t.StringC;
         }>>]>]>, t.IntersectionC<[t.ExactC<t.TypeC<{
             __TYPE__: t.LiteralC<"ExternalLink">;
-        }>>, t.IntersectionC<[t.UnionC<[t.ExactC<t.IntersectionC<[t.TypeC<{
+        }>>, t.UnionC<[t.IntersectionC<[t.ExactC<t.IntersectionC<[t.TypeC<{
             url: t.StringC;
         }>, t.PartialC<{
             kind: t.LiteralC<"web">;
@@ -59,37 +60,33 @@ export declare const RepeatableContent: t.ExactC<t.TypeC<{
             }, {
                 title?: string;
             }, unknown>, t.NullC, t.UndefinedC]>;
-        }>]>>, t.ExactC<t.TypeC<{
+        }>]>>, t.ExactC<t.PartialC<{
+            text: t.StringC;
+        }>>]>, t.ExactC<t.TypeC<{
             kind: t.LiteralC<"web">;
-        }>>]>, t.ExactC<t.PartialC<{
             text: t.StringC;
         }>>]>]>, t.IntersectionC<[t.ExactC<t.TypeC<{
             __TYPE__: t.LiteralC<"MediaLink">;
-        }>>, t.IntersectionC<[t.ExactC<t.TypeC<{
+        }>>, t.ExactC<t.TypeC<{
             kind: t.LiteralC<"media">;
-        }>>, t.ExactC<t.PartialC<{
             text: t.StringC;
-        }>>]>]>, t.IntersectionC<[t.ExactC<t.TypeC<{
+        }>>]>, t.IntersectionC<[t.ExactC<t.TypeC<{
             __TYPE__: t.LiteralC<"AnyLink">;
-        }>>, t.ExactC<t.IntersectionC<[t.TypeC<{
-            kind: t.LiteralC<"any">;
-        }>, t.PartialC<{
+        }>>, t.ExactC<t.TypeC<{
             text: t.StringC;
-        }>]>>]>]>;
-    }>>]>>;
+        }>>]>]>;
+    }>>>;
 }>>;
 export declare type RepeatableContent = t.TypeOf<typeof RepeatableContent>;
 export declare const isRepeatableContent: t.Is<{
     __TYPE__: "RepeatableContent";
     type: "Link";
-    value: ({
-        key: string;
-    } & {
+    value: {
         __TYPE__: "LinkContent";
         value: ({
             __TYPE__: "ImageLink";
-        } & ((({
-            kind: "image";
+        } & (({
+            kind: string;
             id: string;
             url: string;
             height: string;
@@ -98,41 +95,43 @@ export declare const isRepeatableContent: t.Is<{
             name: string;
         } & {
             date?: string | null | undefined;
+        } & {
+            text?: string;
         }) | {
             kind: "image";
-        }) & {
-            text?: string;
+            text: string;
         })) | ({
             __TYPE__: "FileLink";
-        } & ((({
-            kind: "file";
+        } & (({
+            kind: string;
             id: string;
             url: string;
             name: string;
             size: string;
         } & {
             date?: string | null | undefined;
+        } & {
+            text?: string;
         }) | {
             kind: "file";
-        }) & {
-            text?: string;
+            text: string;
         })) | ({
             __TYPE__: "MediaLink";
         } & {
             kind: "media";
-        } & {
-            text?: string;
+            text: string;
         }) | ({
             __TYPE__: "DocumentLink";
         } & (({
             id: string;
-        } | {
-            kind: "document";
-        }) & {
+        } & {
             text?: string;
+        }) | {
+            kind: "document";
+            text: string;
         })) | ({
             __TYPE__: "ExternalLink";
-        } & ((({
+        } & (({
             url: string;
         } & {
             kind?: "web";
@@ -140,18 +139,17 @@ export declare const isRepeatableContent: t.Is<{
             preview?: {
                 title?: string;
             } | null | undefined;
+        } & {
+            text?: string;
         }) | {
             kind: "web";
-        }) & {
-            text?: string;
+            text: string;
         })) | ({
             __TYPE__: "AnyLink";
         } & {
-            kind: "any";
-        } & {
-            text?: string;
+            text: string;
         });
-    })[];
+    }[];
 }>;
 export declare const RepeatableLegacy: (ctx: LegacyContentCtx, fieldType: "Link") => t.Type<RepeatableContent, WithTypes<Array<unknown>>, unknown>;
 export declare type RepeatableCustomType = Link;

package/lib/content/fields/index.d.ts

@@ -1,7 +1,6 @@
 export * from "./EmptyContent";
 export * from "./GroupContent";
 export * from "./nestable";
-export * from "./RepeatableContent";
 export * from "./slices";
 export * from "./UIDContent";
 export * from "./WidgetContent";

package/lib/content/fields/index.js

@@ -4,7 +4,6 @@ const tslib_1 = require("tslib");
 (0, tslib_1.__exportStar)(require("./EmptyContent"), exports);
 (0, tslib_1.__exportStar)(require("./GroupContent"), exports);
 (0, tslib_1.__exportStar)(require("./nestable"), exports);
-(0, tslib_1.__exportStar)(require("./RepeatableContent"), exports);
 (0, tslib_1.__exportStar)(require("./slices"), exports);
 (0, tslib_1.__exportStar)(require("./UIDContent"), exports);
 (0, tslib_1.__exportStar)(require("./WidgetContent"), exports);

package/lib/content/fields/nestable/NestableContent.js

@@ -5,7 +5,6 @@ const tslib_1 = require("tslib");
 const Either_1 = require("fp-ts/lib/Either");
 const t = (0, tslib_1.__importStar)(require("io-ts"));
 const EmptyContent_1 = require("../EmptyContent");
-const RepeatableContent_1 = require("../RepeatableContent");
 const BooleanContent_1 = require("./BooleanContent");
 const EmbedContent_1 = require("./EmbedContent");
 const FieldContent_1 = require("./FieldContent");
@@ -14,6 +13,7 @@ const GeoPointContent_1 = require("./GeoPointContent");
 const ImageContent_1 = require("./ImageContent");
 const IntegrationFieldContent_1 = require("./IntegrationFieldContent");
 const LinkContent_1 = require("./LinkContent");
+const RepeatableContent_1 = require("./RepeatableContent");
 const RichTextContent_1 = require("./RichTextContent");
 const SeparatorContent_1 = require("./SeparatorContent");
 exports.NestableContent = t.union([

package/lib/content/fields/nestable/RepeatableContent.d.ts

@@ -0,0 +1,164 @@
+import * as t from "io-ts";
+import type { ContentPath, TraverseWidgetContentFn } from "../../../_internal/utils";
+import type { Link, NestableWidget } from "../../../customtypes";
+import type { LegacyContentCtx, WithTypes } from "../../LegacyContentCtx";
+export declare const RepeatableContent: t.ExactC<t.TypeC<{
+    __TYPE__: t.LiteralC<"RepeatableContent">;
+    type: t.LiteralC<"Link">;
+    value: t.ArrayC<t.IntersectionC<[t.ExactC<t.TypeC<{
+        key: t.Type<string, string, unknown>;
+    }>>, t.ExactC<t.TypeC<{
+        __TYPE__: t.LiteralC<"LinkContent">;
+        value: t.UnionC<[t.IntersectionC<[t.ExactC<t.TypeC<{
+            __TYPE__: t.LiteralC<"ImageLink">;
+        }>>, t.IntersectionC<[t.UnionC<[t.IntersectionC<[t.ExactC<t.TypeC<{
+            kind: t.Type<"image", "image", unknown>;
+            id: t.StringC;
+            url: t.StringC;
+            height: t.StringC;
+            width: t.StringC;
+            size: t.StringC;
+            name: t.StringC;
+        }>>, t.ExactC<t.PartialC<{
+            date: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+        }>>]>, t.ExactC<t.TypeC<{
+            kind: t.LiteralC<"image">;
+        }>>]>, t.ExactC<t.PartialC<{
+            text: t.StringC;
+        }>>]>]>, t.IntersectionC<[t.ExactC<t.TypeC<{
+            __TYPE__: t.LiteralC<"FileLink">;
+        }>>, t.IntersectionC<[t.UnionC<[t.ExactC<t.IntersectionC<[t.TypeC<{
+            kind: t.Type<"file", "file", unknown>;
+            id: t.StringC;
+            url: t.StringC;
+            name: t.StringC;
+            size: t.StringC;
+        }>, t.PartialC<{
+            date: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+        }>]>>, t.ExactC<t.TypeC<{
+            kind: t.LiteralC<"file">;
+        }>>]>, t.ExactC<t.PartialC<{
+            text: t.StringC;
+        }>>]>]>, t.IntersectionC<[t.ExactC<t.TypeC<{
+            __TYPE__: t.LiteralC<"DocumentLink">;
+        }>>, t.IntersectionC<[t.UnionC<[t.ExactC<t.TypeC<{
+            id: t.Type<string, string, unknown>;
+        }>>, t.ExactC<t.TypeC<{
+            kind: t.LiteralC<"document">;
+        }>>]>, t.ExactC<t.PartialC<{
+            text: t.StringC;
+        }>>]>]>, t.IntersectionC<[t.ExactC<t.TypeC<{
+            __TYPE__: t.LiteralC<"ExternalLink">;
+        }>>, t.IntersectionC<[t.UnionC<[t.ExactC<t.IntersectionC<[t.TypeC<{
+            url: t.StringC;
+        }>, t.PartialC<{
+            kind: t.LiteralC<"web">;
+            target: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+            preview: t.UnionC<[t.Type<{
+                title?: string;
+            }, {
+                title?: string;
+            }, unknown>, t.NullC, t.UndefinedC]>;
+        }>]>>, t.ExactC<t.TypeC<{
+            kind: t.LiteralC<"web">;
+        }>>]>, t.ExactC<t.PartialC<{
+            text: t.StringC;
+        }>>]>]>, t.IntersectionC<[t.ExactC<t.TypeC<{
+            __TYPE__: t.LiteralC<"MediaLink">;
+        }>>, t.IntersectionC<[t.ExactC<t.TypeC<{
+            kind: t.LiteralC<"media">;
+        }>>, t.ExactC<t.PartialC<{
+            text: t.StringC;
+        }>>]>]>, t.IntersectionC<[t.ExactC<t.TypeC<{
+            __TYPE__: t.LiteralC<"AnyLink">;
+        }>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+            kind: t.LiteralC<"any">;
+        }>, t.PartialC<{
+            text: t.StringC;
+        }>]>>]>]>;
+    }>>]>>;
+}>>;
+export declare type RepeatableContent = t.TypeOf<typeof RepeatableContent>;
+export declare const isRepeatableContent: t.Is<{
+    __TYPE__: "RepeatableContent";
+    type: "Link";
+    value: ({
+        key: string;
+    } & {
+        __TYPE__: "LinkContent";
+        value: ({
+            __TYPE__: "ImageLink";
+        } & ((({
+            kind: "image";
+            id: string;
+            url: string;
+            height: string;
+            width: string;
+            size: string;
+            name: string;
+        } & {
+            date?: string | null | undefined;
+        }) | {
+            kind: "image";
+        }) & {
+            text?: string;
+        })) | ({
+            __TYPE__: "FileLink";
+        } & ((({
+            kind: "file";
+            id: string;
+            url: string;
+            name: string;
+            size: string;
+        } & {
+            date?: string | null | undefined;
+        }) | {
+            kind: "file";
+        }) & {
+            text?: string;
+        })) | ({
+            __TYPE__: "MediaLink";
+        } & {
+            kind: "media";
+        } & {
+            text?: string;
+        }) | ({
+            __TYPE__: "DocumentLink";
+        } & (({
+            id: string;
+        } | {
+            kind: "document";
+        }) & {
+            text?: string;
+        })) | ({
+            __TYPE__: "ExternalLink";
+        } & ((({
+            url: string;
+        } & {
+            kind?: "web";
+            target?: string | null | undefined;
+            preview?: {
+                title?: string;
+            } | null | undefined;
+        }) | {
+            kind: "web";
+        }) & {
+            text?: string;
+        })) | ({
+            __TYPE__: "AnyLink";
+        } & {
+            kind: "any";
+        } & {
+            text?: string;
+        });
+    })[];
+}>;
+export declare const RepeatableLegacy: (ctx: LegacyContentCtx, fieldType: "Link") => t.Type<RepeatableContent, WithTypes<Array<unknown>>, unknown>;
+export declare type RepeatableCustomType = Link;
+export declare function traverseRepeatableContent({ path, key, apiId, model, content, }: {
+    path: ContentPath;
+    key: string;
+    apiId: string;
+    content: RepeatableContent;
+    model?: NestableWidget | undefined;
+}): (transform: TraverseWidgetContentFn) => RepeatableContent | undefined;

package/lib/content/fields/nestable/RepeatableContent.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.traverseRepeatableContent = exports.RepeatableLegacy = exports.isRepeatableContent = exports.RepeatableContent = void 0;
+const tslib_1 = require("tslib");
+const fp_ts_1 = require("fp-ts");
+const Either_1 = require("fp-ts/lib/Either");
+const function_1 = require("fp-ts/lib/function");
+const t = (0, tslib_1.__importStar)(require("io-ts"));
+const LinkContent_1 = require("./LinkContent");
+exports.RepeatableContent = t.strict({
+    __TYPE__: t.literal("RepeatableContent"),
+    type: t.literal("Link"),
+    value: t.array(LinkContent_1.LinkContent),
+});
+exports.isRepeatableContent = exports.RepeatableContent.is;
+const RepeatableLegacy = (ctx, fieldType) => {
+    return new t.Type("RepeatableLegacy", exports.isRepeatableContent, (items) => {
+        const parsed = (0, function_1.pipe)(t.array(t.unknown).decode(items), fp_ts_1.either.map((items) => {
+            const parsedItems = items.reduce((acc, item) => {
+                let result;
+                switch (fieldType) {
+                    case "Link":
+                        result = (0, LinkContent_1.LinkContentLegacy)(ctx).decode(item);
+                        break;
+                }
+                if (!result)
+                    return acc;
+                if ((0, Either_1.isLeft)(result))
+                    return acc;
+                return [...acc, result.right];
+            }, []);
+            return {
+                value: parsedItems,
+                type: fieldType,
+                __TYPE__: "RepeatableContent",
+            };
+        }));
+        return parsed;
+    }, (r) => {
+        const res = t.array(LinkContent_1.LinkContent).encode(r.value);
+        const encodedItems = res.reduce((acc, item) => {
+            let encoded;
+            switch (item.__TYPE__) {
+                case LinkContent_1.LinkContentType:
+                    encoded = (0, LinkContent_1.LinkContentLegacy)(ctx).encode(item);
+                    break;
+            }
+            if (!encoded)
+                return acc;
+            return [...acc, encoded];
+        }, []);
+        return {
+            content: encodedItems.map((encodedItem) => encodedItem.content),
+            types: { [ctx.keyOfType]: `Repeatable.${fieldType}` },
+        };
+    });
+};
+exports.RepeatableLegacy = RepeatableLegacy;
+function traverseRepeatableContent({ path, key, apiId, model, content, }) {
+    return (transform) => {
+        const items = content.value.reduce((acc, fieldContent, index) => {
+            const itemPath = path.concat([
+                { key: index.toString(), type: "Widget" },
+            ]);
+            const transformedField = transform({
+                path: itemPath,
+                key: key,
+                apiId: apiId,
+                model: model,
+                content: fieldContent,
+            });
+            // Can happen if the transform function returns undefined to filter out a field
+            if (!transformedField)
+                return acc;
+            // If the transformed field is not a link content, we don't include it
+            if (!(0, LinkContent_1.isLinkContent)(transformedField))
+                return acc;
+            return acc.concat(transformedField);
+        }, []);
+        return transform({
+            path,
+            key,
+            apiId,
+            model,
+            content: {
+                __TYPE__: content.__TYPE__,
+                type: content.type,
+                value: items,
+            },
+        });
+    };
+}
+exports.traverseRepeatableContent = traverseRepeatableContent;