@devtron-labs/devtron-fe-common-lib 0.0.63-beta-2 → 0.0.63-beta-4

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

@@ -1,4 +1,4 @@
-export { useSuperAdmin } from './UseSuperAdmin/UseSuperAdmin';
-export { useClickOutside } from './UseClickOutside/UseClickOutside';
-export { useWindowSize } from './UseWindowSize/UseWindowSize';
-export * from './useUrlFilters';
+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

@@ -1,8 +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";
-};
+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 +1,2 @@
-export { default as useUrlFilters } from './useUrlFilters';
-export type { UseUrlFiltersProps } from './types';
+export { default as useUrlFilters } from './useUrlFilters';
+export type { UseUrlFiltersProps, UseUrlFiltersReturnType } from './types';

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

@@ -1,6 +1,59 @@
-export interface UseUrlFiltersProps<T> {
-    /**
-     * The key on which the sorting should be applied
-     */
-    initialSortKey?: T;
-}
+import { SortingOrder } from '../../Constants';
+export interface UseUrlFiltersProps<T, K> {
+    /**
+     * The key on which the sorting should be applied
+     */
+    initialSortKey?: T;
+    /**
+     * Callback function for parsing the search params
+     */
+    parseSearchParams?: (searchParams: URLSearchParams) => K;
+}
+export type UseUrlFiltersReturnType<T, K = unknown> = K & {
+    /**
+     * Currently applied page size
+     */
+    pageSize: number;
+    /**
+     * Handler for updating the current page
+     */
+    changePage: (pageNumber: number) => void;
+    /**
+     * Handler for updating the current page size
+     */
+    changePageSize: (pageSize: number) => void;
+    /**
+     * Current search key
+     */
+    searchKey: string;
+    /**
+     * Handler for updating the search
+     */
+    handleSearch: (searchKey: string) => void;
+    /**
+     * Computed offset using the pageSize and pageNumber
+     *
+     * Note: Used in pagination component
+     */
+    offset: number;
+    /**
+     * Key on which the sorting is applied
+     */
+    sortBy: T;
+    /**
+     * Current sort order
+     */
+    sortOrder: SortingOrder;
+    /**
+     * Handle the sorting type change / key change
+     */
+    handleSorting: (sortBy: T) => void;
+    /**
+     * Clear all the applied filters
+     */
+    clearFilters: () => void;
+    /**
+     * Update the search params with the passed object
+     */
+    updateSearchParams: (paramsToSerialize: K) => void;
+};

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

@@ -1,32 +1,20 @@
-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;
+import { UseUrlFiltersProps, UseUrlFiltersReturnType } 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, K = unknown>({ initialSortKey, parseSearchParams, }?: UseUrlFiltersProps<T, K>) => UseUrlFiltersReturnType<T, K>;
+export default useUrlFilters;

package/dist/Common/ImageTags.Types.d.ts

