@devtron-labs/devtron-fe-common-lib 1.17.0-beta-5 → 1.17.0-beta-7

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

@@ -1,5 +1,3 @@
 export declare const post: <T = any, K = object>(url: string, data: K, options?: import('..').APIOptions, isMultipartRequest?: boolean) => Promise<import('..').ResponseType<T>>, put: <T = any, K = object>(url: string, data: K, options?: import('..').APIOptions) => Promise<import('..').ResponseType<T>>, patch: <T = any, K = object>(url: string, data: K, options?: import('..').APIOptions) => Promise<import('..').ResponseType<T>>, get: <T = any>(url: string, options?: import('..').APIOptions) => Promise<import('..').ResponseType<T>>, trash: <T = any, K = object>(url: string, data?: K, options?: import('..').APIOptions) => Promise<import('..').ResponseType<T>>;
 export { default as CoreAPI } from './CoreAPI';
-export { QueryClientProvider } from './QueryClientProvider';
-export * from './useQueryClient';
 export { abortPreviousRequests, getIsRequestAborted, handleRedirectToLicenseActivation } from './utils';

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

@@ -0,0 +1,2 @@
+import { ContextSwitcherTypes } from './types';
+export declare const ContextSwitcher: ({ inputId, options, inputValue, onInputChange, isLoading, value, onChange, placeholder, filterOption, formatOptionLabel, optionListError, reloadOptionList, classNamePrefix, }: ContextSwitcherTypes) => JSX.Element;

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

@@ -0,0 +1,3 @@
+export { ContextSwitcher } from './ContextSwitcher';
+export type { ContextSwitcherTypes, RecentlyVisitedGroupedOptionsType, RecentlyVisitedOptions } from './types';
+export { getMinCharSearchPlaceholderGroup } from './utils';

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

@@ -0,0 +1,14 @@
+import { GroupBase } from 'react-select';
+import { SelectPickerOptionType, SelectPickerProps } from '../SelectPicker';
+export interface ContextSwitcherTypes extends Pick<SelectPickerProps, 'placeholder' | 'onChange' | 'value' | 'isLoading' | 'onInputChange' | 'inputValue' | 'inputId' | 'formatOptionLabel' | 'filterOption' | 'optionListError' | 'reloadOptionList' | 'classNamePrefix'> {
+    options: GroupBase<SelectPickerOptionType<string | number>>[];
+    isAppDataAvailable?: boolean;
+}
+export interface RecentlyVisitedOptions extends SelectPickerOptionType<number> {
+    isDisabled?: boolean;
+    isRecentlyVisited?: boolean;
+}
+export interface RecentlyVisitedGroupedOptionsType extends GroupBase<SelectPickerOptionType<number>> {
+    label: string;
+    options: RecentlyVisitedOptions[];
+}

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

@@ -0,0 +1,5 @@
+import { SelectPickerProps } from '../SelectPicker';
+import { RecentlyVisitedGroupedOptionsType, RecentlyVisitedOptions } from './types';
+export declare const getDisabledOptions: (option: RecentlyVisitedOptions) => SelectPickerProps["isDisabled"];
+export declare const customSelectFilterOption: SelectPickerProps['filterOption'];
+export declare const getMinCharSearchPlaceholderGroup: (resourceKind: string) => RecentlyVisitedGroupedOptionsType;

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

@@ -21,6 +21,7 @@ export * from './CollapsibleList';
 export * from './CommitChipCell';
 export * from './Confetti';
 export * from './ConfirmationModal';
+export * from './ContextSwitcher';
 export * from './CountrySelect';
 export * from './CustomInput';
 export * from './DatePicker';

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

@@ -1 +1,3 @@
+import { PreferredResourceKindType } from './types';
 export declare const USER_PREFERENCES_ATTRIBUTE_KEY = "userPreferences";
+export declare const DEFAULT_RESOURCES_MAP: Record<PreferredResourceKindType, null>;

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

@@ -1,4 +1,4 @@
 export * from './constants';
-export { getUserPreferences, updateUserPreferences } from './service';
+export { getUserPreferences, updateAndPersistUserPreferences, updateUserPreferences } from './service';
 export * from './types';
 export { useUserPreferences } from './useUserPrefrences';

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

