generaltranslation 9.4.0 → 9.4.1

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # generaltranslation
 
+## 9.4.1
+
+### Patch Changes
+
+- [#2288](https://github.com/generaltranslation/gt/pull/2288) [`90109bf`](https://github.com/generaltranslation/gt/commit/90109bf9ec4900819023176320629a5069fd7b51) Thanks [@eoinest](https://github.com/eoinest)! - Preserve configured locale identities across negotiation, routing, hooks, cookies, translation loaders, and caches, including when GT services are enabled. For example, configuring `en-gb` keeps that spelling in application-facing values while GT service requests and formatting use `en-GB`.
+
+  Locale negotiation accepts equivalent spellings and returns a configured identity, preserving exact matches between distinct aliases for the same language. This also applies to request-header negotiation: an `Accept-Language` preference of `fr` can resolve to a configured `brand-french` alias. Preserve support for legacy tags such as `sh` and `cnr`, and retain existing custom mappings when validating partial `setConfig()` updates.
+
+  Translation loaders and local filenames must use the configured identity: a loader for configured `en-gb` receives `en-gb`, not `en-GB`. Configure canonical spelling instead if the application requires it. Custom mapping `code` values must use canonical spelling, for example `'en-gb': { code: 'en-GB' }`. Canonicalize locales at GT service boundaries, including nested source-file locales in translation uploads and requests through the shared CLI/Sanity adapter. Require canonical locale codes or explicit custom mappings for CLI commands that use GT translation services. For example, using `en-us` with the API requires `customMapping: { "en-us": { "code": "en-US" } }`; otherwise the command exits with guidance before running the translation workflow. Local-only commands and dry runs retain their existing validation. Restore configured identities in service metadata; without a corresponding requested identity, use the first matching configured locale.
+
+  Align server/browser locale values and expose the configured locale list through `useLocales()`. In Next.js, preserve configured identities in localized paths, route overrides, and locale availability. Resolve unsupported locale preferences before deciding whether to prefix the default locale, and cache locale resolution during middleware initialization.
+
+  For Next.js App Router, read locale and region from server-provided conditions. Setters write request cookies and retain pending values for the refresh callback; hooks keep reading the current server conditions until a new snapshot arrives, including when a locale switch is rejected. Use `router.refresh()` on Next.js 16.1 and newer and a document reload on older versions to avoid stale layout/provider snapshots after middleware redirects. Detect this capability at build time, retain the existing document reload when returning to the default locale, and leave other React integrations' cookie-backed behavior unchanged. This adds no request-time cookie reads and does not change App Router's existing `enableI18n` behavior.
+
+- Updated dependencies [[`90109bf`](https://github.com/generaltranslation/gt/commit/90109bf9ec4900819023176320629a5069fd7b51)]:
+  - @generaltranslation/format@0.1.9
+
 ## 9.4.0
 
 ### Minor Changes

package/dist/adapter/createGtApi.js

@@ -57,13 +57,18 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 import { createApiClient, createBranch, DEFAULT_BATCH_SIZE, downloadFiles, enqueueFileTranslations, generateProjectContext, getFileInfo, getTranslationJobInfo, pollJobs, processBatches, uploadSourceFiles, uploadTranslations, } from '@generaltranslation/api';
-import { resolveAliasLocale, resolveCanonicalLocale, } from '@generaltranslation/format';
+import { resolveAliasLocale, resolveCanonicalLocale, standardizeLocale, } from '@generaltranslation/format';
 import { decodeFileContent, encodeFileContent } from '../utils/base64';
 import { unwrapApiResult } from '../translate/utils/unwrapApiResult';
 export function createGtApiAdapter(defaultConfig) {
     var client = defaultConfig ? createApiClient(defaultConfig) : undefined;
     var configuredClientConfig = defaultConfig;
     var customMapping;
+    // Mapping resolves aliases; standardization also canonicalizes configured
+    // spellings such as en-us before they cross the service boundary.
+    function resolveServiceLocale(locale) {
+        return standardizeLocale(resolveCanonicalLocale(locale, customMapping));
+    }
     function getClient() {
         if (!client) {
             throw new Error('API client not configured — call configureApiClient first');
@@ -90,7 +95,7 @@ export function createGtApiAdapter(defaultConfig) {
             return resolveAliasLocale(locale, customMapping);
         },
         resolveCanonicalLocale: function (locale) {
-            return resolveCanonicalLocale(locale, customMapping);
+            return resolveServiceLocale(locale);
         },
         createBranch: function (body) {
             return __awaiter(this, void 0, void 0, function () {
@@ -114,7 +119,7 @@ export function createGtApiAdapter(defaultConfig) {
                         case 0:
                             _a = unwrapApiResult;
                             return [4 /*yield*/, getFileInfo({
-                                    body: __assign(__assign({}, body), { translatedFiles: (_b = body.translatedFiles) === null || _b === void 0 ? void 0 : _b.map(function (file) { return (__assign(__assign({}, file), { locale: resolveCanonicalLocale(file.locale, customMapping) })); }) }),
+                                    body: __assign(__assign({}, body), { translatedFiles: (_b = body.translatedFiles) === null || _b === void 0 ? void 0 : _b.map(function (file) { return (__assign(__assign({}, file), { locale: resolveServiceLocale(file.locale) })); }) }),
                                     client: getClient(),
                                 })];
                         case 1:
@@ -141,7 +146,7 @@ export function createGtApiAdapter(defaultConfig) {
                                             _a = unwrapApiResult;
                                             return [4 /*yield*/, downloadFiles({
                                                     body: batch.map(function (file) { return (__assign(__assign({}, file), { locale: file.locale
-                                                            ? resolveCanonicalLocale(file.locale, customMapping)
+                                                            ? resolveServiceLocale(file.locale)
                                                             : undefined })); }),
                                                     client: getClient(),
                                                 })];
@@ -197,7 +202,7 @@ export function createGtApiAdapter(defaultConfig) {
                                             });
                                         }),
                                         locales: (_b = options.locales) === null || _b === void 0 ? void 0 : _b.map(function (locale) {
-                                            return resolveCanonicalLocale(locale, customMapping);
+                                            return resolveServiceLocale(locale);
                                         }),
                                         force: options.force,
                                     },
@@ -216,7 +221,7 @@ export function createGtApiAdapter(defaultConfig) {
                     switch (_a.label) {
                         case 0:
                             targetLocales = options.targetLocales.map(function (locale) {
-                                return resolveCanonicalLocale(locale, customMapping);
+                                return resolveServiceLocale(locale);
                             });
                             return [4 /*yield*/, processBatches(files, function (batch) { return __awaiter(_this, void 0, void 0, function () {
                                     var response, _a, jobData;
@@ -238,7 +243,7 @@ export function createGtApiAdapter(defaultConfig) {
                                                             }),
                                                             targetLocales: targetLocales,
                                                             sourceLocale: options.sourceLocale
-                                                                ? resolveCanonicalLocale(options.sourceLocale, customMapping)
+                                                                ? resolveServiceLocale(options.sourceLocale)
                                                                 : undefined,
                                                             // Consumers intentionally accept custom model-provider strings beyond
                                                             // the OpenAPI enum; preserve the existing wire behavior at this boundary.
@@ -272,7 +277,7 @@ export function createGtApiAdapter(defaultConfig) {
                 return __generator(this, function (_a) {
                     switch (_a.label) {
                         case 0:
-                            sourceLocale = resolveCanonicalLocale(options.sourceLocale, customMapping);
+                            sourceLocale = resolveServiceLocale(options.sourceLocale);
                             return [4 /*yield*/, processBatches(files, function (batch) { return __awaiter(_this, void 0, void 0, function () {
                                     var response, _a;
                                     return __generator(this, function (_b) {
@@ -284,7 +289,7 @@ export function createGtApiAdapter(defaultConfig) {
                                                             data: batch.map(function (_a) {
                                                                 var source = _a.source;
                                                                 return ({
-                                                                    source: __assign(__assign({}, source), { content: encodeFileContent(source.content, source.fileFormat), locale: resolveCanonicalLocale(source.locale, customMapping) }),
+                                                                    source: __assign(__assign({}, source), { content: encodeFileContent(source.content, source.fileFormat), locale: resolveServiceLocale(source.locale) }),
                                                                 });
                                                             }),
                                                             sourceLocale: sourceLocale,
@@ -343,11 +348,11 @@ export function createGtApiAdapter(defaultConfig) {
                                                         data: batch.map(function (_a) {
                                                             var source = _a.source, translations = _a.translations;
                                                             return ({
-                                                                source: __assign(__assign({}, source), { content: encodeFileContent(source.content, source.fileFormat) }),
-                                                                translations: translations.map(function (translation) { return (__assign(__assign({}, translation), { locale: resolveCanonicalLocale(translation.locale, customMapping), content: encodeFileContent(translation.content, translation.fileFormat) })); }),
+                                                                source: __assign(__assign({}, source), { content: encodeFileContent(source.content, source.fileFormat), locale: resolveServiceLocale(source.locale) }),
+                                                                translations: translations.map(function (translation) { return (__assign(__assign({}, translation), { locale: resolveServiceLocale(translation.locale), content: encodeFileContent(translation.content, translation.fileFormat) })); }),
                                                             });
                                                         }),
-                                                        sourceLocale: resolveCanonicalLocale(options.sourceLocale, customMapping),
+                                                        sourceLocale: resolveServiceLocale(options.sourceLocale),
                                                     },
                                                     client: getClient(),
                                                 })];

package/dist/index.cjs

@@ -1,6 +1,6 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const require_unwrapApiResult = require("./unwrapApiResult-Dv6Mfw_K.cjs");
-const require_runtime = require("./runtime-BGUJYxhI.cjs");
+const require_runtime = require("./runtime-C25lwh9m.cjs");
 const require_derive = require("./derive-2CDqwrvS.cjs");
 const require_file = require("./file-B37WkCqM.cjs");
 let _generaltranslation_format = require("@generaltranslation/format");
@@ -774,7 +774,7 @@ var GT = class extends require_runtime.GTRuntime {
 		this._validateAuth("setupProject");
 		options = {
 			...options,
-			locales: options?.locales?.map((locale) => this.resolveCanonicalLocale(locale))
+			locales: options?.locales?.map((locale) => this.resolveServiceLocale(locale))
 		};
 		return await _setupProject(files, this._getTranslationConfig(), options);
 	}
@@ -839,11 +839,16 @@ var GT = class extends require_runtime.GTRuntime {
 			require_runtime.gtInstanceLogger.error(error);
 			throw new Error(error);
 		}
+		const targetLocaleIdentities = [...mergedOptions.targetLocales];
 		mergedOptions = {
 			...mergedOptions,
-			targetLocales: mergedOptions.targetLocales.map((locale) => this.resolveCanonicalLocale(locale))
+			sourceLocale: this.resolveServiceLocale(mergedOptions.sourceLocale),
+			targetLocales: mergedOptions.targetLocales.map((locale) => this.resolveServiceLocale(locale))
+		};
+		return {
+			...await _enqueueFiles(files, mergedOptions, this._getTranslationConfig()),
+			locales: targetLocaleIdentities
 		};
-		return await _enqueueFiles(files, mergedOptions, this._getTranslationConfig());
 	}
 	/**
 	* Creates or upserts a file tag, associating a set of source files
@@ -864,7 +869,10 @@ var GT = class extends require_runtime.GTRuntime {
 	*/
 	async publishFiles(files) {
 		this._validateAuth("publishFiles");
-		return await _publishFiles(files, this._getTranslationConfig());
+		return { results: (await _publishFiles(files, this._getTranslationConfig())).results.map((item) => ({
+			...item,
+			...item.locale && { locale: this.resolveServiceResponseLocale(item.locale) }
+		})) };
 	}
 	/**
 	* Submits user edit diffs for existing translations so future generations preserve user intent.
@@ -878,7 +886,7 @@ var GT = class extends require_runtime.GTRuntime {
 			...payload,
 			diffs: (payload.diffs || []).map((d) => ({
 				...d,
-				locale: this.resolveCanonicalLocale(d.locale)
+				locale: this.resolveServiceLocale(d.locale)
 			}))
 		}, this._getTranslationConfig());
 	}
@@ -910,23 +918,28 @@ var GT = class extends require_runtime.GTRuntime {
 	*/
 	async getProjectInfo(options = {}) {
 		this._validateAuth("getProjectInfo");
-		return await _getProjectInfo(options, this._getTranslationConfig());
+		const result = await _getProjectInfo(options, this._getTranslationConfig());
+		return {
+			...result,
+			defaultLocale: this.resolveServiceResponseLocale(result.defaultLocale),
+			currentLocales: result.currentLocales.map((locale) => this.resolveServiceResponseLocale(locale))
+		};
 	}
 	async queryFileData(data, options = {}) {
 		this._validateAuth("queryFileData");
 		data.translatedFiles = data.translatedFiles?.map((item) => ({
 			...item,
-			locale: this.resolveCanonicalLocale(item.locale)
+			locale: this.resolveServiceLocale(item.locale)
 		}));
 		const result = await _queryFileData(data, options, this._getTranslationConfig());
 		result.translatedFiles = result.translatedFiles?.map((item) => ({
 			...item,
-			...item.locale && { locale: this.resolveAliasLocale(item.locale) }
+			...item.locale && { locale: this.resolveServiceResponseLocale(item.locale) }
 		}));
 		result.sourceFiles = result.sourceFiles?.map((item) => ({
 			...item,
-			...item.sourceLocale && { sourceLocale: this.resolveAliasLocale(item.sourceLocale) },
-			locales: item.locales.map((locale) => this.resolveAliasLocale(locale))
+			...item.sourceLocale && { sourceLocale: this.resolveServiceResponseLocale(item.sourceLocale) },
+			locales: item.locales.map((locale) => this.resolveServiceResponseLocale(locale))
 		}));
 		return result;
 	}
@@ -949,10 +962,10 @@ var GT = class extends require_runtime.GTRuntime {
 		const result = await _querySourceFile(data, options, this._getTranslationConfig());
 		result.translations = result.translations.map((item) => ({
 			...item,
-			...item.locale && { locale: this.resolveAliasLocale(item.locale) }
+			...item.locale && { locale: this.resolveServiceResponseLocale(item.locale) }
 		}));
-		result.sourceFile.locales = result.sourceFile.locales.map((locale) => this.resolveAliasLocale(locale));
-		if (result.sourceFile.sourceLocale) result.sourceFile.sourceLocale = this.resolveAliasLocale(result.sourceFile.sourceLocale);
+		result.sourceFile.locales = result.sourceFile.locales.map((locale) => this.resolveServiceResponseLocale(locale));
+		if (result.sourceFile.sourceLocale) result.sourceFile.sourceLocale = this.resolveServiceResponseLocale(result.sourceFile.sourceLocale);
 		return result;
 	}
 	/**
@@ -970,8 +983,8 @@ var GT = class extends require_runtime.GTRuntime {
 	async getProjectData(projectId, options = {}) {
 		this._validateAuth("getProjectData");
 		const result = await _getProjectData(projectId, options, this._getTranslationConfig());
-		result.currentLocales = result.currentLocales.map((item) => this.resolveAliasLocale(item));
-		result.defaultLocale = this.resolveAliasLocale(result.defaultLocale);
+		result.currentLocales = result.currentLocales.map((item) => this.resolveServiceResponseLocale(item));
+		result.defaultLocale = this.resolveServiceResponseLocale(result.defaultLocale);
 		return result;
 	}
 	/**
@@ -1000,7 +1013,7 @@ var GT = class extends require_runtime.GTRuntime {
 		return (await _downloadFileBatch([{
 			fileId: file.fileId,
 			branchId: file.branchId,
-			locale: file.locale ? this.resolveCanonicalLocale(file.locale) : void 0,
+			locale: file.locale ? this.resolveServiceLocale(file.locale) : void 0,
 			versionId: file.versionId,
 			useLatestAvailableVersion: file.useLatestAvailableVersion
 		}], options, this._getTranslationConfig())).data?.[0]?.data ?? "";
@@ -1023,16 +1036,31 @@ var GT = class extends require_runtime.GTRuntime {
 	*/
 	async downloadFileBatch(requests, options = {}) {
 		this._validateAuth("downloadFileBatch");
-		requests = requests.map((request) => ({
-			...request,
-			locale: request.locale ? this.resolveCanonicalLocale(request.locale) : void 0
-		}));
+		const requestedFiles = /* @__PURE__ */ new Map();
+		requests = requests.map((request) => {
+			const locale = request.locale ? this.resolveServiceLocale(request.locale) : void 0;
+			if (locale) {
+				const key = JSON.stringify([request.fileId, locale]);
+				const group = requestedFiles.get(key) ?? [];
+				group.push(request);
+				requestedFiles.set(key, group);
+			}
+			return {
+				...request,
+				locale
+			};
+		});
 		const result = await _downloadFileBatch(requests, options, this._getTranslationConfig());
 		return {
-			files: result.data.map((file) => ({
-				...file,
-				...file.locale && { locale: this.resolveAliasLocale(file.locale) }
-			})),
+			files: result.data.map((file) => {
+				if (!file.locale) return file;
+				const serviceLocale = this.standardizeLocale(file.locale);
+				const matchingRequests = (requestedFiles.get(JSON.stringify([file.fileId, serviceLocale])) ?? []).filter((request) => (!request.branchId || request.branchId === file.branchId) && (!request.versionId || request.versionId === file.versionId));
+				return {
+					...file,
+					locale: matchingRequests.length === 1 ? matchingRequests[0].locale : this.resolveServiceResponseLocale(file.locale)
+				};
+			}),
 			count: result.count
 		};
 	}
@@ -1052,13 +1080,13 @@ var GT = class extends require_runtime.GTRuntime {
 		this._validateAuth("uploadSourceFiles");
 		const mergedOptions = {
 			...options,
-			sourceLocale: this.resolveCanonicalLocale(options.sourceLocale ?? this.sourceLocale ?? "en")
+			sourceLocale: this.resolveServiceLocale(options.sourceLocale ?? this.sourceLocale ?? "en")
 		};
 		files = files.map((f) => ({
 			...f,
 			source: {
 				...f.source,
-				locale: this.resolveCanonicalLocale(f.source.locale)
+				locale: this.resolveServiceLocale(f.source.locale)
 			}
 		}));
 		const result = await _uploadSourceFiles(files, mergedOptions, this._getTranslationConfig());
@@ -1109,12 +1137,16 @@ var GT = class extends require_runtime.GTRuntime {
 			require_runtime.gtInstanceLogger.error(error);
 			throw new Error(error);
 		}
-		mergedOptions.sourceLocale = this.resolveCanonicalLocale(mergedOptions.sourceLocale);
+		mergedOptions.sourceLocale = this.resolveServiceLocale(mergedOptions.sourceLocale);
 		const result = await _uploadTranslations(files.map((f) => ({
 			...f,
+			source: {
+				...f.source,
+				locale: this.resolveServiceLocale(f.source.locale)
+			},
 			translations: f.translations.map((t) => ({
 				...t,
-				locale: this.resolveCanonicalLocale(t.locale)
+				locale: this.resolveServiceLocale(t.locale)
 			}))
 		})), mergedOptions, this._getTranslationConfig());
 		return {