@openshift-console/dynamic-plugin-sdk/lib/extensions/topology-details.d.ts

Provides core APIs, types and utilities used by dynamic plugins at runtime.

import * as React from 'react';
import { GraphElement } from '@patternfly/react-topology';
import { ExtensionHook } from '../api/common-types';
import { Extension, CodeRef, ExtensionDeclaration } from '../types';
import { K8sResourceCommon } from './console-types';
import { BuildConfigData } from './topology-types';
/** DetailsTab contributes a tab for the topology details panel. */
export type DetailsTab = ExtensionDeclaration<'console.topology/details/tab', {
    /** A unique identifier for this details tab. */
    id: string;
    /** The tab label to display in the UI. */
    label: string;
    /** Insert this item before the item referenced here.
     * For arrays, the first one found in order is used.
     * */
    insertBefore?: string | string[];
    /** Insert this item after the item referenced here.
     * For arrays, the first one found in order is used.
     * insertBefore takes precedence.
     * */
    insertAfter?: string | string[];
}>;
/** DetailsTabSection contributes a section for a specific tab in topology details panel. */
export type DetailsTabSection = ExtensionDeclaration<'console.topology/details/tab-section', {
    /** A unique identifier for this details tab section. */
    id: string;
    /** The parent tab ID that this section should contribute to. */
    tab: string;
    /** A hook that returns a component or null/undefined that will be rendered
     * in the topology sidebar.
     * SDK component: <Section title={<optional>}>... padded area </Section>
     * */
    provider: CodeRef<DetailsTabSectionExtensionHook>;
    /** Returns a section for the graph element or undefined if not provided.
     * @deprecated Fallback if no provider is defined. renderNull is a no-op already.
     */
    section: CodeRef<(element: GraphElement, renderNull?: () => null) => React.Component | undefined>;
    /** Insert this item before the item referenced here.
     * For arrays, the first one found in order is used.
     * */
    insertBefore?: string | string[];
    /** Insert this item after the item referenced here.
     * For arrays, the first one found in order is used.
     * insertBefore takes precedence.
     * */
    insertAfter?: string | string[];
}>;
/** DetailsResourceLink contributes a link for specific topology context or graph element. */
export type DetailsResourceLink = ExtensionDeclaration<'console.topology/details/resource-link', {
    /** A higher priority factory will get the first chance to create the link. */
    priority?: number;
    /** Return the resource link if provided, otherwise undefined.
     * Use ResourceIcon and ResourceLink for styles.
     * */
    link: CodeRef<(element: GraphElement) => React.Component | undefined>;
}>;
/** DetailsResourceAlert contributes an alert for specific topology context or graph element. */
export type DetailsResourceAlert = ExtensionDeclaration<'console.topology/details/resource-alert', {
    /** The ID of this alert. Used to save state if the alert shouldn't be shown after dismissed. */
    id: string;
    /** Hook to return the contents of the Alert. */
    contentProvider: CodeRef<(element: GraphElement) => DetailsResourceAlertContent | null>;
}>;
/** PodAdapter contributes an adapter to adapt element to data that can be used by Pod component */
export type PodAdapter = ExtensionDeclaration<'console.topology/adapter/pod', {
    /** adapter to adapt element to data that can be used by Pod component. */
    adapt: CodeRef<(element: GraphElement) => AdapterDataType<PodsAdapterDataType> | undefined>;
}>;
/** BuildAdapter contributes an adapter to adapt element to data that can be used by Build component */
export type BuildAdapter = ExtensionDeclaration<'console.topology/adapter/build', {
    /** adapter to adapt element to data that can be used by Build component. */
    adapt: CodeRef<(element: GraphElement) => AdapterDataType<BuildConfigData> | undefined>;
}>;
/** NetworkAdpater contributes an adapter to adapt element to data that can be used by Networking component */
export type NetworkAdapter = ExtensionDeclaration<'console.topology/adapter/network', {
    /** adapter to adapt element to data that can be used by Networking component. */
    adapt: CodeRef<(element: GraphElement) => NetworkAdapterType | undefined>;
}>;
export type SupportedTopologyDetailsExtensions = DetailsTab | DetailsTabSection | DetailsResourceLink | DetailsResourceAlert | PodAdapter | BuildAdapter | NetworkAdapter;
export declare const isDetailsTab: (e: Extension) => e is DetailsTab;
export declare const isDetailsTabSection: (e: Extension) => e is DetailsTabSection;
export declare const isDetailsResourceLink: (e: Extension) => e is DetailsResourceLink;
export declare const isDetailsResourceAlert: (e: Extension) => e is DetailsResourceAlert;
export declare const isPodAdapter: (e: Extension) => e is PodAdapter;
export declare const isBuildAdapter: (e: Extension) => e is BuildAdapter;
export declare const isNetworkAdapter: (e: Extension) => e is NetworkAdapter;
export type DetailsResourceAlertContent = {
    /** The title of the alert */
    title: string;
    /** Whether to show a dismiss button. false by default.
     * State will be store in user settings, once dismissed alert won't show up again untill user settings state resets
     */
    dismissible?: boolean;
    content: React.Component | undefined | JSX.Element | string;
    variant?: 'success' | 'danger' | 'warning' | 'info' | 'custom';
    actionLinks?: React.ReactNode;
};
export type AdapterDataType<D = {}, T = {}> = {
    resource: K8sResourceCommon;
    data?: T;
    provider: (resource: K8sResourceCommon, data?: T) => D;
};
export type PodsAdapterDataType<E = K8sResourceCommon> = {
    pods: E[];
    loaded: boolean;
    loadError: string;
    emptyText?: string;
    allPodsLink?: string;
    buildConfigData?: BuildConfigData;
};
export type NetworkAdapterType = {
    resource: K8sResourceCommon;
};
export type DetailsTabSectionExtensionHook = ExtensionHook<React.ReactElement | undefined, GraphElement>;