@pauly4010/evalai-sdk 1.4.1 → 1.5.5

package/dist/context.d.ts

@@ -131,4 +131,4 @@ export declare function withContextSync<T>(metadata: ContextMetadata, fn: () =>
  * }
  * ```
  */
-export declare function WithContext(metadata: ContextMetadata): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+export declare function WithContext(metadata: ContextMetadata): (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;

package/dist/context.js

@@ -28,9 +28,7 @@ exports.withContext = withContext;
 exports.withContextSync = withContextSync;
 exports.WithContext = WithContext;
 // Detect environment
-const isNode = typeof process !== 'undefined' &&
-    process.versions?.node &&
-    typeof require !== 'undefined';
+const isNode = typeof process !== "undefined" && process.versions?.node && typeof require !== "undefined";
 // Browser fallback: simple context stack
 class BrowserContextStorage {
     constructor() {
@@ -57,11 +55,11 @@ let contextStorage;
 if (isNode) {
     try {
         // Dynamic import for Node.js only
-        const { AsyncLocalStorage } = require('async_hooks');
+        const { AsyncLocalStorage } = require("node:async_hooks");
         // Create without type argument due to require() being untyped
         contextStorage = new AsyncLocalStorage();
     }
-    catch (error) {
+    catch (_error) {
         // Fallback if async_hooks is not available
         contextStorage = new BrowserContextStorage();
     }
@@ -205,7 +203,7 @@ function withContextSync(metadata, fn) {
  * ```
  */
 function WithContext(metadata) {
-    return function (target, propertyKey, descriptor) {
+    return (_target, _propertyKey, descriptor) => {
         const originalMethod = descriptor.value;
         descriptor.value = async function (...args) {
             return withContext(metadata, () => originalMethod.apply(this, args));

package/dist/errors.d.ts

@@ -47,6 +47,8 @@ export declare class EvalAIError extends Error {
     retryAfter?: number;
     /** When the limit resets (for feature limit errors) */
     resetAt?: Date;
+    /** Request ID from API (for correlation/debugging) */
+    requestId?: string;
     constructor(message: string, code: string, statusCode: number, details?: any);
     /**
      * Get formatted error message with solutions

package/dist/errors.js

@@ -11,126 +11,126 @@ exports.createErrorFromResponse = createErrorFromResponse;
  */
 const ERROR_DOCS = {
     MISSING_API_KEY: {
-        code: 'MISSING_API_KEY',
-        message: 'API key is required to initialize the SDK',
-        documentation: 'https://docs.ai-eval-platform.com/errors/missing-api-key',
+        code: "MISSING_API_KEY",
+        message: "API key is required to initialize the SDK",
+        documentation: "https://docs.ai-eval-platform.com/errors/missing-api-key",
         solutions: [
-            'Set EVALAI_API_KEY environment variable',
+            "Set EVALAI_API_KEY environment variable",
             'Pass apiKey in config: new AIEvalClient({ apiKey: "..." })',
-            'Get your API key from https://platform.ai-eval-platform.com/settings/api-keys'
+            "Get your API key from https://platform.ai-eval-platform.com/settings/api-keys",
         ],
-        retryable: false
+        retryable: false,
     },
     MISSING_ORGANIZATION_ID: {
-        code: 'MISSING_ORGANIZATION_ID',
-        message: 'Organization ID is required for this operation',
-        documentation: 'https://docs.ai-eval-platform.com/errors/missing-org-id',
+        code: "MISSING_ORGANIZATION_ID",
+        message: "Organization ID is required for this operation",
+        documentation: "https://docs.ai-eval-platform.com/errors/missing-org-id",
         solutions: [
-            'Set EVALAI_ORGANIZATION_ID environment variable',
-            'Pass organizationId in config: new AIEvalClient({ organizationId: 123 })',
-            'Pass organizationId in method params'
+            "Set EVALAI_ORGANIZATION_ID environment variable",
+            "Pass organizationId in config: new AIEvalClient({ organizationId: 123 })",
+            "Pass organizationId in method params",
         ],
-        retryable: false
+        retryable: false,
     },
     RATE_LIMIT_EXCEEDED: {
-        code: 'RATE_LIMIT_EXCEEDED',
-        message: 'Rate limit exceeded',
-        documentation: 'https://docs.ai-eval-platform.com/errors/rate-limit',
+        code: "RATE_LIMIT_EXCEEDED",
+        message: "Rate limit exceeded",
+        documentation: "https://docs.ai-eval-platform.com/errors/rate-limit",
         solutions: [
-            'Wait before retrying (check retryAfter property)',
-            'Upgrade your plan for higher rate limits',
-            'Implement exponential backoff in your application'
+            "Wait before retrying (check retryAfter property)",
+            "Upgrade your plan for higher rate limits",
+            "Implement exponential backoff in your application",
         ],
-        retryable: true
+        retryable: true,
     },
     TIMEOUT: {
-        code: 'TIMEOUT',
-        message: 'Request timed out',
-        documentation: 'https://docs.ai-eval-platform.com/errors/timeout',
+        code: "TIMEOUT",
+        message: "Request timed out",
+        documentation: "https://docs.ai-eval-platform.com/errors/timeout",
         solutions: [
-            'Increase timeout: new AIEvalClient({ timeout: 60000 })',
-            'Check your network connection',
-            'The service may be experiencing high load'
+            "Increase timeout: new AIEvalClient({ timeout: 60000 })",
+            "Check your network connection",
+            "The service may be experiencing high load",
         ],
-        retryable: true
+        retryable: true,
     },
     NETWORK_ERROR: {
-        code: 'NETWORK_ERROR',
-        message: 'Network connectivity issue',
-        documentation: 'https://docs.ai-eval-platform.com/errors/network',
+        code: "NETWORK_ERROR",
+        message: "Network connectivity issue",
+        documentation: "https://docs.ai-eval-platform.com/errors/network",
         solutions: [
-            'Check your internet connection',
-            'Verify the baseUrl is correct',
-            'Check if you can reach the API endpoint'
+            "Check your internet connection",
+            "Verify the baseUrl is correct",
+            "Check if you can reach the API endpoint",
         ],
-        retryable: true
+        retryable: true,
     },
     UNAUTHORIZED: {
-        code: 'UNAUTHORIZED',
-        message: 'Authentication failed',
-        documentation: 'https://docs.ai-eval-platform.com/errors/unauthorized',
+        code: "UNAUTHORIZED",
+        message: "Authentication failed",
+        documentation: "https://docs.ai-eval-platform.com/errors/unauthorized",
         solutions: [
-            'Verify your API key is correct',
-            'Check if your API key has expired',
-            'Ensure your API key has the required permissions'
+            "Verify your API key is correct",
+            "Check if your API key has expired",
+            "Ensure your API key has the required permissions",
         ],
-        retryable: false
+        retryable: false,
     },
     FORBIDDEN: {
-        code: 'FORBIDDEN',
-        message: 'Access forbidden',
-        documentation: 'https://docs.ai-eval-platform.com/errors/forbidden',
+        code: "FORBIDDEN",
+        message: "Access forbidden",
+        documentation: "https://docs.ai-eval-platform.com/errors/forbidden",
         solutions: [
-            'Check if you have permission for this resource',
-            'Verify you\'re using the correct organization ID',
-            'Contact support if you believe this is an error'
+            "Check if you have permission for this resource",
+            "Verify you're using the correct organization ID",
+            "Contact support if you believe this is an error",
         ],
-        retryable: false
+        retryable: false,
     },
     NOT_FOUND: {
-        code: 'NOT_FOUND',
-        message: 'Resource not found',
-        documentation: 'https://docs.ai-eval-platform.com/errors/not-found',
+        code: "NOT_FOUND",
+        message: "Resource not found",
+        documentation: "https://docs.ai-eval-platform.com/errors/not-found",
         solutions: [
-            'Verify the resource ID is correct',
-            'Check if the resource was deleted',
-            'Ensure you\'re querying the correct organization'
+            "Verify the resource ID is correct",
+            "Check if the resource was deleted",
+            "Ensure you're querying the correct organization",
         ],
-        retryable: false
+        retryable: false,
     },
     VALIDATION_ERROR: {
-        code: 'VALIDATION_ERROR',
-        message: 'Request validation failed',
-        documentation: 'https://docs.ai-eval-platform.com/errors/validation',
+        code: "VALIDATION_ERROR",
+        message: "Request validation failed",
+        documentation: "https://docs.ai-eval-platform.com/errors/validation",
         solutions: [
-            'Check the error details for specific validation failures',
-            'Verify all required fields are provided',
-            'Ensure field types match the expected format'
+            "Check the error details for specific validation failures",
+            "Verify all required fields are provided",
+            "Ensure field types match the expected format",
         ],
-        retryable: false
+        retryable: false,
     },
     INTERNAL_SERVER_ERROR: {
-        code: 'INTERNAL_SERVER_ERROR',
-        message: 'Internal server error',
-        documentation: 'https://docs.ai-eval-platform.com/errors/server-error',
+        code: "INTERNAL_SERVER_ERROR",
+        message: "Internal server error",
+        documentation: "https://docs.ai-eval-platform.com/errors/server-error",
         solutions: [
-            'Retry the request after a brief delay',
-            'Check status page: https://status.ai-eval-platform.com',
-            'Contact support if the issue persists'
+            "Retry the request after a brief delay",
+            "Check status page: https://status.ai-eval-platform.com",
+            "Contact support if the issue persists",
         ],
-        retryable: true
+        retryable: true,
     },
     FEATURE_LIMIT_REACHED: {
-        code: 'FEATURE_LIMIT_REACHED',
-        message: 'Feature usage limit reached',
-        documentation: 'https://docs.ai-eval-platform.com/errors/feature-limit',
+        code: "FEATURE_LIMIT_REACHED",
+        message: "Feature usage limit reached",
+        documentation: "https://docs.ai-eval-platform.com/errors/feature-limit",
         solutions: [
-            'Upgrade your plan for higher limits',
-            'Wait for your usage to reset (check resetAt property)',
-            'Optimize your usage patterns'
+            "Upgrade your plan for higher limits",
+            "Wait for your usage to reset (check resetAt property)",
+            "Optimize your usage patterns",
         ],
-        retryable: false
-    }
+        retryable: false,
+    },
 };
 /**
  * Enhanced SDK Error class with rich error information and documentation
@@ -156,7 +156,7 @@ const ERROR_DOCS = {
 class EvalAIError extends Error {
     constructor(message, code, statusCode, details) {
         super(message);
-        this.name = 'EvalAIError';
+        this.name = "EvalAIError";
         this.code = code;
         this.statusCode = statusCode;
         this.details = details;
@@ -168,18 +168,19 @@ class EvalAIError extends Error {
             this.retryable = errorDoc.retryable;
         }
         else {
-            this.documentation = 'https://docs.ai-eval-platform.com/errors';
-            this.solutions = ['Check the API documentation for more information'];
+            this.documentation = "https://docs.ai-eval-platform.com/errors";
+            this.solutions = ["Check the API documentation for more information"];
             this.retryable = false;
         }
         // Extract retry-after for rate limits
-        if (code === 'RATE_LIMIT_EXCEEDED' && details?.retryAfter) {
+        if (code === "RATE_LIMIT_EXCEEDED" && details?.retryAfter) {
             this.retryAfter = details.retryAfter;
         }
         // Extract reset time for feature limits
-        if (code === 'FEATURE_LIMIT_REACHED' && details?.resetAt) {
+        if (code === "FEATURE_LIMIT_REACHED" && details?.resetAt) {
             this.resetAt = new Date(details.resetAt);
         }
+        this.requestId = details?.error?.requestId ?? details?.requestId;
         // Ensure proper prototype chain
         Object.setPrototypeOf(this, EvalAIError.prototype);
     }
@@ -189,7 +190,7 @@ class EvalAIError extends Error {
     getDetailedMessage() {
         let msg = `${this.code}: ${this.message}\n\n`;
         msg += `Documentation: ${this.documentation}\n\n`;
-        msg += 'Suggested solutions:\n';
+        msg += "Suggested solutions:\n";
         this.solutions.forEach((solution, i) => {
             msg += `  ${i + 1}. ${solution}\n`;
         });
@@ -221,7 +222,8 @@ class EvalAIError extends Error {
             retryable: this.retryable,
             retryAfter: this.retryAfter,
             resetAt: this.resetAt,
-            details: this.details
+            requestId: this.requestId,
+            details: this.details,
         };
     }
 }
@@ -232,53 +234,60 @@ exports.SDKError = EvalAIError;
  */
 function createErrorFromResponse(response, data) {
     const status = response.status;
-    let code = data?.code || 'UNKNOWN_ERROR';
-    let message = data?.error || data?.message || response.statusText;
-    // Map HTTP status to error codes
-    if (!data?.code) {
+    const errObj = data?.error && typeof data.error === "object" ? data.error : data;
+    let code = errObj?.code ?? data?.code ?? "UNKNOWN_ERROR";
+    const message = typeof data?.error === "string"
+        ? data.error
+        : (errObj?.message ?? data?.message ?? response.statusText);
+    const requestId = errObj?.requestId ?? data?.requestId ?? response.headers.get("x-request-id") ?? undefined;
+    // Map HTTP status to error codes when code not in response
+    if (!errObj?.code && !data?.code) {
         if (status === 401)
-            code = 'UNAUTHORIZED';
+            code = "UNAUTHORIZED";
         else if (status === 403)
-            code = 'FORBIDDEN';
+            code = "FORBIDDEN";
         else if (status === 404)
-            code = 'NOT_FOUND';
+            code = "NOT_FOUND";
         else if (status === 408)
-            code = 'TIMEOUT';
+            code = "TIMEOUT";
         else if (status === 422)
-            code = 'VALIDATION_ERROR';
+            code = "VALIDATION_ERROR";
         else if (status === 429)
-            code = 'RATE_LIMIT_EXCEEDED';
+            code = "RATE_LIMIT_EXCEEDED";
         else if (status >= 500)
-            code = 'INTERNAL_SERVER_ERROR';
+            code = "INTERNAL_SERVER_ERROR";
     }
-    return new EvalAIError(message, code, status, data);
+    const err = new EvalAIError(message, code, status, data);
+    if (requestId)
+        err.requestId = requestId;
+    return err;
 }
 // Specific error types
 class RateLimitError extends EvalAIError {
     constructor(message, retryAfter) {
-        super(message, 'RATE_LIMIT_EXCEEDED', 429, { retryAfter });
-        this.name = 'RateLimitError';
+        super(message, "RATE_LIMIT_EXCEEDED", 429, { retryAfter });
+        this.name = "RateLimitError";
     }
 }
 exports.RateLimitError = RateLimitError;
 class AuthenticationError extends EvalAIError {
-    constructor(message = 'Authentication failed') {
-        super(message, 'AUTHENTICATION_ERROR', 401);
-        this.name = 'AuthenticationError';
+    constructor(message = "Authentication failed") {
+        super(message, "AUTHENTICATION_ERROR", 401);
+        this.name = "AuthenticationError";
     }
 }
 exports.AuthenticationError = AuthenticationError;
 class ValidationError extends EvalAIError {
-    constructor(message = 'Validation failed', details) {
-        super(message, 'VALIDATION_ERROR', 400, details);
-        this.name = 'ValidationError';
+    constructor(message = "Validation failed", details) {
+        super(message, "VALIDATION_ERROR", 400, details);
+        this.name = "ValidationError";
     }
 }
 exports.ValidationError = ValidationError;
 class NetworkError extends EvalAIError {
-    constructor(message = 'Network request failed') {
-        super(message, 'NETWORK_ERROR', 0);
-        this.name = 'NetworkError';
+    constructor(message = "Network request failed") {
+        super(message, "NETWORK_ERROR", 0);
+        this.name = "NetworkError";
         this.retryable = true;
     }
 }

package/dist/export.d.ts

@@ -20,13 +20,13 @@
  * await importFromLangSmith(client, langsmithData);
  * ```
  */
-import type { AIEvalClient } from './client';
-import type { Trace, Evaluation, TestCase, EvaluationRun } from './types';
-export type ExportFormat = 'json' | 'csv' | 'jsonl';
+import type { AIEvalClient } from "./client";
+import type { Evaluation, EvaluationRun, TestCase, Trace } from "./types";
+export type ExportFormat = "json" | "csv" | "jsonl";
 export type { ExportFormat as ExportType };
 export interface ExportOptions {
     /** Export format */
-    format: 'json' | 'csv' | 'jsonl';
+    format: "json" | "csv" | "jsonl";
     /** Include traces */
     includeTraces?: boolean;
     /** Include evaluations */
@@ -152,7 +152,7 @@ export declare function importData(client: AIEvalClient, data: ExportData, optio
  * });
  * ```
  */
-export declare function exportToFile(client: AIEvalClient, filePath: string, options: Omit<ExportOptions, 'format'>): Promise<void>;
+export declare function exportToFile(client: AIEvalClient, filePath: string, options: Omit<ExportOptions, "format">): Promise<void>;
 /**
  * Import data from JSON file
  *
@@ -192,4 +192,4 @@ export declare function importFromLangSmith(client: AIEvalClient, langsmithData:
  * fs.writeFileSync('traces.csv', csv);
  * ```
  */
-export declare function convertToCSV(data: ExportData, type: 'traces' | 'evaluations'): string;
+export declare function convertToCSV(data: ExportData, type: "traces" | "evaluations"): string;

package/dist/export.js

@@ -81,16 +81,16 @@ async function exportData(client, options) {
     const exportData = {
         metadata: {
             exportedAt: new Date().toISOString(),
-            version: '1.0.0',
+            version: "1.0.0",
             format: options.format,
-            organizationId: options.organizationId
-        }
+            organizationId: options.organizationId,
+        },
     };
     // Export traces
     if (options.includeTraces) {
         const traces = await client.traces.list({
             organizationId: options.organizationId,
-            limit: options.limit
+            limit: options.limit,
         });
         exportData.traces = traces;
     }
@@ -98,7 +98,7 @@ async function exportData(client, options) {
     if (options.includeEvaluations) {
         const evaluations = await client.evaluations.list({
             organizationId: options.organizationId,
-            limit: options.limit
+            limit: options.limit,
         });
         exportData.evaluations = evaluations;
         // Export test cases for each evaluation
@@ -140,7 +140,7 @@ async function importData(client, data, options) {
     const result = {
         summary: { total: 0, imported: 0, skipped: 0, failed: 0 },
         details: {},
-        errors: []
+        errors: [],
     };
     if (options.dryRun) {
         // Count what would be imported
@@ -165,13 +165,15 @@ async function importData(client, data, options) {
                     organizationId: options.organizationId || trace.organizationId,
                     status: trace.status,
                     durationMs: trace.durationMs || undefined,
-                    metadata: trace.metadata || undefined
+                    metadata: trace.metadata || undefined,
                 });
                 traceResults.imported++;
                 result.summary.imported++;
             }
             catch (error) {
-                if (options.skipDuplicates && error instanceof Error && error.message.includes('already exists')) {
+                if (options.skipDuplicates &&
+                    error instanceof Error &&
+                    error.message.includes("already exists")) {
                     traceResults.skipped++;
                     result.summary.skipped++;
                 }
@@ -180,7 +182,7 @@ async function importData(client, data, options) {
                     result.summary.failed++;
                     result.errors?.push({
                         item: `trace:${trace.traceId}`,
-                        error: error instanceof Error ? error.message : String(error)
+                        error: error instanceof Error ? error.message : String(error),
                     });
                 }
             }
@@ -194,7 +196,7 @@ async function importData(client, data, options) {
         for (const evaluation of data.evaluations) {
             try {
                 if (!options.createdBy) {
-                    throw new Error('createdBy is required for importing evaluations');
+                    throw new Error("createdBy is required for importing evaluations");
                 }
                 await client.evaluations.create({
                     name: evaluation.name,
@@ -202,13 +204,15 @@ async function importData(client, data, options) {
                     type: evaluation.type,
                     organizationId: options.organizationId || evaluation.organizationId,
                     createdBy: options.createdBy,
-                    status: evaluation.status
+                    status: evaluation.status,
                 });
                 evalResults.imported++;
                 result.summary.imported++;
             }
             catch (error) {
-                if (options.skipDuplicates && error instanceof Error && error.message.includes('already exists')) {
+                if (options.skipDuplicates &&
+                    error instanceof Error &&
+                    error.message.includes("already exists")) {
                     evalResults.skipped++;
                     result.summary.skipped++;
                 }
@@ -217,7 +221,7 @@ async function importData(client, data, options) {
                     result.summary.failed++;
                     result.errors?.push({
                         item: `evaluation:${evaluation.name}`,
-                        error: error instanceof Error ? error.message : String(error)
+                        error: error instanceof Error ? error.message : String(error),
                     });
                 }
             }
@@ -239,8 +243,8 @@ async function importData(client, data, options) {
  * ```
  */
 async function exportToFile(client, filePath, options) {
-    const data = await exportData(client, { ...options, format: 'json' });
-    const fs = await Promise.resolve().then(() => __importStar(require('fs')));
+    const data = await exportData(client, { ...options, format: "json" });
+    const fs = await Promise.resolve().then(() => __importStar(require("node:fs")));
     fs.writeFileSync(filePath, JSON.stringify(data, null, 2));
 }
 /**
@@ -255,8 +259,8 @@ async function exportToFile(client, filePath, options) {
  * ```
  */
 async function importFromFile(client, filePath, options) {
-    const fs = await Promise.resolve().then(() => __importStar(require('fs')));
-    const content = fs.readFileSync(filePath, 'utf-8');
+    const fs = await Promise.resolve().then(() => __importStar(require("node:fs")));
+    const content = fs.readFileSync(filePath, "utf-8");
     const data = JSON.parse(content);
     return importData(client, data, options);
 }
@@ -281,27 +285,27 @@ async function importFromLangSmith(client, langsmithData, options) {
     const transformedData = {
         metadata: {
             exportedAt: new Date().toISOString(),
-            version: '1.0.0',
-            format: 'json',
-            organizationId: options.organizationId
+            version: "1.0.0",
+            format: "json",
+            organizationId: options.organizationId,
         },
-        traces: []
+        traces: [],
     };
     // Transform runs to traces
     if (langsmithData.runs && Array.isArray(langsmithData.runs)) {
         transformedData.traces = langsmithData.runs.map((run) => ({
-            name: run.name || 'Imported Trace',
+            name: run.name || "Imported Trace",
             traceId: run.id || `langsmith-${Date.now()}-${Math.random()}`,
             organizationId: options.organizationId,
-            status: run.error ? 'error' : 'success',
+            status: run.error ? "error" : "success",
             durationMs: run.execution_time ? Math.round(run.execution_time * 1000) : null,
             metadata: {
-                source: 'langsmith',
+                source: "langsmith",
                 original_id: run.id,
                 inputs: run.inputs,
-                outputs: run.outputs
+                outputs: run.outputs,
             },
-            createdAt: run.start_time || new Date().toISOString()
+            createdAt: run.start_time || new Date().toISOString(),
         }));
     }
     return importData(client, transformedData, options);
@@ -317,18 +321,20 @@ async function importFromLangSmith(client, langsmithData, options) {
  * ```
  */
 function convertToCSV(data, type) {
-    const items = type === 'traces' ? data.traces : data.evaluations;
+    const items = type === "traces" ? data.traces : data.evaluations;
     if (!items || items.length === 0)
-        return '';
+        return "";
     // Get headers from first item
     const headers = Object.keys(items[0]);
-    const rows = items.map(item => headers.map(h => {
+    const rows = items.map((item) => headers
+        .map((h) => {
         const value = item[h];
         if (value === null || value === undefined)
-            return '';
-        if (typeof value === 'object')
+            return "";
+        if (typeof value === "object")
             return JSON.stringify(value);
         return String(value);
-    }).join(','));
-    return [headers.join(','), ...rows].join('\n');
+    })
+        .join(","));
+    return [headers.join(","), ...rows].join("\n");
 }