@prismicio/types-internal 1.5.3 → 2.0.0-alpha.0

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

@@ -1,7 +1,103 @@
 import * as t from "io-ts";
+import type { LegacyContentCtx, WithTypes } from "../../LegacyContentCtx";
+export declare const ImageLinkType = "ImageLink";
 export declare const ImageLinkContent: t.IntersectionC<[t.ExactC<t.TypeC<{
     __TYPE__: t.LiteralC<"ImageLink">;
-}>>, t.Type<{
+}>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+    id: t.StringC;
+    url: t.StringC;
+    height: t.StringC;
+    width: t.StringC;
+    size: t.StringC;
+    name: t.StringC;
+    kind: t.StringC;
+}>, t.PartialC<{
+    date: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+}>]>>]>;
+export declare type ImageLinkContent = t.TypeOf<typeof ImageLinkContent>;
+export declare const FileLinkType = "FileLink";
+export declare const FileLinkContent: t.IntersectionC<[t.ExactC<t.IntersectionC<[t.TypeC<{
+    id: t.StringC;
+    url: t.StringC;
+    name: t.StringC;
+    kind: t.StringC;
+}>, t.PartialC<{
+    date: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+    size: t.StringC;
+}>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+    __TYPE__: t.LiteralC<"FileLink">;
+}>, t.PartialC<{
+    size: t.StringC;
+}>]>>]>;
+export declare type FileLinkContent = t.TypeOf<typeof FileLinkContent>;
+export declare const DocumentLinkType = "DocumentLink";
+export declare const DocumentLinkContent: t.IntersectionC<[t.ExactC<t.TypeC<{
+    __TYPE__: t.LiteralC<"DocumentLink">;
+}>>, t.ExactC<t.TypeC<{
+    id: t.Type<string, string, unknown>;
+}>>]>;
+export declare type DocumentLinkContent = t.TypeOf<typeof DocumentLinkContent>;
+export declare const ExternalLinkType = "ExternalLink";
+export declare const ExternalLinkContent: t.IntersectionC<[t.ExactC<t.TypeC<{
+    __TYPE__: t.LiteralC<"ExternalLink">;
+}>>, 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]>;
+}>]>>]>;
+export declare type ExternalLinkContent = t.TypeOf<typeof ExternalLinkContent>;
+export declare const LinkContentType = "LinkContent";
+export declare const isLinkContent: (u: unknown) => u is {
+    __TYPE__: "LinkContent";
+    value: ({
+        __TYPE__: "ImageLink";
+    } & {
+        id: string;
+        url: string;
+        height: string;
+        width: string;
+        size: string;
+        name: string;
+        kind: string;
+    } & {
+        date?: string | null | undefined;
+    }) | ({
+        id: string;
+        url: string;
+        name: string;
+        kind: string;
+    } & {
+        date?: string | null | undefined;
+        size?: string;
+    } & {
+        __TYPE__: "FileLink";
+    } & {
+        size?: string;
+    }) | ({
+        __TYPE__: "DocumentLink";
+    } & {
+        id: string;
+    }) | ({
+        __TYPE__: "ExternalLink";
+    } & {
+        url: string;
+    } & {
+        kind?: "web";
+        target?: string | null | undefined;
+        preview?: {
+            title?: string;
+        } | null | undefined;
+    });
+};
+export declare const LinkLegacy: t.UnionC<[t.Type<{
+    __TYPE__: "ImageLink";
+} & {
     id: string;
     url: string;
     height: string;
@@ -21,12 +117,7 @@ export declare const ImageLinkContent: t.IntersectionC<[t.ExactC<t.TypeC<{
     kind: string;
 } & {
     date?: string | null | undefined;
-} & {
-    __TYPE__: "ImageLink";
-}, unknown>]>;
-export declare type ImageLinkContent = t.TypeOf<typeof ImageLinkContent>;
-export declare const ImageLinkType = "ImageLink";
-export declare const FileLinkContent: t.IntersectionC<[t.Type<{
+}, unknown>, t.Type<{
     id: string;
     url: string;
     name: string;
@@ -34,34 +125,27 @@ export declare const FileLinkContent: t.IntersectionC<[t.Type<{
 } & {
     date?: string | null | undefined;
     size?: string;
+} & {
+    __TYPE__: "FileLink";
+} & {
+    size?: string;
 }, {
-    readonly size: string;
-    readonly __TYPE__: "FileLink";
-    readonly id: string;
-    readonly url: string;
-    readonly name: string;
-    readonly kind: string;
-    readonly date?: string | null | undefined;
-}, unknown>, t.ExactC<t.TypeC<{
-    __TYPE__: t.LiteralC<"FileLink">;
-    size: t.StringC;
-}>>]>;
-export declare type FileLinkContent = t.TypeOf<typeof FileLinkContent>;
-export declare const FileLinkType = "FileLink";
-export declare const DocumentLinkContent: t.IntersectionC<[t.ExactC<t.TypeC<{
-    __TYPE__: t.LiteralC<"DocumentLink">;
-}>>, t.Type<{
+    id: string;
+    url: string;
+    name: string;
+    kind: string;
+} & {
+    date?: string | null | undefined;
+    size?: string;
+}, unknown>, t.Type<{
+    __TYPE__: "DocumentLink";
+} & {
     id: string;
 }, {
     id: string;
+}, unknown>, t.Type<{
+    __TYPE__: "ExternalLink";
 } & {
-    __TYPE__: "DocumentLink";
-}, unknown>]>;
-export declare type DocumentLinkContent = t.TypeOf<typeof DocumentLinkContent>;
-export declare const DocumentLinkType = "DocumentLink";
-export declare const ExternalLinkContent: t.IntersectionC<[t.ExactC<t.TypeC<{
-    __TYPE__: t.LiteralC<"ExternalLink">;
-}>>, t.Type<{
     url: string;
 } & {
     kind?: "web";
@@ -77,16 +161,12 @@ export declare const ExternalLinkContent: t.IntersectionC<[t.ExactC<t.TypeC<{
     preview?: {
         title?: string;
     } | null | undefined;
-} & {
-    __TYPE__: "ExternalLink";
 }, unknown>]>;
-export declare type ExternalLinkContent = t.TypeOf<typeof ExternalLinkContent>;
-export declare const ExternalLinkType = "ExternalLink";
-export declare const LinkContent: t.ExactC<t.TypeC<{
-    __TYPE__: t.LiteralC<"LinkContent">;
-    value: t.UnionC<[t.IntersectionC<[t.ExactC<t.TypeC<{
-        __TYPE__: t.LiteralC<"ImageLink">;
-    }>>, t.Type<{
+export declare const LinkContentLegacy: (ctx: LegacyContentCtx) => t.Type<{
+    __TYPE__: "LinkContent";
+    value: ({
+        __TYPE__: "ImageLink";
+    } & {
         id: string;
         url: string;
         height: string;
@@ -96,48 +176,25 @@ export declare const LinkContent: t.ExactC<t.TypeC<{
         kind: string;
     } & {
         date?: string | null | undefined;
-    }, {
+    }) | ({
         id: string;
         url: string;
-        height: string;
-        width: string;
-        size: string;
         name: string;
         kind: string;
     } & {
         date?: string | null | undefined;
+        size?: string;
     } & {
-        __TYPE__: "ImageLink";
-    }, unknown>]>, t.IntersectionC<[t.Type<{
-        id: string;
-        url: string;
-        name: string;
-        kind: string;
+        __TYPE__: "FileLink";
     } & {
-        date?: string | null | undefined;
         size?: string;
-    }, {
-        readonly size: string;
-        readonly __TYPE__: "FileLink";
-        readonly id: string;
-        readonly url: string;
-        readonly name: string;
-        readonly kind: string;
-        readonly date?: string | null | undefined;
-    }, unknown>, t.ExactC<t.TypeC<{
-        __TYPE__: t.LiteralC<"FileLink">;
-        size: t.StringC;
-    }>>]>, t.IntersectionC<[t.ExactC<t.TypeC<{
-        __TYPE__: t.LiteralC<"DocumentLink">;
-    }>>, t.Type<{
-        id: string;
-    }, {
+    }) | ({
+        __TYPE__: "DocumentLink";
+    } & {
         id: string;
+    }) | ({
+        __TYPE__: "ExternalLink";
     } & {
-        __TYPE__: "DocumentLink";
-    }, unknown>]>, t.IntersectionC<[t.ExactC<t.TypeC<{
-        __TYPE__: t.LiteralC<"ExternalLink">;
-    }>>, t.Type<{
         url: string;
     } & {
         kind?: "web";
@@ -145,24 +202,120 @@ export declare const LinkContent: t.ExactC<t.TypeC<{
         preview?: {
             title?: string;
         } | null | undefined;
+    });
+}, WithTypes<({
+    id: string;
+    url: string;
+    height: string;
+    width: string;
+    size: string;
+    name: string;
+    kind: string;
+} & {
+    date?: string | null | undefined;
+}) | ({
+    id: string;
+    url: string;
+    name: string;
+    kind: string;
+} & {
+    date?: string | null | undefined;
+    size?: string;
+}) | {
+    id: string;
+} | ({
+    url: string;
+} & {
+    kind?: "web";
+    target?: string | null | undefined;
+    preview?: {
+        title?: string;
+    } | null | undefined;
+})>, unknown>;
+export declare const Link: t.UnionC<[t.IntersectionC<[t.ExactC<t.TypeC<{
+    __TYPE__: t.LiteralC<"ImageLink">;
+}>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+    id: t.StringC;
+    url: t.StringC;
+    height: t.StringC;
+    width: t.StringC;
+    size: t.StringC;
+    name: t.StringC;
+    kind: t.StringC;
+}>, t.PartialC<{
+    date: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+}>]>>]>, t.IntersectionC<[t.ExactC<t.IntersectionC<[t.TypeC<{
+    id: t.StringC;
+    url: t.StringC;
+    name: t.StringC;
+    kind: t.StringC;
+}>, t.PartialC<{
+    date: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+    size: t.StringC;
+}>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+    __TYPE__: t.LiteralC<"FileLink">;
+}>, t.PartialC<{
+    size: t.StringC;
+}>]>>]>, t.IntersectionC<[t.ExactC<t.TypeC<{
+    __TYPE__: t.LiteralC<"DocumentLink">;
+}>>, t.ExactC<t.TypeC<{
+    id: t.Type<string, string, unknown>;
+}>>]>, t.IntersectionC<[t.ExactC<t.TypeC<{
+    __TYPE__: t.LiteralC<"ExternalLink">;
+}>>, 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;
     }, {
-        url: string;
-    } & {
-        kind?: "web";
-        target?: string | null | undefined;
-        preview?: {
+        title?: string;
+    }, unknown>, t.NullC, t.UndefinedC]>;
+}>]>>]>]>;
+export declare const LinkContent: t.ExactC<t.TypeC<{
+    __TYPE__: t.LiteralC<"LinkContent">;
+    value: t.UnionC<[t.IntersectionC<[t.ExactC<t.TypeC<{
+        __TYPE__: t.LiteralC<"ImageLink">;
+    }>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+        id: t.StringC;
+        url: t.StringC;
+        height: t.StringC;
+        width: t.StringC;
+        size: t.StringC;
+        name: t.StringC;
+        kind: t.StringC;
+    }>, t.PartialC<{
+        date: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+    }>]>>]>, t.IntersectionC<[t.ExactC<t.IntersectionC<[t.TypeC<{
+        id: t.StringC;
+        url: t.StringC;
+        name: t.StringC;
+        kind: t.StringC;
+    }>, t.PartialC<{
+        date: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+        size: t.StringC;
+    }>]>>, t.ExactC<t.IntersectionC<[t.TypeC<{
+        __TYPE__: t.LiteralC<"FileLink">;
+    }>, t.PartialC<{
+        size: t.StringC;
+    }>]>>]>, t.IntersectionC<[t.ExactC<t.TypeC<{
+        __TYPE__: t.LiteralC<"DocumentLink">;
+    }>>, t.ExactC<t.TypeC<{
+        id: t.Type<string, string, unknown>;
+    }>>]>, t.IntersectionC<[t.ExactC<t.TypeC<{
+        __TYPE__: t.LiteralC<"ExternalLink">;
+    }>>, 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;
-        } | null | undefined;
-    } & {
-        __TYPE__: "ExternalLink";
-    }, unknown>]>]>;
+        }, {
+            title?: string;
+        }, unknown>, t.NullC, t.UndefinedC]>;
+    }>]>>]>]>;
 }>>;
 export declare type LinkContent = t.TypeOf<typeof LinkContent>;
