@zowe/cics-for-zowe-cli 5.0.0 → 5.0.4

package/node_modules/@zowe/cics-for-zowe-sdk/lib/methods/install/index.js

@@ -0,0 +1,28 @@
+"use strict";
+/**
+ * This program and the accompanying materials are made available under the terms of the
+ * Eclipse Public License v2.0 which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-v20.html
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Copyright Contributors to the Zowe Project.
+ *
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Install"), exports);
+//# sourceMappingURL=index.js.map

package/node_modules/@zowe/cics-for-zowe-sdk/lib/methods/install/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/methods/install/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;;;;;;;;;;;;;;AAEH,4CAA0B"}

package/{lib/api → node_modules/@zowe/cics-for-zowe-sdk/lib}/methods/remove-from-list/RemoveFromList.d.ts

@@ -1,3 +1,13 @@
+/**
+ * This program and the accompanying materials are made available under the terms of the
+ * Eclipse Public License v2.0 which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-v20.html
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Copyright Contributors to the Zowe Project.
+ *
+ */
 import { AbstractSession } from "@zowe/imperative";
 import { ICMCIApiResponse, ICSDGroupParms } from "../../doc";
 /**

package/node_modules/@zowe/cics-for-zowe-sdk/lib/methods/remove-from-list/RemoveFromList.js

@@ -0,0 +1,39 @@
+"use strict";
+/**
+ * This program and the accompanying materials are made available under the terms of the
+ * Eclipse Public License v2.0 which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-v20.html
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Copyright Contributors to the Zowe Project.
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeCSDGroupFromList = void 0;
+const imperative_1 = require("@zowe/imperative");
+const rest_1 = require("../../rest");
+const constants_1 = require("../../constants");
+/**
+ * Remove a CSD Group resource from a CSD List in CICS through CMCI REST API
+ * @param {AbstractSession} session - the session to connect to CMCI with
+ * @param {ICSDGroupParms} parms - parameters for defining your CSD Group
+ * @returns {Promise<any>} promise that resolves to the response (XML parsed into a javascript object)
+ *                          when the request is complete
+ * @throws {ImperativeError} CICS CSD Group name not defined or blank
+ * @throws {ImperativeError} CICS CSD List not defined or blank
+ * @throws {ImperativeError} CicsCmciRestClient request fails
+ */
+function removeCSDGroupFromList(session, parms) {
+    imperative_1.ImperativeExpect.toBeDefinedAndNonBlank(parms.name, "CICS CSD Group Name", "CICS CSD Group Name is required");
+    imperative_1.ImperativeExpect.toBeDefinedAndNonBlank(parms.csdList, "CICS CSD List", "CICS CSD List is required");
+    imperative_1.ImperativeExpect.toBeDefinedAndNonBlank(parms.regionName, "CICS Region name", "CICS region name is required");
+    imperative_1.Logger.getAppLogger().debug("Attempting to remove a CSD Group from a CSD List with the following parameters:\n%s", JSON.stringify(parms));
+    const cicsPlex = parms.cicsPlex == null ? "" : parms.cicsPlex + "/";
+    const cmciResource = "/" + constants_1.CicsCmciConstants.CICS_SYSTEM_MANAGEMENT + "/" +
+        constants_1.CicsCmciConstants.CICS_CSDGROUP_IN_LIST + "/" + cicsPlex + parms.regionName +
+        "?CRITERIA=(CSDLIST=='" + parms.csdList + "')%20AND%20(CSDGROUP=='" + parms.name + "')";
+    return rest_1.CicsCmciRestClient.deleteExpectParsedXml(session, cmciResource, []);
+}
+exports.removeCSDGroupFromList = removeCSDGroupFromList;
+//# sourceMappingURL=RemoveFromList.js.map

