@winccoa-tools-pack/npm-winccoa-core 0.1.0-9176c0d

package/dist/types/project/ProjEnvProject.d.ts

@@ -0,0 +1,475 @@
+import { PmonComponent } from '../components/implementations';
+import { ProjEnvProjectRegistry } from '../project/ProjEnvProjectRegistry';
+import { OaLanguage } from '../localization/OaLanguage';
+import { ProjEnvPmonProjectStatus } from './ProjEnvPmonStatus';
+import { ProjEnvManagerState, ProjEnvManagerOptions, ProjEnvManagerStartMode, ProjEnvManagerInfo, ProjEnvProjectState } from './ProjEnv';
+import { WinCCOAErrorHandler } from '../logs/WinCCOAErrorHandler';
+/**
+ * @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 declare class ProjEnvProject {
+    private runnable;
+    private version?;
+    private currentProject;
+    initFromRegister(registry: ProjEnvProjectRegistry): void;
+    isCurrentProject(): boolean;
+    /**
+     * @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: string): void;
+    private format;
+    /**
+     * @brief Function returns project ID.
+     * @return Project ID.
+     * @exception Empty string.
+     */
+    getId(): string;
+    /**
+     * Gets the WinCC OA version from project config file
+     */
+    private getProjectVersion;
+    /**
+     * @brief Function set the project name.
+     * @param name Project name.
+     * @return Error code.
+     * value | description
+     * ------|------------
+     * 0     | Success.
+     * -1    | Name is not valid.
+     */
+    setName(name: string): void;
+    /**
+     * @brief Function returns project name.
+     * @return Project-name.
+     * @exception Empty langString.
+     */
+    getName(): string;
+    getDisplayName(): string;
+    /**
+     * @brief Function set project version.
+     * @param version Project version in format ```<major>.<minor>```
+     * @return Error code. Returns 0 when successful. Otherwise -1.
+     */
+    setVersion(version: string): void;
+    /**
+     * @brief Function returns project version.
+     * @return Project version.
+     * @exception Empty string.
+     */
+    getVersion(): string | undefined;
+    /**
+     * @brief Function set project dir.
+     */
+    setInstallDir(dirPath: string): void;
+    /**
+     * @brief Function returns dir, where are project created.
+     * @return Project installation dir.
+     */
+    getInstallDir(): string | undefined;
+    /**
+     * @brief Function returns project dir inclusive project self.
+     * @return Project dir path.
+     */
+    getDir(relativeDirPath?: string): string;
+    /**
+     * @brief Function returns project config path.
+     * @param configFileName Name of the config file. Default: "config"
+     * @return Project config path.
+     */
+    getConfigPath(configFileName?: string): string;
+    /** Function set project languages.
+     * @param languages Project languages.
+     * @return Error code. Returns 0 when successful. Otherwise -1.
+     */
+    setLanguages(languages: OaLanguage[]): void;
+    /**
+     * @brief Gets configured project languages
+     * @return Dynamic array of configured language codes
+     */
+    getLanguages(): OaLanguage[];
+    /**
+     * @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: boolean): void;
+    /**
+     * @brief Checks if project is configured as runnable
+     * @return True if project is runnable, false otherwise
+     */
+    isRunnable(): boolean;
+    /** @brief Function checks if project (this object) is valid.
+     * @return Returns TRUE when object is valid, otherwise FALSE.
+     */
+    isValid(): boolean;
+    /** Function returns the reason, why is this project invalid.
+     * @return empty string in case the project is valid, the reason otherwise.
+     */
+    getInvalidReason(): string;
+    /** Set the project directory
+     */
+    setDir(pathStr: string): void;
+    /** @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(): boolean;
+    /**
+     * 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
+     */
+    registerProj(): Promise<number>;
+    /**
+     * 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
+     */
+    private tryToRegister;
+    /**
+     * 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
+     */
+    unregisterProj(): Promise<number>;
+    /**
+     * 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
+     */
+    private tryToUnregister;
+    /** @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(): boolean;
+    /** @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?: string): string;
+    /** @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.
+     */
+    deleteProj(): Promise<number>;
+    /**
+     * @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
+     */
+    start(): Promise<number>;
+    /** @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.
+   */
+    stop(): Promise<number>;
+    /** @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
+     */
+    restart(): Promise<number>;
+    /** @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.
+     */
+    killManager(manIdx: number): Promise<number>;
+    /** @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.
+     */
+    startPmon(): Promise<number>;
+    /**
+     * @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.
+     */
+    stopPmon(timeout: number | undefined): Promise<number>;
+    /** @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.
+     */
+    isPmonRunning(): Promise<boolean>;
+    /** @brief Function checks if is the pmon running.
+     * @return Returns TRUE when pmon with 'this' project is running on the host, otherwise FALSE.
+     */
+    isRunning(): boolean;
+    /** 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(): ProjEnvProjectState | undefined;
+    /** Function checks if the project is in emergency mode.
+     *
+     * @returns true if emergency mode is active, false otherwise
+     */
+    isEmergencyMode(): boolean | undefined;
+    /** Function checks if the project use demo license.
+     *
+     * @returns true if demo mode-license is active, false otherwise
+     */
+    isDemoMode(): boolean | undefined;
+    /** @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.
+     */
+    sendDbgFlag(manIdx: number, dbgFlags: string): Promise<number>;
+    /** @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.
+     */
+    startManager(manIdx: number): Promise<number>;
+    /** @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.
+     */
+    stopManager(manIdx: number): Promise<number>;
+    /** @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.
+     */
+    deleteManager(manIdx: number): Promise<number>;
+    /** @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.
+     */
+    insertManager(opts: ProjEnvManagerOptions, manIdx?: number | undefined): Promise<number>;
+    /** @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.
+     */
+    changeManagerOptions(manIdx: number, opts: ProjEnvManagerOptions): Promise<number>;
+    /** @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.
+     */
+    changeManagerStartMode(manIdx: number, startMode: ProjEnvManagerStartMode): Promise<number>;
+    /** @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.
+     */
+    changeManagerStartOptions(manIdx: number, startOptions: string): Promise<number>;
+    /** @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: number): ProjEnvManagerOptions | 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(): any[];
+    /** @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(): ProjEnvPmonProjectStatus | 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: number): ProjEnvManagerInfo | undefined;
+    /**
+     * @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: number): ProjEnvManagerState | undefined;
+    /** @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: unknown, key: string, section?: string, configFile?: string): number;
+    /** @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: unknown, key: string, section?: string, configFile?: string): number;
+    /** @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: unknown, key: string, section?: string, configFile?: string): number;
+    /** @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: string, section?: string, configFile?: string): number;
+    /** 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(): string;
+    /** 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(): string;
+    /** @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: string): boolean;
+    /** @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(): ProjEnvProject[];
+    /** @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(): boolean;
+    /** @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.
+     */
+    loginPmon(username: string, password: string): Promise<void>;
+    /** @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
+     */
+    setPmonCredentials(username: string, password: string): Promise<number>;
+    protected _id: string;
+    protected _name: string;
+    protected installPath?: string;
+    protected _pmon: PmonComponent;
+    protected _errorHandler: WinCCOAErrorHandler;
+    private _languages;
+    private _subProjects;
+    private _projectConfigFile;
+}
+//# sourceMappingURL=ProjEnvProject.d.ts.map

