@andycui/react-native-get-music-files 3.0.1

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2023 Dante Cervantes
+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/README.md

@@ -0,0 +1,226 @@
+# react-native-get-music-files
+React Native package to get music files from local and sd for iOS and Android
+# What does this package?
+
+This package allow you to get music files from Android & iOS with following properties:
+
+* Title
+* Author
+* Album
+* Duration
+* FilePath
+* Cover
+* Duration
+* Genre
+## Getting started
+
+`$ yarn add react-native-get-music-files`
+or 
+`$ yarn add https://github.com/cinder92/react-native-get-music-files.git`
+
+#### iOS
+
+1. Add in `info.plist` following permission
+```
+<key>NSAppleMusicUsageDescription</key>
+<string>This permission is not needed by the app, but it is required by an underlying API. If you see this dialog, contact us.</string>
+``` 
+2. Add MediaPlayer.framework under build settings in Xcode
+3. Ensure all your music files are sync from a computer to a real iPhone device (this package does not work in simulators)
+
+#### Android
+
+1. Navigate to `android/app/src/main/AndroidManifest.xml` and ensure to add this permission
+```
+<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
+<uses-permission android:name="android.permission.READ_MEDIA_AUDIO"/> <-- Add this for Android 13 and newer versions
+```
+
+## Before usage
+
+As this package needs permissions from the device, please ensure that you asked for permissions before run any of this package functions.
+
+## Constants
+```js
+SortSongFields {
+    TITLE, DURATION, ARTIST, GENRE, ALBUM
+}
+
+SortSongOrder {
+    ASC, DESC
+}
+```
+
+## Usage
+```js
+
+import { getAll, getAlbums, searchSongs, SortSongFields, SortSongOrder } from "react-native-get-music-files";
+
+
+const songsOrError = await getAll({
+    limit: 20,
+    offset: 0,
+    coverQuality: 50,
+    minSongDuration: 1000,
+    sortBy: SortSongFields.TITLE,
+    sortOrder: SortSongOrder.DESC,
+});
+
+// error 
+if (typeof songsOrError === 'string') {
+    // do something with the error
+    return;
+}
+
+const albumsOrError = await getAlbums({
+    limit: 10,
+    offset: 0,
+    coverQuality: 50,
+    artist: 'Rihanna',
+    sortBy: SortSongFields.ALBUM,
+    sortOrder: SortSongOrder.DESC,
+});
+
+// error 
+if (typeof albumsOrError === 'string') {
+    // do something with the error
+    return;
+}
+
+const resultsOrError = await searchSongs({
+    limit: 10,
+    offset: 0,
+    coverQuality: 50,
+    searchBy: '...',
+    sortBy: SortSongFields.DURATION,
+    sortOrder: SortSongOrder.DESC,
+});
+
+// error 
+if (typeof resultsOrError === 'string') {
+    // do something with the error
+    return;
+}
+```
+
+MusicFiles returns an array of objects where you can loop, something like this.
+
+```js
+[
+  {
+    title : "La danza del fuego",
+    author : "Mago de Oz",
+    album : "Finisterra",
+    genre : "Folk",
+    duration : 209120,
+    cover : "data:image/jpeg;base64, ....",
+    url : "/sdcard/0/la-danza-del-fuego.mp3"
+  }
+]
+```
+
+  
+#### Return Types
+* Album
+
+    Type: Object
+    
+    | property 	| type 	| description 	|
+    |---------------:	|:--------:	|-------------------------------	|
+    | album 	| string 	| album name 	|
+    | artist 	| string 	| author 	|
+    | cover 	| string 	| base64 of the artwork 	|
+    | numberOfSongs 	| number 	| number of songs in this album 	|
+
+* Song
+
+    | property 	| type 	| description 	|
+    |---------------	|--------	|-------------------------------	|
+    | title 	| string 	| title	|
+    | artist 	| string 	|  artist	|
+    | album 	| string 	|  album name	|
+    | duration 	| string 	|  duration in ms	|
+    | genre 	| string 	|  genre	|
+    | cover 	| string 	|  base64 of the artwork	|
+    | url 	| string 	| path of the song 	|
+
+
+#### Methods
+
+* ##### getAlbums
+    
+    `async getAlbums(options) → {Promise<Album[] | string>}`
+
+    * options
+    
+        Type: Object
+        
+        | property 	| type 	| description 	|
+        |---------------	|--------	|-------------------------------	|
+        | artist  	| string 	|  required	|
+        | limit  	| number 	|  optional	|
+        | offset  	| number 	|  required if limit set	|
+        | coverQuality  	| number 	|  optional	|
+        | sortBy     |  string | optional |
+        | sortOrder   | string  | optional |
+
+    * returns
+  
+        Type: Albums
+        Error: string
+* ##### getAll
+    
+    `async getAll(options) → {Promise<Song[] | string>}`
+    
+    * options
+    
+        Type: Object
+        
+        | property 	| type 	| description 	|
+        |---------------	|--------	|-------------------------------	|
+        | limit  	| number 	|  optional	|
+        | offset  	| number 	|  required if limit set	|
+        | coverQuality  	| string 	|  optional	|
+        | minSongDuration  	| number 	|  optional	|
+        | sortBy     |  string | optional |
+        | sortOrder   | string  | optional |
+        
+    * returns
+    
+        Type: Song
+        Error: string
+* ##### searchSongs
+    
+    `async searchSongs(options) → { Promise<Song[] | string> }`
+    
+    * options
+    
+        Type: Object
+        
+        | property 	| type 	| description 	|
+        |---------------	|--------	|-------------------------------	|
+        | searchBy  	| string 	|  required	|
+        | limit  	| number 	|  optional	|
+        | offset  	| number 	|  required if limit set	|
+        | coverQuality  	| number 	|  optional	|
+        | sortBy     |  string | optional |
+        | sortOrder   | string  | optional |
+   
+    * returns
+        Type: Song
+        Error: string
+
+## Usage:
+
+[example app](https://github.com/cinder92/react-native-get-music-files/tree/master/example)
+
+# Version Changes
+
+# 2.2
+
+- [x] Android & iOS compatible
+- [x] Retro-compat turbo module
+- [x] Limit & offset to paginate results
+- [x] Compatible with `https://github.com/zoontek/react-native-permissions`
+
+PR are welcome!

package/android/build.gradle

@@ -0,0 +1,127 @@
+buildscript {
+  // Buildscript is evaluated before everything else so we can't use getExtOrDefault
+  def kotlin_version = rootProject.ext.has("kotlinVersion") ? rootProject.ext.get("kotlinVersion") : project.properties["TurboSongs_kotlinVersion"]
+
+  repositories {
+    google()
+    mavenCentral()
+  }
+
+  dependencies {
+    classpath "com.android.tools.build:gradle:7.2.1"
+    // noinspection DifferentKotlinGradleVersion
+    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+  }
+}
+
+def isNewArchitectureEnabled() {
+  return rootProject.hasProperty("newArchEnabled") && rootProject.getProperty("newArchEnabled") == "true"
+}
+
+apply plugin: "com.android.library"
+apply plugin: "kotlin-android"
+
+
+def appProject = rootProject.allprojects.find { it.plugins.hasPlugin('com.android.application') }
+
+if (isNewArchitectureEnabled()) {
+  apply plugin: "com.facebook.react"
+}
+
+def getExtOrDefault(name) {
+  return rootProject.ext.has(name) ? rootProject.ext.get(name) : project.properties["TurboSongs_" + name]
+}
+
+def getExtOrIntegerDefault(name) {
+  return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties["TurboSongs_" + name]).toInteger()
+}
+
+def supportsNamespace() {
+  def parsed = com.android.Version.ANDROID_GRADLE_PLUGIN_VERSION.tokenize('.')
+  def major = parsed[0].toInteger()
+  def minor = parsed[1].toInteger()
+
+  // Namespace support was added in 7.3.0
+  if (major == 7 && minor >= 3) {
+    return true
+  }
+
+  return major >= 8
+}
+
+android {
+  if (supportsNamespace()) {
+    namespace "com.turbosongs"
+
+    sourceSets {
+      main {
+        manifest.srcFile "src/main/AndroidManifestNew.xml"
+      }
+    }
+  }
+
+  compileSdkVersion getExtOrIntegerDefault("compileSdkVersion")
+
+  defaultConfig {
+    minSdkVersion getExtOrIntegerDefault("minSdkVersion")
+    targetSdkVersion getExtOrIntegerDefault("targetSdkVersion")
+    buildConfigField "boolean", "IS_NEW_ARCHITECTURE_ENABLED", isNewArchitectureEnabled().toString()
+
+  }
+
+  buildFeatures {
+    buildConfig true
+  }
+
+  buildTypes {
+    release {
+      minifyEnabled false
+    }
+  }
+
+  lintOptions {
+    disable "GradleCompatible"
+  }
+
+  compileOptions {
+    sourceCompatibility JavaVersion.VERSION_1_8
+    targetCompatibility JavaVersion.VERSION_1_8
+  }
+
+  sourceSets {
+    main {
+      if (isNewArchitectureEnabled()) {
+        java.srcDirs += [
+          "src/newarch",
+          // This is needed to build Kotlin project with NewArch enabled
+          "${project.buildDir}/generated/source/codegen/java"
+        ]
+      } else {
+        java.srcDirs += ["src/oldarch"]
+      }
+    }
+  }
+}
+
+repositories {
+  mavenCentral()
+  google()
+}
+
+def kotlin_version = getExtOrDefault("kotlinVersion")
+
+dependencies {
+  // For < 0.71, this will be from the local maven repo
+  // For > 0.71, this will be replaced by `com.facebook.react:react-android:$version` by react gradle plugin
+  //noinspection GradleDynamicVersion
+  implementation "com.facebook.react:react-native:+"
+  implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
+}
+
+if (isNewArchitectureEnabled()) {
+  react {
+    jsRootDir = file("../src/")
+    libraryName = "TurboSongs"
+    codegenJavaPackageName = "com.turbosongs"
+  }
+}

