@devtron-labs/devtron-fe-common-lib 1.10.9-beta-1 → 1.10.10

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@devtron-labs/devtron-fe-common-lib",
-    "version": "1.10.9-beta-1",
+    "version": "1.10.10",
     "description": "Supporting common component library",
     "type": "module",
     "main": "dist/index.js",

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

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

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

@@ -1,30 +0,0 @@
-import { ResourceKindType, BaseAppMetaData } from '../../index';
-import { ThemeConfigType, ThemePreferenceType } from '@Shared/Providers/ThemeProvider/types';
-import { UserPreferencesType, ViewIsPipelineRBACConfiguredRadioTabs, UpdatedUserPreferencesType } 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 resourceTypes: ResourceKindType[];
-/**
- * @description This function updates the user preferences in the server. It constructs a payload with the updated user preferences and sends a PATCH request to the server. If the request is successful, it returns true. If an error occurs, it shows an error message and returns false.
- * @param updatedUserPreferences - The updated user preferences to be sent to the server.
- * @param recentlyVisitedDevtronApps - The recently visited Devtron apps to be sent to the server.
- * @param shouldThrowError - A boolean indicating whether to throw an error if the request fails. Default is false.
- * @returns A promise that resolves to true if the request is successful, or false if an error occurs.
- * @throws Will throw an error if `shouldThrowError` is true and the request fails.
- */
-export type UpdateUserPreferencesProps = {
-    type: 'updateTheme';
-    value: ThemePreferenceType | null;
-    appTheme: ThemeConfigType['appTheme'];
-} | {
-    type: 'updatePipelineRBACView';
-    value: ViewIsPipelineRBACConfiguredRadioTabs;
-} | {
-    type: 'updateRecentlyVisitedApps';
-    value: BaseAppMetaData[];
-};
-export declare const updateUserPreferences: (updatedUserPreferences?: UpdatedUserPreferencesType, recentlyVisitedDevtronApps?: BaseAppMetaData[], shouldThrowError?: boolean) => Promise<boolean>;

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

@@ -1,60 +0,0 @@
-import { AppThemeType, BaseAppMetaData, ResourceKindType } from '../../index';
-import { ThemeConfigType, ThemePreferenceType } from '@Shared/Providers/ThemeProvider/types';
-import { USER_PREFERENCES_ATTRIBUTE_KEY } from '@Shared/Hooks/useUserPreferences/constants';
-export interface GetUserPreferencesQueryParamsType {
-    key: typeof USER_PREFERENCES_ATTRIBUTE_KEY;
-}
-export declare enum ViewIsPipelineRBACConfiguredRadioTabs {
-    ALL_ENVIRONMENTS = "All environments",
-    ACCESS_ONLY = "Access only"
-}
-export declare enum UserPreferenceResourceActions {
-    RECENTLY_VISITED = "recently-visited"
-}
-export interface UserResourceKindActionType {
-    [UserPreferenceResourceActions.RECENTLY_VISITED]: BaseAppMetaData[];
-}
-export interface UserPreferenceResourceType {
-    [ResourceKindType.devtronApplication]: UserResourceKindActionType;
-}
-export interface GetUserPreferencesParsedDTO {
-    viewPermittedEnvOnly?: boolean;
-    /**
-     * Computed app theme for the user
-     *
-     * Could be 'light' | 'dark' | 'system-light' | 'system-dark'
-     */
-    computedAppTheme?: AppThemeType | `system-${AppThemeType}`;
-    /**
-     * @description resources object with key as resource kind and value as ResourceType
-     *
-     */
-    resources?: UserPreferenceResourceType;
-}
-export interface UserPreferencesPayloadValueType extends GetUserPreferencesParsedDTO {
-}
-export interface UpdateUserPreferencesPayloadType extends Pick<GetUserPreferencesQueryParamsType, 'key'> {
-    value: string;
-}
-export interface UserPreferencesType {
-    /**
-     * Preferred theme for the user
-     * If null, would forcibly show user theme switcher dialog for user to select
-     */
-    themePreference?: ThemePreferenceType | null;
-    /**
-     * @type {ViewIsPipelineRBACConfiguredRadioTabs}
-     * @description pipelineRBACViewSelectedTab is used to store the selected tab in the pipeline RBAC view
-     * @default ViewIsPipelineRBACConfiguredRadioTabs.VIEW_PERMITTED_ENV
-     */
-    pipelineRBACViewSelectedTab?: ViewIsPipelineRBACConfiguredRadioTabs;
-    /**
-     * @description resources object
-     */
-    resources?: GetUserPreferencesParsedDTO['resources'];
-}
-export interface UpdatedUserPreferencesType extends UserPreferencesType, Pick<ThemeConfigType, 'appTheme'> {
-}
-export interface UseUserPreferencesProps {
-    migrateUserPreferences?: (userPreferencesResponse: UserPreferencesType) => Promise<UserPreferencesType>;
-}

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

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