[frontend] chore: type api requests & store selects (#4591)

openaev-api/src/main/java/io/openaev/rest/challenge/response/ScenarioChallengesReader.java

@@ -3,6 +3,7 @@
 import com.fasterxml.jackson.annotation.JsonProperty;
 import io.openaev.database.model.Scenario;
 import io.openaev.rest.scenario.response.PublicScenario;
+import jakarta.validation.constraints.NotNull;
 import java.util.ArrayList;
 import java.util.List;
 import lombok.Getter;
@@ -13,6 +14,7 @@
 public class ScenarioChallengesReader {
 
   @JsonProperty("scenario_id")
+  @NotNull
   private String id;
 
   @JsonProperty("scenario_information")

openaev-api/src/main/java/io/openaev/rest/challenge/response/SimulationChallengesReader.java

@@ -3,6 +3,7 @@
 import com.fasterxml.jackson.annotation.JsonProperty;
 import io.openaev.database.model.Exercise;
 import io.openaev.rest.exercise.response.PublicExercise;
+import jakarta.validation.constraints.NotNull;
 import java.util.ArrayList;
 import java.util.List;
 import lombok.Getter;
@@ -13,6 +14,7 @@
 public class SimulationChallengesReader {
 
   @JsonProperty("exercise_id")
+  @NotNull
   private String id;
 
   @JsonProperty("exercise_information")

openaev-api/src/main/java/io/openaev/rest/channel/response/ChannelReader.java

@@ -7,6 +7,7 @@
 import io.openaev.database.model.Channel;
 import io.openaev.database.model.Exercise;
 import io.openaev.database.model.Scenario;
+import jakarta.validation.constraints.NotBlank;
 import java.util.ArrayList;
 import java.util.List;
 import lombok.Getter;
@@ -18,6 +19,7 @@ public class ChannelReader {
 
   @Setter(NONE)
   @JsonProperty("channel_id")
+  @NotBlank
   private String id;
 
   @JsonProperty("channel_information")

openaev-api/src/main/java/io/openaev/rest/inject/ScenarioInjectApi.java

@@ -26,6 +26,7 @@
 import jakarta.validation.constraints.NotNull;
 import java.util.*;
 import lombok.RequiredArgsConstructor;
+import org.springframework.data.domain.Page;
 import org.springframework.data.domain.Pageable;
 import org.springframework.data.jpa.domain.Specification;
 import org.springframework.transaction.annotation.Transactional;
@@ -60,7 +61,7 @@ public Iterable<InjectOutput> scenarioInjectsSimple(
       actionPerformed = Action.READ,
       resourceType = ResourceType.SCENARIO)
   @Transactional(readOnly = true)
-  public Iterable<InjectOutput> scenarioInjectsSimple(
+  public Page<InjectOutput> scenarioInjectsSimple(
       @PathVariable @NotBlank final String scenarioId,
       @RequestBody @Valid final SearchPaginationInput searchPaginationInput) {
     Map<String, Join<Base, Base>> joinMap = new HashMap<>();

openaev-api/src/main/java/io/openaev/rest/inject/SimulationInjectApi.java

@@ -98,7 +98,7 @@ public Iterable<InjectOutput> exerciseInjectsSimple(
       actionPerformed = Action.READ,
       resourceType = ResourceType.SIMULATION)
   @Transactional(readOnly = true)
-  public Iterable<InjectOutput> exerciseInjectsSimple(
+  public Page<InjectOutput> exerciseInjectsSimple(
       @PathVariable @NotBlank final String exerciseId,
       @RequestBody @Valid final SearchPaginationInput searchPaginationInput) {
     Map<String, Join<Base, Base>> joinMap = new HashMap<>();

openaev-framework/src/main/java/io/openaev/utils/FilterUtilsJpa.java

@@ -18,6 +18,7 @@
 import jakarta.persistence.criteria.Expression;
 import jakarta.persistence.criteria.Join;
 import jakarta.persistence.criteria.Predicate;
+import jakarta.validation.constraints.NotBlank;
 import jakarta.validation.constraints.NotNull;
 import java.time.Instant;
 import java.util.*;
@@ -33,7 +34,7 @@ private FilterUtilsJpa() {}
   public static final int PAGE_NUMBER_OPTION = 0;
   public static final int PAGE_SIZE_OPTION = 100;
 
-  public record Option(String id, String label) {}
+  public record Option(@NotBlank String id, @NotBlank String label) {}
 
   public static final Specification<?> EMPTY_SPECIFICATION = (root, query, cb) -> cb.conjunction();
 

openaev-front/src/actions/Application.js

@@ -2,55 +2,55 @@ import { FORM_ERROR } from 'final-form';
 
 import * as Constants from '../constants/ActionTypes';
 import { getReferential, postReferential, putReferential, simpleCall } from '../utils/Action';
-import * as schema from './Schema';
+import { platformParameters, token, user } from './schemas';
 
 export const fetchPlatformParameters = () => (dispatch) => {
-  return getReferential(schema.platformParameters, '/api/settings')(dispatch);
+  return getReferential(platformParameters, '/api/settings')(dispatch);
 };
 
 export const updatePlatformParameters = data => (dispatch) => {
   return putReferential(
-    schema.platformParameters,
+    platformParameters,
     '/api/settings',
     data,
   )(dispatch);
 };
 
 export const updatePlatformPolicies = data => (dispatch) => {
   return putReferential(
-    schema.platformParameters,
+    platformParameters,
     '/api/settings/policies',
     data,
   )(dispatch);
 };
 
 export const updatePlatformEnterpriseEditionParameters = data => (dispatch) => {
   return putReferential(
-    schema.platformParameters,
+    platformParameters,
     '/api/settings/enterprise-edition',
     data,
   )(dispatch);
 };
 
 export const updatePlatformWhitemarkParameters = data => (dispatch) => {
   return putReferential(
-    schema.platformParameters,
+    platformParameters,
     '/api/settings/platform_whitemark',
     data,
   )(dispatch);
 };
 
 export const updatePlatformLightParameters = data => (dispatch) => {
   return putReferential(
-    schema.platformParameters,
+    platformParameters,
     '/api/settings/theme/light',
     data,
   )(dispatch);
 };
 
 export const updatePlatformDarkParameters = data => (dispatch) => {
   return putReferential(
-    schema.platformParameters,
+    platformParameters,
     '/api/settings/theme/dark',
     data,
   )(dispatch);
@@ -61,7 +61,7 @@ export const askReset = (username, locale) => (dispatch) => {
     login: username,
     lang: locale,
   };
-  return postReferential(schema.user, '/api/reset', data)(dispatch);
+  return postReferential(user, '/api/reset', data)(dispatch);
 };
 
 export const resetPassword = (token, values) => (dispatch) => {
@@ -70,7 +70,7 @@ export const resetPassword = (token, values) => (dispatch) => {
     password_validation: values.password_validation,
   };
   const ref = postReferential(
-    schema.user,
+    user,
     `/api/reset/${token}`,
     data,
   )(dispatch);
@@ -94,7 +94,7 @@ export const askToken = (username, password) => (dispatch) => {
     login: username,
     password,
   };
-  const ref = postReferential(schema.user, '/api/login', data)(dispatch);
+  const ref = postReferential(user, '/api/login', data)(dispatch);
   return ref.then((finalData) => {
     if (finalData[FORM_ERROR]) {
       return finalData;
@@ -107,7 +107,7 @@ export const askToken = (username, password) => (dispatch) => {
 };
 
 export const checkKerberos = () => (dispatch) => {
-  const ref = getReferential(schema.token, '/api/auth/kerberos')(dispatch);
+  const ref = getReferential(token, '/api/auth/kerberos')(dispatch);
   return ref.catch(() => {
     dispatch({
       type: Constants.IDENTITY_LOGIN_FAILED,
@@ -117,7 +117,7 @@ export const checkKerberos = () => (dispatch) => {
 };
 
 export const fetchMe = () => (dispatch) => {
-  const ref = getReferential(schema.user, '/api/me')(dispatch);
+  const ref = getReferential(user, '/api/me')(dispatch);
   return ref.then(data => dispatch({
     type: Constants.IDENTITY_LOGIN_SUCCESS,
     payload: data,

openaev-front/src/actions/AttackPattern.ts

@@ -1,24 +1,26 @@
 import { type Dispatch } from 'redux';
 
+import { type Page } from '../components/common/queryable/Page';
 import { delReferential, getReferential, postReferential, putReferential, simpleCall, simplePostCall } from '../utils/Action';
 import {
   type AttackPattern,
   type AttackPatternCreateInput,
   type AttackPatternUpdateInput,
+  type Option,
   type SearchPaginationInput,
 } from '../utils/api-types';
-import * as schema from './Schema';
+import { arrayOfAttackPatterns, attackPattern } from './schemas';
 
 const ATTACK_PATTERN_URI = '/api/attack_patterns';
 
-export const fetchAttackPatterns = () => (dispatch: Dispatch) => {
-  return getReferential(schema.arrayOfAttackPatterns, ATTACK_PATTERN_URI)(dispatch);
+export const fetchAttackPatterns = (dispatch: Dispatch) => {
+  return getReferential<AttackPattern[]>(arrayOfAttackPatterns, ATTACK_PATTERN_URI)(dispatch);
 };
 
 export const searchAttackPatterns = (paginationInput: SearchPaginationInput) => {
   const data = paginationInput;
   const uri = `${ATTACK_PATTERN_URI}/search`;
-  return simplePostCall(uri, data);
+  return simplePostCall<Page<AttackPattern>>(uri, data);
 };
 
 export const searchAttackPatternsWithAIWebservice = (files: File[], text: string) => {
@@ -27,16 +29,16 @@ export const searchAttackPatternsWithAIWebservice = (files: File[], text: string
     formData.append('files', file);
   });
   formData.append('text', new Blob([JSON.stringify({ text })], { type: 'application/json' }));
-  return simplePostCall(`${ATTACK_PATTERN_URI}/search-with-ai`, formData);
+  return simplePostCall<string[]>(`${ATTACK_PATTERN_URI}/search-with-ai`, formData);
 };
 
 export const updateAttackPattern = (attackPatternId: AttackPattern['attack_pattern_id'], data: AttackPatternUpdateInput) => (dispatch: Dispatch) => {
   const uri = `${ATTACK_PATTERN_URI}/${attackPatternId}`;
-  return putReferential(schema.attackPattern, uri, data)(dispatch);
+  return putReferential<AttackPattern>(attackPattern, uri, data)(dispatch);
 };
 
 export const addAttackPattern = (data: AttackPatternCreateInput) => (dispatch: Dispatch) => {
-  return postReferential(schema.attackPattern, ATTACK_PATTERN_URI, data)(dispatch);
+  return postReferential<AttackPattern>(attackPattern, ATTACK_PATTERN_URI, data)(dispatch);
 };
 
 export const deleteAttackPattern = (attackPatternId: AttackPattern['attack_pattern_id']) => (dispatch: Dispatch) => {
@@ -48,9 +50,9 @@ export const deleteAttackPattern = (attackPatternId: AttackPattern['attack_patte
 
 export const searchAttackPatternsByNameAsOption = (searchText: string = '') => {
   const params = { searchText };
-  return simpleCall(`${ATTACK_PATTERN_URI}/options`, { params });
+  return simpleCall<Option[]>(`${ATTACK_PATTERN_URI}/options`, { params });
 };
 
 export const searchAttackPatternsByIdAsOption = (ids: string[]) => {
-  return simplePostCall(`${ATTACK_PATTERN_URI}/options`, ids);
+  return simplePostCall<Option[]>(`${ATTACK_PATTERN_URI}/options`, ids);
 };

openaev-front/src/actions/Collector.js

@@ -1,14 +1,14 @@
 import { delReferential, getReferential, postReferential, putReferential, simplePostCall } from '../utils/Action';
-import * as schema from './Schema';
+import { arrayOfCollectors, collector } from './schemas';
 
 export const fetchCollectors = () => (dispatch) => {
   const uri = '/api/collectors';
-  return getReferential(schema.arrayOfCollectors, uri)(dispatch);
+  return getReferential(arrayOfCollectors, uri)(dispatch);
 };
 
 export const fetchCollector = collectorId => (dispatch) => {
   const uri = `/api/collectors/${collectorId}`;
-  return getReferential(schema.collector, uri)(dispatch);
+  return getReferential(collector, uri)(dispatch);
 };
 
 export const searchCollectors = (paginationInput) => {
@@ -19,12 +19,12 @@ export const searchCollectors = (paginationInput) => {
 
 export const updateCollector = (collectorId, data) => (dispatch) => {
   const uri = `/api/collectors/${collectorId}`;
-  return putReferential(schema.collector, uri, data)(dispatch);
+  return putReferential(collector, uri, data)(dispatch);
 };
 
 export const addCollector = data => (dispatch) => {
   const uri = '/api/collectors';
-  return postReferential(schema.collector, uri, data)(dispatch);
+  return postReferential(collector, uri, data)(dispatch);
 };
 
 export const deleteCollector = collectorId => (dispatch) => {

openaev-front/src/actions/Comcheck.js

@@ -1,19 +1,19 @@
 import { delReferential, getReferential, postReferential } from '../utils/Action';
-import * as schema from './Schema';
+import { arrayOfComchecks, arrayOfComcheckStatuses, comcheck, comcheckStatus } from './schemas';
 
 export const fetchComchecks = exerciseId => (dispatch) => {
   const uri = `/api/exercises/${exerciseId}/comchecks`;
-  return getReferential(schema.arrayOfComchecks, uri)(dispatch);
+  return getReferential(arrayOfComchecks, uri)(dispatch);
 };
 
 export const fetchComcheck = (exerciseId, comcheckId) => (dispatch) => {
   const uri = `/api/exercises/${exerciseId}/comchecks/${comcheckId}`;
-  return getReferential(schema.comcheck, uri)(dispatch);
+  return getReferential(comcheck, uri)(dispatch);
 };
 
 export const addComcheck = (exerciseId, data) => (dispatch) => {
   const uri = `/api/exercises/${exerciseId}/comchecks`;
-  return postReferential(schema.comcheck, uri, data)(dispatch);
+  return postReferential(comcheck, uri, data)(dispatch);
 };
 
 export const deleteComcheck = (exerciseId, comcheckId) => (dispatch) => {
@@ -23,10 +23,10 @@ export const deleteComcheck = (exerciseId, comcheckId) => (dispatch) => {
 
 export const fetchComcheckStatuses = (exerciseId, comcheckId) => (dispatch) => {
   const uri = `/api/exercises/${exerciseId}/comchecks/${comcheckId}/statuses`;
-  return getReferential(schema.arrayOfComcheckStatuses, uri)(dispatch);
+  return getReferential(arrayOfComcheckStatuses, uri)(dispatch);
 };
 
 export const fetchComcheckStatus = statusId => (dispatch) => {
   const uri = `/api/comcheck/${statusId}`;
-  return getReferential(schema.comcheckStatus, uri)(dispatch);
+  return getReferential(comcheckStatus, uri)(dispatch);
 };

openaev-front/src/actions/Communication.js

@@ -1,12 +1,12 @@
 import { getReferential } from '../utils/Action';
-import * as schema from './Schema';
+import { arrayOfCommunications } from './schemas';
 
 export const fetchExerciseCommunications = exerciseId => (dispatch) => {
   const uri = `/api/exercises/${exerciseId}/communications`;
-  return getReferential(schema.arrayOfCommunications, uri)(dispatch);
+  return getReferential(arrayOfCommunications, uri)(dispatch);
 };
 
 export const fetchInjectCommunications = (exerciseId, injectId) => (dispatch) => {
   const uri = `/api/exercises/${exerciseId}/injects/${injectId}/communications`;
-  return getReferential(schema.arrayOfCommunications, uri)(dispatch);
+  return getReferential(arrayOfCommunications, uri)(dispatch);
 };

openaev-front/src/actions/Document.ts

@@ -1,26 +1,27 @@
 import { type Dispatch } from 'redux';
 
+import { type Page } from '../components/common/queryable/Page';
 import { delReferential, getReferential, postReferential, putReferential, simplePostCall } from '../utils/Action';
 import { type DocumentCreateInput, type DocumentUpdateInput, type SearchPaginationInput } from '../utils/api-types';
-import * as schema from './Schema';
+import { arrayOfDocuments, document } from './schemas';
 
-export const fetchDocuments = () => (dispatch: Dispatch) => getReferential(schema.arrayOfDocuments, '/api/documents')(dispatch);
+export const fetchDocuments = () => (dispatch: Dispatch) => getReferential<Document[]>(arrayOfDocuments, '/api/documents')(dispatch);
 
-export const fetchDocument = (documentId: string) => (dispatch: Dispatch) => getReferential(schema.document, `/api/documents/${documentId}`)(dispatch);
+export const fetchDocument = (documentId: string) => (dispatch: Dispatch) => getReferential<Document>(document, `/api/documents/${documentId}`)(dispatch);
 
 export const searchDocuments = (paginationInput: SearchPaginationInput) => {
   const data = paginationInput;
   const uri = '/api/documents/search';
-  return simplePostCall(uri, data);
+  return simplePostCall<Page<Document>>(uri, data);
 };
 
 export const addDocument = (data: DocumentCreateInput) => (dispatch: Dispatch) => {
   const uri = '/api/documents';
-  return postReferential(schema.document, uri, data)(dispatch);
+  return postReferential<Document>(document, uri, data)(dispatch);
 };
 
 export const updateDocument = (documentId: string, data: DocumentUpdateInput) => (dispatch: Dispatch) => putReferential(
-  schema.document,
+  document,
   `/api/documents/${documentId}`,
   data,
 )(dispatch);
@@ -31,11 +32,11 @@ export const deleteDocument = (documentId: string) => (dispatch: Dispatch) => {
 };
 
 export const fetchSimulationPlayerDocuments = (simulationId: string, userId = null) => (dispatch: Dispatch) => getReferential(
-  schema.arrayOfDocuments,
+  arrayOfDocuments,
   `/api/player/simulations/${simulationId}/documents${userId ? `?userId=${userId}` : ''}`,
 )(dispatch);
 
 export const fetchScenarioPlayerDocuments = (scenarioId: string, userId = null) => (dispatch: Dispatch) => getReferential(
-  schema.arrayOfDocuments,
+  arrayOfDocuments,
   `/api/player/scenarios/${scenarioId}/documents${userId ? `?userId=${userId}` : ''}`,
 )(dispatch);