Skip to content

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

Package listing

@kody/workos

src/list-users.ts

70 lines · 2.2 KB · TypeScript
import { workosRequest } from './client.ts'
import { mapUser } from './models.ts'
import type { WorkosAuthInput, WorkosPageInfo, WorkosUserSummary } from './types.ts'
import { clampInt, compactRecord, optionalString, requireRecord } from './types.ts'

export type ListUsersInput = WorkosAuthInput & {
	email?: string
	organizationId?: string
	limit?: number
	after?: string
	before?: string
	order?: 'asc' | 'desc'
}

export type ListUsersResult = {
	items: Array<WorkosUserSummary>
	pageInfo: WorkosPageInfo
}

/**
 * List AuthKit users in the API-key environment.
 * @example
 * import listUsers from 'kody:@kody/workos/list-users'
 * const { items } = await listUsers({ limit: 20 })
 */
export async function listUsers(input: ListUsersInput = {}): Promise<ListUsersResult> {
	const result = await workosRequest<Array<unknown>>({
		...input,
		operation: 'users.read',
		path: '/user_management/users',
		query: compactRecord({
			email: optionalString(input.email, 'email'),
			organization_id: optionalString(input.organizationId, 'organizationId'),
			limit: clampInt(input.limit, 1, 100, 10),
			after: optionalString(input.after, 'after'),
			before: optionalString(input.before, 'before'),
			order: optionalString(input.order, 'order'),
		}),
	})
	return {
		items: (Array.isArray(result.data) ? result.data : []).map(mapUser),
		pageInfo: result.pageInfo,
	}
}

/**
 * List AuthKit users in the API-key environment.
 * @example
 * import listUsers from 'kody:@kody/workos/list-users'
 * const result = await listUsers()
 */
export default async function listUsersEntrypoint(
	params: ListUsersInput & Record<string, unknown> = {},
) {
	const input = requireRecord(params, 'list-users')
	const order = optionalString(input.order, 'order')
	if (order !== undefined && order !== 'asc' && order !== 'desc') {
		throw new Error('order must be "asc" or "desc".')
	}
	return listUsers({
		email: optionalString(input.email, 'email'),
		organizationId: optionalString(input.organizationId, 'organizationId'),
		limit: input.limit as number | undefined,
		after: optionalString(input.after, 'after'),
		before: optionalString(input.before, 'before'),
		order,
		account: optionalString(input.account, 'account'),
		secretName: optionalString(input.secretName, 'secretName'),
	})
}