@atcx/contract 7.7.3 → 7.8.0

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/README.md CHANGED
@@ -3,12 +3,12 @@
3
3
 
4
4
  <p>
5
5
  <a href="https://www.npmjs.com/package/@atcx/contract"><img src="https://img.shields.io/npm/v/@atcx/contract" alt="npm version"></a>
6
- <a href="https://github.com/zgeoff/atc/blob/%40zgeoff%2Fatc%407.7.3/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue" alt="MIT license"></a>
6
+ <a href="https://github.com/zgeoff/atc/blob/%40zgeoff%2Fatc%407.8.0/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue" alt="MIT license"></a>
7
7
  </p>
8
8
 
9
9
  <p>
10
- <a href="https://github.com/zgeoff/atc/blob/%40zgeoff%2Fatc%407.7.3/docs/architecture/protocol/contract.md">The published contract</a> •
11
- <a href="https://github.com/zgeoff/atc/blob/%40zgeoff%2Fatc%407.7.3/docs/architecture/protocol/protocol.md">The client protocol</a>
10
+ <a href="https://github.com/zgeoff/atc/blob/%40zgeoff%2Fatc%407.8.0/docs/architecture/protocol/contract.md">The published contract</a> •
11
+ <a href="https://github.com/zgeoff/atc/blob/%40zgeoff%2Fatc%407.8.0/docs/architecture/protocol/protocol.md">The client protocol</a>
12
12
  </p>
13
13
  </div>
14
14
 
@@ -54,9 +54,9 @@ bun add -d @opentelemetry/api
54
54
  ## Configuration
55
55
 
56
56
  `CONFIG_FILE_SCHEMA` parses the top-level keys of atc's `config.json`, and the
57
- [configuration guide](https://github.com/zgeoff/atc/blob/%40zgeoff%2Fatc%407.7.3/docs/guides/configuration.md) describes each key.
57
+ [configuration guide](https://github.com/zgeoff/atc/blob/%40zgeoff%2Fatc%407.8.0/docs/guides/configuration.md) describes each key.
58
58
 
59
59
  ## Documentation
60
60
 
61
- [The published contract](https://github.com/zgeoff/atc/blob/%40zgeoff%2Fatc%407.7.3/docs/architecture/protocol/contract.md) covers what the package holds
61
+ [The published contract](https://github.com/zgeoff/atc/blob/%40zgeoff%2Fatc%407.8.0/docs/architecture/protocol/contract.md) covers what the package holds
62
62
  and how its version moves with atc's.
@@ -579,6 +579,17 @@ export declare const DAEMON_CONTRACT: {
579
579
  }, z.core.$strip>, z.ZodObject<{
580
580
  forgotten: z.ZodLiteral<true>;
581
581
  destroyed: z.ZodBoolean;
582
+ workspace: z.ZodDiscriminatedUnion<[z.ZodObject<{
583
+ outcome: z.ZodLiteral<"removed">;
584
+ path: z.ZodString;
585
+ found: z.ZodReadonly<z.ZodArray<z.ZodString>>;
586
+ }, z.core.$strip>, z.ZodObject<{
587
+ outcome: z.ZodLiteral<"kept">;
588
+ path: z.ZodString;
589
+ reasons: z.ZodReadonly<z.ZodArray<z.ZodString>>;
590
+ }, z.core.$strip>, z.ZodObject<{
591
+ outcome: z.ZodLiteral<"none">;
592
+ }, z.core.$strip>], "outcome">;
582
593
  }, z.core.$strip>]>, import("@orpc/contract").MergedErrorMap<Record<never, never>, import("./daemon-error-map.js").DaemonErrorMap>, Readonly<{
583
594
  access: "owner" | "principal";
584
595
  readOnly: boolean;
@@ -1,2 +1,2 @@
1
- export declare const DAEMON_FEATURES: readonly ['events.read.from-start', 'daemon.hello.viewer'];
1
+ export declare const DAEMON_FEATURES: readonly ['events.read.from-start', 'daemon.hello.viewer', 'session.forget.workspace'];
2
2
  export type DaemonFeature = (typeof DAEMON_FEATURES)[number];
package/dist/index.d.ts CHANGED
@@ -48,3 +48,4 @@ export * from './to-daemon-id.js';
48
48
  export * from './to-message-id.js';
49
49
  export * from './to-session-id.js';
50
50
  export * from './transcript-row.js';
51
+ export * from './workspace-cleanup.js';
package/dist/index.js CHANGED
@@ -110,10 +110,14 @@ var ANSWER_VIEW_SCHEMA = z4.object({
110
110
  complete: z4.boolean()
111
111
  });
112
112
  // packages/contract/src/contract-version.ts
113
- var CONTRACT_VERSION = "7.7.3";
113
+ var CONTRACT_VERSION = "7.8.0";
114
114
 
115
115
  // packages/contract/src/daemon-features.ts
116
- var DAEMON_FEATURES = ["events.read.from-start", "daemon.hello.viewer"];
116
+ var DAEMON_FEATURES = [
117
+ "events.read.from-start",
118
+ "daemon.hello.viewer",
119
+ "session.forget.workspace"
120
+ ];
117
121
 
118
122
  // packages/contract/src/check-daemon.ts
119
123
  function checkDaemon(hello, contractVersion = CONTRACT_VERSION) {
@@ -176,7 +180,7 @@ var CONFIG_FILE_SCHEMA = z7.object({
176
180
  });
177
181
  // packages/contract/src/daemon-contract.ts
178
182
  import { eventIterator, oc } from "@orpc/contract";
179
- import { z as z37 } from "zod";
183
+ import { z as z38 } from "zod";
180
184
 
181
185
  // packages/contract/src/daemon-error-map.ts
182
186
  import { z as z8 } from "zod";
@@ -926,12 +930,25 @@ var TRANSCRIPT_ROW_SCHEMA = z36.object({
926
930
  at: z36.number().nullable()
927
931
  });
928
932
 
929
- // packages/contract/src/daemon-contract.ts
930
- var EMPTY = z37.object({});
933
+ // packages/contract/src/workspace-cleanup.ts
934
+ import { z as z37 } from "zod";
931
935
  var STRINGS = z37.array(z37.string()).readonly();
932
- var FORGET_CONFIRM = z37.object({ confirmToken: z37.string(), expiresAt: z37.number() });
933
- var FORGET_DONE = z37.object({ forgotten: z37.literal(true), destroyed: z37.boolean() });
934
- var PENDING_PROMPT = z37.object({ message: z37.string() });
936
+ var WORKSPACE_CLEANUP_SCHEMA = z37.discriminatedUnion("outcome", [
937
+ z37.object({ outcome: z37.literal("removed"), path: z37.string(), found: STRINGS }),
938
+ z37.object({ outcome: z37.literal("kept"), path: z37.string(), reasons: STRINGS }),
939
+ z37.object({ outcome: z37.literal("none") })
940
+ ]);
941
+
942
+ // packages/contract/src/daemon-contract.ts
943
+ var EMPTY = z38.object({});
944
+ var STRINGS2 = z38.array(z38.string()).readonly();
945
+ var FORGET_CONFIRM = z38.object({ confirmToken: z38.string(), expiresAt: z38.number() });
946
+ var FORGET_DONE = z38.object({
947
+ forgotten: z38.literal(true),
948
+ destroyed: z38.boolean(),
949
+ workspace: WORKSPACE_CLEANUP_SCHEMA
950
+ });
951
+ var PENDING_PROMPT = z38.object({ message: z38.string() });
935
952
  var ACT = { access: "principal", readOnly: false, keyed: false };
936
953
  var READ = { access: "principal", readOnly: true, keyed: false };
937
954
  var KEYED = { access: "principal", readOnly: false, keyed: true };
@@ -944,72 +961,72 @@ var DAEMON_CONTRACT = {
944
961
  ping: base.meta(READ).input(PARAMS["daemon.ping"]).output(EMPTY),
945
962
  quit: base.meta(OWNER).input(PARAMS["daemon.quit"]).output(EMPTY),
946
963
  restarted: base.meta(OWNER).input(PARAMS["daemon.restarted"]).output(EMPTY),
947
- backup: base.meta(OWNER).input(PARAMS["daemon.backup"]).output(z37.object({ path: z37.string(), bytes: z37.number() }))
964
+ backup: base.meta(OWNER).input(PARAMS["daemon.backup"]).output(z38.object({ path: z38.string(), bytes: z38.number() }))
948
965
  },
949
966
  dirs: {
950
- list: base.meta(READ).input(PARAMS["dirs.list"]).output(z37.object({ dirs: STRINGS }))
967
+ list: base.meta(READ).input(PARAMS["dirs.list"]).output(z38.object({ dirs: STRINGS2 }))
951
968
  },
952
969
  agents: {
953
970
  list: base.meta(READ).input(PARAMS["agents.list"]).output(AGENT_LIST_SCHEMA)
954
971
  },
955
972
  sources: {
956
- list: base.meta(READ).input(PARAMS["sources.list"]).output(z37.object({
957
- source: z37.string(),
958
- scope: z37.string().nullable(),
959
- candidates: z37.array(SOURCE_CANDIDATE_SCHEMA).readonly()
973
+ list: base.meta(READ).input(PARAMS["sources.list"]).output(z38.object({
974
+ source: z38.string(),
975
+ scope: z38.string().nullable(),
976
+ candidates: z38.array(SOURCE_CANDIDATE_SCHEMA).readonly()
960
977
  })),
961
978
  interpret: base.meta(READ).input(PARAMS["sources.interpret"]).output(SOURCE_INTERPRETATION_SCHEMA),
962
- complete: base.meta(READ).input(PARAMS["sources.complete"]).output(z37.object({ completions: z37.array(SOURCE_CANDIDATE_SCHEMA).readonly() }))
979
+ complete: base.meta(READ).input(PARAMS["sources.complete"]).output(z38.object({ completions: z38.array(SOURCE_CANDIDATE_SCHEMA).readonly() }))
963
980
  },
964
981
  git: {
965
982
  probe: base.meta(READ).input(PARAMS["git.probe"]).output(GIT_PROBE_RESULT_SCHEMA)
966
983
  },
967
984
  fleet: {
968
- list: base.meta(READ).input(PARAMS["fleet.list"]).output(z37.object({ fleet: z37.array(FLEET_ENTRY_VIEW_SCHEMA).readonly() })),
969
- restore: base.meta(OWNER).input(PARAMS["fleet.restore"]).output(z37.object({ restored: z37.number() }))
985
+ list: base.meta(READ).input(PARAMS["fleet.list"]).output(z38.object({ fleet: z38.array(FLEET_ENTRY_VIEW_SCHEMA).readonly() })),
986
+ restore: base.meta(OWNER).input(PARAMS["fleet.restore"]).output(z38.object({ restored: z38.number() }))
970
987
  },
971
988
  session: {
972
- list: base.meta(READ).input(PARAMS["session.list"]).output(z37.object({ sessions: z37.array(SESSION_DESCRIPTOR_SCHEMA).readonly() })),
989
+ list: base.meta(READ).input(PARAMS["session.list"]).output(z38.object({ sessions: z38.array(SESSION_DESCRIPTOR_SCHEMA).readonly() })),
973
990
  spawn: base.meta(KEYED).input(PARAMS["session.spawn"]).output(SPAWN_ANSWER_SCHEMA),
974
- kill: base.input(PARAMS["session.kill"]).output(z37.object({ stopped: z37.boolean().optional() })),
991
+ kill: base.input(PARAMS["session.kill"]).output(z38.object({ stopped: z38.boolean().optional() })),
975
992
  ack: base.input(PARAMS["session.ack"]).output(EMPTY),
976
- forget: base.input(PARAMS["session.forget"]).output(z37.union([FORGET_CONFIRM, FORGET_DONE])),
977
- resumeCommand: base.meta(READ).input(PARAMS["session.resumeCommand"]).output(z37.object({ command: z37.string() })),
993
+ forget: base.input(PARAMS["session.forget"]).output(z38.union([FORGET_CONFIRM, FORGET_DONE])),
994
+ resumeCommand: base.meta(READ).input(PARAMS["session.resumeCommand"]).output(z38.object({ command: z38.string() })),
978
995
  auth: {
979
- revoke: base.meta(OWNER).input(PARAMS["session.auth.revoke"]).output(z37.object({ revoked: z37.literal(true) })),
980
- rebind: base.meta(OWNER).input(PARAMS["session.auth.rebind"]).output(z37.object({ revision: z37.number(), restartPending: STRINGS }))
996
+ revoke: base.meta(OWNER).input(PARAMS["session.auth.revoke"]).output(z38.object({ revoked: z38.literal(true) })),
997
+ rebind: base.meta(OWNER).input(PARAMS["session.auth.rebind"]).output(z38.object({ revision: z38.number(), restartPending: STRINGS2 }))
981
998
  },
982
- update: base.input(PARAMS["session.update"]).output(z37.object({ renameSkipped: z37.string().optional() })),
999
+ update: base.input(PARAMS["session.update"]).output(z38.object({ renameSkipped: z38.string().optional() })),
983
1000
  scope: {
984
- add: base.input(PARAMS["session.scope.add"]).output(z37.object({ record: PUBLISHED_RECORD_SCHEMA }))
1001
+ add: base.input(PARAMS["session.scope.add"]).output(z38.object({ record: PUBLISHED_RECORD_SCHEMA }))
985
1002
  },
986
- attach: base.input(PARAMS["session.attach"]).output(z37.object({ cols: z37.number(), rows: z37.number() })),
1003
+ attach: base.input(PARAMS["session.attach"]).output(z38.object({ cols: z38.number(), rows: z38.number() })),
987
1004
  detach: base.input(PARAMS["session.detach"]).output(EMPTY),
988
- watch: base.meta(READ).input(PARAMS["session.watch"]).output(z37.object({ cols: z37.number(), rows: z37.number(), seq: z37.number(), replay: z37.string() })),
1005
+ watch: base.meta(READ).input(PARAMS["session.watch"]).output(z38.object({ cols: z38.number(), rows: z38.number(), seq: z38.number(), replay: z38.string() })),
989
1006
  input: base.input(PARAMS["session.input"]).output(EMPTY),
990
1007
  submit: base.input(PARAMS["session.submit"]).output(EMPTY),
991
1008
  resize: base.input(PARAMS["session.resize"]).output(EMPTY),
992
- screen: base.meta(READ).input(PARAMS["session.screen"]).output(z37.object({ text: z37.string(), cols: z37.number(), rows: z37.number() })),
993
- menu: base.meta(READ).input(PARAMS["session.menu"]).output(z37.object({ menu: MENU_VIEW_SCHEMA.nullable() })),
994
- choose: base.input(PARAMS["session.choose"]).output(z37.object({
995
- pressed: z37.string(),
1009
+ screen: base.meta(READ).input(PARAMS["session.screen"]).output(z38.object({ text: z38.string(), cols: z38.number(), rows: z38.number() })),
1010
+ menu: base.meta(READ).input(PARAMS["session.menu"]).output(z38.object({ menu: MENU_VIEW_SCHEMA.nullable() })),
1011
+ choose: base.input(PARAMS["session.choose"]).output(z38.object({
1012
+ pressed: z38.string(),
996
1013
  menu: MENU_VIEW_SCHEMA.nullable(),
997
- partial: z37.literal(true).optional()
1014
+ partial: z38.literal(true).optional()
998
1015
  })),
999
1016
  eject: base.input(PARAMS["session.eject"]).output(EMPTY),
1000
1017
  adopt: base.input(PARAMS["session.adopt"]).output(EMPTY),
1001
- get: base.meta(READ).input(PARAMS["session.get"]).output(z37.object({
1018
+ get: base.meta(READ).input(PARAMS["session.get"]).output(z38.object({
1002
1019
  session: SESSION_DESCRIPTOR_SCHEMA,
1003
- prompt: z37.string().nullable(),
1004
- lastActivityAt: z37.number(),
1020
+ prompt: z38.string().nullable(),
1021
+ lastActivityAt: z38.number(),
1005
1022
  pending: PENDING_PROMPT.nullable(),
1006
- result: z37.string().nullable(),
1023
+ result: z38.string().nullable(),
1007
1024
  sessionRecord: PUBLISHED_RECORD_SCHEMA.nullable()
1008
1025
  })),
1009
- read: base.meta(READ).input(PARAMS["session.read"]).output(z37.object({
1010
- rows: z37.array(TRANSCRIPT_ROW_SCHEMA).readonly(),
1011
- cursor: z37.string(),
1012
- more: z37.boolean()
1026
+ read: base.meta(READ).input(PARAMS["session.read"]).output(z38.object({
1027
+ rows: z38.array(TRANSCRIPT_ROW_SCHEMA).readonly(),
1028
+ cursor: z38.string(),
1029
+ more: z38.boolean()
1013
1030
  })),
1014
1031
  message: base.meta(KEYED).input(PARAMS["session.message"]).output(MESSAGE_ANSWER_SCHEMA),
1015
1032
  tap: base.input(PARAMS["session.tap"]).output(EMPTY)
@@ -1059,7 +1076,7 @@ var GATEWAY_PATHS = {
1059
1076
  }
1060
1077
  };
1061
1078
  // packages/contract/src/gateway-registry-schema.ts
1062
- import { z as z38 } from "zod";
1079
+ import { z as z39 } from "zod";
1063
1080
 
1064
1081
  // packages/contract/src/max-events-cursor-bytes.ts
1065
1082
  var MAX_EVENTS_CURSOR_BYTES = 4096;
@@ -1071,24 +1088,24 @@ var MAX_REGISTRY_DAEMONS = 36;
1071
1088
  var DAEMON_NAME_PATTERN = /^[a-z][a-z0-9-]{0,30}$/u;
1072
1089
  var ADDRESS_PATTERN = /^(?:\[(?<v6>[^\]]+)\]|(?<host>[^:[\]]+)):(?<port>\d{1,5})$/u;
1073
1090
  var ADDRESS_MESSAGE = "needs an address of <host>:<port> with a port from 1 to 65535";
1074
- var ADDRESS_SCHEMA = z38.string({ error: ADDRESS_MESSAGE }).transform((raw, ctx) => {
1091
+ var ADDRESS_SCHEMA = z39.string({ error: ADDRESS_MESSAGE }).transform((raw, ctx) => {
1075
1092
  const groups = ADDRESS_PATTERN.exec(raw)?.groups;
1076
1093
  const host = groups?.["v6"] ?? groups?.["host"];
1077
1094
  const port = Number(groups?.["port"]);
1078
1095
  if (host === undefined || !Number.isInteger(port) || port < 1 || port > 65535) {
1079
1096
  ctx.issues.push({ code: "custom", message: ADDRESS_MESSAGE, input: raw });
1080
- return z38.NEVER;
1097
+ return z39.NEVER;
1081
1098
  }
1082
1099
  return { host, port };
1083
1100
  });
1084
1101
  var DAEMON_ID_MESSAGE = "needs the daemonID that atc daemon id prints on its host";
1085
- var DAEMON_ID_SCHEMA2 = z38.string({ error: DAEMON_ID_MESSAGE }).regex(/^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$/u, DAEMON_ID_MESSAGE);
1086
- var DAEMON_SCHEMA = z38.object({ address: ADDRESS_SCHEMA, daemonID: DAEMON_ID_SCHEMA2 }, { error: "must be an object with address and daemonID" });
1087
- var GATEWAY_REGISTRY_SCHEMA = z38.object({
1088
- daemons: z38.record(z38.string().regex(DAEMON_NAME_PATTERN), DAEMON_SCHEMA, {
1102
+ var DAEMON_ID_SCHEMA2 = z39.string({ error: DAEMON_ID_MESSAGE }).regex(/^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$/u, DAEMON_ID_MESSAGE);
1103
+ var DAEMON_SCHEMA = z39.object({ address: ADDRESS_SCHEMA, daemonID: DAEMON_ID_SCHEMA2 }, { error: "must be an object with address and daemonID" });
1104
+ var GATEWAY_REGISTRY_SCHEMA = z39.object({
1105
+ daemons: z39.record(z39.string().regex(DAEMON_NAME_PATTERN), DAEMON_SCHEMA, {
1089
1106
  error: (issue) => issue.code === "invalid_key" ? `must match ${DAEMON_NAME_PATTERN.source}` : "the registry must be an object whose daemons is an object"
1090
1107
  }),
1091
- defaultDaemon: z38.string({
1108
+ defaultDaemon: z39.string({
1092
1109
  error: "defaultDaemon is required and must name a daemon in the registry"
1093
1110
  })
1094
1111
  }, { error: "the registry must be an object whose daemons is an object" }).superRefine((registry, ctx) => {
@@ -1153,11 +1170,11 @@ var SESSION_ENV_NAMES = {
1153
1170
  scopeFile: "AUTO_MODE_SCOPE_FILE"
1154
1171
  };
1155
1172
  // packages/contract/src/procedure-meta.ts
1156
- import { z as z39 } from "zod";
1157
- var PROCEDURE_META_SCHEMA = z39.object({
1158
- access: z39.enum(["owner", "principal"]),
1159
- readOnly: z39.boolean(),
1160
- keyed: z39.boolean()
1173
+ import { z as z40 } from "zod";
1174
+ var PROCEDURE_META_SCHEMA = z40.object({
1175
+ access: z40.enum(["owner", "principal"]),
1176
+ readOnly: z40.boolean(),
1177
+ keyed: z40.boolean()
1161
1178
  });
1162
1179
  export {
1163
1180
  AGENT_ENTRY_SCHEMA,
@@ -1203,6 +1220,7 @@ export {
1203
1220
  SPAWN_ANSWER_SCHEMA,
1204
1221
  SPAWN_OPTION_SPEC_SCHEMA,
1205
1222
  TRANSCRIPT_ROW_SCHEMA,
1223
+ WORKSPACE_CLEANUP_SCHEMA,
1206
1224
  checkDaemon,
1207
1225
  resolveAtcPaths,
1208
1226
  resolveHomeDir,
@@ -0,0 +1,13 @@
1
+ import { z } from 'zod';
2
+ export declare const WORKSPACE_CLEANUP_SCHEMA: z.ZodDiscriminatedUnion<[z.ZodObject<{
3
+ outcome: z.ZodLiteral<"removed">;
4
+ path: z.ZodString;
5
+ found: z.ZodReadonly<z.ZodArray<z.ZodString>>;
6
+ }, z.core.$strip>, z.ZodObject<{
7
+ outcome: z.ZodLiteral<"kept">;
8
+ path: z.ZodString;
9
+ reasons: z.ZodReadonly<z.ZodArray<z.ZodString>>;
10
+ }, z.core.$strip>, z.ZodObject<{
11
+ outcome: z.ZodLiteral<"none">;
12
+ }, z.core.$strip>], "outcome">;
13
+ export type WorkspaceCleanup = Readonly<z.output<typeof WORKSPACE_CLEANUP_SCHEMA>>;
package/package.json CHANGED
@@ -14,11 +14,11 @@
14
14
  }
15
15
  },
16
16
  "dependencies": {
17
- "@orpc/contract": "1.16.0",
18
- "zod": "4.6.6"
17
+ "@orpc/contract": "1.16.1",
18
+ "zod": "4.6.7"
19
19
  },
20
20
  "name": "@atcx/contract",
21
- "version": "7.7.3",
21
+ "version": "7.8.0",
22
22
  "description": "atc's public contract: the daemon's request contract, the event, session record, hello and config schemas, the error codes, the session env names, the state paths, and the gateway's routes and registry schema",
23
23
  "homepage": "https://github.com/zgeoff/atc/tree/main/packages/contract#readme",
24
24
  "bugs": "https://github.com/zgeoff/atc/issues",