@realtimex/sdk 1.7.16 → 1.7.19

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/package.json +1 -1
  2. package/skills/realtimex-moderator-sdk/SKILL.md +49 -493
  3. package/skills/realtimex-moderator-sdk/references/activities.md +14 -0
  4. package/skills/realtimex-moderator-sdk/references/agents.md +13 -0
  5. package/skills/realtimex-moderator-sdk/references/api-reference/acpagent.md +105 -0
  6. package/skills/realtimex-moderator-sdk/references/api-reference/activities.md +24 -0
  7. package/skills/realtimex-moderator-sdk/references/api-reference/agent.md +27 -0
  8. package/skills/realtimex-moderator-sdk/references/api-reference/api.md +17 -0
  9. package/skills/realtimex-moderator-sdk/references/api-reference/auth.md +36 -0
  10. package/skills/realtimex-moderator-sdk/references/api-reference/contract.md +27 -0
  11. package/skills/realtimex-moderator-sdk/references/api-reference/core.md +40 -0
  12. package/skills/realtimex-moderator-sdk/references/api-reference/database.md +24 -0
  13. package/skills/realtimex-moderator-sdk/references/api-reference/index.md +43 -0
  14. package/skills/realtimex-moderator-sdk/references/api-reference/llm.md +176 -0
  15. package/skills/realtimex-moderator-sdk/references/api-reference/mcp.md +50 -0
  16. package/skills/realtimex-moderator-sdk/references/api-reference/port.md +21 -0
  17. package/skills/realtimex-moderator-sdk/references/api-reference/stt.md +15 -0
  18. package/skills/realtimex-moderator-sdk/references/api-reference/task.md +62 -0
  19. package/skills/realtimex-moderator-sdk/references/api-reference/tts.md +18 -0
  20. package/skills/realtimex-moderator-sdk/references/api-reference/v1-acpauth.md +21 -0
  21. package/skills/realtimex-moderator-sdk/references/api-reference/v1-acpcommands.md +15 -0
  22. package/skills/realtimex-moderator-sdk/references/api-reference/v1-admin.md +48 -0
  23. package/skills/realtimex-moderator-sdk/references/api-reference/v1-auth.md +18 -0
  24. package/skills/realtimex-moderator-sdk/references/api-reference/v1-channels.md +78 -0
  25. package/skills/realtimex-moderator-sdk/references/api-reference/v1-credentials.md +27 -0
  26. package/skills/realtimex-moderator-sdk/references/api-reference/v1-customthemes.md +24 -0
  27. package/skills/realtimex-moderator-sdk/references/api-reference/v1-desktopbrowser.md +39 -0
  28. package/skills/realtimex-moderator-sdk/references/api-reference/v1-desktopembed.md +24 -0
  29. package/skills/realtimex-moderator-sdk/references/api-reference/v1-desktopruntimesessions.md +33 -0
  30. package/skills/realtimex-moderator-sdk/references/api-reference/v1-document.md +39 -0
  31. package/skills/realtimex-moderator-sdk/references/api-reference/v1-embed.md +27 -0
  32. package/skills/realtimex-moderator-sdk/references/api-reference/v1-openai.md +21 -0
  33. package/skills/realtimex-moderator-sdk/references/api-reference/v1-sttapi.md +12 -0
  34. package/skills/realtimex-moderator-sdk/references/api-reference/v1-system.md +36 -0
  35. package/skills/realtimex-moderator-sdk/references/api-reference/v1-thread.md +26 -0
  36. package/skills/realtimex-moderator-sdk/references/api-reference/v1-users.md +15 -0
  37. package/skills/realtimex-moderator-sdk/references/api-reference/v1-workspace.md +39 -0
  38. package/skills/realtimex-moderator-sdk/references/api-reference/webhook.md +13 -0
  39. package/skills/realtimex-moderator-sdk/references/api-reference.md +78 -1
  40. package/skills/realtimex-moderator-sdk/references/app-concepts.md +148 -0
  41. package/skills/realtimex-moderator-sdk/references/browser.md +27 -0
  42. package/skills/realtimex-moderator-sdk/references/channels.md +189 -0
  43. package/skills/realtimex-moderator-sdk/references/known-issues.md +1 -1
  44. package/skills/realtimex-moderator-sdk/references/llm.md +13 -0
  45. package/skills/realtimex-moderator-sdk/references/mcp.md +13 -0
  46. package/skills/realtimex-moderator-sdk/references/permissions.md +30 -0
  47. package/skills/realtimex-moderator-sdk/references/quickstart.md +16 -0
  48. package/skills/realtimex-moderator-sdk/references/terminal-sessions.md +34 -0
  49. package/skills/realtimex-moderator-sdk/references/workspaces.md +20 -0
  50. package/skills/realtimex-moderator-sdk/scripts/rtx.js +122 -2
