diff --git a/plugins/cost-insights/api-report.md b/plugins/cost-insights/api-report.md index 9092791d9b..97dd33e5ad 100644 --- a/plugins/cost-insights/api-report.md +++ b/plugins/cost-insights/api-report.md @@ -8,7 +8,6 @@ import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePalette } from '@backstage/theme'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { BackstageTheme } from '@backstage/theme'; -import { ClassNameMap } from '@material-ui/styles'; import { ContentRenderer } from 'recharts'; import { Dispatch } from 'react'; import { ForwardRefExoticComponent } from 'react'; @@ -19,16 +18,9 @@ import { RechartsFunction } from 'recharts'; import { RefAttributes } from 'react'; import { RouteRef } from '@backstage/core-plugin-api'; import { SetStateAction } from 'react'; -import { TooltipPayload } from 'recharts'; import { TooltipProps } from 'recharts'; import { TypographyProps } from '@material-ui/core'; -// @public (undocumented) -export const aggregationSort: (a: DateAggregation, b: DateAggregation) => number; - -// @public (undocumented) -export const aggregationSum: (aggregation: DateAggregation[]) => number; - // @public export type Alert = { title: string | JSX.Element; @@ -133,12 +125,6 @@ export enum AlertStatus { Snoozed = "snoozed" } -// @public (undocumented) -export function assertAlways(argument: T | undefined): T; - -// @public (undocumented) -export function assertNever(x: never): never; - // @public (undocumented) export const BarChart: ({ resources, responsive, displayAmount, options, tooltip, onClick, onMouseMove, }: BarChartProps) => JSX.Element; @@ -208,9 +194,6 @@ export type BarChartTooltipProps = { actions?: ReactNode; }; -// @public (undocumented) -export function brighten(color: string, coefficient?: number): string; - // @public (undocumented) export interface ChangeStatistic { // (undocumented) @@ -235,9 +218,6 @@ export type ChartData = { [key: string]: number; }; -// @public (undocumented) -export function choose([savings, excess]: [T, T], change: ChangeStatistic): T; - // @public (undocumented) export interface Cost { // (undocumented) @@ -252,9 +232,6 @@ export interface Cost { trendline?: Trendline; } -// @public (undocumented) -export const costFormatter: Intl.NumberFormat; - // @public (undocumented) export const CostGrowth: ({ change, duration }: CostGrowthProps) => JSX.Element; @@ -288,15 +265,9 @@ export type CostInsightsApi = { // @public (undocumented) export const costInsightsApiRef: ApiRef; -// @public (undocumented) -export const costInsightsDarkTheme: CostInsightsThemeOptions; - // @public (undocumented) export const CostInsightsLabelDataflowInstructionsPage: () => JSX.Element; -// @public (undocumented) -export const costInsightsLightTheme: CostInsightsThemeOptions; - // @public (undocumented) export const CostInsightsPage: () => JSX.Element; @@ -346,9 +317,6 @@ export interface Currency { unit: string; } -// @public (undocumented) -export const currencyFormatter: Intl.NumberFormat; - // @public (undocumented) export enum CurrencyType { // (undocumented) @@ -377,42 +345,9 @@ export type DateAggregation = { amount: number; }; -// @public (undocumented) -export const dateFormatter: Intl.DateTimeFormat; - // @public (undocumented) export const DEFAULT_DATE_FORMAT = "yyyy-LL-dd"; -// @public (undocumented) -export const DEFAULT_DURATION = Duration.P30D; - -// @public (undocumented) -export const defaultCurrencies: Currency[]; - -// @public (undocumented) -export enum DefaultLoadingAction { - // (undocumented) - CostInsightsAlerts = "cost-insights-alerts", - // (undocumented) - CostInsightsInitial = "cost-insights-initial", - // (undocumented) - CostInsightsPage = "cost-insights-page", - // (undocumented) - CostInsightsProducts = "cost-insights-products", - // (undocumented) - LastCompleteBillingDate = "billing-date", - // (undocumented) - UserGroups = "user-groups" -} - -// @public (undocumented) -export enum DefaultNavigation { - // (undocumented) - AlertInsightsHeader = "alert-insights-header", - // (undocumented) - CostOverviewCard = "cost-overview-card" -} - // @public export enum Duration { // (undocumented) @@ -460,82 +395,11 @@ export class ExampleCostInsightsClient implements CostInsightsApi { getUserGroups(userId: string): Promise; } -// @public (undocumented) -export function exclusiveEndDateOf(duration: Duration, inclusiveEndDate: string): string; - -// @public (undocumented) -export function findAlways(collection: T[], callback: (el: T) => boolean): T; - -// @public (undocumented) -export function findAnyKey(record: Record | undefined): string | undefined; - -// @public (undocumented) -export function formatChange(change: ChangeStatistic): string; - -// @public (undocumented) -export function formatCurrency(amount: number, currency?: string): string; - -// @public (undocumented) -export function formatGraphValue(value: number, format?: string): string; - -// @public (undocumented) -export function formatLastTwoLookaheadQuarters(inclusiveEndDate: string): string; - -// @public (undocumented) -export function formatPercent(n: number): string; - -// @public (undocumented) -export function formatPeriod(duration: Duration, date: string, isEndDate: boolean): string; - -// @public (undocumented) -export function getComparedChange(dailyCost: Cost, metricData: MetricData, duration: Duration, lastCompleteBillingDate: string): ChangeStatistic; - -// @public (undocumented) -export const getDefaultNavigationItems: (alerts: number) => NavigationItem[]; - -// @public (undocumented) -export function getDefaultPageFilters(groups: Group[]): PageFilters; - -// @public (undocumented) -export const getDefaultState: (loadingActions: string[]) => Loading; - -// @public (undocumented) -export function getIcon(icon?: string): JSX.Element; - -// @public (undocumented) -export const getInitialPageState: (groups: Group[], queryParams?: Partial) => { - group: Maybe; - project: Maybe; - duration: Duration; - metric: string | null; -}; - -// @public (undocumented) -export const getInitialProductState: (config: ConfigContextProps) => { - productType: string; - duration: Duration; -}[]; - -// @public (undocumented) -export function getPreviousPeriodTotalCost(aggregation: DateAggregation[], duration: Duration, inclusiveEndDate: string): number; - -// @public (undocumented) -export const getResetState: (loadingActions: string[]) => Loading; - -// @public (undocumented) -export const getResetStateWithoutInitial: (loadingActions: string[]) => Loading; - // @public (undocumented) export type Group = { id: string; }; -// @public (undocumented) -export function groupByDate(acc: Record, entry: DateAggregation): Record; - -// @public (undocumented) -export function growthOf(change: ChangeStatistic): GrowthType; - // @public (undocumented) export enum GrowthType { // (undocumented) @@ -568,39 +432,6 @@ export enum IconType { Storage = "storage" } -// @public (undocumented) -export function inclusiveEndDateOf(duration: Duration, inclusiveEndDate: string): string; - -// @public -export function inclusiveStartDateOf(duration: Duration, inclusiveEndDate: string): string; - -// @public (undocumented) -export const indefiniteArticleOf: (articles: [string, string], word: string) => string; - -// @public (undocumented) -export const INITIAL_LOADING_ACTIONS: DefaultLoadingAction[]; - -// @public (undocumented) -export const initialStatesOf: (products: Product[], responses: Array>) => ProductState[]; - -// @public (undocumented) -export function intervalsOf(duration: Duration, inclusiveEndDate: string, repeating?: number): string; - -// @public (undocumented) -export const isInvalid: ({ label, payload }: TooltipProps) => boolean; - -// @public (undocumented) -export const isLabeled: (data?: Record<"activeLabel", string | undefined> | undefined) => boolean | "" | undefined; - -// @public (undocumented) -export function isNull(value: any): boolean; - -// @public (undocumented) -export function isUndefined(value: any): value is undefined; - -// @public (undocumented) -export const isUnlabeled: (data?: Record<"activeLabel", string | undefined> | undefined) => boolean; - // @public (undocumented) export const LegendItem: ({ title, tooltipText, markerColor, children, }: PropsWithChildren) => JSX.Element; @@ -611,9 +442,6 @@ export type LegendItemProps = { markerColor?: string; }; -// @public (undocumented) -export const lengthyCurrencyFormatter: Intl.NumberFormat; - // @public (undocumented) export type Loading = Record; @@ -645,28 +473,6 @@ export const MockConfigProvider: ({ children, ...context }: MockConfigProviderPr // @public (undocumented) export const MockCurrencyProvider: ({ children, ...context }: MockCurrencyProviderProps) => JSX.Element; -// @public (undocumented) -export const monthFormatter: Intl.DateTimeFormat; - -// @public (undocumented) -export const monthOf: (date: string) => string; - -// @public (undocumented) -export type NavigationItem = { - navigation: string; - icon: JSX.Element; - title: string; -}; - -// @public (undocumented) -export function notEmpty(value: TValue | null | undefined): value is TValue; - -// @public (undocumented) -export const numberFormatter: Intl.NumberFormat; - -// @public (undocumented) -export const overviewGraphTickFormatter: (millis: string | number) => string; - // @public (undocumented) export interface PageFilters { // (undocumented) @@ -679,15 +485,6 @@ export interface PageFilters { project: Maybe; } -// @public (undocumented) -export const parse: (queryString: string) => Partial; - -// @public (undocumented) -export type Period = { - periodStart: string; - periodEnd: string; -}; - // @public (undocumented) export interface Product { // (undocumented) @@ -715,13 +512,6 @@ export interface ProductPeriod { productType: string; } -// @public (undocumented) -export type ProductState = { - product: Product; - entity: Maybe; - duration: Duration; -}; - // @public (undocumented) export interface Project { // (undocumented) @@ -761,15 +551,6 @@ export interface ProjectGrowthData { project: string; } -// @public (undocumented) -export function quarterEndDate(inclusiveEndDate: string): string; - -// @public (undocumented) -export const quarterOf: (date: string) => string; - -// @public (undocumented) -export const rateOf: (cost: number, duration: Duration) => number; - // @public (undocumented) export interface ResourceData { // (undocumented) @@ -780,40 +561,6 @@ export interface ResourceData { previous: number; } -// @public (undocumented) -export const resourceOf: (entity: Entity | AlertCost) => ResourceData; - -// @public (undocumented) -export const resourceSort: (a: ResourceData, b: ResourceData) => number; - -// @public (undocumented) -export const ScrollAnchor: ({ id, left, top, block, inline, behavior, }: ScrollAnchorProps) => JSX.Element; - -// @public (undocumented) -export interface ScrollAnchorProps extends ScrollIntoViewOptions { - // (undocumented) - id: ScrollTo; - // (undocumented) - left?: number; - // (undocumented) - top?: number; -} - -// @public (undocumented) -export const settledResponseOf: (responses: PromiseSettledResult[]) => Array>; - -// @public (undocumented) -export const stringify: (queryParams: Partial) => string; - -// @public (undocumented) -export const titleOf: (label?: string | number | undefined) => string; - -// @public (undocumented) -export function toDataMax(metric: string, data: ChartData[]): number; - -// @public (undocumented) -export function toMaxCost(acc: ChartData, entry: ChartData): ChartData; - // @public (undocumented) export type TooltipItem = { fill: string; @@ -821,19 +568,6 @@ export type TooltipItem = { value: string; }; -// @public (undocumented) -export const tooltipItemOf: (payload: TooltipPayload) => { - label: string; - value: string; - fill: string; -} | null; - -// @public (undocumented) -export function totalAggregationSort(a: ProductState, b: ProductState): number; - -// @public (undocumented) -export function trendFrom(trendline: Trendline, date: number): number; - // @public (undocumented) export type Trendline = { slope: number; @@ -881,132 +615,6 @@ export interface UnlabeledDataflowData { unlabeledCost: number; } -// @public (undocumented) -export const useActionItemCardStyles: (props?: any) => ClassNameMap; - -// @public (undocumented) -export const useAlertCardActionHeaderStyles: (props?: any) => ClassNameMap; - -// @public (undocumented) -export const useAlertDialogStyles: (props?: any) => ClassNameMap<"radio" | "icon" | "content" | "actions">; - -// @public (undocumented) -export const useAlertInsightsSectionStyles: (props?: any) => ClassNameMap; - -// @public (undocumented) -export const useAlertStatusSummaryButtonStyles: (props?: any) => ClassNameMap<"icon" | "clicked">; - -// @public (undocumented) -export const useBackdropStyles: (props?: any) => ClassNameMap; - -// @public (undocumented) -export const useBarChartLabelStyles: (props?: any) => ClassNameMap; - -// @public (undocumented) -export const useBarChartLayoutStyles: (props?: any) => ClassNameMap; - -// @public (undocumented) -export const useBarChartStepperButtonStyles: (props?: any) => ClassNameMap; - -// @public (undocumented) -export const useBarChartStepperStyles: (props?: any) => ClassNameMap; - -// @public (undocumented) -export const useBarChartStyles: (theme: CostInsightsTheme) => { - axis: { - fill: string; - }; - barChart: { - margin: { - left: number; - right: number; - }; - }; - cartesianGrid: { - stroke: string; - }; - cursor: { - fill: string; - fillOpacity: number; - }; - container: { - height: number; - width: number; - }; - infoIcon: { - marginLeft: number; - fontSize: string; - }; - xAxis: { - height: number; - }; -}; - -// @public (undocumented) -export const useCostGrowthLegendStyles: (props?: any) => ClassNameMap; - -// @public (undocumented) -export const useCostGrowthStyles: (props?: any) => ClassNameMap; - -// @public (undocumented) -export const useCostInsightsStyles: (props?: any) => ClassNameMap; - -// @public (undocumented) -export const useCostInsightsTabsStyles: (props?: any) => ClassNameMap; - -// @public (undocumented) -export const useCostOverviewStyles: (theme: CostInsightsTheme) => { - axis: { - fill: string; - }; - container: { - height: number; - width: number; - }; - cartesianGrid: { - stroke: string; - }; - chart: { - margin: { - right: number; - top: number; - }; - }; - yAxis: { - width: number; - }; -}; - -// @public (undocumented) -export const useEntityDialogStyles: (props?: any) => ClassNameMap; - -// @public (undocumented) -export const useNavigationStyles: (props?: any) => ClassNameMap; - -// @public (undocumented) -export const useOverviewTabsStyles: (props?: any) => ClassNameMap; - -// @public (undocumented) -export const useProductInsightsCardStyles: (props?: any) => ClassNameMap; - -// @public (undocumented) -export const useProductInsightsChartStyles: (props?: any) => ClassNameMap; - -// @public (undocumented) -export const useSelectStyles: (props?: any) => ClassNameMap; - -// @public (undocumented) -export const useSubtleTypographyStyles: (props?: any) => ClassNameMap; - -// @public (undocumented) -export const useTooltipStyles: (props?: any) => ClassNameMap; - -// @public (undocumented) -export const validate: (queryString: string) => Promise; - -// @public (undocumented) -export function validateMetrics(metrics: Metric[]): void; - // (No @packageDocumentation comment for this package)