@starci/hfs 4.11.22 → 4.12.0

package/emit/operation-schemas.mjs

@@ -3,138 +3,158 @@ import fs from 'node:fs';
 import path from 'node:path';
 import { createRequire } from 'node:module';
 import vm from 'node:vm';
-
 /** The longest value of each fixed-format string that R305 leaves without an explicit bound; the emit publishes it as maxLength. */
 const FIXED_FORMAT_MAX = Object.freeze({ uuid: 36, guid: 36, cuid: 25, ulid: 26, nanoid: 21, ksuid: 27, xid: 20, ipv4: 15, ipv6: 45, e164: 16 });
-
 /** Reject schemas whose wire values remain unconstrained. */
 function assertClosedShape(schema, location) {
-  if (!schema || typeof schema !== 'object' || (!schema.type && !schema.enum && !Object.hasOwn(schema, 'const') && !schema.anyOf && !schema.oneOf && !schema.allOf)) {
-    throw new Error(`${location}: an open schema (any or unknown) is not an operation wire value`);
-  }
-  if (schema.additionalProperties === true) throw new Error(`${location}: an open object is not an operation wire value`);
-  if (schema.properties && schema.additionalProperties === undefined && schema.patternProperties === undefined) {
-    throw new Error(`${location}: an open object is not an operation wire value; use z.strictObject so unknown keys are refused`);
-  }
+    if (!schema || typeof schema !== 'object' || (!schema.type && !schema.enum && !Object.hasOwn(schema, 'const') && !schema.anyOf && !schema.oneOf && !schema.allOf)) {
+        throw new Error(`${location}: an open schema (any or unknown) is not an operation wire value`);
+    }
+    if (schema.additionalProperties === true)
+        throw new Error(`${location}: an open object is not an operation wire value`);
+    if (schema.properties && schema.additionalProperties === undefined && schema.patternProperties === undefined) {
+        throw new Error(`${location}: an open object is not an operation wire value; use z.strictObject so unknown keys are refused`);
+    }
 }
-
 /** A runtime bound must survive the JSON conversion; custom refinements alone cannot publish a bounded contract. */
 function assertEmittedBounds(schema, location) {
-  const types = Array.isArray(schema.type) ? schema.type : [schema.type];
-  const bounded = (keyword) => Number.isFinite(schema[keyword]) && schema[keyword] >= 0;
-  if (types.includes('string') && !schema.enum && !Object.hasOwn(schema, 'const') && !bounded('maxLength')) {
-    throw new Error(`${location}: the string bound must be representable as maxLength in JSON Schema`);
-  }
-  if (types.includes('array') && !bounded('maxItems')) throw new Error(`${location}: the array bound must be representable as maxItems in JSON Schema`);
-  const dictionary = (schema.additionalProperties && typeof schema.additionalProperties === 'object') || schema.patternProperties;
-  if (dictionary && !bounded('maxProperties')) {
-    throw new Error(`${location}: the dictionary bound must be representable as maxProperties in JSON Schema; custom refinements are not emitted by z.toJSONSchema`);
-  }
+    const types = Array.isArray(schema.type) ? schema.type : [schema.type];
+    const bounded = (keyword) => {
+        const value = schema[keyword];
+        return typeof value === 'number' && Number.isFinite(value) && value >= 0;
+    };
+    if (types.includes('string') && !schema.enum && !Object.hasOwn(schema, 'const') && !bounded('maxLength')) {
+        throw new Error(`${location}: the string bound must be representable as maxLength in JSON Schema`);
+    }
+    if (types.includes('array') && !bounded('maxItems'))
+        throw new Error(`${location}: the array bound must be representable as maxItems in JSON Schema`);
+    const dictionary = (schema.additionalProperties && typeof schema.additionalProperties === 'object') || schema.patternProperties;
+    if (dictionary && !bounded('maxProperties')) {
+        throw new Error(`${location}: the dictionary bound must be representable as maxProperties in JSON Schema; custom refinements are not emitted by z.toJSONSchema`);
+    }
 }
