fixing the error message format in integration test

src/clients/AasRepositoryClient.ts

@@ -9,7 +9,7 @@ import {
     AssetAdministrationShellRepositoryAPIApi as AasRepository,
     Configuration,
     PagedResultPagingMetadata,
-    RequiredError,
+    Result,
 } from '../generated';
 import { applyDefaults } from '../lib/apiConfig';
 import { base64Encode } from '../lib/base64Url';
@@ -21,6 +21,7 @@ import {
     convertCoreAssetInformationToApiAssetInformation,
     convertCoreReferenceToApiReference,
 } from '../lib/convertAasTypes';
+import { handleApiError } from '../lib/errorHandler';
 
 export class AasRepositoryClient {
     /**
@@ -47,7 +48,7 @@ export class AasRepositoryClient {
                 pagedResult: PagedResultPagingMetadata | undefined;
                 result: AssetAdministrationShell[];
             },
-            RequiredError
+            Result
         >
     > {
         const { configuration, assetIds, idShort, limit, cursor } = options;
@@ -69,7 +70,8 @@ export class AasRepositoryClient {
                 data: { pagedResult: result.pagingMetadata, result: shells },
             };
         } catch (err) {
-            return { success: false, error: err as RequiredError };
+            const customError = await handleApiError(err);
+            return { success: false, error: customError };
         }
     }
 
@@ -85,7 +87,7 @@ export class AasRepositoryClient {
     async postAssetAdministrationShell(options: {
         configuration: Configuration;
         assetAdministrationShell: AssetAdministrationShell;
-    }): Promise<ApiResult<AssetAdministrationShell, RequiredError>> {
+    }): Promise<ApiResult<AssetAdministrationShell, Result>> {
         const { configuration, assetAdministrationShell } = options;
 
         try {
@@ -97,7 +99,8 @@ export class AasRepositoryClient {
 
             return { success: true, data: convertApiAasToCoreAas(result) };
         } catch (err) {
-            return { success: false, error: err as RequiredError };
+            const customError = await handleApiError(err);
+            return { success: false, error: customError };
         }
     }
 
@@ -113,7 +116,7 @@ export class AasRepositoryClient {
     async deleteAssetAdministrationShellById(options: {
         configuration: Configuration;
         aasIdentifier: string;
-    }): Promise<ApiResult<void, RequiredError>> {
+    }): Promise<ApiResult<void, Result>> {
         const { configuration, aasIdentifier } = options;
 
         try {
@@ -127,7 +130,8 @@ export class AasRepositoryClient {
 
             return { success: true, data: result };
         } catch (err) {
-            return { success: false, error: err as RequiredError };
+            const customError = await handleApiError(err);
+            return { success: false, error: customError };
         }
     }
 
@@ -143,7 +147,7 @@ export class AasRepositoryClient {
     async getAssetAdministrationShellById(options: {
         configuration: Configuration;
         aasIdentifier: string;
-    }): Promise<ApiResult<AssetAdministrationShell, RequiredError>> {
+    }): Promise<ApiResult<AssetAdministrationShell, Result>> {
         const { configuration, aasIdentifier } = options;
 
         try {
@@ -157,7 +161,8 @@ export class AasRepositoryClient {
 
             return { success: true, data: convertApiAasToCoreAas(result) };
         } catch (err) {
-            return { success: false, error: err as RequiredError };
+            const customError = await handleApiError(err);
+            return { success: false, error: customError };
         }
     }
 
@@ -175,7 +180,7 @@ export class AasRepositoryClient {
         configuration: Configuration;
         aasIdentifier: string;
         assetAdministrationShell: AssetAdministrationShell;
-    }): Promise<ApiResult<void, RequiredError>> {
+    }): Promise<ApiResult<void, Result>> {
         const { configuration, aasIdentifier, assetAdministrationShell } = options;
 
         try {
@@ -190,7 +195,8 @@ export class AasRepositoryClient {
 
             return { success: true, data: result };
         } catch (err) {
-            return { success: false, error: err as RequiredError };
+            const customError = await handleApiError(err);
+            return { success: false, error: customError };
         }
     }
 
@@ -206,7 +212,7 @@ export class AasRepositoryClient {
     async getAssetInformation(options: {
         configuration: Configuration;
         aasIdentifier: string;
-    }): Promise<ApiResult<AssetInformation, RequiredError>> {
+    }): Promise<ApiResult<AssetInformation, Result>> {
         const { configuration, aasIdentifier } = options;
 
         try {
@@ -223,7 +229,8 @@ export class AasRepositoryClient {
                 data: convertApiAssetInformationToCoreAssetInformation(result),
             };
         } catch (err) {
-            return { success: false, error: err as RequiredError };
+            const customError = await handleApiError(err);
+            return { success: false, error: customError };
         }
     }
 
@@ -241,7 +248,7 @@ export class AasRepositoryClient {
         configuration: Configuration;
         aasIdentifier: string;
         assetInformation: AssetInformation;
-    }): Promise<ApiResult<void, RequiredError>> {
+    }): Promise<ApiResult<void, Result>> {
         const { configuration, aasIdentifier, assetInformation } = options;
 
         try {
@@ -256,7 +263,8 @@ export class AasRepositoryClient {
 
             return { success: true, data: result };
         } catch (err) {
-            return { success: false, error: err as RequiredError };
+            const customError = await handleApiError(err);
+            return { success: false, error: customError };
         }
     }
 
@@ -272,7 +280,7 @@ export class AasRepositoryClient {
     async deleteThumbnail(options: {
         configuration: Configuration;
         aasIdentifier: string;
-    }): Promise<ApiResult<void, RequiredError>> {
+    }): Promise<ApiResult<void, Result>> {
         const { configuration, aasIdentifier } = options;
         try {
             const apiInstance = new AasRepository(applyDefaults(configuration));
@@ -285,7 +293,8 @@ export class AasRepositoryClient {
 
             return { success: true, data: result };
         } catch (err) {
-            return { success: false, error: err as RequiredError };
+            const customError = await handleApiError(err);
+            return { success: false, error: customError };
         }
     }
 
@@ -301,7 +310,7 @@ export class AasRepositoryClient {
     async getThumbnail(options: {
         configuration: Configuration;
         aasIdentifier: string;
-    }): Promise<ApiResult<Blob, RequiredError>> {
+    }): Promise<ApiResult<Blob, Result>> {
         const { configuration, aasIdentifier } = options;
 
         try {
@@ -315,7 +324,8 @@ export class AasRepositoryClient {
 
             return { success: true, data: result };
         } catch (err) {
-            return { success: false, error: err as RequiredError };
+            const customError = await handleApiError(err);
+            return { success: false, error: customError };
         }
     }
 
@@ -335,7 +345,7 @@ export class AasRepositoryClient {
         aasIdentifier: string;
         fileName: string;
         file: Blob;
-    }): Promise<ApiResult<void, RequiredError>> {
+    }): Promise<ApiResult<void, Result>> {
         const { configuration, aasIdentifier, fileName, file } = options;
 
         try {
@@ -351,7 +361,8 @@ export class AasRepositoryClient {
 
             return { success: true, data: result };
         } catch (err) {
-            return { success: false, error: err as RequiredError };
+            const customError = await handleApiError(err);
+            return { success: false, error: customError };
         }
     }
 
@@ -371,7 +382,7 @@ export class AasRepositoryClient {
         aasIdentifier: string;
         limit?: number;
         cursor?: string;
-    }): Promise<ApiResult<{ pagedResult: PagedResultPagingMetadata | undefined; result: Reference[] }, RequiredError>> {
+    }): Promise<ApiResult<{ pagedResult: PagedResultPagingMetadata | undefined; result: Reference[] }, Result>> {
         const { configuration, aasIdentifier, limit, cursor } = options;
 
         try {
@@ -394,7 +405,8 @@ export class AasRepositoryClient {
                 },
             };
         } catch (err) {
-            return { success: false, error: err as RequiredError };
+            const customError = await handleApiError(err);
+            return { success: false, error: customError };
         }
     }
 
@@ -412,7 +424,7 @@ export class AasRepositoryClient {
         configuration: Configuration;
         aasIdentifier: string;
         submodelReference: Reference;
-    }): Promise<ApiResult<Reference, RequiredError>> {
+    }): Promise<ApiResult<Reference, Result>> {
         const { configuration, aasIdentifier, submodelReference } = options;
 
         try {
@@ -427,7 +439,8 @@ export class AasRepositoryClient {
 
             return { success: true, data: convertApiReferenceToCoreReference(result) };
         } catch (err) {
-            return { success: false, error: err as RequiredError };
+            const customError = await handleApiError(err);
+            return { success: false, error: customError };
         }
     }
 
@@ -445,7 +458,7 @@ export class AasRepositoryClient {
         configuration: Configuration;
         aasIdentifier: string;
         submodelIdentifier: string;
-    }): Promise<ApiResult<void, RequiredError>> {
+    }): Promise<ApiResult<void, Result>> {
         const { configuration, aasIdentifier, submodelIdentifier } = options;
 
         try {
@@ -461,7 +474,8 @@ export class AasRepositoryClient {
 
             return { success: true, data: result };
         } catch (err) {
-            return { success: false, error: err as RequiredError };
+            const customError = await handleApiError(err);
+            return { success: false, error: customError };
         }
     }
 }

src/lib/base64Url.ts

@@ -15,6 +15,8 @@
  * @returns {string} The Base64 encoded string, converted to URL-safe format if requested.
  */
 export function base64Encode(string: string, urlSafe: boolean = true): string {
+    if (string === null || string === undefined) return '';
+
     string = string.trim();
 
     if (string === '') return '';
@@ -49,6 +51,8 @@ export function base64Encode(string: string, urlSafe: boolean = true): string {
  * @returns {string} The decoded string.
  */
 export function base64Decode(urlSafeBase64String: string): string {
+    if (urlSafeBase64String === null || urlSafeBase64String === undefined) return '';
+
     urlSafeBase64String = urlSafeBase64String.trim();
 
     if (urlSafeBase64String === '') return '';

src/lib/errorHandler.ts

@@ -0,0 +1,99 @@
+import { FetchError, Message, RequiredError, ResponseError, Result } from '../generated';
+
+/**
+ * Processes errors from API calls and standardizes them to a Result object
+ * with a consistent messages array following the API spec guidelines.
+ *
+ * @param err The error thrown during an API call
+ * @returns A standardized Result object containing error messages
+ */
+export async function handleApiError(err: unknown): Promise<Result> {
+    try {
+        // Check if the error already has the expected format with messages array
+        const errorAny = err as any;
+        if (errorAny?.messages && Array.isArray(errorAny.messages)) {
+            return { messages: errorAny.messages };
+        }
+
+        // Get current timestamp with millisecond precision as a string
+        const timestamp = (new Date().getTime() / 1000).toString();
+
+        let message: Message = {
+            code: '500',
+            messageType: 'Exception',
+            timestamp: timestamp,
+            text: 'Unknown error',
+        };
+
+        // Handle different error types
+        if (err instanceof RequiredError) {
+            message = {
+                code: '400',
+                messageType: 'Exception',
+                text: err.message || `Required parameter missing: ${err.field}`,
+                timestamp: timestamp,
+            };
+        } else if (err instanceof ResponseError) {
+            // Try to parse response body for messages
+            const responseBody = err.response;
+
+            try {
+                // Check if the response already contains a messages array
+                const responseData = responseBody && responseBody.json ? await responseBody.json() : null;
+
+                if (responseData?.messages && Array.isArray(responseData.messages)) {
+                    return { messages: responseData.messages };
+                }
+
+                // Otherwise, create a message with the status code
+                message = {
+                    code: err.response.status.toString(),
+                    messageType: 'Exception',
+                    text: err.message || `HTTP ${err.response.status} - Response returned an error code`,
+                    timestamp: timestamp,
+                };
+            } catch {
+                // If we can't parse the body, create a basic message
+                message = {
+                    code: err.response.status.toString(),
+                    messageType: 'Exception',
+                    text: `HTTP ${err.response.status} - Response returned an error code`,
+                    timestamp: timestamp,
+                };
+            }
+        } else if (err instanceof FetchError) {
+            message = {
+                code: '0',
+                messageType: 'Exception',
+                text: err.message || 'Network request failed',
+                timestamp: timestamp,
+            };
+        } else if (err instanceof Error) {
+            message = {
+                code: '500',
+                messageType: 'Exception',
+                text: err.message || 'Unknown error occurred',
+                timestamp: timestamp,
+            };
+        }
+
+        return { messages: [message] };
+    } catch (handlerError) {
+        // If our error handler throws an error, capture that and return a fallback error
+        console.error('Error in error handler:', handlerError);
+
+        // Get current timestamp with millisecond precision as a string for the fallback error
+        const timestamp = (new Date().getTime() / 1000).toString();
+
+        return {
+            messages: [
+                {
+                    code: '500',
+                    messageType: 'Exception',
+                    text: 'An error occurred while processing another error',
+                    timestamp: timestamp,
+                },
+            ],
+        };
+    }
+}