@trustify-da/trustify-da-javascript-client 0.3.0-ea.76e1fef → 0.3.0-ea.7ee4047

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 (83) hide show
  1. package/README.md +199 -11
  2. package/dist/package.json +30 -26
  3. package/dist/src/analysis.d.ts +50 -22
  4. package/dist/src/analysis.js +70 -18
  5. package/dist/src/cli.js +188 -6
  6. package/dist/src/config.d.ts +120 -0
  7. package/dist/src/config.js +260 -0
  8. package/dist/src/cyclone_dx_sbom.d.ts +13 -0
  9. package/dist/src/cyclone_dx_sbom.js +50 -4
  10. package/dist/src/index.d.ts +27 -23
  11. package/dist/src/index.js +32 -41
  12. package/dist/src/license/index.d.ts +4 -4
  13. package/dist/src/license/index.js +13 -7
  14. package/dist/src/license/license_utils.js +4 -1
  15. package/dist/src/license/licenses_api.d.ts +3 -3
  16. package/dist/src/license/licenses_api.js +1 -1
  17. package/dist/src/oci_image/images.d.ts +1 -1
  18. package/dist/src/oci_image/images.js +15 -1
  19. package/dist/src/oci_image/utils.d.ts +5 -5
  20. package/dist/src/package_version.d.ts +8 -0
  21. package/dist/src/package_version.js +31 -0
  22. package/dist/src/provider.d.ts +4 -3
  23. package/dist/src/provider.js +6 -2
  24. package/dist/src/providers/base_java.d.ts +67 -3
  25. package/dist/src/providers/base_java.js +80 -23
  26. package/dist/src/providers/base_javascript.d.ts +74 -9
  27. package/dist/src/providers/base_javascript.js +116 -7
  28. package/dist/src/providers/base_pyproject.d.ts +10 -5
  29. package/dist/src/providers/base_pyproject.js +7 -0
  30. package/dist/src/providers/containerfile_parser.d.ts +5 -0
  31. package/dist/src/providers/containerfile_parser.js +20 -0
  32. package/dist/src/providers/golang_gomodules.d.ts +2 -1
  33. package/dist/src/providers/golang_gomodules.js +50 -8
  34. package/dist/src/providers/java_gradle.d.ts +48 -0
  35. package/dist/src/providers/java_gradle.js +206 -22
  36. package/dist/src/providers/java_gradle_groovy.d.ts +1 -1
  37. package/dist/src/providers/java_gradle_kotlin.d.ts +1 -1
  38. package/dist/src/providers/java_maven.d.ts +29 -9
  39. package/dist/src/providers/java_maven.js +176 -10
  40. package/dist/src/providers/javascript_bun.d.ts +22 -0
  41. package/dist/src/providers/javascript_bun.js +141 -0
  42. package/dist/src/providers/javascript_npm.d.ts +19 -1
  43. package/dist/src/providers/javascript_npm.js +40 -1
  44. package/dist/src/providers/javascript_pnpm.d.ts +13 -0
  45. package/dist/src/providers/javascript_pnpm.js +47 -1
  46. package/dist/src/providers/javascript_yarn.d.ts +12 -0
  47. package/dist/src/providers/javascript_yarn.js +75 -2
  48. package/dist/src/providers/manifest.js +6 -3
  49. package/dist/src/providers/oci_dockerfile.d.ts +51 -0
  50. package/dist/src/providers/oci_dockerfile.js +177 -0
  51. package/dist/src/providers/processors/yarn_berry_processor.d.ts +6 -2
  52. package/dist/src/providers/processors/yarn_berry_processor.js +3 -2
  53. package/dist/src/providers/processors/yarn_classic_processor.d.ts +6 -2
  54. package/dist/src/providers/processors/yarn_classic_processor.js +8 -6
  55. package/dist/src/providers/python_controller.js +61 -4
  56. package/dist/src/providers/python_pip.d.ts +1 -0
  57. package/dist/src/providers/python_pip.js +1 -1
  58. package/dist/src/providers/python_pip_pyproject.js +3 -1
  59. package/dist/src/providers/python_poetry.d.ts +31 -8
  60. package/dist/src/providers/python_poetry.js +62 -14
  61. package/dist/src/providers/python_uv.d.ts +5 -14
  62. package/dist/src/providers/python_uv.js +50 -2
  63. package/dist/src/providers/requirements_parser.js +1 -1
  64. package/dist/src/providers/rust_cargo.d.ts +6 -2
  65. package/dist/src/providers/rust_cargo.js +101 -33
  66. package/dist/src/providers/tree-sitter-containerfile.wasm +0 -0
  67. package/dist/src/remediate.d.ts +107 -0
  68. package/dist/src/remediate.js +244 -0
  69. package/dist/src/remediation.d.ts +81 -0
  70. package/dist/src/remediation.js +475 -0
  71. package/dist/src/remediation_report.d.ts +23 -0
  72. package/dist/src/remediation_report.js +180 -0
  73. package/dist/src/sbom.d.ts +11 -0
  74. package/dist/src/sbom.js +10 -0
  75. package/dist/src/tools.d.ts +11 -13
  76. package/dist/src/tools.js +34 -13
  77. package/dist/src/updaters/maven_updater.d.ts +58 -0
  78. package/dist/src/updaters/maven_updater.js +345 -0
  79. package/dist/src/updaters/toml_updater.d.ts +62 -0
  80. package/dist/src/updaters/toml_updater.js +276 -0
  81. package/dist/src/workspace.d.ts +2 -1
  82. package/dist/src/workspace.js +2 -1
  83. package/package.json +31 -27
