Skip to content

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

Package listing

@kody/linear

src/list-issues.ts

110 lines · 3.6 KB · TypeScript
import { linearGraphql } from './client.ts'
import { buildIssueFilter } from './filters.ts'
import {
	ISSUE_FIELDS,
	mapIssue,
	nodesFromConnection,
	pageInfoFromConnection,
	PAGE_INFO_FIELDS,
} from './models.ts'
import type {
	LinearAuthInput,
	LinearIssueSummary,
	LinearPageInfo,
	WorkflowStateType,
} from './types.ts'
import {
	clampInt,
	optionalBoolean,
	optionalString,
	optionalWorkflowStateType,
	requireRecord,
} from './types.ts'
import { requireAuthMode } from './auth.ts'

export type ListIssuesInput = LinearAuthInput & {
	first?: number
	after?: string
	includeArchived?: boolean
	teamId?: string
	teamKey?: string
	projectId?: string
	assigneeId?: string
	stateId?: string
	stateType?: WorkflowStateType
	/** Case-insensitive title contains filter. */
	query?: string
}

export type ListIssuesResult = {
	items: Array<LinearIssueSummary>
	pageInfo: LinearPageInfo
}

/**
 * List Linear issues with optional team, project, assignee, and state filters.
 * @example
 * import listIssues from 'kody:@kody/linear/list-issues'
 * const { items } = await listIssues({ teamKey: 'ENG', stateType: 'started', first: 20 })
 */
export async function listIssues(input: ListIssuesInput = {}): Promise<ListIssuesResult> {
	const first = clampInt(input.first, 1, 50, 25)
	const filter = buildIssueFilter({
		teamId: optionalString(input.teamId, 'teamId'),
		teamKey: optionalString(input.teamKey, 'teamKey'),
		projectId: optionalString(input.projectId, 'projectId'),
		assigneeId: optionalString(input.assigneeId, 'assigneeId'),
		stateId: optionalString(input.stateId, 'stateId'),
		stateType: optionalWorkflowStateType(input.stateType),
		query: optionalString(input.query, 'query'),
	})
	const result = await linearGraphql<{ issues: unknown }>({
		...input,
		operation: 'query',
		query: `query ListIssues($first: Int!, $after: String, $filter: IssueFilter, $includeArchived: Boolean) {
			issues(first: $first, after: $after, filter: $filter, includeArchived: $includeArchived) {
				${PAGE_INFO_FIELDS}
				nodes { ${ISSUE_FIELDS} }
			}
		}`,
		variables: {
			first,
			after: optionalString(input.after, 'after') ?? null,
			filter: filter ?? null,
			includeArchived: optionalBoolean(input.includeArchived, 'includeArchived') ?? false,
		},
	})
	return {
		items: nodesFromConnection(result.data.issues).map(mapIssue),
		pageInfo: pageInfoFromConnection(result.data.issues),
	}
}

/**
 * List Linear issues with optional team, project, assignee, and state filters.
 * @example
 * import listIssues from 'kody:@kody/linear/list-issues'
 * const result = await listIssues({ teamKey: 'ENG' })
 */
export default async function listIssuesEntrypoint(
	params: ListIssuesInput & Record<string, unknown> = {},
) {
	const input = requireRecord(params, 'list-issues')
	return listIssues({
		first: input.first as number | undefined,
		after: optionalString(input.after, 'after'),
		includeArchived: optionalBoolean(input.includeArchived, 'includeArchived'),
		teamId: optionalString(input.teamId, 'teamId'),
		teamKey: optionalString(input.teamKey, 'teamKey'),
		projectId: optionalString(input.projectId, 'projectId'),
		assigneeId: optionalString(input.assigneeId, 'assigneeId'),
		stateId: optionalString(input.stateId, 'stateId'),
		stateType: optionalWorkflowStateType(input.stateType),
		query: optionalString(input.query, 'query'),
		integrationName: optionalString(input.integrationName, 'integrationName'),
		integration: optionalString(input.integration, 'integration'),
		account: optionalString(input.account, 'account'),
		secretName: optionalString(input.secretName, 'secretName'),
		auth: requireAuthMode(input.auth),
	})
}