feat: rebuilt bucket processors (#75)

maxprilutskiy · web-flow · commit b11b48e7c3ab · 2024-05-03T12:48:41.000+02:00
* fix: bucket path patterns

* chore: rm replexica bucket from classic config

* fix(cli): translator response signature

* fix(cli): fix markdown bucket processor (de-)serialization

* chore(demo): rm xcode translations

* fix(cli): fix xcode bucket processor merging

* chore(demo): rm translated results

* chore(demo): add back translated results

* chore(demo): upd demo content translations

* chore: add changeset
diff --git a/.changeset/heavy-eggs-shop.md b/.changeset/heavy-eggs-shop.md
@@ -0,0 +1,8 @@
+---
+"replexica": minor
+"@replexica/compiler": minor
+"@replexica/react": minor
+"@replexica/spec": minor
+---
+
+framework-agnostic i18n support
diff --git a/demo/classic/i18n.json b/demo/classic/i18n.json
@@ -7,7 +7,6 @@
     ]
   },
   "buckets": {
-    "": "replexica",
     "json/[locale].json": "json",
     "xcode/Localizable.xcstrings": "xcode",
     "yaml/[locale].yml": "yaml",
diff --git a/demo/classic/json/es.json b/demo/classic/json/es.json
@@ -1,6 +1,6 @@
 {
   "home": {
     "title/main": "Replexica",
-    "description/dev": "Replexica es una plataforma de localización como servicio potenciada por IA para SaaS modernos."
+    "description/dev": "Replexica es una plataforma de localización como servicio impulsada por IA para SaaS modernos."
   }
 }
diff --git a/demo/classic/json/fr.json b/demo/classic/json/fr.json
diff --git a/demo/classic/markdown/es.md b/demo/classic/markdown/es.md
@@ -46,7 +46,7 @@ Convierte todos los caracteres de la cadena dada a mayúsculas.
 
 ## Contribuciones
 
-Las solicitudes de extracción son bienvenidas. Para cambios importantes, por favor abre un problema primero para discutir lo que te gustaría cambiar.
+Se aceptan solicitudes de extracción. Para cambios importantes, por favor abre un problema primero para discutir lo que te gustaría cambiar.
 
 ## Licencia
 
diff --git a/demo/classic/markdown/fr.md b/demo/classic/markdown/fr.md
diff --git a/demo/classic/xcode/Localizable.xcstrings b/demo/classic/xcode/Localizable.xcstrings
@@ -16,12 +16,6 @@
             "state": "translated",
             "value": "¡Hola mundo!"
           }
-        },
-        "fr": {
-          "stringUnit": {
-            "state": "translated",
-            "value": "Bonjour le monde !!"
-          }
         }
       }
     },
@@ -75,30 +69,6 @@
               }
             }
           }
-        },
-        "fr": {
-          "variations": {
-            "plural": {
-              "one": {
-                "stringUnit": {
-                  "state": "translated",
-                  "value": "%lld article"
-                }
-              },
-              "other": {
-                "stringUnit": {
-                  "state": "translated",
-                  "value": "%lld articles"
-                }
-              },
-              "zero": {
-                "stringUnit": {
-                  "state": "translated",
-                  "value": "Aucun article"
-                }
-              }
-            }
-          }
         }
       }
     }
diff --git a/demo/classic/yaml-root-key/es.yml b/demo/classic/yaml-root-key/es.yml
@@ -2,4 +2,4 @@ es:
   home:
     title/main: Replexica
     description/dev: Replexica es una plataforma de localización como servicio
-      potenciada por IA para SaaS modernos.
+      impulsada por IA para SaaS modernos.
diff --git a/demo/classic/yaml-root-key/fr.yml b/demo/classic/yaml-root-key/fr.yml
diff --git a/demo/classic/yaml/fr.yml b/demo/classic/yaml/fr.yml
diff --git a/packages/cli/src/services/bucket/core.ts b/packages/cli/src/services/bucket/core.ts
@@ -6,6 +6,7 @@ import { createId } from '@paralleldrive/cuid2';
 import { YamlBucketProcessor } from './yaml.js';
 import { YamlRootKeyBucketProcessor } from './yaml-root-key.js';
 import { XcodeBucketProcessor } from './xcode.js';
