@plyaz/types 1.46.1 → 1.46.2

package/dist/core/init/index.d.ts

@@ -2,4 +2,4 @@
  * Core Init Types
  * Service registry and initialization type definitions
  */
-export type { CoreDomainServiceInstance, CoreServiceInitConfig, CoreServiceCreateOptions, CoreInitializableDomainService, CoreServiceEntry, CoreServiceRegistryConfig, CoreExtractServiceConfig, CoreExtractServiceInstance, CoreFeatureFlagInitConfig, CoreErrorHandlerInitConfig, CoreCacheConfig, CoreStorageConfig, CoreNotificationConfig, CoreObservabilityConfig, CoreStreamConfig, CoreInitOptionsBase, CoreServicesResultBase, } from './types';
+export type { CoreDomainServiceInstance, CoreServiceInitConfig, CoreServiceCreateOptions, CoreInitializableDomainService, CoreServiceEntry, CoreServiceRegistryConfig, CoreExtractServiceConfig, CoreExtractServiceInstance, CoreFeatureFlagInitConfig, CoreErrorHandlerInitConfig, CoreCacheConfig, CoreStorageConfig, CoreNotificationConfig, CoreObservabilityConfig, CoreStreamConfig, CoreInitOptionsBase, CoreServicesResultBase, CoreNestJsMiddlewareConfig, CoreNestJsRateLimitConfig, CoreNestJsValidationConfig, CoreNestJsSwaggerConfig, } from './types';

package/dist/core/init/types.d.ts

@@ -787,6 +787,142 @@ export interface CoreStreamConfig {
         maxConnections?: number;
     };
 }
+/**
+ * Rate limiting configuration for NestJS
+ */
+export interface CoreNestJsRateLimitConfig {
+    /** Time window in seconds (default: 60) */
+    ttl?: number;
+    /** Max requests per window (default: 100) */
+    limit?: number;
+    /** Skip rate limiting for certain paths */
+    skipIf?: (request: unknown) => boolean;
+}
+/**
+ * Validation pipe configuration for NestJS
+ */
+export interface CoreNestJsValidationConfig {
+    /** Strip properties not in DTO (default: true) */
+    whitelist?: boolean;
+    /** Throw on non-whitelisted properties (default: false) */
+    forbidNonWhitelisted?: boolean;
+    /** Transform payloads to DTO instances (default: true) */
+    transform?: boolean;
+    /** Disable error messages (default: false) */
+    disableErrorMessages?: boolean;
+}
+/**
+ * Swagger/OpenAPI configuration for NestJS
+ */
+export interface CoreNestJsSwaggerConfig {
+    /** Enable Swagger (default: false in production) */
+    enabled?: boolean;
+    /** Swagger path (default: '/api/docs') */
+    path?: string;
+    /** API title */
+    title?: string;
+    /** API description */
+    description?: string;
+    /** API version */
+    version?: string;
+    /** Bearer auth enabled */
+    bearerAuth?: boolean;
+}
+/**
+ * NestJS middleware and configuration options.
+ * Applied during app bootstrap via configureNestApp().
+ *
+ * @example
+ * ```typescript
+ * await Core.initialize({
+ *   nestjs: {
+ *     compression: true,
+ *     helmet: true,
+ *     rateLimit: { ttl: 60, limit: 100 },
+ *     validation: { whitelist: true, transform: true },
+ *     bodyLimit: '10mb',
+ *     timeout: 30000,
+ *     rawBody: true,
+ *     swagger: { enabled: true, path: '/api/docs' },
+ *   },
+ * });
+ * ```
+ */
+export interface CoreNestJsMiddlewareConfig {
+    /**
+     * Enable response compression (default: true in production).
+     * Uses compression middleware for gzip/brotli.
+     */
+    compression?: boolean;
+    /**
+     * Enable Helmet security headers (default: true).
+     * Adds XSS protection, content security policy, etc.
+     */
+    helmet?: boolean | Record<string, unknown>;
+    /**
+     * Rate limiting configuration.
+     * Set to false to disable, true for defaults, or object for custom config.
+     */
+    rateLimit?: boolean | CoreNestJsRateLimitConfig;
+    /**
+     * Global validation pipe configuration.
+     * Enables class-validator for DTO validation.
+     */
+    validation?: boolean | CoreNestJsValidationConfig;
+    /**
+     * Maximum request body size (default: '10mb').
+     * Accepts string like '1mb', '10kb', or number in bytes.
+     */
+    bodyLimit?: string | number;
+    /**
+     * Request timeout in milliseconds (default: 30000).
+     * Set to 0 to disable timeout.
+     */
+    timeout?: number;
+    /**
+     * Enable raw body parsing for webhooks (default: false).
+     * Required for signature verification (Stripe, GitHub, etc.).
+     * When enabled, raw body is available on request.rawBody.
+     */
+    rawBody?: boolean | {
+        paths?: string[];
+    };
+    /**
+     * Swagger/OpenAPI documentation configuration.
+     * Set to false to disable, true for defaults, or object for custom config.
+     */
+    swagger?: boolean | CoreNestJsSwaggerConfig;
+    /**
+     * CORS configuration override.
+     * By default, uses app-level CORS. Set here to override.
+     */
+    cors?: boolean | {
+        origin?: string | string[] | boolean;
+        credentials?: boolean;
+        methods?: string[];
+        allowedHeaders?: string[];
+    };
+    /**
+     * Global prefix for all routes (default: 'api').
+     * Set to false to disable prefix.
+     */
+    globalPrefix?: string | false;
+    /**
+     * Routes to exclude from global prefix.
+     * @example ['health', 'metrics', 'webhooks/*']
+     */
+    excludeFromPrefix?: string[];
+    /**
+     * Enable graceful shutdown handling (default: true).
+     * Registers SIGTERM/SIGINT handlers for clean shutdown.
+     */
+    gracefulShutdown?: boolean;
+    /**
+     * Shutdown timeout in milliseconds (default: 10000).
+     * Time to wait for graceful shutdown before force exit.
+     */
+    shutdownTimeout?: number;
+}
 /**
  * Base core initialization options
  * Extended by @plyaz/core's CoreInitOptions with specific types
@@ -848,6 +984,12 @@ export interface CoreInitOptionsBase<TDb = unknown, TApi = unknown, TStorage = u
     featureFlags?: CoreFeatureFlagInitConfig;
     /** Domain services to auto-initialize */
     services?: CoreServiceEntry[];
+    /**
+     * NestJS-specific middleware and configuration.
+     * Applied during app bootstrap via configureNestApp().
+     * Only used when runtime is 'nestjs'.
+     */
+    nestjs?: CoreNestJsMiddlewareConfig;
 }
 /**
  * Core services result from initialization

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plyaz/types",
-  "version": "1.46.1",
+  "version": "1.46.2",
   "author": "Redeemer Pace",
   "license": "ISC",
   "description": "Provides shared TypeScript types and schema utilities for validation and parsing in the @playz ecosystem.",