@untemps/user-permissions-utils 1.2.4 → 1.3.0

package/README.md

@@ -54,27 +54,44 @@ controller.abort()
 
 `getUserMediaStream`:
 
-Returns a promise resolved when the permission is granted and the stream is retrieved
+Returns a promise resolved when the permission is granted and the stream is retrieved. Accepts an optional `signal` to cancel the entire operation.
 
 ```javascript
 import { getUserMediaStream } from '@untemps/user-permissions-utils'
 
 const init = async () => {
     try {
-    	const stream = await getUserMediaStream('microphone', { audio: true })
-    	if(!!stream) {
-    	    const audioContext = new AudioContext()
-    	    const streamNode = audioContext.createMediaStreamSource(stream)
-            ...
-    	} else {
-    	    console.error('Stream is not available')
-    	}
+        const stream = await getUserMediaStream('microphone', { audio: true })
+        const audioContext = new AudioContext()
+        const streamNode = audioContext.createMediaStreamSource(stream)
+        ...
     } catch (error) {
         console.error(error)
     }
 }
 ```
 
+To cancel a pending stream acquisition:
+
+```javascript
+import { getUserMediaStream } from '@untemps/user-permissions-utils'
+
+const controller = new AbortController()
+
+const init = async () => {
+    try {
+        const stream = await getUserMediaStream('microphone', { audio: true }, { signal: controller.signal })
+        ...
+    } catch (error) {
+        if (error.name === 'AbortError') return
+        console.error(error)
+    }
+}
+
+// Cancel the operation at any point (permission wait or stream acquisition)
+controller.abort()
+```
+
 `isNavigatorPermissionsSupported`:
 
 Returns `true` if the browser supports `navigator.permissions`
@@ -106,4 +123,3 @@ if (!isNavigatorMediaDevicesSupported()) {
     -   geolocation
     -   notification
     -   ...
--   Add commitlint to ensure commit logs are valid

package/dist/index.d.ts

@@ -4,7 +4,8 @@ export declare function getPermission(
 ): Promise<'granted'>
 export declare function getUserMediaStream(
 	permissionName: PermissionName,
-	constraints: MediaStreamConstraints
+	constraints: MediaStreamConstraints,
+	options?: { signal?: AbortSignal }
 ): Promise<MediaStream>
 export declare function isNavigatorPermissionsSupported(): boolean
 export declare function isNavigatorMediaDevicesSupported(): boolean

package/dist/index.es.js

@@ -20,9 +20,9 @@ var e = () => !!navigator.permissions, t = () => !!navigator.mediaDevices, n = a
 }, r = (e) => {
 	if (e === "denied") throw new DOMException("Permission denied", "NOT_ALLOWED_ERR");
 	return e;
-}, i = async (r, i) => {
+}, i = async (r, i, { signal: a } = {}) => {
 	if (!e() || !t()) throw new DOMException("Navigator API: permissions or Navigator API: mediaDevices not supported", "NOT_SUPPORTED_ERR");
-	return await n(r), navigator.mediaDevices.getUserMedia(i);
+	return await n(r, { signal: a }), a?.throwIfAborted(), navigator.mediaDevices.getUserMedia(i);
 };
 //#endregion
 export { n as getPermission, i as getUserMediaStream, t as isNavigatorMediaDevicesSupported, e as isNavigatorPermissionsSupported };

package/dist/index.js

@@ -1 +1 @@
-Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});var e=()=>!!navigator.permissions,t=()=>!!navigator.mediaDevices,n=async(t,{signal:n}={})=>{if(!e())throw new DOMException(`Navigator API: permissions not supported`,`NOT_SUPPORTED_ERR`);n?.throwIfAborted();let i=await navigator.permissions.query({name:t});return i.state===`prompt`?new Promise((e,t)=>{n?.throwIfAborted();let a=s=>{i.removeEventListener(`change`,a),n?.removeEventListener(`abort`,o);try{e(r(s.target.state))}catch(e){t(e)}},o=()=>{i.removeEventListener(`change`,a),t(n.reason)};i.addEventListener(`change`,a),n?.addEventListener(`abort`,o,{once:!0})}):r(i.state)},r=e=>{if(e===`denied`)throw new DOMException(`Permission denied`,`NOT_ALLOWED_ERR`);return e},i=async(r,i)=>{if(!e()||!t())throw new DOMException(`Navigator API: permissions or Navigator API: mediaDevices not supported`,`NOT_SUPPORTED_ERR`);return await n(r),navigator.mediaDevices.getUserMedia(i)};exports.getPermission=n,exports.getUserMediaStream=i,exports.isNavigatorMediaDevicesSupported=t,exports.isNavigatorPermissionsSupported=e;
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});var e=()=>!!navigator.permissions,t=()=>!!navigator.mediaDevices,n=async(t,{signal:n}={})=>{if(!e())throw new DOMException(`Navigator API: permissions not supported`,`NOT_SUPPORTED_ERR`);n?.throwIfAborted();let i=await navigator.permissions.query({name:t});return i.state===`prompt`?new Promise((e,t)=>{n?.throwIfAborted();let a=s=>{i.removeEventListener(`change`,a),n?.removeEventListener(`abort`,o);try{e(r(s.target.state))}catch(e){t(e)}},o=()=>{i.removeEventListener(`change`,a),t(n.reason)};i.addEventListener(`change`,a),n?.addEventListener(`abort`,o,{once:!0})}):r(i.state)},r=e=>{if(e===`denied`)throw new DOMException(`Permission denied`,`NOT_ALLOWED_ERR`);return e},i=async(r,i,{signal:a}={})=>{if(!e()||!t())throw new DOMException(`Navigator API: permissions or Navigator API: mediaDevices not supported`,`NOT_SUPPORTED_ERR`);return await n(r,{signal:a}),a?.throwIfAborted(),navigator.mediaDevices.getUserMedia(i)};exports.getPermission=n,exports.getUserMediaStream=i,exports.isNavigatorMediaDevicesSupported=t,exports.isNavigatorPermissionsSupported=e;

