ampersand-common-module

Latest Version: v1.0.30

📦 Overview

ampersand-common-module contains the shared backend modules used across the HubbleOrion ERP ecosystem.
It centralizes commonly used functionality to ensure standardization, reduce duplication, and improve maintainability across microservices.

📚 Included Modules

🔐 Auth

Provides Redis-based authentication helpers and a slug middleware for securing API routes.

📝 Audit Log

Captures critical user actions and trackable events performed within the ERP.

⚙️ Constants

Central repository of constants used across services, ensuring consistency.

📁 File Upload

End-to-end module for uploading, retrieving, and managing files from Cloud Storage or Local Storage.

📄 Swagger Helpers

Wrapper utilities over Swagger decorators to simplify repetitive API documentation code.

📨 Kafka Helpers

Utility abstractions for Kafka producers and consumers, enabling consistent message flows across microservices.

📊 Excel Import/Export

Utility toolkit for importing and exporting data in Excel/CSV formats.

🧰 Utils

A set of globally reusable utility functions.

🚀 Publishing Guide

Follow the steps below to publish a new version of the package.

1. Build the package

npm run build

2. Push the code to the main branch

3. Update the version number in package.json and README.md file

4. Run the below command to login into npm

npm login

5. After successful login, run the below command

npm publish