package/android/gradle.properties

@@ -0,0 +1,5 @@
+TurboSongs_kotlinVersion=1.7.0
+TurboSongs_minSdkVersion=21
+TurboSongs_targetSdkVersion=31
+TurboSongs_compileSdkVersion=31
+TurboSongs_ndkversion=21.4.7075529

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,3 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+          package="com.turbosongs">
+</manifest>

package/android/src/main/AndroidManifestNew.xml

@@ -0,0 +1,2 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+</manifest>

package/android/src/main/java/com/turbosongs/BundlePair.kt

@@ -0,0 +1,95 @@
+
+package com.turbosongs
+
+import android.os.Bundle
+
+class BundlePair(
+        private val block: (Bundle) -> Unit
+) {
+    fun apply(bundle: Bundle) = block(bundle)
+}
+
+inline fun bundle(initFun: Bundle.() -> Unit) = Bundle().apply(initFun)
+inline fun bundleOf(initFun: (Bundle) -> Unit) =
+        Bundle().also(initFun)
+
+fun bundleOf(vararg pairs: BundlePair) = bundle {
+    pairs.forEach { it.apply(this) }
+}
+
+infix fun String.bundleTo(value: Boolean) = BundlePair { it[this] = value }
+infix fun String.bundleTo(value: Byte) = BundlePair { it[this] = value }
+infix fun String.bundleTo(value: Short) = BundlePair { it[this] = value }
+infix fun String.bundleTo(value: Int) = BundlePair { it[this] = value }
+infix fun String.bundleTo(value: Long) = BundlePair { it[this] = value }
+infix fun String.bundleTo(value: Float) = BundlePair { it[this] = value }
+infix fun String.bundleTo(value: Double) = BundlePair { it[this] = value }
+infix fun String.bundleTo(value: Char) = BundlePair { it[this] = value }
+infix fun String.bundleTo(value: CharSequence) = BundlePair { it[this] = value }
+infix fun String.bundleTo(value: String) = BundlePair { it[this] = value }
+infix fun String.bundleTo(value: Bundle) = BundlePair { it[this] = value }
+/*infix fun String.bundleTo(value: Parcelable) = BundlePair { it[this] = value }
+infix fun String.bundleTo(value: Serializable) = BundlePair { it[this] = value }*/
+
+/*@RequiresApi(18)
+infix fun String.bundleTo(value: Binder) = BundlePair { it[this] = value }
+@RequiresApi(21)
+infix fun String.bundleTo(value: Size) = BundlePair { it[this] = value }
+@RequiresApi(21)
+infix fun String.bundleTo(value: SizeF) = BundlePair { it[this] = value }*/
+
+infix fun String.bundleTo(value: BooleanArray) = BundlePair { it[this] = value }
+infix fun String.bundleTo(value: ByteArray) = BundlePair { it[this] = value }
+infix fun String.bundleTo(value: ShortArray) = BundlePair { it[this] = value }
+infix fun String.bundleTo(value: IntArray) = BundlePair { it[this] = value }
+infix fun String.bundleTo(value: LongArray) = BundlePair { it[this] = value }
+infix fun String.bundleTo(value: FloatArray) = BundlePair { it[this] = value }
+infix fun String.bundleTo(value: DoubleArray) = BundlePair { it[this] = value }
+infix fun String.bundleTo(value: CharArray) = BundlePair { it[this] = value }
+infix fun String.bundleTo(value: Array<out CharSequence>) = BundlePair { it[this] = value }
+infix fun String.bundleTo(value: Array<out String>) = BundlePair { it[this] = value }
+//infix fun String.bundleTo(value: Array<out Parcelable>) = BundlePair { it[this] = value }
+
+//infix fun String.bundleTo(value: SparseArray<out Parcelable>) = BundlePair { it[this] = value }
+
+//for null
+infix fun String.bundleTo(n: Void?) = BundlePair { it[this] = null }
+
+
+operator fun Bundle.set(key: String, value: Boolean) = putBoolean(key, value)
+operator fun Bundle.set(key: String, value: Byte) = putByte(key, value)
+operator fun Bundle.set(key: String, value: Short) = putShort(key, value)
+operator fun Bundle.set(key: String, value: Int) = putInt(key, value)
+operator fun Bundle.set(key: String, value: Long) = putLong(key, value)
+operator fun Bundle.set(key: String, value: Float) = putFloat(key, value)
+operator fun Bundle.set(key: String, value: Double) = putDouble(key, value)
+operator fun Bundle.set(key: String, value: Char) = putChar(key, value)
+operator fun Bundle.set(key: String, value: CharSequence) = putCharSequence(key, value)
+operator fun Bundle.set(key: String, value: String) = putString(key, value)
+operator fun Bundle.set(key: String, value: Bundle) = putBundle(key, value)
+/*operator fun Bundle.set(key: String, value: Parcelable) = putParcelable(key, value)
+operator fun Bundle.set(key: String, value: Serializable) = putSerializable(key, value)*/
+
+/*@RequiresApi(18)
+operator fun Bundle.set(key: String, value: Binder) = putBinder(key, value)
+@RequiresApi(21)
+operator fun Bundle.set(key: String, value: Size) = putSize(key, value)
+@RequiresApi(21)
+operator fun Bundle.set(key: String, value: SizeF) = putSizeF(key, value)*/
+
+operator fun Bundle.set(key: String, value: BooleanArray) = putBooleanArray(key, value)
+operator fun Bundle.set(key: String, value: ByteArray) = putByteArray(key, value)
+operator fun Bundle.set(key: String, value: ShortArray) = putShortArray(key, value)
+operator fun Bundle.set(key: String, value: IntArray) = putIntArray(key, value)
+operator fun Bundle.set(key: String, value: LongArray) = putLongArray(key, value)
+operator fun Bundle.set(key: String, value: FloatArray) = putFloatArray(key, value)
+operator fun Bundle.set(key: String, value: DoubleArray) = putDoubleArray(key, value)
+operator fun Bundle.set(key: String, value: CharArray) = putCharArray(key, value)
+operator fun Bundle.set(key: String, value: Array<out CharSequence>) = putCharSequenceArray(key, value)
+operator fun Bundle.set(key: String, value: Array<out String>) = putStringArray(key, value)
+//operator fun Bundle.set(key: String, value: Array<out Parcelable>) = putParcelableArray(key, value)
+
+//operator fun Bundle.set(key: String, value: SparseArray<out Parcelable>) = putSparseParcelableArray(key, value)
+
+//for null
+operator fun Bundle.set(key: String, value: Void?) = putString(key, null)