@realtimex/sdk 2.0.19 → 2.0.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/index.d.ts CHANGED
@@ -28,6 +28,43 @@ export interface ApproveChannelPairingCodeOptions extends RealtimeXRequestOption
28
28
  body?: ApproveChannelPairingCodeBody;
29
29
  }
30
30
 
31
+ export type ChatWithTerminalAgentParams = Record<string, never>;
32
+ export type ChatWithTerminalAgentQuery = Record<string, never>;
33
+ export type ChatWithTerminalAgentHeaders = Record<string, never>;
34
+ export type ChatWithTerminalAgentBody = {
35
+ workspaceName?: string;
36
+ threadName?: string;
37
+ agentName?: string;
38
+ agentSearch?: string;
39
+ modelName?: string;
40
+ skipModelSelection?: boolean;
41
+ messageText?: string;
42
+ messageConfirmation?: string;
43
+ workspaceTimeoutMs?: number;
44
+ threadTimeoutMs?: number;
45
+ actionTimeoutMs?: number;
46
+ actionDelayMs?: number;
47
+ recordVideo?: boolean;
48
+ videoPath?: string;
49
+ logProgress?: boolean;
50
+ tour?: boolean;
51
+ tourId?: string;
52
+ tourTts?: string;
53
+ tourLang?: string;
54
+ tourTtsVoice?: string;
55
+ tourSurface?: string;
56
+ tourTtsMaxWaitMs?: number;
57
+ timeoutMs?: number;
58
+ confirmDestructive?: boolean;
59
+ };
60
+ export type ChatWithTerminalAgentResponse = Record<string, unknown>;
61
+ export interface ChatWithTerminalAgentOptions extends RealtimeXRequestOptions {
62
+ params?: ChatWithTerminalAgentParams;
63
+ query?: ChatWithTerminalAgentQuery;
64
+ headers?: ChatWithTerminalAgentHeaders & Record<string, string>;
65
+ body?: ChatWithTerminalAgentBody;
66
+ }
67
+
31
68
  export type ClearWorkspaceDefaultAgentParams = {
32
69
  workspaceSlug: string;
33
70
  };
@@ -110,6 +147,26 @@ export interface CreateWorkspaceOptions extends RealtimeXRequestOptions {
110
147
  body?: CreateWorkspaceBody;
111
148
  }
112
149
 
150
+ export type CreateWorkspaceAgentSkillParams = {
151
+ workspaceSlug: string;
152
+ };
153
+ export type CreateWorkspaceAgentSkillQuery = Record<string, never>;
154
+ export type CreateWorkspaceAgentSkillHeaders = {
155
+ "x-app-id"?: string;
156
+ };
157
+ export type CreateWorkspaceAgentSkillBody = {
158
+ displayName: string;
159
+ name?: string;
160
+ description?: string;
161
+ };
162
+ export type CreateWorkspaceAgentSkillResponse = Record<string, unknown>;
163
+ export interface CreateWorkspaceAgentSkillOptions extends RealtimeXRequestOptions {
164
+ params?: CreateWorkspaceAgentSkillParams;
165
+ query?: CreateWorkspaceAgentSkillQuery;
166
+ headers?: CreateWorkspaceAgentSkillHeaders & Record<string, string>;
167
+ body?: CreateWorkspaceAgentSkillBody;
168
+ }
169
+
113
170
  export type DeleteChannelParams = {
114
171
  channelId: string;
115
172
  };
@@ -530,6 +587,27 @@ export interface PrepareOptions extends RealtimeXRequestOptions {
530
587
  body?: PrepareBody;
531
588
  }
532
589
 
