@promptmetrics/sdk 1.0.0 → 1.0.1

package/CHANGELOG.md

@@ -5,6 +5,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.1] - 2025-12-30
+
+### Fixed
+
+- **Hardcoded baseURL**: API base URL is now hardcoded to `https://api.promptmetrics.dev` - users no longer need to set `BASE_URL` environment variable
+- Simplified configuration - only `PROMPTMETRICS_API_KEY` is required
+
+### Changed
+
+- Removed `BASE_URL` requirement from `.env.example`
+- Updated README to remove baseURL configuration instructions
+- Streamlined Quick Start example
+
+---
+
 ## [1.0.0] - 2025-12-30
 
 ### 🎉 First Stable Release

package/README.md

@@ -1,8 +1,19 @@
 <div align="center">
 
-# 📊 PromptMetrics SDK
+<svg xmlns="http://www.w3.org/2000/svg" width="80" height="80" viewBox="0 0 24 24" fill="none" stroke="#10b981" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
+  <path d="M12 18V5"></path>
+  <path d="M15 13a4.17 4.17 0 0 1-3-4 4.17 4.17 0 0 1-3 4"></path>
+  <path d="M17.598 6.5A3 3 0 1 0 12 5a3 3 0 1 0-5.598 1.5"></path>
+  <path d="M17.997 5.125a4 4 0 0 1 2.526 5.77"></path>
+  <path d="M18 18a4 4 0 0 0 2-7.464"></path>
+  <path d="M19.967 17.483A4 4 0 1 1 12 18a4 4 0 1 1-7.967-.517"></path>
+  <path d="M6 18a4 4 0 0 1-2-7.464"></path>
+  <path d="M6.003 5.125a4 4 0 0 0-2.526 5.77"></path>
+</svg>
 
-**The platform built for <span style="background-color: rgb(219, 234, 254);">prompt engineers</span>**
+# PromptMetrics SDK
+
+**The platform built for prompt engineers**
 
 <a href="https://nodejs.org"><img alt="Node" src="https://img.shields.io/badge/Node.js-43853D?style=for-the-badge&logo=node.js&logoColor=white"></a>
 <a href="https://www.typescriptlang.org/"><img alt="TypeScript" src="https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white"></a>
@@ -64,11 +75,8 @@ const pm = new PromptMetrics({
   apiKey: process.env.PROMPTMETRICS_API_KEY, // pm_xxxxx
 });
 
