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

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

import { TopologyQuadrant } from '@patternfly/react-topology/dist/esm/types';
import { Extension, ExtensionDeclaration, CodeRef } from '../types';
import { WatchK8sResourcesGeneric } from './console-types';
import { CreateConnectionGetter, RelationshipProviderCreate, RelationshipProviderProvides, TopologyApplyDisplayOptions, TopologyDataModelDepicted, TopologyDataModelGetter, TopologyDataModelReconciler, TopologyDecoratorGetter, TopologyDisplayOption, ViewComponentFactory } from './topology-types';
/** Getter for a ViewComponentFactory */
export type TopologyComponentFactory = ExtensionDeclaration<'console.topology/component/factory', {
    /** Getter for a ViewComponentFactory */
    getFactory: CodeRef<ViewComponentFactory>;
}>;
/** Getter for the create connector function */
export type TopologyCreateConnector = ExtensionDeclaration<'console.topology/create/connector', {
    /** Getter for the create connector function */
    getCreateConnector: CodeRef<CreateConnectionGetter>;
}>;
/** Topology Data Model Factory Extension */
export type TopologyDataModelFactory = ExtensionDeclaration<'console.topology/data/factory', {
    /** Unique ID for the factory. */
    id: string;
    /** Priority for the factory */
    priority: number;
    /** Resources to be fetched from useK8sWatchResources hook. */
    resources?: WatchK8sResourcesGeneric;
    /** Keys in resources containing workloads. */
    workloadKeys?: string[];
    /** Getter for the data model factory */
    getDataModel?: CodeRef<TopologyDataModelGetter>;
    /** Getter for function to determine if a resource is depicted by this model factory */
    isResourceDepicted?: CodeRef<TopologyDataModelDepicted>;
    /** Getter for function to reconcile data model after all extensions' models have loaded */
    getDataModelReconciler?: CodeRef<TopologyDataModelReconciler>;
}>;
/** Topology Display Filters Extension */
export type TopologyDisplayFilters = ExtensionDeclaration<'console.topology/display/filters', {
    /** Getter for topology filters specific to the extension */
    getTopologyFilters: CodeRef<() => TopologyDisplayOption[]>;
    /** Function to apply filters to the model */
    applyDisplayOptions: CodeRef<TopologyApplyDisplayOptions>;
}>;
/** Topology Decorator Provider Extension */
export type TopologyDecoratorProvider = ExtensionDeclaration<'console.topology/decorator/provider', {
    /** id for topology decorator specific to the extension */
    id: string;
    /** priority for topology decorator specific to the extension */
    priority: number;
    /** quadrant for topology decorator specific to the extension */
    quadrant: TopologyQuadrant;
    /** decorator specific to the extension */
    decorator: CodeRef<TopologyDecoratorGetter>;
}>;
/** Topology relationship provider connector extension */
export type TopologyRelationshipProvider = ExtensionDeclaration<'console.topology/relationship/provider', {
    /** use to determine if a connection can be created between the source and target node */
    provides: CodeRef<RelationshipProviderProvides>;
    /** tooltip to show when connector operation is hovering over the drop target ex: "Create a Visual Connector" */
    tooltip: string;
    /** callback to execute when connector is drop over target node to create a connection */
    create: CodeRef<RelationshipProviderCreate>;
    /** priority for relationship, higher will be preferred in case of multiple */
    priority: number;
}>;
export declare const isTopologyComponentFactory: (e: Extension) => e is TopologyComponentFactory;
export declare const isTopologyCreateConnector: (e: Extension) => e is TopologyCreateConnector;
export declare const isTopologyDataModelFactory: (e: Extension) => e is TopologyDataModelFactory;
export declare const isTopologyDisplayFilters: (e: Extension) => e is TopologyDisplayFilters;
export declare const isTopologyDecoratorProvider: (e: Extension) => e is TopologyDecoratorProvider;
export declare const isTopologyRelationshipProvider: (e: Extension) => e is TopologyRelationshipProvider;