package/dist/index.umd.js

@@ -1 +1 @@
-(function(e,t){typeof exports==`object`&&typeof module<`u`?t(exports):typeof define==`function`&&define.amd?define([`exports`],t):(e=typeof globalThis<`u`?globalThis:e||self,t(e.UserPermissionsUtils={}))})(this,function(e){Object.defineProperty(e,Symbol.toStringTag,{value:`Module`});var t=()=>!!navigator.permissions,n=()=>!!navigator.mediaDevices,r=async(e,{signal:n}={})=>{if(!t())throw new DOMException(`Navigator API: permissions not supported`,`NOT_SUPPORTED_ERR`);n?.throwIfAborted();let r=await navigator.permissions.query({name:e});return r.state===`prompt`?new Promise((e,t)=>{n?.throwIfAborted();let a=s=>{r.removeEventListener(`change`,a),n?.removeEventListener(`abort`,o);try{e(i(s.target.state))}catch(e){t(e)}},o=()=>{r.removeEventListener(`change`,a),t(n.reason)};r.addEventListener(`change`,a),n?.addEventListener(`abort`,o,{once:!0})}):i(r.state)},i=e=>{if(e===`denied`)throw new DOMException(`Permission denied`,`NOT_ALLOWED_ERR`);return e};e.getPermission=r,e.getUserMediaStream=async(e,i)=>{if(!t()||!n())throw new DOMException(`Navigator API: permissions or Navigator API: mediaDevices not supported`,`NOT_SUPPORTED_ERR`);return await r(e),navigator.mediaDevices.getUserMedia(i)},e.isNavigatorMediaDevicesSupported=n,e.isNavigatorPermissionsSupported=t});
+(function(e,t){typeof exports==`object`&&typeof module<`u`?t(exports):typeof define==`function`&&define.amd?define([`exports`],t):(e=typeof globalThis<`u`?globalThis:e||self,t(e.UserPermissionsUtils={}))})(this,function(e){Object.defineProperty(e,Symbol.toStringTag,{value:`Module`});var t=()=>!!navigator.permissions,n=()=>!!navigator.mediaDevices,r=async(e,{signal:n}={})=>{if(!t())throw new DOMException(`Navigator API: permissions not supported`,`NOT_SUPPORTED_ERR`);n?.throwIfAborted();let r=await navigator.permissions.query({name:e});return r.state===`prompt`?new Promise((e,t)=>{n?.throwIfAborted();let a=s=>{r.removeEventListener(`change`,a),n?.removeEventListener(`abort`,o);try{e(i(s.target.state))}catch(e){t(e)}},o=()=>{r.removeEventListener(`change`,a),t(n.reason)};r.addEventListener(`change`,a),n?.addEventListener(`abort`,o,{once:!0})}):i(r.state)},i=e=>{if(e===`denied`)throw new DOMException(`Permission denied`,`NOT_ALLOWED_ERR`);return e};e.getPermission=r,e.getUserMediaStream=async(e,i,{signal:a}={})=>{if(!t()||!n())throw new DOMException(`Navigator API: permissions or Navigator API: mediaDevices not supported`,`NOT_SUPPORTED_ERR`);return await r(e,{signal:a}),a?.throwIfAborted(),navigator.mediaDevices.getUserMedia(i)},e.isNavigatorMediaDevicesSupported=n,e.isNavigatorPermissionsSupported=t});

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@untemps/user-permissions-utils",
-	"version": "1.2.4",
+	"version": "1.3.0",
 	"description": "Collection of utility functions to manage user permissions",
 	"repository": "git@github.com:untemps/user-permissions-utils.git",
 	"keywords": [
@@ -32,6 +32,8 @@
 		"dist"
 	],
 	"devDependencies": {
+		"@commitlint/cli": "^21.0.1",
+		"@commitlint/config-conventional": "^21.0.1",
 		"@eslint/js": "^10.0.1",
 		"@semantic-release/changelog": "^6.0.1",
 		"@semantic-release/git": "^10.0.1",