@promptev/client 0.0.1

package/LICENSE.txt

@@ -0,0 +1,20 @@
+Promptev SDK License
+
+Copyright © 2025 Promptev Inc.
+
+This software is proprietary and protected under applicable copyright laws.
+By using this software, you agree to the following:
+
+1. You may use this SDK:
+   - Free of charge on the Free Tier of Promptev services
+   - For evaluation or development purposes
+   - In production only with an active Promptev subscription
+
+2. Restrictions:
+   - You may NOT sublicense, distribute, or reverse-engineer this software
+   - You may NOT modify or resell this SDK or derivative works
+   - You may NOT use this SDK outside the Promptev API without a license
+
+3. The SDK is provided “AS IS” without warranties. Promptev Inc. shall not be held liable for any damages.
+
+By using this software, you accept these terms. For licensing inquiries or enterprise use, contact support@Promptev.ai.

package/dist/cjs/index.cjs

@@ -0,0 +1,143 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PromptevClient = void 0;
+const axios_1 = __importDefault(require("axios"));
+class PromptevClient {
+    constructor(config) {
+        this.refreshInterval = null;
+        this.baseUrl = config.baseUrl || "https://api.promptev.ai";
+        this.projectKey = config.projectKey;
+        this.cacheRefreshIntervalMs = config.cacheRefreshIntervalMs || 30000;
+        this.client = axios_1.default.create({ baseURL: this.baseUrl });
+        const isNode = typeof window === "undefined";
+        this.isReady = (async () => {
+            if (isNode) {
+                const { default: NodeCache } = await Promise.resolve().then(() => __importStar(require("node-cache")));
+                this.promptCache = new NodeCache({
+                    stdTTL: 3600,
+                    checkperiod: 120,
+                    useClones: false,
+                });
+            }
+            else {
+                this.promptCache = new Map();
+            }
+            this.startCacheRefresh();
+        })();
+    }
+    async ensureReady() {
+        await this.isReady;
+    }
+    makeCacheKey(promptKey, variables) {
+        const sorted = Object.keys(variables)
+            .sort()
+            .map(k => `${k}=${variables[k]}`)
+            .join("&");
+        return `${promptKey}:${btoa(sorted)}`;
+    }
+    async fetchPromptFromServer(promptKey) {
+        const url = `/api/sdk/v1/prompt/client/${this.projectKey}/${promptKey}`;
+        const response = await this.client.get(url);
+        const rawPrompt = response.data.prompt;
+        const rawVars = Array.isArray(response.data.variables)
+            ? response.data.variables
+            : typeof response.data.variables === "string"
+                ? response.data.variables.split(",").map(v => v.trim())
+                : [];
+        return { prompt: rawPrompt, variables: rawVars };
+    }
+    async formatPrompt(template, requiredVars, values) {
+        if (!requiredVars.length)
+            return template;
+        const missing = requiredVars.filter(v => !(v in values));
+        if (missing.length)
+            throw new Error(`Missing variables: ${missing.join(", ")}`);
+        let formatted = template;
+        for (const [key, val] of Object.entries(values)) {
+            const pattern = new RegExp(`{{\\s*${key.replace(/[.*+?^${}()|[\]\\]/g, "\\$&")}\\s*}}`, "g");
+            formatted = formatted.replace(pattern, val);
+        }
+        return formatted;
+    }
+    startCacheRefresh() {
+        if (this.refreshInterval)
+            clearInterval(this.refreshInterval);
+        this.refreshInterval = setInterval(async () => {
+            await this.ensureReady();
+            const keys = Array.from(this.promptCache instanceof Map ? this.promptCache.keys() : this.promptCache.keys());
+            for (const cacheKey of keys) {
+                const [promptKey, encoded] = cacheKey.split(":");
+                const vars = JSON.parse(atob(encoded));
+                try {
+                    await this.fetchAndCache(promptKey, vars);
+                }
+                catch { }
+            }
+        }, this.cacheRefreshIntervalMs);
+    }
+    async fetchAndCache(promptKey, variables) {
+        const data = await this.fetchPromptFromServer(promptKey);
+        const compiled = await this.formatPrompt(data.prompt, data.variables, variables);
+        const cacheKey = this.makeCacheKey(promptKey, variables);
+        this.promptCache.set(cacheKey, compiled);
+        return compiled;
+    }
+    async getPrompt(promptKey, variables = {}) {
+        await this.ensureReady();
+        const cacheKey = this.makeCacheKey(promptKey, variables);
+        const cached = this.promptCache.get(cacheKey);
+        if (cached)
+            return cached;
+        return await this.fetchAndCache(promptKey, variables);
+    }
+    async dispose() {
+        await this.ensureReady();
+        if (this.refreshInterval)
+            clearInterval(this.refreshInterval);
+        if (this.promptCache instanceof Map) {
+            this.promptCache.clear();
+        }
+        else {
+            this.promptCache.flushAll();
+            this.promptCache.close();
+        }
+    }
+}
+exports.PromptevClient = PromptevClient;
+exports.default = PromptevClient;