-export declare const LinkContentType = "LinkContent";
-export declare const LinksTypes: {
-    readonly DocumentLink: "DocumentLink";
-    readonly FileLink: "FileLink";
-    readonly ExternalLink: "ExternalLink";
-    readonly ImageLink: "ImageLink";
-    readonly LinkContent: "LinkContent";
-};
+export declare type LinksTypes = LinkContent["__TYPE__"] | LinkContent["value"]["__TYPE__"];

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

@@ -1,57 +1,154 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LinksTypes = exports.LinkContentType = exports.LinkContent = exports.ExternalLinkType = exports.ExternalLinkContent = exports.DocumentLinkType = exports.DocumentLinkContent = exports.FileLinkType = exports.FileLinkContent = exports.ImageLinkType = exports.ImageLinkContent = void 0;
+exports.LinkContent = exports.Link = exports.LinkContentLegacy = exports.LinkLegacy = exports.isLinkContent = exports.LinkContentType = exports.ExternalLinkContent = exports.ExternalLinkType = exports.DocumentLinkContent = exports.DocumentLinkType = exports.FileLinkContent = exports.FileLinkType = exports.ImageLinkContent = exports.ImageLinkType = void 0;
 const tslib_1 = require("tslib");
+const fp_ts_1 = require("fp-ts");
+const function_1 = require("fp-ts/lib/function");
 const t = (0, tslib_1.__importStar)(require("io-ts"));
 const io_ts_types_1 = require("io-ts-types");
