API Reference

interface FeedbackOptions {
    projectKey: string
    endpoint?: string
    message: string
    pageUrl?: string
    userEmail?: string
    meta?: Record<string, unknown>
    captchaToken?: string
    assets?: Array<{
        kind: 'image' | 'video'
        url: string
        size: number
    }>
}

interface FeedbackResponse {
    id: string
    status: 'received'
}

interface UseFeedbackReturn {
    submit: (options: SubmitOptions) => Promise<void>
    isSubmitting: boolean
    error: Error | null
    data: FeedbackResponse | null
    reset: () => void
}

async function submitFeedback(
    options: FeedbackOptions
): Promise<FeedbackResponse>

import { submitFeedback } from '@pullreque.st/button'

await submitFeedback({
  projectKey: 'prj_pk_YOUR_KEY',
  message: 'Great app!',
  userEmail: 'user@example.com',
  meta: { rating: 5 }
})

function createFeedbackClient(
    projectKey: string,
    endpoint?: string
): FeedbackClient

const client = createFeedbackClient('prj_pk_YOUR_KEY')

await client.submit({
  message: 'Bug report',
  meta: { page: '/checkout' }
})

function useFeedback(options?: UseFeedbackOptions): UseFeedbackReturn

import { useFeedback } from '@pullreque.st/button/react/headless'

function MyComponent() {
  const { submit, isSubmitting, error, data, reset } = useFeedback({
    onSuccess: (response) => {
      console.log('Feedback submitted!', response)
    },
    onError: (error) => {
      console.error('Submission failed:', error)
    },
    autoCaptureUrl: true
  })

  // Your implementation
}