@sap/cli-core 2023.12.0

package/commands/passcode.command.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addCommands = void 0;
+const config_1 = require("../config");
+const core_1 = require("../config/core");
+const constants_1 = require("../constants");
+const logger_1 = require("../logger");
+const commands_1 = require("../utils/commands");
+const handler_1 = require("./handler");
+const passcode = () => async () => {
+    const { output } = (0, logger_1.get)("commands.passcode");
+    const config = (0, config_1.get)();
+    output(config.passcodeUrl);
+};
+const passcodeCommand = {
+    type: "command",
+    command: "passcode-url",
+    description: "display the passcode url",
+    handler: (0, handler_1.createNextHandler)((0, handler_1.createParseArgumentsHandler)(), (0, handler_1.createMandatoryOptionsHandler)(), passcode),
+};
+const addCommands = async (program) => {
+    if ((0, core_1.getAuthenticationMethods)().includes(constants_1.AuthenticationMethod.passcode)) {
+        (0, commands_1.buildCommand)(program, passcodeCommand);
+    }
+};
+exports.addCommands = addCommands;

package/commands/secrets.command/index.d.ts

@@ -0,0 +1,3 @@
+import { TopCommand } from "../../types";
+declare const secretsCommand: TopCommand;
+export default secretsCommand;

package/commands/secrets.command/index.js

@@ -0,0 +1,13 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const show_command_1 = __importDefault(require("./show.command"));
+const secretsCommand = {
+    type: "topCommand",
+    command: "secrets",
+    description: "work with the locally stored secrets",
+    subCommands: [show_command_1.default],
+};
+exports.default = secretsCommand;

package/commands/secrets.command/show.command.d.ts

@@ -0,0 +1,3 @@
+import { Command } from "../../types";
+declare const showCommand: Command;
+export default showCommand;

package/commands/secrets.command/show.command.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const logger_1 = require("../../logger");
+const handler_1 = require("../handler");
+const cache_1 = require("../handler/authentication/oauth/secretsProvider/cache");
+const utils_1 = require("../handler/authentication/oauth/utils");
+const showSecrets = () => async () => {
+    const { output, error } = (0, logger_1.get)("commands.secrets-show");
+    try {
+        const secrets = (0, utils_1.getSecrets)();
+        output(JSON.stringify(secrets, null, 2));
+    }
+    catch (err) {
+        error("failed to read secrets", err);
+        output("No secrets exist");
+        throw new Error("failed to read secrets");
+    }
+};
+const showCommand = {
+    type: "command",
+    command: "show",
+    description: "display locally stored secrets for interactive OAuth authentication",
+    handler: (0, handler_1.createNextHandler)((0, handler_1.createParseArgumentsHandler)(), (0, handler_1.createResilientHandler)((0, cache_1.create)()), showSecrets),
+};
+exports.default = showCommand;

package/config/core.d.ts

@@ -0,0 +1,10 @@
+import { AuthenticationMethod } from "../constants";
+export declare const getName: () => string;
+export declare const getPackageName: () => string;
+export declare const getDescription: () => string;
+export declare const getDiscoveryPath: () => string;
+export declare const getSapHelp: () => string;
+export declare const getAuthenticationMethods: () => Array<AuthenticationMethod>;
+export declare const getVersion: () => string;
+export declare const isDeprecated: () => boolean;
+export declare const getDeprecationMessage: () => string | undefined;

