Class SalesforceSchemaService

Provides access to Database Schema methods like describe.

Implements

ISalesforceSchemaService

Constructors

constructor

new SalesforceSchemaService(
connectionProvider: SalesforceConnectionProvider,
): SalesforceSchemaService
Parameters
- connectionProvider: SalesforceConnectionProvider
Returns SalesforceSchemaService
- Defined in packages/salesforce/src/salesforceSchemaService.ts:57

Properties

`Private` `Readonly`connectionProvider

connectionProvider: SalesforceConnectionProvider

`Private` `Readonly`fieldMatchingStrategies

fieldMatchingStrategies: ((field: Field, name: string) => boolean)[] = ...

`Private` `Readonly`logger

logger: Logger

`Private` `Readonly`nsService

nsService: NamespaceService

`Private` `Readonly`schemaAccess

schemaAccess: CompositeSchemaAccess

Methods

describeByPrefix

describeByPrefix(prefix: string): Promise<DescribeSObjectResult | undefined>
Parameters
- prefix: string
Returns Promise<DescribeSObjectResult | undefined>
Implementation of ISalesforceSchemaService.describeByPrefix
- Defined in packages/salesforce/src/salesforceSchemaService.ts:191

describeCustomMetadataObjects

describeCustomMetadataObjects(): Promise<string[]>
Returns Promise<string[]>
Implementation of ISalesforceSchemaService.describeCustomMetadataObjects
- Defined in packages/salesforce/src/salesforceSchemaService.ts:75

describePicklistValues

describePicklistValues(
type: string,
fieldName: string,
): Promise<PicklistEntry[]>
Parameters
- type: string
- fieldName: string
Returns Promise<PicklistEntry[]>
Implementation of ISalesforceSchemaService.describePicklistValues
- Defined in packages/salesforce/src/salesforceSchemaService.ts:200
describePicklistValues(
    type: string,
    fieldName: string,
    throwWhenNotFound: boolean,
): Promise<PicklistEntry[] | undefined>
Parameters
- type: string
- fieldName: string
- throwWhenNotFound: boolean
Returns Promise<PicklistEntry[] | undefined>
Implementation of ISalesforceSchemaService.describePicklistValues
- Defined in packages/salesforce/src/salesforceSchemaService.ts:201

describeSObject

describeSObject(type: string): Promise<DescribeSObjectResult>
Describes an SObject and all it's fields using the Describe-API; any object not accessible for the current user will be return undefined.
Parameters
- type: string
  SObject type
Returns Promise<DescribeSObjectResult>
Implementation of ISalesforceSchemaService.describeSObject
- Defined in packages/salesforce/src/salesforceSchemaService.ts:136
describeSObject(
type: string,
throwWhenNotFound: boolean,
): Promise<DescribeSObjectResult | undefined>
Describes an SObject and all it's fields using the Describe-API; any object not accessible for the current user will be return undefined.
Parameters
- type: string
  SObject type
- throwWhenNotFound: boolean
  throw an error when the Object is not found instead of returning undefined
Returns Promise<DescribeSObjectResult | undefined>
Implementation of ISalesforceSchemaService.describeSObject
- Defined in packages/salesforce/src/salesforceSchemaService.ts:142

describeSObjectById

describeSObjectById(id: string): Promise<DescribeSObjectResult>
Parameters
- id: string
Returns Promise<DescribeSObjectResult>
Implementation of ISalesforceSchemaService.describeSObjectById
- Defined in packages/salesforce/src/salesforceSchemaService.ts:169

describeSObjectByPrefix

describeSObjectByPrefix(prefix: string): Promise<DescribeSObjectResult>
Parameters
- prefix: string
Returns Promise<DescribeSObjectResult>
Implementation of ISalesforceSchemaService.describeSObjectByPrefix
- Defined in packages/salesforce/src/salesforceSchemaService.ts:158

describeSObjectField

describeSObjectField(type: string, fieldName: string): Promise<Field>
Parameters
- type: string
- fieldName: string
Returns Promise<Field>
Implementation of ISalesforceSchemaService.describeSObjectField
- Defined in packages/salesforce/src/salesforceSchemaService.ts:237
describeSObjectField(
    type: string,
    fieldName: string,
    throwWhenNotFound: boolean,
): Promise<Field | undefined>
Parameters
- type: string
- fieldName: string
- throwWhenNotFound: boolean
Returns Promise<Field | undefined>
Implementation of ISalesforceSchemaService.describeSObjectField
- Defined in packages/salesforce/src/salesforceSchemaService.ts:238

describeSObjectFieldPath

