@trustify-da/trustify-da-javascript-client 0.3.0-ea.dcb2120 → 0.3.0-ea.de62188

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 (70) hide show
  1. package/README.md +1 -1
  2. package/dist/package.json +25 -22
  3. package/dist/src/analysis.d.ts +14 -7
  4. package/dist/src/analysis.js +29 -13
  5. package/dist/src/cli.js +58 -1
  6. package/dist/src/cyclone_dx_sbom.d.ts +7 -1
  7. package/dist/src/cyclone_dx_sbom.js +29 -8
  8. package/dist/src/index.d.ts +72 -11
  9. package/dist/src/index.js +76 -7
  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/provider.d.ts +4 -3
  18. package/dist/src/provider.js +8 -2
  19. package/dist/src/providers/base_java.d.ts +14 -12
  20. package/dist/src/providers/base_java.js +18 -44
  21. package/dist/src/providers/base_javascript.d.ts +20 -9
  22. package/dist/src/providers/base_javascript.js +10 -3
  23. package/dist/src/providers/base_pyproject.d.ts +22 -32
  24. package/dist/src/providers/base_pyproject.js +60 -74
  25. package/dist/src/providers/containerfile_parser.d.ts +5 -0
  26. package/dist/src/providers/containerfile_parser.js +20 -0
  27. package/dist/src/providers/golang_gomodules.d.ts +11 -1
  28. package/dist/src/providers/golang_gomodules.js +65 -8
  29. package/dist/src/providers/java_gradle.d.ts +19 -0
  30. package/dist/src/providers/java_gradle.js +116 -2
  31. package/dist/src/providers/java_gradle_groovy.d.ts +1 -1
  32. package/dist/src/providers/java_gradle_kotlin.d.ts +1 -1
  33. package/dist/src/providers/java_maven.d.ts +10 -2
  34. package/dist/src/providers/java_maven.js +165 -1
  35. package/dist/src/providers/javascript_bun.d.ts +10 -0
  36. package/dist/src/providers/javascript_bun.js +100 -0
  37. package/dist/src/providers/javascript_npm.d.ts +6 -0
  38. package/dist/src/providers/javascript_npm.js +21 -0
  39. package/dist/src/providers/javascript_pnpm.js +6 -2
  40. package/dist/src/providers/marker_evaluator.d.ts +14 -0
  41. package/dist/src/providers/marker_evaluator.js +191 -0
  42. package/dist/src/providers/oci_dockerfile.d.ts +51 -0
  43. package/dist/src/providers/oci_dockerfile.js +177 -0
  44. package/dist/src/providers/processors/yarn_berry_processor.d.ts +2 -2
  45. package/dist/src/providers/processors/yarn_berry_processor.js +6 -2
  46. package/dist/src/providers/processors/yarn_classic_processor.d.ts +2 -2
  47. package/dist/src/providers/python_controller.d.ts +5 -1
  48. package/dist/src/providers/python_controller.js +65 -7
  49. package/dist/src/providers/python_pip.d.ts +5 -0
  50. package/dist/src/providers/python_pip.js +5 -5
  51. package/dist/src/providers/python_pip_pyproject.d.ts +61 -0
  52. package/dist/src/providers/python_pip_pyproject.js +146 -0
  53. package/dist/src/providers/python_poetry.d.ts +64 -8
  54. package/dist/src/providers/python_poetry.js +139 -22
  55. package/dist/src/providers/python_uv.d.ts +20 -1
  56. package/dist/src/providers/python_uv.js +126 -3
  57. package/dist/src/providers/rust_cargo.d.ts +6 -2
  58. package/dist/src/providers/rust_cargo.js +31 -4
  59. package/dist/src/providers/tree-sitter-containerfile.wasm +0 -0
  60. package/dist/src/sbom.d.ts +7 -1
  61. package/dist/src/sbom.js +4 -2
  62. package/dist/src/tools.d.ts +28 -2
  63. package/dist/src/tools.js +58 -0
  64. package/dist/src/updaters/maven_updater.d.ts +26 -0
  65. package/dist/src/updaters/maven_updater.js +322 -0
  66. package/dist/src/updaters/toml_updater.d.ts +33 -0
  67. package/dist/src/updaters/toml_updater.js +244 -0
  68. package/dist/src/workspace.d.ts +9 -0
  69. package/dist/src/workspace.js +1 -1
  70. package/package.json +26 -23
package/dist/src/index.js CHANGED
@@ -6,6 +6,10 @@ import analysis from './analysis.js';
6
6
  import fs from 'node:fs';
7
7
  import { getCustom } from "./tools.js";
