@trustify-da/trustify-da-javascript-client 0.3.0-ea.3aa2054 → 0.3.0-ea.41ca049

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 (87) 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 +20 -1
  9. package/dist/src/cyclone_dx_sbom.js +68 -9
  10. package/dist/src/index.d.ts +85 -21
  11. package/dist/src/index.js +96 -40
  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 +8 -2
  24. package/dist/src/providers/base_java.d.ts +67 -12
  25. package/dist/src/providers/base_java.js +82 -61
  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 +19 -31
  29. package/dist/src/providers/base_pyproject.js +57 -73
  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 +11 -1
  33. package/dist/src/providers/golang_gomodules.js +114 -15
  34. package/dist/src/providers/java_gradle.d.ts +67 -0
  35. package/dist/src/providers/java_gradle.js +312 -20
  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 +37 -9
  39. package/dist/src/providers/java_maven.js +269 -11
  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 -0
  43. package/dist/src/providers/javascript_npm.js +61 -1
  44. package/dist/src/providers/javascript_pnpm.d.ts +13 -0
  45. package/dist/src/providers/javascript_pnpm.js +53 -3
  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/marker_evaluator.d.ts +14 -0
  50. package/dist/src/providers/marker_evaluator.js +191 -0
  51. package/dist/src/providers/oci_dockerfile.d.ts +51 -0
  52. package/dist/src/providers/oci_dockerfile.js +177 -0
  53. package/dist/src/providers/processors/yarn_berry_processor.d.ts +6 -2
  54. package/dist/src/providers/processors/yarn_berry_processor.js +9 -4
  55. package/dist/src/providers/processors/yarn_classic_processor.d.ts +6 -2
  56. package/dist/src/providers/processors/yarn_classic_processor.js +8 -6
  57. package/dist/src/providers/python_controller.d.ts +5 -1
  58. package/dist/src/providers/python_controller.js +69 -8
  59. package/dist/src/providers/python_pip.d.ts +5 -0
  60. package/dist/src/providers/python_pip.js +5 -5
  61. package/dist/src/providers/python_pip_pyproject.d.ts +61 -0
  62. package/dist/src/providers/python_pip_pyproject.js +146 -0
  63. package/dist/src/providers/python_poetry.d.ts +64 -8
  64. package/dist/src/providers/python_poetry.js +139 -22
  65. package/dist/src/providers/python_uv.d.ts +20 -1
  66. package/dist/src/providers/python_uv.js +126 -3
  67. package/dist/src/providers/requirements_parser.js +1 -1
  68. package/dist/src/providers/rust_cargo.d.ts +6 -2
  69. package/dist/src/providers/rust_cargo.js +101 -33
  70. package/dist/src/providers/tree-sitter-containerfile.wasm +0 -0
  71. package/dist/src/remediate.d.ts +120 -0
  72. package/dist/src/remediate.js +253 -0
  73. package/dist/src/remediation.d.ts +58 -0
  74. package/dist/src/remediation.js +425 -0
  75. package/dist/src/remediation_report.d.ts +40 -0
  76. package/dist/src/remediation_report.js +159 -0
  77. package/dist/src/sbom.d.ts +18 -1
  78. package/dist/src/sbom.js +14 -2
  79. package/dist/src/tools.d.ts +37 -13
  80. package/dist/src/tools.js +92 -13
  81. package/dist/src/updaters/maven_updater.d.ts +58 -0
  82. package/dist/src/updaters/maven_updater.js +345 -0
  83. package/dist/src/updaters/toml_updater.d.ts +62 -0
  84. package/dist/src/updaters/toml_updater.js +276 -0
  85. package/dist/src/workspace.d.ts +11 -1
  86. package/dist/src/workspace.js +3 -2
  87. package/package.json +31 -27
package/dist/src/index.js CHANGED
@@ -1,19 +1,26 @@
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';
7
+ import { getPackageVersion } from './package_version.js';
8
+ import { availableProviders, match } from './provider.js';
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
+ import { discoverUvWorkspaceMembers } from './providers/python_uv.js';
13
+ import { getCustom } from "./tools.js";
9
14
  import { discoverWorkspaceCrates, discoverWorkspacePackages, filterManifestPathsByDiscoveryIgnore, resolveWorkspaceDiscoveryIgnore, validatePackageJson, } from './workspace.js';
