@mesh-sync/worker-backend-client 4.0.4 → 4.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -3
- package/dist/client.d.ts +1 -1
- package/dist/client.js +1 -1
- package/dist/types.d.ts +4 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -336,6 +336,8 @@ Example: Publishing a metamodel with PLA, Resin, ABS materials creates 3 jobs.
|
|
|
336
336
|
|
|
337
337
|
- `generate360Views` (boolean) [✗]: Generate 16 angle views for 360° preview (passed to child job).
|
|
338
338
|
|
|
339
|
+
- `webhookUrl` (string) [✗]: Optional webhook URL to call when download completes. If provided, worker will POST completion status to this endpoint.
|
|
340
|
+
|
|
339
341
|
|
|
340
342
|
|
|
341
343
|
### marketplace-analytics-sync-completed
|
|
@@ -924,7 +926,7 @@ and stores aggregated statistics in Elasticsearch for trend analysis.
|
|
|
924
926
|
|
|
925
927
|
### model-metadata-generation-request
|
|
926
928
|
|
|
927
|
-
**Description:** Generates enriched marketplace metadata (SEO descriptions, tags, categories) for 3D models using LLM analysis
|
|
929
|
+
**Description:** Generates enriched marketplace metadata (SEO descriptions, tags, categories) for 3D models using LLM vision analysis of thumbnails by default. Worker queries database by modelId to retrieve: Model (fileName, fileSize, ownerId, storageItem), TechnicalMetadata (geometry, quality, printability), and ThumbnailMedia (required for default vision analysis). Prerequisites: file download completed, technical metadata analysis completed (strongly recommended), thumbnail generation completed (REQUIRED for vision-enhanced analysis, default behavior). Vision analysis can be disabled via ENABLE_VISION_METADATA_GENERATION environment variable (default: true).
|
|
928
930
|
|
|
929
931
|
**Method:** `client.modelMetadataGenerationRequest(data)`
|
|
930
932
|
|
|
@@ -934,7 +936,7 @@ and stores aggregated statistics in Elasticsearch for trend analysis.
|
|
|
934
936
|
|
|
935
937
|
- `modelId` (string) [✗]: UUID of the model to generate metadata for. Worker queries database to retrieve: 1) Model entity (name, fileName, fileSize, ownerId, storageItem relationship), 2) Model.technicalMetadata relationship (vertices, faces, quality scores, printability metrics), 3) AssociatedMedia.thumbnails (via associatedMediaId) for vision-enhanced analysis. All data fetched from PostgreSQL - no additional parameters required.
|
|
936
938
|
|
|
937
|
-
- `parentJobId` (string) [✗]:
|
|
939
|
+
- `parentJobId` (string) [✗]: ID of parent thumbnail-generation job for BullMQ dependency tracking. SHOULD be set to thumbnail-generation job ID to ensure thumbnails are ready before metadata generation (required for default vision analysis). If omitted, worker will check for thumbnail existence and wait/retry if ENABLE_VISION_METADATA_GENERATION=true.
|
|
938
940
|
|
|
939
941
|
|
|
940
942
|
|
|
@@ -1583,7 +1585,7 @@ and stores aggregated statistics in Elasticsearch for trend analysis.
|
|
|
1583
1585
|
- Notifies backend that enriched marketplace metadata generation completed. Backend updates Model entity with generated description, tags, classification, etc.
|
|
1584
1586
|
|
|
1585
1587
|
- `modelMetadataGenerationRequest(data: ModelMetadataGenerationRequestMessage): Promise<JobResponse>`
|
|
1586
|
-
- Generates enriched marketplace metadata (SEO descriptions, tags, categories) for 3D models using LLM analysis
|
|
1588
|
+
- Generates enriched marketplace metadata (SEO descriptions, tags, categories) for 3D models using LLM vision analysis of thumbnails by default. Worker queries database by modelId to retrieve: Model (fileName, fileSize, ownerId, storageItem), TechnicalMetadata (geometry, quality, printability), and ThumbnailMedia (required for default vision analysis). Prerequisites: file download completed, technical metadata analysis completed (strongly recommended), thumbnail generation completed (REQUIRED for vision-enhanced analysis, default behavior). Vision analysis can be disabled via ENABLE_VISION_METADATA_GENERATION environment variable (default: true).
|
|
1587
1589
|
|
|
1588
1590
|
- `modelMetamodelDetectionFound(data: ModelMetamodelDetectionFoundMessage): Promise<JobResponse>`
|
|
1589
1591
|
- Handles model metamodel detection found with hierarchical relationships.
|
package/dist/client.d.ts
CHANGED
|
@@ -236,7 +236,7 @@ export declare class WorkerClient {
|
|
|
236
236
|
*/
|
|
237
237
|
modelMetadataGenerationCompleted(data: types.ModelMetadataGenerationCompletedMessage): Promise<JobResponse>;
|
|
238
238
|
/**
|
|
239
|
-
* Generates enriched marketplace metadata (SEO descriptions, tags, categories) for 3D models using LLM analysis
|
|
239
|
+
* Generates enriched marketplace metadata (SEO descriptions, tags, categories) for 3D models using LLM vision analysis of thumbnails by default. Worker queries database by modelId to retrieve: Model (fileName, fileSize, ownerId, storageItem), TechnicalMetadata (geometry, quality, printability), and ThumbnailMedia (required for default vision analysis). Prerequisites: file download completed, technical metadata analysis completed (strongly recommended), thumbnail generation completed (REQUIRED for vision-enhanced analysis, default behavior). Vision analysis can be disabled via ENABLE_VISION_METADATA_GENERATION environment variable (default: true).
|
|
240
240
|
* @param data - The message payload
|
|
241
241
|
* @returns Job response with job ID
|
|
242
242
|
*/
|
package/dist/client.js
CHANGED
|
@@ -313,7 +313,7 @@ export class WorkerClient {
|
|
|
313
313
|
return this.sendToQueue(types.MessageTypes.MODEL_METADATA_GENERATION_COMPLETED, data);
|
|
314
314
|
}
|
|
315
315
|
/**
|
|
316
|
-
* Generates enriched marketplace metadata (SEO descriptions, tags, categories) for 3D models using LLM analysis
|
|
316
|
+
* Generates enriched marketplace metadata (SEO descriptions, tags, categories) for 3D models using LLM vision analysis of thumbnails by default. Worker queries database by modelId to retrieve: Model (fileName, fileSize, ownerId, storageItem), TechnicalMetadata (geometry, quality, printability), and ThumbnailMedia (required for default vision analysis). Prerequisites: file download completed, technical metadata analysis completed (strongly recommended), thumbnail generation completed (REQUIRED for vision-enhanced analysis, default behavior). Vision analysis can be disabled via ENABLE_VISION_METADATA_GENERATION environment variable (default: true).
|
|
317
317
|
* @param data - The message payload
|
|
318
318
|
* @returns Job response with job ID
|
|
319
319
|
*/
|
package/dist/types.d.ts
CHANGED
|
@@ -233,6 +233,8 @@ export interface FileDownloadRequestMessage {
|
|
|
233
233
|
previewType?: string;
|
|
234
234
|
/** Generate 16 angle views for 360° preview (passed to child job). */
|
|
235
235
|
generate360Views?: boolean;
|
|
236
|
+
/** Optional webhook URL to call when download completes. If provided, worker will POST completion status to this endpoint. */
|
|
237
|
+
webhookUrl?: string;
|
|
236
238
|
}
|
|
237
239
|
/**
|
|
238
240
|
* Contains synced analytics data for marketplace listings. Backend stores this in marketplace_analytics_snapshots table and indexes to ELK. Works with any marketplace provider.
|
|
@@ -679,12 +681,12 @@ export interface ModelMetadataGenerationCompletedMessage {
|
|
|
679
681
|
metadata: Record<string, string | number | boolean>;
|
|
680
682
|
}
|
|
681
683
|
/**
|
|
682
|
-
* Generates enriched marketplace metadata (SEO descriptions, tags, categories) for 3D models using LLM analysis
|
|
684
|
+
* Generates enriched marketplace metadata (SEO descriptions, tags, categories) for 3D models using LLM vision analysis of thumbnails by default. Worker queries database by modelId to retrieve: Model (fileName, fileSize, ownerId, storageItem), TechnicalMetadata (geometry, quality, printability), and ThumbnailMedia (required for default vision analysis). Prerequisites: file download completed, technical metadata analysis completed (strongly recommended), thumbnail generation completed (REQUIRED for vision-enhanced analysis, default behavior). Vision analysis can be disabled via ENABLE_VISION_METADATA_GENERATION environment variable (default: true).
|
|
683
685
|
*/
|
|
684
686
|
export interface ModelMetadataGenerationRequestMessage {
|
|
685
687
|
/** UUID of the model to generate metadata for. Worker queries database to retrieve: 1) Model entity (name, fileName, fileSize, ownerId, storageItem relationship), 2) Model.technicalMetadata relationship (vertices, faces, quality scores, printability metrics), 3) AssociatedMedia.thumbnails (via associatedMediaId) for vision-enhanced analysis. All data fetched from PostgreSQL - no additional parameters required. */
|
|
686
688
|
modelId?: string;
|
|
687
|
-
/**
|
|
689
|
+
/** ID of parent thumbnail-generation job for BullMQ dependency tracking. SHOULD be set to thumbnail-generation job ID to ensure thumbnails are ready before metadata generation (required for default vision analysis). If omitted, worker will check for thumbnail existence and wait/retry if ENABLE_VISION_METADATA_GENERATION=true. */
|
|
688
690
|
parentJobId?: string;
|
|
689
691
|
}
|
|
690
692
|
/**
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mesh-sync/worker-backend-client",
|
|
3
|
-
"version": "4.0.
|
|
3
|
+
"version": "4.0.6",
|
|
4
4
|
"description": "Auto-generated TypeScript client for worker-backend - provides type-safe methods for enqueueing jobs",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|