@aid-framework/generator-sdk 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,171 @@
-# Temporary Holding Version
+# `@aid-framework/generator-sdk` — generator plugin interface
 
-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.
+Defines what a generator plugin *is*, so third-party and first-party targets are built the same way, and
+supplies the three things every generator needs to be safe to re-run: a manifest, an ownership/drift
+algorithm, and a determinism contract.
+
+Layering is strictly one-directional: `spec ← ir ← generator-sdk ← generators ← cli`. This package imports
+`@aid-framework/ir` and `@aid-framework/spec`; neither may import this one. That constraint is why a target's capability
+declaration travels as **data** (`targetCapabilityDeclarations`) rather than the IR's capability gate
+reaching in here — [`@aid-framework/ir`'s README](../ir/README.md) documented the placeholder it ships, and this
+package is the replacement for it.
+
+## The generator manifest
+
+A generator declares itself with a `GeneratorManifest` (`GENERATOR_MANIFEST_VERSION` is `"0.1.0"`): `name`,
+`target`, `version`, `irRange`, `capabilities`, `emitsAgainst`, `output`, and an optional `optionsSchema`.
+
+`emitsAgainst` is the interesting field, because it is what lets a generated app be reasoned about rather
+than only diffed. It names the runtime the output is paired with and the shape of what gets emitted:
+
+| Key | Values |
+| --- | --- |
+| `runtime` | e.g. `py-fastapi` |
+| `orchestration` | `ORCHESTRATIONS` — Phase 0 emits `plain-async` only |
+| `tracingBackend` | `TRACING_BACKENDS` — e.g. `otel-genai` |
+| `structuredOutput` | `STRUCTURED_OUTPUTS` — e.g. `pydantic-ai` |
+
+Validation returns diagnostics, never thrown exceptions, in the same compiler-style shape as `@aid-framework/spec` and
+`@aid-framework/ir`, so a user sees one report whatever layer rejected the input. Codes are namespaced `generator/*`
+and never reuse a `spec/*` or `ir/*` code.
+
+```ts
+import { parseManifestJson, validateGeneratorSet, checkIRSupport } from '@aid-framework/generator-sdk';
+import { IR_VERSION } from '@aid-framework/ir';
+
+const parsed = parseManifestJson(source);
+if (!parsed.ok) throw new Error(JSON.stringify(parsed.diagnostics, null, 2));
+
+checkIRSupport(parsed.manifest, IR_VERSION); // [] when the generator's irRange covers the IR
+validateGeneratorSet([parsed.manifest]);     // [] when the set is coherent
+```
+
+- `parseManifest(value)` / `parseManifestJson(text)` return `{ ok, manifest, diagnostics }`.
+- `validateManifest(value)` returns the diagnostics for one manifest; `validateGeneratorSet(manifests)`
+  additionally rejects two generators claiming the same `target`.
+- `supportsIR(manifest, irVersion?)` and `checkIRSupport(...)` compare against `irRange` using this package's
+  own semver parser, so the range vocabulary is shared with nothing outside the repo.
+- `managedRoots(manifest)` turns a manifest into the `PlanValidationOptions` its plans must satisfy.
+- `targetCapabilityDeclarations(manifests)` renders `{ target: capabilities[] }` for
+  `runGates(ir, { targetCapabilities })`.
+- `phase0TargetCapabilities` / `phase0Generators` are the committed Phase 0 declarations.
+
+Those declarations are deliberately honest rather than aspirational: `streaming` is declared even though the
+runtime is request/response only (so the IR vocabulary is exercised end to end), and no `orchestration` is
+declared because Phase 0 control flow is plain async.
+
+## `generated/` vs `business/` — the ownership model
+
+The three-tier split is the whole reason regeneration is safe (§8.3, §8.4):
+
+| Tier | Owner | Regeneration behaviour |
+| --- | --- | --- |
+| `generated/` | the generator | overwritten on every run — never hand-edit |
+| `business/` | the developer | written **once**, never overwritten |
+| the seam | — | `business/` is what the generator calls into; it is the escape hatch |
+
+Ownership is decided by **where a path lives**, not by what a generator says about it: every planned path is
+normalized through `src/ownership.ts`, so a generator cannot escape its own root (`escapesRoot`,
+`isAbsolutePath`), cannot claim a `business/` path as generated (`planOwnerMismatch`), and cannot write the
+manifest file (`isReservedPath`). `ownerForPath`, `isGeneratedPath` and `isBusinessPath` are the predicates,
+parameterized by `DEFAULT_GENERATED_DIR` / `DEFAULT_BUSINESS_DIR`.
+
+## The drift algorithm
+
+This is the algorithm the ownership model exists to support (§10), stated once in `src/drift.ts`:
+
+1. Plan the new file set — `plan(ir) -> Plan` is pure and writes nothing.
+2. For each planned `generated/` file: if it exists and its hash is **not** the one recorded in the
+   manifest, a human edited generated code. Do not overwrite it; write the new content to `<path>.aid-rej`
+   and fail with guidance.
+3. For each planned `business/` file: create only if missing. Never overwrite.
+4. Write atomically, then update the manifest.
+5. Report created / updated / unchanged / conflicts.
+
+Step 2 is the whole point. A generator that overwrites `generated/` unconditionally destroys the one signal
+it has that a human disagreed with it, and the loss is silent. Refusing, keeping the rejected bytes next to
+the file (`.aid-rej`, per `REJECTION_SUFFIX`), and naming both escapes — `aid eject <path>` to take
+ownership of a file, `--force` to discard the edits — turns silent data loss into a decision.
+
+```ts
+import { planRegeneration, regenerate, hasDrift } from '@aid-framework/generator-sdk';
+
+const preview = planRegeneration(plan, { sink, manifest }); // pure: nothing is written
+if (hasDrift(preview)) {
+  // preview.actions carries { kind: 'drift', path, recordedSha256, actualSha256 }
+}
+
+const { report, manifest: next } = regenerate(plan, { sink, manifest, provenance });
+```
+
+`RegenerationAction` is `create | update | unchanged | keep-business | drift`, so a caller can render a
+`--dry-run` from the same code path that writes. Two limits are deliberate: a planned file that is newer than
+the manifest but has **no** record at all is treated as drift rather than adopted (an unrecorded file under
+`generated/` cannot be proven unmodified), and stale generated files — recorded but no longer planned — are
+reported but never deleted unless `prune` is passed explicitly, because deletion is the one operation with no
+recovery.
+
+`createNodeSink(root)` writes to disk; `createMemorySink()` is the same `RegenerationSink` interface in
+memory, which is what the drift tests drive every action through.
+
+## The manifest on disk
+
+`.aid-manifest.json` (`DEFAULT_MANIFEST_FILENAME`, version `AID_MANIFEST_VERSION`) records provenance —
+generator name and version, IR version, spec version — plus one entry per file: `path`, `owner`, `sha256`,
+`generator`, `generatorVersion`. It is what makes step 2 above possible, and what lets a later run tell
+`unchanged` from `edited`.
+
+```ts
+import { manifestFor, parseAidManifestJson, serializeAidManifest } from '@aid-framework/generator-sdk';
+
+const manifest = manifestFor(files, provenance);
+const text = serializeAidManifest(manifest);
+```
+
+`serializeAidManifest` is canonical — keys sorted, LF endings, one trailing newline — so the manifest itself
+does not churn a diff. `emptyAidManifest`, `manifestRecordFor`, and
+`parseAidManifest`/`parseAidManifestJson` round out the module.
+
+## Determinism
+
+The contract is narrow and absolute (§8.2): **no timestamps, no host names, no absolute paths, no
+randomness** in generated code. A single timestamp turns every regeneration into a diff, and the golden-file
+tests (§12 regime A) compare bytes.
+
+```ts
+import { checkDeterminism } from '@aid-framework/generator-sdk';
+
+const violations = checkDeterminism(files); // { path, pattern, line, excerpt }[]
+```
+
+- Primitives: `normalizeNewlines`, `ensureTrailingNewline`, `normalizeText`, `sha256Hex`,
+  `stableId(namespace, value)`, and `compareIds` / `sortById` / `sortByPath` / `stableSortBy` for ordering by
+  a **stable ID** rather than by whatever order the IR happened to be walked in.
+- `generatedBanner(options)` writes the do-not-edit header (`GENERATED_BANNER_MARKER`), which is the only
+  thing standing between a reader and an edit the next regeneration will refuse.
+- `DETERMINISM_PATTERNS` is the rule set and `scanForNonDeterminism(path, content)` the per-file checker, so
+  a generator's own tests can run the emitted set through it and fail the build. That is what makes the
+  contract testable instead of aspirational.
+
+The contract applies to **generated code, never to model output** (§8.2): completions are expected to vary,
+and eval gating accounts for that by sampling rather than by comparing bytes.
+
+## Development
+
+```sh
+pnpm build
+pnpm test
+```
+
+`test/` covers the manifest and plan validation, the ownership predicates, the determinism primitives, the
+semver range parser, the on-disk manifest, both sinks, and — the suite that matters most — `drift.test.ts`,
+which drives every `RegenerationAction` including the refuse-and-write-rejection path.
+
+**Not responsible for:** emitting any specific target's code (see [`../generators/`](../generators/)) or for
+the behavior of generated apps (see [`../../runtimes/`](../../runtimes/)).
+
+**Status:** the three responsibilities above are implemented for Phase 0. Deferred by design: escalation
+routing and any orchestration beyond plain async (§14) — which is why the Phase 0 capability declarations
+declare none.
+
+Reference: [`docs/design.md` §8, §8.3, §8.4, §10](../../docs/design.md).