@opensoftware/contracts 0.0.0-stage → 1.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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,106 @@
-# Temporary Holding Version
+---
+covers: [contracts/typespec/**, contracts/src/**, contracts/scripts/**, contracts/events/asyncapi.yaml]
+---
 
-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.
+# contracts
+
+The formats that modules share, from one TypeSpec source: JSON Schemas for every format, the AsyncAPI document of
+the events, and the TypeScript package `@opensoftware/contracts`. Decisions:
+[ADR 0006](../docs/decisions/0006-contracts-typespec.md), [ADR 0012](../docs/decisions/0012-contracts-toolchain.md).
+
+## Quick start
+
+This quick start is scenario `SCN-CTR-001` and is tested on every change.
+
+```sh
+npx @opensoftware/contracts validate factory-definition factory.yaml
+# factory.yaml: valid factory-definition
+```
+
+From TypeScript:
+
+```ts
+import { type FactoryDefinition, validate } from "@opensoftware/contracts";
+
+const problems = validate("factory-definition", document); // [] when valid, else { path, message } per problem
+```
+
+The schema files are exported at the paths in the table below, for example
+`@opensoftware/contracts/work-item/work-item.schema.json`, along with `events/asyncapi.yaml`, `openapi/*` and `typespec/*`.
+
+## Formats
+
+Each format has one schema, generated from `typespec/`, and fixtures that CONTRACT checks on every change.
+
+| Format | Schema | Model | Notes |
+| --- | --- | --- | --- |
+| factory definition | `factory-definition/factory-definition.schema.json` | `FactoryDefinition` | `factory.yaml`. Closed objects: an unknown field is an error. |
+| work item | `work-item/work-item.schema.json` | `WorkItem` | The `data` of `work.received@v1`. |
+| run record | `run-record/run-record.schema.json` | `RunRecord` | OTel resource and root-span attributes; pins in `typespec/run-record.tsp`. |
+| evidence bundle | `evidence-bundle/evidence-bundle.schema.json` | `EvidenceManifest` | `evidence.json` at the bundle root. |
+| score | `score/score.schema.json` | `Score` | Subset of Langfuse's create-score request; factory fields in `metadata`. |
+| events | `events/<event>/<event>.schema.json`, `events/asyncapi.yaml` | `WorkReceived` … `PrOpened` | CloudEvents 1.0, structured JSON. |
+
+Wire formats (everything but the factory definition) are open: readers ignore fields they do not know, so a minor
+version may add optional fields. Read `factory.yaml` with a YAML 1.2 parser: YAML 1.1 parsers turn the key `on`
+into `true`.
+
+## Commands
+
+| Command | What it does |
+| --- | --- |
+| `osf-contracts validate <format> <file>` | Check a YAML or JSON document. Prints `<file>: valid <format>`, or one `<file> <JSON Pointer>: <problem>` line per problem and exits 1. |
+| `osf-contracts breaking [--base <ref>]` | Compare every schema with the last `contracts-v*` tag (or `<ref>`). A change that makes released documents invalid fails unless `contracts/package.json` has a new major version. |
+| `osf-contracts roundtrip --client typescript [dir]` | Load every valid fixture under `dir` (default `contracts`) with the generated TypeScript types and compare what they write back. TypeScript is the only client (ADR 0012). |
+
+## Changing a format
+
+1. Change `typespec/`. Run `pnpm build` in `contracts/`; it regenerates the schemas, `openapi/openapi.json`,
+   `src/generated/types.ts` and `dist/`. `pnpm lint` fails when a committed generated file is out of date.
+2. Add or update fixtures in `<format>/fixtures/{valid,invalid}/`.
+3. A breaking change (removed or newly required field, changed type, removed enum value, closed object, tighter
+   bound or pattern) needs a new major version in `package.json`. Prefer a new optional field, or for events a new
+   type `name@v2` next to the old one.
+
+## Releases
+
+release-please opens a release pull request from the Conventional Commits under `contracts/`. Merging it creates
+the tag `contracts-v<version>`. The workflow `.github/workflows/publish-contracts.yml` then builds the package and
+publishes it to npm as `@opensoftware/contracts`, with provenance. To publish a tag again, run the workflow by
+hand with the tag. The CONTRACT check and `osf-contracts breaking` compare with the newest `contracts-v*` tag.
+
+Only the TypeScript package exists (ADR 0012). A client for another language can be generated from
+`openapi/openapi.json` with any OpenAPI generator when someone needs one.
+
+One-time setup (no credential is ever stored in the repository):
+
+1. npm: the organization `opensoftware` owns the scope `@opensoftware`, under which every package of this
+   repository is published.
+2. GitHub: the publish job runs in the environment `npm` (Settings → Environments; GitHub creates it on the first
+   run).
+3. First version only: npm configures trusted publishing per existing package, so `1.0.0` needs a token. Add a
+   granular npm access token with read and write access to the `opensoftware` organization's packages as the
+   secret `NPM_TOKEN` (a repository secret or a secret of the environment `npm`), or publish `1.0.0` by hand.
+4. After the first version: on npmjs.com, package settings → Trusted publishing, add GitHub Actions with the
+   repository `sesigl/open-software-factory`, the workflow `publish-contracts.yml` and the environment `npm`.
+   Then delete the secret `NPM_TOKEN` and revoke the token. Later versions publish through OIDC only.
+
+## Configuration
+
+None. The CLI reads no environment variables.
+
+## Scenarios
+
+<!-- generated by make docs from features/: do not edit -->
+
+| ID | Status | Scenario |
+| --- | --- | --- |
+| SCN-CTR-001 | implemented | A valid factory definition validates |
+| SCN-CTR-002 | implemented | A factory definition with an unknown agent field is rejected with its path |
+| SCN-CTR-003 | implemented | A run record that names its transcript, artifacts and pull request validates |
+| SCN-CTR-004 | implemented | A run record without a requester is rejected with its path |
+| SCN-CTR-005 | implemented | A breaking change to a released schema fails the compatibility check |
+| SCN-CTR-006 | implemented | The generated TypeScript types round-trip every valid fixture |
+| SCN-CTR-007 | deprecated | The generated Python client round-trips every valid fixture |
+| SCN-CTR-008 | deprecated | The generated Java client round-trips every valid fixture |
+| SCN-CTR-009 | implemented | A tighter form of a "exactly one of" rule fails the compatibility check |

package/dist/breaking.d.ts

@@ -0,0 +1,27 @@
+export interface Schema {
+    type?: string | string[];
+    properties?: Record<string, Schema>;
+    required?: string[];
+    enum?: unknown[];
+    const?: unknown;
+    items?: Schema;
+    anyOf?: Schema[];
+    oneOf?: Schema[];
+    additionalProperties?: boolean | Schema;
+    unevaluatedProperties?: boolean | Schema;
+    pattern?: string;
+    format?: string;
+    minLength?: number;
+    maxLength?: number;
+    minimum?: number;
+    maximum?: number;
+    exclusiveMinimum?: number;
+    exclusiveMaximum?: number;
+    minItems?: number;
+    maxItems?: number;
+    minProperties?: number;
+    maxProperties?: number;
+}
+export declare function breaking(baseRef: string | undefined): number;
+/** Changes that make data valid under `before` invalid under `after`. */
+export declare function diff(before: Schema, after: Schema, path?: string): string[];

package/dist/breaking.js

@@ -0,0 +1,156 @@
+// `osf-contracts breaking`: schema changes since the last release that make documents valid under the released
+// schema invalid, unless the version in contracts/package.json has a new major number.
+import { spawnSync } from "node:child_process";
+import { existsSync, readdirSync, readFileSync, statSync } from "node:fs";
+import { join, relative } from "node:path";
+const RELEASE_TAGS = "contracts-v*";
+export function breaking(baseRef) {
+    const root = git(["rev-parse", "--show-toplevel"], process.cwd());
+    if (root === undefined)
+        return fail("osf-contracts breaking runs inside a Git repository");
+    const base = baseRef ?? git(["tag", "--list", RELEASE_TAGS, "--sort=-v:refname"], root)?.split("\n")[0];
+    if (!base) {
+        process.stdout.write(`no ${RELEASE_TAGS} release tag: nothing to compare\n`);
+        return 0;
+    }
+    if (git(["rev-parse", "--verify", "--quiet", `${base}^{commit}`], root) === undefined) {
+        return fail(`${base} is not a commit, tag or branch`);
+    }
+    const version = (at) => {
+        const text = at ? git(["show", `${at}:contracts/package.json`], root) : read(join(root, "contracts/package.json"));
+        return text ? JSON.parse(text).version : undefined;
+    };
+    const before = version(base);
+    const after = version();
+    const major = (value) => Number(value?.split(".")[0] ?? Number.NaN);
+    const allowed = major(after) > major(before);
+    const released = (git(["ls-tree", "-r", "--name-only", base, "--", "contracts"], root) ?? "")
+        .split("\n")
+        .filter(isSchema);
+    const current = new Set(schemaFiles(join(root, "contracts")).map((file) => relative(root, file)));
+    let failures = 0;
+    for (const file of released) {
+        const changes = current.has(file)
+            ? diff(JSON.parse(git(["show", `${base}:${file}`], root) ?? "{}"), JSON.parse(readFileSync(join(root, file), "utf8")))
+            : ["removed the format"];
+        if (changes.length === 0)
+            continue;
+        if (allowed) {
+            process.stdout.write(`${file}: breaking change allowed by the major version ${before} → ${after}: ${changes.join("; ")}\n`);
+            continue;
+        }
+        failures++;
+        process.stdout.write(`${file}: breaking change since ${base} without a major version (${before ?? "?"} → ${after ?? "?"}): ${changes.join("; ")}\n`);
+    }
+    if (failures === 0)
+        process.stdout.write(`no breaking change since ${base}\n`);
+    return failures === 0 ? 0 : 1;
+}
+/** Changes that make data valid under `before` invalid under `after`. */
+export function diff(before, after, path = "") {
+    const changes = [];
+    const at = path || "the root";
+    const name = (key) => (path ? `${path}.${key}` : key);
+    const types = (schema) => [schema.type ?? []].flat().sort().join("|");
+    if (before.type !== undefined && types(before) !== types(after)) {
+        const widened = types(before) === "integer" && types(after) === "number";
+        if (!widened)
+            changes.push(`changed the type of ${at} from ${types(before)} to ${types(after) || "any"}`);
+    }
+    for (const key of Object.keys(before.properties ?? {})) {
+        const next = after.properties?.[key];
+        if (!next)
+            changes.push(`removed property ${name(key)}`);
+        else
+            changes.push(...diff(before.properties?.[key], next, name(key)));
+    }
+    for (const key of after.required ?? []) {
+        if (!(before.required ?? []).includes(key))
+            changes.push(`made ${name(key)} required`);
+    }
+    if (after.enum) {
+        for (const value of before.enum ?? []) {
+            if (!after.enum.some((candidate) => same(candidate, value))) {
+                changes.push(`removed the value ${JSON.stringify(value)} from ${at}`);
+            }
+        }
+    }
+    if ("const" in after && !("const" in before && same(before.const, after.const))) {
+        changes.push(`fixed ${at} to ${JSON.stringify(after.const)}`);
+    }
+    for (const keyword of ["additionalProperties", "unevaluatedProperties"]) {
+        const old = before[keyword];
+        const next = after[keyword];
+        if (old !== false && next === false)
+            changes.push(`closed ${at} to unknown properties`);
+        if (typeof old === "object" && typeof next === "object")
+            changes.push(...diff(old, next, name("*")));
+    }
+    if (before.items && after.items)
+        changes.push(...diff(before.items, after.items, `${path}[]`));
+    for (const keyword of ["anyOf", "oneOf"]) {
+        const old = before[keyword];
+        const next = after[keyword];
+        if (!old || !next)
+            continue;
+        if (next.length < old.length)
+            changes.push(`removed a form of ${at}`);
+        old.forEach((form, index) => {
+            const replaced = next[index];
+            if (replaced)
+                changes.push(...diff(form, replaced, `${path}|${index + 1}`));
+        });
+    }
+    changes.push(...constraints(before, after, at));
+    return changes;
+}
+/** Tighter bounds, a new or changed pattern, a new format. */
+function constraints(before, after, at) {
+    const changes = [];
+    const lower = ["minLength", "minimum", "exclusiveMinimum", "minItems", "minProperties"];
+    const upper = ["maxLength", "maximum", "exclusiveMaximum", "maxItems", "maxProperties"];
+    for (const key of lower) {
+        const next = after[key];
+        if (next !== undefined && next > (before[key] ?? Number.NEGATIVE_INFINITY))
+            changes.push(`raised ${key} of ${at} to ${next}`);
+    }
+    for (const key of upper) {
+        const next = after[key];
+        if (next !== undefined && next < (before[key] ?? Number.POSITIVE_INFINITY))
+            changes.push(`lowered ${key} of ${at} to ${next}`);
+    }
+    if (after.pattern !== undefined && after.pattern !== before.pattern)
+        changes.push(`changed the pattern of ${at}`);
+    if (after.format !== undefined && after.format !== before.format)
+        changes.push(`required the format ${after.format} for ${at}`);
+    return changes;
+}
+function same(a, b) {
+    return JSON.stringify(a) === JSON.stringify(b);
+}
+function isSchema(file) {
+    return file.endsWith(".schema.json") && !file.includes("/node_modules/") && !file.includes("/fixtures/");
+}
+function schemaFiles(dir) {
+    if (!existsSync(dir))
+        return [];
+    return readdirSync(dir).flatMap((entry) => {
+        if (entry === "node_modules" || entry === "fixtures" || entry.startsWith("."))
+            return [];
+        const full = join(dir, entry);
+        if (statSync(full).isDirectory())
+            return schemaFiles(full);
+        return isSchema(full) ? [full] : [];
+    });
+}
+function read(file) {
+    return existsSync(file) ? readFileSync(file, "utf8") : undefined;
+}
+function git(args, cwd) {
+    const result = spawnSync("git", args, { cwd, encoding: "utf8" });
+    return result.status === 0 ? result.stdout.trim() : undefined;
+}
+function fail(message) {
+    process.stderr.write(`${message}\n`);
+    return 2;
+}

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,68 @@
+#!/usr/bin/env node
+// osf-contracts: validate documents against the shared formats, check schema compatibility with the last release,
+// and round-trip the fixtures through the generated clients.
+import { readFileSync } from "node:fs";
+import { parse } from "yaml";
+import { breaking } from "./breaking.js";
+import { FORMATS, formatNamed } from "./formats.js";
+import { validate } from "./index.js";
+import { CLIENTS, roundtrip } from "./roundtrip.js";
+const USAGE = `Usage: osf-contracts <command>
+
+  validate <format> <file>       check a YAML or JSON document; formats: ${FORMATS.map((format) => format.name).join(", ")}
+  breaking [--base <ref>]        breaking schema changes since the last contracts-v* tag (or <ref>) without a major version
+  roundtrip --client <client> [dir]
+                                 load every valid fixture under dir (default contracts) with a generated client and
+                                 compare what it writes back; clients: ${CLIENTS.join(", ")}
+`;
+function main(argv) {
+    const [command, ...args] = argv;
+    switch (command) {
+        case "validate":
+            return validateCommand(args);
+        case "breaking": {
+            const at = args.indexOf("--base");
+            return breaking(at === -1 ? undefined : args[at + 1]);
+        }
+        case "roundtrip": {
+            const at = args.indexOf("--client");
+            const client = at === -1 ? undefined : args[at + 1];
+            const dir = args.filter((_, index) => index !== at && index !== at + 1)[0] ?? "contracts";
+            if (!client || !CLIENTS.includes(client))
+                return usage(`Give a client: ${CLIENTS.join(", ")}`);
+            return roundtrip(client, dir);
+        }
+        case undefined:
+        case "help":
+        case "--help":
+            process.stdout.write(USAGE);
+            return command === undefined ? 2 : 0;
+        default:
+            return usage(`Unknown command: ${command}`);
+    }
+}
+function validateCommand([name, file]) {
+    const format = name ? formatNamed(name) : undefined;
+    if (!format || !file)
+        return usage(name && !format ? `Unknown format: ${name}` : "Give a format and a file");
+    let document;
+    try {
+        document = parse(readFileSync(file, "utf8"));
+    }
+    catch (error) {
+        process.stdout.write(`${file}: not readable as YAML or JSON: ${error.message}\n`);
+        return 1;
+    }
+    const problems = validate(format, document);
+    for (const problem of problems)
+        process.stdout.write(`${file} ${problem.path}: ${problem.message}\n`);
+    if (problems.length > 0)
+        return 1;
+    process.stdout.write(`${file}: valid ${format.name}\n`);
+    return 0;
+}
+function usage(message) {
+    process.stderr.write(`${message}\n\n${USAGE}`);
+    return 2;
+}
+process.exitCode = main(process.argv.slice(2));

package/dist/formats.d.ts

@@ -0,0 +1,10 @@
+export interface Format {
+    /** CLI name and file name: `<path>/<name>.schema.json`. */
+    name: string;
+    /** Folder under contracts/. */
+    path: string;
+    /** The TypeSpec model, also the name of the generated type and class. */
+    model: string;
+}
+export declare const FORMATS: readonly Format[];
+export declare function formatNamed(name: string): Format | undefined;

package/dist/formats.js

@@ -0,0 +1,18 @@
+// The formats of the contracts: the name used on the CLI, the folder of the schema and the TypeSpec model.
+const format = (path, model) => ({ name: path.split("/").pop(), path, model });
+export const FORMATS = [
+    format("factory-definition", "FactoryDefinition"),
+    format("work-item", "WorkItem"),
+    format("run-record", "RunRecord"),
+    format("evidence-bundle", "EvidenceManifest"),
+    format("score", "Score"),
+    format("events/work-received", "WorkReceived"),
+    format("events/run-completed", "RunCompleted"),
+    format("events/gate-requested", "GateRequested"),
+    format("events/gate-decided", "GateDecided"),
+    format("events/score-recorded", "ScoreRecorded"),
+    format("events/pr-opened", "PrOpened"),
+];
+export function formatNamed(name) {
+    return FORMATS.find((candidate) => candidate.name === name);
+}