@realtimex/sdk 1.5.0 → 1.5.1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@realtimex/sdk",
-    "version": "1.5.0",
+    "version": "1.5.1",
     "description": "SDK for building Local Apps that integrate with RealtimeX",
     "main": "dist/index.js",
     "module": "dist/index.mjs",

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

@@ -1,30 +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-03-31
-sdk_version: 1.5.0
+generated: 2026-04-02
+sdk_version: 1.5.1
 ---
 
 # RealTimeX Moderator (SDK Source-Verified)
 
-Interact with the RealTimeX desktop app (`http://localhost:3001`) using `@realtimex/sdk` **v1.5.0** in Developer Mode (API Key).
-
-> Auto-generated from the `@realtimex/sdk` TypeScript source.
-> Refresh: `node scripts/generate-skill.mjs --force` from the SDK repo root.
-
----
-
-## Authentication
-
-When running inside RealtimeX (via an agent session or on the same machine), authentication is **automatic** — no setup needed.
-
-Handled by `scripts/lib/sdk-init.js` — credential resolution priority:
-1. Explicit override passed to `initSDK({ apiKey })` or `initSDK({ appId })`
-2. `REALTIMEX_API_KEY` / `REALTIMEX_AI_API_KEY` in `<cwd>/.env`
-3. `RTX_API_KEY` / `REALTIMEX_API_KEY` / `REALTIMEX_AI_API_KEY` from `process.env`
-4. `RTX_APP_ID` from `process.env` (injected by RealtimeX for agents / local apps)
-5. `~/.realtimex.ai/.sdk-app-id` file (written by RealTimeX server on startup)
-6. Interactive readline prompt (dev fallback)
+Interact with the RealTimeX platform (`http://localhost:3001`) using `@realtimex/sdk` **v1.5.1**. Authentication is automatic when running inside RealtimeX.
 
 `<SKILL_DIR>` below refers to the directory containing this SKILL.md.
 
@@ -52,7 +35,7 @@ node "$SKILL" help
 
 ```js
 const { initSDK } = require('<SKILL_DIR>/scripts/lib/sdk-init');
-const { sdk, apiKey } = await initSDK({ envDir: process.cwd() });
+const { sdk } = await initSDK();
 // All SDK APIs — see references/api-reference.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.5.0** · 2026-03-31
+> Auto-generated from `@realtimex/sdk` source · v**1.5.1** · 2026-04-02
 
 **Package:** `@realtimex/sdk` (CJS) · **Server:** `http://localhost:3001`
 **Developer Mode auth:** `Authorization: Bearer <apiKey>`

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.5.0** · 2026-03-31
+> Auto-generated by `scripts/generate-skill.mjs` · SDK **1.5.1** · 2026-04-02
 
 Run `node scripts/generate-skill.mjs --force` after SDK source changes to refresh.
 

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

@@ -1,17 +1,15 @@
 'use strict';
 /**
- * sdk-init.js — SDK initializer with automatic credential resolution
+ * sdk-init.js — SDK initializer
  * AUTO-GENERATED by scripts/generate-skill.mjs — do not edit by hand.
  *
- * Source reference: typescript/src/index.ts (RealtimeXSDK constructor)
- *
- * Credential resolution priority:
+ * Credential resolution:
  *   1. Explicit override passed to initSDK({ apiKey } or { appId })
- *   2. REALTIMEX_API_KEY / REALTIMEX_AI_API_KEY in <envDir>/.env
- *   3. RTX_API_KEY / REALTIMEX_API_KEY / REALTIMEX_AI_API_KEY in process.env
- *   4. RTX_APP_ID in process.env (injected by RealtimeX for agents / local apps)
- *   5. ~/.realtimex.ai/.sdk-app-id file (written by RealtimeX server on startup)
- *   6. Interactive readline prompt (dev fallback)
+ *   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)
+ *   6. Interactive readline prompt (fallback)
  */
 
 const path = require('path');
@@ -27,7 +25,7 @@ const ALL_PERMISSIONS = [
   'tts.generate', 'mcp.servers', 'mcp.tools', 'acp.agent',
 ];
 
