v18 is for Victoria (#1639)

# Dedication


![image](https://github.com/RobinTail/express-zod-api/assets/13189514/7ce8a788-6254-4d01-8e7a-6dc7a82a2b05)

**Victoria Carmen White**, a black trans woman, was murdered in New
Jersey, US, on 12 September 2010. Her boyfriend was brought to trial for
her death, but he was acquitted and blamed another man for the murder.
The gun used in the killing was never found.

Transgender women suffer too frequently from transphobic violence and
cruelty, being the less protected social group. I'd like to raise an
awareness of this problem. Humans should be creators — not killers. But
most importantly, I want every transgender girl to have an opportunity
to create applications quickly and, in general, learn to write code
easily in order to receive job offers and leave dangerously transphobic
territories for more favorable and civilized ones, and live happily
there. Protect transgender women.

---

# Version 18

## Description

This version is focused on making the quick start with Express Zod API
even faster by replacing Winston with a built-in console logger having
the same basic functionality needed to begin the development. Migration
should be easy in most cases.

## What's included

- #1636 
- #1640, later overridden by:
- #1654 
- #1671

Author: RobinTail

.github/workflows/codeql-analysis.yml

@@ -13,10 +13,10 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [ master, v14, v15, v16 ]
+    branches: [ master, v15, v16, v17 ]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ master, v14, v15, v16 ]
+    branches: [ master, v15, v16, v17 ]
   schedule:
     - cron: '26 8 * * 1'
 

.github/workflows/node.js.yml

@@ -5,9 +5,9 @@ name: Node.js CI
 
 on:
   push:
-    branches: [ master, v14, v15, v16 ]
+    branches: [ master, v15, v16, v17 ]
   pull_request:
-    branches: [ master, v14, v15, v16 ]
+    branches: [ master, v15, v16, v17 ]
 
 jobs:
   build:

.github/workflows/swagger.yml

@@ -2,9 +2,9 @@ name: OpenAPI Validation
 
 on:
   push:
-    branches: [ master, v14, v15, v16 ]
+    branches: [ master, v15, v16, v17 ]
   pull_request:
-    branches: [ master, v14, v15, v16 ]
+    branches: [ master, v15, v16, v17 ]
 
 
 jobs:

CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## Version 18
+
+### v18.0.0
+
+- **Breaking changes**:
+  - `winston` is no longer a default logger;
+  - `createLogger()` argument is changed, and it now returns a built-in logger instead of `winston`.
+- Features:
+  - New built-in console logger with colorful pretty inspections and basic methods only.
+- Non-breaking significant changes:
+  - Due to detaching from `winston`, the `attachRouting()` method is back to being synchronous.
+- How to migrate confidently:
+  - If you're using `attachRouting()` method:
+    - Remove `await` before it (and possible async IIFE wrapper if present) — no longer required.
+  - If you're using a custom logger in config:
+    - No action required.
+  - If you're using `createLogger()` method in your code:
+    - Remove the `winston` property from its argument.
+  - If you're using the default logger in config (which used to be `winston` as a peer dependency):
+    - If you're only using its `info()`, `debug()`, `error()` and `warn()` methods:
+      - You can now uninstall `winston` — no further action required.
+    - If you're using its other methods, like `.child()` or `profile()`:
+      - Configure `winston` as a custom logger [according to the documentation](README.md#customizing-logger),
+      - Or consider any other compatible logger, like `pino` for example, which is easier to configure.
+
 ## Version 17
 
 ### v17.7.1

README.md

@@ -89,7 +89,7 @@ Therefore, many basic tasks can be accomplished faster and easier, in particular
 - Web server — [Express.js](https://expressjs.com/).
 - Schema validation — [Zod 3.x](https://github.com/colinhacks/zod).
 - Supports any logger having `info()`, `debug()`, `error()` and `warn()` methods;
-  - [Winston](https://github.com/winstonjs/winston) is default.
+  - Built-in console logger with colorful and pretty inspections by default.
 - Generators:
   - Documentation — [OpenAPI 3.1](https://github.com/metadevpro/openapi3-ts) (former Swagger);
   - Client side types — inspired by [zod-to-ts](https://github.com/sachinraja/zod-to-ts).
@@ -118,14 +118,14 @@ Much can be customized to fit your needs.
 Run one of the following commands to install the library, its peer dependencies and packages for types assistance.
 
 ```shell
-yarn add express-zod-api express zod winston typescript http-errors
+yarn add express-zod-api express zod typescript http-errors
 yarn add --dev @types/express @types/node @types/http-errors
 ```
 
 or
 
 ```shell
-npm install express-zod-api express zod winston typescript http-errors
+npm install express-zod-api express zod typescript http-errors
 npm install -D @types/express @types/node @types/http-errors
 ```
 
@@ -147,7 +147,6 @@ Create a minimal configuration. _See all available options
 
 ```typescript
 import { createConfig } from "express-zod-api";
-import type { Logger } from "winston";
 
 const config = createConfig({
   server: {
@@ -156,11 +155,6 @@ const config = createConfig({
   cors: true,
   logger: { level: "debug", color: true },
 });
-
-// Setting the type of the logger used
-declare module "express-zod-api" {
-  interface LoggerOverrides extends Logger {}
-}
 ```
 
 ## Create an endpoints factory
@@ -526,8 +520,9 @@ your API at [Let's Encrypt](https://letsencrypt.org/).
 
 ## Customizing logger
 
-You can uninstall `winston` (which is the default and recommended logger) and use another compatible one, having
-`info()`, `debug()`, `error()` and `warn()` methods. For example, `pino` logger with `pino-pretty` extension:
+If the simple console output of the built-in logger is not enough for you, you can connect any other compatible one.
+It must support at least the following methods: `info()`, `debug()`, `error()` and `warn()`.
+Winston and Pino support is well known. Here is an example configuring `pino` logger with `pino-pretty` extension:
 
 ```typescript
 import pino, { Logger } from "pino";
@@ -560,7 +555,7 @@ import { randomUUID } from "node:crypto";
 const config = createConfig({
   // logger: ...,
   childLoggerProvider: ({ parent, request }) =>
-    parent.child({ requestId: randomUUID() }),
+    parent.child({ requestId: randomUUID() }), // assuming a custom logger having .child() method
 });
 ```
 
@@ -793,7 +788,7 @@ Some options are forced in order to ensure the correct workflow:
 {
   abortOnLimit: false,
   parseNested: true,
-  logger: {}, // the configured logger (default: winston), using its .debug() method
+  logger: {}, // the configured logger, using its .debug() method
 }
 ```
 
@@ -878,15 +873,11 @@ const app = express(); // or express.Router()
 const config = createConfig({ app /* cors, logger, ... */ });
 const routing: Routing = {}; // your endpoints go here
 
-// This async IIFE is only required for the top level CommonJS
-(async () => {
-  const { notFoundHandler, logger } = await attachRouting(config, routing);
-
-  app.use(notFoundHandler); // optional
-  app.listen();
+const { notFoundHandler, logger } = attachRouting(config, routing);
 
-  logger.info("Glory to science!");
-})();
+app.use(notFoundHandler); // optional
+app.listen();
+logger.info("Glory to science!");
 ```
 
 **Please note** that in this case you probably need to parse `request.body`, call `app.listen()` and handle `404`

SECURITY.md

@@ -4,10 +4,11 @@
 
 | Version | Release |     Supported      |
 | ------: | :------ | :----------------: |
+|  18.x.x | 04.2024 | :white_check_mark: |
 |  17.x.x | 02.2024 | :white_check_mark: |
 |  16.x.x | 12.2023 | :white_check_mark: |
 |  15.x.x | 12.2023 | :white_check_mark: |
-|  14.x.x | 10.2023 | :white_check_mark: |
+|  14.x.x | 10.2023 |        :x:         |
 |  12.x.x | 09.2023 |        :x:         |
 |  11.x.x | 06.2023 |        :x:         |
 |  10.x.x | 03.2023 |        :x:         |

example/config.ts

@@ -35,7 +35,7 @@ export const config = createConfig({
   },
 });
 
-// Uncomment these lines to set the type of logger used:
+// Uncomment these lines when using a custom logger, for example winston:
 /*
 declare module "express-zod-api" {
   interface LoggerOverrides extends winston.Logger {}

example/example.documentation.yaml

@@ -1,7 +1,7 @@
 openapi: 3.1.0
 info:
   title: Example API
-  version: 17.7.1
+  version: 18.0.0-beta3
 paths:
   /v1/user/retrieve:
     get:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-zod-api",
-  "version": "17.7.1",
+  "version": "18.0.0-beta3",
   "description": "A Typescript library to help you get an API server up and running with I/O schema validation and custom middlewares in minutes.",
   "license": "MIT",
   "repository": {
@@ -25,7 +25,6 @@
     "build:docs": "tsx example/generate-documentation.ts",
     "build:client": "tsx example/generate-client.ts",
     "build:license": "tsx tools/license.ts",
-    "build:logo": "tsx tools/startup-logo.ts",
     "test": "yarn test:types && yarn test:unit && yarn test:badge",
     "test:cjs": "yarn --cwd tests/cjs && vitest run -r tests/cjs",
     "test:esm": "yarn --cwd tests/esm && vitest run -r tests/esm",
@@ -68,6 +67,7 @@
     "node": "^18.0.0 || ^20.0.0"
   },
   "dependencies": {
+    "ansis": "^3.1.0",
     "openapi3-ts": "^4.2.1",
     "ramda": "^0.29.1"
   },
@@ -86,7 +86,6 @@
     "prettier": "^3.1.0",
     "typescript": "^5.1.3",
     "vitest": "^1.0.4",
-    "winston": "^3.10.0",
     "zod": "^3.22.3"
   },
   "peerDependenciesMeta": {
@@ -122,9 +121,6 @@
     },
     "vitest": {
       "optional": true
-    },
-    "winston": {
-      "optional": true
     }
   },
   "devDependencies": {
@@ -142,7 +138,6 @@
     "@typescript-eslint/eslint-plugin": "^7.1.0",
     "@typescript-eslint/parser": "^7.1.0",
     "@vitest/coverage-istanbul": "^1.5.0",
-    "chalk": "^5.3.0",
     "compression": "^1.7.4",
     "cors": "^2.8.5",
     "eslint": "^8.48.0",
@@ -165,7 +160,6 @@
     "tsx": "^4.6.2",
     "typescript": "^5.2.2",
     "vitest": "^1.5.0",
-    "winston": "^3.10.0",
     "zod": "^3.22.3"
   },
   "keywords": [

src/config-type.ts

@@ -3,7 +3,7 @@ import { IRouter, Request, RequestHandler } from "express";
 import type fileUpload from "express-fileupload";
 import { ServerOptions } from "node:https";
 import { AbstractEndpoint } from "./endpoint";
-import { AbstractLogger, SimplifiedWinstonConfig } from "./logger";
+import { AbstractLogger, BuiltinLoggerConfig } from "./logger";
 import { Method } from "./method";
 import { AnyResultHandlerDefinition } from "./result-handler";
 import { ListenOptions } from "node:net";
@@ -47,10 +47,10 @@ export interface CommonConfig<TAG extends string = string> {
    */
   errorHandler?: AnyResultHandlerDefinition;
   /**
-   * @desc Logger configuration (winston) or instance of any other logger.
+   * @desc Built-in logger configuration or an instance of any compatible logger.
    * @example { level: "debug", color: true }
    * */
-  logger: SimplifiedWinstonConfig | AbstractLogger;
+  logger: BuiltinLoggerConfig | AbstractLogger;
   /**
    * @desc A child logger returned by this function can override the logger in all handlers for each request
    * @example ({ parent }) => parent.child({ requestId: uuid() })