+import { MarkdownBucketProcessor } from './markdown.js';
 
 // Bucket processor
 
@@ -36,6 +37,7 @@ export function createBucketProcessor(
     case 'yaml': return new YamlBucketProcessor(bucketPath, translator);
     case 'yaml-root-key': return new YamlRootKeyBucketProcessor(bucketPath, translator);
     case 'xcode': return new XcodeBucketProcessor(bucketPath, translator);
+    case 'markdown': return new MarkdownBucketProcessor(bucketPath, translator);
   }
 }
 
@@ -83,7 +85,8 @@ export function createTranslator(options: CreateTranslatorOptions): BucketTransl
       }
     }
 
-    const result = await res.json();
+    const jsonResponse = await res.json();
+    const result = jsonResponse.data || null;
     return result;
   };
 }
diff --git a/packages/cli/src/services/bucket/json.ts b/packages/cli/src/services/bucket/json.ts
@@ -1,18 +1,18 @@
-import { BucketTranslatorFn, IBucketProcessor } from "./core.js";
+import { IBucketProcessor } from "./core.js";
 import { BaseBucketProcessor } from "./base.js";
 
 export class JsonBucketProcessor extends BaseBucketProcessor implements IBucketProcessor {
   protected override _validateBucketPath(bucketPath: string): void {
-    if (!bucketPath.includes('[lang]')) {
-      throw new Error(`Invalid bucket path: ${bucketPath}. The path must include the [lang] placeholder.`);
+    if (!bucketPath.includes('[locale]')) {
+      throw new Error(`Invalid bucket path: ${bucketPath}. The path must include the [locale] placeholder.`);
     }
     if (!bucketPath.endsWith('.json')) {
       throw new Error(`Invalid bucket path: ${bucketPath}. The path must have a .json file extension.`);
     }
   }
 
   protected override _resolveDataFilePath(locale: string): string {
-    return this.bucketPath.replace('[lang]', locale);
+    return this.bucketPath.replace('[locale]', locale);
   }
 
   protected override async _deserializeData(content: string): Promise<Record<string, any>> {
diff --git a/packages/cli/src/services/bucket/markdown.ts b/packages/cli/src/services/bucket/markdown.ts
@@ -1,33 +1,26 @@
 import { IBucketProcessor } from "./core.js";
 import { BaseBucketProcessor } from "./base.js";
 import _ from 'lodash';
-import objectHash from 'object-hash';
 
 export class MarkdownBucketProcessor extends BaseBucketProcessor implements IBucketProcessor {
   protected override _validateBucketPath(bucketPath: string): void {
-    if (!bucketPath.includes('[lang]')) {
-      throw new Error(`Invalid bucket path: ${bucketPath}. The path must include the [lang] placeholder.`);
+    if (!bucketPath.includes('[locale]')) {
+      throw new Error(`Invalid bucket path: ${bucketPath}. The path must include the [locale] placeholder.`);
     }
     if (!bucketPath.endsWith('.md')) {
       throw new Error(`Invalid bucket path: ${bucketPath}. The path must have a .md file extension.`);
     }
   }
 
   protected override _resolveDataFilePath(locale: string): string {
-    return this.bucketPath.replace('[lang]', locale);
+    return this.bucketPath.replace('[locale]', locale);
   }
 
   protected override async _deserializeData(content: string): Promise<Record<string, any>> {
-    const result = _.chain(content)
-      .split('\n\n')
-      .map((content, index) => [objectHash({ content, index }), content])
-      .fromPairs()
-      .value();
-    
-    return result;
+    return { '': content };
   }
 
   protected override async _serializeDataContent(data: Record<string, any>): Promise<string> {
-    return _.values(data).join('\n\n');
+    return data[''];
   }
 }
diff --git a/packages/cli/src/services/bucket/xcode.ts b/packages/cli/src/services/bucket/xcode.ts
@@ -1,3 +1,4 @@
+import _ from 'lodash';
 import { BucketPayload, IBucketProcessor } from "./core.js";
 import { BaseBucketProcessor } from "./base.js";
 
@@ -49,6 +50,8 @@ export class XcodeBucketProcessor extends BaseBucketProcessor implements IBucket
   }
 
   protected async _preSave(payload: BucketPayload, locale: string): Promise<BucketPayload> {
+    const existingLangData = await this._loadData(locale);
+
     const langDataToMerge: any = {};
     langDataToMerge.strings = {};
 
@@ -98,6 +101,11 @@ export class XcodeBucketProcessor extends BaseBucketProcessor implements IBucket
       }
     }
 
-    return langDataToMerge;
+    const resultData = _.merge({}, existingLangData, langDataToMerge);
+
+    return {
+      data: resultData,
+      meta: payload.meta,
+    };
   }
 }
