xypriss 9.11.13 → 9.12.0

package/dist/src/types/mod/routing.d.ts

@@ -0,0 +1,385 @@
+/**
+ * @fileoverview Routing-related type definitions for XyPriss integration
+ *
+ * This module contains all routing-related types including route configuration,
+ * caching, security, validation, and optimization.
+ *
+ * @version 4.5.11
+ * @author XyPrissJS Team
+ * @since 2025-01-06
+ */
+import { Request } from "../types";
+import { RouteHandler, MiddlewareFunction } from "./core";
+import { RouteSecurityConfig } from "./security";
+/**
+ * HTTP methods supported by the routing system.
+ */
+export type HttpMethod = "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "ALL";
+/**
+ * Route configuration interface.
+ *
+ * Comprehensive configuration for individual routes including
+ * handlers, middleware, caching, security, and validation.
+ *
+ * @interface RouteConfig
+ *
+ * @example
+ * ```typescript
+ * const routeConfig: RouteConfig = {
+ *   path: '/api/users/:id',
+ *   method: 'GET',
+ *   handler: async (req, res, next) => {
+ *     const user = await getUserById(req.params.id);
+ *     res.success(user);
+ *   },
+ *   middleware: [authMiddleware, validationMiddleware],
+ *   cache: {
+ *     enabled: true,
+ *     ttl: 300,
+ *     key: (req) => `user:${req.params.id}`,
+ *     tags: ['users']
+ *   },
+ *   security: {
+ *     auth: true,
+ *     roles: ['user', 'admin'],
+ *     sanitization: true
+ *   },
+ *   rateLimit: {
+ *     max: 100,
+ *     windowMs: 900000
+ *   },
+ *   validation: {
+ *     params: { id: 'string' },
+ *     required: ['id']
+ *   }
+ * };
+ * ```
+ */
+export interface RouteConfig {
+    /** Route path pattern */
+    path: string;
+    /** HTTP method */
+    method?: HttpMethod;
+    /** Route handler function */
+    handler: RouteHandler;
+    /** Middleware functions to apply */
+    middleware?: MiddlewareFunction[];
+    /** Route-specific cache configuration */
+    cache?: RouteCacheConfig;
+    /** Route-specific security configuration */
+    security?: RouteSecurityConfig;
+    /** Route-specific rate limiting */
+    rateLimit?: RouteRateLimitConfig;
+    /** Request validation configuration */
+    validation?: RouteValidationConfig;
+}
+/**
+ * Route cache configuration interface.
+ *
+ * Configuration for route-specific caching including
+ * TTL, cache keys, tags, and invalidation rules.
+ *
+ * @interface RouteCacheConfig
+ *
+ * @example
+ * ```typescript
+ * const routeCacheConfig: RouteCacheConfig = {
+ *   enabled: true,
+ *   ttl: 300, // 5 minutes
+ *   key: (req) => `api:users:${req.params.id}:${req.query.include}`,
+ *   tags: ['users', 'api'],
+ *   invalidateOn: ['user:updated', 'user:deleted'],
+ *   compression: true
+ * };
+ * ```
+ */
+export interface RouteCacheConfig {
+    /** Enable caching for this route */
+    enabled?: boolean;
+    /** Cache TTL in seconds */
+    ttl?: number;
+    /** Cache key generator */
+    key?: string | ((req: Request) => string);
+    /** Cache tags for invalidation */
+    tags?: string[];
+    /** Events that should invalidate this cache */
+    invalidateOn?: string[];
+    /** Enable compression for cached responses */
+    compression?: boolean;
+}
+/**
+ * Route rate limiting configuration interface.
+ *
+ * Configuration for route-specific rate limiting extending
+ * the base rate limit configuration.
+ *
+ * @interface RouteRateLimitConfig
+ *
+ * @example
+ * ```typescript
+ * const routeRateLimitConfig: RouteRateLimitConfig = {
+ *   windowMs: 900000, // 15 minutes
+ *   max: 50, // 50 requests per window
+ *   message: 'Too many requests to this endpoint',
+ *   keyGenerator: (req) => `${req.ip}:${req.path}`,
+ *   skip: (req) => req.user?.role === 'admin'
+ * };
+ * ```
+ */
+export interface RouteRateLimitConfig {
+    /** Time window in milliseconds */
+    windowMs?: number;
+    /** Maximum requests per window */
+    max?: number;
+    /** Message when limit is exceeded */
+    message?: string;
+    /** Include standard rate limit headers */
+    standardHeaders?: boolean;
+    /** Include legacy rate limit headers */
+    legacyHeaders?: boolean;
+    /** Custom key generator for rate limiting */
+    keyGenerator?: (req: Request) => string;
+    /** Function to skip rate limiting for certain requests */
+    skip?: (req: Request) => boolean;
+}
+/**
+ * Route validation configuration interface.
+ *
+ * Configuration for request validation including
+ * body, query, and parameter validation.
+ *
+ * @interface RouteValidationConfig
+ *
+ * @example
+ * ```typescript
+ * const routeValidationConfig: RouteValidationConfig = {
+ *   body: {
+ *     name: { type: 'string', minLength: 2, maxLength: 50 },
+ *     email: { type: 'email' },
+ *     age: { type: 'number', min: 18, max: 120 }
+ *   },
+ *   query: {
+ *     page: { type: 'number', min: 1, default: 1 },
+ *     limit: { type: 'number', min: 1, max: 100, default: 20 }
+ *   },
+ *   params: {
+ *     id: { type: 'string', pattern: /^[0-9a-f]{24}$/ }
+ *   },
+ *   required: ['name', 'email']
+ * };
+ * ```
+ */
+export interface RouteValidationConfig {
+    /** Request body validation schema */
+    body?: any;
+    /** Query parameters validation schema */
+    query?: any;
+    /** Route parameters validation schema */
+    params?: any;
+    /** Required fields */
+    required?: string[];
+}
+/**
+ * Route options interface for enhanced route methods.
+ *
+ * Options that can be passed to enhanced route methods
+ * like getWithCache, postWithCache, etc.
+ *
+ * @interface RouteOptions
+ *
+ * @example
+ * ```typescript
+ * const routeOptions: RouteOptions = {
+ *   cache: {
+ *     enabled: true,
+ *     ttl: 600,
+ *     strategy: 'hybrid',
+ *     tags: ['products']
+ *   },
+ *   security: {
+ *     auth: true,
+ *     roles: ['user'],
+ *     encryption: false,
+ *     sanitization: true
+ *   },
+ *   performance: {
+ *     compression: true,
+ *     timeout: 30000
+ *   }
+ * };
+ * ```
+ */
+export interface RouteOptions {
+    /** Cache configuration */
+    cache?: {
+        /** Enable caching */
+        enabled?: boolean;
+        /** Cache TTL in seconds */
+        ttl?: number;
+        /** Cache key generator */
+        key?: string | ((req: Request) => string);
+        /** Cache tags */
+        tags?: string[];
+        /** Cache invalidation events */
+        invalidateOn?: string[];
+        /** Cache strategy */
+        strategy?: "memory" | "redis" | "hybrid";
+    };
+    /** Security configuration */
+    security?: {
+        /** Require authentication */
+        auth?: boolean;
+        /** Required user roles */
+        roles?: string[];
+        /** Enable response encryption */
+        encryption?: boolean;
+        /** Enable input sanitization */
+        sanitization?: boolean;
+        /** Custom security headers */
+        headers?: Record<string, string>;
+    };
+    /** Performance configuration */
+    performance?: {
+        /** Enable response compression */
+        compression?: boolean;
+        /** Request timeout in milliseconds */
+        timeout?: number;
+    };
+    /** Direct compression setting (for backward compatibility) */
+    compression?: {
+        /** Enable compression */
+        enabled?: boolean;
+    };
+}
+/**
+ * Router configuration interface.
+ *
+ * Configuration for the high-performance router including
+ * optimization, security, and caching settings.
+ *
+ * @interface RouterConfig
+ *
+ * @example
+ * ```typescript
+ * const routerConfig: RouterConfig = {
+ *   enabled: true,
+ *   precompileCommonRoutes: true,
+ *   enableSecurity: true,
+ *   enableCaching: true,
+ *   warmUpOnStart: true,
+ *   performance: {
+ *     targetResponseTime: 1,
+ *     complexRouteTarget: 5,
+ *     enableProfiling: true,
+ *     enableOptimizations: true
+ *   },
+ *   security: {
+ *     enableValidation: true,
+ *     enableSanitization: true,
+ *     enableRateLimit: true,
+ *     defaultRateLimit: 1000
+ *   },
+ *   cache: {
+ *     enabled: true,
+ *     defaultTTL: 60000,
+ *     maxCacheSize: 1000
+ *   }
+ * };
+ * ```
+ */
+export interface RouterConfig {
+    /** Enable high-performance routing */
+    enabled?: boolean;
+    /** Pre-compile common routes */
+    precompileCommonRoutes?: boolean;
+    /** Enable security validation */
+    enableSecurity?: boolean;
+    /** Enable route caching */
+    enableCaching?: boolean;
+    /** Warm up routes on startup */
+    warmUpOnStart?: boolean;
+    /** Performance configuration */
+    performance?: {
+        /** Target response time for simple routes in ms */
+        targetResponseTime?: number;
+        /** Target response time for complex routes in ms */
+        complexRouteTarget?: number;
+        /** Enable performance profiling */
+        enableProfiling?: boolean;
+        /** Enable all optimizations */
+        enableOptimizations?: boolean;
+    };
+    /** Security configuration */
+    security?: {
+        /** Enable input validation */
+        enableValidation?: boolean;
+        /** Enable input sanitization */
+        enableSanitization?: boolean;
+        /** Enable rate limiting */
+        enableRateLimit?: boolean;
+        /** Default rate limit per minute */
+        defaultRateLimit?: number;
+    };
+    /** Cache configuration */
+    cache?: {
+        /** Enable route caching */
+        enabled?: boolean;
+        /** Default cache TTL in ms */
+        defaultTTL?: number;
+        /** Maximum cached responses */
+        maxCacheSize?: number;
+    };
+}
+/**
+ * Route statistics interface.
+ *
+ * Statistics and metrics for individual routes including
+ * performance, usage, and error metrics.
+ *
+ * @interface RouteStats
+ *
+ * @example
+ * ```typescript
+ * const routeStats: RouteStats = {
+ *   path: '/api/users/:id',
+ *   method: 'GET',
+ *   requestCount: 15420,
+ *   averageResponseTime: 45.2,
+ *   minResponseTime: 12.1,
+ *   maxResponseTime: 234.7,
+ *   errorCount: 23,
+ *   errorRate: 0.0015,
+ *   cacheHitRate: 0.78,
+ *   lastAccessed: new Date(),
+ *   isOptimized: true,
+ *   optimizationLevel: 'high'
+ * };
+ * ```
+ */
+export interface RouteStats {
+    /** Route path */
+    path: string;
+    /** HTTP method */
+    method: string;
+    /** Total number of requests */
+    requestCount: number;
+    /** Average response time in milliseconds */
+    averageResponseTime: number;
+    /** Minimum response time in milliseconds */
+    minResponseTime: number;
+    /** Maximum response time in milliseconds */
+    maxResponseTime: number;
+    /** Total number of errors */
+    errorCount: number;
+    /** Error rate (0-1) */
+    errorRate: number;
+    /** Cache hit rate (0-1) */
+    cacheHitRate: number;
+    /** Last access timestamp */
+    lastAccessed: Date;
+    /** Whether route is optimized */
+    isOptimized: boolean;
+    /** Optimization level */
+    optimizationLevel: "none" | "low" | "medium" | "high" | "ultra";
+}
+//# sourceMappingURL=routing.d.ts.map

