Added localization support (#42)

aarondemelo · web-flow · commit 25b4acb5061d · 2025-08-08T10:29:57.000+05:30
* added localization support * Revert "added localization support" This reverts commit 81f5da2. * localization support only needs set locale or passing default to the server as its handled server side. Reverted local checks * reverted changes * Updated local logic so as to allow for changes to local refreshing the views without requesting network updates * setup locale as optional * added locale for columns * added support for list rendering in HTML * resolved code review comments * updated tests for locale default in url * code clean up
diff --git a/Sources/BuilderIO/BuilderIOManager.swift b/Sources/BuilderIO/BuilderIOManager.swift
@@ -50,17 +50,17 @@ public final class BuilderIOManager {
     return customNavigationScheme
   }
 
-  public func fetchBuilderContent(model: String = "page", url: String? = nil) async -> Result<
-    BuilderContent, Error
-  > {
+  public func fetchBuilderContent(model: String = "page", url: String? = nil, locale: String) async
+    -> Result<BuilderContent, Error>
+  {
     do {
       let resolvedUrl = url ?? ""
 
       if let content = await BuilderContentAPI.getContent(
         model: model,
         apiKey: apiKey,
         url: resolvedUrl,
-        locale: "",
+        locale: locale,
         preview: ""
       ) {
         return .success(content)
diff --git a/Sources/BuilderIO/ComponentRegistry/BuilderComponentProtocol.swift b/Sources/BuilderIO/ComponentRegistry/BuilderComponentProtocol.swift
@@ -18,6 +18,22 @@ extension BuilderViewProtocol {
   func codeBindings() -> [String: String]? {
     return nil
   }
+
+  func localize(localizedValue: AnyCodable) -> String? {
+
+    if let localeDictionary = localizedValue.dictionaryValue {
+      if let currentLocale = block.locale {
+        if let localizedString = localeDictionary[currentLocale]?.stringValue {
+          return localizedString
+        }
+      }
+
+      return localeDictionary["Default"]?.stringValue
+
+    } else {
+      return localizedValue.stringValue
+    }
+  }
 }
 
 struct BuilderEmptyView: BuilderViewProtocol {
diff --git a/Sources/BuilderIO/Components/BuilderColumns.swift b/Sources/BuilderIO/Components/BuilderColumns.swift
@@ -52,6 +52,16 @@ struct BuilderColumns: BuilderViewProtocol {
         }
       }
 
+      if let locale = block.locale {
+
+        for columnIndex in decodedColumns.indices {
+          for blockIndex in decodedColumns[columnIndex].blocks.indices {
+            decodedColumns[columnIndex].blocks[blockIndex]
+              .setLocaleRecursively(locale)
+          }
+        }
+      }
+
       self.columns = decodedColumns
 
     } else {
diff --git a/Sources/BuilderIO/Components/BuilderImage.swift b/Sources/BuilderIO/Components/BuilderImage.swift
@@ -6,7 +6,7 @@ struct BuilderImage: BuilderViewProtocol {
   var block: BuilderBlockModel
   var children: [BuilderBlockModel]?
 
-  var imageURL: URL?
+  var imageURL: URL? = nil
   var aspectRatio: CGFloat? = nil
   var lockAspectRatio: Bool = false
   var contentMode: ContentMode = .fit
@@ -16,8 +16,12 @@ struct BuilderImage: BuilderViewProtocol {
 
   init(block: BuilderBlockModel) {
     self.block = block
-    self.imageURL = URL(
-      string: block.component?.options?.dictionaryValue?["image"]?.stringValue ?? "")
+
+    if let imageLink = block.component?.options?.dictionaryValue?["image"] {
+      self.imageURL = URL(
+        string: localize(localizedValue: imageLink) ?? "")
+    }
+
     if let ratio = block.component?.options?.dictionaryValue?["aspectRatio"]?.doubleValue {
       self.aspectRatio = CGFloat(1 / ratio)
     }
diff --git a/Sources/BuilderIO/Components/BuilderText.swift b/Sources/BuilderIO/Components/BuilderText.swift
@@ -11,7 +11,11 @@ struct BuilderText: BuilderViewProtocol {
 
   init(block: BuilderBlockModel) {
     self.block = block
-    self.text = block.component?.options?.dictionaryValue?["text"]?.stringValue ?? ""
+    var processedText: String = ""
+    if let textValue = block.component?.options?.dictionaryValue?["text"] {
+      self.text = localize(localizedValue: textValue) ?? ""
+    }
+
     self.responsiveStyles = getFinalStyle(responsiveStyles: block.responsiveStyles)
 
     if let textBinding = block.codeBindings(for: "text") {
@@ -106,12 +110,25 @@ struct HTMLTextView: View {
       // Perform the NSAttributedString conversion on the MainActor
       await MainActor.run {
         do {
-          let nsAttributedString = try NSAttributedString(
-            data: data,
-            options: [
+
+          var attributedOptions: [NSAttributedString.DocumentReadingOptionKey: Any] = [:]
+
+          if #available(iOS 18.0, *) {
+            attributedOptions = [
               .documentType: NSAttributedString.DocumentType.html,
               .characterEncoding: String.Encoding.utf8.rawValue,
-            ],
+              .textKit1ListMarkerFormatDocumentOption: true,
+            ]
+          } else {
+            attributedOptions = [
+              .documentType: NSAttributedString.DocumentType.html,
+              .characterEncoding: String.Encoding.utf8.rawValue,
+            ]
+          }
+
+          let nsAttributedString = try NSAttributedString(
+            data: data,
+            options: attributedOptions,
             documentAttributes: nil
           )
 
@@ -121,6 +138,7 @@ struct HTMLTextView: View {
           else {
             throw HTMLProcessingError.attributedStringConversionFailed
           }
+
           self.attributedString = swiftUIAttributedString
           self.errorInProcessing = nil  // Clear error if successful
         } catch {
@@ -227,73 +245,3 @@ struct HTMLTextView: View {
   }
 
 }
-
-struct BuilderText_Previews: PreviewProvider {
-  static let builderJSONString = """
-    {
-             "@type": "@builder.io/sdk:Element",
-             "@version": 2,
-             "id": "builder-54d67576377d4a9293c6f8d2efcda0ef",
-             "meta": {
-               "previousId": "builder-ad756879bc6c4ee3ac7977d5af0b6811"
-             },
-             "component": {
-               "name": "Text",
-              "options": {
-                "text": "<h1><strong>Right<em> </em></strong><em>Align</em><strong><em> </em></strong><strong style=\\\"color: rgb(144, 19, 254);\\\"><em><u>Text</u></em></strong></h1><p> This is a paragraph with some content that will determine the height dynamically. This text should wrap to multiple lines if the width is constrained.</p>"
-              },
-               "isRSC": null
-             },
-             "responsiveStyles": {
-               "large": {
-                 "display": "flex",
-                 "flexDirection": "column",
-                 "position": "relative",
-                 "flexShrink": "0",
-                 "boxSizing": "border-box",
-                 "marginTop": "20px",
-                 "lineHeight": "normal",
-                 "height": "auto",
-                 "marginLeft": "auto",
-                 "paddingLeft": "20px",
-                 "marginRight": "20px"
-               },
-               "medium": {
-                 "display": "none"
-               },
-               "small": {
-                 "borderWidth": "2px",
-                 "borderStyle": "solid",
-                 "borderColor": "rgba(219, 20, 20, 1)",
-                 "backgroundColor": "rgba(80, 227, 194, 1)",
-                 "backgroundRepeat": "no-repeat",
-                 "backgroundPosition": "center",
-                 "backgroundSize": "cover",
-                 "display": "flex",
-                 "fontSize": "12px",
-                 "fontWeight": "600",
-                 "fontFamily": "Aldrich, sans-serif"
-               }
-             }
-           }
-    """
-
-  static func decodeBuilderBlockModel(from jsonString: String) -> BuilderBlockModel? {
-    let data = Data(jsonString.utf8)
-    do {
-      let decoder = JSONDecoder()
-      return try decoder.decode(BuilderBlockModel.self, from: data)
-    } catch {
-      print("Decoding failed:", error)
-      return nil
-    }
-  }
-
-  static var previews: some View {
-    if let block = decodeBuilderBlockModel(from: builderJSONString) {
-      BuilderText(block: block)
-    } else {
-      Text("Failed to decode block")
-    }
-  }
-}
diff --git a/Sources/BuilderIO/ExportedView/BuilderIOContentView.swift b/Sources/BuilderIO/ExportedView/BuilderIOContentView.swift
@@ -7,16 +7,27 @@ public struct BuilderIOContentView: View {
   let url: String?
 
   @State private var viewModel: BuilderIOViewModel
+  @Binding var locale: String
 
-  public init(model: String) {
+  public init(model: String, locale: String = "Default") {
+    self.init(model: model, locale: .constant(locale))
+  }
+
+  public init(model: String, locale: Binding<String>) {
     self.model = model
     self.url = nil
+    self._locale = locale
     _viewModel = State(wrappedValue: BuilderIOViewModel())
   }
 
-  init(url: String, model: String = "page") {
+  public init(url: String, model: String = "page", locale: String = "Default") {
+    self.init(url: url, model: model, locale: .constant(locale))
+  }
+
+  init(url: String, model: String = "page", locale: Binding<String>) {
     self.url = url
     self.model = model
+    self._locale = locale
     _viewModel = State(wrappedValue: BuilderIOViewModel())
   }
 
@@ -66,13 +77,18 @@ public struct BuilderIOContentView: View {
       if viewModel.builderContent == nil && !viewModel.isLoading {
         await loadContent()
       }
+    }.onChange(of: locale) {
+      Task {
+        await loadContent()
+      }
     }
   }
 
   func loadContent() async {
     if !viewModel.isLoading {
       print("Calling fetchBuilderPageContent from .task for section model : \(model)")
-      await viewModel.fetchBuilderContent(model: model, url: url ?? "")
+      await viewModel.fetchBuilderContent(
+        model: model, url: url ?? "", locale: _locale.wrappedValue)
     } else if viewModel.isLoading {
       print("Already loading content for section model: \(model). Not re-fetching.")
     }
diff --git a/Sources/BuilderIO/ExportedView/BuilderIOPage.swift b/Sources/BuilderIO/ExportedView/BuilderIOPage.swift
@@ -5,25 +5,36 @@ public struct BuilderIOPage: View {
 
   let url: String
   let model: String
+  @Binding var locale: String
 
   @StateObject private var buttonActionManager = BuilderActionManager()
   var onClickEventHandler: ((BuilderAction) -> Void)? = nil
 
   @State private var activeNavigationTarget: NavigationTarget? = nil
 
   public init(
-    url: String, model: String = "page", onClickEventHandler: ((BuilderAction) -> Void)? = nil
+    url: String, model: String = "page", locale: String = "Default",
+    onClickEventHandler: ((BuilderAction) -> Void)? = nil
+  ) {
+    self.init(
+      url: url, model: model, locale: .constant(locale), onClickEventHandler: onClickEventHandler)
+  }
+
+  public init(
+    url: String, model: String = "page", locale: Binding<String>,
+    onClickEventHandler: ((BuilderAction) -> Void)? = nil
   ) {
     self.url = url
     self.model = model
     self.onClickEventHandler = onClickEventHandler
+    self._locale = locale
   }
 
   public var body: some View {
     NavigationStack(path: $buttonActionManager.path) {
-      BuilderIOContentView(url: url, model: model)
+      BuilderIOContentView(url: url, model: model, locale: $locale)
         .navigationDestination(for: NavigationTarget.self) { target in
-          BuilderIOContentView(url: target.url, model: target.model)
+          BuilderIOContentView(url: target.url, model: target.model, locale: $locale)
         }
     }.environmentObject(buttonActionManager).onAppear {
       if let onClickEventHandler = onClickEventHandler {
diff --git a/Sources/BuilderIO/ExportedView/BuilderIOViewModel.swift b/Sources/BuilderIO/ExportedView/BuilderIOViewModel.swift
@@ -44,7 +44,7 @@ public final class BuilderIOViewModel {
 
   /// Fetches the Builder.io page content for a given URL.
   /// Manages loading, content, and error states.
-  public func fetchBuilderContent(model: String = "page", url: String = "") async {
+  public func fetchBuilderContent(model: String = "page", url: String = "", locale: String) async {
     // Set loading state immediately
     isLoading = true
     errorMessage = nil  // Clear any previous error
@@ -58,16 +58,24 @@ public final class BuilderIOViewModel {
 
     do {
       // Await the content fetching
-      let result = await BuilderIOManager.shared.fetchBuilderContent(model: model, url: url)
+      let result = await BuilderIOManager.shared.fetchBuilderContent(
+        model: model, url: url, locale: locale)
       switch result {
       case .success(let fetchedContent):
-        if fetchedContent.data.httpRequests != nil {
+        if let httpRequests = fetchedContent.data.httpRequests {
           self.stateModel.apiResponses = try await fetchParallelAPIData(
-            urls: fetchedContent.data.httpRequests!)
+            urls: httpRequests, locale: locale)
         }
 
         if self.stateModel.apiResponses.isEmpty {
+          var newContentBlocks = fetchedContent.data.blocks ?? []
+          for i in 0..<newContentBlocks.count {
+            newContentBlocks[i].setLocaleRecursively(locale)
+          }
+
           self.builderContent = fetchedContent
+
+          self.builderContent?.data.blocks = newContentBlocks
         } else {
           // Further logic for content binding/loops can go here if needed.
           var contentBlocks = fetchedContent.data.blocks ?? []
@@ -103,8 +111,13 @@ public final class BuilderIOViewModel {
             }
 
           }
+
           self.builderContent = fetchedContent
 
+          for i in 0..<newContentBlocks.count {
+            newContentBlocks[i].setLocaleRecursively(locale)
+          }
+
           self.builderContent?.data.blocks = newContentBlocks
         }
 
@@ -120,12 +133,23 @@ public final class BuilderIOViewModel {
     isLoading = false
   }
 
+  func replaceLocalePlaceholder(in string: String, with locale: String) -> String {
+    let placeholder = "&locale={{state.locale}}"
+    if string.contains(placeholder) {
+      return string.replacingOccurrences(of: placeholder, with: "&locale=\(locale)")
+    } else {
+      return string
+    }
+  }
+
   /// Sends a tracking pixel to Builder.io.
   public func sendTrackingPixel() {
     BuilderIOManager.shared.sendTrackingPixel()
   }
 
-  public func fetchParallelAPIData(urls: [String: String]) async -> [String: AnyCodable] {
+  public func fetchParallelAPIData(urls: [String: String], locale: String) async -> [String:
+    AnyCodable]
+  {
     isLoading = true
     errorMessage = nil  // Clear any previous error
 
@@ -140,13 +164,18 @@ public final class BuilderIOViewModel {
 
     // Use withTaskGroup for concurrent execution and collection of results
     // The Task will now return (originalKey, apiResult)
-    await withTaskGroup(of: (String, AnyCodable?).self) { group in
+    await withTaskGroup(of: (String, AnyCodable?).self) { [weak self] group in
       for (key, urlString) in urls {  // Iterate over key-value pairs
         group.addTask {
           do {
-            let apiResult = try await BuilderContentAPI.getDataFromBoundAPI(url: urlString)
-            // Return the original key along with the API result
-            return (key, apiResult)
+            if let self = self {
+              let apiResult = try await BuilderContentAPI.getDataFromBoundAPI(
+                url: self.replaceLocalePlaceholder(in: urlString, with: locale))
+              // Return the original key along with the API result
+              return (key, apiResult)
+            } else {
+              return (key, nil)
+            }
           } catch {
             print(
               "Error fetching data from \(urlString) for key \(key): \(error.localizedDescription)")
diff --git a/Sources/BuilderIO/Schemas/BuilderBlockModel.swift b/Sources/BuilderIO/Schemas/BuilderBlockModel.swift
diff --git a/Tests/BuilderIOTests/Helper/BuilderIOMockManager.swift b/Tests/BuilderIOTests/Helper/BuilderIOMockManager.swift
