@winccoa-tools-pack/npm-winccoa-core 0.1.0-04b5cbe

package/dist/esm/types/project/ProjEnvProject.js

@@ -0,0 +1,1008 @@
+//--------------------------------------------------------------------------------
+import { PmonComponent } from '../components/implementations';
+import { findProjectRegistryById } from '../project/ProjEnvProjectRegistry';
+import { OaLanguage, OaLanguageFromString } from '../localization/OaLanguage';
+import { tr } from '../../utils/winccoa-localization';
+import fs from 'fs';
+// import { getComponentName } from "../../utils/winccoa-components"
+import { ProjEnvPmonStatus } from './ProjEnvPmonStatus';
+import { ProjEnvProjectConfig } from './ProjEnvProjectConfig';
+import { ProjEnvProjectRunnable, ProjEnvProjectFileSysStruct, ProjEnvProjectState, } from './ProjEnv';
+import { WinCCOAErrorHandler } from '../logs/WinCCOAErrorHandler';
+import path from 'path';
+import { PmonComponentCredential } from '../..';
+/**
+ * @brief WinCC OA Project class for managing project lifecycle and configuration
+ * @details Handles project creation, registration, startup, shutdown and management
+ *          of project components and settings.
+ */
+export class ProjEnvProject {
+    constructor() {
+        this.runnable = ProjEnvProjectRunnable.Unknown;
+        this.currentProject = false;
+        //--------------------------------------------------------------------------------
+        //@protected members
+        //--------------------------------------------------------------------------------
+        //------------------------------------------------------------------------------
+        // general project options
+        this._id = '';
+        this._name = '';
+        // Pmon object to control pmon self.
+        this._pmon = new PmonComponent();
+        this._errorHandler = new WinCCOAErrorHandler();
+        //--------------------------------------------------------------------------------
+        //@private members
+        //--------------------------------------------------------------------------------
+        // Languages
+        this._languages = [];
+        // sub-projects
+        this._subProjects = [];
+        // project config file handler
+        this._projectConfigFile = new ProjEnvProjectConfig();
+    }
+    //------------------------------------------------------------------------------
+    initFromRegister(registry) {
+        // console.log(
+        //     '__initFromRegister__, Initializing project from registry: ', registry
+        // );
+        this.setInstallDir(registry.installationDir);
+        if (registry.id) {
+            if (this.getId() && this.getId() !== registry.id) {
+                this._errorHandler.warning(`Project ID mismatch during initFromRegister: expected '${this.getId()}', got '${registry.id}'. We will use '${registry.id}'.`);
+            }
+            this._id = registry.id;
+        }
+        this.setName(registry.name ?? registry.id);
+        if (registry.notRunnable !== undefined)
+            this.setRunnable(!registry.notRunnable);
+        this.currentProject = registry.currentProject ?? false;
+        this._subProjects = [];
+        this._languages = [];
+        if (this.isRunnable()) {
+            if (registry.installationVersion !== undefined) {
+                // console.log(
+                //     `[${new Date().toISOString()}]`,
+                //     this.getId() +
+                //         ` Setting project version from registry: ${registry.installationVersion}`,
+                // );
+                this.setVersion(registry.installationVersion);
+            }
+            // try to get other project properties from config file
+            const configPath = this.getConfigPath();
+            if (configPath === '') {
+                this._errorHandler.warning('The project config file does not exist for project ' + this.getId());
+            }
+            else if (!fs.existsSync(configPath)) {
+                this._errorHandler.warning(`The project config file does not exist for project ${this.getId()}: ${configPath}`);
+            }
+            else {
+                this._projectConfigFile.setConfigPath(configPath);
+                const projectVersion = this.getProjectVersion();
+                if (projectVersion && this.getVersion() && projectVersion !== this.getVersion()) {
+                    this._errorHandler.warning(`Project version mismatch between registry and config file for project ${this.getId()}: registry=${this.getVersion()}, config=${projectVersion}`);
+                }
+                // read sub-projects from config file
+                // the last one proj_path entry is the project itself
+                const subProjectsEntries = this._projectConfigFile.getEntryValueList('proj_path') || [];
+                // check for sub-project entries on windows paths may take a while
+                // the last one is always the project itself, therefoee we skip it
+                // when we have no subpojects
+                if (subProjectsEntries.length > 0) {
+                    subProjectsEntries.forEach((entry, _idx) => {
+                        // console.log('Checking sub-project entry:', entry, 'at position', _idx);
+                        if (!entry || entry.trim().length === 0)
+                            return;
+                        const origEntry = entry;
+                        entry = entry.replace(/\\/g, '/').replace(/\/\//g, '/').toLowerCase();
+                        if (!entry.endsWith('/')) {
+                            entry += '/';
+                        }
+                        const myDir = this.getDir()
+                            .replace(/\\/g, '/')
+                            .replace(/\/\//g, '/')
+                            .toLowerCase();
+                        // console.log(
+                        //     `[${new Date().toISOString()}]`,
+                        //     `Found sub-project entry in config: ${entry}, my dir is ${this.getDir()}`,
+                        // );
+                        if (entry.toLowerCase() === myDir) {
+                            // console.log(
+                            //     `[${new Date().toISOString()}]`,
+                            //     `Skipping sub-project entry that matches self project dir`,
+                            // );
+                            return; // skip self
+                        }
+                        const subProj = new ProjEnvProject();
+                        subProj.setDir(origEntry);
+                        this._subProjects.push(subProj);
+                    });
+                }
+                // read languages from config file
+                const langEntries = this._projectConfigFile.getEntryValueList('langs') || [];
+                langEntries.forEach((entry, _idx) => {
+                    const oaLang = OaLanguageFromString(entry);
+                    if (oaLang === OaLanguage.undefined || oaLang === OaLanguage.auto) {
+                        console.warn(`[${new Date().toISOString()}]`, `Invalid language entry in project config: ${entry}`);
+                    }
+                    // console.log('Checking language entry:', entry, 'at position', _idx, oaLang);
+                    this._languages.push(oaLang);
+                });
+            }
+        }
+    }
+    //------------------------------------------------------------------------------
+    isCurrentProject() {
+        return this.currentProject;
+    }
+    //------------------------------------------------------------------------------
+    /**
+     * @brief Sets the project identifier
+     * @param id Project ID (directory name containing project files)
+     * @return Error code:
+     *          0 = Success
+     *         -1 = Invalid project ID
+     *         -2 = Invalid WinCC OA version
+     *         -3 = Invalid project path
+     */
+    setId(id) {
+        if (id === undefined || id.trim().length === 0) {
+            this._errorHandler.severe(tr('The project ID must not be empty!'));
+            return;
+        }
+        if (id === this.getId()) {
+            return;
+        }
+        this._id = id;
+        if (this.runnable == ProjEnvProjectRunnable.Unknown) {
+            const registry = findProjectRegistryById(id);
+            if (registry) {
+                this.initFromRegister(registry);
+            }
+        }
+    }
+    //------------------------------------------------------------------------------
+    format(template, ...args) {
+        // Replace $1, $2 ... in template with provided args
+        return template.replace(/\$(\d+)/g, (_m, idx) => {
+            const i = parseInt(idx, 10) - 1;
+            return args[i] !== undefined ? String(args[i]) : '';
+        });
+    }
+    /**
+     * @brief Function returns project ID.
+     * @return Project ID.
+     * @exception Empty string.
+     */
+    getId() {
+        return this._id;
+    }
+    /**
+     * Gets the WinCC OA version from project config file
+     */
+    getProjectVersion() {
+        return this._projectConfigFile.getEntryValue('proj_version');
+    }
+    //------------------------------------------------------------------------------
+    /**
+     * @brief Function set the project name.
+     * @param name Project name.
+     * @return Error code.
+     * value | description
+     * ------|------------
+     * 0     | Success.
+     * -1    | Name is not valid.
+     */
+    setName(name) {
+        if (!name) {
+            return;
+        }
+        this._name = name;
+    }
+    //------------------------------------------------------------------------------
+    /**
+     * @brief Function returns project name.
+     * @return Project-name.
+     * @exception Empty langString.
+     */
+    getName() {
+        return this._name;
+    }
+    getDisplayName() {
+        return this._name ? this._name : this._id;
+    }
+    //------------------------------------------------------------------------------
+    /**
+     * @brief Function set project version.
+     * @param version Project version in format ```<major>.<minor>```
+     * @return Error code. Returns 0 when successful. Otherwise -1.
+     */
+    setVersion(version) {
+        if (!version) {
+            throw new Error('Project version must not be empty: ' + this.getId());
+        }
+        this.version = version;
+        this._pmon.setVersion(this.version ?? '');
+    }
+    //------------------------------------------------------------------------------
+    /**
+     * @brief Function returns project version.
+     * @return Project version.
+     * @exception Empty string.
+     */
+    getVersion() {
+        return this.version;
+    }
+    //------------------------------------------------------------------------------
+    /**
+     * @brief Function set project dir.
+     */
+    setInstallDir(dirPath) {
+        if (!dirPath)
+            return;
+        // Store path with trailing separator
+        this.installPath = dirPath;
+        // unse unix style separators
+        this.installPath = this.installPath.replace(/\\/g, '/').replace(/\/\//g, '/');
+        if (!this.installPath.endsWith('/')) {
+            this.installPath += '/';
+        }
+        if (!fs.existsSync(this.installPath)) {
+            console.warn(`[${new Date().toISOString()}] Warning: Project install directory does not exist: ${this.installPath}`);
+        }
+    }
+    //------------------------------------------------------------------------------
+    /**
+     * @brief Function returns dir, where are project created.
+     * @return Project installation dir.
+     */
+    getInstallDir() {
+        return this.installPath;
+    }
+    //------------------------------------------------------------------------------
+    /**
+     * @brief Function returns project dir inclusive project self.
+     * @return Project dir path.
+     */
+    getDir(relativeDirPath = '') {
+        if (!this.getId()) {
+            throw new Error('Project ID is not set');
+            return '';
+        }
+        const base = this.getInstallDir();
+        if (!base) {
+            throw new Error('Project install directory is not set: ' + this.getId());
+            return '';
+        }
+        let retPath = base + this.getId() + '/' + relativeDirPath;
+        // Add separator between base and ID, handle both forward and backslash
+        if (!retPath.endsWith('/')) {
+            retPath += '/';
+        }
+        return retPath;
+    }
+    //------------------------------------------------------------------------------
+    /**
+     * @brief Function returns project config path.
+     * @param configFileName Name of the config file. Default: "config"
+     * @return Project config path.
+     */
+    getConfigPath(configFileName = 'config') {
+        const p = this.getDir(ProjEnvProjectFileSysStruct.CONFIG_REL_PATH);
+        if (!p || !fs.existsSync(p + configFileName))
+            return '';
+        return p + configFileName;
+    }
+    //------------------------------------------------------------------------------
+    /** Function set project languages.
+     * @param languages Project languages.
+     * @return Error code. Returns 0 when successful. Otherwise -1.
+     */
+    setLanguages(languages) {
+        this._languages = languages;
+    }
+    //------------------------------------------------------------------------------
+    /**
+     * @brief Gets configured project languages
+     * @return Dynamic array of configured language codes
+     */
+    getLanguages() {
+        return this._languages;
+    }
+    //------------------------------------------------------------------------------
+    /**
+     * @brief Sets whether the project is runnable
+     * @details Not runnable project are typically sub-projects
+     * @param runnable True if project should be runnable, false otherwise.
+     */
+    setRunnable(runnable) {
+        this.runnable = runnable
+            ? ProjEnvProjectRunnable.Runnable
+            : ProjEnvProjectRunnable.NotRunnable;
+    }
+    //------------------------------------------------------------------------------
+    /**
+     * @brief Checks if project is configured as runnable
+     * @return True if project is runnable, false otherwise
+     */
+    isRunnable() {
+        return this.runnable === ProjEnvProjectRunnable.Runnable;
+    }
+    //------------------------------------------------------------------------------
+    /** @brief Function checks if project (this object) is valid.
+     * @return Returns TRUE when object is valid, otherwise FALSE.
+     */
+    isValid() {
+        return this.getInvalidReason() === '';
+    }
+    //------------------------------------------------------------------------------
+    /** Function returns the reason, why is this project invalid.
+     * @return empty string in case the project is valid, the reason otherwise.
+     */
+    getInvalidReason() {
+        if (!this.getId())
+            return this.format('The project ID is empty.\n$1', this.toString('\t'));
+        if (!this.getInstallDir())
+            return this.format('The project install directory is empty.\n$1', this.toString('\t'));
+        if (!this.getName())
+            return this.format('The project name is empty.\n$1', this.toString('\t'));
+        if (this.isRunnable()) {
+            if (!this.getVersion())
+                return this.format('The project version is empty.\n$1', this.toString('\t'));
+            if (this.isRegistered()) {
+                if (this.getLanguages().length === 0)
+                    return this.format('The project languages are empty.\n$1', this.toString('\t'));
+                let langIndex = 1;
+                for (const lang of this.getLanguages()) {
+                    if (lang === OaLanguage.undefined) {
+                        return this.format('The project has an undefined language configured at position $1.\n$2', langIndex, this.toString('\t'));
+                    }
+                    langIndex++;
+                }
+            }
+        }
+        return '';
+    }
+    //---------------------------------------------------------------------------
+    /** Set the project directory
+     */
+    setDir(pathStr) {
+        this.setInstallDir(path.dirname(pathStr));
+        const projId = path.basename(pathStr);
+        this.setId(projId);
+        this.setName(projId);
+    }
+    //------------------------------------------------------------------------------
+    /** @brief Function checks if the project is registered.
+     * @details Function does not check if the project physically exists.
+     * @return Returns TRUE when project is registered, otherwise FALSE.
+     */
+    isRegistered() {
+        if (!this.getId())
+            this._errorHandler.exception(this.getInvalidReason());
+        return findProjectRegistryById(this.getId()) !== undefined;
+    }
+    //------------------------------------------------------------------------------
+    /**
+     * Registers the project with the WinCC OA system.
+     * The project must have a valid configuration file.
+     *
+     * **Retry Logic:**
+     * If the first registration attempt fails, automatically retries once.
+     * This handles transient failures from file system delays or temporary locks.
+     *
+     * @synchronized Function is not thread safe.
+     * @returns 0 when project is registered successfully, -1 if config not found, -2 on failure
+     */
+    async registerProj() {
+        // set the name in case the user forgot it
+        if (!this.getName())
+            this.setName(this.getId());
+        if (!this.isValid())
+            this._errorHandler.exception(this.getInvalidReason());
+        const configFile = this.isRunnable() ? this.getConfigPath('config') : this.getDir();
+        if (!configFile) {
+            this._errorHandler.severe(`Cannot register project ${this.getId()}: Config file ${this.getDir() + ProjEnvProjectFileSysStruct.CONFIG_REL_PATH + 'config'} not found.`);
+            return -1;
+        }
+        let result;
+        try {
+            result = await this.tryToRegister(configFile);
+        }
+        catch (error) {
+            this._errorHandler.warning(`First attempt to register project ${this.getId()} failed: ${error.toString()}`);
+            // retry once if registration fails
+            result = await this.tryToRegister(configFile);
+        }
+        if (result === 0) {
+            const registry = findProjectRegistryById(this.getId());
+            if (registry) {
+                this.initFromRegister(registry);
+            }
+            else {
+                this._errorHandler.warning(`Project ${this.getId()} registered successfully but could not find registry entry afterwards.`);
+            }
+        }
+        return result ?? -2;
+    }
+    //------------------------------------------------------------------------------
+    /**
+     * Internal helper to register a project with the WinCC OA system.
+     *
+     * **Registration Process:**
+     * 1. Calls pmon's registerProject command
+     * 2. Polls registration status using isRegistered() with 100ms intervals
+     * 3. Waits up to 5 seconds (50 attempts) for registration to complete
+     * 4. Reloads project registry cache automatically via file watching
+     *
+     * **Async Behavior:**
+     * Uses async/await to properly wait between status checks, preventing
+     * busy-waiting and allowing the file system watcher to detect changes.
+     *
+     * @param configFile - Absolute path to the project's config file
+     * @returns 0 on success, -2 on timeout or failure
+     */
+    async tryToRegister(configFile) {
+        const result = this.isRunnable()
+            ? await this._pmon.registerProject(configFile, this.getVersion() ?? '')
+            : await this._pmon.registerSubProject(configFile);
+        console.log(`[${new Date().toISOString()}]`, 'Register project result:', result);
+        let counter = 0;
+        while (!this.isRegistered()) {
+            ++counter;
+            if (counter > 50) {
+                console.warn(`[${new Date().toISOString()}] Registration of project '${this.getId()}' is taking longer than expected.`);
+                break;
+            }
+            console.log(`[${new Date().toISOString()}] Waiting for project '${this.getId()}' to be registered...`);
+            await sleep(100);
+        }
+        return result ?? -2;
+    }
+    //------------------------------------------------------------------------------
+    /**
+     * Unregisters the project from the WinCC OA system.
+     * The project files remain unchanged; only the system registration is removed.
+     *
+     * **Retry Logic:**
+     * If the first unregistration attempt fails, automatically retries once.
+     * This handles transient failures from file system delays or temporary locks.
+     *
+     * @synchronized Function is not thread safe.
+     * @returns 0 when project is unregistered successfully, -2 on failure
+     */
+    async unregisterProj() {
+        if (!this.getId())
+            this._errorHandler.exception(this.getInvalidReason());
+        let result;
+        try {
+            result = await this.tryToUnregister(this.getId());
+        }
+        catch (error) {
+            console.warn(`First attempt to register project ${this.getId()} failed:`, error);
+            // retry once if registration fails
+            result = await this.tryToUnregister(this.getId());
+        }
+        return result ?? -2;
+    }
+    //------------------------------------------------------------------------------
+    /**
+     * Internal helper to unregister a project from the WinCC OA system.
+     *
+     * **Unregistration Process:**
+     * 1. Calls pmon's unregisterProject command
+     * 2. Polls registration status using isRegistered() with 100ms intervals
+     * 3. Waits up to 0.5 seconds (5 attempts) for unregistration to complete
+     * 4. Reloads project registry cache automatically via file watching
+     *
+     * **Async Behavior:**
+     * Uses async/await to properly wait between status checks, preventing
+     * busy-waiting and allowing the file system watcher to detect changes.
+     *
+     * @param projId - The project ID to unregister
+     * @returns 0 on success, -2 on timeout or failure
+     */
+    async tryToUnregister(projId) {
+        const result = await this._pmon.unregisterProject(projId);
+        console.log(`[${new Date().toISOString()}]`, 'Register project result:', result);
+        let counter = 0;
+        while (this.isRegistered()) {
+            ++counter;
+            if (counter > 5) {
+                console.warn(`[${new Date().toISOString()}] UN-Registration of project ${this.getId()} is taking longer than expected.`);
+                break;
+            }
+            await sleep(100);
+        }
+        return result ?? -2;
+    }
+    //------------------------------------------------------------------------------
+    /** @brief Function checks if the project physically exists.
+     * @details Does not check if is registered.
+     * @return Returns TRUE when project is exists, otherwise FALSE.
+     */
+    exists() {
+        const p = this.getDir();
+        return p != '' && fs.existsSync(p);
+    }
+    //------------------------------------------------------------------------------
+    /** @brief Function convert this object to string variable.
+     * @details This is helper for debugging in std log.
+     * @param prefix Prefix for each new line.
+     * @return Object formatted in string variable.
+     */
+    toString(prefix = '') {
+        let ret = '';
+        ret = prefix + this.format('Project ID: $1\n', this.getId());
+        ret += prefix + this.format('Name: $1\n', this.getName());
+        const instDir = this.getInstallDir();
+        if (instDir !== undefined)
+            ret += prefix + this.format('Install directory: $1\n', instDir);
+        ret += prefix + this.format('Version: $1', this.getVersion() ?? '');
+        return ret;
+    }
+    //------------------------------------------------------------------------------
+    /** @brief Function removes (physical) and un-register the project.
+     *
+     * @synchronized Function is not thread safe.
+     * @return Error code. Returns 0 when successful. Otherwise -1.
+     * @warning Work only with locale host.
+     */
+    async deleteProj() {
+        const dirPath = this.getDir();
+        this.unregisterProj();
+        fs.rmSync(dirPath, { recursive: true, force: true });
+        return fs.existsSync(dirPath) ? -1 : 0;
+    }
+    //------------------------------------------------------------------------------
+    /**
+     * @brief Starts the project and waits for completion
+     * @param timeOut Seconds to wait for project startup (0 = don't wait)
+     * @return Error code:
+     *         0  = Success
+     *         -1 = Start failed
+     *         -2 = Before-start hook failed
+     *         -3 = After-start hook failed
+     *         -4 = Wait timeout
+     *         -5 = After-started hook failed
+     */
+    async start() {
+        this._pmon.startPmonOnly(this.getName());
+        const result = await this._pmon.startProject(this.getId());
+        return result ?? -1;
+    }
+    //------------------------------------------------------------------------------
+    /** @brief Function stops the Project.
+   * @param timeOut for stopping the project.
+   * @details But the pmon are still on living after them. Stop only all project managers.
+   *         With default parameter the function does not wait till project stopped.
+             When the function is called with parameter >= 0 it waits the amount in seconds till the Project has the State Down
+   *
+   * @return Error code. Returns 0 when successful. Otherwise -1.
+   */
+    async stop() {
+        const result = await this._pmon.stopProject(this.getId());
+        return result ?? -1;
+    }
+    //------------------------------------------------------------------------------
+    /** @brief Function restarts the project.
+     * @param timeOut for starting the project.
+     * @details Start the project via pmon interface.
+     *         Function start also pmon self, when is not running.
+     *         The function does wait till project is restarted.
+     *         When the function is called with *timeOut* > 0 it waits the amount in seconds till the Project has the State Monitoring again.
+     *
+     * @return  Error code.
+     * value | description
+     * ------|------------
+     * 0     | Success.
+     * -1    | Pmon does not accept start command. Ex. NW-problem.
+     * -2    | Could not restart project within timeOut.
+     * -3    | Project could not be stopped within timeOut
+     */
+    async restart() {
+        const result = this._pmon.restartProject(this.getId());
+        return result ?? -1;
+    }
+    //------------------------------------------------------------------------------
+    /** @brief Function kills manager at the given idx.
+     * @details Index begin with 1. Pmon has idx 0 in progs file.
+     *
+     * @param manIdx Manager index in the pmon table.
+     * @return Error code. Returns 0 when successful. Otherwise -1.
+     */
+    async killManager(manIdx) {
+        const result = await this._pmon.killManager(this.getId(), manIdx);
+        return result ?? -1;
+    }
+    //------------------------------------------------------------------------------
+    /** @brief Function start pmon for this project.
+     *  @details Pmon can be started locally only.
+     * @return Error code.
+     * value | description
+     * ------|------------
+     * 0     | Success.
+     * -1    | Cannot start pmon. See log file for more information.
+     * -2    | Cannot connect to pmon.
+     */
+    async startPmon() {
+        const result = await this._pmon.startPmonOnly(this.getId());
+        return result ?? -1;
+    }
+    //------------------------------------------------------------------------------
+    /**
+     * @brief Function stop the Pmon.
+     *
+     * @details The function stops also the project with it.
+     * @param timeout Time in s.ms to wait for pmon stop
+     * @return Returns 0 when successful, otherwise -1.
+     */
+    async stopPmon(timeout) {
+        if (timeout !== undefined) {
+            timeout = timeout * 1000;
+        }
+        const result = await this._pmon.stopProjectAndPmon(this.getId(), timeout);
+        return result ?? -1;
+    }
+    //------------------------------------------------------------------------------
+    /** @brief Function checks if pmon is running.
+     * @details Checks only pmon, does not check if the pmon is running for this project.
+     *         It can be used to general check, if the pmon with given host, port is
+     *         running. Be sure that you have nw-connection to the remote pmon-host.
+     * @return Returns TRUE when pmon is running on the host, otherwise FALSE.
+     */
+    async isPmonRunning() {
+        const result = await this._pmon.getStatus(this.getId());
+        return result === ProjEnvPmonStatus.Running;
+    }
+    //------------------------------------------------------------------------------
+    /** @brief Function checks if is the pmon running.
+     * @return Returns TRUE when pmon with 'this' project is running on the host, otherwise FALSE.
+     */
+    isRunning() {
+        return this.getStatus() === ProjEnvProjectState.Monitoring;
+    }
+    //------------------------------------------------------------------------------
+    /** Returns current project status.
+      @details The function returns the project status. The status is stored in the pmon table.
+      @return Project status.
+      @see ProjEnvProjectState.
+  */
+    getStatus() {
+        return this.getProjectStatus()?.project?.status;
+    }
+    //------------------------------------------------------------------------------
+    /** Function checks if the project is in emergency mode.
+     *
+     * @returns true if emergency mode is active, false otherwise
+     */
+    isEmergencyMode() {
+        return this.getProjectStatus()?.project?.emergency;
+    }
+    //------------------------------------------------------------------------------
+    /** Function checks if the project use demo license.
+     *
+     * @returns true if demo mode-license is active, false otherwise
+     */
+    isDemoMode() {
+        return this.getProjectStatus()?.project?.demo;
+    }
+    //------------------------------------------------------------------------------
+    /** @brief  Function activates a debug flag
+     * @details Sends the "activate debug flag(s)" command during running time
+     * @param   manIdx Manager index in the pmon table.
+     * @param   dbgFlags debug parameter e.g.: -dbg 2 or -report ALL
+     * @return  Returns 0 when flag was set, otherwise returns -1 or -2.
+     */
+    async sendDbgFlag(manIdx, dbgFlags) {
+        const result = await this._pmon.sendDebugFlag(dbgFlags, this.getId(), manIdx);
+        return result ?? -1;
+    }
+    //------------------------------------------------------------------------------
+    /** @brief Function starts manager at the given idx.
+     * @details Index begin with 1. Pmon has idx 0 in progs file.
+     *
+     * @param manIdx Manager index in the pmon table.
+     * @param timeOut Time to wait for expected manager state.
+     * @param state Expected manager state.
+     * @return Error code. Returns 0 when . Otherwise -1.
+     */
+    async startManager(manIdx) {
+        const result = await this._pmon.startManager(this.getId(), manIdx);
+        return result ?? -1;
+    }
+    //------------------------------------------------------------------------------
+    /** @brief Function stopped manager at the given idx.
+     * @details Index begin with 1. Pmon has idx 0 in progs file.
+     *
+     * @param manIdx Manager index in the pmon table.
+     * @param timeOut Time to wait for expected manager state.
+     * @param state Expected manager state.
+     * @return Error code. Returns 0 when successful. Otherwise -1.
+     */
+    async stopManager(manIdx) {
+        const result = await this._pmon.stopManager(this.getId(), manIdx);
+        return result ?? -1;
+    }
+    //------------------------------------------------------------------------------
+    /** @brief Function deletes manager at the given idx.
+     * @param manIdx Manager index in the pmon table.
+     *               Index begin with 1. Pmon has idx 0 in progs file.
+     * @return Error code. Returns 0 when successful. Otherwise -1.
+     */
+    async deleteManager(manIdx) {
+        const result = await this._pmon.removeManager(this.getId(), manIdx);
+        return result ?? -1;
+    }
+    //------------------------------------------------------------------------------
+    /** @brief Function inserts manager at the given idx.
+     * @details Index begin with 1. Pmon has index 0 in progs file.
+     * @param opts Manager options.
+     * @param manIdx Manager index in the pmon table.
+     *               Index begin with 1. Pmon has idx 0 in progs file.
+     * @return Error code. Returns -1 when failed, -2 when pmon is not reachable, otherwise returns the index of the inserted manager.
+     */
+    async insertManager(opts, manIdx = undefined) {
+        const result = await this._pmon.insertManagerAt(opts, this.getId(), manIdx);
+        return result ?? -1;
+    }
+    //------------------------------------------------------------------------------
+    /** @brief Function changes manager options at the given index.
+     * @details Index begin with 1. Pmon has index 0 in progs file.
+     * @param manIdx Manager index in the pmon table.
+     *               Index begin with 1. Pmon has index 0 in progs file.
+     * @param opts Manager options.
+     * @return Error code. Returns 0 when successful. Otherwise -1.
+     */
+    async changeManagerOptions(manIdx, opts) {
+        const result = await this._pmon.setManagerOptionsAt(opts, this.getId(), manIdx);
+        return result ?? -1;
+    }
+    //------------------------------------------------------------------------------
+    /** @brief Function changes manager start mode at the given index.
+     * @details Index begin with 1. Pmon has index 0 in progs file.
+     * @param manIdx Manager index in the pmon table.
+     *               Index begin with 1. Pmon has index 0 in progs file.
+     * @param startMode Start mode of the manager.
+     * @return Error code. Returns 0 when successful. Otherwise -1.
+     */
+    async changeManagerStartMode(manIdx, startMode) {
+        const current = this.getManagerOptions(manIdx);
+        if (!current)
+            return -1;
+        current.startMode = startMode;
+        return this.changeManagerOptions(manIdx, current);
+    }
+    //------------------------------------------------------------------------------
+    /** @brief Function changes manager start options at the given index.
+     * @details Index begin with 1. Pmon has index 0 in progs file.
+     * @param manIdx Manager index in the pmon table.
+     *               Index begin with 1. Pmon has index 0 in progs file.
+     * @param startOptions Start options of the manager.
+     * @return Error code. Returns 0 when successful. Otherwise -1.
+     */
+    async changeManagerStartOptions(manIdx, startOptions) {
+        const current = this.getManagerOptions(manIdx);
+        if (!current)
+            return -1;
+        current.startOptions = startOptions;
+        return this.changeManagerOptions(manIdx, current);
+    }
+    //------------------------------------------------------------------------------
+    /** @brief Function returns manager options at the given index.
+     * @details Index begin with 1. Pmon has index 0 in progs file.
+     * @param idx Manager index in the pmon table.
+     * @return Manager options. Returns NULL when failed.
+     */
+    getManagerOptions(idx) {
+        if (idx < 0)
+            return null;
+        return null;
+    }
+    //------------------------------------------------------------------------------
+    /** @brief Function returns list of all manager options.
+     * @details The function returns the list of all manager options.
+     *          The list is stored in the pmon table.
+     * @return List of ProjEnvManagerOptions. In case of error is empty dyn_anytype.
+     */
+    getListOfManagerOptions() {
+        return [];
+    }
+    //------------------------------------------------------------------------------
+    /** @brief Function returns project status.
+     * @details The function returns the project status.
+     *          The status is stored in the pmon table.
+     * @return Project status ProjEnvPmonProjectStatus. In case of error returns undefined.
+     */
+    getProjectStatus() {
+        return undefined;
+    }
+    //------------------------------------------------------------------------------
+    /**
+     * @brief Function returns manager info as mapping.
+     * @param idx Manager index in the pmon table.
+     *            Index begin with 1. Pmon has idx 0 in progs file.
+     * @return Manager information ProjEnvManagerInfo. In case of error returns empty ProjEnvManagerInfo.
+     */
+    getManagerInfo(idx) {
+        return this.getProjectStatus()?.managers?.[idx];
+    }
+    //------------------------------------------------------------------------------
+    /**
+     * @brief Function returns manager state ProjEnvManagerState.
+     * @param idx Manager index in the pmon table.
+     *            Index begin with 1. Pmon has idx 0 in progs file.
+     * @return Manager state. See also ProjEnvManagerState.
+     */
+    getManagerStatus(idx) {
+        return this.getProjectStatus()?.managers?.[idx]?.state;
+    }
+    //------------------------------------------------------------------------------
+    /** @brief Function insert value to project config file.
+     * @param value Value to insert into the config file
+     * @param key Config key under which to insert the value
+     * @param section Config section name (defaults to "general")
+     * @param configFile Name of config file (defaults to "config")
+     * @return Error code:
+     *         0  = Success
+     *         -1 = Failed to insert value
+     */
+    insertCfgValue(value, key, section = 'general', configFile = 'config') {
+        const cfg = new ProjEnvProjectConfig(this.getConfigPath(configFile));
+        if (cfg.insertValue(value, key, section))
+            return -1;
+        return 0;
+    }
+    //------------------------------------------------------------------------------
+    /** @brief Function set value to project config file.
+     * @param value Value to set in the config file
+     * @param key Config key to set
+     * @param section Config section name (defaults to "general")
+     * @param configFile Name of config file (defaults to "config")
+     * @return Error code:
+     *          0 = Success
+     *         -1 = Failed to set value
+     */
+    setCfgValue(value, key, section = 'general', configFile = 'config') {
+        const cfg = new ProjEnvProjectConfig(this.getConfigPath(configFile));
+        if (cfg.setValue(value, key, section))
+            return -1;
+        return 0;
+    }
+    //------------------------------------------------------------------------------
+    /** @brief Function deletes value in project config file.
+     * @param value Value to delete from config
+     * @param key Config key to delete
+     * @param section Config section name (defaults to "general")
+     * @param configFile Name of config file (defaults to "config")
+     * @return Error code:
+     *          0 = Success
+     *         -1 = Failed to delete value
+     */
+    deleteCfgValue(value, key, section = 'general', configFile = 'config') {
+        const cfg = new ProjEnvProjectConfig(this.getConfigPath(configFile));
+        if (cfg.deleteValue(value, key, section))
+            return -1;
+        return 0;
+    }
+    //------------------------------------------------------------------------------
+    /** @brief Function deletes entry in config file, used when only the key is known - but not the value. Deletes only one entry, from top to bottom
+     * @param key Config key.
+     * @param section Config section.
+     * @param configFile Config file.
+     * @return Error code. Returns 0 when successful. Otherwise -1.
+     */
+    deleteCfgEntry(key, section = 'general', configFile = 'config') {
+        const cfg = new ProjEnvProjectConfig(this.getConfigPath(configFile));
+        if (cfg.deleteEntry(key, section))
+            return -1;
+        return 0;
+    }
+    //------------------------------------------------------------------------------
+    /** Returns ID formatted for logs.
+     * It includes few more information, like host name, which makes the log analysis
+     * for parallel (multiple nodes) executions more easy.
+     */
+    getIdInLogFormat() {
+        const logId = this.getId();
+        return logId;
+    }
+    //---------------------------------------------------------------------------
+    /** Returns default project location (directory).
+     * @details The default project location is the last used project directory.
+     *          If the last used project directory is not set, the default location is:
+     *          - Windows: C:\WinCC_OA_Proj\
+     *          - Linux: /opt/WinCC_OA_Proj/
+     * @return Default project location (directory).
+     */
+    getDefaultInstallDir() {
+        // TODO use getLastUsedProjectDir() from ProjEnvProjectRegistry here
+        const defaultDirectory = ''; // placeholder for paGetLastUsedProjDir()
+        if (defaultDirectory)
+            return defaultDirectory;
+        // platform-specific defaults could be returned here
+        return '';
+    }
+    //---------------------------------------------------------------------------
+    /** @brief Function checks if the given file path belongs to this project.
+     * @param filePath Full path to the file to check.
+     * @return Returns TRUE if the file belongs to this project, otherwise FALSE.
+     */
+    isProjectFile(filePath) {
+        const projDir = this.getDir();
+        if (!projDir)
+            return false;
+        const normalizedProjDir = path.normalize(projDir).toLowerCase();
+        const normalizedFilePath = path.normalize(filePath).toLowerCase();
+        return normalizedFilePath.startsWith(normalizedProjDir);
+    }
+    //------------------------------------------------------------------------------
+    /** @brief Function returns sub-projects of this project.
+     * @details In case the project does not contains sub-projects, the function returns an empty array.
+     * @return Array of sub-projects.
+     */
+    getSubProjects() {
+        return this._subProjects;
+    }
+    //------------------------------------------------------------------------------
+    /** @brief Function checks if the project is protected.
+     * @details A project is considered protected if it has a password set in the progs file.
+     * @returns true if the project is protected, false otherwise.
+     */
+    isProtected() {
+        if (!this.isRunnable()) {
+            return false; // sub-projects are not protected
+        }
+        if (this._pmon.getCredentials() != null)
+            return true; // user name or pw has been set
+        const progsPath = this.getConfigPath('progs');
+        if (!progsPath || fs.existsSync(progsPath)) {
+            return false; // progs file does not exist
+        }
+        const content = fs.readFileSync(progsPath, 'utf-8');
+        if (content.indexOf('auth "" ""') !== -1)
+            return false; // user name or pw has not been set in progs file
+        else
+            return true; // user name or pw has been set in progs file
+    }
+    //------------------------------------------------------------------------------
+    /** @brief Function logs into the project using the provided credentials.
+     * @details This function logs into the project using the provided username and password.
+     *          It verifies the credentials against the project's pmon component.
+     * @param username The username to use for login.
+     * @param password The password to use for login.
+     */
+    async loginPmon(username, password) {
+        if (!this.isRunnable()) {
+            this._errorHandler.exception(`Project ${this.getId()} is not runnable and cannot be logged into.`);
+        }
+        const cred = new PmonComponentCredential(username, password);
+        const rc = this._pmon.verifyCredentials(this.getId(), cred);
+        if ((await rc) === false) {
+            this._errorHandler.exception(`Failed to login to project ${this.getId()}: Invalid credentials`);
+        }
+    }
+    //------------------------------------------------------------------------------
+    /** @brief Function sets the credentials for the project.
+     * @details This function sets the credentials for the project in the pmon component.
+     * @param username The username to set.
+     * @param password The password to set.
+     * @return Error code:
+     *         0  = Success
+     *         -1 = Failed to set credentials
+     */
+    async setPmonCredentials(username, password) {
+        if (!this.isRunnable()) {
+            this._errorHandler.exception(`Project ${this.getId()} is not runnable and cannot used credentials.`);
+        }
+        const cred = new PmonComponentCredential(username, password);
+        const code = this._pmon.saveCredentials(this.getId(), cred);
+        if ((await code) !== 0) {
+            this._errorHandler.exception(`Failed to set credentials for project ${this.getId()}`);
+        }
+        return 0;
+    }
+}
+const sleep = async (ms) => {
+    return new Promise((resolve) => setTimeout(resolve, ms));
+};
+//# sourceMappingURL=ProjEnvProject.js.map