@sap/cli-core 2023.12.0

package/schemas/discovery.json

@@ -0,0 +1,347 @@
+{
+  "$async": true,
+  "$id": "https://www.sap.com/products/data-warehouse-cloud/cli/schemas/discovery.json",
+  "title": "Command-Line Interface Commands",
+  "description": "This document describes the schema for the discovery document command-line interfaces.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "openapi": {
+      "const": "3.0.3"
+    },
+    "info": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "title": {
+          "type": "string"
+        },
+        "description": {
+          "type": "string"
+        },
+        "contact": {
+          "$ref": "#/$defs/reference"
+        },
+        "license": {
+          "$ref": "#/$defs/reference"
+        },
+        "version": {
+          "type": "string",
+          "pattern": "^[0-9]{1,4}\\.[0-9]{1,2}(\\.[0-9]{1,2})?$"
+        },
+        "x-document-version": {
+          "type": "string",
+          "pattern": "^[0-9]{1,4}\\.[0-9]{1,2}(\\.[0-9]{1,2})?$"
+        }
+      },
+      "required": [
+        "title",
+        "description",
+        "contact",
+        "license",
+        "version",
+        "x-document-version"
+      ]
+    },
+    "tags": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "name": {
+            "$ref": "#/$defs/lowercaseString"
+          },
+          "description": {
+            "$ref": "#/$defs/text"
+          }
+        },
+        "required": ["name", "description"]
+      }
+    },
+    "externalDocs": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "description": {
+          "type": "string"
+        },
+        "url": {
+          "type": "string"
+        }
+      },
+      "required": ["description", "url"]
+    },
+    "paths": {
+      "type": "object",
+      "minProperties": 1,
+      "patternProperties": {
+        "^[a-z/0-9]*$": {
+          "type": "object",
+          "minProperties": 1,
+          "patternProperties": {
+            "^(post|put|get|delete|patch|head)$": {
+              "type": "object",
+              "additionalProperties": true,
+              "properties": {
+                "operationId": {
+                  "$ref": "#/$defs/lowercaseString"
+                },
+                "summary": {
+                  "type": "string"
+                },
+                "description": {
+                  "type": "string"
+                },
+                "x-requestbody-fileonly": {
+                  "type": "boolean"
+                },
+                "x-user-to-confirm": {
+                  "type": "string"
+                },
+                "x-read-command": {
+                  "type": "string"
+                },
+                "parameters": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/$defs/parameters"
+                  }
+                },
+                "requestBody": {
+                  "type": "object",
+                  "additionalProperties": true,
+                  "properties": {
+                    "description": {
+                      "type": "string"
+                    },
+                    "content": {
+                      "oneOf": [
+                        {
+                          "$ref": "#/$defs/SingleContentType"
+                        },
+                        {
+                          "$ref": "#/$defs/MultipleContentTypesIncludingCommands"
+                        }
+                      ]
+                    }
+                  },
+                  "required": ["description", "content", "required"]
+                },
+                "responses": {
+                  "type": "object",
+                  "minProperties": 1,
+                  "patternProperties": {
+                    "^[2-5][0-9]{2}$": {
+                      "oneOf": [
+                        {
+                          "$ref": "#/$defs/component"
+                        },
+                        {
+                          "type": "object",
+                          "properties": {
+                            "description": {
+                              "type": "string"
+                            }
+                          },
+                          "required": ["description"]
+                        }
+                      ]
+                    }
+                  }
+                }
+              },
+              "required": ["operationId", "responses"]
+            }
+          }
+        }
+      }
+    },
+    "components": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "schemas": {
+          "type": "object",
+          "patternProperties": {
+            ".*": {}
+          }
+        },
+        "parameters": {
+          "type": "object",
+          "patternProperties": {
+            ".*": {
+              "$ref": "#/$defs/parameters"
+            }
+          }
+        }
+      }
+    }
+  },
+  "required": [
+    "openapi",
+    "info",
+    "tags",
+    "externalDocs",
+    "paths",
+    "components"
+  ],
+  "$defs": {
+    "SingleContentType": {
+      "type": "object",
+      "additionalProperties": true,
+      "minProperties": 1,
+      "maxProperties": 1,
+      "patternProperties": {
+        "^application/[a-z.+;=0-9]*": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "schema": {
+              "type": "object",
+              "additionalProperties": false,
+              "properties": {
+                "$ref": {
+                  "type": "string"
+                }
+              },
+              "required": ["$ref"]
+            }
+          },
+          "required": ["schema"]
+        }
+      }
+    },
+    "MultipleContentTypesIncludingCommands": {
+      "type": "object",
+      "additionalProperties": true,
+      "minProperties": 1,
+      "patternProperties": {
+        "^application/[a-z.+;=0-9]*": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "x-command": {
+              "type": "string"
+            },
+            "schema": {
+              "type": "object",
+              "additionalProperties": false,
+              "properties": {
+                "$ref": {
+                  "type": "string"
+                }
+              },
+              "required": ["$ref"]
+            }
+          },
+          "required": ["schema", "x-command"]
+        }
+      }
+    },
+    "parameters": {
+      "oneOf": [
+        {
+          "$ref": "#/$defs/component"
+        },
+        {
+          "$ref": "#/$defs/parameter"
+        }
+      ]
+    },
+    "parameter": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "in": {
+          "type": "string",
+          "enum": ["query", "header", "path"]
+        },
+        "description": {
+          "type": "string"
+        },
+        "required": {
+          "type": "boolean"
+        },
+        "allowEmptyValue": {
+          "type": "boolean"
+        },
+        "schema": {
+          "oneOf": [
+            {
+              "$ref": "#/$defs/component"
+            },
+            {
+              "type": "object",
+              "additionalProperties": false,
+              "properties": {
+                "oneOf": {
+                  "type": "array",
+                  "minItems": 1,
+                  "maxItems": 2,
+                  "items": {
+                    "oneOf": [
+                      {
+                        "$ref": "#/$defs/component"
+                      },
+                      {
+                        "$ref": "#/$defs/scalarType"
+                      }
+                    ]
+                  }
+                }
+              },
+              "required": ["oneOf"]
+            },
+            {
+              "$ref": "#/$defs/scalarType"
+            }
+          ]
+        }
+      },
+      "required": ["name", "in", "description", "schema"]
+    },
+    "scalarType": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "enum": ["boolean", "string", "number"]
+        }
+      },
+      "required": ["type"]
+    },
+    "component": {
+      "type": "object",
+      "properties": {
+        "$ref": {
+          "type": "string"
+        }
+      },
+      "required": ["$ref"]
+    },
+    "text": {
+      "type": "string",
+      "pattern": "^[a-zA-Z\\s]*$"
+    },
+    "lowercaseString": {
+      "type": "string",
+      "pattern": "^[a-z\\s-]*$"
+    },
+    "reference": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "url": {
+          "type": "string"
+        }
+      },
+      "required": ["name", "url"]
+    }
+  }
+}

