@harapter/adapter-opencode 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,159 @@
+# `@harapter/adapter-opencode`
+
+`@harapter/adapter-opencode` maps the current documented stable `opencode serve`
+HTTP/OpenAPI and Server-Sent Events interface to Harapter Core.
+
+The host installs, configures, authenticates, starts, and stops OpenCode. The
+Adapter connects only to a host-selected HTTP endpoint and never invokes a
+runtime installation, server disposal, or Session deletion route implicitly.
+
+## Installation
+
+```bash
+pnpm add @harapter/core@next @harapter/adapter-opencode@next
+```
+
+## Profile and authentication
+
+OpenCode uses an `endpoint` Profile with `transport: 'http'` and
+`ownership: 'host'` or `ownership: 'external'`:
+
+```ts
+import { profileId } from '@harapter/core';
+import {
+  OPENCODE_PROVIDER_ID,
+  createOpenCodeProviderFactory,
+} from '@harapter/adapter-opencode';
+
+const factory = createOpenCodeProviderFactory({
+  resolveAuthHeaders: async (reference) => headersFor(reference),
+});
+
+const client = await factory.connect({
+  profileId: profileId('opencode-local'),
+  providerId: OPENCODE_PROVIDER_ID,
+  displayName: 'OpenCode',
+  connection: {
+    kind: 'endpoint',
+    url: 'http://127.0.0.1:4096/',
+    transport: 'http',
+    ownership: 'external',
+    authRef: { scheme: 'host-secret-store', id: 'opencode-server' },
+  },
+});
+```
+
+`authRef` is optional. When present, the host must provide `resolveAuthHeaders`;
+Harapter never resolves, logs, persists, or returns the header values.
+OpenCode's server password, username, and other authentication configuration
+remain outside the Adapter.
+
+Profile `providerOptions` accepts positive bounded values for
+`requestTimeoutMs`, `sseConnectTimeoutMs`, `runRequestTimeoutMs`,
+`cancelSettlementTimeoutMs`, `eventDrainTimeoutMs`, and `maxRunEvents`. Unknown
+options are rejected. `maxRunEvents` must be between 2 and 4096 so the bounded
+queue always reserves terminal capacity.
+
+## Session lifecycle
+
+- `createSession()` calls the documented Session creation route. A portable file
+  workspace URI becomes the OpenCode `directory` query.
+- OpenCode selects an instance by directory. The returned directory, portable
+  system context, and model selection are retained in the provider-bound
+  `SessionRef` so resume and subsequent prompts use the same configuration.
+- A model selection uses the native model ID plus
+  `model.providerOptions.providerId`.
+- `resumeSession()` validates Provider, Profile, stable interface identity,
+  directory state, directory-scoped runtime status, remote Session ID, and
+  returned directory before exposing an idle resumed Session. Busy or retrying
+  Sessions are not resumed.
+- `session.close()` releases only the local handle. It does not call OpenCode's
+  DELETE route, which deletes the Session and its data.
+
+## Run and event lifecycle
+
+One Run may be active per OpenCode Session. The Adapter opens the directory
+event stream before posting a synchronous Session message, then maps assistant
+text, reasoning, tool, artifact, usage, and permission events. A bounded queue
+prevents a stalled consumer from accumulating unbounded Provider events.
+
+The synchronous message response is the only successful terminal authority.
+`session.idle` may help drain already-sent SSE events, but it never proves
+success by itself. Malformed events, stream loss, HTTP failure, and unknown
+terminal shapes cannot become `run.completed`.
+
+`run.cancel()` calls the documented Session abort route. Harapter reports
+`native` only after OpenCode acknowledges the abort and the authoritative
+message response reports `MessageAbortedError`. A local request, event stream,
+Session, or Client abort remains `connection_aborted`. An uncertain remote
+settlement quarantines that Session handle and its Session ID within the Client;
+it cannot start or resume work until the host performs explicit recovery through
+a new connection whose status probe observes the Session as idle.
+
+OpenCode permission events map to portable approval interactions. Portable
+approval sends `once`, denial sends `reject`, and an explicit approval
+`providerOptions: { scope: 'always' }` sends `always`.
+
+## Inputs and native access
+
+Portable text is native. `file_ref` and `image_ref` map to documented file parts
+and require an absolute URI plus `mediaType`; image media types must start with
+`image/`. `opencode.part` accepts validated native text, file, agent, and
+subtask parts.
+
+Run `providerOptions` accepts `agent`, `system`, `tools`, and a native model
+object containing `providerId` and `modelId`. Unsupported fields are rejected
+instead of being ignored.
+
+`client.native()` returns an `OpenCodeNativeClient` with bounded JSON requests
+inside the configured endpoint and a listener for redacted events that cannot be
+routed to an active Run. Native calls are Provider-bound and do not gain
+portable lifecycle guarantees.
+
+## Compatibility and evidence
+
+The Adapter targets the current documented stable server interface without
+pinning the OpenCode executable to a release number. Connection validates the
+health response; every used Session, message, abort, permission, and event shape
+is validated at runtime. The runtime version is reported as identity and does
+not determine capabilities by itself.
+
+The fixture manifest records the exact upstream release, commit, and stable
+OpenAPI fingerprint used for the current evidence baseline. Those values are
+evidence metadata, not a runtime allowlist. Capability declarations come from
+that reviewed stable schema plus executable conformance and live-runtime
+evidence; an incompatible runtime shape fails closed at the boundary where it is
+used.
+
+Evidence includes:
+
+- a published stable OpenAPI fingerprint and synthetic redacted fixtures in
+  [`fixtures/opencode/http-openapi-stable`](../../fixtures/opencode/http-openapi-stable/manifest.json);
+- protocol mapping, authentication, malformed-input, lifecycle, cancellation,
+  interaction, unknown-event, and error tests;
+- the shared portable Provider conformance suite;
+- an opt-in live-runtime test enabled with `HARAPTER_OPENCODE_LIVE=1` and a
+  host-operated server URL in `HARAPTER_OPENCODE_ENDPOINT`;
+- a trusted scheduled live canary that installs the current stable OpenCode
+  release on an ephemeral runner, starts an isolated local server with no
+  plugins, denied permissions, and disabled tools, records the installed package
+  version, and executes a lifecycle that rejects any tool or interaction event.
+
+The last repository-recorded
+[trusted live canary](https://github.com/yunfeizhu/harapter/actions/runs/33747923398)
+passed on 2026-09-03 with `opencode-ai@1.18.27`. It proved the stable health
+interface, an exact completed text response with `run.completed`, resume of the
+same directory-bound native Session through a fresh Client connection, native
+abort with `run.cancelled`, and orderly Session, Client, and Server cleanup. The
+canary submitted two synthetic Prompts with no Tool or interaction Event.
+
+A production host may pin the recorded release for a reproducible deployment.
+Harapter continues to admit newer stable releases and validates their observed
+health, Session, Event, and terminal structures instead of using the recorded
+version as an executable allowlist. The run does not establish automatic SSE
+reconnection, experimental routes, permission interactions, Tool execution,
+commands, plugins, process management, or remote Session deletion.
+
+The package does not claim support for experimental routes, automatic SSE
+reconnection, OpenCode process management, remote Session deletion through
+portable close, or commands and plugins as portable Core capabilities.

package/dist/adapter.d.ts

@@ -0,0 +1,38 @@
+import { type ProviderAdapterFactory, type SecretRef } from '@harapter/core';
+import { type HttpHeaderMap, type HttpMethod } from '@harapter/transport-http-sse';
+import { type OpenCodeRawEvent } from './protocol.js';
+/** Host dependencies used without moving authentication ownership into Harapter. */
+export interface OpenCodeProviderFactoryOptions {
+    readonly fetch?: typeof fetch;
+    readonly resolveAuthHeaders?: (reference: SecretRef) => HttpHeaderMap | Promise<HttpHeaderMap>;
+}
+/** Connection-level limits accepted in an OpenCode Profile's providerOptions. */
+export interface OpenCodeProfileOptions {
+    readonly cancelSettlementTimeoutMs?: number;
+    readonly eventDrainTimeoutMs?: number;
+    readonly maxRunEvents?: number;
+    readonly requestTimeoutMs?: number;
+    readonly runRequestTimeoutMs?: number;
+    readonly sseConnectTimeoutMs?: number;
+}
+/** Request options for the explicit Provider-native HTTP escape hatch. */
+export interface OpenCodeNativeRequestOptions {
+    readonly method?: HttpMethod;
+    readonly body?: unknown;
+    readonly signal?: AbortSignal;
+    readonly timeoutMs?: number;
+}
+/** Bounded JSON response returned by the Provider-native HTTP escape hatch. */
+export interface OpenCodeNativeResponse<T = unknown> {
+    readonly status: number;
+    readonly body: T;
+}
+/** Explicit Provider-native client for documented OpenCode HTTP routes. */
+export interface OpenCodeNativeClient {
+    readonly runtimeIdentity: string;
+    request<T = unknown>(path: string, options?: OpenCodeNativeRequestOptions): Promise<OpenCodeNativeResponse<T>>;
+    onUnknownEvent(listener: (event: OpenCodeRawEvent) => void): () => void;
+}
+/** Create a fresh OpenCode HTTP Adapter factory. */
+export declare function createOpenCodeProviderFactory(options?: OpenCodeProviderFactoryOptions): 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":"AAAA,OAAO,EAmBL,KAAK,sBAAsB,EAM3B,KAAK,SAAS,EAEf,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAGL,KAAK,aAAa,EAClB,KAAK,UAAU,EAIhB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAgBL,KAAK,gBAAgB,EAEtB,MAAM,eAAe,CAAC;AAuBvB,oFAAoF;AACpF,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IAC9B,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAC5B,SAAS,EAAE,SAAS,KACjB,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;CAC7C;AAED,iFAAiF;AACjF,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAC5C,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IACtC,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IACtC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC;CACvC;AAED,0EAA0E;AAC1E,MAAM,WAAW,4BAA4B;IAC3C,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC;IAC7B,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;IAC9B,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,+EAA+E;AAC/E,MAAM,WAAW,sBAAsB,CAAC,CAAC,GAAG,OAAO;IACjD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;CAClB;AAED,2EAA2E;AAC3E,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,OAAO,CAAC,CAAC,GAAG,OAAO,EACjB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,4BAA4B,GACrC,OAAO,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC;IACtC,cAAc,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;CACzE;AAkBD,oDAAoD;AACpD,wBAAgB,6BAA6B,CAC3C,OAAO,GAAE,8BAAmC,GAC3C,sBAAsB,CAQxB"}