@trustify-da/trustify-da-javascript-client 0.3.0-ea.b8af0f8 → 0.3.0-ea.bbe2094

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 (52) hide show
  1. package/README.md +73 -8
  2. package/dist/package.json +6 -5
  3. package/dist/src/analysis.js +3 -2
  4. package/dist/src/cli.js +51 -2
  5. package/dist/src/cyclone_dx_sbom.d.ts +14 -1
  6. package/dist/src/cyclone_dx_sbom.js +32 -5
  7. package/dist/src/index.d.ts +74 -3
  8. package/dist/src/index.js +89 -6
  9. package/dist/src/oci_image/utils.js +11 -2
  10. package/dist/src/provider.js +8 -0
  11. package/dist/src/providers/base_java.d.ts +0 -9
  12. package/dist/src/providers/base_java.js +2 -38
  13. package/dist/src/providers/base_javascript.d.ts +6 -0
  14. package/dist/src/providers/base_javascript.js +37 -6
  15. package/dist/src/providers/base_pyproject.d.ts +153 -0
  16. package/dist/src/providers/base_pyproject.js +315 -0
  17. package/dist/src/providers/golang_gomodules.d.ts +21 -12
  18. package/dist/src/providers/golang_gomodules.js +164 -118
  19. package/dist/src/providers/gomod_parser.d.ts +4 -0
  20. package/dist/src/providers/gomod_parser.js +16 -0
  21. package/dist/src/providers/java_gradle.d.ts +19 -0
  22. package/dist/src/providers/java_gradle.js +116 -2
  23. package/dist/src/providers/java_maven.d.ts +8 -0
  24. package/dist/src/providers/java_maven.js +93 -1
  25. package/dist/src/providers/javascript_bun.d.ts +10 -0
  26. package/dist/src/providers/javascript_bun.js +100 -0
  27. package/dist/src/providers/javascript_npm.d.ts +1 -0
  28. package/dist/src/providers/javascript_npm.js +21 -0
  29. package/dist/src/providers/javascript_pnpm.js +6 -2
  30. package/dist/src/providers/manifest.d.ts +2 -0
  31. package/dist/src/providers/manifest.js +22 -4
  32. package/dist/src/providers/marker_evaluator.d.ts +14 -0
  33. package/dist/src/providers/marker_evaluator.js +191 -0
  34. package/dist/src/providers/processors/yarn_berry_processor.js +88 -5
  35. package/dist/src/providers/python_controller.d.ts +5 -1
  36. package/dist/src/providers/python_controller.js +8 -4
  37. package/dist/src/providers/python_pip.d.ts +4 -0
  38. package/dist/src/providers/python_pip.js +5 -5
  39. package/dist/src/providers/python_pip_pyproject.d.ts +61 -0
  40. package/dist/src/providers/python_pip_pyproject.js +146 -0
  41. package/dist/src/providers/python_poetry.d.ts +75 -0
  42. package/dist/src/providers/python_poetry.js +238 -0
  43. package/dist/src/providers/python_uv.d.ts +55 -0
  44. package/dist/src/providers/python_uv.js +227 -0
  45. package/dist/src/providers/tree-sitter-gomod.wasm +0 -0
  46. package/dist/src/sbom.d.ts +14 -1
  47. package/dist/src/sbom.js +13 -2
  48. package/dist/src/tools.d.ts +26 -0
  49. package/dist/src/tools.js +58 -0
  50. package/dist/src/workspace.d.ts +9 -0
  51. package/dist/src/workspace.js +1 -1
  52. package/package.json +7 -6
package/README.md CHANGED
@@ -224,7 +224,8 @@ $ trustify-da-javascript-client license /path/to/package.json
224
224
  <li><a href="https://www.javascript.com/">JavaScript</a> - <a href="https://pnpm.io/">pnpm</a></li>
225
225
  <li><a href="https://www.javascript.com/">JavaScript</a> - <a href="https://classic.yarnpkg.com/">Yarn Classic</a> / <a href="https://yarnpkg.com/">Yarn Berry</a></li>
226
226
  <li><a href="https://go.dev/">Golang</a> - <a href="https://go.dev/blog/using-go-modules/">Go Modules</a></li>