package/dist/types/project/ProjEnvProject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProjEnvProject.d.ts","sourceRoot":"","sources":["../../../src/types/project/ProjEnvProject.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAA2B,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AACpG,OAAO,EAAE,UAAU,EAAwB,MAAM,4BAA4B,CAAC;AAI9E,OAAO,EAAE,wBAAwB,EAAqB,MAAM,qBAAqB,CAAC;AAElF,OAAO,EAEH,mBAAmB,EACnB,qBAAqB,EACrB,uBAAuB,EACvB,kBAAkB,EAElB,mBAAmB,EACtB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAIlE;;;;GAIG;AACH,qBAAa,cAAc;IACvB,OAAO,CAAC,QAAQ,CAA0D;IAC1E,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,OAAO,CAAC,cAAc,CAAS;IAGxB,gBAAgB,CAAC,QAAQ,EAAE,sBAAsB;IAoHjD,gBAAgB,IAAI,OAAO;IAKlC;;;;;;;;OAQG;IACI,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAqB9B,OAAO,CAAC,MAAM;IAQd;;;;OAIG;IACI,KAAK,IAAI,MAAM;IAItB;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAKzB;;;;;;;;OAQG;IACI,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAQlC;;;;OAIG;IACI,OAAO,IAAI,MAAM;IAIjB,cAAc,IAAI,MAAM;IAK/B;;;;OAIG;IACI,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IASxC;;;;OAIG;IACI,UAAU,IAAI,MAAM,GAAG,SAAS;IAIvC;;OAEG;IACI,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAoB3C;;;OAGG;IACI,aAAa,IAAI,MAAM,GAAG,SAAS;IAK1C;;;OAGG;IACI,MAAM,CAAC,eAAe,SAAK,GAAG,MAAM;IAqB3C;;;;OAIG;IACI,aAAa,CAAC,cAAc,SAAW,GAAG,MAAM;IAOvD;;;OAGG;IACI,YAAY,CAAC,SAAS,EAAE,UAAU,EAAE,GAAG,IAAI;IAKlD;;;OAGG;IACI,YAAY,IAAI,UAAU,EAAE;IAKnC;;;;OAIG;IACI,WAAW,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI;IAO3C;;;OAGG;IACI,UAAU,IAAI,OAAO;IAK5B;;OAEG;IACI,OAAO,IAAI,OAAO;IAKzB;;OAEG;IACI,gBAAgB,IAAI,MAAM;IAgCjC;OACG;IACI,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAQpC;;;OAGG;IACI,YAAY,IAAI,OAAO;IAM9B;;;;;;;;;;OAUG;IACU,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC;IA0C5C;;;;;;;;;;;;;;;OAeG;YACW,aAAa;IAwB3B;;;;;;;;;;OAUG;IACU,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC;IAiB9C;;;;;;;;;;;;;;;OAeG;YACW,eAAe;IAmB7B;;;OAGG;IACI,MAAM,IAAI,OAAO;IAMxB;;;;OAIG;IACI,QAAQ,CAAC,MAAM,SAAK,GAAG,MAAM;IAYpC;;;;;OAKG;IACU,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC;IAU1C;;;;;;;;;;OAUG;IACU,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC;IAOrC;;;;;;;KAOC;IACY,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC;IAMpC;;;;;;;;;;;;;;OAcG;IACU,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC;IAMvC;;;;;OAKG;IACU,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAMzD;;;;;;;;OAQG;IACU,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC;IAKzC;;;;;;OAMG;IACU,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;IASnE;;;;;OAKG;IACU,aAAa,IAAI,OAAO,CAAC,OAAO,CAAC;IAM9C;;OAEG;IACI,SAAS,IAAI,OAAO;IAK3B;;;;IAIA;IACO,SAAS,IAAI,mBAAmB,GAAG,SAAS;IAKnD;;;OAGG;IACI,eAAe,IAAI,OAAO,GAAG,SAAS;IAK7C;;;OAGG;IACI,UAAU,IAAI,OAAO,GAAG,SAAS;IAKxC;;;;;OAKG;IACU,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAM3E;;;;;;;OAOG;IACU,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAM1D;;;;;;;OAOG;IACU,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAMzD;;;;OAIG;IACU,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAM3D;;;;;;OAMG;IACU,aAAa,CACtB,IAAI,EAAE,qBAAqB,EAC3B,MAAM,GAAE,MAAM,GAAG,SAAqB,GACvC,OAAO,CAAC,MAAM,CAAC;IAMlB;;;;;;OAMG;IACU,oBAAoB,CAC7B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,qBAAqB,GAC5B,OAAO,CAAC,MAAM,CAAC;IAMlB;;;;;;OAMG;IACU,sBAAsB,CAC/B,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,uBAAuB,GACnC,OAAO,CAAC,MAAM,CAAC;IAQlB;;;;;;OAMG;IACU,yBAAyB,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAQ7F;;;;OAIG;IACI,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,qBAAqB,GAAG,IAAI;IAMnE;;;;OAIG;IACI,uBAAuB,IAAI,GAAG,EAAE;IAKvC;;;;OAIG;IACI,gBAAgB,IAAI,wBAAwB,GAAG,SAAS;IAK/D;;;;;OAKG;IACI,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,kBAAkB,GAAG,SAAS;IAKlE;;;;;OAKG;IACI,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,mBAAmB,GAAG,SAAS;IAKrE;;;;;;;;OAQG;IACI,cAAc,CACjB,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,MAAM,EACX,OAAO,SAAY,EACnB,UAAU,SAAW,GACtB,MAAM;IAOT;;;;;;;;OAQG;IACI,WAAW,CACd,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,MAAM,EACX,OAAO,SAAY,EACnB,UAAU,SAAW,GACtB,MAAM;IAOT;;;;;;;;OAQG;IACI,cAAc,CACjB,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,MAAM,EACX,OAAO,SAAY,EACnB,UAAU,SAAW,GACtB,MAAM;IAOT;;;;;OAKG;IACI,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,SAAY,EAAE,UAAU,SAAW,GAAG,MAAM;IAOtF;;;OAGG;IACI,gBAAgB,IAAI,MAAM;IAMjC;;;;;;OAMG;IACI,oBAAoB,IAAI,MAAM;IASrC;;;OAGG;IACI,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAS/C;;;OAGG;IACI,cAAc,IAAI,cAAc,EAAE;IAKzC;;;OAGG;IACI,WAAW,IAAI,OAAO;IAqB7B;;;;;OAKG;IACU,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBzE;;;;;;;OAOG;IACU,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAoBpF,SAAS,CAAC,GAAG,SAAM;IACnB,SAAS,CAAC,KAAK,SAAM;IAErB,SAAS,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAG/B,SAAS,CAAC,KAAK,EAAE,aAAa,CAAuB;IAErD,SAAS,CAAC,aAAa,EAAE,mBAAmB,CAA6B;IAOzE,OAAO,CAAC,UAAU,CAAoB;IAGtC,OAAO,CAAC,YAAY,CAAwB;IAG5C,OAAO,CAAC,kBAAkB,CAAoD;CACjF"}

