@osdlc/agent-call 0.0.1-stage → 0.4.1

package/CHANGELOG.md

@@ -0,0 +1,187 @@
+# Changelog
+
+## 0.4.1
+
+### Patch Changes
+
+- 828fa0f: The changelog no longer names a private repository.
+
+## 0.4.0
+
+### Minor Changes
+
+- e02c4d9: The first release on npm. Earlier versions were used only during development and were never
+  published, so this entry lists everything the package does. It is one call spec for headless
+  coding-agent CLIs: describe the prompt, permissions, context, output shape and session once, and
+  each adapter turns it into a `claude`, `codex`, `agy` (Antigravity) or `opencode` command line,
+  recording every approximation. Results come back normalized, with the raw output kept. No
+  dependencies.
+  
+  - The call spec: `AgentCallSpec` with `PermissionSpec`, `PermissionMode`, `ContextSpec`,
+    `OutputSpec`, `OutputFormat`, `SessionSpec`, `McpSpec`, `PluginSpec` and `AgentName`.
+    `EFFORT_LEVELS` (`low`, `medium`, `high`, `xhigh`, `max`) and `EffortLevel` are also exported
+    from `@osdlc/agent-call/models`, which has no Node imports.
+  - Planning and running: `planCall` turns a spec into a `PlannedCall` with no side effects, and
+    `callAgent` runs it with a library-level timeout. Supporting types and values: `CapabilityNote`,
+    `Support`, `TempFile`, `TMP_TOKEN`, `AgentResult`, `CallError` and `CallOptions`. Agent failures
+    come back as `ok: false` with a `CallError`; `callAgent` rejects only when planning throws,
+    a temp file name is not a plain file name, or the temp directory cannot be written. A nonzero
+    exit reports the parser's text, the exit code and the end of stderr together in
+    `error.detail`, and a caller abort reports `aborted by the caller`.
+  - Built-in adapters: `claudeAdapter`, `codexAdapter`, `antigravityAdapter` and `opencodeAdapter`,
+    with their options types `ClaudeAdapterOptions`, `CodexAdapterOptions`,
+    `AntigravityAdapterOptions` and `OpencodeAdapterOptions`, plus `adapterFor`, `BUILTIN_AGENTS`,
+    `detectAgents` and `AgentAvailability`.
+  - Your own adapters: `customAdapter` and `CustomAdapterOptions` for any one-shot CLI (they note
+    the fields they fold into the prompt and `permissions.mode`, and not the fields your `args`
+    leave out), and the contract types `AgentAdapter`, `ParsedOutput` and `RawProcessOutput`.
+  - The conversation model `agent-conversation/1`, from `callAgent` with `captureConversation`:
+    `Conversation`, `ConversationMessage`, `Part`, `Role`, `Usage`, `CONVERSATION_SCHEMA`,
+    `assistantText` and `toolCalls`.
+  
+  The claude adapter passes MCP server config as a temp file, so tokens in server `env` stay off the
+  command line. codex has no file option and uses `-c` overrides.
+  
+  Eight exports are experimental and may change in any minor release: `modelArgs`,
+  `modelArgsRefusal`, `ModelChoice`, `templateAdapter`, `templateRefusal`, `TemplateAdapterOptions`,
+  `claudePluginArgv` and `claudeResumeFlag`. They build launch arguments for callers that assemble
+  a command line themselves. The other exports are stable within 0.x: a breaking change goes in a
+  minor release and is marked `Breaking` in the changelog. `CallError.reason` is open, so a minor
+  release may add a reason. `CallOptions` accepts `undefined` for its optional fields, and
+  `BUILTIN_AGENTS` and `EFFORT_LEVELS` are frozen.
+  
+  The history before this release is in CHANGELOG.md. Node.js 22 or later, ESM only, shipped as
+  compiled JavaScript with type declarations. Tested on Linux and macOS; Windows is untested, and on
+  Windows a timeout may not stop the agent's child processes. The agent runs in its own process group
+  and keeps running if the host is interrupted, so a host that can be interrupted must abort its calls
+  through the `signal` option. `detectAgents` reports a CLI as unavailable when `--version` has not
+  finished within 10 seconds. `templateAdapter` throws when `promptVia` and the `{prompt}` slot
+  disagree. Licensed `MIT OR Apache-2.0`.
+
+## History before the first public release
+
+These versions were never published. The package was developed in a private repository. The
+version numbers were assigned afterwards, from its git history, and have no tags.
+
+### [0.3.0] - 2026-10-11 (unpublished)
+
+#### Added
+
+- `modelArgs(tool, choice)` and `modelArgsRefusal(tool, choice)` build the model and effort
+  flags for the claude, codex and pi CLIs from a resolved `ModelChoice`, and refuse a tool that
+  has no such flags. `ModelChoice.via` holds a launch mode's flags, placed before the model.
+- `templateAdapter` runs a CLI from an argument template with `{prompt}`, `{model}` and
+  `{effort}` slots; `templateRefusal` says why a template cannot take a choice.
+
+#### Changed
+
+- `EFFORT_LEVELS` gains `xhigh`: `low, medium, high, xhigh, max`. claude takes it as
+  `--effort xhigh`, codex as `model_reasoning_effort`, opencode as `--variant`; antigravity
+  clamps it, like `max`, to `--effort high`.
+- The codex adapter passes every effort through, `max` included. It used to send `max` as
+  `high`.
+
+#### Removed
+
+- **Breaking:** model tiers left the call spec. The `modelTier` field of `AgentCallSpec`, the
+  `ModelTier` type, the `CLAUDE_TIER_MODEL` table and the `applyModelTier` helper are removed.
+  Pass a concrete model in `model`.
+
+### [0.2.0] - 2026-10-10 (unpublished)
+
+#### Changed
+
+- **Breaking:** the `gemini` adapter is replaced by `antigravity`. `AgentName` swaps `'gemini'` for
+  `'antigravity'`, and `BUILTIN_AGENTS`, `adapterFor` and `detectAgents` follow.
+  `antigravityAdapter` and `AntigravityAdapterOptions` drive the `agy` CLI headlessly; effort,
+  the output schema, session continuation and the permission posture map to native flags.
+
+#### Removed
+
+- **Breaking:** `geminiAdapter`, `GeminiAdapterOptions` and `GEMINI_TIER_MODEL`. Use
+  `antigravityAdapter`.
+
+### [0.1.7] - 2026-10-06 (unpublished)
+
+#### Added
+
+- `AgentCallSpec.plugins` (`PluginSpec`), claude only: `dirs` load with `--plugin-dir`, and
+  `disable` turns installed plugin ids off through `--settings`.
+- `claudePluginArgv(plugins)` and `claudeResumeFlag(id)` are exported.
+
+#### Fixed
+
+- The claude adapter passes `session.resume` as `--resume=<id>`, so an id that starts with `-`
+  stays bound to the flag.
+
+### [0.1.6] - 2026-10-05 (unpublished)
+
+#### Added
+
+- The `./models` entry point exports `EFFORT_LEVELS` and the effort and tier types with no Node
+  imports, so a browser bundle can use them.
+
+### [0.1.5] - 2026-10-05 (unpublished)
+
+#### Added
+
+- `EFFORT_LEVELS` and the claude and gemini tier-to-model tables are exported.
+
+### [0.1.4] - 2026-09-05 (unpublished)
+
+#### Fixed
+
+- The spec types accept an explicit `undefined` for every optional field, so callers that use
+  `exactOptionalPropertyTypes` compile.
+
+### [0.1.3] - 2026-09-05 (unpublished)
+
+#### Added
+
+- `RawProcessOutput.stdinError` records a prompt that could not be fully written to the
+  child's stdin, so a caller can tell that the agent answered a truncated prompt.
+
+#### Fixed
+
+- An agent that exited without reading its stdin no longer crashes the calling process.
+- Multi-byte characters split across two reads of stdout or stderr are decoded correctly.
+- The gemini adapter no longer applies `systemPrompt` twice.
+- An already-aborted signal stops the call before the agent is spawned.
+- A claude `stream-json` run that ends without its result event reports an `agent-error`,
+  with the events still returned. A caller that ignored the missing envelope saw `ok: true`
+  before.
+
+### [0.1.2] - 2026-08-24 (unpublished)
+
+#### Fixed
+
+- Permission-mode and model-tier flags are built from shared tables in the claude, codex and
+  gemini adapters. The argv and the capability notes are unchanged.
+
+### [0.1.1] - 2026-07-12 (unpublished)
+
+#### Fixed
+
+- A timeout or abort kills the agent's whole process group, so a child that started its own
+  children no longer keeps the call running past its deadline.
+
+### [0.1.0] - 2026-07-12 (unpublished)
+
+#### Added
+
+- `AgentCallSpec`: one agent call in agent-agnostic terms (prompt, model and model tier,
+  reasoning effort, system prompts, permission posture, context files and directories, output
+  format and JSON schema, session behaviour, MCP servers, budget, timeout). Only `prompt` is
+  required.
+- `planCall(adapter, spec)` translates a spec into a `PlannedCall` (argv, stdin, env, temp
+  files) with no side effects. Every planned call carries one `CapabilityNote` per field that
+  did not map one to one: `native`, `approximated`, `emulated` or `dropped`.
+- Adapters for `claude`, `codex`, `gemini` and `opencode`, `customAdapter` for any one-shot
+  CLI, and `detectAgents` to probe which CLIs are installed.
+- `callAgent(adapter, spec)` runs the planned call with a library-level timeout and never
+  throws on agent failure: errors are `spawn-failed`, `timeout`, `nonzero-exit` or
+  `agent-error`.
+- `AgentResult` carries the final text, structured output, session id, token usage, cost and
+  the plan that ran, with raw stdout and stderr kept.
+- `captureConversation: true` lifts a transcript into `agent-conversation/1`: role-tagged
+  messages of typed parts with usage, cost, duration and stop reason.

