@anureo/adapter-hermes 0.0.0-stage → 0.3.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 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 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 those 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Yoichi
+
+   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/package.json

@@ -1,6 +1,47 @@
 {
   "name": "@anureo/adapter-hermes",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "description": "Anureo SDK adapter for the Hermes canonical TUI gateway",
+  "version": "0.3.0",
+  "license": "Apache-2.0",
+  "keywords": [
+    "anureo",
+    "ahp",
+    "hermes",
+    "agent",
+    "gateway"
+  ],
+  "homepage": "https://github.com/hi-youichi/anureo-sdk#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hi-youichi/anureo-sdk.git",
+    "directory": "packages/adapter/hermes"
+  },
+  "bugs": {
+    "url": "https://github.com/hi-youichi/anureo-sdk/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "import": "./src/index.js",
+      "default": "./src/index.js"
+    }
+  },
+  "dependencies": {
+    "@anureo/protocol": "0.3.0",
+    "@anureo/sdk": "0.3.0"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "files": [
+    "src",
+    "bin",
+    "schema",
+    "protocol",
+    "examples"
+  ]
+}

package/protocol/provenance.json

@@ -0,0 +1,15 @@
+{
+  "repository": "https://github.com/NousResearch/hermes-agent",
+  "release": "v0.23.1",
+  "commit": "3b421578588243f920886e6fe79a6faa87ea026e",
+  "protocol": "hermes-gateway-v1",
+  "sources": [
+    "hermes_cli/gateway_runtime_cli.py",
+    "tui_gateway/contracts/canonical.py",
+    "tui_gateway/contracts/canonical_sessions.py",
+    "gateway/session_controls.py",
+    "gateway/session_pending_controls.py",
+    "gateway/session_server_requests.py",
+    "gateway/session_settlement_recovery.py"
+  ]
+}

package/src/attach.d.ts

@@ -0,0 +1,29 @@
+import type { HermesAdapterOptions } from "./options.js";
+/** Validated CLI evidence for one local WebSocket connection. */
+export interface GatewayGrant {
+    url: string;
+    /** Wire protocol followed by the credential subprotocol. Keep private and mint a fresh grant for each retry. */
+    protocols: string[];
+    profileId: string;
+    instanceId: string;
+    /** Owner code hash when supplied, otherwise the wire protocol version. */
+    version: string;
+}
+/** CLI owner policy. Attach uses an existing owner, start ensures one, and recover requests owner recovery. */
+export type AttachMode = 'start' | 'attach' | 'recover';
+/**
+ * Mint a fresh local gateway ticket through the same-user CLI. HermesAdapter.probeRuntime and
+ * HermesSession.connect await this before opening a socket; failures prevent that connection.
+ * Resolve after stdout EOF, successful exit, grant validation, child disposal and stderr drain.
+ * A pre-aborted signal prevents spawning. While awaiting the grant, abort rejects with
+ * RUNTIME_DISPOSED and timeout rejects with retryable HARNESS_UNAVAILABLE. Both dispose the child.
+ * Spawn or cleanup failures can propagate directly. Attach submits no work and the caller owns
+ * the subsequent WebSocket.
+ */
+export declare function attachGateway(options: HermesAdapterOptions, mode: AttachMode, signal?: AbortSignal): Promise<GatewayGrant>;
+/**
+ * Validate the CLI's canonical local endpoint, owner identity and matching ticket subprotocols.
+ * attachGateway returns this grant for connection; malformed data throws PROTOCOL_ERROR and
+ * differing client/owner code hashes throw HERMES_GATEWAY_CODE_MISMATCH without exposing tickets.
+ */
+export declare function validateGrant(value: unknown): GatewayGrant;

package/src/attach.js

