@trustify-da/trustify-da-javascript-client 0.3.0-ea.ff266a3 → 0.3.0-ea.ff694a0

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 +179 -11
  2. package/dist/package.json +13 -4
  3. package/dist/src/analysis.d.ts +16 -0
  4. package/dist/src/analysis.js +53 -4
  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 +171 -4
  8. package/dist/src/cyclone_dx_sbom.d.ts +14 -1
  9. package/dist/src/cyclone_dx_sbom.js +34 -6
  10. package/dist/src/index.d.ts +134 -2
  11. package/dist/src/index.js +352 -6
  12. package/dist/src/license/index.d.ts +2 -2
  13. package/dist/src/license/index.js +4 -4
  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.js +9 -2
  17. package/dist/src/license/project_license.d.ts +1 -6
  18. package/dist/src/license/project_license.js +4 -81
  19. package/dist/src/oci_image/utils.js +11 -2
  20. package/dist/src/provider.d.ts +7 -3
  21. package/dist/src/provider.js +16 -5
  22. package/dist/src/providers/base_java.d.ts +5 -9
  23. package/dist/src/providers/base_java.js +9 -38
  24. package/dist/src/providers/base_javascript.d.ts +30 -3
  25. package/dist/src/providers/base_javascript.js +115 -25
  26. package/dist/src/providers/base_pyproject.d.ts +158 -0
  27. package/dist/src/providers/base_pyproject.js +322 -0
  28. package/dist/src/providers/golang_gomodules.d.ts +22 -12
  29. package/dist/src/providers/golang_gomodules.js +167 -120
  30. package/dist/src/providers/gomod_parser.d.ts +4 -0
  31. package/dist/src/providers/gomod_parser.js +16 -0
  32. package/dist/src/providers/java_gradle.d.ts +19 -0
  33. package/dist/src/providers/java_gradle.js +118 -3
  34. package/dist/src/providers/java_maven.d.ts +9 -1
  35. package/dist/src/providers/java_maven.js +103 -10
  36. package/dist/src/providers/javascript_bun.d.ts +10 -0
  37. package/dist/src/providers/javascript_bun.js +100 -0
  38. package/dist/src/providers/javascript_npm.d.ts +1 -0
  39. package/dist/src/providers/javascript_npm.js +21 -0
  40. package/dist/src/providers/javascript_pnpm.d.ts +1 -1
  41. package/dist/src/providers/javascript_pnpm.js +8 -4
  42. package/dist/src/providers/manifest.d.ts +2 -0
  43. package/dist/src/providers/manifest.js +22 -4
  44. package/dist/src/providers/marker_evaluator.d.ts +14 -0
  45. package/dist/src/providers/marker_evaluator.js +191 -0
  46. package/dist/src/providers/processors/yarn_berry_processor.js +88 -5
  47. package/dist/src/providers/python_controller.d.ts +5 -1
  48. package/dist/src/providers/python_controller.js +8 -4
  49. package/dist/src/providers/python_pip.d.ts +5 -0
  50. package/dist/src/providers/python_pip.js +8 -7
  51. package/dist/src/providers/python_pip_pyproject.d.ts +61 -0
  52. package/dist/src/providers/python_pip_pyproject.js +146 -0
  53. package/dist/src/providers/python_poetry.d.ts +75 -0
  54. package/dist/src/providers/python_poetry.js +238 -0
  55. package/dist/src/providers/python_uv.d.ts +55 -0
  56. package/dist/src/providers/python_uv.js +227 -0
  57. package/dist/src/providers/requirements_parser.js +4 -3
  58. package/dist/src/providers/rust_cargo.d.ts +53 -0
  59. package/dist/src/providers/rust_cargo.js +614 -0
  60. package/dist/src/providers/tree-sitter-gomod.wasm +0 -0
  61. package/dist/src/providers/tree-sitter-requirements.wasm +0 -0
  62. package/dist/src/sbom.d.ts +14 -1
  63. package/dist/src/sbom.js +13 -2
  64. package/dist/src/tools.d.ts +26 -0
  65. package/dist/src/tools.js +58 -0
  66. package/dist/src/workspace.d.ts +70 -0
  67. package/dist/src/workspace.js +256 -0
  68. package/package.json +14 -5
  69. package/dist/src/license/compatibility.d.ts +0 -18
  70. package/dist/src/license/compatibility.js +0 -45
