@mesh-sync/worker-backend-client 1.0.6 → 4.0.3

package/dist/client.d.ts

@@ -37,6 +37,27 @@ export declare class WorkerClient {
      * Get job status by job ID
      */
     getJobStatus(jobId: string): Promise<JobStatus>;
+    /**
+     * Centralized logging event for capturing all warn/error/failure logs from meshsync-backend.
+  This event is sent to ELK for centralized monitoring, alerting, and debugging.
+  
+  Automatically emitted by the custom Pino logger interceptor when:
+  - logger.warn() is called
+  - logger.error() is called
+  - uncaught exceptions occur
+  - request failures happen (4xx, 5xx responses)
+  
+  Used for:
+  - System health monitoring
+  - Error tracking and alerting
+  - Performance degradation detection
+  - Security incident tracking
+  - Compliance and audit trails
+  
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    backendLoggingEvent(data: types.BackendLoggingEventMessage): Promise<JobResponse>;
     /**
      * Contains synced analytics data for Etsy listings. Backend stores this in etsy_analytics_snapshots table and indexes to ELK.
   
@@ -75,7 +96,7 @@ export declare class WorkerClient {
      */
     fileDownloadCompleted(data: types.FileDownloadCompletedMessage): Promise<JobResponse>;
     /**
-     * Handles file download requests.
+     * Downloads model file from storage provider to MinIO for processing pipeline. Acts as parent job for thumbnail generation, technical metadata analysis, and metadata generation.
      * @param data - The message payload
      * @returns Job response with job ID
      */
@@ -92,6 +113,50 @@ export declare class WorkerClient {
      * @returns Job response with job ID
      */
     marketplaceAnalyticsSyncRequest(data: types.MarketplaceAnalyticsSyncRequestMessage): Promise<JobResponse>;
+    /**
+     * Notification that marketplace connection sync has completed. Contains updated connection metadata, profile information, and sync statistics.
+  
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    marketplaceConnectionSyncCompleted(data: types.MarketplaceConnectionSyncCompletedMessage): Promise<JobResponse>;
+    /**
+     * Requests synchronization of marketplace connection data including: - Profile information and shop details - Account status and permissions - Available categories and shipping profiles - Rate limits and API quotas
+  This is typically triggered after initial connection or periodically to keep marketplace metadata up to date.
+  
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    marketplaceConnectionSyncRequest(data: types.MarketplaceConnectionSyncRequestMessage): Promise<JobResponse>;
+    /**
+     * Notification that marketplace credential rotation has completed. Contains the rotation results, new credential metadata, and any issues encountered.
+  
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    marketplaceCredentialRotationCompleted(data: types.MarketplaceCredentialRotationCompletedMessage): Promise<JobResponse>;
+    /**
+     * Requests rotation/refresh of marketplace connection credentials. This is used for: - OAuth token refresh when tokens are near expiry - API key rotation for enhanced security - Re-authentication after connection errors - Scheduled credential updates
+  
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    marketplaceCredentialRotationRequest(data: types.MarketplaceCredentialRotationRequestMessage): Promise<JobResponse>;
+    /**
+     * Notification that marketplace listing sync operation has completed. Contains detailed results of the sync including created/updated listings, errors encountered, and performance statistics.
+  
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    marketplaceListingSyncCompleted(data: types.MarketplaceListingSyncCompletedMessage): Promise<JobResponse>;
+    /**
+     * Requests synchronization of marketplace listings for a connection. Can sync specific listings or all listings for a marketplace connection.
+  Includes bidirectional sync: - Pull: Fetch listings from marketplace to update local database - Push: Update marketplace listings with local changes - Full: Both pull and push operations
+  
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    marketplaceListingSyncRequest(data: types.MarketplaceListingSyncRequestMessage): Promise<JobResponse>;
     /**
      * Indicates completion of marketplace listing publication. Contains external listing ID and URL, or error details if failed. Works with any marketplace provider (etsy, ebay, etc.).
      * @param data - The message payload
@@ -129,6 +194,17 @@ export declare class WorkerClient {
      * @returns Job response with job ID
      */
     metamodelMetadataGenerationRequest(data: types.MetamodelMetadataGenerationRequestMessage): Promise<JobResponse>;
+    /**
+     * Request to collect marketplace analytics for a specific metamodel.
+  Triggered by backend scheduler every 6 hours for popular/tagged metamodels.
+  
+  Worker performs targeted market searches based on metamodel metadata
+  and stores aggregated statistics in Elasticsearch for trend analysis.
+  
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    modelAnalyticsCollectionRequest(data: types.ModelAnalyticsCollectionRequestMessage): Promise<JobResponse>;
     /**
      * Handles model discovery folder processed events.
      * @param data - The message payload
@@ -154,13 +230,13 @@ export declare class WorkerClient {
      */
     modelDiscoveryScanRequest(data: types.ModelDiscoveryScanRequestMessage): Promise<JobResponse>;
     /**
-     * Handles model metadata generation completed.
+     * Notifies backend that enriched marketplace metadata generation completed. Backend updates Model entity with generated description, tags, classification, etc.
      * @param data - The message payload
      * @returns Job response with job ID
      */
     modelMetadataGenerationCompleted(data: types.ModelMetadataGenerationCompletedMessage): Promise<JobResponse>;
     /**
-     * Handles model metadata generation requests.
+     * Generates enriched marketplace metadata (SEO descriptions, tags, categories) for 3D models using LLM analysis with optional vision capabilities. Worker fetches model data from database and uses thumbnails for enhanced analysis when available. Prerequisites: file download, thumbnail generation (optional for vision), and technical metadata analysis (strongly recommended).
      * @param data - The message payload
      * @returns Job response with job ID
      */
@@ -189,6 +265,18 @@ export declare class WorkerClient {
      * @returns Job response with job ID
      */
     modelSellabilityAnalysisRequest(data: types.ModelSellabilityAnalysisRequestMessage): Promise<JobResponse>;
+    /**
+     * Handles completion of 3D model semantic analysis with generated tags and similarity results.
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    modelSemanticAnalysisCompleted(data: types.ModelSemanticAnalysisCompletedMessage): Promise<JobResponse>;
+    /**
+     * Handles 3D model semantic analysis requests using ULIP-2 neural networks and FAISS vector similarity search.
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    modelSemanticAnalysisRequest(data: types.ModelSemanticAnalysisRequestMessage): Promise<JobResponse>;
     /**
      * Reports comprehensive results of technical metadata analysis including geometry, quality metrics, and print-readiness assessment
      * @param data - The message payload
@@ -208,9 +296,58 @@ export declare class WorkerClient {
      */
     thumbnailGenerationCompleted(data: types.ThumbnailGenerationCompletedMessage): Promise<JobResponse>;
     /**
-     * Handles thumbnail generation requests with customization options.
+     * Handles thumbnail generation requests with customization options. Supports both storage provider downloads and MinIO-cached files.
      * @param data - The message payload
      * @returns Job response with job ID
      */
     thumbnailGenerationRequest(data: types.ThumbnailGenerationRequestMessage): Promise<JobResponse>;
+    /**
+     * User engagement and onboarding tracking events for analytics and behavioral insights.
+  
+  Captures key user actions throughout their journey:
+  - Account creation and onboarding steps
+  - Feature usage and adoption
+  - Model management activities
+  - Marketplace interactions
+  - Subscription changes
+  
+  Used for:
+  - User onboarding funnel analysis
+  - Feature adoption tracking
+  - User retention metrics
+  - A/B testing and experimentation
+  - Personalization and recommendations
+  - Product analytics dashboards
+  
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    userEngagementEvent(data: types.UserEngagementEventMessage): Promise<JobResponse>;
+    /**
+     * Analytics event emitted by workers for tracking processing metrics, user behavior,
+  and model statistics. Consumed by worker-analytic-collector and forwarded to ELK.
+  
+  All workers MUST emit this event upon job completion (success or failure).
+  Each worker includes its specific metrics in the `metrics` object.
+  
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    workerAnalyticsEvent(data: types.WorkerAnalyticsEventMessage): Promise<JobResponse>;
+    /**
+     * Enriched metrics event for detailed worker monitoring, cost tracking,
+  and performance analysis. Published to backend.logging.events for
+  centralized monitoring and cost attribution.
+  
+  This event is emitted by all workers on job completion and includes:
+  - LLM token usage and cost breakdown
+  - System resource consumption (CPU, RAM, disk I/O)
+  - Detailed timing breakdown by stage
+  - User and context attribution
+  - Model-specific metadata
+  
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    workerMetricsEnrichedEvent(data: types.WorkerMetricsEnrichedEventMessage): Promise<JobResponse>;
 }

package/dist/client.js

@@ -60,6 +60,29 @@ export class WorkerClient {
         }
         return await response.json();
     }
+    /**
+     * Centralized logging event for capturing all warn/error/failure logs from meshsync-backend.
+  This event is sent to ELK for centralized monitoring, alerting, and debugging.
+  
+  Automatically emitted by the custom Pino logger interceptor when:
+  - logger.warn() is called
+  - logger.error() is called
+  - uncaught exceptions occur
+  - request failures happen (4xx, 5xx responses)
+  
+  Used for:
+  - System health monitoring
+  - Error tracking and alerting
+  - Performance degradation detection
+  - Security incident tracking
+  - Compliance and audit trails
+  
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    async backendLoggingEvent(data) {
+        return this.sendToQueue(types.MessageTypes.BACKEND_LOGGING_EVENT, data);
+    }
     /**
      * Contains synced analytics data for Etsy listings. Backend stores this in etsy_analytics_snapshots table and indexes to ELK.
   
@@ -108,7 +131,7 @@ export class WorkerClient {
         return this.sendToQueue(types.MessageTypes.FILE_DOWNLOAD_COMPLETED, data);
     }
     /**
-     * Handles file download requests.
+     * Downloads model file from storage provider to MinIO for processing pipeline. Acts as parent job for thumbnail generation, technical metadata analysis, and metadata generation.
      * @param data - The message payload
      * @returns Job response with job ID
      */
@@ -131,6 +154,62 @@ export class WorkerClient {
     async marketplaceAnalyticsSyncRequest(data) {
         return this.sendToQueue(types.MessageTypes.MARKETPLACE_ANALYTICS_SYNC_REQUEST, data);
     }
+    /**
+     * Notification that marketplace connection sync has completed. Contains updated connection metadata, profile information, and sync statistics.
+  
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    async marketplaceConnectionSyncCompleted(data) {
+        return this.sendToQueue(types.MessageTypes.MARKETPLACE_CONNECTION_SYNC_COMPLETED, data);
+    }
+    /**
+     * Requests synchronization of marketplace connection data including: - Profile information and shop details - Account status and permissions - Available categories and shipping profiles - Rate limits and API quotas
+  This is typically triggered after initial connection or periodically to keep marketplace metadata up to date.
+  
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    async marketplaceConnectionSyncRequest(data) {
+        return this.sendToQueue(types.MessageTypes.MARKETPLACE_CONNECTION_SYNC_REQUEST, data);
+    }
+    /**
+     * Notification that marketplace credential rotation has completed. Contains the rotation results, new credential metadata, and any issues encountered.
+  
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    async marketplaceCredentialRotationCompleted(data) {
+        return this.sendToQueue(types.MessageTypes.MARKETPLACE_CREDENTIAL_ROTATION_COMPLETED, data);
+    }
+    /**
+     * Requests rotation/refresh of marketplace connection credentials. This is used for: - OAuth token refresh when tokens are near expiry - API key rotation for enhanced security - Re-authentication after connection errors - Scheduled credential updates
+  
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    async marketplaceCredentialRotationRequest(data) {
+        return this.sendToQueue(types.MessageTypes.MARKETPLACE_CREDENTIAL_ROTATION_REQUEST, data);
+    }
+    /**
+     * Notification that marketplace listing sync operation has completed. Contains detailed results of the sync including created/updated listings, errors encountered, and performance statistics.
+  
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    async marketplaceListingSyncCompleted(data) {
+        return this.sendToQueue(types.MessageTypes.MARKETPLACE_LISTING_SYNC_COMPLETED, data);
+    }
+    /**
+     * Requests synchronization of marketplace listings for a connection. Can sync specific listings or all listings for a marketplace connection.
+  Includes bidirectional sync: - Pull: Fetch listings from marketplace to update local database - Push: Update marketplace listings with local changes - Full: Both pull and push operations
+  
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    async marketplaceListingSyncRequest(data) {
+        return this.sendToQueue(types.MessageTypes.MARKETPLACE_LISTING_SYNC_REQUEST, data);
+    }
     /**
      * Indicates completion of marketplace listing publication. Contains external listing ID and URL, or error details if failed. Works with any marketplace provider (etsy, ebay, etc.).
      * @param data - The message payload
@@ -180,6 +259,19 @@ export class WorkerClient {
     async metamodelMetadataGenerationRequest(data) {
         return this.sendToQueue(types.MessageTypes.METAMODEL_METADATA_GENERATION_REQUEST, data);
     }
+    /**
+     * Request to collect marketplace analytics for a specific metamodel.
+  Triggered by backend scheduler every 6 hours for popular/tagged metamodels.
+  
+  Worker performs targeted market searches based on metamodel metadata
+  and stores aggregated statistics in Elasticsearch for trend analysis.
+  
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    async modelAnalyticsCollectionRequest(data) {
+        return this.sendToQueue(types.MessageTypes.MODEL_ANALYTICS_COLLECTION_REQUEST, data);
+    }
     /**
      * Handles model discovery folder processed events.
      * @param data - The message payload
@@ -213,7 +305,7 @@ export class WorkerClient {
         return this.sendToQueue(types.MessageTypes.MODEL_DISCOVERY_SCAN_REQUEST, data);
     }
     /**
-     * Handles model metadata generation completed.
+     * Notifies backend that enriched marketplace metadata generation completed. Backend updates Model entity with generated description, tags, classification, etc.
      * @param data - The message payload
      * @returns Job response with job ID
      */
@@ -221,7 +313,7 @@ export class WorkerClient {
         return this.sendToQueue(types.MessageTypes.MODEL_METADATA_GENERATION_COMPLETED, data);
     }
     /**
-     * Handles model metadata generation requests.
+     * Generates enriched marketplace metadata (SEO descriptions, tags, categories) for 3D models using LLM analysis with optional vision capabilities. Worker fetches model data from database and uses thumbnails for enhanced analysis when available. Prerequisites: file download, thumbnail generation (optional for vision), and technical metadata analysis (strongly recommended).
      * @param data - The message payload
      * @returns Job response with job ID
      */
@@ -260,6 +352,22 @@ export class WorkerClient {
     async modelSellabilityAnalysisRequest(data) {
         return this.sendToQueue(types.MessageTypes.MODEL_SELLABILITY_ANALYSIS_REQUEST, data);
     }
+    /**
+     * Handles completion of 3D model semantic analysis with generated tags and similarity results.
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    async modelSemanticAnalysisCompleted(data) {
+        return this.sendToQueue(types.MessageTypes.MODEL_SEMANTIC_ANALYSIS_COMPLETED, data);
+    }
+    /**
+     * Handles 3D model semantic analysis requests using ULIP-2 neural networks and FAISS vector similarity search.
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    async modelSemanticAnalysisRequest(data) {
+        return this.sendToQueue(types.MessageTypes.MODEL_SEMANTIC_ANALYSIS_REQUEST, data);
+    }
     /**
      * Reports comprehensive results of technical metadata analysis including geometry, quality metrics, and print-readiness assessment
      * @param data - The message payload
@@ -285,11 +393,66 @@ export class WorkerClient {
         return this.sendToQueue(types.MessageTypes.THUMBNAIL_GENERATION_COMPLETED, data);
     }
     /**
-     * Handles thumbnail generation requests with customization options.
+     * Handles thumbnail generation requests with customization options. Supports both storage provider downloads and MinIO-cached files.
      * @param data - The message payload
      * @returns Job response with job ID
      */
     async thumbnailGenerationRequest(data) {
         return this.sendToQueue(types.MessageTypes.THUMBNAIL_GENERATION_REQUEST, data);
     }
+    /**
+     * User engagement and onboarding tracking events for analytics and behavioral insights.
+  
+  Captures key user actions throughout their journey:
+  - Account creation and onboarding steps
+  - Feature usage and adoption
+  - Model management activities
+  - Marketplace interactions
+  - Subscription changes
+  
+  Used for:
+  - User onboarding funnel analysis
+  - Feature adoption tracking
+  - User retention metrics
+  - A/B testing and experimentation
+  - Personalization and recommendations
+  - Product analytics dashboards
+  
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    async userEngagementEvent(data) {
+        return this.sendToQueue(types.MessageTypes.USER_ENGAGEMENT_EVENT, data);
+    }
+    /**
+     * Analytics event emitted by workers for tracking processing metrics, user behavior,
+  and model statistics. Consumed by worker-analytic-collector and forwarded to ELK.
+  
+  All workers MUST emit this event upon job completion (success or failure).
+  Each worker includes its specific metrics in the `metrics` object.
+  
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    async workerAnalyticsEvent(data) {
+        return this.sendToQueue(types.MessageTypes.WORKER_ANALYTICS_EVENT, data);
+    }
+    /**
+     * Enriched metrics event for detailed worker monitoring, cost tracking,
+  and performance analysis. Published to backend.logging.events for
+  centralized monitoring and cost attribution.
+  
+  This event is emitted by all workers on job completion and includes:
+  - LLM token usage and cost breakdown
+  - System resource consumption (CPU, RAM, disk I/O)
+  - Detailed timing breakdown by stage
+  - User and context attribution
+  - Model-specific metadata
+  
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    async workerMetricsEnrichedEvent(data) {
+        return this.sendToQueue(types.MessageTypes.WORKER_METRICS_ENRICHED_EVENT, data);
+    }
 }