@trustify-da/trustify-da-javascript-client 0.3.0-ea.b68592e → 0.3.0-ea.b77d624

package/dist/src/remediation_report.js

@@ -0,0 +1,159 @@
+/**
+ * Report generator that transforms remediation extractor output into structured
+ * markdown for PR bodies, CLI dry-run output, and JSON.
+ */
+import { SEVERITY_ORDER } from './remediation.js';
+/**
+ * Generates a formatted report from an array of remediation entries.
+ *
+ * @param {Array<{purl: string, groupId: string, artifactId: string, currentVersion: string,
+ *   fixedInVersion: string, fixedInPurl: string, provider: string, source: string,
+ *   advisories: Array<{id: string, url: string}>, severity: string, cves: string[]}>} remediations
+ * @param {object} [options]
+ * @param {'dependency'|'bundle'} [options.groupBy='dependency'] - grouping strategy
+ * @param {'markdown'|'json'} [options.format='markdown'] - output format
+ * @param {boolean} [options.dryRun=false] - when true, produces tabular summary
+ * @returns {string}
+ */
+export function generateReport(remediations, options = {}) {
+    const { groupBy = 'dependency', format = 'markdown', dryRun = false } = options;
+    if (!remediations || remediations.length === 0) {
+        return format === 'json' ? '[]' : 'No remediations found.';
+    }
+    if (format === 'json') {
+        return JSON.stringify(remediations, null, '\t');
+    }
+    if (dryRun) {
+        return generateDryRunReport(remediations);
+    }
+    if (groupBy === 'bundle') {
+        return generateBundledReport(remediations);
+    }
+    return generatePerDependencyReport(remediations);
+}
+/**
+ * Generates a per-dependency markdown report with one section per remediation entry.
+ * @param {Array<object>} remediations
+ * @returns {string}
+ */
+function generatePerDependencyReport(remediations) {
+    const sections = remediations.map(rem => {
+        const depName = rem.groupId
+            ? `${rem.groupId}:${rem.artifactId}`
+            : rem.artifactId;
+        const lines = [
+            `## Security Update: ${depName} ${rem.currentVersion} → ${rem.fixedInVersion}`,
+            '',
+            `**Provider:** ${rem.provider} | **Source:** ${rem.source}`,
+            '',
+        ];
+        if (rem.cves && rem.cves.length > 0) {
+            lines.push('### Vulnerabilities resolved');
+            lines.push('');
+            lines.push('| CVE | Severity | Advisory |');
+            lines.push('| --- | --- | --- |');
+            const advisoryLinks = formatAdvisoryLinks(rem.advisories);
+            for (const cve of rem.cves) {
+                lines.push(`| ${cve} | ${rem.severity} | ${advisoryLinks} |`);
+            }
+        }
+        return lines.join('\n');
+    });
+    return sections.join('\n\n');
+}
+/**
+ * Generates a bundled markdown report grouping all remediations by severity.
+ * @param {Array<object>} remediations
+ * @returns {string}
+ */
+function generateBundledReport(remediations) {
+    const lines = ['# Security Update Summary', ''];
+    const bySeverity = groupBySeverity(remediations);
+    for (const severity of [...SEVERITY_ORDER].reverse()) {
+        const group = bySeverity.get(severity);
+        if (!group || group.length === 0) {
+            continue;
+        }
+        lines.push(`## ${severity}`);
+        lines.push('');
+        lines.push('| Dependency | Current | Fixed | Provider | CVEs | Advisory |');
+        lines.push('| --- | --- | --- | --- | --- | --- |');
+        for (const rem of group) {
+            const depName = rem.groupId
+                ? `${rem.groupId}:${rem.artifactId}`
+                : rem.artifactId;
+            const cves = (rem.cves || []).join(', ');
+            const advisoryLinks = formatAdvisoryLinks(rem.advisories);
+            lines.push(`| ${depName} | ${rem.currentVersion} | ${rem.fixedInVersion}`
+                + ` | ${rem.provider} | ${cves} | ${advisoryLinks} |`);
+        }
+        lines.push('');
+    }
+    return lines.join('\n').trimEnd();
+}
+/**
+ * Generates a tabular dry-run summary of proposed changes.
+ * @param {Array<object>} remediations
+ * @returns {string}
+ */
+function generateDryRunReport(remediations) {
+    const lines = [
+        'Proposed dependency updates:',
+        '',
+        '| Dependency | Current | Fixed | Severity | Provider |',
+        '| --- | --- | --- | --- | --- |',
+    ];
+    for (const rem of remediations) {
+        const depName = rem.groupId
+            ? `${rem.groupId}:${rem.artifactId}`
+            : rem.artifactId;
+        lines.push(`| ${depName} | ${rem.currentVersion} | ${rem.fixedInVersion}`
+            + ` | ${rem.severity} | ${rem.provider} |`);
+    }
+    return lines.join('\n');
+}
+/**
+ * Groups remediations by their severity.
+ * @param {Array<object>} remediations
+ * @returns {Map<string, Array<object>>}
+ */
+function groupBySeverity(remediations) {
+    const map = new Map();
+    for (const severity of SEVERITY_ORDER) {
+        map.set(severity, []);
+    }
+    for (const rem of remediations) {
+        const sev = rem.severity || 'UNKNOWN';
+        if (!map.has(sev)) {
+            map.set(sev, []);
+        }
+        map.get(sev).push(rem);
+    }
+    return map;
+}
+/**
+ * Formats advisory entries into markdown links or plain text.
+ * @param {Array<{id: string, url: string}>} advisories
+ * @returns {string}
+ */
+function formatAdvisoryLinks(advisories) {
+    if (!advisories || advisories.length === 0) {
+        return '-';
+    }
+    return advisories
+        .map(adv => adv.url ? `[${adv.id}](${adv.url})` : adv.id)
+        .join(', ');
+}
+/**
+ * Generates a deterministic deduplication key for a remediation entry.
+ * Suitable for checking existing PR titles or branch names.
+ *
+ * @param {object} remediation - a single remediation entry
+ * @returns {string} stable key in the form `groupId:artifactId:newVersion`
+ */
+export function generateDeduplicationKey(remediation) {
+    const group = remediation.groupId || '';
+    const artifact = remediation.artifactId || '';
+    const version = remediation.fixedInVersion || '';
+    return `${group}:${artifact}:${version}`;
+}

