@symbo.ls/sdk 2.32.2 → 2.32.4

package/src/services/ProjectService.js

@@ -1,4 +1,7 @@
 import { BaseService } from './BaseService.js'
+import { computeOrdersForTuples } from '../utils/ordering.js'
+import { preprocessChanges } from '../utils/changePreprocessor.js'
+import { deepStringifyFunctions } from '@domql/utils'
 
 export class ProjectService extends BaseService {
   // ==================== PROJECT METHODS ====================
@@ -16,7 +19,7 @@ export class ProjectService extends BaseService {
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to create project: ${error.message}`)
+      throw new Error(`Failed to create project: ${error.message}`, { cause: error })
     }
   }
 
@@ -44,7 +47,7 @@ export class ProjectService extends BaseService {
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to get projects: ${error.message}`)
+      throw new Error(`Failed to get projects: ${error.message}`, { cause: error })
     }
   }
 
@@ -81,7 +84,7 @@ export class ProjectService extends BaseService {
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to list public projects: ${error.message}`)
+      throw new Error(`Failed to list public projects: ${error.message}`, { cause: error })
     }
   }
 
@@ -106,7 +109,7 @@ export class ProjectService extends BaseService {
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to get project: ${error.message}`)
+      throw new Error(`Failed to get project: ${error.message}`, { cause: error })
     }
   }
 
@@ -134,7 +137,7 @@ export class ProjectService extends BaseService {
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to get public project: ${error.message}`)
+      throw new Error(`Failed to get public project: ${error.message}`, { cause: error })
     }
   }
 
@@ -162,7 +165,7 @@ export class ProjectService extends BaseService {
 
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to get project by key: ${error.message}`)
+      throw new Error(`Failed to get project by key: ${error.message}`, { cause: error })
     }
   }
 
@@ -202,7 +205,7 @@ export class ProjectService extends BaseService {
 
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to get project data by key: ${error.message}`)
+      throw new Error(`Failed to get project data by key: ${error.message}`, { cause: error })
     }
   }
 
@@ -222,7 +225,7 @@ export class ProjectService extends BaseService {
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to update project: ${error.message}`)
+      throw new Error(`Failed to update project: ${error.message}`, { cause: error })
     }
   }
 
@@ -245,7 +248,7 @@ export class ProjectService extends BaseService {
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to update project components: ${error.message}`)
+      throw new Error(`Failed to update project components: ${error.message}`, { cause: error })
     }
   }
 
@@ -265,7 +268,7 @@ export class ProjectService extends BaseService {
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to update project settings: ${error.message}`)
+      throw new Error(`Failed to update project settings: ${error.message}`, { cause: error })
     }
   }
 
@@ -285,7 +288,7 @@ export class ProjectService extends BaseService {
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to update project name: ${error.message}`)
+      throw new Error(`Failed to update project name: ${error.message}`, { cause: error })
     }
   }
 
@@ -306,7 +309,7 @@ export class ProjectService extends BaseService {
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to update project package: ${error.message}`)
+      throw new Error(`Failed to update project package: ${error.message}`, { cause: error })
     }
   }
 
@@ -326,7 +329,7 @@ export class ProjectService extends BaseService {
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to duplicate project: ${error.message}`)
+      throw new Error(`Failed to duplicate project: ${error.message}`, { cause: error })
     }
   }
 
@@ -345,7 +348,7 @@ export class ProjectService extends BaseService {
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to remove project: ${error.message}`)
+      throw new Error(`Failed to remove project: ${error.message}`, { cause: error })
     }
   }
 
@@ -365,7 +368,8 @@ export class ProjectService extends BaseService {
       throw new Error(response.message)
     } catch (error) {
       throw new Error(
-        `Failed to check project key availability: ${error.message}`
+        `Failed to check project key availability: ${error.message}`,
+        { cause: error }
       )
     }
   }
@@ -387,7 +391,7 @@ export class ProjectService extends BaseService {
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to get project members: ${error.message}`)
+      throw new Error(`Failed to get project members: ${error.message}`, { cause: error })
     }
   }
 
@@ -427,7 +431,7 @@ export class ProjectService extends BaseService {
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to invite member: ${error.message}`)
+      throw new Error(`Failed to invite member: ${error.message}`, { cause: error })
     }
   }
 
