generaltranslation 8.2.7 → 8.2.9

package/dist/base64-CUcEPEC5.cjs

@@ -0,0 +1,111 @@
+//#region src/settings/settingsUrls.ts
+const defaultCacheUrl = "https://cdn.gtx.dev";
+const defaultBaseUrl = "https://api2.gtx.dev";
+const defaultRuntimeApiUrl = "https://runtime2.gtx.dev";
+//#endregion
+//#region src/utils/isSupportedFileFormatTransform.ts
+const SUPPORTED_TRANSFORMATIONS = {
+	GTJSON: ["GTJSON"],
+	JSON: ["JSON"],
+	PO: ["PO"],
+	POT: ["POT", "PO"],
+	YAML: ["YAML"],
+	MDX: ["MDX"],
+	MD: ["MD"],
+	TS: ["TS"],
+	JS: ["JS"],
+	HTML: ["HTML"],
+	TXT: ["TXT"],
+	TWILIO_CONTENT_JSON: ["TWILIO_CONTENT_JSON"]
+};
+/**
+* This function checks if a file format transformation is supported during translation
+* @param from - The source file format
+* @param to - The target file format
+* @returns True if the transformation is supported, false otherwise
+*/
+function isSupportedFileFormatTransform(from, to) {
+	return SUPPORTED_TRANSFORMATIONS[from]?.includes(to) ?? false;
+}
+//#endregion
+//#region src/translate/utils/validateFileFormatTransform.ts
+/**
+* Returns a user-facing validation error when a requested file format transform
+* is missing source format context or is not currently supported.
+*/
+function getFileFormatTransformError(file) {
+	if (!file.transformFormat) return void 0;
+	const fileLabel = file.fileName ?? file.fileId ?? "unknown file";
+	if (!file.fileFormat) return `fileFormat is required when transformFormat is provided for ${fileLabel}`;
+	if (!isSupportedFileFormatTransform(file.fileFormat, file.transformFormat)) return `Unsupported file format transform: ${file.fileFormat} -> ${file.transformFormat}`;
+}
+/**
+* Validates file format transforms before sending upload/enqueue requests.
+*/
+function validateFileFormatTransforms(files) {
+	for (const file of files) {
+		const error = getFileFormatTransformError(file);
+		if (error) throw new Error(error);
+	}
+}
+//#endregion
+//#region src/utils/base64.ts
+function encode(data) {
+	if (typeof Buffer !== "undefined") return Buffer.from(data, "utf8").toString("base64");
+	const bytes = new TextEncoder().encode(data);
+	let binary = "";
+	for (let i = 0; i < bytes.length; i++) binary += String.fromCharCode(bytes[i]);
+	return btoa(binary);
+}
+function decode(base64) {
+	if (typeof Buffer !== "undefined") return Buffer.from(base64, "base64").toString("utf8");
+	const binary = atob(base64);
+	const bytes = new Uint8Array(binary.length);
+	for (let i = 0; i < binary.length; i++) bytes[i] = binary.charCodeAt(i);
+	return new TextDecoder().decode(bytes);
+}
+//#endregion
+Object.defineProperty(exports, "decode", {
+	enumerable: true,
+	get: function() {
+		return decode;
+	}
+});
+Object.defineProperty(exports, "defaultBaseUrl", {
+	enumerable: true,
+	get: function() {
+		return defaultBaseUrl;
+	}
+});
+Object.defineProperty(exports, "defaultCacheUrl", {
+	enumerable: true,
+	get: function() {
+		return defaultCacheUrl;
+	}
+});
+Object.defineProperty(exports, "defaultRuntimeApiUrl", {
+	enumerable: true,
+	get: function() {
+		return defaultRuntimeApiUrl;
+	}
+});
+Object.defineProperty(exports, "encode", {
+	enumerable: true,
+	get: function() {
+		return encode;
+	}
+});
+Object.defineProperty(exports, "isSupportedFileFormatTransform", {
+	enumerable: true,
+	get: function() {
+		return isSupportedFileFormatTransform;
+	}
+});
+Object.defineProperty(exports, "validateFileFormatTransforms", {
+	enumerable: true,
+	get: function() {
+		return validateFileFormatTransforms;
+	}
+});
+
+//# sourceMappingURL=base64-CUcEPEC5.cjs.map

