chore: dedupe license headers and narrow tool dependency type

Author: patrykkopycinski

src/core/packages/analytics/server/index.d.ts

@@ -0,0 +1,2 @@
+export type { AnalyticsServiceSetup, AnalyticsServiceStart, AnalyticsServicePreboot, } from './src/contracts';
+export type { AnalyticsClient, AnalyticsClientInitContext, ShipperClassConstructor, RegisterShipperOpts, OptInConfig, OptInConfigPerType, ShipperName, ContextProviderOpts, ContextProviderName, EventTypeOpts, Event, EventContext, EventType, TelemetryCounter, TelemetryCounterType, RootSchema, SchemaObject, SchemaArray, SchemaChildValue, SchemaMeta, SchemaValue, SchemaMetaOptional, PossibleSchemaTypes, AllowedSchemaBooleanTypes, AllowedSchemaNumberTypes, AllowedSchemaStringTypes, AllowedSchemaTypes, IShipper, } from '@elastic/ebt/client';

src/core/packages/analytics/server/src/contracts.d.ts

@@ -0,0 +1,19 @@
+import type { AnalyticsClient } from '@elastic/ebt/client';
+/**
+ * Exposes the public APIs of the AnalyticsClient during the preboot phase
+ * {@link AnalyticsClient}
+ * @public
+ */
+export type AnalyticsServicePreboot = Omit<AnalyticsClient, 'flush' | 'shutdown'>;
+/**
+ * Exposes the public APIs of the AnalyticsClient during the setup phase.
+ * {@link AnalyticsClient}
+ * @public
+ */
+export type AnalyticsServiceSetup = Omit<AnalyticsClient, 'flush' | 'shutdown'>;
+/**
+ * Exposes the public APIs of the AnalyticsClient during the start phase
+ * {@link AnalyticsClient}
+ * @public
+ */
+export type AnalyticsServiceStart = Pick<AnalyticsClient, 'optIn' | 'reportEvent' | 'telemetryCounter$'>;

src/core/packages/application/browser/index.d.ts

@@ -0,0 +1,7 @@
+export { AppLeaveActionType } from './src/app_leave';
+export type { AppLeaveAction, AppLeaveActionFactory, AppLeaveConfirmAction, AppLeaveDefaultAction, AppLeaveHandler, } from './src/app_leave';
+export type { AppMount, AppMountParameters, AppUnmount } from './src/app_mount';
+export type { App, AppDeepLink, AppDeepLinkLocations, PublicAppInfo, AppNavOptions, PublicAppDeepLinkInfo, AppUpdater, AppUpdatableFields, } from './src/application';
+export { AppStatus } from './src/application';
+export type { ApplicationSetup, ApplicationStart, NavigateToAppOptions, NavigateToUrlOptions, } from './src/contracts';
+export type { ScopedHistory } from './src/scoped_history';

src/core/packages/application/browser/src/app_leave.d.ts