@@ -447,7 +451,7 @@ export class ProjectService extends BaseService {
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to accept invite: ${error.message}`)
+      throw new Error(`Failed to accept invite: ${error.message}`, { cause: error })
     }
   }
 
@@ -470,7 +474,7 @@ export class ProjectService extends BaseService {
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to update member role: ${error.message}`)
+      throw new Error(`Failed to update member role: ${error.message}`, { cause: error })
     }
   }
 
@@ -492,7 +496,7 @@ export class ProjectService extends BaseService {
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to remove member: ${error.message}`)
+      throw new Error(`Failed to remove member: ${error.message}`, { cause: error })
     }
   }
 
@@ -514,7 +518,7 @@ export class ProjectService extends BaseService {
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to get available libraries: ${error.message}`)
+      throw new Error(`Failed to get available libraries: ${error.message}`, { cause: error })
     }
   }
 
@@ -533,7 +537,7 @@ export class ProjectService extends BaseService {
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to get project libraries: ${error.message}`)
+      throw new Error(`Failed to get project libraries: ${error.message}`, { cause: error })
     }
   }
 
@@ -549,11 +553,11 @@ export class ProjectService extends BaseService {
         methodName: 'addProjectLibraries'
       })
       if (response.success) {
-        return response.data
+        return response
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to add project libraries: ${error.message}`)
+      throw new Error(`Failed to add project libraries: ${error.message}`, { cause: error })
     }
   }
 
@@ -573,7 +577,7 @@ export class ProjectService extends BaseService {
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to remove project libraries: ${error.message}`)
+      throw new Error(`Failed to remove project libraries: ${error.message}`, { cause: error })
     }
   }
 
@@ -594,14 +598,25 @@ export class ProjectService extends BaseService {
 
     const { message, branch = 'main', type = 'patch' } = options
 
+    // Preprocess into granular changes and derive orders using current state if available
+    const state = this._context && this._context.state
+    const { granularChanges, orders: preprocessorOrders } = preprocessChanges(state, changes, options)
+    const derivedOrders = options.orders || (preprocessorOrders && preprocessorOrders.length
+      ? preprocessorOrders
+      : (state ? computeOrdersForTuples(state, granularChanges) : []))
+
+    const stringify = (val) => deepStringifyFunctions(val, Array.isArray(val) ? [] : {})
+
     try {
       const response = await this._request(`/projects/${projectId}/changes`, {
         method: 'POST',
         body: JSON.stringify({
-          changes,
+          changes: stringify(changes),
+          granularChanges: stringify(granularChanges),
           message,
           branch,
-          type
+          type,
+          ...(derivedOrders && derivedOrders.length ? { orders: derivedOrders } : {})
         }),
         methodName: 'applyProjectChanges'
       })
@@ -611,7 +626,7 @@ export class ProjectService extends BaseService {
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to apply project changes: ${error.message}`)
+      throw new Error(`Failed to apply project changes: ${error.message}`, { cause: error })
     }
   }
 
@@ -650,7 +665,7 @@ export class ProjectService extends BaseService {
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to get project data: ${error.message}`)
+      throw new Error(`Failed to get project data: ${error.message}`, { cause: error })
     }
   }
 
@@ -684,7 +699,7 @@ export class ProjectService extends BaseService {
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to get project versions: ${error.message}`)
+      throw new Error(`Failed to get project versions: ${error.message}`, { cause: error })
     }
   }
 
@@ -719,7 +734,7 @@ export class ProjectService extends BaseService {
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to restore project version: ${error.message}`)
+      throw new Error(`Failed to restore project version: ${error.message}`, { cause: error })
     }
   }
 
@@ -846,7 +861,7 @@ export class ProjectService extends BaseService {
 
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to get favorite projects: ${error.message}`)
+      throw new Error(`Failed to get favorite projects: ${error.message}`, { cause: error })
     }
   }
 
