@stencila/schema/dist/types.d.ts

Stencila schema and other specifications

/**
 * This file was automatically generated.
 * Do not modify it by hand. Instead, modify the source `.schema.yaml` file
 * in the `schema` directory and run `npm run build` to regenerate this file.
 */
/**
 * Describes a valid value for any node in the tree.
 *
 */
export declare type Node = null | boolean | number | string | any[] | {
    [k: string]: any;
} | Thing;
/**
 * A directive to include content from an external source (e.g. file, URL) or content.
 *
 */
export declare type Include = {
    [k: string]: any;
};
/**
 * Block content.
 */
export declare type BlockContent = CodeBlock | CodeChunk | Heading | List | Paragraph | QuoteBlock | Table | ThematicBreak;
/**
 * Inline content.
 */
export declare type InlineContent = null | boolean | number | string | Emphasis | Strong | Delete | Quote | Code | CodeExpr | Link | ImageObject;
export interface Types {
    Article: Article;
    Collection: Collection;
    CreativeWork: CreativeWork;
    Include: Include;
    Node: Node;
    Thing: Thing;
    Datatable: Datatable;
    DatatableColumn: DatatableColumn;
    DatatableColumnSchema: DatatableColumnSchema;
    AudioObject: AudioObject;
    ImageObject: ImageObject;
    MediaObject: MediaObject;
    VideoObject: VideoObject;
    Brand: Brand;
    ContactPoint: ContactPoint;
    Organization: Organization;
    Person: Person;
    Product: Product;
    CodeChunk: CodeChunk;
    CodeExpr: CodeExpr;
    Environment: Environment;
    Mount: Mount;
    ResourceParameters: ResourceParameters;
    SoftwareApplication: SoftwareApplication;
    SoftwareSession: SoftwareSession;
    SoftwareSourceCode: SoftwareSourceCode;
    BlockContent: BlockContent;
    Code: Code;
    CodeBlock: CodeBlock;
    Delete: Delete;
    Emphasis: Emphasis;
    Heading: Heading;
    InlineContent: InlineContent;
    Link: Link;
    List: List;
    Paragraph: Paragraph;
    Quote: Quote;
    QuoteBlock: QuoteBlock;
    Strong: Strong;
    Table: Table;
    TableCell: TableCell;
    TableRow: TableRow;
    ThematicBreak: ThematicBreak;
    [k: string]: any;
}
export interface Article {
    /**
     * The name of the type and all descendant types.
     */
    type: "Article";
    /**
     * The identifier for this item.
     */
    id?: string;
    /**
     * Alternate names (aliases) for the item.
     */
    alternateNames?: string[];
    /**
     * A description of the item.
     */
    description?: string;
    /**
     * Metadata associated with this item.
     */
    meta?: {
        [k: string]: any;
    };
    /**
     * The name of the item.
     */
    name?: string;
    /**
     * The URL of the item.
     */
    url?: string;
    /**
     * The authors of this this creative work.
     */
    authors: (Person | Organization)[];
    /**
     * Citations or references to other creative works, such as another publication,
     * web page, scholarly article, etc.
     *
     */
    citations?: (string | CreativeWork)[];
    /**
     * The structured content of this creative work c.f. property `text`.
     */
    content?: Node[];
    /**
     * Date/time of creation.
     */
    dateCreated?: string;
    /**
     * Date/time of most recent modification.
     */
    dateModified?: string;
    /**
     * Date of first publication.
     */
    datePublished?: string;
    /**
     * Persons who edited the CreativeWork.
     *
     */
    editors?: Person[];
    /**
     * Person or organisation that funded the CreativeWork.
     *
     */
    funders?: (Person | Organization)[];
    /**
     * An item or other CreativeWork that this CreativeWork is a part of.
     *
     */
    isPartOf?: CreativeWork;
    /**
     * License documents that applies to this content, typically indicated by URL.
     *
     */
    licenses?: (string | CreativeWork)[];
    /**
     * Elements of the collection which can be a variety of different elements,
     * such as Articles, Datatables, Tables and more.
     *
     */
    parts?: CreativeWork[];
    /**
     * A publisher of the CreativeWork.
     *
     */
    publisher?: Person | Organization;
    /**
     * The textual content of this creative work.
     */
    text?: string;
    title: string;
    version?: string | number;
    /**
     * The computational environment in which the document should be executed.
     *
     */
    environment?: Environment;
}
/**
 * A person (alive, dead, undead, or fictional). https://schema.org/Person.
 */
export interface Person {
    /**
     * The name of the type and all descendant types.
     */
    type: "Person";
    /**
     * The identifier for this item.
     */
    id?: string;
    /**
     * Alternate names (aliases) for the item.
     */
    alternateNames?: string[];
    /**
     * A description of the item.
     */
    description?: string;
    /**
     * Metadata associated with this item.
     */
    meta?: {
        [k: string]: any;
    };
    /**
     * The name of the item.
     */
    name?: string;
    /**
     * The URL of the item.
     */
    url?: string;
    /**
     * Postal address for the person.
     */
    address?: string;
    /**
     * Organizations that the person is affiliated with.
     */
    affiliations?: Organization[];
    /**
     * Email addresses for the person.
     */
    emails?: string[];
    /**
     * Family name. In the U.S., the last name of an Person.
     * This can be used along with givenName instead of the name property.
     *
     */
    familyNames?: {
        [k: string]: any;
    } & string[];
    /**
     * A person or organization that supports (sponsors) something through
     * some kind of financial contribution.
     *
     */
    funders?: (Organization | Person)[];
    /**
     * Given name. In the U.S., the first name of a Person.
     * This can be used along with familyName instead of the name property.
     *
     */
    givenNames?: {
        [k: string]: any;
    } & string[];
    /**
     * An honorific prefix preceding a person's name such as Dr/Mrs/Mr.
     */
    honorificPrefix?: string;
    /**
     * An honorific suffix after a person's name such as MD/PhD/MSCSW.
     */
    honorificSuffix?: string;
    /**
     * The job title of the person (for example, Financial Manager).
     */
    jobTitle?: string;
    /**
     * An organization (or program membership) to which this person belongs.
     */
    memberOf?: [Organization];
    /**
     * Telephone numbers for the person.
     */
    telephoneNumbers?: string[];
}
/**
 * An organization such as a school, NGO, corporation, club, etc. https://schema.org/Organization.
 */