-const DocumentLink_1 = require("../../../documents/widgets/nestable/Link/DocumentLink");
-const ExternalLink_1 = require("../../../documents/widgets/nestable/Link/ExternalLink");
-const FileLink_1 = require("../../../documents/widgets/nestable/Link/FileLink");
-const ImageLink_1 = require("../../../documents/widgets/nestable/Link/ImageLink");
-const LinkContent_1 = require("../../../documents/widgets/nestable/Link/LinkContent");
+const validators_1 = require("../../../validators");
+const function_2 = require("../../../validators/function");
+const utils_1 = require("../../utils");
+exports.ImageLinkType = "ImageLink";
+const imageLinkLegacyCodec = t.exact(t.intersection([
+    t.type({
+        id: t.string,
+        url: t.string,
+        height: t.string,
+        width: t.string,
+        size: t.string,
+        name: t.string,
+        kind: t.string,
+    }),
+    t.partial({
+        date: validators_1.StringOrNull,
+    }),
+]));
+const ImageLinkLegacy = new t.Type("ImageLink", (u) => (0, utils_1.hasContentType)(u) && u.__TYPE__ === exports.ImageLinkType, (image) => {
+    return (0, function_1.pipe)(imageLinkLegacyCodec.decode(image), fp_ts_1.either.map((parsedImage) => {
+        return exports.ImageLinkContent.encode({
+            ...parsedImage,
+            __TYPE__: exports.ImageLinkType,
+        });
+    }));
+}, (image) => {
+    return imageLinkLegacyCodec.encode(image);
+});
 exports.ImageLinkContent = t.intersection([
     t.strict({
-        __TYPE__: t.literal(ImageLink_1.ImageLinkType),
+        __TYPE__: t.literal(exports.ImageLinkType),
     }),
-    ImageLink_1.ImageLink,
+    imageLinkLegacyCodec,
 ]);
