@backstage/plugin-kubernetes-react 0.1.2-next.0 → 0.2.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,36 @@
 # @backstage/plugin-kubernetes-react
 
+## 0.2.0-next.2
+
+### Minor Changes
+
+- 899d71a: Change `formatClusterLink` to be an API and make it async for further customization possibilities.
+
+  **BREAKING**
+  If you have a custom k8s page and used `formatClusterLink` directly, you need to migrate to new `kubernetesClusterLinkFormatterApiRef`
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/catalog-model@1.4.3
+  - @backstage/core-components@0.13.9-next.2
+  - @backstage/core-plugin-api@1.8.1-next.1
+  - @backstage/errors@1.2.3
+  - @backstage/types@1.1.1
+  - @backstage/plugin-kubernetes-common@0.7.2-next.1
+
+## 0.1.2-next.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/core-components@0.13.9-next.1
+  - @backstage/core-plugin-api@1.8.1-next.1
+  - @backstage/plugin-kubernetes-common@0.7.2-next.1
+  - @backstage/catalog-model@1.4.3
+  - @backstage/errors@1.2.3
+  - @backstage/types@1.1.1
+
 ## 0.1.2-next.0
 
 ### Patch Changes

package/dist/index.d.ts

@@ -8,10 +8,10 @@ import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
 import { OAuthApi, OpenIdConnectApi, DiscoveryApi, IdentityApi } from '@backstage/core-plugin-api';
 import * as kubernetes_models_v1 from 'kubernetes-models/v1';
 import { Event, Pod, IContainer, IContainerStatus } from 'kubernetes-models/v1';
+import { JsonObject } from '@backstage/types';
 import { V1HorizontalPodAutoscaler, V1Job, V1ObjectMeta, V1Pod } from '@kubernetes/client-node';
 import * as react_use_lib_useAsyncFn from 'react-use/lib/useAsyncFn';
 import { Pod as Pod$1 } from 'kubernetes-models/v1/Pod';
-import { JsonObject } from '@backstage/types';
 
 /**
  *
@@ -101,6 +101,8 @@ declare const kubernetesApiRef: _backstage_core_plugin_api.ApiRef<KubernetesApi>
 /** @public */
 declare const kubernetesProxyApiRef: _backstage_core_plugin_api.ApiRef<KubernetesProxyApi>;
 /** @public */
+declare const kubernetesClusterLinkFormatterApiRef: _backstage_core_plugin_api.ApiRef<KubernetesClusterLinkFormatterApi>;
+/** @public */
 interface KubernetesApi {
     getObjectsByEntity(requestBody: KubernetesRequestBody): Promise<ObjectsByEntityResponse>;
     getClusters(): Promise<{
@@ -139,6 +141,20 @@ interface KubernetesProxyApi {
         namespace: string;
     }): Promise<Event[]>;
 }