@@ -0,0 +1,150 @@
+import { HarnessSdkError } from '@anureo/sdk';
+import { spawnHarnessProcess } from '@anureo/sdk/process';
+import { array, GATEWAY_PROTOCOL, identity, object, protocolError } from "./native.js";
+/**
+ * Mint a fresh local gateway ticket through the same-user CLI. HermesAdapter.probeRuntime and
+ * HermesSession.connect await this before opening a socket; failures prevent that connection.
+ * Resolve after stdout EOF, successful exit, grant validation, child disposal and stderr drain.
+ * A pre-aborted signal prevents spawning. While awaiting the grant, abort rejects with
+ * RUNTIME_DISPOSED and timeout rejects with retryable HARNESS_UNAVAILABLE. Both dispose the child.
+ * Spawn or cleanup failures can propagate directly. Attach submits no work and the caller owns
+ * the subsequent WebSocket.
+ */
+export async function attachGateway(options, mode, signal) {
+    if (signal?.aborted)
+        throw new HarnessSdkError('RUNTIME_DISPOSED');
+    const args = attachArguments(options, mode);
+    const child = await (options.processFactory ?? spawnHarnessProcess)({
+        command: options.command ?? 'hermes',
+        args,
+        env: options.env,
+    });
+    const stderr = drainAttachStderr(child.stderr, options);
+    try {
+        return await waitForGrant(child, options.timeoutMs ?? 30_000, signal);
+    }
+    catch (cause) {
+        // Attach has not submitted any work, even when its read/validation fails.
+        if (cause instanceof HarnessSdkError)
+            throw new HarnessSdkError(cause.code, cause.message, cause.retryable, false);
+        throw new HarnessSdkError('PROTOCOL_ERROR', 'Invalid Hermes attach response');
+    }
+    finally {
+        await child.dispose();
+        await stderr;
+    }
+}
+/**
+ * Validate the CLI's canonical local endpoint, owner identity and matching ticket subprotocols.
+ * attachGateway returns this grant for connection; malformed data throws PROTOCOL_ERROR and
+ * differing client/owner code hashes throw HERMES_GATEWAY_CODE_MISMATCH without exposing tickets.
+ */
+export function validateGrant(value) {
+    const data = object(value);
+    const endpoint = object(data.endpoint);
+    if (!['ready', 'draining'].includes(String(data.state)) || data.protocol !== GATEWAY_PROTOCOL)
+        throw protocolError();
+    if (typeof data.client_code_sha === 'string' && typeof endpoint.code_sha === 'string' && data.client_code_sha !== endpoint.code_sha) {
+        throw new HarnessSdkError('HERMES_GATEWAY_CODE_MISMATCH', 'Hermes gateway must be updated or restarted by its owner');
+    }
+    const address = gatewayAddress(data.url);
+    const protocols = array(data.protocols).map(identity);
+    const ticket = identity(data.ticket);
+    if (protocols.length !== 2 || protocols[0] !== data.protocol || protocols[1] !== `hermes-gateway-ticket.${ticket}`)
+        throw protocolError();
+    return {
+        url: address.href,
+        protocols,
+        profileId: identity(endpoint.profile_id),
+        instanceId: identity(endpoint.instance_id),
+        version: typeof endpoint.code_sha === 'string' ? endpoint.code_sha : GATEWAY_PROTOCOL,
+    };
+}
+/** Leave owner policy implicit for attach-only and round up for the CLI's whole-second timeout. */
+function attachArguments(options, mode) {
+    return [
+        ...(options.args ?? []),
+        ...(options.profile ? ['-p', options.profile] : []),
+        'gateway', 'attach', '--json',
+        ...(mode === 'attach' ? [] : [`--${mode}`]),
+        '--timeout', String(Math.max(1, Math.ceil((options.timeoutMs ?? 30_000) / 1000))),
+    ];
+}
+/** Drain stderr concurrently so the CLI cannot block on its pipe; report only a fixed code and ignore drain failures. */
+async function drainAttachStderr(stderr, options) {
+    try {
+        for await (const chunk of stderr)
+            if (chunk.byteLength)
+                options.diagnostic?.('HERMES_ATTACH_STDERR');
+    }
+    catch { /* Protocol stdout and process exit determine the outcome. */ }
+}
+/** Race the response against attach cancellation, removing the timer/listener before the caller disposes the child. */
+async function waitForGrant(child, timeoutMs, signal) {
+    let timer;
+    let abort;
+    try {
+        return await Promise.race([
+            readAttachGrant(child),
+            new Promise((_, reject) => {
+                timer = setTimeout(() => reject(new HarnessSdkError('HARNESS_UNAVAILABLE', 'Hermes gateway attach timed out', true)), timeoutMs);
+            }),
+            new Promise((_, reject) => {
+                abort = () => reject(new HarnessSdkError('RUNTIME_DISPOSED'));
+                signal?.addEventListener('abort', abort, { once: true });
+                if (signal?.aborted)
+                    abort();
+            }),
+        ]);
+    }
+    finally {
+        clearTimeout(timer);
+        if (abort)
+            signal?.removeEventListener('abort', abort);
+    }
+}
+/** Read at most 64 KiB of strict UTF-8 through EOF before trusting a successful CLI exit and parsing its grant. */
+async function readAttachGrant(child) {
+    const decoder = new TextDecoder('utf-8', { fatal: true });
+    let output = '';
+    let bytes = 0;
+    for await (const chunk of child.stdout) {
+        bytes += chunk.byteLength;
+        if (bytes > 64 * 1024)
+            throw new HarnessSdkError('FRAME_TOO_LARGE');
+        output += decoder.decode(chunk, { stream: true });
+    }
+    output += decoder.decode();
+    assertAttachExit(await child.exited);
+    let result;
+    try {
+        result = JSON.parse(output);
+    }
+    catch {
+        throw protocolError();
+    }
+    return validateGrant(result);
+}
+/** Reject unsuccessful CLI exits using safe messages. Only exit 5 represents a retryable failure. */
+function assertAttachExit({ code }) {
+    if (code === 0)
+        return;
+    if (code === 2)
+        throw new HarnessSdkError('HERMES_GATEWAY_UNSUPPORTED', 'Hermes gateway attach is required');
+    const failure = code === 3 ? 'HERMES_GATEWAY_UNSUPPORTED' : code === 4 ? 'AUTHORIZATION_FAILED' : 'HARNESS_UNAVAILABLE';
+    throw new HarnessSdkError(failure, 'Hermes gateway attach failed', code === 5);
+}
+/** Keep tickets on the loopback WebSocket path and out of URL credentials, query strings and fragments. */
+function gatewayAddress(value) {
+    let address;
+    try {
+        address = new URL(identity(value));
+    }
+    catch {
+        throw protocolError();
+    }
+    if (!['ws:', 'wss:'].includes(address.protocol) || !['127.0.0.1', '[::1]', 'localhost'].includes(address.hostname)
+        || address.username || address.password || address.search || address.hash || address.pathname !== '/api/ws')
+        throw protocolError();
+    return address;
+}

