mirror of
https://github.com/n8n-io/n8n.git
synced 2025-02-21 02:56:40 -08:00
✨ Spotify Node
Co-authored-by: Ricardo Espinoza <RicardoE105@users.noreply.github.com>
This commit is contained in:
Erin
parent
d9906e1b24
commit
5e81e02599
|
|
@ -0,0 +1,53 @@
|
||||||
|
import {
|
||||||
|
ICredentialType,
|
||||||
|
NodePropertyTypes,
|
||||||
|
} from 'n8n-workflow';
|
||||||
|
|
||||||
|
|
||||||
|
export class SpotifyOAuth2Api implements ICredentialType {
|
||||||
|
name = 'spotifyOAuth2Api';
|
||||||
|
extends = [
|
||||||
|
'oAuth2Api',
|
||||||
|
];
|
||||||
|
displayName = 'Spotify OAuth2 API';
|
||||||
|
properties = [
|
||||||
|
{
|
||||||
|
displayName: 'Spotify Server',
|
||||||
|
name: 'server',
|
||||||
|
type: 'hidden' as NodePropertyTypes,
|
||||||
|
default: 'https://api.spotify.com/',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
displayName: 'Authorization URL',
|
||||||
|
name: 'authUrl',
|
||||||
|
type: 'hidden' as NodePropertyTypes,
|
||||||
|
default: 'https://accounts.spotify.com/authorize',
|
||||||
|
required: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
displayName: 'Access Token URL',
|
||||||
|
name: 'accessTokenUrl',
|
||||||
|
type: 'hidden' as NodePropertyTypes,
|
||||||
|
default: 'https://accounts.spotify.com/api/token',
|
||||||
|
required: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
displayName: 'Scope',
|
||||||
|
name: 'scope',
|
||||||
|
type: 'hidden' as NodePropertyTypes,
|
||||||
|
default: 'user-read-playback-state playlist-read-collaborative user-modify-playback-state playlist-modify-public user-read-currently-playing playlist-read-private user-read-recently-played playlist-modify-private',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
displayName: 'Auth URI Query Parameters',
|
||||||
|
name: 'authQueryParameters',
|
||||||
|
type: 'hidden' as NodePropertyTypes,
|
||||||
|
default: '',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
displayName: 'Authentication',
|
||||||
|
name: 'authentication',
|
||||||
|
type: 'hidden' as NodePropertyTypes,
|
||||||
|
default: 'header',
|
||||||
|
}
|
||||||
|
];
|
||||||
|
}
|
||||||
84
packages/nodes-base/nodes/Spotify/GenericFunctions.ts
Normal file
84
packages/nodes-base/nodes/Spotify/GenericFunctions.ts
Normal file
|
|
@ -0,0 +1,84 @@
|
||||||
|
import { OptionsWithUri } from 'request';
|
||||||
|
|
||||||
|
import {
|
||||||
|
IExecuteFunctions,
|
||||||
|
IHookFunctions,
|
||||||
|
} from 'n8n-core';
|
||||||
|
|
||||||
|
import {
|
||||||
|
IDataObject,
|
||||||
|
} from 'n8n-workflow';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Make an API request to Spotify
|
||||||
|
*
|
||||||
|
* @param {IHookFunctions} this
|
||||||
|
* @param {string} method
|
||||||
|
* @param {string} url
|
||||||
|
* @param {object} body
|
||||||
|
* @returns {Promise<any>}
|
||||||
|
*/
|
||||||
|
export async function spotifyApiRequest(this: IHookFunctions | IExecuteFunctions,
|
||||||
|
method: string, endpoint: string, body: object, query?: object, uri?: string): Promise<any> { // tslint:disable-line:no-any
|
||||||
|
|
||||||
|
const options: OptionsWithUri = {
|
||||||
|
method,
|
||||||
|
headers: {
|
||||||
|
'User-Agent': 'n8n',
|
||||||
|
'Content-Type': 'text/plain',
|
||||||
|
'Accept': ' application/json',
|
||||||
|
},
|
||||||
|
body,
|
||||||
|
qs: query,
|
||||||
|
uri: uri || `https://api.spotify.com/v1${endpoint}`,
|
||||||
|
json: true
|
||||||
|
};
|
||||||
|
|
||||||
|
try {
|
||||||
|
const credentials = this.getCredentials('spotifyOAuth2Api');
|
||||||
|
|
||||||
|
if (credentials === undefined) {
|
||||||
|
throw new Error('No credentials got returned!');
|
||||||
|
}
|
||||||
|
|
||||||
|
if (Object.keys(body).length === 0) {
|
||||||
|
delete options.body;
|
||||||
|
}
|
||||||
|
|
||||||
|
return await this.helpers.requestOAuth2.call(this, 'spotifyOAuth2Api', options);
|
||||||
|
} catch (error) {
|
||||||
|
if (error.statusCode === 401) {
|
||||||
|
// Return a clear error
|
||||||
|
throw new Error('The Spotify credentials are not valid!');
|
||||||
|
}
|
||||||
|
|
||||||
|
if (error.error && error.error.error && error.error.error.message) {
|
||||||
|
// Try to return the error prettier
|
||||||
|
throw new Error(`Spotify error response [${error.error.error.status}]: ${error.error.error.message}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
// If that data does not exist for some reason return the actual error
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function spotifyApiRequestAllItems(this: IHookFunctions | IExecuteFunctions,
|
||||||
|
propertyName: string, method: string, endpoint: string, body: object, query?: object): Promise<any> { // tslint:disable-line:no-any
|
||||||
|
|
||||||
|
const returnData: IDataObject[] = [];
|
||||||
|
|
||||||
|
let responseData;
|
||||||
|
|
||||||
|
let uri: string | undefined;
|
||||||
|
|
||||||
|
do {
|
||||||
|
responseData = await spotifyApiRequest.call(this, method, endpoint, body, query, uri);
|
||||||
|
returnData.push.apply(returnData, responseData[propertyName]);
|
||||||
|
uri = responseData.next;
|
||||||
|
|
||||||
|
} while (
|
||||||
|
responseData['next'] !== null
|
||||||
|
);
|
||||||
|
|
||||||
|
return returnData;
|
||||||
|
}
|
||||||
816
packages/nodes-base/nodes/Spotify/Spotify.node.ts
Normal file
816
packages/nodes-base/nodes/Spotify/Spotify.node.ts
Normal file
|
|
@ -0,0 +1,816 @@
|
||||||
|
import {
|
||||||
|
IExecuteFunctions,
|
||||||
|
} from 'n8n-core';
|
||||||
|
|
||||||
|
import {
|
||||||
|
IDataObject,
|
||||||
|
INodeExecutionData,
|
||||||
|
INodeType,
|
||||||
|
INodeTypeDescription,
|
||||||
|
} from 'n8n-workflow';
|
||||||
|
|
||||||
|
import {
|
||||||
|
spotifyApiRequest,
|
||||||
|
spotifyApiRequestAllItems,
|
||||||
|
} from './GenericFunctions';
|
||||||
|
|
||||||
|
export class Spotify implements INodeType {
|
||||||
|
description: INodeTypeDescription = {
|
||||||
|
displayName: 'Spotify',
|
||||||
|
name: 'spotify',
|
||||||
|
icon: 'file:spotify.png',
|
||||||
|
group: ['input'],
|
||||||
|
version: 1,
|
||||||
|
description: 'Access public song data via the Spotify API.',
|
||||||
|
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
|
||||||
|
defaults: {
|
||||||
|
name: 'Spotify',
|
||||||
|
color: '#1DB954',
|
||||||
|
},
|
||||||
|
inputs: ['main'],
|
||||||
|
outputs: ['main'],
|
||||||
|
credentials: [
|
||||||
|
{
|
||||||
|
name: 'spotifyOAuth2Api',
|
||||||
|
required: true,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
properties: [
|
||||||
|
// ----------------------------------------------------------
|
||||||
|
// Resource to Operate on
|
||||||
|
// Player, Album, Artisits, Playlists, Tracks
|
||||||
|
// ----------------------------------------------------------
|
||||||
|
{
|
||||||
|
displayName: 'Resource',
|
||||||
|
name: 'resource',
|
||||||
|
type: 'options',
|
||||||
|
options: [
|
||||||
|
{
|
||||||
|
name: 'Album',
|
||||||
|
value: 'album',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'Artist',
|
||||||
|
value: 'artist',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'Player',
|
||||||
|
value: 'player',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'Playlist',
|
||||||
|
value: 'playlist',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'Track',
|
||||||
|
value: 'track',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
default: 'player',
|
||||||
|
description: 'The resource to operate on.',
|
||||||
|
},
|
||||||
|
// --------------------------------------------------------------------------------------------------------
|
||||||
|
// Player Operations
|
||||||
|
// Pause, Play, Get Recently Played, Get Currently Playing, Next Song, Previous Song, Add to Queue
|
||||||
|
// --------------------------------------------------------------------------------------------------------
|
||||||
|
{
|
||||||
|
displayName: 'Operation',
|
||||||
|
name: 'operation',
|
||||||
|
type: 'options',
|
||||||
|
displayOptions: {
|
||||||
|
show: {
|
||||||
|
resource: [
|
||||||
|
'player',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
options: [
|
||||||
|
{
|
||||||
|
name: 'Add Song to Queue',
|
||||||
|
value: 'addSongToQueue',
|
||||||
|
description: 'Add a song to your queue.'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'Currently Playing',
|
||||||
|
value: 'currentlyPlaying',
|
||||||
|
description: 'Get your currently playing track.'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'Next Song',
|
||||||
|
value: 'nextSong',
|
||||||
|
description: 'Skip to your next track.'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'Pause',
|
||||||
|
value: 'pause',
|
||||||
|
description: 'Pause your music.',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'Previous Song',
|
||||||
|
value: 'previousSong',
|
||||||
|
description: 'Skip to your previous song.'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'Recently Played',
|
||||||
|
value: 'recentlyPlayed',
|
||||||
|
description: 'Get your recently played tracks.'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'Start Music',
|
||||||
|
value: 'startMusic',
|
||||||
|
description: 'Start playing a playlist, artist, or album.'
|
||||||
|
},
|
||||||
|
],
|
||||||
|
default: 'addSongToQueue',
|
||||||
|
description: 'The operation to perform.',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
displayName: 'Resource ID',
|
||||||
|
name: 'id',
|
||||||
|
type: 'string',
|
||||||
|
default: '',
|
||||||
|
required: true,
|
||||||
|
displayOptions: {
|
||||||
|
show: {
|
||||||
|
resource: [
|
||||||
|
'player'
|
||||||
|
],
|
||||||
|
operation: [
|
||||||
|
'startMusic',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
placeholder: 'spotify:album:1YZ3k65Mqw3G8FzYlW1mmp',
|
||||||
|
description: `Enter a playlist, artist, or album URI or ID.`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
displayName: 'Track ID',
|
||||||
|
name: 'id',
|
||||||
|
type: 'string',
|
||||||
|
default: '',
|
||||||
|
required: true,
|
||||||
|
displayOptions: {
|
||||||
|
show: {
|
||||||
|
resource: [
|
||||||
|
'player'
|
||||||
|
],
|
||||||
|
operation: [
|
||||||
|
'addSongToQueue',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
placeholder: 'spotify:track:0xE4LEFzSNGsz1F6kvXsHU',
|
||||||
|
description: `Enter a track URI or ID.`,
|
||||||
|
},
|
||||||
|
// -----------------------------------------------
|
||||||
|
// Album Operations
|
||||||
|
// Get an Album, Get an Album's Tracks
|
||||||
|
// -----------------------------------------------
|
||||||
|
{
|
||||||
|
displayName: 'Operation',
|
||||||
|
name: 'operation',
|
||||||
|
type: 'options',
|
||||||
|
displayOptions: {
|
||||||
|
show: {
|
||||||
|
resource: [
|
||||||
|
'album',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
options: [
|
||||||
|
{
|
||||||
|
name: 'Get',
|
||||||
|
value: 'get',
|
||||||
|
description: 'Get an album by URI or ID.',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: `Get Tracks`,
|
||||||
|
value: 'getTracks',
|
||||||
|
description: `Get an album's tracks by URI or ID.`,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
default: 'get',
|
||||||
|
description: 'The operation to perform.',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
displayName: 'Album ID',
|
||||||
|
name: 'id',
|
||||||
|
type: 'string',
|
||||||
|
default: '',
|
||||||
|
required: true,
|
||||||
|
displayOptions: {
|
||||||
|
show: {
|
||||||
|
resource: [
|
||||||
|
'album',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
placeholder: 'spotify:album:1YZ3k65Mqw3G8FzYlW1mmp',
|
||||||
|
description: `The album's Spotify URI or ID.`,
|
||||||
|
},
|
||||||
|
// -------------------------------------------------------------------------------------------------------------
|
||||||
|
// Artist Operations
|
||||||
|
// Get an Artist, Get an Artist's Related Artists, Get an Artist's Top Tracks, Get an Artist's Albums
|
||||||
|
// -------------------------------------------------------------------------------------------------------------
|
||||||
|
{
|
||||||
|
displayName: 'Operation',
|
||||||
|
name: 'operation',
|
||||||
|
type: 'options',
|
||||||
|
displayOptions: {
|
||||||
|
show: {
|
||||||
|
resource: [
|
||||||
|
'artist',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
options: [
|
||||||
|
{
|
||||||
|
name: 'Get',
|
||||||
|
value: 'get',
|
||||||
|
description: 'Get an artist by URI or ID.',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: `Get Albums`,
|
||||||
|
value: 'getAlbums',
|
||||||
|
description: `Get an artist's albums by URI or ID.`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: `Get Related Artists`,
|
||||||
|
value: 'getRelatedArtists',
|
||||||
|
description: `Get an artist's related artists by URI or ID.`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: `Get Top Tracks`,
|
||||||
|
value: 'getTopTracks',
|
||||||
|
description: `Get an artist's top tracks by URI or ID.`,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
default: 'get',
|
||||||
|
description: 'The operation to perform.',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
displayName: 'Artist ID',
|
||||||
|
name: 'id',
|
||||||
|
type: 'string',
|
||||||
|
default: '',
|
||||||
|
required: true,
|
||||||
|
displayOptions: {
|
||||||
|
show: {
|
||||||
|
resource: [
|
||||||
|
'artist',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
placeholder: 'spotify:artist:4LLpKhyESsyAXpc4laK94U',
|
||||||
|
description: `The artist's Spotify URI or ID.`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
displayName: 'Country',
|
||||||
|
name: 'country',
|
||||||
|
type: 'string',
|
||||||
|
default: 'US',
|
||||||
|
required: true,
|
||||||
|
displayOptions: {
|
||||||
|
show: {
|
||||||
|
resource: [
|
||||||
|
'artist'
|
||||||
|
],
|
||||||
|
operation: [
|
||||||
|
'getTopTracks',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
placeholder: 'US',
|
||||||
|
description: `Top tracks in which country? Enter the postal abbriviation.`,
|
||||||
|
},
|
||||||
|
// -------------------------------------------------------------------------------------------------------------
|
||||||
|
// Playlist Operations
|
||||||
|
// Get a Playlist, Get a Playlist's Tracks, Add/Remove a Song from a Playlist, Get a User's Playlists
|
||||||
|
// -------------------------------------------------------------------------------------------------------------
|
||||||
|
{
|
||||||
|
displayName: 'Operation',
|
||||||
|
name: 'operation',
|
||||||
|
type: 'options',
|
||||||
|
displayOptions: {
|
||||||
|
show: {
|
||||||
|
resource: [
|
||||||
|
'playlist',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
options: [
|
||||||
|
{
|
||||||
|
name: 'Add an Item',
|
||||||
|
value: 'add',
|
||||||
|
description: 'Add tracks from a playlist by track and playlist URI or ID.',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'Get',
|
||||||
|
value: 'get',
|
||||||
|
description: 'Get a playlist by URI or ID.',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'Get Tracks',
|
||||||
|
value: 'getTracks',
|
||||||
|
description: `Get a playlist's tracks by URI or ID.`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: `Get the User's Playlists`,
|
||||||
|
value: 'getUserPlaylists',
|
||||||
|
description: `Get a user's playlists.`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'Remove an Item',
|
||||||
|
value: 'delete',
|
||||||
|
description: 'Remove tracks from a playlist by track and playlist URI or ID.',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
default: 'add',
|
||||||
|
description: 'The operation to perform.',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
displayName: 'Playlist ID',
|
||||||
|
name: 'id',
|
||||||
|
type: 'string',
|
||||||
|
default: '',
|
||||||
|
required: true,
|
||||||
|
displayOptions: {
|
||||||
|
show: {
|
||||||
|
resource: [
|
||||||
|
'playlist'
|
||||||
|
],
|
||||||
|
operation: [
|
||||||
|
'add',
|
||||||
|
'delete',
|
||||||
|
'get',
|
||||||
|
'getTracks'
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
placeholder: 'spotify:playlist:37i9dQZF1DWUhI3iC1khPH',
|
||||||
|
description: `The playlist's Spotify URI or its ID.`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
displayName: 'Track ID',
|
||||||
|
name: 'trackID',
|
||||||
|
type: 'string',
|
||||||
|
default: '',
|
||||||
|
required: true,
|
||||||
|
displayOptions: {
|
||||||
|
show: {
|
||||||
|
resource: [
|
||||||
|
'playlist'
|
||||||
|
],
|
||||||
|
operation: [
|
||||||
|
'add',
|
||||||
|
'delete'
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
placeholder: 'spotify:track:0xE4LEFzSNGsz1F6kvXsHU',
|
||||||
|
description: `The track's Spotify URI or its ID. The track to add/delete from the playlist.`,
|
||||||
|
},
|
||||||
|
// -----------------------------------------------------
|
||||||
|
// Track Operations
|
||||||
|
// Get a Track, Get a Track's Audio Features
|
||||||
|
// -----------------------------------------------------
|
||||||
|
{
|
||||||
|
displayName: 'Operation',
|
||||||
|
name: 'operation',
|
||||||
|
type: 'options',
|
||||||
|
displayOptions: {
|
||||||
|
show: {
|
||||||
|
resource: [
|
||||||
|
'track',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
options: [
|
||||||
|
{
|
||||||
|
name: 'Get',
|
||||||
|
value: 'get',
|
||||||
|
description: 'Get a track by its URI or ID.',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'Get Audio Features',
|
||||||
|
value: 'getAudioFeatures',
|
||||||
|
description: 'Get audio features for a track by URI or ID.',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
default: 'track',
|
||||||
|
description: 'The operation to perform.',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
displayName: 'Track ID',
|
||||||
|
name: 'id',
|
||||||
|
type: 'string',
|
||||||
|
default: '',
|
||||||
|
required: true,
|
||||||
|
displayOptions: {
|
||||||
|
show: {
|
||||||
|
resource: [
|
||||||
|
'track',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
placeholder: 'spotify:track:0xE4LEFzSNGsz1F6kvXsHU',
|
||||||
|
description: `The track's Spotify URI or ID.`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
displayName: 'Return All',
|
||||||
|
name: 'returnAll',
|
||||||
|
type: 'boolean',
|
||||||
|
default: false,
|
||||||
|
required: true,
|
||||||
|
displayOptions: {
|
||||||
|
show: {
|
||||||
|
resource: [
|
||||||
|
'album',
|
||||||
|
'artist',
|
||||||
|
'playlist'
|
||||||
|
],
|
||||||
|
operation: [
|
||||||
|
'getTracks',
|
||||||
|
'getAlbums',
|
||||||
|
'getUserPlaylists'
|
||||||
|
]
|
||||||
|
},
|
||||||
|
},
|
||||||
|
description: `The number of items to return.`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
displayName: 'Limit',
|
||||||
|
name: 'limit',
|
||||||
|
type: 'number',
|
||||||
|
default: 50,
|
||||||
|
required: true,
|
||||||
|
displayOptions: {
|
||||||
|
show: {
|
||||||
|
resource: [
|
||||||
|
'album',
|
||||||
|
'artist',
|
||||||
|
'playlist'
|
||||||
|
],
|
||||||
|
operation: [
|
||||||
|
'getTracks',
|
||||||
|
'getAlbums',
|
||||||
|
'getUserPlaylists'
|
||||||
|
],
|
||||||
|
returnAll: [
|
||||||
|
false
|
||||||
|
]
|
||||||
|
},
|
||||||
|
},
|
||||||
|
typeOptions: {
|
||||||
|
minValue: 1,
|
||||||
|
maxValue: 100,
|
||||||
|
},
|
||||||
|
description: `The number of items to return.`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
displayName: 'Limit',
|
||||||
|
name: 'limit',
|
||||||
|
type: 'number',
|
||||||
|
default: 50,
|
||||||
|
required: true,
|
||||||
|
displayOptions: {
|
||||||
|
show: {
|
||||||
|
resource: [
|
||||||
|
'player',
|
||||||
|
],
|
||||||
|
operation: [
|
||||||
|
'recentlyPlayed',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
typeOptions: {
|
||||||
|
minValue: 1,
|
||||||
|
maxValue: 50,
|
||||||
|
},
|
||||||
|
description: `The number of items to return.`,
|
||||||
|
},
|
||||||
|
]
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
|
||||||
|
// Get all of the incoming input data to loop through
|
||||||
|
const items = this.getInputData();
|
||||||
|
const returnData: IDataObject[] = [];
|
||||||
|
|
||||||
|
// For Post
|
||||||
|
let body: IDataObject;
|
||||||
|
// For Query string
|
||||||
|
let qs: IDataObject;
|
||||||
|
|
||||||
|
let requestMethod: string;
|
||||||
|
let endpoint: string;
|
||||||
|
let returnAll: boolean;
|
||||||
|
let propertyName = '';
|
||||||
|
let responseData;
|
||||||
|
|
||||||
|
const operation = this.getNodeParameter('operation', 0) as string;
|
||||||
|
const resource = this.getNodeParameter('resource', 0) as string;
|
||||||
|
|
||||||
|
// Set initial values
|
||||||
|
requestMethod = 'GET';
|
||||||
|
endpoint = '';
|
||||||
|
body = {};
|
||||||
|
qs = {};
|
||||||
|
returnAll = false;
|
||||||
|
|
||||||
|
for(let i = 0; i < items.length; i++) {
|
||||||
|
// -----------------------------
|
||||||
|
// Player Operations
|
||||||
|
// -----------------------------
|
||||||
|
if( resource === 'player' ) {
|
||||||
|
if(operation === 'pause') {
|
||||||
|
requestMethod = 'PUT';
|
||||||
|
|
||||||
|
endpoint = `/me/player/pause`;
|
||||||
|
|
||||||
|
responseData = await spotifyApiRequest.call(this, requestMethod, endpoint, body, qs);
|
||||||
|
|
||||||
|
responseData = { success: true };
|
||||||
|
|
||||||
|
} else if(operation === 'recentlyPlayed') {
|
||||||
|
requestMethod = 'GET';
|
||||||
|
|
||||||
|
endpoint = `/me/player/recently-played`;
|
||||||
|
|
||||||
|
const limit = this.getNodeParameter('limit', i) as number;
|
||||||
|
|
||||||
|
qs = {
|
||||||
|
'limit': limit
|
||||||
|
};
|
||||||
|
|
||||||
|
responseData = await spotifyApiRequest.call(this, requestMethod, endpoint, body, qs);
|
||||||
|
|
||||||
|
responseData = responseData.items;
|
||||||
|
|
||||||
|
} else if(operation === 'currentlyPlaying') {
|
||||||
|
requestMethod = 'GET';
|
||||||
|
|
||||||
|
endpoint = `/me/player/currently-playing`;
|
||||||
|
|
||||||
|
responseData = await spotifyApiRequest.call(this, requestMethod, endpoint, body, qs);
|
||||||
|
|
||||||
|
} else if(operation === 'nextSong') {
|
||||||
|
requestMethod = 'POST';
|
||||||
|
|
||||||
|
endpoint = `/me/player/next`;
|
||||||
|
|
||||||
|
responseData = await spotifyApiRequest.call(this, requestMethod, endpoint, body, qs);
|
||||||
|
|
||||||
|
responseData = { success: true };
|
||||||
|
|
||||||
|
} else if(operation === 'previousSong') {
|
||||||
|
requestMethod = 'POST';
|
||||||
|
|
||||||
|
endpoint = `/me/player/previous`;
|
||||||
|
|
||||||
|
responseData = await spotifyApiRequest.call(this, requestMethod, endpoint, body, qs);
|
||||||
|
|
||||||
|
responseData = { success: true };
|
||||||
|
|
||||||
|
} else if(operation === 'startMusic') {
|
||||||
|
requestMethod = 'PUT';
|
||||||
|
|
||||||
|
endpoint = `/me/player/play`;
|
||||||
|
|
||||||
|
const id = this.getNodeParameter('id', i) as string;
|
||||||
|
|
||||||
|
body.context_uri = id;
|
||||||
|
|
||||||
|
responseData = await spotifyApiRequest.call(this, requestMethod, endpoint, body, qs);
|
||||||
|
|
||||||
|
responseData = { success: true };
|
||||||
|
|
||||||
|
} else if(operation === 'addSongToQueue') {
|
||||||
|
requestMethod = 'POST';
|
||||||
|
|
||||||
|
endpoint = `/me/player/queue`;
|
||||||
|
|
||||||
|
const id = this.getNodeParameter('id', i) as string;
|
||||||
|
|
||||||
|
qs = {
|
||||||
|
'uri': id
|
||||||
|
};
|
||||||
|
|
||||||
|
responseData = await spotifyApiRequest.call(this, requestMethod, endpoint, body, qs);
|
||||||
|
|
||||||
|
responseData = { success: true };
|
||||||
|
}
|
||||||
|
// -----------------------------
|
||||||
|
// Album Operations
|
||||||
|
// -----------------------------
|
||||||
|
} else if( resource === 'album') {
|
||||||
|
const uri = this.getNodeParameter('id', i) as string;
|
||||||
|
|
||||||
|
const id = uri.replace('spotify:album:', '');
|
||||||
|
|
||||||
|
requestMethod = 'GET';
|
||||||
|
|
||||||
|
if(operation === 'get') {
|
||||||
|
endpoint = `/albums/${id}`;
|
||||||
|
|
||||||
|
responseData = await spotifyApiRequest.call(this, requestMethod, endpoint, body, qs);
|
||||||
|
|
||||||
|
} else if(operation === 'getTracks') {
|
||||||
|
endpoint = `/albums/${id}/tracks`;
|
||||||
|
|
||||||
|
propertyName = 'tracks';
|
||||||
|
|
||||||
|
returnAll = this.getNodeParameter('returnAll', i) as boolean;
|
||||||
|
|
||||||
|
propertyName = 'items';
|
||||||
|
|
||||||
|
if(!returnAll) {
|
||||||
|
const limit = this.getNodeParameter('limit', i) as number;
|
||||||
|
|
||||||
|
qs = {
|
||||||
|
'limit': limit
|
||||||
|
};
|
||||||
|
|
||||||
|
responseData = await spotifyApiRequest.call(this, requestMethod, endpoint, body, qs);
|
||||||
|
|
||||||
|
responseData = responseData.items;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// -----------------------------
|
||||||
|
// Artist Operations
|
||||||
|
// -----------------------------
|
||||||
|
} else if( resource === 'artist') {
|
||||||
|
const uri = this.getNodeParameter('id', i) as string;
|
||||||
|
|
||||||
|
const id = uri.replace('spotify:artist:', '');
|
||||||
|
|
||||||
|
if(operation === 'getAlbums') {
|
||||||
|
|
||||||
|
endpoint = `/artists/${id}/albums`;
|
||||||
|
|
||||||
|
returnAll = this.getNodeParameter('returnAll', i) as boolean;
|
||||||
|
|
||||||
|
propertyName = 'items';
|
||||||
|
|
||||||
|
if(!returnAll) {
|
||||||
|
const limit = this.getNodeParameter('limit', i) as number;
|
||||||
|
|
||||||
|
qs = {
|
||||||
|
'limit': limit
|
||||||
|
};
|
||||||
|
|
||||||
|
responseData = await spotifyApiRequest.call(this, requestMethod, endpoint, body, qs);
|
||||||
|
|
||||||
|
responseData = responseData.items;
|
||||||
|
}
|
||||||
|
} else if(operation === 'getRelatedArtists') {
|
||||||
|
|
||||||
|
endpoint = `/artists/${id}/related-artists`;
|
||||||
|
|
||||||
|
responseData = await spotifyApiRequest.call(this, requestMethod, endpoint, body, qs);
|
||||||
|
|
||||||
|
responseData = responseData.artists;
|
||||||
|
|
||||||
|
} else if(operation === 'getTopTracks'){
|
||||||
|
const country = this.getNodeParameter('country', i) as string;
|
||||||
|
|
||||||
|
qs = {
|
||||||
|
'country': country
|
||||||
|
};
|
||||||
|
|
||||||
|
endpoint = `/artists/${id}/top-tracks`;
|
||||||
|
|
||||||
|
responseData = await spotifyApiRequest.call(this, requestMethod, endpoint, body, qs);
|
||||||
|
|
||||||
|
responseData = responseData.tracks;
|
||||||
|
|
||||||
|
} else if (operation === 'get') {
|
||||||
|
|
||||||
|
requestMethod = 'GET';
|
||||||
|
|
||||||
|
endpoint = `/artists/${id}`;
|
||||||
|
|
||||||
|
responseData = await spotifyApiRequest.call(this, requestMethod, endpoint, body, qs);
|
||||||
|
}
|
||||||
|
// -----------------------------
|
||||||
|
// Playlist Operations
|
||||||
|
// -----------------------------
|
||||||
|
} else if( resource === 'playlist') {
|
||||||
|
if(['delete', 'get', 'getTracks', 'add'].includes(operation)) {
|
||||||
|
const uri = this.getNodeParameter('id', i) as string;
|
||||||
|
|
||||||
|
const id = uri.replace('spotify:playlist:', '');
|
||||||
|
|
||||||
|
if(operation === 'delete') {
|
||||||
|
requestMethod = 'DELETE';
|
||||||
|
const trackId = this.getNodeParameter('trackID', i) as string;
|
||||||
|
|
||||||
|
body.tracks = [
|
||||||
|
{
|
||||||
|
"uri": `${trackId}`,
|
||||||
|
"positions": [ 0 ]
|
||||||
|
}
|
||||||
|
];
|
||||||
|
|
||||||
|
endpoint = `/playlists/${id}/tracks`;
|
||||||
|
|
||||||
|
responseData = await spotifyApiRequest.call(this, requestMethod, endpoint, body, qs);
|
||||||
|
|
||||||
|
responseData = { success: true };
|
||||||
|
|
||||||
|
} else if(operation === 'get') {
|
||||||
|
requestMethod = 'GET';
|
||||||
|
|
||||||
|
endpoint = `/playlists/${id}`;
|
||||||
|
|
||||||
|
responseData = await spotifyApiRequest.call(this, requestMethod, endpoint, body, qs);
|
||||||
|
|
||||||
|
} else if(operation === 'getTracks') {
|
||||||
|
requestMethod = 'GET';
|
||||||
|
|
||||||
|
endpoint = `/playlists/${id}/tracks`;
|
||||||
|
|
||||||
|
returnAll = this.getNodeParameter('returnAll', i) as boolean;
|
||||||
|
|
||||||
|
propertyName = 'items';
|
||||||
|
|
||||||
|
if(!returnAll) {
|
||||||
|
const limit = this.getNodeParameter('limit', i) as number;
|
||||||
|
|
||||||
|
qs = {
|
||||||
|
'limit': limit
|
||||||
|
};
|
||||||
|
|
||||||
|
responseData = await spotifyApiRequest.call(this, requestMethod, endpoint, body, qs);
|
||||||
|
|
||||||
|
responseData = responseData.items;
|
||||||
|
}
|
||||||
|
} else if(operation === 'add') {
|
||||||
|
requestMethod = 'POST';
|
||||||
|
|
||||||
|
const trackId = this.getNodeParameter('trackID', i) as string;
|
||||||
|
|
||||||
|
qs = {
|
||||||
|
'uris': trackId
|
||||||
|
};
|
||||||
|
|
||||||
|
endpoint = `/playlists/${id}/tracks`;
|
||||||
|
|
||||||
|
responseData = await spotifyApiRequest.call(this, requestMethod, endpoint, body, qs);
|
||||||
|
|
||||||
|
}
|
||||||
|
} else if(operation === 'getUserPlaylists') {
|
||||||
|
requestMethod = 'GET';
|
||||||
|
|
||||||
|
endpoint = `/me/playlists`;
|
||||||
|
|
||||||
|
returnAll = this.getNodeParameter('returnAll', i) as boolean;
|
||||||
|
|
||||||
|
propertyName = 'items';
|
||||||
|
|
||||||
|
if(!returnAll) {
|
||||||
|
const limit = this.getNodeParameter('limit', i) as number;
|
||||||
|
|
||||||
|
qs = {
|
||||||
|
'limit': limit
|
||||||
|
};
|
||||||
|
|
||||||
|
responseData = await spotifyApiRequest.call(this, requestMethod, endpoint, body, qs);
|
||||||
|
|
||||||
|
responseData = responseData.items;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// -----------------------------
|
||||||
|
// Track Operations
|
||||||
|
// -----------------------------
|
||||||
|
} else if( resource === 'track') {
|
||||||
|
const uri = this.getNodeParameter('id', i) as string;
|
||||||
|
|
||||||
|
const id = uri.replace('spotify:track:', '');
|
||||||
|
|
||||||
|
requestMethod = 'GET';
|
||||||
|
|
||||||
|
if(operation === 'getAudioFeatures') {
|
||||||
|
endpoint = `/audio-features/${id}`;
|
||||||
|
} else if(operation === 'get') {
|
||||||
|
endpoint = `/tracks/${id}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
responseData = await spotifyApiRequest.call(this, requestMethod, endpoint, body, qs);
|
||||||
|
}
|
||||||
|
|
||||||
|
if(returnAll) {
|
||||||
|
responseData = await spotifyApiRequestAllItems.call(this, propertyName, requestMethod, endpoint, body, qs);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (Array.isArray(responseData)) {
|
||||||
|
returnData.push.apply(returnData, responseData as IDataObject[]);
|
||||||
|
} else {
|
||||||
|
returnData.push(responseData as IDataObject);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return [this.helpers.returnJsonArray(returnData)];
|
||||||
|
}
|
||||||
|
}
|
||||||
BIN
packages/nodes-base/nodes/Spotify/spotify.png
Normal file
BIN
packages/nodes-base/nodes/Spotify/spotify.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.5 KiB |
|
|
@ -119,6 +119,7 @@
|
||||||
"dist/credentials/StripeApi.credentials.js",
|
"dist/credentials/StripeApi.credentials.js",
|
||||||
"dist/credentials/SalesmateApi.credentials.js",
|
"dist/credentials/SalesmateApi.credentials.js",
|
||||||
"dist/credentials/SegmentApi.credentials.js",
|
"dist/credentials/SegmentApi.credentials.js",
|
||||||
|
"dist/credentials/SpotifyOAuth2Api.credentials.js",
|
||||||
"dist/credentials/SurveyMonkeyApi.credentials.js",
|
"dist/credentials/SurveyMonkeyApi.credentials.js",
|
||||||
"dist/credentials/SurveyMonkeyOAuth2Api.credentials.js",
|
"dist/credentials/SurveyMonkeyOAuth2Api.credentials.js",
|
||||||
"dist/credentials/TelegramApi.credentials.js",
|
"dist/credentials/TelegramApi.credentials.js",
|
||||||
|
|
@ -263,6 +264,7 @@
|
||||||
"dist/nodes/Slack/Slack.node.js",
|
"dist/nodes/Slack/Slack.node.js",
|
||||||
"dist/nodes/Sms77/Sms77.node.js",
|
"dist/nodes/Sms77/Sms77.node.js",
|
||||||
"dist/nodes/SplitInBatches.node.js",
|
"dist/nodes/SplitInBatches.node.js",
|
||||||
|
"dist/nodes/Spotify/Spotify.node.js",
|
||||||
"dist/nodes/SpreadsheetFile.node.js",
|
"dist/nodes/SpreadsheetFile.node.js",
|
||||||
"dist/nodes/SseTrigger.node.js",
|
"dist/nodes/SseTrigger.node.js",
|
||||||
"dist/nodes/Start.node.js",
|
"dist/nodes/Start.node.js",
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue