generaltranslation 9.4.2 → 9.5.0

package/dist/index.js

@@ -62,6 +62,17 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
         if (ar || !(i in from)) {
@@ -72,28 +83,12 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     return to.concat(ar || Array.prototype.slice.call(from));
 };
 import { libraryDefaultLocale } from './settings/settings';
+import { defaultBaseUrl } from './settings/settingsUrls';
 import { noSourceLocaleProvidedError, noTargetLocaleProvidedError, } from './logging/errors';
 import { gtInstanceLogger } from './logging/logger';
-import { _setupProject, } from './translate/setupProject';
-import { _enqueueFiles, } from './translate/enqueueFiles';
-import { _createTag, } from './translate/createTag';
-import { _downloadFileBatch } from './translate/downloadFileBatch';
-import { _submitUserEditDiffs, } from './translate/submitUserEditDiffs';
-import { _uploadSourceFiles } from './translate/uploadSourceFiles';
-import { _uploadFonts } from './translate/uploadFonts';
-import { _uploadTranslations } from './translate/uploadTranslations';
-import { _querySourceFile } from './translate/querySourceFile';
-import { _getProjectData } from './projects/getProjectData';
-import { _checkJobStatus, } from './translate/checkJobStatus';
-import { _awaitJobIds, } from './translate/awaitJobs';
-import { _queryFileData } from './translate/queryFileData';
-import { _getProjectInfo } from './translate/getProjectInfo';
-import { _queryBranchData } from './translate/queryBranchData';
-import { _createBranch } from './translate/createBranch';
-import { _processFileMoves, } from './translate/processFileMoves';
-import { _getOrphanedFiles, } from './translate/getOrphanedFiles';
-import { _publishFiles, } from './translate/publishFiles';
+import { createGtApiAdapter } from './adapter/createGtApi';
 import { GTRuntime } from './runtime';
+import { validateAuth } from './translate/runtimeTranslate';
 export { GTRuntime } from './runtime';
 export { decodeVars } from './derive/decodeVars';
 export { declareVar } from './derive/declareVar';
@@ -127,6 +122,27 @@ var GT = /** @class */ (function (_super) {
     function GT() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
+    GT.prototype.setConfig = function (params) {
+        // GTRuntime writes credentials before it validates locales, so drop the
+        // cache even when validation throws.
+        try {
+            _super.prototype.setConfig.call(this, params);
+        }
+        finally {
+            this._apiAdapter = undefined;
+        }
+    };
+    GT.prototype._getApiAdapter = function () {
+        var _a;
+        (_a = this._apiAdapter) !== null && _a !== void 0 ? _a : (this._apiAdapter = createGtApiAdapter({
+            apiKey: this.apiKey || this.devApiKey,
+            userTokenProvider: this.userTokenProvider,
+            baseUrl: this.baseUrl || defaultBaseUrl,
+            projectId: this.projectId,
+            customMapping: this.customMapping,
+        }));
+        return this._apiAdapter;
+    };
     // -------------- Branch Methods -------------- //
     /**
      * Queries branch information from the API.
@@ -139,8 +155,8 @@ var GT = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        this._validateAuth('queryBranchData');
-                        return [4 /*yield*/, _queryBranchData(query, this._getTranslationConfig())];
+                        validateAuth('queryBranchData', this._getTranslationConfig());
+                        return [4 /*yield*/, this._getApiAdapter().queryBranchData(query)];
                     case 1: return [2 /*return*/, _a.sent()];
                 }
             });
@@ -157,8 +173,8 @@ var GT = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        this._validateAuth('createBranch');
-                        return [4 /*yield*/, _createBranch(query, this._getTranslationConfig())];
+                        validateAuth('createBranch', this._getTranslationConfig());
+                        return [4 /*yield*/, this._getApiAdapter().createBranch(query)];
                     case 1: return [2 /*return*/, _a.sent()];
                 }
             });
@@ -183,8 +199,8 @@ var GT = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        this._validateAuth('processFileMoves');
-                        return [4 /*yield*/, _processFileMoves(moves, options, this._getTranslationConfig())];
+                        validateAuth('processFileMoves', this._getTranslationConfig());
+                        return [4 /*yield*/, this._getApiAdapter().processFileMoves(moves, options)];
                     case 1: return [2 /*return*/, _a.sent()];
                 }
             });
