@trustify-da/trustify-da-javascript-client 0.3.0-ea.e12bc82 → 0.3.0-ea.e348975

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 (92) hide show
  1. package/README.md +193 -13
  2. package/dist/package.json +43 -27
  3. package/dist/src/analysis.d.ts +28 -5
  4. package/dist/src/analysis.js +99 -89
  5. package/dist/src/batch_opts.d.ts +24 -0
  6. package/dist/src/batch_opts.js +35 -0
  7. package/dist/src/cli.js +346 -9
  8. package/dist/src/cyclone_dx_sbom.d.ts +17 -3
  9. package/dist/src/cyclone_dx_sbom.js +56 -8
  10. package/dist/src/index.d.ts +202 -12
  11. package/dist/src/index.js +361 -9
  12. package/dist/src/license/index.d.ts +28 -0
  13. package/dist/src/license/index.js +103 -0
  14. package/dist/src/license/license_utils.d.ts +40 -0
  15. package/dist/src/license/license_utils.js +137 -0
  16. package/dist/src/license/licenses_api.d.ts +34 -0
  17. package/dist/src/license/licenses_api.js +98 -0
  18. package/dist/src/license/project_license.d.ts +20 -0
  19. package/dist/src/license/project_license.js +62 -0
  20. package/dist/src/oci_image/images.d.ts +4 -5
  21. package/dist/src/oci_image/images.js +15 -1
  22. package/dist/src/oci_image/utils.d.ts +7 -7
  23. package/dist/src/oci_image/utils.js +11 -2
  24. package/dist/src/provider.d.ts +18 -5
  25. package/dist/src/provider.js +33 -5
  26. package/dist/src/providers/base_java.d.ts +15 -15
  27. package/dist/src/providers/base_java.js +18 -44
  28. package/dist/src/providers/base_javascript.d.ts +45 -12
  29. package/dist/src/providers/base_javascript.js +138 -24
  30. package/dist/src/providers/base_pyproject.d.ts +158 -0
  31. package/dist/src/providers/base_pyproject.js +322 -0
  32. package/dist/src/providers/containerfile_parser.d.ts +5 -0
  33. package/dist/src/providers/containerfile_parser.js +20 -0
  34. package/dist/src/providers/golang_gomodules.d.ts +30 -13
  35. package/dist/src/providers/golang_gomodules.js +176 -121
  36. package/dist/src/providers/gomod_parser.d.ts +4 -0
  37. package/dist/src/providers/gomod_parser.js +16 -0
  38. package/dist/src/providers/java_gradle.d.ts +28 -3
  39. package/dist/src/providers/java_gradle.js +128 -4
  40. package/dist/src/providers/java_gradle_groovy.d.ts +1 -1
  41. package/dist/src/providers/java_gradle_kotlin.d.ts +1 -1
  42. package/dist/src/providers/java_maven.d.ts +20 -5
  43. package/dist/src/providers/java_maven.js +198 -6
  44. package/dist/src/providers/javascript_bun.d.ts +10 -0
  45. package/dist/src/providers/javascript_bun.js +100 -0
  46. package/dist/src/providers/javascript_npm.d.ts +6 -0
  47. package/dist/src/providers/javascript_npm.js +21 -0
  48. package/dist/src/providers/javascript_pnpm.d.ts +1 -1
  49. package/dist/src/providers/javascript_pnpm.js +8 -4
  50. package/dist/src/providers/manifest.d.ts +2 -0
  51. package/dist/src/providers/manifest.js +22 -4
  52. package/dist/src/providers/marker_evaluator.d.ts +14 -0
  53. package/dist/src/providers/marker_evaluator.js +191 -0
  54. package/dist/src/providers/oci_dockerfile.d.ts +51 -0
  55. package/dist/src/providers/oci_dockerfile.js +177 -0
  56. package/dist/src/providers/processors/yarn_berry_processor.d.ts +2 -2
  57. package/dist/src/providers/processors/yarn_berry_processor.js +88 -5
  58. package/dist/src/providers/processors/yarn_classic_processor.d.ts +2 -2
  59. package/dist/src/providers/python_controller.d.ts +10 -3
  60. package/dist/src/providers/python_controller.js +122 -63
  61. package/dist/src/providers/python_pip.d.ts +16 -4
  62. package/dist/src/providers/python_pip.js +51 -58
  63. package/dist/src/providers/python_pip_pyproject.d.ts +61 -0
  64. package/dist/src/providers/python_pip_pyproject.js +146 -0
  65. package/dist/src/providers/python_poetry.d.ts +98 -0
  66. package/dist/src/providers/python_poetry.js +286 -0
  67. package/dist/src/providers/python_uv.d.ts +46 -0
  68. package/dist/src/providers/python_uv.js +269 -0
  69. package/dist/src/providers/requirements_parser.d.ts +6 -0
  70. package/dist/src/providers/requirements_parser.js +24 -0
  71. package/dist/src/providers/rust_cargo.d.ts +56 -0
  72. package/dist/src/providers/rust_cargo.js +641 -0
  73. package/dist/src/providers/tree-sitter-containerfile.wasm +0 -0
  74. package/dist/src/providers/tree-sitter-gomod.wasm +0 -0
  75. package/dist/src/providers/tree-sitter-requirements.wasm +0 -0
  76. package/dist/src/remediate.d.ts +21 -0
  77. package/dist/src/remediate.js +149 -0
  78. package/dist/src/remediation.d.ts +57 -0
  79. package/dist/src/remediation.js +436 -0
  80. package/dist/src/remediation_report.d.ts +40 -0
  81. package/dist/src/remediation_report.js +159 -0
  82. package/dist/src/sbom.d.ts +17 -2
  83. package/dist/src/sbom.js +16 -4
  84. package/dist/src/tools.d.ts +48 -6
  85. package/dist/src/tools.js +114 -1
  86. package/dist/src/updaters/maven_updater.d.ts +26 -0
  87. package/dist/src/updaters/maven_updater.js +322 -0
  88. package/dist/src/updaters/toml_updater.d.ts +33 -0
  89. package/dist/src/updaters/toml_updater.js +244 -0
  90. package/dist/src/workspace.d.ts +70 -0
  91. package/dist/src/workspace.js +256 -0
  92. package/package.json +44 -28
