promptmetrics-sample 1.0.0

package/dist/tests/versions.test.js

@@ -0,0 +1,145 @@
+#!/usr/bin/env ts-node
+"use strict";
+/**
+ * Versions Test Suite
+ * Tests all version-related SDK operations
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+require("dotenv/config");
+const sdk_1 = require("@promptmetrics/sdk");
+const logger_1 = require("../utils/logger");
+const pm = new sdk_1.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 = null;
+const tests = [
+    {
+        name: "Get version by ID",
+        fn: async () => {
+            if (!TEST_VERSION_ID) {
+                logger_1.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_1.logger.data("Version ID", version._id);
+            logger_1.logger.data("Version Number", version.version);
+            logger_1.logger.data("Model ID", version.model_id);
+            logger_1.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_1.logger.data("Version ID", version._id);
+            logger_1.logger.data("Version Number", version.version);
+            logger_1.logger.data("Messages Count", version.messages?.length || 0);
+        },
+    },
+    {
+        name: "Run version with variables",
+        fn: async () => {
+            const versionId = TEST_VERSION_ID || fetchedVersionId;
+            if (!versionId) {
+                logger_1.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_1.logger.data("Request ID", result.request_id);
+            logger_1.logger.data("Status", result.status);
+            logger_1.logger.data("Latency", `${result.latency}s`);
+            logger_1.logger.data("Total Tokens", result.llm_total_tokens);
+            logger_1.logger.data("Total Cost", `$${result.total_cost}`);
+        },
+    },
+    {
+        name: "Run version with custom parameters",
+        fn: async () => {
+            const versionId = TEST_VERSION_ID || fetchedVersionId;
+            if (!versionId) {
+                logger_1.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_1.logger.data("Request ID", result.request_id);
+            logger_1.logger.data("Status", result.status);
+            logger_1.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_1.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_1.logger.data("Request ID", result.request_id);
+            logger_1.logger.data("Status", result.status);
+            logger_1.logger.data("Tags", result.tags);
+            // Verify tags are in response
+            if (result.tags && result.tags.includes("sdk-test")) {
+                logger_1.logger.success("Tags verified in response!");
+            }
+            else {
+                logger_1.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_1.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_1.logger.data("Version ID", updatedVersion._id);
+            logger_1.logger.data("Metadata", updatedVersion.metadata);
+        },
+    },
+];
+(0, logger_1.runTestSuite)("Versions Test Suite", tests);
+//# sourceMappingURL=versions.test.js.map

package/dist/tests/versions.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"versions.test.js","sourceRoot":"","sources":["../../src/tests/versions.test.ts"],"names":[],"mappings":";;AACA;;;GAGG;;AAEH,yBAAuB;AACvB,4CAAmD;AACnD,4CAAuD;AAEvD,MAAM,EAAE,GAAG,IAAI,mBAAa,CAAC;IAC3B,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,qBAAsB;CAC3C,CAAC,CAAC;AAEH,MAAM,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,IAAI,eAAe,CAAC;AAC7E,MAAM,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC;AAEpD,wDAAwD;AACxD,IAAI,gBAAgB,GAAkB,IAAI,CAAC;AAE3C,MAAM,KAAK,GAAG;IACZ;QACE,IAAI,EAAE,mBAAmB;QACzB,EAAE,EAAE,KAAK,IAAI,EAAE;YACb,IAAI,CAAC,eAAe,EAAE,CAAC;gBACrB,eAAM,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;gBACjD,OAAO;YACT,CAAC;YACD,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;YACvD,IAAI,CAAC,OAAO;gBAAE,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;YACnD,gBAAgB,GAAG,OAAO,CAAC,GAAG,CAAC;YAC/B,eAAM,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;YACvC,eAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;YAC/C,eAAM,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;YAC1C,eAAM,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;QAC9C,CAAC;KACF;IAED;QACE,IAAI,EAAE,+CAA+C;QACrD,EAAE,EAAE,KAAK,IAAI,EAAE;YACb,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC;YAC7D,IAAI,CAAC,OAAO;gBAAE,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;YACnD,gBAAgB,GAAG,OAAO,CAAC,GAAG,CAAC;YAC/B,eAAM,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;YACvC,eAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;YAC/C,eAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,OAAO,CAAC,QAAQ,EAAE,MAAM,IAAI,CAAC,CAAC,CAAC;QAC/D,CAAC;KACF;IAED;QACE,IAAI,EAAE,4BAA4B;QAClC,EAAE,EAAE,KAAK,IAAI,EAAE;YACb,MAAM,SAAS,GAAG,eAAe,IAAI,gBAAgB,CAAC;YACtD,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,eAAM,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;gBACjD,OAAO;YACT,CAAC;YAED,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,EAAE;gBAC9C,SAAS,EAAE;oBACT,KAAK,EAAE,aAAa;iBACrB;aACF,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM;gBAAE,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;YAC3C,eAAM,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;YAC7C,eAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;YACrC,eAAM,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,MAAM,CAAC,OAAO,GAAG,CAAC,CAAC;YAC7C,eAAM,CAAC,IAAI,CAAC,cAAc,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAC;YACrD,eAAM,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC;QACrD,CAAC;KACF;IAED;QACE,IAAI,EAAE,oCAAoC;QAC1C,EAAE,EAAE,KAAK,IAAI,EAAE;YACb,MAAM,SAAS,GAAG,eAAe,IAAI,gBAAgB,CAAC;YACtD,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,eAAM,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;gBACjD,OAAO;YACT,CAAC;YAED,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,EAAE;gBAC9C,SAAS,EAAE;oBACT,KAAK,EAAE,yBAAyB;iBACjC;gBACD,UAAU,EAAE;oBACV,WAAW,EAAE,GAAG;oBAChB,UAAU,EAAE,GAAG;iBAChB;aACF,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM;gBAAE,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;YAC3C,eAAM,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;YAC7C,eAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;YACrC,eAAM,CAAC,IAAI,CAAC,mBAAmB,EAAE,MAAM,CAAC,qBAAqB,CAAC,CAAC;QACjE,CAAC;KACF;IAED;QACE,IAAI,EAAE,0BAA0B;QAChC,EAAE,EAAE,KAAK,IAAI,EAAE;YACb,MAAM,SAAS,GAAG,eAAe,IAAI,gBAAgB,CAAC;YACtD,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,eAAM,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;gBACjD,OAAO;YACT,CAAC;YAED,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,EAAE;gBAC9C,SAAS,EAAE;oBACT,KAAK,EAAE,WAAW;iBACnB;gBACD,OAAO,EAAE,CAAC,UAAU,EAAE,WAAW,EAAE,gBAAgB,CAAC;aACrD,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM;gBAAE,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;YAC3C,eAAM,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;YAC7C,eAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;YACrC,eAAM,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;YAEjC,8BAA8B;YAC9B,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;gBACpD,eAAM,CAAC,OAAO,CAAC,4BAA4B,CAAC,CAAC;YAC/C,CAAC;iBAAM,CAAC;gBACN,eAAM,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;YAC1D,CAAC;QACH,CAAC;KACF;IAED;QACE,IAAI,EAAE,yBAAyB;QAC/B,EAAE,EAAE,KAAK,IAAI,EAAE;YACb,MAAM,SAAS,GAAG,eAAe,IAAI,gBAAgB,CAAC;YACtD,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,eAAM,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;gBACjD,OAAO;YACT,CAAC;YAED,MAAM,cAAc,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,EAAE;gBACzD,QAAQ,EAAE;oBACR,UAAU,EAAE,oBAAoB;oBAChC,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;oBACnC,QAAQ,EAAE,IAAI;iBACf;aACF,CAAC,CAAC;YAEH,IAAI,CAAC,cAAc;gBAAE,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;YACtD,eAAM,CAAC,IAAI,CAAC,YAAY,EAAE,cAAc,CAAC,GAAG,CAAC,CAAC;YAC9C,eAAM,CAAC,IAAI,CAAC,UAAU,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAC;QACnD,CAAC;KACF;CACF,CAAC;AAEF,IAAA,qBAAY,EAAC,qBAAqB,EAAE,KAAK,CAAC,CAAC"}

package/dist/utils/logger.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Test Logger Utility
+ * Provides consistent logging for test output
+ */
+export declare const logger: {
+    test: (name: string) => void;
+    success: (message: string) => void;
+    error: (message: string) => void;
+    info: (message: string) => void;
+    data: (label: string, value: unknown) => void;
+    separator: () => void;
+    header: (title: string) => void;
+    summary: (passed: number, failed: number) => void;
+};
+/**
+ * Test runner helper
+ */
+export declare function runTest(name: string, testFn: () => Promise<void>): Promise<boolean>;
+/**
+ * Run multiple tests and report summary
+ */
+export declare function runTestSuite(suiteName: string, tests: Array<{
+    name: string;
+    fn: () => Promise<void>;
+}>): Promise<void>;
+//# sourceMappingURL=logger.d.ts.map

