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

package/dist/esm/utils/winccoa-paths.js

@@ -0,0 +1,184 @@
+/**
+ * WinCC OA Installation Path Utilities
+ * Handles platform-specific path discovery and component path resolution
+ *
+ * PERFORMANCE OPTIMIZATION:
+ * This module implements aggressive caching to minimize expensive file system
+ * and Windows registry operations. Cached values persist for the lifetime of
+ * the extension.
+ *
+ * IMPORTANT: If WinCC OA is installed or removed while VS Code is running,
+ * the extension must be reloaded (or VS Code restarted) to detect the changes.
+ * This is an acceptable trade-off for the significant performance improvement.
+ *
+ * Cache Strategy:
+ * - Installation paths are cached per version in cachedWinCCOAInstallationPathByVersion
+ * - Available versions list is cached once in cachedAvailableWinCCOAVersions
+ * - Both caches persist until extension reload/restart
+ *
+ * @author mPokornyETM
+ * @performance Caching reduces registry queries and file system operations by ~95%
+ */
+import * as os from 'os';
+import * as path from 'path';
+import * as fs from 'fs';
+import { execSync, execFileSync } from 'child_process';
+import { parseVersionString } from './winccoa-version-info.js';
+/**
+ * Cache for WinCC OA installation paths indexed by version
+ * Prevents redundant registry queries and file system checks
+ *
+ * Note: Cache persists for extension lifetime. Extension reload required
+ * if WinCC OA installations change.
+ */
+const cachedWinCCOAInstallationPathByVersion = {};
+/**
+ * Finds the WinCC OA installation path for a given version
+ *
+ * CACHED: This function caches results per version. First lookup for each version
+ * performs registry query (Windows) or file system check (Linux). Subsequent
+ * lookups return cached value immediately.
+ *
+ * @param version - WinCC OA version (e.g., "3.20", "3.21")
+ * @returns Installation path or null if not found
+ * @performance First call per version: ~50-100ms, subsequent calls: <1ms
+ */
+export function getWinCCOAInstallationPathByVersion(version) {
+    // Check cache first - even null results are cached to avoid repeated failed lookups
+    if (cachedWinCCOAInstallationPathByVersion[version] !== undefined) {
+        return cachedWinCCOAInstallationPathByVersion[version];
+    }
+    const platform = os.platform();
+    if (platform === 'win32') {
+        cachedWinCCOAInstallationPathByVersion[version] = getWindowsInstallationPath(version);
+    }
+    else {
+        // Unix/Linux systems
+        cachedWinCCOAInstallationPathByVersion[version] = getUnixInstallationPath(version);
+    }
+    return cachedWinCCOAInstallationPathByVersion[version];
+}
+/**
+ * Gets WinCC OA installation path from Windows registry
+ * @param version - WinCC OA version
+ * @returns Installation path or null if not found
+ */
+function getWindowsInstallationPath(version) {
+    try {
+        // Try to read from registry using execFileSync to prevent shell injection
+        const regKey = `HKLM\\Software\\ETM\\WinCC_OA\\${version}`;
+        const args = ['query', regKey, '/v', 'INSTALLDIR'];
+        const output = execFileSync('reg', args, { encoding: 'utf-8' });
+        // Parse the output to extract the INSTALLDIR value
+        const match = output.match(/INSTALLDIR\s+REG_SZ\s+(.+)/);
+        if (match && match[1]) {
+            const installPath = match[1].trim();
+            if (fs.existsSync(installPath)) {
+                return installPath;
+            }
+        }
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    }
+    catch (error) {
+        // Registry key not found or command failed
+        // Fall back to default paths
+    }
+    return null;
+}
+/**
+ * Gets WinCC OA installation path on Unix/Linux systems
+ * @param version - WinCC OA version
+ * @returns Installation path or null if not found
+ */
+function getUnixInstallationPath(version) {
+    const installPath = `/opt/WinCC_OA/${version}`;
+    if (fs.existsSync(installPath)) {
+        return installPath;
+    }
+    return null;
+}
+/**
+ * Cache for available WinCC OA versions list
+ * Prevents redundant registry enumeration and directory scanning
+ *
+ * Performance Impact:
+ * - Windows: Eliminates repeated "reg query" command executions (~100ms each)
+ * - Linux: Eliminates repeated directory scans of /opt/WinCC_OA
+ *
+ * Note: Set to null initially, populated on first call. Cache persists for
+ * extension lifetime. Extension reload required if WinCC OA versions change.
+ */
+let cachedAvailableWinCCOAVersions = null;
+/**
+ * Gets available WinCC OA versions installed on the system
+ *
+ * CACHED: This function caches its result on first call. Subsequent calls
+ * return the cached value immediately without any file system or registry access.
+ *
+ * @returns Array of version strings sorted from highest to lowest
+ * @performance First call: ~100-200ms, subsequent calls: <1ms
+ */
+export function getAvailableWinCCOAVersions() {
+    // Return cached result if available - avoids expensive registry/filesystem operations
+    if (cachedAvailableWinCCOAVersions !== null) {
+        return cachedAvailableWinCCOAVersions;
+    }
+    const platform = os.platform();
+    if (platform === 'win32') {
+        cachedAvailableWinCCOAVersions = getWindowsAvailableVersions();
+    }
+    else {
+        cachedAvailableWinCCOAVersions = getUnixAvailableVersions();
+    }
+    return cachedAvailableWinCCOAVersions;
+}
+/**
+ * Gets available WinCC OA versions on Windows
+ * @returns Array of version strings sorted from highest to lowest
+ */
+export function getWindowsAvailableVersions() {
+    const versions = [];
+    try {
+        // Try to read from registry
+        const regKey = 'HKLM\\Software\\ETM\\WinCC_OA';
+        const command = `reg query "${regKey}"`;
+        const output = execSync(command, { encoding: 'utf-8' });
+        const lines = output.split('\n');
+        for (const line of lines) {
+            const match = line.match(/WinCC_OA\\(\d+\.\d+(?:\.\d+)?)/);
+            if (match && match[1]) {
+                versions.push(match[1]);
+            }
+        }
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    }
+    catch (error) {
+        // Registry query failed, try common paths
+    }
+    // Sort versions descending
+    return versions.sort((a, b) => parseVersionString(b) - parseVersionString(a));
+}
+/**
+ * Gets available WinCC OA versions on Unix/Linux
+ * @returns Array of version strings sorted from highest to lowest
+ */
+function getUnixAvailableVersions() {
+    const basePath = '/opt/WinCC_OA';
+    if (!fs.existsSync(basePath)) {
+        return [];
+    }
+    try {
+        const entries = fs.readdirSync(basePath);
+        const versions = entries.filter((entry) => {
+            const fullPath = path.join(basePath, entry);
+            return fs.statSync(fullPath).isDirectory() && /^\d+\.\d+/.test(entry);
+        });
+        // Sort versions descending
+        return versions.sort((a, b) => parseVersionString(b) - parseVersionString(a));
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    }
+    catch (error) {
+        return [];
+    }
+}
+//# sourceMappingURL=winccoa-paths.js.map

