@trustify-da/trustify-da-javascript-client 0.3.0-ea.ec6824b → 0.3.0-ea.efdc87d

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 (66) hide show
  1. package/README.md +199 -11
  2. package/dist/package.json +15 -10
  3. package/dist/src/analysis.d.ts +47 -19
  4. package/dist/src/analysis.js +70 -18
  5. package/dist/src/cli.js +188 -6
  6. package/dist/src/config.d.ts +120 -0
  7. package/dist/src/config.js +260 -0
  8. package/dist/src/cyclone_dx_sbom.d.ts +13 -0
  9. package/dist/src/cyclone_dx_sbom.js +39 -1
  10. package/dist/src/index.d.ts +27 -22
  11. package/dist/src/index.js +27 -38
  12. package/dist/src/license/index.d.ts +2 -2
  13. package/dist/src/license/index.js +9 -6
  14. package/dist/src/license/licenses_api.d.ts +2 -2
  15. package/dist/src/license/licenses_api.js +1 -1
  16. package/dist/src/oci_image/images.js +15 -1
  17. package/dist/src/package_version.d.ts +8 -0
  18. package/dist/src/package_version.js +31 -0
  19. package/dist/src/provider.js +3 -1
  20. package/dist/src/providers/base_java.d.ts +53 -0
  21. package/dist/src/providers/base_java.js +64 -17
  22. package/dist/src/providers/base_javascript.d.ts +54 -0
  23. package/dist/src/providers/base_javascript.js +106 -4
  24. package/dist/src/providers/containerfile_parser.d.ts +5 -0
  25. package/dist/src/providers/containerfile_parser.js +20 -0
  26. package/dist/src/providers/golang_gomodules.js +49 -7
  27. package/dist/src/providers/java_gradle.d.ts +48 -0
  28. package/dist/src/providers/java_gradle.js +196 -18
  29. package/dist/src/providers/java_maven.d.ts +28 -8
  30. package/dist/src/providers/java_maven.js +104 -10
  31. package/dist/src/providers/javascript_bun.d.ts +12 -0
  32. package/dist/src/providers/javascript_bun.js +42 -1
  33. package/dist/src/providers/javascript_npm.d.ts +13 -0
  34. package/dist/src/providers/javascript_npm.js +40 -1
  35. package/dist/src/providers/javascript_pnpm.d.ts +13 -0
  36. package/dist/src/providers/javascript_pnpm.js +47 -1
  37. package/dist/src/providers/javascript_yarn.d.ts +12 -0
  38. package/dist/src/providers/javascript_yarn.js +75 -2
  39. package/dist/src/providers/manifest.js +6 -3
  40. package/dist/src/providers/oci_dockerfile.d.ts +51 -0
  41. package/dist/src/providers/oci_dockerfile.js +177 -0
  42. package/dist/src/providers/processors/yarn_berry_processor.d.ts +5 -1
  43. package/dist/src/providers/processors/yarn_berry_processor.js +3 -2
  44. package/dist/src/providers/processors/yarn_classic_processor.d.ts +5 -1
  45. package/dist/src/providers/processors/yarn_classic_processor.js +8 -6
  46. package/dist/src/providers/python_controller.js +4 -1
  47. package/dist/src/providers/requirements_parser.js +1 -1
  48. package/dist/src/providers/rust_cargo.js +70 -29
  49. package/dist/src/providers/tree-sitter-containerfile.wasm +0 -0
  50. package/dist/src/remediate.d.ts +120 -0
  51. package/dist/src/remediate.js +253 -0
  52. package/dist/src/remediation.d.ts +58 -0
  53. package/dist/src/remediation.js +425 -0
  54. package/dist/src/remediation_report.d.ts +40 -0
  55. package/dist/src/remediation_report.js +159 -0
  56. package/dist/src/sbom.d.ts +11 -0
  57. package/dist/src/sbom.js +10 -0
  58. package/dist/src/tools.d.ts +9 -11
  59. package/dist/src/tools.js +34 -13
  60. package/dist/src/updaters/maven_updater.d.ts +58 -0
  61. package/dist/src/updaters/maven_updater.js +345 -0
  62. package/dist/src/updaters/toml_updater.d.ts +62 -0
  63. package/dist/src/updaters/toml_updater.js +276 -0
  64. package/dist/src/workspace.d.ts +2 -1
  65. package/dist/src/workspace.js +2 -1
  66. package/package.json +16 -11
