@getzep/zep-cloud 0.0.1-rc.1

package/esm/zep-client.d.ts

@@ -0,0 +1,41 @@
+import DocumentManager from "./document_manager";
+import MemoryManager from "./memory_manager";
+import MessageManager from "./message_manager";
+import UserManager from "./user_manager";
+import { IZepClient } from "./interfaces";
+/**
+ * ZepClient is a Typescript class for interacting with the Zep.
+ */
+export default class ZepClient implements IZepClient {
+    private static constructing;
+    baseURL: string;
+    headers: any;
+    memory: MemoryManager;
+    message: MessageManager;
+    document: DocumentManager;
+    user: UserManager;
+    projectApiKey?: string;
+    cloud: boolean;
+    /**
+     * Constructs a new ZepClient instance.
+     * @param {string} [projectApiKey] - The project API key to use for authentication.
+     * @param {string} baseURL - Optional. The base URL of the Zep API.
+     */
+    constructor(projectApiKey?: string, baseURL?: string);
+    /**
+     * Asynchronously initializes a new instance of the ZepClient class.
+     *
+     * @param {string} [projectApiKey] Optional. The project API key to use for authentication.
+     * @param {string} [baseUrl] Optional. The base URL of the Zep API. Only user for open source
+     * @returns {Promise<ZepClient>} A promise that resolves to a new ZepClient instance.
+     * @throws {Error} Throws an error if the server is not running.
+     */
+    static init(projectApiKey?: string, baseUrl?: string): Promise<ZepClient>;
+    /**
+     * Constructs the full URL for an API endpoint.
+     * @param {string} endpoint - The endpoint of the API.
+     * @returns {string} The full URL.
+     */
+    getFullUrl(endpoint: string): string;
+    private checkServer;
+}

package/esm/zep-client.js

@@ -0,0 +1,104 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import DocumentManager from "./document_manager";
+import { API_BASEPATH, API_VERSION, isVersionGreaterOrEqual, MIN_SERVER_WARNING_MESSAGE, SERVER_ERROR_MESSAGE, warnDeprecation, joinPaths, } from "./utils";
+import MemoryManager from "./memory_manager";
+import MessageManager from "./message_manager";
+import UserManager from "./user_manager";
+/**
+ * ZepClient is a Typescript class for interacting with the Zep.
+ */
+class ZepClient {
+    /**
+     * Constructs a new ZepClient instance.
+     * @param {string} [projectApiKey] - The project API key to use for authentication.
+     * @param {string} baseURL - Optional. The base URL of the Zep API.
+     */
+    constructor(projectApiKey, baseURL) {
+        this.baseURL = "https://api.getzep.com";
+        this.cloud = false;
+        if (!ZepClient.constructing) {
+            warnDeprecation("Please use ZepClient.init(). Calling the ZepClient constructor directly is deprecated.");
+        }
+        if (!projectApiKey && !baseURL) {
+            throw new Error("You need to provide either a projectApiKey (if using cloud) or a baseURL (if using open source) to initialize the ZepClient.");
+        }
+        if (projectApiKey && !baseURL) {
+            if (!projectApiKey.startsWith("z_")) {
+                throw new Error("Invalid projectApiKey. Project API keys should start with 'z_'.");
+            }
+        }
+        if (baseURL) {
+            this.baseURL = baseURL;
+        }
+        this.projectApiKey = projectApiKey;
+        if (projectApiKey === null || projectApiKey === void 0 ? void 0 : projectApiKey.startsWith("z_")) {
+            this.cloud = true;
+        }
+        if (this.cloud) {
+            this.headers = {
+                Authorization: `Api-Key ${projectApiKey}`,
+            };
+        }
+        else if (!this.cloud && projectApiKey) {
+            this.headers = {
+                Authorization: `Bearer ${projectApiKey}`,
+            };
+        }
+        this.memory = new MemoryManager(this);
+        this.message = new MessageManager(this);
+        this.document = new DocumentManager(this);
+        this.user = new UserManager(this);
+    }
+    /**
+     * Asynchronously initializes a new instance of the ZepClient class.
+     *
+     * @param {string} [projectApiKey] Optional. The project API key to use for authentication.
+     * @param {string} [baseUrl] Optional. The base URL of the Zep API. Only user for open source
+     * @returns {Promise<ZepClient>} A promise that resolves to a new ZepClient instance.
+     * @throws {Error} Throws an error if the server is not running.
+     */
+    static init(projectApiKey, baseUrl) {
+        return __awaiter(this, void 0, void 0, function* () {
+            ZepClient.constructing = true;
+            const client = new ZepClient(projectApiKey, baseUrl);
+            ZepClient.constructing = false;
+            const isRunning = yield client.checkServer();
+            if (!isRunning) {
+                throw new Error(SERVER_ERROR_MESSAGE);
+            }
+            return client;
+        });
+    }
+    /**
+     * Constructs the full URL for an API endpoint.
+     * @param {string} endpoint - The endpoint of the API.
+     * @returns {string} The full URL.
+     */
+    getFullUrl(endpoint) {
+        const url = new URL(this.baseURL);
+        url.pathname = joinPaths(API_BASEPATH, `/${API_VERSION}`, endpoint);
+        return url.toString();
+    }
+    checkServer() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const healthCheck = "/healthz";
+            const healthCheckURL = `${this.baseURL}${healthCheck}`;
+            const response = yield fetch(healthCheckURL, { headers: this.headers });
+            const zepServerVersion = response.headers.get("X-Zep-Version");
+            if (!isVersionGreaterOrEqual(zepServerVersion) && !this.projectApiKey) {
+                console.warn(MIN_SERVER_WARNING_MESSAGE);
+            }
+            return response.status === 200;
+        });
+    }
+}
+ZepClient.constructing = false;
+export default ZepClient;