package/dist/esm/utils/winccoa-paths.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"winccoa-paths.js","sourceRoot":"","sources":["../../../src/utils/winccoa-paths.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAE/D;;;;;;GAMG;AACH,MAAM,sCAAsC,GAAyC,EAAE,CAAC;AAExF;;;;;;;;;;GAUG;AACH,MAAM,UAAU,mCAAmC,CAAC,OAAe;IAC/D,oFAAoF;IACpF,IAAI,sCAAsC,CAAC,OAAO,CAAC,KAAK,SAAS,EAAE,CAAC;QAChE,OAAO,sCAAsC,CAAC,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED,MAAM,QAAQ,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;IAE/B,IAAI,QAAQ,KAAK,OAAO,EAAE,CAAC;QACvB,sCAAsC,CAAC,OAAO,CAAC,GAAG,0BAA0B,CAAC,OAAO,CAAC,CAAC;IAC1F,CAAC;SAAM,CAAC;QACJ,qBAAqB;QACrB,sCAAsC,CAAC,OAAO,CAAC,GAAG,uBAAuB,CAAC,OAAO,CAAC,CAAC;IACvF,CAAC;IAED,OAAO,sCAAsC,CAAC,OAAO,CAAC,CAAC;AAC3D,CAAC;AAED;;;;GAIG;AACH,SAAS,0BAA0B,CAAC,OAAe;IAC/C,IAAI,CAAC;QACD,0EAA0E;QAC1E,MAAM,MAAM,GAAG,kCAAkC,OAAO,EAAE,CAAC;QAC3D,MAAM,IAAI,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;QACnD,MAAM,MAAM,GAAG,YAAY,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;QAEhE,mDAAmD;QACnD,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;QACzD,IAAI,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;YACpB,MAAM,WAAW,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YACpC,IAAI,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC7B,OAAO,WAAW,CAAC;YACvB,CAAC;QACL,CAAC;QACD,6DAA6D;IACjE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,2CAA2C;QAC3C,6BAA6B;IACjC,CAAC;IAED,OAAO,IAAI,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,SAAS,uBAAuB,CAAC,OAAe;IAC5C,MAAM,WAAW,GAAG,iBAAiB,OAAO,EAAE,CAAC;IAE/C,IAAI,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;QAC7B,OAAO,WAAW,CAAC;IACvB,CAAC;IAED,OAAO,IAAI,CAAC;AAChB,CAAC;AAED;;;;;;;;;;GAUG;AACH,IAAI,8BAA8B,GAAoB,IAAI,CAAC;AAE3D;;;;;;;;GAQG;AACH,MAAM,UAAU,2BAA2B;IACvC,sFAAsF;IACtF,IAAI,8BAA8B,KAAK,IAAI,EAAE,CAAC;QAC1C,OAAO,8BAA8B,CAAC;IAC1C,CAAC;IAED,MAAM,QAAQ,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;IAE/B,IAAI,QAAQ,KAAK,OAAO,EAAE,CAAC;QACvB,8BAA8B,GAAG,2BAA2B,EAAE,CAAC;IACnE,CAAC;SAAM,CAAC;QACJ,8BAA8B,GAAG,wBAAwB,EAAE,CAAC;IAChE,CAAC;IAED,OAAO,8BAA8B,CAAC;AAC1C,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,2BAA2B;IACvC,MAAM,QAAQ,GAAa,EAAE,CAAC;IAE9B,IAAI,CAAC;QACD,4BAA4B;QAC5B,MAAM,MAAM,GAAG,+BAA+B,CAAC;QAC/C,MAAM,OAAO,GAAG,cAAc,MAAM,GAAG,CAAC;QAExC,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;QACxD,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAEjC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACvB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAAC;YAC3D,IAAI,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;gBACpB,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5B,CAAC;QACL,CAAC;QACD,6DAA6D;IACjE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,0CAA0C;IAC9C,CAAC;IAED,2BAA2B;IAC3B,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,CAAC,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;AAClF,CAAC;AAED;;;GAGG;AACH,SAAS,wBAAwB;IAC7B,MAAM,QAAQ,GAAG,eAAe,CAAC;IAEjC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC3B,OAAO,EAAE,CAAC;IACd,CAAC;IAED,IAAI,CAAC;QACD,MAAM,OAAO,GAAG,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACzC,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,KAAa,EAAE,EAAE;YAC9C,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;YAC5C,OAAO,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,IAAI,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC1E,CAAC,CAAC,CAAC;QAEH,2BAA2B;QAC3B,OAAO,QAAQ,CAAC,IAAI,CAChB,CAAC,CAAS,EAAE,CAAS,EAAE,EAAE,CAAC,kBAAkB,CAAC,CAAC,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAC1E,CAAC;QACF,6DAA6D;IACjE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,OAAO,EAAE,CAAC;IACd,CAAC;AACL,CAAC"}

