@trustify-da/trustify-da-javascript-client 0.3.0-ea.4689ffb → 0.3.0-ea.4e0aceb

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 (82) hide show
  1. package/README.md +250 -11
  2. package/dist/package.json +28 -24
  3. package/dist/src/analysis.d.ts +14 -7
  4. package/dist/src/analysis.js +32 -15
  5. package/dist/src/cli.js +156 -3
  6. package/dist/src/cyclone_dx_sbom.d.ts +14 -1
  7. package/dist/src/cyclone_dx_sbom.js +43 -8
  8. package/dist/src/index.d.ts +86 -11
  9. package/dist/src/index.js +97 -8
  10. package/dist/src/license/index.d.ts +3 -3
  11. package/dist/src/license/index.js +4 -1
  12. package/dist/src/license/license_utils.js +4 -1
  13. package/dist/src/license/licenses_api.d.ts +2 -2
  14. package/dist/src/oci_image/images.d.ts +1 -1
  15. package/dist/src/oci_image/images.js +15 -1
  16. package/dist/src/oci_image/utils.d.ts +5 -5
  17. package/dist/src/oci_image/utils.js +11 -2
  18. package/dist/src/provider.d.ts +4 -3
  19. package/dist/src/provider.js +12 -2
  20. package/dist/src/providers/base_java.d.ts +14 -12
  21. package/dist/src/providers/base_java.js +18 -44
  22. package/dist/src/providers/base_javascript.d.ts +20 -9
  23. package/dist/src/providers/base_javascript.js +44 -6
  24. package/dist/src/providers/base_pyproject.d.ts +158 -0
  25. package/dist/src/providers/base_pyproject.js +322 -0
  26. package/dist/src/providers/containerfile_parser.d.ts +5 -0
  27. package/dist/src/providers/containerfile_parser.js +20 -0
  28. package/dist/src/providers/golang_gomodules.d.ts +23 -13
  29. package/dist/src/providers/golang_gomodules.js +165 -119
  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 +116 -2
  34. package/dist/src/providers/java_gradle_groovy.d.ts +1 -1
  35. package/dist/src/providers/java_gradle_kotlin.d.ts +1 -1
  36. package/dist/src/providers/java_maven.d.ts +10 -2
  37. package/dist/src/providers/java_maven.js +165 -1
  38. package/dist/src/providers/javascript_bun.d.ts +10 -0
  39. package/dist/src/providers/javascript_bun.js +100 -0
  40. package/dist/src/providers/javascript_npm.d.ts +6 -0
  41. package/dist/src/providers/javascript_npm.js +21 -0
  42. package/dist/src/providers/javascript_pnpm.js +6 -2
  43. package/dist/src/providers/manifest.d.ts +2 -0
  44. package/dist/src/providers/manifest.js +22 -4
  45. package/dist/src/providers/marker_evaluator.d.ts +14 -0
  46. package/dist/src/providers/marker_evaluator.js +191 -0
  47. package/dist/src/providers/oci_dockerfile.d.ts +51 -0
  48. package/dist/src/providers/oci_dockerfile.js +177 -0
  49. package/dist/src/providers/processors/yarn_berry_processor.d.ts +2 -2
  50. package/dist/src/providers/processors/yarn_berry_processor.js +88 -5
  51. package/dist/src/providers/processors/yarn_classic_processor.d.ts +2 -2
  52. package/dist/src/providers/python_controller.d.ts +5 -1
  53. package/dist/src/providers/python_controller.js +69 -8
  54. package/dist/src/providers/python_pip.d.ts +5 -0
  55. package/dist/src/providers/python_pip.js +6 -6
  56. package/dist/src/providers/python_pip_pyproject.d.ts +61 -0
  57. package/dist/src/providers/python_pip_pyproject.js +146 -0
  58. package/dist/src/providers/python_poetry.d.ts +98 -0
  59. package/dist/src/providers/python_poetry.js +286 -0
  60. package/dist/src/providers/python_uv.d.ts +46 -0
  61. package/dist/src/providers/python_uv.js +269 -0
  62. package/dist/src/providers/rust_cargo.d.ts +6 -2
  63. package/dist/src/providers/rust_cargo.js +105 -19
  64. package/dist/src/providers/tree-sitter-containerfile.wasm +0 -0
  65. package/dist/src/providers/tree-sitter-gomod.wasm +0 -0
  66. package/dist/src/remediate.d.ts +21 -0
  67. package/dist/src/remediate.js +149 -0
  68. package/dist/src/remediation.d.ts +57 -0
  69. package/dist/src/remediation.js +436 -0
  70. package/dist/src/remediation_report.d.ts +40 -0
  71. package/dist/src/remediation_report.js +159 -0
  72. package/dist/src/sbom.d.ts +14 -1
  73. package/dist/src/sbom.js +13 -2
  74. package/dist/src/tools.d.ts +28 -2
  75. package/dist/src/tools.js +58 -0
  76. package/dist/src/updaters/maven_updater.d.ts +26 -0
  77. package/dist/src/updaters/maven_updater.js +322 -0
  78. package/dist/src/updaters/toml_updater.d.ts +33 -0
  79. package/dist/src/updaters/toml_updater.js +244 -0
  80. package/dist/src/workspace.d.ts +9 -0
  81. package/dist/src/workspace.js +1 -1
  82. package/package.json +29 -25
