chore(i18n): rename getI18nBundles to getDefaultI18nBundles and update imports; add default language documentation

Author: brionmario

packages/i18n/src/index.ts

@@ -23,4 +23,4 @@ export type {I18nBundle, I18nTranslations, I18nMetadata, I18nTextDirection} from
 export * from './translations';
 
 // Utils
-export {default as getI18nBundles} from './utils/getI18nBundles';
+export {default as getDefaultI18nBundles} from './utils/getDefaultI18nBundles';

packages/i18n/src/translations/index.ts

@@ -16,4 +16,8 @@
  * under the License.
  */
 
+// IMPORTANT: Only include default bundled languages here.
+// Current List:
+//   1. en-US
+
 export {default as en_US} from './en-US';

packages/i18n/src/utils/getI18nBundles.ts …/i18n/src/utils/getDefaultI18nBundles.tspackages/i18n/src/utils/getI18nBundles.ts renamed to packages/i18n/src/utils/getDefaultI18nBundles.ts packages/i18n/src/utils/getI18nBundles.ts renamed to packages/i18n/src/utils/getDefaultI18nBundles.ts

@@ -16,17 +16,16 @@
  * under the License.
  */
 
-import {I18nBundle, I18nTranslations} from '../models/i18n';
 import * as i18n from '../translations';
 
 /**
- * Get internationalization bundles for the specified locale.
+ * Get the default i18n bundles.
  *
  * @param locale - The locale to get the bundle for (defaults to 'en-US')
  * @returns The i18n bundle for the specified locale
  */
-const getI18nBundles = () => {
+const getDefaultI18nBundles = () => {
   return i18n;
 };
 
-export default getI18nBundles;
+export default getDefaultI18nBundles;

packages/react/src/contexts/I18n/I18nProvider.tsx

@@ -17,7 +17,7 @@
  */
 
 import {FC, PropsWithChildren, ReactElement, useCallback, useEffect, useMemo, useState} from 'react';
-import {I18nBundle, getI18nBundles} from '@asgardeo/i18n';
+import {I18nBundle, getDefaultI18nBundles} from '@asgardeo/i18n';
 import {deepMerge, I18nPreferences} from '@asgardeo/browser';
 import I18nContext, {I18nContextValue} from './I18nContext';
 
@@ -78,7 +78,7 @@ const I18nProvider: FC<PropsWithChildren<I18nProviderProps>> = ({
   preferences,
 }: PropsWithChildren<I18nProviderProps>): ReactElement => {
   // Get default bundles from the browser package
-  const defaultBundles = getI18nBundles();
+  const defaultBundles = getDefaultI18nBundles();
 
   // Determine the initial language based on preference order:
   // 1. User preference from config