@carecard/jwt-read 2.0.1 → 3.0.2

package/dist/esm/jwtLib.js

@@ -1,325 +0,0 @@
-import * as validate from '@carecard/validate';
-import * as jwtUtilAuth from '@carecard/auth-util';
-import { throwLoginRequiredError, throwNotAuthorizedError } from '@carecard/common-util';
-export function jwtClientId(req) {
-    return req?.jwt?.payload?.client_id;
-}
-export function visitorClientId(req) {
-    return req?.visitor?.payload?.client_id;
-}
-export function doesJwtUserHasRole(req, userRole) {
-    if (userRole && typeof userRole === 'string') {
-        return req?.jwt?.payload?.roles?.includes(userRole);
-    }
-    else {
-        throwNotAuthorizedError();
-    }
-}
-export function throwError(customErrorFunction) {
-    typeof customErrorFunction === 'function' ? customErrorFunction() : throwLoginRequiredError();
-}
-export function isJwtExpired(req, jwtValiditySeconds) {
-    if (jwtValiditySeconds && typeof jwtValiditySeconds === 'number') {
-        return Math.abs(Math.round(jwtValiditySeconds)) * 1000 < jwtAgeInMilliseconds(req);
-    }
-    else {
-        return true;
-    }
-}
-export function jwtAgeInMilliseconds(req) {
-    // Ensure req.jwt exists (create it if undefined)
-    req.jwt ?? (req.jwt = {
-        header: { alg: 'sha512', typ: 'JWT' }, // or a minimal placeholder
-        payload: { iat: 0, client_id: '', roles: [], email_not_confirmed: false },
-        age: Infinity,
-    });
-    const iat = req.jwt.payload?.iat;
-    const age = typeof iat === 'number' && iat > 0 ? Date.now() - iat : Infinity;
-    req.jwt.age = age;
-    return age;
-}
-export async function validateAndExtractJwtObject(req, publicKey, customErrorFunction) {
-    const jwtString = await _validateJwt(req, customErrorFunction);
-    const isJwtSignatureValid = await _isJwtSignatureValid(jwtString, publicKey, customErrorFunction);
-    if (jwtString && isJwtSignatureValid) {
-        await _extractJwtObject(req, jwtString, customErrorFunction);
-    }
-    else {
-        req['jwt'] = null;
-        throwError(customErrorFunction);
-    }
-    return req;
-}
-export async function validateAndExtractWebToken(req, publicKey, headerName, customErrorFunction) {
-    const webTokenString = await _validateWebToken(req, headerName, customErrorFunction);
-    const isJwtSignatureValid = await _isJwtSignatureValid(webTokenString, publicKey, customErrorFunction);
-    if (webTokenString && isJwtSignatureValid) {
-        await _extractJwtObject(req, webTokenString, customErrorFunction);
-    }
-    else {
-        req['jwt'] = null;
-        throwError(customErrorFunction);
-    }
-    return req;
-}
-export async function validateAndExtractJwtObjectNoThrow(req, publicKey) {
-    try {
-        const jwtString = await _validateJwtNoThrow(req);
-        const isJwtSignatureValid = await _isJwtSignatureValidNoThrow(jwtString, publicKey);
-        if (jwtString && isJwtSignatureValid) {
-            await _extractJwtObjectNoThrow(req, jwtString);
-        }
-        else {
-            req['jwt'] = null;
-        }
-    }
-    catch (err) {
-        req['jwt'] = null;
-    }
-    return req;
-}
-export async function validateAndExtractWebTokenObjectNoThrow(req, publicKey, headerName) {
-    try {
-        const jwtString = _validateWebTokenNoThrow(req, headerName);
-        const isJwtSignatureValid = await _isJwtSignatureValidNoThrow(jwtString, publicKey);
-        if (jwtString && isJwtSignatureValid) {
-            await _extractJwtObjectNoThrow(req, jwtString);
-        }
-        else {
-            req['jwt'] = null;
-        }
-    }
-    catch (err) {
-        req['jwt'] = null;
-    }
-    return req;
-}
-export async function validateAndExtractVisitorObjectNoThrow(req, publicKey) {
-    try {
-        const jwtString = await _validateVisitorNoThrow(req);
-        const isJwtSignatureValid = await _isJwtSignatureValidNoThrow(jwtString, publicKey);
-        if (jwtString && isJwtSignatureValid) {
-            await _extractVisitorObjectNoThrow(req, jwtString);
-        }
-        else {
-            req['visitor'] = null;
-        }
-    }
-    catch (err) {
-        req['visitor'] = null;
-    }
-    return req;
-}
-export function verifyJwtAndRole(role, publicKey, customErrorFunction) {
-    return async function (req, res, next) {
-        await validateAndExtractJwtObject(req, publicKey, customErrorFunction)
-            .then(req => doesJwtUserHasRole(req, role))
-            .then(isRoleExist => _isLoginRequired(isRoleExist, customErrorFunction))
-            .then(next)
-            .catch(next);
-    };
-}
-export function verifyJwt(publicKey, customErrorFunction) {
-    return async function (req, res, next) {
-        await validateAndExtractJwtObject(req, publicKey, customErrorFunction)
-            .then(() => process.nextTick(next))
-            .catch(next);
-    };
-}
-export function verifyWebToken(publicKey, headerName, customErrorFunction) {
-    return async function (req, res, next) {
-        await validateAndExtractWebToken(req, publicKey, headerName, customErrorFunction)
-            .then(() => process.nextTick(next))
-            .catch(next);
-    };
-}
-export function verifyJwtNoThrow(publicKey) {
-    return async function (req, res, next) {
-        await validateAndExtractJwtObjectNoThrow(req, publicKey)
-            .then(() => process.nextTick(next))
-            .catch(next);
-    };
-}
-export function verifyWebTokenNoThrow(publicKey, headerName) {
-    return async function (req, res, next) {
-        await validateAndExtractWebTokenObjectNoThrow(req, publicKey, headerName)
-            .then(() => process.nextTick(next))
-            .catch(next);
-    };
-}
-export function verifyVisitorNoThrow(publicKey) {
-    return async function (req, res, next) {
-        await validateAndExtractVisitorObjectNoThrow(req, publicKey)
-            .then(() => process.nextTick(next))
-            .catch(next);
-    };
-}
-export function throwUsedTokenError() {
-    throw new Error('Used_Token');
-}
-/*********************
- * Private functions *
- *********************/
-export function _isLoginRequired(hasRequiredRole, customErrorFunction) {
-    if (!hasRequiredRole) {
-        throwError(customErrorFunction);
-    }
-}
-export async function _extractJwtObject(req, jwt, customErrorFunction) {
-    if (jwt && typeof jwt === 'string') {
-        req['jwt'] = jwtUtilAuth.getHeaderPayloadFromJwt(jwt);
-    }
-    else {
-        throwError(customErrorFunction);
-    }
-}
-export async function _extractJwtObjectNoThrow(req, jwt) {
-    if (jwt && typeof jwt === 'string') {
-        req['jwt'] = jwtUtilAuth.getHeaderPayloadFromJwt(jwt);
-    }
-    else {
-        req['jwt'] = null;
-    }
-}
-export async function _extractVisitorObjectNoThrow(req, jwt) {
-    if (jwt && typeof jwt === 'string') {
-        req['visitor'] = jwtUtilAuth.getHeaderPayloadFromJwt(jwt);
-    }
-    else {
-        req['visitor'] = null;
-    }
-}
-export async function _isJwtSignatureValid(jwt, publicKey, customErrorFunction) {
-    if (jwt && typeof jwt === 'string') {
-        return jwtUtilAuth.verifyJwtSignature(jwt, publicKey);
-    }
-    else {
-        throwError(customErrorFunction);
-    }
-}
-export async function _isJwtSignatureValidNoThrow(jwt, publicKey) {
-    if (jwt && typeof jwt === 'string') {
-        return jwtUtilAuth.verifyJwtSignature(jwt, publicKey);
-    }
-    else {
-        return false;
-    }
-}
-export async function _validateJwt(req, customErrorFunction) {
-    // Get from http header.
-    let jwtRaw = req.get('Authorization');
-    // Extract jwt from bearer schema.
-    let jwt = _extractJwt(jwtRaw, customErrorFunction);
-    // Validate characters string of jwt.
-    if (validate.isJwtString(jwt || '')) {
-        return jwt;
-    }
-    else {
-        throwError(customErrorFunction);
-    }
-}
-export async function _validateWebToken(req, headerName, customErrorFunction) {
-    // Get from http header.
-    let jwtRaw = req.get(headerName);
-    // Extract jwt from bearer schema.
-    let webToken = _extractWebToken(jwtRaw, customErrorFunction);
-    // Validate characters string of jwt.
-    if (validate.isJwtString(webToken || '')) {
-        return webToken;
-    }
-    else {
-        throwError(customErrorFunction);
-    }
-}
-export function _validateJwtNoThrow(req) {
-    // Get from http header.
-    let jwtRaw = req.get('Authorization');
-    if (!jwtRaw) {
-        return null;
-    }
-    // Extract jwt from bearer schema.
-    let jwt = _extractJwtNoThrow(jwtRaw);
-    // Validate characters string of jwt.
-    if (validate.isJwtString(jwt || '')) {
-        return jwt;
-    }
-    return null;
-}
-export function _validateWebTokenNoThrow(req, headerName) {
-    // Get from http header.
-    let jwtRaw = req.get(headerName);
-    if (!jwtRaw) {
-        return null;
-    }
-    // Extract jwt from bearer schema.
-    let webToken = _extractWebTokenNoThrow(jwtRaw);
-    // Validate characters string of jwt.
-    if (validate.isJwtString(webToken || '')) {
-        return webToken;
-    }
-    return null;
-}
-export function _validateVisitorNoThrow(req) {
-    // Get from http header.
-    let jwtRaw = req.get('Visitor');
-    if (!jwtRaw) {
-        return null;
-    }
-    // Extract jwt from bearer schema.
-    let jwt = _extractJwtNoThrow(jwtRaw);
-    // Validate characters string of jwt.
-    if (validate.isJwtString(jwt || '')) {
-        return jwt;
-    }
-    return null;
-}
-export function _extractJwt(jwtRaw, customErrorFunction) {
-    let jwtSplit = null;
-    if (jwtRaw && typeof jwtRaw === 'string') {
-        jwtSplit = jwtRaw.split(' ');
-    }
-    else {
-        throwError(customErrorFunction);
-        return null;
-    }
-    // Guard before indexing
-    if (!jwtSplit || jwtSplit.length < 2) {
-        throwError(customErrorFunction);
-        return null;
-    }
-    if (jwtSplit[0].toLowerCase() === 'bearer') {
-        return jwtSplit[1] ?? null;
-    }
-    else {
-        throwError(customErrorFunction);
-        return null;
-    }
-}
-export function _extractWebToken(jwtRaw, customErrorFunction) {
-    if (jwtRaw && typeof jwtRaw === 'string') {
-        return jwtRaw;
-    }
-    else {
-        throwError(customErrorFunction);
-    }
-    return null;
-}
-export function _extractJwtNoThrow(jwtRaw) {
-    let jwtSplit = null;
-    if (jwtRaw && typeof jwtRaw === 'string') {
-        jwtSplit = jwtRaw.split(' ');
-    }
-    else {
-        return null;
-    }
-    if (jwtSplit[0]?.toLowerCase() === 'bearer') {
-        return jwtSplit[1];
-    }
-    return null;
-}
-export function _extractWebTokenNoThrow(jwtRaw) {
-    if (jwtRaw && typeof jwtRaw === 'string') {
-        return jwtRaw;
-    }
-    return null;
-}

