@wwdrew/expo-spotify-sdk 0.5.0 → 0.6.0

package/ios/SpotifyTokenRefreshClient.swift

@@ -0,0 +1,118 @@
+import Foundation
+
+enum SpotifyRefreshError: Error {
+  case invalidURL(String)
+  case network(Error)
+  case http(status: Int, body: String?)
+  case parse(String)
+
+  var code: String {
+    switch self {
+    case .invalidURL:  return "INVALID_CONFIG"
+    case .network:     return "NETWORK_ERROR"
+    case .http:        return "TOKEN_SWAP_FAILED"
+    case .parse:       return "TOKEN_SWAP_PARSE_ERROR"
+    }
+  }
+
+  var message: String {
+    switch self {
+    case .invalidURL(let s):
+      return "Invalid token refresh URL: \(s)"
+    case .network(let err):
+      return err.localizedDescription
+    case .http(let status, let body):
+      let trimmed = body.map { String($0.prefix(512)) } ?? ""
+      return "Token refresh server returned HTTP \(status)\(trimmed.isEmpty ? "" : ": \(trimmed)")"
+    case .parse(let m):
+      return m
+    }
+  }
+}
+
+struct SpotifyRefreshResult {
+  let accessToken: String
+  let refreshToken: String?
+  let expirationDate: Int64
+  let scopes: [String]
+}
+
+struct SpotifyTokenRefreshClient {
+  let sdkVersion: String
+  let clientID: String
+  let session: URLSession
+
+  init(sdkVersion: String, clientID: String, session: URLSession = .shared) {
+    self.sdkVersion = sdkVersion
+    self.clientID = clientID
+    self.session = session
+  }
+
+  func refresh(
+    refreshToken: String,
+    tokenRefreshURL urlString: String,
+    previousScopes: [String]
+  ) async throws -> SpotifyRefreshResult {
+    guard let url = URL(string: urlString) else {
+      throw SpotifyRefreshError.invalidURL(urlString)
+    }
+    var request = URLRequest(url: url)
+    request.httpMethod = "POST"
+    request.setValue("application/x-www-form-urlencoded", forHTTPHeaderField: "Content-Type")
+    request.setValue("expo-spotify-sdk/\(sdkVersion)", forHTTPHeaderField: "User-Agent")
+    request.httpBody = formURLEncoded([
+      "refresh_token": refreshToken,
+      "client_id": clientID,
+    ]).data(using: .utf8)
+
+    let data: Data
+    let response: URLResponse
+    do {
+      (data, response) = try await session.data(for: request)
+    } catch {
+      throw SpotifyRefreshError.network(error)
+    }
+
+    guard let http = response as? HTTPURLResponse else {
+      throw SpotifyRefreshError.parse("Non-HTTP response from refresh endpoint")
+    }
+    guard (200..<300).contains(http.statusCode) else {
+      let body = String(data: data, encoding: .utf8)
+      throw SpotifyRefreshError.http(status: http.statusCode, body: body)
+    }
+
+    let json: [String: Any]
+    do {
+      guard let parsed = try JSONSerialization.jsonObject(with: data) as? [String: Any] else {
+        throw SpotifyRefreshError.parse("Refresh response was not a JSON object")
+      }
+      json = parsed
+    } catch {
+      throw SpotifyRefreshError.parse("Refresh response was not valid JSON: \(error.localizedDescription)")
+    }
+
+    guard let accessToken = (json["access_token"] as? String), !accessToken.isEmpty else {
+      throw SpotifyRefreshError.parse("Refresh response missing required field: access_token")
+    }
+    guard let expiresIn = json["expires_in"] as? Int else {
+      throw SpotifyRefreshError.parse("Refresh response missing required field: expires_in")
+    }
+    let rotatedRefreshToken = (json["refresh_token"] as? String).flatMap { $0.isEmpty ? nil : $0 }
+    let scopeString = json["scope"] as? String
+    let scopes = scopeString?.split(separator: " ").map(String.init) ?? previousScopes
+    let expirationDate = Int64(Date().timeIntervalSince1970 * 1000) + Int64(expiresIn) * 1000
+
+    return SpotifyRefreshResult(
+      accessToken: accessToken,
+      refreshToken: rotatedRefreshToken ?? refreshToken,
+      expirationDate: expirationDate,
+      scopes: scopes
+    )
+  }
+
+  private func formURLEncoded(_ pairs: [String: String]) -> String {
+    var components = URLComponents()
+    components.queryItems = pairs.map { URLQueryItem(name: $0.key, value: $0.value) }
+    return components.percentEncodedQuery ?? ""
+  }
+}

package/package.json

