@serve.zone/dcrouter 5.0.2 → 5.0.3

package/ts_interfaces/data/stats.ts

@@ -1,131 +0,0 @@
-export interface IServerStats {
-  uptime: number;
-  startTime: number;
-  memoryUsage: {
-    heapUsed: number;
-    heapTotal: number;
-    external: number;
-    rss: number;
-    // SmartMetrics memory data
-    maxMemoryMB?: number;
-    actualUsageBytes?: number;
-    actualUsagePercentage?: number;
-  };
-  cpuUsage: {
-    user: number;
-    system: number;
-  };
-  activeConnections: number;
-  totalConnections: number;
-}
-
-export interface IEmailStats {
-  sent: number;
-  received: number;
-  bounced: number;
-  queued: number;
-  failed: number;
-  averageDeliveryTime: number;
-  deliveryRate: number;
-  bounceRate: number;
-}
-
-export interface IDnsStats {
-  totalQueries: number;
-  cacheHits: number;
-  cacheMisses: number;
-  cacheHitRate: number;
-  activeDomains: number;
-  averageResponseTime: number;
-  queryTypes: {
-    [key: string]: number;
-  };
-}
-
-export interface IRateLimitInfo {
-  domain: string;
-  currentRate: number;
-  limit: number;
-  remaining: number;
-  resetTime: number;
-  blocked: boolean;
-}
-
-export interface ISecurityMetrics {
-  blockedIPs: string[];
-  reputationScores: {
-    [domain: string]: number;
-  };
-  spamDetected: number;
-  malwareDetected: number;
-  phishingDetected: number;
-  authenticationFailures: number;
-  suspiciousActivities: number;
-}
-
-export interface ILogEntry {
-  timestamp: number;
-  level: 'debug' | 'info' | 'warn' | 'error';
-  category: 'smtp' | 'dns' | 'security' | 'system' | 'email';
-  message: string;
-  metadata?: any;
-}
-
-export interface IConnectionInfo {
-  id: string;
-  remoteAddress: string;
-  localAddress: string;
-  startTime: number;
-  protocol: 'smtp' | 'smtps' | 'http' | 'https';
-  state: 'connecting' | 'connected' | 'authenticated' | 'transmitting' | 'closing';
-  bytesReceived: number;
-  bytesSent: number;
-}
-
-export interface IQueueStatus {
-  name: string;
-  size: number;
-  processing: number;
-  failed: number;
-  retrying: number;
-  averageProcessingTime: number;
-}
-
-export interface IHealthStatus {
-  healthy: boolean;
-  uptime: number;
-  services: {
-    [service: string]: {
-      status: 'healthy' | 'degraded' | 'unhealthy';
-      message?: string;
-      lastCheck: number;
-    };
-  };
-  version?: string;
-}
-
-export interface INetworkMetrics {
-  totalBandwidth: {
-    in: number;
-    out: number;
-  };
-  activeConnections: number;
-  connectionDetails: IConnectionDetails[];
-  topEndpoints: Array<{
-    endpoint: string;
-    requests: number;
-    bandwidth: {
-      in: number;
-      out: number;
-    };
-  }>;
-}
-
-export interface IConnectionDetails {
-  remoteAddress: string;
-  protocol: 'http' | 'https' | 'smtp' | 'smtps';
-  state: 'connecting' | 'connected' | 'established' | 'closing';
-  startTime: number;
-  bytesIn: number;
-  bytesOut: number;
-}

package/ts_interfaces/readme.md

