@devtron-labs/devtron-fe-common-lib 1.20.3 → 1.20.4-pre-1

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

@@ -96,9 +96,11 @@ export type TreeItem<DataAttributeType = null> = BaseNode<DataAttributeType> & {
     onClick?: (e: SyntheticEvent) => void;
     href?: never;
     clearQueryParamsOnNavigation?: never;
+    activeClassName?: never;
 } | {
     as: 'link';
     href: string;
+    activeClassName?: string;
     /**
      * The callback function to handle click events on the nav link.
      */
@@ -113,6 +115,7 @@ export type TreeItem<DataAttributeType = null> = BaseNode<DataAttributeType> & {
     href?: never;
     onClick?: never;
     clearQueryParamsOnNavigation?: never;
+    activeClassName?: never;
 });
 /**
  * Props for the TreeView component.
@@ -151,14 +154,25 @@ export type TreeViewProps<DataAttributeType = null> = {
      */
     mode?: 'navigation' | 'form';
     /**
-     * If primary the background color will be bg__primary and bg__hover--opaque, if secondary the background color will be bg__secondary bg__hover-secondary--opaque.
+     * If primary the background color will be bg__primary and bg__hover--opaque \
+     * if secondary the background color will be bg__secondary bg__hover-secondary--opaque,
+     * if sidenav the background color will be bg__transparent bg__hover-sidebar-item.
      * @default 'primary'
      */
-    variant?: 'primary' | 'secondary';
+    variant?: 'primary' | 'secondary' | 'sidenav';
     /**
      * @default {}
      */
     defaultExpandedMap?: Record<string, boolean>;