package/CONTRIBUTING.md

@@ -0,0 +1,65 @@
+# Contributing
+
+Thanks for your interest in `@osdlc/agent-call`.
+
+## Issues
+
+Report bugs and ask for features in the
+[issue tracker](https://github.com/osdlc/osdlc/issues). For a bug, include the
+library version, your Node version, the agent CLI and its version, and the call
+spec that misbehaves. Report security problems privately. See
+[SECURITY.md](./SECURITY.md).
+
+## Pull requests
+
+This package lives in [osdlc/osdlc](https://github.com/osdlc/osdlc) under
+`packages/ts/agent-call`. Open pull requests there. They are reviewed and
+merged there.
+
+## Running the tests
+
+The repository is a pnpm workspace. Install from the repository root, then
+work in the package directory. The tests run on [Vitest](https://vitest.dev)
+under Node 22.12 or later for development.
+
+```sh
+pnpm install
+cd packages/ts/agent-call
+pnpm test
+```
+
+No test needs an agent CLI. `pnpm run coverage` reports test coverage.
+
+`pnpm run build` compiles the package to `dist/`. `pnpm run smoke` runs
+`tests/smoke.mjs`, a short check of the built package under Node. Build first.
+It is not published.
+
+`pnpm run test:live` makes real, paid calls to whichever agent CLIs are
+installed and signed in. The live tests are skipped unless `AGENT_CALL_LIVE=1`
+is set, which that script does.
+
+Other checks:
+
+```sh
+pnpm run typecheck
+pnpm run lint
+pnpm run format:check
+```
+
+## Code style
+
+- TypeScript, ES modules, and `.js` import paths for relative imports.
+- Prettier formats the code and oxlint checks it. Run `pnpm run format` and
+  `pnpm run lint` before you commit.
+- Add a test for each behaviour change or bug fix. A change to what an
+  adapter maps needs a row in `tests/contract.test.ts` and in the README's
+  capability map.
+- A new export gets TSDoc, `@throws` if it can throw, and a use in
+  `examples/`, which imports the package by name. A test fails if an export
+  has no example.
+- An experimental export carries `@experimental` and is listed in the
+  README's API section. A test checks that the two agree.
+- For a change users can see, add a changeset: run `pnpm changeset` at the
+  repository root. Start a breaking change's summary with `**Breaking:**`.
+  Do not edit `CHANGELOG.md` or `version` by hand; the release writes them.
+  See [packages/README.md](https://github.com/osdlc/osdlc/blob/main/packages/README.md).

package/LICENSE-APACHE

@@ -0,0 +1,202 @@
+
+                                 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 sksizer
+
+   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/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 sksizer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.