package/dist/esm/utils/winccoa-project-environment.js

@@ -0,0 +1,66 @@
+import { ProjEnvProject } from '../types/project/ProjEnvProject';
+import { getRegisteredProjects as getRegistries } from '../types/project/ProjEnvProjectRegistry';
+/**
+ * Finds and returns the ProjEnvProject instance for a given file or folder path
+ * by checking all registered projects.
+ * @param selectedPath - The file or folder path to check
+ * @returns ProjEnvProject instance if found, undefined otherwise
+ */
+export async function getProjectByProjectPath(selectedPath) {
+    return (await getRegisteredProjects()).find((project) => {
+        return project.isProjectFile(selectedPath);
+    });
+}
+/**
+ * Return a list of all registered projects.
+ * Creates ProjEnvProject instances from the Windows registry entries.
+ */
+export async function getRegisteredProjects() {
+    const registries = getRegistries();
+    const projects = [];
+    console.log(`Found ${registries.length} registered projects in the registry.`);
+    for (const registry of registries) {
+        //  console.log(`Processing registry entry for project ID: ${registry.id}`);
+        // Skip registry entries with empty or invalid IDs
+        if (!registry.id || registry.id.trim().length === 0) {
+            console.warn(`Skipping registry entry with empty ID`);
+            continue;
+        }
+        try {
+            const project = new ProjEnvProject();
+            project.initFromRegister(registry);
+            projects.push(project);
+        }
+        catch (error) {
+            // Skip projects that fail to initialize
+            console.warn(`Failed to initialize project ${registry.id}:`, error);
+        }
+    }
+    return projects;
+}
+/**Returns all running projects locate on the locale host
+ */
+export async function getRunningProjects() {
+    return (await getRunnableProjects()).filter((project) => project.isRunning());
+}
+/**Returns all runnable projects locate on the locale host*/
+export async function getRunnableProjects() {
+    return (await getRegisteredProjects()).filter((project) => project.isRunnable());
+}
+/**Returns all current projects locate on the locale host.
+ * A current project is the one that is currently active in WinCC OA.
+ * Note: per WinCC OA, there can be only one current project at a time.
+ * However, this function returns an array because you can have multiple WinCC OA installations
+ */
+export async function getCurrentProjects() {
+    return (await getRegisteredProjects()).filter((project) => project.isCurrentProject());
+}
+/** Export default object with all functions */
+export default {
+    getRegisteredProjects,
+    getRunningProjects,
+    getRunnableProjects,
+    getCurrentProjects,
+    getProjectByProjectPath,
+};
+//# sourceMappingURL=winccoa-project-environment.js.map

