@paperbits/common/blocks/blockContract.ts

Paperbits common components.

import { Contract } from "../contract";

/**
 * Block metadata.
 */
export interface BlockContract extends Contract {
    /**
     * Own key.
     */
    key?: string;

    /**
     * Block title.
     */
    title: string;

    /**
     * Block description.
     */
    description: string;

    /**
     * Key of a document having block content.
     */
    contentKey?: string;

    /**
     * Category of the block, e.g. Footers, Pricing, etc.
     */
    category?: string;

    /**
     * A collection of keys for dependencies required to be imported for this block.
     */
    imports?: string[];
}