@aifabrix/miso-client 1.0.1 → 1.0.2

package/README.md

@@ -3,145 +3,446 @@
 [![npm version](https://badge.fury.io/js/%40aifabrix%2Fmiso-client.svg)](https://badge.fury.io/js/%40aifabrix%2Fmiso-client)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-The **AI Fabrix Miso Client SDK** is a TypeScript/JavaScript library that provides authentication, authorization, and logging capabilities for applications integrated with the AI Fabrix platform. It offers seamless integration with Keycloak authentication, Redis caching, and centralized logging.
+The **AI Fabrix Miso Client SDK** provides authentication, authorization, and logging for applications integrated with the AI Fabrix platform.
+
+## ✨ Benefits
+
+### 🔐 Enterprise Security
+
+**SSO and Federated Identity**
+- Single Sign-On (SSO) with Keycloak
+- OAuth 2.0 and OpenID Connect (OIDC) support
+- Multi-factor authentication (MFA) ready
+- Social login integration (Google, Microsoft, etc.)
+
+**Centralized Access Control**
+- Role-based access control (RBAC)
+- Fine-grained permissions
+- Dynamic policy enforcement
+- Attribute-based access control (ABAC)
+
+**API Security**
+- JWT token validation
+- API key authentication
+- Token revocation support
+- Secure token storage
+
+### 📊 Compliance & Audit
+
+**ISO 27001 Compliance**
+- Comprehensive audit trails for all user actions
+- Data access logging and monitoring
+- Security event tracking
+- Accountability and non-repudiation
+
+**Regulatory Compliance**
+- GDPR-ready data protection
+- HIPAA-compliant audit logging
+- SOC 2 audit trail requirements
+- Industry-standard security controls
+
+**Audit Capabilities**
+- Real-time audit event logging
+- Immutable audit records
+- Forensic analysis support
+- Compliance reporting automation
+
+### ⚡ Performance & Scalability
+
+**Intelligent Caching**
+- Redis-based role and permission caching
+- Configurable cache TTL (default: 15 minutes)
+- Automatic cache invalidation
+- Fallback to controller when Redis unavailable
+
+**High Availability**
+- Automatic failover to controller
+- Redundant infrastructure support
+- Load balancing compatible
+- Zero-downtime deployments
+
+**Optimized Network**
+- Efficient API calls with caching
+- Batch operations support
+- Connection pooling
+- Minimal latency
+
+### 🛠️ Developer Experience
+
+**Easy Integration**
+- Progressive activation (6-step setup)
+- Works with any framework (Express, Next.js, NestJS, Fastify)
+- TypeScript-first with full type definitions
+- Browser and Node.js support
+
+**Flexible Configuration**
+- Environment-based configuration
+- Support for dev, test, and production environments
+- Docker and Kubernetes ready
+- CI/CD friendly
+
+**Observability**
+- Centralized logging with correlation IDs
+- Performance tracking and metrics
+- Error tracking and debugging
+- Health monitoring
 
-## 🚀 Features
+---
 
-- **🔐 Authentication**: Token validation and user management
-- **🛡️ Authorization**: Role and permission-based access control
-- **📊 Logging**: Centralized logging with audit trails and API key authentication
-- **⚡ Caching**: Redis-based caching for improved performance
-- **🔄 Fallback**: Automatic fallback to controller when Redis is unavailable
-- **🔑 API Key Security**: Secure API key authentication for application logging
-- **📱 Multi-platform**: Works in Node.js and browser environments
-- **🔧 TypeScript**: Full TypeScript support with type definitions
+## 🚀 Quick Start
 
-## 📚 Documentation
+Get your application secured in 6 steps.
 
-- **[Getting Started](docs/getting-started.md)** - Installation and basic setup
-- **[API Reference](docs/api-reference.md)** - Complete API documentation
-- **[Configuration](docs/configuration.md)** - Configuration options and examples
-- **[Examples](docs/examples.md)** - Practical usage examples
-- **[Troubleshooting](docs/troubleshooting.md)** - Common issues and solutions
+### Step 1: Set Up Your Environment
+
+**What you need:**
+- Keycloak running for authentication
+- AI Fabrix Miso Controller running
 
-## 🏃‍♂️ Quick Start
+**First time setting up?** Use the [AI Fabrix Builder Quick Start](https://github.com/esystemsdev/aifabrix-builder/blob/main/docs/QUICK-START.md):
+
+```bash
+# Start infrastructure (Postgres, Redis)
+aifabrix up
+
+# Install Keycloak for authentication
+aifabrix create keycloak --port 8082 --database --template platform
+aifabrix build keycloak
+aifabrix run keycloak
+
+# Install Miso Controller
+aifabrix create miso-controller --port 3000 --database --redis --template platform
+aifabrix build miso-controller
+aifabrix run miso-controller
+```
+
+→ [Infrastructure Guide](https://github.com/esystemsdev/aifabrix-builder/blob/main/docs/INFRASTRUCTURE.md)
+
+**Already have Keycloak and Controller?** Skip to Step 2.
+
+---
+
+### Step 2: Install Miso Client
 
 ```bash
 npm install @aifabrix/miso-client
 ```
 
+**What you get:**
+- Authentication with Keycloak
+- Role-based access control (RBAC)
+- Centralized logging
+- Redis caching for performance
+
+---
+
+### Step 3: Activate Authentication
+
+**What happens:** Your app validates user tokens from Keycloak.
+
 ```typescript
 import { MisoClient } from '@aifabrix/miso-client';
 
+// Create client
 const client = new MisoClient({
   controllerUrl: 'https://controller.aifabrix.ai',
   environment: 'dev',
-  applicationKey: 'your-app-key',
-  applicationId: 'your-app-id-123', // NEW: Application GUID
-  apiKey: 'your-api-key', // NEW: API key for logging
-  redis: {
-    host: 'localhost',
-    port: 6379,
-    password: 'your-redis-password'
-  }
+  applicationKey: 'my-app',
+  applicationId: 'my-app-id-123',
 });
 
 await client.initialize();
 
-// Validate user token
-const isValid = await client.validateToken(userToken);
+// Validate token from request
+const token = req.headers.authorization?.replace('Bearer ', '');
+const isValid = await client.validateToken(token);
+
 if (isValid) {
-  const user = await client.getUser(userToken);
-  const roles = await client.getRoles(userToken);
+  const user = await client.getUser(token);
+  console.log('User:', user);
+}
+```
+
+**Where to get tokens?** Users authenticate via Keycloak, then your app receives JWTs in the `Authorization` header.
+
+→ [Complete authentication example](examples/step-3-authentication.ts)
+
+---
+
+### Step 4: Activate RBAC (Roles)
+
+**What happens:** Check user roles to control access. Roles are cached in Redis for performance.
+
+```typescript
+// Build on Step 3 - add Redis for caching
+const client = new MisoClient({
+  controllerUrl: 'https://controller.aifabrix.ai',
+  environment: 'dev',
+  applicationKey: 'my-app',
+  applicationId: 'my-app-id-123',
+  redis: { host: 'localhost', port: 6379 }, // Add Redis
+});
 
-  // Check permissions
-  const canEdit = await client.hasPermission(userToken, 'edit:content');
+await client.initialize();
+
+const token = req.headers.authorization?.replace('Bearer ', '');
+
+// Check if user has role
+const isAdmin = await client.hasRole(token, 'admin');
+const roles = await client.getRoles(token);
 
-  // Log events (now with API key authentication)
-  client.log.audit('user.login', 'authentication', { userId: user.id });
+// Gate features by role
+if (isAdmin) {
+  // Show admin panel
 }
 ```
 
-## 🏗️ Architecture
+**Pro tip:** Without Redis, checks go to the controller. Add Redis to cache role lookups (15-minute default TTL).
 
-The Miso Client SDK consists of several core services:
+→ [Complete RBAC example](examples/step-4-rbac.ts)  
+→ [RBAC Configuration](https://github.com/esystemsdev/aifabrix-builder/blob/main/docs/QUICK-START.md#step-3-create-your-app)
 
-- **AuthService**: Handles token validation and user authentication
-- **RoleService**: Manages user roles with Redis caching
-- **PermissionService**: Handles fine-grained permissions
-- **LoggerService**: Centralized logging and audit trails
-- **RedisService**: Caching and queue management
+---
 
-## 🔧 Configuration
+### Step 5: Activate Logging
+
+**What happens:** Application logs are sent to the Miso Controller with API key authentication.
+
+```typescript
+// Add API key for logging
+const client = new MisoClient({
+  controllerUrl: 'https://controller.aifabrix.ai',
+  environment: 'dev',
+  applicationKey: 'my-app',
+  applicationId: 'my-app-id-123',
+  apiKey: 'dev-my-app-my-app-id-123-a1b2c3d4e5f6', // NEW: API key
+  redis: { host: 'localhost', port: 6379 },
+});
+
+await client.initialize();
+
+const token = req.headers.authorization?.replace('Bearer ', '');
+const user = await client.getUser(token);
+
+// Log messages
+await client.log.info('User accessed dashboard', { userId: user?.id });
+await client.log.error('Operation failed', { error: err.message });
+await client.log.warn('Unusual activity', { details: '...' });
+```
+
+**API key format:** `{environment}-{applicationKey}-{applicationId}-{randomString}`
+
+**What happens to logs?** They're sent to the Miso Controller for centralized monitoring and analysis.
 
-The SDK supports flexible configuration options:
+→ [Complete logging example](examples/step-5-logging.ts)  
+→ [Logging Reference](docs/api-reference.md#logger-service)
+
+---
+
+### Step 6: Activate Audit
+
+**What happens:** Create audit trails for compliance and security monitoring.
+
+```typescript
+// Complete configuration
+const client = new MisoClient({
+  controllerUrl: 'https://controller.aifabrix.ai',
+  environment: 'dev',
+  applicationKey: 'my-app',
+  applicationId: 'my-app-id-123',
+  apiKey: 'dev-my-app-my-app-id-123-a1b2c3d4e5f6',
+  redis: { host: 'localhost', port: 6379, password: 'optional' },
+  logLevel: 'info',
+  cache: { roleTTL: 900, permissionTTL: 900 },
+});
+
+await client.initialize();
+
+const token = req.headers.authorization?.replace('Bearer ', '');
+const isValid = await client.validateToken(token);
+const canEdit = await client.hasPermission(token, 'edit:content');
+
+// Audit: User actions
+await client.log.audit('user.login', 'authentication', {
+  userId: user?.id,
+  ip: req.ip,
+  userAgent: req.headers['user-agent'],
+});
+
+// Audit: Content changes
+await client.log.audit('post.created', 'content', {
+  userId: user?.id,
+  postId: 'post-123',
+  postTitle: req.body.title,
+});
+
+// Audit: Permission checks
+await client.log.audit('access.denied', 'authorization', {
+  userId: user?.id,
+  requiredPermission: 'edit:content',
+  resource: 'posts',
+});
+```
+
+**What to audit:** Login/logout, permission checks, content creation/deletion, role changes, sensitive operations.
+
+→ [Complete audit example](examples/step-6-audit.ts)  
+→ [Best Practices](docs/getting-started.md#common-patterns)
+
+---
+
+## 🔧 Configuration
 
 ```typescript
 interface MisoClientConfig {
-  controllerUrl: string; // AI Fabrix controller URL
-  environment: 'dev' | 'tst' | 'pro'; // Environment
-  applicationKey: string; // Your application identifier
-  applicationId: string; // NEW: Application GUID
-  apiKey?: string; // NEW: API key for logging authentication
-  redis?: RedisConfig; // Optional Redis configuration
+  controllerUrl: string;      // Required: Controller URL
+  environment: 'dev' | 'tst' | 'pro'; // Required: Environment
+  applicationKey: string;     // Required: App identifier
+  applicationId: string;      // Required: App GUID
+  apiKey?: string;            // Optional: For logging
+  redis?: RedisConfig;         // Optional: For caching
   logLevel?: 'debug' | 'info' | 'warn' | 'error';
   cache?: {
-    roleTTL?: number; // Role cache TTL (default: 15 minutes)
-    permissionTTL?: number; // Permission cache TTL (default: 15 minutes)
+    roleTTL?: number;         // Role cache TTL (default: 900s)
+    permissionTTL?: number;   // Permission cache TTL (default: 900s)
   };
 }
 ```
 
+→ [Complete Configuration Reference](docs/configuration.md)
+
+---
+
+## 📚 Documentation
+
+- **[Getting Started](docs/getting-started.md)** - Detailed setup guide
+- **[API Reference](docs/api-reference.md)** - Complete API documentation
+- **[Configuration](docs/configuration.md)** - Configuration options
+- **[Examples](docs/examples.md)** - Framework-specific examples
+- **[Troubleshooting](docs/troubleshooting.md)** - Common issues and solutions
+
+---
+
+## 🏗️ Architecture
+
+The SDK consists of five core services:
+
+- **AuthService** - Token validation and user authentication
+- **RoleService** - Role management with Redis caching
+- **PermissionService** - Fine-grained permissions
+- **LoggerService** - Centralized logging with API key authentication
+- **RedisService** - Caching and queue management (optional)
+
+→ [Architecture Details](docs/api-reference.md#architecture)
+
+---
+
 ## 🌐 Environments
 
 The SDK supports three environments:
 
 - **`dev`** - Development environment
-- **`tst`** - Test environment
+- **`tst`** - Test environment  
 - **`pro`** - Production environment
 
-## 📦 Installation
+Each environment uses different controller endpoints and API keys.
 
-### NPM
+---
 
-```bash
-npm install @aifabrix/miso-client
+## 💡 Next Steps
+
+### Learn More
+- [Express.js Middleware](docs/examples.md#expressjs-middleware) - Protect API routes
+- [React Authentication](docs/examples.md#react-authentication) - Frontend auth
+- [NestJS Guards](docs/examples.md#nestjs-guards) - Decorator-based auth
+- [Error Handling](docs/examples.md#error-handling) - Best practices
+
+### Common Tasks
+
+**Add authentication middleware:**
+```typescript
+app.use(async (req, res, next) => {
+  const token = req.headers.authorization?.replace('Bearer ', '');
+  const isValid = await client.validateToken(token);
+  if (isValid) {
+    req.user = await client.getUser(token);
+  }
+  next();
+});
 ```
 
-### Yarn
+**Protect routes by role:**
+```typescript
+app.get('/admin', async (req, res) => {
+  const token = req.headers.authorization?.replace('Bearer ', '');
+  const isAdmin = await client.hasRole(token, 'admin');
+  if (!isAdmin) return res.status(403).json({ error: 'Forbidden' });
+  // Admin only code
+});
+```
 
+**Use environment variables:**
 ```bash
-yarn add @aifabrix/miso-client
+MISO_CONTROLLER_URL=https://controller.aifabrix.ai
+MISO_ENVIRONMENT=dev
+MISO_APPLICATION_KEY=my-app
+MISO_APPLICATION_ID=my-app-id-123
+MISO_API_KEY=dev-my-app-my-app-id-123-a1b2c3d4e5f6
+REDIS_HOST=localhost
+REDIS_PORT=6379
 ```
 
-### PNPM
+---
+
+## 🐛 Troubleshooting
+
+**"Cannot connect to controller"**  
+→ Verify `controllerUrl` is correct and accessible  
+→ Check network connectivity
+
+**"Redis connection failed"**  
+→ SDK falls back to controller-only mode (slower but works)  
+→ Fix: `aifabrix up` to start Redis
+
+**"Invalid API key for logging"**  
+→ Check API key format: `{environment}-{applicationKey}-{applicationId}-{randomString}`  
+→ Verify key is configured in controller
+
+**"Token validation fails"**  
+→ Ensure Keycloak is running and configured correctly  
+→ Verify token is from correct Keycloak instance
+
+→ [More Help](docs/troubleshooting.md)
+
+---
+
+## 📦 Installation
 
 ```bash
+# NPM
+npm install @aifabrix/miso-client
+
+# Yarn
+yarn add @aifabrix/miso-client
+
+# PNPM
 pnpm add @aifabrix/miso-client
 ```
 
+---
+
 ## 🔗 Links
 
 - **GitHub Repository**: [https://github.com/esystemsdev/aifabrix-miso-client](https://github.com/esystemsdev/aifabrix-miso-client)
-- **Documentation**: [https://github.com/esystemsdev/aifabrix-miso-client](https://github.com/esystemsdev/aifabrix-miso-client)
+- **Builder Documentation**: [https://github.com/esystemsdev/aifabrix-builder](https://github.com/esystemsdev/aifabrix-builder)
 - **Issues**: [https://github.com/esystemsdev/aifabrix-miso-client/issues](https://github.com/esystemsdev/aifabrix-miso-client/issues)
 
+---
+
 ## 📄 License
 
 This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
 
-## 🤝 Contributing
-
-Contributions are welcome! Please read our contributing guidelines and submit pull requests to our GitHub repository.
-
-## 📞 Support
-
-For support and questions:
-
-- **Email**: <support@esystemsnordic.com>
-- **Documentation**: [https://github.com/esystemsdev/aifabrix-miso-client](https://github.com/esystemsdev/aifabrix-miso-client)
-- **GitHub Issues**: [https://github.com/esystemsdev/aifabrix-miso-client/issues](https://github.com/esystemsdev/aifabrix-miso-client/issues)
-
 ---
 
 **Made with ❤️ by eSystems Nordic Ltd.**

package/dist/examples/step-3-authentication.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Step 3: Activate Authentication
+ *
+ * Basic token validation to verify user identity.
+ */
+declare function authenticationExample(): Promise<void>;
+export { authenticationExample };
+//# sourceMappingURL=step-3-authentication.d.ts.map

package/dist/examples/step-3-authentication.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"step-3-authentication.d.ts","sourceRoot":"","sources":["../../examples/step-3-authentication.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,iBAAe,qBAAqB,kBAoCnC;AAED,OAAO,EAAE,qBAAqB,EAAE,CAAC"}

package/dist/examples/step-3-authentication.js

@@ -0,0 +1,45 @@
+"use strict";
+/**
+ * Step 3: Activate Authentication
+ *
+ * Basic token validation to verify user identity.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.authenticationExample = authenticationExample;
+const index_1 = require("../src/index");
+async function authenticationExample() {
+    // Create client with controller configuration
+    const client = new index_1.MisoClient({
+        controllerUrl: 'https://controller.aifabrix.ai',
+        environment: 'dev',
+        applicationKey: 'my-app',
+        applicationId: 'my-app-id-123',
+    });
+    try {
+        // Initialize the client
+        await client.initialize();
+        console.log('✅ Client initialized successfully');
+        // Get token from your application (e.g., from HTTP request header)
+        // In real usage: const token = req.headers.authorization?.replace('Bearer ', '');
+        const token = 'your-jwt-token-here';
+        // Validate the token
+        const isValid = await client.validateToken(token);
+        if (isValid) {
+            console.log('✅ Token is valid');
+            // Get user information
+            const user = await client.getUser(token);
+            console.log('👤 User:', user);
+        }
+        else {
+            console.log('❌ Token is invalid');
+        }
+    }
+    catch (error) {
+        console.error('❌ Authentication error:', error);
+    }
+    finally {
+        // Clean up connections
+        await client.disconnect();
+    }
+}
+//# sourceMappingURL=step-3-authentication.js.map

package/dist/examples/step-3-authentication.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"step-3-authentication.js","sourceRoot":"","sources":["../../examples/step-3-authentication.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;AA0CM,sDAAqB;AAxC9B,wCAA0C;AAE1C,KAAK,UAAU,qBAAqB;IAClC,8CAA8C;IAC9C,MAAM,MAAM,GAAG,IAAI,kBAAU,CAAC;QAC5B,aAAa,EAAE,gCAAgC;QAC/C,WAAW,EAAE,KAAK;QAClB,cAAc,EAAE,QAAQ;QACxB,aAAa,EAAE,eAAe;KAC/B,CAAC,CAAC;IAEH,IAAI,CAAC;QACH,wBAAwB;QACxB,MAAM,MAAM,CAAC,UAAU,EAAE,CAAC;QAC1B,OAAO,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC;QAEjD,mEAAmE;QACnE,kFAAkF;QAClF,MAAM,KAAK,GAAG,qBAAqB,CAAC;QAEpC,qBAAqB;QACrB,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAElD,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;YAEhC,uBAAuB;YACvB,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACzC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAChC,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,yBAAyB,EAAE,KAAK,CAAC,CAAC;IAClD,CAAC;YAAS,CAAC;QACT,uBAAuB;QACvB,MAAM,MAAM,CAAC,UAAU,EAAE,CAAC;IAC5B,CAAC;AACH,CAAC"}

package/dist/examples/step-4-rbac.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Step 4: Activate RBAC (Role-Based Access Control)
+ *
+ * Check user roles and enforce access control.
+ */
+declare function rbacExample(): Promise<void>;
+export { rbacExample };
+//# sourceMappingURL=step-4-rbac.d.ts.map

package/dist/examples/step-4-rbac.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"step-4-rbac.d.ts","sourceRoot":"","sources":["../../examples/step-4-rbac.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,iBAAe,WAAW,kBAiDzB;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}

package/dist/examples/step-4-rbac.js

@@ -0,0 +1,54 @@
+"use strict";
+/**
+ * Step 4: Activate RBAC (Role-Based Access Control)
+ *
+ * Check user roles and enforce access control.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rbacExample = rbacExample;
+const index_1 = require("../src/index");
+async function rbacExample() {
+    // Create client (same as Step 3)
+    const client = new index_1.MisoClient({
+        controllerUrl: 'https://controller.aifabrix.ai',
+        environment: 'dev',
+        applicationKey: 'my-app',
+        applicationId: 'my-app-id-123',
+        redis: {
+            host: 'localhost',
+            port: 6379,
+        },
+    });
+    try {
+        await client.initialize();
+        console.log('✅ Client initialized with Redis caching');
+        const token = 'your-jwt-token-here';
+        // Validate token (from Step 3)
+        const isValid = await client.validateToken(token);
+        if (!isValid) {
+            console.log('❌ Token is invalid');
+            return;
+        }
+        // NEW: Get user roles
+        const roles = await client.getRoles(token);
+        console.log('🔑 User roles:', roles);
+        // NEW: Check specific role
+        const isAdmin = await client.hasRole(token, 'admin');
+        console.log('👑 Is admin:', isAdmin);
+        // NEW: Check multiple roles (user needs any of these)
+        const canManage = await client.hasAnyRole(token, ['admin', 'manager']);
+        console.log('⚙️ Can manage:', canManage);
+        // Example: Gate a feature based on role
+        if (isAdmin) {
+            console.log('🔐 Admin feature unlocked');
+            // Show admin dashboard, etc.
+        }
+    }
+    catch (error) {
+        console.error('❌ RBAC error:', error);
+    }
+    finally {
+        await client.disconnect();
+    }
+}
+//# sourceMappingURL=step-4-rbac.js.map

package/dist/examples/step-4-rbac.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"step-4-rbac.js","sourceRoot":"","sources":["../../examples/step-4-rbac.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;AAuDM,kCAAW;AArDpB,wCAA0C;AAE1C,KAAK,UAAU,WAAW;IACxB,iCAAiC;IACjC,MAAM,MAAM,GAAG,IAAI,kBAAU,CAAC;QAC5B,aAAa,EAAE,gCAAgC;QAC/C,WAAW,EAAE,KAAK;QAClB,cAAc,EAAE,QAAQ;QACxB,aAAa,EAAE,eAAe;QAC9B,KAAK,EAAE;YACL,IAAI,EAAE,WAAW;YACjB,IAAI,EAAE,IAAI;SACX;KACF,CAAC,CAAC;IAEH,IAAI,CAAC;QACH,MAAM,MAAM,CAAC,UAAU,EAAE,CAAC;QAC1B,OAAO,CAAC,GAAG,CAAC,yCAAyC,CAAC,CAAC;QAEvD,MAAM,KAAK,GAAG,qBAAqB,CAAC;QAEpC,+BAA+B;QAC/B,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAClD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;YAClC,OAAO;QACT,CAAC;QAED,sBAAsB;QACtB,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC3C,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC;QAErC,2BAA2B;QAC3B,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACrD,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;QAErC,sDAAsD;QACtD,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC;QACvE,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,SAAS,CAAC,CAAC;QAEzC,wCAAwC;QACxC,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC;YACzC,6BAA6B;QAC/B,CAAC;IAEH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;IACxC,CAAC;YAAS,CAAC;QACT,MAAM,MAAM,CAAC,UAAU,EAAE,CAAC;IAC5B,CAAC;AACH,CAAC"}

package/dist/examples/step-5-logging.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Step 5: Activate Logging
+ *
+ * Send application logs to the AI Fabrix controller.
+ */
+declare function loggingExample(): Promise<void>;
+export { loggingExample };
+//# sourceMappingURL=step-5-logging.d.ts.map

package/dist/examples/step-5-logging.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"step-5-logging.d.ts","sourceRoot":"","sources":["../../examples/step-5-logging.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,iBAAe,cAAc,kBAuD5B;AAQD,OAAO,EAAE,cAAc,EAAE,CAAC"}

package/dist/examples/step-5-logging.js

@@ -0,0 +1,66 @@
+"use strict";
+/**
+ * Step 5: Activate Logging
+ *
+ * Send application logs to the AI Fabrix controller.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loggingExample = loggingExample;
+const index_1 = require("../src/index");
+async function loggingExample() {
+    const client = new index_1.MisoClient({
+        controllerUrl: 'https://controller.aifabrix.ai',
+        environment: 'dev',
+        applicationKey: 'my-app',
+        applicationId: 'my-app-id-123',
+        apiKey: 'dev-my-app-my-app-id-123-a1b2c3d4e5f6', // Required for logging
+        redis: {
+            host: 'localhost',
+            port: 6379,
+        },
+    });
+    try {
+        await client.initialize();
+        const token = 'your-jwt-token-here';
+        // Validate token and get user (Steps 3-4)
+        const isValid = await client.validateToken(token);
+        if (!isValid)
+            return;
+        const user = await client.getUser(token);
+        // NEW: Log informational messages
+        await client.log.info('User accessed dashboard', {
+            userId: user?.id,
+            username: user?.username,
+            timestamp: new Date().toISOString(),
+        });
+        // NEW: Log errors
+        try {
+            // Some operation that might fail
+            await performOperation();
+        }
+        catch (error) {
+            await client.log.error('Operation failed', {
+                error: error instanceof Error ? error.message : 'Unknown error',
+                stack: error instanceof Error ? error.stack : undefined,
+                userId: user?.id,
+            });
+        }
+        // NEW: Use debug for detailed diagnostic information
+        await client.log.debug('Processing user request', {
+            userId: user?.id,
+            requestDetails: '...',
+        });
+        console.log('📊 Logs sent to controller');
+    }
+    catch (error) {
+        console.error('❌ Logging error:', error);
+    }
+    finally {
+        await client.disconnect();
+    }
+}
+async function performOperation() {
+    // Your application logic
+}
+let someCondition = false;
+//# sourceMappingURL=step-5-logging.js.map

package/dist/examples/step-5-logging.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"step-5-logging.js","sourceRoot":"","sources":["../../examples/step-5-logging.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;AAmEM,wCAAc;AAjEvB,wCAA0C;AAE1C,KAAK,UAAU,cAAc;IAC3B,MAAM,MAAM,GAAG,IAAI,kBAAU,CAAC;QAC5B,aAAa,EAAE,gCAAgC;QAC/C,WAAW,EAAE,KAAK;QAClB,cAAc,EAAE,QAAQ;QACxB,aAAa,EAAE,eAAe;QAC9B,MAAM,EAAE,uCAAuC,EAAE,uBAAuB;QACxE,KAAK,EAAE;YACL,IAAI,EAAE,WAAW;YACjB,IAAI,EAAE,IAAI;SACX;KACF,CAAC,CAAC;IAEH,IAAI,CAAC;QACH,MAAM,MAAM,CAAC,UAAU,EAAE,CAAC;QAC1B,MAAM,KAAK,GAAG,qBAAqB,CAAC;QAEpC,0CAA0C;QAC1C,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAClD,IAAI,CAAC,OAAO;YAAE,OAAO;QAErB,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAEzC,kCAAkC;QAClC,MAAM,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,yBAAyB,EAAE;YAC/C,MAAM,EAAE,IAAI,EAAE,EAAE;YAChB,QAAQ,EAAE,IAAI,EAAE,QAAQ;YACxB,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;SACpC,CAAC,CAAC;QAEH,kBAAkB;QAClB,IAAI,CAAC;YACH,iCAAiC;YACjC,MAAM,gBAAgB,EAAE,CAAC;QAC3B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,kBAAkB,EAAE;gBACzC,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe;gBAC/D,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;gBACvD,MAAM,EAAE,IAAI,EAAE,EAAE;aACjB,CAAC,CAAC;QACL,CAAC;QAED,qDAAqD;QACrD,MAAM,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,yBAAyB,EAAE;YAChD,MAAM,EAAE,IAAI,EAAE,EAAE;YAChB,cAAc,EAAE,KAAK;SACtB,CAAC,CAAC;QAEH,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;IAE5C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,kBAAkB,EAAE,KAAK,CAAC,CAAC;IAC3C,CAAC;YAAS,CAAC;QACT,MAAM,MAAM,CAAC,UAAU,EAAE,CAAC;IAC5B,CAAC;AACH,CAAC;AAED,KAAK,UAAU,gBAAgB;IAC7B,yBAAyB;AAC3B,CAAC;AAED,IAAI,aAAa,GAAG,KAAK,CAAC"}

package/dist/examples/step-6-audit.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Step 6: Activate Audit
+ *
+ * Complete example with authentication, RBAC, logging, and audit trails.
+ */
+declare function completeExample(): Promise<void>;
+export { completeExample };
+//# sourceMappingURL=step-6-audit.d.ts.map

package/dist/examples/step-6-audit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"step-6-audit.d.ts","sourceRoot":"","sources":["../../examples/step-6-audit.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,iBAAe,eAAe,kBAgG7B;AAED,OAAO,EAAE,eAAe,EAAE,CAAC"}

package/dist/examples/step-6-audit.js

@@ -0,0 +1,97 @@
+"use strict";
+/**
+ * Step 6: Activate Audit
+ *
+ * Complete example with authentication, RBAC, logging, and audit trails.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.completeExample = completeExample;
+const index_1 = require("../src/index");
+async function completeExample() {
+    const client = new index_1.MisoClient({
+        controllerUrl: 'https://controller.aifabrix.ai',
+        environment: 'dev',
+        applicationKey: 'my-app',
+        applicationId: 'my-app-id-123',
+        apiKey: 'dev-my-app-my-app-id-123-a1b2c3d4e5f6',
+        redis: {
+            host: 'localhost',
+            port: 6379,
+            password: 'your-redis-password',
+        },
+        logLevel: 'info',
+        cache: {
+            roleTTL: 900, // 15 minutes
+            permissionTTL: 900, // 15 minutes
+        },
+    });
+    try {
+        await client.initialize();
+        console.log('✅ Client fully configured');
+        const token = 'your-jwt-token-here';
+        // Step 3: Authentication
+        const isValid = await client.validateToken(token);
+        if (!isValid) {
+            await client.log.audit('access.denied', 'authentication', {
+                reason: 'Invalid token',
+                ip: '192.168.1.1',
+            });
+            return;
+        }
+        const user = await client.getUser(token);
+        // Step 4: RBAC
+        const canEdit = await client.hasPermission(token, 'edit:content');
+        if (!canEdit) {
+            await client.log.audit('access.denied', 'authorization', {
+                userId: user?.id,
+                action: 'edit_content',
+                resource: 'posts',
+            });
+            console.log('❌ Insufficient permissions');
+            return;
+        }
+        // Step 5: Logging
+        await client.log.info('User logged in successfully', {
+            userId: user?.id,
+            username: user?.username,
+            email: user?.email,
+        });
+        // Step 6: Audit Trail - Log important user actions
+        await client.log.audit('user.login', 'authentication', {
+            userId: user?.id,
+            ip: '192.168.1.1',
+            userAgent: 'Mozilla/5.0...',
+            timestamp: new Date().toISOString(),
+        });
+        // Audit example: Content changes
+        await client.log.audit('post.created', 'content', {
+            userId: user?.id,
+            postId: 'post-123',
+            postTitle: 'My New Post',
+            category: 'technology',
+        });
+        // Audit example: Permission checks
+        await client.log.audit('role.checked', 'authorization', {
+            userId: user?.id,
+            checkedRole: 'admin',
+            result: 'granted',
+        });
+        // Audit example: Sensitive operations
+        await client.log.audit('user.deleted', 'administration', {
+            userId: user?.id,
+            deletedUserId: 'user-456',
+            reason: 'Policy violation',
+        });
+        console.log('✅ Complete flow: Auth + RBAC + Logging + Audit');
+    }
+    catch (error) {
+        await client.log.error('Application error', {
+            error: error instanceof Error ? error.message : 'Unknown error',
+            stack: error instanceof Error ? error.stack : undefined,
+        });
+    }
+    finally {
+        await client.disconnect();
+    }
+}
+//# sourceMappingURL=step-6-audit.js.map

package/dist/examples/step-6-audit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"step-6-audit.js","sourceRoot":"","sources":["../../examples/step-6-audit.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;AAsGM,0CAAe;AApGxB,wCAA0C;AAE1C,KAAK,UAAU,eAAe;IAC5B,MAAM,MAAM,GAAG,IAAI,kBAAU,CAAC;QAC5B,aAAa,EAAE,gCAAgC;QAC/C,WAAW,EAAE,KAAK;QAClB,cAAc,EAAE,QAAQ;QACxB,aAAa,EAAE,eAAe;QAC9B,MAAM,EAAE,uCAAuC;QAC/C,KAAK,EAAE;YACL,IAAI,EAAE,WAAW;YACjB,IAAI,EAAE,IAAI;YACV,QAAQ,EAAE,qBAAqB;SAChC;QACD,QAAQ,EAAE,MAAM;QAChB,KAAK,EAAE;YACL,OAAO,EAAE,GAAG,EAAO,aAAa;YAChC,aAAa,EAAE,GAAG,EAAE,aAAa;SAClC;KACF,CAAC,CAAC;IAEH,IAAI,CAAC;QACH,MAAM,MAAM,CAAC,UAAU,EAAE,CAAC;QAC1B,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC;QAEzC,MAAM,KAAK,GAAG,qBAAqB,CAAC;QAEpC,yBAAyB;QACzB,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAClD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,eAAe,EAAE,gBAAgB,EAAE;gBACxD,MAAM,EAAE,eAAe;gBACvB,EAAE,EAAE,aAAa;aAClB,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAEzC,eAAe;QACf,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;QAClE,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,eAAe,EAAE,eAAe,EAAE;gBACvD,MAAM,EAAE,IAAI,EAAE,EAAE;gBAChB,MAAM,EAAE,cAAc;gBACtB,QAAQ,EAAE,OAAO;aAClB,CAAC,CAAC;YACH,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;YAC1C,OAAO;QACT,CAAC;QAED,kBAAkB;QAClB,MAAM,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,6BAA6B,EAAE;YACnD,MAAM,EAAE,IAAI,EAAE,EAAE;YAChB,QAAQ,EAAE,IAAI,EAAE,QAAQ;YACxB,KAAK,EAAE,IAAI,EAAE,KAAK;SACnB,CAAC,CAAC;QAEH,mDAAmD;QACnD,MAAM,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,YAAY,EAAE,gBAAgB,EAAE;YACrD,MAAM,EAAE,IAAI,EAAE,EAAE;YAChB,EAAE,EAAE,aAAa;YACjB,SAAS,EAAE,gBAAgB;YAC3B,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;SACpC,CAAC,CAAC;QAEH,iCAAiC;QACjC,MAAM,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,cAAc,EAAE,SAAS,EAAE;YAChD,MAAM,EAAE,IAAI,EAAE,EAAE;YAChB,MAAM,EAAE,UAAU;YAClB,SAAS,EAAE,aAAa;YACxB,QAAQ,EAAE,YAAY;SACvB,CAAC,CAAC;QAEH,mCAAmC;QACnC,MAAM,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,cAAc,EAAE,eAAe,EAAE;YACtD,MAAM,EAAE,IAAI,EAAE,EAAE;YAChB,WAAW,EAAE,OAAO;YACpB,MAAM,EAAE,SAAS;SAClB,CAAC,CAAC;QAEH,sCAAsC;QACtC,MAAM,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,cAAc,EAAE,gBAAgB,EAAE;YACvD,MAAM,EAAE,IAAI,EAAE,EAAE;YAChB,aAAa,EAAE,UAAU;YACzB,MAAM,EAAE,kBAAkB;SAC3B,CAAC,CAAC;QAEH,OAAO,CAAC,GAAG,CAAC,gDAAgD,CAAC,CAAC;IAEhE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,mBAAmB,EAAE;YAC1C,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe;YAC/D,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;SACxD,CAAC,CAAC;IACL,CAAC;YAAS,CAAC;QACT,MAAM,MAAM,CAAC,UAAU,EAAE,CAAC;IAC5B,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aifabrix/miso-client",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "AI Fabrix Client SDK for authentication, authorization, and logging",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",