0.11.0

.env.coding-box.template

@@ -15,6 +15,11 @@ POSTGRES_DB=coding-box
 ## Backend
 JWT_SECRET=random_string
 
+## Redis
+REDIS_HOST=redis
+REDIS_PORT=6379
+REDIS_PREFIX=coding-box
+
 ## Infrastructure
 SERVER_NAME=hostname.de
 TRAEFIK_DIR=

Makefile

@@ -70,6 +70,35 @@ dev-db-rollback-lastchangeset:
 dev-db-generate-docs:
 	$(MAKE) -f $(MK_FILE_DIR)/dev-db.mk -C $(MK_FILE_DIR) $@
 
+dev-redis-registry-login:
+	$(MAKE) -f $(MK_FILE_DIR)/dev-redis.mk -C $(MK_FILE_DIR) $@
+dev-redis-registry-logout:
+	$(MAKE) -f $(MK_FILE_DIR)/dev-redis.mk -C $(MK_FILE_DIR) $@
+dev-redis-build:
+	$(MAKE) -f $(MK_FILE_DIR)/dev-redis.mk -C $(MK_FILE_DIR) $@
+dev-redis-up:
+	$(MAKE) -f $(MK_FILE_DIR)/dev-redis.mk -C $(MK_FILE_DIR) $@
+dev-redis-down:
+	$(MAKE) -f $(MK_FILE_DIR)/dev-redis.mk -C $(MK_FILE_DIR) $@
+dev-redis-volumes-clean:
+	$(MAKE) -f $(MK_FILE_DIR)/dev-redis.mk -C $(MK_FILE_DIR) $@
+dev-redis-images-clean:
+	$(MAKE) -f $(MK_FILE_DIR)/dev-redis.mk -C $(MK_FILE_DIR) $@
+dev-redis-monitor:
+	$(MAKE) -f $(MK_FILE_DIR)/dev-redis.mk -C $(MK_FILE_DIR) $@
+dev-redis-info:
+	$(MAKE) -f $(MK_FILE_DIR)/dev-redis.mk -C $(MK_FILE_DIR) $@
+dev-redis-stats:
+	$(MAKE) -f $(MK_FILE_DIR)/dev-redis.mk -C $(MK_FILE_DIR) $@
+dev-redis-ping:
+	$(MAKE) -f $(MK_FILE_DIR)/dev-redis.mk -C $(MK_FILE_DIR) $@
+dev-redis-flush-all:
+	$(MAKE) -f $(MK_FILE_DIR)/dev-redis.mk -C $(MK_FILE_DIR) $@
+dev-redis-flush-db:
+	$(MAKE) -f $(MK_FILE_DIR)/dev-redis.mk -C $(MK_FILE_DIR) $@
+dev-redis-cli:
+	$(MAKE) -f $(MK_FILE_DIR)/dev-redis.mk -C $(MK_FILE_DIR) $@
+
 dev-test-app:
 	$(MAKE) -f $(MK_FILE_DIR)/dev-test.mk -C $(MK_FILE_DIR) $@
 dev-test-backend:
@@ -125,6 +154,21 @@ coding-box-restore-db-data-only:
 coding-box-update:
 	$(MAKE) -f $(MK_FILE_DIR)/prod.mk -C $(MK_FILE_DIR) $@
 
+coding-box-redis-monitor:
+	$(MAKE) -f $(MK_FILE_DIR)/prod.mk -C $(MK_FILE_DIR) $@
+coding-box-redis-info:
+	$(MAKE) -f $(MK_FILE_DIR)/prod.mk -C $(MK_FILE_DIR) $@
+coding-box-redis-stats:
+	$(MAKE) -f $(MK_FILE_DIR)/prod.mk -C $(MK_FILE_DIR) $@
+coding-box-redis-ping:
+	$(MAKE) -f $(MK_FILE_DIR)/prod.mk -C $(MK_FILE_DIR) $@
+coding-box-redis-flush-all:
+	$(MAKE) -f $(MK_FILE_DIR)/prod.mk -C $(MK_FILE_DIR) $@
+coding-box-redis-flush-db:
+	$(MAKE) -f $(MK_FILE_DIR)/prod.mk -C $(MK_FILE_DIR) $@
+coding-box-redis-cli:
+	$(MAKE) -f $(MK_FILE_DIR)/prod.mk -C $(MK_FILE_DIR) $@
+
 push-dockerhub:
 	$(MAKE) -f $(MK_FILE_DIR)/push.mk -C $(MK_FILE_DIR) $@
 push-iqb-registry:

