extend imperativeError, rename optional property

Signed-off-by: Andrew Twydell <[email protected]>
zowe · Feb 5, 2025 · ee3edd1 · ee3edd1
1 parent ac10a1a
commit ee3edd1
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 11 deletions.
diff --git a/packages/sdk/__tests__/__unit__/get/Get.resource.unit.test.ts b/packages/sdk/__tests__/__unit__/get/Get.resource.unit.test.ts
@@ -301,14 +301,14 @@ describe("CMCI - Get resource", () => {
       expect(getExpectStringMock).toHaveBeenCalledWith(dummySession, endPoint, []);
     });
 
-    it("should provide a CicsCmciRestError when requestOptions.useV4ErrorFormat is true", async () => {
+    it("should provide a CicsCmciRestError when requestOptions.useCICSCmciRestError is true", async () => {
 
       getExpectStringMock.mockClear();
       getExpectStringMock.mockResolvedValue(nodataXmlResponse);
 
       endPoint = `/${CicsCmciConstants.CICS_SYSTEM_MANAGEMENT}/${resource}/REGION1`;
       try {
-        response = await getResource(dummySession, resourceParms, { useV4ErrorFormat: true });
+        response = await getResource(dummySession, resourceParms, { useCICSCmciRestError: true });
       } catch (err) {
         error = err;
       }
@@ -323,14 +323,14 @@ describe("CMCI - Get resource", () => {
       expect(getExpectStringMock).toHaveBeenCalledWith(dummySession, endPoint, []);
     });
 
-    it("should provide a ImperativeError when requestOptions.useV4ErrorFormat is false", async () => {
+    it("should provide a ImperativeError when requestOptions.useCICSCmciRestError is false", async () => {
 
       getExpectStringMock.mockClear();
       getExpectStringMock.mockResolvedValue(nodataXmlResponse);
 
       endPoint = `/${CicsCmciConstants.CICS_SYSTEM_MANAGEMENT}/${resource}/REGION1`;
       try {
-        response = await getResource(dummySession, resourceParms, { useV4ErrorFormat: false });
+        response = await getResource(dummySession, resourceParms, { useCICSCmciRestError: false });
       } catch (err) {
         error = err;
       }

diff --git a/packages/sdk/src/doc/ICMCIRequestOptions.ts b/packages/sdk/src/doc/ICMCIRequestOptions.ts
@@ -17,6 +17,7 @@ export interface ICMCIRequestOptions {
 
   /**
    * If True, a new CicsCmciRestError is returned with formatted CMCI response codes.
+   * Default value is False to maintain backward compatibility.
    */
-  useV4ErrorFormat?: boolean;
+  useCICSCmciRestError?: boolean;
 }
diff --git a/packages/sdk/src/rest/CicsCmciRestClient.ts b/packages/sdk/src/rest/CicsCmciRestClient.ts
@@ -201,7 +201,7 @@ export class CicsCmciRestClient extends RestClient {
       return apiResponse;
     }
 
-    if (requestOptions?.useV4ErrorFormat) {
+    if (requestOptions?.useCICSCmciRestError) {
       throw new CicsCmciRestError(CicsCmciMessages.cmciRequestFailed.message, apiResponse.response.resultsummary);
     }
 

diff --git a/packages/sdk/src/rest/CicsCmciRestError.ts b/packages/sdk/src/rest/CicsCmciRestError.ts
@@ -9,9 +9,10 @@
  *
  */
 
+import { ImperativeError } from "@zowe/imperative";
 import { ICMCIResponseResultSummary } from "../doc";
 
-export class CicsCmciRestError extends Error {
+export class CicsCmciRestError extends ImperativeError {
 
   resultSummary: ICMCIResponseResultSummary;
 
@@ -20,8 +21,10 @@ export class CicsCmciRestError extends Error {
   RESPONSE_1_ALT: string;
   RESPONSE_2_ALT: string;
 
-  constructor(message: string, resultSummary: ICMCIResponseResultSummary) {
-    super(message);
+  constructor(msg: string, resultSummary: ICMCIResponseResultSummary) {
+    super({
+      msg,
+    });
     this.resultSummary = resultSummary;
     this.parseResultSummary();
   }

diff --git a/packages/vsce/src/utils/profileManagement.ts b/packages/vsce/src/utils/profileManagement.ts
@@ -102,7 +102,7 @@ export class ProfileManagement {
       ...params?.criteria && { criteria: params.criteria },
       ...params?.parameter && { parameter: params.parameter },
       ...params?.queryParams && { queryParams: params.queryParams },
-    }, { failOnNoData: false, useV4ErrorFormat: true });
+    }, { failOnNoData: false, useCICSCmciRestError: true });
     return response;
   }
 
@@ -418,7 +418,7 @@ export class ProfileManagement {
           nodiscard: true,
           overrideWarningCount: true,
         }
-      }, { failOnNoData: false, useV4ErrorFormat: true });
+      }, { failOnNoData: false, useCICSCmciRestError: true });
       if (response.resultsummary.api_response1 === `${CicsCmciConstants.RESPONSE_1_CODES.OK}`) {
         const resultsSummary = response.resultsummary;
         return { cacheToken: resultsSummary.cachetoken, recordCount: parseInt(resultsSummary.recordcount, 10) };