@powersync/service-sync-rules 0.0.0-dev-20240708103353

package/dist/SqlDataQuery.d.ts

@@ -0,0 +1,39 @@
+import { SelectedColumn } from 'pgsql-ast-parser';
+import { SqlRuleError } from './errors.js';
+import { ColumnDefinition } from './ExpressionType.js';
+import { SourceTableInterface } from './SourceTableInterface.js';
+import { SqlTools } from './sql_filters.js';
+import { TablePattern } from './TablePattern.js';
+import { EvaluationResult, ParameterMatchClause, QueryParameters, QuerySchema, SourceSchema, SqliteRow } from './types.js';
+interface RowValueExtractor {
+    extract(tables: QueryParameters, into: SqliteRow): void;
+    getTypes(schema: QuerySchema, into: Record<string, ColumnDefinition>): void;
+}
+export declare class SqlDataQuery {
+    static fromSql(descriptor_name: string, bucket_parameters: string[], sql: string, schema?: SourceSchema): SqlDataQuery;
+    sourceTable?: TablePattern;
+    table?: string;
+    sql?: string;
+    columns?: SelectedColumn[];
+    extractors: RowValueExtractor[];
+    filter?: ParameterMatchClause;
+    descriptor_name?: string;
+    bucket_parameters?: string[];
+    tools?: SqlTools;
+    ruleId?: string;
+    errors: SqlRuleError[];
+    constructor();
+    applies(table: SourceTableInterface): boolean | undefined;
+    addSpecialParameters(table: SourceTableInterface, row: SqliteRow): SqliteRow;
+    getOutputName(sourceTable: string): string;
+    isUnaliasedWildcard(): boolean;
+    evaluateRow(table: SourceTableInterface, row: SqliteRow): EvaluationResult[];
+    private transformRow;
+    columnOutputNames(): string[];
+    getColumnOutputs(schema: SourceSchema): {
+        name: string;
+        columns: ColumnDefinition[];
+    }[];
+    private getColumnOutputsFor;
+}
+export {};

package/dist/SqlDataQuery.js

