@realtimex/sdk 1.5.1 → 1.7.0

package/dist/chunk-LM2TBHZ3.mjs

@@ -0,0 +1,651 @@
+// src/v1/errors.ts
+var DeveloperApiError = class extends Error {
+  constructor(status, code, message) {
+    super(message);
+    this.status = status;
+    this.code = code;
+    this.name = "DeveloperApiError";
+  }
+};
+var AuthenticationError = class extends DeveloperApiError {
+  constructor(message = "Invalid or missing API key") {
+    super(403, "AUTHENTICATION_ERROR", message);
+    this.name = "AuthenticationError";
+  }
+};
+var NotFoundError = class extends DeveloperApiError {
+  constructor(message = "Resource not found") {
+    super(404, "NOT_FOUND", message);
+    this.name = "NotFoundError";
+  }
+};
+var ValidationError = class extends DeveloperApiError {
+  constructor(message) {
+    super(400, "VALIDATION_ERROR", message);
+    this.name = "ValidationError";
+  }
+};
+var ServerError = class extends DeveloperApiError {
+  constructor(message = "Internal server error") {
+    super(500, "SERVER_ERROR", message);
+    this.name = "ServerError";
+  }
+};
+
+// src/v1/client.ts
+var DeveloperApiClient = class {
+  constructor(baseUrl, apiKey, appId) {
+    this.baseUrl = baseUrl.replace(/\/$/, "");
+    this.apiKey = apiKey;
+    this.appId = appId;
+  }
+  getHeaders(extra) {
+    const headers = {
+      "Content-Type": "application/json",
+      "Authorization": `Bearer ${this.apiKey}`
+    };
+    if (this.appId) headers["x-app-id"] = this.appId;
+    return { ...headers, ...extra };
+  }
+  async handleResponse(response) {
+    let data;
+    try {
+      data = await response.json();
+    } catch {
+      data = {};
+    }
+    if (response.ok) return data;
+    const message = data?.message || data?.error || response.statusText || "Request failed";
+    switch (response.status) {
+      case 400:
+        throw new ValidationError(message);
+      case 401:
+      case 403:
+        throw new AuthenticationError(message);
+      case 404:
+        throw new NotFoundError(message);
+      case 500:
+      case 502:
+      case 503:
+        throw new ServerError(message);
+      default:
+        throw new DeveloperApiError(response.status, "API_ERROR", message);
+    }
+  }
+  /**
+   * Make a JSON request to the v1 API.
+   */
+  async request(method, path, body) {
+    const url = `${this.baseUrl}/api${path}`;
+    const response = await fetch(url, {
+      method,
+      headers: this.getHeaders(),
+      body: body !== void 0 ? JSON.stringify(body) : void 0
+    });
+    return this.handleResponse(response);
+  }
+  /**
+   * Make a multipart/form-data request (e.g. file uploads).
+   * Do NOT set Content-Type — browser/fetch will set it with the boundary.
+   */
+  async requestMultipart(method, path, form) {
+    const url = `${this.baseUrl}/api${path}`;
+    const authHeaders = { "Authorization": `Bearer ${this.apiKey}` };
+    if (this.appId) authHeaders["x-app-id"] = this.appId;
+    const response = await fetch(url, {
+      method,
+      headers: authHeaders,
+      body: form
+    });
+    return this.handleResponse(response);
+  }
+  /**
+   * Make a raw request and return the Response object directly.
+   * Used for streaming (SSE) endpoints.
+   */
+  async requestRaw(method, path, body) {
+    const url = `${this.baseUrl}/api${path}`;
+    return fetch(url, {
+      method,
+      headers: this.getHeaders(),
+      body: body !== void 0 ? JSON.stringify(body) : void 0
+    });
+  }
+};
+
+// src/v1/modules/v1Auth.ts
+var V1AuthModule = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Verify the attached Authentication header contains a valid API token.
+   * @see GET /v1/auth
+   */
+  async getAuth() {
+    return this.client.request("GET", `/v1/auth`);
+  }
+};
+
+// src/v1/modules/v1Admin.ts
+var V1AdminModule = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Check to see if the instance is in multi-user-mode first. Methods are disabled until multi user mode is enabled via the UI.
+   * @see GET /v1/admin/is-multi-user-mode
+   */
+  async getIsMultiUserMode() {
+    return this.client.request("GET", `/v1/admin/is-multi-user-mode`);
+  }
+  /**
+   * Check to see if the instance is in multi-user-mode first. Methods are disabled until multi user mode is enabled via the UI.
+   * @see GET /v1/admin/users
+   */
+  async listUsers() {
+    return this.client.request("GET", `/v1/admin/users`);
+  }
+  /**
+   * Create a new user with username and password. Methods are disabled until multi user mode is enabled via the UI.
+   * @see POST /v1/admin/users/new
+   */
+  async createUser(body) {
+    return this.client.request("POST", `/v1/admin/users/new`, body);
+  }
+  /**
+   * Update existing user settings. Methods are disabled until multi user mode is enabled via the UI.
+   * @see POST /v1/admin/users/{id}
+   */
+  async updateUser(id, body) {
+    return this.client.request("POST", `/v1/admin/users/${id}`, body);
+  }
+  /**
+   * Delete existing user by id. Methods are disabled until multi user mode is enabled via the UI.
+   * @see DELETE /v1/admin/users/{id}
+   */
+  async deleteUser(id) {
+    return this.client.request("DELETE", `/v1/admin/users/${id}`);
+  }
+  /**
+   * List all existing invitations to instance regardless of status. Methods are disabled until multi user mode is enabled via the UI.
+   * @see GET /v1/admin/invites
+   */
+  async listInvites() {
+    return this.client.request("GET", `/v1/admin/invites`);
+  }
+  /**
+   * Create a new invite code for someone to use to register with instance. Methods are disabled until multi user mode is enabled via the UI.
+   * @see POST /v1/admin/invite/new
+   */
+  async createInvite(body) {
+    return this.client.request("POST", `/v1/admin/invite/new`, body);
+  }
+  /**
+   * Deactivates (soft-delete) invite by id. Methods are disabled until multi user mode is enabled via the UI.
+   * @see DELETE /v1/admin/invite/{id}
+   */
+  async deleteInvite(id) {
+    return this.client.request("DELETE", `/v1/admin/invite/${id}`);
+  }
+  /**
+   * Retrieve a list of users with permissions to access the specified workspace.
+   * @see GET /v1/admin/workspaces/{workspaceId}/users
+   */
+  async listWorkspaceUsers(workspaceId) {
+    return this.client.request("GET", `/v1/admin/workspaces/${workspaceId}/users`);
+  }
+  /**
+   * Overwrite workspace permissions to only be accessible by the given user ids and admins. Methods are disabled until multi user mode is enabled via the UI.
+   * @see POST /v1/admin/workspaces/{workspaceId}/update-users
+   */
+  async updateUsers(workspaceId, body) {
+    return this.client.request("POST", `/v1/admin/workspaces/${workspaceId}/update-users`, body);
+  }
+  /**
+   * Set workspace permissions to be accessible by the given user ids and admins. Methods are disabled until multi user mode is enabled via the UI.
+   * @see POST /v1/admin/workspaces/{workspaceSlug}/manage-users
+   */
+  async workspacesManageUsers(workspaceSlug, body) {
+    return this.client.request("POST", `/v1/admin/workspaces/${workspaceSlug}/manage-users`, body);
+  }
+  /**
+   * All chats in the system ordered by most recent. Methods are disabled until multi user mode is enabled via the UI.
+   * @see POST /v1/admin/workspace-chats
+   */
+  async workspaceChats(body) {
+    return this.client.request("POST", `/v1/admin/workspace-chats`, body);
+  }
+  /**
+   * Update multi-user preferences for instance. Methods are disabled until multi user mode is enabled via the UI.
+   * @see POST /v1/admin/preferences
+   */
+  async createPreference(body) {
+    return this.client.request("POST", `/v1/admin/preferences`, body);
+  }
+};
+
+// src/v1/modules/v1Document.ts
+var V1DocumentModule = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Upload a new file to RealTimeX to be parsed and prepared for embedding.
+   * @see POST /v1/document/upload
+   */
+  // @upload-stub — multipart upload; wire form manually or use helper
+  async upload(form) {
+    return this.client.requestMultipart("POST", `/v1/document/upload`, form);
+  }
+  /**
+   * Upload a new file to a specific folder in RealTimeX to be parsed and prepared for embedding. If the folder does not exist, it will be created.
+   * @see POST /v1/document/upload/{folderName}
+   */
+  // @upload-stub — multipart upload; wire form manually or use helper
+  async uploadFolder(folderName, form) {
+    return this.client.requestMultipart("POST", `/v1/document/upload/${folderName}`, form);
+  }
+  /**
+   * Upload a valid URL for RealTimeX to scrape and prepare for embedding. Optionally, specify a comma-separated list of workspace slugs to embed the document into post-upload.
+   * @see POST /v1/document/upload-link
+   */
+  async uploadLink(body) {
+    return this.client.request("POST", `/v1/document/upload-link`, body);
+  }
+  /**
+   * Upload a file by specifying its raw text content and metadata values without having to upload a file.
+   * @see POST /v1/document/raw-text
+   */
+  async rawText(body) {
+    return this.client.request("POST", `/v1/document/raw-text`, body);
+  }
+  /**
+   * List of all locally-stored documents in instance
+   * @see GET /v1/documents
+   */
+  async listDocuments() {
+    return this.client.request("GET", `/v1/documents`);
+  }
+  /**
+   * Get all documents stored in a specific folder.
+   * @see GET /v1/documents/folder/{folderName}
+   */
+  async getFolder(folderName) {
+    return this.client.request("GET", `/v1/documents/folder/${folderName}`);
+  }
+  /**
+   * Check available filetypes and MIMEs that can be uploaded.
+   * @see GET /v1/document/accepted-file-types
+   */
+  async listAcceptedFileTypes() {
+    return this.client.request("GET", `/v1/document/accepted-file-types`);
+  }
+  /**
+   * Get the known available metadata schema for when doing a raw-text upload and the acceptable type of value for each key.
+   * @see GET /v1/document/metadata-schema
+   */
+  async getMetadataSchema() {
+    return this.client.request("GET", `/v1/document/metadata-schema`);
+  }
+  /**
+   * Get a single document by its unique RealTimeX document name
+   * @see GET /v1/document/{docName}
+   */
+  async getDocument(docName) {
+    return this.client.request("GET", `/v1/document/${docName}`);
+  }
+  /**
+   * Create a new folder inside the documents storage directory.
+   * @see POST /v1/document/create-folder
+   */
+  async createFolder(body) {
+    return this.client.request("POST", `/v1/document/create-folder`, body);
+  }
+  /**
+   * Remove a folder and all its contents from the documents storage directory.
+   * @see DELETE /v1/document/remove-folder
+   */
+  async deleteRemoveFolder() {
+    return this.client.request("DELETE", `/v1/document/remove-folder`);
+  }
+  /**
+   * Move files within the documents storage directory.
+   * @see POST /v1/document/move-files
+   */
+  async moveFiles(body) {
+    return this.client.request("POST", `/v1/document/move-files`, body);
+  }
+};
+
+// src/v1/modules/v1Workspace.ts
+var V1WorkspaceModule = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Create a new workspace
+   * @see POST /v1/workspace/new
+   */
+  async createWorkspace(body) {
+    return this.client.request("POST", `/v1/workspace/new`, body);
+  }
+  /**
+   * List all current workspaces
+   * @see GET /v1/workspaces
+   */
+  async listWorkspaces() {
+    return this.client.request("GET", `/v1/workspaces`);
+  }
+  /**
+   * Get a workspace by its unique slug.
+   * @see GET /v1/workspace/{slug}
+   */
+  async getWorkspace(slug) {
+    return this.client.request("GET", `/v1/workspace/${slug}`);
+  }
+  /**
+   * Deletes a workspace by its slug.
+   * @see DELETE /v1/workspace/{slug}
+   */
+  async deleteWorkspace(slug) {
+    return this.client.request("DELETE", `/v1/workspace/${slug}`);
+  }
+  /**
+   * Update workspace settings by its unique slug.
+   * @see POST /v1/workspace/{slug}/update
+   */
+  async updateWorkspace(slug, body) {
+    return this.client.request("POST", `/v1/workspace/${slug}/update`, body);
+  }
+  /**
+   * Get a workspaces chats regardless of user by its unique slug.
+   * @see GET /v1/workspace/{slug}/chats
+   */
+  async listChats(slug) {
+    return this.client.request("GET", `/v1/workspace/${slug}/chats`);
+  }
+  /**
+   * Add or remove documents from a workspace by its unique slug.
+   * @see POST /v1/workspace/{slug}/update-embeddings
+   */
+  async updateEmbeddings(slug, body) {
+    return this.client.request("POST", `/v1/workspace/${slug}/update-embeddings`, body);
+  }
+  /**
+   * Add or remove pin from a document in a workspace by its unique slug.
+   * @see POST /v1/workspace/{slug}/update-pin
+   */
+  async updatePin(slug, body) {
+    return this.client.request("POST", `/v1/workspace/${slug}/update-pin`, body);
+  }
+  /**
+   * Execute a chat with a workspace
+   * @see POST /v1/workspace/{slug}/chat
+   */
+  async chat(slug, body) {
+    return this.client.request("POST", `/v1/workspace/${slug}/chat`, body);
+  }
+  /**
+   * Execute a streamable chat with a workspace
+   * @see POST /v1/workspace/{slug}/stream-chat
+   */
+  // @streaming-stub — implement SSE parsing in overrides/v1WorkspaceStreaming.ts
+  async streamChat(slug, body) {
+    return this.client.requestRaw("POST", `/v1/workspace/${slug}/stream-chat`, body);
+  }
+  /**
+   * Perform a vector similarity search in a workspace
+   * @see POST /v1/workspace/{slug}/vector-search
+   */
+  async vectorSearch(slug, body) {
+    return this.client.request("POST", `/v1/workspace/${slug}/vector-search`, body);
+  }
+};
+
+// src/v1/modules/v1System.ts
+var V1SystemModule = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Dump all settings to file storage
+   * @see GET /v1/system/env-dump
+   */
+  async getEnvDump() {
+    return this.client.request("GET", `/v1/system/env-dump`);
+  }
+  /**
+   * Get all current system settings that are defined.
+   * @see GET /v1/system
+   */
+  async getSystem() {
+    return this.client.request("GET", `/v1/system`);
+  }
+  /**
+   * Number of all vectors in connected vector database
+   * @see GET /v1/system/vector-count
+   */
+  async getVectorCount() {
+    return this.client.request("GET", `/v1/system/vector-count`);
+  }
+  /**
+   * Update a system setting or preference.
+   * @see POST /v1/system/update-env
+   */
+  async updateEnv(body) {
+    return this.client.request("POST", `/v1/system/update-env`, body);
+  }
+  /**
+   * Export all of the chats from the system in a known format. Output depends on the type sent. Will be send with the correct header for the output.
+   * @see GET /v1/system/export-chats
+   */
+  async listExportChats() {
+    return this.client.request("GET", `/v1/system/export-chats`);
+  }
+  /**
+   * Permanently remove documents from the system.
+   * @see DELETE /v1/system/remove-documents
+   */
+  async deleteRemoveDocument() {
+    return this.client.request("DELETE", `/v1/system/remove-documents`);
+  }
+  /**
+   * Returns a health check object with server uptime and version.
+   * @see GET /v1/system/health
+   */
+  async getHealth() {
+    return this.client.request("GET", `/v1/system/health`);
+  }
+};
+
+// src/v1/modules/v1Thread.ts
+var V1ThreadModule = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Create a new workspace thread
+   * @see POST /v1/workspace/{slug}/thread/new
+   */
+  async createThread(slug, body) {
+    return this.client.request("POST", `/v1/workspace/${slug}/thread/new`, body);
+  }
+  /**
+   * Update thread settings by its unique slug.
+   * @see POST /v1/workspace/{slug}/thread/{threadSlug}/update
+   */
+  async updateThread(slug, threadSlug, body) {
+    return this.client.request("POST", `/v1/workspace/${slug}/thread/${threadSlug}/update`, body);
+  }
+  /**
+   * Delete a workspace thread
+   * @see DELETE /v1/workspace/{slug}/thread/{threadSlug}
+   */
+  async deleteThread(slug, threadSlug) {
+    return this.client.request("DELETE", `/v1/workspace/${slug}/thread/${threadSlug}`);
+  }
+  /**
+   * Get chats for a workspace thread
+   * @see GET /v1/workspace/{slug}/thread/{threadSlug}/chats
+   */
+  async listChats(slug, threadSlug) {
+    return this.client.request("GET", `/v1/workspace/${slug}/thread/${threadSlug}/chats`);
+  }
+  /**
+   * Chat with a workspace thread
+   * @see POST /v1/workspace/{slug}/thread/{threadSlug}/chat
+   */
+  async chat(slug, threadSlug, body) {
+    return this.client.request("POST", `/v1/workspace/${slug}/thread/${threadSlug}/chat`, body);
+  }
+  /**
+   * Stream chat with a workspace thread
+   * @see POST /v1/workspace/{slug}/thread/{threadSlug}/stream-chat
+   */
+  // @streaming-stub — implement SSE parsing in overrides/v1ThreadStreaming.ts
+  async streamChat(slug, threadSlug, body) {
+    return this.client.requestRaw("POST", `/v1/workspace/${slug}/thread/${threadSlug}/stream-chat`, body);
+  }
+};
+
+// src/v1/modules/v1Users.ts
+var V1UsersModule = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * List all users
+   * @see GET /v1/users
+   */
+  async listUsers() {
+    return this.client.request("GET", `/v1/users`);
+  }
+  /**
+   * Issue a temporary auth token for a user
+   * @see GET /v1/users/{id}/issue-auth-token
+   */
+  async getIssueAuthToken(id) {
+    return this.client.request("GET", `/v1/users/${id}/issue-auth-token`);
+  }
+};
+
+// src/v1/modules/v1OpenAI.ts
+var V1OpenAIModule = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Get all available "models" which are workspaces you can use for chatting.
+   * @see GET /v1/openai/models
+   */
+  async listModels() {
+    return this.client.request("GET", `/v1/openai/models`);
+  }
+  /**
+   * Execute a chat with a workspace with OpenAI compatibility. Supports streaming as well. Model must be a workspace slug from /models.
+   * @see POST /v1/openai/chat/completions
+   */
+  async chatCompletions(body) {
+    return this.client.request("POST", `/v1/openai/chat/completions`, body);
+  }
+  /**
+   * Get the embeddings of any arbitrary text string. This will use the embedder provider set in the system. Please ensure the token length of each string fits within the context of your embedder model.
+   * @see POST /v1/openai/embeddings
+   */
+  async createEmbedding(body) {
+    return this.client.request("POST", `/v1/openai/embeddings`, body);
+  }
+  /**
+   * List all the vector database collections connected to RealTimeX. These are essentially workspaces but return their unique vector db identifier - this is the same as the workspace slug.
+   * @see GET /v1/openai/vector_stores
+   */
+  async listVectorStores() {
+    return this.client.request("GET", `/v1/openai/vector_stores`);
+  }
+};
+
+// src/v1/modules/v1Embed.ts
+var V1EmbedModule = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * List all active embeds
+   * @see GET /v1/embed
+   */
+  async getEmbed() {
+    return this.client.request("GET", `/v1/embed`);
+  }
+  /**
+   * Get all chats for a specific embed
+   * @see GET /v1/embed/{embedUuid}/chats
+   */
+  async listChats(embedUuid) {
+    return this.client.request("GET", `/v1/embed/${embedUuid}/chats`);
+  }
+  /**
+   * Get chats for a specific embed and session
+   * @see GET /v1/embed/{embedUuid}/chats/{sessionUuid}
+   */
+  async getChat(embedUuid, sessionUuid) {
+    return this.client.request("GET", `/v1/embed/${embedUuid}/chats/${sessionUuid}`);
+  }
+  /**
+   * Create a new embed configuration
+   * @see POST /v1/embed/new
+   */
+  async createEmbed(body) {
+    return this.client.request("POST", `/v1/embed/new`, body);
+  }
+  /**
+   * Update an existing embed configuration
+   * @see POST /v1/embed/{embedUuid}
+   */
+  async updateEmbed(embedUuid, body) {
+    return this.client.request("POST", `/v1/embed/${embedUuid}`, body);
+  }
+  /**
+   * Delete an existing embed configuration
+   * @see DELETE /v1/embed/{embedUuid}
+   */
+  async deleteEmbed(embedUuid) {
+    return this.client.request("DELETE", `/v1/embed/${embedUuid}`);
+  }
+};
+
+// src/v1/namespace.ts
+var V1ApiNamespace = class {
+  // [GENERATED-PROPS-END]
+  constructor(baseUrl, apiKey, appId) {
+    this._client = new DeveloperApiClient(baseUrl, apiKey, appId);
+    this.auth = new V1AuthModule(this._client);
+    this.admin = new V1AdminModule(this._client);
+    this.document = new V1DocumentModule(this._client);
+    this.workspace = new V1WorkspaceModule(this._client);
+    this.system = new V1SystemModule(this._client);
+    this.thread = new V1ThreadModule(this._client);
+    this.users = new V1UsersModule(this._client);
+    this.openai = new V1OpenAIModule(this._client);
+    this.embed = new V1EmbedModule(this._client);
+  }
+};
+
+export {
+  DeveloperApiError,
+  AuthenticationError,
+  NotFoundError,
+  ValidationError,
+  ServerError,
+  DeveloperApiClient,
+  V1AuthModule,
+  V1AdminModule,
+  V1DocumentModule,
+  V1WorkspaceModule,
+  V1SystemModule,
+  V1ThreadModule,
+  V1UsersModule,
+  V1OpenAIModule,
+  V1EmbedModule,
+  V1ApiNamespace
+};