add pricing estimate for tripo3d

Author: eg-renovate-user

src/providers/tripo3d/README.md

@@ -0,0 +1,109 @@
+# Tripo3D Provider - Credit Tracking
+
+The Tripo3D provider now includes credit tracking functionality to help users understand and monitor their API usage costs.
+
+## Credit Tracking Features
+
+### `getTask` Response - Credits Used
+When checking a completed task status, the response now includes a `credits_used` field:
+
+```json
+{
+  "code": 0,
+  "data": {
+    "task_id": "abc123",
+    "type": "text_to_3d",
+    "status": "success",
+    "progress": 100,
+    "input": {
+      "type": "text_to_3d",
+      "prompt": "A cute robot",
+      "texture_quality": "high",
+      "pbr": true
+    },
+    "output": {
+      "model": "https://...",
+      "pbr_model": "https://..."
+    },
+    "credits_used": 17,
+    "create_time": 1692825600
+  },
+  "provider": "tripo3d"
+}
+```
+
+## Credit Calculation
+
+Credits are calculated based on:
+
+1. **Base Task Cost** - Varies by task type:
+   - `text_to_3d`, `image_to_3d`, `multiview_to_3d`: 10 credits
+   - `animate`: 15 credits
+   - `refine_model`, `retexture`, `stylize`: 5 credits
+   - `convert`: 2 credits
+   - Others: 5 credits (default)
+
+2. **Quality Modifiers**:
+   - `texture_quality: "standard"`: +0 credits
+   - `texture_quality: "high"`: +5 credits
+   - `texture_quality: "ultra"`: +10 credits
+
+3. **Feature Modifiers**:
+   - `pbr: true`: +2 credits
+   - `quad: true`: +3 credits
+   - `with_animation: true`: +5 credits
+   - `bake_animation: true`: +2 credits
+   - `pack_uv: true`: +1 credit
+   - `bake: true`: +2 credits
+
+## Example Calculations
+
+### Basic Text-to-3D
+```javascript
+// Request
+{
+  "type": "text_to_3d",
+  "prompt": "A simple cube"
+}
+// Credits: 10 (base)
+```
+
+### High-Quality Text-to-3D with PBR
+```javascript
+// Request
+{
+  "type": "text_to_3d", 
+  "prompt": "A detailed robot",
+  "texture_quality": "high",
+  "pbr": true
+}
+// Credits: 10 (base) + 5 (high quality) + 2 (PBR) = 17
+```
+
+### Animation Task with Multiple Features
+```javascript
+// Request
+{
+  "type": "animate",
+  "with_animation": true,
+  "bake_animation": true
+}
+// Credits: 15 (base) + 5 (animation) + 2 (bake) = 22
+```
+
+## Important Notes
+
+1. **Estimates Only**: These are estimated credits based on embedded pricing logic. Actual credits may vary if Tripo3D changes their pricing.
+
+2. **Completed Tasks Only**: `credits_used` field only appears for tasks with `status: "success"`.
+
+3. **Async Limitation**: Credits are consumed when tasks complete, not when created. This is due to Tripo3D's async task architecture.
+
+4. **Pricing Updates**: The pricing table in `src/providers/tripo3d/pricing.ts` should be updated when Tripo3D changes their pricing structure.
+
+## Testing
+
+Run the pricing calculation tests:
+```bash
+npx jest src/providers/tripo3d/pricing.test.ts
+```

src/providers/tripo3d/getTask.ts

@@ -4,6 +4,7 @@ import {
   generateErrorResponse,
   generateInvalidProviderResponseError,
 } from '../utils';
