@trustify-da/trustify-da-javascript-client 0.3.0-ea.e12bc82 → 0.3.0-ea.e5bb86c

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 (64) hide show
  1. package/README.md +191 -11
  2. package/dist/package.json +23 -10
  3. package/dist/src/analysis.d.ts +21 -5
  4. package/dist/src/analysis.js +74 -80
  5. package/dist/src/batch_opts.d.ts +24 -0
  6. package/dist/src/batch_opts.js +35 -0
  7. package/dist/src/cli.js +192 -8
  8. package/dist/src/cyclone_dx_sbom.d.ts +10 -2
  9. package/dist/src/cyclone_dx_sbom.js +32 -5
  10. package/dist/src/index.d.ts +128 -11
  11. package/dist/src/index.js +272 -7
  12. package/dist/src/license/index.d.ts +28 -0
  13. package/dist/src/license/index.js +100 -0
  14. package/dist/src/license/license_utils.d.ts +40 -0
  15. package/dist/src/license/license_utils.js +134 -0
  16. package/dist/src/license/licenses_api.d.ts +34 -0
  17. package/dist/src/license/licenses_api.js +98 -0
  18. package/dist/src/license/project_license.d.ts +20 -0
  19. package/dist/src/license/project_license.js +62 -0
  20. package/dist/src/oci_image/images.d.ts +4 -5
  21. package/dist/src/oci_image/utils.d.ts +4 -4
  22. package/dist/src/provider.d.ts +17 -5
  23. package/dist/src/provider.js +27 -5
  24. package/dist/src/providers/base_java.d.ts +3 -5
  25. package/dist/src/providers/base_javascript.d.ts +29 -7
  26. package/dist/src/providers/base_javascript.js +129 -22
  27. package/dist/src/providers/base_pyproject.d.ts +147 -0
  28. package/dist/src/providers/base_pyproject.js +279 -0
  29. package/dist/src/providers/golang_gomodules.d.ts +20 -13
  30. package/dist/src/providers/golang_gomodules.js +112 -114
  31. package/dist/src/providers/gomod_parser.d.ts +4 -0
  32. package/dist/src/providers/gomod_parser.js +16 -0
  33. package/dist/src/providers/java_gradle.d.ts +9 -3
  34. package/dist/src/providers/java_gradle.js +12 -2
  35. package/dist/src/providers/java_gradle_groovy.d.ts +1 -1
  36. package/dist/src/providers/java_gradle_kotlin.d.ts +1 -1
  37. package/dist/src/providers/java_maven.d.ts +12 -5
  38. package/dist/src/providers/java_maven.js +33 -5
  39. package/dist/src/providers/javascript_pnpm.d.ts +1 -1
  40. package/dist/src/providers/javascript_pnpm.js +2 -2
  41. package/dist/src/providers/manifest.d.ts +2 -0
  42. package/dist/src/providers/manifest.js +22 -4
  43. package/dist/src/providers/processors/yarn_berry_processor.js +82 -3
  44. package/dist/src/providers/python_controller.d.ts +5 -2
  45. package/dist/src/providers/python_controller.js +56 -58
  46. package/dist/src/providers/python_pip.d.ts +11 -4
  47. package/dist/src/providers/python_pip.js +47 -54
  48. package/dist/src/providers/python_poetry.d.ts +42 -0
  49. package/dist/src/providers/python_poetry.js +146 -0
  50. package/dist/src/providers/python_uv.d.ts +26 -0
  51. package/dist/src/providers/python_uv.js +118 -0
  52. package/dist/src/providers/requirements_parser.d.ts +6 -0
  53. package/dist/src/providers/requirements_parser.js +24 -0
  54. package/dist/src/providers/rust_cargo.d.ts +52 -0
  55. package/dist/src/providers/rust_cargo.js +614 -0
  56. package/dist/src/providers/tree-sitter-gomod.wasm +0 -0
  57. package/dist/src/providers/tree-sitter-requirements.wasm +0 -0
  58. package/dist/src/sbom.d.ts +10 -1
  59. package/dist/src/sbom.js +12 -2
  60. package/dist/src/tools.d.ts +22 -6
  61. package/dist/src/tools.js +56 -1
  62. package/dist/src/workspace.d.ts +61 -0
  63. package/dist/src/workspace.js +256 -0
  64. package/package.json +24 -11