@@ -14,6 +14,7 @@
14
14
  */
15
15
 
16
16
  const path = require('path');
17
+ const fs = require('fs');
17
18
  const { initSDK } = require('./lib/sdk-init');
18
19
 
19
20
  // ---------------------------------------------------------------------------
@@ -68,6 +69,84 @@ function resolveWorkspaceFlagOrContext(context = {}) {
68
69
  return flags.workspace || context?.workspaceSlug || null;
69
70
  }
70
71
 
72
+ const SKILL_ROOT = path.resolve(__dirname, '..');
73
+ const REFERENCES_DIR = path.join(SKILL_ROOT, 'references');
74
+
75
+ const SKILL_DOCS = {
76
+ core: ['quickstart.md', 'permissions.md', 'workspaces.md'],
77
+ quickstart: ['quickstart.md'],
78
+ permissions: ['permissions.md'],
79
+ workspaces: ['workspaces.md'],
80
+ workspace: ['workspaces.md'],
81
+ threads: ['workspaces.md'],
82
+ agents: ['agents.md'],
83
+ agent: ['agents.md'],
84
+ terminal: ['terminal-sessions.md'],
85
+ terminals: ['terminal-sessions.md'],
86
+ 'terminal-sessions': ['terminal-sessions.md'],
87
+ browser: ['browser.md'],
88
+ channels: ['channels.md'],
89
+ channel: ['channels.md'],
90
+ llm: ['llm.md'],
91
+ vectors: ['llm.md'],
92
+ 'vector-store': ['llm.md'],
93
+ mcp: ['mcp.md'],
94
+ activities: ['activities.md'],
95
+ activity: ['activities.md'],
96
+ credentials: ['credentials.md'],
97
+ issues: ['known-issues.md'],
98
+ 'known-issues': ['known-issues.md'],
99
+ concepts: ['app-concepts.md'],
100
+ api: ['api-reference/index.md'],
101
+ };
102
+
103
+ function readReferenceFile(relPath) {
104
+ const fullPath = path.resolve(REFERENCES_DIR, relPath);
105
+ if (!fullPath.startsWith(REFERENCES_DIR + path.sep)) {
106
+ throw new Error('Invalid skill reference path');
107
+ }
108
+ return fs.readFileSync(fullPath, 'utf-8');
109
+ }
110
+
111
+ function listApiReferenceSlugs() {
112
+ const apiDir = path.join(REFERENCES_DIR, 'api-reference');
113
+ if (!fs.existsSync(apiDir)) return [];
114
+ return fs.readdirSync(apiDir)
115
+ .filter((file) => file.endsWith('.md') && file !== 'index.md')
116
+ .map((file) => `api:${file.replace(/\.md$/, '')}`)
117
+ .sort();
118
+ }
119
+
120
+ function resolveSkillDoc(topic) {
121
+ const normalized = String(topic || 'core').trim().toLowerCase();
122
+ if (normalized.startsWith('api:')) {
123
+ const slug = normalized.slice(4);
124
+ if (!slug) return ['api-reference/index.md'];
125
+ return [`api-reference/${slug}.md`];
126
+ }
127
+ return SKILL_DOCS[normalized] || null;
128
+ }
129
+
130
+ function printSkillDoc(topic, { full = false } = {}) {
131
+ const refs = resolveSkillDoc(topic);
132
+ if (!refs) {
133
+ console.error(`Unknown skill topic: ${topic}`);
134
+ console.error('Run: node rtx.js skills list');
135
+ process.exit(1);
136
+ }
137
+
138
+ const chunks = [];
139
+ for (const rel of refs) {
140
+ chunks.push(readReferenceFile(rel).trimEnd());
141
+ }
142
+
143
+ if (full && topic !== 'api' && !String(topic || '').startsWith('api:')) {
144
+ chunks.push(readReferenceFile('api-reference/index.md').trimEnd());
145
+ }
146
+
147
+ console.log(chunks.join('\n\n---\n\n'));
148
+ }
149
+
71
150
  // ---------------------------------------------------------------------------
