@syncular/typegen 0.5.1 → 0.6.0

package/dist/syql.d.ts

@@ -1,102 +0,0 @@
-import type { IrDocument } from './ir.js';
-import { type AnalyzedQuery, type QueryDb, type QueryNamingOptions } from './query.js';
-export interface SyqlParamDecl {
-    readonly name: string;
-    readonly optional: boolean;
-    /** `from+to?` pairing: both params share the group key. */
-    readonly group?: string;
-    /** `name?: flag` — a boolean guard param (§3). */
-    readonly flag: boolean;
-}
-export interface SyqlOrderBy {
-    readonly allowed: readonly string[];
-    readonly defaultColumn: string;
-    readonly defaultDir: 'asc' | 'desc';
-}
-export interface SyqlLimit {
-    readonly max?: number;
-    readonly default?: number;
-}
-export interface SyqlDepends {
-    readonly table: string;
-    readonly variable: string;
-    readonly params: readonly string[];
-}
-export interface SyqlWindow {
-    readonly table: string;
-    readonly variable: string;
-    readonly units: readonly string[];
-    readonly fixedScopes: readonly {
-        readonly variable: string;
-        readonly param: string;
-    }[];
-}
-export interface SyqlFragmentDecl {
-    readonly name: string;
-    readonly params: readonly SyqlParamDecl[];
-    /** The predicate body (raw SQL expression text). */
-    readonly body: string;
-    /** Source offset of the `fragment` keyword (editor tooling). */
-    readonly offset: number;
-}
-export interface SyqlQueryDecl {
-    readonly name: string;
-    readonly params: readonly SyqlParamDecl[];
-    readonly orderBy?: SyqlOrderBy;
-    readonly limit?: SyqlLimit;
-    /** §7 opt-in: lower to 2^N enumerated statements (perfect index use)
-     * instead of one neutralized statement. API-invisible. */
-    readonly variants?: boolean;
-    /** Checked escape hatches for SQL shapes the conservative analyzer cannot
-     * prove. They live with the query, never in React application code. */
-    readonly depends?: readonly SyqlDepends[];
-    readonly windows?: readonly SyqlWindow[];
-    readonly keyBy?: readonly string[];
-    /** The SQL-shaped body (may contain @fragment refs and if-guards). */
-    readonly body: string;
-    /** Source offset of the `query` keyword (editor tooling). */
-    readonly offset: number;
-}
-export interface SyqlFile {
-    readonly fragments: readonly SyqlFragmentDecl[];
-    readonly queries: readonly SyqlQueryDecl[];
-}
-/** Parse one `.syql` file into its declarations (no lowering yet). */
-export declare function parseSyqlFile(file: string, content: string): SyqlFile;
-interface ParamInfo {
-    optional: boolean;
-    group?: string;
-    flag: boolean;
-    declared: boolean;
-}
-/** One top-level WHERE conjunct after guard analysis: `governing` is the
- * set of OPTIONAL param names gating it (empty = required conjunct). */
-export interface LoweredConjunct {
-    readonly pred: string;
-    readonly governing: readonly string[];
-}
-export interface LoweredSyqlQuery {
-    /** The lowered single SQL statement (named params, no knob tails). */
-    readonly sql: string;
-    /** Params discovered/declared, in signature-then-first-use order. */
-    readonly paramInfo: ReadonlyMap<string, ParamInfo>;
-    /** Statement text before the `where` keyword (whole statement when there
-     * is no WHERE). */
-    readonly prefix: string;
-    /** Statement text after the WHERE clause (may be empty). */
-    readonly suffix: string;
-    /** The structured conjuncts (empty when there is no WHERE) — the §7
-     * variant backend re-assembles per provided-combination from these. */
-    readonly conjuncts: readonly LoweredConjunct[];
-}
-/**
- * Lower one query body: splice fragments, auto-guard optional conjuncts,
- * expand `if` guards, enforce B1. Returns plain SQL (knob tails are the
- * caller's job).
- */
-export declare function lowerSyqlBody(decl: SyqlQueryDecl, fragments: ReadonlyMap<string, SyqlFragmentDecl>, location: string): LoweredSyqlQuery;
-/** Analyze every query of one `.syql` file into `AnalyzedQuery` units —
- * byte-compatible with the `.sql` frontend's output (§1: nothing below the
- * IR knows the frontend). */
-export declare function analyzeSyqlFile(relPath: string, content: string, ir: IrDocument, db: QueryDb, naming?: QueryNamingOptions): AnalyzedQuery[];
-export {};