chore: update jwt-adapter docs

Author: Vicentesan

libs/jwt-adapter/src/adapter.ts

@@ -3,6 +3,9 @@ import { authAdapter } from '@palmares/auth';
 import { sign } from './funcs/sign';
 import { verify } from './funcs/verify';
 
+/**
+ * Defines the structure of the payload used in JWT operations.
+ */
 export interface JWTPayload {
   /**
    * JWT Issuer
@@ -57,6 +60,9 @@ export interface JWTPayload {
   [propName: string]: unknown;
 }
 
+/**
+ * Enumerates the supported JWT signing algorithms.
+ */
 export type JWTAlgorithm =
   | 'HS256'
   | 'HS384'
@@ -71,12 +77,22 @@ export type JWTAlgorithm =
   | 'PS384'
   | 'PS512';
 
+/**
+ * Defines the options for JWT operations.
+ */
 export interface JWTOptions {
   alg: JWTAlgorithm;
   typ?: 'JWT';
   exp: number; // in seconds
 }
 
+/**
+ * Provides JWT authentication methods such as signing and verifying tokens.
+ * We recommend using the 'jose' library for JWT operations due to its comprehensive support for modern JWT standards.
+ * Please refer to the documentation in `@palmares/auth` for more details on adapter implementations.
+ *
+ * Warning: Ensure that the `secret` provided is securely stored and managed to prevent security vulnerabilities.
+ */
 export const jwtAdapter = authAdapter(
   ({ secret, library = 'jose' }: { secret: string; library?: 'jsonwebtoken' | 'jose' }) => ({
     name: 'jwt',

libs/jwt-adapter/src/funcs/sign.ts

@@ -3,6 +3,16 @@ import * as jwt from 'jsonwebtoken';
 
 import type { JWTOptions, JWTPayload } from '../adapter';
 
+/**
+ * Signs a JWT using the specified library and options.
+ *
+ * @param {string} secret - The secret key used for signing the JWT.
+ * @param {'jsonwebtoken' | 'jose'} library - The library to use for signing ('jsonwebtoken' or 'jose').
+ * @param {JWTPayload} payload - The payload to be included in the JWT.
+ * @param {JWTOptions} options - The options to configure the JWT signing process.
+ * @returns {Promise<string>} A promise that resolves with the signed JWT.
+ * @throws {Error} If the specified library is not supported or if signing fails.
+ */
 export async function sign({
   secret,
   library,
@@ -45,6 +55,6 @@ export async function sign({
       return jwtJose;
     }
     default:
-      throw new Error(`unsupported jwt library: ${library}`);
+      throw new Error(`Unsupported JWT library: ${library}`);
   }
 }

libs/jwt-adapter/src/funcs/verify.ts

@@ -1,6 +1,16 @@
 import * as jose from 'jose';
 import * as jwt from 'jsonwebtoken';
 
+/**
+ * Verifies a JWT token using the specified library and options.
+ *
+ * @param {string} secret - The secret key used to verify the JWT.
+ * @param {'jsonwebtoken' | 'jose'} library - The library to use for verification ('jsonwebtoken' or 'jose').
+ * @param {string} token - The JWT token to verify.
+ * @param {object} options - The options to pass to the JWT verification function.
+ * @returns {Promise<object>} A promise that resolves with the decoded token payload if verification is successful.
+ * @throws {Error} If the specified library is not supported or if verification fails.
+ */
 export async function verify({
   secret,
   library,