@microtronics/studio-cli 0.13.0 → 0.15.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 
 
+## 0.15.0 (2025-01-31)
+
+
+### Features
+
+* **studio-cli:** removed `allowedBackends` and `target` from manifest.registry ([99398ae](https://bitbucket.org/microtronics-core/vscode-studio/commits/99398ae8e475946204d49045b8fff83c2f013e6d))
+
+## 0.14.0 (2025-01-29)
+
+
+### Features
+
+* **studio-core:** allow editing the release notes of iot app versions ([2d19d13](https://bitbucket.org/microtronics-core/vscode-studio/commits/2d19d13ca32cceaf4a574a9594563d6dc0931fc5))
+
 ## 0.13.0 (2025-01-29)
 
 

package/dist/studio-cli.d.ts

@@ -175,15 +175,11 @@ declare interface components {
             targetSystem: components["schemas"]["TargetSystem"];
             /** @description ONE specific parameter for the organizationId */
             organizationId?: string;
-            /**
-             * @description Defines which servers are allowed to see this application. If null, the application wont be shared with anyone
-             * @default null
-             */
-            allowedBackends: ("*" | string[]) | null;
+            /** @description Defines which servers are allowed to see this application. If null, the application wont be shared with anyone */
+            allowedBackends?: ("*" | string[]) | null;
         };
         ApplicationInformationBase: {
-            /** @description The actual released version of the application */
-            version: number;
+            version: components["parameters"]["ApplicationVersion"];
             publisherId: components["parameters"]["PublisherId"];
         } & components["schemas"]["NewApplication"];
         ApplicationListInformation: {
@@ -200,8 +196,7 @@ declare interface components {
         ApplicationVersion: {
             /** @description The name of the application when this version wos released */
             name: string;
-            /** @description The version number */
-            version: number;
+            version: components["parameters"]["ApplicationVersion"];
             /**
              * Format: date-time
              * @description Date when this version was published
@@ -1944,6 +1939,13 @@ export declare namespace Helper {
      * @param arrayIndex
      */
     export function patchValueWithArrayInfo(valueToPatch: any, arrayIndex: number): any;
+    /**
+     * Defer a given named task
+     * @param token
+     * @param timeout Milliseconds
+     * @param callback Callback
+     */
+    export function defer(token: string, timeout: number, callback: any): void;
 }
 
 export declare namespace Library {
@@ -2042,7 +2044,14 @@ export declare namespace Manifest {
         };
         registry?: {
             id?: string;
-            allowedBackends?: null | '*' | string[];
+            /**
+             * @deprecated
+             */
+            allowedBackends?: Registry.ApiNewApplication['allowedBackends'];
+            /**
+             * @deprecated
+             */
+            target?: Registry.ApiNewApplication['targetSystem'];
         };
         pov?: {
             details?: ApmPartScripts;
@@ -3358,7 +3367,7 @@ declare interface paths {
         patch?: never;
         trace?: never;
     };
-    "/packages/{publisherId}/applications/{applicationId}/versions/{applicationVersion}/files/{fileName}": {
+    "/packages/{publisherId}/applications/{applicationId}/versions/{applicationVersion}/files/{applicationFileName}": {
         parameters: {
             query?: never;
             header?: never;
@@ -4234,7 +4243,7 @@ export declare namespace Registry {
      * @param libraryId
      */
     export function getLibraryProfile(token: AuthToken, publisherId: string, libraryId: string): Promise<LibraryProfile>;
-    export function fetchLibraryContent(token: AuthToken, contentURL: string, json?: boolean): Promise<any>;
+    export function fetchCustomContent(token: AuthToken, contentURL: string, json?: boolean, env?: Globals.ENV): Promise<ArrayBuffer | any>;
     export type Publisher = components['schemas']['Publisher'];
     export function getPublisher(token: AuthToken, publisherId: string): Promise<Publisher | null>;
     export type ApiNewApplication = components['schemas']['NewApplication'];
@@ -4251,6 +4260,8 @@ export declare namespace Registry {
         'CHANGELOG.md': Uint8Array;
     };
     export function publishLibraryVersion(token: AuthToken, publisherId: string, libraryId: string, libraryVersion: string, files: LibraryFiles, env?: Globals.ENV): Promise<void>;
+    export type ApplicationFileName = components['parameters']['ApplicationFileName'];
+    export function updateApplicationFile(token: AuthToken, publisherId: string, applicationId: string, applicationVersion: string, applicationFileName: ApplicationFileName, blob: Uint8Array, env?: Globals.ENV): Promise<void>;
 }
 
 declare function uriToMemFsPath(path: URI): string;

package/out/dependencies.js

@@ -237,7 +237,7 @@ var Dependencies;
         if (!libraryArchive) {
             throw new Error(`Library ${publisherIdName} has no content!`);
         }
-        const libraryBuffer = await registryAPI_1.Registry.fetchLibraryContent(token, libraryArchive.downloadUrl);
+        const libraryBuffer = await registryAPI_1.Registry.fetchCustomContent(token, libraryArchive.downloadUrl);
         await extractLibraryContent(cwd, fs, libraryName, libraryBuffer);
         // update manifest
         const manifest = await manifest_1.Manifest.read(cwd, fs);
@@ -337,7 +337,7 @@ var Dependencies;
     Dependencies.getApmPartDependencies = getApmPartDependencies;
 })(Dependencies || (exports.Dependencies = Dependencies = {}));
 async function fetchStudioJson(token, studioJsonURL) {
-    return await registryAPI_1.Registry.fetchLibraryContent(token, studioJsonURL, true);
+    return await registryAPI_1.Registry.fetchCustomContent(token, studioJsonURL, true);
 }
 async function validateIfLibraryCanBeRemoved(cwd, fs, dependencies) {
     const allLibraries = {};

package/out/helper.js

@@ -119,5 +119,27 @@ var Helper;
         }
     }
     Helper.patchValueWithArrayInfo = patchValueWithArrayInfo;
+    const _deferrals = {}; // <token>:{ handler:func, tmr:timeoutHandle }
+    /**
+     * Defer a given named task
+     * @param token
+     * @param timeout Milliseconds
+     * @param callback Callback
+     */
+    function defer(token, timeout, callback) {
+        const d = _deferrals[token];
+        if (d) {
+            clearTimeout(d.timer);
+        }
+        _deferrals[token] = {
+            // @ts-ignore
+            timer: setTimeout(() => {
+                delete _deferrals[token];
+                callback();
+            }, timeout),
+            handler: callback
+        };
+    }
+    Helper.defer = defer;
 })(Helper || (exports.Helper = Helper = {}));
 //# sourceMappingURL=helper.js.map

package/out/manifest.js

@@ -90,6 +90,7 @@ var Manifest;
         manifestCache.clear();
         // 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'));
     }
     Manifest.write = write;
@@ -328,4 +329,10 @@ function patchDloCompileOptionsBasedOnDpid(manifest) {
         });
     }
 }
+function removeDeprecatedOptions(manifest) {
+    if (manifest.registry) {
+        delete manifest.registry.allowedBackends;
+        delete manifest.registry.target;
+    }
+}
 //# sourceMappingURL=manifest.js.map

package/out/package/apm.js

@@ -173,12 +173,12 @@ var APM;
     async function registerNew(cwd, fs, token, manifest, env) {
         // only myDatanet -> ONE support not needed.
         const backendTarget = 'myDatanet';
-        const { publisher, name, description, registry } = manifest;
+        const { publisher, name, description } = manifest;
         const newApplication = {
             name: name,
             targetSystem: backendTarget,
             description: description || '',
-            allowedBackends: registry?.allowedBackends ?? null
+            allowedBackends: null
         };
         // create new application
         const projectId = await registryAPI_1.Registry.createNewApplication(token, publisher, newApplication, env);
@@ -186,8 +186,7 @@ var APM;
             throw new Error('Failed to initialize application');
         }
         manifest.registry = {
-            id: projectId,
-            allowedBackends: newApplication.allowedBackends
+            id: projectId
         };
         // write the updated manifest to disk
         await manifest_1.Manifest.write(cwd, fs, manifest);
@@ -206,8 +205,6 @@ var APM;
         const { name, publisher, description, registry } = await manifest_1.Manifest.read(cwd, fs);
         const applicationId = registry?.id;
         await registryAPI_1.Registry.updateExistingApplication(token, publisher, applicationId, {
-            // @ts-ignore
-            allowedBackends: registry.allowedBackends,
             description: description,
             name: name,
             targetSystem: 'myDatanet'

package/out/package/package.js

@@ -154,7 +154,7 @@ var Package;
      */
     async function validatePublishSettings(cwd, fs, token) {
         const manifest = await manifest_1.Manifest.read(cwd, fs);
-        const { name, publisher, description, registry } = manifest;
+        const { name, publisher, description } = manifest;
         const invalidName = manifest_1.Manifest.validateProjectName(name, manifest_1.Manifest.isLibraryProject(manifest));
         if (invalidName) {
             throw new Error(`name: ${invalidName}`);
@@ -171,10 +171,6 @@ var Package;
         if (!manifest_1.Manifest.isLibraryProject(manifest)) {
             await manifest_1.Manifest.validateApplicationIcon(cwd, fs, manifest);
             manifest_1.Manifest.validateEngineSettings(manifest);
-            const invalidBackends = await manifest_1.Manifest.validateRegistryAllowedBackends(registry?.allowedBackends);
-            if (invalidBackends) {
-                throw new Error(`registry: ${invalidBackends}`);
-            }
         }
     }
     Package.validatePublishSettings = validatePublishSettings;

package/out/registryAPI.js

@@ -48,9 +48,13 @@ var Registry;
         return data;
     }
     Registry.getLibraryProfile = getLibraryProfile;
-    async function fetchLibraryContent(token, contentURL, json = false) {
+    async function fetchCustomContent(token, contentURL, json = false, env = globals_1.Globals.ENV.production) {
         const response = await fetch(contentURL, {
-            headers: { ...buildAuthHeader(token) }
+            // @ts-ignore
+            headers: {
+                ...buildAuthHeader(token),
+                ...headerBasedOnEnv(env)
+            }
         });
         if (response.status === 200) {
             if (json) {
@@ -64,7 +68,7 @@ var Registry;
             throw new Error('Failed to fetch the library content');
         }
     }
-    Registry.fetchLibraryContent = fetchLibraryContent;
+    Registry.fetchCustomContent = fetchCustomContent;
     async function getPublisher(token, publisherId) {
         try {
             const { data, error } = await GET('/publisher/{publisherId}', {
@@ -240,6 +244,33 @@ var Registry;
         }
     }
     Registry.publishLibraryVersion = publishLibraryVersion;
+    async function updateApplicationFile(token, publisherId, applicationId, applicationVersion, applicationFileName, blob, env = globals_1.Globals.ENV.production) {
+        const { error } = await POST('/packages/{publisherId}/applications/{applicationId}/versions/{applicationVersion}/files/{applicationFileName}', {
+            ...Registry.getAPIUrl(),
+            headers: {
+                ...buildAuthHeader(token),
+                ...headerBasedOnEnv(env),
+                'Content-Type': 'application/octet-stream'
+            },
+            params: {
+                path: {
+                    publisherId,
+                    applicationId,
+                    applicationVersion,
+                    applicationFileName
+                }
+            },
+            //@ts-ignore
+            body: {},
+            bodySerializer() {
+                return blob;
+            }
+        });
+        if (error) {
+            throw new Error(error.reason);
+        }
+    }
+    Registry.updateApplicationFile = updateApplicationFile;
 })(Registry || (exports.Registry = Registry = {}));
 /**
  * inject the X-Semver header for application based requests

package/package.json

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