@devtron-labs/devtron-fe-common-lib 0.0.58-beta-6 → 0.0.58-beta-7

package/src/Shared/validations.tsx

@@ -0,0 +1,72 @@
+export interface ValidationResponseType {
+    isValid: boolean
+    message?: string
+}
+
+export const validateName = (name: string): ValidationResponseType => {
+    if (!/^.{3,50}$/.test(name)) {
+        return {
+            isValid: false,
+            message: 'Minimum 3 and maximum 50 characters allowed',
+        }
+    }
+
+    if (!/^[a-z0-9-._]+$/.test(name)) {
+        return {
+            isValid: false,
+            message: 'Only lowercase alphanumeric characters, -, _ or . allowed',
+        }
+    }
+
+    if (!/^(?![-._]).*[^-._]$/.test(name)) {
+        return {
+            isValid: false,
+            message: 'Cannot start/end with -, _ or .',
+        }
+    }
+
+    return {
+        isValid: true,
+    }
+}
+
+export const validateDescription = (description: string): ValidationResponseType => {
+    if (description?.length > 300) {
+        return {
+            isValid: false,
+            message: 'Maximum 300 characters are allowed',
+        }
+    }
+
+    return {
+        isValid: true,
+    }
+}
+
+export const validateRequiredPositiveNumber = (value: string | Number): ValidationResponseType => {
+    if (!value) {
+        return {
+            isValid: false,
+            message: 'This field is required',
+        }
+    }
+
+    // TODO: Look if regex is available for this, since 0002 is not a valid number
+    if (!/^\d+(\.\d+)?$/.test(value.toString())) {
+        return {
+            isValid: false,
+            message: 'This field should be a valid positive number',
+        }
+    }
+
+    if (Number(value) <= 0) {
+        return {
+            isValid: false,
+            message: 'Only positive numbers are allowed',
+        }
+    }
+
+    return {
+        isValid: true,
+    }
+}

package/src/index.ts

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

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

@@ -1,8 +0,0 @@
-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

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

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

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

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

@@ -1,32 +0,0 @@
-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

@@ -1,18 +0,0 @@
-/// <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

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

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

@@ -1,8 +0,0 @@
-import { SortingOrder } from '../Constants';
-export interface SortableTableHeaderCellProps {
-    isSorted: boolean;
-    triggerSorting: () => void;
-    sortOrder: SortingOrder;
-    title: string;
-    disabled: boolean;
-}

package/src/Assets/Icon/ic-arrow-up-down.svg

@@ -1,3 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="12" height="12" viewBox="0 0 12 12" fill="none">
-  <path d="M4.125 8.5L6 10.75L7.875 8.5M4.125 3.5L6 1.25L7.875 3.5" stroke="#3B444C" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"/>
-</svg>

package/src/Assets/Icon/ic-sort-arrow-down.svg

@@ -1,3 +0,0 @@
-<svg width="12" height="12" viewBox="0 0 12 12" fill="none" xmlns="http://www.w3.org/2000/svg">
-<path d="M3.5 7.50009L6.00004 10.0001M6.00004 10.0001L8.5 7.50054M6.00004 10.0001V2" stroke="#596168" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"/>
-</svg>

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

@@ -1,9 +0,0 @@
-export const DEFAULT_PAGE_NUMBER = 1
-
-export const URL_FILTER_KEYS = {
-    PAGE_SIZE: 'pageSize',
-    PAGE_NUMBER: 'pageNumber',
-    SEARCH_KEY: 'searchKey',
-    SORT_BY: 'sortBy',
-    SORT_ORDER: 'sortOrder',
-} as const

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

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

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

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

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

@@ -1,120 +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 } 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> = {}) => {
-    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)
-    }
-
-    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,9 +0,0 @@
-import { SortingOrder } from '../Constants'
-
-export interface SortableTableHeaderCellProps {
-    isSorted: boolean
-    triggerSorting: () => void
-    sortOrder: SortingOrder
-    title: string
-    disabled: boolean
-}