chore: Move TranslationKeyError to OnyxCommon

Author: drminh2807

src/components/DotIndicatorMessage.tsx

@@ -10,8 +10,8 @@ import useThemeStyles from '@hooks/useThemeStyles';
 import {isReceiptError, isTranslationKeyError} from '@libs/ErrorUtils';
 import fileDownload from '@libs/fileDownload';
 import handleRetryPress from '@libs/ReceiptUploadRetryHandler';
-import type {TranslationKeyError} from '@src/languages/types';
 import type {ReceiptError} from '@src/types/onyx/Transaction';
+import type {TranslationKeyError} from '@src/types/onyx/OnyxCommon';
 import ConfirmModal from './ConfirmModal';
 import Icon from './Icon';
 import * as Expensicons from './Icon/Expensicons';

src/components/ErrorMessageRow.tsx

@@ -1,15 +1,14 @@
 import mapValues from 'lodash/mapValues';
 import React from 'react';
 import type {StyleProp, ViewStyle} from 'react-native';
-import type {TranslationKeyError, TranslationKeyErrors} from '@src/languages/types';
 import type * as OnyxCommon from '@src/types/onyx/OnyxCommon';
 import type {ReceiptError, ReceiptErrors} from '@src/types/onyx/Transaction';
 import {isEmptyObject} from '@src/types/utils/EmptyObject';
 import MessagesRow from './MessagesRow';
 
 type ErrorMessageRowProps = {
     /** The errors to display  */
-    errors?: OnyxCommon.Errors | ReceiptErrors | TranslationKeyErrors | null;
+    errors?: OnyxCommon.Errors | ReceiptErrors | OnyxCommon.TranslationKeyErrors | null;
 
     /** Additional style object for the error row */
     errorRowStyles?: StyleProp<ViewStyle>;
@@ -27,7 +26,7 @@ type ErrorMessageRowProps = {
 function ErrorMessageRow({errors, errorRowStyles, onClose, canDismissError = true, dismissError}: ErrorMessageRowProps) {
     // Some errors have a null message. This is used to apply opacity only and to avoid showing redundant messages.
     const errorEntries = Object.entries(errors ?? {});
-    const filteredErrorEntries = errorEntries.filter((errorEntry): errorEntry is [string, string | ReceiptError | TranslationKeyError] => errorEntry[1] !== null);
+    const filteredErrorEntries = errorEntries.filter((errorEntry): errorEntry is [string, string | ReceiptError | OnyxCommon.TranslationKeyError] => errorEntry[1] !== null);
     const errorMessages = mapValues(Object.fromEntries(filteredErrorEntries), (error) => error);
     const hasErrorMessages = !isEmptyObject(errorMessages);
 

src/components/MessagesRow.tsx

@@ -5,9 +5,9 @@ import useLocalize from '@hooks/useLocalize';
 import useTheme from '@hooks/useTheme';
 import useThemeStyles from '@hooks/useThemeStyles';
 import CONST from '@src/CONST';
-import type {TranslationKeyError} from '@src/languages/types';
 import type {ReceiptError} from '@src/types/onyx/Transaction';
 import {isEmptyObject} from '@src/types/utils/EmptyObject';
+import type { TranslationKeyError } from '@src/types/onyx/OnyxCommon';
 import DotIndicatorMessage from './DotIndicatorMessage';
 import Icon from './Icon';
 import * as Expensicons from './Icon/Expensicons';

src/components/OfflineWithFeedback.tsx

@@ -8,7 +8,6 @@ import mapChildrenFlat from '@libs/mapChildrenFlat';
 import shouldRenderOffscreen from '@libs/shouldRenderOffscreen';
 import type {AllStyles} from '@styles/utils/types';
 import CONST from '@src/CONST';
-import type {TranslationKeyErrors} from '@src/languages/types';
 import type * as OnyxCommon from '@src/types/onyx/OnyxCommon';
 import type {ReceiptErrors} from '@src/types/onyx/Transaction';
 import type ChildrenProps from '@src/types/utils/ChildrenProps';
@@ -31,7 +30,7 @@ type OfflineWithFeedbackProps = ChildrenProps & {
     shouldHideOnDelete?: boolean;
 
     /** The errors to display  */
-    errors?: OnyxCommon.Errors | ReceiptErrors | TranslationKeyErrors | null;
+    errors?: OnyxCommon.Errors | OnyxCommon.TranslationKeyErrors | ReceiptErrors | null;
 
     /** Whether we should show the error messages */
     shouldShowErrorMessages?: boolean;

src/languages/types.ts

@@ -76,11 +76,6 @@ type DefaultTranslation = typeof en;
  */
 type TranslationPaths = FlattenObject<DefaultTranslation>;
 
-type TranslationKeyError = {
-    translationKey: TranslationPaths;
-};
-
-type TranslationKeyErrors = Record<string, TranslationKeyError>;
 /**
  * Flattened default translation object with its values
  */
@@ -99,4 +94,4 @@ type TranslationParameters<TKey extends TranslationPaths> = FlatTranslationsObje
         : Args
     : never[];
 
-export type {TranslationDeepObject, TranslationPaths, PluralForm, FlatTranslationsObject, TranslationParameters, TranslationKeyError, TranslationKeyErrors};
+export type {TranslationDeepObject, TranslationPaths, PluralForm, FlatTranslationsObject, TranslationParameters};

src/libs/ErrorUtils.ts

@@ -1,8 +1,8 @@
 import mapValues from 'lodash/mapValues';
 import type {OnyxEntry} from 'react-native-onyx';
 import CONST from '@src/CONST';
-import type {TranslationKeyError, TranslationKeyErrors, TranslationPaths} from '@src/languages/types';
-import type {ErrorFields, Errors} from '@src/types/onyx/OnyxCommon';
+import type {TranslationPaths} from '@src/languages/types';
+import type {ErrorFields, Errors, TranslationKeyError, TranslationKeyErrors} from '@src/types/onyx/OnyxCommon';
 import type Response from '@src/types/onyx/Response';
 import type {ReceiptError} from '@src/types/onyx/Transaction';
 import DateUtils from './DateUtils';

src/types/onyx/OnyxCommon.ts

@@ -1,6 +1,7 @@
 import type {ValueOf} from 'type-fest';
 import type {AvatarSource} from '@libs/UserUtils';
 import type CONST from '@src/CONST';
+import type { TranslationPaths } from '@src/languages/types';
 
 /** Pending onyx actions */
 type PendingAction = ValueOf<typeof CONST.RED_BRICK_ROAD_PENDING_ACTION> | null;
@@ -26,6 +27,21 @@ type ErrorFields<TKey extends string = string> = Record<TKey, Errors | null | un
 /** Mapping of form fields with error translation keys and variables */
 type Errors = Record<string, string | null>;
 
+/**
+ * Error object for a translation key
+ */
+type TranslationKeyError = {
+    /**
+     * The translation key
+     */
+    translationKey: TranslationPaths;
+};
+
+/**
+ * Mapping of form fields with key and translation key error variables
+ */
+type TranslationKeyErrors = Record<string, TranslationKeyError>;
+
 /**
  * Types of avatars
  ** avatar - user avatar
@@ -54,4 +70,4 @@ type Icon = {
     fill?: string;
 };
 
-export type {Icon, PendingAction, PendingFields, ErrorFields, Errors, AvatarType, OnyxValueWithOfflineFeedback};
+export type {Icon, PendingAction, PendingFields, ErrorFields, Errors, AvatarType, OnyxValueWithOfflineFeedback, TranslationKeyError, TranslationKeyErrors};