@trustify-da/trustify-da-javascript-client 0.3.0-ea.a109536 → 0.3.0-ea.a754fa8

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 (92) hide show
  1. package/README.md +367 -13
  2. package/dist/package.json +39 -23
  3. package/dist/src/analysis.d.ts +28 -11
  4. package/dist/src/analysis.js +99 -79
  5. package/dist/src/batch_opts.d.ts +24 -0
  6. package/dist/src/batch_opts.js +35 -0
  7. package/dist/src/cli.js +346 -9
  8. package/dist/src/cyclone_dx_sbom.d.ts +17 -2
  9. package/dist/src/cyclone_dx_sbom.js +56 -8
  10. package/dist/src/index.d.ts +145 -7
  11. package/dist/src/index.js +358 -6
  12. package/dist/src/license/index.d.ts +28 -0
  13. package/dist/src/license/index.js +103 -0
  14. package/dist/src/license/license_utils.d.ts +40 -0
  15. package/dist/src/license/license_utils.js +137 -0
  16. package/dist/src/license/licenses_api.d.ts +34 -0
  17. package/dist/src/license/licenses_api.js +98 -0
  18. package/dist/src/license/project_license.d.ts +20 -0
  19. package/dist/src/license/project_license.js +62 -0
  20. package/dist/src/oci_image/images.d.ts +1 -1
  21. package/dist/src/oci_image/images.js +15 -1
  22. package/dist/src/oci_image/utils.d.ts +5 -5
  23. package/dist/src/oci_image/utils.js +11 -2
  24. package/dist/src/provider.d.ts +18 -5
  25. package/dist/src/provider.js +33 -5
  26. package/dist/src/providers/base_java.d.ts +14 -12
  27. package/dist/src/providers/base_java.js +18 -44
  28. package/dist/src/providers/base_javascript.d.ts +45 -12
  29. package/dist/src/providers/base_javascript.js +138 -24
  30. package/dist/src/providers/base_pyproject.d.ts +158 -0
  31. package/dist/src/providers/base_pyproject.js +322 -0
  32. package/dist/src/providers/containerfile_parser.d.ts +5 -0
  33. package/dist/src/providers/containerfile_parser.js +20 -0
  34. package/dist/src/providers/golang_gomodules.d.ts +30 -13
  35. package/dist/src/providers/golang_gomodules.js +218 -122
  36. package/dist/src/providers/gomod_parser.d.ts +4 -0
  37. package/dist/src/providers/gomod_parser.js +16 -0
  38. package/dist/src/providers/java_gradle.d.ts +25 -0
  39. package/dist/src/providers/java_gradle.js +128 -4
  40. package/dist/src/providers/java_gradle_groovy.d.ts +1 -1
  41. package/dist/src/providers/java_gradle_kotlin.d.ts +1 -1
  42. package/dist/src/providers/java_maven.d.ts +18 -3
  43. package/dist/src/providers/java_maven.js +197 -5
  44. package/dist/src/providers/javascript_bun.d.ts +10 -0
  45. package/dist/src/providers/javascript_bun.js +100 -0
  46. package/dist/src/providers/javascript_npm.d.ts +6 -0
  47. package/dist/src/providers/javascript_npm.js +21 -0
  48. package/dist/src/providers/javascript_pnpm.d.ts +1 -1
  49. package/dist/src/providers/javascript_pnpm.js +8 -4
  50. package/dist/src/providers/manifest.d.ts +2 -0
  51. package/dist/src/providers/manifest.js +22 -4
  52. package/dist/src/providers/marker_evaluator.d.ts +14 -0
  53. package/dist/src/providers/marker_evaluator.js +191 -0
  54. package/dist/src/providers/oci_dockerfile.d.ts +51 -0
  55. package/dist/src/providers/oci_dockerfile.js +177 -0
  56. package/dist/src/providers/processors/yarn_berry_processor.d.ts +2 -2
  57. package/dist/src/providers/processors/yarn_berry_processor.js +88 -5
  58. package/dist/src/providers/processors/yarn_classic_processor.d.ts +2 -2
  59. package/dist/src/providers/python_controller.d.ts +10 -3
  60. package/dist/src/providers/python_controller.js +122 -63
  61. package/dist/src/providers/python_pip.d.ts +16 -4
  62. package/dist/src/providers/python_pip.js +51 -58
  63. package/dist/src/providers/python_pip_pyproject.d.ts +61 -0
  64. package/dist/src/providers/python_pip_pyproject.js +146 -0
  65. package/dist/src/providers/python_poetry.d.ts +98 -0
  66. package/dist/src/providers/python_poetry.js +286 -0
  67. package/dist/src/providers/python_uv.d.ts +46 -0
  68. package/dist/src/providers/python_uv.js +269 -0
  69. package/dist/src/providers/requirements_parser.d.ts +6 -0
  70. package/dist/src/providers/requirements_parser.js +24 -0
  71. package/dist/src/providers/rust_cargo.d.ts +56 -0
  72. package/dist/src/providers/rust_cargo.js +700 -0
  73. package/dist/src/providers/tree-sitter-containerfile.wasm +0 -0
  74. package/dist/src/providers/tree-sitter-gomod.wasm +0 -0
  75. package/dist/src/providers/tree-sitter-requirements.wasm +0 -0
  76. package/dist/src/remediate.d.ts +21 -0
  77. package/dist/src/remediate.js +149 -0
  78. package/dist/src/remediation.d.ts +57 -0
  79. package/dist/src/remediation.js +436 -0
  80. package/dist/src/remediation_report.d.ts +40 -0
  81. package/dist/src/remediation_report.js +159 -0
  82. package/dist/src/sbom.d.ts +17 -2
  83. package/dist/src/sbom.js +16 -4
  84. package/dist/src/tools.d.ts +44 -0
  85. package/dist/src/tools.js +113 -0
  86. package/dist/src/updaters/maven_updater.d.ts +26 -0
  87. package/dist/src/updaters/maven_updater.js +322 -0
  88. package/dist/src/updaters/toml_updater.d.ts +33 -0
  89. package/dist/src/updaters/toml_updater.js +244 -0
  90. package/dist/src/workspace.d.ts +70 -0
  91. package/dist/src/workspace.js +256 -0
  92. package/package.json +40 -24
