@devtron-labs/devtron-fe-common-lib 0.2.22 → 0.2.23

package/dist/Common/Api.d.ts

@@ -1,10 +1,10 @@
 import { MutableRefObject } from 'react';
 import { ResponseType, APIOptions } from './Types';
-export declare const post: (url: string, data: object, options?: APIOptions, isMultipartRequest?: boolean) => Promise<ResponseType>;
-export declare const put: (url: string, data: object, options?: APIOptions) => Promise<ResponseType>;
-export declare const patch: (url: string, data: object, options?: APIOptions) => Promise<ResponseType>;
-export declare const get: (url: string, options?: APIOptions) => Promise<ResponseType>;
-export declare const trash: (url: string, data?: object, options?: APIOptions) => Promise<ResponseType>;
+export declare const post: <T = any, K = object>(url: string, data: K, options?: APIOptions, isMultipartRequest?: boolean) => Promise<ResponseType<T>>;
+export declare const put: <T = any, K = object>(url: string, data: K, options?: APIOptions) => Promise<ResponseType<T>>;
+export declare const patch: <T = any, K = object>(url: string, data: K, options?: APIOptions) => Promise<ResponseType<T>>;
+export declare const get: <T = any>(url: string, options?: APIOptions) => Promise<ResponseType<T>>;
+export declare const trash: <T = any, K = object>(url: string, data?: K, options?: APIOptions) => Promise<ResponseType<T>>;
 /**
  * Aborts the previous request before triggering next request
  */

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