package/dist/src/sbom.d.ts

@@ -33,6 +33,17 @@ export default class Sbom {
         alg: string;
         content: string;
     }>): CycloneDxSbom;
+    /**
+     * Attach hashes to existing components by matching their PURL. Post-processing
+     * step used by ecosystem-specific providers (e.g. Maven) to enrich the SBOM
+     * with artifact hashes without leaking their concern into the shared parser.
+     * @param {Map<string, Array<{alg: string, content: string}>>} hashMap - PURL→hashes map
+     * @return {Sbom}
+     */
+    attachHashes(hashMap: Map<string, Array<{
+        alg: string;
+        content: string;
+    }>>): Sbom;
     /**
      * @return String sbom json in a string format
      */

package/dist/src/sbom.js

@@ -50,6 +50,16 @@ export default class Sbom {
     addDependency(sourceRef, targetRef, scope, targetHashes) {
         return this.sbomModel.addDependency(sourceRef, targetRef, scope, targetHashes);
     }
+    /**
+     * Attach hashes to existing components by matching their PURL. Post-processing
+     * step used by ecosystem-specific providers (e.g. Maven) to enrich the SBOM
+     * with artifact hashes without leaking their concern into the shared parser.
+     * @param {Map<string, Array<{alg: string, content: string}>>} hashMap - PURL→hashes map
+     * @return {Sbom}
+     */
+    attachHashes(hashMap) {
+        return this.sbomModel.attachHashes(hashMap);
+    }
     /**
      * @return String sbom json in a string format
      */

package/dist/src/tools.js

@@ -42,6 +42,28 @@ export function getCustom(key, def = null, opts = {}) {
     }
     return key in process.env ? process.env[key] : key in opts && typeof opts[key] === 'string' ? opts[key] : def;
 }
+/**
+ * Validates that an executable path does not use directory traversal or relative segments.
+ * @param {string} binPath - The executable path to validate.
+ * @returns {string} The validated path.
+ * @throws {Error} If the path contains '..' segments or is a relative path with separators.
+ */
+function validateExecutablePath(binPath) {
+    if (typeof binPath !== 'string' || binPath.length === 0) {
+        throw new Error('Executable path rejected: expected a non-empty string');
+    }
+    if (binPath.startsWith('./') || binPath.startsWith('.\\')) {
+        throw new Error(`Executable path rejected: relative paths starting with './' are not allowed: ${binPath}`);
+    }
+    const segments = binPath.split(/[/\\]/);
+    if (segments.includes('..')) {
+        throw new Error(`Executable path rejected: path contains directory traversal segment (..): ${binPath}`);
+    }
+    if ((binPath.includes('/') || binPath.includes('\\')) && !path.isAbsolute(binPath)) {
+        throw new Error(`Executable path rejected: relative paths are not allowed, use an absolute path or a bare command name: ${binPath}`);
+    }
+    return binPath;
+}
 /**
  * Utility function for looking up custom variable for a binary path.
  * Will look in the environment variables (1) or in opts (2) for a key with TRUSTIFY_DA_x_PATH, x is an
@@ -53,7 +75,8 @@ export function getCustom(key, def = null, opts = {}) {
  * 		original name supplied
  */
 export function getCustomPath(name, opts = {}) {
-    return getCustom(`TRUSTIFY_DA_${name.toUpperCase()}_PATH`, name, opts);
+    const resolvedPath = getCustom(`TRUSTIFY_DA_${name.toUpperCase()}_PATH`, name, opts);
+    return validateExecutablePath(resolvedPath);
 }
 /**
  * Utility function for determining whether wrappers for build tools such as gradlew/mvnw should be

package/dist/src/updaters/maven_updater.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Updates dependency versions in a Maven pom.xml while preserving file formatting.
+ *
+ * Uses `fast-xml-parser` to understand the XML structure (dependencies and properties),
+ * then performs position-based string splice to replace version strings without altering
+ * any other formatting, comments, whitespace, or indentation.
+ *
+ * Supports `${property}` indirection: when a dependency's `<version>` is a property
+ * reference, the updater resolves the property chain (including recursive references)
+ * and updates the terminal property value in `<properties>` instead.
+ *
+ * @param {string} pomContent - the raw pom.xml file content
+ * @param {Array<{groupId: string, artifactId: string, newVersion: string}>} versionChanges -
+ *   list of version changes to apply
+ * @returns {{content: string, applied: Array, skipped: Array}} the updated content and
+ *   lists of applied and skipped changes
+ */
+export function updateMavenVersions(pomContent: string, versionChanges: Array<{
+    groupId: string;
+    artifactId: string;
+    newVersion: string;
+}>): {
+    content: string;
+    applied: any[];
+    skipped: any[];
+};

package/dist/src/updaters/maven_updater.js

@@ -0,0 +1,322 @@
+import { XMLParser } from 'fast-xml-parser';
+/**
+ * Extracts the trimmed text content of a simple XML element from a string block.
+ * @param {string} block - the XML text to search within
+ * @param {string} tagName - the element name whose content to extract
+ * @returns {string|null} the trimmed text content, or null if not found
+ */
+function extractTagContent(block, tagName) {
+    const openTag = `<${tagName}>`;
+    const closeTag = `</${tagName}>`;
+    const start = block.indexOf(openTag);
+    if (start === -1) {
+        return null;
+    }
+    const contentStart = start + openTag.length;
+    const end = block.indexOf(closeTag, contentStart);
+    if (end === -1) {
+        return null;
+    }
+    return block.substring(contentStart, end).trim();
+}
+/**
+ * Finds the character positions of an XML element's text content within the raw file.
+ * Returns the start (inclusive) and end (exclusive) offsets of the text between the
+ * opening and closing tags.
+ * @param {string} content - full raw XML content
+ * @param {number} searchStart - start offset to search from
+ * @param {number} searchEnd - end offset to search within
+ * @param {string} tagName - the element name whose content position to locate
+ * @returns {{start: number, end: number}|null} character offsets, or null if not found
+ */
+function findTagContentPosition(content, searchStart, searchEnd, tagName) {
+    const openTag = `<${tagName}>`;
+    const closeTag = `</${tagName}>`;
+    const tagStart = content.indexOf(openTag, searchStart);
+    if (tagStart === -1 || tagStart >= searchEnd) {
+        return null;
+    }
+    const contentStart = tagStart + openTag.length;
+    const tagEnd = content.indexOf(closeTag, contentStart);
+    if (tagEnd === -1 || tagEnd > searchEnd) {
+        return null;
+    }
+    return { start: contentStart, end: tagEnd };
+}
+/**
+ * Checks whether the character immediately following a tag prefix indicates
+ * that the prefix is the complete tag name (e.g. `<dependency>` vs `<dependencyManagement>`).
+ * @param {string} char - the character after the tag prefix
+ * @returns {boolean} true if the character terminates the tag name
+ */
+function isTagBoundary(char) {
+    return char === '>' || char === ' ' || char === '\t'
+        || char === '\n' || char === '\r' || char === '/';
+}
+/**
+ * Finds the text content position of a `<version>` element within the first
+ * `<dependency>` block matching the given groupId and artifactId.
+ * Searches through all `<dependency>` elements in the file, covering both
+ * `<dependencies>` and `<dependencyManagement>` sections.
+ * @param {string} content - full raw pom.xml content
+ * @param {string} groupId - the dependency's groupId to match
+ * @param {string} artifactId - the dependency's artifactId to match
+ * @returns {{start: number, end: number}|null} version content offsets, or null
+ */
+function findDependencyVersionPosition(content, groupId, artifactId) {
+    let searchStart = 0;
+    const TAG_PREFIX = '<dependency';
+    const CLOSE_TAG = '</dependency>';
+    while (searchStart < content.length) {
+        const start = content.indexOf(TAG_PREFIX, searchStart);
+        if (start === -1) {
+            break;
+        }
+        // Verify this is exactly <dependency> and not <dependencyManagement> etc.
+        const charAfterTag = content.charAt(start + TAG_PREFIX.length);
+        if (!isTagBoundary(charAfterTag)) {
+            searchStart = start + 1;
+            continue;
+        }
+        // Find closing </dependency>
+        const end = content.indexOf(CLOSE_TAG, start + TAG_PREFIX.length);
+        if (end === -1) {
+            break;
+        }
+        const blockEnd = end + CLOSE_TAG.length;
+        const block = content.substring(start, blockEnd);
+        const gid = extractTagContent(block, 'groupId');
+        const aid = extractTagContent(block, 'artifactId');
+        if (gid === groupId && aid === artifactId) {
+            const pos = findTagContentPosition(content, start, blockEnd, 'version');
+            if (pos) {
+                return pos;
+            }
+            // Matching dependency but no <version> element; continue searching
+            // (the version may be in <dependencyManagement>)
+        }
+        searchStart = blockEnd;
+    }
+    return null;
+}
+/**
+ * Finds the text content position of a property element inside a `<properties>` block.
+ * Searches through all `<properties>` blocks in the file.
+ * @param {string} content - full raw pom.xml content
+ * @param {string} propName - the property element name to locate
+ * @returns {{start: number, end: number}|null} property value offsets, or null
+ */
+function findPropertyPosition(content, propName) {
+    let searchStart = 0;
+    const TAG_PREFIX = '<properties';
+    const CLOSE_TAG = '</properties>';
+    while (searchStart < content.length) {
+        const propsStart = content.indexOf(TAG_PREFIX, searchStart);
+        if (propsStart === -1) {
+            break;
+        }
+        // Verify this is exactly <properties> and not some other tag
+        const charAfter = content.charAt(propsStart + TAG_PREFIX.length);
+        if (!isTagBoundary(charAfter)) {
+            searchStart = propsStart + 1;
+            continue;
+        }
+        const propsCloseStart = content.indexOf(CLOSE_TAG, propsStart);
+        if (propsCloseStart === -1) {
+            break;
+        }
+        const propsBlockEnd = propsCloseStart + CLOSE_TAG.length;
+        const result = findTagContentPosition(content, propsStart, propsBlockEnd, propName);
+        if (result) {
+            return result;
+        }
+        searchStart = propsBlockEnd;
+    }
+    return null;
+}
+/**
+ * Resolves a Maven property chain, following `${propName}` references through
+ * the properties map until a concrete (non-reference) value is reached.
+ * Detects circular references via a visited set.
+ * @param {string} propName - the initial property name to resolve
+ * @param {Object} properties - properties map from the parsed XML
+ * @param {Set<string>} [visited] - visited property names (for cycle detection)
+ * @returns {{terminalPropName: string, resolvedValue: string}|{error: string}}
+ */
+function resolvePropertyChain(propName, properties, visited = new Set()) {
+    if (visited.has(propName)) {
+        const chain = [...visited, propName].join(' -> ');
+        return { error: `Circular property reference detected: ${chain}` };
+    }
+    visited.add(propName);
+    const value = properties[propName];
+    if (value == null) {
+        return { error: `Property '${propName}' not found in <properties>` };
+    }
+    const valueStr = String(value);
+    const propMatch = valueStr.match(/^\$\{(.+)\}$/);
+    if (propMatch) {
+        return resolvePropertyChain(propMatch[1], properties, visited);
+    }
+    return { terminalPropName: propName, resolvedValue: valueStr };
+}
+/**
+ * Updates dependency versions in a Maven pom.xml while preserving file formatting.
+ *
+ * Uses `fast-xml-parser` to understand the XML structure (dependencies and properties),
+ * then performs position-based string splice to replace version strings without altering
+ * any other formatting, comments, whitespace, or indentation.
+ *
+ * Supports `${property}` indirection: when a dependency's `<version>` is a property
+ * reference, the updater resolves the property chain (including recursive references)
+ * and updates the terminal property value in `<properties>` instead.
+ *
+ * @param {string} pomContent - the raw pom.xml file content
+ * @param {Array<{groupId: string, artifactId: string, newVersion: string}>} versionChanges -
+ *   list of version changes to apply
+ * @returns {{content: string, applied: Array, skipped: Array}} the updated content and
+ *   lists of applied and skipped changes
+ */
+export function updateMavenVersions(pomContent, versionChanges) {
+    if (!versionChanges || versionChanges.length === 0) {
+        return { content: pomContent, applied: [], skipped: [] };
+    }
+    const parser = new XMLParser({
+        parseTagValue: false,
+        commentPropName: '#comment',
+    });
+    let parsed;
+    try {
+        parsed = parser.parse(pomContent);
+    }
+    catch (e) {
+        return {
+            content: pomContent,
+            applied: [],
+            skipped: versionChanges.map(vc => ({
+                groupId: vc.groupId,
+                artifactId: vc.artifactId,
+                newVersion: vc.newVersion,
+                reason: `Failed to parse pom.xml: ${e.message}`,
+            })),
+        };
+    }
+    const project = parsed?.project;
+    if (!project) {
+        return {
+            content: pomContent,
+            applied: [],
+            skipped: versionChanges.map(vc => ({
+                groupId: vc.groupId,
+                artifactId: vc.artifactId,
+                newVersion: vc.newVersion,
+                reason: 'No <project> element found in pom.xml',
+            })),
+        };
+    }
+    const properties = project.properties || {};
+    const applied = [];
+    const skipped = [];
+    /** @type {Map<number, {start: number, end: number, newValue: string}>} */
+    const replacementsByPosition = new Map();
+    for (const change of versionChanges) {
+        const versionPos = findDependencyVersionPosition(pomContent, change.groupId, change.artifactId);
+        if (!versionPos) {
+            skipped.push({
+                groupId: change.groupId,
+                artifactId: change.artifactId,
+                newVersion: change.newVersion,
+                reason: 'Dependency not found in pom.xml or has no <version> element',
+            });
+            continue;
+        }
+        const currentVersion = pomContent.substring(versionPos.start, versionPos.end);
+        const propMatch = currentVersion.match(/^\$\{(.+)\}$/);
+        if (propMatch) {
+            const resolved = resolvePropertyChain(propMatch[1], properties);
+            if (resolved.error) {
+                skipped.push({
+                    groupId: change.groupId,
+                    artifactId: change.artifactId,
+                    newVersion: change.newVersion,
+                    reason: resolved.error,
+                });
+                continue;
+            }
+            const propPos = findPropertyPosition(pomContent, resolved.terminalPropName);
+            if (!propPos) {
+                skipped.push({
+                    groupId: change.groupId,
+                    artifactId: change.artifactId,
+                    newVersion: change.newVersion,
+                    reason: `Could not locate property '${resolved.terminalPropName}' in pom.xml`,
+                });
+                continue;
+            }
+            // Deduplicate: multiple deps may share the same property
+            const existing = replacementsByPosition.get(propPos.start);
+            if (existing) {
+                if (existing.newValue !== change.newVersion) {
+                    skipped.push({
+                        groupId: change.groupId,
+                        artifactId: change.artifactId,
+                        newVersion: change.newVersion,
+                        reason: `Property '${resolved.terminalPropName}' already targeted `
+                            + `with a different version '${existing.newValue}'`,
+                    });
+                    continue;
+                }
+                // Same replacement already queued; record as applied without duplicating
+            }
+            else {
+                replacementsByPosition.set(propPos.start, {
+                    start: propPos.start,
+                    end: propPos.end,
+                    newValue: change.newVersion,
+                });
+            }
+            applied.push({
+                groupId: change.groupId,
+                artifactId: change.artifactId,
+                newVersion: change.newVersion,
+                type: 'property',
+                property: resolved.terminalPropName,
+            });
+        }
+        else {
+            const existing = replacementsByPosition.get(versionPos.start);
+            if (existing) {
+                if (existing.newValue !== change.newVersion) {
+                    skipped.push({
+                        groupId: change.groupId,
+                        artifactId: change.artifactId,
+                        newVersion: change.newVersion,
+                        reason: `Version already targeted with a different version '${existing.newValue}'`,
+                    });
+                    continue;
+                }
+            }
+            else {
+                replacementsByPosition.set(versionPos.start, {
+                    start: versionPos.start,
+                    end: versionPos.end,
+                    newValue: change.newVersion,
+                });
+            }
+            applied.push({
+                groupId: change.groupId,
+                artifactId: change.artifactId,
+                newVersion: change.newVersion,
+                type: 'direct',
+            });
+        }
+    }
+    // Sort replacements by position descending to preserve offsets during splice
+    const sortedReplacements = [...replacementsByPosition.values()]
+        .sort((a, b) => b.start - a.start);
+    let result = pomContent;
+    for (const r of sortedReplacements) {
+        result = result.substring(0, r.start) + r.newValue + result.substring(r.end);
+    }
+    return { content: result, applied, skipped };
+}

