paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 44 Packages Projects Releases Wiki Activity

Adding a deprecation message for the types

Browse Source 
Signed-off-by: Andres Mauricio Gomez P <andmagom@outlook.com>
This commit is contained in:
Andres Mauricio Gomez P
2023-12-12 11:37:36 -05:00
parent 19248768c5
commit 472a47f163
4 changed files with 156 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/kubernetes-backend/api-report.md
+72 -48
View File
@@ -3,25 +3,20 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { AuthenticationStrategy } from '@backstage/plugin-kubernetes-node';
import { AuthMetadata } from '@backstage/plugin-kubernetes-node';
import { AuthenticationStrategy as AuthenticationStrategy_2 } from '@backstage/plugin-kubernetes-node';
import { CatalogApi } from '@backstage/catalog-client';
import { ClusterDetails } from '@backstage/plugin-kubernetes-node';
import { ClusterDetails as ClusterDetails_2 } from '@backstage/plugin-kubernetes-node';
import { Config } from '@backstage/config';
import { CustomResource } from '@backstage/plugin-kubernetes-node';
import { CustomResourcesByEntity } from '@backstage/plugin-kubernetes-node';
import { CustomResource as CustomResource_2 } from '@backstage/plugin-kubernetes-node';
import { Duration } from 'luxon';
import express from 'express';
import { KubernetesClustersSupplier } from '@backstage/plugin-kubernetes-node';
import { KubernetesCredential } from '@backstage/plugin-kubernetes-node';
import { KubernetesFetcher } from '@backstage/plugin-kubernetes-node';
import { KubernetesObjectsByEntity } from '@backstage/plugin-kubernetes-node';
import { KubernetesObjectsProvider } from '@backstage/plugin-kubernetes-node';
import * as k8sAuthTypes from '@backstage/plugin-kubernetes-node';
import { KubernetesClustersSupplier as KubernetesClustersSupplier_2 } from '@backstage/plugin-kubernetes-node';
import { KubernetesObjectsProvider as KubernetesObjectsProvider_2 } from '@backstage/plugin-kubernetes-node';
import { KubernetesRequestAuth } from '@backstage/plugin-kubernetes-common';
import type { KubernetesRequestBody } from '@backstage/plugin-kubernetes-common';
import { KubernetesServiceLocator } from '@backstage/plugin-kubernetes-node';
import { Logger } from 'winston';
import { ObjectToFetch } from '@backstage/plugin-kubernetes-node';
import { ObjectToFetch as ObjectToFetch_2 } from '@backstage/plugin-kubernetes-node';
import { PermissionEvaluator } from '@backstage/plugin-permission-common';
import { PluginEndpointDiscovery } from '@backstage/backend-common';
import { RequestHandler } from 'http-proxy-middleware';
@@ -46,9 +41,11 @@ export class AnonymousStrategy implements AuthenticationStrategy {
validateCluster(): Error[];
}
export { AuthenticationStrategy };
// @public @deprecated (undocumented)
export type AuthenticationStrategy = k8sAuthTypes.AuthenticationStrategy;
export { AuthMetadata };
// @public @deprecated (undocumented)
export type AuthMetadata = k8sAuthTypes.AuthMetadata;
// @public (undocumented)
export class AwsIamStrategy implements AuthenticationStrategy {
@@ -68,12 +65,17 @@ export class AzureIdentityStrategy implements AuthenticationStrategy {
validateCluster(): Error[];
}
export { ClusterDetails };
// @public @deprecated (undocumented)
export type ClusterDetails = k8sAuthTypes.ClusterDetails;
// @public @deprecated
export function createRouter(options: RouterOptions): Promise<express.Router>;
export { CustomResourcesByEntity };
// @public @deprecated (undocumented)
export type CustomResource = k8sAuthTypes.CustomResource;
// @public @deprecated (undocumented)
export type CustomResourcesByEntity = k8sAuthTypes.CustomResourcesByEntity;
// @public (undocumented)
export const DEFAULT_OBJECTS: ObjectToFetch[];
@@ -97,6 +99,9 @@ export type DispatchStrategyOptions = {
};
};
// @public @deprecated (undocumented)
export type FetchResponseWrapper = k8sAuthTypes.FetchResponseWrapper;
// @public (undocumented)
export class GoogleServiceAccountStrategy implements AuthenticationStrategy {
// (undocumented)
@@ -131,37 +136,37 @@ export class KubernetesBuilder {
build(): KubernetesBuilderReturn;
// (undocumented)
protected buildAuthStrategyMap(): {
[key: string]: AuthenticationStrategy;
[key: string]: AuthenticationStrategy_2;
};
// (undocumented)
protected buildClusterSupplier(
refreshInterval: Duration,
): KubernetesClustersSupplier;
): KubernetesClustersSupplier_2;
// (undocumented)
protected buildCustomResources(): CustomResource[];
protected buildCustomResources(): CustomResource_2[];
// (undocumented)
protected buildFetcher(): KubernetesFetcher;
// (undocumented)
protected buildHttpServiceLocator(
_clusterSupplier: KubernetesClustersSupplier,
_clusterSupplier: KubernetesClustersSupplier_2,
): KubernetesServiceLocator;
// (undocumented)
protected buildMultiTenantServiceLocator(
clusterSupplier: KubernetesClustersSupplier,
clusterSupplier: KubernetesClustersSupplier_2,
): KubernetesServiceLocator;
// (undocumented)
protected buildObjectsProvider(
options: KubernetesObjectsProviderOptions,
): KubernetesObjectsProvider;
): KubernetesObjectsProvider_2;
// (undocumented)
protected buildProxy(
logger: Logger,
clusterSupplier: KubernetesClustersSupplier,
clusterSupplier: KubernetesClustersSupplier_2,
): KubernetesProxy;
// (undocumented)
protected buildRouter(
objectsProvider: KubernetesObjectsProvider,
clusterSupplier: KubernetesClustersSupplier,
objectsProvider: KubernetesObjectsProvider_2,
clusterSupplier: KubernetesClustersSupplier_2,
catalogApi: CatalogApi,
proxy: KubernetesProxy,
permissionApi: PermissionEvaluator,
@@ -169,11 +174,11 @@ export class KubernetesBuilder {
// (undocumented)
protected buildServiceLocator(
method: ServiceLocatorMethod,
clusterSupplier: KubernetesClustersSupplier,
clusterSupplier: KubernetesClustersSupplier_2,
): KubernetesServiceLocator;
// (undocumented)
protected buildSingleTenantServiceLocator(
clusterSupplier: KubernetesClustersSupplier,
clusterSupplier: KubernetesClustersSupplier_2,
): KubernetesServiceLocator;
// (undocumented)
static createBuilder(env: KubernetesEnvironment): KubernetesBuilder;
@@ -181,26 +186,26 @@ export class KubernetesBuilder {
protected readonly env: KubernetesEnvironment;
// (undocumented)
protected fetchClusterDetails(
clusterSupplier: KubernetesClustersSupplier,
): Promise<ClusterDetails[]>;
clusterSupplier: KubernetesClustersSupplier_2,
): Promise<ClusterDetails_2[]>;
// (undocumented)
protected getAuthStrategyMap(): {
[key: string]: AuthenticationStrategy;
[key: string]: AuthenticationStrategy_2;
};
// (undocumented)
protected getClusterSupplier(): KubernetesClustersSupplier;
protected getClusterSupplier(): KubernetesClustersSupplier_2;
// (undocumented)
protected getFetcher(): KubernetesFetcher;
// (undocumented)
protected getObjectsProvider(
options: KubernetesObjectsProviderOptions,
): KubernetesObjectsProvider;
): KubernetesObjectsProvider_2;
// (undocumented)
protected getObjectTypesToFetch(): ObjectToFetch[] | undefined;
protected getObjectTypesToFetch(): ObjectToFetch_2[] | undefined;
// (undocumented)
protected getProxy(
logger: Logger,
clusterSupplier: KubernetesClustersSupplier,
clusterSupplier: KubernetesClustersSupplier_2,
): KubernetesProxy;
// (undocumented)
protected getServiceLocator(): KubernetesServiceLocator;
@@ -211,13 +216,13 @@ export class KubernetesBuilder {
[key: string]: AuthenticationStrategy;
}): void;
// (undocumented)
setClusterSupplier(clusterSupplier?: KubernetesClustersSupplier): this;
setClusterSupplier(clusterSupplier?: KubernetesClustersSupplier_2): this;
// (undocumented)
setDefaultClusterRefreshInterval(refreshInterval: Duration): this;
// (undocumented)
setFetcher(fetcher?: KubernetesFetcher): this;
// (undocumented)
setObjectsProvider(objectsProvider?: KubernetesObjectsProvider): this;
setObjectsProvider(objectsProvider?: KubernetesObjectsProvider_2): this;
// (undocumented)
setProxy(proxy?: KubernetesProxy): this;
// (undocumented)
@@ -227,20 +232,23 @@ export class KubernetesBuilder {
// @public
export type KubernetesBuilderReturn = Promise<{
router: express.Router;
clusterSupplier: KubernetesClustersSupplier;
clusterSupplier: KubernetesClustersSupplier_2;
customResources: CustomResource[];
fetcher: KubernetesFetcher;
proxy: KubernetesProxy;
objectsProvider: KubernetesObjectsProvider;
objectsProvider: KubernetesObjectsProvider_2;
serviceLocator: KubernetesServiceLocator;
authStrategyMap: {
[key: string]: AuthenticationStrategy;
};
}>;
export { KubernetesClustersSupplier };
// @public @deprecated (undocumented)
export type KubernetesClustersSupplier =
k8sAuthTypes.KubernetesClustersSupplier;
export { KubernetesCredential };
// @public @deprecated (undocumented)
export type KubernetesCredential = k8sAuthTypes.KubernetesCredential;
// @public (undocumented)
export interface KubernetesEnvironment {
@@ -254,26 +262,31 @@ export interface KubernetesEnvironment {
permissions: PermissionEvaluator;
}
export { KubernetesObjectsByEntity };
// @public @deprecated (undocumented)
export type KubernetesFetcher = k8sAuthTypes.KubernetesFetcher;
export { KubernetesObjectsProvider };
// @public @deprecated (undocumented)
export type KubernetesObjectsProvider = k8sAuthTypes.KubernetesObjectsProvider;
// @public (undocumented)
export interface KubernetesObjectsProviderOptions {
// (undocumented)
config: Config;
// (undocumented)
customResources: CustomResource[];
customResources: k8sAuthTypes.CustomResource[];
// (undocumented)
fetcher: KubernetesFetcher;
fetcher: k8sAuthTypes.KubernetesFetcher;
// (undocumented)
logger: Logger;
// (undocumented)
objectTypesToFetch?: ObjectToFetch[];
objectTypesToFetch?: k8sAuthTypes.ObjectToFetch[];
// (undocumented)
serviceLocator: KubernetesServiceLocator;
serviceLocator: k8sAuthTypes.KubernetesServiceLocator;
}
// @public @deprecated (undocumented)
export type KubernetesObjectTypes = k8sAuthTypes.KubernetesObjectTypes;
// @public
export class KubernetesProxy {
constructor(options: KubernetesProxyOptions);
@@ -295,9 +308,18 @@ export type KubernetesProxyOptions = {
authStrategy: AuthenticationStrategy;
};
// @public @deprecated (undocumented)
export type KubernetesServiceLocator = k8sAuthTypes.KubernetesServiceLocator;
// @public @deprecated (undocumented)
export type ObjectFetchParams = k8sAuthTypes.ObjectFetchParams;
// @public (undocumented)
export type ObjectsByEntityRequest = KubernetesRequestBody;
// @public @deprecated (undocumented)
export type ObjectToFetch = k8sAuthTypes.ObjectToFetch;
// @public (undocumented)
export class OidcStrategy implements AuthenticationStrategy {
// (undocumented)
@@ -336,12 +358,14 @@ export class ServiceAccountStrategy implements AuthenticationStrategy {
// @public (undocumented)
export type ServiceLocatorMethod = 'multiTenant' | 'singleTenant' | 'http';
// @public @deprecated (undocumented)
export type ServiceLocatorRequestContext =
k8sAuthTypes.ServiceLocatorRequestContext;
// @public (undocumented)
export type SigningCreds = {
accessKeyId: string | undefined;
secretAccessKey: string | undefined;
sessionToken: string | undefined;
};
export * from '@backstage/plugin-kubernetes-node';
```
plugins/kubernetes-backend/src/auth/types.ts
+11 -5
View File
@@ -14,9 +14,15 @@
* limitations under the License.
*/
// TODO remove this re-export as a breaking change after a couple of releases
import * as k8sAuthTypes from '@backstage/plugin-kubernetes-node';
export type {
AuthenticationStrategy,
KubernetesCredential,
} from '@backstage/plugin-kubernetes-node';
// TODO remove this re-export as a breaking change after a couple of releases
/**
* @public @deprecated Import it from \@backstage/plugin-kubernetes-node instead
*/
export type AuthenticationStrategy = k8sAuthTypes.AuthenticationStrategy;
/**
* @public @deprecated Import it from \@backstage/plugin-kubernetes-node instead
*/
export type KubernetesCredential = k8sAuthTypes.KubernetesCredential;
plugins/kubernetes-backend/src/types/index.ts
-9
View File
@@ -15,12 +15,3 @@
*/
export * from './types';
export type {
AuthMetadata,
ClusterDetails,
CustomResourcesByEntity,
KubernetesClustersSupplier,
KubernetesObjectsByEntity,
KubernetesObjectsProvider,
} from '@backstage/plugin-kubernetes-node';
plugins/kubernetes-backend/src/types/types.ts
+73 -11
View File
@@ -17,12 +17,7 @@
import { Logger } from 'winston';
import type { KubernetesRequestBody } from '@backstage/plugin-kubernetes-common';
import { Config } from '@backstage/config';
import {
CustomResource,
KubernetesFetcher,
KubernetesServiceLocator,
ObjectToFetch,
} from '@backstage/plugin-kubernetes-node';
import * as k8sTypes from '@backstage/plugin-kubernetes-node';
/**
*
@@ -37,10 +32,10 @@ export type ServiceLocatorMethod = 'multiTenant' | 'singleTenant' | 'http'; // T
export interface KubernetesObjectsProviderOptions {
logger: Logger;
config: Config;
fetcher: KubernetesFetcher;
serviceLocator: KubernetesServiceLocator;
customResources: CustomResource[];
objectTypesToFetch?: ObjectToFetch[];
fetcher: k8sTypes.KubernetesFetcher;
serviceLocator: k8sTypes.KubernetesServiceLocator;
customResources: k8sTypes.CustomResource[];
objectTypesToFetch?: k8sTypes.ObjectToFetch[];
}
/**
@@ -50,4 +45,71 @@ export interface KubernetesObjectsProviderOptions {
export type ObjectsByEntityRequest = KubernetesRequestBody;
// TODO remove this re-export as a breaking change after a couple of releases
export type * from '@backstage/plugin-kubernetes-node';
/**
* @public @deprecated Import it from \@backstage/plugin-kubernetes-node instead
*/
export type KubernetesObjectsProvider = k8sTypes.KubernetesObjectsProvider;
/**
* @public @deprecated Import it from \@backstage/plugin-kubernetes-node instead
*/
export type CustomResourcesByEntity = k8sTypes.CustomResourcesByEntity;
/**
* @public
* @deprecated Import it from \@backstage/plugin-kubernetes-node instead
*/
export type AuthMetadata = k8sTypes.AuthMetadata;
/**
* @public
* @deprecated Import it from \@backstage/plugin-kubernetes-node instead
*/
export type ClusterDetails = k8sTypes.ClusterDetails;
/**
* @public
* @deprecated Import it from \@backstage/plugin-kubernetes-node instead
*/
export type KubernetesClustersSupplier = k8sTypes.KubernetesClustersSupplier;
/**
* @public @deprecated Import it from \@backstage/plugin-kubernetes-node instead
*/
export type KubernetesObjectTypes = k8sTypes.KubernetesObjectTypes;
/**
* @public @deprecated Import it from \@backstage/plugin-kubernetes-node instead
*/
export type ObjectToFetch = k8sTypes.ObjectToFetch;
/**
* @public @deprecated Import it from \@backstage/plugin-kubernetes-node instead
*/
export type CustomResource = k8sTypes.CustomResource;
/**
* @public @deprecated Import it from \@backstage/plugin-kubernetes-node instead
*/
export type ObjectFetchParams = k8sTypes.ObjectFetchParams;
/**
* @public @deprecated Import it from \@backstage/plugin-kubernetes-node instead
*/
export type FetchResponseWrapper = k8sTypes.FetchResponseWrapper;
/**
* @public @deprecated Import it from \@backstage/plugin-kubernetes-node instead
*/
export type KubernetesFetcher = k8sTypes.KubernetesFetcher;
/**
* @public @deprecated Import it from \@backstage/plugin-kubernetes-node instead
*/
export type ServiceLocatorRequestContext =
k8sTypes.ServiceLocatorRequestContext;
/**
* @public @deprecated Import it from \@backstage/plugin-kubernetes-node instead
*/
export type KubernetesServiceLocator = k8sTypes.KubernetesServiceLocator;