590
+ export type PromoteWorkspaceAgentSkillParams = {
591
+ workspaceSlug: string;
592
+ skillId: string;
593
+ };
594
+ export type PromoteWorkspaceAgentSkillQuery = Record<string, never>;
595
+ export type PromoteWorkspaceAgentSkillHeaders = {
596
+ "x-app-id"?: string;
597
+ };
598
+ export type PromoteWorkspaceAgentSkillBody = {
599
+ displayName?: string;
600
+ name?: string;
601
+ description?: string;
602
+ };
603
+ export type PromoteWorkspaceAgentSkillResponse = Record<string, unknown>;
604
+ export interface PromoteWorkspaceAgentSkillOptions extends RealtimeXRequestOptions {
605
+ params?: PromoteWorkspaceAgentSkillParams;
606
+ query?: PromoteWorkspaceAgentSkillQuery;
607
+ headers?: PromoteWorkspaceAgentSkillHeaders & Record<string, string>;
608
+ body?: PromoteWorkspaceAgentSkillBody;
609
+ }
610
+
533
611
  export type PublishArtifactParams = {
534
612
  workspaceSlug: string;
535
613
  };
@@ -774,6 +852,35 @@ export interface SendMessageOptions extends RealtimeXRequestOptions {
774
852
  body?: SendMessageBody;
775
853
  }
776
854
 
855
+ export type SetDefaultWorkspaceAgentParams = Record<string, never>;
856
+ export type SetDefaultWorkspaceAgentQuery = Record<string, never>;
857
+ export type SetDefaultWorkspaceAgentHeaders = Record<string, never>;
858
+ export type SetDefaultWorkspaceAgentBody = {
859
+ workspaceName?: string;
860
+ agentName?: string;
861
+ modelName?: string;
862
+ skipModelSelection?: boolean;
863
+ actionTimeoutMs?: number;
864
+ actionDelayMs?: number;
865
+ tour?: boolean;
866
+ tourId?: string;
867
+ tourTts?: string;
868
+ tourLang?: string;
869
+ tourTtsVoice?: string;
870
+ tourSurface?: string;
871
+ tourTtsMaxWaitMs?: number;
872
+ logProgress?: boolean;
873
+ timeoutMs?: number;
874
+ confirmDestructive?: boolean;
875
+ };
876
+ export type SetDefaultWorkspaceAgentResponse = Record<string, unknown>;
877
+ export interface SetDefaultWorkspaceAgentOptions extends RealtimeXRequestOptions {
878
+ params?: SetDefaultWorkspaceAgentParams;
879
+ query?: SetDefaultWorkspaceAgentQuery;
880
+ headers?: SetDefaultWorkspaceAgentHeaders & Record<string, string>;
881
+ body?: SetDefaultWorkspaceAgentBody;
882
+ }
883
+
777
884
  export type SetHeartbeatActiveHoursParams = Record<string, never>;
778
885
  export type SetHeartbeatActiveHoursQuery = Record<string, never>;