package/dist/src/updaters/toml_updater.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Updates dependency versions in a Gradle version catalog (libs.versions.toml) file.
+ *
+ * Supports two version declaration patterns:
+ * - Centralized: [versions] section defines version aliases, [libraries] references via version.ref
+ * - Inline: [libraries] entries include version = "x.y.z" directly
+ *
+ * Uses smol-toml parse() to locate keys, then performs position-based string replacement
+ * on the raw content to preserve formatting and comments.
+ *
+ * @param {string} tomlContent - raw TOML file content
+ * @param {Array<{groupId: string, artifactId: string, newVersion: string}>} versionChanges
+ * @returns {{content: string, applied: Array<{groupId: string, artifactId: string, newVersion: string, oldVersion: string}>, skipped: Array<{groupId: string, artifactId: string, newVersion: string, reason: string}>}}
+ */
+export function updateTomlVersions(tomlContent: string, versionChanges: Array<{
+    groupId: string;
+    artifactId: string;
+    newVersion: string;
+}>): {
+    content: string;
+    applied: Array<{
+        groupId: string;
+        artifactId: string;
+        newVersion: string;
+        oldVersion: string;
+    }>;
+    skipped: Array<{
+        groupId: string;
+        artifactId: string;
+        newVersion: string;
+        reason: string;
+    }>;
+};