Class DatapackLookupService

Implements

DatapackDependencyResolver

Constructors

constructor

new DatapackLookupService(
    namespaceService: VlocityNamespaceService,
    matchingKeyService: VlocityMatchingKeyService,
    lookupService: SalesforceLookupService,
    schema: SalesforceSchemaService,
    logger?: Logger,
): DatapackLookupService
Parameters
- namespaceService: VlocityNamespaceService
- matchingKeyService: VlocityMatchingKeyService
- lookupService: SalesforceLookupService
- schema: SalesforceSchemaService
- logger: Logger = ...
Returns DatapackLookupService
- Defined in packages/vlocity-deploy/src/datapackLookupService.ts:38

Properties

`Private` `Readonly`distinctLogger

distinctLogger: Logger

`Private` `Readonly`logger

logger: Logger = ...

`Private` `Readonly`lookupCache

lookupCache: Map<
string,
{ entries: Map<string, undefined | string>; refreshed: number },
> = ...

Methods

`Private`buildFilter

buildFilter<K extends string>(
record: DatapackDeploymentRecord,
fields?: K[],
): { [P in string]?: any }
Type Parameters
- K extends string
Parameters
- record: DatapackDeploymentRecord
- Optionalfields: K[]
Returns { [P in string]?: any }
- Defined in packages/vlocity-deploy/src/datapackLookupService.ts:324

compareRecordsToOrgData

compareRecordsToOrgData(
datapacks: DatapackDeploymentRecord[],
cancelToken?: CancellationToken,
): Promise<Map<string, OrgRecordStatus>>
Compare datapack records with ID
Parameters
- datapacks: DatapackDeploymentRecord[]
  Datapack records to lookup
- OptionalcancelToken: CancellationToken
Returns Promise<Map<string, OrgRecordStatus>>
Record org status returned as map keyed by both record ID and source key

See
DatapackDeploymentRecord.recordId to org data and return per record details if the record is up to date with the org
- Defined in packages/vlocity-deploy/src/datapackLookupService.ts:245

`Private`fieldEquals

fieldEquals(record: object, field: string, filterValue: any): boolean
Parameters
- record: object
- field: string
- filterValue: any
Returns boolean
- Defined in packages/vlocity-deploy/src/datapackLookupService.ts:293

`Private`getCache

getCache(
sobjectType: string,
): { entries: Map<string, undefined | string>; refreshed: number }
Parameters
- sobjectType: string
Returns { entries: Map<string, undefined | string>; refreshed: number }
- Defined in packages/vlocity-deploy/src/datapackLookupService.ts:418

`Private`getCachedEntry

getCachedEntry(sobjectType: string, key: undefined | string): undefined | string
Parameters
- sobjectType: string
- key: undefined | string
Returns undefined | string
- Defined in packages/vlocity-deploy/src/datapackLookupService.ts:397
getCachedEntry(
    sobjectType: string,
    key: undefined | string,
    resolver?: (
        key: string,
    ) => undefined | string | Promise<undefined | string>,
): Promise<string>
Parameters
- sobjectType: string
- key: undefined | string
- Optionalresolver: (key: string) => undefined | string | Promise<undefined | string>
Returns Promise<string>
- Defined in packages/vlocity-deploy/src/datapackLookupService.ts:398

`Private`getParentRecordMatchingFields

getParentRecordMatchingFields(
record: DatapackDeploymentRecord,
): Promise<string[]>
Parameters
- record: DatapackDeploymentRecord
Returns Promise<string[]>
- Defined in packages/vlocity-deploy/src/datapackLookupService.ts:350

`Private`getSourceKey

getSourceKey(
    obj:
        | { VlocityLookupRecordSourceKey: string }
        | { VlocityMatchingRecordSourceKey: string },
): string
Parameters
- obj:
  | { VlocityLookupRecordSourceKey: string }
  | { VlocityMatchingRecordSourceKey: string }
Returns string
- Defined in packages/vlocity-deploy/src/datapackLookupService.ts:393

`Private`isLookupFormula

isLookupFormula(formula: string): boolean
Parameters
- formula: string
Returns boolean
- Defined in packages/vlocity-deploy/src/datapackLookupService.ts:389

`Private`isUpdateableField

isUpdateableField(field: Field): boolean
Parameters
- field: Field
Returns boolean
- Defined in packages/vlocity-deploy/src/datapackLookupService.ts:286

lookupIds

lookupIds(
datapackRecords: DatapackDeploymentRecord[],
cancelToken?: CancellationToken,
): Promise<(undefined | string)[]>
Bulk lookup of records in Salesforce using the current matching key configuration;
Parameters
- datapackRecords: DatapackDeploymentRecord[]
  Array of Records to lookup; note the index of the datapackRecords corresponds to the index in the result array