-exports.ImageLinkType = ImageLink_1.ImageLinkType;
-exports.FileLinkContent = t.intersection([
-    FileLink_1.FileLink,
-    t.exact(t.type({
-        __TYPE__: t.literal(FileLink_1.FileLinkType),
+exports.FileLinkType = "FileLink";
+const fileLinkLegacyCodec = t.exact(t.intersection([
+    t.type({
+        id: t.string,
+        url: t.string,
+        name: t.string,
+        kind: t.string,
+    }),
+    t.partial({
+        date: (0, function_2.nullable)(t.string),
         size: (0, io_ts_types_1.withFallback)(t.string, "0"),
-    })),
+    }),
+]));
+const FileLinkLegacy = new t.Type("FileLink", (u) => (0, utils_1.hasContentType)(u) && u.__TYPE__ === exports.FileLinkType, (file) => {
+    return (0, function_1.pipe)(fileLinkLegacyCodec.decode(file), fp_ts_1.either.map((parsedFile) => {
+        return exports.FileLinkContent.encode({
+            ...parsedFile,
+            __TYPE__: exports.FileLinkType,
+        });
+    }));
+}, (file) => {
+    return fileLinkLegacyCodec.encode(file);
+});
+exports.FileLinkContent = t.intersection([
+    fileLinkLegacyCodec,
+    t.exact(t.intersection([
+        t.type({
+            __TYPE__: t.literal(exports.FileLinkType),
+        }),
+        t.partial({
+            size: (0, io_ts_types_1.withFallback)(t.string, "0"),
+        }),
+    ])),
 ]);
-exports.FileLinkType = FileLink_1.FileLinkType;
+exports.DocumentLinkType = "DocumentLink";
+const documentLinkLegacyCodec = t.strict({ id: validators_1.NonEmptyString });
+const DocumentLinkLegacy = new t.Type("DocumentLink", (u) => (0, utils_1.hasContentType)(u) && u.__TYPE__ === exports.DocumentLinkType, (file) => {
+    return (0, function_1.pipe)(documentLinkLegacyCodec.decode(file), fp_ts_1.either.map((parsedDoc) => {
+        return exports.DocumentLinkContent.encode({
+            ...parsedDoc,
+            __TYPE__: exports.DocumentLinkType,
+        });
+    }));
+}, (doc) => {
+    return documentLinkLegacyCodec.encode(doc);
+});
 exports.DocumentLinkContent = t.intersection([
     t.strict({
-        __TYPE__: t.literal(DocumentLink_1.DocumentLinkType),
+        __TYPE__: t.literal(exports.DocumentLinkType),
     }),
-    DocumentLink_1.DocumentLink,
+    documentLinkLegacyCodec,
 ]);
-exports.DocumentLinkType = DocumentLink_1.DocumentLinkType;
+exports.ExternalLinkType = "ExternalLink";
+const externalLinkLegacyCodec = t.exact(t.intersection([
+    t.type({
+        url: t.string,
+    }),
+    t.partial({
+        kind: t.literal("web"),
+        target: validators_1.StringOrNull,
+        preview: (0, function_2.nullable)(t.partial({
+            title: t.string,
+        })),
+    }),
+]));
+const ExternalLinkLegacy = new t.Type("ExternalLink", (u) => (0, utils_1.hasContentType)(u) && u.__TYPE__ === exports.ExternalLinkType, (file) => {
+    return (0, function_1.pipe)(externalLinkLegacyCodec.decode(file), fp_ts_1.either.map((parsedLink) => {
+        return exports.ExternalLinkContent.encode({
+            ...parsedLink,
+            __TYPE__: exports.ExternalLinkType,
+        });
+    }));
+}, (link) => {
+    return externalLinkLegacyCodec.encode(link);
+});
 exports.ExternalLinkContent = t.intersection([
     t.strict({
-        __TYPE__: t.literal(ExternalLink_1.ExternalLinkType),
+        __TYPE__: t.literal(exports.ExternalLinkType),
     }),
-    ExternalLink_1.ExternalLink,
+    externalLinkLegacyCodec,
+]);
+exports.LinkContentType = "LinkContent";
+const isLinkContent = (u) => (0, utils_1.hasContentType)(u) && u.__TYPE__ === exports.LinkContentType;
+exports.isLinkContent = isLinkContent;
+exports.LinkLegacy = t.union([
+    ImageLinkLegacy,
+    FileLinkLegacy,
+    DocumentLinkLegacy,
+    ExternalLinkLegacy,
+]);
+const LinkContentLegacy = (ctx) => new t.Type("LinkLegacy", exports.isLinkContent, (u) => {
+    return (0, function_1.pipe)(exports.LinkLegacy.decode(u), fp_ts_1.either.map((link) => exports.LinkContent.encode({
+        value: link,
+        __TYPE__: exports.LinkContentType,
+    })));
+}, (link) => {
+    return {
+        content: exports.LinkLegacy.encode(link.value),
+        types: { [ctx.keyOfType]: "Link" },
+    };
+});
+exports.LinkContentLegacy = LinkContentLegacy;
+exports.Link = t.union([
+    exports.ImageLinkContent,
+    exports.FileLinkContent,
+    exports.DocumentLinkContent,
+    exports.ExternalLinkContent,
 ]);
-exports.ExternalLinkType = ExternalLink_1.ExternalLinkType;
 exports.LinkContent = t.strict({
-    __TYPE__: t.literal(LinkContent_1.LinkContentType),
-    value: t.union([
-        exports.ImageLinkContent,
-        exports.FileLinkContent,
-        exports.DocumentLinkContent,
-        exports.ExternalLinkContent,
-    ]),
+    __TYPE__: t.literal(exports.LinkContentType),
+    value: exports.Link,
 });
-exports.LinkContentType = LinkContent_1.LinkContentType;
-exports.LinksTypes = {
-    DocumentLink: exports.DocumentLinkType,
-    FileLink: exports.FileLinkType,
-    ExternalLink: exports.ExternalLinkType,
-    ImageLink: exports.ImageLinkType,
-    LinkContent: exports.LinkContentType,
-};