[API] New DTOs

Entjic · Entjic · commit 894bf80e3759 · 2026-02-27T14:17:13.000+01:00
diff --git a/openapi.json b/openapi.json
diff --git a/src/types/dtos/AnnotationDto.d.ts b/src/types/dtos/AnnotationDto.d.ts
@@ -1,15 +1,11 @@
-import type {
-    CharacterBoundingBoxDto
-} from '@/types/dtos/CharacterBoundingBoxDto';
-import type {
-    FixationDto
-} from '@/types/dtos/FixationDto';
+import type { CharacterBoundingBoxDto } from "@/types/dtos/CharacterBoundingBoxDto";
+import type { FixationDto } from "@/types/dtos/FixationDto";
 
 export interface AnnotationDto {
-    'id'?: number;
-    'annotationType'?: string;
-    'fixation'?: FixationDto;
-    'characterBoundingBox'?: CharacterBoundingBoxDto;
-    'dGeomWeight'?: number;
-    'pShareWeight'?: number;
+  id?: number;
+  annotationType?: string;
+  fixation?: FixationDto;
+  characterBoundingBox?: CharacterBoundingBoxDto;
+  dGeomWeight?: number;
+  pShareWeight?: number;
 }
diff --git a/src/types/dtos/AnnotationSessionDto.d.ts b/src/types/dtos/AnnotationSessionDto.d.ts
@@ -1,19 +1,14 @@
-import type {
-    AnnotationDto
-} from '@/types/dtos/AnnotationDto';
-import type {
-    AnnotationsMetaDataDto
-} from '@/types/dtos/AnnotationsMetaDataDto';
-import type {
-    ReadingSessionDto
-} from '@/types/dtos/ReadingSessionDto';
+import type { AnnotationDto } from "@/types/dtos/AnnotationDto";
+import type { AnnotationsMetaDataDto } from "@/types/dtos/AnnotationsMetaDataDto";
+import type { ReadingSessionDto } from "@/types/dtos/ReadingSessionDto";
 
 export interface AnnotationSessionDto {
-    'id'?: number;
-    'annotator'?: number;
-    'annotations'?: AnnotationDto[];
-    'annotationsMetaData'?: AnnotationsMetaDataDto;
-    'readingSession'?: ReadingSessionDto;
-    'inactiveMachineAnnotations'?: Record<string, unknown>;
-    'lastEdited'?: string;
+  id?: number;
+  annotator?: number;
+  annotations?: AnnotationDto[];
+  annotationsMetaData?: AnnotationsMetaDataDto;
+  readingSession?: ReadingSessionDto;
+  inactiveMachineAnnotations?: Record<string, unknown>;
+  lastEdited?: string;
+  removedFixations?: number[];
 }
diff --git a/src/types/dtos/AnnotationsMetaDataDto.d.ts b/src/types/dtos/AnnotationsMetaDataDto.d.ts
@@ -1,4 +1,4 @@
 export interface AnnotationsMetaDataDto {
-    'total'?: number;
-    'done'?: number;
+  total?: number;
+  done?: number;
 }
diff --git a/src/types/dtos/AuthRequest.d.ts b/src/types/dtos/AuthRequest.d.ts
@@ -1,4 +1,4 @@
 export interface AuthRequest {
-    'id'?: string;
-    'password'?: string;
+  id?: string;
+  password?: string;
 }
diff --git a/src/types/dtos/AuthResponse.d.ts b/src/types/dtos/AuthResponse.d.ts
@@ -1,3 +1,3 @@
 export interface AuthResponse {
-    'token'?: string;
+  token?: string;
 }
diff --git a/src/types/dtos/CharacterBoundingBoxDto.d.ts b/src/types/dtos/CharacterBoundingBoxDto.d.ts
@@ -1,8 +1,8 @@
 export interface CharacterBoundingBoxDto {
-    'id'?: number;
-    'character'?: string;
-    'xMin'?: number;
-    'xMax'?: number;
-    'yMin'?: number;
-    'yMax'?: number;
+  id?: number;
+  character?: string;
+  xMin?: number;
+  xMax?: number;
+  yMin?: number;
+  yMax?: number;
 }
diff --git a/src/types/dtos/CreateSurveyDto.d.ts b/src/types/dtos/CreateSurveyDto.d.ts
@@ -1,6 +1,6 @@
 export interface CreateSurveyDto {
-    'users'?: number;
-    'title'?: string;
-    'description'?: string;
-    'readingSessionIds'?: number[];
+  users?: number;
+  title?: string;
+  description?: string;
+  readingSessionIds?: number[];
 }