@@ -0,0 +1,239 @@
+import { JSONBig } from '@powersync/service-jsonbig';
+import { parse } from 'pgsql-ast-parser';
+import { SqlRuleError } from './errors.js';
+import { ExpressionType } from './ExpressionType.js';
+import { SqlTools } from './sql_filters.js';
+import { castAsText } from './sql_functions.js';
+import { checkUnsupportedFeatures, isClauseError } from './sql_support.js';
+import { TablePattern } from './TablePattern.js';
+import { filterJsonRow, getBucketId, isSelectStatement } from './utils.js';
+import { TableQuerySchema } from './TableQuerySchema.js';
+export class SqlDataQuery {
+    static fromSql(descriptor_name, bucket_parameters, sql, schema) {
+        const parsed = parse(sql, { locationTracking: true });
+        const rows = new SqlDataQuery();
+        if (parsed.length > 1) {
+            throw new SqlRuleError('Only a single SELECT statement is supported', sql, parsed[1]?._location);
+        }
+        const q = parsed[0];
+        if (!isSelectStatement(q)) {
+            throw new SqlRuleError('Only SELECT statements are supported', sql, q._location);
+        }
+        rows.errors.push(...checkUnsupportedFeatures(sql, q));
+        if (q.from == null || q.from.length != 1 || q.from[0].type != 'table') {
+            throw new SqlRuleError('Must SELECT from a single table', sql, q.from?.[0]._location);
+        }
+        const tableRef = q.from?.[0].name;
+        if (tableRef?.name == null) {
+            throw new SqlRuleError('Must SELECT from a single table', sql, q.from?.[0]._location);
+        }
+        const alias = tableRef.alias ?? tableRef.name;
+        const sourceTable = new TablePattern(tableRef.schema, tableRef.name);
+        let querySchema = undefined;
+        if (schema) {
+            const tables = schema.getTables(sourceTable);
+            if (tables.length == 0) {
+                const e = new SqlRuleError(`Table ${sourceTable.schema}.${sourceTable.tablePattern} not found`, sql, q.from?.[0]?._location);
+                e.type = 'warning';
+                rows.errors.push(e);
+            }
+            else {
+                querySchema = new TableQuerySchema(tables, alias);
+            }
+        }
+        const where = q.where;
+        const tools = new SqlTools({
+            table: alias,
+            parameter_tables: ['bucket'],
+            value_tables: [alias],
+            sql,
+            schema: querySchema
+        });
+        const filter = tools.compileWhereClause(where);
+        const inputParameterNames = filter.inputParameters.map((p) => p.key);
+        const bucketParameterNames = bucket_parameters.map((p) => `bucket.${p}`);
+        const allParams = new Set([...inputParameterNames, ...bucketParameterNames]);
+        if ((!filter.error && allParams.size != filter.inputParameters.length) ||
+            allParams.size != bucket_parameters.length) {
+            rows.errors.push(new SqlRuleError(`Query must cover all bucket parameters. Expected: ${JSONBig.stringify(bucketParameterNames)} Got: ${JSONBig.stringify(inputParameterNames)}`, sql, q._location));
+        }
+        rows.sourceTable = sourceTable;
+        rows.table = alias;
+        rows.sql = sql;
+        rows.filter = filter;
+        rows.descriptor_name = descriptor_name;
+        rows.bucket_parameters = bucket_parameters;
+        rows.columns = q.columns ?? [];
+        rows.tools = tools;
+        let hasId = false;
+        for (let column of q.columns ?? []) {
+            const name = tools.getOutputName(column);
+            if (name != '*') {
+                const clause = tools.compileRowValueExtractor(column.expr);
+                if (isClauseError(clause)) {
+                    // Error logged already
+                    continue;
+                }
+                rows.extractors.push({
+                    extract: (tables, output) => {
+                        output[name] = clause.evaluate(tables);
+                    },
+                    getTypes(schema, into) {
+                        into[name] = { name, type: clause.getType(schema) };
+                    }
+                });
+            }
+            else {
+                rows.extractors.push({
+                    extract: (tables, output) => {
+                        const row = tables[alias];
+                        for (let key in row) {
+                            if (key.startsWith('_')) {
+                                continue;
+                            }
+                            output[key] ?? (output[key] = row[key]);
+                        }
+                    },
+                    getTypes(schema, into) {
+                        var _a;
+                        for (let column of schema.getColumns(alias)) {
+                            into[_a = column.name] ?? (into[_a] = column);
+                        }
+                    }
+                });
+            }
+            if (name == 'id' || name == '*') {
+                hasId = true;
+            }
+        }
+        if (!hasId) {
+            rows.errors.push(new SqlRuleError(`Query must return an "id" column`, sql, q.columns?.[0]._location));
+        }
+        rows.errors.push(...tools.errors);
+        return rows;
+    }
+    constructor() {
+        this.extractors = [];
+        this.errors = [];
+    }
+    applies(table) {
+        return this.sourceTable?.matches(table);
+    }
+    addSpecialParameters(table, row) {
+        if (this.sourceTable.isWildcard) {
+            return {
+                ...row,
+                _table_suffix: this.sourceTable.suffix(table.table)
+            };
+        }
+        else {
+            return row;
+        }
+    }
+    getOutputName(sourceTable) {
+        if (this.isUnaliasedWildcard()) {
+            // Wildcard without alias - use source
+            return sourceTable;
+        }
+        else {
+            return this.table;
+        }
+    }
+    isUnaliasedWildcard() {
+        return this.sourceTable.isWildcard && this.table == this.sourceTable.tablePattern;
+    }
+    evaluateRow(table, row) {
+        try {
+            const tables = { [this.table]: this.addSpecialParameters(table, row) };
+            const bucketParameters = this.filter.filterRow(tables);
+            const bucketIds = bucketParameters.map((params) => getBucketId(this.descriptor_name, this.bucket_parameters, params));
+            const data = this.transformRow(tables);
+            let id = data.id;
+            if (typeof id != 'string') {
+                // While an explicit cast would be better, this covers against very common
+                // issues when initially testing out sync, for example when the id column is an
+                // auto-incrementing integer.
+                // If there is no id column, we use a blank id. This will result in the user syncing
+                // a single arbitrary row for this table - better than just not being able to sync
+                // anything.
+                id = castAsText(id) ?? '';
+            }
+            const outputTable = this.getOutputName(table.table);
+            return bucketIds.map((bucketId) => {
+                return {
+                    bucket: bucketId,
+                    table: outputTable,
+                    id: id,
+                    data,
+                    ruleId: this.ruleId
+                };
+            });
+        }
+        catch (e) {
+            return [{ error: e.message ?? `Evaluating data query failed` }];
+        }
+    }
+    transformRow(tables) {
+        let result = {};
+        for (let extractor of this.extractors) {
+            extractor.extract(tables, result);
+        }
+        return filterJsonRow(result);
+    }
+    columnOutputNames() {
+        return this.columns.map((c) => {
+            return this.tools.getOutputName(c);
+        });
+    }
+    getColumnOutputs(schema) {
+        let result = [];
+        if (this.isUnaliasedWildcard()) {
+            // Separate results
+            for (let schemaTable of schema.getTables(this.sourceTable)) {
+                let output = {};
+                this.getColumnOutputsFor(schemaTable, output);
+                result.push({
+                    name: this.getOutputName(schemaTable.table),
+                    columns: Object.values(output)
+                });
+            }
+        }
+        else {
+            // Merged results
+            let output = {};
+            for (let schemaTable of schema.getTables(this.sourceTable)) {
+                this.getColumnOutputsFor(schemaTable, output);
+            }
+            result.push({
+                name: this.table,
+                columns: Object.values(output)
+            });
+        }
+        return result;
+    }
+    getColumnOutputsFor(schemaTable, output) {
+        const querySchema = {
+            getType: (table, column) => {
+                if (table == this.table) {
+                    return schemaTable.getType(column) ?? ExpressionType.NONE;
+                }
+                else {
+                    // TODO: bucket parameters?
+                    return ExpressionType.NONE;
+                }
+            },
+            getColumns: (table) => {
+                if (table == this.table) {
+                    return schemaTable.getColumns();
+                }
+                else {
+                    return [];
+                }
+            }
+        };
+        for (let extractor of this.extractors) {
+            extractor.getTypes(querySchema, output);
+        }
+    }
+}
+//# sourceMappingURL=SqlDataQuery.js.map