@@ -77,6 +77,7 @@ export interface VariableType {
     format: string;
     description: string;
     defaultValue: string;
+    allowEmptyValue: boolean;
     variableType: RefVariableType;
     refVariableStepIndex: number;
     refVariableName: string;
@@ -98,7 +99,7 @@ interface ConditionDetails {
     conditionType: ConditionType;
     conditionalValue: string;
 }
-interface InlineStepDetailType {
+export interface InlineStepDetailType {
     scriptType: ScriptType;
     isMountCustomScript?: boolean;
     script?: string;
@@ -117,6 +118,8 @@ interface InlineStepDetailType {
     inputVariables?: VariableType[];
     outputVariables?: VariableType[];
     conditionDetails: ConditionDetails[];
+    storeScriptAt?: string;
+    mountCodeToContainerPath?: string;
 }
 interface PluginRefStepDetailType {
     id: number;

package/dist/Common/Constants.d.ts

@@ -85,6 +85,7 @@ export declare const ROUTES: {
     PLUGIN_GLOBAL_LIST_DETAIL_V2: string;
     PLUGIN_GLOBAL_LIST_V2: string;
     PLUGIN_GLOBAL_LIST_TAGS: string;
+    PLUGIN_LIST_MIN: string;
     DEPLOYMENT_CHARTS_LIST: string;
     USER_LIST_MIN: string;
     CONFIG_DATA: string;
@@ -277,6 +278,7 @@ export declare const DATE_TIME_FORMATS: {
     DD_MMM_YYYY_HH_MM: string;
     DD_MMM_YYYY: string;
 };
+export declare const SEMANTIC_VERSION_DOCUMENTATION_LINK = "https://semver.org/";
 export declare const VULNERABILITIES_SORT_PRIORITY: {
     critical: number;
     high: number;

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

@@ -1,4 +1,4 @@
-import { default as React, HTMLInputTypeAttribute, InputHTMLAttributes } from 'react';
+import { default as React, HTMLInputTypeAttribute, InputHTMLAttributes, ReactNode } from 'react';
 export interface CustomInputProps {
     name: string;
     value: string | number;
@@ -16,7 +16,7 @@ export interface CustomInputProps {
     autoFocus?: boolean;
     rootClassName?: string;
     error?: string[] | string;
-    helperText?: string;
+    helperText?: ReactNode;
     handleOnBlur?: (e: any) => void;
     readOnly?: boolean;
     noTrim?: boolean;

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

@@ -1,6 +1,6 @@
 import { default as React, SyntheticEvent } from 'react';
 export declare class VisibleModal extends React.Component<{
-    className: string;
+    className?: string;
     parentClassName?: string;
     noBackground?: boolean;
     close?: (e: any) => void;

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

@@ -1,6 +1,6 @@
 import { default as React, SyntheticEvent } from 'react';
 export declare class VisibleModal2 extends React.Component<{
-    className: string;
+    className?: string;
     close?: (e: any) => void;
 }> {
     modalRef: HTMLElement;

package/dist/Common/Types.d.ts

@@ -177,10 +177,10 @@ export interface RadioGroupItemProps {
 export interface RadioGroupInterface {
     name: string;
     onChange: any;
-    className?: string;
     initialTab: string;
-    disabled: boolean;
     children: ReactNode;
+    disabled?: boolean;
+    className?: string;
 }
 export interface RadioInterface {
     children: ReactNode;

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

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

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

@@ -0,0 +1,18 @@
+import { EditImageFormFieldProps } from './types';
+/**
+ * @example
+ * ```tsx
+ * <EditImageFormField
+ *      url={icon}
+ *      defaultIcon={<ICSampleIcon className="w-100 h-100 dc__opacity-1 p-5" />}
+ *      errorMessage={formError.icon}
+ *      handleError={handleError}
+ *      handleURLChange={handleURLChange}
+ *      ariaLabelPrefix="Edit icon url"
+ *      dataTestIdPrefix="edit-icon-url"
+ *      altText="Form icon"
+ *  />
+ * ```
+ */
+declare const EditImageFormField: ({ defaultIcon, errorMessage, handleError, url, handleURLChange, ariaLabelPrefix, dataTestIdPrefix, altText, }: EditImageFormFieldProps) => JSX.Element;
+export default EditImageFormField;

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

@@ -0,0 +1,7 @@
+export declare const DEFAULT_MAX_IMAGE_SIZE: number;
+export declare const DEFAULT_IMAGE_DIMENSIONS: {
+    readonly width: 72;
+    readonly height: 72;
+};
+export declare const EMPTY_PREVIEW_URL_ERROR_MESSAGE = "Please provide image URL to preview";
+export declare const BASE_IMAGE_CLASS = "edit-image-form-field__figure-container--base-image";

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

@@ -0,0 +1,2 @@
+export { default as EditImageFormField } from './EditImageFormField';
+export * from './types';

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

@@ -0,0 +1,40 @@
+import { ReactElement } from 'react';
+export interface EditImageFormFieldProps {
+    /**
+     * Fallback icon to be shown when image is not available
+     */
+    defaultIcon: ReactElement;
+    /**
+     * Would be shown below input, there are two types of error messages:
+     * External - Error message handled from state above and would propagate to parent through handleError
+     * Internal - Error message handled internally and would not propagate to parent, like empty preview URL
+     */
+    errorMessage: string;
+    /**
+     * Would be called when there is an error in the image URL during handleChange or handlePreviewImage
+     */
+    handleError: (error: string) => void;
+    /**
+     * The current value of input field
+     */
+    url: string;
+    /**
+     * Would be called when the URL is changed in the input field
+     */
+    handleURLChange: (url: string) => void;
+    /**
+     * The alt text for the image
+     */
+    altText: string;
+    /**
+     * Prefix for aria-label
+     */
+    ariaLabelPrefix: string;
+    /**
+     * Prefix for data-testid
+     */
+    dataTestIdPrefix: string;
+}
+export interface FallbackImageProps extends Pick<EditImageFormFieldProps, 'defaultIcon'> {
+    showEditIcon: boolean;
+}

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

@@ -1,21 +1,10 @@
+import { ModuleStatus } from '../../types';
 import { ResponseType, TippyCustomizedProps } from '../../../Common';
 export declare enum InstallationType {
     OSS_KUBECTL = "oss_kubectl",
     OSS_HELM = "oss_helm",
     ENTERPRISE = "enterprise"
 }
-export declare enum ModuleStatus {
-    HEALTHY = "healthy",
-    NONE = "none",
-    UNKNOWN = "unknown",
-    UPGRADING = "upgrading",
-    UPGRADE_FAILED = "upgradeFailed",
-    INSTALLED = "installed",
-    INSTALLING = "installing",
-    INSTALL_FAILED = "installFailed",
-    NOT_INSTALLED = "notInstalled",
-    TIMEOUT = "timeout"
-}
 export interface PageHeaderType {
     headerName?: string;
     showTabs?: boolean;

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

@@ -1,4 +1,6 @@
-import { GetPluginStoreDataReturnType, GetPluginStoreDataServiceParamsType, PluginDetailServiceParamsType } from './types';
-export declare const getPluginsDetail: ({ appId, parentPluginIds, pluginIds, shouldShowError, }: PluginDetailServiceParamsType) => Promise<Pick<GetPluginStoreDataReturnType, "pluginStore">>;
+import { ResponseType } from '../../../Common';
+import { GetPluginStoreDataReturnType, GetPluginStoreDataServiceParamsType, MinParentPluginDTO, PluginDetailServiceParamsType } from './types';
+export declare const getPluginsDetail: ({ appId, parentPluginIds, pluginIds, signal, 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[]>;
+export declare const getParentPluginList: (appId?: number) => Promise<ResponseType<MinParentPluginDTO[]>>;

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

@@ -7,9 +7,13 @@ export declare enum PluginCreationType {
     SHARED = "SHARED",
     PRESET = "PRESET"
 }
-export interface GetPluginTagsPayloadType {
+export interface PluginAPIBaseQueryParamsType {
     appId: number;
 }
+export interface GetPluginTagsPayloadType extends PluginAPIBaseQueryParamsType {
+}
+export interface GetParentPluginListPayloadType extends PluginAPIBaseQueryParamsType {
+}
 export interface PluginTagNamesDTO {
     tagNames: string[];
 }
@@ -44,6 +48,9 @@ export interface ParentPluginDTO {
     type: PluginCreationType;
     icon: string;
     pluginVersions: PluginVersionsDTO;
+    pluginIdentifier: string;
+}
+export interface MinParentPluginDTO extends Pick<ParentPluginDTO, 'id' | 'name' | 'icon'> {
 }
 export interface PluginDetailDTO {
     parentPlugins: ParentPluginDTO[];
@@ -57,6 +64,7 @@ export interface PluginDetailServiceParamsType {
      * @default true
      */
     shouldShowError?: boolean;
+    signal?: AbortSignal;
 }
 export interface PluginDetailPayloadType extends Pick<PluginDetailServiceParamsType, 'appId'> {
     pluginId?: PluginDetailServiceParamsType['pluginIds'];
@@ -65,11 +73,11 @@ export interface PluginDetailPayloadType extends Pick<PluginDetailServiceParamsT
 export interface PluginListFiltersType extends Pick<BaseFilterQueryParams<unknown>, 'searchKey'> {
     selectedTags: string[];
 }
-interface ParentPluginType extends Pick<ParentPluginDTO, 'id' | 'name' | 'description' | 'type' | 'icon'> {
+interface ParentPluginType extends Pick<ParentPluginDTO, 'id' | 'name' | 'description' | 'type' | 'icon' | 'pluginIdentifier'> {
     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'> {
+interface DetailedPluginVersionType extends Pick<MinimalPluginVersionDataDTO, 'id' | 'description' | 'name' | 'pluginVersion'>, Pick<DetailedPluginVersionDTO, 'tags' | 'isLatest' | 'inputVariables' | 'outputVariables' | 'updatedBy' | 'docLink'>, Pick<ParentPluginType, 'icon' | 'type' | 'pluginIdentifier'> {
     parentPluginId: ParentPluginType['id'];
 }
 export interface PluginDataStoreType {

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

@@ -1,3 +1,5 @@
+import { OptionProps } from 'react-select';
+import { OptionType } from '../../../Common/Types';
 import { ParentPluginDTO, PluginDataStoreType } from './types';
 export declare const parsePluginDetailsDTOIntoPluginStore: (pluginData: ParentPluginDTO[]) => PluginDataStoreType;
 export declare const pluginTagSelectStyles: {
@@ -13,6 +15,7 @@ export declare const pluginTagSelectStyles: {
     group: (base: any) => any;
     groupHeading: (base: any) => any;
 };
+export declare const PluginTagOption: (props: OptionProps<OptionType, true>) => JSX.Element;
 /**
  * @description This method takes the initial plugin data store and updates the keys with the target parent plugin store and plugin version store
  */

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

@@ -134,5 +134,5 @@ import { SelectPickerProps } from './type';
  * />
  * ```
  */
-declare const SelectPicker: <OptionValue, IsMulti extends boolean>({ error, icon, helperText, placeholder, label, showSelectedOptionIcon, size, disabledTippyContent, showSelectedOptionsCount, menuSize, menuPosition, variant, disableDescriptionEllipsis, multiSelectProps, isMulti, name, classNamePrefix, shouldRenderCustomOptions, isSearchable, selectRef, shouldMenuAlignRight, fullWidth, customSelectedOptionsCount, ...props }: SelectPickerProps<OptionValue, IsMulti>) => JSX.Element;
+declare const SelectPicker: <OptionValue, IsMulti extends boolean>({ error, icon, helperText, placeholder, label, showSelectedOptionIcon, size, disabledTippyContent, showSelectedOptionsCount, menuSize, optionListError, reloadOptionList, menuPosition, variant, disableDescriptionEllipsis, multiSelectProps, isMulti, name, classNamePrefix, shouldRenderCustomOptions, isSearchable, selectRef, shouldMenuAlignRight, fullWidth, customSelectedOptionsCount, ...props }: SelectPickerProps<OptionValue, IsMulti>) => JSX.Element;
 export default SelectPicker;

package/dist/Shared/Components/SelectPicker/type.d.ts

@@ -1,3 +1,4 @@
+import { ServerErrors } from '../../../Common/ServerError';
 import { OptionType } from '../../../Common/Types';
 import { ComponentSizeType } from '../../constants';
 import { MutableRefObject, ReactElement, ReactNode } from 'react';
@@ -44,7 +45,7 @@ export declare enum SelectPickerVariantType {
     DEFAULT = "default",
     BORDER_LESS = "border-less"
 }
-export type SelectPickerProps<OptionValue = number | string, IsMulti extends boolean = false> = Pick<SelectProps<OptionValue, IsMulti>, 'name' | 'classNamePrefix' | 'options' | 'value' | 'onChange' | 'isSearchable' | 'isClearable' | 'hideSelectedOptions' | 'controlShouldRenderValue' | 'closeMenuOnSelect' | 'isDisabled' | 'isLoading' | 'required' | 'isOptionDisabled' | 'placeholder' | 'menuPosition' | 'getOptionLabel' | 'getOptionValue' | 'isOptionSelected' | 'menuIsOpen' | 'onMenuOpen' | 'onMenuClose' | 'autoFocus' | 'onBlur'> & Partial<Pick<SelectProps<OptionValue, IsMulti>, 'renderMenuListFooter' | 'shouldRenderCustomOptions' | 'renderCustomOptions'>> & Required<Pick<SelectProps<OptionValue, IsMulti>, 'inputId'>> & {
+export type SelectPickerProps<OptionValue = number | string, IsMulti extends boolean = false> = Pick<SelectProps<OptionValue, IsMulti>, 'name' | 'classNamePrefix' | 'options' | 'value' | 'onChange' | 'isSearchable' | 'isClearable' | 'hideSelectedOptions' | 'controlShouldRenderValue' | 'closeMenuOnSelect' | 'isDisabled' | 'isLoading' | 'required' | 'isOptionDisabled' | 'placeholder' | 'menuPosition' | 'getOptionLabel' | 'getOptionValue' | 'isOptionSelected' | 'menuIsOpen' | 'onMenuOpen' | 'onMenuClose' | 'autoFocus' | 'onBlur' | 'onKeyDown'> & Partial<Pick<SelectProps<OptionValue, IsMulti>, 'renderMenuListFooter' | 'shouldRenderCustomOptions' | 'renderCustomOptions'>> & Required<Pick<SelectProps<OptionValue, IsMulti>, 'inputId'>> & {
     /**
      * Icon to be rendered in the control
      */
@@ -125,6 +126,14 @@ export type SelectPickerProps<OptionValue = number | string, IsMulti extends boo
      * @default false
      */
     fullWidth?: boolean;
+    /**
+     * If truthy, would show generic section error state as no options message
+     */
+    optionListError?: ServerErrors;
+    /**
+     * Would reload the option list when called in case optionListError is present
+     */
+    reloadOptionList?: () => void;
 } & (IsMulti extends true ? {
     isMulti: IsMulti | boolean;
     multiSelectProps?: Pick<CreatableProps<SelectPickerOptionType<OptionValue>, true, GroupBase<SelectPickerOptionType<OptionValue>>>, 'onCreateOption'> & {

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

@@ -36,5 +36,6 @@ export * from './ShowMoreText';
 export * from './CollapsibleList';
 export * from './DeploymentConfigDiff';
 export * from './DetectBottom';
+export * from './EditImageFormField';
 export * from './Collapse';
 export * from './FilterButton';

package/dist/Shared/constants.d.ts

@@ -391,6 +391,7 @@ export declare enum ComponentSizeType {
     medium = "medium",
     large = "large"
 }
+export declare const POP_UP_MENU_MODAL_ID = "popup";
 /**
  * Identifiers for grouped / all resources
  */

package/dist/Shared/validations.d.ts

@@ -13,6 +13,7 @@ export declare const MESSAGES: {
     VALID_POSITIVE_NUMBER: string;
     VALID_POSITIVE_INTEGER: string;
     MAX_SAFE_INTEGER: string;
+    INVALID_SEMANTIC_VERSION: string;
 };
 export declare const requiredField: (value: string) => ValidationResponseType;
 export declare const validateName: (name: string) => ValidationResponseType;
@@ -30,4 +31,14 @@ export declare const validateUniqueKeys: (keys: string[]) => {
     isValid: boolean;
     message: string;
 };
+/**
+ * Rules for valid semantic version:
+ * 1. version.length < 128 and not empty
+ * 2. version should follow semantic versioning regex from https://semver.org/
+ */
+export declare const validateSemanticVersioning: (version: string) => ValidationResponseType;
+/**
+ * A valid display name should be between 3 and 50 characters
+ */
+export declare const validateDisplayName: (name: string) => ValidationResponseType;
 export declare const validateJSON: (json: string) => ValidationResponseType;