diff --git a/src/types/dtos/EditAnnotationsDto.d.ts b/src/types/dtos/EditAnnotationsDto.d.ts
@@ -1,3 +1,6 @@
 export interface EditAnnotationsDto {
-    'annotations'?: Record<string, unknown>;
+  annotations?: Record<string, unknown>;
+  fixationsToRemove?: number[];
+  annotationsToRemove?: Record<string, unknown>;
+  fixationsToUndoRemove?: number[];
 }
diff --git a/src/types/dtos/FixationDto.d.ts b/src/types/dtos/FixationDto.d.ts
@@ -1,6 +1,6 @@
 export interface FixationDto {
-    'id'?: number;
-    'x'?: number;
-    'y'?: number;
-    'disagreement'?: number;
+  id?: number;
+  x?: number;
+  y?: number;
+  disagreement?: number;
 }
diff --git a/src/types/dtos/ImportCharacterBoundingBoxDto.d.ts b/src/types/dtos/ImportCharacterBoundingBoxDto.d.ts
@@ -1,8 +1,8 @@
 export interface ImportCharacterBoundingBoxDto {
-    'foreignId'?: number;
-    'character'?: string;
-    'xMin'?: number;
-    'xMax'?: number;
-    'yMin'?: number;
-    'yMax'?: number;
+  foreignId?: number;
+  character?: string;
+  xMin?: number;
+  xMax?: number;
+  yMin?: number;
+  yMax?: number;
 }
diff --git a/src/types/dtos/ImportFixationDto.d.ts b/src/types/dtos/ImportFixationDto.d.ts
@@ -1,6 +1,6 @@
 export interface ImportFixationDto {
-    'foreignId'?: number;
-    'x'?: number;
-    'y'?: number;
-    'disagreement'?: number;
+  foreignId?: number;
+  x?: number;
+  y?: number;
+  disagreement?: number;
 }
diff --git a/src/types/dtos/ImportPreAnnotationDto.d.ts b/src/types/dtos/ImportPreAnnotationDto.d.ts
@@ -1,8 +1,6 @@
-import type {
-    PreAnnotationValueDto
-} from '@/types/dtos/PreAnnotationValueDto';
+import type { PreAnnotationValueDto } from "@/types/dtos/PreAnnotationValueDto";
 
 export interface ImportPreAnnotationDto {
-    'title'?: string;
-    'annotations'?: PreAnnotationValueDto[];
+  title?: string;
+  annotations?: PreAnnotationValueDto[];
 }
diff --git a/src/types/dtos/ImportReadingSessionDto.d.ts b/src/types/dtos/ImportReadingSessionDto.d.ts
@@ -1,14 +1,10 @@
-import type {
-    ImportFixationDto
-} from '@/types/dtos/ImportFixationDto';
-import type {
-    ImportPreAnnotationDto
-} from '@/types/dtos/ImportPreAnnotationDto';
+import type { ImportFixationDto } from "@/types/dtos/ImportFixationDto";
+import type { ImportPreAnnotationDto } from "@/types/dtos/ImportPreAnnotationDto";
 
 export interface ImportReadingSessionDto {
-    'fixations'?: ImportFixationDto[];
-    'readerForeignId'?: number;
-    'textForeignId'?: number;
-    'language'?: string;
-    'preAnnotations'?: ImportPreAnnotationDto[];
+  fixations?: ImportFixationDto[];
+  readerForeignId?: number;
+  textForeignId?: number;
+  language?: string;
+  preAnnotations?: ImportPreAnnotationDto[];
 }
diff --git a/src/types/dtos/ImportTextDto.d.ts b/src/types/dtos/ImportTextDto.d.ts
@@ -1,15 +1,11 @@
-import type {
-    ImportCharacterBoundingBoxDto
-} from '@/types/dtos/ImportCharacterBoundingBoxDto';
-import type {
-    ImportWordBoundingBoxDto
-} from '@/types/dtos/ImportWordBoundingBoxDto';
+import type { ImportCharacterBoundingBoxDto } from "@/types/dtos/ImportCharacterBoundingBoxDto";
+import type { ImportWordBoundingBoxDto } from "@/types/dtos/ImportWordBoundingBoxDto";
 
 export interface ImportTextDto {
-    'title'?: string;
-    'foreignId'?: number;
-    'language'?: string;
-    'characterBoundingBoxes'?: ImportCharacterBoundingBoxDto[];
-    'wordBoundingBoxes'?: ImportWordBoundingBoxDto[];
-    'backgroundImage'?: string;
+  title?: string;
+  foreignId?: number;
+  language?: string;
+  characterBoundingBoxes?: ImportCharacterBoundingBoxDto[];
+  wordBoundingBoxes?: ImportWordBoundingBoxDto[];
+  backgroundImage?: string;
 }