export interface Organization {
    /**
     * The name of the type and all descendant types.
     */
    type: "Organization";
    /**
     * The identifier for this item.
     */
    id?: string;
    /**
     * Alternate names (aliases) for the item.
     */
    alternateNames?: string[];
    /**
     * A description of the item.
     */
    description?: string;
    /**
     * Metadata associated with this item.
     */
    meta?: {
        [k: string]: any;
    };
    /**
     * The name of the item.
     */
    name?: string;
    /**
     * The URL of the item.
     */
    url?: string;
    /**
     * Postal address for the organization.
     *
     */
    address?: string;
    /**
     * Brands that the organization is connected with.
     *
     */
    brands?: Brand[];
    /**
     * Correspondence/Contact points for the organization.
     *
     */
    contactPoints?: ContactPoint[];
    /**
     * Departments within the organization. For example, Department of Computer Science, Research & Development etc.
     *
     */
    departments?: Organization[];
    /**
     * Organization(s) or person(s) funding the organization.
     *
     */
    funders?: (Organization | Person)[];
    /**
     * Legal name for the Organization. Should only include letters and spaces.
     *
     */
    legalName?: string;
    /**
     * Entity that the Organization is a part of. For example, parentOrganization to a department is a university.
     *
     */
    parentOrganization?: Organization;
}
/**
 * A brand is a name used by an organization or business person for labeling a product,
 * product group, or similar. https://schema.org/Brand.
 *
 */
export interface Brand {
    /**
     * The name of the type and all descendant types.
     */
    type: "Brand";
    /**
     * The identifier for this item.
     */
    id?: string;
    /**
     * Alternate names (aliases) for the item.
     */
    alternateNames?: string[];
    /**
     * A description of the item.
     */
    description?: string;
    /**
     * Metadata associated with this item.
     */
    meta?: {
        [k: string]: any;
    };
    /**
     * The name of the item.
     */
    name?: string;
    /**
     * The URL of the item.
     */
    url?: string;
    /**
     * A logo of of the brand. It can be either a URL of the image or image itself.
     *
     */
    logo?: string | ImageObject;
    /**
     * Short reviews of the brand and/or the products it represents.
     *
     */
    reviews?: string[];
}
/**
 * An image file. https://schema.org/ImageObject
 *
 */
export interface ImageObject {
    /**
     * The name of the type and all descendant types.
     */
    type: "ImageObject";
    /**
     * The identifier for this item.
     */
    id?: string;
    /**
     * Alternate names (aliases) for the item.
     */
    alternateNames?: string[];
    /**
     * A description of the item.
     */
    description?: string;
    /**
     * Metadata associated with this item.
     */
    meta?: {
        [k: string]: any;
    };
    /**
     * The name of the item.
     */
    name?: string;
    /**
     * The URL of the item.
     */
    url?: string;
    /**
     * The authors of this this creative work.
     */
    authors?: (Person | Organization)[];
    /**
     * Citations or references to other creative works, such as another publication,
     * web page, scholarly article, etc.
     *
     */
    citations?: (string | CreativeWork)[];
    /**
     * The structured content of this creative work c.f. property `text`.
     */
    content?: Node[];
    /**
     * Date/time of creation.
     */
    dateCreated?: string;
    /**
     * Date/time of most recent modification.
     */
    dateModified?: string;
    /**
     * Date of first publication.
     */
    datePublished?: string;
    /**
     * Persons who edited the CreativeWork.
     *
     */
    editors?: Person[];
    /**
     * Person or organisation that funded the CreativeWork.
     *
     */
    funders?: (Person | Organization)[];
    /**
     * An item or other CreativeWork that this CreativeWork is a part of.
     *
     */
    isPartOf?: CreativeWork;
    /**
     * License documents that applies to this content, typically indicated by URL.
     *
     */
    licenses?: (string | CreativeWork)[];
    /**
     * Elements of the collection which can be a variety of different elements,
     * such as Articles, Datatables, Tables and more.
     *
     */
    parts?: CreativeWork[];
    /**
     * A publisher of the CreativeWork.
     *
     */
    publisher?: Person | Organization;
    /**
     * The textual content of this creative work.
     */
    text?: string;
    title?: string;
    version?: string | number;
    /**
     * Bitrate in megabits per second (Mbit/s, Mb/s, Mbps).
     *
     */
    bitrate?: number;
    /**
     * File size in megabits (Mbit, Mb).
     *
     */
    contentSize?: number;
    /**
     * URL for the actual bytes of the media object, for example the image file or video file.
     *
     */
    contentUrl: string;
    /**
     * URL that can be used to embed the media on a web page via a specific media player.
     *
     */
    embedUrl?: string;
    /**
     * Media type (MIME type) as per http://www.iana.org/assignments/media-types/media-types.xhtml.
     *
     */
    format?: string;
    /**
     * The caption for this image.
     *
     */
    caption?: string;
    /**
     * Thumbnail image of this image.
     *
     */
    thumbnail?: ImageObject;
}
/**
 * The most generic kind of creative work, including books, movies, photographs,
 * software programs, etc. https://schema.org/CreativeWork
 *
 */
