@sap/cli-core 2023.12.0

package/dwc/dwc.js

@@ -0,0 +1,180 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCommands = exports.executeCommand = exports.init = void 0;
+if (process.env.SUPPRESS_NO_CONFIG_WARNING === undefined) {
+    process.env.SUPPRESS_NO_CONFIG_WARNING = "true";
+}
+const path_1 = __importDefault(require("path"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const logger_1 = require("../logger");
+const constants_1 = require("../constants");
+const cache_1 = require("../cache");
+const config_1 = require("../config");
+const commands_1 = require("../utils/commands");
+const discovery_1 = require("../discovery");
+const settings_1 = require("../settings");
+const utils_1 = require("./utils");
+const utils_2 = require("../commands/handler/options/utils");
+const core_1 = require("../config/core");
+const ResultHandlerImpl_1 = require("../result/ResultHandlerImpl");
+const ResultHandlerFactory_1 = require("../result/ResultHandlerFactory");
+let program;
+let initialized = false;
+const getLogger = () => (0, logger_1.get)("dwc.dwc");
+const MANDATORY_OPTIONS = [
+    constants_1.OPTION_VERSION,
+    constants_1.OPTION_HELP,
+    constants_1.OPTION_HOST,
+    constants_1.OPTION_FILE_PATH,
+    constants_1.OPTION_FORCE,
+    constants_1.OPTION_OUTPUT,
+    constants_1.OPTION_VERBOSE,
+    constants_1.OPTION_INPUT,
+    constants_1.OPTION_OPTIONS_FILE,
+];
+const setTenant = async () => {
+    const config = (0, config_1.get)();
+    if (config.host) {
+        return;
+    }
+    const readHostFromArgv = async () => (0, utils_1.getOptionValueFromArgv)(constants_1.OPTION_HOST);
+    const readHostFromOptionsFile = async () => {
+        const filePath = (0, utils_1.getOptionValueFromArgv)(constants_1.OPTION_OPTIONS_FILE);
+        return (0, utils_2.getValueFromOptionsFile)(filePath, constants_1.OPTION_HOST);
+    };
+    const readHostFromOptions = async () => {
+        if (!config.options?.[constants_1.OPTION_HOST.longName]) {
+            throw new Error("host not found in options");
+        }
+        return config.options[constants_1.OPTION_HOST.longName];
+    };
+    const strategies = [
+        {
+            func: readHostFromArgv,
+            name: "read host from argv",
+        },
+        {
+            func: readHostFromOptionsFile,
+            name: "read host from options-file",
+        },
+        {
+            func: readHostFromOptions,
+            name: "read host from options",
+        },
+    ];
+    const { trace } = getLogger();
+    for (const { name, func } of strategies) {
+        trace(`trying to ${name}`);
+        try {
+            // eslint-disable-next-line no-await-in-loop
+            const host = await func();
+            (0, config_1.set)({ tenant: host });
+        }
+        catch (err) {
+            trace(`failed to ${name}`, err);
+        }
+    }
+};
+const setHost = async () => {
+    const settings = await (0, settings_1.get)();
+    if (settings.host) {
+        (0, config_1.set)({ options: { [constants_1.OPTION_HOST.longName]: settings.host } });
+    }
+};
+const initCacheTolerant = async () => {
+    try {
+        await (0, cache_1.init)();
+    }
+    catch {
+        // ignore
+    }
+};
+const registerMandatoryOptions = () => {
+    MANDATORY_OPTIONS.forEach((option) => (0, commands_1.registerLongName)(option.longName));
+};
+const init = async () => {
+    const { error, debug } = getLogger();
+    if (initialized) {
+        return;
+    }
+    initialized = true;
+    const resultHandler = new ResultHandlerImpl_1.ResultHandlerImpl();
+    ResultHandlerFactory_1.ResultHandlerFactory.set(resultHandler);
+    registerMandatoryOptions();
+    await setHost();
+    await setTenant();
+    await initCacheTolerant();
+    program = (0, commands_1.createCommand)();
+    program.version((0, core_1.getVersion)(), "-v, --version", "output the current version");
+    program.description((0, config_1.get)()[constants_1.CLI_DESCRIPTION]);
+    program.showHelpAfterError(`Did you initialize the CLI by running ${(0, config_1.get)()[constants_1.CLI_NAME]} cache init -H "<Server_URL>"?` +
+        ` Add --help, -h or go to ${(0, config_1.get)()[constants_1.CLI_SAP_HELP]} for additional information.`);
+    program.addOption((0, commands_1.buildOption)(constants_1.OPTION_HOST));
+    program.addOption((0, commands_1.buildOption)(constants_1.OPTION_OPTIONS_FILE));
+    program.configureHelp({ sortSubcommands: true });
+    const commandsPath = path_1.default.join(__dirname, "..", "commands");
+    for (const file of (await fs_extra_1.default.readdir(commandsPath, {
+        encoding: "utf-8",
+        withFileTypes: false,
+    })).filter((f) => f.includes(".command") && !f.endsWith(".d.ts"))) {
+        try {
+            // eslint-disable-next-line
+            const content = require(path_1.default.join(commandsPath, file));
+            if (content.addCommands) {
+                debug("adding commands from file %s.addCommands", file);
+                // eslint-disable-next-line
+                await content.addCommands(program);
+            }
+            else {
+                debug("adding command from file %s.default", file);
+                (0, commands_1.buildCommand)(program, content.default);
+            }
+        }
+        catch (err) {
+            error("error while adding command from file %s:", file, err.stack);
+        }
+    }
+    debug("cli initialized");
+};
+exports.init = init;
+const executeCommand = async (command) => {
+    await program.parseAsync(command?.split(" ") || undefined);
+};
+exports.executeCommand = executeCommand;
+const buildCommandsObject = (name, command, object = {}) => {
+    const commandName = name || "dwc";
+    // eslint-disable-next-line no-param-reassign
+    object[commandName] = async (options) => {
+        await (0, exports.executeCommand)(new Array(2)
+            .fill("dummy")
+            .concat(name.split(" ").concat(options
+            ? Object.entries(options).reduce((prev, curr) => {
+                const [key, value] = curr;
+                return prev.concat([key, value]);
+            }, [])
+            : []))
+            .join(" "));
+        return ResultHandlerFactory_1.ResultHandlerFactory.get().getResult();
+    };
+    /* istanbul ignore next */
+    command.commands.forEach((c) => {
+        buildCommandsObject(name ? `${name} ${c.name()}` : c.name(), c, object);
+    });
+    return object;
+};
+const reinitialize = (host) => {
+    initialized = false;
+    (0, config_1.initialize)();
+    (0, config_1.set)({ tenant: host });
+    (0, config_1.setCustomConfig)();
+    (0, discovery_1.clear)();
+};
+const getCommands = async (host) => {
+    reinitialize(host);
+    await (0, exports.init)();
+    return buildCommandsObject("", program);
+};
+exports.getCommands = getCommands;

package/dwc/run.d.ts

@@ -0,0 +1 @@
+export declare const run: () => Promise<void>;

package/dwc/run.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.run = void 0;
+const core_1 = require("../config/core");
+const logger_1 = require("../logger");
+const dwc_1 = require("./dwc");
+const utils_1 = require("./utils");
+const run = async () => {
+    const { error, debug, output } = (0, logger_1.get)("dwc.run");
+    let exitCode = 0;
+    try {
+        await (0, dwc_1.init)();
+        await (0, utils_1.checkVersion)();
+        await (0, dwc_1.executeCommand)();
+    }
+    catch (err) {
+        if (err.code === "commander.helpDisplayed") {
+            debug("Error while running CLI", err.stack);
+        }
+        else {
+            error("Error while running CLI", err.stack);
+            exitCode = 1;
+        }
+    }
+    finally {
+        await (0, utils_1.compareEtags)();
+        if ((0, core_1.isDeprecated)()) {
+            const message = (0, core_1.getDeprecationMessage)() ||
+                "WARNING: This package has been deprecated. Please consult the README or CHANGELOG for more information.";
+            output(message);
+        }
+        if (exitCode > 0) {
+            process.exit(exitCode);
+        }
+    }
+};
+exports.run = run;

package/dwc/utils.d.ts

@@ -0,0 +1,4 @@
+import { Option } from "../types";
+export declare const checkVersion: () => Promise<void>;
+export declare const compareEtags: () => Promise<void>;
+export declare const getOptionValueFromArgv: ({ longName }: Option) => string;

package/dwc/utils.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getOptionValueFromArgv = exports.compareEtags = exports.checkVersion = void 0;
+const logger_1 = require("../logger");
+const discovery_1 = require("../discovery");
+const commands_1 = require("../utils/commands");
+const core_1 = require("../config/core");
+const getLogger = () => (0, logger_1.get)("dwc.utils");
+const checkVersion = async () => {
+    const { output, error } = getLogger();
+    try {
+        const result = await (0, discovery_1.checkVersion)();
+        if (result.status === "OUTDATED") {
+            output(`Your local CLI installation is outdated. Run 'npm install ${(0, core_1.getPackageName)()} [-g]' to update`);
+        }
+    }
+    catch (err) {
+        error(err.stack);
+    }
+};
+exports.checkVersion = checkVersion;
+const compareEtags = async () => {
+    if (!(await (0, discovery_1.compareEtags)())) {
+        const { output } = getLogger();
+        output(`Your local CLI cache is outdated. Run 'dwc cache init' to update`);
+    }
+};
+exports.compareEtags = compareEtags;
+const getOptionValueFromArgv = ({ longName }) => {
+    const shortFlag = (0, commands_1.getShortFlagForLongName)(longName);
+    const index = process.argv.findIndex((a) => a === `-${shortFlag}` || a === `--${longName}`);
+    if (index > -1) {
+        return process.argv[index + 1];
+    }
+    throw new Error(`option ${longName} not found in argv`);
+};
+exports.getOptionValueFromArgv = getOptionValueFromArgv;

package/index.d.ts

@@ -0,0 +1,16 @@
+import { AuthenticationMethod } from "./constants";
+export { run } from "./dwc/run";
+export { configure, getCommands } from "./module";
+export { AuthenticationMethod };
+export { getVersion, getBin, getDescription, getName, getPackageName, } from "./utils/utils";
+export declare const configureCoreModule: ({ name, packageName, discoveryPath, description, sapHelpLink, authenticationMethods, version, deprecated, deprecationMessage, }: {
+    name: string;
+    packageName: string;
+    discoveryPath: string;
+    description: string;
+    sapHelpLink: string;
+    authenticationMethods?: AuthenticationMethod[] | undefined;
+    version: string;
+    deprecated?: boolean | undefined;
+    deprecationMessage?: string | undefined;
+}) => void;

package/index.js

@@ -0,0 +1,59 @@
+"use strict";
+/* eslint-disable import/first */
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configureCoreModule = exports.getPackageName = exports.getName = exports.getDescription = exports.getBin = exports.getVersion = exports.AuthenticationMethod = exports.getCommands = exports.configure = exports.run = void 0;
+const dotenv = __importStar(require("dotenv"));
+const configureLoggers_1 = require("./configureLoggers");
+dotenv.config();
+(0, configureLoggers_1.configureLoggers)();
+const config_1 = require("./config");
+const constants_1 = require("./constants");
+Object.defineProperty(exports, "AuthenticationMethod", { enumerable: true, get: function () { return constants_1.AuthenticationMethod; } });
+var run_1 = require("./dwc/run");
+Object.defineProperty(exports, "run", { enumerable: true, get: function () { return run_1.run; } });
+var module_1 = require("./module");
+Object.defineProperty(exports, "configure", { enumerable: true, get: function () { return module_1.configure; } });
+Object.defineProperty(exports, "getCommands", { enumerable: true, get: function () { return module_1.getCommands; } });
+var utils_1 = require("./utils/utils");
+Object.defineProperty(exports, "getVersion", { enumerable: true, get: function () { return utils_1.getVersion; } });
+Object.defineProperty(exports, "getBin", { enumerable: true, get: function () { return utils_1.getBin; } });
+Object.defineProperty(exports, "getDescription", { enumerable: true, get: function () { return utils_1.getDescription; } });
+Object.defineProperty(exports, "getName", { enumerable: true, get: function () { return utils_1.getName; } });
+Object.defineProperty(exports, "getPackageName", { enumerable: true, get: function () { return utils_1.getPackageName; } });
+const configureCoreModule = ({ name, packageName, discoveryPath, description, sapHelpLink, authenticationMethods = [constants_1.AuthenticationMethod.oauth], version, deprecated = false, deprecationMessage, }) => {
+    (0, config_1.set)({
+        [constants_1.CLI_NAME]: name,
+        [constants_1.CLI_PACKAGE_NAME]: packageName,
+        [constants_1.CLI_DESCRIPTION]: description,
+        [constants_1.CLI_DISCOVERY_PATH]: discoveryPath,
+        [constants_1.CLI_SAP_HELP]: sapHelpLink,
+        [constants_1.CLI_SUPPORTED_AUTHENTICATION_METHODS]: authenticationMethods,
+        [constants_1.CLI_VERSION]: version,
+        [constants_1.CLI_DEPRECATED]: deprecated,
+        [constants_1.CLI_DEPRECATION_MESSAGE]: deprecationMessage,
+    });
+};
+exports.configureCoreModule = configureCoreModule;

package/logger/index.d.ts

@@ -0,0 +1,28 @@
+import { LogLevel } from "../types";
+type Method = (...args: Array<any>) => void;
+export type Logger = {
+    output: Method;
+    error: Method;
+    warn: Method;
+    info: Method;
+    log: Method;
+    debug: Method;
+    trace: Method;
+};
+type CustomLogger = {
+    output?: Method;
+    error?: Method;
+    warn?: Method;
+    info?: Method;
+    log?: Method;
+    debug?: Method;
+    trace?: Method;
+};
+export type Configuration = {
+    logLevel?: LogLevel;
+    loggers?: RegExp | "RESET";
+    customLogger?: CustomLogger | "RESET";
+};
+export declare const configure: ({ logLevel: newLogLevel, loggers: newLoggers, customLogger: newCustomLogger, }: Configuration) => void;
+export declare const get: (namespace: string) => Logger;
+export {};

package/logger/index.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.get = exports.configure = void 0;
+const types_1 = require("../types");
+const LogLevel2Console = {
+    [types_1.LogLevel.INACTIVE]: "inactive",
+    [types_1.LogLevel.ERROR]: "error",
+    [types_1.LogLevel.WARN]: "warn",
+    [types_1.LogLevel.INFO]: "info",
+    [types_1.LogLevel.DEBUG]: "debug",
+    [types_1.LogLevel.TRACE]: "info",
+};
+let logLevel = types_1.LogLevel.INACTIVE;
+let loggers;
+let customLogger;
+const configure = ({ logLevel: newLogLevel, loggers: newLoggers, customLogger: newCustomLogger, }) => {
+    if (newLogLevel) {
+        logLevel = newLogLevel;
+    }
+    if (newLoggers === "RESET") {
+        loggers = undefined;
+    }
+    else if (newLoggers) {
+        loggers = newLoggers;
+    }
+    if (newCustomLogger === "RESET") {
+        customLogger = undefined;
+    }
+    else if (newCustomLogger) {
+        customLogger = newCustomLogger;
+    }
+};
+exports.configure = configure;
+const logMessage = (namespace, level) => (...args) => {
+    if (level <= logLevel && (loggers ? loggers.test(namespace) : true)) {
+        // @ts-expect-error ts(7053)
+        // eslint-disable-next-line
+        customLogger?.[LogLevel2Console[level]]
+            ? // @ts-expect-error ts(7053)
+                customLogger[LogLevel2Console[level]](...args)
+            : // @ts-expect-error ts(7053)
+                // eslint-disable-next-line
+                console[LogLevel2Console[level]](...[
+                    `[${namespace}:${level === types_1.LogLevel.TRACE ? "trace" : LogLevel2Console[level]}:${new Date().toISOString()}] ${args[0]}`,
+                    ...args.slice(1),
+                ]);
+    }
+};
+const get = (namespace) => {
+    return {
+        output: customLogger?.output
+            ? customLogger.output
+            : // eslint-disable-next-line
+                (...args) => console.log(...args),
+        error: logMessage(namespace, types_1.LogLevel.ERROR),
+        warn: logMessage(namespace, types_1.LogLevel.WARN),
+        info: logMessage(namespace, types_1.LogLevel.INFO),
+        log: logMessage(namespace, types_1.LogLevel.INFO),
+        debug: logMessage(namespace, types_1.LogLevel.DEBUG),
+        trace: logMessage(namespace, types_1.LogLevel.TRACE),
+    };
+};
+exports.get = get;

package/module.d.ts

@@ -0,0 +1,4 @@
+import { PasscodeFunction } from "./commands/handler/authentication/passcode/types";
+import { Configuration as LoggerConfiguration } from "./logger";
+export { getCommands } from "./dwc/dwc";
+export declare const configure: (logger?: LoggerConfiguration, passcodeFunction?: PasscodeFunction) => void;

package/module.js

@@ -0,0 +1,45 @@
+"use strict";
+/* eslint-disable import/first */
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configure = exports.getCommands = void 0;
+const dotenv = __importStar(require("dotenv"));
+const configureLoggers_1 = require("./configureLoggers");
+dotenv.config();
+(0, configureLoggers_1.configureLoggers)();
+const config_1 = require("./config");
+const constants_1 = require("./constants");
+const logger_1 = require("./logger");
+var dwc_1 = require("./dwc/dwc");
+Object.defineProperty(exports, "getCommands", { enumerable: true, get: function () { return dwc_1.getCommands; } });
+const configure = (logger, passcodeFunction) => {
+    if (logger) {
+        (0, logger_1.configure)(logger);
+    }
+    if (passcodeFunction) {
+        (0, config_1.set)({ [constants_1.CONFIG_PASSCODE_FUNCTION]: passcodeFunction });
+    }
+};
+exports.configure = configure;

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@sap/cli-core",
+  "version": "2023.12.0",
+  "description": "Command-Line Interface (CLI) Core Module",
+  "license": "SEE LICENSE IN LICENSE",
+  "author": "SAP SE",
+  "homepage": "https://www.sap.com",
+  "main": "index.js",
+  "engines": {
+    "node": "^16",
+    "npm": "^8"
+  },
+  "keywords": [
+    "cli",
+    "sap data warehouse cloud",
+    "cli-core"
+  ],
+  "dependencies": {
+    "ajv": "8.12.0",
+    "axios": "1.4.0",
+    "commander": "10.0.1",
+    "config": "3.3.9",
+    "dotenv": "16.0.3",
+    "fs-extra": "11.1.1",
+    "https": "1.0.0",
+    "lodash": "4.17.21",
+    "open": "8.4.2",
+    "path": "0.12.7",
+    "prompts": "2.4.2",
+    "qs": "6.11.1"
+  }
+}

package/result/ResultHandlerFactory.d.ts

@@ -0,0 +1,6 @@
+import { ResultHandler } from "./types";
+export declare class ResultHandlerFactory {
+    private static INSTANCE;
+    static get(): ResultHandler;
+    static set(instance: ResultHandler): void;
+}

package/result/ResultHandlerFactory.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResultHandlerFactory = void 0;
+class ResultHandlerFactory {
+    static get() {
+        return ResultHandlerFactory.INSTANCE;
+    }
+    static set(instance) {
+        ResultHandlerFactory.INSTANCE = instance;
+    }
+}
+exports.ResultHandlerFactory = ResultHandlerFactory;

package/result/ResultHandlerImpl.d.ts

@@ -0,0 +1,6 @@
+import { ResultHandler } from "./types";
+export declare class ResultHandlerImpl implements ResultHandler {
+    private data;
+    setResult(data: any): void;
+    getResult(): any;
+}

package/result/ResultHandlerImpl.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResultHandlerImpl = void 0;
+class ResultHandlerImpl {
+    setResult(data) {
+        this.data = data;
+    }
+    getResult() {
+        return this.data;
+    }
+}
+exports.ResultHandlerImpl = ResultHandlerImpl;

package/result/types.d.ts

@@ -0,0 +1,4 @@
+export interface ResultHandler {
+    setResult(data: any): void;
+    getResult(): any;
+}

package/result/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });