firebase-contract 0.1.0-rc.0

package/dist/lib/_internal/ir/ir.d.ts

@@ -0,0 +1,393 @@
+/**
+ * The Intermediate Representation (IR).
+ *
+ * This is the single input every generator consumes. Generators MUST NOT parse
+ * YAML or touch raw documents — they only read the IR defined here. Keeping the
+ * IR the sole contract between the front end (parser/resolver) and the back end
+ * (generators) is what lets generators stay independent and lets new front-end
+ * features land without rewriting generators.
+ */
+export declare const SCALAR_TYPES: readonly ["string", "int", "int64", "float", "boolean", "timestamp", "date", "json", "id"];
+export type ScalarType = (typeof SCALAR_TYPES)[number];
+export declare const isScalarType: (name: string) => name is ScalarType;
+/** A reference from a field to the type that describes its value. */
+export type IrTypeRef = {
+    kind: 'scalar';
+    name: ScalarType;
+} | {
+    kind: 'enum';
+    name: string;
+} | {
+    kind: 'model';
+    name: string;
+}
+/** Emitted when a type name could not be matched; surfaced by validation. */
+ | {
+    kind: 'unresolved';
+    name: string;
+};
+/** Validation constraints on a field, applied by the validation generators. */
+export interface IrConstraints {
+    /** Minimum numeric value (numbers). */
+    min?: number;
+    /** Maximum numeric value (numbers). */
+    max?: number;
+    /** Minimum string/array length. */
+    minLength?: number;
+    /** Maximum string/array length. */
+    maxLength?: number;
+    /** Regex source the value must match (strings). */
+    pattern?: string;
+    /** Non-empty string/array. */
+    nonempty?: boolean;
+    /** Must be a valid email (strings). */
+    email?: boolean;
+    /** Must be a valid URL (strings). */
+    url?: boolean;
+}
+export interface IrField {
+    name: string;
+    description?: string;
+    type: IrTypeRef;
+    constraints: IrConstraints;
+    /** The value may be absent (`field?`). */
+    optional: boolean;
+    /** The value may be `null` (rendered `.nullable()` in Zod-facing generators). */
+    nullable?: boolean;
+    /** Render the description as a JSDoc block instead of line comments. */
+    jsdoc?: boolean;
+    /** The value is an array of `type`. */
+    list: boolean;
+    /** Marks the primary identifier of the model. */
+    isId: boolean;
+    unique: boolean;
+    /**
+     * A model-typed field that is a foreign-key *relation* to another table
+     * (Data Connect emits a relation field + FK column), as opposed to an
+     * *embedded* value object (stored as `Any`/jsonb). Only meaningful when
+     * `type.kind === 'model'`.
+     */
+    relation: boolean;
+    /** Data Connect column dataType override (e.g. `bigserial`); derived for Int64 PKs. */
+    col?: string;
+    /** Pin the field to a single literal value (e.g. a discriminated-union tag). */
+    literal?: string;
+    default?: unknown;
+}
+/** A composite index or unique constraint on a table. */
+export interface IrIndex {
+    fields: string[];
+    /** Explicit index name; generators derive one when absent. */
+    name?: string;
+    unique: boolean;
+    /** Render the directive with one argument per line. */
+    expand?: boolean;
+}
+/**
+ * Raw SQL constraints that Data Connect's schema directives cannot express
+ * (composite foreign keys, CHECK constraints, extra indexes). The SQL migration
+ * generator turns these into executable `ALTER TABLE`/`CREATE INDEX` statements.
+ */
+export interface IrSqlConstraints {
+    checks: string[];
+    foreignKeys: {
+        columns: string[];
+        references: string;
+        name?: string;
+    }[];
+    indexes: {
+        columns: string[];
+        name?: string;
+        unique: boolean;
+    }[];
+}
+export interface IrModel {
+    name: string;
+    description?: string;
+    fields: IrField[];
+    /** Composite primary key field names. Empty means "use the `id: true` field". */
+    key: string[];
+    /** Raw SQL constraints (composite FK / CHECK / index) not expressible in DC. */
+    sql?: IrSqlConstraints;
+    /** Table name override; defaults to the snake_case pluralization of the model name. */
+    table?: string;
+    /** GraphQL type name override (defaults to `name`). */
+    gqlName?: string;
+    /** `multi` = each type-level directive on its own line (real-file style). */
+    directives?: 'inline' | 'multi';
+    /** Trailing comment block rendered after the closing `}` in the schema file. */
+    footer?: string;
+    /** TypeScript-side rename used by Firestore projections. */
+    fsName?: string;
+    /** Composite unique/index constraints (Data Connect `@unique`/`@index`). */
+    indexes: IrIndex[];
+    /** Absolute path of the file this model was defined in. */
+    sourceFile?: string;
+}
+export interface IrEnum {
+    name: string;
+    description?: string;
+    values: string[];
+    /** Per-value comments, keyed by value. */
+    valueComments?: Record<string, string>;
+    /** Const-object key overrides, keyed by value (e.g. Q → QA). */
+    valueKeys?: Record<string, string>;
+    /** GraphQL type name override (defaults to `name`). */
+    gqlName?: string;
+    /** TypeScript-side rename used by Firestore projections (e.g. `Status` → `ReviewStatus`). */
+    fsName?: string;
+    /** Firestore-side comment override (when it differs from the DC description). */
+    fsDescription?: string;
+    sourceFile?: string;
+}
+export type OperationType = 'query' | 'mutation';
+export type MutationAction = 'insert' | 'update' | 'upsert' | 'delete';
+export type AuthLevel = 'NO_ACCESS' | 'PUBLIC' | 'USER';
+/** A single `where` filter: a field compared with an operator (eq, contains, lt, …). */
+export interface IrWhere {
+    field: string;
+    op: string;
+    /** Variable requiredness override (defaults to required). */
+    required?: boolean;
+    /** Comment rendered directly above the variable declaration. */
+    description?: string;
+    /** Variable name override. */
+    var?: string;
+    /** Fixed literal comparison value (no variable), e.g. `ACTIVE` / `true`. */
+    literal?: string;
+    /** Filter on the flat FK column (`fieldId: { eq }`) instead of the relation form. */
+    flat?: boolean;
+}
+/** A mutation input: a field, with optional variable-requiredness override. */
+export interface IrInput {
+    field: string;
+    /** Overrides schema-derived nullability (the operation's own contract). */
+    required?: boolean;
+    /** Comment rendered directly above the variable declaration. */
+    description?: string;
+    /** Variable name override (defaults to the field name / relation FK name). */
+    var?: string;
+    /** Write a relation as its flat FK column (`fieldId: $var`) instead of `field: { id: $var }`. */
+    flat?: boolean;
+    /** Fixed literal written directly into data (no variable), e.g. `PROCESSING` / `false`. */
+    literal?: string;
+    /** Render as an increment write (`field_update: { inc: $var | 1 }`) at this position. */
+    inc?: boolean;
+    /** Pass the relation as a `Model_Key` object variable (`$catalogVersion: CatalogVersion_Key!`). */
+    asKey?: boolean;
+    /** Quote the literal as a GraphQL string. */
+    quote?: boolean;
+}
+/** A selection entry: a field, optionally with a nested selection (relations). */
+export interface IrSelect {
+    field: string;
+    select?: IrSelect[];
+    /** Comment rendered directly above the selection line. */
+    description?: string;
+    /** GraphQL alias (`members: shopMembers_on_user`). */
+    alias?: string;
+    /** Raw argument string rendered verbatim (`orderBy: [{ joinedAt: DESC }]`, join where/limit). */
+    args?: string;
+}
+/** A single `orderBy` clause. */
+export interface IrOrderBy {
+    field: string;
+    dir: 'ASC' | 'DESC';
+}
+/** Aggregate selections for a query. */
+export interface IrAggregate {
+    count: boolean;
+    /** Field names to `_sum`. */
+    sum: string[];
+}
+/** A field set to a raw expression on mutation (e.g. `updatedAt: "request.time"`). */
+export interface IrExpr {
+    field: string;
+    expr: string;
+}
+/** A Data Connect query/mutation operation over a model's table. */
+export interface IrOperation {
+    name: string;
+    description?: string;
+    operationType: OperationType;
+    /** Target model (table) name. */
+    model: string;
+    /** For mutations: which auto-generated resolver to use. */
+    action?: MutationAction;
+    auth: AuthLevel;
+    /** Mandatory rationale when auth is PUBLIC. */
+    authReason?: string;
+    /** Mutation inputs (fields + optional requiredness overrides). */
+    inputs: IrInput[];
+    /** `where` filters (queries). */
+    where: IrWhere[];
+    /** Selection entries; empty means all scalar fields. */
+    select: IrSelect[];
+    /** `orderBy` clauses (queries). */
+    orderBy: IrOrderBy[];
+    /** Row limit (queries): a literal, or a variable spec. */
+    limit?: number | {
+        var: string;
+        default?: number;
+        required?: boolean;
+    };
+    /** Single-row primary-key lookup form: `key` → `x(key: {…})`, `id` → `x(id: $var)`. */
+    single?: 'key' | 'id';
+    /** Update/delete key argument style: nested `key: {…}` (default) or positional `id: $var`. */
+    keyArg?: 'key' | 'id';
+    /** Key variable name overrides, keyed by key field name. */
+    keyVars?: Record<string, string>;
+    /** Aggregate selections (queries). */
+    aggregate?: IrAggregate;
+    /** Fields set to raw expressions on mutation (e.g. `updatedAt: request.time`). */
+    exprs: IrExpr[];
+    /** Increment writes: `field_update: { inc: 1 }`, or `{ inc: $var }` when `var` is set. */
+    inc: {
+        field: string;
+        var?: string;
+    }[];
+    /** Output targets (connectors). Empty means the default/root output. */
+    connectors: string[];
+    /** Entity directory override for split output (defaults to the table's kebab name). */
+    entityDir?: string;
+    /** Wrap where conditions in an explicit `_and: [ … ]` array (matches hand-written form). */
+    whereAnd?: boolean;
+    /** Rendered operation name override (yml key stays the unique id). */
+    gqlName?: string;
+    /** Comment block rendered after the operation (file-trailing NOTEs). */
+    footer?: string;
+    /** Verbatim operation body — rendered as-is (escape hatch for inexpressible ops). */
+    raw?: string;
+    /** Per-operation layout hints matching the hand-written file's formatting. */
+    style?: {
+        signature?: 'inline' | 'multi';
+        args?: 'inline' | 'multi';
+        /** `inline` = whole call on one line; `compact` = one-line data object inside a multi-line call. */
+        data?: 'inline' | 'multi' | 'compact';
+        /** `bare` = single orderBy clause without array brackets. */
+        orderBy?: 'bare' | 'array';
+        /** `newline` = `@auth` on its own line (even NO_ACCESS). */
+        auth?: 'inline' | 'newline';
+        /** `multi` = key object expanded one field per line. */
+        key?: 'inline' | 'multi';
+        /** `inline` = compact one-line `_and: [{…}, {…}]` even inside multi-line args. */
+        and?: 'inline' | 'multi';
+        /** `multi` = plain where body wrapped with one condition per line. */
+        where?: 'inline' | 'multi';
+    };
+    sourceFile?: string;
+}
+export type ApiKind = 'callable' | 'https' | 'task' | 'pubsub';
+/** Request or response shape of an API endpoint. */
+export interface IrApiPayload {
+    /** Reference an existing model as the shape. */
+    model?: string;
+    /** Inline fields (used when `model` is absent). */
+    fields: IrField[];
+    /** Response only: the endpoint returns nothing. */
+    isVoid: boolean;
+}
+/** Cloud Task / Pub/Sub delivery config for an endpoint. */
+export interface IrTaskConfig {
+    /** Envelope type (e.g. `RetryTaskPayload`) wrapping the task data. */
+    envelope?: string;
+    maxAttempts?: number;
+    timeoutSeconds?: number;
+    topic?: string;
+}
+/** An application API endpoint (callable / https / cloud task / pubsub). */
+export interface IrApi {
+    name: string;
+    description?: string;
+    kind: ApiKind;
+    /** HTTP method for `https` endpoints. */
+    method?: string;
+    request: IrApiPayload;
+    response: IrApiPayload;
+    /** Delivery config for `task`/`pubsub` kinds. */
+    task?: IrTaskConfig;
+    sourceFile?: string;
+}
+/** A generic payload envelope, e.g. `RetryTaskPayload<T> = T & { identifierId, opId, enqueuedAt }`. */
+export interface IrEnvelope {
+    name: string;
+    description?: string;
+    /** Fields merged into the wrapped type `T`. */
+    fields: IrField[];
+    sourceFile?: string;
+}
+/**
+ * A Firestore projection document. Firestore is a denormalized read model, so a
+ * projection *derives* from a Data Connect model (`from`) and then diverges:
+ * fields are picked/omitted, relations become resolved string ids, timestamps
+ * become dates, a `_meta_` envelope is added, and extra denormalized fields
+ * (e.g. flattened DAG edges) are declared inline.
+ */
+export interface IrFirestoreDoc {
+    name: string;
+    description?: string;
+    /** Base model to inherit fields from. */
+    from?: string;
+    /** Firestore document path, e.g. `shops/{shopId}`. */
+    collection?: string;
+    /** Keep only these base fields (mutually exclusive with `omit`). */
+    pick: string[];
+    /** Drop these base fields. */
+    omit: string[];
+    /** Added or overriding projection-specific fields. */
+    fields: IrField[];
+    /** Attach the consistency `_meta_` envelope (default true). */
+    meta: boolean;
+    /** Embedded models to host in this projection file even when unreferenced. */
+    include?: string[];
+    /** Verbatim TypeScript helpers emitted into the projection file. */
+    helpers?: string;
+    sourceFile?: string;
+}
+/** A discriminated union of model variants keyed by a shared discriminant field. */
+export interface IrUnion {
+    name: string;
+    description?: string;
+    discriminant: string;
+    variants: string[];
+    sourceFile?: string;
+}
+/** A Data Connect service (one Postgres database + its connectors). */
+export interface IrService {
+    name: string;
+    database?: string;
+    location?: string;
+    connectors: string[];
+}
+/** Project-level topology: services and their Cloud Functions codebases. */
+export interface IrProject {
+    services: IrService[];
+    /** Map of codebase id → service name (e.g. `shop` → `shop-service`). */
+    codebases: {
+        codebase: string;
+        service: string;
+    }[];
+    /** Sqids settings for the generated id-core (encode/decode primitives). */
+    idCodec?: {
+        minLength?: number;
+        alphabet?: string;
+    };
+}
+export interface Ir {
+    version: number;
+    enums: IrEnum[];
+    models: IrModel[];
+    operations: IrOperation[];
+    apis: IrApi[];
+    firestore: IrFirestoreDoc[];
+    unions: IrUnion[];
+    envelopes: IrEnvelope[];
+    project?: IrProject;
+    /** Raw header text from the contract (`default` = built-in banner). */
+    header?: string;
+}
+export declare const findModel: (ir: Ir, name: string) => IrModel | undefined;
+export declare const findEnum: (ir: Ir, name: string) => IrEnum | undefined;
+/** The id field's scalar name of a model, used to type foreign keys. Defaults to `string`. */
+export declare const idTypeOf: (ir: Ir, modelName: string) => ScalarType;
+//# sourceMappingURL=ir.d.ts.map