package/dist/types/project/ProjEnvProjectConfig.d.ts

@@ -0,0 +1,54 @@
+export declare class ProjEnvProjectConfig {
+    throwErrors: boolean;
+    protected _configFilePath: string;
+    /**
+     * Default constructor
+     * @param configFilePath optional path to config file
+     */
+    constructor(configFilePath?: string);
+    /**
+     * Return full native path to the config file. Returns empty string
+     * if not set.
+     */
+    getConfigPath(): string;
+    /**
+     * Set config path. This only sets the member; it does not create files.
+     */
+    setConfigPath(configFilePath: string): void;
+    /**
+     * Insert a value into the config. Placeholder: returns -1 and optionally
+     * throws when not implemented.
+     */
+    insertValue(value: unknown, key: string, _section?: string): number;
+    /**
+     * Set a value in the config. Placeholder implementation.
+     */
+    setValue(value: unknown, key: string, _section?: string): number;
+    /**
+     * Delete a value in the config. Placeholder implementation.
+     */
+    deleteValue(value: unknown, key: string, _section?: string): number;
+    /**
+     * Delete an entry by key in the config. Placeholder implementation.
+     */
+    deleteEntry(key: string, _section?: string): number;
+    getEntryValueList(key: string, _section?: string): string[] | undefined;
+    getEntryValue(key: string, _section?: string): string | undefined;
+    private loaded;
+    private sections;
+    private getSection;
+    /**
+     * Parses a configuration file into sections
+     * @param content File content to parse
+     * @returns Sections with key-value pairs
+     */
+    private parseConfigSections;
+    /**
+     * Save sections back to the config file.
+     * Ensures `[general]` is always the first section. Other sections and keys
+     * are written alphanumerically.
+     */
+    private saveConfigSections;
+}
+export default ProjEnvProjectConfig;
+//# sourceMappingURL=ProjEnvProjectConfig.d.ts.map