-
 /** The wire-bearing descendants of a JSON schema, each with an actionable field path. */
 function* schemaChildren(schema, location) {
-  for (const keyword of ['anyOf', 'oneOf', 'allOf', 'prefixItems']) {
-    for (const [index, child] of (schema[keyword] ?? []).entries()) yield [child, `${location}.${keyword}[${index}]`];
-  }
-  for (const [name, child] of Object.entries(schema.properties ?? {})) yield [child, `${location}.${name}`];
-  for (const [pattern, child] of Object.entries(schema.patternProperties ?? {})) yield [child, `${location}.${pattern}`];
-  if (schema.propertyNames) yield [schema.propertyNames, `${location}.key`];
-  if (schema.items) yield [schema.items, `${location}[]`];
-  if (schema.additionalProperties && typeof schema.additionalProperties === 'object') yield [schema.additionalProperties, `${location}.*`];
+    for (const keyword of ['anyOf', 'oneOf', 'allOf', 'prefixItems']) {
+        for (const [index, child] of (schema[keyword] ?? []).entries())
+            yield [child, `${location}.${keyword}[${index}]`];
+    }
+    for (const [name, child] of Object.entries(schema.properties ?? {}))
+        yield [child, `${location}.${name}`];
+    for (const [pattern, child] of Object.entries(schema.patternProperties ?? {}))
+        yield [child, `${location}.${pattern}`];
+    if (schema.propertyNames)
+        yield [schema.propertyNames, `${location}.key`];
+    if (schema.items)
+        yield [schema.items, `${location}[]`];
+    if (schema.additionalProperties && typeof schema.additionalProperties === 'object')
+        yield [schema.additionalProperties, `${location}.*`];
 }
-
 function assertClosedJsonSchema(schema, location) {
-  assertClosedShape(schema, location);
-  assertEmittedBounds(schema, location);
-  for (const [child, childLocation] of schemaChildren(schema, location)) assertClosedJsonSchema(child, childLocation);
+    assertClosedShape(schema, location);
+    assertEmittedBounds(schema, location);
+    for (const [child, childLocation] of schemaChildren(schema, location))
+        assertClosedJsonSchema(child, childLocation);
 }
