@kody/salesforce

Salesforce REST helpers for identity, SOQL, multi-org routing, and error investigation.

src/get-user-info.ts

22 lines · 832 B · TypeScript

import { fetchUserInfo } from './request.ts'
import type { SalesforceUserInfo } from './types.ts'
import { optionalString, requireRecord } from './types.ts'

export type GetUserInfoInput = {
	/** Saved OAuth integration name. Defaults to `salesforce`. */
	integrationName?: string
}

/**
 * Return identity details for the connected Salesforce user and org.
 * @example
 * import getUserInfo from 'kody:@kody/salesforce/get-user-info'
 * const user = await getUserInfo()
 * // Multi-org: await getUserInfo({ integrationName: 'salesforce-sandbox' })
 */
export default async function getUserInfo(
	params: Partial<GetUserInfoInput> & Record<string, unknown> = {},
): Promise<SalesforceUserInfo> {
	const input = requireRecord(params, 'get-user-info')
	return fetchUserInfo(optionalString(input.integrationName, 'integrationName'))
}