@cobaltcore-dev/aurora 0.19.0 → 0.20.0

package/dist/client/utils/useListWithFiltering.d.ts

@@ -0,0 +1,84 @@
+import { FilterSettings, SortOption, SortSettings } from '../components/ListToolbar/types';
+/**
+ * Sort direction enumeration
+ * Used across all sort-enabled list views
+ */
+export type SortDirection = "asc" | "desc";
+/**
+ * Generic required sort settings with guaranteed non-optional properties
+ * Used by components to maintain a fully-defined sort state
+ *
+ * Type parameter K is the sort key type (string literal union of allowed sort fields)
+ *
+ * @example
+ * // For floating IPs
+ * type FloatingIpListSortSettings = ListSortConfig<FloatingIpsSortKey>
+ *
+ * // For security groups
+ * type SecurityGroupListSortSettings = ListSortConfig<"name" | "project_id">
+ */
+export type ListSortConfig<T extends string = string> = {
+    /**
+     * Array of available sort options to display in the UI
+     */
+    options: SortOption[];
+    /**
+     * The currently selected sort field (guaranteed to be one of the available options)
+     */
+    sortBy: T;
+    /**
+     * The currently active sort direction (guaranteed to be either "asc" or "desc")
+     */
+    sortDirection: SortDirection;
+};
+/**
+ * Configuration options for the useListWithFiltering hook
+ */
+export interface UseListWithFilteringOptions<T extends string> {
+    /** Default sort key to use on initial render */
+    defaultSortKey: T;
+    /** Default sort direction to use on initial render */
+    defaultSortDir: SortDirection;
+    /** Available sort options to display in the sort dropdown */
+    sortOptions: Array<{
+        label: string;
+        value: string;
+    }>;
+    /** Initial filter settings configuration */
+    filterSettings: FilterSettings;
+}
+/**
+ * Return value from the useListWithFiltering hook
+ */
+export interface UseListWithFilteringReturn<T extends string> {
+    searchTerm: string;
+    sortSettings: ListSortConfig<T>;
+    filterSettings: FilterSettings;
+    handleSearchChange: (term: string | number | string[] | undefined) => void;
+    handleSortChange: (newSortSettings: SortSettings) => void;
+    handleFilterChange: (newFilterSettings: FilterSettings) => void;
+}
+/**
+ * Custom hook to manage common list view state: search, sort, and filter
+ *
+ * Extracts shared logic from list components to ensure consistent behavior
+ * across all list pages and reduce code duplication.
+ *
+ * @example
+ * ```tsx
+ * const listState = useListWithFiltering({
+ *   defaultSortKey: "name",
+ *   defaultSortDir: "asc",
+ *   sortOptions: [
+ *     { label: t`Name`, value: "name" },
+ *     { label: t`Created`, value: "created_at" },
+ *   ],
+ *   filterSettings: {
+ *     filters: [
+ *       { displayName: t`Status`, filterName: "status", values: ["active", "inactive"] }
+ *     ]
+ *   }
+ * })
+ * ```
+ */
+export declare function useListWithFiltering<T extends string>({ defaultSortKey, defaultSortDir, sortOptions, filterSettings: initialFilterSettings, }: UseListWithFilteringOptions<T>): UseListWithFilteringReturn<T>;

package/dist/client/utils/useModal.d.ts

@@ -0,0 +1,3 @@
+type UseModalReturn = [boolean, () => void];
+export declare const useModal: (initialState?: boolean) => UseModalReturn;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cobaltcore-dev/aurora",
-  "version": "0.19.0",
+  "version": "0.20.0",
   "private": false,
   "description": "Aurora OpenStack dashboard — server and client library",
   "license": "Apache-2.0",

package/dist/client/hooks-iGiEkLTp.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"hooks-iGiEkLTp.mjs","names":["useAuth","useDomainId","user","domainId","domain","id","Error"],"sources":["../../src/client/hooks/useDomainId.ts"],"sourcesContent":["import { useAuth } from \"@/client/store/AuthProvider\"\n\n/**\n * Get the current user's domain ID from the authentication context.\n *\n * This hook provides access to the domain ID of the currently authenticated user.\n * The domain ID is obtained from the user's session, not from URL parameters.\n *\n * @throws {Error} If user is not authenticated or domain ID is not available\n * @returns {string} The current domain ID from the user's session\n *\n * @example\n * ```tsx\n * function UsersList() {\n *   const domainId = useDomainId()\n *\n *   const { data } = trpc.identity.users.list.useQuery({\n *     domain_id: domainId\n *   })\n * }\n * ```\n */\nexport function useDomainId(): string {\n  const { user } = useAuth()\n\n  const domainId = user?.domain?.id\n\n  if (!domainId) {\n    throw new Error(\n      \"useDomainId() requires an authenticated user with a domain. \" +\n        \"This is likely an authentication error. \" +\n        \"Ensure the user is logged in and has a domain assigned.\"\n    )\n  }\n\n  return domainId\n}\n"],"mappings":";;;AAsBA,SAAgBC,IAAAA;CACd,IAAM,EAAEC,YAASF,EAAAA,GAEXG,IAAWD,GAAME,QAAQC;CAE/B,IAAI,CAACF,GACH,MAAUG,MACR,6JAEE;CAIN,OAAOH;AACT"}