@wwdrew/expo-spotify-sdk 2.0.0 → 2.2.0

package/ios/SpotifyAppRemoteErrorMapping.swift

@@ -0,0 +1,110 @@
+import Foundation
+import SpotifyiOS
+
+/// Maps `SPTAppRemote` NSError payloads into per-namespace native error enums.
+/// Keep aligned with [docs/app-remote-error-mapping.md](../docs/app-remote-error-mapping.md).
+enum SpotifyAppRemoteErrorMapping {
+  private static func isSPTError(_ error: NSError) -> Bool {
+    error.domain == SPTAppRemoteErrorDomain
+  }
+
+  private static func isConnectionTerminated(_ error: NSError) -> Bool {
+    isSPTError(error) && error.code == SPTAppRemoteErrorCode.connectionTerminatedError.rawValue
+  }
+
+  private static func isInvalidArguments(_ error: NSError) -> Bool {
+    isSPTError(error) && error.code == SPTAppRemoteErrorCode.invalidArgumentsError.rawValue
+  }
+
+  private static func isRequestFailed(_ error: NSError) -> Bool {
+    isSPTError(error) && error.code == SPTAppRemoteErrorCode.requestFailedError.rawValue
+  }
+
+  private static func connectionLostMessage(callsite: String) -> String {
+    "\(callsite): connection to Spotify app was terminated"
+  }
+
+  private static func containsRestriction(_ description: String) -> Bool {
+    let desc = description.lowercased()
+    return desc.contains("not allowed") || desc.contains("restriction")
+  }
+
+  static func mapPlayerError(_ error: NSError, callsite: String) -> NativePlayerError {
+    guard isSPTError(error) else {
+      return .unknown(error.localizedDescription)
+    }
+    if isConnectionTerminated(error) {
+      return .connectionLost(connectionLostMessage(callsite: callsite))
+    }
+    if isInvalidArguments(error) {
+      let desc = error.localizedDescription.lowercased()
+      if desc.contains("uri") {
+        return .invalidURI("\(callsite): \(error.localizedDescription)")
+      }
+      return .invalidParameter(error.localizedDescription)
+    }
+    if isRequestFailed(error) {
+      let desc = error.localizedDescription.lowercased()
+      if desc.contains("premium") {
+        return .premiumRequired("\(callsite): Spotify Premium is required for on-demand playback")
+      }
+      if containsRestriction(error.localizedDescription) {
+        return .operationNotAllowed("\(callsite): \(error.localizedDescription)")
+      }
+      return .unknown(error.localizedDescription)
+    }
+    return .unknown(error.localizedDescription)
+  }
+
+  static func mapUserError(_ error: NSError, callsite: String) -> NativeUserError {
+    guard isSPTError(error) else {
+      return .unknown(error.localizedDescription)
+    }
+    if isConnectionTerminated(error) {
+      return .connectionLost(connectionLostMessage(callsite: callsite))
+    }
+    if isInvalidArguments(error) {
+      return .invalidURI("\(callsite): \(error.localizedDescription)")
+    }
+    if isRequestFailed(error) {
+      if containsRestriction(error.localizedDescription) {
+        return .operationNotAllowed("\(callsite): \(error.localizedDescription)")
+      }
+      return .unknown(error.localizedDescription)
+    }
+    return .unknown(error.localizedDescription)
+  }
+
+  static func mapContentError(_ error: NSError, callsite: String) -> NativeContentError {
+    guard isSPTError(error) else {
+      return .unknown(error.localizedDescription)
+    }
+    if isConnectionTerminated(error) {
+      return .connectionLost(connectionLostMessage(callsite: callsite))
+    }
+    if isRequestFailed(error) {
+      let desc = error.localizedDescription.lowercased()
+      if desc.contains("not supported") || desc.contains("unsupported") {
+        return .contentAPIUnavailable("\(callsite): content API is unavailable on this Spotify app version")
+      }
+      return .unknown(error.localizedDescription)
+    }
+    return .unknown(error.localizedDescription)
+  }
+
+  static func mapImagesError(_ error: NSError, callsite: String) -> NativeImagesError {
+    guard isSPTError(error) else {
+      return .unknown(error.localizedDescription)
+    }
+    if isConnectionTerminated(error) {
+      return .notConnected(connectionLostMessage(callsite: callsite))
+    }
+    if isInvalidArguments(error) {
+      return .invalidURI("\(callsite): invalid image identifier")
+    }
+    if isRequestFailed(error) {
+      return .imageLoadFailed("\(callsite): Spotify rejected image request")
+    }
+    return .unknown(error.localizedDescription)
+  }
+}

package/ios/SpotifyAppRemoteErrors.swift

