@byokit/openclaw 0.1.0

package/dist/routes.json

@@ -0,0 +1,398 @@
+[
+    {
+        "choice": "openai",
+        "provider": "openai",
+        "plugin": "openai",
+        "billing": "subscription",
+        "via": "browser",
+        "prerequisite": null,
+        "offer": true,
+        "reason": "ChatGPT/Codex subscription sign-in: the engine writes the redirect to the app's callback port.",
+        "source": "dist/provider-contract-api-*.js (2026.8.1)"
+    },
+    {
+        "choice": "openai-device-code",
+        "provider": "openai",
+        "plugin": "openai",
+        "billing": "subscription",
+        "via": "code",
+        "prerequisite": null,
+        "offer": true,
+        "reason": "ChatGPT subscription sign-in by device code: the code is shown, no browser on this computer needed.",
+        "source": "dist/provider-contract-api-*.js (2026.8.1)"
+    },
+    {
+        "choice": "xai-oauth",
+        "provider": "xai",
+        "plugin": "xai",
+        "billing": "subscription",
+        "via": "code",
+        "prerequisite": null,
+        "offer": true,
+        "reason": "Grok subscription sign-in through the engine's own wizard.",
+        "source": "dist/extensions/xai/openclaw.plugin.json (2026.8.1)"
+    },
+    {
+        "choice": "github-copilot",
+        "provider": "github-copilot",
+        "plugin": "github-copilot",
+        "billing": "subscription",
+        "via": "code",
+        "prerequisite": null,
+        "offer": true,
+        "reason": "GitHub Copilot subscription sign-in; the login stays in the engine's own folder.",
+        "source": "dist/extensions/github-copilot/openclaw.plugin.json (2026.8.1)"
+    },
+    {
+        "choice": "github-copilot-enterprise",
+        "provider": "github-copilot",
+        "plugin": "github-copilot",
+        "billing": "subscription",
+        "via": "code",
+        "prerequisite": null,
+        "offer": true,
+        "reason": "GitHub Copilot Enterprise sign-in; the login stays in the engine's own folder.",
+        "source": "dist/extensions/github-copilot/openclaw.plugin.json (2026.8.1)"
+    },
+    {
+        "choice": "minimax-global-oauth",
+        "provider": "minimax",
+        "plugin": "minimax",
+        "billing": "subscription",
+        "via": "code",
+        "prerequisite": null,
+        "offer": true,
+        "reason": "MiniMax subscription sign-in (global endpoint).",
+        "source": "dist/extensions/minimax/openclaw.plugin.json (2026.8.1)"
+    },
+    {
+        "choice": "minimax-cn-oauth",
+        "provider": "minimax",
+        "plugin": "minimax",
+        "billing": "subscription",
+        "via": "code",
+        "prerequisite": null,
+        "offer": true,
+        "reason": "MiniMax subscription sign-in (CN endpoint).",
+        "source": "dist/extensions/minimax/openclaw.plugin.json (2026.8.1)"
+    },
+    {
+        "choice": "openrouter-oauth",
+        "provider": "openrouter",
+        "plugin": "openrouter",
+        "billing": "api",
+        "via": "browser",
+        "prerequisite": null,
+        "offer": false,
+        "reason": "API billing, not a subscription; upstream OAuth yields a credit-billed key.",
+        "source": "dist/extensions/openrouter/openclaw.plugin.json (2026.8.1)"
+    },
+    {
+        "choice": "xai-device-code",
+        "provider": "xai",
+        "plugin": "xai",
+        "billing": "subscription",
+        "via": "code",
+        "prerequisite": null,
+        "offer": false,
+        "reason": "Compatibility alias the Gateway does not offer; use xai-oauth.",
+        "source": "dist/extensions/xai/openclaw.plugin.json (2026.8.1)"
+    },
+    {
+        "choice": "alibaba-model-studio-api-key",
+        "provider": "alibaba",
+        "plugin": "alibaba",
+        "billing": "api",
+        "via": "browser",
+        "prerequisite": null,
+        "offer": false,
+        "reason": "API billing, not a subscription; shown only when an app asks.",
+        "source": "dist/extensions/alibaba/openclaw.plugin.json (2026.8.1)"
+    },
+    {
+        "choice": "anthropic-cli",
+        "provider": "anthropic",
+        "plugin": "anthropic",
+        "billing": "subscription",
+        "via": "browser",
+        "prerequisite": "the Claude CLI, signed in inside the engine's own folder",
+        "offer": false,
+        "reason": "byokit never adds Claude plan sign-in",
+        "source": "dist/extensions/anthropic/openclaw.plugin.json (2026.8.1)"
+    },
+    {
+        "choice": "apiKey",
+        "provider": "anthropic",
+        "plugin": "anthropic",
+        "billing": "api",
+        "via": "browser",
+        "prerequisite": null,
+        "offer": false,
+        "reason": "API billing, not a subscription; never offered (D12): no Anthropic API fallback.",
+        "source": "dist/extensions/anthropic/openclaw.plugin.json (2026.8.1)"
+    },
+    {
+        "choice": "clawrouter-api-key",
+        "provider": "clawrouter",
+        "plugin": "clawrouter",
+        "billing": "api",
+        "via": "browser",
+        "prerequisite": null,
+        "offer": false,
+        "reason": "API billing, not a subscription; shown only when an app asks.",
+        "source": "dist/extensions/clawrouter/openclaw.plugin.json (2026.8.1)"
+    },
+    {
+        "choice": "copilot-proxy",
+        "provider": "copilot-proxy",
+        "plugin": "copilot-proxy",
+        "billing": "local",
+        "via": "browser",
+        "prerequisite": null,
+        "offer": false,
+        "reason": "Local runtime on this computer; no account and no billing.",
+        "source": "dist/extensions/copilot-proxy/openclaw.plugin.json (2026.8.1)"
+    },
+    {
+        "choice": "custom-api-key",
+        "provider": "custom",
+        "plugin": "",
+        "billing": "api",
+        "via": "browser",
+        "prerequisite": null,
+        "offer": false,
+        "reason": "API billing, not a subscription; shown only when an app asks.",
+        "source": "dist/auth-choice-options-BLHNSTXX.js (2026.8.1)"
+    },
+    {
+        "choice": "fal-api-key",
+        "provider": "fal",
+        "plugin": "fal",
+        "billing": "api",
+        "via": "browser",
+        "prerequisite": null,
+        "offer": false,
+        "reason": "API billing, not a subscription; shown only when an app asks.",
+        "source": "dist/extensions/fal/openclaw.plugin.json (2026.8.1)"
+    },
+    {
+        "choice": "gemini-api-key",
+        "provider": "google",
+        "plugin": "google",
+        "billing": "api",
+        "via": "browser",
+        "prerequisite": null,
+        "offer": false,
+        "reason": "API billing, not a subscription; shown only when an app asks.",
+        "source": "dist/provider-contract-api-*.js (2026.8.1)"
+    },
+    {
+        "choice": "huggingface-api-key",
+        "provider": "huggingface",
+        "plugin": "huggingface",
+        "billing": "api",
+        "via": "browser",
+        "prerequisite": null,
+        "offer": false,
+        "reason": "API billing, not a subscription; shown only when an app asks.",
+        "source": "dist/extensions/huggingface/openclaw.plugin.json (2026.8.1)"
+    },
+    {
+        "choice": "litellm-api-key",
+        "provider": "litellm",
+        "plugin": "litellm",
+        "billing": "api",
+        "via": "browser",
+        "prerequisite": null,
+        "offer": false,
+        "reason": "API billing, not a subscription; shown only when an app asks.",
+        "source": "dist/extensions/litellm/openclaw.plugin.json (2026.8.1)"
+    },
+    {
+        "choice": "lmstudio",
+        "provider": "lmstudio",
+        "plugin": "lmstudio",
+        "billing": "local",
+        "via": "browser",
+        "prerequisite": null,
+        "offer": false,
+        "reason": "Local runtime on this computer; no account and no billing.",
+        "source": "dist/extensions/lmstudio/openclaw.plugin.json (2026.8.1)"
+    },
+    {
+        "choice": "microsoft-foundry-apikey",
+        "provider": "microsoft-foundry",
+        "plugin": "microsoft-foundry",
+        "billing": "api",
+        "via": "browser",
+        "prerequisite": null,
+        "offer": false,
+        "reason": "API billing, not a subscription; shown only when an app asks.",
+        "source": "dist/extensions/microsoft-foundry/openclaw.plugin.json (2026.8.1)"
+    },
+    {
+        "choice": "microsoft-foundry-entra",
+        "provider": "microsoft-foundry",
+        "plugin": "microsoft-foundry",
+        "billing": "api",
+        "via": "browser",
+        "prerequisite": null,
+        "offer": false,
+        "reason": "API billing, not a subscription; shown only when an app asks.",
+        "source": "dist/extensions/microsoft-foundry/openclaw.plugin.json (2026.8.1)"
+    },
+    {
+        "choice": "minimax-cn-api",
+        "provider": "minimax",
+        "plugin": "minimax",
+        "billing": "api",
+        "via": "browser",
+        "prerequisite": null,
+        "offer": false,
+        "reason": "API billing, not a subscription; shown only when an app asks.",
+        "source": "dist/extensions/minimax/openclaw.plugin.json (2026.8.1)"
+    },
+    {
+        "choice": "minimax-global-api",
+        "provider": "minimax",
+        "plugin": "minimax",
+        "billing": "api",
+        "via": "browser",
+        "prerequisite": null,
+        "offer": false,
+        "reason": "API billing, not a subscription; shown only when an app asks.",
+        "source": "dist/extensions/minimax/openclaw.plugin.json (2026.8.1)"
+    },
+    {
+        "choice": "nvidia-api-key",
+        "provider": "nvidia",
+        "plugin": "nvidia",
+        "billing": "api",
+        "via": "browser",
+        "prerequisite": null,
+        "offer": false,
+        "reason": "API billing, not a subscription; shown only when an app asks.",
+        "source": "dist/extensions/nvidia/openclaw.plugin.json (2026.8.1)"
+    },
+    {
+        "choice": "ollama",
+        "provider": "ollama",
+        "plugin": "ollama",
+        "billing": "local",
+        "via": "browser",
+        "prerequisite": null,
+        "offer": false,
+        "reason": "Local runtime on this computer; no account and no billing.",
+        "source": "dist/extensions/ollama/openclaw.plugin.json (2026.8.1)"
+    },
+    {
+        "choice": "ollama-cloud",
+        "provider": "ollama-cloud",
+        "plugin": "ollama",
+        "billing": "api",
+        "via": "browser",
+        "prerequisite": null,
+        "offer": false,
+        "reason": "API billing, not a subscription; shown only when an app asks.",
+        "source": "dist/extensions/ollama/openclaw.plugin.json (2026.8.1)"
+    },
+    {
+        "choice": "openai-api-key",
+        "provider": "openai",
+        "plugin": "openai",
+        "billing": "api",
+        "via": "browser",
+        "prerequisite": null,
+        "offer": false,
+        "reason": "API billing, not a subscription; shown only when an app asks.",
+        "source": "dist/provider-contract-api-*.js (2026.8.1)"
+    },
+    {
+        "choice": "opencode-go",
+        "provider": "opencode-go",
+        "plugin": "opencode-go",
+        "billing": "api",
+        "via": "browser",
+        "prerequisite": null,
+        "offer": false,
+        "reason": "API billing, not a subscription; shown only when an app asks.",
+        "source": "dist/extensions/opencode-go/openclaw.plugin.json (2026.8.1)"
+    },
+    {
+        "choice": "openrouter-api-key",
+        "provider": "openrouter",
+        "plugin": "openrouter",
+        "billing": "api",
+        "via": "browser",
+        "prerequisite": null,
+        "offer": false,
+        "reason": "API billing, not a subscription; shown only when an app asks.",
+        "source": "dist/extensions/openrouter/openclaw.plugin.json (2026.8.1)"
+    },
+    {
+        "choice": "runway-api-key",
+        "provider": "runway",
+        "plugin": "runway",
+        "billing": "api",
+        "via": "browser",
+        "prerequisite": null,
+        "offer": false,
+        "reason": "API billing, not a subscription; shown only when an app asks.",
+        "source": "dist/extensions/runway/openclaw.plugin.json (2026.8.1)"
+    },
+    {
+        "choice": "setup-token",
+        "provider": "anthropic",
+        "plugin": "anthropic",
+        "billing": "subscription",
+        "via": "browser",
+        "prerequisite": null,
+        "offer": false,
+        "reason": "byokit never adds Claude plan sign-in",
+        "source": "dist/extensions/anthropic/openclaw.plugin.json (2026.8.1)"
+    },
+    {
+        "choice": "sglang",
+        "provider": "sglang",
+        "plugin": "sglang",
+        "billing": "local",
+        "via": "browser",
+        "prerequisite": null,
+        "offer": false,
+        "reason": "Local runtime on this computer; no account and no billing.",
+        "source": "dist/extensions/sglang/openclaw.plugin.json (2026.8.1)"
+    },
+    {
+        "choice": "together-api-key",
+        "provider": "together",
+        "plugin": "together",
+        "billing": "api",
+        "via": "browser",
+        "prerequisite": null,
+        "offer": false,
+        "reason": "API billing, not a subscription; shown only when an app asks.",
+        "source": "dist/extensions/together/openclaw.plugin.json (2026.8.1)"
+    },
+    {
+        "choice": "vllm",
+        "provider": "vllm",
+        "plugin": "vllm",
+        "billing": "local",
+        "via": "browser",
+        "prerequisite": null,
+        "offer": false,
+        "reason": "Local runtime on this computer; no account and no billing.",
+        "source": "dist/extensions/vllm/openclaw.plugin.json (2026.8.1)"
+    },
+    {
+        "choice": "xai-api-key",
+        "provider": "xai",
+        "plugin": "xai",
+        "billing": "api",
+        "via": "browser",
+        "prerequisite": null,
+        "offer": false,
+        "reason": "API billing, not a subscription; shown only when an app asks.",
+        "source": "dist/extensions/xai/openclaw.plugin.json (2026.8.1)"
+    }
+]

