diff --git a/packages/core-app-api/api-report.md b/packages/core-app-api/api-report.md new file mode 100644 index 0000000000..36c4f7419b --- /dev/null +++ b/packages/core-app-api/api-report.md @@ -0,0 +1,398 @@ +## API Report File for "@backstage/core-app-api" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { AlertApi } from '@backstage/core-plugin-api'; +import { AlertMessage } from '@backstage/core-plugin-api'; +import { AnyApiFactory } from '@backstage/core-plugin-api'; +import { AnyApiRef } from '@backstage/core-plugin-api'; +import { ApiFactory } from '@backstage/core-plugin-api'; +import { ApiHolder } from '@backstage/core-plugin-api'; +import { ApiRef } from '@backstage/core-plugin-api'; +import { AppConfig } from '@backstage/config'; +import { AppTheme } from '@backstage/core-plugin-api'; +import { AppThemeApi } from '@backstage/core-plugin-api'; +import { auth0AuthApiRef } from '@backstage/core-plugin-api'; +import { AuthProvider } from '@backstage/core-plugin-api'; +import { AuthRequester } from '@backstage/core-plugin-api'; +import { AuthRequesterOptions } from '@backstage/core-plugin-api'; +import { AuthRequestOptions } from '@backstage/core-plugin-api'; +import { BackstageIdentity } from '@backstage/core-plugin-api'; +import { BackstageIdentityApi } from '@backstage/core-plugin-api'; +import { BackstagePlugin } from '@backstage/core-plugin-api'; +import { ComponentType } from 'react'; +import { ConfigReader } from '@backstage/config'; +import { DiscoveryApi } from '@backstage/core-plugin-api'; +import { ErrorApi } from '@backstage/core-plugin-api'; +import { ErrorContext } from '@backstage/core-plugin-api'; +import { ExternalRouteRef } from '@backstage/core-plugin-api'; +import { FeatureFlag } from '@backstage/core-plugin-api'; +import { FeatureFlagsApi } from '@backstage/core-plugin-api'; +import { FeatureFlagsSaveOptions } from '@backstage/core-plugin-api'; +import { gitlabAuthApiRef } from '@backstage/core-plugin-api'; +import { googleAuthApiRef } from '@backstage/core-plugin-api'; +import { IconComponent } from '@backstage/core-plugin-api'; +import { microsoftAuthApiRef } from '@backstage/core-plugin-api'; +import { OAuthApi } from '@backstage/core-plugin-api'; +import { OAuthRequestApi } from '@backstage/core-plugin-api'; +import { Observable } from '@backstage/core-plugin-api'; +import { oktaAuthApiRef } from '@backstage/core-plugin-api'; +import { oneloginAuthApiRef } from '@backstage/core-plugin-api'; +import { OpenIdConnectApi } from '@backstage/core-plugin-api'; +import { PendingAuthRequest } from '@backstage/core-plugin-api'; +import { ProfileInfo } from '@backstage/core-plugin-api'; +import { ProfileInfoApi } from '@backstage/core-plugin-api'; +import { PropsWithChildren } from 'react'; +import PropTypes from 'prop-types'; +import { ReactNode } from 'react'; +import { RouteRef } from '@backstage/core-plugin-api'; +import { SessionApi } from '@backstage/core-plugin-api'; +import { SessionState } from '@backstage/core-plugin-api'; +import { StorageApi } from '@backstage/core-plugin-api'; +import { StorageValueChange } from '@backstage/core-plugin-api'; +import { SubRouteRef } from '@backstage/core-plugin-api'; + +// @public +export class AlertApiForwarder implements AlertApi { + // (undocumented) + alert$(): Observable; + // (undocumented) + post(alert: AlertMessage): void; + } + +// @public (undocumented) +export type ApiFactoryHolder = { + get(api: ApiRef): ApiFactory | undefined; +}; + +// @public +export class ApiFactoryRegistry implements ApiFactoryHolder { + // (undocumented) + get(api: ApiRef): ApiFactory | undefined; + // (undocumented) + getAllApis(): Set; + register(scope: ApiFactoryScope, factory: ApiFactory): boolean; +} + +// @public (undocumented) +export const ApiProvider: { + ({ apis, children, }: PropsWithChildren): JSX.Element; + propTypes: { + apis: PropTypes.Validator any>; + }>>; + children: PropTypes.Requireable; + }; +}; + +// @public (undocumented) +export class ApiRegistry implements ApiHolder { + constructor(apis: Map); + // (undocumented) + static builder(): ApiRegistryBuilder; + // (undocumented) + static from(apis: ApiImpl[]): ApiRegistry; + // (undocumented) + get(api: ApiRef): T | undefined; + static with(api: ApiRef, impl: T): ApiRegistry; + with(api: ApiRef, impl: T): ApiRegistry; +} + +// @public (undocumented) +export class ApiResolver implements ApiHolder { + constructor(factories: ApiFactoryHolder); + // (undocumented) + get(ref: ApiRef): T | undefined; + static validateFactories(factories: ApiFactoryHolder, apis: Iterable): void; +} + +// @public (undocumented) +export type AppComponents = { + NotFoundErrorPage: ComponentType<{}>; + BootErrorPage: ComponentType; + Progress: ComponentType<{}>; + Router: ComponentType<{}>; + SignInPage?: ComponentType; +}; + +// @public +export type AppConfigLoader = () => Promise; + +// @public (undocumented) +export type AppContext = { + getPlugins(): BackstagePlugin[]; + getSystemIcon(key: string): IconComponent | undefined; + getComponents(): AppComponents; +}; + +// @public (undocumented) +export type AppOptions = { + apis?: Iterable; + icons?: AppIcons & { + [key in string]: IconComponent; + }; + plugins?: BackstagePlugin[]; + components?: Partial; + themes?: AppTheme[]; + configLoader?: AppConfigLoader; + bindRoutes?(context: { + bind: AppRouteBinder; + }): void; +}; + +// @public (undocumented) +export type AppRouteBinder = (externalRoutes: ExternalRoutes, targetRoutes: PartialKeys, KeysWithType>>) => void; + +// @public (undocumented) +export class AppThemeSelector implements AppThemeApi { + constructor(themes: AppTheme[]); + // (undocumented) + activeThemeId$(): Observable; + // (undocumented) + static createWithStorage(themes: AppTheme[]): AppThemeSelector; + // (undocumented) + getActiveThemeId(): string | undefined; + // (undocumented) + getInstalledThemes(): AppTheme[]; + // (undocumented) + setActiveThemeId(themeId?: string): void; + } + +// @public (undocumented) +export class Auth0Auth { + // (undocumented) + static create({ discoveryApi, environment, provider, oauthRequestApi, defaultScopes, }: OAuthApiCreateOptions): typeof auth0AuthApiRef.T; +} + +// @public (undocumented) +export type BackstageApp = { + getPlugins(): BackstagePlugin[]; + getSystemIcon(key: string): IconComponent | undefined; + getProvider(): ComponentType<{}>; + getRouter(): ComponentType<{}>; +}; + +// @public (undocumented) +export type BootErrorPageProps = { + step: 'load-config' | 'load-chunk'; + error: Error; +}; + +export { ConfigReader } + +// @public +export function createApp(options?: AppOptions): PrivateAppImpl; + +// @public +export class ErrorAlerter implements ErrorApi { + constructor(alertApi: AlertApi, errorApi: ErrorApi); + // (undocumented) + error$(): Observable<{ + error: { + name: string; + message: string; + stack?: string | undefined; + }; + context?: ErrorContext | undefined; + }>; + // (undocumented) + post(error: Error, context?: ErrorContext): void; +} + +// @public +export class ErrorApiForwarder implements ErrorApi { + // (undocumented) + error$(): Observable<{ + error: Error; + context?: ErrorContext; + }>; + // (undocumented) + post(error: Error, context?: ErrorContext): void; + } + +// @public (undocumented) +export const FlatRoutes: (props: FlatRoutesProps) => JSX.Element | null; + +// @public (undocumented) +export class GithubAuth implements OAuthApi, SessionApi { + constructor(sessionManager: SessionManager); + // (undocumented) + static create({ discoveryApi, environment, provider, oauthRequestApi, defaultScopes, }: OAuthApiCreateOptions): GithubAuth; + // (undocumented) + getAccessToken(scope?: string, options?: AuthRequestOptions): Promise; + // (undocumented) + getBackstageIdentity(options?: AuthRequestOptions): Promise; + // (undocumented) + getProfile(options?: AuthRequestOptions): Promise; + // (undocumented) + static normalizeScope(scope?: string): Set; + // (undocumented) + sessionState$(): Observable; + // (undocumented) + signIn(): Promise; + // (undocumented) + signOut(): Promise; +} + +// @public (undocumented) +export type GithubSession = { + providerInfo: { + accessToken: string; + scopes: Set; + expiresAt: Date; + }; + profile: ProfileInfo; + backstageIdentity: BackstageIdentity; +}; + +// @public (undocumented) +export class GitlabAuth { + // (undocumented) + static create({ discoveryApi, environment, provider, oauthRequestApi, defaultScopes, }: OAuthApiCreateOptions): typeof gitlabAuthApiRef.T; +} + +// @public (undocumented) +export class GoogleAuth { + // (undocumented) + static create({ discoveryApi, oauthRequestApi, environment, provider, defaultScopes, }: OAuthApiCreateOptions): typeof googleAuthApiRef.T; +} + +// @public +export class LocalStorageFeatureFlags implements FeatureFlagsApi { + // (undocumented) + getRegisteredFlags(): FeatureFlag[]; + // (undocumented) + isActive(name: string): boolean; + // (undocumented) + registerFlag(flag: FeatureFlag): void; + // (undocumented) + save(options: FeatureFlagsSaveOptions): void; +} + +// @public (undocumented) +export class MicrosoftAuth { + // (undocumented) + static create({ environment, provider, oauthRequestApi, discoveryApi, defaultScopes, }: OAuthApiCreateOptions): typeof microsoftAuthApiRef.T; +} + +// @public (undocumented) +export class OAuth2 implements OAuthApi, OpenIdConnectApi, ProfileInfoApi, BackstageIdentityApi, SessionApi { + constructor(options: Options); + // (undocumented) + static create({ discoveryApi, environment, provider, oauthRequestApi, defaultScopes, scopeTransform, }: CreateOptions): OAuth2; + // (undocumented) + getAccessToken(scope?: string | string[], options?: AuthRequestOptions): Promise; + // (undocumented) + getBackstageIdentity(options?: AuthRequestOptions): Promise; + // (undocumented) + getIdToken(options?: AuthRequestOptions): Promise; + // (undocumented) + getProfile(options?: AuthRequestOptions): Promise; + // (undocumented) + sessionState$(): Observable; + // (undocumented) + signIn(): Promise; + // (undocumented) + signOut(): Promise; +} + +// @public (undocumented) +export type OAuth2Session = { + providerInfo: { + idToken: string; + accessToken: string; + scopes: Set; + expiresAt: Date; + }; + profile: ProfileInfo; + backstageIdentity: BackstageIdentity; +}; + +// @public +export class OAuthRequestManager implements OAuthRequestApi { + // (undocumented) + authRequest$(): Observable; + // (undocumented) + createAuthRequester(options: AuthRequesterOptions): AuthRequester; + } + +// @public (undocumented) +export class OktaAuth { + // (undocumented) + static create({ discoveryApi, environment, provider, oauthRequestApi, defaultScopes, }: OAuthApiCreateOptions): typeof oktaAuthApiRef.T; +} + +// @public (undocumented) +export class OneLoginAuth { + // (undocumented) + static create({ discoveryApi, environment, provider, oauthRequestApi, }: CreateOptions_2): typeof oneloginAuthApiRef.T; +} + +// @public (undocumented) +export class SamlAuth implements ProfileInfoApi, BackstageIdentityApi, SessionApi { + constructor(sessionManager: SessionManager); + // (undocumented) + static create({ discoveryApi, environment, provider, }: AuthApiCreateOptions): SamlAuth; + // (undocumented) + getBackstageIdentity(options?: AuthRequestOptions): Promise; + // (undocumented) + getProfile(options?: AuthRequestOptions): Promise; + // (undocumented) + sessionState$(): Observable; + // (undocumented) + signIn(): Promise; + // (undocumented) + signOut(): Promise; +} + +// @public (undocumented) +export type SignInPageProps = { + onResult(result: SignInResult): void; +}; + +// @public (undocumented) +export type SignInResult = { + userId: string; + profile: ProfileInfo; + getIdToken?: () => Promise; + signOut?: () => Promise; +}; + +// @public +export class UrlPatternDiscovery implements DiscoveryApi { + static compile(pattern: string): UrlPatternDiscovery; + // (undocumented) + getBaseUrl(pluginId: string): Promise; + } + +// @public (undocumented) +export class WebStorage implements StorageApi { + constructor(namespace: string, errorApi: ErrorApi); + // (undocumented) + static create(options: CreateStorageApiOptions): WebStorage; + // (undocumented) + forBucket(name: string): WebStorage; + // (undocumented) + get(key: string): T | undefined; + // (undocumented) + observe$(key: string): Observable>; + // (undocumented) + remove(key: string): Promise; + // (undocumented) + set(key: string, data: T): Promise; + } + + +// (No @packageDocumentation comment for this package) + +``` diff --git a/packages/core-plugin-api/api-report.md b/packages/core-plugin-api/api-report.md new file mode 100644 index 0000000000..339873cd85 --- /dev/null +++ b/packages/core-plugin-api/api-report.md @@ -0,0 +1,529 @@ +## API Report File for "@backstage/core-plugin-api" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { BackstageTheme } from '@backstage/theme'; +import { ComponentType } from 'react'; +import { Config } from '@backstage/config'; +import { default as React_2 } from 'react'; +import { ReactNode } from 'react'; + +// @public +export type AlertApi = { + post(alert: AlertMessage): void; + alert$(): Observable; +}; + +// @public (undocumented) +export const alertApiRef: ApiRef; + +// @public (undocumented) +export type AlertMessage = { + message: string; + severity?: 'success' | 'info' | 'warning' | 'error'; +}; + +// @public (undocumented) +export type AnyApiFactory = ApiFactory; + +// @public (undocumented) +export type AnyApiRef = ApiRef; + +// @public (undocumented) +export type ApiFactory = { + api: ApiRef; + deps: TypesToApiRefs; + factory(deps: Deps): Impl; +}; + +// @public (undocumented) +export type ApiHolder = { + get(api: ApiRef): T | undefined; +}; + +// @public (undocumented) +export type ApiRef = { + id: string; + T: T; +}; + +// @public (undocumented) +export type ApiRefsToTypes; +}> = { + [key in keyof T]: ApiRefType; +}; + +// @public (undocumented) +export type ApiRefType = T extends ApiRef ? U : never; + +// @public (undocumented) +export type AppComponents = { + NotFoundErrorPage: ComponentType<{}>; + BootErrorPage: ComponentType; + Progress: ComponentType<{}>; + Router: ComponentType<{}>; + SignInPage?: ComponentType; +}; + +// @public (undocumented) +export type AppContext = { + getPlugins(): BackstagePlugin[]; + getSystemIcon(key: string): IconComponent | undefined; + getComponents(): AppComponents; +}; + +// @public +export type AppTheme = { + id: string; + title: string; + variant: 'light' | 'dark'; + theme: BackstageTheme; + icon?: React.ReactElement; +}; + +// @public +export type AppThemeApi = { + getInstalledThemes(): AppTheme[]; + activeThemeId$(): Observable; + getActiveThemeId(): string | undefined; + setActiveThemeId(themeId?: string): void; +}; + +// @public (undocumented) +export const appThemeApiRef: ApiRef; + +// @public (undocumented) +export function attachComponentData

