@trustify-da/trustify-da-javascript-client 0.3.0-ea.bbe2094 → 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 (75) hide show
  1. package/README.md +177 -3
  2. package/dist/package.json +29 -22
  3. package/dist/src/analysis.d.ts +14 -7
  4. package/dist/src/analysis.js +29 -13
  5. package/dist/src/cli.js +106 -2
  6. package/dist/src/cyclone_dx_sbom.d.ts +13 -0
  7. package/dist/src/cyclone_dx_sbom.js +50 -4
  8. package/dist/src/index.d.ts +14 -10
  9. package/dist/src/index.js +15 -26
  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/package_version.d.ts +8 -0
  18. package/dist/src/package_version.js +31 -0
  19. package/dist/src/provider.d.ts +4 -3
  20. package/dist/src/provider.js +4 -2
  21. package/dist/src/providers/base_java.d.ts +67 -3
  22. package/dist/src/providers/base_java.js +80 -23
  23. package/dist/src/providers/base_javascript.d.ts +68 -9
  24. package/dist/src/providers/base_javascript.js +112 -3
  25. package/dist/src/providers/base_pyproject.d.ts +10 -5
  26. package/dist/src/providers/base_pyproject.js +7 -0
  27. package/dist/src/providers/containerfile_parser.d.ts +5 -0
  28. package/dist/src/providers/containerfile_parser.js +20 -0
  29. package/dist/src/providers/golang_gomodules.d.ts +2 -1
  30. package/dist/src/providers/golang_gomodules.js +44 -3
  31. package/dist/src/providers/java_gradle.d.ts +48 -0
  32. package/dist/src/providers/java_gradle.js +194 -15
  33. package/dist/src/providers/java_gradle_groovy.d.ts +1 -1
  34. package/dist/src/providers/java_gradle_kotlin.d.ts +1 -1
  35. package/dist/src/providers/java_maven.d.ts +30 -5
  36. package/dist/src/providers/java_maven.js +168 -7
  37. package/dist/src/providers/javascript_bun.d.ts +12 -0
  38. package/dist/src/providers/javascript_bun.js +42 -1
  39. package/dist/src/providers/javascript_npm.d.ts +19 -1
  40. package/dist/src/providers/javascript_npm.js +40 -1
  41. package/dist/src/providers/javascript_pnpm.d.ts +13 -0
  42. package/dist/src/providers/javascript_pnpm.js +47 -1
  43. package/dist/src/providers/javascript_yarn.d.ts +12 -0
  44. package/dist/src/providers/javascript_yarn.js +75 -2
  45. package/dist/src/providers/oci_dockerfile.d.ts +51 -0
  46. package/dist/src/providers/oci_dockerfile.js +177 -0
  47. package/dist/src/providers/processors/yarn_berry_processor.d.ts +6 -2
  48. package/dist/src/providers/processors/yarn_berry_processor.js +3 -2
  49. package/dist/src/providers/processors/yarn_classic_processor.d.ts +6 -2
  50. package/dist/src/providers/processors/yarn_classic_processor.js +8 -6
  51. package/dist/src/providers/python_controller.js +61 -4
  52. package/dist/src/providers/python_pip.d.ts +1 -0
  53. package/dist/src/providers/python_pip.js +1 -1
  54. package/dist/src/providers/python_poetry.d.ts +31 -8
  55. package/dist/src/providers/python_poetry.js +62 -14
  56. package/dist/src/providers/python_uv.d.ts +5 -14
  57. package/dist/src/providers/python_uv.js +44 -2
  58. package/dist/src/providers/rust_cargo.d.ts +6 -2
  59. package/dist/src/providers/rust_cargo.js +101 -33
  60. package/dist/src/providers/tree-sitter-containerfile.wasm +0 -0
  61. package/dist/src/remediate.d.ts +21 -0
  62. package/dist/src/remediate.js +149 -0
  63. package/dist/src/remediation.d.ts +57 -0
  64. package/dist/src/remediation.js +436 -0
  65. package/dist/src/remediation_report.d.ts +40 -0
  66. package/dist/src/remediation_report.js +159 -0
  67. package/dist/src/sbom.d.ts +11 -0
  68. package/dist/src/sbom.js +10 -0
  69. package/dist/src/tools.d.ts +2 -2
  70. package/dist/src/tools.js +24 -1
  71. package/dist/src/updaters/maven_updater.d.ts +26 -0
  72. package/dist/src/updaters/maven_updater.js +322 -0
  73. package/dist/src/updaters/toml_updater.d.ts +33 -0
  74. package/dist/src/updaters/toml_updater.js +244 -0
  75. package/package.json +30 -23
