Skip to content

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

Package listing

@kody/linear

src/get-issue.ts

50 lines · 1.7 KB · TypeScript
import { linearGraphql } from './client.ts'
import { ISSUE_FIELDS, mapIssue } from './models.ts'
import type { LinearAuthInput, LinearIssueSummary } from './types.ts'
import { optionalString, requireRecord, requireString } from './types.ts'
import { requireAuthMode } from './auth.ts'

export type GetIssueInput = LinearAuthInput & {
	/** Issue UUID or identifier (`ENG-123`). */
	id: string
}

/**
 * Get one Linear issue by UUID or identifier (`ENG-123`).
 * @example
 * import getIssue from 'kody:@kody/linear/get-issue'
 * const issue = await getIssue({ id: 'ENG-123' })
 */
export async function getIssue(input: GetIssueInput): Promise<LinearIssueSummary> {
	const id = requireString(input.id, 'id')
	const result = await linearGraphql<{ issue: unknown }>({
		...input,
		operation: 'query',
		query: `query GetIssue($id: String!) {
			issue(id: $id) { ${ISSUE_FIELDS} }
		}`,
		variables: { id },
	})
	if (!result.data.issue) throw new Error(`Linear issue not found: ${id}`)
	return mapIssue(result.data.issue)
}

/**
 * Get one Linear issue by UUID or identifier (`ENG-123`).
 * @example
 * import getIssue from 'kody:@kody/linear/get-issue'
 * const issue = await getIssue({ id: 'ENG-123' })
 */
export default async function getIssueEntrypoint(
	params: Partial<GetIssueInput> & Record<string, unknown> = {},
) {
	const input = requireRecord(params, 'get-issue')
	return getIssue({
		id: requireString(input.id, 'id'),
		integrationName: optionalString(input.integrationName, 'integrationName'),
		integration: optionalString(input.integration, 'integration'),
		account: optionalString(input.account, 'account'),
		secretName: optionalString(input.secretName, 'secretName'),
		auth: requireAuthMode(input.auth),
	})
}