diff --git a/packages/backend-app-api/api-report.md b/packages/backend-app-api/api-report.md index ef88d9a9d0..33e732cf05 100644 --- a/packages/backend-app-api/api-report.md +++ b/packages/backend-app-api/api-report.md @@ -83,11 +83,6 @@ export const permissionsFactory: ( options?: undefined, ) => ServiceFactory; -// @public -export const rootLifecycleFactory: ( - options?: undefined, -) => ServiceFactory; - // @public (undocumented) export const rootLoggerFactory: ( options?: undefined, diff --git a/packages/backend-common/api-report.md b/packages/backend-common/api-report.md index e8b41e21bb..784f3295c6 100644 --- a/packages/backend-common/api-report.md +++ b/packages/backend-common/api-report.md @@ -30,23 +30,12 @@ import { KubeConfig } from '@kubernetes/client-node'; import { LoadConfigOptionsRemote } from '@backstage/config-loader'; import { Logger } from 'winston'; import { MergeResult } from 'isomorphic-git'; -import { DiscoveryService as PluginEndpointDiscovery } from '@backstage/backend-plugin-api'; import { PushResult } from 'isomorphic-git'; import { Readable } from 'stream'; import { ReadCommitResult } from 'isomorphic-git'; -import { ReadTreeOptions } from '@backstage/backend-plugin-api'; -import { ReadTreeResponse } from '@backstage/backend-plugin-api'; -import { ReadTreeResponseDirOptions } from '@backstage/backend-plugin-api'; -import { ReadTreeResponseFile } from '@backstage/backend-plugin-api'; -import { ReadUrlOptions } from '@backstage/backend-plugin-api'; -import { ReadUrlResponse } from '@backstage/backend-plugin-api'; import { RequestHandler } from 'express'; import { Router } from 'express'; -import { SearchOptions } from '@backstage/backend-plugin-api'; -import { SearchResponse } from '@backstage/backend-plugin-api'; -import { SearchResponseFile } from '@backstage/backend-plugin-api'; import { Server } from 'http'; -import { UrlReaderService as UrlReader } from '@backstage/backend-plugin-api'; import { V1PodTemplateSpec } from '@kubernetes/client-node'; import * as winston from 'winston'; import { Writable } from 'stream'; @@ -531,7 +520,11 @@ export interface PluginDatabaseManager { }; } -export { PluginEndpointDiscovery }; +// @public +export type PluginEndpointDiscovery = { + getBaseUrl(pluginId: string): Promise; + getExternalBaseUrl(pluginId: string): Promise; +}; // @public export type ReaderFactory = (options: { @@ -540,11 +533,30 @@ export type ReaderFactory = (options: { treeResponseFactory: ReadTreeResponseFactory; }) => UrlReaderPredicateTuple[]; -export { ReadTreeOptions }; +// @public +export type ReadTreeOptions = { + filter?( + path: string, + info?: { + size: number; + }, + ): boolean; + etag?: string; + signal?: AbortSignal; +}; -export { ReadTreeResponse }; +// @public +export type ReadTreeResponse = { + files(): Promise; + archive(): Promise; + dir(options?: ReadTreeResponseDirOptions): Promise; + etag: string; +}; -export { ReadTreeResponseDirOptions }; +// @public +export type ReadTreeResponseDirOptions = { + targetDir?: string; +}; // @public export interface ReadTreeResponseFactory { @@ -575,11 +587,24 @@ export type ReadTreeResponseFactoryOptions = { ) => boolean; }; -export { ReadTreeResponseFile }; +// @public +export type ReadTreeResponseFile = { + path: string; + content(): Promise; +}; -export { ReadUrlOptions }; +// @public +export type ReadUrlOptions = { + etag?: string; + signal?: AbortSignal; +}; -export { ReadUrlResponse }; +// @public +export type ReadUrlResponse = { + buffer(): Promise; + stream?(): Readable; + etag?: string; +}; // @public export class ReadUrlResponseFactory { @@ -627,11 +652,23 @@ export type RunContainerOptions = { pullImage?: boolean; }; -export { SearchOptions }; +// @public +export type SearchOptions = { + etag?: string; + signal?: AbortSignal; +}; -export { SearchResponse }; +// @public +export type SearchResponse = { + files: SearchResponseFile[]; + etag: string; +}; -export { SearchResponseFile }; +// @public +export type SearchResponseFile = { + url: string; + content(): Promise; +}; // @public export class ServerTokenManager implements TokenManager { @@ -718,7 +755,13 @@ export interface TokenManager { }>; } -export { UrlReader }; +// @public +export type UrlReader = { + read(url: string): Promise; + readUrl(url: string, options?: ReadUrlOptions): Promise; + readTree(url: string, options?: ReadTreeOptions): Promise; + search(url: string, options?: SearchOptions): Promise; +}; // @public export type UrlReaderPredicateTuple = { diff --git a/packages/backend-plugin-api/api-report.md b/packages/backend-plugin-api/api-report.md index e0fa44eb20..545728b386 100644 --- a/packages/backend-plugin-api/api-report.md +++ b/packages/backend-plugin-api/api-report.md @@ -3,8 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -/// - import { Config } from '@backstage/config'; import { Handler } from 'express'; import { Logger } from 'winston'; @@ -12,10 +10,11 @@ import { PermissionAuthorizer } from '@backstage/plugin-permission-common'; import { PermissionEvaluator } from '@backstage/plugin-permission-common'; import { PluginCacheManager } from '@backstage/backend-common'; import { PluginDatabaseManager } from '@backstage/backend-common'; +import { PluginEndpointDiscovery } from '@backstage/backend-common'; import { PluginTaskScheduler } from '@backstage/backend-tasks'; -import { Readable } from 'stream'; import { TokenManager } from '@backstage/backend-common'; import { TransportStreamOptions } from 'winston-transport'; +import { UrlReader } from '@backstage/backend-common'; // @public (undocumented) export interface BackendFeature { @@ -90,7 +89,6 @@ declare namespace coreServices { tokenManagerServiceRef as tokenManager, permissionsServiceRef as permissions, schedulerServiceRef as scheduler, - rootLifecycleServiceRef as rootLifecycle, rootLoggerServiceRef as rootLogger, pluginMetadataServiceRef as pluginMetadata, lifecycleServiceRef as lifecycle, @@ -168,14 +166,11 @@ export type DatabaseService = PluginDatabaseManager; // @public (undocumented) const databaseServiceRef: ServiceRef; -// @public -export type DiscoveryService = { - getBaseUrl(pluginId: string): Promise; - getExternalBaseUrl(pluginId: string): Promise; -}; +// @public (undocumented) +export type DiscoveryService = PluginEndpointDiscovery; // @public (undocumented) -const discoveryServiceRef: ServiceRef; +const discoveryServiceRef: ServiceRef; // @public export type ExtensionPoint = { @@ -205,7 +200,6 @@ const lifecycleServiceRef: ServiceRef; // @public (undocumented) export type LifecycleServiceShutdownHook = { fn: () => void | Promise; - labels?: Record; }; // @public (undocumented) @@ -251,56 +245,6 @@ export interface PluginMetadataService { // @public (undocumented) const pluginMetadataServiceRef: ServiceRef; -// @public -export type ReadTreeOptions = { - filter?( - path: string, - info?: { - size: number; - }, - ): boolean; - etag?: string; - signal?: AbortSignal; -}; - -// @public -export type ReadTreeResponse = { - files(): Promise; - archive(): Promise; - dir(options?: ReadTreeResponseDirOptions): Promise; - etag: string; -}; - -// @public -export type ReadTreeResponseDirOptions = { - targetDir?: string; -}; - -// @public -export type ReadTreeResponseFile = { - path: string; - content(): Promise; -}; - -// @public -export type ReadUrlOptions = { - etag?: string; - signal?: AbortSignal; -}; - -// @public -export type ReadUrlResponse = { - buffer(): Promise; - stream?(): Readable; - etag?: string; -}; - -// @public (undocumented) -export type RootLifecycleService = LifecycleService; - -// @public (undocumented) -const rootLifecycleServiceRef: ServiceRef; - // @public (undocumented) export type RootLoggerService = LoggerService; @@ -313,24 +257,6 @@ export type SchedulerService = PluginTaskScheduler; // @public (undocumented) const schedulerServiceRef: ServiceRef; -// @public -export type SearchOptions = { - etag?: string; - signal?: AbortSignal; -}; - -// @public -export type SearchResponse = { - files: SearchResponseFile[]; - etag: string; -}; - -// @public -export type SearchResponseFile = { - url: string; - content(): Promise; -}; - // @public (undocumented) export type ServiceFactory = | { @@ -381,13 +307,9 @@ export type TypesToServiceRef = { [key in keyof T]: ServiceRef; }; -// @public -export type UrlReaderService = { - readUrl(url: string, options?: ReadUrlOptions): Promise; - readTree(url: string, options?: ReadTreeOptions): Promise; - search(url: string, options?: SearchOptions): Promise; -}; +// @public (undocumented) +export type UrlReaderService = UrlReader; // @public (undocumented) -const urlReaderServiceRef: ServiceRef; +const urlReaderServiceRef: ServiceRef; ``` diff --git a/packages/catalog-client/api-report.md b/packages/catalog-client/api-report.md index a81314308b..2f76be79e2 100644 --- a/packages/catalog-client/api-report.md +++ b/packages/catalog-client/api-report.md @@ -161,17 +161,6 @@ export type EntityFilterQuery = | Record[] | Record; -// @public -export type EntityOrderQuery = - | { - field: string; - order: 'asc' | 'desc'; - } - | Array<{ - field: string; - order: 'asc' | 'desc'; - }>; - // @public export interface GetEntitiesByRefsRequest { entityRefs: string[]; @@ -190,7 +179,6 @@ export interface GetEntitiesRequest { filter?: EntityFilterQuery; limit?: number; offset?: number; - order?: EntityOrderQuery; } // @public diff --git a/plugins/apollo-explorer/api-report.md b/plugins/apollo-explorer/api-report.md index 1d3b41eac1..7272903b0c 100644 --- a/plugins/apollo-explorer/api-report.md +++ b/plugins/apollo-explorer/api-report.md @@ -25,7 +25,7 @@ export const ApolloExplorerPage: (props: { displayOptions: { docsPanelState?: 'closed' | 'open' | undefined; showHeadersAndEnvVars?: boolean | undefined; - theme?: 'dark' | 'light' | undefined; + theme?: 'light' | 'dark' | undefined; }; } | undefined; diff --git a/plugins/bazaar/api-report.md b/plugins/bazaar/api-report.md index afbb7b5504..d7c463888a 100644 --- a/plugins/bazaar/api-report.md +++ b/plugins/bazaar/api-report.md @@ -5,9 +5,7 @@ ```ts /// -import { ApiHolder } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; -import { Entity } from '@backstage/catalog-model'; import { RouteRef } from '@backstage/core-plugin-api'; // @public (undocumented) @@ -38,14 +36,6 @@ export const bazaarPlugin: BackstagePlugin< // @public (undocumented) export const EntityBazaarInfoCard: () => JSX.Element | null; -// @public (undocumented) -export const isBazaarAvailable: ( - entity: Entity, - context: { - apis: ApiHolder; - }, -) => Promise; - // @public (undocumented) export const SortView: () => JSX.Element; diff --git a/plugins/catalog-backend-module-github/api-report.md b/plugins/catalog-backend-module-github/api-report.md index 78ffd5b018..8ccfdb09ee 100644 --- a/plugins/catalog-backend-module-github/api-report.md +++ b/plugins/catalog-backend-module-github/api-report.md @@ -178,9 +178,7 @@ export class GitHubOrgEntityProvider extends GithubOrgEntityProvider { } // @public -export class GithubOrgEntityProvider - implements EntityProvider, EventSubscriber -{ +export class GithubOrgEntityProvider implements EntityProvider { constructor(options: { id: string; orgUrl: string; @@ -199,11 +197,7 @@ export class GithubOrgEntityProvider ): GithubOrgEntityProvider; // (undocumented) getProviderName(): string; - // (undocumented) - onEvent(params: EventParams): Promise; read(options?: { logger?: Logger }): Promise; - // (undocumented) - supportsEventTopics(): string[]; } // @public @deprecated (undocumented) diff --git a/plugins/code-coverage-backend/api-report.md b/plugins/code-coverage-backend/api-report.md index 440af50714..c33874064b 100644 --- a/plugins/code-coverage-backend/api-report.md +++ b/plugins/code-coverage-backend/api-report.md @@ -3,7 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { CatalogApi } from '@backstage/catalog-client'; import { Config } from '@backstage/config'; import express from 'express'; import { Logger } from 'winston'; @@ -16,8 +15,6 @@ export function createRouter(options: RouterOptions): Promise; // @public export interface RouterOptions { - // (undocumented) - catalogApi?: CatalogApi; // (undocumented) config: Config; // (undocumented) diff --git a/plugins/explore/api-report.md b/plugins/explore/api-report.md index d10f5ddf95..d184ce01a4 100644 --- a/plugins/explore/api-report.md +++ b/plugins/explore/api-report.md @@ -9,6 +9,7 @@ import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { default as default_2 } from 'react'; import { DiscoveryApi } from '@backstage/core-plugin-api'; +import { DomainEntity } from '@backstage/catalog-model'; import { ExploreToolsConfig } from '@backstage/plugin-explore-react'; import { ExternalRouteRef } from '@backstage/core-plugin-api'; import { FetchApi } from '@backstage/core-plugin-api'; @@ -30,6 +31,9 @@ export const catalogEntityRouteRef: ExternalRouteRef< true >; +// @public (undocumented) +export const DomainCard: (props: { entity: DomainEntity }) => JSX.Element; + // @public (undocumented) export const DomainExplorerContent: (props: { title?: string | undefined; diff --git a/plugins/rollbar-backend/api-report.md b/plugins/rollbar-backend/api-report.md index 58a5fb0252..9086121306 100644 --- a/plugins/rollbar-backend/api-report.md +++ b/plugins/rollbar-backend/api-report.md @@ -29,8 +29,8 @@ export class RollbarApi { }, ): Promise< { - count: number; timestamp: number; + count: number; }[] >; // (undocumented) @@ -51,8 +51,8 @@ export class RollbarApi { }, ): Promise< { - count: number; timestamp: number; + count: number; }[] >; // (undocumented) @@ -64,8 +64,8 @@ export class RollbarApi { }>; // (undocumented) getProjectItems(projectName: string): Promise<{ - page: number; items: RollbarItem[]; + page: number; totalCount: number; }>; // (undocumented) diff --git a/plugins/scaffolder-backend/api-report.md b/plugins/scaffolder-backend/api-report.md index 66757a01cd..94377d7720 100644 --- a/plugins/scaffolder-backend/api-report.md +++ b/plugins/scaffolder-backend/api-report.md @@ -195,12 +195,6 @@ export function createGithubRepoCreateAction(options: { gitAuthorEmail?: string | undefined; allowRebaseMerge?: boolean | undefined; allowSquashMerge?: boolean | undefined; - squashMergeCommitTitle?: 'PR_TITLE' | 'COMMIT_OR_PR_TITLE' | undefined; - squashMergeCommitMessage?: - | 'PR_BODY' - | 'COMMIT_MESSAGES' - | 'BLANK' - | undefined; allowMergeCommit?: boolean | undefined; allowAutoMerge?: boolean | undefined; requireCodeOwnerReviews?: boolean | undefined; @@ -214,16 +208,16 @@ export function createGithubRepoCreateAction(options: { requiredStatusCheckContexts?: string[] | undefined; requireBranchesToBeUpToDate?: boolean | undefined; requiredConversationResolution?: boolean | undefined; - repoVisibility?: 'internal' | 'private' | 'public' | undefined; + repoVisibility?: 'public' | 'private' | 'internal' | undefined; collaborators?: | ( | { user: string; - access: string; + access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage'; } | { team: string; - access: string; + access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage'; } | { username: string; @@ -231,9 +225,6 @@ export function createGithubRepoCreateAction(options: { } )[] | undefined; - hasProjects?: boolean | undefined; - hasWiki?: boolean | undefined; - hasIssues?: boolean | undefined; token?: string | undefined; topics?: string[] | undefined; }>; @@ -307,7 +298,7 @@ export function createPublishBitbucketAction(options: { repoUrl: string; description?: string | undefined; defaultBranch?: string | undefined; - repoVisibility?: 'private' | 'public' | undefined; + repoVisibility?: 'public' | 'private' | undefined; sourcePath?: string | undefined; enableLFS?: boolean | undefined; token?: string | undefined; @@ -324,7 +315,7 @@ export function createPublishBitbucketCloudAction(options: { repoUrl: string; description?: string | undefined; defaultBranch?: string | undefined; - repoVisibility?: 'private' | 'public' | undefined; + repoVisibility?: 'public' | 'private' | undefined; sourcePath?: string | undefined; token?: string | undefined; }>; @@ -337,7 +328,7 @@ export function createPublishBitbucketServerAction(options: { repoUrl: string; description?: string | undefined; defaultBranch?: string | undefined; - repoVisibility?: 'private' | 'public' | undefined; + repoVisibility?: 'public' | 'private' | undefined; sourcePath?: string | undefined; enableLFS?: boolean | undefined; token?: string | undefined; @@ -389,12 +380,6 @@ export function createPublishGithubAction(options: { gitAuthorEmail?: string | undefined; allowRebaseMerge?: boolean | undefined; allowSquashMerge?: boolean | undefined; - squashMergeCommitTitle?: 'PR_TITLE' | 'COMMIT_OR_PR_TITLE' | undefined; - squashMergeCommitMessage?: - | 'PR_BODY' - | 'COMMIT_MESSAGES' - | 'BLANK' - | undefined; allowMergeCommit?: boolean | undefined; allowAutoMerge?: boolean | undefined; sourcePath?: string | undefined; @@ -410,16 +395,16 @@ export function createPublishGithubAction(options: { requiredStatusCheckContexts?: string[] | undefined; requireBranchesToBeUpToDate?: boolean | undefined; requiredConversationResolution?: boolean | undefined; - repoVisibility?: 'internal' | 'private' | 'public' | undefined; + repoVisibility?: 'public' | 'private' | 'internal' | undefined; collaborators?: | ( | { user: string; - access: string; + access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage'; } | { team: string; - access: string; + access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage'; } | { username: string; @@ -427,9 +412,6 @@ export function createPublishGithubAction(options: { } )[] | undefined; - hasProjects?: boolean | undefined; - hasWiki?: boolean | undefined; - hasIssues?: boolean | undefined; token?: string | undefined; topics?: string[] | undefined; }>; @@ -459,7 +441,7 @@ export function createPublishGitlabAction(options: { }): TemplateAction<{ repoUrl: string; defaultBranch?: string | undefined; - repoVisibility?: 'internal' | 'private' | 'public' | undefined; + repoVisibility?: 'public' | 'private' | 'internal' | undefined; sourcePath?: string | undefined; token?: string | undefined; gitCommitMessage?: string | undefined; @@ -480,7 +462,7 @@ export const createPublishGitlabMergeRequestAction: (options: { sourcePath?: string | undefined; targetPath?: string | undefined; token?: string | undefined; - commitAction?: 'update' | 'delete' | 'create' | undefined; + commitAction?: 'create' | 'update' | 'delete' | undefined; projectid?: string | undefined; removeSourceBranch?: boolean | undefined; assignee?: string | undefined; diff --git a/plugins/scaffolder/api-report.md b/plugins/scaffolder/api-report.md index 1c4d163123..d936542cfe 100644 --- a/plugins/scaffolder/api-report.md +++ b/plugins/scaffolder/api-report.md @@ -11,6 +11,7 @@ import { BackstagePlugin } from '@backstage/core-plugin-api'; import { ComponentType } from 'react'; import { DiscoveryApi } from '@backstage/core-plugin-api'; import { Entity } from '@backstage/catalog-model'; +import type { ErrorTransformer } from '@rjsf/utils'; import { Extension } from '@backstage/core-plugin-api'; import { ExternalRouteRef } from '@backstage/core-plugin-api'; import { FetchApi } from '@backstage/core-plugin-api'; @@ -18,8 +19,7 @@ import { FieldProps } from '@rjsf/core'; import { FieldProps as FieldProps_2 } from '@rjsf/utils'; import { FieldValidation } from '@rjsf/core'; import { FieldValidation as FieldValidation_2 } from '@rjsf/utils'; -import type { FormProps as FormProps_2 } from '@rjsf/core'; -import type { FormProps as FormProps_3 } from '@rjsf/core-v5'; +import type { FormProps } from '@rjsf/core'; import { IdentityApi } from '@backstage/core-plugin-api'; import { JsonObject } from '@backstage/types'; import { JSONSchema7 } from 'json-schema'; @@ -88,10 +88,6 @@ export const EntityPickerFieldExtension: FieldExtensionComponent< defaultNamespace?: string | false | undefined; allowedKinds?: string[] | undefined; allowArbitraryValues?: boolean | undefined; - catalogFilter?: - | Record - | Record[] - | undefined; } >; @@ -103,10 +99,6 @@ export const EntityPickerFieldSchema: FieldSchema< defaultNamespace?: string | false | undefined; allowedKinds?: string[] | undefined; allowArbitraryValues?: boolean | undefined; - catalogFilter?: - | Record - | Record[] - | undefined; } >; @@ -175,12 +167,6 @@ export interface FieldSchema { readonly uiOptionsType: TUiOptions; } -// @alpha -export type FormProps = Pick< - FormProps_3, - 'transformErrors' | 'noHtml5Validate' ->; - // @public export type LayoutComponent<_TInputProps> = () => null; @@ -193,7 +179,7 @@ export interface LayoutOptions

