@prismicio/types-internal 2.3.1 → 2.4.0-alpha.0

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

@@ -4,6 +4,68 @@ export declare const RichTextContentType = "StructuredTextContent";
 export declare const isRichTextContent: (u: unknown) => u is {
     __TYPE__: "StructuredTextContent";
     value: (({
+        type: "image" | "paragraph" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "strong" | "em" | "preformatted" | "hyperlink" | "embed" | "list-item" | "o-list-item" | "rtl";
+        content: {
+            text: string;
+        } & {
+            spans?: ({
+                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: "hyperlink";
+            } | {
+                data: string;
+                start: number;
+                end: number;
+                type: "label";
+            } | {
+                start: number;
+                end: number;
+                type: "strong" | "em" | "list-item";
+            })[];
+        };
+    } & {
+        label?: string;
+        direction?: string;
+    }) | ({
         type: "image";
         data: {
             origin: {
@@ -27,6 +89,69 @@ export declare const isRichTextContent: (u: unknown) => u is {
             credits?: string | null;
             alt?: string | null;
             provider?: string | null | undefined;
+            caption?: ({
+                type: "image" | "paragraph" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "strong" | "em" | "preformatted" | "hyperlink" | "embed" | "list-item" | "o-list-item" | "rtl";
+                content: {
+                    text: string;
+                } & {
+                    spans?: ({
+                        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: "hyperlink";
+                    } | {
+                        data: string;
+                        start: number;
+                        end: number;
+                        type: "label";
+                    } | {
+                        start: number;
+                        end: number;
+                        type: "strong" | "em" | "list-item";
+                    })[];
+                };
+            } & {
+                label?: string;
+                direction?: string;
+            })[];
         } & {
             linkTo?: ({
                 __TYPE__: "ImageLink";
@@ -95,68 +220,6 @@ export declare const isRichTextContent: (u: unknown) => u is {
     } & {
         label?: string | null | undefined;
         direction?: string | null | undefined;
-    }) | ({
-        type: "image" | "paragraph" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "strong" | "em" | "preformatted" | "hyperlink" | "embed" | "list-item" | "o-list-item" | "rtl";
-        content: {
-            text: string;
-        } & {
-            spans?: ({
-                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: "hyperlink";
-            } | {
-                data: string;
-                start: number;
-                end: number;
-                type: "label";
-            } | {
-                start: number;
-                end: number;
-                type: "strong" | "em" | "list-item";
-            })[];
-        };
-    } & {
-        label?: string;
-        direction?: string;
     }))[];
 };
 export declare const RichTextContent: t.ExactC<t.TypeC<{
@@ -185,6 +248,121 @@ export declare const RichTextContent: t.ExactC<t.TypeC<{
             credits: t.Type<string | null, string | null, unknown>;
             alt: t.Type<string | null, string | null, unknown>;
             provider: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
+            caption: t.ArrayC<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", "image" | "paragraph" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "strong" | "em" | "preformatted" | "hyperlink" | "embed" | "list-item" | "o-list-item" | "rtl", unknown>;
+                content: t.IntersectionC<[t.TypeC<{
+                    text: t.StringC;
+                }>, t.PartialC<{
+                    spans: t.Type<({
+                        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: "hyperlink";
+                    } | {
+                        data: string;
+                        start: number;
+                        end: number;
+                        type: "label";
+                    } | {
+                        start: number;
+                        end: number;
+                        type: "strong" | "em" | "list-item";
+                    })[], ({
+                        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: "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;
+            }>]>>>;
         }>]>>, t.PartialC<{
             linkTo: t.UnionC<[t.Type<({
                 __TYPE__: "ImageLink";
@@ -399,9 +577,72 @@ export declare const RichTextContent: t.ExactC<t.TypeC<{
 }>>;
 export declare type RichTextContent = t.TypeOf<typeof RichTextContent>;
 export * from "./Blocks";
+export * from "./TextBlock";
 export declare const RichTextLegacy: (ctx: LegacyContentCtx) => t.Type<{
     __TYPE__: "StructuredTextContent";
     value: (({
+        type: "image" | "paragraph" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "strong" | "em" | "preformatted" | "hyperlink" | "embed" | "list-item" | "o-list-item" | "rtl";
+        content: {
+            text: string;
+        } & {
+            spans?: ({
+                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: "hyperlink";
+            } | {
+                data: string;
+                start: number;
+                end: number;
+                type: "label";
+            } | {
+                start: number;
+                end: number;
+                type: "strong" | "em" | "list-item";
+            })[];
+        };
+    } & {
+        label?: string;
+        direction?: string;
+    }) | ({
         type: "image";
         data: {
             origin: {
@@ -425,6 +666,69 @@ export declare const RichTextLegacy: (ctx: LegacyContentCtx) => t.Type<{
             credits?: string | null;
             alt?: string | null;
             provider?: string | null | undefined;
+            caption?: ({
+                type: "image" | "paragraph" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "strong" | "em" | "preformatted" | "hyperlink" | "embed" | "list-item" | "o-list-item" | "rtl";
+                content: {
+                    text: string;
+                } & {
+                    spans?: ({
+                        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: "hyperlink";
+                    } | {
+                        data: string;
+                        start: number;
+                        end: number;
+                        type: "label";
+                    } | {
+                        start: number;
+                        end: number;
+                        type: "strong" | "em" | "list-item";
+                    })[];
+                };
+            } & {
+                label?: string;
+                direction?: string;
+            })[];
         } & {
             linkTo?: ({
                 __TYPE__: "ImageLink";
@@ -493,70 +797,70 @@ export declare const RichTextLegacy: (ctx: LegacyContentCtx) => t.Type<{
     } & {
         label?: string | null | undefined;
         direction?: string | null | undefined;
-    }) | ({
-        type: "image" | "paragraph" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "strong" | "em" | "preformatted" | "hyperlink" | "embed" | "list-item" | "o-list-item" | "rtl";
-        content: {
-            text: string;
-        } & {
-            spans?: ({
-                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: "hyperlink";
-            } | {
-                data: string;
-                start: number;
-                end: number;
-                type: "label";
-            } | {
-                start: number;
-                end: number;
-                type: "strong" | "em" | "list-item";
-            })[];
-        };
-    } & {
-        label?: string;
-        direction?: string;
     }))[];
 }, WithTypes<(({
+    type: "image" | "paragraph" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "strong" | "em" | "preformatted" | "hyperlink" | "embed" | "list-item" | "o-list-item" | "rtl";
+    content: {
+        text: string;
+    } & {
+        spans?: ({
+            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: "hyperlink";
+        } | {
+            data: string;
+            start: number;
+            end: number;
+            type: "label";
+        } | {
+            start: number;
+            end: number;
+            type: "strong" | "em" | "list-item";
+        })[];
+    };
+} & {
+    label?: string;
+    direction?: string;
+}) | ({
     type: "image";
     data: {
         origin: {
@@ -580,6 +884,69 @@ export declare const RichTextLegacy: (ctx: LegacyContentCtx) => t.Type<{
         credits?: string | null;
         alt?: string | null;
         provider?: string | null | undefined;
+        caption?: ({
+            type: "image" | "paragraph" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "strong" | "em" | "preformatted" | "hyperlink" | "embed" | "list-item" | "o-list-item" | "rtl";
+            content: {
+                text: string;
+            } & {
+                spans?: ({
+                    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: "hyperlink";
+                } | {
+                    data: string;
+                    start: number;
+                    end: number;
+                    type: "label";
+                } | {
+                    start: number;
+                    end: number;
+                    type: "strong" | "em" | "list-item";
+                })[];
+            };
+        } & {
+            label?: string;
+            direction?: string;
+        })[];
     } & {
         linkTo?: ({
             __TYPE__: "ImageLink";
@@ -648,66 +1015,4 @@ export declare const RichTextLegacy: (ctx: LegacyContentCtx) => t.Type<{
 } & {
     label?: string | null | undefined;
     direction?: string | null | undefined;
-}) | ({
-    type: "image" | "paragraph" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "strong" | "em" | "preformatted" | "hyperlink" | "embed" | "list-item" | "o-list-item" | "rtl";
-    content: {
-        text: string;
-    } & {
-        spans?: ({
-            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: "hyperlink";
-        } | {
-            data: string;
-            start: number;
-            end: number;
-            type: "label";
-        } | {
-            start: number;
-            end: number;
-            type: "strong" | "em" | "list-item";
-        })[];
-    };
-} & {
-    label?: string;
-    direction?: string;
 }))[]>, unknown>;