Class RetrieveDeltaStrategy

Interface for a strategy to determine which components in the packages have changed and need to be deployed. Returns a list of components that have changed which can be used to create a new deployment package.

Index

Constructors

constructor

new RetrieveDeltaStrategy(
deployService: SalesforceDeployService,
logger: Logger,
): RetrieveDeltaStrategy
Parameters
- deployService: SalesforceDeployService
- logger: Logger
Returns RetrieveDeltaStrategy
- Defined in packages/salesforce/src/retrieveDeltaStrategy.ts:55

Properties

`Private` `Readonly`compareStrategies

compareStrategies: Record<CompareStrategyType | string, CompareStrategy> = ...

`Private` `Readonly`deployService

deployService: SalesforceDeployService

`Private` `Readonly`logger

logger: Logger

`Static` `Readonly`defaultXmlStrategy

defaultXmlStrategy: CompareXmlStrategyType = 'xml'

Determines the default strategy for strict XML parsing. This strategy is used when no specific strategy is defined for a metadata type. This strategy is used for XML files that are not metadata types.

`Static` `Readonly`metadataStrategy

metadataStrategy: Record<string, CompareStrategyType | CompareStrategy> = ...

Represents the metadata strategy for different types of metadata.

Methods

getChangedComponents

getChangedComponents(
mdPackage: SalesforcePackage,
options: { cancellationToken?: CancellationToken; deltaTypes?: string[] } & RetrieveManifestOptions,
): Promise<SalesforcePackageComponent[]>
Gets a list of components that have changed since the last deployment.
Parameters
- mdPackage: SalesforcePackage
  Package to get changed components for.
- options: { cancellationToken?: CancellationToken; deltaTypes?: string[] } & RetrieveManifestOptions
Returns Promise<SalesforcePackageComponent[]>
- Defined in packages/salesforce/src/retrieveDeltaStrategy.ts:64

`Private`getComparer

getComparer(
    packagePath: string,
    data: string | Buffer<ArrayBufferLike>,
    type: MetadataType,
): CompareStrategy
Parameters
- packagePath: string
- data: string | Buffer<ArrayBufferLike>
- type: MetadataType
Returns CompareStrategy
- Defined in packages/salesforce/src/retrieveDeltaStrategy.ts:150

`Private`isBinaryEqual

isBinaryEqual(
a: string | Buffer<ArrayBufferLike>,
b: string | Buffer<ArrayBufferLike>,
): boolean
Parameters
- a: string | Buffer<ArrayBufferLike>
- b: string | Buffer<ArrayBufferLike>
Returns boolean
- Defined in packages/salesforce/src/retrieveDeltaStrategy.ts:182

`Private`isComponentChanged

isComponentChanged(
mdPackage: SalesforcePackage,
component: RetrieveResultComponent,
): Promise<boolean>
Compare the retrieved component against the component in the current package to determine if it has changed.
Parameters
- mdPackage: SalesforcePackage
  Package containing the data to compare against
- component: RetrieveResultComponent
  The retrieved component to compare against the same component in package
Returns Promise<boolean>
Returns true if the component has changed
- Defined in packages/salesforce/src/retrieveDeltaStrategy.ts:99

`Private`isDataChanged

isDataChanged(
    packagePath: string,
    localData: undefined | string | Buffer<ArrayBufferLike>,
    orgData: undefined | string | Buffer<ArrayBufferLike>,
    type: MetadataType,
): boolean
Parameters
- packagePath: string
- localData: undefined | string | Buffer<ArrayBufferLike>
- orgData: undefined | string | Buffer<ArrayBufferLike>
- type: MetadataType
Returns boolean
- Defined in packages/salesforce/src/retrieveDeltaStrategy.ts:124

`Private`isMetaXmlEqual

isMetaXmlEqual(
a: string | Buffer<ArrayBufferLike>,
b: string | Buffer<ArrayBufferLike>,
): boolean
Parameters
- a: string | Buffer<ArrayBufferLike>
- b: string | Buffer<ArrayBufferLike>
Returns boolean
- Defined in packages/salesforce/src/retrieveDeltaStrategy.ts:226

`Private`isPackageNewer

isPackageNewer(
a: string | Buffer<ArrayBufferLike>,
b: string | Buffer<ArrayBufferLike>,
): boolean
Parameters
- a: string | Buffer<ArrayBufferLike>
- b: string | Buffer<ArrayBufferLike>
Returns boolean
- Defined in packages/salesforce/src/retrieveDeltaStrategy.ts:204

`Private`isStringEqual

isStringEqual(
a: string | Buffer<ArrayBufferLike>,
b: string | Buffer<ArrayBufferLike>,
): boolean
Parameters
- a: string | Buffer<ArrayBufferLike>
- b: string | Buffer<ArrayBufferLike>
Returns boolean
- Defined in packages/salesforce/src/retrieveDeltaStrategy.ts:245

`Private`isXmlEqual

isXmlEqual(
    a: string | Buffer<ArrayBufferLike>,
    b: string | Buffer<ArrayBufferLike>,
    options?: {
        arrayMode?: boolean;
        ignoreExtra?: boolean;
        strictOrder?: boolean;
    },
): boolean
Parameters
- a: string | Buffer<ArrayBufferLike>
- b: string | Buffer<ArrayBufferLike>
- Optionaloptions: { arrayMode?: boolean; ignoreExtra?: boolean; strictOrder?: boolean }
Returns boolean
- Defined in packages/salesforce/src/retrieveDeltaStrategy.ts:189

`Private`primitiveCompare

primitiveCompare(this: void, a: unknown, b: unknown): boolean
Parameters
- this: void
- a: unknown
- b: unknown
Returns boolean
- Defined in packages/salesforce/src/retrieveDeltaStrategy.ts:251

Class RetrieveDeltaStrategy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RetrieveDeltaStrategy

Properties

Private ReadonlycompareStrategies

Private ReadonlydeployService

Private Readonlylogger

Static ReadonlydefaultXmlStrategy

Static ReadonlymetadataStrategy

Methods

getChangedComponents

Parameters

Returns Promise<SalesforcePackageComponent[]>

PrivategetComparer

Parameters

Returns CompareStrategy

PrivateisBinaryEqual

Parameters

Returns boolean

PrivateisComponentChanged

Parameters

Returns Promise<boolean>

PrivateisDataChanged

Parameters

Returns boolean

PrivateisMetaXmlEqual

Parameters

Returns boolean

PrivateisPackageNewer

Parameters

Returns boolean

PrivateisStringEqual

Parameters

Returns boolean

PrivateisXmlEqual

Parameters

Returns boolean

PrivateprimitiveCompare

Parameters

Returns boolean

Settings

On This Page

`Private` `Readonly`compareStrategies

`Private` `Readonly`deployService

`Private` `Readonly`logger

`Static` `Readonly`defaultXmlStrategy

`Static` `Readonly`metadataStrategy

`Private`getComparer

`Private`isBinaryEqual

`Private`isComponentChanged

`Private`isDataChanged

`Private`isMetaXmlEqual

`Private`isPackageNewer

`Private`isStringEqual

`Private`isXmlEqual

`Private`primitiveCompare