package/dist/utils/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/utils/logger.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,eAAO,MAAM,MAAM;iBACJ,MAAM;uBAIA,MAAM;qBAIR,MAAM;oBAIP,MAAM;kBAIR,MAAM,SAAS,OAAO;;oBAQpB,MAAM;sBAMJ,MAAM,UAAU,MAAM;CAKzC,CAAC;AAEF;;GAEG;AACH,wBAAsB,OAAO,CAC3B,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAC1B,OAAO,CAAC,OAAO,CAAC,CAalB;AAED;;GAEG;AACH,wBAAsB,YAAY,CAChC,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,KAAK,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAAE,CAAC,GACtD,OAAO,CAAC,IAAI,CAAC,CAoBf"}

package/dist/utils/logger.js

@@ -0,0 +1,79 @@
+"use strict";
+/**
+ * Test Logger Utility
+ * Provides consistent logging for test output
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = void 0;
+exports.runTest = runTest;
+exports.runTestSuite = runTestSuite;
+exports.logger = {
+    test: (name) => {
+        console.log(`\n🧪 Testing: ${name}...`);
+    },
+    success: (message) => {
+        console.log(`   ✅ ${message}`);
+    },
+    error: (message) => {
+        console.log(`   ❌ ${message}`);
+    },
+    info: (message) => {
+        console.log(`   ℹ️  ${message}`);
+    },
+    data: (label, value) => {
+        console.log(`   📊 ${label}:`, value);
+    },
+    separator: () => {
+        console.log("\n" + "─".repeat(60) + "\n");
+    },
+    header: (title) => {
+        console.log("\n" + "═".repeat(60));
+        console.log(`  ${title}`);
+        console.log("═".repeat(60) + "\n");
+    },
+    summary: (passed, failed) => {
+        console.log("\n" + "─".repeat(60));
+        console.log(`  📋 Summary: ${passed} passed, ${failed} failed`);
+        console.log("─".repeat(60) + "\n");
+    },
+};
+/**
+ * Test runner helper
+ */
+async function runTest(name, testFn) {
+    exports.logger.test(name);
+    try {
+        await testFn();
+        exports.logger.success("Passed");
+        return true;
+    }
+    catch (error) {
+        exports.logger.error(`Failed: ${error.message}`);
+        if (process.env.DEBUG === "true") {
+            console.error(error);
+        }
+        return false;
+    }
+}
+/**
+ * Run multiple tests and report summary
+ */
+async function runTestSuite(suiteName, tests) {
+    exports.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++;
+        }
+    }
+    exports.logger.summary(passed, failed);
+    if (failed > 0) {
+        process.exit(1);
+    }
+}
+//# sourceMappingURL=logger.js.map