@@ -12,18 +12,30 @@
12
12
  export function selectTrustifyDABackend(opts?: {
13
13
  TRUSTIFY_DA_DEBUG?: string | undefined;
14
14
  TRUSTIFY_DA_BACKEND_URL?: string | undefined;
15
- } | undefined): string;
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 };
31
+ export { stackAnalysisBatch };
21
32
  export { imageAnalysis };
22
33
  export { validateToken };
34
+ export { generateSbom };
23
35
  }
24
36
  export default _default;
25
37
  export type Options = {
26
- [key: string]: string | undefined;
38
+ TRUSTIFY_DA_CARGO_PATH?: string | undefined;
27
39
  TRUSTIFY_DA_DOCKER_PATH?: string | undefined;
28
40
  TRUSTIFY_DA_GO_MVS_LOGIC_ENABLED?: string | undefined;
29
41
  TRUSTIFY_DA_GO_PATH?: string | undefined;
@@ -42,16 +54,53 @@ export type Options = {
42
54
  TRUSTIFY_DA_PYTHON_PATH?: string | undefined;
43
55
  TRUSTIFY_DA_PYTHON_VIRTUAL_ENV?: string | undefined;
44
56
  TRUSTIFY_DA_PYTHON3_PATH?: string | undefined;
45
- TRUSTIFY_DA_RECOMMENDATIONS_ENABLED?: string | undefined;
57
+ TRUSTIFY_DA_PROVIDERS?: string | undefined;
58
+ TRUSTIFY_DA_RECOMMEND?: string | undefined;
59
+ TRUSTIFY_DA_SOURCES?: string | undefined;
46
60
  TRUSTIFY_DA_SKOPEO_CONFIG_PATH?: string | undefined;
47
61
  TRUSTIFY_DA_SKOPEO_PATH?: string | undefined;
48
62
  TRUSTIFY_DA_SYFT_CONFIG_PATH?: string | undefined;
49
63
  TRUSTIFY_DA_SYFT_PATH?: string | undefined;
50
64
  TRUSTIFY_DA_YARN_PATH?: string | undefined;
65
+ TRUSTIFY_DA_WORKSPACE_DIR?: string | undefined;
66
+ TRUSTIFY_DA_LICENSE_CHECK?: string | undefined;
51
67
  MATCH_MANIFEST_VERSIONS?: string | undefined;
52
- RHDA_SOURCE?: string | undefined;
53
- RHDA_TOKEN?: string | undefined;
54
- RHDA_TELEMETRY_ID?: string | undefined;
68
+ TRUSTIFY_DA_SOURCE?: string | undefined;
69
+ TRUSTIFY_DA_TOKEN?: string | undefined;
70
+ TRUSTIFY_DA_TELEMETRY_ID?: string | undefined;
71
+ TRUSTIFY_DA_WORKSPACE_DIR?: string | undefined;
72
+ batchConcurrency?: number | undefined;
73
+ TRUSTIFY_DA_BATCH_CONCURRENCY?: string | undefined;
74
+ workspaceDiscoveryIgnore?: string[] | undefined;
75
+ TRUSTIFY_DA_WORKSPACE_DISCOVERY_IGNORE?: string | undefined;
76
+ continueOnError?: boolean | undefined;
77
+ TRUSTIFY_DA_CONTINUE_ON_ERROR?: string | undefined;
78
+ batchMetadata?: boolean | undefined;
79
+ TRUSTIFY_DA_BATCH_METADATA?: string | undefined;
80
+ TRUSTIFY_DA_UV_PATH?: string | undefined;
81
+ TRUSTIFY_DA_POETRY_PATH?: string | undefined;
82
+ [key: string]: string | number | boolean | string[] | undefined;
83
+ };
84
+ export type BatchAnalysisMetadata = {
85
+ workspaceRoot: string;
86
+ ecosystem: "javascript" | "cargo" | "pyproject" | "unknown";
87
+ total: number;
88
+ successful: number;
89
+ failed: number;
90
+ errors: Array<{
91
+ manifestPath: string;
92
+ phase: "validation" | "sbom";
93
+ reason: string;
94
+ }>;
95
+ };
96
+ export type SbomResult = {
97
+ ok: true;
98
+ purl: string;
99
+ sbom: object;
100
+ } | {
101
+ ok: false;
102
+ manifestPath: string;
103
+ reason: string;
55
104
  };
56
105
  /**
57
106
  * Get component analysis report for a manifest content.
@@ -60,16 +109,143 @@ export type Options = {
60
109
  * @returns {Promise<import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>}
61
110
  * @throws {Error} if no matching provider, failed to get create content, or backend request failed
62
111
  */
63
- declare function componentAnalysis(manifest: string, opts?: Options | undefined): Promise<import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>;
112
+ declare function componentAnalysis(manifest: string, opts?: Options): Promise<any>;
113
+ /**
114
+ * @overload
115
+ * @param {string} manifest
116
+ * @param {true} html
117
+ * @param {Options} [opts={}]
118
+ * @returns {Promise<string>}
119
+ * @throws {Error}
120
+ */
64
121
  declare function stackAnalysis(manifest: string, html: true, opts?: Options | undefined): Promise<string>;
65
- declare function stackAnalysis(manifest: string, html: false, opts?: Options | undefined): Promise<import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>;
66
- declare function stackAnalysis(manifest: string, html?: boolean | undefined, opts?: Options | undefined): Promise<string | import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>;
122
+ /**
123
+ * @overload
124
+ * @param {string} manifest
125
+ * @param {false} html
126
+ * @param {Options} [opts={}]
127
+ * @returns {Promise<import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>}
128
+ * @throws {Error}
129
+ */
130
+ declare function stackAnalysis(manifest: string, html: false, opts?: Options | undefined): Promise<any>;
131
+ /**
132
+ * Get stack analysis report for a manifest file.
133
+ * @overload
134
+ * @param {string} manifest - path for the manifest
135
+ * @param {boolean} [html=false] - true will return a html string, false will return AnalysisReport object.
136
+ * @param {Options} [opts={}] - optional various options to pass along the application
137
+ * @returns {Promise<string|import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>}
138
+ * @throws {Error} if manifest inaccessible, no matching provider, failed to get create content,
139
+ * or backend request failed
140
+ */
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
+ }>;
196
+ /**
197
+ * Get stack analysis for all workspace packages/crates (batch).
198
+ * Detects ecosystem from workspace root: Cargo (Cargo.toml + Cargo.lock) or JS/TS (package.json + lock file).
199
+ * SBOMs are generated in parallel (see `batchConcurrency`) unless `continueOnError: false` (fail-fast sequential).
200
+ * With `opts.batchMetadata` / `TRUSTIFY_DA_BATCH_METADATA`, returns `{ analysis, metadata }` including validation and SBOM errors.
201
+ *
202
+ * @overload
203
+ * @param {string} workspaceRoot - Path to workspace root (containing lock file and workspace config)
204
+ * @param {boolean} [html=false] - true returns HTML, false returns JSON report
205
+ * @param {Options} [opts={}] - `batchConcurrency`, discovery ignores, `continueOnError` (default true), `batchMetadata` (default false)
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 }>}
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.
208
+ */
209
+ declare function stackAnalysisBatch(workspaceRoot: string, html?: boolean | undefined, opts?: Options | undefined): Promise<string | {
210
+ [x: string]: any;
211
+ } | {
212
+ analysis: string | {
213
+ [x: string]: any;
214
+ };
215
+ metadata: BatchAnalysisMetadata;
216
+ }>;
217
+ /**
218
+ * @overload
219
+ * @param {Array<string>} imageRefs
220
+ * @param {true} html
221
+ * @param {Options} [opts={}]
222
+ * @returns {Promise<string>}
223
+ * @throws {Error}
224
+ */
67
225
  declare function imageAnalysis(imageRefs: Array<string>, html: true, opts?: Options | undefined): Promise<string>;