package/dist/SqlDataQuery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SqlDataQuery.js","sourceRoot":"","sources":["../src/SqlDataQuery.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AACrD,OAAO,EAAE,KAAK,EAAkB,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAoB,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAEvE,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,wBAAwB,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAC3E,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAWjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC3E,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAOzD,MAAM,OAAO,YAAY;IACvB,MAAM,CAAC,OAAO,CAAC,eAAuB,EAAE,iBAA2B,EAAE,GAAW,EAAE,MAAqB;QACrG,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,EAAE,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAAC,CAAC;QACtD,MAAM,IAAI,GAAG,IAAI,YAAY,EAAE,CAAC;QAEhC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;YACrB,MAAM,IAAI,YAAY,CAAC,6CAA6C,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;SAClG;QACD,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QACpB,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE;YACzB,MAAM,IAAI,YAAY,CAAC,sCAAsC,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC;SAClF;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,wBAAwB,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;QAEtD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,OAAO,EAAE;YACrE,MAAM,IAAI,YAAY,CAAC,iCAAiC,EAAE,GAAG,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;SACvF;QAED,MAAM,QAAQ,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAClC,IAAI,QAAQ,EAAE,IAAI,IAAI,IAAI,EAAE;YAC1B,MAAM,IAAI,YAAY,CAAC,iCAAiC,EAAE,GAAG,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;SACvF;QACD,MAAM,KAAK,GAAW,QAAQ,CAAC,KAAK,IAAI,QAAQ,CAAC,IAAI,CAAC;QAEtD,MAAM,WAAW,GAAG,IAAI,YAAY,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;QACrE,IAAI,WAAW,GAA4B,SAAS,CAAC;QACrD,IAAI,MAAM,EAAE;YACV,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YAC7C,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,EAAE;gBACtB,MAAM,CAAC,GAAG,IAAI,YAAY,CACxB,SAAS,WAAW,CAAC,MAAM,IAAI,WAAW,CAAC,YAAY,YAAY,EACnE,GAAG,EACH,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,CACvB,CAAC;gBACF,CAAC,CAAC,IAAI,GAAG,SAAS,CAAC;gBAEnB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;aACrB;iBAAM;gBACL,WAAW,GAAG,IAAI,gBAAgB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;aACnD;SACF;QAED,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;QACtB,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC;YACzB,KAAK,EAAE,KAAK;YACZ,gBAAgB,EAAE,CAAC,QAAQ,CAAC;YAC5B,YAAY,EAAE,CAAC,KAAK,CAAC;YACrB,GAAG;YACH,MAAM,EAAE,WAAW;SACpB,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,KAAK,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAE/C,MAAM,mBAAmB,GAAG,MAAM,CAAC,eAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QACtE,MAAM,oBAAoB,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QACzE,MAAM,SAAS,GAAG,IAAI,GAAG,CAAS,CAAC,GAAG,mBAAmB,EAAE,GAAG,oBAAoB,CAAC,CAAC,CAAC;QACrF,IACE,CAAC,CAAC,MAAM,CAAC,KAAK,IAAI,SAAS,CAAC,IAAI,IAAI,MAAM,CAAC,eAAgB,CAAC,MAAM,CAAC;YACnE,SAAS,CAAC,IAAI,IAAI,iBAAiB,CAAC,MAAM,EAC1C;YACA,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,IAAI,YAAY,CACd,qDAAqD,OAAO,CAAC,SAAS,CACpE,oBAAoB,CACrB,SAAS,OAAO,CAAC,SAAS,CAAC,mBAAmB,CAAC,EAAE,EAClD,GAAG,EACH,CAAC,CAAC,SAAS,CACZ,CACF,CAAC;SACH;QAED,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC3C,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,OAAO,IAAI,EAAE,CAAC;QAC/B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QAEnB,IAAI,KAAK,GAAG,KAAK,CAAC;QAClB,KAAK,IAAI,MAAM,IAAI,CAAC,CAAC,OAAO,IAAI,EAAE,EAAE;YAClC,MAAM,IAAI,GAAG,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;YACzC,IAAI,IAAI,IAAI,GAAG,EAAE;gBACf,MAAM,MAAM,GAAG,KAAK,CAAC,wBAAwB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBAC3D,IAAI,aAAa,CAAC,MAAM,CAAC,EAAE;oBACzB,uBAAuB;oBACvB,SAAS;iBACV;gBACD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;oBACnB,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE;wBAC1B,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;oBACzC,CAAC;oBACD,QAAQ,CAAC,MAAM,EAAE,IAAI;wBACnB,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;oBACtD,CAAC;iBACF,CAAC,CAAC;aACJ;iBAAM;gBACL,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;oBACnB,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE;wBAC1B,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;wBAC1B,KAAK,IAAI,GAAG,IAAI,GAAG,EAAE;4BACnB,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;gCACvB,SAAS;6BACV;4BACD,MAAM,CAAC,GAAG,MAAV,MAAM,CAAC,GAAG,IAAM,GAAG,CAAC,GAAG,CAAC,EAAC;yBAC1B;oBACH,CAAC;oBACD,QAAQ,CAAC,MAAM,EAAE,IAAI;;wBACnB,KAAK,IAAI,MAAM,IAAI,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE;4BAC3C,IAAI,MAAC,MAAM,CAAC,IAAI,MAAhB,IAAI,OAAkB,MAAM,EAAC;yBAC9B;oBACH,CAAC;iBACF,CAAC,CAAC;aACJ;YACD,IAAI,IAAI,IAAI,IAAI,IAAI,IAAI,IAAI,GAAG,EAAE;gBAC/B,KAAK,GAAG,IAAI,CAAC;aACd;SACF;QACD,IAAI,CAAC,KAAK,EAAE;YACV,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,kCAAkC,EAAE,GAAG,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;SACvG;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAgBD;QAVA,eAAU,GAAwB,EAAE,CAAC;QAQrC,WAAM,GAAmB,EAAE,CAAC;IAEb,CAAC;IAEhB,OAAO,CAAC,KAA2B;QACjC,OAAO,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IAC1C,CAAC;IAED,oBAAoB,CAAC,KAA2B,EAAE,GAAc;QAC9D,IAAI,IAAI,CAAC,WAAY,CAAC,UAAU,EAAE;YAChC,OAAO;gBACL,GAAG,GAAG;gBACN,aAAa,EAAE,IAAI,CAAC,WAAY,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;aACrD,CAAC;SACH;aAAM;YACL,OAAO,GAAG,CAAC;SACZ;IACH,CAAC;IAED,aAAa,CAAC,WAAmB;QAC/B,IAAI,IAAI,CAAC,mBAAmB,EAAE,EAAE;YAC9B,sCAAsC;YACtC,OAAO,WAAW,CAAC;SACpB;aAAM;YACL,OAAO,IAAI,CAAC,KAAM,CAAC;SACpB;IACH,CAAC;IAED,mBAAmB;QACjB,OAAO,IAAI,CAAC,WAAY,CAAC,UAAU,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,WAAY,CAAC,YAAY,CAAC;IACtF,CAAC;IAED,WAAW,CAAC,KAA2B,EAAE,GAAc;QACrD,IAAI;YACF,MAAM,MAAM,GAAG,EAAE,CAAC,IAAI,CAAC,KAAM,CAAC,EAAE,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC;YACxE,MAAM,gBAAgB,GAAG,IAAI,CAAC,MAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YACxD,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAChD,WAAW,CAAC,IAAI,CAAC,eAAgB,EAAE,IAAI,CAAC,iBAAkB,EAAE,MAAM,CAAC,CACpE,CAAC;YAEF,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;YACvC,IAAI,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;YACjB,IAAI,OAAO,EAAE,IAAI,QAAQ,EAAE;gBACzB,0EAA0E;gBAC1E,+EAA+E;gBAC/E,6BAA6B;gBAC7B,oFAAoF;gBACpF,kFAAkF;gBAClF,YAAY;gBACZ,EAAE,GAAG,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC;aAC3B;YACD,MAAM,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAEpD,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;gBAChC,OAAO;oBACL,MAAM,EAAE,QAAQ;oBAChB,KAAK,EAAE,WAAW;oBAClB,EAAE,EAAE,EAAE;oBACN,IAAI;oBACJ,MAAM,EAAE,IAAI,CAAC,MAAM;iBACA,CAAC;YACxB,CAAC,CAAC,CAAC;SACJ;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,IAAI,8BAA8B,EAAE,CAAC,CAAC;SACjE;IACH,CAAC;IAEO,YAAY,CAAC,MAAuB;QAC1C,IAAI,MAAM,GAAc,EAAE,CAAC;QAC3B,KAAK,IAAI,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE;YACrC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;SACnC;QACD,OAAO,aAAa,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC;IAED,iBAAiB;QACf,OAAO,IAAI,CAAC,OAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YAC7B,OAAO,IAAI,CAAC,KAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,gBAAgB,CAAC,MAAoB;QACnC,IAAI,MAAM,GAAoD,EAAE,CAAC;QAEjE,IAAI,IAAI,CAAC,mBAAmB,EAAE,EAAE;YAC9B,mBAAmB;YACnB,KAAK,IAAI,WAAW,IAAI,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,WAAY,CAAC,EAAE;gBAC3D,IAAI,MAAM,GAAqC,EAAE,CAAC;gBAElD,IAAI,CAAC,mBAAmB,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;gBAE9C,MAAM,CAAC,IAAI,CAAC;oBACV,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,KAAK,CAAC;oBAC3C,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;iBAC/B,CAAC,CAAC;aACJ;SACF;aAAM;YACL,iBAAiB;YACjB,IAAI,MAAM,GAAqC,EAAE,CAAC;YAClD,KAAK,IAAI,WAAW,IAAI,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,WAAY,CAAC,EAAE;gBAC3D,IAAI,CAAC,mBAAmB,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;aAC/C;YACD,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,IAAI,CAAC,KAAM;gBACjB,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;aAC/B,CAAC,CAAC;SACJ;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,mBAAmB,CAAC,WAA8B,EAAE,MAAwC;QAClG,MAAM,WAAW,GAAgB;YAC/B,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;gBACzB,IAAI,KAAK,IAAI,IAAI,CAAC,KAAM,EAAE;oBACxB,OAAO,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC;iBAC3D;qBAAM;oBACL,2BAA2B;oBAC3B,OAAO,cAAc,CAAC,IAAI,CAAC;iBAC5B;YACH,CAAC;YACD,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE;gBACpB,IAAI,KAAK,IAAI,IAAI,CAAC,KAAM,EAAE;oBACxB,OAAO,WAAW,CAAC,UAAU,EAAE,CAAC;iBACjC;qBAAM;oBACL,OAAO,EAAE,CAAC;iBACX;YACH,CAAC;SACF,CAAC;QACF,KAAK,IAAI,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE;YACrC,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;SACzC;IACH,CAAC;CACF"}

