@harapter/adapter-openclaw 0.1.1

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 Harapter contributors
+
+   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

@@ -0,0 +1,229 @@
+# `@harapter/adapter-openclaw`
+
+`@harapter/adapter-openclaw` maps the official `openclaw acp` stdio bridge to
+the portable Harapter lifecycle.
+
+The host installs, configures, authenticates, and operates OpenClaw and its
+Gateway. Harapter starts only the exact adapter-owned command selected by the
+Profile. It does not install an OpenClaw Runtime or SDK, configure models or
+tools, manage Gateway credentials, or change host security policy.
+
+## Installation
+
+```bash
+pnpm add @harapter/core@next @harapter/adapter-openclaw@next
+```
+
+## Runtime prerequisites and compatibility
+
+Connection requires the stable ACP v1 wire contract and an initialize response
+whose implementation name is `openclaw-acp`. Session create, resume, close,
+prompt content, and image support are derived from the validated handshake.
+Approval remains `unknown` until the connected bridge sends a valid permission
+request. The runtime release is not pinned; a non-sensitive hash participates in
+diagnostics, while incompatible protocol or required response shapes fail
+closed.
+
+The fixture manifest records the current upstream source revision inspected for
+the evidence baseline. That revision is provenance, not a runtime allowlist.
+OpenClaw is MIT licensed; Harapter does not redistribute it. See the
+[license record](../../licenses/openclaw.md).
+
+## Profile and process ownership
+
+An OpenClaw Profile uses an adapter-owned process. The normal command shape is:
+
+```ts
+import { HarnessRegistry, profileId } from '@harapter/core';
+import {
+  OPENCLAW_PROVIDER_ID,
+  createOpenClawProviderFactory,
+} from '@harapter/adapter-openclaw';
+
+const registry = new HarnessRegistry();
+registry.register(createOpenClawProviderFactory());
+
+const client = await registry.connect({
+  profileId: profileId('openclaw-local'),
+  providerId: OPENCLAW_PROVIDER_ID,
+  displayName: 'OpenClaw',
+  connection: {
+    kind: 'process',
+    command: 'openclaw',
+    args: ['acp'],
+    ownership: 'adapter',
+  },
+});
+```
+
+The host may select another exact executable path or working directory. Shell
+execution, unresolved `envRefs`, external process ownership, and OpenClaw
+session-routing arguments are rejected. The adapter does not inspect or
+interpolate environment entries, but the child process inherits the
+host-controlled process environment. OpenClaw may use that environment for
+Gateway authentication, and the host remains responsible for its contents.
+
+Profile `providerOptions` accepts positive bounded values for
+`operationTimeoutMs`, `requestTimeoutMs`, `cancelSettlementTimeoutMs`,
+`maxRunEvents`, `maxBufferedEvents`, `maxBufferedMessages`, `maxMessageBytes`,
+`maxPendingRequests`, `maxPendingInboundRequests`, and `maxPendingWrites`.
+Unknown options are rejected. `maxRunEvents` must be between 2 and 4096 so an
+unread Run queue always reserves terminal capacity.
+
+## Session and Run lifecycle
+
+`createSession()` generates an explicit isolated `acp-bridge:harapter-...`
+Gateway session key and passes it through ACP metadata. The native ACP Session
+identifier, working directory, routing strategy, and session key remain bound to
+the Provider and Profile in `SessionRef`. `resumeSession()` requires the same
+Provider, Profile, compatibility reference, native identifier, and isolated
+route state, then asks OpenClaw to require the existing Gateway Session. A
+Session reference is not portable to another Provider or Profile.
+
+ACP accepts the Session working directory, but current evidence does not prove
+that Gateway tool execution uses it. `session.workspace` therefore remains
+`unknown` until an opt-in live Run verifies the effective execution directory.
+Active and in-flight native Session identifiers are reserved per connection.
+Closing enters a local `closing` state before the native request, blocks new
+Runs and approval responses, and reopens only when the close attempt fails.
+
+The Adapter deliberately permits one active Run per ACP connection. Typed
+Session updates contain a Session identifier, but unknown ACP observations do
+not provide a route that can safely distinguish concurrent Runs. The
+connection-wide bound keeps unknown events observable without guessing their
+owner.
+
+Portable Runs accept non-empty text and handshake-advertised image references.
+Harapter sends image URIs as ACP resource links and never reads the referenced
+file. Generic file references, Provider-native input parts, Run metadata, and
+Run Provider options remain unsupported.
+
+Message, reasoning, tool lifecycle, usage, and approval observations map to
+portable events. Tool identifiers are hashed and tool input or output is never
+retained in portable events. The validated ACP prompt response is the only Run
+terminal authority:
+
+- `end_turn` maps to `run.completed`;
+- `cancelled` maps to `run.cancelled`;
+- `refusal`, `max_tokens`, and `max_turn_requests` map to `run.failed`;
+- malformed or unknown stop reasons fail closed;
+- EOF, process loss, Client close, queue overflow, or unconfirmed cancellation
+  maps to `connection.aborted`;
+- a local ACP wait ending before an authoritative prompt or Session mutation
+  response aborts the owning connection and never releases it for reuse.
+
+The transport and ACP client use an inbound wire-order barrier so every update
+received before the terminal response finishes Adapter handling first. Messages
+received after that response cannot append to or rewrite the terminal Run.
+
+## Cancellation, timeout, and approval
+
+`run.cancel()` sends native ACP `session/cancel`, but reports
+`{ mode: 'native' }` only after the authoritative prompt response is
+`cancelled`. A successful notification write alone is not cancellation evidence.
+Missing confirmation, process loss, or cancellation write failure aborts the
+connection instead.
+
+Session create, resume, close, and prompt operations can mutate remote state.
+When their local ACP timeout or abort ends the wait before an authoritative
+response, the Adapter closes the connection, preserves any closing Session as
+unsafe, and reports connection abort rather than a recoverable operation
+failure.
+
+A positive `RunOptions.timeoutMs` starts a local timer that requests the same
+native cancellation. It is reported as emulated timeout control because the
+timer is Harapter-owned, while the final `cancelled` status still requires
+Provider evidence. Closing a Client or Session is never presented as native Run
+cancellation.
+
+Valid `session/request_permission` requests map to portable approval
+interactions. Approval and denial select only choices explicitly offered by the
+Provider. Portable decisions default only to matching one-time choices;
+persistent choices require an explicit, decision-compatible Provider option ID.
+Pending approvals settle as cancelled when their Run or connection terminates.
+Since ACP initialization does not advertise permission support, the capability
+changes from `unknown` to `native` only after a valid request is observed on the
+active connection.
+
+## Unknown events, extension, and native access
+
+Unknown ACP notifications, requests, and future Session update discriminators
+remain observable as `provider` events and through `openclaw.acp.observations`.
+The observation channel bounds depth and collection size, hashes arbitrary
+strings and identifiers, and does not retain prompt, file, credential,
+environment, or tool content. Unknown observations never produce terminal
+success.
+
+`client.native()` returns an `OpenClawNativeClient` with the non-sensitive
+runtime identity, explicitly namespaced ACP extension requests and
+notifications, and unknown-event observation. Native extensions remain outside
+portable lifecycle, capability, redaction, and compatibility guarantees.
+
+## Evidence and limitations
+
+Evidence for this supported ACP v1 Adapter includes:
+
+- deterministic synthetic handshake, completion, permission, and unknown-event
+  fixtures in
+  [`fixtures/openclaw/acp-current`](../../fixtures/openclaw/acp-current/manifest.json);
+- mapping, ownership, resume, cancellation, timeout, approval, disconnect,
+  malformed-terminal, event-bound, process cleanup, native-access, and Provider
+  negative tests;
+- the shared portable Provider conformance suite;
+- an opt-in live lifecycle test for a host-installed authenticated bridge; and
+- a trusted live canary that installs the current OpenClaw release on an
+  ephemeral runner and is configured to exercise runtime probing, the ACP
+  handshake, isolated Session creation, a completed Run, Client reconnection,
+  Session resume, native cancellation, authoritative terminal results, Session
+  close, and Client disposal.
+
+The [repository-recorded live lifecycle run][openclaw-live-2026-09-03] passed on
+2026-09-03 with `openclaw@2026.8.2`. It verified current-package installation,
+version probing, generated configuration validation, Gateway health, the ACP
+handshake, isolated Session creation, exact completed text content,
+`run.started`, `message.completed`, and authoritative `run.completed` Events. It
+then closed the first ACP Client, opened a new bridge connection, resumed the
+same isolated Gateway Session, and verified native cancellation with an
+authoritative `run.cancelled` terminal. The resumed Session and both Clients
+were disposed, and no model-facing tools or approval interactions were observed.
+A production host may pin that release for reproducibility. Harapter continues
+to admit newer releases and validates their ACP identity and observed structures
+instead of using the recorded version as an executable allowlist.
+
+Run live verification only when submitting two synthetic text Prompts through a
+host-operated Gateway is acceptable to the host:
+
+```bash
+HARAPTER_OPENCLAW_LIVE=1 \
+HARAPTER_OPENCLAW_COMMAND="$(command -v openclaw)" \
+pnpm vitest run providers/openclaw/test/live.test.ts
+```
+
+The live test sends one exact-response Prompt, closes its first ACP Client,
+opens a new bridge connection, resumes the same isolated Gateway Session, and
+submits a second long-response Prompt for immediate native cancellation. It logs
+no Provider traffic, requires authoritative `run.completed` and `run.cancelled`
+terminals, and rejects every tool or approval Event. A skipped or failed live
+test is not support evidence. The scheduled canary uses a generated, text-only
+model route with OpenClaw's model tool support disabled, disables model catalog
+refresh, plugins, browser automation, MCP, channels, cron, heartbeat, telemetry,
+auditing, and shell environment loading, and retains no Runtime state or logs
+after its ephemeral job ends. The model credential is an environment-backed
+SecretRef resolved by the isolated Gateway and is removed before the Harapter
+test process starts the ACP bridge. The bridge also omits the temporary
+working-directory prefix from the Prompt.
+
+The recorded live lifecycle above proves the supported ACP v1 completed text
+Run, isolated Session resume, and native cancellation paths. Approval, image
+input, and effective workspace execution remain live-unverified. Those
+capabilities retain their documented `native`, `unknown`, or unsupported status
+according to deterministic protocol evidence; hosts that depend on an unverified
+capability should run focused live evidence before production use.
+
+Shared Gateway session routing, history replay, per-Session MCP configuration,
+audio input, generic file input, filesystem or terminal client services,
+verified Gateway workspace execution, automatic process restart, and direct
+Gateway WebSocket access are outside the current compatibility boundary.
+
+[openclaw-live-2026-09-03]:
+  https://github.com/yunfeizhu/harapter/actions/runs/33740322290