226
+ /**
227
+ * @overload
228
+ * @param {Array<string>} imageRefs
229
+ * @param {false} html
230
+ * @param {Options} [opts={}]
231
+ * @returns {Promise<Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>>}
232
+ * @throws {Error}
233
+ */
68
234
  declare function imageAnalysis(imageRefs: Array<string>, html: false, opts?: Options | undefined): Promise<{
69
- [x: string]: import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport;
235
+ [x: string]: any;
70
236
  }>;
237
+ /**
238
+ * Get image analysis report for a set of OCI image references.
239
+ * @overload
240
+ * @param {Array<string>} imageRefs - OCI image references
241
+ * @param {boolean} [html=false] - true will return a html string, false will return AnalysisReport
242
+ * @param {Options} [opts={}] - optional various options to pass along the application
243
+ * @returns {Promise<string|Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>>}
244
+ * @throws {Error} if manifest inaccessible, no matching provider, failed to get create content,
245
+ * or backend request failed
246
+ */
71
247
  declare function imageAnalysis(imageRefs: Array<string>, html?: boolean | undefined, opts?: Options | undefined): Promise<string | {
72
- [x: string]: import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport;
248
+ [x: string]: any;
73
249
  }>;
74
250
  /**
75
251
  * Validates the Exhort token.
@@ -77,4 +253,18 @@ declare function imageAnalysis(imageRefs: Array<string>, html?: boolean | undefi
77
253
  * @returns {Promise<object>} A promise that resolves with the validation result from the backend.
78
254
  * @throws {Error} if the backend request failed.
79
255
  */