package/settings/index.d.ts

@@ -0,0 +1,4 @@
+import { KeyValuePair } from "../types";
+export declare const get: () => Promise<KeyValuePair>;
+export declare const set: (key: string, value: string) => Promise<void>;
+export declare const remove: (key: string) => Promise<void>;

package/settings/index.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.remove = exports.set = exports.get = void 0;
+const cache_1 = require("../cache");
+const logger_1 = require("../logger");
+const SETTINGS_FILE = "settings.json";
+const getLogger = () => (0, logger_1.get)("settings");
+const get = async () => {
+    try {
+        return JSON.parse(await (0, cache_1.readFile)(SETTINGS_FILE));
+    }
+    catch (err) {
+        const { debug } = getLogger();
+        debug("failed to read settings file", err);
+        return {};
+    }
+};
+exports.get = get;
+const set = async (key, value) => {
+    const settings = await (0, exports.get)();
+    settings[key] = value;
+    await (0, cache_1.writeFile)(SETTINGS_FILE, JSON.stringify(settings));
+    const { debug } = getLogger();
+    debug(`updated key ${key}, value ${value}`);
+};
+exports.set = set;
+const remove = async (key) => {
+    const settings = await (0, exports.get)();
+    delete settings[key];
+    await (0, cache_1.writeFile)(SETTINGS_FILE, JSON.stringify(settings));
+    const { debug } = getLogger();
+    debug(`removed key ${key}`);
+};
+exports.remove = remove;