10
- import.meta.dirname;
11
- import * as url from 'url';
12
15
  export { parseImageRef } from "./oci_image/utils.js";
13
16
  export { ImageRef } from "./oci_image/images.js";
14
17
  export { getProjectLicense, findLicenseFilePath, identifyLicense, getLicenseDetails, licensesFromReport, normalizeLicensesResponse, runLicenseCheck, getCompatibility } from "./license/index.js";
18
+ export { extractRemediations } 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';
15
22
  export default { componentAnalysis, stackAnalysis, stackAnalysisBatch, imageAnalysis, validateToken, generateSbom };
16
- export { discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson, resolveWorkspaceDiscoveryIgnore, filterManifestPathsByDiscoveryIgnore, resolveContinueOnError, resolveBatchMetadata, };
23
+ export { discoverMavenModules, discoverGradleSubprojects, discoverGoWorkspaceModules, discoverUvWorkspaceMembers, discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson, resolveWorkspaceDiscoveryIgnore, filterManifestPathsByDiscoveryIgnore, resolveContinueOnError, resolveBatchMetadata, };
17
24
  /**
18
25
  * @typedef {{
19
26
  * TRUSTIFY_DA_CARGO_PATH?: string | undefined,
@@ -35,7 +42,9 @@ export { discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson
35
42
  * TRUSTIFY_DA_PYTHON_PATH?: string | undefined,
36
43
  * TRUSTIFY_DA_PYTHON_VIRTUAL_ENV?: string | undefined,
37
44
  * TRUSTIFY_DA_PYTHON3_PATH?: string | undefined,
38
- * TRUSTIFY_DA_RECOMMENDATIONS_ENABLED?: string | undefined,
45
+ * TRUSTIFY_DA_PROVIDERS?: string | undefined,
46
+ * TRUSTIFY_DA_RECOMMEND?: string | undefined,
47
+ * TRUSTIFY_DA_SOURCES?: string | undefined,
39
48
  * TRUSTIFY_DA_SKOPEO_CONFIG_PATH?: string | undefined,
40
49
  * TRUSTIFY_DA_SKOPEO_PATH?: string | undefined,
41
50
  * TRUSTIFY_DA_SYFT_CONFIG_PATH?: string | undefined,
@@ -43,6 +52,7 @@ export { discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson
43
52
  * TRUSTIFY_DA_YARN_PATH?: string | undefined,
44
53
  * TRUSTIFY_DA_WORKSPACE_DIR?: string | undefined,
45
54
  * TRUSTIFY_DA_LICENSE_CHECK?: string | undefined,
55
+ * licenseCheck?: boolean | undefined,
46
56
  * MATCH_MANIFEST_VERSIONS?: string | undefined,
47
57
  * TRUSTIFY_DA_SOURCE?: string | undefined,
48
58
  * TRUSTIFY_DA_TOKEN?: string | undefined,
@@ -64,7 +74,7 @@ export { discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson
64
74
  /**
65
75
  * @typedef {{
66
76
  * workspaceRoot: string,
67
- * ecosystem: 'javascript' | 'cargo' | 'unknown',
77
+ * ecosystem: 'javascript' | 'cargo' | 'pyproject' | 'unknown',
68
78
  * total: number,
69
79
  * successful: number,
70
80
  * failed: number,
@@ -87,29 +97,11 @@ function logOptionsAndEnvironmentsVariables(alongsideText, valueToBePrinted) {
87
97
  * @private
88
98
  */
89
99
  function readAndPrintVersionFromPackageJson() {
90
- let dirName;
91
- // new ESM way in nodeJS ( since node version 22 ) to bring module directory.
92
- dirName = import.meta.dirname;
93
- // old ESM way in nodeJS ( before node versions 22.00 to bring module directory)
94
- if (!dirName) {
95
- dirName = url.fileURLToPath(new URL('.', import.meta.url));
96
- }
97
- try {
98
- if (__dirname) {
99
- dirName = __dirname;
100
- }
101
- }
102
- catch (e) {
103
- console.log("__dirname is not defined, continue with fileUrlPath");
104
- }
105
- let packageJson = JSON.parse(fs.readFileSync(path.join(dirName, "..", "package.json")).toString());
106
- logOptionsAndEnvironmentsVariables("trustify-da-javascript-client analysis started, version: ", packageJson.version);
100
+ logOptionsAndEnvironmentsVariables("trustify-da-javascript-client analysis started, version: ", getPackageVersion());
107
101
  }
