@axova/shared 1.0.0

package/dist/interfaces/inventory-events.d.ts

@@ -0,0 +1,453 @@
+export interface ServiceEvents {
+    "inventory.item.created": {
+        inventoryItemId: string;
+        sku: string;
+        locationId: string;
+        initialQuantity: number;
+    };
+    "inventory.item.updated": {
+        inventoryItemId: string;
+        sku: string;
+        changes: Record<string, unknown>;
+    };
+    "inventory.quantity.changed": {
+        inventoryItemId: string;
+        sku: string;
+        locationId: string;
+        previousQuantity: number;
+        newQuantity: number;
+        changeType: string;
+        reason: string;
+    };
+    "inventory.low_stock.detected": {
+        inventoryItemId: string;
+        sku: string;
+        locationId: string;
+        currentQuantity: number;
+        reorderPoint: number;
+        severity: "low" | "medium" | "high" | "critical";
+    };
+    "inventory.out_of_stock.detected": {
+        inventoryItemId: string;
+        sku: string;
+        locationId: string;
+        lastAvailableDate: Date;
+    };
+    "transfer.created": {
+        transferId: string;
+        transferNumber: string;
+        sourceLocationId: string;
+        destinationLocationId: string;
+        totalItems: number;
+        priority: string;
+    };
+    "transfer.status.changed": {
+        transferId: string;
+        transferNumber: string;
+        fromStatus: string;
+        toStatus: string;
+        changedBy: string;
+    };
+    "transfer.completed": {
+        transferId: string;
+        transferNumber: string;
+        sourceLocationId: string;
+        destinationLocationId: string;
+        totalItems: number;
+        totalValue: number;
+        hasDiscrepancies: boolean;
+    };
+    "cycle_count.created": {
+        cycleCountId: string;
+        countNumber: string;
+        countType: string;
+        scheduledDate: Date;
+        totalItems: number;
+    };
+    "cycle_count.completed": {
+        cycleCountId: string;
+        countNumber: string;
+        totalItemsCounted: number;
+        accuracyPercentage: number;
+        discrepanciesFound: number;
+    };
+    "cycle_count.discrepancy.detected": {
+        cycleCountId: string;
+        cycleCountItemId: string;
+        sku: string;
+        systemQuantity: number;
+        countedQuantity: number;
+        variance: number;
+        severity: string;
+    };
+    "batch.created": {
+        batchId: string;
+        batchNumber: string;
+        sku: string;
+        initialQuantity: number;
+        expiryDate?: Date;
+    };
+    "batch.expiry.warning": {
+        batchId: string;
+        batchNumber: string;
+        sku: string;
+        expiryDate: Date;
+        daysUntilExpiry: number;
+        currentQuantity: number;
+    };
+    "batch.expired": {
+        batchId: string;
+        batchNumber: string;
+        sku: string;
+        expiryDate: Date;
+        currentQuantity: number;
+        estimatedLoss: number;
+    };
+    "automation.rule.triggered": {
+        ruleId: string;
+        ruleName: string;
+        triggerCondition: string;
+        affectedItems: string[];
+    };
+    "automation.rule.executed": {
+        ruleId: string;
+        ruleName: string;
+        executionId: string;
+        status: "success" | "failure" | "partial";
+        itemsProcessed: number;
+        duration: number;
+    };
+    "automation.recommendation.generated": {
+        recommendationType: string;
+        confidence: number;
+        affectedItems: string[];
+        estimatedImpact: number;
+    };
+    "warehouse.capacity.warning": {
+        warehouseId: string;
+        warehouseName: string;
+        currentCapacity: number;
+        maxCapacity: number;
+        utilizationPercentage: number;
+    };
+    "warehouse.zone.full": {
+        warehouseId: string;
+        zoneId: string;
+        zoneName: string;
+        utilizationPercentage: number;
+    };
+    "alert.created": {
+        alertId: string;
+        alertType: string;
+        severity: string;
+        message: string;
+        affectedItems: string[];
+    };
+    "alert.resolved": {
+        alertId: string;
+        alertType: string;
+        resolvedBy: string;
+        resolutionNotes?: string;
+    };
+    "audit.log.created": {
+        auditLogId: string;
+        eventType: string;
+        inventoryItemId: string;
+        quantityChange: number;
+        userId: string;
+    };
+    "audit.export.requested": {
+        exportId: string;
+        exportType: string;
+        requestedBy: string;
+        dateRange: {
+            startDate: Date;
+            endDate: Date;
+        };
+    };
+    "audit.export.completed": {
+        exportId: string;
+        exportType: string;
+        recordCount: number;
+        fileSize: number;
+        downloadUrl: string;
+    };
+}
+export interface ServiceConfig {
+    database: {
+        host: string;
+        port: number;
+        name: string;
+        user: string;
+        password: string;
+        ssl: boolean;
+        poolSize: number;
+        connectionTimeout: number;
+        idleTimeout: number;
+    };
+    redis: {
+        host: string;
+        port: number;
+        password?: string;
+        db: number;
+        keyPrefix: string;
+        ttl: {
+            default: number;
+            short: number;
+            long: number;
+        };
+    };
+    kafka: {
+        brokers: string[];
+        clientId: string;
+        groupId: string;
+        topics: {
+            inventory: string;
+            transfers: string;
+            cycleCounts: string;
+            batches: string;
+            automation: string;
+            alerts: string;
+            audit: string;
+        };
+        retryConfig: {
+            retries: number;
+            retryDelay: number;
+            maxRetryDelay: number;
+        };
+    };
+    service: {
+        port: number;
+        host: string;
+        name: string;
+        version: string;
+        environment: "development" | "staging" | "production";
+        logLevel: "debug" | "info" | "warn" | "error";
+        corsOrigins: string[];
+        rateLimiting: {
+            windowMs: number;
+            maxRequests: number;
+            skipSuccessfulRequests: boolean;
+        };
+    };
+    features: {
+        batchTracking: boolean;
+        serialNumberTracking: boolean;
+        aiRecommendations: boolean;
+        automation: boolean;
+        advancedAnalytics: boolean;
+        realTimeSync: boolean;
+        mobileApp: boolean;
+        apiDocumentation: boolean;
+    };
+    businessRules: {
+        inventory: {
+            allowNegativeStock: boolean;
+            autoCreateItems: boolean;
+            defaultReorderPoint: number;
+            defaultSafetyStock: number;
+            lowStockThreshold: number;
+            criticalStockThreshold: number;
+        };
+        transfers: {
+            requireApprovalAboveValue: number;
+            requireApprovalForUrgent: boolean;
+            autoApproveInternal: boolean;
+            maxPartialTransfers: number;
+            defaultLeadTime: number;
+        };
+        cycleCounts: {
+            defaultTolerancePercentage: number;
+            requireApprovalForAdjustments: boolean;
+            autoReconcileWithinTolerance: boolean;
+            maxCountsPerDay: number;
+            requiredPhotosForDiscrepancies: boolean;
+        };
+        batches: {
+            expiryWarningDays: number;
+            criticalExpiryDays: number;
+            autoQuarantineExpired: boolean;
+            requireQualityApproval: boolean;
+            fifoEnforcement: boolean;
+        };
+        automation: {
+            maxRulesPerTenant: number;
+            maxExecutionsPerDay: number;
+            requireApprovalForHighValue: boolean;
+            enableMachineLearning: boolean;
+            confidenceThreshold: number;
+        };
+    };
+    integrations: {
+        erp: {
+            enabled: boolean;
+            endpoint: string;
+            apiKey: string;
+            syncInterval: number;
+            timeout: number;
+        };
+        pos: {
+            enabled: boolean;
+            syncInterval: number;
+            offlineThreshold: number;
+            conflictResolution: "server_wins" | "client_wins" | "manual";
+        };
+        ecommerce: {
+            enabled: boolean;
+            realTimeInventory: boolean;
+            reservationTimeout: number;
+            stockBuffer: number;
+        };
+        wms: {
+            enabled: boolean;
+            endpoint: string;
+            autoReceiveTransfers: boolean;
+            binLocationSync: boolean;
+        };
+        notifications: {
+            email: {
+                enabled: boolean;
+                smtpHost: string;
+                smtpPort: number;
+                username: string;
+                password: string;
+                fromAddress: string;
+            };
+            sms: {
+                enabled: boolean;
+                provider: string;
+                apiKey: string;
+                fromNumber: string;
+            };
+            webhook: {
+                enabled: boolean;
+                endpoints: Array<{
+                    url: string;
+                    events: string[];
+                    authentication: {
+                        type: "none" | "api_key" | "bearer_token";
+                        credentials: Record<string, string>;
+                    };
+                }>;
+            };
+        };
+    };
+    security: {
+        jwt: {
+            secret: string;
+            expiresIn: string;
+            issuer: string;
+            audience: string;
+        };
+        encryption: {
+            algorithm: string;
+            keySize: number;
+            saltRounds: number;
+        };
+        rateLimiting: {
+            enabled: boolean;
+            windowMs: number;
+            maxRequests: number;
+            skipSuccessfulRequests: boolean;
+        };
+        auditLogging: {
+            enabled: boolean;
+            logAllRequests: boolean;
+            retentionDays: number;
+            complianceMode: boolean;
+        };
+    };
+    performance: {
+        caching: {
+            enabled: boolean;
+            defaultTtl: number;
+            inventoryTtl: number;
+            analyticsTtl: number;
+        };
+        pagination: {
+            defaultLimit: number;
+            maxLimit: number;
+        };
+        backgroundJobs: {
+            enabled: boolean;
+            concurrency: number;
+            retryAttempts: number;
+            retryDelay: number;
+        };
+    };
+    monitoring: {
+        healthChecks: {
+            enabled: boolean;
+            interval: number;
+            timeout: number;
+        };
+        metrics: {
+            enabled: boolean;
+            endpoint: string;
+            interval: number;
+        };
+        tracing: {
+            enabled: boolean;
+            serviceName: string;
+            endpoint: string;
+            sampleRate: number;
+        };
+        logging: {
+            level: string;
+            format: "json" | "text";
+            destination: "console" | "file" | "both";
+            maxFileSize: string;
+            maxFiles: number;
+        };
+    };
+}
+export type EventPayload<T extends keyof ServiceEvents> = ServiceEvents[T];
+export type EventHandler<T extends keyof ServiceEvents> = (payload: EventPayload<T>) => Promise<void> | void;
+export interface EventEmitter {
+    emit<T extends keyof ServiceEvents>(event: T, payload: EventPayload<T>): Promise<void>;
+    on<T extends keyof ServiceEvents>(event: T, handler: EventHandler<T>): void;
+    off<T extends keyof ServiceEvents>(event: T, handler: EventHandler<T>): void;
+}
+export interface HealthCheckResult {
+    status: "healthy" | "unhealthy" | "degraded";
+    timestamp: Date;
+    duration: number;
+    checks: {
+        database: {
+            status: "healthy" | "unhealthy";
+            latency: number;
+            error?: string;
+        };
+        redis: {
+            status: "healthy" | "unhealthy";
+            latency: number;
+            error?: string;
+        };
+        kafka: {
+            status: "healthy" | "unhealthy";
+            latency: number;
+            error?: string;
+        };
+        externalServices: {
+            status: "healthy" | "unhealthy" | "degraded";
+            services: Array<{
+                name: string;
+                status: "healthy" | "unhealthy";
+                latency: number;
+                error?: string;
+            }>;
+        };
+    };
+    metadata: {
+        version: string;
+        uptime: number;
+        memory: {
+            used: number;
+            total: number;
+            percentage: number;
+        };
+        cpu: {
+            usage: number;
+        };
+    };
+}

package/dist/interfaces/inventory-events.js

@@ -0,0 +1,3 @@
+"use strict";
+// Inventory service events and configuration interfaces
+Object.defineProperty(exports, "__esModule", { value: true });