@realtimex/sdk 1.6.0 → 1.7.4

package/dist/v1/index.mjs

@@ -0,0 +1,154 @@
+import {
+  AuthenticationError,
+  DeveloperApiClient,
+  DeveloperApiError,
+  NotFoundError,
+  ServerError,
+  V1AdminModule,
+  V1ApiNamespace,
+  V1AuthModule,
+  V1DocumentModule,
+  V1EmbedModule,
+  V1OpenAIModule,
+  V1SystemModule,
+  V1ThreadModule,
+  V1UsersModule,
+  V1WorkspaceModule,
+  ValidationError
+} from "../chunk-PDAMNSF2.mjs";
+
+// src/v1/overrides/v1WorkspaceStreaming.ts
+async function* streamWorkspaceChat(client, slug, body) {
+  const response = await client.requestRaw("POST", `/v1/workspace/${slug}/stream-chat`, body);
+  if (!response.body) {
+    throw new Error("Response body is null \u2014 streaming is not supported in this environment");
+  }
+  const reader = response.body.getReader();
+  const decoder = new TextDecoder();
+  let buffer = "";
+  let isErrorEvent = false;
+  try {
+    while (true) {
+      const { done, value } = await reader.read();
+      if (done) break;
+      buffer += decoder.decode(value, { stream: true });
+      const lines = buffer.split("\n");
+      buffer = lines.pop() ?? "";
+      for (const line of lines) {
+        if (line.startsWith("event: error")) {
+          isErrorEvent = true;
+          continue;
+        }
+        if (line.startsWith("data: ")) {
+          const jsonStr = line.slice(6).trim();
+          if (jsonStr === "[DONE]") {
+            isErrorEvent = false;
+            continue;
+          }
+          let data;
+          try {
+            data = JSON.parse(jsonStr);
+          } catch {
+            continue;
+          }
+          if (isErrorEvent) {
+            throw new Error(data.error ?? "Unknown streaming error from server");
+          }
+          yield data;
+        }
+      }
+    }
+  } finally {
+    reader.releaseLock();
+  }
+}
+
+// src/v1/overrides/v1ThreadStreaming.ts
+async function* streamThreadChat(client, slug, threadSlug, body) {
+  const response = await client.requestRaw(
+    "POST",
+    `/v1/workspace/${slug}/thread/${threadSlug}/stream-chat`,
+    body
+  );
+  if (!response.body) {
+    throw new Error("Response body is null \u2014 streaming is not supported in this environment");
+  }
+  const reader = response.body.getReader();
+  const decoder = new TextDecoder();
+  let buffer = "";
+  let isErrorEvent = false;
+  try {
+    while (true) {
+      const { done, value } = await reader.read();
+      if (done) break;
+      buffer += decoder.decode(value, { stream: true });
+      const lines = buffer.split("\n");
+      buffer = lines.pop() ?? "";
+      for (const line of lines) {
+        if (line.startsWith("event: error")) {
+          isErrorEvent = true;
+          continue;
+        }
+        if (line.startsWith("data: ")) {
+          const jsonStr = line.slice(6).trim();
+          if (jsonStr === "[DONE]") {
+            isErrorEvent = false;
+            continue;
+          }
+          let data;
+          try {
+            data = JSON.parse(jsonStr);
+          } catch {
+            continue;
+          }
+          if (isErrorEvent) {
+            throw new Error(data.error ?? "Unknown streaming error from server");
+          }
+          yield data;
+        }
+      }
+    }
+  } finally {
+    reader.releaseLock();
+  }
+}
+
+// src/v1/overrides/v1DocumentUpload.ts
+async function uploadFile(client, file, options = {}) {
+  const form = new FormData();
+  const filename = options.filename ?? (file instanceof File ? file.name : "upload");
+  form.append("file", file, filename);
+  return client.requestMultipart("POST", `/v1/document/upload`, form);
+}
+async function uploadFileToFolder(client, file, folderName, options = {}) {
+  const form = new FormData();
+  const filename = options.filename ?? (file instanceof File ? file.name : "upload");
+  form.append("file", file, filename);
+  return client.requestMultipart(
+    "POST",
+    `/v1/document/upload/${encodeURIComponent(folderName)}`,
+    form
+  );
+}
+export {
+  AuthenticationError,
+  DeveloperApiClient,
+  DeveloperApiError,
+  NotFoundError,
+  ServerError,
+  V1AdminModule,
+  V1ApiNamespace,
+  V1AuthModule,
+  V1DocumentModule,
+  V1EmbedModule,
+  V1OpenAIModule,
+  V1SystemModule,
+  V1ThreadModule,
+  V1UsersModule,
+  V1WorkspaceModule,
+  ValidationError,
+  streamThreadChat,
+  streamWorkspaceChat,
+  uploadFile,
+  uploadFileToFolder
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@realtimex/sdk",
-    "version": "1.6.0",
+    "version": "1.7.4",
     "description": "SDK for building Local Apps that integrate with RealtimeX",
     "main": "dist/index.js",
     "module": "dist/index.mjs",
@@ -10,15 +10,23 @@
             "import": "./dist/index.mjs",
             "require": "./dist/index.js",
             "types": "./dist/index.d.ts"
+        },
+        "./v1": {
+            "import": "./dist/v1/index.mjs",
+            "require": "./dist/v1/index.js",
+            "types": "./dist/v1/index.d.ts"
         }
     },
     "scripts": {
-        "build": "node ../scripts/generate-skill.mjs --force && tsup src/index.ts --format cjs,esm --dts --clean",
-        "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
+        "build": "node ../scripts/generate-v1-sdk.mjs --force && node ../scripts/generate-skill.mjs --force && tsup src/index.ts src/v1/index.ts --format cjs,esm --dts --clean",
+        "dev": "tsup src/index.ts src/v1/index.ts --format cjs,esm --dts --watch",
         "test": "vitest run",
         "contract:verify": "node ../scripts/verify-contract-compat.mjs",
         "skill:generate": "node ../scripts/generate-skill.mjs",
         "skill:update": "node ../scripts/generate-skill.mjs --force",
+        "sdk:generate": "node ../scripts/generate-v1-sdk.mjs",
+        "sdk:generate:force": "node ../scripts/generate-v1-sdk.mjs --force",
+        "sdk:diff": "node ../scripts/generate-v1-sdk.mjs --dry-run",
         "prepublishOnly": "npm run build"
     },
     "keywords": [

package/skills/realtimex-moderator-sdk/SKILL.md

@@ -1,13 +1,13 @@
 ---
 name: realtimex-moderator-sdk
 description: Control and interact with the RealTimeX application through its Node.js SDK. This skill should be used when users want to manage workspaces, threads, agents, activities, LLM chat, vector store, MCP tools, ACP agent sessions, TTS/STT, or any other RealTimeX platform feature via the API. All method signatures are verified against the SDK source code.
-generated: 2026-04-03
-sdk_version: 1.6.0
+generated: 2026-04-16
+sdk_version: 1.7.4
 ---
 
 # RealTimeX Moderator (SDK Source-Verified)
 
-Interact with the RealTimeX platform (`http://localhost:3001`) using `@realtimex/sdk` **v1.6.0**. Authentication is automatic when running inside RealtimeX.
+Interact with the RealTimeX platform (`http://localhost:3001`) using `@realtimex/sdk` **v1.7.4**. Authentication is automatic when running inside RealtimeX.
 
 `<SKILL_DIR>` below refers to the directory containing this SKILL.md.
 

package/skills/realtimex-moderator-sdk/references/api-reference.md

@@ -1,6 +1,6 @@
 # RealTimeX SDK — API Reference
 
-> Auto-generated from `@realtimex/sdk` source · v**1.6.0** · 2026-04-03
+> Auto-generated from `@realtimex/sdk` source · v**1.7.4** · 2026-04-16
 
 **Package:** `@realtimex/sdk` (CJS) · **Server:** `http://localhost:3001`
 **Developer Mode auth:** `Authorization: Bearer <apiKey>`
@@ -51,9 +51,10 @@
 - `database: DatabaseModule`
 - `auth: AuthModule`
 - `credentials: CredentialsModule`
+- `v1: V1ApiNamespace | undefined`
 
 ```ts
-// Register app with RealtimeX hub and request declared permissions upfront.
+// Developer API (v1) — requires apiKey to be set in config.
 async register(permissions?: string[]): void
 
 // Get environment variable (works in Node.js and browser)
@@ -662,3 +663,374 @@ async getPort(): Promise<number>
 ```
 
 ---
+
+## sdk.v1.acpAuth — v1 Acp Auth
+
+### `V1AcpAuthModule`
+
+```ts
+// @see GET /v1/acp/auth/profiles
+async listProfiles(): Promise<unknown>
+
+// @see POST /v1/acp/auth/profiles
+async createProfile(): Promise<unknown>
+
+// @see GET /v1/acp/auth/status
+async getStatus(): Promise<unknown>
+
+// @see DELETE /v1/acp/auth/profiles/{id}
+async deleteProfile(id: string): Promise<unknown>
+```
+
+---
+
+## sdk.v1.acpCommands — v1 Acp Commands
+
+### `V1AcpCommandsModule`
+
+```ts
+// @see POST /v1/acp/command
+async createCommand(): Promise<unknown>
+
+// @see POST /v1/acp/command/permission-decision
+async permissionDecision(): Promise<unknown>
+```
+
+---
+
+## sdk.v1.admin — v1 Admin
+
+### `V1AdminModule`
+
+```ts
+// Check to see if the instance is in multi-user-mode first. Methods are disabled until multi user mode is enabled via the UI.
+async getIsMultiUserMode(): Promise<unknown>
+
+// Check to see if the instance is in multi-user-mode first. Methods are disabled until multi user mode is enabled via the UI.
+async listUsers(): Promise<unknown>
+
+// Create a new user with username and password. Methods are disabled until multi user mode is enabled via the UI.
+async createUser(body?: Record<string, unknown>): Promise<unknown>
+
+// Update existing user settings. Methods are disabled until multi user mode is enabled via the UI.
+async updateUser(id: string, body?: Record<string, unknown>): Promise<unknown>
+
+// Delete existing user by id. Methods are disabled until multi user mode is enabled via the UI.
+async deleteUser(id: string): Promise<unknown>
+
+// List all existing invitations to instance regardless of status. Methods are disabled until multi user mode is enabled via the UI.
+async listInvites(): Promise<unknown>
+
+// 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.
+async createInvite(body?: Record<string, unknown>): Promise<unknown>
+
+// Deactivates (soft-delete) invite by id. Methods are disabled until multi user mode is enabled via the UI.
+async deleteInvite(id: string): Promise<unknown>
+
+// Retrieve a list of users with permissions to access the specified workspace.
+async listWorkspaceUsers(workspaceId: string): Promise<unknown>
+
+// 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.
+async updateUsers(workspaceId: string, body?: Record<string, unknown>): Promise<unknown>
+
+// 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.
+async workspacesManageUsers(workspaceSlug: string, body?: Record<string, unknown>): Promise<unknown>
+
+// All chats in the system ordered by most recent. Methods are disabled until multi user mode is enabled via the UI.
+async workspaceChats(body?: Record<string, unknown>): Promise<unknown>
+
+// Update multi-user preferences for instance. Methods are disabled until multi user mode is enabled via the UI.
+async createPreference(body?: Record<string, unknown>): Promise<unknown>
+```
+
+---
+
+## sdk.v1.auth — v1 Auth
+
+### `V1AuthModule`
+
+```ts
+// Verify the attached Authentication header contains a valid API token.
+async getAuth(): Promise<unknown>
+```
+
+---
+
+## sdk.v1.credentials — v1 Credentials
+
+### `V1CredentialsModule`
+
+```ts
+// @see POST /v1/credentials
+async createCredential(): Promise<unknown>
+
+// @see GET /v1/credentials
+async listCredentials(): Promise<unknown>
+
+// @see GET /v1/credentials/{id}
+async getCredential(id: string): Promise<unknown>
+
+// @see PUT /v1/credentials/{id}
+async replaceCredential(id: string): Promise<unknown>
+
+// @see DELETE /v1/credentials/{id}
+async deleteCredential(id: string): Promise<unknown>
+
+// @see POST /v1/credentials/{id}/restore
+async restore(id: string): Promise<unknown>
+```
+
+---
+
+## sdk.v1.customThemes — v1 Custom Themes
+
+### `V1CustomThemesModule`
+
+```ts
+// @see GET /v1/custom-themes
+async listCustomThemes(): Promise<unknown>
+
+// @see GET /v1/custom-themes/{id}
+async getCustomTheme(id: string): Promise<unknown>
+
+// @see POST /v1/custom-themes/{id}
+async updateCustomTheme(id: string): Promise<unknown>
+
+// @see DELETE /v1/custom-themes/{id}
+async deleteCustomTheme(id: string): Promise<unknown>
+
+// @see POST /v1/custom-themes/new
+async createCustomTheme(): Promise<unknown>
+```
+
+---
+
+## sdk.v1.desktopEmbed — v1 Desktop Embed
+
+### `V1DesktopEmbedModule`
+
+```ts
+// @see GET /v1/desktop-public-embed/status
+async getStatus(): Promise<unknown>
+
+// @see POST /v1/desktop-public-embed/exposures
+async createExposure(): Promise<unknown>
+
+// @see POST /v1/desktop-public-embed/exposures/{exposureId}/heartbeat
+async exposuresHeartbeat(exposureId: string): Promise<unknown>
+
+// @see GET /v1/desktop-public-embed/exposures/{exposureId}
+async getExposure(exposureId: string): Promise<unknown>
+
+// @see DELETE /v1/desktop-public-embed/exposures/{exposureId}
+async deleteExposure(exposureId: string): Promise<unknown>
+```
+
+---
+
+## sdk.v1.document — v1 Document
+
+### `V1DocumentModule`
+
+```ts
+// Upload a new file to RealTimeX to be parsed and prepared for embedding.
+async uploadLink(body?: Record<string, unknown>): Promise<unknown>
+
+// Upload a file by specifying its raw text content and metadata values without having to upload a file.
+async rawText(body?: Record<string, unknown>): Promise<unknown>
+
+// List of all locally-stored documents in instance
+async listDocuments(): Promise<unknown>
+
+// Get all documents stored in a specific folder.
+async getFolder(folderName: string): Promise<unknown>
+
+// Check available filetypes and MIMEs that can be uploaded.
+async listAcceptedFileTypes(): Promise<unknown>
+
+// Get the known available metadata schema for when doing a raw-text upload and the acceptable type of value for each key.
+async getMetadataSchema(): Promise<unknown>
+
+// Get a single document by its unique RealTimeX document name
+async getDocument(docName: string): Promise<unknown>
+
+// Create a new folder inside the documents storage directory.
+async createFolder(body?: Record<string, unknown>): Promise<unknown>
+
+// Remove a folder and all its contents from the documents storage directory.
+async deleteRemoveFolder(): Promise<unknown>
+
+// Move files within the documents storage directory.
+async moveFiles(body?: Record<string, unknown>): Promise<unknown>
+```
+
+---
+
+## sdk.v1.embed — v1 Embed
+
+### `V1EmbedModule`
+
+```ts
+// List all active embeds
+async getEmbed(): Promise<unknown>
+
+// Get all chats for a specific embed
+async listChats(embedUuid: string): Promise<unknown>
+
+// Get chats for a specific embed and session
+async getChat(embedUuid: string, sessionUuid: string): Promise<unknown>
+
+// Create a new embed configuration
+async createEmbed(body?: Record<string, unknown>): Promise<unknown>
+
+// Update an existing embed configuration
+async updateEmbed(embedUuid: string, body?: Record<string, unknown>): Promise<unknown>
+
+// Delete an existing embed configuration
+async deleteEmbed(embedUuid: string): Promise<unknown>
+```
+
+---
+
+## sdk.v1.openAI — v1 Open A I
+
+### `V1OpenAIModule`
+
+```ts
+// Get all available "models" which are workspaces you can use for chatting.
+async listModels(): Promise<unknown>
+
+// Execute a chat with a workspace with OpenAI compatibility. Supports streaming as well. Model must be a workspace slug from /models.
+async chatCompletions(body?: Record<string, unknown>): Promise<unknown>
+
+// 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.
+async createEmbedding(body?: Record<string, unknown>): Promise<unknown>
+
+// 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.
+async listVectorStores(): Promise<unknown>
+```
+
+---
+
+## sdk.v1.sttApi — v1 Stt Api
+
+### `V1SttApiModule`
+
+```ts
+// @see POST /v1/stt/groq/transcribe
+async groqTranscribe(body?: Record<string, unknown>): Promise<unknown>
+```
+
+---
+
+## sdk.v1.system — v1 System
+
+### `V1SystemModule`
+
+```ts
+// Dump all settings to file storage
+async getEnvDump(): Promise<unknown>
+
+// Get all current system settings that are defined.
+async getSystem(): Promise<unknown>
+
+// Number of all vectors in connected vector database
+async getVectorCount(): Promise<unknown>
+
+// Update a system setting or preference.
+async updateEnv(body?: Record<string, unknown>): Promise<unknown>
+
+// 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.
+async listExportChats(): Promise<unknown>
+
+// Permanently remove documents from the system.
+async deleteRemoveDocument(): Promise<unknown>
+
+// Returns a health check object with server uptime and version.
+async getHealth(): Promise<unknown>
+
+// Returns a health check object with server uptime and version.
+async getHealthVersion2(): Promise<unknown>
+
+// Returns a health check object with server uptime and version.
+async getHealthVersion3(): Promise<unknown>
+```
+
+---
+
+## sdk.v1.thread — v1 Thread
+
+### `V1ThreadModule`
+
+```ts
+// Create a new workspace thread
+async createThread(slug: string, body?: Record<string, unknown>): Promise<unknown>
+
+// Update thread settings by its unique slug.
+async updateThread(slug: string, threadSlug: string, body?: Record<string, unknown>): Promise<unknown>
+
+// Delete a workspace thread
+async deleteThread(slug: string, threadSlug: string): Promise<unknown>
+
+// Get chats for a workspace thread
+async listChats(slug: string, threadSlug: string): Promise<unknown>
+
+// Chat with a workspace thread
+async chat(slug: string, threadSlug: string, body?: Record<string, unknown>): Promise<unknown>
+
+async streamChat(slug: string, threadSlug: string, body?: Record<string, unknown>): Promise<Response>
+```
+
+---
+
+## sdk.v1.users — v1 Users
+
+### `V1UsersModule`
+
+```ts
+// List all users
+async listUsers(): Promise<unknown>
+
+// Issue a temporary auth token for a user
+async getIssueAuthToken(id: string): Promise<unknown>
+```
+
+---
+
+## sdk.v1.workspace — v1 Workspace
+
+### `V1WorkspaceModule`
+
+```ts
+// Create a new workspace
+async createWorkspace(body?: Record<string, unknown>): Promise<unknown>
+
+// List all current workspaces
+async listWorkspaces(): Promise<unknown>
+
+// Get a workspace by its unique slug.
+async getWorkspace(slug: string): Promise<unknown>
+
+// Deletes a workspace by its slug.
+async deleteWorkspace(slug: string): Promise<unknown>
+
+// Update workspace settings by its unique slug.
+async updateWorkspace(slug: string, body?: Record<string, unknown>): Promise<unknown>
+
+// Get a workspaces chats regardless of user by its unique slug.
+async listChats(slug: string): Promise<unknown>
+
+// Add or remove documents from a workspace by its unique slug.
+async updateEmbeddings(slug: string, body?: Record<string, unknown>): Promise<unknown>
+
+// Add or remove pin from a document in a workspace by its unique slug.
+async updatePin(slug: string, body?: Record<string, unknown>): Promise<unknown>
+
+// Execute a chat with a workspace
+async chat(slug: string, body?: Record<string, unknown>): Promise<unknown>
+
+// Execute a streamable chat with a workspace
+async vectorSearch(slug: string, body?: Record<string, unknown>): Promise<unknown>
+```
+
+---

package/skills/realtimex-moderator-sdk/references/known-issues.md

@@ -1,6 +1,6 @@
 # Known Issues — Source-Detected
 
-> Auto-generated by `scripts/generate-skill.mjs` · SDK **1.6.0** · 2026-04-03
+> Auto-generated by `scripts/generate-skill.mjs` · SDK **1.7.4** · 2026-04-16
 
 Run `node scripts/generate-skill.mjs --force` after SDK source changes to refresh.
 

package/skills/realtimex-moderator-sdk/scripts/lib/sdk-init.js

@@ -8,7 +8,7 @@
  *   2. ~/.realtimex.ai/.sdk-app-id file (written by RealtimeX server)
  *   3. RTX_APP_ID in process.env (injected by RealtimeX for local apps)
  *   4. RTX_API_KEY in process.env (standalone dev)
- *   5. REALTIMEX_API_KEY / REALTIMEX_AI_API_KEY in <envDir>/.env (standalone dev)
+ *   5. RTX_API_KEY in <envDir>/.env (standalone dev)
  *   6. Interactive readline prompt (fallback)
  */