package/node_modules/@zowe/cics-for-zowe-sdk/lib/methods/remove-from-list/RemoveFromList.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RemoveFromList.js","sourceRoot":"","sources":["../../../src/methods/remove-from-list/RemoveFromList.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;AAEH,iDAA6E;AAC7E,qCAAgD;AAChD,+CAAoD;AAGpD;;;;;;;;;GASG;AACH,SAAgB,sBAAsB,CAAC,OAAwB,EAAE,KAAqB;IACpF,6BAAgB,CAAC,sBAAsB,CAAC,KAAK,CAAC,IAAI,EAAE,qBAAqB,EAAE,iCAAiC,CAAC,CAAC;IAC9G,6BAAgB,CAAC,sBAAsB,CAAC,KAAK,CAAC,OAAO,EAAE,eAAe,EAAE,2BAA2B,CAAC,CAAC;IACrG,6BAAgB,CAAC,sBAAsB,CAAC,KAAK,CAAC,UAAU,EAAE,kBAAkB,EAAE,8BAA8B,CAAC,CAAC;IAE9G,mBAAM,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC,qFAAqF,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IAE1I,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,GAAG,GAAG,CAAC;IACpE,MAAM,YAAY,GAAG,GAAG,GAAG,6BAAiB,CAAC,sBAAsB,GAAG,GAAG;QACnE,6BAAiB,CAAC,qBAAqB,GAAG,GAAG,GAAG,QAAQ,GAAG,KAAK,CAAC,UAAU;QAC3E,uBAAuB,GAAG,KAAK,CAAC,OAAO,GAAG,yBAAyB,GAAG,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;IAC9F,OAAO,yBAAkB,CAAC,qBAAqB,CAAC,OAAO,EAAE,YAAY,EAAE,EAAE,CAAQ,CAAC;AACpF,CAAC;AAZD,wDAYC"}

package/node_modules/@zowe/cics-for-zowe-sdk/lib/methods/remove-from-list/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This program and the accompanying materials are made available under the terms of the
+ * Eclipse Public License v2.0 which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-v20.html
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Copyright Contributors to the Zowe Project.
+ *
+ */
+export * from "./RemoveFromList";

package/node_modules/@zowe/cics-for-zowe-sdk/lib/methods/remove-from-list/index.js

@@ -0,0 +1,28 @@
+"use strict";
+/**
+ * This program and the accompanying materials are made available under the terms of the
+ * Eclipse Public License v2.0 which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-v20.html
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Copyright Contributors to the Zowe Project.
+ *
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./RemoveFromList"), exports);
+//# sourceMappingURL=index.js.map

package/node_modules/@zowe/cics-for-zowe-sdk/lib/methods/remove-from-list/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/methods/remove-from-list/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;;;;;;;;;;;;;;AAEH,mDAAiC"}

package/{lib/api → node_modules/@zowe/cics-for-zowe-sdk/lib}/methods/set/Set.d.ts

@@ -1,3 +1,13 @@
+/**
+ * This program and the accompanying materials are made available under the terms of the
+ * Eclipse Public License v2.0 which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-v20.html
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Copyright Contributors to the Zowe Project.
+ *
+ */
 import { AbstractSession } from "@zowe/imperative";
 import { ICMCIApiResponse, IProgramParms } from "../../doc";
 /**

package/node_modules/@zowe/cics-for-zowe-sdk/lib/methods/set/Set.js

@@ -0,0 +1,47 @@
+"use strict";
+/**
+ * This program and the accompanying materials are made available under the terms of the
+ * Eclipse Public License v2.0 which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-v20.html
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Copyright Contributors to the Zowe Project.
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.programNewcopy = void 0;
+const imperative_1 = require("@zowe/imperative");
+const rest_1 = require("../../rest");
+const constants_1 = require("../../constants");
+/**
+ * Refresh a program definition on CICS through CMCI REST API
+ * @param {AbstractSession} session - the session to connect to CMCI with
+ * @param {IProgramParms} parms - parameters for refreshing your program
+ * @returns {Promise<any>} promise that resolves to the response (XML parsed into a javascript object)
+ *                          when the request is complete
+ * @throws {ImperativeError} CICS program name not defined or blank
+ * @throws {ImperativeError} CICS region name not defined or blank
+ * @throws {ImperativeError} CicsCmciRestClient request fails
+ */
+function programNewcopy(session, parms) {
+    imperative_1.ImperativeExpect.toBeDefinedAndNonBlank(parms.name, "CICS Program name", "CICS program name is required");
+    imperative_1.ImperativeExpect.toBeDefinedAndNonBlank(parms.regionName, "CICS Region name", "CICS region name is required");
+    imperative_1.Logger.getAppLogger().debug("Attempting to refresh a program with the following parameters:\n%s", JSON.stringify(parms));
+    const requestBody = {
+        request: {
+            action: {
+                $: {
+                    name: "NEWCOPY",
+                }
+            }
+        }
+    };
+    const cicsPlex = parms.cicsPlex == null ? "" : parms.cicsPlex + "/";
+    const cmciResource = "/" + constants_1.CicsCmciConstants.CICS_SYSTEM_MANAGEMENT + "/" +
+        constants_1.CicsCmciConstants.CICS_PROGRAM_RESOURCE + "/" + cicsPlex + parms.regionName +
+        "?CRITERIA=(PROGRAM=" + parms.name + ")";
+    return rest_1.CicsCmciRestClient.putExpectParsedXml(session, cmciResource, [], requestBody);
+}
+exports.programNewcopy = programNewcopy;
+//# sourceMappingURL=Set.js.map

