Class SalesforceService

constructor

• new SalesforceService(
      connectionProvider: SalesforceConnectionProvider,
      namespaceService: NamespaceService,
      queryService: QueryService,
      logger: Logger,
      fs: FileSystem,
  ): SalesforceService

  Parameters

  • connectionProvider: SalesforceConnectionProvider
  • namespaceService: NamespaceService
  • queryService: QueryService
  • logger: Logger
  • fs: FileSystem

  Returns SalesforceService

_batch

Readonlydeploy

Readonlylogs

ReadonlylookupService

Readonlyprofiles

Readonlyschema

batch

• get batch(): SalesforceBatchService

  Returns SalesforceBatchService

compileClasses

• compileClasses(apexClassBody: string[]): Promise<any>

  Compiles the specified class bodies on the server

  Parameters

  • apexClassBody: string[]

    APEX classes to compile

  Returns Promise<any>

delete

• delete(
      ids: Iterable<string | SObjectRecord>,
      chunkSize?: number,
  ): Promise<{ error?: string; id: string; success: boolean }[]>

  Delete one or more records by ID

  Parameters

  • ids: Iterable<string | SObjectRecord>

    list of IDs

  • chunkSize: number = 200

  Returns Promise<{ error?: string; id: string; success: boolean }[]>

deleteWhere

• deleteWhere(
      type: string,
      filter?: string | object | (string | object)[],
      chunkSize?: number,
  ): Promise<{ error?: string; id: string; success: boolean }[]>

  Delete one or more records based on a SOQL filter condition. Returns array of deleted record-ids

  Parameters

  • type: string

    SObject type to delete

  • Optionalfilter: string | object | (string | object)[]

    Object filter or where-conditional selecting the records to delete

  • chunkSize: number = 200

    Number of records to delete in a single call

  Returns Promise<{ error?: string; id: string; success: boolean }[]>

dispose

• dispose(): void

  Returns void

executeAnonymous

• executeAnonymous(
      apex: string,
      options?: { logLevels?: SoapDebuggingHeader; updateNamespace?: boolean },
  ): Promise<ExecuteAnonymousResult & { debugLog?: string }>

  Executes the specified APEX using the SOAP API and returns the result.

  Parameters

  • apex: string

    APEX code to execute

  • Optionaloptions: { logLevels?: SoapDebuggingHeader; updateNamespace?: boolean }

    • OptionallogLevels?: SoapDebuggingHeader

      Optional debug log levels to use

    • OptionalupdateNamespace?: boolean

      Replace namespace placeholders with the actual namespace

  Returns Promise<ExecuteAnonymousResult & { debugLog?: string }>

getApiVersion

• getApiVersion(): string

  Get the version of the current Salesforce connection

  Returns string

getApiVersions

• getApiVersions(count?: number): Promise<string[]>

  Get a list of available API version on the connected server

  Parameters

  • count: number = 10

  Returns Promise<string[]>

getConnectedUserInfo

• getConnectedUserInfo(): Promise<
      { id: string; profileId: any; type: string; username: string },
  >

  Gets basic details about the user for the current connection

  Returns Promise<{ id: string; profileId: any; type: string; username: string }>

getContentVersionData

• getContentVersionData(versionId: string): Promise<string>

  Get the content of the specified content version object based on the content version Id

  Parameters

  • versionId: string

    Content Version object Id

  Returns Promise<string>

getInstalledPackageDetails

• getInstalledPackageDetails(
      packageName: string | RegExp,
  ): Promise<
      | undefined
      | {
          id: string;
          name: string;
          namespace: undefined
          | string;
          version: string;
          versionName: string;
      },
  >

  Parameters

  • packageName: string | RegExp

  Returns Promise<
      | undefined
      | {
          id: string;
          name: string;
          namespace: undefined
          | string;
          version: string;
          versionName: string;
      },
  >

getInstalledPackageNamespace

• getInstalledPackageNamespace(packageName: string | RegExp): Promise<string>

  Parameters

  • packageName: string | RegExp

  Returns Promise<string>

getInstalledPackages

• getInstalledPackages(): Promise<
      {
          id: string;
          name: string;
          namespace: undefined
          | string;
          version: string;
          versionName: string;
      }[],
  >

  Returns Promise<
      {
          id: string;
          name: string;
          namespace: undefined
          | string;
          version: string;
          versionName: string;
      }[],
  >

getJsForceConnection

• getJsForceConnection(): Promise<SalesforceConnection>

  Returns Promise<SalesforceConnection>

getMetadataInfo

• getMetadataInfo(
      filePath: string | FileSystemUri,
  ): Promise<undefined | MetadataInfo>

  Get metadata info about any file; returns metadata type and name or undefined if the specified type is not a Metadata source.

  Parameters

  • filePath: string | FileSystemUri

    Source file path

  Returns Promise<undefined | MetadataInfo>

• getMetadataInfo(
      filePaths: (string | FileSystemUri)[],
  ): Promise<(undefined | MetadataInfo)[]>

  Get metadata info about any file; returns metadata type and name or undefined if the specified type is not a Metadata source.

  Parameters

  • filePaths: (string | FileSystemUri)[]

  Returns Promise<(undefined | MetadataInfo)[]>

getMetadataSetupUrl

• getMetadataSetupUrl(file: string): Promise<string>

  Parameters

  • file: string

  Returns Promise<string>

getMetadataType

• getMetadataType(type: string): undefined | MetadataType

  When the metadata type is a known metadata type return the type.

  Parameters

  • type: string

  Returns undefined | MetadataType