package/dist/esm/jwtRoles.d.ts

@@ -1,2 +0,0 @@
-export declare function getNameOfRoleFromCode(roleCode: string): string;
-export declare function getCodeFromNameOfRole(roleName: string): string;

package/dist/esm/jwtRoles.js

@@ -1,15 +0,0 @@
-const codesToCategory = {
-    ad: 'admin',
-    su: 'super_admin',
-};
-export function getNameOfRoleFromCode(roleCode) {
-    // Cast only at index, use nullish coalescing for fallback
-    return codesToCategory[roleCode] ?? '';
-}
-const namesToCode = {
-    admin: 'ad',
-    super_admin: 'su',
-};
-export function getCodeFromNameOfRole(roleName) {
-    return namesToCode[roleName] ?? '';
-}

package/dist/esm/types.d.ts

@@ -1,25 +0,0 @@
-import type { Request } from 'express';
-export interface JwtHeader {
-    alg: string;
-    typ: string;
-}
-export type Role = string;
-export type Roles = Role[];
-export interface JwtPayload {
-    /** Issued-at timestamp */
-    iat: number;
-    /** Client identifier (UUID as string) */
-    client_id: string;
-    roles: Roles;
-    email_not_confirmed: boolean;
-}
-export interface JWToken {
-    header: JwtHeader;
-    payload: JwtPayload;
-    /** Age in milliseconds (number) */
-    age: number;
-}
-export interface RequestWithJWToken extends Request {
-    jwt?: JWToken | null | undefined;
-    visitor?: JWToken | null | undefined;
-}

package/dist/esm/types.js

@@ -1 +0,0 @@
-export {};