package/dist/SqlParameterQuery.d.ts

@@ -0,0 +1,85 @@
+import { SelectedColumn } from 'pgsql-ast-parser';
+import { SqlRuleError } from './errors.js';
+import { SourceTableInterface } from './SourceTableInterface.js';
+import { SqlTools } from './sql_filters.js';
+import { StaticSqlParameterQuery } from './StaticSqlParameterQuery.js';
+import { TablePattern } from './TablePattern.js';
+import { EvaluatedParametersResult, InputParameter, ParameterMatchClause, ParameterValueClause, QueryBucketIdOptions, QueryParseOptions, RequestParameters, RowValueClause, SourceSchema, SqliteJsonRow, SqliteJsonValue, SqliteRow } from './types.js';
+/**
+ * Represents a parameter query, such as:
+ *
+ *  SELECT id as user_id FROM users WHERE users.user_id = token_parameters.user_id
+ *  SELECT id as user_id, token_parameters.is_admin as is_admin FROM users WHERE users.user_id = token_parameters.user_id
+ */
+export declare class SqlParameterQuery {
+    static fromSql(descriptor_name: string, sql: string, schema?: SourceSchema, options?: QueryParseOptions): SqlParameterQuery | StaticSqlParameterQuery;
+    sourceTable?: TablePattern;
+    table?: string;
+    sql?: string;
+    columns?: SelectedColumn[];
+    lookup_columns?: SelectedColumn[];
+    static_columns?: SelectedColumn[];
+    /**
+     * Example: SELECT *user.id* FROM users WHERE ...
+     */
+    lookup_extractors: Record<string, RowValueClause>;
+    /**
+     * Example: SELECT *token_parameters.user_id*
+     */
+    parameter_extractors: Record<string, ParameterValueClause>;
+    filter?: ParameterMatchClause;
+    descriptor_name?: string;
+    /** _Input_ token / user parameters */
+    input_parameters?: InputParameter[];
+    /** If specified, an input parameter that expands to an array. */
+    expanded_input_parameter?: InputParameter;
+    /**
+     * _Output_ bucket parameters.
+     *
+     * Each one of these will be present in either lookup_extractors or static_extractors.
+     */
+    bucket_parameters?: string[];
+    id?: string;
+    tools?: SqlTools;
+    errors: SqlRuleError[];
+    constructor();
+    applies(table: SourceTableInterface): boolean;
+    evaluateParameterRow(row: SqliteRow): EvaluatedParametersResult[];
+    transformRows(row: SqliteRow): SqliteRow[];
+    /**
+     * Given partial parameter rows, turn into bucket ids.
+     */
+    resolveBucketIds(bucketParameters: SqliteJsonRow[], parameters: RequestParameters): string[];
+    /**
+     * Given sync parameters, get lookups we need to perform on the database.
+     *
+     * Each lookup is [bucket definition name, parameter query index, ...lookup values]
+     */
+    getLookups(parameters: RequestParameters): SqliteJsonValue[][];
+    /**
+     * Given sync parameters (token and user parameters), return bucket ids.
+     *
+     * This is done in three steps:
+     * 1. Given the parameters, get lookups we need to perform on the database.
+     * 2. Perform the lookups, returning parameter sets (partial rows).
+     * 3. Given the parameter sets, resolve bucket ids.
+     */
+    queryBucketIds(options: QueryBucketIdOptions): Promise<string[]>;
+    get hasAuthenticatedBucketParameters(): boolean;
+    get hasAuthenticatedMatchClause(): boolean;
+    get usesUnauthenticatedRequestParameters(): boolean;
+    /**
+     * Safe:
+     * SELECT id as user_id FROM users WHERE users.user_id = request.user_id()
+     * SELECT request.jwt() ->> 'org_id' as org_id, id as project_id FROM projects WHERE id = request.parameters() ->> 'project_id'
+     * SELECT id as project_id FROM projects WHERE org_id = request.jwt() ->> 'org_id' AND id = request.parameters() ->> 'project_id'
+     * SELECT id as category_id FROM categories
+     *
+     * Dangerous:
+     * SELECT id as project_id FROM projects WHERE id = request.parameters() ->> 'project_id'
+     * SELECT id as project_id FROM projects WHERE id = request.parameters() ->> 'project_id' AND request.jwt() ->> 'role' = 'authenticated'
+     * SELECT id as category_id, request.parameters() ->> 'project_id' as project_id FROM categories
+     * SELECT id as category_id FROM categories WHERE request.parameters() ->> 'include_categories'
+     */
+    get usesDangerousRequestParameters(): boolean;
+}