Release/0.0.3

Author: wadeyw

.github/workflows/publish.yml

@@ -3,6 +3,8 @@ name: Publish
 on:
   release:
     types: [published]
+    branches:
+      - main
   workflow_dispatch:
 
 
@@ -31,8 +33,6 @@ jobs:
 
       - name: Build package
         run: npm run build
-        env:
-          BASE_URL: ${{ secrets.BASE_URL }}
 
       - name: Publish to NPM
         run: npm publish

README.md

@@ -61,7 +61,7 @@ const MyComponent = () => {
 
   return (
     <div>
-      <h1>{t("Welcome to our app!", "static")}</h1>
+      <h1>{t("Welcome to our app!", false)}</h1>
       <p>{t("This text will be automatically translated")}</p>
     </div>
   );
@@ -213,17 +213,17 @@ Returns an object with:
 - `loading`: Boolean indicating initialization of translations
 - `error`: Error object if translation loading failed
 
-### Static persist
+### Persist for Editing
 
-When you pass the 'static' parameter to the translation function, the translation will be persisted so that you can review and edit in the dashboard, default is non-static, nothing will be persisted.
+The 'persist' means the string will be persisted so that you can review and edit in the [dashboard](https://dashboard.autolocalise.com), default is true, if the content is dynamic or you don't want to see in the dashboard, pass 'false'.
 
 ```typescript
 import { useAutoTranslate } from "react-autolocalise";
 const MyComponent = () => {
   const { t } = useAutoTranslate();
   return (
     <div>
-      <h1>{t("Welcome to our app!", "static")}</h1>
+      <h1>{t("Welcome to our app!", false)}</h1>
     </div>
   );
 };

package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "react-autolocalise",
-  "version": "0.0.2",
+  "version": "0.0.3-alpha.1",
   "description": "Auto-translation SDK for React and Next.js applications with SSR support",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",
@@ -74,5 +74,6 @@
   },
   "bugs": {
     "url": "https://github.com/AutoLocalise/react-autolocalise/issues"
-  }
+  },
+  "homepage": "https://www.autolocalise.com"
 }

src/context/TranslationContext.tsx

@@ -14,12 +14,12 @@ const TranslationContext = createContext<TranslationContextType>({
   /**
    * Translates the given text to the target language
    * @param text - The text to translate
-   * @param type - Optional parameter to specify the type of text being translated (e.g., 'title', 'description', etc.)
-   *              This is used by the translation service to provide context-aware translations
+   * @param persist - Optional parameter to specify if the translation should be persisted
    * @returns The translated text, or the original text if translation is not yet available
    */
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  translate: (text: string, type?: string) => text,
+  translate: (text: string, persist: boolean = true, reference?: string) =>
+    text,
   loading: true,
   error: null,
 });
@@ -109,7 +109,7 @@ export const TranslationProvider: React.FC<TranslationProviderSSRProps> = ({
   // Remove the translations state
   const translate = useMemo(
     () =>
-      (text: string, type?: string): string => {
+      (text: string, persist: boolean = true, reference?: string): string => {
         if (!text || loading) return text;
 
         // Skip translation if source and target languages are the same
@@ -123,7 +123,7 @@ export const TranslationProvider: React.FC<TranslationProviderSSRProps> = ({
 
         // Start async translation if not already pending
         if (!service.isTranslationPending(text)) {
-          return service.translate(text, type);
+          return service.translate(text, persist, reference);
         }
 
         // Return original text while translation is pending
@@ -148,7 +148,8 @@ export const useAutoTranslate = () => {
     );
   }
   return {
-    t: context.translate,
+    t: (text: string, persist: boolean = true, reference?: string) =>
+      context.translate(text, persist, reference),
     loading: context.loading,
     error: context.error,
   };

src/server/index.ts

@@ -40,7 +40,7 @@ export class ServerTranslation {
     const batchRequest = validTexts.map((text) => ({
       hashkey: this.service.generateHash(text),
       text,
-      type: "static",
+      persist: true,
     }));
 
     try {

src/services/translation.ts

@@ -11,7 +11,7 @@ export class TranslationService {
   private config: TranslationConfig;
   private cache: TranslationMap = {};
   private storage: StorageAdapter | null = null;
-  private pendingTranslations: Map<string, string | undefined> = new Map();
+  private pendingTranslations: Map<string, boolean> = new Map();
   private batchTimeout: NodeJS.Timeout | null = null;
   private cacheKey = "";
   private baseUrl = "https://autolocalise-main-53fde32.zuplo.app";
@@ -110,10 +110,11 @@ export class TranslationService {
     }
 
     this.batchTimeout = setTimeout(async () => {
-      const allTexts: { hashkey: string; text: string; type?: string }[] = [];
+      const allTexts: { hashkey: string; text: string; persist: boolean }[] =
+        [];
 
-      this.pendingTranslations.forEach((type, text) => {
-        allTexts.push({ hashkey: this.generateHash(text), text, type });
+      this.pendingTranslations.forEach((persist, text) => {
+        allTexts.push({ hashkey: this.generateHash(text), text, persist });
       });
       this.pendingTranslations.clear();
 
@@ -205,7 +206,11 @@ export class TranslationService {
    * Translate text asynchronously with batching (client-side)
    * This method is optimized for client-side usage where batching reduces API calls
    */
-  public translate(text: string, type?: string): string {
+  public translate(
+    text: string,
+    persist: boolean = true,
+    reference?: string
+  ): string {
     if (!text || !this.isInitialized) return text;
 
     // Check cache first
@@ -214,7 +219,7 @@ export class TranslationService {
       return cachedTranslation;
     }
 
-    this.pendingTranslations.set(text, type);
+    this.pendingTranslations.set(text, persist);
     this.scheduleBatchTranslation();
 
     // Return original text while translation is pending
@@ -227,7 +232,7 @@ export class TranslationService {
    * @param texts Array of text items to translate in batch
    */
   public async translateBatch(
-    texts: { hashkey: string; text: string; type: string }[]
+    texts: { hashkey: string; text: string; persist: boolean }[]
   ): Promise<Record<string, string>> {
     if (!this.isInitialized || texts.length === 0) {
       return {};

src/types.ts

@@ -15,7 +15,8 @@ export interface TranslationRequest {
   texts: Array<{
     hashkey: string;
     text: string;
-    type?: string;
+    persist: boolean;
+    reference?: string;
   }>;
   sourceLocale: string;
   targetLocale: string;
@@ -33,7 +34,7 @@ export interface StorageAdapter {
 }
 
 export interface TranslationContextType {
-  translate: (text: string, type?: string) => string;
+  translate: (text: string, persist: boolean, reference?: string) => string;
   loading: boolean;
   error: Error | null;
 }