api-dto/coding/codebook-content-setting.ts

@@ -0,0 +1,25 @@
+/**
+ * Settings for codebook content generation
+ */
+export interface CodeBookContentSetting {
+  /** Export format (docx or json) */
+  exportFormat: string;
+  /** Missings profile name */
+  missingsProfile: string;
+  /** Include only manual coding */
+  hasOnlyManualCoding: boolean;
+  /** Include general instructions */
+  hasGeneralInstructions: boolean;
+  /** Include derived variables */
+  hasDerivedVars: boolean;
+  /** Include only variables with codes */
+  hasOnlyVarsWithCodes: boolean;
+  /** Include closed variables */
+  hasClosedVars: boolean;
+  /** Convert code labels to uppercase */
+  codeLabelToUpper: boolean;
+  /** Show score */
+  showScore: boolean;
+  /** Hide item-variable relation */
+  hideItemVarRelation: boolean;
+}

api-dto/coding/missings-profiles.dto.ts

@@ -0,0 +1,41 @@
+export interface MissingDto {
+  id: string;
+  label: string;
+  description: string;
+  code: number;
+}
+
+export class MissingsProfilesDto {
+  id?: number;
+  label!: string;
+  missings!: string;
+
+  parseMissings(): MissingDto[] {
+    try {
+      if (!this.missings) {
+        return [];
+      }
+
+      if (Array.isArray(this.missings)) {
+        return this.missings as unknown as MissingDto[];
+      }
+
+      if (typeof this.missings === 'string') {
+        const parsed = JSON.parse(this.missings);
+        return Array.isArray(parsed) ? parsed : [];
+      }
+
+      return [];
+    } catch (error) {
+      return [];
+    }
+  }
+
+  setMissings(missings: MissingDto[]): void {
+    if (typeof missings === 'string') {
+      this.missings = missings;
+    } else {
+      this.missings = JSON.stringify(missings);
+    }
+  }
+}

api-dto/coding/variable-analysis-item.dto.ts

@@ -0,0 +1,31 @@
+export interface VariableAnalysisItemDto {
+  // Link to the replay of unit with its responses
+  replayUrl: string;
+
+  // Unit ID
+  unitId: string;
+
+  // Variable ID
+  variableId: string;
+
+  // Derivation
+  derivation: string;
+
+  // Code
+  code: string;
+
+  // Description
+  description: string;
+
+  // Score
+  score: number;
+
+  // How often this unitId in combination with variableId with that code is in responses
+  occurrenceCount: number;
+
+  // Total amount of that combination variableId and unit Id
+  totalCount: number;
+
+  // Relative occurrence (for bar chart)
+  relativeOccurrence: number;
+}

api-dto/unit-info/unit-coding-scheme-ref.dto.ts

@@ -0,0 +1,10 @@
+/**
+ * Data transfer object for a coding scheme reference
+ * Based on the CodingSchemeRef element in unit.xsd schema
+ */
+export class UnitCodingSchemeRefDto {
+  content!: string;
+  schemer!: string;
+  schemeType?: string;
+  lastChange?: Date;
+}

api-dto/unit-info/unit-definition.dto.ts

@@ -0,0 +1,11 @@
+/**
+ * Data transfer object for unit definition
+ * Based on the Definition/DefinitionRef element in unit.xsd schema
+ */
+export class UnitDefinitionDto {
+  type!: 'Definition' | 'DefinitionRef';
+  player!: string;
+  editor?: string;
+  content!: string;
+  lastChange?: Date;
+}

