gt-i18n 1.0.16 → 1.0.18

package/CHANGELOG.md

@@ -1,5 +1,48 @@
 # gt-i18n
 
+## 1.0.18
+
+### Patch Changes
+
+- Updated dependencies [[`34845f9`](https://github.com/generaltranslation/gt/commit/34845f92d64fd9c94a712e4710e8958022066b7b)]:
+  - generaltranslation@9.1.8
+
+## 1.0.17
+
+### Patch Changes
+
+- [#2012](https://github.com/generaltranslation/gt/pull/2012) [`8d376e2`](https://github.com/generaltranslation/gt/commit/8d376e23c80828dfd8756e2f0fbf0f7725e0f178) Thanks [@eoinest](https://github.com/eoinest)! - Make `msg(..., { $format: 'STRING' })` preserve source text literally instead
+  of applying ICU interpolation. For example, `msg('Hello {name}', {
+$format: 'STRING', name: 'Ada' })` now encodes `Hello {name}` rather than
+  `Hello Ada`. Add lightweight shared helpers for registering, hashing, and
+  decoding literal STRING messages, browser cookie access, and canonical GT
+  cookie names, and validate encoded fields by type.
+- Updated dependencies [[`f2204b9`](https://github.com/generaltranslation/gt/commit/f2204b990278865c54d14d337392930ea1ec31bf), [`b05b470`](https://github.com/generaltranslation/gt/commit/b05b4703fbbfd34a3cbee335c786e2e606346167)]:
+  - @generaltranslation/format@0.1.8
+  - generaltranslation@9.1.7
+
+## 1.0.13-iris.0
+
+### Patch Changes
+
+- 5d8b78a: Migrate the package license from FSL-1.1-ALv2 to MIT.
+- Updated dependencies [f2204b9]
+- Updated dependencies [b05b470]
+- Updated dependencies [5d8b78a]
+  - @generaltranslation/format@0.1.5-iris.0
+  - generaltranslation@9.1.3-iris.0
+
+## 1.0.12-iris.0
+
+### Patch Changes
+
+- 8d376e2: Make `msg(..., { $format: 'STRING' })` preserve source text literally instead
+  of applying ICU interpolation. For example, `msg('Hello {name}', {
+$format: 'STRING', name: 'Ada' })` now encodes `Hello {name}` rather than
+  `Hello Ada`. Add lightweight shared helpers for registering, hashing, and
+  decoding literal STRING messages, browser cookie access, and canonical GT
+  cookie names, and validate encoded fields by type.
+
 ## 1.0.16
 
 ### Patch Changes

package/dist/{DictionaryCache-DjAdDNiM.d.cts → DictionaryCache-B7XwB7Al.d.cts}

@@ -26,4 +26,4 @@ type DictionaryKey = DictionaryPath;
 type DictionaryLoader = (locale: string) => Promise<Dictionary>;
 //#endregion
 export { DictionaryLeaf as a, DictionaryValue as c, DictionaryKey as i, Translation as l, Dictionary as n, DictionaryObject as o, DictionaryEntry as r, DictionaryPath as s, DictionaryLoader as t };
-//# sourceMappingURL=DictionaryCache-DjAdDNiM.d.cts.map
+//# sourceMappingURL=DictionaryCache-B7XwB7Al.d.cts.map

package/dist/{DictionaryCache-B7oTBs5W.d.mts → DictionaryCache-D2X-D5Km.d.mts}

@@ -1,4 +1,4 @@
-import { t as DictionaryEntryOptions } from "./options-DDUyXaLT.mjs";
+import { t as DictionaryEntryOptions } from "./options-D_Ry5muW.mjs";
 import { Content } from "@generaltranslation/format/types";
 
 //#region src/i18n-cache/translations-manager/utils/types/translation-data.d.ts
@@ -26,4 +26,4 @@ type DictionaryKey = DictionaryPath;
 type DictionaryLoader = (locale: string) => Promise<Dictionary>;
 //#endregion
 export { DictionaryLeaf as a, DictionaryValue as c, DictionaryKey as i, Translation as l, Dictionary as n, DictionaryObject as o, DictionaryEntry as r, DictionaryPath as s, DictionaryLoader as t };
-//# sourceMappingURL=DictionaryCache-B7oTBs5W.d.mts.map
+//# sourceMappingURL=DictionaryCache-D2X-D5Km.d.mts.map

package/dist/{WritableConditionStore-B0Ly3KFF.d.mts → WritableConditionStore-CXSAqNf8.d.cts}

@@ -1,9 +1,9 @@
-import { n as Dictionary, t as DictionaryLoader } from "./DictionaryCache-B7oTBs5W.mjs";
+import { n as Dictionary, t as DictionaryLoader } from "./DictionaryCache-B7XwB7Al.cjs";
+import { CustomMapping } from "@generaltranslation/format/types";
 import { RuntimeTranslateManyOptions } from "generaltranslation/internal";
+import { GTConfig } from "generaltranslation/types";
 import { LocaleConfig } from "@generaltranslation/format";
 import { GTRuntime } from "generaltranslation/runtime";
-import { CustomMapping } from "@generaltranslation/format/types";
-import { GTConfig } from "generaltranslation/types";
 
 //#region src/i18n-cache/translations-manager/TranslationsCache.d.ts
 type TranslationBatchConfig = {
@@ -187,4 +187,4 @@ declare class WritableConditionStore extends ReadonlyConditionStore implements W
 }
 //#endregion
 export { Hash as _, I18nConfig as a, AsyncReadonlyConditionStoreInterface as c, I18nCacheConstructorParams as d, LocaleResolverConfig as f, TranslationsLoader as g, WritableConditionStoreInterface as h, ReadonlyConditionStoreParams as i, DictionaryConfig as l, ScopedConditionStoreInterface as m, WritableConditionStoreParams as n, I18nConfigParams as o, ReadonlyConditionStoreInterface as p, ReadonlyConditionStore as r, LocaleCandidates as s, WritableConditionStore as t, I18nCacheConfig as u, Locale as v, GTConfig as y };
-//# sourceMappingURL=WritableConditionStore-B0Ly3KFF.d.mts.map
+//# sourceMappingURL=WritableConditionStore-CXSAqNf8.d.cts.map

package/dist/{WritableConditionStore-Bn55y9M5.d.cts → WritableConditionStore-DwBYQYJK.d.mts}

@@ -1,9 +1,9 @@
-import { n as Dictionary, t as DictionaryLoader } from "./DictionaryCache-DjAdDNiM.cjs";
-import { CustomMapping } from "@generaltranslation/format/types";
+import { n as Dictionary, t as DictionaryLoader } from "./DictionaryCache-D2X-D5Km.mjs";
 import { RuntimeTranslateManyOptions } from "generaltranslation/internal";
-import { GTConfig } from "generaltranslation/types";
 import { LocaleConfig } from "@generaltranslation/format";
 import { GTRuntime } from "generaltranslation/runtime";
+import { CustomMapping } from "@generaltranslation/format/types";
+import { GTConfig } from "generaltranslation/types";
 
 //#region src/i18n-cache/translations-manager/TranslationsCache.d.ts
 type TranslationBatchConfig = {
@@ -187,4 +187,4 @@ declare class WritableConditionStore extends ReadonlyConditionStore implements W
 }
 //#endregion
 export { Hash as _, I18nConfig as a, AsyncReadonlyConditionStoreInterface as c, I18nCacheConstructorParams as d, LocaleResolverConfig as f, TranslationsLoader as g, WritableConditionStoreInterface as h, ReadonlyConditionStoreParams as i, DictionaryConfig as l, ScopedConditionStoreInterface as m, WritableConditionStoreParams as n, I18nConfigParams as o, ReadonlyConditionStoreInterface as p, ReadonlyConditionStore as r, LocaleCandidates as s, WritableConditionStore as t, I18nCacheConfig as u, Locale as v, GTConfig as y };
-//# sourceMappingURL=WritableConditionStore-Bn55y9M5.d.cts.map
+//# sourceMappingURL=WritableConditionStore-DwBYQYJK.d.mts.map

package/dist/decodeOptions-BeDpvpRG.d.mts

@@ -0,0 +1,12 @@
+import { d as TranslationOptions } from "./options-D_Ry5muW.mjs";
+
+//#region src/translation-functions/msg/decodeOptions.d.ts
+/**
+ * Decodes the options from an encoded message.
+ * @param encodedMsg The message to decode.
+ * @returns The decoded options.
+ */
+declare function decodeOptions(encodedMsg: string): TranslationOptions | null;
+//#endregion
+export { decodeOptions as t };
+//# sourceMappingURL=decodeOptions-BeDpvpRG.d.mts.map

package/dist/decodeOptions-DEMOo8JG.d.cts

@@ -0,0 +1,12 @@
+import { d as TranslationOptions } from "./options-BXeFwN0R.cjs";
+
+//#region src/translation-functions/msg/decodeOptions.d.ts
+/**
+ * Decodes the options from an encoded message.
+ * @param encodedMsg The message to decode.
+ * @returns The decoded options.
+ */
+declare function decodeOptions(encodedMsg: string): TranslationOptions | null;
+//#endregion
+export { decodeOptions as t };
+//# sourceMappingURL=decodeOptions-DEMOo8JG.d.cts.map

package/dist/{functions-BZ_xopQU.d.mts → functions-BlAp7Ico.d.mts}

@@ -1,13 +1,5 @@
-import { f as TranslationVariables, i as GTTranslationOptions } from "./options-DDUyXaLT.mjs";
+import { f as TranslationVariables, i as GTTranslationOptions } from "./options-D_Ry5muW.mjs";
 
-//#region src/translation-functions/types/message.d.ts
-/**
- * Valid types for messages that can be registered.
- * msg('Hello, World!')
- * msg(['Hello, World!', 'Welcome, {user}!'])
- */
-type RegisterableMessages = string | string[] | readonly string[];
-//#endregion
 //#region src/translation-functions/types/functions.d.ts
 type DictionaryObjectTranslation = string | {
   [key: string]: DictionaryObjectTranslation;
@@ -62,5 +54,5 @@ type TFunctionType = ((id: string, options?: TranslationVariables) => string) &
   obj: (id: string) => DictionaryObjectTranslation;
 };
 //#endregion
-export { SyncResolutionFunctionWithFallback as a, SyncResolutionFunction as i, GTFunctionType as n, TFunctionType as o, MFunctionType as r, RegisterableMessages as s, DictionaryObjectTranslation as t };
-//# sourceMappingURL=functions-BZ_xopQU.d.mts.map
+export { SyncResolutionFunctionWithFallback as a, SyncResolutionFunction as i, GTFunctionType as n, TFunctionType as o, MFunctionType as r, DictionaryObjectTranslation as t };
+//# sourceMappingURL=functions-BlAp7Ico.d.mts.map

package/dist/{functions-BiA2tWER.d.cts → functions-DY3ckTRN.d.cts}

@@ -1,13 +1,5 @@
 import { f as TranslationVariables, i as GTTranslationOptions } from "./options-BXeFwN0R.cjs";
 
-//#region src/translation-functions/types/message.d.ts
-/**
- * Valid types for messages that can be registered.
- * msg('Hello, World!')
- * msg(['Hello, World!', 'Welcome, {user}!'])
- */
-type RegisterableMessages = string | string[] | readonly string[];
-//#endregion
 //#region src/translation-functions/types/functions.d.ts
 type DictionaryObjectTranslation = string | {
   [key: string]: DictionaryObjectTranslation;
@@ -62,5 +54,5 @@ type TFunctionType = ((id: string, options?: TranslationVariables) => string) &
   obj: (id: string) => DictionaryObjectTranslation;
 };
 //#endregion
-export { SyncResolutionFunctionWithFallback as a, SyncResolutionFunction as i, GTFunctionType as n, TFunctionType as o, MFunctionType as r, RegisterableMessages as s, DictionaryObjectTranslation as t };
-//# sourceMappingURL=functions-BiA2tWER.d.cts.map
+export { SyncResolutionFunctionWithFallback as a, SyncResolutionFunction as i, GTFunctionType as n, TFunctionType as o, MFunctionType as r, DictionaryObjectTranslation as t };
+//# sourceMappingURL=functions-DY3ckTRN.d.cts.map

package/dist/index.cjs

@@ -1,5 +1,7 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_versionId = require("./versionId-BrRvCzwH.cjs");
+const require_versionId = require("./versionId-Bd7hW7x_.cjs");
+const require_msgString = require("./msgString-CSHG5PMt.cjs");
+const require_isEncodedTranslationOptions = require("./isEncodedTranslationOptions-ab8RTutO.cjs");
 let generaltranslation_internal = require("generaltranslation/internal");
 let _generaltranslation_format = require("@generaltranslation/format");
 let generaltranslation = require("generaltranslation");
@@ -53,6 +55,7 @@ function extractInterpolatableValues(strings, values) {
 //#endregion
 //#region src/translation-functions/msg/msg.ts
 function msg(message, options) {
+	if (options?.$format === "STRING") return require_msgString.msgString(message, options);
 	if (typeof message !== "string") {
 		if (!options) return message;
 		return message.map((m, i) => msg(m, {
@@ -62,7 +65,7 @@ function msg(message, options) {
 	}
 	if (!options) return message;
 	const variables = require_versionId.extractVariables(options);
-	let interpolatedString = message;
+	let interpolatedString;
 	try {
 		interpolatedString = (0, _generaltranslation_format.formatMessage)(message, {
 			locales: [generaltranslation_internal.libraryDefaultLocale],
@@ -85,8 +88,7 @@ function msg(message, options) {
 		$_source,
 		$_hash
 	};
-	const optionsEncoding = (0, generaltranslation_internal.encode)(JSON.stringify(encodedOptions));
-	return `${interpolatedString}:${optionsEncoding}`;
+	return require_msgString.encodeMsg(interpolatedString, encodedOptions);
 }
 //#endregion
 //#region src/translation-functions/msg/decodeMsg.ts
@@ -153,7 +155,7 @@ const gtFallback = (message, options = {}) => {
 */
 const mFallback = (encodedMsg, options = {}) => {
 	if (!encodedMsg) return encodedMsg;
-	if (require_versionId.isEncodedTranslationOptions(require_versionId.decodeOptions(encodedMsg) ?? {})) return decodeMsg(encodedMsg);
+	if (require_isEncodedTranslationOptions.isEncodedTranslationOptions(require_isEncodedTranslationOptions.decodeOptions(encodedMsg) ?? {})) return decodeMsg(encodedMsg);
 	return require_versionId.interpolateIcuMessage(encodedMsg, options);
 };
 //#endregion
@@ -164,7 +166,7 @@ Object.defineProperty(exports, "declareVar", {
 	}
 });
 exports.decodeMsg = decodeMsg;
-exports.decodeOptions = require_versionId.decodeOptions;
+exports.decodeOptions = require_isEncodedTranslationOptions.decodeOptions;
 Object.defineProperty(exports, "decodeVars", {
 	enumerable: true,
 	get: function() {

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","names":["getWritableConditionStore","resolveStringContentWithFallback","getDefaultLocale","resolveStringContent","extractVariables","libraryDefaultLocale","VAR_IDENTIFIER","createInterpolationFailureMessage","hashMessage","interpolateIcuMessage","isEncodedTranslationOptions","decodeOptions","interpolateIcuMessage"],"sources":["../src/translation-functions/t.ts","../src/translation-functions/msg/msg.ts","../src/translation-functions/msg/decodeMsg.ts","../src/translation-functions/fallbacks/gtFallback.ts","../src/translation-functions/fallbacks/mFallback.ts"],"sourcesContent":["import {\n  resolveStringContent,\n  resolveStringContentWithFallback,\n} from './internal/helpers';\nimport { GTTranslationOptions } from './types/options';\nimport { getDefaultLocale } from '../helpers/locale';\nimport { getWritableConditionStore } from '../condition-store/singleton-operations';\n\n/**\n * Translate a message\n * @param {string} message - The message to translate.\n * @param options - The options for the translation.\n * @returns The translated message.\n */\nexport const t: StringOrTemplateSyncResolutionFunction = (\n  messageOrStrings: string | TemplateStringsArray,\n  ...values: unknown[]\n) => {\n  if (typeof messageOrStrings === 'string') {\n    const options = values.at(0) as GTTranslationOptions | undefined;\n    const conditionStore = getWritableConditionStore();\n    const locale = conditionStore.getEnableI18n()\n      ? (options?.$locale ?? conditionStore.getLocale())\n      : getDefaultLocale();\n    return resolveStringContentWithFallback(locale, messageOrStrings, {\n      $format: 'ICU',\n      ...options,\n    });\n  }\n\n  return handleTaggedTemplateLiteralTranslation(messageOrStrings, values);\n};\n\nfunction handleTaggedTemplateLiteralTranslation(\n  messageOrStrings: TemplateStringsArray,\n  values: unknown[]\n): string {\n  const conditionStore = getWritableConditionStore();\n  const locale = conditionStore.getEnableI18n()\n    ? conditionStore.getLocale()\n    : getDefaultLocale();\n  const interpolatedTemplate = messageOrStrings\n    .map((string, index) => string + (values[index] ?? ''))\n    .join('');\n  const translatedInterpolatedTemplate = resolveStringContent(\n    locale,\n    interpolatedTemplate,\n    { $format: 'ICU' }\n  );\n  if (translatedInterpolatedTemplate !== undefined) {\n    return translatedInterpolatedTemplate;\n  }\n\n  const { message, variables } = extractInterpolatableValues(\n    messageOrStrings,\n    values\n  );\n  return resolveStringContentWithFallback(locale, message, {\n    $format: 'ICU',\n    ...variables,\n  });\n}\n\nfunction extractInterpolatableValues(\n  strings: TemplateStringsArray,\n  values: unknown[]\n): {\n  message: string;\n  variables: Record<string, unknown>;\n} {\n  const parts: string[] = [];\n  const variables: Record<string, unknown> = {};\n  let varIndex = 0;\n\n  for (let i = 0; i < strings.length; i++) {\n    parts.push(strings[i]);\n\n    if (i < values.length) {\n      const key = varIndex.toString();\n      parts.push(`{${key}}`);\n      variables[key] = values[i];\n      varIndex++;\n    }\n  }\n\n  return {\n    message: parts.join(''),\n    variables,\n  };\n}\n\ninterface StringOrTemplateSyncResolutionFunction {\n  (strings: TemplateStringsArray, ...values: unknown[]): string;\n  (message: string, options?: GTTranslationOptions): string;\n}\n\nexport type TemplateSyncResolutionFunction = (\n  strings: TemplateStringsArray,\n  ...values: unknown[]\n) => string;\n","import type {\n  EncodedTranslationOptions,\n  GTTranslationOptions,\n} from '../types/options';\nimport { formatMessage } from '@generaltranslation/format';\nimport {\n  encode,\n  libraryDefaultLocale,\n  VAR_IDENTIFIER,\n} from 'generaltranslation/internal';\nimport { createInterpolationFailureMessage } from '../utils/messages';\nimport logger from '../../logs/logger';\nimport { extractVariables } from '../../utils/extractVariables';\nimport { hashMessage } from '../../utils/hashMessage';\nimport { RegisterableMessages } from '../types/message';\n\n/**\n * Registers a message to be translated. Returns the message unchanged if no options are provided.\n * @param {string | string[]} message The message to encode.\n * @param {GTTranslationOptions} [options] The options to encode.\n * @returns The message or array of messages.\n *\n * @note - This function registers the message before the build process. The actual translation does not\n * occur until the m() function is invoked.\n *\n * @note - Message format\n * A message is broken into two parts separated by colons:\n * - interpolated content - the content with interpolated variables\n * - hash + options - a unique identifier for the source content and options for the translation\n *\n * @example - Basic usage\n *\n * const message1 = msg('Hello, World!');\n * console.log(message1); // \"Hello, World!\"\n *\n * const message2 = msg('Hello, {name}!', { name: 'Brian' });\n * console.log(message2); // \"Hello, Brian:eyIkX2hhc2giOiAiMHgxMjMiLCAiJF9zb3VyY2UiOiAiSGVsbG8sIHtuYW1lfSEiLCAibmFtZSI6ICJCcmlhbiJ9\"\n *\n * @example - Array usage\n *\n * const messages = msg(['Hello, Alice!', 'Hello, Bob!']);\n * console.log(messages); // [\"Hello, Alice!\", \"Hello, Bob!\"]\n *\n * @example - When specifying an id for an array, each message will have a unique id of `${id}.${index}`\n * const messages = msg(['Hello, Alice!', 'Hello, Bob!'], { $id: 'greetings' });\n * // \"Hello, Alice!\" id: \"greetings.0\"\n * // \"Hello, Bob!\" id: \"greetings.1\"\n *\n * @important Internal note: until other packages are updated to use i18n-context practices, msg cannot use any functions that use i18nCache at all!\n */\nexport function msg<T extends RegisterableMessages = string>(message: T): T;\nexport function msg<T extends RegisterableMessages = string>(\n  message: T,\n  options?: GTTranslationOptions\n): T extends string ? string : string[];\nexport function msg(\n  message: RegisterableMessages,\n  options?: GTTranslationOptions\n): RegisterableMessages {\n  // Handle array\n  if (typeof message !== 'string') {\n    if (!options) return message;\n    return message.map((m, i) =>\n      msg(m, {\n        ...options,\n        // ignore if $id is an empty string or not defined\n        ...(options.$id && { $id: `${options.$id}.${i}` }),\n      })\n    );\n  }\n\n  if (!options) {\n    return message;\n  }\n\n  // Extract variables\n  const variables = extractVariables(options);\n\n  // Interpolate string\n  let interpolatedString: string = message;\n  try {\n    interpolatedString = formatMessage(message, {\n      locales: [libraryDefaultLocale], // TODO: use compiler to insert locales\n      variables: {\n        ...variables,\n        [VAR_IDENTIFIER]: 'other',\n      },\n    });\n  } catch {\n    logger.warn(createInterpolationFailureMessage(message));\n    return message;\n  }\n\n  // Encode options\n  const $_source = message;\n  const $_hash =\n    options.$_hash ||\n    hashMessage(message, {\n      $format: 'ICU',\n      ...options,\n    });\n\n  const encodedOptions: EncodedTranslationOptions = {\n    ...options,\n    $_source,\n    $_hash,\n  };\n  const optionsEncoding = encode(JSON.stringify(encodedOptions));\n\n  // Construct result\n  return `${interpolatedString}:${optionsEncoding}`;\n}\n","/**\n * Extracts the original interpolated message string.\n * If the message cannot be decoded (i.e., it does not contain a colon separator),\n * the input is returned as-is.\n * @param encodedMsg The message to decode.\n * @returns The decoded message, or the input if it cannot be decoded.\n */\nexport function decodeMsg(encodedMsg: string): string;\nexport function decodeMsg<T extends null | undefined>(encodedMsg: T): T;\nexport function decodeMsg<T extends string | null | undefined>(\n  encodedMsg: T\n): T extends string ? string : T;\nexport function decodeMsg<T extends string | null | undefined>(\n  encodedMsg: T\n): string | T {\n  if (typeof encodedMsg === 'string' && encodedMsg.lastIndexOf(':') !== -1) {\n    return encodedMsg.slice(0, encodedMsg.lastIndexOf(':'));\n  }\n  return encodedMsg;\n}\n","import { GTTranslationOptions } from '../types/options';\nimport { GTFunctionType } from '../types/functions';\nimport { interpolateIcuMessage } from '../utils/interpolation/interpolateIcuMessage';\n\n/**\n * A fallback function for the gt() function that decodes and interpolates.\n * @param {string | null | undefined} message - The ICU formatted message to interpolate.\n * @param {GTTranslationOptions} options - The options to interpolate.\n * @returns - The decoded and interpolated message.\n *\n * @note This function is useful as a placeholder when for incrementally migrating to the m() function.\n * @example\n * // A backwards compatible translation function\n * function getMessage(gt: GTFunctionType = gtFallback) {\n *   return gt('Hello, world!');\n * }\n *\n * // Here i18n has been implemented\n * function WithTranslation() {\n *   const gt = useGT();\n *   return <>{getMessage(gt)}</>;\n * }\n *\n *\n * // i18n has not yet been implemented yet\n * function WithoutTranslations() {\n *   return <>{getMessage()}</>;\n * }\n */\nexport const gtFallback: GTFunctionType = <T extends string | null | undefined>(\n  message: T,\n  options: GTTranslationOptions = {}\n): T extends string ? string : T => {\n  return interpolateIcuMessage(message, options);\n};\n","import { decodeMsg } from '../msg/decodeMsg';\nimport { GTTranslationOptions } from '../types/options';\nimport { MFunctionType } from '../types/functions';\nimport { decodeOptions } from '../msg/decodeOptions';\nimport { isEncodedTranslationOptions } from '../utils/isEncodedTranslationOptions';\nimport { interpolateIcuMessage } from '../utils/interpolation/interpolateIcuMessage';\n\n/**\n * A fallback function for the m() function that decodes and interpolates.\n * @param {string | null | undefined} encodedMsg - The encoded message to decode and interpolate.\n * @param {GTTranslationOptions} options - The options to interpolate.\n * @returns - The decoded and interpolated message.\n *\n * @note This function is useful as a placeholder when for incrementally migrating to the m() function.\n * @example\n * // A backwards compatible translation function\n * function getMessage(m: MFunctionType = mFallback) {\n *   return m(msg('Hello, world!'));\n * }\n *\n * // Here i18n has been implemented\n * function WithTranslation() {\n *   const m = useMessages();\n *   return <>{getMessage(m)}</>;\n * }\n *\n *\n * // i18n has not yet been implemented yet\n * function WithoutTranslations() {\n *   return <>{getMessage()}</>;\n * }\n */\nexport const mFallback: MFunctionType = <T extends string | null | undefined>(\n  encodedMsg: T,\n  options: GTTranslationOptions = {}\n): T extends string ? string : T => {\n  // Return if the encoded message is null or undefined\n  if (!encodedMsg) return encodedMsg as T extends string ? string : T;\n\n  // Get any encoded options\n  const decodedOptions = decodeOptions(encodedMsg) ?? {};\n\n  // Return early if string already interpolated eg: mFallback(msg('Hello, {name}!', { name: 'Brian' }))\n  if (isEncodedTranslationOptions(decodedOptions)) {\n    // This is an encoded string, msg already interpolated, just return decoded string\n    return decodeMsg(encodedMsg) as T extends string ? string : T;\n  }\n\n  // Not using decoded options to match behavior in @gt/react-core\n  return interpolateIcuMessage(encodedMsg, options);\n};\n"],"mappings":";;;;;;;;;;;;AAcA,MAAa,KACX,kBACA,GAAG,WACA;AACH,KAAI,OAAO,qBAAqB,UAAU;EACxC,MAAM,UAAU,OAAO,GAAG,EAAE;EAC5B,MAAM,iBAAiBA,kBAAAA,2BAA2B;AAIlD,SAAOC,kBAAAA,iCAHQ,eAAe,eAAe,GACxC,SAAS,WAAW,eAAe,WAAW,GAC/CC,kBAAAA,kBAAkB,EAC0B,kBAAkB;GAChE,SAAS;GACT,GAAG;GACJ,CAAC;;AAGJ,QAAO,uCAAuC,kBAAkB,OAAO;;AAGzE,SAAS,uCACP,kBACA,QACQ;CACR,MAAM,iBAAiBF,kBAAAA,2BAA2B;CAClD,MAAM,SAAS,eAAe,eAAe,GACzC,eAAe,WAAW,GAC1BE,kBAAAA,kBAAkB;CAItB,MAAM,iCAAiCC,kBAAAA,qBACrC,QAJ2B,iBAC1B,KAAK,QAAQ,UAAU,UAAU,OAAO,UAAU,IAAI,CACtD,KAAK,GAGc,EACpB,EAAE,SAAS,OAAO,CACnB;AACD,KAAI,mCAAmC,KAAA,EACrC,QAAO;CAGT,MAAM,EAAE,SAAS,cAAc,4BAC7B,kBACA,OACD;AACD,QAAOF,kBAAAA,iCAAiC,QAAQ,SAAS;EACvD,SAAS;EACT,GAAG;EACJ,CAAC;;AAGJ,SAAS,4BACP,SACA,QAIA;CACA,MAAM,QAAkB,EAAE;CAC1B,MAAM,YAAqC,EAAE;CAC7C,IAAI,WAAW;AAEf,MAAK,IAAI,IAAI,GAAG,IAAI,QAAQ,QAAQ,KAAK;AACvC,QAAM,KAAK,QAAQ,GAAG;AAEtB,MAAI,IAAI,OAAO,QAAQ;GACrB,MAAM,MAAM,SAAS,UAAU;AAC/B,SAAM,KAAK,IAAI,IAAI,GAAG;AACtB,aAAU,OAAO,OAAO;AACxB;;;AAIJ,QAAO;EACL,SAAS,MAAM,KAAK,GAAG;EACvB;EACD;;;;ACjCH,SAAgB,IACd,SACA,SACsB;AAEtB,KAAI,OAAO,YAAY,UAAU;AAC/B,MAAI,CAAC,QAAS,QAAO;AACrB,SAAO,QAAQ,KAAK,GAAG,MACrB,IAAI,GAAG;GACL,GAAG;GAEH,GAAI,QAAQ,OAAO,EAAE,KAAK,GAAG,QAAQ,IAAI,GAAG,KAAK;GAClD,CAAC,CACH;;AAGH,KAAI,CAAC,QACH,QAAO;CAIT,MAAM,YAAYG,kBAAAA,iBAAiB,QAAQ;CAG3C,IAAI,qBAA6B;AACjC,KAAI;AACF,wBAAA,GAAA,2BAAA,eAAmC,SAAS;GAC1C,SAAS,CAACC,4BAAAA,qBAAqB;GAC/B,WAAW;IACT,GAAG;KACFC,4BAAAA,iBAAiB;IACnB;GACF,CAAC;SACI;AACN,oBAAA,eAAO,KAAKC,kBAAAA,kCAAkC,QAAQ,CAAC;AACvD,SAAO;;CAIT,MAAM,WAAW;CACjB,MAAM,SACJ,QAAQ,UACRC,kBAAAA,YAAY,SAAS;EACnB,SAAS;EACT,GAAG;EACJ,CAAC;CAEJ,MAAM,iBAA4C;EAChD,GAAG;EACH;EACA;EACD;CACD,MAAM,mBAAA,GAAA,4BAAA,QAAyB,KAAK,UAAU,eAAe,CAAC;AAG9D,QAAO,GAAG,mBAAmB,GAAG;;;;AClGlC,SAAgB,UACd,YACY;AACZ,KAAI,OAAO,eAAe,YAAY,WAAW,YAAY,IAAI,KAAK,GACpE,QAAO,WAAW,MAAM,GAAG,WAAW,YAAY,IAAI,CAAC;AAEzD,QAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACWT,MAAa,cACX,SACA,UAAgC,EAAE,KACA;AAClC,QAAOC,kBAAAA,sBAAsB,SAAS,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACDhD,MAAa,aACX,YACA,UAAgC,EAAE,KACA;AAElC,KAAI,CAAC,WAAY,QAAO;AAMxB,KAAIC,kBAAAA,4BAHmBC,kBAAAA,cAAc,WAAW,IAAI,EAAE,CAGP,CAE7C,QAAO,UAAU,WAAW;AAI9B,QAAOC,kBAAAA,sBAAsB,YAAY,QAAQ"}
+{"version":3,"file":"index.cjs","names":["getWritableConditionStore","resolveStringContentWithFallback","getDefaultLocale","resolveStringContent","msgString","extractVariables","libraryDefaultLocale","VAR_IDENTIFIER","createInterpolationFailureMessage","hashMessage","encodeMsg","interpolateIcuMessage","isEncodedTranslationOptions","decodeOptions","interpolateIcuMessage"],"sources":["../src/translation-functions/t.ts","../src/translation-functions/msg/msg.ts","../src/translation-functions/msg/decodeMsg.ts","../src/translation-functions/fallbacks/gtFallback.ts","../src/translation-functions/fallbacks/mFallback.ts"],"sourcesContent":["import {\n  resolveStringContent,\n  resolveStringContentWithFallback,\n} from './internal/helpers';\nimport { GTTranslationOptions } from './types/options';\nimport { getDefaultLocale } from '../helpers/locale';\nimport { getWritableConditionStore } from '../condition-store/singleton-operations';\n\n/**\n * Translate a message\n * @param {string} message - The message to translate.\n * @param options - The options for the translation.\n * @returns The translated message.\n */\nexport const t: StringOrTemplateSyncResolutionFunction = (\n  messageOrStrings: string | TemplateStringsArray,\n  ...values: unknown[]\n) => {\n  if (typeof messageOrStrings === 'string') {\n    const options = values.at(0) as GTTranslationOptions | undefined;\n    const conditionStore = getWritableConditionStore();\n    const locale = conditionStore.getEnableI18n()\n      ? (options?.$locale ?? conditionStore.getLocale())\n      : getDefaultLocale();\n    return resolveStringContentWithFallback(locale, messageOrStrings, {\n      $format: 'ICU',\n      ...options,\n    });\n  }\n\n  return handleTaggedTemplateLiteralTranslation(messageOrStrings, values);\n};\n\nfunction handleTaggedTemplateLiteralTranslation(\n  messageOrStrings: TemplateStringsArray,\n  values: unknown[]\n): string {\n  const conditionStore = getWritableConditionStore();\n  const locale = conditionStore.getEnableI18n()\n    ? conditionStore.getLocale()\n    : getDefaultLocale();\n  const interpolatedTemplate = messageOrStrings\n    .map((string, index) => string + (values[index] ?? ''))\n    .join('');\n  const translatedInterpolatedTemplate = resolveStringContent(\n    locale,\n    interpolatedTemplate,\n    { $format: 'ICU' }\n  );\n  if (translatedInterpolatedTemplate !== undefined) {\n    return translatedInterpolatedTemplate;\n  }\n\n  const { message, variables } = extractInterpolatableValues(\n    messageOrStrings,\n    values\n  );\n  return resolveStringContentWithFallback(locale, message, {\n    $format: 'ICU',\n    ...variables,\n  });\n}\n\nfunction extractInterpolatableValues(\n  strings: TemplateStringsArray,\n  values: unknown[]\n): {\n  message: string;\n  variables: Record<string, unknown>;\n} {\n  const parts: string[] = [];\n  const variables: Record<string, unknown> = {};\n  let varIndex = 0;\n\n  for (let i = 0; i < strings.length; i++) {\n    parts.push(strings[i]);\n\n    if (i < values.length) {\n      const key = varIndex.toString();\n      parts.push(`{${key}}`);\n      variables[key] = values[i];\n      varIndex++;\n    }\n  }\n\n  return {\n    message: parts.join(''),\n    variables,\n  };\n}\n\ninterface StringOrTemplateSyncResolutionFunction {\n  (strings: TemplateStringsArray, ...values: unknown[]): string;\n  (message: string, options?: GTTranslationOptions): string;\n}\n\nexport type TemplateSyncResolutionFunction = (\n  strings: TemplateStringsArray,\n  ...values: unknown[]\n) => string;\n","import type {\n  EncodedTranslationOptions,\n  GTTranslationOptions,\n} from '../types/options';\nimport { formatMessage } from '@generaltranslation/format';\nimport {\n  libraryDefaultLocale,\n  VAR_IDENTIFIER,\n} from 'generaltranslation/internal';\nimport { createInterpolationFailureMessage } from '../utils/messages';\nimport logger from '../../logs/logger';\nimport { extractVariables } from '../../utils/extractVariables';\nimport { hashMessage } from '../../utils/hashMessage';\nimport { RegisterableMessages } from '../types/message';\nimport { encodeMsg } from './encodeMsg';\nimport { msgString } from './msgString';\n\n/**\n * Registers a message to be translated. Returns the message unchanged if no options are provided.\n * @param {string | string[]} message The message to encode.\n * @param {GTTranslationOptions} [options] The options to encode.\n * @returns The message or array of messages.\n *\n * @note - This function registers the message before the build process. The actual translation does not\n * occur until the m() function is invoked.\n *\n * @note - Message format\n * A message is broken into two parts separated by colons:\n * - interpolated content - the content with interpolated variables\n * - hash + options - a unique identifier for the source content and options for the translation\n *\n * @example - Basic usage\n *\n * const message1 = msg('Hello, World!');\n * console.log(message1); // \"Hello, World!\"\n *\n * const message2 = msg('Hello, {name}!', { name: 'Brian' });\n * console.log(message2); // \"Hello, Brian:eyIkX2hhc2giOiAiMHgxMjMiLCAiJF9zb3VyY2UiOiAiSGVsbG8sIHtuYW1lfSEiLCAibmFtZSI6ICJCcmlhbiJ9\"\n *\n * @example - Array usage\n *\n * const messages = msg(['Hello, Alice!', 'Hello, Bob!']);\n * console.log(messages); // [\"Hello, Alice!\", \"Hello, Bob!\"]\n *\n * @example - When specifying an id for an array, each message will have a unique id of `${id}.${index}`\n * const messages = msg(['Hello, Alice!', 'Hello, Bob!'], { $id: 'greetings' });\n * // \"Hello, Alice!\" id: \"greetings.0\"\n * // \"Hello, Bob!\" id: \"greetings.1\"\n *\n * @important Internal note: until other packages are updated to use i18n-context practices, msg cannot use any functions that use i18nCache at all!\n */\nexport function msg<T extends RegisterableMessages = string>(message: T): T;\nexport function msg<T extends RegisterableMessages = string>(\n  message: T,\n  options?: GTTranslationOptions\n): T extends string ? string : string[];\nexport function msg(\n  message: RegisterableMessages,\n  options?: GTTranslationOptions\n): RegisterableMessages {\n  if (options?.$format === 'STRING') return msgString(message, options);\n\n  // Handle array\n  if (typeof message !== 'string') {\n    if (!options) return message;\n    return message.map((m, i) =>\n      msg(m, {\n        ...options,\n        // ignore if $id is an empty string or not defined\n        ...(options.$id && { $id: `${options.$id}.${i}` }),\n      })\n    );\n  }\n\n  if (!options) {\n    return message;\n  }\n\n  const variables = extractVariables(options);\n  let interpolatedString: string;\n  try {\n    interpolatedString = formatMessage(message, {\n      locales: [libraryDefaultLocale], // TODO: use compiler to insert locales\n      variables: {\n        ...variables,\n        [VAR_IDENTIFIER]: 'other',\n      },\n    });\n  } catch {\n    logger.warn(createInterpolationFailureMessage(message));\n    return message;\n  }\n\n  // Encode options\n  const $_source = message;\n  const $_hash =\n    options.$_hash ||\n    hashMessage(message, {\n      $format: 'ICU',\n      ...options,\n    });\n\n  const encodedOptions: EncodedTranslationOptions = {\n    ...options,\n    $_source,\n    $_hash,\n  };\n  return encodeMsg(interpolatedString, encodedOptions);\n}\n","/**\n * Extracts the original interpolated message string.\n * If the message cannot be decoded (i.e., it does not contain a colon separator),\n * the input is returned as-is.\n * @param encodedMsg The message to decode.\n * @returns The decoded message, or the input if it cannot be decoded.\n */\nexport function decodeMsg(encodedMsg: string): string;\nexport function decodeMsg<T extends null | undefined>(encodedMsg: T): T;\nexport function decodeMsg<T extends string | null | undefined>(\n  encodedMsg: T\n): T extends string ? string : T;\nexport function decodeMsg<T extends string | null | undefined>(\n  encodedMsg: T\n): string | T {\n  if (typeof encodedMsg === 'string' && encodedMsg.lastIndexOf(':') !== -1) {\n    return encodedMsg.slice(0, encodedMsg.lastIndexOf(':'));\n  }\n  return encodedMsg;\n}\n","import { GTTranslationOptions } from '../types/options';\nimport { GTFunctionType } from '../types/functions';\nimport { interpolateIcuMessage } from '../utils/interpolation/interpolateIcuMessage';\n\n/**\n * A fallback function for the gt() function that decodes and interpolates.\n * @param {string | null | undefined} message - The ICU formatted message to interpolate.\n * @param {GTTranslationOptions} options - The options to interpolate.\n * @returns - The decoded and interpolated message.\n *\n * @note This function is useful as a placeholder when for incrementally migrating to the m() function.\n * @example\n * // A backwards compatible translation function\n * function getMessage(gt: GTFunctionType = gtFallback) {\n *   return gt('Hello, world!');\n * }\n *\n * // Here i18n has been implemented\n * function WithTranslation() {\n *   const gt = useGT();\n *   return <>{getMessage(gt)}</>;\n * }\n *\n *\n * // i18n has not yet been implemented yet\n * function WithoutTranslations() {\n *   return <>{getMessage()}</>;\n * }\n */\nexport const gtFallback: GTFunctionType = <T extends string | null | undefined>(\n  message: T,\n  options: GTTranslationOptions = {}\n): T extends string ? string : T => {\n  return interpolateIcuMessage(message, options);\n};\n","import { decodeMsg } from '../msg/decodeMsg';\nimport { GTTranslationOptions } from '../types/options';\nimport { MFunctionType } from '../types/functions';\nimport { decodeOptions } from '../msg/decodeOptions';\nimport { isEncodedTranslationOptions } from '../utils/isEncodedTranslationOptions';\nimport { interpolateIcuMessage } from '../utils/interpolation/interpolateIcuMessage';\n\n/**\n * A fallback function for the m() function that decodes and interpolates.\n * @param {string | null | undefined} encodedMsg - The encoded message to decode and interpolate.\n * @param {GTTranslationOptions} options - The options to interpolate.\n * @returns - The decoded and interpolated message.\n *\n * @note This function is useful as a placeholder when for incrementally migrating to the m() function.\n * @example\n * // A backwards compatible translation function\n * function getMessage(m: MFunctionType = mFallback) {\n *   return m(msg('Hello, world!'));\n * }\n *\n * // Here i18n has been implemented\n * function WithTranslation() {\n *   const m = useMessages();\n *   return <>{getMessage(m)}</>;\n * }\n *\n *\n * // i18n has not yet been implemented yet\n * function WithoutTranslations() {\n *   return <>{getMessage()}</>;\n * }\n */\nexport const mFallback: MFunctionType = <T extends string | null | undefined>(\n  encodedMsg: T,\n  options: GTTranslationOptions = {}\n): T extends string ? string : T => {\n  // Return if the encoded message is null or undefined\n  if (!encodedMsg) return encodedMsg as T extends string ? string : T;\n\n  // Get any encoded options\n  const decodedOptions = decodeOptions(encodedMsg) ?? {};\n\n  // Return early if string already interpolated eg: mFallback(msg('Hello, {name}!', { name: 'Brian' }))\n  if (isEncodedTranslationOptions(decodedOptions)) {\n    // This is an encoded string, msg already interpolated, just return decoded string\n    return decodeMsg(encodedMsg) as T extends string ? string : T;\n  }\n\n  // Not using decoded options to match behavior in @gt/react-core\n  return interpolateIcuMessage(encodedMsg, options);\n};\n"],"mappings":";;;;;;;;;;;;;;AAcA,MAAa,KACX,kBACA,GAAG,WACA;AACH,KAAI,OAAO,qBAAqB,UAAU;EACxC,MAAM,UAAU,OAAO,GAAG,EAAE;EAC5B,MAAM,iBAAiBA,kBAAAA,2BAA2B;AAIlD,SAAOC,kBAAAA,iCAHQ,eAAe,eAAe,GACxC,SAAS,WAAW,eAAe,WAAW,GAC/CC,kBAAAA,kBAAkB,EAC0B,kBAAkB;GAChE,SAAS;GACT,GAAG;GACJ,CAAC;;AAGJ,QAAO,uCAAuC,kBAAkB,OAAO;;AAGzE,SAAS,uCACP,kBACA,QACQ;CACR,MAAM,iBAAiBF,kBAAAA,2BAA2B;CAClD,MAAM,SAAS,eAAe,eAAe,GACzC,eAAe,WAAW,GAC1BE,kBAAAA,kBAAkB;CAItB,MAAM,iCAAiCC,kBAAAA,qBACrC,QAJ2B,iBAC1B,KAAK,QAAQ,UAAU,UAAU,OAAO,UAAU,IAAI,CACtD,KAAK,GAGc,EACpB,EAAE,SAAS,OAAO,CACnB;AACD,KAAI,mCAAmC,KAAA,EACrC,QAAO;CAGT,MAAM,EAAE,SAAS,cAAc,4BAC7B,kBACA,OACD;AACD,QAAOF,kBAAAA,iCAAiC,QAAQ,SAAS;EACvD,SAAS;EACT,GAAG;EACJ,CAAC;;AAGJ,SAAS,4BACP,SACA,QAIA;CACA,MAAM,QAAkB,EAAE;CAC1B,MAAM,YAAqC,EAAE;CAC7C,IAAI,WAAW;AAEf,MAAK,IAAI,IAAI,GAAG,IAAI,QAAQ,QAAQ,KAAK;AACvC,QAAM,KAAK,QAAQ,GAAG;AAEtB,MAAI,IAAI,OAAO,QAAQ;GACrB,MAAM,MAAM,SAAS,UAAU;AAC/B,SAAM,KAAK,IAAI,IAAI,GAAG;AACtB,aAAU,OAAO,OAAO;AACxB;;;AAIJ,QAAO;EACL,SAAS,MAAM,KAAK,GAAG;EACvB;EACD;;;;AChCH,SAAgB,IACd,SACA,SACsB;AACtB,KAAI,SAAS,YAAY,SAAU,QAAOG,kBAAAA,UAAU,SAAS,QAAQ;AAGrE,KAAI,OAAO,YAAY,UAAU;AAC/B,MAAI,CAAC,QAAS,QAAO;AACrB,SAAO,QAAQ,KAAK,GAAG,MACrB,IAAI,GAAG;GACL,GAAG;GAEH,GAAI,QAAQ,OAAO,EAAE,KAAK,GAAG,QAAQ,IAAI,GAAG,KAAK;GAClD,CAAC,CACH;;AAGH,KAAI,CAAC,QACH,QAAO;CAGT,MAAM,YAAYC,kBAAAA,iBAAiB,QAAQ;CAC3C,IAAI;AACJ,KAAI;AACF,wBAAA,GAAA,2BAAA,eAAmC,SAAS;GAC1C,SAAS,CAACC,4BAAAA,qBAAqB;GAC/B,WAAW;IACT,GAAG;KACFC,4BAAAA,iBAAiB;IACnB;GACF,CAAC;SACI;AACN,oBAAA,eAAO,KAAKC,kBAAAA,kCAAkC,QAAQ,CAAC;AACvD,SAAO;;CAIT,MAAM,WAAW;CACjB,MAAM,SACJ,QAAQ,UACRC,kBAAAA,YAAY,SAAS;EACnB,SAAS;EACT,GAAG;EACJ,CAAC;CAEJ,MAAM,iBAA4C;EAChD,GAAG;EACH;EACA;EACD;AACD,QAAOC,kBAAAA,UAAU,oBAAoB,eAAe;;;;AC/FtD,SAAgB,UACd,YACY;AACZ,KAAI,OAAO,eAAe,YAAY,WAAW,YAAY,IAAI,KAAK,GACpE,QAAO,WAAW,MAAM,GAAG,WAAW,YAAY,IAAI,CAAC;AAEzD,QAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACWT,MAAa,cACX,SACA,UAAgC,EAAE,KACA;AAClC,QAAOC,kBAAAA,sBAAsB,SAAS,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACDhD,MAAa,aACX,YACA,UAAgC,EAAE,KACA;AAElC,KAAI,CAAC,WAAY,QAAO;AAMxB,KAAIC,oCAAAA,4BAHmBC,oCAAAA,cAAc,WAAW,IAAI,EAAE,CAGP,CAE7C,QAAO,UAAU,WAAW;AAI9B,QAAOC,kBAAAA,sBAAsB,YAAY,QAAQ"}

package/dist/index.d.cts

@@ -1,6 +1,8 @@
-import { d as TranslationOptions, i as GTTranslationOptions } from "./options-BXeFwN0R.cjs";
-import { n as GTFunctionType, r as MFunctionType, s as RegisterableMessages } from "./functions-BiA2tWER.cjs";
-import { t as getVersionId } from "./versionId-0COhh5UX.cjs";
+import { i as GTTranslationOptions } from "./options-BXeFwN0R.cjs";
+import { t as RegisterableMessages } from "./message-BxBVYC3J.cjs";
+import { t as decodeOptions } from "./decodeOptions-DEMOo8JG.cjs";
+import { n as GTFunctionType, r as MFunctionType } from "./functions-DY3ckTRN.cjs";
+import { t as getVersionId } from "./versionId-CGNwvk_T.cjs";
 import { declareVar, decodeVars, derive } from "generaltranslation";
 import * as _$generaltranslation_internal0 from "generaltranslation/internal";
 
@@ -68,14 +70,6 @@ declare function decodeMsg(encodedMsg: string): string;
 declare function decodeMsg<T extends null | undefined>(encodedMsg: T): T;
 declare function decodeMsg<T extends string | null | undefined>(encodedMsg: T): T extends string ? string : T;
 //#endregion
-//#region src/translation-functions/msg/decodeOptions.d.ts
-/**
- * Decodes the options from an encoded message.
- * @param encodedMsg The message to decode.
- * @returns The decoded options.
- */
-declare function decodeOptions(encodedMsg: string): TranslationOptions | null;
-//#endregion
 //#region src/translation-functions/fallbacks/gtFallback.d.ts
 /**
  * A fallback function for the gt() function that decodes and interpolates.

package/dist/index.d.mts

@@ -1,6 +1,8 @@
-import { d as TranslationOptions, i as GTTranslationOptions } from "./options-DDUyXaLT.mjs";
-import { n as GTFunctionType, r as MFunctionType, s as RegisterableMessages } from "./functions-BZ_xopQU.mjs";
-import { t as getVersionId } from "./versionId-Zel3fqtC.mjs";
+import { i as GTTranslationOptions } from "./options-D_Ry5muW.mjs";
+import { t as RegisterableMessages } from "./message-CYsuGTre.mjs";
+import { t as decodeOptions } from "./decodeOptions-BeDpvpRG.mjs";
+import { n as GTFunctionType, r as MFunctionType } from "./functions-BlAp7Ico.mjs";
+import { t as getVersionId } from "./versionId-BSCcbrCd.mjs";
 import * as _$generaltranslation_internal0 from "generaltranslation/internal";
 import { declareVar, decodeVars, derive } from "generaltranslation";
 
@@ -68,14 +70,6 @@ declare function decodeMsg(encodedMsg: string): string;
 declare function decodeMsg<T extends null | undefined>(encodedMsg: T): T;
 declare function decodeMsg<T extends string | null | undefined>(encodedMsg: T): T extends string ? string : T;
 //#endregion
-//#region src/translation-functions/msg/decodeOptions.d.ts
-/**
- * Decodes the options from an encoded message.
- * @param encodedMsg The message to decode.
- * @returns The decoded options.
- */
-declare function decodeOptions(encodedMsg: string): TranslationOptions | null;
-//#endregion
 //#region src/translation-functions/fallbacks/gtFallback.d.ts
 /**
  * A fallback function for the gt() function that decodes and interpolates.

package/dist/index.mjs

@@ -1,5 +1,7 @@
-import { D as logger_default, S as extractVariables, _ as resolveStringContentWithFallback, a as getDefaultLocale, b as interpolateIcuMessage, c as getLocales, d as getWritableConditionStore, g as resolveStringContent, i as hashMessage, l as getRegion, n as isEncodedTranslationOptions, o as getLocale, r as decodeOptions, s as getLocaleProperties, t as getVersionId, u as resolveCanonicalLocale, x as createInterpolationFailureMessage } from "./versionId-I8qWZjrR.mjs";
-import { VAR_IDENTIFIER, encode, libraryDefaultLocale } from "generaltranslation/internal";
+import { T as logger_default, a as getLocaleProperties, b as extractVariables, c as resolveCanonicalLocale, h as resolveStringContentWithFallback, i as getLocale, l as getWritableConditionStore, m as resolveStringContent, n as hashMessage, o as getLocales, r as getDefaultLocale, s as getRegion, t as getVersionId, v as interpolateIcuMessage, y as createInterpolationFailureMessage } from "./versionId-DQnENeZa.mjs";
+import { r as encodeMsg, t as msgString } from "./msgString-C-b5XBju.mjs";
+import { n as decodeOptions, t as isEncodedTranslationOptions } from "./isEncodedTranslationOptions-CmlRuckr.mjs";
+import { VAR_IDENTIFIER, libraryDefaultLocale } from "generaltranslation/internal";
 import { formatMessage } from "@generaltranslation/format";
 import { declareVar, decodeVars, derive } from "generaltranslation";
 //#region src/translation-functions/t.ts
@@ -52,6 +54,7 @@ function extractInterpolatableValues(strings, values) {
 //#endregion
 //#region src/translation-functions/msg/msg.ts
 function msg(message, options) {
+	if (options?.$format === "STRING") return msgString(message, options);
 	if (typeof message !== "string") {
 		if (!options) return message;
 		return message.map((m, i) => msg(m, {
@@ -61,7 +64,7 @@ function msg(message, options) {
 	}
 	if (!options) return message;
 	const variables = extractVariables(options);
-	let interpolatedString = message;
+	let interpolatedString;
 	try {
 		interpolatedString = formatMessage(message, {
 			locales: [libraryDefaultLocale],
@@ -84,8 +87,7 @@ function msg(message, options) {
 		$_source,
 		$_hash
 	};
-	const optionsEncoding = encode(JSON.stringify(encodedOptions));
-	return `${interpolatedString}:${optionsEncoding}`;
+	return encodeMsg(interpolatedString, encodedOptions);
 }
 //#endregion
 //#region src/translation-functions/msg/decodeMsg.ts

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":[],"sources":["../src/translation-functions/t.ts","../src/translation-functions/msg/msg.ts","../src/translation-functions/msg/decodeMsg.ts","../src/translation-functions/fallbacks/gtFallback.ts","../src/translation-functions/fallbacks/mFallback.ts"],"sourcesContent":["import {\n  resolveStringContent,\n  resolveStringContentWithFallback,\n} from './internal/helpers';\nimport { GTTranslationOptions } from './types/options';\nimport { getDefaultLocale } from '../helpers/locale';\nimport { getWritableConditionStore } from '../condition-store/singleton-operations';\n\n/**\n * Translate a message\n * @param {string} message - The message to translate.\n * @param options - The options for the translation.\n * @returns The translated message.\n */\nexport const t: StringOrTemplateSyncResolutionFunction = (\n  messageOrStrings: string | TemplateStringsArray,\n  ...values: unknown[]\n) => {\n  if (typeof messageOrStrings === 'string') {\n    const options = values.at(0) as GTTranslationOptions | undefined;\n    const conditionStore = getWritableConditionStore();\n    const locale = conditionStore.getEnableI18n()\n      ? (options?.$locale ?? conditionStore.getLocale())\n      : getDefaultLocale();\n    return resolveStringContentWithFallback(locale, messageOrStrings, {\n      $format: 'ICU',\n      ...options,\n    });\n  }\n\n  return handleTaggedTemplateLiteralTranslation(messageOrStrings, values);\n};\n\nfunction handleTaggedTemplateLiteralTranslation(\n  messageOrStrings: TemplateStringsArray,\n  values: unknown[]\n): string {\n  const conditionStore = getWritableConditionStore();\n  const locale = conditionStore.getEnableI18n()\n    ? conditionStore.getLocale()\n    : getDefaultLocale();\n  const interpolatedTemplate = messageOrStrings\n    .map((string, index) => string + (values[index] ?? ''))\n    .join('');\n  const translatedInterpolatedTemplate = resolveStringContent(\n    locale,\n    interpolatedTemplate,\n    { $format: 'ICU' }\n  );\n  if (translatedInterpolatedTemplate !== undefined) {\n    return translatedInterpolatedTemplate;\n  }\n\n  const { message, variables } = extractInterpolatableValues(\n    messageOrStrings,\n    values\n  );\n  return resolveStringContentWithFallback(locale, message, {\n    $format: 'ICU',\n    ...variables,\n  });\n}\n\nfunction extractInterpolatableValues(\n  strings: TemplateStringsArray,\n  values: unknown[]\n): {\n  message: string;\n  variables: Record<string, unknown>;\n} {\n  const parts: string[] = [];\n  const variables: Record<string, unknown> = {};\n  let varIndex = 0;\n\n  for (let i = 0; i < strings.length; i++) {\n    parts.push(strings[i]);\n\n    if (i < values.length) {\n      const key = varIndex.toString();\n      parts.push(`{${key}}`);\n      variables[key] = values[i];\n      varIndex++;\n    }\n  }\n\n  return {\n    message: parts.join(''),\n    variables,\n  };\n}\n\ninterface StringOrTemplateSyncResolutionFunction {\n  (strings: TemplateStringsArray, ...values: unknown[]): string;\n  (message: string, options?: GTTranslationOptions): string;\n}\n\nexport type TemplateSyncResolutionFunction = (\n  strings: TemplateStringsArray,\n  ...values: unknown[]\n) => string;\n","import type {\n  EncodedTranslationOptions,\n  GTTranslationOptions,\n} from '../types/options';\nimport { formatMessage } from '@generaltranslation/format';\nimport {\n  encode,\n  libraryDefaultLocale,\n  VAR_IDENTIFIER,\n} from 'generaltranslation/internal';\nimport { createInterpolationFailureMessage } from '../utils/messages';\nimport logger from '../../logs/logger';\nimport { extractVariables } from '../../utils/extractVariables';\nimport { hashMessage } from '../../utils/hashMessage';\nimport { RegisterableMessages } from '../types/message';\n\n/**\n * Registers a message to be translated. Returns the message unchanged if no options are provided.\n * @param {string | string[]} message The message to encode.\n * @param {GTTranslationOptions} [options] The options to encode.\n * @returns The message or array of messages.\n *\n * @note - This function registers the message before the build process. The actual translation does not\n * occur until the m() function is invoked.\n *\n * @note - Message format\n * A message is broken into two parts separated by colons:\n * - interpolated content - the content with interpolated variables\n * - hash + options - a unique identifier for the source content and options for the translation\n *\n * @example - Basic usage\n *\n * const message1 = msg('Hello, World!');\n * console.log(message1); // \"Hello, World!\"\n *\n * const message2 = msg('Hello, {name}!', { name: 'Brian' });\n * console.log(message2); // \"Hello, Brian:eyIkX2hhc2giOiAiMHgxMjMiLCAiJF9zb3VyY2UiOiAiSGVsbG8sIHtuYW1lfSEiLCAibmFtZSI6ICJCcmlhbiJ9\"\n *\n * @example - Array usage\n *\n * const messages = msg(['Hello, Alice!', 'Hello, Bob!']);\n * console.log(messages); // [\"Hello, Alice!\", \"Hello, Bob!\"]\n *\n * @example - When specifying an id for an array, each message will have a unique id of `${id}.${index}`\n * const messages = msg(['Hello, Alice!', 'Hello, Bob!'], { $id: 'greetings' });\n * // \"Hello, Alice!\" id: \"greetings.0\"\n * // \"Hello, Bob!\" id: \"greetings.1\"\n *\n * @important Internal note: until other packages are updated to use i18n-context practices, msg cannot use any functions that use i18nCache at all!\n */\nexport function msg<T extends RegisterableMessages = string>(message: T): T;\nexport function msg<T extends RegisterableMessages = string>(\n  message: T,\n  options?: GTTranslationOptions\n): T extends string ? string : string[];\nexport function msg(\n  message: RegisterableMessages,\n  options?: GTTranslationOptions\n): RegisterableMessages {\n  // Handle array\n  if (typeof message !== 'string') {\n    if (!options) return message;\n    return message.map((m, i) =>\n      msg(m, {\n        ...options,\n        // ignore if $id is an empty string or not defined\n        ...(options.$id && { $id: `${options.$id}.${i}` }),\n      })\n    );\n  }\n\n  if (!options) {\n    return message;\n  }\n\n  // Extract variables\n  const variables = extractVariables(options);\n\n  // Interpolate string\n  let interpolatedString: string = message;\n  try {\n    interpolatedString = formatMessage(message, {\n      locales: [libraryDefaultLocale], // TODO: use compiler to insert locales\n      variables: {\n        ...variables,\n        [VAR_IDENTIFIER]: 'other',\n      },\n    });\n  } catch {\n    logger.warn(createInterpolationFailureMessage(message));\n    return message;\n  }\n\n  // Encode options\n  const $_source = message;\n  const $_hash =\n    options.$_hash ||\n    hashMessage(message, {\n      $format: 'ICU',\n      ...options,\n    });\n\n  const encodedOptions: EncodedTranslationOptions = {\n    ...options,\n    $_source,\n    $_hash,\n  };\n  const optionsEncoding = encode(JSON.stringify(encodedOptions));\n\n  // Construct result\n  return `${interpolatedString}:${optionsEncoding}`;\n}\n","/**\n * Extracts the original interpolated message string.\n * If the message cannot be decoded (i.e., it does not contain a colon separator),\n * the input is returned as-is.\n * @param encodedMsg The message to decode.\n * @returns The decoded message, or the input if it cannot be decoded.\n */\nexport function decodeMsg(encodedMsg: string): string;\nexport function decodeMsg<T extends null | undefined>(encodedMsg: T): T;\nexport function decodeMsg<T extends string | null | undefined>(\n  encodedMsg: T\n): T extends string ? string : T;\nexport function decodeMsg<T extends string | null | undefined>(\n  encodedMsg: T\n): string | T {\n  if (typeof encodedMsg === 'string' && encodedMsg.lastIndexOf(':') !== -1) {\n    return encodedMsg.slice(0, encodedMsg.lastIndexOf(':'));\n  }\n  return encodedMsg;\n}\n","import { GTTranslationOptions } from '../types/options';\nimport { GTFunctionType } from '../types/functions';\nimport { interpolateIcuMessage } from '../utils/interpolation/interpolateIcuMessage';\n\n/**\n * A fallback function for the gt() function that decodes and interpolates.\n * @param {string | null | undefined} message - The ICU formatted message to interpolate.\n * @param {GTTranslationOptions} options - The options to interpolate.\n * @returns - The decoded and interpolated message.\n *\n * @note This function is useful as a placeholder when for incrementally migrating to the m() function.\n * @example\n * // A backwards compatible translation function\n * function getMessage(gt: GTFunctionType = gtFallback) {\n *   return gt('Hello, world!');\n * }\n *\n * // Here i18n has been implemented\n * function WithTranslation() {\n *   const gt = useGT();\n *   return <>{getMessage(gt)}</>;\n * }\n *\n *\n * // i18n has not yet been implemented yet\n * function WithoutTranslations() {\n *   return <>{getMessage()}</>;\n * }\n */\nexport const gtFallback: GTFunctionType = <T extends string | null | undefined>(\n  message: T,\n  options: GTTranslationOptions = {}\n): T extends string ? string : T => {\n  return interpolateIcuMessage(message, options);\n};\n","import { decodeMsg } from '../msg/decodeMsg';\nimport { GTTranslationOptions } from '../types/options';\nimport { MFunctionType } from '../types/functions';\nimport { decodeOptions } from '../msg/decodeOptions';\nimport { isEncodedTranslationOptions } from '../utils/isEncodedTranslationOptions';\nimport { interpolateIcuMessage } from '../utils/interpolation/interpolateIcuMessage';\n\n/**\n * A fallback function for the m() function that decodes and interpolates.\n * @param {string | null | undefined} encodedMsg - The encoded message to decode and interpolate.\n * @param {GTTranslationOptions} options - The options to interpolate.\n * @returns - The decoded and interpolated message.\n *\n * @note This function is useful as a placeholder when for incrementally migrating to the m() function.\n * @example\n * // A backwards compatible translation function\n * function getMessage(m: MFunctionType = mFallback) {\n *   return m(msg('Hello, world!'));\n * }\n *\n * // Here i18n has been implemented\n * function WithTranslation() {\n *   const m = useMessages();\n *   return <>{getMessage(m)}</>;\n * }\n *\n *\n * // i18n has not yet been implemented yet\n * function WithoutTranslations() {\n *   return <>{getMessage()}</>;\n * }\n */\nexport const mFallback: MFunctionType = <T extends string | null | undefined>(\n  encodedMsg: T,\n  options: GTTranslationOptions = {}\n): T extends string ? string : T => {\n  // Return if the encoded message is null or undefined\n  if (!encodedMsg) return encodedMsg as T extends string ? string : T;\n\n  // Get any encoded options\n  const decodedOptions = decodeOptions(encodedMsg) ?? {};\n\n  // Return early if string already interpolated eg: mFallback(msg('Hello, {name}!', { name: 'Brian' }))\n  if (isEncodedTranslationOptions(decodedOptions)) {\n    // This is an encoded string, msg already interpolated, just return decoded string\n    return decodeMsg(encodedMsg) as T extends string ? string : T;\n  }\n\n  // Not using decoded options to match behavior in @gt/react-core\n  return interpolateIcuMessage(encodedMsg, options);\n};\n"],"mappings":";;;;;;;;;;;AAcA,MAAa,KACX,kBACA,GAAG,WACA;AACH,KAAI,OAAO,qBAAqB,UAAU;EACxC,MAAM,UAAU,OAAO,GAAG,EAAE;EAC5B,MAAM,iBAAiB,2BAA2B;AAIlD,SAAO,iCAHQ,eAAe,eAAe,GACxC,SAAS,WAAW,eAAe,WAAW,GAC/C,kBAAkB,EAC0B,kBAAkB;GAChE,SAAS;GACT,GAAG;GACJ,CAAC;;AAGJ,QAAO,uCAAuC,kBAAkB,OAAO;;AAGzE,SAAS,uCACP,kBACA,QACQ;CACR,MAAM,iBAAiB,2BAA2B;CAClD,MAAM,SAAS,eAAe,eAAe,GACzC,eAAe,WAAW,GAC1B,kBAAkB;CAItB,MAAM,iCAAiC,qBACrC,QAJ2B,iBAC1B,KAAK,QAAQ,UAAU,UAAU,OAAO,UAAU,IAAI,CACtD,KAAK,GAGc,EACpB,EAAE,SAAS,OAAO,CACnB;AACD,KAAI,mCAAmC,KAAA,EACrC,QAAO;CAGT,MAAM,EAAE,SAAS,cAAc,4BAC7B,kBACA,OACD;AACD,QAAO,iCAAiC,QAAQ,SAAS;EACvD,SAAS;EACT,GAAG;EACJ,CAAC;;AAGJ,SAAS,4BACP,SACA,QAIA;CACA,MAAM,QAAkB,EAAE;CAC1B,MAAM,YAAqC,EAAE;CAC7C,IAAI,WAAW;AAEf,MAAK,IAAI,IAAI,GAAG,IAAI,QAAQ,QAAQ,KAAK;AACvC,QAAM,KAAK,QAAQ,GAAG;AAEtB,MAAI,IAAI,OAAO,QAAQ;GACrB,MAAM,MAAM,SAAS,UAAU;AAC/B,SAAM,KAAK,IAAI,IAAI,GAAG;AACtB,aAAU,OAAO,OAAO;AACxB;;;AAIJ,QAAO;EACL,SAAS,MAAM,KAAK,GAAG;EACvB;EACD;;;;ACjCH,SAAgB,IACd,SACA,SACsB;AAEtB,KAAI,OAAO,YAAY,UAAU;AAC/B,MAAI,CAAC,QAAS,QAAO;AACrB,SAAO,QAAQ,KAAK,GAAG,MACrB,IAAI,GAAG;GACL,GAAG;GAEH,GAAI,QAAQ,OAAO,EAAE,KAAK,GAAG,QAAQ,IAAI,GAAG,KAAK;GAClD,CAAC,CACH;;AAGH,KAAI,CAAC,QACH,QAAO;CAIT,MAAM,YAAY,iBAAiB,QAAQ;CAG3C,IAAI,qBAA6B;AACjC,KAAI;AACF,uBAAqB,cAAc,SAAS;GAC1C,SAAS,CAAC,qBAAqB;GAC/B,WAAW;IACT,GAAG;KACF,iBAAiB;IACnB;GACF,CAAC;SACI;AACN,iBAAO,KAAK,kCAAkC,QAAQ,CAAC;AACvD,SAAO;;CAIT,MAAM,WAAW;CACjB,MAAM,SACJ,QAAQ,UACR,YAAY,SAAS;EACnB,SAAS;EACT,GAAG;EACJ,CAAC;CAEJ,MAAM,iBAA4C;EAChD,GAAG;EACH;EACA;EACD;CACD,MAAM,kBAAkB,OAAO,KAAK,UAAU,eAAe,CAAC;AAG9D,QAAO,GAAG,mBAAmB,GAAG;;;;AClGlC,SAAgB,UACd,YACY;AACZ,KAAI,OAAO,eAAe,YAAY,WAAW,YAAY,IAAI,KAAK,GACpE,QAAO,WAAW,MAAM,GAAG,WAAW,YAAY,IAAI,CAAC;AAEzD,QAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACWT,MAAa,cACX,SACA,UAAgC,EAAE,KACA;AAClC,QAAO,sBAAsB,SAAS,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACDhD,MAAa,aACX,YACA,UAAgC,EAAE,KACA;AAElC,KAAI,CAAC,WAAY,QAAO;AAMxB,KAAI,4BAHmB,cAAc,WAAW,IAAI,EAAE,CAGP,CAE7C,QAAO,UAAU,WAAW;AAI9B,QAAO,sBAAsB,YAAY,QAAQ"}
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/translation-functions/t.ts","../src/translation-functions/msg/msg.ts","../src/translation-functions/msg/decodeMsg.ts","../src/translation-functions/fallbacks/gtFallback.ts","../src/translation-functions/fallbacks/mFallback.ts"],"sourcesContent":["import {\n  resolveStringContent,\n  resolveStringContentWithFallback,\n} from './internal/helpers';\nimport { GTTranslationOptions } from './types/options';\nimport { getDefaultLocale } from '../helpers/locale';\nimport { getWritableConditionStore } from '../condition-store/singleton-operations';\n\n/**\n * Translate a message\n * @param {string} message - The message to translate.\n * @param options - The options for the translation.\n * @returns The translated message.\n */\nexport const t: StringOrTemplateSyncResolutionFunction = (\n  messageOrStrings: string | TemplateStringsArray,\n  ...values: unknown[]\n) => {\n  if (typeof messageOrStrings === 'string') {\n    const options = values.at(0) as GTTranslationOptions | undefined;\n    const conditionStore = getWritableConditionStore();\n    const locale = conditionStore.getEnableI18n()\n      ? (options?.$locale ?? conditionStore.getLocale())\n      : getDefaultLocale();\n    return resolveStringContentWithFallback(locale, messageOrStrings, {\n      $format: 'ICU',\n      ...options,\n    });\n  }\n\n  return handleTaggedTemplateLiteralTranslation(messageOrStrings, values);\n};\n\nfunction handleTaggedTemplateLiteralTranslation(\n  messageOrStrings: TemplateStringsArray,\n  values: unknown[]\n): string {\n  const conditionStore = getWritableConditionStore();\n  const locale = conditionStore.getEnableI18n()\n    ? conditionStore.getLocale()\n    : getDefaultLocale();\n  const interpolatedTemplate = messageOrStrings\n    .map((string, index) => string + (values[index] ?? ''))\n    .join('');\n  const translatedInterpolatedTemplate = resolveStringContent(\n    locale,\n    interpolatedTemplate,\n    { $format: 'ICU' }\n  );\n  if (translatedInterpolatedTemplate !== undefined) {\n    return translatedInterpolatedTemplate;\n  }\n\n  const { message, variables } = extractInterpolatableValues(\n    messageOrStrings,\n    values\n  );\n  return resolveStringContentWithFallback(locale, message, {\n    $format: 'ICU',\n    ...variables,\n  });\n}\n\nfunction extractInterpolatableValues(\n  strings: TemplateStringsArray,\n  values: unknown[]\n): {\n  message: string;\n  variables: Record<string, unknown>;\n} {\n  const parts: string[] = [];\n  const variables: Record<string, unknown> = {};\n  let varIndex = 0;\n\n  for (let i = 0; i < strings.length; i++) {\n    parts.push(strings[i]);\n\n    if (i < values.length) {\n      const key = varIndex.toString();\n      parts.push(`{${key}}`);\n      variables[key] = values[i];\n      varIndex++;\n    }\n  }\n\n  return {\n    message: parts.join(''),\n    variables,\n  };\n}\n\ninterface StringOrTemplateSyncResolutionFunction {\n  (strings: TemplateStringsArray, ...values: unknown[]): string;\n  (message: string, options?: GTTranslationOptions): string;\n}\n\nexport type TemplateSyncResolutionFunction = (\n  strings: TemplateStringsArray,\n  ...values: unknown[]\n) => string;\n","import type {\n  EncodedTranslationOptions,\n  GTTranslationOptions,\n} from '../types/options';\nimport { formatMessage } from '@generaltranslation/format';\nimport {\n  libraryDefaultLocale,\n  VAR_IDENTIFIER,\n} from 'generaltranslation/internal';\nimport { createInterpolationFailureMessage } from '../utils/messages';\nimport logger from '../../logs/logger';\nimport { extractVariables } from '../../utils/extractVariables';\nimport { hashMessage } from '../../utils/hashMessage';\nimport { RegisterableMessages } from '../types/message';\nimport { encodeMsg } from './encodeMsg';\nimport { msgString } from './msgString';\n\n/**\n * Registers a message to be translated. Returns the message unchanged if no options are provided.\n * @param {string | string[]} message The message to encode.\n * @param {GTTranslationOptions} [options] The options to encode.\n * @returns The message or array of messages.\n *\n * @note - This function registers the message before the build process. The actual translation does not\n * occur until the m() function is invoked.\n *\n * @note - Message format\n * A message is broken into two parts separated by colons:\n * - interpolated content - the content with interpolated variables\n * - hash + options - a unique identifier for the source content and options for the translation\n *\n * @example - Basic usage\n *\n * const message1 = msg('Hello, World!');\n * console.log(message1); // \"Hello, World!\"\n *\n * const message2 = msg('Hello, {name}!', { name: 'Brian' });\n * console.log(message2); // \"Hello, Brian:eyIkX2hhc2giOiAiMHgxMjMiLCAiJF9zb3VyY2UiOiAiSGVsbG8sIHtuYW1lfSEiLCAibmFtZSI6ICJCcmlhbiJ9\"\n *\n * @example - Array usage\n *\n * const messages = msg(['Hello, Alice!', 'Hello, Bob!']);\n * console.log(messages); // [\"Hello, Alice!\", \"Hello, Bob!\"]\n *\n * @example - When specifying an id for an array, each message will have a unique id of `${id}.${index}`\n * const messages = msg(['Hello, Alice!', 'Hello, Bob!'], { $id: 'greetings' });\n * // \"Hello, Alice!\" id: \"greetings.0\"\n * // \"Hello, Bob!\" id: \"greetings.1\"\n *\n * @important Internal note: until other packages are updated to use i18n-context practices, msg cannot use any functions that use i18nCache at all!\n */\nexport function msg<T extends RegisterableMessages = string>(message: T): T;\nexport function msg<T extends RegisterableMessages = string>(\n  message: T,\n  options?: GTTranslationOptions\n): T extends string ? string : string[];\nexport function msg(\n  message: RegisterableMessages,\n  options?: GTTranslationOptions\n): RegisterableMessages {\n  if (options?.$format === 'STRING') return msgString(message, options);\n\n  // Handle array\n  if (typeof message !== 'string') {\n    if (!options) return message;\n    return message.map((m, i) =>\n      msg(m, {\n        ...options,\n        // ignore if $id is an empty string or not defined\n        ...(options.$id && { $id: `${options.$id}.${i}` }),\n      })\n    );\n  }\n\n  if (!options) {\n    return message;\n  }\n\n  const variables = extractVariables(options);\n  let interpolatedString: string;\n  try {\n    interpolatedString = formatMessage(message, {\n      locales: [libraryDefaultLocale], // TODO: use compiler to insert locales\n      variables: {\n        ...variables,\n        [VAR_IDENTIFIER]: 'other',\n      },\n    });\n  } catch {\n    logger.warn(createInterpolationFailureMessage(message));\n    return message;\n  }\n\n  // Encode options\n  const $_source = message;\n  const $_hash =\n    options.$_hash ||\n    hashMessage(message, {\n      $format: 'ICU',\n      ...options,\n    });\n\n  const encodedOptions: EncodedTranslationOptions = {\n    ...options,\n    $_source,\n    $_hash,\n  };\n  return encodeMsg(interpolatedString, encodedOptions);\n}\n","/**\n * Extracts the original interpolated message string.\n * If the message cannot be decoded (i.e., it does not contain a colon separator),\n * the input is returned as-is.\n * @param encodedMsg The message to decode.\n * @returns The decoded message, or the input if it cannot be decoded.\n */\nexport function decodeMsg(encodedMsg: string): string;\nexport function decodeMsg<T extends null | undefined>(encodedMsg: T): T;\nexport function decodeMsg<T extends string | null | undefined>(\n  encodedMsg: T\n): T extends string ? string : T;\nexport function decodeMsg<T extends string | null | undefined>(\n  encodedMsg: T\n): string | T {\n  if (typeof encodedMsg === 'string' && encodedMsg.lastIndexOf(':') !== -1) {\n    return encodedMsg.slice(0, encodedMsg.lastIndexOf(':'));\n  }\n  return encodedMsg;\n}\n","import { GTTranslationOptions } from '../types/options';\nimport { GTFunctionType } from '../types/functions';\nimport { interpolateIcuMessage } from '../utils/interpolation/interpolateIcuMessage';\n\n/**\n * A fallback function for the gt() function that decodes and interpolates.\n * @param {string | null | undefined} message - The ICU formatted message to interpolate.\n * @param {GTTranslationOptions} options - The options to interpolate.\n * @returns - The decoded and interpolated message.\n *\n * @note This function is useful as a placeholder when for incrementally migrating to the m() function.\n * @example\n * // A backwards compatible translation function\n * function getMessage(gt: GTFunctionType = gtFallback) {\n *   return gt('Hello, world!');\n * }\n *\n * // Here i18n has been implemented\n * function WithTranslation() {\n *   const gt = useGT();\n *   return <>{getMessage(gt)}</>;\n * }\n *\n *\n * // i18n has not yet been implemented yet\n * function WithoutTranslations() {\n *   return <>{getMessage()}</>;\n * }\n */\nexport const gtFallback: GTFunctionType = <T extends string | null | undefined>(\n  message: T,\n  options: GTTranslationOptions = {}\n): T extends string ? string : T => {\n  return interpolateIcuMessage(message, options);\n};\n","import { decodeMsg } from '../msg/decodeMsg';\nimport { GTTranslationOptions } from '../types/options';\nimport { MFunctionType } from '../types/functions';\nimport { decodeOptions } from '../msg/decodeOptions';\nimport { isEncodedTranslationOptions } from '../utils/isEncodedTranslationOptions';\nimport { interpolateIcuMessage } from '../utils/interpolation/interpolateIcuMessage';\n\n/**\n * A fallback function for the m() function that decodes and interpolates.\n * @param {string | null | undefined} encodedMsg - The encoded message to decode and interpolate.\n * @param {GTTranslationOptions} options - The options to interpolate.\n * @returns - The decoded and interpolated message.\n *\n * @note This function is useful as a placeholder when for incrementally migrating to the m() function.\n * @example\n * // A backwards compatible translation function\n * function getMessage(m: MFunctionType = mFallback) {\n *   return m(msg('Hello, world!'));\n * }\n *\n * // Here i18n has been implemented\n * function WithTranslation() {\n *   const m = useMessages();\n *   return <>{getMessage(m)}</>;\n * }\n *\n *\n * // i18n has not yet been implemented yet\n * function WithoutTranslations() {\n *   return <>{getMessage()}</>;\n * }\n */\nexport const mFallback: MFunctionType = <T extends string | null | undefined>(\n  encodedMsg: T,\n  options: GTTranslationOptions = {}\n): T extends string ? string : T => {\n  // Return if the encoded message is null or undefined\n  if (!encodedMsg) return encodedMsg as T extends string ? string : T;\n\n  // Get any encoded options\n  const decodedOptions = decodeOptions(encodedMsg) ?? {};\n\n  // Return early if string already interpolated eg: mFallback(msg('Hello, {name}!', { name: 'Brian' }))\n  if (isEncodedTranslationOptions(decodedOptions)) {\n    // This is an encoded string, msg already interpolated, just return decoded string\n    return decodeMsg(encodedMsg) as T extends string ? string : T;\n  }\n\n  // Not using decoded options to match behavior in @gt/react-core\n  return interpolateIcuMessage(encodedMsg, options);\n};\n"],"mappings":";;;;;;;;;;;;;AAcA,MAAa,KACX,kBACA,GAAG,WACA;AACH,KAAI,OAAO,qBAAqB,UAAU;EACxC,MAAM,UAAU,OAAO,GAAG,EAAE;EAC5B,MAAM,iBAAiB,2BAA2B;AAIlD,SAAO,iCAHQ,eAAe,eAAe,GACxC,SAAS,WAAW,eAAe,WAAW,GAC/C,kBAAkB,EAC0B,kBAAkB;GAChE,SAAS;GACT,GAAG;GACJ,CAAC;;AAGJ,QAAO,uCAAuC,kBAAkB,OAAO;;AAGzE,SAAS,uCACP,kBACA,QACQ;CACR,MAAM,iBAAiB,2BAA2B;CAClD,MAAM,SAAS,eAAe,eAAe,GACzC,eAAe,WAAW,GAC1B,kBAAkB;CAItB,MAAM,iCAAiC,qBACrC,QAJ2B,iBAC1B,KAAK,QAAQ,UAAU,UAAU,OAAO,UAAU,IAAI,CACtD,KAAK,GAGc,EACpB,EAAE,SAAS,OAAO,CACnB;AACD,KAAI,mCAAmC,KAAA,EACrC,QAAO;CAGT,MAAM,EAAE,SAAS,cAAc,4BAC7B,kBACA,OACD;AACD,QAAO,iCAAiC,QAAQ,SAAS;EACvD,SAAS;EACT,GAAG;EACJ,CAAC;;AAGJ,SAAS,4BACP,SACA,QAIA;CACA,MAAM,QAAkB,EAAE;CAC1B,MAAM,YAAqC,EAAE;CAC7C,IAAI,WAAW;AAEf,MAAK,IAAI,IAAI,GAAG,IAAI,QAAQ,QAAQ,KAAK;AACvC,QAAM,KAAK,QAAQ,GAAG;AAEtB,MAAI,IAAI,OAAO,QAAQ;GACrB,MAAM,MAAM,SAAS,UAAU;AAC/B,SAAM,KAAK,IAAI,IAAI,GAAG;AACtB,aAAU,OAAO,OAAO;AACxB;;;AAIJ,QAAO;EACL,SAAS,MAAM,KAAK,GAAG;EACvB;EACD;;;;AChCH,SAAgB,IACd,SACA,SACsB;AACtB,KAAI,SAAS,YAAY,SAAU,QAAO,UAAU,SAAS,QAAQ;AAGrE,KAAI,OAAO,YAAY,UAAU;AAC/B,MAAI,CAAC,QAAS,QAAO;AACrB,SAAO,QAAQ,KAAK,GAAG,MACrB,IAAI,GAAG;GACL,GAAG;GAEH,GAAI,QAAQ,OAAO,EAAE,KAAK,GAAG,QAAQ,IAAI,GAAG,KAAK;GAClD,CAAC,CACH;;AAGH,KAAI,CAAC,QACH,QAAO;CAGT,MAAM,YAAY,iBAAiB,QAAQ;CAC3C,IAAI;AACJ,KAAI;AACF,uBAAqB,cAAc,SAAS;GAC1C,SAAS,CAAC,qBAAqB;GAC/B,WAAW;IACT,GAAG;KACF,iBAAiB;IACnB;GACF,CAAC;SACI;AACN,iBAAO,KAAK,kCAAkC,QAAQ,CAAC;AACvD,SAAO;;CAIT,MAAM,WAAW;CACjB,MAAM,SACJ,QAAQ,UACR,YAAY,SAAS;EACnB,SAAS;EACT,GAAG;EACJ,CAAC;CAEJ,MAAM,iBAA4C;EAChD,GAAG;EACH;EACA;EACD;AACD,QAAO,UAAU,oBAAoB,eAAe;;;;AC/FtD,SAAgB,UACd,YACY;AACZ,KAAI,OAAO,eAAe,YAAY,WAAW,YAAY,IAAI,KAAK,GACpE,QAAO,WAAW,MAAM,GAAG,WAAW,YAAY,IAAI,CAAC;AAEzD,QAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACWT,MAAa,cACX,SACA,UAAgC,EAAE,KACA;AAClC,QAAO,sBAAsB,SAAS,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACDhD,MAAa,aACX,YACA,UAAgC,EAAE,KACA;AAElC,KAAI,CAAC,WAAY,QAAO;AAMxB,KAAI,4BAHmB,cAAc,WAAW,IAAI,EAAE,CAGP,CAE7C,QAAO,UAAU,WAAW;AAI9B,QAAO,sBAAsB,YAAY,QAAQ"}

package/dist/internal-cookies.cjs

@@ -0,0 +1,51 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_request = require("./request-B4J2mLiA.cjs");
+//#region src/utils/cookieNames.ts
+/** Cookie name for tracking the user's selected locale. */
+const defaultLocaleCookieName = "generaltranslation.locale";
+/** Cookie name for tracking the user's selected region. */
+const defaultRegionCookieName = "generaltranslation.region";
+/** Cookie name for persisting the enable-i18n feature flag. */
+const defaultEnableI18nCookieName = "generaltranslation.enable-i18n";
+/** Cookie name for tracking an explicit locale reset. */
+const defaultResetLocaleCookieName = "generaltranslation.locale-reset";
+//#endregion
+//#region src/utils/browserCookies.ts
+/**
+* Reads and decodes a browser cookie without accessing `document` during SSR.
+*
+* @param cookieName - Exact cookie name to read.
+* @returns The decoded cookie value, or `undefined` outside a browser or when
+* the cookie is absent.
+*/
+function getBrowserCookieValue(cookieName) {
+	const cookieDocument = getCookieDocument();
+	return cookieDocument ? require_request.getCookieValue(cookieDocument.cookie, cookieName) : void 0;
+}
+/**
+* Writes a path-wide browser session cookie without accessing `document`
+* during SSR.
+*
+* The serialized form intentionally matches the existing GT React browser
+* store so all web runtimes share the same cookie contract.
+*
+* @param cookieName - Cookie name to write.
+* @param value - Raw cookie value to persist.
+*/
+function setBrowserCookieValue(cookieName, value) {
+	const cookieDocument = getCookieDocument();
+	if (cookieDocument) cookieDocument.cookie = `${cookieName}=${value};path=/`;
+}
+function getCookieDocument() {
+	return globalThis.document;
+}
+//#endregion
+exports.defaultEnableI18nCookieName = defaultEnableI18nCookieName;
+exports.defaultLocaleCookieName = defaultLocaleCookieName;
+exports.defaultRegionCookieName = defaultRegionCookieName;
+exports.defaultResetLocaleCookieName = defaultResetLocaleCookieName;
+exports.getBrowserCookieValue = getBrowserCookieValue;
+exports.getCookieValue = require_request.getCookieValue;
+exports.setBrowserCookieValue = setBrowserCookieValue;
+
+//# sourceMappingURL=internal-cookies.cjs.map

package/dist/internal-cookies.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"internal-cookies.cjs","names":["getCookieValue"],"sources":["../src/utils/cookieNames.ts","../src/utils/browserCookies.ts"],"sourcesContent":["/** Cookie name for tracking the user's selected locale. */\nexport const defaultLocaleCookieName = 'generaltranslation.locale';\n\n/** Cookie name for tracking the user's selected region. */\nexport const defaultRegionCookieName = 'generaltranslation.region';\n\n/** Cookie name for persisting the enable-i18n feature flag. */\nexport const defaultEnableI18nCookieName = 'generaltranslation.enable-i18n';\n\n/** Cookie name for tracking an explicit locale reset. */\nexport const defaultResetLocaleCookieName = 'generaltranslation.locale-reset';\n","import { getCookieValue } from './request';\n\ntype CookieDocument = {\n  cookie: string;\n};\n\n/**\n * Reads and decodes a browser cookie without accessing `document` during SSR.\n *\n * @param cookieName - Exact cookie name to read.\n * @returns The decoded cookie value, or `undefined` outside a browser or when\n * the cookie is absent.\n */\nexport function getBrowserCookieValue(cookieName: string): string | undefined {\n  const cookieDocument = getCookieDocument();\n  return cookieDocument\n    ? getCookieValue(cookieDocument.cookie, cookieName)\n    : undefined;\n}\n\n/**\n * Writes a path-wide browser session cookie without accessing `document`\n * during SSR.\n *\n * The serialized form intentionally matches the existing GT React browser\n * store so all web runtimes share the same cookie contract.\n *\n * @param cookieName - Cookie name to write.\n * @param value - Raw cookie value to persist.\n */\nexport function setBrowserCookieValue(cookieName: string, value: string): void {\n  const cookieDocument = getCookieDocument();\n  if (cookieDocument) {\n    cookieDocument.cookie = `${cookieName}=${value};path=/`;\n  }\n}\n\nfunction getCookieDocument(): CookieDocument | undefined {\n  return (\n    globalThis as typeof globalThis & {\n      document?: CookieDocument;\n    }\n  ).document;\n}\n"],"mappings":";;;;AACA,MAAa,0BAA0B;;AAGvC,MAAa,0BAA0B;;AAGvC,MAAa,8BAA8B;;AAG3C,MAAa,+BAA+B;;;;;;;;;;ACG5C,SAAgB,sBAAsB,YAAwC;CAC5E,MAAM,iBAAiB,mBAAmB;AAC1C,QAAO,iBACHA,gBAAAA,eAAe,eAAe,QAAQ,WAAW,GACjD,KAAA;;;;;;;;;;;;AAaN,SAAgB,sBAAsB,YAAoB,OAAqB;CAC7E,MAAM,iBAAiB,mBAAmB;AAC1C,KAAI,eACF,gBAAe,SAAS,GAAG,WAAW,GAAG,MAAM;;AAInD,SAAS,oBAAgD;AACvD,QACE,WAGA"}

package/dist/internal-cookies.d.cts

@@ -0,0 +1,35 @@
+import { t as getCookieValue } from "./request-B7giWTEv.cjs";
+
+//#region src/utils/cookieNames.d.ts
+/** Cookie name for tracking the user's selected locale. */
+declare const defaultLocaleCookieName = "generaltranslation.locale";
+/** Cookie name for tracking the user's selected region. */
+declare const defaultRegionCookieName = "generaltranslation.region";
+/** Cookie name for persisting the enable-i18n feature flag. */
+declare const defaultEnableI18nCookieName = "generaltranslation.enable-i18n";
+/** Cookie name for tracking an explicit locale reset. */
+declare const defaultResetLocaleCookieName = "generaltranslation.locale-reset";
+//#endregion
+//#region src/utils/browserCookies.d.ts
+/**
+ * Reads and decodes a browser cookie without accessing `document` during SSR.
+ *
+ * @param cookieName - Exact cookie name to read.
+ * @returns The decoded cookie value, or `undefined` outside a browser or when
+ * the cookie is absent.
+ */
+declare function getBrowserCookieValue(cookieName: string): string | undefined;
+/**
+ * Writes a path-wide browser session cookie without accessing `document`
+ * during SSR.
+ *
+ * The serialized form intentionally matches the existing GT React browser
+ * store so all web runtimes share the same cookie contract.
+ *
+ * @param cookieName - Cookie name to write.
+ * @param value - Raw cookie value to persist.
+ */
+declare function setBrowserCookieValue(cookieName: string, value: string): void;
+//#endregion
+export { defaultEnableI18nCookieName, defaultLocaleCookieName, defaultRegionCookieName, defaultResetLocaleCookieName, getBrowserCookieValue, getCookieValue, setBrowserCookieValue };
+//# sourceMappingURL=internal-cookies.d.cts.map

package/dist/internal-cookies.d.mts

@@ -0,0 +1,35 @@
+import { t as getCookieValue } from "./request-Bs7NclA3.mjs";
+
+//#region src/utils/cookieNames.d.ts
+/** Cookie name for tracking the user's selected locale. */
+declare const defaultLocaleCookieName = "generaltranslation.locale";
+/** Cookie name for tracking the user's selected region. */
+declare const defaultRegionCookieName = "generaltranslation.region";
+/** Cookie name for persisting the enable-i18n feature flag. */
+declare const defaultEnableI18nCookieName = "generaltranslation.enable-i18n";
+/** Cookie name for tracking an explicit locale reset. */
+declare const defaultResetLocaleCookieName = "generaltranslation.locale-reset";
+//#endregion
+//#region src/utils/browserCookies.d.ts
+/**
+ * Reads and decodes a browser cookie without accessing `document` during SSR.
+ *
+ * @param cookieName - Exact cookie name to read.
+ * @returns The decoded cookie value, or `undefined` outside a browser or when
+ * the cookie is absent.
+ */
+declare function getBrowserCookieValue(cookieName: string): string | undefined;
+/**
+ * Writes a path-wide browser session cookie without accessing `document`
+ * during SSR.
+ *
+ * The serialized form intentionally matches the existing GT React browser
+ * store so all web runtimes share the same cookie contract.
+ *
+ * @param cookieName - Cookie name to write.
+ * @param value - Raw cookie value to persist.
+ */
+declare function setBrowserCookieValue(cookieName: string, value: string): void;
+//#endregion
+export { defaultEnableI18nCookieName, defaultLocaleCookieName, defaultRegionCookieName, defaultResetLocaleCookieName, getBrowserCookieValue, getCookieValue, setBrowserCookieValue };
+//# sourceMappingURL=internal-cookies.d.mts.map