package/dist/src/index.js CHANGED
@@ -1,21 +1,24 @@
1
+ import fs from 'node:fs';
1
2
  import path from "node:path";
2
3
  import { EOL } from "os";
3
4
  import pLimit from 'p-limit';
4
- import { availableProviders, match } from './provider.js';
5
5
  import analysis from './analysis.js';
6
- import fs from 'node:fs';
7
- import { getCustom } from "./tools.js";
8
6
  import { resolveBatchMetadata, resolveContinueOnError } from './batch_opts.js';
9
- import { discoverMavenModules } from './providers/java_maven.js';
10
- import { discoverGradleSubprojects } from './providers/java_gradle.js';
7
+ import { getPackageVersion } from './package_version.js';
8
+ import { availableProviders, match } from './provider.js';
11
9
  import { discoverGoWorkspaceModules } from './providers/golang_gomodules.js';
10
+ import { discoverGradleSubprojects } from './providers/java_gradle.js';
11
+ import { discoverMavenModules } from './providers/java_maven.js';
12
12
  import { discoverUvWorkspaceMembers } from './providers/python_uv.js';
13
+ import { getCustom } from "./tools.js";
13
14
  import { discoverWorkspaceCrates, discoverWorkspacePackages, filterManifestPathsByDiscoveryIgnore, resolveWorkspaceDiscoveryIgnore, validatePackageJson, } from './workspace.js';
14
- import.meta.dirname;
15
- import * as url from 'url';
16
15
  export { parseImageRef } from "./oci_image/utils.js";
17
16
  export { ImageRef } from "./oci_image/images.js";
18
17
  export { getProjectLicense, findLicenseFilePath, identifyLicense, getLicenseDetails, licensesFromReport, normalizeLicensesResponse, runLicenseCheck, getCompatibility } from "./license/index.js";
18
+ export { extractRemediations } from "./remediation.js";
19
+ export { generateReport, generateDeduplicationKey } from './remediation_report.js';
20
+ export { loadConfig, mergeConfig, resolveConfig, CONFIG_FILENAMES } from './config.js';
21
+ export { runRemediation, findManifests } from './remediate.js';
19
22
  export default { componentAnalysis, stackAnalysis, stackAnalysisBatch, imageAnalysis, validateToken, generateSbom };
20
23
  export { discoverMavenModules, discoverGradleSubprojects, discoverGoWorkspaceModules, discoverUvWorkspaceMembers, discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson, resolveWorkspaceDiscoveryIgnore, filterManifestPathsByDiscoveryIgnore, resolveContinueOnError, resolveBatchMetadata, };
