storyblok/dist/index.d.mts

Storyblok CLI

type StoryblokPropertyType = 'asset' | 'multiasset' | 'multilink' | 'table' | 'richtext';
interface StoryblokAsset {
    alt: string | null;
    copyright: string | null;
    fieldtype: 'asset';
    id: number;
    filename: string | null;
    name: string;
    title: string | null;
    focus: string | null;
    meta_data: Record<string, any>;
    source: string | null;
    is_external_url: boolean;
    is_private: boolean;
    src: string;
    updated_at: string;
    width: number | null;
    height: number | null;
    aspect_ratio: number | null;
    public_id: string | null;
    content_type: string;
}
interface StoryblokMultiasset extends Array<StoryblokAsset> {
}
interface StoryblokMultilink {
    fieldtype: 'multilink';
    id: string;
    url: string;
    cached_url: string;
    target?: '_blank' | '_self';
    anchor?: string;
    rel?: string;
    title?: string;
    prep?: string;
    linktype: 'story' | 'url' | 'email' | 'asset';
    story?: {
        name: string;
        created_at: string;
        published_at: string;
        id: number;
        uuid: string;
        content: Record<string, any>;
        slug: string;
        full_slug: string;
        sort_by_date?: string;
        position?: number;
        tag_list?: string[];
        is_startpage?: boolean;
        parent_id?: number | null;
        meta_data?: Record<string, any> | null;
        group_id?: string;
        first_published_at?: string;
        release_id?: number | null;
        lang?: string;
        path?: string | null;
        alternates?: any[];
        default_full_slug?: string | null;
        translated_slugs?: any[] | null;
    };
    email?: string;
}
interface StoryblokTable {
    fieldtype: 'table';
    thead: Array<{
        _uid: string;
        value: string;
        component: '_table_head';
        _editable?: string;
    }>;
    tbody: Array<{
        _uid: string;
        component: '_table_row';
        _editable?: string;
        body: Array<{
            _uid: string;
            value: string;
            component: '_table_col';
            _editable?: string;
        }>;
    }>;
}
interface StoryblokRichtext {
    type: string;
    content?: StoryblokRichtext[];
    marks?: StoryblokRichtext[];
    attrs?: Record<string, any>;
    text?: string;
}

export type { StoryblokAsset, StoryblokMultiasset, StoryblokMultilink, StoryblokPropertyType, StoryblokRichtext, StoryblokTable };