@rigkit/sdk 0.2.3 → 0.2.4

package/README.md

@@ -8,7 +8,7 @@ Configs should import authoring helpers from this package:
 import { env, workflow } from "@rigkit/sdk";
 ```
 
-Task handlers receive `runtime.log(message, options)` for structured step logs.
+Task handlers receive `step.log(message, options)` for structured step logs. Pass `step.log` to SDKs that accept a logger callback.
 Those events stream over the runtime run session and are rendered by interactive
 hosts such as the `rig` terminal run timeline.
 Provider VM commands can also report incremental stdout/stderr through

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rigkit/sdk",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "type": "module",
   "repository": {
     "type": "git",
@@ -23,8 +23,8 @@
     "@effect/platform": "0.96.1",
     "@effect/platform-bun": "0.89.0",
     "effect": "^3.21.2",
-    "@rigkit/engine": "0.2.3",
-    "@rigkit/runtime-client": "0.2.3"
+    "@rigkit/engine": "0.2.4",
+    "@rigkit/runtime-client": "0.2.4"
   },
   "devDependencies": {
     "@types/bun": "latest",

package/src/host.ts

@@ -1,8 +1,17 @@
+export type HostCapabilityLogOptions = {
+  stream?: "stdout" | "stderr" | "info";
+  label?: string;
+};
+
+export type HostCapabilityContext = {
+  log(data: string, options?: HostCapabilityLogOptions): void;
+};
+
 export type HostCapabilityDefinition<Input = unknown, Result = unknown> = {
   readonly schemaHash?: string;
   readonly input?: unknown;
   readonly output?: unknown;
-  readonly handle: (params: Input) => Result | Promise<Result>;
+  readonly handle: (params: Input, context?: HostCapabilityContext) => Result | Promise<Result>;
 };
 
 export type HostCapabilityHandler<Input = unknown, Result = unknown> =

package/src/index.test.ts

@@ -16,7 +16,7 @@ import { defineHostCapabilities, defineHostCapability } from "./host.ts";
 
 describe("@rigkit/sdk package boundary", () => {
   test("exports authoring API and project runtime entrypoints", () => {
-    expect(RIGKIT_SDK_VERSION).toBe("0.2.3");
+    expect(RIGKIT_SDK_VERSION).toBe("0.2.4");
     expect(env).toBeTypeOf("function");
     expect(env.secret).toBeTypeOf("function");
     expect(defineConfig).toBeTypeOf("function");

package/src/runtime/app.test.ts

@@ -416,7 +416,7 @@ describe("runtime HTTP app", () => {
       `
         import { defineConfig, sequence } from "${import.meta.dir}/../../../engine/src/index.ts";
 