package/README.md CHANGED
@@ -32,6 +32,11 @@ let stackAnalysis = await client.stackAnalysis('/path/to/pom.xml')
32
32
  let stackAnalysisHtml = await client.stackAnalysis('/path/to/pom.xml', true)
33
33
  // Get component analysis in JSON format
34
34
  let componentAnalysis = await client.componentAnalysis('/path/to/pom.xml')
35
+ // For monorepos, pass workspace root so the client finds the lock file
36
+ let monorepoOpts = { workspaceDir: '/path/to/workspace-root' }
37
+ let stackAnalysisMonorepo = await client.stackAnalysis('/path/to/package.json', false, monorepoOpts)
38
+ // Batch analysis for entire workspace (Cargo or JS/TS); optional parallel SBOM generation
39
+ let batchReport = await client.stackAnalysisBatch('/path/to/workspace-root', false, { batchConcurrency: 10 })
35
40
  // Get image analysis in JSON format
36
41
  let imageAnalysis = await client.imageAnalysis(['docker.io/library/node:18'])
37
42
  // Get image analysis in HTML format (string)
@@ -43,6 +48,21 @@ let imageAnalysisWithArch = await client.imageAnalysis(['httpd:2.4.49^^amd64'])
43
48
  ```
44
49
  </li>
45
50
  </ul>
51
+
52
+ <h3>License Detection</h3>
53
+ <p>
54
+ The client automatically detects your project's license with intelligent fallback:
55
+ </p>
56
+ <ul>
57
+ <li><strong>Manifest-first:</strong> For ecosystems with license support (Maven, JavaScript, Rust Cargo), reads from manifest file (<code>pom.xml</code>, <code>package.json</code>, <code>Cargo.toml</code>)</li>
58
+ <li><strong>LICENSE file fallback:</strong> If no license in manifest, or for ecosystems without license support (Gradle, Go, Python), automatically reads from <code>LICENSE</code>, <code>LICENSE.md</code>, or <code>LICENSE.txt</code></li>
59
+ <li><strong>SBOM integration:</strong> Detected licenses are included in generated SBOMs for all ecosystems</li>
60
+ <li><strong>SPDX support:</strong> Automatically detects common licenses (Apache-2.0, MIT, GPL, BSD) from LICENSE file content</li>
61
+ </ul>
62
+ <p>
63
+ See <a href="./docs/license-resolution-and-compliance.md">License Resolution and Compliance</a> for detailed documentation.
64
+ </p>
65
+
46
66
  <ul>
47
67
  <li>
48
68
  Use as ESM Module from Common-JS module
@@ -86,8 +106,9 @@ $ npx @trustify-da/trustify-da-javascript-client help
86
106
  Usage: trustify-da-javascript-client {component|stack|image|validate-token|license}
87
107
 
88
108
  Commands:
89
- trustify-da-javascript-client stack </path/to/manifest> [--html|--summary] produce stack report for manifest path
90
- trustify-da-javascript-client component <path/to/manifest> [--summary] produce component report for a manifest type and content
109
+ trustify-da-javascript-client stack </path/to/manifest> [--workspace-dir <path>] [--html|--summary] produce stack report for manifest path
110
+ trustify-da-javascript-client stack-batch </path/to/workspace-root> [--html|--summary] produce stack report for all packages/crates in workspace
111
+ trustify-da-javascript-client component <path/to/manifest> [--workspace-dir <path>] produce component report for a manifest type and content
91
112
  trustify-da-javascript-client image <image-refs..> [--html|--summary] produce image analysis report for OCI image references
92
113
  trustify-da-javascript-client license </path/to/manifest> display project license information from manifest and LICENSE file in JSON format
93
114
 
@@ -106,9 +127,21 @@ $ npx @trustify-da/trustify-da-javascript-client stack /path/to/pom.xml --summar
106
127
  # get stack analysis in html format format
107
128
  $ npx @trustify-da/trustify-da-javascript-client stack /path/to/pom.xml --html
108
129
 
130
+ # get stack analysis for monorepo (lock file at workspace root)
131
+ $ npx @trustify-da/trustify-da-javascript-client stack /path/to/package.json --workspace-dir /path/to/workspace-root
132
+
109
133
  # get component analysis
110
134
  $ npx @trustify-da/trustify-da-javascript-client component /path/to/pom.xml
111
135
 
136
+ # get component analysis for monorepo
137
+ $ npx @trustify-da/trustify-da-javascript-client component /path/to/package.json -w /path/to/workspace-root
138
+
139
+ # batch stack analysis for entire workspace (Cargo or JS/TS)
140
+ $ npx @trustify-da/trustify-da-javascript-client stack-batch /path/to/workspace-root
141
+
142
+ # optional: extra discovery excludes (merged with defaults); repeat --ignore or use TRUSTIFY_DA_WORKSPACE_DISCOVERY_IGNORE
143
+ $ npx @trustify-da/trustify-da-javascript-client stack-batch /path/to/workspace-root --ignore '**/fixtures/**'
144
+
112
145
  # get image analysis in json format
113
146
  $ npx @trustify-da/trustify-da-javascript-client image docker.io/library/node:18
114
147
 
@@ -147,9 +180,21 @@ $ trustify-da-javascript-client stack /path/to/pom.xml --summary
147
180
  # get stack analysis in html format format
148
181
  $ trustify-da-javascript-client stack /path/to/pom.xml --html
149
182
 
183
+ # get stack analysis for monorepo (lock file at workspace root)
184
+ $ trustify-da-javascript-client stack /path/to/package.json --workspace-dir /path/to/workspace-root
185
+
150
186
  # get component analysis
151
187
  $ trustify-da-javascript-client component /path/to/pom.xml
152
188
 
189
+ # get component analysis for monorepo
190
+ $ trustify-da-javascript-client component /path/to/package.json -w /path/to/workspace-root
191
+
192
+ # batch stack analysis for entire workspace
193
+ $ trustify-da-javascript-client stack-batch /path/to/workspace-root
194
+
195
+ # with extra discovery excludes
196
+ $ trustify-da-javascript-client stack-batch /path/to/workspace-root -i '**/vendor/**'
197
+
153
198
  # get image analysis in json format
154
199
  $ trustify-da-javascript-client image docker.io/library/node:18
155
200
 
@@ -179,9 +224,26 @@ $ trustify-da-javascript-client license /path/to/package.json
179
224
  <li><a href="https://www.javascript.com/">JavaScript</a> - <a href="https://pnpm.io/">pnpm</a></li>
180
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>
181
226
  <li><a href="https://go.dev/">Golang</a> - <a href="https://go.dev/blog/using-go-modules/">Go Modules</a></li>
182
- <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>
183
229
  <li><a href="https://gradle.org/">Gradle (Groovy and Kotlin DSL)</a> - <a href="https://gradle.org/install/">Gradle Installation</a></li>
230
+ <li><a href="https://www.rust-lang.org/">Rust</a> - <a href="https://doc.rust-lang.org/cargo/">Cargo</a></li>
231
+ </ul>
232
+
233
+ <h3>License Detection</h3>
234
+ <p>
235
+ The client automatically detects your project's license with intelligent fallback:
236
+ </p>
237
+ <ul>
238
+ <li><strong>Manifest-first:</strong> For ecosystems with license support (Maven, JavaScript, Rust Cargo), reads from manifest file (<code>pom.xml</code>, <code>package.json</code>, <code>Cargo.toml</code>)</li>
239
+ <li><strong>LICENSE file fallback:</strong> If no license in manifest, or for ecosystems without license support (Gradle, Go, Python), automatically reads from <code>LICENSE</code>, <code>LICENSE.md</code>, or <code>LICENSE.txt</code></li>
240
+ <li><strong>SBOM integration:</strong> Detected licenses are included in generated SBOMs for all ecosystems</li>
241
+ <li><strong>SPDX support:</strong> Automatically detects common licenses (Apache-2.0, MIT, GPL, BSD) from LICENSE file content</li>
184
242
  </ul>
243
+ <p>
244
+ See <a href="./docs/license-resolution-and-compliance.md">License Resolution and Compliance</a> for detailed documentation.
245
+ </p>
246
+
185
247
 
186
248
  <h3>Excluding Packages</h3>
187
249
  <p>
@@ -226,8 +288,11 @@ Excluding a package from any analysis can be achieved by marking the package for
226
288
  ]
227
289
  }
228
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:
229
295
 
230
- <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:
231
296
  ```go
