@trustify-da/trustify-da-javascript-client 0.3.0-ea.9988076 → 0.3.0-ea.9a6adf7
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 +127 -10
- package/dist/package.json +27 -23
- package/dist/src/analysis.d.ts +21 -5
- package/dist/src/analysis.js +53 -4
- package/dist/src/batch_opts.d.ts +24 -0
- package/dist/src/batch_opts.js +35 -0
- package/dist/src/cli.js +171 -4
- package/dist/src/cyclone_dx_sbom.d.ts +14 -1
- package/dist/src/cyclone_dx_sbom.js +43 -8
- package/dist/src/index.d.ts +137 -6
- package/dist/src/index.js +350 -5
- package/dist/src/license/index.d.ts +3 -3
- package/dist/src/license/index.js +4 -1
- package/dist/src/license/license_utils.js +4 -1
- package/dist/src/license/licenses_api.d.ts +2 -2
- package/dist/src/oci_image/images.d.ts +1 -1
- package/dist/src/oci_image/utils.d.ts +5 -5
- package/dist/src/oci_image/utils.js +11 -2
- package/dist/src/provider.d.ts +8 -4
- package/dist/src/provider.js +13 -4
- package/dist/src/providers/base_java.d.ts +14 -12
- package/dist/src/providers/base_java.js +18 -44
- package/dist/src/providers/base_javascript.d.ts +37 -10
- package/dist/src/providers/base_javascript.js +108 -20
- package/dist/src/providers/base_pyproject.d.ts +158 -0
- package/dist/src/providers/base_pyproject.js +322 -0
- package/dist/src/providers/golang_gomodules.d.ts +23 -13
- package/dist/src/providers/golang_gomodules.js +165 -119
- package/dist/src/providers/gomod_parser.d.ts +4 -0
- package/dist/src/providers/gomod_parser.js +16 -0
- package/dist/src/providers/java_gradle.d.ts +19 -0
- package/dist/src/providers/java_gradle.js +116 -2
- package/dist/src/providers/java_gradle_groovy.d.ts +1 -1
- package/dist/src/providers/java_gradle_kotlin.d.ts +1 -1
- package/dist/src/providers/java_maven.d.ts +10 -2
- package/dist/src/providers/java_maven.js +165 -1
- package/dist/src/providers/javascript_bun.d.ts +10 -0
- package/dist/src/providers/javascript_bun.js +100 -0
- package/dist/src/providers/javascript_npm.d.ts +6 -0
- package/dist/src/providers/javascript_npm.js +21 -0
- package/dist/src/providers/javascript_pnpm.d.ts +1 -1
- package/dist/src/providers/javascript_pnpm.js +8 -4
- package/dist/src/providers/manifest.d.ts +2 -0
- package/dist/src/providers/manifest.js +22 -4
- package/dist/src/providers/marker_evaluator.d.ts +14 -0
- package/dist/src/providers/marker_evaluator.js +191 -0
- package/dist/src/providers/processors/yarn_berry_processor.d.ts +2 -2
- package/dist/src/providers/processors/yarn_berry_processor.js +88 -5
- package/dist/src/providers/processors/yarn_classic_processor.d.ts +2 -2
- package/dist/src/providers/python_controller.d.ts +5 -1
- package/dist/src/providers/python_controller.js +65 -7
- package/dist/src/providers/python_pip.d.ts +5 -0
- package/dist/src/providers/python_pip.js +6 -6
- package/dist/src/providers/python_pip_pyproject.d.ts +61 -0
- package/dist/src/providers/python_pip_pyproject.js +146 -0
- package/dist/src/providers/python_poetry.d.ts +98 -0
- package/dist/src/providers/python_poetry.js +286 -0
- package/dist/src/providers/python_uv.d.ts +46 -0
- package/dist/src/providers/python_uv.js +269 -0
- package/dist/src/providers/rust_cargo.d.ts +12 -3
- package/dist/src/providers/rust_cargo.js +41 -6
- package/dist/src/providers/tree-sitter-gomod.wasm +0 -0
- package/dist/src/sbom.d.ts +14 -1
- package/dist/src/sbom.js +13 -2
- package/dist/src/tools.d.ts +28 -2
- package/dist/src/tools.js +58 -0
- package/dist/src/workspace.d.ts +70 -0
- package/dist/src/workspace.js +256 -0
- package/package.json +28 -24
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export type ecosystem_maven =
|
|
1
|
+
export type ecosystem_maven = any;
|
|
2
2
|
/** @typedef {import('../provider').Provider} */
|
|
3
3
|
/** @typedef {import('../provider').Provided} Provided */
|
|
4
4
|
/** @typedef {{name: string, version: string}} Package */
|
|
@@ -20,6 +20,11 @@ export default class Base_Java {
|
|
|
20
20
|
CONFLICT_REGEX: RegExp;
|
|
21
21
|
globalBinary: string;
|
|
22
22
|
localWrapper: string;
|
|
23
|
+
/**
|
|
24
|
+
* Returns the package manager name (e.g. mvn, gradle)
|
|
25
|
+
* @returns {string}
|
|
26
|
+
*/
|
|
27
|
+
packageManagerName(): string;
|
|
23
28
|
/**
|
|
24
29
|
* Recursively populates the SBOM instance with the parsed graph
|
|
25
30
|
* @param {string} src - Source dependency to start the calculations from
|
|
@@ -28,6 +33,13 @@ export default class Base_Java {
|
|
|
28
33
|
* @param {Sbom} sbom - The SBOM where the dependencies are being added
|
|
29
34
|
*/
|
|
30
35
|
parseDependencyTree(src: string, srcDepth: number, lines: any[], sbom: Sbom): void;
|
|
36
|
+
/**
|
|
37
|
+
* Calculates how deep in the graph is the given line
|
|
38
|
+
* @param {string} line - line to calculate the depth from
|
|
39
|
+
* @returns {number} The calculated depth
|
|
40
|
+
* @protected
|
|
41
|
+
*/
|
|
42
|
+
protected _getDepth(line: string): number;
|
|
31
43
|
/**
|
|
32
44
|
* Create a PackageURL from any line in a Text Graph dependency tree for a manifest path.
|
|
33
45
|
* @param {string} line - line to parse from a dependencies.txt file
|
|
@@ -57,18 +69,8 @@ export default class Base_Java {
|
|
|
57
69
|
* @returns string
|
|
58
70
|
*/
|
|
59
71
|
selectToolBinary(manifestPath: string, opts: {}): string | null;
|
|
60
|
-
/**
|
|
61
|
-
*
|
|
62
|
-
* @param {string} startingManifest - the path of the manifest from which to start searching for the wrapper
|
|
63
|
-
* @param {string} repoRoot - the root of the repository at which point to stop searching for mvnw, derived via git if unset and then fallsback
|
|
64
|
-
* to the root of the drive the manifest is on (assumes absolute path is given)
|
|
65
|
-
* @returns {string|undefined}
|
|
66
|
-
*/
|
|
67
|
-
traverseForWrapper(startingManifest: string, repoRoot?: string): string | undefined;
|
|
68
|
-
normalizePath(thePath: any): string;
|
|
69
|
-
#private;
|
|
70
72
|
}
|
|
71
|
-
export type Provided =
|
|
73
|
+
export type Provided = any;
|
|
72
74
|
export type Package = {
|
|
73
75
|
name: string;
|
|
74
76
|
version: string;
|
|
@@ -1,7 +1,6 @@
|
|
|
1
|
-
import fs from 'node:fs';
|
|
2
1
|
import path from 'node:path';
|
|
3
2
|
import { PackageURL } from 'packageurl-js';
|
|
4
|
-
import { getCustomPath,
|
|
3
|
+
import { getCustomPath, getWrapperPreference, invokeCommand, traverseForWrapper } from "../tools.js";
|
|
5
4
|
/** @typedef {import('../provider').Provider} */
|
|
6
5
|
/** @typedef {import('../provider').Provided} Provided */
|
|
7
6
|
/** @typedef {{name: string, version: string}} Package */
|
|
@@ -26,6 +25,13 @@ export default class Base_Java {
|
|
|
26
25
|
this.globalBinary = globalBinary;
|
|
27
26
|
this.localWrapper = localWrapper;
|
|
28
27
|
}
|
|
28
|
+
/**
|
|
29
|
+
* Returns the package manager name (e.g. mvn, gradle)
|
|
30
|
+
* @returns {string}
|
|
31
|
+
*/
|
|
32
|
+
packageManagerName() {
|
|
33
|
+
return this.globalBinary;
|
|
34
|
+
}
|
|
29
35
|
/**
|
|
30
36
|
* Recursively populates the SBOM instance with the parsed graph
|
|
31
37
|
* @param {string} src - Source dependency to start the calculations from
|
|
@@ -42,7 +48,7 @@ export default class Base_Java {
|
|
|
42
48
|
}
|
|
43
49
|
let index = 0;
|
|
44
50
|
let target = lines[index];
|
|
45
|
-
let targetDepth = this
|
|
51
|
+
let targetDepth = this._getDepth(target);
|
|
46
52
|
while (targetDepth > srcDepth && index < lines.length) {
|
|
47
53
|
if (targetDepth === srcDepth + 1) {
|
|
48
54
|
let from = this.parseDep(src);
|
|
@@ -55,22 +61,25 @@ export default class Base_Java {
|
|
|
55
61
|
}
|
|
56
62
|
}
|
|
57
63
|
else {
|
|
58
|
-
this.parseDependencyTree(lines[index - 1], this
|
|
64
|
+
this.parseDependencyTree(lines[index - 1], this._getDepth(lines[index - 1]), lines.slice(index), sbom);
|
|
59
65
|
}
|
|
60
66
|
target = lines[++index];
|
|
61
|
-
targetDepth = this
|
|
67
|
+
targetDepth = this._getDepth(target);
|
|
62
68
|
}
|
|
63
69
|
}
|
|
64
70
|
/**
|
|
65
71
|
* Calculates how deep in the graph is the given line
|
|
66
72
|
* @param {string} line - line to calculate the depth from
|
|
67
73
|
* @returns {number} The calculated depth
|
|
68
|
-
* @
|
|
74
|
+
* @protected
|
|
69
75
|
*/
|
|
70
|
-
|
|
71
|
-
if (line ===
|
|
76
|
+
_getDepth(line) {
|
|
77
|
+
if (!line || line.trim() === '') {
|
|
72
78
|
return -1;
|
|
73
79
|
}
|
|
80
|
+
if (line.match(/^\w/)) {
|
|
81
|
+
return 0;
|
|
82
|
+
}
|
|
74
83
|
return ((line.indexOf('-') - 1) / 3) + 1;
|
|
75
84
|
}
|
|
76
85
|
/**
|
|
@@ -131,7 +140,7 @@ export default class Base_Java {
|
|
|
131
140
|
const toolPath = getCustomPath(this.globalBinary, opts);
|
|
132
141
|
const useWrapper = getWrapperPreference(this.globalBinary, opts);
|
|
133
142
|
if (useWrapper) {
|
|
134
|
-
const wrapper = this.
|
|
143
|
+
const wrapper = traverseForWrapper(manifestDir, this.localWrapper);
|
|
135
144
|
if (wrapper !== undefined) {
|
|
136
145
|
try {
|
|
137
146
|
this._invokeCommand(wrapper, ['--version'], { cwd: manifestDir });
|
|
@@ -156,39 +165,4 @@ export default class Base_Java {
|
|
|
156
165
|
}
|
|
157
166
|
return toolPath;
|
|
158
167
|
}
|
|
159
|
-
/**
|
|
160
|
-
*
|
|
161
|
-
* @param {string} startingManifest - the path of the manifest from which to start searching for the wrapper
|
|
162
|
-
* @param {string} repoRoot - the root of the repository at which point to stop searching for mvnw, derived via git if unset and then fallsback
|
|
163
|
-
* to the root of the drive the manifest is on (assumes absolute path is given)
|
|
164
|
-
* @returns {string|undefined}
|
|
165
|
-
*/
|
|
166
|
-
traverseForWrapper(startingManifest, repoRoot = undefined) {
|
|
167
|
-
const normalizedManifest = this.normalizePath(startingManifest);
|
|
168
|
-
const currentDir = this.normalizePath(path.dirname(normalizedManifest));
|
|
169
|
-
repoRoot = repoRoot || getGitRootDir(currentDir) || path.parse(normalizedManifest).root;
|
|
170
|
-
const wrapperPath = path.join(currentDir, this.localWrapper);
|
|
171
|
-
try {
|
|
172
|
-
fs.accessSync(wrapperPath, fs.constants.X_OK);
|
|
173
|
-
return wrapperPath;
|
|
174
|
-
}
|
|
175
|
-
catch (error) {
|
|
176
|
-
if (error.code === 'ENOENT') {
|
|
177
|
-
const rootDir = path.parse(currentDir).root;
|
|
178
|
-
if (currentDir === repoRoot || currentDir === rootDir) {
|
|
179
|
-
return undefined;
|
|
180
|
-
}
|
|
181
|
-
const parentDir = path.dirname(currentDir);
|
|
182
|
-
if (parentDir === currentDir || parentDir === rootDir) {
|
|
183
|
-
return undefined;
|
|
184
|
-
}
|
|
185
|
-
return this.traverseForWrapper(path.join(parentDir, path.basename(normalizedManifest)), repoRoot);
|
|
186
|
-
}
|
|
187
|
-
throw new Error(`failure searching for ${this.localWrapper}`, { cause: error });
|
|
188
|
-
}
|
|
189
|
-
}
|
|
190
|
-
normalizePath(thePath) {
|
|
191
|
-
const normalized = path.resolve(thePath).normalize();
|
|
192
|
-
return process.platform === 'win32' ? normalized.toLowerCase() : normalized;
|
|
193
|
-
}
|
|
194
168
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export type purlType =
|
|
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:
|
|
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
|
|
@@ -67,25 +72,40 @@ export default class Base_javascript {
|
|
|
67
72
|
*/
|
|
68
73
|
isSupported(manifestName: string): boolean;
|
|
69
74
|
/**
|
|
70
|
-
*
|
|
75
|
+
* Walks up the directory tree from manifestDir looking for the lock file.
|
|
76
|
+
* Stops when the lock file is found, when a package.json with a "workspaces"
|
|
77
|
+
* field is encountered without a lock file (workspace root boundary), or
|
|
78
|
+
* when the filesystem root is reached.
|
|
79
|
+
*
|
|
80
|
+
* When TRUSTIFY_DA_WORKSPACE_DIR is set, checks only that directory (no walk-up).
|
|
81
|
+
*
|
|
82
|
+
* @param {string} manifestDir - The directory to start searching from
|
|
83
|
+
* @param {Object} [opts={}] - optional; may contain TRUSTIFY_DA_WORKSPACE_DIR
|
|
84
|
+
* @returns {string|null} The directory containing the lock file, or null
|
|
85
|
+
* @protected
|
|
86
|
+
*/
|
|
87
|
+
protected _isWorkspaceRoot(dir: any): string | null;
|
|
88
|
+
_findLockFileDir(manifestDir: any, opts?: {}): string | null;
|
|
89
|
+
/**
|
|
71
90
|
* @param {string} manifestDir - The base directory where the manifest is located
|
|
91
|
+
* @param {Object} [opts={}] - optional; may contain TRUSTIFY_DA_WORKSPACE_DIR
|
|
72
92
|
* @returns {boolean} True if the lock file exists
|
|
73
93
|
*/
|
|
74
|
-
validateLockFile(manifestDir: string): boolean;
|
|
94
|
+
validateLockFile(manifestDir: string, opts?: Object): boolean;
|
|
75
95
|
/**
|
|
76
96
|
* Provides content and content type for stack analysis
|
|
77
97
|
* @param {string} manifestPath - The manifest path or name
|
|
78
98
|
* @param {Object} [opts={}] - Optional configuration options
|
|
79
99
|
* @returns {Provided} The provided data for stack analysis
|
|
80
100
|
*/
|
|
81
|
-
provideStack(manifestPath: string, opts?:
|
|
101
|
+
provideStack(manifestPath: string, opts?: Object): Provided;
|
|
82
102
|
/**
|
|
83
103
|
* Provides content and content type for component analysis
|
|
84
104
|
* @param {string} manifestPath - Path to package.json for component report
|
|
85
105
|
* @param {Object} [opts={}] - Optional configuration options
|
|
86
106
|
* @returns {Provided} The provided data for component analysis
|
|
87
107
|
*/
|
|
88
|
-
provideComponent(manifestPath: string, opts?:
|
|
108
|
+
provideComponent(manifestPath: string, opts?: Object): Provided;
|
|
89
109
|
/**
|
|
90
110
|
* Read license from manifest (package.json). Reused by npm, pnpm, yarn.
|
|
91
111
|
* @param {string} manifestPath - path to package.json
|
|
@@ -95,24 +115,25 @@ export default class Base_javascript {
|
|
|
95
115
|
/**
|
|
96
116
|
* Builds the dependency tree for the project
|
|
97
117
|
* @param {boolean} includeTransitive - Whether to include transitive dependencies
|
|
118
|
+
* @param {Object} [opts={}] - Configuration options; when `TRUSTIFY_DA_WORKSPACE_DIR` is set, commands run from workspace root
|
|
98
119
|
* @returns {Object} The dependency tree
|
|
99
120
|
* @protected
|
|
100
121
|
*/
|
|
101
|
-
protected _buildDependencyTree(includeTransitive: boolean):
|
|
122
|
+
protected _buildDependencyTree(includeTransitive: boolean, opts?: Object): Object;
|
|
102
123
|
/**
|
|
103
124
|
* Recursively builds the Sbom from the JSON that npm listing returns
|
|
104
125
|
* @param {Sbom} sbom - The SBOM object to add dependencies to
|
|
105
126
|
* @param {Object} depTree - The current dependency tree
|
|
106
127
|
* @protected
|
|
107
128
|
*/
|
|
108
|
-
protected _addDependenciesToSbom(sbom: Sbom, depTree:
|
|
129
|
+
protected _addDependenciesToSbom(sbom: Sbom, depTree: Object): void;
|
|
109
130
|
/**
|
|
110
131
|
* Extracts root dependencies from the dependency tree
|
|
111
132
|
* @param {Object} depTree - The dependency tree object
|
|
112
133
|
* @returns {Map<string, PackageURL>} Map of dependency names to their PackageURL objects
|
|
113
134
|
* @protected
|
|
114
135
|
*/
|
|
115
|
-
protected _getRootDependencies(depTree:
|
|
136
|
+
protected _getRootDependencies(depTree: Object): Map<string, PackageURL>;
|
|
116
137
|
/**
|
|
117
138
|
* Gets the version of the package manager
|
|
118
139
|
* @returns {string} The version string of the package manager
|
|
@@ -120,6 +141,12 @@ export default class Base_javascript {
|
|
|
120
141
|
*/
|
|
121
142
|
protected _version(): string;
|
|
122
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
|
+
/**
|
|
123
150
|
* Parses the dependency tree output
|
|
124
151
|
* @param {string} output - The output to parse
|
|
125
152
|
* @returns {string} The parsed output
|
|
@@ -128,6 +155,6 @@ export default class Base_javascript {
|
|
|
128
155
|
protected _parseDepTreeOutput(output: string): string;
|
|
129
156
|
#private;
|
|
130
157
|
}
|
|
131
|
-
export type Provided =
|
|
158
|
+
export type Provided = any;
|
|
132
159
|
import Manifest from './manifest.js';
|
|
133
160
|
import Sbom from '../sbom.js';
|
|
@@ -3,7 +3,7 @@ import os from "node:os";
|
|
|
3
3
|
import path from 'node:path';
|
|
4
4
|
import { getLicense } from '../license/license_utils.js';
|
|
5
5
|
import Sbom from '../sbom.js';
|
|
6
|
-
import { getCustom, getCustomPath, invokeCommand, toPurl, toPurlFromString } from
|
|
6
|
+
import { getCustom, getCustomPath, invokeCommand, toPurl, toPurlFromString } from '../tools.js';
|
|
7
7
|
import Manifest from './manifest.js';
|
|
8
8
|
/** @typedef {import('../provider').Provider} */
|
|
9
9
|
/** @typedef {import('../provider').Provided} Provided */
|
|
@@ -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
|
|
@@ -97,13 +104,63 @@ export default class Base_javascript {
|
|
|
97
104
|
return 'package.json' === manifestName;
|
|
98
105
|
}
|
|
99
106
|
/**
|
|
100
|
-
*
|
|
107
|
+
* Walks up the directory tree from manifestDir looking for the lock file.
|
|
108
|
+
* Stops when the lock file is found, when a package.json with a "workspaces"
|
|
109
|
+
* field is encountered without a lock file (workspace root boundary), or
|
|
110
|
+
* when the filesystem root is reached.
|
|
111
|
+
*
|
|
112
|
+
* When TRUSTIFY_DA_WORKSPACE_DIR is set, checks only that directory (no walk-up).
|
|
113
|
+
*
|
|
114
|
+
* @param {string} manifestDir - The directory to start searching from
|
|
115
|
+
* @param {Object} [opts={}] - optional; may contain TRUSTIFY_DA_WORKSPACE_DIR
|
|
116
|
+
* @returns {string|null} The directory containing the lock file, or null
|
|
117
|
+
* @protected
|
|
118
|
+
*/
|
|
119
|
+
_isWorkspaceRoot(dir) {
|
|
120
|
+
if (fs.existsSync(path.join(dir, 'pnpm-workspace.yaml'))) {
|
|
121
|
+
return true;
|
|
122
|
+
}
|
|
123
|
+
const pkgJsonPath = path.join(dir, 'package.json');
|
|
124
|
+
if (fs.existsSync(pkgJsonPath)) {
|
|
125
|
+
try {
|
|
126
|
+
const content = JSON.parse(fs.readFileSync(pkgJsonPath, 'utf-8'));
|
|
127
|
+
if (content.workspaces) {
|
|
128
|
+
return true;
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
catch (_) {
|
|
132
|
+
// ignore parse errors
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
return false;
|
|
136
|
+
}
|
|
137
|
+
_findLockFileDir(manifestDir, opts = {}) {
|
|
138
|
+
const workspaceDir = getCustom('TRUSTIFY_DA_WORKSPACE_DIR', null, opts);
|
|
139
|
+
if (workspaceDir) {
|
|
140
|
+
const dir = path.resolve(workspaceDir);
|
|
141
|
+
return fs.existsSync(path.join(dir, this._lockFileName())) ? dir : null;
|
|
142
|
+
}
|
|
143
|
+
let dir = path.resolve(manifestDir);
|
|
144
|
+
let parent = dir;
|
|
145
|
+
do {
|
|
146
|
+
dir = parent;
|
|
147
|
+
if (fs.existsSync(path.join(dir, this._lockFileName()))) {
|
|
148
|
+
return dir;
|
|
149
|
+
}
|
|
150
|
+
if (this._isWorkspaceRoot(dir)) {
|
|
151
|
+
return null;
|
|
152
|
+
}
|
|
153
|
+
parent = path.dirname(dir);
|
|
154
|
+
} while (parent !== dir);
|
|
155
|
+
return null;
|
|
156
|
+
}
|
|
157
|
+
/**
|
|
101
158
|
* @param {string} manifestDir - The base directory where the manifest is located
|
|
159
|
+
* @param {Object} [opts={}] - optional; may contain TRUSTIFY_DA_WORKSPACE_DIR
|
|
102
160
|
* @returns {boolean} True if the lock file exists
|
|
103
161
|
*/
|
|
104
|
-
validateLockFile(manifestDir) {
|
|
105
|
-
|
|
106
|
-
return fs.existsSync(lock);
|
|
162
|
+
validateLockFile(manifestDir, opts = {}) {
|
|
163
|
+
return this._findLockFileDir(manifestDir, opts) !== null;
|
|
107
164
|
}
|
|
108
165
|
/**
|
|
109
166
|
* Provides content and content type for stack analysis
|
|
@@ -159,14 +216,16 @@ export default class Base_javascript {
|
|
|
159
216
|
/**
|
|
160
217
|
* Builds the dependency tree for the project
|
|
161
218
|
* @param {boolean} includeTransitive - Whether to include transitive dependencies
|
|
219
|
+
* @param {Object} [opts={}] - Configuration options; when `TRUSTIFY_DA_WORKSPACE_DIR` is set, commands run from workspace root
|
|
162
220
|
* @returns {Object} The dependency tree
|
|
163
221
|
* @protected
|
|
164
222
|
*/
|
|
165
|
-
_buildDependencyTree(includeTransitive) {
|
|
223
|
+
_buildDependencyTree(includeTransitive, opts = {}) {
|
|
166
224
|
this._version();
|
|
167
|
-
|
|
168
|
-
this
|
|
169
|
-
|
|
225
|
+
const manifestDir = path.dirname(this.#manifest.manifestPath);
|
|
226
|
+
const cmdDir = this._findLockFileDir(manifestDir, opts) || manifestDir;
|
|
227
|
+
this._createLockFile(cmdDir);
|
|
228
|
+
let output = this.#executeListCmd(includeTransitive, cmdDir);
|
|
170
229
|
output = this._parseDepTreeOutput(output);
|
|
171
230
|
return JSON.parse(output);
|
|
172
231
|
}
|
|
@@ -177,15 +236,38 @@ export default class Base_javascript {
|
|
|
177
236
|
* @private
|
|
178
237
|
*/
|
|
179
238
|
#getSBOM(opts = {}) {
|
|
180
|
-
const depsObject = this._buildDependencyTree(true);
|
|
239
|
+
const depsObject = this._buildDependencyTree(true, opts);
|
|
181
240
|
let mainComponent = toPurl(purlType, this.#manifest.name, this.#manifest.version);
|
|
182
241
|
const license = this.readLicenseFromManifest(this.#manifest.manifestPath);
|
|
183
242
|
let sbom = new Sbom();
|
|
184
243
|
sbom.addRoot(mainComponent, license);
|
|
185
244
|
this._addDependenciesToSbom(sbom, depsObject);
|
|
245
|
+
this.#ensurePeerAndOptionalDeps(sbom);
|
|
186
246
|
sbom.filterIgnoredDeps(this.#manifest.ignored);
|
|
187
247
|
return sbom.getAsJsonString(opts);
|
|
188
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
|
+
}
|
|
189
271
|
/**
|
|
190
272
|
* Recursively builds the Sbom from the JSON that npm listing returns
|
|
191
273
|
* @param {Sbom} sbom - The SBOM object to add dependencies to
|
|
@@ -193,7 +275,10 @@ export default class Base_javascript {
|
|
|
193
275
|
* @protected
|
|
194
276
|
*/
|
|
195
277
|
_addDependenciesToSbom(sbom, depTree) {
|
|
196
|
-
const dependencies =
|
|
278
|
+
const dependencies = {
|
|
279
|
+
...depTree["dependencies"],
|
|
280
|
+
...depTree["optionalDependencies"],
|
|
281
|
+
};
|
|
197
282
|
Object.entries(dependencies)
|
|
198
283
|
.forEach(entry => {
|
|
199
284
|
const [name, artifact] = entry;
|
|
@@ -229,7 +314,7 @@ export default class Base_javascript {
|
|
|
229
314
|
* @private
|
|
230
315
|
*/
|
|
231
316
|
#getDirectDependencySbom(opts = {}) {
|
|
232
|
-
const depTree = this._buildDependencyTree(false);
|
|
317
|
+
const depTree = this._buildDependencyTree(false, opts);
|
|
233
318
|
let mainComponent = toPurl(purlType, this.#manifest.name, this.#manifest.version);
|
|
234
319
|
const license = this.readLicenseFromManifest(this.#manifest.manifestPath);
|
|
235
320
|
let sbom = new Sbom();
|
|
@@ -243,6 +328,7 @@ export default class Base_javascript {
|
|
|
243
328
|
const rootPurl = toPurlFromString(sbom.getRoot().purl);
|
|
244
329
|
sbom.addDependency(rootPurl, rootDeps.get(key));
|
|
245
330
|
}
|
|
331
|
+
this.#ensurePeerAndOptionalDeps(sbom);
|
|
246
332
|
sbom.filterIgnoredDeps(this.#manifest.ignored);
|
|
247
333
|
return sbom.getAsJsonString(opts);
|
|
248
334
|
}
|
|
@@ -253,10 +339,14 @@ export default class Base_javascript {
|
|
|
253
339
|
* @protected
|
|
254
340
|
*/
|
|
255
341
|
_getRootDependencies(depTree) {
|
|
256
|
-
|
|
342
|
+
const allDeps = {
|
|
343
|
+
...depTree.dependencies,
|
|
344
|
+
...depTree.optionalDependencies,
|
|
345
|
+
};
|
|
346
|
+
if (Object.keys(allDeps).length === 0) {
|
|
257
347
|
return new Map();
|
|
258
348
|
}
|
|
259
|
-
return new Map(Object.entries(
|
|
349
|
+
return new Map(Object.entries(allDeps).map(([key, value]) => [key, toPurl(purlType, key, value.version)]));
|
|
260
350
|
}
|
|
261
351
|
/**
|
|
262
352
|
* Executes the list command to get dependencies
|
|
@@ -267,7 +357,7 @@ export default class Base_javascript {
|
|
|
267
357
|
*/
|
|
268
358
|
#executeListCmd(includeTransitive, manifestDir) {
|
|
269
359
|
const listArgs = this._listCmdArgs(includeTransitive, manifestDir);
|
|
270
|
-
return this.#invokeCommand(listArgs);
|
|
360
|
+
return this.#invokeCommand(listArgs, { cwd: manifestDir });
|
|
271
361
|
}
|
|
272
362
|
/**
|
|
273
363
|
* Gets the version of the package manager
|
|
@@ -280,19 +370,17 @@ export default class Base_javascript {
|
|
|
280
370
|
/**
|
|
281
371
|
* Creates or updates the lock file for the package manager
|
|
282
372
|
* @param {string} manifestDir - Directory containing the manifest file
|
|
283
|
-
* @
|
|
373
|
+
* @protected
|
|
284
374
|
*/
|
|
285
|
-
|
|
375
|
+
_createLockFile(manifestDir) {
|
|
286
376
|
const originalDir = process.cwd();
|
|
287
377
|
const isWindows = os.platform() === 'win32';
|
|
288
378
|
if (isWindows) {
|
|
289
|
-
// On Windows, --prefix flag doesn't work as expected
|
|
290
|
-
// Instead of installing from the prefix folder, it installs from current working directory
|
|
291
379
|
process.chdir(manifestDir);
|
|
292
380
|
}
|
|
293
381
|
try {
|
|
294
382
|
const args = this._updateLockFileCmdArgs(manifestDir);
|
|
295
|
-
this.#invokeCommand(args);
|
|
383
|
+
this.#invokeCommand(args, { cwd: manifestDir });
|
|
296
384
|
}
|
|
297
385
|
finally {
|
|
298
386
|
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';
|