diff --git a/src/types/dtos/ImportWordBoundingBoxDto.d.ts b/src/types/dtos/ImportWordBoundingBoxDto.d.ts
@@ -1,8 +1,8 @@
 export interface ImportWordBoundingBoxDto {
-    'foreignId'?: number;
-    'word'?: string;
-    'xMin'?: number;
-    'xMax'?: number;
-    'yMin'?: number;
-    'yMax'?: number;
+  foreignId?: number;
+  word?: string;
+  xMin?: number;
+  xMax?: number;
+  yMin?: number;
+  yMax?: number;
 }
diff --git a/src/types/dtos/PreAnnotationValueDto.d.ts b/src/types/dtos/PreAnnotationValueDto.d.ts
@@ -1,6 +1,6 @@
 export interface PreAnnotationValueDto {
-    'foreignFixationId'?: number;
-    'foreignCharacterBoxId'?: number;
-    'dGeom'?: number;
-    'pShare'?: number;
+  foreignFixationId?: number;
+  foreignCharacterBoxId?: number;
+  dGeom?: number;
+  pShare?: number;
 }
diff --git a/src/types/dtos/ReadingSessionDto.d.ts b/src/types/dtos/ReadingSessionDto.d.ts
@@ -1,11 +1,7 @@
-import type {
-    FixationDto
-} from '@/types/dtos/FixationDto';
-import type {
-    TextDto
-} from '@/types/dtos/TextDto';
+import type { FixationDto } from "@/types/dtos/FixationDto";
+import type { TextDto } from "@/types/dtos/TextDto";
 
 export interface ReadingSessionDto {
-    'fixations'?: FixationDto[];
-    'textDto'?: TextDto;
+  fixations?: FixationDto[];
+  textDto?: TextDto;
 }
diff --git a/src/types/dtos/ShallowAnnotationSessionDto.d.ts b/src/types/dtos/ShallowAnnotationSessionDto.d.ts
@@ -1,15 +1,11 @@
-import type {
-    AnnotationsMetaDataDto
-} from '@/types/dtos/AnnotationsMetaDataDto';
-import type {
-    ShallowReadingSessionDto
-} from '@/types/dtos/ShallowReadingSessionDto';
+import type { AnnotationsMetaDataDto } from "@/types/dtos/AnnotationsMetaDataDto";
+import type { ShallowReadingSessionDto } from "@/types/dtos/ShallowReadingSessionDto";
 
 export interface ShallowAnnotationSessionDto {
-    'id'?: number;
-    'annotator'?: number;
-    'annotationsMetaData'?: AnnotationsMetaDataDto;
-    'readingSession'?: ShallowReadingSessionDto;
-    'lastEdited'?: string;
-    'description'?: string;
+  id?: number;
+  annotator?: number;
+  annotationsMetaData?: AnnotationsMetaDataDto;
+  readingSession?: ShallowReadingSessionDto;
+  lastEdited?: string;
+  description?: string;
 }
diff --git a/src/types/dtos/ShallowReadingSessionDto.d.ts b/src/types/dtos/ShallowReadingSessionDto.d.ts
@@ -1,7 +1,7 @@
 export interface ShallowReadingSessionDto {
-    'id'?: number;
-    'reader'?: number;
-    'textId'?: number;
-    'textTitle'?: string;
-    'uploadedAt'?: string;
+  id?: number;
+  reader?: number;
+  textId?: number;
+  textTitle?: string;
+  uploadedAt?: string;
 }
diff --git a/src/types/dtos/ShallowTextDto.d.ts b/src/types/dtos/ShallowTextDto.d.ts
@@ -1,4 +1,4 @@
 export interface ShallowTextDto {
-    'id'?: number;
-    'title'?: string;
+  id?: number;
+  title?: string;
 }
diff --git a/src/types/dtos/SignupRequest.d.ts b/src/types/dtos/SignupRequest.d.ts
@@ -1,6 +1,6 @@
 export interface SignupRequest {
-    'id'?: string;
-    'email'?: string;
-    'password'?: string;
-    'accountType'?: string;
+  id?: string;
+  email?: string;
+  password?: string;
+  accountType?: string;
 }