getMetadataTypes

• getMetadataTypes(): MetadataType[]

  Get the list of supported metadata types for the current organization merged with static metadata from the SFDX registry

  Returns MetadataType[]

getOrganizationDetails

• getOrganizationDetails(): Promise<OrganizationDetails>

  Returns Promise<OrganizationDetails>

getPageUrl

• getPageUrl(
      page: string,
      options?: { namespacePrefix?: string; useFrontdoor?: boolean },
  ): Promise<string>

  Parameters

  • page: string
  • Optionaloptions: { namespacePrefix?: string; useFrontdoor?: boolean }

  Returns Promise<string>

insert

• insert(
      type: string,
      records: { ref: string; values: any }[],
      cancelToken?: CancellationToken,
  ): AwaitableAsyncGenerator<BatchResultRecord>

  Insert one or more records into Salesforce; by default uses the standard collections api but switches to bulk API when there are more then 50 records to be inserted.

  Parameters

  • type: string

    Record types to insert

  • records: { ref: string; values: any }[]

    record data and references

  • OptionalcancelToken: CancellationToken

    optional cancellation token

  Returns AwaitableAsyncGenerator<BatchResultRecord>

  Remarks

  For more control ove the operation users can also directly create a record batch offering more control.

isPackageInstalled

• isPackageInstalled(packageName: string | RegExp): Promise<boolean>

  Parameters

  • packageName: string | RegExp

  Returns Promise<boolean>

isProductionOrg

• isProductionOrg(): Promise<boolean>

  Returns Promise<boolean>

listStaticResources

• listStaticResources(
      resourceName: string,
      filter?: { contentType?: string; namespace?: string },
  ): Promise<
      {
          getBody: (this: any) => Promise<Buffer<ArrayBufferLike>>;
          id: any;
          name: any;
          namespace: any;
          size: any;
      }[],
  >

  Get all static resources matching the specified name, the body of the resource is retrieved when required. The body of the static resource is cached

  Parameters

  • resourceName: string

    Name of the static resource

  • Optionalfilter: { contentType?: string; namespace?: string }

  Returns Promise<
      {
          getBody: (this: any) => Promise<Buffer<ArrayBufferLike>>;
          id: any;
          name: any;
          namespace: any;
          size: any;
      }[],
  >

loadProfilesFromDisk

• loadProfilesFromDisk(): Promise<{ file: string; profile: SalesforceProfile }[]>

  Load all known Salesforce profiles in the current workspace with the *.profile-meta.xml and the *.profile extension from the file system

  Returns Promise<{ file: string; profile: SalesforceProfile }[]>

lookup

• lookup<T extends object, K extends PropertyKey = keyof T>(
      type: string,
      filter?: string | T | (string | T)[],
      lookupFields?: "all" | K[],
      limit?: number,
      useCache?: boolean,
  ): Promise<QueryResult<T, K>[]>

  Query multiple records based on the where condition. The filter condition can either be a string or a complex filter object.

  Type Parameters

  • T extends object
  • K extends PropertyKey = keyof T

  Parameters

  • type: string

    SObject type

  • Optionalfilter: string | T | (string | T)[]

    Object filter or Where conditional string

  • OptionallookupFields: "all" | K[]

    fields to lookup on the record

  • Optionallimit: number

    limit the number of results

  • OptionaluseCache: boolean

    use the query cache

  Returns Promise<QueryResult<T, K>[]>

query

• query<T extends Partial<SObjectRecord>>(
      query: string,
      useCache?: boolean,
  ): Promise<T[]>

  Returns a list of records. All records are mapped to record proxy object

  Type Parameters

  • T extends Partial<SObjectRecord>

  Parameters

  • query: string

    SOQL Query to execute

  • OptionaluseCache: boolean

  Returns Promise<T[]>

requestApexRemote

• requestApexRemote(
      page: string,
      action: string,
      method: HttpMethod,
      data: any,
  ): Promise<any>

  Parameters

  • page: string

    Name of the APEX page which exposes the requested class/controller

  • action: string

    Name of the class including namespace when a namespace is required

  • method: HttpMethod

    Name of the method to call on the controller

  • data: any

    Data to pass to the controller

  Returns Promise<any>

update

• update(
      type: string,
      records: { id: string; [key: string]: unknown }[],
      options?: Partial<
          { bulkApiThreshold: number; chunkSize: number; useBulkApi: boolean },
      > & { cancelToken?: CancellationToken },
  ): AwaitableAsyncGenerator<BatchResultRecord>

  Update one or more records in Salesforce using the ID field as foreign key; by default uses the standard collections api but switches to bulk API when there.

  Parameters

  • type: string

    Record types to updated; all data should have an ID field

  • records: { id: string; [key: string]: unknown }[]

    record data and references

  • Optionaloptions: Partial<{ bulkApiThreshold: number; chunkSize: number; useBulkApi: boolean }> & {
        cancelToken?: CancellationToken;
    }

    Optional record batch options

    • cancelToken

      Optional cancellation token

    • OptionalcancelToken?: CancellationToken

      Optional cancellation token

  Returns AwaitableAsyncGenerator<BatchResultRecord>

  Remarks

  For more control ove the operation users can also directly create a record batch offering more control.

updateNamespace

• updateNamespace(value: string): string

  Updates the namespace used for Salesforce operations.

  Parameters

  • value: string

    The new namespace value to set

  Returns string

  A promise that resolves when the namespace has been updated