@prismicio/types-internal 3.4.0-alpha.2 → 3.4.0-alpha.4

package/lib/content/fields/nestable/RichTextContent/TextBlock.d.ts

@@ -0,0 +1,590 @@
+import * as t from "io-ts";
+export declare const Span: t.UnionC<[t.ExactC<t.TypeC<{
+    data: t.UnionC<[t.IntersectionC<[t.ExactC<t.TypeC<{
+        __TYPE__: t.LiteralC<"ImageLink">;
+    }>>, 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.IntersectionC<[t.ExactC<t.TypeC<{
+        __TYPE__: t.LiteralC<"FileLink">;
+    }>>, 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.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;
+        }, {
+            title?: string;
+        }, unknown>, t.NullC, t.UndefinedC]>;
+    }>]>>]>]> | t.UnionC<[t.Type<{
+        __TYPE__: "ImageLink";
+    } & {
+        kind: "image";
+        id: string;
+        url: string;
+        height: string;
+        width: string;
+        size: string;
+        name: string;
+    } & {
+        date?: string | null | undefined;
+    }, {
+        kind: "image";
+        id: string;
+        url: string;
+        height: string;
+        width: string;
+        size: string;
+        name: string;
+    } & {
+        date?: string | null | undefined;
+    }, unknown>, t.Type<{
+        __TYPE__: "FileLink";
+    } & {
+        kind: "file";
+        id: string;
+        url: string;
+        name: string;
+        size: string;
+    } & {
+        date?: string | null | undefined;
+    }, {
+        kind: "file";
+        id: string;
+        url: string;
+        name: string;
+        size: string;
+    } & {
+        date?: string | null | undefined;
+    }, unknown>, t.Type<{
+        __TYPE__: "DocumentLink";
+    } & {
+        id: string;
+    }, {
+        id: string;
+    }, unknown>, t.Type<{
+        __TYPE__: "ExternalLink";
+    } & {
+        url: string;
+    } & {
+        kind?: "web";
+        target?: string | null | undefined;
+        preview?: {
+            title?: string;
+        } | null | undefined;
+    }, {
+        url: string;
+    } & {
+        kind?: "web";
+        target?: string | null | undefined;
+        preview?: {
+            title?: string;
+        } | null | undefined;
+    }, unknown>]>;
+    start: t.NumberC;
+    end: t.NumberC;
+    type: t.LiteralC<"hyperlink">;
+}>>, t.ExactC<t.TypeC<{
+    data: t.StringC;
+    start: t.NumberC;
+    end: t.NumberC;
+    type: t.LiteralC<"label">;
+}>>, t.ExactC<t.TypeC<{
+    start: t.NumberC;
+    end: t.NumberC;
+    type: t.KeyofC<{
+        strong: null;
+        em: null;
+        "list-item": null;
+    }>;
+}>>]>;
+export declare type Span = t.TypeOf<typeof Span>;
+export declare const SpanLegacy: t.UnionC<[t.ExactC<t.TypeC<{
+    data: t.UnionC<[t.IntersectionC<[t.ExactC<t.TypeC<{
+        __TYPE__: t.LiteralC<"ImageLink">;
+    }>>, 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.IntersectionC<[t.ExactC<t.TypeC<{
+        __TYPE__: t.LiteralC<"FileLink">;
+    }>>, 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.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;
+        }, {
+            title?: string;
+        }, unknown>, t.NullC, t.UndefinedC]>;
+    }>]>>]>]> | t.UnionC<[t.Type<{
+        __TYPE__: "ImageLink";
+    } & {
+        kind: "image";
+        id: string;
+        url: string;
+        height: string;
+        width: string;
+        size: string;
+        name: string;
+    } & {
+        date?: string | null | undefined;
+    }, {
+        kind: "image";
+        id: string;
+        url: string;
+        height: string;
+        width: string;
+        size: string;
+        name: string;
+    } & {
+        date?: string | null | undefined;
+    }, unknown>, t.Type<{
+        __TYPE__: "FileLink";
+    } & {
+        kind: "file";
+        id: string;
+        url: string;
+        name: string;
+        size: string;
+    } & {
+        date?: string | null | undefined;
+    }, {
+        kind: "file";
+        id: string;
+        url: string;
+        name: string;
+        size: string;
+    } & {
+        date?: string | null | undefined;
+    }, unknown>, t.Type<{
+        __TYPE__: "DocumentLink";
+    } & {
+        id: string;
+    }, {
+        id: string;
+    }, unknown>, t.Type<{
+        __TYPE__: "ExternalLink";
+    } & {
+        url: string;
+    } & {
+        kind?: "web";
+        target?: string | null | undefined;
+        preview?: {
+            title?: string;
+        } | null | undefined;
+    }, {
+        url: string;
+    } & {
+        kind?: "web";
+        target?: string | null | undefined;
+        preview?: {
+            title?: string;
+        } | null | undefined;
+    }, unknown>]>;
+    start: t.NumberC;
+    end: t.NumberC;
+    type: t.LiteralC<"hyperlink">;
+}>>, t.ExactC<t.TypeC<{
+    data: t.StringC;
+    start: t.NumberC;
+    end: t.NumberC;
+    type: t.LiteralC<"label">;
+}>>, t.ExactC<t.TypeC<{
+    start: t.NumberC;
+    end: t.NumberC;
+    type: t.KeyofC<{
+        strong: null;
+        em: null;
+        "list-item": null;
+    }>;
+}>>]>;
+export declare type SpanLegacy = t.TypeOf<typeof SpanLegacy>;
+export declare const ValidatedSpans: <C extends t.UnionC<[t.ExactC<t.TypeC<{
+    data: t.UnionC<[t.IntersectionC<[t.ExactC<t.TypeC<{
+        __TYPE__: t.LiteralC<"ImageLink">;
+    }>>, 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.IntersectionC<[t.ExactC<t.TypeC<{
+        __TYPE__: t.LiteralC<"FileLink">;
+    }>>, 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.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;
+        }, {
+            title?: string;
+        }, unknown>, t.NullC, t.UndefinedC]>;
+    }>]>>]>]> | t.UnionC<[t.Type<{
+        __TYPE__: "ImageLink";
+    } & {
+        kind: "image";
+        id: string;
+        url: string;
+        height: string;
+        width: string;
+        size: string;
+        name: string;
+    } & {
+        date?: string | null | undefined;
+    }, {
+        kind: "image";
+        id: string;
+        url: string;
+        height: string;
+        width: string;
+        size: string;
+        name: string;
+    } & {
+        date?: string | null | undefined;
+    }, unknown>, t.Type<{
+        __TYPE__: "FileLink";
+    } & {
+        kind: "file";
+        id: string;
+        url: string;
+        name: string;
+        size: string;
+    } & {
+        date?: string | null | undefined;
+    }, {
+        kind: "file";
+        id: string;
+        url: string;
+        name: string;
+        size: string;
+    } & {
+        date?: string | null | undefined;
+    }, unknown>, t.Type<{
+        __TYPE__: "DocumentLink";
+    } & {
+        id: string;
+    }, {
+        id: string;
+    }, unknown>, t.Type<{
+        __TYPE__: "ExternalLink";
+    } & {
+        url: string;
+    } & {
+        kind?: "web";
+        target?: string | null | undefined;
+        preview?: {
+            title?: string;
+        } | null | undefined;
+    }, {
+        url: string;
+    } & {
+        kind?: "web";
+        target?: string | null | undefined;
+        preview?: {
+            title?: string;
+        } | null | undefined;
+    }, unknown>]>;
+    start: t.NumberC;
+    end: t.NumberC;
+    type: t.LiteralC<"hyperlink">;
+}>>, t.ExactC<t.TypeC<{
+    data: t.StringC;
+    start: t.NumberC;
+    end: t.NumberC;
+    type: t.LiteralC<"label">;
+}>>, t.ExactC<t.TypeC<{
+    start: t.NumberC;
+    end: t.NumberC;
+    type: t.KeyofC<{
+        strong: null;
+        em: null;
+        "list-item": null;
+    }>;
+}>>]>>(spanCodec: C) => t.Type<t.TypeOf<C>[], t.TypeOf<C>[], unknown>;
+export declare const TextBlock: t.ExactC<t.IntersectionC<[t.TypeC<{
+    type: t.Type<"image" | "paragraph" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "strong" | "em" | "preformatted" | "hyperlink" | "embed" | "list-item" | "o-list-item" | "rtl" | "table", "image" | "paragraph" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "strong" | "em" | "preformatted" | "hyperlink" | "embed" | "list-item" | "o-list-item" | "rtl" | "table", unknown>;
+    content: t.IntersectionC<[t.TypeC<{
+        text: t.StringC;
+    }>, t.PartialC<{
+        spans: t.Type<({
+            data: ({
+                __TYPE__: "ImageLink";
+            } & {
+                kind: "image";
+                id: string;
+                url: string;
+                height: string;
+                width: string;
+                size: string;
+                name: string;
+            } & {
+                date?: string | null | undefined;
+            }) | ({
+                __TYPE__: "FileLink";
+            } & {
+                kind: "file";
+                id: string;
+                url: string;
+                name: string;
+                size: string;
+            } & {
+                date?: string | null | undefined;
+            }) | ({
+                __TYPE__: "DocumentLink";
+            } & {
+                id: string;
+            }) | ({
+                __TYPE__: "ExternalLink";
+            } & {
+                url: string;
+            } & {
+                kind?: "web";
+                target?: string | null | undefined;
+                preview?: {
+                    title?: string;
+                } | null | undefined;
+            });
+            start: number;
+            end: number;
+            type: "hyperlink";
+        } | {
+            data: string;
+            start: number;
+            end: number;
+            type: "label";
+        } | {
+            start: number;
+            end: number;
+            type: "strong" | "em" | "list-item";
+        })[], ({
+            data: ({
+                __TYPE__: "ImageLink";
+            } & {
+                kind: "image";
+                id: string;
+                url: string;
+                height: string;
+                width: string;
+                size: string;
+                name: string;
+            } & {
+                date?: string | null | undefined;
+            }) | ({
+                __TYPE__: "FileLink";
+            } & {
+                kind: "file";
+                id: string;
+                url: string;
+                name: string;
+                size: string;
+            } & {
+                date?: string | null | undefined;
+            }) | ({
+                __TYPE__: "DocumentLink";
+            } & {
+                id: string;
+            }) | ({
+                __TYPE__: "ExternalLink";
+            } & {
+                url: string;
+            } & {
+                kind?: "web";
+                target?: string | null | undefined;
+                preview?: {
+                    title?: string;
+                } | null | undefined;
+            });
+            start: number;
+            end: number;
+            type: "hyperlink";
+        } | {
+            data: string;
+            start: number;
+            end: number;
+            type: "label";
+        } | {
+            start: number;
+            end: number;
+            type: "strong" | "em" | "list-item";
+        })[], unknown>;
+    }>]>;
+}>, t.PartialC<{
+    label: t.StringC;
+    direction: t.StringC;
+}>]>>;
+export declare type TextBlock = t.TypeOf<typeof TextBlock>;
+export declare const TextBlockLegacy: t.ExactC<t.IntersectionC<[t.TypeC<{
+    type: t.Type<"image" | "paragraph" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "strong" | "em" | "preformatted" | "hyperlink" | "embed" | "list-item" | "o-list-item" | "rtl" | "table", "image" | "paragraph" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "strong" | "em" | "preformatted" | "hyperlink" | "embed" | "list-item" | "o-list-item" | "rtl" | "table", unknown>;
+    content: t.IntersectionC<[t.TypeC<{
+        text: t.StringC;
+    }>, t.PartialC<{
+        spans: t.Type<({
+            data: ({
+                __TYPE__: "ImageLink";
+            } & {
+                kind: "image";
+                id: string;
+                url: string;
+                height: string;
+                width: string;
+                size: string;
+                name: string;
+            } & {
+                date?: string | null | undefined;
+            }) | ({
+                __TYPE__: "FileLink";
+            } & {
+                kind: "file";
+                id: string;
+                url: string;
+                name: string;
+                size: string;
+            } & {
+                date?: string | null | undefined;
+            }) | ({
+                __TYPE__: "DocumentLink";
+            } & {
+                id: string;
+            }) | ({
+                __TYPE__: "ExternalLink";
+            } & {
+                url: string;
+            } & {
+                kind?: "web";
+                target?: string | null | undefined;
+                preview?: {
+                    title?: string;
+                } | null | undefined;
+            });
+            start: number;
+            end: number;
+            type: "hyperlink";
+        } | {
+            data: string;
+            start: number;
+            end: number;
+            type: "label";
+        } | {
+            start: number;
+            end: number;
+            type: "strong" | "em" | "list-item";
+        })[], ({
+            data: ({
+                __TYPE__: "ImageLink";
+            } & {
+                kind: "image";
+                id: string;
+                url: string;
+                height: string;
+                width: string;
+                size: string;
+                name: string;
+            } & {
+                date?: string | null | undefined;
+            }) | ({
+                __TYPE__: "FileLink";
+            } & {
+                kind: "file";
+                id: string;
+                url: string;
+                name: string;
+                size: string;
+            } & {
+                date?: string | null | undefined;
+            }) | ({
+                __TYPE__: "DocumentLink";
+            } & {
+                id: string;
+            }) | ({
+                __TYPE__: "ExternalLink";
+            } & {
+                url: string;
+            } & {
+                kind?: "web";
+                target?: string | null | undefined;
+                preview?: {
+                    title?: string;
+                } | null | undefined;
+            });
+            start: number;
+            end: number;
+            type: "hyperlink";
+        } | {
+            data: string;
+            start: number;
+            end: number;
+            type: "label";
+        } | {
+            start: number;
+            end: number;
+            type: "strong" | "em" | "list-item";
+        })[], unknown>;
+    }>]>;
+}>, t.PartialC<{
+    label: t.StringC;
+    direction: t.StringC;
+}>]>>;
+export declare type TextBlockLegacy = t.TypeOf<typeof TextBlockLegacy>;

