@soinlabs/hawk/CHANGELOG.md

Package to better manage errors, logs, and its notifications

# Changelog

All notable changes to this project will be documented in this file. All new
features will be always listed first.

## [1.0.1] - 2025-05-16

- Upgrade axios, winston and @slack/webhook

## [1.0.0] - 2024-06-03

- Remove # on methods and classes
- Updated CHANGELOG.md
- Updated Dependencies to the latest version
- Support for node 20

## [0.3.0] - 2021-09-16

- Incorporate Hawk class with his unit test

## [0.1.0] - 2021-07-09

## Logger, FileWriter

- New feature: added log rotation

  ```//
      var rotateTransport = new DailyRotateFile({
      filename: path.join(dir, fileName),
      dirname: dir,
      datePattern: datepattern || "YYYY-MM-DD",
      maxSize: maxsize || "20m",
      maxFiles: maxfiles || "3d",
      level: log.level,
      handleExceptions: true,
    });
  ```

## Features [0.0.3] - 2021-06-04

- Logger: an object for creating logs and send messages to slack (when is
  required)

  - FileWriter: an object for creating and handling files

  ```//
      const logger = new Logger({
        path: join(__dirname, hawkLogs.logsPath),
        slackToken: hawkLogs.slackToken,
      })

      logger.log(loggeableObject, logginLevel)
  ```

- LoggedError: an object for better manage of errors

  - StepGetter: a way to infer the step from stack trace

  ```//
      const newLoggedError = new LoggedError({
        message: "error",
        code: 404,
        toLog: false,
        referenceCode: "TEST",
        previousError: new Error("error")
      });
  ```

- ErrorBuilder: it is for creating errors with some default values (error
  templates for slack, log, elastic, all)

  ```//
    const ToLogError = ErrorBuilder.templateBuilder(ErrorBuilder.TO_LOG_TEMPLATE)
    const error = ToLogError();
  ```

## [0.0.3] - 2021-06-04

## Logger

- Fix bug: Slack webhook was imported in the wrong way

  - IncomingWebhook need to be desestructuring

    `const {IncomingWebhook} = require("@slack/webhook");`