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

package/src/Common/Hooks/useUrlFilters/useUrlFilters.ts

@@ -1,121 +0,0 @@
-import { useMemo } from 'react'
-import { useHistory, useLocation } from 'react-router-dom'
-import { DEFAULT_BASE_PAGE_SIZE, SortingOrder } from '../../Constants'
-import { DEFAULT_PAGE_NUMBER, URL_FILTER_KEYS } from './constants'
-import { UseUrlFiltersProps, UseUrlFiltersReturnType } from './types'
-
-const { PAGE_SIZE, PAGE_NUMBER, SEARCH_KEY, SORT_BY, SORT_ORDER } = URL_FILTER_KEYS
-
-/**
- * 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' })
- * ```
- *
- */
-const useUrlFilters = <T = string>({ initialSortKey }: UseUrlFiltersProps<T> = {}): UseUrlFiltersReturnType<T> => {
-    const location = useLocation()
-    const history = useHistory()
-    const searchParams = new URLSearchParams(location.search)
-
-    const { pageSize, pageNumber, searchKey, sortBy, sortOrder } = useMemo(() => {
-        const _pageSize = searchParams.get(PAGE_SIZE)
-        const _pageNumber = searchParams.get(PAGE_NUMBER)
-        const _searchKey = searchParams.get(SEARCH_KEY)
-        const _sortOrder = searchParams.get(SORT_ORDER) as SortingOrder
-        const _sortBy = searchParams.get(SORT_BY)
-
-        const sortByKey = (_sortBy || initialSortKey || '') as T
-        // Fallback to ascending order
-        const sortByOrder = Object.values(SortingOrder).includes(_sortOrder) ? _sortOrder : SortingOrder.ASC
-
-        return {
-            pageSize: Number(_pageSize) || DEFAULT_BASE_PAGE_SIZE,
-            pageNumber: Number(_pageNumber) || DEFAULT_PAGE_NUMBER,
-            searchKey: _searchKey || '',
-            sortBy: sortByKey,
-            // sort order should only be applied if the key is available
-            sortOrder: (sortByKey ? sortByOrder : '') as SortingOrder,
-        }
-    }, [searchParams])
-
-    /**
-     * Used for getting the required result from the API
-     */
-    const offset = pageSize * (pageNumber - 1)
-
-    /**
-     * Update and replace the search params in the URL.
-     *
-     * Note: Currently only primitive data types are supported
-     */
-    const _updateSearchParam = (key: string, value) => {
-        searchParams.set(key, String(value))
-        history.replace({ search: searchParams.toString() })
-    }
-
-    const _resetPageNumber = () => {
-        _updateSearchParam(PAGE_NUMBER, DEFAULT_PAGE_NUMBER)
-    }
-
-    const changePage = (page: number) => {
-        _updateSearchParam(PAGE_NUMBER, page)
-    }
-
-    const changePageSize = (_pageSize: number) => {
-        _updateSearchParam(PAGE_SIZE, _pageSize)
-        _resetPageNumber()
-    }
-
-    const handleSearch = (searchTerm: string) => {
-        _updateSearchParam(SEARCH_KEY, searchTerm)
-        _resetPageNumber()
-    }
-
-    const handleSorting = (_sortBy: T) => {
-        let order: SortingOrder
-        if (_sortBy === sortBy && sortOrder === SortingOrder.ASC) {
-            order = SortingOrder.DESC
-        } else {
-            order = SortingOrder.ASC
-        }
-
-        _updateSearchParam(SORT_BY, _sortBy)
-        _updateSearchParam(SORT_ORDER, order)
-
-        // Reset page number on sorting change
-        _resetPageNumber()
-    }
-
-    const clearFilters = () => {
-        Object.values(URL_FILTER_KEYS).forEach((key) => {
-            searchParams.delete(key)
-        })
-        history.replace({ search: searchParams.toString() })
-    }
-
-    return {
-        pageSize,
-        changePage,
-        changePageSize,
-        searchKey,
-        handleSearch,
-        offset,
-        sortBy,
-        sortOrder,
-        handleSorting,
-        clearFilters,
-    }
-}
-
-export default useUrlFilters

package/src/Common/SortableTableHeaderCell/SortableTableHeaderCell.tsx

