soundcloud-wrapper 0.9.1 → 0.9.3

package/README.md

@@ -0,0 +1,118 @@
+# Soundcloud Wrapper ☁️
+
+Soundcloud Wrapper is a fully open source, lightweight, strongly-typed Node.js wrapper for the Soundcloud Wrapper. It simplifies interaction with SoundCloud's services by providing an intuitive interface for authentication, track management, playlist operations, and user interactions. Built with TypeScript, it offers full type safety and seamless integration for Node.js applications.
+
+# Docs
+
+🔗 https://soundcloud-wrapper-docs.vercel.app/docs
+
+# Usage
+
+Please visit the docs for full guide on usage. The code samples below are to be seen as guidelines rather than straight copy and paste working solutions. Amend apporopriately to fit your tech stack/use case.
+
+## Get And Store Token
+
+```javascript
+import { Request, Response } from "express"
+import Token from "../models/token"
+import axios from "axios"
+import qs from "qs"
+
+export const getAccessToken = async (req: Request, res: Response) => {
+  // code in ?code= query from your redirectUri/frontend
+  const codeFromFrontend = req.query.code
+  // handle this however you need to, but ensure the logged in users userId is passed so it can be linked to the token later
+  const userId = req.userId
+
+  // build query to be passed to request
+  let data = qs.stringify({
+    grant_type: "authorization_code",
+    client_id: process.env.CLIENT_ID,
+    client_secret: process.env.CLIENT_SECRET,
+    redirect_uri: process.env.REDIRECT_URI,
+    code_verifier: process.env.PKCE_CODE_VERIFIER,
+    code: codeFromFrontend,
+  })
+
+  // define config for request
+  let config = {
+    method: "POST",
+    maxBodyLength: Infinity,
+    url: "https://secure.soundcloud.com/oauth/token",
+    headers: {
+      accept: "application/json; charset=utf-8",
+      "Content-Type": "application/x-www-form-urlencoded",
+    },
+    // pass query built above
+    data: data,
+  }
+
+  // send request to get token
+  const tokenRequest = await axios
+    .request(config)
+    .then((response) => {
+      // upon success return token
+      return response.data
+    })
+    .catch((error) => {
+      // if request fails log error
+      console.log(error)
+      throw new Error("Failed to get access token")
+    })
+
+  // link logged in userId to token
+  const tokenWithUserId = { ...tokenRequest, id: userId }
+
+  // save token with userId to DB
+  const token = new Token(tokenRequest)
+  await token.save()
+
+  return res.status(201).json({ message: "Successfully created token" })
+}
+```
+
+## Use Token
+
+```javascript
+import { Request, Response } from "express"
+import Token from "../models/token"
+import axios from "axios"
+
+export const getMe = async (req: Request, res: Response) => {
+  try {
+    // get token from DB
+    const token = await Token.findById(req.userId)
+
+    // define config for request
+    let config = {
+      method: "get",
+      maxBodyLength: Infinity,
+      url: `https://api.soundcloud.com/me`,
+      headers: {
+        accept: "application/json; charset=utf-8",
+        "Content-Type": "application/json; charset=utf-8",
+        // pass token to request
+        Authorization: `Bearer ${token}`,
+      },
+    }
+
+    // send request to get details of authenticated user
+    const me = await axios
+      .request(config)
+      .then((response: any) => {
+        // upon success return user data
+        return response.data
+      })
+      .catch((error: any) => {
+        // if request fails log error
+        console.log(error)
+        throw new Error("Failed to get me")
+      })
+    // return data of authenticated user
+    return res.status(200).json(me)
+  } catch (e) {
+    console.error(e)
+    throw new Error("Failed to get me")
+  }
+}
+```

package/index.d.ts

@@ -0,0 +1,81 @@
+declare module "soundcloud-wrapper" {
+  export default class SoundCloudClient {
+    constructor(clientId: string, clientSecret: string, redirectUri: string, PKCECodeVerifier: string)
+
+    tracks: {
+      getTrack(authToken: string, trackId: number): Promise<any>
+      getTrackStreams(authToken: string, trackId: number): Promise<any>
+      getTrackComments(authToken: string, trackId: number): Promise<any>
+      getTrackLikers(authToken: string, trackId: number): Promise<any>
+      getTrackReposters(authToken: string, trackId: number): Promise<any>
+      getRelatedTracks(authToken: string, trackId: number): Promise<any>
+      addComment(authToken: string, trackId: number, comment: { comment: { body: string; timestamp: string } }): Promise<any>
+      updateTrack(authToken: string, trackId: number, data: any): Promise<any>
+      deleteTrack(authToken: string, trackId: number): Promise<any>
+    }
+
+    playlists: {
+      getPlaylist(authToken: string, playlistId: number): Promise<any>
+      getPlaylistTracks(authToken: string, playlistId: number): Promise<any>
+      getPlaylistReposters(authToken: string, playlistId: number): Promise<any>
+      createPlaylist(authToken: string, playlistData: PlaylistData): Promise<any>
+      updatePlaylist(authToken: string, playlistId: number, playlistData: PlaylistData): Promise<any>
+      deletePlaylist(authToken: string, playlistId: number): Promise<any>
+    }
+
+    likes: {
+      likeTrack(authToken: string, trackId: number): Promise<any>
+      likePlaylist(authToken: string, playlistId: number): Promise<any>
+      unlikeTrack(authToken: string, trackId: number): Promise<any>
+      unlikePlaylist(authToken: string, playlistId: number): Promise<any>
+    }
+
+    me: {
+      me(authToken: string): Promise<any>
+      getActivity(authToken: string): Promise<any>
+      getTrackActivity(authToken: string): Promise<any>
+      getTrackLikes(authToken: string): Promise<any>
+      getPlaylistLikes(authToken: string): Promise<any>
+      getFollowings(authToken: string): Promise<any>
+      getFollowingsTracks(authToken: string): Promise<any>
+      followUser(authToken: string, userId: number): Promise<any>
+      unfollowUser(authToken: string, userId: number): Promise<any>
+    }
+
+    users: {
+      getUser(authToken: string, userId: number): Promise<any>
+      getUserFollowers(authToken: string, userId: number): Promise<any>
+      getUserFollowings(authToken: string, userId: number): Promise<any>
+      getUserPlaylists(authToken: string, userId: number): Promise<any>
+      getUserTracks(authToken: string, userId: number): Promise<any>
+      getUserWebProfiles(authToken: string, userId: number): Promise<any>
+      getUserLikedTracks(authToken: string, userId: number): Promise<any>
+      getUserLikedPlaylists(authToken: string, userId: number): Promise<any>
+    }
+
+    search: {
+      tracks(authToken: string, query: string): Promise<any>
+      playlists(authToken: string, query: string): Promise<any>
+      users(authToken: string, query: string): Promise<any>
+    }
+
+    token: {
+      getToken(PKCECodeChallenge: string): Promise<any>
+    }
+
+    misc: {
+      resolveUrl(authToken: string, url: string): Promise<any>
+    }
+  }
+
+  interface PlaylistData {
+    playlist: {
+      title: string
+      description: string
+      sharing: string
+      tracks: {
+        id: number
+      }[]
+    }
+  }
+}

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "soundcloud-wrapper",
-  "version": "0.9.1",
+  "version": "0.9.3",
   "description": "Node wrapper for the SoundCloud API",
   "main": "dist/index.js",
   "files": [
-    "dist"
+    "dist",
+    "index.d.ts"
   ],
-  "repository": "https://github.com/18-28/soundcloud-api",
-  "homepage": "https://github.com/18-28/soundcloud-api",
+  "repository": "https://github.com/18-28/soundcloud-wrapper",
+  "homepage": "https://soundcloud-wrapper-docs.vercel.app/docs",
   "scripts": {
     "build": "tsc",
     "prepare": "npm run build"