@@ -7,13 +7,14 @@ import Javascript_bun from './providers/javascript_bun.js';
7
7
  import Javascript_npm from './providers/javascript_npm.js';
8
8
  import Javascript_pnpm from './providers/javascript_pnpm.js';
9
9
  import Javascript_yarn from './providers/javascript_yarn.js';
10
+ import dockerfileProvider from './providers/oci_dockerfile.js';
10
11
  import pythonPipProvider from './providers/python_pip.js';
11
12
  import Python_pip_pyproject from './providers/python_pip_pyproject.js';
12
13
  import Python_poetry from './providers/python_poetry.js';
13
14
  import Python_uv from './providers/python_uv.js';
14
15
  import rustCargoProvider from './providers/rust_cargo.js';
15
16
  /** @typedef {{ecosystem: string, contentType: string, content: string}} Provided */
16
- /** @typedef {{isSupported: function(string): boolean, validateLockFile: function(string, Object): void, provideComponent: function(string, {}): Provided | Promise<Provided>, provideStack: function(string, {}): Provided | Promise<Provided>, readLicenseFromManifest: function(string): string | null}} Provider */
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 */
17
18
  /**
18
19
  * MUST include all providers here.
19
20
  * @type {[Provider]}
@@ -31,7 +32,8 @@ export const availableProviders = [
31
32
  new Python_poetry(),
32
33
  new Python_uv(),
33
34
  new Python_pip_pyproject(),
34
- rustCargoProvider
35
+ rustCargoProvider,
36
+ dockerfileProvider
35
37
  ];
36
38
  /**
37
39
  * Match a provider by manifest type only (no lock file check). Used for license reading.
@@ -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 */
@@ -10,6 +10,13 @@ export type ecosystem_maven = import("../provider").Provider;
10
10
  export const ecosystem_maven: string;
11
11
  export const ecosystem_gradle: "gradle";