package/node_modules/@zowe/cics-for-zowe-sdk/lib/methods/set/Set.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Set.js","sourceRoot":"","sources":["../../../src/methods/set/Set.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;AAEH,iDAA6E;AAC7E,qCAAgD;AAChD,+CAAoD;AAGpD;;;;;;;;;GASG;AACH,SAAgB,cAAc,CAAC,OAAwB,EAAE,KAAoB;IAC3E,6BAAgB,CAAC,sBAAsB,CAAC,KAAK,CAAC,IAAI,EAAE,mBAAmB,EAAE,+BAA+B,CAAC,CAAC;IAC1G,6BAAgB,CAAC,sBAAsB,CAAC,KAAK,CAAC,UAAU,EAAE,kBAAkB,EAAE,8BAA8B,CAAC,CAAC;IAE9G,mBAAM,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC,oEAAoE,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IACzH,MAAM,WAAW,GAAQ;QACvB,OAAO,EAAE;YACP,MAAM,EAAE;gBACN,CAAC,EAAE;oBACD,IAAI,EAAE,SAAS;iBAChB;aACF;SACF;KACF,CAAC;IAEF,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,GAAG,GAAG,CAAC;IACpE,MAAM,YAAY,GAAG,GAAG,GAAG,6BAAiB,CAAC,sBAAsB,GAAG,GAAG;QACnE,6BAAiB,CAAC,qBAAqB,GAAG,GAAG,GAAG,QAAQ,GAAG,KAAK,CAAC,UAAU;QAC3E,qBAAqB,GAAG,KAAK,CAAC,IAAI,GAAG,GAAG,CAAC;IAC/C,OAAO,yBAAkB,CAAC,kBAAkB,CAAC,OAAO,EAAE,YAAY,EAAE,EAAE,EAAE,WAAW,CAAQ,CAAC;AAC9F,CAAC;AApBD,wCAoBC"}

package/node_modules/@zowe/cics-for-zowe-sdk/lib/methods/set/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This program and the accompanying materials are made available under the terms of the
+ * Eclipse Public License v2.0 which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-v20.html
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Copyright Contributors to the Zowe Project.
+ *
+ */
+export * from "./Set";

package/node_modules/@zowe/cics-for-zowe-sdk/lib/methods/set/index.js

