feat: add internal workflow step string status management methods (#572)

Author: NazarLysyi

src/workflows/index.ts

@@ -1,4 +1,4 @@
-import { CrowdinApi, isOptionalNumber, PaginationOptions, ResponseList, ResponseObject } from '../core';
+import { CrowdinApi, isOptionalNumber, PaginationOptions, PatchRequest, ResponseList, ResponseObject } from '../core';
 import { SourceStringsModel } from '../sourceStrings';
 
 /**
@@ -109,6 +109,42 @@ export class Workflows extends CrowdinApi {
         const url = `${this.url}/workflow-templates/${templateId}`;
         return this.get(url, this.defaultConfig());
     }
+
+    /**
+     * @param projectId project identifier
+     * @param stepId workflow step identifier
+     * @param languageId language identifier
+     * @param request request body
+     * @internal
+     * @see https://support.crowdin.com/developer/crowdin-apps-module-workflow-step-type/#api-methods
+     */
+    updateWorkflowStepStringStatus(
+        projectId: number,
+        stepId: number,
+        languageId: string,
+        request: PatchRequest[],
+    ): Promise<ResponseList<WorkflowModel.WorkflowStepStringStatus>> {
+        const url = `${this.url}/projects/${projectId}/workflow-steps/${stepId}/languages/${languageId}/status`;
+        return this.patch(url, request, this.defaultConfig());
+    }
+
+    /**
+     * @param projectId project identifier
+     * @param stepId workflow step identifier
+     * @param languageId language identifier
+     * @param options request options
+     * @internal
+     * @see https://support.crowdin.com/developer/crowdin-apps-module-workflow-step-type/#api-methods
+     */
+    getWorkflowStepStringStatus(
+        projectId: number,
+        stepId: number,
+        languageId: string,
+        options?: PaginationOptions,
+    ): Promise<ResponseList<WorkflowModel.WorkflowStepStringStatus>> {
+        const url = `${this.url}/projects/${projectId}/workflow-steps/${stepId}/languages/${languageId}/status`;
+        return this.getList(url, options?.limit, options?.offset);
+    }
 }
 
 export namespace WorkflowModel {
@@ -151,4 +187,12 @@ export namespace WorkflowModel {
             mtId: number;
         }[];
     }
+
+    export interface WorkflowStepStringStatus {
+        stringId: number;
+        languageId: string;
+        stepId: number;
+        status: string;
+        output: string;
+    }
 }

tests/workflows/api.test.ts

@@ -11,6 +11,7 @@ describe('Workflows API', () => {
     const id = 2;
     const projectId = 4;
     const stringId = 123;
+    const languageId = 'uk';
 
     const limit = 25;
 
@@ -89,6 +90,46 @@ describe('Workflows API', () => {
                 data: {
                     id: id,
                 },
+            })
+            .get(`/projects/${projectId}/workflow-steps/${id}/languages/${languageId}/status`, undefined, {
+                reqheaders: {
+                    Authorization: `Bearer ${api.token}`,
+                },
+            })
+            .reply(200, {
+                data: [
+                    {
+                        data: {
+                            stringId: stringId,
+                            languageId: languageId,
+                            stepId: id,
+                            status: 'DONE',
+                            output: 'translated',
+                        },
+                    },
+                ],
+                pagination: {
+                    offset: 0,
+                    limit: limit,
+                },
+            })
+            .patch(`/projects/${projectId}/workflow-steps/${id}/languages/${languageId}/status`, undefined, {
+                reqheaders: {
+                    Authorization: `Bearer ${api.token}`,
+                },
+            })
+            .reply(200, {
+                data: [
+                    {
+                        data: {
+                            stringId: stringId,
+                            languageId: languageId,
+                            stepId: id,
+                            status: 'DONE',
+                            output: 'approved',
+                        },
+                    },
+                ],
             });
     });
 
@@ -126,4 +167,32 @@ describe('Workflows API', () => {
         const workflow = await api.getWorkflowTemplateInfo(id);
         expect(workflow.data.id).toBe(id);
     });
+
+    it('Get Workflow Step String Status', async () => {
+        const stringStatuses = await api.getWorkflowStepStringStatus(projectId, id, languageId);
+        expect(stringStatuses.data.length).toBe(1);
+        expect(stringStatuses.data[0].data.stringId).toBe(stringId);
+        expect(stringStatuses.data[0].data.languageId).toBe(languageId);
+        expect(stringStatuses.data[0].data.stepId).toBe(id);
+        expect(stringStatuses.data[0].data.status).toBe('DONE');
+        expect(stringStatuses.data[0].data.output).toBe('translated');
+        expect(stringStatuses.pagination.limit).toBe(limit);
+    });
+
+    it('Update Workflow Step String Status', async () => {
+        const request = [
+            {
+                op: 'replace' as const,
+                path: `/${stringId}/output`,
+                value: 'approved',
+            },
+        ];
+        const result = await api.updateWorkflowStepStringStatus(projectId, id, languageId, request);
+        expect(result.data.length).toBe(1);
+        expect(result.data[0].data.stringId).toBe(stringId);
+        expect(result.data[0].data.languageId).toBe(languageId);
+        expect(result.data[0].data.stepId).toBe(id);
+        expect(result.data[0].data.status).toBe('DONE');
+        expect(result.data[0].data.output).toBe('approved');
+    });
 });