227
- <li><a href="https://www.python.org/">Python</a> - <a href="https://pypi.org/project/pip/">pip Installer</a></li>
227
+ <li><a href="https://www.python.org/">Python</a> - <a href="https://pypi.org/project/pip/">pip Installer</a> (<code>requirements.txt</code>)</li>
228
+ <li><a href="https://www.python.org/">Python</a> - <a href="https://python-poetry.org/">Poetry</a> / <a href="https://docs.astral.sh/uv/">uv</a> (<code>pyproject.toml</code>)</li>
228
229
  <li><a href="https://gradle.org/">Gradle (Groovy and Kotlin DSL)</a> - <a href="https://gradle.org/install/">Gradle Installation</a></li>
229
230
  <li><a href="https://www.rust-lang.org/">Rust</a> - <a href="https://doc.rust-lang.org/cargo/">Cargo</a></li>
230
231
  </ul>
@@ -287,8 +288,11 @@ Excluding a package from any analysis can be achieved by marking the package for
287
288
  ]
288
289
  }
289
290
  ```
291
+ </li>
292
+
293
+ <li>
294
+ <em>Golang</em> users can add in go.mod a comment with <code>// exhortignore</code> next to the package to be ignored, or to "piggyback" on existing comment ( e.g - <code>// indirect</code>), for example:
290
295
 
291
- <em>Golang</em> users can add in go.mod a comment with //exhortignore next to the package to be ignored, or to "piggyback" on existing comment ( e.g - //indirect) , for example:
292
296
  ```go
293
297
  module github.com/trustify-da/SaaSi/deployer
294
298
 