@@ -1,4 +1,4 @@
1
- export type purlType = import("../provider").Provider;
1
+ export type purlType = any;
2
2
  /** @typedef {import('../provider').Provider} */
3
3
  /** @typedef {import('../provider').Provided} Provided */
4
4
  /**
@@ -19,7 +19,7 @@ export default class Base_javascript {
19
19
  * @param {Object} opts - Configuration options for the provider
20
20
  * @protected
21
21
  */
22
- protected _setUp(manifestPath: string, opts: any): void;
22
+ protected _setUp(manifestPath: string, opts: Object): void;
23
23
  /**
24
24
  * Gets the current manifest object
25
25
  * @returns {Manifest} The manifest object
@@ -47,6 +47,11 @@ export default class Base_javascript {
47
47
  */
48
48
  protected _cmdName(): string;
49
49
  /**
50
+ * Returns the package manager name (e.g. npm, yarn, pnpm, bun)
51
+ * @returns {string} The package manager name
52
+ */
53
+ packageManagerName(): string;
54
+ /**
50
55
  * Returns the command arguments for listing dependencies
51
56
  * @returns {Array<string>} The command arguments
52
57
  * @abstract
@@ -86,21 +91,21 @@ export default class Base_javascript {
86
91
  * @param {Object} [opts={}] - optional; may contain TRUSTIFY_DA_WORKSPACE_DIR
87
92
  * @returns {boolean} True if the lock file exists
88
93
  */
89
- validateLockFile(manifestDir: string, opts?: any): boolean;
94
+ validateLockFile(manifestDir: string, opts?: Object): boolean;
90
95
  /**
91
96
  * Provides content and content type for stack analysis
92
97
  * @param {string} manifestPath - The manifest path or name
93
98
  * @param {Object} [opts={}] - Optional configuration options
94
99
  * @returns {Provided} The provided data for stack analysis
95
100
  */
96
- provideStack(manifestPath: string, opts?: any): Provided;
101
+ provideStack(manifestPath: string, opts?: Object): Provided;
97
102
  /**
98
103
  * Provides content and content type for component analysis
99
104
  * @param {string} manifestPath - Path to package.json for component report
100
105
  * @param {Object} [opts={}] - Optional configuration options
101
106
  * @returns {Provided} The provided data for component analysis
102
107
  */
103
- provideComponent(manifestPath: string, opts?: any): Provided;
108
+ provideComponent(manifestPath: string, opts?: Object): Provided;
104
109
  /**
105
110
  * Read license from manifest (package.json). Reused by npm, pnpm, yarn.
106
111
  * @param {string} manifestPath - path to package.json
@@ -114,21 +119,21 @@ export default class Base_javascript {
114
119
  * @returns {Object} The dependency tree
115
120
  * @protected
116
121
  */
117
- protected _buildDependencyTree(includeTransitive: boolean, opts?: any): any;
122
+ protected _buildDependencyTree(includeTransitive: boolean, opts?: Object): Object;
118
123
  /**
119
124
  * Recursively builds the Sbom from the JSON that npm listing returns
120
125
  * @param {Sbom} sbom - The SBOM object to add dependencies to
121
126
  * @param {Object} depTree - The current dependency tree
122
127
  * @protected
123
128
  */