package/dist/cjs/index.d.ts

@@ -0,0 +1,30 @@
+export interface PromptliyClientConfig {
+    baseUrl?: string;
+    projectKey: string;
+}
+export interface Prompt {
+    prompt: string;
+    variables: string[] | string | null;
+    format(values?: Record<string, string>): string;
+}
+export declare class PromptliyClient {
+    private client;
+    private baseUrl;
+    private projectKey;
+    private promptCache;
+    private refreshInterval;
+    private cacheRefreshIntervalMs;
+    private isReady;
+    constructor(config: PromptliyClientConfig);
+    private ensureReady;
+    private startCacheRefresh;
+    private refreshCachedPrompt;
+    private createPromptObject;
+    getPrompt(promptKey: string): Promise<Prompt> & {
+        format: (values: Record<string, string>) => Promise<string>;
+    };
+    private fetchPrompt;
+    private fetchPromptFromServer;
+    dispose(): Promise<void>;
+}
+export default PromptliyClient;

package/dist/esm/index.d.ts

@@ -0,0 +1,24 @@
+export interface PromptevClientConfig {
+    baseUrl?: string;
+    projectKey: string;
+    cacheRefreshIntervalMs?: number;
+}
+export declare class PromptevClient {
+    private client;
+    private baseUrl;
+    private projectKey;
+    private promptCache;
+    private refreshInterval;
+    private cacheRefreshIntervalMs;
+    private isReady;
+    constructor(config: PromptevClientConfig);
+    private ensureReady;
+    private makeCacheKey;
+    private fetchPromptFromServer;
+    private formatPrompt;
+    private startCacheRefresh;
+    private fetchAndCache;
+    getPrompt(promptKey: string, variables?: Record<string, string>): Promise<string>;
+    dispose(): Promise<void>;
+}
+export default PromptevClient;

package/dist/esm/index.js

@@ -0,0 +1,103 @@
+import axios from "axios";
+export class PromptevClient {
+    constructor(config) {
+        this.refreshInterval = null;
+        this.baseUrl = config.baseUrl || "https://api.promptev.ai";
+        this.projectKey = config.projectKey;
+        this.cacheRefreshIntervalMs = config.cacheRefreshIntervalMs || 30000;
+        this.client = axios.create({ baseURL: this.baseUrl });
+        const isNode = typeof window === "undefined";
+        this.isReady = (async () => {
+            if (isNode) {
+                const { default: NodeCache } = await import("node-cache");
+                this.promptCache = new NodeCache({
+                    stdTTL: 3600,
+                    checkperiod: 120,
+                    useClones: false,
+                });
+            }
+            else {
+                this.promptCache = new Map();
+            }
+            this.startCacheRefresh();
+        })();
+    }
+    async ensureReady() {
+        await this.isReady;
+    }
+    makeCacheKey(promptKey, variables) {
+        const sorted = Object.keys(variables)
+            .sort()
+            .map(k => `${k}=${variables[k]}`)
+            .join("&");
+        return `${promptKey}:${btoa(sorted)}`;
+    }
+    async fetchPromptFromServer(promptKey) {
+        const url = `/api/sdk/v1/prompt/client/${this.projectKey}/${promptKey}`;
+        const response = await this.client.get(url);
+        const rawPrompt = response.data.prompt;
+        const rawVars = Array.isArray(response.data.variables)
+            ? response.data.variables
+            : typeof response.data.variables === "string"
+                ? response.data.variables.split(",").map(v => v.trim())
+                : [];
+        return { prompt: rawPrompt, variables: rawVars };
+    }
+    async formatPrompt(template, requiredVars, values) {
+        if (!requiredVars.length)
+            return template;
+        const missing = requiredVars.filter(v => !(v in values));
+        if (missing.length)
+            throw new Error(`Missing variables: ${missing.join(", ")}`);
+        let formatted = template;
+        for (const [key, val] of Object.entries(values)) {
+            const pattern = new RegExp(`{{\\s*${key.replace(/[.*+?^${}()|[\]\\]/g, "\\$&")}\\s*}}`, "g");
+            formatted = formatted.replace(pattern, val);
+        }
+        return formatted;
+    }
+    startCacheRefresh() {
+        if (this.refreshInterval)
+            clearInterval(this.refreshInterval);
+        this.refreshInterval = setInterval(async () => {
+            await this.ensureReady();
+            const keys = Array.from(this.promptCache instanceof Map ? this.promptCache.keys() : this.promptCache.keys());
+            for (const cacheKey of keys) {
+                const [promptKey, encoded] = cacheKey.split(":");
+                const vars = JSON.parse(atob(encoded));
+                try {
+                    await this.fetchAndCache(promptKey, vars);
+                }
+                catch { }
+            }
+        }, this.cacheRefreshIntervalMs);
+    }
+    async fetchAndCache(promptKey, variables) {
+        const data = await this.fetchPromptFromServer(promptKey);
+        const compiled = await this.formatPrompt(data.prompt, data.variables, variables);
+        const cacheKey = this.makeCacheKey(promptKey, variables);
+        this.promptCache.set(cacheKey, compiled);
+        return compiled;
+    }
+    async getPrompt(promptKey, variables = {}) {
+        await this.ensureReady();
+        const cacheKey = this.makeCacheKey(promptKey, variables);
+        const cached = this.promptCache.get(cacheKey);
+        if (cached)
+            return cached;
+        return await this.fetchAndCache(promptKey, variables);
+    }
+    async dispose() {
+        await this.ensureReady();
+        if (this.refreshInterval)
+            clearInterval(this.refreshInterval);
+        if (this.promptCache instanceof Map) {
+            this.promptCache.clear();
+        }
+        else {
+            this.promptCache.flushAll();
+            this.promptCache.close();
+        }
+    }
+}
+export default PromptevClient;

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@promptev/client",
+  "version": "0.0.1",
+  "description": "Client library for accessing Promptev API",
+  "type": "module",
+  "main": "./dist/cjs/index.cjs",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/esm/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.cjs",
+      "types": "./dist/esm/index.d.ts"
+    }
+  },
+  "license": "MIT",
+  "author": "Promptev Inc. <support@promptev.ai>",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "homepage": "https://promptliy.ai",
+  "files": [
+    "dist",
+    "readme.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "promptev",
+    "prompts",
+    "api",
+    "client",
+    "sdk",
+    "ai",
+    "promptDev",
+    "promptdev",
+    "promptops",
+    "typescript",
+    "javascript"
+  ],
+  "scripts": {
+    "prepare": "npm run build",
+    "build:esm": "tsc -p tsconfig.json",
+    "build:cjs": "tsc -p tsconfig.cjs.json && node scripts/rename-cjs.cjs",
+    "build": "npm run build:esm && npm run build:cjs"
+  },
+  "dependencies": {
+    "axios": "^1.10.0",
+    "node-cache": "^5.1.2"
+  },
+  "devDependencies": {
+    "@types/node": "^20.10.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.3"
+  }
+}