@@ -1,16 +1,17 @@
 {
   "name": "@wwdrew/expo-spotify-sdk",
-  "version": "0.5.0",
-  "description": "Expo Module for native Spotify SDK",
+  "version": "0.6.0",
+  "description": "Expo module wrapping the native Spotify iOS (v5) and Android (v4) SDKs for OAuth authentication",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "scripts": {
     "build": "expo-module build",
     "clean": "expo-module clean",
     "lint": "expo-module lint",
-    "test": "expo-module test",
+    "test": "expo-module test plugin",
     "prepare": "expo-module prepare",
     "prepublishOnly": "expo-module prepublishOnly",
+    "typecheck": "expo-module typecheck",
     "expo-module": "expo-module",
     "open:ios": "open -a \"Xcode\" example/ios",
     "open:android": "open -a \"Android Studio\" example/android"
@@ -28,23 +29,23 @@
     "android",
     "ios",
     "app.plugin.js",
-    "expo-module.config.json",
-    "server.js"
+    "expo-module.config.json"
   ],
-  "jest": {
-    "preset": "expo-module-scripts"
-  },
   "repository": "https://github.com/wwdrew/expo-spotify-sdk",
   "bugs": {
     "url": "https://github.com/wwdrew/expo-spotify-sdk/issues"
   },
-  "author": "Drew Miller <49833875+wwdrew@users.noreply.github.com> (https:/github.com/wwdrew/)",
+  "author": "Drew Miller <49833875+wwdrew@users.noreply.github.com> (https://github.com/wwdrew/)",
   "license": "MIT",
   "homepage": "https://github.com/wwdrew/expo-spotify-sdk#readme",
   "devDependencies": {
+    "@expo/config-plugins": "^55.0.8",
     "@types/react": "^18.0.25",
-    "expo-module-scripts": "^3.1.0",
-    "expo-modules-core": "^1.5.11"
+    "eslint": "^9.0.0",
+    "expo-module-scripts": "^55.0.2",
+    "expo-modules-core": "^3.0.30",
+    "jest": "^29.7.0",
+    "prettier": "^3.0.0"
   },
   "peerDependencies": {
     "expo": "*",

package/plugin/build/android/withSpotifyAndroidAppBuildGradle.js

@@ -2,27 +2,32 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.withSpotifyAndroidAppBuildGradle = void 0;
 const config_plugins_1 = require("@expo/config-plugins");
+const SENTINEL_KEY = "spotifyClientId";
+const DEFAULT_REDIRECT_PATH_PATTERN = "/.*";
 const withSpotifyAndroidAppBuildGradle = (config, spotifyConfig) => {
     return (0, config_plugins_1.withAppBuildGradle)(config, (config) => {
-        const defaultConfigPattern = /(defaultConfig\s*{[\s\S]*?)(})/s;
-        const manifestPlaceholders = `
-        manifestPlaceholders = [
+        if (config.modResults.contents.includes(SENTINEL_KEY)) {
+            // Already injected on a previous prebuild; bail to keep this modifier
+            // idempotent. Run `expo prebuild --clean` to force a refresh.
+            return config;
+        }
+        const redirectPathPattern = spotifyConfig.redirectPathPattern ?? DEFAULT_REDIRECT_PATH_PATTERN;
+        const placeholders = `        manifestPlaceholders = [
           spotifyClientId: "${spotifyConfig.clientID}",
           spotifyRedirectUri: "${spotifyConfig.scheme}://${spotifyConfig.host}",
           redirectSchemeName: "${spotifyConfig.scheme}",
-          redirectHostName: "${spotifyConfig.host}"
-        ]
-    `;
+          redirectHostName: "${spotifyConfig.host}",
+          redirectPathPattern: "${redirectPathPattern}"
+        ]`;
+        const defaultConfigPattern = /(defaultConfig\s*\{[\s\S]*?)(\n\s*})/m;
         if (defaultConfigPattern.test(config.modResults.contents)) {
-            // If the defaultConfig block exists, add the manifestPlaceholders to it
-            config.modResults.contents = config.modResults.contents.replace(defaultConfigPattern, `$1${manifestPlaceholders}$2`);
+            config.modResults.contents = config.modResults.contents.replace(defaultConfigPattern, `$1\n${placeholders}$2`);
         }
         else {
-            // If the defaultConfig block doesn't exist, add it to the android block
             config.modResults.contents += `
 android {
     defaultConfig {
-        ${manifestPlaceholders}
+${placeholders}
     }
 }`;
         }

package/plugin/build/ios/withSpotifyConfigValues.js

@@ -2,15 +2,20 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.withSpotifyConfigValues = void 0;
 const config_plugins_1 = require("@expo/config-plugins");
+const IOS_KEYS = [
+    "clientID",
+    "host",
+    "scheme",
+];
 const withSpotifyConfigValues = (config, spotifyConfig) => (0, config_plugins_1.withInfoPlist)(config, (config) => {
-    if (!config.modResults.ExpoSpotifySDK) {
-        config.modResults.ExpoSpotifySDK = {};
+    const existing = (config.modResults.ExpoSpotifySDK ?? {});
+    for (const key of IOS_KEYS) {
+        const value = spotifyConfig[key];
+        if (typeof value === "string" && value.length > 0) {
+            existing[key] = value;
+        }
     }
-    const spotifySDKConfig = config.modResults
-        .ExpoSpotifySDK;
-    Object.entries(spotifyConfig).forEach(([key, value]) => {
-        spotifySDKConfig[key] = value;
-    });
+    config.modResults.ExpoSpotifySDK = existing;
     return config;
 });
 exports.withSpotifyConfigValues = withSpotifyConfigValues;

package/plugin/build/ios/withSpotifyURLScheme.d.ts

@@ -1,3 +1,3 @@
-import { ConfigPlugin } from "expo/config-plugins";
+import { ConfigPlugin } from "@expo/config-plugins";
 import { SpotifyConfig } from "../types";
 export declare const withSpotifyURLScheme: ConfigPlugin<SpotifyConfig>;

package/plugin/build/ios/withSpotifyURLScheme.js

@@ -1,18 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.withSpotifyURLScheme = void 0;
-const config_plugins_1 = require("expo/config-plugins");
+const config_plugins_1 = require("@expo/config-plugins");
 const withSpotifyURLScheme = (config, { scheme }) => {
     return (0, config_plugins_1.withInfoPlist)(config, (config) => {
         const bundleId = config.ios?.bundleIdentifier;
-        const urlType = {
-            CFBundleURLName: bundleId,
-            CFBundleURLSchemes: [scheme],
-        };
-        if (!config.modResults.CFBundleURLTypes) {
-            config.modResults.CFBundleURLTypes = [];
+        const urlTypes = config.modResults.CFBundleURLTypes ?? [];
+        const alreadyDeclared = urlTypes.some((entry) => entry.CFBundleURLSchemes?.includes(scheme));
+        if (!alreadyDeclared) {
+            urlTypes.push({
+                CFBundleURLName: bundleId ?? "",
+                CFBundleURLSchemes: [scheme],
+            });
+            config.modResults.CFBundleURLTypes = urlTypes;
         }
-        config.modResults.CFBundleURLTypes.push(urlType);
         return config;
     });
 };

package/plugin/build/types.d.ts

@@ -1,6 +1,41 @@
+/**
+ * Spotify scopes that are valid in Spotify's iOS, Android and Web auth APIs.
+ *
+ * See: https://developer.spotify.com/documentation/web-api/concepts/scopes
+ */
 export type SpotifyScopes = "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";
+/**
+ * Configuration accepted by the `@wwdrew/expo-spotify-sdk` Expo config plugin.
+ *
+ * @example
+ * // app.config.ts
+ * export default {
+ *   plugins: [
+ *     ["@wwdrew/expo-spotify-sdk", {
+ *       clientID: "<spotify-client-id>",
+ *       scheme: "myapp",
+ *       host: "spotify-auth",
+ *       redirectPathPattern: "/.*"
+ *     }]
+ *   ]
+ * }
+ */
 export interface SpotifyConfig {
+    /** Spotify Client ID for your application. */
     clientID: string;
+    /** Path component of the redirect URI (e.g. `"spotify-auth"`). */
     host: string;
+    /**
+     * URL scheme registered for your app, used as the redirect URI scheme
+     * (e.g. `"myapp"`). Must match your Expo app's `scheme`.
+     */
     scheme: string;
+    /**
+     * Path pattern Spotify will accept on the redirect URI. Required by the
+     * Spotify Android Auth SDK from version 3.0.0 onwards. Defaults to `"/.*"`
+     * which matches any path (preserving pre-3.0.0 SDK behaviour).
+     *
+     * See: https://developer.android.com/guide/topics/manifest/data-element#path
+     */
+    redirectPathPattern?: string;
 }

package/plugin/build/types.js

@@ -1,21 +1,2 @@
 "use strict";
-/*
-
-List of Scopes:  https://developer.spotify.com/documentation/web-api/concepts/scopes
-
-Note: these scopes are not currently available in the iOS SDK:
-
-- user-read-playback-position
-- user-soa-link
-- user-soa-unlink
-- user-manage-entitlements
-- user-manage-partner
-- user-create-partner
-
-Also, although these scopes exist in the iOS SDK, they are not valid:
-
-- user-read-birthdate
-- openid
-
-*/
 Object.defineProperty(exports, "__esModule", { value: true });

package/ios/ExpoSpotifyAuthDelegate.swift

@@ -1,13 +0,0 @@
-import ExpoModulesCore
-import SpotifyiOS
-
-public class ExpoSpotifyAuthDelegate: ExpoAppDelegateSubscriber {
-    let sessionManager = ExpoSpotifySessionManager.shared
-    
-    public func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey: Any] = [:]) -> Bool {
-        if let canHandleURL = sessionManager.sessionManager?.application(app, open: url, options: options) {
-            return canHandleURL
-        }
-        return false
-    }
-}

package/ios/ExpoSpotifySessionManager+SessionManagerDelegate.swift

@@ -1,16 +0,0 @@
-import Foundation
-import SpotifyiOS
-
-extension ExpoSpotifySessionManager: SPTSessionManagerDelegate {
-    public func sessionManager(manager _: SPTSessionManager, didInitiate session: SPTSession) {
-        authPromiseSeal?.fulfill(session)
-    }
-    
-    public func sessionManager(manager _: SPTSessionManager, didFailWith error: Error) {
-        authPromiseSeal?.reject(error)
-    }
-    
-    public func sessionManager(manager _: SPTSessionManager, didRenew session: SPTSession) {
-        authPromiseSeal?.fulfill(session)
-    }
-}

package/ios/ExpoSpotifySessionManager.swift

@@ -1,90 +0,0 @@
-import ExpoModulesCore
-import SpotifyiOS
-import PromiseKit
-
-enum SessionManagerError: Error {
-    case notInitialized
-    case invalidConfiguration
-}
-
-final class ExpoSpotifySessionManager: NSObject {
-    weak var module: ExpoSpotifySDKModule?
-    var authPromiseSeal: Resolver<SPTSession>?
-
-    static let shared = ExpoSpotifySessionManager()
-
-    private var expoSpotifyConfiguration: ExpoSpotifyConfiguration? {
-        guard let expoSpotifySdkDict = Bundle.main.object(forInfoDictionaryKey: "ExpoSpotifySDK") as? [String: String],
-              let clientID = expoSpotifySdkDict["clientID"],
-              let host = expoSpotifySdkDict["host"],
-              let scheme = expoSpotifySdkDict["scheme"] else
-        {
-            return nil
-        }
-
-        return ExpoSpotifyConfiguration(clientID: clientID, host: host, scheme: scheme)
-    }
-
-    lazy var configuration: SPTConfiguration? = {
-        guard let clientID = expoSpotifyConfiguration?.clientID,
-              let redirectURL = expoSpotifyConfiguration?.redirectURL else {
-            NSLog("Invalid Spotify configuration")
-            return nil
-        }
-
-        return SPTConfiguration(clientID: clientID, redirectURL: redirectURL)
-    }()
-
-    lazy var sessionManager: SPTSessionManager? = {
-        guard let configuration = configuration else {
-            return nil
-        }
-
-        return SPTSessionManager(configuration: configuration, delegate: self)
-    }()
-
-
-    func authenticate(scopes: [String], tokenSwapURL: String?, tokenRefreshURL: String?) -> PromiseKit.Promise<SPTSession> {
-        return Promise { seal in
-            guard let clientID = self.expoSpotifyConfiguration?.clientID,
-                  let redirectURL = self.expoSpotifyConfiguration?.redirectURL else {
-                NSLog("Invalid Spotify configuration")
-                seal.reject(SessionManagerError.invalidConfiguration)
-                return
-            }
-            
-            let configuration = SPTConfiguration(clientID: clientID, redirectURL: redirectURL)
-
-            if (tokenSwapURL != nil) {
-                configuration.tokenSwapURL = URL(string: tokenSwapURL ?? "")
-            }
-
-            if (tokenRefreshURL != nil) {
-                configuration.tokenRefreshURL = URL(string: tokenRefreshURL ?? "")
-            }
-
-            self.authPromiseSeal = seal
-            self.configuration = configuration
-            self.sessionManager = SPTSessionManager(configuration: configuration, delegate: self)
-
-            DispatchQueue.main.sync {
-                sessionManager?.initiateSession(with: SPTScopeSerializer.deserializeScopes(scopes), options: .default, campaign: nil)
-            }
-        }
-    }
-
-    func spotifyAppInstalled() -> Bool {
-        guard let sessionManager = sessionManager else {
-            NSLog("SPTSessionManager not initialized")
-            return false
-        }
-
-        var isInstalled = false
-
-        DispatchQueue.main.sync {
-            isInstalled = sessionManager.isSpotifyAppInstalled
-        }
-
-        return isInstalled
-    }
-}