@trustify-da/trustify-da-javascript-client 0.3.0-ea.3aa725a → 0.3.0-ea.4558b63

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 (70) hide show
  1. package/README.md +191 -11
  2. package/dist/package.json +23 -10
  3. package/dist/src/analysis.d.ts +21 -5
  4. package/dist/src/analysis.js +74 -80
  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 +241 -8
  8. package/dist/src/cyclone_dx_sbom.d.ts +10 -2
  9. package/dist/src/cyclone_dx_sbom.js +32 -5
  10. package/dist/src/index.d.ts +194 -11
  11. package/dist/src/index.js +329 -7
  12. package/dist/src/license/index.d.ts +28 -0
  13. package/dist/src/license/index.js +100 -0
  14. package/dist/src/license/license_utils.d.ts +40 -0
  15. package/dist/src/license/license_utils.js +134 -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/utils.d.ts +4 -4
  22. package/dist/src/oci_image/utils.js +11 -2
  23. package/dist/src/provider.d.ts +17 -5
  24. package/dist/src/provider.js +29 -5
  25. package/dist/src/providers/base_java.d.ts +3 -14
  26. package/dist/src/providers/base_java.js +2 -38
  27. package/dist/src/providers/base_javascript.d.ts +29 -7
  28. package/dist/src/providers/base_javascript.js +129 -22
  29. package/dist/src/providers/base_pyproject.d.ts +149 -0
  30. package/dist/src/providers/base_pyproject.js +314 -0
  31. package/dist/src/providers/golang_gomodules.d.ts +20 -13
  32. package/dist/src/providers/golang_gomodules.js +112 -114
  33. package/dist/src/providers/gomod_parser.d.ts +4 -0
  34. package/dist/src/providers/gomod_parser.js +16 -0
  35. package/dist/src/providers/java_gradle.d.ts +9 -3
  36. package/dist/src/providers/java_gradle.js +12 -2
  37. package/dist/src/providers/java_gradle_groovy.d.ts +1 -1
  38. package/dist/src/providers/java_gradle_kotlin.d.ts +1 -1
  39. package/dist/src/providers/java_maven.d.ts +20 -5
  40. package/dist/src/providers/java_maven.js +126 -6
  41. package/dist/src/providers/javascript_npm.d.ts +1 -0
  42. package/dist/src/providers/javascript_npm.js +21 -0
  43. package/dist/src/providers/javascript_pnpm.d.ts +1 -1
  44. package/dist/src/providers/javascript_pnpm.js +8 -4
  45. package/dist/src/providers/manifest.d.ts +2 -0
  46. package/dist/src/providers/manifest.js +22 -4
  47. package/dist/src/providers/processors/yarn_berry_processor.js +88 -5
  48. package/dist/src/providers/python_controller.d.ts +5 -2
  49. package/dist/src/providers/python_controller.js +60 -58
  50. package/dist/src/providers/python_pip.d.ts +11 -4
  51. package/dist/src/providers/python_pip.js +47 -54
  52. package/dist/src/providers/python_pip_pyproject.d.ts +61 -0
  53. package/dist/src/providers/python_pip_pyproject.js +144 -0
  54. package/dist/src/providers/python_poetry.d.ts +43 -0
  55. package/dist/src/providers/python_poetry.js +175 -0
  56. package/dist/src/providers/python_uv.d.ts +27 -0
  57. package/dist/src/providers/python_uv.js +149 -0
  58. package/dist/src/providers/requirements_parser.d.ts +6 -0
  59. package/dist/src/providers/requirements_parser.js +24 -0
  60. package/dist/src/providers/rust_cargo.d.ts +52 -0
  61. package/dist/src/providers/rust_cargo.js +614 -0
  62. package/dist/src/providers/tree-sitter-gomod.wasm +0 -0
  63. package/dist/src/providers/tree-sitter-requirements.wasm +0 -0
  64. package/dist/src/sbom.d.ts +10 -1
  65. package/dist/src/sbom.js +12 -2
  66. package/dist/src/tools.d.ts +38 -6
  67. package/dist/src/tools.js +96 -1
  68. package/dist/src/workspace.d.ts +61 -0
  69. package/dist/src/workspace.js +256 -0
  70. package/package.json +24 -11
package/dist/src/index.js CHANGED
@@ -1,16 +1,23 @@
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 { discoverWorkspaceCrates, discoverWorkspacePackages, filterManifestPathsByDiscoveryIgnore, resolveWorkspaceDiscoveryIgnore, validatePackageJson, } from './workspace.js';
7
11
  import.meta.dirname;
8
12
  import * as url from 'url';
9
13
  export { parseImageRef } from "./oci_image/utils.js";
10
14
  export { ImageRef } from "./oci_image/images.js";
