gt 2.19.0 → 2.20.0

package/dist/fs/fileContent.js

@@ -0,0 +1,171 @@
+import fs from "node:fs";
+import { isBinaryFileFormat } from "generaltranslation/types";
+//#region src/fs/fileContent.ts
+/**
+* Formats whose bytes on disk may carry an encoding other than UTF-8, so reads
+* decode by byte order mark and writes restore it. Older Xcode wrote both of
+* Apple's localization formats as UTF-16.
+*/
+const BYTE_ORDER_MARK_FORMATS = new Set(["DOT_STRINGS", "DOT_STRINGSDICT"]);
+/**
+* Ingress. Reads a file as the content the pipeline carries for its format:
+* base64 for binary formats, otherwise UTF-8 text decoded from whatever
+* encoding the file happens to be stored in.
+*
+* A file that cannot be read throws rather than reading as empty, which the
+* pipeline cannot tell apart from a file that is genuinely empty and would
+* upload as a deletion of every string in it.
+* @param {string} filePath - The path to the file to read.
+* @param {FileFormat} fileFormat - The format the file is configured as.
+* @returns {string} - The content.
+*/
+function readFileContent(filePath, fileFormat) {
+	if (isBinaryFileFormat(fileFormat)) return fs.readFileSync(filePath).toString("base64");
+	if (BYTE_ORDER_MARK_FORMATS.has(fileFormat)) return decodeFileText(fs.readFileSync(filePath)).text;
+	return fs.readFileSync(filePath, "utf8");
+}
+/**
+* Egress. Renders translated content for disk in the encoding `sourcePath` is
+* stored in, so a repository of UTF-16 files stays UTF-16 rather than showing
+* every one of them as rewritten.
+*
+* The source file is the record of that encoding, which is why it is re-read
+* here rather than carried from ingress: the download that writes this file is
+* usually a different process run from the upload that read it, so there is no
+* value to carry. Nothing has to be persisted in the lockfile or on the server.
+*
+* A source moved or deleted since it was uploaded leaves the translation
+* already on disk as the only remaining record, so `outputPath` is read next.
+* Defaulting straight to UTF-8 would rewrite every UTF-16 file and, for
+* `.stringsdict`, strand a UTF-16 XML declaration over unmarked UTF-8 bytes —
+* the one combination Foundation rejects.
+* @param {string} content - The translated content, as UTF-8 text.
+* @param {FileFormat} fileFormat - The format being written.
+* @param {string} sourcePath - The source file this translation came from.
+* @param {string} [outputPath] - Where the translation is about to be written.
+* @returns The value to hand to `writeFile`.
+*/
+function encodeFileContent(content, fileFormat, sourcePath, outputPath) {
+	if (!fileFormat || !BYTE_ORDER_MARK_FORMATS.has(fileFormat)) return content;
+	const encoding = readFileEncoding(sourcePath) ?? (outputPath ? readFileEncoding(outputPath) : void 0) ?? "utf8";
+	return encoding === "utf8" ? content : encodeFileText(content, encoding);
+}
+/**
+* Reads a file's byte order mark without reading the rest of it. Undefined
+* separates "no such file" from a file that is genuinely unmarked UTF-8.
+*/
+function readFileEncoding(filePath) {
+	if (!fs.existsSync(filePath) || !fs.statSync(filePath).isFile()) return;
+	const handle = fs.openSync(filePath, "r");
+	try {
+		const mark = Buffer.alloc(LONGEST_BYTE_ORDER_MARK);
+		const read = fs.readSync(handle, mark, 0, mark.length, 0);
+		return detectFileEncoding(mark.subarray(0, read));
+	} finally {
+		fs.closeSync(handle);
+	}
+}
+const BYTE_ORDER_MARKS = [
+	["utf32le", [
+		255,
+		254,
+		0,
+		0
+	]],
+	["utf32be", [
+		0,
+		0,
+		254,
+		255
+	]],
+	["utf16le", [255, 254]],
+	["utf16be", [254, 255]],
+	["utf8-bom", [
+		239,
+		187,
+		191
+	]]
+];
+const BYTE_ORDER_MARK_BY_ENCODING = new Map(BYTE_ORDER_MARKS.map(([encoding, mark]) => [encoding, Buffer.from(mark)]));
+/** Bytes that must be in hand before a byte order mark can be ruled out. */
+const LONGEST_BYTE_ORDER_MARK = Math.max(...BYTE_ORDER_MARKS.map(([, mark]) => mark.length));
+/** Reads the byte order mark, defaulting to UTF-8 when there is none. */
+function detectFileEncoding(bytes) {
+	for (const [encoding, mark] of BYTE_ORDER_MARKS) if (bytes.length >= mark.length && mark.every((b, i) => bytes[i] === b)) return encoding;
+	return "utf8";
+}
+/**
+* Decodes a `.strings` or `.stringsdict` file to text, dropping the byte order
+* mark. The encoding is returned so the writer can restore both on the way out.
+*/
+function decodeFileText(bytes) {
+	const encoding = detectFileEncoding(bytes);
+	const body = bytes.subarray(BYTE_ORDER_MARK_BY_ENCODING.get(encoding)?.length ?? 0);
+	switch (encoding) {
+		case "utf16le": return {
+			text: decodeUtf16(body, true),
+			encoding
+		};
+		case "utf16be": return {
+			text: decodeUtf16(body, false),
+			encoding
+		};
+		case "utf32le": return {
+			text: decodeUtf32(body, true),
+			encoding
+		};
+		case "utf32be": return {
+			text: decodeUtf32(body, false),
+			encoding
+		};
+		default: return {
+			text: body.toString("utf8"),
+			encoding
+		};
+	}
+}
+/** Re-encodes text into the given layout, byte order mark included. */
+function encodeFileText(text, encoding) {
+	const mark = BYTE_ORDER_MARK_BY_ENCODING.get(encoding);
+	const body = (() => {
+		switch (encoding) {
+			case "utf16le": return Buffer.from(text, "utf16le");
+			case "utf16be": return Buffer.from(text, "utf16le").swap16();
+			case "utf32le": return encodeUtf32(text, true);
+			case "utf32be": return encodeUtf32(text, false);
+			default: return Buffer.from(text, "utf8");
+		}
+	})();
+	return mark ? Buffer.concat([mark, body]) : body;
+}
+function decodeUtf16(body, littleEndian) {
+	if (body.length % 2 !== 0) throw new Error("it has a UTF-16 byte order mark but an odd number of bytes. Re-save it as UTF-8, or as complete UTF-16");
+	if (littleEndian) return body.toString("utf16le");
+	return Buffer.from(body).swap16().toString("utf16le");
+}
+const CODE_POINTS_PER_CALL = 4096;
+function decodeUtf32(body, littleEndian) {
+	if (body.length % 4 !== 0) throw new Error("it has a UTF-32 byte order mark but its length is not a multiple of four bytes. Re-save it as UTF-8, or as complete UTF-32");
+	const codePoints = Array.from({ length: body.length / 4 }, (_, i) => littleEndian ? body.readUInt32LE(i * 4) : body.readUInt32BE(i * 4));
+	let text = "";
+	for (let i = 0; i < codePoints.length; i += CODE_POINTS_PER_CALL) try {
+		text += String.fromCodePoint(...codePoints.slice(i, i + CODE_POINTS_PER_CALL));
+	} catch {
+		throw new Error("it has a UTF-32 byte order mark but contains a value that is not a Unicode code point");
+	}
+	return text;
+}
+function encodeUtf32(text, littleEndian) {
+	const characters = Array.from(text);
+	const body = Buffer.alloc(characters.length * 4);
+	characters.forEach((character, index) => {
+		const codePoint = character.codePointAt(0) ?? 0;
+		if (littleEndian) body.writeUInt32LE(codePoint, index * 4);
+		else body.writeUInt32BE(codePoint, index * 4);
+	});
+	return body;
+}
+//#endregion
+export { decodeFileText, detectFileEncoding, encodeFileContent, encodeFileText, readFileContent };
+
+//# sourceMappingURL=fileContent.js.map