export interface CreativeWork {
    /**
     * The name of the type and all descendant types.
     */
    type: "CreativeWork" | "Article" | "AudioObject" | "CodeChunk" | "CodeExpr" | "Collection" | "Datatable" | "ImageObject" | "MediaObject" | "SoftwareApplication" | "SoftwareSourceCode" | "Table" | "VideoObject";
    /**
     * The identifier for this item.
     */
    id?: string;
    /**
     * Alternate names (aliases) for the item.
     */
    alternateNames?: string[];
    /**
     * A description of the item.
     */
    description?: string;
    /**
     * Metadata associated with this item.
     */
    meta?: {
        [k: string]: any;
    };
    /**
     * The name of the item.
     */
    name?: string;
    /**
     * The URL of the item.
     */
    url?: string;
    /**
     * The authors of this this creative work.
     */
    authors?: (Person | Organization)[];
    /**
     * Citations or references to other creative works, such as another publication,
     * web page, scholarly article, etc.
     *
     */
    citations?: (string | CreativeWork)[];
    /**
     * The structured content of this creative work c.f. property `text`.
     */
    content?: Node[];
    /**
     * Date/time of creation.
     */
    dateCreated?: string;
    /**
     * Date/time of most recent modification.
     */
    dateModified?: string;
    /**
     * Date of first publication.
     */
    datePublished?: string;
    /**
     * Persons who edited the CreativeWork.
     *
     */
    editors?: Person[];
    /**
     * Person or organisation that funded the CreativeWork.
     *
     */
    funders?: (Person | Organization)[];
    /**
     * An item or other CreativeWork that this CreativeWork is a part of.
     *
     */
    isPartOf?: CreativeWork;
    /**
     * License documents that applies to this content, typically indicated by URL.
     *
     */
    licenses?: (string | CreativeWork)[];
    /**
     * Elements of the collection which can be a variety of different elements,
     * such as Articles, Datatables, Tables and more.
     *
     */
    parts?: CreativeWork[];
    /**
     * A publisher of the CreativeWork.
     *
     */
    publisher?: Person | Organization;
    /**
     * The textual content of this creative work.
     */
    text?: string;
    title?: string;
    version?: string | number;
}
/**
 * The most generic type of item https://schema.org/Thing.
 */
export interface Thing {
    /**
     * The name of the type and all descendant types.
     */
    type: "Thing" | "Article" | "AudioObject" | "Brand" | "Code" | "CodeBlock" | "CodeChunk" | "CodeExpr" | "Collection" | "ContactPoint" | "CreativeWork" | "Datatable" | "DatatableColumn" | "DatatableColumnSchema" | "Delete" | "Emphasis" | "Environment" | "Heading" | "ImageObject" | "Link" | "List" | "MediaObject" | "Mount" | "Organization" | "Paragraph" | "Person" | "Product" | "Quote" | "QuoteBlock" | "ResourceParameters" | "SoftwareApplication" | "SoftwareSession" | "SoftwareSourceCode" | "Strong" | "Table" | "TableCell" | "TableRow" | "ThematicBreak" | "VideoObject";
    /**
     * The identifier for this item.
     */
    id?: string;
    /**
     * Alternate names (aliases) for the item.
     */
    alternateNames?: string[];
    /**
     * A description of the item.
     */
    description?: string;
    /**
     * Metadata associated with this item.
     */
    meta?: {
        [k: string]: any;
    };
    /**
     * The name of the item.
     */
    name?: string;
    /**
     * The URL of the item.
     */
    url?: string;
}
/**
 * A contact point—for example, a R&D department. https://schema.org/ContactPoint.
 */
export interface ContactPoint {
    /**
     * The name of the type and all descendant types.
     */
    type: "ContactPoint";
    /**
     * The identifier for this item.
     */
    id?: string;
    /**
     * Alternate names (aliases) for the item.
     */
    alternateNames?: string[];
    /**
     * A description of the item.
     */
    description?: string;
    /**
     * Metadata associated with this item.
     */
    meta?: {
        [k: string]: any;
    };
    /**
     * The name of the item.
     */
    name?: string;
    /**
     * The URL of the item.
     */
    url?: string;
    /**
     * Languages (human not programming) in which it is possible to communicate with the organization/department etc.
     *
     */
    availableLanguages?: string[];
    /**
     * Email address for correspondence. It must be provided in a valid email format (eg. info@example.com ).
     *
     */
    emails?: string[];
    /**
     * "Phone contact number. Accepted formats: +44 123455, (02)12345, 006645667."
     *
     */
    telephone?: string;
}
/**
 * A computational environment.
 */
export interface Environment {
    /**
     * The name of the type and all descendant types.
     */
    type: "Environment";
    /**
     * The identifier for this item.
     */
    id?: string;
    /**
     * Alternate names (aliases) for the item.
     */
    alternateNames?: string[];
    /**
     * A description of the item.
     */
    description?: string;
    /**
     * Metadata associated with this item.
     */
    meta?: {
        [k: string]: any;
    };
    /**
     * The name of the item.
     */
    name: string;
    /**
     * The URL of the item.
     */
    url?: string;
    /**
     * Other environments that this environment extends by adding or removing packages.,
     */
    extends?: Environment[];
    /**
     * The packages that this environment adds to the base environments listed under `extends` (if any).,
     */
    adds?: SoftwareSourceCode[];
    /**
     * The packages that this environment removes from the base environments listed under `extends` (if any).,
     */
    removes?: SoftwareSourceCode[];
    /**
     * Source of environment definition. For example, a URL to a Dockerfile, a path to Singularity recipe file,
     * or a path to a filesystem folder.,
     *
     */
    environmentSource?: string;
}
/**
 * Computer programming source code. Example: Full (compile ready) solutions, code snippet samples, scripts, templates.
 *
 */
