@generaltranslation/react-core 0.0.0 → 0.0.1-alpha.0

package/LICENSE.md

@@ -0,0 +1,105 @@
+# Functional Source License, Version 1.1, ALv2 Future License
+
+## Abbreviation
+
+FSL-1.1-ALv2
+
+## Notice
+
+Copyright 2025 General Translation, Inc.
+
+## Terms and Conditions
+
+### Licensor ("We")
+
+The party offering the Software under these Terms and Conditions.
+
+### The Software
+
+The "Software" is each version of the software that we make available under
+these Terms and Conditions, as indicated by our inclusion of these Terms and
+Conditions with the Software.
+
+### License Grant
+
+Subject to your compliance with this License Grant and the Patents,
+Redistribution and Trademark clauses below, we hereby grant you the right to
+use, copy, modify, create derivative works, publicly perform, publicly display
+and redistribute the Software for any Permitted Purpose identified below.
+
+### Permitted Purpose
+
+A Permitted Purpose is any purpose other than a Competing Use. A Competing Use
+means making the Software available to others in a commercial product or
+service that:
+
+1. substitutes for the Software;
+
+2. substitutes for any other product or service we offer using the Software
+   that exists as of the date we make the Software available; or
+
+3. offers the same or substantially similar functionality as the Software.
+
+Permitted Purposes specifically include using the Software:
+
+1. for your internal use and access;
+
+2. for non-commercial education;
+
+3. for non-commercial research; and
+
+4. in connection with professional services that you provide to a licensee
+   using the Software in accordance with these Terms and Conditions.
+
+### Patents
+
+To the extent your use for a Permitted Purpose would necessarily infringe our
+patents, the license grant above includes a license under our patents. If you
+make a claim against any party that the Software infringes or contributes to
+the infringement of any patent, then your patent license to the Software ends
+immediately.
+
+### Redistribution
+
+The Terms and Conditions apply to all copies, modifications and derivatives of
+the Software.
+
+If you redistribute any copies, modifications or derivatives of the Software,
+you must include a copy of or a link to these Terms and Conditions and not
+remove any copyright notices provided in or with the Software.
+
+### Disclaimer
+
+THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR
+PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
+
+IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE
+SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES,
+EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
+
+### Trademarks
+
+Except for displaying the License Details and identifying us as the origin of
+the Software, you have no right under these Terms and Conditions to use our
+trademarks, trade names, service marks or product names.
+
+## Grant of Future License
+
+We hereby irrevocably grant you an additional license to use the Software under
+the Apache License, Version 2.0 that is effective on the second anniversary of
+the date we make the Software available. On or after that date, you may use the
+Software under the Apache License, Version 2.0, in which case the following
+will apply:
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this file except in compliance with the License.
+
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed
+under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.

package/README.md

@@ -0,0 +1,9 @@
+<p align="center">
+  <a href="https://generaltranslation.com" target="_blank">
+    <img src="https://generaltranslation.com/gt-logo-light.svg" alt="General Translation" width="100" height="100">
+  </a>
+</p>
+
+# @generaltranslation/react-core
+
+A pure React library for internationalization

package/dist/branches/Branch.d.ts

@@ -0,0 +1,34 @@
+/**
+ * The `<Branch>` component dynamically renders a specified branch of content or a fallback child component.
+ * It allows for flexible content switching based on the `branch` prop and an object of possible branches (`...branches`).
+ * If the specified `branch` is present in the `branches` object, it renders the content of that branch.
+ * If the `branch` is not found, it renders the provided `children` as fallback content.
+ *
+ * @example
+ * ```jsx
+ * <Branch
+ *  branch="summary"
+ * summary={<p>This is a summary</p>}
+ * details={<p>Details here</p>}
+ * >
+ *   <p>Fallback content</p>
+ * </Branch>
+ * ```
+ * If the `branch` prop is set to `"summary"`, it will render `<p>This is a summary</p>`. If the `branch` is not set or does not match any keys in the branches object, it renders the fallback content `<p>Fallback content</p>`.
+ *
+ * @param {any} [children] - Fallback content to render if no matching branch is found.
+ * @param {any} [name="branch"] - Optional name for the component, used for metadata or tracking purposes.
+ * @param {string} [branch] - The name of the branch to render. The component looks for this key in the `...branches` object.
+ * @param {...{[key: string]: any}} [branches] - A spread object containing possible branches as keys and their corresponding content as values.
+ * @returns {React.JSX.Element} The rendered branch or fallback content.
+ */
+declare function Branch({ children, branch, ...branches }: {
+    children?: any;
+    branch?: string | number | boolean;
+    [key: string]: any;
+}): React.JSX.Element;
+declare namespace Branch {
+    var _gtt: string;
+}
+export default Branch;
+//# sourceMappingURL=Branch.d.ts.map

