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

package/dist/Common/BreadCrumb/BreadcrumbStore.d.ts

@@ -1,7 +1,5 @@
-import { BreadcrumbTextProps } from './Types';
 import { default as React } from 'react';
 
-export declare const BreadcrumbText: ({ heading, isActive }: BreadcrumbTextProps) => JSX.Element;
 declare const Store: ({ children }: {
     children: any;
 }) => JSX.Element;

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

@@ -26,7 +26,3 @@ export interface Breadcrumbs {
     className?: string;
 }
 export type UseBreadcrumbOptionalProps = UseBreadcrumbProps | null;
-export interface BreadcrumbTextProps {
-    heading: string;
-    isActive?: boolean;
-}

package/dist/Common/Helper.d.ts

@@ -86,4 +86,5 @@ export declare const compareObjectLength: (objA: any, objB: any) => boolean;
  * Return deep copy of the object
  */
 export declare function deepEqual(configA: any, configB: any): boolean;
+export declare const prefixZeroIfSingleDigit: (value?: number) => string | number;
 export {};

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

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

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

@@ -0,0 +1,2 @@
+export { default as useStateFilters } from './useStateFilters';
+export type { UseStateFiltersProps, UseStateFiltersReturnType } from './types';

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

@@ -0,0 +1,6 @@
+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'> {
+}

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

@@ -0,0 +1,17 @@
+import { UseStateFiltersProps, UseStateFiltersReturnType } from './types';
+
+/**
+ * Generic hook for implementing state based pagination, search, sorting.
+ * Sister method of [useUrlFilters](https://github.com/devtron-labs/devtron-fe-common-lib/blob/main/src/Common/Hooks/useUrlFilters/useUrlFilters.ts)
+ *
+ * The exposed handlers can be consumed directly without the need for explicit state management
+ *
+ * @example Usage with custom type for sort keys and initial sort key:
+ * ```tsx
+ * const  { sortBy, sortOrder } = useUrlFilters<'email' | 'name'>({ initialSortKey: 'email' })
+ * ```
+ *
+ * To be extended to be used with pagination and search as and when required
+ */
+declare const useStateFilters: <T = string>({ initialSortKey, }?: UseStateFiltersProps<T>) => UseStateFiltersReturnType<T>;
+export default useStateFilters;

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

@@ -56,5 +56,5 @@ export type UseUrlFiltersReturnType<T, K = unknown> = K & {
     /**
      * Update the search params with the passed object
      */
-    updateSearchParams: (paramsToSerialize: K) => void;
+    updateSearchParams: (paramsToSerialize: Partial<K>) => void;
 };

package/dist/Common/SearchBar/SearchBar.component.d.ts

