web-audio-api-player - npm Package Compare versions

Comparing version 4.0.1 to 4.0.2

dist/index.d.ts

 export { PlayerCore, ICoreOptions } from './library/core';
 export { PlayerSound, ISoundAttributes, ISound } from './library/sound';

dist/library/audio.d.ts

@@ -0,0 +0,0 @@ import { typePlayerModes } from './core';

dist/library/core.d.ts

@@ -0,0 +0,0 @@ import { ISound, ISoundAttributes, ISoundSource, typeSoundStates } from './sound';

dist/library/error.d.ts

@@ -0,0 +0,0 @@ export interface IPlayerError extends Error {

dist/library/request.d.ts

@@ -0,0 +0,0 @@ import { IPlayerError } from './error';

dist/library/sound.d.ts

@@ -0,0 +0,0 @@ declare const SOUND_STATE_STOPPED = "sound_state_stopped";

package.json

 {
     "name": "web-audio-api-player",
-    "version": "4.0.1",
+    "version": "4.0.2",
     "description": "web audio api player",
@@ -42,11 +42,11 @@ "keywords": [
     "devDependencies": {
-        "@typescript-eslint/eslint-plugin": "5.47.0",
-        "@typescript-eslint/parser": "5.47.0",
-        "eslint": "8.30.0",
-        "eslint-plugin-import": "2.26.0",
-        "rollup": "3.8.1",
+        "@typescript-eslint/eslint-plugin": "5.55.0",
+        "@typescript-eslint/parser": "5.55.0",
+        "eslint": "8.36.0",
+        "eslint-plugin-import": "2.27.5",
+        "rollup": "3.19.1",
         "rollup-plugin-typescript2": "0.34.1",
-        "typescript": "4.9.4"
+        "typescript": "5.0.2"
     },
     "type": "module"
 }

README.md

@@ -19,3 +19,3 @@ [![npm version](https://img.shields.io/npm/v/web-audio-api-player.svg?style=flat)](https://www.npmjs.com/package/web-audio-api-player)
 
-Want to help improve the documentation or contribute to this project by improving and fixing it, then first check out the [TODOs section](#todos-help-wanted-) below, maybe there is something in the list you want to help with. Any contribution, even things not listed on the TODO list are of course welcome. To get started check out the section ["contributing" section](#contributing) below.  
+Want to help improve the documentation or contribute to this project by improving and fixing it, then first check out the [TODOs section](#todos-help--prs-appreciated) below, maybe there is something in the list you want to help with. Any contribution, even things not listed on the TODO list are of course welcome. To get started check out the section ["contributing" section](#contributing-prs-welcome) below.  
 
@@ -26,4 +26,10 @@ ## installation
 
-`npm install web-audio-api-player`  
+with npm:
 
+`npm i web-audio-api-player`  
+
+or with yarn:
+
+`yarn add web-audio-api-player`  
+
 ## documentation
@@ -111,5 +117,2 @@
 
-* es6 module = /dist/index.js  
-* UMD version = /dist/index.umd.js  
-
 `npm run build`
@@ -129,3 +132,3 @@
 
-## contributing
+## contributing (PRs welcome)
 
@@ -140,3 +143,3 @@ you should first open a ticket and explain what fix or improvement you want to provide on the [github issues page](https://github.com/chrisweb/web-audio-api-player/issues) of this project (remember the github ticket number you will need it for the commit message later on)
 
-when you are done coding, commit your local changes (if your commit is related to a ticket start your commit message with the "#TICKER_NUMBER")  
+when you are done coding, commit your local changes (if your commit is related to a ticket start your commit message with the "#TICKER_NUMBER", this will "link" the commit to the ticket)  
 
@@ -167,3 +170,3 @@ `git commit -m "#TICKER_NUMBER commit message"`
 
-As of now (25.05.2019) the web audio api typings seems to be included in lib.d.ts, so removing them from package.json:  
+As of the 25.05.2019 the web audio api typings seem to be included in lib.d.ts, so removing them from package.json:  
 
@@ -176,12 +179,19 @@ ```json
 
-Unfortunately the defined window does not have AudioContext:  
-check out [[open] github ticket (as of 06/2019)](https://github.com/microsoft/TypeScript/issues/31686)  
-the current [dom.d.ts on github](https://github.com/microsoft/TypeScript/blob/master/src/lib/dom.generated.d.ts)  
+Unfortunately (as of 06/2019) the defined window does not have AudioContext:  
 
+* check out [github ticket](https://github.com/microsoft/TypeScript/issues/31686)  
+* the current [dom.d.ts on github](https://github.com/microsoft/TypeScript/blob/master/src/lib/dom.generated.d.ts)  
+
+This is fixed, as of now (20.02.2023) the AudioContext is now defined properly
+
 ## Changelog
 
+* 4.0.2 eslint-plugin-import dependency update, to fix JSON5 related [CVE-2022-46175](https://github.com/advisories/GHSA-9c47-m6qq-7p4h)
+* 4.0.1 merged pull request #19 to fix audiocontext types
 * 4.0.0 removed UMD support, this and future versions will be ESM only
 
-## TODOs (help / PRs appreciated 😊)
+## TODOs (help / PRs appreciated)
 
+If you are interested in helping out 😊 by working on one of the following TODOs, please start by reading the ["contributing"](#contributing-prs-welcome) chapter above
+
 * create a react example
@@ -188,0 +198,0 @@ * create a vue.js example

No alert changes

Improved metrics

Lines of code

1875

increased by0.11%

Number of lines in readme file

269

increased by3.86%

Worsened metrics

Total package byte prevSize

104752

decreased by-1.17%

No dependency changes