package/dist/adapter.d.ts

@@ -0,0 +1,31 @@
+import { type ProviderAdapterFactory } from '@harapter/core';
+/** Connection limits accepted in an OpenClaw Profile's providerOptions. */
+export interface OpenClawProfileOptions {
+    readonly cancelSettlementTimeoutMs?: number;
+    readonly maxBufferedEvents?: number;
+    readonly maxBufferedMessages?: number;
+    readonly maxMessageBytes?: number;
+    readonly maxPendingInboundRequests?: number;
+    readonly maxPendingRequests?: number;
+    readonly maxPendingWrites?: number;
+    readonly maxRunEvents?: number;
+    readonly operationTimeoutMs?: number;
+    readonly requestTimeoutMs?: number;
+}
+/** Provider extension for observing bounded, redacted ACP observations. */
+export interface OpenClawObservationExtension {
+    onObservation(listener: (event: unknown) => void): () => void;
+}
+/** Explicit Provider-native access to namespaced ACP extensions. */
+export interface OpenClawNativeClient {
+    readonly runtimeIdentity: string;
+    requestExtension<TResult = unknown>(method: string, params?: unknown, options?: Readonly<{
+        signal?: AbortSignal;
+        timeoutMs?: number;
+    }>): Promise<TResult>;
+    notifyExtension(method: string, params?: unknown): Promise<void>;
+    onUnknownEvent(listener: (event: unknown) => void): () => void;
+}
+/** Create a fresh OpenClaw ACP Provider Adapter factory. */
+export declare function createOpenClawProviderFactory(): ProviderAdapterFactory;
+//# sourceMappingURL=adapter.d.ts.map

package/dist/adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":"AAMA,OAAO,EAmBL,KAAK,sBAAsB,EAQ5B,MAAM,gBAAgB,CAAC;AAkDxB,2EAA2E;AAC3E,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAC5C,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACpC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IACtC,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAC5C,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IACrC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IACrC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;CACpC;AAED,2EAA2E;AAC3E,MAAM,WAAW,4BAA4B;IAC3C,aAAa,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;CAC/D;AAED,oEAAoE;AACpE,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,gBAAgB,CAAC,OAAO,GAAG,OAAO,EAChC,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,OAAO,EAChB,OAAO,CAAC,EAAE,QAAQ,CAAC;QAAE,MAAM,CAAC,EAAE,WAAW,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,GAC/D,OAAO,CAAC,OAAO,CAAC,CAAC;IACpB,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACjE,cAAc,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;CAChE;AA2BD,4DAA4D;AAC5D,wBAAgB,6BAA6B,IAAI,sBAAsB,CAQtE"}