21
24
  /**
@@ -39,7 +42,9 @@ export { discoverMavenModules, discoverGradleSubprojects, discoverGoWorkspaceMod
39
42
  * TRUSTIFY_DA_PYTHON_PATH?: string | undefined,
40
43
  * TRUSTIFY_DA_PYTHON_VIRTUAL_ENV?: string | undefined,
41
44
  * TRUSTIFY_DA_PYTHON3_PATH?: string | undefined,
42
- * TRUSTIFY_DA_RECOMMENDATIONS_ENABLED?: string | undefined,
45
+ * TRUSTIFY_DA_PROVIDERS?: string | undefined,
46
+ * TRUSTIFY_DA_RECOMMEND?: string | undefined,
47
+ * TRUSTIFY_DA_SOURCES?: string | undefined,
43
48
  * TRUSTIFY_DA_SKOPEO_CONFIG_PATH?: string | undefined,
44
49
  * TRUSTIFY_DA_SKOPEO_PATH?: string | undefined,
45
50
  * TRUSTIFY_DA_SYFT_CONFIG_PATH?: string | undefined,
@@ -47,6 +52,7 @@ export { discoverMavenModules, discoverGradleSubprojects, discoverGoWorkspaceMod
47
52
  * TRUSTIFY_DA_YARN_PATH?: string | undefined,
48
53
  * TRUSTIFY_DA_WORKSPACE_DIR?: string | undefined,
49
54
  * TRUSTIFY_DA_LICENSE_CHECK?: string | undefined,
55
+ * licenseCheck?: boolean | undefined,
50
56
  * MATCH_MANIFEST_VERSIONS?: string | undefined,
51
57
  * TRUSTIFY_DA_SOURCE?: string | undefined,
52
58
  * TRUSTIFY_DA_TOKEN?: string | undefined,
@@ -91,29 +97,11 @@ function logOptionsAndEnvironmentsVariables(alongsideText, valueToBePrinted) {
91
97
  * @private
92
98
  */
93
99
  function readAndPrintVersionFromPackageJson() {
94
- let dirName;
95
- // new ESM way in nodeJS ( since node version 22 ) to bring module directory.
96
- dirName = import.meta.dirname;
97
- // old ESM way in nodeJS ( before node versions 22.00 to bring module directory)
98
- if (!dirName) {
99
- dirName = url.fileURLToPath(new URL('.', import.meta.url));
100
- }
101
- try {
102
- if (__dirname) {
103
- dirName = __dirname;
104
- }
105
- }
106
- catch (e) {
107
- console.log("__dirname is not defined, continue with fileUrlPath");
108
- }
109
- let packageJson = JSON.parse(fs.readFileSync(path.join(dirName, "..", "package.json")).toString());
110
- logOptionsAndEnvironmentsVariables("trustify-da-javascript-client analysis started, version: ", packageJson.version);
100
+ logOptionsAndEnvironmentsVariables("trustify-da-javascript-client analysis started, version: ", getPackageVersion());
111
101
  }
112
102
  /**
113
- * This function is used to determine the Trustify DA backend URL.
114
- * The TRUSTIFY_DA_BACKEND_URL is evaluated in the following order and selected when it finds it first:
115
- * 1. Environment Variable
116
- * 2. (key,value) from opts object
103
+ * Selects the Trustify DA backend URL from opts.TRUSTIFY_DA_BACKEND_URL, then environment
104
+ * variable TRUSTIFY_DA_BACKEND_URL. Options take precedence over environment variables.
117
105
  * If TRUSTIFY_DA_BACKEND_URL is not set, the function will throw an error.
118
106
  * @param {{TRUSTIFY_DA_DEBUG?: string | undefined; TRUSTIFY_DA_BACKEND_URL?: string | undefined}} [opts={}]
119
107
  * @return {string} - The selected Trustify DA backend URL
@@ -144,7 +132,7 @@ export function selectTrustifyDABackend(opts = {}) {
144
132
  * @param {string} manifest
145
133
  * @param {false} html
146
134
  * @param {Options} [opts={}]
147
- * @returns {Promise<import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>}
135
+ * @returns {Promise<import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport>}
148
136
  * @throws {Error}
149
137
  */
150
138
  /**
@@ -153,7 +141,7 @@ export function selectTrustifyDABackend(opts = {}) {
153
141
  * @param {string} manifest - path for the manifest
154
142
  * @param {boolean} [html=false] - true will return a html string, false will return AnalysisReport object.
155
143
  * @param {Options} [opts={}] - optional various options to pass along the application
156
- * @returns {Promise<string|import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>}
144
+ * @returns {Promise<string|import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport>}
157
145
  * @throws {Error} if manifest inaccessible, no matching provider, failed to get create content,
158
146
  * or backend request failed
159
147
  */
