@trackunit/filters-filter-bar 0.0.1-alpha-d272aa10e1.0

package/src/lib/types/FilterTypes.d.ts

@@ -0,0 +1,219 @@
+import React from "react";
+export type ValueName = {
+    value: string;
+    name: string;
+};
+export type NumberValue = {
+    numberValue?: number;
+};
+export type BooleanValue = {
+    booleanValue?: boolean;
+};
+export type Coordinate = {
+    latitude: number;
+    longitude: number;
+};
+export type BoundingBox = {
+    nw: Coordinate;
+    /** The coordinates for the South/East values of the bounding box. */
+    se: Coordinate;
+    /** The zoom level from which the bound box spans. */
+    zoom?: number;
+};
+export type MinMaxFilterValue = {
+    min?: number;
+    max?: number;
+};
+export type FilterValueType = string[] | ValueName[] | MinMaxFilterValue | BoundingBox | string | number | boolean | undefined;
+export declare type FilterTypes = "boolean" | "string" | "number" | "dateRange" | "boundingBox" | "valueName" | "stringArray" | "minMax";
+export type FilterMapActions = {
+    updateStarredFilters: (filterkey: string) => void;
+    toggleArrayValue: (key: string, value: string) => void;
+    setStringValue: (key: string, value: string) => void;
+    setArrayValue: (key: string, value: string[]) => void;
+    setBoundingBox: (boundingBox: BoundingBox) => void;
+    setNumberValue: (key: string, value: NumberValue) => void;
+    setBooleanValue: (key: string, value: BooleanValue) => void;
+    setDateRange: (key: string, value: DateRangeValue) => void;
+    setMinMaxValue: (key: string, minMaxValue: MinMaxFilterValue) => void;
+    setArrayObjectValue: (key: string, value: ValueName[]) => void;
+    toggleArrayObjectValue: (key: string, value: ValueName) => void;
+    resetFiltersToInitialState: () => void;
+    resetIndividualFilterToInitialState: (key: string) => void;
+};
+export type FilterMapGetter = {
+    getFilterName: () => string;
+    objectArrayIncludesValue: (key: string, value: string) => boolean;
+    getValuesByKey: (key: string) => FilterValueType;
+    arrayIncludesValue: (key: string, value: string) => boolean;
+    filtersHaveBeenApplied: boolean;
+    filterHasChanged(key: string): boolean;
+    isFilterIncludedByKey(key: string): boolean;
+};
+export type FilterName = string;
+export type FilterBarDefinition = Record<FilterName, FilterDefinition>;
+export type FilterTranslation = string;
+export type FilterGroup = "METADATA" | "STATUS" | "SITES" | "OTHER" | "CUSTOM_FIELDS" | "MY_NETWORK" | "ASSET" | "OPERATOR" | "SERVICE" | "RENTAL";
+export interface AbstractFilterDefinition {
+    /**
+     * The unique key or identifier for the filter.
+     */
+    filterKey: FilterName;
+    /**
+     * The type of the filter, indicating its behavior and data format.
+     */
+    type: FilterTypes;
+    /**
+     * The title and translation for the filter.
+     */
+    title: FilterTranslation;
+    /**
+     * If the filter should be on the provided filter bar as default
+     */
+    default?: boolean;
+    /**
+     * The Group the filter will be shown under in the ui.
+     *
+     * @default "OTHER"
+     */
+    group: FilterGroup;
+    /**
+     * In which filter bar should the filter be present
+     *
+     * @deprecated Will be removed in next release
+     */
+    includeAt?: string;
+    /**
+     * If the filter should be feature flagged away
+     *
+     * @deprecated Will be removed in next release
+     */
+    requireFlag?: string;
+    /**
+     * A function that determines if the filter should be displayed in the starred filter menu.
+     */
+    showInStarredMenu?: () => boolean;
+}
+export interface BooleanFilterDefinition extends AbstractFilterDefinition {
+    type: "boolean";
+    defaultValue?: BooleanValue;
+    valueAsText?: (value: BooleanValue) => string;
+    component: (filterComponentProps: FilterViewProps<BooleanValue>) => React.ReactNode;
+}
+export interface StringFilterDefinition extends AbstractFilterDefinition {
+    type: "string";
+    defaultValue?: string;
+    valueAsText?: (value: string) => string;
+    component: (filterComponentProps: FilterViewProps<string>) => React.ReactNode;
+}
+export interface NumberFilterDefinition extends AbstractFilterDefinition {
+    type: "number";
+    defaultValue?: number;
+    valueAsText?: (value: boolean) => string;
+    component: (filterComponentProps: FilterViewProps<number>) => React.ReactNode;
+}
+export interface BoundingBoxFilterDefinition extends AbstractFilterDefinition {
+    type: "boundingBox";
+    defaultValue?: BoundingBox;
+    valueAsText?: (value: BoundingBox) => string;
+    component: (filterComponentProps: FilterViewProps<BoundingBox>) => React.ReactNode;
+}
+export interface ValueNameFilterDefinition extends AbstractFilterDefinition {
+    type: "valueName";
+    defaultValue?: ValueName[];
+    valueAsText?: (value: ValueName[]) => string[];
+    component: (filterComponentProps: FilterViewProps<ValueName[]>) => React.ReactNode;
+}
+export interface StringArrayFilterDefinition extends AbstractFilterDefinition {
+    type: "stringArray";
+    defaultValue?: string[];
+    valueAsText?: (value: string[]) => string[];
+    component: (filterComponentProps: FilterViewProps<string[]>) => React.ReactNode;
+}
+export interface MinMaxFilterDefinition extends AbstractFilterDefinition {
+    type: "minMax";
+    defaultValue?: MinMaxFilterValue;
+    /**
+     * The minimum value that can be selected for this defintion
+     */
+    minimumNumber?: number | undefined;
+    /**
+     * The maximum value that can be selected for this defintion
+     */
+    maximumNumber?: number | undefined;
+    valueAsText?: (value: MinMaxFilterValue) => string;
+    component: (filterComponentProps: FilterViewProps<MinMaxFilterValue>) => React.ReactNode;
+}
+export type DateRangeValue = {
+    from: string | undefined;
+    to: string | undefined;
+};
+export interface DateRangeFilterDefinition extends AbstractFilterDefinition {
+    type: "dateRange";
+    defaultValue?: DateRangeValue;
+    /**
+     * The minimum value that can be selected for this defintion
+     */
+    from?: string | undefined;
+    /**
+     * The maximum value that can be selected for this defintion
+     */
+    to?: string | undefined;
+    valueAsText?: (value: DateRangeValue) => string;
+    component: (filterComponentProps: FilterViewProps<DateRangeValue>) => React.ReactNode;
+}
+export type FilterDefinition = BooleanFilterDefinition | MinMaxFilterDefinition | StringFilterDefinition | NumberFilterDefinition | DateRangeFilterDefinition | BoundingBoxFilterDefinition | ValueNameFilterDefinition | StringArrayFilterDefinition;
+export type FilterDefinitionValue = NonNullable<FilterDefinition["defaultValue"]>;
+export interface FilterViewProps<TReturnType> {
+    filterDefinition: FilterDefinition;
+    value?: TReturnType;
+    setValue: FilterStateSetterCallback<TReturnType>;
+    filterState: FilterState<{}>;
+    filterBarActions: FilterMapActions & FilterMapGetter;
+}
+export type FiltersStoreInstance<T extends FilterBarDefinition> = Partial<FilterBarConfig<T>>;
+/**
+ * This is the container of all the FilterMaps that can be used to filter, this is persisted to localstorage.
+ */
+export interface FilterStateMap<T extends FilterBarDefinition> {
+    filtersMap: Record<string, FilterBarConfig<T>>;
+}
+export type FilterBarInferredValue<T extends FilterBarDefinition, K extends keyof T> = T[K]["type"] extends infer Type ? Type extends "boolean" ? boolean | undefined : Type extends "string" ? string | undefined : Type extends "number" ? number | undefined : Type extends "boundingBox" ? BoundingBox | undefined : Type extends "valueName" ? ValueName[] | undefined : Type extends "stringArray" ? string[] | undefined : Type extends "minMax" ? MinMaxFilterValue | undefined : Type extends "dateRange" ? DateRangeValue | undefined : undefined : undefined;
+export type SetterKey<T extends string> = `set${Capitalize<T>}`;
+export type ReverseSetterKey<T extends string> = Uncapitalize<T extends `set${infer U}` ? U : never>;
+export type ExtractFilterKeys<T extends FilterBarDefinition> = Extract<keyof T, string>;
+export type ExtractSetterKeys<T extends FilterBarDefinition> = {
+    [K in ExtractFilterKeys<T>]: SetterKey<K>;
+};
+export type FilterStateSetterCallback<T> = (callback: (prev: T | undefined) => T | undefined) => void;
+export type FilterStateSetters<TFilterBarDefinition extends FilterBarDefinition> = {
+    [K in ExtractSetterKeys<TFilterBarDefinition>[keyof ExtractSetterKeys<TFilterBarDefinition>]]: FilterStateSetterCallback<FilterBarInferredValue<TFilterBarDefinition, ReverseSetterKey<K>> | undefined>;
+};
+export type FilterStateValues<T extends FilterBarDefinition> = {
+    [K in keyof T]?: FilterBarInferredValue<T, K>;
+};
+export type InitialState<T extends FilterBarDefinition> = {
+    [K in keyof T]?: FilterBarInferredValue<T, K>;
+};
+export interface FilterState<T extends FilterBarDefinition> {
+    values: FilterStateValues<T>;
+    setters: FilterStateSetters<T>;
+}
+/**
+ * A FilterBarConfig is the Container of filters that can be used to filter.
+ */
+export interface FilterBarConfig<T extends FilterBarDefinition> extends FilterState<T> {
+    name: string;
+    /**
+     * The initial state of the filters in this filter list.
+     */
+    initialState: InitialState<T>;
+    /**
+     * Allowed FilterName for this filter
+     */
+    filterNames: ExtractFilterKeys<T>[];
+    /**
+     * Filter names that should be starred for this filter list.
+     */
+    starredFilterKeys: ExtractFilterKeys<T>[];
+}

