@microtronics/studio-cli 0.24.0 → 0.25.0

package/CHANGELOG.md

@@ -1,11 +1,20 @@
 
 
-## 0.24.0 (2025-03-10)
+## 0.25.0 (2025-03-12)
 
 
 ### Features
 
-* **studio-cli:** correct server version to allow app type addon ([1ff035c](https://bitbucket.org/microtronics-core/vscode-studio/commits/1ff035c30ced5018228646b28b0855ba8202aceb))
+* **studio-cli:** show update notification after each cli command ([c719fd8](https://bitbucket.org/microtronics-core/vscode-studio/commits/c719fd8ea6a7dda16589764d2ae77f70e006d80a))
+
+## 0.24.1 (2025-03-12)
+
+## 0.24.0 (2025-03-10)
+
+
+### Features
+
+* **studio-cli:** correct server version to allow app type addon ([1ff035c](https://bitbucket.org/microtronics-core/vscode-studio/commits/1ff035c30ced5018228646b28b0855ba8202aceb))
 * **studio-core:** support to download a specific app version ([30bd6b2](https://bitbucket.org/microtronics-core/vscode-studio/commits/30bd6b23db14790c55771de4d4d1622bab26edc7))
 
 ## 0.23.0 (2025-02-25)

package/dist/studio-cli.d.ts

@@ -115,6 +115,16 @@ declare interface BaseTagHeader {
     addon_max_sources?: number;
 }
 
+/**
+ * Builds all parts of the specified project in the given working directory.
+ *
+ * @param {URI} cwd - The current working directory where the build process will be executed.
+ * @param {LocalFS} fs - The local file system instance used for file operations during the build.
+ * @param {APM.Part} part - The project part to be built.
+ * @return {Promise<any>} A promise that resolves when the build process is complete.
+ */
+export declare function build(cwd: URI, fs: LocalFS, part?: APM.Part): Promise<any>;
+
 declare interface components {
     schemas: {
         /** @default 25 */
@@ -2003,6 +2013,18 @@ export declare namespace Helper {
     export function defer(token: string, timeout: number, callback: any): void;
 }
 
+/**
+ * Installs the specified dependencies or all dependencies if none are provided.
+ *
+ * @param {URI} cwd - The current working directory where the installation process takes place.
+ * @param {LocalFS} fs - The file system interface used for managing files during the installation process.
+ * @param {Globals.ENV} env - The global environment configuration used during the installation.
+ * @param {string|null} apiToken - The API token for authentication, if required, or null if not applicable.
+ * @param {string[]} dependencies - An array of dependency strings in the format "libraryId@version". If empty, all dependencies will be installed.
+ * @return {Promise<void>} A promise that resolves when the installation process completes successfully or logs an error if it fails.
+ */
+export declare function install(cwd: URI, fs: LocalFS, env: Globals.ENV, apiToken: string | null, dependencies: string[]): Promise<void>;
+
 export declare namespace Library {
     /**
      * Creates the library.tar.gz archive content
@@ -4480,6 +4502,19 @@ declare interface paths {
     };
 }
 
+/**
+ * Publishes a package to the registry with the specified settings and configurations.
+ *
+ * @param {URI} cwd - The current working directory of the package.
+ * @param {LocalFS} fs - The file system interface for reading and writing files.
+ * @param {Globals.ENV} env - The environment configuration for the publishing process.
+ * @param {string | null} apiToken - The API token for authentication, or null if not applicable.
+ * @param {string | undefined} optsAllowedBackends - A semicolon-separated list of allowed backends, or '*' to allow all, or undefined if not specified.
+ * @param {APM.TagPhase} optsPhase - The release phase tag associated with the package publishing.
+ * @return {Promise<void>} A promise that resolves when the package has been successfully published or rejects with an error if the process fails.
+ */
+export declare function publish(cwd: URI, fs: LocalFS, env: Globals.ENV, apiToken: string | null, optsAllowedBackends: string | undefined, optsPhase: APM.TagPhase): Promise<void>;
+
 export declare namespace Registry {
     export type AuthToken = string | null;
     /**

package/out/api.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ENV = exports.DFILES = exports.Library = exports.APM = exports.Package = exports.DLO = exports.Globals = exports.DeviceProfiles = exports.DefaultFiles = exports.Diagnostics = exports.Helper = exports.DDE = exports.DDE_Core = exports.Registry = exports.Manifest = exports.Dependencies = void 0;
+exports.install = install;
+exports.build = build;
+exports.publish = publish;
 const dependencies_1 = require("./dependencies");
 Object.defineProperty(exports, "Dependencies", { enumerable: true, get: function () { return dependencies_1.Dependencies; } });
 const manifest_1 = require("./manifest");
@@ -33,4 +36,63 @@ const dfiles_1 = require("./dfiles/dfiles");
 Object.defineProperty(exports, "DFILES", { enumerable: true, get: function () { return dfiles_1.DFILES; } });
 const dotenv_1 = require("./dotenv");
 Object.defineProperty(exports, "ENV", { enumerable: true, get: function () { return dotenv_1.ENV; } });
+/**
+ * Installs the specified dependencies or all dependencies if none are provided.
+ *
+ * @param {URI} cwd - The current working directory where the installation process takes place.
+ * @param {LocalFS} fs - The file system interface used for managing files during the installation process.
+ * @param {Globals.ENV} env - The global environment configuration used during the installation.
+ * @param {string|null} apiToken - The API token for authentication, if required, or null if not applicable.
+ * @param {string[]} dependencies - An array of dependency strings in the format "libraryId@version". If empty, all dependencies will be installed.
+ * @return {Promise<void>} A promise that resolves when the installation process completes successfully or logs an error if it fails.
+ */
+async function install(cwd, fs, env, apiToken, dependencies) {
+    try {
+        if (dependencies.length > 0) {
+            for (const dependency of dependencies) {
+                const [libraryId, version] = dependency.split('@');
+                await dependencies_1.Dependencies.installDependency(cwd, fs, env, apiToken, libraryId, version || null);
+            }
+        }
+        else {
+            return await dependencies_1.Dependencies.installDependencies(cwd, fs, env, apiToken);
+        }
+    }
+    catch (e) {
+        console.error(e);
+    }
+}
+/**
+ * Builds all parts of the specified project in the given working directory.
+ *
+ * @param {URI} cwd - The current working directory where the build process will be executed.
+ * @param {LocalFS} fs - The local file system instance used for file operations during the build.
+ * @param {APM.Part} part - The project part to be built.
+ * @return {Promise<any>} A promise that resolves when the build process is complete.
+ */
+async function build(cwd, fs, part) {
+    return package_1.Package.buildAll(cwd, fs, part);
+}
+/**
+ * Publishes a package to the registry with the specified settings and configurations.
+ *
+ * @param {URI} cwd - The current working directory of the package.
+ * @param {LocalFS} fs - The file system interface for reading and writing files.
+ * @param {Globals.ENV} env - The environment configuration for the publishing process.
+ * @param {string | null} apiToken - The API token for authentication, or null if not applicable.
+ * @param {string | undefined} optsAllowedBackends - A semicolon-separated list of allowed backends, or '*' to allow all, or undefined if not specified.
+ * @param {APM.TagPhase} optsPhase - The release phase tag associated with the package publishing.
+ * @return {Promise<void>} A promise that resolves when the package has been successfully published or rejects with an error if the process fails.
+ */
+async function publish(cwd, fs, env, apiToken, optsAllowedBackends, optsPhase) {
+    let allowedBackends = null;
+    if (optsAllowedBackends) {
+        allowedBackends = optsAllowedBackends === '*' ? optsAllowedBackends : optsAllowedBackends.split(';');
+        const errorMessage = await manifest_1.Manifest.validateRegistryAllowedBackends(allowedBackends);
+        if (errorMessage) {
+            throw new Error(errorMessage);
+        }
+    }
+    await package_1.Package.release(cwd, fs, apiToken, optsPhase, allowedBackends, env);
+}
 //# sourceMappingURL=api.js.map

package/out/main.js

@@ -7,14 +7,12 @@ 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 dependencies_1 = require("./dependencies");
-var installDependencies = dependencies_1.Dependencies.installDependencies;
-var installDependency = dependencies_1.Dependencies.installDependency;
-const package_1 = require("./package/package");
 const apm_1 = require("./package/apm");
 const globals_1 = require("./globals");
-const manifest_1 = require("./manifest");
+const update_notifier_1 = __importDefault(require("update-notifier"));
+const api_1 = require("./api");
 const program = new commander_1.Command();
+const notifier = (0, update_notifier_1.default)({ pkg: package_json_1.default });
 // dummy cwd
 const devPath = () => {
     if (process.env.NODE_ENV === 'local-dev-app') {
@@ -30,6 +28,19 @@ const devPath = () => {
 };
 const cwd = vscode_uri_1.Utils.joinPath(vscode_uri_1.URI.file(process.cwd()), devPath());
 program.version(package_json_1.default.version).usage('<command>');
+/**
+ * Executes a task and ensures that the update available notification is sent after the task completes,
+ * regardless of whether it succeeds or fails.
+ *
+ * @param {Promise<void>} task - A promise representing the task to be executed.
+ * @return {void} This function does not return a value.
+ */
+function main(task) {
+    // 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) {
@@ -40,6 +51,12 @@ function handleStudioEnv(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
  */
@@ -58,29 +75,15 @@ program
     .allowExcessArguments(true)
     .addOption(optionStudioEnv)
     .addOption(optionStudioToken)
-    .action(async (dependencies, opts) => {
-    const env = handleStudioEnv(opts.env);
-    const apiToken = getStudioApiToken(opts);
-    try {
-        if (dependencies.length > 0) {
-            for (const dependency of dependencies) {
-                const [libraryId, version] = dependency.split('@');
-                await installDependency(cwd, cliFS_1.cliFS, env, apiToken, libraryId, version || null);
-            }
-        }
-        else {
-            return await installDependencies(cwd, cliFS_1.cliFS, env, apiToken);
-        }
-    }
-    catch (e) {
-        console.error(e);
-    }
+    .action((dependencies, opts) => {
+    const { env, token } = getDefaultOptions(opts);
+    main((0, api_1.install)(cwd, cliFS_1.cliFS, env, token, dependencies));
 });
 program
     .command('build')
     .addOption(new commander_1.Option('-p --part <APM part>', 'APM part that should be build').choices(Object.values(apm_1.APM.Part)))
-    .action(async (opts) => {
-    await package_1.Package.buildAll(cwd, cliFS_1.cliFS, opts.part);
+    .action(opts => {
+    main((0, api_1.build)(cwd, cliFS_1.cliFS, opts.part));
 });
 const releasePhaseArguments = Object.values(apm_1.APM.TagPhase);
 program
@@ -92,17 +95,8 @@ program
     .addOption(optionStudioEnv)
     .addOption(optionStudioToken)
     .action(async (opts) => {
-    const env = handleStudioEnv(opts.env);
-    const token = getStudioApiToken(opts);
-    let allowedBackends = null;
-    if (opts.allowedBackends) {
-        allowedBackends = opts.allowedBackends === '*' ? opts.allowedBackends : opts.allowedBackends.split(';');
-        const errorMessage = await manifest_1.Manifest.validateRegistryAllowedBackends(allowedBackends);
-        if (errorMessage) {
-            throw new Error(errorMessage);
-        }
-    }
-    await package_1.Package.release(cwd, cliFS_1.cliFS, token, opts.phase, allowedBackends, env);
+    const { env, token } = getDefaultOptions(opts);
+    main((0, api_1.publish)(cwd, cliFS_1.cliFS, env, token, opts.allowedBackends, opts.phase));
 });
 module.exports = function (argv) {
     program.parse(argv);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@microtronics/studio-cli",
-	"version": "0.24.0",
+	"version": "0.25.0",
 	"description": "Microtronics Studio CLI Tool",
 	"main": "./out/api.js",
 	"typings": "./dist/studio-cli.d.ts",
@@ -42,6 +42,7 @@
 		"semver": "^7.6.3",
 		"tarballjs": "github:ankitrohatgi/tarballjs",
 		"tinytar-fix": "^0.1.1",
+		"update-notifier": "^7.3.1",
 		"vscode-uri": "^3.0.8",
 		"yaml": "^2.6.1"
 	},
@@ -56,6 +57,7 @@
 		"@types/mocha": "^10.0.9",
 		"@types/node": "^22.9.1",
 		"@types/semver": "^7.5.6",
+		"@types/update-notifier": "^6.0.8",
 		"@types/vscode": "^1.86.2",
 		"chai": "^4.3.8",
 		"chai-as-promised": "^7.1.2",