Skip to content

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

Package listing

@kody/asana

src/list-workspaces.ts

62 lines · 2.0 KB · TypeScript
import { asanaRequest } from './client.ts'
import { mapWorkspace, WORKSPACE_FIELDS } from './models.ts'
import type { AsanaAuthInput, AsanaPageInfo, AsanaWorkspaceSummary } from './types.ts'
import { clampInt, compactRecord, optionalString, requireRecord } from './types.ts'
import { requireAuthMode } from './auth.ts'

export type ListWorkspacesInput = AsanaAuthInput & {
	limit?: number
	offset?: string
}

export type ListWorkspacesResult = {
	items: Array<AsanaWorkspaceSummary>
	pageInfo: AsanaPageInfo
}

/**
 * List Asana workspaces visible to the authorizing user.
 * @example
 * import listWorkspaces from 'kody:@kody/asana/list-workspaces'
 * const { items } = await listWorkspaces({ limit: 25 })
 */
export async function listWorkspaces(
	input: ListWorkspacesInput = {},
): Promise<ListWorkspacesResult> {
	const limit = clampInt(input.limit, 1, 100, 25)
	const result = await asanaRequest<Array<unknown>>({
		...input,
		operation: 'workspaces.read',
		path: '/workspaces',
		query: compactRecord({
			limit,
			offset: optionalString(input.offset, 'offset'),
			opt_fields: WORKSPACE_FIELDS,
		}),
	})
	return {
		items: (Array.isArray(result.data) ? result.data : []).map(mapWorkspace),
		pageInfo: result.pageInfo,
	}
}

/**
 * List Asana workspaces visible to the authorizing user.
 * @example
 * import listWorkspaces from 'kody:@kody/asana/list-workspaces'
 * const result = await listWorkspaces()
 */
export default async function listWorkspacesEntrypoint(
	params: ListWorkspacesInput & Record<string, unknown> = {},
) {
	const input = requireRecord(params, 'list-workspaces')
	return listWorkspaces({
		limit: input.limit as number | undefined,
		offset: optionalString(input.offset, 'offset'),
		integrationName: optionalString(input.integrationName, 'integrationName'),
		integration: optionalString(input.integration, 'integration'),
		account: optionalString(input.account, 'account'),
		secretName: optionalString(input.secretName, 'secretName'),
		auth: requireAuthMode(input.auth),
	})
}