@foxtware/mineral 0.1.28 → 0.1.29

package/api/spotify/spotifyPlayerPrevious.js

@@ -0,0 +1,55 @@
+// https://developer.spotify.com/documentation/web-api/reference/skip-users-playback-to-previous-track
+
+const { ArgsWarden, logDeep } = require('../utils');
+const { credsValidator } = require('../validators');
+const { spotifyClient } = require('../spotify/spotify.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const spotifyPlayerPrevious = async (
+  credsPayload,
+  {
+    deviceId,
+    fetchClient = spotifyClient,
+  } = {},
+) => {
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const response = await fetchClient.fetch({
+    context: { credsPayload },
+    requestPayload: {
+      method: 'post',
+      url: '/me/player/previous',
+      params: {
+        ...(deviceId !== undefined && { device_id: deviceId }),
+      },
+    },
+  });
+
+  const { ok, data, error } = response;
+  if (!ok) {
+    logDeep({ error });
+    return { ok: false, error };
+  }
+
+  return {
+    ok: true,
+    data: data ?? null,
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  spotifyPlayerPrevious,
+  funcApiConfig,
+};

package/api/spotify/spotifyPlaylistCreate.js

@@ -0,0 +1,63 @@
+// https://developer.spotify.com/documentation/web-api/reference/create-playlist
+
+const { ArgsWarden, logDeep } = require('../utils');
+const { credsValidator } = require('../validators');
+const { spotifyClient } = require('../spotify/spotify.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['userId'],
+  ['name'],
+]);
+
+const spotifyPlaylistCreate = async (
+  credsPayload,
+  userId,
+  name,
+  {
+    public: isPublic = true,
+    collaborative = false,
+    description,
+    fetchClient = spotifyClient,
+  } = {},
+) => {
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    userId,
+    name,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const response = await fetchClient.fetch({
+    context: { credsPayload },
+    requestPayload: {
+      method: 'post',
+      url: `/users/${ userId }/playlists`,
+      body: {
+        name,
+        public: isPublic,
+        collaborative,
+        ...(description !== undefined && { description }),
+      },
+    },
+  });
+
+  const { ok, data, error } = response;
+  if (!ok) {
+    logDeep({ error });
+    return { ok: false, error };
+  }
+
+  return { ok: true, data };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  spotifyPlaylistCreate,
+  funcApiConfig,
+};

package/api/spotify/spotifyPlaylistGet.js

