@trustify-da/trustify-da-javascript-client 0.2.4-ea.13

package/dist/src/cyclone_dx_sbom.js

@@ -0,0 +1,244 @@
+import { EOL } from "os";
+import { PackageURL } from "packageurl-js";
+/**
+ *
+ * @param component {PackageURL}
+ * @param type type of package - application or library
+ * @param scope scope of the component - runtime or compile
+ * @return {{"bom-ref": string, name, purl: string, type, version, scope}}
+ * @private
+ */
+function getComponent(component, type, scope) {
+    let componentObject;
+    if (component instanceof PackageURL) {
+        if (component.namespace) {
+            componentObject = {
+                "group": component.namespace,
+                "name": component.name,
+                "version": component.version,
+                "purl": component.toString(),
+                "type": type,
+                "bom-ref": component.toString(),
+                "scope": scope
+            };
+        }
+        else {
+            componentObject = {
+                "name": component.name,
+                "version": component.version,
+                "purl": component.toString(),
+                "type": type,
+                "bom-ref": component.toString(),
+                "scope": scope
+            };
+        }
+    }
+    else {
+        componentObject = component;
+    }
+    return componentObject;
+}
+function createDependency(dependency) {
+    return {
+        "ref": dependency,
+        "dependsOn": new Array()
+    };
+}
+export default class CycloneDxSbom {
+    sbomObject;
+    rootComponent;
+    components;
+    dependencies;
+    sourceManifestForAuditTrail;
+    constructor() {
+        this.dependencies = new Array();
+        this.components = new Array();
+    }
+    /**
+     * @param {PackageURL} root - add main/root component for sbom
+     * @return {CycloneDxSbom} the CycloneDxSbom Sbom Object
+     */
+    addRoot(root) {
+        this.rootComponent =
+            getComponent(root, "application");
+        this.components.push(this.rootComponent);
+        return this;
+    }
+    /**
+     * @return {{{"bom-ref": string, name, purl: string, type, version}}} root component of sbom.
+     */
+    getRoot() {
+        return this.rootComponent;
+    }
+    /**
+     * Adds a dependency relationship between two components in the SBOM
+     * @param {PackageURL} sourceRef - The source component (parent)
+     * @param {PackageURL} targetRef - The target component (dependency)
+     * @return {CycloneDxSbom} The updated SBOM
+     */
+    addDependency(sourceRef, targetRef, scope) {
+        const sourcePurl = sourceRef.toString();
+        const targetPurl = targetRef.toString();
+        // Ensure both components exist in the components list
+        [sourceRef, targetRef].forEach((ref, index) => {
+            const purl = index === 0 ? sourcePurl : targetPurl;
+            if (this.getComponentIndex(purl) < 0) {
+                this.components.push(getComponent(ref, "library", scope));
+            }
+        });
+        // Ensure source dependency exists
+        let sourceDepIndex = this.getDependencyIndex(sourcePurl);
+        if (sourceDepIndex < 0) {
+            this.dependencies.push(createDependency(sourcePurl));
+            sourceDepIndex = this.dependencies.length - 1;
+        }
+        // Add target to source's dependencies if not already present
+        if (!this.dependencies[sourceDepIndex].dependsOn.includes(targetPurl)) {
+            this.dependencies[sourceDepIndex].dependsOn.push(targetPurl);
+        }
+        // Ensure target dependency exists
+        if (this.getDependencyIndex(targetPurl) < 0) {
+            this.dependencies.push(createDependency(targetPurl));
+        }
+        return this;
+    }
+    /** @param {{}} opts - various options, settings and configuration of application.
+     * @return String CycloneDx Sbom json object in a string format
+     */
+    getAsJsonString(opts) {
+        let manifestType = opts["manifest-type"];
+        this.setSourceManifest(opts["source-manifest"]);
+        this.sbomObject = {
+            "bomFormat": "CycloneDX",
+            "specVersion": "1.4",
+            "version": 1,
+            "metadata": {
+                "timestamp": new Date(),
+                "component": this.rootComponent,
+                "properties": new Array()
+            },
+            "components": this.components,
+            "dependencies": this.dependencies
+        };
+        if (this.rootComponent === undefined) {
+            delete this.sbomObject.metadata.component;
+        }
+        if (this.sourceManifestForAuditTrail !== undefined && manifestType !== undefined) {
+            this.sbomObject.metadata.properties.push({ "name": "rhda:manifest:content", "value": this.sourceManifestForAuditTrail });
+            this.sbomObject.metadata.properties.push({ "name": "rhda:manifest:filename", "value": manifestType });
+        }
+        else {
+            delete this.sbomObject.metadata.properties;
+        }
+        if (process.env["TRUSTIFY_DA_DEBUG"] === "true") {
+            console.log("SBOM Generated for manifest, to be sent to exhort service:" + EOL + JSON.stringify(this.sbomObject, null, 4));
+        }
+        return JSON.stringify(this.sbomObject);
+    }
+    /**
+     *
+     * @param {String} dependency - purl string of the component.
+     * @return {int} - the index of the dependency in dependencies Array, returns -1 if not found.
+     */
+    getDependencyIndex(dependency) {
+        return this.dependencies.findIndex(dep => dep.ref === dependency);
+    }
+    /**
+     *
+     * @param {component} theComponent - Component Object with purl field.
+     * @return {int} index of the found component entry, if not found returns -1.
+     * @private
+     */
+    getComponentIndex(theComponent) {
+        return this.components.findIndex(component => component.purl === theComponent);
+    }
+    /** This method gets a PackageUrl, and returns a Component of CycloneDx Sbom
+     * @param purl {PackageURL}
+     * @return component
+     */
+    purlToComponent(purl) {
+        return getComponent(purl, "library");
+    }
+    /**
+     * This method gets an array of dependencies to be ignored, and remove all of them from CycloneDx Sbom
+     * @param {Array[PackageURL]} dependencies to be removed from sbom
+     * @return {CycloneDxSbom} without ignored dependencies
+     */
+    filterIgnoredDeps(deps) {
+        deps.forEach(dep => {
+            let index = this.components.findIndex(component => component.name === dep.name && component.group === dep.namespace);
+            if (index === -1) {
+                return;
+            }
+            const depPurl = this.components[index].purl;
+            this.components.splice(index, 1);
+            index = this.dependencies.findIndex(dependency => dependency.ref.includes(dep));
+            if (index === -1) {
+                return;
+            }
+            this.dependencies.splice(index, 1);
+            this.dependencies.forEach(dependency => {
+                let indexDependsOn = dependency.dependsOn.findIndex(theDep => theDep.includes(depPurl));
+                if (indexDependsOn > -1) {
+                    dependency.dependsOn.splice(indexDependsOn, 1);
+                }
+            });
+        });
+        return this;
+    }
+    /**
+     * This method gets an array of dependencies with versions( purl string format) to be ignored, and remove all of them from CycloneDx Sbom
+     * @param {Array} dependencies to be removed from sbom
+     * @return {CycloneDxSbom} without ignored dependencies
+     */
+    filterIgnoredDepsIncludingVersion(deps) {
+        deps.forEach(dep => {
+            let index = this.components.findIndex(component => component.purl === dep);
+            if (index >= 0) {
+                this.components.splice(index, 1);
+            }
+            index = this.dependencies.findIndex(dependency => dependency.ref === dep);
+            if (index >= 0) {
+                this.dependencies.splice(index, 1);
+            }
+            this.dependencies.forEach(dependency => {
+                let indexDependsOn = dependency.dependsOn.findIndex(theDep => theDep === dep);
+                if (indexDependsOn > -1) {
+                    dependency.dependsOn.splice(indexDependsOn, 1);
+                }
+            });
+        });
+        return this;
+    }
+    /** This method gets a component object, and a string name, and checks if the name is a substring of the component' purl.
+     * @param {} component to search in its dependencies
+     * @param {String} name to be checked.
+     *
+     * @return {boolean}
+     */
+    checkIfPackageInsideDependsOnList(component, name) {
+        let dependencyIndex = this.getDependencyIndex(component.purl);
+        if (dependencyIndex < 0) {
+            return false;
+        }
+        //Only if the dependency doesn't exists on the dependency list of dependency, then add it to this list.
+        if (this.dependencies[dependencyIndex].dependsOn.findIndex(dep => dep.includes(name)) >= 0) {
+            return true;
+        }
+        else {
+            return false;
+        }
+    }
+    /** Removes the root component from the sbom
+     */
+    removeRootComponent() {
+        let compIndex = this.getComponentIndex(this.rootComponent);
+        let depIndex = this.getDependencyIndex(this.rootComponent.purl);
+        this.components.splice(compIndex, 1);
+        this.dependencies.splice(depIndex, 1);
+        this.rootComponent = undefined;
+    }
+    setSourceManifest(manifestData) {
+        this.sourceManifestForAuditTrail = manifestData;
+    }
+}