package/dist/branches/Branch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Branch.d.ts","sourceRoot":"","sources":["../../src/branches/Branch.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,iBAAS,MAAM,CAAC,EACd,QAAQ,EACR,MAAM,EACN,GAAG,QAAQ,EACZ,EAAE;IACD,QAAQ,CAAC,EAAE,GAAG,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IACnC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAOpB;kBAfQ,MAAM;;;AAkBf,eAAe,MAAM,CAAC"}

package/dist/branches/plurals/Plural.d.ts

@@ -0,0 +1,38 @@
+/**
+ * The `<Plural>` component dynamically renders content based on the plural form of the given number (`n`).
+ * It determines which content to display by matching the value of `n` to the appropriate pluralization branch,
+ * based on the current locale or a default locale. If no matching plural branch is found, the component renders
+ * the fallback `children` content.
+ *
+ * @example
+ * ```jsx
+ * <Plural
+ *  n={1}
+ *  one="There is 1 item"
+ *  other="There are {n} items"
+ * />
+ * ```
+ * In this example, if `n` is 1, it renders `"There is 1 item"`. If `n` is a different number, it renders
+ * `"There are {n} items"`.
+ *
+ * @param {any} [children] - Fallback content to render if no matching plural branch is found.
+ * @param {number} [n] - The number used to determine the plural form. This is required for pluralization to work.
+ * @param {string} [locales] - Optional parameter, the locale to use for pluralization format. If not provided and wrapped
+ *  in <GTProvider> will automatically populate this value as user's current locale. If not provided and not wrapped in
+ *  <GTProvider>, will use the library default locale (en-US).
+ * @param {...{[key: string]: any}} [branches] - A spread object containing possible plural branches, typically including `one` for singular
+ * and `other` for plural forms, but it may vary depending on the locale.
+ * @returns {React.JSX.Element} The rendered content corresponding to the plural form of `n`, or the fallback content.
+ * @throws {Error} If `n` is not provided or not a valid number.
+ */
+declare function Plural({ children, n, locales, ...branches }: {
+    children?: React.ReactNode;
+    n?: number;
+    locales?: string;
+    [key: string]: any;
+}): React.JSX.Element;
+declare namespace Plural {
+    var _gtt: string;
+}
+export default Plural;
+//# sourceMappingURL=Plural.d.ts.map

package/dist/branches/plurals/Plural.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Plural.d.ts","sourceRoot":"","sources":["../../../src/branches/plurals/Plural.tsx"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,iBAAS,MAAM,CAAC,EACd,QAAQ,EACR,CAAC,EACD,OAAO,EACP,GAAG,QAAQ,EACZ,EAAE;IACD,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAcpB;kBAxBQ,MAAM;;;AA4Bf,eAAe,MAAM,CAAC"}

package/dist/branches/plurals/getPluralBranch.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Main function to get the appropriate branch based on the provided number and branches.
+ *
+ * @param {number} n - The number to determine the branch for.
+ * @param {any} branches - The object containing possible branches.
+ * @returns {any} The determined branch.
+ */
+export default function getPluralBranch(n: number, locales: string[], branches: Record<string, any>): any;
+//# sourceMappingURL=getPluralBranch.d.ts.map

package/dist/branches/plurals/getPluralBranch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getPluralBranch.d.ts","sourceRoot":"","sources":["../../../src/branches/plurals/getPluralBranch.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,eAAe,CACrC,CAAC,EAAE,MAAM,EACT,OAAO,EAAE,MAAM,EAAE,EACjB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,OAQ9B"}

package/dist/dictionaries/collectUntranslatedEntries.d.ts

@@ -0,0 +1,17 @@
+import { Dictionary } from '../types-dir/types';
+/**
+ * @description Collects all untranslated entries from a dictionary
+ * @param dictionary - The dictionary to collect untranslated entries from
+ * @param translationsDictionary - The translated dictionary to compare against
+ * @param id - The id of the dictionary to collect untranslated entries from
+ * @returns An array of untranslated entries
+ */
+export declare function collectUntranslatedEntries(dictionary: Dictionary, translationsDictionary: Dictionary, id?: string): {
+    source: string;
+    metadata: {
+        $id: string;
+        $context?: string;
+        $_hash: string;
+    };
+}[];
+//# sourceMappingURL=collectUntranslatedEntries.d.ts.map