package/dist/src/index.js CHANGED
@@ -1,21 +1,24 @@
1
+ import fs from 'node:fs';
1
2
  import path from "node:path";
2
3
  import { EOL } from "os";
3
4
  import pLimit from 'p-limit';
4
- import { availableProviders, match } from './provider.js';
5
5
  import analysis from './analysis.js';
6
- import fs from 'node:fs';
7
- import { getCustom } from "./tools.js";
8
6
  import { resolveBatchMetadata, resolveContinueOnError } from './batch_opts.js';
9
- import { discoverMavenModules } from './providers/java_maven.js';
10
- import { discoverGradleSubprojects } from './providers/java_gradle.js';
7
+ import { getPackageVersion } from './package_version.js';
8
+ import { availableProviders, match } from './provider.js';
11
9
  import { discoverGoWorkspaceModules } from './providers/golang_gomodules.js';
10
+ import { discoverGradleSubprojects } from './providers/java_gradle.js';
11
+ import { discoverMavenModules } from './providers/java_maven.js';
12
12
  import { discoverUvWorkspaceMembers } from './providers/python_uv.js';
13
+ import { getCustom } from "./tools.js";
13
14
  import { discoverWorkspaceCrates, discoverWorkspacePackages, filterManifestPathsByDiscoveryIgnore, resolveWorkspaceDiscoveryIgnore, validatePackageJson, } from './workspace.js';
14
- import.meta.dirname;
15
- import * as url from 'url';
16
15
  export { parseImageRef } from "./oci_image/utils.js";
17
16
  export { ImageRef } from "./oci_image/images.js";
18
17
  export { getProjectLicense, findLicenseFilePath, identifyLicense, getLicenseDetails, licensesFromReport, normalizeLicensesResponse, runLicenseCheck, getCompatibility } from "./license/index.js";
18
+ export { extractRemediations, maxSeverity } from "./remediation.js";
19
+ export { generateReport, generateDeduplicationKey } from './remediation_report.js';
20
+ export { loadConfig, mergeConfig, resolveConfig, CONFIG_FILENAMES } from './config.js';
21
+ export { runRemediation, findManifests } from './remediate.js';
19
22
  export default { componentAnalysis, stackAnalysis, stackAnalysisBatch, imageAnalysis, validateToken, generateSbom };
20
23
  export { discoverMavenModules, discoverGradleSubprojects, discoverGoWorkspaceModules, discoverUvWorkspaceMembers, discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson, resolveWorkspaceDiscoveryIgnore, filterManifestPathsByDiscoveryIgnore, resolveContinueOnError, resolveBatchMetadata, };
21
24
  /**
@@ -39,7 +42,9 @@ export { discoverMavenModules, discoverGradleSubprojects, discoverGoWorkspaceMod
39
42
  * TRUSTIFY_DA_PYTHON_PATH?: string | undefined,
40
43
  * TRUSTIFY_DA_PYTHON_VIRTUAL_ENV?: string | undefined,
41
44
  * TRUSTIFY_DA_PYTHON3_PATH?: string | undefined,
42
- * TRUSTIFY_DA_RECOMMENDATIONS_ENABLED?: string | undefined,
45
+ * TRUSTIFY_DA_PROVIDERS?: string | undefined,
46
+ * TRUSTIFY_DA_RECOMMEND?: string | undefined,
47
+ * TRUSTIFY_DA_SOURCES?: string | undefined,
43
48
  * TRUSTIFY_DA_SKOPEO_CONFIG_PATH?: string | undefined,
44
49
  * TRUSTIFY_DA_SKOPEO_PATH?: string | undefined,
45
50
  * TRUSTIFY_DA_SYFT_CONFIG_PATH?: string | undefined,
@@ -47,11 +52,11 @@ export { discoverMavenModules, discoverGradleSubprojects, discoverGoWorkspaceMod
47
52
  * TRUSTIFY_DA_YARN_PATH?: string | undefined,
48
53
  * TRUSTIFY_DA_WORKSPACE_DIR?: string | undefined,
49
54
  * TRUSTIFY_DA_LICENSE_CHECK?: string | undefined,
55
+ * licenseCheck?: boolean | undefined,
50
56
  * MATCH_MANIFEST_VERSIONS?: string | undefined,
51
57
  * TRUSTIFY_DA_SOURCE?: string | undefined,
52
58
  * TRUSTIFY_DA_TOKEN?: string | undefined,
53
59
  * TRUSTIFY_DA_TELEMETRY_ID?: string | undefined,
54
- * TRUSTIFY_DA_WORKSPACE_DIR?: string | undefined,
55
60
  * batchConcurrency?: number | undefined,
56
61
  * TRUSTIFY_DA_BATCH_CONCURRENCY?: string | undefined,
57
62
  * workspaceDiscoveryIgnore?: string[] | undefined,
@@ -91,29 +96,11 @@ function logOptionsAndEnvironmentsVariables(alongsideText, valueToBePrinted) {
91
96
  * @private
92
97
  */