@@ -1,8 +1,28 @@
-import { UserPreferenceResourceProps, UserPreferencesType } from './types';
+import { PreferredResourceKindType, UserPreferenceFilteredListTypes, UserPreferenceResourceProps, UserPreferencesType } from './types';
 /**
  * @returns UserPreferencesType
  * @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 updateUserPreferences: ({ path, value, shouldThrowError, }: UserPreferenceResourceProps) => Promise<boolean>;
+export declare const updateUserPreferences: ({ path, value, resourceKind, shouldThrowError, userPreferencesResponse, }: UserPreferenceResourceProps) => Promise<boolean>;
+/**
+ * Optimized function to get updated user preferences with resource filtering
+ * Can work with provided userPreferences or fetch from server/localStorage
+ * Centralizes all resource updating logic
+ */
+export declare const getUpdatedUserPreferences: ({ id, name, resourceKind, userPreferencesResponse, }: UserPreferenceFilteredListTypes & {
+    userPreferencesResponse?: UserPreferencesType;
+}) => Promise<UserPreferencesType>;
+/**
+ * Centralized function to update and persist user preferences
+ * Handles both local state and server updates automatically
+ * Eliminates the need for manual resource management in multiple places
+ */
+export declare const updateAndPersistUserPreferences: ({ id, name, resourceKind, shouldThrowError, updateLocalStorage, }: {
+    id?: number;
+    name?: string;
+    resourceKind?: PreferredResourceKindType;
+    shouldThrowError?: boolean;
+    updateLocalStorage?: boolean;
+}) => Promise<UserPreferencesType>;

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

@@ -1,6 +1,5 @@
 import { USER_PREFERENCES_ATTRIBUTE_KEY } from './constants';
 import { AppThemeType, ThemeConfigType, ThemePreferenceType } from '../../Providers/ThemeProvider/types';
