@aid-framework/ir 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,199 @@
+# `@aid-framework/ir`
+
+The intermediate representation of [AID Framework](https://github.com/aid-framework/aid-framework): the one
+normalized, stack-independent, versioned form of an application that every code generator consumes.
+
+Generators never read a spec. This package resolves the spec **once** into an IR, so a Python target and a
+TypeScript target are looking at the same program — the same names, the same defaults, the same resolved
+references.
+
+```text
+spec.yaml ──buildIR──▶ IR ──runGates──▶ buildable ──▶ generator plan ──▶ code
+```
+
+## Install
+
+```sh
+npm install @aid-framework/ir
+```
+
+Requires Node.js 24 or newer. Depends only on `@aid-framework/spec`.
+
+## Quick start
+
+```ts
+import { checkSpecText, formatDiagnostics } from '@aid-framework/spec';
+import { buildIR, runGates, serializeIR } from '@aid-framework/ir';
+
+const checked = checkSpecText(source, { file: 'app/app.spec.yaml' });
+if (!checked.ok) throw new Error(formatDiagnostics(checked.diagnostics));
+
+const built = buildIR(checked.value, { file: 'app/app.spec.yaml' });
+if (built.diagnostics.some((d) => d.severity === 'error')) {
+  throw new Error(formatDiagnostics(built.diagnostics));
+}
+
+const gates = runGates(built.ir, { file: 'app/app.spec.yaml' });
+if (!gates.ok) throw new Error(formatDiagnostics(gates.diagnostics));
+
+const canonical = serializeIR(built.ir);
+```
+
+`buildIR` resolves every type, model, prompt and tool reference eagerly, materializes every default, and derives
+each stable identity from identity rather than from content — so editing one prompt does not renumber an unrelated
+pipeline.
+
+## The IR
+
+`IR_VERSION` is `"0.1.0"`. `specVersion` is carried through from the spec, so a consumer can always tell which
+spec revision produced an IR. The two are independent: neither implies the other.
+
+An IR always carries all nineteen top-level keys, even when a collection is empty:
+
+```text
+irVersion, specVersion, project, types, models, prompts, tools, retrievers, embeddings,
+stores, memory, agents, pipelines, evals, guardrails, deployments, observability, runtime,
+requiredCapabilities
+```
+
+### An empty collection is a contract
+
+An empty array here is not "missing" — it is a statement. The collections are present and required by the schema
+even when empty, so a later version can fill one in without touching a single consumer:
+
+- `agents`, `guardrails`, `memory`, `deployments` — declared by the spec language but unused by this document.
+- `embeddings` — not a spec section at all. A spec declares embedding capacity by giving a model the `embeddings`
+  capability and pointing a retriever at it, so this collection is **derived** from that content. Empty means the
+  app embeds nothing.
+
+`observability` and `runtime` are objects with defaults rather than arrays: tracing on, and a runtime descriptor
+naming plain-async control flow.
+
+## The build-time gates
+
+Gates decide whether an IR is buildable, before a single byte of code is emitted. There are sixteen, run as one
+report by `runGates`. All of them emit diagnostics rather than throwing, in the same compiler-style shape as
+`@aid-framework/spec`, so a user gets one report whatever layer rejected the input.
+
+| Gate | Rejects |
+| --- | --- |
+| `referential` | An unresolvable type or reference, a reference of the wrong kind, prompt variables that do not match the template, an undefined or duplicated step binding, a malformed eval target, a fallback cycle |
+| `normalize` | A value left implicit for the generator to invent, a provider this build does not serve, params above a model's limits |
+| `capability` | A target declaring no capabilities, an unknown target, a capability outside the vocabulary, a required capability the target does not declare |
+| `cost` | A budget declared against an unpriced model. Warns for an estimate above a budget, and for an unpriced, unbudgeted model |
+| `security` | A write or destructive tool with no auth policy, a destructive tool without confirmation, an under-redacting trace config, an HTTP path reaching a write with no auth |
+| `eval-coverage` | Nothing — warns when an HTTP-served pipeline has no CI-gating eval |
+| `agents/refs-resolve` | An agent naming a tool, prompt or model that does not exist |
+| `agents/handoff-cycles` | Transfer or delegation graphs that can re-enter an agent |
+| `agents/budgets` | An agent budget that cannot be honoured |
+| `agents/budget-degrade` | `onBudgetExhausted: degrade` with no strictly cheaper alias to step down to |
+| `guardrails/coverage` | A guardrail not attached to an input or output it can act on |
+| `guardrails/policies` | A guardrail policy that does not parse, or names an unknown builtin |
+| `hitl/side-effects` | A human-in-the-loop pause guarding a side effect it cannot actually hold |
+| `memory/refs` | A memory reference that does not resolve to a declared scope |
+| `deploy/streaming` | A deployment declaring streaming the target cannot emit |
+| `orchestration/deepagents` | An agent engine declaration the runtime cannot honour |
+
+**Suppression is explicit.** A check this build genuinely cannot enforce appears in `suppressed` with a stated
+reason rather than being skipped silently — because a skipped check and a passing check look identical from the
+outside.
+
+The capability set the gates check is derived from the IR's own content and written back onto
+`requiredCapabilities`, so the value a generator reads is the value that was actually checked:
+
+```ts
+const result = runGates(ir, {
+  targetCapabilities: {
+    'py-fastapi': ['http-trigger', 'json-schema', 'otel'],
+  },
+});
+
+result.ok;         // false when any gate emitted an error
+result.byGate;     // per-gate diagnostics
+result.suppressed; // what was not enforced, and why
+```
+
+## PolicyExpr
+
+Tool auth policies are written in a small expression language. This package parses them into a plain-JSON AST, so
+the AST can live in the IR, serialize canonically, and be evaluated by any target in any language.
+
+```text
+or         := and ('or' and)*
+and        := comparison ('and' comparison)*
+comparison := unary (('==' | '!=' | '<' | '<=' | '>' | '>=') unary)?
+unary      := 'not' unary | primary
+primary    := 'true' | 'false' | builtin '(' args ')' | '(' or ')'
+builtin    := hasRole | hasScope | isAuthenticated
+```
+
+```ts
+import { parsePolicyExpr, formatPolicyExpr } from '@aid-framework/ir';
+
+const parsed = parsePolicyExpr("hasRole('admin') or hasScope('tickets:write')");
+if (parsed.ok) console.log(formatPolicyExpr(parsed.value));
+```
+
+Parsing is a total function: it returns either an AST or positioned diagnostics, never a thrown exception.
+Anything outside this grammar is a validation error, including an unknown builtin. That is the fail-closed rule —
+a policy the runtime cannot evaluate must never be treated as `true`.
+
+Eval predicates use a companion grammar with the same properties (`parsePredicateExpr`, `PREDICATE_BUILTINS`), so
+a gate condition is as strict as an auth policy.
+
+## Canonical serialization
+
+`serializeIR` is deterministic, so regeneration is byte-reproducible and golden files are stable:
+
+- object keys sorted, LF endings, two-space indent, exactly one trailing newline;
+- no `NaN`, `Infinity` or `undefined`; an absent field is omitted rather than written as `null`;
+- array order preserved, because an array's order is meaningful and an object's is not.
+
+Two documents that differ only in key order or whitespace therefore produce byte-identical IR.
+
+## Model catalog
+
+The catalog is the build-time source of truth for model pricing and limits, used by the `cost` and `normalize`
+gates.
+
+```ts
+import {
+  CATALOG_VERSION, catalogCostProfile, catalogCostProfiles, catalogModel,
+} from '@aid-framework/ir';
+```
+
+The catalog JSON is also exported as `@aid-framework/ir/catalog/models.json`, and the IR schema as
+`@aid-framework/ir/ir.schema.json`.
+
+## Capabilities
+
+```ts
+import {
+  DEFERRED_CAPABILITIES, MODEL_CAPABILITIES, REQUIRED_CAPABILITIES,
+  deriveRequiredCapabilities, isRequiredCapability,
+} from '@aid-framework/ir';
+```
+
+`deriveRequiredCapabilities(ir)` returns the capabilities the IR's own content requires, in vocabulary order.
+`runGates` calls it before gating, so the gates and the generator never disagree about what is required.
+
+## API
+
+| Export | Purpose |
+| --- | --- |
+| `buildIR(value, options?)` | Spec value → `{ ir, diagnostics }` |
+| `runGates(ir, options?)` | Run all gates; returns `{ ok, diagnostics, suppressed, byGate }` |
+| `GATES` | The gate registry, in execution order |
+| `serializeIR(ir)`, `canonicalJson(value)` | Canonical JSON rendering |
+| `IR_VERSION` | The IR shape version (`0.1.0`) |
+| `IR_COLLECTIONS`, `IR_ONLY_COLLECTIONS` | The collection vocabulary |
+| `deriveRequiredCapabilities(ir)` | The capabilities the content requires |
+| `REQUIRED_CAPABILITIES`, `MODEL_CAPABILITIES`, `DEFERRED_CAPABILITIES` | The capability vocabularies |
+| `parsePolicyExpr`, `formatPolicyExpr`, `POLICY_BUILTINS` | The tool-auth policy language |
+| `parsePredicateExpr`, `formatPredicateExpr`, `PREDICATE_BUILTINS` | The eval predicate language |
+| `catalogModel`, `catalogCostProfile`, `catalogCostProfiles`, `CATALOG_VERSION` | Model pricing and limits |
+
+## 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.