@@ -0,0 +1,28 @@
+"use strict";
+/**
+ * This program and the accompanying materials are made available under the terms of the
+ * Eclipse Public License v2.0 which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-v20.html
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Copyright Contributors to the Zowe Project.
+ *
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Set"), exports);
+//# sourceMappingURL=index.js.map

package/node_modules/@zowe/cics-for-zowe-sdk/lib/methods/set/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/methods/set/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;;;;;;;;;;;;;;AAEH,wCAAsB"}

package/node_modules/@zowe/cics-for-zowe-sdk/lib/rest/CicsCmciRestClient.d.ts

@@ -0,0 +1,128 @@
+/**
+ * This program and the accompanying materials are made available under the terms of the
+ * Eclipse Public License v2.0 which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-v20.html
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Copyright Contributors to the Zowe Project.
+ *
+ */
+import { AbstractSession, IImperativeError, RestClient } from "@zowe/imperative";
+import { ICMCIApiResponse } from "../doc/ICMCIApiResponse";
+/**
+ * Wrapper for invoke CICS CMCI API through the RestClient to perform common error
+ * handling and checking and resolve promises according to generic types
+ * @export
+ * @class CicsCmciRestClient
+ * @extends {RestClient}
+ */
+export declare class CicsCmciRestClient extends RestClient {
+    /**
+       * If the API request is successful, this value should be in
+       * api_response2 in  the resultsummary object in the response
+       */
+    static readonly CMCI_SUCCESS_RESPONSE_1 = "1024";
+    /**
+       * If the API request is successful, this value should be in
+       * api_response2 in  the resultsummary object in the response
+       */
+    static readonly CMCI_SUCCESS_RESPONSE_2 = "0";
+    /**
+       * Convert an object to XML using the xml2js package
+       * @param obj - the object to convert to XML
+       * @returns {string} the string of XML generated by xml2js
+       */
+    static convertObjectToXML(obj: any): string;
+    /**
+       * Call the RestClient.getExpectString function assuming the response is XML, then return a promise of the JSON representation.
+       * @static
+       * @param {AbstractSession} session - representing connection to this api
+       * @param {string} resource - URI for which this request should go against
+       * @param {any} reqHeaders - headers to include in the REST request
+       * @returns {Promise<*>} - response body content from http(s) call
+       * @throws {ImperativeError} verifyResponseCodes fails
+       */
+    static getExpectParsedXml(session: AbstractSession, resource: string, reqHeaders?: any[]): Promise<ICMCIApiResponse>;
+    /**
+       * Call the RestClient.deleteExpectString function assuming the response is XML, then return a promise of the JSON representation.
+       * @static
+       * @param {AbstractSession} session - representing connection to this api
+       * @param {string} resource - URI for which this request should go against
+       * @param {any} reqHeaders - headers to include in the REST request
+       * @returns {Promise<*>} - response body content from http(s) call
+       * @throws {ImperativeError} verifyResponseCodes fails
+       */
+    static deleteExpectParsedXml(session: AbstractSession, resource: string, reqHeaders?: any[]): Promise<ICMCIApiResponse>;
+    /**
+       * PUT a CMCI endpoint expecting an XML return value parsed into a JCL
+       * Call the RestClient.putExpectString function assuming the response is XML, then return a promise of the JSON representation.
+       * @static
+       * @param {AbstractSession} session - representing connection to this api
+       * @param {string} resource - URI for which this request should go against
+       * @param {any} reqHeaders - headers to include in the REST request
+       * @param payload - XML body to put or a javascript object to convert to XML
+       * @returns {Promise<*>} - response body content from http(s) call
+       * @throws {ImperativeError} verifyResponseCodes fails
+       */
+    static putExpectParsedXml(session: AbstractSession, resource: string, reqHeaders: any[], payload: any): Promise<ICMCIApiResponse>;
+    /**
+       * POST a CMCI endpoint expecting a XML return value
+       * Calls the RestClient.postExpectString function assuming the response is XML, then return a promise of the JSON representation.
+       * @static
+       * @param {AbstractSession} session - representing connection to this api
+       * @param {string} resource - URI for which this request should go against
+       * @param {any} reqHeaders - headers to include in the REST request
+       * @param payload - XML body to put or a javascript object to convert to XML
+       * @returns {Promise<*>} - response body content from http(s) call
+       * @throws {ImperativeError} verifyResponseCodes fails
+       */
+    static postExpectParsedXml(session: AbstractSession, resource: string, reqHeaders: any[], payload: any): Promise<ICMCIApiResponse>;
+    /**
+       * Internal logger
+       */
+    private static mLogger;
+    /**
+       * Internal parser
+       */
+    private static mParser;
+    /**
+       * Detect if a rpayload is a string or an object
+       * If it is an object, convert it to XML using xml2js
+       * @param payload - the request body / payload
+       * @returns {string} the XML that can be used as the request body
+       */
+    private static convertPayloadToXML;
+    /**
+       * Use the Brightside logger instead of the imperative logger
+       * @return {Logger}
+       */
+    private static get log();
+    /**
+       * Use a configured parser
+       * @return {Parser}
+       */
+    private static get parser();
+    /**
+       * Check that we got the expected response codes from the API after a request
+       * @param {ICMCIApiResponse} apiResponse - the parsed response
+       * @returns {ICMCIApiResponse} - the response if it was correct
+       * @throws {ImperativeError} request did not get the expected codes
+       */
+    private static verifyResponseCodes;
+    /**
+       * parse an XML string with XML2js
+       * The API is already synchronous according to their documentation but requires a callback.
+       * This is a wrapper that doesn't require a callback.
+       * @param {string} str - the string of XML to parse
+       * @returns {any} the object parsed from the XML
+       * @throws {Error} xml2js.parseString fails
+       */
+    private static parseStringSync;
+    /**
+       * Process an error encountered in the rest client
+       * @param {IImperativeError} original - the original error automatically built by the abstract rest client
+       * @returns {IImperativeError} - the processed error with details added
+       */
+    protected processError(original: IImperativeError): IImperativeError;
+}