93
98
  function readAndPrintVersionFromPackageJson() {
94
- let dirName;
95
- // new ESM way in nodeJS ( since node version 22 ) to bring module directory.
96
- dirName = import.meta.dirname;
97
- // old ESM way in nodeJS ( before node versions 22.00 to bring module directory)
98
- if (!dirName) {
99
- dirName = url.fileURLToPath(new URL('.', import.meta.url));
100
- }
101
- try {
102
- if (__dirname) {
103
- dirName = __dirname;
104
- }
105
- }
106
- catch (e) {
107
- console.log("__dirname is not defined, continue with fileUrlPath");
108
- }
109
- let packageJson = JSON.parse(fs.readFileSync(path.join(dirName, "..", "package.json")).toString());
110
- logOptionsAndEnvironmentsVariables("trustify-da-javascript-client analysis started, version: ", packageJson.version);
99
+ logOptionsAndEnvironmentsVariables("trustify-da-javascript-client analysis started, version: ", getPackageVersion());
111
100
  }
112
101
  /**
113
- * This function is used to determine the Trustify DA backend URL.
114
- * The TRUSTIFY_DA_BACKEND_URL is evaluated in the following order and selected when it finds it first:
115
- * 1. Environment Variable
116
- * 2. (key,value) from opts object
102
+ * Selects the Trustify DA backend URL from opts.TRUSTIFY_DA_BACKEND_URL, then environment
103
+ * variable TRUSTIFY_DA_BACKEND_URL. Options take precedence over environment variables.
117
104
  * If TRUSTIFY_DA_BACKEND_URL is not set, the function will throw an error.
118
105
  * @param {{TRUSTIFY_DA_DEBUG?: string | undefined; TRUSTIFY_DA_BACKEND_URL?: string | undefined}} [opts={}]
119
106
  * @return {string} - The selected Trustify DA backend URL
@@ -144,7 +131,7 @@ export function selectTrustifyDABackend(opts = {}) {
144
131
  * @param {string} manifest
145
132
  * @param {false} html
146
133
  * @param {Options} [opts={}]
147
- * @returns {Promise<import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>}
134
+ * @returns {Promise<import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport>}
148
135
  * @throws {Error}
149
136
  */
150
137
  /**
@@ -153,7 +140,7 @@ export function selectTrustifyDABackend(opts = {}) {
153
140
  * @param {string} manifest - path for the manifest
154
141
  * @param {boolean} [html=false] - true will return a html string, false will return AnalysisReport object.
155
142
  * @param {Options} [opts={}] - optional various options to pass along the application
156
- * @returns {Promise<string|import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>}
143
+ * @returns {Promise<string|import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport>}
157
144
  * @throws {Error} if manifest inaccessible, no matching provider, failed to get create content,
158
145
  * or backend request failed
159
146
  */