package/dist/dictionaries/collectUntranslatedEntries.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"collectUntranslatedEntries.d.ts","sourceRoot":"","sources":["../../src/dictionaries/collectUntranslatedEntries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAKhD;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,UAAU,EACtB,sBAAsB,EAAE,UAAU,EAClC,EAAE,GAAE,MAAW,GACd;IACD,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CAC9D,EAAE,CAgCF"}

package/dist/dictionaries/getDictionaryEntry.d.ts

@@ -0,0 +1,4 @@
+import { Dictionary, DictionaryEntry } from '../types-dir/types';
+export declare function isValidDictionaryEntry(value: unknown): value is DictionaryEntry;
+export declare function getDictionaryEntry<T extends Dictionary>(dictionary: T, id: string): Dictionary | DictionaryEntry | undefined;
+//# sourceMappingURL=getDictionaryEntry.d.ts.map

package/dist/dictionaries/getDictionaryEntry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDictionaryEntry.d.ts","sourceRoot":"","sources":["../../src/dictionaries/getDictionaryEntry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAGjE,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,OAAO,GACb,KAAK,IAAI,eAAe,CAgB1B;AAED,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,UAAU,EACrD,UAAU,EAAE,CAAC,EACb,EAAE,EAAE,MAAM,GACT,UAAU,GAAG,eAAe,GAAG,SAAS,CAU1C"}

package/dist/dictionaries/getEntryAndMetadata.d.ts

@@ -0,0 +1,6 @@
+import { DictionaryEntry, MetaEntry } from '../types-dir/types';
+export default function getEntryAndMetadata(value: DictionaryEntry): {
+    entry: string;
+    metadata?: MetaEntry;
+};
+//# sourceMappingURL=getEntryAndMetadata.d.ts.map

package/dist/dictionaries/getEntryAndMetadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getEntryAndMetadata.d.ts","sourceRoot":"","sources":["../../src/dictionaries/getEntryAndMetadata.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAEhE,MAAM,CAAC,OAAO,UAAU,mBAAmB,CAAC,KAAK,EAAE,eAAe,GAAG;IACnE,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB,CAUA"}

package/dist/dictionaries/getSubtree.d.ts

@@ -0,0 +1,18 @@
+import { Dictionary, DictionaryEntry } from '../types-dir/types';
+export declare function getSubtree<T extends Dictionary>({ dictionary, id, }: {
+    dictionary: T;
+    id: string;
+}): Dictionary | DictionaryEntry | undefined;
+/**
+ * @description A function that gets a subtree from a dictionary
+ * @param dictionary - new dictionary to get the subtree from
+ * @param id - id of the subtree to get
+ * @param sourceDictionary - source dictionary to model off of
+ * @returns
+ */
+export declare function getSubtreeWithCreation<T extends Dictionary>({ dictionary, id, sourceDictionary, }: {
+    dictionary: T;
+    id: string;
+    sourceDictionary: T;
+}): Dictionary | DictionaryEntry | undefined;
+//# sourceMappingURL=getSubtree.d.ts.map

package/dist/dictionaries/getSubtree.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getSubtree.d.ts","sourceRoot":"","sources":["../../src/dictionaries/getSubtree.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAGjE,wBAAgB,UAAU,CAAC,CAAC,SAAS,UAAU,EAAE,EAC/C,UAAU,EACV,EAAE,GACH,EAAE;IACD,UAAU,EAAE,CAAC,CAAC;IACd,EAAE,EAAE,MAAM,CAAC;CACZ,GAAG,UAAU,GAAG,eAAe,GAAG,SAAS,CAW3C;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,UAAU,EAAE,EAC3D,UAAU,EACV,EAAE,EACF,gBAAgB,GACjB,EAAE;IACD,UAAU,EAAE,CAAC,CAAC;IACd,EAAE,EAAE,MAAM,CAAC;IACX,gBAAgB,EAAE,CAAC,CAAC;CACrB,GAAG,UAAU,GAAG,eAAe,GAAG,SAAS,CAoB3C"}

package/dist/dictionaries/indexDict.d.ts

@@ -0,0 +1,15 @@
+import { Dictionary, DictionaryEntry } from '../types-dir/types';
+/**
+ * @description A function that gets a value from a dictionary, only one level
+ * @param dictionary - dictionary to get the value from
+ * @param id - id of the value to get
+ */
+export declare function get(dictionary: Dictionary, id: string | number): DictionaryEntry | Dictionary;
+/**
+ * @description A function that sets a value in a dictionary
+ * @param dictionary - dictionary to set the value in
+ * @param id - id of the value to set
+ * @param value - value to set
+ */
+export declare function set(dictionary: Dictionary, id: string | number, value: Dictionary | DictionaryEntry): void;
+//# sourceMappingURL=indexDict.d.ts.map

package/dist/dictionaries/indexDict.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexDict.d.ts","sourceRoot":"","sources":["../../src/dictionaries/indexDict.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACjE;;;;GAIG;AACH,wBAAgB,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,gCAQ9D;AAED;;;;;GAKG;AACH,wBAAgB,GAAG,CACjB,UAAU,EAAE,UAAU,EACtB,EAAE,EAAE,MAAM,GAAG,MAAM,EACnB,KAAK,EAAE,UAAU,GAAG,eAAe,QAOpC"}

package/dist/dictionaries/injectAndMerge.d.ts

@@ -0,0 +1,9 @@
+import { Dictionary } from '../types-dir/types';
+/**
+ * @description Given a subtree and a dictionary, injects the subtree into the dictionary at the given id
+ * @param dictionary - The dictionary to inject the subtree into
+ * @param subtree - The subtree to inject into the dictionary
+ * @param id - The id of the subtree to inject into the dictionary
+ */
+export declare function injectAndMerge(dictionary: Dictionary, subtree: Dictionary, id: string): Dictionary;
+//# sourceMappingURL=injectAndMerge.d.ts.map

package/dist/dictionaries/injectAndMerge.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"injectAndMerge.d.ts","sourceRoot":"","sources":["../../src/dictionaries/injectAndMerge.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAmB,MAAM,oBAAoB,CAAC;AAYjE;;;;;GAKG;AACH,wBAAgB,cAAc,CAC5B,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,UAAU,EACnB,EAAE,EAAE,MAAM,cAeX"}

package/dist/dictionaries/injectEntry.d.ts

@@ -0,0 +1,18 @@
+import { Dictionary, DictionaryEntry, TranslatedChildren } from '../types-dir/types';
+/**
+ * @description Injects an entry into a translations object
+ * @param translations - The translations object to inject the entry into
+ * @param entry - The entry to inject
+ * @param hash - The hash of the entry
+ * @param sourceDictionary - The source dictionary to model the new dictionary after
+ */
+export declare function injectEntry(dictionaryEntry: DictionaryEntry, dictionary: Dictionary | DictionaryEntry, id: string, sourceDictionary: Dictionary | DictionaryEntry): DictionaryEntry | undefined;
+/**
+ * @description Merge results into a dictionary
+ * @param dictionary - The dictionary to merge the results into
+ * @param results - The results to merge into the dictionary
+ * @param sourceDictionary - The source dictionary to model the new dictionary after
+ * @returns The merged dictionary
+ */
+export declare function mergeResultsIntoDictionary(dictionary: Dictionary, results: [string, TranslatedChildren][], sourceDictionary: Dictionary): Dictionary;
+//# sourceMappingURL=injectEntry.d.ts.map

package/dist/dictionaries/injectEntry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"injectEntry.d.ts","sourceRoot":"","sources":["../../src/dictionaries/injectEntry.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,eAAe,EACf,kBAAkB,EACnB,MAAM,oBAAoB,CAAC;AAY5B;;;;;;GAMG;AACH,wBAAgB,WAAW,CACzB,eAAe,EAAE,eAAe,EAChC,UAAU,EAAE,UAAU,GAAG,eAAe,EACxC,EAAE,EAAE,MAAM,EACV,gBAAgB,EAAE,UAAU,GAAG,eAAe,+BAiC/C;AAED;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,CAAC,MAAM,EAAE,kBAAkB,CAAC,EAAE,EACvC,gBAAgB,EAAE,UAAU,GAC3B,UAAU,CAKZ"}

package/dist/dictionaries/injectFallbacks.d.ts

@@ -0,0 +1,17 @@
+import { Dictionary } from '../types-dir/types';
+/**
+ * @description Injects fallbacks into a dictionary
+ * @param dictionary - The dictionary to inject translations into
+ * @param translationsDictionary - The translations to inject into the dictionary
+ * @param translations - The translations to inject into the dictionary
+ * @param id - The id of the dictionary to inject translations into
+ */
+export declare function injectFallbacks(dictionary: Dictionary, translationsDictionary: Dictionary, missingTranslations: {
+    source: string;
+    metadata: {
+        $id: string;
+        $context?: string;
+        $_hash: string;
+    };
+}[], prefixToRemove?: string): Dictionary;
+//# sourceMappingURL=injectFallbacks.d.ts.map

