docs: update api reports

Signed-off-by: Camila Belo <camilaibs@gmail.com>
This commit is contained in:
Camila Belo
2023-11-13 10:09:56 +01:00
parent 9f07394a99
commit 6ee84d8fdc
@@ -86,6 +86,51 @@ export { alertApiRef };
export { AlertMessage };
// @public
export type AnalyticsApi = {
captureEvent(event: AnalyticsEvent): void;
};
// @public
export const analyticsApiRef: ApiRef<AnalyticsApi>;
// @public
export const AnalyticsContext: (options: {
attributes: Partial<AnalyticsContextValue>;
children: ReactNode;
}) => React_2.JSX.Element;
// @public
export type AnalyticsContextValue = CommonAnalyticsContext & {
[param in string]: string | boolean | number | undefined;
};
// @public
export type AnalyticsEvent = {
action: string;
subject: string;
value?: number;
attributes?: AnalyticsEventAttributes;
context: AnalyticsContextValue;
};
// @public
export type AnalyticsEventAttributes = {
[attribute in string]: string | boolean | number;
};
// @public
export type AnalyticsTracker = {
captureEvent: (
action: string,
subject: string,
options?: {
value?: number;
attributes?: AnalyticsEventAttributes;
},
) => void;
};
export { AnyApiFactory };
export { AnyApiRef };
@@ -233,6 +278,13 @@ export { bitbucketAuthApiRef };
export { bitbucketServerAuthApiRef };
// @public
export type CommonAnalyticsContext = {
pluginId: string;
routeRef: string;
extension: string;
};
export { ConfigApi };
export { configApiRef };
@@ -770,6 +822,9 @@ export interface SubRouteRef<
export { TypesToApiRefs };
// @public
export function useAnalytics(): AnalyticsTracker;
export { useApi };
export { useApiHolder };