package/config/core.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDeprecationMessage = exports.isDeprecated = exports.getVersion = exports.getAuthenticationMethods = exports.getSapHelp = exports.getDiscoveryPath = exports.getDescription = exports.getPackageName = exports.getName = void 0;
+const constants_1 = require("../constants");
+const index_1 = require("./index");
+const getName = () => (0, index_1.get)()[constants_1.CLI_NAME];
+exports.getName = getName;
+const getPackageName = () => (0, index_1.get)()[constants_1.CLI_PACKAGE_NAME];
+exports.getPackageName = getPackageName;
+const getDescription = () => (0, index_1.get)()[constants_1.CLI_DESCRIPTION];
+exports.getDescription = getDescription;
+const getDiscoveryPath = () => (0, index_1.get)()[constants_1.CLI_DISCOVERY_PATH];
+exports.getDiscoveryPath = getDiscoveryPath;
+const getSapHelp = () => (0, index_1.get)()[constants_1.CLI_SAP_HELP];
+exports.getSapHelp = getSapHelp;
+const getAuthenticationMethods = () => (0, index_1.get)()[constants_1.CLI_SUPPORTED_AUTHENTICATION_METHODS];
+exports.getAuthenticationMethods = getAuthenticationMethods;
+const getVersion = () => (0, index_1.get)()[constants_1.CLI_VERSION];
+exports.getVersion = getVersion;
+const isDeprecated = () => (0, index_1.get)()[constants_1.CLI_DEPRECATED] || false;
+exports.isDeprecated = isDeprecated;
+const getDeprecationMessage = () => (0, index_1.get)()[constants_1.CLI_DEPRECATION_MESSAGE];
+exports.getDeprecationMessage = getDeprecationMessage;

package/config/index.d.ts

@@ -0,0 +1,5 @@
+import { KeyValuePair } from "../types";
+export declare const initialize: () => void;
+export declare const setCustomConfig: () => void;
+export declare const set: (c: KeyValuePair) => void;
+export declare const get: () => KeyValuePair;

package/config/index.js

@@ -0,0 +1,90 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.get = exports.set = exports.setCustomConfig = exports.initialize = void 0;
+const lodash_1 = __importDefault(require("lodash"));
+const config_1 = __importDefault(require("config"));
+const logger_1 = require("../logger");
+const utils_1 = require("../utils/utils");
+const constants_1 = require("../constants");
+const CUSTOM_HOST = "tenant.host";
+const CUSTOM_PASSCODE_URL = "tenant.passcodeUrl";
+const CUSTOM_PUBLIC_FQDN = "tenant.publicfqdn";
+let config;
+const CONFIGS_TO_KEEP = [
+    constants_1.CONFIG_PASSCODE_FUNCTION,
+    constants_1.CLI_DESCRIPTION,
+    constants_1.CLI_DISCOVERY_PATH,
+    constants_1.CLI_NAME,
+    constants_1.CLI_PACKAGE_NAME,
+    constants_1.CLI_SAP_HELP,
+    constants_1.CLI_SUPPORTED_AUTHENTICATION_METHODS,
+    constants_1.CLI_VERSION,
+    constants_1.CLI_DEPRECATED,
+    constants_1.CLI_DEPRECATION_MESSAGE,
+];
+const initialize = () => {
+    const keep = {};
+    for (const keepConfig of CONFIGS_TO_KEEP) {
+        keep[keepConfig] = config?.[keepConfig];
+    }
+    config = {};
+    for (const keepConfig of CONFIGS_TO_KEEP) {
+        if (keep[keepConfig]) {
+            config[keepConfig] = keep[keepConfig];
+        }
+    }
+};
+exports.initialize = initialize;
+(0, exports.initialize)();
+const getLogger = () => (0, logger_1.get)("config");
+const setCustomConfig = () => {
+    const { trace, debug } = getLogger();
+    debug("setting custom configuration");
+    const sources = config_1.default.util.getConfigSources();
+    trace("config.custom.getConfigSources", JSON.stringify(sources, null, 2));
+    trace("config.custom.NODE_CONFIG_DIR", config_1.default.util.getEnv("NODE_CONFIG_DIR"));
+    trace("config.custom.NODE_ENV", config_1.default.util.getEnv("NODE_ENV"));
+    trace("config.custom.NODE_CONFIG", JSON.stringify(config_1.default.util.getEnv("NODE_CONFIG"), null, 2));
+    trace("config.custom.HOSTNAME", config_1.default.util.getEnv("HOSTNAME"));
+    trace("config.custom.NODE_APP_INSTANCE", config_1.default.util.getEnv("NODE_APP_INSTANCE"));
+    if (config_1.default.has(CUSTOM_HOST)) {
+        config.host = config_1.default.get(CUSTOM_HOST);
+        config.hostSetFromCustomConfig = true;
+    }
+    if (config_1.default.has(CUSTOM_PASSCODE_URL)) {
+        config.passcodeUrl = config_1.default.get(CUSTOM_PASSCODE_URL);
+    }
+    if (config_1.default.has(CUSTOM_PUBLIC_FQDN)) {
+        config.publicfqdn = (0, utils_1.parseTenant)(config_1.default.get(CUSTOM_PUBLIC_FQDN));
+    }
+};
+exports.setCustomConfig = setCustomConfig;
+(0, exports.setCustomConfig)();
+const setTenant = (tenant) => {
+    const info = (0, utils_1.getInfoFromTenant)(tenant, config.verbose);
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    (0, exports.set)({ ...info, newTenant: tenant });
+};
+const set = (c) => {
+    const { trace } = getLogger();
+    const prev = JSON.parse(JSON.stringify(config));
+    if (c.tenant) {
+        setTenant(c.tenant);
+    }
+    else {
+        config = lodash_1.default.merge(config, c);
+        if (config.newTenant) {
+            config.tenant = config.newTenant;
+            delete config.newTenant;
+        }
+        if (!lodash_1.default.isEqual(prev, config)) {
+            trace("configuration changed. previous: %s, current: %s", JSON.stringify(prev), JSON.stringify(config));
+        }
+    }
+};
+exports.set = set;
+const get = () => config;
+exports.get = get;

