@mininglamp-oss/octo-runtime-client 0.0.0-stage → 1.1.11

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Mininglamp Technology
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,39 @@
-# Temporary Holding Version
+# @mininglamp-oss/octo-runtime-client
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Standalone Node.js SDK for an **existing local Executor Kernel**. No CLI, server, Core, Provider Adapter or Extra is installed. Node.js 24 or 26 is required.
+
+```sh
+npm install @mininglamp-oss/octo-runtime-client
+```
+
+```ts
+import { attachKernel } from "@mininglamp-oss/octo-runtime-client";
+import type { InvokeInput } from "@mininglamp-oss/octo-runtime-client/protocol";
+
+// The host supplies an existing Unix socket or Windows named pipe endpoint.
+async function execute(endpoint: string, input: InvokeInput) {
+  const client = attachKernel({ endpoint });
+  try {
+    for await (const event of client.invoke({ ...input, protocol_mode: "canonical" })) {
+      console.log(event);
+    }
+  } finally {
+    // Close releases this client's connections; it does not stop the Kernel or cancel runs.
+    client.close();
+  }
+}
+```
+
+The root exports `attachKernel`, `KernelClient`, `KernelError`, `AsyncQuestionReply`, invocation lifecycle types and common protocol types. `/protocol` exports all shared public protocol types, constants and validators. `/protocol/browser` and `/protocol/notification` retain specialized protocol entrypoints. Raw schemas are available at `/protocol/schema.json`, `/protocol/ipc-schema.json`, `/protocol/ipc-fixtures.json` and `/protocol/behavior.json`. Schemas are copied from the authoritative private protocol package, which is bundled rather than independently published.
+
+`/internal` contains same-version Runtime composition helpers, including pure path validation and invocation bookkeeping. It is not a stable application API and does not construct services. Ordinary applications use the root API.
+
+`invoke` owns bounded call registration and observation recovery. Cancellation ACK is distinct from execution completion. Consumers must finish their own persistence/delivery work and explicitly cancel unwanted runs. Owners stop admission, drain their registered calls within a deadline, finish business cleanup, then close. `submit`/`subscribe` are advanced APIs whose callers manage their own run references, cancellation and observation. A lost ACK is queried using the original identity; execution and control actions with unknown outcomes are never automatically resubmitted.
+
+Both public npm packages are released from one stable tag with matching versions. The full Runtime bundles its own client and protocol under its internal node_modules, preserving single-archive offline installation. The standalone client bundles only the private protocol. Both use the same source implementation; neither requires downloading the other public artifact. Existing full SDK `/executor-kernel` and `/protocol` imports remain supported. Service creation, direct Core use and Extra construction require `@mininglamp-oss/octo-runtime`.
+
+Values and error classes are shared within each distribution. Installing both distributions may create separate module instances even at the same version: do not compare functions/classes across distributions or rely on cross-copy `instanceof` or invocation rejection evidence. Use the error class from the producing API, or inspect its public `code`. Client interfaces and protocol data remain structurally compatible.
+
+Package versions are distinct from IPC v1, Run 7, Context v3 and Adapter transport 2. Matching release pairs are supported. Cross-version attachment requires the same wire contracts and support for every field/method used; arbitrary older combinations are not guaranteed. There is no negotiation or compatibility translation. `status()` rejects unsupported IPC versions with `KERNEL_IPC_VERSION_UNSUPPORTED` and malformed status with `INVALID_RESPONSE`; submission uses that existing status query before writing an invocation. Existing RPC and frame validators report unsupported requests/frames; the client does not silently retry execution or downgrade. Schema provenance is the same tagged repository revision as the package, with build source recorded in build-info.json. This extraction does not add browser/network transport, remote authentication, Provider installation or Home initialization.
+
+中文：本包只连接宿主提供的本地 Kernel，不拥有服务。根入口提供客户端、错误、调用登记和旁路问题接口；`/protocol` 提供共享类型与校验，`/protocol/*.json` 提供原始 schema。完整 Runtime 原入口继续兼容。两个 npm 包从同一 tag 同版本发布，完整包内置 client/protocol，独立 client 仅内置 protocol；任一 tgz 均可单独离线安装。每个发行物内部共享错误与协议值；跨发行物可能是两个模块副本，不承诺 ===、instanceof 或 WeakSet 证据互认。npm 版本与 IPC/Run/Context 版本分别管理；跨版本须满足实际 wire 合同，无自动协商、降级或重放。取消回执不等于执行完成，关闭连接不取消 Run，业务收尾及服务生命周期始终归宿主。

