@zmdb/compiler 1.0.0-beta.1

package/dist/emit/index.d.ts

@@ -0,0 +1,103 @@
+import type { ToolProvider } from '@zmdb/ai';
+import { type SchemaIR, type ShapeIR, type TypeIR } from '@zmdb/schema/ir';
+import type { GrpcServiceIR } from '../protobuf/grpc-ir.js';
+/** Sanitise a pattern before it goes between `/` delimiters in emitted source. */
+export declare function escapePattern(pattern: string): string;
+export type EmitTarget = 'check' | 'excess' | 'issues' | 'sample';
+export interface EmitOptions {
+    /** Prefix for every emitted identifier. Default `_zmdb`. */
+    readonly prefix?: string;
+    /** Cap on hoisted helpers per file. Exceeding it is a refusal, not a hang. */
+    readonly maxHelpers?: number;
+    /** Module specifier the emitted prelude imports `AssertError` from. */
+    readonly errorModule?: string;
+    /** Module specifier the emitted prelude imports `ProtoReader`/`ProtoWriter` from. */
+    readonly protobufModule?: string;
+}
+/** A refusal. `path` is the property chain that reached it, as in the reflection. */
+export interface EmitDiagnostic {
+    readonly path: string;
+    readonly reason: string;
+    readonly source?: string;
+}
+export declare class Emitter {
+    #private;
+    constructor(options?: EmitOptions);
+    get diagnostics(): readonly EmitDiagnostic[];
+    /** Record a build-time refusal discovered at the call-site boundary. */
+    refuse(path: string, reason: string): undefined;
+    /** True once anything has been hoisted, so a caller knows a prelude is needed. */
+    get hasPrelude(): boolean;
+    /**
+     * Everything that has to sit at the top of the module: the `AssertError` import when a
+     * throwing form was emitted, then the helpers in definition order.
+     */
+    prelude(): string;
+    /** `is<T>(expr)` → a boolean expression. */
+    emitIs(node: TypeIR, expr: string, maxDepth?: number): string | undefined;
+    /** `equals<T>(expr)` → `is<T>` plus a recursive no-excess-keys check. */
+    emitEquals(node: TypeIR, expr: string): string | undefined;
+    /** `assert<T>(expr)` / `assertEquals<T>(expr)` → the value, or a throw. */
+    emitAssert(node: TypeIR, expr: string, strict: boolean, maxDepth?: number): string | undefined;
+    /** `validate<T>(expr)` → a `ValidateResult<T>`, never a throw. */
+    emitValidate(node: TypeIR, expr: string, strict?: boolean, maxDepth?: number): string | undefined;
+    /** `random<T>()` → an expression producing a value that satisfies `T`. */
+    emitRandom(node: TypeIR): string | undefined;
+    /**
+     * `toJsonSchema<T>()` → a reference to the document, hoisted and frozen (REQ-TF-7).
+     *
+     * One of the two targets that is not a walk. The other four emit code that runs later;
+     * a JSON Schema document is *finished* at build time, so what gets emitted is the
+     * answer itself. `jsonSchemaFromShape` is the same function the value path calls, which
+     * is what makes the two documents identical rather than merely tested for equality.
+     */
+    emitJsonSchema(shape: ShapeIR): string | undefined;
+    /**
+     * `schemaOf<T>()` → a reference to the generated schema value, hoisted and frozen
+     * (REQ-TF-10).
+     *
+     * The other half of "one IR, several back-ends": the query compiler and the DDL emitter
+     * want the table and the column types as data, so what gets emitted is the projection
+     * `schemaFromIR` builds — and that includes the IR itself, on the value's `ir` field.
+     * Both are in the literal on purpose. The projection is what the query compiler reads on
+     * every call and wants flat; the IR is what the decoders, the wire codecs and the OpenAPI
+     * document read, and it says things no column map can hold. Emitting only the projection
+     * would mean recovering the rest by inference at runtime, which is the walk this design
+     * removed.
+     *
+     * Relations do not travel with the projection. A `CoreSchema` has no relation map — the
+     * repository takes one separately — so a `ManyToOne<…>` on the declaration is read, is
+     * not a column, and reaches a consumer only through `ir.relations`.
+     */
+    emitSchemaValue(ir: SchemaIR): string | undefined;
+    /**
+     * `toolFor<T>(provider, name, opts)` → the provider's frozen parameter document.
+     *
+     * The transformer supplies the framing expressions because `name` and `description`
+     * belong to the call site. The schema itself is complete here: a pure projection of the
+     * reflected table IR, shared with the runtime schema-value overload.
+     */
+    emitToolSchema(ir: SchemaIR, provider: ToolProvider): string | undefined;
+    /** `protoDescriptor<T>()` -> one compile-time-produced proto3 string literal. */
+    emitProtoDescriptor(node: TypeIR, name: string): string | undefined;
+    /** `grpcDescriptor<S>(service, package)` -> one complete proto3 file. */
+    emitGrpcDescriptor(node: GrpcServiceIR, service: string, pkg: string): string | undefined;
+    /**
+     * `loadGrpcService<S>(service, package)` -> a frozen descriptor plus generated
+     * request/response validators and codecs for every method.
+     */
+    emitGrpcService(node: GrpcServiceIR, service: string, pkg: string): string | undefined;
+    /** `protoEncode<T>(expr)` -> a call to a compile-time-produced straight-line encoder. */
+    emitProtoEncode(node: TypeIR, name: string, expr: string): string | undefined;
+    /** `protoDecode<T>(expr)` -> a field-number-dispatched decoder over a bounded reader. */
+    emitProtoDecode(node: TypeIR, name: string, expr: string): string | undefined;
+    /**
+     * The name of a hoisted function implementing `target` for `node`, for callers that
+     * want the function rather than an inlined call site — the differential suite and the
+     * emitted-output snapshots both do.
+     */
+    helper(node: TypeIR, target: EmitTarget): string | undefined;
+}
+export { discriminantOf, expectedForConstraint, expectedForDiscriminant, expectedOf, hasExcessCheck, messageFor, } from '@zmdb/schema/ir';
+export { type ConstraintKeyword, type Discriminant, type DiscriminantArm } from '@zmdb/schema/ir';
+//# sourceMappingURL=index.d.ts.map

