@prismicio/types-internal 2.2.0-traverse.alpha-6 → 2.2.0-traverse.alpha-7

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Block = exports.BlockLegacy = exports.TextBlock = exports.checkEmbedBlock = exports.EmbedBlock = exports.checkImageBlock = exports.ImageBlock = exports.ValidatedMetas = exports.Span = exports.Meta = void 0;
+exports.Block = exports.BlockLegacy = exports.TextBlock = exports.checkEmbedBlock = exports.EmbedBlock = exports.checkImageBlock = exports.ImageBlock = exports.ValidatedSpans = exports.SpanLegacy = exports.Span = void 0;
 const tslib_1 = require("tslib");
 const fp_ts_1 = require("fp-ts");
 const Either_1 = require("fp-ts/lib/Either");
@@ -12,9 +12,9 @@ const function_2 = require("../../../../validators/function");
 const EmbedContent_1 = require("../EmbedContent");
 const ImageContent_1 = require("../ImageContent");
 const LinkContent_1 = require("../LinkContent");
-exports.Meta = t.exact(t.intersection([
+const SpanFn = (linkCodec) => t.exact(t.intersection([
     t.partial({
-        data: t.unknown,
+        data: linkCodec,
     }),
     t.type({
         start: t.number,
@@ -22,46 +22,28 @@ exports.Meta = t.exact(t.intersection([
         type: t.union([nestable_1.RichTextNodeTypeCodec, t.literal("label")]),
     }),
 ]));
-// export alias for code clarity
-exports.Span = exports.Meta;
-const ValidatedMetas = (linkCodec) => new t.Type("ValidatedMetas", (metas) => Array.isArray(metas) && metas.every(exports.Meta.is), (metas, c) => {
-    if (Array.isArray(metas)) {
-        const res = metas
-            .reduce((acc, maybeMeta) => {
-            const maybeDecodedMeta = exports.Meta.decode(maybeMeta);
-            if ((0, Either_1.isRight)(maybeDecodedMeta)) {
-                const meta = maybeDecodedMeta.right;
-                // if it's an hyperlink it should have data validated as link otherwise we don't care and keep the meta
-                if (meta.data && meta.type === "hyperlink") {
-                    const decoded = linkCodec.decode(meta.data);
-                    if ((0, Either_1.isLeft)(decoded))
-                        return acc;
-                    return [...acc, { ...meta, data: decoded.right }];
-                }
-                else if (meta.type !== "hyperlink") {
-                    return [...acc, meta];
-                }
-            }
-            return acc;
-        }, [])
-            .sort((m1, m2) => m1.start - m2.start);
-        return t.success(res);
-    }
-    else
-        return t.failure(metas, c);
-}, (m) => {
-    return m.reduce((acc, meta) => {
-        if (meta.type === "hyperlink" && meta.data) {
-            // since the Span data are typed as unknown we have to redecode for type safety and then encode to either new format or legacy.
-            const decoded = linkCodec.decode(meta.data);
-            if ((0, Either_1.isLeft)(decoded))
-                return acc;
-            return [...acc, { ...meta, data: linkCodec.encode(decoded.right) }];
+exports.Span = SpanFn(LinkContent_1.Link);
+exports.SpanLegacy = SpanFn(LinkContent_1.LinkLegacy);
+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);
+                return (0, Either_1.isRight)(decodedSpan) ? [...acc, decodedSpan.right] : acc;
+            }, [])
+                .sort((m1, m2) => m1.start - m2.start);
+            return t.success(res);
         }
-        return [...acc, exports.Meta.encode(meta)];
-    }, []);
-});
-exports.ValidatedMetas = ValidatedMetas;
+        else
+            return t.failure(spans, c);
+    }, (m) => {
+        return m.reduce((acc, meta) => {
+            return [...acc, spanCodec.encode(meta)];
+        }, []);
+    });
+};
+exports.ValidatedSpans = ValidatedSpans;
 const ImageBlockCodec = (linkCodec) => t.exact(t.intersection([
     t.type({
         type: t.literal(nestable_1.RichTextNodeType.image),
@@ -126,7 +108,7 @@ function checkEmbedBlock(block) {
     return block.type === nestable_1.RichTextNodeType.embed;
 }
 exports.checkEmbedBlock = checkEmbedBlock;
-const TextBlockCodec = (linkCodec) => t.exact(t.intersection([
+const TextBlockCodec = (spanCodec) => t.exact(t.intersection([
     t.type({
         type: (0, function_2.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([
@@ -134,7 +116,7 @@ const TextBlockCodec = (linkCodec) => t.exact(t.intersection([
                 text: t.string,
             }),
             t.partial({
-                spans: (0, exports.ValidatedMetas)(linkCodec),
+                spans: (0, exports.ValidatedSpans)(spanCodec),
             }),
         ]),
     }),
@@ -143,8 +125,9 @@ const TextBlockCodec = (linkCodec) => t.exact(t.intersection([
         direction: t.string,
     }),
 ]));
-exports.TextBlock = TextBlockCodec(LinkContent_1.Link);
-const TextBlockLegacy = TextBlockCodec(LinkContent_1.LinkLegacy);
+/* These Text block will decode codec A and encode from codec B to A */
+exports.TextBlock = TextBlockCodec(exports.Span);
+const TextBlockLegacy = TextBlockCodec(exports.SpanLegacy);
 const legacyBlockCodec = t.union([
     EmbedBlockLegacy,
     ImageBlockLegacy,

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

@@ -101,7 +101,45 @@ export declare const isRichTextContent: (u: unknown) => u is {
             text: string;
         } & {
             spans?: ({
-                data?: unknown;
+                data?: ({
+                    __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;
+                    size: string;
+                } & {
+                    date?: string | null | undefined;
+                } & {
+                    __TYPE__: "FileLink";
+                } & {
+                    size?: string;
+                }) | ({
+                    __TYPE__: "DocumentLink";
+                } & {
+                    id: string;
+                }) | ({
+                    __TYPE__: "ExternalLink";
+                } & {
+                    url: string;
+                } & {
+                    kind?: "web";
+                    target?: string | null | undefined;
+                    preview?: {
+                        title?: string;
+                    } | null | undefined;
+                });
             } & {
                 start: number;
                 end: number;
@@ -241,13 +279,89 @@ export declare const RichTextContent: t.ExactC<t.TypeC<{
             text: t.StringC;
         }>, t.PartialC<{
             spans: t.Type<({
-                data?: unknown;
+                data?: ({
+                    __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;
+                    size: string;
+                } & {
+                    date?: string | null | undefined;
+                } & {
+                    __TYPE__: "FileLink";
+                } & {
+                    size?: string;
+                }) | ({
+                    __TYPE__: "DocumentLink";
+                } & {
+                    id: string;
+                }) | ({
+                    __TYPE__: "ExternalLink";
+                } & {
+                    url: string;
+                } & {
+                    kind?: "web";
+                    target?: string | null | undefined;
+                    preview?: {
+                        title?: string;
+                    } | null | undefined;
+                });
             } & {
                 start: number;
                 end: number;
                 type: "image" | "label" | "paragraph" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "strong" | "em" | "preformatted" | "hyperlink" | "embed" | "list-item" | "o-list-item" | "rtl";
             })[], ({
-                data?: unknown;
+                data?: ({
+                    __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;
+                    size: string;
+                } & {
+                    date?: string | null | undefined;
+                } & {
+                    __TYPE__: "FileLink";
+                } & {
+                    size?: string;
+                }) | ({
+                    __TYPE__: "DocumentLink";
+                } & {
+                    id: string;
+                }) | ({
+                    __TYPE__: "ExternalLink";
+                } & {
+                    url: string;
+                } & {
+                    kind?: "web";
+                    target?: string | null | undefined;
+                    preview?: {
+                        title?: string;
+                    } | null | undefined;
+                });
             } & {
                 start: number;
                 end: number;
@@ -361,7 +475,45 @@ export declare const RichTextLegacy: (ctx: LegacyContentCtx) => t.Type<{
             text: string;
         } & {
             spans?: ({
-                data?: unknown;
+                data?: ({
+                    __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;
+                    size: string;
+                } & {
+                    date?: string | null | undefined;
+                } & {
+                    __TYPE__: "FileLink";
+                } & {
+                    size?: string;
+                }) | ({
+                    __TYPE__: "DocumentLink";
+                } & {
+                    id: string;
+                }) | ({
+                    __TYPE__: "ExternalLink";
+                } & {
+                    url: string;
+                } & {
+                    kind?: "web";
+                    target?: string | null | undefined;
+                    preview?: {
+                        title?: string;
+                    } | null | undefined;
+                });
             } & {
                 start: number;
                 end: number;
@@ -470,7 +622,45 @@ export declare const RichTextLegacy: (ctx: LegacyContentCtx) => t.Type<{
         text: string;
     } & {
         spans?: ({
-            data?: unknown;
+            data?: ({
+                __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;
+                size: string;
+            } & {
+                date?: string | null | undefined;
+            } & {
+                __TYPE__: "FileLink";
+            } & {
+                size?: string;
+            }) | ({
+                __TYPE__: "DocumentLink";
+            } & {
+                id: string;
+            }) | ({
+                __TYPE__: "ExternalLink";
+            } & {
+                url: string;
+            } & {
+                kind?: "web";
+                target?: string | null | undefined;
+                preview?: {
+                    title?: string;
+                } | null | undefined;
+            });
         } & {
             start: number;
             end: number;