package/dist/esm/utils/winccoa-project-environment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"winccoa-project-environment.js","sourceRoot":"","sources":["../../../src/utils/winccoa-project-environment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,qBAAqB,IAAI,aAAa,EAAE,MAAM,yCAAyC,CAAC;AAEjG;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CACzC,YAAoB;IAEpB,OAAO,CAAC,MAAM,qBAAqB,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAuB,EAAE,EAAE;QACpE,OAAO,OAAO,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;AACP,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB;IACvC,MAAM,UAAU,GAAG,aAAa,EAAE,CAAC;IACnC,MAAM,QAAQ,GAAqB,EAAE,CAAC;IAEtC,OAAO,CAAC,GAAG,CAAC,SAAS,UAAU,CAAC,MAAM,uCAAuC,CAAC,CAAC;IAE/E,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;QAChC,4EAA4E;QAC5E,kDAAkD;QAClD,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAClD,OAAO,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAC;YACtD,SAAS;QACb,CAAC;QAED,IAAI,CAAC;YACD,MAAM,OAAO,GAAG,IAAI,cAAc,EAAE,CAAC;YACrC,OAAO,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;YACnC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC3B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,wCAAwC;YACxC,OAAO,CAAC,IAAI,CAAC,gCAAgC,QAAQ,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;QACxE,CAAC;IACL,CAAC;IAED,OAAO,QAAQ,CAAC;AACpB,CAAC;AAED;GACG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB;IACpC,OAAO,CAAC,MAAM,mBAAmB,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;AAClF,CAAC;AAED,4DAA4D;AAC5D,MAAM,CAAC,KAAK,UAAU,mBAAmB;IACrC,OAAO,CAAC,MAAM,qBAAqB,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;AACrF,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB;IACpC,OAAO,CAAC,MAAM,qBAAqB,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;AAC3F,CAAC;AAED,+CAA+C;AAC/C,eAAe;IACX,qBAAqB;IACrB,kBAAkB;IAClB,mBAAmB;IACnB,kBAAkB;IAClB,uBAAuB;CAC1B,CAAC"}

package/dist/esm/utils/winccoa-version-info.js

@@ -0,0 +1,20 @@
+/**
+ * WinCC OA Version Information Utilities
+ * Handles version string parsing and comparison
+ *
+ * @author mPokornyETM
+ */
+/**
+ * Parses a version string to a comparable number
+ * Format: major.minor.patch (patch is optional)
+ * @param version - Version string like "3.19" or "3.19.1"
+ * @returns Numeric representation for comparison (e.g., "3.19" -> 30190, "3.19.1" -> 319001)
+ */
+export function parseVersionString(version) {
+    const parts = version.split('.').map((part) => parseInt(part, 10) || 0);
+    const major = parts[0] || 0;
+    const minor = parts[1] || 0;
+    const patch = parts[2] || 0;
+    return major * 100000 + minor * 1000 + patch;
+}
+//# sourceMappingURL=winccoa-version-info.js.map

