@trackunit/filters-asset-filter-definitions 1.17.0 → 1.17.1

package/index.cjs.js

@@ -3348,8 +3348,8 @@ const useCustomerHierarchy = (customerSummary) => {
  *
  * This component renders a hierarchical checkbox filter for selecting customer IDs.
  *
- * @param {FilterViewProps<ValueName[]>} props - Filter properties including data, state, and actions.
- * @param customerId - The ID of the customer that owns the customers shown in the filter bar.
+ * @param props - Filter properties including data, state, and actions.
+ * @param props.customerId - The ID of the customer that owns the customers shown in the filter bar.
  * @returns {ReactElement} A customer ID filter component for rendering in the UI.
  */
 const CustomerIdsFilterView = ({ customerId, ...props }) => {
@@ -4390,10 +4390,10 @@ const FETCH_LIMIT$7 = 1000;
  * This component provides an interface to select production years.
  * It fetches data from a GraphQL query and integrates with the filter bar's filtering logic.
  *
- * @param {ValueNameArrayFilterDefinition} filterDefinition - The filter's definition.
- * @param {FilterState} filterState - The current state of the filter, including selected values.
- * @param {object} filterBarActions - Actions for the filter's interaction with the filter bar.
- * @param {object} props - Additional props passed to the component.
+ * @param props - The filter view props.
+ * @param props.filterDefinition - The filter's definition.
+ * @param props.filterState - The current state of the filter, including selected values.
+ * @param props.filterBarActions - Actions for the filter's interaction with the filter bar.
  * @returns {ReactElement} React component to render the production year filter.
  */
 const ProductionYearFilterView = ({ filterDefinition, filterState, filterBarActions, ...props }) => {
@@ -5327,10 +5327,13 @@ const SiteTypesFilterView = (props) => {
     return jsxRuntime.jsx(filtersFilterBar.DefaultCheckboxFilter, { ...props, loading: loading, options: siteTypeOptions });
 };
 /**
- *  SiteType filter definition
+ * SiteType filter definition.
  *
- * @param showInFilterBar  Function to determine if filter should be shown in filter bar
- * @returns {StringArrayFilterDefinition}  SiteType filter definition
+ * @param props - The hook props.
+ * @param props.showInFilterBar - Function to determine if filter should be shown in filter bar.
+ * @param props.group - The filter group.
+ * @param props.persistValue - Whether to persist the filter value.
+ * @returns {StringArrayFilterDefinition} SiteType filter definition.
  */
 const useSiteTypeFilter = ({ showInFilterBar, persistValue, group } = {
     persistValue: true,

package/index.esm.js

@@ -3346,8 +3346,8 @@ const useCustomerHierarchy = (customerSummary) => {
  *
  * This component renders a hierarchical checkbox filter for selecting customer IDs.
  *
- * @param {FilterViewProps<ValueName[]>} props - Filter properties including data, state, and actions.
- * @param customerId - The ID of the customer that owns the customers shown in the filter bar.
+ * @param props - Filter properties including data, state, and actions.
+ * @param props.customerId - The ID of the customer that owns the customers shown in the filter bar.
  * @returns {ReactElement} A customer ID filter component for rendering in the UI.
  */
 const CustomerIdsFilterView = ({ customerId, ...props }) => {
@@ -4388,10 +4388,10 @@ const FETCH_LIMIT$7 = 1000;
  * This component provides an interface to select production years.
  * It fetches data from a GraphQL query and integrates with the filter bar's filtering logic.
  *
- * @param {ValueNameArrayFilterDefinition} filterDefinition - The filter's definition.
- * @param {FilterState} filterState - The current state of the filter, including selected values.
- * @param {object} filterBarActions - Actions for the filter's interaction with the filter bar.
- * @param {object} props - Additional props passed to the component.
+ * @param props - The filter view props.
+ * @param props.filterDefinition - The filter's definition.
+ * @param props.filterState - The current state of the filter, including selected values.
+ * @param props.filterBarActions - Actions for the filter's interaction with the filter bar.
  * @returns {ReactElement} React component to render the production year filter.
  */
 const ProductionYearFilterView = ({ filterDefinition, filterState, filterBarActions, ...props }) => {
@@ -5325,10 +5325,13 @@ const SiteTypesFilterView = (props) => {
     return jsx(DefaultCheckboxFilter, { ...props, loading: loading, options: siteTypeOptions });
 };
 /**
- *  SiteType filter definition
+ * SiteType filter definition.
  *
- * @param showInFilterBar  Function to determine if filter should be shown in filter bar
- * @returns {StringArrayFilterDefinition}  SiteType filter definition
+ * @param props - The hook props.
+ * @param props.showInFilterBar - Function to determine if filter should be shown in filter bar.
+ * @param props.group - The filter group.
+ * @param props.persistValue - Whether to persist the filter value.
+ * @returns {StringArrayFilterDefinition} SiteType filter definition.
  */
 const useSiteTypeFilter = ({ showInFilterBar, persistValue, group } = {
     persistValue: true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/filters-asset-filter-definitions",
-  "version": "1.17.0",
+  "version": "1.17.1",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -15,23 +15,23 @@
     "zod": "^3.23.8",
     "string-ts": "^2.0.0",
     "tailwind-merge": "^2.0.0",
-    "@trackunit/iris-app-build-utilities": "1.12.20",
-    "@trackunit/filters-filter-bar": "1.13.0",
-    "@trackunit/react-core-hooks": "1.12.0",
-    "@trackunit/react-filter-components": "1.12.0",
-    "@trackunit/react-form-components": "1.13.0",
-    "@trackunit/filters-graphql-hook": "1.16.0",
-    "@trackunit/utilization-indicator": "1.12.0",
-    "@trackunit/geo-json-utils": "1.11.19",
-    "@trackunit/react-components": "1.16.0",
-    "@trackunit/shared-utils": "1.13.19",
-    "@trackunit/translations-machine-type": "1.12.0",
-    "@trackunit/criticality-indicator": "1.12.0",
-    "@trackunit/iris-app-api": "1.14.18",
-    "@trackunit/react-core-contexts-test": "1.12.0",
-    "@trackunit/i18n-library-translation": "1.12.0",
-    "@trackunit/iris-app-runtime-core-api": "1.12.0",
-    "@trackunit/react-graphql-hooks": "1.13.0"
+    "@trackunit/iris-app-build-utilities": "1.12.21",
+    "@trackunit/filters-filter-bar": "1.13.1",
+    "@trackunit/react-core-hooks": "1.12.1",
+    "@trackunit/react-filter-components": "1.12.1",
+    "@trackunit/react-form-components": "1.13.1",
+    "@trackunit/filters-graphql-hook": "1.16.1",
+    "@trackunit/utilization-indicator": "1.12.1",
+    "@trackunit/geo-json-utils": "1.11.20",
+    "@trackunit/react-components": "1.16.1",
+    "@trackunit/shared-utils": "1.13.20",
+    "@trackunit/translations-machine-type": "1.12.1",
+    "@trackunit/criticality-indicator": "1.12.1",
+    "@trackunit/iris-app-api": "1.14.19",
+    "@trackunit/react-core-contexts-test": "1.12.1",
+    "@trackunit/i18n-library-translation": "1.12.1",
+    "@trackunit/iris-app-runtime-core-api": "1.12.1",
+    "@trackunit/react-graphql-hooks": "1.13.1"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/defaultFilters/defaults/CustomerIdsFilter.d.ts

@@ -5,8 +5,8 @@ import { ReactElement } from "react";
  *
  * This component renders a hierarchical checkbox filter for selecting customer IDs.
  *
- * @param {FilterViewProps<ValueName[]>} props - Filter properties including data, state, and actions.
- * @param customerId - The ID of the customer that owns the customers shown in the filter bar.
+ * @param props - Filter properties including data, state, and actions.
+ * @param props.customerId - The ID of the customer that owns the customers shown in the filter bar.
  * @returns {ReactElement} A customer ID filter component for rendering in the UI.
  */
 export declare const CustomerIdsFilterView: ({ customerId, ...props }: {

package/src/defaultFilters/defaults/ProductionYearFilter.d.ts

@@ -6,10 +6,10 @@ import { ReactElement } from "react";
  * This component provides an interface to select production years.
  * It fetches data from a GraphQL query and integrates with the filter bar's filtering logic.
  *
- * @param {ValueNameArrayFilterDefinition} filterDefinition - The filter's definition.
- * @param {FilterState} filterState - The current state of the filter, including selected values.
- * @param {object} filterBarActions - Actions for the filter's interaction with the filter bar.
- * @param {object} props - Additional props passed to the component.
+ * @param props - The filter view props.
+ * @param props.filterDefinition - The filter's definition.
+ * @param props.filterState - The current state of the filter, including selected values.
+ * @param props.filterBarActions - Actions for the filter's interaction with the filter bar.
  * @returns {ReactElement} React component to render the production year filter.
  */
 export declare const ProductionYearFilterView: ({ filterDefinition, filterState, filterBarActions, ...props }: FilterViewProps<Array<ValueName>>) => ReactElement;

package/src/defaultFilters/defaults/SiteTypeFilter.d.ts

@@ -34,10 +34,13 @@ interface SiteTypeFilterProps {
     persistValue?: boolean;
 }
 /**
- *  SiteType filter definition
+ * SiteType filter definition.
  *
- * @param showInFilterBar  Function to determine if filter should be shown in filter bar
- * @returns {StringArrayFilterDefinition}  SiteType filter definition
+ * @param props - The hook props.
+ * @param props.showInFilterBar - Function to determine if filter should be shown in filter bar.
+ * @param props.group - The filter group.
+ * @param props.persistValue - Whether to persist the filter value.
+ * @returns {StringArrayFilterDefinition} SiteType filter definition.
  */
 export declare const useSiteTypeFilter: ({ showInFilterBar, persistValue, group }?: SiteTypeFilterProps) => StringArrayFilterDefinition;
 export {};