Add Translation WebHooks

Author: alexcibotari

functions/src/models/webhook.model.ts

@@ -16,6 +16,10 @@ export enum WebHookEvent {
   CONTENT_UNPUBLISHED = 'content.unpublished',
   CONTENT_DELETED = 'content.deleted',
   CONTENT_UPDATED = 'content.updated',
+  TRANSLATION_PUBLISHED = 'translation.published',
+  TRANSLATION_ADDED = 'translation.added',
+  TRANSLATION_UPDATED = 'translation.updated',
+  TRANSLATION_DELETED = 'translation.deleted',
 }
 
 export type WebHookStatus = 'success' | 'failure';
@@ -24,14 +28,18 @@ export interface WebHookPayload {
   event: WebHookEvent;
   spaceId: string;
   timestamp: string;
-  data: ContentWebHookPayloadData;
+  data: ContentWebHookPayloadData | TranslationWebHookPayloadData;
   signature?: string;
 }
 
 export interface ContentWebHookPayloadData {
   contentId: string;
 }
 
+export interface TranslationWebHookPayloadData {
+  translationId?: string;
+}
+
 export interface WebHookLog {
   event: WebHookEvent;
   status: WebHookStatus;

functions/src/translations.ts

@@ -15,6 +15,8 @@ import {
 import { deleteTranslations, findSpaceById, findTranslations, findTranslationsHistory, spaceTranslationCachePath } from './services';
 import { translateCloud, translateWithGoogle } from './services/translate.service';
 import { canPerform } from './utils/user-auth-utils';
+import { triggerWebHooksForEvent } from './utils/webhook-utils';
+import { WebHookEvent, WebHookPayload } from './models/webhook.model';
 
 // Publish
 const publish = onCall<PublishTranslationsData>(async request => {
@@ -59,6 +61,13 @@ const publish = onCall<PublishTranslationsData>(async request => {
       createdAt: FieldValue.serverTimestamp(),
     };
     await findTranslationsHistory(spaceId).add(addHistory);
+    const webhookPayload: WebHookPayload = {
+      event: WebHookEvent.TRANSLATION_PUBLISHED,
+      spaceId,
+      timestamp: new Date().toISOString(),
+      data: {},
+    };
+    await triggerWebHooksForEvent(spaceId, webhookPayload);
     return;
   } else {
     logger.info(`[translationsPublish] Space ${spaceId} does not exist or no translations.`);
@@ -257,6 +266,26 @@ const onWriteToHistory = onDocumentWritten('spaces/{spaceId}/translations/{trans
     addHistory.name = afterData.updatedBy.name;
   }
   await findTranslationsHistory(spaceId).add(addHistory);
+
+  // Trigger webhook based on operation type
+  let webhookEvent: WebHookEvent | undefined;
+  if (beforeData && afterData) {
+    webhookEvent = WebHookEvent.TRANSLATION_UPDATED;
+  } else if (beforeData) {
+    webhookEvent = WebHookEvent.TRANSLATION_DELETED;
+  } else if (afterData) {
+    webhookEvent = WebHookEvent.TRANSLATION_ADDED;
+  }
+  if (webhookEvent) {
+    const webhookPayload: WebHookPayload = {
+      event: webhookEvent,
+      spaceId,
+      timestamp: new Date().toISOString(),
+      data: { translationId },
+    };
+    await triggerWebHooksForEvent(spaceId, webhookPayload);
+  }
+
   const countSnapshot = await findTranslationsHistory(spaceId).count().get();
   const { count } = countSnapshot.data();
   if (count > 30) {

src/app/features/spaces/contents/edit-document/edit-document.component.ts

@@ -272,7 +272,7 @@ export class EditDocumentComponent implements OnInit, DirtyFormGuardComponent {
   constructor() {}
 
   ngOnInit(): void {
-    this.history$ = this.contentHistoryService.findAll(this.spaceId(), this.contentId()).pipe(takeUntilDestroyed(this.destroyRef));
+    this.history$ = this.contentHistoryService.findAll(this.spaceId(), this.contentId(), 30).pipe(takeUntilDestroyed(this.destroyRef));
     const document = this.document();
     // Initialize document data
     if (document.kind === ContentKind.DOCUMENT) {

src/app/features/spaces/translations/translations.component.ts

@@ -326,7 +326,7 @@ export class TranslationsComponent implements OnInit {
           this.isLoading.set(false);
         },
       });
-    this.history$ = this.translateHistoryService.findAll(this.spaceId()).pipe(takeUntilDestroyed(this.destroyRef));
+    this.history$ = this.translateHistoryService.findAll(this.spaceId(), 30).pipe(takeUntilDestroyed(this.destroyRef));
   }
 
   publish(): void {

src/app/shared/models/webhook.model.ts

@@ -17,6 +17,10 @@ export enum WebHookEvent {
   CONTENT_UNPUBLISHED = 'content.unpublished',
   CONTENT_DELETED = 'content.deleted',
   CONTENT_UPDATED = 'content.updated',
+  TRANSLATION_PUBLISHED = 'translation.published',
+  TRANSLATION_ADDED = 'translation.added',
+  TRANSLATION_UPDATED = 'translation.updated',
+  TRANSLATION_DELETED = 'translation.deleted',
 }
 
 export type WebHookStatus = 'success' | 'failure';

src/app/shared/services/content-history.service.ts

@@ -9,8 +9,11 @@ import { map } from 'rxjs/operators';
 export class ContentHistoryService {
   private readonly firestore = inject(Firestore);
 
-  findAll(spaceId: string, id: string): Observable<ContentHistory[]> {
-    const queryConstrains: QueryConstraint[] = [orderBy('createdAt', 'desc'), limit(30)];
+  findAll(spaceId: string, id: string, max?: number): Observable<ContentHistory[]> {
+    const queryConstrains: QueryConstraint[] = [orderBy('createdAt', 'desc')];
+    if (max) {
+      queryConstrains.push(limit(max));
+    }
     return collectionData(query(collection(this.firestore, `spaces/${spaceId}/contents/${id}/histories`), ...queryConstrains), {
       idField: 'id',
     }).pipe(

src/app/shared/services/translation-history.service.ts

@@ -9,8 +9,11 @@ import { map } from 'rxjs/operators';
 export class TranslationHistoryService {
   private readonly firestore = inject(Firestore);
 
-  findAll(spaceId: string): Observable<TranslationHistory[]> {
-    const queryConstrains: QueryConstraint[] = [orderBy('createdAt', 'desc'), limit(30)];
+  findAll(spaceId: string, max?: number): Observable<TranslationHistory[]> {
+    const queryConstrains: QueryConstraint[] = [orderBy('createdAt', 'desc')];
+    if (max) {
+      queryConstrains.push(limit(max));
+    }
     return collectionData(query(collection(this.firestore, `spaces/${spaceId}/translations_history`), ...queryConstrains), {
       idField: 'id',
     }).pipe(