@microtronics/studio-cli 0.48.0 → 0.49.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@microtronics/studio-cli",
-	"version": "0.48.0",
+	"version": "0.49.0",
 	"description": "Microtronics Studio CLI Tool",
 	"main": "./out/api.js",
 	"typings": "./dist/studio-cli.d.ts",
@@ -13,8 +13,9 @@
 	"scripts": {
 		"release": "release-it --ci",
 		"compile": "npm run build:registryApiTypings && tsc",
+		"build:cli": "node build.mjs",
 		"api": "api-extractor run --local --verbose",
-		"build": "npm run compile && npm run api",
+		"build": "npm run compile && npm run build:cli && npm run api",
 		"watch:build": "npm run compile -- --watch",
 		"test": "cross-env STUDIO_ENV=lucky mocha",
 		"test-ci": "cross-env STUDIO_ENV=lucky mocha --reporter mocha-junit-reporter",
@@ -25,7 +26,6 @@
 	"author": "Microtronics",
 	"license": "ISC",
 	"dependencies": {
-		"uuid": "^9.0.1",
 		"@gera2ld/tarjs": "^0.3.1",
 		"ajv": "^8.17.1",
 		"ajv-formats": "^3.0.1",
@@ -47,7 +47,7 @@
 		"tinytar-fix": "^0.1.1",
 		"update-notifier": "^7.3.1",
 		"usb": "^2.14.0",
-		"uto-master": "bitbucket:microtronics-core/wasm-uto-master",
+		"uuid": "^9.0.1",
 		"vscode-uri": "^3.0.8",
 		"yaml": "^2.6.1"
 	},
@@ -67,13 +67,15 @@
 		"chai": "^4.3.8",
 		"chai-as-promised": "^7.1.2",
 		"cross-env": "^7.0.3",
+		"esbuild": "^0.27.3",
 		"extract-zip": "^2.0.1",
+		"uto-master": "bitbucket:microtronics-core/wasm-uto-master",
 		"mocha": "^10.8.2",
 		"mocha-junit-reporter": "^2.2.1",
 		"openapi-typescript": "^7.6.0",
+		"tar": "^7.5.7",
 		"ts-node": "^10.9.2",
-		"typescript": "^5.6.3",
-		"tar": "^7.5.7"
+		"typescript": "^5.6.3"
 	},
 	"mocha": {
 		"require": [

package/studio-cli

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-require('./out/main')(process.argv);
+require('./dist/main')(process.argv);

package/out/argumentParser.js

@@ -1,64 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseUnknownLongOptions = parseUnknownLongOptions;
-/**
- * Set a nested value in an object by a dot-separated path.
- * Example: setByDotPath(obj, 'dlo.mainFile', 'x') => obj = { dlo: { mainFile: 'x' } }
- */
-function setByDotPath(target, path, value) {
-    const parts = path.split('.').filter(Boolean);
-    let cur = target;
-    for (let i = 0; i < parts.length; i++) {
-        const key = parts[i];
-        const isLeaf = i === parts.length - 1;
-        if (isLeaf) {
-            cur[key] = value;
-        }
-        else {
-            if (typeof cur[key] !== 'object' || cur[key] === null || Array.isArray(cur[key])) {
-                cur[key] = {};
-            }
-            cur = cur[key];
-        }
-    }
-}
-/**
- * Parse unknown long options (starting with `--`) into a key/value object.
- * - Supports `--key=value` and `--key value`
- */
-function parseUnknownLongOptions(command) {
-    const argv = command.args;
-    const result = {};
-    for (let i = 0; i < argv.length; i++) {
-        const token = argv[i];
-        // Only process long options that start with `--`
-        if (!token || !token.startsWith('--')) {
-            continue;
-        }
-        // Split inline assignment: --key=value
-        const [flag, inlineVal] = token.split('=', 2);
-        // Unknown option: collect it
-        const key = flag.slice(2); // remove leading '--'
-        let value = true;
-        if (inlineVal !== undefined) {
-            value = inlineVal;
-        }
-        else {
-            // If next token exists and doesn't look like another flag, use it as the value
-            const next = argv[i + 1];
-            if (next && !next.startsWith('-')) {
-                value = next;
-                i++; // consume the value
-            }
-        }
-        // Dot-notation => nested object
-        if (key.includes('.')) {
-            setByDotPath(result, key, value);
-        }
-        else {
-            result[key] = value;
-        }
-    }
-    return result;
-}
-//# sourceMappingURL=argumentParser.js.map

package/out/cliFS.js

@@ -1,74 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.cliFS = void 0;
-const promises_1 = __importDefault(require("node:fs/promises"));
-const FS_1 = require("./FS");
-const vscode_uri_1 = require("vscode-uri");
-const glob_1 = require("glob");
-exports.cliFS = {
-    readFile(path) {
-        return promises_1.default.readFile(path.fsPath);
-    },
-    async rm(path) {
-        if (await this.stat(path)) {
-            return promises_1.default.rm(path.fsPath, { recursive: true });
-        }
-    },
-    async stat(path) {
-        try {
-            const stat = await promises_1.default.stat(path.fsPath);
-            const fileType = (stat.isDirectory() ? FS_1.FileType.Directory : 0) |
-                (stat.isFile() ? FS_1.FileType.File : 0) |
-                (stat.isSymbolicLink() ? FS_1.FileType.SymbolicLink : 0);
-            return {
-                ctime: stat.ctimeMs,
-                mtime: stat.mtimeMs,
-                permissions: undefined,
-                size: stat.size,
-                type: fileType
-            };
-        }
-        catch (e) {
-            return null;
-        }
-    },
-    async writeFile(path, content) {
-        if (typeof content === 'string') {
-            content = new TextEncoder().encode(content);
-        }
-        const dirPath = vscode_uri_1.Utils.dirname(path);
-        await promises_1.default.mkdir(dirPath.fsPath, { recursive: true });
-        return promises_1.default.writeFile(path.fsPath, content, { flag: 'w' });
-    },
-    async findFiles(cwd, include, exclude) {
-        const options = {
-            ignore: exclude,
-            nodir: true,
-            absolute: true,
-            dot: true,
-            cwd: cwd.fsPath
-        };
-        const files = await (0, glob_1.glob)(include, options);
-        return files.map(file => {
-            const posix = file.replace(/\\/g, '/');
-            return vscode_uri_1.URI.parse(`file:///${posix}`);
-        });
-    },
-    async copy(source, target) {
-        const stat = await promises_1.default.stat(source.fsPath);
-        await promises_1.default.mkdir(vscode_uri_1.Utils.dirname(target).fsPath, { recursive: true });
-        if (stat.isDirectory()) {
-            return promises_1.default.cp(source.fsPath, target.fsPath, { force: true, recursive: true });
-        }
-        else {
-            return promises_1.default.copyFile(source.fsPath, target.fsPath);
-        }
-    },
-    async mkdir(path) {
-        await promises_1.default.mkdir(path.fsPath, { recursive: true });
-    }
-};
-//# sourceMappingURL=cliFS.js.map

package/out/main.js

@@ -1,251 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const package_json_1 = __importDefault(require("../package.json"));
-const cliFS_1 = require("./cliFS");
-const vscode_uri_1 = require("vscode-uri");
-const apm_1 = require("./package/apm");
-const globals_1 = require("./globals");
-const update_notifier_1 = __importDefault(require("update-notifier"));
-const api_1 = require("./api");
-const log_1 = require("./log");
-const argumentParser_1 = require("./argumentParser");
-const usb_1 = require("./usb");
-const run_1 = require("./run");
-const program = new commander_1.Command();
-const notifier = (0, update_notifier_1.default)({ pkg: package_json_1.default });
-const logger = new log_1.Log.Logger();
-// dummy cwd
-const devPath = () => {
-    if (process.env.NODE_ENV === 'local-dev-app') {
-        return './dev/app';
-    }
-    else if (process.env.NODE_ENV === 'local-dev-lib') {
-        return './dev/modbus-master';
-    }
-    else if (process.env.NODE_ENV === 'local-dev-addon') {
-        return './dev/addon';
-    }
-    else if (process.env.NODE_ENV === 'local-dev-analytics') {
-        return './dev/analytics';
-    }
-    return '';
-};
-const cwd = vscode_uri_1.Utils.joinPath(vscode_uri_1.URI.file(process.cwd()), devPath());
-program.version(package_json_1.default.version).usage('<command>');
-program.description('This tool is used to manage the project dependencies, build, package and publish the project.\n' +
-    'The manifest options can be overwritten with the --option=value syntax.\n' +
-    'Example: "studio build --dlo.mainFile="./dlo/test.dlo" will overwrite the dlo.mainFile option of the manifest.\n' +
-    '\nUse "studio --help" for more information.');
-/**
- * Executes a task and ensures that the update available notification is sent after the task completes,
- * regardless of whether it succeeds or fails.
- *
- * @param command
- * @param {Promise<void>} task - A promise representing the task to be executed.
- * @return {void} This function does not return a value.
- */
-function main(command, task) {
-    const manifestOptions = (0, argumentParser_1.parseUnknownLongOptions)(command);
-    api_1.Manifest.setOverwrites(manifestOptions);
-    // todo add task catch handler like: https://github.com/microsoft/vscode-vsce/blob/5518f2f242983d23f1983f6dd0350474f2011543/src/main.ts#L51
-    task.finally(() => {
-        notifier.notify();
-    });
-}
-function handleStudioEnv(env) {
-    process.env.STUDIO_ENV = env || globals_1.Globals.ENV.production;
-    if (env && env !== globals_1.Globals.ENV.production) {
-        console.log(`Using STUDIO_ENV=${env}`);
-    }
-    return process.env.STUDIO_ENV;
-}
-function getStudioApiToken(opts) {
-    return opts?.token || null;
-}
-function getDefaultOptions(opts) {
-    return {
-        env: handleStudioEnv(opts.env),
-        token: getStudioApiToken(opts)
-    };
-}
-/**
- * Generic option for the STUDIO_ENV
- */
-const optionStudioEnv = new commander_1.Option('-e, --env <environment>', 'CLI target environment (defaults to STUDIO_ENV environment variable)')
-    .default(process.env['STUDIO_ENV'])
-    .choices(Object.values(globals_1.Globals.ENV));
-/**
- * Generic option for the STUDIO_TOKEN
- */
-const optionStudioToken = new commander_1.Option('--token <API-token>', 'API Access Token (defaults to STUDIO_TOKEN environment variable)').default(process.env['STUDIO_TOKEN']);
-/**
- * Represents a command-line option for specifying the allowed backends deployment for a version.
- *
- * This variable represents an instance of an `Option` that determines which backends are permitted
- * during the deployment process. The backends can be specified as*/
-const optionAllowedBackends = new commander_1.Option('--allowedBackends <null|*|server.xz;server.yz>', 'specify the allowedBackends deployment for this version.').default(null);
-const releasePhaseArguments = Object.values(apm_1.APM.TagPhase);
-/**
- * Represents a command-line option for specifying a release phase in a software deployment process.
- *
- * The option includes a flag `-ph` or `--phase`, followed by the user-defined release phase value. It offers predefined
- * choices for acceptable release phase arguments, ensuring input validation. If no value is explicitly provided,
- * the default release phase is set to 'release'.
- */
-const optionReleasePhase = new commander_1.Option('-ph --phase <release phase>', 'specify a release phase')
-    .choices(releasePhaseArguments)
-    .default('release');
-/**
- * Option for specifying the APM part to build
- */
-const optionApmPart = new commander_1.Option('-p --part <APM part>', 'APM part that should be built').choices(Object.values(apm_1.APM.Part));
-/**
- * Option for device serial number (16 characters hex)
- */
-const optionDeviceSerial = new commander_1.Option('-s, --serial <serial>', 'Device serial number (16 characters hex)');
-/**
- * Option for enabling debug logging
- */
-const optionDebug = new commander_1.Option('--debug', 'Enable debug logging').default(false);
-/**
- * Option for myDatanet instance URL
- */
-const optionMdnServer = new commander_1.Option('--server <url>', 'myDatanet instance URL (https:// prefix optional)').default(process.env['MYDATANET_HOST']);
-/**
- * Option for myDatanet customer UID or ID
- */
-const optionMdnCustomer = new commander_1.Option('--customer <customerId>', 'myDatanet customer UID or ID').default(process.env['MYDATANET_CUSTOMER']);
-/**
- * Option for myDatanet API token
- */
-const optionMdnToken = new commander_1.Option('--mdn-token <token>', 'myDatanet API token').default(process.env['MYDATANET_TOKEN']);
-program
-    .command('install')
-    .aliases(['i'])
-    .description('install all the dependencies in your project')
-    .arguments('[dependency...]')
-    .allowExcessArguments(true)
-    .addOption(optionStudioEnv)
-    .addOption(optionStudioToken)
-    .allowUnknownOption(true)
-    .action((dependencies, opts, command) => {
-    const { env, token } = getDefaultOptions(opts);
-    main(command, (0, api_1.install)(cwd, cliFS_1.cliFS, env, token, dependencies));
-});
-program
-    .command('build')
-    .addOption(optionApmPart)
-    .allowExcessArguments(true)
-    .addOption(optionStudioEnv)
-    .addOption(optionStudioToken)
-    .allowUnknownOption(true)
-    .action((opts, command) => {
-    const { env, token } = getDefaultOptions(opts);
-    main(command, (0, api_1.build)(cwd, cliFS_1.cliFS, logger, env, token, opts.part));
-});
-program
-    .command('publish')
-    .addOption(optionReleasePhase)
-    .addOption(optionAllowedBackends)
-    .addOption(optionStudioEnv)
-    .addOption(optionStudioToken)
-    .allowUnknownOption(true)
-    .option('-i, --packagePath <path>', 'Publish the provided library or app package. Use "*" for autodetection.')
-    .action(async (opts, command) => {
-    const { env, token } = getDefaultOptions(opts);
-    main(command, (0, api_1.publish)(cwd, cliFS_1.cliFS, logger, env, token, opts.allowedBackends, opts.phase, opts.packagePath));
-});
-program
-    .command('package')
-    .alias('pack')
-    .description('Package the project')
-    .addOption(optionReleasePhase)
-    .addOption(optionStudioEnv)
-    .addOption(optionStudioToken)
-    .allowUnknownOption(true)
-    .action(async (opts, command) => {
-    const { env, token } = getDefaultOptions(opts);
-    main(command, (0, api_1.pack)(cwd, cliFS_1.cliFS, logger, env, token, opts.phase));
-});
-// Run command - Build, upload to device, and create development site
-program
-    .command('run')
-    .description('Build, upload to USB device, and create development site on myDatanet')
-    .addOption(optionDeviceSerial.makeOptionMandatory(true))
-    .addOption(optionMdnServer)
-    .addOption(optionMdnCustomer)
-    .addOption(optionMdnToken)
-    .addOption(optionApmPart)
-    .addOption(optionStudioEnv)
-    .addOption(optionStudioToken)
-    .addOption(optionDebug)
-    .allowUnknownOption(true)
-    .action(async (opts, command) => {
-    const { env, token } = getDefaultOptions(opts);
-    const mdnToken = opts.mdnToken;
-    const server = opts.server;
-    // Validate required options
-    if (!mdnToken) {
-        logger.error('MYDATANET_TOKEN is required. Set via --mdn-token or MYDATANET_TOKEN environment variable');
-        notifier.notify();
-        process.exit(run_1.RunExitCode.AuthenticationFailed);
-    }
-    if (!server) {
-        logger.error('Server URL is required. Set via --server or MYDATANET_HOST environment variable');
-        notifier.notify();
-        process.exit(run_1.RunExitCode.AuthenticationFailed);
-    }
-    const manifestOptions = (0, argumentParser_1.parseUnknownLongOptions)(command);
-    api_1.Manifest.setOverwrites(manifestOptions);
-    const result = await (0, run_1.run)(cwd, cliFS_1.cliFS, logger, env, token, {
-        serial: opts.serial,
-        server: server,
-        customer: opts.customer,
-        mdnToken: mdnToken,
-        debug: opts.debug,
-        part: opts.part ? [opts.part] : undefined
-    });
-    notifier.notify();
-    if (result.success) {
-        process.exit(run_1.RunExitCode.Success);
-    }
-    else {
-        logger.error(result.message);
-        process.exit(result.errorCode || 1);
-    }
-});
-// USB commands
-const usbCommand = program.command('usb').description('USB device management commands');
-usbCommand
-    .command('list')
-    .description('List available USB devices')
-    .action(async () => {
-    await (0, usb_1.printUsbDevices)(logger);
-    notifier.notify();
-});
-usbCommand
-    .command('upload')
-    .description('Upload an AMX binary to a USB device')
-    .addOption(optionDeviceSerial.makeOptionMandatory(true))
-    .requiredOption('-f, --file <path>', 'Path to the AMX file (relative to current directory)')
-    .addOption(optionDebug)
-    .action(async (opts) => {
-    const fileUri = vscode_uri_1.Utils.joinPath(cwd, opts.file);
-    const result = await (0, usb_1.uploadToDevice)(opts.serial, fileUri, cliFS_1.cliFS, logger, opts.debug);
-    notifier.notify();
-    if (!result.success) {
-        logger.error(result.message);
-        process.exit(1);
-    }
-    else {
-        process.exit(0);
-    }
-});
-module.exports = function (argv) {
-    program.parse(argv);
-};
-//# sourceMappingURL=main.js.map