@cyclonedx/cdxgen/types/lib/helpers/provenanceUtils.d.ts

Creates CycloneDX Software Bill of Materials (SBOM) from source or container image

export declare const NPM_PROVENANCE_EVIDENCE_PROPERTIES: string[];
export declare const PYPI_PROVENANCE_EVIDENCE_PROPERTIES: string[];
export declare const CARGO_PROVENANCE_EVIDENCE_PROPERTIES: string[];
export declare const REGISTRY_PROVENANCE_EVIDENCE_PROPERTIES: string[];
export declare const TRUSTED_PUBLISHING_PROPERTIES: string[];
export declare const REGISTRY_PROVENANCE_ICON = "\uD83D\uDEE1";
/**
 * Return a component property value by name.
 *
 * @param {object} component CycloneDX component
 * @param {string} propertyName Property name to look up
 * @returns {string | undefined} Property value if present
 */
export declare function getComponentPropertyValue(component: object, propertyName: string): string | undefined;
/**
 * Return a property value by name from a raw properties array.
 *
 * @param {object[]} properties CycloneDX properties array
 * @param {string} propertyName Property name to look up
 * @returns {string | undefined} Property value if present
 */
export declare function getPropertyValue(properties: object[], propertyName: string): string | undefined;
/**
 * Check whether any of the supplied properties exist and carry a value.
 *
 * @param {object[]} properties CycloneDX properties array
 * @param {string[]} propertyNames Property names to test
 * @returns {boolean} True when any named property has a non-empty value
 */
export declare function hasAnyPropertyValue(properties: object[], propertyNames: string[]): boolean;
/**
 * Determine whether a raw properties array includes trusted publishing metadata.
 *
 * @param {object[]} properties CycloneDX properties array
 * @returns {boolean} True when trusted publishing is recorded for npm, PyPI, or Cargo
 */
export declare function hasTrustedPublishingProperties(properties: object[]): boolean;
/**
 * Determine whether a raw properties array includes direct registry provenance evidence.
 *
 * @param {object[]} properties CycloneDX properties array
 * @returns {boolean} True when direct provenance evidence is present
 */
export declare function hasRegistryProvenanceEvidenceProperties(properties: object[]): boolean;
/**
 * Determine whether a component includes trusted publishing metadata.
 *
 * @param {object} component CycloneDX component
 * @returns {boolean} True when trusted publishing is recorded for npm, PyPI, or Cargo
 */
export declare function hasComponentTrustedPublishing(component: object): boolean;
/**
 * Determine whether a component includes direct registry provenance evidence.
 *
 * @param {object} component CycloneDX component
 * @returns {boolean} True when provenance URL, digests, signatures, or key IDs exist
 */
export declare function hasComponentRegistryProvenanceEvidence(component: object): boolean;
/**
 * Determine whether a component includes registry provenance metadata.
 *
 * @param {object} component CycloneDX component
 * @returns {boolean} True when provenance or trusted publishing metadata exists
 */
export declare function hasComponentRegistryProvenance(component: object): boolean;
/**
 * Filter components to those carrying trusted publishing metadata.
 *
 * @param {object[]} components BOM components
 * @returns {object[]} Trusted-publishing-backed components
 */
export declare function getTrustedComponents(components: object[]): object[];
/**
 * Filter components to those carrying direct registry provenance evidence.
 *
 * @param {object[]} components BOM components
 * @returns {object[]} Provenance-backed components
 */
export declare function getProvenanceComponents(components: object[]): object[];
/**
 * Count components with trusted publishing metadata by registry ecosystem.
 *
 * @param {object[]} components BOM components
 * @returns {{cargo: number, npm: number, pypi: number, total: number}} Trusted publishing counts
 */
export declare function getTrustedPublishingComponentCounts(components: object[]): {
    cargo: number;
    npm: number;
    pypi: number;
    total: number;
};
//# sourceMappingURL=provenanceUtils.d.ts.map