package/dist/utils/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/utils/logger.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AA2CH,0BAgBC;AAKD,oCAuBC;AArFY,QAAA,MAAM,GAAG;IACpB,IAAI,EAAE,CAAC,IAAY,EAAE,EAAE;QACrB,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,KAAK,CAAC,CAAC;IAC1C,CAAC;IAED,OAAO,EAAE,CAAC,OAAe,EAAE,EAAE;QAC3B,OAAO,CAAC,GAAG,CAAC,QAAQ,OAAO,EAAE,CAAC,CAAC;IACjC,CAAC;IAED,KAAK,EAAE,CAAC,OAAe,EAAE,EAAE;QACzB,OAAO,CAAC,GAAG,CAAC,QAAQ,OAAO,EAAE,CAAC,CAAC;IACjC,CAAC;IAED,IAAI,EAAE,CAAC,OAAe,EAAE,EAAE;QACxB,OAAO,CAAC,GAAG,CAAC,UAAU,OAAO,EAAE,CAAC,CAAC;IACnC,CAAC;IAED,IAAI,EAAE,CAAC,KAAa,EAAE,KAAc,EAAE,EAAE;QACtC,OAAO,CAAC,GAAG,CAAC,SAAS,KAAK,GAAG,EAAE,KAAK,CAAC,CAAC;IACxC,CAAC;IAED,SAAS,EAAE,GAAG,EAAE;QACd,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;IAC5C,CAAC;IAED,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE;QACxB,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;QACnC,OAAO,CAAC,GAAG,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC;QAC1B,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;IACrC,CAAC;IAED,OAAO,EAAE,CAAC,MAAc,EAAE,MAAc,EAAE,EAAE;QAC1C,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;QACnC,OAAO,CAAC,GAAG,CAAC,iBAAiB,MAAM,YAAY,MAAM,SAAS,CAAC,CAAC;QAChE,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;IACrC,CAAC;CACF,CAAC;AAEF;;GAEG;AACI,KAAK,UAAU,OAAO,CAC3B,IAAY,EACZ,MAA2B;IAE3B,cAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClB,IAAI,CAAC;QACH,MAAM,MAAM,EAAE,CAAC;QACf,cAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,cAAM,CAAC,KAAK,CAAC,WAAY,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;QACpD,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,KAAK,MAAM,EAAE,CAAC;YACjC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,YAAY,CAChC,SAAiB,EACjB,KAAuD;IAEvD,cAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEzB,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,IAAI,MAAM,GAAG,CAAC,CAAC;IAEf,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;QACjD,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,EAAE,CAAC;QACX,CAAC;aAAM,CAAC;YACN,MAAM,EAAE,CAAC;QACX,CAAC;IACH,CAAC;IAED,cAAM,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAE/B,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;QACf,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC"}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "promptmetrics-sample",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "tsc",
+    "start": "ts-node src/index.ts",
+    "test:templates": "ts-node src/tests/templates.test.ts",
+    "test:load": "ts-node src/tests/template-run-load.test.ts",
+    "test:versions": "ts-node src/tests/versions.test.ts",
+    "test:logs": "ts-node src/tests/logs.test.ts",
+    "test:providers": "ts-node src/tests/providers.test.ts",
+    "test:traces": "ts-node src/tests/traces.test.ts",
+    "test:traceable": "ts-node src/tests/traceable.test.ts",
+    "test:tags": "ts-node src/tests/tags.test.ts",
+    "test:all": "npm run test:templates && npm run test:versions && npm run test:logs && npm run test:providers && npm run test:traces && npm run test:traceable && npm run test:tags"
+  },
+  "keywords": [
+    "promptmetrics",
+    "sdk",
+    "testing",
+    "llm"
+  ],
+  "author": "",
+  "license": "ISC",
+  "description": "Sample project to test PromptMetrics SDK functionality",
+  "devDependencies": {
+    "@types/node": "^25.0.3",
+    "dotenv": "^17.2.3",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "@promptmetrics/sdk": "^1.0.0"
+  }
+}