package/configureLoggers.d.ts

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

package/configureLoggers.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configureLoggers = void 0;
+const logger_1 = require("./logger");
+const configureLoggers = () => (0, logger_1.configure)({
+    logLevel: process.env.LOG_LEVEL
+        ? parseInt(process.env.LOG_LEVEL, 10)
+        : undefined,
+    loggers: process.env.LOGGERS ? new RegExp(process.env.LOGGERS) : undefined,
+});
+exports.configureLoggers = configureLoggers;

package/constants.d.ts

@@ -0,0 +1,43 @@
+import { Option } from "./types";
+export declare const VERSION: string;
+export declare const DISCOVERY_DOCUMENT_PREFIX = "discovery-";
+export declare enum AuthenticationMethod {
+    oauth = "oauth",
+    passcode = "passcode"
+}
+export declare const CLI_NAME = "cli-name";
+export declare const CLI_PACKAGE_NAME = "cli-package-name";
+export declare const CLI_DESCRIPTION = "cli-description";
+export declare const CLI_DISCOVERY_PATH = "cli-discovery-path";
+export declare const CLI_SAP_HELP = "cli-sap-help";
+export declare const CLI_VERSION = "cli-version";
+export declare const CLI_DEPRECATED = "cli-deprecated";
+export declare const CLI_DEPRECATION_MESSAGE = "cli-deprecation-message";
+export declare const CLI_SUPPORTED_AUTHENTICATION_METHODS = "cli-supported-authentication-methods";
+export declare const SEGMENTS_TO_REMOVE_FOR_PASSCODE_AUTH: string[];
+export declare const DISCOVERY_METADATA_PATH = "discovery-metadata.json";
+export declare const X_CSRF_TOKEN = "x-csrf-token";
+export declare const PATH_TO_SUCCESS_HTML: string;
+export declare const PATH_TO_ERROR_HTML: string;
+export declare const CACHE_SECRETS_FILE = "secrets.json";
+export declare const OPTION_VERSION: Option;
+export declare const OPTION_HELP: Option;
+export declare const OPTION_HOST: Option;
+export declare const OPTION_OUTPUT: Option;
+export declare const OPTION_PRETTY: Option;
+export declare const OPTION_VERBOSE: Option;
+export declare const OPTION_FORCE: Option;
+export declare const OPTION_CLIENT_ID: Option;
+export declare const OPTION_CLIENT_SECRET: Option;
+export declare const OPTION_AUTHORIZATION_URL: Option;
+export declare const OPTION_TOKEN_URL: Option;
+export declare const OPTION_ACCESS_TOKEN: Option;
+export declare const OPTION_REFRESH_TOKEN: Option;
+export declare const OPTION_EXPIRES_IN: Option;
+export declare const OPTION_SECRETS_FILE: Option;
+export declare const OPTION_CODE: Option;
+export declare const OPTION_PASSCODE: Option;
+export declare const CONFIG_PASSCODE_FUNCTION = "passcodeFunction";
+export declare const OPTION_OPTIONS_FILE: Option;
+export declare const OPTION_FILE_PATH: Option;
+export declare const OPTION_INPUT: Option;