package/dist/dictionaries/injectFallbacks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"injectFallbacks.d.ts","sourceRoot":"","sources":["../../src/dictionaries/injectFallbacks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAMhD;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC7B,UAAU,EAAE,UAAU,EACtB,sBAAsB,EAAE,UAAU,EAClC,mBAAmB,EAAE;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CAC9D,EAAE,EACH,cAAc,GAAE,MAAW,cAuB5B"}

package/dist/dictionaries/injectHashes.d.ts

@@ -0,0 +1,11 @@
+import { Dictionary } from '../types-dir/types';
+/**
+ * @description Given a dictionary, adds hashes to all dictionary entries
+ * @param dictionary - The dictionary to add hashes to
+ * @param id - The starting point of dictionary (if subtree)
+ */
+export declare function injectHashes(dictionary: Dictionary, id?: string): {
+    dictionary: Dictionary;
+    updateDictionary: boolean;
+};
+//# sourceMappingURL=injectHashes.d.ts.map

package/dist/dictionaries/injectHashes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"injectHashes.d.ts","sourceRoot":"","sources":["../../src/dictionaries/injectHashes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAIhD;;;;GAIG;AACH,wBAAgB,YAAY,CAC1B,UAAU,EAAE,UAAU,EACtB,EAAE,GAAE,MAAW,GACd;IAAE,UAAU,EAAE,UAAU,CAAC;IAAC,gBAAgB,EAAE,OAAO,CAAA;CAAE,CAwBvD"}

package/dist/dictionaries/injectTranslations.d.ts

@@ -0,0 +1,20 @@
+import { Dictionary, Translations } from '../types-dir/types';
+/**
+ * @description Injects translations into a dictionary
+ * @param dictionary - The dictionary to inject translations into
+ * @param translationsDictionary - The translations to inject into the dictionary
+ * @param translations - The translations to inject into the dictionary
+ * @param id - The id of the dictionary to inject translations into
+ */
+export declare function injectTranslations(dictionary: Dictionary, translationsDictionary: Dictionary, translations: Translations, missingTranslations: {
+    source: string;
+    metadata: {
+        $id: string;
+        $context?: string;
+        $_hash: string;
+    };
+}[], prefixToRemove?: string): {
+    dictionary: Dictionary;
+    updateDictionary: boolean;
+};
+//# sourceMappingURL=injectTranslations.d.ts.map

package/dist/dictionaries/injectTranslations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"injectTranslations.d.ts","sourceRoot":"","sources":["../../src/dictionaries/injectTranslations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAM9D;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAChC,UAAU,EAAE,UAAU,EACtB,sBAAsB,EAAE,UAAU,EAClC,YAAY,EAAE,YAAY,EAC1B,mBAAmB,EAAE;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CAC9D,EAAE,EACH,cAAc,GAAE,MAAW,GAC1B;IAAE,UAAU,EAAE,UAAU,CAAC;IAAC,gBAAgB,EAAE,OAAO,CAAA;CAAE,CA8BvD"}

package/dist/dictionaries/isDictionaryEntry.d.ts

@@ -0,0 +1,8 @@
+import { Dictionary, DictionaryEntry } from '../types-dir/types';
+/**
+ * Type guard function that checks if a value is a DictionaryEntry
+ * @param value - The value to check
+ * @returns true if the value is a DictionaryEntry, false otherwise
+ */
+export declare function isDictionaryEntry(value: Dictionary | DictionaryEntry | undefined): value is DictionaryEntry;
+//# sourceMappingURL=isDictionaryEntry.d.ts.map

package/dist/dictionaries/isDictionaryEntry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isDictionaryEntry.d.ts","sourceRoot":"","sources":["../../src/dictionaries/isDictionaryEntry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAEjE;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,UAAU,GAAG,eAAe,GAAG,SAAS,GAC9C,KAAK,IAAI,eAAe,CAoC1B"}

package/dist/dictionaries/loadDictionaryHelper.d.ts

@@ -0,0 +1,3 @@
+import { CustomLoader, Dictionary } from '../types-dir/types';
+export default function loadDictionaryHelper(locale: string, loadDictionary: CustomLoader): Promise<Dictionary | undefined>;
+//# sourceMappingURL=loadDictionaryHelper.d.ts.map

package/dist/dictionaries/loadDictionaryHelper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loadDictionaryHelper.d.ts","sourceRoot":"","sources":["../../src/dictionaries/loadDictionaryHelper.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAE9D,wBAA8B,oBAAoB,CAChD,MAAM,EAAE,MAAM,EACd,cAAc,EAAE,YAAY,GAC3B,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAkBjC"}

package/dist/dictionaries/mergeDictionaries.d.ts

