@trackunit/filters-graphql-hook 2.1.48 → 2.1.50

package/index.esm.js

@@ -1,6 +1,6 @@
 import 'react/jsx-runtime';
 import { registerTranslations } from '@trackunit/i18n-library-translation';
-import { isStringArrayFilterValue, isMinMaxFilterValue, isDateRangeValue, isBooleanValue } from '@trackunit/filters-filter-bar';
+import { isStringArrayFilterValue, isMinMaxFilterValue, isDateRangeValue, isBooleanValue, dateRangeSchema, areaFilterGeoJsonGeometrySchema } from '@trackunit/filters-filter-bar';
 import { objectValues, truthy } from '@trackunit/shared-utils';
 import { z } from 'zod';
 import { useCurrentUserSystemOfMeasurement, useAssetSorting } from '@trackunit/react-core-hooks';
@@ -442,7 +442,15 @@ const useCustomFieldFilters = (filters) => {
     }, [filters]);
 };
 
+/**
+ * Prefix used for custom-field filter keys in the Manager filter-bar value map.
+ *
+ * Lives in its own dependency-free module so lightweight consumers (e.g. the
+ * lazily-loaded AssetFiltersInput converter) can reference the constant without
+ * pulling in the `useActiveAssetFilters` hook graph.
+ */
 const CustomFieldPrefix = "cf__";