describeSObjectFieldPath(type: string, fieldName: string): Promise<Field[]>
Parameters
- type: string
- fieldName: string
Returns Promise<Field[]>
Implementation of ISalesforceSchemaService.describeSObjectFieldPath
- Defined in packages/salesforce/src/salesforceSchemaService.ts:244
describeSObjectFieldPath(
    type: string,
    fieldName: string,
    throwWhenNotFound: boolean,
): Promise<readonly Field[] | undefined>
Parameters
- type: string
- fieldName: string
- throwWhenNotFound: boolean
Returns Promise<readonly Field[] | undefined>
Implementation of ISalesforceSchemaService.describeSObjectFieldPath
- Defined in packages/salesforce/src/salesforceSchemaService.ts:245

describeSObjects

describeSObjects(): Promise<DescribeGlobalSObjectResult[]>
Returns Promise<DescribeGlobalSObjectResult[]>
Implementation of ISalesforceSchemaService.describeSObjects
- Defined in packages/salesforce/src/salesforceSchemaService.ts:68

dispose

dispose(): void
Returns void
Implementation of ISalesforceSchemaService.dispose
- Defined in packages/salesforce/src/salesforceSchemaService.ts:62

`Private`encodeIndexAsBitset

encodeIndexAsBitset(index: number): string
Parameters
- index: number
Returns string
- Defined in packages/salesforce/src/salesforceSchemaService.ts:231

filterIds

filterIds(
ids: string | string[],
predicate: (type: DescribeSObjectResult, id: string) => boolean,
): Promise<string[]>
Filters a list of Salesforce IDs based on the provided filter function.

This method groups IDs by their 3-character prefix, determines the corresponding SObject type for each prefix, and then applies the filter function to each ID based on its SObject type.
Parameters
- ids: string | string[]
  A single Salesforce ID or an array of Salesforce IDs to filter
- predicate: (type: DescribeSObjectResult, id: string) => boolean
  A function that determines whether an ID should be included based on its SObject type
Returns Promise<string[]>
A Promise that resolves to an array of filtered Salesforce IDs
Example
```
// Filter only Contact IDs
const contactIds = await filterIds(mixedIds, (type) => type.name === 'Contact');
```
Implementation of ISalesforceSchemaService.filterIds
- Defined in packages/salesforce/src/salesforceSchemaService.ts:302

`Private`findSObjectField

findSObjectField(type: string, field: string): Promise<Field | undefined>
Parameters
- type: string
- field: string
Returns Promise<Field | undefined>
- Defined in packages/salesforce/src/salesforceSchemaService.ts:394

`Private`getMatchingField

getMatchingField(fields: Field[], name: string): Field | undefined
Parameters
- fields: Field[]
- name: string
Returns Field | undefined
- Defined in packages/salesforce/src/salesforceSchemaService.ts:278

getNameField

getNameField(type: string): Promise<string | undefined>
Retrieves the API name of the name field for a specific Salesforce object type.
Parameters
- type: string
  The API name of the Salesforce object type (e.g., 'Account', 'Contact')
Returns Promise<string | undefined>
A Promise that resolves to the API name of the name field, or undefined if no name field is found
Implementation of ISalesforceSchemaService.getNameField
- Defined in packages/salesforce/src/salesforceSchemaService.ts:338

getObjectDescribe

getObjectDescribe(
type: string,
): Promise<DescribeGlobalSObjectResult | undefined>
Gets the SObject describe for a given SObject type; returns undefined when the SObject is not accessible for the current user, this does not check if the SObject is actually defined but only if it's accessible through the describe API, this means that for objects that are not accessible for the current user this method will return undefined even when they are actually defined in the org.
Parameters
- type: string
  Type of SObject
Returns Promise<DescribeGlobalSObjectResult | undefined>
the SObject describe when the SObject is accessible for the current user otherwise undefined; when undefined is returned it can either mean that the SObject is not defined or that it's not accessible for the current user
- Defined in packages/salesforce/src/salesforceSchemaService.ts:101

getSObjectFields

getSObjectFields(type: string): Promise<ReadonlyMap<string, Field>>
Get list of immutable fields for an SObject
Parameters
- type: string
  SObject Type
Returns Promise<ReadonlyMap<string, Field>>
Implementation of ISalesforceSchemaService.getSObjectFields
- Defined in packages/salesforce/src/salesforceSchemaService.ts:317

getSObjectTypeById

getSObjectTypeById(id: string): Promise<DescribeGlobalSObjectResult>
Parameters
- id: string
Returns Promise<DescribeGlobalSObjectResult>
- Defined in packages/salesforce/src/salesforceSchemaService.ts:180

isSObjectAccessible

isSObjectAccessible(type: string): Promise<boolean>
Checks if the SObject is accessible for the current user; this does not check if the SObject is actually defined but only if it's accessible through the describe API, this means that for objects that are not accessible for the current user this method will return false even when they are actually defined in the org.
Parameters
- type: string
  Type of SObject
Returns Promise<boolean>
true when the SObject is accessible for the current user otherwise false; when false is returned it can either mean that the SObject is not defined or that it's not accessible for the current user
- Defined in packages/salesforce/src/salesforceSchemaService.ts:89

