@paperbits/common/media/mediaContract.ts

Paperbits common components.

import { MediaVariantContract } from "./mediaVariantContract";

/**
 * Media file metadata.
 */
export interface MediaContract {
    /**
     * Own key.
     */
    key?: string;

    /**
     * A key that is used to identify a file in blob.
     */
    blobKey?: string;

    /**
     * Display name of a file (i.e. picture.png). It is used to name target file during publishing.
     */
    fileName: string;

    /**
     * File description. Used as additional information for authors.
     */
    description: string;

    /** 
     * File key words. Used for searching.
     */
    keywords: string;

    /**
     * Download URL. If available, can be used for direct download.
     */
    downloadUrl?: string;

    /**
     * Permalink referencing this media.
     */
    permalink?: string;

    /**
     * Mime type of a file (i.e. image/png).
     */
    mimeType?: string;

    /**
     * Terms assigned to a file. Used for grouping
     */
    tags?: string[];

    /**
     * Variants of the media for different screen sizes.
     */
    variants?: MediaVariantContract[];
}