@naturalcycles/backend-lib 9.14.0 → 9.16.0

package/src/server/logMiddleware.ts

@@ -1,6 +1,8 @@
 import { inspect } from 'node:util'
-import type { AnyObject, CommonLogger } from '@naturalcycles/js-lib'
-import { _inspect, dimGrey } from '@naturalcycles/nodejs-lib'
+import type { CommonLogger } from '@naturalcycles/js-lib/log'
+import type { AnyObject } from '@naturalcycles/js-lib/types'
+import { _inspect } from '@naturalcycles/nodejs-lib'
+import { dimGrey } from '@naturalcycles/nodejs-lib/colors'
 import type { BackendRequestHandler } from './server.model.js'
 
 const { GOOGLE_CLOUD_PROJECT, GAE_INSTANCE, K_SERVICE, APP_ENV } = process.env

package/src/server/request.log.util.ts

@@ -1,5 +1,5 @@
-import type { CommonLogLevel } from '@naturalcycles/js-lib'
-import { boldGrey, green, red, yellow } from '@naturalcycles/nodejs-lib'
+import type { CommonLogLevel } from '@naturalcycles/js-lib/log'
+import { boldGrey, green, red, yellow } from '@naturalcycles/nodejs-lib/colors'
 import type { BackendRequest } from './server.model.js'
 
 export function logRequestWithColors(

package/src/server/requestLoggerMiddleware.ts

@@ -1,7 +1,7 @@
-import type { UnixTimestampMillis } from '@naturalcycles/js-lib'
-import { _since } from '@naturalcycles/js-lib'
-import type { BackendRequest, BackendRequestHandler } from '../index.js'
-import { onFinished } from '../index.js'
+import { _since } from '@naturalcycles/js-lib/datetime'
+import type { UnixTimestampMillis } from '@naturalcycles/js-lib/types'
+import { onFinished } from '../onFinished.js'
+import type { BackendRequest, BackendRequestHandler } from './server.model.js'
 
 export interface RequestLoggerMiddlewareCfg {
   /**

package/src/server/requestTimeoutMiddleware.ts

@@ -1,7 +1,10 @@
-import type { NumberOfSeconds } from '@naturalcycles/js-lib'
-import { _ms, AppError } from '@naturalcycles/js-lib'
-import type { BackendRequest, BackendRequestHandler, BackendResponse } from '../index.js'
-import { getRequestEndpoint, onFinished, respondWithError } from '../index.js'
+import { _ms } from '@naturalcycles/js-lib/datetime'
+import { AppError } from '@naturalcycles/js-lib/error'
+import type { NumberOfSeconds } from '@naturalcycles/js-lib/types'
+import { onFinished } from '../onFinished.js'
+import { respondWithError } from './genericErrorMiddleware.js'
+import { getRequestEndpoint } from './request.util.js'
+import type { BackendRequest, BackendRequestHandler, BackendResponse } from './server.model.js'
 
 export interface RequestTimeoutMiddlewareCfg {
   /**

package/src/server/safeJsonMiddleware.ts

@@ -1,4 +1,4 @@
-import { _safeJsonStringify } from '@naturalcycles/js-lib'
+import { _safeJsonStringify } from '@naturalcycles/js-lib/string'
 import type { BackendRequestHandler, BackendResponse } from './server.model.js'
 
 /**

package/src/server/server.model.ts

@@ -1,4 +1,5 @@
-import type { CommonLogFunction, Promisable } from '@naturalcycles/js-lib'
+import type { CommonLogFunction } from '@naturalcycles/js-lib/log'
+import type { Promisable } from '@naturalcycles/js-lib/types'
 import type { Application, IRouter, NextFunction, Request, Response } from 'express'
 
 /**

package/src/server/server.util.ts

@@ -1,6 +1,6 @@
 import type { Server } from 'node:http'
 import type { Socket } from 'node:net'
-import type { StringMap } from '@naturalcycles/js-lib'
+import type { StringMap } from '@naturalcycles/js-lib/types'
 
 export interface DestroyableServer extends Server {
   destroy: () => Promise<void>

package/src/server/serverStatsMiddleware.ts

@@ -1,19 +1,11 @@
-import type { StringMap } from '@naturalcycles/js-lib'
-import {
-  _get,
-  _mapValues,
-  _mb,
-  _ms,
-  _percentile,
-  _sortBy,
-  _stringMapEntries,
-  _stringMapValues,
-  _sum,
-  NumberStack,
-} from '@naturalcycles/js-lib'
-import type { BackendRequestHandler } from '../index.js'
-import { onFinished } from '../index.js'
+import { _mb, _sortBy, _sum } from '@naturalcycles/js-lib'
+import { _ms } from '@naturalcycles/js-lib/datetime'
+import { _percentile, NumberStack } from '@naturalcycles/js-lib/math'
+import { _get, _mapValues } from '@naturalcycles/js-lib/object'
+import { _stringMapEntries, _stringMapValues, type StringMap } from '@naturalcycles/js-lib/types'
+import { onFinished } from '../onFinished.js'
 import { getRequestEndpoint } from './request.util.js'
+import type { BackendRequestHandler } from './server.model.js'
 
 const { GAE_INSTANCE } = process.env
 

package/src/server/serverStatusMiddleware.ts

@@ -1,6 +1,7 @@
-import { _filterNullishValues, localTime } from '@naturalcycles/js-lib'
+import { localTime } from '@naturalcycles/js-lib/datetime'
+import { _filterNullishValues } from '@naturalcycles/js-lib/object'
 import { memoryUsageFull, processSharedUtil } from '@naturalcycles/nodejs-lib'
-import { getDeployInfo } from './deployInfo.util.js'
+import { getDeployInfo } from '../deploy/deployInfo.util.js'
 import type { BackendRequestHandler } from './server.model.js'
 
 const { versions, arch, platform } = process

package/src/server/simpleRequestLoggerMiddleware.ts

@@ -1,9 +1,9 @@
-import type { UnixTimestampMillis } from '@naturalcycles/js-lib'
-import { _since } from '@naturalcycles/js-lib'
-import { boldGrey, dimGrey } from '@naturalcycles/nodejs-lib'
-import type { BackendRequestHandler } from '../index.js'
-import { onFinished } from '../index.js'
+import { _since } from '@naturalcycles/js-lib/datetime'
+import type { UnixTimestampMillis } from '@naturalcycles/js-lib/types'
+import { boldGrey, dimGrey } from '@naturalcycles/nodejs-lib/colors'
+import { onFinished } from '../onFinished.js'
 import { logRequestWithColors } from './request.log.util.js'
+import type { BackendRequestHandler } from './server.model.js'
 
 export interface SimpleRequestLoggerMiddlewareCfg {
   /**

package/src/testing/express.test.service.ts

@@ -1,10 +1,14 @@
 import type { Server } from 'node:http'
 import type { AddressInfo } from 'node:net'
-import type { Fetcher, FetcherOptions, FetchFunction } from '@naturalcycles/js-lib'
-import { getFetcher, pDelay } from '@naturalcycles/js-lib'
-import type { BackendApplication, DefaultAppCfg } from '../index.js'
-import { createDefaultApp } from '../index.js'
-import type { BackendRequestHandlerCfg } from '../server/createDefaultApp.model.js'
+import type { Fetcher, FetcherOptions, FetchFunction } from '@naturalcycles/js-lib/http'
+import { getFetcher } from '@naturalcycles/js-lib/http'
+import { pDelay } from '@naturalcycles/js-lib/promise'
+import {
+  type BackendRequestHandlerCfg,
+  createDefaultApp,
+  type DefaultAppCfg,
+} from '../express/createDefaultApp.js'
+import type { BackendApplication } from '../server/server.model.js'
 
 const nativeFetchFn: FetchFunction = async (url, init) => await globalThis.fetch(url, init)
 

package/src/{server/validation → validation/ajv}/ajvValidateRequest.ts

@@ -1,7 +1,8 @@
-import { _get, AppError } from '@naturalcycles/js-lib'
+import { AppError } from '@naturalcycles/js-lib/error'
+import { _get } from '@naturalcycles/js-lib/object'
 import type { AjvSchema, AjvValidationError } from '@naturalcycles/nodejs-lib/ajv'
-import type { BackendRequest } from '../server.model.js'
-import type { ReqValidationOptions } from './validateRequest.js'
+import type { BackendRequest } from '../../server/server.model.js'
+import type { ReqValidationOptions } from '../joi/joiValidateRequest.js'
 
 class AjvValidateRequest {
   body<T>(

package/src/{server/validation/validateRequest.ts → validation/joi/joiValidateRequest.ts}

@@ -1,7 +1,8 @@
-import { _get, AppError } from '@naturalcycles/js-lib'
+import { AppError } from '@naturalcycles/js-lib/error'
+import { _get } from '@naturalcycles/js-lib/object'
 import type { AnySchema, JoiValidationError } from '@naturalcycles/nodejs-lib/joi'
 import { getValidationResult } from '@naturalcycles/nodejs-lib/joi'
-import type { BackendRequest } from '../server.model.js'
+import type { BackendRequest } from '../../server/server.model.js'
 
 export interface ReqValidationOptions<ERR extends Error> {
   /**

package/src/{server/validation → validation/zod}/zodValidateRequest.ts

@@ -1,7 +1,8 @@
-import { _get, AppError } from '@naturalcycles/js-lib'
+import { AppError } from '@naturalcycles/js-lib/error'
+import { _get } from '@naturalcycles/js-lib/object'
 import { type ZodType, type ZodValidationError, zSafeValidate } from '@naturalcycles/js-lib/zod'
-import type { BackendRequest } from '../server.model.js'
-import type { ReqValidationOptions } from './validateRequest.js'
+import type { BackendRequest } from '../../server/server.model.js'
+import type { ReqValidationOptions } from '../joi/joiValidateRequest.js'
 
 class ZodValidateRequest {
   body<T>(

package/dist/server/createDefaultApp.d.ts

@@ -1,3 +0,0 @@
-import type { DefaultAppCfg } from './createDefaultApp.model.js';
-import type { BackendApplication } from './server.model.js';
-export declare function createDefaultApp(cfg: DefaultAppCfg): Promise<BackendApplication>;

package/dist/server/createDefaultApp.model.js

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

package/dist/server/deployInfo.util.d.ts

@@ -1,2 +0,0 @@
-import type { DeployInfo } from '../deploy/index.js';
-export declare const getDeployInfo: ((projectDir: string) => DeployInfo) & import("@naturalcycles/js-lib").MemoizedFunction;

package/dist/server/startServer.d.ts

@@ -1,17 +0,0 @@
-import type { Server } from 'node:http';
-import type { StartServerCfg, StartServerData } from './startServer.model.js';
-export declare class BackendServer {
-    private cfg;
-    constructor(cfg: StartServerCfg);
-    server?: Server;
-    start(): Promise<StartServerData>;
-    /**
-     * Gracefully shuts down the server.
-     * Does `process.exit()` in the end.
-     */
-    stop(reason: string): Promise<void>;
-}
-/**
- * Convenience function.
- */
-export declare function startServer(cfg: StartServerCfg): Promise<StartServerData>;

package/dist/server/startServer.model.js

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

package/src/server/createDefaultApp.model.ts

@@ -1,41 +0,0 @@
-import type { Options, OptionsJson, OptionsUrlencoded } from 'body-parser'
-import type { CorsOptions } from 'cors'
-import type { SentrySharedService } from '../sentry/sentry.shared.service.js'
-import type { GenericErrorMiddlewareCfg } from './genericErrorMiddleware.js'
-import type { BackendRequestHandler } from './server.model.js'
-
-/**
- * Plain RequestHandler can be provided - then it's mounted to /
- * Otherwise `path` can be provided to specify mounting point.
- */
-export type BackendRequestHandlerCfg = BackendRequestHandler | BackendRequestHandlerWithPath
-
-export interface BackendRequestHandlerWithPath {
-  path: string
-  handler: BackendRequestHandler
-}
-
-/**
- * Handlers are used in this order:
- *
- * 1. preHandlers
- * 2. handlers
- * 3. resources
- * 4. postHandlers
- */
-export interface DefaultAppCfg {
-  preHandlers?: BackendRequestHandlerCfg[]
-  handlers?: BackendRequestHandlerCfg[]
-  resources?: BackendRequestHandlerCfg[]
-  postHandlers?: BackendRequestHandlerCfg[]
-
-  sentryService?: SentrySharedService
-
-  bodyParserJsonOptions?: OptionsJson
-  bodyParserUrlEncodedOptions?: OptionsUrlencoded
-  bodyParserRawOptions?: Options
-
-  corsOptions?: CorsOptions
-
-  genericErrorMwCfg?: GenericErrorMiddlewareCfg
-}

package/src/server/startServer.model.ts

@@ -1,44 +0,0 @@
-import type { Server } from 'node:http'
-import type { SentrySharedService } from '../sentry/sentry.shared.service.js'
-import type { DefaultAppCfg } from './createDefaultApp.model.js'
-import type { BackendApplication } from './server.model.js'
-
-/**
- * If DefaultAppCfg.resources is passed and `expressApp` is not passed - it will call createDefaultApp(cfg).
- */
-export interface StartServerCfg extends DefaultAppCfg {
-  /**
-   * @default process.env.PORT || 8080
-   */
-  port?: number
-
-  expressApp?: BackendApplication
-
-  /**
-   * Server will wait for promise to resolve until shutting down.
-   * (with a timeout)
-   */
-  onShutdown?: () => Promise<void>
-
-  /**
-   * @default 3000
-   */
-  forceShutdownTimeout?: number
-
-  sentryService?: SentrySharedService
-
-  /**
-   * Defaults to true.
-   * Set to false if you already have your handlers elsewhere and don't need them here.
-   */
-  registerUncaughtExceptionHandlers?: boolean
-}
-
-export interface StartServerData {
-  port: number
-  server: Server
-  /**
-   * "Processed" server.address() as a string, ready to Cmd+click in MacOS Terminal
-   */
-  address: string
-}