@broadcom/jclcheck-for-zowe-cli/lib/pluginDef.js

JCLCheck Plug-in for Zowe CLI

"use strict";
/**
 * Copyright (c) 2023. Broadcom.  All rights reserved.
 *
 * 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 CA IS EXPRESSLY ADVISED OF SUCH LOSS OR
 * DAMAGE.
 *
 * The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
 *
 **/
const ProfileConstants_1 = require("./api/ProfileConstants");
const JCLCheckSessionUtils_1 = require("./cli/JCLCheckSessionUtils");
const pluginDef = {
    commandModuleGlobs: ["**/cli/*/*.definition!(.d).*s"],
    pluginLifeCycle: __dirname + "/LifeCycleForJCLCheck",
    pluginSummary: ProfileConstants_1.ProfileConstants.PLUGIN_SUMMARY,
    pluginAliases: [ProfileConstants_1.ProfileConstants.ALIAS],
    rootCommandDescription: ProfileConstants_1.ProfileConstants.PLUGIN_DESCRIPTION,
    productDisplayName: ProfileConstants_1.ProfileConstants.DISPLAY_NAME,
    name: ProfileConstants_1.ProfileConstants.NAME,
    apimlConnLookup: [
        {
            apiId: "com.broadcom.jclcheck",
            gatewayUrl: "api/v1",
            connProfType: "jclcheck"
        }
    ],
    profiles: [
        {
            type: "jclcheck",
            schema: {
                type: "object",
                title: "JCLCheck Profile",
                description: "A JCLCheck profile is required to issue commands in the jcl command group that interact with JCLCheck. The JCLCheck " +
                    "profile contains your host and port for the JCLCheck instance of your choice.",
                properties: {
                    host: {
                        type: "string",
                        optionDefinition: JCLCheckSessionUtils_1.JCLCheckSessionUtils.JCLCHECK_OPTION_HOST
                    },
                    port: {
                        type: "number",
                        optionDefinition: JCLCheckSessionUtils_1.JCLCheckSessionUtils.JCLCHECK_OPTION_PORT,
                        includeInTemplate: true
                    },
                    user: {
                        type: "string",
                        secure: true,
                        optionDefinition: JCLCheckSessionUtils_1.JCLCheckSessionUtils.JCLCHECK_OPTION_USER
                    },
                    password: {
                        type: "string",
                        secure: true,
                        optionDefinition: JCLCheckSessionUtils_1.JCLCheckSessionUtils.JCLCHECK_OPTION_PASSWORD
                    },
                    basePath: {
                        type: "string",
                        optionDefinition: JCLCheckSessionUtils_1.JCLCheckSessionUtils.JCLCHECK_OPTION_BASE_PATH,
                        includeInTemplate: true
                    },
                    rejectUnauthorized: {
                        type: "boolean",
                        optionDefinition: JCLCheckSessionUtils_1.JCLCheckSessionUtils.JCLCHECK_OPTION_REJECT_UNAUTHORIZED
                    },
                    protocol: {
                        type: "string",
                        optionDefinition: JCLCheckSessionUtils_1.JCLCheckSessionUtils.JCLCHECK_OPTION_PROTOCOL
                    },
                    jclcheckOptions: {
                        type: "string",
                        optionDefinition: JCLCheckSessionUtils_1.JCLCheckSessionUtils.JCLCHECK_OPTION_JCK_OPTS
                    }
                },
                required: []
            },
            /*createProfileExamples: [
                {
                    options: "jcl123 --host zos123 --port 1234 --user ibmuser --pass myp4ss",
                    description: "Create a JCLCheck profile named 'jcl123' to run JCLCheck at host zos123 and port 1234"
                },
                {
                    options: `jcl123 --host zos123 --port 1234 --user ibmuser --pass myp4ss --jo "${ProfileConstants.EXAMPLE_JCK_OPTS}"`,
                    description: "Create a JCLCheck profile with default set of JCLCheck runtime options specified"
                }
            ]*/
        }
    ]
};
module.exports = pluginDef;
//# sourceMappingURL=pluginDef.js.map