@trustify-da/trustify-da-javascript-client 0.3.0-ea.c9a9877 → 0.3.0-ea.d349baa

package/dist/package.json

@@ -45,13 +45,13 @@
     },
     "dependencies": {
         "@babel/core": "^7.23.2",
-        "@cyclonedx/cyclonedx-library": "~1.13.3",
+        "@cyclonedx/cyclonedx-library": "^6.13.0",
         "fast-toml": "^0.5.4",
-        "fast-xml-parser": "^4.5.3",
+        "fast-xml-parser": "^5.3.4",
         "help": "^3.0.2",
         "https-proxy-agent": "^7.0.6",
         "node-fetch": "^2.7.0",
-        "packageurl-js": "^1.0.2",
+        "packageurl-js": "~1.0.2",
         "yargs": "^17.7.2"
     },
     "devDependencies": {
@@ -60,14 +60,14 @@
         "@types/node": "^20.17.30",
         "@types/which": "^3.0.4",
         "babel-plugin-rewire": "^1.2.0",
-        "c8": "^8.0.0",
+        "c8": "^10.1.3",
         "chai": "^4.3.7",
         "eslint": "^8.42.0",
         "eslint-plugin-editorconfig": "^4.0.3",
         "eslint-plugin-import": "^2.29.1",
         "esmock": "^2.6.2",
         "mocha": "^10.2.0",
-        "msw": "^1.3.2",
+        "msw": "^2.12.7",
         "sinon": "^15.1.2",
         "sinon-chai": "^3.7.0",
         "typescript": "^5.1.3",

package/dist/src/analysis.d.ts

@@ -13,7 +13,7 @@ export default _default;
  * @param {import("index.js").Options} [opts={}] - optional various options to pass along the application
  * @returns {Promise<import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>}
  */
-declare function requestComponent(provider: import('./provider').Provider, manifest: string, url: string, opts?: import("index.js").Options | undefined): Promise<import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>;
+declare function requestComponent(provider: import("./provider").Provider, manifest: string, url: string, opts?: import("index.js").Options): Promise<import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport>;
 /**
  * Send a stack analysis request and get the report as 'text/html' or 'application/json'.
  * @param {import('./provider').Provider} provider - the provided data for constructing the request
@@ -23,7 +23,7 @@ declare function requestComponent(provider: import('./provider').Provider, manif
  * @param {import("index.js").Options} [opts={}] - optional various options to pass along the application
  * @returns {Promise<string|import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>}
  */
-declare function requestStack(provider: import('./provider').Provider, manifest: string, url: string, html?: boolean | undefined, opts?: import("index.js").Options | undefined): Promise<string | import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>;
+declare function requestStack(provider: import("./provider").Provider, manifest: string, url: string, html?: boolean, opts?: import("index.js").Options): Promise<string | import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport>;
 /**
  *
  * @param {Array<string>} imageRefs
@@ -31,8 +31,8 @@ declare function requestStack(provider: import('./provider').Provider, manifest:
  * @param {import("index.js").Options} [opts={}] - optional various options to pass along the application
  * @returns {Promise<string|Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>>}
  */
-declare function requestImages(imageRefs: Array<string>, url: string, html?: boolean, opts?: import("index.js").Options | undefined): Promise<string | {
-    [x: string]: import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport;
+declare function requestImages(imageRefs: Array<string>, url: string, html?: boolean, opts?: import("index.js").Options): Promise<string | {
+    [x: string]: import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport;
 }>;
 /**
  *
@@ -40,4 +40,4 @@ declare function requestImages(imageRefs: Array<string>, url: string, html?: boo
  * @param {import("index.js").Options} [opts={}] - optional various options to pass headers for t he validateToken Request
  * @return {Promise<number>} return the HTTP status Code of the response from the validate token request.
  */
-declare function validateToken(url: any, opts?: import("index.js").Options | undefined): Promise<number>;
+declare function validateToken(url: any, opts?: import("index.js").Options): Promise<number>;

package/dist/src/cyclone_dx_sbom.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="packageurl-js/src/package-url" />
 export default class CycloneDxSbom {
     sbomObject: any;
     rootComponent: any;

package/dist/src/index.d.ts

@@ -12,7 +12,7 @@
 export function selectTrustifyDABackend(opts?: {
     TRUSTIFY_DA_DEBUG?: string | undefined;
     TRUSTIFY_DA_BACKEND_URL?: string | undefined;
-} | undefined): string;
+}): string;
 export { parseImageRef } from "./oci_image/utils.js";
 export { ImageRef } from "./oci_image/images.js";
 declare namespace _default {
@@ -23,7 +23,6 @@ declare namespace _default {
 }
 export default _default;
 export type Options = {
-    [key: string]: string | undefined;
     TRUSTIFY_DA_DOCKER_PATH?: string | undefined;
     TRUSTIFY_DA_GO_MVS_LOGIC_ENABLED?: string | undefined;
     TRUSTIFY_DA_GO_PATH?: string | undefined;
@@ -52,6 +51,7 @@ export type Options = {
     RHDA_SOURCE?: string | undefined;
     RHDA_TOKEN?: string | undefined;
     RHDA_TELEMETRY_ID?: string | undefined;
+    [key: string]: string | undefined;
 };
 /**
  * Get component analysis report for a manifest content.
@@ -60,16 +60,68 @@ export type Options = {
  * @returns {Promise<import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>}
  * @throws {Error} if no matching provider, failed to get create content, or backend request failed
  */
-declare function componentAnalysis(manifest: string, opts?: Options | undefined): Promise<import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>;
+declare function componentAnalysis(manifest: string, opts?: Options): Promise<import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport>;
+/**
+ * @overload
+ * @param {string} manifest
+ * @param {true} html
+ * @param {Options} [opts={}]
+ * @returns {Promise<string>}
+ * @throws {Error}
+ */
 declare function stackAnalysis(manifest: string, html: true, opts?: Options | undefined): Promise<string>;
-declare function stackAnalysis(manifest: string, html: false, opts?: Options | undefined): Promise<import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>;
-declare function stackAnalysis(manifest: string, html?: boolean | undefined, opts?: Options | undefined): Promise<string | import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>;
+/**
+ * @overload
+ * @param {string} manifest
+ * @param {false} html
+ * @param {Options} [opts={}]
+ * @returns {Promise<import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>}
+ * @throws {Error}
+ */
+declare function stackAnalysis(manifest: string, html: false, opts?: Options | undefined): Promise<import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport>;
+/**
+ * Get stack analysis report for a manifest file.
+ * @overload
+ * @param {string} manifest - path for the manifest
+ * @param {boolean} [html=false] - true will return a html string, false will return AnalysisReport object.
+ * @param {Options} [opts={}] - optional various options to pass along the application
+ * @returns {Promise<string|import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>}
+ * @throws {Error} if manifest inaccessible, no matching provider, failed to get create content,
+ * 		or backend request failed
+ */
+declare function stackAnalysis(manifest: string, html?: boolean | undefined, opts?: Options | undefined): Promise<string | import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport>;
+/**
+ * @overload
+ * @param {Array<string>} imageRefs
+ * @param {true} html
+ * @param {Options} [opts={}]
+ * @returns {Promise<string>}
+ * @throws {Error}
+ */
 declare function imageAnalysis(imageRefs: Array<string>, html: true, opts?: Options | undefined): Promise<string>;
+/**
+ * @overload
+ * @param {Array<string>} imageRefs
+ * @param {false} html
+ * @param {Options} [opts={}]
+ * @returns {Promise<Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>>}
+ * @throws {Error}
+ */
 declare function imageAnalysis(imageRefs: Array<string>, html: false, opts?: Options | undefined): Promise<{
-    [x: string]: import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport;
+    [x: string]: import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport;
 }>;
+/**
+ * Get image analysis report for a set of OCI image references.
+ * @overload
+ * @param {Array<string>} imageRefs - OCI image references
+ * @param {boolean} [html=false] - true will return a html string, false will return AnalysisReport
+ * @param {Options} [opts={}] - optional various options to pass along the application
+ * @returns {Promise<string|Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>>}
+ * @throws {Error} if manifest inaccessible, no matching provider, failed to get create content,
+ * 		or backend request failed
+ */
 declare function imageAnalysis(imageRefs: Array<string>, html?: boolean | undefined, opts?: Options | undefined): Promise<string | {
-    [x: string]: import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport;
+    [x: string]: import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport;
 }>;
 /**
  * Validates the Exhort token.
@@ -77,4 +129,4 @@ declare function imageAnalysis(imageRefs: Array<string>, html?: boolean | undefi
  * @returns {Promise<object>} A promise that resolves with the validation result from the backend.
  * @throws {Error} if the backend request failed.
  */
-declare function validateToken(opts?: Options | undefined): Promise<object>;
+declare function validateToken(opts?: Options): Promise<object>;

package/dist/src/oci_image/images.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="packageurl-js/src/package-url.js" />
 /**
 * Helper class for parsing docker repository/image names:
 *
@@ -26,7 +25,7 @@ export class Image {
      * @param {string} fullName
      * @param {string} [givenTag]
      */
-    constructor(fullName: string, givenTag?: string | undefined);
+    constructor(fullName: string, givenTag?: string);
     repository: string;
     registry: string;
     tag: string;
@@ -46,12 +45,12 @@ export class Image {
     * @param {string} [optionalRegistry]
     * @returns {string}
     */
-    getNameWithoutTag(optionalRegistry?: string | undefined): string;
+    getNameWithoutTag(optionalRegistry?: string): string;
     /**
     * @param {string} [optionalRegistry]
     * @returns {string}
     */
-    getFullName(optionalRegistry?: string | undefined): string;
+    getFullName(optionalRegistry?: string): string;
     /**
     * @returns {string}
     */
@@ -79,7 +78,7 @@ export class ImageRef {
      * @param {string} [platform]
      * @param {import("index.js").Options} [opts={}]
      */
-    constructor(image: string, platform?: string | undefined, opts?: import("index.js").Options | undefined);
+    constructor(image: string, platform?: string, opts?: import("index.js").Options);
     /** @type {Image} */
     image: Image;
     /** @type {Platform} */

package/dist/src/oci_image/utils.d.ts

@@ -4,20 +4,20 @@
  * @param {import("../index.js").Options} [opts={}] - optional various options to pass along the application
  * @returns {{}}
  */
-export function generateImageSBOM(imageRef: import('./images').ImageRef, opts?: import("../index.js").Options | undefined): {};
+export function generateImageSBOM(imageRef: import("./images").ImageRef, opts?: import("../index.js").Options): {};
 /**
  *
  * @param {string} image
  * @param {import("../index.js").Options} [opts={}] - optional various options to pass along the application
  * @returns {ImageRef}
  */
-export function parseImageRef(image: string, opts?: import("../index.js").Options | undefined): ImageRef;
+export function parseImageRef(image: string, opts?: import("../index.js").Options): ImageRef;
 /**
  * Gets the platform information for an image
  * @param {import("../index.js").Options} [opts={}] - optional various options to pass along the application
  * @returns {Platform|null} - The platform information or null
  */
-export function getImagePlatform(opts?: import("../index.js").Options | undefined): Platform | null;
+export function getImagePlatform(opts?: import("../index.js").Options): Platform | null;
 /**
  * Gets the digests for an image
  * @param {import('./images').ImageRef} imageRef - The image reference
@@ -25,7 +25,7 @@ export function getImagePlatform(opts?: import("../index.js").Options | undefine
  * @returns {Object.<string, string>} - The image digests
  * @throws {Error} If the image info is invalid
  */
-export function getImageDigests(imageRef: import('./images').ImageRef, opts?: import("../index.js").Options | undefined): {
+export function getImageDigests(imageRef: import("./images").ImageRef, opts?: import("../index.js").Options): {
     [x: string]: string;
 };
 export type SyftImageSource = {

package/dist/src/providers/base_java.d.ts

@@ -1,6 +1,4 @@
-/// <reference types="node" />
-/// <reference types="packageurl-js/src/package-url.js" />
-export type ecosystem_maven = import('../provider').Provider;
+export type ecosystem_maven = import("../provider").Provider;
 /** @typedef {import('../provider').Provider} */
 /** @typedef {import('../provider').Provided} Provided */
 /** @typedef {{name: string, version: string}} Package */
@@ -51,7 +49,7 @@ export default class Base_Java {
      * @param {import('child_process').ExecFileOptionsWithStringEncoding} [opts={}]
      * @protected
      */
-    protected _invokeCommand(bin: any, args: any, opts?: import("child_process").ExecFileOptionsWithStringEncoding | undefined): string;
+    protected _invokeCommand(bin: any, args: any, opts?: import("child_process").ExecFileOptionsWithStringEncoding): string;
     /**
      *
      * @param {string} manifestPath
@@ -70,7 +68,7 @@ export default class Base_Java {
     normalizePath(thePath: any): string;
     #private;
 }
-export type Provided = import('../provider').Provided;
+export type Provided = import("../provider").Provided;
 export type Package = {
     name: string;
     version: string;

package/dist/src/providers/base_javascript.d.ts

@@ -121,7 +121,7 @@ export default class Base_javascript {
     protected _parseDepTreeOutput(output: string): string;
     #private;
 }
-export type Provider = import('../provider.js').Provider;
-export type Provided = import('../provider.js').Provided;
+export type Provider = import("../provider.js").Provider;
+export type Provided = import("../provider.js").Provided;
 import Manifest from './manifest.js';
 import Sbom from '../sbom.js';

package/dist/src/providers/golang_gomodules.d.ts

@@ -5,7 +5,7 @@ declare namespace _default {
     export { provideStack };
 }
 export default _default;
-export type Provided = import('../provider').Provided;
+export type Provided = import("../provider").Provided;
 export type Package = {
     name: string;
     version: string;
@@ -32,11 +32,11 @@ declare function validateLockFile(): boolean;
  * @param {{}} [opts={}] - optional various options to pass along the application
  * @returns {Provided}
  */
-declare function provideComponent(manifest: string, opts?: {} | undefined): Provided;
+declare function provideComponent(manifest: string, opts?: {}): Provided;
 /**
  * Provide content and content type for maven-maven stack analysis.
  * @param {string} manifest - the manifest path or name
  * @param {{}} [opts={}] - optional various options to pass along the application
  * @returns {Provided}
  */
-declare function provideStack(manifest: string, opts?: {} | undefined): Provided;
+declare function provideStack(manifest: string, opts?: {}): Provided;

package/dist/src/providers/java_gradle.d.ts

@@ -21,15 +21,15 @@ export default class Java_gradle extends Base_java {
      * @param {{}} [opts={}] - optional various options to pass along the application
      * @returns {Provided}
      */
-    provideStack(manifest: string, opts?: {} | undefined): Provided;
+    provideStack(manifest: string, opts?: {}): Provided;
     /**
      * Provide content and content type for maven-maven component analysis.
      * @param {string} manifest - path to pom.xml for component report
      * @param {{}} [opts={}] - optional various options to pass along the application
      * @returns {Provided}
      */
-    provideComponent(manifest: string, opts?: {} | undefined): Provided;
+    provideComponent(manifest: string, opts?: {}): Provided;
     #private;
 }
-export type Provided = import('../provider.js').Provided;
+export type Provided = import("../provider.js").Provided;
 import Base_java from "./base_java.js";

package/dist/src/providers/java_gradle_groovy.d.ts

@@ -3,5 +3,5 @@ export default class Java_gradle_groovy extends Java_gradle {
     _parseAliasForLibsNotation(alias: any): any;
     _extractDepToBeIgnored(dep: any): any;
 }
-export type Provided = import('../provider').Provided;
+export type Provided = import("../provider").Provided;
 import Java_gradle from './java_gradle.js';

package/dist/src/providers/java_gradle_kotlin.d.ts

@@ -7,5 +7,5 @@ export default class Java_gradle_kotlin extends Java_gradle {
     _parseAliasForLibsNotation(alias: any): any;
     _extractDepToBeIgnored(dep: any): string | null;
 }
-export type Provided = import('../provider').Provided;
+export type Provided = import("../provider").Provided;
 import Java_gradle from './java_gradle.js';

package/dist/src/providers/java_maven.d.ts

@@ -19,14 +19,14 @@ export default class Java_maven extends Base_java {
      * @param {{}} [opts={}] - optional various options to pass along the application
      * @returns {Provided}
      */
-    provideStack(manifest: string, opts?: {} | undefined): Provided;
+    provideStack(manifest: string, opts?: {}): Provided;
     /**
      * Provide content and content type for maven-maven component analysis.
      * @param {string} manifest - path to the manifest file
      * @param {{}} [opts={}] - optional various options to pass along the application
      * @returns {Provided}
      */
-    provideComponent(manifest: string, opts?: {} | undefined): Provided;
+    provideComponent(manifest: string, opts?: {}): Provided;
     /**
      *
      * @param {String} textGraphList Text graph String of the manifest
@@ -36,8 +36,8 @@ export default class Java_maven extends Base_java {
     createSbomFileFromTextFormat(textGraphList: string, ignoredDeps: [string], opts: any): string;
     #private;
 }
-export type Java_maven = import('../provider').Provider;
-export type Provided = import('../provider').Provided;
+export type Java_maven = import("../provider").Provider;
+export type Provided = import("../provider").Provided;
 export type Package = {
     name: string;
     version: string;

package/dist/src/providers/java_maven.js

@@ -209,7 +209,7 @@ export default class Java_maven extends Base_java {
         let ignored = [];
         // build xml parser with options
         let parser = new XMLParser({
-            commentPropName: '#comment',
+            commentPropName: '#comment', // mark comments with #comment
             isArray: (_, jpath) => 'project.dependencies.dependency' === jpath,
             parseTagValue: false
         });

package/dist/src/providers/python_pip.d.ts

@@ -25,11 +25,11 @@ declare function validateLockFile(): boolean;
  * @param {{}} [opts={}] - optional various options to pass along the application
  * @returns {Provided}
  */
-declare function provideComponent(manifest: string, opts?: {} | undefined): Provided;
+declare function provideComponent(manifest: string, opts?: {}): Provided;
 /**
  * Provide content and content type for python-pip stack analysis.
  * @param {string} manifest - the manifest path or name
  * @param {{}} [opts={}] - optional various options to pass along the application
  * @returns {Provided}
  */
-declare function provideStack(manifest: string, opts?: {} | undefined): Provided;
+declare function provideStack(manifest: string, opts?: {}): Provided;

package/dist/src/tools.d.ts

@@ -1,12 +1,10 @@
-/// <reference types="node" />
-/// <reference types="packageurl-js/src/package-url" />
 /**
  *
  * @param {string} key to log its value from environment variables and from opts, if it exists
  * @param {{}} [opts={}] different options of application, if key in it, log it.
  * @param {string }defValue default value of key in case there is no option and environment variable values for key
  */
-export function logValueFromObjects(key: string, opts?: {} | undefined, defValue: string): void;
+export function logValueFromObjects(key: string, opts?: {}, defValue: string): void;
 /**
  * Utility function will return the value for key from the environment variables,
  * if not present will return the value for key from the opts objects only if it's a string,
@@ -17,7 +15,7 @@ export function logValueFromObjects(key: string, opts?: {} | undefined, defValue
  * @returns {string|null} the value of the key found in the environment, options object, or the
  * 		default supplied
  */
-export function getCustom(key: string, def?: string | null | undefined, opts?: {} | undefined): string | null;
+export function getCustom(key: string, def?: string | null, opts?: {}): string | null;
 /**
  * Utility function for looking up custom variable for a binary path.
  * Will look in the environment variables (1) or in opts (2) for a key with TRUSTIFY_DA_x_PATH, x is an
@@ -28,7 +26,7 @@ export function getCustom(key: string, def?: string | null | undefined, opts?: {
  * @returns {string|null} the value of the key found in the environment, options object, or the
  * 		original name supplied
  */
-export function getCustomPath(name: any, opts?: {} | undefined): string | null;
+export function getCustomPath(name: any, opts?: {}): string | null;
 /**
  * Utility function for determining whether wrappers for build tools such as gradlew/mvnw should be
  * preferred over invoking the binary directly.
@@ -69,6 +67,6 @@ export function getGitRootDir(cwd: string): string | undefined;
  * @param {import('child_process').ExecFileOptionsWithStringEncoding} [opts={}]
  * @returns {string}
  */
-export function invokeCommand(bin: string, args: Array<string>, opts?: import("child_process").ExecFileOptionsWithStringEncoding | undefined): string;
+export function invokeCommand(bin: string, args: Array<string>, opts?: import("child_process").ExecFileOptionsWithStringEncoding): string;
 export const RegexNotToBeLogged: RegExp;
 import { PackageURL } from "packageurl-js";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@trustify-da/trustify-da-javascript-client",
-	"version": "0.3.0-ea.c9a9877",
+	"version": "0.3.0-ea.d349baa",
 	"description": "Code-Ready Dependency Analytics JavaScript API.",
 	"license": "Apache-2.0",
 	"homepage": "https://github.com/guacsec/trustify-da-javascript-client#README.md",
@@ -45,13 +45,13 @@
 	},
 	"dependencies": {
 		"@babel/core": "^7.23.2",
-		"@cyclonedx/cyclonedx-library": "~1.13.3",
+		"@cyclonedx/cyclonedx-library": "^6.13.0",
 		"fast-toml": "^0.5.4",
-		"fast-xml-parser": "^4.5.3",
+		"fast-xml-parser": "^5.3.4",
 		"help": "^3.0.2",
 		"https-proxy-agent": "^7.0.6",
 		"node-fetch": "^2.7.0",
-		"packageurl-js": "^1.0.2",
+		"packageurl-js": "~1.0.2",
 		"yargs": "^17.7.2"
 	},
 	"devDependencies": {
@@ -60,14 +60,14 @@
 		"@types/node": "^20.17.30",
 		"@types/which": "^3.0.4",
 		"babel-plugin-rewire": "^1.2.0",
-		"c8": "^8.0.0",
+		"c8": "^10.1.3",
 		"chai": "^4.3.7",
 		"eslint": "^8.42.0",
 		"eslint-plugin-editorconfig": "^4.0.3",
 		"eslint-plugin-import": "^2.29.1",
 		"esmock": "^2.6.2",
 		"mocha": "^10.2.0",
-		"msw": "^1.3.2",
+		"msw": "^2.12.7",
 		"sinon": "^15.1.2",
 		"sinon-chai": "^3.7.0",
 		"typescript": "^5.1.3",