Merged PR 134: API修正（IF）

## 概要
[Task1922: API修正（IF）](https://paruru.nds-tyo.co.jp:8443/tfs/ReciproCollection/fa4924a4-d079-4fab-9fb5-a9a11eb205f0/_workitems/edit/1922)

- タスク取得APIの引数を修正
  - directionとparamNameを追加
- 定数を文字列配列からオブジェクトに変更

## レビューポイント
- 引数の型を自作のものに修正したが問題ないか。
  - Pull Request 128: API実装（ソート条件変更）で議論中

## UIの変更
- Before/Afterのスクショなど
- スクショ置き場

## 動作確認状況
- ローカルで確認

## 補足
- 相談、参考資料などがあれば

dictation_server/src/api/odms/openapi.json

@@ -677,6 +677,20 @@
             "description": "取得対象とするタスクのステータス。カンマ(,)区切りで複数指定可能。設定されない場合はすべてのステータスを取得対象とする。許容するステータスの値は次の通り: Uploaded / Pending / InProgress / Finished / Backup",
             "example": "Uploaded,Pending,InProgress",
             "schema": { "type": "string" }
+          },
+          {
+            "name": "direction",
+            "required": false,
+            "in": "query",
+            "description": "ASC/DESC",
+            "schema": { "type": "string" }
+          },
+          {
+            "name": "paramName",
+            "required": false,
+            "in": "query",
+            "description": "JOB_NUMBER/STATUS/ENCRYPTION/AUTHOR_ID/FILE_NAME/FILE_LENGTH/FILE_SIZE/RECORDING_STARTED_DATE/RECORDING_FINISHED_DATE/UPLOAD_DATE/TRANSCRIPTION_STARTED_DATE/TRANSCRIPTION_FINISHED_DATE",
+            "schema": { "type": "string" }
           }
         ],
         "responses": {

dictation_server/src/constants/index.ts

@@ -149,5 +149,7 @@ export const TASK_LIST_SORTABLE_ATTRIBUTES = [
   'TRANSCRIPTION_FINISHED_DATE',
 ] as const;
 
-// export const SORT_DIRECTIONS = { asc: 'ASC', desc: 'DESC' } as const;
+/**
+ * タスク一覧のソート条件（昇順・降順）
+ */
 export const SORT_DIRECTIONS = ['ASC', 'DESC'] as const;

dictation_server/src/features/accounts/accounts.controller.spec.ts

@@ -1,6 +1,7 @@
 import { Test, TestingModule } from '@nestjs/testing';
 import { AccountsController } from './accounts.controller';
 import { AccountsService } from './accounts.service';
+import { ConfigModule } from '@nestjs/config';
 
 describe('AccountsController', () => {
   let controller: AccountsController;
@@ -8,6 +9,12 @@ describe('AccountsController', () => {
 
   beforeEach(async () => {
     const module: TestingModule = await Test.createTestingModule({
+      imports: [
+        ConfigModule.forRoot({
+          envFilePath: ['.env.local', '.env'],
+          isGlobal: true,
+        }),
+      ],
       controllers: [AccountsController],
       providers: [AccountsService],
     })

dictation_server/src/features/accounts/accounts.controller.ts

@@ -22,8 +22,8 @@ import {
   GetLicenseSummaryResponse,
 } from './types/types';
 import { USER_ROLES, ADMIN_ROLES } from '../../constants';
-import { AuthGuard } from 'src/common/guards/auth/authguards';
-import { RoleGuard } from 'src/common/guards/role/roleguards';
+import { AuthGuard } from '../../common/guards/auth/authguards';
+import { RoleGuard } from '../../common/guards/role/roleguards';
 
 @ApiTags('accounts')
 @Controller('accounts')

dictation_server/src/features/licenses/licenses.service.spec.ts

@@ -1,4 +1,4 @@
-import { AccessToken } from 'src/common/token';
+import { AccessToken } from '../../common/token';
 import { CreateOrdersRequest } from './types/types';
 import {
   makeDefaultAccountsRepositoryMockValue,

dictation_server/src/features/licenses/licenses.service.ts

@@ -1,6 +1,6 @@
 import { HttpException, HttpStatus, Injectable, Logger } from '@nestjs/common';
 import { makeErrorResponse } from '../../common/error/makeErrorResponse';
-import { AccessToken } from 'src/common/token';
+import { AccessToken } from '../../common/token';
 import {
   UsersRepositoryService,
   UserNotFoundError,

dictation_server/src/features/tasks/types/types.ts

@@ -1,6 +1,9 @@
 import { ApiProperty } from '@nestjs/swagger';
 import { AudioOptionItem } from '../../../features/files/types/types';
-import { IsInt, IsOptional, Min } from 'class-validator';
+import { IsIn, IsInt, IsOptional, Min } from 'class-validator';
+
+import { Type } from 'class-transformer';
+import { TASK_LIST_SORTABLE_ATTRIBUTES } from '../../../constants';
 
 export class TasksRequest {
   @ApiProperty({
@@ -11,6 +14,7 @@ export class TasksRequest {
   @IsInt()
   @Min(0)
   @IsOptional()
+  @Type(() => Number)
   limit: number;
 
   @ApiProperty({
@@ -22,6 +26,7 @@ export class TasksRequest {
   @IsInt()
   @Min(0)
   @IsOptional()
+  @Type(() => Number)
   offset: number;
 
   @ApiProperty({
@@ -33,6 +38,24 @@ export class TasksRequest {
   @IsOptional()
   // TODO: 入力チェックを行うデコレータを追加する。@Matches or カスタムデコレータで実装想定。statusの値は先頭大文字であることまで一致しなくていいはず？（実装時レビューにて要確認）
   status?: string;
+
+  @ApiProperty({
+    required: false,
+    description: 'ASC/DESC',
+  })
+  @IsIn(['ASC', 'DESC'], { message: 'invalid direction' })
+  @IsOptional()
+  direction?: string;
+
+  @ApiProperty({
+    required: false,
+    description: `${TASK_LIST_SORTABLE_ATTRIBUTES.join('/')}`,
+  })
+  @IsIn(TASK_LIST_SORTABLE_ATTRIBUTES, {
+    message: 'invalid attributes',
+  })
+  @IsOptional()
+  paramName?: string;
 }
 
 export class Typist {

dictation_server/src/features/users/users.service.spec.ts

@@ -1,5 +1,5 @@
 import { HttpException, HttpStatus } from '@nestjs/common';
-import { AccessToken } from 'src/common/token';
+import { AccessToken } from '../../common/token';
 import { makeErrorResponse } from '../../common/error/makeErrorResponse';
 import { User as EntityUser } from '../../repositories/users/entity/user.entity';
 import { EmailAlreadyVerifiedError } from '../../repositories/users/users.repository.service';

dictation_server/src/repositories/tasks/tasks.repository.service.ts

@@ -3,7 +3,7 @@ import { DataSource } from 'typeorm';
 import { Task } from './entity/task.entity';
 import { TASK_STATUS } from '../../constants/index';
 import { AudioFile } from '../audio_files/entity/audio_file.entity';
-import { AudioOptionItem as ParamOptionItem } from 'src/features/files/types/types';
+import { AudioOptionItem as ParamOptionItem } from '../../features/files/types/types';
 import { AudioOptionItem } from '../audio_option_items/entity/audio_option_item.entity';
 
 @Injectable()