@@ -0,0 +1,3 @@
+import { Dictionary } from '../types-dir/types';
+export default function mergeDictionaries(defaultLocaleDictionary: Dictionary, localeDictionary: Dictionary): Dictionary;
+//# sourceMappingURL=mergeDictionaries.d.ts.map

package/dist/dictionaries/mergeDictionaries.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mergeDictionaries.d.ts","sourceRoot":"","sources":["../../src/dictionaries/mergeDictionaries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAmB,MAAM,oBAAoB,CAAC;AAUjE,MAAM,CAAC,OAAO,UAAU,iBAAiB,CACvC,uBAAuB,EAAE,UAAU,EACnC,gBAAgB,EAAE,UAAU,GAC3B,UAAU,CAiDZ"}

package/dist/dictionaries/stripMetadataFromEntries.d.ts

@@ -0,0 +1,6 @@
+import { Dictionary } from '../types-dir/types';
+/**
+ * @description Iterate over tree and remove metadata leaving just the entry
+ */
+export declare function stripMetadataFromEntries(dictionary: Dictionary): Dictionary;
+//# sourceMappingURL=stripMetadataFromEntries.d.ts.map

package/dist/dictionaries/stripMetadataFromEntries.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stripMetadataFromEntries.d.ts","sourceRoot":"","sources":["../../src/dictionaries/stripMetadataFromEntries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAKhD;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,UAAU,EAAE,UAAU,GAAG,UAAU,CAc3E"}

package/dist/errors-dir/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const PACKAGE_NAME = "@generaltranslation/react-core";
+//# sourceMappingURL=constants.d.ts.map

package/dist/errors-dir/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/errors-dir/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,YAAY,mCAAmC,CAAC"}

package/dist/errors-dir/createErrors.d.ts

@@ -0,0 +1,32 @@
+export declare const projectIdMissingError = "@generaltranslation/react-core Error: General Translation cloud services require a project ID! Find yours at generaltranslation.com/dashboard.";
+export declare const devApiKeyProductionError = "@generaltranslation/react-core Error: Production environments cannot include a development api key.";
+export declare const apiKeyInProductionError = "@generaltranslation/react-core Error: Production environments cannot include an api key.";
+export declare const createNoAuthError = "@generaltranslation/react-core Error: Configuration is missing a projectId and/or devApiKey. Please add these values to your environment or pass them to the <GTProvider> directly.";
+export declare const createPluralMissingError: (children: any) => string;
+export declare const createClientSideTDictionaryCollisionError: (id: string) => string;
+export declare const createClientSideTHydrationError: (id: string) => string;
+export declare const dynamicTranslationError = "@generaltranslation/react-core Error: Fetching batched translations failed";
+export declare const createGenericRuntimeTranslationError: (id: string | undefined, hash: string) => string;
+export declare const runtimeTranslationError = "@generaltranslation/react-core Error: Runtime translation failed: ";
+export declare const customLoadTranslationsError: (locale?: string) => string;
+export declare const customLoadDictionaryWarning: (locale?: string) => string;
+export declare const missingVariablesError: (variables: string[], message: string) => string;
+export declare const createStringRenderError: (message: string, id: string | undefined) => string;
+export declare const createStringTranslationError: (string: string, id?: string, functionName?: string) => string;
+export declare const invalidLocalesError: (locales: string[]) => string;
+export declare const invalidCanonicalLocalesError: (locales: string[]) => string;
+export declare const createEmptyIdError: () => string;
+export declare const createSubtreeNotFoundError: (id: string) => string;
+export declare const createDictionaryEntryError: () => string;
+export declare const createCannotInjectDictionaryEntryError: () => string;
+export declare const projectIdMissingWarning = "@generaltranslation/react-core Warning: Translation cloud services require a project ID! Find yours at generaltranslation.com/dashboard.";
+export declare const createNoEntryFoundWarning: (id: string) => string;
+export declare const createInvalidDictionaryEntryWarning: (id: string) => string;
+export declare const createNoEntryTranslationWarning: (id: string, prefixedId: string) => string;
+export declare const createMismatchingHashWarning: (expectedHash: string, receivedHash: string) => string;
+export declare const APIKeyMissingWarn: string;
+export declare const createUnsupportedLocalesWarning: (locales: string[]) => string;
+export declare const runtimeTranslationTimeoutWarning = "@generaltranslation/react-core Warning: Runtime translation timed out.";
+export declare const createUnsupportedLocaleWarning: (validatedLocale: string, newLocale: string, packageName?: string) => string;
+export declare const dictionaryMissingWarning = "@generaltranslation/react-core Warning: No dictionary was found. Ensure you are either passing your dictionary to the <GTProvider>.";
+//# sourceMappingURL=createErrors.d.ts.map

