promptmetrics-sample 1.0.0

package/src/tests/versions.test.ts

@@ -0,0 +1,155 @@
+#!/usr/bin/env ts-node
+/**
+ * Versions Test Suite
+ * Tests all version-related SDK operations
+ */
+
+import "dotenv/config";
+import { PromptMetrics } from "@promptmetrics/sdk";
+import { runTestSuite, logger } from "../utils/logger";
+
+const pm = new PromptMetrics({
+  apiKey: process.env.PROMPTMETRICS_API_KEY!,
+});
+
+const TEST_TEMPLATE_NAME = process.env.TEST_TEMPLATE_NAME || "test-template";
+const TEST_VERSION_ID = process.env.TEST_VERSION_ID;
+
+// Store version ID from first test for subsequent tests
+let fetchedVersionId: string | null = null;
+
+const tests = [
+  {
+    name: "Get version by ID",
+    fn: async () => {
+      if (!TEST_VERSION_ID) {
+        logger.info("Skipped - TEST_VERSION_ID not set");
+        return;
+      }
+      const version = await pm.versions.get(TEST_VERSION_ID);
+      if (!version) throw new Error("Version not found");
+      fetchedVersionId = version._id;
+      logger.data("Version ID", version._id);
+      logger.data("Version Number", version.version);
+      logger.data("Model ID", version.model_id);
+      logger.data("Env Label", version.env_label);
+    },
+  },
+
+  {
+    name: "Get version by template name + version number",
+    fn: async () => {
+      const version = await pm.versions.get(TEST_TEMPLATE_NAME, 1);
+      if (!version) throw new Error("Version not found");
+      fetchedVersionId = version._id;
+      logger.data("Version ID", version._id);
+      logger.data("Version Number", version.version);
+      logger.data("Messages Count", version.messages?.length || 0);
+    },
+  },
+
+  {
+    name: "Run version with variables",
+    fn: async () => {
+      const versionId = TEST_VERSION_ID || fetchedVersionId;
+      if (!versionId) {
+        logger.info("Skipped - No version ID available");
+        return;
+      }
+
+      const result = await pm.versions.run(versionId, {
+        variables: {
+          topic: "SDK Testing",
+        },
+      });
+
+      if (!result) throw new Error("Run failed");
+      logger.data("Request ID", result.request_id);
+      logger.data("Status", result.status);
+      logger.data("Latency", `${result.latency}s`);
+      logger.data("Total Tokens", result.llm_total_tokens);
+      logger.data("Total Cost", `$${result.total_cost}`);
+    },
+  },
+
+  {
+    name: "Run version with custom parameters",
+    fn: async () => {
+      const versionId = TEST_VERSION_ID || fetchedVersionId;
+      if (!versionId) {
+        logger.info("Skipped - No version ID available");
+        return;
+      }
+
+      const result = await pm.versions.run(versionId, {
+        variables: {
+          topic: "Parameter Override Test",
+        },
+        parameters: {
+          temperature: 0.5,
+          max_tokens: 100,
+        },
+      });
+
+      if (!result) throw new Error("Run failed");
+      logger.data("Request ID", result.request_id);
+      logger.data("Status", result.status);
+      logger.data("Completion Tokens", result.llm_completion_tokens);
+    },
+  },
+
+  {
+    name: "Run version with pm_tags",
+    fn: async () => {
+      const versionId = TEST_VERSION_ID || fetchedVersionId;
+      if (!versionId) {
+        logger.info("Skipped - No version ID available");
+        return;
+      }
+
+      const result = await pm.versions.run(versionId, {
+        variables: {
+          topic: "Tags Test",
+        },
+        pm_tags: ["sdk-test", "automated", "sample-project"],
+      });
+
+      if (!result) throw new Error("Run failed");
+      logger.data("Request ID", result.request_id);
+      logger.data("Status", result.status);
+      logger.data("Tags", result.tags);
+
+      // Verify tags are in response
+      if (result.tags && result.tags.includes("sdk-test")) {
+        logger.success("Tags verified in response!");
+      } else {
+        logger.info("Tags may not be returned in response yet");
+      }
+    },
+  },
+
+  {
+    name: "Update version metadata",
+    fn: async () => {
+      const versionId = TEST_VERSION_ID || fetchedVersionId;
+      if (!versionId) {
+        logger.info("Skipped - No version ID available");
+        return;
+      }
+
+      const updatedVersion = await pm.versions.update(versionId, {
+        metadata: {
+          tested_via: "SDK Sample Project",
+          tested_at: new Date().toISOString(),
+          test_run: true,
+        },
+      });
+
+      if (!updatedVersion) throw new Error("Update failed");
+      logger.data("Version ID", updatedVersion._id);
+      logger.data("Metadata", updatedVersion.metadata);
+    },
+  },
+];
+
+runTestSuite("Versions Test Suite", tests);

package/src/utils/logger.ts

@@ -0,0 +1,91 @@
+/**
+ * Test Logger Utility
+ * Provides consistent logging for test output
+ */
+
+export const logger = {
+  test: (name: string) => {
+    console.log(`\n🧪 Testing: ${name}...`);
+  },
+
+  success: (message: string) => {
+    console.log(`   ✅ ${message}`);
+  },
+
+  error: (message: string) => {
+    console.log(`   ❌ ${message}`);
+  },
+
+  info: (message: string) => {
+    console.log(`   ℹ️  ${message}`);
+  },
+
+  data: (label: string, value: unknown) => {
+    console.log(`   📊 ${label}:`, value);
+  },
+
+  separator: () => {
+    console.log("\n" + "─".repeat(60) + "\n");
+  },
+
+  header: (title: string) => {
+    console.log("\n" + "═".repeat(60));
+    console.log(`  ${title}`);
+    console.log("═".repeat(60) + "\n");
+  },
+
+  summary: (passed: number, failed: number) => {
+    console.log("\n" + "─".repeat(60));
+    console.log(`  📋 Summary: ${passed} passed, ${failed} failed`);
+    console.log("─".repeat(60) + "\n");
+  },
+};
+
+/**
+ * Test runner helper
+ */
+export async function runTest(
+  name: string,
+  testFn: () => Promise<void>
+): Promise<boolean> {
+  logger.test(name);
+  try {
+    await testFn();
+    logger.success("Passed");
+    return true;
+  } catch (error) {
+    logger.error(`Failed: ${(error as Error).message}`);
+    if (process.env.DEBUG === "true") {
+      console.error(error);
+    }
+    return false;
+  }
+}
+
+/**
+ * Run multiple tests and report summary
+ */
+export async function runTestSuite(
+  suiteName: string,
+  tests: Array<{ name: string; fn: () => Promise<void> }>
+): Promise<void> {
+  logger.header(suiteName);
+
+  let passed = 0;
+  let failed = 0;
+
+  for (const test of tests) {
+    const result = await runTest(test.name, test.fn);
+    if (result) {
+      passed++;
+    } else {
+      failed++;
+    }
+  }
+
+  logger.summary(passed, failed);
+
+  if (failed > 0) {
+    process.exit(1);
+  }
+}

package/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "commonjs",
+    "lib": ["ES2020"],
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "resolveJsonModule": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}