-// Get a template and run it
-const template = await pm.templates.get("customer-support");
-const version = template.versions[0];
-
-const result = await pm.versions.run(version._id, {
+// Run a template directly
+const result = await pm.templates.run("customer-support", {
   variables: {
     customer_name: "John Doe",
     issue: "billing problem",
@@ -104,9 +112,6 @@ const pm = new PromptMetrics({
 ### Environment Variables
 
 ```bash
-# Required
-BASE_URL=https://api.promptmetrics.com
-
 # Optional (can also be passed in config)
 PROMPTMETRICS_API_KEY=pm_xxxxx
 ```
@@ -146,6 +151,31 @@ const template = await pm.templates.get("customer-support", {
 });
 ```
 
+#### Run a Template
+
+```typescript
+// Run template directly (uses production version with canary support)
+const result = await pm.templates.run("customer-support", {
+  variables: {
+    customer_name: "John Doe",
+    issue: "billing problem",
+  },
+});
+
+// Run with environment label
+const result = await pm.templates.run("customer-support", {
+  env_label: "staging",
+  variables: { customer_name: "John" },
+});
+
+// Run with model override
+const result = await pm.templates.run("customer-support", {
+  variables: { customer_name: "John" },
+  model: "gpt-4",
+  pm_tags: ["production", "customer-support"],
+});
+```
+
 #### List Templates
 
 ```typescript
@@ -240,54 +270,6 @@ console.log(result.logs);
 console.log(result.pagination);
 ```
 
-#### Log Structure
-
-```typescript
-interface PromptLog {
-  _id: string;
-  template_version_id: string;
-  template_id: string;
-  workspace_id: string;
-
-  // Request/Response
-  request_object: {
-    model: string;
-    messages: Message[];
-    temperature?: number;
-    // ... other parameters
-  };
-  response_object: {
-    id: string;
-    choices: Array<{
-      message: Message;
-      finish_reason: string;
-    }>;
-    usage: {
-      prompt_tokens: number;
-      completion_tokens: number;
-      total_tokens: number;
-    };
-  };
-
-  // Performance
-  latency: number; // seconds
-  status: "SUCCESS" | "ERROR";
-
-  // Costs
-  prompt_cost: number;
-  completion_cost: number;
-  total_cost: number;
-
-  // Trace correlation (if called from @traceable)
-  trace_id?: string;
-  span_id?: string;
-  group_id?: string;
-
-  created_at: string;
-  updated_at: string;
-}
-```
-
 ---
 
 ### LLM Providers
@@ -570,7 +552,7 @@ class TraceBuffer {
 
 ### LLM Request Correlation
 
-When you call `pm.versions.run()` inside a `@traceable` function, the LLM request is automatically linked to your trace.
+When you call `pm.templates.run()` or `pm.versions.run()` inside a `@traceable` function, the LLM request is automatically linked to your trace.
 
 #### Automatic Correlation
 
@@ -578,14 +560,19 @@ When you call `pm.versions.run()` inside a `@traceable` function, the LLM reques
 class AIService {
   @pm.traceable({ name: "generate_support_response" })
   async generateResponse(customerMessage: string) {
-    // This LLM call is automatically linked to the trace!
-    const result = await pm.versions.run("version_123", {
+    // Option 1: Run template directly (auto-linked to trace!)
+    const result = await pm.templates.run("support-template", {
       variables: {
         customer_message: customerMessage,
         context: "support",
       },
     });
 
+    // Option 2: Run specific version (also auto-linked!)
+    const result2 = await pm.versions.run("version_123", {
+      variables: { customer_message: customerMessage },
+    });
+
     // The prompt_log will have:
     // - trace_id: current trace ID
     // - span_id: current span ID
@@ -613,8 +600,8 @@ class CustomerSupportWorkflow {
     // Step 1: Custom function (traced)
     const enriched = await this.enrichCustomerData(message);
 
-    // Step 2: LLM call (auto-linked!)
-    const response = await pm.versions.run("support-template", {
+    // Step 2: LLM call using template.run() (auto-linked!)
+    const response = await pm.templates.run("support-template", {
       variables: { message: enriched.text },
     });
 
@@ -836,7 +823,7 @@ await bot.handleMessage("How are you?", "conv_123");
 ## Support
 
 - **Documentation**: [docs.promptmetrics.com](https://docs.promptmetrics.com)
-- **GitHub Issues**: [github.com/Xomatic/promptmetrics-sdk/issues](https://github.com/Xomatic/promptmetrics-sdk/issues)
+<!-- - **GitHub Issues**: [github.com/Xomatic/promptmetrics-sdk/issues](https://github.com/Xomatic/promptmetrics-sdk/issues) -->
 - **Email**: support@promptmetrics.com
 
 ---
@@ -847,8 +834,8 @@ MIT
 
 ---
 
-## Additional Resources
+<!-- ## Additional Resources
 
 - **[TRACING.md](./TRACING.md)** - Comprehensive tracing guide with advanced examples
 - **[Examples](./examples/)** - Code examples for common use cases
-- **[Changelog](./CHANGELOG.md)** - Version history and updates
+- **[Changelog](./CHANGELOG.md)** - Version history and updates -->

package/dist/index.d.mts

@@ -1315,6 +1315,6 @@ declare class TimeoutError extends PromptMetricsError {
  * ```
  */
 
-declare const VERSION = "1.0.0";
+declare const VERSION = "1.0.1";
 
 export { type AddTraceScoreOptions, AuthenticationError, AuthorizationError, type CreateTraceOptions, type GetTemplateOptions, type LLMModel, type LLMProvider, type ListLogsOptions, type ListPromptsOptions, type ListPromptsResponse, type ListTracesOptions, type Message, NetworkError, NotFoundError, type PromptLog, PromptMetrics, type PromptMetricsConfig, PromptMetricsError, type PromptMetricsErrorResponse, type ProviderWithModels, RateLimitError, type RunTemplateOptions, type RunVersionOptions, ServerError, type Template, type TemplateMetadata, type TemplateOptions, type TemplateVersion, TimeoutError, type Trace, type TraceAnalytics, type TraceError, type TraceListResponse, type TraceScore, type TraceStatus, type TraceTreeNode, type TraceableOptions, type UpdateTraceMetadataOptions, type UpdateVersionOptions, VERSION, ValidationError };

package/dist/index.d.ts

@@ -1315,6 +1315,6 @@ declare class TimeoutError extends PromptMetricsError {
  * ```
  */
 
-declare const VERSION = "1.0.0";
+declare const VERSION = "1.0.1";
 
 export { type AddTraceScoreOptions, AuthenticationError, AuthorizationError, type CreateTraceOptions, type GetTemplateOptions, type LLMModel, type LLMProvider, type ListLogsOptions, type ListPromptsOptions, type ListPromptsResponse, type ListTracesOptions, type Message, NetworkError, NotFoundError, type PromptLog, PromptMetrics, type PromptMetricsConfig, PromptMetricsError, type PromptMetricsErrorResponse, type ProviderWithModels, RateLimitError, type RunTemplateOptions, type RunVersionOptions, ServerError, type Template, type TemplateMetadata, type TemplateOptions, type TemplateVersion, TimeoutError, type Trace, type TraceAnalytics, type TraceError, type TraceListResponse, type TraceScore, type TraceStatus, type TraceTreeNode, type TraceableOptions, type UpdateTraceMetadataOptions, type UpdateVersionOptions, VERSION, ValidationError };

package/dist/index.js

@@ -1278,14 +1278,8 @@ var PromptMetrics = class {
    */
   constructor(config) {
     this.validateConfig(config);
-    const baseURL = process.env.BASE_URL;
-    if (!baseURL) {
-      throw new ValidationError(
-        "BASE_URL environment variable is required. Please set it in your .env file."
-      );
-    }
     this.httpClient = new HttpClient({
-      baseURL,
+      baseURL: "https://api.promptmetrics.dev",
       apiKey: config.apiKey,
       timeout: config.timeout,
       maxRetries: config.maxRetries,
@@ -1356,7 +1350,7 @@ var PromptMetrics = class {
 };
 
 // src/index.ts
-var VERSION = "1.0.0";
+var VERSION = "1.0.1";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   AuthenticationError,

package/dist/index.mjs

@@ -1232,14 +1232,8 @@ var PromptMetrics = class {
    */
   constructor(config) {
     this.validateConfig(config);
-    const baseURL = process.env.BASE_URL;
-    if (!baseURL) {
-      throw new ValidationError(
-        "BASE_URL environment variable is required. Please set it in your .env file."
-      );
-    }
     this.httpClient = new HttpClient({
-      baseURL,
+      baseURL: "https://api.promptmetrics.dev",
       apiKey: config.apiKey,
       timeout: config.timeout,
       maxRetries: config.maxRetries,
@@ -1310,7 +1304,7 @@ var PromptMetrics = class {
 };
 
 // src/index.ts
-var VERSION = "1.0.0";
+var VERSION = "1.0.1";
 export {
   AuthenticationError,
   AuthorizationError,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@promptmetrics/sdk",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Official TypeScript/JavaScript SDK for PromptMetrics API - Manage and execute LLM prompts with version control, monitoring, and analytics",
   "main": "dist/index.js",
   "module": "dist/index.mjs",