Disclaimer

This is a package developed developed for internal use only. You are free to download, use and modify as you wish, for both private and public purposes and for either commercial or not applications. However, we do not offer any kind of support or warranty, under any circumstances whatsoever, when you choose to do so.

By using it in any form or means, you agree that you are doing it on your own risk, and cannot hold us either liable or accountable for any usage on your application.

We will not accept any form of contributions to this package (either via source code management - pull requests - or any other way, such as email).

We do not always follow semver strictly - meaning that, if you choose to use it, you also accept that there may be unexpected breaking changes and this package may behavior not according to your expectations.

At the end of the day, you should not use this package.

Introduction

This package is a collection of common and shared helper function, methods and classes.

Getting started

After cloning the repo, install the dependencies:

npm install

There are no applications involved here, so there's no execution step.

Tests

To run the automated unit tests, simply run:

npm test

Publishing

To publish a new version of this package, you first must be associated to the @wpp-dti-aca organization[^1]. After that, you just need to update the version in package.json and run:

npm publish

Please note that the unit tests will be run before publishing, and if it fails, the publishing process will stop - i.e., a new publication will only happen if all the tests are passing.

[^1]: if you need, you can request it via email to (lucas.vilasboas@dtidigital)[mailto:[email protected]]. It will only be granted if your association makes sense.

Folder structure

.
├── coverage            # jest coverage report
├── dist                # built source code
├── src                 # source code
    ├── common
    ├── constants
    ├── entities
    ├── helpers
    ├── infrastructure
    ├── middlewares
    ├── types
├── tests               # unit tests

./src

./src/common

Contains implementation of helper methods and classes, such as the abstract base classes of Controller and UseCase, along with the Logger class (which abstracts all of the setup required to log messages), and the Stopwatch class, which allows time execution functionality.

./src/constants

Contains implementation of constants, such as Exception and Http (methods and statuses).

./src/entities

Contains business models, representing also the schema of database entities.

./src/helpers

Context-specific helper methods (such as StringHelper and DateHelper, for instance).

./infrastructure

Contains abstractions of infrastructure-specific configurations and setup - such as BigQuery, ApiClient (for API communication) and MemCache (for managing in-memory caching).

./middlewares

Contains middlewares for usage on API setups.

./types

Contains type merging definitions.