@@ -297,7 +301,7 @@ go 1.19
297
301
  require (
298
302
  github.com/gin-gonic/gin v1.9.1
299
303
  github.com/google/uuid v1.1.2
300
- github.com/jessevdk/go-flags v1.5.0 //exhortignore
304
+ github.com/jessevdk/go-flags v1.5.0 // exhortignore
301
305
  github.com/kr/pretty v0.3.1
302
306
  gopkg.in/yaml.v2 v2.4.0
303
307
  k8s.io/apimachinery v0.26.1
@@ -305,14 +309,20 @@ require (
305
309
  )
306
310
 
307
311
  require (
308
- github.com/davecgh/go-spew v1.1.1 // indirect exhortignore
312
+ github.com/davecgh/go-spew v1.1.1 // indirect; exhortignore
309
313
  github.com/emicklei/go-restful/v3 v3.9.0 // indirect
310
- github.com/go-logr/logr v1.2.3 // indirect //exhortignore
314
+ github.com/go-logr/logr v1.2.3 // indirect; exhortignore
311
315
 
312
316
  )
313
317
  ```
314
318
 
319
+ <b>NOTE</b>: It is important to format <code>exhortignore</code> markers on indirect dependencies as shown above, otherwise the Go tooling (as well as this library) may incorrectly parse dependencies marked as indirect as being direct dependencies instead.
320
+ </li>
321
+
322
+
323
+ <li>
315
324
  <em>Python pip</em> users can add in requirements.txt a comment with #exhortignore(or # exhortignore) to the right of the same artifact to be ignored, for example:
325
+
316
326
  ```properties
317
327
  anyio==3.6.2
318
328
  asgiref==3.4.1
@@ -343,11 +353,14 @@ Werkzeug==2.0.3
343
353
  zipp==3.6.0
344
354
 
345
355
  ```
356
+ </li>
346
357
 
358
+ <li>
347
359
  <em>Gradle</em> users can add in build.gradle a comment with //exhortignore next to the package to be ignored:
360
+
348
361
  ```build.gradle
349
362
  plugins {
350
- id 'java'
363
+ id 'java'
351
364
  }
352
365
 
353
366
  group = 'groupName'
@@ -379,9 +392,31 @@ version = "1.10"
379
392
  log = "0.4" # trustify-da-ignore
380
393
  ```
381
394
 
382
- All of the 6 above examples are valid for marking a package to be ignored
383
- </li>
384
395
 
396
+ <em>Python pyproject.toml</em> users can add a comment with <code>#exhortignore</code> (or <code># trustify-da-ignore</code>) next to the dependency in <code>pyproject.toml</code>.
397
+
398
+ PEP 621 style (<code>[project]</code> dependencies):
399
+ ```toml
400
+ [project]
401
+ dependencies = [
402
+ "flask>=2.0.3",
403
+ "requests>=2.25.1",
404
+ "uvicorn>=0.17.0", #exhortignore
405
+ "click>=8.0.4", # trustify-da-ignore
406
+ ]
407
+ ```
408
+
409
+ Poetry style (<code>[tool.poetry.dependencies]</code>):
410
+ ```toml
411
+ [tool.poetry.dependencies]
412
+ flask = "^2.0.3"
413
+ requests = "^2.25.1"
414
+ uvicorn = "^0.17.0" #exhortignore
415
+ click = "^8.0.4" # trustify-da-ignore
416
+ ```
417
+
418
+ All of the above examples are valid for marking a package to be ignored
419
+ </li>
385
420
  </ul>
386
421
 
387
422
  <h3>Customization</h3>
@@ -410,6 +445,8 @@ let options = {
410
445
  'TRUSTIFY_DA_PIP3_PATH' : '/path/to/pip3',
411
446
  'TRUSTIFY_DA_PYTHON_PATH' : '/path/to/python',
412
447
  'TRUSTIFY_DA_PIP_PATH' : '/path/to/pip',
448
+ 'TRUSTIFY_DA_UV_PATH' : '/path/to/uv',
449
+ 'TRUSTIFY_DA_POETRY_PATH' : '/path/to/poetry',
413
450
  'TRUSTIFY_DA_GRADLE_PATH' : '/path/to/gradle',
414
451
  'TRUSTIFY_DA_CARGO_PATH' : '/path/to/cargo',
415
452
  // Workspace root for monorepos (Cargo, npm/pnpm/yarn); lock file expected here
@@ -556,6 +593,16 @@ following keys for setting custom paths for the said executables.
556
593
  <td>TRUSTIFY_DA_CARGO_PATH</td>
557
594
  </tr>
558
595
  <tr>
596
+ <td><a href="https://docs.astral.sh/uv/">uv</a></td>
597
+ <td><em>uv</em></td>
598
+ <td>TRUSTIFY_DA_UV_PATH</td>
599
+ </tr>
600
+ <tr>
601
+ <td><a href="https://python-poetry.org/">Poetry</a></td>
602
+ <td><em>poetry</em></td>
603
+ <td>TRUSTIFY_DA_POETRY_PATH</td>
604
+ </tr>
605
+ <tr>
559
606
  <td>Workspace root (monorepos)</td>
560
607
  <td>—</td>
561
608
  <td>workspaceDir / TRUSTIFY_DA_WORKSPACE_DIR</td>
@@ -608,6 +655,24 @@ TRUSTIFY_DA_GO_MVS_LOGIC_ENABLED=false
608
655
 
609
656
  #### Python Support
610
657
 
658
+ The client supports two Python manifest formats:
659
+
660
+ - **`requirements.txt`** — uses pip/pip3 to resolve dependencies
661
+ - **`pyproject.toml`** — uses [uv](https://docs.astral.sh/uv/) or [Poetry](https://python-poetry.org/) to resolve dependencies
662
+
663
+ ##### pyproject.toml
664
+
665
+ For `pyproject.toml` projects, the client detects which tool manages the project by checking for lock files:
666
+ - If `poetry.lock` is present and `[tool.poetry]` is defined, **Poetry** is used (`poetry show --tree` and `poetry show --all`)
667
+ - If `uv.lock` is present, **uv** is used (`uv export --format requirements.txt --frozen --no-hashes`)
668
+ - If neither lock file is found, an error is thrown
669
+
670
+ Both PEP 621 (`[project]` dependencies) and Poetry-style (`[tool.poetry.dependencies]`) are supported.
671
+
672
+ Custom executable paths can be set via `TRUSTIFY_DA_UV_PATH` and `TRUSTIFY_DA_POETRY_PATH`.
673
+
674
+ ##### requirements.txt
675
+
611
676
  By default, For python support, the api assumes that the package is installed using the pip/pip3 binary on the system PATH, or using the customized
612
677
  Binaries passed to environment variables. In any case, If the package is not installed , then an error will be thrown.
613
678
 
package/dist/package.json CHANGED
@@ -38,31 +38,32 @@
38
38
  "lint": "eslint src test --ext js",
39
39
  "lint:fix": "eslint src test --ext js --fix",
40
40
  "test": "c8 npm run tests",
41
- "tests": "mocha --config .mocharc.json --grep \".*analysis module.*\" --invert",
41
+ "tests": "mocha --config .mocharc.json",
42
42
  "tests:rep": "mocha --reporter-option maxDiffSize=0 --reporter json > unit-tests-result.json",
43
- "pretest": "cp node_modules/tree-sitter-requirements/tree-sitter-requirements.wasm src/providers/tree-sitter-requirements.wasm",
43
+ "pretest": "cp node_modules/tree-sitter-requirements/tree-sitter-requirements.wasm src/providers/tree-sitter-requirements.wasm && cp node_modules/tree-sitter-gomod/tree-sitter-gomod.wasm src/providers/tree-sitter-gomod.wasm",
44
44
  "precompile": "rm -rf dist",
45
45
  "compile": "tsc -p tsconfig.json",
46
46
  "compile:dev": "tsc -p tsconfig.dev.json",
47
- "postcompile": "cp node_modules/tree-sitter-requirements/tree-sitter-requirements.wasm dist/src/providers/tree-sitter-requirements.wasm"
47
+ "postcompile": "cp node_modules/tree-sitter-requirements/tree-sitter-requirements.wasm dist/src/providers/tree-sitter-requirements.wasm && cp node_modules/tree-sitter-gomod/tree-sitter-gomod.wasm dist/src/providers/tree-sitter-gomod.wasm"
48
48
  },
49
49
  "dependencies": {
50
50
  "@babel/core": "^7.23.2",
51
51
  "@cyclonedx/cyclonedx-library": "^6.13.0",
52
52
  "eslint-import-resolver-typescript": "^4.4.4",
53
53
  "fast-glob": "^3.3.3",
54
- "fast-toml": "^0.5.4",
55
54
  "fast-xml-parser": "^5.3.4",
56
55
  "help": "^3.0.2",
57
56
  "https-proxy-agent": "^7.0.6",
58
57
  "js-yaml": "^4.1.1",
58
+ "jsonc-parser": "^3.3.1",
59
59
  "micromatch": "^4.0.8",
60
60
  "node-fetch": "^3.3.2",
61
61
  "p-limit": "^4.0.0",
62
62
  "packageurl-js": "~1.0.2",
63
63
  "smol-toml": "^1.6.0",
64
+ "tree-sitter-gomod": "github:strum355/tree-sitter-go-mod#56326f2ad478892ace58ff247a97d492a3cbcdda",
64
65
  "tree-sitter-requirements": "github:Strum355/tree-sitter-requirements#d0261ee76b84253997fe70d7d397e78c006c3801",
65
- "web-tree-sitter": "^0.26.6",
66
+ "web-tree-sitter": "^0.26.7",
66
67
  "yargs": "^18.0.0"
67
68
  },
68
69
  "devDependencies": {
@@ -189,7 +189,7 @@ async function requestImages(imageRefs, url, html = false, opts = {}) {
189
189
  if (opts['TRUSTIFY_DA_RECOMMENDATIONS_ENABLED'] === 'false') {
190
190
  finalUrl.searchParams.append('recommend', 'false');
191
191
  }
192
- const resp = await fetch(finalUrl, {
192
+ const fetchOptions = addProxyAgent({
193
193
  method: 'POST',
194
194
  headers: {
195
195
  'Accept': html ? 'text/html' : 'application/json',
@@ -197,7 +197,8 @@ async function requestImages(imageRefs, url, html = false, opts = {}) {
197
197
  ...getTokenHeaders(opts)
198
198
  },
199
199
  body: JSON.stringify(imageSboms),
200
- });
200
+ }, opts);
201
+ const resp = await fetch(finalUrl, fetchOptions);
201
202
  if (resp.status === 200) {
202
203
  let result;
203
204
  if (!html) {
package/dist/src/cli.js CHANGED
@@ -1,9 +1,10 @@
1
1
  #!/usr/bin/env node
2
+ import fs from 'node:fs';
2
3
  import * as path from "path";
3
4
  import yargs from 'yargs';
4
5
  import { hideBin } from 'yargs/helpers';
5
6
  import { getProjectLicense, getLicenseDetails } from './license/index.js';
6
- import client, { selectTrustifyDABackend } from './index.js';
7
+ import client, { selectTrustifyDABackend, generateSbom } from './index.js';
7
8
  // command for component analysis take manifest type and content
8
9
  const component = {
9
10
  command: 'component </path/to/manifest>',
@@ -325,15 +326,63 @@ const license = {
325
326
  console.log(JSON.stringify(output, null, 2));
326
327
  }
327
328
  };
329
+ const sbom = {
330
+ command: 'sbom </path/to/manifest> [--output]',
331
+ desc: 'generate a CycloneDX SBOM from a manifest file',
332
+ builder: yargs => yargs.positional('/path/to/manifest', {
333
+ desc: 'manifest path for SBOM generation',
334
+ type: 'string',
335
+ normalize: true,
336
+ }).options({
337
+ output: {
338
+ alias: 'o',
339
+ desc: 'Write SBOM JSON to a file instead of stdout',
340
+ type: 'string',
341
+ normalize: true,
342
+ },
343
+ workspaceDir: {
344
+ alias: 'w',
345
+ desc: 'Workspace root directory (for monorepos; lock file is expected here)',
346
+ type: 'string',
347
+ normalize: true,
348
+ }
349
+ }),
350
+ handler: async (args) => {
351
+ let manifest = args['/path/to/manifest'];
352
+ const opts = args.workspaceDir ? { TRUSTIFY_DA_WORKSPACE_DIR: args.workspaceDir } : {};
353
+ let result;
354
+ try {
355
+ result = await generateSbom(manifest, opts);
356
+ }
357
+ catch (err) {
358
+ console.error(JSON.stringify({ error: `Failed to generate SBOM: ${err.message}` }, null, 2));
359
+ process.exit(1);
360
+ }
361
+ const json = JSON.stringify(result, null, 2);
362
+ if (args.output) {
363
+ try {
364
+ fs.writeFileSync(args.output, json);
365
+ }
366
+ catch (err) {
367
+ console.error(JSON.stringify({ error: `Failed to write output file: ${err.message}` }, null, 2));
368
+ process.exit(1);
369
+ }
370
+ }
371
+ else {
372
+ console.log(json);
373
+ }
374
+ }
375
+ };
328
376
  // parse and invoke the command
329
377
  yargs(hideBin(process.argv))
330
- .usage(`Usage: ${process.argv[0].includes("node") ? path.parse(process.argv[1]).base : path.parse(process.argv[0]).base} {component|stack|stack-batch|image|validate-token|license}`)
378
+ .usage(`Usage: ${process.argv[0].includes("node") ? path.parse(process.argv[1]).base : path.parse(process.argv[0]).base} {component|stack|stack-batch|image|validate-token|license|sbom}`)
331
379
  .command(stack)
332
380
  .command(stackBatch)
333
381
  .command(component)
334
382
  .command(image)
335
383
  .command(validateToken)
336
384
  .command(license)
385
+ .command(sbom)
337
386
  .scriptName('')
338
387
  .version(false)
339
388
  .demandCommand(1)
@@ -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) {
@@ -47,6 +48,10 @@ function getComponent(component, type, scope, licenses) {
47
48
  return lic;
48
49
  });
49
50
  }
51
+ // Add hashes if provided (CycloneDX 1.4 format).
52
+ if (hashes && hashes.length > 0) {
53
+ componentObject.hashes = hashes;
54
+ }
50
55
  return componentObject;
51
56
  }
52
57
  function createDependency(dependency) {
@@ -86,16 +91,24 @@ export default class CycloneDxSbom {
86
91
  * Adds a dependency relationship between two components in the SBOM
87
92
  * @param {PackageURL} sourceRef - The source component (parent)
88
93
  * @param {PackageURL} targetRef - The target component (dependency)
94
+ * @param {string} [scope] - Scope of the dependency
95
+ * @param {Array<{alg: string, content: string}>} [targetHashes] - Optional hashes for the target component
89
96
  * @return {CycloneDxSbom} The updated SBOM
90
97
  */
91
- addDependency(sourceRef, targetRef, scope) {
98
+ addDependency(sourceRef, targetRef, scope, targetHashes) {
92
99
  const sourcePurl = sourceRef.toString();
93
100
  const targetPurl = targetRef.toString();
94
101
  // Ensure both components exist in the components list
95
102
  [sourceRef, targetRef].forEach((ref, index) => {
96
103
  const purl = index === 0 ? sourcePurl : targetPurl;
97
- if (this.getComponentIndex(purl) < 0) {
98
- this.components.push(getComponent(ref, "library", scope));
104
+ const existingIndex = this.getComponentIndex(purl);
105
+ if (existingIndex < 0) {
106
+ const hashes = index === 1 ? targetHashes : undefined;
107
+ this.components.push(getComponent(ref, "library", scope, undefined, hashes));
108
+ }
109
+ else if (index === 1 && targetHashes && targetHashes.length > 0 && !this.components[existingIndex].hashes) {
110
+ // Update hashes if the component was first seen without them (e.g. as a source)
111
+ this.components[existingIndex].hashes = targetHashes;
99
112
  }
100
113
  });
101
114
  // Ensure source dependency exists
@@ -242,6 +255,20 @@ export default class CycloneDxSbom {
242
255
  return false;
243
256
  }
244
257
  }
258
+ /**
259
+ * Checks if any entry in the dependsOn list of sourceRef starts with the given purl prefix.
260
+ * @param {PackageURL} sourceRef - The source component
261
+ * @param {string} purlPrefix - The purl prefix to match (e.g. "pkg:npm/minimist@")
262
+ * @return {boolean}
263
+ */
264
+ checkDependsOnByPurlPrefix(sourceRef, purlPrefix) {
265
+ const sourcePurl = sourceRef.toString();
266
+ const depIndex = this.getDependencyIndex(sourcePurl);
267
+ if (depIndex < 0) {
268
+ return false;
269
+ }
270
+ return this.dependencies[depIndex].dependsOn.some(dep => dep.startsWith(purlPrefix));
271
+ }
245
272
  /** Removes the root component from the sbom
246
273
  */
247
274
  removeRootComponent() {
@@ -13,6 +13,15 @@ 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";
18
27
  declare namespace _default {
@@ -21,6 +30,7 @@ declare namespace _default {
21
30
  export { stackAnalysisBatch };
22
31
  export { imageAnalysis };
23
32
  export { validateToken };
33
+ export { generateSbom };
24
34
  }
25
35
  export default _default;
26
36
  export type Options = {
@@ -64,11 +74,13 @@ export type Options = {
64
74
  TRUSTIFY_DA_CONTINUE_ON_ERROR?: string | undefined;
65
75
  batchMetadata?: boolean | undefined;
66
76
  TRUSTIFY_DA_BATCH_METADATA?: string | undefined;
77
+ TRUSTIFY_DA_UV_PATH?: string | undefined;
78
+ TRUSTIFY_DA_POETRY_PATH?: string | undefined;
67
79
  [key: string]: string | number | boolean | string[] | undefined;
68
80
  };
69
81
  export type BatchAnalysisMetadata = {
70
82
  workspaceRoot: string;
71
- ecosystem: "javascript" | "cargo" | "unknown";
83
+ ecosystem: "javascript" | "cargo" | "pyproject" | "unknown";
72
84
  total: number;
73
85
  successful: number;
74
86
  failed: number;
@@ -124,19 +136,74 @@ declare function stackAnalysis(manifest: string, html: false, opts?: Options | u
124
136
  * or backend request failed
125
137
  */
126
138
  declare function stackAnalysis(manifest: string, html?: boolean | undefined, opts?: Options | undefined): Promise<string | import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport>;
139
+ /**
140
+ * @overload
141
+ * @param {string} workspaceRoot
142
+ * @param {true} html
143
+ * @param {Options & { batchMetadata: true }} opts
144
+ * @returns {Promise<{ analysis: string, metadata: BatchAnalysisMetadata }>}
145
+ * @throws {Error}
146
+ */
147
+ declare function stackAnalysisBatch(workspaceRoot: string, html: true, opts: Options & {
148
+ batchMetadata: true;
149
+ }): Promise<{
150
+ analysis: string;
151
+ metadata: BatchAnalysisMetadata;
152
+ }>;
153
+ /**
154
+ * @overload
155
+ * @param {string} workspaceRoot
156
+ * @param {true} html
157
+ * @param {Options & { batchMetadata?: false }} [opts={}]
158
+ * @returns {Promise<string>}
159
+ * @throws {Error}
160
+ */
161
+ declare function stackAnalysisBatch(workspaceRoot: string, html: true, opts?: (Options & {
162
+ batchMetadata?: false;
163
+ }) | undefined): Promise<string>;
164
+ /**
165
+ * @overload
166
+ * @param {string} workspaceRoot
167
+ * @param {false} html
168
+ * @param {Options & { batchMetadata: true }} opts
169
+ * @returns {Promise<{ analysis: Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>, metadata: BatchAnalysisMetadata }>}
170
+ * @throws {Error}
171
+ */
172
+ declare function stackAnalysisBatch(workspaceRoot: string, html: false, opts: Options & {
173
+ batchMetadata: true;
174
+ }): Promise<{
175
+ analysis: {
176
+ [x: string]: import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport;
177
+ };
178
+ metadata: BatchAnalysisMetadata;
179
+ }>;
180
+ /**
181
+ * @overload
182
+ * @param {string} workspaceRoot
183
+ * @param {false} html
184
+ * @param {Options & { batchMetadata?: false }} [opts={}]
185
+ * @returns {Promise<Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>>}
186
+ * @throws {Error}
187
+ */
188
+ declare function stackAnalysisBatch(workspaceRoot: string, html: false, opts?: (Options & {
189
+ batchMetadata?: false;
190
+ }) | undefined): Promise<{
191
+ [x: string]: import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport;
192
+ }>;
127
193
  /**
128
194
  * Get stack analysis for all workspace packages/crates (batch).
129
195
  * Detects ecosystem from workspace root: Cargo (Cargo.toml + Cargo.lock) or JS/TS (package.json + lock file).
130
196
  * SBOMs are generated in parallel (see `batchConcurrency`) unless `continueOnError: false` (fail-fast sequential).
131
197
  * With `opts.batchMetadata` / `TRUSTIFY_DA_BATCH_METADATA`, returns `{ analysis, metadata }` including validation and SBOM errors.
132
198
  *
199
+ * @overload
133
200
  * @param {string} workspaceRoot - Path to workspace root (containing lock file and workspace config)
134
201
  * @param {boolean} [html=false] - true returns HTML, false returns JSON report
135
202
  * @param {Options} [opts={}] - `batchConcurrency`, discovery ignores, `continueOnError` (default true), `batchMetadata` (default false)
136
203
  * @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
204
  * @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
205
  */
139
- declare function stackAnalysisBatch(workspaceRoot: string, html?: boolean, opts?: Options): Promise<string | {
206
+ declare function stackAnalysisBatch(workspaceRoot: string, html?: boolean | undefined, opts?: Options | undefined): Promise<string | {
140
207
  [x: string]: import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport;
141
208
  } | {
142
209
  analysis: string | {
@@ -184,6 +251,10 @@ declare function imageAnalysis(imageRefs: Array<string>, html?: boolean | undefi
184
251
  * @throws {Error} if the backend request failed.
185
252
  */
186
253
  declare function validateToken(opts?: Options): Promise<object>;
254
+ import { discoverMavenModules } from './providers/java_maven.js';
255
+ import { discoverGradleSubprojects } from './providers/java_gradle.js';
256
+ import { discoverGoWorkspaceModules } from './providers/golang_gomodules.js';
257
+ import { discoverUvWorkspaceMembers } from './providers/python_uv.js';
187
258
  import { discoverWorkspacePackages } from './workspace.js';
188
259
  import { discoverWorkspaceCrates } from './workspace.js';
189
260
  import { validatePackageJson } from './workspace.js';
@@ -191,5 +262,5 @@ import { resolveWorkspaceDiscoveryIgnore } from './workspace.js';
191
262
  import { filterManifestPathsByDiscoveryIgnore } from './workspace.js';
192
263
  import { resolveContinueOnError } from './batch_opts.js';
193
264
  import { resolveBatchMetadata } from './batch_opts.js';
194
- export { discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson, resolveWorkspaceDiscoveryIgnore, filterManifestPathsByDiscoveryIgnore, resolveContinueOnError, resolveBatchMetadata };
265
+ export { discoverMavenModules, discoverGradleSubprojects, discoverGoWorkspaceModules, discoverUvWorkspaceMembers, discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson, resolveWorkspaceDiscoveryIgnore, filterManifestPathsByDiscoveryIgnore, resolveContinueOnError, resolveBatchMetadata };
195
266
  export { getProjectLicense, findLicenseFilePath, identifyLicense, getLicenseDetails, licensesFromReport, normalizeLicensesResponse, runLicenseCheck, getCompatibility } from "./license/index.js";