package/dist/esm/utils/winccoa-version-info.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"winccoa-version-info.js","sourceRoot":"","sources":["../../../src/utils/winccoa-version-info.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,OAAe;IAC9C,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IACxE,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC5B,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC5B,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC5B,OAAO,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,IAAI,GAAG,KAAK,CAAC;AACjD,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * WinCC OA Core Utilities
+ * Platform-agnostic utilities for WinCC OA automation
+ */
+export * from './utils/index.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,cAAc,kBAAkB,CAAC"}

package/dist/types/components/WinCCOAComponent.d.ts

@@ -0,0 +1,127 @@
+/**
+ * Platform-agnostic WinCC OA component base class
+ * Stripped of VS Code-specific APIs so it can live in the shared library.
+ */
+export declare abstract class WinCCOAComponent {
+    /**
+     * Accumulated standard output from the last spawned process.
+     * Use this to inspect output produced by helper commands invoked
+     * by the component (e.g., version queries).
+     */
+    stdOut: string;
+    /**
+     * Accumulated standard error output from the last spawned process.
+     */
+    stdErr: string;
+    /**
+     * Returns the canonical internal name of this component. This is the
+     * identifier used to locate the executable (e.g., 'WCCILpmon').
+     * Implementations must return a stable string.
+     */
+    abstract getName(): string;
+    /**
+     * Returns a human-friendly description of the component. This should be
+     * suitable for display or logs and remain language-neutral where possible.
+     */
+    abstract getDescription(): string;
+    /**
+     * Returns the executable filename used by the component. Defaults to
+     * the value returned by `getName()` but may be overridden by
+     * platform-specific implementations.
+     *
+     * @returns executable filename (without path)
+     */
+    getExecutableName(): string;
+    /**
+     * Attempts to discover the full filesystem path to the component
+     * executable by scanning known WinCC OA installation directories.
+     *
+     * The search strategy:
+     * - If version is specified, search only in that version's installation
+     * - Otherwise, query all available WinCC OA versions (cached by utils)
+     * - For each version, resolve the installation root and check
+     *   `bin/<executable>` and `bin/<executable>.exe` for existence.
+     *
+     * Returns the absolute path to the executable when found or `null`
+     * if not present on the host system.
+     *
+     * @param version - Optional WinCC OA version to search in (e.g., '3.20')
+     * @returns absolute path to executable or `null`
+     */
+    getPath(version?: string): string | null;
+    /**
+     * Returns `true` when the component's executable exists on disk and is
+     * discoverable by `getPath()`.
+     */
+    exists(): boolean;
+    /**
+     * Executes the component with the `-version` flag and extracts the version string
+     * from the output. Uses a 5-second timeout to prevent hanging.
+     *
+     * @returns parsed version string (e.g., '3.20.1') or `null` when no version could be found
+     */
+    getFullVersion(): Promise<string | null>;
+    /**
+     * Parses a version-like substring from arbitrary command output.
+     * Default implementation finds the first occurrence of `N.N` or
+     * `N.N.N` using a simple regex. Override in concrete components if
+     * they produce more complex version output.
+     *
+     * @param output - Raw output to inspect
+     * @returns matched version string or `null`
+     */
+    protected parseVersionOutput(output: string): string | null;
+    /**
+     * Starts the component process with the provided arguments.
+     * Captures stdout/stderr into `stdOut`/`stdErr` and resolves with the
+     * exit code when the process closes. Rejects on process start errors.
+     *
+     * **Detached Process Behavior:**
+     * When `detached: true`, the process runs independently of the parent:
+     * - Sets `stdio: 'ignore'` to prevent blocking on I/O streams
+     * - Calls `unref()` to allow parent to exit independently
+     * - Resolves immediately with exit code 0
+     * - stdout/stderr are NOT captured for detached processes
+     *
+     * **Timeout Behavior:**
+     * When timeout is specified, the process is killed if it doesn't complete
+     * within the given time. The promise rejects with a timeout error.
+     *
+     * **Version Selection:**
+     * If a specific version is provided, the component executable from that
+     * WinCC OA version will be used.
+     *
+     * @param args - Array of arguments to pass to the executable
+     * @param options.detached - Whether to spawn the process detached (default: false)
+     * @param options.timeout - Timeout in milliseconds; kills process if exceeded (optional)
+     * @param options.version - Specific WinCC OA version to use (optional)
+     * @param options.waitForLog - Wait for specific log output (TODO: not yet implemented)
+     * @returns Promise resolving with process exit code (0 for detached processes)
+     * @throws Error if executable not found or timeout exceeded
+     */
+    start(args?: string[], options?: {
+        detached?: boolean;
+        waitForLog?: string;
+        timeout?: number;
+        version?: string;
+    }): Promise<number>;
+    /**
+     * Execute a command and collect stdout lines as an array of strings.
+     * Returns trimmed lines (excluding empty lines and terminating ';').
+     *
+     * This is a utility method for executing short-lived commands that produce
+     * line-based output. Stderr is captured separately but not returned.
+     *
+     * **Timeout Behavior:**
+     * If timeout is specified and exceeded, the process is killed and the
+     * promise rejects with a timeout error.
+     *
+     * @param cmdPath - Absolute path to the executable
+     * @param args - Array of command-line arguments to pass
+     * @param timeout - Optional timeout in milliseconds; kills process if exceeded
+     * @returns Array of trimmed, non-empty output lines
+     * @throws Error if process fails to spawn or timeout is exceeded
+     */
+    protected execAndCollectLines(cmdPath: string, args: string[], timeout?: number): Promise<string[]>;
+}
+//# sourceMappingURL=WinCCOAComponent.d.ts.map

package/dist/types/components/WinCCOAComponent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WinCCOAComponent.d.ts","sourceRoot":"","sources":["../../../src/types/components/WinCCOAComponent.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA2BH,8BAAsB,gBAAgB;IAElC;;;;OAIG;IACI,MAAM,EAAE,MAAM,CAAM;IAE3B;;OAEG;IACI,MAAM,EAAE,MAAM,CAAM;IAE3B;;;;OAIG;IACH,QAAQ,CAAC,OAAO,IAAI,MAAM;IAE1B;;;OAGG;IACH,QAAQ,CAAC,cAAc,IAAI,MAAM;IAEjC;;;;;;OAMG;IACI,iBAAiB,IAAI,MAAM;IAIlC;;;;;;;;;;;;;;;OAeG;IACI,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAsB/C;;;OAGG;IACI,MAAM,IAAI,OAAO;IAKxB;;;;;OAKG;IACU,cAAc,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAUrD;;;;;;;;OAQG;IACH,SAAS,CAAC,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAK3D;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACU,KAAK,CACd,IAAI,GAAE,MAAM,EAAO,EACnB,OAAO,GAAE;QACL,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC;KACf,GACP,OAAO,CAAC,MAAM,CAAC;IAkFlB;;;;;;;;;;;;;;;;OAgBG;cACa,mBAAmB,CAC/B,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EAAE,EACd,OAAO,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,MAAM,EAAE,CAAC;CAuCvB"}

package/dist/types/components/implementations/AlertManagerComponent.d.ts

@@ -0,0 +1,6 @@
+import { WinCCOAComponent } from '../WinCCOAComponent.js';
+export declare class AlertManagerComponent extends WinCCOAComponent {
+    getName(): string;
+    getDescription(): string;
+}
+//# sourceMappingURL=AlertManagerComponent.d.ts.map

package/dist/types/components/implementations/AlertManagerComponent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AlertManagerComponent.d.ts","sourceRoot":"","sources":["../../../../src/types/components/implementations/AlertManagerComponent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,qBAAa,qBAAsB,SAAQ,gBAAgB;IAChD,OAAO,IAAI,MAAM;IAGjB,cAAc,IAAI,MAAM;CAGlC"}

package/dist/types/components/implementations/AndroidComponent.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Android Mobile Component
+ */
+import { WinCCOAComponent } from '../WinCCOAComponent.js';
+export declare class AndroidComponent extends WinCCOAComponent {
+    getName(): string;
+    getDescription(): string;
+}
+//# sourceMappingURL=AndroidComponent.d.ts.map

package/dist/types/components/implementations/AndroidComponent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AndroidComponent.d.ts","sourceRoot":"","sources":["../../../../src/types/components/implementations/AndroidComponent.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,qBAAa,gBAAiB,SAAQ,gBAAgB;IAC3C,OAAO,IAAI,MAAM;IAIjB,cAAc,IAAI,MAAM;CAKlC"}

package/dist/types/components/implementations/ApiComponent.d.ts

@@ -0,0 +1,6 @@
+import { WinCCOAComponent } from '../WinCCOAComponent.js';
+export declare class ApiComponent extends WinCCOAComponent {
+    getName(): string;
+    getDescription(): string;
+}
+//# sourceMappingURL=ApiComponent.d.ts.map

package/dist/types/components/implementations/ApiComponent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiComponent.d.ts","sourceRoot":"","sources":["../../../../src/types/components/implementations/ApiComponent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,qBAAa,YAAa,SAAQ,gBAAgB;IACvC,OAAO,IAAI,MAAM;IAIjB,cAAc,IAAI,MAAM;CAKlC"}

package/dist/types/components/implementations/AsciiManagerComponent.d.ts

@@ -0,0 +1,6 @@
+import { WinCCOAComponent } from '../WinCCOAComponent.js';
+export declare class AsciiManagerComponent extends WinCCOAComponent {
+    getName(): string;
+    getDescription(): string;
+}
+//# sourceMappingURL=AsciiManagerComponent.d.ts.map

package/dist/types/components/implementations/AsciiManagerComponent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AsciiManagerComponent.d.ts","sourceRoot":"","sources":["../../../../src/types/components/implementations/AsciiManagerComponent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,qBAAa,qBAAsB,SAAQ,gBAAgB;IAChD,OAAO,IAAI,MAAM;IAGjB,cAAc,IAAI,MAAM;CAGlC"}

package/dist/types/components/implementations/ConfComponent.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Configuration Component
+ */
+import { WinCCOAComponent } from '../WinCCOAComponent.js';
+export declare class ConfComponent extends WinCCOAComponent {
+    getName(): string;
+    getDescription(): string;
+}
+//# sourceMappingURL=ConfComponent.d.ts.map

package/dist/types/components/implementations/ConfComponent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfComponent.d.ts","sourceRoot":"","sources":["../../../../src/types/components/implementations/ConfComponent.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,qBAAa,aAAc,SAAQ,gBAAgB;IACxC,OAAO,IAAI,MAAM;IAIjB,cAAc,IAAI,MAAM;CAKlC"}

package/dist/types/components/implementations/CtrlComponent.d.ts

@@ -0,0 +1,10 @@
+import { WinCCOAComponent } from '../WinCCOAComponent.js';
+export declare class CtrlComponent extends WinCCOAComponent {
+    getName(): string;
+    getDescription(): string;
+    /**
+     * Starts the Control Manager with a specific script
+     */
+    startWithScript(scriptName: string, additionalArgs?: string[], outputCallback?: (msg: string) => void): Promise<number>;
+}
+//# sourceMappingURL=CtrlComponent.d.ts.map

package/dist/types/components/implementations/CtrlComponent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CtrlComponent.d.ts","sourceRoot":"","sources":["../../../../src/types/components/implementations/CtrlComponent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,qBAAa,aAAc,SAAQ,gBAAgB;IACxC,OAAO,IAAI,MAAM;IAIjB,cAAc,IAAI,MAAM;IAI/B;;OAEG;IACU,eAAe,CACxB,UAAU,EAAE,MAAM,EAClB,cAAc,GAAE,MAAM,EAAO,EAC7B,cAAc,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,GACvC,OAAO,CAAC,MAAM,CAAC;CAmBrB"}

package/dist/types/components/implementations/DNP3Component.d.ts

@@ -0,0 +1,9 @@
+/**
+ * DNP3 Driver Component
+ */
+import { WinCCOAComponent } from '../WinCCOAComponent.js';
+export declare class DNP3Component extends WinCCOAComponent {
+    getName(): string;
+    getDescription(): string;
+}
+//# sourceMappingURL=DNP3Component.d.ts.map

package/dist/types/components/implementations/DNP3Component.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DNP3Component.d.ts","sourceRoot":"","sources":["../../../../src/types/components/implementations/DNP3Component.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,qBAAa,aAAc,SAAQ,gBAAgB;IACxC,OAAO,IAAI,MAAM;IAIjB,cAAc,IAAI,MAAM;CAKlC"}

package/dist/types/components/implementations/DataComponent.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Database Manager Component
+ */
+import { WinCCOAComponent } from '../WinCCOAComponent.js';
+export declare class DataComponent extends WinCCOAComponent {
+    getName(): string;
+    getDescription(): string;
+}
+//# sourceMappingURL=DataComponent.d.ts.map

package/dist/types/components/implementations/DataComponent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataComponent.d.ts","sourceRoot":"","sources":["../../../../src/types/components/implementations/DataComponent.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,qBAAa,aAAc,SAAQ,gBAAgB;IACxC,OAAO,IAAI,MAAM;IAIjB,cAAc,IAAI,MAAM;CAKlC"}

package/dist/types/components/implementations/DbManagerComponent.d.ts

@@ -0,0 +1,6 @@
+import { WinCCOAComponent } from '../WinCCOAComponent.js';
+export declare class DbManagerComponent extends WinCCOAComponent {
+    getName(): string;
+    getDescription(): string;
+}
+//# sourceMappingURL=DbManagerComponent.d.ts.map

package/dist/types/components/implementations/DbManagerComponent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DbManagerComponent.d.ts","sourceRoot":"","sources":["../../../../src/types/components/implementations/DbManagerComponent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,qBAAa,kBAAmB,SAAQ,gBAAgB;IAC7C,OAAO,IAAI,MAAM;IAGjB,cAAc,IAAI,MAAM;CAGlC"}

package/dist/types/components/implementations/DistComponent.d.ts

@@ -0,0 +1,6 @@
+import { WinCCOAComponent } from '../WinCCOAComponent.js';
+export declare class DistComponent extends WinCCOAComponent {
+    getName(): string;
+    getDescription(): string;
+}
+//# sourceMappingURL=DistComponent.d.ts.map

package/dist/types/components/implementations/DistComponent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DistComponent.d.ts","sourceRoot":"","sources":["../../../../src/types/components/implementations/DistComponent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,qBAAa,aAAc,SAAQ,gBAAgB;IACxC,OAAO,IAAI,MAAM;IAGjB,cAAc,IAAI,MAAM;CAGlC"}

package/dist/types/components/implementations/DriverComponent.d.ts

@@ -0,0 +1,6 @@
+import { WinCCOAComponent } from '../WinCCOAComponent.js';
+export declare class DriverComponent extends WinCCOAComponent {
+    getName(): string;
+    getDescription(): string;
+}
+//# sourceMappingURL=DriverComponent.d.ts.map

package/dist/types/components/implementations/DriverComponent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DriverComponent.d.ts","sourceRoot":"","sources":["../../../../src/types/components/implementations/DriverComponent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,qBAAa,eAAgB,SAAQ,gBAAgB;IAC1C,OAAO,IAAI,MAAM;IAGjB,cAAc,IAAI,MAAM;CAGlC"}

package/dist/types/components/implementations/EventComponent.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Event Manager Component
+ */
+import { WinCCOAComponent } from '../WinCCOAComponent.js';
+export declare class EventComponent extends WinCCOAComponent {
+    getName(): string;
+    getDescription(): string;
+}
+//# sourceMappingURL=EventComponent.d.ts.map

package/dist/types/components/implementations/EventComponent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventComponent.d.ts","sourceRoot":"","sources":["../../../../src/types/components/implementations/EventComponent.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,qBAAa,cAAe,SAAQ,gBAAgB;IACzC,OAAO,IAAI,MAAM;IAIjB,cAAc,IAAI,MAAM;CAKlC"}

package/dist/types/components/implementations/HttpComponent.d.ts

@@ -0,0 +1,6 @@
+import { WinCCOAComponent } from '../WinCCOAComponent.js';
+export declare class HttpComponent extends WinCCOAComponent {
+    getName(): string;
+    getDescription(): string;
+}
+//# sourceMappingURL=HttpComponent.d.ts.map

package/dist/types/components/implementations/HttpComponent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HttpComponent.d.ts","sourceRoot":"","sources":["../../../../src/types/components/implementations/HttpComponent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,qBAAa,aAAc,SAAQ,gBAAgB;IACxC,OAAO,IAAI,MAAM;IAGjB,cAAc,IAAI,MAAM;CAGlC"}

package/dist/types/components/implementations/IEC60870Component.d.ts

@@ -0,0 +1,9 @@
+/**
+ * IEC 60870 Driver Component
+ */
+import { WinCCOAComponent } from '../WinCCOAComponent.js';
+export declare class IEC60870Component extends WinCCOAComponent {
+    getName(): string;
+    getDescription(): string;
+}
+//# sourceMappingURL=IEC60870Component.d.ts.map

package/dist/types/components/implementations/IEC60870Component.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEC60870Component.d.ts","sourceRoot":"","sources":["../../../../src/types/components/implementations/IEC60870Component.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,qBAAa,iBAAkB,SAAQ,gBAAgB;IAC5C,OAAO,IAAI,MAAM;IAIjB,cAAc,IAAI,MAAM;CAKlC"}

package/dist/types/components/implementations/IEC61850Component.d.ts

@@ -0,0 +1,9 @@
+/**
+ * IEC 61850 Client Component
+ */
+import { WinCCOAComponent } from '../WinCCOAComponent.js';
+export declare class IEC61850Component extends WinCCOAComponent {
+    getName(): string;
+    getDescription(): string;
+}
+//# sourceMappingURL=IEC61850Component.d.ts.map

package/dist/types/components/implementations/IEC61850Component.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEC61850Component.d.ts","sourceRoot":"","sources":["../../../../src/types/components/implementations/IEC61850Component.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,qBAAa,iBAAkB,SAAQ,gBAAgB;IAC5C,OAAO,IAAI,MAAM;IAIjB,cAAc,IAAI,MAAM;CAKlC"}