@untemps/user-permissions-utils 1.1.38 → 1.2.1

package/README.md

@@ -16,7 +16,7 @@ yarn add @untemps/user-permissions-utils
 
 `getPermission`:
 
-Returns a promise resolved when the permission is granted
+Returns a promise resolved when the permission is granted. Accepts an optional `signal` to cancel the pending wait.
 
 ```javascript
 import { getPermission } from '@untemps/user-permissions-utils'
@@ -31,6 +31,27 @@ const init = async () => {
 }
 ```
 
+To cancel a pending permission wait:
+
+```javascript
+import { getPermission } from '@untemps/user-permissions-utils'
+
+const controller = new AbortController()
+
+const init = async () => {
+    try {
+        await getPermission('microphone', { signal: controller.signal })
+        ...
+    } catch (error) {
+        if (error.name === 'AbortError') return
+        console.error(error)
+    }
+}
+
+// Cancel before the user responds to the permission dialog
+controller.abort()
+```
+
 `getUserMediaStream`:
 
 Returns a promise resolved when the permission is granted and the stream is retrieved

package/dist/index.d.ts

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

package/dist/index.es.js

@@ -1,18 +1,22 @@
 //#region src/isNavigatorPermissionsSupported.js
-var e = () => !!navigator.permissions, t = () => !!navigator.mediaDevices, n = async (t) => {
+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");
-	let n = await navigator.permissions.query({ name: t });
-	return n.state === "prompt" ? new Promise((e, t) => {
-		let i = (a) => {
-			n.removeEventListener("change", i);
+	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(a.target.state));
+				e(r(s.target.state));
 			} catch (e) {
 				t(e);
 			}
+		}, o = () => {
+			i.removeEventListener("change", a), t(n.reason);
 		};
-		n.addEventListener("change", i);
-	}) : r(n.state);
+		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;

package/dist/index.js

@@ -1 +1 @@
-Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});var e=()=>!!navigator.permissions,t=()=>!!navigator.mediaDevices,n=async t=>{if(!e())throw new DOMException(`Navigator API: permissions not supported`,`NOT_SUPPORTED_ERR`);let n=await navigator.permissions.query({name:t});return n.state===`prompt`?new Promise((e,t)=>{let i=a=>{n.removeEventListener(`change`,i);try{e(r(a.target.state))}catch(e){t(e)}};n.addEventListener(`change`,i)}):r(n.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)=>{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;

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=>{if(!t())throw new DOMException(`Navigator API: permissions not supported`,`NOT_SUPPORTED_ERR`);let n=await navigator.permissions.query({name:e});return n.state===`prompt`?new Promise((e,t)=>{let r=a=>{n.removeEventListener(`change`,r);try{e(i(a.target.state))}catch(e){t(e)}};n.addEventListener(`change`,r)}):i(n.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)=>{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});

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@untemps/user-permissions-utils",
-	"version": "1.1.38",
+	"version": "1.2.1",
 	"description": "Collection of utility functions to manage user permissions",
 	"repository": "git@github.com:untemps/user-permissions-utils.git",
 	"keywords": [