+/**
+ * @public
+ */
+type FormatClusterLinkOptions = {
+    dashboardUrl?: string;
+    dashboardApp?: string;
+    dashboardParameters?: JsonObject;
+    object: any;
+    kind: string;
+};
+/** @public */
+interface KubernetesClusterLinkFormatterApi {
+    formatClusterLink(options: FormatClusterLinkOptions): Promise<string | undefined>;
+}
 
 /** @public */
 interface KubernetesAuthProvider {
@@ -248,6 +264,33 @@ declare class KubernetesBackendClient implements KubernetesApi {
     private static getKubernetesAuthHeaderByAuthProvider;
 }
 
+/**
+ * @public
+ */
+interface ClusterLinksFormatterOptions {
+    dashboardUrl?: URL;
+    dashboardParameters?: JsonObject;
+    object: any;
+    kind: string;
+}
+/**
+ * @public
+ */
+interface ClusterLinksFormatter {
+    formatClusterLink(options: ClusterLinksFormatterOptions): Promise<URL>;
+}
+
+/** @public */
+declare class KubernetesClusterLinkFormatter implements KubernetesClusterLinkFormatterApi {
+    private readonly formatters;
+    private readonly defaultFormatterName;
+    constructor(options: {
+        formatters: Record<string, ClusterLinksFormatter>;
+        defaultFormatterName: string;
+    });
+    formatClusterLink(options: FormatClusterLinkOptions): Promise<string | undefined>;
+}
+
 /**
  * A client for common requests through the proxy endpoint of the kubernetes backend plugin.
  *
@@ -276,6 +319,41 @@ declare class KubernetesProxyClient {
     }>;
 }
 
+/** @public */
+declare class AksClusterLinksFormatter implements ClusterLinksFormatter {
+    formatClusterLink(options: ClusterLinksFormatterOptions): Promise<URL>;
+}
+
+/** @public */
+declare class EksClusterLinksFormatter implements ClusterLinksFormatter {
+    formatClusterLink(_options: ClusterLinksFormatterOptions): Promise<URL>;
+}
+
+/** @public */
+declare class GkeClusterLinksFormatter implements ClusterLinksFormatter {
+    formatClusterLink(options: ClusterLinksFormatterOptions): Promise<URL>;
+}
+
+/** @public */
+declare class StandardClusterLinksFormatter implements ClusterLinksFormatter {
+    formatClusterLink(options: ClusterLinksFormatterOptions): Promise<URL>;
+}
+
+/** @public */
+declare class OpenshiftClusterLinksFormatter {
+    formatClusterLink(options: ClusterLinksFormatterOptions): Promise<URL>;
+}
+
+/** @public */
+declare class RancherClusterLinksFormatter implements ClusterLinksFormatter {
+    formatClusterLink(options: ClusterLinksFormatterOptions): Promise<URL>;
+}
+
+/** @public */
+declare const DEFAULT_FORMATTER_NAME = "standard";
+/** @public */
+declare function getDefaultFormatters(_deps: {}): Record<string, ClusterLinksFormatter>;
+
 /**
  * Props for Cluster
  *
@@ -780,38 +858,4 @@ declare const PodExecTerminal: (props: PodExecTerminalProps) => React__default.J
  */
 declare const PodExecTerminalDialog: (props: PodExecTerminalProps) => React__default.JSX.Element;
 
-/**
- * @public
- */
-type FormatClusterLinkOptions = {
-    dashboardUrl?: string;
-    dashboardApp?: string;
-    dashboardParameters?: JsonObject;
-    object: any;
-    kind: string;
-};
-/**
- * @public
- */
-declare function formatClusterLink(options: FormatClusterLinkOptions): string | undefined;
-
-/**
- * @public
- */
-interface ClusterLinksFormatterOptions {
-    dashboardUrl?: URL;
-    dashboardParameters?: JsonObject;
-    object: any;
-    kind: string;
-}
-/**
- * @public
- */
-type ClusterLinksFormatter = (options: ClusterLinksFormatterOptions) => URL;
-
-/**
- * @public
- */
-declare const clusterLinksFormatters: Record<string, ClusterLinksFormatter>;
-
-export { AksKubernetesAuthProvider, Cluster, ClusterContext, ClusterLinksFormatter, ClusterLinksFormatterOptions, ClusterProps, ContainerCard, ContainerCardProps, ContainerScope, CronJobsAccordions, CronJobsAccordionsProps, CustomResources, CustomResourcesProps, DetectedErrorsContext, ErrorList, ErrorListProps, ErrorMatcher, ErrorPanel, ErrorPanelProps, ErrorReporting, ErrorReportingProps, Events, EventsContent, EventsContentProps, EventsOptions, EventsProps, FixDialog, FixDialogProps, FormatClusterLinkOptions, GoogleKubernetesAuthProvider, GroupedResponsesContext, HorizontalPodAutoscalerDrawer, IngressesAccordions, IngressesAccordionsProps, JobsAccordions, JobsAccordionsProps, KubernetesApi, KubernetesAuthProvider, KubernetesAuthProviders, KubernetesAuthProvidersApi, KubernetesBackendClient, KubernetesDrawer, KubernetesDrawerProps, KubernetesDrawerable, KubernetesObject, KubernetesObjects, KubernetesProxyApi, KubernetesProxyClient, KubernetesStructuredMetadataTableDrawer, KubernetesStructuredMetadataTableDrawerProps, LinkErrorPanel, LinkErrorPanelProps, ManifestYaml, ManifestYamlProps, OidcKubernetesAuthProvider, PendingPodContent, PendingPodContentProps, PodAndErrors, PodColumns, PodDrawer, PodDrawerProps, PodExecTerminal, PodExecTerminalDialog, PodExecTerminalProps, PodLogs, PodLogsDialog, PodLogsDialogProps, PodLogsOptions, PodLogsProps, PodMetricsContext, PodMetricsMatcher, PodNamesWithErrorsContext, PodNamesWithMetricsContext, PodScope, PodsTable, PodsTablesProps, READY_COLUMNS, RESOURCE_COLUMNS, ResourceUtilization, ResourceUtilizationProps, ServerSideKubernetesAuthProvider, ServicesAccordions, ServicesAccordionsProps, clusterLinksFormatters, formatClusterLink, kubernetesApiRef, kubernetesAuthProvidersApiRef, kubernetesProxyApiRef, useCustomResources, useEvents, useKubernetesObjects, useMatchingErrors, usePodLogs, usePodMetrics };
+export { AksClusterLinksFormatter, AksKubernetesAuthProvider, Cluster, ClusterContext, ClusterLinksFormatter, ClusterLinksFormatterOptions, ClusterProps, ContainerCard, ContainerCardProps, ContainerScope, CronJobsAccordions, CronJobsAccordionsProps, CustomResources, CustomResourcesProps, DEFAULT_FORMATTER_NAME, DetectedErrorsContext, EksClusterLinksFormatter, ErrorList, ErrorListProps, ErrorMatcher, ErrorPanel, ErrorPanelProps, ErrorReporting, ErrorReportingProps, Events, EventsContent, EventsContentProps, EventsOptions, EventsProps, FixDialog, FixDialogProps, FormatClusterLinkOptions, GkeClusterLinksFormatter, GoogleKubernetesAuthProvider, GroupedResponsesContext, HorizontalPodAutoscalerDrawer, IngressesAccordions, IngressesAccordionsProps, JobsAccordions, JobsAccordionsProps, KubernetesApi, KubernetesAuthProvider, KubernetesAuthProviders, KubernetesAuthProvidersApi, KubernetesBackendClient, KubernetesClusterLinkFormatter, KubernetesClusterLinkFormatterApi, KubernetesDrawer, KubernetesDrawerProps, KubernetesDrawerable, KubernetesObject, KubernetesObjects, KubernetesProxyApi, KubernetesProxyClient, KubernetesStructuredMetadataTableDrawer, KubernetesStructuredMetadataTableDrawerProps, LinkErrorPanel, LinkErrorPanelProps, ManifestYaml, ManifestYamlProps, OidcKubernetesAuthProvider, OpenshiftClusterLinksFormatter, PendingPodContent, PendingPodContentProps, PodAndErrors, PodColumns, PodDrawer, PodDrawerProps, PodExecTerminal, PodExecTerminalDialog, PodExecTerminalProps, PodLogs, PodLogsDialog, PodLogsDialogProps, PodLogsOptions, PodLogsProps, PodMetricsContext, PodMetricsMatcher, PodNamesWithErrorsContext, PodNamesWithMetricsContext, PodScope, PodsTable, PodsTablesProps, READY_COLUMNS, RESOURCE_COLUMNS, RancherClusterLinksFormatter, ResourceUtilization, ResourceUtilizationProps, ServerSideKubernetesAuthProvider, ServicesAccordions, ServicesAccordionsProps, StandardClusterLinksFormatter, getDefaultFormatters, kubernetesApiRef, kubernetesAuthProvidersApiRef, kubernetesClusterLinkFormatterApiRef, kubernetesProxyApiRef, useCustomResources, useEvents, useKubernetesObjects, useMatchingErrors, usePodLogs, usePodMetrics };