@salesforce/source-deploy-retrieve/lib/src/collections/types.d.ts

JavaScript library to run Salesforce metadata deploys and retrieves

import { Connection } from '@salesforce/core';
import { OptionalTreeRegistryOptions } from '../common/types';
import { XML_NS_KEY } from '../common/constants';
import { FileProperties } from '../client/types';
import { ComponentSet } from './componentSet';
export type PackageTypeMembers = {
    name: string;
    members: string[];
};
export type PackageManifestObject = {
    Package: {
        types: PackageTypeMembers[];
        version: string;
        fullName?: string;
        [XML_NS_KEY]?: string;
    };
};
export declare enum DestructiveChangesType {
    POST = "post",
    PRE = "pre"
}
export type FromSourceOptions = {
    /**
     * File paths or directory paths to resolve components against
     */
    fsPaths: string[];
    /**
     * Only resolve components contained in the given set
     */
    include?: ComponentSet;
    /**
     * File paths or directory paths of deleted components, i.e., destructive changes.
     */
    fsDeletePaths?: string[];
} & OptionalTreeRegistryOptions;
export type FromManifestOptions = {
    /**
     * Path to the manifest file in XML format
     */
    manifestPath: string;
    /**
     * Paths to resolve source-backed components. The manifest file is used to
     * indicate which components to include.
     */
    resolveSourcePaths?: string[];
    /**
     * By default, wildcard members encountered in the manifest are added to the set
     * e.g. `{ fullName: '*', type: 'ApexClass' }`. If `resolveSourcePaths` is set,
     * wildcard components are not added to the final set, but are used in the filter
     * when resolving source-backed components to match all components with the wildcard
     * type.
     *
     * Use this flag to always add wildcard components to the set, regardless of the other
     * conditions.
     */
    forceAddWildcards?: boolean;
    /**
     * path to a `destructiveChangesPre.xml` file in XML format
     */
    destructivePre?: string;
    /**
     * path to a `destructiveChangesPost.xml` file in XML format
     */
    destructivePost?: string;
} & OptionalTreeRegistryOptions;
export type FromConnectionOptions = {
    /**
     * username or connection to an org
     */
    usernameOrConnection: string | Connection;
    /**
     * the metadata API version to use
     */
    apiVersion?: string;
    /**
     * filter the result components to e.g. remove managed components
     */
    componentFilter?: (component: Partial<FileProperties>) => boolean;
    /**
     * array of metadata type names to use for `connection.metadata.list()`
     */
    metadataTypes?: string[];
} & OptionalTreeRegistryOptions;