Files
simstudioai--sim/apps/sim/tools/spotify/get_albums.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

116 lines
3.2 KiB
TypeScript

import { SIMPLIFIED_ARTIST_OUTPUT_PROPERTIES } from '@/tools/spotify/types'
import type { ToolConfig, ToolResponse } from '@/tools/types'
interface SpotifyGetAlbumsParams {
accessToken: string
albumIds: string
market?: string
}
interface SpotifyGetAlbumsResponse extends ToolResponse {
output: {
albums: Array<{
id: string
name: string
artists: Array<{ id: string; name: string }>
album_type: string
total_tracks: number
release_date: string
image_url: string | null
external_url: string
}>
}
}
export const spotifyGetAlbumsTool: ToolConfig<SpotifyGetAlbumsParams, SpotifyGetAlbumsResponse> = {
id: 'spotify_get_albums',
name: 'Spotify Get Multiple Albums',
description: 'Get details for multiple albums by their IDs.',
version: '1.0.0',
oauth: {
required: true,
provider: 'spotify',
requiredScopes: ['user-read-private'],
},
params: {
albumIds: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description: 'Comma-separated album IDs (max 20)',
},
market: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'ISO 3166-1 alpha-2 country code (e.g., "US", "GB")',
},
},
request: {
url: (params) => {
const ids = params.albumIds
.split(',')
.map((id) => id.trim())
.slice(0, 20)
.join(',')
let url = `https://api.spotify.com/v1/albums?ids=${ids}`
if (params.market) {
url += `&market=${params.market}`
}
return url
},
method: 'GET',
headers: (params) => ({
Authorization: `Bearer ${params.accessToken}`,
'Content-Type': 'application/json',
}),
},
transformResponse: async (response): Promise<SpotifyGetAlbumsResponse> => {
const data = await response.json()
const albums = (data.albums || []).map((album: any) => ({
id: album.id,
name: album.name,
artists: album.artists?.map((a: any) => ({ id: a.id, name: a.name })) || [],
album_type: album.album_type,
total_tracks: album.total_tracks,
release_date: album.release_date,
image_url: album.images?.[0]?.url || null,
external_url: album.external_urls?.spotify || '',
}))
return {
success: true,
output: { albums },
}
},
outputs: {
albums: {
type: 'array',
description: 'List of albums',
items: {
type: 'object',
properties: {
id: { type: 'string', description: 'Spotify album ID' },
name: { type: 'string', description: 'Album name' },
artists: {
type: 'array',
description: 'List of artists',
items: { type: 'object', properties: SIMPLIFIED_ARTIST_OUTPUT_PROPERTIES },
},
album_type: { type: 'string', description: 'Type of album (album, single, compilation)' },
total_tracks: { type: 'number', description: 'Total number of tracks' },
release_date: { type: 'string', description: 'Release date' },
image_url: { type: 'string', description: 'Album cover image URL', optional: true },
external_url: { type: 'string', description: 'Spotify URL' },
},
},
},
},
}