@@ -1,40 +1,40 @@
-export interface ReleaseTag {
-    id: number;
-    tagName: string;
-    appId: number;
-    deleted: boolean;
-    artifactId: number;
-    duplicateTag: boolean;
-}
-export interface ImageComment {
-    id: number;
-    comment: string;
-    artifactId: number;
-}
-export interface ImageTaggingContainerType {
-    ciPipelineId?: number;
-    artifactId?: number;
-    imageComment?: ImageComment;
-    imageReleaseTags?: ReleaseTag[];
-    updateCurrentAppMaterial?: (matId: number, releaseTags?: ReleaseTag[], imageComment?: ImageComment) => void;
-    appReleaseTagNames?: string[];
-    tagsEditable?: boolean;
-    forceReInit?: boolean;
-    setAppReleaseTagNames?: (appReleaseTags: string[]) => void;
-    setTagsEditable?: (tagsEditable: boolean) => void;
-    toggleCardMode?: (id: number) => void;
-    hideHardDelete?: boolean;
-    isSuperAdmin?: boolean;
-}
-export interface ImageButtonType {
-    text: string;
-    isSoftDeleted: boolean;
-    isEditing: boolean;
-    onSoftDeleteClick?: any;
-    onHardDeleteClick?: any;
-    tagId: number;
-    softDeleteTags: any;
-    isSuperAdmin: any;
-    duplicateTag?: boolean;
-    hideHardDelete?: boolean;
-}
+export interface ReleaseTag {
+    id: number;
+    tagName: string;
+    appId: number;
+    deleted: boolean;
+    artifactId: number;
+    duplicateTag: boolean;
+}
+export interface ImageComment {
+    id: number;
+    comment: string;
+    artifactId: number;
+}
+export interface ImageTaggingContainerType {
+    ciPipelineId?: number;
+    artifactId?: number;
+    imageComment?: ImageComment;
+    imageReleaseTags?: ReleaseTag[];
+    updateCurrentAppMaterial?: (matId: number, releaseTags?: ReleaseTag[], imageComment?: ImageComment) => void;
+    appReleaseTagNames?: string[];
+    tagsEditable?: boolean;
+    forceReInit?: boolean;
+    setAppReleaseTagNames?: (appReleaseTags: string[]) => void;
+    setTagsEditable?: (tagsEditable: boolean) => void;
+    toggleCardMode?: (id: number) => void;
+    hideHardDelete?: boolean;
+    isSuperAdmin?: boolean;
+}
+export interface ImageButtonType {
+    text: string;
+    isSoftDeleted: boolean;
+    isEditing: boolean;
+    onSoftDeleteClick?: any;
+    onHardDeleteClick?: any;
+    tagId: number;
+    softDeleteTags: any;
+    isSuperAdmin: any;
+    duplicateTag?: boolean;
+    hideHardDelete?: boolean;
+}

package/dist/Common/ImageTags.d.ts

@@ -1,3 +1,4 @@
-import { ImageButtonType, ImageTaggingContainerType } from './ImageTags.Types';
-export declare const ImageTagsContainer: ({ ciPipelineId, artifactId, imageComment, imageReleaseTags, updateCurrentAppMaterial, appReleaseTagNames, setAppReleaseTagNames, tagsEditable, setTagsEditable, toggleCardMode, hideHardDelete, forceReInit, isSuperAdmin, }: ImageTaggingContainerType) => JSX.Element;
-export declare const ImageTagButton: ({ text, isSoftDeleted, isEditing, onSoftDeleteClick, onHardDeleteClick, tagId, softDeleteTags, isSuperAdmin, duplicateTag, hideHardDelete, }: ImageButtonType) => JSX.Element;
+/// <reference types="react" />
+import { ImageButtonType, ImageTaggingContainerType } from './ImageTags.Types';
+export declare const ImageTagsContainer: ({ ciPipelineId, artifactId, imageComment, imageReleaseTags, updateCurrentAppMaterial, appReleaseTagNames, setAppReleaseTagNames, tagsEditable, setTagsEditable, toggleCardMode, hideHardDelete, forceReInit, isSuperAdmin }: ImageTaggingContainerType) => JSX.Element;
+export declare const ImageTagButton: ({ text, isSoftDeleted, isEditing, onSoftDeleteClick, onHardDeleteClick, tagId, softDeleteTags, isSuperAdmin, duplicateTag, hideHardDelete, }: ImageButtonType) => JSX.Element;

package/dist/Common/InfoColorBar/InfoColourbar.d.ts

@@ -1,3 +1,5 @@
-import { InfoColourBarType } from '../Types';
-declare const InfoColourBar: ({ message, classname, Icon, iconClass, iconSize, renderActionButton, linkText, redirectLink, linkOnClick, linkClass, internalLink, styles, }: InfoColourBarType) => JSX.Element;
-export default InfoColourBar;
+/// <reference types="react" />
+import { InfoColourBarType } from '../Types';
+import './infoColourBar.scss';
+declare function InfoColourBar({ message, classname, Icon, iconClass, iconSize, renderActionButton, linkText, redirectLink, linkOnClick, linkClass, internalLink, styles, }: InfoColourBarType): JSX.Element;
+export default InfoColourBar;

