@atomist/cortex/Review.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 { PullRequest } from "./PullRequest";
export { Review };

/**
 * Type Review
 */
interface Review extends GraphNode {

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

    /**
     * by - Review -> GitHubId
     *
     * @property {GitHubId[]} by
     */
    readonly by: GitHubId[];

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

    /**
     * commit - Review -> Commit
     *
     * @property {Commit} commit
     */
    readonly commit: Commit;

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

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

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

    /**
     * pullRequest - Review -> PullRequest
     *
     * @property {PullRequest} pullRequest
     */
    readonly pullRequest: PullRequest;

    /**
     * state
     *
     * @property {"requested" | "pending" | "approved"} state
     */
    readonly state: "requested" | "pending" | "approved";

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

}