@untemps/user-permissions-utils 1.3.3 → 1.3.5-beta.1

package/README.md

@@ -12,6 +12,16 @@ Collection of utility functions to manage user permissions.
 yarn add @untemps/user-permissions-utils
 ```
 
+## TypeScript
+
+This package is written in TypeScript and ships its own type declarations — no extra `@types/...` package is required. The option types are exported for convenience:
+
+```typescript
+import { getPermission, getUserMediaStream, type GetPermissionOptions, type GetUserMediaStreamOptions } from '@untemps/user-permissions-utils'
+```
+
+`permissionName` is typed as the DOM `PermissionName` (e.g. `'microphone'`, `'camera'`) and `mediaStreamConstraints` as the DOM `MediaStreamConstraints`.
+
 ## Utils
 
 `getPermission`:

package/dist/getPermission.d.ts

@@ -0,0 +1,11 @@
+export interface GetPermissionOptions {
+    signal?: AbortSignal;
+}
+/**
+ * Returns a promise resolved when the permission is granted by the user
+ * @param permissionName            Name of the permission. @see https://w3c.github.io/permissions/#enumdef-permissionname
+ * @param options                   Optional settings
+ * @param options.signal            Optional AbortSignal to cancel the pending permission wait
+ */
+declare const getPermission: (permissionName: PermissionName, { signal }?: GetPermissionOptions) => Promise<"granted">;
+export default getPermission;

package/dist/getUserMediaStream.d.ts

@@ -0,0 +1,12 @@
+export interface GetUserMediaStreamOptions {
+    signal?: AbortSignal;
+}
+/**
+ * Returns a promise resolved when the permission is granted by the user and the stream is retrieved
+ * @param permissionName            Name of the permission. @see https://w3c.github.io/permissions/#enumdef-permissionname
+ * @param mediaStreamConstraints    Constraints object. @see https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamConstraints
+ * @param options                   Optional settings
+ * @param options.signal            Optional AbortSignal to cancel the operation
+ */
+declare const getUserMediaStream: (permissionName: PermissionName, mediaStreamConstraints: MediaStreamConstraints, { signal }?: GetUserMediaStreamOptions) => Promise<MediaStream>;
+export default getUserMediaStream;

package/dist/index.d.ts

@@ -1,11 +1,6 @@
-export declare function getPermission(
-	permissionName: PermissionName,
-	options?: { signal?: AbortSignal }
-): Promise<'granted'>
-export declare function getUserMediaStream(
-	permissionName: PermissionName,
-	constraints: MediaStreamConstraints,
-	options?: { signal?: AbortSignal }
-): Promise<MediaStream>
-export declare function isNavigatorPermissionsSupported(): boolean
-export declare function isNavigatorMediaDevicesSupported(): boolean
+export { default as isNavigatorPermissionsSupported } from './isNavigatorPermissionsSupported';
+export { default as isNavigatorMediaDevicesSupported } from './isNavigatorMediaDevicesSupported';
+export { default as getPermission } from './getPermission';
+export { default as getUserMediaStream } from './getUserMediaStream';
+export type { GetPermissionOptions } from './getPermission';
+export type { GetUserMediaStreamOptions } from './getUserMediaStream';

package/dist/index.es.js

@@ -1,4 +1,4 @@
-//#region src/isNavigatorPermissionsSupported.js
+//#region src/isNavigatorPermissionsSupported.ts
 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();

package/dist/isNavigatorMediaDevicesSupported.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Check whether Navigator API: mediaDevices is supported by the current browser
+ */
+declare const _default: () => boolean;
+export default _default;

package/dist/isNavigatorPermissionsSupported.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Check whether Navigator API: permissions is supported by the current browser
+ */
+declare const _default: () => boolean;
+export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@untemps/user-permissions-utils",
-	"version": "1.3.3",
+	"version": "1.3.5-beta.1",
 	"description": "Collection of utility functions to manage user permissions",
 	"repository": "git@github.com:untemps/user-permissions-utils.git",
 	"keywords": [
@@ -44,12 +44,19 @@
 		"jsdom": "^29.1.1",
 		"prettier": "^3.8.3",
 		"semantic-release": "^25.0.3",
+		"typescript": "^6.0.3",
+		"typescript-eslint": "^8.60.1",
 		"vite": "^8.0.12",
+		"vite-plugin-dts": "^5.0.2",
 		"vitest": "^4.1.6"
 	},
 	"release": {
 		"branches": [
-			"main"
+			"main",
+			{
+				"name": "beta",
+				"prerelease": true
+			}
 		],
 		"plugins": [
 			[
@@ -73,9 +80,10 @@
 		"dev": "vite demo --config demo/vite.config.js",
 		"test": "vitest",
 		"test:ci": "vitest run --coverage",
-		"build": "vite build && cp src/index.d.ts dist/index.d.ts",
+		"typecheck": "tsc --noEmit",
+		"build": "vite build",
 		"lint": "eslint src/",
-		"prettier": "prettier \"./**/*.js\" --ignore-path ./.prettierignore --write",
+		"prettier": "prettier \"./**/*.{js,ts}\" --ignore-path ./.prettierignore --write",
 		"prepare": "husky"
 	}
 }