import { workosRequest } from './client.ts'
import { mapDirectoryUser } from './models.ts'
import type { WorkosAuthInput, WorkosDirectoryUserSummary, WorkosPageInfo } from './types.ts'
import { clampInt, compactRecord, optionalString, requireRecord, requireString } from './types.ts'
export type ListDirectoryUsersInput = WorkosAuthInput & {
directory: string
limit?: number
after?: string
before?: string
order?: 'asc' | 'desc'
}
export type ListDirectoryUsersResult = {
items: Array<WorkosDirectoryUserSummary>
pageInfo: WorkosPageInfo
}
/**
* List users synced from one WorkOS directory.
* @example
* import listDirectoryUsers from 'kody:@kody/workos/list-directory-users'
* const { items } = await listDirectoryUsers({ directory: 'directory_01EXAMPLE' })
*/
export async function listDirectoryUsers(
input: ListDirectoryUsersInput,
): Promise<ListDirectoryUsersResult> {
const result = await workosRequest<Array<unknown>>({
...input,
operation: 'directories.read',
path: '/directory_users',
query: compactRecord({
directory: requireString(input.directory, 'directory'),
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(mapDirectoryUser),
pageInfo: result.pageInfo,
}
}
/**
* List users synced from one WorkOS directory.
* @example
* import listDirectoryUsers from 'kody:@kody/workos/list-directory-users'
* const result = await listDirectoryUsers({ directory: 'directory_01EXAMPLE' })
*/
export default async function listDirectoryUsersEntrypoint(
params: Partial<ListDirectoryUsersInput> & Record<string, unknown> = {},
) {
const input = requireRecord(params, 'list-directory-users')
const order = optionalString(input.order, 'order')
if (order !== undefined && order !== 'asc' && order !== 'desc') {
throw new Error('order must be "asc" or "desc".')
}
return listDirectoryUsers({
directory: requireString(input.directory, 'directory'),
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'),
})
}