@trackunit/filters-asset-filter-definitions 1.10.51 → 1.10.52

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.cjs.js CHANGED
@@ -417,7 +417,7 @@ const ActiveFilterFiltersView = (props) => {
417
417
  * Active filter definition
418
418
  * It is a boolean filter that filters out hidden assets from the asset list
419
419
  *
420
- * @returns {BooleanFilterDefinition}
420
+ * @returns {BooleanFilterDefinition} Active filter definition
421
421
  */
422
422
  const useActiveFilterFilter = ({ isHidden } = {
423
423
  isHidden: () => false,
@@ -2912,7 +2912,7 @@ const FETCH_LIMIT$9 = 1000;
2912
2912
  *
2913
2913
  * @param filterValues - The current values from the filter bar.
2914
2914
  * @param customerId - The ID of the customer that owns the customers shown in the filter bar.
2915
- * @returns An object containing the fetched data, loading state, and a function to set search text.
2915
+ * @returns {object} An object containing the fetched data, loading state, and a function to set search text.
2916
2916
  */
2917
2917
  const useCustomerData = (filterValues, customerId) => {
2918
2918
  const activeFilters = filtersGraphqlHook.useActiveAssetFilters(filterValues);
@@ -2951,7 +2951,7 @@ const assignLevelAndSort = (option, level) => {
2951
2951
  * Custom hook to transform customer summary data into a hierarchical options structure.
2952
2952
  *
2953
2953
  * @param customerSummary - The customer summary data fetched from the API.
2954
- * @returns An array of hierarchical filter options.
2954
+ * @returns {Array<HierarchicalFilterOption>} An array of hierarchical filter options.
2955
2955
  */
2956
2956
  const useCustomerHierarchy = (customerSummary) => {
2957
2957
  return react.useMemo(() => {
package/index.esm.js CHANGED
@@ -415,7 +415,7 @@ const ActiveFilterFiltersView = (props) => {
415
415
  * Active filter definition
416
416
  * It is a boolean filter that filters out hidden assets from the asset list
417
417
  *
418
- * @returns {BooleanFilterDefinition}
418
+ * @returns {BooleanFilterDefinition} Active filter definition
419
419
  */
420
420
  const useActiveFilterFilter = ({ isHidden } = {
421
421
  isHidden: () => false,
@@ -2910,7 +2910,7 @@ const FETCH_LIMIT$9 = 1000;
2910
2910
  *
2911
2911
  * @param filterValues - The current values from the filter bar.
2912
2912
  * @param customerId - The ID of the customer that owns the customers shown in the filter bar.
2913
- * @returns An object containing the fetched data, loading state, and a function to set search text.
2913
+ * @returns {object} An object containing the fetched data, loading state, and a function to set search text.
2914
2914
  */
2915
2915
  const useCustomerData = (filterValues, customerId) => {
2916
2916
  const activeFilters = useActiveAssetFilters(filterValues);
@@ -2949,7 +2949,7 @@ const assignLevelAndSort = (option, level) => {
2949
2949
  * Custom hook to transform customer summary data into a hierarchical options structure.
2950
2950
  *
2951
2951
  * @param customerSummary - The customer summary data fetched from the API.
2952
- * @returns An array of hierarchical filter options.
2952
+ * @returns {Array<HierarchicalFilterOption>} An array of hierarchical filter options.
2953
2953
  */
2954
2954
  const useCustomerHierarchy = (customerSummary) => {
2955
2955
  return useMemo(() => {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@trackunit/filters-asset-filter-definitions",
3
- "version": "1.10.51",
3
+ "version": "1.10.52",
4
4
  "repository": "https://github.com/Trackunit/manager",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "engines": {
@@ -16,24 +16,24 @@
16
16
  "jest-fetch-mock": "^3.0.3",
17
17
  "string-ts": "^2.0.0",
18
18
  "tailwind-merge": "^2.0.0",
19
- "@trackunit/iris-app-build-utilities": "1.7.30",
20
- "@trackunit/filters-filter-bar": "1.8.47",
21
- "@trackunit/react-core-hooks": "1.7.34",
22
- "@trackunit/react-filter-components": "1.7.46",
23
- "@trackunit/react-form-components": "1.8.45",
24
- "@trackunit/filters-graphql-hook": "1.10.48",
25
- "@trackunit/utilization-indicator": "1.7.43",
26
- "@trackunit/geo-json-utils": "1.7.29",
27
- "@trackunit/react-components": "1.9.43",
28
- "@trackunit/shared-utils": "1.9.29",
29
- "@trackunit/translations-machine-type": "1.7.38",
30
- "@trackunit/criticality-indicator": "1.7.43",
31
- "@trackunit/iris-app-api": "1.7.30",
32
- "@trackunit/react-core-contexts-test": "1.7.34",
33
- "@trackunit/i18n-library-translation": "1.7.35",
34
- "@trackunit/react-core-contexts-api": "1.8.31",
35
- "@trackunit/react-test-setup": "1.4.29",
36
- "@trackunit/react-graphql-hooks": "1.7.43"
19
+ "@trackunit/iris-app-build-utilities": "1.7.31",
20
+ "@trackunit/filters-filter-bar": "1.8.48",
21
+ "@trackunit/react-core-hooks": "1.7.35",
22
+ "@trackunit/react-filter-components": "1.7.47",
23
+ "@trackunit/react-form-components": "1.8.46",
24
+ "@trackunit/filters-graphql-hook": "1.10.49",
25
+ "@trackunit/utilization-indicator": "1.7.44",
26
+ "@trackunit/geo-json-utils": "1.7.30",
27
+ "@trackunit/react-components": "1.9.44",
28
+ "@trackunit/shared-utils": "1.9.30",
29
+ "@trackunit/translations-machine-type": "1.7.39",
30
+ "@trackunit/criticality-indicator": "1.7.44",
31
+ "@trackunit/iris-app-api": "1.7.31",
32
+ "@trackunit/react-core-contexts-test": "1.7.35",
33
+ "@trackunit/i18n-library-translation": "1.7.36",
34
+ "@trackunit/react-core-contexts-api": "1.8.32",
35
+ "@trackunit/react-test-setup": "1.4.30",
36
+ "@trackunit/react-graphql-hooks": "1.7.44"
37
37
  },
38
38
  "module": "./index.esm.js",
39
39
  "main": "./index.cjs.js",
@@ -15,7 +15,7 @@ interface ActiveFilterFilterProps {
15
15
  * Active filter definition
16
16
  * It is a boolean filter that filters out hidden assets from the asset list
17
17
  *
18
- * @returns {BooleanFilterDefinition}
18
+ * @returns {BooleanFilterDefinition} Active filter definition
19
19
  */
20
20
  export declare const useActiveFilterFilter: ({ isHidden }?: ActiveFilterFilterProps) => BooleanFilterDefinition;
21
21
  export {};
@@ -5,7 +5,7 @@ import { GetCustomerIdSummaryQuery } from "../../../generated/graphql-api/graphq
5
5
  *
6
6
  * @param filterValues - The current values from the filter bar.
7
7
  * @param customerId - The ID of the customer that owns the customers shown in the filter bar.
8
- * @returns An object containing the fetched data, loading state, and a function to set search text.
8
+ * @returns {object} An object containing the fetched data, loading state, and a function to set search text.
9
9
  */
10
10
  export declare const useCustomerData: (filterValues: FilterBarValues | undefined, customerId?: string) => {
11
11
  data: GetCustomerIdSummaryQuery | undefined;
@@ -6,7 +6,7 @@ type CustomerSummary = ReadonlyArray<CustomerSummaryItem | null> | undefined | n
6
6
  * Custom hook to transform customer summary data into a hierarchical options structure.
7
7
  *
8
8
  * @param customerSummary - The customer summary data fetched from the API.
9
- * @returns An array of hierarchical filter options.
9
+ * @returns {Array<HierarchicalFilterOption>} An array of hierarchical filter options.
10
10
  */
11
11
  export declare const useCustomerHierarchy: (customerSummary?: CustomerSummary) => Array<HierarchicalFilterOption>;
12
12
  export {};