swytchcode-runtime 0.1.1 → 0.1.3

package/README.md

@@ -1,4 +1,4 @@
-# @swytchcode/runtime
+# swytchcode-runtime
 
 Thin runtime wrapper around the Swytchcode CLI. Calls `swytchcode exec` for you so you can stay in TypeScript/JavaScript without shell boilerplate.
 
@@ -9,7 +9,7 @@ By default, the runtime runs Swytchcode in **JSON mode**: the CLI is invoked wit
 ## Install
 
 ```bash
-npm install @swytchcode/runtime
+npm install swytchcode-runtime
 ```
 
 ## Use
@@ -17,22 +17,40 @@ npm install @swytchcode/runtime
 ### JSON mode (default)
 
 ```ts
-import { exec } from "@swytchcode/runtime";
+import { exec } from "swytchcode-runtime";
 
 const result = await exec("api.account.create", {
-  email: "test@example.com",
+  body: { name: "my-cluster" },
+  Authorization: "Bearer token123",
 });
 // result is parsed JSON (unknown)
 ```
 
-Equivalent to: `swytchcode exec api.account.create --json` with input on stdin.
+Equivalent to: `swytchcode exec api.account.create --json` with args on stdin.
+
+**Request input (args):** The second argument is the kernel **args** object (sent as JSON on stdin). Use this shape so the kernel builds the request correctly:
+- **`body`** — Request body (object).
+- **`params`** — Query/path params (object, e.g. `{ id: "cluster-123" }`).
+- **`Authorization`** — Auth header value (e.g. `"Bearer token123"`).
+- **`headers`** — Additional request headers (e.g. `{ "X-Request-Id": "abc-123" }`).
+- Other top-level keys are passed as query params.
+
+Example with body, params, and headers:
+
+```ts
+await exec("api.cluster.get", {
+  params: { id: "cluster-123" },
+  Authorization: "Bearer token123",
+  headers: { "X-Request-Id": "abc-123" },
+});
+```
 
 ### Raw mode
 
 Get stdout as a string instead of parsing JSON:
 
 ```ts
-import { exec } from "@swytchcode/runtime";
+import { exec } from "swytchcode-runtime";
 
 const output = await exec("api.report.export", { id: "123" }, { raw: true });
 // output is the raw stdout string
@@ -65,7 +83,7 @@ Or in code: `exec("shell.integration.list", undefined, { debug: true })`.
 Failures throw `SwytchcodeError` (spawn error, non-zero exit, signal, empty stdout in JSON mode, invalid JSON). Use the type guard when you need to narrow:
 
 ```ts
-import { exec, isSwytchcodeError } from "@swytchcode/runtime";
+import { exec, isSwytchcodeError } from "swytchcode-runtime";
 
 try {
   await exec("api.account.create", { email: "test@example.com" });
@@ -103,7 +121,7 @@ Generate code that uses this runtime instead of subprocess boilerplate.
 **Preferred:**
 
 ```ts
-import { exec } from "@swytchcode/runtime";
+import { exec } from "swytchcode-runtime";
 
 export async function createAccount(input: { email: string }) {
   return exec("api.account.create", input);

package/dist/exec.d.ts

@@ -1,9 +1,12 @@
-import { ExecOptions, ExecResult } from "./types.js";
+import type { ExecArgs, ExecOptions, ExecResult } from "./types.js";
 /**
- * Run `swytchcode exec <canonicalId>` with optional JSON input on stdin.
+ * Run `swytchcode exec <canonicalId>` with optional JSON args on stdin.
  * Default is JSON mode (stdout must be valid JSON; empty or parse failure throws).
  * Use output: "raw" or raw: true for raw stdout string. Stream mode is not supported.
  *
+ * The second argument (input) is the kernel args object sent on stdin: use body, params,
+ * Authorization, and headers so the kernel builds the request correctly. See ExecArgs.
+ *
  * Enable logs: pass `{ debug: true }` or set env SWYTCHCODE_RUNTIME_DEBUG=1
  */
-export declare function exec(canonicalId: string, input?: unknown, options?: ExecOptions): Promise<ExecResult>;
+export declare function exec(canonicalId: string, input?: ExecArgs | unknown, options?: ExecOptions): Promise<ExecResult>;

package/dist/exec.js

@@ -16,10 +16,13 @@ function log(debug, msg, detail) {
     process.stderr.write(line);
 }
 /**
- * Run `swytchcode exec <canonicalId>` with optional JSON input on stdin.
+ * Run `swytchcode exec <canonicalId>` with optional JSON args on stdin.
  * Default is JSON mode (stdout must be valid JSON; empty or parse failure throws).
  * Use output: "raw" or raw: true for raw stdout string. Stream mode is not supported.
  *
+ * The second argument (input) is the kernel args object sent on stdin: use body, params,
+ * Authorization, and headers so the kernel builds the request correctly. See ExecArgs.
+ *
  * Enable logs: pass `{ debug: true }` or set env SWYTCHCODE_RUNTIME_DEBUG=1
  */
 function exec(canonicalId, input, options = {}) {

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 export { exec } from "./exec.js";
-export type { ExecOptions, ExecResult, OutputMode } from "./types.js";
+export type { ExecArgs, ExecOptions, ExecResult, OutputMode } from "./types.js";
 export { SwytchcodeError, isSwytchcodeError } from "./errors.js";

package/dist/types.d.ts

@@ -21,3 +21,18 @@ export interface ExecOptions {
 }
 /** Result of `exec()` in JSON mode: parsed stdout. In raw mode the result is a string. */
 export type ExecResult = unknown;
+/**
+ * Tool arguments sent to the kernel on stdin (matches `swytchcode exec` JSON stdin).
+ * - `body`: Request body (object).
+ * - `params`: Query/path params (object).
+ * - `Authorization`: Auth header value (e.g. "Bearer token").
+ * - `headers`: Additional request headers (map of header name to value).
+ * - Other top-level keys are passed as query params.
+ */
+export interface ExecArgs {
+    body?: unknown;
+    params?: Record<string, string>;
+    Authorization?: string;
+    headers?: Record<string, string>;
+    [key: string]: unknown;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swytchcode-runtime",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Thin runtime wrapper around the Swytchcode CLI",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",