package/dist/errors-dir/createErrors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createErrors.d.ts","sourceRoot":"","sources":["../../src/errors-dir/createErrors.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,qBAAqB,mJAAoI,CAAC;AAEvK,eAAO,MAAM,wBAAwB,wGAAyF,CAAC;AAE/H,eAAO,MAAM,uBAAuB,6FAA8E,CAAC;AAEnH,eAAO,MAAM,iBAAiB,wLAAyK,CAAC;AAExM,eAAO,MAAM,wBAAwB,GAAI,UAAU,GAAG,WACwC,CAAC;AAE/F,eAAO,MAAM,yCAAyC,GAAI,IAAI,MAAM,WACoF,CAAC;AAEzJ,eAAO,MAAM,+BAA+B,GAAI,IAAI,MAAM,WAEmE,CAAC;AAE9H,eAAO,MAAM,uBAAuB,+EAAgE,CAAC;AAErG,eAAO,MAAM,oCAAoC,GAC/C,IAAI,MAAM,GAAG,SAAS,EACtB,MAAM,MAAM,WAOb,CAAC;AAEF,eAAO,MAAM,uBAAuB,uEAAwD,CAAC;AAE7F,eAAO,MAAM,2BAA2B,GAAI,SAAQ,MAAW,WAC+F,CAAC;AAE/J,eAAO,MAAM,2BAA2B,GAAI,SAAQ,MAAW,WAC2F,CAAC;AAE3J,eAAO,MAAM,qBAAqB,GAAI,WAAW,MAAM,EAAE,EAAE,SAAS,MAAM,WACwB,CAAC;AAEnG,eAAO,MAAM,uBAAuB,GAClC,SAAS,MAAM,EACf,IAAI,MAAM,GAAG,SAAS,WAEuF,CAAC;AAEhH,eAAO,MAAM,4BAA4B,GACvC,QAAQ,MAAM,EACd,KAAK,MAAM,EACX,qBAAmB,WAIa,CAAC;AAEnC,eAAO,MAAM,mBAAmB,GAAI,SAAS,MAAM,EAAE,WAGwB,CAAC;AAE9E,eAAO,MAAM,4BAA4B,GAAI,SAAS,MAAM,EAAE,WACuD,CAAC;AAEtH,eAAO,MAAM,kBAAkB,cACqC,CAAC;AAErE,eAAO,MAAM,0BAA0B,GAAI,IAAI,MAAM,WACkB,CAAC;AAExE,eAAO,MAAM,0BAA0B,cAC8B,CAAC;AAEtE,eAAO,MAAM,sCAAsC,cACkB,CAAC;AAItE,eAAO,MAAM,uBAAuB,6IAA8H,CAAC;AAEnK,eAAO,MAAM,yBAAyB,GAAI,IAAI,MAAM,WACwB,CAAC;AAE7E,eAAO,MAAM,mCAAmC,GAAI,IAAI,MAAM,WACa,CAAC;AAE5E,eAAO,MAAM,+BAA+B,GAC1C,IAAI,MAAM,EACV,YAAY,MAAM,WAE8E,CAAC;AAEnG,eAAO,MAAM,4BAA4B,GACvC,cAAc,MAAM,EACpB,cAAc,MAAM,WAE2M,CAAC;AAElO,eAAO,MAAM,iBAAiB,QAGqF,CAAC;AAEpH,eAAO,MAAM,+BAA+B,GAAI,SAAS,MAAM,EAAE,WAMhD,CAAC;AAElB,eAAO,MAAM,gCAAgC,2EAA4D,CAAC;AAE1G,eAAO,MAAM,8BAA8B,GACzC,iBAAiB,MAAM,EACvB,WAAW,MAAM,EACjB,cAAa,MAAqB,WAOnC,CAAC;AAEF,eAAO,MAAM,wBAAwB,wIAAyH,CAAC"}

package/dist/errors-dir/internalErrors.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Invoked when a method that was designated for overriding is invoked by @generaltranslation/react-core.
+ * This is an internal library error due to incorrect implementation of a wrapper library.
+ * @param methodName
+ * @returns Error object
+ */
+export declare function createInternalUsageError(methodName: string): Error;
+//# sourceMappingURL=internalErrors.d.ts.map

package/dist/errors-dir/internalErrors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"internalErrors.d.ts","sourceRoot":"","sources":["../../src/errors-dir/internalErrors.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,UAAU,EAAE,MAAM,GAAG,KAAK,CAIlE"}

package/dist/errors.cjs.min.cjs

