auto-harness-client 0.5.0 → 0.6.0

package/README.md

@@ -192,6 +192,11 @@ that `auto-harness`'s own
 uses, so a consuming
 workflow's inline script and a bundled composite action stay in sync with the same validation.
 
+The same module also covers session drain from a workflow: `isHarnessDrainOperation` (a type
+guard for the `start-drain`/`get-drain`/`wait-for-drain`/`release-drain` operation vocabulary) and
+`writeDrainOutputs` (writes `operation-id`/`status`/`queued-count`/`running-count`/
+`cancelled-count`/`failure-code` to `GITHUB_OUTPUT` for a `SessionDrain`).
+
 ```js
 import { parseHarnessTarget, requiredEnvironmentValue } from "auto-harness-client/actions";
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "auto-harness-client",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Dependency-free client for the Auto Harness automation API",
   "repository": {
     "type": "git",

package/src/actions/drain.js

@@ -0,0 +1,8 @@
+export function isHarnessDrainOperation(value) {
+  return (
+    value === "start-drain" ||
+    value === "get-drain" ||
+    value === "wait-for-drain" ||
+    value === "release-drain"
+  );
+}

package/src/actions/index.d.ts

@@ -1,4 +1,4 @@
-import type { TargetSpec } from "../index.js";
+import type { SessionDrain, TargetSpec } from "../index.js";
 
 /** Dependency-free env→`CreateSessionInput` adapter for GitHub Actions consumers of Auto Harness. */
 
@@ -66,3 +66,17 @@ export function writeOutputs(
   result: DispatchResult,
   route?: TargetSpec[],
 ): void;
+
+export type HarnessDrainOperation =
+  | "start-drain"
+  | "get-drain"
+  | "wait-for-drain"
+  | "release-drain";
+
+export function isHarnessDrainOperation(value: string | undefined): value is HarnessDrainOperation;
+
+/**
+ * Writes `operation-id`/`status`/`queued-count`/`running-count`/`cancelled-count`/`failure-code`
+ * to `GITHUB_OUTPUT`, only when it is set.
+ */
+export function writeDrainOutputs(environment: ActionEnvironment, drain: SessionDrain): void;

package/src/actions/index.js

@@ -1,5 +1,6 @@
 export { requiredEnvironmentValue } from "./env.js";
 export { HarnessDispatchError } from "./errors.js";
+export { isHarnessDrainOperation } from "./drain.js";
 export {
   parseApiOrigin,
   parseConcurrencyId,
@@ -9,4 +10,5 @@ export {
   parseRequiredLabels,
 } from "./parse.js";
 export { TARGET_SPEC_KEYS, parseHarnessFallbacks, parseHarnessTarget } from "./parse-target.js";
+export { writeDrainOutputs } from "./write-drain-outputs.js";
 export { writeOutputs } from "./write-outputs.js";

package/src/actions/write-drain-outputs.js

@@ -0,0 +1,18 @@
+import { appendFileSync } from "node:fs";
+
+export function writeDrainOutputs(environment, drain) {
+  if (!environment.GITHUB_OUTPUT) return;
+  appendFileSync(
+    environment.GITHUB_OUTPUT,
+    [
+      `operation-id=${drain.operationId}`,
+      `status=${drain.status}`,
+      `queued-count=${drain.queuedCount}`,
+      `running-count=${drain.runningCount}`,
+      `cancelled-count=${drain.cancelledCount}`,
+      `failure-code=${drain.failureCode ?? ""}`,
+      "",
+    ].join("\n"),
+    "utf8",
+  );
+}