@sensinum/astro-strapi-blocks/src/types/strapi.ts

Astro components for Strapi Block Field

export type StrapiMedia = {
    url: string;
    alternativeText: string;
    caption: string;
    width: number;
    height: number;
    hash: string;
    ext: string;
    mime: string;
    size: number;
    previewUrl: string;
    provider: string;
    provider_metadata: any;
    formats: {
        small?: StrapiMedia;
        medium?: StrapiMedia;
        large?: StrapiMedia;
    },
};

export type StrapiBlockTextItem = {
    text: string;
    type: 'text';
    bold?: boolean;
    italic?: boolean;
    underline?: boolean;
    strikethrough?: boolean;
};

export type StrapiBlockLinkItem = {
    url: string;
    target?: string;
    rel?: string;
    type: 'link';
    children: Array<StrapiBlockTextItem>;
};

export type StrapiBlockListItem = {
    type: 'list-item';
    children: Array<StrapiBlockNode>;
};

export type StrapiBlockNode = StrapiBlockTextItem | StrapiBlockLinkItem | StrapiBlockListItem | StrapiBlockList;

export type StrapiBlockHeading = {
    type: 'heading';
    level: number;
};

export type StrapiBlockCode = {
    type: 'code';
    language: string;
    children: Array<StrapiBlockNode>;
};

export type StrapiBlockListType = 'ordered' | 'unordered'

export type StrapiBlockList = {
    type: 'list';
    format: StrapiBlockListType;
    indentLevel?: number;
    children: Array<StrapiBlockListItem>
};

export type StrapiBlockParagraph = {
    type: 'paragraph';
};

export type StrapiBlockQuote = {
    type: 'quote';
};

export type StrapiBlockImage = {
    type: 'image';
    image: StrapiMedia;
    format?: 'original' | keyof StrapiMedia['formats'];
    children?: Array<StrapiBlockNode>;
};

export type StrapiBlockVariations = StrapiBlockParagraph | StrapiBlockHeading | StrapiBlockList | StrapiBlockCode | StrapiBlockQuote | StrapiBlockImage;

export type StrapiBlockType = 'paragraph' | 'heading' | 'list' | 'quote' | 'code' | 'image';

export type StrapiBlockParagraphClass = {
    strong?: string;
    em?: string;
    a?: string;
    s?: string;
    u?: string;
    span?: string;
    master?: string;
};

export type StrapiBlockClassExtension = {
    paragraph?: StrapiBlockParagraphClass | string;
    heading?: string;
    list?: string;
    quote?: string;
    code?: string;
    image?: string;
};

export type StrapiBlock<T = StrapiBlockVariations> = {
    children: Array<StrapiBlockTextItem>;
} & T;

export type StrapiBlockField = Array<StrapiBlock>;