trm-client/dist/index.js

TRM (Transport Request Manager) Client

#!/usr/bin/env node
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const commander_1 = require("commander");
const utils_1 = require("./utils");
const trm_registry_types_1 = require("trm-registry-types");
const program = new commander_1.Command();
program
    .name(`trm`)
    .description(`TRM - Transport Request Manager CLI`)
    .version((0, utils_1.getClientVersion)(), `-cv, --clientVersion`, `Client version.`);
const createAlias = program.command(`createAlias <alias>`)
    .description(`Create a new system alias.`);
(0, utils_1.registerCommand)(createAlias);
const deleteAlias = program.command(`deleteAlias <alias>`)
    .description(`Delete a system alias.`);
(0, utils_1.registerCommand)(deleteAlias);
const manageAliases = program.command(`alias [alias]`)
    .description(`List and manage aliases.`);
(0, utils_1.registerCommand)(manageAliases);
const addRegistry = program.command(`addRegistry <registryName>`)
    .description(`Add a new registry.`)
    .option(`-e, --endpoint <endpoint>`, `Endpoint.`)
    .option(`-a, --authentication <authentication>`, `Optional authentication as a valid JSON string.`);
(0, utils_1.registerCommand)(addRegistry);
const removeRegistry = program.command(`removeRegistry <registryName>`)
    .description(`Remove a registry.`)
    .option(`-f, --force`, `Force.`, false);
(0, utils_1.registerCommand)(removeRegistry);
const login = program.command(`login`)
    .description(`Log into a registry.`)
    .addHelpText(`before`, `This command has no effect when trying to login into a registry that doesn't require authentication.`)
    .option(`-f, --force`, `Force login.`, false)
    .option(`-a, --authentication <authentication>`, `Authentication as a valid JSON string.`);
(0, utils_1.registerCommand)(login, {
    requiresRegistry: true,
    registryAuthBlacklist: [trm_registry_types_1.AuthenticationType.NO_AUTH]
});
const whoami = program.command(`whoami`)
    .description(`Registry logged user data.`)
    .addHelpText(`before`, `This command has no effect when trying to get user info from a registry that doesn't require authentication.`);
(0, utils_1.registerCommand)(whoami, {
    requiresRegistry: true,
    registryAuthBlacklist: [trm_registry_types_1.AuthenticationType.NO_AUTH]
});
const logout = program.command(`logout`)
    .description(`Log out of a registry.`)
    .addHelpText(`before`, `This command has no effect when trying to logout from a registry that doesn't require authentication.`);
(0, utils_1.registerCommand)(logout, {
    requiresRegistry: true,
    registryAuthBlacklist: [trm_registry_types_1.AuthenticationType.NO_AUTH]
});
const ping = program.command(`ping`)
    .description(`Ping trm-server.`);