80
- declare function validateToken(opts?: Options | undefined): Promise<object>;
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';
261
+ import { discoverWorkspacePackages } from './workspace.js';
262
+ import { discoverWorkspaceCrates } from './workspace.js';
263
+ import { validatePackageJson } from './workspace.js';
264
+ import { resolveWorkspaceDiscoveryIgnore } from './workspace.js';
265
+ import { filterManifestPathsByDiscoveryIgnore } from './workspace.js';
266
+ import { resolveContinueOnError } from './batch_opts.js';
267
+ import { resolveBatchMetadata } from './batch_opts.js';
268
+ export { discoverMavenModules, discoverGradleSubprojects, discoverGoWorkspaceModules, discoverUvWorkspaceMembers, discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson, resolveWorkspaceDiscoveryIgnore, filterManifestPathsByDiscoveryIgnore, resolveContinueOnError, resolveBatchMetadata };
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
@@ -1,16 +1,28 @@
1
1
  import path from "node:path";
2
2
  import { EOL } from "os";
3
+ import pLimit from 'p-limit';
3
4
  import { availableProviders, match } from './provider.js';
4
5
  import analysis from './analysis.js';
5
6
  import fs from 'node:fs';
6
7
  import { getCustom } from "./tools.js";
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';
13
+ import { discoverWorkspaceCrates, discoverWorkspacePackages, filterManifestPathsByDiscoveryIgnore, resolveWorkspaceDiscoveryIgnore, validatePackageJson, } from './workspace.js';
7
14
  import.meta.dirname;
8
15
  import * as url from 'url';
9
16
  export { parseImageRef } from "./oci_image/utils.js";
10
17
  export { ImageRef } from "./oci_image/images.js";