- OptionalcancelToken: CancellationToken
Returns Promise<(undefined | string)[]>
Array with all IDs found in Salesforce; array index matches the order of the datapackRecords as provided
- Defined in packages/vlocity-deploy/src/datapackLookupService.ts:103

`Private`lookupMultiple

lookupMultiple(
lookups: { filter: object; sobjectType: string }[],
): Promise<(undefined | string[])[]>
Lookup multiple records over multiple SObjects using the specified filters
Parameters
- lookups: { filter: object; sobjectType: string }[]
  lookup requests
Returns Promise<(undefined | string[])[]>
Array with all matched records or undefined when no matches found
- Defined in packages/vlocity-deploy/src/datapackLookupService.ts:197

`Private`normalizeFilter

normalizeFilter<T extends object>(data: T): T
Type Parameters
- T extends object
Parameters
- data: T
Returns T
- Defined in packages/vlocity-deploy/src/datapackLookupService.ts:337

resolveDependencies

resolveDependencies(
dependencies: DependencyResolutionRequest[],
): Promise<{ resolution: undefined | string }[]>
Resolve the records for a set of dependencies in Salesforce; returns the real record IDs for each dependency.
Parameters
- dependencies: DependencyResolutionRequest[]
  Array of dependency resolution requests
Returns Promise<{ resolution: undefined | string }[]>
Implementation of DatapackDependencyResolver.resolveDependencies
- Defined in packages/vlocity-deploy/src/datapackLookupService.ts:59

resolveDependency

resolveDependency(
dependency: VlocityDatapackReference,
datapackRecord: DatapackDeploymentRecord,
): Promise<undefined | string>
Resolve the record if of a dependency in Salesforce; returns the real record ID of a dependency.
Parameters
- dependency: VlocityDatapackReference
  Dependency whose ID to resolve
- datapackRecord: DatapackDeploymentRecord
Returns Promise<undefined | string>
Implementation of DatapackDependencyResolver.resolveDependency
- Defined in packages/vlocity-deploy/src/datapackLookupService.ts:51

`Private`resolveFieldDescribe

resolveFieldDescribe(
sobjectType: string,
field: string,
): Promise<undefined | { describe: Field; fullName: string }>
Parameters
- sobjectType: string
- field: string
Returns Promise<undefined | { describe: Field; fullName: string }>
- Defined in packages/vlocity-deploy/src/datapackLookupService.ts:369

`Private`updateCachedEntry

updateCachedEntry<T extends undefined | string>(
    sobjectType: string,
    key: string,
    id: T,
): T
Type Parameters
- T extends undefined | string
Parameters
- sobjectType: string
- key: string
- id: T
Returns T
- Defined in packages/vlocity-deploy/src/datapackLookupService.ts:413

Class DatapackLookupService

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DatapackLookupService

Properties

Private ReadonlydistinctLogger

Private Readonlylogger

Private ReadonlylookupCache

Private ReadonlylookupService

Private ReadonlymatchingKeyService

Private ReadonlynamespaceService

Private Readonlyschema

Methods

PrivatebuildFilter

Type Parameters

Parameters

Returns { [P in string]?: any }

compareRecordsToOrgData

Parameters

Returns Promise<Map<string, OrgRecordStatus>>

See

PrivatefieldEquals

Parameters

Returns boolean

PrivategetCache

Parameters

Returns { entries: Map<string, undefined | string>; refreshed: number }

PrivategetCachedEntry

Parameters

Returns undefined | string

Parameters

Returns Promise<string>

PrivategetParentRecordMatchingFields

Parameters

Returns Promise<string[]>

PrivategetSourceKey

Parameters

Returns string

PrivateisLookupFormula

Parameters

Returns boolean

PrivateisUpdateableField

Parameters

Returns boolean

lookupIds

Parameters

Returns Promise<(undefined | string)[]>

PrivatelookupMultiple

Parameters

Returns Promise<(undefined | string[])[]>

PrivatenormalizeFilter

Type Parameters

Parameters

Returns T

resolveDependencies

Parameters

Returns Promise<{ resolution: undefined | string }[]>

resolveDependency

Parameters

Returns Promise<undefined | string>

PrivateresolveFieldDescribe

Parameters

Returns Promise<undefined | { describe: Field; fullName: string }>

PrivateupdateCachedEntry

Type Parameters

Parameters

Returns T

Settings

On This Page

`Private` `Readonly`distinctLogger

`Private` `Readonly`logger

`Private` `Readonly`lookupCache

`Private` `Readonly`lookupService

`Private` `Readonly`matchingKeyService

`Private` `Readonly`namespaceService

`Private` `Readonly`schema

`Private`buildFilter

`Private`fieldEquals

`Private`getCache

`Private`getCachedEntry

`Private`getParentRecordMatchingFields

`Private`getSourceKey

`Private`isLookupFormula

`Private`isUpdateableField

`Private`lookupMultiple

`Private`normalizeFilter

`Private`resolveFieldDescribe

`Private`updateCachedEntry