search.go

package gotidal

import (
	"context"
	"encoding/json"
	"errors"
	"fmt"
	"net/http"
)

const (
	searchURL                 = "/search"
	SearchTypeAlbums          = "ALBUMS"
	SearchTypeArtists         = "ARTISTS"
	SearchTypeTracks          = "TRACKS"
	SearchTypeVideos          = "VIDEOS"
	SearchPopularityWorldwide = "WORLDWIDE"
	SearchPopularityCountry   = "COUNTRY"
)

// SearchParams defines the request parameters used by the TIDAL search API endpoint.
// See: https://developer.tidal.com/apiref?spec=search&ref=search
type SearchParams struct {
	// Search query in plain text.
	// Example: Beyoncé
	Query string `json:"query"`

	// Target search type. Optional. Searches for all types if not specified.
	// Example: ARTISTS, ALBUMS, TRACKS, VIDEOS
	Type string `json:"type"`

	// Pagination offset (in number of items). Required if 'query' is provided.
	// Example: 0
	Offset int `json:"offset"`

	// Page size. Required if 'query' is provided.
	// Example: 10
	Limit int `json:"limit"`

	// Specify which popularity type to apply for query result: either worldwide or country popularity.
	// Worldwide popularity is used by default if nothing is specified.
	// Example: WORLDWIDE, COUNTRY
	Popularity string `json:"popularity"`
}

var ErrMissingRequiredParameters = errors.New("both the Query and the CountryCode parameters are required")

type SearchResults struct {
	Albums  []Album
	Artists []Artist
	Tracks  []Track
	Videos  []Video
}

func (c *Client) Search(ctx context.Context, params SearchParams) (*SearchResults, error) {
	if params.Query == "" {
		return nil, ErrMissingRequiredParameters
	}

	response, err := c.request(ctx, http.MethodGet, searchURL, params)
	if err != nil {
		return nil, fmt.Errorf("failed to connect to the search endpoint: %w", err)
	}

	var results SearchResults

	err = json.Unmarshal(response, &results)
	if err != nil {
		return nil, fmt.Errorf("failed to unmarshal the search response body: %w", err)
	}

	return &results, nil
}