@trackunit/filters-asset-filter-definitions 2.24.10 → 2.24.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/filters-asset-filter-definitions",
-  "version": "2.24.10",
+  "version": "2.24.11",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -12,24 +12,24 @@
     "zod": "^3.25.76",
     "string-ts": "^2.0.0",
     "tailwind-merge": "^2.0.0",
-    "@trackunit/iris-app-build-utilities": "2.7.3",
-    "@trackunit/filters-filter-bar": "2.10.6",
-    "@trackunit/react-core-hooks": "1.25.3",
-    "@trackunit/react-filter-components": "2.10.6",
-    "@trackunit/react-form-components": "2.10.6",
-    "@trackunit/filters-graphql-hook": "2.23.10",
-    "@trackunit/utilization-indicator": "2.10.6",
-    "@trackunit/geo-json-utils": "1.18.3",
-    "@trackunit/react-components": "3.8.0",
-    "@trackunit/shared-utils": "1.19.3",
-    "@trackunit/translations-machine-type": "2.8.4",
-    "@trackunit/criticality-indicator": "2.10.6",
-    "@trackunit/iris-app-api": "2.9.3",
-    "@trackunit/react-core-contexts-test": "1.22.3",
-    "@trackunit/i18n-library-translation": "2.8.3",
-    "@trackunit/iris-app-runtime-core-api": "1.21.3",
-    "@trackunit/react-graphql-hooks": "2.10.6",
-    "@trackunit/translations-device": "1.22.7"
+    "@trackunit/iris-app-build-utilities": "2.7.4",
+    "@trackunit/filters-filter-bar": "2.10.7",
+    "@trackunit/react-core-hooks": "1.25.4",
+    "@trackunit/react-filter-components": "2.10.7",
+    "@trackunit/react-form-components": "2.10.7",
+    "@trackunit/filters-graphql-hook": "2.23.11",
+    "@trackunit/utilization-indicator": "2.10.7",
+    "@trackunit/geo-json-utils": "1.18.4",
+    "@trackunit/react-components": "3.8.1",
+    "@trackunit/shared-utils": "1.19.4",
+    "@trackunit/translations-machine-type": "2.8.5",
+    "@trackunit/criticality-indicator": "2.10.7",
+    "@trackunit/iris-app-api": "2.9.4",
+    "@trackunit/react-core-contexts-test": "1.22.4",
+    "@trackunit/i18n-library-translation": "2.8.4",
+    "@trackunit/iris-app-runtime-core-api": "1.21.4",
+    "@trackunit/react-graphql-hooks": "2.10.7",
+    "@trackunit/translations-device": "1.22.8"
   },
   "peerDependencies": {
     "@apollo/client": "^3.13.8",

package/src/defaultFilters/defaults/hooks/useCustomerData.d.ts

@@ -1,3 +1,4 @@
+import { FilterCustomSearch } from "@trackunit/filters-filter-bar";
 import { FilterBarValues } from "@trackunit/iris-app-runtime-core-api";
 import { GetCustomerIdSummaryQuery } from "../../../generated/graphql-api/graphql";
 /**
@@ -5,11 +6,10 @@ import { GetCustomerIdSummaryQuery } from "../../../generated/graphql-api/graphq
  *
  * @param filterValues - The current values from the filter bar.
  * @param customerId - The ID of the customer that owns the customers shown in the filter bar.
- * @returns {object} An object containing the fetched data, loading state, and a function to set search text.
+ * @returns {object} The fetched data, `loading` (only true while there are no customers yet) and the `customSearch` for the filter.
  */
 export declare const useCustomerData: (filterValues: FilterBarValues | undefined, customerId?: string) => {
     data: GetCustomerIdSummaryQuery | undefined;
     loading: boolean;
-    searchText: string;
-    setSearchText: import("react").Dispatch<import("react").SetStateAction<string>>;
+    customSearch: FilterCustomSearch;
 };

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

@@ -146,23 +146,6 @@ export declare const asSummaryConnectionNode: (node: unknown) => {
  * for a facet. `DefaultCheckboxFilter` pins the option carrying this key to the bottom of the list.
  */
 export declare const UNDEFINED_SUMMARY_KEY = "UNDEFINED";
-/**
- * Flattens connection edges into plain summary entries, appending the bucket of assets without
- * a value when one is reported.
- *
- * @param edges the edges of a key/count summary connection
- * @param missing the number of assets without a value, counted by a separate query
- * @param loading whether either query behind the facet is still fetching, which suppresses the
- *   entries until the first page arrives. The two queries resolve independently, and
- *   `FilterResults` only renders its loading state for an empty list, so without this a facet
- *   would briefly show whichever of the two landed first as its only content — the undefined
- *   bucket alone, or a set of values that the undefined bucket is about to be appended to.
- * @returns {Array<{ key: string; count: number }>} the summary entries to render as filter options
- */
-export declare const toSummaryEntries: (edges: Array<AssetSummaryConnectionEdge>, missing: number | null | undefined, loading?: boolean) => Array<{
-    key: string;
-    count: number;
-}>;
 /**
  * Reads a group summary node.
  *

package/src/defaultFilters/defaults/test/summaryConnectionTestUtils.d.ts

@@ -1,15 +1,22 @@
 import { AssetFiltersInput } from "../../../generated/graphql-api/graphql";
+declare const pageInfoMock: {
+    hasNextPage: boolean;
+    hasPreviousPage: boolean;
+    endCursor: string;
+    startCursor: string;
+};
 /**
  * Builds a mock result for a plain key/count summary connection.
  *
  * @param connectionField name of the connection field on `assetSummary`
  * @param items the summary entries to expose as edges
+ * @param pageInfo overrides for the page info, e.g. to expose a next page
  * @returns {object} the mocked query result
  */
 export declare const createSummaryConnectionMockData: (connectionField: string, items: Array<{
     key: string;
     count: number;
-}>) => {
+}>, pageInfo?: Partial<typeof pageInfoMock>) => {
     assetSummary: {
         [x: string]: Record<string, unknown>;
     };

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

@@ -0,0 +1,65 @@
+import { TypedDocumentNode } from "@graphql-typed-document-node/core";
+import { FilterCustomSearch, FilterOption, FilterViewProps } from "@trackunit/filters-filter-bar";
+import { RelayTableSupport } from "@trackunit/react-components";
+import { AssetFiltersInput } from "../../generated/graphql-api/graphql";
+import { AssetSummaryQueryShape, FacetMissingCountVariables, FleetSummaryConnectionVariables } from "./summaryConnectionTypes";
+type SummaryEntry = {
+    key: string;
+    count: number;
+};
+type FacetMissingDocument = TypedDocumentNode<AssetSummaryQueryShape, FacetMissingCountVariables>;
+type FacetConnectionSource<TData extends AssetSummaryQueryShape> = {
+    /** The generated `…SummaryConnection` query. */
+    document: TypedDocumentNode<TData, FleetSummaryConnectionVariables>;
+    /** Name of the connection field on `assetSummary`. */
+    connectionField: string;
+    /** Narrows the active filters for this facet's own queries, typically by clearing the facet's own key. */
+    scope: (activeFilters: AssetFiltersInput) => AssetFiltersInput;
+    /** Whether options carry their count. Defaults to true. */
+    showCount?: boolean;
+    /** Apollo context for both the connection and the missing count query. */
+    context?: Record<string, unknown>;
+};
+/** A facet whose nodes are plain `{ key, count }` summary entries. */
+type SummaryEntryFacet = {
+    /** Maps a summary entry to an option. The missing row arrives here too, keyed `UNDEFINED`. */
+    toOption: (entry: SummaryEntry) => FilterOption;
+    node?: never;
+    /** Adds the row of assets without a value, counted by its own query. */
+    missing?: {
+        document: FacetMissingDocument;
+    };
+};
+/** A facet whose nodes carry more than a key, such as a group or an account. */
+type CustomNodeFacet<TNode> = {
+    node: {
+        /** Reads the raw edge node, usually with one of the `as…ConnectionNode` readers. */
+        read: (node: unknown) => TNode;
+        toOption: (node: TNode) => FilterOption;
+    };
+    toOption?: never;
+    /** Adds the row of assets without a value, counted by its own query, under the given label. */
+    missing?: {
+        document: FacetMissingDocument;
+        label: string;
+    };
+};
+export type FacetConnectionConfig<TData extends AssetSummaryQueryShape, TNode> = FacetConnectionSource<TData> & (SummaryEntryFacet | CustomNodeFacet<TNode>);
+/**
+ * Everything `DefaultCheckboxFilter` needs for a facet backed by a paginated `assetSummary` connection:
+ * the shared search box, the paged options with the optional missing row, and the loading state.
+ *
+ * `loading` is only true while there is nothing to show yet, so refreshing a list on screen does not
+ * flash the loading state.
+ *
+ * @param filterState the filter state handed to the filter view
+ * @param config the facet's data source and how its nodes become options
+ * @returns {object} props to spread into `DefaultCheckboxFilter`
+ */
+export declare const useFacetConnectionOptions: <TData extends AssetSummaryQueryShape, TNode>(filterState: FilterViewProps<unknown>["filterState"], config: FacetConnectionConfig<TData, TNode>) => {
+    customSearch: FilterCustomSearch;
+    loading: boolean;
+    options: Array<FilterOption>;
+    pagination: RelayTableSupport;
+};
+export {};

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

@@ -0,0 +1,38 @@
+import { TypedDocumentNode } from "@graphql-typed-document-node/core";
+import { FilterCustomSearch, FilterOption, FilterViewProps } from "@trackunit/filters-filter-bar";
+import { AssetFiltersInput } from "../../generated/graphql-api/graphql";
+/** How many rows a limited facet fetches. A full page means there may be more, so the user is asked to search. */
+export declare const FACET_FETCH_LIMIT = 1000;
+/** The variables every limited facet summary query accepts. */
+export type FacetLimitedVariables = {
+    filters: AssetFiltersInput | null | undefined;
+    search: string | null | undefined;
+    limit: number;
+};
+/** Describes one facet backed by a summary query that returns up to {@link FACET_FETCH_LIMIT} rows. */
+export type FacetLimitedConfig<TData, TItem> = {
+    /** The generated summary query. */
+    document: TypedDocumentNode<TData, FacetLimitedVariables>;
+    /** Narrows the active filters for this facet's query, typically by clearing the facet's own key. */
+    scope: (activeFilters: AssetFiltersInput) => AssetFiltersInput;
+    /** Picks the summary rows out of the query result. */
+    read: (data: TData) => ReadonlyArray<TItem> | null | undefined;
+    /** Maps one summary row to a checkbox option. */
+    toOption: (item: TItem) => FilterOption;
+    /** Whether options carry their count. Defaults to true. */
+    showCount?: boolean;
+};
+/**
+ * Supplies a `DefaultCheckboxFilter` whose options come from one summary query capped at
+ * {@link FACET_FETCH_LIMIT} rows. The search text is sent as typed once debounced.
+ *
+ * @param filterState the filter view's state, used to resolve the active asset filters
+ * @param config which query to run and how to turn its rows into options
+ * @returns {object} props to spread onto `DefaultCheckboxFilter`; `loading` is only true while there are no options yet
+ */
+export declare const useFacetLimitedOptions: <TData, TItem>(filterState: FilterViewProps<unknown>["filterState"], config: FacetLimitedConfig<TData, TItem>) => {
+    customSearch: FilterCustomSearch;
+    loading: boolean;
+    options: Array<FilterOption>;
+    showRequestMoreUseSearch: boolean;
+};

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

@@ -0,0 +1,14 @@
+import { FilterCustomSearch, FilterOption } from "@trackunit/filters-filter-bar";
+/**
+ * Supplies a `DefaultCheckboxFilter` whose options are all fetched up front and searched locally.
+ * Matching is on the label, trimmed and case-insensitive, once the search is debounced.
+ *
+ * @param allOptions every option the facet can show
+ * @param loading whether the query behind `allOptions` is loading
+ * @returns {object} props to spread onto `DefaultCheckboxFilter`; `loading` is only true while there are no options yet
+ */
+export declare const useFacetLocalOptions: (allOptions: Array<FilterOption>, loading: boolean) => {
+    customSearch: FilterCustomSearch;
+    loading: boolean;
+    options: Array<FilterOption>;
+};

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

@@ -12,13 +12,13 @@ type UseFacetMissingCountOptions = {
  * the facet search term and outside paging, so it is identical on every page and would only be
  * re-fetched for nothing if it rode along with the paginated query.
  *
- * @param document the generated `…SummaryMissing` query
+ * @param document the generated `…SummaryMissing` query, or undefined for a facet without a missing row
  * @param connectionField name of the connection field on `assetSummary`
  * @param filters the filters scoping the summary, the same ones the paginated query uses
  * @param options optional skip flag and Apollo context
  * @returns {object} the count of assets without a value, plus loading state
  */
-export declare const useFacetMissingCount: <TData extends AssetSummaryQueryShape>(document: TypedDocumentNode<TData, FacetMissingCountVariables>, connectionField: string, filters: AssetFiltersInput | null | undefined, options?: UseFacetMissingCountOptions) => {
+export declare const useFacetMissingCount: <TData extends AssetSummaryQueryShape>(document: TypedDocumentNode<TData, FacetMissingCountVariables> | undefined, connectionField: string, filters: AssetFiltersInput | null | undefined, options?: UseFacetMissingCountOptions) => {
     missing: number | null | undefined;
     loading: boolean;
 };

package/migrations/entry.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"entry.js","sourceRoot":"","sources":["../../../../../libs/filters/asset-filter-definitions/migrations/entry.ts"],"names":[],"mappings":"","sourcesContent":["export {};\n"]}