package/lib/content/fields/nestable/RichTextContent/TextBlock.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TextBlockLegacy = exports.TextBlock = exports.ValidatedSpans = exports.SpanLegacy = exports.Span = void 0;
+const tslib_1 = require("tslib");
+const Either_1 = require("fp-ts/lib/Either");
+const t = (0, tslib_1.__importStar)(require("io-ts"));
+const io_ts_types_1 = require("io-ts-types");
+const nestable_1 = require("../../../../customtypes/widgets/nestable");
+const function_1 = require("../../../../validators/function");
+const LinkContent_1 = require("../LinkContent");
+const linkSpan = (linkCodec) => t.strict({
+    data: linkCodec,
+    start: t.number,
+    end: t.number,
+    type: t.literal(nestable_1.RichTextNodeType.hyperlink),
+});
+const labelSpan = t.strict({
+    data: (0, io_ts_types_1.withFallback)(t.string, ""),
+    start: t.number,
+    end: t.number,
+    type: t.literal("label"),
+});
+const basicSpan = t.strict({
+    start: t.number,
+    end: t.number,
+    type: t.keyof({
+        [nestable_1.RichTextNodeType.strong]: null,
+        [nestable_1.RichTextNodeType.em]: null,
+        "list-item": null, // legacy case that should not happen, we shouldn't support this in new page builder or migration API
+    }),
+});
+exports.Span = t.union([linkSpan(LinkContent_1.FilledLink), labelSpan, basicSpan]);
+exports.SpanLegacy = t.union([
+    linkSpan(LinkContent_1.FilledLinkLegacy),
+    labelSpan,
+    basicSpan,
+]);
+const ValidatedSpans = (spanCodec) => {
+    return new t.Type("ValidatedSpans", (spans) => Array.isArray(spans) && spans.every(spanCodec.is), (spans, c) => {
+        if (Array.isArray(spans)) {
+            const res = spans
+                .reduce((acc, maybeSpan) => {
+                const decodedSpan = spanCodec.decode(maybeSpan);
+                if ((0, Either_1.isLeft)(decodedSpan))
+                    return acc;
+                return [...acc, decodedSpan.right];
+            }, [])
+                .sort((m1, m2) => m1.start - m2.start);
+            return t.success(res);
+        }
+        else
+            return t.failure(spans, c);
+    }, (m) => {
+        return m.reduce((acc, meta) => {
+            const encoded = spanCodec.encode(meta);
+            return [...acc, encoded];
+        }, []);
+    });
+};
+exports.ValidatedSpans = ValidatedSpans;
+const TextBlockCodec = (spanCodec) => t.exact(t.intersection([
+    t.type({
+        type: (0, function_1.refineType)(nestable_1.RichTextNodeTypeCodec, `string which isn't ${nestable_1.RichTextNodeType.image} ${nestable_1.RichTextNodeType.embed}`, (s) => s !== nestable_1.RichTextNodeType.image && s !== nestable_1.RichTextNodeType.embed),
+        content: t.intersection([
+            t.type({
+                text: t.string,
+            }),
+            t.partial({
+                spans: (0, exports.ValidatedSpans)(spanCodec),
+            }),
+        ]),
+    }),
+    t.partial({
+        label: t.string,
+        direction: t.string,
+    }),
+]));
+/* These Text block will decode codec A and encode from codec B to A */
+exports.TextBlock = TextBlockCodec(exports.Span);
+exports.TextBlockLegacy = TextBlockCodec(exports.SpanLegacy);