@trustify-da/trustify-da-javascript-client 0.3.0-ea.2ea1d77 → 0.3.0-ea.329b3cf

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 (80) hide show
  1. package/README.md +75 -10
  2. package/dist/package.json +28 -24
  3. package/dist/src/analysis.d.ts +16 -7
  4. package/dist/src/analysis.js +36 -17
  5. package/dist/src/cli.js +109 -3
  6. package/dist/src/cyclone_dx_sbom.d.ts +14 -1
  7. package/dist/src/cyclone_dx_sbom.js +43 -8
  8. package/dist/src/index.d.ts +86 -11
  9. package/dist/src/index.js +97 -8
  10. package/dist/src/license/index.d.ts +3 -3
  11. package/dist/src/license/index.js +4 -1
  12. package/dist/src/license/license_utils.js +4 -1
  13. package/dist/src/license/licenses_api.d.ts +2 -2
  14. package/dist/src/oci_image/images.d.ts +1 -1
  15. package/dist/src/oci_image/images.js +15 -1
  16. package/dist/src/oci_image/utils.d.ts +5 -5
  17. package/dist/src/oci_image/utils.js +11 -2
  18. package/dist/src/provider.d.ts +4 -3
  19. package/dist/src/provider.js +12 -2
  20. package/dist/src/providers/base_java.d.ts +14 -12
  21. package/dist/src/providers/base_java.js +18 -44
  22. package/dist/src/providers/base_javascript.d.ts +36 -15
  23. package/dist/src/providers/base_javascript.js +100 -20
  24. package/dist/src/providers/base_pyproject.d.ts +158 -0
  25. package/dist/src/providers/base_pyproject.js +322 -0
  26. package/dist/src/providers/containerfile_parser.d.ts +5 -0
  27. package/dist/src/providers/containerfile_parser.js +20 -0
  28. package/dist/src/providers/golang_gomodules.d.ts +23 -13
  29. package/dist/src/providers/golang_gomodules.js +165 -119
  30. package/dist/src/providers/gomod_parser.d.ts +4 -0
  31. package/dist/src/providers/gomod_parser.js +16 -0
  32. package/dist/src/providers/java_gradle.d.ts +19 -0
  33. package/dist/src/providers/java_gradle.js +116 -2
  34. package/dist/src/providers/java_gradle_groovy.d.ts +1 -1
  35. package/dist/src/providers/java_gradle_kotlin.d.ts +1 -1
  36. package/dist/src/providers/java_maven.d.ts +10 -2
  37. package/dist/src/providers/java_maven.js +165 -1
  38. package/dist/src/providers/javascript_bun.d.ts +10 -0
  39. package/dist/src/providers/javascript_bun.js +100 -0
  40. package/dist/src/providers/javascript_npm.d.ts +6 -0
  41. package/dist/src/providers/javascript_npm.js +21 -0
  42. package/dist/src/providers/javascript_pnpm.js +6 -2
  43. package/dist/src/providers/manifest.d.ts +2 -0
  44. package/dist/src/providers/manifest.js +22 -4
  45. package/dist/src/providers/marker_evaluator.d.ts +14 -0
  46. package/dist/src/providers/marker_evaluator.js +191 -0
  47. package/dist/src/providers/oci_dockerfile.d.ts +51 -0
  48. package/dist/src/providers/oci_dockerfile.js +177 -0
  49. package/dist/src/providers/processors/yarn_berry_processor.d.ts +2 -2
  50. package/dist/src/providers/processors/yarn_berry_processor.js +88 -5
  51. package/dist/src/providers/processors/yarn_classic_processor.d.ts +2 -2
  52. package/dist/src/providers/python_controller.d.ts +5 -1
  53. package/dist/src/providers/python_controller.js +69 -8
  54. package/dist/src/providers/python_pip.d.ts +5 -0
  55. package/dist/src/providers/python_pip.js +6 -6
  56. package/dist/src/providers/python_pip_pyproject.d.ts +61 -0
  57. package/dist/src/providers/python_pip_pyproject.js +146 -0
  58. package/dist/src/providers/python_poetry.d.ts +98 -0
  59. package/dist/src/providers/python_poetry.js +286 -0
  60. package/dist/src/providers/python_uv.d.ts +46 -0
  61. package/dist/src/providers/python_uv.js +269 -0
  62. package/dist/src/providers/rust_cargo.d.ts +6 -2
  63. package/dist/src/providers/rust_cargo.js +31 -4
  64. package/dist/src/providers/tree-sitter-containerfile.wasm +0 -0
  65. package/dist/src/providers/tree-sitter-gomod.wasm +0 -0
  66. package/dist/src/remediation.d.ts +34 -0
  67. package/dist/src/remediation.js +321 -0
  68. package/dist/src/remediation_report.d.ts +40 -0
  69. package/dist/src/remediation_report.js +159 -0
  70. package/dist/src/sbom.d.ts +14 -1
  71. package/dist/src/sbom.js +13 -2
  72. package/dist/src/tools.d.ts +28 -2
  73. package/dist/src/tools.js +58 -0
  74. package/dist/src/updaters/maven_updater.d.ts +26 -0
  75. package/dist/src/updaters/maven_updater.js +322 -0
  76. package/dist/src/updaters/toml_updater.d.ts +33 -0
  77. package/dist/src/updaters/toml_updater.js +244 -0
  78. package/dist/src/workspace.d.ts +9 -0
  79. package/dist/src/workspace.js +1 -1
  80. package/package.json +29 -25