11
- export default { componentAnalysis, stackAnalysis, imageAnalysis, validateToken };
15
+ export { getProjectLicense, findLicenseFilePath, identifyLicense, getLicenseDetails, licensesFromReport, normalizeLicensesResponse, runLicenseCheck, getCompatibility } from "./license/index.js";
16
+ export default { componentAnalysis, stackAnalysis, stackAnalysisBatch, imageAnalysis, validateToken, generateSbom };
17
+ export { discoverMavenModules, discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson, resolveWorkspaceDiscoveryIgnore, filterManifestPathsByDiscoveryIgnore, resolveContinueOnError, resolveBatchMetadata, };
12
18
  /**
13
19
  * @typedef {{
20
+ * TRUSTIFY_DA_CARGO_PATH?: string | undefined,
14
21
  * TRUSTIFY_DA_DOCKER_PATH?: string | undefined,
15
22
  * TRUSTIFY_DA_GO_MVS_LOGIC_ENABLED?: string | undefined,
16
23
  * TRUSTIFY_DA_GO_PATH?: string | undefined,
@@ -35,13 +42,36 @@ export default { componentAnalysis, stackAnalysis, imageAnalysis, validateToken
35
42
  * TRUSTIFY_DA_SYFT_CONFIG_PATH?: string | undefined,
36
43
  * TRUSTIFY_DA_SYFT_PATH?: string | undefined,
37
44
  * TRUSTIFY_DA_YARN_PATH?: string | undefined,
45
+ * TRUSTIFY_DA_WORKSPACE_DIR?: string | undefined,
46
+ * TRUSTIFY_DA_LICENSE_CHECK?: string | undefined,
38
47
  * 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,
48
+ * TRUSTIFY_DA_SOURCE?: string | undefined,
49
+ * TRUSTIFY_DA_TOKEN?: string | undefined,
50
+ * TRUSTIFY_DA_TELEMETRY_ID?: string | undefined,
51
+ * TRUSTIFY_DA_WORKSPACE_DIR?: string | undefined,
52
+ * batchConcurrency?: number | undefined,
53
+ * TRUSTIFY_DA_BATCH_CONCURRENCY?: string | undefined,
54
+ * workspaceDiscoveryIgnore?: string[] | undefined,
55
+ * TRUSTIFY_DA_WORKSPACE_DISCOVERY_IGNORE?: string | undefined,
56
+ * continueOnError?: boolean | undefined,
57
+ * TRUSTIFY_DA_CONTINUE_ON_ERROR?: string | undefined,
58
+ * batchMetadata?: boolean | undefined,
59
+ * TRUSTIFY_DA_BATCH_METADATA?: string | undefined,
60
+ * TRUSTIFY_DA_UV_PATH?: string | undefined,
61
+ * TRUSTIFY_DA_POETRY_PATH?: string | undefined,
62
+ * [key: string]: string | number | boolean | string[] | undefined,
43
63
  * }} Options
44
64
  */
