import { figmaRequest } from './client.ts'
import { mapFileMeta } from './models.ts'
import { parseFileKey } from './setup.ts'
import type { FigmaAuthInput, FigmaFileMeta } from './types.ts'
import { optionalString, requireRecord } from './types.ts'
import { requireAuthMode } from './auth.ts'
export type GetFileMetaInput = FigmaAuthInput & {
/** File key, or a figma.com file/design/board URL. */
fileKey: string
}
/**
* Load Figma file metadata without the document tree. Needs `file_metadata:read`.
* @example
* import getFileMeta from 'kody:@kody/figma/get-file-meta'
* const meta = await getFileMeta({ fileKey: 'abc123' })
*/
export async function getFileMeta(input: GetFileMetaInput): Promise<FigmaFileMeta> {
const fileKey = parseFileKey(input.fileKey)
const result = await figmaRequest<unknown>({
...input,
operation: 'files.meta',
path: `/v1/files/${encodeURIComponent(fileKey)}/meta`,
})
return mapFileMeta(fileKey, result.body)
}
/**
* Load Figma file metadata without the document tree.
* @example
* import getFileMeta from 'kody:@kody/figma/get-file-meta'
* const meta = await getFileMeta({ fileKey: 'abc123' })
*/
export default async function getFileMetaEntrypoint(
params: Partial<GetFileMetaInput> & Record<string, unknown> = {},
) {
const input = requireRecord(params, 'get-file-meta')
return getFileMeta({
fileKey: String(input.fileKey ?? input.fileUrl ?? ''),
integrationName: optionalString(input.integrationName, 'integrationName'),
integration: optionalString(input.integration, 'integration'),
account: optionalString(input.account, 'account'),
secretName: optionalString(input.secretName, 'secretName'),
auth: requireAuthMode(input.auth),
})
}