@aid-framework/ir 0.0.0 → 0.1.39

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,135 @@
+# `@aid-framework/ir` — the intermediate representation
+
+The IR is the one stack-independent, normalized, versioned representation of an app that every generator
+consumes. Generators never read the spec: `@aid-framework/ir` resolves it once, at build time, into something a
+generator can emit code from directly.
+
+Layering is strictly one-directional. `@aid-framework/ir` imports `@aid-framework/spec`; `@aid-framework/spec` never imports `@aid-framework/ir`.
+
+## IR v0.1
+
+`IR_VERSION` is `"0.1.0"` and `specVersion` is carried through from `@aid-framework/spec`, so a consumer can tell which
+spec revision produced an IR. The two are independent and neither implies the other.
+
+Every IR carries all 19 top-level keys of [`docs/design.md` §7.2](../../docs/design.md):
+
+```text
+irVersion, specVersion, project, types, models, prompts, tools, retrievers, embeddings,
+stores, memory, agents, pipelines, evals, guardrails, deployments, observability, runtime,
+requiredCapabilities
+```
+
+Phase 0 populates `types`, `models`, `prompts`, `tools`, `pipelines`, and `evals`. Phase 1 adds `stores` and
+`retrievers` from their spec sections and derives `embeddings` from the embedding models a spec declares.
+
+### Empty collections are a contract, not an omission
+
+Five collections are **present and empty by design**. They are `[]` rather than omitted or `undefined`, and
+the JSON Schema requires each of them, so a later phase can fill one in without touching a single consumer.
+An empty array is otherwise indistinguishable from "not implemented", so the two reasons are worth keeping
+apart:
+
+- `agents`, `guardrails`, `memory`, `deployments` — sections the spec **defers**. Layer 1 lists them in
+  `DEFERRED_SECTIONS`, so no spec can populate them yet.
+- `embeddings` — not a spec section at all. It exists only in the IR: a spec declares embedding capacity by
+  giving a model the `embeddings` capability and pointing a retriever at it, so the collection is derived
+  from that content rather than written out by hand. Empty means "this app embeds nothing".
+
+`observability` and `runtime` are objects rather than arrays, present with Phase 0 defaults: tracing on, and
+a runtime descriptor naming plain-async control flow.
+
+## Building
+
+```ts
+import { checkSpecText, formatDiagnostics } from '@aid-framework/spec';
+import { buildIR, runGates, serializeIR } from '@aid-framework/ir';
+
+const checked = checkSpecText(source, { file: 'app.yaml' });
+if (!checked.ok) throw new Error(formatDiagnostics(checked.diagnostics));
+
+const { ir, diagnostics } = buildIR(checked.value, { file: 'app.yaml' });
+const gates = runGates(ir, { file: 'app.yaml' });
+
+if (!gates.ok) throw new Error(formatDiagnostics(gates.diagnostics));
+console.log(serializeIR(ir));
+```
+
+- `buildIR(value, { file? })` returns `{ ir, diagnostics }`. It resolves every `TypeRef` and every
+  `model`/`prompt`/`tool` reference eagerly, materializes every default, and derives each stable identity
+  from identity rather than content, so an unrelated edit never churns a generated diff.
+- `runGates(ir, { targetCapabilities?, file? })` returns `{ ok, diagnostics, suppressed, byGate }`. `ok` is
+  false when any gate emitted an error-severity diagnostic.
+- `serializeIR(ir)` renders canonical JSON.
+- `deriveRequiredCapabilities(ir)` returns the capabilities the IR's own content requires, in vocabulary
+  order. `runGates` sets `requiredCapabilities` from it before gating, so the value on the IR is the one the
+  generator should read.
+
+## The six build-time gates
+
+All six run before code generation. They emit diagnostics, never exceptions, and use the same
+compiler-style shape as `@aid-framework/spec`, so a user sees one report whatever layer rejected the input. IR codes
+are namespaced `ir/*` and never reuse a `spec/*` code.
+
+| Gate | Rejects |
+| --- | --- |
+| `referential` | An unresolvable `TypeRef` or reference, a reference whose kind does not match (a `tool` step naming a prompt), prompt variables that do not match the template, an undefined or duplicated step binding, a malformed eval target, a `fallbacks` cycle |
+| `normalize` | A value left implicit for the generator to invent, a provider Phase 0 does not serve, params above a model's limits |
+| `capability` | A target that declares 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 when an estimate exceeds a budget, and when a model is unpriced but unbudgeted |
+| `security` | A `write`/`destructive` tool with no `auth`, a `destructive` tool without `requiresConfirmation`, an under-redacting trace config, an HTTP path that reaches a write with no `auth` |
+| `eval-coverage` | Nothing: warns when an HTTP-served pipeline has no `eval` with `gate.ci: true` |
+
+**Suppression is explicit.** A check Phase 0 genuinely cannot enforce appears in `suppressed` with a stated
+reason rather than being skipped silently, because a skipped check is indistinguishable from a passing one.
+Phase 0 suppresses the guardrail rule: there is no guardrail runtime to enforce it against.
+
+### Capability declarations are injected
+
+`@aid-framework/ir` must not import `packages/generator-sdk`, which does not exist yet, so a target's capability
+declaration arrives as a gate argument:
+
+```ts
+runGates(ir, { targetCapabilities: { 'py-fastapi': ['http-trigger', 'json-schema', 'otel'] } });
+```
+
+`src/catalog/` exports the Phase 0 reference declaration (`PHASE_0_TARGET_CAPABILITIES`) that the default
+uses. Layer 3 supplies the real declarations instead, and nothing else in this package changes.
+
+## Canonical serialization
+
+`serializeIR` is deterministic so that regeneration is byte-reproducible and golden files are stable: object
+keys sorted, LF endings, 2-space indent, exactly one trailing newline, no `NaN`/`Infinity`/`undefined`, and
+`undefined` fields omitted rather than written as `null`. Array order is preserved because an array's order
+is meaningful; an object's is not. Two spec documents that differ only in key order or whitespace produce
+byte-identical IR.
+
+## PolicyExpr
+
+`src/policy/` parses the policy mini-language used by `tool.auth` into a plain-JSON AST, so the AST can be
+embedded in the IR, serialized canonically, and evaluated by any target.
+
+```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
+```
+
+Parsing is a total function: `parsePolicyExpr(source, context?)` returns either an AST or position-bearing
+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`.
+
+## Development
+
+```sh
+pnpm build
+pnpm test
+```
+
+Fixtures live in `test/fixtures/`, so this package's tests do not depend on `@aid-framework/spec`'s own fixtures.
+`test/__golden__/` holds the committed canonical IR for the full fixture, compared byte for byte.
+
+Reference: [`docs/design.md` §7](../../docs/design.md).