108
102
  /**
109
- * This function is used to determine the Trustify DA backend URL.
110
- * The TRUSTIFY_DA_BACKEND_URL is evaluated in the following order and selected when it finds it first:
111
- * 1. Environment Variable
112
- * 2. (key,value) from opts object
103
+ * Selects the Trustify DA backend URL from opts.TRUSTIFY_DA_BACKEND_URL, then environment
104
+ * variable TRUSTIFY_DA_BACKEND_URL. Options take precedence over environment variables.
113
105
  * If TRUSTIFY_DA_BACKEND_URL is not set, the function will throw an error.
114
106
  * @param {{TRUSTIFY_DA_DEBUG?: string | undefined; TRUSTIFY_DA_BACKEND_URL?: string | undefined}} [opts={}]
115
107
  * @return {string} - The selected Trustify DA backend URL
@@ -140,7 +132,7 @@ export function selectTrustifyDABackend(opts = {}) {
140
132
  * @param {string} manifest
141
133
  * @param {false} html
142
134
  * @param {Options} [opts={}]
143
- * @returns {Promise<import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>}
135
+ * @returns {Promise<import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport>}
144
136
  * @throws {Error}
145
137
  */
146
138
  /**
@@ -149,7 +141,7 @@ export function selectTrustifyDABackend(opts = {}) {
149
141
  * @param {string} manifest - path for the manifest
150
142
  * @param {boolean} [html=false] - true will return a html string, false will return AnalysisReport object.
151
143
  * @param {Options} [opts={}] - optional various options to pass along the application
152
- * @returns {Promise<string|import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>}
144
+ * @returns {Promise<string|import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport>}
153
145
  * @throws {Error} if manifest inaccessible, no matching provider, failed to get create content,
154
146
  * or backend request failed
155
147
  */