package/dist/runs.d.ts

@@ -0,0 +1,14 @@
+import type { Bridge } from './bridge.ts';
+import type { GatewayTransport, Member, RunEnd, RunEvent, RunSpec } from './types.ts';
+export declare function createRuns(ctx: {
+    request: GatewayTransport['request'];
+    onEvent: GatewayTransport['onEvent'];
+    ensure(member: Member): Promise<{
+        agentId: string;
+    }>;
+    bridge: Pick<Bridge, 'register' | 'unregister'>;
+}): {
+    run(spec: RunSpec, on?: (e: RunEvent) => void): Promise<RunEnd>;
+    steer(k: string, t: string): Promise<void>;
+    abort(k: string): Promise<void>;
+};

package/dist/runs.js

@@ -0,0 +1,110 @@
+// Runs: one Gateway run per spec, streamed through typed events, ending in a classified RunEnd (5.8, O8).
+import { randomUUID } from 'node:crypto';
+import { classify } from "./classify.js";
+// The gateway gives up on a silent run after an hour; we wait ten minutes longer for the reply frame itself.
+const WAIT_MS = 3_600_000;
+const WAIT_CLIENT_MS = 3_610_000;
+const USABLE = new Set(['ok', 'expiring', 'static']);
+const usable = (row) => typeof row === 'string'
+    || (Array.isArray(row.profiles) && row.profiles.length > 0 ? row.profiles.some((p) => USABLE.has(String(p?.status)))
+        : row.status === undefined || USABLE.has(String(row.status)));
+/**
+ * The account a run names, `provider/model`, split for the `agent` request's per-run `provider`/`model` override.
+ * Refused before any request when malformed or when it carries an `@profile` pin: the pin only reaches the engine as
+ * a session preference it may rotate away from (docs/runtime-kits.md 5.8), so the kit never sends one.
+ */
+function account(model) {
+    const at = model.indexOf('/');
+    if (at <= 0 || at === model.length - 1 || /[\s@]/.test(model))
+        throw new Error(`refused: "${model}" is not a provider/model reference`);
+    return { provider: model.slice(0, at).toLowerCase(), model: model.slice(at + 1) }; // the engine lowercases ids
+}
+export function createRuns(ctx) {
+    const run = async (spec, on) => {
+        // Member boundary first: a member never speaks in another member's session, refused before any request.
+        if (!spec.sessionKey.startsWith(`agent:${spec.member}:`))
+            throw new Error(`refused: "${spec.sessionKey}" is not a session of member "${spec.member}"`);
+        const picked = spec.model === undefined ? undefined : account(spec.model);
+        const { agentId } = await ctx.ensure(spec.member);
+        const registered = spec.register !== false;
+        if (registered)
+            ctx.bridge.register({ sessionKey: spec.sessionKey, member: spec.member });
+        let last = '';
+        let runId = ''; // gateway events for other runs carry a real runId and never match the empty one
+        let ended = false;
+        // The engine flags an aborted run on its lifecycle end event; the wait receipt itself only says
+        // `status: 'error', stopReason: 'rpc'` (O11), so the flag is what maps the receipt to aborted.
+        let abortedByEngine = false;
+        const unsubscribe = ctx.onEvent((e) => {
+            if (ended || e.event !== 'agent')
+                return;
+            const p = e.payload;
+            if (!p || p.runId !== runId)
+                return;
+            if (p.stream === 'lifecycle' && p.data?.phase === 'end'
+                && p.data.aborted === true)
+                abortedByEngine = true;
+            if (p.stream === 'assistant' && typeof p.data?.text === 'string') {
+                last = p.data.text;
+                on?.({ type: 'text', text: p.data.text });
+            }
+            else if (p.stream === 'tool' && typeof p.data?.name === 'string') {
+                // The real engine marks completion `phase: 'result'` (O11); anything but `start` ends the pair.
+                on?.({ type: 'tool', name: p.data.name, phase: p.data.phase === 'start' ? 'start' : 'end' });
+            }
+        });
+        try {
+            if (picked) {
+                // The picked account must be the one called: check it is signed in for this member before the run, since
+                // the engine would otherwise fail the run only after admitting it. An explicit provider/model is strict on
+                // the pinned engine (never another provider or model), so this check plus the override is the guarantee.
+                const status = (refresh) => ctx.request('models.authStatus', { agentId, ...(refresh ? { refresh: true } : {}) });
+                let auth = await status(false);
+                if (auth.unavailable)
+                    auth = await status(true); // no prepared snapshot yet: build it once
+                if (auth.unavailable)
+                    return { ok: false, kind: 'other', message: String(auth.unavailable.message ?? 'account status unavailable') };
+                const row = (auth.providers ?? []).find((e) => (typeof e === 'string' ? e : e?.provider) === picked.provider);
+                if (!row || !usable(row))
+                    return { ok: false, kind: 'signed-out', message: `${picked.provider} is not signed in for ${spec.member}` };
+            }
+            const started = await ctx.request('agent', {
+                agentId,
+                sessionKey: spec.sessionKey,
+                message: spec.message,
+                idempotencyKey: randomUUID(),
+                ...(picked ?? {}),
+                ...(spec.system ? { extraSystemPrompt: spec.system } : {}),
+                ...(spec.images ? { attachments: spec.images.map((image) => ({ mimeType: image.mimeType, content: image.data })) } : {}),
+                ...(spec.thinking ? { thinking: spec.thinking } : {}),
+            });
+            runId = started.runId;
+            const result = await ctx.request('agent.wait', { runId, timeoutMs: WAIT_MS }, { timeoutMs: WAIT_CLIENT_MS });
+            if (result.status === 'ok') {
+                const text = typeof result.terminalReply?.text === 'string' ? result.terminalReply.text : last;
+                on?.({ type: 'text', text }); // the final cumulative text
+                return { ok: true, text };
+            }
+            if (result.stopReason === 'aborted' || (abortedByEngine && result.status !== 'ok'))
+                return { ok: false, aborted: true };
+            const message = typeof result.error === 'string' ? result.error
+                : typeof result.message === 'string' ? result.message : '';
+            return { ok: false, ...classify(message), message };
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            return { ok: false, ...classify(message), message };
+        }
+        finally {
+            ended = true;
+            unsubscribe();
+            if (registered)
+                ctx.bridge.unregister(spec.sessionKey);
+        }
+    };
+    return {
+        run,
+        steer: (k, t) => ctx.request('sessions.steer', { sessionKey: k, message: t }),
+        abort: (k) => ctx.request('chat.abort', { sessionKey: k }),
+    };
+}

package/dist/signin.d.ts

@@ -0,0 +1,24 @@
+import type { GatewayTransport, Member, SignInView } from './types.ts';
+export type SignInCtx = {
+    request: GatewayTransport['request'];
+    ensure(member: Member): Promise<{
+        agentId: string;
+    }>;
+    callbackPort: number;
+};
+/**
+ * Drive the engine's provider-owned login. `on` sees every view the person watches; `done` resolves once, and
+ * `paste` hands a returned browser address to a waiting wizard text step. Every exit short of done cancels this
+ * session and its callback listener only.
+ */
+export declare function signIn(ctx: SignInCtx, member: Member, o: {
+    authChoice: string;
+    via?: 'browser' | 'code';
+}, on: (v: SignInView) => void): {
+    paste(text: string): void;
+    cancel(): void;
+    done: Promise<SignInView>;
+};
+/** The providers this member's engine reports as signed in, from `models.authStatus` (a string or `{ provider }`). */
+export declare function providers(ctx: SignInCtx, member: Member, refresh?: boolean): Promise<string[]>;
+export declare function signOut(ctx: SignInCtx, member: Member, provider: string): Promise<void>;