/** * @fileoverview Shared Asana types: `JsonRecord`, `AsanaAuthMode`, `AsanaAuthInput`, `AsanaNamedRef`, `AsanaPageInfo`, `AsanaWorkspaceSummary`, `AsanaProjectSummary`, `AsanaTaskSummary`, and related shapes. * Import from `kody:@kody/asana/types` when typing Asana helpers. Default export returns a type-name catalog. * * @example * import { type AsanaAuthMode } from 'kody:@kody/asana/types' */ export type JsonRecord = Record export type AsanaAuthMode = 'oauth' | 'pat' export type AsanaAuthInput = { /** Saved OAuth integration name. Defaults to `asana`. */ integrationName?: string /** Alias of `integrationName`. */ integration?: string /** * Short account alias. `work` → `asana-work`. Values that already start * with `asana-` are used as-is. `default` / `asana` / omitted → `asana`. */ account?: string /** User secret name for a personal access token. Defaults to `asanaPat`. */ secretName?: string /** Force OAuth or PAT auth when both exist. */ auth?: AsanaAuthMode } export type AsanaNamedRef = { gid: string name: string } export type AsanaPageInfo = { hasNextPage: boolean nextOffset: string | null } export type AsanaWorkspaceSummary = { gid: string name: string isOrganization: boolean | null } export type AsanaProjectSummary = { gid: string name: string archived: boolean | null permalinkUrl: string | null notes: string | null color: string | null workspace: AsanaNamedRef | null team: AsanaNamedRef | null createdAt: string | null modifiedAt: string | null } export type AsanaTaskSummary = { gid: string name: string completed: boolean | null permalinkUrl: string | null notes: string | null dueOn: string | null dueAt: string | null assignee: AsanaNamedRef | null workspace: AsanaNamedRef | null projects: Array parent: AsanaNamedRef | null createdAt: string | null modifiedAt: string | null } export type AsanaStorySummary = { gid: string text: string | null type: string | null resourceSubtype: string | null createdAt: string | null createdBy: AsanaNamedRef | null } export type DryRunResult = { dryRun: true wouldCall: T } /** * Shared Asana types and parsing helpers for this package. * Import from `kody:@kody/asana/types` when typing other Asana exports. * * @returns Catalog of exported type/helper names for agent discovery. * * @example * import types from 'kody:@kody/asana/types' * const catalog = await types() */ export function requireRecord(value: unknown, label: string): JsonRecord { if (!value || typeof value !== 'object' || Array.isArray(value)) { throw new Error(`${label} must be an object.`) } return value as JsonRecord } export function requireString( value: unknown, label: string, options: { allowEmpty?: boolean } = {}, ): string { if (typeof value !== 'string' || (!options.allowEmpty && value.trim().length === 0)) { throw new Error( `${label} must be ${options.allowEmpty ? 'a string' : 'a non-empty string'}.`, ) } return options.allowEmpty ? value : value.trim() } export function optionalString(value: unknown, label: string): string | undefined { if (value === undefined || value === null) return undefined return requireString(value, label) } export function optionalBoolean(value: unknown, label: string): boolean | undefined { if (value === undefined) return undefined if (typeof value !== 'boolean') throw new Error(`${label} must be a boolean.`) return value } export function optionalStringArray(value: unknown, label: string): Array | undefined { if (value === undefined || value === null) return undefined if (!Array.isArray(value)) throw new Error(`${label} must be an array of strings.`) return value.map((item, index) => requireString(item, `${label}[${index}]`)) } export function clampInt( value: unknown, min: number, max: number, fallback: number, label = 'limit', ): number { if (value === undefined || value === null) return fallback if (typeof value !== 'number' || !Number.isInteger(value)) { throw new Error(`${label} must be an integer.`) } if (value < min || value > max) { throw new Error(`${label} must be between ${min} and ${max}.`) } return value } export function compactRecord(value: T): T { const output: JsonRecord = {} for (const [key, item] of Object.entries(value)) { if (item === undefined) continue output[key] = item } return output as T } /** * Shared Asana types for this package: `JsonRecord`, `AsanaAuthMode`, `AsanaAuthInput`, `AsanaNamedRef`, `AsanaPageInfo`, `AsanaWorkspaceSummary`, `AsanaProjectSummary`, `AsanaTaskSummary`, and related shapes. * Import from `kody:@kody/asana/types` when typing Asana helpers without pulling runtime clients. * * @returns Catalog of exported type names for agent discovery. * * @example * import types from 'kody:@kody/asana/types' * const catalog = await types() */ export default async function typesOverview() { return { auth: ['AsanaAuthInput', 'AsanaAuthMode'], models: [ 'AsanaWorkspaceSummary', 'AsanaProjectSummary', 'AsanaTaskSummary', 'AsanaStorySummary', ], } }