@aid-framework/runtime 0.0.0 → 0.1.48

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 [yyyy] [name of copyright owner]
+
+   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,183 @@
+# `@aid-framework/runtime`
+
+The TypeScript runtime for [AID Framework](https://github.com/aid-framework/aid-framework): the library a
+generated application calls at runtime. Pin a model, run a prompt, call a tool, trace it, stay inside a budget,
+and prove that quality did not regress.
+
+Generated code is thin glue. This is where the behaviour lives — which is why it is a normal dependency of the
+generated app, not part of the compiler.
+
+## Install
+
+```sh
+npm install @aid-framework/runtime
+```
+
+Requires Node.js 24 or newer. Ships as ESM with TypeScript declarations. `zod` is used for structured output and
+nothing else.
+
+## Quick start
+
+A gateway resolves aliases to pinned models, enforces budgets, records cost and opens a span per call:
+
+```ts
+import {
+  Budget, ModelGateway, OpenAICompatibleProvider, PinnedModel,
+} from '@aid-framework/runtime';
+
+const gateway = new ModelGateway({
+  providers: {
+    'openai-compatible': new OpenAICompatibleProvider({ apiKey: process.env.OPENAI_API_KEY }),
+  },
+  aliases: {
+    small: new PinnedModel({
+      alias: 'small',
+      spec: {
+        name: 'gpt-4o-2024-08-06',
+        provider: 'openai-compatible',
+        contextWindow: 128_000,
+        maxOutputTokens: 4_096,
+        cost: { inputPer1kUsd: 0.0025, outputPer1kUsd: 0.01 },
+      },
+    }),
+  },
+  budget: new Budget({ maxUsd: 5, scope: 'nightly' }),
+});
+
+const result = await gateway.generate('small', { prompt: 'hello' });
+
+result.text;
+result.usage;
+result.costUsd;
+result.attempts;  // every alias tried, in order
+result.fellBack;
+```
+
+**An alias resolves to an exact, pinned model id.** That is not cosmetic: a baseline recorded against `gpt-4o`
+means nothing if the alias floats to a later snapshot on the next run. An unknown alias therefore raises
+`UnknownModelAliasError` rather than falling through to a provider default.
+
+## A pipeline
+
+Control flow is plain async TypeScript. There is no graph engine and no orchestration framework: a generated app
+is ordinary code that is easy to read, step through and test.
+
+```ts
+import { Pipeline, PipelineContext } from '@aid-framework/runtime';
+
+const pipeline = new Pipeline([
+  { name: 'load', run: (ctx) => ctx.withValues({ question: ctx.require('request').question }) },
+  { name: 'answer', run: async (ctx) => ({ answer: await ask(ctx.require('question')) }) },
+]);
+
+const result = await pipeline.run(new PipelineContext({ request }));
+```
+
+`PipelineContext` is immutable — `get` / `require` / `withValues` — so a step cannot mutate what an earlier step
+observed, and a failed run's state stays inspectable. Each step runs in its own span; a step that throws aborts
+the run with the original error chained; `StopPipeline` is the supported early exit. A pipeline rejects an empty
+or duplicate-named step list at construction.
+
+Composite steps — `branch`, `parallel`, `mapStep`, `reduceStep` — are provided as step builders, with bounded
+nesting (`MAX_STEP_DEPTH`).
+
+## What is in the package
+
+| Area | Exports | Notes |
+| --- | --- | --- |
+| Types | `Message`, `ModelSpec`, `PinnedModel`, `TokenUsage`, `CompletionRequest`, `CompletionResponse`, `Capability` | The vocabulary everything else is typed against |
+| Errors | `AidRuntimeError` and 25 subclasses | One base, so an app catches framework refusals in one place |
+| Gateway | `ModelGateway`, `estimateUsage` | Pinned aliases, capability negotiation, ordered fallback, budget preflight |
+| Providers | `OpenAICompatibleProvider`, `FakeProvider`, `supports` | One HTTP adapter, one deterministic fake, plus the `Provider` protocol |
+| Cost | `Budget`, `CostLedger`, `estimateCostUsd` | Pre-call enforcement, per-call ledger entries, spend summaries |
+| Tracing | `getTracer`, `llmSpan`, `recordUsage`, `recordCost`, `recordException` | OTel GenAI semantic conventions; AID values namespaced `aid.*` |
+| Prompts | `PromptRegistry`, `PromptTemplate`, `Example` | Versioned registry, typed rendering, few-shot assembly |
+| Tools | `Tool`, `ToolExecutor`, `validateArguments` | Schema-validated dispatch over a documented JSON-Schema subset |
+| Structured output | `buildAgent`, `parseStructured`, `runStructured`, `repairPrompt` | Parse/repair loop over zod schemas |
+| Pipelines | `Pipeline`, `PipelineContext`, `StopPipeline`, `branch`, `parallel`, `mapStep`, `reduceStep` | Sequential reducer over an immutable context |
+| Concurrency | `ConcurrencyLimiter`, `holdsSlot` | Bounded in-flight work, including inside composite steps |
+| Policy | `evaluatePolicy`, `Principal`, `POLICY_BUILTINS` | Tool-auth expressions, fail-closed |
+| Agent loop | `agents/*` | Native loop: transfer vs. delegate, budgets, degrade, memory, HITL checkpoint |
+| Evals | `Dataset`, `EvalCase`, `runEvaluation`, `BaselineGate`, `EvalBaseline` | N-run sampling and the statistical gate |
+| Metrics | `ExactMatch`, `NormalizedContains`, `JsonSchemaValid`, `LlmJudge` | Plus `defaultMetrics` and `metricNames` |
+| Retrieval | `Retriever`, `RetrievalGate`, `chunkDocument`, `openConnector`, `createStore`, `fuse` | Connectors, chunkers, embedders, stores, hybrid search, reranking, citations |
+
+## Model pinning and capability checks
+
+`gateway.require(alias, capabilities)` checks **both** sides — the model's declared capabilities and the
+adapter's ability to serialize them — and returns the pinned model. A model that supports tool calling behind an
+adapter that does not serialize tool definitions cannot tool-call, and `CapabilityMismatchError` names what is
+missing rather than failing later at the provider.
+
+`generate(alias, request, { fallbacks })` tries the alias, then each fallback **in the order given**. Fallbacks
+are ordered, not conditional, and `result.attempts` reports what was actually tried.
+
+## Evals gate on statistics, not equality
+
+A model is *expected* to vary between runs, so a metric comparing two runs for equality is either always red or
+measuring nothing. Non-determinism is the property the gate is built to tolerate:
+
+```ts
+import { BaselineGate, runEvaluation, ExactMatch, defaultMetrics } from '@aid-framework/runtime';
+
+const run = await runEvaluation(dataset, runner, defaultMetrics(), { runs: 5 });
+const verdict = new BaselineGate(thresholds).evaluate(run, baseline);
+
+verdict.passed;
+verdict.metrics; // per-metric z-score, allowance and outcome
+```
+
+`runEvaluation` samples the runner **N times** and reports per-run metric means, so one unlucky run does not
+decide the verdict. `EvalBaseline.fromRun(run)` stores per metric the sample count, mean and spread; the gate
+compares with a one-sided normal test. A metric passes by clearing `minMean`, by staying within `maxRegression`
+of the baseline, or by regressing only within sampling noise.
+
+`LlmJudge` is implemented and never CI-required: a gate that depends on one non-deterministic call inside the
+gate you are trying to trust is the problem the design avoids.
+
+The arithmetic matches the Python runtime exactly — the same z-critical table, the same baseline comparison, the
+same sampling semantics — because a gate whose statistics differed per language would let a TypeScript
+regression pass a Python baseline.
+
+## Retrieval
+
+`retrieval/*` is IR-driven: `bindingFromSpec(retriever, { embedding, store })` folds the IR's `retrievers`,
+`embeddings` and `stores` entries into one `RetrieverBinding`, which a `Retriever` then ingests and searches.
+
+Chunk ids are content hashes, so re-ingesting the same input produces the same ids and a no-op diff.
+`FakeDeterministicEmbedder` hashes with SHAKE-128 and `chunkIdFor` with SHA-256, which is what lets a retrieval
+gate run in CI with no network and no key.
+
+`RetrievalMetric` (`RecallAtK`, `MeanReciprocalRank`, `CitationGrounding`) is a separate protocol from `Metric`,
+because retrieval scores a *retrieved set* rather than a single string. Retrieval is sampled through
+`RetrievalGate.sample(...)` into a standard `EvalRun` and judged by the unchanged `BaselineGate`.
+
+## Limits, stated plainly
+
+- **Streaming is declared, not implemented.** `Capability` includes it so a spec can require it and a build-time
+  gate can check it; calling `ModelGateway.stream` raises `FeatureDeferredError`. The transport is
+  request/response only.
+- **One HTTP provider and one fake.** Breadth of vendor coverage is a later concern; a narrow, correct seam is
+  worth more than a wide shallow one.
+- `PgVectorStore` needs a live `vector` extension and is not exercised by CI; the in-memory store carries the
+  store tests, and both share the same `VectorStore` protocol and `similarity` semantics.
+
+## API
+
+The full surface is the package's named exports; the table above is the map. The one deliberate asymmetry with
+the Python runtime is `providers/fake.ts`, which derives its accuracy draw from a SHA-256 hash of
+`seed:index:prompt` rather than CPython's Mersenne Twister, because string seeding there is a CPython
+implementation detail with no portable equivalent. The draw is still deterministic and still varies per call
+index, which is the property the gate depends on.
+
+## Related packages
+
+- [`aid-runtime-python`](https://pypi.org/project/aid-runtime-python/) — the same runtime for Python
+- [`@aid-framework/generator-ts-vercel`](https://www.npmjs.com/package/@aid-framework/generator-ts-vercel) — the
+  generator that emits apps against this runtime
+- [`@aid-framework/cli`](https://www.npmjs.com/package/@aid-framework/cli) — `aid`
+
+## License
+
+[Apache-2.0](https://github.com/aid-framework/aid-framework/blob/main/LICENSE). Code generated by AID Framework is
+not subject to this license.