@mesh-sync/worker-backend-client 1.0.6 → 4.0.0-pr.51.20260312131431

package/dist/client.d.ts

@@ -37,6 +37,35 @@ export declare class WorkerClient {
      * Get job status by job ID
      */
     getJobStatus(jobId: string): Promise<JobStatus>;
+    /**
+     * Request to trigger a manual market data collection job.
+  Used for ad-hoc scraping of specific queries on marketplaces.
+  
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    analyticsCollectionRequest(data: types.AnalyticsCollectionRequestMessage): Promise<JobResponse>;
+    /**
+     * 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,35 +104,186 @@ 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.
+  
+  Retry Configuration:
+  - Automatic retry enabled for transient failures (connection errors, timeouts)
+  - Default: 5 attempts with exponential backoff (2s, 4s, 8s, 16s, 32s)
+  - Retry on: STORAGE_TIMEOUT, NETWORK_ERROR, MINIO_UNAVAILABLE, CONNECTION_REFUSED
+  - No retry on: INVALID_CREDENTIALS, FILE_NOT_FOUND, PERMISSION_DENIED
+  
      * @param data - The message payload
      * @returns Job response with job ID
      */
     fileDownloadRequest(data: types.FileDownloadRequestMessage): Promise<JobResponse>;
     /**
-     * Contains synced analytics data for marketplace listings. Backend stores this in marketplace_analytics_snapshots table and indexes to ELK. Works with any marketplace provider.
+     * Result of the vectorization process containing the embedding vector.
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    fileVectorizeCompleted(data: types.FileVectorizeCompletedMessage): Promise<JobResponse>;
+    /**
+     * Request to generate a vector embedding for an image file using CLIP.
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    fileVectorizeRequest(data: types.FileVectorizeRequestMessage): Promise<JobResponse>;
+    /**
+     * Contains IP verification results including trademark risk, copyright risk, detected brands/franchises, and analysis confidence scores
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    ipCheckCompleted(data: types.IpCheckCompletedMessage): Promise<JobResponse>;
+    /**
+     * Triggers intellectual property verification analysis for a model thumbnail, detecting potential trademark and copyright issues using perceptual hashing, text analysis, and optional reverse image search.
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    ipCheckRequest(data: types.IpCheckRequestMessage): 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>;
+    /**
+     * Response from marketplace intelligence scraping.
+  Contains aggregated similarity data from marketplace searches.
+  
+  Consumed by worker-backend to update pipeline context before
+  sellability analysis runs.
+  
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    marketplaceIntelligenceCompleted(data: types.MarketplaceIntelligenceCompletedMessage): Promise<JobResponse>;
+    /**
+     * Public marketplace intelligence data scraped from external marketplaces.
+  
+  This event contains:
+  - Listing details (title, price, images)
+  - Engagement metrics (views, favorites, reviews)
+  - Shop information
+  - Market positioning data
+  
+  Unlike marketplace-listing-sync-request (private user data), this focuses on:
+  - Broad market trends and pricing analysis
+  - Competitive intelligence and demand signals
+  - Product popularity and sentiment
+  
+  Consumed by worker-analytic-collector for Elasticsearch indexing.
+  Used for market research, pricing optimization, and trend detection.
+  
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    marketplaceIntelligenceEvent(data: types.MarketplaceIntelligenceEventMessage): Promise<JobResponse>;
+    /**
+     * Triggers automated marketplace scraping to find similar/competing listings
+  for a given model. This is a pipeline stage that runs after metadata generation
+  to inform sellability analysis with real market data.
+  
+  The worker-analytic-collector (or marketplace-connectors worker) will:
+  1. Use model metadata (title, tags, category) to build search queries
+  2. Scrape connected marketplaces (Etsy, eBay, etc.) for similar listings
+  3. Emit marketplace-intelligence-event results for Elasticsearch indexing
+  4. Return aggregated similarity data to the pipeline context
+  
+  Pipeline integration:
+  - Triggered after: metadata-generation (needs model title/tags/category)
+  - Results feed into: sellability-analysis (market positioning data)
+  
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    marketplaceIntelligenceRequest(data: types.MarketplaceIntelligenceRequestMessage): Promise<JobResponse>;
+    /**
+     * Notifies backend that marketplace description generation completed. Contains generated description with metadata tracking (AI model, confidence, generation timestamp) and suggested price.
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    marketplaceListingDescriptionGenerationCompleted(data: types.MarketplaceListingDescriptionGenerationCompletedMessage): Promise<JobResponse>;
+    /**
+     * Generates SEO-optimized marketplace description for a 3D model using LLM vision analysis. Worker receives model data, technical metadata, and thumbnail URLs to generate compelling product descriptions tailored to the target marketplace.
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    marketplaceListingDescriptionGenerationRequest(data: types.MarketplaceListingDescriptionGenerationRequestMessage): 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>;
+    /**
+     * Notifies backend that marketplace tags generation completed. Contains generated tags optimized for discoverability with metadata tracking.
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    marketplaceListingTagsGenerationCompleted(data: types.MarketplaceListingTagsGenerationCompletedMessage): Promise<JobResponse>;
+    /**
+     * Generates searchability tags for a 3D model optimized for marketplace discoverability. Worker creates style, technical, and usage keywords following marketplace tag limits and SEO best practices.
      * @param data - The message payload
      * @returns Job response with job ID
      */
-    marketplaceAnalyticsSyncCompleted(data: types.MarketplaceAnalyticsSyncCompletedMessage): Promise<JobResponse>;
+    marketplaceListingTagsGenerationRequest(data: types.MarketplaceListingTagsGenerationRequestMessage): Promise<JobResponse>;
     /**
-     * Syncs analytics data from marketplace API for one or more listings. Fetches views, favorites, sales, revenue, and traffic source data. Can sync: specific listings, all user listings, or shop-level analytics. Works with any marketplace provider that supports analytics (etsy, ebay, etc.).
+     * Notifies backend that marketplace title generation completed. Contains generated title with metadata tracking.
      * @param data - The message payload
      * @returns Job response with job ID
      */
-    marketplaceAnalyticsSyncRequest(data: types.MarketplaceAnalyticsSyncRequestMessage): Promise<JobResponse>;
+    marketplaceListingTitleGenerationCompleted(data: types.MarketplaceListingTitleGenerationCompletedMessage): 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.).
+     * Generates marketplace-optimized title for a 3D model. Worker creates concise, SEO-friendly titles following marketplace character limits and best practices.
      * @param data - The message payload
      * @returns Job response with job ID
      */