package/dist/types/project/ProjEnvProjectConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProjEnvProjectConfig.d.ts","sourceRoot":"","sources":["../../../src/types/project/ProjEnvProjectConfig.ts"],"names":[],"mappings":"AAkBA,qBAAa,oBAAoB;IAEtB,WAAW,UAAQ;IAG1B,SAAS,CAAC,eAAe,SAAM;IAE/B;;;OAGG;gBACS,cAAc,GAAE,MAAW;IAIvC;;;OAGG;IACI,aAAa,IAAI,MAAM;IAI9B;;OAEG;IACI,aAAa,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI;IAWlD;;;OAGG;IACI,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,SAAY,GAAG,MAAM;IAmB7E;;OAEG;IACI,QAAQ,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,SAAY,GAAG,MAAM;IAkB1E;;OAEG;IACI,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,SAAY,GAAG,MAAM;IAwB7E;;OAEG;IACI,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,SAAY,GAAG,MAAM;IAsBtD,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,SAAY,GAAG,MAAM,EAAE,GAAG,SAAS;IAoB1E,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,SAAY,GAAG,MAAM,GAAG,SAAS;IAoB3E,OAAO,CAAC,MAAM,CAAkB;IAChC,OAAO,CAAC,QAAQ,CAAyD;IAEzE,OAAO,CAAC,UAAU;IAUlB;;;;OAIG;IACH,OAAO,CAAC,mBAAmB;IA0C3B;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;CA0C7B;AAED,eAAe,oBAAoB,CAAC"}

