base-cloud-service v7.0.0

Base.Cloud.Service

Base.Cloud.Service it is a Node JS package that contains good practices and reusable common components. This package can be applied to any web component such as:

• Cloud Function
• Google App Engine
• Google Kubernate Engine
• Node Express Server

Getting Started

1. Install enviroment (NodeJS)
2. Install dependencies: npm install
3. Build: npm run build
4. Publish: npm publish

Build and Test

• Build: npm run build
• Test: npm run test
• TDD: npm run tdd

Documentation

Table of Contents

• Entity
  • BaseEntity
  • BaseList
• Error
  • CustomErrorHandler
  • ErrorResponse
• Filter
• ErrorHandlerMiddleware
• Order
• Utils
  • QueryRequest
  • Logger
  • ConsoleLogger
  • WinstonLogger
  • RedisCacheManager
  • GetValidation
• Repository
  • BaseDatastoreRepository
  • BaseFirestoreRepository
• Security
  • CloudKeyManagementService
  • FirebaseAuthenticationService
  • FirebaseAuthorizationService
  • GoogleAuthenticationService
  • GoogleAuthorizationService
  • GooglePlatformAuthorizationService
  • TokenAuthorizationService
  • SecurityServiceLocator
• Service
  • CryptoEncryptionService
  • GooglePubsubService
  • RequestService

Entity

Class set to manage entities in the Database

BaseEntity

Base Class for Entities

BaseList

Base List Class for Entities

Error

Class set to handle application errors

CustomErrorHandler

Handling application errors

ErrorResponse

HttpError type class to represent errors

Filter

Class to handle multiple filters in the databases

ErrorHandlerMiddleware

Middleware to handle application errors

Order

Class to handle order in the database

Utils

Utility package set for NodeJS components

QueryRequest

Class to handle queries to the database

Logger

Generic class to handle logger in applications

ConsoleLogger

Console handle logger in applications

WinstonLogger

Winston handle logger in applications

RedisCacheManager

Class to handle the connection to the Redis cache

GetValidation

Method to validate entities

Repository

Repositories package set for NodeJS components

BaseDatastoreRepository

Base repository for Google Datastore

BaseFirestoreRepository

Base repository for Google Firestore

Security

Security package set for NodeJS components

CloudKeyManagementService

Service responsible for managing integration with Cloud Key Management Service

FirebaseAuthenticationService

Service responsible for managing authentication with Firebase Administrator

FirebaseAuthorizationService

Service responsible for managing authorization with Firebase Administrator

GoogleAuthenticationService

Service responsible for managing authentication with Google AUTH

GoogleAuthorizationService

Service responsible for managing authorization with Google AUTH

GooglePlatformAuthorizationService

Service responsible for managing authorization for Google Plataform

TokenAuthorizationService

(Obsolete) Service responsible for handling static tokens

SecurityServiceLocator

Service responsible for the management of all security services

Service

Service package set for NodeJS components

CryptoEncryptionService

Service responsible for handling encrypted data with Crypto

GooglePubsubService

Service responsible for managing integration with Google PubSub Service

RequestService

Service responsible for managing integration with HTTP Request

Contribute

If you are interested in fixing issues and contributing directly to the code, please contact to the project manager. Here is how you can contribute to Base.Cloud.Service:

• Submit bugs and help us verify fixes
• Submit pull requests for bug fixes and features and discuss existing proposals

Copyright(�) Todos los derechos reservados