chore: import upstream snapshot with attribution
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
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
This commit is contained in:
@@ -0,0 +1,176 @@
|
||||
import type { BrandfetchGetBrandParams, BrandfetchGetBrandResponse } from '@/tools/brandfetch/types'
|
||||
import type { ToolConfig } from '@/tools/types'
|
||||
|
||||
export const brandfetchGetBrandTool: ToolConfig<
|
||||
BrandfetchGetBrandParams,
|
||||
BrandfetchGetBrandResponse
|
||||
> = {
|
||||
id: 'brandfetch_get_brand',
|
||||
name: 'Brandfetch Get Brand',
|
||||
description:
|
||||
'Retrieve brand assets including logos, colors, fonts, and company info by domain, ticker, ISIN, or crypto symbol',
|
||||
version: '1.0.0',
|
||||
|
||||
hosting: {
|
||||
envKeyPrefix: 'BRANDFETCH_API_KEY',
|
||||
apiKeyParam: 'apiKey',
|
||||
byokProviderId: 'brandfetch',
|
||||
pricing: {
|
||||
type: 'per_request',
|
||||
// Brand API: $99/month for 2,500 calls = $0.0396/request — https://docs.brandfetch.com/brand-api/quotas-and-usage
|
||||
cost: 0.04,
|
||||
},
|
||||
rateLimit: {
|
||||
mode: 'per_request',
|
||||
requestsPerMinute: 30,
|
||||
},
|
||||
},
|
||||
|
||||
params: {
|
||||
apiKey: {
|
||||
type: 'string',
|
||||
required: true,
|
||||
visibility: 'user-only',
|
||||
description: 'Brandfetch API key',
|
||||
},
|
||||
identifier: {
|
||||
type: 'string',
|
||||
required: true,
|
||||
visibility: 'user-or-llm',
|
||||
description:
|
||||
'Brand identifier: domain (nike.com), stock ticker (NKE), ISIN (US6541061031), or crypto symbol (BTC)',
|
||||
},
|
||||
},
|
||||
|
||||
request: {
|
||||
url: (params) =>
|
||||
`https://api.brandfetch.io/v2/brands/${encodeURIComponent(params.identifier.trim())}`,
|
||||
method: 'GET',
|
||||
headers: (params) => ({
|
||||
Authorization: `Bearer ${params.apiKey}`,
|
||||
Accept: 'application/json',
|
||||
}),
|
||||
},
|
||||
|
||||
transformResponse: async (response: Response) => {
|
||||
if (!response.ok) {
|
||||
const errorText = await response.text()
|
||||
throw new Error(`Brandfetch API error (${response.status}): ${errorText}`)
|
||||
}
|
||||
|
||||
const data = await response.json()
|
||||
|
||||
return {
|
||||
success: true,
|
||||
output: {
|
||||
id: data.id ?? '',
|
||||
name: data.name ?? null,
|
||||
domain: data.domain ?? '',
|
||||
claimed: data.claimed ?? false,
|
||||
description: data.description ?? null,
|
||||
longDescription: data.longDescription ?? null,
|
||||
links: data.links ?? [],
|
||||
logos: data.logos ?? [],
|
||||
colors: data.colors ?? [],
|
||||
fonts: data.fonts ?? [],
|
||||
company: data.company ?? null,
|
||||
qualityScore: data.qualityScore ?? null,
|
||||
isNsfw: data.isNsfw ?? false,
|
||||
},
|
||||
}
|
||||
},
|
||||
|
||||
outputs: {
|
||||
id: {
|
||||
type: 'string',
|
||||
description: 'Unique brand identifier',
|
||||
},
|
||||
name: {
|
||||
type: 'string',
|
||||
description: 'Brand name',
|
||||
optional: true,
|
||||
},
|
||||
domain: {
|
||||
type: 'string',
|
||||
description: 'Brand domain',
|
||||
},
|
||||
claimed: {
|
||||
type: 'boolean',
|
||||
description: 'Whether the brand profile is claimed',
|
||||
},
|
||||
description: {
|
||||
type: 'string',
|
||||
description: 'Short brand description',
|
||||
optional: true,
|
||||
},
|
||||
longDescription: {
|
||||
type: 'string',
|
||||
description: 'Detailed brand description',
|
||||
optional: true,
|
||||
},
|
||||
links: {
|
||||
type: 'array',
|
||||
description: 'Social media and website links',
|
||||
items: {
|
||||
type: 'json',
|
||||
properties: {
|
||||
name: { type: 'string', description: 'Link name (e.g., twitter, linkedin)' },
|
||||
url: { type: 'string', description: 'Link URL' },
|
||||
},
|
||||
},
|
||||
},
|
||||
logos: {
|
||||
type: 'array',
|
||||
description: 'Brand logos with formats and themes',
|
||||
items: {
|
||||
type: 'json',
|
||||
properties: {
|
||||
type: { type: 'string', description: 'Logo type (logo, icon, symbol, other)' },
|
||||
theme: { type: 'string', description: 'Logo theme (light, dark)' },
|
||||
formats: {
|
||||
type: 'array',
|
||||
description: 'Available formats with src URL, format, width, and height',
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
colors: {
|
||||
type: 'array',
|
||||
description: 'Brand colors with hex values and types',
|
||||
items: {
|
||||
type: 'json',
|
||||
properties: {
|
||||
hex: { type: 'string', description: 'Hex color code' },
|
||||
type: { type: 'string', description: 'Color type (accent, dark, light, brand)' },
|
||||
brightness: { type: 'number', description: 'Brightness value' },
|
||||
},
|
||||
},
|
||||
},
|
||||
fonts: {
|
||||
type: 'array',
|
||||
description: 'Brand fonts with names and types',
|
||||
items: {
|
||||
type: 'json',
|
||||
properties: {
|
||||
name: { type: 'string', description: 'Font name' },
|
||||
type: { type: 'string', description: 'Font type (title, body)' },
|
||||
origin: { type: 'string', description: 'Font origin (google, custom, system)' },
|
||||
},
|
||||
},
|
||||
},
|
||||
company: {
|
||||
type: 'json',
|
||||
description: 'Company firmographic data including employees, location, and industries',
|
||||
optional: true,
|
||||
},
|
||||
qualityScore: {
|
||||
type: 'number',
|
||||
description: 'Data quality score from 0 to 1',
|
||||
optional: true,
|
||||
},
|
||||
isNsfw: {
|
||||
type: 'boolean',
|
||||
description: 'Whether the brand contains adult content',
|
||||
},
|
||||
},
|
||||
}
|
||||
@@ -0,0 +1,3 @@
|
||||
export { brandfetchGetBrandTool } from '@/tools/brandfetch/get_brand'
|
||||
export { brandfetchSearchTool } from '@/tools/brandfetch/search'
|
||||
export * from '@/tools/brandfetch/types'
|
||||
@@ -0,0 +1,93 @@
|
||||
import type {
|
||||
BrandfetchSearchParams,
|
||||
BrandfetchSearchResponse,
|
||||
BrandfetchSearchResult,
|
||||
} from '@/tools/brandfetch/types'
|
||||
import type { ToolConfig } from '@/tools/types'
|
||||
|
||||
export const brandfetchSearchTool: ToolConfig<BrandfetchSearchParams, BrandfetchSearchResponse> = {
|
||||
id: 'brandfetch_search',
|
||||
name: 'Brandfetch Search',
|
||||
description: 'Search for brands by name and find their domains and logos',
|
||||
version: '1.0.0',
|
||||
|
||||
hosting: {
|
||||
envKeyPrefix: 'BRANDFETCH_API_KEY',
|
||||
apiKeyParam: 'apiKey',
|
||||
byokProviderId: 'brandfetch',
|
||||
pricing: {
|
||||
type: 'per_request',
|
||||
// Brand Search API is free (fair-use 500K/month) — https://docs.brandfetch.com/brand-search-api/rate-limits
|
||||
cost: 0,
|
||||
},
|
||||
rateLimit: {
|
||||
mode: 'per_request',
|
||||
requestsPerMinute: 30,
|
||||
},
|
||||
},
|
||||
|
||||
params: {
|
||||
apiKey: {
|
||||
type: 'string',
|
||||
required: true,
|
||||
visibility: 'user-only',
|
||||
description: 'Brandfetch API key',
|
||||
},
|
||||
name: {
|
||||
type: 'string',
|
||||
required: true,
|
||||
visibility: 'user-or-llm',
|
||||
description: 'Company or brand name to search for',
|
||||
},
|
||||
},
|
||||
|
||||
request: {
|
||||
url: (params) =>
|
||||
`https://api.brandfetch.io/v2/search/${encodeURIComponent(params.name.trim())}`,
|
||||
method: 'GET',
|
||||
headers: (params) => ({
|
||||
Authorization: `Bearer ${params.apiKey}`,
|
||||
Accept: 'application/json',
|
||||
}),
|
||||
},
|
||||
|
||||
transformResponse: async (response: Response) => {
|
||||
if (!response.ok) {
|
||||
const errorText = await response.text()
|
||||
throw new Error(`Brandfetch API error (${response.status}): ${errorText}`)
|
||||
}
|
||||
|
||||
const data = await response.json()
|
||||
const results = Array.isArray(data) ? data : []
|
||||
|
||||
return {
|
||||
success: true,
|
||||
output: {
|
||||
results: results.map((item: Partial<BrandfetchSearchResult>) => ({
|
||||
brandId: item.brandId ?? '',
|
||||
name: item.name ?? null,
|
||||
domain: item.domain ?? '',
|
||||
claimed: item.claimed ?? false,
|
||||
icon: item.icon ?? null,
|
||||
})),
|
||||
},
|
||||
}
|
||||
},
|
||||
|
||||
outputs: {
|
||||
results: {
|
||||
type: 'array',
|
||||
description: 'List of matching brands',
|
||||
items: {
|
||||
type: 'json',
|
||||
properties: {
|
||||
brandId: { type: 'string', description: 'Unique brand identifier' },
|
||||
name: { type: 'string', description: 'Brand name' },
|
||||
domain: { type: 'string', description: 'Brand domain' },
|
||||
claimed: { type: 'boolean', description: 'Whether the brand profile is claimed' },
|
||||
icon: { type: 'string', description: 'Brand icon URL' },
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
@@ -0,0 +1,97 @@
|
||||
import type { ToolResponse } from '@/tools/types'
|
||||
|
||||
export interface BrandfetchGetBrandParams {
|
||||
apiKey: string
|
||||
identifier: string
|
||||
}
|
||||
|
||||
export interface BrandfetchSearchParams {
|
||||
apiKey: string
|
||||
name: string
|
||||
}
|
||||
|
||||
interface BrandLink {
|
||||
name: string
|
||||
url: string
|
||||
}
|
||||
|
||||
interface BrandLogo {
|
||||
type: string
|
||||
theme: string | null
|
||||
formats: Array<{
|
||||
src: string
|
||||
format: string
|
||||
width: number | null
|
||||
height: number | null
|
||||
background: string | null
|
||||
}>
|
||||
}
|
||||
|
||||
interface BrandColor {
|
||||
hex: string
|
||||
type: string
|
||||
brightness: number
|
||||
}
|
||||
|
||||
interface BrandFont {
|
||||
name: string | null
|
||||
type: string
|
||||
origin: string
|
||||
originId: string | null
|
||||
weights: number[]
|
||||
}
|
||||
|
||||
interface BrandCompany {
|
||||
employees: string | null
|
||||
foundedYear: number | null
|
||||
kind: string | null
|
||||
location: {
|
||||
city: string | null
|
||||
country: string | null
|
||||
countryCode: string | null
|
||||
state: string | null
|
||||
stateCode: string | null
|
||||
region: string | null
|
||||
subRegion: string | null
|
||||
} | null
|
||||
industries: Array<{
|
||||
score: number
|
||||
id: string
|
||||
name: string
|
||||
emoji: string
|
||||
slug: string
|
||||
parent: { id: string; name: string; emoji: string; slug: string } | null
|
||||
}>
|
||||
}
|
||||
|
||||
export interface BrandfetchGetBrandResponse extends ToolResponse {
|
||||
output: {
|
||||
id: string
|
||||
name: string | null
|
||||
domain: string
|
||||
claimed: boolean
|
||||
description: string | null
|
||||
longDescription: string | null
|
||||
links: BrandLink[]
|
||||
logos: BrandLogo[]
|
||||
colors: BrandColor[]
|
||||
fonts: BrandFont[]
|
||||
company: BrandCompany | null
|
||||
qualityScore: number | null
|
||||
isNsfw: boolean
|
||||
}
|
||||
}
|
||||
|
||||
export interface BrandfetchSearchResult {
|
||||
brandId: string
|
||||
name: string | null
|
||||
domain: string
|
||||
claimed: boolean
|
||||
icon: string | null
|
||||
}
|
||||
|
||||
export interface BrandfetchSearchResponse extends ToolResponse {
|
||||
output: {
|
||||
results: BrandfetchSearchResult[]
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user