8
8
  import { resolveBatchMetadata, resolveContinueOnError } from './batch_opts.js';
9
+ import { discoverMavenModules } from './providers/java_maven.js';
10
+ import { discoverGradleSubprojects } from './providers/java_gradle.js';
11
+ import { discoverGoWorkspaceModules } from './providers/golang_gomodules.js';
12
+ import { discoverUvWorkspaceMembers } from './providers/python_uv.js';
9
13
  import { discoverWorkspaceCrates, discoverWorkspacePackages, filterManifestPathsByDiscoveryIgnore, resolveWorkspaceDiscoveryIgnore, validatePackageJson, } from './workspace.js';
10
14
  import.meta.dirname;
11
15
  import * as url from 'url';
@@ -13,7 +17,7 @@ export { parseImageRef } from "./oci_image/utils.js";
13
17
  export { ImageRef } from "./oci_image/images.js";
14
18
  export { getProjectLicense, findLicenseFilePath, identifyLicense, getLicenseDetails, licensesFromReport, normalizeLicensesResponse, runLicenseCheck, getCompatibility } from "./license/index.js";
15
19
  export default { componentAnalysis, stackAnalysis, stackAnalysisBatch, imageAnalysis, validateToken, generateSbom };
16
- export { discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson, resolveWorkspaceDiscoveryIgnore, filterManifestPathsByDiscoveryIgnore, resolveContinueOnError, resolveBatchMetadata, };
20
+ export { discoverMavenModules, discoverGradleSubprojects, discoverGoWorkspaceModules, discoverUvWorkspaceMembers, discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson, resolveWorkspaceDiscoveryIgnore, filterManifestPathsByDiscoveryIgnore, resolveContinueOnError, resolveBatchMetadata, };
17
21
  /**
18
22
  * @typedef {{
19
23
  * TRUSTIFY_DA_CARGO_PATH?: string | undefined,
@@ -35,7 +39,9 @@ export { discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson
35
39
  * TRUSTIFY_DA_PYTHON_PATH?: string | undefined,
36
40
  * TRUSTIFY_DA_PYTHON_VIRTUAL_ENV?: string | undefined,
37
41
  * TRUSTIFY_DA_PYTHON3_PATH?: string | undefined,
38
- * TRUSTIFY_DA_RECOMMENDATIONS_ENABLED?: string | undefined,
42
+ * TRUSTIFY_DA_PROVIDERS?: string | undefined,
43
+ * TRUSTIFY_DA_RECOMMEND?: string | undefined,
44
+ * TRUSTIFY_DA_SOURCES?: string | undefined,
39
45
  * TRUSTIFY_DA_SKOPEO_CONFIG_PATH?: string | undefined,
40
46
  * TRUSTIFY_DA_SKOPEO_PATH?: string | undefined,
41
47
  * TRUSTIFY_DA_SYFT_CONFIG_PATH?: string | undefined,
@@ -64,7 +70,7 @@ export { discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson
64
70
  /**
65
71
  * @typedef {{
66
72
  * workspaceRoot: string,
67
- * ecosystem: 'javascript' | 'cargo' | 'unknown',
73
+ * ecosystem: 'javascript' | 'cargo' | 'pyproject' | 'unknown',
68
74
  * total: number,
69
75
  * successful: number,
70
76
  * failed: number,
@@ -171,7 +177,9 @@ async function componentAnalysis(manifest, opts = {}) {
171
177
  fs.accessSync(manifest, fs.constants.R_OK);
172
178
  opts["manifest-type"] = path.basename(manifest);
173
179
  let provider = match(manifest, availableProviders, opts); // throws error if no matching provider
174
- return await analysis.requestComponent(provider, manifest, theUrl, opts); // throws error request sending failed
180
+ const result = await analysis.requestComponent(provider, manifest, theUrl, opts); // throws error request sending failed
181
+ result.packageManager = provider.packageManagerName();
182
+ return result;
175
183
  }
176
184
  /**
177
185
  * @overload
@@ -279,17 +287,45 @@ async function generateOneSbom(manifestPath, workspaceOpts) {
279
287
  *
280
288
  * @param {string} root - Resolved workspace root
281
289
  * @param {Options} opts
282
- * @returns {Promise<{ ecosystem: 'javascript' | 'cargo' | 'unknown', manifestPaths: string[] }>}
290
+ * @returns {Promise<{ ecosystem: 'javascript' | 'cargo' | 'maven' | 'gradle' | 'gomodules' | 'pyproject' | 'unknown', manifestPaths: string[] }>}
283
291
  * @private
284
292
  */
