@trustify-da/trustify-da-javascript-client 0.3.0-ea.ce73b2f → 0.3.0-ea.d71f957

package/dist/src/license/licenses_api.js

@@ -0,0 +1,98 @@
+/**
+ * Client for the Trustify DA backend License Analysis API (POST /api/v5/licenses).
+ * The same license data shape is returned in the dependency analysis JSON report (result.licenses).
+ * @see https://github.com/guacsec/trustify-dependency-analytics#license-analysis-apiv5licenses
+ * @see https://github.com/guacsec/trustify-da-api-spec/blob/main/api/v5/openapi.yaml
+ */
+import { PackageURL } from 'packageurl-js';
+import { selectTrustifyDABackend } from '../index.js';
+import { addProxyAgent, getTokenHeaders } from '../tools.js';
+/**
+ * Fetch license details by SPDX identifier from the backend GET /api/v5/licenses/{spdx}.
+ * Returns detailed information about a specific license including category, name, and text.
+ *
+ * @param {string} spdxId - SPDX identifier (e.g., "Apache-2.0", "MIT")
+ * @param {import('../index.js').Options} [opts={}] - options (proxy, token, TRUSTIFY_DA_BACKEND_URL, etc.)
+ * @returns {Promise<Object|null>} License details or null if not found
+ */
+export async function getLicenseDetails(spdxId, opts = {}) {
+    if (!spdxId) {
+        return null;
+    }
+    const url = selectTrustifyDABackend(opts);
+    const finalUrl = new URL(`${url}/api/v5/licenses/${encodeURIComponent(spdxId)}`);
+    const fetchOptions = addProxyAgent({
+        method: 'GET',
+        headers: {
+            'Accept': 'application/json',
+            ...getTokenHeaders(opts)
+        },
+    }, opts);
+    try {
+        const resp = await fetch(finalUrl, fetchOptions);
+        if (!resp.ok) {
+            const errorText = await resp.text().catch(() => '');
+            throw new Error(`HTTP ${resp.status}: ${errorText || resp.statusText}`);
+        }
+        return await resp.json();
+    }
+    catch (err) {
+        throw new Error(`Failed to fetch license details: ${err.message}`);
+    }
+}
+function normalizePurlString(purl) {
+    const parsed = PackageURL.fromString(purl);
+    return new PackageURL(parsed.type, parsed.namespace, parsed.name, parsed.version, null, null).toString();
+}
+/**
+ * Normalize the LicensesResponse shape (array of LicenseProviderResult) into a map of purl -> license info.
+ * Each provider result has { status, summary, packages } where packages is { [purl]: { concluded, evidence } }.
+ * We merge the first successful provider's packages; concluded has identifiers[], category (PERMISSIVE | WEAK_COPYLEFT | STRONG_COPYLEFT | UNKNOWN).
+ *
+ * @param {unknown} data - LicensesResponse (array) or analysis report's licenses field
+ * @param {string[]} [purls] - optional list of purls to restrict to (for consistency with getLicensesByPurl)
+ * @returns {Map<string, { licenses: string[], category?: string }>}
+ */
+export function normalizeLicensesResponse(data, purls = []) {
+    const map = new Map();
+    if (!data || !Array.isArray(data)) {
+        return map;
+    }
+    const normalizedPurlsSet = purls.length > 0 ? new Set(purls.map(normalizePurlString)) : null;
+    for (const providerResult of data) {
+        const packages = providerResult?.packages;
+        if (!packages || typeof packages !== 'object') {
+            continue;
+        }
+        for (const [purl, pkgLicense] of Object.entries(packages)) {
+            const concluded = pkgLicense?.concluded;
+            const identifiers = Array.isArray(concluded?.identifiers) ? concluded.identifiers : [];
+            const expression = concluded?.expression;
+            const licenses = identifiers.length > 0 ? identifiers : (expression ? [expression] : []);
+            const category = concluded?.category; // PERMISSIVE | WEAK_COPYLEFT | STRONG_COPYLEFT | UNKNOWN
+            const normalizedPurl = normalizePurlString(purl);
+            if (normalizedPurlsSet === null || normalizedPurlsSet.has(normalizedPurl)) {
+                map.set(normalizedPurl, { licenses: licenses.filter(Boolean), category });
+            }
+        }
+        // Use first provider that has packages; backend may return multiple (e.g. deps.dev)
+        if (map.size > 0) {
+            break;
+        }
+    }
+    return map;
+}
+/**
+ * Build license map from an analysis report that already includes license data (result.licenses).
+ * Use this when the dependency analysis response already contains the licenses array to avoid a second request.
+ *
+ * @param {import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport} analysisReport - full analysis JSON
+ * @param {string[]} [purls] - optional list of purls to restrict to
+ * @returns {Map<string, { licenses: string[], category?: string }>}
+ */
+export function licensesFromReport(analysisReport, purls = []) {
+    if (!analysisReport?.licenses) {
+        return new Map();
+    }
+    return normalizeLicensesResponse(analysisReport.licenses, purls);
+}

