auth-vir 0.0.1 → 0.0.3

package/README.md

@@ -65,7 +65,7 @@ Use this on your host / server / backend to authenticate client / frontend reque
 5. In your application code, load the string keys from step 1 into [`parseJwtKeys`](https://electrovir.github.io/auth-vir/functions/parseUserJwt.html): `await parseJwtKeys(stringKeys)`.
 6. Use the output of [`parseJwtKeys`](https://electrovir.github.io/auth-vir/functions/parseUserJwt.html) in all auth functionality:
     - [`generateSuccessfulLoginHeaders`](https://electrovir.github.io/auth-vir/functions/generateSuccessfulLoginHeaders.html): after a user successfully logs in, run this function and attach the output headers to the `Response` object.
-    - [`extractUserIdFromRequestHeaders`](https://electrovir.github.io/auth-vir/functions/extractUserIdFromRequestHeaders.html): to verify an authenticated user `Request` object (make sure to properly attach all auth in the client by following the below [Client side](#client-side) guide).
+    - [`extractUserIdFromRequestHeaders`](https://electrovir.github.io/auth-vir/functions/extractUserIdFromRequestHeaders.html): to verify an authenticated user `Request` object (make sure to properly attach all auth in the client by following the below [Client / frontend side](#client--frontend-side) guide).
 
 Here's a full example of how to use all host / server / backend side auth functionality:
 
@@ -236,7 +236,7 @@ Use this on your client / frontend for storing and sending session authorization
 1. Send a login fetch request to your host / server / backend with `{credentials: 'include'}` set on the request.
 2. Pass the `Response` from step 1 into [`handleAuthResponse`](https://electrovir.github.io/auth-vir/functions/handleAuthResponse.html).
 3. In all subsequent fetch requests to the host / server / backend, set `{credentials: 'include'}` and include `{headers: {[csrfTokenHeaderName]: getCurrentCsrfToken()}}`.
-4. Upon user logout, call [`wipeCurrentCsrfToken()]`(https://electrovir.github.io/auth-vir/functions/wipeCurrentCsrfToken.html)
+4. Upon user logout, call [`wipeCurrentCsrfToken()`](https://electrovir.github.io/auth-vir/functions/wipeCurrentCsrfToken.html)
 
 Here's a full example of how to use all the client / frontend side auth functionality:
 

package/dist/auth.d.ts

@@ -1,5 +1,5 @@
-import { CookieParams } from './cookie.js';
-import { ParseJwtParams } from './jwt.js';
+import { type CookieParams } from './cookie.js';
+import { type ParseJwtParams } from './jwt.js';
 /**
  * All possible headers container types supported by {@link extractUserIdFromRequestHeaders}.
  *

package/dist/cookie.d.ts

@@ -1,7 +1,7 @@
 import { type PartialWithUndefined } from '@augment-vir/common';
 import { type AnyDuration } from 'date-vir';
-import { CreateJwtParams, type ParseJwtParams } from './jwt.js';
-import { UserJwtData } from './user-jwt.js';
+import { type CreateJwtParams, type ParseJwtParams } from './jwt.js';
+import { type UserJwtData } from './user-jwt.js';
 /**
  * Parameters for {@link generateCookie}.
  *

package/dist/jwt.d.ts

@@ -1,6 +1,6 @@
-import type { AnyObject, PartialWithUndefined } from '@augment-vir/common';
+import { type AnyObject, type PartialWithUndefined } from '@augment-vir/common';
 import { type AnyDuration, type DateLike } from 'date-vir';
-import { JwtKeys } from './jwt-keys.js';
+import { type JwtKeys } from './jwt-keys.js';
 /**
  * Params for {@link createJwt}.
  *

package/dist/user-jwt.d.ts

@@ -1,4 +1,4 @@
-import { CreateJwtParams, ParseJwtParams } from './jwt.js';
+import { type CreateJwtParams, type ParseJwtParams } from './jwt.js';
 /**
  * Shape definition and source of truth for {@link UserJwtData}.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "auth-vir",
-    "version": "0.0.1",
+    "version": "0.0.3",
     "description": "Auth made easy and secure via JWT cookies, CSRF tokens, and password hashing helpers.",
     "keywords": [
         "auth",
@@ -28,7 +28,7 @@
     "main": "dist/index.js",
     "module": "dist/index.js",
     "types": "dist/index.d.ts",
-    "bin": "",
+    "bin": "bin.js",
     "scripts": {
         "build": "virmator frontend build",
         "compile": "virmator compile",
@@ -40,16 +40,16 @@
         "test:update": "npm test update"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.11.0",
-        "@augment-vir/common": "^31.11.0",
+        "@augment-vir/assert": "^31.17.1",
+        "@augment-vir/common": "^31.17.1",
         "date-vir": "^7.3.1",
         "hash-wasm": "^4.12.0",
-        "jose": "^6.0.10",
+        "jose": "^6.0.11",
         "object-shape-tester": "^5.1.5",
         "url-vir": "^2.1.3"
     },
     "devDependencies": {
-        "@augment-vir/test": "^31.11.0",
+        "@augment-vir/test": "^31.17.1",
         "@web/dev-server-esbuild": "^1.0.4",
         "@web/test-runner": "^0.20.1",
         "@web/test-runner-commands": "^0.9.0",
@@ -57,7 +57,7 @@
         "@web/test-runner-visual-regression": "^0.10.0",
         "istanbul-smart-text-reporter": "^1.1.5",
         "markdown-code-example-inserter": "^3.0.3",
-        "typedoc": "^0.28.2"
+        "typedoc": "^0.28.4"
     },
     "engines": {
         "node": ">=22"

package/src/auth.ts

@@ -1,6 +1,6 @@
-import {CookieParams, extractCookieJwt, generateCookie} from './cookie.js';
+import {type CookieParams, extractCookieJwt, generateCookie} from './cookie.js';
 import {csrfTokenHeaderName, generateCsrfToken} from './csrf-token.js';
-import {ParseJwtParams} from './jwt.js';
+import {type ParseJwtParams} from './jwt.js';
 
 /**
  * All possible headers container types supported by {@link extractUserIdFromRequestHeaders}.

package/src/cookie.ts

@@ -2,8 +2,8 @@ import {check} from '@augment-vir/assert';
 import {safeMatch, type PartialWithUndefined} from '@augment-vir/common';
 import {convertDuration, type AnyDuration} from 'date-vir';
 import {parseUrl} from 'url-vir';
-import {CreateJwtParams, type ParseJwtParams} from './jwt.js';
-import {createUserJwt, parseUserJwt, UserJwtData} from './user-jwt.js';
+import {type CreateJwtParams, type ParseJwtParams} from './jwt.js';
+import {createUserJwt, parseUserJwt, type UserJwtData} from './user-jwt.js';
 
 /**
  * Parameters for {@link generateCookie}.

package/src/jwt.ts

@@ -1,5 +1,5 @@
 import {check} from '@augment-vir/assert';
-import type {AnyObject, PartialWithUndefined} from '@augment-vir/common';
+import {type AnyObject, type PartialWithUndefined} from '@augment-vir/common';
 import {
     calculateRelativeDate,
     createFullDateInUserTimezone,
@@ -9,7 +9,7 @@ import {
     type DateLike,
 } from 'date-vir';
 import {EncryptJWT, jwtDecrypt, jwtVerify, SignJWT} from 'jose';
-import {JwtKeys} from './jwt-keys.js';
+import {type JwtKeys} from './jwt-keys.js';
 
 const encryptionProtectedHeader = {alg: 'dir', enc: 'A256GCM'};
 const signingProtectedHeader = {alg: 'HS512'};

package/src/user-jwt.ts

@@ -1,6 +1,6 @@
 import {defineShape, isValidShape} from 'object-shape-tester';
 import {type generateCsrfToken} from './csrf-token.js';
-import {createJwt, CreateJwtParams, parseJwt, ParseJwtParams} from './jwt.js';
+import {createJwt, type CreateJwtParams, parseJwt, type ParseJwtParams} from './jwt.js';
 
 /**
  * Shape definition and source of truth for {@link UserJwtData}.