package/dist/fs/fileContent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileContent.js","names":[],"sources":["../../src/fs/fileContent.ts"],"sourcesContent":["import fs from 'node:fs';\nimport { isBinaryFileFormat, type FileFormat } from 'generaltranslation/types';\n\n/**\n * How file content crosses the disk boundary.\n *\n * This is the only module in the CLI that knows a file may be stored in\n * something other than UTF-8. `readFileContent` is the single ingress point and\n * `encodeFileContent` the single egress point; in between, content is a UTF-8\n * string and nothing else has to reason about encodings.\n */\n\n/**\n * On-disk byte layouts Foundation accepts for `.strings` and `.stringsdict`.\n *\n * A byte order mark is the only signal. Foundation does not sniff UTF-16 from\n * interleaved NUL bytes, so an unmarked file is UTF-8 even when its bytes are\n * plainly UTF-16 — `plutil` rejects those files, and guessing would translate\n * content Foundation itself cannot read.\n */\nexport type FileEncoding =\n  | 'utf8'\n  | 'utf8-bom'\n  | 'utf16le'\n  | 'utf16be'\n  | 'utf32le'\n  | 'utf32be';\n\n/**\n * Formats whose bytes on disk may carry an encoding other than UTF-8, so reads\n * decode by byte order mark and writes restore it. Older Xcode wrote both of\n * Apple's localization formats as UTF-16.\n */\nconst BYTE_ORDER_MARK_FORMATS: ReadonlySet<FileFormat> = new Set<FileFormat>([\n  'DOT_STRINGS',\n  'DOT_STRINGSDICT',\n]);\n\n/**\n * Ingress. Reads a file as the content the pipeline carries for its format:\n * base64 for binary formats, otherwise UTF-8 text decoded from whatever\n * encoding the file happens to be stored in.\n *\n * A file that cannot be read throws rather than reading as empty, which the\n * pipeline cannot tell apart from a file that is genuinely empty and would\n * upload as a deletion of every string in it.\n * @param {string} filePath - The path to the file to read.\n * @param {FileFormat} fileFormat - The format the file is configured as.\n * @returns {string} - The content.\n */\nexport function readFileContent(\n  filePath: string,\n  fileFormat: FileFormat\n): string {\n  if (isBinaryFileFormat(fileFormat)) {\n    return fs.readFileSync(filePath).toString('base64');\n  }\n  if (BYTE_ORDER_MARK_FORMATS.has(fileFormat)) {\n    return decodeFileText(fs.readFileSync(filePath)).text;\n  }\n  return fs.readFileSync(filePath, 'utf8');\n}\n\n/**\n * Egress. Renders translated content for disk in the encoding `sourcePath` is\n * stored in, so a repository of UTF-16 files stays UTF-16 rather than showing\n * every one of them as rewritten.\n *\n * The source file is the record of that encoding, which is why it is re-read\n * here rather than carried from ingress: the download that writes this file is\n * usually a different process run from the upload that read it, so there is no\n * value to carry. Nothing has to be persisted in the lockfile or on the server.\n *\n * A source moved or deleted since it was uploaded leaves the translation\n * already on disk as the only remaining record, so `outputPath` is read next.\n * Defaulting straight to UTF-8 would rewrite every UTF-16 file and, for\n * `.stringsdict`, strand a UTF-16 XML declaration over unmarked UTF-8 bytes —\n * the one combination Foundation rejects.\n * @param {string} content - The translated content, as UTF-8 text.\n * @param {FileFormat} fileFormat - The format being written.\n * @param {string} sourcePath - The source file this translation came from.\n * @param {string} [outputPath] - Where the translation is about to be written.\n * @returns The value to hand to `writeFile`.\n */\nexport function encodeFileContent(\n  content: string,\n  fileFormat: FileFormat | undefined,\n  sourcePath: string,\n  outputPath?: string\n): string | Buffer {\n  if (!fileFormat || !BYTE_ORDER_MARK_FORMATS.has(fileFormat)) return content;\n  const encoding =\n    readFileEncoding(sourcePath) ??\n    (outputPath ? readFileEncoding(outputPath) : undefined) ??\n    'utf8';\n  return encoding === 'utf8' ? content : encodeFileText(content, encoding);\n}\n\n/**\n * Reads a file's byte order mark without reading the rest of it. Undefined\n * separates \"no such file\" from a file that is genuinely unmarked UTF-8.\n */\nfunction readFileEncoding(filePath: string): FileEncoding | undefined {\n  if (!fs.existsSync(filePath) || !fs.statSync(filePath).isFile()) {\n    return undefined;\n  }\n  const handle = fs.openSync(filePath, 'r');\n  try {\n    const mark = Buffer.alloc(LONGEST_BYTE_ORDER_MARK);\n    const read = fs.readSync(handle, mark, 0, mark.length, 0);\n    return detectFileEncoding(mark.subarray(0, read));\n  } finally {\n    fs.closeSync(handle);\n  }\n}\n\nconst BYTE_ORDER_MARKS = [\n  // UTF-32LE is checked before UTF-16LE because its mark begins with the same\n  // two bytes; the reverse order silently decodes UTF-32 as NUL-padded UTF-16.\n  ['utf32le', [0xff, 0xfe, 0x00, 0x00]],\n  ['utf32be', [0x00, 0x00, 0xfe, 0xff]],\n  ['utf16le', [0xff, 0xfe]],\n  ['utf16be', [0xfe, 0xff]],\n  ['utf8-bom', [0xef, 0xbb, 0xbf]],\n] as const satisfies ReadonlyArray<readonly [FileEncoding, number[]]>;\n\nconst BYTE_ORDER_MARK_BY_ENCODING = new Map<FileEncoding, Buffer>(\n  BYTE_ORDER_MARKS.map(([encoding, mark]) => [encoding, Buffer.from(mark)])\n);\n\n/** Bytes that must be in hand before a byte order mark can be ruled out. */\nconst LONGEST_BYTE_ORDER_MARK = Math.max(\n  ...BYTE_ORDER_MARKS.map(([, mark]) => mark.length)\n);\n\n/** Reads the byte order mark, defaulting to UTF-8 when there is none. */\nexport function detectFileEncoding(bytes: Buffer): FileEncoding {\n  for (const [encoding, mark] of BYTE_ORDER_MARKS) {\n    if (bytes.length >= mark.length && mark.every((b, i) => bytes[i] === b)) {\n      return encoding;\n    }\n  }\n  return 'utf8';\n}\n\n/**\n * Decodes a `.strings` or `.stringsdict` file to text, dropping the byte order\n * mark. The encoding is returned so the writer can restore both on the way out.\n */\nexport function decodeFileText(bytes: Buffer): {\n  text: string;\n  encoding: FileEncoding;\n} {\n  const encoding = detectFileEncoding(bytes);\n  const body = bytes.subarray(\n    BYTE_ORDER_MARK_BY_ENCODING.get(encoding)?.length ?? 0\n  );\n\n  switch (encoding) {\n    case 'utf16le':\n      return { text: decodeUtf16(body, true), encoding };\n    case 'utf16be':\n      return { text: decodeUtf16(body, false), encoding };\n    case 'utf32le':\n      return { text: decodeUtf32(body, true), encoding };\n    case 'utf32be':\n      return { text: decodeUtf32(body, false), encoding };\n    default:\n      return { text: body.toString('utf8'), encoding };\n  }\n}\n\n/** Re-encodes text into the given layout, byte order mark included. */\nexport function encodeFileText(text: string, encoding: FileEncoding): Buffer {\n  const mark = BYTE_ORDER_MARK_BY_ENCODING.get(encoding);\n  const body = (() => {\n    switch (encoding) {\n      case 'utf16le':\n        return Buffer.from(text, 'utf16le');\n      case 'utf16be':\n        return Buffer.from(text, 'utf16le').swap16();\n      case 'utf32le':\n        return encodeUtf32(text, true);\n      case 'utf32be':\n        return encodeUtf32(text, false);\n      default:\n        return Buffer.from(text, 'utf8');\n    }\n  })();\n  return mark ? Buffer.concat([mark, body]) : body;\n}\n\nfunction decodeUtf16(body: Buffer, littleEndian: boolean): string {\n  if (body.length % 2 !== 0) {\n    throw new Error(\n      'it has a UTF-16 byte order mark but an odd number of bytes. Re-save it as UTF-8, or as complete UTF-16'\n    );\n  }\n  if (littleEndian) return body.toString('utf16le');\n  // swap16 reorders in place, so copy rather than mutating the caller's bytes.\n  return Buffer.from(body).swap16().toString('utf16le');\n}\n\n// String.fromCodePoint takes code points as arguments, so a whole file spread\n// in one call can overflow the stack.\nconst CODE_POINTS_PER_CALL = 4096;\n\nfunction decodeUtf32(body: Buffer, littleEndian: boolean): string {\n  if (body.length % 4 !== 0) {\n    throw new Error(\n      'it has a UTF-32 byte order mark but its length is not a multiple of four bytes. Re-save it as UTF-8, or as complete UTF-32'\n    );\n  }\n  const codePoints = Array.from({ length: body.length / 4 }, (_, i) =>\n    littleEndian ? body.readUInt32LE(i * 4) : body.readUInt32BE(i * 4)\n  );\n  let text = '';\n  for (let i = 0; i < codePoints.length; i += CODE_POINTS_PER_CALL) {\n    try {\n      text += String.fromCodePoint(\n        ...codePoints.slice(i, i + CODE_POINTS_PER_CALL)\n      );\n    } catch {\n      throw new Error(\n        'it has a UTF-32 byte order mark but contains a value that is not a Unicode code point'\n      );\n    }\n  }\n  return text;\n}\n\nfunction encodeUtf32(text: string, littleEndian: boolean): Buffer {\n  // Iterating a string yields whole code points, so surrogate pairs stay intact.\n  const characters = Array.from(text);\n  const body = Buffer.alloc(characters.length * 4);\n  characters.forEach((character, index) => {\n    const codePoint = character.codePointAt(0) ?? 0;\n    if (littleEndian) body.writeUInt32LE(codePoint, index * 4);\n    else body.writeUInt32BE(codePoint, index * 4);\n  });\n  return body;\n}\n"],"mappings":";;;;;;;;AAiCA,MAAM,0BAAmD,IAAI,IAAgB,CAC3E,eACA,kBACD,CAAC;;;;;;;;;;;;;AAcF,SAAgB,gBACd,UACA,YACQ;AACR,KAAI,mBAAmB,WAAW,CAChC,QAAO,GAAG,aAAa,SAAS,CAAC,SAAS,SAAS;AAErD,KAAI,wBAAwB,IAAI,WAAW,CACzC,QAAO,eAAe,GAAG,aAAa,SAAS,CAAC,CAAC;AAEnD,QAAO,GAAG,aAAa,UAAU,OAAO;;;;;;;;;;;;;;;;;;;;;;;AAwB1C,SAAgB,kBACd,SACA,YACA,YACA,YACiB;AACjB,KAAI,CAAC,cAAc,CAAC,wBAAwB,IAAI,WAAW,CAAE,QAAO;CACpE,MAAM,WACJ,iBAAiB,WAAW,KAC3B,aAAa,iBAAiB,WAAW,GAAG,KAAA,MAC7C;AACF,QAAO,aAAa,SAAS,UAAU,eAAe,SAAS,SAAS;;;;;;AAO1E,SAAS,iBAAiB,UAA4C;AACpE,KAAI,CAAC,GAAG,WAAW,SAAS,IAAI,CAAC,GAAG,SAAS,SAAS,CAAC,QAAQ,CAC7D;CAEF,MAAM,SAAS,GAAG,SAAS,UAAU,IAAI;AACzC,KAAI;EACF,MAAM,OAAO,OAAO,MAAM,wBAAwB;EAClD,MAAM,OAAO,GAAG,SAAS,QAAQ,MAAM,GAAG,KAAK,QAAQ,EAAE;AACzD,SAAO,mBAAmB,KAAK,SAAS,GAAG,KAAK,CAAC;WACzC;AACR,KAAG,UAAU,OAAO;;;AAIxB,MAAM,mBAAmB;CAGvB,CAAC,WAAW;EAAC;EAAM;EAAM;EAAM;EAAK,CAAC;CACrC,CAAC,WAAW;EAAC;EAAM;EAAM;EAAM;EAAK,CAAC;CACrC,CAAC,WAAW,CAAC,KAAM,IAAK,CAAC;CACzB,CAAC,WAAW,CAAC,KAAM,IAAK,CAAC;CACzB,CAAC,YAAY;EAAC;EAAM;EAAM;EAAK,CAAC;CACjC;AAED,MAAM,8BAA8B,IAAI,IACtC,iBAAiB,KAAK,CAAC,UAAU,UAAU,CAAC,UAAU,OAAO,KAAK,KAAK,CAAC,CAAC,CAC1E;;AAGD,MAAM,0BAA0B,KAAK,IACnC,GAAG,iBAAiB,KAAK,GAAG,UAAU,KAAK,OAAO,CACnD;;AAGD,SAAgB,mBAAmB,OAA6B;AAC9D,MAAK,MAAM,CAAC,UAAU,SAAS,iBAC7B,KAAI,MAAM,UAAU,KAAK,UAAU,KAAK,OAAO,GAAG,MAAM,MAAM,OAAO,EAAE,CACrE,QAAO;AAGX,QAAO;;;;;;AAOT,SAAgB,eAAe,OAG7B;CACA,MAAM,WAAW,mBAAmB,MAAM;CAC1C,MAAM,OAAO,MAAM,SACjB,4BAA4B,IAAI,SAAS,EAAE,UAAU,EACtD;AAED,SAAQ,UAAR;EACE,KAAK,UACH,QAAO;GAAE,MAAM,YAAY,MAAM,KAAK;GAAE;GAAU;EACpD,KAAK,UACH,QAAO;GAAE,MAAM,YAAY,MAAM,MAAM;GAAE;GAAU;EACrD,KAAK,UACH,QAAO;GAAE,MAAM,YAAY,MAAM,KAAK;GAAE;GAAU;EACpD,KAAK,UACH,QAAO;GAAE,MAAM,YAAY,MAAM,MAAM;GAAE;GAAU;EACrD,QACE,QAAO;GAAE,MAAM,KAAK,SAAS,OAAO;GAAE;GAAU;;;;AAKtD,SAAgB,eAAe,MAAc,UAAgC;CAC3E,MAAM,OAAO,4BAA4B,IAAI,SAAS;CACtD,MAAM,cAAc;AAClB,UAAQ,UAAR;GACE,KAAK,UACH,QAAO,OAAO,KAAK,MAAM,UAAU;GACrC,KAAK,UACH,QAAO,OAAO,KAAK,MAAM,UAAU,CAAC,QAAQ;GAC9C,KAAK,UACH,QAAO,YAAY,MAAM,KAAK;GAChC,KAAK,UACH,QAAO,YAAY,MAAM,MAAM;GACjC,QACE,QAAO,OAAO,KAAK,MAAM,OAAO;;KAElC;AACJ,QAAO,OAAO,OAAO,OAAO,CAAC,MAAM,KAAK,CAAC,GAAG;;AAG9C,SAAS,YAAY,MAAc,cAA+B;AAChE,KAAI,KAAK,SAAS,MAAM,EACtB,OAAM,IAAI,MACR,yGACD;AAEH,KAAI,aAAc,QAAO,KAAK,SAAS,UAAU;AAEjD,QAAO,OAAO,KAAK,KAAK,CAAC,QAAQ,CAAC,SAAS,UAAU;;AAKvD,MAAM,uBAAuB;AAE7B,SAAS,YAAY,MAAc,cAA+B;AAChE,KAAI,KAAK,SAAS,MAAM,EACtB,OAAM,IAAI,MACR,6HACD;CAEH,MAAM,aAAa,MAAM,KAAK,EAAE,QAAQ,KAAK,SAAS,GAAG,GAAG,GAAG,MAC7D,eAAe,KAAK,aAAa,IAAI,EAAE,GAAG,KAAK,aAAa,IAAI,EAAE,CACnE;CACD,IAAI,OAAO;AACX,MAAK,IAAI,IAAI,GAAG,IAAI,WAAW,QAAQ,KAAK,qBAC1C,KAAI;AACF,UAAQ,OAAO,cACb,GAAG,WAAW,MAAM,GAAG,IAAI,qBAAqB,CACjD;SACK;AACN,QAAM,IAAI,MACR,wFACD;;AAGL,QAAO;;AAGT,SAAS,YAAY,MAAc,cAA+B;CAEhE,MAAM,aAAa,MAAM,KAAK,KAAK;CACnC,MAAM,OAAO,OAAO,MAAM,WAAW,SAAS,EAAE;AAChD,YAAW,SAAS,WAAW,UAAU;EACvC,MAAM,YAAY,UAAU,YAAY,EAAE,IAAI;AAC9C,MAAI,aAAc,MAAK,cAAc,WAAW,QAAQ,EAAE;MACrD,MAAK,cAAc,WAAW,QAAQ,EAAE;GAC7C;AACF,QAAO"}

package/dist/generated/version.d.ts

@@ -1 +1 @@
-export declare const PACKAGE_VERSION = "2.19.0";
+export declare const PACKAGE_VERSION = "2.20.0";

package/dist/generated/version.js

@@ -1,5 +1,5 @@
 //#region src/generated/version.ts
-const PACKAGE_VERSION = "2.19.0";
+const PACKAGE_VERSION = "2.20.0";
 //#endregion
 export { PACKAGE_VERSION };
 

package/dist/generated/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","names":[],"sources":["../../src/generated/version.ts"],"sourcesContent":["// This file is auto-generated. Do not edit manually.\nexport const PACKAGE_VERSION = '2.19.0';\n"],"mappings":";AACA,MAAa,kBAAkB"}
+{"version":3,"file":"version.js","names":[],"sources":["../../src/generated/version.ts"],"sourcesContent":["// This file is auto-generated. Do not edit manually.\nexport const PACKAGE_VERSION = '2.20.0';\n"],"mappings":";AACA,MAAa,kBAAkB"}

package/dist/state/recentDownloads.d.ts

@@ -1,8 +1,10 @@
-type DownloadMeta = {
+import type { FileFormat } from 'generaltranslation/types';
+export type DownloadMeta = {
     branchId: string;
     fileId: string;
     versionId: string;
     locale: string;
+    fileFormat: FileFormat;
     inputPath?: string;
 };
 export declare function recordDownloaded(filePath: string, meta?: DownloadMeta): void;
@@ -16,4 +18,3 @@ export declare function getDownloaded(): Set<string>;
 export declare function getNeedsPostprocessing(): Set<string>;
 export declare function getDownloadedMeta(): Map<string, DownloadMeta>;
 export declare function clearDownloaded(): void;
-export {};

package/dist/state/recentDownloads.js.map

@@ -1 +1 @@
-{"version":3,"file":"recentDownloads.js","names":[],"sources":["../../src/state/recentDownloads.ts"],"sourcesContent":["type DownloadMeta = {\n  branchId: string;\n  fileId: string;\n  versionId: string;\n  locale: string;\n  inputPath?: string;\n};\n\nconst recent = new Set<string>();\nconst recentMeta = new Map<string, DownloadMeta>();\nconst remerged = new Set<string>();\n\nexport function recordDownloaded(filePath: string, meta?: DownloadMeta) {\n  recent.add(filePath);\n  if (meta) {\n    recentMeta.set(filePath, meta);\n  }\n}\n\n/**\n * Track a file that was re-merged with the source\n * so that postprocessing still runs on it.\n */\nexport function recordRemerged(filePath: string) {\n  remerged.add(filePath);\n}\n\nexport function getDownloaded(): Set<string> {\n  return recent;\n}\n\n/** Files that need postprocessing: downloaded OR re-merged */\nexport function getNeedsPostprocessing(): Set<string> {\n  return new Set([...recent, ...remerged]);\n}\n\nexport function getDownloadedMeta(): Map<string, DownloadMeta> {\n  return recentMeta;\n}\n\nexport function clearDownloaded() {\n  recent.clear();\n  recentMeta.clear();\n  remerged.clear();\n}\n"],"mappings":";AAQA,MAAM,yBAAS,IAAI,KAAa;AAChC,MAAM,6BAAa,IAAI,KAA2B;AAClD,MAAM,2BAAW,IAAI,KAAa;AAElC,SAAgB,iBAAiB,UAAkB,MAAqB;AACtE,QAAO,IAAI,SAAS;AACpB,KAAI,KACF,YAAW,IAAI,UAAU,KAAK;;;;;;AAQlC,SAAgB,eAAe,UAAkB;AAC/C,UAAS,IAAI,SAAS;;AAGxB,SAAgB,gBAA6B;AAC3C,QAAO;;;AAIT,SAAgB,yBAAsC;AACpD,QAAO,IAAI,IAAI,CAAC,GAAG,QAAQ,GAAG,SAAS,CAAC;;AAG1C,SAAgB,oBAA+C;AAC7D,QAAO;;AAGT,SAAgB,kBAAkB;AAChC,QAAO,OAAO;AACd,YAAW,OAAO;AAClB,UAAS,OAAO"}
+{"version":3,"file":"recentDownloads.js","names":[],"sources":["../../src/state/recentDownloads.ts"],"sourcesContent":["import type { FileFormat } from 'generaltranslation/types';\n\nexport type DownloadMeta = {\n  branchId: string;\n  fileId: string;\n  versionId: string;\n  locale: string;\n  // The format the file was written as, so it can be read back the same way.\n  fileFormat: FileFormat;\n  inputPath?: string;\n};\n\nconst recent = new Set<string>();\nconst recentMeta = new Map<string, DownloadMeta>();\nconst remerged = new Set<string>();\n\nexport function recordDownloaded(filePath: string, meta?: DownloadMeta) {\n  recent.add(filePath);\n  if (meta) {\n    recentMeta.set(filePath, meta);\n  }\n}\n\n/**\n * Track a file that was re-merged with the source\n * so that postprocessing still runs on it.\n */\nexport function recordRemerged(filePath: string) {\n  remerged.add(filePath);\n}\n\nexport function getDownloaded(): Set<string> {\n  return recent;\n}\n\n/** Files that need postprocessing: downloaded OR re-merged */\nexport function getNeedsPostprocessing(): Set<string> {\n  return new Set([...recent, ...remerged]);\n}\n\nexport function getDownloadedMeta(): Map<string, DownloadMeta> {\n  return recentMeta;\n}\n\nexport function clearDownloaded() {\n  recent.clear();\n  recentMeta.clear();\n  remerged.clear();\n}\n"],"mappings":";AAYA,MAAM,yBAAS,IAAI,KAAa;AAChC,MAAM,6BAAa,IAAI,KAA2B;AAClD,MAAM,2BAAW,IAAI,KAAa;AAElC,SAAgB,iBAAiB,UAAkB,MAAqB;AACtE,QAAO,IAAI,SAAS;AACpB,KAAI,KACF,YAAW,IAAI,UAAU,KAAK;;;;;;AAQlC,SAAgB,eAAe,UAAkB;AAC/C,UAAS,IAAI,SAAS;;AAGxB,SAAgB,gBAA6B;AAC3C,QAAO;;;AAIT,SAAgB,yBAAsC;AACpD,QAAO,IAAI,IAAI,CAAC,GAAG,QAAQ,GAAG,SAAS,CAAC;;AAG1C,SAAgB,oBAA+C;AAC7D,QAAO;;AAGT,SAAgB,kBAAkB;AAChC,QAAO,OAAO;AACd,YAAW,OAAO;AAClB,UAAS,OAAO"}

package/dist/translation/reviewSetupWarning.js

@@ -1,5 +1,5 @@
 import { logger } from "../console/logger.js";
-import { gt } from "../utils/gt.js";
+import { api } from "../utils/api.js";
 import chalk from "chalk";
 import path from "node:path";
 //#region src/translation/reviewSetupWarning.ts
@@ -20,12 +20,12 @@ const PROJECT_INFO_TIMEOUT_MS = 1e4;
 async function warnManualReviewSetup(settings, files) {
 	const requiresReviewPaths = settings.files?.requiresReviewPaths;
 	if (!files.some((file) => {
-		if (file.fileFormat === "GTJSON") return Object.values(file.formatMetadata ?? {}).some((metadata) => metadata?.requires_review === true);
+		if (file.fileFormat === "GTJSON") return Object.values(file.formatMetadata ?? {}).some((metadata) => typeof metadata === "object" && metadata !== null && "requires_review" in metadata && metadata.requires_review === true);
 		return requiresReviewPaths?.has(path.resolve(process.cwd(), file.fileName));
 	})) return;
 	let autoApprove;
 	try {
-		autoApprove = (await gt.getProjectInfo({ timeout: PROJECT_INFO_TIMEOUT_MS })).autoApprove;
+		autoApprove = (await api.getProjectInfo(PROJECT_INFO_TIMEOUT_MS)).autoApprove;
 	} catch {}
 	if (autoApprove === false) return;
 	const settingsUrl = settings.projectId ? `${settings.dashboardUrl}/project/${settings.projectId}/settings` : settings.dashboardUrl;

package/dist/translation/reviewSetupWarning.js.map

@@ -1 +1 @@
-{"version":3,"file":"reviewSetupWarning.js","names":[],"sources":["../../src/translation/reviewSetupWarning.ts"],"sourcesContent":["import path from 'node:path';\nimport chalk from 'chalk';\nimport type { FileToUpload } from 'generaltranslation/types';\nimport { logger } from '../console/logger.js';\nimport { gt } from '../utils/gt.js';\nimport { Settings } from '../types/index.js';\n\nconst PROJECT_INFO_TIMEOUT_MS = 10_000;\n\n/**\n * Warns when an upload contains review-gated content but the project\n * auto-approves new translations, pointing the user at the dashboard project\n * settings page. The CLI cannot change the auto-approve setting itself —\n * review setup happens in the dashboard.\n *\n * The project's auto-approve setting is fetched lazily (only when the upload\n * actually contains review-gated content):\n * - false: manual review is already the project workflow — no warning\n * - true: requiresReview config has no gating effect — warn\n * - unavailable (older API, dry runs without credentials): warn with\n *   conditional wording, since auto-approve is the platform default\n */\nexport async function warnManualReviewSetup(\n  settings: Settings,\n  files: FileToUpload[]\n): Promise<void> {\n  const requiresReviewPaths = settings.files?.requiresReviewPaths;\n\n  const hasReviewGatedFile = files.some((file) => {\n    if (file.fileFormat === 'GTJSON') {\n      // Uploaded GTJSON metadata carries the platform's snake_case key\n      return Object.values(file.formatMetadata ?? {}).some(\n        (metadata) =>\n          (metadata as { requires_review?: boolean })?.requires_review === true\n      );\n    }\n    return requiresReviewPaths?.has(path.resolve(process.cwd(), file.fileName));\n  });\n  if (!hasReviewGatedFile) return;\n\n  let autoApprove: boolean | undefined;\n  try {\n    autoApprove = (\n      await gt.getProjectInfo({ timeout: PROJECT_INFO_TIMEOUT_MS })\n    ).autoApprove;\n  } catch {\n    // Setting unavailable — fall through to the conditional wording\n  }\n  if (autoApprove === false) return;\n\n  const settingsUrl = settings.projectId\n    ? `${settings.dashboardUrl}/project/${settings.projectId}/settings`\n    : settings.dashboardUrl;\n  const autoApproveClause =\n    autoApprove === true\n      ? 'but this project approves new translations automatically.'\n      : 'but new translations are approved automatically unless auto-approval is turned off for this project.';\n  // \"Auto approve translations\" matches the dashboard setting title exactly.\n  const message =\n    `Some of your content requires review (requiresReview), ${autoApproveClause} ` +\n    `To review translations before they are used, disable \"Auto approve translations\" in your project settings:`;\n  logger.warn(\n    chalk.yellow(\n      [...wrapWords(message, 70), chalk.cyan(settingsUrl)].join('\\n')\n    )\n  );\n}\n\n/**\n * Greedy word wrap so warning lines render at a consistent width instead of\n * one terminal-width line followed by stubby fragments.\n */\nfunction wrapWords(text: string, width: number): string[] {\n  const lines: string[] = [];\n  let line = '';\n  for (const word of text.split(' ')) {\n    if (line && line.length + 1 + word.length > width) {\n      lines.push(line);\n      line = word;\n    } else {\n      line = line ? `${line} ${word}` : word;\n    }\n  }\n  if (line) lines.push(line);\n  return lines;\n}\n"],"mappings":";;;;;AAOA,MAAM,0BAA0B;;;;;;;;;;;;;;AAehC,eAAsB,sBACpB,UACA,OACe;CACf,MAAM,sBAAsB,SAAS,OAAO;AAY5C,KAAI,CAVuB,MAAM,MAAM,SAAS;AAC9C,MAAI,KAAK,eAAe,SAEtB,QAAO,OAAO,OAAO,KAAK,kBAAkB,EAAE,CAAC,CAAC,MAC7C,aACE,UAA4C,oBAAoB,KACpE;AAEH,SAAO,qBAAqB,IAAI,KAAK,QAAQ,QAAQ,KAAK,EAAE,KAAK,SAAS,CAAC;GAEtD,CAAE;CAEzB,IAAI;AACJ,KAAI;AACF,iBACE,MAAM,GAAG,eAAe,EAAE,SAAS,yBAAyB,CAAC,EAC7D;SACI;AAGR,KAAI,gBAAgB,MAAO;CAE3B,MAAM,cAAc,SAAS,YACzB,GAAG,SAAS,aAAa,WAAW,SAAS,UAAU,aACvD,SAAS;CAMb,MAAM,UACJ,0DALA,gBAAgB,OACZ,8DACA,uGAGwE;AAE9E,QAAO,KACL,MAAM,OACJ,CAAC,GAAG,UAAU,SAAS,GAAG,EAAE,MAAM,KAAK,YAAY,CAAC,CAAC,KAAK,KAAK,CAChE,CACF;;;;;;AAOH,SAAS,UAAU,MAAc,OAAyB;CACxD,MAAM,QAAkB,EAAE;CAC1B,IAAI,OAAO;AACX,MAAK,MAAM,QAAQ,KAAK,MAAM,IAAI,CAChC,KAAI,QAAQ,KAAK,SAAS,IAAI,KAAK,SAAS,OAAO;AACjD,QAAM,KAAK,KAAK;AAChB,SAAO;OAEP,QAAO,OAAO,GAAG,KAAK,GAAG,SAAS;AAGtC,KAAI,KAAM,OAAM,KAAK,KAAK;AAC1B,QAAO"}
+{"version":3,"file":"reviewSetupWarning.js","names":[],"sources":["../../src/translation/reviewSetupWarning.ts"],"sourcesContent":["import path from 'node:path';\nimport chalk from 'chalk';\nimport type { FileToUpload } from 'generaltranslation/types';\nimport { logger } from '../console/logger.js';\nimport { api } from '../utils/api.js';\nimport { Settings } from '../types/index.js';\n\nconst PROJECT_INFO_TIMEOUT_MS = 10_000;\n\n/**\n * Warns when an upload contains review-gated content but the project\n * auto-approves new translations, pointing the user at the dashboard project\n * settings page. The CLI cannot change the auto-approve setting itself —\n * review setup happens in the dashboard.\n *\n * The project's auto-approve setting is fetched lazily (only when the upload\n * actually contains review-gated content):\n * - false: manual review is already the project workflow — no warning\n * - true: requiresReview config has no gating effect — warn\n * - unavailable (older API, dry runs without credentials): warn with\n *   conditional wording, since auto-approve is the platform default\n */\nexport async function warnManualReviewSetup(\n  settings: Settings,\n  files: FileToUpload[]\n): Promise<void> {\n  const requiresReviewPaths = settings.files?.requiresReviewPaths;\n\n  const hasReviewGatedFile = files.some((file) => {\n    if (file.fileFormat === 'GTJSON') {\n      // Uploaded GTJSON metadata carries the platform's snake_case key\n      return Object.values(file.formatMetadata ?? {}).some(\n        (metadata) =>\n          typeof metadata === 'object' &&\n          metadata !== null &&\n          'requires_review' in metadata &&\n          metadata.requires_review === true\n      );\n    }\n    return requiresReviewPaths?.has(path.resolve(process.cwd(), file.fileName));\n  });\n  if (!hasReviewGatedFile) return;\n\n  let autoApprove: boolean | undefined;\n  try {\n    autoApprove = (await api.getProjectInfo(PROJECT_INFO_TIMEOUT_MS))\n      .autoApprove;\n  } catch {\n    // Setting unavailable — fall through to the conditional wording\n  }\n  if (autoApprove === false) return;\n\n  const settingsUrl = settings.projectId\n    ? `${settings.dashboardUrl}/project/${settings.projectId}/settings`\n    : settings.dashboardUrl;\n  const autoApproveClause =\n    autoApprove === true\n      ? 'but this project approves new translations automatically.'\n      : 'but new translations are approved automatically unless auto-approval is turned off for this project.';\n  // \"Auto approve translations\" matches the dashboard setting title exactly.\n  const message =\n    `Some of your content requires review (requiresReview), ${autoApproveClause} ` +\n    `To review translations before they are used, disable \"Auto approve translations\" in your project settings:`;\n  logger.warn(\n    chalk.yellow(\n      [...wrapWords(message, 70), chalk.cyan(settingsUrl)].join('\\n')\n    )\n  );\n}\n\n/**\n * Greedy word wrap so warning lines render at a consistent width instead of\n * one terminal-width line followed by stubby fragments.\n */\nfunction wrapWords(text: string, width: number): string[] {\n  const lines: string[] = [];\n  let line = '';\n  for (const word of text.split(' ')) {\n    if (line && line.length + 1 + word.length > width) {\n      lines.push(line);\n      line = word;\n    } else {\n      line = line ? `${line} ${word}` : word;\n    }\n  }\n  if (line) lines.push(line);\n  return lines;\n}\n"],"mappings":";;;;;AAOA,MAAM,0BAA0B;;;;;;;;;;;;;;AAehC,eAAsB,sBACpB,UACA,OACe;CACf,MAAM,sBAAsB,SAAS,OAAO;AAe5C,KAAI,CAbuB,MAAM,MAAM,SAAS;AAC9C,MAAI,KAAK,eAAe,SAEtB,QAAO,OAAO,OAAO,KAAK,kBAAkB,EAAE,CAAC,CAAC,MAC7C,aACC,OAAO,aAAa,YACpB,aAAa,QACb,qBAAqB,YACrB,SAAS,oBAAoB,KAChC;AAEH,SAAO,qBAAqB,IAAI,KAAK,QAAQ,QAAQ,KAAK,EAAE,KAAK,SAAS,CAAC;GAEtD,CAAE;CAEzB,IAAI;AACJ,KAAI;AACF,iBAAe,MAAM,IAAI,eAAe,wBAAwB,EAC7D;SACG;AAGR,KAAI,gBAAgB,MAAO;CAE3B,MAAM,cAAc,SAAS,YACzB,GAAG,SAAS,aAAa,WAAW,SAAS,UAAU,aACvD,SAAS;CAMb,MAAM,UACJ,0DALA,gBAAgB,OACZ,8DACA,uGAGwE;AAE9E,QAAO,KACL,MAAM,OACJ,CAAC,GAAG,UAAU,SAAS,GAAG,EAAE,MAAM,KAAK,YAAY,CAAC,CAAC,KAAK,KAAK,CAChE,CACF;;;;;;AAOH,SAAS,UAAU,MAAc,OAAyB;CACxD,MAAM,QAAkB,EAAE;CAC1B,IAAI,OAAO;AACX,MAAK,MAAM,QAAQ,KAAK,MAAM,IAAI,CAChC,KAAI,QAAQ,KAAK,SAAS,IAAI,KAAK,SAAS,OAAO;AACjD,QAAM,KAAK,KAAK;AAChB,SAAO;OAEP,QAAO,OAAO,GAAG,KAAK,GAAG,SAAS;AAGtC,KAAI,KAAM,OAAM,KAAK,KAAK;AAC1B,QAAO"}

package/dist/utils/api.d.ts

@@ -0,0 +1,194 @@
+import type { CustomMapping } from '@generaltranslation/format/types';
+import { type ApiClientConfig, type AwaitJobsOptions, type CreateBranchData, type CreateProjectData, type CreateTagData, type DownloadFilesData, type EnqueueFileTranslationsData, type GenerateProjectContextData, type GetBranchInfoData, type GetFileInfoData, type ProcessFileMovesData, type PublishFilesData, type SubmitUserEditDiffsData, type UploadSourceFilesData, type UploadTranslationsData } from 'generaltranslation/api';
+export declare function configureApiClient(config: ApiClientConfig & {
+    customMapping?: CustomMapping;
+}): void;
+export declare const api: {
+    queryBranchData(body: GetBranchInfoData["body"]): Promise<{
+        branches: Array<import("@generaltranslation/api").Branch>;
+        defaultBranch: import("@generaltranslation/api").Branch & ({
+            [key: string]: unknown;
+        } | null);
+    }>;
+    createBranch(body: CreateBranchData["body"]): Promise<{
+        branch: import("@generaltranslation/api").Branch;
+    }>;
+    queryFileData(body: GetFileInfoData["body"]): Promise<{
+        translatedFiles: {
+            locale: string;
+            branchId: string;
+            fileId: string;
+            versionId: string;
+            fileFormat: import("@generaltranslation/api").FileFormat;
+            dataFormat: string | null;
+            createdAt: string;
+            updatedAt: string;
+            approvedAt: string | null;
+            publishedAt: string | null;
+            completedAt: string | null;
+        }[];
+        sourceFiles: {
+            sourceLocale: string;
+            locales: string[];
+            branchId: string;
+            fileId: string;
+            versionId: string;
+            fileName: string;
+            fileFormat: import("@generaltranslation/api").FileFormat;
+            dataFormat: string | null;
+            createdAt: string;
+            updatedAt: string;
+            publishedAt: string | null;
+        }[];
+    }>;
+    checkJobStatus(jobIds: string[]): Promise<({
+        status: "queued";
+        jobId: string;
+    } | {
+        status: "processing";
+        jobId: string;
+    } | {
+        status: "failed";
+        jobId: string;
+        error: {
+            message: string | null;
+        };
+    } | {
+        status: "completed";
+        jobId: string;
+    } | {
+        status: "unknown";
+        jobId: string;
+    })[]>;
+    getProjectInfo(timeoutMs: number): Promise<{
+        id: string;
+        name: string;
+        orgId: string;
+        defaultLocale: string | null;
+        currentLocales: Array<string>;
+        autoApprove: boolean;
+    }>;
+    resolveAliasLocale(locale: string): string;
+    downloadFileBatch(files: DownloadFilesData["body"]): Promise<{
+        files: {
+            data: string;
+            locale?: string;
+            id: string;
+            branchId: string;
+            fileId: string;
+            versionId: string;
+            fileName?: string;
+            metadata: import("@generaltranslation/api").JsonObject;
+            fileFormat: import("@generaltranslation/api").FileFormat;
+        }[];
+        count: number;
+        pending: {
+            branchId: string;
+            fileId: string;
+            locale: string;
+            versionId: string;
+        }[];
+    }>;
+    publishFiles(files: PublishFilesData["body"]["files"]): Promise<{
+        results: Array<{
+            fileId: string;
+            versionId: string;
+            locale?: string;
+            branchId: string;
+            success: boolean;
+            error?: string;
+        }>;
+    }>;
+    submitUserEditDiffs(body: SubmitUserEditDiffsData["body"]): Promise<{
+        filesProcessed: number;
+        entriesReceived: number;
+        message: string;
+    }[]>;
+    createTag(body: CreateTagData["body"]): Promise<{
+        tag: {
+            id: string;
+            tagId: string;
+            message: string | null;
+            createdAt: string;
+            updatedAt: string;
+        };
+    }>;
+    createProject(body: CreateProjectData["body"]): Promise<{
+        project: {
+            id: string;
+            name: string;
+            orgId: string;
+            defaultLocale: string;
+        };
+    }>;
+    getOrphanedFiles(branchId: string, fileIds: string[]): Promise<{
+        orphanedFiles: Array<{
+            fileId: string;
+            versionId: string;
+            fileName: string;
+        }>;
+    }>;
+    processFileMoves(moves: ProcessFileMovesData["body"]["moves"], options: Pick<ProcessFileMovesData["body"], "branchId">): Promise<{
+        results: {
+            oldFileId: string;
+            newFileId: string;
+            success: boolean;
+            newSourceFileId?: string;
+            clonedTranslationsCount?: number;
+            error?: string;
+        }[];
+        summary: {
+            total: number;
+            succeeded: number;
+            failed: number;
+        };
+    }>;
+    setupProject(files: GenerateProjectContextData["body"]["files"], options?: Omit<GenerateProjectContextData["body"], "files">): Promise<{
+        status: "completed";
+    } | {
+        setupJobId: string;
+        status: "queued";
+    }>;
+    awaitJobs(jobIds: readonly string[], options?: AwaitJobsOptions): Promise<import("@generaltranslation/api").AwaitJobsResult>;
+    enqueueFiles(files: EnqueueFileTranslationsData["body"]["files"], options: {
+        sourceLocale?: string;
+        targetLocales: string[];
+        modelProvider?: string;
+        force?: boolean;
+    }): Promise<{
+        jobData: {
+            [k: string]: any;
+        };
+        locales: string[];
+        message: string;
+    }>;
+    uploadSourceFiles(files: Array<{
+        source: UploadSourceFilesData["body"]["data"][number]["source"];
+    }>, options: {
+        sourceLocale: string;
+    }): Promise<{
+        uploadedFiles: {
+            branchId?: string;
+            fileId: string;
+            versionId: string;
+            fileName: string;
+            fileFormat: import("@generaltranslation/api").FileFormat;
+            dataFormat?: string;
+            locale?: string;
+        }[];
+    }>;
+    uploadTranslations(files: UploadTranslationsData["body"]["data"], options: {
+        sourceLocale: string;
+    }): Promise<{
+        uploadedFiles: {
+            branchId?: string;
+            fileId: string;
+            versionId: string;
+            fileName: string;
+            fileFormat: import("@generaltranslation/api").FileFormat;
+            dataFormat?: string;
+            locale?: string;
+        }[];
+    }>;
+};
+export type ApiClient = typeof api;