gtx-cli 2.5.6 → 2.5.7

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # gtx-cli
 
+## 2.5.7
+
+### Patch Changes
+
+- [#819](https://github.com/generaltranslation/gt/pull/819) [`50338d2`](https://github.com/generaltranslation/gt/commit/50338d2192e2882a4192273a7bbf12d39939c209) Thanks [@fernando-aviles](https://github.com/fernando-aviles)! - Adding sorting by locale order
+
 ## 2.5.6
 
 ### Patch Changes

package/dist/api/downloadFileBatch.js

@@ -83,7 +83,7 @@ export async function downloadFileBatch(fileTracker, files, options, forceDownlo
                                     translatedContent: file.data,
                                     targetLocale: locale,
                                 },
-                            ], options.defaultLocale)[0];
+                            ], options.defaultLocale, options.locales)[0];
                         }
                     }
                 }

package/dist/formats/json/mergeJson.d.ts

@@ -2,7 +2,7 @@ import { AdditionalOptions, SourceObjectOptions } from '../../types/index.js';
 export declare function mergeJson(originalContent: string, inputPath: string, options: AdditionalOptions, targets: {
     translatedContent: string;
     targetLocale: string;
-}[], defaultLocale: string): string[];
+}[], defaultLocale: string, localeOrder?: string[]): string[];
 /**
  * Apply transformations to the sourceItem in-place
  * @param sourceItem - The source item to apply transformations to

package/dist/formats/json/mergeJson.js

@@ -1,10 +1,10 @@
 import JSONPointer from 'jsonpointer';
 import { exit, logError, logWarning } from '../../console/logging.js';
-import { findMatchingItemArray, findMatchingItemObject, generateSourceObjectPointers, getSourceObjectOptionsArray, validateJsonSchema, } from './utils.js';
+import { findMatchingItemArray, findMatchingItemObject, generateSourceObjectPointers, getIdentifyingLocaleProperty, getSourceObjectOptionsArray, validateJsonSchema, } from './utils.js';
 import { JSONPath } from 'jsonpath-plus';
 import { getLocaleProperties } from 'generaltranslation';
 import { replaceLocalePlaceholders } from '../utils.js';
-export function mergeJson(originalContent, inputPath, options, targets, defaultLocale) {
+export function mergeJson(originalContent, inputPath, options, targets, defaultLocale, localeOrder = []) {
     const jsonSchema = validateJsonSchema(options, inputPath);
     if (!jsonSchema) {
         return targets.map((target) => target.translatedContent);
@@ -136,7 +136,7 @@ export function mergeJson(originalContent, inputPath, options, targets, defaultL
             const filteredSourceObjectValue = sourceObjectValue.filter((_, index) => !indiciesToRemove.has(index));
             // 10. Add all items to the original JSON
             filteredSourceObjectValue.push(...itemsToAdd);
-            JSONPointer.set(mergedJson, sourceObjectPointer, filteredSourceObjectValue);
+            JSONPointer.set(mergedJson, sourceObjectPointer, sortByLocaleOrder(filteredSourceObjectValue, sourceObjectOptions, localeOrder, sourceObjectPointer, defaultLocale));
         }
         else {
             // Validate type
@@ -205,6 +205,53 @@ export function mergeJson(originalContent, inputPath, options, targets, defaultL
     }
     return [JSON.stringify(mergedJson, null, 2)];
 }
+function sortByLocaleOrder(items, sourceObjectOptions, localeOrder, sourceObjectPointer, defaultLocale) {
+    if (sourceObjectOptions.experimentalSort !== 'locales' ||
+        !localeOrder.length ||
+        !sourceObjectOptions.key) {
+        return items;
+    }
+    const orderedLocaleList = [
+        defaultLocale,
+        ...localeOrder.filter((locale) => locale !== defaultLocale),
+    ];
+    const localeOrderValues = orderedLocaleList.map((locale) => getIdentifyingLocaleProperty(locale, sourceObjectPointer, sourceObjectOptions));
+    const itemsWithLocale = items.map((item) => {
+        let localeValue;
+        try {
+            const values = JSONPath({
+                json: item,
+                path: sourceObjectOptions.key,
+                resultType: 'value',
+                flatten: true,
+                wrap: true,
+            });
+            const value = values?.[0];
+            if (typeof value === 'string') {
+                localeValue = value;
+            }
+        }
+        catch {
+            /* empty */
+        }
+        return { item, localeValue };
+    });
+    const orderedItems = [];
+    const remainingItems = [...itemsWithLocale];
+    for (const localeValue of localeOrderValues) {
+        for (let i = 0; i < remainingItems.length;) {
+            const entry = remainingItems[i];
+            if (entry.localeValue === localeValue) {
+                orderedItems.push(entry.item);
+                remainingItems.splice(i, 1);
+                continue;
+            }
+            i += 1;
+        }
+    }
+    remainingItems.forEach((entry) => orderedItems.push(entry.item));
+    return orderedItems;
+}
 /**
  * Apply transformations to the sourceItem in-place
  * @param sourceItem - The source item to apply transformations to

package/dist/types/index.d.ts

@@ -187,6 +187,7 @@ export type SourceObjectOptions = {
     key?: string;
     localeProperty?: string;
     transform?: TransformOptions;
+    experimentalSort?: 'locales';
 };
 export type TransformOptions = {
     [transformPath: string]: TransformOption;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gtx-cli",
-  "version": "2.5.6",
+  "version": "2.5.7",
   "main": "dist/index.js",
   "bin": "dist/main.js",
   "files": [