@@ -0,0 +1,134 @@
1
+ /**
2
+ * License utilities: file reading, SPDX detection, normalization, compatibility.
3
+ * This module has NO dependencies on providers or backend to avoid circular dependencies.
4
+ */
5
+ import fs from 'node:fs';
6
+ import path from 'node:path';
7
+ const LICENSE_FILES = ['LICENSE', 'LICENSE.md', 'LICENSE.txt'];
8
+ /**
9
+ * Find LICENSE file path in the same directory as the manifest.
10
+ * @param {string} manifestPath
11
+ * @returns {string|null} - path to LICENSE file or null if not found
12
+ */
13
+ export function findLicenseFilePath(manifestPath) {
14
+ const manifestDir = path.dirname(path.resolve(manifestPath));
15
+ for (const name of LICENSE_FILES) {
16
+ const filePath = path.join(manifestDir, name);
17
+ try {
18
+ if (fs.statSync(filePath).isFile()) {
19
+ return filePath;
20
+ }
21
+ }
22
+ catch {
23
+ // skip
24
+ }
25
+ }
26
+ return null;
27
+ }
28
+ /**
29
+ * Very simple SPDX detection from common license text (first ~500 chars).
30
+ * @param {string} text
31
+ * @returns {string|null}
32
+ */
33
+ export function detectSpdxFromText(text) {
34
+ const head = text.slice(0, 500);
35
+ if (/Apache License,?\s*Version 2\.0/i.test(head)) {
36
+ return 'Apache-2.0';
37
+ }
38
+ if (/MIT License/i.test(head) && /Permission is hereby granted/i.test(head)) {
39
+ return 'MIT';
40
+ }
41
+ if (/GNU AFFERO GENERAL PUBLIC LICENSE\s+Version 3/i.test(head)) {
42
+ return 'AGPL-3.0-only';
43
+ }
44
+ if (/GNU LESSER GENERAL PUBLIC LICENSE\s+Version 3/i.test(head)) {
45
+ return 'LGPL-3.0-only';
46
+ }
47
+ if (/GNU LESSER GENERAL PUBLIC LICENSE\s+Version 2\.1/i.test(head)) {
48
+ return 'LGPL-2.1-only';
49
+ }
50
+ if (/GNU GENERAL PUBLIC LICENSE\s+Version 2/i.test(head)) {
51
+ return 'GPL-2.0-only';
52
+ }
53
+ if (/GNU GENERAL PUBLIC LICENSE\s+Version 3/i.test(head)) {
54
+ return 'GPL-3.0-only';
55
+ }
56
+ if (/BSD 2-Clause/i.test(head)) {
57
+ return 'BSD-2-Clause';
58
+ }
59
+ if (/BSD 3-Clause/i.test(head)) {
60
+ return 'BSD-3-Clause';
61
+ }
62
+ return null;
63
+ }
64
+ /**
65
+ * Read LICENSE file and detect SPDX identifier.
66
+ * @param {string} manifestPath - path to manifest
67
+ * @returns {string|null} - SPDX identifier from LICENSE file or null
68
+ */
69
+ export function readLicenseFile(manifestPath) {
70
+ const licenseFilePath = findLicenseFilePath(manifestPath);
71
+ if (!licenseFilePath) {
72
+ return null;
73
+ }
74
+ try {
75
+ const content = fs.readFileSync(licenseFilePath, 'utf-8');
76
+ return detectSpdxFromText(content) || content.split('\n')[0]?.trim() || null;
77
+ }
78
+ catch {
79
+ return null;
80
+ }
81
+ }
82
+ /**
83
+ * Get project license from manifest or LICENSE file.
84
+ * Returns manifestLicense if provided, otherwise tries LICENSE file.
85
+ * @param {string|null} manifestLicense - license from manifest (or null)
86
+ * @param {string} manifestPath - path to manifest
87
+ * @returns {string|null} - SPDX identifier or null
88
+ */
89
+ export function getLicense(manifestLicense, manifestPath) {
90
+ return manifestLicense || readLicenseFile(manifestPath) || null;
91
+ }
92
+ /**
93
+ * Normalize SPDX identifier for comparison (lowercase, strip common suffixes).
94
+ * @param {string} spdxOrName
95
+ * @returns {string}
96
+ */
97
+ export function normalizeSpdx(spdxOrName) {
98
+ const s = String(spdxOrName).trim().toLowerCase();
99
+ if (s.endsWith(' license')) {
100
+ return s.slice(0, -8);
101
+ }
102
+ return s;
103
+ }
104
+ /**
105
+ * Check if a dependency's license is compatible with the project license based on backend categories.
106
+ *
107
+ * @param {string} [projectCategory] - backend category for project license: PERMISSIVE | WEAK_COPYLEFT | STRONG_COPYLEFT | UNKNOWN
108
+ * @param {string} [dependencyCategory] - backend category for dependency license: PERMISSIVE | WEAK_COPYLEFT | STRONG_COPYLEFT | UNKNOWN
109
+ * @returns {'compatible'|'incompatible'|'unknown'}
110
+ */
111
+ export function getCompatibility(projectCategory, dependencyCategory) {
112
+ if (!projectCategory || !dependencyCategory) {
113
+ return 'unknown';
114
+ }
115
+ const proj = projectCategory.toUpperCase();
116
+ const dep = dependencyCategory.toUpperCase();
117
+ if (proj === 'UNKNOWN' || dep === 'UNKNOWN') {
118
+ return 'unknown';
119
+ }
120
+ const restrictiveness = {
121
+ 'PERMISSIVE': 1,
122
+ 'WEAK_COPYLEFT': 2,
123
+ 'STRONG_COPYLEFT': 3
124
+ };
125
+ const projLevel = restrictiveness[proj];
126
+ const depLevel = restrictiveness[dep];
127
+ if (projLevel === undefined || depLevel === undefined) {
128
+ return 'unknown';
129
+ }
130
+ if (depLevel > projLevel) {
131
+ return 'incompatible';
132
+ }
133
+ return 'compatible';
134
+ }
@@ -0,0 +1,34 @@
1
+ /**
2
+ * Fetch license details by SPDX identifier from the backend GET /api/v5/licenses/{spdx}.
3
+ * Returns detailed information about a specific license including category, name, and text.
4
+ *
5
+ * @param {string} spdxId - SPDX identifier (e.g., "Apache-2.0", "MIT")
6
+ * @param {import('../index.js').Options} [opts={}] - options (proxy, token, TRUSTIFY_DA_BACKEND_URL, etc.)
7
+ * @returns {Promise<Object|null>} License details or null if not found
8
+ */
9
+ export function getLicenseDetails(spdxId: string, opts?: import("../index.js").Options): Promise<any | null>;
10
+ /**
11
+ * Normalize the LicensesResponse shape (array of LicenseProviderResult) into a map of purl -> license info.
12
+ * Each provider result has { status, summary, packages } where packages is { [purl]: { concluded, evidence } }.
13
+ * We merge the first successful provider's packages; concluded has identifiers[], category (PERMISSIVE | WEAK_COPYLEFT | STRONG_COPYLEFT | UNKNOWN).
14
+ *
15
+ * @param {unknown} data - LicensesResponse (array) or analysis report's licenses field
16
+ * @param {string[]} [purls] - optional list of purls to restrict to (for consistency with getLicensesByPurl)
17
+ * @returns {Map<string, { licenses: string[], category?: string }>}
18
+ */
19
+ export function normalizeLicensesResponse(data: unknown, purls?: string[]): Map<string, {
20
+ licenses: string[];
21
+ category?: string;
22
+ }>;
23
+ /**
24
+ * Build license map from an analysis report that already includes license data (result.licenses).
25
+ * Use this when the dependency analysis response already contains the licenses array to avoid a second request.
26
+ *
27
+ * @param {import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport} analysisReport - full analysis JSON
28
+ * @param {string[]} [purls] - optional list of purls to restrict to
29
+ * @returns {Map<string, { licenses: string[], category?: string }>}
30
+ */
31
+ export function licensesFromReport(analysisReport: import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport, purls?: string[]): Map<string, {
32
+ licenses: string[];
33
+ category?: string;
34
+ }>;
@@ -0,0 +1,98 @@
1
+ /**
2
+ * Client for the Trustify DA backend License Analysis API (POST /api/v5/licenses).
3
+ * The same license data shape is returned in the dependency analysis JSON report (result.licenses).
4
+ * @see https://github.com/guacsec/trustify-dependency-analytics#license-analysis-apiv5licenses
5
+ * @see https://github.com/guacsec/trustify-da-api-spec/blob/main/api/v5/openapi.yaml
6
+ */
7
+ import { PackageURL } from 'packageurl-js';
8
+ import { selectTrustifyDABackend } from '../index.js';
9
+ import { addProxyAgent, getTokenHeaders } from '../tools.js';
10
+ /**
11
+ * Fetch license details by SPDX identifier from the backend GET /api/v5/licenses/{spdx}.
12
+ * Returns detailed information about a specific license including category, name, and text.
13
+ *
14
+ * @param {string} spdxId - SPDX identifier (e.g., "Apache-2.0", "MIT")
15
+ * @param {import('../index.js').Options} [opts={}] - options (proxy, token, TRUSTIFY_DA_BACKEND_URL, etc.)
16
+ * @returns {Promise<Object|null>} License details or null if not found
17
+ */
18
+ export async function getLicenseDetails(spdxId, opts = {}) {
19
+ if (!spdxId) {
20
+ return null;
21
+ }
22
+ const url = selectTrustifyDABackend(opts);
23
+ const finalUrl = new URL(`${url}/api/v5/licenses/${encodeURIComponent(spdxId)}`);
24
+ const fetchOptions = addProxyAgent({
25
+ method: 'GET',
26
+ headers: {
27
+ 'Accept': 'application/json',
28
+ ...getTokenHeaders(opts)
29
+ },
30
+ }, opts);
31
+ try {
32
+ const resp = await fetch(finalUrl, fetchOptions);
33
+ if (!resp.ok) {
34
+ const errorText = await resp.text().catch(() => '');
35
+ throw new Error(`HTTP ${resp.status}: ${errorText || resp.statusText}`);
36
+ }
37
+ return await resp.json();
38
+ }
39
+ catch (err) {
40
+ throw new Error(`Failed to fetch license details: ${err.message}`);
41
+ }
42
+ }
43
+ function normalizePurlString(purl) {
44
+ const parsed = PackageURL.fromString(purl);
45
+ return new PackageURL(parsed.type, parsed.namespace, parsed.name, parsed.version, null, null).toString();
46
+ }
47
+ /**
48
+ * Normalize the LicensesResponse shape (array of LicenseProviderResult) into a map of purl -> license info.
49
+ * Each provider result has { status, summary, packages } where packages is { [purl]: { concluded, evidence } }.
50
+ * We merge the first successful provider's packages; concluded has identifiers[], category (PERMISSIVE | WEAK_COPYLEFT | STRONG_COPYLEFT | UNKNOWN).
51
+ *
52
+ * @param {unknown} data - LicensesResponse (array) or analysis report's licenses field
53
+ * @param {string[]} [purls] - optional list of purls to restrict to (for consistency with getLicensesByPurl)
54
+ * @returns {Map<string, { licenses: string[], category?: string }>}
55
+ */
56
+ export function normalizeLicensesResponse(data, purls = []) {
57
+ const map = new Map();
58
+ if (!data || !Array.isArray(data)) {
59
+ return map;
60
+ }
61
+ const normalizedPurlsSet = purls.length > 0 ? new Set(purls.map(normalizePurlString)) : null;
62
+ for (const providerResult of data) {
63
+ const packages = providerResult?.packages;
64
+ if (!packages || typeof packages !== 'object') {
65
+ continue;
66
+ }
67
+ for (const [purl, pkgLicense] of Object.entries(packages)) {
68
+ const concluded = pkgLicense?.concluded;
69
+ const identifiers = Array.isArray(concluded?.identifiers) ? concluded.identifiers : [];
70
+ const expression = concluded?.expression;
71
+ const licenses = identifiers.length > 0 ? identifiers : (expression ? [expression] : []);
72
+ const category = concluded?.category; // PERMISSIVE | WEAK_COPYLEFT | STRONG_COPYLEFT | UNKNOWN
73
+ const normalizedPurl = normalizePurlString(purl);
74
+ if (normalizedPurlsSet === null || normalizedPurlsSet.has(normalizedPurl)) {
75
+ map.set(normalizedPurl, { licenses: licenses.filter(Boolean), category });
76
+ }
77
+ }
78
+ // Use first provider that has packages; backend may return multiple (e.g. deps.dev)
79
+ if (map.size > 0) {
80
+ break;
81
+ }
82
+ }
83
+ return map;
84
+ }
85
+ /**
86
+ * Build license map from an analysis report that already includes license data (result.licenses).
87
+ * Use this when the dependency analysis response already contains the licenses array to avoid a second request.
88
+ *
89
+ * @param {import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport} analysisReport - full analysis JSON
90
+ * @param {string[]} [purls] - optional list of purls to restrict to
91
+ * @returns {Map<string, { licenses: string[], category?: string }>}
92
+ */
93
+ export function licensesFromReport(analysisReport, purls = []) {
94
+ if (!analysisReport?.licenses) {
95
+ return new Map();
96
+ }
97
+ return normalizeLicensesResponse(analysisReport.licenses, purls);
98
+ }
@@ -0,0 +1,20 @@
1
+ /**
2
+ * Resolve project license from manifest and from LICENSE / LICENSE.md in manifest dir or git root.
3
+ * Uses local pattern matching for LICENSE file identification (synchronous).
4
+ * For more accurate backend-based identification, use identifyLicense() separately.
5
+ * @param {string} manifestPath - path to manifest
6
+ * @returns {{ fromManifest: string|null, fromFile: string|null, mismatch: boolean }}
7
+ */
8
+ export function getProjectLicense(manifestPath: string): {
9
+ fromManifest: string | null;
10
+ fromFile: string | null;
11
+ mismatch: boolean;
12
+ };
13
+ /**
14
+ * Call backend /licenses/identify endpoint to identify license from file.
15
+ * @param {string} licenseFilePath - path to LICENSE file
16
+ * @param {{}} [opts={}] - options (proxy, token, etc.)
17
+ * @returns {Promise<string|null>} - SPDX identifier or null
18
+ */
19
+ export function identifyLicense(licenseFilePath: string, opts?: {}): Promise<string | null>;
20
+ export { findLicenseFilePath, readLicenseFile } from "./license_utils.js";
@@ -0,0 +1,62 @@
1
+ /**
2
+ * Resolves the project license from the manifest and from a LICENSE / LICENSE.md file.
3
+ * Used to report manifest-vs-file mismatch and as the baseline for dependency license compatibility.
4
+ */
5
+ import fs from 'node:fs';
6
+ import path from 'node:path';
7
+ import { selectTrustifyDABackend } from '../index.js';
8
+ import { matchForLicense, availableProviders } from '../provider.js';
9
+ import { addProxyAgent, getTokenHeaders } from '../tools.js';
10
+ import { normalizeSpdx, readLicenseFile } from './license_utils.js';
11
+ /**
12
+ * Resolve project license from manifest and from LICENSE / LICENSE.md in manifest dir or git root.
13
+ * Uses local pattern matching for LICENSE file identification (synchronous).
14
+ * For more accurate backend-based identification, use identifyLicense() separately.
15
+ * @param {string} manifestPath - path to manifest
16
+ * @returns {{ fromManifest: string|null, fromFile: string|null, mismatch: boolean }}
17
+ */
18
+ export function getProjectLicense(manifestPath) {
19
+ const resolved = path.resolve(manifestPath);
20
+ const provider = matchForLicense(resolved, availableProviders);
21
+ const fromManifest = provider.readLicenseFromManifest(resolved);
22
+ const fromFile = readLicenseFile(resolved);
23
+ const mismatch = Boolean(fromManifest && fromFile && normalizeSpdx(fromManifest) !== normalizeSpdx(fromFile));
24
+ return {
25
+ fromManifest: fromManifest || null,
26
+ fromFile: fromFile || null,
27
+ mismatch
28
+ };
29
+ }
30
+ export { findLicenseFilePath, readLicenseFile } from './license_utils.js';
31
+ /**
32
+ * Call backend /licenses/identify endpoint to identify license from file.
33
+ * @param {string} licenseFilePath - path to LICENSE file
34
+ * @param {{}} [opts={}] - options (proxy, token, etc.)
35
+ * @returns {Promise<string|null>} - SPDX identifier or null
36
+ */
37
+ export async function identifyLicense(licenseFilePath, opts = {}) {
38
+ try {
39
+ const fileContent = fs.readFileSync(licenseFilePath);
40
+ const backendUrl = selectTrustifyDABackend(opts);
41
+ const url = new URL(`${backendUrl}/api/v5/licenses/identify`);
42
+ const tokenHeaders = getTokenHeaders(opts);
43
+ const fetchOptions = addProxyAgent({
44
+ method: 'POST',
45
+ headers: {
46
+ 'Content-Type': 'application/octet-stream',
47
+ ...tokenHeaders,
48
+ },
49
+ body: fileContent,
50
+ }, opts);
51
+ const resp = await fetch(url, fetchOptions);
52
+ if (!resp.ok) {
53
+ return null; // Fallback to local detection on error
54
+ }
55
+ const data = await resp.json();
56
+ // Extract SPDX identifier from backend response
57
+ return data?.license?.id || data?.spdx_id || data?.identifier || null;
58
+ }
59
+ catch {
60
+ return null; // Fallback to local detection on error
61
+ }
62
+ }
@@ -1,4 +1,3 @@
1
- /// <reference types="packageurl-js/src/package-url.js" />
2
1
  /**
3
2
  * Helper class for parsing docker repository/image names:
4
3
  *
@@ -26,7 +25,7 @@ export class Image {
26
25
  * @param {string} fullName
27
26
  * @param {string} [givenTag]
28
27
  */
