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.

Hierarchy

RetrieveDeltaStrategy

Index

Constructors

constructor

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

Properties

`Private` `Readonly` compareStrategies

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

`Private` `Readonly` deployService

deployService: SalesforceDeployService

`Private` `Readonly` logger

logger: Logger

`Private` `Readonly` metadataRegistry

metadataRegistry: MetadataRegistry

`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, CompareStrategy | CompareStrategyType> = ...

Represents the metadata strategy for different types of metadata.

Methods

getChangedComponents

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

`Private` getComparer

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

`Private` isBinaryEqual

isBinaryEqual(this, a, b): boolean
Parameters
- this: void
- a: string | Buffer
- b: string | Buffer
Returns boolean
- Defined in packages/salesforce/src/retrieveDeltaStrategy.ts:183

`Private` isComponentChanged

isComponentChanged(mdPackage, component): 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<SalesforceRetrievedComponentFile>
  
  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:100

`Private` isDataChanged

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

`Private` isMetaXmlEqual

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

`Private` isPackageNewer

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

`Private` isStringEqual

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

`Private` isXmlEqual

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

`Private` primitiveCompare

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

Class RetrieveDeltaStrategy

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

deployService: SalesforceDeployService

metadataRegistry: MetadataRegistry

logger: Logger

Returns RetrieveDeltaStrategy

Properties

Private Readonly compareStrategies

Private Readonly deployService

Private Readonly logger

Private Readonly metadataRegistry

Static Readonly defaultXmlStrategy

Static Readonly metadataStrategy

Methods

getChangedComponents

Parameters

mdPackage: SalesforcePackage

options: { cancellationToken?: CancellationToken; deltaTypes?: string[]; } & RetrieveManifestOptions

Returns Promise<SalesforcePackageComponent[]>

Private getComparer

Parameters

packagePath: string

data: string | Buffer

type: MetadataType

Returns CompareStrategy

Private isBinaryEqual

Parameters

this: void

a: string | Buffer

b: string | Buffer

Returns boolean

Private isComponentChanged

Parameters

mdPackage: SalesforcePackage

component: RetrieveResultComponent<SalesforceRetrievedComponentFile>

Returns Promise<boolean>

Private isDataChanged

Parameters

packagePath: string

localData: undefined | string | Buffer

orgData: undefined | string | Buffer

type: MetadataType

Returns boolean

Private isMetaXmlEqual

Parameters

a: string | Buffer

b: string | Buffer

Returns boolean

Private isPackageNewer

Parameters

a: string | Buffer

b: string | Buffer

Returns boolean

Private isStringEqual

Parameters

a: string | Buffer

b: string | Buffer

Returns boolean

Private isXmlEqual

Parameters

a: string | Buffer

b: string | Buffer

Optional options: { arrayMode?: boolean; ignoreExtra?: boolean; strictOrder?: boolean; }

Optional arrayMode?: boolean

Optional ignoreExtra?: boolean

Optional strictOrder?: boolean

Returns boolean

Private primitiveCompare

Parameters

this: void

a: unknown

b: unknown

Returns boolean

`Private` `Readonly` compareStrategies

`Private` `Readonly` deployService

`Private` `Readonly` logger

`Private` `Readonly` metadataRegistry

`Static` `Readonly` defaultXmlStrategy

`Static` `Readonly` metadataStrategy

options: {
cancellationToken?: CancellationToken;
deltaTypes?: string[];
} & RetrieveManifestOptions

`Private` getComparer

`Private` isBinaryEqual

`Private` isComponentChanged

`Private` isDataChanged

`Private` isMetaXmlEqual

`Private` isPackageNewer

`Private` isStringEqual

`Private` isXmlEqual

`Optional` options: {
arrayMode?: boolean;
ignoreExtra?: boolean;
strictOrder?: boolean;
}

`Optional` arrayMode?: boolean

`Optional` ignoreExtra?: boolean

`Optional` strictOrder?: boolean

`Private` primitiveCompare