@@ -0,0 +1,221 @@
+import ExpoModulesCore
+import Foundation
+
+// MARK: — App Remote error types
+
+enum AppRemoteError: Error {
+  case connectionFailed(String)
+  case connectionLost(String)
+  case notConnected(String)
+  case unknown(String)
+
+  var code: String {
+    switch self {
+    case .connectionFailed: return "CONNECTION_FAILED"
+    case .connectionLost: return "CONNECTION_LOST"
+    case .notConnected: return "NOT_CONNECTED"
+    case .unknown: return "UNKNOWN"
+    }
+  }
+
+  var message: String {
+    switch self {
+    case .connectionFailed(let m): return m
+    case .connectionLost(let m): return m
+    case .notConnected(let m): return m
+    case .unknown(let m): return m
+    }
+  }
+}
+
+/// Bridges an `AppRemoteError` through expo-modules-core's exception system so
+/// JS callers receive a structured `code` and `reason`, not "undefined reason".
+final class AppRemoteException: Exception, @unchecked Sendable {
+  private let appRemoteCode: String
+  private let appRemoteMessage: String
+
+  init(_ error: AppRemoteError, file: String = #fileID, line: UInt = #line, function: String = #function) {
+    self.appRemoteCode = error.code
+    self.appRemoteMessage = error.message
+    super.init(file: file, line: line, function: function)
+  }
+
+  override var code: String { appRemoteCode }
+  override var reason: String { appRemoteMessage }
+}
+
+// MARK: — Player error types
+
+enum NativePlayerError: Error {
+  case notConnected(String)
+  case connectionLost(String)
+  case premiumRequired(String)
+  case invalidURI(String)
+  case invalidParameter(String)
+  case operationNotAllowed(String)
+  case unknown(String)
+
+  var code: String {
+    switch self {
+    case .notConnected: return "NOT_CONNECTED"
+    case .connectionLost: return "CONNECTION_LOST"
+    case .premiumRequired: return "PREMIUM_REQUIRED"
+    case .invalidURI: return "INVALID_URI"
+    case .invalidParameter: return "INVALID_PARAMETER"
+    case .operationNotAllowed: return "OPERATION_NOT_ALLOWED"
+    case .unknown: return "UNKNOWN"
+    }
+  }
+
+  var message: String {
+    switch self {
+    case .notConnected(let m): return m
+    case .connectionLost(let m): return m
+    case .premiumRequired(let m): return m
+    case .invalidURI(let m): return m
+    case .invalidParameter(let m): return m
+    case .operationNotAllowed(let m): return m
+    case .unknown(let m): return m
+    }
+  }
+}
+
+final class PlayerException: Exception, @unchecked Sendable {
+  private let playerCode: String
+  private let playerMessage: String
+
+  init(_ error: NativePlayerError, file: String = #fileID, line: UInt = #line, function: String = #function) {
+    self.playerCode = error.code
+    self.playerMessage = error.message
+    super.init(file: file, line: line, function: function)
+  }
+
+  override var code: String { playerCode }
+  override var reason: String { playerMessage }
+}
+
+// MARK: — User error types
+
+enum NativeUserError: Error {
+  case notConnected(String)
+  case connectionLost(String)
+  case invalidURI(String)
+  case operationNotAllowed(String)
+  case unknown(String)
+
+  var code: String {
+    switch self {
+    case .notConnected: return "NOT_CONNECTED"
+    case .connectionLost: return "CONNECTION_LOST"
+    case .invalidURI: return "INVALID_URI"
+    case .operationNotAllowed: return "OPERATION_NOT_ALLOWED"
+    case .unknown: return "UNKNOWN"
+    }
+  }
+
+  var message: String {
+    switch self {
+    case .notConnected(let m): return m
+    case .connectionLost(let m): return m
+    case .invalidURI(let m): return m
+    case .operationNotAllowed(let m): return m
+    case .unknown(let m): return m
+    }
+  }
+}
+
+final class UserException: Exception, @unchecked Sendable {
+  private let userCode: String
+  private let userMessage: String
+
+  init(_ error: NativeUserError, file: String = #fileID, line: UInt = #line, function: String = #function) {
+    self.userCode = error.code
+    self.userMessage = error.message
+    super.init(file: file, line: line, function: function)
+  }
+
+  override var code: String { userCode }
+  override var reason: String { userMessage }
+}
+
+// MARK: — Content error types
+
+enum NativeContentError: Error {
+  case notConnected(String)
+  case connectionLost(String)
+  case contentAPIUnavailable(String)
+  case unknown(String)
+
+  var code: String {
+    switch self {
+    case .notConnected: return "NOT_CONNECTED"
+    case .connectionLost: return "CONNECTION_LOST"
+    case .contentAPIUnavailable: return "CONTENT_API_UNAVAILABLE"
+    case .unknown: return "UNKNOWN"
+    }
+  }
+
+  var message: String {
+    switch self {
+    case .notConnected(let m): return m
+    case .connectionLost(let m): return m
+    case .contentAPIUnavailable(let m): return m
+    case .unknown(let m): return m
+    }
+  }
+}
+
+final class ContentException: Exception, @unchecked Sendable {
+  private let contentCode: String
+  private let contentMessage: String
+
+  init(_ error: NativeContentError, file: String = #fileID, line: UInt = #line, function: String = #function) {
+    self.contentCode = error.code
+    self.contentMessage = error.message
+    super.init(file: file, line: line, function: function)
+  }
+
+  override var code: String { contentCode }
+  override var reason: String { contentMessage }
+}
+
+// MARK: — Images error types
+
+enum NativeImagesError: Error {
+  case notConnected(String)
+  case invalidURI(String)
+  case imageLoadFailed(String)
+  case unknown(String)
+
+  var code: String {
+    switch self {
+    case .notConnected: return "NOT_CONNECTED"
+    case .invalidURI: return "INVALID_URI"
+    case .imageLoadFailed: return "IMAGE_LOAD_FAILED"
+    case .unknown: return "UNKNOWN"
+    }
+  }
+
+  var message: String {
+    switch self {
+    case .notConnected(let m): return m
+    case .invalidURI(let m): return m
+    case .imageLoadFailed(let m): return m
+    case .unknown(let m): return m
+    }
+  }
+}
+
+final class ImagesException: Exception, @unchecked Sendable {
+  private let imagesCode: String
+  private let imagesMessage: String
+
+  init(_ error: NativeImagesError, file: String = #fileID, line: UInt = #line, function: String = #function) {
+    self.imagesCode = error.code
+    self.imagesMessage = error.message
+    super.init(file: file, line: line, function: function)
+  }
+
+  override var code: String { imagesCode }
+  override var reason: String { imagesMessage }
+}

