@microtronics/studio-cli 0.33.0 → 0.35.0

package/CHANGELOG.md

@@ -1,12 +1,27 @@
 # Changelog
 
-## 0.33.0 (2025-09-01)
+## 0.35.0 (2025-09-12)
 
-### Features
+### Bug Fixes
 
-* **cli:** add description to CLI tool usage ([97e8562](https://bitbucket.org/microtronics-core/vscode-studio/commits/97e85625a7c6d11070e2713f3ec3d2c24691854a))
-* **cli:** add support for parsing unknown long options ([fa6523c](https://bitbucket.org/microtronics-core/vscode-studio/commits/fa6523caef791d508b31ed5d563452b616e99ae0))
-* **cli:** support custom ini file in manifest ([5ae2741](https://bitbucket.org/microtronics-core/vscode-studio/commits/5ae2741ad379258fee95311fd28acc8b3dd1bdb6))
+* **cli:** expected test fixtures ([0edb940](https://bitbucket.org/microtronics-core/vscode-studio/commits/0edb940c79aacb0cc631786f141e3cb28ff5cb78))
+* **cli:** replaced shallow clones with structured clones for API method objects ([f8b3a88](https://bitbucket.org/microtronics-core/vscode-studio/commits/f8b3a88b5a81ad3aa5d422a7f36ea1055068b921))
+
+## 0.34.0 (2025-09-12)
+
+### Features
+
+* **cli:** add App Center routing support in API generator ([6586c8b](https://bitbucket.org/microtronics-core/vscode-studio/commits/6586c8bee9a9bdf0a803b5c0e33d04fa22092d8e))
+* **cli:** add support for analytics project type in manifest ([ff0f354](https://bitbucket.org/microtronics-core/vscode-studio/commits/ff0f354f3d95028a889ca87495b24ad36800b1b1))
+* **cli:** enhance path generation for analytics projects ([bb0936a](https://bitbucket.org/microtronics-core/vscode-studio/commits/bb0936afdb385cc67569305c1363617df19b258a))
+
+## 0.33.0 (2025-09-01)
+
+### Features
+
+* **cli:** add description to CLI tool usage ([97e8562](https://bitbucket.org/microtronics-core/vscode-studio/commits/97e85625a7c6d11070e2713f3ec3d2c24691854a))
+* **cli:** add support for parsing unknown long options ([fa6523c](https://bitbucket.org/microtronics-core/vscode-studio/commits/fa6523caef791d508b31ed5d563452b616e99ae0))
+* **cli:** support custom ini file in manifest ([5ae2741](https://bitbucket.org/microtronics-core/vscode-studio/commits/5ae2741ad379258fee95311fd28acc8b3dd1bdb6))
 * **cli:** support manifest overwrites with deep merge ([10b69e2](https://bitbucket.org/microtronics-core/vscode-studio/commits/10b69e29c9426bec08022610b66e85b86cee79c9))
 
 ## 0.32.3 (2025-06-11)

package/dist/studio-cli.d.ts

@@ -1166,7 +1166,7 @@ export declare namespace DDE {
      * @param ddeHistory
      * @constructor
      */
-    const PreCompiler: (libraries: DDE_Core.LibraryFile[], ddeHistory: HistoryJson | null) => YamlPreCompiler.PreCompiler;
+    const PreCompiler: (manifest: Manifest.Manifest, libraries: DDE_Core.LibraryFile[], ddeHistory: HistoryJson | null) => YamlPreCompiler.PreCompiler;
     /**
      * File Generators
      */
@@ -2171,7 +2171,8 @@ export declare namespace Manifest {
     export enum ProjectTypes {
         app = "app",
         library = "library",
-        addon = "addon"
+        addon = "addon",
+        analytics = "analytics"
     }
     export interface Manifest {
         version: string;
@@ -2270,6 +2271,11 @@ export declare namespace Manifest {
      * @param manifest
      */
     export function isApp(manifest: Manifest.Manifest): boolean;
+    /**
+     * Check if the current project is an analytics project
+     * @param manifest
+     */
+    export function isAnalytics(manifest: Manifest.Manifest): boolean;
     /**
      * Validates if the properties within
      * @param cwd
@@ -4714,13 +4720,14 @@ declare interface XMLField {
 
 declare namespace YamlPreCompiler {
     class PreCompiler {
+        private manifest;
         private libraryFiles;
         private ddeHistory;
         private readonly fieldNamesPerContainer;
         private readonly usedContainerNames;
         private fileDiagnostics;
         private readonly libraryDDE;
-        constructor(libraryFiles: DDE_Core.LibraryFile[], ddeHistory: DDE.HistoryJson | null);
+        constructor(manifest: Manifest.Manifest, libraryFiles: DDE_Core.LibraryFile[], ddeHistory: DDE.HistoryJson | null);
         /**
          * Parse the given library files and return the diagnostics
          */
@@ -4732,10 +4739,12 @@ declare namespace YamlPreCompiler {
             diagnostics: Diagnostics.File[];
         };
         /**
-         * Parse a given yaml file
-         * @param filePath
-         * @param yaml
-         * @param libraryName
+         * Parses a YAML file and validates its content to produce a structured JSON object along with diagnostic information.
+         *
+         * @param filePath The URI of the YAML file being parsed.
+         * @param yaml The raw YAML content to parse.
+         * @param libraryName An optional parameter specifying the library name for additional validation.
+         * @return An object containing the parsed DDE JSON and an array of diagnostic messages related to the file.
          */
         parseYamlFile(filePath: URI, yaml: string, libraryName?: string): {
             parsedDDE: DDEJson;

package/out/dde/dde.js

@@ -93,9 +93,10 @@ var DDE;
      * @param fileName
      */
     async function compileDDE(cwd, fs, logger, fileName = defaultFiles_1.DefaultFiles.fileNames.mainDDE) {
+        const manifest = await manifest_1.Manifest.read(cwd, fs);
         const validated = await validate(cwd, fs, logger, fileName);
         const historyJson = await getHistoryJson(cwd, fs, logger);
-        const preCompiler = new yamlDdePreCompiler_1.YamlPreCompiler.PreCompiler(validated.libraryFiles, historyJson);
+        const preCompiler = new yamlDdePreCompiler_1.YamlPreCompiler.PreCompiler(manifest, validated.libraryFiles, historyJson);
         const libraryDiagnostics = preCompiler.parseLibraries();
         const librariesHaveError = libraryDiagnostics.find(diagnostics => diagnostics.level === 'error');
         if (librariesHaveError) {
@@ -137,8 +138,8 @@ var DDE;
      * @param ddeHistory
      * @constructor
      */
-    DDE.PreCompiler = (libraries, ddeHistory) => {
-        return new yamlDdePreCompiler_1.YamlPreCompiler.PreCompiler(libraries, ddeHistory);
+    DDE.PreCompiler = (manifest, libraries, ddeHistory) => {
+        return new yamlDdePreCompiler_1.YamlPreCompiler.PreCompiler(manifest, libraries, ddeHistory);
     };
     /**
      * File Generators

package/out/dde/fileGenerators/api.js

@@ -33,6 +33,7 @@ var fieldTypeDefinitions = coreDefinitions_1.DDE_Core.fieldTypeDefinitions;
 const manifest_1 = require("../../manifest");
 const contextIdRef = { $ref: '#/components/parameters/contextId' };
 const addonIdRef = { $ref: '#/components/parameters/addonId' };
+const appIdRef = { $ref: '#/components/parameters/appId' };
 const histdataResponseRef = { $ref: '#/components/schemas/histdataResponse' };
 const histdataRequestRef = { $ref: '#/components/schemas/histdataRequest' };
 const rapidM2MStampRef = { $ref: '#/components/schemas/rapidM2MStamp' };
@@ -52,6 +53,15 @@ const defaultComponents = {
                 type: 'string'
             },
             required: true
+        },
+        appId: {
+            name: 'appUid',
+            in: 'path',
+            description: 'The app uid',
+            schema: {
+                type: 'string'
+            },
+            required: true
         }
     },
     schemas: {
@@ -182,6 +192,7 @@ function generateAPIFromMap(ddeMap, manifest, context = null) {
         Object.assign(apiDescription.components, structuredClone(defaultAppComponents));
     }
     const isAddon = manifest_1.Manifest.isAddon(manifest);
+    const isAnalytics = manifest_1.Manifest.isAnalytics(manifest);
     if (isAddon) {
         // add addonUid parameter if this is an addon project
         apiDescription.components.parameters['addonId'] = {
@@ -203,13 +214,17 @@ function generateAPIFromMap(ddeMap, manifest, context = null) {
         }
         generateTagDescriptionFromContainer(apiDescription, containerDefinition);
         generateSchemasFromContainer(apiDescription, containerDefinition, context);
-        generatePathInformationFromContainer(apiDescription, containerDefinition, isAddon);
+        generatePathInformationFromContainer(apiDescription, containerDefinition, isAddon, isAnalytics);
         // legacy routes
-        if (!isAddon) {
+        if (!isAddon && !isAnalytics) {
             generateLegacySchemasFromContainer(apiDescription, containerDefinition, context);
             generateLegacyPathInformationFromContainer(apiDescription, containerDefinition);
         }
     }
+    apiDescription.tags.push({
+        name: 'app-center',
+        description: 'App Center related routes'
+    });
     return (0, yaml_1.stringify)(apiDescription);
 }
 function generateTagDescriptionFromContainer(apiDescription, containerDefinition) {
@@ -451,23 +466,45 @@ function generateLegacyPathInformationFromContainer(apiDescription, containerDef
     }
     apiDescription.paths[apiPath] = apiPathMethods;
 }
-function generatePathInformationFromContainer(apiDescription, containerDefinition, isAddonProject = false) {
+function generatePathInformationFromContainer(apiDescription, containerDefinition, isAddonProject = false, isAnalyticsProject = false) {
     const isTimeseriesContainer = containerDefinition.containerType === ContainerType.hx;
     const containerType = isTimeseriesContainer ? 'timeseries' : 'containers';
-    const pathParameters = [contextIdRef];
-    let apiPath = `/api/1/sites/{siteUid}/${containerType}/${containerDefinition.title}`;
+    let apiPathOptions = [];
+    const containerRouteTagName = tagNameFromContainerTitle(containerDefinition.title);
+    // analytic projects do not have any site
+    if (!isAnalyticsProject) {
+        apiPathOptions.push({
+            path: `/api/1/sites/{siteUid}/${containerType}/${containerDefinition.title}`,
+            params: [contextIdRef],
+            tags: [containerRouteTagName]
+        });
+    }
     if (isAddonProject) {
-        apiPath = `/api/1/sites/{siteUid}/addons/{addonUid}/${containerType}/${containerDefinition.title}`;
-        pathParameters.push(addonIdRef);
+        apiPathOptions = [
+            {
+                path: `/api/1/sites/{siteUid}/addons/{addonUid}/${containerType}/${containerDefinition.title}`,
+                params: [addonIdRef],
+                tags: [containerRouteTagName]
+            }
+        ];
+    }
+    const appCenterPathOptions = {
+        path: `/api/1/app-center/apps/{appUid}/${containerType}/${containerDefinition.title}`,
+        params: [appIdRef],
+        tags: ['app-center']
+    };
+    if (isAnalyticsProject) {
+        appCenterPathOptions.tags.push(containerRouteTagName);
     }
+    apiPathOptions.push(appCenterPathOptions);
     const apiPathMethods = {
         get: undefined,
         put: undefined
     };
     const getMethod = {
-        tags: [tagNameFromContainerTitle(containerDefinition.title)],
+        tags: [],
         summary: `Retrieve the data of the "${tagNameFromContainerTitle(containerDefinition.title)}" container`,
-        parameters: [...pathParameters],
+        parameters: [],
         responses: {
             '200': {
                 ...successfulOperationResponse,
@@ -498,9 +535,9 @@ function generatePathInformationFromContainer(apiDescription, containerDefinitio
         apiPathMethods.get = getMethod;
         if ([TransferDirection.down, TransferDirection.backendOnly].includes(containerDefinition.transferDirection)) {
             apiPathMethods.put = {
-                tags: [tagNameFromContainerTitle(containerDefinition.title)],
+                tags: [],
                 summary: `Modify the data of the "${tagNameFromContainerTitle(containerDefinition.title)}" container`,
-                parameters: [...pathParameters],
+                parameters: [],
                 requestBody: {
                     content: {
                         'application/json': {
@@ -521,14 +558,20 @@ function generatePathInformationFromContainer(apiDescription, containerDefinitio
                 }
             };
         }
-        apiDescription.paths[apiPath] = apiPathMethods;
+        apiPathOptions.forEach(path => {
+            const methods = structuredClone(apiPathMethods);
+            Object.values(methods).forEach(value => {
+                value?.parameters?.unshift(...path.params);
+                value?.tags?.unshift(...path.tags);
+            });
+            apiDescription.paths[path.path] = methods;
+        });
     }
     if (containerDefinition.containerType === ContainerType.hx) {
         apiPathMethods.get = {
-            tags: [tagNameFromContainerTitle(containerDefinition.title)],
+            tags: [],
             summary: `Get the historical data of "${containerDefinition.title}"`,
             parameters: [
-                ...pathParameters,
                 {
                     name: 'json',
                     in: 'query',
@@ -555,16 +598,23 @@ function generatePathInformationFromContainer(apiDescription, containerDefinitio
                 ...defaultResponseCodes
             }
         };
-        apiDescription.paths[apiPath] = apiPathMethods;
-        const youngestPath = `${apiPath}/youngest`;
+        // only site and addons support timeseries
+        const pathOptions = apiPathOptions[0];
+        const methods = structuredClone(apiPathMethods);
+        Object.values(methods).forEach(value => {
+            value?.parameters?.unshift(...pathOptions.params);
+            value?.tags?.unshift(...pathOptions.tags);
+        });
+        apiDescription.paths[pathOptions.path] = methods;
+        const youngestPath = `${pathOptions.path}/youngest`;
         const youngestMethod = {
-            get: getMethod
+            get: structuredClone(methods.get)
         };
         youngestMethod.get.summary = `Get the youngest record of "${containerDefinition.title}" container`;
         apiDescription.paths[youngestPath] = youngestMethod;
-        const oldestPath = `${apiPath}/oldest`;
+        const oldestPath = `${pathOptions.path}/oldest`;
         const oldestMethod = {
-            get: getMethod
+            get: structuredClone(methods.get)
         };
         oldestMethod.get.summary = `Get the oldest record of "${containerDefinition.title}" container`;
         apiDescription.paths[oldestPath] = oldestMethod;

package/out/dde/yamlDdePreCompiler.js

@@ -18,16 +18,19 @@ var CONFIG_CONTAINER = coreDefinitions_1.DDE_Core.CONFIG_CONTAINER;
 var TransferDirection = coreDefinitions_1.DDE_Core.TransferDirection;
 var fieldTypeDefinitions = coreDefinitions_1.DDE_Core.fieldTypeDefinitions;
 var yamlRangeToLineInformation = helper_1.Helper.yamlRangeToLineInformation;
+const api_1 = require("../api");
 var YamlPreCompiler;
 (function (YamlPreCompiler) {
     class PreCompiler {
+        manifest;
         libraryFiles;
         ddeHistory;
         fieldNamesPerContainer = {};
         usedContainerNames = {};
         fileDiagnostics = [];
         libraryDDE = [];
-        constructor(libraryFiles, ddeHistory) {
+        constructor(manifest, libraryFiles, ddeHistory) {
+            this.manifest = manifest;
             this.libraryFiles = libraryFiles;
             this.ddeHistory = ddeHistory;
         }
@@ -63,10 +66,12 @@ var YamlPreCompiler;
             return { ddeJSON: mergedDDE, diagnostics };
         }
         /**
-         * Parse a given yaml file
-         * @param filePath
-         * @param yaml
-         * @param libraryName
+         * Parses a YAML file and validates its content to produce a structured JSON object along with diagnostic information.
+         *
+         * @param filePath The URI of the YAML file being parsed.
+         * @param yaml The raw YAML content to parse.
+         * @param libraryName An optional parameter specifying the library name for additional validation.
+         * @return An object containing the parsed DDE JSON and an array of diagnostic messages related to the file.
          */
         parseYamlFile(filePath, yaml, libraryName) {
             this.fileDiagnostics.length = 0;
@@ -444,6 +449,16 @@ var YamlPreCompiler;
                     ...yamlRangeToLineInformation(lineCounter, container.key.range)
                 });
             }
+            if (api_1.Manifest.isAnalytics(this.manifest) &&
+                ![DDEContainerName.relations, DDEContainerName.storage].includes(containerName)) {
+                const invalidName = containerName.includes('_') ? containerName.split('_')[1] : containerName;
+                this.fileDiagnostics.push({
+                    file: sourceUri,
+                    level: 'error',
+                    message: `"${invalidName}" not allowed within an analytics app. Only "relations" and "storage" are allowed.`,
+                    ...yamlRangeToLineInformation(lineCounter, container.key.range)
+                });
+            }
         }
         validateContainerFields(yamlDoc, sourceUri, container, lineCounter) {
             const containerFields = container.value; //(container.value as YAMLMap).get('fields', true);

package/out/manifest.js

@@ -16,6 +16,7 @@ const deepmerge_ts_1 = require("deepmerge-ts");
 const PRODUCT_ID_SUPPORTED = '52v007';
 const SEMVER_SUPPORTED = '53v001';
 const ADDON_SUPPORTED = '54v001';
+const ANALYTICS_SUPPORTED = '56v001';
 // Cache to reduce the disk read requests
 const manifestCache = {
     _manifest: null,
@@ -66,6 +67,7 @@ var Manifest;
         ProjectTypes["app"] = "app";
         ProjectTypes["library"] = "library";
         ProjectTypes["addon"] = "addon";
+        ProjectTypes["analytics"] = "analytics";
     })(ProjectTypes = Manifest.ProjectTypes || (Manifest.ProjectTypes = {}));
     let BloAccessLevel;
     (function (BloAccessLevel) {
@@ -156,6 +158,14 @@ var Manifest;
         return manifest.type === ProjectTypes.app;
     }
     Manifest.isApp = isApp;
+    /**
+     * Check if the current project is an analytics project
+     * @param manifest
+     */
+    function isAnalytics(manifest) {
+        return manifest.type === ProjectTypes.analytics;
+    }
+    Manifest.isAnalytics = isAnalytics;
     /**
      * Validates if the properties within
      * @param cwd
@@ -327,7 +337,7 @@ var Manifest;
             throw new Error('Setting "engines.backend" is invalid');
         }
         validateHwFwOrProductId(manifest);
-        validateAddonSupported(manifest);
+        validateAddonOrAnalyticsSupported(manifest);
     }
     Manifest.validateEngineSettings = validateEngineSettings;
     /**
@@ -342,9 +352,10 @@ var Manifest;
             manifest = await Manifest.read(cwd, fs);
         }
         const isAddon = Manifest.isAddon(manifest);
+        const isAnalytics = Manifest.isAnalytics(manifest);
         switch (apmPart) {
             case apm_1.APM.Part.dlo:
-                return !!manifest?.dlo?.mainFile && !isAddon;
+                return !!manifest?.dlo?.mainFile && !isAddon && !isAnalytics;
             case apm_1.APM.Part.blo:
                 return !!(manifest.blo?.buildCommand && manifest.blo?.workingPath);
             case apm_1.APM.Part.pov:
@@ -403,19 +414,20 @@ function validateHwFwOrProductId(manifest) {
         throw new Error(`"engines.productId" requires "engines.backend" to be "${PRODUCT_ID_SUPPORTED}"`);
     }
 }
-function validateAddonSupported(manifest) {
-    if (!Manifest.isAddon(manifest)) {
+function validateAddonOrAnalyticsSupported(manifest) {
+    if (!Manifest.isAddon(manifest) && !Manifest.isAnalytics(manifest)) {
         return;
     }
     const { backend } = manifest.engines;
-    if (!backend || backend < ADDON_SUPPORTED) {
-        throw new Error(`Project type "addon" requires "engines.backend" to be ">=${ADDON_SUPPORTED}"`);
+    const requiredBackend = Manifest.isAddon(manifest) ? ADDON_SUPPORTED : ANALYTICS_SUPPORTED;
+    if (!backend || backend < requiredBackend) {
+        throw new Error(`Project type "${manifest.type}" requires "engines.backend" to be ">=${requiredBackend}"`);
     }
     if (manifest.dlo) {
-        throw new Error('For project type "addon", "dlo" is not supported!"');
+        throw new Error(`For project type "${manifest.type}", "dlo" is not supported!"`);
     }
     if (manifest.dpid) {
-        throw new Error('For project type "addon", "dpid" is not supported!"');
+        throw new Error(`For project type "${manifest.type}", "dpid" is not supported!"`);
     }
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@microtronics/studio-cli",
-	"version": "0.33.0",
+	"version": "0.35.0",
 	"description": "Microtronics Studio CLI Tool",
 	"main": "./out/api.js",
 	"typings": "./dist/studio-cli.d.ts",