fix remaining alpha exports

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2023-02-02 20:32:59 +01:00
parent 8ce58b40fb
commit 4c08ac06fc
35 changed files with 125 additions and 131 deletions
+1 -2
View File
@@ -3,14 +3,13 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { ReactNode } from 'react';
// @alpha
export interface PluginOptionsProviderProps {
// (undocumented)
children: ReactNode;
// Warning: (ae-forgotten-export) The symbol "BackstagePlugin" needs to be exported by the entry point alpha.d.ts
//
// (undocumented)
plugin?: BackstagePlugin;
}
@@ -19,7 +19,7 @@ import {
createVersionedValueMap,
useVersionedContext,
} from '@backstage/version-bridge';
import { BackstagePlugin } from '../plugin';
import { BackstagePlugin } from '@backstage/core-plugin-api';
import React, { ReactNode } from 'react';
const contextKey: string = 'plugin-context';
@@ -5,8 +5,6 @@
```ts
import { BackendFeature } from '@backstage/backend-plugin-api';
// Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/plugin-catalog-backend-module-github" does not have an export "GithubEntityProvider"
//
// @alpha
export const githubEntityProviderCatalogModule: () => BackendFeature;
@@ -7,7 +7,7 @@ import { AnalyzeOptions } from '@backstage/plugin-catalog-backend';
import { CatalogProcessor } from '@backstage/plugin-catalog-backend';
import { CatalogProcessorEmit } from '@backstage/plugin-catalog-backend';
import { Config } from '@backstage/config';
import { Entity } from '@backstage/catalog-model';
import { Entity } from '@backstage/catalog-model/*';
import { EntityProvider } from '@backstage/plugin-catalog-backend';
import { EntityProviderConnection } from '@backstage/plugin-catalog-backend';
import { EventParams } from '@backstage/plugin-events-node';
@@ -23,7 +23,7 @@ import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/
import { GithubEntityProvider } from '../providers/GithubEntityProvider';
/**
* Registers the {@link GithubEntityProvider} with the catalog processing extension point.
* Registers the `GithubEntityProvider` with the catalog processing extension point.
*
* @alpha
*/
@@ -4,8 +4,8 @@
```ts
import { BackendFeature } from '@backstage/backend-plugin-api';
import type { DeferredEntity } from '@backstage/plugin-catalog-backend';
import type { DurationObjectUnits } from 'luxon';
import { IncrementalEntityProvider } from '@backstage/plugin-catalog-backend-module-incremental-ingestion';
import { IncrementalEntityProviderOptions } from '@backstage/plugin-catalog-backend-module-incremental-ingestion';
// @alpha
export const incrementalIngestionEntityProviderCatalogModule: (options: {
@@ -15,10 +15,5 @@ export const incrementalIngestionEntityProviderCatalogModule: (options: {
}[];
}) => BackendFeature;
// Warnings were encountered during analysis:
//
// src/module/incrementalIngestionEntityProviderCatalogModule.d.ts:9:9 - (ae-forgotten-export) The symbol "IncrementalEntityProvider" needs to be exported by the entry point alpha.d.ts
// src/module/incrementalIngestionEntityProviderCatalogModule.d.ts:10:9 - (ae-forgotten-export) The symbol "IncrementalEntityProviderOptions" needs to be exported by the entry point alpha.d.ts
// (No @packageDocumentation comment for this package)
```
@@ -3,6 +3,8 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="express" />
import { CatalogBuilder } from '@backstage/plugin-catalog-backend';
import type { Config } from '@backstage/config';
import type { DeferredEntity } from '@backstage/plugin-catalog-backend';
@@ -22,7 +22,7 @@ import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/
import {
IncrementalEntityProvider,
IncrementalEntityProviderOptions,
} from '../types';
} from '@backstage/plugin-catalog-backend-module-incremental-ingestion';
import { WrapperProviders } from './WrapperProviders';
/**
@@ -4,22 +4,19 @@
```ts
import { BackendFeature } from '@backstage/backend-plugin-api';
import { GroupEntity } from '@backstage/catalog-model';
import * as MicrosoftGraph from '@microsoft/microsoft-graph-types';
import { UserEntity } from '@backstage/catalog-model';
import { GroupTransformer } from '@backstage/plugin-catalog-backend-module-msgraph';
import { OrganizationTransformer } from '@backstage/plugin-catalog-backend-module-msgraph';
import { UserTransformer } from '@backstage/plugin-catalog-backend-module-msgraph';
// @alpha
export const microsoftGraphOrgEntityProviderCatalogModule: () => BackendFeature;
// @alpha
export interface MicrosoftGraphOrgEntityProviderCatalogModuleOptions {
// Warning: (ae-forgotten-export) The symbol "GroupTransformer" needs to be exported by the entry point alpha.d.ts
groupTransformer?: GroupTransformer | Record<string, GroupTransformer>;
// Warning: (ae-forgotten-export) The symbol "OrganizationTransformer" needs to be exported by the entry point alpha.d.ts
organizationTransformer?:
| OrganizationTransformer
| Record<string, OrganizationTransformer>;
// Warning: (ae-forgotten-export) The symbol "UserTransformer" needs to be exported by the entry point alpha.d.ts
userTransformer?: UserTransformer | Record<string, UserTransformer>;
}
@@ -24,7 +24,7 @@ import {
GroupTransformer,
OrganizationTransformer,
UserTransformer,
} from '../microsoftGraph';
} from '@backstage/plugin-catalog-backend-module-msgraph';
import { MicrosoftGraphOrgEntityProvider } from '../processors';
/**
+16 -8
View File
@@ -6,7 +6,8 @@
import { BackendFeature } from '@backstage/backend-plugin-api';
import { ConditionalPolicyDecision } from '@backstage/plugin-permission-common';
import { Conditions } from '@backstage/plugin-permission-node';
import { Entity } from '@backstage/catalog-model';
import { Entity } from '@backstage/catalog-model/*';
import { Entity as Entity_2 } from '@backstage/catalog-model';
import { PermissionCondition } from '@backstage/plugin-permission-common';
import { PermissionCriteria } from '@backstage/plugin-permission-common';
import { PermissionRule } from '@backstage/plugin-permission-node';
@@ -71,7 +72,7 @@ export const catalogConditions: Conditions<{
// @alpha
export type CatalogPermissionRule<
TParams extends PermissionRuleParams = PermissionRuleParams,
> = PermissionRule<Entity, EntitiesSearchFilter, 'catalog-entity', TParams>;
> = PermissionRule<Entity_2, EntitiesSearchFilter, 'catalog-entity', TParams>;
// @alpha
export const catalogPlugin: () => BackendFeature;
@@ -88,8 +89,19 @@ export const createCatalogConditionalDecision: (
export const createCatalogPermissionRule: <
TParams extends PermissionRuleParams = undefined,
>(
rule: PermissionRule<Entity, EntitiesSearchFilter, 'catalog-entity', TParams>,
) => PermissionRule<Entity, EntitiesSearchFilter, 'catalog-entity', TParams>;
rule: PermissionRule<
Entity_2,
EntitiesSearchFilter,
'catalog-entity',
TParams
>,
) => PermissionRule<Entity_2, EntitiesSearchFilter, 'catalog-entity', TParams>;
// @public
export type EntitiesSearchFilter = {
key: string;
values?: string[];
};
// @alpha
export const permissionRules: {
@@ -146,9 +158,5 @@ export const permissionRules: {
>;
};
// Warnings were encountered during analysis:
//
// src/permissions/conditionExports.d.ts:8:5 - (ae-forgotten-export) The symbol "EntitiesSearchFilter" needs to be exported by the entry point alpha.d.ts
// (No @packageDocumentation comment for this package)
```
+6
View File
@@ -14,5 +14,11 @@
* limitations under the License.
*/
// TODO(Rugvip): Re-exported for alpha types as the API report will otherwise
// produce warnings due to the indirect dependency. We be nice to avoid.
import type { EntitiesSearchFilter } from './catalog/types';
export type { /** @alpha */ EntitiesSearchFilter };
export * from './permissions';
export { catalogPlugin } from './service/CatalogPlugin';
+2 -10
View File
@@ -3,26 +3,18 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />
import { CatalogApi } from '@backstage/catalog-client';
import { CompoundEntityRef } from '@backstage/catalog-model';
import { Entity } from '@backstage/catalog-model';
import { CatalogProcessor } from '@backstage/plugin-catalog-node';
import { EntityProvider } from '@backstage/plugin-catalog-node';
import { ExtensionPoint } from '@backstage/backend-plugin-api';
import { JsonValue } from '@backstage/types';
import { LocationSpec } from '@backstage/plugin-catalog-common';
import { ServiceRef } from '@backstage/backend-plugin-api';
// @alpha (undocumented)
export interface CatalogProcessingExtensionPoint {
// Warning: (ae-forgotten-export) The symbol "EntityProvider" needs to be exported by the entry point alpha.d.ts
//
// (undocumented)
addEntityProvider(
...providers: Array<EntityProvider | Array<EntityProvider>>
): void;
// Warning: (ae-forgotten-export) The symbol "CatalogProcessor" needs to be exported by the entry point alpha.d.ts
//
// (undocumented)
addProcessor(
...processors: Array<CatalogProcessor | Array<CatalogProcessor>>
+4 -2
View File
@@ -14,8 +14,10 @@
* limitations under the License.
*/
import { createExtensionPoint } from '@backstage/backend-plugin-api';
import { EntityProvider } from './api';
import { CatalogProcessor } from './api/processor';
import {
EntityProvider,
CatalogProcessor,
} from '@backstage/plugin-catalog-node';
/**
* @alpha
@@ -5,8 +5,6 @@
```ts
import { BackendFeature } from '@backstage/backend-plugin-api';
// Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/plugin-events-backend-module-azure" does not have an export "AzureDevOpsEventRouter"
//
// @alpha
export const azureDevOpsEventRouterEventsModule: () => BackendFeature;
@@ -21,7 +21,7 @@ import { AzureDevOpsEventRouter } from '../router/AzureDevOpsEventRouter';
/**
* Module for the events-backend plugin, adding an event router for Azure DevOps.
*
* Registers the {@link AzureDevOpsEventRouter}.
* Registers the `AzureDevOpsEventRouter`.
*
* @alpha
*/
@@ -5,8 +5,6 @@
```ts
import { BackendFeature } from '@backstage/backend-plugin-api';
// Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/plugin-events-backend-module-bitbucket-cloud" does not have an export "BitbucketCloudEventRouter"
//
// @alpha
export const bitbucketCloudEventRouterEventsModule: () => BackendFeature;
@@ -21,7 +21,7 @@ import { BitbucketCloudEventRouter } from '../router/BitbucketCloudEventRouter';
/**
* Module for the events-backend plugin, adding an event router for Bitbucket Cloud.
*
* Registers the {@link BitbucketCloudEventRouter}.
* Registers the `BitbucketCloudEventRouter`.
*
* @alpha
*/
@@ -0,0 +1,12 @@
## API Report File for "@backstage/plugin-events-backend-module-gerrit"
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { BackendFeature } from '@backstage/backend-plugin-api';
// @alpha
export const gerritEventRouterEventsModule: () => BackendFeature;
// (No @packageDocumentation comment for this package)
```
@@ -3,7 +3,6 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { BackendFeature } from '@backstage/backend-plugin-api';
import { EventParams } from '@backstage/plugin-events-node';
import { SubTopicEventRouter } from '@backstage/plugin-events-node';
@@ -13,7 +12,4 @@ export class GerritEventRouter extends SubTopicEventRouter {
// (undocumented)
protected determineSubTopic(params: EventParams): string | undefined;
}
// @alpha
export const gerritEventRouterEventsModule: () => BackendFeature;
```
@@ -21,7 +21,7 @@ import { GerritEventRouter } from '../router/GerritEventRouter';
/**
* Module for the events-backend plugin, adding an event router for Gerrit.
*
* Registers the {@link GerritEventRouter}.
* Registers the `GerritEventRouter`.
*
* @alpha
*/
@@ -5,8 +5,6 @@
```ts
import { BackendFeature } from '@backstage/backend-plugin-api';
// Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/plugin-events-backend-module-github" does not have an export "GithubEventRouter"
//
// @alpha
export const githubEventRouterEventsModule: () => BackendFeature;
@@ -21,7 +21,7 @@ import { GithubEventRouter } from '../router/GithubEventRouter';
/**
* Module for the events-backend plugin, adding an event router for GitHub.
*
* Registers the {@link GithubEventRouter}.
* Registers the `GithubEventRouter`.
*
* @alpha
*/
@@ -5,13 +5,9 @@
```ts
import { BackendFeature } from '@backstage/backend-plugin-api';
// Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/plugin-events-backend-module-gitlab" does not have an export "GitlabEventRouter"
//
// @alpha
export const gitlabEventRouterEventsModule: () => BackendFeature;
// Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/plugin-events-backend-module-gitlab" does not have an export "GitlabEventRouter"
//
// @alpha
export const gitlabWebhookEventsModule: () => BackendFeature;
@@ -21,7 +21,7 @@ import { GitlabEventRouter } from '../router/GitlabEventRouter';
/**
* Module for the events-backend plugin, adding an event router for GitLab.
*
* Registers the {@link GitlabEventRouter}.
* Registers the `GitlabEventRouter`.
*
* @alpha
*/
@@ -26,7 +26,7 @@ import { createGitlabTokenValidator } from '../http/createGitlabTokenValidator';
* registering an HTTP POST ingress with request validator
* which verifies the webhook token based on a secret.
*
* Registers the {@link GitlabEventRouter}.
* Registers the `GitlabEventRouter`.
*
* @alpha
*/
+4 -8
View File
@@ -3,28 +3,24 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { EventBroker } from '@backstage/plugin-events-node';
import { EventPublisher } from '@backstage/plugin-events-node';
import { EventSubscriber } from '@backstage/plugin-events-node';
import { ExtensionPoint } from '@backstage/backend-plugin-api';
import { HttpPostIngressOptions } from '@backstage/plugin-events-node';
// @alpha (undocumented)
export interface EventsExtensionPoint {
// Warning: (ae-forgotten-export) The symbol "HttpPostIngressOptions" needs to be exported by the entry point alpha.d.ts
//
// (undocumented)
addHttpPostIngress(options: HttpPostIngressOptions): void;
// Warning: (ae-forgotten-export) The symbol "EventPublisher" needs to be exported by the entry point alpha.d.ts
//
// (undocumented)
addPublishers(
...publishers: Array<EventPublisher | Array<EventPublisher>>
): void;
// Warning: (ae-forgotten-export) The symbol "EventSubscriber" needs to be exported by the entry point alpha.d.ts
//
// (undocumented)
addSubscribers(
...subscribers: Array<EventSubscriber | Array<EventSubscriber>>
): void;
// Warning: (ae-forgotten-export) The symbol "EventBroker" needs to be exported by the entry point alpha.d.ts
//
// (undocumented)
setEventBroker(eventBroker: EventBroker): void;
}
+1 -1
View File
@@ -20,7 +20,7 @@ import {
EventPublisher,
EventSubscriber,
HttpPostIngressOptions,
} from './api';
} from '@backstage/plugin-events-node';
/**
* @alpha
+36 -36
View File
@@ -21,7 +21,7 @@ import { PluginEndpointDiscovery } from '@backstage/backend-common';
import type { RequestHandler } from 'express';
import { TokenCredential } from '@azure/identity';
// @alpha (undocumented)
// @public (undocumented)
export interface AWSClusterDetails extends ClusterDetails {
// (undocumented)
assumeRole?: string;
@@ -29,7 +29,7 @@ export interface AWSClusterDetails extends ClusterDetails {
externalId?: string;
}
// @alpha (undocumented)
// @public (undocumented)
export class AwsIamKubernetesAuthTranslator
implements KubernetesAuthTranslator
{
@@ -54,10 +54,10 @@ export class AwsIamKubernetesAuthTranslator
validCredentials(creds: SigningCreds): boolean;
}
// @alpha (undocumented)
// @public (undocumented)
export interface AzureClusterDetails extends ClusterDetails {}
// @alpha (undocumented)
// @public (undocumented)
export class AzureIdentityKubernetesAuthTranslator
implements KubernetesAuthTranslator
{
@@ -68,7 +68,7 @@ export class AzureIdentityKubernetesAuthTranslator
): Promise<AzureClusterDetails>;
}
// @alpha (undocumented)
// @public (undocumented)
export interface ClusterDetails {
// (undocumented)
authProvider: string;
@@ -91,25 +91,25 @@ export interface ClusterDetails {
url: string;
}
// @alpha @deprecated
// @public @deprecated
export function createRouter(options: RouterOptions): Promise<express.Router>;
// @alpha (undocumented)
// @public (undocumented)
export interface CustomResource extends ObjectToFetch {
// (undocumented)
objectType: 'customresources';
}
// @alpha (undocumented)
// @public (undocumented)
export interface CustomResourcesByEntity extends KubernetesObjectsByEntity {
// (undocumented)
customResources: CustomResourceMatcher[];
}
// @alpha (undocumented)
// @public (undocumented)
export const DEFAULT_OBJECTS: ObjectToFetch[];
// @alpha (undocumented)
// @public (undocumented)
export interface FetchResponseWrapper {
// (undocumented)
errors: KubernetesFetchError[];
@@ -117,10 +117,10 @@ export interface FetchResponseWrapper {
responses: FetchResponse[];
}
// @alpha (undocumented)
// @public (undocumented)
export interface GKEClusterDetails extends ClusterDetails {}
// @alpha (undocumented)
// @public (undocumented)
export class GoogleKubernetesAuthTranslator
implements KubernetesAuthTranslator
{
@@ -131,7 +131,7 @@ export class GoogleKubernetesAuthTranslator
): Promise<GKEClusterDetails>;
}
// @alpha (undocumented)
// @public (undocumented)
export class GoogleServiceAccountAuthTranslator
implements KubernetesAuthTranslator
{
@@ -144,7 +144,7 @@ export class GoogleServiceAccountAuthTranslator
// @public
export const HEADER_KUBERNETES_CLUSTER: string;
// @alpha (undocumented)
// @public (undocumented)
export interface KubernetesAuthTranslator {
// (undocumented)
decorateClusterDetailsWithAuth(
@@ -153,7 +153,7 @@ export interface KubernetesAuthTranslator {
): Promise<ClusterDetails>;
}
// @alpha (undocumented)
// @public (undocumented)
export class KubernetesAuthTranslatorGenerator {
// (undocumented)
static getKubernetesAuthTranslatorInstance(
@@ -164,7 +164,7 @@ export class KubernetesAuthTranslatorGenerator {
): KubernetesAuthTranslator;
}
// @alpha (undocumented)
// @public (undocumented)
export class KubernetesBuilder {
constructor(env: KubernetesEnvironment);
// (undocumented)
@@ -247,7 +247,7 @@ export class KubernetesBuilder {
setServiceLocator(serviceLocator?: KubernetesServiceLocator): this;
}
// @alpha
// @public
export type KubernetesBuilderReturn = Promise<{
router: express.Router;
clusterSupplier: KubernetesClustersSupplier;
@@ -258,12 +258,12 @@ export type KubernetesBuilderReturn = Promise<{
serviceLocator: KubernetesServiceLocator;
}>;
// @alpha
// @public
export interface KubernetesClustersSupplier {
getClusters(): Promise<ClusterDetails[]>;
}
// @alpha (undocumented)
// @public (undocumented)
export interface KubernetesEnvironment {
// (undocumented)
catalogApi: CatalogApi;
@@ -273,7 +273,7 @@ export interface KubernetesEnvironment {
logger: Logger;
}
// @alpha
// @public
export interface KubernetesFetcher {
// (undocumented)
fetchObjectsForService(
@@ -286,7 +286,7 @@ export interface KubernetesFetcher {
): Promise<FetchResponseWrapper>;
}
// @alpha (undocumented)
// @public (undocumented)
export interface KubernetesObjectsByEntity {
// (undocumented)
auth: KubernetesRequestAuth;
@@ -294,7 +294,7 @@ export interface KubernetesObjectsByEntity {
entity: Entity;
}
// @alpha (undocumented)
// @public (undocumented)
export interface KubernetesObjectsProvider {
// (undocumented)
getCustomResourcesByEntity(
@@ -306,7 +306,7 @@ export interface KubernetesObjectsProvider {
): Promise<ObjectsByEntityResponse>;
}
// @alpha (undocumented)
// @public (undocumented)
export interface KubernetesObjectsProviderOptions {
// (undocumented)
customResources: CustomResource[];
@@ -320,7 +320,7 @@ export interface KubernetesObjectsProviderOptions {
serviceLocator: KubernetesServiceLocator;
}
// @alpha (undocumented)
// @public (undocumented)
export type KubernetesObjectTypes =
| 'pods'
| 'services'
@@ -336,14 +336,14 @@ export type KubernetesObjectTypes =
| 'statefulsets'
| 'daemonsets';
// @alpha
// @public
export class KubernetesProxy {
constructor(logger: Logger, clusterSupplier: KubernetesClustersSupplier);
// (undocumented)
createRequestHandler(): RequestHandler;
}
// @alpha
// @public
export interface KubernetesServiceLocator {
// (undocumented)
getClustersByEntity(
@@ -354,7 +354,7 @@ export interface KubernetesServiceLocator {
}>;
}
// @alpha (undocumented)
// @public (undocumented)
export class NoopKubernetesAuthTranslator implements KubernetesAuthTranslator {
// (undocumented)
decorateClusterDetailsWithAuth(
@@ -362,7 +362,7 @@ export class NoopKubernetesAuthTranslator implements KubernetesAuthTranslator {
): Promise<ServiceAccountClusterDetails>;
}
// @alpha (undocumented)
// @public (undocumented)
export interface ObjectFetchParams {
// (undocumented)
clusterDetails:
@@ -382,10 +382,10 @@ export interface ObjectFetchParams {
serviceId: string;
}
// @alpha (undocumented)
// @public (undocumented)
export type ObjectsByEntityRequest = KubernetesRequestBody;
// @alpha (undocumented)
// @public (undocumented)
export interface ObjectToFetch {
// (undocumented)
apiVersion: string;
@@ -397,7 +397,7 @@ export interface ObjectToFetch {
plural: string;
}
// @alpha (undocumented)
// @public (undocumented)
export class OidcKubernetesAuthTranslator implements KubernetesAuthTranslator {
// (undocumented)
decorateClusterDetailsWithAuth(
@@ -406,7 +406,7 @@ export class OidcKubernetesAuthTranslator implements KubernetesAuthTranslator {
): Promise<ClusterDetails>;
}
// @alpha (undocumented)
// @public (undocumented)
export interface RouterOptions {
// (undocumented)
catalogApi: CatalogApi;
@@ -420,13 +420,13 @@ export interface RouterOptions {
logger: Logger;
}
// @alpha (undocumented)
// @public (undocumented)
export interface ServiceAccountClusterDetails extends ClusterDetails {}
// @alpha (undocumented)
// @public (undocumented)
export type ServiceLocatorMethod = 'multiTenant' | 'http';
// @alpha (undocumented)
// @public (undocumented)
export interface ServiceLocatorRequestContext {
// (undocumented)
customResources: CustomResourceMatcher[];
@@ -434,7 +434,7 @@ export interface ServiceLocatorRequestContext {
objectTypesToFetch: Set<ObjectToFetch>;
}
// @alpha (undocumented)
// @public (undocumented)
export type SigningCreds = {
accessKeyId: string | undefined;
secretAccessKey: string | undefined;
+5 -5
View File
@@ -101,7 +101,7 @@ export interface DeploymentResources {
replicaSets: V1ReplicaSet[];
}
// @alpha
// @public
export interface DetectedError {
// (undocumented)
cluster: string;
@@ -117,10 +117,10 @@ export interface DetectedError {
severity: ErrorSeverity;
}
// @alpha
// @public
export type DetectedErrorsByCluster = Map<string, DetectedError[]>;
// @alpha
// @public
export const detectErrors: (
objects: ObjectsByEntityResponse,
) => DetectedErrorsByCluster;
@@ -137,7 +137,7 @@ export type EntityKubernetesContentProps = {
refreshIntervalMs?: number;
};
// @alpha
// @public
export type ErrorDetectableKind =
| 'Pod'
| 'Deployment'
@@ -161,7 +161,7 @@ export const ErrorReporting: ({
detectedErrors,
}: ErrorReportingProps) => JSX.Element;
// @alpha
// @public
export type ErrorSeverity = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;
// Warning: (ae-forgotten-export) The symbol "FormatClusterLinkOptions" needs to be exported by the entry point index.d.ts
@@ -25,7 +25,7 @@ import { detectErrorsInHpa } from './hpas';
* For each cluster try to find errors in each of the object types provided
* returning a map of cluster names to errors in that cluster
*
* @alpha
* @public
*/
export const detectErrors = (
objects: ObjectsByEntityResponse,
@@ -24,7 +24,7 @@ import {
/**
* Severity of the error, where 10 is critical and 0 is very low.
*
* @alpha
* @public
*/
export type ErrorSeverity = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;
@@ -33,7 +33,7 @@ export type ErrorDetectable = V1Pod | V1Deployment | V1HorizontalPodAutoscaler;
/**
* Kubernetes kinds that errors might be reported by the plugin
*
* @alpha
* @public
*/
export type ErrorDetectableKind =
| 'Pod'
@@ -43,14 +43,14 @@ export type ErrorDetectableKind =
/**
* A list of errors keyed by Cluster name
*
* @alpha
* @public
*/
export type DetectedErrorsByCluster = Map<string, DetectedError[]>;
/**
* Represents an error found on a Kubernetes object
*
* @alpha
* @public
*/
export interface DetectedError {
severity: ErrorSeverity;
+3 -3
View File
@@ -137,17 +137,17 @@ export const createPermissionRule: <
rule: PermissionRule<TResource, TQuery, TResourceType, TParams>,
) => PermissionRule<TResource, TQuery, TResourceType, TParams>;
// @alpha
// @public
export const isAndCriteria: <T>(
criteria: PermissionCriteria<T>,
) => criteria is AllOfCriteria<T>;
// @alpha
// @public
export const isNotCriteria: <T>(
criteria: PermissionCriteria<T>,
) => criteria is NotCriteria<T>;
// @alpha
// @public
export const isOrCriteria: <T>(
criteria: PermissionCriteria<T>,
) => criteria is AnyOfCriteria<T>;
+9 -8
View File
@@ -6,7 +6,7 @@
/// <reference types="react" />
import { ApiHolder } from '@backstage/core-plugin-api';
import { ApiRef } from '@backstage/core-plugin-api';
import { ApiRef } from '@backstage/core-plugin-api/*';
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { ComponentType } from 'react';
import { createScaffolderFieldExtension as createScaffolderFieldExtension_2 } from '@backstage/plugin-scaffolder-react';
@@ -32,6 +32,7 @@ import { PathParams } from '@backstage/core-plugin-api';
import { default as React_2 } from 'react';
import { ReactNode } from 'react';
import { RouteRef } from '@backstage/core-plugin-api';
import { RouteRef as RouteRef_2 } from '@backstage/core-plugin-api/*';
import { ScaffolderApi as ScaffolderApi_2 } from '@backstage/plugin-scaffolder-react';
import { ScaffolderDryRunOptions as ScaffolderDryRunOptions_2 } from '@backstage/plugin-scaffolder-react';
import { ScaffolderDryRunResponse as ScaffolderDryRunResponse_2 } from '@backstage/plugin-scaffolder-react';
@@ -109,9 +110,9 @@ export type EntityPickerUiOptions =
export const EntityTagsPickerFieldExtension: FieldExtensionComponent_2<
string[],
{
helperText?: string | undefined;
kinds?: string[] | undefined;
showCounts?: boolean | undefined;
kinds?: string[] | undefined;
helperText?: string | undefined;
}
>;
@@ -119,9 +120,9 @@ export const EntityTagsPickerFieldExtension: FieldExtensionComponent_2<
export const EntityTagsPickerFieldSchema: FieldSchema<
string[],
{
helperText?: string | undefined;
kinds?: string[] | undefined;
showCounts?: boolean | undefined;
kinds?: string[] | undefined;
helperText?: string | undefined;
}
>;
@@ -259,8 +260,8 @@ export const RepoUrlPickerFieldExtension: FieldExtensionComponent_2<
| {
azure?: string[] | undefined;
github?: string[] | undefined;
bitbucket?: string[] | undefined;
gitlab?: string[] | undefined;
bitbucket?: string[] | undefined;
gerrit?: string[] | undefined;
}
| undefined;
@@ -285,8 +286,8 @@ export const RepoUrlPickerFieldSchema: FieldSchema<
| {
azure?: string[] | undefined;
github?: string[] | undefined;
bitbucket?: string[] | undefined;
gitlab?: string[] | undefined;
bitbucket?: string[] | undefined;
gerrit?: string[] | undefined;
}
| undefined;
@@ -315,7 +316,7 @@ export type ReviewStepProps = {
};
// @public @deprecated (undocumented)
export const rootRouteRef: RouteRef<undefined>;
export const rootRouteRef: RouteRef_2<undefined>;
// @public
export type RouterProps = {
+3 -3
View File
@@ -7,11 +7,11 @@
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { DiscoveryApi } from '@backstage/core-plugin-api';
import { Entity } from '@backstage/catalog-model';
import { FindingSummary } from '@backstage/plugin-sonarqube-react';
import { Entity } from '@backstage/catalog-model/*';
import { FindingSummary } from '@backstage/plugin-sonarqube-react/alpha';
import { IdentityApi } from '@backstage/core-plugin-api';
import { InfoCardVariants } from '@backstage/core-components';
import { SonarQubeApi } from '@backstage/plugin-sonarqube-react';
import { SonarQubeApi } from '@backstage/plugin-sonarqube-react/alpha';
// @public (undocumented)
export type DuplicationRating = {