isSObjectDefined

isSObjectDefined(type: string): Promise<boolean>
Checks if the SObject is defined; similar describeSObject but does an extra check on the SObject definition through the tooling API
Parameters
- type: string
  Type of SObject
Returns Promise<boolean>
Implementation of ISalesforceSchemaService.isSObjectDefined
- Defined in packages/salesforce/src/salesforceSchemaService.ts:111

isSObjectFieldDefined

isSObjectFieldDefined(type: string, field: string): Promise<boolean>
Checks if the SObject Field is defined; similar describeSObjectField but does an extra check on the Field definition through the tooling API.
Parameters
- type: string
  Type of SObject
- field: string
  Name of the field
Returns Promise<boolean>
Implementation of ISalesforceSchemaService.isSObjectFieldDefined
- Defined in packages/salesforce/src/salesforceSchemaService.ts:124

sObjectGetFieldType

sObjectGetFieldType(type: string, fieldName: string): Promise<FieldType>
Get the field type of an SObject field in Salesforce
Parameters
- type: string
  SObject Type
- fieldName: string
  Field Name
Returns Promise<FieldType>
Implementation of ISalesforceSchemaService.sObjectGetFieldType
- Defined in packages/salesforce/src/salesforceSchemaService.ts:347
sObjectGetFieldType(
    type: string,
    fieldName: string,
    throwWhenNotFound: boolean,
): Promise<FieldType | undefined>
Get the field type of an SObject field in Salesforce
Parameters
- type: string
  SObject Type
- fieldName: string
  Field Name
- throwWhenNotFound: boolean
Returns Promise<FieldType | undefined>
Implementation of ISalesforceSchemaService.sObjectGetFieldType
- Defined in packages/salesforce/src/salesforceSchemaService.ts:348

sObjectHasField

sObjectHasField(type: string, fieldName: string): Promise<boolean>
Determines if an SObject has a particular field name.
Parameters
- type: string
  SObject Type
- fieldName: string
  Field Name
Returns Promise<boolean>
Implementation of ISalesforceSchemaService.sObjectHasField
- Defined in packages/salesforce/src/salesforceSchemaService.ts:328

toSalesforceField

toSalesforceField(type: string, path: string): Promise<string>
Transforms a property like Salesforce field to a valid Salesforce field or field path, for exampled transforms contract.account.name -> vlocity__cmt_Contract__c.Account.Name
Parameters
- type: string
  SOBject type
- path: string
  Full path of properties
Returns Promise<string>
Implementation of ISalesforceSchemaService.toSalesforceField
- Defined in packages/salesforce/src/salesforceSchemaService.ts:360

Class SalesforceSchemaService

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SalesforceSchemaService

Properties

Private ReadonlyconnectionProvider

Private ReadonlyfieldMatchingStrategies

Private Readonlylogger

Private ReadonlynsService

Private ReadonlyschemaAccess

Methods

describeByPrefix

Parameters

Returns Promise<DescribeSObjectResult | undefined>

describeCustomMetadataObjects

Returns Promise<string[]>

describePicklistValues

Parameters

Returns Promise<PicklistEntry[]>

Parameters

Returns Promise<PicklistEntry[] | undefined>

describeSObject

Parameters

Returns Promise<DescribeSObjectResult>

Parameters

Returns Promise<DescribeSObjectResult | undefined>

describeSObjectById

Parameters

Returns Promise<DescribeSObjectResult>

describeSObjectByPrefix

Parameters

Returns Promise<DescribeSObjectResult>

describeSObjectField

Parameters

Returns Promise<Field>

Parameters

Returns Promise<Field | undefined>

describeSObjectFieldPath

Parameters

Returns Promise<Field[]>

Parameters

Returns Promise<readonly Field[] | undefined>

describeSObjects

Returns Promise<DescribeGlobalSObjectResult[]>

dispose

Returns void

PrivateencodeIndexAsBitset

Parameters

Returns string

filterIds

Parameters

Returns Promise<string[]>

Example

PrivatefindSObjectField

Parameters

Returns Promise<Field | undefined>

PrivategetMatchingField

Parameters

Returns Field | undefined

getNameField

Parameters

Returns Promise<string | undefined>

getObjectDescribe

Parameters

Returns Promise<DescribeGlobalSObjectResult | undefined>

getSObjectFields

Parameters

Returns Promise<ReadonlyMap<string, Field>>

getSObjectTypeById

Parameters

Returns Promise<DescribeGlobalSObjectResult>

isSObjectAccessible

Parameters

Returns Promise<boolean>

`Private` `Readonly`connectionProvider

`Private` `Readonly`fieldMatchingStrategies

`Private` `Readonly`logger

`Private` `Readonly`nsService

`Private` `Readonly`schemaAccess

`Private`encodeIndexAsBitset

`Private`findSObjectField

`Private`getMatchingField