chore: unify and simplify types structure for element options (#4475)

uzh-bf · Jan 24, 2025 · 7f474dd · 7f474dd
1 parent 1367343
commit 7f474dd
Show file tree

Hide file tree

Showing 25 changed files with 758 additions and 790 deletions.
diff --git a/apps/func-response-processor/src/index.ts b/apps/func-response-processor/src/index.ts
@@ -23,7 +23,7 @@ const DEFAULT_POINTS = 10 // points a participant gets for participating in a po
 const DEFAULT_CORRECT_POINTS = 5 // points a participant gets for answering correctly (independent of time)
 
 // TODO: what if the participant is not part of the course? when starting a session, prepopulate the leaderboard with all participations? what if a participant joins the course during a session? filter out all 0 point participants before rendering the LB
-// TODO: ensure that the response meets the restrictions specified in the question options
+// TODO: ensure that the response meets the restrictions specified in the element options
 
 Sentry.init()
 

diff --git a/packages/graphql/src/lib/validateAndProcessElementOptions.ts b/packages/graphql/src/lib/validateAndProcessElementOptions.ts
@@ -7,7 +7,7 @@ import validateNumericalOptions from './validateNumericalOptions.js'
 import validateSCOptions from './validateSCOptions.js'
 import validateSelectionOptions from './validateSelectionOptions.js'
 
-export interface QuestionOptionsArgs {
+export interface ElementOptionsArgs {
   unit?: string | null // NR only
   accuracy?: number | null // NR only
   placeholder?: string | null // NR/FT only
@@ -40,7 +40,7 @@ export interface QuestionOptionsArgs {
 
 function validateAndProcessElementOptions(
   elementType: DB.ElementType,
-  options?: QuestionOptionsArgs | null
+  options?: ElementOptionsArgs | null
 ) {
   switch (elementType) {
     case DB.ElementType.SC:

diff --git a/packages/graphql/src/lib/validateElementInputs.ts b/packages/graphql/src/lib/validateElementInputs.ts
@@ -1,5 +1,5 @@
 import * as DB from '@klicker-uzh/prisma'
-import { QuestionOptionsArgs } from './validateAndProcessElementOptions.js'
+import { ElementOptionsArgs } from './validateAndProcessElementOptions.js'
 
 export interface ManipulateQuestionArgs {
   id?: number | null
@@ -8,7 +8,7 @@ export interface ManipulateQuestionArgs {
   name?: string | null
   content?: string | null
   explanation?: string | null
-  options?: QuestionOptionsArgs | null
+  options?: ElementOptionsArgs | null
   pointsMultiplier?: number | null
   tags?: string[] | null
 }

diff --git a/packages/graphql/src/lib/validateFreeTextOptions.ts b/packages/graphql/src/lib/validateFreeTextOptions.ts
@@ -1,6 +1,6 @@
-import { QuestionOptionsArgs } from './validateAndProcessElementOptions.js'
+import { ElementOptionsArgs } from './validateAndProcessElementOptions.js'
 
-function validateFreeTextOptions(options?: QuestionOptionsArgs | null) {
+function validateFreeTextOptions(options?: ElementOptionsArgs | null) {
   // options and hasSampleSolution need to be defined
   if (
     !options ||

diff --git a/packages/graphql/src/lib/validateKPRIMOptions.ts b/packages/graphql/src/lib/validateKPRIMOptions.ts
@@ -1,7 +1,7 @@
-import { QuestionOptionsArgs } from './validateAndProcessElementOptions.js'
+import { ElementOptionsArgs } from './validateAndProcessElementOptions.js'
 import validateSharedChoicesFields from './validateSharedChoicesFields.js'
 
-function validateKPRIMOptions(options?: QuestionOptionsArgs | null) {
+function validateKPRIMOptions(options?: ElementOptionsArgs | null) {
   let valid = validateSharedChoicesFields(options)
   if (!valid) return false
 

diff --git a/packages/graphql/src/lib/validateMCOptions.ts b/packages/graphql/src/lib/validateMCOptions.ts
@@ -1,7 +1,7 @@
-import { QuestionOptionsArgs } from './validateAndProcessElementOptions.js'
+import { ElementOptionsArgs } from './validateAndProcessElementOptions.js'
 import validateSharedChoicesFields from './validateSharedChoicesFields.js'
 
-function validateMCOptions(options?: QuestionOptionsArgs | null) {
+function validateMCOptions(options?: ElementOptionsArgs | null) {
   let valid = validateSharedChoicesFields(options)
   if (!valid) return false
 

diff --git a/packages/graphql/src/lib/validateNumericalOptions.ts b/packages/graphql/src/lib/validateNumericalOptions.ts
@@ -1,6 +1,6 @@
-import { QuestionOptionsArgs } from './validateAndProcessElementOptions.js'
+import { ElementOptionsArgs } from './validateAndProcessElementOptions.js'
 
-function validateNumericalOptions(options?: QuestionOptionsArgs | null) {
+function validateNumericalOptions(options?: ElementOptionsArgs | null) {
   // options and hasSampleSolution need to be defined
   if (
     !options ||

diff --git a/packages/graphql/src/lib/validateSCOptions.ts b/packages/graphql/src/lib/validateSCOptions.ts
@@ -1,7 +1,7 @@
-import { QuestionOptionsArgs } from './validateAndProcessElementOptions.js'
+import { ElementOptionsArgs } from './validateAndProcessElementOptions.js'
 import validateSharedChoicesFields from './validateSharedChoicesFields.js'
 
-function validateSCOptions(options?: QuestionOptionsArgs | null) {
+function validateSCOptions(options?: ElementOptionsArgs | null) {
   let valid = validateSharedChoicesFields(options)
   if (!valid) return false
 

diff --git a/packages/graphql/src/lib/validateSelectionOptions.ts b/packages/graphql/src/lib/validateSelectionOptions.ts
@@ -1,6 +1,6 @@
-import { QuestionOptionsArgs } from './validateAndProcessElementOptions.js'
+import { ElementOptionsArgs } from './validateAndProcessElementOptions.js'
 
-function validateSelectionOptions(options?: QuestionOptionsArgs | null) {
+function validateSelectionOptions(options?: ElementOptionsArgs | null) {
   // options and hasSampleSolution need to be defined
   if (
     !options ||

diff --git a/packages/graphql/src/lib/validateSharedChoicesFields.ts b/packages/graphql/src/lib/validateSharedChoicesFields.ts
@@ -1,7 +1,7 @@
 import { DisplayMode } from '@klicker-uzh/types'
-import { QuestionOptionsArgs } from './validateAndProcessElementOptions.js'
+import { ElementOptionsArgs } from './validateAndProcessElementOptions.js'
 
-function validateSharedChoicesFields(options?: QuestionOptionsArgs | null) {
+function validateSharedChoicesFields(options?: ElementOptionsArgs | null) {
   // options and choices therein need to be defined
   if (!options || !options.choices) {
     console.error('Options are required on choices questions')