qualifire 0.1.0 → 0.2.0

package/README.md

@@ -18,33 +18,24 @@ npm install my-package-name
 ## Usage
 
 ```ts
-import { myPackage } from 'my-package-name';
-
-myPackage('hello');
-//=> 'hello from my package'
+import * as qualifire from 'qualifire';
+
+const qualifireClient = qualifire.getClient('#YOUR-SDK-KEY#');
+
+const prompt = await qualifireClient.getValueAsync(
+  'isMyAwesomeFeatureEnabled',
+  {
+    var1: 'val1',
+    var2: 'val2',
+  }
+);
+
+const chatCompletion = await openai.createChatCompletion({
+  model: 'gpt-3.5-turbo',
+  messages: [{ role: 'user', content: prompt }],
+});
 ```
 
-## API
-
-### myPackage(input, options?)
-
-#### input
-
-Type: `string`
-
-Lorem ipsum.
-
-#### options
-
-Type: `object`
-
-##### postfix
-
-Type: `string`
-Default: `rainbows`
-
-Lorem ipsum.
-
 [build-img]: https://github.com/drorivry/develop/qualifire-typescript-sdk/actions/workflows/release.yml/badge.svg
 [build-url]: https://github.com/drorivry/qualifire-typescript-sdk/actions/workflows/release.yml
 [downloads-img]: https://img.shields.io/npm/dt/main/qualifire

package/lib/index.d.ts

@@ -1 +1,8 @@
-export declare const myPackage: (taco?: string) => string;
+export declare function getClient(sdkKey?: string, qualifireBaseUrl?: string): QualifireClient;
+declare class QualifireClient {
+    sdkKey: string;
+    baseUrl: string;
+    constructor(key: string, baseUrl: string);
+    getValueAsync(promptId: string, templateValues?: Record<string, string>, defaultValue?: string | null): Promise<string | null>;
+}
+export {};

package/lib/index.js

@@ -1,5 +1,42 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.myPackage = void 0;
-const myPackage = (taco = '') => `${taco} from my package`;
-exports.myPackage = myPackage;
+exports.getClient = void 0;
+function getClient(sdkKey, qualifireBaseUrl) {
+    const key = sdkKey || process.env.QUALIFIRE_SDK_KEY;
+    const baseUrl = qualifireBaseUrl ||
+        process.env.QUALIFIRE_BASE_URL ||
+        'https://app.qualifire.xyz';
+    if (!key) {
+        throw new Error('Missing SDK key, please provide an arg or add the QUALIFIRE_SDK_KEY environment variable.');
+    }
+    return new QualifireClient(key, baseUrl);
+}
+exports.getClient = getClient;
+class QualifireClient {
+    constructor(key, baseUrl) {
+        this.sdkKey = key;
+        this.baseUrl = baseUrl;
+    }
+    async getValueAsync(promptId, templateValues, defaultValue = null) {
+        const qualifireResponse = await fetch(`${this.baseUrl}/api/studio/prompt?${new URLSearchParams({
+            promptId,
+        }).toString()}`, {
+            headers: new Headers({
+                Authorization: 'Bearer ' + this.sdkKey,
+            }),
+        });
+        if (!qualifireResponse.ok) {
+            console.error('error while getting the prompt', qualifireResponse.json());
+            return defaultValue;
+        }
+        const { prompt, templateVariables } = (await qualifireResponse.json());
+        let parsedPrompt = prompt;
+        if (templateValues && templateVariables) {
+            for (const variable of templateVariables) {
+                parsedPrompt = parsedPrompt.replaceAll(`{${variable}}`, templateValues[variable] || '');
+            }
+            return parsedPrompt;
+        }
+        return defaultValue;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qualifire",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Qualifire client SDK",
   "main": "./lib/index.js",
   "files": [
@@ -58,7 +58,7 @@
     "semantic-release": "^21.0.1",
     "ts-jest": "^27.0.5",
     "ts-node": "^10.2.1",
-    "typescript": "^4.2.4"
+    "typescript": "^5.1.6"
   },
   "config": {
     "commitizen": {