-        const root = sequence("session-test").step("noop", async () => ({ ok: true }));
+        const root = sequence("session-test").step("noop", async () => ({ ctx: { ok: true } }));
 
         export default defineConfig({
           providers: {},
@@ -473,7 +473,7 @@ describe("runtime HTTP app", () => {
         import { defineConfig, sequence } from "${import.meta.dir}/../../../engine/src/index.ts";
 
         const root = sequence("workspace-ctx")
-          .step("prepare", async () => ({ repoPath: "/workspace/repo" }))
+          .step("prepare", async () => ({ ctx: { repoPath: "/workspace/repo" } }))
           .workspace({
             create: async ({ workflow, workspace }) => ({
               name: workspace.name,
@@ -536,7 +536,7 @@ describe("runtime HTTP app", () => {
         import { defineConfig, sequence } from "${import.meta.dir}/../../../engine/src/index.ts";
 
         const root = sequence("validation")
-          .step("prepare", async () => ({ ok: true }))
+          .step("prepare", async () => ({ ctx: { ok: true } }))
           .workspace({
             create: async ({ workspace }) => ({ name: workspace.name, vmId: "vm-" + workspace.name }),
             remove: async () => {},
@@ -806,7 +806,7 @@ function writeNoopConfig(projectDir: string): void {
     `
       import { defineConfig, sequence } from "${import.meta.dir}/../../../engine/src/index.ts";
 
-      const root = sequence("noop").step("ready", async () => ({ ready: true }));
+      const root = sequence("noop").step("ready", async () => ({ ctx: { ready: true } }));
 
       export default defineConfig({
         providers: {},

package/src/runtime/operations.ts

@@ -3,6 +3,7 @@ import {
   type DevMachineEngine,
   type EngineOperationSummary,
   type JsonValue,
+  type LocalHostCapabilityRequestOptions,
 } from "@rigkit/engine";
 import { normalizeRuntimeRunError } from "./errors.ts";
 import {
@@ -83,10 +84,18 @@ async function executeOperation(run: RunRecord, store: RunStore, options: Engine
         const result = await requestHost(store, run, "host.command.run", command);
         return HostCommandResultSchema.parse(result);
       },
-      requestCapability: async <Result = unknown>(capability: string, params: unknown) =>
-        await requestHostCapability(store, run, capability, params) as Result,
-      requestCapabilitySession: async <Result = unknown>(capability: string, params: unknown) =>
-        await requestHostCapabilitySession<Result>(store, run, capability, params),
+      requestCapability: async <Result = unknown>(
+        capability: string,
+        params: unknown,
+        requestOptions?: LocalHostCapabilityRequestOptions,
+      ) =>
+        await requestHostCapability(store, run, capability, params, requestOptions) as Result,
+      requestCapabilitySession: async <Result = unknown>(
+        capability: string,
+        params: unknown,
+        requestOptions?: LocalHostCapabilityRequestOptions,
+      ) =>
+        await requestHostCapabilitySession<Result>(store, run, capability, params, requestOptions),
     },
   });
   engine.onEvent((event) => emitRunEvent(run, event));

package/src/runtime/protocol.ts

@@ -99,6 +99,7 @@ export type HostCapabilityRequestEvent = {
   type: "host.capability.request";
   requestId: string;
   id: string;
+  nodePath?: string;
   capability: string;
   params: unknown;
 };

package/src/runtime/runs.ts

@@ -21,6 +21,10 @@ export type HostCapabilitySessionResult<Result = unknown> = {
   closed: Promise<void>;
 };
 
+export type HostCapabilityRequestOptions = {
+  nodePath?: string;
+};
+
 export type RunRecord = {
   id: string;
   operation: string;
@@ -197,8 +201,9 @@ export function requestHostCapability(
   run: RunRecord,
   capability: string,
   params: unknown,
+  options: HostCapabilityRequestOptions = {},
 ): Promise<unknown> {
-  const { requestId } = emitHostCapabilityRequest(run, capability, params);
+  const { requestId } = emitHostCapabilityRequest(run, capability, params, options);
   return waitForHostResponse(store, requestId);
 }
 
@@ -207,8 +212,9 @@ export async function requestHostCapabilitySession<Result = unknown>(
   run: RunRecord,
   capability: string,
   params: unknown,
+  options: HostCapabilityRequestOptions = {},
 ): Promise<HostCapabilitySessionResult<Result>> {
-  const { requestId } = emitHostCapabilityRequest(run, capability, params);
+  const { requestId } = emitHostCapabilityRequest(run, capability, params, options);
   const closed = new Promise<void>((resolveClosed, rejectClosed) => {
     store.hostCapabilityResources.set(requestId, { resolveClosed, rejectClosed });
     run.pendingHostCapabilityResourceIds.add(requestId);
@@ -234,6 +240,7 @@ function emitHostCapabilityRequest(
   run: RunRecord,
   capability: string,
   params: unknown,
+  options: HostCapabilityRequestOptions = {},
 ): { requestId: string } {
   if (run.status !== "running") {
     throw new RuntimeHostRequestError({
@@ -243,7 +250,14 @@ function emitHostCapabilityRequest(
   }
   const requestId = `cap_req_${crypto.randomUUID()}`;
   run.pendingHostRequestIds.add(requestId);
-  emitRunEvent(run, { type: "host.capability.request", requestId, id: requestId, capability, params });
+  emitRunEvent(run, {
+    type: "host.capability.request",
+    requestId,
+    id: requestId,
+    ...(options.nodePath ? { nodePath: options.nodePath } : {}),
+    capability,
+    params,
+  });
   return { requestId };
 }
 

package/src/runtime/sessions.ts

@@ -164,6 +164,7 @@ function sessionEvent(event: unknown): Record<string, unknown> {
     return {
       type: "host.capability.request",
       id: typeof event.id === "string" ? event.id : event.requestId,
+      ...(typeof event.nodePath === "string" ? { nodePath: event.nodePath } : {}),
       capability: event.capability,
       params: event.params,
     };

package/src/runtime/version.ts

@@ -1 +1 @@
-export const RIGKIT_RUNTIME_VERSION = "0.2.3";
+export const RIGKIT_RUNTIME_VERSION = "0.2.4";

package/src/version.ts

@@ -1 +1 @@
-export const RIGKIT_SDK_VERSION = "0.2.3";
+export const RIGKIT_SDK_VERSION = "0.2.4";