package/dist/src/license/project_license.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Resolve project license from manifest and from LICENSE / LICENSE.md in manifest dir or git root.
+ * Uses local pattern matching for LICENSE file identification (synchronous).
+ * For more accurate backend-based identification, use identifyLicense() separately.
+ * @param {string} manifestPath - path to manifest
+ * @returns {{ fromManifest: string|null, fromFile: string|null, mismatch: boolean }}
+ */
+export function getProjectLicense(manifestPath: string): {
+    fromManifest: string | null;
+    fromFile: string | null;
+    mismatch: boolean;
+};
+/**
+ * Call backend /licenses/identify endpoint to identify license from file.
+ * @param {string} licenseFilePath - path to LICENSE file
+ * @param {{}} [opts={}] - options (proxy, token, etc.)
+ * @returns {Promise<string|null>} - SPDX identifier or null
+ */
+export function identifyLicense(licenseFilePath: string, opts?: {}): Promise<string | null>;
+export { findLicenseFilePath, readLicenseFile } from "./license_utils.js";

package/dist/src/license/project_license.js

@@ -0,0 +1,62 @@
+/**
+ * Resolves the project license from the manifest and from a LICENSE / LICENSE.md file.
+ * Used to report manifest-vs-file mismatch and as the baseline for dependency license compatibility.
+ */
+import fs from 'node:fs';
+import path from 'node:path';
+import { selectTrustifyDABackend } from '../index.js';
+import { matchForLicense, availableProviders } from '../provider.js';
+import { addProxyAgent, getTokenHeaders } from '../tools.js';
+import { normalizeSpdx, readLicenseFile } from './license_utils.js';
+/**
+ * Resolve project license from manifest and from LICENSE / LICENSE.md in manifest dir or git root.
+ * Uses local pattern matching for LICENSE file identification (synchronous).
+ * For more accurate backend-based identification, use identifyLicense() separately.
+ * @param {string} manifestPath - path to manifest
+ * @returns {{ fromManifest: string|null, fromFile: string|null, mismatch: boolean }}
+ */
+export function getProjectLicense(manifestPath) {
+    const resolved = path.resolve(manifestPath);
+    const provider = matchForLicense(resolved, availableProviders);
+    const fromManifest = provider.readLicenseFromManifest(resolved);
+    const fromFile = readLicenseFile(resolved);
+    const mismatch = Boolean(fromManifest && fromFile && normalizeSpdx(fromManifest) !== normalizeSpdx(fromFile));
+    return {
+        fromManifest: fromManifest || null,
+        fromFile: fromFile || null,
+        mismatch
+    };
+}
+export { findLicenseFilePath, readLicenseFile } from './license_utils.js';
+/**
+ * Call backend /licenses/identify endpoint to identify license from file.
+ * @param {string} licenseFilePath - path to LICENSE file
+ * @param {{}} [opts={}] - options (proxy, token, etc.)
+ * @returns {Promise<string|null>} - SPDX identifier or null
+ */
+export async function identifyLicense(licenseFilePath, opts = {}) {
+    try {
+        const fileContent = fs.readFileSync(licenseFilePath);
+        const backendUrl = selectTrustifyDABackend(opts);
+        const url = new URL(`${backendUrl}/api/v5/licenses/identify`);
+        const tokenHeaders = getTokenHeaders(opts);
+        const fetchOptions = addProxyAgent({
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/octet-stream',
+                ...tokenHeaders,
+            },
+            body: fileContent,
+        }, opts);
+        const resp = await fetch(url, fetchOptions);
+        if (!resp.ok) {
+            return null; // Fallback to local detection on error
+        }
+        const data = await resp.json();
+        // Extract SPDX identifier from backend response
+        return data?.license?.id || data?.spdx_id || data?.identifier || null;
+    }
+    catch {
+        return null; // Fallback to local detection on error
+    }
+}

package/dist/src/oci_image/images.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="packageurl-js/src/package-url.js" />
 /**
 * Helper class for parsing docker repository/image names:
 *
@@ -26,7 +25,7 @@ export class Image {
      * @param {string} fullName
      * @param {string} [givenTag]
      */
