@amityco/ui-kit-open-source 4.15.0 → 4.16.0

package/dist/index.d.mts

@@ -4,6 +4,24 @@ import * as styled_components_dist_types from 'styled-components/dist/types';
 import * as styled_components from 'styled-components';
 import { AnalyticsSourceTypeEnum, FeedSourceEnum } from '@amityco/ts-sdk';
 
+/**
+ * UIKit v4 — String Resolution Chain (Levels 2–5)
+ *
+ * Implements the priority chain from the UIKit Cross-Platform Localization Spec §1:
+ *
+ *   Level 1: Config text (remote)  — handled by useAmityElement / CustomizationProvider
+ *   Level 2: Programmatic override — setStringOverrides / clearStringOverrides
+ *   Level 3: Locale bundle         — setLocaleBundle / clearLocaleBundle
+ *   Level 4: Library default       — defaultLocaleBundle (auto-generated en.ts)
+ *   Level 5: Key name fallback     — returns the raw key string
+ *
+ * Usage:
+ *   import { resolveString } from '~/v4/core/localization/resolveString';
+ *   const text = resolveString('amity_social_create_post');
+ *   const text = resolveString('amity_social_items_count', 42);  // format arg
+ */
+type LocaleBundle = Record<string, string>;
+
 type AmityReactionType = {
     name: string;
     image: string;
@@ -342,8 +360,8 @@ type UpcomingEventsPageProps = UpcomingEventsProps;
 declare function UpcomingEventsPage({ fromExplore }: UpcomingEventsPageProps): react_jsx_runtime.JSX.Element;
 
 declare const enum UserRelationshipPageTabs {
-    FOLLOWING = "following",
-    FOLLOWER = "followers"
+    FOLLOWING = "Following",
+    FOLLOWER = "Follower"
 }
 type UserRelationshipPageProps = {
     userId: string;
@@ -786,6 +804,24 @@ interface AmityUIKitProviderProps {
     seoOptimizationEnabled?: boolean;
     syncNetworkConfig?: boolean;
     onEmptyNavigationStack?: () => void;
+    /**
+     * Localization configuration for the UIKit.
+     * - `localeBundle`: initial Level 3 locale bundle (key → translated string)
+     * - `overrides`: initial Level 2 programmatic overrides (merge with locale)
+     * - `localeMap`: map of locale code → bundle for automatic device-language detection.
+     *   When `localeBundle` is not set the provider checks `navigator.language` against
+     *   this map (exact match, then language-prefix). Falls back to English if no match.
+     *
+     * @example
+     *   localization={{ localeBundle: jaLocale }}
+     * @example
+     *   localization={{ localeMap: { ja: jaLocale, th: thLocale } }}
+     */
+    localization?: {
+        localeBundle?: LocaleBundle;
+        overrides?: LocaleBundle;
+        localeMap?: Record<string, LocaleBundle>;
+    };
 }
 declare const AmityUIKitProvider: React.FC<AmityUIKitProviderProps>;
 

package/dist/index.d.ts

@@ -4,6 +4,24 @@ import * as styled_components_dist_types from 'styled-components/dist/types';
 import * as styled_components from 'styled-components';
 import { AnalyticsSourceTypeEnum, FeedSourceEnum } from '@amityco/ts-sdk';
 
+/**
+ * UIKit v4 — String Resolution Chain (Levels 2–5)
+ *
+ * Implements the priority chain from the UIKit Cross-Platform Localization Spec §1:
+ *
+ *   Level 1: Config text (remote)  — handled by useAmityElement / CustomizationProvider
+ *   Level 2: Programmatic override — setStringOverrides / clearStringOverrides
+ *   Level 3: Locale bundle         — setLocaleBundle / clearLocaleBundle
+ *   Level 4: Library default       — defaultLocaleBundle (auto-generated en.ts)
+ *   Level 5: Key name fallback     — returns the raw key string
+ *
+ * Usage:
+ *   import { resolveString } from '~/v4/core/localization/resolveString';
+ *   const text = resolveString('amity_social_create_post');
+ *   const text = resolveString('amity_social_items_count', 42);  // format arg
+ */
+type LocaleBundle = Record<string, string>;
+
 type AmityReactionType = {
     name: string;
     image: string;
@@ -342,8 +360,8 @@ type UpcomingEventsPageProps = UpcomingEventsProps;
 declare function UpcomingEventsPage({ fromExplore }: UpcomingEventsPageProps): react_jsx_runtime.JSX.Element;
 
 declare const enum UserRelationshipPageTabs {
-    FOLLOWING = "following",
-    FOLLOWER = "followers"
+    FOLLOWING = "Following",
+    FOLLOWER = "Follower"
 }
 type UserRelationshipPageProps = {
     userId: string;
@@ -786,6 +804,24 @@ interface AmityUIKitProviderProps {
     seoOptimizationEnabled?: boolean;
     syncNetworkConfig?: boolean;
     onEmptyNavigationStack?: () => void;
+    /**
+     * Localization configuration for the UIKit.
+     * - `localeBundle`: initial Level 3 locale bundle (key → translated string)
+     * - `overrides`: initial Level 2 programmatic overrides (merge with locale)
+     * - `localeMap`: map of locale code → bundle for automatic device-language detection.
+     *   When `localeBundle` is not set the provider checks `navigator.language` against
+     *   this map (exact match, then language-prefix). Falls back to English if no match.
+     *
+     * @example
+     *   localization={{ localeBundle: jaLocale }}
+     * @example
+     *   localization={{ localeMap: { ja: jaLocale, th: thLocale } }}
+     */
+    localization?: {
+        localeBundle?: LocaleBundle;
+        overrides?: LocaleBundle;
+        localeMap?: Record<string, LocaleBundle>;
+    };
 }
 declare const AmityUIKitProvider: React.FC<AmityUIKitProviderProps>;