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

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

@@ -23,6 +23,69 @@ export declare const isImageContent: (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;
+    })[];
 } & {
     thumbnails?: {
         [x: string]: {
@@ -47,6 +110,69 @@ export declare const isImageContent: (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;
+            })[];
         };
     };
 } & {
@@ -74,6 +200,121 @@ export declare const ImageContentView: t.ExactC<t.IntersectionC<[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;
+    }>]>>>;
 }>]>>;
 export declare type ImageContentView = t.TypeOf<typeof ImageContentView>;
 export declare const ImageLegacy: (ctx: LegacyContentCtx) => t.Type<{
@@ -98,6 +339,69 @@ export declare const ImageLegacy: (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;
+    })[];
 } & {
     thumbnails?: {
         [x: string]: {
@@ -122,6 +426,69 @@ export declare const ImageLegacy: (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;
+            })[];
         };
     };
 } & {
@@ -148,6 +515,69 @@ export declare const ImageLegacy: (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;
+    })[];
 } & {
     thumbnails?: {
         [x: string]: {
@@ -172,6 +602,69 @@ export declare const ImageLegacy: (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;
+            })[];
         };
     };
 }>, unknown>;
@@ -197,6 +690,121 @@ export declare const ImageContent: t.IntersectionC<[t.IntersectionC<[t.ExactC<t.
     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<{
     thumbnails: t.RecordC<t.StringC, t.ExactC<t.IntersectionC<[t.TypeC<{
         origin: t.ExactC<t.TypeC<{
@@ -220,6 +828,121 @@ export declare const ImageContent: t.IntersectionC<[t.IntersectionC<[t.ExactC<t.
         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.ExactC<t.TypeC<{
     __TYPE__: t.LiteralC<"ImageContent">;