@@ -167,7 +155,7 @@ async function stackAnalysis(manifest, html = false, opts = {}) {
167
155
  * Get component analysis report for a manifest content.
168
156
  * @param {string} manifest - path to the manifest
169
157
  * @param {Options} [opts={}] - optional various options to pass along the application
170
- * @returns {Promise<import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>}
158
+ * @returns {Promise<import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport>}
171
159
  * @throws {Error} if no matching provider, failed to get create content, or backend request failed
172
160
  */
173
161
  async function componentAnalysis(manifest, opts = {}) {
@@ -192,7 +180,7 @@ async function componentAnalysis(manifest, opts = {}) {
192
180
  * @param {Array<string>} imageRefs
193
181
  * @param {false} html
194
182
  * @param {Options} [opts={}]
195
- * @returns {Promise<Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>>}
183
+ * @returns {Promise<Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport>>}
196
184
  * @throws {Error}
197
185
  */
198
186
  /**
@@ -201,7 +189,7 @@ async function componentAnalysis(manifest, opts = {}) {
201
189
  * @param {Array<string>} imageRefs - OCI image references
202
190
  * @param {boolean} [html=false] - true will return a html string, false will return AnalysisReport
203
191
  * @param {Options} [opts={}] - optional various options to pass along the application
204
- * @returns {Promise<string|Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>>}
192
+ * @returns {Promise<string|Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport>>}
205
193
  * @throws {Error} if manifest inaccessible, no matching provider, failed to get create content,
206
194
  * or backend request failed
207
195
  */
@@ -210,7 +198,8 @@ async function imageAnalysis(imageRefs, html = false, opts = {}) {
210
198
  return await analysis.requestImages(imageRefs, theUrl, html, opts);
211
199
  }
212
200
  /**
213
- * Max concurrent SBOM generations for batch workspace analysis. Env/opts override default 10.
201
+ * Max concurrent SBOM generations for batch workspace analysis. Options override environment;
202
+ * environment overrides the default of 10.
214
203
  * @param {Options} opts
215
204
  * @returns {number}
216
205
  * @private
@@ -453,7 +442,7 @@ function batchError(message, wantMetadata, metadata) {
453
442
  * @param {string} workspaceRoot
454
443
  * @param {false} html
455
444
  * @param {Options & { batchMetadata: true }} opts
456
- * @returns {Promise<{ analysis: Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>, metadata: BatchAnalysisMetadata }>}
445
+ * @returns {Promise<{ analysis: Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport>, metadata: BatchAnalysisMetadata }>}
457
446
  * @throws {Error}
458
447
  */
459
448
  /**
@@ -461,7 +450,7 @@ function batchError(message, wantMetadata, metadata) {
461
450
  * @param {string} workspaceRoot
462
451
  * @param {false} html
463
452
  * @param {Options & { batchMetadata?: false }} [opts={}]
464
- * @returns {Promise<Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>>}
453
+ * @returns {Promise<Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport>>}
465
454
  * @throws {Error}
466
455
  */
467
456
  /**
@@ -474,7 +463,7 @@ function batchError(message, wantMetadata, metadata) {
474
463
  * @param {string} workspaceRoot - Path to workspace root (containing lock file and workspace config)
475
464
  * @param {boolean} [html=false] - true returns HTML, false returns JSON report
476
465
  * @param {Options} [opts={}] - `batchConcurrency`, discovery ignores, `continueOnError` (default true), `batchMetadata` (default false)
477
- * @returns {Promise<string|Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>|{ analysis: string|Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>, metadata: BatchAnalysisMetadata }>}
466
+ * @returns {Promise<string|Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport>|{ analysis: string|Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport>, metadata: BatchAnalysisMetadata }>}
478
467
  * @throws {Error} if workspace root invalid, no manifests found, no packages pass validation, no SBOMs produced, or backend request failed. When `opts.batchMetadata` is set, `error.batchMetadata` may be set on thrown errors.
479
468
  */
480
469
  async function stackAnalysisBatch(workspaceRoot, html = false, opts = {}) {
@@ -6,10 +6,10 @@
6
6
  * @param {string} manifestPath - path to manifest
7
7
  * @param {string} url - the backend url to send the request to
8
8
  * @param {import('../index.js').Options} [opts={}]
9
- * @param {import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport} [analysisResult] - analysis result that includes licenses array from backend
9
+ * @param {import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport} [analysisResult] - analysis result that includes licenses array from backend
10
10
  * @returns {Promise<{ projectLicense: { manifest: Object|null, file: Object|null, mismatch: boolean }, incompatibleDependencies: Array<{ purl: string, licenses: string[], category?: string, reason: string }>, error?: string }>}
11
11
  */
12
- export function runLicenseCheck(sbomContent: string, manifestPath: string, url: string, opts?: import("../index.js").Options, analysisResult?: any): Promise<{
12
+ export function runLicenseCheck(sbomContent: string, manifestPath: string, url: string, opts?: import("../index.js").Options, analysisResult?: import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts").AnalysisReport): Promise<{
13
13
  projectLicense: {
14
14
  manifest: Object | null;
15
15
  file: Object | null;
@@ -1,9 +1,9 @@
1
1
  /**
2
2
  * License resolution and dependency license compatibility for component analysis.
3
3
  */
4
- import { getProjectLicense, findLicenseFilePath, identifyLicense } from './project_license.js';
5
- import { licensesFromReport, getLicenseDetails } from './licenses_api.js';
6
4
  import { getCompatibility } from './license_utils.js';
5
+ import { licensesFromReport, getLicenseDetails } from './licenses_api.js';
6
+ import { getProjectLicense, findLicenseFilePath, identifyLicense } from './project_license.js';
7
7
  export { getProjectLicense, findLicenseFilePath, identifyLicense } from './project_license.js';
8
8
  export { licensesFromReport, normalizeLicensesResponse, getLicenseDetails } from './licenses_api.js';
9
9
  export { getCompatibility } from './license_utils.js';
@@ -15,7 +15,7 @@ export { getCompatibility } from './license_utils.js';
15
15
  * @param {string} manifestPath - path to manifest
16
16
  * @param {string} url - the backend url to send the request to
17
17
  * @param {import('../index.js').Options} [opts={}]
18
- * @param {import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport} [analysisResult] - analysis result that includes licenses array from backend
18
+ * @param {import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport} [analysisResult] - analysis result that includes licenses array from backend
19
19
  * @returns {Promise<{ projectLicense: { manifest: Object|null, file: Object|null, mismatch: boolean }, incompatibleDependencies: Array<{ purl: string, licenses: string[], category?: string, reason: string }>, error?: string }>}
20
20
  */
21
21
  export async function runLicenseCheck(sbomContent, manifestPath, url, opts = {}, analysisResult = null) {
@@ -39,10 +39,12 @@ export async function runLicenseCheck(sbomContent, manifestPath, url, opts = {},
39
39
  // Fetch detailed license info from backend (avoid duplicate calls if same license)
40
40
  const licenseDetailsCache = new Map();
41
41
  async function getDetails(spdxId) {
42
- if (!spdxId || !url)
42
+ if (!spdxId || !url) {
43
43
  return null;
44
- if (licenseDetailsCache.has(spdxId))
44
+ }
45
+ if (licenseDetailsCache.has(spdxId)) {
45
46
  return licenseDetailsCache.get(spdxId);
47
+ }
46
48
  try {
47
49
  const details = await getLicenseDetails(spdxId, { ...opts, TRUSTIFY_DA_BACKEND_URL: url });
48
50
  licenseDetailsCache.set(spdxId, details);
@@ -81,8 +83,9 @@ export async function runLicenseCheck(sbomContent, manifestPath, url, opts = {},
81
83
  const incompatibleDependencies = [];
82
84
  for (const purl of purls) {
83
85
  const entry = licenseByPurl.get(purl);
84
- if (!entry)
86
+ if (!entry) {
85
87
  continue;
88
+ }
86
89
  const status = getCompatibility(projectCategory, entry.category);
87
90
  if (status === 'incompatible') {
88
91
  const reason = entry.category?.toUpperCase() === 'UNKNOWN'
@@ -24,11 +24,11 @@ export function normalizeLicensesResponse(data: unknown, purls?: string[]): Map<
24
24
  * Build license map from an analysis report that already includes license data (result.licenses).
25
25
  * Use this when the dependency analysis response already contains the licenses array to avoid a second request.
26
26
  *
27
- * @param {import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport} analysisReport - full analysis JSON
27
+ * @param {import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport} analysisReport - full analysis JSON
28
28
  * @param {string[]} [purls] - optional list of purls to restrict to
29
29
  * @returns {Map<string, { licenses: string[], category?: string }>}
30
30
  */
31
- export function licensesFromReport(analysisReport: any, purls?: string[]): Map<string, {
31
+ export function licensesFromReport(analysisReport: import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts").AnalysisReport, purls?: string[]): Map<string, {
32
32
  licenses: string[];
33
33
  category?: string;
34
34
  }>;
@@ -86,7 +86,7 @@ export function normalizeLicensesResponse(data, purls = []) {
86
86
  * Build license map from an analysis report that already includes license data (result.licenses).
87
87
  * Use this when the dependency analysis response already contains the licenses array to avoid a second request.
88
88
  *
89
- * @param {import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport} analysisReport - full analysis JSON
89
+ * @param {import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport} analysisReport - full analysis JSON
90
90
  * @param {string[]} [purls] - optional list of purls to restrict to
91
91
  * @returns {Map<string, { licenses: string[], category?: string }>}
92
92
  */
@@ -242,8 +242,22 @@ export class ImageRef {
242
242
  getPackageURL() {
243
243
  /** @type {Object.<string, string>} */
244
244
  const qualifiers = {};
245
- const repositoryUrl = this.image.getNameWithoutTag();
245
+ let repositoryUrl = this.image.getNameWithoutTag();
246
246
  const simpleName = this.image.getSimpleName();
247
+ // Normalize Docker Hub image references so all forms produce the same PURL:
248
+ // node → docker.io/node
249
+ // docker.io/library/node → docker.io/node
250
+ if (repositoryUrl != null) {
251
+ const lower = repositoryUrl.toLowerCase();
252
+ if (lower === simpleName.toLowerCase()) {
253
+ // Bare name (e.g. "node") — default to docker.io
254
+ repositoryUrl = `docker.io/${simpleName}`;
255
+ }
256
+ else if (lower.startsWith('docker.io/library/')) {
257
+ // Official image with library/ prefix — strip it
258
+ repositoryUrl = `docker.io/${lower.substring('docker.io/library/'.length)}`;
259
+ }
260
+ }
247
261
  if (repositoryUrl != null && repositoryUrl.toLowerCase() !== simpleName.toLowerCase()) {
248
262
  qualifiers[ImageRef.REPOSITORY_QUALIFIER] = repositoryUrl.toLowerCase();
249
263
  }
@@ -0,0 +1,8 @@
1
+ /**
2
+ * Reads this package's version from package.json, resolving the path relative
3
+ * to this module. Works under ESM (node >= 22 import.meta.dirname, older via
4
+ * import.meta.url) and CommonJS (__dirname). Returns undefined if the file
5
+ * cannot be read, so callers never fail on a missing version.
6
+ * @return {string|undefined} the package version, or undefined
7
+ */
8
+ export function getPackageVersion(): string | undefined;
@@ -0,0 +1,31 @@
1
+ import fs from "node:fs";
2
+ import path from "node:path";
3
+ import * as url from "url";
4
+ /**
5
+ * Reads this package's version from package.json, resolving the path relative
6
+ * to this module. Works under ESM (node >= 22 import.meta.dirname, older via
7
+ * import.meta.url) and CommonJS (__dirname). Returns undefined if the file
8
+ * cannot be read, so callers never fail on a missing version.
9
+ * @return {string|undefined} the package version, or undefined
10
+ */
11
+ export function getPackageVersion() {
12
+ try {
13
+ let dirName = import.meta.dirname;
14
+ if (!dirName) {
15
+ dirName = url.fileURLToPath(new URL('.', import.meta.url));
16
+ }
17
+ try {
18
+ if (__dirname) {
19
+ dirName = __dirname;
20
+ }
21
+ }
22
+ catch {
23
+ // __dirname not defined under ESM, continue with fileURLToPath
24
+ }
25
+ const packageJson = JSON.parse(fs.readFileSync(path.join(dirName, "..", "package.json")).toString());
26
+ return packageJson.version;
27
+ }
28
+ catch {
29
+ return undefined;
30
+ }
31
+ }
@@ -7,6 +7,7 @@ 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';
@@ -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.
@@ -10,6 +10,13 @@ export type ecosystem_maven = any;
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
@@ -40,6 +47,52 @@ export default class Base_Java {
40
47
  * @protected
41
48
  */
42
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;
43
96
  /**
44
97
  * Create a PackageURL from any line in a Text Graph dependency tree for a manifest path.
45
98
  * @param {string} line - line to parse from a dependencies.txt file
@@ -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
  /**
@@ -82,31 +89,71 @@ export default class Base_Java {
82
89
  }
83
90
  return ((line.indexOf('-') - 1) / 3) + 1;
84
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
+ }
85
146
  /**
86
147
  * Create a PackageURL from any line in a Text Graph dependency tree for a manifest path.
87
148
  * @param {string} line - line to parse from a dependencies.txt file
88
149
  * @returns {PackageURL} The parsed packageURL
89
150
  */
90
151
  parseDep(line) {
91
- let match = line.split(':').map(part => part ? part.match(this.DEP_REGEX)[0] : '');
92
- if (!match) {
93
- throw new Error(`Unable generate SBOM from dependency tree. Line: ${line} cannot be parsed into a PackageURL`);
94
- }
95
- let version;
96
- if (match.length >= 5 && ['compile', 'provided', 'runtime'].includes(match[5])) {
97
- version = `${match[4]}-${match[3]}`;
98
- }
99
- else {
100
- version = match[3];
101
- }
102
- let override = line.match(this.CONFLICT_REGEX);
103
- if (override) {
104
- version = override[1];
105
- }
106
- if (match[0].trim() === '') {
152
+ const coord = this.parseCoordinate(line);
153
+ if (coord.groupId.trim() === '') {
107
154
  throw new Error(`Artifact coordinates should have a non-empty group ID: ${line}`);
108
155
  }
109
- return this.toPurl(match[0], match[1], version);
156
+ return this._coordinateToPurl(coord);
110
157
  }
111
158
  /**
112
159
  * Returns a PackageUrl For Java maven dependencies
@@ -1,3 +1,16 @@
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;
1
14
  export type purlType = any;
2
15
  /** @typedef {import('../provider').Provider} */
3
16
  /** @typedef {import('../provider').Provided} Provided */
@@ -65,6 +78,47 @@ export default class Base_javascript {
65
78
  * @protected
66
79
  */
67
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;
68
122
  /**
69
123
  * Checks if the provider supports the given manifest name
70
124
  * @param {string} manifestName - The manifest name to check