package/dist/src/index.d.ts

@@ -0,0 +1,82 @@
+/**
+ * This function is used to determine exhort theUrl backend according to the following logic:
+ * If TRUSTIFY_DA_DEV_MODE = true, then take the value of the EXHORT BACKEND URL of dev/staging environment in such a way:
+ * take it as environment variable if exists, otherwise, take it from opts object if exists, otherwise, use the hardcoded default of DEV environment.
+ * If TRUSTIFY_DA_DEV_MODE = false , then select the production theUrl of EXHORT Backend, which is hardcoded.
+ * TRUSTIFY_DA_DEV_MODE evaluated in the following order and selected when it finds it first:
+ * 1. Environment Variable
+ * 2. (key,value) from opts object
+ * 3. Default False ( points to production URL )
+ * @param {{TRUSTIFY_DA_DEBUG?: string | undefined; TRUSTIFY_DA_BACKEND_URL?: string | undefined}} [opts={}]
+ * @return {string} - The selected exhort backend
+ * @private
+ */
+export function selectExhortBackend(opts?: {
+    TRUSTIFY_DA_DEBUG?: string | undefined;
+    TRUSTIFY_DA_BACKEND_URL?: string | undefined;
+} | undefined): string;
+export { parseImageRef } from "./oci_image/utils.js";
+export { ImageRef } from "./oci_image/images.js";
+declare namespace _default {
+    export { componentAnalysis };
+    export { stackAnalysis };
+    export { imageAnalysis };
+    export { validateToken };
+}
+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;
+    TRUSTIFY_DA_GRADLE_PATH?: string | undefined;
+    TRUSTIFY_DA_IMAGE_PLATFORM?: string | undefined;
+    TRUSTIFY_DA_MVN_PATH?: string | undefined;
+    TRUSTIFY_DA_PIP_PATH?: string | undefined;
+    TRUSTIFY_DA_PIP_USE_DEP_TREE?: string | undefined;
+    TRUSTIFY_DA_PIP3_PATH?: string | undefined;
+    TRUSTIFY_DA_PNPM_PATH?: string | undefined;
+    TRUSTIFY_DA_PODMAN_PATH?: string | undefined;
+    TRUSTIFY_DA_PREFER_GRADLEW?: string | undefined;
+    TRUSTIFY_DA_PREFER_MVNW?: string | undefined;
+    TRUSTIFY_DA_PROXY_URL?: string | undefined;
+    TRUSTIFY_DA_PYTHON_INSTALL_BEST_EFFORTS?: string | undefined;
+    TRUSTIFY_DA_PYTHON_PATH?: string | undefined;
+    TRUSTIFY_DA_PYTHON_VIRTUAL_ENV?: string | undefined;
+    TRUSTIFY_DA_PYTHON3_PATH?: string | undefined;
+    TRUSTIFY_DA_RECOMMENDATIONS_ENABLED?: string | undefined;
+    TRUSTIFY_DA_SKOPEO_CONFIG_PATH?: string | undefined;
+    TRUSTIFY_DA_SKOPEO_PATH?: string | undefined;
+    TRUSTIFY_DA_SYFT_CONFIG_PATH?: string | undefined;
+    TRUSTIFY_DA_SYFT_PATH?: string | undefined;
+    TRUSTIFY_DA_YARN_PATH?: string | undefined;
+    MATCH_MANIFEST_VERSIONS?: string | undefined;
+    RHDA_SOURCE?: string | undefined;
+    RHDA_TOKEN?: string | undefined;
+    RHDA_TELEMETRY_ID?: string | undefined;
+};
+/**
+ * Get component analysis report for a manifest content.
+ * @param {string} manifest - path to the manifest
+ * @param {Options} [opts={}] - optional various options to pass along the application
+ * @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 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>;
+declare function imageAnalysis(imageRefs: Array<string>, html: true, opts?: Options | undefined): Promise<string>;
+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;
+}>;
+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;
+}>;
+/**
+ * Validates the Exhort token.
+ * @param {Options} [opts={}] - Optional parameters, potentially including token override.
+ * @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>;

package/dist/src/index.js

@@ -0,0 +1,194 @@
+import path from "node:path";
+import { EOL } from "os";
+import { availableProviders, match } from './provider.js';
+import analysis from './analysis.js';
+import fs from 'node:fs';
+import { getCustom } from "./tools.js";
+import.meta.dirname;
+import * as url from 'url';
+export { parseImageRef } from "./oci_image/utils.js";
+export { ImageRef } from "./oci_image/images.js";
+export default { componentAnalysis, stackAnalysis, imageAnalysis, validateToken };
+/**
+ * @typedef {{
+ * TRUSTIFY_DA_DOCKER_PATH?: string | undefined,
+ * TRUSTIFY_DA_GO_MVS_LOGIC_ENABLED?: string | undefined,
+ * TRUSTIFY_DA_GO_PATH?: string | undefined,
+ * TRUSTIFY_DA_GRADLE_PATH?: string | undefined,
+ * TRUSTIFY_DA_IMAGE_PLATFORM?: string | undefined,
+ * TRUSTIFY_DA_MVN_PATH?: string | undefined,
+ * TRUSTIFY_DA_PIP_PATH?: string | undefined,
+ * TRUSTIFY_DA_PIP_USE_DEP_TREE?: string | undefined,
+ * TRUSTIFY_DA_PIP3_PATH?: string | undefined,
+ * TRUSTIFY_DA_PNPM_PATH?: string | undefined,
+ * TRUSTIFY_DA_PODMAN_PATH?: string | undefined,
+ * TRUSTIFY_DA_PREFER_GRADLEW?: string | undefined,
+ * TRUSTIFY_DA_PREFER_MVNW?: string | undefined,
+ * TRUSTIFY_DA_PROXY_URL?: string | undefined,
+ * TRUSTIFY_DA_PYTHON_INSTALL_BEST_EFFORTS?: string | undefined,
+ * TRUSTIFY_DA_PYTHON_PATH?: string | undefined,
+ * TRUSTIFY_DA_PYTHON_VIRTUAL_ENV?: string | undefined,
+ * TRUSTIFY_DA_PYTHON3_PATH?: string | undefined,
+ * TRUSTIFY_DA_RECOMMENDATIONS_ENABLED?: string | undefined,
+ * TRUSTIFY_DA_SKOPEO_CONFIG_PATH?: string | undefined,
+ * TRUSTIFY_DA_SKOPEO_PATH?: string | undefined,
+ * TRUSTIFY_DA_SYFT_CONFIG_PATH?: string | undefined,
+ * TRUSTIFY_DA_SYFT_PATH?: string | undefined,
+ * TRUSTIFY_DA_YARN_PATH?: string | undefined,
+ * MATCH_MANIFEST_VERSIONS?: string | undefined,
+ * RHDA_SOURCE?: string | undefined,
+ * RHDA_TOKEN?: string | undefined,
+ * RHDA_TELEMETRY_ID?: string | undefined,
+ * [key: string]: string | undefined,
+ * }} Options
+ */
+/**
+ * Logs messages to the console if the TRUSTIFY_DA_DEBUG environment variable is set to "true".
+ * @param {string} alongsideText - The text to prepend to the log message.
+ * @param {any} valueToBePrinted - The value to log.
+ * @private
+ */
+function logOptionsAndEnvironmentsVariables(alongsideText, valueToBePrinted) {
+    if (process.env["TRUSTIFY_DA_DEBUG"] === "true") {
+        console.log(`${alongsideText}: ${valueToBePrinted} ${EOL}`);
+    }
+}
+/**
+ * Reads the version from the package.json file and logs it if debug mode is enabled.
+ * @private
+ */
+function readAndPrintVersionFromPackageJson() {
+    let dirName;
+    // new ESM way in nodeJS ( since node version 22 ) to bring module directory.
+    dirName = import.meta.dirname;
+    // old ESM way in nodeJS ( before node versions 22.00 to bring module directory)
+    if (!dirName) {
+        dirName = url.fileURLToPath(new URL('.', import.meta.url));
+    }
+    try {
+        if (__dirname) {
+            dirName = __dirname;
+        }
+    }
+    catch (e) {
+        console.log("__dirname is not defined, continue with fileUrlPath");
+    }
+    let packageJson = JSON.parse(fs.readFileSync(path.join(dirName, "..", "package.json")).toString());
+    logOptionsAndEnvironmentsVariables("trustify-da-javascript-client analysis started, version: ", packageJson.version);
+}
+/**
+ * This function is used to determine exhort theUrl backend according to the following logic:
+ * If TRUSTIFY_DA_DEV_MODE = true, then take the value of the EXHORT BACKEND URL of dev/staging environment in such a way:
+ * take it as environment variable if exists, otherwise, take it from opts object if exists, otherwise, use the hardcoded default of DEV environment.
+ * If TRUSTIFY_DA_DEV_MODE = false , then select the production theUrl of EXHORT Backend, which is hardcoded.
+ * TRUSTIFY_DA_DEV_MODE evaluated in the following order and selected when it finds it first:
+ * 1. Environment Variable
+ * 2. (key,value) from opts object
+ * 3. Default False ( points to production URL )
+ * @param {{TRUSTIFY_DA_DEBUG?: string | undefined; TRUSTIFY_DA_BACKEND_URL?: string | undefined}} [opts={}]
+ * @return {string} - The selected exhort backend
+ * @private
+ */
+export function selectExhortBackend(opts = {}) {
+    if (getCustom("TRUSTIFY_DA_DEBUG", "false", opts) === "true") {
+        readAndPrintVersionFromPackageJson();
+    }
+    let url;
+    if (getCustom('TRUSTIFY_DA_DEV_MODE', 'false', opts) === 'true') {
+        url = getCustom('DEV_TRUSTIFY_DA_BACKEND_URL', undefined, opts);
+    }
+    else {
+        url = getCustom('TRUSTIFY_DA_BACKEND_URL', undefined, opts);
+    }
+    if (!url) {
+        throw new Error(`TRUSTIFY_DA_BACKEND_URL is unset`);
+    }
+    logOptionsAndEnvironmentsVariables("Chosen exhort backend URL:", url);
+    return url;
+}
+/**
+ * @overload
+ * @param {string} manifest
+ * @param {true} html
+ * @param {Options} [opts={}]
+ * @returns {Promise<string>}
+ * @throws {Error}
+ */
+/**
+ * @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}
+ */
+/**
+ * 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
+ */
+async function stackAnalysis(manifest, html = false, opts = {}) {
+    const theUrl = selectExhortBackend(opts);
+    fs.accessSync(manifest, fs.constants.R_OK); // throws error if file unreadable
+    let provider = match(manifest, availableProviders); // throws error if no matching provider
+    return await analysis.requestStack(provider, manifest, theUrl, html, opts); // throws error request sending failed
+}
+/**
+ * Get component analysis report for a manifest content.
+ * @param {string} manifest - path to the manifest
+ * @param {Options} [opts={}] - optional various options to pass along the application
+ * @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
+ */
+async function componentAnalysis(manifest, opts = {}) {
+    const theUrl = selectExhortBackend(opts);
+    fs.accessSync(manifest, fs.constants.R_OK);
+    opts["manifest-type"] = path.basename(manifest);
+    let provider = match(manifest, availableProviders); // throws error if no matching provider
+    return await analysis.requestComponent(provider, manifest, theUrl, opts); // throws error request sending failed
+}
+/**
+ * @overload
+ * @param {Array<string>} imageRefs
+ * @param {true} html
+ * @param {Options} [opts={}]
+ * @returns {Promise<string>}
+ * @throws {Error}
+ */
+/**
+ * @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}
+ */
+/**
+ * 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
+ */
+async function imageAnalysis(imageRefs, html = false, opts = {}) {
+    const theUrl = selectExhortBackend(opts);
+    return await analysis.requestImages(imageRefs, theUrl, html, opts);
+}
+/**
+ * Validates the Exhort token.
+ * @param {Options} [opts={}] - Optional parameters, potentially including token override.
+ * @returns {Promise<object>} A promise that resolves with the validation result from the backend.
+ * @throws {Error} if the backend request failed.
+ */
+async function validateToken(opts = {}) {
+    const theUrl = selectExhortBackend(opts);
+    return await analysis.validateToken(theUrl, opts); // throws error request sending failed
+}

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

