CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[0.15.0] - 2024-05-13

• Feature: Every endpoint method now accepts a third parameter called next. This gives express authors access to the express internals if they are useful

  getUsers: (req, res, next: NextFunction) => {
    // implementation
  }

[0.14.0] - 2024-05-13

• Feature: Support a skipResponseValidation configuration so that users can disable response validation. Note that this will still keep the serialization layer. To enable this configuration, add the following option to your generators.yml:

  config: 
    skipResponseValidation: true

[0.13.0] - 2024-05-06

• Feature: Bump to v43 of IR which means that you will need 0.26.1 of the Fern CLI version. To bump your CLI version, please run fern upgrade.

  If you specify custom response status codes, the underlying express implementation will send that back to the user.

[0.12.0] - 2024-05-07

• Improvement: Support a skipRequestValidation configuration so that users can disable request validation if they want to. To do so, add the following option to your generators.yml

  config: 
    skipRequestValidation: true

• Improvement: Remove unnecessary console.error statements whenever the server implementation throws an error. The router will now only log the warnings whenever an unrecognized error is thrown like so:

  try {
    ...
  } catch (error) {
      if (error instanceof errors.AcmeError) {
          console.warn(
              `Endpoint 'post' unexpectedly threw ${error.constructor.name}.` +
                  ` If this was intentional, please add ${error.constructor.name} to` +
                  " the endpoint's errors list in your Fern Definition."
          );
          await error.send(res);
      } else {
          res.status(500).json("Internal Server Error");
      }
      next(error);
  }

• Support V38 of the IR

[0.11.0-rc0] - 2024-04-12

• Feature: Add allowExtraFields option to permit extra fields in the returned response.

  - name: fernapi/fern-typscript-express
    version: 0.11.0-rc0
    ...
    config:
      allowExtraFields: true

[0.10.0] - 2024-04-09

• Support V37 of the IR.

[0.10.0-rc0] - 2024-04-02

• Feature: Add retainOriginalCasing option to preserve the naming convention expressed in the API. For example, the following Fern definition will generate a type like so:

types:
  GetUsersRequest
    properties:
      group_id: string

Before

export interface GetUsersRequest {
  groupId: string;
}

export interface GetUsersRequest = core.serialization.object({
 groupId: core.serialization.string("group_id")
})

export namespace GetUsersRequest {
  interface Raw {
    group_id: string
  }
}

After

export interface GetUsersRequest {
  group_id: string;
}

export interface GetUsersRequest = core.serialization.object({
 group_id: core.serialization.string()
})

export namespace GetUsersRequest {
  interface Raw {
    group_id: string
  }
}

[0.9.9] - 2024-03-22

• Fix: Compile started failing for express generators with the following error:

  error TS2688: Cannot find type definition file for 'mime'.
  
  The file is in the program because:
    Entry point for implicit type library 'mime'
  

  The root cause is because a breaking change was released in v4 of the mime library. This is now fixed because the generator resolves to v3 of the library as specified in this GitHub issue.

[0.9.8] - 2024-03-22

• Improvement: Enhance serde performance by reducing reliance on async behavior and lazy async dynamic imports.
• Internal: Shared generator notification and config parsing logic.

[0.9.7] - 2024-02-11

• Chore: Intialize this changelog