@up42/up-components 5.7.1 → 5.8.0

package/dist/esm/types/index.d.ts

@@ -65,6 +65,7 @@ export { copyToClipboard } from './utils/helpers/copyToClipboard';
 export { formatNumber } from './utils/helpers/formatNumber';
 export { formatDate } from './utils/helpers/formatDate';
 export { formatFileSize } from './utils/helpers/formatFileSize';
+export { generateQueryKey } from './utils/helpers/generateQueryKey';
 export { useQueryParams } from './utils/hooks/useQueryParams';
 export { useRemotePagination, type PaginatedResponse } from './utils/hooks/useRemotePagination';
 export { useCursorPagination, type CursorPaginatedResponse } from './utils/hooks/useCursorPagination';

package/dist/esm/types/utils/helpers/generateQueryKey.d.ts

@@ -0,0 +1,17 @@
+type Key = string | number | Record<string, unknown> | undefined;
+type QueryKey = readonly unknown[];
+/**
+ * Generates a consistent React Query key builder for a given domain.
+ *
+ * @example
+ * const queryKey = generateQueryKey('MY_DOMAIN')
+ * useQuery(queryKey('list')) // → ['MY_DOMAIN', 'list']
+ * useQuery(queryKey('details', id)) // → ['MY_DOMAIN', 'details', id]
+ *
+ * @param domain - The root domain for the query key (e.g. 'USER', 'DASHBOARD')
+ * @returns A function that builds query keys. Undefined values are filtered out.
+ *
+ * Documentation: https://up-components.up42.com/?path=/docs/utils--docs#generatequerykey
+ */
+export declare const generateQueryKey: <Domain extends string>(domain: Exclude<Domain, "">) => (service: string, ...keys: Key[]) => QueryKey;
+export {};

package/dist/esm/types/utils/helpers/generateQueryKey.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -5678,6 +5678,23 @@ declare const formatNumber: (number: string | number, options?: Intl.NumberForma
  */
 declare const formatFileSize: (value: number) => string;
 
+type Key = string | number | Record<string, unknown> | undefined;
+type QueryKey = readonly unknown[];
+/**
+ * Generates a consistent React Query key builder for a given domain.
+ *
+ * @example
+ * const queryKey = generateQueryKey('MY_DOMAIN')
+ * useQuery(queryKey('list')) // → ['MY_DOMAIN', 'list']
+ * useQuery(queryKey('details', id)) // → ['MY_DOMAIN', 'details', id]
+ *
+ * @param domain - The root domain for the query key (e.g. 'USER', 'DASHBOARD')
+ * @returns A function that builds query keys. Undefined values are filtered out.
+ *
+ * Documentation: https://up-components.up42.com/?path=/docs/utils--docs#generatequerykey
+ */
+declare const generateQueryKey: <Domain extends string>(domain: Exclude<Domain, "">) => (service: string, ...keys: Key[]) => QueryKey;
+
 /**
  * Returns query parameter values from a string or an array of strings.
  *
@@ -5842,5 +5859,5 @@ type ContextState = {
  */
 declare const useAlert: () => ContextState;
 
-export { Alert, Avatar, Badge, Banner, Button, Checkbox, CodeBlock, CodeInline, CodeSnippet, ContactBox, ControlButton, CopyButton, DataGrid, DateTime, Divider, DocumentationPopover, EditTagsButton, EmptyState, FeatureCard, FeatureCardHeader, FeatureCardHeaderActions, FeatureFlagCheckbox, FormCheckbox, FormDatePicker, FormDateRangePicker, FormDateRangePickerList, FormDateTimePicker, FormInput, FormRadio, FormSelect, FormSwitch, GridContainer, GridItem, Icon, Illustration, InfoCard, InfoModal, InfoPopover, Input, Link, Loading, Logo, NotFound, PageContainer, PageHeader, Popover, Radio, Select, Slider, StatusLight, Switch, Tab, TabGroup, Table, TableBody, TableCell, TableContainer, TableFooter, TableHead, TablePagination, TableRow, TableSortLabel, Tabs, Tag, TagsList, ToggleButton, Typography, UpComponentsProvider, capitalize, copyToClipboard, formatDate, formatFileSize, formatNumber, theme, useAlert, useCursorPagination, useDebounce, useQueryParams, useRemotePagination, useToggle };
+export { Alert, Avatar, Badge, Banner, Button, Checkbox, CodeBlock, CodeInline, CodeSnippet, ContactBox, ControlButton, CopyButton, DataGrid, DateTime, Divider, DocumentationPopover, EditTagsButton, EmptyState, FeatureCard, FeatureCardHeader, FeatureCardHeaderActions, FeatureFlagCheckbox, FormCheckbox, FormDatePicker, FormDateRangePicker, FormDateRangePickerList, FormDateTimePicker, FormInput, FormRadio, FormSelect, FormSwitch, GridContainer, GridItem, Icon, Illustration, InfoCard, InfoModal, InfoPopover, Input, Link, Loading, Logo, NotFound, PageContainer, PageHeader, Popover, Radio, Select, Slider, StatusLight, Switch, Tab, TabGroup, Table, TableBody, TableCell, TableContainer, TableFooter, TableHead, TablePagination, TableRow, TableSortLabel, Tabs, Tag, TagsList, ToggleButton, Typography, UpComponentsProvider, capitalize, copyToClipboard, formatDate, formatFileSize, formatNumber, generateQueryKey, theme, useAlert, useCursorPagination, useDebounce, useQueryParams, useRemotePagination, useToggle };
 export type { AlertProps, AvatarProps, BadgeProps, BannerProps, ButtonProps, CheckboxProps, CodeBlockProps, CodeInlineProps, CodeSnippetItemProps, CodeSnippetProps, ContactBoxProps, ControlButtonProps, CopyButtonProps, CreateAlertProps, CreateSnackbarProps, CursorPaginatedResponse, DatePickerDateType, DateRange, DateTimeProps, DividerProps, DocumentationPopoverProps, EditTagsButtonProps, EmptyStateProps, FeatureCardHeaderActionsProps, FeatureCardHeaderProps, FeatureCardProps, FeatureFlagCheckboxProps, FormCheckboxProps, FormDatePickerProps, FormDateRangePickerListProps, FormDateRangePickerProps, FormDateTimePickerProps, FormInputProps, FormRadioProps, FormSelectProps, FormSwitchProps, GridContainerProps, GridItemProps, IconAction, IconProps$1 as IconProps, IllustrationProps, InfoCardProps, InfoModalProps, InfoPopoverProps, InputProps, LinkProps, LoadingProps, LogoProps, MenuAction, NotFoundProps, PageContainerProps, PageHeaderProps, PaginatedResponse, PopoverProps, RadioProps, SelectProps, SliderProps, StatusLightProps, SwitchProps, TabGroupProps, TabProps, TableBodyProps, TableCellProps, TableContainerProps, TableFooterProps, TableHeadProps, TablePaginationProps, TableProps, TableRowProps, TableSortLabelProps, TabsProps, TagItem, TagProps, TagsListProps, ToggleButtonProps, TypographyProps, UseToggleResult };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@up42/up-components",
-  "version": "5.7.1",
+  "version": "5.8.0",
   "description": "UP42 Component Library",
   "author": "Axel Fuhrmann axel.fuhrmann@up42.com",
   "license": "ISC",