package/node_modules/@zowe/cics-for-zowe-sdk/lib/rest/CicsCmciRestClient.js

@@ -0,0 +1,221 @@
+"use strict";
+/**
+ * This program and the accompanying materials are made available under the terms of the
+ * Eclipse Public License v2.0 which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-v20.html
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Copyright Contributors to the Zowe Project.
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CicsCmciRestClient = void 0;
+const imperative_1 = require("@zowe/imperative");
+const xml2js_1 = require("xml2js");
+const CicsCmci_messages_1 = require("../constants/CicsCmci.messages");
+const util_1 = require("util");
+/**
+ * Wrapper for invoke CICS CMCI API through the RestClient to perform common error
+ * handling and checking and resolve promises according to generic types
+ * @export
+ * @class CicsCmciRestClient
+ * @extends {RestClient}
+ */
+class CicsCmciRestClient extends imperative_1.RestClient {
+    /**
+       * If the API request is successful, this value should be in
+       * api_response2 in  the resultsummary object in the response
+       */
+    static CMCI_SUCCESS_RESPONSE_1 = "1024";
+    /**
+       * If the API request is successful, this value should be in
+       * api_response2 in  the resultsummary object in the response
+       */
+    static CMCI_SUCCESS_RESPONSE_2 = "0";
+    /**
+       * Convert an object to XML using the xml2js package
+       * @param obj - the object to convert to XML
+       * @returns {string} the string of XML generated by xml2js
+       */
+    static convertObjectToXML(obj) {
+        this.log.trace("Converting the following object to XML via xml2js:\n%s", JSON.stringify(obj, null, 2));
+        const builder = new xml2js_1.Builder({ headless: true });
+        return builder.buildObject(obj);
+    }
+    /**
+       * Call the RestClient.getExpectString function assuming the response is XML, then return a promise of the JSON representation.
+       * @static
+       * @param {AbstractSession} session - representing connection to this api
+       * @param {string} resource - URI for which this request should go against
+       * @param {any} reqHeaders - headers to include in the REST request
+       * @returns {Promise<*>} - response body content from http(s) call
+       * @throws {ImperativeError} verifyResponseCodes fails
+       */
+    static async getExpectParsedXml(session, resource, reqHeaders = []) {
+        const data = await CicsCmciRestClient.getExpectString(session, resource, reqHeaders);
+        const apiResponse = CicsCmciRestClient.parseStringSync(data);
+        return CicsCmciRestClient.verifyResponseCodes(apiResponse);
+    }
+    /**
+       * Call the RestClient.deleteExpectString function assuming the response is XML, then return a promise of the JSON representation.
+       * @static
+       * @param {AbstractSession} session - representing connection to this api
+       * @param {string} resource - URI for which this request should go against
+       * @param {any} reqHeaders - headers to include in the REST request
+       * @returns {Promise<*>} - response body content from http(s) call
+       * @throws {ImperativeError} verifyResponseCodes fails
+       */
+    static async deleteExpectParsedXml(session, resource, reqHeaders = []) {
+        const data = await CicsCmciRestClient.deleteExpectString(session, resource, reqHeaders);
+        const apiResponse = CicsCmciRestClient.parseStringSync(data);
+        return CicsCmciRestClient.verifyResponseCodes(apiResponse);
+    }
+    /**
+       * PUT a CMCI endpoint expecting an XML return value parsed into a JCL
+       * Call the RestClient.putExpectString function assuming the response is XML, then return a promise of the JSON representation.
+       * @static
+       * @param {AbstractSession} session - representing connection to this api
+       * @param {string} resource - URI for which this request should go against
+       * @param {any} reqHeaders - headers to include in the REST request
+       * @param payload - XML body to put or a javascript object to convert to XML
+       * @returns {Promise<*>} - response body content from http(s) call
+       * @throws {ImperativeError} verifyResponseCodes fails
+       */
+    static async putExpectParsedXml(session, resource, reqHeaders = [], payload) {
+        if (payload != null) {
+            payload = CicsCmciRestClient.convertPayloadToXML(payload);
+        }
+        const data = await CicsCmciRestClient.putExpectString(session, resource, reqHeaders, payload);
+        const apiResponse = CicsCmciRestClient.parseStringSync(data);
+        return CicsCmciRestClient.verifyResponseCodes(apiResponse);
+    }
+    /**
+       * POST a CMCI endpoint expecting a XML return value
+       * Calls the RestClient.postExpectString function assuming the response is XML, then return a promise of the JSON representation.
+       * @static
+       * @param {AbstractSession} session - representing connection to this api
+       * @param {string} resource - URI for which this request should go against
+       * @param {any} reqHeaders - headers to include in the REST request
+       * @param payload - XML body to put or a javascript object to convert to XML
+       * @returns {Promise<*>} - response body content from http(s) call
+       * @throws {ImperativeError} verifyResponseCodes fails
+       */
+    static async postExpectParsedXml(session, resource, reqHeaders = [], payload) {
+        if (payload != null) {
+            payload = CicsCmciRestClient.convertPayloadToXML(payload);
+        }
+        const data = await CicsCmciRestClient.postExpectString(session, resource, reqHeaders, payload);
+        const apiResponse = CicsCmciRestClient.parseStringSync(data);
+        return CicsCmciRestClient.verifyResponseCodes(apiResponse);
+    }
+    /**
+       * Internal logger
+       */
+    static mLogger;
+    /**
+       * Internal parser
+       */
+    static mParser;
+    /**
+       * Detect if a rpayload is a string or an object
+       * If it is an object, convert it to XML using xml2js
+       * @param payload - the request body / payload
+       * @returns {string} the XML that can be used as the request body
+       */
+    static convertPayloadToXML(payload) {
+        if ((0, util_1.isString)(payload)) {
+            // if it's already a string, use it verbatim
+            return payload;
+        }
+        else {
+            // if it's an object, turn it into XML
+            return this.convertObjectToXML(payload);
+        }
+    }
+    /**
+       * Use the Brightside logger instead of the imperative logger
+       * @return {Logger}
+       */
+    static get log() {
+        if (this.mLogger == null) {
+            this.mLogger = imperative_1.Logger.getAppLogger();
+        }
+        return this.mLogger;
+    }
+    /**
+       * Use a configured parser
+       * @return {Parser}
+       */
+    static get parser() {
+        if (this.mParser == null) {
+            this.mParser = new xml2js_1.Parser({
+                explicitArray: false,
+                mergeAttrs: true,
+                normalizeTags: true // Guarantee that all tags are going to be lowercase
+            });
+        }
+        return this.mParser;
+    }
+    /**
+       * Check that we got the expected response codes from the API after a request
+       * @param {ICMCIApiResponse} apiResponse - the parsed response
+       * @returns {ICMCIApiResponse} - the response if it was correct
+       * @throws {ImperativeError} request did not get the expected codes
+       */
+    static verifyResponseCodes(apiResponse) {
+        if (apiResponse.response != null && apiResponse.response.resultsummary != null
+            && apiResponse.response.resultsummary.api_response1 === CicsCmciRestClient.CMCI_SUCCESS_RESPONSE_1
+            && apiResponse.response.resultsummary.api_response2 === CicsCmciRestClient.CMCI_SUCCESS_RESPONSE_2) {
+            // expected return code and reason code specify
+            return apiResponse;
+        }
+        else {
+            throw new imperative_1.ImperativeError({
+                msg: CicsCmci_messages_1.CicsCmciMessages.cmciRequestFailed.message + "\n" + imperative_1.TextUtils.prettyJson(apiResponse),
+            });
+        }
+    }
+    /**
+       * parse an XML string with XML2js
+       * The API is already synchronous according to their documentation but requires a callback.
+       * This is a wrapper that doesn't require a callback.
+       * @param {string} str - the string of XML to parse
+       * @returns {any} the object parsed from the XML
+       * @throws {Error} xml2js.parseString fails
+       */
+    static parseStringSync(str) {
+        let result;
+        let error;
+        this.parser.parseString(str, (err, r) => {
+            error = err;
+            result = r;
+        });
+        if (error != null) {
+            throw error;
+        }
+        return result;
+    }
+    /**
+       * Process an error encountered in the rest client
+       * @param {IImperativeError} original - the original error automatically built by the abstract rest client
+       * @returns {IImperativeError} - the processed error with details added
+       */
+    processError(original) {
+        original.msg = "CICS CMCI REST API Error:\n" + original.msg;
+        let details = original.causeErrors;
+        try {
+            const xmlDetails = CicsCmciRestClient.parseStringSync(details);
+            // if we didn't get an error, make the parsed details part of the error
+            details = imperative_1.TextUtils.prettyJson(xmlDetails, undefined, false);
+        }
+        catch (e) {
+            // if there's an error, the causeErrors text is not json
+            this.log.debug("Encountered an error trying to parse causeErrors as XML  - causeErrors is likely not JSON format");
+        }
+        original.msg += "\n" + details; // add the data string which is the original error
+        return original;
+    }
+}
+exports.CicsCmciRestClient = CicsCmciRestClient;
+//# sourceMappingURL=CicsCmciRestClient.js.map