package/dist/lib/_internal/ir/ir.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ir.d.ts","sourceRoot":"","sources":["../../../../src/lib/_internal/ir/ir.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,eAAO,MAAM,YAAY,4FAA6F,CAAA;AAEtH,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAA;AAEtD,eAAO,MAAM,YAAY,GAAI,MAAM,MAAM,KAAG,IAAI,IAAI,UACA,CAAA;AAEpD,qEAAqE;AACrE,MAAM,MAAM,SAAS,GACjB;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,UAAU,CAAA;CAAE,GACpC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC9B;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE;AACjC,6EAA6E;GAC3E;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAA;AAExC,+EAA+E;AAC/E,MAAM,WAAW,aAAa;IAC5B,uCAAuC;IACvC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,uCAAuC;IACvC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,mCAAmC;IACnC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,mCAAmC;IACnC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,mDAAmD;IACnD,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,8BAA8B;IAC9B,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,uCAAuC;IACvC,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,qCAAqC;IACrC,GAAG,CAAC,EAAE,OAAO,CAAA;CACd;AAED,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,EAAE,SAAS,CAAA;IACf,WAAW,EAAE,aAAa,CAAA;IAC1B,0CAA0C;IAC1C,QAAQ,EAAE,OAAO,CAAA;IACjB,iFAAiF;IACjF,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,wEAAwE;IACxE,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,uCAAuC;IACvC,IAAI,EAAE,OAAO,CAAA;IACb,iDAAiD;IACjD,IAAI,EAAE,OAAO,CAAA;IACb,MAAM,EAAE,OAAO,CAAA;IACf;;;;;OAKG;IACH,QAAQ,EAAE,OAAO,CAAA;IACjB,uFAAuF;IACvF,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,gFAAgF;IAChF,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,yDAAyD;AACzD,MAAM,WAAW,OAAO;IACtB,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,8DAA8D;IAC9D,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,OAAO,CAAA;IACf,uDAAuD;IACvD,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,WAAW,EAAE;QAAE,OAAO,EAAE,MAAM,EAAE,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IACvE,OAAO,EAAE;QAAE,OAAO,EAAE,MAAM,EAAE,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,OAAO,CAAA;KAAE,EAAE,CAAA;CACjE;AAED,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,MAAM,EAAE,OAAO,EAAE,CAAA;IACjB,iFAAiF;IACjF,GAAG,EAAE,MAAM,EAAE,CAAA;IACb,gFAAgF;IAChF,GAAG,CAAC,EAAE,gBAAgB,CAAA;IACtB,uFAAuF;IACvF,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,uDAAuD;IACvD,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,6EAA6E;IAC7E,UAAU,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAA;IAC/B,gFAAgF;IAChF,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,4DAA4D;IAC5D,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,4EAA4E;IAC5E,OAAO,EAAE,OAAO,EAAE,CAAA;IAClB,2DAA2D;IAC3D,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,0CAA0C;IAC1C,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACtC,gEAAgE;IAChE,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAClC,uDAAuD;IACvD,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,6FAA6F;IAC7F,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,iFAAiF;IACjF,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,UAAU,CAAA;AAChD,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAA;AACtE,MAAM,MAAM,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,MAAM,CAAA;AAEvD,wFAAwF;AACxF,MAAM,WAAW,OAAO;IACtB,KAAK,EAAE,MAAM,CAAA;IACb,EAAE,EAAE,MAAM,CAAA;IACV,6DAA6D;IAC7D,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,gEAAgE;IAChE,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,8BAA8B;IAC9B,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,4EAA4E;IAC5E,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,qFAAqF;IACrF,IAAI,CAAC,EAAE,OAAO,CAAA;CACf;AAED,+EAA+E;AAC/E,MAAM,WAAW,OAAO;IACtB,KAAK,EAAE,MAAM,CAAA;IACb,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,gEAAgE;IAChE,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,8EAA8E;IAC9E,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,iGAAiG;IACjG,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,2FAA2F;IAC3F,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,yFAAyF;IACzF,GAAG,CAAC,EAAE,OAAO,CAAA;IACb,mGAAmG;IACnG,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,6CAA6C;IAC7C,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB;AAED,kFAAkF;AAClF,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAA;IACnB,0DAA0D;IAC1D,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,sDAAsD;IACtD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,iGAAiG;IACjG,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,iCAAiC;AACjC,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,CAAA;IACb,GAAG,EAAE,KAAK,GAAG,MAAM,CAAA;CACpB;AAED,wCAAwC;AACxC,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,OAAO,CAAA;IACd,6BAA6B;IAC7B,GAAG,EAAE,MAAM,EAAE,CAAA;CACd;AAED,sFAAsF;AACtF,MAAM,WAAW,MAAM;IACrB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;CACb;AAED,oEAAoE;AACpE,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,aAAa,CAAA;IAC5B,iCAAiC;IACjC,KAAK,EAAE,MAAM,CAAA;IACb,2DAA2D;IAC3D,MAAM,CAAC,EAAE,cAAc,CAAA;IACvB,IAAI,EAAE,SAAS,CAAA;IACf,+CAA+C;IAC/C,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,kEAAkE;IAClE,MAAM,EAAE,OAAO,EAAE,CAAA;IACjB,iCAAiC;IACjC,KAAK,EAAE,OAAO,EAAE,CAAA;IAChB,wDAAwD;IACxD,MAAM,EAAE,QAAQ,EAAE,CAAA;IAClB,mCAAmC;IACnC,OAAO,EAAE,SAAS,EAAE,CAAA;IACpB,0DAA0D;IAC1D,KAAK,CAAC,EAAE,MAAM,GAAG;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,CAAA;IACtE,uFAAuF;IACvF,MAAM,CAAC,EAAE,KAAK,GAAG,IAAI,CAAA;IACrB,8FAA8F;IAC9F,MAAM,CAAC,EAAE,KAAK,GAAG,IAAI,CAAA;IACrB,4DAA4D;IAC5D,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,sCAAsC;IACtC,SAAS,CAAC,EAAE,WAAW,CAAA;IACvB,kFAAkF;IAClF,KAAK,EAAE,MAAM,EAAE,CAAA;IACf,0FAA0F;IAC1F,GAAG,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IACtC,wEAAwE;IACxE,UAAU,EAAE,MAAM,EAAE,CAAA;IACpB,uFAAuF;IACvF,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,4FAA4F;IAC5F,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,sEAAsE;IACtE,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,wEAAwE;IACxE,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,qFAAqF;IACrF,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,8EAA8E;IAC9E,KAAK,CAAC,EAAE;QACN,SAAS,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAA;QAC9B,IAAI,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAA;QACzB,oGAAoG;QACpG,IAAI,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAA;QACrC,6DAA6D;QAC7D,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;QAC1B,4DAA4D;QAC5D,IAAI,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;QAC3B,wDAAwD;QACxD,GAAG,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAA;QACxB,kFAAkF;QAClF,GAAG,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAA;QACxB,sEAAsE;QACtE,KAAK,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAA;KAC3B,CAAA;IACD,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,MAAM,OAAO,GAAG,UAAU,GAAG,OAAO,GAAG,MAAM,GAAG,QAAQ,CAAA;AAE9D,oDAAoD;AACpD,MAAM,WAAW,YAAY;IAC3B,gDAAgD;IAChD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,mDAAmD;IACnD,MAAM,EAAE,OAAO,EAAE,CAAA;IACjB,mDAAmD;IACnD,MAAM,EAAE,OAAO,CAAA;CAChB;AAED,4DAA4D;AAC5D,MAAM,WAAW,YAAY;IAC3B,sEAAsE;IACtE,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,4EAA4E;AAC5E,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,EAAE,OAAO,CAAA;IACb,yCAAyC;IACzC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,YAAY,CAAA;IACrB,QAAQ,EAAE,YAAY,CAAA;IACtB,iDAAiD;IACjD,IAAI,CAAC,EAAE,YAAY,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,uGAAuG;AACvG,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,+CAA+C;IAC/C,MAAM,EAAE,OAAO,EAAE,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,yCAAyC;IACzC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,sDAAsD;IACtD,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,oEAAoE;IACpE,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,8BAA8B;IAC9B,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,sDAAsD;IACtD,MAAM,EAAE,OAAO,EAAE,CAAA;IACjB,+DAA+D;IAC/D,IAAI,EAAE,OAAO,CAAA;IACb,8EAA8E;IAC9E,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB,oEAAoE;IACpE,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,oFAAoF;AACpF,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,EAAE,MAAM,CAAA;IACpB,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,uEAAuE;AACvE,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,EAAE,CAAA;CACrB;AAED,4EAA4E;AAC5E,MAAM,WAAW,SAAS;IACxB,QAAQ,EAAE,SAAS,EAAE,CAAA;IACrB,wEAAwE;IACxE,SAAS,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IAClD,2EAA2E;IAC3E,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;CACpD;AAED,MAAM,WAAW,EAAE;IACjB,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,MAAM,EAAE,CAAA;IACf,MAAM,EAAE,OAAO,EAAE,CAAA;IACjB,UAAU,EAAE,WAAW,EAAE,CAAA;IACzB,IAAI,EAAE,KAAK,EAAE,CAAA;IACb,SAAS,EAAE,cAAc,EAAE,CAAA;IAC3B,MAAM,EAAE,OAAO,EAAE,CAAA;IACjB,SAAS,EAAE,UAAU,EAAE,CAAA;IACvB,OAAO,CAAC,EAAE,SAAS,CAAA;IACnB,uEAAuE;IACvE,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,eAAO,MAAM,SAAS,GAAI,IAAI,EAAE,EAAE,MAAM,MAAM,KAAG,OAAO,GAAG,SACb,CAAA;AAE9C,eAAO,MAAM,QAAQ,GAAI,IAAI,EAAE,EAAE,MAAM,MAAM,KAAG,MAAM,GAAG,SACV,CAAA;AAE/C,8FAA8F;AAC9F,eAAO,MAAM,QAAQ,GAAI,IAAI,EAAE,EAAE,WAAW,MAAM,KAAG,UAOpD,CAAA"}