@@ -0,0 +1,91 @@
+// https://developer.spotify.com/documentation/web-api/reference/get-playlist
+
+const { ArgsWarden, actionSingleOrMultiple, logDeep } = require('../utils');
+const { credsValidator } = require('../validators');
+const { spotifyClient } = require('../spotify/spotify.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['playlistId'],
+]);
+
+const spotifyPlaylistGetSingle = async (
+  credsPayload,
+  playlistId,
+  {
+    market,
+    fields,
+    additionalTypes,
+    fetchClient = spotifyClient,
+  } = {},
+) => {
+  const response = await fetchClient.fetch({
+    context: { credsPayload },
+    requestPayload: {
+      method: 'get',
+      url: `/playlists/${ playlistId }`,
+      params: {
+        ...(market !== undefined && { market }),
+        ...(fields !== undefined && { fields }),
+        ...(additionalTypes !== undefined && {
+          additional_types: Array.isArray(additionalTypes)
+            ? additionalTypes.join(',')
+            : additionalTypes,
+        }),
+      },
+    },
+  });
+
+  const { ok, data, error } = response;
+  if (!ok) {
+    logDeep({ error });
+    return { ok: false, error };
+  }
+
+  return { ok: true, data };
+};
+
+const spotifyPlaylistGet = async (
+  credsPayload,
+  playlistId,
+  {
+    market,
+    fields,
+    additionalTypes,
+    queueRunOptions,
+    fetchClient,
+  } = {},
+) => {
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    playlistId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return actionSingleOrMultiple(
+    playlistId,
+    spotifyPlaylistGetSingle,
+    (playlistIdItem) => ({
+      args: [credsPayload, playlistIdItem, {
+        market,
+        fields,
+        additionalTypes,
+        fetchClient,
+      }],
+    }),
+    {
+      ...(queueRunOptions ? { queueRunOptions } : {}),
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  spotifyPlaylistGet,
+  funcApiConfig,
+};

package/api/spotify/spotifyPlaylistItemsAdd.js

@@ -0,0 +1,61 @@
+// https://developer.spotify.com/documentation/web-api/reference/add-items-to-playlist
+
+const { ArgsWarden, logDeep } = require('../utils');
+const { credsValidator } = require('../validators');
+const { spotifyClient } = require('../spotify/spotify.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['playlistId'],
+  ['uris'],
+]);
+
+const spotifyPlaylistItemsAdd = async (
+  credsPayload,
+  playlistId,
+  uris,
+  {
+    position,
+    fetchClient = spotifyClient,
+  } = {},
+) => {
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    playlistId,
+    uris,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const uriList = Array.isArray(uris) ? uris : [uris];
+
+  const response = await fetchClient.fetch({
+    context: { credsPayload },
+    requestPayload: {
+      method: 'post',
+      url: `/playlists/${ playlistId }/items`,
+      body: {
+        uris: uriList,
+        ...(position !== undefined && { position }),
+      },
+    },
+  });
+
+  const { ok, data, error } = response;
+  if (!ok) {
+    logDeep({ error });
+    return { ok: false, error };
+  }
+
+  return { ok: true, data };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  spotifyPlaylistItemsAdd,
+  funcApiConfig,
+};

package/api/spotify/spotifyPlaylistItemsGet.js

@@ -0,0 +1,58 @@
+// https://developer.spotify.com/documentation/web-api/reference/get-playlists-items
+// (formerly /tracks; renamed to /items)
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { spotifyGet } = require('../spotify/spotifyGet');
+const { MAX_PER_PAGE } = require('../spotify/spotify.constants');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['playlistId'],
+]);
+
+const spotifyPlaylistItemsGet = async (
+  credsPayload,
+  playlistId,
+  {
+    market,
+    fields,
+    additionalTypes,
+    perPage = MAX_PER_PAGE,
+    fetchClient,
+    ...getterOptions
+  } = {},
+) => {
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    playlistId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return spotifyGet(credsPayload, `/playlists/${ playlistId }/items`, {
+    params: {
+      ...(market !== undefined && { market }),
+      ...(fields !== undefined && { fields }),
+      ...(additionalTypes !== undefined && {
+        additional_types: Array.isArray(additionalTypes)
+          ? additionalTypes.join(',')
+          : additionalTypes,
+      }),
+    },
+    perPage,
+    resultsKey: 'items',
+    fetchClient,
+    ...getterOptions,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  spotifyPlaylistItemsGet,
+  funcApiConfig,
+};

package/api/spotify/spotifyPlaylistItemsRemove.js

@@ -0,0 +1,67 @@
+// https://developer.spotify.com/documentation/web-api/reference/remove-playlist-items
+
+const { ArgsWarden, logDeep } = require('../utils');
+const { credsValidator } = require('../validators');
+const { spotifyClient } = require('../spotify/spotify.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['playlistId'],
+  ['tracks'],
+]);
+
+// tracks: array of { uri, positions? } or array of uri strings
+const spotifyPlaylistItemsRemove = async (
+  credsPayload,
+  playlistId,
+  tracks,
+  {
+    snapshotId,
+    fetchClient = spotifyClient,
+  } = {},
+) => {
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    playlistId,
+    tracks,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const trackList = (Array.isArray(tracks) ? tracks : [tracks]).map((entry) => {
+    if (typeof entry === 'string') {
+      return { uri: entry };
+    }
+    return entry;
+  });
+
+  const response = await fetchClient.fetch({
+    context: { credsPayload },
+    requestPayload: {
+      method: 'delete',
+      url: `/playlists/${ playlistId }/items`,
+      body: {
+        tracks: trackList,
+        ...(snapshotId !== undefined && { snapshot_id: snapshotId }),
+      },
+    },
+  });
+
+  const { ok, data, error } = response;
+  if (!ok) {
+    logDeep({ error });
+    return { ok: false, error };
+  }
+
+  return { ok: true, data };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  spotifyPlaylistItemsRemove,
+  funcApiConfig,
+};

package/api/spotify/spotifyPlaylistUpdate.js

@@ -0,0 +1,64 @@
+// https://developer.spotify.com/documentation/web-api/reference/change-playlist-details
+
+const { ArgsWarden, logDeep } = require('../utils');
+const { credsValidator } = require('../validators');
+const { spotifyClient } = require('../spotify/spotify.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['playlistId'],
+]);
+
+const spotifyPlaylistUpdate = async (
+  credsPayload,
+  playlistId,
+  {
+    name,
+    public: isPublic,
+    collaborative,
+    description,
+    fetchClient = spotifyClient,
+  } = {},
+) => {
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    playlistId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const response = await fetchClient.fetch({
+    context: { credsPayload },
+    requestPayload: {
+      method: 'put',
+      url: `/playlists/${ playlistId }`,
+      body: {
+        ...(name !== undefined && { name }),
+        ...(isPublic !== undefined && { public: isPublic }),
+        ...(collaborative !== undefined && { collaborative }),
+        ...(description !== undefined && { description }),
+      },
+    },
+  });
+
+  const { ok, data, error } = response;
+  if (!ok) {
+    logDeep({ error });
+    return { ok: false, error };
+  }
+
+  return {
+    ok: true,
+    data: data ?? null,
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  spotifyPlaylistUpdate,
+  funcApiConfig,
+};

package/api/spotify/spotifyPlaylistsGet.js

@@ -0,0 +1,47 @@
+// https://developer.spotify.com/documentation/web-api/reference/get-a-list-of-current-users-playlists
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { spotifyGet } = require('../spotify/spotifyGet');
+const { MAX_PER_PAGE } = require('../spotify/spotify.constants');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const spotifyPlaylistsGet = async (
+  credsPayload,
+  {
+    userId,
+    perPage = MAX_PER_PAGE,
+    fetchClient,
+    ...getterOptions
+  } = {},
+) => {
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const url = userId
+    ? `/users/${ userId }/playlists`
+    : '/me/playlists';
+
+  return spotifyGet(credsPayload, url, {
+    perPage,
+    resultsKey: 'items',
+    fetchClient,
+    ...getterOptions,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  spotifyPlaylistsGet,
+  funcApiConfig,
+};

package/api/spotify/spotifySavedTracksGet.js

@@ -0,0 +1,46 @@
+// https://developer.spotify.com/documentation/web-api/reference/get-users-saved-tracks
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { spotifyGet } = require('../spotify/spotifyGet');
+const { MAX_PER_PAGE } = require('../spotify/spotify.constants');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const spotifySavedTracksGet = async (
+  credsPayload,
+  {
+    market,
+    perPage = MAX_PER_PAGE,
+    fetchClient,
+    ...getterOptions
+  } = {},
+) => {
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return spotifyGet(credsPayload, '/me/tracks', {
+    params: {
+      ...(market !== undefined && { market }),
+    },
+    perPage,
+    resultsKey: 'items',
+    fetchClient,
+    ...getterOptions,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  spotifySavedTracksGet,
+  funcApiConfig,
+};

package/api/spotify/spotifySavedTracksRemove.js

@@ -0,0 +1,59 @@
+// https://developer.spotify.com/documentation/web-api/reference/remove-tracks-user
+
+const { ArgsWarden, logDeep } = require('../utils');
+const { credsValidator } = require('../validators');
+const { spotifyClient } = require('../spotify/spotify.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['ids'],
+]);
+
+const spotifySavedTracksRemove = async (
+  credsPayload,
+  ids,
+  {
+    fetchClient = spotifyClient,
+  } = {},
+) => {
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    ids,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const idList = Array.isArray(ids) ? ids : [ids];
+
+  const response = await fetchClient.fetch({
+    context: { credsPayload },
+    requestPayload: {
+      method: 'delete',
+      url: '/me/tracks',
+      params: {
+        ids: idList.join(','),
+      },
+    },
+  });
+
+  const { ok, data, error } = response;
+  if (!ok) {
+    logDeep({ error });
+    return { ok: false, error };
+  }
+
+  return {
+    ok: true,
+    data: data ?? null,
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  spotifySavedTracksRemove,
+  funcApiConfig,
+};

package/api/spotify/spotifySavedTracksSave.js

@@ -0,0 +1,59 @@
+// https://developer.spotify.com/documentation/web-api/reference/save-tracks-user
+
+const { ArgsWarden, logDeep } = require('../utils');
+const { credsValidator } = require('../validators');
+const { spotifyClient } = require('../spotify/spotify.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['ids'],
+]);
+
+const spotifySavedTracksSave = async (
+  credsPayload,
+  ids,
+  {
+    fetchClient = spotifyClient,
+  } = {},
+) => {
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    ids,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const idList = Array.isArray(ids) ? ids : [ids];
+
+  const response = await fetchClient.fetch({
+    context: { credsPayload },
+    requestPayload: {
+      method: 'put',
+      url: '/me/tracks',
+      params: {
+        ids: idList.join(','),
+      },
+    },
+  });
+
+  const { ok, data, error } = response;
+  if (!ok) {
+    logDeep({ error });
+    return { ok: false, error };
+  }
+
+  return {
+    ok: true,
+    data: data ?? null,
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  spotifySavedTracksSave,
+  funcApiConfig,
+};