@@ -1,44 +0,0 @@
-import { ReactComponent as SortIcon } from '../../Assets/Icon/ic-arrow-up-down.svg'
-import { ReactComponent as SortArrowDown } from '../../Assets/Icon/ic-sort-arrow-down.svg'
-import { SortingOrder } from '../Constants'
-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}
- * />
- * ```
- */
-const SortableTableHeaderCell = ({
-    isSorted,
-    triggerSorting,
-    sortOrder,
-    title,
-    disabled,
-}: SortableTableHeaderCellProps) => (
-    <button
-        type="button"
-        className="dc__transparent p-0 bcn-0 cn-7 flex dc__content-start dc__gap-4 cursor"
-        onClick={triggerSorting}
-        disabled={disabled}
-    >
-        <span className="dc__uppercase dc__ellipsis-right">{title}</span>
-        {isSorted ? (
-            <SortArrowDown
-                className={`icon-dim-12 mw-12 scn-7 ${sortOrder === SortingOrder.DESC ? 'dc__flip-180' : ''}`}
-            />
-        ) : (
-            <SortIcon className="icon-dim-12 mw-12 scn-7" />
-        )}
-    </button>
-)
-
-export default SortableTableHeaderCell

package/src/Common/SortableTableHeaderCell/index.ts

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

package/src/Common/SortableTableHeaderCell/types.ts

@@ -1,26 +0,0 @@
-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/src/Pages/GlobalConfigurations/Authorization/constants.ts

@@ -1,16 +0,0 @@
-/**
- * User Status received from the API
- */
-export enum UserStatusDto {
-    active = 'active',
-    inactive = 'inactive',
-}
-
-/**
- * User status for the frontend
- */
-export enum UserStatus {
-    active = 'active',
-    inactive = 'inactive',
-    temporary = 'temporary',
-}

package/src/Pages/GlobalConfigurations/Authorization/index.ts

@@ -1 +0,0 @@
-export * from './constants'

package/src/Pages/GlobalConfigurations/index.ts

@@ -1 +0,0 @@
-export * from './Authorization'

package/src/Pages/index.ts

@@ -1 +0,0 @@
-export * from './GlobalConfigurations'

package/src/Shared/Components/BulkSelection/BulkSelection.tsx

@@ -1,77 +0,0 @@
-import BulkSelectionDropdownItems from './BulkSelectionDropdownItems'
-import { CHECKBOX_VALUE, Checkbox, PopupMenu, noop } from '../../../Common'
-import { useBulkSelection } from './BulkSelectionProvider'
-import { BulkSelectionDropdownItemsType, BulkSelectionEvents, BulkSelectionProps } from './types'
-import { BULK_DROPDOWN_TEST_ID, BulkSelectionOptionsLabels } from './constants'
-import { ReactComponent as ICChevronDown } from '../../../Assets/Icon/ic-chevron-down.svg'
-import { ReactComponent as ICCheckSquare } from '../../../Assets/Icon/ic-check-square.svg'
-import { ReactComponent as ICCheckAll } from '../../../Assets/Icon/ic-check-all.svg'
-import { ReactComponent as ICClose } from '../../../Assets/Icon/ic-close.svg'
-
-const BulkSelection = <T,>({ showPagination }: BulkSelectionProps) => {
-    const { handleBulkSelection, selectedIdentifiers, isChecked, checkboxValue } = useBulkSelection<T>()
-    const areOptionsSelected = Object.keys(selectedIdentifiers).length > 0
-    const BulkSelectionItems: BulkSelectionDropdownItemsType[] = [
-        {
-            locator: BulkSelectionEvents.SELECT_ALL_ON_PAGE,
-            label: BulkSelectionOptionsLabels[BulkSelectionEvents.SELECT_ALL_ON_PAGE],
-            isSelected: isChecked && checkboxValue === CHECKBOX_VALUE.CHECKED,
-            icon: ICCheckSquare,
-        },
-        ...(showPagination
-            ? [
-                  {
-                      locator: BulkSelectionEvents.SELECT_ALL_ACROSS_PAGES,
-                      label: BulkSelectionOptionsLabels[BulkSelectionEvents.SELECT_ALL_ACROSS_PAGES],
-                      isSelected: isChecked && checkboxValue === CHECKBOX_VALUE.BULK_CHECKED,
-                      icon: ICCheckAll,
-                  },
-              ]
-            : []),
-        ...(areOptionsSelected
-            ? [
-                  {
-                      locator: BulkSelectionEvents.CLEAR_ALL_SELECTIONS,
-                      label: BulkSelectionOptionsLabels[BulkSelectionEvents.CLEAR_ALL_SELECTIONS],
-                      isSelected: false,
-                      icon: ICClose,
-                  },
-              ]
-            : []),
-    ]
-
-    return (
-        <PopupMenu autoClose>
-            <PopupMenu.Button
-                isKebab
-                rootClassName="h-20 flexbox p-0 dc__no-background dc__no-border dc__outline-none-imp"
-                dataTestId={BULK_DROPDOWN_TEST_ID}
-            >
-                <Checkbox
-                    isChecked={isChecked}
-                    onChange={noop}
-                    rootClassName="icon-dim-20 m-0"
-                    value={checkboxValue}
-                    // Ideally should be disabled but was giving issue with cursor
-                />
-
-                <ICChevronDown className="icon-dim-20 fcn-6 dc__no-shrink" />
-            </PopupMenu.Button>
-
-            <PopupMenu.Body rootClassName="dc__top-22 w-150 dc__right-0 pt-4 pb-4 pl-0 pr-0 bcn-0 flex column dc__content-start dc__align-start dc__position-abs bcn-0 dc__border dc__border-radius-4-imp">
-                {BulkSelectionItems.map((item) => (
-                    <BulkSelectionDropdownItems<T>
-                        key={item.locator}
-                        locator={item.locator}
-                        label={item.label}
-                        isSelected={item.isSelected}
-                        icon={item.icon}
-                        handleBulkSelection={handleBulkSelection}
-                    />
-                ))}
-            </PopupMenu.Body>
-        </PopupMenu>
-    )
-}
-
-export default BulkSelection

package/src/Shared/Components/BulkSelection/BulkSelectionDropdownItems.tsx

@@ -1,31 +0,0 @@
-import { BulkSelectionDropdownItemsProps } from './types'
-
-const BulkSelectionDropdownItems = <T,>({
-    locator,
-    label,
-    isSelected,
-    handleBulkSelection,
-    icon: Icon,
-}: BulkSelectionDropdownItemsProps<T>) => {
-    const handleSelect = () => {
-        handleBulkSelection({
-            action: locator,
-        })
-    }
-
-    return (
-        <button
-            data-testid={`bulk-action-${locator}`}
-            onClick={handleSelect}
-            className={`dc__no-border dc__outline-none-imp w-100 flexbox h-32 dc__align-items-center pt-6 pr-8 pb-6 pl-8 dc__gap-8 ${
-                isSelected ? 'cb-5 bcb-2 fs-13 fw-6 lh-20' : 'dc__no-background cn-9 fs-13 fw-4 lh-20 dc__hover-n50'
-            }`}
-            type="button"
-        >
-            <Icon className="icon-dim-16" />
-            {label}
-        </button>
-    )
-}
-
-export default BulkSelectionDropdownItems

package/src/Shared/Components/BulkSelection/BulkSelectionProvider.tsx

@@ -1,160 +0,0 @@
-import { createContext, useContext, useMemo, useState } from 'react'
-import { BULK_SELECTION_CONTEXT_ERROR, SELECT_ALL_ACROSS_PAGES_LOCATOR, getInvalidActionMessage } from './constants'
-import {
-    BulkSelectionEvents,
-    GetBulkSelectionCheckboxValuesType,
-    HandleBulkSelectionType,
-    SelectAllDialogStatus,
-    UseBulkSelectionProps,
-    UseBulkSelectionReturnType,
-} from './types'
-import { CHECKBOX_VALUE, noop } from '../../../Common'
-
-// giving type any here since not exporting this context, rather using it through useBulkSelection hook which is typed
-const BulkSelectionContext = createContext<UseBulkSelectionReturnType<any>>({
-    selectedIdentifiers: {},
-    handleBulkSelection: noop,
-    isChecked: false,
-    checkboxValue: CHECKBOX_VALUE.CHECKED,
-})
-
-export const useBulkSelection = <T,>() => {
-    const context = useContext<UseBulkSelectionReturnType<T>>(BulkSelectionContext)
-    if (!context) {
-        throw new Error(BULK_SELECTION_CONTEXT_ERROR)
-    }
-    return context
-}
-
-export const BulkSelectionProvider = <T,>({
-    children,
-    identifiers,
-    getSelectAllDialogStatus,
-}: UseBulkSelectionProps<T>) => {
-    const [selectedIdentifiers, setSelectedIdentifiers] = useState<T>({} as T)
-
-    const setIdentifiersAfterClear = (newIdentifiers: T, selectedIds: (number | string)[]) => {
-        const _newIdentifiers = JSON.parse(JSON.stringify(newIdentifiers))
-        selectedIds.forEach((id) => {
-            delete _newIdentifiers[id]
-        })
-        setSelectedIdentifiers(_newIdentifiers)
-    }
-
-    const setIdentifiersAfterPageSelection = (baseObject: T) => {
-        const _selectedIdentifiers = JSON.parse(JSON.stringify(selectedIdentifiers))
-        // removing bulk selection across pages if present
-        if (_selectedIdentifiers[SELECT_ALL_ACROSS_PAGES_LOCATOR]) {
-            delete _selectedIdentifiers[SELECT_ALL_ACROSS_PAGES_LOCATOR]
-        }
-
-        setSelectedIdentifiers({
-            ..._selectedIdentifiers,
-            ...baseObject,
-        })
-    }
-
-    const handleBulkSelection = ({ action, data }: HandleBulkSelectionType<T>) => {
-        const selectedIds = data?.identifierIds ?? []
-        const identifierObject = data?.identifierObject ?? {}
-
-        switch (action) {
-            case BulkSelectionEvents.CLEAR_ALL_SELECTIONS:
-                setSelectedIdentifiers({} as T)
-                break
-
-            case BulkSelectionEvents.CLEAR_IDENTIFIERS_AFTER_ACROSS_SELECTION: {
-                setIdentifiersAfterClear(identifiers, selectedIds)
-                break
-            }
-
-            case BulkSelectionEvents.CLEAR_IDENTIFIERS: {
-                setIdentifiersAfterClear(selectedIdentifiers, selectedIds)
-                break
-            }
-
-            case BulkSelectionEvents.SELECT_ALL_ACROSS_PAGES: {
-                if (selectedIdentifiers[SELECT_ALL_ACROSS_PAGES_LOCATOR]) {
-                    return
-                }
-                const selectedIdentifiersLength = Object.keys(selectedIdentifiers).length
-                if (selectedIdentifiersLength > 0 && getSelectAllDialogStatus() === SelectAllDialogStatus.OPEN) {
-                    return
-                }
-
-                setSelectedIdentifiers({
-                    [SELECT_ALL_ACROSS_PAGES_LOCATOR]: true,
-                } as unknown as T)
-                break
-            }
-
-            case BulkSelectionEvents.CLEAR_SELECTIONS_AND_SELECT_ALL_ACROSS_PAGES:
-                setSelectedIdentifiers({
-                    [SELECT_ALL_ACROSS_PAGES_LOCATOR]: true,
-                } as unknown as T)
-                break
-
-            case BulkSelectionEvents.SELECT_ALL_ON_PAGE: {
-                setIdentifiersAfterPageSelection(identifiers)
-                break
-            }
-
-            case BulkSelectionEvents.SELECT_IDENTIFIER: {
-                setIdentifiersAfterPageSelection(identifierObject as T)
-                break
-            }
-
-            default:
-                throw new Error(getInvalidActionMessage(action))
-        }
-    }
-
-    const getBulkSelectionCheckboxValues = (): GetBulkSelectionCheckboxValuesType => {
-        const selectedIdentifiersArray = Object.keys(selectedIdentifiers)
-        if (selectedIdentifiersArray.length === 0) {
-            return {
-                isChecked: false,
-                checkboxValue: CHECKBOX_VALUE.CHECKED,
-            }
-        }
-
-        // if selectedIdentifiers contains select all across pages locator then it means all are selected
-        if (selectedIdentifiers[SELECT_ALL_ACROSS_PAGES_LOCATOR]) {
-            return {
-                isChecked: true,
-                checkboxValue: CHECKBOX_VALUE.BULK_CHECKED,
-            }
-        }
-
-        // if all the identifiers are selected then CHECKED else intermediate
-        const areAllPresentIdentifiersSelected = Object.keys(identifiers).every(
-            (identifierId) => selectedIdentifiers[identifierId],
-        )
-
-        if (areAllPresentIdentifiersSelected) {
-            return {
-                isChecked: true,
-                checkboxValue: CHECKBOX_VALUE.CHECKED,
-            }
-        }
-
-        return {
-            isChecked: true,
-            checkboxValue: CHECKBOX_VALUE.INTERMEDIATE,
-        }
-    }
-
-    const { isChecked, checkboxValue } = getBulkSelectionCheckboxValues()
-
-    const value = useMemo(
-        () => ({
-            selectedIdentifiers,
-            handleBulkSelection,
-            isChecked,
-            checkboxValue,
-        }),
-        [selectedIdentifiers, handleBulkSelection, isChecked, checkboxValue],
-    )
-
-    return <BulkSelectionContext.Provider value={value}>{children}</BulkSelectionContext.Provider>
-}

package/src/Shared/Components/BulkSelection/constants.tsx

@@ -1,13 +0,0 @@
-import { BulkSelectionEvents } from './types'
-
-export const BULK_DROPDOWN_TEST_ID = 'bulk-selection-pop-up-menu' as const
-export const BulkSelectionOptionsLabels = {
-    [BulkSelectionEvents.SELECT_ALL_ON_PAGE]: 'All on this page',
-    [BulkSelectionEvents.SELECT_ALL_ACROSS_PAGES]: 'All across pages',
-    [BulkSelectionEvents.CLEAR_ALL_SELECTIONS]: 'Clear selection',
-} as const
-
-// Considering application can not be named as *
-export const SELECT_ALL_ACROSS_PAGES_LOCATOR = '*' as const
-export const getInvalidActionMessage = (action: string) => `Invalid action ${action} passed to useBulkSelection`
-export const BULK_SELECTION_CONTEXT_ERROR = 'useBulkSelection must be used within BulkSelectionContext'

package/src/Shared/Components/BulkSelection/index.ts

@@ -1,4 +0,0 @@
-export { default as BulkSelection } from './BulkSelection'
-export * from './BulkSelectionProvider'
-export * from './types'
-export * from './constants'

package/src/Shared/Components/BulkSelection/types.tsx

@@ -1,65 +0,0 @@
-import { CHECKBOX_VALUE } from '../../../Common'
-
-export enum BulkSelectionEvents {
-    CLEAR_ALL_SELECTIONS = 'CLEAR_ALL_SELECTIONS',
-    CLEAR_IDENTIFIERS = 'CLEAR_IDENTIFIERS',
-    SELECT_ALL_ACROSS_PAGES = 'SELECT_ALL_ACROSS_PAGES',
-    SELECT_ALL_ON_PAGE = 'SELECT_ALL_ON_PAGE',
-    SELECT_IDENTIFIER = 'SELECT_IDENTIFIER',
-    CLEAR_IDENTIFIERS_AFTER_ACROSS_SELECTION = 'CLEAR_IDENTIFIERS_AFTER_ACROSS_SELECTION',
-    CLEAR_SELECTIONS_AND_SELECT_ALL_ACROSS_PAGES = 'CLEAR_SELECTIONS_AND_SELECT_ALL_ACROSS_PAGES',
-}
-
-export interface HandleBulkSelectionType<T> {
-    action: BulkSelectionEvents
-    data?: {
-        identifierIds?: (number | string)[]
-        identifierObject?: T
-    }
-}
-
-export interface GetBulkSelectionCheckboxValuesType {
-    isChecked: boolean
-    checkboxValue: CHECKBOX_VALUE
-}
-
-export interface UseBulkSelectionReturnType<T> extends GetBulkSelectionCheckboxValuesType {
-    selectedIdentifiers: T
-    handleBulkSelection: ({ action, data }: HandleBulkSelectionType<T>) => void
-}
-
-export interface BulkSelectionProps {
-    showPagination: boolean
-}
-
-export interface BulkSelectionDropdownItemsType {
-    locator: BulkSelectionEvents
-    label: string
-    isSelected: boolean
-    icon: React.FunctionComponent<React.SVGProps<SVGSVGElement>>
-}
-
-export interface BulkSelectionDropdownItemsProps<T>
-    extends BulkSelectionDropdownItemsType,
-        Pick<UseBulkSelectionReturnType<T>, 'handleBulkSelection'> {}
-
-export enum SelectAllDialogStatus {
-    OPEN = 'OPEN',
-    CLOSED = 'CLOSED',
-}
-
-// This type is intended to be used with UseBulkSelectionProps, e.g, UseBulkSelectionProps<BulkSelectionIdentifiersType<boolean>>
-export type BulkSelectionIdentifiersType<T> = Record<string | number, T>
-
-export interface UseBulkSelectionProps<T> {
-    /**
-     * Response from API, assuming structure to be array of objects with key and values
-     * This will the given ids on current page
-     */
-    identifiers: T
-    /**
-     * Act as buffer between select all across pages and select all on page state
-     */
-    getSelectAllDialogStatus: () => SelectAllDialogStatus
-    children?: React.ReactNode
-}

package/src/Shared/Components/index.ts

@@ -1 +0,0 @@
-export * from './BulkSelection'

package/src/Shared/index.ts

@@ -1 +0,0 @@
-export * from './Components'