package/src/events.d.ts

@@ -0,0 +1,87 @@
+import { type SessionEventSink } from '@anureo/sdk';
+import { type NativeEvent, type NativeObject } from "./native.js";
+import type { HermesAdapterOptions } from "./options.js";
+/**
+ * Publish cumulative session usage for HermesSession.apply and terminal turn projection.
+ * Omit nonfinite or negative counters and await sink publication.
+ */
+export declare function sessionUsage(sink: SessionEventSink, payload: NativeObject): Promise<void>;
+/**
+ * Internal execution projection created by HermesSession.turn. Publish ordered SDK items through
+ * its sink, retaining bounded provisional state until native terminal evidence arrives. Native
+ * snapshots complete items; deltas only describe provisional progress. Sink failures reject to the
+ * session's receipt or event path; the session owns recovery and channel disposal.
+ */
+export declare class HermesTurn {
+    /** SDK identity shared by submission bindings, events and interrupt targeting. */
+    readonly id: string;
+    /** Durable native admission used to reconcile this execution after reconnect. */
+    readonly admissionId: string;
+    /** Native authority paired with generation; HermesSession checks both when reusing this execution. */
+    readonly epoch: number;
+    /** Native execution generation within this authority, used to fence interrupt requests. */
+    readonly generation: number;
+    /** Set before publishing turn/started to suppress duplicate starts during association and event delivery. */
+    started: boolean;
+    /** Set before turn/completed publication. HermesSession uses it to stop treating this turn as active. */
+    terminal: boolean;
+    /** Set with terminal evidence before turn/completed publication, and retained after item content is released. */
+    status?: TerminalStatus;
+    /** Accept validated native execution identity and derive a local turn id stable across replay. */
+    constructor({ admissionId, epoch, generation, sessionId, sink, options }: {
+        admissionId: string;
+        epoch: number;
+        generation: number;
+        sessionId: string;
+        sink: SessionEventSink;
+        options: HermesAdapterOptions;
+    });
+    /** Publish turn/started at most once, before any binding or item publication. */
+    start(): Promise<void>;
+    /** HermesSession.associate binds native-claimed input once; late binding of a terminal turn adds no user item. */
+    bind(submissionId: string, input: string): Promise<void>;
+    /** Report incomplete progress once and stop appending to the current partial segment; native snapshots can still replace its text. */
+    gap(): Promise<void>;
+    /** Project the event supplied by HermesSession.applyTurnEvent. Ignore terminal replays and reject malformed payloads or sink failures. */
+    apply(event: NativeEvent): Promise<void>;
+    /**
+     * HermesSession.associate supplies receipt-only terminal evidence after reconnect or submit.
+     * Mark unavailable intermediate progress, then publish the final response; unsupported outcomes or
+     * non-string final_response reject as protocol errors. Missing final_response means empty text.
+     */
+    fromReceipt(result: NativeObject, outcome: string | null): Promise<void>;
+    private readonly items;
+    private readonly completed;
+    private readonly submissions;
+    private segment;
+    private current?;
+    private lastText;
+    private reasoning;
+    private bytes;
+    private gapReported;
+    /** Replace streamed commentary with the native snapshot and seal the segment unless it is stale. */
+    private messageInterim;
+    /** Retain the accumulated reasoning summary while publishing only the new chunk as a delta. */
+    private reasoningDelta;
+    /**
+     * Project both tool phases under one native identity. Ignore duplicate starts, retain prior input
+     * when completion omits it, and convert native duration seconds to SDK milliseconds.
+     */
+    private toolEvent;
+    /** Require a recognized terminal status. Use retained text only when both native text fields are absent or null. */
+    private messageComplete;
+    /** Retain a detached item within count/byte budgets and publish item/started only on first appearance. */
+    private put;
+    /** Publish item completion at most once per id, starting an unseen item first. */
+    private complete;
+    /** Seal the current commentary segment and retain its text as the fallback when a terminal frame omits text. */
+    private commentary;
+    /** Reconcile UTF-16 text offsets within a commentary segment; conflicting overlap rejects and a missing prefix marks a gap. */
+    private messageDelta;
+    /** Complete final/reasoning items before terminal publication, flag unfinished native items and release retained content after success. */
+    private finish;
+    private readonly sink;
+    private readonly options;
+}
+type TerminalStatus = 'completed' | 'interrupted' | 'failed';
+export {};