{ } // @public -export type LayoutTemplate = FormProps_2['ObjectFieldTemplate']; +export type LayoutTemplate = FormProps['ObjectFieldTemplate']; // @public export type ListActionsResponse = Array<{ @@ -278,7 +264,7 @@ export type NextRouterProps = { TaskPageComponent?: React_2.ComponentType<{}>; }; groups?: TemplateGroupFilter[]; - FormProps?: FormProps; + transformErrors?: ErrorTransformer; }; // @alpha @@ -324,10 +310,6 @@ export const OwnerPickerFieldExtension: FieldExtensionComponent< defaultNamespace?: string | false | undefined; allowedKinds?: string[] | undefined; allowArbitraryValues?: boolean | undefined; - catalogFilter?: - | Record - | Record[] - | undefined; } >; @@ -338,10 +320,6 @@ export const OwnerPickerFieldSchema: FieldSchema< defaultNamespace?: string | false | undefined; allowedKinds?: string[] | undefined; allowArbitraryValues?: boolean | undefined; - catalogFilter?: - | Record - | Record[] - | undefined; } >; @@ -370,10 +348,10 @@ export const RepoUrlPickerFieldExtension: FieldExtensionComponent< | { additionalScopes?: | { - azure?: string[] | undefined; github?: string[] | undefined; gitlab?: string[] | undefined; bitbucket?: string[] | undefined; + azure?: string[] | undefined; gerrit?: string[] | undefined; } | undefined; @@ -396,10 +374,10 @@ export const RepoUrlPickerFieldSchema: FieldSchema< | { additionalScopes?: | { - azure?: string[] | undefined; github?: string[] | undefined; gitlab?: string[] | undefined; bitbucket?: string[] | undefined; + azure?: string[] | undefined; gerrit?: string[] | undefined; } | undefined; diff --git a/plugins/techdocs-react/api-report.md b/plugins/techdocs-react/api-report.md index f1d6d3f177..09da4e012c 100644 --- a/plugins/techdocs-react/api-report.md +++ b/plugins/techdocs-react/api-report.md @@ -32,9 +32,6 @@ export const SHADOW_DOM_STYLE_LOAD_EVENT = 'TECH_DOCS_SHADOW_DOM_STYLE_LOAD'; // @public export type SyncResult = 'cached' | 'updated'; -// @public -export const TECHDOCS_ADDONS_KEY = 'techdocs.addons.addon.v1'; - // @public export const TECHDOCS_ADDONS_WRAPPER_KEY = 'techdocs.addons.wrapper.v1';