@deviceinsight/ng-ui-scale-lib 9.18.3 → 9.18.4

package/dist/api.d.ts

@@ -0,0 +1,1175 @@
+import * as api from '@deviceinsight/ng-ui-api-client';
+import { Datapoint, User, UserGroup, Role, Asset, Gateway, AssetGroup, Event, AssetDefinition, AssetGroupDefinition, Bundle, BundleVersion, AuthInfo, PaginationSettings, Pageable, Sort } from '@deviceinsight/ng-ui-api-client';
+import { HttpBackendOptions } from 'i18next-http-backend';
+import { TOptions, i18n } from 'i18next';
+import * as React from 'react';
+import React__default, { ComponentType, ReactNode, ButtonHTMLAttributes, PropsWithChildren } from 'react';
+import { Layout } from 'react-grid-layout';
+import { ReactableColumnDef, Period } from '@deviceinsight/ng-ui-components';
+import { AxiosInstance } from 'axios';
+import { Trans as Trans$1, useTranslation as useTranslation$1 } from 'react-i18next';
+import { GrantRequestFunctionType } from 'ux4iot-react';
+
+/**
+ * Sets the application title.
+ * @param {string} title The application title.
+ */
+declare const setTitle: (title: string) => Promise<void>;
+
+/**
+ * Allows to load the custom locize.io project.
+ * @param {object} locizeProject The configuration for the locize.io project.
+ * @param {string} locizeProject.projectId The project id.
+ * @param {string} locizeProject.apiKey The api key.
+ * @param {string} locizeProject.version The version.
+ * @example
+ * ```ts
+ * import { setLocizeProject } from '@deviceinsight/scale-ui-types';
+ *
+ * setLocizeProject({
+ *   projectId: 'my-project-id',
+ *   apiKey: 'my-api-key',
+ *   version: 'latest'
+ * });
+ * ```
+ */
+declare const setLocizeProject: (locizeProject: {
+    projectId: string;
+    apiKey: string;
+    version: string;
+}) => Promise<void>;
+
+/**
+ * Adds a i18next XHR backend to the i18next instance.
+ * It's helpful if you store the translations in a json file.
+ * @param {Record<string, any>} httpBackendOptions The configuration for the i18next XHR backend.
+ * @example
+ * ```ts
+ * import { addI18nextXHRBackend } from '@deviceinsight/scale-ui-types';
+ *
+ * addI18nextXHRBackend({
+ *   loadPath: '/lib/public/i18n/{{lng}}/{{ns}}.json'
+ * });
+ * ```
+ */
+declare const addI18nextXHRBackend: (httpBackendOptions: HttpBackendOptions) => Promise<void>;
+
+type DatapointValue = [number, boolean | string | number | {
+    latitude: number;
+    longitude: number;
+}];
+
+type DatapointWithLastValue = Datapoint & {
+    lastValue: DatapointValue | null | undefined;
+    lastValueTimestamp: number | null | undefined;
+};
+
+type UserWithGroupsAndRoles = User & {
+    userGroups: Array<UserGroup>;
+    roles: Array<Role>;
+};
+
+type Context = Asset | Gateway | AssetGroup | User | UserWithGroupsAndRoles | UserGroup | Datapoint | DatapointWithLastValue | Event | void;
+type TranslationRule = {
+    pattern: string;
+    modification: (key: string, context: Context) => string;
+};
+/**
+ * Translation API class
+ */
+declare class TranslationApi {
+    context: Context;
+    rules: TranslationRule[];
+    setRules: (rules: TranslationRule[]) => void;
+    getRules: () => TranslationRule[];
+    setContext: (context: Context) => void;
+    getContext: () => Context;
+    modifyTranslationKey: (key: string, context?: Context | undefined) => string;
+}
+declare const _default$5: TranslationApi;
+
+type TranslationDescriptor = {
+    id: string;
+    defaultValue: string;
+};
+/**
+ * Translation function type.
+ * @param {string} key The key of the text to translate.
+ * @param {Record<string, any>} [data] The data to pass to the translation function.
+ * @returns {string} The translated text.
+ */
+type TFunction = (key: string, options?: TOptions, context?: Context) => string;
+
+interface Props$2 extends Omit<React__default.ComponentProps<typeof Trans$1>, 'context'> {
+    context?: Context;
+}
+declare const StaticTrans: (props: Props$2) => JSX.Element;
+/**
+ * Component to translate a text.
+ * This component mimics the functionality of the `Trans` component of `react-i18next`.
+ * @param {string} props.i18nKey The key of the text to translate.
+ * @param {ReactNode} props.children The default value of the text to translate.
+ * @example
+ * ```tsx
+ * import { Trans } from '@deviceinsight/scale-ui-types';
+ *
+ * <Trans i18nKey="my.key">My Default Translation</Trans>
+ * ```
+ */
+declare function Trans(props: React__default.ComponentProps<typeof StaticTrans>): JSX.Element;
+
+type Result = {
+    t: TFunction;
+    i18n: i18n;
+    ready: boolean;
+};
+/**
+ * Hook to use the translation function in a functional component.
+ * @param {Namespace} ns The namespace of the translation function.
+ * @param {Record<string, any>} props The props to pass to the translation function.
+ * @returns {WithTranslation} The translation function.
+ * @example
+ * import { useTranslation } from '@deviceinsight/scale-ui-types';
+ *
+ * const { t } = useTranslation('namespace');
+ * const text = t('my.title', {defaultValue: 'My Title'});
+ */
+declare function useTranslation(...args: Parameters<typeof useTranslation$1>): Result;
+
+type ContextInfoPathName = {
+    pathname: string;
+};
+type ContextInfoString = ContextInfoPathName & {
+    type: 'string';
+    value: string;
+};
+type ContextInfoSearch = ContextInfoPathName & {
+    type: 'search';
+    elements: number;
+    totalElements: number | null | undefined;
+    totalElementsAccurate?: boolean;
+    context: string;
+    customTranslations?: {
+        all: TranslationDescriptor;
+        some: TranslationDescriptor;
+    };
+    tooltip?: string;
+};
+type ContextInfoAsset = ContextInfoPathName & {
+    type: 'asset';
+    asset: Asset;
+    assetGroups: Array<AssetGroup>;
+    assetDefinition: AssetDefinition | undefined;
+    gateway: Gateway | null | undefined;
+};
+type ContextInfoAssetGroup = ContextInfoPathName & {
+    type: 'assetGroup';
+    assetGroup: AssetGroup;
+    assetGroupDefinition: AssetGroupDefinition;
+};
+type ContextInfo = ContextInfoString | ContextInfoSearch | ContextInfoAsset | ContextInfoAssetGroup;
+
+type AppConfiguration<ConfigurationType> = {
+    enabled: boolean;
+    configuration: ConfigurationType;
+};
+type AppConfigurationBundle = Record<string, AppConfiguration<any>>;
+type validateAppConfigurationFunctionType = (appConfigurationUntyped: AppConfiguration<any>) => AppConfiguration<any>;
+type ThemeConfig = {
+    logo?: string;
+    favicon?: string;
+    primaryColor?: string;
+};
+type EventPriority = {
+    priority: number;
+    label: string;
+    icon: string;
+    color: string;
+};
+
+type Authorities = string[] | string[][];
+/**
+ * Checks if the current user has the given authorities.
+ * @param {Authorities} authorities The authorities to check. Can be a list of authorities or a list of lists of authorities. In first case the user needs to have all authorities, in the second case the user needs to have all the authorities in at leat one list.
+ * @returns {boolean} True if the current user has the given authorities, false otherwise.
+ * @example
+ * import { hasAuthorities } from '@deviceinsight/scale-ui-types';
+ *
+ * const hasAdminOrUserAuthorities = hasAuthorities(['ROLE_ADMIN', 'ROLE_USER']);
+ */
+declare const hasAuthorities: (authorities?: Authorities) => boolean;
+
+type ContextInfoProps = {
+    pathname: string;
+    contextInfo?: ContextInfo;
+};
+type ContextActionType = {
+    pathname: string;
+    HasAuthorities: React.ComponentType<{
+        authorities: Authorities;
+        children: React.ReactNode;
+    }>;
+};
+type App = 'dashboard' | 'trend' | 'events' | 'files' | 'usergroupthemes' | 'auditLog' | 'bundleManagement';
+type VisibilityProps = {
+    onlyOnAsset?: string;
+    onlyOnAssetGroup?: string;
+    onlyIfInAssetGroup?: string;
+    onlyIfAsset?: boolean;
+    onlyIfGateway?: boolean;
+    onlyWithAssetGroupProperties?: Array<string>;
+    onlyWithAssetGroupDefinition?: string;
+    onlyWithAssetDefinition?: string;
+    sidebarIndex?: number;
+    onlyIfRouteChildrenAllowed?: boolean;
+};
+type RouteConfig = {
+    relativePath: string;
+    label?: TranslationDescriptor;
+    component?: React.ComponentType<any>;
+    className?: string;
+    childRoutes?: RouteConfig[];
+    childRoutesContainer?: React.ComponentType<any>;
+    iconSvg?: React.ComponentType<any>;
+    iconLight?: string;
+    iconDark?: string;
+    show?: (contextInfo: ContextInfo | null | undefined, user: User) => boolean;
+    requiredAuthorities?: string[] | Array<string[]>;
+    appName?: App;
+    scope?: string;
+    validateAppConfiguration?: validateAppConfigurationFunctionType;
+    config?: VisibilityProps;
+    getTitleSegments?: (contextInfo: ContextInfo) => Array<string | TranslationDescriptor>;
+    contextAction?: React.ComponentType<ContextActionType>;
+    contextInfo?: React.ComponentType<ContextInfoProps>;
+    excludeFromNavigation?: boolean;
+};
+type RouteLink = {
+    path: string;
+    label: TranslationDescriptor | null | undefined;
+    active: boolean;
+    iconSvg?: React.ComponentType<any>;
+    iconLight?: string;
+    iconDark?: string;
+    requiredAuthorities?: string[] | string[][];
+};
+type NavGroup = {
+    label: TranslationDescriptor;
+    icon?: string;
+    iconSvg?: React.ComponentType<any>;
+    paths: Array<string>;
+    appName?: App;
+    scope?: string;
+    separator?: boolean;
+};
+
+type UpdateAuthoritiesConfig = {
+    onlyChildren: boolean;
+} | {
+    includeChildren: boolean;
+};
+type Link = {
+    appName?: string;
+    scope: string[];
+    value: string;
+    label: TranslationDescriptor;
+};
+/**
+ * Route API class.
+ * Allows to manage the client-side routes.
+ *
+ * ## Adding a route
+ * The class allows to add a custom route on different levels:
+ * - global level ([`addGlobalApp`](#addglobalapp))
+ * - asset level ([`addAssetTopLevelApp`](#addassettoplevelapp))
+ * - asset details level ([`addAssetApp`](#addassetapp))
+ * - asset group level ([`addAssetGroupTopLevelApp`](#addassetgrouptoplevelapp))
+ * - asset group details level ([`addAssetGroupApp`](#addassetgroupapp))
+ * - user level ([`addUserTopLevelApp`](#addusertoplevelapp))
+ * - user details level ([`addUserApp`](#adduserapp))
+ * - user group level ([`addUserGroupTopLevelApp`](#addusergrouptoplevelapp)
+ * - user group details level ([`addUserGroupApp`](#addusergroupapp))
+ *
+ * The above functions accept a [RouteConfig](../modules.html#routeconfig) object as parameter. The parameter defines the path of the route, the component to render, the appeareance in the navigation menu and the access rules.
+ *
+ * @example
+ * ```ts
+ * // adding a route on the asset details level, visible only for users
+ * // having the ROLE_ADMIN authority and only if the asset is in the asset group
+ * // with id 'my-asset-group'.
+ * RouteApi.addAssetApp({
+ *  relativePath: 'my-route',
+ *  label: {
+ *    id: 'my-route.label',
+ *    defaultValue: 'My Route'
+ *  },
+ *  component: MyRouteComponent,
+ *  requiredAuthorities: ['ROLE_ADMIN'],
+ *  config: {
+ *    onlyIfInAssetGroup: 'my-asset-group'
+ *  });
+ * ```
+ * ## Removing a route
+ * The class allows to remove a custom route on different levels:
+ * - global level ([`removeGlobalApp`](#removeglobalapp))
+ * - asset level ([`removeAssetTopLevelApp`](#removeassettoplevelapp))
+ * - asset details level ([`removeAssetApp`](#removeassetapp))
+ * - asset group level ([`removeAssetGroupTopLevelApp`](#removeassetgrouptoplevelapp))
+ * - asset group details level ([`removeAssetGroupApp`](#removeassetgroupapp)
+ * - user level ([`removeUserTopLevelApp`](#removeusertoplevelapp))
+ * - user details level ([`removeUserApp`](#removeuserapp))
+ * - user group level ([`removeUserGroupTopLevelApp`](#removeusergrouptoplevelapp)
+ * - user group details level ([`removeUserGroupApp`](#removeusergroupapp)
+ *
+ * The above functions accept a `string` as parameter. The parameter defines the name (`relativePath` field) of the route to remove.
+ *
+ * ## Adding a navigation group
+ * The class allows to add a custom navigation group with a function [`addNavGroup`](#addnavgroup). This allows to group the custom routes in the navigation menu.
+ * The function [`addNavGroup`](#addNavGroup) accepts a [`NavGroup`](../modules.html#navgroup) object as parameter.
+ * The parameter defines the label of the navigation group, the icon to show in the navigation menu and the routes to include in the navigation group.
+ * The routes are identified by the `relativePath` field of the [`RouteConfig`](../modules.html#routeconfig) object.
+ * @example
+ * ```ts
+ * // adding a navigation group with the label 'My Group' and the icon 'my-icon'
+ * // containing the routes 'my-route-1' and 'my-route-2'
+ * RouteApi.addNavGroup({
+ *   label: {
+ *     id: 'my-group.label',
+ *     defaultValue: 'My Group'
+ *   },
+ *   icon: 'my-icon',
+ *   paths: ['my-route-1', 'my-route-2']
+ * });
+ * ```
+ */
+declare class RouteApi {
+    routes: Array<RouteConfig>;
+    navGroups: Array<NavGroup>;
+    /** @hidden */
+    constructor(routes: Array<RouteConfig>);
+    /** returns routes having name equal to the passed parameter */
+    findRoutes: (routeName: string, routes?: Array<RouteConfig>) => Array<RouteConfig>;
+    /** @deprecated please use findRoutes instead.*/
+    findRoute: (routeName: string, routes?: Array<RouteConfig>) => RouteConfig | null | undefined;
+    /** returns all routes */
+    getRoutes: () => RouteConfig[];
+    /** returns all navigation groups */
+    getNavGroups: () => NavGroup[];
+    /** @internal returns the given routes filtered by the enabled apps */
+    filterRoutes: (routes: Array<RouteConfig> | undefined, user: User, contextInfo: ContextInfo | null | undefined) => Array<RouteConfig>;
+    /** returns the given links filtered by the enabled apps */
+    filterLinksByEnabledApps: (links: Array<Link>) => Array<Link>;
+    /** returns the given routes filtered by the enabled apps */
+    filterRoutesByEnabledApps: (routes?: Array<RouteConfig>) => RouteConfig[];
+    /** returns the given navigation groups filtered by the enabled apps */
+    filterNavGroupsByEnabledApps: (navGroups?: Array<NavGroup>) => Array<NavGroup>;
+    private findAppRoute;
+    private addApp;
+    private removeApp;
+    /** adds a route on the asset details level */
+    addAssetApp: (assetApp: RouteConfig) => void;
+    /** adds a route on the asset level */
+    addAssetTopLevelApp: (assetTopLevelApp: RouteConfig) => void;
+    /** adds a route on the asset group details level */
+    addAssetGroupApp: (assetGroupApp: RouteConfig) => void;
+    /** adds a route on the asset group level */
+    addAssetGroupTopLevelApp: (assetGroupTopLevelApp: RouteConfig) => void;
+    /** adds a route on the user details level */
+    addUserApp: (userApp: RouteConfig) => void;
+    /** adds a route on the user level */
+    addUserTopLevelApp: (userTopLevelApp: RouteConfig) => void;
+    /** adds a route on the user group details level */
+    addUserGroupApp: (userGroupApp: RouteConfig) => void;
+    /** adds a route on the user group level */
+    addUserGroupTopLevelApp: (userGroupTopLevelApp: RouteConfig) => void;
+    /** adds a navigation group */
+    addNavGroup: (navGroup: NavGroup) => number;
+    /** removes a route on the asset details level */
+    removeAssetApp: (assetAppName: string) => void;
+    /** removes a route on the asset group details level */
+    removeAssetGroupApp: (assetGroupAppName: string) => void;
+    /** removes a route on the asset level */
+    removeAssetTopLevelApp: (assetTopLevelAppName: string) => void;
+    /** removes a route on the asset group level */
+    removeAssetGroupTopLevelApp: (assetGroupTopLevelAppName: string) => void;
+    /** removes a route on the user details level */
+    removeUserApp: (userAppName: string) => void;
+    /** removes a route on the user group details level */
+    removeUserGroupApp: (userGroupAppName: string) => void;
+    /** removes a route on the user level */
+    removeUserTopLevelApp: (userTopLevelAppName: string) => void;
+    /** removes a route on the user group level */
+    removeUserGroupTopLevelApp: (userGroupTopLevelAppName: string) => void;
+    /** adds a route on the global level */
+    addGlobalApp: (globalApp: RouteConfig) => void;
+    /** removes a route on the global level */
+    removeGlobalApp: (globalAppName: string) => void;
+    updateSingleRouteAuthorities: (route: RouteConfig, authorities: Array<string>) => void;
+    /**
+     * Makes all routes having name equal to the passed parameter enabled only for users having the specified authorities.
+     *
+     * @param {string} routeName
+     * @param {string[]} authorities
+     * @param {object} [config] extra configuration
+     * @param {boolean} [config.onlyChildren] only direct children of the found routes will be enabled or disabled
+     * @param {boolean} [config.includeChildren] fond routes and their direct children will be enabled or disabled
+     */
+    updateAuthorities: (routeName: string, authorities: Array<string>, config?: UpdateAuthoritiesConfig) => void;
+}
+declare const _default$4: RouteApi;
+
+type DefaultStyleCustomization = {
+    colorPalette: Array<string>;
+    trueColors: Array<string>;
+    falseColors: Array<string>;
+};
+type StyleCustomization = {
+    colorPalette?: Array<string>;
+    trueColors?: Array<string>;
+    falseColors?: Array<string>;
+};
+/**
+ * Style API class.
+ *
+ * Allows to manage the CSS variables and the custom style customizations, as well as the color palette.
+ *
+ * ## Customizing the style configuration
+ * The class allows to customize the style configuration with the method `setStyleCustomizations`.
+ * The method accepts a `StyleCustomization` object as parameter.
+ * The object can contain the following properties:
+ * - `colorPalette`: an array of colors to be used as color palette. The colors can be any valid CSS color.
+ * - `trueColors`: an array of colors to be used as true colors. The colors can be any valid CSS color. Used by the DigitalIO widget.
+ * - `falseColors`: an array of colors to be used as false colors. The colors can be any valid CSS color. Used by the DigitalIO widget.
+ *
+ *  @example
+ *  ```ts
+ *  await StyleApi.setStyleCustomizations({
+ *    colorPalette: ['#000000', '#ffffff']
+ *  });
+ *  ```
+ *
+ *
+ * ## CSS variables
+ * The class allows to define custom CSS variables and custom style customizations.
+ *
+ * @example
+ * await StyleApi.setCssVariables({
+ * '--primary-color-darker-10-percent': '#dedede'
+ * });
+ *
+ *
+ */
+declare class StyleApi {
+    defaultStyleSettings: DefaultStyleCustomization;
+    customStyleSettings: StyleCustomization;
+    /** @hidden */
+    constructor();
+    /** allows to set the global css variables */
+    setCssVariables: (variablesToSet: Record<string, string>) => Promise<void>;
+    /** allows to set the color palette */
+    setStyleCustomizations: (styleCustomizations: StyleCustomization) => Promise<void>;
+    /** returns the color palette */
+    getColorPalette: (defaults?: boolean) => Array<string>;
+    /** @internal returns the true colors. Used internally by the DigitalIO widget */
+    getTrueColors: () => Array<string>;
+    /** @internal returns the default true color. Used internally by the DigitalIO widget */
+    getDefaultTrueColor: () => string;
+    /** @internal returns the default false color. Used internally by the DigitalIO widget */
+    getDefaultFalseColor: () => string;
+    /** @internal returns the false colors. Used internally by the DigitalIO widget */
+    getFalseColors: () => Array<string>;
+    /**
+     * Helper function allowing to get the next color from the color palette.
+     * @param {Array<string>} [excludeColors] An array of colors to exclude from the color palette.
+     * @param {Array<string>} [colorList] An array of colors to use as color palette. If not specified, the color palette is used.
+     * @returns {string} The next color from the color palette.
+     */
+    getNextColor: (excludeColors?: Array<string>, colorList?: Array<string>) => string;
+}
+/**
+ * Style API Singleton instance.
+ */
+declare const _default$3: StyleApi;
+
+/**
+ * Theme API class.
+ * @example
+ * import { ThemeApi } from '@deviceinsight/scale-ui-types';
+ *
+ * ThemeApi.setCustomTheme({
+ *  logo: 'https://www.example.com/logo.png',
+ *  favicon: 'https://www.example.com/favicon.ico',
+ *  primaryColor: '#000000'
+ *  });
+ */
+declare class ThemeApi {
+    /**
+     * @internal
+     * Stores the default theme.
+     */
+    private defaultTheme;
+    private userTheme;
+    private customTheme;
+    /**
+     * @internal
+     * Internal initialization function. Shouldn't be used directly.
+     */
+    initializeThemeConfiguration: () => void;
+    /**
+     * @internal
+     * sets the current theme. Shouldn't be used directly.
+     */
+    setTheme: (config?: ThemeConfig) => void;
+    /**
+     * returns a default theme
+     */
+    getDefaultTheme: () => ThemeConfig;
+    /**
+     * sets the default theme
+     */
+    setDefaultTheme: (config: ThemeConfig) => void;
+    /**
+     * returns the user theme, which is taken from the user group configuration.
+     */
+    getUserTheme: () => ThemeConfig;
+    /**
+     * @internal
+     * Internal function to set the user theme. Shouldn't be used directly.
+     */
+    setUserTheme: (config: ThemeConfig) => void;
+    /**
+     * sets the custom theme
+     */
+    setCustomTheme: (config: ThemeConfig) => void;
+    /**
+     * @internal
+     * Internal function to set the user theme. Shouldn't be used directly.
+     */
+    loadThemeForUser: (user: User) => Promise<void>;
+}
+/**
+ * Singleton instance of the ThemeApiClass.
+ * Allows to change the theme programmatically.
+ */
+declare const _default$2: ThemeApi;
+
+type PowerBiReportConfigBase = {
+    reportHeading: string;
+    workspaceId: string;
+    reportId: string;
+};
+type PowerBiReportConfig = PowerBiReportConfigBase & {
+    tabName: string;
+};
+
+type DashboardWidgetType = 'default' | 'map' | 'image' | 'dpvalue' | 'datapoints' | 'trend' | 'trendv2' | 'properties' | 'barchart' | 'digitalio' | 'link' | 'svg' | 'assignedAssets' | 'emptyInfoWidget' | 'kpiSingleValue' | 'kpiAggregatedChart' | 'aggregation' | 'kpiSingleValueColumn' | 'kpiPieChart' | 'kpiSinglePeriodChart' | 'assetsInfo' | 'testWidget';
+type DashboardWidgetConfig = {
+    key: string;
+    type: DashboardWidgetType;
+    span?: number;
+    title: string;
+    settings: any;
+};
+type DashboardConfig = {
+    key: string;
+    name: string | null | undefined;
+    description: string | null | undefined;
+    labels?: string[];
+    isAssetDefinitionDashboard?: boolean;
+    shared: boolean;
+    assetGroupId?: number;
+    creationDate: number;
+    orderId?: number;
+    widgets: Array<DashboardWidgetConfig>;
+    layout: Layout[];
+    columnsCount: number;
+    /** By default for new dashboards set to TRUE, but for old (based on rows) to FALSE */
+    autoAdjustLayout: boolean;
+};
+type AssetContext = {
+    type: 'asset';
+    asset: Asset;
+};
+type AssetGroupContext = {
+    type: 'assetGroup';
+    assetGroup: AssetGroup;
+};
+type GlobalDashboardContext = {
+    type: 'global';
+};
+type AssetDefinitionContext = {
+    type: 'assetDefinition';
+    assetDefinition: AssetDefinition;
+};
+type DashboardContext = AssetContext | AssetGroupContext | GlobalDashboardContext | AssetDefinitionContext;
+
+type RoleTemplate = {
+    id: number;
+    name: string;
+    description: string;
+    authorities: string[];
+};
+
+/**
+ * UI Configuration API class.
+ * Provides the Tenant UI configuration.
+ */
+declare class UIConfiguration {
+    appConfiguration: AppConfigurationBundle | null | undefined;
+    syncWithBackend(uiConfiguration: Record<string, any>): Promise<any>;
+    getAppName(): string;
+    getFavicon(): string;
+    /**
+     * returns a boolean indicating if the app is enabled
+     * @param {string} appName The name of the app
+     * @param {string} scope The scope
+     */
+    isAppEnabled(appName: string, scope?: string): boolean;
+    /** @internal */
+    getAppConfiguration(appName: string, validateAppConfiguration?: validateAppConfigurationFunctionType): AppConfiguration<any> | null | undefined;
+    getPrimaryColor(): string;
+    getLogo(): string;
+    getErrorMessageAutocloseTimeout(): number | null | undefined;
+    getCustomStyleConfiguration(): StyleCustomization;
+    getTenantConfigUrl(): string | null | undefined;
+    isTenantShowingAssetQRCodes(): boolean;
+    getTenant(): string;
+    getApiBaseUrl(): string;
+    getDefaultTimezone(): string;
+    getGoogleMapsAPIKey(): string;
+    getDefaultMapCenter(): string;
+    getDefaultMapZoom(): string;
+    getTenantStartPageUrl(): string | null | undefined;
+    getTransportChannelsAvailable(): string;
+    getSupportedTimezones(): string[];
+    getDatapointExplorerEnabled(): boolean;
+    getInitialUserState(): 'TERMS_ACCEPTANCE_PENDING' | 'ACTIVE';
+    isPubSubStompDebuggingEnabled(): boolean;
+    getMainLocizeProject(): {
+        apiKey: string;
+        projectId: string;
+        version: string;
+    };
+    getTenantLocizeProject(): null | {
+        apiKey: any;
+        projectId: any;
+        version: any;
+    };
+    getSvgWidgetFieldIdentifier(): string;
+    getGatewayPrefix(): string;
+    getAssetPrefix(): string;
+    getFallbackLocale(): string;
+    getConfigurationsStatusInterval(): number;
+    hasLegalPages(): boolean;
+    getAppFooter(): string | null | undefined;
+    getPublicAppFooter(): string | null | undefined;
+    getAppWhatsNewVersion(): string | null | undefined;
+    getDocumentationStandardBaseUrl(): string | null | undefined;
+    getDocumentationStandardNamespace(): string | null | undefined;
+    getDocumentationStandardVersion(): string | null | undefined;
+    getDocumentationCustomBaseUrl(): string | null | undefined;
+    getDocumentationCustomNamespace(): string | null | undefined;
+    getDocumentationCustomVersion(): string | null | undefined;
+    getAvailableApps(): Array<string> | null | undefined;
+    getTrendExactValuesMinutes(): number;
+    getAccountCreationPrinciple(): 'username' | 'email';
+    getEnabledWidgets(): string[] | null | undefined;
+    isDashboardTimeDriveEnabled(context: DashboardContext['type']): boolean;
+    isWidgetTimeDriveEnabled(widgetType: DashboardWidgetType, context: DashboardContext['type']): boolean;
+    getEventPriorities(): EventPriority[];
+    getEventPriority(priorityValue: number): EventPriority | null;
+    getDefaultEventPriority(): EventPriority;
+    getTrendSlicesDivisor(): number;
+    getTrendSlicesMinimum(): number;
+    getDisplayWelcomeScreen(): boolean;
+    getGitCommitShaShort(): string;
+    getPowerBiReports(): PowerBiReportConfig[] | null | undefined;
+    getUx4iotUrl(): string | null | undefined;
+    getAssetListDefaultSearch(): string | null | undefined;
+    getAssetListAssetTypes(): 'all' | 'only_gateways' | 'only_assets';
+    getAssetGroupAssetAssignmentAssetTypes(): 'all' | 'only_assets' | 'only_gateways';
+    isFavoritesEnabled(): boolean;
+    isHistoryEnabled(): boolean;
+    isDatapointValuesUseAdx(): boolean;
+    getDashboardLabels(): string[];
+    getDefaultDashboardLabel(): string | undefined;
+    isReleaseNotesHidden(): boolean;
+    getDefaultSearchMode(): 'context' | 'full';
+    getRoleTemplates(): RoleTemplate[];
+    getGlobalAssetTimezoneMode(): 'browser' | 'asset' | 'user';
+    getPrimaryColorAvoidingGray(): string;
+    getUx4IotGrantRequestEndpoint(): string;
+    isTestTenant(): boolean;
+}
+declare const _default$1: UIConfiguration;
+
+/**
+ * Allows to add a custom React element in the header
+ * @param {string} customHeaderElementId A unique id of the custom header element
+ * @param {ComponentType<any>} customHeaderElementComponent The React component to render
+ * @example
+ * ```ts
+ * import { addCustomHeaderElement } from '@deviceinsight/scale-ui-types';
+ * import { MyCustomHeaderElement } from './MyCustomHeaderElement';
+ *
+ * addCustomHeaderElement('my-custom-header-element', MyCustomHeaderElement);
+ * ```
+ */
+declare const addCustomHeaderElement: (customHeaderElementId: string, customHeaderElementComponent: ComponentType<any>) => void;
+/**
+ * Allows to remove a custom React element from the header added with `addCustomHeaderElement`
+ * @param {string} customHeaderElementId The id of the custom header element to remove
+ * @example
+ * ```ts
+ * import { removeCustomHeaderElement } from '@deviceinsight/scale-ui-types';
+ * removeCustomHeaderElement('my-custom-header-element');
+ * ```
+ */
+declare const removeCustomHeaderElement: (customHeaderElementId: string) => void;
+
+/**
+ * @deprecated Please use the RouteApi.
+ * Allows to define a custom list of routes.
+ * @param {function(routes: Array<RouteConfig>): Array<RouteConfig>} modifyRoutesFn The custom function for determining the list of routes.
+ * The function receives the default list of routes and returns the modified list of routes.
+ * @example Adding a new custom route
+ * ```ts
+ * import { modifyRoutes } from '@deviceinsight/scale-ui-types';
+ *
+ * modifyRoutes((routes) => {
+ *   return [...routes, {
+ *     relativePath: 'my-route',
+ *     label: {
+ *       id: 'my-route.label',
+ *       defaultValue: 'My Route'
+ *     },
+ *     component: MyRouteComponent,
+ *     requiredAuthorities: ['ROLE_ADMIN']
+ *   }];
+ * });
+ * ```
+ */
+declare const modifyRoutes: (modifyRoutesFn: (currentRoutes: Array<RouteConfig>) => Array<RouteConfig>) => Promise<void>;
+
+type AssetAndGroupsAndGateway = {
+    id: number;
+    asset: Asset;
+    assetGroups: Array<AssetGroup>;
+    gateway: Gateway | null | undefined;
+};
+
+type AssetColumnDefs = Array<ReactableColumnDef<AssetAndGroupsAndGateway>>;
+
+type AssetGroupInfo = {
+    id: number;
+    assetGroup: AssetGroup;
+    assetGroupDefinition: AssetGroupDefinition;
+    ancestors: Array<AssetGroup>;
+};
+
+type AssetGroupColumnDefs = Array<ReactableColumnDef<AssetGroupInfo>>;
+
+type UserColumnDefs = Array<ReactableColumnDef<UserWithGroupsAndRoles>>;
+
+type UserGroupInfo = UserGroup & {
+    roleName?: string;
+    licenseDisplayName?: string[];
+};
+
+type UserGroupColumnDefs = Array<ReactableColumnDef<UserGroupInfo>>;
+
+/**
+ * Asset Column Definition Customization
+ * */
+type GetCustomAssetColumnDefsFunction = (defaultColumnDefinitions: AssetColumnDefs, context: string, withLink?: boolean) => AssetColumnDefs;
+/**
+ * Allows to define a custom list of columns for the asset table.
+ * @param {function(defaultColumnDefinitions: Array<ReactableColumnDef<AssetAndGroupsAndGateway>>): Array<ReactableColumnDef<AssetAndGroupsAndGateway>>} modifier The custom function for determining the list of columns.
+ * The function receives the default list of columns and returns the modified list of columns.
+ * @example
+ * ```ts
+ * import { modifyAssetColumnDefinitions } from '@deviceinsight/scale-ui-types';
+ * import { AssetAndGroupsAndGateway } from '@deviceinsight/ng-ui-api-client';
+ * import { MyCustomAssetColumnDefs } from './MyCustomAssetColumnDefs';
+ *
+ * modifyAssetColumnDefinitions((defaultColumnDefinitions) => {
+ *   return [...defaultColumnDefinitions, ...MyCustomAssetColumnDefs];
+ * });
+ * ```
+ */
+declare const modifyAssetColumnDefinitions: (getTenantSpecificColumnDefs: GetCustomAssetColumnDefsFunction) => Promise<void>;
+/**
+ * Asset Group Column Definition Customization
+ * */
+type GetCustomAssetGroupColumnDefsFunction = (defaultColumnDefinitions: AssetGroupColumnDefs, context: string, withLink?: boolean) => AssetGroupColumnDefs;
+/**
+ * Allows to define a custom list of columns for the asset group table.
+ * @param {function(defaultColumnDefinitions: Array<ReactableColumnDef<AssetGroupInfo>>): Array<ReactableColumnDef<AssetGroupInfo>>} modifier The custom function for determining the list of columns.
+ * The function receives the default list of columns and returns the modified list of columns.
+ * @example
+ * ```ts
+ * import { modifyAssetGroupColumnDefinitions } from '@deviceinsight/scale-ui-types';
+ * import { AssetGroupInfo } from '@deviceinsight/ng-ui-api-client';
+ * import { MyCustomAssetGroupColumnDefs } from './MyCustomAssetGroupColumnDefs';
+ *
+ * modifyAssetGroupColumnDefinitions((defaultColumnDefinitions) => {
+ *   return [...defaultColumnDefinitions, ...MyCustomAssetGroupColumnDefs];
+ * });
+ *  ```
+ */
+declare const modifyAssetGroupColumnDefinitions: (getTenantSpecificColumnDefs: GetCustomAssetGroupColumnDefsFunction) => Promise<void>;
+/**
+ * User Column Definition Customization
+ * */
+type GetCustomUserColumnDefsFunction = (defaultColumnDefinitions: UserColumnDefs, withLink?: boolean) => UserColumnDefs;
+/**
+ * Allows to define a custom list of columns for the user table.
+ * @param {function(defaultColumnDefinitions: Array<ReactableColumnDef<UserWithGroupsAndRoles>>): Array<ReactableColumnDef<UserWithGroupsAndRoles>>} getTenantSpecificColumnDefs The custom function for determining the list of columns.
+ * The function receives the default list of columns and returns the modified list of columns.
+ * @example
+ * ```ts
+ * import { modifyUserColumnDefinitions } from '@deviceinsight/scale-ui-types';
+ * import { UserWithGroupsAndRoles } from '@deviceinsight/ng-ui-api-client';
+ * import { MyCustomUserColumnDefs } from './MyCustomUserColumnDefs';
+ *
+ * modifyUserColumnDefinitions((defaultColumnDefinitions) => {
+ *   return [...defaultColumnDefinitions, ...MyCustomUserColumnDefs];
+ * });
+ * ```
+ */
+declare const modifyUserColumnDefinitions: (getTenantSpecificColumnDefs: GetCustomUserColumnDefsFunction) => Promise<void>;
+/**
+ * User Group Column Definition Customization
+ * */
+type GetCustomColumnDefsFunction = (defaultColumnDefinitions: UserGroupColumnDefs, withLink?: boolean) => UserGroupColumnDefs;
+/**
+ * Allows to define a custom list of columns for the user group table.
+ * @param {function(defaultColumnDefinitions: Array<ReactableColumnDef<UserGroup>>): Array<ReactableColumnDef<UserGroup>>} getTenantSpecificColumnDefs The custom function for determining the list of columns.
+ * The function receives the default list of columns and returns the modified list of columns.
+ * @example
+ * ```ts
+ * import { modifyUserGroupColumnDefinitions } from '@deviceinsight/scale-ui-types';
+ * import { UserGroup } from '@deviceinsight/ng-ui-api-client';
+ * import { MyCustomUserGroupColumnDefs } from './MyCustomUserGroupColumnDefs';
+ *
+ * modifyUserGroupColumnDefinitions((defaultColumnDefinitions) => {
+ *   return [...defaultColumnDefinitions, ...MyCustomUserGroupColumnDefs];
+ * });
+ * ```
+ */
+declare const modifyUserGroupColumnDefinitions: (getTenantSpecificColumnDefs: GetCustomColumnDefsFunction) => Promise<void>;
+
+type GetCustomMapMarkerIconFunction = (asset: Asset) => string;
+/**
+ * Allows to define a custom function returning a map icon for a specific asset.
+ * @param {function(asset: Asset): string} modifier The custom function for determining the map icon.
+ * The function receives the asset and returns the map icon.
+ */
+declare const modifyMapMarkerIcon: (getTenantSpecificMapMarkerIcon: GetCustomMapMarkerIconFunction) => Promise<void>;
+
+type CanDeleteResult = {
+    canBeDeleted: boolean;
+    error?: string;
+};
+
+/**
+ * Allows to define a custom function for determining if a bundle can be deleted or not.
+ * @param {function(bundle: Bundle): Promise<CanDeleteResult>} modifier The custom function for determining if a bundle can be deleted or not.
+ */
+declare const modifyCanDeleteBundle: (customCanDeleteBundle: (arg0: Bundle) => Promise<CanDeleteResult>) => Promise<void>;
+
+/**
+ * Allows to define a custom function for determining if a bundle version can be deleted or not.
+ * @param {function(bundle: Bundle, version: BundleVersion): Promise<CanDeleteResult>} modifier The custom function for determining if a bundle version can be deleted or not.
+ */
+declare const modifyCanDeleteBundleVersion: (customCanDeleteBundleVersion: (bundle: Bundle, version: BundleVersion) => Promise<CanDeleteResult>) => Promise<void>;
+
+type IsPropertyVisible = (propertyKey: string, userRoles: Role[]) => boolean;
+/**
+ * Allows to define a rule for determining if a property is visible or not.
+ * @param {IsPropertyVisible} customFunction The custom function for determining if a property is visible or not.
+ * @example
+ * ```ts
+ * import { modifyPropertyVisibility } from '@deviceinsight/scale-ui-types';
+ *
+ * const isPropertyVisible: IsPropertyVisible = (propertyKey, userRoles) => {
+ *  return propertyKey !== 'my-property' || userRoles.some(role => role.name === 'ROLE_ADMIN');
+ * };
+ *
+ * modifyPropertyVisibility(isPropertyVisible);
+ * ```
+ */
+declare const modifyPropertyVisibility: (customFunction: IsPropertyVisible) => void;
+
+/**
+ * Allows setting runtime environment variables
+ * @param {Record<string, string>} env The environment variables to set.
+ */
+declare const setEnvironment: (env: Record<string, string>) => Promise<void>;
+
+/**
+ * Returns the user start page. If it is not defined, returns `/`.
+ * @returns Promise<string>
+ */
+declare const getStartPage: () => Promise<string>;
+
+/**
+ * Returns an axios instance storing the current user's token and preconfigured to handle token refresh when needed.
+ */
+declare const _default: () => AxiosInstance;
+
+/**
+ * Helper function to retrieve the auth info of the current user.
+ * @returns {Promise<AuthInfo>} The auth info of the current user.
+ */
+declare const retrieveAuthInfo: () => Promise<AuthInfo>;
+
+/**
+ * Sets the globally available information about the current context.
+ * Note it's an internal scale-ui function. Use it only if you know what you are doing.
+ * @param {ContextInfo} contextInfo The context information.
+ */
+declare function setContextInfo(contextInfo: ContextInfo): void;
+
+type Props$1 = {
+    authorities: Authorities;
+};
+/**
+ * Renders the wrapped component only if the current user has the given authorities.
+ * @param {Authorities} authorities The authorities to check. Can be a list of authorities or a list of lists of authorities. In first case the user needs to have all authorities, in the second case the user needs to have all the authorities in at leat one list.
+ * @returns {React.ReactNode} The wrapped component.
+ * @example
+ * import { HasAuthorities } from '@deviceinsight/scale-ui-types';
+ *
+ * <HasAuthorities authorities={['ROLE_ADMIN', 'ROLE_USER']}>
+ *  <div>Only visible for users with ROLE_ADMIN or ROLE_USER</div>
+ * </HasAuthorities>
+ *
+ * // ...
+ * <HasAuthorities authorities={[['ROLE_ADMIN'], ['ROLE_CUSTOMER', 'ROLE_MAINTENANCE']}>
+ *   <div>Only visible for users with ROLE_ADMIN or both roles: ROLE_USER and ROLE_MAINTENANCE</div>
+ * </HasAuthorities>
+ */
+declare const HasAuthorities: ({ authorities, children }: React__default.PropsWithChildren<Props$1>) => JSX.Element | null;
+
+type IsDashboardVisible = (dashboard: DashboardConfig, context: DashboardContext, user: User) => Promise<boolean>;
+/**
+ * Allows to define a custom function to determine if a dashboard is visible for the current user.
+ * @param {IsDashboardVisible} isDashboardVisible The custom function to determine if a dashboard is visible for the current user.
+ * @example
+ * import { modifyIsDashboardVisible } from '@deviceinsight/scale-ui-types';
+ *
+ * modifyIsDashboardVisible(async (dashboard, context, user) => {
+ *  if (dashboard.key === 'settings' && context.type === 'assetGroup' && !user.userGroups.some(userGroup => userGroup.name === 'admin')) {
+ *    return false;
+ *  }
+ *  return true;
+ * });
+ */
+declare function modifyIsDashboardVisible(isDashboardVisible: IsDashboardVisible): void;
+
+type CustomCategory = {
+    categoryName: string;
+    type: 'documents' | 'images';
+    locizeKey: string;
+    locizeDefaultValue: string;
+};
+/**
+ * Sets custom file categories for the files app.
+ * @param {CustomCategory[]} categories The custom file categories.
+ * @example
+ * import { setCustomFilesCategories } from '@deviceinsight/scale-ui-types';
+ * setCustomFilesCategories([
+ *  {
+ *  categoryName: 'Custom Category',
+ *  type: 'documents',
+ *  locizeKey: 'customCategory',
+ *  locizeDefaultValue: 'Custom Category'
+ *  }
+ *  ]);
+ */
+declare function setCustomFilesCategories(categories: CustomCategory[]): void;
+
+type WidgetProps = {
+    context: DashboardContext;
+    config: DashboardWidgetConfig;
+    assetGroupId: number | null | undefined;
+    editMode: boolean;
+    dashboardId: string;
+    dashboardPeriod?: Period | null | undefined;
+    dashboardTime?: number | null | undefined;
+    setTimeDriveSupported?: (supported: boolean) => void;
+};
+type WidgetConfigProps = {
+    context: DashboardContext;
+    config: DashboardWidgetConfig;
+    assetGroupId: number | null | undefined;
+    onChangeConfig: (config: DashboardWidgetConfig, withoutLivePreview?: boolean) => void;
+    setApplyButtonDisabled: (value: boolean) => void;
+    configChanged: boolean;
+};
+type WidgetDefinition = {
+    name: DashboardWidgetType;
+    widgetComponent: React__default.ComponentType<WidgetProps>;
+    configComponent?: React__default.ComponentType<WidgetConfigProps>;
+    contextComponent?: React__default.ComponentType<React__default.PropsWithChildren<unknown>>;
+    title: TranslationDescriptor;
+    subtitle?: TranslationDescriptor;
+    autoOpenConfig?: boolean;
+    defaultSettings?: Record<string, any>;
+    scope: Array<'asset' | 'gateway' | 'assetGroup' | 'global' | 'assetDefinition'>;
+    disabledByDefault?: boolean;
+    timeDriveSupport?: boolean | ((config: any) => boolean | null | undefined);
+};
+
+type GetCustomDashboardWidgets = (widgets: WidgetDefinition[]) => WidgetDefinition[];
+/**
+ * Allows to define a custom list of available widgets on the dashboards.
+ * @param {function(widgets: Array<WidgetDefinition<any, any>>): Array<WidgetDefinition<any, any>>} modifier The custom function for determining the list of available widgets.
+ * The function receives the default list of available widgets and returns the modified list of available widgets.
+ *
+ * @example Adding a custom widget
+ * ```ts
+ * import { modifyDashboardWidgets } from '@deviceinsight/scale-ui-types';
+ * import { MyCustomWidgetDefinition } from './MyCustomWidget';
+ *
+ * modifyDashboardWidgets((widgets) => {
+ *   return [...widgets, MyCustomWidgetDefinition];
+ * });
+ * ```
+ * @example Removing a widget
+ * ```ts
+ * import { modifyDashboardWidgets } from '@deviceinsight/scale-ui-types';
+ *
+ * modifyDashboardWidgets((widgets) => {
+ *   return widgets.filter(widget => widget.name !== 'MyCustomWidget');
+ * });
+ * ```
+ */
+declare const modifyDashboardWidgets: (modifyWidgetsFn: GetCustomDashboardWidgets) => void;
+
+type CustomizableComponentName = 'Logo' | 'Footer' | 'AssetConnectionState' | 'HeaderSearch';
+/**
+ * Allows to replace some of the scale-ui components with custom ones.
+ * @param {'Logo' | 'Footer' | 'AssetConnectionState' | 'HeaderSearch'} name The name of the component to replace.
+ * @param {ComponentType<any> | null} component The React component to render.
+ * @example
+ * ```ts
+ * import { replaceComponent } from '@deviceinsight/scale-ui-types';
+ * import { MyCustomLogo } from './MyCustomLogo';
+ *
+ * replaceComponent('Logo', MyCustomLogo);
+ * ```
+ */
+declare const replaceComponent: (name: CustomizableComponentName, component: ComponentType<any>) => Promise<void>;
+
+type GenerateAssetUrnFn = (isGateway: boolean) => string;
+/**
+ * Allows to define a custom function for generating the asset URN.
+ * @param {function(boolean): string} generator The custom function for generating the asset URN.
+ * It takes a boolean parameter indicating if the asset is a gateway or not and returns the generated URN.
+ * @param {boolean} editable Indicates if the URN is editable or not.
+ * @example
+ * ```ts
+ * import { generateAssetUrn } from '@deviceinsight/scale-ui-types';
+ *
+ * modifyGenerateAssetUrn((isGateway) => {
+ *  return isGateway ? 'urn:scale:gateway:' : 'urn:scale:asset:';
+ * }, true);
+ * ```
+ */
+declare const modifyGenerateAssetUrn: (generator: GenerateAssetUrnFn, editable: boolean) => void;
+
+type CustomLoginPageElementsContextType = {
+    aboveForm: ReactNode;
+    belowForm: ReactNode;
+    belowLoginButton: ReactNode;
+    nextToLoginButton: ReactNode;
+};
+type Position = keyof CustomLoginPageElementsContextType;
+
+/**
+ * Sets a custom login page element.
+ * @param {'aboveForm' | 'belowForm' | 'belowLoginButton' | 'nextToLoginButton'} position The position of the custom element.
+ * @param {ReactNode} element The custom element.
+ * @returns {Promise<void>}
+ * @example
+ * import { setCustomLoginPageElement } from '@deviceinsight/scale-ui-types';
+ * setCustomLoginPageElement('aboveForm', <div>Custom element</div>);
+ */
+declare function setCustomLoginPageElement(position: Position, element: ReactNode): Promise<void>;
+
+declare const ux4iotGrantRequestFunction: GrantRequestFunctionType;
+
+/**
+ * Returns the timezone selected by the user. Might be the browser timezone or the timezone set in the current asset object.
+ * @returns {string} The timezone selected by the user.
+ * @example
+ * import { useAssetTimezone } from '@deviceinsight/scale-ui-types';
+ * const timezone = useAssetTimezone();
+ */
+declare function useAssetTimezone(): string;
+
+/**
+ * Returns the current user account info.
+ * @returns {User} The current user account info.
+ * @example
+ * import { useUserAccountInfo } from '@deviceinsight/scale-ui-types';
+ * const user = useUserAccountInfo();
+ */
+declare function useUserAccountInfo(): User;
+
+type SearchProps<T> = {
+    query: string;
+    paginationSettings: PaginationSettings;
+    searchResult: Pageable<T> | null | undefined;
+    isSearching: boolean;
+    search?: (query: string, paginationSettings: PaginationSettings) => Promise<Pageable<any>>;
+    onChangePageSize?: (size: number) => void;
+};
+
+/**
+ * Allows to change the initial sort configuration for the child asset groups table placed in the asset group masterdata page.
+ * @param {Sort} sort The sort configuration.
+ * @example <caption>Sort by definition name ascending</caption>
+ * import { modifyChildAssetGroupsInitialSort } from '@deviceinsight/scale-ui-types';
+ *
+ * modifyChildAssetGroupsInitialSort({
+ *   property: 'definitionName',
+ *   direction: 'ASC'
+ * });
+ */
+declare const modifyChildAssetGroupsInitialSort: (sort: Sort) => void;
+
+type Props = ButtonHTMLAttributes<HTMLButtonElement> & {
+    icon: ReactNode;
+};
+declare function ContextBarAction({ className, icon, ...props }: Props): JSX.Element;
+
+declare function ContextBarActionContainer({ children }: PropsWithChildren): null;
+
+type CustomSearchProperty = {
+    key: string;
+    type: 'string' | 'number' | 'boolean';
+};
+
+/**
+ * Allows to define custom search properties in the advanced search panel.
+ * @param {Array<CustomSearchProperty> | undefined} properties The custom search properties.
+ * @example
+ * import {modifyCustomSearchProperties} from '@deviceinsight/ng-ui-scale-lib/api';
+ *
+ * modifyCustomSearchProperties([{key: 'custom.prop', type: 'string'}, {key: 'custom.bool', type: 'boolean'}]);
+ */
+declare const modifyCustomSearchProperties: (properties: CustomSearchProperty[]) => void;
+
+declare function setFavicon(filename: string): Promise<void>;
+declare function setPrimaryColor(color: string): Promise<void>;
+declare const eventBus: {
+    onSignin: (eventHandler: (user: api.User, autoSignin: boolean) => any, once?: boolean) => void;
+    onSignout: (eventHandler: (arg0: api.User) => any, once?: boolean) => void;
+    onThemeChange: (eventHandler: (config: ThemeConfig) => any, once?: boolean) => void;
+    onUserProfileChange: (eventHandler: (user: api.User) => void, once?: boolean) => void;
+};
+
+export { App, AppConfigurationBundle, AssetAndGroupsAndGateway, AssetGroupInfo, CanDeleteResult, ContextActionType, ContextBarAction, ContextBarActionContainer, ContextInfoProps, DashboardConfig, DashboardWidgetConfig, DashboardWidgetType, HasAuthorities, NavGroup, _default$4 as RouteApi, RouteConfig, RouteLink, SearchProps, _default$3 as StyleApi, StyleCustomization, TFunction, _default$2 as ThemeApi, ThemeConfig, Trans, _default$5 as TranslationApi, TranslationDescriptor, _default$1 as UiConfigurationApi, UserColumnDefs, UserGroupColumnDefs, VisibilityProps, WidgetConfigProps, WidgetDefinition, WidgetProps, addCustomHeaderElement, addI18nextXHRBackend, eventBus, modifyGenerateAssetUrn as generateAssetUrn, _default as getNguiAxios, getStartPage, hasAuthorities, modifyAssetColumnDefinitions, modifyAssetGroupColumnDefinitions, modifyCanDeleteBundle, modifyCanDeleteBundleVersion, modifyChildAssetGroupsInitialSort, modifyCustomSearchProperties, modifyDashboardWidgets, modifyIsDashboardVisible, modifyMapMarkerIcon, modifyPropertyVisibility, modifyRoutes, modifyUserColumnDefinitions, modifyUserGroupColumnDefinitions, removeCustomHeaderElement, replaceComponent, retrieveAuthInfo, setContextInfo, setCustomFilesCategories, setCustomLoginPageElement, setEnvironment, setFavicon, setLocizeProject, setPrimaryColor, setTitle, useAssetTimezone, useTranslation, useUserAccountInfo, ux4iotGrantRequestFunction };