@realtimex/sdk 1.7.19 → 1.7.21
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.
- package/dist/{chunk-PEWBG7US.mjs → chunk-Z5GAUBIM.mjs} +170 -0
- package/dist/{errors-DsxB91BA.d.mts → errors-NufsyIZ-.d.mts} +122 -1
- package/dist/{errors-DsxB91BA.d.ts → errors-NufsyIZ-.d.ts} +122 -1
- package/dist/index.d.mts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +169 -0
- package/dist/index.mjs +1 -1
- package/dist/v1/index.d.mts +2 -2
- package/dist/v1/index.d.ts +2 -2
- package/dist/v1/index.js +171 -0
- package/dist/v1/index.mjs +3 -1
- package/package.json +1 -1
- package/skills/realtimex-moderator-sdk/SKILL.md +2 -2
- package/skills/realtimex-moderator-sdk/references/activities.md +1 -1
- package/skills/realtimex-moderator-sdk/references/agents.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/acpagent.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/activities.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/agent.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/api.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/auth.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/contract.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/core.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/database.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/index.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/llm.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/mcp.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/port.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/stt.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/task.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/tts.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/v1-acpauth.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/v1-acpcommands.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/v1-admin.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/v1-auth.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/v1-channels.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/v1-credentials.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/v1-customthemes.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/v1-desktopbrowser.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/v1-desktopembed.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/v1-desktopruntimesessions.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/v1-document.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/v1-embed.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/v1-openai.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/v1-sttapi.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/v1-system.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/v1-thread.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/v1-users.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/v1-workspace.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference/webhook.md +1 -1
- package/skills/realtimex-moderator-sdk/references/api-reference.md +1 -1
- package/skills/realtimex-moderator-sdk/references/browser.md +1 -1
- package/skills/realtimex-moderator-sdk/references/channels.md +1 -1
- package/skills/realtimex-moderator-sdk/references/known-issues.md +1 -1
- package/skills/realtimex-moderator-sdk/references/llm.md +1 -1
- package/skills/realtimex-moderator-sdk/references/mcp.md +1 -1
- package/skills/realtimex-moderator-sdk/references/permissions.md +1 -1
- package/skills/realtimex-moderator-sdk/references/quickstart.md +1 -1
- package/skills/realtimex-moderator-sdk/references/terminal-sessions.md +1 -1
- package/skills/realtimex-moderator-sdk/references/workspaces.md +1 -1
package/dist/v1/index.d.mts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { D as DeveloperApiClient } from '../errors-
|
|
2
|
-
export { A as AuthenticationError, c as DeveloperApiError, N as NotFoundError, S as ServerError, f as V1AdminModule, V as V1ApiNamespace, e as V1AuthModule, b as V1DesktopBrowserModule, a as V1DesktopRuntimeSessionsModule, g as V1DocumentModule, m as V1EmbedModule, l as V1OpenAIModule, i as V1SystemModule, j as V1ThreadModule, k as V1UsersModule, h as V1WorkspaceModule, d as ValidationError } from '../errors-
|
|
1
|
+
import { D as DeveloperApiClient } from '../errors-NufsyIZ-.mjs';
|
|
2
|
+
export { A as AuthenticationError, c as DeveloperApiError, N as NotFoundError, S as ServerError, f as V1AdminModule, V as V1ApiNamespace, e as V1AuthModule, n as V1ChannelsModule, b as V1DesktopBrowserModule, a as V1DesktopRuntimeSessionsModule, g as V1DocumentModule, m as V1EmbedModule, l as V1OpenAIModule, i as V1SystemModule, j as V1ThreadModule, k as V1UsersModule, h as V1WorkspaceModule, d as ValidationError } from '../errors-NufsyIZ-.mjs';
|
|
3
3
|
|
|
4
4
|
interface WorkspaceStreamChunk {
|
|
5
5
|
/** The text fragment emitted by this SSE event */
|
package/dist/v1/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { D as DeveloperApiClient } from '../errors-
|
|
2
|
-
export { A as AuthenticationError, c as DeveloperApiError, N as NotFoundError, S as ServerError, f as V1AdminModule, V as V1ApiNamespace, e as V1AuthModule, b as V1DesktopBrowserModule, a as V1DesktopRuntimeSessionsModule, g as V1DocumentModule, m as V1EmbedModule, l as V1OpenAIModule, i as V1SystemModule, j as V1ThreadModule, k as V1UsersModule, h as V1WorkspaceModule, d as ValidationError } from '../errors-
|
|
1
|
+
import { D as DeveloperApiClient } from '../errors-NufsyIZ-.js';
|
|
2
|
+
export { A as AuthenticationError, c as DeveloperApiError, N as NotFoundError, S as ServerError, f as V1AdminModule, V as V1ApiNamespace, e as V1AuthModule, n as V1ChannelsModule, b as V1DesktopBrowserModule, a as V1DesktopRuntimeSessionsModule, g as V1DocumentModule, m as V1EmbedModule, l as V1OpenAIModule, i as V1SystemModule, j as V1ThreadModule, k as V1UsersModule, h as V1WorkspaceModule, d as ValidationError } from '../errors-NufsyIZ-.js';
|
|
3
3
|
|
|
4
4
|
interface WorkspaceStreamChunk {
|
|
5
5
|
/** The text fragment emitted by this SSE event */
|
package/dist/v1/index.js
CHANGED
|
@@ -28,6 +28,7 @@ __export(v1_exports, {
|
|
|
28
28
|
V1AdminModule: () => V1AdminModule,
|
|
29
29
|
V1ApiNamespace: () => V1ApiNamespace,
|
|
30
30
|
V1AuthModule: () => V1AuthModule,
|
|
31
|
+
V1ChannelsModule: () => V1ChannelsModule,
|
|
31
32
|
V1DesktopBrowserModule: () => V1DesktopBrowserModule,
|
|
32
33
|
V1DesktopRuntimeSessionsModule: () => V1DesktopRuntimeSessionsModule,
|
|
33
34
|
V1DocumentModule: () => V1DocumentModule,
|
|
@@ -689,6 +690,174 @@ var V1EmbedModule = class {
|
|
|
689
690
|
}
|
|
690
691
|
};
|
|
691
692
|
|
|
693
|
+
// src/v1/modules/v1Channels.ts
|
|
694
|
+
var V1ChannelsModule = class {
|
|
695
|
+
constructor(client) {
|
|
696
|
+
this.client = client;
|
|
697
|
+
}
|
|
698
|
+
/**
|
|
699
|
+
* List configured channel plugins without exposing encrypted plugin configuration.
|
|
700
|
+
* @see GET /v1/channels/plugins
|
|
701
|
+
*/
|
|
702
|
+
async listPlugins() {
|
|
703
|
+
return this.client.request("GET", `/v1/channels/plugins`);
|
|
704
|
+
}
|
|
705
|
+
/**
|
|
706
|
+
* Create a channel plugin. The request may include provider credentials in config, but credentials are never returned.
|
|
707
|
+
* @see POST /v1/channels/plugins
|
|
708
|
+
*/
|
|
709
|
+
async createPlugin(body) {
|
|
710
|
+
return this.client.request("POST", `/v1/channels/plugins`, body);
|
|
711
|
+
}
|
|
712
|
+
/**
|
|
713
|
+
* Get editable non-secret channel plugin configuration.
|
|
714
|
+
* @see GET /v1/channels/plugins/{id}/config
|
|
715
|
+
*/
|
|
716
|
+
async getConfig(id) {
|
|
717
|
+
return this.client.request("GET", `/v1/channels/plugins/${id}/config`);
|
|
718
|
+
}
|
|
719
|
+
/**
|
|
720
|
+
* Update a channel plugin. Config values are encrypted before storage.
|
|
721
|
+
* @see POST /v1/channels/plugins/{id}/update
|
|
722
|
+
*/
|
|
723
|
+
async updatePlugin(id, body) {
|
|
724
|
+
return this.client.request("POST", `/v1/channels/plugins/${id}/update`, body);
|
|
725
|
+
}
|
|
726
|
+
/**
|
|
727
|
+
* Delete a channel plugin and stop any running plugin instance.
|
|
728
|
+
* @see DELETE /v1/channels/plugins/{id}
|
|
729
|
+
*/
|
|
730
|
+
async deletePlugin(id) {
|
|
731
|
+
return this.client.request("DELETE", `/v1/channels/plugins/${id}`);
|
|
732
|
+
}
|
|
733
|
+
/**
|
|
734
|
+
* Enable and start a channel plugin.
|
|
735
|
+
* @see POST /v1/channels/plugins/{id}/start
|
|
736
|
+
*/
|
|
737
|
+
async pluginsStart(id) {
|
|
738
|
+
return this.client.request("POST", `/v1/channels/plugins/${id}/start`);
|
|
739
|
+
}
|
|
740
|
+
/**
|
|
741
|
+
* Disable and stop a channel plugin.
|
|
742
|
+
* @see POST /v1/channels/plugins/{id}/stop
|
|
743
|
+
*/
|
|
744
|
+
async pluginsStop(id) {
|
|
745
|
+
return this.client.request("POST", `/v1/channels/plugins/${id}/stop`);
|
|
746
|
+
}
|
|
747
|
+
/**
|
|
748
|
+
* Test channel provider credentials without saving a plugin.
|
|
749
|
+
* @see POST /v1/channels/plugins/test
|
|
750
|
+
*/
|
|
751
|
+
async pluginsTest(body) {
|
|
752
|
+
return this.client.request("POST", `/v1/channels/plugins/test`, body);
|
|
753
|
+
}
|
|
754
|
+
/**
|
|
755
|
+
* Get runtime status for all running channel plugins.
|
|
756
|
+
* @see GET /v1/channels/status
|
|
757
|
+
*/
|
|
758
|
+
async getStatus() {
|
|
759
|
+
return this.client.request("GET", `/v1/channels/status`);
|
|
760
|
+
}
|
|
761
|
+
/**
|
|
762
|
+
* Start a QR login flow for Zalo personal or WhatsApp plugins.
|
|
763
|
+
* @see POST /v1/channels/plugins/{id}/qr-login/start
|
|
764
|
+
*/
|
|
765
|
+
async pluginsQrLoginStart(id, body) {
|
|
766
|
+
return this.client.request("POST", `/v1/channels/plugins/${id}/qr-login/start`, body);
|
|
767
|
+
}
|
|
768
|
+
/**
|
|
769
|
+
* Poll QR login status for Zalo personal or WhatsApp plugins.
|
|
770
|
+
* @see GET /v1/channels/plugins/{id}/qr-login/state
|
|
771
|
+
*/
|
|
772
|
+
async getState(id) {
|
|
773
|
+
return this.client.request("GET", `/v1/channels/plugins/${id}/qr-login/state`);
|
|
774
|
+
}
|
|
775
|
+
/**
|
|
776
|
+
* Cancel a QR login flow for Zalo personal or WhatsApp plugins.
|
|
777
|
+
* @see POST /v1/channels/plugins/{id}/qr-login/cancel
|
|
778
|
+
*/
|
|
779
|
+
async pluginsQrLoginCancel(id) {
|
|
780
|
+
return this.client.request("POST", `/v1/channels/plugins/${id}/qr-login/cancel`);
|
|
781
|
+
}
|
|
782
|
+
/**
|
|
783
|
+
* Log out a QR-authenticated Zalo personal or WhatsApp plugin and clear stored credentials.
|
|
784
|
+
* @see POST /v1/channels/plugins/{id}/logout
|
|
785
|
+
*/
|
|
786
|
+
async pluginsLogout(id) {
|
|
787
|
+
return this.client.request("POST", `/v1/channels/plugins/${id}/logout`);
|
|
788
|
+
}
|
|
789
|
+
/**
|
|
790
|
+
* Update safe channel policies for Zalo personal or WhatsApp plugins without overwriting credentials.
|
|
791
|
+
* @see POST /v1/channels/plugins/{id}/policies
|
|
792
|
+
*/
|
|
793
|
+
async pluginsPolicies(id, body) {
|
|
794
|
+
return this.client.request("POST", `/v1/channels/plugins/${id}/policies`, body);
|
|
795
|
+
}
|
|
796
|
+
/**
|
|
797
|
+
* Search a Zalo personal friends directory.
|
|
798
|
+
* @see GET /v1/channels/plugins/{id}/directory/friends
|
|
799
|
+
*/
|
|
800
|
+
async listDirectoryFriends(id) {
|
|
801
|
+
return this.client.request("GET", `/v1/channels/plugins/${id}/directory/friends`);
|
|
802
|
+
}
|
|
803
|
+
/**
|
|
804
|
+
* Search a Zalo personal groups directory.
|
|
805
|
+
* @see GET /v1/channels/plugins/{id}/directory/groups
|
|
806
|
+
*/
|
|
807
|
+
async listDirectoryGroups(id) {
|
|
808
|
+
return this.client.request("GET", `/v1/channels/plugins/${id}/directory/groups`);
|
|
809
|
+
}
|
|
810
|
+
/**
|
|
811
|
+
* List pending pairing codes for a channel plugin.
|
|
812
|
+
* @see GET /v1/channels/plugins/{id}/pairing-codes
|
|
813
|
+
*/
|
|
814
|
+
async listPluginPairingCodes(id) {
|
|
815
|
+
return this.client.request("GET", `/v1/channels/plugins/${id}/pairing-codes`);
|
|
816
|
+
}
|
|
817
|
+
/**
|
|
818
|
+
* Generate a pairing code for a channel plugin.
|
|
819
|
+
* @see POST /v1/channels/plugins/{id}/pairing-codes
|
|
820
|
+
*/
|
|
821
|
+
async pluginsPairingCodes(id, body) {
|
|
822
|
+
return this.client.request("POST", `/v1/channels/plugins/${id}/pairing-codes`, body);
|
|
823
|
+
}
|
|
824
|
+
/**
|
|
825
|
+
* Approve a channel pairing code.
|
|
826
|
+
* @see POST /v1/channels/pairing-codes/{id}/approve
|
|
827
|
+
*/
|
|
828
|
+
async pairingCodesApprove(id) {
|
|
829
|
+
return this.client.request("POST", `/v1/channels/pairing-codes/${id}/approve`);
|
|
830
|
+
}
|
|
831
|
+
/**
|
|
832
|
+
* Reject a channel pairing code.
|
|
833
|
+
* @see POST /v1/channels/pairing-codes/{id}/reject
|
|
834
|
+
*/
|
|
835
|
+
async pairingCodesReject(id) {
|
|
836
|
+
return this.client.request("POST", `/v1/channels/pairing-codes/${id}/reject`);
|
|
837
|
+
}
|
|
838
|
+
/**
|
|
839
|
+
* List channel users for a plugin.
|
|
840
|
+
* @see GET /v1/channels/plugins/{id}/users
|
|
841
|
+
*/
|
|
842
|
+
async listPluginUsers(id) {
|
|
843
|
+
return this.client.request("GET", `/v1/channels/plugins/${id}/users`);
|
|
844
|
+
}
|
|
845
|
+
/**
|
|
846
|
+
* Set authorization for a channel user.
|
|
847
|
+
* @see POST /v1/channels/plugins/{id}/users/{userId}/authorization
|
|
848
|
+
*/
|
|
849
|
+
async pluginsUsersAuthorization(id, userId, body) {
|
|
850
|
+
return this.client.request("POST", `/v1/channels/plugins/${id}/users/${userId}/authorization`, body);
|
|
851
|
+
}
|
|
852
|
+
/**
|
|
853
|
+
* Remove a channel user from a plugin.
|
|
854
|
+
* @see DELETE /v1/channels/plugins/{id}/users/{userId}
|
|
855
|
+
*/
|
|
856
|
+
async deleteUser(id, userId) {
|
|
857
|
+
return this.client.request("DELETE", `/v1/channels/plugins/${id}/users/${userId}`);
|
|
858
|
+
}
|
|
859
|
+
};
|
|
860
|
+
|
|
692
861
|
// src/v1/modules/v1DesktopRuntimeSessions.ts
|
|
693
862
|
var V1DesktopRuntimeSessionsModule = class {
|
|
694
863
|
constructor(client) {
|
|
@@ -843,6 +1012,7 @@ var V1ApiNamespace = class {
|
|
|
843
1012
|
this.users = new V1UsersModule(this._client);
|
|
844
1013
|
this.openai = new V1OpenAIModule(this._client);
|
|
845
1014
|
this.embed = new V1EmbedModule(this._client);
|
|
1015
|
+
this.channels = new V1ChannelsModule(this._client);
|
|
846
1016
|
this.desktopRuntimeSessions = new V1DesktopRuntimeSessionsModule(this._client);
|
|
847
1017
|
this.desktopBrowser = new V1DesktopBrowserModule(this._client);
|
|
848
1018
|
}
|
|
@@ -971,6 +1141,7 @@ async function uploadFileToFolder(client, file, folderName, options = {}) {
|
|
|
971
1141
|
V1AdminModule,
|
|
972
1142
|
V1ApiNamespace,
|
|
973
1143
|
V1AuthModule,
|
|
1144
|
+
V1ChannelsModule,
|
|
974
1145
|
V1DesktopBrowserModule,
|
|
975
1146
|
V1DesktopRuntimeSessionsModule,
|
|
976
1147
|
V1DocumentModule,
|
package/dist/v1/index.mjs
CHANGED
|
@@ -7,6 +7,7 @@ import {
|
|
|
7
7
|
V1AdminModule,
|
|
8
8
|
V1ApiNamespace,
|
|
9
9
|
V1AuthModule,
|
|
10
|
+
V1ChannelsModule,
|
|
10
11
|
V1DesktopBrowserModule,
|
|
11
12
|
V1DesktopRuntimeSessionsModule,
|
|
12
13
|
V1DocumentModule,
|
|
@@ -17,7 +18,7 @@ import {
|
|
|
17
18
|
V1UsersModule,
|
|
18
19
|
V1WorkspaceModule,
|
|
19
20
|
ValidationError
|
|
20
|
-
} from "../chunk-
|
|
21
|
+
} from "../chunk-Z5GAUBIM.mjs";
|
|
21
22
|
|
|
22
23
|
// src/v1/overrides/v1WorkspaceStreaming.ts
|
|
23
24
|
async function* streamWorkspaceChat(client, slug, body) {
|
|
@@ -141,6 +142,7 @@ export {
|
|
|
141
142
|
V1AdminModule,
|
|
142
143
|
V1ApiNamespace,
|
|
143
144
|
V1AuthModule,
|
|
145
|
+
V1ChannelsModule,
|
|
144
146
|
V1DesktopBrowserModule,
|
|
145
147
|
V1DesktopRuntimeSessionsModule,
|
|
146
148
|
V1DocumentModule,
|
package/package.json
CHANGED
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
name: realtimex-moderator-sdk
|
|
3
3
|
description: Control and interact with the RealTimeX application through its Node.js SDK. Use for workspaces, threads, agents, activities, LLM chat, vector store, MCP tools, ACP sessions, desktop terminal/browser sessions, chat channels, TTS/STT, and other RealTimeX platform APIs. Load detailed version-matched instructions with `rtx.js skills get <topic>`.
|
|
4
4
|
generated: 2026-05-18
|
|
5
|
-
sdk_version: 1.7.
|
|
5
|
+
sdk_version: 1.7.21
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# RealTimeX Moderator SDK
|
|
9
9
|
|
|
10
|
-
SDK-backed control of the local RealTimeX platform (`http://localhost:3001`) using `@realtimex/sdk` **v1.7.
|
|
10
|
+
SDK-backed control of the local RealTimeX platform (`http://localhost:3001`) using `@realtimex/sdk` **v1.7.21**.
|
|
11
11
|
|
|
12
12
|
This file is the discovery stub. Load workflow content from the bundled CLI so instructions match the installed SDK version.
|
|
13
13
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# API Reference Index
|
|
2
2
|
|
|
3
|
-
> Auto-generated from `@realtimex/sdk` source · v**1.7.
|
|
3
|
+
> Auto-generated from `@realtimex/sdk` source · v**1.7.21** · 2026-05-18
|
|
4
4
|
|
|
5
5
|
Use these files for exact SDK signatures. Topic guides in `references/*.md` explain workflows.
|
|
6
6
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# RealTimeX SDK — API Reference
|
|
2
2
|
|
|
3
|
-
> Auto-generated from `@realtimex/sdk` source · v**1.7.
|
|
3
|
+
> Auto-generated from `@realtimex/sdk` source · v**1.7.21** · 2026-05-18
|
|
4
4
|
|
|
5
5
|
**Package:** `@realtimex/sdk` (CJS) · **Server:** `http://localhost:3001`
|
|
6
6
|
**Developer Mode auth:** `Authorization: Bearer <apiKey>`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Known Issues — Source-Detected
|
|
2
2
|
|
|
3
|
-
> Auto-generated by `scripts/generate-skill.mjs` · SDK **1.7.
|
|
3
|
+
> Auto-generated by `scripts/generate-skill.mjs` · SDK **1.7.21** · 2026-05-18
|
|
4
4
|
|
|
5
5
|
Run `node scripts/generate-skill.mjs --force` after SDK source changes to refresh.
|
|
6
6
|
|