@@ -34,5 +34,5 @@ import { SearchBarProps } from './types';
  * <SearchBar inputProps={{ placeholder: 'Enter search text' }} />
  * ```
  */
-declare const SearchBar: ({ initialSearchText, handleSearchChange, handleEnter, inputProps, containerClassName, shouldDebounce, debounceTimeout, }: SearchBarProps) => JSX.Element;
+declare const SearchBar: ({ initialSearchText, handleSearchChange, handleEnter, inputProps, containerClassName, shouldDebounce, debounceTimeout, noBackgroundAndBorder, }: SearchBarProps) => JSX.Element;
 export default SearchBar;

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

@@ -32,4 +32,8 @@ export interface SearchBarProps {
      * Timeout for the debounce handler to be triggered
      */
     debounceTimeout?: number;
+    /**
+     * Hide the background and border of the search
+     */
+    noBackgroundAndBorder?: boolean;
 }

package/dist/Common/Types.d.ts

@@ -28,9 +28,9 @@ export interface APIOptions {
     signal?: AbortSignal;
     preventAutoLogout?: boolean;
 }
-export interface OptionType {
-    label: string;
-    value: string;
+export interface OptionType<T = string, K = string> {
+    value: T;
+    label: K;
 }
 export declare enum TippyTheme {
     black = "black",
@@ -116,7 +116,7 @@ export interface GenericEmptyStateType {
     layout?: 'row' | 'column';
     contentClassName?: string;
 }
-export interface ErrorPageType extends Pick<GenericEmptyStateType, 'image' | 'title' | 'subTitle' | 'renderButton' | 'imageType'>, Pick<ErrorScreenManagerProps, 'reload'> {
+export interface ErrorPageType extends Pick<GenericEmptyStateType, 'image' | 'title' | 'subTitle' | 'renderButton' | 'imageType'>, Pick<ErrorScreenManagerProps, 'reload' | 'redirectURL'> {
     code: number;
     heightToDeduct?: number;
     redirectURL?: string;
@@ -128,6 +128,10 @@ export interface ErrorScreenManagerProps {
     subtitle?: React.ReactChild;
     reloadClass?: string;
     heightToDeduct?: number;
+    /**
+     * Would be used to redirect URL in case of 404
+     * @default - APP_LIST
+     */
     redirectURL?: string;
 }
 export interface ErrorScreenNotAuthorizedProps {
@@ -136,8 +140,7 @@ export interface ErrorScreenNotAuthorizedProps {
 }
 export declare enum ImageType {
     Large = "large",
-    Medium = "medium",
-    SMALL = "small"
+    Medium = "medium"
 }
 export interface InfoColourBarType {
     message: React.ReactNode;
@@ -307,6 +310,14 @@ export interface DeploymentWindowArtifactMetadata {
     name: string;
     type: DEPLOYMENT_WINDOW_TYPE;
 }
+export interface ArtifactReleaseMappingType {
+    id: number;
+    identifier: string;
+    releaseVersion: string;
+    name: string;
+    kind: string;
+    version: string;
+}
 export interface CDMaterialType {
     index: number;
     id: string;
@@ -350,6 +361,14 @@ export interface CDMaterialType {
     promotionApprovalMetadata?: PromotionApprovalMetadataType;
     deployedOnEnvironments?: string[];
     deploymentWindowArtifactMetadata?: DeploymentWindowArtifactMetadata;
+    /**
+     * Will only be present in case of release
+     */
+    configuredInReleases: ArtifactReleaseMappingType[];
+    /**
+     * Would currently only be received in case of release
+     */
+    appWorkflowId: number;
 }
 export declare enum CDMaterialServiceEnum {
     ROLLBACK = "rollback",

package/dist/Common/index.d.ts

@@ -14,7 +14,7 @@ export * from './Modals/OpaqueModal';
 export * from './Modals/VisibleModal';
 export * from './Modals/VisibleModal2';
 export { BreadCrumb, useBreadcrumb } from './BreadCrumb/BreadCrumb';
-export { default as BreadcrumbStore, BreadcrumbText } from './BreadCrumb/BreadcrumbStore';
+export { default as BreadcrumbStore } from './BreadCrumb/BreadcrumbStore';
 export { default as RadioGroup } from './RadioGroup';
 export { default as RadioGroupItem } from './RadioGroupItem';
 export { default as PopupMenu } from './PopupMenu';

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

@@ -1,4 +1,4 @@
 import { APIResponseHandlerProps } from './types';
 
-declare const APIResponseHandler: ({ isLoading, progressingProps, customLoader, error, notAuthorized, notFoundText, reloadProps, genericSectionErrorProps, children, }: APIResponseHandlerProps) => JSX.Element;
+declare const APIResponseHandler: ({ isLoading, progressingProps, customLoader, error, notAuthorized, notFoundText, reloadProps, genericSectionErrorProps, errorScreenManagerProps, children, }: APIResponseHandlerProps) => JSX.Element;
 export default APIResponseHandler;

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

@@ -1,5 +1,5 @@
 import { GenericSectionErrorStateProps } from '../GenericSectionErrorState/types';
-import { GenericEmptyStateType, ProgressingProps, ReloadType, ServerErrors } from '../../../Common';
+import { ErrorScreenManagerProps, GenericEmptyStateType, ProgressingProps, ReloadType, ServerErrors } from '../../../Common';
 import { ReactNode } from 'react';
 
 export interface EmptyPageTextType {
@@ -37,9 +37,14 @@ export interface APIResponseHandlerProps {
      */
     reloadProps?: ReloadType;
     /**
-     * If given, would show this component instead of default Error component
+     * If given, would show GenericSectionErrorState instead of default Reload component
      */
     genericSectionErrorProps?: GenericSectionErrorStateProps;
+    /**
+     * If given, would show ErrorScreenManager component instead of Reload component
+     * Priority of error states are: genericSectionErrorProps > errorScreenManagerProps > Reload component
+     */
+    errorScreenManagerProps?: ErrorScreenManagerProps;
     /**
      * If no Error and no Loading, would load this component
      */

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

@@ -14,5 +14,5 @@ import { ButtonWithSelectorProps } from './types';
  * </ButtonWithSelector>
  * ```
  */
-declare const ButtonWithSelector: ({ content, onClick, children, className, popUpBodyClassName, showPopUp, }: ButtonWithSelectorProps) => JSX.Element;
+declare const ButtonWithSelector: ({ content, onClick, children, className, popUpBodyClassName, showPopUp, disabled, }: ButtonWithSelectorProps) => JSX.Element;
 export default ButtonWithSelector;

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

