@salesforce/source-deploy-retrieve/lib/src/client/retrieveExtract.d.ts

JavaScript library to run Salesforce metadata deploys and retrieves

import { Logger } from '@salesforce/core/logger';
import { ComponentSet } from '../collections';
import { SourceComponent } from '../resolve/sourceComponent';
import { BotVersionFilter, FileResponse, PackageOption, PackageOptions } from './types';
import { MetadataApiRetrieveOptions } from './types';
export declare const extract: ({ zip, options, logger, mainComponents, }: {
    zip: Buffer;
    options: MetadataApiRetrieveOptions;
    logger: Logger;
    mainComponents?: ComponentSet;
}) => Promise<{
    componentSet: ComponentSet;
    partialDeleteFileResponses: FileResponse[];
}>;
export declare const getPackageOptions: (packageOptions?: PackageOptions) => Array<Required<PackageOption>>;
/**
 * Extracts version number from BotVersion fullName.
 * BotVersion fullName can be in formats like "v0", "v1", "v2" or "0", "1", "2"
 *
 * @internal Exported for testing purposes
 */
export declare function extractVersionNumber(fullName: string): number | null;
/**
 * Determines if a version number matches the filter criteria.
 * Shared logic for both Bot and GenAiPlannerBundle filtering.
 *
 * @param versionNum The version number to check
 * @param versionFilter The filter criteria ('all', 'highest', or specific number)
 * @param highestVersion The highest version number (required when filter is 'highest')
 * @returns true if the version should be kept, false otherwise
 * @internal Exported for testing purposes
 */
export declare function versionMatchesFilter(versionNum: number, versionFilter: 'all' | 'highest' | number, highestVersion?: number): boolean;
/**
 * Filters BotVersion entries from a Bot XML based on version filter criteria.
 *
 * @internal Exported for testing purposes
 */
export declare function filterBotVersionEntries(botVersions: Array<{
    fullName?: string;
}>, versionFilter: 'all' | 'highest' | number): Array<{
    fullName?: string;
}>;
export declare function filterAgentComponents(components: SourceComponent[], botVersionFilters: BotVersionFilter[]): Promise<SourceComponent[]>;