generaltranslation 2.0.45 → 2.0.46

package/README.md

@@ -178,13 +178,32 @@ console.log(result.translation); // { "type": "div", "props": { "children": "Hol
 
 #### Parameters
 
-- `content` (any): The React children content to be translated.
-- `targetLanguage` (string): The target language for the translation.
-- `metadata` (object): Additional metadata for the translation process.
+- `requests` (Request[]): An array of request objects. Each request can be of type `translate`, `intl`, or `react`.
+
+- **Translate Request**:
+  - `type`: `'translate'`
+  - `data`: An object containing:
+    - `content` (string): The string content to be translated.
+    - `targetLanguage` (string): The target language for the translation.
+    - `metadata` (Record<string, any>): Additional metadata for the translation process.
+
+- **Intl Request**:
+  - `type`: `'intl'`
+  - `data`: An object containing:
+    - `content` (string): The string content to be translated.
+    - `targetLanguage` (string): The target language for the translation.
+    - `metadata` (Record<string, any>): Additional metadata for the translation process.
+
+- **React Request**:
+  - `type`: `'intl'`
+  - `data`: An object containing:
+    - `children` (object | string): The React children content to be translated.
+    - `targetLanguage` (string): The target language for the translation.
+    - `metadata` (Record<string, any>): Additional metadata for the translation process.
 
 #### Returns
 
-- A promise that resolves to an object containing the translated content and optional error information.
+- A promise that resolves to an object containing the translated content, optional error information, and dictionary information for react and intl requests.
 
 #### `bundleTranslation(requests: any[]): Promise<Array<any | null>>`
 
@@ -193,13 +212,13 @@ Bundles multiple requests and sends them to the server.
 ```javascript
 const requests = [
     {
-        type: "intl"
+        type: "translate"
         data: {
             content: 'Hello', targetLanguage: 'es'
         }
     }
     {
-        type: "intl"
+        type: "translate"
         data: {
             content: 'Hello', targetLanguage: 'de'
         }
@@ -207,7 +226,7 @@ const requests = [
     
 ];
 const results = await gt.bundleTranslation(requests);
-console.log(results); // ['Hola', 'Hallo']
+console.log(results); // [{ translation: "Hola", language: "es" }, { translation: "Hallo", language: "de" }]
 ```
 
 #### Parameters
@@ -218,6 +237,50 @@ console.log(results); // ['Hola', 'Hallo']
 
 - A promise that resolves to an array of processed results.
 
+### updateRemoteDictionary(updates)
+
+Pushes updates to a remotely cached translation dictionary.
+
+#### Parameters
+
+- `updates` (Update[]): An array of update objects. Each update can be of type `react` or `intl`.
+
+  - **React Update**:
+    - `type`: `'react'`
+    - `data`: An object containing:
+      - `children` (object | string): The React children content to be translated.
+      - `targetLanguage` (string, optional): The target language for the translation.
+      - `metadata` (Record<string, any>): Additional metadata for the translation process.
+
+  - **Intl Update**:
+    - `type`: `'intl'`
+    - `data`: An object containing:
+      - `content` (string): The string content to be translated.
+      - `targetLanguage` (string, optional): The target language for the translation.
+      - `metadata` (Record<string, any>): Additional metadata for the translation process.
+
+#### Returns
+
+- A promise that resolves to a boolean indicating success (`true`) or failure (`false`).
+
+#### Example
+
+```js
+import { updateRemoteDictionary } from 'generaltranslation';
+const updates = [
+    {
+        type: 'react',
+        data: {
+            children: { type: 'div', props: { children: 'Hello, world' } },
+            targetLanguage: 'es',
+            metadata: { id: 'greeting' }
+        }
+    }
+];
+const success = await updateRemoteDictionary(updates);
+console.log(success); // true or false
+```
+
 ## Utility Functions
 
 ### getLanguageDirection

package/dist/translation/_bundleTranslation.d.ts

@@ -13,7 +13,7 @@ export type Request = {
         metadata: Record<string, any>;
     };
 } | {
-    type: 'intl';
+    type: 'react';
     data: {
         children: object | string;
         targetLanguage: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "generaltranslation",
-  "version": "2.0.45",
+  "version": "2.0.46",
   "description": "A language toolkit for AI developers",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",