renovate/dist/modules/datasource/types.d.ts

Automated dependency updates. Flexible so you don't need to be.

import type { ConstraintsFilter, CustomDatasourceConfig } from '../../config/types';
import type { ModuleApi } from '../../types';
import type { Timestamp } from '../../util/timestamp';
export interface GetDigestInputConfig {
    datasource: string;
    packageName: string;
    defaultRegistryUrls?: string[];
    registryUrls?: string[] | null;
    registryUrl?: string;
    lookupName?: string;
    additionalRegistryUrls?: string[];
    currentValue?: string;
    currentDigest?: string;
    replacementName?: string;
}
export interface DigestConfig {
    packageName: string;
    lookupName?: string;
    registryUrl?: string;
    currentValue?: string;
    currentDigest?: string;
}
export interface GetReleasesConfig {
    customDatasources?: Record<string, CustomDatasourceConfig>;
    datasource?: string;
    packageName: string;
    registryUrl?: string;
    currentValue?: string;
}
export interface GetPkgReleasesConfig {
    customDatasources?: Record<string, CustomDatasourceConfig>;
    npmrc?: string;
    defaultRegistryUrls?: string[];
    registryUrls?: string[] | null;
    additionalRegistryUrls?: string[];
    datasource: string;
    packageName: string;
    currentValue?: string;
    versioning?: string;
    extractVersion?: string;
    versionCompatibility?: string;
    currentCompatibility?: string;
    constraints?: Record<string, string>;
    replacementName?: string;
    replacementVersion?: string;
    constraintsFiltering?: ConstraintsFilter;
    registryStrategy?: RegistryStrategy;
}
export interface Release {
    changelogContent?: string;
    changelogUrl?: string;
    checksumUrl?: string;
    downloadUrl?: string;
    gitRef?: string;
    isDeprecated?: boolean;
    isStable?: boolean;
    releaseTimestamp?: Timestamp | null;
    version: string;
    /** The original value to which `extractVersion` was applied */
    versionOrig?: string;
    newDigest?: string | undefined;
    constraints?: Record<string, string[]>;
    dependencies?: Record<string, string>;
    devDependencies?: Record<string, string>;
    registryUrl?: string;
    sourceUrl?: string | undefined;
    sourceDirectory?: string;
    currentAge?: string;
    isLatest?: boolean;
}
export interface ReleaseResult {
    deprecationMessage?: string;
    isPrivate?: boolean;
    releases: Release[];
    tags?: Record<string, string> | undefined;
    changelogContent?: string;
    changelogUrl?: string;
    dependencyUrl?: string;
    homepage?: string | undefined;
    gitRef?: string;
    sourceUrl?: string | null;
    sourceDirectory?: string;
    registryUrl?: string;
    replacementName?: string;
    replacementVersion?: string;
    lookupName?: string;
    packageScope?: string;
    mostRecentTimestamp?: Timestamp;
    isAbandoned?: boolean;
    respectLatest?: boolean;
}
export interface PostprocessReleaseConfig {
    packageName: string;
    registryUrl: string | null;
}
export type PostprocessReleaseResult = Release | 'reject';
export type RegistryStrategy = 'first' | 'hunt' | 'merge';
export type SourceUrlSupport = 'package' | 'release' | 'none';
export interface DatasourceApi extends ModuleApi {
    id: string;
    getDigest?(config: DigestConfig, newValue?: string): Promise<string | null>;
    getReleases(config: GetReleasesConfig): Promise<ReleaseResult | null>;
    defaultRegistryUrls?: string[] | (() => string[]);
    defaultVersioning?: string | undefined;
    defaultConfig?: Record<string, unknown> | undefined;
    /**
     * Strategy to use when multiple registryUrls are available to the datasource.
     * - `first`: only the first registryUrl will be tried and others ignored
     * - `hunt`: registryUrls will be tried in order until one returns a result
     * - `merge`: all registryUrls will be tried and the results merged if more than one returns a result
     */
    registryStrategy?: RegistryStrategy | undefined;
    /**
     * Whether custom registryUrls are allowed.
     */
    customRegistrySupport: boolean;
    /**
     * Whether release timestamp can be returned.
     */
    releaseTimestampSupport: boolean;
    /**
     * Notes on how release timestamp is determined.
     */
    releaseTimestampNote?: string;
    /**
     * Whether sourceURL can be returned.
     */
    sourceUrlSupport: SourceUrlSupport;
    /**
     * Notes on how sourceURL is determined.
     */
    sourceUrlNote?: string;
    /**
     * Whether to perform centralized caching in the datasource index/wrapper or not.
     *
     * - `true`: datasource index wrapper will cache all results (based on registryUrl/packageName)
     *   - **Must be set only if datasource is able to determine and return `isPrivate` flag**
     * - `false`: centralized caching is not performed, implementation still could do caching internally
     */
    caching?: boolean | undefined;
    /**
     * When the candidate for update is formed, this method could be called
     * to fetch additional information such as `releaseTimestamp`.
     *
     * Also, the release could be checked (and potentially rejected)
     * via some datasource-specific external call.
     *
     * In case of reject, the next candidate release is selected,
     * and `postprocessRelease` is called again.
     *
     * Rejection must happen only when the release will lead to downstream error,
     * e.g. the release turned out to be yanked or doesn't exist for some reason.
     *
     * In other cases, the original `Release` parameter should be returned.
     */
    postprocessRelease(config: PostprocessReleaseConfig, release: Release): Promise<PostprocessReleaseResult>;
}