samanbayaka 0.0.9 → 0.0.10

package/README.md

@@ -1,97 +1,159 @@
-# samanbayaka
+<p align="center" style="margin: 0;">
+  <img style="background-color: #000; border-radius: 30%;" src="https://unpkg.com/samanbayaka/public/favicon.svg" width="256" />
+</p>
 
-##check environment variable before start the server
-$echo $SBK_CONFIG_PATH
-$echo export SBK_PORT=87xx for gateway services
+# samanbayaka
 
+This project is a modular, production-ready microservices framework built with Moleculer and Moleculer-Web latest, using NATS as a high-performance messaging transporter and AJV for robust schema validation. It provides a scalable foundation for developing distributed Node.js applications, emphasizing fault tolerance, clean architecture, and efficient service communication. The system is designed to support flexible orchestration of services while maintaining strong validation and reliability across components.
 
+[![NPM version](https://img.shields.io/npm/v/samanbayaka.svg)](https://www.npmjs.com/package/samanbayaka)
+[![License](https://img.shields.io/npm/l/samanbayaka.svg)](LICENSE)
 
-## Getting started
+# Features
 
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+- Moleculer-based microservices architecture
+- NATS transporter for high-performance messaging
+- Redpanda transporter for persistent,robust and scalability.
+- In memory L1 cache and Redis cache for L2
+- Schema validation using AJV
+- Dynamic service loading (Gateway / Feature / Demo)
+- Graceful shutdown handling (SIGINT, SIGTERM)
+- Centralized error handling middleware
+- REPL support for debugging
+- Config-driven initialization
+- Metrics and Log shipping for Grafana
 
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
 
-## Add your files
 
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:
+# Installation
 
+```bash
+pnpm install samanbayaka
 ```
-cd existing_repo
-git remote add origin https://gitlab.com/dalal.suvendu/samanbayaka.git
-git branch -M main
-git push -uf origin main
+# Prerequisites
+It is assumed that NATS, Redpanda, and Redis are installed and properly configured. All services should be discoverable through the /etc/hosts file.
+#### Minimum required Node.js version: >= 22.x.x
+```bash
+node -v
+nvm use 22
 ```
 
-## Integrate with your tools
-
-- [ ] [Set up project integrations](https://gitlab.com/dalal.suvendu/samanbayaka/-/settings/integrations)
-
-## Collaborate with your team
-
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/)
-
-## Test and Deploy
-
-Use the built-in continuous integration in GitLab.
-
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
-
-***
-
-# Editing this README
-
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
-
-## Suggestions for a good README
-
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
-
-## Name
-Choose a self-explaining name for your project.
-
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
-
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+#### Environment variables
+To configure all required environment variables, copy the <your_project_name>/bash/sbk.sh file into the /etc/profile.d/ directory and update the environment variable values as needed. Before copying, ensure that your current working directory is the project directory.
+```bash
+pwd
+sudo cp bash/sbk.sh /etc/profile.d/
+source /etc/profile.d/sbk.sh
+```
+Optionally, you may verify the set environment variables.
+```bash
+echo $SBK_PORT
+```
+#### Configuration files
+Create a directory to store the configuration files, then copy all configuration files from the current project path into this directory and update them as needed. Before copying, ensure that your current working directory is the project directory.
+```bash
+pwd
+sudo mkdir -p /usr/local/etc/<your_project_name>
+sudo cp config/*.*  /usr/local/etc/<your_project_name>
+```
 
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
 
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+# Usage
+#### Create a service, gateway
+The gateway is an important service that exposes all endpoints as REST APIs. At least one Gateway service is mandatory in the project.
+```bash
+mkdir gateway
+cd gateway
+npm init -y
+pnpm install samanbayaka
+touch index.mjs
+```
 
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+Open and edit the index.mjs file as follows
+```bash
+import sbk from "samanbayaka"
+await sbk.loadGatewayService()
+```
+Run the service, gateway
+```bash
+node index.mjs
+```
 
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
 
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
+#### Create your endpoints as a feature service, such as a test service
+```bash
+mkdir test
+cd test
+npm init -y
+pnpm install samanbayaka
+touch index.mjs
+```
 
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
+Open and edit the index.mjs file as follows
+```bash
+import sbk from "samanbayaka"
+await sbk.loadFeatureService.mainBus({
+  name: "test",
+  version: "v1",
+
+  actions: {
+    hello: {
+      rest: {
+        method: "GET",
+        path: "/hello"
+      },
+
+      /**
+       * Enable caching to this action
+       */
+      cache: {
+
+        /**
+         * These cache entries will be expired after 5 seconds instead of 30.
+         */      
+        ttl: 2*60
+      },
+      handler(ctx){
+        return "Hello Samanbayaka"
+      }
+    },
+    welcome: {
+      rest: "GET /welcome",
+      handler(ctx) {
+        return `Welcome, ${ctx.params.query?.name || "Guest"} - ${ctx.broker.nodeID}`
+      }
+    },
+    createUser
+  },
+})
 
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+```
+Run the service, test
+```bash
+node index.mjs
+```
+# Demo
+You can also run the demo service to better understand how the system works.
+```bash
+mkdir demo
+cd demo
+npm init -y
+pnpm install samanbayaka
+touch demo.mjs
+```
+Open and edit the demo.mjs file as follows
+```bash
+import sbk from "samanbayaka"
+await sbk.loadDemo()
+```
+Run the service, demo
+```bash
+node demo.mjs
+```
 
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
 
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
 
-## License
-For open source projects, say how it is licensed.
 
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
+<p align="center" style="margin-top: 100px;">
+  <img src="https://moleculer.services/images/banner.png" alt="Moleculer Logo" width="600">
+</p>

package/bash/sbk.sh

@@ -5,7 +5,10 @@
 ###############################################################################
 
 ##Configurations files path
-$export SBK_CONFIG_PATH="/usr/local/etc/your_folder"
+export SBK_CONFIG_PATH="/usr/local/etc/your_folder"
 
 ##web server port 8760-8769
-$export SBK_PORT=8765
+export SBK_PORT=8765
+
+##
+export SBK_LOG_LEVEL=info

package/commit-hash.mjs

@@ -1 +1 @@
-export const COMMIT_HASH = 'd6d0b66';
+export const COMMIT_HASH = '95e0f1a';

package/config/broker.mjs

@@ -156,4 +156,6 @@ export default Object.freeze({
   metadata: {
       // region: "eu-west1"
   },
+
+  logLevel: "trace",
 })

package/config/logger.mjs

@@ -1,35 +1,35 @@
 /*logger.mjs*/
 export default Object.freeze({
-  type: "Console",
+  type: "Pino",
   options: {
     /**
      * Logging level
      */
     level: "info",
 
-    /**
-     * Using colors on the output
-     */
-    colors: true,
+    // /**
+    //  * Using colors on the output
+    //  */
+    // colors: true,
 
-    /**
-     * Print module names with different colors (like docker-compose for containers)
-     */
-    moduleColors: true,
+    // /**
+    //  * Print module names with different colors (like docker-compose for containers)
+    //  */
+    // moduleColors: true,
 
-    /**
-     * Line formatter. It can be "json", "short", "simple", "full", a `Function` or a template string like "{timestamp} {level} {nodeID}/{mod}: {msg}"
-     */
-    formatter: "full",
+    // /**
+    //  * Line formatter. It can be "json", "short", "simple", "full", a `Function` or a template string like "{timestamp} {level} {nodeID}/{mod}: {msg}"
+    //  */
+    // formatter: "full",
 
-    /**
-     * Custom object printer. If not defined, it uses the `util.inspect` method.
-     */
-    objectPrinter: null,
+    // /**
+    //  * Custom object printer. If not defined, it uses the `util.inspect` method.
+    //  */
+    // objectPrinter: null,
 
-    /**
-     * Auto-padding the module name in order to messages begin at the same column.
-     */
-    autoPadding: false
+    // /**
+    //  * Auto-padding the module name in order to messages begin at the same column.
+    //  */
+    // autoPadding: false
   }
 })