@@ -1,205 +0,0 @@
-# @serve.zone/dcrouter-interfaces
-
-TypeScript interfaces and type definitions for the DcRouter OpsServer API. 📡
-
-This module provides strongly-typed interfaces for communicating with the DcRouter OpsServer via [TypedRequest](https://code.foss.global/api.global/typedrequest). Use these interfaces for type-safe API interactions in your frontend applications or integration code.
-
-## Issue Reporting and Security
-
-For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
-
-## Installation
-
-```bash
-pnpm add @serve.zone/dcrouter-interfaces
-```
-
-Or import directly from the main package:
-
-```typescript
-import { data, requests } from '@serve.zone/dcrouter/interfaces';
-```
-
-## Usage
-
-```typescript
-import { data, requests } from '@serve.zone/dcrouter-interfaces';
-
-// Use data interfaces for type definitions
-const identity: data.IIdentity = {
-  jwt: 'your-jwt-token',
-  userId: 'user-123',
-  name: 'Admin User',
-  expiresAt: Date.now() + 3600000,
-  role: 'admin'
-};
-
-// Use request interfaces for API calls
-import * as typedrequest from '@api.global/typedrequest';
-
-const statsClient = new typedrequest.TypedRequest<requests.IReq_GetServerStatistics>(
-  'https://your-dcrouter:3000/typedrequest',
-  'getServerStatistics'
-);
-
-const stats = await statsClient.fire({
-  identity,
-  includeHistory: true,
-  timeRange: '24h'
-});
-```
-
-## Module Structure
-
-### Data Interfaces (`data`)
-
-Core data types used throughout the DcRouter system:
-
-#### `IIdentity`
-Authentication identity for API requests:
-```typescript
-interface IIdentity {
-  jwt: string;           // JWT token
-  userId: string;        // Unique user ID
-  name: string;          // Display name
-  expiresAt: number;     // Token expiration timestamp
-  role?: string;         // User role (e.g., 'admin')
-  type?: string;         // Identity type
-}
-```
-
-#### Statistics Interfaces
-| Interface | Description |
-|-----------|-------------|
-| `IServerStats` | Uptime, memory, CPU, connection counts |
-| `IEmailStats` | Sent/received/bounced/queued/failed, delivery & bounce rates |
-| `IDnsStats` | Total queries, cache hits/misses, query types |
-| `IRateLimitInfo` | Domain rate limit status (current rate, limit, remaining) |
-| `ISecurityMetrics` | Blocked IPs, spam/malware/phishing counts |
-| `IConnectionInfo` | Connection ID, remote address, protocol, state, bytes |
-| `IQueueStatus` | Queue name, size, processing/failed/retrying counts |
-| `IHealthStatus` | Healthy flag, uptime, per-service status map |
-| `INetworkMetrics` | Bandwidth, connection counts, top endpoints |
-| `ILogEntry` | Timestamp, level, category, message, metadata |
-
-### Request Interfaces (`requests`)
-
-TypedRequest interfaces for the OpsServer API, organized by domain:
-
-#### 🔐 Authentication
-| Interface | Method | Description |
-|-----------|--------|-------------|
-| `IReq_AdminLoginWithUsernameAndPassword` | `adminLoginWithUsernameAndPassword` | Authenticate as admin |
-| `IReq_AdminLogout` | `adminLogout` | End admin session |
-| `IReq_VerifyIdentity` | `verifyIdentity` | Verify JWT token validity |
-
-#### 📊 Statistics
-| Interface | Method | Description |
-|-----------|--------|-------------|
-| `IReq_GetServerStatistics` | `getServerStatistics` | Overall server stats |
-| `IReq_GetEmailStatistics` | `getEmailStatistics` | Email throughput metrics |
-| `IReq_GetDnsStatistics` | `getDnsStatistics` | DNS query stats |
-| `IReq_GetRateLimitStatus` | `getRateLimitStatus` | Rate limit status |
-| `IReq_GetSecurityMetrics` | `getSecurityMetrics` | Security event metrics |
-| `IReq_GetActiveConnections` | `getActiveConnections` | Active connection list |
-| `IReq_GetQueueStatus` | `getQueueStatus` | Email queue status |
-| `IReq_GetHealthStatus` | `getHealthStatus` | System health check |
-| `IReq_GetCombinedMetrics` | `getCombinedMetrics` | All metrics in one request |
-
-#### ⚙️ Configuration
-| Interface | Method | Description |
-|-----------|--------|-------------|
-| `IReq_GetConfiguration` | `getConfiguration` | Current config (read-only) |
-
-#### 📜 Logs
-| Interface | Method | Description |
-|-----------|--------|-------------|
-| `IReq_GetRecentLogs` | `getLogs` | Retrieve system logs |
-| `IReq_GetLogStream` | `getLogStream` | Stream live logs |
-
-#### 📧 Email Operations
-| Interface | Method | Description |
-|-----------|--------|-------------|
-| `IReq_GetQueuedEmails` | `getQueuedEmails` | List queued emails |
-| `IReq_GetSentEmails` | `getSentEmails` | List delivered emails |
-| `IReq_GetFailedEmails` | `getFailedEmails` | List failed emails |
-| `IReq_ResendEmail` | `resendEmail` | Re-queue a failed email |
-| `IReq_GetSecurityIncidents` | `getSecurityIncidents` | Security events |
-| `IReq_GetBounceRecords` | `getBounceRecords` | Bounce records |
-| `IReq_RemoveFromSuppressionList` | `removeFromSuppressionList` | Unsuppress an address |
-
-#### 📡 RADIUS
-| Interface | Method | Description |
-|-----------|--------|-------------|
-| `IReq_GetRadiusClients` | `getRadiusClients` | List NAS clients |
-| `IReq_SetRadiusClient` | `setRadiusClient` | Add/update a NAS client |
-| `IReq_RemoveRadiusClient` | `removeRadiusClient` | Remove a NAS client |
-| `IReq_GetVlanMappings` | `getVlanMappings` | List VLAN mappings |
-| `IReq_SetVlanMapping` | `setVlanMapping` | Add/update VLAN mapping |
-| `IReq_RemoveVlanMapping` | `removeVlanMapping` | Remove VLAN mapping |
-| `IReq_TestVlanAssignment` | `testVlanAssignment` | Test what VLAN a MAC gets |
-| `IReq_GetRadiusSessions` | `getRadiusSessions` | List active sessions |
-| `IReq_DisconnectRadiusSession` | `disconnectRadiusSession` | Force disconnect |
-| `IReq_GetRadiusStatistics` | `getRadiusStatistics` | RADIUS stats |
-| `IReq_GetRadiusAccountingSummary` | `getRadiusAccountingSummary` | Accounting summary |
-
-## Example: Full API Integration
-
-```typescript
-import * as typedrequest from '@api.global/typedrequest';
-import { data, requests } from '@serve.zone/dcrouter-interfaces';
-
-// 1. Login
-const loginClient = new typedrequest.TypedRequest<requests.IReq_AdminLoginWithUsernameAndPassword>(
-  'https://your-dcrouter:3000/typedrequest',
-  'adminLogin'
-);
-
-const loginResponse = await loginClient.fire({
-  username: 'admin',
-  password: 'your-password'
-});
-const identity = loginResponse.identity;
-
-// 2. Fetch combined metrics
-const metricsClient = new typedrequest.TypedRequest<requests.IReq_GetCombinedMetrics>(
-  'https://your-dcrouter:3000/typedrequest',
-  'getCombinedMetrics'
-);
-
-const metrics = await metricsClient.fire({ identity });
-console.log('Server:', metrics.serverStats);
-console.log('Email:', metrics.emailStats);
-console.log('DNS:', metrics.dnsStats);
-console.log('Security:', metrics.securityMetrics);
-
-// 3. Check email queues
-const queueClient = new typedrequest.TypedRequest<requests.IReq_GetQueuedEmails>(
-  'https://your-dcrouter:3000/typedrequest',
-  'getQueuedEmails'
-);
-
-const queued = await queueClient.fire({ identity });
-console.log('Queued emails:', queued.emails.length);
-```
-
-## License and Legal Information
-
-This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](../LICENSE) file.
-
-**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
-
-### Trademarks
-
-This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.
-
-Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
-
-### Company Information
-
-Task Venture Capital GmbH
-Registered at District Court Bremen HRB 35230 HB, Germany
-
-For any legal inquiries or further information, please contact us via email at hello@task.vc.
-
-By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

