Fixes Problem with deleting optional idShort in SMLs

aaronzi · aaronzi · commit 8a261485ba74 · 2026-02-23T16:46:16.000+01:00
diff --git a/aas-web-ui/src/components/EditorComponents/SubmodelElements/AnnotatedRelationshipElementForm.vue b/aas-web-ui/src/components/EditorComponents/SubmodelElements/AnnotatedRelationshipElementForm.vue
@@ -251,11 +251,14 @@
             annotatedRelationshipElementObject.value = new aasTypes.AnnotatedRelationshipElement();
         }
 
-        if (annotatedRelationshipElementIdShort.value !== null) {
-            annotatedRelationshipElementObject.value.idShort = annotatedRelationshipElementIdShort.value;
+        const normalizedIdShort = annotatedRelationshipElementIdShort.value?.trim() ?? null;
+        if (normalizedIdShort) {
+            annotatedRelationshipElementObject.value.idShort = normalizedIdShort;
         } else if (!isParentSubmodelElementList.value) {
             errors.value.set('idShort', 'Annotated Relationship Element IdShort is required');
             return;
+        } else {
+            (annotatedRelationshipElementObject.value as Record<string, unknown>).idShort = null;
         }
 
         annotatedRelationshipElementObject.value.first = firstReference.value;
diff --git a/aas-web-ui/src/components/EditorComponents/SubmodelElements/BlobForm.vue b/aas-web-ui/src/components/EditorComponents/SubmodelElements/BlobForm.vue
@@ -282,11 +282,14 @@ usage of the 'Enter' key, make sure to edit the keyDown/keyUp method to not exec
             blobObject.value = new aasTypes.Blob();
         }
 
-        if (blobIdShort.value !== null) {
-            blobObject.value.idShort = blobIdShort.value;
+        const normalizedIdShort = blobIdShort.value?.trim() ?? null;
+        if (normalizedIdShort) {
+            blobObject.value.idShort = normalizedIdShort;
         } else if (!isParentSubmodelElementList.value) {
             errors.value.set('idShort', 'Blob Element IdShort is required');
             return;
+        } else {
+            (blobObject.value as Record<string, unknown>).idShort = null;
         }
 
         blobObject.value.value = blobContent.value;
diff --git a/aas-web-ui/src/components/EditorComponents/SubmodelElements/CollectionForm.vue b/aas-web-ui/src/components/EditorComponents/SubmodelElements/CollectionForm.vue
@@ -211,11 +211,14 @@
             smcObject.value = new aasTypes.SubmodelElementCollection();
         }
 
