generaltranslation 8.2.18 → 8.2.19

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # generaltranslation
 
+## 8.2.19
+
+### Patch Changes
+
+- [#1786](https://github.com/generaltranslation/gt/pull/1786) [`6945a98`](https://github.com/generaltranslation/gt/commit/6945a9871ea260dd999dcb2246c48b21134721f6) Thanks [@fernando-aviles](https://github.com/fernando-aviles)! - Add `requiresReview`
+
 ## 8.2.18
 
 ### Patch Changes

package/dist/id/hashSource.d.ts

@@ -20,6 +20,6 @@ export declare function hashString(string: string): string;
  * @param {function} [hashFunction] - Custom hash function.
  * @returns {string} - The unique hash of the children.
  */
-export declare function hashSource({ source, context, id, maxChars, dataFormat, }: {
+export declare function hashSource({ source, context, id, maxChars, requiresReview, dataFormat, }: {
     source: JsxChildren | string;
 } & HashMetadata, hashFunction?: (string: string) => string): string;

package/dist/id/hashSource.js

@@ -38,7 +38,7 @@ export function hashString(string) {
  * @returns {string} - The unique hash of the children.
  */
 export function hashSource(_a, hashFunction) {
-    var source = _a.source, context = _a.context, id = _a.id, maxChars = _a.maxChars, dataFormat = _a.dataFormat;
+    var source = _a.source, context = _a.context, id = _a.id, maxChars = _a.maxChars, requiresReview = _a.requiresReview, dataFormat = _a.dataFormat;
     if (hashFunction === void 0) { hashFunction = hashString; }
     var sanitizedSource;
     if (dataFormat === 'JSX') {
@@ -47,7 +47,7 @@ export function hashSource(_a, hashFunction) {
     else {
         sanitizedSource = source;
     }
-    var sanitizedData = __assign(__assign(__assign(__assign({ source: sanitizedSource }, (id && { id: id })), (context && { context: context })), (maxChars != null && { maxChars: Math.abs(maxChars) })), (dataFormat && { dataFormat: dataFormat }));
+    var sanitizedData = __assign(__assign(__assign(__assign(__assign({ source: sanitizedSource }, (id && { id: id })), (context && { context: context })), (maxChars != null && { maxChars: Math.abs(maxChars) })), (requiresReview === true && { requiresReview: true })), (dataFormat && { dataFormat: dataFormat }));
     var stringifiedData = stringify(sanitizedData);
     return hashFunction(stringifiedData);
 }

package/dist/id/types.d.ts

@@ -3,5 +3,6 @@ export type HashMetadata = {
     context?: string;
     id?: string;
     maxChars?: number;
+    requiresReview?: boolean;
     dataFormat?: DataFormat;
 };

package/dist/{id-DEaFhGqX.mjs → id-BS-dC63I.mjs}

@@ -24,7 +24,7 @@ function hashString(string) {
 * @param {function} [hashFunction] - Custom hash function.
 * @returns {string} - The unique hash of the children.
 */
-function hashSource({ source, context, id, maxChars, dataFormat }, hashFunction = hashString) {
+function hashSource({ source, context, id, maxChars, requiresReview, dataFormat }, hashFunction = hashString) {
 	let sanitizedSource;
 	if (dataFormat === "JSX") sanitizedSource = sanitizeJsxChildren(source);
 	else sanitizedSource = source;
@@ -33,6 +33,7 @@ function hashSource({ source, context, id, maxChars, dataFormat }, hashFunction
 		...id && { id },
 		...context && { context },
 		...maxChars != null && { maxChars: Math.abs(maxChars) },
+		...requiresReview === true && { requiresReview: true },
 		...dataFormat && { dataFormat }
 	}));
 }
@@ -71,4 +72,4 @@ function hashTemplate(template, hashFunction = hashString) {
 //#endregion
 export { hashSource as n, hashString as r, hashTemplate as t };
 
-//# sourceMappingURL=id-DEaFhGqX.mjs.map
+//# sourceMappingURL=id-BS-dC63I.mjs.map

package/dist/id-BS-dC63I.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"id-BS-dC63I.mjs","names":["stringify","stringify"],"sources":["../src/id/hashSource.ts","../src/id/hashTemplate.ts"],"sourcesContent":["// Functions provided to other GT libraries\n\nimport { JsxChild, JsxChildren, Variable } from '../types';\nimport { stableStringify as stringify } from '../utils/stableStringify';\nimport { sha256 } from '@noble/hashes/sha2.js';\nimport { bytesToHex, utf8ToBytes } from '@noble/hashes/utils.js';\nimport isVariable from '../utils/isVariable';\nimport { HashMetadata } from './types';\n\n// ----- FUNCTIONS ----- //\n/**\n * Calculates a unique hash for a given string using SHA-256.\n *\n * First 16 characters of hash, hex encoded.\n *\n * @param {string} string - The string to be hashed.\n * @returns {string} The resulting hash as a hexadecimal string.\n */\nexport function hashString(string: string): string {\n  return bytesToHex(sha256(utf8ToBytes(string))).slice(0, 16);\n}\n\n/**\n * Calculates a unique ID for the given children objects by hashing their sanitized JSON string representation.\n *\n * @param {any} childrenAsObjects - The children objects to be hashed.\n * @param {string} [context] - The context for the children.\n * @param {string} [id] - The ID for the JSX children object.\n * @param {number} [maxChars] - The maxChars limit for the JSX children object.\n * @param {string} [dataFormat] - The data format of the sources.\n * @param {function} [hashFunction] - Custom hash function.\n * @returns {string} - The unique hash of the children.\n */\nexport function hashSource(\n  {\n    source,\n    context,\n    id,\n    maxChars,\n    requiresReview,\n    dataFormat,\n  }: {\n    source: JsxChildren | string;\n  } & HashMetadata,\n  hashFunction: (string: string) => string = hashString\n): string {\n  let sanitizedSource: SanitizedChildren | string;\n  if (dataFormat === 'JSX') {\n    sanitizedSource = sanitizeJsxChildren(source);\n  } else {\n    sanitizedSource = source as string;\n  }\n  const sanitizedData: {\n    source?: SanitizedChildren;\n  } & HashMetadata = {\n    source: sanitizedSource,\n    ...(id && { id }),\n    ...(context && { context }),\n    ...(maxChars != null && { maxChars: Math.abs(maxChars) }),\n    // Only mixed in when true: false/absent must hash identically to\n    // pre-requiresReview versions so existing projects keep their hashes\n    ...(requiresReview === true && { requiresReview: true }),\n    ...(dataFormat && { dataFormat }),\n  };\n  const stringifiedData = stringify(sanitizedData);\n  return hashFunction(stringifiedData);\n}\n\ntype SanitizedVariable = Omit<Variable, 'i'>;\n\ntype SanitizedElement = {\n  b?: {\n    [k: string]: SanitizedChildren; // Branches\n  };\n  c?: SanitizedChildren; // Children\n  t?: string; // Branch Transformation\n};\ntype SanitizedChild = SanitizedElement | SanitizedVariable | string;\ntype SanitizedChildren = SanitizedChild | SanitizedChild[];\n\n/**\n * Sanitizes a child object by removing the data-_gt attribute and its branches.\n *\n * @param child - The child object to sanitize.\n * @returns The sanitized child object.\n *\n */\nconst sanitizeChild = (child: JsxChild): SanitizedChild => {\n  if (child && typeof child === 'object') {\n    const newChild: SanitizedChild = {};\n    if ('c' in child && child.c) {\n      newChild.c = sanitizeJsxChildren(child.c);\n    }\n    if ('d' in child) {\n      const generaltranslation = child?.d;\n      if (generaltranslation?.b) {\n        // The only thing that prevents sanitizeJsx from being stable is\n        // the order of the keys in the branches object.\n        // We don't sort them because stable-stringify sorts them anyways\n        newChild.b = Object.fromEntries(\n          Object.entries(generaltranslation.b).map(([key, value]) => [\n            key,\n            sanitizeJsxChildren(value as JsxChildren),\n          ])\n        );\n      }\n      if (generaltranslation?.t) {\n        newChild.t = generaltranslation.t;\n      }\n    }\n    if (isVariable(child)) {\n      return {\n        k: child.k,\n        ...(child.v && {\n          v: child.v,\n        }),\n      };\n    }\n    return newChild;\n  }\n  return child;\n};\n\nfunction sanitizeJsxChildren(\n  childrenAsObjects: JsxChildren\n): SanitizedChildren {\n  return Array.isArray(childrenAsObjects)\n    ? childrenAsObjects.map(sanitizeChild)\n    : sanitizeChild(childrenAsObjects);\n}\n","import { hashString } from './hashSource';\nimport { stableStringify as stringify } from '../utils/stableStringify';\n\nexport default function hashTemplate(\n  template: {\n    [key: string]: string;\n  },\n  hashFunction = hashString\n): string {\n  return hashFunction(stringify(template));\n}\n"],"mappings":";;;;;;;;;;;;AAkBA,SAAgB,WAAW,QAAwB;AACjD,QAAO,WAAW,OAAO,YAAY,OAAO,CAAC,CAAC,CAAC,MAAM,GAAG,GAAG;;;;;;;;;;;;;AAc7D,SAAgB,WACd,EACE,QACA,SACA,IACA,UACA,gBACA,cAIF,eAA2C,YACnC;CACR,IAAI;AACJ,KAAI,eAAe,MACjB,mBAAkB,oBAAoB,OAAO;KAE7C,mBAAkB;AAepB,QAAO,aADiBA,gBAAU;EAThC,QAAQ;EACR,GAAI,MAAM,EAAE,IAAI;EAChB,GAAI,WAAW,EAAE,SAAS;EAC1B,GAAI,YAAY,QAAQ,EAAE,UAAU,KAAK,IAAI,SAAS,EAAE;EAGxD,GAAI,mBAAmB,QAAQ,EAAE,gBAAgB,MAAM;EACvD,GAAI,cAAc,EAAE,YAAY;EAEa,CACZ,CAAC;;;;;;;;;AAsBtC,MAAM,iBAAiB,UAAoC;AACzD,KAAI,SAAS,OAAO,UAAU,UAAU;EACtC,MAAM,WAA2B,EAAE;AACnC,MAAI,OAAO,SAAS,MAAM,EACxB,UAAS,IAAI,oBAAoB,MAAM,EAAE;AAE3C,MAAI,OAAO,OAAO;GAChB,MAAM,qBAAqB,OAAO;AAClC,OAAI,oBAAoB,EAItB,UAAS,IAAI,OAAO,YAClB,OAAO,QAAQ,mBAAmB,EAAE,CAAC,KAAK,CAAC,KAAK,WAAW,CACzD,KACA,oBAAoB,MAAqB,CAC1C,CAAC,CACH;AAEH,OAAI,oBAAoB,EACtB,UAAS,IAAI,mBAAmB;;AAGpC,MAAI,WAAW,MAAM,CACnB,QAAO;GACL,GAAG,MAAM;GACT,GAAI,MAAM,KAAK,EACb,GAAG,MAAM,GACV;GACF;AAEH,SAAO;;AAET,QAAO;;AAGT,SAAS,oBACP,mBACmB;AACnB,QAAO,MAAM,QAAQ,kBAAkB,GACnC,kBAAkB,IAAI,cAAc,GACpC,cAAc,kBAAkB;;;;AC7HtC,SAAwB,aACtB,UAGA,eAAe,YACP;AACR,QAAO,aAAaC,gBAAU,SAAS,CAAC"}

package/dist/{id-C2orn1MA.cjs → id-BrGkL9bC.cjs}

@@ -22,7 +22,7 @@ function hashString(string) {
 * @param {function} [hashFunction] - Custom hash function.
 * @returns {string} - The unique hash of the children.
 */
-function hashSource({ source, context, id, maxChars, dataFormat }, hashFunction = hashString) {
+function hashSource({ source, context, id, maxChars, requiresReview, dataFormat }, hashFunction = hashString) {
 	let sanitizedSource;
 	if (dataFormat === "JSX") sanitizedSource = sanitizeJsxChildren(source);
 	else sanitizedSource = source;
@@ -31,6 +31,7 @@ function hashSource({ source, context, id, maxChars, dataFormat }, hashFunction
 		...id && { id },
 		...context && { context },
 		...maxChars != null && { maxChars: Math.abs(maxChars) },
+		...requiresReview === true && { requiresReview: true },
 		...dataFormat && { dataFormat }
 	}));
 }
@@ -86,4 +87,4 @@ Object.defineProperty(exports, "hashTemplate", {
 	}
 });
 
-//# sourceMappingURL=id-C2orn1MA.cjs.map
+//# sourceMappingURL=id-BrGkL9bC.cjs.map

package/dist/id-BrGkL9bC.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"id-BrGkL9bC.cjs","names":["bytesToHex","sha256","utf8ToBytes","stringify","isVariable","stringify"],"sources":["../src/id/hashSource.ts","../src/id/hashTemplate.ts"],"sourcesContent":["// Functions provided to other GT libraries\n\nimport { JsxChild, JsxChildren, Variable } from '../types';\nimport { stableStringify as stringify } from '../utils/stableStringify';\nimport { sha256 } from '@noble/hashes/sha2.js';\nimport { bytesToHex, utf8ToBytes } from '@noble/hashes/utils.js';\nimport isVariable from '../utils/isVariable';\nimport { HashMetadata } from './types';\n\n// ----- FUNCTIONS ----- //\n/**\n * Calculates a unique hash for a given string using SHA-256.\n *\n * First 16 characters of hash, hex encoded.\n *\n * @param {string} string - The string to be hashed.\n * @returns {string} The resulting hash as a hexadecimal string.\n */\nexport function hashString(string: string): string {\n  return bytesToHex(sha256(utf8ToBytes(string))).slice(0, 16);\n}\n\n/**\n * Calculates a unique ID for the given children objects by hashing their sanitized JSON string representation.\n *\n * @param {any} childrenAsObjects - The children objects to be hashed.\n * @param {string} [context] - The context for the children.\n * @param {string} [id] - The ID for the JSX children object.\n * @param {number} [maxChars] - The maxChars limit for the JSX children object.\n * @param {string} [dataFormat] - The data format of the sources.\n * @param {function} [hashFunction] - Custom hash function.\n * @returns {string} - The unique hash of the children.\n */\nexport function hashSource(\n  {\n    source,\n    context,\n    id,\n    maxChars,\n    requiresReview,\n    dataFormat,\n  }: {\n    source: JsxChildren | string;\n  } & HashMetadata,\n  hashFunction: (string: string) => string = hashString\n): string {\n  let sanitizedSource: SanitizedChildren | string;\n  if (dataFormat === 'JSX') {\n    sanitizedSource = sanitizeJsxChildren(source);\n  } else {\n    sanitizedSource = source as string;\n  }\n  const sanitizedData: {\n    source?: SanitizedChildren;\n  } & HashMetadata = {\n    source: sanitizedSource,\n    ...(id && { id }),\n    ...(context && { context }),\n    ...(maxChars != null && { maxChars: Math.abs(maxChars) }),\n    // Only mixed in when true: false/absent must hash identically to\n    // pre-requiresReview versions so existing projects keep their hashes\n    ...(requiresReview === true && { requiresReview: true }),\n    ...(dataFormat && { dataFormat }),\n  };\n  const stringifiedData = stringify(sanitizedData);\n  return hashFunction(stringifiedData);\n}\n\ntype SanitizedVariable = Omit<Variable, 'i'>;\n\ntype SanitizedElement = {\n  b?: {\n    [k: string]: SanitizedChildren; // Branches\n  };\n  c?: SanitizedChildren; // Children\n  t?: string; // Branch Transformation\n};\ntype SanitizedChild = SanitizedElement | SanitizedVariable | string;\ntype SanitizedChildren = SanitizedChild | SanitizedChild[];\n\n/**\n * Sanitizes a child object by removing the data-_gt attribute and its branches.\n *\n * @param child - The child object to sanitize.\n * @returns The sanitized child object.\n *\n */\nconst sanitizeChild = (child: JsxChild): SanitizedChild => {\n  if (child && typeof child === 'object') {\n    const newChild: SanitizedChild = {};\n    if ('c' in child && child.c) {\n      newChild.c = sanitizeJsxChildren(child.c);\n    }\n    if ('d' in child) {\n      const generaltranslation = child?.d;\n      if (generaltranslation?.b) {\n        // The only thing that prevents sanitizeJsx from being stable is\n        // the order of the keys in the branches object.\n        // We don't sort them because stable-stringify sorts them anyways\n        newChild.b = Object.fromEntries(\n          Object.entries(generaltranslation.b).map(([key, value]) => [\n            key,\n            sanitizeJsxChildren(value as JsxChildren),\n          ])\n        );\n      }\n      if (generaltranslation?.t) {\n        newChild.t = generaltranslation.t;\n      }\n    }\n    if (isVariable(child)) {\n      return {\n        k: child.k,\n        ...(child.v && {\n          v: child.v,\n        }),\n      };\n    }\n    return newChild;\n  }\n  return child;\n};\n\nfunction sanitizeJsxChildren(\n  childrenAsObjects: JsxChildren\n): SanitizedChildren {\n  return Array.isArray(childrenAsObjects)\n    ? childrenAsObjects.map(sanitizeChild)\n    : sanitizeChild(childrenAsObjects);\n}\n","import { hashString } from './hashSource';\nimport { stableStringify as stringify } from '../utils/stableStringify';\n\nexport default function hashTemplate(\n  template: {\n    [key: string]: string;\n  },\n  hashFunction = hashString\n): string {\n  return hashFunction(stringify(template));\n}\n"],"mappings":";;;;;;;;;;AAkBA,SAAgB,WAAW,QAAwB;AACjD,QAAOA,mBAAAA,WAAWC,mBAAAA,OAAOC,mBAAAA,YAAY,OAAO,CAAC,CAAC,CAAC,MAAM,GAAG,GAAG;;;;;;;;;;;;;AAc7D,SAAgB,WACd,EACE,QACA,SACA,IACA,UACA,gBACA,cAIF,eAA2C,YACnC;CACR,IAAI;AACJ,KAAI,eAAe,MACjB,mBAAkB,oBAAoB,OAAO;KAE7C,mBAAkB;AAepB,QAAO,aADiBC,mBAAAA,gBAAU;EAThC,QAAQ;EACR,GAAI,MAAM,EAAE,IAAI;EAChB,GAAI,WAAW,EAAE,SAAS;EAC1B,GAAI,YAAY,QAAQ,EAAE,UAAU,KAAK,IAAI,SAAS,EAAE;EAGxD,GAAI,mBAAmB,QAAQ,EAAE,gBAAgB,MAAM;EACvD,GAAI,cAAc,EAAE,YAAY;EAEa,CACZ,CAAC;;;;;;;;;AAsBtC,MAAM,iBAAiB,UAAoC;AACzD,KAAI,SAAS,OAAO,UAAU,UAAU;EACtC,MAAM,WAA2B,EAAE;AACnC,MAAI,OAAO,SAAS,MAAM,EACxB,UAAS,IAAI,oBAAoB,MAAM,EAAE;AAE3C,MAAI,OAAO,OAAO;GAChB,MAAM,qBAAqB,OAAO;AAClC,OAAI,oBAAoB,EAItB,UAAS,IAAI,OAAO,YAClB,OAAO,QAAQ,mBAAmB,EAAE,CAAC,KAAK,CAAC,KAAK,WAAW,CACzD,KACA,oBAAoB,MAAqB,CAC1C,CAAC,CACH;AAEH,OAAI,oBAAoB,EACtB,UAAS,IAAI,mBAAmB;;AAGpC,MAAIC,mBAAAA,WAAW,MAAM,CACnB,QAAO;GACL,GAAG,MAAM;GACT,GAAI,MAAM,KAAK,EACb,GAAG,MAAM,GACV;GACF;AAEH,SAAO;;AAET,QAAO;;AAGT,SAAS,oBACP,mBACmB;AACnB,QAAO,MAAM,QAAQ,kBAAkB,GACnC,kBAAkB,IAAI,cAAc,GACpC,cAAc,kBAAkB;;;;AC7HtC,SAAwB,aACtB,UAGA,eAAe,YACP;AACR,QAAO,aAAaC,mBAAAA,gBAAU,SAAS,CAAC"}

package/dist/id.cjs

@@ -1,5 +1,5 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_id = require("./id-C2orn1MA.cjs");
+const require_id = require("./id-BrGkL9bC.cjs");
 exports.hashSource = require_id.hashSource;
 exports.hashString = require_id.hashString;
 exports.hashTemplate = require_id.hashTemplate;

package/dist/id.d.cts

@@ -1,4 +1,4 @@
-import { Nt as HashMetadata, g as JsxChildren } from "./types-CdRgQtET.cjs";
+import { Nt as HashMetadata, g as JsxChildren } from "./types-Czjib__7.cjs";
 
 //#region src/id/hashSource.d.ts
 /**
@@ -26,6 +26,7 @@ declare function hashSource({
   context,
   id,
   maxChars,
+  requiresReview,
   dataFormat
 }: {
   source: JsxChildren | string;

package/dist/id.d.mts

@@ -1,4 +1,4 @@
-import { Nt as HashMetadata, g as JsxChildren } from "./types-Db2Dn3oN.mjs";
+import { Nt as HashMetadata, g as JsxChildren } from "./types-Dr51dZ5s.mjs";
 
 //#region src/id/hashSource.d.ts
 /**
@@ -26,6 +26,7 @@ declare function hashSource({
   context,
   id,
   maxChars,
+  requiresReview,
   dataFormat
 }: {
   source: JsxChildren | string;

package/dist/id.mjs

@@ -1,2 +1,2 @@
-import { n as hashSource, r as hashString, t as hashTemplate } from "./id-DEaFhGqX.mjs";
+import { n as hashSource, r as hashString, t as hashTemplate } from "./id-BS-dC63I.mjs";
 export { hashSource, hashString, hashTemplate };

package/dist/index.cjs

@@ -1,7 +1,7 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const require_base64 = require("./base64-YBGAXkqy.cjs");
 const require_ApiError = require("./ApiError-D-IBuHj6.cjs");
-const require_id = require("./id-C2orn1MA.cjs");
+const require_id = require("./id-BrGkL9bC.cjs");
 let _generaltranslation_format = require("@generaltranslation/format");
 //#region src/logging/errors.ts
 const GT_SOURCE = "GT";
@@ -564,7 +564,6 @@ async function _enqueueFiles(files, options, config) {
 				})),
 				targetLocales: options.targetLocales,
 				sourceLocale: options.sourceLocale,
-				requireApproval: options.requireApproval,
 				modelProvider: options.modelProvider,
 				force: options.force
 			},
@@ -848,6 +847,21 @@ async function _queryFileData(data, options = {}, config) {
 	});
 }
 //#endregion
+//#region src/translate/getProjectInfo.ts
+/**
+* @internal
+* Fetches project info (name, locales, review settings) for a project.
+* @param options - The options for the API call.
+* @param config - The configuration for the API call.
+* @returns The project info.
+*/
+async function _getProjectInfo(options, config) {
+	return apiRequest(config, `/v2/project/info/${config.projectId}`, {
+		method: "GET",
+		timeout: options.timeout
+	});
+}
+//#endregion
 //#region src/translate/queryBranchData.ts
 /**
 * @internal
@@ -1255,6 +1269,16 @@ var GT = class {
 	* });
 	*
 	*/
+	/**
+	* Fetches project info (name, locales, review settings) for the
+	* authenticated project.
+	* @param options - The options for the API call.
+	* @returns The project info.
+	*/
+	async getProjectInfo(options = {}) {
+		this._validateAuth("getProjectInfo");
+		return await _getProjectInfo(options, this._getTranslationConfig());
+	}
 	async queryFileData(data, options = {}) {
 		this._validateAuth("queryFileData");
 		data.translatedFiles = data.translatedFiles?.map((item) => ({