@@ -3,12 +3,18 @@ import golangGomodulesProvider from './providers/golang_gomodules.js';
3
3
  import Java_gradle_groovy from "./providers/java_gradle_groovy.js";
4
4
  import Java_gradle_kotlin from "./providers/java_gradle_kotlin.js";
5
5
  import Java_maven from "./providers/java_maven.js";
6
+ import Javascript_bun from './providers/javascript_bun.js';
6
7
  import Javascript_npm from './providers/javascript_npm.js';
7
8
  import Javascript_pnpm from './providers/javascript_pnpm.js';
8
9
  import Javascript_yarn from './providers/javascript_yarn.js';
10
+ import dockerfileProvider from './providers/oci_dockerfile.js';
9
11
  import pythonPipProvider from './providers/python_pip.js';
12
+ import Python_pip_pyproject from './providers/python_pip_pyproject.js';
13
+ import Python_poetry from './providers/python_poetry.js';
14
+ import Python_uv from './providers/python_uv.js';
15
+ import rustCargoProvider from './providers/rust_cargo.js';
10
16
  /** @typedef {{ecosystem: string, contentType: string, content: string}} Provided */
11
- /** @typedef {{isSupported: function(string): boolean, validateLockFile: function(string): void, provideComponent: function(string, {}): Provided, provideStack: function(string, {}): Provided}} Provider */
17
+ /** @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, Object=): string | null, packageManagerName: function(): string}} Provider */
12
18
  /**
13
19
  * MUST include all providers here.
14
20
  * @type {[Provider]}
@@ -17,12 +23,33 @@ export const availableProviders = [
17
23
  new Java_maven(),
18
24
  new Java_gradle_groovy(),
19
25
  new Java_gradle_kotlin(),
20
- new Javascript_npm(),
26
+ new Javascript_bun(),
21
27
  new Javascript_pnpm(),
22
28
  new Javascript_yarn(),
29
+ new Javascript_npm(),
23
30
  golangGomodulesProvider,
24
- pythonPipProvider
31
+ pythonPipProvider,
32
+ new Python_poetry(),
33
+ new Python_uv(),
34
+ new Python_pip_pyproject(),
35
+ rustCargoProvider,
36
+ dockerfileProvider
25
37
  ];
38
+ /**
39
+ * Match a provider by manifest type only (no lock file check). Used for license reading.
40
+ * @param {string} manifestPath - path or name of the manifest
41
+ * @param {[Provider]} providers - list of providers to iterate over
42
+ * @returns {Provider}
43
+ * @throws {Error} when the manifest is not supported and no provider was matched
44
+ */
45
+ export function matchForLicense(manifestPath, providers) {
46
+ const base = path.parse(manifestPath).base;
47
+ const provider = providers.find(prov => prov.isSupported(base));
48
+ if (!provider) {
49
+ throw new Error(`${base} is not supported`);
50
+ }
51
+ return provider;
52
+ }
26
53
  /**
27
54
  * Match a provider from a list or providers based on file type.
28
55
  * Each provider MUST export 'isSupported' taking a file name-type and returning true if supported.
@@ -30,16 +57,17 @@ export const availableProviders = [
30
57
  * Each provider MUST export 'provideStack' taking manifest path returning a {@link Provided}.
31
58
  * @param {string} manifest - the name-type or path of the manifest
32
59
  * @param {[Provider]} providers - list of providers to iterate over
60
+ * @param {{TRUSTIFY_DA_WORKSPACE_DIR?: string}} [opts={}] - optional; TRUSTIFY_DA_WORKSPACE_DIR overrides lock file location for workspaces
33
61
  * @returns {Provider}
34
62
  * @throws {Error} when the manifest is not supported and no provider was matched
35
63
  */
