@wwdrew/expo-spotify-sdk 0.2.0 → 0.3.0

package/README.md

@@ -24,9 +24,7 @@ Include the `expo-spotify-sdk` plugin in your `app.json/app.config.js` file with
     ["@wwdrew/expo-spotify-sdk", {
       "clientID": "<your-spotify-client-id>",
       "scheme": "expo-spotify-sdk-example",
-      "host": "authenticate",
-      "tokenSwapURL": "http://192.168.0.5:3000/swap",
-      "tokenRefreshURL": "http://192.168.0.5:3000/swap"
+      "host": "authenticate"
     }]
   ],
   ...
@@ -37,23 +35,27 @@ Required:
 - `clientID`: &lt;string&gt; the Spotify Client ID for your application
 - `scheme`: &lt;string&gt; the [URL scheme](https://docs.expo.dev/versions/latest/config/app/#scheme) to link into your app as part of the redirect URI
 - `host`: &lt;string&gt; the path of the redirect URI
-- `tokenSwapURL` (optional): &lt;string&gt; The URL to use for attempting to swap an authorization code for an access token
-- `tokenRefreshURL` (optional): &lt;string&gt; The URL to use for attempting to renew an access token with a refresh token
 
 ## API Reference
 
-`isAvailable(): boolean`
+```typescript
+isAvailable(): boolean`
+```
 
 Determines if the Spotify app is installed on the target device.
 
 ---
 
-`authenticateAsync(scopes: SpotifyScope[]): Promise<SpotifySesson>`
+```typescript
+authenticateAsync(config: SpotifyConfig): Promise<SpotifySession>
+```
 
 Starts the authentication process. Requires an array of OAuth scopes. If the Spotify app is installed on the target device it will interact directly with it, otherwise it will open a web view to authenticate with the Spotify website.
 
 ### Parameters
 
+- `tokenSwapURL` (optional): &lt;string&gt; The URL to use for attempting to swap an authorization code for an access token
+- `tokenRefreshURL` (optional): &lt;string&gt; The URL to use for attempting to renew an access token with a refresh token
 - `scopes`: An array of OAuth scopes that declare how your app wants to access a user's account. See [Spotify Scopes](https://developer.spotify.com/web-api/using-scopes/) for more information.
 
   **Note**: The following scopes are not available to Expo Spotify SDK:
@@ -68,11 +70,18 @@ Starts the authentication process. Requires an array of OAuth scopes. If the Spo
 ### Types
 
 ```typescript
+interface SpotifyConfig {
+  scopes: SpotifyScope[];
+  tokenSwapURL?: string;
+  tokenRefreshURL?: string;
+}
+
 interface SpotifySession {
   accessToken: string;
   refreshToken: string;
   expirationDate: number;
   isExpired: boolean;
+  scopes: SpotifyScopes[];
 }
 
 type SpotifyScopes =
@@ -94,12 +103,11 @@ type SpotifyScopes =
   | "user-library-read"
   | "user-read-email"
   | "user-read-private";
-
 ```
 
 ## Acknowledgments
 
-This project has been heavily inspired by the following projects.
+This project has been heavily inspired by the following projects:
 
 * [react-native-spotify-remote](https://github.com/cjam/react-native-spotify-remote)
 * [expo-spotify](https://github.com/kvbalib/expo-spotify)

package/build/ExpoSpotifySDK.types.d.ts

@@ -3,11 +3,13 @@ export interface SpotifySession {
     refreshToken: string;
     expirationDate: number;
     isExpired: boolean;
+    scopes: SpotifyScope[];
 }
 export interface SpotifyConfig {
     scopes: SpotifyScope[];
     tokenSwapURL?: string;
     tokenRefreshURL?: string;
+    shouldRequestAccessToken?: boolean;
 }
 export type SpotifyScope = "ugc-image-upload" | "user-read-playback-state" | "user-modify-playback-state" | "user-read-currently-playing" | "app-remote-control" | "streaming" | "playlist-read-private" | "playlist-read-collaborative" | "playlist-modify-private" | "playlist-modify-public" | "user-follow-modify" | "user-follow-read" | "user-top-read" | "user-read-recently-played" | "user-library-modify" | "user-library-read" | "user-read-email" | "user-read-private";
 //# sourceMappingURL=ExpoSpotifySDK.types.d.ts.map

package/build/ExpoSpotifySDK.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ExpoSpotifySDK.types.d.ts","sourceRoot":"","sources":["../src/ExpoSpotifySDK.types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,YAAY,EAAE,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,MAAM,YAAY,GACpB,kBAAkB,GAClB,0BAA0B,GAC1B,4BAA4B,GAC5B,6BAA6B,GAC7B,oBAAoB,GACpB,WAAW,GACX,uBAAuB,GACvB,6BAA6B,GAC7B,yBAAyB,GACzB,wBAAwB,GACxB,oBAAoB,GACpB,kBAAkB,GAClB,eAAe,GACf,2BAA2B,GAC3B,qBAAqB,GACrB,mBAAmB,GACnB,iBAAiB,GACjB,mBAAmB,CAAC"}
+{"version":3,"file":"ExpoSpotifySDK.types.d.ts","sourceRoot":"","sources":["../src/ExpoSpotifySDK.types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,OAAO,CAAC;IACnB,MAAM,EAAE,YAAY,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,YAAY,EAAE,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,wBAAwB,CAAC,EAAE,OAAO,CAAC;CACpC;AAED,MAAM,MAAM,YAAY,GACpB,kBAAkB,GAClB,0BAA0B,GAC1B,4BAA4B,GAC5B,6BAA6B,GAC7B,oBAAoB,GACpB,WAAW,GACX,uBAAuB,GACvB,6BAA6B,GAC7B,yBAAyB,GACzB,wBAAwB,GACxB,oBAAoB,GACpB,kBAAkB,GAClB,eAAe,GACf,2BAA2B,GAC3B,qBAAqB,GACrB,mBAAmB,GACnB,iBAAiB,GACjB,mBAAmB,CAAC"}

package/build/ExpoSpotifySDK.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"ExpoSpotifySDK.types.js","sourceRoot":"","sources":["../src/ExpoSpotifySDK.types.ts"],"names":[],"mappings":"","sourcesContent":["export interface SpotifySession {\n  accessToken: string;\n  refreshToken: string;\n  expirationDate: number;\n  isExpired: boolean;\n}\n\nexport interface SpotifyConfig {\n  scopes: SpotifyScope[];\n  tokenSwapURL?: string;\n  tokenRefreshURL?: string;\n}\n\nexport type SpotifyScope =\n  | \"ugc-image-upload\"\n  | \"user-read-playback-state\"\n  | \"user-modify-playback-state\"\n  | \"user-read-currently-playing\"\n  | \"app-remote-control\"\n  | \"streaming\"\n  | \"playlist-read-private\"\n  | \"playlist-read-collaborative\"\n  | \"playlist-modify-private\"\n  | \"playlist-modify-public\"\n  | \"user-follow-modify\"\n  | \"user-follow-read\"\n  | \"user-top-read\"\n  | \"user-read-recently-played\"\n  | \"user-library-modify\"\n  | \"user-library-read\"\n  | \"user-read-email\"\n  | \"user-read-private\";\n"]}
+{"version":3,"file":"ExpoSpotifySDK.types.js","sourceRoot":"","sources":["../src/ExpoSpotifySDK.types.ts"],"names":[],"mappings":"","sourcesContent":["export interface SpotifySession {\n  accessToken: string;\n  refreshToken: string;\n  expirationDate: number;\n  isExpired: boolean;\n  scopes: SpotifyScope[];\n}\n\nexport interface SpotifyConfig {\n  scopes: SpotifyScope[];\n  tokenSwapURL?: string;\n  tokenRefreshURL?: string;\n  shouldRequestAccessToken?: boolean;\n}\n\nexport type SpotifyScope =\n  | \"ugc-image-upload\"\n  | \"user-read-playback-state\"\n  | \"user-modify-playback-state\"\n  | \"user-read-currently-playing\"\n  | \"app-remote-control\"\n  | \"streaming\"\n  | \"playlist-read-private\"\n  | \"playlist-read-collaborative\"\n  | \"playlist-modify-private\"\n  | \"playlist-modify-public\"\n  | \"user-follow-modify\"\n  | \"user-follow-read\"\n  | \"user-top-read\"\n  | \"user-read-recently-played\"\n  | \"user-library-modify\"\n  | \"user-library-read\"\n  | \"user-read-email\"\n  | \"user-read-private\";\n"]}

package/ios/ExpoSpotifySDKModule.swift

@@ -2,38 +2,44 @@ import ExpoModulesCore
 import SpotifyiOS
 
 public class ExpoSpotifySDKModule: Module {
-
+    
     public func definition() -> ModuleDefinition {
-
+        
         let spotifySession = ExpoSpotifySessionManager.shared
-
+        
         Name("ExpoSpotifySDK")
-
+        
         Function("isAvailable") {
             return spotifySession.spotifyAppInstalled()
         }
-
+        
         AsyncFunction("authenticateAsync") { (config: [String: Any], promise: Promise) in
             guard let scopes = config["scopes"] as? [String] else {
                 promise.reject("INVALID_CONFIG", "Invalid SpotifyConfig object")
                 return
             }
-
+            
             let tokenSwapURL = config["tokenSwapURL"] as? String
             let tokenRefreshURL = config["tokenRefreshURL"] as? String
-
-            spotifySession.authenticate(scopes: scopes, tokenSwapURL: tokenSwapURL, tokenRefreshURL: tokenRefreshURL).done { session in
-                let sessionData: [String: Any] = [
-                    "accessToken": session.accessToken,
-                    "refreshToken": session.refreshToken,
-                    "expirationDate": Int(session.expirationDate.timeIntervalSince1970 * 1000),
-                    "scopes": SPTScopeSerializer.serializeScopes(session.scope),
-                    "isExpired": session.isExpired
-                ]
-                promise.resolve(sessionData)
+            let shouldRequestAccessToken = config["shouldRequestAccessToken"] as? Bool ?? true
+            
+            spotifySession.authenticate(scopes: scopes, tokenSwapURL: tokenSwapURL, tokenRefreshURL: tokenRefreshURL, shouldRequestAccessToken: shouldRequestAccessToken).done { result in
+                switch result {
+                case .session(let session):
+                    promise.resolve([
+                        "accessToken": session.accessToken,
+                        "refreshToken": session.refreshToken,
+                        "expirationDate": Int(session.expirationDate.timeIntervalSince1970 * 1000),
+                        "scopes": SPTScopeSerializer.serializeScopes(session.scope),
+                        "isExpired": session.isExpired
+                    ])
+                case .authorizationCode(let code):
+                    promise.resolve(["code": code])
+                }
             }.catch { error in
                 promise.reject(error)
             }
         }
+        
     }
 }

package/ios/ExpoSpotifySessionManager+SessionManagerDelegate.swift

@@ -3,14 +3,24 @@ import SpotifyiOS
 
 extension ExpoSpotifySessionManager: SPTSessionManagerDelegate {
     public func sessionManager(manager _: SPTSessionManager, didInitiate session: SPTSession) {
-        authPromiseSeal?.fulfill(session)
+        if shouldRequestAccessToken {
+            authPromiseSeal?.fulfill(AuthenticationResult.session(session))
+        }
     }
-
+    
     public func sessionManager(manager _: SPTSessionManager, didFailWith error: Error) {
         authPromiseSeal?.reject(error)
     }
-
+    
     public func sessionManager(manager _: SPTSessionManager, didRenew session: SPTSession) {
-        authPromiseSeal?.fulfill(session)
+        authPromiseSeal?.fulfill(AuthenticationResult.session(session))
+    }
+    
+    public func sessionManager(manager: SPTSessionManager, shouldRequestAccessTokenWith code: String) -> Bool {
+        if !shouldRequestAccessToken {
+            authPromiseSeal?.fulfill(AuthenticationResult.authorizationCode(code))
+        }
+        
+        return shouldRequestAccessToken
     }
 }

package/ios/ExpoSpotifySessionManager.swift

@@ -2,6 +2,11 @@ import ExpoModulesCore
 import SpotifyiOS
 import PromiseKit
 
+enum AuthenticationResult {
+    case session(SPTSession)
+    case authorizationCode(String)
+}
+
 enum SessionManagerError: Error {
     case notInitialized
     case invalidConfiguration
@@ -9,7 +14,9 @@ enum SessionManagerError: Error {
 
 final class ExpoSpotifySessionManager: NSObject {
     weak var module: ExpoSpotifySDKModule?
-    var authPromiseSeal: Resolver<SPTSession>?
+    var authPromiseSeal: Resolver<AuthenticationResult>?
+    
+    var shouldRequestAccessToken: Bool = true
     
     static let shared = ExpoSpotifySessionManager()
     
@@ -44,7 +51,7 @@ final class ExpoSpotifySessionManager: NSObject {
     }()
     
     
-    func authenticate(scopes: [String], tokenSwapURL: String?, tokenRefreshURL: String?) -> PromiseKit.Promise<SPTSession> {
+    func authenticate(scopes: [String], tokenSwapURL: String?, tokenRefreshURL: String?, shouldRequestAccessToken: Bool = true) -> PromiseKit.Promise<AuthenticationResult> {
         return Promise { seal in
             guard let clientID = expoSpotifyConfiguration?.clientID,
                   let redirectURL = expoSpotifyConfiguration?.redirectURL else {
@@ -53,10 +60,17 @@ final class ExpoSpotifySessionManager: NSObject {
                 return
             }
             let configuration = SPTConfiguration(clientID: clientID, redirectURL: redirectURL)
-
-            configuration.tokenSwapURL = URL(string: tokenSwapURL ?? "")
-            configuration.tokenRefreshURL = URL(string: tokenRefreshURL ?? "")
             
+            if (tokenSwapURL != nil) {
+                configuration.tokenSwapURL = URL(string: tokenSwapURL ?? "")
+            }
+            
+            if (tokenRefreshURL != nil) {
+                configuration.tokenRefreshURL = URL(string: tokenRefreshURL ?? "")
+            }
+            
+            self.shouldRequestAccessToken = shouldRequestAccessToken
+            self.configuration = configuration
             self.sessionManager = SPTSessionManager(configuration: configuration, delegate: self)
             
             self.authPromiseSeal = seal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wwdrew/expo-spotify-sdk",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Expo Module for native Spotify SDK",
   "main": "build/index.js",
   "types": "build/index.d.ts",