package/dist/emit/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/emit/index.ts"],"names":[],"mappings":"AAqCA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAE7C,OAAO,EAcL,KAAK,QAAQ,EACb,KAAK,OAAO,EAEZ,KAAK,MAAM,EAEZ,MAAM,iBAAiB,CAAC;AAMzB,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAE5D,kFAAkF;AAClF,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CASrD;AAED,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAElE,MAAM,WAAW,WAAW;IAC1B,4DAA4D;IAC5D,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,8EAA8E;IAC9E,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,uEAAuE;IACvE,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,qFAAqF;IACrF,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;CAClC;AAED,qFAAqF;AACrF,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CAC1B;AA2DD,qBAAa,OAAO;;IAsBlB,YAAY,OAAO,GAAE,WAAgB,EAKpC;IAED,IAAI,WAAW,IAAI,SAAS,cAAc,EAAE,CAE3C;IAED,wEAAwE;IACxE,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,SAAS,CAG9C;IAED,kFAAkF;IAClF,IAAI,UAAU,IAAI,OAAO,CAExB;IAED;;;OAGG;IACH,OAAO,IAAI,MAAM,CAahB;IAMD,4CAA4C;IAC5C,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAOxE;IAED,yEAAyE;IACzE,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAazD;IAED,2EAA2E;IAC3E,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAY7F;IAED,kEAAkE;IAClE,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,UAAQ,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAQ9F;IAED,0EAA0E;IAC1E,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAK3C;IAED;;;;;;;OAOG;IACH,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAEjD;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,eAAe,CAAC,EAAE,EAAE,QAAQ,GAAG,MAAM,GAAG,SAAS,CAEhD;IAED;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,GAAG,MAAM,GAAG,SAAS,CAavE;IAED,iFAAiF;IACjF,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAIlE;IAED,yEAAyE;IACzE,kBAAkB,CAAC,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAIxF;IAED;;;OAGG;IACH,eAAe,CAAC,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAsCrF;IAED,yFAAyF;IACzF,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAgB5E;IAED,yFAAyF;IACzF,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAgB5E;IA4BD;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,GAAG,MAAM,GAAG,SAAS,CAmB3D;CAy6BF;AAqED,OAAO,EACL,cAAc,EACd,qBAAqB,EACrB,uBAAuB,EACvB,UAAU,EACV,cAAc,EACd,UAAU,GACX,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,KAAK,iBAAiB,EAAE,KAAK,YAAY,EAAE,KAAK,eAAe,EAAE,MAAM,iBAAiB,CAAC"}