@devtron-labs/devtron-fe-common-lib 0.1.6 → 0.1.7-beta-1

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

@@ -252,14 +252,4 @@ export interface FormErrorObjectType {
         steps: TaskErrorObj[];
     };
 }
-export interface PluginDetailType {
-    id: number;
-    name: string;
-    type: string;
-    description: string;
-    icon: string;
-    tags: string[];
-    inputVariables?: VariableType[];
-    outputVariables?: VariableType[];
-}
 export {};

package/dist/Common/Constants.d.ts

@@ -74,6 +74,9 @@ export declare const ROUTES: {
     CONFIG_CD_PIPELINE: string;
     MODULE_CONFIGURED: string;
     RESOURCE_HISTORY_DEPLOYMENT: string;
+    PLUGIN_GLOBAL_LIST_DETAIL_V2: string;
+    PLUGIN_GLOBAL_LIST_V2: string;
+    PLUGIN_GLOBAL_LIST_TAGS: string;
 };
 export declare enum KEY_VALUE {
     KEY = "key",

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

@@ -1,4 +1,6 @@
+import { PluginDataStoreType } from '../Shared';
 import { VariableType } from './CIPipeline.Types';
+import { ServerErrors } from './ServerError';
 import { ResponseType } from './Types';
 
 export declare enum ApplyPolicyToStage {
@@ -24,6 +26,7 @@ export interface DefinitionSourceType {
 }
 export interface MandatoryPluginDetailType {
     id: number;
+    parentPluginId: number;
     icon: string;
     name: string;
     description?: string;
@@ -38,6 +41,11 @@ export interface MandatoryPluginDataType {
     isValidPre: boolean;
     isValidPost: boolean;
 }
+export interface ProcessPluginDataReturnType {
+    mandatoryPluginData: MandatoryPluginDataType;
+    pluginDataStore: PluginDataStoreType;
+    mandatoryPluginsError?: ServerErrors;
+}
 export declare enum ConsequenceAction {
     BLOCK = "BLOCK",
     ALLOW_UNTIL_TIME = "ALLOW_UNTIL_TIME",

package/dist/Pages/GlobalConfigurations/Authorization/index.d.ts

@@ -1,3 +1,3 @@
 export * from './constants';
-export type { UserListFilterParams, BaseFilterQueryParams, UserRoleGroup } from './types';
+export type { UserListFilterParams, UserRoleGroup } from './types';
 export * from './shared';

package/dist/Pages/GlobalConfigurations/Authorization/types.d.ts

@@ -1,24 +1,6 @@
-import { SortingParams } from '../../../Common/Types';
+import { BaseFilterQueryParams } from '../../../Shared';
 import { UserListSortableKeys, UserStatus } from './constants';
 
-export type BaseFilterQueryParams<T> = {
-    /**
-     * Offset for the list result
-     */
-    offset?: number;
-    /**
-     * Number of items required in the list
-     */
-    size?: number;
-    /**
-     * Search string (if any)
-     */
-    searchKey?: string;
-    /**
-     * If true, all items are returned with any search / filtering applied without pagination
-     */
-    showAll?: boolean;
-} & SortingParams<T>;
 export type UserListFilterParams = BaseFilterQueryParams<UserListSortableKeys> & {
     /**
      * Selected statuses (if any)

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

@@ -0,0 +1,5 @@
+interface DetectBottomProps {
+    callback: () => void;
+}
+declare const DetectBottom: ({ callback }: DetectBottomProps) => JSX.Element;
+export default DetectBottom;

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

@@ -0,0 +1 @@
+export { default as DetectBottom } from './DetectBottom.component';

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: <T = Record<string, unknown>>({ filterConfig, clearFilters, onRemoveFilter, getFormattedLabel, getFormattedValue, className, clearButtonClassName, }: FilterChipsProps<T>) => JSX.Element;
+declare const FilterChips: <T = Record<string, unknown>>({ filterConfig, clearFilters, onRemoveFilter, getFormattedLabel, getFormattedValue, className, clearButtonClassName, shouldHideLabel, }: FilterChipsProps<T>) => JSX.Element;
 export default FilterChips;

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

@@ -4,7 +4,7 @@ export interface FilterChipProps {
     /**
      * Filter label
      */
-    label: string;
+    label?: string;
     /**
      * Corresponding value of the filter
      */
@@ -21,8 +21,13 @@ export interface FilterChipProps {
      * If passed, the label will be formatted accordingly
      */
     getFormattedValue?: (filterKey: string, filterValue: unknown) => ReactNode;
+    /**
+     * If true, would hide the label
+     * @default false
+     */
+    shouldHideLabel?: boolean;
 }
-export interface FilterChipsProps<T = Record<string, unknown>> extends Pick<FilterChipProps, 'getFormattedLabel' | 'getFormattedValue'> {
+export interface FilterChipsProps<T = Record<string, unknown>> extends Pick<FilterChipProps, 'getFormattedLabel' | 'getFormattedValue' | 'shouldHideLabel'> {
     /**
      * Current filter configuration
      */

package/dist/Shared/Components/Plugin/PluginCard.d.ts

@@ -0,0 +1,4 @@
+import { PluginCardProps } from './types';
+
+declare const PluginCard: ({ isSelectable, pluginDataStore, handlePluginSelection, parentPluginId, isSelected, showCardBorder, }: PluginCardProps) => JSX.Element;
+export default PluginCard;

package/dist/Shared/Components/Plugin/PluginCardSkeletonList.d.ts

@@ -0,0 +1,4 @@
+import { PluginCardSkeletonListProps } from './types';
+
+declare const PluginCardSkeletonList: ({ count }: PluginCardSkeletonListProps) => JSX.Element;
+export default PluginCardSkeletonList;

package/dist/Shared/Components/Plugin/PluginImageContainer.d.ts

@@ -0,0 +1,4 @@
+import { PluginImageContainerProps } from './types';
+
+declare const PluginImageContainer: ({ imageProps, fallbackImageClassName }: PluginImageContainerProps) => JSX.Element;
+export default PluginImageContainer;

package/dist/Shared/Components/Plugin/PluginList.d.ts

@@ -0,0 +1,4 @@
+import { PluginListProps } from './types';
+
+declare const PluginList: ({ pluginDataStore, pluginList, totalCount, handleDataUpdateForPluginResponse, filters: { selectedTags, searchKey }, handlePluginSelection, selectedPluginsMap, isSelectable, handleClearFilters, showCardBorder, getPluginStoreRef, }: PluginListProps) => JSX.Element;
+export default PluginList;

package/dist/Shared/Components/Plugin/PluginListContainer.d.ts

@@ -0,0 +1,4 @@
+import { PluginListContainerProps } from './types';
+
+declare const PluginListContainer: ({ availableTags, handleUpdateAvailableTags, pluginDataStore, handlePluginDataStoreUpdate, handlePluginSelection, isSelectable, selectedPluginsMap, persistFilters, parentPluginList, handleParentPluginListUpdate, parentTotalCount, handleParentTotalCount, parentFilters, handleUpdateParentFilters, rootClassName, showCardBorder, }: Readonly<PluginListContainerProps>) => JSX.Element;
+export default PluginListContainer;

package/dist/Shared/Components/Plugin/PluginTagSelect.d.ts

@@ -0,0 +1,4 @@
+import { PluginTagSelectProps } from './types';
+
+declare const PluginTagSelect: ({ availableTags, handleUpdateSelectedTags, selectedTags, isLoading, hasError, reloadTags, }: PluginTagSelectProps) => JSX.Element;
+export default PluginTagSelect;

package/dist/Shared/Components/Plugin/PluginTagsContainer.d.ts

@@ -0,0 +1,4 @@
+import { PluginTagsContainerProps } from './types';
+
+declare const PluginTagsContainer: ({ tags, rootClassName }: PluginTagsContainerProps) => JSX.Element;
+export default PluginTagsContainer;

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

@@ -0,0 +1,5 @@
+import { PluginDataStoreType, PluginListFiltersType } from './types';
+
+export declare const DEFAULT_PLUGIN_DATA_STORE: PluginDataStoreType;
+export declare const DEFAULT_PLUGIN_LIST_FILTERS: PluginListFiltersType;
+export declare const DEFAULT_PLUGIN_CREATED_BY = "Devtron";

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

@@ -0,0 +1,7 @@
+export * from './types';
+export * from './service';
+export * from './utils';
+export * from './constants';
+export { default as PluginListContainer } from './PluginListContainer';
+export { default as PluginTagsContainer } from './PluginTagsContainer';
+export { default as PluginImageContainer } from './PluginImageContainer';

package/dist/Shared/Components/Plugin/service.d.ts

@@ -0,0 +1,5 @@
+import { GetPluginStoreDataReturnType, GetPluginStoreDataServiceParamsType, PluginDetailServiceParamsType } from './types';
+
+export declare const getPluginsDetail: ({ appId, parentPluginIds, pluginIds, shouldShowError, }: PluginDetailServiceParamsType) => Promise<Pick<GetPluginStoreDataReturnType, 'pluginStore'>>;
+export declare const getPluginStoreData: ({ searchKey, selectedTags, appId, offset, signal, }: GetPluginStoreDataServiceParamsType) => Promise<GetPluginStoreDataReturnType>;
+export declare const getAvailablePluginTags: (appId: number) => Promise<string[]>;

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

@@ -0,0 +1,176 @@
+import { MutableRefObject } from 'react';
+import { VariableType } from '../../../Common';
+import { BaseFilterQueryParams } from '../../types';
+import { ImageWithFallbackProps } from '../ImageWithFallback';
+import { getPluginStoreData } from './service';
+
+export declare enum PluginCreationType {
+    SHARED = "SHARED",
+    PRESET = "PRESET"
+}
+export interface GetPluginTagsPayloadType {
+    appId: number;
+}
+export interface PluginTagNamesDTO {
+    tagNames: string[];
+}
+/**
+ * Minimal data of child plugins
+ */
+interface MinimalPluginVersionDataDTO {
+    id: number;
+    name: string;
+    description: string;
+    pluginVersion: string;
+    isLatest: boolean;
+}
+interface DetailedPluginVersionDTO extends MinimalPluginVersionDataDTO {
+    tags: string[];
+    inputVariables: VariableType[];
+    outputVariables: VariableType[];
+    /**
+     * Present in case of shared plugin
+     */
+    updatedBy?: string;
+    docLink?: string;
+}
+interface PluginVersionsDTO {
+    detailedPluginVersionData: DetailedPluginVersionDTO[];
+    minimalPluginVersionData: MinimalPluginVersionDataDTO[];
+}
+export interface ParentPluginDTO {
+    id: number;
+    name: string;
+    description: string;
+    type: PluginCreationType;
+    icon: string;
+    pluginVersions: PluginVersionsDTO;
+}
+export interface PluginDetailDTO {
+    parentPlugins: ParentPluginDTO[];
+    totalCount: number;
+}
+export interface PluginDetailServiceParamsType {
+    appId: number;
+    pluginIds?: number[];
+    parentPluginIds?: number[];
+    /**
+     * @default true
+     */
+    shouldShowError?: boolean;
+}
+export interface PluginDetailPayloadType extends Pick<PluginDetailServiceParamsType, 'appId'> {
+    pluginId?: PluginDetailServiceParamsType['pluginIds'];
+    parentPluginId?: PluginDetailServiceParamsType['parentPluginIds'];
+}
+export interface PluginListFiltersType extends Pick<BaseFilterQueryParams<unknown>, 'searchKey'> {
+    selectedTags: string[];
+}
+interface ParentPluginType extends Pick<ParentPluginDTO, 'id' | 'name' | 'description' | 'type' | 'icon'> {
+    latestVersionId: MinimalPluginVersionDataDTO['id'];
+    pluginVersions: MinimalPluginVersionDataDTO[];
+}
+interface DetailedPluginVersionType extends Pick<MinimalPluginVersionDataDTO, 'id' | 'description' | 'name' | 'pluginVersion'>, Pick<DetailedPluginVersionDTO, 'tags' | 'isLatest' | 'inputVariables' | 'outputVariables' | 'updatedBy' | 'docLink'>, Pick<ParentPluginType, 'icon' | 'type'> {
+    parentPluginId: ParentPluginType['id'];
+}
+export interface PluginDataStoreType {
+    parentPluginStore: Record<number, ParentPluginType>;
+    pluginVersionStore: Record<number, DetailedPluginVersionType>;
+}
+export interface PluginDetailType extends DetailedPluginVersionType {
+}
+export type PluginListItemType = Pick<PluginDetailType, 'parentPluginId'>;
+interface BasePluginListContainerProps {
+    availableTags: string[];
+    handleUpdateAvailableTags: (tags: string[]) => void;
+    handlePluginSelection: (parentPluginId: PluginDetailType['parentPluginId']) => void;
+    pluginDataStore: PluginDataStoreType;
+    handlePluginDataStoreUpdate: (pluginStore: PluginDataStoreType) => void;
+    rootClassName?: string;
+    showCardBorder?: boolean;
+}
+type PluginListType = {
+    persistFilters: true;
+    parentPluginList: PluginListItemType[];
+    handleParentPluginListUpdate: (pluginList: PluginListItemType[]) => void;
+    parentTotalCount: number;
+    handleParentTotalCount: (totalCount: number) => void;
+    parentFilters: PluginListFiltersType;
+    handleUpdateParentFilters: (filters: PluginListFiltersType) => void;
+} | {
+    persistFilters: false;
+    parentPluginList?: never;
+    handleParentPluginListUpdate?: never;
+    parentTotalCount?: never;
+    handleParentTotalCount?: never;
+    parentFilters?: never;
+    handleUpdateParentFilters?: never;
+};
+export type PluginListContainerProps = BasePluginListContainerProps & PluginListType & ({
+    /**
+     * Would be used to identify the case where we are selecting plugins like mandatory plugin list
+     */
+    isSelectable: false;
+    selectedPluginsMap?: never;
+} | {
+    isSelectable: true;
+    /**
+     * Map of parentId to boolean
+     */
+    selectedPluginsMap: Record<number, true>;
+});
+export interface GetPluginStoreDataServiceParamsType extends Pick<PluginListFiltersType, 'searchKey' | 'selectedTags'> {
+    signal: AbortSignal;
+    appId: number;
+    offset?: number;
+}
+export interface GetPluginListPayloadType extends Pick<GetPluginStoreDataServiceParamsType, 'searchKey' | 'offset' | 'appId'> {
+    tag: PluginListFiltersType['selectedTags'];
+    size: number;
+}
+export interface GetPluginStoreDataReturnType {
+    totalCount: number;
+    pluginStore: PluginDataStoreType;
+}
+export interface PluginListParamsType {
+    appId?: string;
+}
+export interface PluginTagSelectProps extends Pick<BasePluginListContainerProps, 'availableTags'> {
+    selectedTags: PluginListContainerProps['parentFilters']['selectedTags'];
+    isLoading: boolean;
+    hasError: boolean;
+    reloadTags: () => void;
+    handleUpdateSelectedTags: (tags: string[]) => void;
+}
+export interface PluginListProps extends Pick<PluginListContainerProps, 'pluginDataStore' | 'handlePluginSelection' | 'selectedPluginsMap' | 'isSelectable' | 'showCardBorder'> {
+    handleDataUpdateForPluginResponse: (pluginResponse: Awaited<ReturnType<typeof getPluginStoreData>>, 
+    /**
+     * If true, the response would be appended to the existing data
+     * if false, the existing data would be replaced with the new data
+     * @default false
+     */
+    appendResponse?: boolean) => void;
+    handleClearFilters: () => void;
+    pluginList: PluginListContainerProps['parentPluginList'];
+    totalCount: PluginListContainerProps['parentTotalCount'];
+    filters: PluginListContainerProps['parentFilters'];
+    getPluginStoreRef: MutableRefObject<AbortController>;
+}
+export interface PluginCardProps extends Pick<PluginListProps, 'isSelectable' | 'pluginDataStore' | 'handlePluginSelection' | 'showCardBorder'> {
+    parentPluginId: PluginDetailType['parentPluginId'];
+    isSelected: boolean;
+}
+export interface PluginCardSkeletonListProps {
+    /**
+     * @default 3
+     */
+    count?: number;
+}
+export interface PluginTagsContainerProps {
+    tags: string[];
+    rootClassName?: string;
+}
+export interface PluginImageContainerProps extends Pick<ImageWithFallbackProps, 'imageProps'> {
+    fallbackImageClassName?: string;
+}
+export {};

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

@@ -0,0 +1,20 @@
+import { ParentPluginDTO, PluginDataStoreType } from './types';
+
+export declare const parsePluginDetailsDTOIntoPluginStore: (pluginData: ParentPluginDTO[]) => PluginDataStoreType;
+export declare const pluginTagSelectStyles: {
+    option: (base: any, state: any) => any;
+    container: (base: any, state: any) => any;
+    menuList: (base: any) => any;
+    control: (base: any, state: any) => any;
+    dropdownIndicator: (base: any, state: any) => any;
+    valueContainer: (base: any) => any;
+    loadingMessage: (base: any) => any;
+    noOptionsMessage: (base: any) => any;
+    placeholder: (base: any) => any;
+    group: (base: any) => any;
+    groupHeading: (base: any) => any;
+};
+/**
+ * @description This method takes the initial plugin data store and updates the keys with the target parent plugin store and plugin version store
+ */
+export declare const getUpdatedPluginStore: (initialPluginDataStore: PluginDataStoreType, targetParentPluginStore: PluginDataStoreType['parentPluginStore'], targetPluginVersionStore: PluginDataStoreType['pluginVersionStore']) => PluginDataStoreType;

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

@@ -1,4 +1,5 @@
-import { MenuListProps } from 'react-select';
+import { MenuListProps, ValueContainerProps } from 'react-select';
+import { OptionType } from '../../../Common';
 
 export declare const getCommonSelectStyle: (styleOverrides?: {}) => {
     container: (base: any, state: any) => any;
@@ -33,3 +34,6 @@ export declare const commonSelectStyles: {
 export declare const MenuListWithApplyButton: ({ handleApplyFilter, ...props }: MenuListProps<unknown, boolean, import('react-select').GroupBase<unknown>> & {
     handleApplyFilter: () => void;
 }) => JSX.Element;
+export declare const MultiSelectValueContainer: ({ title, ...props }: ValueContainerProps<OptionType<string, string>, true, import('react-select').GroupBase<OptionType<string, string>>> & {
+    title: string;
+}) => JSX.Element;

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

@@ -30,4 +30,5 @@ export * from './ImageChipCell';
 export * from './ArtifactInfoModal';
 export * from './MaterialHistory';
 export * from './IframeContainer';
+export * from './Plugin';
 export * from './KeyValueTable';

package/dist/Shared/types.d.ts

@@ -1,4 +1,4 @@
-import { OptionType, CommonNodeAttr, ResponseType, UserApprovalConfigType, VulnerabilityType, DeploymentAppTypes, ServerErrors } from '../Common';
+import { OptionType, CommonNodeAttr, ResponseType, UserApprovalConfigType, VulnerabilityType, DeploymentAppTypes, ServerErrors, SortingParams } from '../Common';
 import { EnvironmentTypeEnum, PatchOperationType } from './constants';
 
 export declare enum EnvType {
@@ -516,4 +516,22 @@ export interface BatchConfigType {
 export interface scrollableInterface {
     autoBottomScroll: boolean;
 }
+export type BaseFilterQueryParams<T> = {
+    /**
+     * Offset for the list result
+     */
+    offset?: number;
+    /**
+     * Number of items required in the list
+     */
+    size?: number;
+    /**
+     * Search string (if any)
+     */
+    searchKey?: string;
+    /**
+     * If true, all items are returned with any search / filtering applied without pagination
+     */
+    showAll?: boolean;
+} & SortingParams<T>;
 export {};