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

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.
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,13 +38,13 @@
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",
@@ -61,8 +61,9 @@
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)
@@ -70,6 +70,13 @@ export default class CycloneDxSbom {
70
70
  * @return {boolean}
71
71
  */
72
72
  checkIfPackageInsideDependsOnList(component: any, name: string): boolean;
73
+ /**
74
+ * Checks if any entry in the dependsOn list of sourceRef starts with the given purl prefix.
75
+ * @param {PackageURL} sourceRef - The source component
76
+ * @param {string} purlPrefix - The purl prefix to match (e.g. "pkg:npm/minimist@")
77
+ * @return {boolean}
78
+ */
79
+ checkDependsOnByPurlPrefix(sourceRef: PackageURL, purlPrefix: string): boolean;
73
80
  /** Removes the root component from the sbom
74
81
  */
75
82
  removeRootComponent(): void;
@@ -242,6 +242,20 @@ export default class CycloneDxSbom {
242
242
  return false;
243
243
  }
244
244
  }
245
+ /**
246
+ * Checks if any entry in the dependsOn list of sourceRef starts with the given purl prefix.
247
+ * @param {PackageURL} sourceRef - The source component
248
+ * @param {string} purlPrefix - The purl prefix to match (e.g. "pkg:npm/minimist@")
249
+ * @return {boolean}
250
+ */
251
+ checkDependsOnByPurlPrefix(sourceRef, purlPrefix) {
252
+ const sourcePurl = sourceRef.toString();
253
+ const depIndex = this.getDependencyIndex(sourcePurl);
254
+ if (depIndex < 0) {
255
+ return false;
256
+ }
257
+ return this.dependencies[depIndex].dependsOn.some(dep => dep.startsWith(purlPrefix));
258
+ }
245
259
  /** Removes the root component from the sbom
246
260
  */
247
261
  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,6 +74,8 @@ 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 = {
package/dist/src/index.js CHANGED
@@ -12,7 +12,7 @@ import * as url from 'url';
12
12
  export { parseImageRef } from "./oci_image/utils.js";
13
13
  export { ImageRef } from "./oci_image/images.js";
14
14
  export { getProjectLicense, findLicenseFilePath, identifyLicense, getLicenseDetails, licensesFromReport, normalizeLicensesResponse, runLicenseCheck, getCompatibility } from "./license/index.js";
15
- export default { componentAnalysis, stackAnalysis, stackAnalysisBatch, imageAnalysis, validateToken };
15
+ export default { componentAnalysis, stackAnalysis, stackAnalysisBatch, imageAnalysis, validateToken, generateSbom };
16
16
  export { discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson, resolveWorkspaceDiscoveryIgnore, filterManifestPathsByDiscoveryIgnore, resolveContinueOnError, resolveBatchMetadata, };
17
17
  /**
18
18
  * @typedef {{
@@ -56,6 +56,8 @@ export { discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson
56
56
  * TRUSTIFY_DA_CONTINUE_ON_ERROR?: string | undefined,
57
57
  * batchMetadata?: boolean | undefined,
58
58
  * TRUSTIFY_DA_BATCH_METADATA?: string | undefined,
59
+ * TRUSTIFY_DA_UV_PATH?: string | undefined,
60
+ * TRUSTIFY_DA_POETRY_PATH?: string | undefined,
59
61
  * [key: string]: string | number | boolean | string[] | undefined,
60
62
  * }} Options
61
63
  */
@@ -235,6 +237,22 @@ function buildBatchAnalysisMetadata(root, ecosystem, totalSbomAttempts, successf
235
237
  errors: [...errors],
236
238
  };
237
239
  }
240
+ /**
241
+ * Generate a CycloneDX SBOM from a manifest file. No backend HTTP request is made.
242
+ *
243
+ * @param {string} manifestPath - path to the manifest file (e.g. pom.xml, package.json)
244
+ * @param {Options} [opts={}] - optional options (e.g. workspace dir, tool paths)
245
+ * @returns {Promise<object>} parsed CycloneDX SBOM JSON object
246
+ * @throws {Error} if the manifest is unsupported or SBOM generation fails
247
+ */
248
+ export async function generateSbom(manifestPath, opts = {}) {
249
+ fs.accessSync(manifestPath, fs.constants.R_OK);
250
+ const result = await generateOneSbom(manifestPath, opts);
251
+ if (!result.ok) {
252
+ throw new Error(`Failed to generate SBOM for ${result.manifestPath}: ${result.reason}`);
253
+ }
254
+ return result.sbom;
255
+ }
238
256
  /**
239
257
  * @typedef {{ ok: true, purl: string, sbom: object } | { ok: false, manifestPath: string, reason: string }} SbomResult
240
258
  */