36
- export function match(manifest, providers) {
64
+ export function match(manifest, providers, opts = {}) {
37
65
  const manifestPath = path.parse(manifest);
38
66
  const supported = providers.filter(prov => prov.isSupported(manifestPath.base));
39
67
  if (supported.length === 0) {
40
68
  throw new Error(`${manifestPath.base} is not supported`);
41
69
  }
42
- const provider = supported.find(prov => prov.validateLockFile(manifestPath.dir));
70
+ const provider = supported.find(prov => prov.validateLockFile(manifestPath.dir, opts));
43
71
  if (!provider) {
44
72
  throw new Error(`${manifestPath.base} requires a lock file. Use your preferred package manager to generate the lock file.`);
45
73
  }
@@ -1,4 +1,4 @@
1
- export type ecosystem_maven = import("../provider").Provider;
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 = import("../provider").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, getGitRootDir, getWrapperPreference, invokeCommand } from "../tools.js";
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.#getDepth(target);
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.#getDepth(lines[index - 1]), lines.slice(index), sbom);
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.#getDepth(target);
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
- * @private
74
+ * @protected
69
75
  */
70
- #getDepth(line) {
71
- if (line === undefined) {
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.traverseForWrapper(manifestPath);
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,5 +1,6 @@
1
- /** @typedef {import('../provider.js').Provider} Provider */
2
- /** @typedef {import('../provider.js').Provided} Provided */
1
+ export type purlType = any;
2
+ /** @typedef {import('../provider').Provider} */
3
+ /** @typedef {import('../provider').Provided} Provided */
3
4
  /**
4
5
  * The ecosystem identifier for JavaScript/npm packages
5
6
  * @type {string}
@@ -18,7 +19,7 @@ export default class Base_javascript {
18
19
  * @param {Object} opts - Configuration options for the provider
19
20
  * @protected
20
21
  */
21
- protected _setUp(manifestPath: string, opts: any): void;
22
+ protected _setUp(manifestPath: string, opts: Object): void;
22
23
  /**
23
24
  * Gets the current manifest object
24
25
  * @returns {Manifest} The manifest object
@@ -46,6 +47,11 @@ export default class Base_javascript {
46
47
  */
47
48
  protected _cmdName(): string;
48
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
+ /**
49
55
  * Returns the command arguments for listing dependencies
50
56
  * @returns {Array<string>} The command arguments
51
57
  * @abstract
@@ -66,46 +72,68 @@ export default class Base_javascript {
66
72
  */
67
73
  isSupported(manifestName: string): boolean;
68
74
  /**
69
- * Checks if a required lock file exists in the same path as the manifest
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
+ /**
70
90
  * @param {string} manifestDir - The base directory where the manifest is located
91
+ * @param {Object} [opts={}] - optional; may contain TRUSTIFY_DA_WORKSPACE_DIR
71
92
  * @returns {boolean} True if the lock file exists
72
93
  */
73
- validateLockFile(manifestDir: string): boolean;
94
+ validateLockFile(manifestDir: string, opts?: Object): boolean;
74
95
  /**
75
96
  * Provides content and content type for stack analysis
76
97
  * @param {string} manifestPath - The manifest path or name
77
98
  * @param {Object} [opts={}] - Optional configuration options
78
99
  * @returns {Provided} The provided data for stack analysis
79
100
  */
80
- provideStack(manifestPath: string, opts?: any): Provided;
101
+ provideStack(manifestPath: string, opts?: Object): Provided;
81
102
  /**
82
103
  * Provides content and content type for component analysis
83
104
  * @param {string} manifestPath - Path to package.json for component report
84
105
  * @param {Object} [opts={}] - Optional configuration options
85
106
  * @returns {Provided} The provided data for component analysis
86
107
  */
87
- provideComponent(manifestPath: string, opts?: any): Provided;
108
+ provideComponent(manifestPath: string, opts?: Object): Provided;
109
+ /**
110
+ * Read license from manifest (package.json). Reused by npm, pnpm, yarn.
111
+ * @param {string} manifestPath - path to package.json
112
+ * @returns {string|null}
113
+ */
114
+ readLicenseFromManifest(manifestPath: string): string | null;
88
115
  /**
89
116
  * Builds the dependency tree for the project
90
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
91
119
  * @returns {Object} The dependency tree
92
120
  * @protected
93
121
  */
94
- protected _buildDependencyTree(includeTransitive: boolean): any;
122
+ protected _buildDependencyTree(includeTransitive: boolean, opts?: Object): Object;
95
123
  /**
96
124
  * Recursively builds the Sbom from the JSON that npm listing returns
97
125
  * @param {Sbom} sbom - The SBOM object to add dependencies to
98
126
  * @param {Object} depTree - The current dependency tree
99
127
  * @protected
100
128
  */
101
- protected _addDependenciesToSbom(sbom: Sbom, depTree: any): void;
129
+ protected _addDependenciesToSbom(sbom: Sbom, depTree: Object): void;
102
130
  /**
103
131
  * Extracts root dependencies from the dependency tree
104
132
  * @param {Object} depTree - The dependency tree object
105
133
  * @returns {Map<string, PackageURL>} Map of dependency names to their PackageURL objects
106
134
  * @protected
107
135
  */
108
- protected _getRootDependencies(depTree: any): Map<string, PackageURL>;
136
+ protected _getRootDependencies(depTree: Object): Map<string, PackageURL>;
109
137
  /**
110
138
  * Gets the version of the package manager
111
139
  * @returns {string} The version string of the package manager
@@ -113,6 +141,12 @@ export default class Base_javascript {
113
141
  */
114
142
  protected _version(): string;
115
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
+ /**
116
150
  * Parses the dependency tree output
117
151
  * @param {string} output - The output to parse
118
152
  * @returns {string} The parsed output
@@ -121,7 +155,6 @@ export default class Base_javascript {
121
155
  protected _parseDepTreeOutput(output: string): string;
122
156
  #private;
123
157
  }
124
- export type Provider = import("../provider.js").Provider;
125
- export type Provided = import("../provider.js").Provided;
158
+ export type Provided = any;
126
159
  import Manifest from './manifest.js';
127
160
  import Sbom from '../sbom.js';
@@ -1,11 +1,12 @@
1
1
  import fs from 'node:fs';
2
2
  import os from "node:os";
3
3
  import path from 'node:path';
4
+ import { getLicense } from '../license/license_utils.js';
4
5
  import Sbom from '../sbom.js';
5
- import { getCustom, getCustomPath, invokeCommand, toPurl, toPurlFromString } from "../tools.js";
6
+ import { getCustom, getCustomPath, invokeCommand, toPurl, toPurlFromString } from '../tools.js';
6
7
  import Manifest from './manifest.js';
7
- /** @typedef {import('../provider.js').Provider} Provider */
8
- /** @typedef {import('../provider.js').Provided} Provided */
8
+ /** @typedef {import('../provider').Provider} */
9
+ /** @typedef {import('../provider').Provided} Provided */
9
10
  /**
10
11
  * The ecosystem identifier for JavaScript/npm packages
11
12
  * @type {string}
@@ -70,6 +71,13 @@ export default class Base_javascript {
70
71
  throw new TypeError("_cmdName must be implemented");
71
72
  }
72
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
+ /**
73
81
  * Returns the command arguments for listing dependencies
74
82
  * @returns {Array<string>} The command arguments
75
83
  * @abstract
@@ -96,13 +104,63 @@ export default class Base_javascript {
96
104
  return 'package.json' === manifestName;
97
105
  }
98
106
  /**
99
- * Checks if a required lock file exists in the same path as the manifest
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
+ /**
100
158
  * @param {string} manifestDir - The base directory where the manifest is located
159
+ * @param {Object} [opts={}] - optional; may contain TRUSTIFY_DA_WORKSPACE_DIR
101
160
  * @returns {boolean} True if the lock file exists
102
161
  */
103
- validateLockFile(manifestDir) {
104
- const lock = path.join(manifestDir, this._lockFileName());
105
- return fs.existsSync(lock);
162
+ validateLockFile(manifestDir, opts = {}) {
163
+ return this._findLockFileDir(manifestDir, opts) !== null;
106
164
  }
107
165
  /**
108
166
  * Provides content and content type for stack analysis
@@ -132,17 +190,42 @@ export default class Base_javascript {
132
190
  contentType: 'application/vnd.cyclonedx+json'
133
191
  };
134
192
  }
193
+ /**
194
+ * Read license from manifest (package.json). Reused by npm, pnpm, yarn.
195
+ * @param {string} manifestPath - path to package.json
196
+ * @returns {string|null}
197
+ */
198
+ readLicenseFromManifest(manifestPath) {
199
+ let manifestLicense;
200
+ try {
201
+ const content = JSON.parse(fs.readFileSync(manifestPath, 'utf-8'));
202
+ if (typeof content.license === 'string') {
203
+ manifestLicense = content.license.trim() || null;
204
+ }
205
+ else if (Array.isArray(content.licenses) && content.licenses.length > 0) {
206
+ const first = content.licenses[0];
207
+ const name = first.type || first.name;
208
+ manifestLicense = (typeof name === 'string' ? name.trim() : null);
209
+ }
210
+ }
211
+ catch {
212
+ manifestLicense = null;
213
+ }
214
+ return getLicense(manifestLicense, manifestPath);
215
+ }
135
216
  /**
136
217
  * Builds the dependency tree for the project
137
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
138
220
  * @returns {Object} The dependency tree
139
221
  * @protected
140
222
  */
141
- _buildDependencyTree(includeTransitive) {
223
+ _buildDependencyTree(includeTransitive, opts = {}) {
142
224
  this._version();
143
- let manifestDir = path.dirname(this.#manifest.manifestPath);
144
- this.#createLockFile(manifestDir);
145
- let output = this.#executeListCmd(includeTransitive, manifestDir);
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);
146
229
  output = this._parseDepTreeOutput(output);
147
230
  return JSON.parse(output);
148
231
  }
@@ -153,14 +236,38 @@ export default class Base_javascript {
153
236
  * @private
154
237
  */
155
238
  #getSBOM(opts = {}) {
156
- const depsObject = this._buildDependencyTree(true);
239
+ const depsObject = this._buildDependencyTree(true, opts);
157
240
  let mainComponent = toPurl(purlType, this.#manifest.name, this.#manifest.version);
241
+ const license = this.readLicenseFromManifest(this.#manifest.manifestPath);
158
242
  let sbom = new Sbom();
159
- sbom.addRoot(mainComponent);
243
+ sbom.addRoot(mainComponent, license);
160
244
  this._addDependenciesToSbom(sbom, depsObject);
245
+ this.#ensurePeerAndOptionalDeps(sbom);
161
246
  sbom.filterIgnoredDeps(this.#manifest.ignored);
162
247
  return sbom.getAsJsonString(opts);
163
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
+ }
164
271
  /**
165
272
  * Recursively builds the Sbom from the JSON that npm listing returns
166
273
  * @param {Sbom} sbom - The SBOM object to add dependencies to
@@ -168,7 +275,10 @@ export default class Base_javascript {
168
275
  * @protected
169
276
  */
170
277
  _addDependenciesToSbom(sbom, depTree) {
171
- const dependencies = depTree["dependencies"] || {};
278
+ const dependencies = {
279
+ ...depTree["dependencies"],
280
+ ...depTree["optionalDependencies"],
281
+ };
172
282
  Object.entries(dependencies)
173
283
  .forEach(entry => {
174
284
  const [name, artifact] = entry;
@@ -204,10 +314,11 @@ export default class Base_javascript {
204
314
  * @private
205
315
  */
206
316
  #getDirectDependencySbom(opts = {}) {
207
- const depTree = this._buildDependencyTree(false);
317
+ const depTree = this._buildDependencyTree(false, opts);
208
318
  let mainComponent = toPurl(purlType, this.#manifest.name, this.#manifest.version);
319
+ const license = this.readLicenseFromManifest(this.#manifest.manifestPath);
209
320
  let sbom = new Sbom();
210
- sbom.addRoot(mainComponent);
321
+ sbom.addRoot(mainComponent, license);
211
322
  const rootDeps = this._getRootDependencies(depTree);
212
323
  const sortedDepsKeys = Array
213
324
  .from(rootDeps.keys())
@@ -217,6 +328,7 @@ export default class Base_javascript {
217
328
  const rootPurl = toPurlFromString(sbom.getRoot().purl);
218
329
  sbom.addDependency(rootPurl, rootDeps.get(key));
219
330
  }
331
+ this.#ensurePeerAndOptionalDeps(sbom);
220
332
  sbom.filterIgnoredDeps(this.#manifest.ignored);
221
333
  return sbom.getAsJsonString(opts);
222
334
  }
@@ -227,10 +339,14 @@ export default class Base_javascript {
227
339
  * @protected
228
340
  */
229
341
  _getRootDependencies(depTree) {
230
- if (!depTree.dependencies) {
342
+ const allDeps = {
343
+ ...depTree.dependencies,
344
+ ...depTree.optionalDependencies,
345
+ };
346
+ if (Object.keys(allDeps).length === 0) {
231
347
  return new Map();
232
348
  }
233
- 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)]));
234
350
  }
235
351
  /**
236
352
  * Executes the list command to get dependencies
@@ -241,7 +357,7 @@ export default class Base_javascript {
241
357
  */
242
358
  #executeListCmd(includeTransitive, manifestDir) {
243
359
  const listArgs = this._listCmdArgs(includeTransitive, manifestDir);
244
- return this.#invokeCommand(listArgs);
360
+ return this.#invokeCommand(listArgs, { cwd: manifestDir });
245
361
  }
246
362
  /**
247
363
  * Gets the version of the package manager
@@ -254,19 +370,17 @@ export default class Base_javascript {
254
370
  /**
255
371
  * Creates or updates the lock file for the package manager
256
372
  * @param {string} manifestDir - Directory containing the manifest file
257
- * @private
373
+ * @protected
258
374
  */
259
- #createLockFile(manifestDir) {
375
+ _createLockFile(manifestDir) {
260
376
  const originalDir = process.cwd();
261
377
  const isWindows = os.platform() === 'win32';
262
378
  if (isWindows) {
263
- // On Windows, --prefix flag doesn't work as expected
264
- // Instead of installing from the prefix folder, it installs from current working directory
265
379
  process.chdir(manifestDir);
266
380
  }
267
381
  try {
268
382
  const args = this._updateLockFileCmdArgs(manifestDir);
269
- this.#invokeCommand(args);
383
+ this.#invokeCommand(args, { cwd: manifestDir });
270
384
  }
271
385
  finally {
272
386
  if (isWindows) {