+
 /**
  * Converts field filters to a format that can be used by the GraphQL API for AssetFiltersInput
  *
@@ -560,6 +568,364 @@ const useActiveAssetFilters = (filters) => {
 };
 const booleanArraySchema = z.array(z.boolean());
 
+const numberRangeSchema = z.object({
+    min: z.number().optional(),
+    max: z.number().optional(),
+});
+const aggregatedNumberRangeSchema = z.object({
+    period: z.literal("LIFETIME"),
+    range: numberRangeSchema,
+});
+const customFieldSchema = z
+    .object({
+    booleanValue: z.boolean().optional(),
+    dateRange: dateRangeSchema.optional(),
+    definitionId: z.string().optional(),
+    numberRange: z
+        .object({
+        from: z.number().optional(),
+        to: z.number().optional(),
+    })
+        .optional(),
+    stringArrayValue: z.array(z.string()).optional(),
+    stringWildcardValue: z.string().optional(),
+})
+    .strip();
+/**
+ * Drift guard: keying the supported subset to `keyof AssetFiltersInput` forces a
+ * compile error if the generated GraphQL schema renames or removes a field we map.
+ * Enum-value drift is already caught because every `z.nativeEnum(...)` references a
+ * generated GraphQL enum, so a removed enum breaks the import.
+ */
+const assetFiltersInputSchema = z
+    .object({
+    accessManagementDesiredModes: z.array(z.nativeEnum(accessManagementMode)).optional(),
+    activeFilter: z.boolean().optional(),
+    activities: z.array(z.nativeEnum(assetActivityState)).optional(),
+    area: areaFilterGeoJsonGeometrySchema.optional(),
+    assetIds: z.array(z.string()).optional(),
+    assetTypes: z.array(z.nativeEnum(assetType)).optional(),
+    brands: z.array(z.string()).optional(),
+    criticalities: z.array(z.nativeEnum(assetCriticalityState)).optional(),
+    customerIds: z.array(z.string()).optional(),
+    deviceTypes: z.array(z.string()).optional(),
+    fleetHealthCategories: z.array(z.nativeEnum(fleetDataHealthIssueCategory)).optional(),
+    fleetHealthDeviceStatuses: z.array(z.nativeEnum(fleetDataHealthDeviceStatus)).optional(),
+    fleetHealthTypes: z.array(z.nativeEnum(fleetDataHealthIssueType)).optional(),
+    groups: z.array(z.string()).optional(),
+    customFields: z.array(customFieldSchema).optional(),
+    insightsFilters: z
+        .object({
+        afterTreatmentDieselExhaustFluidTankLevel: numberRangeSchema.optional(),
+        batteryChargerState: z.array(z.boolean()).optional(),
+        batteryPotential: numberRangeSchema.optional(),
+        batteryStateOfChargePercent: numberRangeSchema.optional(),
+        cumulativeIdleHours: aggregatedNumberRangeSchema.optional(),
+        cumulativeOperatingHours: aggregatedNumberRangeSchema.optional(),
+        fuelLevel: numberRangeSchema.optional(),
+    })
+        .strip()
+        .optional(),
+    lastSeen: z.nativeEnum(assetLastSeen).optional(),
+    metadataCompleteness: z.nativeEnum(metadataCompleteness).optional(),
+    models: z.array(z.string()).optional(),
+    ownerAccountIds: z.array(z.string()).optional(),
+    owningDepotSiteIds: z.array(z.string()).optional(),
+    partnerId: z.string().optional(),
+    pendingTelematicsDevices: z.array(z.string()).optional(),
+    rentalActiveContractFilters: z
+        .object({
+        customerExternalReferences: z.array(z.string()).optional(),
+        customerParentExternalReferences: z.array(z.string()).optional(),
+        customerParentNames: z.array(z.string()).optional(),
+        offRentDatesDateRange: dateRangeSchema.optional(),
+        onRentDatesDateRange: dateRangeSchema.optional(),
+    })
+        .optional(),
+    rentalContractOrderNumbers: z.array(z.string()).optional(),
+    rentalContractReferenceCodeDescriptionQuery: z.string().optional(),
+    rentalContractReferenceCodes: z.array(z.string()).optional(),
+    rentalStatuses: z.array(z.nativeEnum(rentalStatus)).optional(),
+    searchQuery: z.string().optional(),
+    serviceBooked: z.array(z.boolean()).optional(),
+    servicePlanAssignments: z.array(z.nativeEnum(servicePlanStatus)).optional(),
+    servicePlanIds: z.array(z.string()).optional(),
+    servicePlanStatuses: z.array(z.nativeEnum(servicePlanStatus)).optional(),
+    serviceProviderIds: z.array(z.string()).optional(),
+    siteIds: z.array(z.string()).optional(),
+    siteTypes: z.array(z.nativeEnum(siteTypeSFS)).optional(),
+    sustainabilityExcluded: z.boolean().optional(),
+    telematicsDeviceIsConnected: z.boolean().optional(),
+    types: z.array(z.string()).optional(),
+})
+    .strip();
+/**
+ * Type guard for plain (non-array) objects so unknown payloads can be traversed safely.
+ *
+ * @param value - Unknown value to test.
+ * @returns {boolean} True when the value is a non-null, non-array object.
+ */
+const isPlainObject = (value) => {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+};
+/**
+ * Recursively strips properties whose value is `null` so they are treated as omitted.
+ *
+ * The generated `AssetFiltersInput` uses InputMaybe (`T | null | undefined`), and
+ * `useActiveAssetFilters` emits `null` for unset fields. The zod schema rejects `null`,
+ * so this deep-strips `null`-valued properties from plain objects, recursing into nested
+ * plain objects and arrays of plain objects. Non-null values are returned unchanged.
+ *
+ * @param value - Unknown payload to normalize.
+ * @returns {unknown} The payload with all `null`-valued properties removed.
+ */
+const stripNullProperties = (value) => {
+    if (Array.isArray(value)) {
+        return value.map(stripNullProperties);
+    }
+    if (isPlainObject(value)) {
+        const result = {};
+        for (const [key, propertyValue] of Object.entries(value)) {
+            if (propertyValue === null) {
+                continue;
+            }
+            result[key] = stripNullProperties(propertyValue);
+        }
+        return result;
+    }
+    return value;
+};
+/**
+ * Validates an unknown payload against the supported public GraphQL AssetFiltersInput subset.
+ *
+ * Unknown/unsupported keys are stripped; invalid values for supported fields produce an error.
+ *
+ * @param input - Unknown hash payload supplied to /goto/assets or /goto/map.
+ * @returns {ParseAssetFiltersInputResult} The stripped, validated subset or a validation error.
+ */
+const parseAssetFiltersInput = (input) => {
+    const parsed = assetFiltersInputSchema.safeParse(stripNullProperties(input));
+    if (!parsed.success) {
+        return { success: false, error: parsed.error.message };
+    }
+    return { success: true, data: parsed.data };
+};
+
+/**
+ * Map plain strings to ValueName objects (inverse of valueNameArrayOrUndefined).
+ */
+const toValueNameArray = (values) => {
+    return values.map(value => ({ name: value, value }));
+};
+/**
+ * Wrap a boolean in a boolean filter value (inverse of valueBooleanOrUndefined).
+ */
+const toBooleanFilterValue = (booleanValue) => {
+    return { booleanValue };
+};
+/**
+ * Map a number range to a min/max filter value (inverse of minMaxFilterValueToNumberRange).
+ */
+const toMinMaxFilterValue = (range) => {
+    return { min: range.min, max: range.max };
+};
+/**
+ * Converts a public GraphQL AssetFiltersInput-shaped object to Manager filter-bar values.
+ *
+ * @param input - Unknown hash payload supplied to /goto/assets or /goto/map.
+ * @returns {AssetFiltersInputToFilterBarValuesResult} A conversion result with stripped unsupported fields or validation errors for invalid supported fields.
+ */
+const convertAssetFiltersInputToFilterBarValues = (input) => {
+    const parsed = parseAssetFiltersInput(input);
+    if (!parsed.success) {
+        return { success: false, error: parsed.error };
+    }
+    const filterBarValues = {};
+    if (parsed.data.searchQuery !== undefined) {
+        filterBarValues.search = parsed.data.searchQuery;
+    }
+    if (parsed.data.assetIds !== undefined) {
+        filterBarValues.assetIds = parsed.data.assetIds;
+    }
+    if (parsed.data.siteIds !== undefined) {
+        filterBarValues.siteIds = toValueNameArray(parsed.data.siteIds);
+    }
+    if (parsed.data.groups !== undefined) {
+        filterBarValues.groups = toValueNameArray(parsed.data.groups);
+    }
+    if (parsed.data.ownerAccountIds !== undefined) {
+        filterBarValues.ownerAccountIds = toValueNameArray(parsed.data.ownerAccountIds);
+    }
+    if (parsed.data.customerIds !== undefined) {
+        filterBarValues.customerIds = toValueNameArray(parsed.data.customerIds);
+    }
+    if (parsed.data.owningDepotSiteIds !== undefined) {
+        filterBarValues.siteDepotOwnershipIds = toValueNameArray(parsed.data.owningDepotSiteIds);
+    }
+    if (parsed.data.brands !== undefined) {
+        filterBarValues.brands = parsed.data.brands;
+    }
+    if (parsed.data.types !== undefined) {
+        filterBarValues.types = parsed.data.types;
+    }
+    if (parsed.data.models !== undefined) {
+        filterBarValues.models = parsed.data.models;
+    }
+    if (parsed.data.pendingTelematicsDevices !== undefined) {
+        filterBarValues.pendingTelematicsDevices = parsed.data.pendingTelematicsDevices;
+    }
+    if (parsed.data.deviceTypes !== undefined) {
+        filterBarValues.deviceTypes = toValueNameArray(parsed.data.deviceTypes);
+    }
+    if (parsed.data.activities !== undefined) {
+        filterBarValues.activity = parsed.data.activities;
+    }
+    if (parsed.data.assetTypes !== undefined) {
+        filterBarValues.assetType = parsed.data.assetTypes;
+    }
+    if (parsed.data.criticalities !== undefined) {
+        filterBarValues.criticality = parsed.data.criticalities;
+    }
+    if (parsed.data.rentalStatuses !== undefined) {
+        filterBarValues.rentalStatuses = parsed.data.rentalStatuses;
+    }
+    if (parsed.data.siteTypes !== undefined) {
+        filterBarValues.siteType = parsed.data.siteTypes;
+    }
+    if (parsed.data.fleetHealthTypes !== undefined) {
+        filterBarValues.fleetHealthTypes = toValueNameArray(parsed.data.fleetHealthTypes);
+    }
+    if (parsed.data.fleetHealthCategories !== undefined) {
+        filterBarValues.fleetHealthCategories = toValueNameArray(parsed.data.fleetHealthCategories);
+    }
+    if (parsed.data.fleetHealthDeviceStatuses !== undefined) {
+        filterBarValues.fleetHealthStatus = toValueNameArray(parsed.data.fleetHealthDeviceStatuses);
+    }
+    if (parsed.data.accessManagementDesiredModes !== undefined) {
+        filterBarValues.accessManagementMode = parsed.data.accessManagementDesiredModes;
+    }
+    if (parsed.data.activeFilter !== undefined) {
+        filterBarValues.activeFilter = toBooleanFilterValue(parsed.data.activeFilter);
+    }
+    if (parsed.data.telematicsDeviceIsConnected !== undefined) {
+        filterBarValues.telematicsConnected = toBooleanFilterValue(parsed.data.telematicsDeviceIsConnected);
+    }
+    if (parsed.data.sustainabilityExcluded !== undefined) {
+        filterBarValues.assetVisibility = toBooleanFilterValue(parsed.data.sustainabilityExcluded);
+    }
+    if (parsed.data.area !== undefined) {
+        filterBarValues.area = parsed.data.area;
+    }
+    if (parsed.data.lastSeen !== undefined) {
+        filterBarValues.lastSeen = parsed.data.lastSeen;
+    }
+    if (parsed.data.metadataCompleteness !== undefined) {
+        filterBarValues.metadataCompleteness = { name: parsed.data.metadataCompleteness, value: parsed.data.metadataCompleteness };
+    }
+    if (parsed.data.serviceBooked !== undefined) {
+        filterBarValues.serviceBooked = parsed.data.serviceBooked;
+    }
+    if (parsed.data.servicePlanAssignments !== undefined) {
+        filterBarValues.servicePlanStatus = parsed.data.servicePlanAssignments;
+    }
+    if (parsed.data.servicePlanIds !== undefined) {
+        filterBarValues.servicePlan = toValueNameArray(parsed.data.servicePlanIds);
+    }
+    if (parsed.data.servicePlanStatuses !== undefined) {
+        filterBarValues.serviceStatus = parsed.data.servicePlanStatuses;
+    }
+    if (parsed.data.serviceProviderIds !== undefined) {
+        filterBarValues.serviceProvider = toValueNameArray(parsed.data.serviceProviderIds);
+    }
+    if (parsed.data.partnerId !== undefined) {
+        filterBarValues.partner = toValueNameArray([parsed.data.partnerId]);
+    }
+    if (parsed.data.rentalContractOrderNumbers !== undefined) {
+        filterBarValues.rentalContractOrderNumber = parsed.data.rentalContractOrderNumbers;
+    }
+    if (parsed.data.rentalContractReferenceCodes !== undefined) {
+        filterBarValues.rentalContractReferenceCode = parsed.data.rentalContractReferenceCodes;
+    }
+    if (parsed.data.rentalContractReferenceCodeDescriptionQuery !== undefined) {
+        filterBarValues.rentalContractReferenceCodeDescriptionQuery =
+            parsed.data.rentalContractReferenceCodeDescriptionQuery;
+    }
+    if (parsed.data.rentalActiveContractFilters?.onRentDatesDateRange !== undefined) {
+        filterBarValues.rentalActiveContractItemOnRentDatesDateRange =
+            parsed.data.rentalActiveContractFilters.onRentDatesDateRange;
+    }
+    if (parsed.data.rentalActiveContractFilters?.offRentDatesDateRange !== undefined) {
+        filterBarValues.rentalActiveContractItemOffRentDatesDateRange =
+            parsed.data.rentalActiveContractFilters.offRentDatesDateRange;
+    }
+    if (parsed.data.rentalActiveContractFilters?.customerExternalReferences !== undefined) {
+        filterBarValues.rentalContractCustomerExternalReference =
+            parsed.data.rentalActiveContractFilters.customerExternalReferences;
+    }
+    if (parsed.data.rentalActiveContractFilters?.customerParentExternalReferences !== undefined) {
+        filterBarValues.rentalContractCustomerParentExternalReference =
+            parsed.data.rentalActiveContractFilters.customerParentExternalReferences;
+    }
+    if (parsed.data.rentalActiveContractFilters?.customerParentNames !== undefined) {
+        filterBarValues.rentalContractCustomerParentName = parsed.data.rentalActiveContractFilters.customerParentNames;
+    }
+    if (parsed.data.insightsFilters?.fuelLevel !== undefined) {
+        filterBarValues.insightsFuelLevel = toMinMaxFilterValue(parsed.data.insightsFilters.fuelLevel);
+    }
+    if (parsed.data.insightsFilters?.afterTreatmentDieselExhaustFluidTankLevel !== undefined) {
+        filterBarValues.insightsAfterTreatmentDieselExhaustFluidTankLevel = toMinMaxFilterValue(parsed.data.insightsFilters.afterTreatmentDieselExhaustFluidTankLevel);
+    }
+    if (parsed.data.insightsFilters?.batteryPotential !== undefined) {
+        filterBarValues.insightsBatteryPotential = toMinMaxFilterValue(parsed.data.insightsFilters.batteryPotential);
+    }
+    if (parsed.data.insightsFilters?.batteryStateOfChargePercent !== undefined) {
+        filterBarValues.insightsBatteryStateOfChargePercent = toMinMaxFilterValue(parsed.data.insightsFilters.batteryStateOfChargePercent);
+    }
+    if (parsed.data.insightsFilters?.cumulativeIdleHours !== undefined) {
+        filterBarValues.insightsCumulativeIdleHours = toMinMaxFilterValue(parsed.data.insightsFilters.cumulativeIdleHours.range);
+    }
+    if (parsed.data.insightsFilters?.cumulativeOperatingHours !== undefined) {
+        filterBarValues.insightsCumulativeOperatingHours = toMinMaxFilterValue(parsed.data.insightsFilters.cumulativeOperatingHours.range);
+    }
+    if (parsed.data.insightsFilters?.batteryChargerState?.[0] !== undefined) {
+        const value = String(parsed.data.insightsFilters.batteryChargerState[0]);
+        filterBarValues.insightsBatteryChargerState = { name: value, value };
+    }
+    parsed.data.customFields?.forEach(customField => {
+        if (!customField.definitionId) {
+            return;
+        }
+        const key = `${CustomFieldPrefix}${customField.definitionId}`;
+        if (customField.stringWildcardValue !== undefined) {
+            filterBarValues[key] = customField.stringWildcardValue;
+        }
+        else if (customField.stringArrayValue !== undefined) {
+            filterBarValues[key] = customField.stringArrayValue;
+        }
+        else if (customField.numberRange !== undefined) {
+            filterBarValues[key] = { min: customField.numberRange.from, max: customField.numberRange.to };
+        }
+        else if (customField.dateRange !== undefined) {
+            filterBarValues[key] = customField.dateRange;
+        }
+        else if (customField.booleanValue !== undefined) {
+            filterBarValues[key] = toBooleanFilterValue(customField.booleanValue);
+        }
+    });
+    return { success: true, filterBarValues };
+};
+
+/**
+ * Exposes the AssetFiltersInput converter through a stable hook API.
+ *
+ * @returns {{ assetFiltersInputToFilterBarValues: (input: unknown) => AssetFiltersInputToFilterBarValuesResult }} Stable converter API.
+ */
+const useAssetFiltersInputToFilterBarValues = () => {
+    return useMemo(() => ({
+        assetFiltersInputToFilterBarValues: convertAssetFiltersInputToFilterBarValues,
+    }), []);
+};
+
 /**
  * Sort properties that require an aggregation period
  */
