@microtronics/studio-cli 0.15.0 → 0.16.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 
 
+## 0.16.0 (2025-02-07)
+
+
+### Features
+
+* **studio-cli:** add the `history.json` to the store tag ([70086be](https://bitbucket.org/microtronics-core/vscode-studio/commits/70086be5ef2100ba6bf0e699d242bf9d02d7e347))
+* **studio-cli:** add the `studio.json` to the store tag ([6e23a79](https://bitbucket.org/microtronics-core/vscode-studio/commits/6e23a793f8d7c7ebc8a5044d86002d965ac484eb))
+* **studio-cli:** introduced new manifest property `type` ([edbd5cb](https://bitbucket.org/microtronics-core/vscode-studio/commits/edbd5cbb11198f6659be42560642676258c6ca66))
+* **studio-cli:** prevent generating `history.json` for library projects ([00e45c0](https://bitbucket.org/microtronics-core/vscode-studio/commits/00e45c02b07147a157b0c3fedb3217988c0ea225))
+
+## 0.15.1 (2025-01-31)
+
+
+### Bug Fixes
+
+* **studio-cli:** didn't allow that allowedBackends are null ([6335dab](https://bitbucket.org/microtronics-core/vscode-studio/commits/6335dab9eb7e783faa4354da304989f3adc79be0))
+
 ## 0.15.0 (2025-01-31)
 
 

package/dist/studio-cli.d.ts

@@ -2021,12 +2021,24 @@ declare interface LocalFS {
 }
 
 export declare namespace Manifest {
+    /**
+     * The source filename where the information is stored in
+     */
+    const fileName = "studio.json";
     export type DeviceProfiles = 'm22x' | 'm23x' | 'nrf91' | 'm2blegw' | 'm2easyv3' | 'm2easyiot';
+    /**
+     * Type of the iot app project
+     */
+    export enum ProjectTypes {
+        app = "app",
+        library = "library"
+    }
     export interface Manifest {
         version: string;
         name: string;
         publisher: string;
         description: string;
+        type: ProjectTypes;
         legacyProject?: boolean;
         icon?: string;
         dpid: DeviceProfiles;
@@ -2035,6 +2047,9 @@ export declare namespace Manifest {
             hwfw?: string[];
             productId?: string[];
         };
+        /**
+         * @deprecated
+         */
         library?: boolean;
         libraryDependencies?: Dependencies;
         libraryDevDependencies?: Dependencies;
@@ -2098,7 +2113,7 @@ export declare namespace Manifest {
     /**
      * Check if the current project is a library project
      */
-    export function isLibraryProject(manifest: Manifest.Manifest): boolean;
+    export function isLibrary(manifest: Manifest.Manifest): boolean;
     /**
      * Validates if the properties within
      * @param cwd

package/out/dde/dde.js

@@ -275,7 +275,7 @@ var DDE;
      */
     async function exportOpenApi(cwd, fs, ddeMap) {
         const manifest = await manifest_1.Manifest.read(cwd, fs);
-        const isLibrary = manifest.library;
+        const isLibrary = manifest_1.Manifest.isLibrary(manifest);
         // remove previous api description:
         const previousOpenAPIFileName = vscode_uri_1.Utils.joinPath(cwd, defaultFiles_1.DefaultFiles.filePaths.dist.path, 'dde-api.yaml');
         await fs.rm(previousOpenAPIFileName).catch(() => { });
@@ -330,7 +330,7 @@ async function getDependencies(cwd, fs, manifest) {
         }
     }
     // push library projects dde file also into the list
-    if (manifest_1.Manifest.isLibraryProject(manifest)) {
+    if (manifest_1.Manifest.isLibrary(manifest)) {
         const projectLibPath = vscode_uri_1.Utils.joinPath(cwd, `/${exports.DDE_PATH}/${manifest.name}.dde`);
         if (await fs.stat(projectLibPath)) {
             ddeFiles.push({

package/out/dde/fileGenerators/dlo.js

@@ -62,7 +62,7 @@ function getPawnTypeDefinition(field) {
 }
 const MICROTRONICS_DLO_CORE = 'Microtronics/dlo-core';
 function getRequiredDloCoreVersion(manifest) {
-    if (manifest_1.Manifest.isLibraryProject(manifest) && manifest.name === 'dlo-core') {
+    if (manifest_1.Manifest.isLibrary(manifest) && manifest.name === 'dlo-core') {
         return manifest.version;
     }
     else if (manifest.libraryDependencies && Object.hasOwn(manifest.libraryDependencies, MICROTRONICS_DLO_CORE)) {

package/out/dependencies.js

@@ -35,7 +35,6 @@ const pako = require('pako');
 exports.LIB_DEPS_PATH = '.studio/libdeps';
 var Dependencies;
 (function (Dependencies) {
-    var isLibraryProject = manifest_1.Manifest.isLibraryProject;
     /**
      * Just combine all dependencies in one object
      * Optional devDependencies can be excluded
@@ -323,7 +322,7 @@ var Dependencies;
             }
         }
         // add current project file if it is a library project
-        if (isLibraryProject(manifest)) {
+        if (manifest_1.Manifest.isLibrary(manifest)) {
             const incPath = vscode_uri_1.Utils.joinPath(cwd, defaultApmPath, `${manifest.name}.${includeExtension}`);
             if (await fs.stat(incPath)) {
                 apmDependencies.push({

package/out/dlo/preCompiler.js

@@ -111,7 +111,7 @@ class DloPreCompiler {
                 // console.log('MANGLED LIB', baseName, mangleDDEFunctions);
             }
         }
-        else if (manifest_1.Manifest.isLibraryProject(manifest) && baseName === `${manifest.name}.inc`) {
+        else if (manifest_1.Manifest.isLibrary(manifest) && baseName === `${manifest.name}.inc`) {
             mangleDDEFunctions = helper_1.Helper.generateHashForLibraryName(manifest.name);
             // console.log('MANGLED PROJECT LIB', baseName, mangleDDEFunctions);
         }

package/out/globals.js

@@ -63,7 +63,7 @@ var Globals;
             }
         }
         // load the library projects specific ini file
-        if (manifest_1.Manifest.isLibraryProject(manifest)) {
+        if (manifest_1.Manifest.isLibrary(manifest)) {
             const libIni = vscode_uri_1.Utils.joinPath(cwd, defaultFiles_1.DefaultFiles.filePaths.dlo.path, `${manifest.name}.ini`);
             if (await fs.stat(libIni)) {
                 const iniContent = await readIniFile(fs, libIni);

package/out/manifest.js

@@ -13,7 +13,6 @@ const globals_1 = require("./globals");
 const preload_1 = __importDefault(require("semver/preload"));
 const DeviceProfiles_1 = require("./DeviceProfiles");
 var isNumeric = helper_1.Helper.isNumeric;
-const STUDIO_JSON_NAME = 'studio.json';
 // Cache to reduce the disk read requests
 const manifestCache = {
     _manifest: null,
@@ -39,6 +38,18 @@ const manifestCache = {
 var Manifest;
 (function (Manifest) {
     var convertBlobToString = helper_1.Helper.convertBlobToString;
+    /**
+     * The source filename where the information is stored in
+     */
+    Manifest.fileName = 'studio.json';
+    /**
+     * Type of the iot app project
+     */
+    let ProjectTypes;
+    (function (ProjectTypes) {
+        ProjectTypes["app"] = "app";
+        ProjectTypes["library"] = "library";
+    })(ProjectTypes = Manifest.ProjectTypes || (Manifest.ProjectTypes = {}));
     let BloAccessLevel;
     (function (BloAccessLevel) {
         BloAccessLevel["restricted"] = "restricted";
@@ -55,7 +66,7 @@ var Manifest;
      * @param fs
      */
     async function read(cwd, fs) {
-        const manifestUri = vscode_uri_1.Utils.joinPath(cwd, STUDIO_JSON_NAME);
+        const manifestUri = vscode_uri_1.Utils.joinPath(cwd, Manifest.fileName);
         const manifestStat = await fs.stat(manifestUri);
         // if the manifest was modified, reload the cache
         if (manifestCache.manifest === null ||
@@ -77,7 +88,7 @@ var Manifest;
      * @param fs
      */
     async function readAsBlob(cwd, fs) {
-        return await fs.readFile(vscode_uri_1.Utils.joinPath(cwd, STUDIO_JSON_NAME));
+        return await fs.readFile(vscode_uri_1.Utils.joinPath(cwd, Manifest.fileName));
     }
     Manifest.readAsBlob = readAsBlob;
     /**
@@ -91,16 +102,21 @@ var Manifest;
         // patch the options if they are not valid for a specific device profile
         patchDloCompileOptionsBasedOnDpid(manifest);
         removeDeprecatedOptions(manifest);
-        return fs.writeFile(vscode_uri_1.Utils.joinPath(cwd, STUDIO_JSON_NAME), JSON.stringify(manifest, null, '\t'));
+        return fs.writeFile(vscode_uri_1.Utils.joinPath(cwd, Manifest.fileName), JSON.stringify(manifest, null, '\t'));
     }
     Manifest.write = write;
     /**
      * Check if the current project is a library project
      */
-    function isLibraryProject(manifest) {
-        return !!manifest.library;
+    function isLibrary(manifest) {
+        if (manifest.library !== undefined) {
+            return manifest.library;
+        }
+        else {
+            return manifest.type === ProjectTypes.library;
+        }
     }
-    Manifest.isLibraryProject = isLibraryProject;
+    Manifest.isLibrary = isLibrary;
     /**
      * Validates if the properties within
      * @param cwd
@@ -194,6 +210,9 @@ var Manifest;
         if (allowedBackends === undefined) {
             return 'Allowed backends not specified yet';
         }
+        if (allowedBackends === null) {
+            return null;
+        }
         if (Array.isArray(allowedBackends) || allowedBackends?.includes(';')) {
             const validationArray = allowedBackends?.includes(';') ? allowedBackends.split(';') : allowedBackends;
             for (const domain of validationArray) {
@@ -292,7 +311,7 @@ function validateHwFwOrProductId(manifest) {
  * @param env
  */
 function validateProjectVersion(manifest, env) {
-    if (env === globals_1.Globals.ENV.lucky || Manifest.isLibraryProject(manifest)) {
+    if (env === globals_1.Globals.ENV.lucky || Manifest.isLibrary(manifest)) {
         if (!preload_1.default.valid(manifest.version)) {
             throw new Error('"version" has to be a semantic version string!"');
         }

package/out/package/apm.js

@@ -96,6 +96,7 @@ var APM;
     async function createBuffer(cwd, fs, manifest, tagHeader) {
         const apmBuffer = new FormData();
         apmBuffer.append('tag', JSON.stringify(tagHeader));
+        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))]);
@@ -257,5 +258,7 @@ async function addAdditionalFiles(cwd, fs, apmBuffer) {
         const reportTemplateBlob = new Blob([await fs.readFile(reportTemplate)]);
         apmBuffer.append(`bin/pov/mdn_report_template.json`, reportTemplateBlob);
     }
+    const historyPath = vscode_uri_1.Utils.joinPath(cwd, defaultFiles_1.DefaultFiles.filePaths.dist.historyJson);
+    apmBuffer.append(`src/dde/${manifest_1.Manifest.fileName}`, new Blob([await fs.readFile(historyPath)]));
 }
 //# sourceMappingURL=apm.js.map

package/out/package/package.js

@@ -51,7 +51,7 @@ var Package;
      */
     async function release(cwd, fs, token, releasePhase, env = globals_1.Globals.ENV.production) {
         const manifest = await manifest_1.Manifest.read(cwd, fs);
-        if (manifest_1.Manifest.isLibraryProject(manifest)) {
+        if (manifest_1.Manifest.isLibrary(manifest)) {
             await releaseLibrary(cwd, fs, token, env);
         }
         else {
@@ -155,7 +155,7 @@ var Package;
     async function validatePublishSettings(cwd, fs, token) {
         const manifest = await manifest_1.Manifest.read(cwd, fs);
         const { name, publisher, description } = manifest;
-        const invalidName = manifest_1.Manifest.validateProjectName(name, manifest_1.Manifest.isLibraryProject(manifest));
+        const invalidName = manifest_1.Manifest.validateProjectName(name, manifest_1.Manifest.isLibrary(manifest));
         if (invalidName) {
             throw new Error(`name: ${invalidName}`);
         }
@@ -168,7 +168,7 @@ var Package;
             throw new Error(`publisher: ${invalidPublisher}`);
         }
         // only validate if the project is not a library project
-        if (!manifest_1.Manifest.isLibraryProject(manifest)) {
+        if (!manifest_1.Manifest.isLibrary(manifest)) {
             await manifest_1.Manifest.validateApplicationIcon(cwd, fs, manifest);
             manifest_1.Manifest.validateEngineSettings(manifest);
         }
@@ -198,7 +198,11 @@ async function buildDDE(cwd, fs) {
     throwIfDiagnosticsHaveError(apm_1.APM.Part.dde, result.diagnostics);
     if (result.ddeJSON) {
         await dde_1.DDE.exportMyDatanetXML(cwd, fs, result.ddeJSON);
-        await dde_1.DDE.exportHistoryJson(cwd, fs, result.ddeJSON);
+        const manifest = await manifest_1.Manifest.read(cwd, fs);
+        // a library does not need a history.json
+        if (!manifest_1.Manifest.isLibrary(manifest)) {
+            await dde_1.DDE.exportHistoryJson(cwd, fs, result.ddeJSON);
+        }
         await dde_1.DDE.exportOpenApi(cwd, fs, result.ddeJSON);
         await dde_1.DDE.exportAutoDloFiles(cwd, fs, result.ddeJSON);
         await dlo_1.DLO.exportDloConfig(cwd, fs);

package/package.json

@@ -1,76 +1,76 @@
-{
-	"name": "@microtronics/studio-cli",
-	"version": "0.15.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.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
+	}
+}