Files
simstudioai--sim/apps/sim/tools/dub/get_qr_code.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

130 lines
3.8 KiB
TypeScript

import type { DubGetQrCodeParams, DubGetQrCodeResponse } from '@/tools/dub/types'
import type { ToolConfig } from '@/tools/types'
export const getQrCodeTool: ToolConfig<DubGetQrCodeParams, DubGetQrCodeResponse> = {
id: 'dub_get_qr_code',
name: 'Dub Get QR Code',
description:
'Generate a customizable QR code (PNG) for a short link, with control over size, error correction, colors, and margin.',
version: '1.0.0',
params: {
apiKey: {
type: 'string',
required: true,
visibility: 'user-only',
description: 'Dub API key',
},
url: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description: 'The short link URL to encode in the QR code',
},
logo: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'URL of a custom logo to embed in the QR code (requires a paid Dub plan)',
},
size: {
type: 'number',
required: false,
visibility: 'user-or-llm',
description: 'QR code size in pixels (default: 600)',
},
level: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Error correction level: L (default), M, Q, or H',
},
fgColor: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Foreground color in hex (default: #000000)',
},
bgColor: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Background color in hex (default: #FFFFFF)',
},
hideLogo: {
type: 'boolean',
required: false,
visibility: 'user-or-llm',
description: 'Whether to hide the logo in the center of the QR code (default: false)',
},
margin: {
type: 'number',
required: false,
visibility: 'user-or-llm',
description: 'Margin (quiet zone) around the QR code (default: 2)',
},
},
request: {
url: (params) => {
const url = new URL('https://api.dub.co/qr')
url.searchParams.set('url', params.url.trim())
if (params.logo) url.searchParams.set('logo', params.logo)
if (params.size !== undefined) url.searchParams.set('size', String(params.size))
if (params.level) url.searchParams.set('level', params.level)
if (params.fgColor) url.searchParams.set('fgColor', params.fgColor)
if (params.bgColor) url.searchParams.set('bgColor', params.bgColor)
if (params.hideLogo !== undefined) url.searchParams.set('hideLogo', String(params.hideLogo))
if (params.margin !== undefined) url.searchParams.set('margin', String(params.margin))
return url.toString()
},
method: 'GET',
headers: (params) => ({
Accept: 'image/png',
Authorization: `Bearer ${params.apiKey}`,
}),
},
transformResponse: async (response: Response) => {
if (!response.ok) {
const errorText = await response.text()
let message = errorText || `Failed to generate QR code: ${response.status}`
try {
const parsed = JSON.parse(errorText)
message = parsed.error?.message || parsed.error || message
} catch {
// Non-JSON error body; use the raw text
}
throw new Error(message)
}
const arrayBuffer = await response.arrayBuffer()
const buffer = Buffer.from(arrayBuffer)
const mimeType = response.headers.get('content-type') || 'image/png'
return {
success: true,
output: {
file: {
name: 'qrcode.png',
mimeType,
data: buffer.toString('base64'),
size: buffer.length,
},
content: buffer.toString('base64'),
},
}
},
outputs: {
file: {
type: 'file',
description: 'Generated QR code image stored in execution files',
},
content: {
type: 'string',
description: 'Base64-encoded PNG image data',
},
},
}