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

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 (88) hide show
  1. package/README.md +250 -11
  2. package/dist/package.json +33 -25
  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 +27 -1
  7. package/dist/src/cyclone_dx_sbom.js +82 -9
  8. package/dist/src/index.d.ts +86 -11
  9. package/dist/src/index.js +102 -30
  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/package_version.d.ts +8 -0
  19. package/dist/src/package_version.js +31 -0
  20. package/dist/src/provider.d.ts +4 -3
  21. package/dist/src/provider.js +12 -2
  22. package/dist/src/providers/base_java.d.ts +67 -12
  23. package/dist/src/providers/base_java.js +82 -61
  24. package/dist/src/providers/base_javascript.d.ts +74 -9
  25. package/dist/src/providers/base_javascript.js +149 -9
  26. package/dist/src/providers/base_pyproject.d.ts +158 -0
  27. package/dist/src/providers/base_pyproject.js +322 -0
  28. package/dist/src/providers/containerfile_parser.d.ts +5 -0
  29. package/dist/src/providers/containerfile_parser.js +20 -0
  30. package/dist/src/providers/golang_gomodules.d.ts +23 -13
  31. package/dist/src/providers/golang_gomodules.js +207 -120
  32. package/dist/src/providers/gomod_parser.d.ts +4 -0
  33. package/dist/src/providers/gomod_parser.js +16 -0
  34. package/dist/src/providers/java_gradle.d.ts +67 -0
  35. package/dist/src/providers/java_gradle.js +310 -17
  36. package/dist/src/providers/java_gradle_groovy.d.ts +1 -1
  37. package/dist/src/providers/java_gradle_kotlin.d.ts +1 -1
  38. package/dist/src/providers/java_maven.d.ts +38 -5
  39. package/dist/src/providers/java_maven.js +261 -8
  40. package/dist/src/providers/javascript_bun.d.ts +22 -0
  41. package/dist/src/providers/javascript_bun.js +141 -0
  42. package/dist/src/providers/javascript_npm.d.ts +19 -0
  43. package/dist/src/providers/javascript_npm.js +61 -1
  44. package/dist/src/providers/javascript_pnpm.d.ts +13 -0
  45. package/dist/src/providers/javascript_pnpm.js +53 -3
  46. package/dist/src/providers/javascript_yarn.d.ts +12 -0
  47. package/dist/src/providers/javascript_yarn.js +75 -2
  48. package/dist/src/providers/manifest.d.ts +2 -0
  49. package/dist/src/providers/manifest.js +22 -4
  50. package/dist/src/providers/marker_evaluator.d.ts +14 -0
  51. package/dist/src/providers/marker_evaluator.js +191 -0
  52. package/dist/src/providers/oci_dockerfile.d.ts +51 -0
  53. package/dist/src/providers/oci_dockerfile.js +177 -0
  54. package/dist/src/providers/processors/yarn_berry_processor.d.ts +6 -2
  55. package/dist/src/providers/processors/yarn_berry_processor.js +91 -7
  56. package/dist/src/providers/processors/yarn_classic_processor.d.ts +6 -2
  57. package/dist/src/providers/processors/yarn_classic_processor.js +8 -6
  58. package/dist/src/providers/python_controller.d.ts +5 -1
  59. package/dist/src/providers/python_controller.js +69 -8
  60. package/dist/src/providers/python_pip.d.ts +5 -0
  61. package/dist/src/providers/python_pip.js +6 -6
  62. package/dist/src/providers/python_pip_pyproject.d.ts +61 -0
  63. package/dist/src/providers/python_pip_pyproject.js +146 -0
  64. package/dist/src/providers/python_poetry.d.ts +98 -0
  65. package/dist/src/providers/python_poetry.js +286 -0
  66. package/dist/src/providers/python_uv.d.ts +46 -0
  67. package/dist/src/providers/python_uv.js +269 -0
  68. package/dist/src/providers/rust_cargo.d.ts +6 -2
  69. package/dist/src/providers/rust_cargo.js +101 -33
  70. package/dist/src/providers/tree-sitter-containerfile.wasm +0 -0
  71. package/dist/src/providers/tree-sitter-gomod.wasm +0 -0
  72. package/dist/src/remediate.d.ts +21 -0
  73. package/dist/src/remediate.js +149 -0
  74. package/dist/src/remediation.d.ts +57 -0
  75. package/dist/src/remediation.js +436 -0
  76. package/dist/src/remediation_report.d.ts +40 -0
  77. package/dist/src/remediation_report.js +159 -0
  78. package/dist/src/sbom.d.ts +25 -1
  79. package/dist/src/sbom.js +23 -2
  80. package/dist/src/tools.d.ts +28 -2
  81. package/dist/src/tools.js +82 -1
  82. package/dist/src/updaters/maven_updater.d.ts +26 -0
  83. package/dist/src/updaters/maven_updater.js +322 -0
  84. package/dist/src/updaters/toml_updater.d.ts +33 -0
  85. package/dist/src/updaters/toml_updater.js +244 -0
  86. package/dist/src/workspace.d.ts +9 -0
  87. package/dist/src/workspace.js +1 -1
  88. package/package.json +34 -26