@@ -0,0 +1 @@
+"use strict";require("generaltranslation");exports.createUnsupportedLocaleWarning=(o,r,e="@generaltranslation/react-core")=>`${e} Warning: You are trying to switch to "${r}" which is not supported.  Update the list of supported locales through your dashboard or your config.json file if you are using a config file. Falling back to "${o}".`;

package/dist/errors.d.ts

@@ -0,0 +1,3 @@
+declare const createUnsupportedLocaleWarning: (validatedLocale: string, newLocale: string, packageName?: string) => string;
+
+export { createUnsupportedLocaleWarning };

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,8BAA8B,EAAE,MAAM,2BAA2B,CAAC;AAE3E,OAAO,EAAE,8BAA8B,EAAE,CAAC"}

package/dist/errors.esm.min.mjs

@@ -0,0 +1 @@
+import"generaltranslation";const o=(o,t,r="@generaltranslation/react-core")=>`${r} Warning: You are trying to switch to "${t}" which is not supported.  Update the list of supported locales through your dashboard or your config.json file if you are using a config file. Falling back to "${o}".`;export{o as createUnsupportedLocaleWarning};

package/dist/hooks/useDefaultLocale.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Retrieves the application's default locale from the `<GTProvider>` context.
+ *
+ * If no default locale is passed to the `<GTProvider>`, it defaults to providing 'en'.
+ *
+ * @returns {string} The application's default locale, e.g., 'en-US'.
+ *
+ * @example
+ * const locale = useDefaultLocale();
+ * console.log(locale); // 'en-US'
+ */
+export default function useDefaultLocale(): string;
+//# sourceMappingURL=useDefaultLocale.d.ts.map

package/dist/hooks/useDefaultLocale.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useDefaultLocale.d.ts","sourceRoot":"","sources":["../../src/hooks/useDefaultLocale.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB,IAAI,MAAM,CAIjD"}

package/dist/hooks/useGTClass.d.ts

@@ -0,0 +1,23 @@
+import { LocaleProperties } from 'generaltranslation/types';
+/**
+ * Returns the configured GT class instance.
+ *
+ * @returns {GT} The configured GT class instance.
+ *
+ * @example
+ * const gt = useGTClass();
+ * console.log(gt.getLocaleProperties('en-US'));
+ */
+export declare function useGTClass(): import("generaltranslation").GT;
+/**
+ * Returns the locale properties for the given locale.
+ *
+ * @param {string} locale - The locale to get the properties for.
+ * @returns {LocaleProperties} The locale properties for the given locale.
+ *
+ * @example
+ * const localeProperties = useLocaleProperties('en-US');
+ * console.log(localeProperties);
+ */
+export declare function useLocaleProperties(locale: string): LocaleProperties;
+//# sourceMappingURL=useGTClass.d.ts.map

package/dist/hooks/useGTClass.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useGTClass.d.ts","sourceRoot":"","sources":["../../src/hooks/useGTClass.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAG5D;;;;;;;;GAQG;AACH,wBAAgB,UAAU,oCAIzB;AAED;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAGpE"}

package/dist/hooks/useLocale.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Retrieves the user's locale from the `<GTProvider>` context.
+ *
+ * @returns {string} The user's locale, e.g., 'en-US'.
+ *
+ * @example
+ * const locale = useLocale();
+ * console.log(locale); // 'en-US'
+ */
+export default function useLocale(): string;
+//# sourceMappingURL=useLocale.d.ts.map

package/dist/hooks/useLocale.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLocale.d.ts","sourceRoot":"","sources":["../../src/hooks/useLocale.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,UAAU,SAAS,IAAI,MAAM,CAI1C"}

package/dist/hooks/useLocaleDirection.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Retrieves the text direction ('ltr' or 'rtl') for the current or specified locale from the `<GTProvider>` context.
+ *
+ * If no locale is provided, the direction for the current user's locale is returned.
+ *
+ * @param {string} [locale] - Optional locale code (e.g., 'ar', 'en-US'). If omitted, uses the current locale from context.
+ * @returns {'ltr' | 'rtl'} The text direction for the locale: 'rtl' for right-to-left languages, otherwise 'ltr'.
+ *
+ * @example
+ * const dir = useLocaleDirection(); // e.g., 'ltr'
+ * const arabicDir = useLocaleDirection('ar'); // 'rtl'
+ */
+export declare function useLocaleDirection(locale?: string): 'ltr' | 'rtl';
+//# sourceMappingURL=useLocaleDirection.d.ts.map

package/dist/hooks/useLocaleDirection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLocaleDirection.d.ts","sourceRoot":"","sources":["../../src/hooks/useLocaleDirection.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,CAKjE"}