simstudioai--sim/apps/sim/tools/vercel/create_check.ts

import type { ToolConfig } from '@/tools/types'
import type { VercelCheckResponse, VercelCreateCheckParams } from '@/tools/vercel/types'

export const vercelCreateCheckTool: ToolConfig<VercelCreateCheckParams, VercelCheckResponse> = {
  id: 'vercel_create_check',
  name: 'Vercel Create Check',
  description: 'Create a new deployment check',
  version: '1.0.0',

  params: {
    apiKey: {
      type: 'string',
      required: true,
      visibility: 'user-only',
      description: 'Vercel Access Token',
    },
    deploymentId: {
      type: 'string',
      required: true,
      visibility: 'user-or-llm',
      description: 'Deployment ID to create the check for',
    },
    name: {
      type: 'string',
      required: true,
      visibility: 'user-or-llm',
      description: 'Name of the check (max 100 characters)',
    },
    blocking: {
      type: 'boolean',
      required: true,
      visibility: 'user-or-llm',
      description: 'Whether the check blocks the deployment',
    },
    path: {
      type: 'string',
      required: false,
      visibility: 'user-or-llm',
      description: 'Page path being checked',
    },
    detailsUrl: {
      type: 'string',
      required: false,
      visibility: 'user-or-llm',
      description: 'URL with details about the check',
    },
    externalId: {
      type: 'string',
      required: false,
      visibility: 'user-or-llm',
      description: 'External identifier for the check',
    },
    rerequestable: {
      type: 'boolean',
      required: false,
      visibility: 'user-or-llm',
      description: 'Whether the check can be rerequested',
    },
    teamId: {
      type: 'string',
      required: false,
      visibility: 'user-or-llm',
      description: 'Team ID to scope the request',
    },
    slug: {
      type: 'string',
      required: false,
      visibility: 'user-or-llm',
      description: 'Team slug to scope the request (alternative to teamId)',
    },
  },

  request: {
    url: (params: VercelCreateCheckParams) => {
      const query = new URLSearchParams()
      if (params.teamId) query.set('teamId', params.teamId.trim())
      if (params.slug) query.set('slug', params.slug.trim())
      const qs = query.toString()
      return `https://api.vercel.com/v1/deployments/${params.deploymentId.trim()}/checks${qs ? `?${qs}` : ''}`
    },
    method: 'POST',
    headers: (params: VercelCreateCheckParams) => ({
      Authorization: `Bearer ${params.apiKey}`,
      'Content-Type': 'application/json',
    }),
    body: (params: VercelCreateCheckParams) => {
      const body: Record<string, unknown> = {
        name: params.name.trim(),
        blocking: params.blocking,
      }
      if (params.path) body.path = params.path
      if (params.detailsUrl) body.detailsUrl = params.detailsUrl
      if (params.externalId) body.externalId = params.externalId
      if (params.rerequestable !== undefined) body.rerequestable = params.rerequestable
      return body
    },
  },

  transformResponse: async (response: Response) => {
    const data = await response.json()
    return {
      success: true,
      output: {
        id: data.id,
        name: data.name,
        status: data.status ?? 'registered',
        conclusion: data.conclusion ?? null,
        blocking: data.blocking ?? false,
        deploymentId: data.deploymentId,
        integrationId: data.integrationId ?? null,
        externalId: data.externalId ?? null,
        detailsUrl: data.detailsUrl ?? null,
        path: data.path ?? null,
        rerequestable: data.rerequestable ?? false,
        createdAt: data.createdAt,
        updatedAt: data.updatedAt,
        startedAt: data.startedAt ?? null,
        completedAt: data.completedAt ?? null,
        output: data.output ?? null,
      },
    }
  },

  outputs: {
    id: { type: 'string', description: 'Check ID' },
    name: { type: 'string', description: 'Check name' },
    status: { type: 'string', description: 'Check status: registered, running, or completed' },
    conclusion: {
      type: 'string',
      description: 'Check conclusion: canceled, failed, neutral, succeeded, skipped, or stale',
      optional: true,
    },
    blocking: { type: 'boolean', description: 'Whether the check blocks the deployment' },
    deploymentId: { type: 'string', description: 'Associated deployment ID' },
    integrationId: { type: 'string', description: 'Associated integration ID', optional: true },
    externalId: { type: 'string', description: 'External identifier', optional: true },
    detailsUrl: { type: 'string', description: 'URL with details about the check', optional: true },
    path: { type: 'string', description: 'Page path being checked', optional: true },
    rerequestable: { type: 'boolean', description: 'Whether the check can be rerequested' },
    createdAt: { type: 'number', description: 'Creation timestamp in milliseconds' },
    updatedAt: { type: 'number', description: 'Last update timestamp in milliseconds' },
    startedAt: { type: 'number', description: 'Start timestamp in milliseconds', optional: true },
    completedAt: {
      type: 'number',
      description: 'Completion timestamp in milliseconds',
      optional: true,
    },
    output: {
      type: 'json',
      description:
        'Check result output including metrics (FCP, LCP, CLS, TBT, virtualExperienceScore)',
      optional: true,
    },
  },
}