package/src/lib/utils/FilterEvents.d.ts

@@ -0,0 +1,17 @@
+import { BaseEvent, UnspecifiedEvent } from "@trackunit/react-core-contexts-api";
+export interface FilterEvent extends BaseEvent {
+    type: string;
+    value: string | number;
+}
+/**
+ * Events — each with a name, and eventType.
+ * Adding a Description is encouraged, amplitudeName is NOT, but here for legacy reasons.
+ * Each entry must be made with createEvent to get get typed events
+ *
+ * Pass an event type to createEvent to specify the interface e.g. specify
+ * which properties are required/recommended when using logEvent() on said event
+ */
+export declare const FilterEvents: {
+    FilterApplied: import("@trackunit/react-core-contexts-api").Event<FilterEvent>;
+    StarringFilter: import("@trackunit/react-core-contexts-api").Event<UnspecifiedEvent>;
+};

package/src/lib/utils/capitalize.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Capitalizes the first letter of a string.
+ *
+ * @param {string | null | undefined} s - The input string to capitalize. Can be null or undefined.
+ * @returns {string} The input string with its first letter capitalized, or an empty string if the input is null or undefined.
+ */
+export declare const capitalize: (s: string | null | undefined) => string;

package/src/lib/utils/createInitialState.d.ts

