@devtron-labs/devtron-fe-common-lib 0.0.82-beta-2 → 0.0.82-beta-3

package/dist/Common/Helper.d.ts

@@ -86,4 +86,5 @@ export declare const compareObjectLength: (objA: any, objB: any) => boolean;
  * Return deep copy of the object
  */
 export declare function deepEqual(configA: any, configB: any): boolean;
+export declare const prefixZeroIfSingleDigit: (value?: number) => string | number;
 export {};

package/dist/Common/Hooks/index.d.ts

@@ -3,3 +3,4 @@ export { useClickOutside } from './UseClickOutside/UseClickOutside';
 export { useWindowSize } from './UseWindowSize/UseWindowSize';
 export * from './useUrlFilters';
 export * from './UseRegisterShortcut';
+export * from './useStateFilters';

package/dist/Common/Hooks/useStateFilters/index.d.ts

@@ -0,0 +1,2 @@
+export { default as useStateFilters } from './useStateFilters';
+export type { UseStateFiltersProps, UseStateFiltersReturnType } from './types';

package/dist/Common/Hooks/useStateFilters/types.d.ts

@@ -0,0 +1,6 @@
+import { UseUrlFiltersProps, UseUrlFiltersReturnType } from '../useUrlFilters';
+
+export interface UseStateFiltersProps<T> extends Pick<UseUrlFiltersProps<T, never>, 'initialSortKey'> {
+}
+export interface UseStateFiltersReturnType<T> extends Pick<UseUrlFiltersReturnType<T>, 'sortBy' | 'sortOrder' | 'handleSorting' | 'clearFilters'> {
+}

package/dist/Common/Hooks/useStateFilters/useStateFilters.d.ts

@@ -0,0 +1,17 @@
+import { UseStateFiltersProps, UseStateFiltersReturnType } from './types';
+
+/**
+ * Generic hook for implementing state based pagination, search, sorting.
+ * Sister method of [useUrlFilters](https://github.com/devtron-labs/devtron-fe-common-lib/blob/main/src/Common/Hooks/useUrlFilters/useUrlFilters.ts)
+ *
+ * The exposed handlers can be consumed directly without the need for explicit state management
+ *
+ * @example Usage with custom type for sort keys and initial sort key:
+ * ```tsx
+ * const  { sortBy, sortOrder } = useUrlFilters<'email' | 'name'>({ initialSortKey: 'email' })
+ * ```
+ *
+ * To be extended to be used with pagination and search as and when required
+ */
+declare const useStateFilters: <T = string>({ initialSortKey, }?: UseStateFiltersProps<T>) => UseStateFiltersReturnType<T>;
+export default useStateFilters;

package/dist/Shared/Helpers.d.ts

@@ -1,5 +1,5 @@
 import { GitTriggers, WebhookEventNameType } from './types';
-import { MaterialInfo } from '../Common';
+import { MaterialInfo, SortingOrder } from '../Common';
 
 interface HighlightSearchTextProps {
     /**
@@ -19,7 +19,8 @@ export declare const highlightSearchText: ({ searchText, text, highlightClasses
 export declare const preventBodyScroll: (lock: boolean) => void;
 export declare const getIsMaterialInfoAvailable: (materialInfo: MaterialInfo[]) => boolean;
 export declare const getGitCommitInfo: (materialInfo: MaterialInfo) => GitTriggers;
-export declare const caseInsensitiveStringComparator: (a: string, b: string) => number;
+export declare const stringComparatorBySortOrder: (a: string, b: string, sortOrder?: SortingOrder, isCaseSensitive?: boolean) => number;
+export declare const numberComparatorBySortOrder: (a: number, b: number, sortOrder?: SortingOrder) => number;
 export declare const getWebhookEventIcon: (eventName: WebhookEventNameType) => JSX.Element;
 export declare const isNullOrUndefined: (value: unknown) => boolean;
 export {};