package/dist/types/project/ProjEnvProjectRegistry.d.ts

@@ -0,0 +1,61 @@
+/**
+ * Represents the basic configuration information for a WinCC OA project
+ * as stored in the PVSS configuration files and Windows registry.
+ */
+export interface ProjEnvProjectRegistry {
+    /** The project ID */
+    id: string;
+    /** Absolute path to the project installation directory */
+    installationDir: string;
+    /** ISO 8601 date string when the project was installed/created */
+    installationDate: string;
+    /** Whether this project is runnable (has proper configuration) */
+    notRunnable: boolean;
+    /** Optional company/organization that created the project */
+    company?: string;
+    /** Optional the display name of the project */
+    name?: string;
+    /** Optional the project description */
+    description?: string;
+    /** Whether this is the currently active project in WinCC OA */
+    currentProject?: boolean;
+    installationVersion?: string;
+    invalidReason?: string;
+}
+export interface ProductRegistry extends ProjEnvProjectRegistry {
+    lastUsedProjectDir?: string;
+    currentproject?: string;
+}
+/**
+ * Retrieves all registered WinCC OA projects from the system configuration.
+ * Loads from pvssInst.conf on first call and caches the results.
+ * The cache is automatically refreshed when the configuration file changes.
+ *
+ * @returns Array of all registered project configurations
+ */
+export declare function getRegisteredProjects(): ProjEnvProjectRegistry[];
+/**
+ * Retrieves all registered WinCC OA product installations (versions) from the system.
+ * Loads from pvssInst.conf on first call and caches the results.
+ * The cache is automatically refreshed when the configuration file changes.
+ *
+ * @returns Array of all registered product (version) configurations
+ */
+export declare function getRegisteredProducts(): ProductRegistry[];
+/**
+ * Finds a registered project by its unique identifier.
+ *
+ * @param id - The project ID to search for
+ * @returns Project registry entry if found, undefined otherwise
+ */
+export declare function findProjectRegistryById(id: string): ProjEnvProjectRegistry | undefined;
+export declare function getProductByVersion(version: string): ProductRegistry | undefined;
+export declare function getLastUsedProjectDir(version: string): string | undefined;
+/**
+ * Forces an immediate reload of project registries from pvssInst.conf.
+ * Useful when you need to ensure the cache is up-to-date.
+ * Note: File watching with automatic reload is already active, so this
+ * is typically only needed for manual refresh scenarios.
+ */
+export declare function reloadProjectRegistries(): void;
+//# sourceMappingURL=ProjEnvProjectRegistry.d.ts.map