(component: ComponentType

, type: string, data: unknown): void; + +// @public +export const auth0AuthApiRef: ApiRef; + +// @public +export type AuthProvider = { + title: string; + icon: IconComponent; +}; + +// @public +export type AuthRequester = (scopes: Set) => Promise; + +// @public +export type AuthRequesterOptions = { + provider: AuthProvider; + onAuthRequest(scopes: Set): Promise; +}; + +// @public (undocumented) +export type AuthRequestOptions = { + optional?: boolean; + instantPopup?: boolean; +}; + +// @public (undocumented) +export type BackstageIdentity = { + id: string; + idToken: string; +}; + +// @public +export type BackstageIdentityApi = { + getBackstageIdentity(options?: AuthRequestOptions): Promise; +}; + +// @public (undocumented) +export type BackstagePlugin = { + getId(): string; + output(): PluginOutput[]; + getApis(): Iterable; + provide(extension: Extension): T; + routes: Routes; + externalRoutes: ExternalRoutes; +}; + +// @public (undocumented) +export type BootErrorPageProps = { + step: 'load-config' | 'load-chunk'; + error: Error; +}; + +// @public +export type ConfigApi = Config; + +// @public (undocumented) +export const configApiRef: ApiRef; + +// @public +export function createApiFactory(factory: ApiFactory): ApiFactory; + +// @public (undocumented) +export function createApiFactory(api: ApiRef, instance: Impl): ApiFactory; + +// @public (undocumented) +export function createApiRef(config: ApiRefConfig): ApiRef; + +// @public (undocumented) +export function createComponentExtension JSX.Element>(options: { + component: ComponentLoader; +}): Extension; + +// @public (undocumented) +export function createExternalRouteRef(options: { + id: string; + params?: ParamKey[]; + optional?: Optional; +}): ExternalRouteRef, Optional>; + +// @public (undocumented) +export function createPlugin(config: PluginConfig): BackstagePlugin; + +// @public (undocumented) +export function createReactExtension JSX.Element>(options: { + component: ComponentLoader; + data?: Record; +}): Extension; + +// @public (undocumented) +export function createRoutableExtension JSX.Element>(options: { + component: () => Promise; + mountPoint: RouteRef; +}): Extension; + +// @public (undocumented) +export function createRouteRef(config: { + id?: string; + params?: ParamKey[]; + path?: string; + icon?: IconComponent; + title?: string; +}): RouteRef>; + +// @public (undocumented) +export function createSubRouteRef(config: { + id: string; + path: Path; + parent: RouteRef; +}): MakeSubRouteRef, ParentParams>; + +// @public +export type DiscoveryApi = { + getBaseUrl(pluginId: string): Promise; +}; + +// @public (undocumented) +export const discoveryApiRef: ApiRef; + +// @public +export type ErrorApi = { + post(error: Error_2, context?: ErrorContext): void; + error$(): Observable<{ + error: Error_2; + context?: ErrorContext; + }>; +}; + +// @public (undocumented) +export const errorApiRef: ApiRef; + +// @public +export type ErrorContext = { + hidden?: boolean; +}; + +// @public (undocumented) +export type Extension = { + expose(plugin: BackstagePlugin): T; +}; + +// @public (undocumented) +export type ExternalRouteRef = { + readonly [routeRefType]: 'external'; + params: ParamKeys; + optional?: Optional; +}; + +// @public +export type FeatureFlag = { + name: string; + pluginId: string; +}; + +// @public (undocumented) +export type FeatureFlagOutput = { + type: 'feature-flag'; + name: string; +}; + +// @public (undocumented) +export interface FeatureFlagsApi { + getRegisteredFlags(): FeatureFlag[]; + isActive(name: string): boolean; + registerFlag(flag: FeatureFlag): void; + save(options: FeatureFlagsSaveOptions): void; +} + +// @public (undocumented) +export const featureFlagsApiRef: ApiRef; + +// @public (undocumented) +export type FeatureFlagsHooks = { + register(name: string): void; +}; + +// @public +export type FeatureFlagsSaveOptions = { + states: Record; + merge?: boolean; +}; + +// @public (undocumented) +export enum FeatureFlagState { + // (undocumented) + Active = 1, + // (undocumented) + None = 0 +} + +// @public (undocumented) +export function getComponentData(node: ReactNode, type: string): T | undefined; + +// @public +export const githubAuthApiRef: ApiRef; + +// @public +export const gitlabAuthApiRef: ApiRef; + +// @public +export const googleAuthApiRef: ApiRef; + +// @public +export type IconComponent = ComponentType<{ + fontSize?: 'default' | 'small' | 'large'; +}>; + +// @public +export type IdentityApi = { + getUserId(): string; + getProfile(): ProfileInfo; + getIdToken(): Promise; + signOut(): Promise; +}; + +// @public (undocumented) +export const identityApiRef: ApiRef; + +// @public +export const microsoftAuthApiRef: ApiRef; + +// @public +export const oauth2ApiRef: ApiRef; + +// @public +export type OAuthApi = { + getAccessToken(scope?: OAuthScope, options?: AuthRequestOptions): Promise; +}; + +// @public +export type OAuthRequestApi = { + createAuthRequester(options: AuthRequesterOptions): AuthRequester; + authRequest$(): Observable; +}; + +// @public (undocumented) +export const oauthRequestApiRef: ApiRef; + +// @public +export type OAuthScope = string | string[]; + +// @public +export type Observable = { + [Symbol.observable](): Observable; + subscribe(observer: Observer): Subscription; + subscribe(onNext?: (value: T) => void, onError?: (error: Error) => void, onComplete?: () => void): Subscription; +}; + +// @public +export type Observer = { + next?(value: T): void; + error?(error: Error): void; + complete?(): void; +}; + +// @public +export const oidcAuthApiRef: ApiRef; + +// @public +export const oktaAuthApiRef: ApiRef; + +// @public (undocumented) +export const oneloginAuthApiRef: ApiRef; + +// @public +export type OpenIdConnectApi = { + getIdToken(options?: AuthRequestOptions): Promise; +}; + +// @public +export type PendingAuthRequest = { + provider: AuthProvider; + reject: () => void; + trigger(): Promise; +}; + +// @public (undocumented) +export type PluginConfig = { + id: string; + apis?: Iterable; + register?(hooks: PluginHooks): void; + routes?: Routes; + externalRoutes?: ExternalRoutes; +}; + +// @public (undocumented) +export type PluginHooks = { + featureFlags: FeatureFlagsHooks; +}; + +// @public (undocumented) +export type PluginOutput = FeatureFlagOutput; + +// @public +export type ProfileInfo = { + email?: string; + displayName?: string; + picture?: string; +}; + +// @public +export type ProfileInfoApi = { + getProfile(options?: AuthRequestOptions): Promise; +}; + +// @public (undocumented) +export type RouteOptions = { + exact?: boolean; +}; + +// @public (undocumented) +export type RoutePath = string; + +// @public (undocumented) +export type RouteRef = { + readonly [routeRefType]: 'absolute'; + params: ParamKeys; + path: string; + icon?: IconComponent; + title?: string; +}; + +// @public +export const samlAuthApiRef: ApiRef; + +// @public +export type SessionApi = { + signIn(): Promise; + signOut(): Promise; + sessionState$(): Observable; +}; + +// @public +export enum SessionState { + // (undocumented) + SignedIn = "SignedIn", + // (undocumented) + SignedOut = "SignedOut" +} + +// @public (undocumented) +export type SignInPageProps = { + onResult(result: SignInResult): void; +}; + +// @public (undocumented) +export type SignInResult = { + userId: string; + profile: ProfileInfo; + getIdToken?: () => Promise; + signOut?: () => Promise; +}; + +// @public (undocumented) +export interface StorageApi { + forBucket(name: string): StorageApi; + get(key: string): T | undefined; + observe$(key: string): Observable>; + remove(key: string): Promise; + set(key: string, data: any): Promise; +} + +// @public (undocumented) +export const storageApiRef: ApiRef; + +// @public (undocumented) +export type StorageValueChange = { + key: string; + newValue?: T; +}; + +// @public (undocumented) +export type SubRouteRef = { + readonly [routeRefType]: 'sub'; + parent: RouteRef; + path: string; + params: ParamKeys; +}; + +// @public +export type Subscription = { + unsubscribe(): void; + readonly closed: boolean; +}; + +// @public (undocumented) +export type TypesToApiRefs = { + [key in keyof T]: ApiRef; +}; + +// @public (undocumented) +export function useApi(apiRef: ApiRef): T; + +// @public (undocumented) +export function useApiHolder(): ApiHolder; + +// @public (undocumented) +export const useApp: () => AppContext; + +// @public (undocumented) +export type UserFlags = {}; + +// @public (undocumented) +export function useRouteRef(routeRef: ExternalRouteRef): Optional extends true ? RouteFunc | undefined : RouteFunc; + +// @public (undocumented) +export function useRouteRef(routeRef: RouteRef | SubRouteRef): RouteFunc; + +// @public (undocumented) +export function useRouteRefParams(_routeRef: RouteRef | SubRouteRef): Params; + +// @public (undocumented) +export function withApis(apis: TypesToApiRefs):

(WrappedComponent: React_2.ComponentType

) => { + (props: React_2.PropsWithChildren>): JSX.Element; + displayName: string; +}; + + +// (No @packageDocumentation comment for this package) + +``` diff --git a/scripts/api-extractor.ts b/scripts/api-extractor.ts index 37dc4769fd..555bad10e0 100644 --- a/scripts/api-extractor.ts +++ b/scripts/api-extractor.ts @@ -67,9 +67,10 @@ const DOCUMENTED_PACKAGES = [ 'packages/cli-common', 'packages/config', 'packages/config-loader', + 'packages/core-app-api', // TODO(Rugvip): Enable these once `import * as ...` and `import()` PRs have landed, #1796 & #1916. - // 'packages/core', - // 'packages/core-api', + // 'packages/core-components', + 'packages/core-plugin-api', 'packages/dev-utils', 'packages/errors', 'packages/integration',