package/sample-project-plan.md

@@ -0,0 +1,316 @@
+# PromptMetrics SDK Sample Project Plan
+
+A sample Node.js/TypeScript project to test all SDK functionality by linking the `@promptmetrics/sdk` package via npm.
+
+---
+
+## Project Overview
+
+**Goal:** Create a comprehensive test project that validates all SDK features work correctly when installed as an npm package.
+
+**Tech Stack:**
+
+- Node.js 18+
+- TypeScript
+- npm (for package management)
+- dotenv (for environment variables)
+
+---
+
+## Project Structure
+
+```
+promptmetrics-sample/
+├── src/
+│   ├── index.ts              # Main entry point
+│   ├── tests/
+│   │   ├── templates.test.ts # Template operations tests
+│   │   ├── versions.test.ts  # Version operations tests
+│   │   ├── logs.test.ts      # Log operations tests
+│   │   ├── providers.test.ts # Provider operations tests
+│   │   ├── traces.test.ts    # Trace operations tests
+│   │   ├── traceable.test.ts # @traceable decorator tests
+│   │   └── tags.test.ts      # pl_tags feature tests
+│   └── utils/
+│       └── logger.ts         # Test logging utility
+├── .env                      # Environment variables
+├── .env.example              # Example env file
+├── package.json
+├── tsconfig.json
+└── README.md
+```
+
+---
+
+## Setup Steps
+
+### Step 1: Initialize Project
+
+```bash
+mkdir promptmetrics-sample
+cd promptmetrics-sample
+npm init -y
+```
+
+### Step 2: Install Dependencies
+
+```bash
+# Install SDK (link locally for development or install from npm)
+npm link ../promptmetrics-sdk  # For local development
+# OR
+npm install @promptmetrics/sdk  # For production
+
+# Install dev dependencies
+npm install -D typescript ts-node @types/node dotenv
+```
+
+### Step 3: Configure TypeScript
+
+Create `tsconfig.json`:
+
+```json
+{
+  "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
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}
+```
+
+### Step 4: Configure Environment
+
+Create `.env`:
+
+```bash
+# Required
+BASE_URL=http://localhost:3000
+
+# Required
+PROMPTMETRICS_API_KEY=pm_your_workspace_api_key
+
+# Test data (update with your actual IDs)
+TEST_TEMPLATE_NAME=test-template
+TEST_VERSION_ID=your_version_id
+TEST_TEMPLATE_ID=your_template_id
+```
+
+---
+
+## Test Cases to Implement
+
+### 1. Templates (`templates.test.ts`)
+
+| Test                      | Description                                                  |
+| ------------------------- | ------------------------------------------------------------ |
+| `getTemplateByName`       | Get template by name                                         |
+| `getTemplateById`         | Get template by ID                                           |
+| `getTemplateWithVersion`  | Get template with specific version number                    |
+| `getTemplateWithEnvLabel` | Get template with env_label (production/staging/development) |
+| `listTemplates`           | List all templates with pagination                           |
+| `listTemplatesWithSearch` | List templates with search filter                            |
+
+### 2. Versions (`versions.test.ts`)
+
+| Test                            | Description                                          |
+| ------------------------------- | ---------------------------------------------------- |
+| `getVersionById`                | Get version by ID                                    |
+| `getVersionByTemplateAndNumber` | Get version by template name + version number        |
+| `runVersion`                    | Run a version with variables                         |
+| `runVersionWithParameters`      | Run with custom parameters (temperature, max_tokens) |
+| `runVersionWithModel`           | Run with model override                              |
+| `runVersionWithTags`            | Run with pl_tags (new feature)                       |
+| `updateVersionMetadata`         | Update version metadata                              |
+| `updateVersionEnvLabel`         | Promote version to production                        |
+
+### 3. Logs (`logs.test.ts`)
+
+| Test                  | Description                                              |
+| --------------------- | -------------------------------------------------------- |
+| `listLogs`            | List all logs                                            |
+| `listLogsWithFilters` | List logs with template_id, status, date filters         |
+| `getLogById`          | Get specific log by ID                                   |
+| `verifyLogHasTags`    | Verify tags are stored in log (after runVersionWithTags) |
+
+### 4. Providers (`providers.test.ts`)
+
+| Test                | Description                      |
+| ------------------- | -------------------------------- |
+| `listProviders`     | List all LLM providers           |
+| `getProviderModels` | Get models for specific provider |
+
+### 5. Traces (`traces.test.ts`)
+
+| Test                | Description                     |
+| ------------------- | ------------------------------- |
+| `createTrace`       | Create a manual trace           |
+| `createBatchTraces` | Create multiple traces in batch |
+| `getTraceBySpanId`  | Get trace by span ID            |
+| `getTraceTree`      | Get full trace tree by trace_id |
+| `getTraceGroup`     | Get traces by group_id          |
+| `listTraces`        | List traces with filters        |
+| `addScore`          | Add score to a trace            |
+| `updateMetadata`    | Update trace metadata           |
+| `getAnalytics`      | Get trace analytics             |
+
+### 6. Traceable Decorator (`traceable.test.ts`)
+
+| Test                    | Description                                |
+| ----------------------- | ------------------------------------------ |
+| `basicTraceable`        | Basic @traceable decorator usage           |
+| `traceableWithMetadata` | @traceable with static metadata            |
+| `traceableWithTags`     | @traceable with tags                       |
+| `nestedTraceable`       | Nested @traceable functions (parent-child) |
+| `traceableWithLLMCall`  | @traceable with pm.versions.run inside     |
+| `trackMetadata`         | pm.track.metadata() inside traced function |
+| `trackScore`            | pm.track.score() inside traced function    |
+| `trackGroup`            | pm.track.group() for conversation grouping |
+
+### 7. Tags Feature (`tags.test.ts`)
+
+| Test                  | Description                                                |
+| --------------------- | ---------------------------------------------------------- |
+| `runWithPlTags`       | Run version with pl_tags array                             |
+| `verifyTagsInLog`     | Verify tags are stored in prompt log                       |
+| `runWithoutTags`      | Run without pl_tags (should inherit from template)         |
+| `verifyInheritedTags` | Verify template tags are inherited when pl_tags not passed |
+
+---
+
+## Implementation Plan
+
+### Phase 1: Project Setup (Day 1)
+
+- [ ] Create project directory structure
+- [ ] Initialize npm and install dependencies
+- [ ] Configure TypeScript
+- [ ] Set up environment variables
+- [ ] Create logger utility
+
+### Phase 2: Core Tests (Day 2)
+
+- [ ] Implement templates.test.ts
+- [ ] Implement versions.test.ts
+- [ ] Implement logs.test.ts
+- [ ] Implement providers.test.ts
+
+### Phase 3: Tracing Tests (Day 3)
+
+- [ ] Implement traces.test.ts
+- [ ] Implement traceable.test.ts
+
+### Phase 4: New Features (Day 4)
+
+- [ ] Implement tags.test.ts (pl_tags feature)
+- [ ] Add comprehensive error handling tests
+- [ ] Add edge case tests
+
+### Phase 5: Documentation & Cleanup (Day 5)
+
+- [ ] Write README with usage instructions
+- [ ] Add npm scripts for running tests
+- [ ] Clean up and finalize
+
+---
+
+## npm Scripts
+
+Add to `package.json`:
+
+```json
+{
+  "scripts": {
+    "build": "tsc",
+    "start": "ts-node src/index.ts",
+    "test:templates": "ts-node src/tests/templates.test.ts",
+    "test:versions": "ts-node src/tests/versions.test.ts",
+    "test:logs": "ts-node src/tests/logs.test.ts",
+    "test:providers": "ts-node src/tests/providers.test.ts",
+    "test:traces": "ts-node src/tests/traces.test.ts",
+    "test:traceable": "ts-node src/tests/traceable.test.ts",
+    "test:tags": "ts-node src/tests/tags.test.ts",
+    "test:all": "npm run test:templates && npm run test:versions && npm run test:logs && npm run test:providers && npm run test:traces && npm run test:traceable && npm run test:tags"
+  }
+}
+```
+
+---
+
+## Sample Test Implementation
+
+### Example: `src/tests/versions.test.ts`
+
+```typescript
+import "dotenv/config";
+import { PromptMetrics } from "@promptmetrics/sdk";
+
+const pm = new PromptMetrics({
+  apiKey: process.env.PROMPTMETRICS_API_KEY!,
+});
+
+async function testRunVersionWithTags() {
+  console.log("🧪 Testing: Run version with pl_tags...");
+
+  const result = await pm.versions.run(process.env.TEST_VERSION_ID!, {
+    variables: {
+      topic: "AI Testing",
+    },
+    pl_tags: ["sdk-test", "automated", "sample-project"],
+  });
+
+  console.log("✅ Success!");
+  console.log("   Request ID:", result.request_id);
+  console.log("   Tags:", result.tags);
+  console.log("   Status:", result.status);
+
+  // Verify tags are in response
+  if (result.tags?.includes("sdk-test")) {
+    console.log("   ✅ Tags verified in response!");
+  } else {
+    console.log("   ❌ Tags not found in response");
+  }
+}
+
+async function main() {
+  try {
+    await testRunVersionWithTags();
+  } catch (error) {
+    console.error("❌ Test failed:", error);
+    process.exit(1);
+  }
+}
+
+main();
+```
+
+---
+
+## Success Criteria
+
+- [ ] All SDK methods can be called without errors
+- [ ] Templates can be fetched by name, ID, version, and env_label
+- [ ] Versions can be run with variables, parameters, model overrides, and tags
+- [ ] Logs are created and can be retrieved with correct data
+- [ ] Traces are created via @traceable decorator and manual API
+- [ ] LLM calls inside @traceable are automatically correlated
+- [ ] pl_tags are stored in prompt logs correctly
+- [ ] Error handling works as expected (authentication, validation, not found)
+
+---
+
+## Notes
+
+- Make sure backend is running at `BASE_URL` before running tests
+- Create test templates/versions in the UI before running tests
+- Update `.env` with actual IDs from your workspace