package/readme.md

@@ -0,0 +1,125 @@
+# promptev-client (JavaScript / TypeScript)
+
+A lightweight JS SDK to securely fetch, format, and cache prompts from [Promptev.ai](https://promptev.ai).
+
+---
+
+## Installation
+
+```bash
+npm install @promptev/client
+# or
+yarn install @promptev/client
+#or
+pnpm add @promptev/client
+```
+
+> Optional for Node.js caching (recommended):
+```bash
+npm install node-cache
+```
+
+---
+
+## What is Promptev?
+
+[Promptev](https://promptev.ai) helps teams manage, version, and collaborate on production-grade prompts with live context, variables, versioning and integrations.
+
+---
+
+## Usage
+
+### 1. Initialize the client
+
+```ts
+import { PromptevClient } from "@promptev/client";
+
+const client = new PromptevClient({
+  projectKey: "pv_sk_abc123yourkey"
+});
+```
+
+---
+
+### 2. Fetch a prompt with variables
+
+```ts
+const prompt = await client.getPrompt("onboarding-email", {
+  name: "Ava",
+  product: "Promptev"
+});
+
+console.log(prompt);
+// "Subject: Welcome, Ava! Hey Ava, Thanks for joining Promptev..."
+```
+
+---
+
+### 3. Fetch a prompt without variables
+
+```ts
+const staticPrompt = await client.getPrompt("system-intro");
+console.log(staticPrompt);
+// "You are a helpful AI assistant..."
+```
+
+> ⚠️ No variables? You can omit the second argument.
+
+---
+
+### 4. Use with LLM APIs (OpenAI, Claude, Gemini, etc.)
+
+```ts
+import OpenAI from "openai";
+
+const openai = new OpenAI({ apiKey: "sk-..." });
+
+const promptText = await client.getPrompt("clarify-topic", {
+  topic: "prompt engineering"
+});
+
+const response = await openai.chat.completions.create({
+  model: "gpt-4",
+  messages: [{ role: "user", content: promptText }]
+});
+
+console.log(response.choices[0].message.content);
+```
+
+---
+
+## Features
+
+- ✅ Works with or without prompt variables
+- 🔁 In-memory caching (Map or NodeCache)
+- 🔄 Background refresh (default: 30s, configurable)
+- ⚡ Token-safe variable formatting
+- 🔐 Secure for frontend & server
+- 🔌 Works with any LLM provider
+
+---
+
+## Options
+
+```ts
+new PromptevClient({
+  projectKey: "pv_sk_abc...",
+  baseUrl: "https://api.promptev.ai",   // optional
+  cacheRefreshIntervalMs: 60000         // optional
+});
+```
+
+---
+
+## License
+
+This SDK is **commercial software** by Promptev Inc.
+
+By using this package, you agree to the terms in [`LICENSE.txt`](./LICENSE.txt).
+
+---
+
+## Contact
+
+- 🌐 [https://promptev.ai](https://promptev.ai)
+- 📧 support@promptev.ai