export interface SoftwareSourceCode {
    /**
     * The name of the type and all descendant types.
     */
    type: "SoftwareSourceCode" | "CodeChunk" | "CodeExpr";
    /**
     * The identifier for this item.
     */
    id?: string;
    /**
     * Alternate names (aliases) for the item.
     */
    alternateNames?: string[];
    /**
     * A description of the item.
     */
    description?: string;
    /**
     * Metadata associated with this item.
     */
    meta?: {
        [k: string]: any;
    };
    /**
     * The name of the item.
     */
    name?: string;
    /**
     * The URL of the item.
     */
    url?: string;
    /**
     * The authors of this this creative work.
     */
    authors?: (Person | Organization)[];
    /**
     * Citations or references to other creative works, such as another publication,
     * web page, scholarly article, etc.
     *
     */
    citations?: (string | CreativeWork)[];
    /**
     * The structured content of this creative work c.f. property `text`.
     */
    content?: Node[];
    /**
     * Date/time of creation.
     */
    dateCreated?: string;
    /**
     * Date/time of most recent modification.
     */
    dateModified?: string;
    /**
     * Date of first publication.
     */
    datePublished?: string;
    /**
     * Persons who edited the CreativeWork.
     *
     */
    editors?: Person[];
    /**
     * Person or organisation that funded the CreativeWork.
     *
     */
    funders?: (Person | Organization)[];
    /**
     * An item or other CreativeWork that this CreativeWork is a part of.
     *
     */
    isPartOf?: CreativeWork;
    /**
     * License documents that applies to this content, typically indicated by URL.
     *
     */
    licenses?: (string | CreativeWork)[];
    /**
     * Elements of the collection which can be a variety of different elements,
     * such as Articles, Datatables, Tables and more.
     *
     */
    parts?: CreativeWork[];
    /**
     * A publisher of the CreativeWork.
     *
     */
    publisher?: Person | Organization;
    /**
     * The textual content of this creative work.
     */
    text?: string;
    title?: string;
    version?: string | number;
    /**
     * Link to the repository where the un-compiled, human readable code and related code is located (SVN, github, CodePlex)
     *
     */
    codeRepository?: string;
    /**
     * What type of code sample: full (compile ready) solution, code snippet, inline code, scripts, template.
     *
     */
    codeSampleType?: string;
    /**
     * The people or organizations who maintain the software.
     *
     */
    maintainers?: [Organization, Person];
    /**
     * The computer programming language.
     *
     */
    programmingLanguage?: string;
    /**
     * Runtime platform or script interpreter dependencies (Example - Java v1, Python2.3, .Net Framework 3.0).
     *
     */
    runtimePlatform?: [string];
    /**
     * Component dependency requirements for application.
     * This includes runtime environments and shared libraries that
     * are not included in the application distribution package, but
     * required to run the application (Examples include DirectX, Java or .NET runtime).
     *
     */
    softwareRequirements?: (SoftwareSourceCode | SoftwareApplication | string)[];
    /**
     * Target Operating System / Product to which the code applies.
     * If applies to several versions, just the product name can be used.
     *
     */
    targetProducts?: [SoftwareApplication];
}
/**
 * A software application.
 *
 */
export interface SoftwareApplication {
    /**
     * The name of the type and all descendant types.
     */
    type: "SoftwareApplication";
    /**
     * The identifier for this item.
     */
    id?: string;
    /**
     * Alternate names (aliases) for the item.
     */
    alternateNames?: string[];
    /**
     * A description of the item.
     */
    description?: string;
    /**
     * Metadata associated with this item.
     */
    meta?: {
        [k: string]: any;
    };
    /**
     * The name of the item.
     */
    name?: string;
    /**
     * The URL of the item.
     */
    url?: string;
    /**
     * The authors of this this creative work.
     */
    authors?: (Person | Organization)[];
    /**
     * Citations or references to other creative works, such as another publication,
     * web page, scholarly article, etc.
     *
     */
    citations?: (string | CreativeWork)[];
    /**
     * The structured content of this creative work c.f. property `text`.
     */
    content?: Node[];
    /**
     * Date/time of creation.
     */
    dateCreated?: string;
    /**
     * Date/time of most recent modification.
     */
    dateModified?: string;
    /**
     * Date of first publication.
     */
    datePublished?: string;
    /**
     * Persons who edited the CreativeWork.
     *
     */
    editors?: Person[];
    /**
     * Person or organisation that funded the CreativeWork.
     *
     */
    funders?: (Person | Organization)[];
    /**
     * An item or other CreativeWork that this CreativeWork is a part of.
     *
     */
    isPartOf?: CreativeWork;
    /**
     * License documents that applies to this content, typically indicated by URL.
     *
     */
    licenses?: (string | CreativeWork)[];
    /**
     * Elements of the collection which can be a variety of different elements,
     * such as Articles, Datatables, Tables and more.
     *
     */
    parts?: CreativeWork[];
    /**
     * A publisher of the CreativeWork.
     *
     */
    publisher?: Person | Organization;
    /**
     * The textual content of this creative work.
     */
    text?: string;
    title?: string;
    version?: string | number;
    /**
     * Component dependency requirements for application. This includes runtime environments and shared libraries that are not included in the application distribution package, but required to run the application (Examples: DirectX, Java or .NET runtime).
     *
     */
    softwareRequirements?: [SoftwareApplication];
    /**
     * Version of the software instance.
     */
    softwareVersion?: string;
}
/**
 * A created collection of CreativeWorks or other artefacts.
 *
 */
