@atomist/sdm/src/lib/api/context/skillContext.ts

Atomist Software Delivery Machine SDK

/*
 * Copyright © 2020 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";

/**
 * Skills get additional contextual information when they
 * execute
 */
export interface SkillContext<C = any> {
    /** Optional configuration of the skill */
    configuration?: SkillConfiguration<C>;
}

/**
 * Skills get configured and the named configuration gets
 * passed to the running command or event handler
 */
export interface SkillConfiguration<C extends Record<string, any> = any> {
    /** Name of the configuration */
    name: string;
    /** */
    parameters: C;
}

/**
 * Helper function to create a SkillContext instance
 * from the passed in HandlerContext
 */
export function createSkillContext<C extends Record<string, any> = any>(ctx: HandlerContext): SkillContext<C> {
    const configuration = (ctx as any)?.trigger?.configuration;
    if (!!configuration) {
        const parameters = {};
        (configuration.parameters || []).forEach(p => parameters[p.name] = p.value);
        const skillContext: SkillContext<C> = {
            configuration: {
                name: configuration.name,
                parameters,
            },
        } as unknown;
        return skillContext;
    }
    return {};
}