12
12
  export default class Base_Java {
13
+ /**
14
+ * Maven dependency scopes. Used to detect whether the trailing column of a
15
+ * dependency-tree line is a scope keyword — which in turn signals that an
16
+ * optional classifier column is present between the packaging and version.
17
+ * @type {string[]}
18
+ */
19
+ static MAVEN_SCOPES: string[];
13
20
  /**
14
21
  *
15
22
  * @param {string} globalBinary name of the global binary
@@ -20,6 +27,11 @@ export default class Base_Java {
20
27
  CONFLICT_REGEX: RegExp;
21
28
  globalBinary: string;
22
29
  localWrapper: string;
30
+ /**
31
+ * Returns the package manager name (e.g. mvn, gradle)
32
+ * @returns {string}
33
+ */
34
+ packageManagerName(): string;
23
35
  /**
24
36
  * Recursively populates the SBOM instance with the parsed graph
25
37
  * @param {string} src - Source dependency to start the calculations from
@@ -28,6 +40,59 @@ export default class Base_Java {
28
40
  * @param {Sbom} sbom - The SBOM where the dependencies are being added
29
41
  */
30
42
  parseDependencyTree(src: string, srcDepth: number, lines: any[], sbom: Sbom): void;
43
+ /**
44
+ * Calculates how deep in the graph is the given line
45
+ * @param {string} line - line to calculate the depth from
46
+ * @returns {number} The calculated depth
47
+ * @protected
48
+ */
49
+ protected _getDepth(line: string): number;
50
+ /**
51
+ * Parse a single dependency-tree line into its Maven coordinate parts.
52
+ *
53
+ * This is the single source of truth for interpreting a dependency-tree
54
+ * line. Both {@link parseDep} (used to build SBOM component PURLs) and the
55
+ * Maven hash-map builder rely on it, so the PURL key and the artifact file
56
+ * path can never drift from one another.
57
+ *
58
+ * A line has the shape `groupId:artifactId:packaging[:classifier]:version[:scope]`.
59
+ * The classifier column is only present when a sixth column holds a known
60
+ * Maven scope keyword; otherwise the fourth column is the version.
61
+ *
62
+ * @param {string} line - line to parse from a dependency tree
63
+ * @returns {{groupId: string, artifactId: string, packaging: string, classifier: (string|null), version: string, scope: (string|null), overridden: boolean}}
64
+ * Parsed coordinate. `version` is the resolved concrete version — when the
65
+ * line carries a conflict override the override version replaces it and
66
+ * `overridden` is set, mirroring how Maven records the winning version.
67
+ */
68
+ parseCoordinate(line: string): {
69
+ groupId: string;
70
+ artifactId: string;
71
+ packaging: string;
72
+ classifier: (string | null);
73
+ version: string;
74
+ scope: (string | null);
75
+ overridden: boolean;
76
+ };
77
+ /**
78
+ * Build the canonical PackageURL for a parsed coordinate.
79
+ *
80
+ * The classifier is folded into the version component (e.g.
81
+ * `4.1.0-linux-x86_64`) except when the version came from a conflict
82
+ * override, in which case the override version stands alone — matching the
83
+ * historical behavior of {@link parseDep}.
84
+ *
85
+ * @param {{groupId: string, artifactId: string, classifier: (string|null), version: string, overridden: boolean}} coord
86
+ * @returns {PackageURL} The canonical packageURL for the coordinate
87
+ * @protected
88
+ */
89
+ protected _coordinateToPurl(coord: {
90
+ groupId: string;
91
+ artifactId: string;
92
+ classifier: (string | null);
93
+ version: string;
94
+ overridden: boolean;
95
+ }): PackageURL;
31
96
  /**
32
97
  * Create a PackageURL from any line in a Text Graph dependency tree for a manifest path.
33
98
  * @param {string} line - line to parse from a dependencies.txt file
@@ -57,9 +122,8 @@ export default class Base_Java {
57
122
  * @returns string
58
123
  */
59
124
  selectToolBinary(manifestPath: string, opts: {}): string | null;
60
- #private;
61
125
  }
