@atomist/cortex/Issue.ts

Atomist Cortex model TypeScript typings

/*
 * Copyright 2015-2017 Atomist Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { TreeNode, GraphNode, FormatInfo, PathExpressionEngine } from "@atomist/rug/tree/PathExpression";
import { ProjectContext } from "@atomist/rug/operations/ProjectEditor";
import { Comment } from "./Comment";
import { Commit } from "./Commit";
import { GitHubId } from "./GitHubId";
import { Label } from "./Label";
import { Repo } from "./Repo";
export { Issue };

/**
 * Type Issue
 */
interface Issue extends GraphNode {

    /**
     * action
     *
     * @property {string} action
     */
    readonly action: string;

    /**
     * assignees - Issue -> GitHubId
     *
     * @property {GitHubId[]} assignees
     */
    readonly assignees: GitHubId[];

    /**
     * body
     *
     * @property {string} body
     */
    readonly body: string;

    /**
     * closedAt
     *
     * @property {string} closedAt
     */
    readonly closedAt: string;

    /**
     * closedBy - Issue -> GitHubId
     *
     * @property {GitHubId} closedBy
     */
    readonly closedBy: GitHubId;

    /**
     * comments - Issue -> Comment
     *
     * @property {Comment[]} comments
     */
    readonly comments: Comment[];

    /**
     * createdAt
     *
     * @property {string} createdAt
     */
    readonly createdAt: string;

    /**
     * id
     *
     * @property {string} id
     */
    readonly id: string;

    /**
     * labels - Issue -> Label
     *
     * @property {Label[]} labels
     */
    readonly labels: Label[];

    /**
     * lastAssignedBy - Issue -> GitHubId
     *
     * @property {GitHubId} lastAssignedBy
     */
    readonly lastAssignedBy: GitHubId;

    /**
     * name
     *
     * @property {string} name
     */
    readonly name: string;

    /**
     * number
     *
     * @property {number} number
     */
    readonly number: number;

    /**
     * openedBy - Issue -> GitHubId
     *
     * @property {GitHubId} openedBy
     */
    readonly openedBy: GitHubId;

    /**
     * repo - Issue -> Repo
     *
     * @property {Repo} repo
     */
    readonly repo: Repo;

    /**
     * resolvingCommits - Issue -> Commit
     *
     * @property {Commit[]} resolvingCommits
     */
    readonly resolvingCommits: Commit[];

    /**
     * state
     *
     * @property {"open" | "closed"} state
     */
    readonly state: "open" | "closed";

    /**
     * timestamp
     *
     * @property {string} timestamp
     */
    readonly timestamp: string;

    /**
     * title
     *
     * @property {string} title
     */
    readonly title: string;

    /**
     * updatedAt
     *
     * @property {string} updatedAt
     */
    readonly updatedAt: string;

}