@trustify-da/trustify-da-javascript-client 0.3.0-ea.c555cdf → 0.3.0-ea.cb4ae28

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/README.md +43 -1
  2. package/dist/package.json +11 -4
  3. package/dist/src/analysis.js +21 -76
  4. package/dist/src/cli.js +72 -6
  5. package/dist/src/cyclone_dx_sbom.d.ts +3 -1
  6. package/dist/src/cyclone_dx_sbom.js +16 -4
  7. package/dist/src/index.d.ts +5 -3
  8. package/dist/src/index.js +5 -3
  9. package/dist/src/license/index.d.ts +28 -0
  10. package/dist/src/license/index.js +100 -0
  11. package/dist/src/license/license_utils.d.ts +40 -0
  12. package/dist/src/license/license_utils.js +134 -0
  13. package/dist/src/license/licenses_api.d.ts +34 -0
  14. package/dist/src/license/licenses_api.js +98 -0
  15. package/dist/src/license/project_license.d.ts +20 -0
  16. package/dist/src/license/project_license.js +62 -0
  17. package/dist/src/provider.d.ts +12 -3
  18. package/dist/src/provider.js +16 -1
  19. package/dist/src/providers/base_javascript.d.ts +10 -4
  20. package/dist/src/providers/base_javascript.js +30 -4
  21. package/dist/src/providers/golang_gomodules.d.ts +8 -1
  22. package/dist/src/providers/golang_gomodules.js +13 -4
  23. package/dist/src/providers/java_gradle.d.ts +6 -0
  24. package/dist/src/providers/java_gradle.js +12 -2
  25. package/dist/src/providers/java_maven.d.ts +8 -1
  26. package/dist/src/providers/java_maven.js +32 -4
  27. package/dist/src/providers/python_controller.d.ts +5 -2
  28. package/dist/src/providers/python_controller.js +56 -58
  29. package/dist/src/providers/python_pip.d.ts +11 -4
  30. package/dist/src/providers/python_pip.js +46 -53
  31. package/dist/src/providers/requirements_parser.d.ts +6 -0
  32. package/dist/src/providers/requirements_parser.js +24 -0
  33. package/dist/src/providers/tree-sitter-requirements.wasm +0 -0
  34. package/dist/src/sbom.d.ts +3 -1
  35. package/dist/src/sbom.js +3 -2
  36. package/dist/src/tools.d.ts +18 -0
  37. package/dist/src/tools.js +56 -1
  38. package/package.json +12 -5
