@broadcom/endevor-bridge-for-git-for-zowe-cli/lib/cli/commands/add/add-element/AddElement.definition.js

Endevor Bridge for Git plug-in for Zowe CLI

'use strict';

var EBGSession = require('../../../sessions/EBGSession.js');
var EndevorSession = require('../../../sessions/EndevorSession.js');
var AddElementOptions = require('../../../options/AddElementOptions.js');

/*
 * Copyright (c) 2026 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.
 *
 */
const AddElementDefinition = {
    name: "element",
    aliases: ["ele"],
    type: "command",
    handler: __dirname + "/AddElement.handler",
    description: "Add an element to your Git repository from up the map in Endevor.",
    positionals: [AddElementOptions.AddElementOptions.CONTEXT, AddElementOptions.AddElementOptions.MAPPING],
    profile: {
        optional: [EBGSession.EBGSession.PROFILE_TYPE, EndevorSession.EndevorSession.PROFILE_TYPE],
    },
    options: [
        AddElementOptions.AddElementOptions.ELEMENT_NAME,
        AddElementOptions.AddElementOptions.ELEMENT_TYPE,
        AddElementOptions.AddElementOptions.ENDEVOR_SYSTEM,
        AddElementOptions.AddElementOptions.ENDEVOR_SUBSYSTEM,
        AddElementOptions.AddElementOptions.WITH_DEPENDENCIES,
        AddElementOptions.AddElementOptions.FORCE_GET_DEPENDENCIES,
        AddElementOptions.AddElementOptions.BRANCH_ID,
        AddElementOptions.AddElementOptions.ALL_BRANCHES,
        AddElementOptions.AddElementOptions.FILE_NAME,
    ].concat(EndevorSession.EndevorSession.ENDEVOR_CONNECTION_OPTIONS),
    examples: [
        {
            description: "Add an element 'MY-ELEMENT-TYPE / MY-ELEMENT-NAME' for your mapping 'MY-CONTEXT / MY-MAPPING'",
            options: "MY-CONTEXT MY-MAPPING " +
                "--name MY-ELEMENT-NAME --type MY-ELEMENT-TYPE",
        },
        {
            description: "Add multiple elements for your mapping 'MY-CONTEXT / MY-MAPPING' from file",
            options: "MY-CONTEXT MY-MAPPING " + "--file MY-FILEPATH.json",
        },
    ],
};

exports.AddElementDefinition = AddElementDefinition;