@@ -0,0 +1,99 @@
+/// <reference types="packageurl-js/src/package-url.js" />
+/**
+* Helper class for parsing docker repository/image names:
+*
+* - If the first part before the slash contains a "." or a ":" it is considered to be a registry URL
+* - A last part starting with a ":" is considered to be a tag
+* - The rest is considered the repository name (which might be separated via slashes)
+*
+* Example of valid names:
+*
+* - consol/tomcat-8.0
+* - consol/tomcat-8.0:8.0.9
+* - docker.consol.de:5000/tomcat-8.0
+* - docker.consol.de:5000/jolokia/tomcat-8.0:8.0.9
+*/
+export class Image {
+    static NAME_COMPONENT_REGEXP: string;
+    static DOMAIN_COMPONENT_REGEXP: string;
+    static NAME_COMP_REGEXP: RegExp;
+    static IMAGE_NAME_REGEXP: RegExp;
+    static DOMAIN_REGEXP: RegExp;
+    static TAG_REGEXP: RegExp;
+    static DIGEST_REGEXP: RegExp;
+    /**
+     *
+     * @param {string} fullName
+     * @param {string} [givenTag]
+     */
+    constructor(fullName: string, givenTag?: string | undefined);
+    repository: string;
+    registry: string;
+    tag: string;
+    digest: string | null;
+    user: string;
+    /**
+    * @param {string[]} parts
+    * @returns {string}
+    */
+    joinTail(parts: string[]): string;
+    /**
+    * @param {string} part
+    * @returns {boolean}
+    */
+    isRegistry(part: string): boolean;
+    /**
+    * @param {string} [optionalRegistry]
+    * @returns {string}
+    */
+    getNameWithoutTag(optionalRegistry?: string | undefined): string;
+    /**
+    * @param {string} [optionalRegistry]
+    * @returns {string}
+    */
+    getFullName(optionalRegistry?: string | undefined): string;
+    /**
+    * @returns {string}
+    */
+    getSimpleName(): string;
+    /**
+    * @param {string} optionalRepository
+    * @returns {string}
+    */
+    getNameWithOptionalRepository(optionalRepository: string): string;
+    doValidate(): void;
+    /**
+    * @param {string} rest
+    */
+    parseComponentsBeforeTag(rest: string): void;
+}
+export class ImageRef {
+    static OCI_TYPE: string;
+    static REPOSITORY_QUALIFIER: string;
+    static TAG_QUALIFIER: string;
+    static ARCH_QUALIFIER: string;
+    static OS_QUALIFIER: string;
+    static VARIANT_QUALIFIER: string;
+    /**
+     * @param {string} image
+     * @param {string} [platform]
+     * @param {import("index.js").Options} [opts={}]
+     */
+    constructor(image: string, platform?: string | undefined, opts?: import("index.js").Options | undefined);
+    /** @type {Image} */
+    image: Image;
+    /** @type {Platform} */
+    platform: Platform;
+    /**
+     * @private
+     */
+    private checkImageDigest;
+    /**
+     * @returns {PackageURL}
+     * @throws {Error}
+     * @see https://github.com/package-url/purl-spec/blob/master/PURL-TYPES.rst#oci
+     */
+    getPackageURL(): PackageURL;
+}
+import { Platform } from "./platform.js";
+import { PackageURL } from "packageurl-js";