232
297
  module github.com/trustify-da/SaaSi/deployer
233
298
 
@@ -236,7 +301,7 @@ go 1.19
236
301
  require (
237
302
  github.com/gin-gonic/gin v1.9.1
238
303
  github.com/google/uuid v1.1.2
239
- github.com/jessevdk/go-flags v1.5.0 //exhortignore
304
+ github.com/jessevdk/go-flags v1.5.0 // exhortignore
240
305
  github.com/kr/pretty v0.3.1
241
306
  gopkg.in/yaml.v2 v2.4.0
242
307
  k8s.io/apimachinery v0.26.1
@@ -244,14 +309,20 @@ require (
244
309
  )
245
310
 
246
311
  require (
247
- github.com/davecgh/go-spew v1.1.1 // indirect exhortignore
312
+ github.com/davecgh/go-spew v1.1.1 // indirect; exhortignore
248
313
  github.com/emicklei/go-restful/v3 v3.9.0 // indirect
249
- github.com/go-logr/logr v1.2.3 // indirect //exhortignore
314
+ github.com/go-logr/logr v1.2.3 // indirect; exhortignore
250
315
 
251
316
  )
252
317
  ```
253
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>
254
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
+
255
326
  ```properties
256
327
  anyio==3.6.2
257
328
  asgiref==3.4.1
@@ -282,11 +353,14 @@ Werkzeug==2.0.3
282
353
  zipp==3.6.0
283
354
 
284
355
  ```
356
+ </li>
285
357
 
358
+ <li>
286
359
  <em>Gradle</em> users can add in build.gradle a comment with //exhortignore next to the package to be ignored:
360
+
287
361
  ```build.gradle
288
362
  plugins {
289
- id 'java'
363
+ id 'java'
290
364
  }
291
365
 
292
366
  group = 'groupName'
@@ -304,9 +378,45 @@ test {
304
378
  }
305
379
  ```
306
380
 
307
- All of the 5 above examples are valid for marking a package to be ignored
308
- </li>
381
+ <em>Rust Cargo</em> users can add a comment with <code># trustify-da-ignore</code> (or <code># exhortignore</code>) in <em>Cargo.toml</em> next to the dependency to be ignored. This works for inline declarations, table-based declarations, and workspace-level dependency sections:
309
382
 
383
+ ```toml
384
+ [dependencies]
385
+ serde = "1.0" # trustify-da-ignore
386
+ tokio = { version = "1.35", features = ["full"] }
387
+
388
+ [dependencies.regex] # trustify-da-ignore
389
+ version = "1.10"
390
+
391
+ [workspace.dependencies]
392
+ log = "0.4" # trustify-da-ignore
393
+ ```
394
+
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>
310
420
  </ul>
311
421
 
312
422
  <h3>Customization</h3>
@@ -335,7 +445,12 @@ let options = {
335
445
  'TRUSTIFY_DA_PIP3_PATH' : '/path/to/pip3',
336
446
  'TRUSTIFY_DA_PYTHON_PATH' : '/path/to/python',
337
447
  'TRUSTIFY_DA_PIP_PATH' : '/path/to/pip',
448
+ 'TRUSTIFY_DA_UV_PATH' : '/path/to/uv',
449
+ 'TRUSTIFY_DA_POETRY_PATH' : '/path/to/poetry',
338
450
  'TRUSTIFY_DA_GRADLE_PATH' : '/path/to/gradle',
451
+ 'TRUSTIFY_DA_CARGO_PATH' : '/path/to/cargo',
452
+ // Workspace root for monorepos (Cargo, npm/pnpm/yarn); lock file expected here
453
+ 'workspaceDir': '/path/to/workspace-root',
339
454
  // Configure proxy for all requests
340
455
  'TRUSTIFY_DA_PROXY_URL': 'http://proxy.example.com:8080'
341
456
  }
@@ -358,6 +473,21 @@ let imageAnalysisWithArch = await client.imageAnalysis(['httpd:2.4.49^^amd64'],
358
473
  **_Environment variables takes precedence._**
359
474
  </p>
360
475
 
476
+ <h4>Monorepo / Workspace Support</h4>
477
+ <p>
478
+ For monorepos (Cargo workspaces, npm/pnpm/yarn workspaces) where the lock file lives at the workspace root rather than next to the manifest, pass the workspace root via <code>workspaceDir</code> or <code>TRUSTIFY_DA_WORKSPACE_DIR</code>:
479
+ </p>
480
+ <ul>
481
+ <li><strong>Cargo:</strong> When set, the client checks only the given directory for <code>Cargo.lock</code> instead of walking up from the manifest.</li>
482
+ <li><strong>JavaScript (npm, pnpm, yarn):</strong> When set, the client looks for the lock file (<code>package-lock.json</code>, <code>pnpm-lock.yaml</code>, <code>yarn.lock</code>) at the workspace root.</li>
483
+ </ul>
484
+ <p>
485
+ Use <code>stackAnalysisBatch(workspaceRoot, html, opts)</code> to analyze all packages/crates in a workspace in one request. Supports Cargo workspaces and JS/TS workspaces (pnpm, npm, yarn). Optional <code>batchConcurrency</code> (or <code>TRUSTIFY_DA_BATCH_CONCURRENCY</code>) limits parallel SBOM generation (default 10). For JS/TS, each <code>package.json</code> must have non-empty <code>name</code> and <code>version</code>; invalid manifests are skipped (warnings). Per-manifest SBOM failures are skipped if at least one SBOM succeeds (unless <code>continueOnError: false</code>). Set <code>batchMetadata: true</code> (or <code>TRUSTIFY_DA_BATCH_METADATA</code>) to receive <code>{ analysis, metadata }</code> with <code>errors[]</code>. CLI: <code>stack-batch --metadata</code>, <code>--fail-fast</code>. See <a href="./docs/monorepo-implementation-plan.md">monorepo implementation plan</a> §2.3 and §3.5.
486
+ </p>
487
+ <p>
488
+ See <a href="./docs/vscode-extension-integration-requirements.md">VS Code Extension Integration Requirements</a> for integration details.
489
+ </p>
490
+
361
491
  <h4>Proxy Configuration</h4>
362
492
  <p>
363
493
  You can configure a proxy for all HTTP/HTTPS requests made by the API. This is useful when your environment requires going through a proxy to access external services.
@@ -381,7 +511,7 @@ The proxy URL should be in the format: `http://host:port` or `https://host:port`
381
511
 
382
512
  <h4>License resolution and dependency license compliance</h4>
383
513
  <p>
384
- The client can resolve the <strong>project license</strong> from the manifest (e.g. <code>package.json</code> <code>license</code>, <code>pom.xml</code> <code>&lt;licenses&gt;</code>) and from a <code>LICENSE</code> or <code>LICENSE.md</code> file in the project, and report when they differ. For <strong>component analysis</strong>, you can optionally run a license check: the client fetches dependency licenses from the backend (by purl) and reports dependencies whose licenses are incompatible with the project license. See <a href="docs/license-resolution-and-compliance.md">License resolution and compliance</a> for design and behavior. To disable the check on component analysis, set <code>TRUSTIFY_DA_LICENSE_CHECK=false</code> or pass <code>licenseCheck: false</code> in the options.
514
+ The client can resolve the <strong>project license</strong> from the manifest (e.g. <code>package.json</code> <code>license</code>, <code>pom.xml</code> <code>&lt;licenses&gt;</code>, <code>Cargo.toml</code> <code>license</code>) and from a <code>LICENSE</code> or <code>LICENSE.md</code> file in the project, and report when they differ. For <strong>component analysis</strong>, you can optionally run a license check: the client fetches dependency licenses from the backend (by purl) and reports dependencies whose licenses are incompatible with the project license. See <a href="docs/license-resolution-and-compliance.md">License resolution and compliance</a> for design and behavior. To disable the check on component analysis, set <code>TRUSTIFY_DA_LICENSE_CHECK=false</code> or pass <code>licenseCheck: false</code> in the options.
385
515
  </p>
386
516
 
387
517
  <h4>Customizing Executables</h4>
@@ -457,6 +587,26 @@ following keys for setting custom paths for the said executables.
457
587
  <td><em>gradle</em></td>
458
588
  <td>TRUSTIFY_DA_PREFER_GRADLEW</td>
459
589
  </tr>
590
+ <tr>
591
+ <td><a href="https://www.rust-lang.org/">Rust Cargo</a></td>
592
+ <td><em>cargo</em></td>
593
+ <td>TRUSTIFY_DA_CARGO_PATH</td>
594
+ </tr>
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>
606
+ <td>Workspace root (monorepos)</td>
607
+ <td>—</td>
608
+ <td>workspaceDir / TRUSTIFY_DA_WORKSPACE_DIR</td>
609
+ </tr>
460
610
  </table>
461
611
 
462
612
  #### Match Manifest Versions Feature
@@ -505,6 +655,24 @@ TRUSTIFY_DA_GO_MVS_LOGIC_ENABLED=false
505
655
 
506
656
  #### Python Support
507
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
+
508
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
509
677
  Binaries passed to environment variables. In any case, If the package is not installed , then an error will be thrown.
510
678
 
package/dist/package.json CHANGED
@@ -38,23 +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 && cp node_modules/tree-sitter-gomod/tree-sitter-gomod.wasm src/providers/tree-sitter-gomod.wasm",
43
44
  "precompile": "rm -rf dist",
44
- "compile": "tsc -p tsconfig.json"
45
+ "compile": "tsc -p tsconfig.json",
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 && cp node_modules/tree-sitter-gomod/tree-sitter-gomod.wasm dist/src/providers/tree-sitter-gomod.wasm"
45
48
  },