-    marketplacePublishListingCompleted(data: types.MarketplacePublishListingCompletedMessage): Promise<JobResponse>;
+    marketplaceListingTitleGenerationRequest(data: types.MarketplaceListingTitleGenerationRequestMessage): Promise<JobResponse>;
     /**
-     * Publishes a single metamodel listing to a marketplace for a specific material variant. Creates listing, uploads digital file, and returns external listing ID. This message is enqueued for EACH material variant when publishing a metamodel. The marketplace type (etsy, ebay, etc.) is determined by the marketplaceProvider field.
+     * Result of a listing update operation
      * @param data - The message payload
      * @returns Job response with job ID
      */
-    marketplacePublishListingRequest(data: types.MarketplacePublishListingRequestMessage): Promise<JobResponse>;
+    marketplaceListingUpdateCompleted(data: types.MarketplaceListingUpdateCompletedMessage): Promise<JobResponse>;
+    /**
+     * Request to update an existing listing on a marketplace (price, quantity, etc.)
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    marketplaceListingUpdateRequest(data: types.MarketplaceListingUpdateRequestMessage): Promise<JobResponse>;
     /**
      * Notifies that a batch media download has been completed.
      * @param data - The message payload
@@ -129,6 +309,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 +345,31 @@ export declare class WorkerClient {
      */
     modelDiscoveryScanRequest(data: types.ModelDiscoveryScanRequestMessage): Promise<JobResponse>;
     /**
-     * Handles model metadata generation completed.
+     * DEPRECATED (2026-02-18) — FR-023 retired. Merge 3D rendering into worker-file-vectorize.
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    modelFinderIndexRequest(data: types.ModelFinderIndexRequestMessage): Promise<JobResponse>;
+    /**
+     * DEPRECATED (2026-02-18) — FR-023 retired. Merge 3D rendering into worker-file-vectorize.
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    modelFinderResponse(data: types.ModelFinderResponseMessage): Promise<JobResponse>;
+    /**
+     * DEPRECATED (2026-02-18) — FR-023 retired. Merge 3D rendering into worker-file-vectorize.
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    modelFinderSearchRequest(data: types.ModelFinderSearchRequestMessage): Promise<JobResponse>;
+    /**
+     * 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 vision analysis. Worker receives all necessary data in the payload (Model, TechnicalMetadata, Thumbnails) and does NOT query the database. Prerequisites: file download, technical metadata, and thumbnail generation must be complete before this message is sent.
      * @param data - The message payload
      * @returns Job response with job ID
      */
