@naturalcycles/backend-lib 4.17.0 → 4.17.2

package/dist/admin/adminMiddleware.js

@@ -27,7 +27,7 @@ function requireAdminPermissions(adminService, reqPermissions = [], cfg = {}) {
             return next();
         }
         catch (err) {
-            if (err instanceof js_lib_1.HttpError && err.data.adminAuthRequired) {
+            if (err instanceof js_lib_1.AppError && err.data.adminAuthRequired) {
                 // Redirect to login.html
                 const href = `${loginHtmlPath}?${autoLogin ? 'autoLogin=1&' : ''}returnUrl=\${encodeURIComponent(location.href)}${apiHost ? '&apiHost=' + apiHost : ''}`;
                 res.status(401).send(getLoginHtmlRedirect(href));

package/dist/admin/base.admin.service.js

@@ -116,9 +116,9 @@ class BaseAdminService {
         const adminToken = await this.getAdminToken(req);
         const email = await this.getEmailByToken(req, adminToken);
         if (!email) {
-            throw new js_lib_1.HttpError('adminToken required', {
+            throw new js_lib_1.AppError('adminToken required', {
                 adminAuthRequired: true,
-                httpStatusCode: 401,
+                backendResponseStatusCode: 401,
                 userFriendly: true,
             });
         }
@@ -142,10 +142,10 @@ class BaseAdminService {
             }
         }
         if (!granted) {
-            throw new js_lib_1.HttpError(`Admin permissions required: [${reqPermissions.join(', ')}]`, {
+            throw new js_lib_1.AppError(`Admin permissions required: [${reqPermissions.join(', ')}]`, {
                 adminPermissionsRequired: reqPermissions,
                 email,
-                httpStatusCode: 403,
+                backendResponseStatusCode: 403,
                 userFriendly: true,
             });
         }
@@ -175,7 +175,7 @@ class BaseAdminService {
             const token = req.header('authentication');
             (0, js_lib_1._assert)(token, `401 Unauthenticated`, {
                 userFriendly: true,
-                httpStatusCode: 401,
+                backendResponseStatusCode: 401,
             });
             let maxAge = 1000 * 60 * 60 * 24 * 30; // 30 days
             // Special case

package/dist/admin/secureHeaderMiddleware.js

@@ -23,8 +23,8 @@ function requireSecureHeaderOrAdmin(cfg, reqPermissions) {
         if (providedHeader) {
             if (!secureHeaderValue || providedHeader === secureHeaderValue)
                 return next();
-            return next(new js_lib_1.HttpError('secureHeader or adminToken is required', {
-                httpStatusCode: 401,
+            return next(new js_lib_1.AppError('secureHeader or adminToken is required', {
+                backendResponseStatusCode: 401,
                 adminAuthRequired: true,
             }));
         }

package/dist/deploy/deployHealthCheck.js

@@ -84,7 +84,7 @@ async function deployHealthCheck(url, opt = {}) {
         attempt++;
         console.log([`>>`, (0, colors_1.dimGrey)(url), (0, node_util_1.inspect)({ attempt }, inspectOpt)].join(' '));
         const started = Date.now();
-        const { err, fetchResponse } = await fetcher.rawFetch(url, {
+        const { err, fetchResponse } = await fetcher.doFetch(url, {
             mode: 'json',
             timeoutSeconds: timeoutSec,
             retry: {

package/dist/server/bodyParserTimeoutMiddleware.d.ts

@@ -7,7 +7,7 @@ export interface BodyParserTimeoutMiddlewareCfg {
     /**
      * @default 400
      */
-    httpStatusCode?: number;
+    backendResponseStatusCode?: number;
     /**
      * @default 'Timeout reading request input'
      */

package/dist/server/bodyParserTimeoutMiddleware.js

@@ -8,9 +8,9 @@ const code = 'BODY_PARSER_TIMEOUT';
  * Should be called BEFORE bodyParser
  */
 function bodyParserTimeoutMiddleware(cfg = {}) {
-    const { timeoutSeconds, httpStatusCode, httpStatus } = {
+    const { timeoutSeconds, backendResponseStatusCode, httpStatus } = {
         timeoutSeconds: 10,
-        httpStatusCode: 400,
+        backendResponseStatusCode: 400,
         httpStatus: 'Timeout reading request input',
         ...cfg,
     };
@@ -21,9 +21,9 @@ function bodyParserTimeoutMiddleware(cfg = {}) {
         if (req.bodyParserTimeout)
             clearTimeout(req.bodyParserTimeout);
         req.bodyParserTimeout = setTimeout(() => {
-            (0, index_1.respondWithError)(req, res, new js_lib_1.HttpError(httpStatus, {
+            (0, index_1.respondWithError)(req, res, new js_lib_1.AppError(httpStatus, {
                 code,
-                httpStatusCode,
+                backendResponseStatusCode,
                 // userFriendly: true, // no, cause this error is not expected
             }));
         }, timeout);

package/dist/server/genericErrorMiddleware.d.ts

@@ -1,4 +1,4 @@
-import { ErrorObject, HttpErrorData } from '@naturalcycles/js-lib';
+import { ErrorObject } from '@naturalcycles/js-lib';
 import { SentrySharedService } from '../sentry/sentry.shared.service';
 import { BackendErrorRequestHandler, BackendRequest, BackendResponse } from './server.model';
 export interface GenericErrorMiddlewareCfg {
@@ -12,7 +12,7 @@ export interface GenericErrorMiddlewareCfg {
      * Generic hook that can be used to **mutate** errors before they are returned to client.
      * This function does not affect data sent to sentry.
      */
-    formatError?: (err: ErrorObject<HttpErrorData>) => void;
+    formatError?: (err: ErrorObject) => void;
 }
 /**
  * Generic error handler.

package/dist/server/genericErrorMiddleware.js

@@ -52,12 +52,12 @@ function respondWithError(req, res, err) {
     if (!includeErrorStack)
         delete httpError.stack;
     httpError.data.errorId = errorId;
-    httpError.data.httpStatusCode ||= 500; // default to 500
+    httpError.data.backendResponseStatusCode ||= 500; // default to 500
     httpError.data.headersSent = headersSent || undefined;
     httpError.data.report ||= undefined; // set to undefined if false
     (0, js_lib_1._filterUndefinedValues)(httpError.data, true);
     formatError?.(httpError); // Mutates
-    res.status(httpError.data.httpStatusCode).json({
+    res.status(httpError.data.backendResponseStatusCode).json({
         error: httpError,
     });
 }
@@ -76,5 +76,5 @@ function shouldReportToSentry(err) {
     // If no httpCode - report
     // if httpCode >= 500 - report
     // Otherwise - report, unless !reportOnly5xx is set
-    return !reportOnly5xx || !e.data.httpStatusCode || e.data.httpStatusCode >= 500;
+    return (!reportOnly5xx || !e.data.backendResponseStatusCode || e.data.backendResponseStatusCode >= 500);
 }

package/dist/server/reqValidationMiddleware.js

@@ -15,8 +15,8 @@ function reqValidation(reqProperty, schema, opt = {}) {
                 error.data.joiValidationErrorItems.length = 0; // clears the array
                 delete error.data.annotation;
             }
-            return next(new js_lib_1.HttpError(error.message, {
-                httpStatusCode: 400,
+            return next(new js_lib_1.AppError(error.message, {
+                backendResponseStatusCode: 400,
                 report,
                 ...error.data,
             }));

package/dist/server/requestTimeoutMiddleware.d.ts

@@ -1,13 +1,14 @@
+import { NumberOfSeconds } from '@naturalcycles/js-lib';
 import { BackendRequest, BackendRequestHandler, BackendResponse } from '../index';
 export interface RequestTimeoutMiddlewareCfg {
     /**
      * @default 120
      */
-    timeoutSeconds?: number;
+    timeoutSeconds?: NumberOfSeconds;
     /**
      * @default 503
      */
-    httpStatusCode?: number;
+    backendResponseStatusCode?: number;
     /**
      * @default 'Request timed out'
      */
@@ -18,7 +19,7 @@ export interface CustomRequestTimeoutMiddlewareCfg {
     /**
      * @default 120
      */
-    timeoutSeconds?: number;
+    timeoutSeconds?: NumberOfSeconds;
 }
 /**
  * Example:

package/dist/server/requestTimeoutMiddleware.js

@@ -6,13 +6,13 @@ const index_1 = require("../index");
 const code = 'REQUEST_TIMEOUT';
 const REQUEST_TIMEOUT_QUERY_KEY = 'requestTimeout';
 function requestTimeoutMiddleware(cfg = {}) {
-    const { timeoutSeconds: defTimeoutSeconds, httpStatusCode, httpErrorMessage, } = {
+    const { timeoutSeconds: defTimeoutSeconds, backendResponseStatusCode, httpErrorMessage, } = {
         // Considerations about the default value of the timeout.
         // Ideally the default value here would be HIGHER than the default timeout for getGot (in nodejs-lib),
         // so, cross-service communication has a chance to fail SOONER than server times out,
         // so, proper error from exact service is shown, rather than generic "503 request timed out"
         timeoutSeconds: 120,
-        httpStatusCode: 503,
+        backendResponseStatusCode: 503,
         httpErrorMessage: 'Request timed out',
         ...cfg,
     };
@@ -27,9 +27,9 @@ function requestTimeoutMiddleware(cfg = {}) {
         req.requestTimeout = setTimeout(() => {
             const endpoint = (0, index_1.getRequestEndpoint)(req);
             const msg = `${httpErrorMessage} on ${endpoint} after ${(0, js_lib_1._ms)(timeoutSeconds * 1000)}`;
-            (0, index_1.respondWithError)(req, res, new js_lib_1.HttpError(msg, {
+            (0, index_1.respondWithError)(req, res, new js_lib_1.AppError(msg, {
                 code,
-                httpStatusCode,
+                backendResponseStatusCode,
                 endpoint,
                 timeoutSeconds,
                 // userFriendly: true, // no, cause this error is not expected

package/dist/server/validateMiddleware.js

@@ -35,8 +35,8 @@ function validateObject(prop, schema, opt = {}) {
                 redact(opt.redactPaths, req[prop], error);
                 error.data.errors.length = 0; // clears the array
             }
-            return next(new js_lib_1.HttpError(error.message, {
-                httpStatusCode: 400,
+            return next(new js_lib_1.AppError(error.message, {
+                backendResponseStatusCode: 400,
                 report,
                 ...error.data,
             }));

package/dist/server/zodValidateMiddleware.js

@@ -20,8 +20,8 @@ function zodReqValidate(prop, schema, opt = {}) {
         if (opt.redactPaths) {
             redact(opt.redactPaths, req[prop], error);
         }
-        return next(new js_lib_1.HttpError(error.message, {
-            httpStatusCode: 400,
+        return next(new js_lib_1.AppError(error.message, {
+            backendResponseStatusCode: 400,
             report,
         }));
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/backend-lib",
-  "version": "4.17.0",
+  "version": "4.17.2",
   "scripts": {
     "prepare": "husky install && patch-package",
     "serve": "APP_ENV=dev nodemon",

package/src/admin/adminMiddleware.ts

@@ -1,5 +1,5 @@
 import * as fs from 'node:fs'
-import { Admin401ErrorData, HttpError, _memoFn } from '@naturalcycles/js-lib'
+import { _memoFn, AppError } from '@naturalcycles/js-lib'
 import * as ejs from 'ejs'
 import { BackendRequestHandler } from '../server/server.model'
 import { BaseAdminService } from './base.admin.service'
@@ -62,7 +62,7 @@ export function requireAdminPermissions(
       await adminService.requirePermissions(req, reqPermissions)
       return next()
     } catch (err) {
-      if (err instanceof HttpError && (err.data as Admin401ErrorData).adminAuthRequired) {
+      if (err instanceof AppError && err.data.adminAuthRequired) {
         // Redirect to login.html
         const href = `${loginHtmlPath}?${
           autoLogin ? 'autoLogin=1&' : ''

package/src/admin/base.admin.service.ts

@@ -1,4 +1,4 @@
-import { _assert, Admin401ErrorData, Admin403ErrorData, HttpError } from '@naturalcycles/js-lib'
+import { _assert, AppError } from '@naturalcycles/js-lib'
 import { dimGrey, green, red } from '@naturalcycles/nodejs-lib/dist/colors'
 import type * as FirebaseAdmin from 'firebase-admin'
 import { BackendRequest, BackendRequestHandler } from '../server/server.model'
@@ -176,9 +176,9 @@ export class BaseAdminService {
     const email = await this.getEmailByToken(req, adminToken)
 
     if (!email) {
-      throw new HttpError<Admin401ErrorData>('adminToken required', {
+      throw new AppError('adminToken required', {
         adminAuthRequired: true,
-        httpStatusCode: 401,
+        backendResponseStatusCode: 401,
         userFriendly: true,
       })
     }
@@ -203,15 +203,12 @@ export class BaseAdminService {
     }
 
     if (!granted) {
-      throw new HttpError<Admin403ErrorData>(
-        `Admin permissions required: [${reqPermissions.join(', ')}]`,
-        {
-          adminPermissionsRequired: reqPermissions,
-          email,
-          httpStatusCode: 403,
-          userFriendly: true,
-        },
-      )
+      throw new AppError(`Admin permissions required: [${reqPermissions.join(', ')}]`, {
+        adminPermissionsRequired: reqPermissions,
+        email,
+        backendResponseStatusCode: 403,
+        userFriendly: true,
+      })
     }
 
     return {
@@ -251,7 +248,7 @@ export class BaseAdminService {
       const token = req.header('authentication')
       _assert(token, `401 Unauthenticated`, {
         userFriendly: true,
-        httpStatusCode: 401,
+        backendResponseStatusCode: 401,
       })
 
       let maxAge = 1000 * 60 * 60 * 24 * 30 // 30 days

package/src/admin/secureHeaderMiddleware.ts

@@ -1,4 +1,4 @@
-import { Admin401ErrorData, HttpError } from '@naturalcycles/js-lib'
+import { AppError } from '@naturalcycles/js-lib'
 import { BackendRequestHandler } from '../server/server.model'
 import { AdminMiddleware, RequireAdminCfg, requireAdminPermissions } from './adminMiddleware'
 import { BaseAdminService } from './base.admin.service'
@@ -44,8 +44,8 @@ function requireSecureHeaderOrAdmin(
       if (!secureHeaderValue || providedHeader === secureHeaderValue) return next()
 
       return next(
-        new HttpError<Admin401ErrorData>('secureHeader or adminToken is required', {
-          httpStatusCode: 401,
+        new AppError('secureHeader or adminToken is required', {
+          backendResponseStatusCode: 401,
           adminAuthRequired: true,
         }),
       )

package/src/deploy/deployHealthCheck.ts

@@ -126,7 +126,7 @@ export async function deployHealthCheck(
 
     const started = Date.now()
 
-    const { err, fetchResponse } = await fetcher.rawFetch(url, {
+    const { err, fetchResponse } = await fetcher.doFetch(url, {
       mode: 'json',
       timeoutSeconds: timeoutSec,
       retry: {

package/src/server/bodyParserTimeoutMiddleware.ts

@@ -1,4 +1,4 @@
-import { HttpError } from '@naturalcycles/js-lib'
+import { AppError } from '@naturalcycles/js-lib'
 import { BackendRequestHandler, respondWithError } from '../index'
 
 export interface BodyParserTimeoutMiddlewareCfg {
@@ -10,7 +10,7 @@ export interface BodyParserTimeoutMiddlewareCfg {
   /**
    * @default 400
    */
-  httpStatusCode?: number
+  backendResponseStatusCode?: number
 
   /**
    * @default 'Timeout reading request input'
@@ -26,9 +26,9 @@ const code = 'BODY_PARSER_TIMEOUT'
 export function bodyParserTimeoutMiddleware(
   cfg: BodyParserTimeoutMiddlewareCfg = {},
 ): BackendRequestHandler {
-  const { timeoutSeconds, httpStatusCode, httpStatus } = {
+  const { timeoutSeconds, backendResponseStatusCode, httpStatus } = {
     timeoutSeconds: 10,
-    httpStatusCode: 400,
+    backendResponseStatusCode: 400,
     httpStatus: 'Timeout reading request input',
     ...cfg,
   }
@@ -44,9 +44,9 @@ export function bodyParserTimeoutMiddleware(
       respondWithError(
         req,
         res,
-        new HttpError(httpStatus, {
+        new AppError(httpStatus, {
           code,
-          httpStatusCode,
+          backendResponseStatusCode,
           // userFriendly: true, // no, cause this error is not expected
         }),
       )

package/src/server/genericErrorMiddleware.ts

@@ -2,10 +2,9 @@ import {
   _anyToError,
   _errorToErrorObject,
   _filterUndefinedValues,
+  AppError,
+  BackendErrorResponseObject,
   ErrorObject,
-  HttpError,
-  HttpErrorData,
-  HttpErrorResponse,
 } from '@naturalcycles/js-lib'
 import { SentrySharedService } from '../sentry/sentry.shared.service'
 import { BackendErrorRequestHandler, BackendRequest, BackendResponse } from './server.model'
@@ -23,7 +22,7 @@ export interface GenericErrorMiddlewareCfg {
    * Generic hook that can be used to **mutate** errors before they are returned to client.
    * This function does not affect data sent to sentry.
    */
-  formatError?: (err: ErrorObject<HttpErrorData>) => void
+  formatError?: (err: ErrorObject) => void
 }
 
 const { APP_ENV } = process.env
@@ -82,24 +81,24 @@ export function respondWithError(req: BackendRequest, res: BackendResponse, err:
 
   if (res.headersSent) return
 
-  const httpError = _errorToErrorObject<HttpErrorData>(originalError)
+  const httpError = _errorToErrorObject(originalError)
   if (!includeErrorStack) delete httpError.stack
 
   httpError.data.errorId = errorId
-  httpError.data.httpStatusCode ||= 500 // default to 500
+  httpError.data.backendResponseStatusCode ||= 500 // default to 500
   httpError.data.headersSent = headersSent || undefined
   httpError.data.report ||= undefined // set to undefined if false
   _filterUndefinedValues(httpError.data, true)
 
   formatError?.(httpError) // Mutates
 
-  res.status(httpError.data.httpStatusCode).json({
+  res.status(httpError.data.backendResponseStatusCode).json({
     error: httpError,
-  } as HttpErrorResponse)
+  } satisfies BackendErrorResponseObject)
 }
 
 function shouldReportToSentry(err: Error): boolean {
-  const e = err as HttpError
+  const e = err as AppError
 
   // By default - report
   if (!e?.data) return true
@@ -112,5 +111,7 @@ function shouldReportToSentry(err: Error): boolean {
   // If no httpCode - report
   // if httpCode >= 500 - report
   // Otherwise - report, unless !reportOnly5xx is set
-  return !reportOnly5xx || !e.data.httpStatusCode || e.data.httpStatusCode >= 500
+  return (
+    !reportOnly5xx || !e.data.backendResponseStatusCode || e.data.backendResponseStatusCode >= 500
+  )
 }

package/src/server/reqValidationMiddleware.ts

@@ -1,4 +1,4 @@
-import { HttpError, _get } from '@naturalcycles/js-lib'
+import { _get, AppError } from '@naturalcycles/js-lib'
 import { AnySchema, getValidationResult, JoiValidationError } from '@naturalcycles/nodejs-lib'
 import { BackendRequestHandler } from './server.model'
 
@@ -37,8 +37,8 @@ export function reqValidation(
       }
 
       return next(
-        new HttpError(error.message, {
-          httpStatusCode: 400,
+        new AppError(error.message, {
+          backendResponseStatusCode: 400,
           report,
           ...error.data,
         }),

package/src/server/requestTimeoutMiddleware.ts

@@ -1,4 +1,4 @@
-import { _ms, HttpError } from '@naturalcycles/js-lib'
+import { _ms, AppError, NumberOfSeconds } from '@naturalcycles/js-lib'
 import {
   BackendRequest,
   BackendRequestHandler,
@@ -12,12 +12,12 @@ export interface RequestTimeoutMiddlewareCfg {
   /**
    * @default 120
    */
-  timeoutSeconds?: number
+  timeoutSeconds?: NumberOfSeconds
 
   /**
    * @default 503
    */
-  httpStatusCode?: number
+  backendResponseStatusCode?: number
 
   /**
    * @default 'Request timed out'
@@ -33,7 +33,7 @@ export function requestTimeoutMiddleware(
 ): BackendRequestHandler {
   const {
     timeoutSeconds: defTimeoutSeconds,
-    httpStatusCode,
+    backendResponseStatusCode,
     httpErrorMessage,
   } = {
     // Considerations about the default value of the timeout.
@@ -41,7 +41,7 @@ export function requestTimeoutMiddleware(
     // so, cross-service communication has a chance to fail SOONER than server times out,
     // so, proper error from exact service is shown, rather than generic "503 request timed out"
     timeoutSeconds: 120,
-    httpStatusCode: 503,
+    backendResponseStatusCode: 503,
     httpErrorMessage: 'Request timed out',
     ...cfg,
   }
@@ -62,9 +62,9 @@ export function requestTimeoutMiddleware(
       respondWithError(
         req,
         res,
-        new HttpError(msg, {
+        new AppError(msg, {
           code,
-          httpStatusCode,
+          backendResponseStatusCode,
           endpoint,
           timeoutSeconds,
           // userFriendly: true, // no, cause this error is not expected
@@ -82,7 +82,7 @@ export interface CustomRequestTimeoutMiddlewareCfg {
   /**
    * @default 120
    */
-  timeoutSeconds?: number
+  timeoutSeconds?: NumberOfSeconds
 }
 
 /**

package/src/server/validateMiddleware.ts

@@ -1,4 +1,4 @@
-import { HttpError, JsonSchema, JsonSchemaBuilder, _get } from '@naturalcycles/js-lib'
+import { JsonSchema, JsonSchemaBuilder, _get, AppError } from '@naturalcycles/js-lib'
 import { AjvSchema, AjvValidationError } from '@naturalcycles/nodejs-lib'
 import { BackendRequestHandler } from './server.model'
 import { ReqValidationOptions } from './reqValidationMiddleware'
@@ -54,8 +54,8 @@ function validateObject(
       }
 
       return next(
-        new HttpError(error.message, {
-          httpStatusCode: 400,
+        new AppError(error.message, {
+          backendResponseStatusCode: 400,
           report,
           ...error.data,
         }),

package/src/server/zodValidateMiddleware.ts

@@ -1,10 +1,4 @@
-import {
-  HttpError,
-  _get,
-  ZodSchema,
-  ZodValidationError,
-  zSafeValidate,
-} from '@naturalcycles/js-lib'
+import { _get, AppError, ZodSchema, ZodValidationError, zSafeValidate } from '@naturalcycles/js-lib'
 import { BackendRequestHandler } from './server.model'
 import { ReqValidationOptions } from './reqValidationMiddleware'
 
@@ -36,8 +30,8 @@ export function zodReqValidate(
     }
 
     return next(
-      new HttpError(error.message, {
-        httpStatusCode: 400,
+      new AppError(error.message, {
+        backendResponseStatusCode: 400,
         report,
       }),
     )