@@ -0,0 +1,21 @@
+import { FilterBarConfig, FilterBarDefinition, FilterBarInferredValue, FilterDefinition, FilterTypes, InitialState, ValueName } from "../types/FilterTypes";
+/**
+ * A helper function that returns a default value based on the filter type.
+ *
+ * @param {FilterTypes} type - The filter type for which to retrieve the initial value.
+ * @returns {string[] | ValueName[] | null | { min: undefined, max: undefined } | { from: undefined, to: undefined }} - The initial value corresponding to the given filter type.
+ */
+export declare const getInitialValueFromType: (type: FilterTypes) => string[] | ValueName[] | null | {
+    min: undefined;
+    max: undefined;
+} | {
+    from: undefined;
+    to: undefined;
+};
+/**
+ * Creates an initial state object for a filter bar configuration based on the provided parameters.
+ *
+ * @template TFilterBarDefinition - The type representing the filter bar definition.
+ * @returns {FilterBarConfig<TFilterBarDefinition>} - Returns an initial filter bar configuration object.
+ */
+export declare const createInitialState: <TFilterBarDefinition extends FilterBarDefinition>(name: string, mainFilters: FilterDefinition[], initialState: InitialState<TFilterBarDefinition>, setValue: (key: string, callback: (prev: FilterBarInferredValue<TFilterBarDefinition, never> | undefined) => FilterBarInferredValue<TFilterBarDefinition, never> | undefined) => void) => FilterBarConfig<TFilterBarDefinition>;

package/src/lib/utils/getCountryName.d.ts

@@ -0,0 +1,10 @@
+import { TransForLibs } from "@trackunit/i18n-library-translation";
+/**
+ * Get the name of a country based on its country code.
+ *
+ * @param {string} countryCode - The country code for which to retrieve the name.
+ * @param {TransForLibs<"myNetwork.insights.unknown">} t - A translation function for localized strings.
+ * @param {Array<string>} languages - An array of language codes to determine the display language.
+ * @returns {string} The name of the country or a localized "unknown" string if the country code is "UNKNOWN" or if the name is not found.
+ */
+export declare const getCountryName: (countryCode: string, t: TransForLibs<"myNetwork.insights.unknown">, languages: readonly string[]) => string;

package/src/lib/utils/mergeFilters.d.ts

@@ -0,0 +1,8 @@
+import { FilterDefinition } from "../types/FilterTypes";
+/**
+ * Merges additional filters into an existing filter bar definition.
+ *
+ * @param {Record<string, FilterDefinition>} filterBarDefinition - The existing filter bar definition to which the filters will be added.
+ * @param {FilterDefinition[]} extraFilters - An array of additional filters to merge into the definition.
+ */
+export declare const mergeFilters: (filterBarDefinition: Record<string, FilterDefinition>, extraFilters: FilterDefinition[]) => void;

package/src/lib/utils/reduceFilterText.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Returns the two first values, appends counter if more.
+ *
+ * @param {string[]} [input] Array of values to reduce
+ * @returns {*}  {string}
+ */
+export declare const reduceFilterText: (input: string | string[]) => string;

package/src/lib/utils/toggleFilterValue.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Toggles a filter value in an array.
+ *
+ * @template T - The type of the filter values.
+ * @returns {(prev?: T[]) => T[]} A function that takes an optional previous array of filter values
+ */
+export declare const toggleFilterValue: <T extends Object>(value: T) => (prev?: T[] | undefined) => T[];

package/src/lib/utils/validateFilter.d.ts

@@ -0,0 +1,10 @@
+import { FilterBarConfig, FilterBarDefinition, FilterDefinition } from "../types/FilterTypes";
+/**
+ * Validates a filter configuration against filter definitions.
+ *
+ * @template TFilterBarDefinition - The type of the filter bar definition.
+ * @param {FilterBarConfig<TFilterBarDefinition>} filter - The filter configuration to validate.
+ * @param {FilterDefinition[]} filterDefinitions - An array of filter definitions to validate against.
+ * @returns {boolean} - Returns `true` if the filter configuration is valid, otherwise `false`.
+ */
+export declare const validateFilter: <TFilterBarDefinition extends FilterBarDefinition>(filter: FilterBarConfig<TFilterBarDefinition>, filterDefinitions: FilterDefinition[]) => boolean;

package/src/translation.d.ts

