Api updates (#238)

* added translation alignment * added concordance search in TMs * added concordance search in Glossaries
crowdin · Mar 16, 2023 · 746373f · 746373f
1 parent 7e88692
commit 746373f
Show file tree

Hide file tree

Showing 8 changed files with 203 additions and 4 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@crowdin/crowdin-api-client",
-    "version": "1.22.0",
+    "version": "1.22.1",
     "description": "JavaScript library for Crowdin API v2.",
     "main": "out/index.js",
     "types": "out/index.d.ts",

diff --git a/src/glossaries/index.ts b/src/glossaries/index.ts
@@ -332,6 +332,19 @@ export class Glossaries extends CrowdinApi {
         const url = `${this.url}/glossaries/${glossaryId}/concepts/${conceptId}`;
         return this.delete(url, this.defaultConfig());
     }
+
+    /**
+     * @param projectId project identifier
+     * @param request request body
+     * @see https://developer.crowdin.com/api/v2/#operation/api.projects.glossaries.concordance.post
+     */
+    concordanceSearch(
+        projectId: number,
+        request: GlossariesModel.ConcordanceSearchRequest,
+    ): Promise<ResponseList<GlossariesModel.ConcordanceSearchResponse>> {
+        const url = `${this.url}/projects/${projectId}/glossaries/concordance`;
+        return this.post(url, request, this.defaultConfig());
+    }
 }
 
 export namespace GlossariesModel {
@@ -343,6 +356,8 @@ export namespace GlossariesModel {
         terms: number;
         languageId: string;
         languageIds: string[];
+        defaultProjectId: number;
+        defaultProjectIds: number[];
         projectIds: number[];
         createdAt: string;
     }
@@ -421,6 +436,19 @@ export namespace GlossariesModel {
         conceptId?: number;
     }
 
+    export interface ConcordanceSearchRequest extends PaginationOptions {
+        sourceLanguageId: string;
+        targetLanguageId: string;
+        expression: string;
+    }
+
+    export interface ConcordanceSearchResponse {
+        glossary: Glossary;
+        concept: Concept;
+        sourceTerms: Term[];
+        targetTerms: Term[];
+    }
+
     export type Status = 'preferred' | 'admitted' | 'not recommended' | 'obsolete';
 
     export type Type = 'full form' | 'acronym' | 'abbreviation' | 'short form' | 'phrase' | 'variant';

diff --git a/src/stringTranslations/index.ts b/src/stringTranslations/index.ts
@@ -185,6 +185,19 @@ export class StringTranslations extends CrowdinApi {
         return this.getList(url, options.limit, options.offset);
     }
 
+    /**
+     * @param projectId project identifier
+     * @param request request body
+     * @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.alignment.post
+     */
+    translationAlignment(
+        projectId: number,
+        request: StringTranslationsModel.TranslationAlignmentRequest,
+    ): Promise<ResponseObject<StringTranslationsModel.TranslationAlignmentResponse>> {
+        const url = `${this.url}/projects/${projectId}/translations/alignment`;
+        return this.post(url, request, this.defaultConfig());
+    }
+
     /**
      * @param projectId project identifier
      * @param stringId string identifier
@@ -456,6 +469,26 @@ export namespace StringTranslationsModel {
         createdAt: string;
     }
 
+    export interface TranslationAlignmentRequest {
+        sourceLanguageId: string;
+        targetLanguageId: string;
+        text: string;
+    }
+
+    export interface TranslationAlignmentResponse {
+        words: {
+            text: string;
+            alignments: {
+                sourceWord: string;
+                sourceLemma: string;
+                targetWord: string;
+                targetLemma: string;
+                match: number;
+                probability: number;
+            }[];
+        }[];
+    }
+
     export interface AddStringTranslationRequest {
         stringId: number;
         languageId: string;

diff --git a/src/translationMemory/index.ts b/src/translationMemory/index.ts
@@ -134,6 +134,19 @@ export class TranslationMemory extends CrowdinApi {
         return this.get(url, this.defaultConfig());
     }
 
+    /**
+     * @param projectId project identifier
+     * @param request request body
+     * @see https://developer.crowdin.com/api/v2/#operation/api.projects.tms.concordance.post
+     */
+    concordanceSearch(
+        projectId: number,
+        request: TranslationMemoryModel.ConcordanceSearchRequest,
+    ): Promise<ResponseList<TranslationMemoryModel.ConcordanceSearchResponse>> {
+        const url = `${this.url}/projects/${projectId}/tms/concordance`;
+        return this.post(url, request, this.defaultConfig());
+    }
+
     /**
      * @param tmId tm identifier
      * @param request request body
@@ -171,6 +184,7 @@ export namespace TranslationMemoryModel {
         languageIds: string[];
         segmentsCount: number;
         defaultProjectId: number;
+        defaultProjectIds: number[];
         projectIds: number[];
         createdAt: string;
     }
@@ -181,6 +195,24 @@ export namespace TranslationMemoryModel {
         groupId?: number;
     }
 
+    export interface ConcordanceSearchRequest {
+        sourceLanguageId: string;
+        targetLanguageId: string;
+        autoSubstitution: boolean;
+        minRelevant: number;
+        expression: string;
+    }
+
+    export interface ConcordanceSearchResponse {
+        tm: TranslationMemory;
+        recordId: number;
+        source: string;
+        target: string;
+        relevant: number;
+        substituted: string;
+        updatedAt: string;
+    }
+
     export interface ExportTranslationMemoryRequest {
         sourceLanguageId?: number;
         targetLanguageId?: number;

diff --git a/tests/glossaries/api.test.ts b/tests/glossaries/api.test.ts
@@ -21,6 +21,7 @@ describe('Glossaries API', () => {
     const termLanguageId = 'fr';
     const limit = 25;
     const groupId = 111;
+    const projectId = 123;
 
     const conceptId = 983;
     const subject = 'test';
@@ -305,7 +306,35 @@ describe('Glossaries API', () => {
                     Authorization: `Bearer ${api.token}`,
                 },
             })
-            .reply(200);
+            .reply(200)
+            .post(
+                `/projects/${projectId}/glossaries/concordance`,
+                {
+                    sourceLanguageId: termLanguageId,
+                    targetLanguageId: termLanguageId,
+                    expression: 'Welcome!',
+                },
+                {
+                    reqheaders: {
+                        Authorization: `Bearer ${api.token}`,
+                    },
+                },
+            )
+            .reply(200, {
+                data: [
+                    {
+                        data: {
+                            glossary: {
+                                id: glossaryId,
+                            },
+                        },
+                    },
+                ],
+                pagination: {
+                    offset: 0,
+                    limit: limit,
+                },
+            });
     });
 
     afterAll(() => {
@@ -448,4 +477,14 @@ describe('Glossaries API', () => {
     it('Delete concept', async () => {
         await api.deleteConcept(glossaryId, conceptId);
     });
+
+    it('Concordance search', async () => {
+        const res = await api.concordanceSearch(projectId, {
+            sourceLanguageId: termLanguageId,
+            targetLanguageId: termLanguageId,
+            expression: 'Welcome!',
+        });
+        expect(res.data.length).toBe(1);
+        expect(res.data[0].data.glossary.id).toBe(glossaryId);
+    });
 });
diff --git a/tests/stringTranslations/api.test.ts b/tests/stringTranslations/api.test.ts
@@ -89,6 +89,20 @@ describe('String Translations API', () => {
                     limit: limit,
                 },
             })
+            .post(`/projects/${projectId}/translations/alignment`, {
+                sourceLanguageId: languageId,
+                targetLanguageId: languageId,
+                text: 'test',
+            })
+            .reply(200, {
+                data: {
+                    words: [
+                        {
+                            text: 'test',
+                        },
+                    ],
+                },
+            })
             .get(`/projects/${projectId}/translations`, undefined, {
                 reqheaders: {
                     Authorization: `Bearer ${api.token}`,
@@ -256,6 +270,16 @@ describe('String Translations API', () => {
         expect(translations.pagination.limit).toBe(limit);
     });
 
+    it('Translation Alignment', async () => {
+        const res = await api.translationAlignment(projectId, {
+            sourceLanguageId: languageId,
+            targetLanguageId: languageId,
+            text: 'test',
+        });
+        expect(res.data.words.length).toBe(1);
+        expect(res.data.words[0].text).toBe('test');
+    });
+
     it('List String Translations', async () => {
         const translations = await api.listStringTranslations(projectId, stringId, languageId);
         expect(translations.data.length).toBe(1);

diff --git a/tests/translationMemory/api.test.ts b/tests/translationMemory/api.test.ts
@@ -11,6 +11,7 @@ describe('Translation Memory API', () => {
     const tmId = 2;
     const groupId = 44;
     const storageId = 55;
+    const projectId = 77;
     const exportId = '3';
     const importId = '4';
     const name = 'test';
@@ -113,6 +114,36 @@ describe('Translation Memory API', () => {
                     url: url,
                 },
             })
+            .post(
+                `/projects/${projectId}/tms/concordance`,
+                {
+                    sourceLanguageId: languageId,
+                    targetLanguageId: languageId,
+                    autoSubstitution: true,
+                    minRelevant: 60,
+                    expression: 'Welcome!',
+                },
+                {
+                    reqheaders: {
+                        Authorization: `Bearer ${api.token}`,
+                    },
+                },
+            )
+            .reply(200, {
+                data: [
+                    {
+                        data: {
+                            tm: {
+                                id: tmId,
+                            },
+                        },
+                    },
+                ],
+                pagination: {
+                    offset: 0,
+                    limit: limit,
+                },
+            })
             .post(
                 `/tms/${tmId}/exports`,
                 {},
@@ -215,6 +246,18 @@ describe('Translation Memory API', () => {
         expect(link.data.url).toBe(url);
     });
 
+    it('Concordance search in TMs', async () => {
+        const res = await api.concordanceSearch(projectId, {
+            autoSubstitution: true,
+            expression: 'Welcome!',
+            minRelevant: 60,
+            sourceLanguageId: languageId,
+            targetLanguageId: languageId,
+        });
+        expect(res.data.length).toBe(1);
+        expect(res.data[0].data.tm.id).toBe(tmId);
+    });
+
     it('Export TM', async () => {
         const status = await api.exportTm(tmId, {});
         expect(status.data.identifier).toBe(exportId);