46
49
  "dependencies": {
47
50
  "@babel/core": "^7.23.2",
48
51
  "@cyclonedx/cyclonedx-library": "^6.13.0",
49
52
  "eslint-import-resolver-typescript": "^4.4.4",
50
- "fast-toml": "^0.5.4",
53
+ "fast-glob": "^3.3.3",
51
54
  "fast-xml-parser": "^5.3.4",
52
55
  "help": "^3.0.2",
53
56
  "https-proxy-agent": "^7.0.6",
57
+ "js-yaml": "^4.1.1",
58
+ "jsonc-parser": "^3.3.1",
59
+ "micromatch": "^4.0.8",
54
60
  "node-fetch": "^3.3.2",
61
+ "p-limit": "^4.0.0",
55
62
  "packageurl-js": "~1.0.2",
63
+ "smol-toml": "^1.6.0",
64
+ "tree-sitter-gomod": "github:strum355/tree-sitter-go-mod#56326f2ad478892ace58ff247a97d492a3cbcdda",
56
65
  "tree-sitter-requirements": "github:Strum355/tree-sitter-requirements#d0261ee76b84253997fe70d7d397e78c006c3801",
57
- "web-tree-sitter": "^0.26.6",
66
+ "web-tree-sitter": "^0.26.7",
58
67
  "yargs": "^18.0.0"
59
68
  },