@@ -0,0 +1,82 @@
+import type { EuiButtonColor } from '@elastic/eui';
+/**
+ * A handler that will be executed before leaving the application, either when
+ * going to another application or when closing the browser tab or manually changing
+ * the url.
+ * Should return `confirm` to prompt a message to the user before leaving the page, or `default`
+ * to keep the default behavior (doing nothing).
+ *
+ * See {@link AppMountParameters} for detailed usage examples.
+ *
+ * @remarks prefer {@link ScopedHistory.block} instead
+ *
+ * @public
+ */
+export type AppLeaveHandler = (factory: AppLeaveActionFactory, nextAppId?: string) => AppLeaveAction;
+/**
+ * Possible type of actions on application leave.
+ *
+ * @public
+ */
+export declare enum AppLeaveActionType {
+    confirm = "confirm",
+    default = "default"
+}
+/**
+ * Action to return from a {@link AppLeaveHandler} to execute the default
+ * behaviour when leaving the application.
+ *
+ * See {@link AppLeaveActionFactory}
+ *
+ * @public
+ */
+export interface AppLeaveDefaultAction {
+    type: AppLeaveActionType.default;
+}
+/**
+ * Action to return from a {@link AppLeaveHandler} to show a confirmation
+ * message when trying to leave an application.
+ *
+ * See {@link AppLeaveActionFactory}
+ *
+ * @public
+ */
+export interface AppLeaveConfirmAction {
+    type: AppLeaveActionType.confirm;
+    text: string;
+    title?: string;
+    confirmButtonText?: string;
+    buttonColor?: EuiButtonColor;
+    callback?: () => void;
+}
+/**
+ * Possible actions to return from a {@link AppLeaveHandler}
+ *
+ * See {@link AppLeaveConfirmAction} and {@link AppLeaveDefaultAction}
+ *
+ * @public
+ * */
+export type AppLeaveAction = AppLeaveDefaultAction | AppLeaveConfirmAction;
+/**
+ * Factory provided when invoking a {@link AppLeaveHandler} to retrieve the {@link AppLeaveAction} to execute.
+ */
+export interface AppLeaveActionFactory {
+    /**
+     * Returns a confirm action, resulting on prompting a message to the user before leaving the
+     * application, allowing him to choose if he wants to stay on the app or confirm that he
+     * wants to leave.
+     *
+     * @param text The text to display in the confirmation message
+     * @param title (optional) title to display in the confirmation message
+     * @param callback (optional) to know that the user want to stay on the page
+     * @param confirmButtonText (optional) text for the confirmation button
+     * @param buttonColor (optional) color for the confirmation button
+     * so we can show to the user the right UX for him to saved his/her/their changes
+     */
+    confirm(text: string, title?: string, callback?: () => void, confirmButtonText?: string, buttonColor?: EuiButtonColor): AppLeaveConfirmAction;
+    /**
+     * Returns a default action, resulting on executing the default behavior when
+     * the user tries to leave an application
+     */
+    default(): AppLeaveDefaultAction;
+}

src/core/packages/application/browser/src/app_mount.d.ts