@@ -18,9 +18,14 @@ export default class CycloneDxSbom {
18
18
  * Adds a dependency relationship between two components in the SBOM
19
19
  * @param {PackageURL} sourceRef - The source component (parent)
20
20
  * @param {PackageURL} targetRef - The target component (dependency)
21
+ * @param {string} [scope] - Scope of the dependency
22
+ * @param {Array<{alg: string, content: string}>} [targetHashes] - Optional hashes for the target component
21
23
  * @return {CycloneDxSbom} The updated SBOM
22
24
  */
23
- addDependency(sourceRef: PackageURL, targetRef: PackageURL, scope: any): CycloneDxSbom;
25
+ addDependency(sourceRef: PackageURL, targetRef: PackageURL, scope?: string, targetHashes?: Array<{
26
+ alg: string;
27
+ content: string;
28
+ }>): CycloneDxSbom;
24
29
  /** @param {{}} opts - various options, settings and configuration of application.
25
30
  * @return String CycloneDx Sbom json object in a string format
26
31
  */
@@ -50,6 +55,7 @@ export default class CycloneDxSbom {
50
55
  version: any;
51
56
  scope: any;
52
57
  licenses?: any;
58
+ hashes?: any;
53
59
  };
54
60
  /**
55
61
  * This method gets an array of dependencies to be ignored, and remove all of them from CycloneDx Sbom
@@ -70,6 +76,13 @@ export default class CycloneDxSbom {
70
76
  * @return {boolean}
71
77
  */
72
78
  checkIfPackageInsideDependsOnList(component: any, name: string): boolean;
79
+ /**
80
+ * Checks if any entry in the dependsOn list of sourceRef starts with the given purl prefix.
81
+ * @param {PackageURL} sourceRef - The source component
82
+ * @param {string} purlPrefix - The purl prefix to match (e.g. "pkg:npm/minimist@")
83
+ * @return {boolean}
84
+ */
85
+ checkDependsOnByPurlPrefix(sourceRef: PackageURL, purlPrefix: string): boolean;
73
86
  /** Removes the root component from the sbom
74
87
  */
75
88
  removeRootComponent(): void;
@@ -6,10 +6,11 @@ import { PackageURL } from "packageurl-js";
6
6
  * @param type type of package - application or library
7
7
  * @param scope scope of the component - runtime or compile
8
8
  * @param licenses optional license string or array of licenses for the component
9
- * @return {{"bom-ref": string, name, purl: string, type, version, scope, licenses?}}
9
+ * @param hashes optional array of hash objects for the component, e.g. [{alg: "SHA-256", content: "..."}]
10
+ * @return {{"bom-ref": string, name, purl: string, type, version, scope, licenses?, hashes?}}
10
11
  * @private
11
12
  */
12
- function getComponent(component, type, scope, licenses) {
13
+ function getComponent(component, type, scope, licenses, hashes) {
13
14
  let componentObject;
14
15
  if (component instanceof PackageURL) {
15
16
  if (component.namespace) {
@@ -40,12 +41,24 @@ function getComponent(component, type, scope, licenses) {
40
41
  // Add licenses if provided (CycloneDX format). Callers must provide valid SPDX identifiers.
41
42
  if (licenses) {
42
43
  const licenseArray = Array.isArray(licenses) ? licenses : [licenses];
43
- componentObject.licenses = licenseArray.map(lic => {
44
+ const validLicenses = licenseArray
45
+ .map(lic => {
44
46
  if (typeof lic === 'string') {
45
47
  return { license: { id: lic } };
46
48
  }
47
- return lic;
48
- });
49
+ if (typeof lic === 'object' && lic !== null && ('license' in lic || 'expression' in lic)) {
50
+ return lic;
51
+ }
52
+ return null;
53
+ })
54
+ .filter(Boolean);
55
+ if (validLicenses.length > 0) {
56
+ componentObject.licenses = validLicenses;
57
+ }
58
+ }
59
+ // Add hashes if provided (CycloneDX 1.4 format).
60
+ if (hashes && hashes.length > 0) {
61
+ componentObject.hashes = hashes;
49
62
  }
50
63
  return componentObject;
51
64
  }
@@ -86,16 +99,24 @@ export default class CycloneDxSbom {
86
99
  * Adds a dependency relationship between two components in the SBOM
87
100
  * @param {PackageURL} sourceRef - The source component (parent)
88
101
  * @param {PackageURL} targetRef - The target component (dependency)
102
+ * @param {string} [scope] - Scope of the dependency
103
+ * @param {Array<{alg: string, content: string}>} [targetHashes] - Optional hashes for the target component
89
104
  * @return {CycloneDxSbom} The updated SBOM
90
105
  */
91
- addDependency(sourceRef, targetRef, scope) {
106
+ addDependency(sourceRef, targetRef, scope, targetHashes) {
92
107
  const sourcePurl = sourceRef.toString();
93
108
  const targetPurl = targetRef.toString();
94
109
  // Ensure both components exist in the components list
95
110
  [sourceRef, targetRef].forEach((ref, index) => {
96
111
  const purl = index === 0 ? sourcePurl : targetPurl;
97
- if (this.getComponentIndex(purl) < 0) {
98
- this.components.push(getComponent(ref, "library", scope));
112
+ const existingIndex = this.getComponentIndex(purl);
113
+ if (existingIndex < 0) {
114
+ const hashes = index === 1 ? targetHashes : undefined;
115
+ this.components.push(getComponent(ref, "library", scope, undefined, hashes));
116
+ }
117
+ else if (index === 1 && targetHashes && targetHashes.length > 0 && !this.components[existingIndex].hashes) {
118
+ // Update hashes if the component was first seen without them (e.g. as a source)
119
+ this.components[existingIndex].hashes = targetHashes;
99
120
  }
100
121
  });
101
122
  // Ensure source dependency exists
@@ -242,6 +263,20 @@ export default class CycloneDxSbom {
242
263
  return false;
243
264
  }
244
265
  }
266
+ /**
267
+ * Checks if any entry in the dependsOn list of sourceRef starts with the given purl prefix.
268
+ * @param {PackageURL} sourceRef - The source component
269
+ * @param {string} purlPrefix - The purl prefix to match (e.g. "pkg:npm/minimist@")
270
+ * @return {boolean}
271
+ */
272
+ checkDependsOnByPurlPrefix(sourceRef, purlPrefix) {
273
+ const sourcePurl = sourceRef.toString();
274
+ const depIndex = this.getDependencyIndex(sourcePurl);
275
+ if (depIndex < 0) {
276
+ return false;
277
+ }
278
+ return this.dependencies[depIndex].dependsOn.some(dep => dep.startsWith(purlPrefix));
279
+ }
245
280
  /** Removes the root component from the sbom
246
281
  */
247
282
  removeRootComponent() {
@@ -13,14 +13,25 @@ export function selectTrustifyDABackend(opts?: {
13
13
  TRUSTIFY_DA_DEBUG?: string | undefined;
14
14
  TRUSTIFY_DA_BACKEND_URL?: string | undefined;
15
15
  }): string;
16
+ /**
17
+ * Generate a CycloneDX SBOM from a manifest file. No backend HTTP request is made.
18
+ *
19
+ * @param {string} manifestPath - path to the manifest file (e.g. pom.xml, package.json)
20
+ * @param {Options} [opts={}] - optional options (e.g. workspace dir, tool paths)
21
+ * @returns {Promise<object>} parsed CycloneDX SBOM JSON object
22
+ * @throws {Error} if the manifest is unsupported or SBOM generation fails
23
+ */
24
+ export function generateSbom(manifestPath: string, opts?: Options): Promise<object>;
16
25
  export { parseImageRef } from "./oci_image/utils.js";
17
26
  export { ImageRef } from "./oci_image/images.js";
27
+ export { extractRemediations } from "./remediation.js";
18
28
  declare namespace _default {
19
29
  export { componentAnalysis };
20
30
  export { stackAnalysis };
21
31
  export { stackAnalysisBatch };
22
32
  export { imageAnalysis };
23
33
  export { validateToken };
34
+ export { generateSbom };
24
35
  }
25
36
  export default _default;
26
37
  export type Options = {
@@ -43,7 +54,9 @@ export type Options = {
43
54
  TRUSTIFY_DA_PYTHON_PATH?: string | undefined;
44
55
  TRUSTIFY_DA_PYTHON_VIRTUAL_ENV?: string | undefined;
45
56
  TRUSTIFY_DA_PYTHON3_PATH?: string | undefined;
46
- TRUSTIFY_DA_RECOMMENDATIONS_ENABLED?: string | undefined;
57
+ TRUSTIFY_DA_PROVIDERS?: string | undefined;
58
+ TRUSTIFY_DA_RECOMMEND?: string | undefined;
59
+ TRUSTIFY_DA_SOURCES?: string | undefined;
47
60
  TRUSTIFY_DA_SKOPEO_CONFIG_PATH?: string | undefined;
48
61
  TRUSTIFY_DA_SKOPEO_PATH?: string | undefined;
49
62
  TRUSTIFY_DA_SYFT_CONFIG_PATH?: string | undefined;
@@ -64,11 +77,13 @@ export type Options = {
64
77
  TRUSTIFY_DA_CONTINUE_ON_ERROR?: string | undefined;
65
78
  batchMetadata?: boolean | undefined;
66
79
  TRUSTIFY_DA_BATCH_METADATA?: string | undefined;
80
+ TRUSTIFY_DA_UV_PATH?: string | undefined;
81
+ TRUSTIFY_DA_POETRY_PATH?: string | undefined;
67
82
  [key: string]: string | number | boolean | string[] | undefined;
68
83
  };
69
84
  export type BatchAnalysisMetadata = {
70
85
  workspaceRoot: string;
71
- ecosystem: "javascript" | "cargo" | "unknown";
86
+ ecosystem: "javascript" | "cargo" | "pyproject" | "unknown";
72
87
  total: number;
73
88
  successful: number;
74
89
  failed: number;
@@ -94,7 +109,7 @@ export type SbomResult = {
94
109
  * @returns {Promise<import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>}
95
110
  * @throws {Error} if no matching provider, failed to get create content, or backend request failed
96
111
  */
97
- declare function componentAnalysis(manifest: string, opts?: Options): Promise<import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport>;
112
+ declare function componentAnalysis(manifest: string, opts?: Options): Promise<any>;
98
113
  /**
99
114
  * @overload
100
115
  * @param {string} manifest
@@ -112,7 +127,7 @@ declare function stackAnalysis(manifest: string, html: true, opts?: Options | un
112
127
  * @returns {Promise<import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>}
113
128
  * @throws {Error}
114
129
  */
115
- declare function stackAnalysis(manifest: string, html: false, opts?: Options | undefined): Promise<import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport>;
130
+ declare function stackAnalysis(manifest: string, html: false, opts?: Options | undefined): Promise<any>;
116
131
  /**
117
132
  * Get stack analysis report for a manifest file.
118
133
  * @overload
@@ -123,24 +138,79 @@ declare function stackAnalysis(manifest: string, html: false, opts?: Options | u
123
138
  * @throws {Error} if manifest inaccessible, no matching provider, failed to get create content,
124
139
  * or backend request failed
125
140
  */
126
- declare function stackAnalysis(manifest: string, html?: boolean | undefined, opts?: Options | undefined): Promise<string | import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport>;
141
+ declare function stackAnalysis(manifest: string, html?: boolean | undefined, opts?: Options | undefined): Promise<string | any>;
142
+ /**
143
+ * @overload
144
+ * @param {string} workspaceRoot
145
+ * @param {true} html
146
+ * @param {Options & { batchMetadata: true }} opts
147
+ * @returns {Promise<{ analysis: string, metadata: BatchAnalysisMetadata }>}
148
+ * @throws {Error}
149
+ */
150
+ declare function stackAnalysisBatch(workspaceRoot: string, html: true, opts: Options & {
151
+ batchMetadata: true;
152
+ }): Promise<{
153
+ analysis: string;
154
+ metadata: BatchAnalysisMetadata;
155
+ }>;
156
+ /**
157
+ * @overload
158
+ * @param {string} workspaceRoot
159
+ * @param {true} html
160
+ * @param {Options & { batchMetadata?: false }} [opts={}]
161
+ * @returns {Promise<string>}
162
+ * @throws {Error}
163
+ */
164
+ declare function stackAnalysisBatch(workspaceRoot: string, html: true, opts?: (Options & {
165
+ batchMetadata?: false;
166
+ }) | undefined): Promise<string>;
167
+ /**
168
+ * @overload
169
+ * @param {string} workspaceRoot
170
+ * @param {false} html
171
+ * @param {Options & { batchMetadata: true }} opts
172
+ * @returns {Promise<{ analysis: Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>, metadata: BatchAnalysisMetadata }>}
173
+ * @throws {Error}
174
+ */
175
+ declare function stackAnalysisBatch(workspaceRoot: string, html: false, opts: Options & {
176
+ batchMetadata: true;
177
+ }): Promise<{
178
+ analysis: {
179
+ [x: string]: any;
180
+ };
181
+ metadata: BatchAnalysisMetadata;
182
+ }>;
183
+ /**
184
+ * @overload
185
+ * @param {string} workspaceRoot
186
+ * @param {false} html
187
+ * @param {Options & { batchMetadata?: false }} [opts={}]
188
+ * @returns {Promise<Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>>}
189
+ * @throws {Error}
190
+ */
191
+ declare function stackAnalysisBatch(workspaceRoot: string, html: false, opts?: (Options & {
192
+ batchMetadata?: false;
193
+ }) | undefined): Promise<{
194
+ [x: string]: any;
195
+ }>;
127
196
  /**
128
197
  * Get stack analysis for all workspace packages/crates (batch).
129
198
  * Detects ecosystem from workspace root: Cargo (Cargo.toml + Cargo.lock) or JS/TS (package.json + lock file).
130
199
  * SBOMs are generated in parallel (see `batchConcurrency`) unless `continueOnError: false` (fail-fast sequential).
131
200
  * With `opts.batchMetadata` / `TRUSTIFY_DA_BATCH_METADATA`, returns `{ analysis, metadata }` including validation and SBOM errors.
132
201
  *
202
+ * @overload
133
203
  * @param {string} workspaceRoot - Path to workspace root (containing lock file and workspace config)
134
204
  * @param {boolean} [html=false] - true returns HTML, false returns JSON report
135
205
  * @param {Options} [opts={}] - `batchConcurrency`, discovery ignores, `continueOnError` (default true), `batchMetadata` (default false)
136
206
  * @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 }>}
137
207
  * @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.
138
208
  */
139
- declare function stackAnalysisBatch(workspaceRoot: string, html?: boolean, opts?: Options): Promise<string | {
140
- [x: string]: import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport;
209
+ declare function stackAnalysisBatch(workspaceRoot: string, html?: boolean | undefined, opts?: Options | undefined): Promise<string | {
210
+ [x: string]: any;
141
211
  } | {
142
212
  analysis: string | {
143
- [x: string]: import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport;
213
+ [x: string]: any;
144
214
  };
145
215
  metadata: BatchAnalysisMetadata;
146
216
  }>;
@@ -162,7 +232,7 @@ declare function imageAnalysis(imageRefs: Array<string>, html: true, opts?: Opti
162
232
  * @throws {Error}
163
233
  */
164
234
  declare function imageAnalysis(imageRefs: Array<string>, html: false, opts?: Options | undefined): Promise<{
165
- [x: string]: import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport;
235
+ [x: string]: any;
166
236
  }>;
167
237
  /**
168
238
  * Get image analysis report for a set of OCI image references.
@@ -175,7 +245,7 @@ declare function imageAnalysis(imageRefs: Array<string>, html: false, opts?: Opt
175
245
  * or backend request failed
176
246
  */
177
247
  declare function imageAnalysis(imageRefs: Array<string>, html?: boolean | undefined, opts?: Options | undefined): Promise<string | {
178
- [x: string]: import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport;
248
+ [x: string]: any;
179
249
  }>;
180
250
  /**
181
251
  * Validates the Exhort token.
@@ -184,6 +254,10 @@ declare function imageAnalysis(imageRefs: Array<string>, html?: boolean | undefi
184
254
  * @throws {Error} if the backend request failed.
185
255
  */
186
256
  declare function validateToken(opts?: Options): Promise<object>;
257
+ import { discoverMavenModules } from './providers/java_maven.js';
258
+ import { discoverGradleSubprojects } from './providers/java_gradle.js';
259
+ import { discoverGoWorkspaceModules } from './providers/golang_gomodules.js';
260
+ import { discoverUvWorkspaceMembers } from './providers/python_uv.js';
187
261
  import { discoverWorkspacePackages } from './workspace.js';
188
262
  import { discoverWorkspaceCrates } from './workspace.js';
189
263
  import { validatePackageJson } from './workspace.js';
@@ -191,5 +265,6 @@ import { resolveWorkspaceDiscoveryIgnore } from './workspace.js';
191
265
  import { filterManifestPathsByDiscoveryIgnore } from './workspace.js';
192
266
  import { resolveContinueOnError } from './batch_opts.js';
193
267
  import { resolveBatchMetadata } from './batch_opts.js';
194
- export { discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson, resolveWorkspaceDiscoveryIgnore, filterManifestPathsByDiscoveryIgnore, resolveContinueOnError, resolveBatchMetadata };
268
+ export { discoverMavenModules, discoverGradleSubprojects, discoverGoWorkspaceModules, discoverUvWorkspaceMembers, discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson, resolveWorkspaceDiscoveryIgnore, filterManifestPathsByDiscoveryIgnore, resolveContinueOnError, resolveBatchMetadata };
195
269
  export { getProjectLicense, findLicenseFilePath, identifyLicense, getLicenseDetails, licensesFromReport, normalizeLicensesResponse, runLicenseCheck, getCompatibility } from "./license/index.js";
270
+ export { generateReport, generateDeduplicationKey } from "./remediation_report.js";
package/dist/src/index.js CHANGED
@@ -6,14 +6,20 @@ import analysis from './analysis.js';
6
6
  import fs from 'node:fs';
7
7
  import { getCustom } from "./tools.js";
8
8
  import { resolveBatchMetadata, resolveContinueOnError } from './batch_opts.js';
9
+ import { discoverMavenModules } from './providers/java_maven.js';
10
+ import { discoverGradleSubprojects } from './providers/java_gradle.js';
11
+ import { discoverGoWorkspaceModules } from './providers/golang_gomodules.js';
12
+ import { discoverUvWorkspaceMembers } from './providers/python_uv.js';
9
13
  import { discoverWorkspaceCrates, discoverWorkspacePackages, filterManifestPathsByDiscoveryIgnore, resolveWorkspaceDiscoveryIgnore, validatePackageJson, } from './workspace.js';
10
14
  import.meta.dirname;
11
15
  import * as url from 'url';
12
16
  export { parseImageRef } from "./oci_image/utils.js";
13
17
  export { ImageRef } from "./oci_image/images.js";
14
18
  export { getProjectLicense, findLicenseFilePath, identifyLicense, getLicenseDetails, licensesFromReport, normalizeLicensesResponse, runLicenseCheck, getCompatibility } from "./license/index.js";
15
- export default { componentAnalysis, stackAnalysis, stackAnalysisBatch, imageAnalysis, validateToken };
16
- export { discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson, resolveWorkspaceDiscoveryIgnore, filterManifestPathsByDiscoveryIgnore, resolveContinueOnError, resolveBatchMetadata, };
19
+ export { extractRemediations } from "./remediation.js";
20
+ export { generateReport, generateDeduplicationKey } from './remediation_report.js';
21
+ export default { componentAnalysis, stackAnalysis, stackAnalysisBatch, imageAnalysis, validateToken, generateSbom };
22
+ export { discoverMavenModules, discoverGradleSubprojects, discoverGoWorkspaceModules, discoverUvWorkspaceMembers, discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson, resolveWorkspaceDiscoveryIgnore, filterManifestPathsByDiscoveryIgnore, resolveContinueOnError, resolveBatchMetadata, };
17
23
  /**
18
24
  * @typedef {{
19
25
  * TRUSTIFY_DA_CARGO_PATH?: string | undefined,
@@ -35,7 +41,9 @@ export { discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson
35
41
  * TRUSTIFY_DA_PYTHON_PATH?: string | undefined,
36
42
  * TRUSTIFY_DA_PYTHON_VIRTUAL_ENV?: string | undefined,
37
43
  * TRUSTIFY_DA_PYTHON3_PATH?: string | undefined,
38
- * TRUSTIFY_DA_RECOMMENDATIONS_ENABLED?: string | undefined,
44
+ * TRUSTIFY_DA_PROVIDERS?: string | undefined,
45
+ * TRUSTIFY_DA_RECOMMEND?: string | undefined,
46
+ * TRUSTIFY_DA_SOURCES?: string | undefined,
39
47
  * TRUSTIFY_DA_SKOPEO_CONFIG_PATH?: string | undefined,
40
48
  * TRUSTIFY_DA_SKOPEO_PATH?: string | undefined,
41
49
  * TRUSTIFY_DA_SYFT_CONFIG_PATH?: string | undefined,
@@ -56,13 +64,15 @@ export { discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson
56
64
  * TRUSTIFY_DA_CONTINUE_ON_ERROR?: string | undefined,
57
65
  * batchMetadata?: boolean | undefined,
58
66
  * TRUSTIFY_DA_BATCH_METADATA?: string | undefined,
67
+ * TRUSTIFY_DA_UV_PATH?: string | undefined,
68
+ * TRUSTIFY_DA_POETRY_PATH?: string | undefined,
59
69
  * [key: string]: string | number | boolean | string[] | undefined,
60
70
  * }} Options
61
71
  */
62
72
  /**
63
73
  * @typedef {{
64
74
  * workspaceRoot: string,
65
- * ecosystem: 'javascript' | 'cargo' | 'unknown',
75
+ * ecosystem: 'javascript' | 'cargo' | 'pyproject' | 'unknown',
66
76
  * total: number,
67
77
  * successful: number,
68
78
  * failed: number,
@@ -169,7 +179,9 @@ async function componentAnalysis(manifest, opts = {}) {
169
179
  fs.accessSync(manifest, fs.constants.R_OK);
170
180
  opts["manifest-type"] = path.basename(manifest);
171
181
  let provider = match(manifest, availableProviders, opts); // throws error if no matching provider
172
- return await analysis.requestComponent(provider, manifest, theUrl, opts); // throws error request sending failed
182
+ const result = await analysis.requestComponent(provider, manifest, theUrl, opts); // throws error request sending failed
183
+ result.packageManager = provider.packageManagerName();
184
+ return result;
173
185
  }
174
186
  /**
175
187
  * @overload
@@ -235,6 +247,22 @@ function buildBatchAnalysisMetadata(root, ecosystem, totalSbomAttempts, successf
235
247
  errors: [...errors],
236
248
  };
237
249
  }
250
+ /**
251
+ * Generate a CycloneDX SBOM from a manifest file. No backend HTTP request is made.
252
+ *
253
+ * @param {string} manifestPath - path to the manifest file (e.g. pom.xml, package.json)
254
+ * @param {Options} [opts={}] - optional options (e.g. workspace dir, tool paths)
255
+ * @returns {Promise<object>} parsed CycloneDX SBOM JSON object
256
+ * @throws {Error} if the manifest is unsupported or SBOM generation fails
257
+ */
258
+ export async function generateSbom(manifestPath, opts = {}) {
259
+ fs.accessSync(manifestPath, fs.constants.R_OK);
260
+ const result = await generateOneSbom(manifestPath, opts);
261
+ if (!result.ok) {
262
+ throw new Error(`Failed to generate SBOM for ${result.manifestPath}: ${result.reason}`);
263
+ }
264
+ return result.sbom;
265
+ }
238
266
  /**
239
267
  * @typedef {{ ok: true, purl: string, sbom: object } | { ok: false, manifestPath: string, reason: string }} SbomResult
240
268
  */
@@ -261,17 +289,45 @@ async function generateOneSbom(manifestPath, workspaceOpts) {
261
289
  *
262
290
  * @param {string} root - Resolved workspace root
263
291
  * @param {Options} opts
264
- * @returns {Promise<{ ecosystem: 'javascript' | 'cargo' | 'unknown', manifestPaths: string[] }>}
292
+ * @returns {Promise<{ ecosystem: 'javascript' | 'cargo' | 'maven' | 'gradle' | 'gomodules' | 'pyproject' | 'unknown', manifestPaths: string[] }>}
265
293
  * @private
266
294
  */
267
295
  async function detectWorkspaceManifests(root, opts) {
268
296
  const cargoToml = path.join(root, 'Cargo.toml');
269
297
  const cargoLock = path.join(root, 'Cargo.lock');
270
298
  const packageJson = path.join(root, 'package.json');
299
+ const pomXml = path.join(root, 'pom.xml');
271
300
  if (fs.existsSync(cargoToml) && fs.existsSync(cargoLock)) {
272
301
  return { ecosystem: 'cargo', manifestPaths: await discoverWorkspaceCrates(root, opts) };
273
302
  }
274
- const hasJsLock = fs.existsSync(path.join(root, 'pnpm-lock.yaml'))
303
+ if (fs.existsSync(pomXml)) {
304
+ const manifestPaths = await discoverMavenModules(root, opts);
305
+ if (manifestPaths.length > 0) {
306
+ return { ecosystem: 'maven', manifestPaths };
307
+ }
308
+ }
309
+ const hasGradleSettings = fs.existsSync(path.join(root, 'settings.gradle'))
310
+ || fs.existsSync(path.join(root, 'settings.gradle.kts'));
311
+ if (hasGradleSettings) {
312
+ const manifestPaths = await discoverGradleSubprojects(root, opts);
313
+ if (manifestPaths.length > 0) {
314
+ return { ecosystem: 'gradle', manifestPaths };
315
+ }
316
+ }
317
+ if (fs.existsSync(path.join(root, 'go.work'))) {
318
+ const manifestPaths = await discoverGoWorkspaceModules(root, opts);
319
+ if (manifestPaths.length > 0) {
320
+ return { ecosystem: 'gomodules', manifestPaths };
321
+ }
322
+ }
323
+ if (fs.existsSync(path.join(root, 'pyproject.toml')) && fs.existsSync(path.join(root, 'uv.lock'))) {
324
+ const manifestPaths = await discoverUvWorkspaceMembers(root, opts);
325
+ if (manifestPaths.length > 0) {
326
+ return { ecosystem: 'pyproject', manifestPaths };
327
+ }
328
+ }
329
+ const hasJsLock = fs.existsSync(path.join(root, 'bun.lock'))
330
+ || fs.existsSync(path.join(root, 'pnpm-lock.yaml'))
275
331
  || fs.existsSync(path.join(root, 'yarn.lock'))
276
332
  || fs.existsSync(path.join(root, 'package-lock.json'));
277
333
  if (fs.existsSync(packageJson) && hasJsLock) {
@@ -380,12 +436,45 @@ function batchError(message, wantMetadata, metadata) {
380
436
  }
381
437
  return err;
382
438
  }
439
+ /**
440
+ * @overload
441
+ * @param {string} workspaceRoot
442
+ * @param {true} html
443
+ * @param {Options & { batchMetadata: true }} opts
444
+ * @returns {Promise<{ analysis: string, metadata: BatchAnalysisMetadata }>}
445
+ * @throws {Error}
446
+ */
447
+ /**
448
+ * @overload
449
+ * @param {string} workspaceRoot
450
+ * @param {true} html
451
+ * @param {Options & { batchMetadata?: false }} [opts={}]
452
+ * @returns {Promise<string>}
453
+ * @throws {Error}
454
+ */
455
+ /**
456
+ * @overload
457
+ * @param {string} workspaceRoot
458
+ * @param {false} html
459
+ * @param {Options & { batchMetadata: true }} opts
460
+ * @returns {Promise<{ analysis: Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>, metadata: BatchAnalysisMetadata }>}
461
+ * @throws {Error}
462
+ */
463
+ /**
464
+ * @overload
465
+ * @param {string} workspaceRoot
466
+ * @param {false} html
467
+ * @param {Options & { batchMetadata?: false }} [opts={}]
468
+ * @returns {Promise<Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>>}
469
+ * @throws {Error}
470
+ */
383
471
  /**
384
472
  * Get stack analysis for all workspace packages/crates (batch).
385
473
  * Detects ecosystem from workspace root: Cargo (Cargo.toml + Cargo.lock) or JS/TS (package.json + lock file).
386
474
  * SBOMs are generated in parallel (see `batchConcurrency`) unless `continueOnError: false` (fail-fast sequential).
387
475
  * With `opts.batchMetadata` / `TRUSTIFY_DA_BATCH_METADATA`, returns `{ analysis, metadata }` including validation and SBOM errors.
388
476
  *
477
+ * @overload
389
478
  * @param {string} workspaceRoot - Path to workspace root (containing lock file and workspace config)
390
479
  * @param {boolean} [html=false] - true returns HTML, false returns JSON report
391
480
  * @param {Options} [opts={}] - `batchConcurrency`, discovery ignores, `continueOnError` (default true), `batchMetadata` (default false)
@@ -416,7 +505,7 @@ async function stackAnalysisBatch(workspaceRoot, html = false, opts = {}) {
416
505
  }
417
506
  }
418
507
  if (manifestPaths.length === 0) {
419
- throw new Error(`No workspace manifests found at ${root}. Ensure Cargo.toml+Cargo.lock or package.json+lock file exist.`);
508
+ 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).`);
420
509
  }
421
510
  const workspaceOpts = { ...opts, TRUSTIFY_DA_WORKSPACE_DIR: root };
422
511
  const concurrency = resolveBatchConcurrency(opts);
@@ -9,10 +9,10 @@
9
9
  * @param {import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').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?: any): 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<{
@@ -85,11 +85,14 @@ export async function runLicenseCheck(sbomContent, manifestPath, url, opts = {},
85
85
  continue;
86
86
  const status = getCompatibility(projectCategory, entry.category);
87
87
  if (status === 'incompatible') {
88
+ const reason = entry.category?.toUpperCase() === 'UNKNOWN'
89
+ ? 'License not recognized as a standard SPDX identifier. Manual review recommended to verify compatibility.'
90
+ : 'Dependency license(s) are incompatible with the project license.';
88
91
  incompatibleDependencies.push({
89
92
  purl,
90
93
  licenses: entry.licenses,
91
94
  category: entry.category,
92
- reason: 'Dependency license(s) are incompatible with the project license.'
95
+ reason
93
96
  });
94
97
  }
95
98
  }
@@ -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 } }.
@@ -28,7 +28,7 @@ export function normalizeLicensesResponse(data: unknown, purls?: string[]): Map<
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: any, purls?: string[]): Map<string, {
32
32
  licenses: string[];
33
33
  category?: string;
34
34
  }>;
@@ -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';