package/ios/SpotifyAppRemoteMappers.swift

@@ -0,0 +1,88 @@
+import Foundation
+import SpotifyiOS
+import UIKit
+
+/// Serializes Spotify App Remote SDK objects into NSDictionary-compatible payloads
+/// for the Expo JS bridge.
+enum SpotifyAppRemoteMappers {
+  static func playerStateToMap(_ state: any SPTAppRemotePlayerState) -> [String: Any] {
+    let track = state.track
+    let restrictions = state.playbackRestrictions
+    let options = state.playbackOptions
+    return [
+      "track": [
+        "uri": track.uri,
+        "name": track.name,
+        "imageIdentifier": track.imageIdentifier,
+        "duration": track.duration,
+        "artist": ["name": track.artist.name, "uri": track.artist.uri],
+        "album": ["name": track.album.name, "uri": track.album.uri],
+        "isSaved": track.isSaved,
+        "isEpisode": track.isEpisode,
+        "isPodcast": track.isPodcast,
+        "isAdvertisement": track.isAdvertisement,
+      ] as [String: Any],
+      "playbackPosition": state.playbackPosition,
+      "playbackSpeed": state.playbackSpeed,
+      "isPaused": state.isPaused,
+      "playbackOptions": [
+        "isShuffling": options.isShuffling,
+        "repeatMode": options.repeatMode.rawValue,
+      ] as [String: Any],
+      "playbackRestrictions": [
+        "canSkipNext": restrictions.canSkipNext,
+        "canSkipPrevious": restrictions.canSkipPrevious,
+        "canRepeatTrack": restrictions.canRepeatTrack,
+        "canRepeatContext": restrictions.canRepeatContext,
+        "canToggleShuffle": restrictions.canToggleShuffle,
+        "canSeek": restrictions.canSeek,
+      ] as [String: Any],
+      "contextTitle": state.contextTitle,
+      "contextUri": state.contextURI.absoluteString,
+    ]
+  }
+
+  static func capabilitiesToMap(_ capabilities: any SPTAppRemoteUserCapabilities) -> [String: Any] {
+    ["canPlayOnDemand": capabilities.canPlayOnDemand]
+  }
+
+  static func libraryStateToMap(_ state: any SPTAppRemoteLibraryState) -> [String: Any] {
+    ["uri": state.uri, "isAdded": state.isAdded, "canAdd": state.canAdd]
+  }
+
+  static func mapContentType(_ type: String) -> String {
+    switch type {
+    case "navigation": return SPTAppRemoteContentTypeNavigation
+    case "fitness": return SPTAppRemoteContentTypeFitness
+    case "gaming": return SPTAppRemoteContentTypeGaming
+    default: return SPTAppRemoteContentTypeDefault
+    }
+  }
+
+  static func mapImageSize(_ size: String) -> CGSize {
+    switch size {
+    case "small": return CGSize(width: 64, height: 64)
+    case "medium": return CGSize(width: 300, height: 300)
+    default: return CGSize(width: 640, height: 640)
+    }
+  }
+
+  static func contentItemToMap(_ item: any SPTAppRemoteContentItem) -> [String: Any] {
+    var map: [String: Any] = [
+      "title": item.title as Any,
+      "subtitle": item.subtitle as Any,
+      "contentDescription": item.contentDescription as Any,
+      "identifier": item.identifier,
+      "uri": item.uri,
+      "imageIdentifier": item.imageIdentifier,
+      "isAvailableOffline": item.isAvailableOffline,
+      "isPlayable": item.isPlayable,
+      "isContainer": item.isContainer,
+      "isPinned": item.isPinned,
+    ]
+    if let children = item.children {
+      map["children"] = children.map(contentItemToMap)
+    }
+    return map
+  }
+}

