@microtronics/studio-cli 0.16.0 → 0.17.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 
 
+## 0.17.0 (2025-02-13)
+
+
+### Features
+
+* **studio-cli:** added function to validate if a given apm part is enabled or not ([1dce992](https://bitbucket.org/microtronics-core/vscode-studio/commits/1dce99291f0629aed450af5413b128b0b80f29eb))
+* **studio-cli:** allow set the `MYDATANET_CUSTOMER` env ([a34297a](https://bitbucket.org/microtronics-core/vscode-studio/commits/a34297ae1e670ef665b5991d065f74e6401466e3))
+* **studio-cli:** make `ENV` namespace available ([09a8b80](https://bitbucket.org/microtronics-core/vscode-studio/commits/09a8b80a1b0f99eada300e273bb84029d28132bb))
+* **studio-cli:** only add dlo binarys if the dlo part is enabled ([6d106ab](https://bitbucket.org/microtronics-core/vscode-studio/commits/6d106ab411c44057ca71e04d301d1c984a6b253b))
+* **studio-cli:** only start compiler if the apm part is enabled ([dfbc701](https://bitbucket.org/microtronics-core/vscode-studio/commits/dfbc70173abf81eb5635a6d360d89a2f8734868a))
+* **studio-cli:** support to read `.env.local` to support local build settings ([3376dbf](https://bitbucket.org/microtronics-core/vscode-studio/commits/3376dbf16f757f06829556eb2fc1d92d628253c1))
+
+
+### Bug Fixes
+
+* **studio-cli:** only return boolean for `isApmPartEnabled` function ([c80468a](https://bitbucket.org/microtronics-core/vscode-studio/commits/c80468ae245b49fb1f5209fbf5a948df9f5bc7d2))
+* **studio-cli:** validate if `.env.local` file exist ([eeea393](https://bitbucket.org/microtronics-core/vscode-studio/commits/eeea3932bc28a259975c4755a4f5a6a107ab34b7))
+
 ## 0.16.0 (2025-02-07)
 
 

package/dist/studio-cli.d.ts

@@ -1782,6 +1782,23 @@ declare class DloPreCompiler {
     }>;
 }
 
+export declare namespace ENV {
+    /**
+     *
+     */
+    export interface ENV {
+        MYDATANET_HOST?: string;
+        MYDATANET_API_TOKEN?: string;
+        MYDATANET_CUSTOMER?: string;
+    }
+    /**
+     * Read/parse the supported .env file
+     * @param cwd
+     * @param fs
+     */
+    export function read(cwd: URI, fs: LocalFS): Promise<ENV.ENV>;
+}
+
 /**
  * Permissions of a file.
  */
@@ -2130,6 +2147,14 @@ export declare namespace Manifest {
     export function validateRegistryAllowedBackends(allowedBackends: undefined | null | string | string[]): Promise<string | null>;
     export function validateApplicationIcon(cwd: URI, fs: LocalFS, manifest: Manifest.Manifest): Promise<void>;
     export function validateEngineSettings(manifest: Manifest.Manifest): void;
+    /**
+     * Validate if the given apm part is used
+     * @param cwd
+     * @param fs
+     * @param apmPart
+     * @param manifest
+     */
+    export function isApmPartEnabled(cwd: URI, fs: LocalFS, apmPart: APM.Part, manifest?: Manifest.Manifest): Promise<boolean>;
 }
 
 export declare namespace Package {

package/out/api.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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.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;
 const dependencies_1 = require("./dependencies");
 Object.defineProperty(exports, "Dependencies", { enumerable: true, get: function () { return dependencies_1.Dependencies; } });
 const manifest_1 = require("./manifest");
@@ -31,4 +31,6 @@ const library_1 = require("./package/library");
 Object.defineProperty(exports, "Library", { enumerable: true, get: function () { return library_1.Library; } });
 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; } });
 //# sourceMappingURL=api.js.map

package/out/dlo/compiler.js

@@ -65,6 +65,15 @@ class DloCompiler {
     }
     async compile(cwd, fs) {
         const manifest = await manifest_1.Manifest.read(cwd, fs);
+        if (!(await manifest_1.Manifest.isApmPartEnabled(cwd, fs, apm_1.APM.Part.dlo, manifest))) {
+            console.log('DLO not enabled. Skipped.');
+            return {
+                code: 0,
+                stdout: [],
+                stderr: [],
+                diagnostics: []
+            };
+        }
         await this.initDloCC();
         const precompilerDiagnostics = await this.persistDloFiles(cwd, fs, manifest);
         const mainFile = vscode_uri_1.Utils.joinPath(cwd, manifest.dlo?.mainFile || defaultFiles_1.DefaultFiles.filePaths.dlo.mainDLO);

package/out/dotenv.js

@@ -0,0 +1,28 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ENV = void 0;
+const dotenv_1 = __importDefault(require("dotenv"));
+const vscode_uri_1 = require("vscode-uri");
+const helper_1 = require("./helper");
+const envLocalFile = '.env.local';
+var ENV;
+(function (ENV) {
+    /**
+     * Read/parse the supported .env file
+     * @param cwd
+     * @param fs
+     */
+    async function read(cwd, fs) {
+        const envPath = vscode_uri_1.Utils.joinPath(cwd, envLocalFile);
+        if (await fs.stat(envPath)) {
+            const envData = await fs.readFile(envPath);
+            return dotenv_1.default.parse(helper_1.Helper.convertBlobToString(envData));
+        }
+        return {};
+    }
+    ENV.read = read;
+})(ENV || (exports.ENV = ENV = {}));
+//# sourceMappingURL=dotenv.js.map

package/out/manifest.js

@@ -13,6 +13,7 @@ const globals_1 = require("./globals");
 const preload_1 = __importDefault(require("semver/preload"));
 const DeviceProfiles_1 = require("./DeviceProfiles");
 var isNumeric = helper_1.Helper.isNumeric;
+const apm_1 = require("./package/apm");
 // Cache to reduce the disk read requests
 const manifestCache = {
     _manifest: null,
@@ -263,6 +264,33 @@ var Manifest;
         validateHwFwOrProductId(manifest);
     }
     Manifest.validateEngineSettings = validateEngineSettings;
+    /**
+     * Validate if the given apm part is used
+     * @param cwd
+     * @param fs
+     * @param apmPart
+     * @param manifest
+     */
+    async function isApmPartEnabled(cwd, fs, apmPart, manifest) {
+        if (!manifest) {
+            manifest = await Manifest.read(cwd, fs);
+        }
+        switch (apmPart) {
+            case apm_1.APM.Part.dlo:
+                return !!manifest?.dlo?.mainFile;
+            case apm_1.APM.Part.blo:
+                return !!(manifest.blo?.buildCommand && manifest.blo?.workingPath);
+            case apm_1.APM.Part.pov:
+                return !!(manifest.pov?.details?.buildCommand && manifest.pov.details.workingPath);
+            // dde and dfiles are always enabled
+            case apm_1.APM.Part.dde:
+            case apm_1.APM.Part.dfiles:
+                return true;
+            default:
+                return false;
+        }
+    }
+    Manifest.isApmPartEnabled = isApmPartEnabled;
 })(Manifest || (exports.Manifest = Manifest = {}));
 function validatePOVSettings(manifest) {
     const { pov } = manifest;

package/out/package/apm.js

@@ -99,8 +99,6 @@ var APM;
         apmBuffer.append(`src/${manifest_1.Manifest.fileName}`, new Blob([await manifest_1.Manifest.readAsBlob(cwd, fs)]));
         const xmlBlob = new Blob([await fs.readFile(vscode_uri_1.Utils.joinPath(cwd, defaultFiles_1.DefaultFiles.filePaths.dist.ddeXmlPath))]);
         apmBuffer.append('bin/dde/xml', xmlBlob);
-        const amxBlob = new Blob([await fs.readFile(vscode_uri_1.Utils.joinPath(cwd, defaultFiles_1.DefaultFiles.filePaths.dist.mainAmxPath))]);
-        apmBuffer.append('bin/dlo/amx', amxBlob);
         if (manifest.icon) {
             const appIcon = await fs.readFile(vscode_uri_1.Utils.joinPath(cwd, manifest.icon));
             const base64 = bufferToBase64(appIcon);
@@ -113,8 +111,12 @@ var APM;
             apmBuffer.append(`previews/README.md`, new Blob([readme]));
             apmBuffer.append(`previews/CHANGELOG.md`, new Blob([changelog]));
         }
+        if (await manifest_1.Manifest.isApmPartEnabled(cwd, fs, APM.Part.dlo)) {
+            const amxBlob = new Blob([await fs.readFile(vscode_uri_1.Utils.joinPath(cwd, defaultFiles_1.DefaultFiles.filePaths.dist.mainAmxPath))]);
+            apmBuffer.append('bin/dlo/amx', amxBlob);
+        }
         // handle pov binaries
-        if (manifest.pov?.details) {
+        if (await manifest_1.Manifest.isApmPartEnabled(cwd, fs, APM.Part.pov, manifest)) {
             // get files in details dir
             await insertRelativePathFilesToBuffer(cwd, fs, apmBuffer, defaultFiles_1.DefaultFiles.filePaths.dist.povDetailsPath, 'bin/pov/details');
             //site list not supported yet -> add an empty index.html
@@ -128,7 +130,7 @@ var APM;
             apmBuffer.append(`bin/dfiles/${vscode_uri_1.Utils.basename(fileName)}`, dfileBlob);
         }
         // handle blo files
-        if (manifest.blo) {
+        if (await manifest_1.Manifest.isApmPartEnabled(cwd, fs, APM.Part.pov, manifest)) {
             // get files in blo dir
             await insertRelativePathFilesToBuffer(cwd, fs, apmBuffer, defaultFiles_1.DefaultFiles.filePaths.dist.bloPath, 'bin/blo');
         }

package/out/scriptRunner.js

@@ -37,7 +37,7 @@ var Shell;
      */
     async function tryBuildPov(cwd, fs) {
         const manifest = await manifest_1.Manifest.read(cwd, fs);
-        if (manifest.pov?.details?.buildCommand && manifest.pov.details.workingPath) {
+        if (await manifest_1.Manifest.isApmPartEnabled(cwd, fs, apm_1.APM.Part.pov)) {
             console.log('Executing POV build script', manifest.pov?.details.buildCommand);
             const { buildCommand, workingPath } = manifest.pov.details;
             const povDir = vscode_uri_1.Utils.joinPath(cwd, workingPath);
@@ -62,7 +62,7 @@ var Shell;
      */
     async function tryBuildBlo(cwd, fs) {
         const manifest = await manifest_1.Manifest.read(cwd, fs);
-        if (manifest.blo?.buildCommand && manifest.blo?.workingPath) {
+        if (await manifest_1.Manifest.isApmPartEnabled(cwd, fs, apm_1.APM.Part.blo, manifest)) {
             console.log('Executing BLO build script', manifest.blo?.buildCommand);
             const { buildCommand, workingPath } = manifest.blo;
             const bloDir = vscode_uri_1.Utils.joinPath(cwd, workingPath);

package/package.json

@@ -1,76 +1,77 @@
-{
-	"name": "@microtronics/studio-cli",
-	"version": "0.16.0",
-	"description": "Microtronics Studio CLI Tool",
-	"main": "./out/api.js",
-	"typings": "./dist/studio-cli.d.ts",
-	"bin": {
-		"studio-cli": "studio-cli"
-	},
-	"publishConfig": {
-		"access": "public"
-	},
-	"scripts": {
-		"release": "release-it --ci",
-		"compile": "npm run build:registryApiTypings && tsc",
-		"api": "api-extractor run --local --verbose",
-		"build": "npm run compile && 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",
-		"watch:test": "npm run test -- --watch",
-		"prepublishOnly": "npm run build",
-		"build:registryApiTypings": "npx openapi-typescript https://api.registry.stage.microtronics.com/v1/openapi.yaml -o ./src/typings/registry.ts"
-	},
-	"author": "Microtronics",
-	"license": "ISC",
-	"dependencies": {
-		"ajv": "^8.17.1",
-		"ajv-formats": "^3.0.1",
-		"ajv-keywords": "^5.1.0",
-		"commander": "^12.1.0",
-		"cross-fetch": "^4.0.0",
-		"glob": "^11.0.1",
-		"iconv-lite": "^0.6.3",
-		"minimatch": "^10.0.1",
-		"ini": "^5.0.0",
-		"openapi-fetch": "^0.13.0",
-		"pako": "^2.1.0",
-		"semver": "^7.6.3",
-		"tarballjs": "github:ankitrohatgi/tarballjs",
-		"tinytar-fix": "^0.1.1",
-		"vscode-uri": "^3.0.8",
-		"yaml": "^2.6.1",
-		"image-dimensions": "^2.3.0",
-		"file-type-checker": "^1.1.2"
-	},
-	"engines": {
-		"node": ">= 22"
-	},
-	"devDependencies": {
-		"@microsoft/api-extractor": "^7.47.11",
-		"@types/chai": "^4.3.6",
-		"@types/chai-as-promised": "^7.1.5",
-		"@types/ini": "^4.1.1",
-		"@types/mocha": "^10.0.9",
-		"@types/node": "^22.9.1",
-		"@types/semver": "^7.5.6",
-		"@types/vscode": "^1.86.2",
-		"chai": "^4.3.8",
-		"chai-as-promised": "^7.1.2",
-		"cross-env": "^7.0.3",
-		"mocha": "^10.8.2",
-		"mocha-junit-reporter": "^2.2.1",
-		"openapi-typescript": "^7.6.0",
-		"ts-node": "^10.9.2",
-		"typescript": "^5.6.3"
-	},
-	"mocha": {
-		"require": [
-			"ts-node/register"
-		],
-		"watch-files": "src/**",
-		"spec": "./test/**/*.spec.ts",
-		"recursive": true
-	}
-}
+{
+	"name": "@microtronics/studio-cli",
+	"version": "0.17.0",
+	"description": "Microtronics Studio CLI Tool",
+	"main": "./out/api.js",
+	"typings": "./dist/studio-cli.d.ts",
+	"bin": {
+		"studio-cli": "studio-cli"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"scripts": {
+		"release": "release-it --ci",
+		"compile": "npm run build:registryApiTypings && tsc",
+		"api": "api-extractor run --local --verbose",
+		"build": "npm run compile && 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",
+		"watch:test": "npm run test -- --watch",
+		"prepublishOnly": "npm run build",
+		"build:registryApiTypings": "npx openapi-typescript https://api.registry.stage.microtronics.com/v1/openapi.yaml -o ./src/typings/registry.ts"
+	},
+	"author": "Microtronics",
+	"license": "ISC",
+	"dependencies": {
+		"ajv": "^8.17.1",
+		"ajv-formats": "^3.0.1",
+		"ajv-keywords": "^5.1.0",
+		"commander": "^12.1.0",
+		"cross-fetch": "^4.0.0",
+		"dotenv": "^16.4.7",
+		"file-type-checker": "^1.1.2",
+		"glob": "^11.0.1",
+		"iconv-lite": "^0.6.3",
+		"image-dimensions": "^2.3.0",
+		"ini": "^5.0.0",
+		"minimatch": "^10.0.1",
+		"openapi-fetch": "^0.13.0",
+		"pako": "^2.1.0",
+		"semver": "^7.6.3",
+		"tarballjs": "github:ankitrohatgi/tarballjs",
+		"tinytar-fix": "^0.1.1",
+		"vscode-uri": "^3.0.8",
+		"yaml": "^2.6.1"
+	},
+	"engines": {
+		"node": ">= 22"
+	},
+	"devDependencies": {
+		"@microsoft/api-extractor": "^7.47.11",
+		"@types/chai": "^4.3.6",
+		"@types/chai-as-promised": "^7.1.5",
+		"@types/ini": "^4.1.1",
+		"@types/mocha": "^10.0.9",
+		"@types/node": "^22.9.1",
+		"@types/semver": "^7.5.6",
+		"@types/vscode": "^1.86.2",
+		"chai": "^4.3.8",
+		"chai-as-promised": "^7.1.2",
+		"cross-env": "^7.0.3",
+		"mocha": "^10.8.2",
+		"mocha-junit-reporter": "^2.2.1",
+		"openapi-typescript": "^7.6.0",
+		"ts-node": "^10.9.2",
+		"typescript": "^5.6.3"
+	},
+	"mocha": {
+		"require": [
+			"ts-node/register"
+		],
+		"watch-files": "src/**",
+		"spec": "./test/**/*.spec.ts",
+		"recursive": true
+	}
+}