-        if (smcIdShort.value !== null) {
-            smcObject.value.idShort = smcIdShort.value;
+        const normalizedIdShort = smcIdShort.value?.trim() ?? null;
+        if (normalizedIdShort) {
+            smcObject.value.idShort = normalizedIdShort;
         } else if (!isParentSubmodelElementList.value) {
             errors.value.set('idShort', 'SubmodelElementCollection IdShort is required');
             return;
+        } else {
+            (smcObject.value as Record<string, unknown>).idShort = null;
         }
 
         if (semanticId.value !== null) {
diff --git a/aas-web-ui/src/components/EditorComponents/SubmodelElements/EntityForm.vue b/aas-web-ui/src/components/EditorComponents/SubmodelElements/EntityForm.vue
@@ -240,11 +240,14 @@
             entityObject.value = new aasTypes.Entity();
         }
 
-        if (entityIdShort.value !== null) {
-            entityObject.value.idShort = entityIdShort.value;
+        const normalizedIdShort = entityIdShort.value?.trim() ?? null;
+        if (normalizedIdShort) {
+            entityObject.value.idShort = normalizedIdShort;
         } else if (!isParentSubmodelElementList.value) {
             errors.value.set('idShort', 'Entity IdShort is required');
             return;
+        } else {
+            (entityObject.value as Record<string, unknown>).idShort = null;
         }
 
         entityObject.value.entityType = entityType.value;
diff --git a/aas-web-ui/src/components/EditorComponents/SubmodelElements/FileForm.vue b/aas-web-ui/src/components/EditorComponents/SubmodelElements/FileForm.vue
@@ -284,11 +284,14 @@
             fileObject.value = new aasTypes.File();
         }
 
-        if (fileIdShort.value !== null) {
-            fileObject.value.idShort = fileIdShort.value;
+        const normalizedIdShort = fileIdShort.value?.trim() ?? null;
+        if (normalizedIdShort) {
+            fileObject.value.idShort = normalizedIdShort;
         } else if (!isParentSubmodelElementList.value) {
             errors.value.set('idShort', 'File Element IdShort is required');
             return;
+        } else {
+            (fileObject.value as Record<string, unknown>).idShort = null;
         }
 
         fileObject.value.value = filePath.value;
diff --git a/aas-web-ui/src/components/EditorComponents/SubmodelElements/ListForm.vue b/aas-web-ui/src/components/EditorComponents/SubmodelElements/ListForm.vue
@@ -17,7 +17,7 @@
                                         v-model="smlIdShort"
                                         label="IdShort"
                                         :error="hasError('idShort')"
-                                        :rules="[rules.required]"
+                                        :rules="isParentSubmodelElementList ? [] : [rules.required]"
                                         :error-messages="getError('idShort')" />
                                 </v-col>
                                 <v-col cols="auto" class="px-0">
@@ -182,6 +182,8 @@
 
     const errors = ref<Map<string, string>>(new Map());
 
+    const isParentSubmodelElementList = computed(() => props.parentElement?.modelType === 'SubmodelElementList');
+
     const rules = {
         required: (value: any) => !!value || 'Required.',
     };
@@ -296,11 +298,14 @@
             smlObject.value = new aasTypes.SubmodelElementList(aasTypes.AasSubmodelElements.SubmodelElement);
         }
 
-        if (smlIdShort.value !== null) {
-            smlObject.value.idShort = smlIdShort.value;
-        } else {
+        const normalizedIdShort = smlIdShort.value?.trim() ?? null;
+        if (normalizedIdShort) {
+            smlObject.value.idShort = normalizedIdShort;
+        } else if (!isParentSubmodelElementList.value) {
             errors.value.set('idShort', 'SubmodelElementList IdShort is required');
             return;
+        } else {
+            (smlObject.value as Record<string, unknown>).idShort = null;
         }
 
         if (semanticId.value !== null) {
diff --git a/aas-web-ui/src/components/EditorComponents/SubmodelElements/MLPForm.vue b/aas-web-ui/src/components/EditorComponents/SubmodelElements/MLPForm.vue
@@ -234,11 +234,14 @@
             mlpObject.value = new aasTypes.MultiLanguageProperty();
         }
 
-        if (mlpIdShort.value !== null) {
-            mlpObject.value.idShort = mlpIdShort.value;
+        const normalizedIdShort = mlpIdShort.value?.trim() ?? null;
+        if (normalizedIdShort) {
+            mlpObject.value.idShort = normalizedIdShort;
         } else if (!isParentSubmodelElementList.value) {
             errors.value.set('idShort', 'MultiLanguageProperty IdShort is required');
             return;
+        } else {
+            (mlpObject.value as Record<string, unknown>).idShort = null;
         }
 
         if (semanticId.value !== null) {
diff --git a/aas-web-ui/src/components/EditorComponents/SubmodelElements/PropertyForm.vue b/aas-web-ui/src/components/EditorComponents/SubmodelElements/PropertyForm.vue
@@ -289,11 +289,14 @@
             propertyObject.value = new aasTypes.Property(valueType.value);
         }
 
-        if (propertyIdShort.value !== null) {
-            propertyObject.value.idShort = propertyIdShort.value;
+        const normalizedIdShort = propertyIdShort.value?.trim() ?? null;
+        if (normalizedIdShort) {
+            propertyObject.value.idShort = normalizedIdShort;
         } else if (!isParentSubmodelElementList.value) {
             errors.value.set('idShort', 'Property IdShort is required');
             return;
+        } else {
+            (propertyObject.value as Record<string, unknown>).idShort = null;
         }
 
         propertyObject.value.value = propertyValue.value;
diff --git a/aas-web-ui/src/components/EditorComponents/SubmodelElements/RangeForm.vue b/aas-web-ui/src/components/EditorComponents/SubmodelElements/RangeForm.vue
@@ -258,11 +258,14 @@
             rangeObject.value = new aasTypes.Range(valueType.value);
         }
 
-        if (rangeIdShort.value !== null) {
-            rangeObject.value.idShort = rangeIdShort.value;
+        const normalizedIdShort = rangeIdShort.value?.trim() ?? null;
+        if (normalizedIdShort) {
+            rangeObject.value.idShort = normalizedIdShort;
         } else if (!isParentSubmodelElementList.value) {
             errors.value.set('idShort', 'Range IdShort is required');
             return;
+        } else {
+            (rangeObject.value as Record<string, unknown>).idShort = null;
         }
 
         rangeObject.value.min = minValue.value;
diff --git a/aas-web-ui/src/components/EditorComponents/SubmodelElements/ReferenceElementForm.vue b/aas-web-ui/src/components/EditorComponents/SubmodelElements/ReferenceElementForm.vue
@@ -241,11 +241,14 @@
             referenceElementObject.value = new aasTypes.ReferenceElement();
         }
 
-        if (referenceElementIdShort.value !== null) {
-            referenceElementObject.value.idShort = referenceElementIdShort.value;
+        const normalizedIdShort = referenceElementIdShort.value?.trim() ?? null;
+        if (normalizedIdShort) {
+            referenceElementObject.value.idShort = normalizedIdShort;
         } else if (!isParentSubmodelElementList.value) {
             errors.value.set('idShort', 'Reference Element IdShort is required');
             return;
+        } else {
+            (referenceElementObject.value as Record<string, unknown>).idShort = null;
         }
 
         referenceElementObject.value.value = referenceElementValue.value;
diff --git a/aas-web-ui/src/components/EditorComponents/SubmodelElements/RelationshipElementForm.vue b/aas-web-ui/src/components/EditorComponents/SubmodelElements/RelationshipElementForm.vue
@@ -247,11 +247,14 @@
             relationshipElementObject.value = new aasTypes.RelationshipElement();
         }
 
-        if (relationshipElementIdShort.value !== null) {
-            relationshipElementObject.value.idShort = relationshipElementIdShort.value;
+        const normalizedIdShort = relationshipElementIdShort.value?.trim() ?? null;
+        if (normalizedIdShort) {
+            relationshipElementObject.value.idShort = normalizedIdShort;
         } else if (!isParentSubmodelElementList.value) {
             errors.value.set('idShort', 'Relationship Element IdShort is required');
             return;
+        } else {
+            (relationshipElementObject.value as Record<string, unknown>).idShort = null;
         }
 
         relationshipElementObject.value.first = firstReference.value;
diff --git a/aas-web-ui/src/composables/MetamodelVerification.ts b/aas-web-ui/src/composables/MetamodelVerification.ts
@@ -1,4 +1,4 @@
-import { verification } from '@aas-core-works/aas-core3.1-typescript';
+import { types as aasTypes, verification } from '@aas-core-works/aas-core3.1-typescript';
 
 export interface VerificationOptions {
     maxErrors?: number;
@@ -64,7 +64,7 @@ function tryMapField(path: string, fieldAliases: Record<string, string>): string
     return fieldAliases[normalizedLastPart] ?? null;
 }
 
-export function verifyForEditor(element: object, options?: VerificationOptions): VerificationResult {
+export function verifyForEditor(element: aasTypes.Class, options?: VerificationOptions): VerificationResult {
     const maxErrors = options?.maxErrors ?? 10;
     const fieldAliases = { ...defaultFieldAliases, ...(options?.fieldAliases ?? {}) };
 
@@ -74,26 +74,33 @@ export function verifyForEditor(element: object, options?: VerificationOptions):
     let totalErrors = 0;
     let reportedErrors = 0;
 
-    for (const error of verification.verify(element as any)) {
-        totalErrors += 1;
+    try {
+        for (const error of verification.verify(element)) {
+            totalErrors += 1;
 
-        // Only record up to maxErrors, but keep counting totalErrors
-        if (reportedErrors >= maxErrors) {
-            continue;
-        }
+            // Only record up to maxErrors, but keep counting totalErrors
+            if (reportedErrors >= maxErrors) {
+                continue;
+            }
 
-        reportedErrors += 1;
+            reportedErrors += 1;
 
-        const normalizedPath = normalizePath(String(error.path));
-        const mappedField = tryMapField(normalizedPath, fieldAliases);
+            const normalizedPath = normalizePath(String(error.path));
+            const mappedField = tryMapField(normalizedPath, fieldAliases);
 
-        if (mappedField && !fieldErrors.has(mappedField)) {
-            fieldErrors.set(mappedField, error.message);
-            continue;
-        }
+            if (mappedField && !fieldErrors.has(mappedField)) {
+                fieldErrors.set(mappedField, error.message);
+                continue;
+            }
 
-        const prefix = normalizedPath ? `${normalizedPath}: ` : '';
-        globalErrors.push(`${prefix}${error.message}`);
+            const prefix = normalizedPath ? `${normalizedPath}: ` : '';
+            globalErrors.push(`${prefix}${error.message}`);
+        }
+    } catch (error) {
+        totalErrors = Math.max(totalErrors, 1);
+        reportedErrors = Math.max(reportedErrors, 1);
+        const message = error instanceof Error ? error.message : String(error);
+        globalErrors.push(`Verification failed unexpectedly: ${message}`);
     }
 
     return {
diff --git a/aas-web-ui/tests/composables/MetamodelVerification.test.ts b/aas-web-ui/tests/composables/MetamodelVerification.test.ts
@@ -52,4 +52,15 @@ describe('MetamodelVerification.ts', () => {
 
         expect(targetMap.get('idShort')).toBe('invalid value');
     });
+
+    it('does not throw when optional idShort is undefined', () => {
+        const property = new aasTypes.Property(aasTypes.DataTypeDefXsd.String);
+        property.idShort = 'temp';
+        (property as unknown as Record<string, unknown>).idShort = undefined;
+
+        const result = verifyForEditor(property, { maxErrors: 10 });
+
+        expect(result.isValid).toBe(false);
+        expect(result.globalErrors.some((message) => message.includes('Verification failed unexpectedly'))).toBe(true);
+    });
 });