package/types.d.ts

@@ -0,0 +1,182 @@
+import { Method as HTTPMethod, AxiosRequestConfig as HTTPConfig, AxiosResponse as HTTPResponse } from "axios";
+import { Command as CommandType } from "commander";
+export type Secrets = {
+    client_id: string;
+    client_secret: string;
+    access_token: string;
+    expires_in: number;
+    expires_after: number;
+    refresh_token: string;
+    token_url: string;
+    authorization_url: string;
+    token_type: string;
+    jti: string;
+    scope: string;
+    id_token: string;
+};
+export { HTTPMethod, HTTPConfig, HTTPResponse };
+export type In = "query" | "body" | "header" | "path";
+export type DataType = "boolean" | "string" | "number";
+export type ParameterMapping = {
+    name: string;
+    in: In;
+    source: {
+        type: "option";
+        name: string;
+        dataType: DataType;
+    } | {
+        type: "value";
+        value: any;
+    };
+};
+export type ParameterMappings = Array<ParameterMapping>;
+export declare enum LogLevel {
+    INACTIVE = 1,
+    ERROR = 2,
+    WARN = 3,
+    INFO = 4,
+    DEBUG = 5,
+    TRACE = 6
+}
+export type JSONOneOf<T> = {
+    oneOf: Array<T | JSONReference>;
+};
+export type JSONObject = {
+    type: "object";
+    description?: string;
+    properties: {
+        [key: string]: JSONSchema;
+    };
+    required?: Array<string>;
+};
+export type JSONSimpleType = {
+    type: DataType;
+    description?: string;
+    enum?: Array<boolean | string | number>;
+    default?: boolean | string | number;
+};
+export type JSONReference = {
+    $ref: string;
+};
+// @ts-expect-error Type alias 'Schema' circularly references itself.ts(2456)
+export type JSONSchema = JSONObject | JSONSimpleType | JSONReference | JSONOneOf<JSONSchema>;
+export type Parameter = {
+    name: string;
+    in: In;
+    description: string;
+    required?: boolean;
+    allowEmptyValue?: boolean;
+    schema: JSONSchema;
+};
+export type Operation = {
+    operationId: string;
+    parameters?: Array<JSONReference | Parameter>;
+    summary?: string;
+    description?: string;
+    "x-requestbody-fileonly"?: boolean;
+    "x-user-to-confirm"?: string;
+    "x-read-path"?: string;
+    requestBody?: {
+        description: string;
+        content: {
+            [contentType: string]: {
+                schema: JSONSchema | JSONReference;
+            };
+        };
+        required?: boolean;
+    };
+    responses?: {
+        [httpStatusCode: number]: unknown;
+    };
+};
+export type HTTPMethodPath = {
+    [method in HTTPMethod]?: Operation;
+};
+export type Parameters = Array<Parameter | JSONReference>;
+export type ParameterPath = {
+    parameters?: Parameters;
+};
+export type Discovery = {
+    openapi: string;
+    info: {
+        ["x-document-version"]: string;
+        version: string;
+    };
+    tags: Array<{
+        name: string;
+        description: string;
+    }>;
+    paths: {
+        [path: string]: HTTPMethodPath | ParameterPath;
+    };
+    components?: {
+        parameters?: {
+            [parameter: string]: Parameter;
+        };
+        schemas?: {
+            [schema: string]: JSONSchema;
+        };
+    };
+};
+export declare const CHARACTERS: string[];
+export type PackageJson = {
+    name: string;
+    description: string;
+    version: string;
+    bin?: {
+        [key: string]: string;
+    };
+};
+export type DiscoveryMetadata = {
+    tenant: string;
+    addedAt: number;
+};
+export type KeyValuePair = {
+    [key: string]: any;
+};
+export type Option = {
+    longName: string;
+    description: string;
+    default?: string;
+    required?: boolean;
+    choices?: Array<string>;
+    args?: Array<{
+        name: string;
+        optional?: boolean;
+    }>;
+    prompts?: {
+        initial?: any;
+        message: string | (() => string);
+        type: "confirm" | "text" | "password" | "multiselect" | "number" | "select";
+        inputValidator?: (value: any) => boolean;
+    };
+};
+export type HandlerProps = {
+    command: string;
+    args: KeyValuePair;
+    options: KeyValuePair;
+};
+export type CommanderHandler = (...args: any[]) => void | Promise<void>;
+export type Handler = (command: CommandType) => CommanderHandler;
+export type CommandsArgument = {
+    argument: string;
+    description: string;
+};
+export type TopCommand = {
+    type: "topCommand";
+    command: string;
+    description: string;
+    subCommands: Array<Command>;
+    options?: Array<Option>;
+};
+export type LeafCommand = {
+    type: "command";
+    command: string;
+    description: string;
+    options?: Array<Option>;
+    args?: Array<CommandsArgument>;
+    handler: Handler;
+};
+export type Command = TopCommand | LeafCommand;
+export type AddCommands = (program: CommandType) => Promise<void>;
+export type ResponsePostProcessor = (response: HTTPResponse) => Promise<void>;