package/ts_interfaces/requests/admin.ts

@@ -1,46 +0,0 @@
-import * as plugins from '../plugins.js';
-import * as authInterfaces from '../data/auth.js';
-
-// Admin Login
-export interface IReq_AdminLoginWithUsernameAndPassword extends plugins.typedrequestInterfaces.implementsTR<
-  plugins.typedrequestInterfaces.ITypedRequest,
-  IReq_AdminLoginWithUsernameAndPassword
-> {
-  method: 'adminLoginWithUsernameAndPassword';
-  request: {
-    username: string;
-    password: string;
-  };
-  response: {
-    identity?: authInterfaces.IIdentity;
-  };
-}
-
-// Admin Logout
-export interface IReq_AdminLogout extends plugins.typedrequestInterfaces.implementsTR<
-  plugins.typedrequestInterfaces.ITypedRequest,
-  IReq_AdminLogout
-> {
-  method: 'adminLogout';
-  request: {
-    identity: authInterfaces.IIdentity;
-  };
-  response: {
-    success: boolean;
-  };
-}
-
-// Verify Identity
-export interface IReq_VerifyIdentity extends plugins.typedrequestInterfaces.implementsTR<
-  plugins.typedrequestInterfaces.ITypedRequest,
-  IReq_VerifyIdentity
-> {
-  method: 'verifyIdentity';
-  request: {
-    identity: authInterfaces.IIdentity;
-  };
-  response: {
-    valid: boolean;
-    identity?: authInterfaces.IIdentity;
-  };
-}