11
- export default { componentAnalysis, stackAnalysis, imageAnalysis, validateToken };
18
+ export { getProjectLicense, findLicenseFilePath, identifyLicense, getLicenseDetails, licensesFromReport, normalizeLicensesResponse, runLicenseCheck, getCompatibility } from "./license/index.js";
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, };
12
23
  /**
13
24
  * @typedef {{
25
+ * TRUSTIFY_DA_CARGO_PATH?: string | undefined,
14
26
  * TRUSTIFY_DA_DOCKER_PATH?: string | undefined,
15
27
  * TRUSTIFY_DA_GO_MVS_LOGIC_ENABLED?: string | undefined,
16
28
  * TRUSTIFY_DA_GO_PATH?: string | undefined,
@@ -29,19 +41,44 @@ export default { componentAnalysis, stackAnalysis, imageAnalysis, validateToken
29
41
  * TRUSTIFY_DA_PYTHON_PATH?: string | undefined,
30
42
  * TRUSTIFY_DA_PYTHON_VIRTUAL_ENV?: string | undefined,
31
43
  * TRUSTIFY_DA_PYTHON3_PATH?: string | undefined,
32
- * TRUSTIFY_DA_RECOMMENDATIONS_ENABLED?: string | undefined,
44
+ * TRUSTIFY_DA_PROVIDERS?: string | undefined,
45
+ * TRUSTIFY_DA_RECOMMEND?: string | undefined,
46
+ * TRUSTIFY_DA_SOURCES?: string | undefined,
33
47
  * TRUSTIFY_DA_SKOPEO_CONFIG_PATH?: string | undefined,
34
48
  * TRUSTIFY_DA_SKOPEO_PATH?: string | undefined,
35
49
  * TRUSTIFY_DA_SYFT_CONFIG_PATH?: string | undefined,
36
50
  * TRUSTIFY_DA_SYFT_PATH?: string | undefined,
37
51
  * TRUSTIFY_DA_YARN_PATH?: string | undefined,
52
+ * TRUSTIFY_DA_WORKSPACE_DIR?: string | undefined,
53
+ * TRUSTIFY_DA_LICENSE_CHECK?: string | undefined,
38
54
  * MATCH_MANIFEST_VERSIONS?: string | undefined,
39
- * RHDA_SOURCE?: string | undefined,
40
- * RHDA_TOKEN?: string | undefined,
41
- * RHDA_TELEMETRY_ID?: string | undefined,
42
- * [key: string]: string | undefined,
55
+ * TRUSTIFY_DA_SOURCE?: string | undefined,
56
+ * TRUSTIFY_DA_TOKEN?: string | undefined,
57
+ * TRUSTIFY_DA_TELEMETRY_ID?: string | undefined,
58
+ * TRUSTIFY_DA_WORKSPACE_DIR?: string | undefined,
59
+ * batchConcurrency?: number | undefined,
60
+ * TRUSTIFY_DA_BATCH_CONCURRENCY?: string | undefined,
61
+ * workspaceDiscoveryIgnore?: string[] | undefined,
62
+ * TRUSTIFY_DA_WORKSPACE_DISCOVERY_IGNORE?: string | undefined,
63
+ * continueOnError?: boolean | undefined,
64
+ * TRUSTIFY_DA_CONTINUE_ON_ERROR?: string | undefined,
65
+ * batchMetadata?: boolean | undefined,
66
+ * TRUSTIFY_DA_BATCH_METADATA?: string | undefined,
67
+ * TRUSTIFY_DA_UV_PATH?: string | undefined,
68
+ * TRUSTIFY_DA_POETRY_PATH?: string | undefined,
69
+ * [key: string]: string | number | boolean | string[] | undefined,
43
70
  * }} Options
44
71
  */
