[DIT-12000] Add iosLocales Configuration Support

lib/src/formatters/index.ts

@@ -2,7 +2,7 @@ import { CommandMetaFlags } from "../http/types";
 import { Output } from "../outputs";
 import { ProjectConfigYAML } from "../services/projectConfig";
 import AndroidXMLFormatter from "./android";
-import ICUFormatter from "./icu";
+import JSONICUFormatter from "./jsonICU";
 import IOSStringsFormatter from "./iosStrings";
 import IOSStringsDictFormatter from "./iosStringsDict";
 import JSONFormatter from "./json";
@@ -21,8 +21,8 @@ export default function formatOutput(
       return new IOSStringsFormatter(output, projectConfig, meta).format();
     case "ios-stringsdict":
       return new IOSStringsDictFormatter(output, projectConfig, meta).format();
-    case "icu":
-      return new ICUFormatter(output, projectConfig, meta).format();
+    case "json_icu":
+      return new JSONICUFormatter(output, projectConfig, meta).format();
     default:
       throw new Error(`Unsupported output format: ${output}`);
   }

lib/src/formatters/iosStrings.ts

@@ -5,6 +5,8 @@ import {
   ExportTextItemsStringResponse,
   PullQueryParams,
 } from "../http/types";
+import OutputFile from "./shared/fileTypes/OutputFile";
+
 export default class IOSStringsFormatter extends BaseExportFormatter<
   IOSStringsOutputFile<{ variantId: string }>,
   ExportTextItemsStringResponse,
@@ -19,9 +21,17 @@ export default class IOSStringsFormatter extends BaseExportFormatter<
   ): void {
     this.outputFiles[fileName] ??= new IOSStringsOutputFile({
       filename: fileName,
-      path: this.outDir,
+      path: this.getLocalesPath(variantId),
       metadata: { variantId: variantId || "base" },
       content: content,
     });
   }
+
+  protected async writeFiles(files: OutputFile[]): Promise<void> {
+    if (this.projectConfig.iosLocales) {
+      const swiftDriverFile = await this.getSwiftDriverFile();
+      files.push(swiftDriverFile);
+    }
+    await super.writeFiles([...files]);
+  }
 }

lib/src/formatters/iosStringsDict.ts

@@ -5,6 +5,7 @@ import {
   ExportTextItemsStringResponse,
   PullQueryParams,
 } from "../http/types";
+import OutputFile from "./shared/fileTypes/OutputFile";
 export default class IOSStringsDictFormatter extends BaseExportFormatter<
   IOSStringsDictOutputFile<{ variantId: string }>,
   ExportTextItemsStringResponse,
@@ -19,9 +20,17 @@ export default class IOSStringsDictFormatter extends BaseExportFormatter<
   ): void {
     this.outputFiles[fileName] ??= new IOSStringsDictOutputFile({
       filename: fileName,
-      path: this.outDir,
+      path: this.getLocalesPath(variantId),
       metadata: { variantId: variantId || "base" },
       content: content,
     });
   }
+
+  protected async writeFiles(files: OutputFile[]): Promise<void> {
+    if (this.projectConfig.iosLocales) {
+      const swiftDriverFile = await this.getSwiftDriverFile();
+      files.push(swiftDriverFile);
+    }
+    await super.writeFiles(files);
+  }
 }

lib/src/formatters/icu.ts → lib/src/formatters/jsonICU.ts

@@ -6,12 +6,12 @@ import {
   PullQueryParams,
 } from "../http/types";
 
-export default class ICUFormatter extends BaseExportFormatter<
+export default class JSONICUFormatter extends BaseExportFormatter<
   ICUOutputFile<{ variantId: string }>,
   ExportTextItemsJSONResponse,
   ExportComponentsJSONResponse
 > {
-  protected exportFormat: PullQueryParams["format"] = "icu";
+  protected exportFormat: PullQueryParams["format"] = "json_icu";
 
   protected createOutputFile(
     fileName: string,

lib/src/formatters/shared/base.test.ts

@@ -399,3 +399,4 @@ describe("BaseFormatter", () => {
     });
   });
 });
+

lib/src/formatters/shared/base.ts

@@ -104,7 +104,7 @@ export default class BaseFormatter<OutputFileType, APIDataType = unknown> {
     await this.writeFiles(files);
   }
 
