snyk/dist/cli/commands/test/iac/local-execution/oci-pull.d.ts

snyk library and cli utility

import { OCIPullOptions, OCIRegistryURLComponents } from './types';
import { CustomError } from '../../../../../lib/errors';
export declare const CUSTOM_RULES_TARBALL = "custom-bundle.tar.gz";
export declare function extractOCIRegistryURLComponents(OCIRegistryURL: string): OCIRegistryURLComponents;
/**
 * Downloads an OCI Artifact from a remote OCI Registry and writes it to the disk.
 * The artifact here is a custom rules bundle stored in a remote registry.
 * In order to do that, it calls an external docker registry v2 client to get the manifests, the layers and then builds the artifact.
 * Example: https://github.com/opencontainers/image-spec/blob/main/manifest.md#example-image-manifest
 * @param OCIRegistryURL - the URL where the custom rules bundle is stored
 * @param opt????? (optional) - object that holds the credentials and other metadata required for the registry-v2-client
 **/
export declare function pull({ registryBase, repo, tag }: OCIRegistryURLComponents, opt?: OCIPullOptions): Promise<string>;
export declare class FailedToBuildOCIArtifactError extends CustomError {
    constructor(message?: string);
}
export declare class InvalidManifestSchemaVersionError extends CustomError {
    constructor(message?: string);
}
export declare class InvalidRemoteRegistryURLError extends CustomError {
    constructor(url?: string);
}
export declare class UnsupportedEntitlementPullError extends CustomError {
    constructor(entitlement: string);
}