@aid-framework/generator-ts-vercel 0.0.0-stage → 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

@@ -1,3 +1,164 @@
-# Temporary Holding Version
+# `ts-vercel` generator
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The **Phase 1 second target**: turns the IR into a Next.js App Router service wired to the
+[`@aid-framework/runtime`](../../../runtimes/typescript/) runtime. Generated code is declarative glue — zod schemas, model
+aliases, prompt templates, route handlers, tool adapters, retrieval bindings, eval definitions — and every
+behaviour it calls already exists in the runtime ([`docs/design.md` §4](../../../docs/design.md), principle 1:
+*thin generated, fat runtime*).
+
+The only input is the IR. `plan` is a pure function of it: nothing here reads a spec file, a template
+directory, the environment or the clock, so the same IR always produces the same bytes.
+
+**Emits against** ([`§8.1`](../../../docs/design.md)):
+
+| Key | Value | Why |
+| --- | --- | --- |
+| `structuredOutput` | `zod` | Response models are zod schemas, so a structured-output call is validated by the runtime's gateway |
+| `tracing` | `otel-genai` | Spans follow the OTel GenAI semantic conventions |
+| `orchestration` | *absent* | Control flow is **plain async**. Orchestration frameworks are deferred to Phase 2 ([`§14`](../../../docs/design.md)), and declaring nothing is what keeps the choice swappable |
+
+## Deviation: no `emitsAgainst.vectorStore`
+
+The frozen plan's L6 row asks for
+`emitsAgainst = { structuredOutput: 'zod', tracing: 'otel-genai', vectorStore: 'pgvector' }`. **The third key is
+not expressible, and this package does not declare it.** `EmitsAgainst` in
+[`packages/generator-sdk/src/manifest.ts:56`](../../generator-sdk/src/manifest.ts) has exactly three members —
+`orchestration?`, `structuredOutput?`, `tracing?` — and adding a fourth is an SDK change, which is outside this
+layer.
+
+The plan cites [`manifest.test.ts:135`](../../generator-sdk/test/manifest.test.ts) as evidence that
+`emitsAgainst.vectorStore` is supported. That line is inside the test *"rejects an unknown emitsAgainst key and
+an out-of-vocabulary value"*, and it asserts `manifestUnknownKey` **for** `{ vectorStore: 'pgvector' }`: the plan
+cited the counter-example as if it were the example.
+
+`pgvector` is nevertheless honoured — as the IR's store kind
+([`packages/ir/src/shapes.ts:397-400`](../../ir/src/shapes.ts)), not as an `emitsAgainst` key. `validate.ts`
+accepts `memory` and `pgvector` stores and refuses any other kind, and the emitted `retrieval/bindings.ts` passes
+the kind through to the runtime, whose `PgVectorStore` adapter loads its driver lazily. So the **substance** of
+the plan's declaration is present; the declared shape is the SDK's. This is the same fail-closed resolution
+`py-fastapi` reached, and for the same reason: a manifest that does not parse is not a target.
+
+A test pins the key set to an exact literal — `Object.keys(manifest.emitsAgainst).sort()` equals
+`['structuredOutput', 'tracing']` — the same non-vacuous shape
+[`py-fastapi/test/target.test.ts:137`](../py-fastapi/test/target.test.ts) uses, so adding or dropping a key fails
+rather than silently passing.
+
+## Capabilities: 6 declared, `streaming` not
+
+| Declared | Honoured by |
+| --- | --- |
+| `http-trigger` | `routes/<pipeline>.ts`, a Fetch-shaped handler Next serves |
+| `json-schema` | `schemas.ts`, zod schemas the runtime validates structured output with |
+| `tool-calling` | `tools/**` and `contracts/**`, adapters over handlers you own |
+| `otel` | `observability.ts`, the runtime tracer |
+| `embeddings` | `retrieval/bindings.ts`, `retrieval/index.ts`, `retrieval/ingest/**` |
+| `rerank` | the retriever binding's `rerank` spec, resolved by the runtime's `rerankerFor` |
+
+`streaming` is **not** declared. `ModelGateway.stream` raises `FeatureDeferredError`, so declaring the capability
+would be the fail-open the capability discipline forbids: a target must not advertise what it cannot emit.
+
+**Emits** (24 files per generated app — [`§8.3`](../../../docs/design.md)):
+
+- **Model gateway wiring** — `gateway/models.ts` and `gateway/index.ts`: one alias per declared model, with
+  provider, model id and cost profile, validated against the runtime's adapter registry.
+- **Prompt registry wiring** — `prompts/<prompt>.ts` and `prompts/index.ts`: the template, its version, and the
+  typed values it interpolates.
+- **One structured-output endpoint** — `requests.ts`, `schemas.ts`, `routes/<pipeline>.ts` and
+  `pipelines/<pipeline>.ts`: the request shape, the response schema, the route handler, and the plain-async
+  pipeline that renders the prompt, calls the gateway, runs the tool and shapes the response.
+- **One tool** — `tools/<tool>.ts` plus `contracts/<tool>.ts`, and their two indexes: a zod-validated adapter
+  over a handler you own. The handler itself is seeded once and then yours.
+- **Retrieval** — `retrieval/bindings.ts`, `retrieval/index.ts` and `retrieval/ingest/**`: the embedding, store
+  and retriever declarations, the `buildRetrievers` factory that resolves and validates the binding at startup,
+  and one idempotent ingest entry point per retriever.
+- **Evals** — `evals/<eval>.ts` and `evals/index.ts`: the dataset loader, the stored baseline, the metric list and
+  the gate, delegating every statistic to `@aid-framework/runtime`.
+- **`observability.ts`** and **`deps.ts`** — tracer setup and the dependency container that the route and the eval
+  both build from, so the eval measures the prompt the app actually renders.
+
+Packaging, the Next `app/api/**` shim and the tests are **not** generated: `package.json`, `app/api/<path>/route.ts`
+and `tests/**` are hand-written in the example, because a plan may only write into the two managed tiers below.
+
+## Layout and ownership ([`§8.4`](../../../docs/design.md))
+
+| Path | Owner | On regeneration |
+| --- | --- | --- |
+| `app/generated/**` | the generator | overwritten, never merged |
+| `app/business/**` | you | created once if missing, then **never** touched |
+| `app/aid.manifest.json` | the generator | rewritten from the plan; not a planned artifact itself |
+
+A generated file whose bytes no longer match the hash recorded in the manifest is **drift**: regeneration reports
+it as an error, leaves your edit in place, and writes the content it wanted beside it as `<path>.aid-rej`.
+`--force` discards the edit instead (with a warning), and `--prune` deletes generated files the plan no longer
+produces ([`§10`](../../../docs/design.md)).
+
+## Accepted collision: `output.root: 'app'`
+
+Decision A7 puts `generated/` and `business/` under `output.root: 'app'` for parity with the Python target, and
+that root is also Next.js's own App Router directory. The plan names the collision, accepts it for parity with
+the SDK's `managedRoots`, and flags it for review; **this package accepts it too rather than working around it.**
+The consequences, stated plainly:
+
+- `app/generated/**` and `app/business/**` sit beside your own routes, layouts and pages, in the directory the
+  framework already owns. Nothing is lost, because the two managed tiers are disjoint from Next's file
+  conventions (`route.ts`, `layout.tsx`, `page.tsx`), but it is a naming collision a reader must know about.
+- A future `output.root` of `.` would remove it at the cost of parity; that is a plan decision, not this layer's.
+
+## Deviation: the `app/api/**` shim is hand-written
+
+A7 also asks the generator to emit "a thin emitted `app/api/<path>/route.ts` shim that Next actually serves".
+**This package does not emit it**, for two independent mechanical reasons, either of which is sufficient:
+
+1. **The plan validator refuses the path.** `validatePlan` accepts writes only under the manifest's managed roots
+   (`app/generated`, `app/business`); `app/api/tickets/route.ts` is rejected with `generator/plan-owner-mismatch`.
+   A test asserts exactly that rejection.
+2. **The manifest's owner cross-check would break every later run.** `parseAidManifest` treats the first path
+   segment as the owner, so a recorded `app/api/...` entry does not match the generator's root and the next
+   `aid gen` fails to parse the manifest it wrote itself — a hard CLI break, not a cosmetic mismatch.
+
+So the generator emits the real handler at `app/generated/routes/<pipeline>.ts`, which exports both
+`handle<Pipeline>` and a `ROUTE` constant (`{ method, path }`), and the example hand-writes the three-line Next
+shim at `app/api/tickets/answer/route.ts`. This mirrors `py-fastapi`, where `app/main.py` is likewise hand-written
+because a plan may not write outside its tiers: the framework's mount point is yours, the handler is generated.
+
+## No `next` dependency
+
+Next is the **deployment target**, not a dependency of this repository. `next` pulls `caniuse-lite`, which is
+CC-BY-4.0, and [`scripts/check-licenses.mjs`](../../../scripts/check-licenses.mjs) allows only
+0BSD/Apache-2.0/BlueOak/BSD/CC0-1.0/ISC/MIT/MIT-0/MPL-2.0/Python-2.0/PSF-2.0/Unlicense/WTFPL. Adding Next would
+mean weakening the license allowlist, which this layer does not do. The example therefore ships
+`tests/server.ts`, a Node host that speaks the same Fetch-shaped contract as the emitted handler and looks up the
+same `ROUTE` constant, so the end-to-end job can boot generated code and hit a real socket without a Next install.
+
+**Determinism** ([`§8.2`](../../../docs/design.md)): output is path-sorted, LF-only, with one trailing newline, no
+timestamps, no absolute paths and no machine names. `checkDeterminism` in the generator SDK is the lint that holds
+this; a test in this package plans the example twice and compares bytes.
+
+**Prompt templates** are the one place the two runtimes disagree about syntax: the IR stores `{{ name }}` mustaches
+and the TypeScript runtime parses `str.format`-style `{name}` fields. `src/placeholders.ts` performs that
+conversion once, `validate.ts` refuses a template the runtime cannot interpolate, and the emitter never re-indents
+template content.
+
+**Not responsible for:** runtime behaviour — the gateway, prompt registry, tool executor, tracing, retrieval, the
+eval harness and the baseline statistics all live in [`runtimes/typescript/`](../../../runtimes/typescript/).
+
+**Status:** implemented for the Phase 1 scope and reachable as `aid gen --target ts-vercel` through the two-entry
+registry in [`packages/cli/src/targets.ts`](../../cli/src/targets.ts). `py-fastapi` remains the default target.
+
+**Scope boundary:** the generator rejects what it cannot express rather than emitting something broken
+([`§4`](../../../docs/design.md), capability negotiation) — `cursor-memory`, guardrails, multi-step agent loops,
+streaming bodies, `llm-judge` as a required CI gate, latency and cost budgets, eval metrics selected by field or
+value, non-`http` triggers, retriever `filters` and non-file sources. Each refusal has a plan diagnostic code.
+
+**Tests:** `test/golden.test.ts` (the example's committed tree *is* the golden fixture), `test/drift.test.ts`
+(regeneration safety across both tiers), `test/target.test.ts` (manifest, capability discipline, IR-only purity,
+layout), `test/text.test.ts` (the byte-level helpers, including the linear edge trim every emitter shares) and
+[`packages/cli/test/targets.test.ts`](../../cli/test/targets.test.ts) (the registry cross-check). The
+example app is in [`examples/support-copilot-ts/`](../../../examples/support-copilot-ts/), and the end-to-end job
+runs `pnpm e2e:ts` after the Python example's `pnpm e2e` in the same `e2e` job, then the example's own suite
+(`pnpm --filter support-copilot-ts-example test`), which the root `vitest` run does not collect and whose 7 passing
+tests are pinned by `examples/support-copilot-ts/scripts/run-tests.mjs`.
+
+Reference: [`docs/design.md` §8](../../../docs/design.md) (generator plugin model),
+[`§9`](../../../docs/design.md) (runtime libraries), [`§6.1`](../../../docs/design.md) (example spec),
+[`§12`](../../../docs/design.md) (testing), [`§14`](../../../docs/design.md) (roadmap).