(0, utils_1.registerCommand)(ping, {
    requiresConnection: true,
    requiresTrmDependencies: true
});
const publish = program.command(`publish <package> [version]`)
    .description(`Publish package to registry.`)
    .addHelpText(`before`, `When no version is defined, it will automatically set to:
- When it's the first publish: 1.0.0
- When it's already published: the latest available release with patch increased by 1
When it's the first publish, full manifest definition is asked.
When a release is already published, the latest available manifest is used but can be overwritten.
Translation transport is only generated for packages that contain one or more objects with translations (unless skipped by flag).
Customizing transport is only generated if a valid list of customizing transports is provided (unless skipped by flag).
If a default manifest with dependencies is provided in conjunction with the automatic dependency generation, results will be merged.`)
    .option(`-p, --private`, `Publish package with private visibility.`)
    .option(`-np, --noPrompts`, `No prompts (will force some decisions).`, false)
    .option(`-km, --keepLatestReleaseManifestValues`, `Keep the latest release (if exists) manifest values as defaults.`, true)
    .option(`-nl, --noLanguageTransport`, `Skip language (translations) transport publish.`, false)
    .option(`-nd, --noDependenciesDetection`, `Skip automatic dependencies detection.`, false)
    .option(`-sc, --skipCustomizingTransports`, `Skip customizing transports input.`, false)
    .option(`-to, --releaseTimeout <timeout>`, `Publish transports release timeout (in seconds).`, '180')
    .option(`-d, --devclass <devclass>`, `ABAP package to publish.`)
    .option(`-cust, --customizingTransports <customizingTransports>`, `Customizing transports (separated by comma).`)
    .option(`-rm, --readme <readme>`, `Path to file or value of readme.`)
    .option(`-tt, --transportTarget <transportTarget>`, `Publish transports target.`)
    .option(`-bc, --backwardsCompatible`, `Indicates backwards compatibility with older releases.`, true)
    .option(`-sd, --description`, `Short description of the package.`)
    .option(`-gl, --git <link>`, `Git link.`)
    .option(`-wl, --website <link>`, `Website link.`)
    .option(`-pl, --license <license>`, `Package license.`)
    .option(`-pa, --authors <authors>`, `Package authors (separated by comma).`)
    .option(`-pk, --keywords <keywords>`, `Package keywords (separated by comma).`)
    .option(`-pd, --dependencies <JSON>`, `Package dependencies (in JSON format).`)
    .option(`-ps, --sapEntries <JSON>`, `Package SAP entries (in JSON format).`);
(0, utils_1.registerCommand)(publish, {
    requiresConnection: true,
    requiresRegistry: true,
    requiresTrmDependencies: true
});
const pack = program.command(`pack <package> [version]`)
    .description(`Save package locally.`)
    .addHelpText(`before`, `When no version is defined, it will automatically set to 1.0.0.
Translation transport is only generated for packages that contain one or more objects with translations (unless skipped by flag).
Customizing transport is only generated if a valid list of customizing transports is provided (unless skipped by flag).
If a default manifest with dependencies is provided in conjunction with the automatic dependency generation, results will be merged.`)
    .option(`-o, --output <<outputPath>>`, `Output path.`)
    .option(`-np, --noPrompts`, `No prompts (will force some decisions).`, false)
    .option(`-nl, --noLanguageTransport`, `Skip language (translations) transport publish.`, false)
    .option(`-nd, --noDependenciesDetection`, `Skip automatic dependencies detection.`, false)
    .option(`-sc, --skipCustomizingTransports`, `Skip customizing transports input.`, false)
    .option(`-to, --releaseTimeout <timeout>`, `Publish transports release timeout (in seconds).`, '180')
    .option(`-d, --devclass <devclass>`, `ABAP package to publish.`)
    .option(`-cust, --customizingTransports <customizingTransports>`, `Customizing transports (separated by comma).`)
    .option(`-tt, --transportTarget <transportTarget>`, `Publish transports target.`)
    .option(`-bc, --backwardsCompatible`, `Indicates backwards compatibility with older releases.`, true)
    .option(`-sd, --description`, `Short description of the package.`)
    .option(`-gl, --git <link>`, `Git link.`)
    .option(`-wl, --website <link>`, `Website link.`)
    .option(`-pl, --license <license>`, `Package license.`)
    .option(`-pa, --authors <authors>`, `Package authors (separated by comma).`)
    .option(`-pk, --keywords <keywords>`, `Package keywords (separated by comma).`)
    .option(`-pd, --dependencies <JSON>`, `Package dependencies (in JSON format).`)
    .option(`-ps, --sapEntries <JSON>`, `Package SAP entries (in JSON format).`);
(0, utils_1.registerCommand)(pack, {
    requiresConnection: true,
    requiresTrmDependencies: true
});
const unpublish = program.command(`unpublish <package> [version]`)
    .description(`Unpublish a package release from registry.`);
