@broadcom/dbm-db2-for-zowe-cli/lib/constants.js

Broadcom Database Management Solutions for Db2 for z/OS plug-in for Zowe CLI

"use strict";
/*!
 * Copyright (c) 2024 Broadcom.  All Rights Reserved.  The term
 * "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
 *
 * This software and all information contained therein is
 * confidential and proprietary and shall not be duplicated,
 * used, disclosed, or disseminated in any way except as
 * authorized by the applicable license agreement, without the
 * express written permission of Broadcom.  All authorized
 * reproductions must be marked with this language.
 *
 * EXCEPT AS SET FORTH IN THE APPLICABLE LICENSE AGREEMENT, TO
 * THE EXTENT PERMITTED BY APPLICABLE LAW, BROADCOM PROVIDES THIS
 * SOFTWARE WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT
 * LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR
 * FITNESS FOR A PARTICULAR PURPOSE.  IN NO EVENT WILL BROADCOM
 * BE LIABLE TO THE END USER OR ANY THIRD PARTY FOR ANY LOSS OR
 * DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS SOFTWARE,
 * INCLUDING WITHOUT LIMITATION, LOST PROFITS, BUSINESS
 * INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF BROADCOM IS
 * EXPRESSLY ADVISED OF SUCH LOSS OR DAMAGE.
 */
Object.defineProperty(exports, "__esModule", { value: true });
exports.Endpoints = exports.DefaultValues = exports.DefaultFileNames = exports.SamplesRepoReference = exports.WorkDatasetsLocationMsg = exports.SuccessMsg = exports.ErrorMsg = exports.ApiConstants = exports.IMPACT_REPORT_VERSION = exports.PROFILE_SPECIAL_PROCESSING_PROPERTIES = exports.PLUGIN_NAME_LOW = exports.PLUGIN_NAME = void 0;
exports.PLUGIN_NAME = "DBM-Db2";
exports.PLUGIN_NAME_LOW = exports.PLUGIN_NAME.toLowerCase();
exports.PROFILE_SPECIAL_PROCESSING_PROPERTIES = ["environmentList"];
exports.IMPACT_REPORT_VERSION = "1.8.0";
class ApiConstants {
}
exports.ApiConstants = ApiConstants;
ApiConstants.BASE_PATH = "dbm/api/v1";
ApiConstants.STATUS_POLL_DELAY = 3000;
var ErrorMsg;
(function (ErrorMsg) {
    ErrorMsg["EXECUTION_FAILURE_TEMPLATE"] = "Execution failed.{{ERROR_FILE_SAVED}}{{RESTART_TOKEN}}";
    ErrorMsg["ERROR_FILE_SAVED"] = "Failure details saved to {{errorFilename}}";
    ErrorMsg["RESTART_TOKEN"] = "Restart token: {{restartToken}}";
    ErrorMsg["PROFILE_NOT_EXISTS"] = "Profile \"{{name}}\" of type \"{{type}}\" does not exist.";
    ErrorMsg["INVALID_EXCEPTION"] = "Unable to process an exception due to invalid type. Expected \"{{type}}\", received:\n\n{{objectDetails}}";
})(ErrorMsg || (exports.ErrorMsg = ErrorMsg = {}));
var SuccessMsg;
(function (SuccessMsg) {
    SuccessMsg["CHECK_DDL"] = "DDL checked successfully. No errors found.";
    SuccessMsg["COMPARE_DDL_TEMPLATE"] = "{{NO_OBJECT_CHANGES}}{{COMPARE_SCRIPT_SAVED}}{{SUMMARY_FILE_SAVED}}{{IMPACT_FILE_SAVED}}";
    SuccessMsg["NO_OBJECT_CHANGES"] = "No Db2 object changes identified. Script execution is not required.";
    SuccessMsg["COMPARE_SCRIPT_SAVED"] = "Compare-script saved to {{scriptFilename}}";
    SuccessMsg["SUMMARY_FILE_SAVED"] = "Summary report saved to {{summaryFilename}}";
    SuccessMsg["IMPACT_FILE_SAVED"] = "Impact report saved to {{impactFilename}}";
    SuccessMsg["DEPLOY_DDL"] = "DDL deployed successfully.";
    SuccessMsg["EXECUTE_SCRIPT"] = "Script executed successfully.";
    SuccessMsg["EXECUTE_CMP_SCRIPT_TEMPLATE"] = "{{EXECUTE_SCRIPT}}{{RECOVERY_SCRIPT_INFO}}";
    SuccessMsg["RECOVERY_SCRIPT_SKIPPED"] = "Recovery script not saved: Empty response received during restart. Existing output preserved.";
    SuccessMsg["RECOVERY_SCRIPT_SAVED"] = "Recovery script saved to {{recoveryScriptFilename}}";
    SuccessMsg["DDL_FILE_SAVED"] = "DDL saved to {{ddlFilename}}";
    SuccessMsg["PREPARE_MIGRATION_TEMPLATE"] = "{{MIGRATION_SCRIPT_SAVED}}{{DDL_FILE_SAVED}}";
    SuccessMsg["MIGRATION_SCRIPT_SAVED"] = "Migration-script saved to {{scriptFilename}}";
})(SuccessMsg || (exports.SuccessMsg = SuccessMsg = {}));
exports.WorkDatasetsLocationMsg = "Work data sets location: {{HLQ}}";
exports.SamplesRepoReference = `For details about command usage for automation, see ${exports.PLUGIN_NAME} samples\
 at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli`;
var DefaultFileNames;
(function (DefaultFileNames) {
    DefaultFileNames["ERROR_FILE"] = "error.log";
    DefaultFileNames["COMPARE_SCRIPT"] = "compare.txt";
    DefaultFileNames["SUMMARY_FILE"] = "summary.txt";
    DefaultFileNames["IMPACT_FILE"] = "impact.json";
    DefaultFileNames["DDL_FILE"] = "output.sql";
    DefaultFileNames["RECOVERY_SCRIPT"] = "recovery.txt";
    DefaultFileNames["MIGRATE_SCRIPT"] = "migration.txt";
})(DefaultFileNames || (exports.DefaultFileNames = DefaultFileNames = {}));
var DefaultValues;
(function (DefaultValues) {
    DefaultValues["VERIFY"] = "no";
    DefaultValues["TYPE"] = "create";
})(DefaultValues || (exports.DefaultValues = DefaultValues = {}));
var Endpoints;
(function (Endpoints) {
    Endpoints["CHECK"] = "devops/check";
    Endpoints["COMPARE"] = "devops/compare";
    Endpoints["DEPLOY"] = "devops/deploy";
    Endpoints["EXECUTE"] = "devops/execute";
    Endpoints["EXECUTE_COMPARE"] = "devops/execute/compare";
    Endpoints["EXECUTE_MIGRATE"] = "devops/execute/migrate";
    Endpoints["GENERATE"] = "devops/generate";
    Endpoints["MIGRATE"] = "devops/migrate";
    Endpoints["STATUS"] = "devops/status";
    Endpoints["SUBSYSTEMS_ACTIVE"] = "gen/subsystems/active";
    Endpoints["ABOUT"] = "about";
})(Endpoints || (exports.Endpoints = Endpoints = {}));
//# sourceMappingURL=constants.js.map