Google Translate Integration (#20)

Author: alexcibotari

README.md

@@ -22,6 +22,7 @@ If you would like to become a sponsor, please consider:
 ## Key Features
 
 - Edit your localisation content in real time
+- Translate with Google Translate
 - No application build required anymore
 - Publish your changes (instant update)
 - Google CDN Integration (very fast response time, about 300ms for 125kb of 5000 translations)

firebase.json

@@ -34,6 +34,10 @@
         "source": "/api/v1/**",
         "function": "v1"
       },
+      {
+        "source": "/api/translate",
+        "function": "translate"
+      },
       {
         "source": "/api/translationsPublish",
         "function": "translationsPublish"

functions/package-lock.json

@@ -21,7 +21,8 @@
     "express": "^4.18.1",
     "firebase-admin": "^11.0.1",
     "firebase-functions": "^3.23.0",
-    "axios": "^0.27.2"
+    "axios": "^0.27.2",
+    "@google-cloud/translate": "^7.0.2"
   },
   "devDependencies": {
     "@typescript-eslint/eslint-plugin": "^5.36.1",

functions/package.json

@@ -2,7 +2,8 @@
 import {App, initializeApp} from 'firebase-admin/app';
 import {Firestore, getFirestore} from 'firebase-admin/firestore';
 import {getStorage, Storage} from 'firebase-admin/storage';
-import {getAuth, Auth} from 'firebase-admin/auth';
+import {Auth, getAuth} from 'firebase-admin/auth';
+import {TranslationServiceClient} from '@google-cloud/translate';
 
 // BATCH OPERATION
 export const BATCH_MAX = 500;
@@ -25,3 +26,16 @@ export const firestoreService: Firestore = getFirestore(app);
 export const authService: Auth = getAuth(app);
 export const storageService: Storage = getStorage(app);
 export const bucket = storageService.bucket();
+export const translationService = new TranslationServiceClient()
+
+// Translation
+export const SUPPORT_LOCALES = new Set([
+    "af", "am", "ar", "az", "be", "bg", "bn", "bs", "ca", "ceb", "ckb", "co", "cs", "cy", "da", "de",
+    "el", "en", "eo", "es", "et", "eu", "fa", "fi", "fr", "fy", "ga", "gd", "gl", "gu", "ha", "haw",
+    "he", "hi", "hmn", "hr", "ht", "hu", "hy", "id", "ig", "is", "it", "iw", "ja", "jw", "ka", "kk",
+    "km", "kn", "ko", "ku", "ky", "la", "lb", "lo", "lt", "lv", "mai", "mg", "mi", "mk", "ml", "mn",
+    "mr", "ms", "mt", "my", "ne", "nl", "no", "ny", "or", "pa", "pl", "ps", "pt", "ro", "ru", "rw",
+    "sd", "si", "sk", "sl", "sm", "sn", "so", "sq", "sr", "st", "su", "sv", "sw", "ta", "te", "tg",
+    "th", "tk", "tl", "tr", "tt", "ug", "uk", "ur", "uz", "vi", "xh", "yi", "yo", "zh", "zh-TW", "zu"
+  ]
+)

functions/src/config.ts

@@ -2,6 +2,8 @@ export {setup} from './setup';
 
 export {onSpaceDelete} from './spaces';
 
+export {translate} from './translate'
+
 export {translationsPublish, translationsExport, translationsImport} from './translations';
 
 export {onAuthUserCreate, onUserUpdate, userInvite, onUserDelete, usersSync} from './users';

functions/src/index.ts

@@ -0,0 +1,7 @@
+export const FIREBASE_CONFIG = 'FIREBASE_CONFIG'
+
+export interface FirebaseConfig {
+  projectId: string;
+  storageBucket: string;
+  locationId?: string;
+}

functions/src/models/firebase.model.ts

@@ -0,0 +1,5 @@
+export interface TranslateData {
+  content: string
+  sourceLocale: string
+  targetLocale: string
+}

functions/src/models/translate.model.ts

@@ -60,3 +60,7 @@ export interface TranslationsImportFullData {
 }
 
 export type  TranslationsImportData = TranslationsImportFlatData | TranslationsImportFullData
+
+export interface PublishTranslationsData {
+  spaceId: string
+}

functions/src/models/translation.model.ts …nctions/src/models/translations.model.tsfunctions/src/models/translation.model.ts renamed to functions/src/models/translations.model.ts functions/src/models/translation.model.ts renamed to functions/src/models/translations.model.ts

@@ -0,0 +1,47 @@
+import {https, logger} from 'firebase-functions';
+import {SecurityUtils} from './utils/security-utils';
+import {ROLE_ADMIN, ROLE_EDIT, ROLE_WRITE, SUPPORT_LOCALES, translationService} from './config';
+import {FIREBASE_CONFIG, FirebaseConfig} from './models/firebase.model';
+import {TranslateData} from './models/translate.model';
+import {protos} from '@google-cloud/translate';
+
+export const translate = https.onCall(async (data: TranslateData, context) => {
+  logger.info('[translate] data: ' + JSON.stringify(data));
+  logger.info('[translate] context.auth: ' + JSON.stringify(context.auth));
+  if (!SecurityUtils.hasAnyRole([ROLE_EDIT, ROLE_WRITE, ROLE_ADMIN], context.auth)) throw new https.HttpsError('permission-denied', 'permission-denied');
+  if (!(SUPPORT_LOCALES.has(data.sourceLocale) && SUPPORT_LOCALES.has(data.targetLocale))) throw new https.HttpsError('invalid-argument', 'Unsupported language');
+
+
+    const firebaseConfig: FirebaseConfig = JSON.parse(process.env[FIREBASE_CONFIG] || '')
+  const projectId = firebaseConfig.projectId
+  let locationId; //firebaseConfig.locationId || 'global'
+  if (firebaseConfig.locationId && firebaseConfig.locationId.startsWith('us-')) {
+    locationId = 'us-central1'
+  } else {
+    locationId = 'global'
+  }
+
+
+  const request: protos.google.cloud.translation.v3.ITranslateTextRequest = {
+    parent: `projects/${projectId}/locations/${locationId}`,
+    contents: [data.content],
+    mimeType: 'text/plain',
+    sourceLanguageCode: data.sourceLocale,
+    targetLanguageCode: data.targetLocale,
+  };
+
+  try {
+
+    // Run request
+    const [responseTranslateText] = await translationService.translateText(request);
+
+    if (responseTranslateText.translations && responseTranslateText.translations.length > 0) {
+      return responseTranslateText.translations[0].translatedText
+    } else {
+      return null
+    }
+  } catch (e) {
+    logger.error(e)
+    throw new https.HttpsError('failed-precondition', `Cloud Translation API has not been used in project ${projectId} before or it is disabled`);
+  }
+});