package/dist/src/types/mod/routing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"routing.d.ts","sourceRoot":"","sources":["../../../../src/types/mod/routing.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACnC,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,QAAQ,CAAC;AAC1D,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAEjD;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,GAAG,KAAK,CAAC;AAE7E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAM,WAAW,WAAW;IACxB,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAC;IAEb,kBAAkB;IAClB,MAAM,CAAC,EAAE,UAAU,CAAC;IAEpB,6BAA6B;IAC7B,OAAO,EAAE,YAAY,CAAC;IAEtB,oCAAoC;IACpC,UAAU,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAElC,yCAAyC;IACzC,KAAK,CAAC,EAAE,gBAAgB,CAAC;IAEzB,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,mBAAmB,CAAC;IAE/B,mCAAmC;IACnC,SAAS,CAAC,EAAE,oBAAoB,CAAC;IAEjC,uCAAuC;IACvC,UAAU,CAAC,EAAE,qBAAqB,CAAC;CACtC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,WAAW,gBAAgB;IAC7B,oCAAoC;IACpC,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,2BAA2B;IAC3B,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,0BAA0B;IAC1B,GAAG,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,GAAG,EAAE,OAAO,KAAK,MAAM,CAAC,CAAC;IAE1C,kCAAkC;IAClC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhB,+CAA+C;IAC/C,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB,8CAA8C;IAC9C,WAAW,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,oBAAoB;IACjC,kCAAkC;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,kCAAkC;IAClC,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,qCAAqC;IACrC,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,0CAA0C;IAC1C,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,wCAAwC;IACxC,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB,6CAA6C;IAC7C,YAAY,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,MAAM,CAAC;IAExC,0DAA0D;IAC1D,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,OAAO,CAAC;CACpC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,qBAAqB;IAClC,qCAAqC;IACrC,IAAI,CAAC,EAAE,GAAG,CAAC;IAEX,yCAAyC;IACzC,KAAK,CAAC,EAAE,GAAG,CAAC;IAEZ,yCAAyC;IACzC,MAAM,CAAC,EAAE,GAAG,CAAC;IAEb,sBAAsB;IACtB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACvB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,WAAW,YAAY;IACzB,0BAA0B;IAC1B,KAAK,CAAC,EAAE;QACJ,qBAAqB;QACrB,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB,2BAA2B;QAC3B,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb,0BAA0B;QAC1B,GAAG,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,GAAG,EAAE,OAAO,KAAK,MAAM,CAAC,CAAC;QAE1C,iBAAiB;QACjB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;QAEhB,gCAAgC;QAChC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;QAExB,qBAAqB;QACrB,QAAQ,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAC;KAC5C,CAAC;IAEF,6BAA6B;IAC7B,QAAQ,CAAC,EAAE;QACP,6BAA6B;QAC7B,IAAI,CAAC,EAAE,OAAO,CAAC;QAEf,0BAA0B;QAC1B,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;QAEjB,iCAAiC;QACjC,UAAU,CAAC,EAAE,OAAO,CAAC;QAErB,gCAAgC;QAChC,YAAY,CAAC,EAAE,OAAO,CAAC;QAEvB,8BAA8B;QAC9B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KACpC,CAAC;IAEF,gCAAgC;IAChC,WAAW,CAAC,EAAE;QACV,kCAAkC;QAClC,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB,sCAAsC;QACtC,OAAO,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IAEF,8DAA8D;IAC9D,WAAW,CAAC,EAAE;QACV,yBAAyB;QACzB,OAAO,CAAC,EAAE,OAAO,CAAC;KACrB,CAAC;CACL;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,WAAW,YAAY;IACzB,sCAAsC;IACtC,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,gCAAgC;IAChC,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC,iCAAiC;IACjC,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB,2BAA2B;IAC3B,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB,gCAAgC;IAChC,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB,gCAAgC;IAChC,WAAW,CAAC,EAAE;QACV,mDAAmD;QACnD,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAE5B,oDAAoD;QACpD,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAE5B,mCAAmC;QACnC,eAAe,CAAC,EAAE,OAAO,CAAC;QAE1B,+BAA+B;QAC/B,mBAAmB,CAAC,EAAE,OAAO,CAAC;KACjC,CAAC;IAEF,6BAA6B;IAC7B,QAAQ,CAAC,EAAE;QACP,8BAA8B;QAC9B,gBAAgB,CAAC,EAAE,OAAO,CAAC;QAE3B,gCAAgC;QAChC,kBAAkB,CAAC,EAAE,OAAO,CAAC;QAE7B,2BAA2B;QAC3B,eAAe,CAAC,EAAE,OAAO,CAAC;QAE1B,oCAAoC;QACpC,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC7B,CAAC;IAEF,0BAA0B;IAC1B,KAAK,CAAC,EAAE;QACJ,2BAA2B;QAC3B,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB,8BAA8B;QAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,+BAA+B;QAC/B,YAAY,CAAC,EAAE,MAAM,CAAC;KACzB,CAAC;CACL;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,UAAU;IACvB,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;IAEb,kBAAkB;IAClB,MAAM,EAAE,MAAM,CAAC;IAEf,+BAA+B;IAC/B,YAAY,EAAE,MAAM,CAAC;IAErB,4CAA4C;IAC5C,mBAAmB,EAAE,MAAM,CAAC;IAE5B,4CAA4C;IAC5C,eAAe,EAAE,MAAM,CAAC;IAExB,4CAA4C;IAC5C,eAAe,EAAE,MAAM,CAAC;IAExB,6BAA6B;IAC7B,UAAU,EAAE,MAAM,CAAC;IAEnB,uBAAuB;IACvB,SAAS,EAAE,MAAM,CAAC;IAElB,2BAA2B;IAC3B,YAAY,EAAE,MAAM,CAAC;IAErB,4BAA4B;IAC5B,YAAY,EAAE,IAAI,CAAC;IAEnB,iCAAiC;IACjC,WAAW,EAAE,OAAO,CAAC;IAErB,yBAAyB;IACzB,iBAAiB,EAAE,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,CAAC;CACnE"}

package/dist/src/types/mod/routing.js

@@ -0,0 +1,12 @@
+/**
+ * @fileoverview Routing-related type definitions for XyPriss integration
+ *
+ * This module contains all routing-related types including route configuration,
+ * caching, security, validation, and optimization.
+ *
+ * @version 4.5.11
+ * @author XyPrissJS Team
+ * @since 2025-01-06
+ */
+export {};
+//# sourceMappingURL=routing.js.map

package/dist/src/types/mod/routing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"routing.js","sourceRoot":"","sources":["../../../../src/types/mod/routing.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG"}