@devtron-labs/devtron-fe-common-lib 1.10.6 → 1.10.9

package/dist/{@common-rjsf-Csa3u0xl.js → @common-rjsf-EfnVAmc9.js}

@@ -1,7 +1,7 @@
 import { j as n, au as y, aw as k, av as W } from "./@vendor-DZHtXPTX.js";
 import V, { forwardRef as J, useMemo as P } from "react";
 import K, { getDefaultRegistry as q } from "@rjsf/core";
-import { T as F, j as N, c as v, b as S, a as Y, i as z, d as w, e as E, S as G } from "./@code-editor-DRIyM3Bp.js";
+import { T as F, j as N, c as v, b as S, a as Y, i as z, d as w, e as E, S as G } from "./@code-editor-AsGkdwLJ.js";
 import Q, { components as D } from "react-select";
 import { ReactComponent as X } from "./assets/ic-chevron-down.fc70d7a7.svg";
 import { getUiOptions as B, getTemplate as $, getSubmitButtonOptions as Z, ADDITIONAL_PROPERTY_FLAG as L, errorId as ee, englishStringTranslator as te, TranslatableString as ne, titleId as re, canExpand as se, deepEquals as ae } from "@rjsf/utils";

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

@@ -7,8 +7,22 @@ export declare const KEYBOARD_KEYS_MAP: {
     readonly E: "E";
     readonly R: "R";
     readonly K: "K";
+    readonly X: "X";
+    readonly A: "A";
     readonly Escape: "Esc";
     readonly Enter: "↩";
+    readonly ArrowLeft: "←";
+    readonly ArrowRight: "→";
+    readonly ArrowUp: "↑";
+    readonly ArrowDown: "↓";
+    readonly PageUp: "PgUp";
+    readonly PageDown: "PgDn";
+    readonly Home: "Home";
+    readonly End: "End";
+    readonly Backspace: "⌫";
+    readonly Delete: "⌦";
+    readonly '.': ".";
+    readonly Space: "Space";
 };
 export type SupportedKeyboardKeysType = keyof typeof KEYBOARD_KEYS_MAP;
 export interface ShortcutType {

package/dist/Common/Hooks/UseRegisterShortcut/utils.d.ts

@@ -1,6 +1,6 @@
 import { ShortcutType } from './types';
 export declare const preprocessKeys: (keys: ShortcutType["keys"]) => {
-    keys: ("Escape" | "Control" | "Alt" | "F" | "E" | "R" | "K" | "Shift" | "Meta" | "Enter")[];
+    keys: ("Escape" | "Control" | "Alt" | "F" | "E" | "R" | "K" | "X" | "A" | "Home" | "End" | "." | "Space" | "Shift" | "Meta" | "Enter" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "ArrowDown" | "PageUp" | "PageDown" | "Backspace" | "Delete")[];
     id: string;
 };
 export declare const verifyCallbackStack: (stack: ShortcutType["callbackStack"]) => void;

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

@@ -1,7 +1,7 @@
 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' | 'changePage' | 'changePageSize' | 'offset' | 'pageSize' | 'searchKey' | 'handleSearch'> {
+export interface UseStateFiltersReturnType<T> extends Pick<UseUrlFiltersReturnType<T>, 'sortBy' | 'sortOrder' | 'handleSorting' | 'clearFilters' | 'changePage' | 'changePageSize' | 'offset' | 'pageSize' | 'searchKey' | 'handleSearch' | 'isFilterApplied'> {
 }
 export interface PaginationType<T> extends Pick<UseUrlFiltersReturnType<T>, 'pageSize'> {
     pageNumber: number;

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

@@ -1,5 +1,5 @@
 import { SortingOrder } from '../../Constants';
-export interface UseUrlFiltersProps<T, K> {
+export interface UseUrlFiltersProps<T, K extends {}> {
     /**
      * The key on which the sorting should be applied
      */
@@ -19,8 +19,8 @@ export interface UseUrlFiltersProps<T, K> {
      */
     redirectionMethod?: 'replace' | 'push';
 }
-export type UpdateSearchParamsOptionsType<T, K = unknown> = Partial<Pick<UseUrlFiltersProps<T, K>, 'redirectionMethod'>>;
-export type UseUrlFiltersReturnType<T, K = unknown> = K & {
+export type UpdateSearchParamsOptionsType<T, K = {}> = Partial<Pick<UseUrlFiltersProps<T, K>, 'redirectionMethod'>>;
+export type UseUrlFiltersReturnType<T, K = {}> = K & {
     /**
      * Currently applied page size
      */
@@ -67,4 +67,5 @@ export type UseUrlFiltersReturnType<T, K = unknown> = K & {
      * Update the search params with the passed object
      */
     updateSearchParams: (paramsToSerialize: Partial<K>, options?: UpdateSearchParamsOptionsType<T, K>) => void;
+    isFilterApplied: boolean;
 };

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

@@ -16,5 +16,5 @@ import { UseUrlFiltersProps, UseUrlFiltersReturnType } from './types';
  * ```
  *
  */
-declare const useUrlFilters: <T = string, K = unknown>({ initialSortKey, parseSearchParams, localStorageKey, redirectionMethod, }?: UseUrlFiltersProps<T, K>) => UseUrlFiltersReturnType<T, K>;
+declare const useUrlFilters: <T = string, K = {}>({ initialSortKey, parseSearchParams, localStorageKey, redirectionMethod, }?: UseUrlFiltersProps<T, K>) => UseUrlFiltersReturnType<T, K>;
 export default useUrlFilters;

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

@@ -1 +1,2 @@
 export declare const setItemInLocalStorageIfKeyExists: (localStorageKey: string, value: string) => void;
+export declare const areAnyAdditionalFiltersApplied: (parsedParams: Record<string | number, any>) => boolean;

package/dist/Shared/Components/Button/types.d.ts

@@ -1,6 +1,6 @@
 import { TooltipProps } from '@Common/Tooltip/types';
 import { ComponentSizeType } from '../../constants';
-import { ButtonHTMLAttributes, ReactElement } from 'react';
+import { AnchorHTMLAttributes, ButtonHTMLAttributes, ReactElement } from 'react';
 import { LinkProps } from 'react-router-dom';
 export declare enum ButtonVariantType {
     primary = "primary",
@@ -18,7 +18,8 @@ export declare enum ButtonStyleType {
 }
 export declare enum ButtonComponentType {
     button = "button",
-    link = "link"
+    link = "link",
+    anchor = "anchor"
 }
 export type ButtonProps<ComponentType extends ButtonComponentType = ButtonComponentType.button> = (ComponentType extends ButtonComponentType.link ? {
     component: ButtonComponentType.link;
@@ -27,7 +28,19 @@ export type ButtonProps<ComponentType extends ButtonComponentType = ButtonCompon
      */
     linkProps: Omit<LinkProps, 'children' | 'styles' | 'className' | 'onClick'>;
     buttonProps?: never;
+    anchorProps?: never;
     onClick?: LinkProps['onClick'];
+} : ComponentType extends ButtonComponentType.anchor ? {
+    component: ButtonComponentType.anchor;
+    linkProps?: never;
+    buttonProps?: never;
+    /**
+     * Props for the anchor component
+     *
+     * Note: The target is '_blank' & rel is 'noopener noreferrer' by default.
+     */
+    anchorProps: Omit<AnchorHTMLAttributes<HTMLAnchorElement>, 'children' | 'styles' | 'className' | 'onClick'>;
+    onClick?: AnchorHTMLAttributes<HTMLAnchorElement>['onClick'];
 } : {
     /**
      * Component to be rendered from the available options
@@ -40,6 +53,7 @@ export type ButtonProps<ComponentType extends ButtonComponentType = ButtonCompon
      */
     buttonProps?: Omit<ButtonHTMLAttributes<HTMLButtonElement>, 'children' | 'styles' | 'className' | 'disabled' | 'onClick'>;
     linkProps?: never;
+    anchorProps?: never;
     onClick?: ButtonHTMLAttributes<HTMLButtonElement>['onClick'];
 }) & {
     /**

package/dist/Shared/Components/Table/BulkSelectionActionWidget.d.ts

@@ -0,0 +1,3 @@
+import { BulkSelectionActionWidgetProps } from './types';
+declare const BulkSelectionActionWidget: ({ count, handleClearBulkSelection, parentRef, BulkActionsComponent, }: BulkSelectionActionWidgetProps) => JSX.Element;
+export default BulkSelectionActionWidget;

package/dist/Shared/Components/Table/InternalTable.d.ts

@@ -0,0 +1,3 @@
+import { InternalTableProps } from './types';
+declare const InternalTable: ({ filtersVariant, filterData, rows, getRows, columns, ViewWrapper, resizableConfig, emptyStateConfig, additionalProps, areColumnsConfigurable, filter, setVisibleColumns, visibleColumns, stylesConfig, loading, bulkSelectionConfig, bulkSelectionReturnValue, handleClearBulkSelection, handleToggleBulkSelectionOnRow, paginationVariant, RowActionsOnHoverComponent, }: InternalTableProps) => JSX.Element;
+export default InternalTable;

package/dist/Shared/Components/Table/Table.component.d.ts

@@ -0,0 +1,3 @@
+import { TableProps } from './types';
+declare const TableWrapper: (tableProps: TableProps) => JSX.Element;
+export default TableWrapper;

package/dist/Shared/Components/Table/constants.d.ts

@@ -0,0 +1,7 @@
+export declare const SEARCH_SORT_CHANGE_DEBOUNCE_TIME = 350; /** in ms */
+export declare const LOCAL_STORAGE_EXISTS: boolean;
+export declare const LOCAL_STORAGE_KEY_FOR_VISIBLE_COLUMNS = "generic-table-configurable-columns";
+export declare const BULK_ACTION_GUTTER_LABEL = "bulk-action-gutter";
+export declare const EVENT_TARGET: EventTarget;
+export declare const DRAG_SELECTOR_IDENTIFIER = "table-drag-selector";
+export declare const SHIMMER_DUMMY_ARRAY: number[];

package/dist/Shared/Components/Table/index.d.ts

@@ -0,0 +1,3 @@
+export { default as Table } from './Table.component';
+export { FiltersTypeEnum, PaginationEnum, SignalEnum as TableSignalEnum } from './types';
+export type { ViewWrapperProps as TableViewWrapperProps, Column as TableColumnType, TableProps, CellComponentProps as TableCellComponentProps, } from './types';

package/dist/Shared/Components/Table/types.d.ts

@@ -0,0 +1,193 @@
+import { Dispatch, FunctionComponent, PropsWithChildren, SetStateAction } from 'react';
+import { SortableTableHeaderCellProps, useResizableTableConfig } from '../../../Common/SortableTableHeaderCell';
+import { UseStateFiltersProps, UseStateFiltersReturnType, UseUrlFiltersProps } from '../../../Common/Hooks';
+import { GenericEmptyStateType } from '../../../Common/index';
+import { GenericFilterEmptyStateProps } from '@Common/EmptyState/types';
+import { useBulkSelection, UseBulkSelectionProps } from '../BulkSelection';
+export interface UseFiltersReturnType extends UseStateFiltersReturnType<string> {
+}
+export declare enum SignalEnum {
+    ENTER_PRESSED = "enter-pressed",
+    DELETE_PRESSED = "delete-pressed",
+    ESCAPE_PRESSED = "escape-pressed",
+    OPEN_CONTEXT_MENU = "open-context-menu",
+    ROW_CLICKED = "row-clicked"
+}
+export interface SignalsType<T extends string = SignalEnum> extends Pick<EventTarget, 'addEventListener' | 'removeEventListener'> {
+    addEventListener: (type: T, callback: (event: CustomEvent) => void, options?: Parameters<EventTarget['addEventListener']>[2]) => ReturnType<EventTarget['addEventListener']>;
+    removeEventListener: (type: T, callback: (event: CustomEvent) => void, options?: Parameters<EventTarget['removeEventListener']>[2]) => ReturnType<EventTarget['removeEventListener']>;
+}
+type SizeType = {
+    /** This signifies this column is resizable */
+    range: {
+        startWidth: number;
+        minWidth: number;
+        maxWidth: number | 'infinite';
+    };
+    /** If we want a fixed width */
+    fixed?: never;
+} | {
+    range?: never;
+    fixed: number;
+} | null;
+type BaseColumnType = {
+    /** This is the key using which we will fetch the data of  */
+    field: string;
+    /** This is the string that will be displayed to the user as header text */
+    label?: string;
+    /**
+     * If we want resizable columns, then every column has to have a fixed height
+     * If we specify size to be null then the size be will set to 1fr
+     */
+    size: SizeType;
+    horizontallySticky?: boolean;
+};
+interface AdditionalProps {
+    [key: string]: unknown;
+}
+export type RowType = {
+    id: string;
+    data: Record<string, unknown>;
+};
+export type RowsType = RowType[];
+export interface CellComponentProps extends Pick<BaseColumnType, 'field'>, AdditionalProps {
+    signals: SignalsType;
+    value: unknown;
+    row: RowType;
+    filterData: UseFiltersReturnType;
+    isRowActive: boolean;
+}
+export type Column = Pick<SortableTableHeaderCellProps, 'showTippyOnTruncate'> & BaseColumnType & {
+    CellComponent?: FunctionComponent<CellComponentProps>;
+} & ({
+    isSortable: true;
+    /**
+     * Compare two rows when sorting is triggered on this column
+     * Values fed are from the field key in the row's data object
+     * @returns -1 if a < b, 0 if a === b, 1 if a > b
+     */
+    comparator?: (a: unknown, b: unknown) => number;
+} | {
+    isSortable?: false;
+    comparator?: never;
+});
+type BulkSelectionConfigType = Pick<UseBulkSelectionProps<unknown>, 'getSelectAllDialogStatus'> & {
+    /** Make sure to wrap it in useCallback */
+    onBulkSelectionChanged: (selectedRows: RowsType) => void;
+    BulkActionsComponent: FunctionComponent<{}>;
+};
+export declare enum PaginationEnum {
+    PAGINATED = "paginated",
+    INFINITE = "infinite",
+    NOT_PAGINATED = "not-paginated"
+}
+export declare enum FiltersTypeEnum {
+    STATE = "state",
+    URL = "url",
+    NONE = "none"
+}
+export interface ConfigurableColumnsType {
+    allColumns: Column[];
+    visibleColumns: Column[];
+    setVisibleColumns: Dispatch<SetStateAction<ConfigurableColumnsType['visibleColumns']>>;
+}
+interface GetRowsProps extends Pick<UseFiltersReturnType, 'offset' | 'pageSize' | 'searchKey' | 'sortBy' | 'sortOrder'> {
+}
+type AdditionalFilterPropsType<T extends Exclude<FiltersTypeEnum, FiltersTypeEnum.NONE>> = T extends FiltersTypeEnum.URL ? Pick<UseUrlFiltersProps<string, unknown>, 'parseSearchParams' | 'localStorageKey' | 'redirectionMethod' | 'initialSortKey'> : Pick<UseStateFiltersProps<string>, 'initialSortKey'>;
+export type ViewWrapperProps = PropsWithChildren<Pick<UseFiltersReturnType, 'offset' | 'handleSearch' | 'searchKey' | 'sortBy' | 'sortOrder' | 'clearFilters'> & AdditionalProps & Partial<ConfigurableColumnsType> & {
+    areRowsLoading: boolean;
+}>;
+export type InternalTableProps = Required<Pick<ConfigurableColumnsType, 'visibleColumns' | 'setVisibleColumns'>> & {
+    id: `table__${string}`;
+    loading?: boolean;
+    paginationVariant: PaginationEnum;
+    /**
+     * Memoize columns before passing as props.
+     *
+     * For columns from backend: initialize as empty array and set loading
+     * to true until API call completes.
+     */
+    columns: Column[];
+    /** If bulk selections are not a concern omit this prop */
+    bulkSelectionConfig?: BulkSelectionConfigType;
+    emptyStateConfig: {
+        noRowsConfig: Omit<GenericEmptyStateType, 'children'>;
+        noRowsForFilterConfig?: Pick<GenericFilterEmptyStateProps, 'title' | 'subTitle'> & {
+            clearFilters: () => void;
+        };
+    };
+    filterData: UseFiltersReturnType | null;
+    resizableConfig: ReturnType<typeof useResizableTableConfig> | null;
+    /**
+     * Enable this to let users choose which columns to display.
+     * Example: Resource Browser > Node Listing
+     *
+     * Using the provided id for this table, we will store the user's preference in localStorage
+     */
+    areColumnsConfigurable?: boolean;
+    additionalProps?: AdditionalProps;
+    /** Control the look of the table using this prop */
+    stylesConfig?: {
+        showSeparatorBetweenRows: boolean;
+    };
+    /**
+     * Use this component to display additional content at the end of a row when it is hovered over.
+     */
+    RowActionsOnHoverComponent?: FunctionComponent<{
+        row: RowType;
+    }>;
+    bulkSelectionReturnValue: ReturnType<typeof useBulkSelection> | null;
+    handleClearBulkSelection: () => void;
+    handleToggleBulkSelectionOnRow: (row: RowType) => void;
+    ViewWrapper?: FunctionComponent<ViewWrapperProps>;
+} & ({
+    /**
+     * Direct rows data for frontend-only datasets like resource browser.
+     */
+    rows: RowsType;
+    /**
+     * Use `getRows` function instead for data that needs to be fetched from backend with pagination/sorting/filtering.
+     */
+    getRows?: never;
+} | {
+    rows?: never;
+    /** NOTE: Sorting on frontend is only handled if rows is provided instead of getRows */
+    getRows: (props: GetRowsProps) => Promise<RowsType>;
+}) & ({
+    filtersVariant: FiltersTypeEnum.URL;
+    /**
+     * props for useUrlFilters/useStateFilters hooks
+     */
+    additionalFilterProps?: AdditionalFilterPropsType<FiltersTypeEnum.URL>;
+    /**
+     * This func is used to filter the rows based on filter data.
+     * Only applicable if filtersVariant is NOT set to NONE
+     *
+     * If filter is only being used for sorting, then send `noop` in this prop
+     */
+    filter: (row: RowType, filterData: UseFiltersReturnType) => boolean;
+} | {
+    filtersVariant: FiltersTypeEnum.STATE;
+    additionalFilterProps?: AdditionalFilterPropsType<FiltersTypeEnum.STATE>;
+    filter: (row: RowType, filterData: UseFiltersReturnType) => boolean;
+} | {
+    filtersVariant: FiltersTypeEnum.NONE;
+    additionalFilterProps?: never;
+    filter?: never;
+});
+export type UseResizableTableConfigWrapperProps = Omit<InternalTableProps, 'resizableConfig'>;
+export type TableWithBulkSelectionProps = Omit<UseResizableTableConfigWrapperProps, 'bulkSelectionReturnValue' | 'handleClearBulkSelection' | 'handleToggleBulkSelectionOnRow'>;
+export type VisibleColumnsWrapperProps = Omit<TableWithBulkSelectionProps, 'visibleColumns' | 'setVisibleColumns'>;
+export type FilterWrapperProps = Omit<VisibleColumnsWrapperProps, 'filterData'>;
+export type TableProps = Pick<FilterWrapperProps, 'additionalFilterProps' | 'bulkSelectionConfig' | 'areColumnsConfigurable' | 'emptyStateConfig' | 'filtersVariant' | 'filter' | 'additionalProps' | 'columns' | 'getRows' | 'rows' | 'paginationVariant' | 'stylesConfig' | 'id' | 'RowActionsOnHoverComponent' | 'loading' | 'ViewWrapper'>;
+export interface BulkSelectionActionWidgetProps extends Pick<BulkSelectionConfigType, 'BulkActionsComponent'> {
+    count: number;
+    handleClearBulkSelection: () => void;
+    parentRef: React.RefObject<HTMLDivElement>;
+}
+export type ConfigurableColumnsConfigType = Record<string, ConfigurableColumnsType['visibleColumns']>;
+export interface GetFilteringPromiseProps {
+    searchSortTimeoutRef: React.MutableRefObject<number>;
+    callback: () => Promise<RowsType> | RowsType;
+}
+export {};

package/dist/Shared/Components/Table/useTableWithKeyboardShortcuts.d.ts

@@ -0,0 +1,6 @@
+import { InternalTableProps, RowsType } from './types';
+declare const useTableWithKeyboardShortcuts: ({ bulkSelectionConfig, handleToggleBulkSelectionOnRow, bulkSelectionReturnValue, }: Pick<InternalTableProps, "bulkSelectionConfig" | "bulkSelectionReturnValue" | "handleToggleBulkSelectionOnRow">, visibleRows: RowsType) => {
+    activeRowIndex: number;
+    setActiveRowIndex: import('react').Dispatch<import('react').SetStateAction<number>>;
+};
+export default useTableWithKeyboardShortcuts;

package/dist/Shared/Components/Table/utils.d.ts

@@ -0,0 +1,6 @@
+import { Column, ConfigurableColumnsType, GetFilteringPromiseProps, RowsType, TableProps, UseFiltersReturnType } from './types';
+export declare const searchAndSortRows: (rows: TableProps["rows"], filter: TableProps["filter"], filterData: UseFiltersReturnType, comparator?: Column["comparator"]) => RowsType;
+export declare const getVisibleColumnsFromLocalStorage: ({ allColumns, id, }: Pick<ConfigurableColumnsType, "allColumns"> & Pick<TableProps, "id">) => Column[];
+export declare const setVisibleColumnsToLocalStorage: ({ id, visibleColumns, }: Pick<ConfigurableColumnsType, "visibleColumns"> & Pick<TableProps, "id">) => void;
+export declare const getVisibleColumns: ({ areColumnsConfigurable, columns, id, }: Pick<TableProps, "areColumnsConfigurable" | "columns" | "id">) => Column[];
+export declare const getFilteringPromise: ({ searchSortTimeoutRef, callback }: GetFilteringPromiseProps) => Promise<RowsType>;

package/dist/Shared/Components/index.d.ts

@@ -69,6 +69,7 @@ export * from './CustomInput';
 export * from './InfoBlock';
 export * from './CodeEditorWrapper';
 export * from './SSOProviderIcon';
+export * from './Table';
 export * from './Backdrop';
 export * from './CountrySelect';
 export * from './PhoneInput';