Files
simstudioai--sim/apps/sim/tools/wordpress/list_users.ts
T
wehub-resource-sync d25d482dc2
Publish CLI Package / publish-npm (push) Waiting to run
Publish Python SDK / publish-pypi (push) Waiting to run
Publish TypeScript SDK / publish-npm (push) Waiting to run
CI / Migrate Dev DB (push) Has been skipped
CI / Detect Version (push) Has been cancelled
CI / Migrate DB (push) Has been cancelled
CI / Build Dev ECR (./docker/app.Dockerfile, ECR_APP) (push) Has been cancelled
CI / Build Dev ECR (./docker/db.Dockerfile, ECR_MIGRATIONS) (push) Has been cancelled
CI / Build Dev ECR (./docker/pii.Dockerfile, ECR_PII) (push) Has been cancelled
CI / Build Dev ECR (./docker/realtime.Dockerfile, ECR_REALTIME) (push) Has been cancelled
CI / Deploy Trigger.dev (Dev) (push) Has been cancelled
CI / Build AMD64 (./docker/app.Dockerfile, ECR_APP, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build AMD64 (./docker/db.Dockerfile, ECR_MIGRATIONS, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build AMD64 (./docker/pii.Dockerfile, ECR_PII, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build AMD64 (./docker/realtime.Dockerfile, ECR_REALTIME, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/app.Dockerfile, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/db.Dockerfile, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/pii.Dockerfile, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/realtime.Dockerfile, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Check Docs Changes (push) Has been cancelled
CI / Process Docs (push) Has been cancelled
CI / Create GitHub Release (push) Has been cancelled
CI / Test and Build (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:20:55 +08:00

144 lines
4.4 KiB
TypeScript

import type { ToolConfig } from '@/tools/types'
import {
WORDPRESS_COM_API_BASE,
type WordPressListUsersParams,
type WordPressListUsersResponse,
} from '@/tools/wordpress/types'
export const listUsersTool: ToolConfig<WordPressListUsersParams, WordPressListUsersResponse> = {
id: 'wordpress_list_users',
name: 'WordPress List Users',
description: 'List users from WordPress.com (requires admin privileges)',
version: '1.0.0',
oauth: {
required: true,
provider: 'wordpress',
requiredScopes: ['global'],
},
params: {
siteId: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description: 'WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)',
},
perPage: {
type: 'number',
required: false,
visibility: 'user-or-llm',
description: 'Number of users per request (e.g., 10, 25, 50). Default: 10, max: 100',
},
page: {
type: 'number',
required: false,
visibility: 'user-or-llm',
description: 'Page number for pagination (e.g., 1, 2, 3)',
},
search: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Search term to filter users (e.g., "john", "admin")',
},
roles: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Comma-separated role names to filter by (e.g., "administrator,editor")',
},
order: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Order direction: asc or desc',
},
},
request: {
url: (params) => {
const queryParams = new URLSearchParams()
if (params.perPage) queryParams.append('per_page', String(params.perPage))
if (params.page) queryParams.append('page', String(params.page))
if (params.search) queryParams.append('search', params.search)
if (params.roles) queryParams.append('roles', params.roles)
if (params.order) queryParams.append('order', params.order)
const queryString = queryParams.toString()
return `${WORDPRESS_COM_API_BASE}/${params.siteId}/users${queryString ? `?${queryString}` : ''}`
},
method: 'GET',
headers: (params) => ({
'Content-Type': 'application/json',
Authorization: `Bearer ${params.accessToken}`,
}),
},
transformResponse: async (response: Response) => {
if (!response.ok) {
const error = await response.json().catch(() => ({}))
throw new Error(error.message || `WordPress API error: ${response.status}`)
}
const data = await response.json()
const total = Number.parseInt(response.headers.get('X-WP-Total') || '0', 10)
const totalPages = Number.parseInt(response.headers.get('X-WP-TotalPages') || '0', 10)
return {
success: true,
output: {
users: data.map((user: any) => ({
id: user.id,
username: user.username,
name: user.name,
first_name: user.first_name,
last_name: user.last_name,
email: user.email,
url: user.url,
description: user.description,
link: user.link,
slug: user.slug,
roles: user.roles || [],
avatar_urls: user.avatar_urls,
})),
total,
totalPages,
},
}
},
outputs: {
users: {
type: 'array',
description: 'List of users',
items: {
type: 'object',
properties: {
id: { type: 'number', description: 'User ID' },
username: { type: 'string', description: 'Username' },
name: { type: 'string', description: 'Display name' },
first_name: { type: 'string', description: 'First name' },
last_name: { type: 'string', description: 'Last name' },
email: { type: 'string', description: 'Email address' },
url: { type: 'string', description: 'User website URL' },
description: { type: 'string', description: 'User bio' },
link: { type: 'string', description: 'Author archive URL' },
slug: { type: 'string', description: 'User slug' },
roles: { type: 'array', description: 'User roles' },
avatar_urls: { type: 'object', description: 'Avatar URLs at different sizes' },
},
},
},
total: {
type: 'number',
description: 'Total number of users',
},
totalPages: {
type: 'number',
description: 'Total number of result pages',
},
},
}