62
- export type Provided = import("../provider").Provided;
126
+ export type Provided = any;
63
127
  export type Package = {
64
128
  name: string;
65
129
  version: string;
@@ -14,6 +14,13 @@ export const ecosystem_gradle = 'gradle';
14
14
  export default class Base_Java {
15
15
  DEP_REGEX = /(([-a-zA-Z0-9._]{2,})|[0-9])/g;
16
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'];
17
24
  globalBinary;
18
25
  localWrapper;
19
26
  /**
@@ -25,6 +32,13 @@ export default class Base_Java {
25
32
  this.globalBinary = globalBinary;
26
33
  this.localWrapper = localWrapper;
27
34
  }
35
+ /**
36
+ * Returns the package manager name (e.g. mvn, gradle)
37
+ * @returns {string}
38
+ */
39
+ packageManagerName() {
40
+ return this.globalBinary;
41
+ }
28
42
  /**
29
43
  * Recursively populates the SBOM instance with the parsed graph
30
44
  * @param {string} src - Source dependency to start the calculations from
@@ -41,7 +55,7 @@ export default class Base_Java {
41
55
  }
42
56
  let index = 0;
43
57
  let target = lines[index];
44
- let targetDepth = this.#getDepth(target);
58
+ let targetDepth = this._getDepth(target);
45
59
  while (targetDepth > srcDepth && index < lines.length) {
46
60
  if (targetDepth === srcDepth + 1) {
47
61
  let from = this.parseDep(src);
@@ -54,49 +68,92 @@ export default class Base_Java {
54
68
  }
55
69
  }
56
70
  else {
57
- 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);
58
72
  }
59
73
  target = lines[++index];
60
- targetDepth = this.#getDepth(target);
74
+ targetDepth = this._getDepth(target);
61
75
  }
62
76
  }
63
77
  /**
64
78
  * Calculates how deep in the graph is the given line
65
79
  * @param {string} line - line to calculate the depth from
66
80
  * @returns {number} The calculated depth
67
- * @private
81
+ * @protected
68
82
  */
69
- #getDepth(line) {
70
- if (line === undefined) {
83
+ _getDepth(line) {
84
+ if (!line || line.trim() === '') {
71
85
  return -1;
72
86
  }
87
+ if (line.match(/^\w/)) {
88
+ return 0;
89
+ }
73
90
  return ((line.indexOf('-') - 1) / 3) + 1;
74
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
+ }
75
146
  /**
76
147
  * Create a PackageURL from any line in a Text Graph dependency tree for a manifest path.
77
148
  * @param {string} line - line to parse from a dependencies.txt file
78
149
  * @returns {PackageURL} The parsed packageURL
79
150
  */
80
151
  parseDep(line) {
81
- let match = line.split(':').map(part => part ? part.match(this.DEP_REGEX)[0] : '');
82
- if (!match) {
83
- throw new Error(`Unable generate SBOM from dependency tree. Line: ${line} cannot be parsed into a PackageURL`);
84
- }
85
- let version;
86
- if (match.length >= 5 && ['compile', 'provided', 'runtime'].includes(match[5])) {
87
- version = `${match[4]}-${match[3]}`;
88
- }
89
- else {
90
- version = match[3];
91
- }
92
- let override = line.match(this.CONFLICT_REGEX);
93
- if (override) {
94
- version = override[1];
95
- }
96
- if (match[0].trim() === '') {
152
+ const coord = this.parseCoordinate(line);
153
+ if (coord.groupId.trim() === '') {
97
154
  throw new Error(`Artifact coordinates should have a non-empty group ID: ${line}`);
98
155
  }
99
- return this.toPurl(match[0], match[1], version);
156
+ return this._coordinateToPurl(coord);
100
157
  }
101
158
  /**
102
159
  * Returns a PackageUrl For Java maven dependencies
@@ -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
@@ -150,6 +209,6 @@ export default class Base_javascript {
150
209
  protected _parseDepTreeOutput(output: string): string;
151
210
  #private;
152
211
  }
153
- export type Provided = import("../provider").Provided;
212
+ export type Provided = any;
154
213
  import Manifest from './manifest.js';
155
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
@@ -218,6 +325,7 @@ export default class Base_javascript {
218
325
  const manifestDir = path.dirname(this.#manifest.manifestPath);
219
326
  const cmdDir = this._findLockFileDir(manifestDir, opts) || manifestDir;
220
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);
@@ -277,7 +385,7 @@ export default class Base_javascript {
277
385
  const [name, artifact] = entry;
278
386
  const target = toPurl(purlType, name, artifact.version);
279
387
  const rootPurl = toPurl(purlType, this.#manifest.name, this.#manifest.version);
280
- sbom.addDependency(rootPurl, target);
388
+ sbom.addDependency(rootPurl, target, undefined, this._hashesFor(name, artifact.version));
281
389
  this.#addDependenciesOf(sbom, target, artifact);
282
390
  });
283
391
  }
@@ -295,7 +403,7 @@ export default class Base_javascript {
295
403
  const [name, depArtifact] = entry;
296
404
  if (depArtifact.version !== undefined) {
297
405
  const target = toPurl(purlType, name, depArtifact.version);
298
- sbom.addDependency(from, target);
406
+ sbom.addDependency(from, target, undefined, this._hashesFor(name, depArtifact.version));
299
407
  this.#addDependenciesOf(sbom, target, depArtifact);
300
408
  }
301
409
  });
@@ -319,7 +427,8 @@ export default class Base_javascript {
319
427
  .sort();
320
428
  for (const key of sortedDepsKeys) {
321
429
  const rootPurl = toPurlFromString(sbom.getRoot().purl);
322
- sbom.addDependency(rootPurl, rootDeps.get(key));
430
+ const targetPurl = rootDeps.get(key);
431
+ sbom.addDependency(rootPurl, targetPurl, undefined, this._hashesForPurl(targetPurl));
323
432
  }
324
433
  this.#ensurePeerAndOptionalDeps(sbom);
325
434
  sbom.filterIgnoredDeps(this.#manifest.ignored);
@@ -13,7 +13,7 @@ export default class Base_pyproject {
13
13
  * @param {Object} [opts={}]
14
14
  * @returns {boolean}
15
15
  */
16
- validateLockFile(manifestDir: string, opts?: any): boolean;
16
+ validateLockFile(manifestDir: string, opts?: Object): boolean;
17
17
  /**
18
18
  * Walk up from manifestDir to find the directory containing the lock file.
19
19
  * Follows the same pattern as Base_javascript._findLockFileDir().
@@ -22,7 +22,7 @@ export default class Base_pyproject {
22
22
  * @returns {string|null}
23
23
  * @protected
24
24
  */
25
- protected _findLockFileDir(manifestDir: string, opts?: any): string | null;
25
+ protected _findLockFileDir(manifestDir: string, opts?: Object): string | null;
26
26
  /**
27
27
  * Detect workspace root boundaries.
28
28
  * Currently only uv has native workspace support ([tool.uv.workspace] in pyproject.toml).
@@ -44,13 +44,13 @@ export default class Base_pyproject {
44
44
  * @param {Object} [opts={}]
45
45
  * @returns {Promise<Provided>}
46
46
  */
47
- provideStack(manifest: string, opts?: any): Promise<Provided>;
47
+ provideStack(manifest: string, opts?: Object): Promise<Provided>;
48
48
  /**
49
49
  * @param {string} manifest - path to pyproject.toml
50
50
  * @param {Object} [opts={}]
51
51
  * @returns {Promise<Provided>}
52
52
  */
53
- provideComponent(manifest: string, opts?: any): Promise<Provided>;
53
+ provideComponent(manifest: string, opts?: Object): Promise<Provided>;
54
54
  /**
55
55
  * @returns {string}
56
56
  * @protected
@@ -61,6 +61,11 @@ export default class Base_pyproject {
61
61
  * @protected
62
62
  */
63
63
  protected _cmdName(): string;
64
+ /**
65
+ * Returns the package manager name (e.g. pip, poetry, uv)
66
+ * @returns {string}
67
+ */
68
+ packageManagerName(): string;
64
69
  /**
65
70
  * Resolve dependencies using the tool-specific command and parser.
66
71
  *
@@ -72,7 +77,7 @@ export default class Base_pyproject {
72
77
  * @returns {Promise<DependencyData>}
73
78
  * @protected
74
79
  */
75
- protected _getDependencyData(manifestDir: string, workspaceDir: string, parsed: object, opts: any): Promise<DependencyData>;
80
+ protected _getDependencyData(manifestDir: string, workspaceDir: string, parsed: object, opts: Object): Promise<DependencyData>;
76
81
  /**
77
82
  * Canonicalize a Python package name per PEP 503.
78
83
  * @param {string} name
@@ -145,6 +145,13 @@ export default class Base_pyproject {
145
145
  _cmdName() {
146
146
  throw new TypeError('_cmdName must be implemented');
147
147
  }
148
+ /**
149
+ * Returns the package manager name (e.g. pip, poetry, uv)
150
+ * @returns {string}
151
+ */
152
+ packageManagerName() {
153
+ return this._cmdName();
154
+ }
148
155
  /**
149
156
  * Resolve dependencies using the tool-specific command and parser.
150
157
  *
@@ -0,0 +1,5 @@
1
+ export function getParser(): Promise<Parser>;
2
+ export function getFromQuery(): Promise<Query>;
3
+ export function getArgQuery(): Promise<Query>;
4
+ import { Parser } from 'web-tree-sitter';
5
+ import { Query } from 'web-tree-sitter';