express-zod-api - npm Package Versions

v21.11.0

• New public property ctx is available on instances of BuiltinLogger:
  • When using the built-in logger and childLoggerProvider config option, the ctx property contains the argument that was used for creating the child logger using its .child() method;
  • It can be utilized for accessing its requestId property for purposes other than logging;
  • The default value of ctx is an empty object (when the instance is not a child logger).

import { BuiltinLogger, createConfig, createMiddleware } from "express-zod-api";

// Declaring the logger type in use
declare module "express-zod-api" {
  interface LoggerOverrides extends BuiltinLogger {}
}

// Configuring child logger provider
const config = createConfig({
  childLoggerProvider: ({ parent }) =>
    parent.child({ requestId: randomUUID() }),
});

// Accessing child logger context
createMiddleware({
  handler: async ({ logger }) => {
    doSomething(logger.ctx.requestId); // <—
  },
});

v21.10.0

• New Integration option: serverUrl, string, optional, the API URL for the generated client:
  • Currently used for generating example implementation;
  • Default value remains https://example.com;
• Using new URL() for constructing the final request URL in the example implementation of the generated client:
  • That enables handling serverUrl both with and without trailing slash;

v21.9.0

• Deprecating MethodPath type in the code generated by Integration:
  • Introducing the Request type to be used instead;
• Added JSDoc having the request in description for every type and interface generated by Integration;
• A couple adjustments for consistency and performance.

v21.8.0

• Deprecating jsonEndpoints from the code generated by Integration:
  • Use the content-type header of an actual response instead, example.

v21.7.0

• Feature: introducing EncodedResponse public interface in the code generated by Integration:
  • The new entity should enable making custom clients having response type awereness based on the status code;
  • The difference between Response and EndcodedResponse is the second hierarchical level.

import { EncodedResponse } from "./generated.ts";

type UsageExample = EncodedResponse["get /v1/user/retrieve"][200];