Skip to content

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

Package listing

@kody/linear

src/list-projects.ts

75 lines · 2.4 KB · TypeScript
import { linearGraphql } from './client.ts'
import {
	mapProject,
	nodesFromConnection,
	pageInfoFromConnection,
	PAGE_INFO_FIELDS,
	PROJECT_FIELDS,
} from './models.ts'
import type { LinearAuthInput, LinearPageInfo, LinearProjectSummary } from './types.ts'
import { clampInt, optionalBoolean, optionalString, requireRecord } from './types.ts'
import { requireAuthMode } from './auth.ts'

export type ListProjectsInput = LinearAuthInput & {
	first?: number
	after?: string
	includeArchived?: boolean
}

export type ListProjectsResult = {
	items: Array<LinearProjectSummary>
	pageInfo: LinearPageInfo
}

/**
 * List Linear projects in the connected workspace.
 * @example
 * import listProjects from 'kody:@kody/linear/list-projects'
 * const { items } = await listProjects({ first: 25 })
 */
export async function listProjects(
	input: ListProjectsInput = {},
): Promise<ListProjectsResult> {
	const first = clampInt(input.first, 1, 50, 25)
	const result = await linearGraphql<{ projects: unknown }>({
		...input,
		operation: 'query',
		query: `query ListProjects($first: Int!, $after: String, $includeArchived: Boolean) {
			projects(first: $first, after: $after, includeArchived: $includeArchived) {
				${PAGE_INFO_FIELDS}
				nodes { ${PROJECT_FIELDS} }
			}
		}`,
		variables: {
			first,
			after: optionalString(input.after, 'after') ?? null,
			includeArchived: optionalBoolean(input.includeArchived, 'includeArchived') ?? false,
		},
	})
	return {
		items: nodesFromConnection(result.data.projects).map(mapProject),
		pageInfo: pageInfoFromConnection(result.data.projects),
	}
}

/**
 * List Linear projects in the connected workspace.
 * @example
 * import listProjects from 'kody:@kody/linear/list-projects'
 * const result = await listProjects()
 */
export default async function listProjectsEntrypoint(
	params: ListProjectsInput & Record<string, unknown> = {},
) {
	const input = requireRecord(params, 'list-projects')
	return listProjects({
		first: input.first as number | undefined,
		after: optionalString(input.after, 'after'),
		includeArchived: optionalBoolean(input.includeArchived, 'includeArchived'),
		integrationName: optionalString(input.integrationName, 'integrationName'),
		integration: optionalString(input.integration, 'integration'),
		account: optionalString(input.account, 'account'),
		secretName: optionalString(input.secretName, 'secretName'),
		auth: requireAuthMode(input.auth),
	})
}