@atomist/sdm-pack-aspect/src/lib/tree/sunburst.ts

an Atomist SDM Extension Pack for visualizing drift across an organization

/*
 * 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 { Tag } from "../aspect/AspectRegistry";

/**
 * Information about the use of tags within a repo
 */
export interface TagUsage extends Tag {
    count: number;
}

/**
 * SunburstTree with accompanying metadata about the meaning of each level
 */
export interface PlantedTree {
    tree: SunburstTree;
    circles: SunburstCircleMetadata[];
    errors?: Array<{ message: string }>;
    tags?: TagUsage[];
}

export interface SunburstCircleMetadata {
    meaning: string;
}

/**
 * Tree with leafs with a size element
 */
export interface SunburstTree {
    name: string;
    children: Array<SunburstTree | SunburstLeaf>;
}

export interface SunburstLeaf {
    name: string;
    size: number;
}

export type SunburstLevel = SunburstTree | SunburstLeaf;

export function isSunburstTree(level: SunburstLevel): level is SunburstTree {
    const maybe = level as SunburstTree;
    return maybe.children !== undefined;
}