60
69
  "devDependencies": {
@@ -1,6 +1,9 @@
1
+ /** Media type for CycloneDX JSON batch payloads (batch-analysis API). */
2
+ export const CYCLONEDX_JSON_MEDIA_TYPE: "application/vnd.cyclonedx+json";
1
3
  declare namespace _default {
2
4
  export { requestComponent };
3
5
  export { requestStack };
6
+ export { requestStackBatch };
4
7
  export { requestImages };
5
8
  export { validateToken };
6
9
  }
@@ -24,6 +27,19 @@ declare function requestComponent(provider: import("./provider").Provider, manif
24
27
  * @returns {Promise<string|import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>}
25
28
  */
26
29
  declare function requestStack(provider: import("./provider").Provider, manifest: string, url: string, html?: boolean, opts?: import("index.js").Options): Promise<string | import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport>;
30
+ /**
31
+ * Send a batch stack analysis request for multiple manifests (SBOMs keyed by purl).
32
+ * @param {Object.<string, object>} sbomByPurl - Map of root purl to CycloneDX SBOM object
33
+ * @param {string} url - the backend url
34
+ * @param {boolean} [html=false] - true returns HTML, false returns JSON
35
+ * @param {import("index.js").Options} [opts={}]
36
+ * @returns {Promise<string|Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>>}
37
+ */
38
+ declare function requestStackBatch(sbomByPurl: {
39
+ [x: string]: any;
40
+ }, url: string, html?: boolean, opts?: import("index.js").Options): Promise<string | {
41
+ [x: string]: import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport;
42
+ }>;
27
43
  /**
28
44
  *
29
45
  * @param {Array<string>} imageRefs
@@ -4,7 +4,9 @@ import { EOL } from "os";
4
4
  import { runLicenseCheck } from "./license/index.js";
5
5
  import { generateImageSBOM, parseImageRef } from "./oci_image/utils.js";
6
6
  import { addProxyAgent, getCustom, getTokenHeaders, TRUSTIFY_DA_OPERATION_TYPE_HEADER, TRUSTIFY_DA_PACKAGE_MANAGER_HEADER } from "./tools.js";
7
- export default { requestComponent, requestStack, requestImages, validateToken };
7
+ /** Media type for CycloneDX JSON batch payloads (batch-analysis API). */
8
+ export const CYCLONEDX_JSON_MEDIA_TYPE = 'application/vnd.cyclonedx+json';
9
+ export default { requestComponent, requestStack, requestStackBatch, requestImages, validateToken };
8
10
  /**
9
11
  * Send a stack analysis request and get the report as 'text/html' or 'application/json'.
10
12
  * @param {import('./provider').Provider} provider - the provided data for constructing the request
@@ -124,6 +126,52 @@ async function requestComponent(provider, manifest, url, opts = {}) {
124
126
  }
125
127
  return Promise.resolve(result);
126
128
  }
129
+ /**
130
+ * Send a batch stack analysis request for multiple manifests (SBOMs keyed by purl).
131
+ * @param {Object.<string, object>} sbomByPurl - Map of root purl to CycloneDX SBOM object
132
+ * @param {string} url - the backend url
133
+ * @param {boolean} [html=false] - true returns HTML, false returns JSON
134
+ * @param {import("index.js").Options} [opts={}]
135
+ * @returns {Promise<string|Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>>}
136
+ */
137
+ async function requestStackBatch(sbomByPurl, url, html = false, opts = {}) {
138
+ const finalUrl = new URL(`${url}/api/v5/batch-analysis`);
139
+ if (opts['TRUSTIFY_DA_RECOMMENDATIONS_ENABLED'] === 'false') {
140
+ finalUrl.searchParams.append('recommend', 'false');
141
+ }
142
+ const fetchOptions = addProxyAgent({
143
+ method: 'POST',
144
+ headers: {
145
+ 'Accept': html ? 'text/html' : 'application/json',
146
+ 'Content-Type': CYCLONEDX_JSON_MEDIA_TYPE,
147
+ ...getTokenHeaders(opts)
148
+ },
149
+ body: JSON.stringify(sbomByPurl)
150
+ }, opts);
151
+ const resp = await fetch(finalUrl, fetchOptions);
152
+ if (resp.status === 200) {
153
+ let result;
154
+ if (!html) {
155
+ result = await resp.json();
156
+ }
157
+ else {
158
+ result = await resp.text();
159
+ }
160
+ if (process.env["TRUSTIFY_DA_DEBUG"] === "true") {
161
+ const exRequestId = resp.headers.get("ex-request-id");
162
+ if (exRequestId) {
163
+ console.log("Unique Identifier associated with this request - ex-request-id=" + exRequestId);
164
+ }
165
+ console.log("Response body received from Trustify DA backend server : " + EOL + EOL);
166
+ console.log(JSON.stringify(result, null, 4));
167
+ console.log("Ending time of sending batch stack analysis request to Trustify DA backend server= " + new Date());
168
+ }
169
+ return result;
170
+ }
171
+ else {
172
+ throw new Error(`Got error response from Trustify DA backend - http return code : ${resp.status}, ex-request-id: ${resp.headers.get("ex-request-id")} error message => ${await resp.text()}`);
173
+ }
174
+ }
127
175
  /**
128
176
  *
129
177
  * @param {Array<string>} imageRefs
@@ -141,15 +189,16 @@ async function requestImages(imageRefs, url, html = false, opts = {}) {
141
189
  if (opts['TRUSTIFY_DA_RECOMMENDATIONS_ENABLED'] === 'false') {
142
190
  finalUrl.searchParams.append('recommend', 'false');
143
191
  }
144
- const resp = await fetch(finalUrl, {
192
+ const fetchOptions = addProxyAgent({
145
193
  method: 'POST',
146
194
  headers: {
147
195
  'Accept': html ? 'text/html' : 'application/json',
148
- 'Content-Type': 'application/vnd.cyclonedx+json',
196
+ 'Content-Type': CYCLONEDX_JSON_MEDIA_TYPE,
149
197
  ...getTokenHeaders(opts)
150
198
  },
151
199
  body: JSON.stringify(imageSboms),
152
- });
200
+ }, opts);
201
+ const resp = await fetch(finalUrl, fetchOptions);
153
202
  if (resp.status === 200) {
154
203
  let result;
155
204
  if (!html) {
@@ -0,0 +1,24 @@
1
+ /**
2
+ * Whether to skip failed manifests and continue (default), or fail on first SBOM/validation error.
3
+ * `opts.continueOnError` overrides; env `TRUSTIFY_DA_CONTINUE_ON_ERROR=false` disables continuation.
4
+ *
5
+ * @param {{ continueOnError?: boolean, TRUSTIFY_DA_CONTINUE_ON_ERROR?: string, [key: string]: unknown }} [opts={}]
6
+ * @returns {boolean} true = collect errors (default), false = fail-fast
7
+ */
8
+ export function resolveContinueOnError(opts?: {
9
+ continueOnError?: boolean;
10
+ TRUSTIFY_DA_CONTINUE_ON_ERROR?: string;
11
+ [key: string]: unknown;
12
+ }): boolean;
13
+ /**
14
+ * When true, `stackAnalysisBatch` returns `{ analysis, metadata }` instead of the backend response only.
15
+ * `opts.batchMetadata` overrides; env `TRUSTIFY_DA_BATCH_METADATA=true` enables.
16
+ *
17
+ * @param {{ batchMetadata?: boolean, TRUSTIFY_DA_BATCH_METADATA?: string, [key: string]: unknown }} [opts={}]
18
+ * @returns {boolean}
19
+ */
20
+ export function resolveBatchMetadata(opts?: {
21
+ batchMetadata?: boolean;
22
+ TRUSTIFY_DA_BATCH_METADATA?: string;
23
+ [key: string]: unknown;
24
+ }): boolean;
@@ -0,0 +1,35 @@
1
+ import { getCustom } from './tools.js';
2
+ /**
3
+ * Whether to skip failed manifests and continue (default), or fail on first SBOM/validation error.
4
+ * `opts.continueOnError` overrides; env `TRUSTIFY_DA_CONTINUE_ON_ERROR=false` disables continuation.
5
+ *
6
+ * @param {{ continueOnError?: boolean, TRUSTIFY_DA_CONTINUE_ON_ERROR?: string, [key: string]: unknown }} [opts={}]
7
+ * @returns {boolean} true = collect errors (default), false = fail-fast
8
+ */
9
+ export function resolveContinueOnError(opts = {}) {
10
+ if (typeof opts.continueOnError === 'boolean') {
11
+ return opts.continueOnError;
12
+ }
13
+ const v = getCustom('TRUSTIFY_DA_CONTINUE_ON_ERROR', null, opts);
14
+ if (v != null && String(v).trim() !== '') {
15
+ return String(v).toLowerCase() !== 'false';
16
+ }
17
+ return true;
18
+ }
19
+ /**
20
+ * When true, `stackAnalysisBatch` returns `{ analysis, metadata }` instead of the backend response only.
21
+ * `opts.batchMetadata` overrides; env `TRUSTIFY_DA_BATCH_METADATA=true` enables.
22
+ *
23
+ * @param {{ batchMetadata?: boolean, TRUSTIFY_DA_BATCH_METADATA?: string, [key: string]: unknown }} [opts={}]
24
+ * @returns {boolean}
25
+ */
26
+ export function resolveBatchMetadata(opts = {}) {
27
+ if (typeof opts.batchMetadata === 'boolean') {
28
+ return opts.batchMetadata;
29
+ }
30
+ const v = getCustom('TRUSTIFY_DA_BATCH_METADATA', null, opts);
31
+ if (v != null && String(v).trim() !== '') {
32
+ return String(v).toLowerCase() === 'true';
33
+ }
34
+ return false;
35
+ }