@@ -7,4 +7,5 @@ export interface ButtonWithSelectorProps {
     className?: string;
     popUpBodyClassName?: string;
     showPopUp?: boolean;
+    disabled?: boolean;
 }

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

@@ -3,5 +3,5 @@ import { FilterChipsProps } from './types';
 /**
  * Component for rendering the applied filter chips
  */
-declare const FilterChips: ({ filterConfig, clearFilters, onRemoveFilter, getFormattedLabel, getFormattedValue, }: FilterChipsProps) => JSX.Element;
+declare const FilterChips: <T = Record<string, unknown>>({ filterConfig, clearFilters, onRemoveFilter, getFormattedLabel, getFormattedValue, className, clearButtonClassName, }: FilterChipsProps<T>) => JSX.Element;
 export default FilterChips;

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

@@ -22,11 +22,11 @@ export interface FilterChipProps {
      */
     getFormattedValue?: (filterKey: string, filterValue: unknown) => ReactNode;
 }
-export interface FilterChipsProps extends Pick<FilterChipProps, 'getFormattedLabel' | 'getFormattedValue'> {
+export interface FilterChipsProps<T = Record<string, unknown>> extends Pick<FilterChipProps, 'getFormattedLabel' | 'getFormattedValue'> {
     /**
      * Current filter configuration
      */
-    filterConfig: Record<string, unknown>;
+    filterConfig: T;
     /**
      * Callback handler for removing the filters
      */
@@ -34,5 +34,13 @@ export interface FilterChipsProps extends Pick<FilterChipProps, 'getFormattedLab
     /**
      * Handler for removing a applied filter
      */
-    onRemoveFilter: (filterConfig: Record<string, unknown>) => void;
+    onRemoveFilter: (filterConfig: T) => void;
+    /**
+     * Class name for the container
+     */
+    className?: string;
+    /**
+     * Class name for the clear filter button
+     */
+    clearButtonClassName?: string;
 }

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

@@ -1,4 +1,4 @@
 import { GenericSectionErrorStateProps } from './types';
 
-declare const GenericSectionErrorState: ({ reload, withBorder, title, subTitle, description, buttonText, rootClassName, }: GenericSectionErrorStateProps) => JSX.Element;
+declare const GenericSectionErrorState: ({ reload, withBorder, title, subTitle, description, buttonText, rootClassName, useInfoIcon, }: GenericSectionErrorStateProps) => JSX.Element;
 export default GenericSectionErrorState;

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

@@ -1 +1,2 @@
 export { default as GenericSectionErrorState } from './GenericSectionErrorState.component';
+export type { GenericSectionErrorStateProps } from './types';

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

@@ -29,4 +29,10 @@ export interface GenericSectionErrorStateProps {
      * to be applied on parent div
      */
     rootClassName?: string;
+    /**
+     * If true, info icon would be used instead of error
+     *
+     * @default false
+     */
+    useInfoIcon?: boolean;
 }

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

@@ -17,4 +17,3 @@ export * from './Header';
 export * from './AnnouncementBanner';
 export * from './ButtonWithLoader';
 export * from './ButtonWithSelector';
-export * from './FeatureDescription';

package/dist/Shared/Helpers.d.ts

@@ -1,5 +1,5 @@
 import { GitTriggers, WebhookEventNameType } from './types';
-import { MaterialInfo } from '../Common';
+import { MaterialInfo, SortingOrder } from '../Common';
 
 interface HighlightSearchTextProps {
     /**
@@ -19,7 +19,9 @@ export declare const highlightSearchText: ({ searchText, text, highlightClasses
 export declare const preventBodyScroll: (lock: boolean) => void;
 export declare const getIsMaterialInfoAvailable: (materialInfo: MaterialInfo[]) => boolean;
 export declare const getGitCommitInfo: (materialInfo: MaterialInfo) => GitTriggers;
-export declare const caseInsensitiveStringComparator: (a: string, b: string) => number;
+export declare const stringComparatorBySortOrder: (a: string, b: string, sortOrder?: SortingOrder, isCaseSensitive?: boolean) => number;
+export declare const numberComparatorBySortOrder: (a: number, b: number, sortOrder?: SortingOrder) => number;
 export declare const getWebhookEventIcon: (eventName: WebhookEventNameType) => JSX.Element;
 export declare const isNullOrUndefined: (value: unknown) => boolean;
+export declare const getKeyToBooleanMapFromArray: <T extends string | number>(arr?: T[]) => Record<T, boolean>;
 export {};