65
+ /**
66
+ * @typedef {{
67
+ * workspaceRoot: string,
68
+ * ecosystem: 'javascript' | 'cargo' | 'unknown',
69
+ * total: number,
70
+ * successful: number,
71
+ * failed: number,
72
+ * errors: Array<{ manifestPath: string, phase: 'validation' | 'sbom', reason: string }>
73
+ * }} BatchAnalysisMetadata
74
+ */
45
75
  /**
46
76
  * Logs messages to the console if the TRUSTIFY_DA_DEBUG environment variable is set to "true".
47
77
  * @param {string} alongsideText - The text to prepend to the log message.
@@ -127,7 +157,7 @@ export function selectTrustifyDABackend(opts = {}) {
127
157
  async function stackAnalysis(manifest, html = false, opts = {}) {
128
158
  const theUrl = selectTrustifyDABackend(opts);
129
159
  fs.accessSync(manifest, fs.constants.R_OK); // throws error if file unreadable
130
- let provider = match(manifest, availableProviders); // throws error if no matching provider
160
+ let provider = match(manifest, availableProviders, opts); // throws error if no matching provider
131
161
  return await analysis.requestStack(provider, manifest, theUrl, html, opts); // throws error request sending failed
132
162
  }
133
163
  /**
@@ -141,7 +171,7 @@ async function componentAnalysis(manifest, opts = {}) {
141
171
  const theUrl = selectTrustifyDABackend(opts);
142
172
  fs.accessSync(manifest, fs.constants.R_OK);
143
173
  opts["manifest-type"] = path.basename(manifest);
144
- let provider = match(manifest, availableProviders); // throws error if no matching provider
174
+ let provider = match(manifest, availableProviders, opts); // throws error if no matching provider
145
175
  return await analysis.requestComponent(provider, manifest, theUrl, opts); // throws error request sending failed
146
176
  }
147
177
  /**
@@ -174,6 +204,298 @@ async function imageAnalysis(imageRefs, html = false, opts = {}) {
174
204
  const theUrl = selectTrustifyDABackend(opts);
175
205
  return await analysis.requestImages(imageRefs, theUrl, html, opts);
176
206
  }
207
+ /**
208
+ * Max concurrent SBOM generations for batch workspace analysis. Env/opts override default 10.
209
+ * @param {Options} opts
210
+ * @returns {number}
211
+ * @private
212
+ */
213
+ function resolveBatchConcurrency(opts) {
214
+ const fromEnv = getCustom('TRUSTIFY_DA_BATCH_CONCURRENCY', null, opts);
215
+ const raw = opts.batchConcurrency ?? fromEnv ?? '10';
216
+ const n = typeof raw === 'number' ? raw : parseInt(String(raw), 10);
217
+ if (!Number.isFinite(n) || n < 1) {
218
+ return 10;
219
+ }
220
+ return Math.min(256, n);
221
+ }
222
+ /**
223
+ * @param {string} root
224
+ * @param {'javascript' | 'cargo' | 'unknown'} ecosystem
225
+ * @param {number} totalSbomAttempts
226
+ * @param {number} successfulSbomCount
227
+ * @param {Array<{ manifestPath: string, phase: 'validation' | 'sbom', reason: string }>} errors
228
+ * @returns {BatchAnalysisMetadata}
229
+ * @private
230
+ */
231
+ function buildBatchAnalysisMetadata(root, ecosystem, totalSbomAttempts, successfulSbomCount, errors) {
232
+ return {
233
+ workspaceRoot: root,
234
+ ecosystem,
235
+ total: totalSbomAttempts,
236
+ successful: successfulSbomCount,
237
+ failed: errors.length,
238
+ errors: [...errors],
239
+ };
240
+ }
241
+ /**
242
+ * Generate a CycloneDX SBOM from a manifest file. No backend HTTP request is made.
243
+ *
244
+ * @param {string} manifestPath - path to the manifest file (e.g. pom.xml, package.json)
245
+ * @param {Options} [opts={}] - optional options (e.g. workspace dir, tool paths)
246
+ * @returns {Promise<object>} parsed CycloneDX SBOM JSON object
247
+ * @throws {Error} if the manifest is unsupported or SBOM generation fails
248
+ */
249
+ export async function generateSbom(manifestPath, opts = {}) {
250
+ fs.accessSync(manifestPath, fs.constants.R_OK);
251
+ const result = await generateOneSbom(manifestPath, opts);
252
+ if (!result.ok) {
253
+ throw new Error(`Failed to generate SBOM for ${result.manifestPath}: ${result.reason}`);
254
+ }
255
+ return result.sbom;
256
+ }
257
+ /**
258
+ * @typedef {{ ok: true, purl: string, sbom: object } | { ok: false, manifestPath: string, reason: string }} SbomResult
259
+ */
260
+ /**
261
+ * Generate an SBOM for a single manifest, returning a normalized result.
262
+ *
263
+ * @param {string} manifestPath
264
+ * @param {Options} workspaceOpts - opts with `TRUSTIFY_DA_WORKSPACE_DIR` set
265
+ * @returns {Promise<SbomResult>}
266
+ * @private
267
+ */
268
+ async function generateOneSbom(manifestPath, workspaceOpts) {
269
+ const provider = match(manifestPath, availableProviders, workspaceOpts);
270
+ const provided = await provider.provideStack(manifestPath, workspaceOpts);
271
+ const sbom = JSON.parse(provided.content);
272
+ const purl = sbom?.metadata?.component?.purl || sbom?.metadata?.component?.['bom-ref'];
273
+ if (!purl) {
274
+ return { ok: false, manifestPath, reason: 'missing purl in SBOM' };
275
+ }
276
+ return { ok: true, purl, sbom };
277
+ }
278
+ /**
279
+ * Detect the workspace ecosystem and discover manifest paths.
280
+ *
281
+ * @param {string} root - Resolved workspace root
282
+ * @param {Options} opts
283
+ * @returns {Promise<{ ecosystem: 'javascript' | 'cargo' | 'maven' | 'unknown', manifestPaths: string[] }>}
284
+ * @private
285
+ */
286
+ async function detectWorkspaceManifests(root, opts) {
287
+ const cargoToml = path.join(root, 'Cargo.toml');
288
+ const cargoLock = path.join(root, 'Cargo.lock');
289
+ const packageJson = path.join(root, 'package.json');
290
+ const pomXml = path.join(root, 'pom.xml');
291
+ if (fs.existsSync(cargoToml) && fs.existsSync(cargoLock)) {
292
+ return { ecosystem: 'cargo', manifestPaths: await discoverWorkspaceCrates(root, opts) };
293
+ }
294
+ if (fs.existsSync(pomXml)) {
295
+ const manifestPaths = await discoverMavenModules(root, opts);
296
+ if (manifestPaths.length > 0) {
297
+ return { ecosystem: 'maven', manifestPaths };
298
+ }
299
+ }
300
+ const hasJsLock = fs.existsSync(path.join(root, 'pnpm-lock.yaml'))
301
+ || fs.existsSync(path.join(root, 'yarn.lock'))
302
+ || fs.existsSync(path.join(root, 'package-lock.json'));
303
+ if (fs.existsSync(packageJson) && hasJsLock) {
304
+ let manifestPaths = await discoverWorkspacePackages(root, opts);
305
+ if (manifestPaths.length === 0) {
306
+ manifestPaths = [packageJson];
307
+ }
308
+ return { ecosystem: 'javascript', manifestPaths };
309
+ }
310
+ return { ecosystem: 'unknown', manifestPaths: [] };
311
+ }
312
+ /**
313
+ * Validate discovered JS package.json manifests, collecting errors.
314
+ *
315
+ * @param {string[]} manifestPaths
316
+ * @param {boolean} continueOnError
317
+ * @param {Array<{ manifestPath: string, phase: 'validation' | 'sbom', reason: string }>} collectedErrors - mutated in place
318
+ * @returns {{ validPaths: string[] }}
319
+ * @throws {Error} on first invalid manifest when `continueOnError` is false
320
+ * @private
321
+ */
322
+ function validateJsManifests(manifestPaths, continueOnError, collectedErrors) {
323
+ const validPaths = [];
324
+ for (const p of manifestPaths) {
325
+ const v = validatePackageJson(p);
326
+ if (v.valid) {
327
+ validPaths.push(p);
328
+ }
329
+ else {
330
+ collectedErrors.push({ manifestPath: p, phase: 'validation', reason: v.error });
331
+ console.warn(`Skipping invalid package.json (${v.error}): ${p}`);
332
+ if (!continueOnError) {
333
+ throw new Error(`Invalid package.json (${v.error}): ${p}`);
334
+ }
335
+ }
336
+ }
337
+ return { validPaths };
338
+ }
339
+ /**
340
+ * Generate SBOMs for all manifests. In fail-fast mode, stops on first error.
341
+ * In continue-on-error mode, runs concurrently and collects failures.
342
+ *
343
+ * @param {string[]} manifestPaths
344
+ * @param {Options} workspaceOpts
345
+ * @param {boolean} continueOnError
346
+ * @param {number} concurrency
347
+ * @param {Array<{ manifestPath: string, phase: 'validation' | 'sbom', reason: string }>} collectedErrors - mutated in place
348
+ * @returns {Promise<Object.<string, object>>} sbomByPurl map
349
+ * @throws {Error} on first SBOM failure when `continueOnError` is false
350
+ * @private
351
+ */
352
+ async function generateSboms(manifestPaths, workspaceOpts, continueOnError, concurrency, collectedErrors) {
353
+ /** @type {SbomResult[]} */
354
+ const results = [];
355
+ if (!continueOnError) {
356
+ for (const manifestPath of manifestPaths) {
357
+ const result = await generateOneSbom(manifestPath, workspaceOpts);
358
+ if (!result.ok) {
359
+ collectedErrors.push({ manifestPath: result.manifestPath, phase: 'sbom', reason: result.reason });
360
+ throw new Error(`${result.manifestPath}: ${result.reason}`);
361
+ }
362
+ results.push(result);
363
+ }
364
+ }
365
+ else {
366
+ const limit = pLimit(concurrency);
367
+ const settled = await Promise.all(manifestPaths.map(manifestPath => limit(async () => {
368
+ try {
369
+ return await generateOneSbom(manifestPath, workspaceOpts);
370
+ }
371
+ catch (err) {
372
+ const msg = err instanceof Error ? err.message : String(err);
373
+ if (process.env["TRUSTIFY_DA_DEBUG"] === "true") {
374
+ console.log(`Skipping ${manifestPath}: ${msg}`);
375
+ }
376
+ return { ok: false, manifestPath, reason: msg };
377
+ }
378
+ })));
379
+ for (const r of settled) {
380
+ results.push(r);
381
+ if (!r.ok) {
382
+ collectedErrors.push({ manifestPath: r.manifestPath, phase: 'sbom', reason: r.reason });
383
+ }
384
+ }
385
+ }
386
+ const sbomByPurl = {};
387
+ for (const r of results) {
388
+ if (r.ok) {
389
+ sbomByPurl[r.purl] = r.sbom;
390
+ }
391
+ }
392
+ return sbomByPurl;
393
+ }
394
+ /**
395
+ * Create an Error with optional `batchMetadata` attached.
396
+ * @param {string} message
397
+ * @param {boolean} wantMetadata
398
+ * @param {BatchAnalysisMetadata} [metadata]
399
+ * @returns {Error}
400
+ * @private
401
+ */
402
+ function batchError(message, wantMetadata, metadata) {
403
+ const err = new Error(message);
404
+ if (wantMetadata && metadata) {
405
+ err.batchMetadata = metadata;
406
+ }
407
+ return err;
408
+ }
409
+ /**
410
+ * @overload
411
+ * @param {string} workspaceRoot
412
+ * @param {true} html
413
+ * @param {Options & { batchMetadata: true }} opts
414
+ * @returns {Promise<{ analysis: string, metadata: BatchAnalysisMetadata }>}
415
+ * @throws {Error}
416
+ */
417
+ /**
418
+ * @overload
419
+ * @param {string} workspaceRoot
420
+ * @param {true} html
421
+ * @param {Options & { batchMetadata?: false }} [opts={}]
422
+ * @returns {Promise<string>}
423
+ * @throws {Error}
424
+ */
425
+ /**
426
+ * @overload
427
+ * @param {string} workspaceRoot
428
+ * @param {false} html
429
+ * @param {Options & { batchMetadata: true }} opts
430
+ * @returns {Promise<{ analysis: Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>, metadata: BatchAnalysisMetadata }>}
431
+ * @throws {Error}
432
+ */
433
+ /**
434
+ * @overload
435
+ * @param {string} workspaceRoot
436
+ * @param {false} html
437
+ * @param {Options & { batchMetadata?: false }} [opts={}]
438
+ * @returns {Promise<Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>>}
439
+ * @throws {Error}
440
+ */
441
+ /**
442
+ * Get stack analysis for all workspace packages/crates (batch).
443
+ * Detects ecosystem from workspace root: Cargo (Cargo.toml + Cargo.lock) or JS/TS (package.json + lock file).
444
+ * SBOMs are generated in parallel (see `batchConcurrency`) unless `continueOnError: false` (fail-fast sequential).
445
+ * With `opts.batchMetadata` / `TRUSTIFY_DA_BATCH_METADATA`, returns `{ analysis, metadata }` including validation and SBOM errors.
446
+ *
447
+ * @overload
448
+ * @param {string} workspaceRoot - Path to workspace root (containing lock file and workspace config)
449
+ * @param {boolean} [html=false] - true returns HTML, false returns JSON report
450
+ * @param {Options} [opts={}] - `batchConcurrency`, discovery ignores, `continueOnError` (default true), `batchMetadata` (default false)
451
+ * @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 }>}
452
+ * @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.
453
+ */
454
+ async function stackAnalysisBatch(workspaceRoot, html = false, opts = {}) {
455
+ const theUrl = selectTrustifyDABackend(opts);
456
+ const root = path.resolve(workspaceRoot);
457
+ fs.accessSync(root, fs.constants.R_OK);
458
+ const continueOnError = resolveContinueOnError(opts);
459
+ const wantMetadata = resolveBatchMetadata(opts);
460
+ /** @type {Array<{ manifestPath: string, phase: 'validation' | 'sbom', reason: string }>} */
461
+ const collectedErrors = [];
462
+ const { ecosystem, manifestPaths: discovered } = await detectWorkspaceManifests(root, opts);
463
+ let manifestPaths = discovered;
464
+ if (ecosystem === 'javascript') {
465
+ try {
466
+ const { validPaths } = validateJsManifests(manifestPaths, continueOnError, collectedErrors);
467
+ manifestPaths = validPaths;
468
+ }
469
+ catch (err) {
470
+ throw batchError(err.message, wantMetadata, buildBatchAnalysisMetadata(root, ecosystem, 0, 0, collectedErrors));
471
+ }
472
+ if (manifestPaths.length === 0 && discovered.length > 0) {
473
+ const detail = collectedErrors.map(e => `${e.manifestPath}: ${e.reason}`).join('; ');
474
+ throw batchError(`No valid packages after validation at ${root}. ${detail}`, wantMetadata, buildBatchAnalysisMetadata(root, ecosystem, 0, 0, collectedErrors));
475
+ }
476
+ }
477
+ if (manifestPaths.length === 0) {
478
+ throw new Error(`No workspace manifests found at ${root}. Ensure Cargo.toml+Cargo.lock or package.json+lock file exist.`);
479
+ }
480
+ const workspaceOpts = { ...opts, TRUSTIFY_DA_WORKSPACE_DIR: root };
481
+ const concurrency = resolveBatchConcurrency(opts);
482
+ let sbomByPurl;
483
+ try {
484
+ sbomByPurl = await generateSboms(manifestPaths, workspaceOpts, continueOnError, concurrency, collectedErrors);
485
+ }
486
+ catch (err) {
487
+ throw batchError(err.message, wantMetadata, buildBatchAnalysisMetadata(root, ecosystem, manifestPaths.length, 0, collectedErrors));
488
+ }
489
+ if (Object.keys(sbomByPurl).length === 0) {
490
+ throw batchError(`No valid SBOMs produced from ${manifestPaths.length} manifest(s) at ${root}`, wantMetadata, buildBatchAnalysisMetadata(root, ecosystem, manifestPaths.length, 0, collectedErrors));
491
+ }
492
+ const analysisResult = await analysis.requestStackBatch(sbomByPurl, theUrl, html, opts);
493
+ const meta = buildBatchAnalysisMetadata(root, ecosystem, manifestPaths.length, Object.keys(sbomByPurl).length, collectedErrors);
494
+ if (wantMetadata) {
495
+ return { analysis: analysisResult, metadata: meta };
496
+ }
497
+ return analysisResult;
498
+ }
177
499
  /**
178
500
  * Validates the Exhort token.
179
501
  * @param {Options} [opts={}] - Optional parameters, potentially including token override.
@@ -0,0 +1,28 @@
1
+ /**
2
+ * Run full license check: resolve project license (with backend identification and details),
3
+ * get dependency licenses from analysis report, and compute incompatibilities.
4
+ *
5
+ * @param {string} sbomContent - CycloneDX SBOM JSON string (the one sent for component analysis)
6
+ * @param {string} manifestPath - path to manifest
7
+ * @param {string} url - the backend url to send the request to
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
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
+ */
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<{
13
+ projectLicense: {
14
+ manifest: any | null;
15
+ file: any | null;
16
+ mismatch: boolean;
17
+ };
18
+ incompatibleDependencies: Array<{
19
+ purl: string;
20
+ licenses: string[];
21
+ category?: string;
22
+ reason: string;
23
+ }>;
24
+ error?: string;
25
+ }>;
26
+ export { getCompatibility } from "./license_utils.js";
27
+ export { getProjectLicense, findLicenseFilePath, identifyLicense } from "./project_license.js";
28
+ export { licensesFromReport, normalizeLicensesResponse, getLicenseDetails } from "./licenses_api.js";
@@ -0,0 +1,100 @@
1
+ /**
2
+ * License resolution and dependency license compatibility for component analysis.
3
+ */
4
+ import { getProjectLicense, findLicenseFilePath, identifyLicense } from './project_license.js';
5
+ import { licensesFromReport, getLicenseDetails } from './licenses_api.js';
6
+ import { getCompatibility } from './license_utils.js';
7
+ export { getProjectLicense, findLicenseFilePath, identifyLicense } from './project_license.js';
8
+ export { licensesFromReport, normalizeLicensesResponse, getLicenseDetails } from './licenses_api.js';
9
+ export { getCompatibility } from './license_utils.js';
10
+ /**
11
+ * Run full license check: resolve project license (with backend identification and details),
12
+ * get dependency licenses from analysis report, and compute incompatibilities.
13
+ *
14
+ * @param {string} sbomContent - CycloneDX SBOM JSON string (the one sent for component analysis)
15
+ * @param {string} manifestPath - path to manifest
16
+ * @param {string} url - the backend url to send the request to
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
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
+ */
21
+ export async function runLicenseCheck(sbomContent, manifestPath, url, opts = {}, analysisResult = null) {
22
+ // Resolve project license from manifest and LICENSE file
23
+ const projectLicense = getProjectLicense(manifestPath);
24
+ // Try backend identification for LICENSE file (more accurate than local pattern matching)
25
+ const licenseFilePath = findLicenseFilePath(manifestPath);
26
+ let backendFileId = null;
27
+ if (licenseFilePath) {
28
+ try {
29
+ backendFileId = await identifyLicense(licenseFilePath, { ...opts, TRUSTIFY_DA_BACKEND_URL: url });
30
+ }
31
+ catch {
32
+ // Fall back to local detection
33
+ }
34
+ }
35
+ // Determine final license identifiers
36
+ const manifestSpdx = projectLicense.fromManifest;
37
+ const fileSpdx = backendFileId || projectLicense.fromFile;
38
+ const mismatch = Boolean(manifestSpdx && fileSpdx && manifestSpdx.toLowerCase() !== fileSpdx.toLowerCase());
39
+ // Fetch detailed license info from backend (avoid duplicate calls if same license)
40
+ const licenseDetailsCache = new Map();
41
+ async function getDetails(spdxId) {
42
+ if (!spdxId || !url)
43
+ return null;
44
+ if (licenseDetailsCache.has(spdxId))
45
+ return licenseDetailsCache.get(spdxId);
46
+ try {
47
+ const details = await getLicenseDetails(spdxId, { ...opts, TRUSTIFY_DA_BACKEND_URL: url });
48
+ licenseDetailsCache.set(spdxId, details);
49
+ return details;
50
+ }
51
+ catch {
52
+ return null;
53
+ }
54
+ }
55
+ const manifestLicenseInfo = await getDetails(manifestSpdx);
56
+ const fileLicenseInfo = await getDetails(fileSpdx);
57
+ // Extract dependency purls from SBOM (exclude root component)
58
+ const sbomObj = typeof sbomContent === 'string' ? JSON.parse(sbomContent) : sbomContent;
59
+ const rootRef = sbomObj?.metadata?.component?.["bom-ref"] || sbomObj?.metadata?.component?.purl;
60
+ const purls = (sbomObj?.components || [])
61
+ .map(c => c.purl || c["bom-ref"])
62
+ .filter(Boolean)
63
+ .filter(purl => !rootRef || purl !== rootRef);
64
+ if (purls.length === 0) {
65
+ return {
66
+ projectLicense: { manifest: manifestLicenseInfo, file: fileLicenseInfo, mismatch },
67
+ incompatibleDependencies: []
68
+ };
69
+ }
70
+ // Get dependency licenses from analysis report
71
+ const licenseByPurl = licensesFromReport(analysisResult, purls);
72
+ if (licenseByPurl.size === 0 && analysisResult) {
73
+ return {
74
+ projectLicense: { manifest: manifestLicenseInfo, file: fileLicenseInfo, mismatch },
75
+ incompatibleDependencies: [],
76
+ error: 'No license data available in analysis report'
77
+ };
78
+ }
79
+ // Check compatibility for each dependency
80
+ const projectCategory = manifestLicenseInfo?.category || fileLicenseInfo?.category;
81
+ const incompatibleDependencies = [];
82
+ for (const purl of purls) {
83
+ const entry = licenseByPurl.get(purl);
84
+ if (!entry)
85
+ continue;
86
+ const status = getCompatibility(projectCategory, entry.category);
87
+ if (status === 'incompatible') {
88
+ incompatibleDependencies.push({
89
+ purl,
90
+ licenses: entry.licenses,
91
+ category: entry.category,
92
+ reason: 'Dependency license(s) are incompatible with the project license.'
93
+ });
94
+ }
95
+ }
96
+ return {
97
+ projectLicense: { manifest: manifestLicenseInfo, file: fileLicenseInfo, mismatch },
98
+ incompatibleDependencies
99
+ };
100
+ }
@@ -0,0 +1,40 @@
1
+ /**
2
+ * Find LICENSE file path in the same directory as the manifest.
3
+ * @param {string} manifestPath
4
+ * @returns {string|null} - path to LICENSE file or null if not found
5
+ */
6
+ export function findLicenseFilePath(manifestPath: string): string | null;
7
+ /**
8
+ * Very simple SPDX detection from common license text (first ~500 chars).
9
+ * @param {string} text
10
+ * @returns {string|null}
11
+ */
12
+ export function detectSpdxFromText(text: string): string | null;
13
+ /**
14
+ * Read LICENSE file and detect SPDX identifier.
15
+ * @param {string} manifestPath - path to manifest
16
+ * @returns {string|null} - SPDX identifier from LICENSE file or null
17
+ */
18
+ export function readLicenseFile(manifestPath: string): string | null;
19
+ /**
20
+ * Get project license from manifest or LICENSE file.
21
+ * Returns manifestLicense if provided, otherwise tries LICENSE file.
22
+ * @param {string|null} manifestLicense - license from manifest (or null)
23
+ * @param {string} manifestPath - path to manifest
24
+ * @returns {string|null} - SPDX identifier or null
25
+ */
26
+ export function getLicense(manifestLicense: string | null, manifestPath: string): string | null;
27
+ /**
28
+ * Normalize SPDX identifier for comparison (lowercase, strip common suffixes).
29
+ * @param {string} spdxOrName
30
+ * @returns {string}
31
+ */
32
+ export function normalizeSpdx(spdxOrName: string): string;
33
+ /**
34
+ * Check if a dependency's license is compatible with the project license based on backend categories.
35
+ *
36
+ * @param {string} [projectCategory] - backend category for project license: PERMISSIVE | WEAK_COPYLEFT | STRONG_COPYLEFT | UNKNOWN
37
+ * @param {string} [dependencyCategory] - backend category for dependency license: PERMISSIVE | WEAK_COPYLEFT | STRONG_COPYLEFT | UNKNOWN
38
+ * @returns {'compatible'|'incompatible'|'unknown'}
39
+ */
40
+ export function getCompatibility(projectCategory?: string, dependencyCategory?: string): "compatible" | "incompatible" | "unknown";
@@ -0,0 +1,134 @@
1
+ /**
2
+ * License utilities: file reading, SPDX detection, normalization, compatibility.
3
+ * This module has NO dependencies on providers or backend to avoid circular dependencies.
4
+ */
5
+ import fs from 'node:fs';
6
+ import path from 'node:path';
7
+ const LICENSE_FILES = ['LICENSE', 'LICENSE.md', 'LICENSE.txt'];
8
+ /**
9
+ * Find LICENSE file path in the same directory as the manifest.
10
+ * @param {string} manifestPath
11
+ * @returns {string|null} - path to LICENSE file or null if not found
12
+ */
13
+ export function findLicenseFilePath(manifestPath) {
14
+ const manifestDir = path.dirname(path.resolve(manifestPath));
15
+ for (const name of LICENSE_FILES) {
16
+ const filePath = path.join(manifestDir, name);
17
+ try {
18
+ if (fs.statSync(filePath).isFile()) {
19
+ return filePath;
20
+ }
21
+ }
22
+ catch {
23
+ // skip
24
+ }
25
+ }
26
+ return null;
27
+ }
28
+ /**
29
+ * Very simple SPDX detection from common license text (first ~500 chars).
30
+ * @param {string} text
31
+ * @returns {string|null}
32
+ */
33
+ export function detectSpdxFromText(text) {
34
+ const head = text.slice(0, 500);
35
+ if (/Apache License,?\s*Version 2\.0/i.test(head)) {
36
+ return 'Apache-2.0';
37
+ }
38
+ if (/MIT License/i.test(head) && /Permission is hereby granted/i.test(head)) {
39
+ return 'MIT';
40
+ }
41
+ if (/GNU AFFERO GENERAL PUBLIC LICENSE\s+Version 3/i.test(head)) {
42
+ return 'AGPL-3.0-only';
43
+ }
44
+ if (/GNU LESSER GENERAL PUBLIC LICENSE\s+Version 3/i.test(head)) {
45
+ return 'LGPL-3.0-only';
46
+ }
47
+ if (/GNU LESSER GENERAL PUBLIC LICENSE\s+Version 2\.1/i.test(head)) {
48
+ return 'LGPL-2.1-only';
49
+ }
50
+ if (/GNU GENERAL PUBLIC LICENSE\s+Version 2/i.test(head)) {
51
+ return 'GPL-2.0-only';
52
+ }
53
+ if (/GNU GENERAL PUBLIC LICENSE\s+Version 3/i.test(head)) {
54
+ return 'GPL-3.0-only';
55
+ }
56
+ if (/BSD 2-Clause/i.test(head)) {
57
+ return 'BSD-2-Clause';
58
+ }
59
+ if (/BSD 3-Clause/i.test(head)) {
60
+ return 'BSD-3-Clause';
61
+ }
62
+ return null;
63
+ }
64
+ /**
65
+ * Read LICENSE file and detect SPDX identifier.
66
+ * @param {string} manifestPath - path to manifest
67
+ * @returns {string|null} - SPDX identifier from LICENSE file or null
68
+ */
69
+ export function readLicenseFile(manifestPath) {
70
+ const licenseFilePath = findLicenseFilePath(manifestPath);
71
+ if (!licenseFilePath) {
72
+ return null;
73
+ }
74
+ try {
75
+ const content = fs.readFileSync(licenseFilePath, 'utf-8');
76
+ return detectSpdxFromText(content) || content.split('\n')[0]?.trim() || null;
77
+ }
78
+ catch {
79
+ return null;
80
+ }
81
+ }
82
+ /**
83
+ * Get project license from manifest or LICENSE file.
84
+ * Returns manifestLicense if provided, otherwise tries LICENSE file.
85
+ * @param {string|null} manifestLicense - license from manifest (or null)
86
+ * @param {string} manifestPath - path to manifest
87
+ * @returns {string|null} - SPDX identifier or null
88
+ */
89
+ export function getLicense(manifestLicense, manifestPath) {
90
+ return manifestLicense || readLicenseFile(manifestPath) || null;
91
+ }
92
+ /**
93
+ * Normalize SPDX identifier for comparison (lowercase, strip common suffixes).
94
+ * @param {string} spdxOrName
95
+ * @returns {string}
96
+ */
97
+ export function normalizeSpdx(spdxOrName) {
98
+ const s = String(spdxOrName).trim().toLowerCase();
99
+ if (s.endsWith(' license')) {
100
+ return s.slice(0, -8);
101
+ }
102
+ return s;
103
+ }
104
+ /**
105
+ * Check if a dependency's license is compatible with the project license based on backend categories.
106
+ *
107
+ * @param {string} [projectCategory] - backend category for project license: PERMISSIVE | WEAK_COPYLEFT | STRONG_COPYLEFT | UNKNOWN
108
+ * @param {string} [dependencyCategory] - backend category for dependency license: PERMISSIVE | WEAK_COPYLEFT | STRONG_COPYLEFT | UNKNOWN
109
+ * @returns {'compatible'|'incompatible'|'unknown'}
110
+ */
111
+ export function getCompatibility(projectCategory, dependencyCategory) {
112
+ if (!projectCategory || !dependencyCategory) {
113
+ return 'unknown';
114
+ }
115
+ const proj = projectCategory.toUpperCase();
116
+ const dep = dependencyCategory.toUpperCase();
117
+ if (proj === 'UNKNOWN' || dep === 'UNKNOWN') {
118
+ return 'unknown';
119
+ }
120
+ const restrictiveness = {
121
+ 'PERMISSIVE': 1,
122
+ 'WEAK_COPYLEFT': 2,
123
+ 'STRONG_COPYLEFT': 3
124
+ };
125
+ const projLevel = restrictiveness[proj];
126
+ const depLevel = restrictiveness[dep];
127
+ if (projLevel === undefined || depLevel === undefined) {
128
+ return 'unknown';
129
+ }
130
+ if (depLevel > projLevel) {
131
+ return 'incompatible';
132
+ }
133
+ return 'compatible';
134
+ }