@@ -0,0 +1,34 @@
+/// <reference types="react" />
+import { NamespaceTransProps, TransForLibs, TranslationResource } from "@trackunit/i18n-library-translation";
+import defaultTranslations from "./locales/en/translation.json";
+/** A type for all available translation keys in this library */
+export type TranslationKeys = keyof typeof defaultTranslations;
+/** The translation namespace for this library */
+export declare const namespace = "filters";
+/**
+ * The TranslationResource for this Library.
+ * Holds lazy loaded imports for all languages supported by the library.
+ *
+ * This is used to register the translations for this library before initializing i18next.
+ */
+export declare const translations: TranslationResource<TranslationKeys>;
+/**
+ *  Local useTranslation for this specific library
+ */
+export declare const useTranslation: () => [TransForLibs<"access.management.filter.operator.role.keyAdmin" | "access.management.keys.filter.active" | "access.management.keys.filter.deleted" | "access.management.keys.filter.expired" | "access.management.keys.filter.future" | "access.management.operator.asset.filter.category" | "access.management.operator.asset.filter.keyType" | "access.management.operator.asset.filter.type.digitalKey" | "access.management.operator.asset.filter.type.rollingPin" | "access.management.operator.asset.filter.type.staticPin" | "access.management.operator.filter.category" | "access.management.operator.filter.keyStatus.title" | "access.management.operator.filter.operatorRole.title" | "assetFilters.activityFilter.idling" | "assetFilters.activityFilter.stopped" | "assetFilters.activityFilter.unknown" | "assetFilters.activityFilter.working" | "assetFilters.assetType.ATTACHMENT" | "assetFilters.assetType.EQUIPMENT" | "assetFilters.assetType.GATEWAY" | "assetFilters.assetType.MACHINE" | "assetFilters.assetType.OTHER" | "assetFilters.assetType.TOOL" | "assetFilters.boundingBoxFilter.label" | "assetFilters.boundingBoxFilter.value" | "assetFilters.criticality.CRITICAL" | "assetFilters.criticality.LOW" | "assetFilters.criticality.NONE" | "assetFilters.followedFilter.label" | "assetFilters.hourIntervalFilter.label" | "assetFilters.lastSeenFilter.anytime" | "assetFilters.lastSeenFilter.last24Hours" | "assetFilters.lastSeenFilter.last30Days" | "assetFilters.lastSeenFilter.last7Days" | "assetFilters.lastSeenFilter.lastHour" | "assetFilters.lastSeenFilter.olderThan30Days" | "assetFilters.ownerAccountNameFilter.label" | "assetFilters.partnerFilter.label" | "assetFilters.periodFilter.label" | "assetFilters.periodFilter.LAST_24_HOURS" | "assetFilters.periodFilter.LAST_30_DAYS" | "assetFilters.periodFilter.LAST_7_DAYS" | "assetFilters.periodFilter.LIFETIME" | "assetFilters.planned" | "assetFilters.productionYear.label" | "assetFilters.regions.ANTARCTICA" | "assetFilters.regions.AUSTRALIA_AND_NEW_ZEALAND" | "assetFilters.regions.CENTRAL_ASIA" | "assetFilters.regions.EASTERN_ASIA" | "assetFilters.regions.EASTERN_EUROPE" | "assetFilters.regions.label" | "assetFilters.regions.LATIN_AMERICA_AND_THE_CARIBBEAN" | "assetFilters.regions.MELANESIA" | "assetFilters.regions.MICRONESIA" | "assetFilters.regions.NORTHERN_AFRICA" | "assetFilters.regions.NORTHERN_AMERICA" | "assetFilters.regions.NORTHERN_EUROPE" | "assetFilters.regions.POLYNESIA" | "assetFilters.regions.SOUTH-EASTERN_ASIA" | "assetFilters.regions.SOUTHERN_ASIA" | "assetFilters.regions.SOUTHERN_EUROPE" | "assetFilters.regions.SUB-SAHARAN_AFRICA" | "assetFilters.regions.WESTERN_ASIA" | "assetFilters.regions.WESTERN_EUROPE" | "assetFilters.regions.WHOLE_WORLD" | "assetFilters.rentalCustomerNameFilter.label" | "assetFilters.rentalStatusFilter.label" | "assetFilters.searchFilter.label" | "assetFilters.searchPlaceholder" | "assetFilters.serviceAssignmentStatusFilter.label" | "assetFilters.servicePlanFilter.fullyConfigured" | "assetFilters.servicePlanFilter.label" | "assetFilters.servicePlanFilter.notConfigured" | "assetFilters.servicePlanFilter.partiallyConfigured" | "assetFilters.serviceProviderFilter.label" | "assetFilters.serviceProviderStatusFilter.hasServiceProvider" | "assetFilters.serviceProviderStatusFilter.noServiceProvider" | "assetFilters.serviceStatusFilter.label" | "assetFilters.serviceStatusFilter.overdue" | "assetFilters.serviceStatusFilter.upcoming" | "assetFilters.shareOwnerFilter.label" | "assetFilters.unknown" | "assetFilters.visibleToFilter.label" | "auditlog.filter.categories" | "auditlog.filter.component" | "auditlog.filter.components" | "auditlog.filter.events" | "auditlog.filter.users" | "filtersBar.closeFilter" | "filtersBar.defaultAssetFilters.followedFilter.ALL" | "filtersBar.defaultAssetFilters.followedFilter.allLabel" | "filtersBar.defaultAssetFilters.followedFilter.FOLLOWED" | "filtersBar.defaultAssetFilters.followedFilter.followedOnlyLabel" | "filtersBar.defaultAssetFilters.lastSeenFilter.ALL" | "filtersBar.defaultAssetFilters.lastSeenFilter.LAST_24_HOURS" | "filtersBar.defaultAssetFilters.lastSeenFilter.LAST_30_DAYS" | "filtersBar.defaultAssetFilters.lastSeenFilter.LAST_7_DAYS" | "filtersBar.defaultAssetFilters.lastSeenFilter.LAST_HOUR" | "filtersBar.defaultAssetFilters.lastSeenFilter.OLDER_THAN_30_DAYS" | "filtersBar.defaultDateRangeFilters.apply" | "filtersBar.defaultDateRangeFilters.cancel" | "filtersBar.defaultMinMaxFilters.apply" | "filtersBar.defaultMinMaxFilters.max" | "filtersBar.defaultMinMaxFilters.min" | "filtersBar.emptyResults" | "filtersBar.filtersHeading" | "filtersBar.groups.ASSET" | "filtersBar.groups.CUSTOM_FIELDS" | "filtersBar.groups.METADATA" | "filtersBar.groups.MY_NETWORK" | "filtersBar.groups.OPERATOR" | "filtersBar.groups.OTHER" | "filtersBar.groups.RENTAL" | "filtersBar.groups.SERVICE" | "filtersBar.groups.SITES" | "filtersBar.groups.STATUS" | "filtersBar.loading" | "filtersBar.myNetworkGroup" | "filtersBar.resetFilter" | "filtersBar.resetFilters" | "filtersBar.starredFilters.title" | "filtersBar.starredFiltersTitle" | "fleetlist.column.activity" | "fleetlist.column.assetIds" | "fleetlist.column.assetType" | "fleetlist.column.attention" | "fleetlist.column.brand" | "fleetlist.column.city" | "fleetlist.column.country" | "fleetlist.column.externalReference" | "fleetlist.column.lastSeen" | "fleetlist.column.metadata" | "fleetlist.column.model" | "fleetlist.column.name" | "fleetlist.column.owner" | "fleetlist.column.siteStatus" | "fleetlist.column.siteType" | "fleetlist.column.streetAddress" | "fleetlist.column.totalHours" | "fleetlist.column.type" | "fleetlist.column.unitSerialNumber" | "fleetlist.column.vin" | "fleetlist.column.year" | "fleetlist.column.zipCode" | "fleetlist.createGroup" | "fleetlist.description" | "fleetList.sorting.ACTIVITY" | "fleetList.sorting.ASSET_TYPE" | "fleetList.sorting.BRAND" | "fleetList.sorting.CATEGORY" | "fleetList.sorting.CRITICALITY" | "fleetList.sorting.EXTERNAL_REFERENCE" | "fleetList.sorting.LOCATION" | "fleetList.sorting.LOCATION_UPDATED_AT" | "fleetList.sorting.MODEL" | "fleetList.sorting.NAME" | "fleetList.sorting.OWNER_ACCOUNT_NAME" | "fleetList.sorting.PRODUCTION_YEAR" | "fleetList.sorting.SERIAL_NUMBER" | "fleetList.sorting.SERVICE_PLAN_ASSIGNMENT_STATUS" | "fleetList.sorting.SERVICE_PLAN_OVERDUENESS" | "fleetList.sorting.SERVICE_PLAN_STATUS" | "fleetList.sorting.TELEMATICS_DEVICE_SERIAL_NUMBER" | "fleetList.sorting.TYPE" | "fleetList.sortingCategories.metadata" | "fleetList.sortingCategories.other" | "fleetList.sortingCategories.status" | "machine.types.ALL" | "machine.types.Unknown" | "myNetwork.deviceList.filterBar.accessControlType" | "myNetwork.deviceList.filterBar.canProfile" | "myNetwork.deviceList.filterBar.country" | "myNetwork.deviceList.filterBar.deviceHealth" | "myNetwork.deviceList.filterBar.deviceHealthScore" | "myNetwork.deviceList.filterBar.deviceType" | "myNetwork.deviceList.filterBar.digitalKeyMode" | "myNetwork.deviceList.filterBar.firmwareVersion" | "myNetwork.deviceList.filterBar.hasCanSupport" | "myNetwork.deviceList.filterBar.mobileOperator" | "myNetwork.deviceList.filterBar.networkTechnology" | "myNetwork.deviceList.filterBar.operatingHoursIssue" | "myNetwork.deviceList.filterBar.owner" | "myNetwork.deviceList.filterBar.powerProfile" | "myNetwork.insights.accessControlType.NO_ACCESSORY_CONNECTED" | "myNetwork.insights.accessControlType.TRACKUNIT_DUALID_CONNECTED" | "myNetwork.insights.accessControlType.TRACKUNIT_DUALID_II_CONNECTED" | "myNetwork.insights.accessControlType.TRACKUNIT_IBUTTON_READER_CONNECTED" | "myNetwork.insights.hasCanSupport.false" | "myNetwork.insights.hasCanSupport.true" | "myNetwork.insights.NONE" | "myNetwork.insights.operatingHoursIssue.HOURS_FROM_CAN_AND_PRERUN1_CONFIGURED" | "myNetwork.insights.operatingHoursIssue.MACHINE_CONSTANTLY_ON" | "myNetwork.insights.operatingHoursIssue.MULTIPLE_HOURS_SOURCE" | "myNetwork.insights.operatingHoursIssue.NOT_COUNTING_OPERATING_HOURS" | "myNetwork.insights.operatingHoursIssue.NOT_RECEIVING_HOURS_FROM_CAN" | "myNetwork.insights.unknown" | "myNetwork.overview.deviceHealthScoreV2.criticality.AT_RISK" | "myNetwork.overview.deviceHealthScoreV2.criticality.CRITICAL" | "myNetwork.overview.deviceHealthScoreV2.criticality.HEALTHY" | "myNetwork.overview.deviceHealthScoreV2.criticality.NONE" | "myNetwork.overview.unsupportedNetworkTechnology" | "pages.machines.telematics.networkTechnology.NW_TECH_2G" | "pages.machines.telematics.networkTechnology.NW_TECH_3G" | "pages.machines.telematics.networkTechnology.NW_TECH_4G" | "pages.machines.telematics.networkTechnology.UNKNOWN" | "pages.machines.telematics.operationalStatus.digitalKeyMode.DISABLED" | "pages.machines.telematics.operationalStatus.digitalKeyMode.LOCKED_FOR_ALL" | "pages.machines.telematics.operationalStatus.digitalKeyMode.name" | "pages.machines.telematics.operationalStatus.digitalKeyMode.NEVER_INITIALIZED" | "pages.machines.telematics.operationalStatus.digitalKeyMode.UNKNOWN" | "pages.machines.telematics.operationalStatus.digitalKeyMode.UNLOCKED_FOR_ALL" | "pages.machines.telematics.operationalStatus.digitalKeyMode.UNLOCKED_FOR_ALL_FIXED" | "pages.machines.telematics.operationalStatus.digitalKeyMode.UNLOCKED_FOR_KEY" | "pages.machines.telematics.operationalStatus.digitalKeyMode.UNLOCKED_FOR_KEY_AND_PIN" | "pages.machines.telematics.operationalStatus.digitalKeyMode.UNLOCKED_FOR_PIN" | "pages.machines.telematics.operationalStatus.digitalKeyMode.UNSUPPORTED" | "rental.status.available" | "rental.status.inRepair" | "rental.status.onRent" | "rental.status.other" | "rental.status.pickUpReady" | "rental.status.returned" | "rental.status.transfer" | "rental.status.unknown" | "siteFilters.siteStatus.ACTIVE" | "siteFilters.siteStatus.ARCHIVED" | "siteFilters.siteStatus.FINISHED" | "siteFilters.siteStatus.PLANNED" | "siteFilters.siteStatus.unknown" | "siteFilters.siteType.AREA" | "siteFilters.siteType.CLASSIC_POI" | "siteFilters.siteType.CLASSIC_ZONE" | "siteFilters.siteType.CONSTRUCTION_SITE" | "siteFilters.siteType.DEPOT" | "siteFilters.siteType.NOT_ON_SITE" | "siteFilters.siteType.unknown" | "siteFilters.siteType.WORK_PLACE">, import("i18next").i18n, boolean] & {
+    t: TransForLibs<"access.management.filter.operator.role.keyAdmin" | "access.management.keys.filter.active" | "access.management.keys.filter.deleted" | "access.management.keys.filter.expired" | "access.management.keys.filter.future" | "access.management.operator.asset.filter.category" | "access.management.operator.asset.filter.keyType" | "access.management.operator.asset.filter.type.digitalKey" | "access.management.operator.asset.filter.type.rollingPin" | "access.management.operator.asset.filter.type.staticPin" | "access.management.operator.filter.category" | "access.management.operator.filter.keyStatus.title" | "access.management.operator.filter.operatorRole.title" | "assetFilters.activityFilter.idling" | "assetFilters.activityFilter.stopped" | "assetFilters.activityFilter.unknown" | "assetFilters.activityFilter.working" | "assetFilters.assetType.ATTACHMENT" | "assetFilters.assetType.EQUIPMENT" | "assetFilters.assetType.GATEWAY" | "assetFilters.assetType.MACHINE" | "assetFilters.assetType.OTHER" | "assetFilters.assetType.TOOL" | "assetFilters.boundingBoxFilter.label" | "assetFilters.boundingBoxFilter.value" | "assetFilters.criticality.CRITICAL" | "assetFilters.criticality.LOW" | "assetFilters.criticality.NONE" | "assetFilters.followedFilter.label" | "assetFilters.hourIntervalFilter.label" | "assetFilters.lastSeenFilter.anytime" | "assetFilters.lastSeenFilter.last24Hours" | "assetFilters.lastSeenFilter.last30Days" | "assetFilters.lastSeenFilter.last7Days" | "assetFilters.lastSeenFilter.lastHour" | "assetFilters.lastSeenFilter.olderThan30Days" | "assetFilters.ownerAccountNameFilter.label" | "assetFilters.partnerFilter.label" | "assetFilters.periodFilter.label" | "assetFilters.periodFilter.LAST_24_HOURS" | "assetFilters.periodFilter.LAST_30_DAYS" | "assetFilters.periodFilter.LAST_7_DAYS" | "assetFilters.periodFilter.LIFETIME" | "assetFilters.planned" | "assetFilters.productionYear.label" | "assetFilters.regions.ANTARCTICA" | "assetFilters.regions.AUSTRALIA_AND_NEW_ZEALAND" | "assetFilters.regions.CENTRAL_ASIA" | "assetFilters.regions.EASTERN_ASIA" | "assetFilters.regions.EASTERN_EUROPE" | "assetFilters.regions.label" | "assetFilters.regions.LATIN_AMERICA_AND_THE_CARIBBEAN" | "assetFilters.regions.MELANESIA" | "assetFilters.regions.MICRONESIA" | "assetFilters.regions.NORTHERN_AFRICA" | "assetFilters.regions.NORTHERN_AMERICA" | "assetFilters.regions.NORTHERN_EUROPE" | "assetFilters.regions.POLYNESIA" | "assetFilters.regions.SOUTH-EASTERN_ASIA" | "assetFilters.regions.SOUTHERN_ASIA" | "assetFilters.regions.SOUTHERN_EUROPE" | "assetFilters.regions.SUB-SAHARAN_AFRICA" | "assetFilters.regions.WESTERN_ASIA" | "assetFilters.regions.WESTERN_EUROPE" | "assetFilters.regions.WHOLE_WORLD" | "assetFilters.rentalCustomerNameFilter.label" | "assetFilters.rentalStatusFilter.label" | "assetFilters.searchFilter.label" | "assetFilters.searchPlaceholder" | "assetFilters.serviceAssignmentStatusFilter.label" | "assetFilters.servicePlanFilter.fullyConfigured" | "assetFilters.servicePlanFilter.label" | "assetFilters.servicePlanFilter.notConfigured" | "assetFilters.servicePlanFilter.partiallyConfigured" | "assetFilters.serviceProviderFilter.label" | "assetFilters.serviceProviderStatusFilter.hasServiceProvider" | "assetFilters.serviceProviderStatusFilter.noServiceProvider" | "assetFilters.serviceStatusFilter.label" | "assetFilters.serviceStatusFilter.overdue" | "assetFilters.serviceStatusFilter.upcoming" | "assetFilters.shareOwnerFilter.label" | "assetFilters.unknown" | "assetFilters.visibleToFilter.label" | "auditlog.filter.categories" | "auditlog.filter.component" | "auditlog.filter.components" | "auditlog.filter.events" | "auditlog.filter.users" | "filtersBar.closeFilter" | "filtersBar.defaultAssetFilters.followedFilter.ALL" | "filtersBar.defaultAssetFilters.followedFilter.allLabel" | "filtersBar.defaultAssetFilters.followedFilter.FOLLOWED" | "filtersBar.defaultAssetFilters.followedFilter.followedOnlyLabel" | "filtersBar.defaultAssetFilters.lastSeenFilter.ALL" | "filtersBar.defaultAssetFilters.lastSeenFilter.LAST_24_HOURS" | "filtersBar.defaultAssetFilters.lastSeenFilter.LAST_30_DAYS" | "filtersBar.defaultAssetFilters.lastSeenFilter.LAST_7_DAYS" | "filtersBar.defaultAssetFilters.lastSeenFilter.LAST_HOUR" | "filtersBar.defaultAssetFilters.lastSeenFilter.OLDER_THAN_30_DAYS" | "filtersBar.defaultDateRangeFilters.apply" | "filtersBar.defaultDateRangeFilters.cancel" | "filtersBar.defaultMinMaxFilters.apply" | "filtersBar.defaultMinMaxFilters.max" | "filtersBar.defaultMinMaxFilters.min" | "filtersBar.emptyResults" | "filtersBar.filtersHeading" | "filtersBar.groups.ASSET" | "filtersBar.groups.CUSTOM_FIELDS" | "filtersBar.groups.METADATA" | "filtersBar.groups.MY_NETWORK" | "filtersBar.groups.OPERATOR" | "filtersBar.groups.OTHER" | "filtersBar.groups.RENTAL" | "filtersBar.groups.SERVICE" | "filtersBar.groups.SITES" | "filtersBar.groups.STATUS" | "filtersBar.loading" | "filtersBar.myNetworkGroup" | "filtersBar.resetFilter" | "filtersBar.resetFilters" | "filtersBar.starredFilters.title" | "filtersBar.starredFiltersTitle" | "fleetlist.column.activity" | "fleetlist.column.assetIds" | "fleetlist.column.assetType" | "fleetlist.column.attention" | "fleetlist.column.brand" | "fleetlist.column.city" | "fleetlist.column.country" | "fleetlist.column.externalReference" | "fleetlist.column.lastSeen" | "fleetlist.column.metadata" | "fleetlist.column.model" | "fleetlist.column.name" | "fleetlist.column.owner" | "fleetlist.column.siteStatus" | "fleetlist.column.siteType" | "fleetlist.column.streetAddress" | "fleetlist.column.totalHours" | "fleetlist.column.type" | "fleetlist.column.unitSerialNumber" | "fleetlist.column.vin" | "fleetlist.column.year" | "fleetlist.column.zipCode" | "fleetlist.createGroup" | "fleetlist.description" | "fleetList.sorting.ACTIVITY" | "fleetList.sorting.ASSET_TYPE" | "fleetList.sorting.BRAND" | "fleetList.sorting.CATEGORY" | "fleetList.sorting.CRITICALITY" | "fleetList.sorting.EXTERNAL_REFERENCE" | "fleetList.sorting.LOCATION" | "fleetList.sorting.LOCATION_UPDATED_AT" | "fleetList.sorting.MODEL" | "fleetList.sorting.NAME" | "fleetList.sorting.OWNER_ACCOUNT_NAME" | "fleetList.sorting.PRODUCTION_YEAR" | "fleetList.sorting.SERIAL_NUMBER" | "fleetList.sorting.SERVICE_PLAN_ASSIGNMENT_STATUS" | "fleetList.sorting.SERVICE_PLAN_OVERDUENESS" | "fleetList.sorting.SERVICE_PLAN_STATUS" | "fleetList.sorting.TELEMATICS_DEVICE_SERIAL_NUMBER" | "fleetList.sorting.TYPE" | "fleetList.sortingCategories.metadata" | "fleetList.sortingCategories.other" | "fleetList.sortingCategories.status" | "machine.types.ALL" | "machine.types.Unknown" | "myNetwork.deviceList.filterBar.accessControlType" | "myNetwork.deviceList.filterBar.canProfile" | "myNetwork.deviceList.filterBar.country" | "myNetwork.deviceList.filterBar.deviceHealth" | "myNetwork.deviceList.filterBar.deviceHealthScore" | "myNetwork.deviceList.filterBar.deviceType" | "myNetwork.deviceList.filterBar.digitalKeyMode" | "myNetwork.deviceList.filterBar.firmwareVersion" | "myNetwork.deviceList.filterBar.hasCanSupport" | "myNetwork.deviceList.filterBar.mobileOperator" | "myNetwork.deviceList.filterBar.networkTechnology" | "myNetwork.deviceList.filterBar.operatingHoursIssue" | "myNetwork.deviceList.filterBar.owner" | "myNetwork.deviceList.filterBar.powerProfile" | "myNetwork.insights.accessControlType.NO_ACCESSORY_CONNECTED" | "myNetwork.insights.accessControlType.TRACKUNIT_DUALID_CONNECTED" | "myNetwork.insights.accessControlType.TRACKUNIT_DUALID_II_CONNECTED" | "myNetwork.insights.accessControlType.TRACKUNIT_IBUTTON_READER_CONNECTED" | "myNetwork.insights.hasCanSupport.false" | "myNetwork.insights.hasCanSupport.true" | "myNetwork.insights.NONE" | "myNetwork.insights.operatingHoursIssue.HOURS_FROM_CAN_AND_PRERUN1_CONFIGURED" | "myNetwork.insights.operatingHoursIssue.MACHINE_CONSTANTLY_ON" | "myNetwork.insights.operatingHoursIssue.MULTIPLE_HOURS_SOURCE" | "myNetwork.insights.operatingHoursIssue.NOT_COUNTING_OPERATING_HOURS" | "myNetwork.insights.operatingHoursIssue.NOT_RECEIVING_HOURS_FROM_CAN" | "myNetwork.insights.unknown" | "myNetwork.overview.deviceHealthScoreV2.criticality.AT_RISK" | "myNetwork.overview.deviceHealthScoreV2.criticality.CRITICAL" | "myNetwork.overview.deviceHealthScoreV2.criticality.HEALTHY" | "myNetwork.overview.deviceHealthScoreV2.criticality.NONE" | "myNetwork.overview.unsupportedNetworkTechnology" | "pages.machines.telematics.networkTechnology.NW_TECH_2G" | "pages.machines.telematics.networkTechnology.NW_TECH_3G" | "pages.machines.telematics.networkTechnology.NW_TECH_4G" | "pages.machines.telematics.networkTechnology.UNKNOWN" | "pages.machines.telematics.operationalStatus.digitalKeyMode.DISABLED" | "pages.machines.telematics.operationalStatus.digitalKeyMode.LOCKED_FOR_ALL" | "pages.machines.telematics.operationalStatus.digitalKeyMode.name" | "pages.machines.telematics.operationalStatus.digitalKeyMode.NEVER_INITIALIZED" | "pages.machines.telematics.operationalStatus.digitalKeyMode.UNKNOWN" | "pages.machines.telematics.operationalStatus.digitalKeyMode.UNLOCKED_FOR_ALL" | "pages.machines.telematics.operationalStatus.digitalKeyMode.UNLOCKED_FOR_ALL_FIXED" | "pages.machines.telematics.operationalStatus.digitalKeyMode.UNLOCKED_FOR_KEY" | "pages.machines.telematics.operationalStatus.digitalKeyMode.UNLOCKED_FOR_KEY_AND_PIN" | "pages.machines.telematics.operationalStatus.digitalKeyMode.UNLOCKED_FOR_PIN" | "pages.machines.telematics.operationalStatus.digitalKeyMode.UNSUPPORTED" | "rental.status.available" | "rental.status.inRepair" | "rental.status.onRent" | "rental.status.other" | "rental.status.pickUpReady" | "rental.status.returned" | "rental.status.transfer" | "rental.status.unknown" | "siteFilters.siteStatus.ACTIVE" | "siteFilters.siteStatus.ARCHIVED" | "siteFilters.siteStatus.FINISHED" | "siteFilters.siteStatus.PLANNED" | "siteFilters.siteStatus.unknown" | "siteFilters.siteType.AREA" | "siteFilters.siteType.CLASSIC_POI" | "siteFilters.siteType.CLASSIC_ZONE" | "siteFilters.siteType.CONSTRUCTION_SITE" | "siteFilters.siteType.DEPOT" | "siteFilters.siteType.NOT_ON_SITE" | "siteFilters.siteType.unknown" | "siteFilters.siteType.WORK_PLACE">;
+    i18n: import("i18next").i18n;
+    ready: boolean;
+};
+/**
+ * Type of the t function for the local useTranslation for this specific library
+ */
+export type TranslationFunction = TransForLibs<TranslationKeys>;
+/**
+ * Trans for this specific library.
+ */
+export declare const Trans: (props: NamespaceTransProps<TranslationKeys>) => JSX.Element;
+/**
+ * Registers the translations for this library
+ */
+export declare const setupLibraryTranslations: () => void;