@devtron-labs/devtron-fe-common-lib 1.19.4 → 1.20.0-alpha-4

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}`;
 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/ToastManager/ToastContent.d.ts

@@ -1,2 +1,3 @@
-import { ToastProps } from './types';
+import { ShortcutToastContentProps, ToastProps } from './types';
 export declare const ToastContent: ({ title, description, buttonProps, }: Pick<ToastProps, "title" | "description" | "buttonProps">) => JSX.Element;
+export declare const ShortcutToastContent: ({ shortcuts, text }: ShortcutToastContentProps) => JSX.Element;

package/dist/Shared/Services/ToastManager/constants.d.ts

@@ -1,4 +1,4 @@
 import { ToastContainerProps, ToastOptions } from 'react-toastify';
-import { ToastProps, ToastVariantType } from './types';
+import { BaseToastProps, ToastProps } from './types';
 export declare const TOAST_BASE_CONFIG: ToastContainerProps;
-export declare const TOAST_VARIANT_TO_CONFIG_MAP: Record<ToastVariantType, Required<Pick<ToastProps, 'icon' | 'title' | 'progressBarBg'>> & Pick<ToastOptions, 'type'>>;
+export declare const TOAST_VARIANT_TO_CONFIG_MAP: Record<BaseToastProps['variant'], Required<Pick<ToastProps, 'icon' | 'title' | 'progressBarBg'>> & Pick<ToastOptions, 'type'>>;

package/dist/Shared/Services/ToastManager/toastManager.service.d.ts

@@ -65,7 +65,7 @@ declare class ToastManager {
     /**
      * Handler for showing the toast
      */
-    showToast: ({ variant, icon: customIcon, title, description, buttonProps, progressBarBg: customProgressBarBg, }: ToastProps, options?: Pick<ToastOptions, "autoClose">) => import('react-toastify').Id;
+    showToast: ({ variant, icon: customIcon, title, description, buttonProps, progressBarBg: customProgressBarBg, text, shortcuts, }: ToastProps, options?: Pick<ToastOptions, "autoClose">) => import('react-toastify').Id;
     /**
      * Handler for dismissing an existing toast
      */

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

@@ -1,13 +1,28 @@
 import { ReactElement } from 'react';
+import { SupportedKeyboardKeysType } from '../../../Common/Hooks';
 import { ButtonComponentType, ButtonProps } from '../../Components';
 export declare enum ToastVariantType {
     info = "info",
     success = "success",
     error = "error",
     warn = "warn",
-    notAuthorized = "notAuthorized"
+    notAuthorized = "notAuthorized",
+    shortcut = "shortcut"
 }
-export interface ToastProps {
+export interface ShortcutToastProps {
+    variant: ToastVariantType.shortcut;
+    /**
+     * Text to display along the shortcuts in the toast
+     * Example: "Press [S] to switch context"
+     */
+    text: string;
+    /**
+     * The shortcuts to be displayed in the toast
+     * Note: The shortcuts should be in the format of `['Ctrl', 'A']
+     */
+    shortcuts: SupportedKeyboardKeysType[];
+}
+export interface BaseToastProps {
     /**
      * Title for the toast
      * If not provided, defaults to a value based on the selected variant
@@ -26,7 +41,7 @@ export interface ToastProps {
      *
      * @default ToastVariantType.info
      */
-    variant?: ToastVariantType;
+    variant?: Exclude<ToastVariantType, ToastVariantType.shortcut>;
     /**
      * Props for the action button to be displayed in the toast
      *
@@ -38,3 +53,8 @@ export interface ToastProps {
      */
     progressBarBg?: string;
 }
+export type ToastProps = (BaseToastProps & Partial<Record<Exclude<keyof ShortcutToastProps, 'variant'>, never>>) | (ShortcutToastProps & Partial<Record<Exclude<keyof BaseToastProps, 'variant'>, never>>);
+export interface ShortcutToastContentProps {
+    text: string;
+    shortcuts: SupportedKeyboardKeysType[];
+}

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

@@ -1,11 +1,11 @@
 import { AppConfigProps } from '../../Pages/index';
 import { ResponseType } from '../../Common';
-import { AppEnvDeploymentConfigDTO, AppEnvDeploymentConfigPayloadType, CIMaterialInfoType, GetCITriggerInfoParamsType } from './app.types';
-export declare const getCITriggerInfo: (params: GetCITriggerInfoParamsType) => Promise<CIMaterialInfoType>;
+import { AppEnvDeploymentConfigDTO, AppEnvDeploymentConfigPayloadType, CIMaterialInfoDTO, GetCITriggerInfoParamsType } from './app.types';
+export declare const getCITriggerInfo: (params: GetCITriggerInfoParamsType) => Promise<ResponseType<CIMaterialInfoDTO>>;
 /**
  * The only difference between this and getCITriggerInfo is it doesn't have env and trigger related meta info
  */
-export declare const getArtifactInfo: (params: Pick<GetCITriggerInfoParamsType, "ciArtifactId">) => Promise<CIMaterialInfoType>;
+export declare const getArtifactInfo: (params: Pick<GetCITriggerInfoParamsType, "ciArtifactId">) => Promise<ResponseType<CIMaterialInfoDTO>>;
 export declare const getAppEnvDeploymentConfig: ({ params, signal, isTemplateView, appId, }: {
     params: AppEnvDeploymentConfigPayloadType;
     signal?: AbortSignal;

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 {};