package/src/index.ts

@@ -0,0 +1,36 @@
+#!/usr/bin/env ts-node
+/**
+ * PromptMetrics SDK Sample Project
+ * Main entry point - runs all test suites
+ */
+
+import "dotenv/config";
+import { logger } from "./utils/logger";
+
+async function main() {
+  logger.header("PromptMetrics SDK Sample Project");
+
+  console.log("This project tests all SDK functionality.\n");
+  console.log("Available test commands:");
+  console.log("  npm run test:templates   - Test template operations");
+  console.log("  npm run test:versions    - Test version operations");
+  console.log("  npm run test:logs        - Test log operations");
+  console.log("  npm run test:providers   - Test provider operations");
+  console.log("  npm run test:traces      - Test trace operations");
+  console.log("  npm run test:traceable   - Test @traceable decorator");
+  console.log("  npm run test:tags        - Test pm_tags feature");
+  console.log("  npm run test:all         - Run all tests");
+  console.log("\nConfiguration:");
+  console.log(`  BASE_URL: ${process.env.BASE_URL || "NOT SET"}`);
+  console.log(
+    `  API_KEY: ${
+      process.env.PROMPTMETRICS_API_KEY ? "SET (pm_***)" : "NOT SET"
+    }`
+  );
+  console.log(
+    `  TEST_TEMPLATE_NAME: ${process.env.TEST_TEMPLATE_NAME || "NOT SET"}`
+  );
+  console.log(`  TEST_VERSION_ID: ${process.env.TEST_VERSION_ID || "NOT SET"}`);
+}
+
+main().catch(console.error);