72
151
  // Commands
73
152
  // ---------------------------------------------------------------------------
@@ -82,6 +161,36 @@ CMD.context = async () => {
82
161
  });
83
162
  };
84
163
 
164
+ CMD.skills = async () => {
165
+ const [subcommand, topic] = cmdArgs;
166
+ if (!subcommand || subcommand === 'list') {
167
+ console.log('Available skill topics:');
168
+ for (const key of Object.keys(SKILL_DOCS).sort()) {
169
+ console.log(` ${key}`);
170
+ }
171
+ const apiTopics = listApiReferenceSlugs();
172
+ if (apiTopics.length) {
173
+ console.log('');
174
+ console.log('Available API reference topics:');
175
+ for (const key of apiTopics) {
176
+ console.log(` ${key}`);
177
+ }
178
+ }
179
+ console.log('');
180
+ console.log('Usage: node rtx.js skills get <topic> [--full]');
181
+ return;
182
+ }
183
+
184
+ if (subcommand === 'get') {
185
+ printSkillDoc(topic || 'core', { full: flags.full === true || flags.full === 'true' });
186
+ return;
187
+ }
188
+
189
+ console.error('Usage: node rtx.js skills list');
190
+ console.error(' or: node rtx.js skills get <topic> [--full]');
191
+ process.exit(1);
192
+ };
193
+
85
194
  // -- ping -------------------------------------------------------------------
86
195
  // Source: index.ts → sdk.ping() → { success, mode, appId, timestamp }
87
196
  CMD.ping = async () => { const { sdk } = await getSDK(); print(await sdk.ping()); };
@@ -1036,6 +1145,18 @@ Global flags:
1036
1145
  Connection:
1037
1146
  ping / info
1038
1147
 
1148
+ Skill docs:
1149
+ skills list
1150
+ List version-matched workflow/API skill topics bundled with this SDK.
1151
+
1152
+ skills get <topic> [--full]
1153
+ Print a focused skill guide from the installed SDK version.
1154
+ Examples:
1155
+ skills get core
1156
+ skills get channels
1157
+ skills get browser
1158
+ skills get api:v1-channels --full
1159
+
1039
1160
  sdk.api.*:
1040
1161
  agents / workspaces / threads <slug> / task <uuid>
1041
1162
  context
@@ -1147,8 +1268,7 @@ sdk.desktopBrowser.* — RealTimeX Browser sessions and tabs:
1147
1268
  Close a managed browser tab.
1148
1269
 
1149
1270
  Workflow note:
1150
- Prefer one session per target URL. If you need another URL, create a new browser
1151
- session first, then use that session's remoteDebugPort with the agent-browser skill
1271
+ Each session has seperated browser profile, use session's remoteDebugPort with the agent-browser skill
1152
1272
  over CDP for page interaction and automation.
1153
1273
 
1154
1274
  Compatibility: