@hkdigital/lib-core 0.4.13 → 0.4.14

package/dist/auth/jwt/util.d.ts

@@ -1,3 +1,41 @@
+/**
+ * Create a JSON Web Token (JWT)
+ * - Stringifies the claims as JSON object
+ * - Encodes the options
+ * - Calculates a Message Authentication Code (MAC)
+ *   (by default a Hash Based Authentication Code (HMAC) will be used: HS512)
+ * - Combines the parts into a JWT string
+ *
+ * @param {import('./typedef.js').JwtPayload} claims - JWT payload/claims
+ * @param {import('./typedef.js').Secret} secretOrPrivateKey
+ *   Secret or private key that is used by the MAC calculation algorithm
+ *
+ *   - To generate a secret for a Hash based Authentication Code (HMAC):
+ *     use a function like `generateSecretKeyForHmacBase58()`.
+ *
+ *   - For algorithms that use asymmetric keys, the secret is the private key
+ *     of the key pair.
+ *
+ * @param {import('./typedef.js').SignOptions} [options] - JWT signing options
+ *
+ * For more options:
+ * @see https://github.com/auth0/node-jsonwebtoken
+ *
+ * @returns {string} JsonWebToken
+ */
+export function sign(claims: import("./typedef.js").JwtPayload, secretOrPrivateKey: import("./typedef.js").Secret, options?: import("./typedef.js").SignOptions): string;
+/**
+ * Decode and verify a JWT token
+ * - Forces the use of the algorithm specified in VERIFY_OPTIONS
+ *
+ * @param {string} token - A JWT token
+ * @param {import('./typedef.js').Secret} secretOrPrivateKey
+ *   The secret of private key to be used for decoding
+ * @param {import('./typedef.js').VerifyOptions} [options=VERIFY_OPTIONS] - verify / decode options
+ *
+ * @returns {import('./typedef.js').JwtPayload} claims - The decoded JWT payload
+ */
+export function verify(token: string, secretOrPrivateKey: import("./typedef.js").Secret, options?: import("./typedef.js").VerifyOptions): import("./typedef.js").JwtPayload;
 /**
  * Casts jsonwebtoken library errors to internal error types
  * @param {Error} error - The original jsonwebtoken error

package/dist/auth/jwt/util.js

@@ -2,14 +2,26 @@
  * JWT utility functions
  *
  * @description
- * This module provides utility functions for JWT operations including error casting.
+ * This module provides utility functions for JWT operations including 
+ * sign, verify and error casting.
  */
 
