@bugfreedback/bugfreedback

bugfreedback

Nuxt feedback widget with screen capture, annotation, pluggable screenshot storage (GCS / S3), and modular export adapters (GitHub, Linear, Jira, Notion, Slack, Asana, Trello, Webhook, IFTTT).

• Package: @bugfreedback/bugfreedback
• Docs: https://bugfreedback.github.io/bugfreedback/
• Repo: bugfreedback/bugfreedback

Quick start

Install the module and its peer dependency:

npm install @bugfreedback/bugfreedback @nuxt/ui

// nuxt.config.ts
export default defineNuxtConfig({
  modules: ['@nuxt/ui', '@bugfreedback/bugfreedback'],
  bugfreedback: {
    enabled: true,
    storage: { provider: 'gcs', bucket: process.env.BUGFREEDBACK_GCS_BUCKET! },
    export: {
      provider: 'github',
      token: process.env.BUGFREEDBACK_GITHUB_TOKEN!,
      owner: 'your-org',
      repo: 'your-repo',
    },
  },
})

<!-- layouts/default.vue -->
<template>
  <div>
    <slot />
    <BugfreedbackHost />
  </div>
</template>

See the getting started guide for theming and the full adapter catalog.

Integration

Submit API

The module registers POST /api/_bugfreedback/submit (override with submitPath). The widget uploads an optional screenshot to your configured storage adapter, then routes the report through your export adapter (GitHub Issue, Linear, Slack, custom webhook, etc.).

Runtime secrets

Adapter credentials can be set in nuxt.config.ts or injected at runtime via environment variables (useful for containers and CI/CD where secrets should not be baked into the build):

Leave token / bucket empty in config when relying on runtime injection; the submit handler resolves secrets from process.env on each request.

Auth hooks

bugfreedback does not validate JWTs itself. Host apps wire their own auth:

Client — set auth: 'required' and provide a token accessor:

export default defineNuxtPlugin(() => {
  provideBugfreedbackAuth({
    getToken: () => myAuth.getToken(),
    getUser: () => myAuth.user.value,
  })
})

The widget sends Authorization: Bearer <token> when a token is available.

Server — add Nitro middleware on the submit route that validates the Bearer token and sets reporter context:

// event.context.bugfreedbackReporter = { id, username, email }

With auth: 'required', the submit handler returns 401 when neither a Bearer header nor bugfreedbackReporter is present. Token signature/expiry validation is the host's responsibility.

Webhook export

For export.provider: 'webhook', configure outbound auth headers so your receiver can verify requests:

export: {
  provider: 'webhook',
  url: process.env.BUGFREEDBACK_WEBHOOK_URL || '',
  headers: {
    Authorization: `Bearer ${process.env.BUGFREEDBACK_WEBHOOK_SECRET}`,
  },
},

See the webhook export guide for payload format and response expectations.

Screenshots on mobile and tablet

Mobile browsers (iOS and Android) do not support tab capture via getDisplayMedia(). On those platforms the widget shows Attach a screenshot instead of Take a screenshot, opens the device file picker, and runs the same annotate → submit flow.

A (?) help button next to attach explains how to take a system screenshot on the detected device (iPhone, iPad, Samsung, Pixel, OnePlus, Xiaomi, and other major Android OEMs).

Development

npm install
npm run dev:prepare
npm run dev          # playground
npm test
npm run docs:dev     # VitePress site

Maintainers: see RELEASING.md for version bumps and npm publish.

Docs & demo: npm run docs:dev · npm run dev (playground at http://localhost:3000)

License

MIT