cordova-spotify - npm Package Compare versions

Comparing version 0.5.2 to 0.5.4

package.json

 {
   "name": "cordova-spotify",
-  "version": "0.5.2",
+  "version": "0.5.4",
   "description": "Spotify SDK bindings for Cordova Applications",
@@ -29,3 +29,3 @@ "repository": {
   ],
-  "license": "LGPL-3.0",
+  "license": "MIT",
   "bugs": {
@@ -32,0 +32,0 @@ "url": "https://github.com/Festify/cordova-spotify/issues",

README.md

 # Cordova Spotify SDK Plugin
 
-[![Greenkeeper badge](https://badges.greenkeeper.io/Festify/cordova-spotify.svg)](https://greenkeeper.io/)
+[![Greenkeeper badge](https://badges.greenkeeper.io/Festify/cordova-spotify.svg)](https://greenkeeper.io/) [![Travis](https://img.shields.io/travis/Festify/cordova-spotify.svg)](https://travis-ci.org/Festify/cordova-spotify)
 
 An [Apache Cordova](https://cordova.apache.org/) plugin providing access to the Spotify SDK for iOS and Android.
 
-[API documentation](#api-docs)
+[API documentation](https://festify.github.io/cordova-spotify/)
 
@@ -24,62 +24,1 @@ ## Features
 Pull requests are very welcome! Please use the [gitmoji](https://gitmoji.carloscuesta.me/) style for commit messages.
-
-## <a name="api-docs"></a>API Documentation
-
-### General 
-
-The plugin has an extremely simple API that is focused just on playback. It consists of six functions clobbered onto `cordova.plugins.spotify`. In the following, treat all paths relative to that. The plugin handles all internal state and SDK initialization aspects automatically and hides these aspects from the developer.
-
-All functions are asynchronous and return promises (due to the way the Cordova <-> native code bridge works). The plugin automatically polyfills promise support through `es6-promise-plugin`.
-
-If any of the function parameters have invalid values, an appropriate `Error` will be thrown immediately instead of returning a rejected promise. This is because invalid arguments are bugs and not runtime errors.
-
-### `getEventEmitter(): Promise<EventEmitter>`
-
-Obtains an event emitter that relays the events fired by the native SDKs. The emitter will be created once and then returned on subsequent invocations.
-
-The emitter implementation comes from [eventemitter3](https://github.com/primus/eventemitter3). See their Github page for more information.
-
-The events emitted are the following:
-- `connectionmessage`
-- `loggedin`
-- `loggedout`
-- `loginfailed`
-- `playbackerror`
-- `playbackevent`
-- `temporaryerror`
-
-In the case of `loginfailed`, `playbackevent` and `playbackerror`, the event contains a payload that describes what happened exactly. The payload is simply the name of the discriminant of the enum in the native SDK without the prefix (usually `kSp` or `kSpError`). See the offical documentation [here](https://spotify.github.io/android-sdk/player/com/spotify/sdk/android/player/Error.html) and [here](https://spotify.github.io/android-sdk/player/com/spotify/sdk/android/player/PlayerEvent.html) for all variants.
-
-### `getPosition(): Promise<number>`
-
-Obtains the players position in _milliseconds_. If no track is currently loaded, returns 0.
-
-### `play(trackUri: string, authOptions: object[, position: number]): Promise`
-
-Plays the track with the given Spotify URI.
-
-#### Parameters
-
-- `trackUri`: The Spotify URI of the track to play. E.g. `spotify:track:6nTiIhLmQ3FWhvrGafw2z`. May not be null.
-- `authOptions`: An object containing two keys:
-    - `token: string`: A valid Spotify access token with the `streaming` scope. May not be null. You can use the [cordova-spotify-oauth](https://github.com/Festify/cordova-spotify-oauth) plugin for authentication.
-    - `clientId: string`: Your application's client ID as obtained from https://developer.spotify.com. May not be null.
-- `position`: Optional. The position (in _milliseconds_) to start playing the track from. Must be >= 0.
-
-`token` and `clientId` may change freely during runtime. The plugin will handle the required login / logout processes automatically when a new track is played.
-
-### `pause(): Promise`
-
-Pauses playback. If no track is loaded, returns normally.
-
-### `resume(): Promise`
-
-Resumes playback. If no track is loaded, the returned promise will be rejected with an error of type `not_playing`.
-
-### `seekTo(position: number): Promise`
-
-Sets the playback position to the given value. If no track is loaded, the returned promise will be rejected with an error of type `not_playing`.
-
-#### Parameters
-
-- `position`: The position (in _milliseconds_) to seek to. Must be >= 0.

www/package.json

@@ -7,8 +7,14 @@ {
   "devDependencies": {
-    "babel-core": "^6.20.0",
-    "babel-loader": "^6.2.9",
-    "babel-plugin-transform-object-assign": "^6.8.0",
-    "babel-preset-es2015": "^6.18.0",
-    "webpack": "^1.14.0"
+    "@types/cordova": "^0.0.34",
+    "@types/node": "^8.0.46",
+    "@types/webpack": "^3.0.13",
+    "awesome-typescript-loader": "^3.2.3",
+    "typedoc": "^0.9.0",
+    "typedoc-webpack-plugin": "^1.1.4",
+    "typescript": "^2.5.3",
+    "webpack": "^3.8.1"
+  },
+  "scripts": {
+    "build": "./node_modules/.bin/webpack -p"
   }
 }

www/webpack.config.js

@@ -1,22 +0,38 @@
-var webpack = require('webpack');
+const TypeDocPlugin = require('typedoc-webpack-plugin');
+const path = require('path');
 
 module.exports = {
-    entry: './cordova-spotify.js',
+    entry: './cordova-spotify.ts',
+    module: {
+        rules: [{
+            test: /(\.ts)/,
+            exclude: /node_modules/,
+            use: 'awesome-typescript-loader'
+        }]
+    },
+    resolve: {
+        extensions: ['.js', '.ts']
+    },
+    devtool: 'source-map',
+    externals: [
+        "cordova",
+        "cordova/exec"
+    ],
     output: {
-        path: __dirname,
-        filename: 'build/cordova-spotify.js',
+        path: path.resolve(__dirname, 'build'),
+        filename: 'cordova-spotify.min.js',
         library: 'spotify',
         libraryTarget: 'commonjs'
     },
-    module : {
-        externals: [
-            "cordova",
-            "cordova/exec"
-        ],
-        loaders: [{
-            test: /.js$/,
-            exclude: /node_modules/,
-            loader: 'babel-loader'
-        }]
-    }
+    plugins: [
+        new TypeDocPlugin({
+            excludeExternals: true,
+            excludePrivate: true,
+            ignoreCompilerErrors: true,
+            name: "Cordova Spotify Plugin",
+            mode: 'file',
+            readme: 'none',
+            target: 'ES6'
+        }, './cordova-spotify.ts')
+    ]
 };

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Copyleft License

License

(Experimental) Copyleft license information was found.

Found 1 instance in 1 package

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Non-permissive License

License

(Experimental) A license not known to be considered permissive was found.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

629768

increased by346.01%

Number of package files

44

increased by25.71%

Number of low license alerts

0

decreased by-100%

License quality

100

increased by42.86%

Lines of code

439

increased by299.09%

Worsened metrics

Number of lines in readme file

24

decreased by-71.76%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes