@mattrika/server-utils 1.0.0 → 1.0.1

package/index.cjs.js

@@ -8,7 +8,6 @@ var zodOpenapi = require('@hono/zod-openapi');
 var crypto = require('crypto');
 var argon2 = require('@node-rs/argon2');
 var httpStatusCodes = require('stoker/http-status-codes');
-var esToolkit = require('es-toolkit');
 var jwt = require('hono/jwt');
 
 const DEFAULT_PAGE_SIZE = 20;
@@ -105,6 +104,9 @@ function pinoLogger() {
   return pino({
     level: process.env?.['PINO_LOG_LEVEL'] || 'info',
     timestamp: pino.stdTimeFunctions.isoTime,
+    serializers: {
+      err: pino.stdSerializers.errWithCause
+    },
     formatters: {
       bindings: bindings => ({
         pid: bindings?.['pid'],
@@ -293,7 +295,8 @@ function ApiPdfResponse(description) {
 function throwHttpError(error, defaultMessage = 'Something went wrong') {
   const code = error instanceof Error ? Number.isNaN(error.cause) ? httpStatusCodes.INTERNAL_SERVER_ERROR : error.cause : httpStatusCodes.INTERNAL_SERVER_ERROR;
   throw new httpException.HTTPException(code, {
-    message: error.message ?? defaultMessage
+    message: error.message ?? defaultMessage,
+    cause: error
   });
 }
 function isUniqueViolationPg(error) {
@@ -310,6 +313,12 @@ function toErrorCode(value) {
 function onErrorFn(debugLog = true) {
   return async (err, c) => {
     const statusCode = 'status' in err ? toErrorCode(err.status) : 'cause' in err ? toErrorCode(err.cause) : httpStatusCodes.INTERNAL_SERVER_ERROR;
+    let originalError = err;
+    const seen = new Set([err]);
+    while (originalError.cause instanceof Error && !seen.has(originalError.cause)) {
+      originalError = originalError.cause;
+      seen.add(originalError);
+    }
     const logger = c.get('logger');
     logger.error({
       err,
@@ -317,12 +326,12 @@ function onErrorFn(debugLog = true) {
       method: c.req.method
     }, 'Request failed');
     if (debugLog) {
-      console.error(JSON.stringify(err, undefined, 2));
+      console.error(err);
     }
     return c.json({
       data: null,
       error: !debugLog ? undefined : err,
-      message: err.cause ?? err.message,
+      message: originalError.message || err.message,
       success: false
     }, statusCode);
   };
@@ -338,19 +347,163 @@ const notFoundFn = c => {
 };
 
 function buildPaginationResponse(page, size, total) {
-  const numPage = esToolkit.clamp(Number(page), 1) || 1;
-  const positivePage = numPage < 1 ? 1 : numPage;
-  const numSize = esToolkit.clamp(Number(size), DEFAULT_PAGE_SIZE);
-  const numTotal = esToolkit.clamp(Number(total), 0);
-  const totalPages = Math.ceil(numTotal / numSize);
+  const numPage = Number(page);
+  const positivePage = Number.isFinite(numPage) ? Math.max(numPage, 1) : 1;
+  const numSize = Number(size);
+  const positiveSize = Number.isFinite(numSize) && numSize > 0 ? numSize : DEFAULT_PAGE_SIZE;
+  const numTotal = Number(total);
+  const positiveTotal = Number.isFinite(numTotal) ? Math.max(numTotal, 0) : 0;
+  const totalPages = Math.ceil(positiveTotal / positiveSize);
   return {
     page: positivePage,
-    size: numSize,
-    totalItems: numTotal,
+    size: positiveSize,
+    totalItems: positiveTotal,
     totalPages
   };
 }
 
+/**
+ * @module constants
+ * @summary Useful constants
+ * @description
+ * Collection of useful date constants.
+ *
+ * The constants could be imported from `date-fns/constants`:
+ *
+ * ```ts
+ * import { maxTime, minTime } from "./constants/date-fns/constants";
+ *
+ * function isAllowedTime(time) {
+ *   return time <= maxTime && time >= minTime;
+ * }
+ * ```
+ */
+
+
+/**
+ * @constant
+ * @name constructFromSymbol
+ * @summary Symbol enabling Date extensions to inherit properties from the reference date.
+ *
+ * The symbol is used to enable the `constructFrom` function to construct a date
+ * using a reference date and a value. It allows to transfer extra properties
+ * from the reference date to the new date. It's useful for extensions like
+ * [`TZDate`](https://github.com/date-fns/tz) that accept a time zone as
+ * a constructor argument.
+ */
+const constructFromSymbol = Symbol.for("constructDateFrom");
+
+/**
+ * @name constructFrom
+ * @category Generic Helpers
+ * @summary Constructs a date using the reference date and the value
+ *
+ * @description
+ * The function constructs a new date using the constructor from the reference
+ * date and the given value. It helps to build generic functions that accept
+ * date extensions.
+ *
+ * It defaults to `Date` if the passed reference date is a number or a string.
+ *
+ * Starting from v3.7.0, it allows to construct a date using `[Symbol.for("constructDateFrom")]`
+ * enabling to transfer extra properties from the reference date to the new date.
+ * It's useful for extensions like [`TZDate`](https://github.com/date-fns/tz)
+ * that accept a time zone as a constructor argument.
+ *
+ * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+ *
+ * @param date - The reference date to take constructor from
+ * @param value - The value to create the date
+ *
+ * @returns Date initialized using the given date and value
+ *
+ * @example
+ * import { constructFrom } from "./constructFrom/date-fns";
+ *
+ * // A function that clones a date preserving the original type
+ * function cloneDate<DateType extends Date>(date: DateType): DateType {
+ *   return constructFrom(
+ *     date, // Use constructor from the given date
+ *     date.getTime() // Use the date value to create a new date
+ *   );
+ * }
+ */
+function constructFrom(date, value) {
+  if (typeof date === "function") return date(value);
+
+  if (date && typeof date === "object" && constructFromSymbol in date)
+    return date[constructFromSymbol](value);
+
+  if (date instanceof Date) return new date.constructor(value);
+
+  return new Date(value);
+}
+
+/**
+ * @name toDate
+ * @category Common Helpers
+ * @summary Convert the given argument to an instance of Date.
+ *
+ * @description
+ * Convert the given argument to an instance of Date.
+ *
+ * If the argument is an instance of Date, the function returns its clone.
+ *
+ * If the argument is a number, it is treated as a timestamp.
+ *
+ * If the argument is none of the above, the function returns Invalid Date.
+ *
+ * Starting from v3.7.0, it clones a date using `[Symbol.for("constructDateFrom")]`
+ * enabling to transfer extra properties from the reference date to the new date.
+ * It's useful for extensions like [`TZDate`](https://github.com/date-fns/tz)
+ * that accept a time zone as a constructor argument.
+ *
+ * **Note**: *all* Date arguments passed to any *date-fns* function is processed by `toDate`.
+ *
+ * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+ * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
+ *
+ * @param argument - The value to convert
+ *
+ * @returns The parsed date in the local time zone
+ *
+ * @example
+ * // Clone the date:
+ * const result = toDate(new Date(2014, 1, 11, 11, 30, 30))
+ * //=> Tue Feb 11 2014 11:30:30
+ *
+ * @example
+ * // Convert the timestamp to date:
+ * const result = toDate(1392098430000)
+ * //=> Tue Feb 11 2014 11:30:30
+ */
+function toDate(argument, context) {
+  // [TODO] Get rid of `toDate` or `constructFrom`?
+  return constructFrom(argument, argument);
+}
+
+/**
+ * @name isAfter
+ * @category Common Helpers
+ * @summary Is the first date after the second one?
+ *
+ * @description
+ * Is the first date after the second one?
+ *
+ * @param date - The date that should be after the other one to return true
+ * @param dateToCompare - The date to compare with
+ *
+ * @returns The first date is after the second date
+ *
+ * @example
+ * // Is 10 July 1989 after 11 February 1987?
+ * const result = isAfter(new Date(1989, 6, 10), new Date(1987, 1, 11))
+ * //=> true
+ */
+function isAfter(date, dateToCompare) {
+  return +toDate(date) > +toDate(dateToCompare);
+}
+
 class TokenUtil {
   alg;
   secret;
@@ -385,6 +538,9 @@ class TokenUtil {
       ...rest
     };
   }
+  expiresWithin(exp, seconds) {
+    return isAfter(new Date(), new Date(exp - seconds * 1000));
+  }
 }
 
 function validationHook(result, _c) {

package/index.esm.js

@@ -6,7 +6,6 @@ import { z } from '@hono/zod-openapi';
 import crypto from 'crypto';
 import argon2 from '@node-rs/argon2';
 import { INTERNAL_SERVER_ERROR, NOT_FOUND, UNPROCESSABLE_ENTITY } from 'stoker/http-status-codes';
-import { clamp } from 'es-toolkit';
 import { sign, verify } from 'hono/jwt';
 
 const DEFAULT_PAGE_SIZE = 20;
@@ -103,6 +102,9 @@ function pinoLogger() {
   return pino({
     level: process.env?.['PINO_LOG_LEVEL'] || 'info',
     timestamp: pino.stdTimeFunctions.isoTime,
+    serializers: {
+      err: pino.stdSerializers.errWithCause
+    },
     formatters: {
       bindings: bindings => ({
         pid: bindings?.['pid'],
@@ -291,7 +293,8 @@ function ApiPdfResponse(description) {
 function throwHttpError(error, defaultMessage = 'Something went wrong') {
   const code = error instanceof Error ? Number.isNaN(error.cause) ? INTERNAL_SERVER_ERROR : error.cause : INTERNAL_SERVER_ERROR;
   throw new HTTPException(code, {
-    message: error.message ?? defaultMessage
+    message: error.message ?? defaultMessage,
+    cause: error
   });
 }
 function isUniqueViolationPg(error) {
@@ -308,6 +311,12 @@ function toErrorCode(value) {
 function onErrorFn(debugLog = true) {
   return async (err, c) => {
     const statusCode = 'status' in err ? toErrorCode(err.status) : 'cause' in err ? toErrorCode(err.cause) : INTERNAL_SERVER_ERROR;
+    let originalError = err;
+    const seen = new Set([err]);
+    while (originalError.cause instanceof Error && !seen.has(originalError.cause)) {
+      originalError = originalError.cause;
+      seen.add(originalError);
+    }
     const logger = c.get('logger');
     logger.error({
       err,
@@ -315,12 +324,12 @@ function onErrorFn(debugLog = true) {
       method: c.req.method
     }, 'Request failed');
     if (debugLog) {
-      console.error(JSON.stringify(err, undefined, 2));
+      console.error(err);
     }
     return c.json({
       data: null,
       error: !debugLog ? undefined : err,
-      message: err.cause ?? err.message,
+      message: originalError.message || err.message,
       success: false
     }, statusCode);
   };
@@ -336,19 +345,163 @@ const notFoundFn = c => {
 };
 
 function buildPaginationResponse(page, size, total) {
-  const numPage = clamp(Number(page), 1) || 1;
-  const positivePage = numPage < 1 ? 1 : numPage;
-  const numSize = clamp(Number(size), DEFAULT_PAGE_SIZE);
-  const numTotal = clamp(Number(total), 0);
-  const totalPages = Math.ceil(numTotal / numSize);
+  const numPage = Number(page);
+  const positivePage = Number.isFinite(numPage) ? Math.max(numPage, 1) : 1;
+  const numSize = Number(size);
+  const positiveSize = Number.isFinite(numSize) && numSize > 0 ? numSize : DEFAULT_PAGE_SIZE;
+  const numTotal = Number(total);
+  const positiveTotal = Number.isFinite(numTotal) ? Math.max(numTotal, 0) : 0;
+  const totalPages = Math.ceil(positiveTotal / positiveSize);
   return {
     page: positivePage,
-    size: numSize,
-    totalItems: numTotal,
+    size: positiveSize,
+    totalItems: positiveTotal,
     totalPages
   };
 }
 
+/**
+ * @module constants
+ * @summary Useful constants
+ * @description
+ * Collection of useful date constants.
+ *
+ * The constants could be imported from `date-fns/constants`:
+ *
+ * ```ts
+ * import { maxTime, minTime } from "./constants/date-fns/constants";
+ *
+ * function isAllowedTime(time) {
+ *   return time <= maxTime && time >= minTime;
+ * }
+ * ```
+ */
+
+
+/**
+ * @constant
+ * @name constructFromSymbol
+ * @summary Symbol enabling Date extensions to inherit properties from the reference date.
+ *
+ * The symbol is used to enable the `constructFrom` function to construct a date
+ * using a reference date and a value. It allows to transfer extra properties
+ * from the reference date to the new date. It's useful for extensions like
+ * [`TZDate`](https://github.com/date-fns/tz) that accept a time zone as
+ * a constructor argument.
+ */
+const constructFromSymbol = Symbol.for("constructDateFrom");
+
+/**
+ * @name constructFrom
+ * @category Generic Helpers
+ * @summary Constructs a date using the reference date and the value
+ *
+ * @description
+ * The function constructs a new date using the constructor from the reference
+ * date and the given value. It helps to build generic functions that accept
+ * date extensions.
+ *
+ * It defaults to `Date` if the passed reference date is a number or a string.
+ *
+ * Starting from v3.7.0, it allows to construct a date using `[Symbol.for("constructDateFrom")]`
+ * enabling to transfer extra properties from the reference date to the new date.
+ * It's useful for extensions like [`TZDate`](https://github.com/date-fns/tz)
+ * that accept a time zone as a constructor argument.
+ *
+ * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+ *
+ * @param date - The reference date to take constructor from
+ * @param value - The value to create the date
+ *
+ * @returns Date initialized using the given date and value
+ *
+ * @example
+ * import { constructFrom } from "./constructFrom/date-fns";
+ *
+ * // A function that clones a date preserving the original type
+ * function cloneDate<DateType extends Date>(date: DateType): DateType {
+ *   return constructFrom(
+ *     date, // Use constructor from the given date
+ *     date.getTime() // Use the date value to create a new date
+ *   );
+ * }
+ */
+function constructFrom(date, value) {
+  if (typeof date === "function") return date(value);
+
+  if (date && typeof date === "object" && constructFromSymbol in date)
+    return date[constructFromSymbol](value);
+
+  if (date instanceof Date) return new date.constructor(value);
+
+  return new Date(value);
+}
+
+/**
+ * @name toDate
+ * @category Common Helpers
+ * @summary Convert the given argument to an instance of Date.
+ *
+ * @description
+ * Convert the given argument to an instance of Date.
+ *
+ * If the argument is an instance of Date, the function returns its clone.
+ *
+ * If the argument is a number, it is treated as a timestamp.
+ *
+ * If the argument is none of the above, the function returns Invalid Date.
+ *
+ * Starting from v3.7.0, it clones a date using `[Symbol.for("constructDateFrom")]`
+ * enabling to transfer extra properties from the reference date to the new date.
+ * It's useful for extensions like [`TZDate`](https://github.com/date-fns/tz)
+ * that accept a time zone as a constructor argument.
+ *
+ * **Note**: *all* Date arguments passed to any *date-fns* function is processed by `toDate`.
+ *
+ * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+ * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
+ *
+ * @param argument - The value to convert
+ *
+ * @returns The parsed date in the local time zone
+ *
+ * @example
+ * // Clone the date:
+ * const result = toDate(new Date(2014, 1, 11, 11, 30, 30))
+ * //=> Tue Feb 11 2014 11:30:30
+ *
+ * @example
+ * // Convert the timestamp to date:
+ * const result = toDate(1392098430000)
+ * //=> Tue Feb 11 2014 11:30:30
+ */
+function toDate(argument, context) {
+  // [TODO] Get rid of `toDate` or `constructFrom`?
+  return constructFrom(argument, argument);
+}
+
+/**
+ * @name isAfter
+ * @category Common Helpers
+ * @summary Is the first date after the second one?
+ *
+ * @description
+ * Is the first date after the second one?
+ *
+ * @param date - The date that should be after the other one to return true
+ * @param dateToCompare - The date to compare with
+ *
+ * @returns The first date is after the second date
+ *
+ * @example
+ * // Is 10 July 1989 after 11 February 1987?
+ * const result = isAfter(new Date(1989, 6, 10), new Date(1987, 1, 11))
+ * //=> true
+ */
+function isAfter(date, dateToCompare) {
+  return +toDate(date) > +toDate(dateToCompare);
+}
+
 class TokenUtil {
   alg;
   secret;
@@ -383,6 +536,9 @@ class TokenUtil {
       ...rest
     };
   }
+  expiresWithin(exp, seconds) {
+    return isAfter(new Date(), new Date(exp - seconds * 1000));
+  }
 }
 
 function validationHook(result, _c) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mattrika/server-utils",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "license": "MIT",
   "repository": {
     "type": "git",

package/src/lib/utils/token.util.d.ts

@@ -7,4 +7,5 @@ export declare class TokenUtil {
     create<T extends JWTPayload>(payload: T, lifeSeconds?: number): Promise<string>;
     decode<T extends JWTPayload>(token: string): Promise<T | null>;
     decodeUnexpired<T extends JWTPayload>(token: string): Promise<T | null>;
+    expiresWithin(exp: number, seconds: number): boolean;
 }