@prsm/auth 1.0.0 → 1.0.2

package/README.md

@@ -1,14 +1,16 @@
-<img src="logo.svg" alt="@prsm/auth" width="96" height="96">
+<p align="center">
+  <img src="logo.svg" width="80" height="80" alt="auth logo">
+</p>
 
-# @prsm/auth
+<h1 align="center">@prsm/auth</h1>
 
-[![test](https://github.com/prsmjs/auth/actions/workflows/test.yml/badge.svg)](https://github.com/prsmjs/auth/actions/workflows/test.yml)
-[![npm](https://img.shields.io/npm/v/@prsm/auth)](https://www.npmjs.com/package/@prsm/auth)
+<p align="center">
+  <a href="https://github.com/prsmjs/auth/actions/workflows/test.yml"><img src="https://github.com/prsmjs/auth/actions/workflows/test.yml/badge.svg" alt="test"></a>
+  <a href="https://www.npmjs.com/package/@prsm/auth"><img src="https://img.shields.io/npm/v/@prsm/auth" alt="npm"></a>
+</p>
 
 PostgreSQL-backed authentication for Express. It owns its own auth tables and links to your user records through `user_id`, so it stays out of the way of however you model application users. One middleware attaches everything to `req.auth`: registration, login, sessions, remember-me, email confirmation, password reset, OAuth, role bitmasks, two-factor authentication, and audited impersonation.
 
-It runs on a single shared PostgreSQL database behind any number of stateless app instances. Session storage is delegated to `express-session`, so you pick the store. Optional PostgreSQL `LISTEN/NOTIFY` propagates bans, role changes, and force-logouts across the fleet the instant they happen, with no Redis required.
-
 ## Install
 
 ```bash

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prsm/auth",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "PostgreSQL-backed authentication for Express: sessions, remember-me, password reset, email confirmation, OAuth, roles, two-factor, and audited impersonation",
   "type": "module",
   "exports": {
@@ -46,7 +46,7 @@
   },
   "peerDependencies": {
     "cookie-parser": "^1.4.0",
-    "express": "^5.0.0",
+    "express": "^4.17.0 || ^5.0.0",
     "express-session": "^1.18.0",
     "pg": "^8.0.0"
   },

package/src/user-roles.js

@@ -13,8 +13,9 @@ const MAX_ROLES = 31
  * Define a set of named roles as a frozen bitmask map. Each role gets the next
  * power-of-two bit. Capped at 31 because postgres INTEGER is 32-bit signed.
  *
- * @param {...string} names
- * @returns {Readonly<Record<string, number>>}
+ * @template {string} K
+ * @param {...K} names
+ * @returns {Readonly<Record<K, number>>}
  */
 export function defineRoles(...names) {
   if (names.length > MAX_ROLES) {

package/types/user-roles.d.ts

@@ -2,10 +2,11 @@
  * Define a set of named roles as a frozen bitmask map. Each role gets the next
  * power-of-two bit. Capped at 31 because postgres INTEGER is 32-bit signed.
  *
- * @param {...string} names
- * @returns {Readonly<Record<string, number>>}
+ * @template {string} K
+ * @param {...K} names
+ * @returns {Readonly<Record<K, number>>}
  */
-export function defineRoles(...names: string[]): Readonly<Record<string, number>>;
+export function defineRoles<K extends string>(...names: K[]): Readonly<Record<K, number>>;
 /**
  * Add a role to a user's account using bitwise OR.
  *