@boxxy/model 0.1.8 → 0.1.9

package/dist/index.d.ts

@@ -58,7 +58,7 @@ export type { AcceptanceInput, BuildCloseOut, BuildInput, CloseOut, CloseOutAnsw
 export type { Claim } from './dispatch/types.ts';
 export type { AnyNewFact, EntityRef, FactEnvelope, FactType, NewFact, OutboxFact, RelationPayload, WorkFacts, } from './facts/types.ts';
 export type { Admission, AdmissionGrant, AdmissionName, Decision, Fault, Filter, Frame, FrameItem, FrameValues, Gate, GateName, Hold, Lift, Limit, LimitFill, Pick, PlanContext, Pool, PropagationLine, SeatRef, SeatRelease, SeatTake, Signal, SignalKey, SignalName, Snapshot, StartPick, View, ViewName, Wait, WaitReason, Waiver, WaiverName, Wake, WakePick, } from './planning/types.ts';
-export type { ApplyResult, Attention, CallerProof, CapacityBackoff, ClaimStore, Clock, FactSink, ForgetOutcome, Forge, GitSource, HoldNotice, ItemDetailRows, ItemFilter, NewId, NoticeOutcome, Notifier, OutboxReader, PepysAnswer, PepysReader, SinkAnswer, PullRequestReading, RowWrite, SessionFault, SessionReading, SpawnRequest, StartOutcome, StopOutcome, StoreChange, StoreReader, StoreTx, SuspendOutcome, TableName, Tables, WakeSource, WorkerKind, } from './ports/types.ts';
+export type { ApplyResult, Attention, CallerProof, CapacityBackoff, ClaimStore, Clock, FactSink, ForgetOutcome, Forge, GitSource, HoldNotice, ItemDetailRows, ItemFilter, NewId, NoticeOutcome, Notifier, OutboxReader, PepysAnswer, PepysReader, SinkAnswer, PullRequestReading, RowWrite, RunnerFault, SessionFault, SessionReading, SpawnRequest, StartOutcome, StopOutcome, StoreChange, StoreReader, StoreTx, SuspendOutcome, TableName, Tables, WakeSource, WorkerKind, WorkerRefusal, } from './ports/types.ts';
 export type { CostToLand, StageTime } from './reports/types.ts';
 export type { OutboxStatus } from './reports/outbox-status.ts';
 export type { ItemSetRows, ItemWithLevers } from './items/types.ts';

package/dist/ports/types.d.ts

@@ -204,6 +204,9 @@ export type Attention = 'working' | 'needs-input' | 'turn-ended';
 export interface GitSource {
     readonly url: string;
     readonly ref: string;
+    readonly credentialRef?: {
+        readonly name: string;
+    };
 }
 export type SpawnRequest = SpawnRequestFields & ({
     readonly cwd: string;
@@ -248,6 +251,15 @@ export interface SessionFault {
     readonly attempt: AttemptId;
     readonly holder: AttemptId;
 }
+export interface WorkerRefusal {
+    readonly kind: 'fault';
+    readonly fault: 'spawn-refused' | 'wake-refused';
+    readonly attempt: AttemptId;
+    readonly item: ItemId;
+    readonly cause: 'capacity' | 'other';
+    readonly reason: string;
+}
+export type RunnerFault = SessionFault | WorkerRefusal;
 export type SinkAnswer = {
     readonly kind: 'stored';
 } | {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@boxxy/model",
-  "version": "0.1.8",
+  "version": "0.1.9",
   "description": "The types that boxxy's packages share",
   "homepage": "https://github.com/zgeoff/boxxy/tree/main/libs/model#readme",
   "bugs": "https://github.com/zgeoff/boxxy/issues",
@@ -31,7 +31,7 @@
     "typecheck": "tsrs --noEmit"
   },
   "dependencies": {
-    "@boxxy/content-hash": "0.1.8",
+    "@boxxy/content-hash": "0.1.9",
     "tiny-invariant": "1.3.3",
     "zod": "4.6.7"
   },

package/src/index.ts

@@ -236,6 +236,7 @@ export type {
   SinkAnswer,
   PullRequestReading,
   RowWrite,
+  RunnerFault,
   SessionFault,
   SessionReading,
   SpawnRequest,
@@ -249,6 +250,7 @@ export type {
   Tables,
   WakeSource,
   WorkerKind,
+  WorkerRefusal,
 } from './ports/types.ts';
 
 export type { CostToLand, StageTime } from './reports/types.ts';

package/src/ports/types.ts

@@ -305,11 +305,13 @@ export type SessionReading =
 
 export type Attention = 'working' | 'needs-input' | 'turn-ended';
 
-// A git repository that atc clones on the target. It carries no credential: an imp clones over its
-// own network, where the broker adds the credential from the session's grants.
+// A git repository that atc clones for the session. The atc daemon clones it before the session
+// exists, so a private repository needs `credentialRef`: the name of the daemon's environment
+// variable that holds a clone token. The name is no secret; boxxy never reads the token.
 export interface GitSource {
   readonly url: string;
   readonly ref: string;
+  readonly credentialRef?: { readonly name: string };
 }
 
 // Exactly one of the two: `cwd`, the repo's folder on a target on the atc daemon's own host, or
@@ -370,6 +372,21 @@ export interface SessionFault {
   readonly holder: AttemptId;
 }
 
+// A spawn or a wake that the worker refused. A refused spawn settles the attempt as `no-capacity`
+// or `spawn-refused`; a refused wake sleeps the attempt again for capacity, and otherwise leaves it
+// `waking` for the next reading. The runner logs the worker's reason, which no fact carries.
+export interface WorkerRefusal {
+  readonly kind: 'fault';
+  readonly fault: 'spawn-refused' | 'wake-refused';
+  readonly attempt: AttemptId;
+  readonly item: ItemId;
+  readonly cause: 'capacity' | 'other';
+  readonly reason: string;
+}
+
+// What a claim or a reading returns for the runner to log.
+export type RunnerFault = SessionFault | WorkerRefusal;
+
 // What one batch sent to the sink got back. `retry` may or may not have stored the batch.
 export type SinkAnswer =
   | { readonly kind: 'stored' }

package/src/rows/spawn-request-schema.ts

@@ -14,6 +14,16 @@ export const gitSourceSchema: z.ZodType<GitSource> = z.strictObject({
     .min(1)
     .max(255)
     .refine((ref) => !ref.startsWith('-'), 'a git source ref must not start with -'),
+
+  // atc's own rule for the name of an environment variable
+  credentialRef: z
+    .strictObject({
+      name: z
+        .string()
+        .max(255)
+        .regex(/^[A-Za-z_]\w*$/u, 'a credentialRef names an environment variable'),
+    })
+    .exactOptional(),
 });
 
 const spawnRequestFields = z.strictObject({