package/constants.js

@@ -0,0 +1,175 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OPTION_INPUT = exports.OPTION_FILE_PATH = exports.OPTION_OPTIONS_FILE = exports.CONFIG_PASSCODE_FUNCTION = exports.OPTION_PASSCODE = exports.OPTION_CODE = exports.OPTION_SECRETS_FILE = exports.OPTION_EXPIRES_IN = exports.OPTION_REFRESH_TOKEN = exports.OPTION_ACCESS_TOKEN = exports.OPTION_TOKEN_URL = exports.OPTION_AUTHORIZATION_URL = exports.OPTION_CLIENT_SECRET = exports.OPTION_CLIENT_ID = exports.OPTION_FORCE = exports.OPTION_VERBOSE = exports.OPTION_PRETTY = exports.OPTION_OUTPUT = exports.OPTION_HOST = exports.OPTION_HELP = exports.OPTION_VERSION = exports.CACHE_SECRETS_FILE = exports.PATH_TO_ERROR_HTML = exports.PATH_TO_SUCCESS_HTML = exports.X_CSRF_TOKEN = exports.DISCOVERY_METADATA_PATH = exports.SEGMENTS_TO_REMOVE_FOR_PASSCODE_AUTH = exports.CLI_SUPPORTED_AUTHENTICATION_METHODS = exports.CLI_DEPRECATION_MESSAGE = exports.CLI_DEPRECATED = exports.CLI_VERSION = exports.CLI_SAP_HELP = exports.CLI_DISCOVERY_PATH = exports.CLI_DESCRIPTION = exports.CLI_PACKAGE_NAME = exports.CLI_NAME = exports.AuthenticationMethod = exports.DISCOVERY_DOCUMENT_PREFIX = exports.VERSION = void 0;
+const path_1 = __importDefault(require("path"));
+const utils_1 = require("./utils/utils");
+exports.VERSION = (0, utils_1.getVersion)();
+exports.DISCOVERY_DOCUMENT_PREFIX = "discovery-";
+var AuthenticationMethod;
+(function (AuthenticationMethod) {
+    AuthenticationMethod["oauth"] = "oauth";
+    AuthenticationMethod["passcode"] = "passcode";
+})(AuthenticationMethod = exports.AuthenticationMethod || (exports.AuthenticationMethod = {}));
+exports.CLI_NAME = "cli-name";
+exports.CLI_PACKAGE_NAME = "cli-package-name";
+exports.CLI_DESCRIPTION = "cli-description";
+exports.CLI_DISCOVERY_PATH = "cli-discovery-path";
+exports.CLI_SAP_HELP = "cli-sap-help";
+exports.CLI_VERSION = "cli-version";
+exports.CLI_DEPRECATED = "cli-deprecated";
+exports.CLI_DEPRECATION_MESSAGE = "cli-deprecation-message";
+exports.CLI_SUPPORTED_AUTHENTICATION_METHODS = "cli-supported-authentication-methods";
+exports.SEGMENTS_TO_REMOVE_FOR_PASSCODE_AUTH = ["dwaas-core"];
+exports.DISCOVERY_METADATA_PATH = "discovery-metadata.json";
+exports.X_CSRF_TOKEN = "x-csrf-token";
+exports.PATH_TO_SUCCESS_HTML = path_1.default.join(__dirname, "assets", "success.html");
+exports.PATH_TO_ERROR_HTML = path_1.default.join(__dirname, "assets", "error.html");
+exports.CACHE_SECRETS_FILE = "secrets.json";
+exports.OPTION_VERSION = {
+    longName: "version",
+    description: "print version",
+};
+exports.OPTION_HELP = {
+    longName: "help",
+    description: "print help for a command",
+    args: [{ name: "command" }],
+};
+exports.OPTION_HOST = {
+    longName: "host",
+    description: "specifies the url where the tenant is hosted",
+    args: [{ name: "host" }],
+    prompts: {
+        message: "URL of the SAP Data Warehouse Cloud system to connect to:",
+        type: "text",
+    },
+};
+exports.OPTION_OUTPUT = {
+    longName: "output",
+    description: "specifies the file to store the output of the command",
+    args: [{ name: "output" }],
+};
+exports.OPTION_PRETTY = {
+    longName: "pretty",
+    description: "pretty-formats JSON responses",
+};
+exports.OPTION_VERBOSE = {
+    longName: "verbose",
+    description: "print detailed log information to console",
+};
+exports.OPTION_FORCE = {
+    longName: "force",
+    description: "force the command execution",
+};
+exports.OPTION_CLIENT_ID = {
+    longName: "client-id",
+    description: "client id for interactive oauth session authentication",
+    args: [{ name: "id" }],
+    prompts: {
+        type: "text",
+        message: `Please enter your client ID:`,
+    },
+};
+exports.OPTION_CLIENT_SECRET = {
+    longName: "client-secret",
+    description: "client secret for interactive oauth session authentication",
+    args: [{ name: "secret" }],
+    prompts: {
+        type: "password",
+        message: `Please enter your client secret:`,
+    },
+};
+exports.OPTION_AUTHORIZATION_URL = {
+    longName: "authorization-url",
+    description: "authorization url for interactive oauth session authentication",
+    args: [{ name: "url" }],
+    prompts: {
+        type: "text",
+        message: `Please enter your authorization URL:`,
+    },
+};
+exports.OPTION_TOKEN_URL = {
+    longName: "token-url",
+    description: "token url for interactive oauth session authentication",
+    args: [{ name: "url" }],
+    prompts: {
+        type: "text",
+        message: `Please enter your token URL:`,
+    },
+};
+exports.OPTION_ACCESS_TOKEN = {
+    longName: "access-token",
+    description: "access token for interactive oauth session authentication",
+    args: [{ name: "token" }],
+    prompts: {
+        type: "password",
+        message: `Please enter your access token:`,
+    },
+};
+exports.OPTION_REFRESH_TOKEN = {
+    longName: "refresh-token",
+    description: "refresh token for interactive oauth session authentication",
+    args: [{ name: "token" }],
+    prompts: {
+        type: "password",
+        message: `Please enter your refresh token:`,
+    },
+};
+exports.OPTION_EXPIRES_IN = {
+    longName: "expires-in",
+    description: "expires in information for interactive oauth session authentication",
+    args: [{ name: "expires" }],
+    prompts: {
+        type: "number",
+        message: `Please enter a value for expires in:`,
+    },
+};
+exports.OPTION_SECRETS_FILE = {
+    longName: "secrets-file",
+    description: "path to secrets file",
+    args: [{ name: "file" }],
+    prompts: {
+        type: "text",
+        message: `Please enter the path to the secrets file:`,
+    },
+};
+exports.OPTION_CODE = {
+    longName: "code",
+    description: "code for oauth token retrieval",
+    args: [{ name: "code" }],
+    prompts: {
+        type: "text",
+        message: `Please enter the code for retrieving the oauth access_token and refresh_token:`,
+    },
+};
+exports.OPTION_PASSCODE = {
+    longName: "passcode",
+    description: "passcode for interactive session authentication",
+    args: [{ name: "passcode" }],
+};
+exports.CONFIG_PASSCODE_FUNCTION = "passcodeFunction";
+exports.OPTION_OPTIONS_FILE = {
+    longName: "options-file",
+    description: "path to options file",
+    args: [{ name: "file" }],
+};
+exports.OPTION_FILE_PATH = {
+    longName: "file-path",
+    description: "specifies the file to use as input for the command",
+    args: [{ name: "path" }],
+    prompts: {
+        message: "Path to input file:",
+        type: "text",
+    },
+};
+exports.OPTION_INPUT = {
+    longName: "input",
+    description: "specifies input as string to use for the command",
+    args: [{ name: "input" }],
+    prompts: {
+        message: "Input as string:",
+        type: "text",
+    },
+};