+import { calculateEstimatedCredits } from './pricing';
 
 export const Tripo3DGetTaskConfig: ProviderConfig = {
   task_id: {
@@ -44,6 +45,8 @@ export interface Tripo3DTask {
   create_time: number;
   running_left_time?: number;
   queuing_num?: number;
+  // Added by Portkey for pricing/usage tracking
+  credits_used?: number;
 }
 
 export interface Tripo3DGetTaskResponse {
@@ -70,9 +73,19 @@ export const Tripo3DGetTaskResponseTransform: (
   }
 
   if (response.data) {
+    const taskData = { ...response.data };
+
+    // Add credits_used for completed tasks
+    if (taskData.status === 'success' && taskData.type && taskData.input) {
+      taskData.credits_used = calculateEstimatedCredits(
+        taskData.type,
+        taskData.input
+      );
+    }
+
     return {
       code: response.code,
-      data: response.data,
+      data: taskData,
       provider: TRIPO3D,
     };
   }

src/providers/tripo3d/pricing.test.ts

@@ -0,0 +1,154 @@
+import {
+  calculateEstimatedCredits,
+  getTaskTypePricing,
+  TRIPO3D_PRICING,
+} from './pricing';
+
+describe('Tripo3D Pricing', () => {
+  describe('calculateEstimatedCredits', () => {
+    it('should return base cost for known task types', () => {
+      expect(calculateEstimatedCredits('text_to_3d')).toBe(10);
+      expect(calculateEstimatedCredits('image_to_3d')).toBe(10);
+      expect(calculateEstimatedCredits('refine_model')).toBe(5);
+      expect(calculateEstimatedCredits('animate')).toBe(15);
+      expect(calculateEstimatedCredits('convert')).toBe(2);
+    });
+
+    it('should return default cost for unknown task types', () => {
+      expect(calculateEstimatedCredits('unknown_task_type')).toBe(5);
+      expect(calculateEstimatedCredits('')).toBe(5);
+    });
+
+    it('should add texture quality modifiers', () => {
+      expect(
+        calculateEstimatedCredits('text_to_3d', { texture_quality: 'standard' })
+      ).toBe(10);
+      expect(
+        calculateEstimatedCredits('text_to_3d', { texture_quality: 'high' })
+      ).toBe(15);
+      expect(
+        calculateEstimatedCredits('text_to_3d', { texture_quality: 'ultra' })
+      ).toBe(20);
+    });
+
+    it('should add PBR feature modifier', () => {
+      expect(calculateEstimatedCredits('text_to_3d', { pbr: true })).toBe(12);
+      expect(calculateEstimatedCredits('text_to_3d', { pbr: false })).toBe(10);
+    });
+
+    it('should add quad topology modifier', () => {
+      expect(calculateEstimatedCredits('text_to_3d', { quad: true })).toBe(13);
+      expect(calculateEstimatedCredits('text_to_3d', { quad: false })).toBe(10);
+    });
+
+    it('should add animation modifiers', () => {
+      expect(
+        calculateEstimatedCredits('text_to_3d', { with_animation: true })
+      ).toBe(15);
+      expect(
+        calculateEstimatedCredits('text_to_3d', { bake_animation: true })
+      ).toBe(12);
+    });
+
+    it('should add texture processing modifiers', () => {
+      expect(calculateEstimatedCredits('text_to_3d', { pack_uv: true })).toBe(
+        11
+      );
+      expect(calculateEstimatedCredits('text_to_3d', { bake: true })).toBe(12);
+    });
+
+    it('should combine multiple modifiers', () => {
+      const params = {
+        texture_quality: 'high',
+        pbr: true,
+        quad: true,
+        with_animation: true,
+        pack_uv: true,
+        bake: true,
+      };
+      // base (10) + high quality (5) + pbr (2) + quad (3) + animation (5) + pack_uv (1) + bake (2) = 28
+      expect(calculateEstimatedCredits('text_to_3d', params)).toBe(28);
+    });
+
+    it('should return minimum of 1 credit', () => {
+      // Even if we had a task with 0 base cost, it should return at least 1
+      const zeroBaseCost = { ...TRIPO3D_PRICING };
+      zeroBaseCost.baseCosts.test_task = 0;
+
+      // Our current minimum is handled in the function
+      expect(calculateEstimatedCredits('test_task')).toBe(5); // Returns default
+    });
+
+    it('should handle empty parameters object', () => {
+      expect(calculateEstimatedCredits('text_to_3d', {})).toBe(10);
+    });
+
+    it('should ignore unknown parameters', () => {
+      const params = {
+        unknown_param: true,
+        another_unknown: 'value',
+        texture_quality: 'high',
+      };
+      expect(calculateEstimatedCredits('text_to_3d', params)).toBe(15); // base + high quality only
+    });
+  });
+
+  describe('getTaskTypePricing', () => {
+    it('should return pricing info for known task types', () => {
+      const pricing = getTaskTypePricing('text_to_3d');
+      expect(pricing).toEqual({
+        taskType: 'text_to_3d',
+        baseCost: 10,
+        availableModifiers: expect.arrayContaining([
+          'pbr',
+          'quad',
+          'with_animation',
+        ]),
+        textureQualityOptions: expect.arrayContaining([
+          'standard',
+          'high',
+          'ultra',
+        ]),
+      });
+    });
+
+    it('should return default pricing for unknown task types', () => {
+      const pricing = getTaskTypePricing('unknown_task');
+      expect(pricing).toEqual({
+        taskType: 'unknown_task',
+        baseCost: 5,
+        availableModifiers: expect.arrayContaining([
+          'pbr',
+          'quad',
+          'with_animation',
+        ]),
+        textureQualityOptions: expect.arrayContaining([
+          'standard',
+          'high',
+          'ultra',
+        ]),
+      });
+    });
+  });
+
+  describe('TRIPO3D_PRICING configuration', () => {
+    it('should have all required pricing sections', () => {
+      expect(TRIPO3D_PRICING).toHaveProperty('baseCosts');
+      expect(TRIPO3D_PRICING).toHaveProperty('modifiers');
+      expect(TRIPO3D_PRICING.modifiers).toHaveProperty('texture_quality');
+      expect(TRIPO3D_PRICING.modifiers).toHaveProperty('features');
+    });
+
+    it('should have default task type', () => {
+      expect(TRIPO3D_PRICING.baseCosts).toHaveProperty('default');
+      expect(typeof TRIPO3D_PRICING.baseCosts.default).toBe('number');
+    });
+
+    it('should have standard texture quality as baseline', () => {
+      expect(TRIPO3D_PRICING.modifiers.texture_quality).toHaveProperty(
+        'standard'
+      );
+      expect(TRIPO3D_PRICING.modifiers.texture_quality.standard).toBe(0);
+    });
+  });
+});