export interface Collection {
    /**
     * The name of the type and all descendant types.
     */
    type: "Collection";
    /**
     * The identifier for this item.
     */
    id?: string;
    /**
     * Alternate names (aliases) for the item.
     */
    alternateNames?: string[];
    /**
     * A description of the item.
     */
    description?: string;
    /**
     * Metadata associated with this item.
     */
    meta?: {
        [k: string]: any;
    };
    /**
     * The name of the item.
     */
    name?: string;
    /**
     * The URL of the item.
     */
    url?: string;
    /**
     * The authors of this this creative work.
     */
    authors?: (Person | Organization)[];
    /**
     * Citations or references to other creative works, such as another publication,
     * web page, scholarly article, etc.
     *
     */
    citations?: (string | CreativeWork)[];
    /**
     * The structured content of this creative work c.f. property `text`.
     */
    content?: Node[];
    /**
     * Date/time of creation.
     */
    dateCreated?: string;
    /**
     * Date/time of most recent modification.
     */
    dateModified?: string;
    /**
     * Date of first publication.
     */
    datePublished?: string;
    /**
     * Persons who edited the CreativeWork.
     *
     */
    editors?: Person[];
    /**
     * Person or organisation that funded the CreativeWork.
     *
     */
    funders?: (Person | Organization)[];
    /**
     * An item or other CreativeWork that this CreativeWork is a part of.
     *
     */
    isPartOf?: CreativeWork;
    /**
     * License documents that applies to this content, typically indicated by URL.
     *
     */
    licenses?: (string | CreativeWork)[];
    /**
     * Elements of the collection which can be a variety of different elements,
     * such as Articles, Datatables, Tables and more.
     *
     */
    parts: CreativeWork[];
    /**
     * A publisher of the CreativeWork.
     *
     */
    publisher?: Person | Organization;
    /**
     * The textual content of this creative work.
     */
    text?: string;
    title?: string;
    version?: string | number;
}
/**
 * A table of data.
 */
export interface Datatable {
    /**
     * The name of the type and all descendant types.
     */
    type: "Datatable";
    /**
     * The identifier for this item.
     */
    id?: string;
    /**
     * Alternate names (aliases) for the item.
     */
    alternateNames?: string[];
    /**
     * A description of the item.
     */
    description?: string;
    /**
     * Metadata associated with this item.
     */
    meta?: {
        [k: string]: any;
    };
    /**
     * The name of the item.
     */
    name?: string;
    /**
     * The URL of the item.
     */
    url?: string;
    /**
     * The authors of this this creative work.
     */
    authors?: (Person | Organization)[];
    /**
     * Citations or references to other creative works, such as another publication,
     * web page, scholarly article, etc.
     *
     */
    citations?: (string | CreativeWork)[];
    /**
     * The structured content of this creative work c.f. property `text`.
     */
    content?: Node[];
    /**
     * Date/time of creation.
     */
    dateCreated?: string;
    /**
     * Date/time of most recent modification.
     */
    dateModified?: string;
    /**
     * Date of first publication.
     */
    datePublished?: string;
    /**
     * Persons who edited the CreativeWork.
     *
     */
    editors?: Person[];
    /**
     * Person or organisation that funded the CreativeWork.
     *
     */
    funders?: (Person | Organization)[];
    /**
     * An item or other CreativeWork that this CreativeWork is a part of.
     *
     */
    isPartOf?: CreativeWork;
    /**
     * License documents that applies to this content, typically indicated by URL.
     *
     */
    licenses?: (string | CreativeWork)[];
    /**
     * Elements of the collection which can be a variety of different elements,
     * such as Articles, Datatables, Tables and more.
     *
     */
    parts?: CreativeWork[];
    /**
     * A publisher of the CreativeWork.
     *
     */
    publisher?: Person | Organization;
    /**
     * The textual content of this creative work.
     */
    text?: string;
    title?: string;
    version?: string | number;
    /**
     * TODO
     */
    columns: DatatableColumn[];
}
export interface DatatableColumn {
    /**
     * The name of the type and all descendant types.
     */
    type: "DatatableColumn";
    /**
     * The identifier for this item.
     */
    id?: string;
    /**
     * Alternate names (aliases) for the item.
     */
    alternateNames?: string[];
    /**
     * A description of the item.
     */
    description?: string;
    /**
     * Metadata for the column.
     */
    meta?: {
        [k: string]: any;
    };
    /**
     * The name of the item.
     */
    name: string;
    /**
     * The URL of the item.
     */
    url?: string;
    /**
     * The schema to use to validate data in the column.
     */
    schema?: DatatableColumnSchema;
    /**
     * The values of the column.
     */
    values: any[];
}
export interface DatatableColumnSchema {
    /**
     * The name of the type and all descendant types.
     */
    type: "DatatableColumnSchema";
    /**
     * The identifier for this item.
     */
    id?: string;
    /**
     * Alternate names (aliases) for the item.
     */
    alternateNames?: string[];
    /**
     * A description of the item.
     */
    description?: string;
    /**
     * Metadata associated with this item.
     */
    meta?: {
        [k: string]: any;
    };
    /**
     * The name of the item.
     */
    name?: string;
    /**
     * The URL of the item.
     */
    url?: string;
    items: {
        [k: string]: any;
    };
    uniqueItems?: boolean;
}
/**
 * An audio file. https://schema.org/AudioObject
 *
 */