285
293
  async function detectWorkspaceManifests(root, opts) {
286
294
  const cargoToml = path.join(root, 'Cargo.toml');
287
295
  const cargoLock = path.join(root, 'Cargo.lock');
288
296
  const packageJson = path.join(root, 'package.json');
297
+ const pomXml = path.join(root, 'pom.xml');
289
298
  if (fs.existsSync(cargoToml) && fs.existsSync(cargoLock)) {
290
299
  return { ecosystem: 'cargo', manifestPaths: await discoverWorkspaceCrates(root, opts) };
291
300
  }
292
- const hasJsLock = fs.existsSync(path.join(root, 'pnpm-lock.yaml'))
301
+ if (fs.existsSync(pomXml)) {
302
+ const manifestPaths = await discoverMavenModules(root, opts);
303
+ if (manifestPaths.length > 0) {
304
+ return { ecosystem: 'maven', manifestPaths };
305
+ }
306
+ }
307
+ const hasGradleSettings = fs.existsSync(path.join(root, 'settings.gradle'))
308
+ || fs.existsSync(path.join(root, 'settings.gradle.kts'));
309
+ if (hasGradleSettings) {
310
+ const manifestPaths = await discoverGradleSubprojects(root, opts);
311
+ if (manifestPaths.length > 0) {
312
+ return { ecosystem: 'gradle', manifestPaths };
313
+ }
314
+ }
315
+ if (fs.existsSync(path.join(root, 'go.work'))) {
316
+ const manifestPaths = await discoverGoWorkspaceModules(root, opts);
317
+ if (manifestPaths.length > 0) {
318
+ return { ecosystem: 'gomodules', manifestPaths };
319
+ }
320
+ }
321
+ if (fs.existsSync(path.join(root, 'pyproject.toml')) && fs.existsSync(path.join(root, 'uv.lock'))) {
322
+ const manifestPaths = await discoverUvWorkspaceMembers(root, opts);
323
+ if (manifestPaths.length > 0) {
324
+ return { ecosystem: 'pyproject', manifestPaths };
325
+ }
326
+ }
327
+ const hasJsLock = fs.existsSync(path.join(root, 'bun.lock'))
328
+ || fs.existsSync(path.join(root, 'pnpm-lock.yaml'))
293
329
  || fs.existsSync(path.join(root, 'yarn.lock'))
294
330
  || fs.existsSync(path.join(root, 'package-lock.json'));
295
331
  if (fs.existsSync(packageJson) && hasJsLock) {
@@ -398,12 +434,45 @@ function batchError(message, wantMetadata, metadata) {
398
434
  }
399
435
  return err;
400
436
  }
437
+ /**
438
+ * @overload
439
+ * @param {string} workspaceRoot
440
+ * @param {true} html
441
+ * @param {Options & { batchMetadata: true }} opts
442
+ * @returns {Promise<{ analysis: string, metadata: BatchAnalysisMetadata }>}
443
+ * @throws {Error}
444
+ */
445
+ /**
446
+ * @overload
447
+ * @param {string} workspaceRoot
448
+ * @param {true} html
449
+ * @param {Options & { batchMetadata?: false }} [opts={}]
450
+ * @returns {Promise<string>}
451
+ * @throws {Error}
452
+ */
453
+ /**
454
+ * @overload
455
+ * @param {string} workspaceRoot
456
+ * @param {false} html
457
+ * @param {Options & { batchMetadata: true }} opts
458
+ * @returns {Promise<{ analysis: Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>, metadata: BatchAnalysisMetadata }>}
459
+ * @throws {Error}
460
+ */
461
+ /**
462
+ * @overload
463
+ * @param {string} workspaceRoot
464
+ * @param {false} html
465
+ * @param {Options & { batchMetadata?: false }} [opts={}]
466
+ * @returns {Promise<Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>>}
467
+ * @throws {Error}
468
+ */
401
469
  /**
402
470
  * Get stack analysis for all workspace packages/crates (batch).
403
471
  * Detects ecosystem from workspace root: Cargo (Cargo.toml + Cargo.lock) or JS/TS (package.json + lock file).
404
472
  * SBOMs are generated in parallel (see `batchConcurrency`) unless `continueOnError: false` (fail-fast sequential).
405
473
  * With `opts.batchMetadata` / `TRUSTIFY_DA_BATCH_METADATA`, returns `{ analysis, metadata }` including validation and SBOM errors.
406
474
  *
475
+ * @overload
407
476
  * @param {string} workspaceRoot - Path to workspace root (containing lock file and workspace config)
408
477
  * @param {boolean} [html=false] - true returns HTML, false returns JSON report
409
478
  * @param {Options} [opts={}] - `batchConcurrency`, discovery ignores, `continueOnError` (default true), `batchMetadata` (default false)
@@ -434,7 +503,7 @@ async function stackAnalysisBatch(workspaceRoot, html = false, opts = {}) {
434
503
  }
435
504
  }
436
505
  if (manifestPaths.length === 0) {
437
- throw new Error(`No workspace manifests found at ${root}. Ensure Cargo.toml+Cargo.lock or package.json+lock file exist.`);
506
+ throw new Error(`No workspace manifests found at ${root}. Ensure a supported workspace root exists (Cargo.toml+Cargo.lock, pom.xml, build.gradle, go.work, pyproject.toml+uv.lock, or package.json+lock file).`);
438
507
  }
439
508
  const workspaceOpts = { ...opts, TRUSTIFY_DA_WORKSPACE_DIR: root };
440
509
  const concurrency = resolveBatchConcurrency(opts);
@@ -9,10 +9,10 @@
9
9
  * @param {import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').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?: import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport): Promise<{
12
+ export function runLicenseCheck(sbomContent: string, manifestPath: string, url: string, opts?: import("../index.js").Options, analysisResult?: any): Promise<{
13
13
  projectLicense: {
14
- manifest: any | null;
15
- file: any | null;
14
+ manifest: Object | null;
15
+ file: Object | null;
16
16
  mismatch: boolean;
17
17
  };
18
18
  incompatibleDependencies: Array<{
@@ -85,11 +85,14 @@ export async function runLicenseCheck(sbomContent, manifestPath, url, opts = {},
85
85
  continue;
86
86
  const status = getCompatibility(projectCategory, entry.category);
87
87
  if (status === 'incompatible') {
88
+ const reason = entry.category?.toUpperCase() === 'UNKNOWN'
89
+ ? 'License not recognized as a standard SPDX identifier. Manual review recommended to verify compatibility.'
90
+ : 'Dependency license(s) are incompatible with the project license.';
88
91
  incompatibleDependencies.push({
89
92
  purl,
90
93
  licenses: entry.licenses,
91
94
  category: entry.category,
92
- reason: 'Dependency license(s) are incompatible with the project license.'
95
+ reason
93
96
  });
94
97
  }
95
98
  }
@@ -114,9 +114,12 @@ export function getCompatibility(projectCategory, dependencyCategory) {
114
114
  }
115
115
  const proj = projectCategory.toUpperCase();
116
116
  const dep = dependencyCategory.toUpperCase();
117
- if (proj === 'UNKNOWN' || dep === 'UNKNOWN') {
117
+ if (proj === 'UNKNOWN') {
118
118
  return 'unknown';
119
119
  }
120
+ if (dep === 'UNKNOWN') {
121
+ return 'incompatible';
122
+ }
120
123
  const restrictiveness = {
121
124
  'PERMISSIVE': 1,
122
125
  'WEAK_COPYLEFT': 2,
@@ -6,7 +6,7 @@
6
6
  * @param {import('../index.js').Options} [opts={}] - options (proxy, token, TRUSTIFY_DA_BACKEND_URL, etc.)
7
7
  * @returns {Promise<Object|null>} License details or null if not found
8
8
  */
9
- export function getLicenseDetails(spdxId: string, opts?: import("../index.js").Options): Promise<any | null>;
9
+ export function getLicenseDetails(spdxId: string, opts?: import("../index.js").Options): Promise<Object | null>;
10
10
  /**
11
11
  * Normalize the LicensesResponse shape (array of LicenseProviderResult) into a map of purl -> license info.
12
12
  * Each provider result has { status, summary, packages } where packages is { [purl]: { concluded, evidence } }.
@@ -28,7 +28,7 @@ export function normalizeLicensesResponse(data: unknown, purls?: string[]): Map<
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: import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport, purls?: string[]): Map<string, {
31
+ export function licensesFromReport(analysisReport: any, purls?: string[]): Map<string, {
32
32
  licenses: string[];
33
33
  category?: string;
34
34
  }>;
@@ -78,7 +78,7 @@ export class ImageRef {
78
78
  * @param {string} [platform]
79
79
  * @param {import("index.js").Options} [opts={}]
80
80
  */
81
- constructor(image: string, platform?: string, opts?: import("index.js").Options);
81
+ constructor(image: string, platform?: string, opts?: any);
82
82
  /** @type {Image} */
83
83
  image: Image;
84
84
  /** @type {Platform} */
@@ -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
  }
