@cobaltcore-dev/aurora 0.4.0 → 0.6.0

package/dist/client/useListWithFiltering-CbhHJO4V.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"useListWithFiltering-CbhHJO4V.mjs","names":["startTransition","useState","useListWithFiltering","defaultSortKey","defaultSortDir","sortOptions","filterSettings","initialFilterSettings","searchTerm","setSearchTerm","handleSearchChange","term","searchValue","sortSettings","setSortSettings","options","sortBy","sortDirection","handleSortChange","newSortSettings","settings","toString","setFilterSettings","handleFilterChange","newFilterSettings"],"sources":["../../src/client/utils/useListWithFiltering.ts"],"sourcesContent":["import { startTransition, useState } from \"react\"\nimport { FilterSettings, SortOption, SortSettings } from \"@/client/components/ListToolbar/types\"\n\n/**\n * Sort direction enumeration\n * Used across all sort-enabled list views\n */\nexport type SortDirection = \"asc\" | \"desc\"\n\n/**\n * Generic required sort settings with guaranteed non-optional properties\n * Used by components to maintain a fully-defined sort state\n *\n * Type parameter K is the sort key type (string literal union of allowed sort fields)\n *\n * @example\n * // For floating IPs\n * type FloatingIpListSortSettings = ListSortConfig<FloatingIpsSortKey>\n *\n * // For security groups\n * type SecurityGroupListSortSettings = ListSortConfig<\"name\" | \"project_id\">\n */\nexport type ListSortConfig<T extends string = string> = {\n  /**\n   * Array of available sort options to display in the UI\n   */\n  options: SortOption[]\n  /**\n   * The currently selected sort field (guaranteed to be one of the available options)\n   */\n  sortBy: T\n  /**\n   * The currently active sort direction (guaranteed to be either \"asc\" or \"desc\")\n   */\n  sortDirection: SortDirection\n}\n\n/**\n * Configuration options for the useListWithFiltering hook\n */\nexport interface UseListWithFilteringOptions<T extends string> {\n  /** Default sort key to use on initial render */\n  defaultSortKey: T\n  /** Default sort direction to use on initial render */\n  defaultSortDir: SortDirection\n  /** Available sort options to display in the sort dropdown */\n  sortOptions: Array<{ label: string; value: string }>\n  /** Initial filter settings configuration */\n  filterSettings: FilterSettings\n}\n\n/**\n * Return value from the useListWithFiltering hook\n */\nexport interface UseListWithFilteringReturn<T extends string> {\n  // State\n  searchTerm: string\n  sortSettings: ListSortConfig<T>\n  filterSettings: FilterSettings\n\n  // Handlers\n  handleSearchChange: (term: string | number | string[] | undefined) => void\n  handleSortChange: (newSortSettings: SortSettings) => void\n  handleFilterChange: (newFilterSettings: FilterSettings) => void\n}\n\n/**\n * Custom hook to manage common list view state: search, sort, and filter\n *\n * Extracts shared logic from list components to ensure consistent behavior\n * across all list pages and reduce code duplication.\n *\n * @example\n * ```tsx\n * const listState = useListWithFiltering({\n *   defaultSortKey: \"name\",\n *   defaultSortDir: \"asc\",\n *   sortOptions: [\n *     { label: t`Name`, value: \"name\" },\n *     { label: t`Created`, value: \"created_at\" },\n *   ],\n *   filterSettings: {\n *     filters: [\n *       { displayName: t`Status`, filterName: \"status\", values: [\"active\", \"inactive\"] }\n *     ]\n *   }\n * })\n * ```\n */\nexport function useListWithFiltering<T extends string>({\n  defaultSortKey,\n  defaultSortDir,\n  sortOptions,\n  filterSettings: initialFilterSettings,\n}: UseListWithFilteringOptions<T>): UseListWithFilteringReturn<T> {\n  // Search\n  const [searchTerm, setSearchTerm] = useState(\"\")\n  const handleSearchChange = (term: string | number | string[] | undefined) => {\n    const searchValue = typeof term === \"string\" ? term : \"\"\n    startTransition(() => setSearchTerm(searchValue))\n  }\n\n  // Sort\n  const [sortSettings, setSortSettings] = useState<ListSortConfig<T>>({\n    options: sortOptions,\n    sortBy: defaultSortKey,\n    sortDirection: defaultSortDir,\n  })\n  const handleSortChange = (newSortSettings: SortSettings) => {\n    const settings: ListSortConfig<T> = {\n      options: newSortSettings.options ?? sortSettings.options,\n      sortBy: (newSortSettings.sortBy?.toString() as T) || defaultSortKey,\n      sortDirection: (newSortSettings.sortDirection as SortDirection) || defaultSortDir,\n    }\n    setSortSettings(settings)\n  }\n\n  // Filter\n  const [filterSettings, setFilterSettings] = useState<FilterSettings>(initialFilterSettings)\n  const handleFilterChange = (newFilterSettings: FilterSettings) => {\n    startTransition(() => setFilterSettings(newFilterSettings))\n  }\n\n  return {\n    searchTerm,\n    sortSettings,\n    filterSettings,\n    handleSearchChange,\n    handleSortChange,\n    handleFilterChange,\n  }\n}\n"],"mappings":";;AAyFA,SAAgBE,EAAuC,EACrDC,mBACAC,mBACAC,gBACAC,gBAAgBC,KACe;CAE/B,IAAM,CAACC,GAAYC,KAAiBR,EAAS,GAAA,EACvCS,KAAsBC,MAAAA;EAC1B,IAAMC,IAAc,OAAOD,KAAS,WAAWA,IAAO;AACtDX,UAAsBS,EAAcG,EAAAA,CAAAA;IAIhC,CAACC,GAAcC,KAAmBb,EAA4B;EAClEc,SAASV;EACTW,QAAQb;EACRc,eAAeb;EACjB,CAAA,EACMc,KAAoBC,MAAAA;AAMxBL,IALoC;GAClCC,SAASI,EAAgBJ,WAAWF,EAAaE;GACjDC,QAAQ,EAAiBA,QAAQK,UAAAA,IAAoBlB;GACrDc,eAAe,EAAiBA,iBAAmCb;GACrE,CACgBgB;IAIZ,CAACd,GAAgBgB,KAAqBrB,EAAyBM,EAAAA;AAKrE,QAAO;EACLC;EACAK;EACAP;EACAI;EACAQ;EACAK,qBAV0BC,MAAAA;AAC1BxB,WAAsBsB,EAAkBE,EAAAA,CAAAA;;EAU1C"}