@@ -163,7 +155,7 @@ async function stackAnalysis(manifest, html = false, opts = {}) {
163
155
  * Get component analysis report for a manifest content.
164
156
  * @param {string} manifest - path to the manifest
165
157
  * @param {Options} [opts={}] - optional various options to pass along the application
166
- * @returns {Promise<import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>}
158
+ * @returns {Promise<import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport>}
167
159
  * @throws {Error} if no matching provider, failed to get create content, or backend request failed
168
160
  */
169
161
  async function componentAnalysis(manifest, opts = {}) {
@@ -171,7 +163,9 @@ async function componentAnalysis(manifest, opts = {}) {
171
163
  fs.accessSync(manifest, fs.constants.R_OK);
172
164
  opts["manifest-type"] = path.basename(manifest);
173
165
  let provider = match(manifest, availableProviders, opts); // throws error if no matching provider
174
- return await analysis.requestComponent(provider, manifest, theUrl, opts); // throws error request sending failed
166
+ const result = await analysis.requestComponent(provider, manifest, theUrl, opts); // throws error request sending failed
167
+ result.packageManager = provider.packageManagerName();
168
+ return result;
175
169
  }
176
170
  /**
177
171
  * @overload
@@ -186,7 +180,7 @@ async function componentAnalysis(manifest, opts = {}) {
186
180
  * @param {Array<string>} imageRefs
187
181
  * @param {false} html
188
182
  * @param {Options} [opts={}]
189
- * @returns {Promise<Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>>}
183
+ * @returns {Promise<Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport>>}
190
184
  * @throws {Error}
191
185
  */
192
186
  /**
@@ -195,7 +189,7 @@ async function componentAnalysis(manifest, opts = {}) {
195
189
  * @param {Array<string>} imageRefs - OCI image references
196
190
  * @param {boolean} [html=false] - true will return a html string, false will return AnalysisReport
197
191
  * @param {Options} [opts={}] - optional various options to pass along the application
198
- * @returns {Promise<string|Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>>}
192
+ * @returns {Promise<string|Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport>>}
199
193
  * @throws {Error} if manifest inaccessible, no matching provider, failed to get create content,
200
194
  * or backend request failed
201
195
  */
@@ -204,7 +198,8 @@ async function imageAnalysis(imageRefs, html = false, opts = {}) {
204
198
  return await analysis.requestImages(imageRefs, theUrl, html, opts);
205
199
  }
206
200
  /**
207
- * Max concurrent SBOM generations for batch workspace analysis. Env/opts override default 10.
201
+ * Max concurrent SBOM generations for batch workspace analysis. Options override environment;
202
+ * environment overrides the default of 10.
208
203
  * @param {Options} opts
209
204
  * @returns {number}
210
205
  * @private
@@ -279,17 +274,45 @@ async function generateOneSbom(manifestPath, workspaceOpts) {
279
274
  *
280
275
  * @param {string} root - Resolved workspace root
281
276
  * @param {Options} opts
282
- * @returns {Promise<{ ecosystem: 'javascript' | 'cargo' | 'unknown', manifestPaths: string[] }>}
277
+ * @returns {Promise<{ ecosystem: 'javascript' | 'cargo' | 'maven' | 'gradle' | 'gomodules' | 'pyproject' | 'unknown', manifestPaths: string[] }>}
283
278
  * @private
284
279
  */
285
280
  async function detectWorkspaceManifests(root, opts) {
286
281
  const cargoToml = path.join(root, 'Cargo.toml');
287
282
  const cargoLock = path.join(root, 'Cargo.lock');
288
283
  const packageJson = path.join(root, 'package.json');
284
+ const pomXml = path.join(root, 'pom.xml');
289
285
  if (fs.existsSync(cargoToml) && fs.existsSync(cargoLock)) {
290
286
  return { ecosystem: 'cargo', manifestPaths: await discoverWorkspaceCrates(root, opts) };
291
287
  }
292
- const hasJsLock = fs.existsSync(path.join(root, 'pnpm-lock.yaml'))
288
+ if (fs.existsSync(pomXml)) {
289
+ const manifestPaths = await discoverMavenModules(root, opts);
290
+ if (manifestPaths.length > 0) {
291
+ return { ecosystem: 'maven', manifestPaths };
292
+ }
293
+ }
294
+ const hasGradleSettings = fs.existsSync(path.join(root, 'settings.gradle'))
295
+ || fs.existsSync(path.join(root, 'settings.gradle.kts'));
296
+ if (hasGradleSettings) {
297
+ const manifestPaths = await discoverGradleSubprojects(root, opts);
298
+ if (manifestPaths.length > 0) {
299
+ return { ecosystem: 'gradle', manifestPaths };
300
+ }
301
+ }
302
+ if (fs.existsSync(path.join(root, 'go.work'))) {
303
+ const manifestPaths = await discoverGoWorkspaceModules(root, opts);
304
+ if (manifestPaths.length > 0) {
305
+ return { ecosystem: 'gomodules', manifestPaths };
306
+ }
307
+ }
308
+ if (fs.existsSync(path.join(root, 'pyproject.toml')) && fs.existsSync(path.join(root, 'uv.lock'))) {
309
+ const manifestPaths = await discoverUvWorkspaceMembers(root, opts);
310
+ if (manifestPaths.length > 0) {
311
+ return { ecosystem: 'pyproject', manifestPaths };
312
+ }
313
+ }
314
+ const hasJsLock = fs.existsSync(path.join(root, 'bun.lock'))
315
+ || fs.existsSync(path.join(root, 'pnpm-lock.yaml'))
293
316
  || fs.existsSync(path.join(root, 'yarn.lock'))
294
317
  || fs.existsSync(path.join(root, 'package-lock.json'));
295
318
  if (fs.existsSync(packageJson) && hasJsLock) {
@@ -398,16 +421,49 @@ function batchError(message, wantMetadata, metadata) {
398
421
  }
399
422
  return err;
400
423
  }
424
+ /**
425
+ * @overload
426
+ * @param {string} workspaceRoot
427
+ * @param {true} html
428
+ * @param {Options & { batchMetadata: true }} opts
429
+ * @returns {Promise<{ analysis: string, metadata: BatchAnalysisMetadata }>}
430
+ * @throws {Error}
431
+ */
432
+ /**
433
+ * @overload
434
+ * @param {string} workspaceRoot
435
+ * @param {true} html
436
+ * @param {Options & { batchMetadata?: false }} [opts={}]
437
+ * @returns {Promise<string>}
438
+ * @throws {Error}
439
+ */
440
+ /**
441
+ * @overload
442
+ * @param {string} workspaceRoot
443
+ * @param {false} html
444
+ * @param {Options & { batchMetadata: true }} opts
445
+ * @returns {Promise<{ analysis: Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport>, metadata: BatchAnalysisMetadata }>}
446
+ * @throws {Error}
447
+ */
448
+ /**
449
+ * @overload
450
+ * @param {string} workspaceRoot
451
+ * @param {false} html
452
+ * @param {Options & { batchMetadata?: false }} [opts={}]
453
+ * @returns {Promise<Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport>>}
454
+ * @throws {Error}
455
+ */
401
456
  /**
402
457
  * Get stack analysis for all workspace packages/crates (batch).
403
458
  * Detects ecosystem from workspace root: Cargo (Cargo.toml + Cargo.lock) or JS/TS (package.json + lock file).
404
459
  * SBOMs are generated in parallel (see `batchConcurrency`) unless `continueOnError: false` (fail-fast sequential).
405
460
  * With `opts.batchMetadata` / `TRUSTIFY_DA_BATCH_METADATA`, returns `{ analysis, metadata }` including validation and SBOM errors.
406
461
  *
462
+ * @overload
407
463
  * @param {string} workspaceRoot - Path to workspace root (containing lock file and workspace config)
408
464
  * @param {boolean} [html=false] - true returns HTML, false returns JSON report
409
465
  * @param {Options} [opts={}] - `batchConcurrency`, discovery ignores, `continueOnError` (default true), `batchMetadata` (default false)
410
- * @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 }>}
466
+ * @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 }>}
411
467
  * @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.
412
468
  */
413
469
  async function stackAnalysisBatch(workspaceRoot, html = false, opts = {}) {
@@ -434,7 +490,7 @@ async function stackAnalysisBatch(workspaceRoot, html = false, opts = {}) {
434
490
  }
435
491
  }
436
492
  if (manifestPaths.length === 0) {
437
- throw new Error(`No workspace manifests found at ${root}. Ensure Cargo.toml+Cargo.lock or package.json+lock file exist.`);
493
+ throw new Error(`No workspace manifests found at ${root}. Ensure a supported workspace root exists (Cargo.toml+Cargo.lock, pom.xml, build.gradle, go.work, pyproject.toml+uv.lock, or package.json+lock file).`);
438
494
  }
439
495
  const workspaceOpts = { ...opts, TRUSTIFY_DA_WORKSPACE_DIR: root };
440
496
  const concurrency = resolveBatchConcurrency(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,15 +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';
12
+ import Python_pip_pyproject from './providers/python_pip_pyproject.js';
10
13
  import Python_poetry from './providers/python_poetry.js';
11
14
  import Python_uv from './providers/python_uv.js';
12
15
  import rustCargoProvider from './providers/rust_cargo.js';
13
16
  /** @typedef {{ecosystem: string, contentType: string, content: string}} Provided */
14
- /** @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 */
15
18
  /**
16
19
  * MUST include all providers here.
17
20
  * @type {[Provider]}
@@ -20,6 +23,7 @@ export const availableProviders = [
20
23
  new Java_maven(),
21
24
  new Java_gradle_groovy(),
22
25
  new Java_gradle_kotlin(),
26
+ new Javascript_bun(),
23
27
  new Javascript_pnpm(),
24
28
  new Javascript_yarn(),
25
29
  new Javascript_npm(),
@@ -27,7 +31,9 @@ export const availableProviders = [
27
31
  pythonPipProvider,
28
32
  new Python_poetry(),
29
33
  new Python_uv(),
30
- rustCargoProvider
34
+ new Python_pip_pyproject(),
35
+ rustCargoProvider,
36
+ dockerfileProvider
31
37
  ];
32
38
  /**
33
39
  * Match a provider by manifest type only (no lock file check). Used for license reading.