-  private async writeFiles(files: OutputFile[]): Promise<void> {
+  protected async writeFiles(files: OutputFile[]): Promise<void> {
     await Promise.all(
       files.map((file) =>
         writeFile(file.fullPath, file.formattedContent).then(() => {

lib/src/formatters/shared/baseExport.test.ts

@@ -9,12 +9,21 @@ import fetchText from "../../http/textItems";
 import fetchComponents from "../../http/components";
 import fetchProjects from "../../http/projects";
 import fetchVariants from "../../http/variants";
+import generateSwiftDriver from "../../http/cli";
+import appContext from "../../utils/appContext";
 import BaseExportFormatter from "./baseExport";
 
 jest.mock("../../http/textItems");
 jest.mock("../../http/components");
 jest.mock("../../http/projects");
 jest.mock("../../http/variants");
+jest.mock("../../http/cli");
+jest.mock("../../utils/appContext", () => ({
+  __esModule: true,
+  default: {
+    outDir: "/mock/app/context/outDir",
+  },
+}));
 
 const mockFetchText = fetchText as jest.MockedFunction<typeof fetchText>;
 const mockFetchComponents = fetchComponents as jest.MockedFunction<
@@ -26,6 +35,9 @@ const mockFetchProjects = fetchProjects as jest.MockedFunction<
 const mockFetchVariants = fetchVariants as jest.MockedFunction<
   typeof fetchVariants
 >;
+const mockGenerateSwiftDriver = generateSwiftDriver as jest.MockedFunction<
+  typeof generateSwiftDriver
+>;
 
 // fake test class to expose private methods
 // @ts-ignore
@@ -57,6 +69,14 @@ class TestBaseExportFormatter extends BaseExportFormatter {
   public async fetchComponentsMap() {
     return super["fetchComponentsMap"]();
   }
+
+  public getLocalesPath(variantId: string) {
+    return super.getLocalesPath(variantId);
+  }
+
+  public async getSwiftDriverFile() {
+    return super.getSwiftDriverFile();
+  }
 }
 
 describe("BaseExportFormatter", () => {
@@ -438,4 +458,242 @@ describe("BaseExportFormatter", () => {
       );
     });
   });
+
+  /***********************************************************
+   * getLocalesPath
+   ***********************************************************/
+  describe("getLocalesPath", () => {
+    it("should return output outDir when iosLocales is not configured", () => {
+      const projectConfig = createMockProjectConfig({
+        iosLocales: undefined,
+      });
+      const output = createMockOutput({ outDir: "/test/output" });
+      // @ts-ignore
+      const formatter = new TestBaseExportFormatter(
+        output,
+        projectConfig,
+        createMockMeta()
+      );
+
+      const result = formatter.getLocalesPath("base");
+
+      expect(result).toBe("/test/output");
+    });
+
+    it("should return locale path when iosLocales is configured and variantId matches", () => {
+      const projectConfig = createMockProjectConfig({
+        iosLocales: [{ base: "en" }, { variant1: "es" }, { variant2: "fr" }],
+      });
+      const output = createMockOutput({ outDir: "/test/output" });
+      // @ts-ignore
+      const formatter = new TestBaseExportFormatter(
+        output,
+        projectConfig,
+        createMockMeta()
+      );
+
+      const result = formatter.getLocalesPath("variant1");
+
+      expect(result).toBe("/mock/app/context/outDir/es.lproj");
+    });
+
+    it("should return output's outDir when iosLocales is configured but variantId does not exist in iosLocales map", () => {
+      const projectConfig = createMockProjectConfig({
+        iosLocales: [{ base: "en" }, { variant1: "es" }],
+      });
+      const output = createMockOutput({ outDir: "/test/output" });
+      // @ts-ignore
+      const formatter = new TestBaseExportFormatter(
+        output,
+        projectConfig,
+        createMockMeta()
+      );
+
+      const result = formatter.getLocalesPath("variant2");
+
+      expect(result).toBe("/test/output");
+    });
+
+    it("should return locale path for base variant when configured", () => {
+      const projectConfig = createMockProjectConfig({
+        iosLocales: [{ base: "en" }, { variant1: "es" }],
+      });
+      const output = createMockOutput({ outDir: "/test/output" });
+      // @ts-ignore
+      const formatter = new TestBaseExportFormatter(
+        output,
+        projectConfig,
+        createMockMeta()
+      );
+
+      const result = formatter.getLocalesPath("base");
+
+      expect(result).toBe("/mock/app/context/outDir/en.lproj");
+    });
+  });
+
+  /***********************************************************
+   * getSwiftDriverFile
+   ***********************************************************/
+  describe("getSwiftDriverFile", () => {
+    it("should generate Swift driver file with components folders from projectConfig", async () => {
+      const projectConfig = createMockProjectConfig({
+        components: {
+          folders: [{ id: "folder1" }, { id: "folder2" }],
+        },
+        projects: [{ id: "project1" }],
+      });
+      const output = createMockOutput();
+      // @ts-ignore
+      const formatter = new TestBaseExportFormatter(
+        output,
+        projectConfig,
+        createMockMeta()
+      );
+
+      const mockSwiftDriver = "import Foundation\nclass Ditto { }";
+      mockGenerateSwiftDriver.mockResolvedValue(mockSwiftDriver);
+
+      const result = await formatter.getSwiftDriverFile();
+
+      expect(mockGenerateSwiftDriver).toHaveBeenCalledWith(
+        {
+          components: {
+            folders: [{ id: "folder1" }, { id: "folder2" }],
+          },
+          projects: [{ id: "project1" }],
+        },
+        {}
+      );
+      expect(result.filename).toBe("Ditto");
+      expect(result.path).toBe("/mock/app/context/outDir");
+      expect(result.content).toBe(mockSwiftDriver);
+    });
+
+    it("should generate Swift driver file with components folders from output", async () => {
+      const projectConfig = createMockProjectConfig({
+        components: {
+          folders: [{ id: "config-folder" }],
+        },
+      });
+      const output = createMockOutput({
+        components: {
+          folders: [{ id: "output-folder1" }, { id: "output-folder2" }],
+        },
+      });
+      // @ts-ignore
+      const formatter = new TestBaseExportFormatter(
+        output,
+        projectConfig,
+        createMockMeta()
+      );
+
+      const mockSwiftDriver = "import Foundation\nclass Ditto { }";
+      mockGenerateSwiftDriver.mockResolvedValue(mockSwiftDriver);
+
+      const result = await formatter.getSwiftDriverFile();
+
+      expect(mockGenerateSwiftDriver).toHaveBeenCalledWith(
+        {
+          components: {
+            folders: [{ id: "output-folder1" }, { id: "output-folder2" }],
+          },
+          projects: [],
+        },
+        {}
+      );
+      expect(result.filename).toBe("Ditto");
+      expect(result.path).toBe("/mock/app/context/outDir");
+      expect(result.content).toBe(mockSwiftDriver);
+    });
+
+    it("should generate Swift driver file with projects from output", async () => {
+      const projectConfig = createMockProjectConfig({
+        projects: [{ id: "config-project" }],
+        components: undefined,
+      });
+      const output = createMockOutput({
+        projects: [{ id: "output-project1" }, { id: "output-project2" }],
+      });
+      // @ts-ignore
+      const formatter = new TestBaseExportFormatter(
+        output,
+        projectConfig,
+        createMockMeta()
+      );
+
+      const mockSwiftDriver = "import Foundation\nclass Ditto { }";
+      mockGenerateSwiftDriver.mockResolvedValue(mockSwiftDriver);
+
+      const result = await formatter.getSwiftDriverFile();
+
+      expect(mockGenerateSwiftDriver).toHaveBeenCalledWith(
+        {
+          projects: [{ id: "output-project1" }, { id: "output-project2" }],
+        },
+        {}
+      );
+      expect(result.filename).toBe("Ditto");
+      expect(result.path).toBe("/mock/app/context/outDir");
+    });
+
+    it("should generate Swift driver file with empty projects array when not configured", async () => {
+      const projectConfig = createMockProjectConfig({
+        projects: [],
+        components: {
+          folders: [],
+        },
+      });
+      const output = createMockOutput();
+      // @ts-ignore
+      const formatter = new TestBaseExportFormatter(
+        output,
+        projectConfig,
+        createMockMeta()
+      );
+
+      const mockSwiftDriver = "import Foundation\nclass Ditto { }";
+      mockGenerateSwiftDriver.mockResolvedValue(mockSwiftDriver);
+
+      const result = await formatter.getSwiftDriverFile();
+
+      expect(mockGenerateSwiftDriver).toHaveBeenCalledWith(
+        {
+          projects: [],
+          components: {
+            folders: [],
+          },
+        },
+        {}
+      );
+      expect(result.filename).toBe("Ditto");
+      expect(result.path).toBe("/mock/app/context/outDir");
+    });
+
+    it("should not include components in filters when components not configured", async () => {
+      const projectConfig = createMockProjectConfig({
+        components: undefined,
+        projects: [{ id: "project1" }],
+      });
+      const output = createMockOutput();
+      // @ts-ignore
+      const formatter = new TestBaseExportFormatter(
+        output,
+        projectConfig,
+        createMockMeta()
+      );
+
+      const mockSwiftDriver = "import Foundation\nclass Ditto { }";
+      mockGenerateSwiftDriver.mockResolvedValue(mockSwiftDriver);
+
+      await formatter.getSwiftDriverFile();
+
+      expect(mockGenerateSwiftDriver).toHaveBeenCalledWith(
+        {
+          projects: [{ id: "project1" }],
+        },
+        {}
+      );
+    });
+  });
 });