feat(translations): add new pre-translate parameters (#681)

Author: andrii-bodnar

src/translations/index.ts

@@ -317,36 +317,56 @@ export namespace TranslationsModel {
         languageIds: string[];
         fileIds: number[];
         method?: Method;
+        priority?: Priority;
         engineId?: number;
         aiPromptId?: number;
         autoApproveOption?: AutoApproveOption;
         duplicateTranslations?: boolean;
         skipApprovedTranslations?: boolean;
+        /**
+         * @deprecated Use {@link scope} instead
+         */
         translateUntranslatedOnly?: boolean;
+        scope?: Scope;
+        translationModifiedBefore?: string;
+        replaceTranslationsOption?: ReplaceTranslationsOption;
+        resetApprovalStatus?: boolean;
         translateWithPerfectMatchOnly?: boolean;
         fallbackLanguages?: {
             languageId?: string[];
         };
         labelIds?: number[];
         excludeLabelIds?: number[];
+        sourceLanguageId?: string;
+        customInstruction?: string;
     }
 
     export interface PreTranslateStringsRequest {
         languageIds: string[];
         branchIds?: number[];
         method?: Method;
+        priority?: Priority;
         engineId?: number;
         aiPromptId?: number;
         autoApproveOption?: AutoApproveOption;
         duplicateTranslations?: boolean;
         skipApprovedTranslations?: boolean;
+        /**
+         * @deprecated Use {@link scope} instead
+         */
         translateUntranslatedOnly?: boolean;
+        scope?: Scope;
+        translationModifiedBefore?: string;
+        replaceTranslationsOption?: ReplaceTranslationsOption;
+        resetApprovalStatus?: boolean;
         translateWithPerfectMatchOnly?: boolean;
         fallbackLanguages?: {
             languageId: string[];
         };
         labelIds?: number[];
         excludeLabelIds?: number[];
+        sourceLanguageId?: string;
+        customInstruction?: string;
     }
 
     export interface BuildProjectDirectoryTranslationRequest {
@@ -407,7 +427,16 @@ export namespace TranslationsModel {
 
     export type Method = 'tm' | 'mt' | 'ai';
 
-    export type AutoApproveOption = 'all' | 'exceptAutoSubstituted' | 'perfectMatchOnly' | 'none';
+    export type AutoApproveOption =
+        | 'all'
+        | 'exceptAutoSubstituted'
+        | 'perfectMatchOnly'
+        | 'perfectMatchApprovedOnly'
+        | 'none';
+
+    export type Scope = 'untranslated' | 'translated' | 'all';
+
+    export type ReplaceTranslationsOption = 'none' | 'autoTranslated' | 'all';
 
     export type Priority = 'low' | 'normal' | 'high';
 

tests/translations/api.test.ts

@@ -355,6 +355,32 @@ describe('Translations API', () => {
                     },
                 },
             )
+            .reply(200, {
+                data: {
+                    identifier: preTranslationId,
+                    attributes: {},
+                },
+            })
+            .post(
+                `/projects/${projectId}/pre-translations`,
+                {
+                    languageIds: [],
+                    fileIds: [],
+                    method: 'ai',
+                    priority: 'high',
+                    scope: 'untranslated',
+                    translationModifiedBefore: '2024-01-01T00:00:00+00:00',
+                    replaceTranslationsOption: 'autoTranslated',
+                    resetApprovalStatus: true,
+                    sourceLanguageId: 'en',
+                    customInstruction: 'Translate formally',
+                },
+                {
+                    reqheaders: {
+                        Authorization: `Bearer ${api.token}`,
+                    },
+                },
+            )
             .reply(200, {
                 data: {
                     identifier: preTranslationId,
@@ -392,6 +418,22 @@ describe('Translations API', () => {
         expect(preTranslation.data.identifier).toBe(preTranslationId);
     });
 
+    it('Apply Pre-Translation with new options', async () => {
+        const preTranslation = await api.applyPreTranslation(projectId, {
+            fileIds: [],
+            languageIds: [],
+            method: 'ai',
+            priority: 'high',
+            scope: 'untranslated',
+            translationModifiedBefore: '2024-01-01T00:00:00+00:00',
+            replaceTranslationsOption: 'autoTranslated',
+            resetApprovalStatus: true,
+            sourceLanguageId: 'en',
+            customInstruction: 'Translate formally',
+        });
+        expect(preTranslation.data.identifier).toBe(preTranslationId);
+    });
+
     it('Pre-translation status', async () => {
         const preTranslation = await api.preTranslationStatus(projectId, preTranslationId);
         expect(preTranslation.data.identifier).toBe(preTranslationId);