{"_id":"@daveyvdbogaard/react-native-spotify-remote","_rev":"1-ff509dd46554a547751c89a18f5c7e80","name":"@daveyvdbogaard/react-native-spotify-remote","dist-tags":{"next":"0.3.11-4","latest":"0.3.11-4"},"versions":{"0.3.11-4":{"name":"@daveyvdbogaard/react-native-spotify-remote","repository":{"type":"git","url":"git+https://github.com/cjam/react-native-spotify-remote.git"},"bugs":{"url":"https://github.com/cjam/react-native-spotify-remote/issues"},"version":"0.3.11-4","description":"React Native wrapper around the Spotify Remote SDK","author":{"name":"Colter McQuay"},"licenses":[{"type":"MIT","url":"https://www.opensource.org/licenses/mit-license.php"}],"nativePackage":true,"license":"ISC","keywords":["react-native","spotify","music","audio","remote","mobile","player"],"main":"dist/index","module":"dist/index","types":"dist/index.d.ts","source":"dist/index","react-native":"dist/index","scripts":{"rebuild":"yarn build && yarn docs","clean":"rm -rf ./dist","build":"yarn clean && ./node_modules/.bin/tsc","watch":"yarn build --watch","docs":"typedoc --options typedoc.json --excludeExternals","test":"echo \"Error: no test specified\" && exit 1","prepublishOnly":"yarn rebuild","prepack":"yarn submodules && yarn cleanup:ios","cleanup:ios":"pushd ios/external/SpotifySDK/SpotifyiOS.framework; rm SpotifyiOS Headers; mv Versions/Current/* .; popd","postpack":"yarn submodules","submodules":"rm -rf ios/external/* && rm -rf android/external/* && git submodule update --init --recursive","example":"concurrently -n \"server,packager\" -c \"yellow,cyan\" \"cd example-server && yarn start\" \"cd example && yarn start\"","xcode":"open example/ios/example.xcworkspace","release":"release-it"},"peerDependencies":{"react-native":">=0.60"},"dependencies":{"react-native-events":"^1.0.21"},"devDependencies":{"@release-it/keep-a-changelog":"^2.2.2","@types/events":"^1.2.0","@types/react-native":"^0.57.0","all-contributors-cli":"^6.14.2","concurrently":"^5.0.2","jetifier":"^1.6.5","release-it":"^14.6.1","typedoc":"^0.20.24","typescript":"^4.1.3"},"release-it":{"hooks":{"after:bump":["npm run rebuild"]},"git":{"commitMessage":"chore: release ${version}","tagName":"v${version}"},"npm":{"publish":true},"github":{"release":true},"plugins":{"@release-it/keep-a-changelog":{"addUnreleased":true}}},"gitHead":"2a086d0b77ee3fc92c94315c1b1e711821d91cb0","homepage":"https://github.com/cjam/react-native-spotify-remote#readme","_id":"@daveyvdbogaard/react-native-spotify-remote@0.3.11-4","_nodeVersion":"17.3.0","_npmVersion":"8.3.0","dist":{"integrity":"sha512-H15nCucy2I1ox2rDqUo7DwBVWXjBQD6JwRSclcoQEzTPM37M4gY+Cnv2cVGWmwbBRFwppzUSks1LkLClFjUj5g==","shasum":"e947db8faa6f9d55429e834bf5aa72394cec7d72","tarball":"https://registry.npmjs.org/@daveyvdbogaard/react-native-spotify-remote/-/react-native-spotify-remote-0.3.11-4.tgz","fileCount":234,"unpackedSize":24267336,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJiAkjtCRA9TVsSAnZWagAAypkP/R7Nsd/yz2rRQ65IscLX\nuNDo9CUXJBZ736fYP0gmhppC6GF7dKoCIGjqyPDvJrBs5741s/tadpvoUQxx\nJMHsnDFQoAO1Vi/EF5XdE1Q1YYGsrrUtdthLde0sLB6LSaIJ39AeSvhCmr2q\n485aOeTcnzip3/BXfoDnUSrYLWkIs2w5ci9yNrW+jq+MaOaKtEF65MF/HB/d\nxkQgzEbYCQXL9+zHnRni5IBObbZHDf6pnM8Fljl4VWcu0yp2B76BYLvGEprq\nqqQfIsvSoo5wZ3jetfvSMRvXcr0k185lmTu75iEvULTmS43WjlYff1tXdK6c\nNy0EAPiJoGEMm/7bJ0iG1HUi6NxChlWS52n9zZb3LP5WK7T91Cso9QYoxmJ3\nbxwYrodZqQBeTNQ3W0GBTfM6wi0ZI+QLrjw/EOiY8WWrNFjGbkf8OV+fA1lw\nDWPnVA3xuE7l5MxQtihO1V+BNvRrkZtGvPOlAxS/QsvKp/2LvwF+qThKcbhH\n1mBT84dQnHEPDEsfUg/d8ALFt0v+SE+OtzTrkBr9OhY/L77xPAgTna+SC5wR\nu4Xofw/Tpiyz+eVMC+th0jmkQQNvelpcEE7qzERJZ8bXmaZoAgPFfjKQdWsR\nEFcumyniPPEP7ExtqoJMcT2UCIBwb0zgIm05BBr6lZdIyZ3RxHr1fC1gvtpm\nvPNG\r\n=BKoU\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCiw/0LGbNNDycIj8nTm9XuH0+nUEOoveuMmsKezmoy1gIgMaKkhucHWzwN3toOkPQUdMPk3tXXbHi+Cbk9NtDx4yE="}]},"_npmUser":{"name":"daveyvdbogaard","email":"daveyvdbogaard@live.nl"},"directories":{},"maintainers":[{"name":"daveyvdbogaard","email":"daveyvdbogaard@live.nl"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/react-native-spotify-remote_0.3.11-4_1644316909485_0.9963287671786718"},"_hasShrinkwrap":false}},"time":{"created":"2022-02-08T10:41:49.430Z","0.3.11-4":"2022-02-08T10:41:49.853Z","modified":"2022-04-05T03:05:24.513Z"},"maintainers":[{"name":"daveyvdbogaard","email":"daveyvdbogaard@live.nl"}],"description":"React Native wrapper around the Spotify Remote SDK","homepage":"https://github.com/cjam/react-native-spotify-remote#readme","keywords":["react-native","spotify","music","audio","remote","mobile","player"],"repository":{"type":"git","url":"git+https://github.com/cjam/react-native-spotify-remote.git"},"author":{"name":"Colter McQuay"},"bugs":{"url":"https://github.com/cjam/react-native-spotify-remote/issues"},"license":"ISC","readme":"# Spotify App Remote for React Native\n\n[![npm version](https://badge.fury.io/js/react-native-spotify-remote.svg)](https://badge.fury.io/js/react-native-spotify-remote)\n\n[![Spotify iOS SDK Version](https://img.shields.io/badge/Spotify%20iOS%20SDK-v1.2.2-brightgreen)](https://github.com/spotify/ios-sdk/commit/f9a7d53967de5ea633845c2387b7fc8f90b96265)\n\n[![Spotify Android App Remote Version](https://img.shields.io/badge/Spotify%20Android%20App%20Remote%20SDK-v0.7.2-brightgreen)](https://github.com/spotify/android-sdk/commit/cfd6b68a47440a7db8afac1983d92d324a1c0015)\n\n[![Spotify Android Auth Version](https://img.shields.io/badge/Spotify%20Android%20Auth%20SDK-v1.2.3-brightgreen)](https://github.com/spotify/android-sdk/commit/cfd6b68a47440a7db8afac1983d92d324a1c0015)\n\nA react native module for the Spotify Remote SDK ( [iOS](https://github.com/spotify/ios-sdk/) | [Android](https://github.com/spotify/android-sdk/) )\n\n- [Documentation](https://cjam.github.io/react-native-spotify-remote/index.html)\n- [Change Log](./CHANGELOG.md)\n- [Contributing](./CONTRIBUTING.md)\n\n## Supported Features\n\nAn [Example](./example) project was developed to exercise and test all functionality within this library. If you are curious about how to use something, or need to compare your application setup to something that works, check there first.\n\n## Features\n\nThe following table shows the platform support for various Spotify Remote API functionality within this library.\n\n| Feature | iOS | Android | |\n| :--------------------------- | :-: | :-----: | ---------------------------: |\n| **Authentication** |\n| `authorize` | ✅ | ✅ | |\n| `getSession` | ✅ | ✅ | |\n| `endSession` | ✅ | ✅ | |\n| **Remote** |\n| `isConnectedAsync` | ✅ | ✅ | |\n| `connect` | ✅ | ✅ | |\n| `disconnect` | ✅ | ✅ | |\n| `playUri` | ✅ | ✅ | |\n| `playItem` | ✅ | ✅ | |\n| `playItemWithIndex` | ✅ | ✅ | |\n| `queueUri` | ✅ | ✅ | |\n| `seek` | ✅ | ✅ | |\n| `resume` | ✅ | ✅ | |\n| `pause` | ✅ | ✅ | |\n| `skipToNext` | ✅ | ✅ | |\n| `skipToPrevious` | ✅ | ✅ | |\n| `setShuffling` | ✅ | ✅ | |\n| `setRepeatMode` | ✅ | ✅ | |\n| `getPlayerState` | ✅ | ✅ | |\n| `getRootContentItems` | ✅ | ❌ | Not available in Android SDK |\n| `getRecommendedContentItems` | ✅ | ✅ | |\n| `getChildrenOfItem` | ✅ | ✅ | |\n| `getContentItemForUri` | ✅ | ❌ | Not available in Android SDK |\n| `getCrossfadeState` | ✅ | ✅ | |\n| **Remote Events** |\n| `playerStateChanged` | ✅ | ✅ | |\n| `playerContextChanged` | ✅ | ✅ | |\n| `remoteDisconnected` | ✅ | ✅ | |\n| `remoteConnected` | ✅ | ✅ | |\n\n## Install\n\n```bash\nyarn add react-native-spotify-remote\n```\n\nor\n\n```bash\nnpm install --save react-native-spotify-remote\n```\n\n> **Android 11 and Above**\n>\n> Add the following to your Android Manifest:\n>\n> ` `\n\n## Linking\n\nAs of React Native `> 0.61`, auto linking should work for both iOS and Android. There shouldn't be any modifications necessary and it _Should_ work out of the box. The one caveat, is that `react-native-events` needs to be linked as it doesn't yet support auto linking. If you do run into issues or are using an older version of React Native, the following sections should help get you up and running.\n\n### iOS\n\n> This library requires being built with **XCode 11** for reasons given [here](https://github.com/spotify/ios-sdk/issues/179#issuecomment-581032275).\n\n#### Cocoapods (Recommended)\n\nBy far the easiest way to integrate into your project. In your `ios/PodFile` add the following lines to your projects target:\n\n```rb\n\tpod 'RNEventEmitter', :path => \"../node_modules/react-native-events\"\n\tpod 'RNSpotifyRemote', :path => '../node_modules/react-native-spotify-remote'\n```\n\nSee the [`Example App PodFile`](./example/ios/PodFile) for a full example.\n\nI have only tested this against RN > 0.60 in the example app. So if you have issues with a RN version < 0.60 that might be a place to start troubleshooting.\n\n#### Manual\n\nManual linking is needed for projects that don't use Cocoapods.\n\n1. Manually add the frameworks from `node_modules/react-native-spotify-remote/ios/external/SpotifySDK` to _Linked Frameworks and Libraries_ in your project settings.\n\n![iOS Framework Search paths](.screenshots/ios-add-framework.png);\n\n2. Then add `../node_modules/react-native-spotify-remote/ios/external/SpotifySDK` to _Framework Search Paths_ in your project settings see the screenshot below. (By default it won't show the options in XCode so you may need to check `all`)\n\n![iOS Framework Search paths](.screenshots/ios-framework-searchpaths.png);\n\n##### Troubleshooting\n\n`'React/RCTConvert.h' file not found` might be due to a build dependency issue where `RNSpotifyRemote` is being built _before_ `React`. Try adding `React` as an explicit dependency of the `RNSpotifyRemote` target/project in XCode. Otherwise, Cocoapods should solve this for you.\n\n## Auth Callback\n\nIn order to support the callback that you will get from the Spotify App you will need to add a url handler to your app.\n\n### iOS\n\nModifications are needed for the `AppDelegate.m`:\n\n```objective-c\n#import \"AppDelegate.h\"\n\n#import \n#import \n#import \n\n@implementation AppDelegate\n\n- (BOOL)application:(UIApplication *)application openURL:(NSURL *)URL options:(NSDictionary *)options\n{\n return [[RNSpotifyRemoteAuth sharedInstance] application:application openURL:URL options:options];\n}\n\n@end\n```\n\n### Android\n\nIf you need to link your project manually, here are some things you'll need to do.\n\n> ### `react-native-events` does not support autolinking at this point and will need to be manually linked into your application\n\n1. Open up `android/app/src/main/java/[...]/MainApplication.java`\n\n- Add the following imports to the top of the file\n\n```\nimport com.reactlibrary.RNSpotifyRemotePackage;\nimport com.lufinkey.react.eventemitter.RNEventEmitterPackage;\n```\n\n- Add to the list returned by `getPackages()` for example:\n\n```java\n @Override\n protected List getPackages() {\n @SuppressWarnings(\"UnnecessaryLocalVariable\")\n List packages = new PackageList(this).getPackages();\n // Packages that cannot be autolinked yet can be added manually here, for example:\n packages.add(new RNEventEmitterPackage());\n\t\t packages.add(new RNSpotifyRemotePackage());\n return packages;\n }\n```\n\n2. Append the following lines to `android/settings.gradle`:\n\n ```\n include ':react-native-spotify-remote'\n project(':react-native-spotify-remote').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-spotify-remote/android')\n\n include ':react-native-events'\n project(':react-native-events').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-events/android')\n ```\n\n3. Insert the following lines inside the dependencies block in `android/app/build.gradle`:\n ```\n implementation project(':react-native-spotify-remote')\n implementation project(':react-native-events')\n ```\n4. As per the [Spotify Android SDK Docs](https://developer.spotify.com/documentation/android/guides/android-authentication/) Insert the following lines into `android/app/src/AndroidManifest.xml`\n\n```xml\n \n\n \n \n \n \n\n \"\n android:host=\"\"/>\n \n \n\n \n \n```\n\nIf you have issues linking the module, please check that gradle is updated to the latest version and that your project is synced.\n\n## Usage\n\n### Example Application\n\nThis repo contains an [Example App](./example/Readme.md) which should be the quickest and easiest way to get up and running to try things out. It is using React Hooks (cuz they're pretty cool) and exercises all of the remote API calls.\n\n### In Code\n\nAgain, I recommend looking at the example app. If you specifically want to see some code that actually does stuff take a look at the [App.tsx](./example/App.tsx).\n\nHere's how you would use this library with Typescript (though the same mostly applies to Javascript) and the `async`/`await` syntax for promises (Just cuz I like em).\n\n```typescript\nimport {\n auth as SpotifyAuth,\n remote as SpotifyRemote,\n ApiScope,\n ApiConfig,\n} from \"react-native-spotify-remote\";\n\n// Api Config object, replace with your own applications client id and urls\nconst spotifyConfig: ApiConfig = {\n clientID: \"SPOTIFY_CLIENT_ID\",\n redirectURL: \"SPOTIFY_REDIRECT_URL\",\n tokenRefreshURL: \"SPOTIFY_TOKEN_REFRESH_URL\",\n tokenSwapURL: \"SPOTIFY_TOKEN_SWAP_URL\",\n scopes: [ApiScope.AppRemoteControlScope, ApiScope.UserFollowReadScope],\n};\n\n// Initialize the library and connect the Remote\n// then play an epic song\nasync function playEpicSong() {\n try {\n const session = await SpotifyAuth.authorize(spotifyConfig);\n await SpotifyRemote.connect(session.accessToken);\n await SpotifyRemote.playUri(\"spotify:track:6IA8E2Q5ttcpbuahIejO74\");\n await SpotifyRemote.seek(58000);\n } catch (err) {\n console.error(\"Couldn't authorize with or connect to Spotify\", err);\n }\n}\n```\n\n## Token Swap & Refresh\n\n> A server must be running for with endpoints that allow Spotify to authenticate your app.\n\nIn order to support the OAuth flow, you need to have a server to support the calls for token `swap` and `refresh`. I have included the same server setup defined in the [react-native-spotify](https://github.com/lufinkey/react-native-spotify#token-swap-and-refresh) repo as it does exactly what you need.\n\nSee the [Server Readme](./example-server/README.md) for further instructions.\n\n## Additional notes\n\nNothing has been special to deal with Spotify _Free_ Users but this module _should_ still work.\n\n## Opening Issues\n\nPlease do not open issues about getting the module to work unless you have tried using both the example app and the example token swap server. Please make sure you have tried running on the latest react-native version before submitting a bug.\n\n## Contributors\n\nBig thanks to [@lufinkey](https://github.com/lufinkey) and all of the great work that he has done in the [react-native-spotify](https://github.com/lufinkey/react-native-spotify) repo which was the original source of inspiration and some useful patterns for this package.\n\n\n\n[![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors-)\n\n\n\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\"\"/
Colter McQuay
💻		\"\"/
Luis Finke
🤔		\"\"/
Stanislav
💻		\"\"/
Will Caine
💻		\"\"/
Everaldo Rosa de Souza Junior
💻		\"\"/
İbrahim Can KALYA
💻		\"\"/
Mahmoud Ashraf Mahmoud
💻
\"\"/
Şerafettin Aytekin
💻		\"\"/
Peter Stenger
💻		\"\"/
Reinhard Höll
🐛 💻		\"\"/
Gustavo Graña
🐛 💻		\"\"/
Dylan
💻		\"\"/
Hoang
💻
\n\n\n\n\n\n","readmeFilename":"README.md"}