@@ -209,8 +225,8 @@ var GT = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        this._validateAuth('getOrphanedFiles');
-                        return [4 /*yield*/, _getOrphanedFiles(branchId, fileIds, options, this._getTranslationConfig())];
+                        validateAuth('getOrphanedFiles', this._getTranslationConfig());
+                        return [4 /*yield*/, this._getApiAdapter().getOrphanedFiles(branchId, fileIds, options)];
                     case 1: return [2 /*return*/, _a.sent()];
                 }
             });
@@ -236,11 +252,11 @@ var GT = /** @class */ (function (_super) {
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
-                        this._validateAuth('setupProject');
+                        validateAuth('setupProject', this._getTranslationConfig());
                         options = __assign(__assign({}, options), { locales: (_a = options === null || options === void 0 ? void 0 : options.locales) === null || _a === void 0 ? void 0 : _a.map(function (locale) {
                                 return _this.resolveServiceLocale(locale);
                             }) });
-                        return [4 /*yield*/, _setupProject(files, this._getTranslationConfig(), options)];
+                        return [4 /*yield*/, this._getApiAdapter().setupProject(files, options)];
                     case 1: return [2 /*return*/, _b.sent()];
                 }
             });
@@ -267,8 +283,8 @@ var GT = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        this._validateAuth('checkJobStatus');
-                        return [4 /*yield*/, _checkJobStatus(jobIds, this._getTranslationConfig(), timeoutMs)];
+                        validateAuth('checkJobStatus', this._getTranslationConfig());
+                        return [4 /*yield*/, this._getApiAdapter().checkJobStatus(jobIds, timeoutMs)];
                     case 1: return [2 /*return*/, _a.sent()];
                 }
             });
@@ -287,9 +303,9 @@ var GT = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        this._validateAuth('awaitJobs');
+                        validateAuth('awaitJobs', this._getTranslationConfig());
                         jobIds = Array.isArray(jobs) ? jobs : Object.keys(jobs.jobData);
-                        return [4 /*yield*/, _awaitJobIds(jobIds, options, this._getTranslationConfig())];
+                        return [4 /*yield*/, this._getApiAdapter().awaitJobs(jobIds, options)];
                     case 1: return [2 /*return*/, _a.sent()];
                 }
             });