@@ -0,0 +1,185 @@
+import type { Observable } from 'rxjs';
+import type { CoreTheme } from '@kbn/core-theme-browser';
+import type { MountPoint } from '@kbn/core-mount-utils-browser';
+import type { AppLeaveHandler } from './app_leave';
+import type { ScopedHistory } from './scoped_history';
+/**
+ * A mount function called when the user navigates to this app's route.
+ *
+ * @param params {@link AppMountParameters}
+ * @returns An unmounting function that will be called to unmount the application. See {@link AppUnmount}.
+ *
+ * @public
+ */
+export type AppMount<HistoryLocationState = unknown> = (params: AppMountParameters<HistoryLocationState>) => AppUnmount | Promise<AppUnmount>;
+/**
+ * A function called when an application should be unmounted from the page. This function should be synchronous.
+ * @public
+ */
+export type AppUnmount = () => void;
+/** @public */
+export interface AppMountParameters<HistoryLocationState = unknown> {
+    /**
+     * The container element to render the application into.
+     */
+    element: HTMLElement;
+    /**
+     * A scoped history instance for your application. Should be used to wire up
+     * your applications Router.
+     *
+     * @example
+     * How to configure react-router with a base path:
+     *
+     * ```ts
+     * // inside your plugin's setup function
+     * export class MyPlugin implements Plugin {
+     *   setup({ application }) {
+     *     application.register({
+     *      id: 'my-app',
+     *      appRoute: '/my-app',
+     *      async mount(params) {
+     *        const { renderApp } = await import('./application');
+     *        return renderApp(params);
+     *      },
+     *    });
+     *  }
+     * }
+     * ```
+     *
+     * ```ts
+     * // application.tsx
+     * import React from 'react';
+     * import ReactDOM from 'react-dom';
+     * import { Router, Route } from 'react-router-dom';
+     *
+     * import { CoreStart, AppMountParameters } from 'src/core/public';
+     * import { MyPluginDepsStart } from './plugin';
+     *
+     * export renderApp = ({ element, history }: AppMountParameters) => {
+     *   ReactDOM.render(
+     *     <Router history={history}>
+     *       <Route path="/" exact component={HomePage} />
+     *     </Router>,
+     *     element
+     *   );
+     *
+     *   return () => ReactDOM.unmountComponentAtNode(element);
+     * }
+     * ```
+     */
+    history: ScopedHistory<HistoryLocationState>;
+    /**
+     * The route path for configuring navigation to the application.
+     * This string should not include the base path from HTTP.
+     *
+     * @deprecated Use {@link AppMountParameters.history} instead.
+     * remove after https://github.com/elastic/kibana/issues/132600 is done
+     *
+     * @example
+     *
+     * How to configure react-router with a base path:
+     *
+     * ```ts
+     * // inside your plugin's setup function
+     * export class MyPlugin implements Plugin {
+     *   setup({ application }) {
+     *     application.register({
+     *      id: 'my-app',
+     *      appRoute: '/my-app',
+     *      async mount(params) {
+     *        const { renderApp } = await import('./application');
+     *        return renderApp(params);
+     *      },
+     *    });
+     *  }
+     * }
+     * ```
+     *
+     * ```ts
+     * // application.tsx
+     * import React from 'react';
+     * import ReactDOM from 'react-dom';
+     * import { BrowserRouter, Route } from 'react-router-dom';
+     *
+     * import { CoreStart, AppMountParameters } from 'src/core/public';
+     * import { MyPluginDepsStart } from './plugin';
+     *
+     * export renderApp = ({ appBasePath, element }: AppMountParameters) => {
+     *   ReactDOM.render(
+     *     // pass `appBasePath` to `basename`
+     *     <BrowserRouter basename={appBasePath}>
+     *       <Route path="/" exact component={HomePage} />
+     *     </BrowserRouter>,
+     *     element
+     *   );
+     *
+     *   return () => ReactDOM.unmountComponentAtNode(element);
+     * }
+     * ```
+     */
+    appBasePath: string;
+    /**
+     * A function that can be used to register a handler that will be called
+     * when the user is leaving the current application, allowing to
+     * prompt a confirmation message before actually changing the page.
+     *
+     * This will be called either when the user goes to another application, or when
+     * trying to close the tab or manually changing the url.
+     *
+     *
+     * @example
+     *
+     * ```ts
+     * // application.tsx
+     * import React from 'react';
+     * import ReactDOM from 'react-dom';
+     * import { BrowserRouter, Route } from 'react-router-dom';
+     *
+     * import { CoreStart, AppMountParameters } from 'src/core/public';
+     * import { MyPluginDepsStart } from './plugin';
+     *
+     * export renderApp = ({ element, history, onAppLeave }: AppMountParameters) => {
+     *    const { renderApp, hasUnsavedChanges } = await import('./application');
+     *    onAppLeave(actions => {
+     *      if(hasUnsavedChanges()) {
+     *        return actions.confirm('Some changes were not saved. Are you sure you want to leave?');
+     *      }
+     *      return actions.default();
+     *    });
+     *    return renderApp({ element, history });
+     * }
+     * ```
+     *
+     * @remarks prefer {@link ScopedHistory.block} instead
+     * Resources with names containing percent sign with other special characters or
+     * containing `%25` sequence can experience navigation issues. Refs https://github.com/elastic/kibana/issues/82440 and https://github.com/elastic/kibana/issues/132600
+  
+     */
+    onAppLeave: (handler: AppLeaveHandler) => void;
+    /**
+     * @deprecated Pass `menu` to `AppHeader` from `@kbn/app-header`.
+     */
+    setHeaderActionMenu: (menuMount: MountPoint | undefined) => void;
+    /**
+     * An observable emitting {@link CoreTheme | Core's theme}.
+     * Should be used when mounting the application to include theme information.
+     *
+     * @example
+     * When mounting a react application:
+     * ```ts
+     * // application.tsx
+     * import React from 'react';
+     * import ReactDOM from 'react-dom';
+     *
+     * import { AppMountParameters } from 'src/core/public';
+     * import { wrapWithTheme } from 'src/platform/plugins/shared/kibana_react';
+     * import { MyApp } from './app';
+     *
+     * export renderApp = ({ element, theme$ }: AppMountParameters) => {
+     *    ReactDOM.render(wrapWithTheme(<MyApp/>, theme$), element);
+     *    return () => ReactDOM.unmountComponentAtNode(element);
+     * }
+     * ```
+     */
+    theme$: Observable<CoreTheme>;
+}