package/dist/base64-CUcEPEC5.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"base64-CUcEPEC5.cjs","names":[],"sources":["../src/settings/settingsUrls.ts","../src/utils/isSupportedFileFormatTransform.ts","../src/translate/utils/validateFileFormatTransform.ts","../src/utils/base64.ts"],"sourcesContent":["export const defaultCacheUrl = 'https://cdn.gtx.dev' as const;\nexport const defaultBaseUrl = 'https://api2.gtx.dev' as const;\nexport const defaultRuntimeApiUrl = 'https://runtime2.gtx.dev' as const;\n","import type { FileFormat } from '../types-dir/api/file';\n\nconst SUPPORTED_TRANSFORMATIONS = {\n  GTJSON: ['GTJSON'],\n  JSON: ['JSON'],\n  PO: ['PO'],\n  // POT templates can produce translated PO catalog files.\n  POT: ['POT', 'PO'],\n  YAML: ['YAML'],\n  MDX: ['MDX'],\n  MD: ['MD'],\n  TS: ['TS'],\n  JS: ['JS'],\n  HTML: ['HTML'],\n  TXT: ['TXT'],\n  TWILIO_CONTENT_JSON: ['TWILIO_CONTENT_JSON'],\n} as const satisfies Record<FileFormat, FileFormat[]>;\n\n/**\n * This function checks if a file format transformation is supported during translation\n * @param from - The source file format\n * @param to - The target file format\n * @returns True if the transformation is supported, false otherwise\n */\nexport function isSupportedFileFormatTransform(\n  from: FileFormat,\n  to: FileFormat\n): boolean {\n  const toFormats: FileFormat[] | undefined = SUPPORTED_TRANSFORMATIONS[from];\n  return toFormats?.includes(to) ?? false;\n}\n","import type { FileFormat } from '../../types-dir/api/file';\nimport { isSupportedFileFormatTransform } from '../../utils/isSupportedFileFormatTransform';\n\nexport type FileFormatTransformInput = {\n  fileFormat?: FileFormat;\n  transformFormat?: FileFormat;\n  fileName?: string;\n  fileId?: string;\n};\n\n/**\n * Returns a user-facing validation error when a requested file format transform\n * is missing source format context or is not currently supported.\n */\nexport function getFileFormatTransformError(\n  file: FileFormatTransformInput\n): string | undefined {\n  if (!file.transformFormat) return undefined;\n  const fileLabel = file.fileName ?? file.fileId ?? 'unknown file';\n  if (!file.fileFormat) {\n    return `fileFormat is required when transformFormat is provided for ${fileLabel}`;\n  }\n  if (!isSupportedFileFormatTransform(file.fileFormat, file.transformFormat)) {\n    return `Unsupported file format transform: ${file.fileFormat} -> ${file.transformFormat}`;\n  }\n  return undefined;\n}\n\n/**\n * Validates file format transforms before sending upload/enqueue requests.\n */\nexport function validateFileFormatTransforms(\n  files: FileFormatTransformInput[]\n): void {\n  for (const file of files) {\n    const error = getFileFormatTransformError(file);\n    if (error) throw new Error(error);\n  }\n}\n","// Encode a string to base64\nexport function encode(data: string): string {\n  if (typeof Buffer !== 'undefined') {\n    // Node.js path\n    return Buffer.from(data, 'utf8').toString('base64');\n  }\n  // Browser path\n  const bytes = new TextEncoder().encode(data);\n  let binary = '';\n  for (let i = 0; i < bytes.length; i++) {\n    binary += String.fromCharCode(bytes[i]);\n  }\n  return btoa(binary);\n}\n\n// Decode a base64 string to a string\nexport function decode(base64: string): string {\n  if (typeof Buffer !== 'undefined') {\n    // Node.js path\n    return Buffer.from(base64, 'base64').toString('utf8');\n  }\n  // Browser path\n  const binary = atob(base64);\n  const bytes = new Uint8Array(binary.length);\n  for (let i = 0; i < binary.length; i++) {\n    bytes[i] = binary.charCodeAt(i);\n  }\n  return new TextDecoder().decode(bytes);\n}\n"],"mappings":";AAAA,MAAa,kBAAkB;AAC/B,MAAa,iBAAiB;AAC9B,MAAa,uBAAuB;;;ACApC,MAAM,4BAA4B;CAChC,QAAQ,CAAC,SAAS;CAClB,MAAM,CAAC,OAAO;CACd,IAAI,CAAC,KAAK;CAEV,KAAK,CAAC,OAAO,KAAK;CAClB,MAAM,CAAC,OAAO;CACd,KAAK,CAAC,MAAM;CACZ,IAAI,CAAC,KAAK;CACV,IAAI,CAAC,KAAK;CACV,IAAI,CAAC,KAAK;CACV,MAAM,CAAC,OAAO;CACd,KAAK,CAAC,MAAM;CACZ,qBAAqB,CAAC,sBAAsB;CAC7C;;;;;;;AAQD,SAAgB,+BACd,MACA,IACS;AAET,QAD4C,0BAA0B,OACpD,SAAS,GAAG,IAAI;;;;;;;;ACfpC,SAAgB,4BACd,MACoB;AACpB,KAAI,CAAC,KAAK,gBAAiB,QAAO,KAAA;CAClC,MAAM,YAAY,KAAK,YAAY,KAAK,UAAU;AAClD,KAAI,CAAC,KAAK,WACR,QAAO,+DAA+D;AAExE,KAAI,CAAC,+BAA+B,KAAK,YAAY,KAAK,gBAAgB,CACxE,QAAO,sCAAsC,KAAK,WAAW,MAAM,KAAK;;;;;AAQ5E,SAAgB,6BACd,OACM;AACN,MAAK,MAAM,QAAQ,OAAO;EACxB,MAAM,QAAQ,4BAA4B,KAAK;AAC/C,MAAI,MAAO,OAAM,IAAI,MAAM,MAAM;;;;;ACnCrC,SAAgB,OAAO,MAAsB;AAC3C,KAAI,OAAO,WAAW,YAEpB,QAAO,OAAO,KAAK,MAAM,OAAO,CAAC,SAAS,SAAS;CAGrD,MAAM,QAAQ,IAAI,aAAa,CAAC,OAAO,KAAK;CAC5C,IAAI,SAAS;AACb,MAAK,IAAI,IAAI,GAAG,IAAI,MAAM,QAAQ,IAChC,WAAU,OAAO,aAAa,MAAM,GAAG;AAEzC,QAAO,KAAK,OAAO;;AAIrB,SAAgB,OAAO,QAAwB;AAC7C,KAAI,OAAO,WAAW,YAEpB,QAAO,OAAO,KAAK,QAAQ,SAAS,CAAC,SAAS,OAAO;CAGvD,MAAM,SAAS,KAAK,OAAO;CAC3B,MAAM,QAAQ,IAAI,WAAW,OAAO,OAAO;AAC3C,MAAK,IAAI,IAAI,GAAG,IAAI,OAAO,QAAQ,IACjC,OAAM,KAAK,OAAO,WAAW,EAAE;AAEjC,QAAO,IAAI,aAAa,CAAC,OAAO,MAAM"}

