fix(types)!: align SoapFault type to network error response

Add Detail.Error.Trace and Code fields. Remove Detail.Error.Detail field BREAKING CHANGE: Remove Detail.Error.Detail field from SoapFault type Refs: SHELL-203 (#433)
zextras · Jun 25, 2024 · 367dcb4 · 367dcb4
1 parent 57f771b
commit 367dcb4
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 7 deletions.
diff --git a/api-extractor/carbonio-shell-ui.api.md b/api-extractor/carbonio-shell-ui.api.md
@@ -1319,11 +1319,15 @@ export interface SoapContext extends Omit<RawSoapContext, 'notify'> {
 
 // @public (undocumented)
 interface SoapFault {
+    // (undocumented)
+    Code: {
+        Value: string;
+    };
     // (undocumented)
     Detail: {
         Error: {
             Code: string;
-            Detail: string;
+            Trace: string;
         };
     };
     // (undocumented)
@@ -1695,8 +1699,8 @@ interface ZimletProp {
 // lib/types/misc/index.d.ts:138:5 - (ae-forgotten-export) The symbol "SortBy" needs to be exported by the entry point lib.d.ts
 // lib/types/network/index.d.ts:107:5 - (ae-forgotten-export) The symbol "AccountACEInfo" needs to be exported by the entry point lib.d.ts
 // lib/types/network/soap.d.ts:11:5 - (ae-forgotten-export) The symbol "NameSpace" needs to be exported by the entry point lib.d.ts
-// lib/types/network/soap.d.ts:33:5 - (ae-forgotten-export) The symbol "SoapFault" needs to be exported by the entry point lib.d.ts
-// lib/types/network/soap.d.ts:62:5 - (ae-forgotten-export) The symbol "SoapSearchFolder" needs to be exported by the entry point lib.d.ts
+// lib/types/network/soap.d.ts:36:5 - (ae-forgotten-export) The symbol "SoapFault" needs to be exported by the entry point lib.d.ts
+// lib/types/network/soap.d.ts:65:5 - (ae-forgotten-export) The symbol "SoapSearchFolder" needs to be exported by the entry point lib.d.ts
 // lib/types/workers/index.d.ts:12:5 - (ae-forgotten-export) The symbol "SyncMessage" needs to be exported by the entry point lib.d.ts
 
 ```
diff --git a/src/network/fetch.test.ts b/src/network/fetch.test.ts
@@ -23,11 +23,14 @@ describe('Fetch', () => {
 					HttpResponse.json({
 						Body: {
 							Fault: {
+								Code: {
+									Value: ''
+								},
 								Reason: { Text: 'Controlled error: auth required' },
 								Detail: {
 									Error: {
 										Code: 'service.AUTH_REQUIRED',
-										Detail: ''
+										Trace: ''
 									}
 								}
 							}
@@ -50,11 +53,14 @@ describe('Fetch', () => {
 					HttpResponse.json({
 						Body: {
 							Fault: {
+								Code: {
+									Value: ''
+								},
 								Reason: { Text: 'Controlled error: auth expired' },
 								Detail: {
 									Error: {
 										Code: 'service.AUTH_EXPIRED',
-										Detail: ''
+										Trace: ''
 									}
 								}
 							}

diff --git a/src/network/fetch.ts b/src/network/fetch.ts
@@ -117,7 +117,7 @@ const handleResponse = <R extends Record<string, unknown>>(
 		}
 		console.error(
 			new Error(
-				`${(<ErrorSoapResponse>res).Body.Fault.Detail?.Error?.Detail}: ${
+				`${(<ErrorSoapResponse>res).Body.Fault.Detail?.Error?.Code}: ${
 					(<ErrorSoapResponse>res).Body.Fault.Reason?.Text
 				}`
 			)

diff --git a/src/types/network/soap.ts b/src/types/network/soap.ts
@@ -34,12 +34,15 @@ export interface SoapFault {
 	Detail: {
 		Error: {
 			Code: string;
-			Detail: string;
+			Trace: string;
 		};
 	};
 	Reason: {
 		Text: string;
 	};
+	Code: {
+		Value: string;
+	};
 }
 
 export type ErrorSoapBodyResponse = {