Merge branch 'prep-v20' into mw-class

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### v20.0.0
 
+- Method `createLogger()` removed — use `new BuiltinLogger()` instead if needed;
 - Publicly exposed types are corrected for better constraints:
   - `IOSchema` type: type arguments generalized to the most wide type possible;
   - The `requestProps`, `responseProps` and `loggerProps` properties of the `testEndpoint()` method's argument:

src/builtin-logger.ts

@@ -102,11 +102,3 @@ export class BuiltinLogger implements AbstractLogger {
     return new BuiltinLogger({ ...this.config, ctx });
   }
 }
-
-/**
- * @desc Alias for "new BuiltinLogger()"
- * @deprecated use new BuiltinLogger()
- * @todo remove in v20
- * */
-export const createLogger = (config: BuiltinLoggerConfig) =>
-  new BuiltinLogger(config);

src/documentation-helpers.ts

@@ -1020,8 +1020,7 @@ export const depictSecurityRefs = (
   return depictSecurityRefs({ or: [container] });
 };
 
-// @todo depictBody
-export const depictRequest = ({
+export const depictBody = ({
   method,
   path,
   schema,

src/documentation.ts

@@ -20,7 +20,7 @@ import { mapLogicalContainer } from "./logical-container";
 import { Method } from "./method";
 import {
   OpenAPIContext,
-  depictRequest,
+  depictBody,
   depictRequestParams,
   depictResponse,
   depictSecurity,
@@ -221,7 +221,7 @@ export class Documentation extends OpenApiBuilder {
       }
 
       const requestBody = inputSources.includes("body")
-        ? depictRequest({
+        ? depictBody({
             ...commons,
             paramNames: pluck("name", depictedParams),
             schema: endpoint.getSchema("input"),

src/index.ts

@@ -12,7 +12,7 @@ export {
   getMessageFromError,
   getStatusCodeFromError,
 } from "./common-helpers";
-export { createLogger, BuiltinLogger } from "./builtin-logger";
+export { BuiltinLogger } from "./builtin-logger";
 export { Middleware } from "./middleware";
 export {
   createResultHandler,

tests/unit/__snapshots__/index.spec.ts.snap

@@ -50,8 +50,6 @@ exports[`Index Entrypoint > exports > attachRouting should have certain value 1`
 
 exports[`Index Entrypoint > exports > createConfig should have certain value 1`] = `[Function]`;
 
-exports[`Index Entrypoint > exports > createLogger should have certain value 1`] = `[Function]`;
-
 exports[`Index Entrypoint > exports > createResultHandler should have certain value 1`] = `[Function]`;
 
 exports[`Index Entrypoint > exports > createServer should have certain value 1`] = `[Function]`;
@@ -102,7 +100,6 @@ exports[`Index Entrypoint > exports > should have certain entities exposed 1`] =
   "getExamples",
   "getMessageFromError",
   "getStatusCodeFromError",
-  "createLogger",
   "BuiltinLogger",
   "Middleware",
   "createResultHandler",

tests/unit/builtin-logger.spec.ts

@@ -9,11 +9,7 @@ import {
   test,
   vi,
 } from "vitest";
-import {
-  BuiltinLogger,
-  BuiltinLoggerConfig,
-  createLogger,
-} from "../../src/builtin-logger";
+import { BuiltinLogger, BuiltinLoggerConfig } from "../../src/builtin-logger";
 
 describe("BuiltinLogger", () => {
   beforeAll(() => {
@@ -118,11 +114,4 @@ describe("BuiltinLogger", () => {
       expect(logSpy.mock.calls).toMatchSnapshot();
     });
   });
-
-  /** @todo remove in v20 */
-  describe("createLogger() alias", () => {
-    test("should return instance of BuiltinLogger", () => {
-      expect(createLogger({ level: "debug" })).toBeInstanceOf(BuiltinLogger);
-    });
-  });
 });