(0, utils_1.registerCommand)(unpublish, {
    requiresRegistry: true
});
const install = program.command(`install <package> [version]`)
    .description(`Install package from registry into system.`)
    .addHelpText(`before`, `When no version is specified, the latest will be installed.`)
    .option(`-np, --noPrompts`, `No prompts (will force some decisions).`, false)
    .option(`-ow, --overwrite`, `Overwrite installation (allow re-install).`, false)
    .option(`-sf, --safe`, `Safe install (needs package integrity).`, false)
    .option(`-nd, --noDependencies`, `Skip check/install of package dependencies.`, false)
    .option(`-no, --noObjectTypes`, `Skip check of package object types.`, false)
    .option(`-ns, --noSapEntries`, `Skip check of package SAP entries/objects.`, false)
    .option(`-nl, --noLanguageTransport`, `Skip install of language (translations) transport (if exists).`, false)
    .option(`-nc, --noCustomizingTransport`, `Skip install of customizing transport (if exists).`, false)
    .option(`-to, --importTimeout <timeout>`, `Install transports import timeout (in seconds).`, '180')
    .option(`-kd, --keepOriginalPackages`, `Keep original ABAP packages names.`, false)
    .option(`-it, --createInstallTransport`, `Create/update install transport (used for landscape transports).`, true)
    .option(`-r3, --r3transPath <path>`, `R3trans program path. (default: Environment variable R3TRANS_HOME)`)
    .option(`-sha, --integrity <sha>`, `Package integrity.`)
    .option(`-tl, --transportLayer <transportLayer>`, `ABAP packages transport layer. (default: System default)`)
    .option(`-tl, --packageReplacements <JSON>`, `ABAP package replacements in JSON format.`)
    .option(`-itt, --installTransportTargetSys <transportTarget>`, `Install transport target system.`);
(0, utils_1.registerCommand)(install, {
    requiresConnection: true,
    requiresRegistry: true,
    requiresTrmDependencies: true
});
const update = program.command(`update <package> [version]`)
    .description(`Update package from registry into system.`)
    .description(`Install package from registry into system.`)
    .addHelpText(`before`, `When no version is specified, the latest will be installed.`)
    .option(`-np, --noPrompts`, `No prompts (will force some decisions).`, false)
    .option(`-sf, --safe`, `Safe install (needs package integrity).`, false)
    .option(`-nd, --noDependencies`, `Skip check/install of package dependencies.`, false)
    .option(`-no, --noObjectTypes`, `Skip check of package object types.`, false)
    .option(`-ns, --noSapEntries`, `Skip check of package SAP entries/objects.`, false)
    .option(`-nl, --noLanguageTransport`, `Skip install of language (translations) transport (if exists).`, false)
    .option(`-nc, --noCustomizingTransport`, `Skip install of customizing transport (if exists).`, false)
    .option(`-to, --importTimeout <timeout>`, `Install transports import timeout (in seconds).`, '180')
    .option(`-kd, --keepOriginalPackages`, `Keep original ABAP packages names.`, false)
    .option(`-it, --createInstallTransport`, `Create/update install transport (used for landscape transports).`, true)
    .option(`-r3, --r3transPath <path>`, `R3trans program path. (default: Environment variable R3TRANS_HOME)`)
    .option(`-sha, --integrity <sha>`, `Package integrity.`)
    .option(`-tl, --transportLayer <transportLayer>`, `ABAP packages transport layer. (default: System default)`)
    .option(`-tl, --packageReplacements <JSON>`, `ABAP package replacements in JSON format.`)
    .option(`-itt, --installTransportTargetSys <transportTarget>`, `Install transport target system.`);
