@atomist/sdm/src/lib/spi/credentials/CredentialsResolver.ts

Atomist Software Delivery Machine SDK

/*
 * Copyright © 2019 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 { HandlerContext } from "@atomist/automation-client/lib/HandlerContext";
import { ProjectOperationCredentials } from "@atomist/automation-client/lib/operations/common/ProjectOperationCredentials";
import { RemoteRepoRef } from "@atomist/automation-client/lib/operations/common/RepoId";

/**
 * Strategy interface to resolve credentials from a handler invocation.
 */
export interface CredentialsResolver {

    /**
     * Return the appropriate credentials for this event handler invocation.
     * @param {HandlerContext} context
     * @param {RemoteRepoRef} id id of the repo if available
     * @return {ProjectOperationCredentials}
     */
    eventHandlerCredentials(context: HandlerContext, id?: RemoteRepoRef):
        Promise<ProjectOperationCredentials> | ProjectOperationCredentials;

    /**
     * Return the appropriate credentials for this command handler invocation.
     * @param {HandlerContext} context
     * @param {RemoteRepoRef} id id of the repo if available
     * @return {ProjectOperationCredentials}
     */
    commandHandlerCredentials(context: HandlerContext, id?: RemoteRepoRef):
        Promise<ProjectOperationCredentials> | ProjectOperationCredentials;

}