diff --git a/.gitignore b/.gitignore index aa839715..7934326e 100644 --- a/.gitignore +++ b/.gitignore @@ -106,3 +106,6 @@ mindconnect-nodejs-win.exe # Webstorm .idea + +# markdown-help +markdown-help/** \ No newline at end of file diff --git a/.npmignore b/.npmignore index 532c821f..ef8e8976 100644 --- a/.npmignore +++ b/.npmignore @@ -63,3 +63,6 @@ mindconnect-nodejs-win.exe # Spellchecker files .spelling + +# markdown-help +markdown-help/** \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index c01765c3..5e1e59f1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Changelog +## 3.19.0 - (Dove Vienna) - April 2022 + +- CLI: new `mdsp markdown-help` command to generate markdown help available at [opensource.mindsphere.io](https://opensource.mindsphere.io/docs/mindconnect-nodejs/cli/index.html#tab1anchor2) +- SDK: Data Lake - added support for mindsphere data upload in CN1 (on alibaba cloud) [[#316](https://github.com/mindsphere/mindconnect-nodejs/issues/316)] +- Bumped most depedencies + ## 3.18.2 - (Hazelwood Vienna) - March 2022 - fixed missing date-fns dependency in package.json diff --git a/package-lock.json b/package-lock.json index 8deb3f7e..3213b2e6 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@mindconnect/mindconnect-nodejs", - "version": "3.18.2", + "version": "3.19.0-1", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@mindconnect/mindconnect-nodejs", - "version": "3.18.2", + "version": "3.19.0-1", "license": "MIT", "dependencies": { "ajv": "^8.10.0", @@ -2491,14 +2491,6 @@ "node": ">=0.10.0" } }, - "node_modules/ansi-regex": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", - "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", - "engines": { - "node": ">=8" - } - }, "node_modules/ansi-styles": { "version": "4.2.1", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz", @@ -3318,6 +3310,27 @@ "wrap-ansi": "^7.0.0" } }, + "node_modules/cliui/node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/cliui/node_modules/strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "dev": true, + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, "node_modules/clone": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/clone/-/clone-1.0.4.tgz", @@ -6201,9 +6214,9 @@ } }, "node_modules/minimist": { - "version": "1.2.5", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz", - "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==" + "version": "1.2.6", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.6.tgz", + "integrity": "sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q==" }, "node_modules/mkdirp": { "version": "0.5.5", @@ -6864,6 +6877,25 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/ora/node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "engines": { + "node": ">=8" + } + }, + "node_modules/ora/node_modules/strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, "node_modules/os-homedir": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/os-homedir/-/os-homedir-1.0.2.tgz", @@ -8538,7 +8570,15 @@ "node": ">=8" } }, - "node_modules/strip-ansi": { + "node_modules/string-width/node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "engines": { + "node": ">=8" + } + }, + "node_modules/string-width/node_modules/strip-ansi": { "version": "6.0.1", "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", @@ -9523,6 +9563,25 @@ "url": "https://github.com/chalk/wrap-ansi?sponsor=1" } }, + "node_modules/wrap-ansi/node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "engines": { + "node": ">=8" + } + }, + "node_modules/wrap-ansi/node_modules/strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, "node_modules/wrappy": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", @@ -11466,11 +11525,6 @@ "ansi-wrap": "0.1.0" } }, - "ansi-regex": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", - "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==" - }, "ansi-styles": { "version": "4.2.1", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz", @@ -12100,6 +12154,23 @@ "string-width": "^4.2.0", "strip-ansi": "^6.0.0", "wrap-ansi": "^7.0.0" + }, + "dependencies": { + "ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "dev": true + }, + "strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "dev": true, + "requires": { + "ansi-regex": "^5.0.1" + } + } } }, "clone": { @@ -14351,9 +14422,9 @@ } }, "minimist": { - "version": "1.2.5", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz", - "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==" + "version": "1.2.6", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.6.tgz", + "integrity": "sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q==" }, "mkdirp": { "version": "0.5.5", @@ -14859,6 +14930,21 @@ "log-symbols": "^4.1.0", "strip-ansi": "^6.0.0", "wcwidth": "^1.0.1" + }, + "dependencies": { + "ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==" + }, + "strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "requires": { + "ansi-regex": "^5.0.1" + } + } } }, "os-homedir": { @@ -16200,14 +16286,21 @@ "emoji-regex": "^8.0.0", "is-fullwidth-code-point": "^3.0.0", "strip-ansi": "^6.0.1" - } - }, - "strip-ansi": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", - "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", - "requires": { - "ansi-regex": "^5.0.1" + }, + "dependencies": { + "ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==" + }, + "strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "requires": { + "ansi-regex": "^5.0.1" + } + } } }, "strip-bom": { @@ -16954,6 +17047,21 @@ "ansi-styles": "^4.0.0", "string-width": "^4.1.0", "strip-ansi": "^6.0.0" + }, + "dependencies": { + "ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==" + }, + "strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "requires": { + "ansi-regex": "^5.0.1" + } + } } }, "wrappy": { diff --git a/package.json b/package.json index c433ebd5..42a42821 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@mindconnect/mindconnect-nodejs", - "version": "3.18.2", + "version": "3.19.0-1", "description": "NodeJS Library for MindSphere Connectivity - TypeScript SDK for MindSphere - MindSphere Command Line Interface - MindSphere Development Proxy", "main": "./dist/src/index.js", "browser": "./dist/src/index.bundle.js", diff --git a/src/api/sdk/data-lake/data-lake.ts b/src/api/sdk/data-lake/data-lake.ts index 7a36883f..765d364d 100644 --- a/src/api/sdk/data-lake/data-lake.ts +++ b/src/api/sdk/data-lake/data-lake.ts @@ -149,8 +149,17 @@ export class DataLakeClient extends SdkClient { const proxy = process.env.http_proxy || process.env.HTTP_PROXY; const proxyHttpAgent: any = proxy ? new HttpsProxyAgent(proxy) : null; - // x-ms-blob is necessary on eu2 and is ignored on eu1 - const request: any = { method: "PUT", headers: { "x-ms-blob-type": "BlockBlob" }, agent: proxyHttpAgent }; + let headers; + + // in china the Object Storage Service needs Content-Type to be application/octet-stream + if (this.GetGateway().toLowerCase().includes("mindsphere-in.cn")) { + headers = { "Content-Type": "application/octet-stream" }; + } else { + // x-ms-blob is necessary on eu2 and is ignored on eu1 + headers = { "x-ms-blob-type": "BlockBlob" }; + } + + const request: any = { method: "PUT", headers: headers, agent: proxyHttpAgent }; request.body = myBuffer; const response = await fetch(signedUrl, request); return response.headers; diff --git a/src/cli/commands/html/sc/index.html b/src/cli/commands/html/sc/index.html index c32699ce..649f2744 100644 --- a/src/cli/commands/html/sc/index.html +++ b/src/cli/commands/html/sc/index.html @@ -1,335 +1,251 @@ - - - - - mindconnect-nodejs command line interface configuration - - - + + + +
+
+
+ + - -
-
-
-
-
Command Line Interface
-
- - -
+
+
+
+
+
+
Command Line Interface
+
+ + +
+
+
+