@@ -867,7 +882,7 @@ export class ProjectService extends BaseService {
 
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to add favorite project: ${error.message}`)
+      throw new Error(`Failed to add favorite project: ${error.message}`, { cause: error })
     }
   }
 
@@ -888,7 +903,7 @@ export class ProjectService extends BaseService {
 
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to remove favorite project: ${error.message}`)
+      throw new Error(`Failed to remove favorite project: ${error.message}`, { cause: error })
     }
   }
 
@@ -925,7 +940,7 @@ export class ProjectService extends BaseService {
 
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to get recent projects: ${error.message}`)
+      throw new Error(`Failed to get recent projects: ${error.message}`, { cause: error })
     }
   }
 }

package/src/services/PullRequestService.js

@@ -33,7 +33,7 @@ export class PullRequestService extends BaseService {
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to create pull request: ${error.message}`)
+      throw new Error(`Failed to create pull request: ${error.message}`, { cause: error })
     }
   }
 
@@ -74,7 +74,7 @@ export class PullRequestService extends BaseService {
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to list pull requests: ${error.message}`)
+      throw new Error(`Failed to list pull requests: ${error.message}`, { cause: error })
     }
   }
 
@@ -103,7 +103,7 @@ export class PullRequestService extends BaseService {
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to get pull request: ${error.message}`)
+      throw new Error(`Failed to get pull request: ${error.message}`, { cause: error })
     }
   }
 
@@ -140,7 +140,7 @@ export class PullRequestService extends BaseService {
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to review pull request: ${error.message}`)
+      throw new Error(`Failed to review pull request: ${error.message}`, { cause: error })
     }
   }
 
@@ -173,7 +173,7 @@ export class PullRequestService extends BaseService {
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to add pull request comment: ${error.message}`)
+      throw new Error(`Failed to add pull request comment: ${error.message}`, { cause: error })
     }
   }
 
@@ -210,7 +210,7 @@ export class PullRequestService extends BaseService {
       ) {
         throw new Error(`Pull request has merge conflicts: ${error.message}`)
       }
-      throw new Error(`Failed to merge pull request: ${error.message}`)
+      throw new Error(`Failed to merge pull request: ${error.message}`, { cause: error })
     }
   }
 
@@ -239,7 +239,7 @@ export class PullRequestService extends BaseService {
       }
       throw new Error(response.message)
     } catch (error) {
-      throw new Error(`Failed to get pull request diff: ${error.message}`)
+      throw new Error(`Failed to get pull request diff: ${error.message}`, { cause: error })
     }
   }
 

package/src/services/ScreenshotService.js

