openlit 1.1.0 → 1.3.0

package/README.md

@@ -132,7 +132,7 @@ export OTEL_EXPORTER_OTLP_HEADERS = "YOUR_OTEL_ENDPOINT_AUTH"
 
 With the LLM Observability data now being collected and sent to OpenLIT, the next step is to visualize and analyze this data to get insights into your LLM application’s performance, behavior, and identify areas of improvement.
 
-To begin exploring your LLM Application's performance data within the OpenLIT UI, please see the [Quickstart Guide](https://docs.openlit.io/latest/quickstart).
+To begin exploring your LLM Application's performance data within the OpenLIT, please see the [Quickstart Guide](https://docs.openlit.io/latest/quickstart).
 
 If you want to integrate and send metrics and traces to your existing observability tools, refer to our [Connections Guide](https://docs.openlit.io/latest/connections/intro) for detailed instructions.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openlit",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "homepage": "https://github.com/openlit/openlit#readme",
   "bugs": {
     "url": "https://github.com/openlit/openlit/issues",

package/src/constant.ts

@@ -1,5 +1,6 @@
-export const SDK_NAME = "openlit";
-export const DEFAULT_ENVIRONMENT = "default";
-export const DEFAULT_APPLICATION_NAME = "default";
-export const INSTRUMENTATION_PREFIX = "@openlit";
-export const TELEMETRY_SDK_NAME = 'opentelemetry';
+export const SDK_NAME = 'openlit';
+export const DEFAULT_ENVIRONMENT = 'default';
+export const DEFAULT_APPLICATION_NAME = 'default';
+export const INSTRUMENTATION_PREFIX = '@openlit';
+export const TELEMETRY_SDK_NAME = 'opentelemetry';
+export const OPENLIT_URL = 'http://127.0.0.1:3000';

package/src/features/base.ts

@@ -0,0 +1,7 @@
+import PromptHub from './prompt-hub';
+import Vault from './vault';
+
+export default class BaseOpenlit {
+  static getPrompts = PromptHub.getPrompts;
+  static getSecrets = Vault.getSecrets;
+}

package/src/features/prompt-hub.ts

@@ -0,0 +1,64 @@
+import OpenlitConfig from '../config';
+import { OPENLIT_URL } from '../constant';
+import { PromptHubOptions } from '../types';
+
+export default class PromptHub {
+  static async getPrompts(options: PromptHubOptions) {
+    const url = process.env.OPENLIT_URL || options.url || OPENLIT_URL;
+    const apiKey = process.env.OPENLIT_API_KEY || options.apiKey || '';
+    let metaProperties = {
+      applicationName: OpenlitConfig.applicationName,
+      environment: OpenlitConfig.environment,
+    };
+    if (
+      options.metaProperties &&
+      typeof options.metaProperties === 'object' &&
+      !Array.isArray(options.metaProperties)
+    ) {
+      metaProperties = {
+        ...metaProperties,
+        ...options.metaProperties,
+      };
+    }
+
+    try {
+      return await fetch(`${url}/api/prompt/get-compiled`, {
+        method: 'POST',
+        body: JSON.stringify({
+          name: options.name,
+          version: options.version,
+          shouldCompile: !!options.shouldCompile,
+          variables: options.variables || {},
+          id: options.promptId,
+          metaProperties,
+          source: 'ts-sdk',
+        }),
+        headers: {
+          Authorization: `Bearer ${apiKey}`,
+        },
+      })
+        .then(async (response) => {
+          if (!response.ok) {
+            return {
+              err: `Openlit Error : HTTP error! Status: ${response.status}`,
+            };
+          }
+          return response.json();
+        })
+        .then((resp: any) => {
+          return resp;
+        });
+    } catch (e: any) {
+      if (e && typeof e.toString === 'function') {
+        return {
+          err: `Openlit Error : ${e.toString()}`,
+          data: null,
+        };
+      }
+
+      return {
+        err: `Openlit Error : ${e}`,
+      };
+    }
+  }
+}

package/src/features/vault.ts

@@ -0,0 +1,54 @@
+import { OPENLIT_URL } from '../constant';
+import { VaultOptions } from '../types';
+
+export default class Vault {
+  static async getSecrets(options: VaultOptions) {
+    const url = process.env.OPENLIT_URL || options.url || OPENLIT_URL;
+    const apiKey = process.env.OPENLIT_API_KEY || options.apiKey || '';
+
+    try {
+      const vaultResponse = await fetch(`${url}/api/vault/get-secrets`, {
+        method: 'POST',
+        body: JSON.stringify({
+          key: options.key,
+          tags: options.tags,
+        }),
+        headers: {
+          Authorization: `Bearer ${apiKey}`,
+        },
+      })
+        .then(async (response) => {
+          if (!response.ok) {
+            return {
+              err: `Openlit Error : HTTP error! Status: ${response.status}`,
+            };
+          }
+          return response.json();
+        })
+        .then((resp: any) => {
+          return resp;
+        });
+
+      const { res = {} } = vaultResponse;
+      if (!!options.shouldSetEnv) {
+        Object.entries(res).forEach(([key, value]: [string, unknown]) => {
+          process.env[key] = value as string;
+        });
+      }
+
+      return vaultResponse;
+    } catch (e: any) {
+      console.log(e);
+      if (e && typeof e.toString === 'function') {
+        return {
+          err: `Openlit Error : ${e.toString()}`,
+          data: null,
+        };
+      }
+
+      return {
+        err: `Openlit Error : ${e}`,
+      };
+    }
+  }
+}

package/src/index.ts

@@ -9,8 +9,9 @@ import { OpenlitOptions } from './types';
 import Tracing from './tracing';
 import { DEFAULT_APPLICATION_NAME, DEFAULT_ENVIRONMENT, SDK_NAME } from './constant';
 import { SpanExporter } from '@opentelemetry/sdk-trace-base';
+import BaseOpenlit from './features/base';
 
-export default class Openlit {
+export default class Openlit extends BaseOpenlit {
   static resource: Resource;
   static options: OpenlitOptions;
   static _sdk: NodeSDK;

package/src/prompt-hub.ts

@@ -0,0 +1,64 @@
+import OpenlitConfig from './config';
+import { OPENLIT_URL } from './constant';
+import { PromptHubOptions } from './types';
+
+export default class PromptHub {
+  static async getPrompts(options: PromptHubOptions) {
+    const url = process.env.OPENLIT_URL || options.url || OPENLIT_URL;
+    const apiKey = process.env.OPENLIT_API_KEY || options.apiKey || '';
+    let metaProperties = {
+      applicationName: OpenlitConfig.applicationName,
+      environment: OpenlitConfig.environment,
+    };
+    if (
+      options.metaProperties &&
+      typeof options.metaProperties === 'object' &&
+      !Array.isArray(options.metaProperties)
+    ) {
+      metaProperties = {
+        ...metaProperties,
+        ...options.metaProperties,
+      };
+    }
+
+    try {
+      return await fetch(`${url}/api/prompt/get-compiled`, {
+        method: 'POST',
+        body: JSON.stringify({
+          name: options.name,
+          version: options.version,
+          shouldCompile: !!options.shouldCompile,
+          variables: options.variables || {},
+          id: options.promptId,
+          metaProperties,
+          source: 'ts-sdk',
+        }),
+        headers: {
+          Authorization: `Bearer ${apiKey}`,
+        },
+      })
+        .then(async (response) => {
+          if (!response.ok) {
+            return {
+              err: `Openlit Error : HTTP error! Status: ${response.status}`,
+            };
+          }
+          return response.json();
+        })
+        .then((resp: any) => {
+          return resp;
+        });
+    } catch (e: any) {
+      if (e && typeof e.toString === 'function') {
+        return {
+          err: `Openlit Error : ${e.toString()}`,
+          data: null,
+        };
+      }
+
+      return {
+        err: `Openlit Error : ${e}`,
+      };
+    }
+  }
+}

package/src/types.ts

@@ -46,3 +46,23 @@ export type OpenlitOptions = {
 export type SetupTracerOptions = OpenlitOptions & {
   resource: Resource;
 };
+
+export interface BaseOpenlitOptions {
+  url?: string;
+  apiKey?: string;
+}
+
+export interface PromptHubOptions extends BaseOpenlitOptions {
+  name?: string;
+  version?: string;
+  shouldCompile?: boolean;
+  variables?: Record<string, any>;
+  promptId?: string;
+  metaProperties?: Record<string, any>;
+}
+
+export interface VaultOptions extends BaseOpenlitOptions {
+  key?: string;
+  tags?: string[];
+  shouldSetEnv?: boolean;
+}