+ You need to supply the application credentials or (deprecated) service credentials for + the command line interface. Press the add + button on the right to add a + new set of credentials.
The credential set with green checkmark will be used for + cli commands. + + See more help... + +

+ +
+
    -
    -

    - You need to supply the application credentials or (deprecated) service credentials for - the command line interface. Press the add - button on the right to add a - new set of credentials.
    The credential set with green checkmark will be used for - cli commands. - - See more help... - -

    - -
    -
      -
      -
      - -
      +
      +
      - -
      -
      -
      -
      -
      -
      - - Add new credentials -
      -
      -
      - -
      - + +
      -
      - - -
      +
      +
      +
      +
      +
      + + Add new credentials +
      +
      + + +
      + + +
      + + +
      -
      - - -
      +
      + + +
      - - -
      - Used to decrypt the information. You have to remember it, there is no way to - retrieve it. -
      + + +
      + Used to decrypt the information. You have to remember it, there is no way to + retrieve it. +
      - - -
      - Username for application or service credentials. -
      + + +
      + Username for application or service credentials. +
      - - -
      - Password for application or service credentials. -
      + + +
      + Password for application or service credentials. +
      - - -
      Region string or full gateway url
      + + +
      Region string or full gateway url
      + + + +
      + Tenant or Host Tenant (for application credentials) +
      - - +
      + +
      - Tenant or Host Tenant (for application credentials) + User Tenant (for application credentials)
      -
      - - -
      - User Tenant (for application credentials) -
      - - - -
      Application name
      - - -
      Application version
      -
      + + +
      Application name
      + + +
      Application version
      - -
      - -
      +
      + +
      +
      +
      - + - -
      - - + window.onload = init; + +
      + + + \ No newline at end of file diff --git a/src/cli/commands/markdown-help.ts b/src/cli/commands/markdown-help.ts new file mode 100644 index 00000000..924a9f30 --- /dev/null +++ b/src/cli/commands/markdown-help.ts @@ -0,0 +1,146 @@ +import { Command } from "commander"; +import { log } from "console"; +import * as fs from "fs"; +import * as path from "path"; +import { throwError } from "../../api/utils"; +import { errorLog, getColor, serviceCredentialLog } from "./command-utils"; + +let color = getColor("green"); + +export default (program: Command) => { + program + .command("markdown-help") + .alias("mdhelp") + .description(color(`generates folder with markdown help commands for the CLI*`)) + .option("-d, --dir ", "folder folder", "markdown-help") + .option("-o, --overwrite", "overwrite files if they already exist") + .action((options) => { + (async () => { + try { + let index = ``; + + program.commands.forEach((cmd) => { + const name = cmd.name(); + const description = cmd.description(); + const help = cmd.helpInformation(); + const examples = extractExamples(cmd); + + index += `| [\`mdsp ${name}\`](${name}.md) | ${stripAnsi(description)} |\n`; + writeCommandText(options, name, commandTemplate(name, description, help, examples).trim()); + }); + + writeCommandText(options, "index", indexTemplate(index).trim()); + } catch (err) { + errorLog(err, options.verbose); + } + })(); + }) + .on("--help", () => { + log("\n Examples:\n"); + log(` mc mdhelp`); + serviceCredentialLog(); + }); +}; + +function writeCommandText(options: any, commandName: string, text: string) { + const fileName = `${options.dir}/${commandName}.md`; + const filePath = path.resolve(fileName); + + !fs.existsSync(path.resolve(options.dir)) && fs.mkdirSync(path.resolve(options.dir)); + + fs.existsSync(filePath) && + !options.overwrite && + throwError(`The ${filePath} already exists. (use --overwrite to overwrite) `); + + fs.writeFileSync(filePath, text); + console.log(`The data was written into ${color(filePath)}`); +} + +function extractExamples(cmd: Command) { + const preservedConsoleLog = console.log; + + cmd.configureOutput({ writeOut: (str) => 0 }); + + let text = ""; + console.log = (...args: any[]) => { + text += args.join("") + "\n"; + }; + cmd.outputHelp(); + + console.log = preservedConsoleLog; + return text; +} + +const commandTemplate = (name: string, description: string, help: string, examples: string) => { + return ` +--- +title: MindSphere CLI - mdsp ${stripAnsi(name)} Command +next: + - title: Overview + link: ../cli/index + - title: Setting up the CLI + link: ../cli/setting-up-the-cli +--- + +# MindSphere CLI: mdsp ${stripAnsi(name)} Command + +Syntax: + +\`\`\`bash +mdsp ${stripAnsi(name)} +\`\`\` + +Help: + +\`\`\`bash +mdsp ${stripAnsi(name)} --help +\`\`\` + +Alternative form: + +\`\`\`bash +mc ${stripAnsi(name)} +\`\`\` + +(The CLI was using \`mc\` as default command name in older versions) + +## Description + +${stripAnsi(description)} + +## Usage + +Parameter list: + +\`\`\`text +${stripAnsi(help)} +\`\`\` + +## Examples + +Here are some examples of how to use the \`mdsp ${stripAnsi(name)}\` command: + +\`\`\`text +${stripAnsi(examples)} +\`\`\` + +See [MindSphere API documentation](https://documentation.mindsphere.io/MindSphere/apis/index.html) for more information about MindSphere APIs. + +`; +}; + +const indexTemplate = (index: string) => ` +--- +title: MindSphere CLI: List of all commands +--- +# MindSphere CLI: List of all commands + +| Command | Description | +| ----------- | ----------- | +${index}\n`; + +const stripAnsi = (x: string) => { + return x + .replace(/[\u001b\u009b][[()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcf-nqry=><]/g, "") + .replace(/(<([^>]+)>)/gi, ""); +}; diff --git a/src/cli/mc.ts b/src/cli/mc.ts index 5aa6b727..9a03e1da 100644 --- a/src/cli/mc.ts +++ b/src/cli/mc.ts @@ -24,6 +24,7 @@ import iotBulkDirCommand from "./commands/iot-prepare-bulk-dir"; import jobsCommand from "./commands/jobmanager-jobs"; import scheduleCommand from "./commands/jobmanager-schedules"; import kpicalculationCommand from "./commands/kpi-calculation"; +import markdownHelpCommand from "./commands/markdown-help"; import agentStatusCommand from "./commands/mc-agent-status"; import agentTokenCommand from "./commands/mc-agent-token"; import agentAutoConfigCommand from "./commands/mc-automap"; @@ -111,6 +112,7 @@ iotDownloadBulkCommand(program); deliveryJobsCommand(program); + // * assets files and event handling commands assetModelLockCommand(program); assetInfoCommand(program); @@ -205,6 +207,10 @@ mqttCreateCommand(program); starterTsCommand(program); starterJsCommand(program); +// * markdown help command + +markdownHelpCommand(program); + program.on("command:*", function () { console.error("Invalid command: %s\nSee --help for a list of available commands.", program.args.join(" ")); process.exit(1); diff --git a/src/version.ts b/src/version.ts index 449dd06a..ce9bbab9 100644 --- a/src/version.ts +++ b/src/version.ts @@ -1,2 +1,2 @@ -export const MC_VERSION = "3.18.2"; +export const MC_VERSION = "3.19.0"; export const MC_NAME = "mindconnect-nodejs";