package/ios/spotify-native-sdk-versions.json

@@ -0,0 +1,12 @@
+{
+  "ios": {
+    "spmRepositoryUrl": "https://github.com/spotify/ios-sdk.git",
+    "spmVersion": "5.0.1",
+    "spmProduct": "SpotifyiOS"
+  },
+  "android": {
+    "appRemoteVersion": "0.8.0",
+    "appRemoteReleaseTag": "v0.8.0-appremote_v2.1.0-auth",
+    "appRemoteSha256": "b5a6dd880eaf01f63a871cba9ef7af77c341f8a94ffc8fdf2e9021f9a9d4c198"
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wwdrew/expo-spotify-sdk",
-  "version": "2.0.0",
+  "version": "2.2.0",
   "description": "Expo module wrapping the native Spotify iOS (v5) and Android (v4) SDKs for OAuth authentication and App Remote playback control",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -17,9 +17,9 @@
   "scripts": {
     "build": "tsc",
     "build:plugin": "tsc -p plugin/tsconfig.json",
-    "clean": "rm -rf build plugin/build",
+    "clean": "rm -rf build plugin/build android/build",
     "lint": "eslint src",
-    "test": "jest --rootDir plugin --config plugin/jest.config.js",
+    "test": "jest --config jest.config.js",
     "prepublishOnly": "yarn clean && yarn build && yarn build:plugin",
     "typecheck": "tsc --noEmit",
     "open:ios": "open -a \"Xcode\" example/ios",
@@ -33,10 +33,18 @@
     "Spotify"
   ],
   "files": [
+    "plugin/index.js",
+    "plugin/index.d.ts",
     "plugin/build",
     "build",
-    "android",
-    "ios",
+    "android/build.gradle",
+    "android/spotify-native-sdk.gradle",
+    "android/consumer-rules.pro",
+    "android/src",
+    "android/libs/SETUP.md",
+    "ios/spotify-native-sdk-versions.json",
+    "ios/*.swift",
+    "ios/*.podspec",
     "app.plugin.js",
     "expo-module.config.json"
   ],

package/plugin/index.d.ts

@@ -0,0 +1,2 @@
+export { default } from "./build/index";
+export type { SpotifyConfig, SpotifyScopes } from "./build/types";

package/plugin/index.js

@@ -0,0 +1 @@
+module.exports = require("./build").default;

package/ios/SpotifySDK/Licenses/MPMessagePack-LICENSE.md

@@ -1,20 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2014 Gabriel Handford
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/ios/SpotifySDK/SpotifyiOS.xcframework/Info.plist

@@ -1,40 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
-	<key>AvailableLibraries</key>
-	<array>
-		<dict>
-			<key>LibraryIdentifier</key>
-			<string>ios-arm64</string>
-			<key>LibraryPath</key>
-			<string>SpotifyiOS.framework</string>
-			<key>SupportedArchitectures</key>
-			<array>
-				<string>arm64</string>
-			</array>
-			<key>SupportedPlatform</key>
-			<string>ios</string>
-		</dict>
-		<dict>
-			<key>LibraryIdentifier</key>
-			<string>ios-arm64_x86_64-simulator</string>
-			<key>LibraryPath</key>
-			<string>SpotifyiOS.framework</string>
-			<key>SupportedArchitectures</key>
-			<array>
-				<string>arm64</string>
-				<string>x86_64</string>
-			</array>
-			<key>SupportedPlatform</key>
-			<string>ios</string>
-			<key>SupportedPlatformVariant</key>
-			<string>simulator</string>
-		</dict>
-	</array>
-	<key>CFBundlePackageType</key>
-	<string>XFWK</string>
-	<key>XCFrameworkFormatVersion</key>
-	<string>1.0</string>
-</dict>
-</plist>