package/dist/core-CJMv4fMa.d.cts

@@ -0,0 +1,209 @@
+import { Dt as StringFormat, Mt as CustomMapping, jt as LocaleProperties, n as FormatVariables } from "./types-mZeu4HS3.cjs";
+
+//#region src/formatting/custom-formats/CutoffFormat/types.d.ts
+/** Type of terminator */
+type CutoffFormatStyle = 'none' | 'ellipsis';
+/** Terminator options */
+interface TerminatorOptions {
+  /** The terminator to use */
+  terminator?: string;
+  /** An optional separator between the terminator and the value */
+  separator?: string;
+}
+/** Input formatting options (for constructor) */
+interface CutoffFormatOptions extends TerminatorOptions {
+  /** Cutoff length */
+  maxChars?: number;
+  /** Type of terminator */
+  style?: CutoffFormatStyle;
+}
+//#endregion
+//#region src/LocaleConfig.d.ts
+type LocaleConfigConstructorParams = {
+  defaultLocale?: string;
+  locales?: string[];
+  customMapping?: CustomMapping;
+};
+type LocalesOption = {
+  locales?: string | string[];
+};
+type WithLocales<T = object> = T & LocalesOption;
+/**
+ * LocaleConfig contains the locale and formatting primitives exposed through
+ * the core entrypoint.
+ *
+ * It intentionally does not store project IDs, API keys, runtime URLs, or any
+ * translation credentials. It only stores locale metadata needed to resolve
+ * aliases, choose formatting fallbacks, and format values with Intl.
+ */
+declare class LocaleConfig {
+  readonly defaultLocale: string;
+  readonly locales: string[];
+  readonly customMapping?: CustomMapping;
+  constructor({
+    defaultLocale,
+    locales,
+    customMapping
+  }?: LocaleConfigConstructorParams);
+  private get translationLocales();
+  private resolveCanonicalLocaleList;
+  private resolveCanonicalLocaleArgs;
+  private toLocaleList;
+  private getFormattingLocales;
+  formatNum(value: number, targetLocale?: string, options?: WithLocales<Intl.NumberFormatOptions>): string;
+  formatDateTime(value: Date, targetLocale?: string, options?: WithLocales<Intl.DateTimeFormatOptions>): string;
+  formatCurrency(value: number, currency: string, targetLocale?: string, options?: WithLocales<Intl.NumberFormatOptions>): string;
+  formatRelativeTime(value: number, unit: Intl.RelativeTimeFormatUnit, targetLocale?: string, options?: WithLocales<Intl.RelativeTimeFormatOptions>): string;
+  formatRelativeTimeFromDate(date: Date, targetLocale?: string, options?: WithLocales<Intl.RelativeTimeFormatOptions & {
+    baseDate?: Date;
+  }>): string;
+  formatCutoff(value: string, targetLocale?: string, options?: WithLocales<CutoffFormatOptions>): string;
+  formatMessage(message: string, targetLocale?: string, options?: WithLocales<{
+    variables?: FormatVariables;
+    dataFormat?: StringFormat;
+  }>): string;
+  formatList(array: Array<string | number>, targetLocale?: string, options?: WithLocales<Intl.ListFormatOptions>): string;
+  formatListToParts<T>(array: Array<T>, targetLocale?: string, options?: WithLocales<Intl.ListFormatOptions>): (string | T)[];
+  getLocaleName(locale: string): string;
+  getLocaleEmoji(locale: string): string;
+  getLocaleProperties(locale: string): LocaleProperties;
+  requiresTranslation(targetLocale: string, sourceLocale?: string, approvedLocales?: string[] | undefined): boolean;
+  determineLocale(locales: string | string[], approvedLocales?: string[]): string | undefined;
+  getLocaleDirection(locale: string): "ltr" | "rtl";
+  isValidLocale(locale: string): boolean;
+  resolveCanonicalLocale(locale: string): string;
+  resolveAliasLocale(locale: string): string;
+  standardizeLocale(locale: string): string;
+  isSameDialect(...locales: (string | string[])[]): boolean;
+  isSameLanguage(...locales: (string | string[])[]): boolean;
+  isSupersetLocale(superLocale: string, subLocale: string): boolean;
+}
+//#endregion
+//#region src/core.d.ts
+/**
+ * Core formatting and locale helpers.
+ *
+ * This entry point exposes deterministic locale and formatting primitives. It
+ * does not export the GT service client, project credentials, network
+ * translation methods, file APIs, or other server/service concerns from the
+ * root `generaltranslation` facade.
+ *
+ * This entry point is intended for framework and shared packages that need
+ * locale metadata or formatting behavior without pulling in the full
+ * translation API surface.
+ */
+/**
+ * Formats a string with cutoff behavior, applying a terminator when the string exceeds the maximum character limit.
+ *
+ * This standalone function provides cutoff formatting functionality without requiring a GT instance.
+ * The locales parameter is required for proper terminator selection based on the target language.
+ *
+ * @param {string} value - The string value to format with cutoff behavior.
+ * @param {Object} [options] - Configuration options for cutoff formatting.
+ * @param {string | string[]} [options.locales] - The locales to use for terminator selection.
+ * @param {number} [options.maxChars] - The maximum number of characters to display.
+ * - Undefined values are treated as no cutoff.
+ * - Negative values follow .slice() behavior and terminator will be added before the value.
+ * - 0 will result in an empty string.
+ * - If cutoff results in an empty string, no terminator is added.
+ * @param {CutoffFormatStyle} [options.style='ellipsis'] - The style of the terminator.
+ * @param {string} [options.terminator] - Optional override the terminator to use.
+ * @param {string} [options.separator] - Optional override the separator to use between the terminator and the value.
+ * - If no terminator is provided, then separator is ignored.
+ * @returns {string} The formatted string with terminator applied if cutoff occurs.
+ *
+ * @example
+ * formatCutoff('Hello, world!', { locales: 'en-US', maxChars: 8 });
+ * // Returns: 'Hello, …'
+ *
+ * @example
+ * formatCutoff('Hello, world!', { locales: 'en-US', maxChars: -3 });
+ * // Returns: '…d!'
+ *
+ * @example
+ * formatCutoff('Very long text that needs cutting', {
+ *   locales: 'en-US',
+ *   maxChars: 15,
+ *   style: 'ellipsis',
+ *   separator: ' '
+ * });
+ * // Returns: 'Very long tex …'
+ */
+declare function formatCutoff(value: string, options?: {
+  locales?: string | string[];
+} & CutoffFormatOptions): string;
+/**
+ * Formats a message according to the specified locales and options.
+ *
+ * @param {string} message - The message to format.
+ * @param {Object} [options] - Configuration options for message formatting.
+ * @param {string | string[]} [options.locales] - The locales to use for formatting.
+ * @param {FormatVariables} [options.variables] - The variables to use for formatting.
+ * @param {StringFormat} [options.dataFormat='ICU'] - The format of the message. When STRING, the message is returned as is.
+ * @returns {string} The formatted message.
+ *
+ * @example
+ * formatMessage('Hello {name}', { variables: { name: 'John' } });
+ * // Returns: "Hello John"
+ *
+ * @example
+ * formatMessage('Hello {name}', {
+ *   locales: ['fr'],
+ *   variables: { name: 'John' }
+ * });
+ */
+declare function formatMessage(message: string, options?: {
+  locales?: string | string[];
+  variables?: FormatVariables;
+  dataFormat?: StringFormat;
+}): string;
+/**
+ * Checks if a given BCP 47 locale code is valid.
+ *
+ * @param {string} locale - The BCP 47 locale code to validate.
+ * @param {CustomMapping} [customMapping] - The custom mapping to use for validation.
+ * @returns {boolean} True if the BCP 47 code is valid, false otherwise.
+ *
+ * @example
+ * isValidLocale('en-US');
+ * // Returns: true
+ *
+ * @example
+ * isValidLocale('en_US');
+ * // Returns: false
+ */
+declare function isValidLocale(locale: string, customMapping?: CustomMapping): boolean;
+/**
+ * Resolves the canonical locale for a given locale.
+ *
+ * @param {string} locale - The locale to resolve the canonical locale for.
+ * @param {CustomMapping} [customMapping] - The custom mapping to use for resolving the canonical locale.
+ * @returns {string} The canonical locale.
+ *
+ * @example
+ * resolveCanonicalLocale('en-US');
+ * // Returns: 'en-US'
+ *
+ * @example
+ * resolveCanonicalLocale('en', { en: 'en-US' });
+ * // Returns: 'en-US'
+ */
+declare function resolveCanonicalLocale(locale: string, customMapping?: CustomMapping): string;
+/**
+ * Standardizes a BCP 47 locale code to ensure correct formatting.
+ *
+ * @param {string} locale - The BCP 47 locale code to standardize.
+ * @returns {string} The standardized BCP 47 locale code or an empty string if it is an invalid code.
+ *
+ * @example
+ * standardizeLocale('en-us');
+ * // Returns: 'en-US'
+ *
+ * @example
+ * standardizeLocale('not a locale');
+ * // Returns: ''
+ */
+declare function standardizeLocale(locale: string): string;
+//#endregion
+export { standardizeLocale as a, CutoffFormatOptions as c, resolveCanonicalLocale as i, formatMessage as n, LocaleConfig as o, isValidLocale as r, LocaleConfigConstructorParams as s, formatCutoff as t };
+//# sourceMappingURL=core-CJMv4fMa.d.cts.map