api-dto/unit-info/unit-dependency.dto.ts

@@ -0,0 +1,9 @@
+/**
+ * Data transfer object for a unit dependency
+ * Based on the Dependency element in unit.xsd schema
+ */
+export class UnitDependencyDto {
+  type!: 'File' | 'Service';
+  content!: string;
+  for!: 'player' | 'editor' | 'schemer' | 'coder';
+}

api-dto/unit-info/unit-info.dto.ts

@@ -0,0 +1,19 @@
+import { UnitMetadataDto } from './unit-metadata.dto';
+import { UnitDefinitionDto } from './unit-definition.dto';
+import { UnitVariableDto } from './unit-variable.dto';
+import { UnitCodingSchemeRefDto } from './unit-coding-scheme-ref.dto';
+import { UnitDependencyDto } from './unit-dependency.dto';
+
+/**
+ * Data transfer object for unit information
+ * Based on the unit.xsd schema
+ */
+export class UnitInfoDto {
+  metadata!: UnitMetadataDto;
+  definition!: UnitDefinitionDto;
+  codingSchemeRef?: UnitCodingSchemeRefDto;
+  dependencies?: UnitDependencyDto[];
+  baseVariables?: UnitVariableDto[];
+  derivedVariables?: UnitVariableDto[];
+  rawXml!: string;
+}

api-dto/unit-info/unit-metadata.dto.ts

@@ -0,0 +1,12 @@
+/**
+ * Data transfer object for unit metadata
+ * Based on the Metadata element in unit.xsd schema
+ */
+export class UnitMetadataDto {
+  id!: string;
+  label!: string;
+  description?: string;
+  transcript?: string;
+  reference?: string;
+  lastChange?: Date;
+}

api-dto/unit-info/unit-variable-value.dto.ts

@@ -0,0 +1,8 @@
+/**
+ * Data transfer object for a variable value
+ * Based on the VariableValue element in unit.xsd schema
+ */
+export class UnitVariableValueDto {
+  label!: string;
+  value!: string;
+}

api-dto/unit-info/unit-variable.dto.ts

@@ -0,0 +1,18 @@
+import { UnitVariableValueDto } from './unit-variable-value.dto';
+
+/**
+ * Data transfer object for a unit variable
+ * Based on the Variable element in unit.xsd schema
+ */
+export class UnitVariableDto {
+  id!: string;
+  alias?: string;
+  type!: 'string' | 'integer' | 'number' | 'boolean' | 'attachment' | 'json' | 'no-value';
+  format?: string;
+  multiple?: boolean;
+  nullable?: boolean;
+  page?: string;
+  values?: UnitVariableValueDto[];
+  valuesComplete?: boolean;
+  valuePositionLabels?: string[];
+}

apps/backend/src/app/admin/admin.module.ts

@@ -20,8 +20,12 @@ import { VariableAnalysisController } from './variable-analysis/variable-analysi
 import { JobsController } from './jobs/jobs.controller';
 import { ValidationTaskController } from './workspace/validation-task.controller';
 import { BookletInfoController } from './workspace/booklet-info.controller';
+import { UnitInfoController } from './workspace/unit-info.controller';
+import { MissingsProfilesController } from './workspace/missings-profiles.controller';
 import { BookletInfoService } from '../database/services/booklet-info.service';
+import { UnitInfoService } from '../database/services/unit-info.service';
 import FileUpload from '../database/entities/file_upload.entity';
+import { ReplayStatisticsController } from './replay-statistics/replay-statistics.controller';
 
 @Module({
   imports: [
@@ -47,10 +51,14 @@ import FileUpload from '../database/entities/file_upload.entity';
     VariableAnalysisController,
     JobsController,
     ValidationTaskController,
-    BookletInfoController
+    BookletInfoController,
+    UnitInfoController,
+    MissingsProfilesController,
+    ReplayStatisticsController
   ],
   providers: [
-    BookletInfoService
+    BookletInfoService,
+    UnitInfoService
   ]
 })
 export class AdminModule {}