@devtron-labs/devtron-fe-common-lib 0.0.58-beta-8 → 0.0.58-beta-9

package/dist/Common/Api.d.ts

@@ -1,5 +1,14 @@
 import { ResponseType, APIOptions } from './Types';
+import { MutableRefObject } from 'react';
 export declare const post: (url: string, data: object, options?: APIOptions, isMultipartRequest?: boolean) => Promise<ResponseType>;
 export declare const put: (url: string, data: object, options?: APIOptions) => Promise<ResponseType>;
 export declare const get: (url: string, options?: APIOptions) => Promise<ResponseType>;
 export declare const trash: (url: string, data?: object, options?: APIOptions) => Promise<ResponseType>;
+/**
+ * Aborts the previous request before triggering next request
+ */
+export declare const abortPreviousRequests: <T>(callback: () => Promise<T>, abortControllerRef: MutableRefObject<AbortController>) => Promise<T>;
+/**
+ * Returns true if the error is due to a aborted request
+ */
+export declare const getIsRequestAborted: (error: any) => boolean;

package/dist/Common/Constants.d.ts

@@ -21,7 +21,6 @@ export declare const ROUTES: {
     IMAGE_TAGGING: string;
     CD_MATERIAL_GET: string;
     DEPLOYMENT_TEMPLATE_LIST: string;
-    INFRA_CONFIG_PROFILE: string;
 };
 export declare enum KEY_VALUE {
     KEY = "key",
@@ -74,3 +73,17 @@ export declare const SELECTED_APPROVAL_TAB_STATE: {
     APPROVAL: string;
     PENDING: string;
 };
+export declare enum SortingOrder {
+    /**
+     * Ascending order
+     */
+    ASC = "ASC",
+    /**
+     * Descending order
+     */
+    DESC = "DESC"
+}
+/**
+ * Base page size for pagination
+ */
+export declare const DEFAULT_BASE_PAGE_SIZE = 20;

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

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

package/dist/Common/Hooks/useUrlFilters/constants.d.ts

@@ -0,0 +1,8 @@
+export declare const DEFAULT_PAGE_NUMBER = 1;
+export declare const URL_FILTER_KEYS: {
+    readonly PAGE_SIZE: "pageSize";
+    readonly PAGE_NUMBER: "pageNumber";
+    readonly SEARCH_KEY: "searchKey";
+    readonly SORT_BY: "sortBy";
+    readonly SORT_ORDER: "sortOrder";
+};

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

@@ -0,0 +1,2 @@
+export { default as useUrlFilters } from './useUrlFilters';
+export type { UseUrlFiltersProps } from './types';

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

@@ -0,0 +1,6 @@
+export interface UseUrlFiltersProps<T> {
+    /**
+     * The key on which the sorting should be applied
+     */
+    initialSortKey?: T;
+}

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

@@ -0,0 +1,32 @@
+import { SortingOrder } from '../../Constants';
+import { UseUrlFiltersProps } from './types';
+/**
+ * Generic hook for implementing URL based filters.
+ * eg: pagination, search, sort.
+ *
+ * The exposed handlers can be consumed directly without the need for explicit state management
+ *
+ * @example Default Usage:
+ * ```tsx
+ * const { pageSize, changePage, ...rest } = useUrlFilters()
+ * ```
+ *
+ * @example Usage with custom type for sort keys and initial sort key:
+ * ```tsx
+ * const  { sortBy, sortOrder } = useUrlFilters<'email' | 'name'>({ initialSortKey: 'email' })
+ * ```
+ *
+ */
+declare const useUrlFilters: <T = string>({ initialSortKey }?: UseUrlFiltersProps<T>) => {
+    pageSize: number;
+    changePage: (page: number) => void;
+    changePageSize: (_pageSize: number) => void;
+    searchKey: string;
+    handleSearch: (searchTerm: string) => void;
+    offset: number;
+    sortBy: T;
+    sortOrder: SortingOrder;
+    handleSorting: (_sortBy: T) => void;
+    clearFilters: () => void;
+};
+export default useUrlFilters;

package/dist/Common/SortableTableHeaderCell/SortableTableHeaderCell.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="react" />
+import { SortableTableHeaderCellProps } from './types';
+/**
+ * Reusable component for the table header cell with support for sorting icons
+ *
+ * @example Usage
+ * ```tsx
+ * <SortableTableHeaderCell
+ *   isSorted={currentSortedCell === 'cell'}
+ *   triggerSorting={() => {}}
+ *   sortOrder={SortingOrder.ASC}
+ *   title="Header Cell"
+ *   disabled={isDisabled}
+ * />
+ * ```
+ */
+declare const SortableTableHeaderCell: ({ isSorted, triggerSorting, sortOrder, title, disabled, }: SortableTableHeaderCellProps) => JSX.Element;
+export default SortableTableHeaderCell;

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

@@ -0,0 +1,2 @@
+export { default as SortableTableHeaderCell } from './SortableTableHeaderCell';
+export type { SortableTableHeaderCellProps } from './types';

package/dist/Common/SortableTableHeaderCell/types.d.ts

@@ -0,0 +1,25 @@
+import { SortingOrder } from '../Constants';
+export interface SortableTableHeaderCellProps {
+    /**
+     * If true, the cell is sorted
+     */
+    isSorted: boolean;
+    /**
+     * Callback for handling the sorting of the cell
+     */
+    triggerSorting: () => void;
+    /**
+     * Current sort order
+     *
+     * Note: On click, the sort order should be updated as required
+     */
+    sortOrder: SortingOrder;
+    /**
+     * Label for the cell
+     */
+    title: string;
+    /**
+     * If true, the cell is disabled
+     */
+    disabled: boolean;
+}

package/dist/Common/Types.d.ts

@@ -1,7 +1,7 @@
 import React, { ReactNode, CSSProperties } from 'react';
 import { Placement } from 'tippy.js';
 import { ImageComment, ReleaseTag } from './ImageTags.Types';
-import { DockerConfigOverrideType, TaskErrorObj } from '.';
+import { DockerConfigOverrideType, SortingOrder, TaskErrorObj } from '.';
 /**
  * Generic response type object with support for overriding the result type
  *
@@ -44,13 +44,12 @@ export interface Teams {
 }
 export declare enum CHECKBOX_VALUE {
     CHECKED = "CHECKED",
-    INTERMEDIATE = "INTERMEDIATE",
-    BULK_CHECKED = "BULK_CHECKED"
+    INTERMEDIATE = "INTERMEDIATE"
 }
 export interface CheckboxProps {
     onChange: (event: any) => void;
     isChecked: boolean;
-    value: 'CHECKED' | 'INTERMEDIATE' | 'BULK_CHECKED';
+    value: 'CHECKED' | 'INTERMEDIATE';
     disabled?: boolean;
     tabIndex?: number;
     rootClassName?: string;
@@ -689,4 +688,16 @@ export interface EdgeNodeType {
 export interface EdgeEndNodeType extends EdgeNodeType {
     userApprovalConfig?: UserApprovalConfigType;
 }
+/**
+ * Search params for sorting configuration
+ *
+ * Note: Either both sortOrder and sortBy are required or none
+ */
+export type SortingParams<T = string> = {
+    sortOrder: SortingOrder;
+    sortBy: T;
+} | {
+    sortOrder?: never;
+    sortBy?: never;
+};
 export {};

package/dist/Common/index.d.ts

@@ -27,6 +27,7 @@ export * from './Checkbox';
 export { default as EmptyState } from './EmptyState/EmptyState';
 export { default as GenericEmptyState } from './EmptyState/GenericEmptyState';
 export * from './SearchBar';
+export * from './SortableTableHeaderCell';
 export { default as Toggle } from './Toggle/Toggle';
 export { default as ScanVulnerabilitiesTable } from './Security/ScanVulnerabilitiesTable';
 export { default as StyledRadioGroup } from './RadioGroup/RadioGroup';

package/dist/index.d.ts

@@ -1,3 +1 @@
-export * from './Common';
-export * from './Pages';
-export * from './Shared';
+export * from "./Common";