package/types.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CHARACTERS = exports.LogLevel = void 0;
+var LogLevel;
+(function (LogLevel) {
+    LogLevel[LogLevel["INACTIVE"] = 1] = "INACTIVE";
+    LogLevel[LogLevel["ERROR"] = 2] = "ERROR";
+    LogLevel[LogLevel["WARN"] = 3] = "WARN";
+    LogLevel[LogLevel["INFO"] = 4] = "INFO";
+    LogLevel[LogLevel["DEBUG"] = 5] = "DEBUG";
+    LogLevel[LogLevel["TRACE"] = 6] = "TRACE";
+})(LogLevel = exports.LogLevel || (exports.LogLevel = {}));
+/* jscpd:ignore-start */
+exports.CHARACTERS = [
+    "a",
+    "b",
+    "c",
+    "d",
+    "e",
+    "f",
+    "g",
+    "h",
+    "i",
+    "j",
+    "k",
+    "l",
+    "m",
+    "n",
+    "o",
+    "p",
+    "q",
+    "r",
+    "s",
+    "t",
+    "u",
+    "v",
+    "w",
+    "x",
+    "y",
+    "z",
+    "A",
+    "B",
+    "C",
+    "D",
+    "E",
+    "F",
+    "G",
+    "H",
+    "I",
+    "J",
+    "K",
+    "L",
+    "M",
+    "N",
+    "O",
+    "P",
+    "Q",
+    "R",
+    "S",
+    "T",
+    "U",
+    "V",
+    "W",
+    "X",
+    "Y",
+    "Z",
+];

package/utils/commands.d.ts

@@ -0,0 +1,8 @@
+import commander, { Command, Option } from "commander";
+import { Command as CommandType, Option as OptionType } from "../types";
+export declare const createCommand: (name?: string) => Command;
+export declare const getShortFlagForLongName: (longName: string) => string;
+export declare const isOptionAlreadyRegistered: ({ longName }: OptionType, command: Command) => boolean;
+export declare const registerLongName: (longName: string) => string;
+export declare const buildOption: ({ longName, description, choices, required, default: defaultValue, args, }: OptionType) => Option;
+export declare const buildCommand: (topCommand: commander.Command, command: CommandType) => void;