@@ -0,0 +1,40 @@
1
+ /**
2
+ * Find LICENSE file path in the same directory as the manifest.
3
+ * @param {string} manifestPath
4
+ * @returns {string|null} - path to LICENSE file or null if not found
5
+ */
6
+ export function findLicenseFilePath(manifestPath: string): string | null;
7
+ /**
8
+ * Very simple SPDX detection from common license text (first ~500 chars).
9
+ * @param {string} text
10
+ * @returns {string|null}
11
+ */
12
+ export function detectSpdxFromText(text: string): string | null;
13
+ /**
14
+ * Read LICENSE file and detect SPDX identifier.
15
+ * @param {string} manifestPath - path to manifest
16
+ * @returns {string|null} - SPDX identifier from LICENSE file or null
17
+ */
18
+ export function readLicenseFile(manifestPath: string): string | null;
19
+ /**
20
+ * Get project license from manifest or LICENSE file.
21
+ * Returns manifestLicense if provided, otherwise tries LICENSE file.
22
+ * @param {string|null} manifestLicense - license from manifest (or null)
23
+ * @param {string} manifestPath - path to manifest
24
+ * @returns {string|null} - SPDX identifier or null
25
+ */
26
+ export function getLicense(manifestLicense: string | null, manifestPath: string): string | null;
27
+ /**
28
+ * Normalize SPDX identifier for comparison (lowercase, strip common suffixes).
29
+ * @param {string} spdxOrName
30
+ * @returns {string}
31
+ */
32
+ export function normalizeSpdx(spdxOrName: string): string;
33
+ /**
34
+ * Check if a dependency's license is compatible with the project license based on backend categories.
35
+ *
36
+ * @param {string} [projectCategory] - backend category for project license: PERMISSIVE | WEAK_COPYLEFT | STRONG_COPYLEFT | UNKNOWN
37
+ * @param {string} [dependencyCategory] - backend category for dependency license: PERMISSIVE | WEAK_COPYLEFT | STRONG_COPYLEFT | UNKNOWN
38
+ * @returns {'compatible'|'incompatible'|'unknown'}
39
+ */
40
+ export function getCompatibility(projectCategory?: string, dependencyCategory?: string): "compatible" | "incompatible" | "unknown";
@@ -0,0 +1,134 @@
1
+ /**
2
+ * License utilities: file reading, SPDX detection, normalization, compatibility.
3
+ * This module has NO dependencies on providers or backend to avoid circular dependencies.
4
+ */
5
+ import fs from 'node:fs';
6
+ import path from 'node:path';
7
+ const LICENSE_FILES = ['LICENSE', 'LICENSE.md', 'LICENSE.txt'];
8
+ /**
9
+ * Find LICENSE file path in the same directory as the manifest.
10
+ * @param {string} manifestPath
11
+ * @returns {string|null} - path to LICENSE file or null if not found
12
+ */
13
+ export function findLicenseFilePath(manifestPath) {
14
+ const manifestDir = path.dirname(path.resolve(manifestPath));
15
+ for (const name of LICENSE_FILES) {
16
+ const filePath = path.join(manifestDir, name);
17
+ try {
18
+ if (fs.statSync(filePath).isFile()) {
19
+ return filePath;
20
+ }
21
+ }
22
+ catch {
23
+ // skip
24
+ }
25
+ }
26
+ return null;
27
+ }
28
+ /**
29
+ * Very simple SPDX detection from common license text (first ~500 chars).
30
+ * @param {string} text
31
+ * @returns {string|null}
32
+ */
33
+ export function detectSpdxFromText(text) {
34
+ const head = text.slice(0, 500);
35
+ if (/Apache License,?\s*Version 2\.0/i.test(head)) {
36
+ return 'Apache-2.0';
37
+ }
38
+ if (/MIT License/i.test(head) && /Permission is hereby granted/i.test(head)) {
39
+ return 'MIT';
40
+ }
41
+ if (/GNU AFFERO GENERAL PUBLIC LICENSE\s+Version 3/i.test(head)) {
42
+ return 'AGPL-3.0-only';
43
+ }
44
+ if (/GNU LESSER GENERAL PUBLIC LICENSE\s+Version 3/i.test(head)) {
45
+ return 'LGPL-3.0-only';
46
+ }
47
+ if (/GNU LESSER GENERAL PUBLIC LICENSE\s+Version 2\.1/i.test(head)) {
48
+ return 'LGPL-2.1-only';
49
+ }
50
+ if (/GNU GENERAL PUBLIC LICENSE\s+Version 2/i.test(head)) {
51
+ return 'GPL-2.0-only';
52
+ }
53
+ if (/GNU GENERAL PUBLIC LICENSE\s+Version 3/i.test(head)) {
54
+ return 'GPL-3.0-only';
55
+ }
56
+ if (/BSD 2-Clause/i.test(head)) {
57
+ return 'BSD-2-Clause';
58
+ }
59
+ if (/BSD 3-Clause/i.test(head)) {
60
+ return 'BSD-3-Clause';
61
+ }
62
+ return null;
63
+ }
64
+ /**
65
+ * Read LICENSE file and detect SPDX identifier.
66
+ * @param {string} manifestPath - path to manifest
67
+ * @returns {string|null} - SPDX identifier from LICENSE file or null
68
+ */
69
+ export function readLicenseFile(manifestPath) {
70
+ const licenseFilePath = findLicenseFilePath(manifestPath);
71
+ if (!licenseFilePath) {
72
+ return null;
73
+ }
74
+ try {
75
+ const content = fs.readFileSync(licenseFilePath, 'utf-8');
76
+ return detectSpdxFromText(content) || content.split('\n')[0]?.trim() || null;
77
+ }
78
+ catch {
79
+ return null;
80
+ }
81
+ }
82
+ /**
83
+ * Get project license from manifest or LICENSE file.
84
+ * Returns manifestLicense if provided, otherwise tries LICENSE file.
85
+ * @param {string|null} manifestLicense - license from manifest (or null)
86
+ * @param {string} manifestPath - path to manifest
87
+ * @returns {string|null} - SPDX identifier or null
88
+ */
89
+ export function getLicense(manifestLicense, manifestPath) {
90
+ return manifestLicense || readLicenseFile(manifestPath) || null;
91
+ }
92
+ /**
93
+ * Normalize SPDX identifier for comparison (lowercase, strip common suffixes).
94
+ * @param {string} spdxOrName
95
+ * @returns {string}
96
+ */
97
+ export function normalizeSpdx(spdxOrName) {
98
+ const s = String(spdxOrName).trim().toLowerCase();
99
+ if (s.endsWith(' license')) {
100
+ return s.slice(0, -8);
101
+ }
102
+ return s;
103
+ }
104
+ /**
105
+ * Check if a dependency's license is compatible with the project license based on backend categories.
106
+ *
107
+ * @param {string} [projectCategory] - backend category for project license: PERMISSIVE | WEAK_COPYLEFT | STRONG_COPYLEFT | UNKNOWN
108
+ * @param {string} [dependencyCategory] - backend category for dependency license: PERMISSIVE | WEAK_COPYLEFT | STRONG_COPYLEFT | UNKNOWN
109
+ * @returns {'compatible'|'incompatible'|'unknown'}
110
+ */
111
+ export function getCompatibility(projectCategory, dependencyCategory) {
112
+ if (!projectCategory || !dependencyCategory) {
113
+ return 'unknown';
114
+ }
115
+ const proj = projectCategory.toUpperCase();
116
+ const dep = dependencyCategory.toUpperCase();
117
+ if (proj === 'UNKNOWN' || dep === 'UNKNOWN') {
118
+ return 'unknown';
119
+ }
120
+ const restrictiveness = {
121
+ 'PERMISSIVE': 1,
122
+ 'WEAK_COPYLEFT': 2,
123
+ 'STRONG_COPYLEFT': 3
124
+ };
125
+ const projLevel = restrictiveness[proj];
126
+ const depLevel = restrictiveness[dep];
127
+ if (projLevel === undefined || depLevel === undefined) {
128
+ return 'unknown';
129
+ }
130
+ if (depLevel > projLevel) {
131
+ return 'incompatible';
132
+ }
133
+ return 'compatible';
134
+ }
@@ -0,0 +1,34 @@
1
+ /**
2
+ * Fetch license details by SPDX identifier from the backend GET /api/v5/licenses/{spdx}.
3
+ * Returns detailed information about a specific license including category, name, and text.
4
+ *
5
+ * @param {string} spdxId - SPDX identifier (e.g., "Apache-2.0", "MIT")
6
+ * @param {import('../index.js').Options} [opts={}] - options (proxy, token, TRUSTIFY_DA_BACKEND_URL, etc.)
7
+ * @returns {Promise<Object|null>} License details or null if not found
8
+ */
9
+ export function getLicenseDetails(spdxId: string, opts?: import("../index.js").Options): Promise<any | null>;
10
+ /**
11
+ * Normalize the LicensesResponse shape (array of LicenseProviderResult) into a map of purl -> license info.
12
+ * Each provider result has { status, summary, packages } where packages is { [purl]: { concluded, evidence } }.
13
+ * We merge the first successful provider's packages; concluded has identifiers[], category (PERMISSIVE | WEAK_COPYLEFT | STRONG_COPYLEFT | UNKNOWN).
14
+ *
15
+ * @param {unknown} data - LicensesResponse (array) or analysis report's licenses field
16
+ * @param {string[]} [purls] - optional list of purls to restrict to (for consistency with getLicensesByPurl)
17
+ * @returns {Map<string, { licenses: string[], category?: string }>}
18
+ */
19
+ export function normalizeLicensesResponse(data: unknown, purls?: string[]): Map<string, {
20
+ licenses: string[];
21
+ category?: string;
22
+ }>;
23
+ /**
24
+ * Build license map from an analysis report that already includes license data (result.licenses).
25
+ * Use this when the dependency analysis response already contains the licenses array to avoid a second request.
26
+ *
27
+ * @param {import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport} analysisReport - full analysis JSON
28
+ * @param {string[]} [purls] - optional list of purls to restrict to
29
+ * @returns {Map<string, { licenses: string[], category?: string }>}
30
+ */
31
+ export function licensesFromReport(analysisReport: import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport, purls?: string[]): Map<string, {
32
+ licenses: string[];
33
+ category?: string;
34
+ }>;
@@ -0,0 +1,98 @@
1
+ /**
2
+ * Client for the Trustify DA backend License Analysis API (POST /api/v5/licenses).
3
+ * The same license data shape is returned in the dependency analysis JSON report (result.licenses).
4
+ * @see https://github.com/guacsec/trustify-dependency-analytics#license-analysis-apiv5licenses
5
+ * @see https://github.com/guacsec/trustify-da-api-spec/blob/main/api/v5/openapi.yaml
6
+ */
7
+ import { PackageURL } from 'packageurl-js';
8
+ import { selectTrustifyDABackend } from '../index.js';
9
+ import { addProxyAgent, getTokenHeaders } from '../tools.js';
10
+ /**
11
+ * Fetch license details by SPDX identifier from the backend GET /api/v5/licenses/{spdx}.
12
+ * Returns detailed information about a specific license including category, name, and text.
13
+ *
14
+ * @param {string} spdxId - SPDX identifier (e.g., "Apache-2.0", "MIT")
15
+ * @param {import('../index.js').Options} [opts={}] - options (proxy, token, TRUSTIFY_DA_BACKEND_URL, etc.)
16
+ * @returns {Promise<Object|null>} License details or null if not found
17
+ */
18
+ export async function getLicenseDetails(spdxId, opts = {}) {
19
+ if (!spdxId) {
20
+ return null;
21
+ }
22
+ const url = selectTrustifyDABackend(opts);
23
+ const finalUrl = new URL(`${url}/api/v5/licenses/${encodeURIComponent(spdxId)}`);
24
+ const fetchOptions = addProxyAgent({
25
+ method: 'GET',
26
+ headers: {
27
+ 'Accept': 'application/json',
28
+ ...getTokenHeaders(opts)
29
+ },
30
+ }, opts);
31
+ try {
32
+ const resp = await fetch(finalUrl, fetchOptions);
33
+ if (!resp.ok) {
34
+ const errorText = await resp.text().catch(() => '');
35
+ throw new Error(`HTTP ${resp.status}: ${errorText || resp.statusText}`);
36
+ }
37
+ return await resp.json();
38
+ }
39
+ catch (err) {
40
+ throw new Error(`Failed to fetch license details: ${err.message}`);
41
+ }
42
+ }
43
+ function normalizePurlString(purl) {
44
+ const parsed = PackageURL.fromString(purl);
45
+ return new PackageURL(parsed.type, parsed.namespace, parsed.name, parsed.version, null, null).toString();
46
+ }
47
+ /**
48
+ * Normalize the LicensesResponse shape (array of LicenseProviderResult) into a map of purl -> license info.
49
+ * Each provider result has { status, summary, packages } where packages is { [purl]: { concluded, evidence } }.
50
+ * We merge the first successful provider's packages; concluded has identifiers[], category (PERMISSIVE | WEAK_COPYLEFT | STRONG_COPYLEFT | UNKNOWN).
51
+ *
52
+ * @param {unknown} data - LicensesResponse (array) or analysis report's licenses field
53
+ * @param {string[]} [purls] - optional list of purls to restrict to (for consistency with getLicensesByPurl)
54
+ * @returns {Map<string, { licenses: string[], category?: string }>}
55
+ */
56
+ export function normalizeLicensesResponse(data, purls = []) {
57
+ const map = new Map();
58
+ if (!data || !Array.isArray(data)) {
59
+ return map;
60
+ }
61
+ const normalizedPurlsSet = purls.length > 0 ? new Set(purls.map(normalizePurlString)) : null;
62
+ for (const providerResult of data) {
63
+ const packages = providerResult?.packages;
64
+ if (!packages || typeof packages !== 'object') {
65
+ continue;
66
+ }
67
+ for (const [purl, pkgLicense] of Object.entries(packages)) {
68
+ const concluded = pkgLicense?.concluded;
69
+ const identifiers = Array.isArray(concluded?.identifiers) ? concluded.identifiers : [];
70
+ const expression = concluded?.expression;
71
+ const licenses = identifiers.length > 0 ? identifiers : (expression ? [expression] : []);
72
+ const category = concluded?.category; // PERMISSIVE | WEAK_COPYLEFT | STRONG_COPYLEFT | UNKNOWN
73
+ const normalizedPurl = normalizePurlString(purl);
74
+ if (normalizedPurlsSet === null || normalizedPurlsSet.has(normalizedPurl)) {
75
+ map.set(normalizedPurl, { licenses: licenses.filter(Boolean), category });
76
+ }
77
+ }
78
+ // Use first provider that has packages; backend may return multiple (e.g. deps.dev)
79
+ if (map.size > 0) {
80
+ break;
81
+ }
82
+ }
83
+ return map;
84
+ }
85
+ /**
86
+ * Build license map from an analysis report that already includes license data (result.licenses).
87
+ * Use this when the dependency analysis response already contains the licenses array to avoid a second request.
88
+ *
89
+ * @param {import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport} analysisReport - full analysis JSON
90
+ * @param {string[]} [purls] - optional list of purls to restrict to
91
+ * @returns {Map<string, { licenses: string[], category?: string }>}
92
+ */
93
+ export function licensesFromReport(analysisReport, purls = []) {
94
+ if (!analysisReport?.licenses) {
95
+ return new Map();
96
+ }
97
+ return normalizeLicensesResponse(analysisReport.licenses, purls);
98
+ }
@@ -0,0 +1,20 @@
1
+ /**
2
+ * Resolve project license from manifest and from LICENSE / LICENSE.md in manifest dir or git root.
3
+ * Uses local pattern matching for LICENSE file identification (synchronous).
4
+ * For more accurate backend-based identification, use identifyLicense() separately.
5
+ * @param {string} manifestPath - path to manifest
6
+ * @returns {{ fromManifest: string|null, fromFile: string|null, mismatch: boolean }}
7
+ */
8
+ export function getProjectLicense(manifestPath: string): {
9
+ fromManifest: string | null;
10
+ fromFile: string | null;
11
+ mismatch: boolean;
12
+ };
13
+ /**
14
+ * Call backend /licenses/identify endpoint to identify license from file.
15
+ * @param {string} licenseFilePath - path to LICENSE file
16
+ * @param {{}} [opts={}] - options (proxy, token, etc.)
17
+ * @returns {Promise<string|null>} - SPDX identifier or null
18
+ */
19
+ export function identifyLicense(licenseFilePath: string, opts?: {}): Promise<string | null>;
20
+ export { findLicenseFilePath, readLicenseFile } from "./license_utils.js";
@@ -0,0 +1,62 @@
1
+ /**
2
+ * Resolves the project license from the manifest and from a LICENSE / LICENSE.md file.
3
+ * Used to report manifest-vs-file mismatch and as the baseline for dependency license compatibility.
4
+ */
5
+ import fs from 'node:fs';
6
+ import path from 'node:path';
7
+ import { selectTrustifyDABackend } from '../index.js';
8
+ import { matchForLicense, availableProviders } from '../provider.js';
9
+ import { addProxyAgent, getTokenHeaders } from '../tools.js';
10
+ import { normalizeSpdx, readLicenseFile } from './license_utils.js';
11
+ /**
12
+ * Resolve project license from manifest and from LICENSE / LICENSE.md in manifest dir or git root.
13
+ * Uses local pattern matching for LICENSE file identification (synchronous).
14
+ * For more accurate backend-based identification, use identifyLicense() separately.
15
+ * @param {string} manifestPath - path to manifest
16
+ * @returns {{ fromManifest: string|null, fromFile: string|null, mismatch: boolean }}
17
+ */
18
+ export function getProjectLicense(manifestPath) {
19
+ const resolved = path.resolve(manifestPath);
20
+ const provider = matchForLicense(resolved, availableProviders);
21
+ const fromManifest = provider.readLicenseFromManifest(resolved);
22
+ const fromFile = readLicenseFile(resolved);
23
+ const mismatch = Boolean(fromManifest && fromFile && normalizeSpdx(fromManifest) !== normalizeSpdx(fromFile));
24
+ return {
25
+ fromManifest: fromManifest || null,
26
+ fromFile: fromFile || null,
27
+ mismatch
28
+ };
29
+ }
30
+ export { findLicenseFilePath, readLicenseFile } from './license_utils.js';
31
+ /**
32
+ * Call backend /licenses/identify endpoint to identify license from file.
33
+ * @param {string} licenseFilePath - path to LICENSE file
34
+ * @param {{}} [opts={}] - options (proxy, token, etc.)
35
+ * @returns {Promise<string|null>} - SPDX identifier or null
36
+ */
37
+ export async function identifyLicense(licenseFilePath, opts = {}) {
38
+ try {
39
+ const fileContent = fs.readFileSync(licenseFilePath);
40
+ const backendUrl = selectTrustifyDABackend(opts);
41
+ const url = new URL(`${backendUrl}/api/v5/licenses/identify`);
42
+ const tokenHeaders = getTokenHeaders(opts);
43
+ const fetchOptions = addProxyAgent({
44
+ method: 'POST',
45
+ headers: {
46
+ 'Content-Type': 'application/octet-stream',
47
+ ...tokenHeaders,
48
+ },
49
+ body: fileContent,
50
+ }, opts);
51
+ const resp = await fetch(url, fetchOptions);
52
+ if (!resp.ok) {
53
+ return null; // Fallback to local detection on error
54
+ }
55
+ const data = await resp.json();
56
+ // Extract SPDX identifier from backend response
57
+ return data?.license?.id || data?.spdx_id || data?.identifier || null;
58
+ }
59
+ catch {
60
+ return null; // Fallback to local detection on error
61
+ }
62
+ }
@@ -1,3 +1,11 @@
1
+ /**
2
+ * Match a provider by manifest type only (no lock file check). Used for license reading.
3
+ * @param {string} manifestPath - path or name of the manifest
4
+ * @param {[Provider]} providers - list of providers to iterate over
5
+ * @returns {Provider}
6
+ * @throws {Error} when the manifest is not supported and no provider was matched
7
+ */
8
+ export function matchForLicense(manifestPath: string, providers: [Provider]): Provider;
1
9
  /**
2
10
  * Match a provider from a list or providers based on file type.
3
11
  * Each provider MUST export 'isSupported' taking a file name-type and returning true if supported.
@@ -10,7 +18,7 @@
10
18
  */
