@microtronics/studio-cli 0.61.0 → 0.62.0

package/out/manifest.js

@@ -1,492 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Manifest = void 0;
-const vscode_uri_1 = require("vscode-uri");
-const helper_1 = require("./helper");
-const image_dimensions_1 = require("image-dimensions");
-const file_type_checker_1 = require("file-type-checker");
-const registryAPI_1 = require("./registryAPI");
-const preload_1 = __importDefault(require("semver/preload"));
-const apm_1 = require("./package/apm");
-var isNumeric = helper_1.Helper.isNumeric;
-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,
-    _stat: null,
-    _overwrites: null,
-    get manifest() {
-        // clone the cached object to prevent any reference changes
-        return (0, deepmerge_ts_1.deepmerge)(structuredClone(this._manifest), manifestCache._overwrites || {});
-    },
-    set manifest(manifest) {
-        this._manifest = manifest;
-    },
-    set overwrites(manifest) {
-        this._overwrites = manifest;
-    },
-    get stat() {
-        return this._stat;
-    },
-    set stat(stat) {
-        this._stat = stat;
-    },
-    clear() {
-        this._stat = null;
-        this._manifest = null;
-    }
-};
-var Manifest;
-(function (Manifest) {
-    var convertBlobToString = helper_1.Helper.convertBlobToString;
-    /**
-     * The source filename where the information is stored in
-     */
-    Manifest.fileName = 'studio.json';
-    let DeviceProfiles;
-    (function (DeviceProfiles) {
-        DeviceProfiles["m22x"] = "m22x";
-        DeviceProfiles["m23x"] = "m23x";
-        DeviceProfiles["nrf91"] = "nrf91";
-        DeviceProfiles["m2blegw"] = "m2blegw";
-        DeviceProfiles["m2easyv3"] = "m2easyv3";
-        DeviceProfiles["m2easyiot"] = "m2easyiot";
-    })(DeviceProfiles = Manifest.DeviceProfiles || (Manifest.DeviceProfiles = {}));
-    /**
-     * Type of the iot app project
-     */
-    let ProjectTypes;
-    (function (ProjectTypes) {
-        ProjectTypes["app"] = "app";
-        ProjectTypes["library"] = "library";
-        ProjectTypes["addon"] = "addon";
-        ProjectTypes["analytics"] = "analytics";
-    })(ProjectTypes = Manifest.ProjectTypes || (Manifest.ProjectTypes = {}));
-    let BloAccessLevel;
-    (function (BloAccessLevel) {
-        BloAccessLevel["restricted"] = "restricted";
-        BloAccessLevel["global"] = "global";
-    })(BloAccessLevel = Manifest.BloAccessLevel || (Manifest.BloAccessLevel = {}));
-    let PovLocation;
-    (function (PovLocation) {
-        PovLocation["embedded"] = "$embedded";
-        PovLocation["pure"] = "$pure";
-    })(PovLocation = Manifest.PovLocation || (Manifest.PovLocation = {}));
-    function setOverwrites(manifest) {
-        manifestCache.overwrites = manifest;
-    }
-    Manifest.setOverwrites = setOverwrites;
-    function clearOverwrites() {
-        manifestCache.overwrites = null;
-    }
-    Manifest.clearOverwrites = clearOverwrites;
-    /**
-     * Read the studio.json manifest and parse it
-     * @param cwd
-     * @param fs
-     */
-    async function read(cwd, fs) {
-        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 ||
-            manifestUri?.fsPath !== manifestCache.stat?.path.fsPath ||
-            manifestStat?.ctime !== manifestCache.stat?.ctime ||
-            manifestStat?.mtime !== manifestCache.stat?.mtime ||
-            manifestStat?.size !== manifestCache.stat?.size) {
-            const localManifest = await fs.readFile(manifestUri);
-            const manifestString = convertBlobToString(localManifest);
-            manifestCache.manifest = JSON.parse(manifestString);
-            manifestCache.stat = { ...manifestStat, path: manifestUri };
-        }
-        return manifestCache.manifest;
-    }
-    Manifest.read = read;
-    /**
-     * Reads the studio.json as an Uint8Array
-     * @param cwd
-     * @param fs
-     */
-    async function readAsBlob(cwd, fs) {
-        return await fs.readFile(vscode_uri_1.Utils.joinPath(cwd, Manifest.fileName));
-    }
-    Manifest.readAsBlob = readAsBlob;
-    /**
-     * Write the manifest to the workspace
-     * @param cwd
-     * @param fs
-     * @param manifest
-     */
-    async function write(cwd, fs, manifest) {
-        manifestCache.clear();
-        removeDeprecatedOptions(manifest);
-        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 isLibrary(manifest) {
-        if (manifest.library !== undefined) {
-            return manifest.library;
-        }
-        else {
-            return manifest.type === ProjectTypes.library;
-        }
-    }
-    Manifest.isLibrary = isLibrary;
-    /**
-     * Check if the current project is an addon project
-     * @param manifest
-     */
-    function isAddon(manifest) {
-        return manifest.type === ProjectTypes.addon;
-    }
-    Manifest.isAddon = isAddon;
-    /**
-     * Check if the current project is an app project
-     * @param manifest
-     */
-    function isApp(manifest) {
-        if (manifest.type === undefined && !isLibrary(manifest)) {
-            return true;
-        }
-        return manifest.type === ProjectTypes.app;
-    }
-    Manifest.isApp = isApp;
-    /**
-     * Check if the current project is an iot app project
-     * @param manifest
-     */
-    function isIotApp(manifest) {
-        if (manifest.type === undefined) {
-            return true;
-        }
-        return manifest.type === ProjectTypes.app;
-    }
-    Manifest.isIotApp = isIotApp;
-    /**
-     * 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
-     * @param fs
-     * @param manifest
-     * @param env
-     */
-    async function validateBasicManifest(cwd, fs, manifest) {
-        if (!manifest) {
-            manifest = await read(cwd, fs);
-        }
-        validateProjectVersion(manifest);
-        validatePOVSettings(manifest);
-        validateBLOSettings(manifest);
-        validateMaxInstancesPerSite(manifest);
-    }
-    Manifest.validateBasicManifest = validateBasicManifest;
-    function validateLibraryName(libraryName) {
-        const errorMessage = `Library name can only contain 'a' through 'z', '0' through '9', '_' and '-'. The Library name must start with an alphabetic or numeric character.`;
-        const valid = libraryName.match(/^[a-z0-9-_]+$/);
-        if (valid) {
-            const invalidChars = ['-', '_'];
-            if (invalidChars.includes(libraryName[0]) || invalidChars.includes(libraryName[libraryName.length - 1])) {
-                return errorMessage;
-            }
-        }
-        else {
-            return errorMessage;
-        }
-        if (libraryName.length < 3 || libraryName.length > 20) {
-            return `The library name is beyond permissible length of 20 characters.`;
-        }
-        return null;
-    }
-    Manifest.validateLibraryName = validateLibraryName;
-    function validateProjectName(name, isLibrary) {
-        if (isLibrary) {
-            return validateLibraryName(name);
-        }
-        else {
-            const errorMessage = `Project name can only contain 'A' through 'Z', 'a' through 'z', '0' through '9', ' ', '_' and '-'. The Project name must start with an alphabetic or numeric character.`;
-            // ...validate...
-            const validChars = name.match(/^([a-zA-Z0-9 _-]+)$/);
-            if (!validChars) {
-                return errorMessage;
-            }
-            if (name.length < 3 || name.length > 40) {
-                return `The project name is beyond permissible length of 40 characters.`;
-            }
-            const invalidChars = ['-', '_', ' '];
-            if (invalidChars.includes(name[0]) || invalidChars.includes(name[name.length - 1])) {
-                return errorMessage;
-            }
-            return null;
-        }
-    }
-    Manifest.validateProjectName = validateProjectName;
-    function validateDescription(description) {
-        if (description.length < 5) {
-            return `The description must have at least 5 characters.`;
-        }
-        else {
-            return null;
-        }
-    }
-    Manifest.validateDescription = validateDescription;
-    function validatePublisherId(publisher) {
-        if (!publisher) {
-            return `No publisher set yet`;
-        }
-        const errorMessage = `Publisher can only contain 'A' through 'Z', 'a' through 'z', '0' through '9' and '-'. The Publisher start with an alphabetic or numeric character.`;
-        const valid = publisher.match(/^[a-zA-Z0-9-]+$/);
-        if (valid) {
-            const invalidChars = ['_'];
-            if (invalidChars.includes(publisher[0]) || invalidChars.includes(publisher[publisher.length - 1])) {
-                return errorMessage;
-            }
-        }
-        else {
-            return errorMessage;
-        }
-        return null;
-    }
-    Manifest.validatePublisherId = validatePublisherId;
-    async function validatePublisherOnline(token, publisher, env) {
-        const exists = await registryAPI_1.Registry.getPublisher(token, publisher, env);
-        if (!exists) {
-            return `Publisher '${publisher}' does not exist.`;
-        }
-        return null;
-    }
-    Manifest.validatePublisherOnline = validatePublisherOnline;
-    const REGEX_SERVER_DOMAIN = /^(((?!-))(xn--)?[a-z0-9\-_]{0,61}[a-z0-9]{1,1}\.)*(xn--)?([a-z0-9-]{1,61}|[a-z0-9-]{1,30})\.[a-z]{2,}$/;
-    async function validateRegistryAllowedBackends(allowedBackends) {
-        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) {
-                if (!domain.match(REGEX_SERVER_DOMAIN)) {
-                    return `Domain "${domain}" is invalid`;
-                }
-            }
-        }
-        else if (!allowedBackends?.match(REGEX_SERVER_DOMAIN) && allowedBackends !== '*') {
-            return `Invalid value for "allowedBackends"`;
-        }
-        return null;
-    }
-    Manifest.validateRegistryAllowedBackends = validateRegistryAllowedBackends;
-    const REGEX_UUID = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i;
-    async function validateRegistryAllowedApplications(allowedApplications) {
-        if (allowedApplications === undefined) {
-            return 'Allowed applications not specified yet';
-        }
-        if (allowedApplications === null) {
-            return null;
-        }
-        if (Array.isArray(allowedApplications) || allowedApplications?.includes(';')) {
-            const validationArray = allowedApplications?.includes(';')
-                ? allowedApplications.split(';')
-                : allowedApplications;
-            for (const uid of validationArray) {
-                if (!uid.match(REGEX_UUID)) {
-                    return `Application id "${uid}" is invalid`;
-                }
-            }
-        }
-        else if (!allowedApplications?.match(REGEX_UUID) && allowedApplications !== '*') {
-            return `Invalid value for "allowedApplications"`;
-        }
-        return null;
-    }
-    Manifest.validateRegistryAllowedApplications = validateRegistryAllowedApplications;
-    async function validateApplicationIcon(cwd, fs, manifest) {
-        const iconPath = manifest.icon;
-        if (!iconPath) {
-            throw new Error('App icon is required for publishing an application!');
-        }
-        const iconUri = vscode_uri_1.Utils.joinPath(cwd, iconPath);
-        const iconExist = await fs.stat(iconUri);
-        if (!iconExist) {
-            throw new Error(`Could not load icon "${iconPath}"`);
-        }
-        const iconData = await fs.readFile(iconUri);
-        const dimensions = (0, image_dimensions_1.imageDimensionsFromData)(iconData);
-        if (!dimensions) {
-            throw new Error(`App icon could not be validated!`);
-        }
-        if (dimensions?.width !== dimensions?.height) {
-            throw new Error(`App icon has to be a square!`);
-        }
-        if (dimensions.width > 512 || dimensions.width < 75) {
-            throw new Error(`App icon size should be between 75px and 512px!`);
-        }
-        if (!(0, file_type_checker_1.isPNG)(iconData)) {
-            throw new Error(`App icon has to be of type PNG!`);
-        }
-    }
-    Manifest.validateApplicationIcon = validateApplicationIcon;
-    function validateEngineSettings(manifest) {
-        const { engines } = manifest;
-        // validate vor server versions >=52v006
-        if (engines?.backend &&
-            !engines.backend.match(/(^[5-9][2-9]|[6-9]\d+|\d{3,})v(0(0[0-9]|[1-9]\d)|[1-9]\d{2}|[1-9]\d{3,})$/)) {
-            throw new Error('Setting "engines.backend" is invalid');
-        }
-        validateHwFwOrProductId(manifest);
-        validateAddonOrAnalyticsSupported(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);
-        }
-        const isAddon = Manifest.isAddon(manifest);
-        const isAnalytics = Manifest.isAnalytics(manifest);
-        switch (apmPart) {
-            case apm_1.APM.Part.dlo:
-                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:
-                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;
-    if (!pov) {
-        return;
-    }
-    if (pov.details) {
-        if (!Object.hasOwn(pov.details, 'buildCommand')) {
-            throw new Error('Setting "pov.details.buildCommand" missing!');
-        }
-        if (!Object.hasOwn(pov.details, 'workingPath')) {
-            throw new Error('Setting "pov.details.workingPath" missing!');
-        }
-    }
-}
-function validateBLOSettings(manifest) {
-    const { blo } = manifest;
-    if (!blo) {
-        return;
-    }
-    if (!Object.hasOwn(blo, 'buildCommand')) {
-        throw new Error('Setting "blo.buildCommand" missing!');
-    }
-    if (!Object.hasOwn(blo, 'workingPath')) {
-        throw new Error('Setting "blo.workingPath" missing!');
-    }
-    if (blo.accessLevel &&
-        ![Manifest.BloAccessLevel.restricted, Manifest.BloAccessLevel.global].includes(blo.accessLevel)) {
-        throw new Error(`Only "${Manifest.BloAccessLevel.restricted}" or "${Manifest.BloAccessLevel.global}" are allowed as value for "blo.accessLevel"!`);
-    }
-}
-function validateHwFwOrProductId(manifest) {
-    const { backend, productId, hwfw } = manifest.engines;
-    if (Manifest.isAddon(manifest) && (productId || hwfw)) {
-        throw new Error('For project type "addon", "engines.hwfw" or "engines.productId" is not allowed!"');
-    }
-    if (backend && backend >= PRODUCT_ID_SUPPORTED) {
-        if (hwfw && productId) {
-            throw new Error('Only "engines.hwfw" or "engines.productId" is allowed!"');
-        }
-    }
-    else if (productId) {
-        throw new Error(`"engines.productId" requires "engines.backend" to be "${PRODUCT_ID_SUPPORTED}"`);
-    }
-}
-function validateAddonOrAnalyticsSupported(manifest) {
-    if (!Manifest.isAddon(manifest) && !Manifest.isAnalytics(manifest)) {
-        return;
-    }
-    const { backend } = manifest.engines;
-    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 "${manifest.type}", "dlo" is not supported!"`);
-    }
-    if (manifest.dpid) {
-        throw new Error(`For project type "${manifest.type}", "dpid" is not supported!"`);
-    }
-}
-function validateMaxInstancesPerSite(manifest) {
-    const { maxInstancesPerSite } = manifest;
-    // If maxInstancesPerSite is not defined, check if it's required
-    if (maxInstancesPerSite === undefined) {
-        if (Manifest.isAddon(manifest)) {
-            throw new Error('Property "maxInstancesPerSite" is required for addon projects!');
-        }
-        return;
-    }
-    // If maxInstancesPerSite is defined, validate it's only allowed for addon projects
-    if (!Manifest.isAddon(manifest)) {
-        throw new Error(`Property "maxInstancesPerSite" is only allowed for addon projects!`);
-    }
-    // Validate the value
-    if (!Number.isInteger(maxInstancesPerSite)) {
-        throw new Error('Property "maxInstancesPerSite" must be an integer!');
-    }
-    if (maxInstancesPerSite < 1 || maxInstancesPerSite > 100) {
-        throw new Error('Property "maxInstancesPerSite" must be between 1 and 100!');
-    }
-}
-/**
- * Check based on the current env if the given version string is correct
- * @param manifest
- */
-function validateProjectVersion(manifest) {
-    const serverVersion = manifest.engines?.backend || '00v000';
-    if (serverVersion >= SEMVER_SUPPORTED || Manifest.isLibrary(manifest)) {
-        if (!preload_1.default.valid(manifest.version)) {
-            throw new Error(`From "engines.backend" version >= ${SEMVER_SUPPORTED} onwards "version" has to be a semantic version string!"`);
-        }
-    }
-    else {
-        if (!isNumeric(manifest.version)) {
-            throw new Error('"version" has to be a number!');
-        }
-    }
-}
-function removeDeprecatedOptions(manifest) {
-    if (manifest.registry) {
-        delete manifest.registry.allowedBackends;
-        delete manifest.registry.target;
-    }
-}
-//# sourceMappingURL=manifest.js.map