diff --git a/src/types/dtos/SurveyCreatedDto.d.ts b/src/types/dtos/SurveyCreatedDto.d.ts
@@ -1,8 +1,6 @@
-import type {
-    SurveyDto
-} from '@/types/dtos/SurveyDto';
+import type { SurveyDto } from "@/types/dtos/SurveyDto";
 
 export interface SurveyCreatedDto {
-    'surveyDto'?: SurveyDto;
-    'users'?: Record<string, unknown>;
+  surveyDto?: SurveyDto;
+  users?: Record<string, unknown>;
 }
diff --git a/src/types/dtos/SurveyDto.d.ts b/src/types/dtos/SurveyDto.d.ts
@@ -1,11 +1,9 @@
-import type {
-    ShallowAnnotationSessionDto
-} from '@/types/dtos/ShallowAnnotationSessionDto';
+import type { ShallowAnnotationSessionDto } from "@/types/dtos/ShallowAnnotationSessionDto";
 
 export interface SurveyDto {
-    'id'?: number;
-    'userIds'?: number[];
-    'title'?: string;
-    'description'?: string;
-    'annotationSessions'?: ShallowAnnotationSessionDto[];
+  id?: number;
+  userIds?: number[];
+  title?: string;
+  description?: string;
+  annotationSessions?: ShallowAnnotationSessionDto[];
 }
diff --git a/src/types/dtos/TextDto.d.ts b/src/types/dtos/TextDto.d.ts
@@ -1,14 +1,10 @@
-import type {
-    CharacterBoundingBoxDto
-} from '@/types/dtos/CharacterBoundingBoxDto';
-import type {
-    WordBoundingBoxDto
-} from '@/types/dtos/WordBoundingBoxDto';
+import type { CharacterBoundingBoxDto } from "@/types/dtos/CharacterBoundingBoxDto";
+import type { WordBoundingBoxDto } from "@/types/dtos/WordBoundingBoxDto";
 
 export interface TextDto {
-    'id'?: number;
-    'title'?: string;
-    'wordBoundingBoxes'?: WordBoundingBoxDto[];
-    'characterBoundingBoxes'?: CharacterBoundingBoxDto[];
-    'backgroundImage'?: string;
+  id?: number;
+  title?: string;
+  wordBoundingBoxes?: WordBoundingBoxDto[];
+  characterBoundingBoxes?: CharacterBoundingBoxDto[];
+  backgroundImage?: string;
 }
diff --git a/src/types/dtos/UserSurveyProgressDto.d.ts b/src/types/dtos/UserSurveyProgressDto.d.ts
@@ -1,5 +1,5 @@
 export interface UserSurveyProgressDto {
-    'userId'?: number;
-    'total'?: number;
-    'done'?: number;
+  userId?: number;
+  total?: number;
+  done?: number;
 }
diff --git a/src/types/dtos/WordBoundingBoxDto.d.ts b/src/types/dtos/WordBoundingBoxDto.d.ts
@@ -1,8 +1,8 @@
 export interface WordBoundingBoxDto {
-    'id'?: number;
-    'word'?: string;
-    'xMin'?: number;
-    'xMax'?: number;
-    'yMin'?: number;
-    'yMax'?: number;
+  id?: number;
+  word?: string;
+  xMin?: number;
+  xMax?: number;
+  yMin?: number;
+  yMax?: number;
 }

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`export interface AnnotationsMetaDataDto {`
`2`		`- 'total'?: number;`
`3`		`- 'done'?: number;`
	`2`	`+ total?: number;`
	`3`	`+ done?: number;`
`4`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`export interface AuthRequest {`
`2`		`- 'id'?: string;`
`3`		`- 'password'?: string;`
	`2`	`+ id?: string;`
	`3`	`+ password?: string;`
`4`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`export interface AuthResponse {`
`2`		`- 'token'?: string;`
	`2`	`+ token?: string;`
`3`	`3`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,6 @@`
`1`	`1`	`export interface EditAnnotationsDto {`
`2`		`- 'annotations'?: Record<string, unknown>;`
	`2`	`+ annotations?: Record<string, unknown>;`
	`3`	`+ fixationsToRemove?: number[];`
	`4`	`+ annotationsToRemove?: Record<string, unknown>;`
	`5`	`+ fixationsToUndoRemove?: number[];`
`3`	`6`	`}`