@contensis/canvas-react 1.0.0

package/dist/canvas-react.d.ts

@@ -0,0 +1,480 @@
+import * as react from 'react';
+
+type InlineBlock = FragmentBlock | AnchorBlock | LinkBlock | InlineEntryBlock;
+type InlineChildren = string | InlineBlock[];
+type DecoratorTypeMap<T> = {
+    code: T;
+    delete: T;
+    emphasis: T;
+    insert: T;
+    keyboard: T;
+    linebreak: T;
+    mark: T;
+    strong: T;
+    strikethrough: T;
+    subscript: T;
+    superscript: T;
+    underline: T;
+    variable: T;
+};
+type DecoratorType = keyof DecoratorTypeMap<any>;
+type BaseSys = {
+    id?: string;
+    uri?: string;
+    language?: string;
+    contentTypeId?: string;
+    projectId?: string;
+    dataFormat?: string;
+};
+type BaseEntry<TSys extends BaseSys> = {
+    sys: null | TSys;
+    entryTitle?: string;
+    entryDescription?: string;
+    entryThumbnail?: Image$1;
+};
+type EntrySys = {
+    id?: string;
+    uri?: string;
+    language?: string;
+    contentTypeId?: string;
+    projectId?: string;
+    dataFormat?: 'entry';
+};
+type Entry = BaseEntry<EntrySys>;
+type Image$1 = {
+    asset?: Asset;
+    caption?: string;
+    transformations?: Transformations;
+    altText?: string;
+};
+type AssetSys = {
+    id?: string;
+    uri?: string;
+    language?: string;
+    contentTypeId?: string;
+    projectId?: string;
+    dataFormat?: 'asset';
+    properties?: {
+        width?: number;
+        height?: number;
+    };
+};
+type Asset = BaseEntry<AssetSys> & {
+    altText?: string;
+};
+type Transformations = {
+    size?: {
+        width?: number;
+        height?: number;
+    };
+    flip?: null | 'h' | 'v' | 'both';
+    rotate?: number;
+    crop?: {
+        width?: number;
+        height?: number;
+        x?: number;
+        y?: number;
+    };
+    quality?: number;
+    format?: string;
+};
+type Node = {
+    displayName?: string;
+    id?: string;
+    includeInMenu?: boolean;
+    isCanonical?: boolean;
+    language?: string;
+    path?: string;
+    slug?: string;
+};
+type LinkType = 'entry' | 'node' | 'uri';
+type LinkProperties = {
+    query?: string;
+    fragment?: string;
+    type: LinkType;
+};
+type LinkSys = EntrySys & {
+    linkProperties: LinkProperties;
+    node?: Node;
+};
+type Link$1 = BaseEntry<LinkSys>;
+type Block = AnchorBlock | CodeBlock | ComponentBlock | DividerBlock | FragmentBlock | HeadingBlock | ImageBlock | InlineEntryBlock | LinkBlock | ListBlock | ListItemBlock | PanelBlock | ParagraphBlock | QuoteBlock | TableBlock | TableBodyBlock | TableCaptionBlock | TableCellBlock | TableFooterBlock | TableHeaderBlock | TableHeaderCellBlock | TableRowBlock;
+type AnchorBlock = {
+    type: '_anchor';
+    id: string;
+    value?: InlineChildren;
+    properties?: {
+        id?: string;
+    };
+};
+type CodeBlock = {
+    type: '_code';
+    id: string;
+    value?: {
+        code?: string;
+        language?: string;
+        caption?: string;
+    };
+    properties?: {
+        id?: string;
+    };
+};
+type ComponentBlock = {
+    type: '_component';
+    id: string;
+    value?: Record<string, any>;
+    properties?: {
+        id?: string;
+        component: string;
+    };
+};
+type DividerBlock = {
+    type: '_divider';
+    id: string;
+    value?: undefined;
+    properties?: {
+        id?: string;
+    };
+};
+type FragmentBlock = {
+    type: '_fragment';
+    id: string;
+    value?: InlineChildren;
+    properties?: {
+        id?: string;
+        decorators?: DecoratorType[];
+    };
+};
+type HeadingBlock = {
+    type: '_heading';
+    id: string;
+    value?: InlineChildren;
+    properties?: {
+        id?: string;
+        level?: number;
+    };
+};
+type ImageBlock = {
+    type: '_image';
+    id: string;
+    value?: Image$1;
+    properties?: {
+        id?: string;
+    };
+};
+type InlineEntryBlock = {
+    type: '_inlineEntry';
+    id: string;
+    value?: Entry;
+    properties?: {
+        id?: string;
+    };
+};
+type LinkBlock = {
+    type: '_link';
+    id: string;
+    value?: InlineChildren;
+    properties?: {
+        id?: string;
+        link?: Link$1;
+        newTab?: boolean;
+    };
+};
+type ListType = 'ordered' | 'unordered';
+type ListBlock = {
+    type: '_list';
+    id: string;
+    value?: ListItemBlock[];
+    properties?: {
+        id?: string;
+        listType?: ListType;
+        start?: number;
+    };
+};
+type ListItemBlock = {
+    type: '_listItem';
+    id: string;
+    value?: string | Block[];
+    properties?: {
+        id?: string;
+    };
+};
+type PanelType = 'info' | 'note' | 'warning' | 'success' | 'error';
+type PanelBlock = {
+    type: '_panel';
+    id: string;
+    value?: InlineChildren;
+    properties?: {
+        id?: string;
+        panelType?: PanelType;
+    };
+};
+type ParagraphType = 'lead';
+type ParagraphBlock = {
+    type: '_paragraph';
+    id: string;
+    value?: InlineChildren;
+    properties?: {
+        id?: string;
+        paragraphType?: ParagraphType;
+    };
+};
+type QuoteBlock = {
+    type: '_quote';
+    id: string;
+    value?: InlineChildren;
+    properties?: {
+        id?: string;
+        url?: string;
+        citation?: string;
+        source?: string;
+    };
+};
+type TableBlock = {
+    type: '_table';
+    id: string;
+    value?: (TableCaptionBlock | TableHeaderBlock | TableBodyBlock | TableFooterBlock)[];
+    properties?: {
+        id?: string;
+    };
+};
+type TableBodyBlock = {
+    type: '_tableBody';
+    id: string;
+    value?: TableRowBlock[];
+    properties?: {
+        id?: string;
+    };
+};
+type TableCaptionBlock = {
+    type: '_tableCaption';
+    id: string;
+    value?: string | Block[];
+    properties?: {
+        id?: string;
+    };
+};
+type TableCellBlock = {
+    type: '_tableCell';
+    id: string;
+    value?: string | Block[];
+    properties?: {
+        id?: string;
+    };
+};
+type TableFooterBlock = {
+    type: '_tableFooter';
+    id: string;
+    value?: TableRowBlock[];
+    properties?: {
+        id?: string;
+    };
+};
+type TableHeaderBlock = {
+    type: '_tableHeader';
+    id: string;
+    value?: TableRowBlock[];
+    properties?: {
+        id?: string;
+    };
+};
+type TableHeaderCellBlock = {
+    type: '_tableHeaderCell';
+    id: string;
+    value?: string | Block[];
+    properties?: {
+        id?: string;
+    };
+};
+type TableRowBlock = {
+    type: '_tableRow';
+    id: string;
+    value?: (TableCellBlock | TableHeaderCellBlock)[];
+    properties?: {
+        id?: string;
+    };
+};
+
+type Attributes = Record<string, any>;
+type WithChildren = {
+    children?: JSX.Element;
+};
+type RendererProps = {
+    data: Block[];
+};
+type RenderBlockProps<T extends Block> = {
+    block: T;
+};
+type RenderBlockPropsWithChildren<T extends Block> = RenderBlockProps<T> & WithChildren & Attributes;
+type TypedBlock<TType extends Block['type']> = Extract<Block, {
+    type: TType;
+}>;
+type BlockRenderer<T extends Block> = (props: RenderBlockPropsWithChildren<T>) => JSX.Element;
+type BlockRenderers = {
+    [TType in Block['type']]: BlockRenderer<TypedBlock<TType>>;
+};
+type RenderDecoratorProps = {
+    block: FragmentBlock;
+    decorator: undefined | DecoratorType;
+    otherDecorators: undefined | DecoratorType[];
+};
+type RenderDecoratorPropsWithChildren = RenderDecoratorProps & WithChildren & Attributes;
+type DecoratorRenderer = (props: RenderDecoratorPropsWithChildren) => JSX.Element;
+type DecoratorRenderers = Record<DecoratorType, DecoratorRenderer>;
+type ComponentRenderer = (props: RenderBlockPropsWithChildren<ComponentBlock>) => JSX.Element;
+type ComponentRenderers = Record<string, ComponentRenderer>;
+type RendererContextValue = {
+    blocks?: BlockRenderers;
+    decorators?: DecoratorRenderers;
+    components?: ComponentRenderers;
+};
+type RendererOverridesContextValue = {
+    blocks?: Partial<BlockRenderers>;
+    decorators?: Partial<DecoratorRenderers>;
+    components?: ComponentRenderers;
+};
+type RendererContextProviderProps = {
+    children: JSX.Element;
+} & RendererOverridesContextValue;
+declare const RendererContext: react.Context<RendererContextValue>;
+declare function RenderContextProvider(props: RendererContextProviderProps): JSX.Element;
+declare function Renderer(props: RendererProps): JSX.Element;
+declare function Anchor(props: RenderBlockPropsWithChildren<AnchorBlock>): JSX.Element;
+declare namespace Anchor {
+    var Children: (props: RenderBlockProps<AnchorBlock>) => JSX.Element;
+}
+declare function Code(props: RenderBlockPropsWithChildren<CodeBlock>): JSX.Element;
+declare namespace Code {
+    var Children: (props: RenderBlockProps<CodeBlock>) => JSX.Element;
+}
+declare function Component(props: RenderBlockPropsWithChildren<ComponentBlock>): JSX.Element;
+declare namespace Component {
+    var Children: (props: RenderBlockProps<ComponentBlock>) => JSX.Element;
+}
+declare function Divider(props: RenderBlockPropsWithChildren<DividerBlock>): JSX.Element;
+declare namespace Divider {
+    var Children: (props: RenderBlockProps<DividerBlock>) => JSX.Element;
+}
+declare function Fragment(props: RenderBlockPropsWithChildren<FragmentBlock>): JSX.Element;
+declare namespace Fragment {
+    var Children: (props: RenderBlockProps<FragmentBlock>) => JSX.Element;
+}
+declare function Heading(props: RenderBlockPropsWithChildren<HeadingBlock>): JSX.Element;
+declare namespace Heading {
+    var Children: (props: RenderBlockProps<HeadingBlock>) => JSX.Element;
+}
+declare function Image(props: RenderBlockPropsWithChildren<ImageBlock>): JSX.Element;
+declare namespace Image {
+    var Children: (props: RenderBlockProps<ImageBlock>) => JSX.Element;
+}
+declare function InlineEntry(props: RenderBlockPropsWithChildren<InlineEntryBlock>): JSX.Element;
+declare namespace InlineEntry {
+    var Children: (props: RenderBlockProps<InlineEntryBlock>) => JSX.Element;
+}
+declare function Link(props: RenderBlockPropsWithChildren<LinkBlock>): JSX.Element;
+declare namespace Link {
+    var Children: (props: RenderBlockProps<LinkBlock>) => JSX.Element;
+}
+declare function List(props: RenderBlockPropsWithChildren<ListBlock>): JSX.Element;
+declare namespace List {
+    var Children: (props: RenderBlockProps<ListBlock>) => JSX.Element;
+}
+declare function ListItem(props: RenderBlockPropsWithChildren<ListItemBlock>): JSX.Element;
+declare namespace ListItem {
+    var Children: (props: RenderBlockProps<ListItemBlock>) => JSX.Element;
+}
+declare function Panel(props: RenderBlockPropsWithChildren<PanelBlock>): JSX.Element;
+declare namespace Panel {
+    var Children: (props: RenderBlockProps<PanelBlock>) => JSX.Element;
+}
+declare function Paragraph(props: RenderBlockPropsWithChildren<ParagraphBlock>): JSX.Element;
+declare namespace Paragraph {
+    var Children: (props: RenderBlockProps<ParagraphBlock>) => JSX.Element;
+}
+declare function Table(props: RenderBlockPropsWithChildren<TableBlock>): JSX.Element;
+declare namespace Table {
+    var Children: (props: RenderBlockProps<TableBlock>) => JSX.Element;
+}
+declare function TableBody(props: RenderBlockPropsWithChildren<TableBodyBlock>): JSX.Element;
+declare namespace TableBody {
+    var Children: (props: RenderBlockProps<TableBodyBlock>) => JSX.Element;
+}
+declare function TableCaption(props: RenderBlockPropsWithChildren<TableCaptionBlock>): JSX.Element;
+declare namespace TableCaption {
+    var Children: (props: RenderBlockProps<TableCaptionBlock>) => JSX.Element;
+}
+declare function TableCell(props: RenderBlockPropsWithChildren<TableCellBlock>): JSX.Element;
+declare namespace TableCell {
+    var Children: (props: RenderBlockProps<TableCellBlock>) => JSX.Element;
+}
+declare function TableFooter(props: RenderBlockPropsWithChildren<TableFooterBlock>): JSX.Element;
+declare namespace TableFooter {
+    var Children: (props: RenderBlockProps<TableFooterBlock>) => JSX.Element;
+}
+declare function TableHeader(props: RenderBlockPropsWithChildren<TableHeaderBlock>): JSX.Element;
+declare namespace TableHeader {
+    var Children: (props: RenderBlockProps<TableHeaderBlock>) => JSX.Element;
+}
+declare function TableHeaderCell(props: RenderBlockPropsWithChildren<TableHeaderCellBlock>): JSX.Element;
+declare namespace TableHeaderCell {
+    var Children: (props: RenderBlockProps<TableHeaderCellBlock>) => JSX.Element;
+}
+declare function TableRow(props: RenderBlockPropsWithChildren<TableRowBlock>): JSX.Element;
+declare namespace TableRow {
+    var Children: (props: RenderBlockProps<TableRowBlock>) => JSX.Element;
+}
+declare function DecoratorChildren(props: RenderDecoratorPropsWithChildren): JSX.Element;
+declare function InlineCode(props: RenderDecoratorPropsWithChildren): JSX.Element;
+declare namespace InlineCode {
+    var Children: typeof DecoratorChildren;
+}
+declare function Delete(props: RenderDecoratorPropsWithChildren): JSX.Element;
+declare namespace Delete {
+    var Children: typeof DecoratorChildren;
+}
+declare function Emphasis(props: RenderDecoratorPropsWithChildren): JSX.Element;
+declare namespace Emphasis {
+    var Children: typeof DecoratorChildren;
+}
+declare function Insert(props: RenderDecoratorPropsWithChildren): JSX.Element;
+declare namespace Insert {
+    var Children: typeof DecoratorChildren;
+}
+declare function Keyboard(props: RenderDecoratorPropsWithChildren): JSX.Element;
+declare namespace Keyboard {
+    var Children: typeof DecoratorChildren;
+}
+declare function LineBreak(props: RenderDecoratorPropsWithChildren): JSX.Element;
+declare namespace LineBreak {
+    var Children: (props: RenderDecoratorPropsWithChildren) => JSX.Element;
+}
+declare function Mark(props: RenderDecoratorPropsWithChildren): JSX.Element;
+declare namespace Mark {
+    var Children: typeof DecoratorChildren;
+}
+declare function Strong(props: RenderDecoratorPropsWithChildren): JSX.Element;
+declare namespace Strong {
+    var Children: typeof DecoratorChildren;
+}
+declare function Strikethrough(props: RenderDecoratorPropsWithChildren): JSX.Element;
+declare namespace Strikethrough {
+    var Children: typeof DecoratorChildren;
+}
+declare function Subscript(props: RenderDecoratorPropsWithChildren): JSX.Element;
+declare namespace Subscript {
+    var Children: typeof DecoratorChildren;
+}
+declare function Superscript(props: RenderDecoratorPropsWithChildren): JSX.Element;
+declare namespace Superscript {
+    var Children: typeof DecoratorChildren;
+}
+declare function Underline(props: RenderDecoratorPropsWithChildren): JSX.Element;
+declare namespace Underline {
+    var Children: typeof DecoratorChildren;
+}
+declare function Variable(props: RenderDecoratorPropsWithChildren): JSX.Element;
+declare namespace Variable {
+    var Children: typeof DecoratorChildren;
+}
+
+export { Anchor, type AnchorBlock, type Block, Code, type CodeBlock, Component, type ComponentBlock, type DecoratorType, Delete, Divider, type DividerBlock, Emphasis, Fragment, type FragmentBlock, Heading, type HeadingBlock, Image, type ImageBlock, InlineCode, InlineEntry, type InlineEntryBlock, Insert, Keyboard, LineBreak, Link, type LinkBlock, List, type ListBlock, ListItem, type ListItemBlock, Mark, Panel, type PanelBlock, Paragraph, type ParagraphBlock, type QuoteBlock, RenderContextProvider, Renderer, RendererContext, Strikethrough, Strong, Subscript, Superscript, Table, type TableBlock, TableBody, type TableBodyBlock, TableCaption, type TableCaptionBlock, TableCell, type TableCellBlock, TableFooter, type TableFooterBlock, TableHeader, type TableHeaderBlock, TableHeaderCell, type TableHeaderCellBlock, TableRow, type TableRowBlock, Underline, Variable };