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

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

export function repositoryUrlForHuggingFaceAssetType(assetType: any): "https://huggingface.co" | "https://huggingface.co/datasets" | "https://huggingface.co/spaces";
export function assetTypeFromHuggingFaceRepositoryUrl(repositoryUrl: any): "model" | "dataset" | "space";
/**
 * Normalize a Hugging Face repository identifier to the canonical namespace/name form.
 *
 * @param {string} repoId Hugging Face repository id candidate
 * @returns {string|undefined} normalized repository id
 */
export function sanitizeHuggingFaceRepoId(repoId: string): string | undefined;
/**
 * Encode Hugging Face path segments while preserving path separators.
 *
 * @param {string} value path-like repository identifier
 * @returns {string} encoded path segments
 */
export function encodeHuggingFacePathSegments(value: string): string;
/**
 * Convert a Hugging Face asset reference to a canonical web path.
 *
 * @param {string} assetType asset type such as model, dataset, or space
 * @param {string} repoId Hugging Face repository id
 * @returns {string|undefined} canonical path under huggingface.co
 */
export function toHuggingFaceAssetPath(assetType: string, repoId: string): string | undefined;
/**
 * Convert a Hugging Face asset reference to a canonical web URL.
 *
 * @param {string} assetType asset type such as model, dataset, or space
 * @param {string} repoId Hugging Face repository id
 * @returns {string|undefined} canonical URL under huggingface.co
 */
export function toHuggingFaceAssetUrl(assetType: string, repoId: string): string | undefined;
/**
 * Convert a Hugging Face repo reference to a package URL.
 *
 * @param {string} repoId Hugging Face repository id
 * @param {string} [version] optional revision or sha
 * @param {string} [repositoryUrl] optional registry URL override
 * @returns {string|undefined} normalized Hugging Face purl
 */
export function toHuggingFacePurl(repoId: string, version?: string, repositoryUrl?: string): string | undefined;
/**
 * Normalize a direct Hugging Face URL or purl into a repo reference.
 *
 * @param {string} value direct URL, API URL, or purl
 * @returns {{ assetType: string, repoId: string, version?: string }|undefined} normalized reference
 */
export function normalizeHuggingFaceReference(value: string): {
    assetType: string;
    repoId: string;
    version?: string;
} | undefined;
/**
 * Normalize a Hugging Face dataset descriptor into reusable fields.
 *
 * @param {object|string} dataset dataset reference from model-card metadata
 * @param {{ urlSanitizer?: (url: string|undefined) => string|undefined }} [options={}] dataset normalization options
 * @returns {{
 *   assetType: "dataset",
 *   bomRef: string,
 *   description?: string,
 *   group: string,
 *   name: string,
 *   repoId: string,
 *   url: string,
 * }|undefined} normalized dataset metadata
 */
export function normalizeHuggingFaceDataset(dataset: object | string, options?: {
    urlSanitizer?: (url: string | undefined) => string | undefined;
}): {
    assetType: "dataset";
    bomRef: string;
    description?: string;
    group: string;
    name: string;
    repoId: string;
    url: string;
} | undefined;
/**
 * Create an inline CycloneDX dataset object from Hugging Face model-card metadata.
 *
 * @param {object|string} dataset dataset reference from model-card metadata
 * @param {{ urlSanitizer?: (url: string|undefined) => string|undefined }} [options={}] dataset normalization options
 * @returns {{ contents?: { url: string }, description?: string, name: string, type: string }|undefined} inline dataset object
 */
export function createInlineHuggingFaceDataset(dataset: object | string, options?: {
    urlSanitizer?: (url: string | undefined) => string | undefined;
}): {
    contents?: {
        url: string;
    };
    description?: string;
    name: string;
    type: string;
} | undefined;
/**
 * Convert Hugging Face model-index entries into CycloneDX performance metrics.
 *
 * @param {Array<object>} [modelIndex=[]] model-index entries from model-card metadata
 * @returns {Array<{ slice?: string, type: string, value: string }>} CycloneDX performance metrics
 */
export function createPerformanceMetrics(modelIndex?: Array<object>): Array<{
    slice?: string;
    type: string;
    value: string;
}>;
/**
 * Derive a human-readable quantization label from a Hugging Face quantization config.
 *
 * @param {object|string} quantizationConfig Hugging Face quantization configuration
 * @returns {string|undefined} normalized quantization label
 */
export function quantizationValueFromConfig(quantizationConfig: object | string): string | undefined;
export const HF_BASE_URL: "https://huggingface.co";
export const HUGGING_FACE_ANCESTOR_RELATIONS: Set<string>;
export const HUGGING_FACE_DATASET_REPOSITORY_URL: "https://huggingface.co/datasets";
export const HUGGING_FACE_SPACE_REPOSITORY_URL: "https://huggingface.co/spaces";
//# sourceMappingURL=huggingfaceUtils.d.ts.map