@@ -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 */
@@ -15,6 +14,13 @@ export const ecosystem_gradle = 'gradle';
15
14
  export default class Base_Java {
16
15
  DEP_REGEX = /(([-a-zA-Z0-9._]{2,})|[0-9])/g;
17
16
  CONFLICT_REGEX = /.*omitted for conflict with (\S+)\)/;
17
+ /**
18
+ * Maven dependency scopes. Used to detect whether the trailing column of a
19
+ * dependency-tree line is a scope keyword — which in turn signals that an
20
+ * optional classifier column is present between the packaging and version.
21
+ * @type {string[]}
22
+ */
23
+ static MAVEN_SCOPES = ['compile', 'provided', 'runtime', 'test', 'system', 'import'];
18
24
  globalBinary;
19
25
  localWrapper;
20
26
  /**
@@ -26,6 +32,13 @@ export default class Base_Java {
26
32
  this.globalBinary = globalBinary;
27
33
  this.localWrapper = localWrapper;
28
34
  }
35
+ /**
36
+ * Returns the package manager name (e.g. mvn, gradle)
37
+ * @returns {string}
38
+ */
39
+ packageManagerName() {
40
+ return this.globalBinary;
41
+ }
29
42
  /**
30
43
  * Recursively populates the SBOM instance with the parsed graph
31
44
  * @param {string} src - Source dependency to start the calculations from
@@ -42,7 +55,7 @@ export default class Base_Java {
42
55
  }
43
56
  let index = 0;
44
57
  let target = lines[index];
45
- let targetDepth = this.#getDepth(target);
58
+ let targetDepth = this._getDepth(target);
46
59
  while (targetDepth > srcDepth && index < lines.length) {
47
60
  if (targetDepth === srcDepth + 1) {
48
61
  let from = this.parseDep(src);
@@ -55,49 +68,92 @@ export default class Base_Java {
55
68
  }
56
69
  }
57
70
  else {
58
- this.parseDependencyTree(lines[index - 1], this.#getDepth(lines[index - 1]), lines.slice(index), sbom);
71
+ this.parseDependencyTree(lines[index - 1], this._getDepth(lines[index - 1]), lines.slice(index), sbom);
59
72
  }
60
73
  target = lines[++index];
61
- targetDepth = this.#getDepth(target);
74
+ targetDepth = this._getDepth(target);
62
75
  }
63
76
  }
64
77
  /**
65
78
  * Calculates how deep in the graph is the given line
66
79
  * @param {string} line - line to calculate the depth from
67
80
  * @returns {number} The calculated depth
68
- * @private
81
+ * @protected
69
82
  */