export interface AudioObject {
    /**
     * The name of the type and all descendant types.
     */
    type: "AudioObject";
    /**
     * The identifier for this item.
     */
    id?: string;
    /**
     * Alternate names (aliases) for the item.
     */
    alternateNames?: string[];
    /**
     * A description of the item.
     */
    description?: string;
    /**
     * Metadata associated with this item.
     */
    meta?: {
        [k: string]: any;
    };
    /**
     * The name of the item.
     */
    name?: string;
    /**
     * The URL of the item.
     */
    url?: string;
    /**
     * The authors of this this creative work.
     */
    authors?: (Person | Organization)[];
    /**
     * Citations or references to other creative works, such as another publication,
     * web page, scholarly article, etc.
     *
     */
    citations?: (string | CreativeWork)[];
    /**
     * The structured content of this creative work c.f. property `text`.
     */
    content?: Node[];
    /**
     * Date/time of creation.
     */
    dateCreated?: string;
    /**
     * Date/time of most recent modification.
     */
    dateModified?: string;
    /**
     * Date of first publication.
     */
    datePublished?: string;
    /**
     * Persons who edited the CreativeWork.
     *
     */
    editors?: Person[];
    /**
     * Person or organisation that funded the CreativeWork.
     *
     */
    funders?: (Person | Organization)[];
    /**
     * An item or other CreativeWork that this CreativeWork is a part of.
     *
     */
    isPartOf?: CreativeWork;
    /**
     * License documents that applies to this content, typically indicated by URL.
     *
     */
    licenses?: (string | CreativeWork)[];
    /**
     * Elements of the collection which can be a variety of different elements,
     * such as Articles, Datatables, Tables and more.
     *
     */
    parts?: CreativeWork[];
    /**
     * A publisher of the CreativeWork.
     *
     */
    publisher?: Person | Organization;
    /**
     * The textual content of this creative work.
     */
    text?: string;
    title?: string;
    version?: string | number;
    /**
     * Bitrate in megabits per second (Mbit/s, Mb/s, Mbps).
     *
     */
    bitrate?: number;
    /**
     * File size in megabits (Mbit, Mb).
     *
     */
    contentSize?: number;
    /**
     * URL for the actual bytes of the media object, for example the image file or video file.
     *
     */
    contentUrl: string;
    /**
     * URL that can be used to embed the media on a web page via a specific media player.
     *
     */
    embedUrl?: string;
    /**
     * Media type (MIME type) as per http://www.iana.org/assignments/media-types/media-types.xhtml.
     *
     */
    format?: string;
    /**
     * The caption for this audio recording.
     *
     */
    caption?: string;
    /**
     * The transcript of this audio recording.
     *
     */
    transcript?: string;
}
/**
 * A media object, such as an image, video, or audio object embedded in a web page or a
 * downloadable dataset. https://schema.org/MediaObject
 *
 */
export interface MediaObject {
    /**
     * The name of the type and all descendant types.
     */
    type: "MediaObject" | "AudioObject" | "ImageObject" | "VideoObject";
    /**
     * The identifier for this item.
     */
    id?: string;
    /**
     * Alternate names (aliases) for the item.
     */
    alternateNames?: string[];
    /**
     * A description of the item.
     */
    description?: string;
    /**
     * Metadata associated with this item.
     */
    meta?: {
        [k: string]: any;
    };
    /**
     * The name of the item.
     */
    name?: string;
    /**
     * The URL of the item.
     */
    url?: string;
    /**
     * The authors of this this creative work.
     */
    authors?: (Person | Organization)[];
    /**
     * Citations or references to other creative works, such as another publication,
     * web page, scholarly article, etc.
     *
     */
    citations?: (string | CreativeWork)[];
    /**
     * The structured content of this creative work c.f. property `text`.
     */
    content?: Node[];
    /**
     * Date/time of creation.
     */
    dateCreated?: string;
    /**
     * Date/time of most recent modification.
     */
    dateModified?: string;
    /**
     * Date of first publication.
     */
    datePublished?: string;
    /**
     * Persons who edited the CreativeWork.
     *
     */
    editors?: Person[];
    /**
     * Person or organisation that funded the CreativeWork.
     *
     */
    funders?: (Person | Organization)[];
    /**
     * An item or other CreativeWork that this CreativeWork is a part of.
     *
     */
    isPartOf?: CreativeWork;
    /**
     * License documents that applies to this content, typically indicated by URL.
     *
     */
    licenses?: (string | CreativeWork)[];
    /**
     * Elements of the collection which can be a variety of different elements,
     * such as Articles, Datatables, Tables and more.
     *
     */
    parts?: CreativeWork[];
    /**
     * A publisher of the CreativeWork.
     *
     */
    publisher?: Person | Organization;
    /**
     * The textual content of this creative work.
     */
    text?: string;
    title?: string;
    version?: string | number;
    /**
     * Bitrate in megabits per second (Mbit/s, Mb/s, Mbps).
     *
     */
    bitrate?: number;
    /**
     * File size in megabits (Mbit, Mb).
     *
     */
    contentSize?: number;
    /**
     * URL for the actual bytes of the media object, for example the image file or video file.
     *
     */
    contentUrl: string;
    /**
     * URL that can be used to embed the media on a web page via a specific media player.
     *
     */
    embedUrl?: string;
    /**
     * Media type (MIME type) as per http://www.iana.org/assignments/media-types/media-types.xhtml.
     *
     */
    format?: string;
}
/**
 * A video file. https://schema.org/VideoObject
 *
 */