package/ts_interfaces/requests/combined.stats.ts

@@ -1,25 +0,0 @@
-import type * as data from '../data/index.js';
-
-export interface IReq_GetCombinedMetrics {
-  method: 'getCombinedMetrics';
-  request: {
-    identity: data.IIdentity;
-    sections?: {
-      server?: boolean;
-      email?: boolean;
-      dns?: boolean;
-      security?: boolean;
-      network?: boolean;
-    };
-  };
-  response: {
-    metrics: {
-      server?: data.IServerStats;
-      email?: data.IEmailStats;
-      dns?: data.IDnsStats;
-      security?: data.ISecurityMetrics;
-      network?: data.INetworkMetrics;
-    };
-    timestamp: number;
-  };
-}

package/ts_interfaces/requests/config.ts

@@ -1,18 +0,0 @@
-import * as plugins from '../plugins.js';
-import * as authInterfaces from '../data/auth.js';
-
-// Get Configuration (read-only)
-export interface IReq_GetConfiguration extends plugins.typedrequestInterfaces.implementsTR<
-  plugins.typedrequestInterfaces.ITypedRequest,
-  IReq_GetConfiguration
-> {
-  method: 'getConfiguration';
-  request: {
-    identity?: authInterfaces.IIdentity;
-    section?: string;
-  };
-  response: {
-    config: any;
-    section?: string;
-  };
-}

package/ts_interfaces/requests/email-ops.ts