72
+ /**
73
+ * @typedef {{
74
+ * workspaceRoot: string,
75
+ * ecosystem: 'javascript' | 'cargo' | 'pyproject' | 'unknown',
76
+ * total: number,
77
+ * successful: number,
78
+ * failed: number,
79
+ * errors: Array<{ manifestPath: string, phase: 'validation' | 'sbom', reason: string }>
80
+ * }} BatchAnalysisMetadata
81
+ */
45
82
  /**
46
83
  * Logs messages to the console if the TRUSTIFY_DA_DEBUG environment variable is set to "true".
47
84
  * @param {string} alongsideText - The text to prepend to the log message.
@@ -127,7 +164,7 @@ export function selectTrustifyDABackend(opts = {}) {
127
164
  async function stackAnalysis(manifest, html = false, opts = {}) {
128
165
  const theUrl = selectTrustifyDABackend(opts);
129
166
  fs.accessSync(manifest, fs.constants.R_OK); // throws error if file unreadable
130
- let provider = match(manifest, availableProviders); // throws error if no matching provider
167
+ let provider = match(manifest, availableProviders, opts); // throws error if no matching provider
131
168
  return await analysis.requestStack(provider, manifest, theUrl, html, opts); // throws error request sending failed
132
169
  }
133
170
  /**
@@ -141,8 +178,10 @@ async function componentAnalysis(manifest, opts = {}) {
141
178
  const theUrl = selectTrustifyDABackend(opts);
142
179
  fs.accessSync(manifest, fs.constants.R_OK);
143
180
  opts["manifest-type"] = path.basename(manifest);
144
- let provider = match(manifest, availableProviders); // throws error if no matching provider
145
- return await analysis.requestComponent(provider, manifest, theUrl, opts); // throws error request sending failed
181
+ let provider = match(manifest, availableProviders, opts); // throws error if no matching provider
182
+ const result = await analysis.requestComponent(provider, manifest, theUrl, opts); // throws error request sending failed
183
+ result.packageManager = provider.packageManagerName();
184
+ return result;
146
185
  }
147
186
  /**
148
187
  * @overload
@@ -174,6 +213,319 @@ async function imageAnalysis(imageRefs, html = false, opts = {}) {
174
213
  const theUrl = selectTrustifyDABackend(opts);
175
214
  return await analysis.requestImages(imageRefs, theUrl, html, opts);
176
215
  }
216
+ /**
217
+ * Max concurrent SBOM generations for batch workspace analysis. Env/opts override default 10.
218
+ * @param {Options} opts
219
+ * @returns {number}
220
+ * @private
221
+ */
222
+ function resolveBatchConcurrency(opts) {
223
+ const fromEnv = getCustom('TRUSTIFY_DA_BATCH_CONCURRENCY', null, opts);
224
+ const raw = opts.batchConcurrency ?? fromEnv ?? '10';
225
+ const n = typeof raw === 'number' ? raw : parseInt(String(raw), 10);
226
+ if (!Number.isFinite(n) || n < 1) {
227
+ return 10;
228
+ }
229
+ return Math.min(256, n);
230
+ }
231
+ /**
232
+ * @param {string} root
233
+ * @param {'javascript' | 'cargo' | 'unknown'} ecosystem
234
+ * @param {number} totalSbomAttempts
235
+ * @param {number} successfulSbomCount
236
+ * @param {Array<{ manifestPath: string, phase: 'validation' | 'sbom', reason: string }>} errors
237
+ * @returns {BatchAnalysisMetadata}
238
+ * @private
239
+ */
240
+ function buildBatchAnalysisMetadata(root, ecosystem, totalSbomAttempts, successfulSbomCount, errors) {
241
+ return {
242
+ workspaceRoot: root,
243
+ ecosystem,
244
+ total: totalSbomAttempts,
245
+ successful: successfulSbomCount,
246
+ failed: errors.length,
247
+ errors: [...errors],
248
+ };
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
+ }
266
+ /**
267
+ * @typedef {{ ok: true, purl: string, sbom: object } | { ok: false, manifestPath: string, reason: string }} SbomResult
268
+ */
269
+ /**
270
+ * Generate an SBOM for a single manifest, returning a normalized result.
271
+ *
272
+ * @param {string} manifestPath
273
+ * @param {Options} workspaceOpts - opts with `TRUSTIFY_DA_WORKSPACE_DIR` set
274
+ * @returns {Promise<SbomResult>}
275
+ * @private
276
+ */
277
+ async function generateOneSbom(manifestPath, workspaceOpts) {
278
+ const provider = match(manifestPath, availableProviders, workspaceOpts);
279
+ const provided = await provider.provideStack(manifestPath, workspaceOpts);
280
+ const sbom = JSON.parse(provided.content);
281
+ const purl = sbom?.metadata?.component?.purl || sbom?.metadata?.component?.['bom-ref'];
282
+ if (!purl) {
283
+ return { ok: false, manifestPath, reason: 'missing purl in SBOM' };
284
+ }
285
+ return { ok: true, purl, sbom };
286
+ }
287
+ /**
288
+ * Detect the workspace ecosystem and discover manifest paths.
289
+ *
290
+ * @param {string} root - Resolved workspace root
291
+ * @param {Options} opts
292
+ * @returns {Promise<{ ecosystem: 'javascript' | 'cargo' | 'maven' | 'gradle' | 'gomodules' | 'pyproject' | 'unknown', manifestPaths: string[] }>}
293
+ * @private
294
+ */
295
+ async function detectWorkspaceManifests(root, opts) {
296
+ const cargoToml = path.join(root, 'Cargo.toml');
297
+ const cargoLock = path.join(root, 'Cargo.lock');
298
+ const packageJson = path.join(root, 'package.json');
299
+ const pomXml = path.join(root, 'pom.xml');
300
+ if (fs.existsSync(cargoToml) && fs.existsSync(cargoLock)) {
301
+ return { ecosystem: 'cargo', manifestPaths: await discoverWorkspaceCrates(root, opts) };
302
+ }
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'))
331
+ || fs.existsSync(path.join(root, 'yarn.lock'))
332
+ || fs.existsSync(path.join(root, 'package-lock.json'));
333
+ if (fs.existsSync(packageJson) && hasJsLock) {
334
+ let manifestPaths = await discoverWorkspacePackages(root, opts);
335
+ if (manifestPaths.length === 0) {
336
+ manifestPaths = [packageJson];
337
+ }
338
+ return { ecosystem: 'javascript', manifestPaths };
339
+ }
340
+ return { ecosystem: 'unknown', manifestPaths: [] };
341
+ }
342
+ /**
343
+ * Validate discovered JS package.json manifests, collecting errors.
344
+ *
345
+ * @param {string[]} manifestPaths
346
+ * @param {boolean} continueOnError
347
+ * @param {Array<{ manifestPath: string, phase: 'validation' | 'sbom', reason: string }>} collectedErrors - mutated in place
348
+ * @returns {{ validPaths: string[] }}
349
+ * @throws {Error} on first invalid manifest when `continueOnError` is false
350
+ * @private
351
+ */
352
+ function validateJsManifests(manifestPaths, continueOnError, collectedErrors) {
353
+ const validPaths = [];
354
+ for (const p of manifestPaths) {
355
+ const v = validatePackageJson(p);
356
+ if (v.valid) {
357
+ validPaths.push(p);
358
+ }
359
+ else {
360
+ collectedErrors.push({ manifestPath: p, phase: 'validation', reason: v.error });
361
+ console.warn(`Skipping invalid package.json (${v.error}): ${p}`);
362
+ if (!continueOnError) {
363
+ throw new Error(`Invalid package.json (${v.error}): ${p}`);
364
+ }
365
+ }
366
+ }
367
+ return { validPaths };
368
+ }
369
+ /**
370
+ * Generate SBOMs for all manifests. In fail-fast mode, stops on first error.
371
+ * In continue-on-error mode, runs concurrently and collects failures.
372
+ *
373
+ * @param {string[]} manifestPaths
374
+ * @param {Options} workspaceOpts
375
+ * @param {boolean} continueOnError
376
+ * @param {number} concurrency
377
+ * @param {Array<{ manifestPath: string, phase: 'validation' | 'sbom', reason: string }>} collectedErrors - mutated in place
378
+ * @returns {Promise<Object.<string, object>>} sbomByPurl map
379
+ * @throws {Error} on first SBOM failure when `continueOnError` is false
380
+ * @private
381
+ */
382
+ async function generateSboms(manifestPaths, workspaceOpts, continueOnError, concurrency, collectedErrors) {
383
+ /** @type {SbomResult[]} */
384
+ const results = [];
385
+ if (!continueOnError) {
386
+ for (const manifestPath of manifestPaths) {
387
+ const result = await generateOneSbom(manifestPath, workspaceOpts);
388
+ if (!result.ok) {
389
+ collectedErrors.push({ manifestPath: result.manifestPath, phase: 'sbom', reason: result.reason });
390
+ throw new Error(`${result.manifestPath}: ${result.reason}`);
391
+ }
392
+ results.push(result);
393
+ }
394
+ }
395
+ else {
396
+ const limit = pLimit(concurrency);
397
+ const settled = await Promise.all(manifestPaths.map(manifestPath => limit(async () => {
398
+ try {
399
+ return await generateOneSbom(manifestPath, workspaceOpts);
400
+ }
401
+ catch (err) {
402
+ const msg = err instanceof Error ? err.message : String(err);
403
+ if (process.env["TRUSTIFY_DA_DEBUG"] === "true") {
404
+ console.log(`Skipping ${manifestPath}: ${msg}`);
405
+ }
406
+ return { ok: false, manifestPath, reason: msg };
407
+ }
408
+ })));
409
+ for (const r of settled) {
410
+ results.push(r);
411
+ if (!r.ok) {
412
+ collectedErrors.push({ manifestPath: r.manifestPath, phase: 'sbom', reason: r.reason });
413
+ }
414
+ }
415
+ }
416
+ const sbomByPurl = {};
417
+ for (const r of results) {
418
+ if (r.ok) {
419
+ sbomByPurl[r.purl] = r.sbom;
420
+ }
421
+ }
422
+ return sbomByPurl;
423
+ }
424
+ /**
425
+ * Create an Error with optional `batchMetadata` attached.
426
+ * @param {string} message
427
+ * @param {boolean} wantMetadata
428
+ * @param {BatchAnalysisMetadata} [metadata]
429
+ * @returns {Error}
430
+ * @private
431
+ */
432
+ function batchError(message, wantMetadata, metadata) {
433
+ const err = new Error(message);
434
+ if (wantMetadata && metadata) {
435
+ err.batchMetadata = metadata;
436
+ }
437
+ return err;
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
+ */
471
+ /**
472
+ * Get stack analysis for all workspace packages/crates (batch).
473
+ * Detects ecosystem from workspace root: Cargo (Cargo.toml + Cargo.lock) or JS/TS (package.json + lock file).
474
+ * SBOMs are generated in parallel (see `batchConcurrency`) unless `continueOnError: false` (fail-fast sequential).
475
+ * With `opts.batchMetadata` / `TRUSTIFY_DA_BATCH_METADATA`, returns `{ analysis, metadata }` including validation and SBOM errors.
476
+ *
477
+ * @overload
478
+ * @param {string} workspaceRoot - Path to workspace root (containing lock file and workspace config)
479
+ * @param {boolean} [html=false] - true returns HTML, false returns JSON report
480
+ * @param {Options} [opts={}] - `batchConcurrency`, discovery ignores, `continueOnError` (default true), `batchMetadata` (default false)
481
+ * @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 }>}
482
+ * @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.
483
+ */
484
+ async function stackAnalysisBatch(workspaceRoot, html = false, opts = {}) {
485
+ const theUrl = selectTrustifyDABackend(opts);
486
+ const root = path.resolve(workspaceRoot);
487
+ fs.accessSync(root, fs.constants.R_OK);
488
+ const continueOnError = resolveContinueOnError(opts);
489
+ const wantMetadata = resolveBatchMetadata(opts);
490
+ /** @type {Array<{ manifestPath: string, phase: 'validation' | 'sbom', reason: string }>} */
491
+ const collectedErrors = [];
492
+ const { ecosystem, manifestPaths: discovered } = await detectWorkspaceManifests(root, opts);
493
+ let manifestPaths = discovered;
494
+ if (ecosystem === 'javascript') {
495
+ try {
496
+ const { validPaths } = validateJsManifests(manifestPaths, continueOnError, collectedErrors);
497
+ manifestPaths = validPaths;
498
+ }
499
+ catch (err) {
500
+ throw batchError(err.message, wantMetadata, buildBatchAnalysisMetadata(root, ecosystem, 0, 0, collectedErrors));
501
+ }
502
+ if (manifestPaths.length === 0 && discovered.length > 0) {
503
+ const detail = collectedErrors.map(e => `${e.manifestPath}: ${e.reason}`).join('; ');
504
+ throw batchError(`No valid packages after validation at ${root}. ${detail}`, wantMetadata, buildBatchAnalysisMetadata(root, ecosystem, 0, 0, collectedErrors));
505
+ }
506
+ }
507
+ if (manifestPaths.length === 0) {
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).`);
509
+ }
510
+ const workspaceOpts = { ...opts, TRUSTIFY_DA_WORKSPACE_DIR: root };
511
+ const concurrency = resolveBatchConcurrency(opts);
512
+ let sbomByPurl;
513
+ try {
514
+ sbomByPurl = await generateSboms(manifestPaths, workspaceOpts, continueOnError, concurrency, collectedErrors);
515
+ }
516
+ catch (err) {
517
+ throw batchError(err.message, wantMetadata, buildBatchAnalysisMetadata(root, ecosystem, manifestPaths.length, 0, collectedErrors));
518
+ }
519
+ if (Object.keys(sbomByPurl).length === 0) {
520
+ throw batchError(`No valid SBOMs produced from ${manifestPaths.length} manifest(s) at ${root}`, wantMetadata, buildBatchAnalysisMetadata(root, ecosystem, manifestPaths.length, 0, collectedErrors));
521
+ }
522
+ const analysisResult = await analysis.requestStackBatch(sbomByPurl, theUrl, html, opts);
523
+ const meta = buildBatchAnalysisMetadata(root, ecosystem, manifestPaths.length, Object.keys(sbomByPurl).length, collectedErrors);
524
+ if (wantMetadata) {
525
+ return { analysis: analysisResult, metadata: meta };
526
+ }
527
+ return analysisResult;
528
+ }
177
529
  /**
178
530
  * Validates the Exhort token.
179
531
  * @param {Options} [opts={}] - Optional parameters, potentially including token override.