+    /**
+     * When true, the selected heading (`selectedId`) will be highlighted only when it is collapsed.
+     * @default false
+     */
+    highlightSelectedHeadingOnlyWhenCollapsed?: boolean;
+    /**
+     * @default true
+     */
+    useOverflowAuto?: boolean;
 } /**
  * WARNING: For internal use only.
  */ & ({
@@ -188,7 +202,7 @@ export type TreeViewProps<DataAttributeType = null> = {
     expandedMap?: never;
     isControlled?: false;
 });
-export interface TreeViewNodeContentProps extends Pick<BaseNode, 'startIconConfig' | 'title' | 'subtitle' | 'customTooltipConfig' | 'strikeThrough'> {
+export interface TreeViewNodeContentProps extends Pick<BaseNode, 'startIconConfig' | 'title' | 'subtitle' | 'customTooltipConfig' | 'strikeThrough'>, Required<Pick<TreeViewProps, 'variant'>> {
     type: 'heading' | 'item';
     isSelected: boolean;
 }

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

@@ -13,6 +13,7 @@ export * from './BulkSelection';
 export * from './Button';
 export * from './ButtonWithLoader';
 export * from './ButtonWithSelector';
+export * from './Charts';
 export * from './Chip';
 export * from './CICDHistory';
 export * from './CMCS';
@@ -59,6 +60,7 @@ export * from './ImageWithFallback';
 export * from './InfoBlock';
 export * from './InfoIconTippy';
 export * from './InvalidYAMLTippy';
+export * from './KeyboardShortcut';
 export * from './KeyValueTable';
 export * from './License';
 export { default as LoadingCard } from './LoadingCard';
@@ -71,6 +73,7 @@ export * from './Plugin';
 export * from './Popover';
 export * from './PortalContainer';
 export * from './ProgressBar';
+export * from './PrometheusConfigurations';
 export { default as QRCode } from './QRCode';
 export * from './ReactSelect';
 export * from './RegistryIcon';
@@ -78,6 +81,7 @@ export * from './ScannedByToolModal';
 export * from './Security';
 export * from './SelectPicker';
 export * from './ShowMoreText';
+export * from './SideNavigation';
 export * from './SSOProviderIcon';
 export * from './StatusComponent';
 export * from './Switch';

package/dist/Shared/Helpers.d.ts

@@ -103,4 +103,5 @@ export declare const clearCookieOnLogout: () => void;
 export declare const getAppDetailsURL: (appId: number | string, envId?: number | string) => string;
 export declare const smoothScrollToTop: (scrollContainer: HTMLElement, targetPosition: number) => import('framer-motion').AnimationPlaybackControls;
 export declare const getGroupVersionFromApiVersion: (apiVersion: string) => Pick<Node, "group" | "version">;
+export declare const YAMLtoJSON: (yamlString: string) => string;
 export {};

package/dist/Shared/Hooks/useGetResourceKindsOptions/service.d.ts

@@ -1,7 +1,2 @@
 import { Teams } from '../../../Common/Types';
-import { ClusterType } from '../../Services';
-import { AppsGroupedByProjectsType, EnvironmentsGroupedByClustersType } from './types';
-export declare const getAppOptionsGroupedByProjects: () => Promise<AppsGroupedByProjectsType>;
 export declare const getProjectOptions: () => Promise<Pick<Teams, "id" | "name">[]>;
-export declare const getClusterOptions: () => Promise<ClusterType[]>;
-export declare const getEnvironmentOptionsGroupedByClusters: () => Promise<EnvironmentsGroupedByClustersType>;

package/dist/Shared/Hooks/useGetResourceKindsOptions/types.d.ts

@@ -1,24 +1,9 @@
+import { getAppOptionsGroupedByProjects } from '../../../Common/Common.service';
 import { ServerErrors } from '../../../Common/ServerError';
-import { EnvironmentType, ResourceKindType } from '../../types';
-import { getAppOptionsGroupedByProjects, getClusterOptions, getProjectOptions } from './service';
-export interface AppType {
-    name: string;
-}
-export type AppsGroupedByProjectsType = {
-    projectId: number;
-    projectName: string;
-    appList: AppType[];
-}[];
-export type EnvironmentsGroupedByClustersType = {
-    clusterName: EnvironmentType['cluster'];
-    envList: EnvironmentType[];
-}[];
-export interface ClusterDTO {
-    id: number;
-    cluster_name: string;
-    isVirtualCluster: boolean;
-    isProd: boolean;
-}
+import { EnvironmentsGroupedByClustersType } from '../../../Common/Types';
+import { getClusterOptions } from '../../index';
+import { ResourceKindType } from '../../types';
+import { getProjectOptions } from './service';
 export interface UseGetResourceKindsOptionsProps {
     resourcesToFetch: Extract<ResourceKindType, ResourceKindType.devtronApplication | ResourceKindType.project | ResourceKindType.cluster | ResourceKindType.environment>[];
 }

package/dist/Shared/Hooks/useUserPreferences/service.d.ts

@@ -4,7 +4,7 @@ import { PreferredResourceKindType, UserPreferenceFilteredListTypes, UserPrefere
  * @description This function fetches the user preferences from the server. It uses the `get` method to make a request to the server and retrieves the user preferences based on the `USER_PREFERENCES_ATTRIBUTE_KEY`. The result is parsed and returned as a `UserPreferencesType` object.
  * @throws Will throw an error if the request fails or if the result is not in the expected format.
  */
-export declare const getUserPreferences: () => Promise<UserPreferencesType>;
+export declare const getUserPreferences: (signal?: AbortSignal) => Promise<UserPreferencesType>;
 export declare const updateUserPreferences: ({ path, value, resourceKind, shouldThrowError, userPreferencesResponse, }: UserPreferenceResourceProps) => Promise<boolean>;
 /**
  * Optimized function to get updated user preferences with resource filtering

package/dist/Shared/Hooks/useUserPreferences/types.d.ts

@@ -1,6 +1,8 @@
 import { USER_PREFERENCES_ATTRIBUTE_KEY } from './constants';
 import { AppThemeType, ThemeConfigType, ThemePreferenceType } from '../../Providers/ThemeProvider/types';
 import { ResourceKindType } from '../../types';
+export type NavigationItemID = 'application-management-overview' | 'application-management-applications' | 'application-management-application-groups' | 'application-management-chart-store' | 'application-management-bulk-edit' | 'application-management-application-templates' | 'application-management-projects' | 'application-management-configurations' | 'application-management-policies' | 'infrastructure-management-overview' | 'infrastructure-management-resource-browser' | 'infrastructure-management-resource-watcher' | 'infrastructure-management-catalog-framework' | 'software-release-management-overview' | 'software-release-management-release-hub' | 'software-release-management-tenants' | 'cost-visibility-overview' | 'cost-visibility-cost-breakdown' | 'cost-visibility-configurations' | 'security-center-overview' | 'security-center-security-scans' | 'security-center-security-policy' | 'automation-and-enablement-jobs' | 'automation-and-enablement-alerting' | 'automation-and-enablement-incident-response' | 'automation-and-enablement-api-portal' | 'automation-and-enablement-runbook-automation' | 'global-configuration-sso-login-services' | 'global-configuration-host-urls' | 'global-configuration-cluster-and-environments' | 'global-configuration-container-oci-registry' | 'global-configuration-authorization' | 'backup-and-restore-overview' | 'backup-and-restore-backup-and-schedule' | 'backup-and-restore-restores' | 'backup-and-restore-backup-repositories' | 'backup-and-restore-backup-locations' | 'backup-and-restore-history-and-logs' | 'ai-recommendations-overview';
+export type NavigationSubMenuItemID = 'application-management-configurations-gitops' | 'application-management-configurations-git-accounts' | 'application-management-configurations-external-links' | 'application-management-configurations-chart-repository' | 'application-management-configurations-deployment-charts' | 'application-management-configurations-notifications' | 'application-management-configurations-catalog-frameworks' | 'application-management-configurations-scoped-variables' | 'application-management-configurations-build-infra' | 'application-management-policies-deployment-window' | 'application-management-policies-approval-policy' | 'application-management-policies-plugin-policy' | 'application-management-policies-pull-image-digest' | 'application-management-policies-tag-policy' | 'application-management-policies-filter-conditions' | 'application-management-policies-image-promotion' | 'application-management-policies-lock-deployment-configuration' | 'cost-visibility-cost-breakdown-clusters' | 'cost-visibility-cost-breakdown-environments' | 'cost-visibility-cost-breakdown-projects' | 'cost-visibility-cost-breakdown-applications' | 'global-configuration-authorization-user-permissions' | 'global-configuration-authorization-permission-groups' | 'global-configuration-authorization-api-tokens';
 export interface GetUserPreferencesQueryParamsType {
     key: typeof USER_PREFERENCES_ATTRIBUTE_KEY;
 }
@@ -23,6 +25,7 @@ export interface UserResourceKindActionType {
     [UserPreferenceResourceActions.RECENTLY_VISITED]: BaseRecentlyVisitedEntitiesTypes[];
 }
 export type UserPreferenceResourceType = Partial<Record<PreferredResourceKindType, UserResourceKindActionType>>;
+export type CommandBarAdditionalItemsId = 'app-management-devtron-app-list' | 'app-management-helm-app-list' | 'app-management-flux-app-list' | 'app-management-argo-app-list' | `app-management-devtron-app-list-${number}` | 'search-app-list-view' | `chart-list-${number}` | 'search-chart-list-view' | `helm-app-list-${number}` | 'search-helm-app-list-view' | `cluster-list-${number}` | 'search-cluster-list-view';
 export interface GetUserPreferencesParsedDTO {
     viewPermittedEnvOnly?: boolean;
     /**
@@ -36,13 +39,18 @@ export interface GetUserPreferencesParsedDTO {
      *
      */
     resources?: UserPreferenceResourceType;
+    commandBar: {
+        recentNavigationActions: {
+            id: NavigationItemID | NavigationSubMenuItemID | CommandBarAdditionalItemsId;
+        }[];
+    };
 }
 export interface UserPreferencesPayloadValueType extends GetUserPreferencesParsedDTO {
 }
 export interface UpdateUserPreferencesPayloadType extends Pick<GetUserPreferencesQueryParamsType, 'key'> {
     value: string;
 }
-export interface UserPreferencesType {
+export interface UserPreferencesType extends Pick<GetUserPreferencesParsedDTO, 'commandBar'> {
     /**
      * Preferred theme for the user
      * If null, would forcibly show user theme switcher dialog for user to select
@@ -69,7 +77,7 @@ export interface UseUserPreferencesProps {
     migrateUserPreferences?: (userPreferencesResponse: UserPreferencesType) => Promise<UserPreferencesType>;
     recentlyVisitedFetchConfig?: RecentlyVisitedFetchConfigType;
 }
-export type UserPathValueMapType = {
+type UserPathValueMapType = {
     path: 'themePreference';
     value: Required<Pick<UpdatedUserPreferencesType, 'themePreference' | 'appTheme'>>;
     resourceKind?: never;
@@ -84,7 +92,28 @@ export type UserPathValueMapType = {
     value: Required<BaseRecentlyVisitedEntitiesTypes[]>;
     resourceKind: PreferredResourceKindType;
     userPreferencesResponse?: UserPreferencesType;
+} | {
+    path: 'commandBar.recentNavigationActions';
+    value: UserPreferencesType['commandBar']['recentNavigationActions'];
+    resourceKind?: never;
+    userPreferencesResponse?: never;
 };
+export type GetUserPreferencePayloadParams = {
+    userPreferencesResponse: UserPreferencesType;
+    resourceKind?: PreferredResourceKindType;
+} & ({
+    path: 'themePreference';
+    value: Required<Pick<UpdatedUserPreferencesType, 'themePreference' | 'appTheme'>>;
+} | {
+    path: 'pipelineRBACViewSelectedTab';
+    value: Required<Pick<UserPreferencesType, 'pipelineRBACViewSelectedTab'>>;
+} | {
+    path: 'resources';
+    value: Required<BaseRecentlyVisitedEntitiesTypes[]>;
+} | {
+    path: 'commandBar.recentNavigationActions';
+    value: UserPreferencesType['commandBar']['recentNavigationActions'];
+});
 export type UserPreferenceResourceProps = UserPathValueMapType & {
     shouldThrowError?: boolean;
     userPreferencesResponse?: UserPreferencesType;
@@ -92,3 +121,4 @@ export type UserPreferenceResourceProps = UserPathValueMapType & {
 export interface UserPreferenceFilteredListTypes extends UserPreferenceRecentlyVisitedAppsTypes {
     userPreferencesResponse?: UserPreferencesType;
 }
+export {};

package/dist/Shared/Providers/MainContextProvider/types.d.ts

@@ -21,6 +21,7 @@ export interface SidePanelConfig {
     reinitialize?: boolean;
     /** URL to documentation that should be displayed in the panel */
     docLink: string | null;
+    aiSessionId?: string;
 }
 type AIAgentContextType = {
     path: string;
@@ -39,6 +40,14 @@ export interface TempAppWindowConfig {
     showOpenInNewTab?: boolean;
     /** React component to render in the window */
     component?: JSX.Element;
+    customCloseConfig?: {
+        /**
+         * Provide this method if you want to do something before temp window closes
+         * Provide noop if not relevant
+         * */
+        beforeClose: () => void;
+        icon: JSX.Element;
+    };
 }
 type CommonMainContextProps = {
     setServerMode: (serverMode: SERVER_MODE) => void;

package/dist/Shared/Services/common.service.d.ts

@@ -1,6 +1,8 @@
 import { AppConfigProps } from '../../Pages/index';
+import { ClusterType } from '..';
 import { EnvironmentDataValuesDTO, GetPolicyApiUrlProps, GetResourceApiUrlProps } from './types';
 export declare const getResourceApiUrl: <T>({ baseUrl, kind, version, suffix, queryParams }: GetResourceApiUrlProps<T>) => string;
 export declare const getPolicyApiUrl: <T>({ kind, version, queryParams, suffix }: GetPolicyApiUrlProps<T>) => string;
 export declare const saveCDPipeline: (request: any, { isTemplateView }: Required<Pick<AppConfigProps, "isTemplateView">>) => Promise<import('../../Common').ResponseType<any>>;
 export declare const getEnvironmentData: () => Promise<import('../../Common').ResponseType<EnvironmentDataValuesDTO>>;
+export declare const getClusterOptions: () => Promise<ClusterType[]>;

package/dist/Shared/Services/types.d.ts

@@ -40,4 +40,10 @@ export interface EnvironmentDataValuesDTO extends Pick<MainContext, 'featureGitO
     devtronManagedLicensingEnabled: boolean;
     isResourceRecommendationEnabled?: boolean;
 }
+export interface ClusterMinDTO {
+    id: number;
+    cluster_name: string;
+    isVirtualCluster: boolean;
+    isProd: boolean;
+}
 export {};

package/dist/Shared/constants.d.ts

@@ -1,6 +1,6 @@
 import { DeploymentNodeType, OptionType } from '../Common/Types';
 import { InfoBlockProps } from './Components';
-import { CDMaterialSidebarType, ConfigKeysWithLockType, ConfigurationType, DeploymentStrategyTypeWithDefault, IconBaseColorType } from './types';
+import { CDMaterialSidebarType, ConfigKeysWithLockType, ConfigurationType, DeploymentStrategyTypeWithDefault, IconBaseColorType, RemoteConnectionType } from './types';
 export declare const ARTIFACT_STATUS: {
     PROGRESSING: string;
     DEGRADED: string;
@@ -434,3 +434,4 @@ export declare const PROGRESSING_DEPLOYMENT_STATUS_POLLING_INTERVAL = 10000;
 export declare const STRATEGY_TYPE_TO_TITLE_MAP: Record<DeploymentStrategyTypeWithDefault, string>;
 export declare const CUBIC_BEZIER_CURVE: [number, number, number, number];
 export declare const ALLOW_ACTION_OUTSIDE_FOCUS_TRAP = "allow-action-outside-focus-trap";
+export declare const REMOTE_CONNECTION_TYPE_LABEL_MAP: Record<RemoteConnectionType, string>;

package/dist/Shared/types.d.ts

@@ -1114,4 +1114,24 @@ export interface PipelineDeploymentStrategy {
     strategies: Strategy[];
     error: ServerError;
 }
+export declare enum RemoteConnectionType {
+    Direct = "DIRECT",
+    Proxy = "PROXY",
+    SSHTunnel = "SSH"
+}
+export declare enum AuthenticationType {
+    BASIC = "BASIC",
+    ANONYMOUS = "ANONYMOUS",
+    IAM = "IAM"
+}
+/**
+ * Makes all props in T optional and set to never when isLoading is true.
+ * Used for components with loading states.
+ * @example See usage in CostVisibility -> cards
+ */
+export type PropsTypeWithIsLoading<T extends Record<string, any>> = (Partial<Record<keyof T, never>> & {
+    isLoading: true;
+}) | ({
+    isLoading?: false;
+} & T);
 export {};