Merge pull request 'IDB Sub-messages, 2D-DOC parser, unified API, regristry renaming' (#8) from feature/merged-idb-fr2ddoc into main

Reviewed-on: https://gitea.t-senger.de/tsenger/vdstools/pulls/8

Author: tsenger

README.md

@@ -44,7 +44,7 @@ val seal: Seal = Seal.fromString(rawString)
 //Get list with all messages in seal
 val messageList = seal.messageList
 for (message in messageList) {
-    println("${message.name} (${message.coding}) -> ${message.value}")
+    println("${message.name} -> ${message.value}")
 }
 
 // Access message data by name - value.toString() returns the decoded value
@@ -85,7 +85,7 @@ Some seal types use a two-stage lookup: the header's `documentRef` points to a b
 `ADMINISTRATIVE_DOCUMENTS`), and the first tags of the message zone carry administrative metadata
 (e.g. the document profile UUID at tag 0, validity dates at tag 1) rather than user-visible content.
 
-These tags are declared as `metadataTagList` in `SealCodings.json` and are automatically separated
+These tags are declared as `metadataTagList` in `VdsDocumentTypes.json` and are automatically separated
 from the regular `messageList` during parsing. They are only accessible via `metadataMessageList`.
 
 ```kotlin
@@ -112,8 +112,8 @@ if (seal.metadataMessageList.isNotEmpty()) {
 To check at the type level which tags are configured as metadata (without a concrete seal instance):
 
 ```kotlin
-DataEncoder.getMetadataTags("ADMINISTRATIVE_DOCUMENTS") // → {0, 1, 2, 3}
-DataEncoder.getMetadataTags("RESIDENT_PERMIT")          // → {} (no metadata tags)
+DataEncoder.vdsDocumentTypes.getMetadataTags("ADMINISTRATIVE_DOCUMENTS") // → {0, 1, 2, 3}
+DataEncoder.vdsDocumentTypes.getMetadataTags("RESIDENT_PERMIT")          // → {} (no metadata tags)
 ```
 
 Regular document types have no `metadataTagList` configured, so their `metadataMessageList` is
@@ -259,12 +259,12 @@ val customJson = """[
 ]"""
 
 // Add to defaults – built-in types remain available:
-DataEncoder.addCustomSealCodings(customJson)
-DataEncoder.addCustomSealCodingsFromFile("path/to/MyCodings.json")  // JVM only
+DataEncoder.addCustomVdsDocumentTypes(customJson)
+DataEncoder.addCustomVdsDocumentTypesFromFile("path/to/MyDocumentTypes.json")  // JVM only
 
 // Replace defaults entirely – only your types are available:
-DataEncoder.replaceCustomSealCodings(customJson)
-DataEncoder.replaceCustomSealCodingsFromFile("path/to/MyCodings.json")  // JVM only
+DataEncoder.replaceCustomVdsDocumentTypes(customJson)
+DataEncoder.replaceCustomVdsDocumentTypesFromFile("path/to/MyDocumentTypes.json")  // JVM only
 ```
 
 The same pattern applies to the other registries:
@@ -274,13 +274,13 @@ The same pattern applies to the other registries:
 DataEncoder.addCustomIdbMessageTypes(jsonString)
 DataEncoder.replaceCustomIdbMessageTypes(jsonString)
 
-// IDB national document types
-DataEncoder.addCustomIdbNationalDocumentTypes(jsonString)
-DataEncoder.replaceCustomIdbNationalDocumentTypes(jsonString)
+// IDB document types
+DataEncoder.addCustomIdbDocumentTypes(jsonString)
+DataEncoder.replaceCustomIdbDocumentTypes(jsonString)
 
-// Extended message definitions (VDS administrative documents)
-DataEncoder.addCustomExtendedMessageDefinitions(jsonString)
-DataEncoder.replaceCustomExtendedMessageDefinitions(jsonString)
+// VDS profile definitions (VDS administrative documents)
+DataEncoder.addCustomVdsProfileDefinitions(jsonString)
+DataEncoder.replaceCustomVdsProfileDefinitions(jsonString)
 
 // Revert all registries to embedded defaults:
 DataEncoder.resetToDefaults()
@@ -319,7 +319,7 @@ val vdsSeal = VdsSeal(header, messageGroup, signer)
 | `DATE`        | 3-byte date (ICAO format, e.g. "2024-06-15")                |
 | `MASKED_DATE` | 4-byte date with uncertainty masks                          |
 
-See `src/commonMain/resources/SealCodings.json` for the complete structure of the default codings.
+See `src/commonMain/resources/VdsDocumentTypes.json` for the complete structure of the default document types.
 
 ## Byte-level structure inspection with the `dissect` package
 

build.gradle.kts

@@ -212,10 +212,11 @@ tasks.register("generateResourceConstants") {
         outputDir.mkdirs()
 
         // JSON-Dateien einlesen
-        val sealCodings = file("$inputDir/SealCodings.json").readText()
+        val vdsDocumentTypes = file("$inputDir/VdsDocumentTypes.json").readText()
         val idbMessageTypes = file("$inputDir/IdbMessageTypes.json").readText()
-        val idbDocumentTypes = file("$inputDir/IdbNationalDocumentTypes.json").readText()
-        val extendedMessageDefinitions = file("$inputDir/ExtendedMessageDefinitions.json").readText()
+        val idbDocumentTypes = file("$inputDir/IdbGermanDocumentTypes.json").readText()
+        val vdsProfileDefinitions = file("$inputDir/VdsProfileDefinitions.json").readText()
+        val fr2ddocFieldDefinitions = file("$inputDir/Fr2ddocFieldDefinitions.json").readText()
 
         // Kotlin Code generieren
         val kotlinCode = """
@@ -228,13 +229,15 @@ package de.tsenger.vdstools.generated
  * Source: src/commonMain/resources/
  */
 internal object ResourceConstants {
-    const val SEAL_CODINGS_JSON: String = ""${'"'}$sealCodings""${'"'}
+    const val VDS_DOCUMENT_TYPES_JSON: String = ""${'"'}$vdsDocumentTypes""${'"'}
 
     const val IDB_MESSAGE_TYPES_JSON: String = ""${'"'}$idbMessageTypes""${'"'}
 
     const val IDB_DOCUMENT_TYPES_JSON: String = ""${'"'}$idbDocumentTypes""${'"'}
 
-    const val EXTENDED_MESSAGE_DEFINITIONS_JSON: String = ""${'"'}$extendedMessageDefinitions""${'"'}
+    const val VDS_PROFILE_DEFINITIONS_JSON: String = ""${'"'}$vdsProfileDefinitions""${'"'}
+
+    const val FR2DDOC_FIELD_DEFINITIONS_JSON: String = ""${'"'}$fr2ddocFieldDefinitions""${'"'}
 }
 """.trimIndent()
 
@@ -244,7 +247,7 @@ internal object ResourceConstants {
             writeText(kotlinCode)
         }
 
-        println("✅ Generated ResourceConstants.kt with ${sealCodings.length + idbMessageTypes.length + idbDocumentTypes.length + extendedMessageDefinitions.length} bytes")
+        println("✅ Generated ResourceConstants.kt with ${vdsDocumentTypes.length + idbMessageTypes.length + idbDocumentTypes.length + vdsProfileDefinitions.length + fr2ddocFieldDefinitions.length} bytes")
     }
 }