-/** Well-known file written by RealtimeX server for seamless SDK auth. */
+/** Well-known file written by RealtimeX server for seamless auth. */
 const SDK_APP_ID_FILE = path.join(os.homedir(), '.realtimex.ai', '.sdk-app-id');
 
 function parseEnvFile(filePath) {
@@ -46,28 +44,16 @@ function parseEnvFile(filePath) {
 }
 
 /**
- * Resolve credentials using the full priority chain.
- * Returns { apiKey, appId } — exactly one will be set.
+ * Resolve credentials. The well-known app ID file is checked first so
+ * agents running inside RealtimeX authenticate without hitting stale
+ * or inherited env vars.
  */
 async function resolveCredentials({ envDir, apiKey, appId } = {}) {
   // 1. Explicit overrides
   if (apiKey) return { apiKey, appId: null };
   if (appId) return { apiKey: null, appId };
 
-  // 2. .env file
-  const envVars = parseEnvFile(path.join(envDir || process.cwd(), '.env'));
-  const fromFile = envVars.REALTIMEX_API_KEY || envVars.REALTIMEX_AI_API_KEY;
-  if (fromFile) return { apiKey: fromFile, appId: null };
-
-  // 3. Process env — API key
-  const fromEnv = process.env.RTX_API_KEY || process.env.REALTIMEX_API_KEY || process.env.REALTIMEX_AI_API_KEY;
-  if (fromEnv) return { apiKey: fromEnv, appId: null };
-
-  // 4. Process env — App ID (injected by RealtimeX for agents / local apps)
-  const envAppId = process.env.RTX_APP_ID;
-  if (envAppId) return { apiKey: null, appId: envAppId };
-
-  // 5. Well-known file (written by RealtimeX server on startup)
+  // 2. Well-known file (written by RealtimeX server — highest auto priority)
   try {
     if (fs.existsSync(SDK_APP_ID_FILE)) {
       const fileAppId = fs.readFileSync(SDK_APP_ID_FILE, 'utf-8').trim();
@@ -75,7 +61,19 @@ async function resolveCredentials({ envDir, apiKey, appId } = {}) {
     }
   } catch { /* ignore read errors */ }
 
-  // 6. Interactive prompt (dev fallback)
+  // 3. RTX_APP_ID from process.env (injected by Electron for local apps)
+  const envAppId = process.env.RTX_APP_ID;
+  if (envAppId) return { apiKey: null, appId: envAppId };
+
+  // 4. RTX_API_KEY from process.env (standalone dev — explicit, no collision risk)
+  if (process.env.RTX_API_KEY) return { apiKey: process.env.RTX_API_KEY, appId: null };
+
+  // 5. .env file (standalone dev)
+  const envVars = parseEnvFile(path.join(envDir || process.cwd(), '.env'));
+  const fromFile = envVars.RTX_API_KEY || envVars.REALTIMEX_API_KEY || envVars.REALTIMEX_AI_API_KEY;
+  if (fromFile) return { apiKey: fromFile, appId: null };
+
+  // 6. Interactive prompt (fallback)
   const rl = readline.createInterface({ input: process.stdin, output: process.stderr });
   const answer = await new Promise((resolve) => {
     rl.question('RealTimeX API key not found. Enter your API key: ', (ans) => {
@@ -88,19 +86,13 @@ async function resolveCredentials({ envDir, apiKey, appId } = {}) {
   return { apiKey: null, appId: null };
 }
 
-/** @deprecated Use resolveCredentials() instead */
-async function resolveApiKey(opts = {}) {
-  const { apiKey } = await resolveCredentials(opts);
-  return apiKey;
-}
-
 async function initSDK(opts = {}) {
   const { RealtimeXSDK } = require('@realtimex/sdk');
   const { apiKey, appId } = await resolveCredentials(opts);
 
   if (!apiKey && !appId) {
     throw new Error(
-      'No credentials found. Set REALTIMEX_API_KEY in .env, or run inside RealtimeX for automatic auth.'
+      'No credentials found. Run inside RealtimeX for automatic auth, or set RTX_API_KEY.'
     );
   }
 
@@ -116,4 +108,4 @@ async function initSDK(opts = {}) {
   return { sdk, apiKey: apiKey || null, appId: appId || null };
 }
 
-module.exports = { initSDK, resolveCredentials, resolveApiKey, parseEnvFile, ALL_PERMISSIONS, SDK_APP_ID_FILE };
+module.exports = { initSDK, resolveCredentials, parseEnvFile, ALL_PERMISSIONS, SDK_APP_ID_FILE };