diff --git a/packages/cli/src/services/bucket/yaml.ts b/packages/cli/src/services/bucket/yaml.ts
@@ -4,8 +4,8 @@ import { BaseBucketProcessor } from "./base.js";
 
 export class YamlBucketProcessor extends BaseBucketProcessor implements IBucketProcessor {
   protected override _validateBucketPath(bucketPath: string): void {
-    if (!bucketPath.includes('[lang]')) {
-      throw new Error(`Invalid bucket path: ${bucketPath}. The path must include the [lang] placeholder.`);
+    if (!bucketPath.includes('[locale]')) {
+      throw new Error(`Invalid bucket path: ${bucketPath}. The path must include the [locale] placeholder.`);
     }
 
     const supportedExtensions = ['.yaml', '.yml'];
@@ -15,7 +15,7 @@ export class YamlBucketProcessor extends BaseBucketProcessor implements IBucketP
   }
 
   protected override _resolveDataFilePath(locale: string): string {
-    return this.bucketPath.replace('[lang]', locale);
+    return this.bucketPath.replace('[locale]', locale);
   }
 
   protected _deserializeData(content: string): Promise<Record<string, any>> {

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,6 @@`
`7`	`7`	`]`
`8`	`8`	`},`
`9`	`9`	`"buckets": {`
`10`		`- "": "replexica",`
`11`	`10`	`"json/[locale].json": "json",`
`12`	`11`	`"xcode/Localizable.xcstrings": "xcode",`
`13`	`12`	`"yaml/[locale].yml": "yaml",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"home": {`
`3`	`3`	`"title/main": "Replexica",`
`4`		`- "description/dev": "Replexica es una plataforma de localización como servicio potenciada por IA para SaaS modernos."`
	`4`	`+ "description/dev": "Replexica es una plataforma de localización como servicio impulsada por IA para SaaS modernos."`
`5`	`5`	`}`
`6`	`6`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,12 +16,6 @@`
`16`	`16`	`"state": "translated",`
`17`	`17`	`"value": "¡Hola mundo!"`
`18`	`18`	`}`
`19`		`- },`
`20`		`- "fr": {`
`21`		`- "stringUnit": {`
`22`		`- "state": "translated",`
`23`		`- "value": "Bonjour le monde !!"`
`24`		`- }`
`25`	`19`	`}`
`26`	`20`	`}`
`27`	`21`	`},`
`@@ -75,30 +69,6 @@`
`75`	`69`	`}`
`76`	`70`	`}`
`77`	`71`	`}`
`78`		`- },`
`79`		`- "fr": {`
`80`		`- "variations": {`
`81`		`- "plural": {`
`82`		`- "one": {`
`83`		`- "stringUnit": {`
`84`		`- "state": "translated",`
`85`		`- "value": "%lld article"`
`86`		`- }`
`87`		`- },`
`88`		`- "other": {`
`89`		`- "stringUnit": {`
`90`		`- "state": "translated",`
`91`		`- "value": "%lld articles"`
`92`		`- }`
`93`		`- },`
`94`		`- "zero": {`
`95`		`- "stringUnit": {`
`96`		`- "state": "translated",`
`97`		`- "value": "Aucun article"`
`98`		`- }`
`99`		`- }`
`100`		`- }`
`101`		`- }`
`102`	`72`	`}`
`103`	`73`	`}`
`104`	`74`	`}`