-import { BaseAppMetaData } from '../../Services';
 import { ResourceKindType } from '../../types';
 export interface GetUserPreferencesQueryParamsType {
     key: typeof USER_PREFERENCES_ATTRIBUTE_KEY;
@@ -12,12 +11,18 @@ export declare enum ViewIsPipelineRBACConfiguredRadioTabs {
 export declare enum UserPreferenceResourceActions {
     RECENTLY_VISITED = "recently-visited"
 }
-export interface UserResourceKindActionType {
-    [UserPreferenceResourceActions.RECENTLY_VISITED]: BaseAppMetaData[];
+export type PreferredResourceKindType = ResourceKindType.devtronApplication | ResourceKindType.job | 'app-group' | ResourceKindType.cluster;
+export interface BaseRecentlyVisitedEntitiesTypes {
+    id: number;
+    name: string;
+}
+export interface UserPreferenceRecentlyVisitedAppsTypes extends BaseRecentlyVisitedEntitiesTypes {
+    resourceKind: PreferredResourceKindType;
 }
-export interface UserPreferenceResourceType {
-    [ResourceKindType.devtronApplication]: UserResourceKindActionType;
+export interface UserResourceKindActionType {
+    [UserPreferenceResourceActions.RECENTLY_VISITED]: BaseRecentlyVisitedEntitiesTypes[];
 }
+export type UserPreferenceResourceType = Partial<Record<PreferredResourceKindType, UserResourceKindActionType>>;
 export interface GetUserPreferencesParsedDTO {
     viewPermittedEnvOnly?: boolean;
     /**
@@ -56,26 +61,34 @@ export interface UserPreferencesType {
 }
 export interface UpdatedUserPreferencesType extends UserPreferencesType, Pick<ThemeConfigType, 'appTheme'> {
 }
+export interface RecentlyVisitedFetchConfigType extends UserPreferenceRecentlyVisitedAppsTypes {
+    isDataAvailable?: boolean;
+}
 export interface UseUserPreferencesProps {
+    userPreferenceResourceKind?: PreferredResourceKindType;
     migrateUserPreferences?: (userPreferencesResponse: UserPreferencesType) => Promise<UserPreferencesType>;
+    recentlyVisitedFetchConfig?: RecentlyVisitedFetchConfigType;
 }
 export type UserPathValueMapType = {
     path: 'themePreference';
     value: Required<Pick<UpdatedUserPreferencesType, 'themePreference' | 'appTheme'>>;
+    resourceKind?: never;
+    userPreferencesResponse?: never;
 } | {
     path: 'pipelineRBACViewSelectedTab';
     value: Required<Pick<UserPreferencesType, 'pipelineRBACViewSelectedTab'>>;
+    resourceKind?: never;
+    userPreferencesResponse?: never;
 } | {
     path: 'resources';
-    value: Required<BaseAppMetaData[]>;
+    value: Required<BaseRecentlyVisitedEntitiesTypes[]>;
+    resourceKind: PreferredResourceKindType;
+    userPreferencesResponse?: UserPreferencesType;
 };
 export type UserPreferenceResourceProps = UserPathValueMapType & {
     shouldThrowError?: boolean;
+    userPreferencesResponse?: UserPreferencesType;
 };
-export interface UserPreferenceRecentlyVisitedAppsTypes {
-    appId: number;
-    appName: string;
-}
 export interface UserPreferenceFilteredListTypes extends UserPreferenceRecentlyVisitedAppsTypes {
-    userPreferencesResponse: UserPreferencesType;
+    userPreferencesResponse?: UserPreferencesType;
 }

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

@@ -1,10 +1,12 @@
 import { ServerErrors } from '../../../Common/ServerError';
-import { UserPreferenceRecentlyVisitedAppsTypes, UserPreferencesType, UseUserPreferencesProps, ViewIsPipelineRBACConfiguredRadioTabs } from './types';
-export declare const useUserPreferences: ({ migrateUserPreferences }: UseUserPreferencesProps) => {
+import { BaseRecentlyVisitedEntitiesTypes, UserPreferencesType, UseUserPreferencesProps, ViewIsPipelineRBACConfiguredRadioTabs } from './types';
+export declare const useUserPreferences: ({ migrateUserPreferences, recentlyVisitedFetchConfig }: UseUserPreferencesProps) => {
     userPreferences: UserPreferencesType;
     userPreferencesError: ServerErrors;
     handleFetchUserPreferences: () => Promise<void>;
     handleUpdatePipelineRBACViewSelectedTab: (selectedTab: ViewIsPipelineRBACConfiguredRadioTabs) => void;
     handleUpdateUserThemePreference: (themePreference: UserPreferencesType["themePreference"]) => void;
-    fetchRecentlyVisitedParsedApps: ({ appId, appName }: UserPreferenceRecentlyVisitedAppsTypes) => Promise<void>;
+    fetchRecentlyVisitedParsedEntities: () => Promise<UserPreferencesType>;
+    recentlyVisitedResources: BaseRecentlyVisitedEntitiesTypes[];
+    recentResourcesLoading: boolean;
 };

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

@@ -1,4 +1,3 @@
-import { BaseAppMetaData } from '../../Services';
-import { UserPreferenceFilteredListTypes, UserPreferenceResourceType } from './types';
-export declare const getUserPreferenceResourcesMetadata: (recentlyVisited: BaseAppMetaData[]) => UserPreferenceResourceType;
-export declare const getFilteredUniqueAppList: ({ userPreferencesResponse, appId, appName, }: UserPreferenceFilteredListTypes) => BaseAppMetaData[];
+import { GetUserPreferencesParsedDTO, UserPreferenceFilteredListTypes, UserPreferencesType } from './types';
+export declare const getFilteredUniqueAppList: ({ userPreferencesResponse, id, name, resourceKind, }: UserPreferenceFilteredListTypes) => import('./types').BaseRecentlyVisitedEntitiesTypes[];
+export declare const getParsedResourcesMap: (resources: GetUserPreferencesParsedDTO["resources"]) => UserPreferencesType["resources"];

package/dist/index.d.ts

@@ -174,22 +174,6 @@ declare global {
         _env_: customEnv;
     }
 }
-declare module '@tanstack/react-query' {
-    interface QueryMeta {
-        /**
-         * Optional flag indicating whether to display a toast notification for errors.
-         * @default true
-         */
-        showToastError?: boolean;
-    }
-    interface MutationMeta {
-        /**
-         * Optional flag indicating whether to display a toast notification for errors.
-         * @default true
-         */
-        showToastError?: boolean;
-    }
-}
 export * from './Common';
 export * from './Pages';
 export * from './Shared';