export interface VideoObject {
    /**
     * The name of the type and all descendant types.
     */
    type: "VideoObject";
    /**
     * The identifier for this item.
     */
    id?: string;
    /**
     * Alternate names (aliases) for the item.
     */
    alternateNames?: string[];
    /**
     * A description of the item.
     */
    description?: string;
    /**
     * Metadata associated with this item.
     */
    meta?: {
        [k: string]: any;
    };
    /**
     * The name of the item.
     */
    name?: string;
    /**
     * The URL of the item.
     */
    url?: string;
    /**
     * The authors of this this creative work.
     */
    authors?: (Person | Organization)[];
    /**
     * Citations or references to other creative works, such as another publication,
     * web page, scholarly article, etc.
     *
     */
    citations?: (string | CreativeWork)[];
    /**
     * The structured content of this creative work c.f. property `text`.
     */
    content?: Node[];
    /**
     * Date/time of creation.
     */
    dateCreated?: string;
    /**
     * Date/time of most recent modification.
     */
    dateModified?: string;
    /**
     * Date of first publication.
     */
    datePublished?: string;
    /**
     * Persons who edited the CreativeWork.
     *
     */
    editors?: Person[];
    /**
     * Person or organisation that funded the CreativeWork.
     *
     */
    funders?: (Person | Organization)[];
    /**
     * An item or other CreativeWork that this CreativeWork is a part of.
     *
     */
    isPartOf?: CreativeWork;
    /**
     * License documents that applies to this content, typically indicated by URL.
     *
     */
    licenses?: (string | CreativeWork)[];
    /**
     * Elements of the collection which can be a variety of different elements,
     * such as Articles, Datatables, Tables and more.
     *
     */
    parts?: CreativeWork[];
    /**
     * A publisher of the CreativeWork.
     *
     */
    publisher?: Person | Organization;
    /**
     * The textual content of this creative work.
     */
    text?: string;
    title?: string;
    version?: string | number;
    /**
     * Bitrate in megabits per second (Mbit/s, Mb/s, Mbps).
     *
     */
    bitrate?: number;
    /**
     * File size in megabits (Mbit, Mb).
     *
     */
    contentSize?: number;
    /**
     * URL for the actual bytes of the media object, for example the image file or video file.
     *
     */
    contentUrl: string;
    /**
     * URL that can be used to embed the media on a web page via a specific media player.
     *
     */
    embedUrl?: string;
    /**
     * Media type (MIME type) as per http://www.iana.org/assignments/media-types/media-types.xhtml.
     *
     */
    format?: string;
    /**
     * The caption for this video recording.
     *
     */
    caption?: string;
    /**
     * Thumbnail image of this video recording.
     *
     */
    thumbnail?: ImageObject;
    /**
     * The transcript of this video recording.
     *
     */
    transcript?: string;
}
/**
 * Any offered product or service. For example, a pair of shoes; a concert ticket; the rental of a car;
 * a haircut; or an episode of a TV show streamed online. https://schema.org/Product
 *
 */
export interface Product {
    /**
     * The name of the type and all descendant types.
     */
    type: "Product";
    /**
     * The identifier for this item.
     */
    id?: string;
    /**
     * Alternate names (aliases) for the item.
     */
    alternateNames?: string[];
    /**
     * A description of the item.
     */
    description?: string;
    /**
     * Metadata associated with this item.
     */
    meta?: {
        [k: string]: any;
    };
    /**
     * The name of the item.
     */
    name?: string;
    /**
     * The URL of the item.
     */
    url?: string;
    brand?: Brand1;
    /**
     * A logo of of the product. It can be either a URL of the image or image itself.
     *
     */
    logo?: string | ImageObject;
    /**
     * Product identification code.
     *
     */
    productID?: string;
}
/**
 * Brand that the product is labelled with.
 *
 */
export interface Brand1 {
    /**
     * The name of the type and all descendant types.
     */
    type: "Brand";
    /**
     * The identifier for this item.
     */
    id?: string;
    /**
     * Alternate names (aliases) for the item.
     */
    alternateNames?: string[];
    /**
     * A description of the item.
     */
    description?: string;
    /**
     * Metadata associated with this item.
     */
    meta?: {
        [k: string]: any;
    };
    /**
     * The name of the item.
     */
    name?: string;
    /**
     * The URL of the item.
     */
    url?: string;
    /**
     * A logo of of the brand. It can be either a URL of the image or image itself.
     *
     */
    logo?: string | ImageObject;
    /**
     * Short reviews of the brand and/or the products it represents.
     *
     */
    reviews?: string[];
}
/**
 * A executable chunk of code.
 *
 */
export interface CodeChunk {
    /**
     * The name of the type and all descendant types.
     */
    type: "CodeChunk";
    /**
     * The identifier for this item.
     */
    id?: string;
    /**
     * Alternate names (aliases) for the item.
     */
    alternateNames?: string[];
    /**
     * A description of the item.
     */
    description?: string;
    /**
     * Metadata associated with this item.
     */
    meta?: {
        [k: string]: any;
    };
    /**
     * The name of the item.
     */
    name?: string;
    /**
     * The URL of the item.
     */
    url?: string;
    /**
     * The authors of this this creative work.
     */
    authors?: (Person | Organization)[];
    /**
     * Citations or references to other creative works, such as another publication,
     * web page, scholarly article, etc.
     *
     */
    citations?: (string | CreativeWork)[];
    /**
     * The structured content of this creative work c.f. property `text`.
     */
    content?: Node[];
    /**
     * Date/time of creation.
     */
    dateCreated?: string;
    /**
     * Date/time of most recent modification.
     */
    dateModified?: string;
    /**
     * Date of first publication.
     */
    datePublished?: string;
    /**
     * Persons who edited the CreativeWork.
     *
     */
    editors?: Person[];
    /**
     * Person or organisation that funded the CreativeWork.
     *
     */
    funders?: (Person | Organization)[];
    /**
     * An item or other CreativeWork that this CreativeWork is a part of.
     *
     */
    isPartOf?: CreativeWork;
    /**
     * License documents that applies to this content, typically indicated by URL.
     *
     */
    licenses?: (string | CreativeWork)[];
    /**
     * Elements of the collection which can be a variety of different elements,
     * such as Articles, Datatables, Tables and more.
     *
     */
    parts?: CreativeWork[];
    /**
     * A publisher of the CreativeWork.
     *
     */
    publisher?: Person | Organization;
    /**
     * The textual content of this creative work.
     */
    text?: string;
    title?: string;
    version?: string | number;
    /**
     * Link to the repository where the un-compiled, human readable code and related code is located (SVN, github, CodePlex)
     *
     */
    codeRepository?: string;
    /**
     * What type of code sample: full (compile ready) solution, code snippet, inline code, scripts, template.
     *
     */
    codeSampleType?: string;
    /**
     * The people or organizations who maintain the software.
     *
     */
    maintainers?: [Organization, Person];
    /**
     * The computer programming language.
     *
     */
    programmingLanguage?: string;
    /**
     * Runtime platform or script interpreter dependencies (Example - Java v1, Python2.3, .Net Framework 3.0).
     *
     */
    runtimePlatform?: [string];
    /**
     * Component dependency requirements for application.
     * This includes runtime environments and shared libraries that
     * are not included in the application distribution package, but
     * required to run the application (Examples include DirectX, Java or .NET runtime).
     *
     */
    softwareRequirements?: (SoftwareSourceCode | SoftwareApplication | string)[];
    /**
     * Target Operating System / Product to which the code applies.
     * If applies to several versions, just the product name can be used.
     *
     */
    targetProducts?: [SoftwareApplication];
    /**
     * Outputs from executing the chunk.
     *
     */
    outputs?: Node[];
}
/**
 * An expression.
 */