package/dist/types/project/ProjEnvProjectRegistry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProjEnvProjectRegistry.d.ts","sourceRoot":"","sources":["../../../src/types/project/ProjEnvProjectRegistry.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACnC,qBAAqB;IACrB,EAAE,EAAE,MAAM,CAAC;IAEX,0DAA0D;IAC1D,eAAe,EAAE,MAAM,CAAC;IAExB,kEAAkE;IAClE,gBAAgB,EAAE,MAAM,CAAC;IAEzB,kEAAkE;IAClE,WAAW,EAAE,OAAO,CAAC;IAErB,6DAA6D;IAC7D,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,+CAA+C;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,uCAAuC;IACvC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,+DAA+D;IAC/D,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,eAAgB,SAAQ,sBAAsB;IAC3D,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAC;CAC3B;AA0BD;;;;;;GAMG;AACH,wBAAgB,qBAAqB,IAAI,sBAAsB,EAAE,CAGhE;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,IAAI,eAAe,EAAE,CAGzD;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,sBAAsB,GAAG,SAAS,CAEtF;AAED,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS,CAGhF;AAED,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAGzE;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,IAAI,IAAI,CAE9C"}

package/dist/types/status/WinCCOAManager.d.ts

@@ -0,0 +1,15 @@
+export interface WinCCOAManager {
+    index: number;
+    name: string;
+    status: string;
+    pid?: number;
+    startMode?: 'manual' | 'once' | 'always';
+    secKill?: number;
+    restartCount?: number;
+    resetMin?: number;
+    args?: string;
+    runningState?: 'stopped' | 'init' | 'running' | 'blocked';
+    managerNumber?: number;
+    startTimeStamp?: Date;
+}
+//# sourceMappingURL=WinCCOAManager.d.ts.map

package/dist/types/status/WinCCOAManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WinCCOAManager.d.ts","sourceRoot":"","sources":["../../../src/types/status/WinCCOAManager.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,cAAc;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,CAAC;IAC1D,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,IAAI,CAAC;CACzB"}

package/dist/types/version/DetailedVersionInfo.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Detailed version information for WinCC OA components.
+ */
+export interface DetailedVersionInfo {
+    /** Major version number */
+    major: number;
+    /** Minor version number */
+    minor: number;
+    /** Optional patch version number */
+    patch?: number;
+    /** Original version string */
+    raw: string;
+    /** Numeric comparable value produced by parseVersionString */
+    numeric?: number;
+}
+//# sourceMappingURL=DetailedVersionInfo.d.ts.map

package/dist/types/version/DetailedVersionInfo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DetailedVersionInfo.d.ts","sourceRoot":"","sources":["../../../src/types/version/DetailedVersionInfo.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,WAAW,mBAAmB;IAChC,2BAA2B;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,2BAA2B;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,oCAAoC;IACpC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8BAA8B;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,8DAA8D;IAC9D,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB"}

package/dist/utils/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Utility Functions
+ * Core utility functions for WinCC OA operations
+ */
+export * from './winccoa-components';
+export * from './winccoa-paths';
+export * from './winccoa-project-environment';
+export * from './winccoa-version-info';
+//# sourceMappingURL=index.d.ts.map

package/dist/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,wBAAwB,CAAC"}

package/dist/utils/winccoa-components.d.ts

@@ -0,0 +1,3 @@
+import { WinCCOAComponent } from '../types/components/WinCCOAComponent';
+export declare function getComponentName(component: WinCCOAComponent): string;
+//# sourceMappingURL=winccoa-components.d.ts.map