package/node_modules/@zowe/cics-for-zowe-sdk/lib/rest/CicsCmciRestClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CicsCmciRestClient.js","sourceRoot":"","sources":["../../src/rest/CicsCmciRestClient.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;AAEH,iDAAqH;AACrH,mCAAyC;AAEzC,sEAAkE;AAClE,+BAAgC;AAEhC;;;;;;GAMG;AACH,MAAa,kBAAmB,SAAQ,uBAAU;IAChD;;;SAGK;IACE,MAAM,CAAU,uBAAuB,GAAG,MAAM,CAAC;IAExD;;;SAGK;IACE,MAAM,CAAU,uBAAuB,GAAG,GAAG,CAAC;IAErD;;;;SAIK;IACE,MAAM,CAAC,kBAAkB,CAAC,GAAQ;QACvC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,wDAAwD,EACrE,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAChC,MAAM,OAAO,GAAG,IAAI,gBAAO,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAC,CAAC,CAAC;QAC9C,OAAO,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;;;SAQK;IACE,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,OAAwB,EAC7D,QAAgB,EAAE,aAAoB,EAAE;QACxC,MAAM,IAAI,GAAG,MAAM,kBAAkB,CAAC,eAAe,CAAC,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;QACrF,MAAM,WAAW,GAAG,kBAAkB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAC7D,OAAO,kBAAkB,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;SAQK;IACE,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,OAAwB,EAChE,QAAgB,EAAE,aAAoB,EAAE;QACxC,MAAM,IAAI,GAAG,MAAM,kBAAkB,CAAC,kBAAkB,CAAC,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;QACxF,MAAM,WAAW,GAAG,kBAAkB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAC7D,OAAO,kBAAkB,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;SAUK;IACE,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,OAAwB,EAC7D,QAAgB,EAAE,aAAoB,EAAE,EACxC,OAAY;QACZ,IAAI,OAAO,IAAI,IAAI,EAAE;YACnB,OAAO,GAAG,kBAAkB,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;SAC3D;QACD,MAAM,IAAI,GAAG,MAAM,kBAAkB,CAAC,eAAe,CAAC,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;QAC9F,MAAM,WAAW,GAAG,kBAAkB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAC7D,OAAO,kBAAkB,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;SAUK;IACE,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,OAAwB,EAC9D,QAAgB,EAAE,aAAoB,EAAE,EACxC,OAAY;QACZ,IAAI,OAAO,IAAI,IAAI,EAAE;YACnB,OAAO,GAAG,kBAAkB,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;SAC3D;QACD,MAAM,IAAI,GAAG,MAAM,kBAAkB,CAAC,gBAAgB,CAAC,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;QAC/F,MAAM,WAAW,GAAqB,kBAAkB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAC/E,OAAO,kBAAkB,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;IAC7D,CAAC;IAED;;SAEK;IACG,MAAM,CAAC,OAAO,CAAS;IAE/B;;SAEK;IACG,MAAM,CAAC,OAAO,CAAS;IAE/B;;;;;SAKK;IACG,MAAM,CAAC,mBAAmB,CAAC,OAAY;QAC7C,IAAI,IAAA,eAAQ,EAAC,OAAO,CAAC,EAAE;YACrB,4CAA4C;YAC5C,OAAO,OAAO,CAAC;SAChB;aAAM;YACL,sCAAsC;YACtC,OAAO,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;SACzC;IACH,CAAC;IAED;;;SAGK;IACG,MAAM,KAAK,GAAG;QACpB,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,EAAE;YACxB,IAAI,CAAC,OAAO,GAAG,mBAAM,CAAC,YAAY,EAAE,CAAC;SACtC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;SAGK;IACG,MAAM,KAAK,MAAM;QACvB,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,EAAE;YACxB,IAAI,CAAC,OAAO,GAAG,IAAI,eAAM,CAAC;gBACxB,aAAa,EAAE,KAAK;gBACpB,UAAU,EAAE,IAAI;gBAChB,aAAa,EAAE,IAAI,CAAK,oDAAoD;aAC7E,CAAC,CAAC;SACJ;QACD,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;;;SAKK;IACG,MAAM,CAAC,mBAAmB,CAAC,WAA6B;QAC9D,IAAI,WAAW,CAAC,QAAQ,IAAI,IAAI,IAAI,WAAW,CAAC,QAAQ,CAAC,aAAa,IAAI,IAAI;eACnE,WAAW,CAAC,QAAQ,CAAC,aAAa,CAAC,aAAa,KAAK,kBAAkB,CAAC,uBAAuB;eAC/F,WAAW,CAAC,QAAQ,CAAC,aAAa,CAAC,aAAa,KAAK,kBAAkB,CAAC,uBAAuB,EAAE;YAC1G,+CAA+C;YAC/C,OAAO,WAAW,CAAC;SACpB;aAAM;YACL,MAAM,IAAI,4BAAe,CAAC;gBACxB,GAAG,EAAE,oCAAgB,CAAC,iBAAiB,CAAC,OAAO,GAAG,IAAI,GAAG,sBAAS,CAAC,UAAU,CAAC,WAAW,CAAC;aAC3F,CAAC,CAAC;SACJ;IACH,CAAC;IAED;;;;;;;SAOK;IACG,MAAM,CAAC,eAAe,CAAC,GAAW;QACxC,IAAI,MAAM,CAAC;QACX,IAAI,KAAY,CAAC;QACjB,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,GAAQ,EAAE,CAAM,EAAE,EAAE;YAChD,KAAK,GAAG,GAAG,CAAC;YACZ,MAAM,GAAG,CAAC,CAAC;QACb,CAAC,CAAC,CAAC;QACH,IAAI,KAAK,IAAI,IAAI,EAAE;YACjB,MAAM,KAAK,CAAC;SACb;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;SAIK;IACK,YAAY,CAAC,QAA0B;QAC/C,QAAQ,CAAC,GAAG,GAAG,6BAA6B,GAAG,QAAQ,CAAC,GAAG,CAAC;QAC5D,IAAI,OAAO,GAAG,QAAQ,CAAC,WAAW,CAAC;QACnC,IAAI;YACF,MAAM,UAAU,GAAG,kBAAkB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;YAC/D,uEAAuE;YACvE,OAAO,GAAG,sBAAS,CAAC,UAAU,CAAC,UAAU,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;SAC9D;QAAC,OAAO,CAAC,EAAE;YACV,wDAAwD;YACxD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,kGAAkG,CAAC,CAAC;SACpH;QACD,QAAQ,CAAC,GAAG,IAAI,IAAI,GAAG,OAAO,CAAC,CAAC,kDAAkD;QAClF,OAAO,QAAQ,CAAC;IAClB,CAAC;;AAnNU,gDAAkB"}

package/node_modules/@zowe/cics-for-zowe-sdk/lib/rest/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This program and the accompanying materials are made available under the terms of the
+ * Eclipse Public License v2.0 which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-v20.html
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Copyright Contributors to the Zowe Project.
+ *
+ */
+export * from "./CicsCmciRestClient";

package/node_modules/@zowe/cics-for-zowe-sdk/lib/rest/index.js

@@ -0,0 +1,28 @@
+"use strict";
+/**
+ * This program and the accompanying materials are made available under the terms of the
+ * Eclipse Public License v2.0 which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-v20.html
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Copyright Contributors to the Zowe Project.
+ *
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./CicsCmciRestClient"), exports);
+//# sourceMappingURL=index.js.map

package/node_modules/@zowe/cics-for-zowe-sdk/lib/rest/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/rest/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;;;;;;;;;;;;;;AAEH,uDAAqC"}