Skip to content

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

Package listing

@kody/asana

src/list-stories.ts

66 lines · 2.1 KB · TypeScript
import { asanaRequest } from './client.ts'
import { mapStory, STORY_FIELDS } from './models.ts'
import type { AsanaAuthInput, AsanaPageInfo, AsanaStorySummary } from './types.ts'
import { clampInt, compactRecord, optionalString, requireRecord, requireString } from './types.ts'
import { requireAuthMode } from './auth.ts'

export type ListStoriesInput = AsanaAuthInput & {
	/** Task GID whose stories/comments to list. */
	taskGid: string
	limit?: number
	offset?: string
}

export type ListStoriesResult = {
	taskGid: string
	items: Array<AsanaStorySummary>
	pageInfo: AsanaPageInfo
}

/**
 * List stories and comments on an Asana task.
 * @example
 * import listStories from 'kody:@kody/asana/list-stories'
 * const { items } = await listStories({ taskGid: '123' })
 */
export async function listStories(input: ListStoriesInput): Promise<ListStoriesResult> {
	const taskGid = requireString(input.taskGid, 'taskGid')
	const limit = clampInt(input.limit, 1, 100, 25)
	const result = await asanaRequest<Array<unknown>>({
		...input,
		operation: 'stories.read',
		path: `/tasks/${encodeURIComponent(taskGid)}/stories`,
		query: compactRecord({
			limit,
			offset: optionalString(input.offset, 'offset'),
			opt_fields: STORY_FIELDS,
		}),
	})
	return {
		taskGid,
		items: (Array.isArray(result.data) ? result.data : []).map(mapStory),
		pageInfo: result.pageInfo,
	}
}

/**
 * List stories and comments on an Asana task.
 * @example
 * import listStories from 'kody:@kody/asana/list-stories'
 * const result = await listStories({ taskGid: '123' })
 */
export default async function listStoriesEntrypoint(
	params: Partial<ListStoriesInput> & Record<string, unknown> = {},
) {
	const input = requireRecord(params, 'list-stories')
	return listStories({
		taskGid: requireString(input.taskGid, 'taskGid'),
		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),
	})
}