@@ -167,7 +154,7 @@ async function stackAnalysis(manifest, html = false, opts = {}) {
167
154
  * Get component analysis report for a manifest content.
168
155
  * @param {string} manifest - path to the manifest
169
156
  * @param {Options} [opts={}] - optional various options to pass along the application
170
- * @returns {Promise<import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>}
157
+ * @returns {Promise<import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport>}
171
158
  * @throws {Error} if no matching provider, failed to get create content, or backend request failed
172
159
  */
173
160
  async function componentAnalysis(manifest, opts = {}) {
@@ -175,7 +162,9 @@ async function componentAnalysis(manifest, opts = {}) {
175
162
  fs.accessSync(manifest, fs.constants.R_OK);
176
163
  opts["manifest-type"] = path.basename(manifest);
177
164
  let provider = match(manifest, availableProviders, opts); // throws error if no matching provider
178
- return await analysis.requestComponent(provider, manifest, theUrl, opts); // throws error request sending failed
165
+ const result = await analysis.requestComponent(provider, manifest, theUrl, opts); // throws error request sending failed
166
+ result.packageManager = provider.packageManagerName();
167
+ return result;
179
168
  }
180
169
  /**
181
170
  * @overload
@@ -190,7 +179,7 @@ async function componentAnalysis(manifest, opts = {}) {
190
179
  * @param {Array<string>} imageRefs
191
180
  * @param {false} html
192
181
  * @param {Options} [opts={}]
193
- * @returns {Promise<Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>>}
182
+ * @returns {Promise<Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport>>}
194
183
  * @throws {Error}
195
184
  */
196
185
  /**
@@ -199,7 +188,7 @@ async function componentAnalysis(manifest, opts = {}) {
199
188
  * @param {Array<string>} imageRefs - OCI image references
200
189
  * @param {boolean} [html=false] - true will return a html string, false will return AnalysisReport
201
190
  * @param {Options} [opts={}] - optional various options to pass along the application
202
- * @returns {Promise<string|Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>>}
191
+ * @returns {Promise<string|Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport>>}
203
192
  * @throws {Error} if manifest inaccessible, no matching provider, failed to get create content,
204
193
  * or backend request failed
205
194
  */
@@ -208,7 +197,8 @@ async function imageAnalysis(imageRefs, html = false, opts = {}) {
208
197
  return await analysis.requestImages(imageRefs, theUrl, html, opts);
209
198
  }
210
199
  /**
211
- * Max concurrent SBOM generations for batch workspace analysis. Env/opts override default 10.
200
+ * Max concurrent SBOM generations for batch workspace analysis. Options override environment;
201
+ * environment overrides the default of 10.
212
202
  * @param {Options} opts
213
203
  * @returns {number}
214
204
  * @private
@@ -320,7 +310,8 @@ async function detectWorkspaceManifests(root, opts) {
320
310
  return { ecosystem: 'pyproject', manifestPaths };
321
311
  }
322
312
  }
323
- const hasJsLock = fs.existsSync(path.join(root, 'pnpm-lock.yaml'))
313
+ const hasJsLock = fs.existsSync(path.join(root, 'bun.lock'))
314
+ || fs.existsSync(path.join(root, 'pnpm-lock.yaml'))
324
315
  || fs.existsSync(path.join(root, 'yarn.lock'))
325
316
  || fs.existsSync(path.join(root, 'package-lock.json'));
326
317
  if (fs.existsSync(packageJson) && hasJsLock) {
@@ -450,7 +441,7 @@ function batchError(message, wantMetadata, metadata) {
450
441
  * @param {string} workspaceRoot
451
442
  * @param {false} html
452
443
  * @param {Options & { batchMetadata: true }} opts
453
- * @returns {Promise<{ analysis: Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>, metadata: BatchAnalysisMetadata }>}
444
+ * @returns {Promise<{ analysis: Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport>, metadata: BatchAnalysisMetadata }>}
454
445
  * @throws {Error}
455
446
  */
456
447
  /**
@@ -458,7 +449,7 @@ function batchError(message, wantMetadata, metadata) {
458
449
  * @param {string} workspaceRoot
459
450
  * @param {false} html
460
451
  * @param {Options & { batchMetadata?: false }} [opts={}]
461
- * @returns {Promise<Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>>}
452
+ * @returns {Promise<Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport>>}
462
453
  * @throws {Error}
463
454
  */
464
455
  /**
@@ -471,7 +462,7 @@ function batchError(message, wantMetadata, metadata) {
471
462
  * @param {string} workspaceRoot - Path to workspace root (containing lock file and workspace config)
472
463
  * @param {boolean} [html=false] - true returns HTML, false returns JSON report
473
464
  * @param {Options} [opts={}] - `batchConcurrency`, discovery ignores, `continueOnError` (default true), `batchMetadata` (default false)
474
- * @returns {Promise<string|Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>|{ analysis: string|Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>, metadata: BatchAnalysisMetadata }>}
465
+ * @returns {Promise<string|Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport>|{ analysis: string|Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport>, metadata: BatchAnalysisMetadata }>}
475
466
  * @throws {Error} if workspace root invalid, no manifests found, no packages pass validation, no SBOMs produced, or backend request failed. When `opts.batchMetadata` is set, `error.batchMetadata` may be set on thrown errors.
476
467
  */
477
468
  async function stackAnalysisBatch(workspaceRoot, html = false, opts = {}) {
@@ -6,13 +6,13 @@
6
6
  * @param {string} manifestPath - path to manifest
7
7
  * @param {string} url - the backend url to send the request to
8
8
  * @param {import('../index.js').Options} [opts={}]
9
- * @param {import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport} [analysisResult] - analysis result that includes licenses array from backend
9
+ * @param {import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport} [analysisResult] - analysis result that includes licenses array from backend
10
10
  * @returns {Promise<{ projectLicense: { manifest: Object|null, file: Object|null, mismatch: boolean }, incompatibleDependencies: Array<{ purl: string, licenses: string[], category?: string, reason: string }>, error?: string }>}
11
11
  */
12
- export function runLicenseCheck(sbomContent: string, manifestPath: string, url: string, opts?: import("../index.js").Options, analysisResult?: import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport): Promise<{
12
+ export function runLicenseCheck(sbomContent: string, manifestPath: string, url: string, opts?: import("../index.js").Options, analysisResult?: import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts").AnalysisReport): Promise<{
13
13
  projectLicense: {
14
- manifest: any | null;
15
- file: any | null;
14
+ manifest: Object | null;
15
+ file: Object | null;
16
16
  mismatch: boolean;
17
17
  };
18
18
  incompatibleDependencies: Array<{
@@ -1,9 +1,9 @@
1
1
  /**
2
2
  * License resolution and dependency license compatibility for component analysis.
3
3
  */
4
- import { getProjectLicense, findLicenseFilePath, identifyLicense } from './project_license.js';
5
- import { licensesFromReport, getLicenseDetails } from './licenses_api.js';
6
4
  import { getCompatibility } from './license_utils.js';
5
+ import { licensesFromReport, getLicenseDetails } from './licenses_api.js';
6
+ import { getProjectLicense, findLicenseFilePath, identifyLicense } from './project_license.js';
7
7
  export { getProjectLicense, findLicenseFilePath, identifyLicense } from './project_license.js';
8
8
  export { licensesFromReport, normalizeLicensesResponse, getLicenseDetails } from './licenses_api.js';
9
9
  export { getCompatibility } from './license_utils.js';
@@ -15,7 +15,7 @@ export { getCompatibility } from './license_utils.js';
15
15
  * @param {string} manifestPath - path to manifest
16
16
  * @param {string} url - the backend url to send the request to
17
17
  * @param {import('../index.js').Options} [opts={}]
18
- * @param {import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport} [analysisResult] - analysis result that includes licenses array from backend
18
+ * @param {import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport} [analysisResult] - analysis result that includes licenses array from backend
19
19
  * @returns {Promise<{ projectLicense: { manifest: Object|null, file: Object|null, mismatch: boolean }, incompatibleDependencies: Array<{ purl: string, licenses: string[], category?: string, reason: string }>, error?: string }>}
20
20
  */
21
21
  export async function runLicenseCheck(sbomContent, manifestPath, url, opts = {}, analysisResult = null) {
@@ -39,10 +39,12 @@ export async function runLicenseCheck(sbomContent, manifestPath, url, opts = {},
39
39
  // Fetch detailed license info from backend (avoid duplicate calls if same license)
40
40
  const licenseDetailsCache = new Map();
41
41
  async function getDetails(spdxId) {
42
- if (!spdxId || !url)
42
+ if (!spdxId || !url) {
43
43
  return null;
44
- if (licenseDetailsCache.has(spdxId))
44
+ }
45
+ if (licenseDetailsCache.has(spdxId)) {
45
46
  return licenseDetailsCache.get(spdxId);
47
+ }
46
48
  try {
47
49
  const details = await getLicenseDetails(spdxId, { ...opts, TRUSTIFY_DA_BACKEND_URL: url });
48
50
  licenseDetailsCache.set(spdxId, details);
@@ -81,15 +83,19 @@ export async function runLicenseCheck(sbomContent, manifestPath, url, opts = {},
81
83
  const incompatibleDependencies = [];
82
84
  for (const purl of purls) {
83
85
  const entry = licenseByPurl.get(purl);
84
- if (!entry)
86
+ if (!entry) {
85
87
  continue;
88
+ }
86
89
  const status = getCompatibility(projectCategory, entry.category);
87
90
  if (status === 'incompatible') {
91
+ const reason = entry.category?.toUpperCase() === 'UNKNOWN'
92
+ ? 'License not recognized as a standard SPDX identifier. Manual review recommended to verify compatibility.'
93
+ : 'Dependency license(s) are incompatible with the project license.';
88
94
  incompatibleDependencies.push({
89
95
  purl,
90
96
  licenses: entry.licenses,
91
97
  category: entry.category,
92
- reason: 'Dependency license(s) are incompatible with the project license.'
98
+ reason
93
99
  });
94
100
  }
95
101
  }
@@ -114,9 +114,12 @@ export function getCompatibility(projectCategory, dependencyCategory) {
114
114
  }
115
115
  const proj = projectCategory.toUpperCase();
116
116
  const dep = dependencyCategory.toUpperCase();
117
- if (proj === 'UNKNOWN' || dep === 'UNKNOWN') {
117
+ if (proj === 'UNKNOWN') {
118
118
  return 'unknown';
119
119
  }
120
+ if (dep === 'UNKNOWN') {
121
+ return 'incompatible';
122
+ }
120
123
  const restrictiveness = {
121
124
  'PERMISSIVE': 1,
122
125
  'WEAK_COPYLEFT': 2,
@@ -6,7 +6,7 @@
6
6
  * @param {import('../index.js').Options} [opts={}] - options (proxy, token, TRUSTIFY_DA_BACKEND_URL, etc.)
7
7
  * @returns {Promise<Object|null>} License details or null if not found
8
8
  */
9
- export function getLicenseDetails(spdxId: string, opts?: import("../index.js").Options): Promise<any | null>;
9
+ export function getLicenseDetails(spdxId: string, opts?: import("../index.js").Options): Promise<Object | null>;
10
10
  /**
11
11
  * Normalize the LicensesResponse shape (array of LicenseProviderResult) into a map of purl -> license info.
12
12
  * Each provider result has { status, summary, packages } where packages is { [purl]: { concluded, evidence } }.
@@ -24,11 +24,11 @@ export function normalizeLicensesResponse(data: unknown, purls?: string[]): Map<
24
24
  * Build license map from an analysis report that already includes license data (result.licenses).
25
25
  * Use this when the dependency analysis response already contains the licenses array to avoid a second request.
26
26
  *
27
- * @param {import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport} analysisReport - full analysis JSON
27
+ * @param {import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport} analysisReport - full analysis JSON
28
28
  * @param {string[]} [purls] - optional list of purls to restrict to
29
29
  * @returns {Map<string, { licenses: string[], category?: string }>}
30
30
  */
31
- export function licensesFromReport(analysisReport: import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport, purls?: string[]): Map<string, {
31
+ export function licensesFromReport(analysisReport: import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts").AnalysisReport, purls?: string[]): Map<string, {
32
32
  licenses: string[];
33
33
  category?: string;
34
34
  }>;
@@ -86,7 +86,7 @@ export function normalizeLicensesResponse(data, purls = []) {
86
86
  * Build license map from an analysis report that already includes license data (result.licenses).
87
87
  * Use this when the dependency analysis response already contains the licenses array to avoid a second request.
88
88
  *
89
- * @param {import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport} analysisReport - full analysis JSON
89
+ * @param {import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport} analysisReport - full analysis JSON
90
90
  * @param {string[]} [purls] - optional list of purls to restrict to
91
91
  * @returns {Map<string, { licenses: string[], category?: string }>}
92
92
  */
@@ -78,7 +78,7 @@ export class ImageRef {
78
78
  * @param {string} [platform]
79
79
  * @param {import("index.js").Options} [opts={}]
80
80
  */
81
- constructor(image: string, platform?: string, opts?: import("index.js").Options);
81
+ constructor(image: string, platform?: string, opts?: any);
82
82
  /** @type {Image} */
83
83
  image: Image;
84
84
  /** @type {Platform} */
@@ -242,8 +242,22 @@ export class ImageRef {
242
242
  getPackageURL() {
243
243
  /** @type {Object.<string, string>} */
244
244
  const qualifiers = {};
245
- const repositoryUrl = this.image.getNameWithoutTag();
245
+ let repositoryUrl = this.image.getNameWithoutTag();
246
246
  const simpleName = this.image.getSimpleName();
247
+ // Normalize Docker Hub image references so all forms produce the same PURL:
248
+ // node → docker.io/node
249
+ // docker.io/library/node → docker.io/node
250
+ if (repositoryUrl != null) {
251
+ const lower = repositoryUrl.toLowerCase();
252
+ if (lower === simpleName.toLowerCase()) {
253
+ // Bare name (e.g. "node") — default to docker.io
254
+ repositoryUrl = `docker.io/${simpleName}`;
255
+ }
256
+ else if (lower.startsWith('docker.io/library/')) {
257
+ // Official image with library/ prefix — strip it
258
+ repositoryUrl = `docker.io/${lower.substring('docker.io/library/'.length)}`;
259
+ }
260
+ }
247
261
  if (repositoryUrl != null && repositoryUrl.toLowerCase() !== simpleName.toLowerCase()) {
248
262
  qualifiers[ImageRef.REPOSITORY_QUALIFIER] = repositoryUrl.toLowerCase();
249
263
  }
@@ -4,7 +4,7 @@
4
4
  * @param {import("../index.js").Options} [opts={}] - optional various options to pass along the application
5
5
  * @returns {{}}
6
6
  */
7
- export function generateImageSBOM(imageRef: import("./images").ImageRef, opts?: import("../index.js").Options): {};
7
+ export function generateImageSBOM(imageRef: any, opts?: import("../index.js").Options): {};
8
8
  /**
9
9
  *
10
10
  * @param {string} image
@@ -25,7 +25,7 @@ export function getImagePlatform(opts?: import("../index.js").Options): Platform
25
25
  * @returns {Object.<string, string>} - The image digests
26
26
  * @throws {Error} If the image info is invalid
27
27
  */
28
- export function getImageDigests(imageRef: import("./images").ImageRef, opts?: import("../index.js").Options): {
28
+ export function getImageDigests(imageRef: any, opts?: import("../index.js").Options): {
29
29
  [x: string]: string;
30
30
  };
31
31
  export type SyftImageSource = {
@@ -34,9 +34,9 @@ export type SyftImageSource = {
34
34
  getVariant: () => string;
35
35
  };
36
36
  export type SyftImageSourceType = {
37
- getOs: (arg0: any) => string;
38
- getArch: (arg0: any) => string;
39
- getVariant: (arg0: any) => string;
37
+ getOs: (arg0: Object) => string;
38
+ getArch: (arg0: Object) => string;
39
+ getVariant: (arg0: Object) => string;
40
40
  };
41
41
  import { ImageRef } from './images.js';
42
42
  import { Platform } from './platform.js';
@@ -0,0 +1,8 @@
1
+ /**
2
+ * Reads this package's version from package.json, resolving the path relative
3
+ * to this module. Works under ESM (node >= 22 import.meta.dirname, older via
4
+ * import.meta.url) and CommonJS (__dirname). Returns undefined if the file
5
+ * cannot be read, so callers never fail on a missing version.
6
+ * @return {string|undefined} the package version, or undefined
7
+ */
8
+ export function getPackageVersion(): string | undefined;
@@ -0,0 +1,31 @@
1
+ import fs from "node:fs";
2
+ import path from "node:path";
3
+ import * as url from "url";
4
+ /**
5
+ * Reads this package's version from package.json, resolving the path relative
6
+ * to this module. Works under ESM (node >= 22 import.meta.dirname, older via
7
+ * import.meta.url) and CommonJS (__dirname). Returns undefined if the file
8
+ * cannot be read, so callers never fail on a missing version.
9
+ * @return {string|undefined} the package version, or undefined
10
+ */
11
+ export function getPackageVersion() {
12
+ try {
13
+ let dirName = import.meta.dirname;
14
+ if (!dirName) {
15
+ dirName = url.fileURLToPath(new URL('.', import.meta.url));
16
+ }
17
+ try {
18
+ if (__dirname) {
19
+ dirName = __dirname;
20
+ }
21
+ }
22
+ catch {
23
+ // __dirname not defined under ESM, continue with fileURLToPath
24
+ }
25
+ const packageJson = JSON.parse(fs.readFileSync(path.join(dirName, "..", "package.json")).toString());
26
+ return packageJson.version;
27
+ }
28
+ catch {
29
+ return undefined;
30
+ }
31
+ }
@@ -21,7 +21,7 @@ export function match(manifest: string, providers: [Provider], opts?: {
21
21
  TRUSTIFY_DA_WORKSPACE_DIR?: string;
22
22
  }): Provider;
23
23
  /** @typedef {{ecosystem: string, contentType: string, content: string}} Provided */
24
- /** @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 */
24
+ /** @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, Object=): string | null, packageManagerName: function(): string}} Provider */
25
25
  /**
26
26
  * MUST include all providers here.
27
27
  * @type {[Provider]}
@@ -34,8 +34,9 @@ export type Provided = {
34
34
  };
35
35
  export type Provider = {
36
36
  isSupported: (arg0: string) => boolean;
37
- validateLockFile: (arg0: string, arg1: any) => void;
37
+ validateLockFile: (arg0: string, arg1: Object) => void;
38
38
  provideComponent: (arg0: string, arg1: {}) => Provided | Promise<Provided>;
39
39
  provideStack: (arg0: string, arg1: {}) => Provided | Promise<Provided>;
40
- readLicenseFromManifest: (arg0: string) => string | null;
40
+ readLicenseFromManifest: (arg0: string, arg1: Object | undefined) => string | null;
41
+ packageManagerName: () => string;
41
42
  };
@@ -3,16 +3,18 @@ import golangGomodulesProvider from './providers/golang_gomodules.js';
3
3
  import Java_gradle_groovy from "./providers/java_gradle_groovy.js";
4
4
  import Java_gradle_kotlin from "./providers/java_gradle_kotlin.js";
5
5
  import Java_maven from "./providers/java_maven.js";
6
+ import Javascript_bun from './providers/javascript_bun.js';
6
7
  import Javascript_npm from './providers/javascript_npm.js';
7
8
  import Javascript_pnpm from './providers/javascript_pnpm.js';
8
9
  import Javascript_yarn from './providers/javascript_yarn.js';
10
+ import dockerfileProvider from './providers/oci_dockerfile.js';
9
11
  import pythonPipProvider from './providers/python_pip.js';
10
12
  import Python_pip_pyproject from './providers/python_pip_pyproject.js';
11
13
  import Python_poetry from './providers/python_poetry.js';
12
14
  import Python_uv from './providers/python_uv.js';
13
15
  import rustCargoProvider from './providers/rust_cargo.js';
14
16
  /** @typedef {{ecosystem: string, contentType: string, content: string}} Provided */
15
- /** @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 */
17
+ /** @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, Object=): string | null, packageManagerName: function(): string}} Provider */
16
18
  /**
17
19
  * MUST include all providers here.
18
20
  * @type {[Provider]}
@@ -21,6 +23,7 @@ export const availableProviders = [
21
23
  new Java_maven(),
22
24
  new Java_gradle_groovy(),
23
25
  new Java_gradle_kotlin(),
26
+ new Javascript_bun(),
24
27
  new Javascript_pnpm(),
25
28
  new Javascript_yarn(),
26
29
  new Javascript_npm(),
@@ -29,7 +32,8 @@ export const availableProviders = [
29
32
  new Python_poetry(),
30
33
  new Python_uv(),
31
34
  new Python_pip_pyproject(),
32
- rustCargoProvider
35
+ rustCargoProvider,
36
+ dockerfileProvider
33
37
  ];
34
38
  /**
35
39
  * Match a provider by manifest type only (no lock file check). Used for license reading.
@@ -1,4 +1,4 @@
1
- export type ecosystem_maven = import("../provider").Provider;
1
+ export type ecosystem_maven = any;
2
2
  /** @typedef {import('../provider').Provider} */
3
3
  /** @typedef {import('../provider').Provided} Provided */
4
4
  /** @typedef {{name: string, version: string}} Package */
@@ -10,6 +10,13 @@ export type ecosystem_maven = import("../provider").Provider;
10
10
  export const ecosystem_maven: string;
11
11
  export const ecosystem_gradle: "gradle";
12
12
  export default class Base_Java {
13
+ /**
14
+ * Maven dependency scopes. Used to detect whether the trailing column of a
15
+ * dependency-tree line is a scope keyword — which in turn signals that an
16
+ * optional classifier column is present between the packaging and version.
17
+ * @type {string[]}
18
+ */
19
+ static MAVEN_SCOPES: string[];
13
20
  /**
14
21
  *
15
22
  * @param {string} globalBinary name of the global binary
@@ -20,6 +27,11 @@ export default class Base_Java {
20
27
  CONFLICT_REGEX: RegExp;
21
28
  globalBinary: string;
22
29
  localWrapper: string;
30
+ /**
31
+ * Returns the package manager name (e.g. mvn, gradle)
32
+ * @returns {string}
33
+ */
34
+ packageManagerName(): string;
23
35
  /**
24
36
  * Recursively populates the SBOM instance with the parsed graph
25
37
  * @param {string} src - Source dependency to start the calculations from
@@ -28,6 +40,59 @@ export default class Base_Java {
28
40
  * @param {Sbom} sbom - The SBOM where the dependencies are being added
29
41
  */
30
42
  parseDependencyTree(src: string, srcDepth: number, lines: any[], sbom: Sbom): void;
43
+ /**
44
+ * Calculates how deep in the graph is the given line
45
+ * @param {string} line - line to calculate the depth from
46
+ * @returns {number} The calculated depth
47
+ * @protected
48
+ */
49
+ protected _getDepth(line: string): number;
50
+ /**
51
+ * Parse a single dependency-tree line into its Maven coordinate parts.
52
+ *
53
+ * This is the single source of truth for interpreting a dependency-tree
54
+ * line. Both {@link parseDep} (used to build SBOM component PURLs) and the
55
+ * Maven hash-map builder rely on it, so the PURL key and the artifact file
56
+ * path can never drift from one another.
57
+ *
58
+ * A line has the shape `groupId:artifactId:packaging[:classifier]:version[:scope]`.
59
+ * The classifier column is only present when a sixth column holds a known
60
+ * Maven scope keyword; otherwise the fourth column is the version.
61
+ *
62
+ * @param {string} line - line to parse from a dependency tree
63
+ * @returns {{groupId: string, artifactId: string, packaging: string, classifier: (string|null), version: string, scope: (string|null), overridden: boolean}}
64
+ * Parsed coordinate. `version` is the resolved concrete version — when the
65
+ * line carries a conflict override the override version replaces it and
66
+ * `overridden` is set, mirroring how Maven records the winning version.
67
+ */
68
+ parseCoordinate(line: string): {
69
+ groupId: string;
70
+ artifactId: string;
71
+ packaging: string;
72
+ classifier: (string | null);
73
+ version: string;
74
+ scope: (string | null);
75
+ overridden: boolean;
76
+ };
77
+ /**
78
+ * Build the canonical PackageURL for a parsed coordinate.
79
+ *
80
+ * The classifier is folded into the version component (e.g.
81
+ * `4.1.0-linux-x86_64`) except when the version came from a conflict
82
+ * override, in which case the override version stands alone — matching the
83
+ * historical behavior of {@link parseDep}.
84
+ *
85
+ * @param {{groupId: string, artifactId: string, classifier: (string|null), version: string, overridden: boolean}} coord
86
+ * @returns {PackageURL} The canonical packageURL for the coordinate
87
+ * @protected
88
+ */
89
+ protected _coordinateToPurl(coord: {
90
+ groupId: string;
91
+ artifactId: string;
92
+ classifier: (string | null);
93
+ version: string;
94
+ overridden: boolean;
95
+ }): PackageURL;
31
96
  /**
32
97
  * Create a PackageURL from any line in a Text Graph dependency tree for a manifest path.
33
98
  * @param {string} line - line to parse from a dependencies.txt file
@@ -57,9 +122,8 @@ export default class Base_Java {
57
122
  * @returns string
58
123
  */
59
124
  selectToolBinary(manifestPath: string, opts: {}): string | null;
60
- #private;
61
125
  }
62
- export type Provided = import("../provider").Provided;
126
+ export type Provided = any;
63
127
  export type Package = {
64
128
  name: string;
65
129
  version: string;