package/dist/lib/_internal/ir/ir.js

@@ -0,0 +1,22 @@
+/**
+ * The Intermediate Representation (IR).
+ *
+ * This is the single input every generator consumes. Generators MUST NOT parse
+ * YAML or touch raw documents — they only read the IR defined here. Keeping the
+ * IR the sole contract between the front end (parser/resolver) and the back end
+ * (generators) is what lets generators stay independent and lets new front-end
+ * features land without rewriting generators.
+ */
+export const SCALAR_TYPES = ['string', 'int', 'int64', 'float', 'boolean', 'timestamp', 'date', 'json', 'id'];
+export const isScalarType = (name) => SCALAR_TYPES.includes(name);
+export const findModel = (ir, name) => ir.models.find(model => model.name === name);
+export const findEnum = (ir, name) => ir.enums.find(irEnum => irEnum.name === name);
+/** The id field's scalar name of a model, used to type foreign keys. Defaults to `string`. */
+export const idTypeOf = (ir, modelName) => {
+    const model = findModel(ir, modelName);
+    const idField = model?.fields.find(field => field.isId);
+    if (idField && idField.type.kind === 'scalar') {
+        return idField.type.name;
+    }
+    return 'string';
+};

package/dist/lib/_internal/parser/parse.d.ts

@@ -0,0 +1,9 @@
+import { RawContract } from './raw-document.js';
+/**
+ * Parse a single YAML contract file into a {@link RawContract}. Shorthand forms
+ * are normalized here so downstream code sees one canonical shape. Syntax and
+ * structural problems throw a {@link ContractError}; semantic problems are left
+ * for validation.
+ */
+export declare const parseContract: (content: string, filePath: string) => RawContract;
+//# sourceMappingURL=parse.d.ts.map

package/dist/lib/_internal/parser/parse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse.d.ts","sourceRoot":"","sources":["../../../../src/lib/_internal/parser/parse.ts"],"names":[],"mappings":"AAIA,OAAO,EAGL,WAAW,EAUZ,MAAM,mBAAmB,CAAA;AAyc1B;;;;;GAKG;AACH,eAAO,MAAM,aAAa,GAAI,SAAS,MAAM,EAAE,UAAU,MAAM,KAAG,WA+JjE,CAAA"}