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

update API reports for createApp split

Browse Source 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2021-10-29 16:49:45 +02:00
parent b7958c36db
commit c1578d609b
4 changed files with 41 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/app-defaults/api-report.md
+26
View File
@@ -0,0 +1,26 @@
## API Report File for "@backstage/app-defaults"
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { AppComponents } from '@backstage/core-app-api';
import { AppIcons } from '@backstage/core-app-api';
import { AppManager } from '@backstage/core-app-api/src/app/AppManager';
import { AppOptions } from '@backstage/core-app-api';
import { AppTheme } from '@backstage/core-plugin-api';
import { IconComponent } from '@backstage/core-plugin-api';
// @public
export function createApp(
options?: Omit<AppOptions, keyof OptionalAppOptions> & OptionalAppOptions,
): AppManager;
// @public
export type OptionalAppOptions = {
icons?: Partial<AppIcons> & {
[key in string]: IconComponent;
};
themes?: (Partial<AppTheme> & Omit<AppTheme, 'theme'>)[];
components?: Partial<AppComponents>;
};
```
packages/core-app-api/api-report.md
+14 -6
View File
@@ -45,6 +45,7 @@ import { Observable } from '@backstage/types';
import { oktaAuthApiRef } from '@backstage/core-plugin-api';
import { oneloginAuthApiRef } from '@backstage/core-plugin-api';
import { OpenIdConnectApi } from '@backstage/core-plugin-api';
import { OptionalAppOptions } from '@backstage/app-defaults';
import { PendingAuthRequest } from '@backstage/core-plugin-api';
import { PluginOutput } from '@backstage/core-plugin-api';
import { ProfileInfo } from '@backstage/core-plugin-api';
@@ -150,7 +151,7 @@ export type AppComponents = {
Progress: ComponentType<{}>;
Router: ComponentType<{}>;
ErrorBoundaryFallback: ComponentType<ErrorBoundaryFallbackProps>;
ThemeProvider: ComponentType<{}>;
ThemeProvider?: ComponentType<{}>;
SignInPage?: ComponentType<SignInPageProps>;
};
@@ -189,12 +190,13 @@ export type AppIcons = {
// @public
export type AppOptions = {
apis?: Iterable<AnyApiFactory>;
icons?: Partial<AppIcons> & {
defaultApis?: Iterable<AnyApiFactory>;
icons: AppIcons & {
[key in string]: IconComponent;
};
plugins?: BackstagePluginWithAnyOutput[];
components?: Partial<AppComponents>;
themes?: (Partial<AppTheme> & Omit<AppTheme, 'theme'>)[];
components: AppComponents;
themes: (Partial<AppTheme> & Omit<AppTheme, 'theme'>)[];
configLoader?: AppConfigLoader;
bindRoutes?(context: { bind: AppRouteBinder }): void;
};
@@ -308,10 +310,16 @@ export type BootErrorPageProps = {
export { ConfigReader };
// Warning: (ae-forgotten-export) The symbol "PrivateAppImpl" needs to be exported by the entry point index.d.ts
// Warning: (tsdoc-characters-after-block-tag) The token "@backstage" looks like a TSDoc tag but contains an invalid character "/"; if it is not a tag, use a backslash to escape the "@"
// Warning: (ae-forgotten-export) The symbol "AppManager" needs to be exported by the entry point index.d.ts
//
// @public @deprecated
export function createApp(options?: OptionalAppOptions): AppManager;
// Warning: (ae-missing-release-tag) "createSpecializedApp" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function createApp(options?: AppOptions): PrivateAppImpl;
export function createSpecializedApp(options: AppOptions): AppManager;
// @public
export const defaultConfigLoader: AppConfigLoader;
packages/core-components/api-report.md
-33
View File
@@ -5,26 +5,20 @@
```ts
/// <reference types="react" />
import { AnyApiFactory } 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 { BackstageIdentityApi } from '@backstage/core-plugin-api';
import { BackstagePalette } from '@backstage/theme';
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { BackstageTheme } from '@backstage/theme';
import { ButtonProps as ButtonProps_2 } from '@material-ui/core/Button';
import { CardHeaderProps } from '@material-ui/core/CardHeader';
import { Column } from '@material-table/core';
import { ComponentClass } from 'react';
import { ComponentProps } from 'react';
import { ComponentType } from 'react';
import { Context } from 'react';
import { default as CSS_2 } from 'csstype';
import { CSSProperties } from 'react';
import { ElementType } from 'react';
import { ErrorInfo } from 'react';
import { ExternalRouteRef } from '@backstage/core-plugin-api';
import { IconComponent } from '@backstage/core-plugin-api';
import { LinearProgressProps } from '@material-ui/core/LinearProgress';
import { LinkProps as LinkProps_2 } from '@material-ui/core/Link';
@@ -33,15 +27,12 @@ import MaterialBreadcrumbs from '@material-ui/core/Breadcrumbs';
import { MaterialTableProps } from '@material-table/core';
import { NavLinkProps } from 'react-router-dom';
import { Overrides } from '@material-ui/core/styles/overrides';
import { PluginOutput } from '@backstage/core-plugin-api';
import { ProfileInfo } from '@backstage/core-plugin-api';
import { ProfileInfoApi } from '@backstage/core-plugin-api';
import { PropsWithChildren } from 'react';
import { default as React_2 } from 'react';
import * as React_3 from 'react';
import { ReactElement } from 'react';
import { ReactNode } from 'react';
import { RouteRef } from '@backstage/core-plugin-api';
import { SessionApi } from '@backstage/core-plugin-api';
import { SignInPageProps } from '@backstage/core-plugin-api';
import { SparklinesLineProps } from 'react-sparklines';
@@ -49,7 +40,6 @@ import { SparklinesProps } from 'react-sparklines';
import { StyledComponentProps } from '@material-ui/core/styles';
import { StyleRules } from '@material-ui/styles';
import { StyleRules as StyleRules_2 } from '@material-ui/core/styles/withStyles';
import { SubRouteRef } from '@backstage/core-plugin-api';
import { TabProps } from '@material-ui/core/Tab';
import { TextTruncateProps } from 'react-text-truncate';
import { Theme } from '@material-ui/core/styles';
@@ -681,22 +671,6 @@ export type OAuthRequestDialogClassKey =
// @public (undocumented)
export type OpenedDropdownClassKey = 'icon';
// @public
export interface OptionalAppOptions {
// Warning: (ae-forgotten-export) The symbol "AppComponents" needs to be exported by the entry point index.d.ts
//
// (undocumented)
components?: Partial<AppComponents>;
// Warning: (ae-forgotten-export) The symbol "AppIcons" needs to be exported by the entry point index.d.ts
//
// (undocumented)
icons?: Partial<AppIcons> & {
[key in string]: IconComponent;
};
// (undocumented)
themes?: (Partial<AppTheme> & Omit<AppTheme, 'theme'>)[];
}
// Warning: (ae-forgotten-export) The symbol "Props" needs to be exported by the entry point index.d.ts
// Warning: (ae-missing-release-tag) "OverflowTooltip" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
@@ -2344,13 +2318,6 @@ export type WarningPanelClassKey =
| 'message'
| 'details';
// Warning: (ae-forgotten-export) The symbol "AppOptions" needs to be exported by the entry point index.d.ts
//
// @public
export function withDefaults(
options?: Omit<AppOptions, keyof OptionalAppOptions> & OptionalAppOptions,
): AppOptions;
// Warnings were encountered during analysis:
//
// src/components/DependencyGraph/types.d.ts:16:5 - (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/core-components" does not have an export "DependencyNode"
packages/core-plugin-api/api-report.md
+1 -1
View File
@@ -164,7 +164,7 @@ export type AppComponents = {
Progress: ComponentType<{}>;
Router: ComponentType<{}>;
ErrorBoundaryFallback: ComponentType<ErrorBoundaryFallbackProps>;
ThemeProvider: ComponentType<{}>;
ThemeProvider?: ComponentType<{}>;
SignInPage?: ComponentType<SignInPageProps>;
};