Skip to content

Latest commit

 

History

History
392 lines (211 loc) · 12.8 KB

CHANGELOG.md

File metadata and controls

392 lines (211 loc) · 12.8 KB

Change Log

5.3.0

Minor Changes

  • 5bf006d: Create a child method to allow for creating new loggers with existing options

Patch Changes

5.2.1

Patch Changes

  • 48dbd4d: Explicitly set the styler type

5.2.0

Minor Changes

  • e940f93: The @ogma/styler instance is now exposed at the .style property of ogma

Patch Changes

5.1.4

Patch Changes

  • 02cd763: Upgrade reflect-metadata to v0.2.1 and update peer dependency range

5.1.3

Patch Changes

  • 99b3be9: OgmaService properly returns the OgmaService instance when changing the log level, insterad of the underkying Ogma class instance
  • Updated dependencies [6cd729d]

5.1.2

Patch Changes

  • 1ec5683: Properly handle observable and promise errors for the @Log() decorator

5.1.1

Patch Changes

  • 18c0d5f: Update the service options provider to correctly pass on the options to the ogma creation process
  • Updated dependencies [743cf48]

5.1.0

Minor Changes

  • 15b6f6f: Allow the log level to be changed during runtime

Patch Changes

5.0.1

Patch Changes

  • c970428: Warn if there are multiple parsers installed of the same type

5.0.0

Major Changes

  • 36ff6d0: New parser format and module options

    With the new version, there is no longer a need toseparate the service and interceptor options.As such, the options passed to the module are now the same as those passed to Ogma directly plus a traceMethod property for the @Log() decorator.

    As for the parsers that were originally passed to interceptor.[type], they should now be registered directly as providers so that the discovery service can find them on application start.

    FOR ANY CUSTOM EXISTING PARSERS

    Add the @Parser() decorator to your parser and pass in the context in which it should be called. This should match what context.getType() or host.getType() returns

Minor Changes

  • 84c799f: Update @ogma/styler to 2.0.0

Patch Changes

4.2.3

Patch Changes

  • 7ce391c: chore(deps): fix peer dependency typo in nestjs-module
  • dd5215e: Security updates of dependencies. Should be nothing major here.
  • Updated dependencies [dd5215e]

4.2.2

Patch Changes

  • 33c279b: Fix dependencies for better install experience

    @ogma/logger

    @ogma/common and @ogma/styler were set as peerDependencies instead of dependencies meaning package managers wouldn't install them by default. They are now properly set as dependencies

    @ogma/nestjs-module

    @ogma/logger was set as a peerDependency instead of a dependency. Now has been set to a dependency.

  • Updated dependencies [33c279b]

4.2.1

Patch Changes

  • a4a01af: Fixed the published peer dependencies of each package

4.2.0