package/dist/Common/Modals/Modal.d.ts

@@ -1,3 +1,3 @@
-import React from 'react';
-import { ModalType } from '../Types';
-export declare const Modal: ({ style, children, modal, rootClassName, onClick, callbackRef, preventWheelDisable, noBackDrop, }: ModalType) => React.ReactPortal;
+import React from 'react';
+import { ModalType } from '../Types';
+export declare const Modal: ({ style, children, modal, rootClassName, onClick, callbackRef, preventWheelDisable, noBackDrop, }: ModalType) => React.ReactPortal;

package/dist/Common/Modals/OpaqueModal.d.ts

@@ -1,12 +1,12 @@
-import React from 'react';
-export interface OpaqueModalProps {
-    className?: string;
-    onHide?: any;
-    noBackground?: boolean;
-}
-export declare class OpaqueModal extends React.Component<OpaqueModalProps> {
-    modalRef: HTMLElement;
-    componentDidMount(): void;
-    componentWillUnmount(): void;
-    render(): React.ReactPortal;
-}
+import React from 'react';
+export interface OpaqueModalProps {
+    className?: string;
+    onHide?: any;
+    noBackground?: boolean;
+}
+export declare class OpaqueModal extends React.Component<OpaqueModalProps> {
+    modalRef: HTMLElement;
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    render(): React.ReactPortal;
+}

package/dist/Common/Modals/VisibleModal.d.ts

@@ -1,15 +1,15 @@
-import React from 'react';
-export declare class VisibleModal extends React.Component<{
-    className: string;
-    parentClassName?: string;
-    noBackground?: boolean;
-    close?: (e: any) => void;
-    onEscape?: (e: any) => void;
-}> {
-    modalRef: HTMLElement;
-    constructor(props: any);
-    escFunction(event: any): void;
-    componentDidMount(): void;
-    componentWillUnmount(): void;
-    render(): React.ReactPortal;
-}
+import React from 'react';
+export declare class VisibleModal extends React.Component<{
+    className: string;
+    parentClassName?: string;
+    noBackground?: boolean;
+    close?: (e: any) => void;
+    onEscape?: (e: any) => void;
+}> {
+    modalRef: HTMLElement;
+    constructor(props: any);
+    escFunction(event: any): void;
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    render(): React.ReactPortal;
+}

package/dist/Common/Modals/VisibleModal2.d.ts

@@ -1,12 +1,12 @@
-import React from 'react';
-export declare class VisibleModal2 extends React.Component<{
-    className: string;
-    close?: (e: any) => void;
-}> {
-    modalRef: HTMLElement;
-    constructor(props: any);
-    escFunction(event: any): void;
-    componentDidMount(): void;
-    componentWillUnmount(): void;
-    render(): React.ReactPortal;
-}
+import React from 'react';
+export declare class VisibleModal2 extends React.Component<{
+    className: string;
+    close?: (e: any) => void;
+}> {
+    modalRef: HTMLElement;
+    constructor(props: any);
+    escFunction(event: any): void;
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    render(): React.ReactPortal;
+}

package/dist/Common/MultiSelectCustomization.d.ts

