@celljs/ta-protocol 4.15.0 → 4.15.1

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.
@@ -13,6 +13,8 @@ export declare const TA_SERVER_SERVICE = "TaServer";
13
13
  export declare const TA_CLIENT_SERVICE = "TaClient";
14
14
  /** The file `ta serve` writes in the agent directory, readable only by its user. */
15
15
  export declare const TA_SERVE_FILE = "serve.json";
16
+ /** What a `ta serve` started by an app (Ta Desktop) exits with when asked to restart (TaServer.restartServer): the app restarts. */
17
+ export declare const TA_SERVE_RESTART_EXIT_CODE = 75;
16
18
  /** The contents of {@link TA_SERVE_FILE}: how to reach the running `ta serve`. */
17
19
  export interface TaServeInfo {
18
20
  url: string;
@@ -26,8 +28,17 @@ export interface TaServeInfo {
26
28
  export declare const TA_RESUME_MESSAGE = "ta-resume";
27
29
  /** What a client needs to know of the server before it opens a session. */
28
30
  export interface TaServerInfo {
29
- /** The version of ta. */
31
+ /** The version of ta that runs. */
30
32
  version: string;
33
+ /** The commit of a build of the development channel (Ta Desktop's ta-build.json); none for a release. */
34
+ build?: string;
35
+ /**
36
+ * Another build of Ta was installed over the one that runs (an update, a reinstall, a build of the repository):
37
+ * it runs once ta serve restarts (restartServer). None from a ta serve of before.
38
+ */
39
+ update?: TaServerUpdate;
40
+ /** It can restart itself (restartServer): a ta serve of before, or one not started as `ta serve`, cannot. */
41
+ restartable?: boolean;
31
42
  /**
32
43
  * Where a client opens a session when the user names no directory: the one set with
33
44
  * `setWorkingDirectory`, else the working directory of `ta serve`, or of its execution environment.
@@ -42,6 +53,12 @@ export interface TaServerInfo {
42
53
  /** The page is of one the user let in (docs/design/ta-team.md), not the user: who, and as what. */
43
54
  member?: TaMemberInfo;
44
55
  }
56
+ /** The build of Ta installed now, which a restart of ta serve runs (TaServerInfo.update). */
57
+ export interface TaServerUpdate {
58
+ version: string;
59
+ /** As TaServerInfo.build. */
60
+ build?: string;
61
+ }
45
62
  /** The stable `code` of each failure of a {@link TaServer} call. */
46
63
  export declare const TaErrorCode: {
47
64
  readonly SESSION_NOT_FOUND: 'CELL_TA_SESSION_NOT_FOUND';
@@ -469,6 +486,12 @@ export interface TaServer {
469
486
  * restarts: where conversations open when the user names no directory. Sessions already open stay where they are.
470
487
  */
471
488
  setWorkingDirectory(cwd: string): Promise<TaServerInfo>;
489
+ /**
490
+ * Stops ta serve and starts it again, from the files installed now (TaServerInfo.update): what runs pauses and
491
+ * goes on after the start. It answers first; connections then close and connect again. The owner's alone; fails
492
+ * with INVALID_ARGUMENT where it cannot restart (TaServerInfo.restartable).
493
+ */
494
+ restartServer(): Promise<void>;
472
495
  openSession(options: TaOpenSessionOptions): Promise<TaOpenedSession>;
473
496
  closeSession(sessionId: string): Promise<void>;
474
497
  listSessions(): Promise<TaSessionInfo[]>;
@@ -6,6 +6,8 @@ export const TA_SERVER_SERVICE = 'TaServer';
6
6
  export const TA_CLIENT_SERVICE = 'TaClient';
7
7
  /** The file `ta serve` writes in the agent directory, readable only by its user. */
8
8
  export const TA_SERVE_FILE = 'serve.json';
9
+ /** What a `ta serve` started by an app (Ta Desktop) exits with when asked to restart (TaServer.restartServer): the app restarts. */
10
+ export const TA_SERVE_RESTART_EXIT_CODE = 75;
9
11
  /**
10
12
  * The type of the custom message `ta serve` adds to a conversation whose run a restart of it cut off, when it opens
11
13
  * the conversation again and has it carry on (TaSessionResume of ta-host); the web client shows it as a mark.
@@ -13,6 +13,8 @@ export declare const TA_SERVER_SERVICE = "TaServer";
13
13
  export declare const TA_CLIENT_SERVICE = "TaClient";
14
14
  /** The file `ta serve` writes in the agent directory, readable only by its user. */
15
15
  export declare const TA_SERVE_FILE = "serve.json";
16
+ /** What a `ta serve` started by an app (Ta Desktop) exits with when asked to restart (TaServer.restartServer): the app restarts. */
17
+ export declare const TA_SERVE_RESTART_EXIT_CODE = 75;
16
18
  /** The contents of {@link TA_SERVE_FILE}: how to reach the running `ta serve`. */
17
19
  export interface TaServeInfo {
18
20
  url: string;
@@ -26,8 +28,17 @@ export interface TaServeInfo {
26
28
  export declare const TA_RESUME_MESSAGE = "ta-resume";
27
29
  /** What a client needs to know of the server before it opens a session. */
28
30
  export interface TaServerInfo {
29
- /** The version of ta. */
31
+ /** The version of ta that runs. */
30
32
  version: string;
33
+ /** The commit of a build of the development channel (Ta Desktop's ta-build.json); none for a release. */
34
+ build?: string;
35
+ /**
36
+ * Another build of Ta was installed over the one that runs (an update, a reinstall, a build of the repository):
37
+ * it runs once ta serve restarts (restartServer). None from a ta serve of before.
38
+ */
39
+ update?: TaServerUpdate;
40
+ /** It can restart itself (restartServer): a ta serve of before, or one not started as `ta serve`, cannot. */
41
+ restartable?: boolean;
31
42
  /**
32
43
  * Where a client opens a session when the user names no directory: the one set with
33
44
  * `setWorkingDirectory`, else the working directory of `ta serve`, or of its execution environment.
@@ -42,6 +53,12 @@ export interface TaServerInfo {
42
53
  /** The page is of one the user let in (docs/design/ta-team.md), not the user: who, and as what. */
43
54
  member?: TaMemberInfo;
44
55
  }
56
+ /** The build of Ta installed now, which a restart of ta serve runs (TaServerInfo.update). */
57
+ export interface TaServerUpdate {
58
+ version: string;
59
+ /** As TaServerInfo.build. */
60
+ build?: string;
61
+ }
45
62
  /** The stable `code` of each failure of a {@link TaServer} call. */
46
63
  export declare const TaErrorCode: {
47
64
  readonly SESSION_NOT_FOUND: 'CELL_TA_SESSION_NOT_FOUND';
@@ -469,6 +486,12 @@ export interface TaServer {
469
486
  * restarts: where conversations open when the user names no directory. Sessions already open stay where they are.
470
487
  */
471
488
  setWorkingDirectory(cwd: string): Promise<TaServerInfo>;
489
+ /**
490
+ * Stops ta serve and starts it again, from the files installed now (TaServerInfo.update): what runs pauses and
491
+ * goes on after the start. It answers first; connections then close and connect again. The owner's alone; fails
492
+ * with INVALID_ARGUMENT where it cannot restart (TaServerInfo.restartable).
493
+ */
494
+ restartServer(): Promise<void>;
472
495
  openSession(options: TaOpenSessionOptions): Promise<TaOpenedSession>;
473
496
  closeSession(sessionId: string): Promise<void>;
474
497
  listSessions(): Promise<TaSessionInfo[]>;
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.TaSkillUse = exports.TaAgentSummary = exports.TaImageSize = exports.TaImageNote = exports.TaMessageSource = exports.TaMessageContext = exports.TaSlashCommandUtil = exports.TA_RPC_ERROR_CODE = exports.TaErrorUtil = exports.TaErrorCode = exports.TA_RESUME_MESSAGE = exports.TA_SERVE_FILE = exports.TA_CLIENT_SERVICE = exports.TA_SERVER_SERVICE = exports.TA_WEBSOCKET_PATH = exports.TaClient = exports.TaServer = void 0;
3
+ exports.TaSkillUse = exports.TaAgentSummary = exports.TaImageSize = exports.TaImageNote = exports.TaMessageSource = exports.TaMessageContext = exports.TaSlashCommandUtil = exports.TA_RPC_ERROR_CODE = exports.TaErrorUtil = exports.TaErrorCode = exports.TA_RESUME_MESSAGE = exports.TA_SERVE_RESTART_EXIT_CODE = exports.TA_SERVE_FILE = exports.TA_CLIENT_SERVICE = exports.TA_SERVER_SERVICE = exports.TA_WEBSOCKET_PATH = exports.TaClient = exports.TaServer = void 0;
4
4
  exports.TaServer = Symbol('TaServer');
5
5
  exports.TaClient = Symbol('TaClient');
6
6
  /** Path of the WebSocket endpoint of `ta serve`, and the JSON-RPC method prefixes of both sides. */
@@ -9,6 +9,8 @@ exports.TA_SERVER_SERVICE = 'TaServer';
9
9
  exports.TA_CLIENT_SERVICE = 'TaClient';
10
10
  /** The file `ta serve` writes in the agent directory, readable only by its user. */
11
11
  exports.TA_SERVE_FILE = 'serve.json';
12
+ /** What a `ta serve` started by an app (Ta Desktop) exits with when asked to restart (TaServer.restartServer): the app restarts. */
13
+ exports.TA_SERVE_RESTART_EXIT_CODE = 75;
12
14
  /**
13
15
  * The type of the custom message `ta serve` adds to a conversation whose run a restart of it cut off, when it opens
14
16
  * the conversation again and has it carry on (TaSessionResume of ta-host); the web client shows it as a mark.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@celljs/ta-protocol",
3
- "version": "4.15.0",
3
+ "version": "4.15.1",
4
4
  "description": "The protocol between ta serve and its clients",
5
5
  "homepage": "https://github.com/cellbang/ta",
6
6
  "bugs": {