From 80b21eee80f629fa1be812d348cb27a4c567c763 Mon Sep 17 00:00:00 2001 From: Brian Parrish Date: Tue, 16 Dec 2025 09:36:08 -0500 Subject: [PATCH 1/2] [DIT-11970] iOS Strings Format Support (#129) * Add scaffolding for ios-strings support, notably IOSStringsFormatter class, and IOSStringsOutput file * Add /v2/variants endpoint. Update IOSStringsFormatter to pull down variants and projects as expected. Moved shared BaseFormatter class methods out of JSON and IOSStringsFormatters * Minor inline doc updates * Add pull command E2E tests for outputted ios-strings files. Added component mapping to iosStringsFormatter * Add unit tests to IOSSTringsFormatter class * Update variant fetching to be shared across textItems and components. Unit tests additions to IOSStringsFormatter class * Update http request tests to handle default error * Minor: test fix * Minor: cleanup and .gitignore of local items --- .gitignore | 1 + lib/src/commands/pull.test.ts | 182 ++++++- lib/src/formatters/index.ts | 3 + lib/src/formatters/iosStrings.test.ts | 447 ++++++++++++++++++ lib/src/formatters/iosStrings.ts | 142 ++++++ lib/src/formatters/json.ts | 74 +-- lib/src/formatters/shared/base.test.ts | 447 ++++++++++++++++++ lib/src/formatters/shared/base.ts | 83 +++- .../shared/fileTypes/IOSStringsOutputFile.ts | 25 + lib/src/http/components.ts | 39 +- lib/src/http/projects.test.ts | 51 ++ lib/src/http/projects.ts | 20 + lib/src/http/textItems.ts | 39 +- lib/src/http/types.ts | 38 ++ lib/src/http/variants.test.ts | 66 +++ lib/src/http/variants.ts | 20 + lib/src/outputs/index.ts | 3 +- lib/src/outputs/iosStrings.ts | 7 + 18 files changed, 1591 insertions(+), 96 deletions(-) create mode 100644 lib/src/formatters/iosStrings.test.ts create mode 100644 lib/src/formatters/iosStrings.ts create mode 100644 lib/src/formatters/shared/base.test.ts create mode 100644 lib/src/formatters/shared/fileTypes/IOSStringsOutputFile.ts create mode 100644 lib/src/http/projects.test.ts create mode 100644 lib/src/http/projects.ts create mode 100644 lib/src/http/variants.test.ts create mode 100644 lib/src/http/variants.ts create mode 100644 lib/src/outputs/iosStrings.ts diff --git a/.gitignore b/.gitignore index b044dcd..73c21b5 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ ditto bin/ .env coverage +.DS_Store \ No newline at end of file diff --git a/lib/src/commands/pull.test.ts b/lib/src/commands/pull.test.ts index 1970675..bd6b456 100644 --- a/lib/src/commands/pull.test.ts +++ b/lib/src/commands/pull.test.ts @@ -469,7 +469,7 @@ describe("pull command - end-to-end tests", () => { }); }); - describe("Output files", () => { + describe("Output files - JSON", () => { it("should create output files for each project and variant returned from the API", async () => { fs.mkdirSync(outputDir, { recursive: true }); @@ -604,4 +604,184 @@ describe("pull command - end-to-end tests", () => { ]); }); }); + + // Helper functions + const setupIosStringsMocks = ({ + textItems = [], + components = [], + variables = [], + }: { + textItems: TextItem[]; + components?: Component[]; + variables?: any[]; + }) => { + /* + "this-is-a-ditto-text-item" = "No its not"; + + "this-is-a-text-layer-on-figma" = "This is a Ditto text item (LinkedNode)"; + + "update-preferences" = "Update preferences"; + */ + mockHttpClient.get.mockImplementation((url: string, config?: any) => { + if (url.includes("/v2/textItems/export")) { + return Promise.resolve({ + data: textItems + .map((textItem) => `"${textItem.id}" = "${textItem.text}"`) + .join("\n\n"), + }); + } + if (url.includes("/v2/variables")) { + return Promise.resolve({ data: variables }); + } + if (url.includes("/v2/components/export")) { + return Promise.resolve({ + data: components + .map((component) => `"${component.id}" = "${component.text}"`) + .join("\n\n"), + }); + } + return Promise.resolve({ data: [] }); + }); + }; + + describe("Output files - ios-strings", () => { + it("should create output files for each project and variant returned from the API", async () => { + fs.mkdirSync(outputDir, { recursive: true }); + + appContext.setProjectConfig({ + components: {}, + outputs: [ + { + format: "ios-strings", + outDir: outputDir, + projects: [{ id: "project-1" }, { id: "project-2" }], + variants: [ + { id: "base" }, + { id: "variant-a" }, + { id: "variant-b" }, + ], + }, + ], + }); + + // project-1 and project-2 each have at least one base text item + const baseTextItems = [ + createMockTextItem({ + projectId: "project-1", + variantId: null, + id: "text-1", + }), + createMockTextItem({ + projectId: "project-1", + variantId: null, + id: "text-2", + }), + createMockTextItem({ + projectId: "project-2", + variantId: null, + id: "text-3", + }), + ]; + + // project-1 and project-2 each have a variant-a text item + const variantATextItems = [ + createMockTextItem({ + projectId: "project-1", + variantId: "variant-a", + id: "text-4", + }), + createMockTextItem({ + projectId: "project-2", + variantId: "variant-a", + id: "text-5", + }), + ]; + + // Only project-1 has variant-b, so only project-1 should get a variant-b file + const variantBTextItems = [ + createMockTextItem({ + projectId: "project-1", + variantId: "variant-b", + id: "text-6", + }), + createMockTextItem({ + projectId: "project-1", + variantId: "variant-b", + id: "text-7", + }), + ]; + + const componentsBase = [ + createMockComponent({ + id: "comp-1", + variantId: null, + folderId: null, + }), + createMockComponent({ + id: "comp-2", + variantId: null, + folderId: "folder-1", + }), + createMockComponent({ + id: "comp-3", + variantId: null, + folderId: "folder-2", + }), + ]; + + const componentsVariantA = [ + createMockComponent({ + id: "comp-4", + variantId: "variant-a", + folderId: null, + }), + createMockComponent({ + id: "comp-5", + variantId: "variant-a", + folderId: "folder-1", + }), + ]; + + const componentsVariantB = [ + createMockComponent({ + id: "comp-6", + variantId: "variant-b", + folderId: null, + }), + createMockComponent({ + id: "comp-7", + variantId: "variant-b", + folderId: "folder-1", + }), + ]; + + setupIosStringsMocks({ + textItems: [ + ...baseTextItems, + ...variantATextItems, + ...variantBTextItems, + ], + components: [ + ...componentsBase, + ...componentsVariantA, + ...componentsVariantB, + ], + }); + + await pull({}); + + // Verify a file was created for each project and variant present in the (mocked) API response + assertFilesCreated(outputDir, [ + "project-1___base.strings", + "project-1___variant-a.strings", + "project-1___variant-b.strings", + "project-2___base.strings", + "project-2___variant-a.strings", + "project-2___variant-b.strings", + "components___base.strings", + "components___variant-a.strings", + "components___variant-b.strings", + ]); + }); + }); }); diff --git a/lib/src/formatters/index.ts b/lib/src/formatters/index.ts index d02e8d8..8dcaf5a 100644 --- a/lib/src/formatters/index.ts +++ b/lib/src/formatters/index.ts @@ -1,6 +1,7 @@ import { CommandMetaFlags } from "../http/types"; import { Output } from "../outputs"; import { ProjectConfigYAML } from "../services/projectConfig"; +import IOSStringsFormatter from "./iosStrings"; import JSONFormatter from "./json"; export default function formatOutput( @@ -11,6 +12,8 @@ export default function formatOutput( switch (output.format) { case "json": return new JSONFormatter(output, projectConfig, meta).format(); + case "ios-strings": + return new IOSStringsFormatter(output, projectConfig, meta).format(); default: throw new Error(`Unsupported output format: ${output}`); } diff --git a/lib/src/formatters/iosStrings.test.ts b/lib/src/formatters/iosStrings.test.ts new file mode 100644 index 0000000..3942288 --- /dev/null +++ b/lib/src/formatters/iosStrings.test.ts @@ -0,0 +1,447 @@ +import IOSStringsFormatter from "./iosStrings"; +import { Output } from "../outputs"; +import { ProjectConfigYAML } from "../services/projectConfig"; +import { CommandMetaFlags } from "../http/types"; +import { + ExportTextItemsResponse, + ExportComponentsResponse, +} from "../http/types"; +import fetchText from "../http/textItems"; +import fetchComponents from "../http/components"; +import fetchProjects from "../http/projects"; +import fetchVariants from "../http/variants"; +import IOSStringsOutputFile from "./shared/fileTypes/IOSStringsOutputFile"; + +jest.mock("../http/textItems"); +jest.mock("../http/components"); +jest.mock("../http/projects"); +jest.mock("../http/variants"); + +const mockFetchText = fetchText as jest.MockedFunction; +const mockFetchComponents = fetchComponents as jest.MockedFunction< + typeof fetchComponents +>; +const mockFetchProjects = fetchProjects as jest.MockedFunction< + typeof fetchProjects +>; +const mockFetchVariants = fetchVariants as jest.MockedFunction< + typeof fetchVariants +>; + +// fake test class to expose private methods +// @ts-ignore +class TestIOSStringsFormatter extends IOSStringsFormatter { + public async fetchAPIData() { + return super.fetchAPIData(); + } + + public transformAPIData( + data: Parameters[0] + ) { + return super.transformAPIData(data); + } + + public async fetchVariants() { + return super["fetchVariants"](); + } + + // Expose private methods for testing + public async fetchTextItemsMap() { + return super["fetchTextItemsMap"](); + } + + public async fetchComponentsMap() { + return super["fetchComponentsMap"](); + } +} + +describe("IOSStringsFormatter", () => { + // @ts-ignore + const createMockOutput = (overrides: Partial = {}): Output => ({ + format: "ios-strings", + outDir: "/test/output", + ...overrides, + }); + + const createMockProjectConfig = ( + overrides: Partial = {} + ): ProjectConfigYAML => ({ + projects: [], + variants: [], + components: { + folders: [], + }, + outputs: [ + { + format: "ios-strings", + }, + ], + ...overrides, + }); + + const createMockMeta = (): CommandMetaFlags => ({}); + + const createMockIOSStringsContent = (): ExportTextItemsResponse => + ` + "this-is-a-ditto-text-item" = "No its not"; + + "this-is-a-text-layer-on-figma" = "This is a Ditto text item (LinkedNode)"; + + "update-preferences" = "Update preferences"; + `; + + const createMockComponentsContent = (): ExportComponentsResponse => + ` + "continue" = "Continue"; + + "email" = "Email"; + `; + + beforeEach(() => { + jest.clearAllMocks(); + }); + + /*********************************************************** + * fetchTextItemsMap + ***********************************************************/ + + describe("fetchTextItemsMap", () => { + it("should fetch text items for projects and variants configured at root level", async () => { + const projectConfig = createMockProjectConfig({ + projects: [{ id: "project1" }, { id: "project2" }], + variants: [{ id: "variant1" }, { id: "base" }], + }); + const output = createMockOutput(); + const formatter = new TestIOSStringsFormatter( + output, + projectConfig, + createMockMeta() + ); + + const mockContent = createMockIOSStringsContent(); + mockFetchText.mockResolvedValue(mockContent); + + await formatter.fetchVariants(); + const result = await formatter.fetchTextItemsMap(); + + expect(result).toEqual({ + project1: { + variant1: mockContent, + base: mockContent, + }, + project2: { + variant1: mockContent, + base: mockContent, + }, + }); + }); + + it("should fetch all projects from API when not configured", async () => { + const projectConfig = createMockProjectConfig({ + projects: [], + variants: [{ id: "base" }], + }); + const output = createMockOutput(); + const formatter = new TestIOSStringsFormatter( + output, + projectConfig, + createMockMeta() + ); + + const mockProjects = [ + { id: "project-1", name: "Project 1" }, + { id: "project-2", name: "Project 2" }, + { id: "project-3", name: "Project 3" }, + { id: "project-4", name: "Project 4" }, + ]; + const mockContent = createMockIOSStringsContent(); + + mockFetchProjects.mockResolvedValue(mockProjects); + mockFetchText.mockResolvedValue(mockContent); + + await formatter.fetchVariants(); + const result = await formatter.fetchTextItemsMap(); + + expect(mockFetchProjects).toHaveBeenCalled(); + expect(result).toEqual({ + "project-1": { + base: mockContent, + }, + "project-2": { + base: mockContent, + }, + "project-3": { + base: mockContent, + }, + "project-4": { + base: mockContent, + }, + }); + }); + + it("should fetch variants from API when 'all' is specified", async () => { + const projectConfig = createMockProjectConfig({ + projects: [{ id: "project1" }], + variants: [{ id: "all" }], + }); + const output = createMockOutput(); + const formatter = new TestIOSStringsFormatter( + output, + projectConfig, + createMockMeta() + ); + + const mockVariants = [ + { id: "variant1", name: "Variant 1" }, + { id: "variant2", name: "Variant 2" }, + ]; + const mockContent = createMockIOSStringsContent(); + + mockFetchVariants.mockResolvedValue(mockVariants); + mockFetchText.mockResolvedValue(mockContent); + + await formatter.fetchVariants(); + const result = await formatter.fetchTextItemsMap(); + + expect(mockFetchVariants).toHaveBeenCalled(); + expect(result).toEqual({ + project1: { + variant1: mockContent, + variant2: mockContent, + }, + }); + }); + + it("should default to base variant when variants are empty", async () => { + const projectConfig = createMockProjectConfig({ + projects: [{ id: "project1" }], + variants: [], + }); + const output = createMockOutput(); + const formatter = new TestIOSStringsFormatter( + output, + projectConfig, + createMockMeta() + ); + + const mockContent = createMockIOSStringsContent(); + mockFetchText.mockResolvedValue(mockContent); + + await formatter.fetchVariants(); + const result = await formatter.fetchTextItemsMap(); + + expect(result).toEqual({ + project1: { + base: mockContent, + }, + }); + }); + }); + + /*********************************************************** + * fetchComponentsMap + ***********************************************************/ + describe("fetchComponentsMap", () => { + it("should fetch components for variants configured at root level", async () => { + const projectConfig = createMockProjectConfig({ + variants: [{ id: "variant1" }, { id: "base" }], + components: { + folders: [], + }, + }); + const output = createMockOutput(); + const formatter = new TestIOSStringsFormatter( + output, + projectConfig, + createMockMeta() + ); + + const mockContent = createMockComponentsContent(); + mockFetchComponents.mockResolvedValue(mockContent); + + await formatter.fetchVariants(); + const result = await formatter.fetchComponentsMap(); + + expect(result).toEqual({ + variant1: mockContent, + base: mockContent, + }); + + expect(mockFetchComponents).toHaveBeenCalledTimes(2); + }); + + it("should fetch variants from API when 'all' is specified", async () => { + const projectConfig = createMockProjectConfig({ + variants: [{ id: "all" }], + components: { + folders: [], + }, + }); + const output = createMockOutput(); + const formatter = new TestIOSStringsFormatter( + output, + projectConfig, + createMockMeta() + ); + + const mockVariants = [ + { id: "variant1", name: "Variant 1" }, + { id: "variant2", name: "Variant 2" }, + ]; + const mockContent = createMockComponentsContent(); + + mockFetchVariants.mockResolvedValue(mockVariants); + mockFetchComponents.mockResolvedValue(mockContent); + + await formatter.fetchVariants(); + const result = await formatter.fetchComponentsMap(); + + expect(mockFetchVariants).toHaveBeenCalled(); + expect(result).toEqual({ variant1: mockContent, variant2: mockContent }); + }); + + it("should default to base variant when variants are empty", async () => { + const projectConfig = createMockProjectConfig({ + variants: [], + components: { + folders: [], + }, + }); + const output = createMockOutput(); + const formatter = new TestIOSStringsFormatter( + output, + projectConfig, + createMockMeta() + ); + + const mockContent = createMockComponentsContent(); + mockFetchComponents.mockResolvedValue(mockContent); + + await formatter.fetchVariants(); + const result = await formatter.fetchComponentsMap(); + + expect(result).toEqual({ + base: mockContent, + }); + }); + + it("should return empty object when components not configured", async () => { + const projectConfig = createMockProjectConfig({ + components: undefined, + }); + const output = createMockOutput(); + const formatter = new TestIOSStringsFormatter( + output, + projectConfig, + createMockMeta() + ); + + const result = await formatter.fetchComponentsMap(); + + expect(result).toEqual({}); + expect(mockFetchComponents).not.toHaveBeenCalled(); + }); + }); + + /*********************************************************** + * fetchAPIData + ***********************************************************/ + describe("fetchAPIData", () => { + it("should fetchVariants and combine text items and components data", async () => { + const projectConfig = createMockProjectConfig({ + projects: [{ id: "project1" }], + variants: [{ id: "base" }], + components: { + folders: [], + }, + }); + const output = createMockOutput(); + const formatter = new TestIOSStringsFormatter( + output, + projectConfig, + createMockMeta() + ); + + const mockTextContent = createMockIOSStringsContent(); + const mockComponentsContent = createMockComponentsContent(); + + mockFetchText.mockResolvedValue(mockTextContent); + mockFetchComponents.mockResolvedValue(mockComponentsContent); + + const fetchVariantsSpy = jest.spyOn(formatter, "fetchVariants"); + const result = await formatter.fetchAPIData(); + + expect(fetchVariantsSpy).toHaveBeenCalled(); + expect(result).toEqual({ + textItemsMap: { + project1: { + base: mockTextContent, + }, + }, + componentsMap: { + base: mockComponentsContent, + }, + }); + }); + }); + + /*********************************************************** + * transformAPIData + ***********************************************************/ + describe("transformAPIData", () => { + it("should transform text items into IOSStringsOutputFile output files", () => { + const projectConfig = createMockProjectConfig(); + const output = createMockOutput({ outDir: "/test/output" }); + const formatter = new TestIOSStringsFormatter( + output, + projectConfig, + createMockMeta() + ); + + const mockTextContent = createMockIOSStringsContent(); + const data = { + textItemsMap: { + project1: { + base: mockTextContent, + variant1: mockTextContent, + }, + }, + componentsMap: {}, + }; + + const result = formatter.transformAPIData(data); + expect(result).toHaveLength(2); + expect(result[0]).toBeInstanceOf(IOSStringsOutputFile); + expect(result[0].filename).toBe("project1___base"); + expect(result[1]).toBeInstanceOf(IOSStringsOutputFile); + expect(result[1].filename).toBe("project1___variant1"); + }); + + it("should transform components into IOSStringsOutputFile output files", () => { + const projectConfig = createMockProjectConfig(); + const output = createMockOutput({ outDir: "/test/output" }); + const formatter = new TestIOSStringsFormatter( + output, + projectConfig, + createMockMeta() + ); + + const mockComponentsContent = createMockComponentsContent(); + const data = { + textItemsMap: {}, + componentsMap: { + base: mockComponentsContent, + variant1: mockComponentsContent, + }, + }; + + const result = formatter.transformAPIData(data); + + expect(result).toHaveLength(2); + expect(result[0]).toBeInstanceOf(IOSStringsOutputFile); + expect(result[0].filename).toBe("components___base"); + expect(result[1]).toBeInstanceOf(IOSStringsOutputFile); + expect(result[1].filename).toBe("components___variant1"); + }); + }); +}); diff --git a/lib/src/formatters/iosStrings.ts b/lib/src/formatters/iosStrings.ts new file mode 100644 index 0000000..a209aa3 --- /dev/null +++ b/lib/src/formatters/iosStrings.ts @@ -0,0 +1,142 @@ +import fetchText from "../http/textItems"; +import { ExportComponentsResponse, ExportTextItemsResponse, PullQueryParams, Variant } from "../http/types"; +import fetchComponents from "../http/components"; +import BaseFormatter from "./shared/base"; +import { applyMixins } from "./shared"; +import fetchProjects from "../http/projects"; +import IOSStringsOutputFile from "./shared/fileTypes/IOSStringsOutputFile"; +import fetchVariants from "../http/variants"; + +interface ComponentsMap { + [variantId: string]: ExportComponentsResponse +} +interface TextItemsMap { + [projectId: string]: { + [variantId: string]: ExportTextItemsResponse + } +} + +type IOSStringsAPIData = { + textItemsMap: TextItemsMap; + componentsMap: ComponentsMap; +}; + +export default class IOSStringsFormatter extends applyMixins( + BaseFormatter, IOSStringsAPIData>) { + private variants: { id: string }[] = []; + + protected async fetchAPIData() { + await this.fetchVariants(); + const textItemsMap = await this.fetchTextItemsMap(); + const componentsMap = await this.fetchComponentsMap(); + + return { textItemsMap, componentsMap }; + } + + /** + * For each project/variant permutation and its fetched .strings data, + * create a new file with the expected naming + * + * @returns {OutputFile[]} List of Output Files + */ + protected transformAPIData(data: IOSStringsAPIData) { + Object.entries(data.textItemsMap).forEach(([projectId, projectVariants]) => { + Object.entries(projectVariants).forEach(([variantId, iosStringsFile]) => { + const fileName = `${projectId}___${variantId || "base"}`; + this.outputFiles[fileName] ??= new IOSStringsOutputFile({ + filename: fileName, + path: this.outDir, + metadata: { variantId: variantId || "base" }, + content: iosStringsFile + }); + }); + }); + + Object.entries(data.componentsMap).forEach(([variantId, iosStringsFile]) => { + const fileName = `components___${variantId || "base"}`; + this.outputFiles[fileName] ??= new IOSStringsOutputFile({ + filename: fileName, + path: this.outDir, + metadata: { variantId: variantId || "base" }, + content: iosStringsFile + }); + }) + + return Object.values(this.outputFiles); + } + + /** + * Sets variants based on configuration + * - Fetches from API if "all" configured + * - Adds "base" variant by default if none configured + */ + private async fetchVariants(): Promise { + let variants: { id: string }[] = this.output.variants ?? this.projectConfig.variants ?? []; + if (variants.some((variant) => variant.id === 'all')) { + variants = await fetchVariants(this.meta); + } else if (variants.length === 0) { + variants = [{ id: 'base' }] + } + + this.variants = variants; + } + + /** + * Fetches text item data via API for each configured project and variant + * in this output + * + * @returns text items mapped to their respective variant and project + */ + private async fetchTextItemsMap(): Promise { + if (!this.projectConfig.projects && !this.output.projects) return {}; + let projects: { id: string }[] = this.output.projects ?? this.projectConfig.projects ?? []; + + const result: TextItemsMap = {}; + + if (projects.length === 0) { + projects = await fetchProjects(this.meta); + } + + for (const project of projects) { + result[project.id] = {}; + + for (const variant of this.variants) { + // map "base" to undefined, as by default export endpoint returns base variant + const variantsParam = variant.id === 'base' ? undefined : [{ id: variant.id }] + const params: PullQueryParams = { + ...super.generateQueryParams("textItem", { projects: [{ id: project.id }], variants: variantsParam }), + format: 'ios-strings' + }; + const iosStringsFile = await fetchText(params, this.meta); + result[project.id][variant.id] = iosStringsFile; + } + } + + return result; + } + + /** + * Fetches component data via API. + * If individual variants configured, fetch by each otherwise fetch for all + * Skips the fetch request if components field is not specified in config. + * + * @returns components data + */ + private async fetchComponentsMap(): Promise { + if (!this.projectConfig.components && !this.output.components) return {}; + const result: ComponentsMap = {}; + + for (const variant of this.variants) { + // map "base" to undefined, as by default export endpoint returns base variant + const variantsParam = variant.id === 'base' ? undefined : [{ id: variant.id }] + const params: PullQueryParams = { + ...super.generateQueryParams("component", { variants: variantsParam }), + format: 'ios-strings' + }; + const iosStringsFile = await fetchComponents(params, this.meta); + result[variant.id] = iosStringsFile; + } + + return result; + } +} diff --git a/lib/src/formatters/json.ts b/lib/src/formatters/json.ts index 8c189f3..7ac69b5 100644 --- a/lib/src/formatters/json.ts +++ b/lib/src/formatters/json.ts @@ -14,10 +14,8 @@ type JSONAPIData = { variablesById: Record; }; -type RequestType = "textItem" | "component"; - export default class JSONFormatter extends applyMixins( - BaseFormatter) { + BaseFormatter, JSONAPIData>) { protected async fetchAPIData() { const textItems = await this.fetchTextItems(); @@ -32,7 +30,7 @@ export default class JSONFormatter extends applyMixins( return { textItems, variablesById, components }; } - protected async transformAPIData(data: JSONAPIData) { + protected transformAPIData(data: JSONAPIData) { for (let i = 0; i < data.textItems.length; i++) { const textItem = data.textItems[i]; this.transformAPITextEntity(textItem, data.variablesById); @@ -44,13 +42,13 @@ export default class JSONFormatter extends applyMixins( } let results: OutputFile[] = [ - ...Object.values(this.outputJsonFiles), + ...Object.values(this.outputFiles), this.variablesOutputFile, ] if (this.output.framework) { // process framework - results.push(...getFrameworkProcessor(this.output).process(this.outputJsonFiles)); + results.push(...getFrameworkProcessor(this.output).process(this.outputFiles)); } return results; @@ -64,7 +62,7 @@ export default class JSONFormatter extends applyMixins( private transformAPITextEntity(textEntity: TextItem | Component, variablesById: Record) { const fileName = isTextItem(textEntity) ? `${textEntity.projectId}___${textEntity.variantId || "base"}` : `components___${textEntity.variantId || "base"}`; - this.outputJsonFiles[fileName] ??= new JSONOutputFile({ + this.outputFiles[fileName] ??= new JSONOutputFile({ filename: fileName, path: this.outDir, metadata: { variantId: textEntity.variantId || "base" }, @@ -78,69 +76,13 @@ export default class JSONFormatter extends applyMixins( ? textEntity.richText : textEntity.text; - this.outputJsonFiles[fileName].content[textEntity.id] = textValue; + this.outputFiles[fileName].content[textEntity.id] = textValue; for (const variableId of textEntity.variableIds) { const variable = variablesById[variableId]; this.variablesOutputFile.content[variableId] = variable.data; } } - private generateTextItemPullFilter() { - let filters: PullFilters = { - projects: this.projectConfig.projects, - variants: this.projectConfig.variants, - }; - - if (this.output.projects) { - filters.projects = this.output.projects; - } - - if (this.output.variants) { - filters.variants = this.output.variants; - } - - return filters; - } - - private generateComponentPullFilter() { - let filters: PullFilters = { - ...(this.projectConfig.components?.folders && { folders: this.projectConfig.components.folders }), - variants: this.projectConfig.variants, - }; - - if (this.output.components) { - filters.folders = this.output.components?.folders; - } - - if (this.output.variants) { - filters.variants = this.output.variants; - } - - return filters; - } - - /** - * Returns the query parameters for the fetchText API request - */ - private generateQueryParams(requestType: RequestType) { - const filter = requestType === "textItem" ? this.generateTextItemPullFilter() : this.generateComponentPullFilter(); - - let params: PullQueryParams = { - filter: JSON.stringify(filter), - }; - - if (this.projectConfig.richText) { - params.richText = this.projectConfig.richText; - } - - if (this.output.richText) { - params.richText = this.output.richText; - } - - - return params; - } - /** * Fetches text item data via API. * Skips the fetch request if projects field is not specified in config. @@ -150,7 +92,7 @@ export default class JSONFormatter extends applyMixins( private async fetchTextItems() { if (!this.projectConfig.projects && !this.output.projects) return []; - return await fetchText(this.generateQueryParams("textItem"), this.meta); + return await fetchText(super.generateQueryParams("textItem"), this.meta); } /** @@ -162,7 +104,7 @@ export default class JSONFormatter extends applyMixins( private async fetchComponents() { if (!this.projectConfig.components && !this.output.components) return []; - return await fetchComponents(this.generateQueryParams("component"), this.meta); + return await fetchComponents(super.generateQueryParams("component"), this.meta); } private async fetchVariables() { diff --git a/lib/src/formatters/shared/base.test.ts b/lib/src/formatters/shared/base.test.ts new file mode 100644 index 0000000..83ea850 --- /dev/null +++ b/lib/src/formatters/shared/base.test.ts @@ -0,0 +1,447 @@ +import BaseFormatter from "./base"; +import { Output } from "../../outputs"; +import { ProjectConfigYAML } from "../../services/projectConfig"; +import { CommandMetaFlags, PullFilters } from "../../http/types"; +import JSONOutputFile from "./fileTypes/JSONOutputFile"; + +// fake test class to expose private methods +// @ts-ignore +class TestBaseFormatter extends BaseFormatter { + public generateTextItemPullFilter() { + return super["generateTextItemPullFilter"](); + } + + public generateComponentPullFilter() { + return super["generateComponentPullFilter"](); + } + + public generateQueryParams( + requestType: "textItem" | "component", + filter: PullFilters = {} + ) { + return super.generateQueryParams(requestType, filter); + } +} + +describe("BaseFormatter", () => { + const createMockOutput = (overrides: Partial = {}): Output => ({ + format: "json", + ...overrides, + }); + + const createMockProjectConfig = ( + overrides: Partial = {} + ): ProjectConfigYAML => ({ + projects: [], + variants: [], + components: { + folders: [], + }, + outputs: [ + { + format: "json", + }, + ], + ...overrides, + }); + + const createMockMeta = (): CommandMetaFlags => ({}); + + /*********************************************************** + * generateTextItemPullFilter + ***********************************************************/ + + describe("generateTextItemPullFilter", () => { + it("should use projectConfig projects and variants when output does not override", () => { + const projectConfig = createMockProjectConfig({ + projects: [{ id: "project1" }, { id: "project2" }], + variants: [{ id: "variant1" }], + }); + const output = createMockOutput(); + const formatter = new TestBaseFormatter( + output, + projectConfig, + createMockMeta() + ); + + const filters = formatter.generateTextItemPullFilter(); + + expect(filters).toEqual({ + projects: [{ id: "project1" }, { id: "project2" }], + variants: [{ id: "variant1" }], + }); + }); + + it("should override projects with output.projects when provided", () => { + const projectConfig = createMockProjectConfig({ + projects: [{ id: "project1" }, { id: "project2" }], + variants: [{ id: "variant1" }], + }); + const output = createMockOutput({ + projects: [{ id: "project3" }], + }); + const formatter = new TestBaseFormatter( + output, + projectConfig, + createMockMeta() + ); + + const filters = formatter.generateTextItemPullFilter(); + + expect(filters).toEqual({ + projects: [{ id: "project3" }], + variants: [{ id: "variant1" }], + }); + }); + + it("should override variants with output.variants when provided", () => { + const projectConfig = createMockProjectConfig({ + projects: [{ id: "project1" }], + variants: [{ id: "variant1" }], + }); + const output = createMockOutput({ + variants: [{ id: "variant2" }, { id: "variant3" }], + }); + const formatter = new TestBaseFormatter( + output, + projectConfig, + createMockMeta() + ); + + const filters = formatter.generateTextItemPullFilter(); + + expect(filters).toEqual({ + projects: [{ id: "project1" }], + variants: [{ id: "variant2" }, { id: "variant3" }], + }); + }); + + it("should override both projects and variants when both are provided in output", () => { + const projectConfig = createMockProjectConfig({ + projects: [{ id: "project1" }], + variants: [{ id: "variant1" }], + }); + const output = createMockOutput({ + projects: [{ id: "project2" }], + variants: [{ id: "variant2" }], + }); + const formatter = new TestBaseFormatter( + output, + projectConfig, + createMockMeta() + ); + + const filters = formatter.generateTextItemPullFilter(); + + expect(filters).toEqual({ + projects: [{ id: "project2" }], + variants: [{ id: "variant2" }], + }); + }); + + it("should handle undefined projects and variants in projectConfig", () => { + const projectConfig = createMockProjectConfig({ + projects: undefined, + variants: undefined, + }); + const output = createMockOutput(); + const formatter = new TestBaseFormatter( + output, + projectConfig, + createMockMeta() + ); + + const filters = formatter.generateTextItemPullFilter(); + + expect(filters).toEqual({ + projects: undefined, + variants: undefined, + }); + }); + }); + + /*********************************************************** + * generateComponentPullFilter + ***********************************************************/ + describe("generateComponentPullFilter", () => { + const getComponentPullFilters = ( + mockProjectConfig: any, + mockOutput?: any + ) => { + const projectConfig = createMockProjectConfig(mockProjectConfig); + const output = createMockOutput(mockOutput); + const formatter = new TestBaseFormatter( + output, + projectConfig, + createMockMeta() + ); + + return formatter.generateComponentPullFilter(); + }; + + it("should use projectConfig components.folders and variants when output is not provided", () => { + const filters = getComponentPullFilters({ + components: { + folders: [ + { id: "folder1" }, + { id: "folder2", excludeNestedFolders: true }, + ], + }, + variants: [{ id: "variant1" }], + }); + + expect(filters).toEqual({ + folders: [ + { id: "folder1" }, + { id: "folder2", excludeNestedFolders: true }, + ], + variants: [{ id: "variant1" }], + }); + }); + + it("should not include folders when projectConfig.components.folders is undefined", () => { + const filters = getComponentPullFilters({ + components: { + folders: undefined, + }, + variants: [{ id: "variant1" }], + }); + + expect(filters).toEqual({ + variants: [{ id: "variant1" }], + }); + expect(filters.folders).toBeUndefined(); + }); + + it("should override folders with output.components.folders when provided", () => { + const filters = getComponentPullFilters( + { + components: { + folders: [{ id: "folder1" }], + }, + variants: [{ id: "variant1" }], + }, + { + components: { + folders: [{ id: "folder2" }], + }, + } + ); + + expect(filters).toEqual({ + folders: [{ id: "folder2" }], + variants: [{ id: "variant1" }], + }); + }); + + it("should override variants with output.variants when provided", () => { + const filters = getComponentPullFilters( + { + components: { + folders: [{ id: "folder1" }], + }, + variants: [{ id: "variant1" }], + }, + { + variants: [{ id: "variant2" }], + } + ); + + expect(filters).toEqual({ + folders: [{ id: "folder1" }], + variants: [{ id: "variant2" }], + }); + }); + + it("should override both folders and variants when both are provided in output", () => { + const filters = getComponentPullFilters( + { + components: { + folders: [{ id: "folder1" }], + }, + variants: [{ id: "variant1" }], + }, + { + components: { + folders: [{ id: "folder2" }], + }, + variants: [{ id: "variant2" }], + } + ); + expect(filters).toEqual({ + folders: [{ id: "folder2" }], + variants: [{ id: "variant2" }], + }); + }); + + it("should handle undefined components in projectConfig", () => { + const filters = getComponentPullFilters({ + components: undefined, + variants: [{ id: "variant1" }], + }); + + expect(filters).toEqual({ + variants: [{ id: "variant1" }], + }); + expect(filters.folders).toBeUndefined(); + }); + }); + + /*********************************************************** + * generateQueryParams + ***********************************************************/ + + describe("generateQueryParams", () => { + it("should generate query params for RequestType: textItem", () => { + const projectConfig = createMockProjectConfig({ + projects: [{ id: "project1" }], + variants: [{ id: "variant1" }], + }); + const output = createMockOutput(); + const formatter = new TestBaseFormatter( + output, + projectConfig, + createMockMeta() + ); + + const params = formatter.generateQueryParams("textItem"); + + expect(params.filter).toBeDefined(); + const parsedFilter = JSON.parse(params.filter); + expect(parsedFilter).toEqual({ + projects: [{ id: "project1" }], + variants: [{ id: "variant1" }], + }); + expect(params.richText).toBeUndefined(); + }); + + it("should generate query params for RequestType: component", () => { + const projectConfig = createMockProjectConfig({ + components: { + folders: [{ id: "folder1" }], + }, + variants: [{ id: "variant1" }], + }); + const output = createMockOutput(); + const formatter = new TestBaseFormatter( + output, + projectConfig, + createMockMeta() + ); + + const params = formatter.generateQueryParams("component"); + + expect(params.filter).toBeDefined(); + const parsedFilter = JSON.parse(params.filter); + expect(parsedFilter).toEqual({ + folders: [{ id: "folder1" }], + variants: [{ id: "variant1" }], + }); + expect(params.richText).toBeUndefined(); + }); + + it("should merge additional filter with base filter", () => { + const projectConfig = createMockProjectConfig({ + projects: [{ id: "project1" }], + variants: [{ id: "variant1" }], + }); + const output = createMockOutput(); + const formatter = new TestBaseFormatter( + output, + projectConfig, + createMockMeta() + ); + + const additionalFilter: PullFilters = { + projects: [{ id: "project2" }], + }; + const params = formatter.generateQueryParams( + "textItem", + additionalFilter + ); + + expect(params.filter).toBeDefined(); + const parsedFilter = JSON.parse(params.filter); + expect(parsedFilter).toEqual({ + projects: [{ id: "project2" }], // Additional filter overrides base + variants: [{ id: "variant1" }], + }); + }); + + it("should include richText from projectConfig when set", () => { + const projectConfig = createMockProjectConfig({ + projects: [{ id: "project1" }], + richText: "html", + }); + const output = createMockOutput(); + const formatter = new TestBaseFormatter( + output, + projectConfig, + createMockMeta() + ); + + const params = formatter.generateQueryParams("textItem"); + + expect(params.richText).toBe("html"); + }); + + it("should override projectConfig richText with output richText when both are set", () => { + const projectConfig = createMockProjectConfig({ + projects: [{ id: "project1" }], + richText: false, + }); + const output = createMockOutput({ + richText: "html", + }); + const formatter = new TestBaseFormatter( + output, + projectConfig, + createMockMeta() + ); + + const params = formatter.generateQueryParams("textItem"); + + expect(params.richText).toBe("html"); + }); + + it("should use output richText when only output has richText set", () => { + const projectConfig = createMockProjectConfig({ + projects: [{ id: "project1" }], + }); + const output = createMockOutput({ + richText: "html", + }); + const formatter = new TestBaseFormatter( + output, + projectConfig, + createMockMeta() + ); + + const params = formatter.generateQueryParams("textItem"); + + expect(params.richText).toBe("html"); + }); + + it("should handle empty filter object", () => { + const projectConfig = createMockProjectConfig({ + projects: [{ id: "project1" }], + variants: [{ id: "variant1" }], + }); + const output = createMockOutput(); + const formatter = new TestBaseFormatter( + output, + projectConfig, + createMockMeta() + ); + + const params = formatter.generateQueryParams("textItem", undefined); + + expect(params.filter).toBeDefined(); + const parsedFilter = JSON.parse(params.filter); + expect(parsedFilter).toEqual({ + projects: [{ id: "project1" }], + variants: [{ id: "variant1" }], + }); + }); + }); +}); diff --git a/lib/src/formatters/shared/base.ts b/lib/src/formatters/shared/base.ts index 797ff0c..824f3b4 100644 --- a/lib/src/formatters/shared/base.ts +++ b/lib/src/formatters/shared/base.ts @@ -5,16 +5,18 @@ import { ProjectConfigYAML } from "../../services/projectConfig"; import OutputFile from "./fileTypes/OutputFile"; import appContext from "../../utils/appContext"; import JSONOutputFile from "./fileTypes/JSONOutputFile"; -import { CommandMetaFlags } from "../../http/types"; +import { + CommandMetaFlags, + PullFilters, + PullQueryParams, +} from "../../http/types"; -export default class BaseFormatter { +type RequestType = "textItem" | "component"; +export default class BaseFormatter { protected output: Output; protected projectConfig: ProjectConfigYAML; protected outDir: string; - protected outputJsonFiles: Record< - string, - JSONOutputFile<{ variantId: string }> - >; + protected outputFiles: Record; protected variablesOutputFile: JSONOutputFile; protected meta: CommandMetaFlags; @@ -26,7 +28,7 @@ export default class BaseFormatter { this.output = output; this.projectConfig = projectConfig; this.outDir = output.outDir ?? appContext.outDir; - this.outputJsonFiles = {}; + this.outputFiles = {}; this.variablesOutputFile = new JSONOutputFile({ filename: "variables", path: this.outDir, @@ -34,15 +36,78 @@ export default class BaseFormatter { this.meta = meta; } + private generateTextItemPullFilter() { + let filters: PullFilters = { + projects: this.projectConfig.projects, + variants: this.projectConfig.variants, + }; + + if (this.output.projects) { + filters.projects = this.output.projects; + } + + if (this.output.variants) { + filters.variants = this.output.variants; + } + + return filters; + } + + private generateComponentPullFilter() { + let filters: PullFilters = { + ...(this.projectConfig.components?.folders && { + folders: this.projectConfig.components.folders, + }), + variants: this.projectConfig.variants, + }; + + if (this.output.components) { + filters.folders = this.output.components?.folders; + } + + if (this.output.variants) { + filters.variants = this.output.variants; + } + + return filters; + } + + /** + * Returns the query parameters for the fetchText API request + */ + protected generateQueryParams( + requestType: RequestType, + filter: PullFilters = {} + ): PullQueryParams { + const baseFilter = + requestType === "textItem" + ? this.generateTextItemPullFilter() + : this.generateComponentPullFilter(); + + let params: PullQueryParams = { + filter: JSON.stringify({ ...baseFilter, ...filter }), + }; + + if (this.projectConfig.richText) { + params.richText = this.projectConfig.richText; + } + + if (this.output.richText) { + params.richText = this.output.richText; + } + + return params; + } + protected async fetchAPIData(): Promise { return {} as APIDataType; } - protected async transformAPIData(data: APIDataType): Promise { + protected transformAPIData(data: APIDataType): OutputFile[] { return []; } - async format(): Promise { + public async format(): Promise { const data = await this.fetchAPIData(); const files = await this.transformAPIData(data); await this.writeFiles(files); diff --git a/lib/src/formatters/shared/fileTypes/IOSStringsOutputFile.ts b/lib/src/formatters/shared/fileTypes/IOSStringsOutputFile.ts new file mode 100644 index 0000000..6c6dd9a --- /dev/null +++ b/lib/src/formatters/shared/fileTypes/IOSStringsOutputFile.ts @@ -0,0 +1,25 @@ +import OutputFile from "./OutputFile"; + +export default class IOSStringsOutputFile extends OutputFile< + string, + MetadataType +> { + constructor(config: { + filename: string; + path: string; + content?: string; + metadata?: MetadataType; + }) { + super({ + filename: config.filename, + path: config.path, + extension: "strings", + content: config.content ?? "", + metadata: config.metadata ?? ({} as MetadataType), + }); + } + + get formattedContent(): string { + return this.content; + } +} diff --git a/lib/src/http/components.ts b/lib/src/http/components.ts index 70c26cf..2d3d822 100644 --- a/lib/src/http/components.ts +++ b/lib/src/http/components.ts @@ -1,23 +1,18 @@ import { AxiosError } from "axios"; import { ZComponentsResponse, + ZExportComponentsResponse, PullQueryParams, CommandMetaFlags, } from "./types"; import getHttpClient from "./client"; -export default async function fetchComponents( - params: PullQueryParams, - meta: CommandMetaFlags +function fetchComponentsWrapper( + performRequest: () => Promise ) { try { - const httpClient = getHttpClient({ meta }); - const response = await httpClient.get("/v2/components", { - params, - }); - - return ZComponentsResponse.parse(response.data); - } catch (e) { + return performRequest(); + } catch (e: unknown) { if (!(e instanceof AxiosError)) { throw new Error( "Sorry! We're having trouble reaching the Ditto API. Please try again later." @@ -41,3 +36,27 @@ export default async function fetchComponents( throw e; } } + +export default async function fetchComponents( + params: PullQueryParams, + meta: CommandMetaFlags +) { + switch (params.format) { + case "ios-strings": + return fetchComponentsWrapper(async () => { + const httpClient = getHttpClient({ meta }); + const response = await httpClient.get("/v2/components/export", { + params, + }); + return ZExportComponentsResponse.parse(response.data) as TResponse; + }); + default: + return fetchComponentsWrapper(async () => { + const httpClient = getHttpClient({ meta }); + const response = await httpClient.get("/v2/components", { + params, + }); + return ZComponentsResponse.parse(response.data) as TResponse; + }); + } +} diff --git a/lib/src/http/projects.test.ts b/lib/src/http/projects.test.ts new file mode 100644 index 0000000..0401f86 --- /dev/null +++ b/lib/src/http/projects.test.ts @@ -0,0 +1,51 @@ +import getHttpClient from "./client"; +import fetchProjects from "./projects"; + +jest.mock("./client"); + +describe("fetchProjects", () => { + const mockHttpClient = { + get: jest.fn(), + }; + + (getHttpClient as jest.Mock).mockReturnValue(mockHttpClient); + + beforeEach(() => { + jest.clearAllMocks(); + }); + + it("should parse response correctly", async () => { + const mockResponse = { + data: [ + { + id: "project1", + name: "Project One", + }, + { + id: "project2", + name: "Project Two", + }, + ], + }; + + mockHttpClient.get.mockResolvedValue(mockResponse); + const result = await fetchProjects({}); + expect(result).toEqual([...mockResponse.data]); + }); + + it("should handle empty response", async () => { + const mockResponse = { data: [] }; + mockHttpClient.get.mockResolvedValue(mockResponse); + const result = await fetchProjects({}); + expect(result).toEqual([]); + }); + + it("should have user-friendly error response if not instance of AxiosError", async () => { + const mockError = new Error("Request failed"); + mockHttpClient.get.mockRejectedValue(mockError); + + await expect(fetchProjects({})).rejects.toThrow( + "Sorry! We're having trouble reaching the Ditto API. Please try again later." + ); + }); +}); diff --git a/lib/src/http/projects.ts b/lib/src/http/projects.ts new file mode 100644 index 0000000..45c4d0b --- /dev/null +++ b/lib/src/http/projects.ts @@ -0,0 +1,20 @@ +import { AxiosError } from "axios"; +import { ZProjectsResponse, CommandMetaFlags } from "./types"; +import getHttpClient from "./client"; + +export default async function fetchProjects(meta: CommandMetaFlags) { + try { + const httpClient = getHttpClient({ meta }); + const response = await httpClient.get("/v2/projects"); + + return ZProjectsResponse.parse(response.data); + } catch (e) { + if (!(e instanceof AxiosError)) { + throw new Error( + "Sorry! We're having trouble reaching the Ditto API. Please try again later." + ); + } + + throw e; + } +} diff --git a/lib/src/http/textItems.ts b/lib/src/http/textItems.ts index 57d4618..36c9442 100644 --- a/lib/src/http/textItems.ts +++ b/lib/src/http/textItems.ts @@ -1,17 +1,16 @@ import httpClient from "./client"; import { AxiosError } from "axios"; -import { CommandMetaFlags, PullQueryParams, ZTextItemsResponse } from "./types"; +import { + CommandMetaFlags, + PullQueryParams, + ZTextItemsResponse, + ZExportTextItemsResponse, +} from "./types"; import getHttpClient from "./client"; -export default async function fetchText( - params: PullQueryParams, - meta: CommandMetaFlags -) { +function fetchTextWrapper(cb: () => Promise) { try { - const httpClient = getHttpClient({ meta }); - const response = await httpClient.get("/v2/textItems", { params }); - - return ZTextItemsResponse.parse(response.data); + return cb(); } catch (e: unknown) { if (!(e instanceof AxiosError)) { throw new Error( @@ -36,3 +35,25 @@ export default async function fetchText( throw e; } } + +export default async function fetchText( + params: PullQueryParams, + meta: CommandMetaFlags +) { + switch (params.format) { + case "ios-strings": + return fetchTextWrapper(async () => { + const httpClient = getHttpClient({ meta }); + const response = await httpClient.get("/v2/textItems/export", { + params, + }); + return ZExportTextItemsResponse.parse(response.data) as TResponse; + }); + default: + return fetchTextWrapper(async () => { + const httpClient = getHttpClient({ meta }); + const response = await httpClient.get("/v2/textItems", { params }); + return ZTextItemsResponse.parse(response.data) as TResponse; + }); + } +} diff --git a/lib/src/http/types.ts b/lib/src/http/types.ts index bd11c07..df18bd5 100644 --- a/lib/src/http/types.ts +++ b/lib/src/http/types.ts @@ -12,6 +12,7 @@ export interface PullFilters { export interface PullQueryParams { filter: string; // Stringified PullFilters richText?: "html"; + format?: "ios-strings" | undefined; } const ZBaseTextEntity = z.object({ @@ -41,6 +42,9 @@ export type TextItem = z.infer; export const ZTextItemsResponse = z.array(ZTextItem); export type TextItemsResponse = z.infer; +export const ZExportTextItemsResponse = z.string(); +export type ExportTextItemsResponse = z.infer; + // MARK - Components const ZComponent = ZBaseTextEntity.extend({ @@ -55,6 +59,40 @@ export type Component = z.infer; export const ZComponentsResponse = z.array(ZComponent); export type ComponentsResponse = z.infer; +export const ZExportComponentsResponse = z.string(); +export type ExportComponentsResponse = z.infer; + +// MARK - Projects + +const ZProject = z.object({ + id: z.string(), + name: z.string(), +}); + +/** + * Represents a single project, as returned from the /v2/projects endpoint + */ +export type Project = z.infer; + +export const ZProjectsResponse = z.array(ZProject); +export type ProjectsResponse = z.infer; + +// MARK - Variants + +const ZVariant = z.object({ + id: z.string(), + name: z.string(), + description: z.string().optional(), +}); + +/** + * Represents a single variant, as returned from the /v2/variants endpoint + */ +export type Variant = z.infer; + +export const ZVariantsResponse = z.array(ZVariant); +export type VariantsResponse = z.infer; + /** * Contains metadata attached to CLI commands via -m or --meta flag * Currently only used internally to identify requests from our GitHub Action diff --git a/lib/src/http/variants.test.ts b/lib/src/http/variants.test.ts new file mode 100644 index 0000000..14c3fbb --- /dev/null +++ b/lib/src/http/variants.test.ts @@ -0,0 +1,66 @@ +import getHttpClient from "./client"; +import fetchVariants from "./variants"; + +jest.mock("./client"); + +describe("fetchVariants", () => { + const mockHttpClient = { get: jest.fn() }; + + (getHttpClient as jest.Mock).mockReturnValue(mockHttpClient); + + beforeEach(() => { + jest.clearAllMocks(); + }); + + it("should parse response correctly", async () => { + const mockResponse = { + data: [ + { + id: "variant1", + name: "Variant One", + description: "This is variant one", + }, + { + id: "variant2", + name: "Variant Two", + description: "This is variant two", + }, + ], + }; + + mockHttpClient.get.mockResolvedValue(mockResponse); + const result = await fetchVariants({}); + expect(result).toEqual([...mockResponse.data]); + }); + + it("should handle response without description field", async () => { + const mockResponse = { + data: [ + { + id: "variant1", + name: "Variant One", + }, + ], + }; + + mockHttpClient.get.mockResolvedValue(mockResponse); + const result = await fetchVariants({}); + expect(result).toEqual([...mockResponse.data]); + }); + + it("should handle empty response", async () => { + const mockResponse = { data: [] }; + mockHttpClient.get.mockResolvedValue(mockResponse); + const result = await fetchVariants({}); + expect(result).toEqual([]); + }); + + it("should have user-friendly error response if not instance of AxiosError", async () => { + const mockError = new Error("Request failed"); + mockHttpClient.get.mockRejectedValue(mockError); + + await expect(fetchVariants({})).rejects.toThrow( + "Sorry! We're having trouble reaching the Ditto API. Please try again later." + ); + }); +}); diff --git a/lib/src/http/variants.ts b/lib/src/http/variants.ts new file mode 100644 index 0000000..16fd4dd --- /dev/null +++ b/lib/src/http/variants.ts @@ -0,0 +1,20 @@ +import { AxiosError } from "axios"; +import { ZVariantsResponse, CommandMetaFlags } from "./types"; +import getHttpClient from "./client"; + +export default async function fetchVariants(meta: CommandMetaFlags) { + try { + const httpClient = getHttpClient({ meta }); + const response = await httpClient.get("/v2/variants"); + + return ZVariantsResponse.parse(response.data); + } catch (e) { + if (!(e instanceof AxiosError)) { + throw new Error( + "Sorry! We're having trouble reaching the Ditto API. Please try again later." + ); + } + + throw e; + } +} diff --git a/lib/src/outputs/index.ts b/lib/src/outputs/index.ts index 303b95b..ae109ce 100644 --- a/lib/src/outputs/index.ts +++ b/lib/src/outputs/index.ts @@ -1,9 +1,10 @@ import { z } from "zod"; import { ZJSONOutput } from "./json"; +import { ZIOSStringsOutput } from "./iosStrings"; /** * The output config is a discriminated union of all the possible output formats. */ -export const ZOutput = z.union([...ZJSONOutput.options]); +export const ZOutput = z.union([...ZJSONOutput.options, ZIOSStringsOutput]); export type Output = z.infer; diff --git a/lib/src/outputs/iosStrings.ts b/lib/src/outputs/iosStrings.ts new file mode 100644 index 0000000..1dd64b4 --- /dev/null +++ b/lib/src/outputs/iosStrings.ts @@ -0,0 +1,7 @@ +import { z } from "zod"; +import { ZBaseOutputFilters } from "./shared"; + +export const ZIOSStringsOutput = ZBaseOutputFilters.extend({ + format: z.literal("ios-strings"), + framework: z.undefined(), +}).strict(); From 7cfe2f242c725d04ba51d49146c99ffe4ac5f195 Mon Sep 17 00:00:00 2001 From: Brian Parrish Date: Wed, 17 Dec 2025 17:13:30 -0500 Subject: [PATCH 2/2] [DIT-11792][DIT-11791][DIT-11960] IOS Strings Dict, Android, ICU format additions (#130) * Add ios-stringsdict support to BaseFormatter * Refactor IOSStringsFileFormatter into BaseExportFormatter to be shared amongst all export formats. Updated IOSStringsDict to use that class * Add android export format * Add BaseExportFormatter class tests. Updated IOSStringsFormatter tests to no longer include baseExport method tests. Updated all formats to test for correct output file creation * Update base generateQueryParams to take in filters as sole param * Add i18n test cases * Add ios-stringsdict and Android XML formatting tests to pull * Add ICU format. Update HTTP Response types to allow for JSON. Added generics to BaseFormatter to allow for parameter-ized response types * Updated ExportComponentsResponse and TextItemsResponse Zod schema * Made BaseExportFormatter abstract class * Minor: clean * Test fix and HTTP wrapper cleanup * Minor: clean * Add promise.all to fetchTextItemsMap and fetchComponentsMap for performance --- lib/src/commands/pull.test.ts | 572 ++++++++++-------- lib/src/formatters/android.test.ts | 116 ++++ lib/src/formatters/android.ts | 28 + lib/src/formatters/icu.ts | 28 + lib/src/formatters/index.ts | 9 + lib/src/formatters/iosStrings.test.ts | 465 ++------------ lib/src/formatters/iosStrings.ts | 161 +---- lib/src/formatters/iosStringsDict.test.ts | 117 ++++ lib/src/formatters/iosStringsDict.ts | 27 + lib/src/formatters/json.ts | 8 +- lib/src/formatters/shared/base.test.ts | 78 +-- lib/src/formatters/shared/base.ts | 17 +- lib/src/formatters/shared/baseExport.test.ts | 441 ++++++++++++++ lib/src/formatters/shared/baseExport.ts | 193 ++++++ .../shared/fileTypes/AndroidOutputFile.ts | 25 + .../shared/fileTypes/ICUOutputFile.ts | 25 + .../fileTypes/IOSStringsDictOutputFile.ts | 25 + lib/src/http/components.ts | 50 +- lib/src/http/textItems.ts | 45 +- lib/src/http/types.ts | 35 +- lib/src/outputs/android.ts | 7 + lib/src/outputs/icu.ts | 7 + lib/src/outputs/index.ts | 11 +- lib/src/outputs/iosStringsDict.ts | 7 + 24 files changed, 1567 insertions(+), 930 deletions(-) create mode 100644 lib/src/formatters/android.test.ts create mode 100644 lib/src/formatters/android.ts create mode 100644 lib/src/formatters/icu.ts create mode 100644 lib/src/formatters/iosStringsDict.test.ts create mode 100644 lib/src/formatters/iosStringsDict.ts create mode 100644 lib/src/formatters/shared/baseExport.test.ts create mode 100644 lib/src/formatters/shared/baseExport.ts create mode 100644 lib/src/formatters/shared/fileTypes/AndroidOutputFile.ts create mode 100644 lib/src/formatters/shared/fileTypes/ICUOutputFile.ts create mode 100644 lib/src/formatters/shared/fileTypes/IOSStringsDictOutputFile.ts create mode 100644 lib/src/outputs/android.ts create mode 100644 lib/src/outputs/icu.ts create mode 100644 lib/src/outputs/iosStringsDict.ts diff --git a/lib/src/commands/pull.test.ts b/lib/src/commands/pull.test.ts index bd6b456..fe6ea93 100644 --- a/lib/src/commands/pull.test.ts +++ b/lib/src/commands/pull.test.ts @@ -5,6 +5,7 @@ import appContext from "../utils/appContext"; import * as path from "path"; import * as fs from "fs"; import * as os from "os"; +import validateXMLString from "../utils/validateXML"; jest.mock("../http/client"); @@ -16,7 +17,9 @@ const mockHttpClient = { // Make getHttpClient return the mock client (getHttpClient as jest.Mock).mockReturnValue(mockHttpClient); -// Test data factories +/********************************************************** + * HELPERS + **********************************************************/ const createMockTextItem = (overrides: Partial = {}) => ({ id: "text-1", text: "Plain text content", @@ -54,6 +57,108 @@ const createMockVariable = (overrides: any = {}) => ({ ...overrides, }); +const createMockData = () => { + // project-1 and project-2 each have at least one base text item + const baseTextItems = [ + createMockTextItem({ + projectId: "project-1", + variantId: null, + id: "text-1", + }), + createMockTextItem({ + projectId: "project-1", + variantId: null, + id: "text-2", + }), + createMockTextItem({ + projectId: "project-2", + variantId: null, + id: "text-3", + }), + ]; + + // project-1 and project-2 each have a variant-a text item + const variantATextItems = [ + createMockTextItem({ + projectId: "project-1", + variantId: "variant-a", + id: "text-4", + }), + createMockTextItem({ + projectId: "project-2", + variantId: "variant-a", + id: "text-5", + }), + ]; + + // Only project-1 has variant-b, so only project-1 should get a variant-b file + const variantBTextItems = [ + createMockTextItem({ + projectId: "project-1", + variantId: "variant-b", + id: "text-6", + }), + createMockTextItem({ + projectId: "project-1", + variantId: "variant-b", + id: "text-7", + }), + ]; + + const componentsBase = [ + createMockComponent({ + id: "comp-1", + variantId: null, + folderId: null, + }), + createMockComponent({ + id: "comp-2", + variantId: null, + folderId: "folder-1", + }), + createMockComponent({ + id: "comp-3", + variantId: null, + folderId: "folder-2", + }), + ]; + + const componentsVariantA = [ + createMockComponent({ + id: "comp-4", + variantId: "variant-a", + folderId: null, + }), + createMockComponent({ + id: "comp-5", + variantId: "variant-a", + folderId: "folder-1", + }), + ]; + + const componentsVariantB = [ + createMockComponent({ + id: "comp-6", + variantId: "variant-b", + folderId: null, + }), + createMockComponent({ + id: "comp-7", + variantId: "variant-b", + folderId: "folder-1", + }), + ]; + + return { + textItems: [...baseTextItems, ...variantATextItems, ...variantBTextItems], + components: [ + ...componentsBase, + ...componentsVariantA, + ...componentsVariantB, + ], + }; +}; + // Helper functions const setupMocks = ({ textItems = [], @@ -78,6 +183,33 @@ const setupMocks = ({ }); }; +const setupExportMocks = ({ + textItems, + components, + variables = [], +}: { + textItems: any; + components?: any; + variables?: any[]; +}) => { + mockHttpClient.get.mockImplementation((url: string, config?: any) => { + if (url.includes("/v2/textItems/export")) { + return Promise.resolve({ + data: textItems, + }); + } + if (url.includes("/v2/variables")) { + return Promise.resolve({ data: variables }); + } + if (url.includes("/v2/components/export")) { + return Promise.resolve({ + data: components, + }); + } + return Promise.resolve({ data: [] }); + }); +}; + const parseJsonFile = (filepath: string) => { const content = fs.readFileSync(filepath, "utf-8"); return JSON.parse(content); @@ -97,6 +229,10 @@ const assertFilesCreated = (outputDir: string, expectedFiles: string[]) => { expect(actualFiles).toEqual(expectedFiles.toSorted()); }; +/********************************************************** + * E2E Tests + **********************************************************/ + describe("pull command - end-to-end tests", () => { // Create a temporary directory for tests let testDir: string; @@ -469,10 +605,25 @@ describe("pull command - end-to-end tests", () => { }); }); + /********************************************************** + * OUTPUT TESTS - JSON + **********************************************************/ describe("Output files - JSON", () => { + const expectedJSONFiles = [ + "project-1___base.json", + "project-1___variant-a.json", + "project-1___variant-b.json", + "project-2___base.json", + "project-2___variant-a.json", + "components___base.json", + "components___variant-a.json", + "components___variant-b.json", + "variables.json", + ]; + it("should create output files for each project and variant returned from the API", async () => { fs.mkdirSync(outputDir, { recursive: true }); - + setupMocks(createMockData()); appContext.setProjectConfig({ projects: [], components: {}, @@ -484,168 +635,60 @@ describe("pull command - end-to-end tests", () => { ], }); - // project-1 and project-2 each have at least one base text item - const baseTextItems = [ - createMockTextItem({ - projectId: "project-1", - variantId: null, - id: "text-1", - }), - createMockTextItem({ - projectId: "project-1", - variantId: null, - id: "text-2", - }), - createMockTextItem({ - projectId: "project-2", - variantId: null, - id: "text-3", - }), - ]; - - // project-1 and project-2 each have a variant-a text item - const variantATextItems = [ - createMockTextItem({ - projectId: "project-1", - variantId: "variant-a", - id: "text-4", - }), - createMockTextItem({ - projectId: "project-2", - variantId: "variant-a", - id: "text-5", - }), - ]; - - // Only project-1 has variant-b, so only project-1 should get a variant-b file - const variantBTextItems = [ - createMockTextItem({ - projectId: "project-1", - variantId: "variant-b", - id: "text-6", - }), - createMockTextItem({ - projectId: "project-1", - variantId: "variant-b", - id: "text-7", - }), - ]; - - const componentsBase = [ - createMockComponent({ - id: "comp-1", - variantId: null, - folderId: null, - }), - createMockComponent({ - id: "comp-2", - variantId: null, - folderId: "folder-1", - }), - createMockComponent({ - id: "comp-3", - variantId: null, - folderId: "folder-2", - }), - ]; - - const componentsVariantA = [ - createMockComponent({ - id: "comp-4", - variantId: "variant-a", - folderId: null, - }), - createMockComponent({ - id: "comp-5", - variantId: "variant-a", - folderId: "folder-1", - }), - ]; - - const componentsVariantB = [ - createMockComponent({ - id: "comp-6", - variantId: "variant-b", - folderId: null, - }), - createMockComponent({ - id: "comp-7", - variantId: "variant-b", - folderId: "folder-1", - }), - ]; - - setupMocks({ - textItems: [ - ...baseTextItems, - ...variantATextItems, - ...variantBTextItems, - ], - components: [ - ...componentsBase, - ...componentsVariantA, - ...componentsVariantB, + await pull({}); + + // Verify a file was created for each project and variant present in the (mocked) API response + assertFilesCreated(outputDir, expectedJSONFiles); + }); + + it("should create index.js file when framework: i18next provided", async () => { + fs.mkdirSync(outputDir, { recursive: true }); + setupMocks(createMockData()); + + appContext.setProjectConfig({ + projects: [], + components: {}, + outputs: [ + { + format: "json", + outDir: outputDir, + framework: "i18next", + }, ], }); await pull({}); - // Verify a file was created for each project and variant present in the (mocked) API response - assertFilesCreated(outputDir, [ - "project-1___base.json", - "project-1___variant-a.json", - "project-1___variant-b.json", - "project-2___base.json", - "project-2___variant-a.json", - "components___base.json", - "components___variant-a.json", - "components___variant-b.json", - "variables.json", - ]); + assertFilesCreated(outputDir, [...expectedJSONFiles, "index.js"]); }); - }); - // Helper functions - const setupIosStringsMocks = ({ - textItems = [], - components = [], - variables = [], - }: { - textItems: TextItem[]; - components?: Component[]; - variables?: any[]; - }) => { - /* - "this-is-a-ditto-text-item" = "No its not"; - - "this-is-a-text-layer-on-figma" = "This is a Ditto text item (LinkedNode)"; - - "update-preferences" = "Update preferences"; - */ - mockHttpClient.get.mockImplementation((url: string, config?: any) => { - if (url.includes("/v2/textItems/export")) { - return Promise.resolve({ - data: textItems - .map((textItem) => `"${textItem.id}" = "${textItem.text}"`) - .join("\n\n"), - }); - } - if (url.includes("/v2/variables")) { - return Promise.resolve({ data: variables }); - } - if (url.includes("/v2/components/export")) { - return Promise.resolve({ - data: components - .map((component) => `"${component.id}" = "${component.text}"`) - .join("\n\n"), - }); - } - return Promise.resolve({ data: [] }); + it("should create index.js file when framework: vue-18n provided", async () => { + fs.mkdirSync(outputDir, { recursive: true }); + setupMocks(createMockData()); + + appContext.setProjectConfig({ + projects: [], + components: {}, + outputs: [ + { + format: "json", + outDir: outputDir, + framework: "i18next", + }, + ], + }); + + await pull({}); + + assertFilesCreated(outputDir, [...expectedJSONFiles, "index.js"]); }); - }; + }); + /********************************************************** + * OUTPUT TESTS - ios-strings + **********************************************************/ describe("Output files - ios-strings", () => { - it("should create output files for each project and variant returned from the API", async () => { + it("should create correct output files for each project and variant returned from the API", async () => { fs.mkdirSync(outputDir, { recursive: true }); appContext.setProjectConfig({ @@ -663,109 +706,22 @@ describe("pull command - end-to-end tests", () => { }, ], }); - - // project-1 and project-2 each have at least one base text item - const baseTextItems = [ - createMockTextItem({ - projectId: "project-1", - variantId: null, - id: "text-1", - }), - createMockTextItem({ - projectId: "project-1", - variantId: null, - id: "text-2", - }), - createMockTextItem({ - projectId: "project-2", - variantId: null, - id: "text-3", - }), - ]; - - // project-1 and project-2 each have a variant-a text item - const variantATextItems = [ - createMockTextItem({ - projectId: "project-1", - variantId: "variant-a", - id: "text-4", - }), - createMockTextItem({ - projectId: "project-2", - variantId: "variant-a", - id: "text-5", - }), - ]; - - // Only project-1 has variant-b, so only project-1 should get a variant-b file - const variantBTextItems = [ - createMockTextItem({ - projectId: "project-1", - variantId: "variant-b", - id: "text-6", - }), - createMockTextItem({ - projectId: "project-1", - variantId: "variant-b", - id: "text-7", - }), - ]; - - const componentsBase = [ - createMockComponent({ - id: "comp-1", - variantId: null, - folderId: null, - }), - createMockComponent({ - id: "comp-2", - variantId: null, - folderId: "folder-1", - }), - createMockComponent({ - id: "comp-3", - variantId: null, - folderId: "folder-2", - }), - ]; - - const componentsVariantA = [ - createMockComponent({ - id: "comp-4", - variantId: "variant-a", - folderId: null, - }), - createMockComponent({ - id: "comp-5", - variantId: "variant-a", - folderId: "folder-1", - }), - ]; - - const componentsVariantB = [ - createMockComponent({ - id: "comp-6", - variantId: "variant-b", - folderId: null, - }), - createMockComponent({ - id: "comp-7", - variantId: "variant-b", - folderId: "folder-1", - }), - ]; - - setupIosStringsMocks({ - textItems: [ - ...baseTextItems, - ...variantATextItems, - ...variantBTextItems, - ], - components: [ - ...componentsBase, - ...componentsVariantA, - ...componentsVariantB, - ], + // create exports like so + /* + "this-is-a-ditto-text-item" = "No its not"; + + "this-is-a-text-layer-on-figma" = "This is a Ditto text item (LinkedNode)"; + + "update-preferences" = "Update preferences"; + */ + const { textItems, components } = createMockData(); + setupExportMocks({ + textItems: textItems + .map((textItem) => `"${textItem.id}" = "${textItem.text}"`) + .join("\n\n"), + components: components + .map((component) => `"${component.id}" = "${component.text}"`) + .join("\n\n"), }); await pull({}); @@ -784,4 +740,106 @@ describe("pull command - end-to-end tests", () => { ]); }); }); + + /********************************************************** + * OUTPUT TESTS - ios-strings + **********************************************************/ + describe("Output files - ios-stringsdict", () => { + it("should create correct output files for each project and variant returned from the API", async () => { + fs.mkdirSync(outputDir, { recursive: true }); + + appContext.setProjectConfig({ + components: {}, + outputs: [ + { + format: "ios-stringsdict", + outDir: outputDir, + projects: [{ id: "project-1" }, { id: "project-2" }], + variants: [ + { id: "base" }, + { id: "variant-a" }, + { id: "variant-b" }, + ], + }, + ], + }); + const { textItems, components } = createMockData(); + setupExportMocks({ + // Todo: once we have plurals let's make some real mock data here + textItems: textItems.join("\n"), + components: components.join("\n"), + }); + + await pull({}); + + // Verify a file was created for each project and variant present in the (mocked) API response + assertFilesCreated(outputDir, [ + "project-1___base.stringsdict", + "project-1___variant-a.stringsdict", + "project-1___variant-b.stringsdict", + "project-2___base.stringsdict", + "project-2___variant-a.stringsdict", + "project-2___variant-b.stringsdict", + "components___base.stringsdict", + "components___variant-a.stringsdict", + "components___variant-b.stringsdict", + ]); + }); + }); + + /********************************************************** + * OUTPUT TESTS - ios-strings + **********************************************************/ + describe("Output files - Android XML", () => { + it("should create correct output files for each project and variant returned from the API", async () => { + fs.mkdirSync(outputDir, { recursive: true }); + + appContext.setProjectConfig({ + components: {}, + outputs: [ + { + format: "android", + outDir: outputDir, + projects: [{ id: "project-1" }, { id: "project-2" }], + variants: [ + { id: "base" }, + { id: "variant-a" }, + { id: "variant-b" }, + ], + }, + ], + }); + + const { textItems, components } = createMockData(); + setupExportMocks({ + textItems: textItems + .map( + (ti) => + `${ti.text}` + ) + .join("\n"), + components: components + .map( + (cmp) => + `${cmp.text}` + ) + .join("\n"), + }); + + await pull({}); + + // Verify a file was created for each project and variant present in the (mocked) API response + assertFilesCreated(outputDir, [ + "project-1___base.xml", + "project-1___variant-a.xml", + "project-1___variant-b.xml", + "project-2___base.xml", + "project-2___variant-a.xml", + "project-2___variant-b.xml", + "components___base.xml", + "components___variant-a.xml", + "components___variant-b.xml", + ]); + }); + }); }); diff --git a/lib/src/formatters/android.test.ts b/lib/src/formatters/android.test.ts new file mode 100644 index 0000000..f585205 --- /dev/null +++ b/lib/src/formatters/android.test.ts @@ -0,0 +1,116 @@ +import AndroidOutputFile from "./shared/fileTypes/AndroidOutputFile"; +import { Output } from "../outputs"; +import { ProjectConfigYAML } from "../services/projectConfig"; +import { CommandMetaFlags } from "../http/types"; +import AndroidXMLFormatter from "./android"; + +// @ts-ignore +class TestAndroidXMLFormatter extends AndroidXMLFormatter { + public createOutputFilePublic( + fileName: string, + variantId: string, + content: string + ) { + // @ts-ignore + return super.createOutputFile(fileName, variantId, content); + } + + public getExportFormat() { + // @ts-ignore + return this.exportFormat; + } + + public getOutputFiles() { + // @ts-ignore + return this.outputFiles; + } +} + +describe("AndroidXMLFormatter", () => { + // @ts-ignore + const createMockOutput = (overrides: Partial = {}): Output => ({ + format: "android", + ...overrides, + }); + + const createMockProjectConfig = ( + overrides: Partial = {} + ): ProjectConfigYAML => ({ + projects: [], + variants: [], + components: { + folders: [], + }, + outputs: [ + { + format: "android", + } as any, + ], + ...overrides, + }); + + const createMockMeta = (): CommandMetaFlags => ({}); + + it("has export format of android", () => { + const output = createMockOutput({ outDir: "/test/output" }); + const projectConfig = createMockProjectConfig(); + const formatter = new TestAndroidXMLFormatter( + output, + projectConfig, + createMockMeta() + ); + + expect(formatter.getExportFormat()).toBe("android"); + }); + + it("creates AndroidOutputFile with correct metadata and content", () => { + const output = createMockOutput({ outDir: "/test/output" }); + const projectConfig = createMockProjectConfig(); + const formatter = new TestAndroidXMLFormatter( + output, + projectConfig, + createMockMeta() + ); + + const fileName = "cli-testing-project___spanish"; + const variantId = "spanish"; + const content = "file-content"; + + formatter.createOutputFilePublic(fileName, variantId, content); + + const files = formatter.getOutputFiles(); + const file = files[fileName] as AndroidOutputFile<{ + variantId: string; + }>; + + expect(file).toBeInstanceOf(AndroidOutputFile); + expect(file.fullPath).toBe( + "/test/output/cli-testing-project___spanish.xml" + ); + expect(file.metadata).toEqual({ variantId: "spanish" }); + expect(file.content).toBe("file-content"); + }); + + it("defaults variantId metadata to 'base' when variantId is falsy", () => { + const output = createMockOutput({ outDir: "/test/output" }); + const projectConfig = createMockProjectConfig(); + const formatter = new TestAndroidXMLFormatter( + output, + projectConfig, + createMockMeta() + ); + + const fileName = "cli-testing-project___base"; + const content = "base-content"; + + formatter.createOutputFilePublic(fileName, "" as any, content); + + const files = formatter.getOutputFiles(); + const file = files[fileName] as AndroidOutputFile<{ + variantId: string; + }>; + + expect(file.metadata).toEqual({ variantId: "base" }); + expect(file.content).toBe("base-content"); + }); +}); diff --git a/lib/src/formatters/android.ts b/lib/src/formatters/android.ts new file mode 100644 index 0000000..6cf59d0 --- /dev/null +++ b/lib/src/formatters/android.ts @@ -0,0 +1,28 @@ +import BaseExportFormatter from "./shared/baseExport"; +import AndroidOutputFile from "./shared/fileTypes/AndroidOutputFile"; +import { + ExportComponentsStringResponse, + ExportTextItemsStringResponse, + PullQueryParams, +} from "../http/types"; + +export default class AndroidXMLFormatter extends BaseExportFormatter< + AndroidOutputFile<{ variantId: string }>, + ExportTextItemsStringResponse, + ExportComponentsStringResponse +> { + protected exportFormat: PullQueryParams["format"] = "android"; + + protected createOutputFile( + fileName: string, + variantId: string, + content: string + ): void { + this.outputFiles[fileName] ??= new AndroidOutputFile({ + filename: fileName, + path: this.outDir, + metadata: { variantId: variantId || "base" }, + content: content, + }); + } +} diff --git a/lib/src/formatters/icu.ts b/lib/src/formatters/icu.ts new file mode 100644 index 0000000..7b376a9 --- /dev/null +++ b/lib/src/formatters/icu.ts @@ -0,0 +1,28 @@ +import BaseExportFormatter from "./shared/baseExport"; +import ICUOutputFile from "./shared/fileTypes/ICUOutputFile"; +import { + ExportComponentsJSONResponse, + ExportTextItemsJSONResponse, + PullQueryParams, +} from "../http/types"; + +export default class ICUFormatter extends BaseExportFormatter< + ICUOutputFile<{ variantId: string }>, + ExportTextItemsJSONResponse, + ExportComponentsJSONResponse +> { + protected exportFormat: PullQueryParams["format"] = "icu"; + + protected createOutputFile( + fileName: string, + variantId: string, + content: Record + ): void { + this.outputFiles[fileName] ??= new ICUOutputFile({ + filename: fileName, + path: this.outDir, + metadata: { variantId: variantId || "base" }, + content: content, + }); + } +} diff --git a/lib/src/formatters/index.ts b/lib/src/formatters/index.ts index 8dcaf5a..4bb784c 100644 --- a/lib/src/formatters/index.ts +++ b/lib/src/formatters/index.ts @@ -1,7 +1,10 @@ import { CommandMetaFlags } from "../http/types"; import { Output } from "../outputs"; import { ProjectConfigYAML } from "../services/projectConfig"; +import AndroidXMLFormatter from "./android"; +import ICUFormatter from "./icu"; import IOSStringsFormatter from "./iosStrings"; +import IOSStringsDictFormatter from "./iosStringsDict"; import JSONFormatter from "./json"; export default function formatOutput( @@ -10,10 +13,16 @@ export default function formatOutput( meta: CommandMetaFlags ) { switch (output.format) { + case "android": + return new AndroidXMLFormatter(output, projectConfig, meta).format(); case "json": return new JSONFormatter(output, projectConfig, meta).format(); case "ios-strings": 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(); default: throw new Error(`Unsupported output format: ${output}`); } diff --git a/lib/src/formatters/iosStrings.test.ts b/lib/src/formatters/iosStrings.test.ts index 3942288..9f29ad2 100644 --- a/lib/src/formatters/iosStrings.test.ts +++ b/lib/src/formatters/iosStrings.test.ts @@ -1,57 +1,28 @@ -import IOSStringsFormatter from "./iosStrings"; +import IOSStringsOutputFile from "./shared/fileTypes/IOSStringsOutputFile"; import { Output } from "../outputs"; import { ProjectConfigYAML } from "../services/projectConfig"; import { CommandMetaFlags } from "../http/types"; -import { - ExportTextItemsResponse, - ExportComponentsResponse, -} from "../http/types"; -import fetchText from "../http/textItems"; -import fetchComponents from "../http/components"; -import fetchProjects from "../http/projects"; -import fetchVariants from "../http/variants"; -import IOSStringsOutputFile from "./shared/fileTypes/IOSStringsOutputFile"; - -jest.mock("../http/textItems"); -jest.mock("../http/components"); -jest.mock("../http/projects"); -jest.mock("../http/variants"); - -const mockFetchText = fetchText as jest.MockedFunction; -const mockFetchComponents = fetchComponents as jest.MockedFunction< - typeof fetchComponents ->; -const mockFetchProjects = fetchProjects as jest.MockedFunction< - typeof fetchProjects ->; -const mockFetchVariants = fetchVariants as jest.MockedFunction< - typeof fetchVariants ->; +import IOSStringsFormatter from "./iosStrings"; -// fake test class to expose private methods // @ts-ignore class TestIOSStringsFormatter extends IOSStringsFormatter { - public async fetchAPIData() { - return super.fetchAPIData(); - } - - public transformAPIData( - data: Parameters[0] + public createOutputFilePublic( + fileName: string, + variantId: string, + content: string ) { - return super.transformAPIData(data); + // @ts-ignore + return super.createOutputFile(fileName, variantId, content); } - public async fetchVariants() { - return super["fetchVariants"](); + public getExportFormat() { + // @ts-ignore + return this.exportFormat; } - // Expose private methods for testing - public async fetchTextItemsMap() { - return super["fetchTextItemsMap"](); - } - - public async fetchComponentsMap() { - return super["fetchComponentsMap"](); + public getOutputFiles() { + // @ts-ignore + return this.outputFiles; } } @@ -59,7 +30,6 @@ describe("IOSStringsFormatter", () => { // @ts-ignore const createMockOutput = (overrides: Partial = {}): Output => ({ format: "ios-strings", - outDir: "/test/output", ...overrides, }); @@ -74,374 +44,73 @@ describe("IOSStringsFormatter", () => { outputs: [ { format: "ios-strings", - }, + } as any, ], ...overrides, }); const createMockMeta = (): CommandMetaFlags => ({}); - const createMockIOSStringsContent = (): ExportTextItemsResponse => - ` - "this-is-a-ditto-text-item" = "No its not"; - - "this-is-a-text-layer-on-figma" = "This is a Ditto text item (LinkedNode)"; - - "update-preferences" = "Update preferences"; - `; - - const createMockComponentsContent = (): ExportComponentsResponse => - ` - "continue" = "Continue"; - - "email" = "Email"; - `; - - beforeEach(() => { - jest.clearAllMocks(); - }); - - /*********************************************************** - * fetchTextItemsMap - ***********************************************************/ - - describe("fetchTextItemsMap", () => { - it("should fetch text items for projects and variants configured at root level", async () => { - const projectConfig = createMockProjectConfig({ - projects: [{ id: "project1" }, { id: "project2" }], - variants: [{ id: "variant1" }, { id: "base" }], - }); - const output = createMockOutput(); - const formatter = new TestIOSStringsFormatter( - output, - projectConfig, - createMockMeta() - ); - - const mockContent = createMockIOSStringsContent(); - mockFetchText.mockResolvedValue(mockContent); - - await formatter.fetchVariants(); - const result = await formatter.fetchTextItemsMap(); - - expect(result).toEqual({ - project1: { - variant1: mockContent, - base: mockContent, - }, - project2: { - variant1: mockContent, - base: mockContent, - }, - }); - }); - - it("should fetch all projects from API when not configured", async () => { - const projectConfig = createMockProjectConfig({ - projects: [], - variants: [{ id: "base" }], - }); - const output = createMockOutput(); - const formatter = new TestIOSStringsFormatter( - output, - projectConfig, - createMockMeta() - ); - - const mockProjects = [ - { id: "project-1", name: "Project 1" }, - { id: "project-2", name: "Project 2" }, - { id: "project-3", name: "Project 3" }, - { id: "project-4", name: "Project 4" }, - ]; - const mockContent = createMockIOSStringsContent(); - - mockFetchProjects.mockResolvedValue(mockProjects); - mockFetchText.mockResolvedValue(mockContent); - - await formatter.fetchVariants(); - const result = await formatter.fetchTextItemsMap(); - - expect(mockFetchProjects).toHaveBeenCalled(); - expect(result).toEqual({ - "project-1": { - base: mockContent, - }, - "project-2": { - base: mockContent, - }, - "project-3": { - base: mockContent, - }, - "project-4": { - base: mockContent, - }, - }); - }); - - it("should fetch variants from API when 'all' is specified", async () => { - const projectConfig = createMockProjectConfig({ - projects: [{ id: "project1" }], - variants: [{ id: "all" }], - }); - const output = createMockOutput(); - const formatter = new TestIOSStringsFormatter( - output, - projectConfig, - createMockMeta() - ); - - const mockVariants = [ - { id: "variant1", name: "Variant 1" }, - { id: "variant2", name: "Variant 2" }, - ]; - const mockContent = createMockIOSStringsContent(); - - mockFetchVariants.mockResolvedValue(mockVariants); - mockFetchText.mockResolvedValue(mockContent); + it("has export format of ios-strings", () => { + const output = createMockOutput({ outDir: "/test/output" }); + const projectConfig = createMockProjectConfig(); + const formatter = new TestIOSStringsFormatter( + output, + projectConfig, + createMockMeta() + ); - await formatter.fetchVariants(); - const result = await formatter.fetchTextItemsMap(); - - expect(mockFetchVariants).toHaveBeenCalled(); - expect(result).toEqual({ - project1: { - variant1: mockContent, - variant2: mockContent, - }, - }); - }); - - it("should default to base variant when variants are empty", async () => { - const projectConfig = createMockProjectConfig({ - projects: [{ id: "project1" }], - variants: [], - }); - const output = createMockOutput(); - const formatter = new TestIOSStringsFormatter( - output, - projectConfig, - createMockMeta() - ); - - const mockContent = createMockIOSStringsContent(); - mockFetchText.mockResolvedValue(mockContent); - - await formatter.fetchVariants(); - const result = await formatter.fetchTextItemsMap(); - - expect(result).toEqual({ - project1: { - base: mockContent, - }, - }); - }); + expect(formatter.getExportFormat()).toBe("ios-strings"); }); - /*********************************************************** - * fetchComponentsMap - ***********************************************************/ - describe("fetchComponentsMap", () => { - it("should fetch components for variants configured at root level", async () => { - const projectConfig = createMockProjectConfig({ - variants: [{ id: "variant1" }, { id: "base" }], - components: { - folders: [], - }, - }); - const output = createMockOutput(); - const formatter = new TestIOSStringsFormatter( - output, - projectConfig, - createMockMeta() - ); - - const mockContent = createMockComponentsContent(); - mockFetchComponents.mockResolvedValue(mockContent); - - await formatter.fetchVariants(); - const result = await formatter.fetchComponentsMap(); - - expect(result).toEqual({ - variant1: mockContent, - base: mockContent, - }); - - expect(mockFetchComponents).toHaveBeenCalledTimes(2); - }); - - it("should fetch variants from API when 'all' is specified", async () => { - const projectConfig = createMockProjectConfig({ - variants: [{ id: "all" }], - components: { - folders: [], - }, - }); - const output = createMockOutput(); - const formatter = new TestIOSStringsFormatter( - output, - projectConfig, - createMockMeta() - ); - - const mockVariants = [ - { id: "variant1", name: "Variant 1" }, - { id: "variant2", name: "Variant 2" }, - ]; - const mockContent = createMockComponentsContent(); - - mockFetchVariants.mockResolvedValue(mockVariants); - mockFetchComponents.mockResolvedValue(mockContent); - - await formatter.fetchVariants(); - const result = await formatter.fetchComponentsMap(); - - expect(mockFetchVariants).toHaveBeenCalled(); - expect(result).toEqual({ variant1: mockContent, variant2: mockContent }); - }); - - it("should default to base variant when variants are empty", async () => { - const projectConfig = createMockProjectConfig({ - variants: [], - components: { - folders: [], - }, - }); - const output = createMockOutput(); - const formatter = new TestIOSStringsFormatter( - output, - projectConfig, - createMockMeta() - ); - - const mockContent = createMockComponentsContent(); - mockFetchComponents.mockResolvedValue(mockContent); - - await formatter.fetchVariants(); - const result = await formatter.fetchComponentsMap(); - - expect(result).toEqual({ - base: mockContent, - }); - }); - - it("should return empty object when components not configured", async () => { - const projectConfig = createMockProjectConfig({ - components: undefined, - }); - const output = createMockOutput(); - const formatter = new TestIOSStringsFormatter( - output, - projectConfig, - createMockMeta() - ); - - const result = await formatter.fetchComponentsMap(); - - expect(result).toEqual({}); - expect(mockFetchComponents).not.toHaveBeenCalled(); - }); - }); - - /*********************************************************** - * fetchAPIData - ***********************************************************/ - describe("fetchAPIData", () => { - it("should fetchVariants and combine text items and components data", async () => { - const projectConfig = createMockProjectConfig({ - projects: [{ id: "project1" }], - variants: [{ id: "base" }], - components: { - folders: [], - }, - }); - const output = createMockOutput(); - const formatter = new TestIOSStringsFormatter( - output, - projectConfig, - createMockMeta() - ); - - const mockTextContent = createMockIOSStringsContent(); - const mockComponentsContent = createMockComponentsContent(); - - mockFetchText.mockResolvedValue(mockTextContent); - mockFetchComponents.mockResolvedValue(mockComponentsContent); - - const fetchVariantsSpy = jest.spyOn(formatter, "fetchVariants"); - const result = await formatter.fetchAPIData(); - - expect(fetchVariantsSpy).toHaveBeenCalled(); - expect(result).toEqual({ - textItemsMap: { - project1: { - base: mockTextContent, - }, - }, - componentsMap: { - base: mockComponentsContent, - }, - }); - }); + it("creates IOSStringsOutputFile with correct metadata and content", () => { + const output = createMockOutput({ outDir: "/test/output" }); + const projectConfig = createMockProjectConfig(); + const formatter = new TestIOSStringsFormatter( + output, + projectConfig, + createMockMeta() + ); + + const fileName = "cli-testing-project___spanish"; + const variantId = "spanish"; + const content = "file-content"; + + formatter.createOutputFilePublic(fileName, variantId, content); + + const files = formatter.getOutputFiles(); + const file = files[fileName] as IOSStringsOutputFile<{ + variantId: string; + }>; + + expect(file).toBeInstanceOf(IOSStringsOutputFile); + expect(file.fullPath).toBe( + "/test/output/cli-testing-project___spanish.strings" + ); + expect(file.metadata).toEqual({ variantId: "spanish" }); + expect(file.content).toBe("file-content"); }); - /*********************************************************** - * transformAPIData - ***********************************************************/ - describe("transformAPIData", () => { - it("should transform text items into IOSStringsOutputFile output files", () => { - const projectConfig = createMockProjectConfig(); - const output = createMockOutput({ outDir: "/test/output" }); - const formatter = new TestIOSStringsFormatter( - output, - projectConfig, - createMockMeta() - ); - - const mockTextContent = createMockIOSStringsContent(); - const data = { - textItemsMap: { - project1: { - base: mockTextContent, - variant1: mockTextContent, - }, - }, - componentsMap: {}, - }; - - const result = formatter.transformAPIData(data); - expect(result).toHaveLength(2); - expect(result[0]).toBeInstanceOf(IOSStringsOutputFile); - expect(result[0].filename).toBe("project1___base"); - expect(result[1]).toBeInstanceOf(IOSStringsOutputFile); - expect(result[1].filename).toBe("project1___variant1"); - }); + it("defaults variantId metadata to 'base' when variantId is falsy", () => { + const output = createMockOutput({ outDir: "/test/output" }); + const projectConfig = createMockProjectConfig(); + const formatter = new TestIOSStringsFormatter( + output, + projectConfig, + createMockMeta() + ); - it("should transform components into IOSStringsOutputFile output files", () => { - const projectConfig = createMockProjectConfig(); - const output = createMockOutput({ outDir: "/test/output" }); - const formatter = new TestIOSStringsFormatter( - output, - projectConfig, - createMockMeta() - ); + const fileName = "cli-testing-project___base"; + const content = "base-content"; - const mockComponentsContent = createMockComponentsContent(); - const data = { - textItemsMap: {}, - componentsMap: { - base: mockComponentsContent, - variant1: mockComponentsContent, - }, - }; + formatter.createOutputFilePublic(fileName, "" as any, content); - const result = formatter.transformAPIData(data); + const files = formatter.getOutputFiles(); + const file = files[fileName] as IOSStringsOutputFile<{ + variantId: string; + }>; - expect(result).toHaveLength(2); - expect(result[0]).toBeInstanceOf(IOSStringsOutputFile); - expect(result[0].filename).toBe("components___base"); - expect(result[1]).toBeInstanceOf(IOSStringsOutputFile); - expect(result[1].filename).toBe("components___variant1"); - }); + expect(file.metadata).toEqual({ variantId: "base" }); + expect(file.content).toBe("base-content"); }); }); diff --git a/lib/src/formatters/iosStrings.ts b/lib/src/formatters/iosStrings.ts index a209aa3..8449472 100644 --- a/lib/src/formatters/iosStrings.ts +++ b/lib/src/formatters/iosStrings.ts @@ -1,142 +1,27 @@ -import fetchText from "../http/textItems"; -import { ExportComponentsResponse, ExportTextItemsResponse, PullQueryParams, Variant } from "../http/types"; -import fetchComponents from "../http/components"; -import BaseFormatter from "./shared/base"; -import { applyMixins } from "./shared"; -import fetchProjects from "../http/projects"; +import BaseExportFormatter from "./shared/baseExport"; import IOSStringsOutputFile from "./shared/fileTypes/IOSStringsOutputFile"; -import fetchVariants from "../http/variants"; - -interface ComponentsMap { - [variantId: string]: ExportComponentsResponse -} -interface TextItemsMap { - [projectId: string]: { - [variantId: string]: ExportTextItemsResponse - } -} - -type IOSStringsAPIData = { - textItemsMap: TextItemsMap; - componentsMap: ComponentsMap; -}; - -export default class IOSStringsFormatter extends applyMixins( - BaseFormatter, IOSStringsAPIData>) { - private variants: { id: string }[] = []; - - protected async fetchAPIData() { - await this.fetchVariants(); - const textItemsMap = await this.fetchTextItemsMap(); - const componentsMap = await this.fetchComponentsMap(); - - return { textItemsMap, componentsMap }; - } - - /** - * For each project/variant permutation and its fetched .strings data, - * create a new file with the expected naming - * - * @returns {OutputFile[]} List of Output Files - */ - protected transformAPIData(data: IOSStringsAPIData) { - Object.entries(data.textItemsMap).forEach(([projectId, projectVariants]) => { - Object.entries(projectVariants).forEach(([variantId, iosStringsFile]) => { - const fileName = `${projectId}___${variantId || "base"}`; - this.outputFiles[fileName] ??= new IOSStringsOutputFile({ - filename: fileName, - path: this.outDir, - metadata: { variantId: variantId || "base" }, - content: iosStringsFile - }); - }); +import { + ExportComponentsStringResponse, + ExportTextItemsStringResponse, + PullQueryParams, +} from "../http/types"; +export default class IOSStringsFormatter extends BaseExportFormatter< + IOSStringsOutputFile<{ variantId: string }>, + ExportTextItemsStringResponse, + ExportComponentsStringResponse +> { + protected exportFormat: PullQueryParams["format"] = "ios-strings"; + + protected createOutputFile( + fileName: string, + variantId: string, + content: string + ): void { + this.outputFiles[fileName] ??= new IOSStringsOutputFile({ + filename: fileName, + path: this.outDir, + metadata: { variantId: variantId || "base" }, + content: content, }); - - Object.entries(data.componentsMap).forEach(([variantId, iosStringsFile]) => { - const fileName = `components___${variantId || "base"}`; - this.outputFiles[fileName] ??= new IOSStringsOutputFile({ - filename: fileName, - path: this.outDir, - metadata: { variantId: variantId || "base" }, - content: iosStringsFile - }); - }) - - return Object.values(this.outputFiles); - } - - /** - * Sets variants based on configuration - * - Fetches from API if "all" configured - * - Adds "base" variant by default if none configured - */ - private async fetchVariants(): Promise { - let variants: { id: string }[] = this.output.variants ?? this.projectConfig.variants ?? []; - if (variants.some((variant) => variant.id === 'all')) { - variants = await fetchVariants(this.meta); - } else if (variants.length === 0) { - variants = [{ id: 'base' }] - } - - this.variants = variants; - } - - /** - * Fetches text item data via API for each configured project and variant - * in this output - * - * @returns text items mapped to their respective variant and project - */ - private async fetchTextItemsMap(): Promise { - if (!this.projectConfig.projects && !this.output.projects) return {}; - let projects: { id: string }[] = this.output.projects ?? this.projectConfig.projects ?? []; - - const result: TextItemsMap = {}; - - if (projects.length === 0) { - projects = await fetchProjects(this.meta); - } - - for (const project of projects) { - result[project.id] = {}; - - for (const variant of this.variants) { - // map "base" to undefined, as by default export endpoint returns base variant - const variantsParam = variant.id === 'base' ? undefined : [{ id: variant.id }] - const params: PullQueryParams = { - ...super.generateQueryParams("textItem", { projects: [{ id: project.id }], variants: variantsParam }), - format: 'ios-strings' - }; - const iosStringsFile = await fetchText(params, this.meta); - result[project.id][variant.id] = iosStringsFile; - } - } - - return result; - } - - /** - * Fetches component data via API. - * If individual variants configured, fetch by each otherwise fetch for all - * Skips the fetch request if components field is not specified in config. - * - * @returns components data - */ - private async fetchComponentsMap(): Promise { - if (!this.projectConfig.components && !this.output.components) return {}; - const result: ComponentsMap = {}; - - for (const variant of this.variants) { - // map "base" to undefined, as by default export endpoint returns base variant - const variantsParam = variant.id === 'base' ? undefined : [{ id: variant.id }] - const params: PullQueryParams = { - ...super.generateQueryParams("component", { variants: variantsParam }), - format: 'ios-strings' - }; - const iosStringsFile = await fetchComponents(params, this.meta); - result[variant.id] = iosStringsFile; - } - - return result; } } diff --git a/lib/src/formatters/iosStringsDict.test.ts b/lib/src/formatters/iosStringsDict.test.ts new file mode 100644 index 0000000..629fe13 --- /dev/null +++ b/lib/src/formatters/iosStringsDict.test.ts @@ -0,0 +1,117 @@ +import IOSStringsDictFormatter from "./iosStringsDict"; +import IOSStringsDictOutputFile from "./shared/fileTypes/IOSStringsDictOutputFile"; +import { Output } from "../outputs"; +import { ProjectConfigYAML } from "../services/projectConfig"; +import { CommandMetaFlags } from "../http/types"; + +// @ts-ignore +class TestIOSStringsDictFormatter extends IOSStringsDictFormatter { + public createOutputFilePublic( + fileName: string, + variantId: string, + content: string + ) { + // @ts-ignore + return super.createOutputFile(fileName, variantId, content); + } + + public getExportFormat() { + // @ts-ignore + return this.exportFormat; + } + + public getOutputFiles() { + // @ts-ignore + return this.outputFiles; + } +} + +describe("IOSStringsDictFormatter", () => { + // @ts-ignore + const createMockOutput = (overrides: Partial = {}): Output => ({ + format: "ios-stringsdict", + ...overrides, + }); + + const createMockProjectConfig = ( + overrides: Partial = {} + ): ProjectConfigYAML => ({ + projects: [], + variants: [], + components: { + folders: [], + }, + outputs: [ + { + // Minimal valid output config for this formatter + format: "ios-stringsdict", + } as any, + ], + ...overrides, + }); + + const createMockMeta = (): CommandMetaFlags => ({}); + + it("has export format of ios-stringsdict", () => { + const output = createMockOutput({ outDir: "/test/output" }); + const projectConfig = createMockProjectConfig(); + const formatter = new TestIOSStringsDictFormatter( + output, + projectConfig, + createMockMeta() + ); + + expect(formatter.getExportFormat()).toBe("ios-stringsdict"); + }); + + it("creates IOSStringsDictOutputFile with correct metadata and content", () => { + const output = createMockOutput({ outDir: "/test/output" }); + const projectConfig = createMockProjectConfig(); + const formatter = new TestIOSStringsDictFormatter( + output, + projectConfig, + createMockMeta() + ); + + const fileName = "cli-testing-project___spanish"; + const variantId = "spanish"; + const content = "file-content"; + + formatter.createOutputFilePublic(fileName, variantId, content); + + const files = formatter.getOutputFiles(); + const file = files[fileName] as IOSStringsDictOutputFile<{ + variantId: string; + }>; + + expect(file).toBeInstanceOf(IOSStringsDictOutputFile); + expect(file.fullPath).toBe( + "/test/output/cli-testing-project___spanish.stringsdict" + ); + expect(file.metadata).toEqual({ variantId: "spanish" }); + expect(file.content).toBe("file-content"); + }); + + it("defaults variantId metadata to 'base' when variantId is falsy", () => { + const output = createMockOutput({ outDir: "/test/output" }); + const projectConfig = createMockProjectConfig(); + const formatter = new TestIOSStringsDictFormatter( + output, + projectConfig, + createMockMeta() + ); + + const fileName = "cli-testing-project___base"; + const content = "base-content"; + + formatter.createOutputFilePublic(fileName, "" as any, content); + + const files = formatter.getOutputFiles(); + const file = files[fileName] as IOSStringsDictOutputFile<{ + variantId: string; + }>; + + expect(file.metadata).toEqual({ variantId: "base" }); + expect(file.content).toBe("base-content"); + }); +}); diff --git a/lib/src/formatters/iosStringsDict.ts b/lib/src/formatters/iosStringsDict.ts new file mode 100644 index 0000000..82c7ed4 --- /dev/null +++ b/lib/src/formatters/iosStringsDict.ts @@ -0,0 +1,27 @@ +import BaseExportFormatter from "./shared/baseExport"; +import IOSStringsDictOutputFile from "./shared/fileTypes/IOSStringsDictOutputFile"; +import { + ExportComponentsStringResponse, + ExportTextItemsStringResponse, + PullQueryParams, +} from "../http/types"; +export default class IOSStringsDictFormatter extends BaseExportFormatter< + IOSStringsDictOutputFile<{ variantId: string }>, + ExportTextItemsStringResponse, + ExportComponentsStringResponse +> { + protected exportFormat: PullQueryParams["format"] = "ios-stringsdict"; + + protected createOutputFile( + fileName: string, + variantId: string, + content: string + ): void { + this.outputFiles[fileName] ??= new IOSStringsDictOutputFile({ + filename: fileName, + path: this.outDir, + metadata: { variantId: variantId || "base" }, + content: content, + }); + } +} diff --git a/lib/src/formatters/json.ts b/lib/src/formatters/json.ts index 7ac69b5..b2aea45 100644 --- a/lib/src/formatters/json.ts +++ b/lib/src/formatters/json.ts @@ -91,8 +91,8 @@ export default class JSONFormatter extends applyMixins( */ private async fetchTextItems() { if (!this.projectConfig.projects && !this.output.projects) return []; - - return await fetchText(super.generateQueryParams("textItem"), this.meta); + const filters = super.generateTextItemPullFilter(); + return await fetchText(super.generateQueryParams(filters), this.meta); } /** @@ -103,8 +103,8 @@ export default class JSONFormatter extends applyMixins( */ private async fetchComponents() { if (!this.projectConfig.components && !this.output.components) return []; - - return await fetchComponents(super.generateQueryParams("component"), this.meta); + const filters = super.generateComponentPullFilter(); + return await fetchComponents(super.generateQueryParams(filters), this.meta); } private async fetchVariables() { diff --git a/lib/src/formatters/shared/base.test.ts b/lib/src/formatters/shared/base.test.ts index 83ea850..e332dfb 100644 --- a/lib/src/formatters/shared/base.test.ts +++ b/lib/src/formatters/shared/base.test.ts @@ -15,11 +15,8 @@ class TestBaseFormatter extends BaseFormatter { return super["generateComponentPullFilter"](); } - public generateQueryParams( - requestType: "textItem" | "component", - filter: PullFilters = {} - ) { - return super.generateQueryParams(requestType, filter); + public generateQueryParams(filters: PullFilters = {}) { + return super.generateQueryParams(filters); } } @@ -292,7 +289,7 @@ describe("BaseFormatter", () => { ***********************************************************/ describe("generateQueryParams", () => { - it("should generate query params for RequestType: textItem", () => { + it("should generate query params for provided text item filters", () => { const projectConfig = createMockProjectConfig({ projects: [{ id: "project1" }], variants: [{ id: "variant1" }], @@ -304,9 +301,12 @@ describe("BaseFormatter", () => { createMockMeta() ); - const params = formatter.generateQueryParams("textItem"); + const params = formatter.generateQueryParams( + formatter.generateTextItemPullFilter() + ); expect(params.filter).toBeDefined(); + expect(params.filter).toEqual(expect.any(String)); const parsedFilter = JSON.parse(params.filter); expect(parsedFilter).toEqual({ projects: [{ id: "project1" }], @@ -315,7 +315,7 @@ describe("BaseFormatter", () => { expect(params.richText).toBeUndefined(); }); - it("should generate query params for RequestType: component", () => { + it("should generate query params with provided component filters", () => { const projectConfig = createMockProjectConfig({ components: { folders: [{ id: "folder1" }], @@ -329,43 +329,17 @@ describe("BaseFormatter", () => { createMockMeta() ); - const params = formatter.generateQueryParams("component"); - - expect(params.filter).toBeDefined(); - const parsedFilter = JSON.parse(params.filter); - expect(parsedFilter).toEqual({ - folders: [{ id: "folder1" }], - variants: [{ id: "variant1" }], - }); - expect(params.richText).toBeUndefined(); - }); - - it("should merge additional filter with base filter", () => { - const projectConfig = createMockProjectConfig({ - projects: [{ id: "project1" }], - variants: [{ id: "variant1" }], - }); - const output = createMockOutput(); - const formatter = new TestBaseFormatter( - output, - projectConfig, - createMockMeta() - ); - - const additionalFilter: PullFilters = { - projects: [{ id: "project2" }], - }; const params = formatter.generateQueryParams( - "textItem", - additionalFilter + formatter.generateComponentPullFilter() ); expect(params.filter).toBeDefined(); const parsedFilter = JSON.parse(params.filter); expect(parsedFilter).toEqual({ - projects: [{ id: "project2" }], // Additional filter overrides base + folders: [{ id: "folder1" }], variants: [{ id: "variant1" }], }); + expect(params.richText).toBeUndefined(); }); it("should include richText from projectConfig when set", () => { @@ -380,7 +354,9 @@ describe("BaseFormatter", () => { createMockMeta() ); - const params = formatter.generateQueryParams("textItem"); + const params = formatter.generateQueryParams( + formatter.generateTextItemPullFilter() + ); expect(params.richText).toBe("html"); }); @@ -399,7 +375,7 @@ describe("BaseFormatter", () => { createMockMeta() ); - const params = formatter.generateQueryParams("textItem"); + const params = formatter.generateQueryParams(); expect(params.richText).toBe("html"); }); @@ -417,31 +393,9 @@ describe("BaseFormatter", () => { createMockMeta() ); - const params = formatter.generateQueryParams("textItem"); + const params = formatter.generateQueryParams(); expect(params.richText).toBe("html"); }); - - it("should handle empty filter object", () => { - const projectConfig = createMockProjectConfig({ - projects: [{ id: "project1" }], - variants: [{ id: "variant1" }], - }); - const output = createMockOutput(); - const formatter = new TestBaseFormatter( - output, - projectConfig, - createMockMeta() - ); - - const params = formatter.generateQueryParams("textItem", undefined); - - expect(params.filter).toBeDefined(); - const parsedFilter = JSON.parse(params.filter); - expect(parsedFilter).toEqual({ - projects: [{ id: "project1" }], - variants: [{ id: "variant1" }], - }); - }); }); }); diff --git a/lib/src/formatters/shared/base.ts b/lib/src/formatters/shared/base.ts index 824f3b4..e1b0684 100644 --- a/lib/src/formatters/shared/base.ts +++ b/lib/src/formatters/shared/base.ts @@ -11,7 +11,6 @@ import { PullQueryParams, } from "../../http/types"; -type RequestType = "textItem" | "component"; export default class BaseFormatter { protected output: Output; protected projectConfig: ProjectConfigYAML; @@ -36,7 +35,7 @@ export default class BaseFormatter { this.meta = meta; } - private generateTextItemPullFilter() { + protected generateTextItemPullFilter() { let filters: PullFilters = { projects: this.projectConfig.projects, variants: this.projectConfig.variants, @@ -53,7 +52,7 @@ export default class BaseFormatter { return filters; } - private generateComponentPullFilter() { + protected generateComponentPullFilter() { let filters: PullFilters = { ...(this.projectConfig.components?.folders && { folders: this.projectConfig.components.folders, @@ -75,17 +74,9 @@ export default class BaseFormatter { /** * Returns the query parameters for the fetchText API request */ - protected generateQueryParams( - requestType: RequestType, - filter: PullFilters = {} - ): PullQueryParams { - const baseFilter = - requestType === "textItem" - ? this.generateTextItemPullFilter() - : this.generateComponentPullFilter(); - + protected generateQueryParams(filters: PullFilters = {}): PullQueryParams { let params: PullQueryParams = { - filter: JSON.stringify({ ...baseFilter, ...filter }), + filter: JSON.stringify(filters), }; if (this.projectConfig.richText) { diff --git a/lib/src/formatters/shared/baseExport.test.ts b/lib/src/formatters/shared/baseExport.test.ts new file mode 100644 index 0000000..81cf6fa --- /dev/null +++ b/lib/src/formatters/shared/baseExport.test.ts @@ -0,0 +1,441 @@ +import { Output } from "../../outputs"; +import { ProjectConfigYAML } from "../../services/projectConfig"; +import { CommandMetaFlags } from "../../http/types"; +import { + ExportTextItemsResponse, + ExportComponentsStringResponse, +} from "../../http/types"; +import fetchText from "../../http/textItems"; +import fetchComponents from "../../http/components"; +import fetchProjects from "../../http/projects"; +import fetchVariants from "../../http/variants"; +import BaseExportFormatter from "./baseExport"; + +jest.mock("../../http/textItems"); +jest.mock("../../http/components"); +jest.mock("../../http/projects"); +jest.mock("../../http/variants"); + +const mockFetchText = fetchText as jest.MockedFunction; +const mockFetchComponents = fetchComponents as jest.MockedFunction< + typeof fetchComponents +>; +const mockFetchProjects = fetchProjects as jest.MockedFunction< + typeof fetchProjects +>; +const mockFetchVariants = fetchVariants as jest.MockedFunction< + typeof fetchVariants +>; + +// fake test class to expose private methods +// @ts-ignore +class TestBaseExportFormatter extends BaseExportFormatter { + public createOutputFile( + fileName: string, + variantId: string, + content: string + ) {} + public async fetchAPIData() { + return super.fetchAPIData(); + } + + public transformAPIData( + data: Parameters["transformAPIData"]>[0] + ) { + return super.transformAPIData(data); + } + + public async fetchVariants() { + return super["fetchVariants"](); + } + + // Expose private methods for testing + public async fetchTextItemsMap() { + return super["fetchTextItemsMap"](); + } + + public async fetchComponentsMap() { + return super["fetchComponentsMap"](); + } +} + +describe("BaseExportFormatter", () => { + // @ts-ignore + const createMockOutput = (overrides: Partial = {}): Output => ({ + format: "ios-strings", + outDir: "/test/output", + ...overrides, + }); + + const createMockProjectConfig = ( + overrides: Partial = {} + ): ProjectConfigYAML => ({ + projects: [], + variants: [], + components: { + folders: [], + }, + outputs: [ + { + format: "ios-strings", + }, + ], + ...overrides, + }); + + const createMockMeta = (): CommandMetaFlags => ({}); + + const createMockIOSStringsContent = (): ExportTextItemsResponse => + ` + "this-is-a-ditto-text-item" = "No its not"; + + "this-is-a-text-layer-on-figma" = "This is a Ditto text item (LinkedNode)"; + + "update-preferences" = "Update preferences"; + `; + + const createMockComponentsContent = (): ExportComponentsStringResponse => + ` + "continue" = "Continue"; + + "email" = "Email"; + `; + + beforeEach(() => { + jest.clearAllMocks(); + }); + + /*********************************************************** + * fetchTextItemsMap + ***********************************************************/ + + describe("fetchTextItemsMap", () => { + it("should fetch text items for projects and variants configured at root level", async () => { + const projectConfig = createMockProjectConfig({ + projects: [{ id: "project1" }, { id: "project2" }], + variants: [{ id: "variant1" }, { id: "base" }], + }); + const output = createMockOutput(); + // @ts-ignore + const formatter = new TestBaseExportFormatter( + output, + projectConfig, + createMockMeta() + ); + + const mockContent = createMockIOSStringsContent(); + mockFetchText.mockResolvedValue(mockContent); + + await formatter.fetchVariants(); + const result = await formatter.fetchTextItemsMap(); + + expect(result).toEqual({ + project1: { + variant1: mockContent, + base: mockContent, + }, + project2: { + variant1: mockContent, + base: mockContent, + }, + }); + }); + + it("should fetch all projects from API when not configured", async () => { + const projectConfig = createMockProjectConfig({ + projects: [], + variants: [{ id: "base" }], + }); + const output = createMockOutput(); + // @ts-ignore + const formatter = new TestBaseExportFormatter( + output, + projectConfig, + createMockMeta() + ); + + const mockProjects = [ + { id: "project-1", name: "Project 1" }, + { id: "project-2", name: "Project 2" }, + { id: "project-3", name: "Project 3" }, + { id: "project-4", name: "Project 4" }, + ]; + const mockContent = createMockIOSStringsContent(); + + mockFetchProjects.mockResolvedValue(mockProjects); + mockFetchText.mockResolvedValue(mockContent); + + await formatter.fetchVariants(); + const result = await formatter.fetchTextItemsMap(); + + expect(mockFetchProjects).toHaveBeenCalled(); + expect(result).toEqual({ + "project-1": { + base: mockContent, + }, + "project-2": { + base: mockContent, + }, + "project-3": { + base: mockContent, + }, + "project-4": { + base: mockContent, + }, + }); + }); + + it("should fetch variants from API when 'all' is specified", async () => { + const projectConfig = createMockProjectConfig({ + projects: [{ id: "project1" }], + variants: [{ id: "all" }], + }); + const output = createMockOutput(); + // @ts-ignore + const formatter = new TestBaseExportFormatter( + output, + projectConfig, + createMockMeta() + ); + + const mockVariants = [ + { id: "variant1", name: "Variant 1" }, + { id: "variant2", name: "Variant 2" }, + ]; + const mockContent = createMockIOSStringsContent(); + + mockFetchVariants.mockResolvedValue(mockVariants); + mockFetchText.mockResolvedValue(mockContent); + + await formatter.fetchVariants(); + const result = await formatter.fetchTextItemsMap(); + + expect(mockFetchVariants).toHaveBeenCalled(); + expect(result).toEqual({ + project1: { + variant1: mockContent, + variant2: mockContent, + }, + }); + }); + + it("should default to base variant when variants are empty", async () => { + const projectConfig = createMockProjectConfig({ + projects: [{ id: "project1" }], + variants: [], + }); + const output = createMockOutput(); + // @ts-ignore + const formatter = new TestBaseExportFormatter( + output, + projectConfig, + createMockMeta() + ); + + const mockContent = createMockIOSStringsContent(); + mockFetchText.mockResolvedValue(mockContent); + + await formatter.fetchVariants(); + const result = await formatter.fetchTextItemsMap(); + + expect(result).toEqual({ + project1: { + base: mockContent, + }, + }); + }); + }); + + /*********************************************************** + * fetchComponentsMap + ***********************************************************/ + describe("fetchComponentsMap", () => { + it("should fetch components for variants configured at root level", async () => { + const projectConfig = createMockProjectConfig({ + variants: [{ id: "variant1" }, { id: "base" }], + components: { + folders: [], + }, + }); + const output = createMockOutput(); + // @ts-ignore + const formatter = new TestBaseExportFormatter( + output, + projectConfig, + createMockMeta() + ); + + const mockContent = createMockComponentsContent(); + mockFetchComponents.mockResolvedValue(mockContent); + + await formatter.fetchVariants(); + const result = await formatter.fetchComponentsMap(); + + expect(result).toEqual({ + variant1: mockContent, + base: mockContent, + }); + + expect(mockFetchComponents).toHaveBeenCalledTimes(2); + }); + + it("should fetch variants from API when 'all' is specified", async () => { + const projectConfig = createMockProjectConfig({ + variants: [{ id: "all" }], + components: { + folders: [], + }, + }); + const output = createMockOutput(); + // @ts-ignore + const formatter = new TestBaseExportFormatter( + output, + projectConfig, + createMockMeta() + ); + + const mockVariants = [ + { id: "variant1", name: "Variant 1" }, + { id: "variant2", name: "Variant 2" }, + ]; + const mockContent = createMockComponentsContent(); + + mockFetchVariants.mockResolvedValue(mockVariants); + mockFetchComponents.mockResolvedValue(mockContent); + + await formatter.fetchVariants(); + const result = await formatter.fetchComponentsMap(); + + expect(mockFetchVariants).toHaveBeenCalled(); + expect(result).toEqual({ variant1: mockContent, variant2: mockContent }); + }); + + it("should default to base variant when variants are empty", async () => { + const projectConfig = createMockProjectConfig({ + variants: [], + components: { + folders: [], + }, + }); + const output = createMockOutput(); + // @ts-ignore + const formatter = new TestBaseExportFormatter( + output, + projectConfig, + createMockMeta() + ); + + const mockContent = createMockComponentsContent(); + mockFetchComponents.mockResolvedValue(mockContent); + + await formatter.fetchVariants(); + const result = await formatter.fetchComponentsMap(); + + expect(result).toEqual({ + base: mockContent, + }); + }); + + it("should return empty object when components not configured", async () => { + const projectConfig = createMockProjectConfig({ + components: undefined, + }); + const output = createMockOutput(); + // @ts-ignore + const formatter = new TestBaseExportFormatter( + output, + projectConfig, + createMockMeta() + ); + + const result = await formatter.fetchComponentsMap(); + + expect(result).toEqual({}); + expect(mockFetchComponents).not.toHaveBeenCalled(); + }); + }); + + /*********************************************************** + * fetchAPIData + ***********************************************************/ + describe("fetchAPIData", () => { + it("should fetchVariants and combine text items and components data", async () => { + const projectConfig = createMockProjectConfig({ + projects: [{ id: "project1" }], + variants: [{ id: "base" }], + components: { + folders: [], + }, + }); + const output = createMockOutput(); + // @ts-ignore + const formatter = new TestBaseExportFormatter( + output, + projectConfig, + createMockMeta() + ); + + const mockTextContent = createMockIOSStringsContent(); + const mockComponentsContent = createMockComponentsContent(); + + mockFetchText.mockResolvedValue(mockTextContent); + mockFetchComponents.mockResolvedValue(mockComponentsContent); + + const fetchVariantsSpy = jest.spyOn(formatter, "fetchVariants"); + const result = await formatter.fetchAPIData(); + + expect(fetchVariantsSpy).toHaveBeenCalled(); + expect(result).toEqual({ + textItemsMap: { + project1: { + base: mockTextContent, + }, + }, + componentsMap: { + base: mockComponentsContent, + }, + }); + }); + }); + + /*********************************************************** + * transformAPIData + ***********************************************************/ + describe("transformAPIData", () => { + it("should invoke BaseExportFormatter.createOutputFiles for each text item", () => { + const projectConfig = createMockProjectConfig(); + const output = createMockOutput({ outDir: "/test/output" }); + // @ts-ignore + const formatter = new TestBaseExportFormatter( + output, + projectConfig, + createMockMeta() + ); + + const createOutputSpy = jest.spyOn(formatter, "createOutputFile"); + const mockTextContent = createMockIOSStringsContent(); + const data = { + textItemsMap: { + project1: { + base: mockTextContent, + variant1: mockTextContent, + }, + }, + componentsMap: {}, + }; + + formatter.transformAPIData(data); + expect(createOutputSpy).toHaveBeenCalledTimes(2); + expect(createOutputSpy).toHaveBeenCalledWith( + `project1___base`, + "base", + mockTextContent + ); + expect(createOutputSpy).toHaveBeenCalledWith( + `project1___variant1`, + "variant1", + mockTextContent + ); + }); + }); +}); diff --git a/lib/src/formatters/shared/baseExport.ts b/lib/src/formatters/shared/baseExport.ts new file mode 100644 index 0000000..528b01c --- /dev/null +++ b/lib/src/formatters/shared/baseExport.ts @@ -0,0 +1,193 @@ +import fetchText from "../../http/textItems"; +import { + PullQueryParams, + ExportTextItemsResponse, + ExportComponentsResponse, +} from "../../http/types"; +import fetchComponents from "../../http/components"; +import BaseFormatter from "./base"; +import fetchProjects from "../../http/projects"; +import fetchVariants from "../../http/variants"; +import OutputFile from "./fileTypes/OutputFile"; + +interface ComponentsMap { + [variantId: string]: ExportComponentsResponse; +} +interface TextItemsMap { + [projectId: string]: { + [variantId: string]: ExportTextItemsResponse; + }; +} + +type ExportFormatAPIData = { + textItemsMap: TextItemsMap; + componentsMap: ComponentsMap; +}; + +type ExportOutputFile = OutputFile< + string | Record, + MetadataType +>; + +/** + * Base Class for File Formats That Leverage API /v2/components/export and /v2/textItems/export endpoints + * These file formats fetch their file data directly from the API and write to files, as unlike in the case of + * default /v2/textItems + /v2/components JSON, we cannot or do not want to perform any manipulation on the data itself + */ +export default abstract class BaseExportFormatter< + TOutputFile extends ExportOutputFile<{ variantId: string }>, + // The response types below correspond to the file data returned from the export endpoint and what will ultimately be written directly to the /ditto directory + // ios-strings, ios-stringsdict, and android formats are all strings while icu is { [developerId: string]: string } JSON Structure + TTextItemsResponse extends ExportTextItemsResponse, + TComponentsResponse extends ExportComponentsResponse +> extends BaseFormatter { + protected abstract exportFormat: PullQueryParams["format"]; + private variants: { id: string }[] = []; + + protected abstract createOutputFile( + fileName: string, + variantId: string, + content: string | Record + ): void; + + protected async fetchAPIData() { + await this.fetchVariants(); + const [textItemsMap, componentsMap] = await Promise.all([ + this.fetchTextItemsMap(), + this.fetchComponentsMap(), + ]); + + return { textItemsMap, componentsMap }; + } + + /** + * For each project/variant permutation and its fetched .strings data, + * create a new file with the expected naming + * + * @returns {OutputFile[]} List of Output Files + */ + protected transformAPIData(data: ExportFormatAPIData): TOutputFile[] { + Object.entries(data.textItemsMap).forEach( + ([projectId, projectVariants]) => { + Object.entries(projectVariants).forEach( + ([variantId, textItemsFileContent]) => { + const fileName = `${projectId}___${variantId || "base"}`; + this.createOutputFile(fileName, variantId, textItemsFileContent); + } + ); + } + ); + + Object.entries(data.componentsMap).forEach( + ([variantId, componentsFileContent]) => { + const fileName = `components___${variantId || "base"}`; + this.createOutputFile(fileName, variantId, componentsFileContent); + } + ); + + return Object.values(this.outputFiles); + } + + /** + * Sets variants based on configuration + * - Fetches from API if "all" configured + * - Adds "base" variant by default if none configured + */ + private async fetchVariants(): Promise { + let variants: { id: string }[] = + this.output.variants ?? this.projectConfig.variants ?? []; + if (variants.some((variant) => variant.id === "all")) { + variants = await fetchVariants(this.meta); + } else if (variants.length === 0) { + variants = [{ id: "base" }]; + } + + this.variants = variants; + } + + /** + * Fetches text item data via API for each configured project and variant + * in this output + * + * @returns text items mapped to their respective variant and project + */ + private async fetchTextItemsMap(): Promise { + if (!this.projectConfig.projects && !this.output.projects) return {}; + let projects: { id: string }[] = + this.output.projects ?? this.projectConfig.projects ?? []; + + const result: TextItemsMap = {}; + + if (projects.length === 0) { + projects = await fetchProjects(this.meta); + } + + const fetchFileContentRequests = []; + + for (const project of projects) { + result[project.id] = {}; + + for (const variant of this.variants) { + // map "base" to undefined, as by default export endpoint returns base variant + const variantsParam = + variant.id === "base" ? undefined : [{ id: variant.id }]; + const params: PullQueryParams = { + ...super.generateQueryParams({ + projects: [{ id: project.id }], + variants: variantsParam, + }), + format: this.exportFormat, + }; + const addVariantToProjectMap = fetchText( + params, + this.meta + ).then((textItemsFileContent) => { + result[project.id][variant.id] = textItemsFileContent; + }); + fetchFileContentRequests.push(addVariantToProjectMap); + } + } + + await Promise.all(fetchFileContentRequests); + + return result; + } + + /** + * Fetches component data via API. + * If individual variants configured, fetch by each otherwise fetch for all + * Skips the fetch request if components field is not specified in config. + * + * @returns components data + */ + private async fetchComponentsMap(): Promise { + if (!this.projectConfig.components && !this.output.components) return {}; + const result: ComponentsMap = {}; + + const fetchFileContentRequests = []; + + for (const variant of this.variants) { + // map "base" to undefined, as by default export endpoint returns base variant + const variantsParam = + variant.id === "base" ? undefined : [{ id: variant.id }]; + const folderFilters = super.generateComponentPullFilter().folders; + const params: PullQueryParams = { + // gets folders from base component pull filters, overwrites variants with just this iteration's variant + ...super.generateQueryParams({ + folders: folderFilters, + variants: variantsParam, + }), + format: this.exportFormat, + }; + const addVariantToMap = fetchComponents( + params, + this.meta + ).then((componentsFileContent) => { + result[variant.id] = componentsFileContent; + }); + fetchFileContentRequests.push(addVariantToMap); + } + + return result; + } +} diff --git a/lib/src/formatters/shared/fileTypes/AndroidOutputFile.ts b/lib/src/formatters/shared/fileTypes/AndroidOutputFile.ts new file mode 100644 index 0000000..df3e5ac --- /dev/null +++ b/lib/src/formatters/shared/fileTypes/AndroidOutputFile.ts @@ -0,0 +1,25 @@ +import OutputFile from "./OutputFile"; + +export default class AndroidOutputFile extends OutputFile< + string, + MetadataType +> { + constructor(config: { + filename: string; + path: string; + content?: string; + metadata?: MetadataType; + }) { + super({ + filename: config.filename, + path: config.path, + extension: "xml", + content: config.content ?? "", + metadata: config.metadata ?? ({} as MetadataType), + }); + } + + get formattedContent(): string { + return this.content; + } +} diff --git a/lib/src/formatters/shared/fileTypes/ICUOutputFile.ts b/lib/src/formatters/shared/fileTypes/ICUOutputFile.ts new file mode 100644 index 0000000..860e897 --- /dev/null +++ b/lib/src/formatters/shared/fileTypes/ICUOutputFile.ts @@ -0,0 +1,25 @@ +import OutputFile from "./OutputFile"; + +export default class ICUOutputFile extends OutputFile< + Record, + MetadataType +> { + constructor(config: { + filename: string; + path: string; + content?: Record; + metadata?: MetadataType; + }) { + super({ + filename: config.filename, + path: config.path, + extension: "json", + content: config.content ?? {}, + metadata: config.metadata ?? ({} as MetadataType), + }); + } + + get formattedContent(): string { + return JSON.stringify(this.content, null, 2); + } +} diff --git a/lib/src/formatters/shared/fileTypes/IOSStringsDictOutputFile.ts b/lib/src/formatters/shared/fileTypes/IOSStringsDictOutputFile.ts new file mode 100644 index 0000000..6ad668e --- /dev/null +++ b/lib/src/formatters/shared/fileTypes/IOSStringsDictOutputFile.ts @@ -0,0 +1,25 @@ +import OutputFile from "./OutputFile"; + +export default class IOSStringsDictOutputFile extends OutputFile< + string, + MetadataType +> { + constructor(config: { + filename: string; + path: string; + content?: string; + metadata?: MetadataType; + }) { + super({ + filename: config.filename, + path: config.path, + extension: "stringsdict", + content: config.content ?? "", + metadata: config.metadata ?? ({} as MetadataType), + }); + } + + get formattedContent(): string { + return this.content; + } +} diff --git a/lib/src/http/components.ts b/lib/src/http/components.ts index 2d3d822..7eb8259 100644 --- a/lib/src/http/components.ts +++ b/lib/src/http/components.ts @@ -1,17 +1,35 @@ import { AxiosError } from "axios"; import { ZComponentsResponse, - ZExportComponentsResponse, PullQueryParams, CommandMetaFlags, + ZExportComponentsResponse, } from "./types"; import getHttpClient from "./client"; -function fetchComponentsWrapper( - performRequest: () => Promise +export default async function fetchComponents( + params: PullQueryParams, + meta: CommandMetaFlags ) { try { - return performRequest(); + const httpClient = getHttpClient({ meta }); + switch (params.format) { + case "android": + case "ios-strings": + case "ios-stringsdict": + case "icu": + const exportResponse = await httpClient.get("/v2/components/export", { + params, + }); + return ZExportComponentsResponse.parse( + exportResponse.data + ) as TResponse; + default: + const defaultResponse = await httpClient.get("/v2/components", { + params, + }); + return ZComponentsResponse.parse(defaultResponse.data) as TResponse; + } } catch (e: unknown) { if (!(e instanceof AxiosError)) { throw new Error( @@ -36,27 +54,3 @@ function fetchComponentsWrapper( throw e; } } - -export default async function fetchComponents( - params: PullQueryParams, - meta: CommandMetaFlags -) { - switch (params.format) { - case "ios-strings": - return fetchComponentsWrapper(async () => { - const httpClient = getHttpClient({ meta }); - const response = await httpClient.get("/v2/components/export", { - params, - }); - return ZExportComponentsResponse.parse(response.data) as TResponse; - }); - default: - return fetchComponentsWrapper(async () => { - const httpClient = getHttpClient({ meta }); - const response = await httpClient.get("/v2/components", { - params, - }); - return ZComponentsResponse.parse(response.data) as TResponse; - }); - } -} diff --git a/lib/src/http/textItems.ts b/lib/src/http/textItems.ts index 36c9442..4fb8f3b 100644 --- a/lib/src/http/textItems.ts +++ b/lib/src/http/textItems.ts @@ -1,4 +1,3 @@ -import httpClient from "./client"; import { AxiosError } from "axios"; import { CommandMetaFlags, @@ -8,9 +7,27 @@ import { } from "./types"; import getHttpClient from "./client"; -function fetchTextWrapper(cb: () => Promise) { +export default async function fetchText( + params: PullQueryParams, + meta: CommandMetaFlags +) { try { - return cb(); + const httpClient = getHttpClient({ meta }); + switch (params.format) { + case "android": + case "ios-strings": + case "ios-stringsdict": + case "icu": + const exportResponse = await httpClient.get("/v2/textItems/export", { + params, + }); + return ZExportTextItemsResponse.parse(exportResponse.data) as TResponse; + default: + const defaultResponse = await httpClient.get("/v2/textItems", { + params, + }); + return ZTextItemsResponse.parse(defaultResponse.data) as TResponse; + } } catch (e: unknown) { if (!(e instanceof AxiosError)) { throw new Error( @@ -35,25 +52,3 @@ function fetchTextWrapper(cb: () => Promise) { throw e; } } - -export default async function fetchText( - params: PullQueryParams, - meta: CommandMetaFlags -) { - switch (params.format) { - case "ios-strings": - return fetchTextWrapper(async () => { - const httpClient = getHttpClient({ meta }); - const response = await httpClient.get("/v2/textItems/export", { - params, - }); - return ZExportTextItemsResponse.parse(response.data) as TResponse; - }); - default: - return fetchTextWrapper(async () => { - const httpClient = getHttpClient({ meta }); - const response = await httpClient.get("/v2/textItems", { params }); - return ZTextItemsResponse.parse(response.data) as TResponse; - }); - } -} diff --git a/lib/src/http/types.ts b/lib/src/http/types.ts index df18bd5..a22f406 100644 --- a/lib/src/http/types.ts +++ b/lib/src/http/types.ts @@ -12,7 +12,7 @@ export interface PullFilters { export interface PullQueryParams { filter: string; // Stringified PullFilters richText?: "html"; - format?: "ios-strings" | undefined; + format?: "ios-strings" | "ios-stringsdict" | "android" | "icu" | undefined; } const ZBaseTextEntity = z.object({ @@ -42,7 +42,20 @@ export type TextItem = z.infer; export const ZTextItemsResponse = z.array(ZTextItem); export type TextItemsResponse = z.infer; -export const ZExportTextItemsResponse = z.string(); +const ZExportTextItemsStringResponse = z.string(); +export type ExportTextItemsStringResponse = z.infer< + typeof ZExportTextItemsStringResponse +>; + +const ZExportTextItemsJSONResponse = z.record(z.string(), z.string()); +export type ExportTextItemsJSONResponse = z.infer< + typeof ZExportTextItemsJSONResponse +>; + +export const ZExportTextItemsResponse = z.union([ + ZExportTextItemsStringResponse, + ZExportTextItemsJSONResponse, +]); export type ExportTextItemsResponse = z.infer; // MARK - Components @@ -59,8 +72,22 @@ export type Component = z.infer; export const ZComponentsResponse = z.array(ZComponent); export type ComponentsResponse = z.infer; -export const ZExportComponentsResponse = z.string(); -export type ExportComponentsResponse = z.infer; +export const ZExportComponentsJSONResponse = z.record(z.string(), z.string()); +export type ExportComponentsJSONResponse = z.infer< + typeof ZExportTextItemsJSONResponse +>; + +export const ZExportComponentsStringResponse = z.string(); +export type ExportComponentsStringResponse = z.infer< + typeof ZExportComponentsStringResponse +>; +export const ZExportComponentsResponse = z.union([ + ZExportComponentsStringResponse, + ZExportComponentsJSONResponse, +]); +export type ExportComponentsResponse = z.infer< + typeof ZExportComponentsResponse +>; // MARK - Projects diff --git a/lib/src/outputs/android.ts b/lib/src/outputs/android.ts new file mode 100644 index 0000000..f1acd7a --- /dev/null +++ b/lib/src/outputs/android.ts @@ -0,0 +1,7 @@ +import { z } from "zod"; +import { ZBaseOutputFilters } from "./shared"; + +export const ZAndroidOutput = ZBaseOutputFilters.extend({ + format: z.literal("android"), + framework: z.undefined(), +}).strict(); diff --git a/lib/src/outputs/icu.ts b/lib/src/outputs/icu.ts new file mode 100644 index 0000000..5b98dd4 --- /dev/null +++ b/lib/src/outputs/icu.ts @@ -0,0 +1,7 @@ +import { z } from "zod"; +import { ZBaseOutputFilters } from "./shared"; + +export const ZICUOutput = ZBaseOutputFilters.extend({ + format: z.literal("icu"), + framework: z.undefined(), +}).strict(); diff --git a/lib/src/outputs/index.ts b/lib/src/outputs/index.ts index ae109ce..d723c5f 100644 --- a/lib/src/outputs/index.ts +++ b/lib/src/outputs/index.ts @@ -1,10 +1,19 @@ import { z } from "zod"; import { ZJSONOutput } from "./json"; import { ZIOSStringsOutput } from "./iosStrings"; +import { ZIOSStringsDictOutput } from "./iosStringsDict"; +import { ZAndroidOutput } from "./android"; +import { ZICUOutput } from "./icu"; /** * The output config is a discriminated union of all the possible output formats. */ -export const ZOutput = z.union([...ZJSONOutput.options, ZIOSStringsOutput]); +export const ZOutput = z.union([ + ...ZJSONOutput.options, + ZAndroidOutput, + ZIOSStringsOutput, + ZIOSStringsDictOutput, + ZICUOutput, +]); export type Output = z.infer; diff --git a/lib/src/outputs/iosStringsDict.ts b/lib/src/outputs/iosStringsDict.ts new file mode 100644 index 0000000..0249382 --- /dev/null +++ b/lib/src/outputs/iosStringsDict.ts @@ -0,0 +1,7 @@ +import { z } from "zod"; +import { ZBaseOutputFilters } from "./shared"; + +export const ZIOSStringsDictOutput = ZBaseOutputFilters.extend({ + format: z.literal("ios-stringsdict"), + framework: z.undefined(), +}).strict();