package/discovery/index.d.ts

@@ -0,0 +1,10 @@
+import { Discovery, DiscoveryMetadata } from "../types";
+export declare const getPathToDiscoveryDocument: () => string;
+export declare const getMetadata: () => Promise<Array<DiscoveryMetadata>>;
+export declare const addMetadata: ({ tenant, addedAt, }: DiscoveryMetadata) => Promise<void>;
+export declare const clear: () => void;
+export declare const init: () => Promise<Discovery>;
+export declare const compareEtags: () => Promise<boolean>;
+export declare const checkVersion: () => Promise<{
+    status: "UPTODATE" | "OUTDATED";
+}>;

package/discovery/index.js

@@ -0,0 +1,142 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkVersion = exports.compareEtags = exports.init = exports.clear = exports.addMetadata = exports.getMetadata = exports.getPathToDiscoveryDocument = void 0;
+const path_1 = __importDefault(require("path"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const cache_1 = require("../cache");
+const utils_1 = require("./utils");
+const utils_2 = require("../utils/utils");
+const logger_1 = require("../logger");
+const config_1 = require("../config");
+const constants_1 = require("../constants");
+const core_1 = require("../config/core");
+const getLogger = () => (0, logger_1.get)("discovery");
+let initialized = false;
+let document;
+let metadata;
+const getDocumentName = () => {
+    const { trace } = getLogger();
+    const config = (0, config_1.get)();
+    const sha = (0, utils_2.sha256)(`${config.publicfqdn}${(0, core_1.getDiscoveryPath)()}`).replace(/[/\\]/g, "_");
+    const name = `${constants_1.DISCOVERY_DOCUMENT_PREFIX}${sha}.json`;
+    trace(`calculating document name for host ${config.host}, name ${name}`);
+    return name;
+};
+const getPathToDiscoveryDocument = () => (0, cache_1.getPath)(getDocumentName());
+exports.getPathToDiscoveryDocument = getPathToDiscoveryDocument;
+const initMetadata = async () => {
+    const { error } = getLogger();
+    if (!metadata) {
+        try {
+            metadata = JSON.parse(await (0, cache_1.readFile)(constants_1.DISCOVERY_METADATA_PATH));
+        }
+        catch (err) {
+            error("error while reading discovery metadata", err.stack);
+            metadata = [];
+        }
+    }
+};
+const getMetadata = async () => {
+    await initMetadata();
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    return metadata;
+};
+exports.getMetadata = getMetadata;
+const addMetadata = async ({ tenant, addedAt, }) => {
+    await initMetadata();
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    metadata = metadata.filter((t) => t.tenant !== tenant);
+    metadata.push({ tenant, addedAt });
+    await (0, cache_1.writeFile)(constants_1.DISCOVERY_METADATA_PATH, JSON.stringify(metadata));
+};
+exports.addMetadata = addMetadata;
+const clear = () => {
+    initialized = false;
+    document = undefined;
+    metadata = undefined;
+};
+exports.clear = clear;
+/* jscpd:ignore-start */
+const init = async () => {
+    const { trace, error, debug } = getLogger();
+    if (initialized) {
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        return document;
+    }
+    initialized = true;
+    /* jscpd:ignore-end */
+    let schema;
+    try {
+        trace("reading discovery document");
+        const file = await (0, cache_1.readFile)(getDocumentName());
+        document = JSON.parse(file);
+    }
+    catch (err) {
+        error("error while reading discovery document", err.stack);
+        throw err;
+    }
+    try {
+        trace("reading schema document");
+        try {
+            const file = await fs_extra_1.default.readFile(path_1.default.join(__dirname, "..", "..", "schemas", "discovery.json"), "utf-8");
+            schema = JSON.parse(file);
+        }
+        catch (err) {
+            debug("failed reading schema, trying again", err.stack);
+            // path changes after build
+            const file = await fs_extra_1.default.readFile(path_1.default.join(__dirname, "..", "schemas", "discovery.json"), "utf-8");
+            schema = JSON.parse(file);
+        }
+    }
+    catch (err) {
+        error("error while reading schema document", err.stack);
+        throw err;
+    }
+    debug("validating discovery document against schema");
+    const result = await (0, utils_1.validate)(schema, document);
+    if (result.result === "INVALID") {
+        error("discovery document contains invalid data", result.errors);
+        throw new Error("discovery document contains invalid data");
+    }
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    return document;
+};
+exports.init = init;
+const compareEtags = async () => {
+    const { debug, error } = getLogger();
+    try {
+        const doc = await (0, exports.init)();
+        const config = (0, config_1.get)();
+        if (config.etag && doc) {
+            const etag = (0, utils_2.sha256)(JSON.stringify(doc));
+            if (config.etag === etag) {
+                debug("etags match: %s", config.etag);
+                return true;
+            }
+            debug("etags do not match. server: %s, client: %s", config.etag, etag);
+            return false;
+        }
+        debug("etag is not available");
+    }
+    catch (err) {
+        error("failed to compare etags", err.stack);
+    }
+    return true;
+};
+exports.compareEtags = compareEtags;
+const checkVersion = async () => {
+    const { debug } = getLogger();
+    const doc = await (0, exports.init)();
+    const local = (0, utils_2.parseVersion)(constants_1.VERSION);
+    const server = (0, utils_2.parseVersion)(doc.info["x-document-version"]);
+    if (local.major < server.major ||
+        (local.major === server.major && local.minor < server.minor)) {
+        debug(`CLI is outdated (local: ${JSON.stringify(local)}, server: ${JSON.stringify(server)})`);
+        return { status: "OUTDATED" };
+    }
+    return { status: "UPTODATE" };
+};
+exports.checkVersion = checkVersion;

package/discovery/utils.d.ts

@@ -0,0 +1,7 @@
+import { ErrorObject } from "ajv";
+export declare const validate: (schema: string, data: unknown) => Promise<{
+    result: "VALID";
+} | {
+    result: "INVALID";
+    errors: Array<Partial<ErrorObject>>;
+}>;

package/discovery/utils.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validate = void 0;
+const ajv_1 = __importDefault(require("ajv"));
+const logger_1 = require("../logger");
+const validate = async (schema, data) => {
+    const logger = (0, logger_1.get)("jsonschema");
+    try {
+        const ajv = new ajv_1.default({ logger });
+        // use await, see ajv.js.org/api.html#ajv-validate-schemaorref-object-string-data-any-boolean
+        await ajv.validate(schema, data);
+        return {
+            result: "VALID",
+        };
+    }
+    catch (err) {
+        logger.error("error while compiling schema or validating data", err.stack);
+        return {
+            result: "INVALID",
+            errors: err.errors,
+        };
+    }
+};
+exports.validate = validate;

package/dwc/dwc.d.ts

@@ -0,0 +1,10 @@
+export declare const init: () => Promise<void>;
+export declare const executeCommand: (command?: string) => Promise<void>;
+type Options = {
+    [option: string]: string;
+};
+type CommandObject = {
+    [command: string]: (options?: Options) => Promise<void>;
+};
+export declare const getCommands: (host?: string) => Promise<CommandObject>;
+export {};