(0, utils_1.registerCommand)(update, {
    requiresConnection: true,
    requiresRegistry: true,
    requiresTrmDependencies: true
});
const _import = program.command(`import <file>`)
    .description(`Import a package (as a file) into system.`)
    .option(`-np, --noPrompts`, `No prompts (will force some decisions).`, false)
    .option(`-ow, --overwrite`, `Overwrite installation (allow re-install).`, false)
    .option(`-sf, --safe`, `Safe install (needs package integrity).`, false)
    .option(`-nd, --noDependencies`, `Skip check/install of package dependencies.`, false)
    .option(`-no, --noObjectTypes`, `Skip check of package object types.`, false)
    .option(`-ns, --noSapEntries`, `Skip check of package SAP entries/objects.`, false)
    .option(`-nl, --noLanguageTransport`, `Skip install of language (translations) transport (if exists).`, false)
    .option(`-nc, --noCustomizingTransport`, `Skip install of customizing transport (if exists).`, false)
    .option(`-to, --importTimeout <timeout>`, `Install transports import timeout (in seconds).`, '180')
    .option(`-kd, --keepOriginalPackages`, `Keep original ABAP packages names.`, false)
    .option(`-it, --createInstallTransport`, `Create/update install transport (used for landscape transports).`, true)
    .option(`-r3, --r3transPath <path>`, `R3trans program path. (default: Environment variable R3TRANS_HOME)`)
    .option(`-sha, --integrity <sha>`, `Package integrity.`)
    .option(`-tl, --transportLayer <transportLayer>`, `ABAP packages transport layer. (default: System default)`)
    .option(`-tl, --packageReplacements <JSON>`, `ABAP package replacements in JSON format.`)
    .option(`-itt, --installTransportTargetSys <transportTarget>`, `Install transport target system.`);
(0, utils_1.registerCommand)(_import, {
    requiresConnection: true,
    requiresTrmDependencies: true
});
const view = program.command(`view <package>`)
    .description(`View package.`)
    .addHelpText(`before`, `Shows package details.
If the package is not found on the system, it will automatically fall back to the data provided by the registry, granted it exists.`);
(0, utils_1.registerCommand)(view, {
    requiresConnection: true,
    addNoConnection: true,
    requiresRegistry: true,
    ignoreRegistryUnreachable: true
});
const compare = program.command(`compare <package>`)
    .description(`Compare a package on different systems.`)
    .option(`-c, --connections <json>`, `Path to JSON file or JSON containing an array of aliases.`);
(0, utils_1.registerCommand)(compare, {
    requiresRegistry: true,
    ignoreRegistryUnreachable: true
});
const content = program.command(`content <package> [version]`)
    .description(`List content of a package.`)
    .option(`-a, --all`, `List all content`, false)
    .option(`-r3, --r3transPath <path>`, `R3trans program path. (default: Environment variable R3TRANS_HOME)`);
(0, utils_1.registerCommand)(content, {
    requiresRegistry: true
});
const list = program.command(`list`)
    .description(`List packages installed on a system.`)
    .option(`-l, --locals`, `List imported/exported local packages`, false);
(0, utils_1.registerCommand)(list, {
    requiresConnection: true
});
const check = program.command(`check <package>`)
    .description(`Analyze installed package status on a system.`)
    .option(`-at, --analysisType`, `Analysis type (DEPENDENCIES, SAPENTRIES or ALL).`);
(0, utils_1.registerCommand)(check, {
    requiresConnection: true,
    requiresRegistry: true,
    ignoreRegistryUnreachable: true
});
const findDependencies = program.command(`findDependencies <devclass>`)
    .description(`Find SAP package dependencies with custom packages/trm packages/SAP entries/objects.`)
    .option(`-se, --sapEntries`, `Show list of required SAP entries/objects.`, false)
    .option(`-np, --noPrompts`, `No prompts (will force some decisions).`, false);
(0, utils_1.registerCommand)(findDependencies, {
    requiresConnection: true
});
const info = program.command(`info`)
    .description(`TRM Client/Server Info.`);
(0, utils_1.registerCommand)(info, {
    requiresConnection: true,
    addNoConnection: true,
    requiresTrmDependencies: true
});
const settings = program.command(`settings`)
    .description(`Show/Set settings.`)
    .option(`-s, --set <property>`, `Property as KEY=VALUE.`);
(0, utils_1.registerCommand)(settings);
program.parse(process.argv);