@@ -1,239 +0,0 @@
-import * as plugins from '../plugins.js';
-import * as authInterfaces from '../data/auth.js';
-
-// ============================================================================
-// Email Queue Item Interface (matches backend IQueueItem)
-// ============================================================================
-export type TEmailQueueStatus = 'pending' | 'processing' | 'delivered' | 'failed' | 'deferred';
-
-export interface IEmailQueueItem {
-  id: string;
-  processingMode: 'forward' | 'mta' | 'process';
-  status: TEmailQueueStatus;
-  attempts: number;
-  nextAttempt: number; // timestamp
-  lastError?: string;
-  createdAt: number; // timestamp
-  updatedAt: number; // timestamp
-  deliveredAt?: number; // timestamp
-  // Email details extracted from processingResult
-  from?: string;
-  to?: string[];
-  subject?: string;
-}
-
-// ============================================================================
-// Bounce Record Interface (matches backend BounceRecord)
-// ============================================================================
-export type TBounceType =
-  | 'invalid_recipient'
-  | 'domain_not_found'
-  | 'mailbox_full'
-  | 'mailbox_inactive'
-  | 'blocked'
-  | 'spam_related'
-  | 'policy_related'
-  | 'server_unavailable'
-  | 'temporary_failure'
-  | 'quota_exceeded'
-  | 'network_error'
-  | 'timeout'
-  | 'auto_response'
-  | 'challenge_response'
-  | 'unknown';
-
-export type TBounceCategory = 'hard' | 'soft' | 'auto_response' | 'unknown';
-
-export interface IBounceRecord {
-  id: string;
-  originalEmailId?: string;
-  recipient: string;
-  sender: string;
-  domain: string;
-  subject?: string;
-  bounceType: TBounceType;
-  bounceCategory: TBounceCategory;
-  timestamp: number;
-  smtpResponse?: string;
-  diagnosticCode?: string;
-  statusCode?: string;
-  processed: boolean;
-  retryCount?: number;
-  nextRetryTime?: number;
-}
-
-// ============================================================================
-// Security Incident Interface (matches backend ISecurityEvent)
-// ============================================================================
-export type TSecurityLogLevel = 'info' | 'warn' | 'error' | 'critical';
-
-export type TSecurityEventType =
-  | 'authentication'
-  | 'access_control'
-  | 'email_validation'
-  | 'email_processing'
-  | 'email_forwarding'
-  | 'email_delivery'
-  | 'dkim'
-  | 'spf'
-  | 'dmarc'
-  | 'rate_limit'
-  | 'rate_limiting'
-  | 'spam'
-  | 'malware'
-  | 'connection'
-  | 'data_exposure'
-  | 'configuration'
-  | 'ip_reputation'
-  | 'rejected_connection';
-
-export interface ISecurityIncident {
-  timestamp: number;
-  level: TSecurityLogLevel;
-  type: TSecurityEventType;
-  message: string;
-  details?: any;
-  ipAddress?: string;
-  userId?: string;
-  sessionId?: string;
-  emailId?: string;
-  domain?: string;
-  action?: string;
-  result?: string;
-  success?: boolean;
-}
-
-// ============================================================================
-// Get Queued Emails Request
-// ============================================================================
-export interface IReq_GetQueuedEmails extends plugins.typedrequestInterfaces.implementsTR<
-  plugins.typedrequestInterfaces.ITypedRequest,
-  IReq_GetQueuedEmails
-> {
-  method: 'getQueuedEmails';
-  request: {
-    identity?: authInterfaces.IIdentity;
-    status?: TEmailQueueStatus;
-    limit?: number;
-    offset?: number;
-  };
-  response: {
-    items: IEmailQueueItem[];
-    total: number;
-  };
-}
-
-// ============================================================================
-// Get Sent Emails Request
-// ============================================================================
-export interface IReq_GetSentEmails extends plugins.typedrequestInterfaces.implementsTR<
-  plugins.typedrequestInterfaces.ITypedRequest,
-  IReq_GetSentEmails
-> {
-  method: 'getSentEmails';
-  request: {
-    identity?: authInterfaces.IIdentity;
-    limit?: number;
-    offset?: number;
-  };
-  response: {
-    items: IEmailQueueItem[];
-    total: number;
-  };
-}
-
-// ============================================================================
-// Get Failed Emails Request
-// ============================================================================
-export interface IReq_GetFailedEmails extends plugins.typedrequestInterfaces.implementsTR<
-  plugins.typedrequestInterfaces.ITypedRequest,
-  IReq_GetFailedEmails
-> {
-  method: 'getFailedEmails';
-  request: {
-    identity?: authInterfaces.IIdentity;
-    limit?: number;
-    offset?: number;
-  };
-  response: {
-    items: IEmailQueueItem[];
-    total: number;
-  };
-}
-
-// ============================================================================
-// Resend Failed Email Request
-// ============================================================================
-export interface IReq_ResendEmail extends plugins.typedrequestInterfaces.implementsTR<
-  plugins.typedrequestInterfaces.ITypedRequest,
-  IReq_ResendEmail
-> {
-  method: 'resendEmail';
-  request: {
-    identity?: authInterfaces.IIdentity;
-    emailId: string;
-  };
-  response: {
-    success: boolean;
-    newQueueId?: string;
-    error?: string;
-  };
-}
-
-// ============================================================================
-// Get Security Incidents Request
-// ============================================================================
-export interface IReq_GetSecurityIncidents extends plugins.typedrequestInterfaces.implementsTR<
-  plugins.typedrequestInterfaces.ITypedRequest,
-  IReq_GetSecurityIncidents
-> {
-  method: 'getSecurityIncidents';
-  request: {
-    identity?: authInterfaces.IIdentity;
-    type?: TSecurityEventType;
-    level?: TSecurityLogLevel;
-    limit?: number;
-  };
-  response: {
-    incidents: ISecurityIncident[];
-    total: number;
-  };
-}
-
-// ============================================================================
-// Get Bounce Records Request
-// ============================================================================
-export interface IReq_GetBounceRecords extends plugins.typedrequestInterfaces.implementsTR<
-  plugins.typedrequestInterfaces.ITypedRequest,
-  IReq_GetBounceRecords
-> {
-  method: 'getBounceRecords';
-  request: {
-    identity?: authInterfaces.IIdentity;
-    limit?: number;
-    offset?: number;
-  };
-  response: {
-    records: IBounceRecord[];
-    suppressionList: string[];
-    total: number;
-  };
-}
-
-// ============================================================================
-// Remove from Suppression List Request
-// ============================================================================
-export interface IReq_RemoveFromSuppressionList extends plugins.typedrequestInterfaces.implementsTR<
-  plugins.typedrequestInterfaces.ITypedRequest,
-  IReq_RemoveFromSuppressionList
-> {
-  method: 'removeFromSuppressionList';
-  request: {
-    identity?: authInterfaces.IIdentity;
-    email: string;
-  };
-  response: {
-    success: boolean;
-    error?: string;
-  };
-}