@harapter/adapter-codex 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,250 @@
+# `@harapter/adapter-codex`
+
+`@harapter/adapter-codex` exposes the official Codex harness through the stable
+[Codex App Server](https://developers.openai.com/codex/app-server) interface and
+maps it to the portable Harapter lifecycle. The harness and App Server source
+live in the open-source
+[OpenAI Codex repository](https://github.com/openai/codex).
+
+## Installation
+
+```bash
+pnpm add @harapter/core@next @harapter/adapter-codex@next
+```
+
+## Runtime prerequisites and compatibility
+
+The host installs and authenticates Codex. This package does not include the
+Codex binary, read credentials, resolve `SecretRef` values, or change a host
+security policy. The configured process is launched without a shell, and its
+stderr is not captured or exposed.
+
+The Adapter targets the current stable App Server interface with
+`experimentalApi: false`. `connect()` completes the required `initialize` /
+`initialized` handshake, validates the required response structure, and keeps
+the returned runtime version only as non-sensitive diagnostic identity. The
+leading user-agent product name may reflect `clientInfo.name` or a process-level
+originator, so it is not treated as Provider identity. There is no CLI version
+allowlist. Malformed required structures fail with `provider_api_incompatible`,
+while unknown events remain observable through the bounded raw channel.
+
+The upstream runtime and generated Schema are Apache-2.0 licensed. Harapter does
+not redistribute either one; see the
+[license record](../../licenses/openai-codex.md).
+
+## Public entrypoints
+
+- `CODEX_PROVIDER_ID` is `openai.codex`.
+- `createCodexProviderFactory()` returns a dynamically registrable Provider
+  factory.
+- `CODEX_USER_INPUT_PART` names the explicit `openai.codex.userInput` native
+  input escape hatch.
+- `CodexNativeClient` exposes initialized native requests, notifications, the
+  non-sensitive runtime identity, and bounded redacted unknown-event
+  observation.
+
+```ts
+import { HarnessRegistry, profileId } from '@harapter/core';
+import {
+  CODEX_PROVIDER_ID,
+  createCodexProviderFactory,
+} from '@harapter/adapter-codex';
+
+const registry = new HarnessRegistry();
+registry.register(createCodexProviderFactory());
+
+const client = await registry.connect({
+  profileId: profileId('codex-local'),
+  providerId: CODEX_PROVIDER_ID,
+  displayName: 'Local Codex',
+  connection: {
+    kind: 'process',
+    command: 'codex',
+    args: ['app-server', '--stdio'],
+    ownership: 'adapter',
+  },
+});
+
+const session = await client.createSession();
+const run = await session.start({
+  parts: [{ type: 'text', text: 'Describe the current project.' }],
+});
+
+for await (const event of run.events()) {
+  // Render or persist according to the host's data policy.
+}
+
+const result = await run.result();
+await session.close();
+await client.close();
+```
+
+## Profile and process ownership
+
+The Adapter currently accepts only `process` connections with
+`ownership: "adapter"`. The Profile supplies the complete command, arguments,
+and optional process working directory. Harapter never appends installation or
+authentication commands and never invokes a shell. This package has no host
+Secret Store resolver. `envRefs` are rejected. The child otherwise inherits the
+environment selected by the host process.
+
+`HarnessProfile.providerOptions` accepts these positive integer limits:
+
+- `maxMessageBytes`, `maxBufferedMessages`, `maxPendingRequests`,
+  `maxPendingInboundRequests`, and `maxPendingWrites` configure the shared JSONL
+  RPC transport;
+- `requestTimeoutMs` bounds each App Server request wait;
+- `cancelSettlementTimeoutMs` bounds the wait for native `turn/started`, the
+  `turn/interrupt` request, and its authoritative terminal notification;
+- `maxRunEvents` bounds unread portable events and must be at least two so a
+  terminal event always has reserved space.
+
+An unread Run that exhausts its event bound closes the connection and settles as
+`connection_aborted`; it does not silently drop events or claim native
+cancellation.
+
+## Session, Run, and input mapping
+
+Codex Thread is a Harapter Session, and Codex Turn is a Harapter Run. A
+`SessionRef` stores the native Thread id and remains bound to the creating
+Provider, Profile, stable App Server interface, and Provider-owned state. Resume
+checks those fields before sending `thread/resume`, and it rejects a response
+that identifies another Thread. Ephemeral Threads declare Session resume as
+unsupported and are rejected before Provider traffic.
+
+`CreateSessionInput` maps workspace file URIs, system context, and model id to
+stable `thread/start` fields. Its `providerOptions` accepts `approvalPolicy`,
+`sandbox`, `modelProvider`, `serviceTier`, `personality`, `config`, and
+`ephemeral`. Omitting these fields preserves the active Codex configuration; the
+Adapter does not choose a weaker approval or sandbox policy.
+
+Runs accept text and image references. Arbitrary file references are
+unsupported. `RunOptions.providerOptions` accepts the stable turn overrides
+`approvalPolicy`, `effort`, `model`, `outputSchema`, `personality`,
+`sandboxPolicy`, `serviceTier`, and `summary`. Unknown options fail instead of
+being silently ignored. A positive `timeoutMs` requests native `turn/interrupt`;
+an authoritative `interrupted` terminal result is returned as `cancelled` with a
+timeout reason.
+
+The Adapter enforces one active Turn per Thread and rejects any Turn identifier
+reused during the connection lifetime. Reuse aborts the connection so late
+traffic cannot be reassigned to a later Run. `turn/completed` is the only
+authoritative Run terminal notification:
+
+- `completed` → `run.completed`;
+- `interrupted` → `run.cancelled`;
+- `failed` → `run.failed` with only a safe Provider error code;
+- an unknown status in a structurally complete terminal → a redacted `provider`
+  event and `run.failed`, never success;
+- a malformed terminal → a redacted `provider` event while the Run remains
+  active.
+
+Closing the Client or losing the process settles active Runs as
+`connection_aborted`. Only a successful `turn/interrupt` followed by the
+authoritative `interrupted` terminal status reports native cancellation. The
+Adapter waits for the matching native `turn/started` notification before
+requesting interruption. A missing start notification or an acknowledged
+interrupt without a terminal notification closes the owning connection after
+`cancelSettlementTimeoutMs` and reports `connection_aborted`.
+
+## Events and interactions
+
+Agent message, reasoning, Tool lifecycle, Tool update, usage, interaction, and
+terminal notifications map to the portable event vocabulary. Completed agent
+message items are authoritative for `finalMessage`. Known message, reasoning,
+Tool, and interaction content remains application data and must follow the
+host's normal privacy and persistence policy.
+
+Unknown notifications during a Run remain observable as `provider` events. Their
+`raw` value is a bounded structural summary: string values and unsafe keys are
+redacted, numeric scalar values are redacted, nesting and collections are
+capped, and the method name is length-limited.
+`CodexNativeClient.onUnknownEvent()` observes the same safe summary even when no
+portable Run can own it. Unknown values are never reinterpreted as terminal
+success.
+
+Stable command and file-change requests map to portable approvals. App Server
+user-input requests belong to the experimental API and remain explicit
+`provider` interactions; the portable `interaction.user_input` capability is
+unsupported. A host that needs a native Codex decision such as
+`acceptForSession`, permission subsets, MCP elicitation, or another
+Provider-specific response uses `InteractionResponse.kind: "provider"`
+explicitly. Server requests that cannot be associated with an active Run are
+denied instead of changing state invisibly.
+
+## Capabilities and native access
+
+The current stable Schema declares native Session creation and resume,
+streaming, Turn interrupt, text and image input, approvals, generic Provider
+interactions, and native client access. Session close, connection abort, and
+bounded raw observation are Adapter-controlled. Session fork, portable file
+input, and portable user input are explicitly unsupported.
+
+Capability values are selected only after the stable App Server handshake is
+validated. They are not inferred from `openai.codex` identity.
+
+`CodexNativeClient` is an explicit escape hatch and can issue methods outside
+the portable lifecycle. Callers own the resulting Provider semantics and must
+not use it to bypass host authorization, Session ownership, or data policy.
+
+## Errors, evidence, and limitations
+
+Errors contain fixed Harapter messages, stable categories, safe numeric or
+transport codes, Schema-declared Codex error categories, and no Provider message
+bodies, prompts, file contents, credentials, environment values, or local paths.
+Runtime absence is `runtime_not_found`; handshake and method incompatibility is
+`provider_api_incompatible`; request wait expiry is `timeout`; unexpected stream
+or process termination is `connection_aborted` after connect; and an
+operation-local transport rejection on an open connection is `provider_error`.
+
+Evidence for the supported interface includes:
+
+- the generated stable Schema fingerprint and synthetic JSONL traces in
+  [`fixtures/codex/app-server-stable`](../../fixtures/codex/app-server-stable/manifest.json);
+- a synthetic initialize response with the client-selected originator used by
+  the official App Server;
+- mapping, malformed-input, redaction, interaction, timeout, cancellation,
+  process-exit, ownership, and cleanup tests;
+- the shared portable Provider conformance suite;
+- a local live test against the current Codex release using a read-only,
+  resumable Thread that performs no Tool calls, verifies one completed Turn and
+  one natively interrupted Turn, and logs no Provider traffic.
+
+The live test is opt-in and requires an authenticated Codex installation:
+
+```bash
+HARAPTER_CODEX_LIVE=1 \
+HARAPTER_CODEX_COMMAND="$(command -v codex)" \
+pnpm vitest run providers/codex/test/live.test.ts
+```
+
+The last repository-recorded
+[trusted live canary](https://github.com/yunfeizhu/harapter/actions/runs/33745075649)
+passed on 2026-09-03 with `@openai/codex@0.153.0`. It proved the stable
+handshake, an exact completed text response with `run.completed`,
+same-connection resume of the native non-ephemeral Thread, immediate native
+cancellation with `run.cancelled`, and orderly Session and Client 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 the observed
+handshake, response, Event, and terminal structures instead of using the
+recorded version as an executable allowlist. The run does not establish
+cross-process Thread resume, experimental App Server APIs, image input, approval
+interactions, or Tool execution.
+
+The trusted scheduled live-canary workflow can install the current stable Codex
+release on an ephemeral runner and execute the same lifecycle with an isolated
+configuration. It is enabled independently from pull request CI, records the
+installed package version, and requires a configured model service that supports
+the Responses interface used by Codex. Before the job receives the real model
+credential, the current Codex feature inventory must match the reviewed
+tool-disabled surface. The lifecycle requires one exact completed response,
+closes and resumes the same non-ephemeral Thread on the App Server connection,
+then requires native interruption and an authoritative cancelled terminal for a
+second Turn. It fails if a tool or interaction event is observed and stores only
+Event type strings in the test.
+
+Experimental App Server APIs, Session fork, paginated history, direct account or
+authentication management, and host-owned process streams are not supported by
+this release.

package/dist/adapter.d.ts

@@ -0,0 +1,28 @@
+import { type ProviderAdapterFactory } from '@harapter/core';
+import { type CodexRawEvent } from './protocol.js';
+/** Connection-level limits accepted in a Codex Profile's providerOptions. */
+export interface CodexProfileOptions {
+    readonly cancelSettlementTimeoutMs?: number;
+    readonly maxBufferedMessages?: number;
+    readonly maxMessageBytes?: number;
+    readonly maxPendingInboundRequests?: number;
+    readonly maxPendingRequests?: number;
+    readonly maxPendingWrites?: number;
+    readonly maxRunEvents?: number;
+    readonly requestTimeoutMs?: number;
+}
+/** Request options for explicit Provider-native App Server calls. */
+export interface CodexNativeRequestOptions {
+    readonly signal?: AbortSignal;
+    readonly timeoutMs?: number;
+}
+/** Explicit Provider-native escape hatch for initialized App Server traffic. */
+export interface CodexNativeClient {
+    readonly runtimeIdentity: string;
+    request<TResult = unknown>(method: string, params?: unknown, options?: CodexNativeRequestOptions): Promise<TResult>;
+    notify(method: string, params?: unknown): Promise<void>;
+    onUnknownEvent(listener: (event: CodexRawEvent) => void): () => void;
+}
+/** Create a fresh Codex App Server Adapter factory. */
+export declare function createCodexProviderFactory(): 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":"AAEA,OAAO,EAmBL,KAAK,sBAAsB,EAQ5B,MAAM,gBAAgB,CAAC;AAUxB,OAAO,EAcL,KAAK,aAAa,EAGnB,MAAM,eAAe,CAAC;AAcvB,6EAA6E;AAC7E,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAC5C,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,gBAAgB,CAAC,EAAE,MAAM,CAAC;CACpC;AAED,qEAAqE;AACrE,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;IAC9B,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,gFAAgF;AAChF,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,OAAO,CAAC,OAAO,GAAG,OAAO,EACvB,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,OAAO,EAChB,OAAO,CAAC,EAAE,yBAAyB,GAClC,OAAO,CAAC,OAAO,CAAC,CAAC;IACpB,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxD,cAAc,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;CACtE;AAyBD,uDAAuD;AACvD,wBAAgB,0BAA0B,IAAI,sBAAsB,CAQnE"}