@@ -317,7 +333,7 @@ var GT = /** @class */ (function (_super) {
                 switch (_c.label) {
                     case 0:
                         // Validation
-                        this._validateAuth('enqueueFiles');
+                        validateAuth('enqueueFiles', this._getTranslationConfig());
                         mergedOptions = __assign(__assign({}, options), { sourceLocale: (_a = options.sourceLocale) !== null && _a !== void 0 ? _a : this.sourceLocale, targetLocales: (_b = options.targetLocales) !== null && _b !== void 0 ? _b : [this.targetLocale] });
                         // Require source locale
                         if (!mergedOptions.sourceLocale) {
@@ -337,7 +353,7 @@ var GT = /** @class */ (function (_super) {
                         mergedOptions = __assign(__assign({}, mergedOptions), { sourceLocale: this.resolveServiceLocale(mergedOptions.sourceLocale), targetLocales: mergedOptions.targetLocales.map(function (locale) {
                                 return _this.resolveServiceLocale(locale);
                             }) });
-                        return [4 /*yield*/, _enqueueFiles(files, mergedOptions, this._getTranslationConfig())];
+                        return [4 /*yield*/, this._getApiAdapter().enqueueFiles(files, mergedOptions)];
                     case 1:
                         result = _c.sent();
                         return [2 /*return*/, __assign(__assign({}, result), { locales: targetLocaleIdentities })];
@@ -357,8 +373,8 @@ var GT = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        this._validateAuth('createTag');
-                        return [4 /*yield*/, _createTag(options, this._getTranslationConfig())];
+                        validateAuth('createTag', this._getTranslationConfig());
+                        return [4 /*yield*/, this._getApiAdapter().createTag(options)];
                     case 1: return [2 /*return*/, _a.sent()];
                 }
             });
@@ -377,8 +393,8 @@ var GT = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        this._validateAuth('publishFiles');
-                        return [4 /*yield*/, _publishFiles(files, this._getTranslationConfig())];
+                        validateAuth('publishFiles', this._getTranslationConfig());
+                        return [4 /*yield*/, this._getApiAdapter().publishFiles(files)];
                     case 1:
                         result = _a.sent();
                         return [2 /*return*/, {
@@ -403,9 +419,9 @@ var GT = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        this._validateAuth('submitUserEditDiffs');
+                        validateAuth('submitUserEditDiffs', this._getTranslationConfig());
                         normalized = __assign(__assign({}, payload), { diffs: (payload.diffs || []).map(function (d) { return (__assign(__assign({}, d), { locale: _this.resolveServiceLocale(d.locale) })); }) });
-                        return [4 /*yield*/, _submitUserEditDiffs(normalized, this._getTranslationConfig())];
+                        return [4 /*yield*/, this._getApiAdapter().submitUserEditDiffs(normalized)];
                     case 1:
                         _a.sent();
                         return [2 /*return*/];
@@ -447,8 +463,8 @@ var GT = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        this._validateAuth('getProjectInfo');
-                        return [4 /*yield*/, _getProjectInfo(options, this._getTranslationConfig())];
+                        validateAuth('getProjectInfo', this._getTranslationConfig());
+                        return [4 /*yield*/, this._getApiAdapter().getProjectInfo(undefined, options.timeout)];
                     case 1:
                         result = _a.sent();
                         return [2 /*return*/, __assign(__assign({}, result), { defaultLocale: this.resolveServiceResponseLocale(result.defaultLocale), currentLocales: result.currentLocales.map(function (locale) {
@@ -468,13 +484,13 @@ var GT = /** @class */ (function (_super) {
                 switch (_d.label) {
                     case 0:
                         // Validation
-                        this._validateAuth('queryFileData');
+                        validateAuth('queryFileData', this._getTranslationConfig());
                         // Replace target locales with canonical locales
                         data.translatedFiles = (_a = data.translatedFiles) === null || _a === void 0 ? void 0 : _a.map(function (item) { return (__assign(__assign({}, item), { locale: _this.resolveServiceLocale(item.locale) })); });
-                        return [4 /*yield*/, _queryFileData(data, options, this._getTranslationConfig())];
+                        return [4 /*yield*/, this._getApiAdapter().queryFileData(data, options.timeout)];
                     case 1:
                         result = _d.sent();
-                        // Resolve canonical locales
+                        // Restore configured identities from service language codes.
                         result.translatedFiles = (_b = result.translatedFiles) === null || _b === void 0 ? void 0 : _b.map(function (item) { return (__assign(__assign({}, item), (item.locale && {
                             locale: _this.resolveServiceResponseLocale(item.locale),
                         }))); });
@@ -511,8 +527,8 @@ var GT = /** @class */ (function (_super) {
                 switch (_a.label) {
                     case 0:
                         // Validation
-                        this._validateAuth('querySourceFile');
-                        return [4 /*yield*/, _querySourceFile(data, options, this._getTranslationConfig())];
+                        validateAuth('querySourceFile', this._getTranslationConfig());
+                        return [4 /*yield*/, this._getApiAdapter().querySourceFile({ fileId: data.fileId }, { branchId: data.branchId, versionId: data.versionId }, options.timeout)];
                     case 1:
                         result = _a.sent();
                         // Restore configured identities from service language codes.
@@ -533,6 +549,9 @@ var GT = /** @class */ (function (_super) {
     /**
      * Get project data for a given project ID.
      *
+     * @deprecated Use `getProjectInfo()` on a `GT` instance configured with the
+     * target `projectId`; it reads the same resource and also returns
+     * `autoApprove`. This method will be removed in the next major version.
      * @param {string} projectId - The ID of the project to get the data for.
      * @returns {Promise<ProjectData>} The project data.
      *
@@ -544,23 +563,21 @@ var GT = /** @class */ (function (_super) {
      */
     GT.prototype.getProjectData = function (projectId_1) {
         return __awaiter(this, arguments, void 0, function (projectId, options) {
-            var result;
+            var _a, _autoApprove, project;
             var _this = this;
             if (options === void 0) { options = {}; }
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            return __generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
                         // Validation
-                        this._validateAuth('getProjectData');
-                        return [4 /*yield*/, _getProjectData(projectId, options, this._getTranslationConfig())];
+                        validateAuth('getProjectData', this._getTranslationConfig());
+                        return [4 /*yield*/, this._getApiAdapter().getProjectInfo(projectId, options.timeout)];
                     case 1:
-                        result = _a.sent();
+                        _a = _b.sent(), _autoApprove = _a.autoApprove, project = __rest(_a, ["autoApprove"]);
                         // Restore configured identities from service language codes.
-                        result.currentLocales = result.currentLocales.map(function (item) {
-                            return _this.resolveServiceResponseLocale(item);
-                        });
-                        result.defaultLocale = this.resolveServiceResponseLocale(result.defaultLocale);
-                        return [2 /*return*/, result];
+                        return [2 /*return*/, __assign(__assign({}, project), { defaultLocale: this.resolveServiceResponseLocale(project.defaultLocale), currentLocales: project.currentLocales.map(function (item) {
+                                    return _this.resolveServiceResponseLocale(item);
+                                }) })];
                 }
             });
         });
@@ -589,27 +606,21 @@ var GT = /** @class */ (function (_super) {
     GT.prototype.downloadFile = function (file_1) {
         return __awaiter(this, arguments, void 0, function (file, options) {
             var result;
-            var _a, _b, _c;
+            var _a, _b;
             if (options === void 0) { options = {}; }
-            return __generator(this, function (_d) {
-                switch (_d.label) {
+            return __generator(this, function (_c) {
+                switch (_c.label) {
                     case 0:
                         // Validation
-                        this._validateAuth('downloadTranslatedFile');
-                        return [4 /*yield*/, _downloadFileBatch([
-                                {
-                                    fileId: file.fileId,
-                                    branchId: file.branchId,
-                                    locale: file.locale
+                        validateAuth('downloadTranslatedFile', this._getTranslationConfig());
+                        return [4 /*yield*/, this._getApiAdapter().downloadFileBatch([
+                                __assign(__assign({}, file), { locale: file.locale
                                         ? this.resolveServiceLocale(file.locale)
-                                        : undefined,
-                                    versionId: file.versionId,
-                                    useLatestAvailableVersion: file.useLatestAvailableVersion,
-                                },
-                            ], options, this._getTranslationConfig())];
+                                        : undefined }),
+                            ], options)];
                     case 1:
-                        result = _d.sent();
-                        return [2 /*return*/, (_c = (_b = (_a = result.data) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.data) !== null && _c !== void 0 ? _c : ''];
+                        result = _c.sent();
+                        return [2 /*return*/, (_b = (_a = result.files[0]) === null || _a === void 0 ? void 0 : _a.data) !== null && _b !== void 0 ? _b : ''];
                 }
             });
         });
@@ -639,7 +650,7 @@ var GT = /** @class */ (function (_super) {
                 switch (_a.label) {
                     case 0:
                         // Validation
-                        this._validateAuth('downloadFileBatch');
+                        validateAuth('downloadFileBatch', this._getTranslationConfig());
                         requestedFiles = new Map();
                         requests = requests.map(function (request) {
                             var _a;
@@ -654,15 +665,17 @@ var GT = /** @class */ (function (_super) {
                             }
                             return __assign(__assign({}, request), { locale: locale });
                         });
-                        return [4 /*yield*/, _downloadFileBatch(requests, options, this._getTranslationConfig())];
+                        return [4 /*yield*/, this._getApiAdapter().downloadFileBatch(requests, options)];
                     case 1:
                         result = _a.sent();
                         return [2 /*return*/, {
-                                files: result.data.map(function (file) {
+                                files: result.files.map(function (file) {
                                     var _a;
                                     if (!file.locale)
                                         return file;
-                                    var serviceLocale = _this.standardizeLocale(file.locale);
+                                    // The adapter may already have restored an alias; canonicalize before
+                                    // matching against the service codes the requests were keyed by.
+                                    var serviceLocale = _this.resolveServiceLocale(file.locale);
                                     var matchingRequests = ((_a = requestedFiles.get(JSON.stringify([file.fileId, serviceLocale]))) !== null && _a !== void 0 ? _a : []).filter(function (request) {
                                         return (!request.branchId || request.branchId === file.branchId) &&
                                             (!request.versionId || request.versionId === file.versionId);
@@ -691,24 +704,25 @@ var GT = /** @class */ (function (_super) {
      */
     GT.prototype.uploadSourceFiles = function (files, options) {
         return __awaiter(this, void 0, void 0, function () {
-            var mergedOptions, result;
+            var mergedOptions, result, uploadedFiles;
             var _this = this;
             var _a, _b;
             return __generator(this, function (_c) {
                 switch (_c.label) {
                     case 0:
                         // Validation
-                        this._validateAuth('uploadSourceFiles');
+                        validateAuth('uploadSourceFiles', this._getTranslationConfig());
                         mergedOptions = __assign(__assign({}, options), { sourceLocale: this.resolveServiceLocale((_b = (_a = options.sourceLocale) !== null && _a !== void 0 ? _a : this.sourceLocale) !== null && _b !== void 0 ? _b : libraryDefaultLocale) });
                         // resolve canonical locales
                         files = files.map(function (f) { return (__assign(__assign({}, f), { source: __assign(__assign({}, f.source), { locale: _this.resolveServiceLocale(f.source.locale) }) })); });
-                        return [4 /*yield*/, _uploadSourceFiles(files, mergedOptions, this._getTranslationConfig())];
+                        return [4 /*yield*/, this._getApiAdapter().uploadSourceFiles(files, mergedOptions)];
                     case 1:
                         result = _c.sent();
+                        uploadedFiles = result.uploadedFiles;
                         return [2 /*return*/, {
-                                uploadedFiles: result.data,
-                                count: result.count,
-                                message: "Successfully uploaded ".concat(result.count, " files in ").concat(result.batchCount, " batch(es)"),
+                                uploadedFiles: uploadedFiles,
+                                count: uploadedFiles.length,
+                                message: "Successfully uploaded ".concat(uploadedFiles.length, " files in ").concat(Math.ceil(files.length / 100), " batch(es)"),
                             }];
                 }
             });
@@ -720,20 +734,17 @@ var GT = /** @class */ (function (_super) {
      * re-running only stores new fonts.
      * @param {AssetUpload[]} fonts - Fonts to upload (`content` base64-encoded).
      * @param {UploadAssetsOptions} options - Optional settings (e.g. timeout).
-     * @returns {Promise<UploadAssetsResponse>} The stored/deduped assets.
+     * @returns {Promise<UploadAssetsResponse>} The stored assets.
      */
     GT.prototype.uploadFonts = function (fonts_1) {
         return __awaiter(this, arguments, void 0, function (fonts, options) {
-            var result;
             if (options === void 0) { options = {}; }
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        this._validateAuth('uploadFonts');
-                        return [4 /*yield*/, _uploadFonts(fonts, options, this._getTranslationConfig())];
-                    case 1:
-                        result = _a.sent();
-                        return [2 /*return*/, { assets: result.data, count: result.count }];
+                        validateAuth('uploadFonts', this._getTranslationConfig());
+                        return [4 /*yield*/, this._getApiAdapter().uploadFonts(fonts, options)];
+                    case 1: return [2 /*return*/, _a.sent()];
                 }
             });
         });
@@ -754,14 +765,14 @@ var GT = /** @class */ (function (_super) {
      */
     GT.prototype.uploadTranslations = function (files, options) {
         return __awaiter(this, void 0, void 0, function () {
-            var mergedOptions, error, targetFiles, result;
+            var mergedOptions, error, targetFiles, result, uploadedFiles;
             var _this = this;
             var _a;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
                         // Validation
-                        this._validateAuth('uploadTranslations');
+                        validateAuth('uploadTranslations', this._getTranslationConfig());
                         mergedOptions = __assign(__assign({}, options), { sourceLocale: (_a = options.sourceLocale) !== null && _a !== void 0 ? _a : this.sourceLocale });
                         // Require source locale
                         if (!mergedOptions.sourceLocale) {
@@ -771,13 +782,14 @@ var GT = /** @class */ (function (_super) {
                         }
                         mergedOptions.sourceLocale = this.resolveServiceLocale(mergedOptions.sourceLocale);
                         targetFiles = files.map(function (f) { return (__assign(__assign({}, f), { source: __assign(__assign({}, f.source), { locale: _this.resolveServiceLocale(f.source.locale) }), translations: f.translations.map(function (t) { return (__assign(__assign({}, t), { locale: _this.resolveServiceLocale(t.locale) })); }) })); });
-                        return [4 /*yield*/, _uploadTranslations(targetFiles, mergedOptions, this._getTranslationConfig())];
+                        return [4 /*yield*/, this._getApiAdapter().uploadTranslations(targetFiles, mergedOptions)];
                     case 1:
                         result = _b.sent();
+                        uploadedFiles = result.uploadedFiles;
                         return [2 /*return*/, {
-                                uploadedFiles: result.data,
-                                count: result.count,
-                                message: "Successfully uploaded ".concat(result.count, " files in ").concat(result.batchCount, " batch(es)"),
+                                uploadedFiles: uploadedFiles,
+                                count: uploadedFiles.length,
+                                message: "Successfully uploaded ".concat(uploadedFiles.length, " files in ").concat(Math.ceil(files.length / 100), " batch(es)"),
                             }];
                 }
             });