Minor Changes

  • 4327443: Allow for logging out the response body as well

    While technically this is a breaking change in the getContextSuccessString method, passing the data object instead of the buffer length, to my knowledge there are no custom parsers out there that make use of this method and all @ogma/* parsers have been checked that no changes are necessary for them. If this does end up breaking something for someone, I'm sorry.

4.1.1

Patch Changes

4.1.0

Minor Changes

  • 2f5ccce: Allow for printing of each array value

4.0.1

Patch Changes

  • 6f7b8cb: fix: add application property in OgmaServiceMeta

4.0.0

Major Changes

  • e82c80b: NestJS v9 Support

    Features

    • Use the new ConfigurableModuleBuilder from @nestjs/common@9
    • Support Fastify v4
      • As a side effect, @ogma/platform-graphql-fastify can only be used with @nestjs/mercurius until apollo-server-fastify supports v4

    How to Upgrade

    Run your preferred pacakge manager's method of ugrading. There's no code chagnes necessary to the ogma imports, but implications of underlying packages that should be taken into consideration

3.3.1

Patch Changes

  • a674a96: fix defect in @Log decorator that produces an error when the original function was called

3.3.0

Minor Changes

  • 828ad94: made determineStatusCodeFromError protected (instead of private) to be able to override it in child classes

3.2.2

Patch Changes

  • 50f7664: Add peer dependencie on @ogma/logger for @ogma/nestjs-module and set up peerDependenciesMeta for better package manager integration

3.2.1

Patch Changes

  • 43e2854: Updated the doc string for the OgmaService log methods

3.2.0

Minor Changes

3.1.1

Patch Changes

  • d0217ad: patch: remove extra blank line print from printError.

3.1.0

Minor Changes

  • 384fc2b: Extra metadata can now be logged in interceptors by using a custom parser and the getMeta method

3.0.1

Patch Changes

  • 329f92a: Set the main file in the package.json correctly based on the proper publish method

3.0.0

Major Changes

  • 5e51fdc: Update package versions to work with Nest v8

    Breaking Changes

    For @ogma/nestjs-module and all of the @ogma/platform-* packages, Nest v8 is the supported package version. Nest v7 may still continue to work, but has no guarantees. Also, RxJS is upgraded to v7 to stay inline with Nest's expectations.

    Why the change was made

    To stay current with Nest.

    How to upgrade

    Upgrade with Nest v8. There shouldn't be any breaking underlying changes, but you can never be too careful with coded upgrades.

2.0.2

Patch Changes

2.0.1

Patch Changes

2.0.0

Major Changes

  • 8bea02f: Release of @ogma/common and @ogma/styler. Upgrade @ogma/nestjs-module to be 100% compatible with Nest's logger

    Breaking Changes

    • @ogma/logger now depends on @ogma/common and @ogma/styler for types and string styling, instead of managing it on its own
    • @ogma/nestjs-module now accepts trace as the second parameter to error instead of context. meta can still be passed as a second parameter too or it can be a third parameter.
    • @ogma/logger now sets an ool property when logging in JSON mode to accommodate when using a custom log map
    • @ogma/logger no longer needs the stream property to have a hasColor function
    • @ogma/cli now reads from the ool property instead level to allow writing back to Ogma's standard format

    Features

    • @ogma/logger now correctly logs Error objects the same way process.stdout does instead of logging {}
    • @ogma/logger can accept a levelMap property for custom level mapping
    • @ogma/logger's stream option can now have a getColorDepth property method, but it is not necessary

    Why

    I wanted to be able to have full control over string styles and this gave me a great chance to learn about SGRs and how they work. Along with that, this gave me the perfect opportunity to make some changes to the logger to be more compliant with Nest's logger and have better compatibility with it.

    How to Upgrade

    I tried to make this is painless as possible in terms of breaking changes. For the most part, you should just be able to upgrade with no problems. If you have a stream with hasColor you will need to remove that method. You may want to add in the getColorDepth method, but can also just use FORCE_COLOR if necessary.

Patch Changes

1.0.0

Major Changes

  • bbf66f6: Major release of @ogma

    The ogma command has been moved from @ogma/logger to @ogma/cli. There are no other breaking changes. This change was made to keep the package size as small as possible and to keep the code clean and maintainable.

Patch Changes

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

0.4.3 (2020-10-30)

Features

  • interceptor: getRequestId now optionally accepts ExecutionContext (130b9e6), closes #326

0.4.2 (2020-10-26)

Note: Version bump only for package @ogma/nestjs-module

0.4.1 (2020-10-25)

Bug Fixes

  • service: fixes logger methods to follow LoggerService interface (f1fd191)

0.4.0 (2020-10-25)

Features

BREAKING CHANGES

  • all: log methods now take an object as the second parameter instead of having 3 extra optional parameters

0.3.1 (2020-09-12)

Features

  • module: adds a forFeatures method to the module (e7f5df1)

0.3.0 (2020-09-05)

Bug Fixes

  • module: add requestId check to printMessage (97bcda7)

Features

  • all: add request id generation and log (00fd8c7)
  • module: remove registration of global interceptor (fdf5ef7)

0.2.2 (2020-08-10)

Note: Version bump only for package @ogma/nestjs-module

0.2.1 (2020-07-25)

Bug Fixes

  • all: fixes OgmaCoreModule not configured (c7cd6d7), closes #106

Features

  • module: adds export for createProviderToken (9b0b43f)

0.2.0 (2020-07-20)

0.2.0 (2020-07-20)

Note: Version bump only for package @ogma/nestjs-module

0.1.2 (2020-07-18)

Bug Fixes

  • module: updates decorators type to accept a class (1bc3df7)

0.1.1 (2020-07-18)

Bug Fixes

  • gql: updates gql types to work with apollo > 2.11 (a097842)

0.1.0 (2020-04-20)

Bug Fixes

  • interceptor: adds case to skip over graphql subscriptions (1e35310)

Features

  • gql: implements gql parser for express (9290504), closes #14
  • module: implements plugin system for interceptor context parser (d116da3), closes #7 #8 #9 #10 #11
  • module: let base module work for http express (1bb52a7)