-
 /** Loads schema-only modules and converts their exported zod values with the app's own z.toJSONSchema. */
 export function operationSchemaReader({ ts, program, repoRoot }) {
-  const checker = program.getTypeChecker();
-  const requireApp = createRequire(path.join(repoRoot, 'package.json'));
-  const loaded = new Map();
-  const actual = (symbol) => symbol?.flags & ts.SymbolFlags.Alias ? checker.getAliasedSymbol(symbol) : symbol;
-  const unwrap = (node) => {
-    while (node && (ts.isAsExpression(node) || ts.isTypeAssertionExpression(node) || ts.isSatisfiesExpression(node) || ts.isParenthesizedExpression(node) || ts.isNonNullExpression(node))) node = node.expression;
-    return node;
-  };
-  const initializer = (node, seen = new Set()) => {
-    node = unwrap(node);
-    if (node && (ts.isIdentifier(node) || ts.isPropertyAccessExpression(node))) {
-      const declaration = actual(checker.getSymbolAtLocation(node))?.valueDeclaration;
-      const value = declaration && valueOf(declaration);
-      if (value && !seen.has(declaration)) {
+    const checker = program.getTypeChecker();
+    const requireApp = createRequire(path.join(repoRoot, 'package.json'));
+    const loaded = new Map();
+    const actual = (symbol) => symbol?.flags & ts.SymbolFlags.Alias ? checker.getAliasedSymbol(symbol) : symbol;
+    const unwrap = (node) => {
+        while (node && (ts.isAsExpression(node) || ts.isTypeAssertionExpression(node) || ts.isSatisfiesExpression(node) || ts.isParenthesizedExpression(node) || ts.isNonNullExpression(node)))
+            node = node.expression;
+        return node;
+    };
+    const initializer = (node, seen = new Set()) => {
+        node = unwrap(node);
+        if (node && (ts.isIdentifier(node) || ts.isPropertyAccessExpression(node))) {
+            const declaration = actual(checker.getSymbolAtLocation(node))?.valueDeclaration;
+            const value = declaration && valueOf(declaration);
+            if (value && !seen.has(declaration)) {
+                seen.add(declaration);
+                return initializer(value, seen);
+            }
+        }
+        return node;
+    };
+    const valueOf = (property) => {
+        if (!property || !ts.isShorthandPropertyAssignment(property))
+            return property?.initializer;
+        const value = actual(checker.getShorthandAssignmentValueSymbol(property));
+        return value?.valueDeclaration?.initializer && !value.valueDeclaration.getSourceFile().fileName.endsWith('.schema.ts')
+            ? value.valueDeclaration.initializer
+            : value?.valueDeclaration?.name ?? property.name;
+    };
+    const schemaSymbol = (node, seen = new Set()) => {
+        node = unwrap(node);
+        const symbol = node && actual(checker.getSymbolAtLocation(node));
+        const declaration = symbol?.valueDeclaration;
+        if (!declaration || seen.has(declaration))
+            return null;
+        if (declaration.getSourceFile().fileName.endsWith('.schema.ts'))
+            return symbol;
         seen.add(declaration);
-        return initializer(value, seen);
-      }
+        return declaration.initializer ? schemaSymbol(declaration.initializer, seen) : null;
+    };
+    function load(file) {
+        const cached = loaded.get(file);
+        if (cached)
+            return cached.exports;
+        if (!file.endsWith('.schema.ts'))
+            throw new Error(`schema dependencies must be *.schema.ts, found ${file}`);
+        const source = program.getSourceFile(file)?.text ?? fs.readFileSync(file, 'utf8');
+        const compiled = ts.transpileModule(source, { fileName: file, compilerOptions: { target: ts.ScriptTarget.ES2022, module: ts.ModuleKind.CommonJS, esModuleInterop: true } }).outputText;
+        const module = { exports: {} };
+        loaded.set(file, module);
+        const requireSchema = (specifier) => {
+            if (/^zod(?:\/|$)/.test(specifier))
+                return requireApp(specifier);
+            const resolved = ts.resolveModuleName(specifier, file, program.getCompilerOptions(), ts.sys).resolvedModule?.resolvedFileName;
+            if (!resolved?.endsWith('.schema.ts'))
+                throw new Error(`schema modules may import only zod and *.schema.ts, found ${specifier} in ${file}`);
+            return load(resolved);
+        };
+        // zod is the app's dependency, not the schema's code: it loads before the timed run, so the 1000 ms budget bounds only the
+        // schema module itself (a cold zod load inside it ran past the budget on a loaded machine).
+        for (const [, specifier] of compiled.matchAll(/require\("(zod(?:\/[^"]*)?)"\)/g))
+            requireApp(specifier);
+        new vm.Script(compiled, { filename: file }).runInNewContext({ module, exports: module.exports, require: requireSchema }, { timeout: 1000 });
+        return module.exports;
     }
-    return node;
-  };
-  const valueOf = (property) => {
-    if (!property || !ts.isShorthandPropertyAssignment(property)) return property?.initializer;
-    const value = actual(checker.getShorthandAssignmentValueSymbol(property));
-    return value?.valueDeclaration?.initializer && !value.valueDeclaration.getSourceFile().fileName.endsWith('.schema.ts')
-      ? value.valueDeclaration.initializer
-      : value?.valueDeclaration?.name ?? property.name;
-  };
-  const schemaSymbol = (node, seen = new Set()) => {
-    node = unwrap(node);
-    const symbol = node && actual(checker.getSymbolAtLocation(node));
-    const declaration = symbol?.valueDeclaration;
-    if (!declaration || seen.has(declaration)) return null;
-    if (declaration.getSourceFile().fileName.endsWith('.schema.ts')) return symbol;
-    seen.add(declaration);
-    return declaration.initializer ? schemaSymbol(declaration.initializer, seen) : null;
-  };
-  function load(file) {
-    if (loaded.has(file)) return loaded.get(file).exports;
-    if (!file.endsWith('.schema.ts')) throw new Error(`schema dependencies must be *.schema.ts, found ${file}`);
-    const source = program.getSourceFile(file)?.text ?? fs.readFileSync(file, 'utf8');
-    const compiled = ts.transpileModule(source, { fileName: file, compilerOptions: { target: ts.ScriptTarget.ES2022, module: ts.ModuleKind.CommonJS, esModuleInterop: true } }).outputText;
-    const module = { exports: {} };
-    loaded.set(file, module);
-    const requireSchema = (specifier) => {
-      if (/^zod(?:\/|$)/.test(specifier)) return requireApp(specifier);
-      const resolved = ts.resolveModuleName(specifier, file, program.getCompilerOptions(), ts.sys).resolvedModule?.resolvedFileName;
-      if (!resolved?.endsWith('.schema.ts')) throw new Error(`schema modules may import only zod and *.schema.ts, found ${specifier} in ${file}`);
-      return load(resolved);
+    return (property, label) => {
+        const entry = initializer(valueOf(property.valueDeclaration));
+        const options = entry && ts.isCallExpression(entry) ? initializer(entry.arguments[0]) : null;
+        const field = options && checker.getTypeAtLocation(options).getProperty(label)?.getDeclarations()?.find((item) => ts.isPropertyAssignment(item) || ts.isShorthandPropertyAssignment(item));
+        const reference = field && unwrap(valueOf(field));
+        if (!reference)
+            throw new Error(`${label}: declare input and output zod schemas in *.schema.ts and pass { input, output } to query or mutation`);
+        const symbol = schemaSymbol(reference);
+        const declaration = symbol?.valueDeclaration;
+        const sourceFile = declaration?.getSourceFile();
+        if (!sourceFile?.fileName.endsWith('.schema.ts'))
+            throw new Error(`${label}: the schema must be an exported declaration from *.schema.ts`);
+        const moduleSymbol = checker.getSymbolAtLocation(sourceFile);
+        const exported = moduleSymbol && checker.getExportsOfModule(moduleSymbol).find((item) => actual(item) === symbol);
+        if (!exported)
+            throw new Error(`${label}: the schema must be exported from ${sourceFile.fileName}`);
+        const schema = load(sourceFile.fileName)[exported.getName()];
+        // Inline reused schemas and refuse cycles: a recursive value has no bounded wire depth, and a local $ref would point at
+        // the OpenAPI document root instead of this nested schema. Unrepresentable values (Date, transforms) also fail closed.
+        const json = requireApp('zod').z.toJSONSchema(schema, {
+            io: label, target: 'draft-2020-12', cycles: 'throw', reused: 'inline',
+            // A request property marked readOnly would tell OpenAPI clients not to send it; a fixed-format string carries its real maximum.
+            override: ({ jsonSchema }) => {
+                if (label === 'input')
+                    delete jsonSchema.readOnly;
+                const fixed = jsonSchema.format === undefined ? undefined : FIXED_FORMAT_MAX[jsonSchema.format];
+                if (jsonSchema.type === 'string' && fixed && jsonSchema.maxLength === undefined)
+                    jsonSchema.maxLength = fixed;
+            },
+        });
+        delete json.$schema;
+        assertClosedJsonSchema(json, label);
+        return json;
     };
-    // zod is the app's dependency, not the schema's code: it loads before the timed run, so the 1000 ms budget bounds only the
-    // schema module itself (a cold zod load inside it ran past the budget on a loaded machine).
-    for (const [, specifier] of compiled.matchAll(/require\("(zod(?:\/[^"]*)?)"\)/g)) requireApp(specifier);
-    new vm.Script(compiled, { filename: file }).runInNewContext({ module, exports: module.exports, require: requireSchema }, { timeout: 1000 });
-    return module.exports;
-  }
-
-  return (property, label) => {
-    const entry = initializer(valueOf(property.valueDeclaration));
-    const options = entry && ts.isCallExpression(entry) ? initializer(entry.arguments[0]) : null;
-    const field = options && checker.getTypeAtLocation(options).getProperty(label)?.getDeclarations()?.find((item) => ts.isPropertyAssignment(item) || ts.isShorthandPropertyAssignment(item));
-    const reference = field && unwrap(valueOf(field));
-    if (!reference) throw new Error(`${label}: declare input and output zod schemas in *.schema.ts and pass { input, output } to query or mutation`);
-    const symbol = schemaSymbol(reference);
-    const declaration = symbol?.valueDeclaration;
-    const sourceFile = declaration?.getSourceFile();
-    if (!sourceFile?.fileName.endsWith('.schema.ts')) throw new Error(`${label}: the schema must be an exported declaration from *.schema.ts`);
-    const moduleSymbol = checker.getSymbolAtLocation(sourceFile);
-    const exported = moduleSymbol && checker.getExportsOfModule(moduleSymbol).find((item) => actual(item) === symbol);
-    if (!exported) throw new Error(`${label}: the schema must be exported from ${sourceFile.fileName}`);
-    const schema = load(sourceFile.fileName)[exported.getName()];
-    // Inline reused schemas and refuse cycles: a recursive value has no bounded wire depth, and a local $ref would point at
-    // the OpenAPI document root instead of this nested schema. Unrepresentable values (Date, transforms) also fail closed.
-    const json = requireApp('zod').z.toJSONSchema(schema, {
-      io: label, target: 'draft-2020-12', cycles: 'throw', reused: 'inline',
-      // A request property marked readOnly would tell OpenAPI clients not to send it; a fixed-format string carries its real maximum.
-      override: ({ jsonSchema }) => {
-        if (label === 'input') delete jsonSchema.readOnly;
-        const fixed = FIXED_FORMAT_MAX[jsonSchema.format];
-        if (jsonSchema.type === 'string' && fixed && jsonSchema.maxLength === undefined) jsonSchema.maxLength = fixed;
-      },
-    });
-    delete json.$schema;
-    assertClosedJsonSchema(json, label);
-    return json;
-  };
 }

package/emit/operations-worker.d.mts

@@ -0,0 +1 @@
+export {};

package/emit/operations-worker.mjs

@@ -6,19 +6,21 @@ import fs from 'node:fs';
 import path from 'node:path';
 import { compilerOptionsOf } from './compiler.mjs';
 import { openApiText, operationsPath, readOperations } from './operations.mjs';
-
+// The parent (contracts.mts) always passes the repository root and the app.
 const [rootArgument, app] = process.argv.slice(2);
 const repoRoot = path.resolve(rootArgument);
 const file = path.join(repoRoot, operationsPath(app));
-if (!fs.existsSync(file)) process.exit(3);
+if (!fs.existsSync(file))
+    process.exit(3);
 const ts = createRequire(path.join(repoRoot, 'package.json'))('typescript');
 const options = compilerOptionsOf(ts, repoRoot, (message) => process.stderr.write(`stand-in ${message}\n`));
 const program = ts.createProgram({ rootNames: [file], options });
 try {
-  const { operations, components } = readOperations({ ts, program, file, repoRoot });
-  process.stdout.write(openApiText({ app, operations, components }));
-} catch (error) {
-  process.stderr.write(`${error.message}
+    const { operations, components } = readOperations({ ts, program, file, repoRoot }); // the file is the program's own root, so it is found
+    process.stdout.write(openApiText({ app, operations, components }));
+}
+catch (error) {
+    process.stderr.write(`${error.message}
 `);
-  process.exit(1);
+    process.exit(1);
 }

package/emit/operations.d.mts

@@ -0,0 +1,47 @@
+/**
+ * The versioned operations of an api app, read from its typed operation table and printed as OpenAPI 3.1.
+ *
+ * The table is the canon's one declaration of an app's operation surface (knowledge/patterns/be/api.yaml, BE-OPERATIONS-1):
+ * `apps/<app>/src/operations.ts` exports `OPERATIONS`, made by `defineOperations({ "<id>@<version>": query({ input, output }) })`.
+ * Input and output are exported zod schemas from *.schema.ts. Only schema modules are evaluated, never app modules; the app's
+ * z.toJSONSchema carries their constraints into OpenAPI. Open schemas and unrepresentable wire values are refused; the
+ * TypeScript checker separately proves closed parsed input/output types and refusal codes. A failure always names the operation.
+ *
+ * The wire is one route, `POST /operations`: the body is `{ operation, requestId, input }` and the answer is `{ operation, requestId,
+ * outcome }`, `outcome` being `{ kind: "ok", value }` or `{ kind: "refused", code, params? }`. Each operation contributes one request
+ * and one reply component carrying `x-operation: "<id>@<version>"`; the route's body and answer are the oneOf over them.
+ */
+import type TypeScript from 'typescript';
+import type { JsonSchema } from './type-schema.mjs';
+import type { WireSchema } from './operation-schemas.mjs';
+/** The repository-relative path of an app's operation table. */
+export declare const operationsPath: (app: string) => string;
+/** The repository-relative path of an app's OpenAPI contract. */
+export declare const openapiPath: (app: string) => string;
+/** One operation of the table, with its wire schemas and closed refusal codes. */
+export interface OperationRead {
+    readonly id: string;
+    readonly kind: 'query' | 'mutation';
+    readonly input: WireSchema;
+    readonly output: WireSchema;
+    readonly refusal: string[];
+}
+/**
+ * Reads the operation table of a source file of a program. Answers null when the file is not in the program; throws when it
+ * exports no `OPERATIONS` or an operation is not decidable.
+ */
+export declare function readOperations({ ts, program, file, repoRoot }: {
+    ts: typeof TypeScript;
+    program: TypeScript.Program;
+    file: string;
+    repoRoot?: string;
+}): {
+    operations: OperationRead[];
+    components: Record<string, JsonSchema>;
+} | null;
+/** The OpenAPI 3.1 document of an app's operations, as sorted-key JSON text with one final newline. */
+export declare function openApiText({ app, operations, components }: {
+    app: string;
+    operations: readonly OperationRead[];
+    components: Readonly<Record<string, JsonSchema>>;
+}): string;