29
- constructor(fullName: string, givenTag?: string | undefined);
28
+ constructor(fullName: string, givenTag?: string);
30
29
  repository: string;
31
30
  registry: string;
32
31
  tag: string;
@@ -46,12 +45,12 @@ export class Image {
46
45
  * @param {string} [optionalRegistry]
47
46
  * @returns {string}
48
47
  */
49
- getNameWithoutTag(optionalRegistry?: string | undefined): string;
48
+ getNameWithoutTag(optionalRegistry?: string): string;
50
49
  /**
51
50
  * @param {string} [optionalRegistry]
52
51
  * @returns {string}
53
52
  */
54
- getFullName(optionalRegistry?: string | undefined): string;
53
+ getFullName(optionalRegistry?: string): string;
55
54
  /**
56
55
  * @returns {string}
57
56
  */
@@ -79,7 +78,7 @@ export class ImageRef {
79
78
  * @param {string} [platform]
80
79
  * @param {import("index.js").Options} [opts={}]
81
80
  */
82
- constructor(image: string, platform?: string | undefined, opts?: import("index.js").Options | undefined);
81
+ constructor(image: string, platform?: string, opts?: import("index.js").Options);
83
82
  /** @type {Image} */
84
83
  image: Image;
85
84
  /** @type {Platform} */
@@ -4,20 +4,20 @@
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 | undefined): {};
7
+ export function generateImageSBOM(imageRef: import("./images").ImageRef, opts?: import("../index.js").Options): {};
8
8
  /**
9
9
  *
10
10
  * @param {string} image
11
11
  * @param {import("../index.js").Options} [opts={}] - optional various options to pass along the application
12
12
  * @returns {ImageRef}
13
13
  */
14
- export function parseImageRef(image: string, opts?: import("../index.js").Options | undefined): ImageRef;
14
+ export function parseImageRef(image: string, opts?: import("../index.js").Options): ImageRef;
15
15
  /**
16
16
  * Gets the platform information for an image
17
17
  * @param {import("../index.js").Options} [opts={}] - optional various options to pass along the application
18
18
  * @returns {Platform|null} - The platform information or null
19
19
  */
20
- export function getImagePlatform(opts?: import("../index.js").Options | undefined): Platform | null;
20
+ export function getImagePlatform(opts?: import("../index.js").Options): Platform | null;
21
21
  /**
22
22
  * Gets the digests for an image
23
23
  * @param {import('./images').ImageRef} imageRef - The image reference
@@ -25,7 +25,7 @@ export function getImagePlatform(opts?: import("../index.js").Options | undefine
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 | undefined): {
28
+ export function getImageDigests(imageRef: import("./images").ImageRef, opts?: import("../index.js").Options): {
29
29
  [x: string]: string;
30
30
  };
31
31
  export type SyftImageSource = {
@@ -1,3 +1,11 @@
1
+ /**
2
+ * Match a provider by manifest type only (no lock file check). Used for license reading.
3
+ * @param {string} manifestPath - path or name of the manifest
4
+ * @param {[Provider]} providers - list of providers to iterate over
5
+ * @returns {Provider}
6
+ * @throws {Error} when the manifest is not supported and no provider was matched
7
+ */
8
+ export function matchForLicense(manifestPath: string, providers: [Provider]): Provider;
1
9
  /**
2
10
  * Match a provider from a list or providers based on file type.
3
11
  * Each provider MUST export 'isSupported' taking a file name-type and returning true if supported.
@@ -5,12 +13,15 @@
5
13
  * Each provider MUST export 'provideStack' taking manifest path returning a {@link Provided}.
6
14
  * @param {string} manifest - the name-type or path of the manifest
7
15
  * @param {[Provider]} providers - list of providers to iterate over
16
+ * @param {{TRUSTIFY_DA_WORKSPACE_DIR?: string}} [opts={}] - optional; TRUSTIFY_DA_WORKSPACE_DIR overrides lock file location for workspaces
8
17
  * @returns {Provider}
9
18
  * @throws {Error} when the manifest is not supported and no provider was matched
10
19
  */
11
- export function match(manifest: string, providers: [Provider]): Provider;
20
+ export function match(manifest: string, providers: [Provider], opts?: {
21
+ TRUSTIFY_DA_WORKSPACE_DIR?: string;
22
+ }): Provider;
12
23
  /** @typedef {{ecosystem: string, contentType: string, content: string}} Provided */
13
- /** @typedef {{isSupported: function(string): boolean, validateLockFile: function(string): void, provideComponent: function(string, {}): Provided, provideStack: function(string, {}): Provided}} 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): string | null}} Provider */
14
25
  /**
15
26
  * MUST include all providers here.
16
27
  * @type {[Provider]}
@@ -23,7 +34,8 @@ export type Provided = {
23
34
  };
24
35
  export type Provider = {
25
36
  isSupported: (arg0: string) => boolean;
26
- validateLockFile: (arg0: string) => void;
27
- provideComponent: (arg0: string, arg1: {}) => Provided;
28
- provideStack: (arg0: string, arg1: {}) => Provided;
37
+ validateLockFile: (arg0: string, arg1: any) => void;
38
+ provideComponent: (arg0: string, arg1: {}) => Provided | Promise<Provided>;
39
+ provideStack: (arg0: string, arg1: {}) => Provided | Promise<Provided>;
40
+ readLicenseFromManifest: (arg0: string) => string | null;
29
41
  };
@@ -7,8 +7,11 @@ import Javascript_npm from './providers/javascript_npm.js';
7
7
  import Javascript_pnpm from './providers/javascript_pnpm.js';
8
8
  import Javascript_yarn from './providers/javascript_yarn.js';
9
9
  import pythonPipProvider from './providers/python_pip.js';
10
+ import Python_poetry from './providers/python_poetry.js';
11
+ import Python_uv from './providers/python_uv.js';
12
+ import rustCargoProvider from './providers/rust_cargo.js';
10
13
  /** @typedef {{ecosystem: string, contentType: string, content: string}} Provided */
11
- /** @typedef {{isSupported: function(string): boolean, validateLockFile: function(string): void, provideComponent: function(string, {}): Provided, provideStack: function(string, {}): Provided}} Provider */
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 */
12
15
  /**
13
16
  * MUST include all providers here.
14
17
  * @type {[Provider]}
@@ -17,12 +20,30 @@ export const availableProviders = [
17
20
  new Java_maven(),
18
21
  new Java_gradle_groovy(),
19
22
  new Java_gradle_kotlin(),
20
- new Javascript_npm(),
21
23
  new Javascript_pnpm(),
22
24
  new Javascript_yarn(),
25
+ new Javascript_npm(),
23
26
  golangGomodulesProvider,
24
- pythonPipProvider
27
+ pythonPipProvider,
28
+ new Python_poetry(),
29
+ new Python_uv(),
30
+ rustCargoProvider
25
31
  ];
32
+ /**
33
+ * Match a provider by manifest type only (no lock file check). Used for license reading.
34
+ * @param {string} manifestPath - path or name of the manifest
35
+ * @param {[Provider]} providers - list of providers to iterate over
36
+ * @returns {Provider}
37
+ * @throws {Error} when the manifest is not supported and no provider was matched
38
+ */
39
+ export function matchForLicense(manifestPath, providers) {
40
+ const base = path.parse(manifestPath).base;
41
+ const provider = providers.find(prov => prov.isSupported(base));
42
+ if (!provider) {
43
+ throw new Error(`${base} is not supported`);
44
+ }
45
+ return provider;
46
+ }
26
47
  /**
27
48
  * Match a provider from a list or providers based on file type.
28
49
  * Each provider MUST export 'isSupported' taking a file name-type and returning true if supported.
@@ -30,16 +51,17 @@ export const availableProviders = [
30
51
  * Each provider MUST export 'provideStack' taking manifest path returning a {@link Provided}.
31
52
  * @param {string} manifest - the name-type or path of the manifest
32
53
  * @param {[Provider]} providers - list of providers to iterate over
54
+ * @param {{TRUSTIFY_DA_WORKSPACE_DIR?: string}} [opts={}] - optional; TRUSTIFY_DA_WORKSPACE_DIR overrides lock file location for workspaces
33
55
  * @returns {Provider}
34
56
  * @throws {Error} when the manifest is not supported and no provider was matched
35
57
  */
36
- export function match(manifest, providers) {
58
+ export function match(manifest, providers, opts = {}) {
37
59
  const manifestPath = path.parse(manifest);
38
60
  const supported = providers.filter(prov => prov.isSupported(manifestPath.base));
39
61
  if (supported.length === 0) {
40
62
  throw new Error(`${manifestPath.base} is not supported`);
41
63
  }
42
- const provider = supported.find(prov => prov.validateLockFile(manifestPath.dir));
64
+ const provider = supported.find(prov => prov.validateLockFile(manifestPath.dir, opts));
43
65
  if (!provider) {
44
66
  throw new Error(`${manifestPath.base} requires a lock file. Use your preferred package manager to generate the lock file.`);
45
67
  }
@@ -1,6 +1,4 @@
1
- /// <reference types="node" />
2
- /// <reference types="packageurl-js/src/package-url.js" />
3
- export type ecosystem_maven = import('../provider').Provider;
1
+ export type ecosystem_maven = import("../provider").Provider;
4
2
  /** @typedef {import('../provider').Provider} */
5
3
  /** @typedef {import('../provider').Provided} Provided */
6
4
  /** @typedef {{name: string, version: string}} Package */
@@ -51,7 +49,7 @@ export default class Base_Java {
51
49
  * @param {import('child_process').ExecFileOptionsWithStringEncoding} [opts={}]
52
50
  * @protected
53
51
  */
54
- protected _invokeCommand(bin: any, args: any, opts?: import("child_process").ExecFileOptionsWithStringEncoding | undefined): string;
52
+ protected _invokeCommand(bin: any, args: any, opts?: import("child_process").ExecFileOptionsWithStringEncoding): string;
55
53
  /**
56
54
  *
57
55
  * @param {string} manifestPath
@@ -70,7 +68,7 @@ export default class Base_Java {
70
68
  normalizePath(thePath: any): string;
71
69
  #private;
72
70
  }
73
- export type Provided = import('../provider').Provided;
71
+ export type Provided = import("../provider").Provided;
74
72
  export type Package = {
75
73
  name: string;
76
74
  version: string;
@@ -1,5 +1,6 @@
1
- /** @typedef {import('../provider.js').Provider} Provider */
2
- /** @typedef {import('../provider.js').Provided} Provided */
1
+ export type purlType = import("../provider").Provider;
2
+ /** @typedef {import('../provider').Provider} */
3
+ /** @typedef {import('../provider').Provided} Provided */
3
4
  /**
4
5
  * The ecosystem identifier for JavaScript/npm packages
5
6
  * @type {string}
@@ -66,11 +67,26 @@ export default class Base_javascript {
66
67
  */
67
68
  isSupported(manifestName: string): boolean;
68
69
  /**
69
- * Checks if a required lock file exists in the same path as the manifest
70
+ * Walks up the directory tree from manifestDir looking for the lock file.
71
+ * Stops when the lock file is found, when a package.json with a "workspaces"
72
+ * field is encountered without a lock file (workspace root boundary), or
73
+ * when the filesystem root is reached.
74
+ *
75
+ * When TRUSTIFY_DA_WORKSPACE_DIR is set, checks only that directory (no walk-up).
76
+ *
77
+ * @param {string} manifestDir - The directory to start searching from
78
+ * @param {Object} [opts={}] - optional; may contain TRUSTIFY_DA_WORKSPACE_DIR
79
+ * @returns {string|null} The directory containing the lock file, or null
80
+ * @protected
81
+ */
82
+ protected _isWorkspaceRoot(dir: any): string | null;
83
+ _findLockFileDir(manifestDir: any, opts?: {}): string | null;
84
+ /**
70
85
  * @param {string} manifestDir - The base directory where the manifest is located
86
+ * @param {Object} [opts={}] - optional; may contain TRUSTIFY_DA_WORKSPACE_DIR
71
87
  * @returns {boolean} True if the lock file exists
72
88
  */
73
- validateLockFile(manifestDir: string): boolean;
89
+ validateLockFile(manifestDir: string, opts?: any): boolean;
74
90
  /**
75
91
  * Provides content and content type for stack analysis
76
92
  * @param {string} manifestPath - The manifest path or name
@@ -85,13 +101,20 @@ export default class Base_javascript {
85
101
  * @returns {Provided} The provided data for component analysis
86
102
  */
87
103
  provideComponent(manifestPath: string, opts?: any): Provided;
104
+ /**
105
+ * Read license from manifest (package.json). Reused by npm, pnpm, yarn.
106
+ * @param {string} manifestPath - path to package.json
107
+ * @returns {string|null}
108
+ */
109
+ readLicenseFromManifest(manifestPath: string): string | null;
88
110
  /**
89
111
  * Builds the dependency tree for the project
90
112
  * @param {boolean} includeTransitive - Whether to include transitive dependencies
113
+ * @param {Object} [opts={}] - Configuration options; when `TRUSTIFY_DA_WORKSPACE_DIR` is set, commands run from workspace root
91
114
  * @returns {Object} The dependency tree
92
115
  * @protected
93
116
  */
94
- protected _buildDependencyTree(includeTransitive: boolean): any;
117
+ protected _buildDependencyTree(includeTransitive: boolean, opts?: any): any;
95
118
  /**
96
119
  * Recursively builds the Sbom from the JSON that npm listing returns
97
120
  * @param {Sbom} sbom - The SBOM object to add dependencies to
@@ -121,7 +144,6 @@ export default class Base_javascript {
121
144
  protected _parseDepTreeOutput(output: string): string;
122
145
  #private;
123
146
  }
124
- export type Provider = import('../provider.js').Provider;
125
- export type Provided = import('../provider.js').Provided;
147
+ export type Provided = import("../provider").Provided;
126
148
  import Manifest from './manifest.js';
127
149
  import Sbom from '../sbom.js';