-import jwt, { 
+import jwt from 'jsonwebtoken';
+
+import {
   TokenExpiredError as JwtTokenExpiredError,
   JsonWebTokenError as JwtJsonWebTokenError,
   NotBeforeError as JwtNotBeforeError
 } from 'jsonwebtoken';
+
+import * as expect from '../../util/expect.js';
+
+import {
+  JWT_DEFAULT_EXPIRES_IN,
+  DEFAULT_ALGORITHM,
+  VERIFY_OPTIONS 
+} from './constants.js';
+
 import {
   TokenExpiredError,
   JsonWebTokenError,
@@ -17,6 +29,101 @@ import {
   NotBeforeError
 } from './errors.js';
 
+/**
+ * Create a JSON Web Token (JWT)
+ * - Stringifies the claims as JSON object
+ * - Encodes the options
+ * - Calculates a Message Authentication Code (MAC)
+ *   (by default a Hash Based Authentication Code (HMAC) will be used: HS512)
+ * - Combines the parts into a JWT string
+ *
+ * @param {import('./typedef.js').JwtPayload} claims - JWT payload/claims
+ * @param {import('./typedef.js').Secret} secretOrPrivateKey
+ *   Secret or private key that is used by the MAC calculation algorithm
+ *
+ *   - To generate a secret for a Hash based Authentication Code (HMAC):
+ *     use a function like `generateSecretKeyForHmacBase58()`.
+ *
+ *   - For algorithms that use asymmetric keys, the secret is the private key
+ *     of the key pair.
+ *
+ * @param {import('./typedef.js').SignOptions} [options] - JWT signing options
+ *
+ * For more options:
+ * @see https://github.com/auth0/node-jsonwebtoken
+ *
+ * @returns {string} JsonWebToken
+ */
+export function sign(
+  claims,
+  secretOrPrivateKey,
+  options={} )
+{
+  expect.object( claims );
+  expect.defined( secretOrPrivateKey );
+
+  if( options )
+  {
+    expect.object( options );
+  }
+  else {
+    options = {};
+  }
+
+  if( !('algorithm' in options) )
+  {
+    options.algorithm = DEFAULT_ALGORITHM;
+  }
+
+  if( !('expiresIn' in options) )
+  {
+    options.expiresIn = JWT_DEFAULT_EXPIRES_IN;
+  }
+  else if( !options.expiresIn )
+  {
+    delete options.expiresIn;
+  }
+
+  // @ts-ignore
+  return jwt.sign( claims, secretOrPrivateKey, options );
+}
+
+/**
+ * Decode and verify a JWT token
+ * - Forces the use of the algorithm specified in VERIFY_OPTIONS
+ *
+ * @param {string} token - A JWT token
+ * @param {import('./typedef.js').Secret} secretOrPrivateKey
+ *   The secret of private key to be used for decoding
+ * @param {import('./typedef.js').VerifyOptions} [options=VERIFY_OPTIONS] - verify / decode options
+ *
+ * @returns {import('./typedef.js').JwtPayload} claims - The decoded JWT payload
+ */
+export function verify( token, secretOrPrivateKey, options=VERIFY_OPTIONS )
+{
+  expect.notEmptyString( token );
+  expect.defined( secretOrPrivateKey );
+
+  if( !('algorithms' in options) )
+  {
+    options.algorithms = VERIFY_OPTIONS.algorithms;
+  }
+
+  try {
+    // @ts-ignore
+    const decoded = jwt.verify( token, secretOrPrivateKey, options );
+
+    return decoded;
+  }
+  catch( e )
+  {
+    //
+    // Cast internal jsonwebtoken errors to Error types defined in this lib
+    //
+    throw castJwtError(e);
+  }
+}
+
 /**
  * Casts jsonwebtoken library errors to internal error types
  * @param {Error} error - The original jsonwebtoken error
@@ -40,4 +147,4 @@ export function castJwtError(error) {
   
   // Return original error if not a known JWT error
   return error;
-}
+}

package/dist/auth/jwt.d.ts

@@ -1,4 +1,3 @@
-export * from "./jwt/core.js";
 export * from "./jwt/generators.js";
 export * from "./jwt/errors.js";
 export * from "./jwt/constants.js";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@hkdigital/lib-core",
-	"version": "0.4.13",
+	"version": "0.4.14",
 	"author": {
 		"name": "HKdigital",
 		"url": "https://hkdigital.nl"

package/dist/auth/jwt/core.d.ts

@@ -1,38 +0,0 @@
-/**
- * Create a JSON Web Token (JWT)
- * - Stringifies the claims as JSON object
- * - Encodes the options
- * - Calculates a Message Authentication Code (MAC)
- *   (by default a Hash Based Authentication Code (HMAC) will be used: HS512)
- * - Combines the parts into a JWT string
- *
- * @param {import('./typedef.js').JwtPayload} claims - JWT payload/claims
- * @param {import('./typedef.js').Secret} secretOrPrivateKey
- *   Secret or private key that is used by the MAC calculation algorithm
- *
- *   - To generate a secret for a Hash based Authentication Code (HMAC):
- *     use a function like `generateSecretKeyForHmacBase58()`.
- *
- *   - For algorithms that use asymmetric keys, the secret is the private key
- *     of the key pair.
- *
- * @param {import('./typedef.js').SignOptions} [options] - JWT signing options
- *
- * For more options:
- * @see https://github.com/auth0/node-jsonwebtoken
- *
- * @returns {string} JsonWebToken
- */
-export function sign(claims: import("./typedef.js").JwtPayload, secretOrPrivateKey: import("./typedef.js").Secret, options?: import("./typedef.js").SignOptions): string;
-/**
- * Decode and verify a JWT token
- * - Forces the use of the algorithm specified in VERIFY_OPTIONS
- *
- * @param {string} token - A JWT token
- * @param {import('./typedef.js').Secret} secretOrPrivateKey
- *   The secret of private key to be used for decoding
- * @param {import('./typedef.js').VerifyOptions} [options=VERIFY_OPTIONS] - verify / decode options
- *
- * @returns {import('./typedef.js').JwtPayload} claims - The decoded JWT payload
- */
-export function verify(token: string, secretOrPrivateKey: import("./typedef.js").Secret, options?: import("./typedef.js").VerifyOptions): import("./typedef.js").JwtPayload;

package/dist/auth/jwt/core.js

@@ -1,114 +0,0 @@
-/**
- * Core JWT operations - sign and verify functions
- *
- * @description
- * This module provides the main JWT functionality for signing and verifying tokens.
- * It wraps the jsonwebtoken library with consistent error handling and validation.
- */
-
-import jwt from 'jsonwebtoken';
-
-import * as expect from '../../util/expect.js';
-
-import { 
-  JWT_DEFAULT_EXPIRES_IN,
-  DEFAULT_ALGORITHM,
-  VERIFY_OPTIONS 
-} from './constants.js';
-
-import { castJwtError } from './util.js';
-
-/**
- * Create a JSON Web Token (JWT)
- * - Stringifies the claims as JSON object
- * - Encodes the options
- * - Calculates a Message Authentication Code (MAC)
- *   (by default a Hash Based Authentication Code (HMAC) will be used: HS512)
- * - Combines the parts into a JWT string
- *
- * @param {import('./typedef.js').JwtPayload} claims - JWT payload/claims
- * @param {import('./typedef.js').Secret} secretOrPrivateKey
- *   Secret or private key that is used by the MAC calculation algorithm
- *
- *   - To generate a secret for a Hash based Authentication Code (HMAC):
- *     use a function like `generateSecretKeyForHmacBase58()`.
- *
- *   - For algorithms that use asymmetric keys, the secret is the private key
- *     of the key pair.
- *
- * @param {import('./typedef.js').SignOptions} [options] - JWT signing options
- *
- * For more options:
- * @see https://github.com/auth0/node-jsonwebtoken
- *
- * @returns {string} JsonWebToken
- */
-export function sign(
-  claims,
-  secretOrPrivateKey,
-  options={} )
-{
-  expect.object( claims );
-  expect.defined( secretOrPrivateKey );
-
-  if( options )
-  {
-    expect.object( options );
-  }
-  else {
-    options = {};
-  }
-
-  if( !('algorithm' in options) )
-  {
-    options.algorithm = DEFAULT_ALGORITHM;
-  }
-
-  if( !('expiresIn' in options) )
-  {
-    options.expiresIn = JWT_DEFAULT_EXPIRES_IN;
-  }
-  else if( !options.expiresIn )
-  {
-    delete options.expiresIn;
-  }
-
-  // @ts-ignore
-  return jwt.sign( claims, secretOrPrivateKey, options );
-}
-
-/**
- * Decode and verify a JWT token
- * - Forces the use of the algorithm specified in VERIFY_OPTIONS
- *
- * @param {string} token - A JWT token
- * @param {import('./typedef.js').Secret} secretOrPrivateKey
- *   The secret of private key to be used for decoding
- * @param {import('./typedef.js').VerifyOptions} [options=VERIFY_OPTIONS] - verify / decode options
- *
- * @returns {import('./typedef.js').JwtPayload} claims - The decoded JWT payload
- */
-export function verify( token, secretOrPrivateKey, options=VERIFY_OPTIONS )
-{
-  expect.notEmptyString( token );
-  expect.defined( secretOrPrivateKey );
-
-  if( !('algorithms' in options) )
-  {
-    options.algorithms = VERIFY_OPTIONS.algorithms;
-  }
-
-  try {
-    // @ts-ignore
-    const decoded = jwt.verify( token, secretOrPrivateKey, options );
-
-    return decoded;
-  }
-  catch( e )
-  {
-    //
-    // Cast internal jsonwebtoken errors to Error types defined in this lib
-    //
-    throw castJwtError(e);
-  }
-}