@@ -627,4 +993,4 @@ const useAssetQueryFilters = (props) => {
  */
 setupLibraryTranslations();
 
-export { CustomFieldPrefix, activeFilterToGraphQL, booleanValueToArray, convertToAssetSortInput, fixType, fixTypes, geoJsonSimplifiedPolygonSchema, isStringArrayValue, isValueName, isValueNameArray, minMaxFilterValueToAggregatedNumberRange, minMaxFilterValueToArray, minMaxFilterValueToNumberRange, positiveValueBooleanOrNull, stringArrayOrUndefined, useActiveAssetFilters, useAssetQueryFilters, useAssetSortInput, useCustomFieldFilters, valueBooleanOrUndefined, valueNameArrayOrUndefined, valueNameBooleanToArray, valueNameOrUndefined, valuesIfNotEmpty };
+export { CustomFieldPrefix, activeFilterToGraphQL, booleanValueToArray, convertToAssetSortInput, fixType, fixTypes, geoJsonSimplifiedPolygonSchema, isStringArrayValue, isValueName, isValueNameArray, minMaxFilterValueToAggregatedNumberRange, minMaxFilterValueToArray, minMaxFilterValueToNumberRange, positiveValueBooleanOrNull, stringArrayOrUndefined, useActiveAssetFilters, useAssetFiltersInputToFilterBarValues, useAssetQueryFilters, useAssetSortInput, useCustomFieldFilters, valueBooleanOrUndefined, valueNameArrayOrUndefined, valueNameBooleanToArray, valueNameOrUndefined, valuesIfNotEmpty };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/filters-graphql-hook",
-  "version": "2.1.48",
+  "version": "2.1.50",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {

package/src/convertAssetFiltersInputToFilterBarValues.d.ts

@@ -0,0 +1,14 @@
+export type AssetFiltersInputToFilterBarValuesResult = {
+    success: true;
+    filterBarValues: Record<string, unknown>;
+} | {
+    success: false;
+    error: string;
+};
+/**
+ * Converts a public GraphQL AssetFiltersInput-shaped object to Manager filter-bar values.
+ *
+ * @param input - Unknown hash payload supplied to /goto/assets or /goto/map.
+ * @returns {AssetFiltersInputToFilterBarValuesResult} A conversion result with stripped unsupported fields or validation errors for invalid supported fields.
+ */
+export declare const convertAssetFiltersInputToFilterBarValues: (input: unknown) => AssetFiltersInputToFilterBarValuesResult;

package/src/customFieldPrefix.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Prefix used for custom-field filter keys in the Manager filter-bar value map.
+ *
+ * Lives in its own dependency-free module so lightweight consumers (e.g. the
+ * lazily-loaded AssetFiltersInput converter) can reference the constant without
+ * pulling in the `useActiveAssetFilters` hook graph.
+ */
+export declare const CustomFieldPrefix = "cf__";

package/src/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./fixTypes";
 export * from "./useActiveAssetFilters";
+export * from "./useAssetFiltersInputToFilterBarValues";
 export * from "./useAssetQueryFilters";
 export * from "./useAssetSortInput";
 export * from "./useCustomFieldFilters";