package/build-info.json

@@ -0,0 +1,5 @@
+{
+  "commit": "780cd7cd5e67e4868df895a2e74a826097f349fd",
+  "dirty": false,
+  "buildTime": "2026-11-05T06:19:50.356Z"
+}

package/dist/async-question-reply.d.ts

@@ -0,0 +1,30 @@
+import { type AsyncQuestionReplySnapshot, type CanonicalEvent, type HostFrame, type InvokeEnvironment, type InvokeInput } from "@mininglamp-oss/octo-runtime-protocol";
+import { type KernelClient } from "./types.js";
+export type AsyncQuestionReplyResult = {
+    route: "steer";
+    acceptance: "provider_accepted";
+} | {
+    route: "new_run";
+    input: InvokeInput;
+    events: AsyncGenerator<CanonicalEvent>;
+};
+/**
+ * 宿主持有的一份旁路问题控制者，不拥有 Kernel 或数据库。
+ * 活动时 steer，确认正常完成后复用 invoke；宿主须串行管理同会话、
+ * 保存提交状态并消费新 Run 尾流。新流返回不代表 Provider 接纳。
+ */
+export declare class AsyncQuestionReply {
+    #private;
+    readonly client: KernelClient;
+    readonly continuation: () => InvokeInput;
+    readonly environment?: InvokeEnvironment | undefined;
+    constructor(client: KernelClient, snapshot: AsyncQuestionReplySnapshot, continuation: () => InvokeInput, environment?: InvokeEnvironment | undefined);
+    /** 独立 JSON 副本供宿主保存；恢复 submitting/unknown 不会再次投递。 */
+    snapshot(): AsyncQuestionReplySnapshot;
+    /** 只接受原源流事实；消息 final 或查不到 Run 不能证明正常完成。 */
+    observe(frame: HostFrame): void;
+    /** 关闭旁路，不中断模型；原活动交互同步关闭，未知响应不重试。 */
+    cancel(): Promise<void>;
+    /** 整批一次。steer 等待 Provider ACK；new_run 必须消费返回流，沿原 invoke 管理执行。 */
+    respond(value: unknown): Promise<AsyncQuestionReplyResult>;
+}

package/dist/async-question-reply.js