@@ -1,37 +1,37 @@
-import React from 'react';
-export declare const Option: (props: any) => JSX.Element;
-export declare const SingleSelectOption: (props: any) => JSX.Element;
-export declare const MultiValueContainer: (props: any) => JSX.Element;
-export declare const ClearIndicator: (props: any) => JSX.Element;
-export declare const MultiValueRemove: (props: any) => JSX.Element;
-export declare const MultiValueChipContainer: ({ validator, isAllSelected, ...props }: {
-    [x: string]: any;
-    validator: any;
-    isAllSelected?: boolean;
-}) => JSX.Element;
-export declare const multiSelectStyles: {
-    control: (base: any, state: any) => any;
-    menu: (base: any, state: any) => any;
-    option: (base: any, state: any) => any;
-    container: (base: any, state: any) => any;
-    valueContainer: (base: any, state: any) => any;
-};
-export interface CustomSelect {
-    sortSelected?: boolean;
-    options: any[];
-    onChange: (...args: any[]) => void;
-    value?: any;
-    name?: string;
-    placeholder?: string;
-    className?: string;
-    classNamePrefix?: string;
-    menuPortalTarget?: any;
-    components?: object;
-    styles?: object;
-    isMulti?: boolean;
-    isDisabled?: boolean;
-    closeMenuOnSelect?: boolean;
-    hideSelectedOptions?: boolean;
-    formatOptionLabel?: (...args: any[]) => any;
-}
-export declare const CustomSelect: React.FC<CustomSelect>;
+import React from 'react';
+export declare const Option: (props: any) => JSX.Element;
+export declare const SingleSelectOption: (props: any) => JSX.Element;
+export declare const MultiValueContainer: (props: any) => JSX.Element;
+export declare const ClearIndicator: (props: any) => JSX.Element;
+export declare const MultiValueRemove: (props: any) => JSX.Element;
+export declare const MultiValueChipContainer: ({ validator, isAllSelected, ...props }: {
+    [x: string]: any;
+    validator: any;
+    isAllSelected?: boolean;
+}) => JSX.Element;
+export declare const multiSelectStyles: {
+    control: (base: any, state: any) => any;
+    menu: (base: any, state: any) => any;
+    option: (base: any, state: any) => any;
+    container: (base: any, state: any) => any;
+    valueContainer: (base: any, state: any) => any;
+};
+export interface CustomSelect {
+    sortSelected?: boolean;
+    options: any[];
+    onChange: (...args: any[]) => void;
+    value?: any;
+    name?: string;
+    placeholder?: string;
+    className?: string;
+    classNamePrefix?: string;
+    menuPortalTarget?: any;
+    components?: object;
+    styles?: object;
+    isMulti?: boolean;
+    isDisabled?: boolean;
+    closeMenuOnSelect?: boolean;
+    hideSelectedOptions?: boolean;
+    formatOptionLabel?: (...args: any[]) => any;
+}
+export declare const CustomSelect: React.FC<CustomSelect>;

package/dist/Common/Pagination/PageSizeSelector.d.ts

@@ -1,3 +1,4 @@
-import { PageSizeSelectorProps } from './types';
-declare const PageSizeSelector: ({ pageSizeOptions, pageSize, changePageSize }: PageSizeSelectorProps) => JSX.Element;
-export default PageSizeSelector;
+/// <reference types="react" />
+import { PageSizeSelectorProps } from './types';
+declare const PageSizeSelector: ({ pageSizeOptions, pageSize, changePageSize }: PageSizeSelectorProps) => JSX.Element;
+export default PageSizeSelector;

package/dist/Common/Pagination/Pagination.d.ts

@@ -1,3 +1,5 @@
-import { PaginationProps } from './types';
-declare const Pagination: ({ size, pageSize, offset, changePage, changePageSize, isPageSizeFix, pageSizeOptions, rootClassName, }: PaginationProps) => JSX.Element;
-export default Pagination;
+/// <reference types="react" />
+import { PaginationProps } from './types';
+import './pagination.scss';
+declare const Pagination: ({ size, pageSize, offset, changePage, changePageSize, isPageSizeFix, pageSizeOptions, rootClassName, }: PaginationProps) => JSX.Element;
+export default Pagination;

package/dist/Common/Pagination/constants.d.ts

@@ -1,5 +1,5 @@
-export declare const VISIBLE_PAGES_LIMIT = 5;
-export declare const FALLBACK_PAGE_SIZE_OPTIONS: {
-    value: number;
-    selected: boolean;
-}[];
+export declare const VISIBLE_PAGES_LIMIT = 5;
+export declare const FALLBACK_PAGE_SIZE_OPTIONS: {
+    value: number;
+    selected: boolean;
+}[];

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

@@ -1 +1 @@
-export { default as Pagination } from './Pagination';
+export { default as Pagination } from './Pagination';

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