779
886
  export type SetHeartbeatActiveHoursHeaders = {
@@ -949,9 +1056,11 @@ export type SetupWorkingDirBody = {
949
1056
  actionTimeoutMs?: number;
950
1057
  actionDelayMs?: number;
951
1058
  tour?: boolean;
1059
+ tourId?: string;
952
1060
  tourTts?: string;
953
1061
  tourLang?: string;
954
1062
  tourTtsVoice?: string;
1063
+ tourSurface?: string;
955
1064
  tourTtsMaxWaitMs?: number;
956
1065
  logProgress?: boolean;
957
1066
  timeoutMs?: number;
@@ -1140,6 +1249,9 @@ export declare class RealtimeXClient {
1140
1249
  /** Approve one pending channel pairing code by visible 6-digit code or database id. Works for telegram, discord, and zalo channel pairing requests. */
1141
1250
  approveChannelPairingCode(options?: ApproveChannelPairingCodeOptions): Promise<ApproveChannelPairingCodeResponse>;
1142
1251
  approveChannelPairingCode(code: string, options?: Omit<ApproveChannelPairingCodeOptions, 'params'>): Promise<ApproveChannelPairingCodeResponse>;
1252
+ /** Guide a user through sending a chat message to the terminal agent. */
1253
+ chatWithTerminalAgent(options?: ChatWithTerminalAgentOptions): Promise<ChatWithTerminalAgentResponse>;
1254
+ chatWithTerminalAgent(body: ChatWithTerminalAgentBody, options?: Omit<ChatWithTerminalAgentOptions, 'body'>): Promise<ChatWithTerminalAgentResponse>;
1143
1255
  /** Clear the default CLI agent from a workspace. */
1144
1256
  clearWorkspaceDefaultAgent(options?: ClearWorkspaceDefaultAgentOptions): Promise<ClearWorkspaceDefaultAgentResponse>;
1145
1257
  clearWorkspaceDefaultAgent(workspaceSlug: string, options?: Omit<ClearWorkspaceDefaultAgentOptions, 'params'>): Promise<ClearWorkspaceDefaultAgentResponse>;
@@ -1152,6 +1264,9 @@ export declare class RealtimeXClient {
1152
1264
  /** Create a workspace. Requires a human-readable workspace name. */
1153
1265
  createWorkspace(options?: CreateWorkspaceOptions): Promise<CreateWorkspaceResponse>;
1154
1266
  createWorkspace(body: CreateWorkspaceBody, options?: Omit<CreateWorkspaceOptions, 'body'>): Promise<CreateWorkspaceResponse>;
1267
+ /** Create a managed agent skill owned by one workspace. Terminal agents should use this instead of writing final skill content into runtime skill directories. */
1268
+ createWorkspaceAgentSkill(options?: CreateWorkspaceAgentSkillOptions): Promise<CreateWorkspaceAgentSkillResponse>;
1269
+ createWorkspaceAgentSkill(workspaceSlug: string, body: CreateWorkspaceAgentSkillBody, options?: Omit<CreateWorkspaceAgentSkillOptions, 'params' | 'body'>): Promise<CreateWorkspaceAgentSkillResponse>;
1155
1270
  /** Delete one chat channel by exact channel id. */
1156
1271
  deleteChannel(options?: DeleteChannelOptions): Promise<DeleteChannelResponse>;
1157
1272
  deleteChannel(channelId: string, options?: Omit<DeleteChannelOptions, 'params'>): Promise<DeleteChannelResponse>;
@@ -1218,6 +1333,9 @@ export declare class RealtimeXClient {
1218
1333
  /** Return compact workspace, thread, current workspace/thread from explicit workspaceSlug and threadSlug query parameters, LLM provider, model, and CLI agent context for agents before choosing arguments. Agents should pass --workspace-slug "$RTX_WORKSPACE_SLUG" and --thread-slug "$RTX_THREAD_SLUG" when those environment variables exist. */
1219
1334
  prepare(options?: PrepareOptions): Promise<PrepareResponse>;
1220
1335
  prepare(query?: PrepareQuery, options?: Omit<PrepareOptions, 'query'>): Promise<PrepareResponse>;
1336
+ /** Promote one workspace-owned agent skill to a global managed skill by copying its files into a new global skill row. */
1337
+ promoteWorkspaceAgentSkill(options?: PromoteWorkspaceAgentSkillOptions): Promise<PromoteWorkspaceAgentSkillResponse>;
1338
+ promoteWorkspaceAgentSkill(params: PromoteWorkspaceAgentSkillParams, body: PromoteWorkspaceAgentSkillBody, options?: Omit<PromoteWorkspaceAgentSkillOptions, 'params' | 'body'>): Promise<PromoteWorkspaceAgentSkillResponse>;
1221
1339
  /** Publish a browser-viewable file or folder under a workspace artifacts directory. artifactPath is relative to that workspace artifacts directory. */
1222
1340
  publishArtifact(options?: PublishArtifactOptions): Promise<PublishArtifactResponse>;
1223
1341
  publishArtifact(workspaceSlug: string, body: PublishArtifactBody, options?: Omit<PublishArtifactOptions, 'params' | 'body'>): Promise<PublishArtifactResponse>;
@@ -1257,6 +1375,9 @@ export declare class RealtimeXClient {
1257
1375
  /** Send one message to an exact thread using the same routing as channel replies. Terminal-agent threads are dispatched to the terminal runtime; other threads use the configured LLM chat path. */
1258
1376
  sendMessage(options?: SendMessageOptions): Promise<SendMessageResponse>;
1259
1377
  sendMessage(params: SendMessageParams, body: SendMessageBody, options?: Omit<SendMessageOptions, 'params' | 'body'>): Promise<SendMessageResponse>;
1378
+ /** Set a workspace default agent from the desktop workspace chat settings UI. */
1379
+ setDefaultWorkspaceAgent(options?: SetDefaultWorkspaceAgentOptions): Promise<SetDefaultWorkspaceAgentResponse>;
1380
+ setDefaultWorkspaceAgent(body: SetDefaultWorkspaceAgentBody, options?: Omit<SetDefaultWorkspaceAgentOptions, 'body'>): Promise<SetDefaultWorkspaceAgentResponse>;
1260
1381
  /** Set workspace or global ambient-agent active hours using HH:mm start and end values. */
1261
1382
  setHeartbeatActiveHours(options?: SetHeartbeatActiveHoursOptions): Promise<SetHeartbeatActiveHoursResponse>;
1262
1383
  setHeartbeatActiveHours(body: SetHeartbeatActiveHoursBody, options?: Omit<SetHeartbeatActiveHoursOptions, 'body'>): Promise<SetHeartbeatActiveHoursResponse>;
package/index.js CHANGED
@@ -13,6 +13,14 @@ const operations = {
13
13
  ],
14
14
  "hasBody": false
15
15
  },
16
+ "chatWithTerminalAgent": {
17
+ "method": "POST",
18
+ "path": "/chat-with-terminal-agent",
19
+ "pathParams": [],
20
+ "queryParams": [],
21
+ "headerParams": [],
22
+ "hasBody": true
23
+ },
16
24
  "clearWorkspaceDefaultAgent": {
17
25
  "method": "DELETE",
18
26
  "path": "/clear-workspace-default-agent/{workspaceSlug}",
@@ -61,6 +69,18 @@ const operations = {
61
69
  ],
62
70
  "hasBody": true
63
71
  },
72
+ "createWorkspaceAgentSkill": {
73
+ "method": "POST",
74
+ "path": "/create-workspace-agent-skill/{workspaceSlug}",
75
+ "pathParams": [
76
+ "workspaceSlug"
77
+ ],
78
+ "queryParams": [],
79
+ "headerParams": [
80
+ "x-app-id"
81
+ ],
82
+ "hasBody": true
83
+ },
64
84
  "deleteChannel": {
65
85
  "method": "DELETE",
66
86
  "path": "/delete-channel/{channelId}",
@@ -346,6 +366,19 @@ const operations = {
346
366
  ],
347
367
  "hasBody": false
348
368
  },
369
+ "promoteWorkspaceAgentSkill": {
370
+ "method": "POST",
371
+ "path": "/promote-workspace-agent-skill/{workspaceSlug}/{skillId}",
372
+ "pathParams": [
373
+ "workspaceSlug",
374
+ "skillId"
375
+ ],
376
+ "queryParams": [],
377
+ "headerParams": [
378
+ "x-app-id"
379
+ ],
380
+ "hasBody": true
381
+ },
349
382
  "publishArtifact": {
350
383
  "method": "POST",
351
384
  "path": "/publish-artifact/{workspaceSlug}",
@@ -496,6 +529,14 @@ const operations = {
496
529
  ],
497
530
  "hasBody": true
498
531
  },
532
+ "setDefaultWorkspaceAgent": {
533
+ "method": "POST",
534
+ "path": "/set-default-workspace-agent",
535
+ "pathParams": [],
536
+ "queryParams": [],
537
+ "headerParams": [],
538
+ "hasBody": true
539
+ },
499
540
  "setHeartbeatActiveHours": {
500
541
  "method": "POST",
501
542
  "path": "/set-heartbeat-active-hours",
@@ -888,6 +929,13 @@ class RealtimeXClient {
888
929
  );
889
930
  }
890
931
 
932
+ chatWithTerminalAgent(...args) {
933
+ return this.request(
934
+ "chatWithTerminalAgent",
935
+ normalizeOperationOptions(operations["chatWithTerminalAgent"], args)
936
+ );
937
+ }
938
+
891
939
  clearWorkspaceDefaultAgent(...args) {
892
940
  return this.request(
893
941
  "clearWorkspaceDefaultAgent",
@@ -916,6 +964,13 @@ class RealtimeXClient {
916
964
  );
917
965
  }
918
966
 
967
+ createWorkspaceAgentSkill(...args) {
968
+ return this.request(
969
+ "createWorkspaceAgentSkill",
970
+ normalizeOperationOptions(operations["createWorkspaceAgentSkill"], args)
971
+ );
972
+ }
973
+
919
974
  deleteChannel(...args) {
920
975
  return this.request(
921
976
  "deleteChannel",
@@ -1084,6 +1139,13 @@ class RealtimeXClient {
1084
1139
  );
1085
1140
  }
1086
1141
 
1142
+ promoteWorkspaceAgentSkill(...args) {
1143
+ return this.request(
1144
+ "promoteWorkspaceAgentSkill",
1145
+ normalizeOperationOptions(operations["promoteWorkspaceAgentSkill"], args)
1146
+ );
1147
+ }
1148
+
1087
1149
  publishArtifact(...args) {
1088
1150
  return this.request(
1089
1151
  "publishArtifact",
@@ -1175,6 +1237,13 @@ class RealtimeXClient {
1175
1237
  );
1176
1238
  }
1177
1239
 
1240
+ setDefaultWorkspaceAgent(...args) {
1241
+ return this.request(
1242
+ "setDefaultWorkspaceAgent",
1243
+ normalizeOperationOptions(operations["setDefaultWorkspaceAgent"], args)
1244
+ );
1245
+ }
1246
+
1178
1247
  setHeartbeatActiveHours(...args) {
1179
1248
  return this.request(
1180
1249
  "setHeartbeatActiveHours",
@@ -1305,5 +1374,5 @@ module.exports = {
1305
1374
  createClient: createRealtimeXClient,
1306
1375
  createRealtimeXClient,
1307
1376
  operations,
1308
- version: "2.0.19",
1377
+ version: "2.0.21",
1309
1378
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@realtimex/sdk",
3
- "version": "2.0.19",
3
+ "version": "2.0.21",
4
4
  "description": "RealtimeX runtime SDK package and moderator agent skill assets.",
5
5
  "private": false,
6
6
  "main": "./index.js",
@@ -20,15 +20,15 @@ This skill drives the `realtimex-pp-cli` binary. Verify the CLI is installed and
20
20
 
21
21
  1. Install or reinstall the pinned version via npm:
22
22
  ```bash
23
- npm install -g @realtimex/pp-cli@2.0.19
23
+ npm install -g @realtimex/pp-cli@2.0.21
24
24
  ```
25
25
  2. Verify the exact version:
26
26
  ```bash
27
27
  realtimex-pp-cli --version
28
28
  ```
29
- The output must be `realtimex-pp-cli 2.0.19`.
29
+ The output must be `realtimex-pp-cli 2.0.21`.
30
30
 
31
- If `--version` reports "command not found" after install, the npm global bin directory is not on `$PATH`. If it reports any version other than `2.0.19`, reinstall with the pinned npm command above. Do not proceed with skill commands until exact-version verification succeeds.
31
+ If `--version` reports "command not found" after install, the npm global bin directory is not on `$PATH`. If it reports any version other than `2.0.21`, reinstall with the pinned npm command above. Do not proceed with skill commands until exact-version verification succeeds.
32
32
 
33
33
  * Always run first:
34
34
 
@@ -42,6 +42,10 @@ If `--version` reports "command not found" after install, the npm global bin dir
42
42
 
43
43
  - `realtimex-pp-cli approve-channel-pairing-code <code>` — Approve one pending channel pairing code by visible 6-digit code or database id.
44
44
 
45
+ **chat-with-terminal-agent** — Manage chat with terminal agent
46
+
47
+ - `realtimex-pp-cli chat-with-terminal-agent` — Guide a user through sending a chat message to the terminal agent.
48
+
45
49
  **clear-workspace-default-agent** — Manage clear workspace default agent
46
50
 
47
51
  - `realtimex-pp-cli clear-workspace-default-agent <workspaceSlug>` — Clear the default CLI agent from a workspace.
@@ -58,6 +62,10 @@ If `--version` reports "command not found" after install, the npm global bin dir
58
62
 
59
63
  - `realtimex-pp-cli create-workspace` — Create a workspace. Requires a human-readable workspace name.
60
64
 
65
+ **create-workspace-agent-skill** — Manage create workspace agent skill
66
+
67
+ - `realtimex-pp-cli create-workspace-agent-skill <workspaceSlug>` — Create a managed agent skill owned by one workspace.
68
+
61
69
  **delete-channel** — Manage delete channel
62
70
 
63
71
  - `realtimex-pp-cli delete-channel <channelId>` — Delete one chat channel by exact channel id.
@@ -154,6 +162,10 @@ If `--version` reports "command not found" after install, the npm global bin dir
154
162
 
155
163
  - `realtimex-pp-cli prepare` — Return compact workspace, thread, current workspace/thread from explicit workspaceSlug and threadSlug query parameters
156
164
 
165
+ **promote-workspace-agent-skill** — Manage promote workspace agent skill
166
+
167
+ - `realtimex-pp-cli promote-workspace-agent-skill <workspaceSlug> <skillId>` — Promote one workspace-owned agent skill to a global managed skill by copying its files into a new global skill row.
168
+
157
169
  **publish-artifact** — Manage publish artifact
158
170
 
159
171
  - `realtimex-pp-cli publish-artifact <workspaceSlug>` — Publish a browser-viewable file or folder under a workspace artifacts directory.
@@ -202,6 +214,10 @@ If `--version` reports "command not found" after install, the npm global bin dir
202
214
 
203
215
  - `realtimex-pp-cli send-message <workspaceSlug> <threadSlug>` — Send one message to an exact thread using the same routing as channel replies.
204
216
 
217
+ **set-default-workspace-agent** — Manage set default workspace agent
218
+
219
+ - `realtimex-pp-cli set-default-workspace-agent` — Set a workspace default agent from the desktop workspace chat settings UI.
220
+
205
221
  **set-heartbeat-active-hours** — Manage set heartbeat active hours
206
222
 
207
223
  - `realtimex-pp-cli set-heartbeat-active-hours` — Set workspace or global ambient-agent active hours using HH:mm start and end values.
@@ -396,9 +412,9 @@ Verify: `claude mcp list`
396
412
  ```bash
397
413
  realtimex-pp-cli --version
398
414
  ```
399
- If the command is missing or the output is not exactly `realtimex-pp-cli 2.0.19`, reinstall the pinned version:
415
+ If the command is missing or the output is not exactly `realtimex-pp-cli 2.0.21`, reinstall the pinned version:
400
416
  ```bash
401
- npm install -g @realtimex/pp-cli@2.0.19
417
+ npm install -g @realtimex/pp-cli@2.0.21
402
418
  ```
403
419
  Then run `realtimex-pp-cli --version` again and proceed only after exact-version verification succeeds.
404
420
  2. Match the user query to the best command from the Unique Capabilities and Command Reference above.