11
19
  export function match(manifest: string, providers: [Provider]): Provider;
12
20
  /** @typedef {{ecosystem: string, contentType: string, content: string}} Provided */
13
- /** @typedef {{isSupported: function(string): boolean, validateLockFile: function(string): void, provideComponent: function(string, {}): Provided, provideStack: function(string, {}): Provided}} Provider */
21
+ /** @typedef {{isSupported: function(string): boolean, validateLockFile: function(string): void, provideComponent: function(string, {}): Provided | Promise<Provided>, provideStack: function(string, {}): Provided | Promise<Provided>, readLicenseFromManifest: function(string): string | null}} Provider */
14
22
  /**
15
23
  * MUST include all providers here.
16
24
  * @type {[Provider]}
@@ -24,6 +32,7 @@ export type Provided = {
24
32
  export type Provider = {
25
33
  isSupported: (arg0: string) => boolean;
26
34
  validateLockFile: (arg0: string) => void;
27
- provideComponent: (arg0: string, arg1: {}) => Provided;
28
- provideStack: (arg0: string, arg1: {}) => Provided;
35
+ provideComponent: (arg0: string, arg1: {}) => Provided | Promise<Provided>;
36
+ provideStack: (arg0: string, arg1: {}) => Provided | Promise<Provided>;
37
+ readLicenseFromManifest: (arg0: string) => string | null;
29
38
  };
@@ -8,7 +8,7 @@ import Javascript_pnpm from './providers/javascript_pnpm.js';
8
8
  import Javascript_yarn from './providers/javascript_yarn.js';
9
9
  import pythonPipProvider from './providers/python_pip.js';
10
10
  /** @typedef {{ecosystem: string, contentType: string, content: string}} Provided */