@@ -1,51 +1,51 @@
-/// <reference types="react" />
-export interface PageSizeOption {
-    value: number;
-    selected: boolean;
-}
-export interface PaginationProps {
-    /**
-     * number of items
-     */
-    size: number;
-    /**
-     * pageSize
-     */
-    pageSize: number;
-    offset: number;
-    changePage: (pageNo: number) => void;
-    changePageSize?: (pageSize: number) => void;
-    /**
-     * If true will not show page size selector
-     */
-    isPageSizeFix?: boolean;
-    /**
-     * If given would show these options in page size selector else [20,40,50] with 20 as selected
-     */
-    pageSizeOptions?: PageSizeOption[];
-    /**
-     * class for wrapper
-     */
-    rootClassName?: string;
-}
-export interface Page {
-    value: number;
-    selected: boolean;
-    isVisible: boolean;
-}
-export interface CreatePageArrType extends Pick<PaginationProps, 'size' | 'pageSize'> {
-    selectedPageNo: number;
-}
-export interface PageSizeSelectorProps extends Pick<PaginationProps, 'pageSizeOptions' | 'pageSize' | 'changePageSize'> {
-}
-export interface PageSizeItemsProps extends Pick<PageSizeSelectorProps, 'changePageSize'> {
-    optionValue: PageSizeOption['value'];
-    options: PageSizeOption[];
-    setOptions: React.Dispatch<React.SetStateAction<PageSizeOption[]>>;
-    handleCloseDropdown: () => void;
-}
-export interface PageValueItemProps {
-    value: PageSizeOption['value'];
-    isSelected: PageSizeOption['selected'];
-    selectPage: (selectedPageNo: number) => void;
-}
+/// <reference types="react" />
+export interface PageSizeOption {
+    value: number;
+    selected: boolean;
+}
+export interface PaginationProps {
+    /**
+     * number of items
+     */
+    size: number;
+    /**
+     * pageSize
+     */
+    pageSize: number;
+    offset: number;
+    changePage: (pageNo: number) => void;
+    changePageSize?: (pageSize: number) => void;
+    /**
+     * If true will not show page size selector
+     */
+    isPageSizeFix?: boolean;
+    /**
+     * If given would show these options in page size selector else [20,40,50] with 20 as selected
+     */
+    pageSizeOptions?: PageSizeOption[];
+    /**
+     * class for wrapper
+     */
+    rootClassName?: string;
+}
+export interface Page {
+    value: number;
+    selected: boolean;
+    isVisible: boolean;
+}
+export interface CreatePageArrType extends Pick<PaginationProps, 'size' | 'pageSize'> {
+    selectedPageNo: number;
+}
+export interface PageSizeSelectorProps extends Pick<PaginationProps, 'pageSizeOptions' | 'pageSize' | 'changePageSize'> {
+}
+export interface PageSizeItemsProps extends Pick<PageSizeSelectorProps, 'changePageSize'> {
+    optionValue: PageSizeOption['value'];
+    options: PageSizeOption[];
+    setOptions: React.Dispatch<React.SetStateAction<PageSizeOption[]>>;
+    handleCloseDropdown: () => void;
+}
+export interface PageValueItemProps {
+    value: PageSizeOption['value'];
+    isSelected: PageSizeOption['selected'];
+    selectPage: (selectedPageNo: number) => void;
+}

package/dist/Common/Pagination/utils.d.ts

@@ -1,6 +1,6 @@
-import { CreatePageArrType, Page, PageSizeOption } from './types';
-/**
- * Returns an array of pages numbers and whether they are selected, visible or not
- */
-export declare const createPageArr: ({ size, pageSize, selectedPageNo }: CreatePageArrType) => Page[];
-export declare const getDefaultPageValueOptions: (pageSizeOptions: PageSizeOption[]) => PageSizeOption[];
+import { CreatePageArrType, Page, PageSizeOption } from './types';
+/**
+ * Returns an array of pages numbers and whether they are selected, visible or not
+ */
+export declare const createPageArr: ({ size, pageSize, selectedPageNo }: CreatePageArrType) => Page[];
+export declare const getDefaultPageValueOptions: (pageSizeOptions: PageSizeOption[]) => PageSizeOption[];