@@ -177,6 +386,18 @@ export declare class WorkerClient {
      * @returns Job response with job ID
      */
     modelMetamodelDetectionRequest(data: types.ModelMetamodelDetectionRequestMessage): Promise<JobResponse>;
+    /**
+     * Reports completion of 3D print analysis — contains estimation, printability, and cost breakdown per FR-022
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    modelPrintAnalysisCompleted(data: types.ModelPrintAnalysisCompletedMessage): Promise<JobResponse>;
+    /**
+     * Triggers 3D print analysis for a model — estimates print time, material usage, support needs, and cost breakdown per FR-022
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    modelPrintAnalysisRequest(data: types.ModelPrintAnalysisRequestMessage): Promise<JobResponse>;
     /**
      * Contains sellability analysis results including Etsy-specific recommendations, material pricing, and marketplace compatibility scores
      * @param data - The message payload
@@ -189,6 +410,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
@@ -201,6 +434,42 @@ export declare class WorkerClient {
      * @returns Job response with job ID
      */
     modelTechnicalMetadataRequest(data: types.ModelTechnicalMetadataRequestMessage): Promise<JobResponse>;
+    /**
+     * Request FDM slicing simulation via OrcaSlicer (preferred) or heuristic fallback. Accepts OrcaSlicer-compatible printer/process/filament JSON profiles.
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    slicingFdmRequest(data: types.SlicingFdmRequestMessage): Promise<JobResponse>;
+    /**
+     * Result of FDM slicing simulation from OrcaSlicer (toolpath) or heuristic fallback. Contains exact physical metrics for cost calculation.
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    slicingFdmResult(data: types.SlicingFdmResultMessage): Promise<JobResponse>;
+    /**
+     * Request SLA/MSLA slicing simulation via PySLM cross-sectional analysis. Accepts resin printer profile with exposure, lift, and layer parameters.
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    slicingSlaRequest(data: types.SlicingSlaRequestMessage): Promise<JobResponse>;
+    /**
+     * Result of SLA/MSLA slicing simulation from PySLM cross-sectional analysis. Contains exact resin usage and print time metrics.
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    slicingSlaResult(data: types.SlicingSlaResultMessage): Promise<JobResponse>;
+    /**
+     * Emitted when AI texture generation completes (success or failure). Contains artifact S3 URLs on success, or error details on failure. The credit reservation should be confirmed (success) or released (failure) based on the status.
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    textureGenerationCompleted(data: types.TextureGenerationCompletedMessage): Promise<JobResponse>;
+    /**
+     * Request AI-powered texture generation for a 3D model. Requires a mesh file URL and a text prompt describing the desired texture. Credits are reserved before dispatch.
+     * @param data - The message payload
+     * @returns Job response with job ID
+     */
+    textureGenerationRequest(data: types.TextureGenerationRequestMessage): Promise<JobResponse>;
     /**
      * Handles thumbnail generation completed.
      * @param data - The message payload
@@ -208,9 +477,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>;
 }