@@ -135,7 +135,7 @@ function execSyft(imageRef, opts = {}) {
135
135
  function getSyftEnvs(dockerPath, podmanPath) {
136
136
  let path = null;
137
137
  if (dockerPath && podmanPath) {
138
- path = `${dockerPath}${File.pathSeparator}${podmanPath}`;
138
+ path = `${dockerPath}${delimiter}${podmanPath}`;
139
139
  }
140
140
  else if (dockerPath) {
141
141
  path = dockerPath;
@@ -276,7 +276,16 @@ function podmanGetVariant(opts = {}) {
276
276
  * @returns {string} - The information
277
277
  */
278
278
  function dockerPodmanInfo(dockerSupplier, podmanSupplier, opts = {}) {
279
- return dockerSupplier(opts) || podmanSupplier(opts);
279
+ try {
280
+ const result = dockerSupplier(opts);
281
+ if (result) {
282
+ return result;
283
+ }
284
+ }
285
+ catch (_) {
286
+ // docker not available, fall through to podman
287
+ }
288
+ return podmanSupplier(opts);
280
289
  }
281
290
  /**
282
291
  * Gets the digests for an image
@@ -7,6 +7,8 @@ import Javascript_npm from './providers/javascript_npm.js';
7
7
  import Javascript_pnpm from './providers/javascript_pnpm.js';
8
8
  import Javascript_yarn from './providers/javascript_yarn.js';
9
9
  import pythonPipProvider from './providers/python_pip.js';
10
+ import Python_poetry from './providers/python_poetry.js';
11
+ import Python_uv from './providers/python_uv.js';
10
12
  import rustCargoProvider from './providers/rust_cargo.js';
11
13
  /** @typedef {{ecosystem: string, contentType: string, content: string}} Provided */
12
14
  /** @typedef {{isSupported: function(string): boolean, validateLockFile: function(string, Object): void, provideComponent: function(string, {}): Provided | Promise<Provided>, provideStack: function(string, {}): Provided | Promise<Provided>, readLicenseFromManifest: function(string): string | null}} Provider */
@@ -23,6 +25,8 @@ export const availableProviders = [
23
25
  new Javascript_npm(),
24
26
  golangGomodulesProvider,
25
27
  pythonPipProvider,
28
+ new Python_poetry(),
29
+ new Python_uv(),
26
30
  rustCargoProvider
27
31
  ];
28
32
  /**
@@ -235,9 +235,32 @@ export default class Base_javascript {
235
235
  let sbom = new Sbom();
236
236
  sbom.addRoot(mainComponent, license);
237
237
  this._addDependenciesToSbom(sbom, depsObject);
238
+ this.#ensurePeerAndOptionalDeps(sbom);
238
239
  sbom.filterIgnoredDeps(this.#manifest.ignored);
239
240
  return sbom.getAsJsonString(opts);
240
241
  }
242
+ /**
243
+ * Ensures peer and optional dependencies declared in the manifest are
244
+ * present in the SBOM, even when the package manager does not resolve them
245
+ * (e.g. yarn does not include peer deps in its dependency listing).
246
+ * @param {Sbom} sbom - The SBOM to supplement
247
+ * @private
248
+ */
249
+ #ensurePeerAndOptionalDeps(sbom) {
250
+ const rootPurl = toPurl(purlType, this.#manifest.name, this.#manifest.version);
251
+ const depSources = [this.#manifest.peerDependencies, this.#manifest.optionalDependencies];
252
+ for (const source of depSources) {
253
+ for (const [name, version] of Object.entries(source)) {
254
+ // Build the purl prefix for exact matching (e.g. "pkg:npm/minimist@"
255
+ // or "pkg:npm/%40hapi/joi@") to avoid substring false positives
256
+ const probe = toPurl(purlType, name, version);
257
+ const purlPrefix = probe.toString().replace(/@[^@]*$/, '@');
258
+ if (!sbom.checkDependsOnByPurlPrefix(rootPurl, purlPrefix)) {
259
+ sbom.addDependency(rootPurl, probe);
260
+ }
261
+ }
262
+ }
263
+ }
241
264
  /**
242
265
  * Recursively builds the Sbom from the JSON that npm listing returns
243
266
  * @param {Sbom} sbom - The SBOM object to add dependencies to
@@ -245,7 +268,10 @@ export default class Base_javascript {
245
268
  * @protected
246
269
  */
247
270
  _addDependenciesToSbom(sbom, depTree) {
248
- const dependencies = depTree["dependencies"] || {};
271
+ const dependencies = {
272
+ ...depTree["dependencies"],
273
+ ...depTree["optionalDependencies"],
274
+ };
249
275
  Object.entries(dependencies)
250
276
  .forEach(entry => {
251
277
  const [name, artifact] = entry;
@@ -295,6 +321,7 @@ export default class Base_javascript {
295
321
  const rootPurl = toPurlFromString(sbom.getRoot().purl);
296
322
  sbom.addDependency(rootPurl, rootDeps.get(key));
297
323
  }
324
+ this.#ensurePeerAndOptionalDeps(sbom);
298
325
  sbom.filterIgnoredDeps(this.#manifest.ignored);
299
326
  return sbom.getAsJsonString(opts);
300
327
  }
@@ -305,10 +332,14 @@ export default class Base_javascript {
305
332
  * @protected
306
333
  */
307
334
  _getRootDependencies(depTree) {
308
- if (!depTree.dependencies) {
335
+ const allDeps = {
336
+ ...depTree.dependencies,
337
+ ...depTree.optionalDependencies,
338
+ };
339
+ if (Object.keys(allDeps).length === 0) {
309
340
  return new Map();
310
341
  }
311
- return new Map(Object.entries(depTree.dependencies).map(([key, value]) => [key, toPurl(purlType, key, value.version)]));
342
+ return new Map(Object.entries(allDeps).map(([key, value]) => [key, toPurl(purlType, key, value.version)]));
312
343
  }
313
344
  /**
314
345
  * Executes the list command to get dependencies
@@ -0,0 +1,147 @@
1
+ /** @typedef {{name: string, version: string, children: string[]}} GraphEntry */
2
+ /** @typedef {{name: string, version: string, dependencies: DepTreeEntry[]}} DepTreeEntry */
3
+ /** @typedef {{directDeps: string[], graph: Map<string, GraphEntry>}} DependencyData */
4
+ /** @typedef {{ecosystem: string, content: string, contentType: string}} Provided */
5
+ export default class Base_pyproject {
6
+ /**
7
+ * @param {string} manifestName
8
+ * @returns {boolean}
9
+ */
10
+ isSupported(manifestName: string): boolean;
11
+ /**
12
+ * @param {string} manifestDir
13
+ * @returns {boolean}
14
+ */
15
+ validateLockFile(manifestDir: string): boolean;
16
+ /**
17
+ * Read project license from pyproject.toml, with fallback to LICENSE file.
18
+ * @param {string} manifestPath
19
+ * @returns {string|null}
20
+ */
21
+ readLicenseFromManifest(manifestPath: string): string | null;
22
+ /**
23
+ * @param {string} manifest - path to pyproject.toml
24
+ * @param {Object} [opts={}]
25
+ * @returns {Promise<Provided>}
26
+ */
27
+ provideStack(manifest: string, opts?: any): Promise<Provided>;
28
+ /**
29
+ * @param {string} manifest - path to pyproject.toml
30
+ * @param {Object} [opts={}]
31
+ * @returns {Promise<Provided>}
32
+ */
33
+ provideComponent(manifest: string, opts?: any): Promise<Provided>;
34
+ /**
35
+ * @returns {string}
36
+ * @protected
37
+ */
38
+ protected _lockFileName(): string;
39
+ /**
40
+ * @returns {string}
41
+ * @protected
42
+ */
43
+ protected _cmdName(): string;
44
+ /**
45
+ * Resolve dependencies using the tool-specific command and parser.
46
+ * @param {string} manifestDir
47
+ * @param {object} parsed - parsed pyproject.toml
48
+ * @param {Object} opts
49
+ * @returns {Promise<DependencyData>}
50
+ * @protected
51
+ */
52
+ protected _getDependencyData(manifestDir: string, parsed: object, opts: any): Promise<DependencyData>;
53
+ /**
54
+ * Canonicalize a Python package name per PEP 503.
55
+ * @param {string} name
56
+ * @returns {string}
57
+ * @protected
58
+ */
59
+ protected _canonicalize(name: string): string;
60
+ /**
61
+ * Get the project name from pyproject.toml.
62
+ * @param {object} parsed
63
+ * @returns {string|null}
64
+ * @protected
65
+ */
66
+ protected _getProjectName(parsed: object): string | null;
67
+ /**
68
+ * Get the project version from pyproject.toml.
69
+ * @param {object} parsed
70
+ * @returns {string|null}
71
+ * @protected
72
+ */
73
+ protected _getProjectVersion(parsed: object): string | null;
74
+ /**
75
+ * Scan raw pyproject.toml text for dependencies with ignore markers.
76
+ * @param {string} manifestPath
77
+ * @returns {Set<string>}
78
+ * @protected
79
+ */
80
+ protected _getIgnoredDeps(manifestPath: string): Set<string>;
81
+ /**
82
+ * Build dependency tree from graph, starting from direct deps.
83
+ * @param {Map<string, GraphEntry>} graph
84
+ * @param {string[]} directDeps - canonical names of direct deps
85
+ * @param {Set<string>} ignoredDeps
86
+ * @param {boolean} includeTransitive
87
+ * @returns {DepTreeEntry[]}
88
+ * @protected
89
+ */
90
+ protected _buildDependencyTree(graph: Map<string, GraphEntry>, directDeps: string[], ignoredDeps: Set<string>, includeTransitive: boolean): DepTreeEntry[];
91
+ /**
92
+ * Recursively collect transitive dependencies.
93
+ * @param {Map<string, GraphEntry>} graph
94
+ * @param {string[]} childKeys
95
+ * @param {DepTreeEntry[]} result - mutated in place
96
+ * @param {Set<string>} ignoredDeps
97
+ * @param {Set<string>} visited
98
+ * @returns {void}
99
+ * @protected
100
+ */
101
+ protected _collectTransitive(graph: Map<string, GraphEntry>, childKeys: string[], result: DepTreeEntry[], ignoredDeps: Set<string>, visited: Set<string>): void;
102
+ /**
103
+ * @param {string} name
104
+ * @param {string} version
105
+ * @returns {PackageURL}
106
+ * @protected
107
+ */
108
+ protected _toPurl(name: string, version: string): PackageURL;
109
+ /**
110
+ * Recursively add a dependency and its transitive deps to the SBOM.
111
+ * @param {PackageURL} source
112
+ * @param {DepTreeEntry} dep
113
+ * @param {Sbom} sbom
114
+ * @returns {void}
115
+ * @private
116
+ */
117
+ private _addAllDependencies;
118
+ /**
119
+ * Create SBOM json string for a pyproject.toml project.
120
+ * @param {string} manifest - path to pyproject.toml
121
+ * @param {Object} opts
122
+ * @param {boolean} includeTransitive
123
+ * @returns {Promise<string>}
124
+ * @private
125
+ */
126
+ private _createSbom;
127
+ }
128
+ export type GraphEntry = {
129
+ name: string;
130
+ version: string;
131
+ children: string[];
132
+ };
133
+ export type DepTreeEntry = {
134
+ name: string;
135
+ version: string;
136
+ dependencies: DepTreeEntry[];
137
+ };
138
+ export type DependencyData = {
139
+ directDeps: string[];
140
+ graph: Map<string, GraphEntry>;
141
+ };
142
+ export type Provided = {
143
+ ecosystem: string;
144
+ content: string;
145
+ contentType: string;
146
+ };
147
+ import { PackageURL } from 'packageurl-js';