@@ -0,0 +1,258 @@
+import { BaseService } from './BaseService.js'
+
+export class ScreenshotService extends BaseService {
+  constructor (config) {
+    super(config)
+    this._debounceTimers = new Map()
+    this._inflightRefreshes = new Map()
+  }
+
+  // ==================== PROJECT-LEVEL OPERATIONS ====================
+
+  async createScreenshotProject (payload) {
+    this._requireReady('createScreenshotProject')
+    try {
+      const response = await this._request('/screenshots/projects', {
+        method: 'POST',
+        body: JSON.stringify(payload),
+        methodName: 'createScreenshotProject'
+      })
+      if (response.success) {return response}
+      throw new Error(response.message)
+    } catch (error) {
+      throw new Error(`Failed to create screenshot project: ${error.message}`, { cause: error })
+    }
+  }
+
+  async getProjectScreenshots (projectKey, params = {}) {
+    this._requireReady('getProjectScreenshots')
+    if (!projectKey) {throw new Error('projectKey is required')}
+    const { type = 'all', status, limit = 50, offset = 0 } = params
+    const qs = new URLSearchParams()
+    if (type) {qs.set('type', type)}
+    if (status) {qs.set('status', status)}
+    if (limit != null) {qs.set('limit', String(limit))}
+    if (offset != null) {qs.set('offset', String(offset))}
+    try {
+      const response = await this._request(
+        `/screenshots/projects/${encodeURIComponent(projectKey)}${qs.toString() ? `?${qs.toString()}` : ''}`,
+        { method: 'GET', methodName: 'getProjectScreenshots' }
+      )
+      if (response.success) {return response}
+      throw new Error(response.message)
+    } catch (error) {
+      throw new Error(`Failed to get project screenshots: ${error.message}`, { cause: error })
+    }
+  }
+
+  async reprocessProjectScreenshots (projectKey, body = {}) {
+    this._requireReady('reprocessProjectScreenshots')
+    if (!projectKey) {throw new Error('projectKey is required')}
+    try {
+      const response = await this._request(
+        `/screenshots/projects/${encodeURIComponent(projectKey)}/reprocess`,
+        { method: 'POST', body: JSON.stringify(body), methodName: 'reprocessProjectScreenshots' }
+      )
+      if (response.success) {return response}
+      throw new Error(response.message)
+    } catch (error) {
+      throw new Error(`Failed to reprocess screenshots: ${error.message}`, { cause: error })
+    }
+  }
+
+  async recreateProjectScreenshots (projectKey, body = {}) {
+    this._requireReady('recreateProjectScreenshots')
+    if (!projectKey) {throw new Error('projectKey is required')}
+    try {
+      const response = await this._request(
+        `/screenshots/projects/${encodeURIComponent(projectKey)}/recreate`,
+        { method: 'POST', body: JSON.stringify(body), methodName: 'recreateProjectScreenshots' }
+      )
+      if (response.success) {return response}
+      throw new Error(response.message)
+    } catch (error) {
+      throw new Error(`Failed to recreate screenshots: ${error.message}`, { cause: error })
+    }
+  }
+
+  async deleteProjectScreenshots (projectKey) {
+    this._requireReady('deleteProjectScreenshots')
+    if (!projectKey) {throw new Error('projectKey is required')}
+    try {
+      const response = await this._request(
+        `/screenshots/projects/${encodeURIComponent(projectKey)}`,
+        { method: 'DELETE', methodName: 'deleteProjectScreenshots' }
+      )
+      if (response.success) {return response}
+      throw new Error(response.message)
+    } catch (error) {
+      throw new Error(`Failed to delete project screenshots: ${error.message}`, { cause: error })
+    }
+  }
+
+  // ==================== THUMBNAIL ====================
+
+  async getThumbnailCandidate (projectKey, options = {}) {
+    this._requireReady('getThumbnailCandidate')
+    if (!projectKey) {throw new Error('projectKey is required')}
+    const { includeData = false } = options
+    const qs = new URLSearchParams()
+    if (includeData) {qs.set('include_data', 'true')}
+    try {
+      const response = await this._request(
+        `/screenshots/projects/${encodeURIComponent(projectKey)}/thumbnail/candidate${qs.toString() ? `?${qs.toString()}` : ''}`,
+        { method: 'GET', methodName: 'getThumbnailCandidate' }
+      )
+      if (response.success) {return response}
+      throw new Error(response.message)
+    } catch (error) {
+      throw new Error(`Failed to get thumbnail candidate: ${error.message}`, { cause: error })
+    }
+  }
+
+  async updateProjectThumbnail (projectKey, body = {}) {
+    this._requireReady('updateProjectThumbnail')
+    if (!projectKey) {throw new Error('projectKey is required')}
+    try {
+      const response = await this._request(
+        `/screenshots/projects/${encodeURIComponent(projectKey)}/thumbnail`,
+        { method: 'POST', body: JSON.stringify(body), methodName: 'updateProjectThumbnail' }
+      )
+      if (response.success) {return response}
+      throw new Error(response.message)
+    } catch (error) {
+      throw new Error(`Failed to update project thumbnail: ${error.message}`, { cause: error })
+    }
+  }
+
+  // ==================== INDIVIDUAL SHOTS ====================
+
+  async getPageScreenshot (screenshotId, format = 'json') {
+    this._requireReady('getPageScreenshot')
+    if (!screenshotId) {throw new Error('screenshotId is required')}
+    const qs = new URLSearchParams()
+    if (format) {qs.set('format', format)}
+    try {
+      return await this._request(
+        `/screenshots/pages/${encodeURIComponent(screenshotId)}${qs.toString() ? `?${qs.toString()}` : ''}`,
+        { method: 'GET', methodName: 'getPageScreenshot' }
+      )
+    } catch (error) {
+      throw new Error(`Failed to get page screenshot: ${error.message}`, { cause: error })
+    }
+  }
+
+  async getComponentScreenshot (screenshotId, format = 'json') {
+    this._requireReady('getComponentScreenshot')
+    if (!screenshotId) {throw new Error('screenshotId is required')}
+    const qs = new URLSearchParams()
+    if (format) {qs.set('format', format)}
+    try {
+      return await this._request(
+        `/screenshots/components/${encodeURIComponent(screenshotId)}${qs.toString() ? `?${qs.toString()}` : ''}`,
+        { method: 'GET', methodName: 'getComponentScreenshot' }
+      )
+    } catch (error) {
+      throw new Error(`Failed to get component screenshot: ${error.message}`, { cause: error })
+    }
+  }
+
+  async getScreenshotByKey (projectKey, type, key, format = 'json') {
+    this._requireReady('getScreenshotByKey')
+    if (!projectKey) {throw new Error('projectKey is required')}
+    if (!type || !['component', 'page'].includes(String(type))) {
+      throw new Error("type must be 'component' or 'page'")
+    }
+    if (!key) {throw new Error('key is required')}
+    const qs = new URLSearchParams()
+    if (format) {qs.set('format', format)}
+    const sub = type === 'component' ? 'components' : 'pages'
+    try {
+      return await this._request(
+        `/screenshots/projects/${encodeURIComponent(projectKey)}/${sub}/${encodeURIComponent(key)}${qs.toString() ? `?${qs.toString()}` : ''}`,
+        { method: 'GET', methodName: 'getScreenshotByKey' }
+      )
+    } catch (error) {
+      throw new Error(`Failed to get screenshot by key: ${error.message}`, { cause: error })
+    }
+  }
+
+  async getQueueStatistics () {
+    this._requireReady('getQueueStatistics')
+    try {
+      const response = await this._request('/screenshots/queue/stats', {
+        method: 'GET',
+        methodName: 'getQueueStatistics'
+      })
+      if (response.success) {return response}
+      throw new Error(response.message)
+    } catch (error) {
+      throw new Error(`Failed to get queue statistics: ${error.message}`, { cause: error })
+    }
+  }
+
+  // ==================== COMBINATION/DEBOUNCED ====================
+
+  /**
+   * Debounced thumbnail refresh that recreates screenshots and then updates thumbnail.
+   * Subsequent calls within debounce window reset the timer.
+   */
+  async refreshThumbnail (projectKey, options = {}) {
+    this._requireReady('refreshThumbnail')
+    if (!projectKey) {throw new Error('projectKey is required')}
+
+    const {
+      debounceMs = 15000,
+      waitAfterRecreateMs = 20000,
+      recreate = {
+        process_pages: true,
+        process_components: false,
+        process_descriptions: false,
+        force: false,
+        priority: 5
+      },
+      thumbnail = {
+        strategy: 'auto',
+        force: true
+      }
+    } = options
+
+    // Clear existing debounce timer if present
+    const existingTimer = this._debounceTimers.get(projectKey)
+    if (existingTimer) {
+      clearTimeout(existingTimer)
+    }
+
+    // Wrap execution in a promise we store, so callers can await the outcome
+    const executionPromise = await new Promise(resolve => {
+      const timer = setTimeout(async () => {
+        try {
+          // Step 1: queue screenshot recreation (non-blocking server-side)
+          await this.recreateProjectScreenshots(projectKey, recreate)
+
+          // Step 2: wait for some time to allow processing to progress
+          await new Promise(resolveDelay => { setTimeout(resolveDelay, waitAfterRecreateMs) })
+
+          // Step 3: update thumbnail using best candidate
+          const result = await this.updateProjectThumbnail(projectKey, thumbnail)
+          resolve(result)
+        } catch (e) {
+          // Resolve with error object but do not throw to avoid unhandled rejections
+          resolve({ success: false, error: e?.message || String(e) })
+        } finally {
+          this._debounceTimers.delete(projectKey)
+          this._inflightRefreshes.delete(projectKey)
+        }
+      }, debounceMs)
+
+      this._debounceTimers.set(projectKey, timer)
+    })
+
+    this._inflightRefreshes.set(projectKey, executionPromise)
+    return executionPromise
+  }
+}
+
+export default ScreenshotService
+
+