gt-react 10.3.2-alpha.3 → 10.4.0

package/dist/client.d.ts

@@ -38,6 +38,7 @@ type InlineTranslationOptions = DictionaryTranslationOptions & {
     $context?: string;
     $id?: string;
     $_hash?: string;
+    $_source?: string;
 };
 type VariableProps = {
     variableType: VariableType;
@@ -78,6 +79,7 @@ type GTContextType = {
     registerIcuForTranslation: TranslateIcuCallback;
     registerJsxForTranslation: TranslateChildrenCallback;
     _tFunction: (message: string, options?: InlineTranslationOptions, preloadedTranslations?: Translations) => string;
+    _mFunction: (message: string, options?: Record<string, any>, preloadedTranslations?: Translations) => string;
     _filterMessagesForPreload: (_messages: _Messages) => _Messages;
     _preloadMessages: (_messages: _Messages) => Promise<Translations>;
     _dictionaryFunction: (id: string, options?: DictionaryTranslationOptions) => string;
@@ -121,6 +123,47 @@ defaultLocale, runtimeUrl, renderSettings, setTranslations, ...additionalMetadat
 
 declare const renderVariable: RenderVariable;
 
+/**
+ * Encodes content into a message that contains important translation metadata
+ * @param message The message to encode.
+ * @param options The options to encode.
+ * @returns The encoded message.
+ *
+ * @note - Message format
+ * A message is broken into two parts separated by colons:
+ * - interpolated content - the content with interpolated variables
+ * - hash + options - a unique identifier for the source content and options for the translation
+ *
+ * @example - Basic usage
+ *
+ * ```jsx
+ * import { msg } from 'gt-react';
+ * const message = msg('Hello, {name}!', { name: 'Brian' });
+ * console.log(message); // "Hello, Brian:eyIkX2hhc2giOiAiMHgxMjMiLCAiJF9zb3VyY2UiOiAiSGVsbG8sIHtuYW1lfSEiLCAibmFtZSI6ICJCcmlhbiJ9"
+ * ```
+ * eyIkX2hhc2giOiAiMHgxMjMiLCAiJF9zb3VyY2UiOiAiSGVsbG8sIHtuYW1lfSEiLCAibmFtZSI6ICJCcmlhbiJ9
+ * encodes to {"$_hash": "0x123", "$_source": "Hello, {name}!", "name": "Brian"}
+ *
+ */
+declare function msg(message: string, options?: InlineTranslationOptions): string;
+/**
+ * Extracts the original interpolated message string.
+ * If the message cannot be decoded (i.e., it does not contain a colon separator),
+ * the input is returned as-is.
+ * @param encodedMsg The message to decode.
+ * @returns The decoded message, or the input if it cannot be decoded.
+ */
+declare function decodeMsg(encodedMsg: string): string;
+/**
+ * Decodes the options from an encoded message.
+ * @param encodedMsg The message to decode.
+ * @returns The decoded options.
+ */
+declare function decodeOptions(encodedMsg: string): ({
+    $_source: string;
+    $_hash: string;
+} & InlineTranslationOptions) | null;
+
 type GTConfig = {
     projectId?: string;
     devApiKey?: string;
@@ -268,7 +311,7 @@ declare namespace Plural {
 /**
  * Gets the translation function `t` provided by `<GTProvider>`.
  *
- * @returns {Function} A translation function that accepts a key string and returns the translated value.
+ * @returns {Function} A translation function that accepts an ICU message format string and returns the translation of that string.
  *
  * @example
  * const t = useGT();
@@ -276,12 +319,7 @@ declare namespace Plural {
  *
  * @example
  * const t = useGT();
- * return (<>
- *  {
- *     t('My name is {customName}', { customName: "Brian", id: 'my-name', context: 'a proper noun' } )
- *  }
- * </>);
- *
+ * t('My name is {customName}', { customName: "Brian", id: 'my-name', context: 'a proper noun' } )
  */
 declare function useGT(_messages?: _Messages): (string: string, options?: Record<string, any> & {
     $id?: string;
@@ -739,4 +777,21 @@ declare function useRegionSelector({ regions: _regions, customMapping, prioritiz
  */
 declare function useLocaleDirection(locale?: string): 'ltr' | 'rtl';
 
-export { Branch, ClientProvider, Currency, DateTime, GTContext, GTProvider, LocaleSelector, Num, Plural, RegionSelector, T, Var, renderVariable, useDefaultLocale, useGT, useGTClass, useLocale, useLocaleDirection, useLocaleProperties, useLocaleSelector, useLocales, useRegion, useRegionSelector, useRuntimeTranslation, useSetLocale, useTranslations };
+/**
+ * Gets the message decoding and translation function `m` provided by `<GTProvider>`.
+ *
+ * @returns {Function} A translation function that accepts an encoded message, decodes it, and returns the translated value.
+ *
+ * @example
+ * const encodedMessage = msg("Hello, world")
+ * const m = useMessages();
+ * m(encodedMessage) // returns "Hello, world" translated
+ *
+ * @example
+ * const encodedMessage = msg("My name is {name}", { name: "Brian" });
+ * const m = useMessages();
+ * m(encodedMessage) // returns "My name is Brian" translated
+ */
+declare function useMessages(_messages?: _Messages): (encodedMsg: string, options?: Record<string, any>) => string;
+
+export { Branch, ClientProvider, Currency, DateTime, GTContext, GTProvider, LocaleSelector, Num, Plural, RegionSelector, T, Var, decodeMsg, decodeOptions, msg, renderVariable, useDefaultLocale, useGT, useGTClass, useLocale, useLocaleDirection, useLocaleProperties, useLocaleSelector, useLocales, useMessages, useRegion, useRegionSelector, useRuntimeTranslation, useSetLocale, useTranslations };

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,qBAAqB,MAAM,wCAAwC,CAAC;AAC3E,OAAO,cAAc,MAAM,4BAA4B,CAAC;AACxD,OAAO,cAAc,MAAM,2BAA2B,CAAC;AACvD,OAAO,MAAM,MAAM,mBAAmB,CAAC;AACvC,OAAO,MAAM,MAAM,2BAA2B,CAAC;AAC/C,OAAO,KAAK,MAAM,2BAA2B,CAAC;AAC9C,OAAO,gBAAgB,MAAM,0BAA0B,CAAC;AACxD,OAAO,eAAe,MAAM,qCAAqC,CAAC;AAClE,OAAO,SAAS,MAAM,mBAAmB,CAAC;AAC1C,OAAO,CAAC,MAAM,wBAAwB,CAAC;AACvC,OAAO,QAAQ,MAAM,sBAAsB,CAAC;AAC5C,OAAO,QAAQ,MAAM,sBAAsB,CAAC;AAC5C,OAAO,GAAG,MAAM,iBAAiB,CAAC;AAClC,OAAO,GAAG,MAAM,iBAAiB,CAAC;AAClC,OAAO,cAAc,MAAM,qBAAqB,CAAC;AACjD,OAAO,cAAc,MAAM,qBAAqB,CAAC;AACjD,OAAO,UAAU,MAAM,uBAAuB,CAAC;AAC/C,OAAO,YAAY,MAAM,sBAAsB,CAAC;AAChD,OAAO,UAAU,MAAM,oBAAoB,CAAC;AAC5C,OAAO,iBAAiB,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACrE,OAAO,SAAS,MAAM,mBAAmB,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAEhE,OAAO,EACL,SAAS,EACT,UAAU,EACV,qBAAqB,EACrB,cAAc,EACd,cAAc,EACd,KAAK,EACL,eAAe,EACf,gBAAgB,EAChB,SAAS,EACT,UAAU,EACV,YAAY,EACZ,iBAAiB,EACjB,SAAS,EACT,iBAAiB,EACjB,UAAU,EACV,mBAAmB,EACnB,kBAAkB,EAClB,CAAC,EACD,GAAG,EACH,GAAG,EACH,QAAQ,EACR,QAAQ,EACR,MAAM,EACN,MAAM,EACN,cAAc,EACd,cAAc,GACf,CAAC"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,qBAAqB,MAAM,wCAAwC,CAAC;AAC3E,OAAO,cAAc,MAAM,4BAA4B,CAAC;AACxD,OAAO,cAAc,MAAM,2BAA2B,CAAC;AACvD,OAAO,MAAM,MAAM,mBAAmB,CAAC;AACvC,OAAO,MAAM,MAAM,2BAA2B,CAAC;AAC/C,OAAO,KAAK,MAAM,2BAA2B,CAAC;AAC9C,OAAO,gBAAgB,MAAM,0BAA0B,CAAC;AACxD,OAAO,eAAe,MAAM,qCAAqC,CAAC;AAClE,OAAO,SAAS,MAAM,mBAAmB,CAAC;AAC1C,OAAO,CAAC,MAAM,wBAAwB,CAAC;AACvC,OAAO,QAAQ,MAAM,sBAAsB,CAAC;AAC5C,OAAO,QAAQ,MAAM,sBAAsB,CAAC;AAC5C,OAAO,GAAG,MAAM,iBAAiB,CAAC;AAClC,OAAO,GAAG,MAAM,iBAAiB,CAAC;AAClC,OAAO,cAAc,MAAM,qBAAqB,CAAC;AACjD,OAAO,cAAc,MAAM,qBAAqB,CAAC;AACjD,OAAO,UAAU,MAAM,uBAAuB,CAAC;AAC/C,OAAO,YAAY,MAAM,sBAAsB,CAAC;AAChD,OAAO,UAAU,MAAM,oBAAoB,CAAC;AAC5C,OAAO,iBAAiB,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACrE,OAAO,SAAS,MAAM,mBAAmB,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpE,OAAO,WAAW,MAAM,iCAAiC,CAAC;AAE1D,OAAO,EACL,SAAS,EACT,UAAU,EACV,qBAAqB,EACrB,cAAc,EACd,cAAc,EACd,KAAK,EACL,eAAe,EACf,gBAAgB,EAChB,SAAS,EACT,UAAU,EACV,YAAY,EACZ,iBAAiB,EACjB,SAAS,EACT,iBAAiB,EACjB,UAAU,EACV,mBAAmB,EACnB,kBAAkB,EAClB,GAAG,EACH,SAAS,EACT,aAAa,EACb,WAAW,EACX,CAAC,EACD,GAAG,EACH,GAAG,EACH,QAAQ,EACR,QAAQ,EACR,MAAM,EACN,MAAM,EACN,cAAc,EACd,cAAc,GACf,CAAC"}