-    constructor(fullName: string, givenTag?: string | undefined);
+    constructor(fullName: string, givenTag?: string);
     repository: string;
     registry: string;
     tag: string;
@@ -46,12 +45,12 @@ export class Image {
     * @param {string} [optionalRegistry]
     * @returns {string}
     */
-    getNameWithoutTag(optionalRegistry?: string | undefined): string;
+    getNameWithoutTag(optionalRegistry?: string): string;
     /**
     * @param {string} [optionalRegistry]
     * @returns {string}
     */
-    getFullName(optionalRegistry?: string | undefined): string;
+    getFullName(optionalRegistry?: string): string;
     /**
     * @returns {string}
     */
@@ -79,7 +78,7 @@ export class ImageRef {
      * @param {string} [platform]
      * @param {import("index.js").Options} [opts={}]
      */
-    constructor(image: string, platform?: string | undefined, opts?: import("index.js").Options | undefined);
+    constructor(image: string, platform?: string, opts?: import("index.js").Options);
     /** @type {Image} */
     image: Image;
     /** @type {Platform} */

package/dist/src/oci_image/utils.d.ts

@@ -4,20 +4,20 @@
  * @param {import("../index.js").Options} [opts={}] - optional various options to pass along the application
  * @returns {{}}
  */
-export function generateImageSBOM(imageRef: import('./images').ImageRef, opts?: import("../index.js").Options | undefined): {};
+export function generateImageSBOM(imageRef: import("./images").ImageRef, opts?: import("../index.js").Options): {};
 /**
  *
  * @param {string} image
  * @param {import("../index.js").Options} [opts={}] - optional various options to pass along the application
  * @returns {ImageRef}
  */
-export function parseImageRef(image: string, opts?: import("../index.js").Options | undefined): ImageRef;
+export function parseImageRef(image: string, opts?: import("../index.js").Options): ImageRef;
 /**
  * Gets the platform information for an image
  * @param {import("../index.js").Options} [opts={}] - optional various options to pass along the application
  * @returns {Platform|null} - The platform information or null
  */
-export function getImagePlatform(opts?: import("../index.js").Options | undefined): Platform | null;
+export function getImagePlatform(opts?: import("../index.js").Options): Platform | null;
 /**
  * Gets the digests for an image
  * @param {import('./images').ImageRef} imageRef - The image reference
@@ -25,7 +25,7 @@ export function getImagePlatform(opts?: import("../index.js").Options | undefine
  * @returns {Object.<string, string>} - The image digests
  * @throws {Error} If the image info is invalid
  */
-export function getImageDigests(imageRef: import('./images').ImageRef, opts?: import("../index.js").Options | undefined): {
+export function getImageDigests(imageRef: import("./images").ImageRef, opts?: import("../index.js").Options): {
     [x: string]: string;
 };
 export type SyftImageSource = {

package/dist/src/provider.d.ts

@@ -1,3 +1,11 @@
+/**
+ * Match a provider by manifest type only (no lock file check). Used for license reading.
+ * @param {string} manifestPath - path or name of the manifest
+ * @param {[Provider]} providers - list of providers to iterate over
+ * @returns {Provider}
+ * @throws {Error} when the manifest is not supported and no provider was matched
+ */
+export function matchForLicense(manifestPath: string, providers: [Provider]): Provider;
 /**
  * Match a provider from a list or providers based on file type.
  * Each provider MUST export 'isSupported' taking a file name-type and returning true if supported.
@@ -5,12 +13,15 @@
  * Each provider MUST export 'provideStack' taking manifest path returning a {@link Provided}.
  * @param {string} manifest - the name-type or path of the manifest
  * @param {[Provider]} providers - list of providers to iterate over
+ * @param {{TRUSTIFY_DA_WORKSPACE_DIR?: string}} [opts={}] - optional; TRUSTIFY_DA_WORKSPACE_DIR overrides lock file location for workspaces
  * @returns {Provider}
  * @throws {Error} when the manifest is not supported and no provider was matched
  */
-export function match(manifest: string, providers: [Provider]): Provider;
+export function match(manifest: string, providers: [Provider], opts?: {
+    TRUSTIFY_DA_WORKSPACE_DIR?: string;
+}): Provider;
 /** @typedef {{ecosystem: string, contentType: string, content: string}} Provided */
-/** @typedef {{isSupported: function(string): boolean, validateLockFile: function(string): void, provideComponent: function(string, {}): Provided, provideStack: function(string, {}): Provided}} Provider */
+/** @typedef {{isSupported: function(string): boolean, validateLockFile: function(string, Object): void, provideComponent: function(string, {}): Provided | Promise<Provided>, provideStack: function(string, {}): Provided | Promise<Provided>, readLicenseFromManifest: function(string): string | null}} Provider */
 /**
  * MUST include all providers here.
  * @type {[Provider]}
@@ -23,7 +34,8 @@ export type Provided = {
 };
 export type Provider = {
     isSupported: (arg0: string) => boolean;
-    validateLockFile: (arg0: string) => void;
-    provideComponent: (arg0: string, arg1: {}) => Provided;
-    provideStack: (arg0: string, arg1: {}) => Provided;
+    validateLockFile: (arg0: string, arg1: any) => void;
+    provideComponent: (arg0: string, arg1: {}) => Provided | Promise<Provided>;
+    provideStack: (arg0: string, arg1: {}) => Provided | Promise<Provided>;
+    readLicenseFromManifest: (arg0: string) => string | null;
 };

package/dist/src/provider.js

@@ -7,8 +7,9 @@ import Javascript_npm from './providers/javascript_npm.js';
 import Javascript_pnpm from './providers/javascript_pnpm.js';
 import Javascript_yarn from './providers/javascript_yarn.js';
 import pythonPipProvider from './providers/python_pip.js';
+import rustCargoProvider from './providers/rust_cargo.js';
 /** @typedef {{ecosystem: string, contentType: string, content: string}} Provided */
-/** @typedef {{isSupported: function(string): boolean, validateLockFile: function(string): void, provideComponent: function(string, {}): Provided, provideStack: function(string, {}): Provided}} Provider */
+/** @typedef {{isSupported: function(string): boolean, validateLockFile: function(string, Object): void, provideComponent: function(string, {}): Provided | Promise<Provided>, provideStack: function(string, {}): Provided | Promise<Provided>, readLicenseFromManifest: function(string): string | null}} Provider */
 /**
  * MUST include all providers here.
  * @type {[Provider]}
@@ -17,12 +18,28 @@ export const availableProviders = [
     new Java_maven(),
     new Java_gradle_groovy(),
     new Java_gradle_kotlin(),
-    new Javascript_npm(),
     new Javascript_pnpm(),
     new Javascript_yarn(),
+    new Javascript_npm(),
     golangGomodulesProvider,
-    pythonPipProvider
+    pythonPipProvider,
+    rustCargoProvider
 ];
+/**
+ * Match a provider by manifest type only (no lock file check). Used for license reading.
+ * @param {string} manifestPath - path or name of the manifest
+ * @param {[Provider]} providers - list of providers to iterate over
+ * @returns {Provider}
+ * @throws {Error} when the manifest is not supported and no provider was matched
+ */
+export function matchForLicense(manifestPath, providers) {
+    const base = path.parse(manifestPath).base;
+    const provider = providers.find(prov => prov.isSupported(base));
+    if (!provider) {
+        throw new Error(`${base} is not supported`);
+    }
+    return provider;
+}
 /**
  * Match a provider from a list or providers based on file type.
  * Each provider MUST export 'isSupported' taking a file name-type and returning true if supported.
@@ -30,16 +47,17 @@ export const availableProviders = [
  * Each provider MUST export 'provideStack' taking manifest path returning a {@link Provided}.
  * @param {string} manifest - the name-type or path of the manifest
  * @param {[Provider]} providers - list of providers to iterate over
+ * @param {{TRUSTIFY_DA_WORKSPACE_DIR?: string}} [opts={}] - optional; TRUSTIFY_DA_WORKSPACE_DIR overrides lock file location for workspaces
  * @returns {Provider}
  * @throws {Error} when the manifest is not supported and no provider was matched
  */
-export function match(manifest, providers) {
+export function match(manifest, providers, opts = {}) {
     const manifestPath = path.parse(manifest);
     const supported = providers.filter(prov => prov.isSupported(manifestPath.base));
     if (supported.length === 0) {
         throw new Error(`${manifestPath.base} is not supported`);
     }
-    const provider = supported.find(prov => prov.validateLockFile(manifestPath.dir));
+    const provider = supported.find(prov => prov.validateLockFile(manifestPath.dir, opts));
     if (!provider) {
         throw new Error(`${manifestPath.base} requires a lock file. Use your preferred package manager to generate the lock file.`);
     }

package/dist/src/providers/base_java.d.ts

@@ -1,6 +1,4 @@
-/// <reference types="node" />
-/// <reference types="packageurl-js/src/package-url.js" />
-export type ecosystem_maven = import('../provider').Provider;
+export type ecosystem_maven = import("../provider").Provider;
 /** @typedef {import('../provider').Provider} */
 /** @typedef {import('../provider').Provided} Provided */
 /** @typedef {{name: string, version: string}} Package */
@@ -51,7 +49,7 @@ export default class Base_Java {
      * @param {import('child_process').ExecFileOptionsWithStringEncoding} [opts={}]
      * @protected
      */
-    protected _invokeCommand(bin: any, args: any, opts?: import("child_process").ExecFileOptionsWithStringEncoding | undefined): string;
+    protected _invokeCommand(bin: any, args: any, opts?: import("child_process").ExecFileOptionsWithStringEncoding): string;
     /**
      *
      * @param {string} manifestPath
@@ -70,7 +68,7 @@ export default class Base_Java {
     normalizePath(thePath: any): string;
     #private;
 }
-export type Provided = import('../provider').Provided;
+export type Provided = import("../provider").Provided;
 export type Package = {
     name: string;
     version: string;

package/dist/src/providers/base_javascript.d.ts

@@ -1,5 +1,6 @@
-/** @typedef {import('../provider.js').Provider} Provider */
-/** @typedef {import('../provider.js').Provided} Provided */
+export type purlType = import("../provider").Provider;
+/** @typedef {import('../provider').Provider} */
+/** @typedef {import('../provider').Provided} Provided */
 /**
  * The ecosystem identifier for JavaScript/npm packages
  * @type {string}
@@ -66,11 +67,26 @@ export default class Base_javascript {
    */
     isSupported(manifestName: string): boolean;
     /**
-   * Checks if a required lock file exists in the same path as the manifest
+   * Walks up the directory tree from manifestDir looking for the lock file.
+   * Stops when the lock file is found, when a package.json with a "workspaces"
+   * field is encountered without a lock file (workspace root boundary), or
+   * when the filesystem root is reached.
+   *
+   * When TRUSTIFY_DA_WORKSPACE_DIR is set, checks only that directory (no walk-up).
+   *
+   * @param {string} manifestDir - The directory to start searching from
+   * @param {Object} [opts={}] - optional; may contain TRUSTIFY_DA_WORKSPACE_DIR
+   * @returns {string|null} The directory containing the lock file, or null
+   * @protected
+   */
+    protected _isWorkspaceRoot(dir: any): string | null;
+    _findLockFileDir(manifestDir: any, opts?: {}): string | null;
+    /**
    * @param {string} manifestDir - The base directory where the manifest is located
+   * @param {Object} [opts={}] - optional; may contain TRUSTIFY_DA_WORKSPACE_DIR
    * @returns {boolean} True if the lock file exists
    */
-    validateLockFile(manifestDir: string): boolean;
+    validateLockFile(manifestDir: string, opts?: any): boolean;
     /**
    * Provides content and content type for stack analysis
    * @param {string} manifestPath - The manifest path or name
@@ -85,13 +101,20 @@ export default class Base_javascript {
    * @returns {Provided} The provided data for component analysis
    */
     provideComponent(manifestPath: string, opts?: any): Provided;
+    /**
+     * Read license from manifest (package.json). Reused by npm, pnpm, yarn.
+     * @param {string} manifestPath - path to package.json
+     * @returns {string|null}
+     */
+    readLicenseFromManifest(manifestPath: string): string | null;
     /**
    * Builds the dependency tree for the project
    * @param {boolean} includeTransitive - Whether to include transitive dependencies
+   * @param {Object} [opts={}] - Configuration options; when `TRUSTIFY_DA_WORKSPACE_DIR` is set, commands run from workspace root
    * @returns {Object} The dependency tree
    * @protected
    */
-    protected _buildDependencyTree(includeTransitive: boolean): any;
+    protected _buildDependencyTree(includeTransitive: boolean, opts?: any): any;
     /**
    * Recursively builds the Sbom from the JSON that npm listing returns
    * @param {Sbom} sbom - The SBOM object to add dependencies to
@@ -121,7 +144,6 @@ export default class Base_javascript {
     protected _parseDepTreeOutput(output: string): string;
     #private;
 }
-export type Provider = import('../provider.js').Provider;
-export type Provided = import('../provider.js').Provided;
+export type Provided = import("../provider").Provided;
 import Manifest from './manifest.js';
 import Sbom from '../sbom.js';