export interface CodeExpr {
    /**
     * The name of the type and all descendant types.
     */
    type: "CodeExpr";
    /**
     * The identifier for this item.
     */
    id?: string;
    /**
     * Alternate names (aliases) for the item.
     */
    alternateNames?: string[];
    /**
     * A description of the item.
     */
    description?: string;
    /**
     * Metadata associated with this item.
     */
    meta?: {
        [k: string]: any;
    };
    /**
     * The name of the item.
     */
    name?: string;
    /**
     * The URL of the item.
     */
    url?: string;
    /**
     * The authors of this this creative work.
     */
    authors?: (Person | Organization)[];
    /**
     * Citations or references to other creative works, such as another publication,
     * web page, scholarly article, etc.
     *
     */
    citations?: (string | CreativeWork)[];
    /**
     * The structured content of this creative work c.f. property `text`.
     */
    content?: Node[];
    /**
     * Date/time of creation.
     */
    dateCreated?: string;
    /**
     * Date/time of most recent modification.
     */
    dateModified?: string;
    /**
     * Date of first publication.
     */
    datePublished?: string;
    /**
     * Persons who edited the CreativeWork.
     *
     */
    editors?: Person[];
    /**
     * Person or organisation that funded the CreativeWork.
     *
     */
    funders?: (Person | Organization)[];
    /**
     * An item or other CreativeWork that this CreativeWork is a part of.
     *
     */
    isPartOf?: CreativeWork;
    /**
     * License documents that applies to this content, typically indicated by URL.
     *
     */
    licenses?: (string | CreativeWork)[];
    /**
     * Elements of the collection which can be a variety of different elements,
     * such as Articles, Datatables, Tables and more.
     *
     */
    parts?: CreativeWork[];
    /**
     * A publisher of the CreativeWork.
     *
     */
    publisher?: Person | Organization;
    /**
     * The textual content of this creative work.
     */
    text?: string;
    title?: string;
    version?: string | number;
    /**
     * Link to the repository where the un-compiled, human readable code and related code is located (SVN, github, CodePlex)
     *
     */
    codeRepository?: string;
    /**
     * What type of code sample: full (compile ready) solution, code snippet, inline code, scripts, template.
     *
     */
    codeSampleType?: string;
    /**
     * The people or organizations who maintain the software.
     *
     */
    maintainers?: [Organization, Person];
    /**
     * The computer programming language.
     *
     */
    programmingLanguage?: string;
    /**
     * Runtime platform or script interpreter dependencies (Example - Java v1, Python2.3, .Net Framework 3.0).
     *
     */
    runtimePlatform?: [string];
    /**
     * Component dependency requirements for application.
     * This includes runtime environments and shared libraries that
     * are not included in the application distribution package, but
     * required to run the application (Examples include DirectX, Java or .NET runtime).
     *
     */
    softwareRequirements?: (SoftwareSourceCode | SoftwareApplication | string)[];
    /**
     * Target Operating System / Product to which the code applies.
     * If applies to several versions, just the product name can be used.
     *
     */
    targetProducts?: [SoftwareApplication];
    value?: Node;
}
/**
 * Describes a volume mount from a host to container.
 *
 */
export interface Mount {
    /**
     * The name of the type and all descendant types.
     */
    type: "Mount";
    /**
     * The identifier for this item.
     */
    id?: string;
    /**
     * Alternate names (aliases) for the item.
     */
    alternateNames?: string[];
    /**
     * A description of the item.
     */
    description?: string;
    /**
     * Metadata associated with this item.
     */
    meta?: {
        [k: string]: any;
    };
    /**
     * The name of the item.
     */
    name?: string;
    /**
     * The URL of the item.
     */
    url?: string;
    /**
     * The mount source directory on the host.
     */
    mountSource?: string;
    /**
     * The mount location inside the container.
     */
    mountDestination: string;
    /**
     * A list of options to use when applying the mount.
     */
    mountOptions?: [string];
    /**
     * The type of mount.
     */
    mountType?: string;
}
/**
 * Describes limits or requested amounts for a particular resource (e.g. memory or CPU).
 *
 */
export interface ResourceParameters {
    /**
     * The name of the type and all descendant types.
     */
    type: "ResourceParameters";
    /**
     * The identifier for this item.
     */
    id?: string;
    /**
     * Alternat