@generaltranslation/react-core 1.0.3 → 1.0.5

package/dist/messages/messages.d.ts

@@ -22,7 +22,38 @@ export declare function icuMessageContainsVariables(message: string): boolean;
  * encodes to {"$_hash": "0x123", "$_source": "Hello, {name}!", "name": "Brian"}
  *
  */
-export declare function msg(message: string, options?: InlineTranslationOptions): string;
+/**
+ * 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}!');
+ * console.log(message); // "Hello, {name}!"
+ * ```
+ *
+ * @example - Usage with options
+ *
+ * ```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"}
+ *
+ */
+export declare function msg<T extends string>(message: T): T;
+export declare function msg<T extends string>(message: T, options: InlineTranslationOptions): string;
 /**
  * Extracts the original interpolated message string.
  * If the message cannot be decoded (i.e., it does not contain a colon separator),

package/dist/messages/messages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../src/messages/messages.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAI9D,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAiDpE;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,GAAG,CACjB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,wBAAwB,GACjC,MAAM,CAuCR;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,SAAS,EAC3D,UAAU,EAAE,CAAC,GACZ,CAAC,CAKH;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,UAAU,EAAE,MAAM,GAC5C,CAAC;IACC,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;CAChB,GAAG,wBAAwB,CAAC,GAC7B,IAAI,CAeP"}
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../src/messages/messages.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAI9D,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAiDpE;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,GAAG,CAAC,CAAC,SAAS,MAAM,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;AACrD,wBAAgB,GAAG,CAAC,CAAC,SAAS,MAAM,EAClC,OAAO,EAAE,CAAC,EACV,OAAO,EAAE,wBAAwB,GAChC,MAAM,CAAC;AAuCV;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,SAAS,EAC3D,UAAU,EAAE,CAAC,GACZ,CAAC,CAKH;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,UAAU,EAAE,MAAM,GAC5C,CAAC;IACC,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;CAChB,GAAG,wBAAwB,CAAC,GAC7B,IAAI,CAeP"}

package/dist/provider/hooks/translation/useCreateInternalUseGTFunction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useCreateInternalUseGTFunction.d.ts","sourceRoot":"","sources":["../../../../src/provider/hooks/translation/useCreateInternalUseGTFunction.ts"],"names":[],"mappings":"AACA,OAAO,EACL,wBAAwB,EACxB,YAAY,EACZ,SAAS,EAEV,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AASxC,MAAM,CAAC,OAAO,UAAU,8BAA8B,CAAC,EACrD,EAAE,EACF,YAAY,EACZ,MAAM,EACN,aAAa,EACb,mBAAmB,EACnB,qBAAqB,EACrB,yBAAyB,GAC1B,EAAE;IACD,EAAE,EAAE,EAAE,CAAC;IACP,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;IACtB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,qBAAqB,EAAE,OAAO,CAAC;IAC/B,yBAAyB,EAAE,oBAAoB,CAAC;CACjD,GAAG;IACF,UAAU,EAAE,CACV,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,wBAAwB,EAClC,qBAAqB,CAAC,EAAE,YAAY,KACjC,MAAM,CAAC;IACZ,UAAU,EAAE,CAAC,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,SAAS,EAC9C,OAAO,EAAE,CAAC,EACV,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC7B,qBAAqB,CAAC,EAAE,YAAY,KACjC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,CAAC,CAAC;IACnC,yBAAyB,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,SAAS,CAAC;IAC/D,gBAAgB,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;CACnE,CAkSA"}
+{"version":3,"file":"useCreateInternalUseGTFunction.d.ts","sourceRoot":"","sources":["../../../../src/provider/hooks/translation/useCreateInternalUseGTFunction.ts"],"names":[],"mappings":"AACA,OAAO,EACL,wBAAwB,EACxB,YAAY,EACZ,SAAS,EAEV,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AASxC,MAAM,CAAC,OAAO,UAAU,8BAA8B,CAAC,EACrD,EAAE,EACF,YAAY,EACZ,MAAM,EACN,aAAa,EACb,mBAAmB,EACnB,qBAAqB,EACrB,yBAAyB,GAC1B,EAAE;IACD,EAAE,EAAE,EAAE,CAAC;IACP,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;IACtB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,qBAAqB,EAAE,OAAO,CAAC;IAC/B,yBAAyB,EAAE,oBAAoB,CAAC;CACjD,GAAG;IACF,UAAU,EAAE,CACV,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,wBAAwB,EAClC,qBAAqB,CAAC,EAAE,YAAY,KACjC,MAAM,CAAC;IACZ,UAAU,EAAE,CAAC,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,SAAS,EAC9C,OAAO,EAAE,CAAC,EACV,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC7B,qBAAqB,CAAC,EAAE,YAAY,KACjC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,CAAC,CAAC;IACnC,yBAAyB,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,SAAS,CAAC;IAC/D,gBAAgB,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;CACnE,CAqSA"}

package/dist/translation/hooks/useGT.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useGT.d.ts","sourceRoot":"","sources":["../../../src/translation/hooks/useGT.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAgB,MAAM,uBAAuB,CAAC;AAKhE;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,OAAO,UAAU,KAAK,CAAC,SAAS,CAAC,EAAE,SAAS,YAmCvC,MAAM,YACL,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IAC7B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,KACA,MAAM,CAmBV"}
+{"version":3,"file":"useGT.d.ts","sourceRoot":"","sources":["../../../src/translation/hooks/useGT.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAgB,MAAM,uBAAuB,CAAC;AAKhE;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,OAAO,UAAU,KAAK,CAAC,SAAS,CAAC,EAAE,SAAS,YA8BvC,MAAM,YACL,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IAC7B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,KACA,MAAM,CAmBV"}

package/dist/translation/hooks/useMessages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useMessages.d.ts","sourceRoot":"","sources":["../../../src/translation/hooks/useMessages.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAgB,MAAM,uBAAuB,CAAC;AAGhE,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAGtD;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,OAAO,UAAU,WAAW,CAAC,SAAS,CAAC,EAAE,SAAS,GAAG,aAAa,CA4DxE"}
+{"version":3,"file":"useMessages.d.ts","sourceRoot":"","sources":["../../../src/translation/hooks/useMessages.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAgB,MAAM,uBAAuB,CAAC;AAEhE,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAItD;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,OAAO,UAAU,WAAW,CAAC,SAAS,CAAC,EAAE,SAAS,GAAG,aAAa,CAuDxE"}

package/dist/translation/inline/T.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"T.d.ts","sourceRoot":"","sources":["../../../src/translation/inline/T.tsx"],"names":[],"mappings":"AAAA,OAAO,KAA8B,MAAM,OAAO,CAAC;AAgBnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,iBAAS,CAAC,CAAC,EACT,QAAQ,EACR,EAAE,EACF,OAAO,EACP,KAAK,EACL,GAAG,OAAO,EACX,EAAE;IACD,QAAQ,EAAE,GAAG,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,GAAG,SAAS,CAiKhC;kBA7KQ,CAAC;;;AAiLV,eAAe,CAAC,CAAC"}
+{"version":3,"file":"T.d.ts","sourceRoot":"","sources":["../../../src/translation/inline/T.tsx"],"names":[],"mappings":"AAAA,OAAO,KAA8B,MAAM,OAAO,CAAC;AAanD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,iBAAS,CAAC,CAAC,EACT,QAAQ,EACR,EAAE,EACF,OAAO,EACP,KAAK,EACL,GAAG,OAAO,EACX,EAAE;IACD,QAAQ,EAAE,GAAG,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,GAAG,SAAS,CAiKhC;kBA7KQ,CAAC;;;AAiLV,eAAe,CAAC,CAAC"}

package/dist/utils/use.d.ts

@@ -0,0 +1,4 @@
+import * as React from 'react';
+declare let reactUse: typeof React.use | undefined;
+export default reactUse;
+//# sourceMappingURL=use.d.ts.map

package/dist/utils/use.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use.d.ts","sourceRoot":"","sources":["../../src/utils/use.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAM/B,QAAA,IAAI,QAAQ,EAAE,OAAO,KAAK,CAAC,GAAG,GAAG,SAAS,CAAC;AAY3C,eAAe,QAAQ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@generaltranslation/react-core",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "A pure React library for internationalization",
   "main": "./dist/index.cjs.min.cjs",
   "module": "./dist/index.esm.min.mjs",