Skip to content

Built for people who want to own their automations. Join the waitlist for an invite.

Package listing

@kody/figma

src/viewer.ts

45 lines · 1.4 KB · TypeScript
import { figmaRequest } from './client.ts'
import { mapUser } from './models.ts'
import type { FigmaAuthInput, FigmaUserRef } from './types.ts'
import { optionalString, requireRecord } from './types.ts'
import { requireAuthMode } from './auth.ts'

export type FigmaViewer = FigmaUserRef

export type ViewerInput = FigmaAuthInput

/**
 * Return the authenticated Figma user (no email).
 * @example
 * import getViewer from 'kody:@kody/figma/viewer'
 * const viewer = await getViewer()
 */
export async function getViewer(input: ViewerInput = {}): Promise<FigmaViewer> {
	const result = await figmaRequest<unknown>({
		...input,
		operation: 'users.read',
		path: '/v1/me',
	})
	const viewer = mapUser(result.body)
	if (!viewer) throw new Error('Figma /v1/me did not return a user id.')
	return viewer
}

/**
 * Return the authenticated Figma user (no email).
 * @example
 * import getViewer from 'kody:@kody/figma/viewer'
 * const viewer = await getViewer({ integrationName: 'figma-work' })
 */
export default async function viewerEntrypoint(
	params: ViewerInput & Record<string, unknown> = {},
) {
	const input = requireRecord(params, 'viewer')
	return getViewer({
		integrationName: optionalString(input.integrationName, 'integrationName'),
		integration: optionalString(input.integration, 'integration'),
		account: optionalString(input.account, 'account'),
		secretName: optionalString(input.secretName, 'secretName'),
		auth: requireAuthMode(input.auth),
	})
}