11
- /** @typedef {{isSupported: function(string): boolean, validateLockFile: function(string): void, provideComponent: function(string, {}): Provided, provideStack: function(string, {}): Provided}} Provider */
11
+ /** @typedef {{isSupported: function(string): boolean, validateLockFile: function(string): void, provideComponent: function(string, {}): Provided | Promise<Provided>, provideStack: function(string, {}): Provided | Promise<Provided>, readLicenseFromManifest: function(string): string | null}} Provider */
12
12
  /**
13
13
  * MUST include all providers here.
14
14
  * @type {[Provider]}
@@ -23,6 +23,21 @@ export const availableProviders = [
23
23
  golangGomodulesProvider,
24
24
  pythonPipProvider
25
25
  ];
26
+ /**
27
+ * Match a provider by manifest type only (no lock file check). Used for license reading.
28
+ * @param {string} manifestPath - path or name of the manifest
29
+ * @param {[Provider]} providers - list of providers to iterate over
30
+ * @returns {Provider}
31
+ * @throws {Error} when the manifest is not supported and no provider was matched
32
+ */
33
+ export function matchForLicense(manifestPath, providers) {
34
+ const base = path.parse(manifestPath).base;
35
+ const provider = providers.find(prov => prov.isSupported(base));
36
+ if (!provider) {
37
+ throw new Error(`${base} is not supported`);
38
+ }
39
+ return provider;
40
+ }
26
41
  /**
27
42
  * Match a provider from a list or providers based on file type.
28
43
  * Each provider MUST export 'isSupported' taking a file name-type and returning true if supported.
@@ -1,5 +1,6 @@
1
- /** @typedef {import('../provider.js').Provider} Provider */
2
- /** @typedef {import('../provider.js').Provided} Provided */
1
+ export type purlType = import("../provider").Provider;
2
+ /** @typedef {import('../provider').Provider} */
3
+ /** @typedef {import('../provider').Provided} Provided */
3
4
  /**
4
5
  * The ecosystem identifier for JavaScript/npm packages
5
6
  * @type {string}
@@ -85,6 +86,12 @@ export default class Base_javascript {
85
86
  * @returns {Provided} The provided data for component analysis
86
87
  */
87
88
  provideComponent(manifestPath: string, opts?: any): Provided;
89
+ /**
90
+ * Read license from manifest (package.json). Reused by npm, pnpm, yarn.
91
+ * @param {string} manifestPath - path to package.json
92
+ * @returns {string|null}
93
+ */
94
+ readLicenseFromManifest(manifestPath: string): string | null;
88
95
  /**
89
96
  * Builds the dependency tree for the project
90
97
  * @param {boolean} includeTransitive - Whether to include transitive dependencies
@@ -121,7 +128,6 @@ export default class Base_javascript {
121
128
  protected _parseDepTreeOutput(output: string): string;
122
129
  #private;
123
130
  }
124
- export type Provider = import("../provider.js").Provider;
125
- export type Provided = import("../provider.js").Provided;
131
+ export type Provided = import("../provider").Provided;
126
132
  import Manifest from './manifest.js';
127
133
  import Sbom from '../sbom.js';
@@ -1,11 +1,12 @@
1
1
  import fs from 'node:fs';
2
2
  import os from "node:os";
3
3
  import path from 'node:path';
4
+ import { getLicense } from '../license/license_utils.js';
4
5
  import Sbom from '../sbom.js';
5
6
  import { getCustom, getCustomPath, invokeCommand, toPurl, toPurlFromString } from "../tools.js";
6
7
  import Manifest from './manifest.js';
7
- /** @typedef {import('../provider.js').Provider} Provider */
8
- /** @typedef {import('../provider.js').Provided} Provided */
8
+ /** @typedef {import('../provider').Provider} */
9
+ /** @typedef {import('../provider').Provided} Provided */
9
10
  /**
10
11
  * The ecosystem identifier for JavaScript/npm packages
11
12
  * @type {string}
@@ -132,6 +133,29 @@ export default class Base_javascript {
132
133
  contentType: 'application/vnd.cyclonedx+json'
133
134
  };
134
135
  }
136
+ /**
137
+ * Read license from manifest (package.json). Reused by npm, pnpm, yarn.
138
+ * @param {string} manifestPath - path to package.json
139
+ * @returns {string|null}
140
+ */
141
+ readLicenseFromManifest(manifestPath) {
142
+ let manifestLicense;
143
+ try {
144
+ const content = JSON.parse(fs.readFileSync(manifestPath, 'utf-8'));
145
+ if (typeof content.license === 'string') {
146
+ manifestLicense = content.license.trim() || null;
147
+ }
148
+ else if (Array.isArray(content.licenses) && content.licenses.length > 0) {
149
+ const first = content.licenses[0];
150
+ const name = first.type || first.name;
151
+ manifestLicense = (typeof name === 'string' ? name.trim() : null);
152
+ }
153
+ }
154
+ catch {
155
+ manifestLicense = null;
156
+ }
157
+ return getLicense(manifestLicense, manifestPath);
158
+ }
135
159
  /**
136
160
  * Builds the dependency tree for the project
137
161
  * @param {boolean} includeTransitive - Whether to include transitive dependencies
@@ -155,8 +179,9 @@ export default class Base_javascript {
155
179
  #getSBOM(opts = {}) {
156
180
  const depsObject = this._buildDependencyTree(true);
157
181
  let mainComponent = toPurl(purlType, this.#manifest.name, this.#manifest.version);
182
+ const license = this.readLicenseFromManifest(this.#manifest.manifestPath);
158
183
  let sbom = new Sbom();
159
- sbom.addRoot(mainComponent);
184
+ sbom.addRoot(mainComponent, license);
160
185
  this._addDependenciesToSbom(sbom, depsObject);
161
186
  sbom.filterIgnoredDeps(this.#manifest.ignored);
162
187
  return sbom.getAsJsonString(opts);
@@ -206,8 +231,9 @@ export default class Base_javascript {
206
231
  #getDirectDependencySbom(opts = {}) {
207
232
  const depTree = this._buildDependencyTree(false);
208
233
  let mainComponent = toPurl(purlType, this.#manifest.name, this.#manifest.version);
234
+ const license = this.readLicenseFromManifest(this.#manifest.manifestPath);
209
235
  let sbom = new Sbom();
210
- sbom.addRoot(mainComponent);
236
+ sbom.addRoot(mainComponent, license);
211
237
  const rootDeps = this._getRootDependencies(depTree);
212
238
  const sortedDepsKeys = Array
213
239
  .from(rootDeps.keys())
@@ -3,6 +3,7 @@ declare namespace _default {
3
3
  export { validateLockFile };
4
4
  export { provideComponent };
5
5
  export { provideStack };
6
+ export { readLicenseFromManifest };
6
7
  }
7
8
  export default _default;
8
9
  export type Provided = import("../provider").Provided;
@@ -20,7 +21,7 @@ export type Dependency = {
20
21
  /**
21
22
  * @param {string} manifestName - the subject manifest name-type
22
23
  * @returns {boolean} - return true if `pom.xml` is the manifest name-type
23
- */
24
+ */
24
25
  declare function isSupported(manifestName: string): boolean;
25
26
  /**
26
27
  * @param {string} manifestDir - the directory where the manifest lies
@@ -40,3 +41,9 @@ declare function provideComponent(manifest: string, opts?: {}): Provided;
40
41
  * @returns {Provided}
41
42
  */
42
43
  declare function provideStack(manifest: string, opts?: {}): Provided;
44
+ /**
45
+ * Go modules have no standard license field in go.mod
46
+ * @param {string} manifestPath - path to go.mod
47
+ * @returns {string|null}
48
+ */
49
+ declare function readLicenseFromManifest(manifestPath: string): string | null;
@@ -2,9 +2,10 @@ import fs from 'node:fs';
2
2
  import path from 'node:path';
3
3
  import { EOL } from "os";
4
4
  import { PackageURL } from 'packageurl-js';
5
+ import { readLicenseFile } from '../license/license_utils.js';
5
6
  import Sbom from '../sbom.js';
6
7
  import { getCustom, getCustomPath, invokeCommand } from "../tools.js";
7
- export default { isSupported, validateLockFile, provideComponent, provideStack };
8
+ export default { isSupported, validateLockFile, provideComponent, provideStack, readLicenseFromManifest };
8
9
  /** @typedef {import('../provider').Provider} */
9
10
  /** @typedef {import('../provider').Provided} Provided */
10
11
  /** @typedef {{name: string, version: string}} Package */
@@ -12,16 +13,23 @@ export default { isSupported, validateLockFile, provideComponent, provideStack }
12
13
  /**
13
14
  * @type {string} ecosystem for npm-npm is 'maven'
14
15
  * @private
15
- */
16
+ */
16
17
  const ecosystem = 'golang';
17
18
  const defaultMainModuleVersion = "v0.0.0";
18
19
  /**
19
20
  * @param {string} manifestName - the subject manifest name-type
20
21
  * @returns {boolean} - return true if `pom.xml` is the manifest name-type
21
- */
22
+ */
22
23
  function isSupported(manifestName) {
23
24
  return 'go.mod' === manifestName;
24
25
  }
26
+ /**
27
+ * Go modules have no standard license field in go.mod
28
+ * @param {string} manifestPath - path to go.mod
29
+ * @returns {string|null}
30
+ */
31
+ // eslint-disable-next-line no-unused-vars
32
+ function readLicenseFromManifest(manifestPath) { return readLicenseFile(manifestPath); }
25
33
  /**
26
34
  * @param {string} manifestDir - the directory where the manifest lies
27
35
  */
@@ -250,7 +258,8 @@ function getSBOM(manifest, opts = {}, includeTransitive) {
250
258
  performManifestVersionsCheck(root, rows, manifest);
251
259
  }
252
260
  const mainModule = toPurl(root, "@");
253
- sbom.addRoot(mainModule);
261
+ const license = readLicenseFromManifest(manifest);
262
+ sbom.addRoot(mainModule, license);
254
263
  const exhortGoMvsLogicEnabled = getCustom("TRUSTIFY_DA_GO_MVS_LOGIC_ENABLED", "true", opts);
255
264
  if (includeTransitive && exhortGoMvsLogicEnabled === "true") {
256
265
  rows = getFinalPackagesVersionsForModule(rows, manifest, goBin);
@@ -15,6 +15,12 @@ export default class Java_gradle extends Base_java {
15
15
  * @param {string} manifestDir - the directory where the manifest lies
16
16
  */
17
17
  validateLockFile(): boolean;
18
+ /**
19
+ * Gradle manifests (build.gradle, build.gradle.kts) have no standard license field.
20
+ * @param {string} manifestPath - path to manifest
21
+ * @returns {null}
22
+ */
23
+ readLicenseFromManifest(manifestPath: string): null;
18
24
  /**
19
25
  * Provide content and content type for stack analysis.
20
26
  * @param {string} manifest - the manifest path or name