70
- #getDepth(line) {
71
- if (line === undefined) {
83
+ _getDepth(line) {
84
+ if (!line || line.trim() === '') {
72
85
  return -1;
73
86
  }
87
+ if (line.match(/^\w/)) {
88
+ return 0;
89
+ }
74
90
  return ((line.indexOf('-') - 1) / 3) + 1;
75
91
  }
92
+ /**
93
+ * Parse a single dependency-tree line into its Maven coordinate parts.
94
+ *
95
+ * This is the single source of truth for interpreting a dependency-tree
96
+ * line. Both {@link parseDep} (used to build SBOM component PURLs) and the
97
+ * Maven hash-map builder rely on it, so the PURL key and the artifact file
98
+ * path can never drift from one another.
99
+ *
100
+ * A line has the shape `groupId:artifactId:packaging[:classifier]:version[:scope]`.
101
+ * The classifier column is only present when a sixth column holds a known
102
+ * Maven scope keyword; otherwise the fourth column is the version.
103
+ *
104
+ * @param {string} line - line to parse from a dependency tree
105
+ * @returns {{groupId: string, artifactId: string, packaging: string, classifier: (string|null), version: string, scope: (string|null), overridden: boolean}}
106
+ * Parsed coordinate. `version` is the resolved concrete version — when the
107
+ * line carries a conflict override the override version replaces it and
108
+ * `overridden` is set, mirroring how Maven records the winning version.
109
+ */
110
+ parseCoordinate(line) {
111
+ const parts = line.split(':').map(part => part ? part.match(this.DEP_REGEX)?.[0] ?? '' : '');
112
+ const groupId = parts[0] ?? '';
113
+ const artifactId = parts[1] ?? '';
114
+ const packaging = parts[2] ?? '';
115
+ // A classifier column exists only when a sixth column holds a scope keyword.
116
+ const hasClassifier = parts.length >= 6 && Base_Java.MAVEN_SCOPES.includes(parts[5]);
117
+ const classifier = hasClassifier ? parts[3] : null;
118
+ let version = (hasClassifier ? parts[4] : parts[3]) ?? '';
119
+ const scope = hasClassifier ? parts[5] : (parts.length >= 5 ? parts[4] : null);
120
+ // A conflict override replaces the resolved version entirely.
121
+ const override = line.match(this.CONFLICT_REGEX);
122
+ const overridden = Boolean(override);
123
+ if (overridden) {
124
+ version = override[1];
125
+ }
126
+ return { groupId, artifactId, packaging, classifier, version, scope, overridden };
127
+ }
128
+ /**
129
+ * Build the canonical PackageURL for a parsed coordinate.
130
+ *
131
+ * The classifier is folded into the version component (e.g.
132
+ * `4.1.0-linux-x86_64`) except when the version came from a conflict
133
+ * override, in which case the override version stands alone — matching the
134
+ * historical behavior of {@link parseDep}.
135
+ *
136
+ * @param {{groupId: string, artifactId: string, classifier: (string|null), version: string, overridden: boolean}} coord
137
+ * @returns {PackageURL} The canonical packageURL for the coordinate
138
+ * @protected
139
+ */
140
+ _coordinateToPurl(coord) {
141
+ const purlVersion = (coord.classifier && !coord.overridden)
142
+ ? `${coord.version}-${coord.classifier}`
143
+ : coord.version;
144
+ return this.toPurl(coord.groupId, coord.artifactId, purlVersion);
145
+ }
76
146
  /**
77
147
  * Create a PackageURL from any line in a Text Graph dependency tree for a manifest path.
78
148
  * @param {string} line - line to parse from a dependencies.txt file
79
149
  * @returns {PackageURL} The parsed packageURL
80
150
  */
81
151
  parseDep(line) {
82
- let match = line.split(':').map(part => part ? part.match(this.DEP_REGEX)[0] : '');
83
- if (!match) {
84
- throw new Error(`Unable generate SBOM from dependency tree. Line: ${line} cannot be parsed into a PackageURL`);
85
- }
86
- let version;
87
- if (match.length >= 5 && ['compile', 'provided', 'runtime'].includes(match[5])) {
88
- version = `${match[4]}-${match[3]}`;
89
- }
90
- else {
91
- version = match[3];
92
- }
93
- let override = line.match(this.CONFLICT_REGEX);
94
- if (override) {
95
- version = override[1];
96
- }
97
- if (match[0].trim() === '') {
152
+ const coord = this.parseCoordinate(line);
153
+ if (coord.groupId.trim() === '') {
98
154
  throw new Error(`Artifact coordinates should have a non-empty group ID: ${line}`);
99
155
  }
100
- return this.toPurl(match[0], match[1], version);
156
+ return this._coordinateToPurl(coord);
101
157
  }
102
158
  /**
103
159
  * Returns a PackageUrl For Java maven dependencies
@@ -131,7 +187,7 @@ export default class Base_Java {
131
187
  const toolPath = getCustomPath(this.globalBinary, opts);
132
188
  const useWrapper = getWrapperPreference(this.globalBinary, opts);
133
189
  if (useWrapper) {
134
- const wrapper = this.traverseForWrapper(manifestPath);
190
+ const wrapper = traverseForWrapper(manifestDir, this.localWrapper);
135
191
  if (wrapper !== undefined) {
136
192
  try {
137
193
  this._invokeCommand(wrapper, ['--version'], { cwd: manifestDir });
@@ -156,39 +212,4 @@ export default class Base_Java {
156
212
  }
157
213
  return toolPath;
158
214
  }
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
215
  }
@@ -1,4 +1,17 @@
1
- export type purlType = import("../provider").Provider;
1
+ /**
2
+ * Converts a Subresource Integrity (SRI) string to a CycloneDX hash object.
3
+ * SRI is formatted as `<alg>-<base64>` (e.g. `sha512-Ab3d...`). CycloneDX
4
+ * expects an uppercased algorithm label (e.g. `SHA-512`) and a hex-encoded
5
+ * digest. When the SRI string contains multiple space-separated hashes, only
6
+ * the first is used.
7
+ * @param {string} integrity - SRI string from a lock file
8
+ * @returns {{alg: string, content: string}|null} CycloneDX hash, or null when unparseable
9
+ */
10
+ export function sriToHash(integrity: string): {
11
+ alg: string;
12
+ content: string;
13
+ } | null;
14
+ export type purlType = any;
2
15
  /** @typedef {import('../provider').Provider} */
3
16
  /** @typedef {import('../provider').Provided} Provided */
4
17
  /**
@@ -19,7 +32,7 @@ export default class Base_javascript {
19
32
  * @param {Object} opts - Configuration options for the provider
20
33
  * @protected
21
34
  */
22
- protected _setUp(manifestPath: string, opts: any): void;
35
+ protected _setUp(manifestPath: string, opts: Object): void;
23
36
  /**
24
37
  * Gets the current manifest object
25
38
  * @returns {Manifest} The manifest object
@@ -47,6 +60,11 @@ export default class Base_javascript {
47
60
  */
48
61
  protected _cmdName(): string;
49
62
  /**
63
+ * Returns the package manager name (e.g. npm, yarn, pnpm, bun)
64
+ * @returns {string} The package manager name
65
+ */
66
+ packageManagerName(): string;
67
+ /**
50
68
  * Returns the command arguments for listing dependencies
51
69
  * @returns {Array<string>} The command arguments
52
70
  * @abstract
@@ -60,6 +78,47 @@ export default class Base_javascript {
60
78
  * @protected
61
79
  */
62
80
  protected _updateLockFileCmdArgs(): Array<string>;
81
+ /**
82
+ * Parses the provider's lock file into a hash map keyed by `name@version`.
83
+ * Subclasses override this (accepting the lock directory) to support their
84
+ * lock file format. The default implementation returns an empty map so
85
+ * providers without lock parsing (or without a lock file present) gracefully
86
+ * omit hashes.
87
+ * @returns {Map<string, Array<{alg: string, content: string}>>} Hash map
88
+ * @protected
89
+ */
90
+ protected _parseLockFileHashes(): Map<string, Array<{
91
+ alg: string;
92
+ content: string;
93
+ }>>;
94
+ /**
95
+ * Loads lock-file hashes for the given directory into internal state.
96
+ * Parsing failures degrade gracefully to an empty map (no hashes emitted).
97
+ * @param {string} lockDir - Directory containing the lock file
98
+ * @protected
99
+ */
100
+ protected _loadHashes(lockDir: string): void;
101
+ /**
102
+ * Looks up CycloneDX hashes for a package by name and resolved version.
103
+ * @param {string} name - The package name (including scope, e.g. `@hapi/joi`)
104
+ * @param {string} version - The resolved package version
105
+ * @returns {Array<{alg: string, content: string}>|undefined} Hashes, or undefined
106
+ * @protected
107
+ */
108
+ protected _hashesFor(name: string, version: string): Array<{
109
+ alg: string;
110
+ content: string;
111
+ }> | undefined;
112
+ /**
113
+ * Looks up CycloneDX hashes for a package described by a PackageURL.
114
+ * @param {PackageURL} purl - The package URL
115
+ * @returns {Array<{alg: string, content: string}>|undefined} Hashes, or undefined
116
+ * @protected
117
+ */
118
+ protected _hashesForPurl(purl: PackageURL): Array<{
119
+ alg: string;
120
+ content: string;
121
+ }> | undefined;
63
122
  /**
64
123
  * Checks if the provider supports the given manifest name
65
124
  * @param {string} manifestName - The manifest name to check
@@ -86,21 +145,21 @@ export default class Base_javascript {
86
145
  * @param {Object} [opts={}] - optional; may contain TRUSTIFY_DA_WORKSPACE_DIR
87
146
  * @returns {boolean} True if the lock file exists
88
147
  */
89
- validateLockFile(manifestDir: string, opts?: any): boolean;
148
+ validateLockFile(manifestDir: string, opts?: Object): boolean;
90
149
  /**
91
150
  * Provides content and content type for stack analysis
92
151
  * @param {string} manifestPath - The manifest path or name
93
152
  * @param {Object} [opts={}] - Optional configuration options
94
153
  * @returns {Provided} The provided data for stack analysis
95
154
  */
96
- provideStack(manifestPath: string, opts?: any): Provided;
155
+ provideStack(manifestPath: string, opts?: Object): Provided;
97
156
  /**
98
157
  * Provides content and content type for component analysis
99
158
  * @param {string} manifestPath - Path to package.json for component report
100
159
  * @param {Object} [opts={}] - Optional configuration options
101
160
  * @returns {Provided} The provided data for component analysis
102
161
  */
103
- provideComponent(manifestPath: string, opts?: any): Provided;
162
+ provideComponent(manifestPath: string, opts?: Object): Provided;
104
163
  /**
105
164
  * Read license from manifest (package.json). Reused by npm, pnpm, yarn.
106
165
  * @param {string} manifestPath - path to package.json
@@ -114,21 +173,21 @@ export default class Base_javascript {
114
173
  * @returns {Object} The dependency tree
115
174
  * @protected
116
175
  */
117
- protected _buildDependencyTree(includeTransitive: boolean, opts?: any): any;
176
+ protected _buildDependencyTree(includeTransitive: boolean, opts?: Object): Object;
118
177
  /**
119
178
  * Recursively builds the Sbom from the JSON that npm listing returns
120
179
  * @param {Sbom} sbom - The SBOM object to add dependencies to
121
180
  * @param {Object} depTree - The current dependency tree
122
181
  * @protected
123
182
  */
124
- protected _addDependenciesToSbom(sbom: Sbom, depTree: any): void;
183
+ protected _addDependenciesToSbom(sbom: Sbom, depTree: Object): void;
125
184
  /**
126
185
  * Extracts root dependencies from the dependency tree
127
186
  * @param {Object} depTree - The dependency tree object
128
187
  * @returns {Map<string, PackageURL>} Map of dependency names to their PackageURL objects
129
188
  * @protected
130
189
  */
131
- protected _getRootDependencies(depTree: any): Map<string, PackageURL>;
190
+ protected _getRootDependencies(depTree: Object): Map<string, PackageURL>;
132
191
  /**
133
192
  * Gets the version of the package manager
134
193
  * @returns {string} The version string of the package manager
@@ -136,6 +195,12 @@ export default class Base_javascript {
136
195
  */
137
196
  protected _version(): string;
138
197
  /**
198
+ * Creates or updates the lock file for the package manager
199
+ * @param {string} manifestDir - Directory containing the manifest file
200
+ * @protected
201
+ */
202
+ protected _createLockFile(manifestDir: string): void;
203
+ /**
139
204
  * Parses the dependency tree output
140
205
  * @param {string} output - The output to parse
141
206
  * @returns {string} The parsed output
@@ -144,6 +209,6 @@ export default class Base_javascript {
144
209
  protected _parseDepTreeOutput(output: string): string;
145
210
  #private;
146
211
  }
147
- export type Provided = import("../provider").Provided;
212
+ export type Provided = any;
148
213
  import Manifest from './manifest.js';
149
214
  import Sbom from '../sbom.js';
@@ -12,6 +12,49 @@ import Manifest from './manifest.js';
12
12
  * @type {string}
13
13
  */
14
14
  export const purlType = 'npm';
15
+ /**
16
+ * Maps a Subresource Integrity (SRI) algorithm token to its CycloneDX label.
17
+ * @type {Object<string, string>}
18
+ */
19
+ const SRI_ALG_LABELS = {
20
+ sha1: 'SHA-1',
21
+ sha256: 'SHA-256',
22
+ sha384: 'SHA-384',
23
+ sha512: 'SHA-512',
24
+ };
25
+ /**
26
+ * Converts a Subresource Integrity (SRI) string to a CycloneDX hash object.
27
+ * SRI is formatted as `<alg>-<base64>` (e.g. `sha512-Ab3d...`). CycloneDX
28
+ * expects an uppercased algorithm label (e.g. `SHA-512`) and a hex-encoded
29
+ * digest. When the SRI string contains multiple space-separated hashes, only
30
+ * the first is used.
31
+ * @param {string} integrity - SRI string from a lock file
32
+ * @returns {{alg: string, content: string}|null} CycloneDX hash, or null when unparseable
33
+ */
34
+ export function sriToHash(integrity) {
35
+ if (typeof integrity !== 'string') {
36
+ return null;
37
+ }
38
+ const first = integrity.trim().split(/\s+/)[0];
39
+ if (!first) {
40
+ return null;
41
+ }
42
+ const dash = first.indexOf('-');
43
+ if (dash < 0) {
44
+ return null;
45
+ }
46
+ const alg = SRI_ALG_LABELS[first.slice(0, dash).toLowerCase()];
47
+ // Strip any SRI options (e.g. "?foo") that may follow the base64 payload
48
+ const base64 = first.slice(dash + 1).split('?')[0];
49
+ if (!alg || !base64) {
50
+ return null;
51
+ }
52
+ const content = Buffer.from(base64, 'base64').toString('hex');
53
+ if (!content) {
54
+ return null;
55
+ }
56
+ return { alg, content };
57
+ }
15
58
  /**
16
59
  * Base class for JavaScript package manager providers.
17
60
  * This class provides common functionality for different JavaScript package managers
@@ -25,6 +68,11 @@ export default class Base_javascript {
25
68
  #cmd;
26
69
  /** @type {string} */
27
70
  #ecosystem;
71
+ /**
72
+ * Lock-file hashes keyed by `name@version`.
73
+ * @type {Map<string, Array<{alg: string, content: string}>>}
74
+ */
75
+ #hashes = new Map();
28
76
  /**
29
77
  * Sets up the provider with the manifest path and options
30
78
  * @param {string} manifestPath - Path to the package.json manifest file
@@ -71,6 +119,13 @@ export default class Base_javascript {
71
119
  throw new TypeError("_cmdName must be implemented");
72
120
  }
73
121
  /**
122
+ * Returns the package manager name (e.g. npm, yarn, pnpm, bun)
123
+ * @returns {string} The package manager name
124
+ */
125
+ packageManagerName() {
126
+ return this._cmdName();
127
+ }
128
+ /**
74
129
  * Returns the command arguments for listing dependencies
75
130
  * @returns {Array<string>} The command arguments
76
131
  * @abstract
@@ -88,6 +143,58 @@ export default class Base_javascript {
88
143
  _updateLockFileCmdArgs() {
89
144
  throw new TypeError("_updateLockFileCmdArgs must be implemented");
90
145
  }
146
+ /**
147
+ * Parses the provider's lock file into a hash map keyed by `name@version`.
148
+ * Subclasses override this (accepting the lock directory) to support their
149
+ * lock file format. The default implementation returns an empty map so
150
+ * providers without lock parsing (or without a lock file present) gracefully
151
+ * omit hashes.
152
+ * @returns {Map<string, Array<{alg: string, content: string}>>} Hash map
153
+ * @protected
154
+ */
155
+ _parseLockFileHashes() {
156
+ return new Map();
157
+ }
158
+ /**
159
+ * Loads lock-file hashes for the given directory into internal state.
160
+ * Parsing failures degrade gracefully to an empty map (no hashes emitted).
161
+ * @param {string} lockDir - Directory containing the lock file
162
+ * @protected
163
+ */
164
+ _loadHashes(lockDir) {
165
+ try {
166
+ this.#hashes = this._parseLockFileHashes(lockDir) || new Map();
167
+ }
168
+ catch (_) {
169
+ this.#hashes = new Map();
170
+ }
171
+ }
172
+ /**
173
+ * Looks up CycloneDX hashes for a package by name and resolved version.
174
+ * @param {string} name - The package name (including scope, e.g. `@hapi/joi`)
175
+ * @param {string} version - The resolved package version
176
+ * @returns {Array<{alg: string, content: string}>|undefined} Hashes, or undefined
177
+ * @protected
178
+ */
179
+ _hashesFor(name, version) {
180
+ if (!name || !version) {
181
+ return undefined;
182
+ }
183
+ return this.#hashes.get(`${name}@${version}`);
184
+ }
185
+ /**
186
+ * Looks up CycloneDX hashes for a package described by a PackageURL.
187
+ * @param {PackageURL} purl - The package URL
188
+ * @returns {Array<{alg: string, content: string}>|undefined} Hashes, or undefined
189
+ * @protected
190
+ */
191
+ _hashesForPurl(purl) {
192
+ if (!purl) {
193
+ return undefined;
194
+ }
195
+ const name = purl.namespace ? `${purl.namespace}/${purl.name}` : purl.name;
196
+ return this._hashesFor(name, purl.version);
197
+ }
91
198
  /**
92
199
  * Checks if the provider supports the given manifest name
93
200
  * @param {string} manifestName - The manifest name to check
@@ -217,7 +324,8 @@ export default class Base_javascript {
217
324
  this._version();
218
325
  const manifestDir = path.dirname(this.#manifest.manifestPath);
219
326
  const cmdDir = this._findLockFileDir(manifestDir, opts) || manifestDir;
220
- this.#createLockFile(cmdDir);
327
+ this._createLockFile(cmdDir);
328
+ this._loadHashes(cmdDir);
221
329
  let output = this.#executeListCmd(includeTransitive, cmdDir);
222
330
  output = this._parseDepTreeOutput(output);
223
331
  return JSON.parse(output);
@@ -235,9 +343,32 @@ export default class Base_javascript {
235
343
  let sbom = new Sbom();
236
344
  sbom.addRoot(mainComponent, license);
237
345
  this._addDependenciesToSbom(sbom, depsObject);
346
+ this.#ensurePeerAndOptionalDeps(sbom);
238
347
  sbom.filterIgnoredDeps(this.#manifest.ignored);
239
348
  return sbom.getAsJsonString(opts);
240
349
  }
350
+ /**
351
+ * Ensures peer and optional dependencies declared in the manifest are
352
+ * present in the SBOM, even when the package manager does not resolve them
353
+ * (e.g. yarn does not include peer deps in its dependency listing).
354
+ * @param {Sbom} sbom - The SBOM to supplement
355
+ * @private
356
+ */
357
+ #ensurePeerAndOptionalDeps(sbom) {
358
+ const rootPurl = toPurl(purlType, this.#manifest.name, this.#manifest.version);
359
+ const depSources = [this.#manifest.peerDependencies, this.#manifest.optionalDependencies];
360
+ for (const source of depSources) {
361
+ for (const [name, version] of Object.entries(source)) {
362
+ // Build the purl prefix for exact matching (e.g. "pkg:npm/minimist@"
363
+ // or "pkg:npm/%40hapi/joi@") to avoid substring false positives
364
+ const probe = toPurl(purlType, name, version);
365
+ const purlPrefix = probe.toString().replace(/@[^@]*$/, '@');
366
+ if (!sbom.checkDependsOnByPurlPrefix(rootPurl, purlPrefix)) {
367
+ sbom.addDependency(rootPurl, probe);
368
+ }
369
+ }
370
+ }
371
+ }
241
372
  /**
242
373
  * Recursively builds the Sbom from the JSON that npm listing returns
243
374
  * @param {Sbom} sbom - The SBOM object to add dependencies to
@@ -245,13 +376,16 @@ export default class Base_javascript {
245
376
  * @protected
246
377
  */
247
378
  _addDependenciesToSbom(sbom, depTree) {
248
- const dependencies = depTree["dependencies"] || {};
379
+ const dependencies = {
380
+ ...depTree["dependencies"],
381
+ ...depTree["optionalDependencies"],
382
+ };
249
383
  Object.entries(dependencies)
250
384
  .forEach(entry => {
251
385
  const [name, artifact] = entry;
252
386
  const target = toPurl(purlType, name, artifact.version);
253
387
  const rootPurl = toPurl(purlType, this.#manifest.name, this.#manifest.version);
254
- sbom.addDependency(rootPurl, target);
388
+ sbom.addDependency(rootPurl, target, undefined, this._hashesFor(name, artifact.version));
255
389
  this.#addDependenciesOf(sbom, target, artifact);
256
390
  });
257
391
  }
@@ -269,7 +403,7 @@ export default class Base_javascript {
269
403
  const [name, depArtifact] = entry;
270
404
  if (depArtifact.version !== undefined) {
271
405
  const target = toPurl(purlType, name, depArtifact.version);
272
- sbom.addDependency(from, target);
406
+ sbom.addDependency(from, target, undefined, this._hashesFor(name, depArtifact.version));
273
407
  this.#addDependenciesOf(sbom, target, depArtifact);
274
408
  }
275
409
  });
@@ -293,8 +427,10 @@ export default class Base_javascript {
293
427
  .sort();
294
428
  for (const key of sortedDepsKeys) {
295
429
  const rootPurl = toPurlFromString(sbom.getRoot().purl);
296
- sbom.addDependency(rootPurl, rootDeps.get(key));
430
+ const targetPurl = rootDeps.get(key);
431
+ sbom.addDependency(rootPurl, targetPurl, undefined, this._hashesForPurl(targetPurl));
297
432
  }
433
+ this.#ensurePeerAndOptionalDeps(sbom);
298
434
  sbom.filterIgnoredDeps(this.#manifest.ignored);
299
435
  return sbom.getAsJsonString(opts);
300
436
  }
@@ -305,10 +441,14 @@ export default class Base_javascript {
305
441
  * @protected
306
442
  */
307
443
  _getRootDependencies(depTree) {
308
- if (!depTree.dependencies) {
444
+ const allDeps = {
445
+ ...depTree.dependencies,
446
+ ...depTree.optionalDependencies,
447
+ };
448
+ if (Object.keys(allDeps).length === 0) {
309
449
  return new Map();
310
450
  }
311
- return new Map(Object.entries(depTree.dependencies).map(([key, value]) => [key, toPurl(purlType, key, value.version)]));
451
+ return new Map(Object.entries(allDeps).map(([key, value]) => [key, toPurl(purlType, key, value.version)]));
312
452
  }
313
453
  /**
314
454
  * Executes the list command to get dependencies
@@ -332,9 +472,9 @@ export default class Base_javascript {
332
472
  /**
333
473
  * Creates or updates the lock file for the package manager
334
474
  * @param {string} manifestDir - Directory containing the manifest file
335
- * @private
475
+ * @protected
336
476
  */
337
- #createLockFile(manifestDir) {
477
+ _createLockFile(manifestDir) {
338
478
  const originalDir = process.cwd();
339
479
  const isWindows = os.platform() === 'win32';
340
480
  if (isWindows) {