@adaas/a-utils 0.1.14 → 0.1.16

package/README.md

@@ -2,13 +2,36 @@
 
 # A-Utils SDK 
 
+![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)
+![Node.js](https://img.shields.io/badge/Node.js-43853D?style=for-the-badge&logo=node.js&logoColor=white)
+![Jest](https://img.shields.io/badge/Jest-323330?style=for-the-badge&logo=Jest&logoColor=white)
+![npm](https://img.shields.io/badge/npm-CB3837?style=for-the-badge&logo=npm&logoColor=white)
+
+![License](https://img.shields.io/badge/license-ISC-blue.svg)
+![Version](https://img.shields.io/npm/v/@adaas/a-utils)
+![Downloads](https://img.shields.io/npm/dm/@adaas/a-utils)
+![Build Status](https://img.shields.io/badge/build-passing-brightgreen)
+
 This package is a set of common utilities that can be used across projects related or not related to ADAAS Ecosystem. 
 In this package it is possible to find useful features to work with structures, objects, types, commands, configuration management, logging, scheduling, and more.  
 
 
 | LTS | Latest | npm               |
 |---------------|----------|---------------------------|
-| v0.1.7      |   v0.1.7    |     [@adaas/a-utils](https://npm.com)    |
+| v0.1.14      |   v0.1.14    |     [@adaas/a-utils](https://www.npmjs.com/package/@adaas/a-utils)    |
+
+
+## ✨ Key Features
+
+🚀 **Communication Channels** - Structured messaging with lifecycle management  
+⚡ **Command Pattern** - Event-driven command execution with serialization  
+🔧 **Configuration Management** - Multi-source config with type safety  
+📝 **Smart Logging** - Scope-aware logging with color support  
+🛡️ **Access Control** - Regex-based permission management  
+💾 **Memory Management** - Type-safe intermediate value storage  
+📅 **Task Scheduling** - Promise-based scheduling with cancellation  
+🔌 **Polyfills** - Cross-environment compatibility  
+🏗️ **Component Architecture** - Extensible dependency injection system
 
 
 <!-- TABLE OF CONTENTS -->
@@ -16,6 +39,7 @@ In this package it is possible to find useful features to work with structures,
 
 - [About the Project](#overview)
 - [Installation](#installation)
+- [Key Features](#-key-features)
 - [Components](#components)
   - [A-Channel](#a-channel)
   - [A-Command](#a-command)
@@ -69,7 +93,7 @@ class HttpChannel extends A_Channel {}
 class HttpProcessor extends A_Component {
     @A_Feature.Extend({ scope: [HttpChannel] })
     async [A_ChannelFeatures.onRequest](
-        @A_Inject(A_ChannelRequestContext) context: A_ChannelRequestContext
+        @A_Inject(A_ChannelRequest) context: A_ChannelRequest
     ) {
         const response = await fetch(context.params.url);
         (context as any)._result = await response.json();
@@ -225,32 +249,82 @@ const configLoader = new A_ConfigLoader();
 
 ### A-Logger
 
-A comprehensive logging system with color support, scope awareness, and configurable output formatting.
+A sophisticated logging component with advanced formatting, scope-based organization, and configurable output levels for ADAAS applications.
 
 **Basic Usage:**
 ```typescript
 import { A_Logger } from '@adaas/a-utils';
 import { A_Scope } from '@adaas/a-concept';
 
-const scope = new A_Scope({
-    name: 'MyApp',
-    components: [A_Logger]
-});
+const scope = new A_Scope({ name: 'MyService' });
+const logger = new A_Logger(scope);
+
+// Basic logging with colors
+logger.log('Application started');
+logger.log('green', 'Operation successful');
+logger.warning('Resource usage high');
+logger.error('Database connection failed');
+
+// Object logging with formatting
+const user = { id: 1, name: 'John', active: true };
+logger.log('blue', 'User data:', user);
+
+// Multi-argument logging
+logger.log('green', 
+    'Processing complete:',
+    'Records:', 150,
+    'Errors:', 2,
+    'Success rate:', '98.7%'
+);
+```
+
+**Advanced Features:**
+```typescript
+// Error handling with context
+try {
+    throw new Error('Database timeout');
+} catch (error) {
+    logger.error('Operation failed:', error, 'Context:', { 
+        userId: '123', 
+        operation: 'update' 
+    });
+}
 
-const logger = scope.resolve(A_Logger);
+// Log level filtering (via A_LOGGER_LEVEL env var)
+// Levels: debug, info, warn, error, all
+process.env.A_LOGGER_LEVEL = 'warn'; // Only warnings and errors
 
-logger.log('Hello World');
-logger.error('Something went wrong');
-logger.warning('This is a warning');
-logger.success('Operation completed');
+// Scope alignment - all messages align consistently
+const services = [
+    new A_Logger(new A_Scope({ name: 'API' })),
+    new A_Logger(new A_Scope({ name: 'DatabaseConnectionPool' })),
+    new A_Logger(new A_Scope({ name: 'Auth' }))
+];
 ```
 
-**Features:**
-- Colored console output
-- Scope-aware logging
-- Multiple log levels (log, error, warning, success)
-- Integration with A-Config for configuration
-- Formatted output with timestamps and scope information
+**Key Features:**
+- ✅ **Scope-based Formatting** - Consistent message alignment regardless of scope name length
+- ✅ **9 Terminal Colors** - green, blue, red, yellow, gray, magenta, cyan, white, pink
+- ✅ **Object Pretty-printing** - JSON formatting with proper indentation
+- ✅ **Error Handling** - Special formatting for A_Error and standard Error objects
+- ✅ **Log Level Filtering** - Configurable filtering (debug, info, warn, error, all)
+- ✅ **Performance Optimized** - Efficient handling of large objects and rapid logging
+- ✅ **Multi-line Support** - Proper alignment for complex multi-argument logs
+- ✅ **Timestamp Integration** - High-precision timestamps (MM:SS:mmm format)
+
+**Output Examples:**
+```
+[API                 ] |15:42:123| Operation successful
+[DatabaseConnectionPool] |15:42:124| Connection established
+[Auth                ] |15:42:125| User authenticated: {"id":1,"name":"John"}
+```
+
+**Log Levels:**
+- `debug` - Shows all messages
+- `info` - Shows info, warning, and error messages  
+- `warn` - Shows warning and error messages only
+- `error` - Shows error messages only
+- `all` - Shows all messages (default)
 
 ---