@@ -0,0 +1,199 @@
+import { randomUUID } from "node:crypto";
+import { assertCanonicalEvent, assertHostFrame, assertHostFrameIdentity, assertHostRunReceipt, assertInvokeInput, assertJsonValue, assertQuestionRequest, assertQuestionResponse, questionAnswerText } from "@mininglamp-oss/octo-runtime-protocol";
+import { KernelError } from "./types.js";
+/**
+ * 宿主持有的一份旁路问题控制者，不拥有 Kernel 或数据库。
+ * 活动时 steer，确认正常完成后复用 invoke；宿主须串行管理同会话、
+ * 保存提交状态并消费新 Run 尾流。新流返回不代表 Provider 接纳。
+ */
+export class AsyncQuestionReply {
+    client;
+    continuation;
+    environment;
+    #snapshot;
+    constructor(client, snapshot, continuation, environment) {
+        this.client = client;
+        this.continuation = continuation;
+        this.environment = environment;
+        assertJsonValue(snapshot);
+        if (snapshot.schema !== "octo.async-question-reply/v1" ||
+            !["pending", "submitting", "answered", "cancelled", "invalidated", "unknown"].includes(snapshot.phase) ||
+            typeof snapshot.completed !== "boolean" ||
+            snapshot.ref.protocol_mode !== "canonical" ||
+            snapshot.ref.protocol !== "codex.app-server" ||
+            snapshot.question.delivery !== "async" ||
+            snapshot.question.kind !== "question" ||
+            snapshot.question.executionInstanceId !== snapshot.ref.invocation_id ||
+            !snapshot.providerSession.sessionId ||
+            snapshot.providerSession.resumable === false)
+            throw new KernelError("INVALID_ASYNC_QUESTION_SNAPSHOT");
+        const { kernel_instance_id, ...receipt } = snapshot.ref;
+        if (!kernel_instance_id)
+            throw new KernelError("INVALID_ASYNC_QUESTION_SNAPSHOT");
+        assertHostRunReceipt(receipt);
+        assertCanonicalEvent({
+            protocolVersion: 2,
+            type: "interaction.requested",
+            payload: snapshot.question
+        });
+        assertQuestionRequest(snapshot.question.request);
+        this.#snapshot = structuredClone(snapshot);
+    }
+    /** 独立 JSON 副本供宿主保存；恢复 submitting/unknown 不会再次投递。 */
+    snapshot() {
+        return structuredClone(this.#snapshot);
+    }
+    /** 只接受原源流事实；消息 final 或查不到 Run 不能证明正常完成。 */
+    observe(frame) {
+        assertHostFrame(frame);
+        const { kernel_instance_id: _instance, ...receipt } = this.#snapshot.ref;
+        void _instance;
+        assertHostFrameIdentity(frame, receipt);
+        if (frame.kind === "control" && frame.control.type === "state") {
+            if (frame.control.state === "completed")
+                this.#snapshot.completed = true;
+            else if (["failed", "cancelled", "lost"].includes(frame.control.state))
+                this.#snapshot.phase = "invalidated";
+        }
+        if (frame.kind === "canonical" &&
+            frame.event.type === "interaction.resolved" &&
+            frame.event.payload.interactionId === this.#snapshot.question.interactionId) {
+            const payload = frame.event.payload;
+            this.#snapshot.phase =
+                payload.reasonCode === "provider_accepted"
+                    ? "answered"
+                    : payload.reasonCode === "submission_outcome_unknown"
+                        ? "unknown"
+                        : "invalidated";
+        }
+    }
+    /** 关闭旁路，不中断模型；原活动交互同步关闭，未知响应不重试。 */
+    async cancel() {
+        this.#assertPending();
+        this.#snapshot.phase = "cancelled";
+        if (!this.#snapshot.completed) {
+            try {
+                await this.client.respond(this.#snapshot.ref, {
+                    interactionId: this.#snapshot.question.interactionId,
+                    outcome: "cancelled"
+                });
+            }
+            catch (error) {
+                if (!(error instanceof KernelError) || error.code !== "INTERACTION_NOT_ACTIVE")
+                    throw error;
+            }
+        }
+    }
+    /** 整批一次。steer 等待 Provider ACK；new_run 必须消费返回流，沿原 invoke 管理执行。 */
+    async respond(value) {
+        this.#assertPending();
+        const original = this.#snapshot;
+        assertQuestionRequest(original.question.request);
+        const answer = structuredClone(value);
+        assertQuestionResponse(answer);
+        const text = questionAnswerText(original.question.request, answer);
+        const next = structuredClone(this.continuation());
+        assertInvokeInput(next);
+        // 现有会话由宿主显式提供，旧题不能跨 reset 或 Provider binding 改投。
+        if (next.sessionId !== original.ref.agent_session_id ||
+            (next.sessionGeneration ?? 0) !== original.ref.session_generation ||
+            next.providerSession?.sessionId !== original.providerSession.sessionId ||
+            next.providerSession?.resumable === false ||
+            next.providerEpoch !== original.providerEpoch)
+            throw new KernelError("ASYNC_QUESTION_SESSION_STALE");
+        original.phase = "submitting";
+        let attempted = false;
+        try {
+            if (!original.completed) {
+                const current = await this.client.get(original.ref, original.ref.kernel_instance_id);
+                if (current.terminal)
+                    this.observe(current.terminal);
+                if (this.snapshot().phase === "invalidated")
+                    throw new KernelError("INTERACTION_NOT_ACTIVE");
+            }
+            if (!original.completed) {
+                attempted = true;
+                try {
+                    this.#assertNotExpired();
+                    await this.client.respond(original.ref, {
+                        interactionId: original.question.interactionId,
+                        outcome: "answered",
+                        value: answer
+                    });
+                    original.phase = "answered";
+                    return { route: "steer", acceptance: "provider_accepted" };
+                }
+                catch (error) {
+                    if (!(error instanceof KernelError) ||
+                        !["INTERACTION_NOT_ACTIVE", "ASYNC_ANSWER_REJECTED"].includes(error.code))
+                        throw error;
+                    // 仅明确未接纳才可在正常终态之后续跑；ACK 丢失和写后失联绝不进入此分支。
+                    attempted = false;
+                    const current = await this.client.get(original.ref, original.ref.kernel_instance_id);
+                    if (current.terminal)
+                        this.observe(current.terminal);
+                    if (!original.completed) {
+                        original.phase = "invalidated";
+                        throw error;
+                    }
+                }
+            }
+            const input = {
+                ...next,
+                runId: randomUUID(),
+                invocationId: randomUUID(),
+                protocol_mode: "canonical",
+                continuityMode: "continue",
+                inputs: [{ type: "text", text }],
+                prompt: text,
+                modelInput: text,
+                providerSession: { ...original.providerSession, requireResume: true },
+                freshFallbackModelInput: text,
+                freshFallbackModelInputParts: [{ type: "text", text }]
+            };
+            const client = this.client, environment = this.environment;
+            const beforeInvoke = () => {
+                this.#assertNotExpired();
+                const currentInput = this.continuation();
+                if (currentInput.sessionId !== input.sessionId ||
+                    (currentInput.sessionGeneration ?? 0) !== original.ref.session_generation ||
+                    currentInput.providerSession?.sessionId !== original.providerSession.sessionId ||
+                    currentInput.providerEpoch !== original.providerEpoch)
+                    throw new KernelError("ASYNC_QUESTION_SESSION_STALE");
+            };
+            const events = (async function* () {
+                try {
+                    beforeInvoke();
+                    for await (const event of client.invoke(input, environment)) {
+                        if (event.type === "session.update" &&
+                            event.payload.providerSession?.sessionId === original.providerSession.sessionId &&
+                            event.payload.providerSession.resumeOutcome === "resumed")
+                            original.phase = "answered";
+                        yield event;
+                    }
+                }
+                finally {
+                    if (original.phase === "submitting")
+                        original.phase = "unknown";
+                }
+            })();
+            return { route: "new_run", input: structuredClone(input), events };
+        }
+        catch (error) {
+            if (original.phase === "submitting")
+                original.phase = attempted ? "unknown" : "pending";
+            throw error;
+        }
+    }
+    #assertPending() {
+        const snapshot = this.#snapshot;
+        if (snapshot.phase !== "pending")
+            throw new KernelError("INTERACTION_NOT_ACTIVE");
+        this.#assertNotExpired();
+    }
+    #assertNotExpired() {
+        const expiresAt = this.#snapshot.question.expiresAt;
+        if (expiresAt !== undefined && Date.parse(expiresAt) <= Date.now())
+            throw new KernelError("INTERACTION_NOT_ACTIVE");
+    }
+}

package/dist/browser.d.ts

@@ -0,0 +1 @@
+export * from "@mininglamp-oss/octo-runtime-protocol/browser";

package/dist/browser.js

@@ -0,0 +1 @@
+export * from "@mininglamp-oss/octo-runtime-protocol/browser";

package/dist/client.d.ts

@@ -0,0 +1,10 @@
+import { type KernelClient } from "./types.js";
+/**
+ * 连接本机 socket/Windows Pipe，返回不拥有 Kernel 进程的客户端。
+ * 独立应用显式连接已有服务；原生 SDK 服务宿主使用 kernel.client。
+ * Kernel/Extra 服务内部也复用本函数构造 RPC 客户端，不要求 SDK 调用方额外 attach。
+ * invoke 提供登记、取消和尾流观察；关闭连接或迭代器不会隐式取消已接纳 Run。
+ */
+export declare function attachKernel(options: {
+    endpoint: string;
+}): KernelClient;