124
- protected _addDependenciesToSbom(sbom: Sbom, depTree: any): void;
129
+ protected _addDependenciesToSbom(sbom: Sbom, depTree: Object): void;
125
130
  /**
126
131
  * Extracts root dependencies from the dependency tree
127
132
  * @param {Object} depTree - The dependency tree object
128
133
  * @returns {Map<string, PackageURL>} Map of dependency names to their PackageURL objects
129
134
  * @protected
130
135
  */
131
- protected _getRootDependencies(depTree: any): Map<string, PackageURL>;
136
+ protected _getRootDependencies(depTree: Object): Map<string, PackageURL>;
132
137
  /**
133
138
  * Gets the version of the package manager
134
139
  * @returns {string} The version string of the package manager
@@ -136,6 +141,12 @@ export default class Base_javascript {
136
141
  */
137
142
  protected _version(): string;
138
143
  /**
144
+ * Creates or updates the lock file for the package manager
145
+ * @param {string} manifestDir - Directory containing the manifest file
146
+ * @protected
147
+ */
148
+ protected _createLockFile(manifestDir: string): void;
149
+ /**
139
150
  * Parses the dependency tree output
140
151
  * @param {string} output - The output to parse
141
152
  * @returns {string} The parsed output
@@ -144,6 +155,6 @@ export default class Base_javascript {
144
155
  protected _parseDepTreeOutput(output: string): string;
145
156
  #private;
146
157
  }
147
- export type Provided = import("../provider").Provided;
158
+ export type Provided = any;
148
159
  import Manifest from './manifest.js';
149
160
  import Sbom from '../sbom.js';
@@ -71,6 +71,13 @@ export default class Base_javascript {
71
71
  throw new TypeError("_cmdName must be implemented");
72
72
  }
73
73
  /**
74
+ * Returns the package manager name (e.g. npm, yarn, pnpm, bun)
75
+ * @returns {string} The package manager name
76
+ */
77
+ packageManagerName() {
78
+ return this._cmdName();
79
+ }
80
+ /**
74
81
  * Returns the command arguments for listing dependencies
75
82
  * @returns {Array<string>} The command arguments
76
83
  * @abstract
@@ -217,7 +224,7 @@ export default class Base_javascript {
217
224
  this._version();
218
225
  const manifestDir = path.dirname(this.#manifest.manifestPath);
219
226
  const cmdDir = this._findLockFileDir(manifestDir, opts) || manifestDir;
220
- this.#createLockFile(cmdDir);
227
+ this._createLockFile(cmdDir);
221
228
  let output = this.#executeListCmd(includeTransitive, cmdDir);
222
229
  output = this._parseDepTreeOutput(output);
223
230
  return JSON.parse(output);
@@ -235,9 +242,32 @@ export default class Base_javascript {
235
242
  let sbom = new Sbom();
236
243
  sbom.addRoot(mainComponent, license);
237
244
  this._addDependenciesToSbom(sbom, depsObject);
245
+ this.#ensurePeerAndOptionalDeps(sbom);
238
246
  sbom.filterIgnoredDeps(this.#manifest.ignored);
239
247
  return sbom.getAsJsonString(opts);
240
248
  }
249
+ /**
250
+ * Ensures peer and optional dependencies declared in the manifest are
251
+ * present in the SBOM, even when the package manager does not resolve them
252
+ * (e.g. yarn does not include peer deps in its dependency listing).
253
+ * @param {Sbom} sbom - The SBOM to supplement
254
+ * @private
255
+ */
256
+ #ensurePeerAndOptionalDeps(sbom) {
257
+ const rootPurl = toPurl(purlType, this.#manifest.name, this.#manifest.version);
258
+ const depSources = [this.#manifest.peerDependencies, this.#manifest.optionalDependencies];
259
+ for (const source of depSources) {
260
+ for (const [name, version] of Object.entries(source)) {
261
+ // Build the purl prefix for exact matching (e.g. "pkg:npm/minimist@"
262
+ // or "pkg:npm/%40hapi/joi@") to avoid substring false positives
263
+ const probe = toPurl(purlType, name, version);
264
+ const purlPrefix = probe.toString().replace(/@[^@]*$/, '@');
265
+ if (!sbom.checkDependsOnByPurlPrefix(rootPurl, purlPrefix)) {
266
+ sbom.addDependency(rootPurl, probe);
267
+ }
268
+ }
269
+ }
270
+ }
241
271
  /**
242
272
  * Recursively builds the Sbom from the JSON that npm listing returns
243
273
  * @param {Sbom} sbom - The SBOM object to add dependencies to
@@ -245,7 +275,10 @@ export default class Base_javascript {
245
275
  * @protected
246
276
  */
247
277
  _addDependenciesToSbom(sbom, depTree) {
248
- const dependencies = depTree["dependencies"] || {};
278
+ const dependencies = {
279
+ ...depTree["dependencies"],
280
+ ...depTree["optionalDependencies"],
281
+ };
249
282
  Object.entries(dependencies)
250
283
  .forEach(entry => {
251
284
  const [name, artifact] = entry;
@@ -295,6 +328,7 @@ export default class Base_javascript {
295
328
  const rootPurl = toPurlFromString(sbom.getRoot().purl);
296
329
  sbom.addDependency(rootPurl, rootDeps.get(key));
297
330
  }
331
+ this.#ensurePeerAndOptionalDeps(sbom);
298
332
  sbom.filterIgnoredDeps(this.#manifest.ignored);
299
333
  return sbom.getAsJsonString(opts);
300
334
  }
@@ -305,10 +339,14 @@ export default class Base_javascript {
305
339
  * @protected
306
340
  */
307
341
  _getRootDependencies(depTree) {
308
- if (!depTree.dependencies) {
342
+ const allDeps = {
343
+ ...depTree.dependencies,
344
+ ...depTree.optionalDependencies,
345
+ };
346
+ if (Object.keys(allDeps).length === 0) {
309
347
  return new Map();
310
348
  }
311
- return new Map(Object.entries(depTree.dependencies).map(([key, value]) => [key, toPurl(purlType, key, value.version)]));
349
+ return new Map(Object.entries(allDeps).map(([key, value]) => [key, toPurl(purlType, key, value.version)]));
312
350
  }
313
351
  /**
314
352
  * Executes the list command to get dependencies
@@ -332,9 +370,9 @@ export default class Base_javascript {
332
370
  /**
333
371
  * Creates or updates the lock file for the package manager
334
372
  * @param {string} manifestDir - Directory containing the manifest file
335
- * @private
373
+ * @protected
336
374
  */
337
- #createLockFile(manifestDir) {
375
+ _createLockFile(manifestDir) {
338
376
  const originalDir = process.cwd();
339
377
  const isWindows = os.platform() === 'win32';
340
378
  if (isWindows) {
@@ -0,0 +1,158 @@
1
+ /** @typedef {{name: string, version: string, children: string[], hashes?: Array<{alg: string, content: 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
+ * @param {Object} [opts={}]
14
+ * @returns {boolean}
15
+ */
16
+ validateLockFile(manifestDir: string, opts?: Object): boolean;
17
+ /**
18
+ * Walk up from manifestDir to find the directory containing the lock file.
19
+ * Follows the same pattern as Base_javascript._findLockFileDir().
20
+ * @param {string} manifestDir
21
+ * @param {Object} [opts={}]
22
+ * @returns {string|null}
23
+ * @protected
24
+ */
25
+ protected _findLockFileDir(manifestDir: string, opts?: Object): string | null;
26
+ /**
27
+ * Detect workspace root boundaries.
28
+ * Currently only uv has native workspace support ([tool.uv.workspace] in pyproject.toml).
29
+ * Poetry has no workspace/monorepo support (python-poetry/poetry#2270), so each
30
+ * poetry project is treated independently — see Python_poetry._findLockFileDir().
31
+ * @param {string} dir
32
+ * @returns {boolean}
33
+ * @protected
34
+ */
35
+ protected _isWorkspaceRoot(dir: string): boolean;
36
+ /**
37
+ * Read project license from pyproject.toml, with fallback to LICENSE file.
38
+ * @param {string} manifestPath
39
+ * @returns {string|null}
40
+ */
41
+ readLicenseFromManifest(manifestPath: string): string | null;
42
+ /**
43
+ * @param {string} manifest - path to pyproject.toml
44
+ * @param {Object} [opts={}]
45
+ * @returns {Promise<Provided>}
46
+ */
47
+ provideStack(manifest: string, opts?: Object): Promise<Provided>;
48
+ /**
49
+ * @param {string} manifest - path to pyproject.toml
50
+ * @param {Object} [opts={}]
51
+ * @returns {Promise<Provided>}
52
+ */
53
+ provideComponent(manifest: string, opts?: Object): Promise<Provided>;
54
+ /**
55
+ * @returns {string}
56
+ * @protected
57
+ */
58
+ protected _lockFileName(): string;
59
+ /**
60
+ * @returns {string}
61
+ * @protected
62
+ */
63
+ protected _cmdName(): string;
64
+ /**
65
+ * Returns the package manager name (e.g. pip, poetry, uv)
66
+ * @returns {string}
67
+ */
68
+ packageManagerName(): string;
69
+ /**
70
+ * Resolve dependencies using the tool-specific command and parser.
71
+ *
72
+ * @param {string} manifestDir - directory containing the target pyproject.toml
73
+ * @param {string} workspaceDir - workspace root (where the lock file lives);
74
+ * only used by providers that need workspace-level resolution (e.g. uv)
75
+ * @param {object} parsed - parsed pyproject.toml
76
+ * @param {Object} opts
77
+ * @returns {Promise<DependencyData>}
78
+ * @protected
79
+ */
80
+ protected _getDependencyData(manifestDir: string, workspaceDir: string, parsed: object, opts: Object): Promise<DependencyData>;
81
+ /**
82
+ * Canonicalize a Python package name per PEP 503.
83
+ * @param {string} name
84
+ * @returns {string}
85
+ * @protected
86
+ */
87
+ protected _canonicalize(name: string): string;
88
+ /**
89
+ * Get the project name from pyproject.toml.
90
+ * @param {object} parsed
91
+ * @returns {string|null}
92
+ * @protected
93
+ */
94
+ protected _getProjectName(parsed: object): string | null;
95
+ /**
96
+ * Get the project version from pyproject.toml.
97
+ * @param {object} parsed
98
+ * @returns {string|null}
99
+ * @protected
100
+ */
101
+ protected _getProjectVersion(parsed: object): string | null;
102
+ /**
103
+ * Scan raw pyproject.toml text for dependencies with ignore markers.
104
+ * @param {string} manifestPath
105
+ * @returns {Set<string>}
106
+ * @protected
107
+ */
108
+ protected _getIgnoredDeps(manifestPath: string): Set<string>;
109
+ /**
110
+ * Compute the set of graph nodes reachable from direct deps, excluding ignored.
111
+ * @param {Map<string, GraphEntry>} graph
112
+ * @param {string[]} directDeps
113
+ * @param {Set<string>} ignoredDeps
114
+ * @returns {Set<string>}
115
+ * @protected
116
+ */
117
+ protected _reachableNodes(graph: Map<string, GraphEntry>, directDeps: string[], ignoredDeps: Set<string>): Set<string>;
118
+ /**
119
+ * @param {string} name
120
+ * @param {string} version
121
+ * @returns {PackageURL}
122
+ * @protected
123
+ */
124
+ protected _toPurl(name: string, version: string): PackageURL;
125
+ /**
126
+ * Create SBOM json string for a pyproject.toml project.
127
+ * @param {string} manifest - path to pyproject.toml
128
+ * @param {Object} opts
129
+ * @param {boolean} includeTransitive
130
+ * @returns {Promise<string>}
131
+ * @private
132
+ */
133
+ private _createSbom;
134
+ }
135
+ export type GraphEntry = {
136
+ name: string;
137
+ version: string;
138
+ children: string[];
139
+ hashes?: Array<{
140
+ alg: string;
141
+ content: string;
142
+ }>;
143
+ };
144
+ export type DepTreeEntry = {
145
+ name: string;
146
+ version: string;
147
+ dependencies: DepTreeEntry[];
148
+ };
149
+ export type DependencyData = {
150
+ directDeps: string[];
151
+ graph: Map<string, GraphEntry>;
152
+ };
153
+ export type Provided = {
154
+ ecosystem: string;
155
+ content: string;
156
+ contentType: string;
157
+ };
158
+ import { PackageURL } from 'packageurl-js';
@@ -0,0 +1,322 @@
1
+ import fs from 'node:fs';
2
+ import path from 'node:path';
3
+ import { PackageURL } from 'packageurl-js';
4
+ import { parse as parseToml } from 'smol-toml';
5
+ import { getLicense } from '../license/license_utils.js';
6
+ import Sbom from '../sbom.js';
7
+ import { getCustom } from '../tools.js';
8
+ const ecosystem = 'pip';
9
+ const IGNORE_MARKERS = ['exhortignore', 'trustify-da-ignore'];
10
+ const NO_SCOPE = undefined;
11
+ const DEFAULT_ROOT_NAME = 'default-pip-root';
12
+ const DEFAULT_ROOT_VERSION = '0.0.0';
13
+ /** @typedef {{name: string, version: string, children: string[], hashes?: Array<{alg: string, content: string}>}} GraphEntry */
14
+ /** @typedef {{name: string, version: string, dependencies: DepTreeEntry[]}} DepTreeEntry */
15
+ /** @typedef {{directDeps: string[], graph: Map<string, GraphEntry>}} DependencyData */
16
+ /** @typedef {{ecosystem: string, content: string, contentType: string}} Provided */
17
+ export default class Base_pyproject {
18
+ /**
19
+ * @param {string} manifestName
20
+ * @returns {boolean}
21
+ */
22
+ isSupported(manifestName) {
23
+ return 'pyproject.toml' === manifestName;
24
+ }
25
+ /**
26
+ * @param {string} manifestDir
27
+ * @param {Object} [opts={}]
28
+ * @returns {boolean}
29
+ */
30
+ validateLockFile(manifestDir, opts = {}) {
31
+ return this._findLockFileDir(manifestDir, opts) != null;
32
+ }
33
+ /**
34
+ * Walk up from manifestDir to find the directory containing the lock file.
35
+ * Follows the same pattern as Base_javascript._findLockFileDir().
36
+ * @param {string} manifestDir
37
+ * @param {Object} [opts={}]
38
+ * @returns {string|null}
39
+ * @protected
40
+ */
41
+ _findLockFileDir(manifestDir, opts = {}) {
42
+ const workspaceDir = getCustom('TRUSTIFY_DA_WORKSPACE_DIR', null, opts);
43
+ if (workspaceDir) {
44
+ const dir = path.resolve(workspaceDir);
45
+ return fs.existsSync(path.join(dir, this._lockFileName())) ? dir : null;
46
+ }
47
+ let dir = path.resolve(manifestDir);
48
+ let parent = dir;
49
+ do {
50
+ dir = parent;
51
+ if (fs.existsSync(path.join(dir, this._lockFileName()))) {
52
+ return dir;
53
+ }
54
+ if (this._isWorkspaceRoot(dir)) {
55
+ return null;
56
+ }
57
+ parent = path.dirname(dir);
58
+ } while (parent !== dir);
59
+ return null;
60
+ }
61
+ /**
62
+ * Detect workspace root boundaries.
63
+ * Currently only uv has native workspace support ([tool.uv.workspace] in pyproject.toml).
64
+ * Poetry has no workspace/monorepo support (python-poetry/poetry#2270), so each
65
+ * poetry project is treated independently — see Python_poetry._findLockFileDir().
66
+ * @param {string} dir
67
+ * @returns {boolean}
68
+ * @protected
69
+ */
70
+ _isWorkspaceRoot(dir) {
71
+ const pyprojectPath = path.join(dir, 'pyproject.toml');
72
+ if (!fs.existsSync(pyprojectPath)) {
73
+ return false;
74
+ }
75
+ try {
76
+ const content = parseToml(fs.readFileSync(pyprojectPath, 'utf-8'));
77
+ if (content.tool?.uv?.workspace) {
78
+ return true;
79
+ }
80
+ }
81
+ catch (_) {
82
+ // ignore parse errors
83
+ }
84
+ return false;
85
+ }
86
+ /**
87
+ * Read project license from pyproject.toml, with fallback to LICENSE file.
88
+ * @param {string} manifestPath
89
+ * @returns {string|null}
90
+ */
91
+ readLicenseFromManifest(manifestPath) {
92
+ let fromManifest = null;
93
+ try {
94
+ let content = fs.readFileSync(manifestPath, 'utf-8');
95
+ let parsed = parseToml(content);
96
+ fromManifest = parsed.project?.license;
97
+ if (typeof fromManifest === 'object' && fromManifest != null) {
98
+ fromManifest = fromManifest.text || null;
99
+ }
100
+ if (!fromManifest) {
101
+ fromManifest = parsed.tool?.poetry?.license || null;
102
+ }
103
+ }
104
+ catch (_) {
105
+ // leave fromManifest as null
106
+ }
107
+ return getLicense(fromManifest, manifestPath);
108
+ }
109
+ /**
110
+ * @param {string} manifest - path to pyproject.toml
111
+ * @param {Object} [opts={}]
112
+ * @returns {Promise<Provided>}
113
+ */
114
+ async provideStack(manifest, opts = {}) {
115
+ return {
116
+ ecosystem,
117
+ content: await this._createSbom(manifest, opts, true),
118
+ contentType: 'application/vnd.cyclonedx+json'
119
+ };
120
+ }
121
+ /**
122
+ * @param {string} manifest - path to pyproject.toml
123
+ * @param {Object} [opts={}]
124
+ * @returns {Promise<Provided>}
125
+ */
126
+ async provideComponent(manifest, opts = {}) {
127
+ return {
128
+ ecosystem,
129
+ content: await this._createSbom(manifest, opts, false),
130
+ contentType: 'application/vnd.cyclonedx+json'
131
+ };
132
+ }
133
+ // --- abstract methods (subclasses must override) ---
134
+ /**
135
+ * @returns {string}
136
+ * @protected
137
+ */
138
+ _lockFileName() {
139
+ throw new TypeError('_lockFileName must be implemented');
140
+ }
141
+ /**
142
+ * @returns {string}
143
+ * @protected
144
+ */
145
+ _cmdName() {
146
+ throw new TypeError('_cmdName must be implemented');
147
+ }
148
+ /**
149
+ * Returns the package manager name (e.g. pip, poetry, uv)
150
+ * @returns {string}
151
+ */
152
+ packageManagerName() {
153
+ return this._cmdName();
154
+ }
155
+ /**
156
+ * Resolve dependencies using the tool-specific command and parser.
157
+ *
158
+ * @param {string} manifestDir - directory containing the target pyproject.toml
159
+ * @param {string} workspaceDir - workspace root (where the lock file lives);
160
+ * only used by providers that need workspace-level resolution (e.g. uv)
161
+ * @param {object} parsed - parsed pyproject.toml
162
+ * @param {Object} opts
163
+ * @returns {Promise<DependencyData>}
164
+ * @protected
165
+ */
166
+ // eslint-disable-next-line no-unused-vars
167
+ async _getDependencyData(manifestDir, workspaceDir, parsed, opts) {
168
+ throw new TypeError('_getDependencyData must be implemented');
169
+ }
170
+ // --- shared helpers ---
171
+ /**
172
+ * Canonicalize a Python package name per PEP 503.
173
+ * @param {string} name
174
+ * @returns {string}
175
+ * @protected
176
+ */
177
+ _canonicalize(name) {
178
+ return name.toLowerCase().replace(/[-_.]+/g, '-');
179
+ }
180
+ /**
181
+ * Get the project name from pyproject.toml.
182
+ * @param {object} parsed
183
+ * @returns {string|null}
184
+ * @protected
185
+ */
186
+ _getProjectName(parsed) {
187
+ return parsed.project?.name || parsed.tool?.poetry?.name || null;
188
+ }
189
+ /**
190
+ * Get the project version from pyproject.toml.
191
+ * @param {object} parsed
192
+ * @returns {string|null}
193
+ * @protected
194
+ */
195
+ _getProjectVersion(parsed) {
196
+ return parsed.project?.version || parsed.tool?.poetry?.version || null;
197
+ }
198
+ /**
199
+ * Scan raw pyproject.toml text for dependencies with ignore markers.
200
+ * @param {string} manifestPath
201
+ * @returns {Set<string>}
202
+ * @protected
203
+ */
204
+ _getIgnoredDeps(manifestPath) {
205
+ let ignored = new Set();
206
+ let content = fs.readFileSync(manifestPath, 'utf-8');
207
+ let lines = content.split(/\r?\n/);
208
+ for (let line of lines) {
209
+ if (!IGNORE_MARKERS.some(m => line.includes(m))) {
210
+ continue;
211
+ }
212
+ // PEP 621 style: "requests>=2.25" #exhortignore
213
+ let pep621Match = line.match(/^\s*"([^"]+)"/);
214
+ if (pep621Match) {
215
+ let reqStr = pep621Match[1];
216
+ let nameMatch = reqStr.match(/^([A-Za-z0-9]([A-Za-z0-9._-]*[A-Za-z0-9])?)/);
217
+ if (nameMatch) {
218
+ ignored.add(this._canonicalize(nameMatch[1]));
219
+ }
220
+ continue;
221
+ }
222
+ // Poetry style: requests = "^2.25" #exhortignore
223
+ let poetryMatch = line.match(/^\s*([A-Za-z0-9][A-Za-z0-9._-]*)\s*=/);
224
+ if (poetryMatch) {
225
+ ignored.add(this._canonicalize(poetryMatch[1]));
226
+ }
227
+ }
228
+ return ignored;
229
+ }
230
+ /**
231
+ * Compute the set of graph nodes reachable from direct deps, excluding ignored.
232
+ * @param {Map<string, GraphEntry>} graph
233
+ * @param {string[]} directDeps
234
+ * @param {Set<string>} ignoredDeps
235
+ * @returns {Set<string>}
236
+ * @protected
237
+ */
238
+ _reachableNodes(graph, directDeps, ignoredDeps) {
239
+ let reachable = new Set();
240
+ let queue = directDeps.filter(k => !ignoredDeps.has(k) && graph.has(k));
241
+ while (queue.length > 0) {
242
+ let key = queue.shift();
243
+ if (reachable.has(key)) {
244
+ continue;
245
+ }
246
+ reachable.add(key);
247
+ for (let child of graph.get(key).children) {
248
+ if (!ignoredDeps.has(child) && graph.has(child) && !reachable.has(child)) {
249
+ queue.push(child);
250
+ }
251
+ }
252
+ }
253
+ return reachable;
254
+ }
255
+ /**
256
+ * @param {string} name
257
+ * @param {string} version
258
+ * @returns {PackageURL}
259
+ * @protected
260
+ */
261
+ _toPurl(name, version) {
262
+ return new PackageURL('pypi', undefined, name, version, undefined, undefined);
263
+ }
264
+ /**
265
+ * Create SBOM json string for a pyproject.toml project.
266
+ * @param {string} manifest - path to pyproject.toml
267
+ * @param {Object} opts
268
+ * @param {boolean} includeTransitive
269
+ * @returns {Promise<string>}
270
+ * @private
271
+ */
272
+ async _createSbom(manifest, opts, includeTransitive) {
273
+ let manifestDir = path.dirname(manifest);
274
+ let content = fs.readFileSync(manifest, 'utf-8');
275
+ let parsed = parseToml(content);
276
+ let workspaceDir = this._findLockFileDir(manifestDir, opts) || manifestDir;
277
+ let { directDeps, graph } = await this._getDependencyData(manifestDir, workspaceDir, parsed, opts);
278
+ let ignoredDeps = this._getIgnoredDeps(manifest);
279
+ let sbom = new Sbom();
280
+ let rootName = this._getProjectName(parsed) || DEFAULT_ROOT_NAME;
281
+ let rootVersion = this._getProjectVersion(parsed) || DEFAULT_ROOT_VERSION;
282
+ let rootPurl = this._toPurl(rootName, rootVersion);
283
+ let license = this.readLicenseFromManifest(manifest);
284
+ sbom.addRoot(rootPurl, license);
285
+ if (includeTransitive) {
286
+ let reachable = this._reachableNodes(graph, directDeps, ignoredDeps);
287
+ for (let key of directDeps) {
288
+ if (!reachable.has(key)) {
289
+ continue;
290
+ }
291
+ let entry = graph.get(key);
292
+ sbom.addDependency(rootPurl, this._toPurl(entry.name, entry.version), NO_SCOPE, entry.hashes);
293
+ }
294
+ for (let [key, entry] of graph) {
295
+ if (!reachable.has(key)) {
296
+ continue;
297
+ }
298
+ let parentPurl = this._toPurl(entry.name, entry.version);
299
+ for (let child of entry.children) {
300
+ if (!reachable.has(child)) {
301
+ continue;
302
+ }
303
+ let childEntry = graph.get(child);
304
+ sbom.addDependency(parentPurl, this._toPurl(childEntry.name, childEntry.version), NO_SCOPE, childEntry.hashes);
305
+ }
306
+ }
307
+ }
308
+ else {
309
+ for (let key of directDeps) {
310
+ if (ignoredDeps.has(key)) {
311
+ continue;
312
+ }
313
+ let entry = graph.get(key);
314
+ if (!entry) {
315
+ continue;
316
+ }
317
+ sbom.addDependency(rootPurl, this._toPurl(entry.name, entry.version), NO_SCOPE, entry.hashes);
318
+ }
319
+ }
320
+ return sbom.getAsJsonString(opts);
321
+ }
322
+ }
@@ -0,0 +1,5 @@
1
+ export function getParser(): Promise<Parser>;
2
+ export function getFromQuery(): Promise<Query>;
3
+ export function getArgQuery(): Promise<Query>;
4
+ import { Parser } from 'web-tree-sitter';
5
+ import { Query } from 'web-tree-sitter';