@@ -4,7 +4,7 @@
4
4
  * @param {import("../index.js").Options} [opts={}] - optional various options to pass along the application
5
5
  * @returns {{}}
6
6
  */
7
- export function generateImageSBOM(imageRef: import("./images").ImageRef, opts?: import("../index.js").Options): {};
7
+ export function generateImageSBOM(imageRef: any, opts?: import("../index.js").Options): {};
8
8
  /**
9
9
  *
10
10
  * @param {string} image
@@ -25,7 +25,7 @@ export function getImagePlatform(opts?: import("../index.js").Options): Platform
25
25
  * @returns {Object.<string, string>} - The image digests
26
26
  * @throws {Error} If the image info is invalid
27
27
  */
28
- export function getImageDigests(imageRef: import("./images").ImageRef, opts?: import("../index.js").Options): {
28
+ export function getImageDigests(imageRef: any, opts?: import("../index.js").Options): {
29
29
  [x: string]: string;
30
30
  };
31
31
  export type SyftImageSource = {
@@ -34,9 +34,9 @@ export type SyftImageSource = {
34
34
  getVariant: () => string;
35
35
  };
36
36
  export type SyftImageSourceType = {
37
- getOs: (arg0: any) => string;
38
- getArch: (arg0: any) => string;
39
- getVariant: (arg0: any) => string;
37
+ getOs: (arg0: Object) => string;
38
+ getArch: (arg0: Object) => string;
39
+ getVariant: (arg0: Object) => string;
40
40
  };
41
41
  import { ImageRef } from './images.js';
42
42
  import { Platform } from './platform.js';
@@ -21,7 +21,7 @@ export function match(manifest: string, providers: [Provider], opts?: {
21
21
  TRUSTIFY_DA_WORKSPACE_DIR?: string;
22
22
  }): Provider;
23
23
  /** @typedef {{ecosystem: string, contentType: string, content: string}} Provided */
24
- /** @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 */
24
+ /** @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 */
25
25
  /**
26
26
  * MUST include all providers here.
27
27
  * @type {[Provider]}
@@ -34,8 +34,9 @@ export type Provided = {
34
34
  };
35
35
  export type Provider = {
36
36
  isSupported: (arg0: string) => boolean;
37
- validateLockFile: (arg0: string, arg1: any) => void;
37
+ validateLockFile: (arg0: string, arg1: Object) => void;
38
38
  provideComponent: (arg0: string, arg1: {}) => Provided | Promise<Provided>;
39
39
  provideStack: (arg0: string, arg1: {}) => Provided | Promise<Provided>;
40
- readLicenseFromManifest: (arg0: string) => string | null;
40
+ readLicenseFromManifest: (arg0: string, arg1: Object | undefined) => string | null;
41
+ packageManagerName: () => string;
41
42
  };
@@ -3,15 +3,18 @@ import golangGomodulesProvider from './providers/golang_gomodules.js';
3
3
  import Java_gradle_groovy from "./providers/java_gradle_groovy.js";
4
4
  import Java_gradle_kotlin from "./providers/java_gradle_kotlin.js";
5
5
  import Java_maven from "./providers/java_maven.js";
6
+ import Javascript_bun from './providers/javascript_bun.js';
6
7
  import Javascript_npm from './providers/javascript_npm.js';
7
8
  import Javascript_pnpm from './providers/javascript_pnpm.js';
8
9
  import Javascript_yarn from './providers/javascript_yarn.js';
10
+ import dockerfileProvider from './providers/oci_dockerfile.js';
9
11
  import pythonPipProvider from './providers/python_pip.js';
12
+ import Python_pip_pyproject from './providers/python_pip_pyproject.js';
10
13
  import Python_poetry from './providers/python_poetry.js';
11
14
  import Python_uv from './providers/python_uv.js';
12
15
  import rustCargoProvider from './providers/rust_cargo.js';
13
16
  /** @typedef {{ecosystem: string, contentType: string, content: string}} Provided */
14
- /** @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 */
15
18
  /**
16
19
  * MUST include all providers here.
17
20
  * @type {[Provider]}
@@ -20,6 +23,7 @@ export const availableProviders = [
20
23
  new Java_maven(),
21
24
  new Java_gradle_groovy(),
22
25
  new Java_gradle_kotlin(),
26
+ new Javascript_bun(),
23
27
  new Javascript_pnpm(),
24
28
  new Javascript_yarn(),
25
29
  new Javascript_npm(),
@@ -27,7 +31,9 @@ export const availableProviders = [
27
31
  pythonPipProvider,
28
32
  new Python_poetry(),
29
33
  new Python_uv(),
30
- rustCargoProvider
34
+ new Python_pip_pyproject(),
35
+ rustCargoProvider,
36
+ dockerfileProvider
31
37
  ];
32
38
  /**
33
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 */
@@ -20,6 +20,11 @@ export default class Base_Java {
20
20
  CONFLICT_REGEX: RegExp;
21
21
  globalBinary: string;
22
22
  localWrapper: string;
23
+ /**
24
+ * Returns the package manager name (e.g. mvn, gradle)
25
+ * @returns {string}
26
+ */
27
+ packageManagerName(): string;
23
28
  /**
24
29
  * Recursively populates the SBOM instance with the parsed graph
25
30
  * @param {string} src - Source dependency to start the calculations from
@@ -28,6 +33,13 @@ export default class Base_Java {
28
33
  * @param {Sbom} sbom - The SBOM where the dependencies are being added
29
34
  */
30
35
  parseDependencyTree(src: string, srcDepth: number, lines: any[], sbom: Sbom): void;
36
+ /**
37
+ * Calculates how deep in the graph is the given line
38
+ * @param {string} line - line to calculate the depth from
39
+ * @returns {number} The calculated depth
40
+ * @protected
41
+ */
42
+ protected _getDepth(line: string): number;
31
43
  /**
32
44
  * Create a PackageURL from any line in a Text Graph dependency tree for a manifest path.
33
45
  * @param {string} line - line to parse from a dependencies.txt file
@@ -57,18 +69,8 @@ export default class Base_Java {
57
69
  * @returns string
58
70
  */
59
71
  selectToolBinary(manifestPath: string, opts: {}): string | null;
60
- /**
61
- *
62
- * @param {string} startingManifest - the path of the manifest from which to start searching for the wrapper
63
- * @param {string} repoRoot - the root of the repository at which point to stop searching for mvnw, derived via git if unset and then fallsback
64
- * to the root of the drive the manifest is on (assumes absolute path is given)
65
- * @returns {string|undefined}
66
- */
67
- traverseForWrapper(startingManifest: string, repoRoot?: string): string | undefined;
68
- normalizePath(thePath: any): string;
69
- #private;
70
72
  }
71
- export type Provided = import("../provider").Provided;
73
+ export type Provided = any;
72
74
  export type Package = {
73
75
  name: string;
74
76
  version: string;
@@ -1,7 +1,6 @@
1
- import fs from 'node:fs';
2
1
  import path from 'node:path';
3
2
  import { PackageURL } from 'packageurl-js';
4
- import { getCustomPath, getGitRootDir, getWrapperPreference, invokeCommand } from "../tools.js";
3
+ import { getCustomPath, getWrapperPreference, invokeCommand, traverseForWrapper } from "../tools.js";
5
4
  /** @typedef {import('../provider').Provider} */
6
5
  /** @typedef {import('../provider').Provided} Provided */
7
6
  /** @typedef {{name: string, version: string}} Package */
@@ -26,6 +25,13 @@ export default class Base_Java {
26
25
  this.globalBinary = globalBinary;
27
26
  this.localWrapper = localWrapper;
28
27
  }
28
+ /**
29
+ * Returns the package manager name (e.g. mvn, gradle)
30
+ * @returns {string}
31
+ */
32
+ packageManagerName() {
33
+ return this.globalBinary;
34
+ }
29
35
  /**
30
36
  * Recursively populates the SBOM instance with the parsed graph
31
37
  * @param {string} src - Source dependency to start the calculations from
@@ -42,7 +48,7 @@ export default class Base_Java {
42
48
  }
43
49
  let index = 0;
44
50
  let target = lines[index];
45
- let targetDepth = this.#getDepth(target);
51
+ let targetDepth = this._getDepth(target);
46
52
  while (targetDepth > srcDepth && index < lines.length) {
47
53
  if (targetDepth === srcDepth + 1) {
48
54
  let from = this.parseDep(src);
@@ -55,22 +61,25 @@ export default class Base_Java {
55
61
  }
56
62
  }
57
63
  else {
58
- this.parseDependencyTree(lines[index - 1], this.#getDepth(lines[index - 1]), lines.slice(index), sbom);
64
+ this.parseDependencyTree(lines[index - 1], this._getDepth(lines[index - 1]), lines.slice(index), sbom);
59
65
  }
60
66
  target = lines[++index];
61
- targetDepth = this.#getDepth(target);
67
+ targetDepth = this._getDepth(target);
62
68
  }
63
69
  }
64
70
  /**
65
71
  * Calculates how deep in the graph is the given line
66
72
  * @param {string} line - line to calculate the depth from
67
73
  * @returns {number} The calculated depth
68
- * @private
74
+ * @protected
69
75
  */
70
- #getDepth(line) {
71
- if (line === undefined) {
76
+ _getDepth(line) {
77
+ if (!line || line.trim() === '') {
72
78
  return -1;
73
79
  }
80
+ if (line.match(/^\w/)) {
81
+ return 0;
82
+ }
74
83
  return ((line.indexOf('-') - 1) / 3) + 1;
75
84
  }
76
85
  /**
@@ -131,7 +140,7 @@ export default class Base_Java {
131
140
  const toolPath = getCustomPath(this.globalBinary, opts);
132
141
  const useWrapper = getWrapperPreference(this.globalBinary, opts);
133
142
  if (useWrapper) {
134
- const wrapper = this.traverseForWrapper(manifestPath);
143
+ const wrapper = traverseForWrapper(manifestDir, this.localWrapper);
135
144
  if (wrapper !== undefined) {
136
145
  try {
137
146
  this._invokeCommand(wrapper, ['--version'], { cwd: manifestDir });
@@ -156,39 +165,4 @@ export default class Base_Java {
156
165
  }
157
166
  return toolPath;
158
167
  }
159
- /**
160
- *
161
- * @param {string} startingManifest - the path of the manifest from which to start searching for the wrapper
162
- * @param {string} repoRoot - the root of the repository at which point to stop searching for mvnw, derived via git if unset and then fallsback
163
- * to the root of the drive the manifest is on (assumes absolute path is given)
164
- * @returns {string|undefined}
165
- */
166
- traverseForWrapper(startingManifest, repoRoot = undefined) {
167
- const normalizedManifest = this.normalizePath(startingManifest);
168
- const currentDir = this.normalizePath(path.dirname(normalizedManifest));
169
- repoRoot = repoRoot || getGitRootDir(currentDir) || path.parse(normalizedManifest).root;
170
- const wrapperPath = path.join(currentDir, this.localWrapper);
171
- try {
172
- fs.accessSync(wrapperPath, fs.constants.X_OK);
173
- return wrapperPath;
174
- }
175
- catch (error) {
176
- if (error.code === 'ENOENT') {
177
- const rootDir = path.parse(currentDir).root;
178
- if (currentDir === repoRoot || currentDir === rootDir) {
179
- return undefined;
180
- }
181
- const parentDir = path.dirname(currentDir);
182
- if (parentDir === currentDir || parentDir === rootDir) {
183
- return undefined;
184
- }
185
- return this.traverseForWrapper(path.join(parentDir, path.basename(normalizedManifest)), repoRoot);
186
- }
187
- throw new Error(`failure searching for ${this.localWrapper}`, { cause: error });
188
- }
189
- }
190
- normalizePath(thePath) {
191
- const normalized = path.resolve(thePath).normalize();
192
- return process.platform === 'win32' ? normalized.toLowerCase() : normalized;
193
- }
194
168
  }
@@ -1,4 +1,4 @@
1
- export type purlType = import("../provider").Provider;
1
+ export type purlType = any;
2
2
  /** @typedef {import('../provider').Provider} */
3
3
  /** @typedef {import('../provider').Provided} Provided */
4
4
  /**
@@ -19,7 +19,7 @@ export default class Base_javascript {
19
19
  * @param {Object} opts - Configuration options for the provider
20
20
  * @protected
21
21
  */
22
- protected _setUp(manifestPath: string, opts: any): void;
22
+ protected _setUp(manifestPath: string, opts: Object): void;
23
23
  /**
24
24
  * Gets the current manifest object
25
25
  * @returns {Manifest} The manifest object
@@ -47,6 +47,11 @@ export default class Base_javascript {
47
47
  */
48
48
  protected _cmdName(): string;
49
49
  /**
50
+ * Returns the package manager name (e.g. npm, yarn, pnpm, bun)
51
+ * @returns {string} The package manager name
52
+ */
53
+ packageManagerName(): string;
54
+ /**
50
55
  * Returns the command arguments for listing dependencies
51
56
  * @returns {Array<string>} The command arguments
52
57
  * @abstract
@@ -86,21 +91,21 @@ export default class Base_javascript {
86
91
  * @param {Object} [opts={}] - optional; may contain TRUSTIFY_DA_WORKSPACE_DIR
87
92
  * @returns {boolean} True if the lock file exists
88
93
  */
89
- validateLockFile(manifestDir: string, opts?: any): boolean;
94
+ validateLockFile(manifestDir: string, opts?: Object): boolean;
90
95
  /**
91
96
  * Provides content and content type for stack analysis
92
97
  * @param {string} manifestPath - The manifest path or name
93
98
  * @param {Object} [opts={}] - Optional configuration options
94
99
  * @returns {Provided} The provided data for stack analysis
95
100
  */
96
- provideStack(manifestPath: string, opts?: any): Provided;
101
+ provideStack(manifestPath: string, opts?: Object): Provided;
97
102
  /**
98
103
  * Provides content and content type for component analysis
99
104
  * @param {string} manifestPath - Path to package.json for component report
100
105
  * @param {Object} [opts={}] - Optional configuration options
101
106
  * @returns {Provided} The provided data for component analysis
102
107
  */
103
- provideComponent(manifestPath: string, opts?: any): Provided;
108
+ provideComponent(manifestPath: string, opts?: Object): Provided;
104
109
  /**
105
110
  * Read license from manifest (package.json). Reused by npm, pnpm, yarn.
106
111
  * @param {string} manifestPath - path to package.json
@@ -114,21 +119,21 @@ export default class Base_javascript {
114
119
  * @returns {Object} The dependency tree
115
120
  * @protected
116
121
  */
117
- protected _buildDependencyTree(includeTransitive: boolean, opts?: any): any;
122
+ protected _buildDependencyTree(includeTransitive: boolean, opts?: Object): Object;
118
123
  /**
119
124
  * Recursively builds the Sbom from the JSON that npm listing returns
120
125
  * @param {Sbom} sbom - The SBOM object to add dependencies to
121
126
  * @param {Object} depTree - The current dependency tree
122
127
  * @protected
123
128
  */
124
- protected _addDependenciesToSbom(sbom: Sbom, depTree: any): void;
129
+ protected _addDependenciesToSbom(sbom: Sbom, depTree: Object): void;
125
130
  /**
126
131
  * Extracts root dependencies from the dependency tree
127
132
  * @param {Object} depTree - The dependency tree object
128
133
  * @returns {Map<string, PackageURL>} Map of dependency names to their PackageURL objects
129
134
  * @protected
130
135
  */
131
- protected _getRootDependencies(depTree: any): Map<string, PackageURL>;
136
+ protected _getRootDependencies(depTree: Object): Map<string, PackageURL>;
132
137
  /**
133
138
  * Gets the version of the package manager
134
139
  * @returns {string} The version string of the package manager
@@ -136,6 +141,12 @@ export default class Base_javascript {
136
141
  */
137
142
  protected _version(): string;
138
143
  /**
144
+ * Creates or updates the lock file for the package manager
145
+ * @param {string} manifestDir - Directory containing the manifest file
146
+ * @protected
147
+ */
148
+ protected _createLockFile(manifestDir: string): void;
149
+ /**
139
150
  * Parses the dependency tree output
140
151
  * @param {string} output - The output to parse
141
152
  * @returns {string} The parsed output
@@ -144,6 +155,6 @@ export default class Base_javascript {
144
155
  protected _parseDepTreeOutput(output: string): string;
145
156
  #private;
146
157
  }
147
- export type Provided = import("../provider").Provided;
158
+ export type Provided = any;
148
159
  import Manifest from './manifest.js';
149
160
  import Sbom from '../sbom.js';
@@ -71,6 +71,13 @@ export default class Base_javascript {
71
71
  throw new TypeError("_cmdName must be implemented");
72
72
  }
73
73
  /**
74
+ * Returns the package manager name (e.g. npm, yarn, pnpm, bun)
75
+ * @returns {string} The package manager name
76
+ */
77
+ packageManagerName() {
78
+ return this._cmdName();
79
+ }
80
+ /**
74
81
  * Returns the command arguments for listing dependencies
75
82
  * @returns {Array<string>} The command arguments
76
83
  * @abstract
@@ -217,7 +224,7 @@ export default class Base_javascript {
217
224
  this._version();
218
225
  const manifestDir = path.dirname(this.#manifest.manifestPath);
219
226
  const cmdDir = this._findLockFileDir(manifestDir, opts) || manifestDir;
220
- this.#createLockFile(cmdDir);
227
+ this._createLockFile(cmdDir);
221
228
  let output = this.#executeListCmd(includeTransitive, cmdDir);
222
229
  output = this._parseDepTreeOutput(output);
223
230
  return JSON.parse(output);
@@ -363,9 +370,9 @@ export default class Base_javascript {
363
370
  /**
364
371
  * Creates or updates the lock file for the package manager
365
372
  * @param {string} manifestDir - Directory containing the manifest file
366
- * @private
373
+ * @protected
367
374
  */
368
- #createLockFile(manifestDir) {
375
+ _createLockFile(manifestDir) {
369
376
  const originalDir = process.cwd();
370
377
  const isWindows = os.platform() === 'win32';
371
378
  if (isWindows) {