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

package/dist/StaticSchema.d.ts

@@ -0,0 +1,26 @@
+import { TablePattern } from './TablePattern.js';
+import { SourceSchema, SourceSchemaTable } from './types.js';
+export interface SourceSchemaDefinition {
+    name: string;
+    tables: SourceTableDefinition[];
+}
+export interface SourceTableDefinition {
+    name: string;
+    columns: SourceColumnDefinition[];
+}
+export interface SourceColumnDefinition {
+    name: string;
+    /**
+     * Postgres type.
+     */
+    pg_type: string;
+}
+export interface SourceConnectionDefinition {
+    tag: string;
+    schemas: SourceSchemaDefinition[];
+}
+export declare class StaticSchema implements SourceSchema {
+    private tables;
+    constructor(connections: SourceConnectionDefinition[]);
+    getTables(sourceTable: TablePattern): SourceSchemaTable[];
+}

package/dist/StaticSchema.js

@@ -0,0 +1,61 @@
+import { ExpressionType } from './ExpressionType.js';
+class SourceTableDetails {
+    constructor(connection, schema, table) {
+        this.connectionTag = connection.tag;
+        this.schema = schema.name;
+        this.table = table.name;
+        this.columns = Object.fromEntries(table.columns.map((column) => {
+            return [column.name, mapColumn(column)];
+        }));
+    }
+    getType(column) {
+        return this.columns[column]?.type;
+    }
+    getColumns() {
+        return Object.values(this.columns);
+    }
+}
+export class StaticSchema {
+    constructor(connections) {
+        this.tables = [];
+        for (let connection of connections) {
+            for (let schema of connection.schemas) {
+                for (let table of schema.tables) {
+                    this.tables.push(new SourceTableDetails(connection, schema, table));
+                }
+            }
+        }
+    }
+    getTables(sourceTable) {
+        const filtered = this.tables.filter((t) => sourceTable.matches(t));
+        return filtered;
+    }
+}
+function mapColumn(column) {
+    return {
+        name: column.name,
+        type: mapType(column.pg_type)
+    };
+}
+function mapType(type) {
+    if (type?.endsWith('[]')) {
+        return ExpressionType.TEXT;
+    }
+    switch (type) {
+        case 'bool':
+            return ExpressionType.INTEGER;
+        case 'bytea':
+            return ExpressionType.BLOB;
+        case 'int2':
+        case 'int4':
+        case 'int8':
+        case 'oid':
+            return ExpressionType.INTEGER;
+        case 'float4':
+        case 'float8':
+            return ExpressionType.REAL;
+        default:
+            return ExpressionType.TEXT;
+    }
+}
+//# sourceMappingURL=StaticSchema.js.map

package/dist/StaticSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StaticSchema.js","sourceRoot":"","sources":["../src/StaticSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,cAAc,EAAE,MAAM,qBAAqB,CAAC;AA4BvE,MAAM,kBAAkB;IAMtB,YAAY,UAAsC,EAAE,MAA8B,EAAE,KAA4B;QAC9G,IAAI,CAAC,aAAa,GAAG,UAAU,CAAC,GAAG,CAAC;QACpC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC;QAC1B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,WAAW,CAC/B,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;YAC3B,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;QAC1C,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;IAED,OAAO,CAAC,MAAc;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC;IACpC,CAAC;IAED,UAAU;QACR,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC;CACF;AAED,MAAM,OAAO,YAAY;IAGvB,YAAY,WAAyC;QACnD,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACjB,KAAK,IAAI,UAAU,IAAI,WAAW,EAAE;YAClC,KAAK,IAAI,MAAM,IAAI,UAAU,CAAC,OAAO,EAAE;gBACrC,KAAK,IAAI,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE;oBAC/B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,kBAAkB,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;iBACrE;aACF;SACF;IACH,CAAC;IAED,SAAS,CAAC,WAAyB;QACjC,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QACnE,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF;AAED,SAAS,SAAS,CAAC,MAA8B;IAC/C,OAAO;QACL,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC;KAC9B,CAAC;AACJ,CAAC;AAED,SAAS,OAAO,CAAC,IAAwB;IACvC,IAAI,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,EAAE;QACxB,OAAO,cAAc,CAAC,IAAI,CAAC;KAC5B;IACD,QAAQ,IAAI,EAAE;QACZ,KAAK,MAAM;YACT,OAAO,cAAc,CAAC,OAAO,CAAC;QAChC,KAAK,OAAO;YACV,OAAO,cAAc,CAAC,IAAI,CAAC;QAC7B,KAAK,MAAM,CAAC;QACZ,KAAK,MAAM,CAAC;QACZ,KAAK,MAAM,CAAC;QACZ,KAAK,KAAK;YACR,OAAO,cAAc,CAAC,OAAO,CAAC;QAChC,KAAK,QAAQ,CAAC;QACd,KAAK,QAAQ;YACX,OAAO,cAAc,CAAC,IAAI,CAAC;QAC7B;YACE,OAAO,cAAc,CAAC,IAAI,CAAC;KAC9B;AACH,CAAC"}

package/dist/StaticSqlParameterQuery.d.ts

@@ -0,0 +1,27 @@
+import { SelectedColumn, SelectFromStatement } from 'pgsql-ast-parser';
+import { SqlRuleError } from './errors.js';
+import { SqlTools } from './sql_filters.js';
+import { ParameterValueClause, QueryParseOptions, RequestParameters } from './types.js';
+/**
+ * Represents a bucket parameter query without any tables, e.g.:
+ *
+ *    SELECT token_parameters.user_id
+ *    SELECT token_parameters.user_id as user_id WHERE token_parameters.is_admin
+ */
+export declare class StaticSqlParameterQuery {
+    static fromSql(descriptor_name: string, sql: string, q: SelectFromStatement, options?: QueryParseOptions): StaticSqlParameterQuery;
+    sql?: string;
+    columns?: SelectedColumn[];
+    parameter_extractors: Record<string, ParameterValueClause>;
+    descriptor_name?: string;
+    /** _Output_ bucket parameters */
+    bucket_parameters?: string[];
+    id?: string;
+    tools?: SqlTools;
+    filter?: ParameterValueClause;
+    errors: SqlRuleError[];
+    getStaticBucketIds(parameters: RequestParameters): string[];
+    get hasAuthenticatedBucketParameters(): boolean;
+    get usesUnauthenticatedRequestParameters(): boolean;
+    get usesDangerousRequestParameters(): boolean;
+}

package/dist/StaticSqlParameterQuery.js

@@ -0,0 +1,96 @@
+import { SqlRuleError } from './errors.js';
+import { SqlTools } from './sql_filters.js';
+import { checkUnsupportedFeatures, isClauseError, isParameterValueClause, sqliteBool } from './sql_support.js';
+import { getBucketId, isJsonValue } from './utils.js';
+/**
+ * Represents a bucket parameter query without any tables, e.g.:
+ *
+ *    SELECT token_parameters.user_id
+ *    SELECT token_parameters.user_id as user_id WHERE token_parameters.is_admin
+ */
+export class StaticSqlParameterQuery {
+    constructor() {
+        this.parameter_extractors = {};
+        this.errors = [];
+    }
+    static fromSql(descriptor_name, sql, q, options) {
+        const query = new StaticSqlParameterQuery();
+        query.errors.push(...checkUnsupportedFeatures(sql, q));
+        const tools = new SqlTools({
+            table: undefined,
+            parameter_tables: ['token_parameters', 'user_parameters'],
+            supports_parameter_expressions: true,
+            sql
+        });
+        const where = q.where;
+        const filter = tools.compileParameterValueExtractor(where);
+        const columns = q.columns ?? [];
+        const bucket_parameters = columns.map((column) => tools.getOutputName(column));
+        query.sql = sql;
+        query.descriptor_name = descriptor_name;
+        query.bucket_parameters = bucket_parameters;
+        query.columns = columns;
+        query.tools = tools;
+        if (!isClauseError(filter)) {
+            query.filter = filter;
+        }
+        for (let column of columns) {
+            const name = tools.getSpecificOutputName(column);
+            const extractor = tools.compileParameterValueExtractor(column.expr);
+            if (isClauseError(extractor)) {
+                // Error logged already
+                continue;
+            }
+            query.parameter_extractors[name] = extractor;
+        }
+        query.errors.push(...tools.errors);
+        if (query.usesDangerousRequestParameters && !options?.accept_potentially_dangerous_queries) {
+            let err = new SqlRuleError('Pontially dangerous query based on unauthenticated client parameters', sql);
+            err.type = 'warning';
+            query.errors.push(err);
+        }
+        return query;
+    }
+    getStaticBucketIds(parameters) {
+        if (this.filter == null) {
+            // Error in filter clause
+            return [];
+        }
+        const filterValue = this.filter.lookupParameterValue(parameters);
+        if (sqliteBool(filterValue) === 0n) {
+            return [];
+        }
+        let result = {};
+        for (let name of this.bucket_parameters) {
+            const value = this.parameter_extractors[name].lookupParameterValue(parameters);
+            if (isJsonValue(value)) {
+                result[`bucket.${name}`] = value;
+            }
+            else {
+                // Not valid.
+                // Should we error instead?
+                return [];
+            }
+        }
+        return [getBucketId(this.descriptor_name, this.bucket_parameters, result)];
+    }
+    get hasAuthenticatedBucketParameters() {
+        // select where request.jwt() ->> 'role' == 'authorized'
+        // we do not count this as a sufficient check
+        // const authenticatedFilter = this.filter!.usesAuthenticatedRequestParameters;
+        // select request.user_id() as user_id
+        const authenticatedExtractor = Object.values(this.parameter_extractors).find((clause) => isParameterValueClause(clause) && clause.usesAuthenticatedRequestParameters) != null;
+        return authenticatedExtractor;
+    }
+    get usesUnauthenticatedRequestParameters() {
+        // select where request.parameters() ->> 'include_comments'
+        const unauthenticatedFilter = this.filter.usesUnauthenticatedRequestParameters;
+        // select request.parameters() ->> 'project_id'
+        const unauthenticatedExtractor = Object.values(this.parameter_extractors).find((clause) => isParameterValueClause(clause) && clause.usesUnauthenticatedRequestParameters) != null;
+        return unauthenticatedFilter || unauthenticatedExtractor;
+    }
+    get usesDangerousRequestParameters() {
+        return this.usesUnauthenticatedRequestParameters && !this.hasAuthenticatedBucketParameters;
+    }
+}
+//# sourceMappingURL=StaticSqlParameterQuery.js.map

package/dist/StaticSqlParameterQuery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StaticSqlParameterQuery.js","sourceRoot":"","sources":["../src/StaticSqlParameterQuery.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,wBAAwB,EAAE,aAAa,EAAE,sBAAsB,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE/G,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEtD;;;;;GAKG;AACH,MAAM,OAAO,uBAAuB;IAApC;QAiDE,yBAAoB,GAAyC,EAAE,CAAC;QAShE,WAAM,GAAmB,EAAE,CAAC;IAwD9B,CAAC;IAjHC,MAAM,CAAC,OAAO,CAAC,eAAuB,EAAE,GAAW,EAAE,CAAsB,EAAE,OAA2B;QACtG,MAAM,KAAK,GAAG,IAAI,uBAAuB,EAAE,CAAC;QAE5C,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,wBAAwB,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;QAEvD,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC;YACzB,KAAK,EAAE,SAAS;YAChB,gBAAgB,EAAE,CAAC,kBAAkB,EAAE,iBAAiB,CAAC;YACzD,8BAA8B,EAAE,IAAI;YACpC,GAAG;SACJ,CAAC,CAAC;QACH,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;QAEtB,MAAM,MAAM,GAAG,KAAK,CAAC,8BAA8B,CAAC,KAAK,CAAC,CAAC;QAC3D,MAAM,OAAO,GAAG,CAAC,CAAC,OAAO,IAAI,EAAE,CAAC;QAChC,MAAM,iBAAiB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;QAE/E,KAAK,CAAC,GAAG,GAAG,GAAG,CAAC;QAChB,KAAK,CAAC,eAAe,GAAG,eAAe,CAAC;QACxC,KAAK,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC5C,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;QACxB,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE;YAC1B,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;SACvB;QAED,KAAK,IAAI,MAAM,IAAI,OAAO,EAAE;YAC1B,MAAM,IAAI,GAAG,KAAK,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;YACjD,MAAM,SAAS,GAAG,KAAK,CAAC,8BAA8B,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACpE,IAAI,aAAa,CAAC,SAAS,CAAC,EAAE;gBAC5B,uBAAuB;gBACvB,SAAS;aACV;YACD,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC;SAC9C;QAED,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;QAEnC,IAAI,KAAK,CAAC,8BAA8B,IAAI,CAAC,OAAO,EAAE,oCAAoC,EAAE;YAC1F,IAAI,GAAG,GAAG,IAAI,YAAY,CAAC,sEAAsE,EAAE,GAAG,CAAC,CAAC;YACxG,GAAG,CAAC,IAAI,GAAG,SAAS,CAAC;YACrB,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACxB;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAeD,kBAAkB,CAAC,UAA6B;QAC9C,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;YACvB,yBAAyB;YACzB,OAAO,EAAE,CAAC;SACX;QACD,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QACjE,IAAI,UAAU,CAAC,WAAW,CAAC,KAAK,EAAE,EAAE;YAClC,OAAO,EAAE,CAAC;SACX;QAED,IAAI,MAAM,GAAoC,EAAE,CAAC;QACjD,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,iBAAkB,EAAE;YACxC,MAAM,KAAK,GAAG,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;YAC/E,IAAI,WAAW,CAAC,KAAK,CAAC,EAAE;gBACtB,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC,GAAG,KAAK,CAAC;aAClC;iBAAM;gBACL,aAAa;gBACb,2BAA2B;gBAC3B,OAAO,EAAE,CAAC;aACX;SACF;QAED,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,eAAgB,EAAE,IAAI,CAAC,iBAAkB,EAAE,MAAM,CAAC,CAAC,CAAC;IAC/E,CAAC;IAED,IAAI,gCAAgC;QAClC,wDAAwD;QACxD,6CAA6C;QAC7C,+EAA+E;QAE/E,sCAAsC;QACtC,MAAM,sBAAsB,GAC1B,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAC3C,CAAC,MAAM,EAAE,EAAE,CAAC,sBAAsB,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,kCAAkC,CACxF,IAAI,IAAI,CAAC;QACZ,OAAO,sBAAsB,CAAC;IAChC,CAAC;IAED,IAAI,oCAAoC;QACtC,2DAA2D;QAC3D,MAAM,qBAAqB,GAAG,IAAI,CAAC,MAAO,CAAC,oCAAoC,CAAC;QAEhF,+CAA+C;QAC/C,MAAM,wBAAwB,GAC5B,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAC3C,CAAC,MAAM,EAAE,EAAE,CAAC,sBAAsB,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,oCAAoC,CAC1F,IAAI,IAAI,CAAC;QAEZ,OAAO,qBAAqB,IAAI,wBAAwB,CAAC;IAC3D,CAAC;IAED,IAAI,8BAA8B;QAChC,OAAO,IAAI,CAAC,oCAAoC,IAAI,CAAC,IAAI,CAAC,gCAAgC,CAAC;IAC7F,CAAC;CACF"}

package/dist/TablePattern.d.ts

@@ -0,0 +1,17 @@
+import { SourceTableInterface } from './SourceTableInterface.js';
+export declare const DEFAULT_TAG = "default";
+export declare const DEFAULT_SCHEMA = "public";
+/**
+ * Some pattern matching SourceTables.
+ */
+export declare class TablePattern {
+    readonly connectionTag: string;
+    readonly schema: string;
+    readonly tablePattern: string;
+    constructor(schema: string | undefined, tablePattern: string);
+    get isWildcard(): boolean;
+    get tablePrefix(): string;
+    get name(): string;
+    matches(table: SourceTableInterface): boolean;
+    suffix(table: string): string;
+}

package/dist/TablePattern.js

@@ -0,0 +1,56 @@
+export const DEFAULT_TAG = 'default';
+export const DEFAULT_SCHEMA = 'public';
+/**
+ * Some pattern matching SourceTables.
+ */
+export class TablePattern {
+    constructor(schema, tablePattern) {
+        schema ?? (schema = DEFAULT_SCHEMA);
+        const splitSchema = schema.split('.');
+        if (splitSchema.length > 2) {
+            throw new Error(`Invalid schema: ${schema}`);
+        }
+        if (splitSchema.length == 2) {
+            this.connectionTag = splitSchema[0];
+            this.schema = splitSchema[1];
+        }
+        else {
+            this.connectionTag = DEFAULT_TAG;
+            this.schema = schema;
+        }
+        this.tablePattern = tablePattern;
+    }
+    get isWildcard() {
+        return this.tablePattern.endsWith('%');
+    }
+    get tablePrefix() {
+        if (!this.isWildcard) {
+            throw new Error('Not a wildcard table');
+        }
+        return this.tablePattern.substring(0, this.tablePattern.length - 1);
+    }
+    get name() {
+        if (this.isWildcard) {
+            throw new Error('Cannot get name for wildcard table');
+        }
+        return this.tablePattern;
+    }
+    matches(table) {
+        if (this.connectionTag != table.connectionTag || this.schema != table.schema) {
+            return false;
+        }
+        if (this.isWildcard) {
+            return table.table.startsWith(this.tablePrefix);
+        }
+        else {
+            return this.tablePattern == table.table;
+        }
+    }
+    suffix(table) {
+        if (!this.isWildcard) {
+            return '';
+        }
+        return table.substring(this.tablePrefix.length);
+    }
+}
+//# sourceMappingURL=TablePattern.js.map

package/dist/TablePattern.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TablePattern.js","sourceRoot":"","sources":["../src/TablePattern.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,WAAW,GAAG,SAAS,CAAC;AACrC,MAAM,CAAC,MAAM,cAAc,GAAG,QAAQ,CAAC;AAEvC;;GAEG;AACH,MAAM,OAAO,YAAY;IAMvB,YAAY,MAA0B,EAAE,YAAoB;QAC1D,MAAM,KAAN,MAAM,GAAK,cAAc,EAAC;QAC1B,MAAM,WAAW,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACtC,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE;YAC1B,MAAM,IAAI,KAAK,CAAC,mBAAmB,MAAM,EAAE,CAAC,CAAC;SAC9C;QACD,IAAI,WAAW,CAAC,MAAM,IAAI,CAAC,EAAE;YAC3B,IAAI,CAAC,aAAa,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;YACpC,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;SAC9B;aAAM;YACL,IAAI,CAAC,aAAa,GAAG,WAAW,CAAC;YACjC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;SACtB;QACD,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACnC,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,WAAW;QACb,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACtE,CAAC;IAED,IAAI,IAAI;QACN,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;SACvD;QACD,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,OAAO,CAAC,KAA2B;QACjC,IAAI,IAAI,CAAC,aAAa,IAAI,KAAK,CAAC,aAAa,IAAI,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,EAAE;YAC5E,OAAO,KAAK,CAAC;SACd;QACD,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,OAAO,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;SACjD;aAAM;YACL,OAAO,IAAI,CAAC,YAAY,IAAI,KAAK,CAAC,KAAK,CAAC;SACzC;IACH,CAAC;IAED,MAAM,CAAC,KAAa;QAClB,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YACpB,OAAO,EAAE,CAAC;SACX;QACD,OAAO,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAClD,CAAC;CACF"}

package/dist/TableQuerySchema.d.ts

@@ -0,0 +1,9 @@
+import { ColumnDefinition, ExpressionType } from './ExpressionType.js';
+import { QuerySchema, SourceSchemaTable } from './types.js';
+export declare class TableQuerySchema implements QuerySchema {
+    private tables;
+    private alias;
+    constructor(tables: SourceSchemaTable[], alias: string);
+    getType(table: string, column: string): ExpressionType;
+    getColumns(table: string): ColumnDefinition[];
+}

package/dist/TableQuerySchema.js

@@ -0,0 +1,34 @@
+import { ExpressionType } from './ExpressionType.js';
+export class TableQuerySchema {
+    constructor(tables, alias) {
+        this.tables = tables;
+        this.alias = alias;
+    }
+    getType(table, column) {
+        if (table != this.alias) {
+            return ExpressionType.NONE;
+        }
+        for (let table of this.tables) {
+            const t = table.getType(column);
+            if (t != null) {
+                return t;
+            }
+        }
+        return ExpressionType.NONE;
+    }
+    getColumns(table) {
+        if (table != this.alias) {
+            return [];
+        }
+        let columns = {};
+        for (let table of this.tables) {
+            for (let col of table.getColumns()) {
+                if (!(col.name in columns)) {
+                    columns[col.name] = col;
+                }
+            }
+        }
+        return Object.values(columns);
+    }
+}
+//# sourceMappingURL=TableQuerySchema.js.map

package/dist/TableQuerySchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TableQuerySchema.js","sourceRoot":"","sources":["../src/TableQuerySchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAGvE,MAAM,OAAO,gBAAgB;IAC3B,YAAoB,MAA2B,EAAU,KAAa;QAAlD,WAAM,GAAN,MAAM,CAAqB;QAAU,UAAK,GAAL,KAAK,CAAQ;IAAG,CAAC;IAE1E,OAAO,CAAC,KAAa,EAAE,MAAc;QACnC,IAAI,KAAK,IAAI,IAAI,CAAC,KAAK,EAAE;YACvB,OAAO,cAAc,CAAC,IAAI,CAAC;SAC5B;QACD,KAAK,IAAI,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE;YAC7B,MAAM,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAChC,IAAI,CAAC,IAAI,IAAI,EAAE;gBACb,OAAO,CAAC,CAAC;aACV;SACF;QACD,OAAO,cAAc,CAAC,IAAI,CAAC;IAC7B,CAAC;IAED,UAAU,CAAC,KAAa;QACtB,IAAI,KAAK,IAAI,IAAI,CAAC,KAAK,EAAE;YACvB,OAAO,EAAE,CAAC;SACX;QACD,IAAI,OAAO,GAAqC,EAAE,CAAC;QAEnD,KAAK,IAAI,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE;YAC7B,KAAK,IAAI,GAAG,IAAI,KAAK,CAAC,UAAU,EAAE,EAAE;gBAClC,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,IAAI,OAAO,CAAC,EAAE;oBAC1B,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;iBACzB;aACF;SACF;QACD,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;CACF"}

package/dist/errors.d.ts

@@ -0,0 +1,22 @@
+import { Expr, NodeLocation } from 'pgsql-ast-parser';
+export interface ErrorLocation {
+    start: number;
+    end: number;
+}
+export declare class SqlRuleError extends Error {
+    sql: string;
+    location?: ErrorLocation;
+    type: 'warning' | 'fatal';
+    constructor(message: string, sql: string, location?: NodeLocation | Expr);
+}
+export declare class YamlError extends Error {
+    source: Error;
+    location: ErrorLocation;
+    type: 'warning' | 'fatal';
+    constructor(source: Error, location?: ErrorLocation);
+}
+export declare class SyncRulesErrors extends Error {
+    errors: YamlError[];
+    static constructMessage(errors: YamlError[]): string;
+    constructor(errors: YamlError[]);
+}

package/dist/errors.js

@@ -0,0 +1,58 @@
+import * as yaml from 'yaml';
+function getLocation(location) {
+    if (location != null && !isLocation(location)) {
+        return location._location;
+    }
+    else if (isLocation(location)) {
+        return location;
+    }
+    else {
+        return undefined;
+    }
+}
+function isLocation(location) {
+    return (location != null &&
+        typeof location.start == 'number' &&
+        typeof location.end == 'number');
+}
+export class SqlRuleError extends Error {
+    constructor(message, sql, location) {
+        super(message);
+        this.sql = sql;
+        this.type = 'fatal';
+        this.location = getLocation(location) ?? { start: 0, end: sql.length };
+    }
+}
+export class YamlError extends Error {
+    constructor(source, location) {
+        super(source.message);
+        this.source = source;
+        this.type = 'fatal';
+        if (location == null && source instanceof yaml.YAMLError) {
+            location = {
+                start: source.pos[0],
+                end: source.pos[1]
+            };
+        }
+        else if (location == null) {
+            location = {
+                start: 0,
+                end: 10
+            };
+        }
+        if (source instanceof YamlError || source instanceof SqlRuleError) {
+            this.type = source.type;
+        }
+        this.location = location;
+    }
+}
+export class SyncRulesErrors extends Error {
+    static constructMessage(errors) {
+        return errors.map((e) => e.message).join(', ');
+    }
+    constructor(errors) {
+        super(SyncRulesErrors.constructMessage(errors));
+        this.errors = errors;
+    }
+}
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAO7B,SAAS,WAAW,CAAC,QAA8B;IACjD,IAAI,QAAQ,IAAI,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;QAC7C,OAAO,QAAQ,CAAC,SAAS,CAAC;KAC3B;SAAM,IAAI,UAAU,CAAC,QAAQ,CAAC,EAAE;QAC/B,OAAO,QAAQ,CAAC;KACjB;SAAM;QACL,OAAO,SAAS,CAAC;KAClB;AACH,CAAC;AAED,SAAS,UAAU,CAAC,QAA8B;IAChD,OAAO,CACL,QAAQ,IAAI,IAAI;QAChB,OAAQ,QAAyB,CAAC,KAAK,IAAI,QAAQ;QACnD,OAAQ,QAAyB,CAAC,GAAG,IAAI,QAAQ,CAClD,CAAC;AACJ,CAAC;AAED,MAAM,OAAO,YAAa,SAAQ,KAAK;IAIrC,YAAY,OAAe,EAAS,GAAW,EAAE,QAA8B;QAC7E,KAAK,CAAC,OAAO,CAAC,CAAC;QADmB,QAAG,GAAH,GAAG,CAAQ;QAF/C,SAAI,GAAwB,OAAO,CAAC;QAKlC,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC;IACzE,CAAC;CACF;AAED,MAAM,OAAO,SAAU,SAAQ,KAAK;IAIlC,YAAmB,MAAa,EAAE,QAAwB;QACxD,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QADL,WAAM,GAAN,MAAM,CAAO;QAFhC,SAAI,GAAwB,OAAO,CAAC;QAKlC,IAAI,QAAQ,IAAI,IAAI,IAAI,MAAM,YAAY,IAAI,CAAC,SAAS,EAAE;YACxD,QAAQ,GAAG;gBACT,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;gBACpB,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;aACnB,CAAC;SACH;aAAM,IAAI,QAAQ,IAAI,IAAI,EAAE;YAC3B,QAAQ,GAAG;gBACT,KAAK,EAAE,CAAC;gBACR,GAAG,EAAE,EAAE;aACR,CAAC;SACH;QAED,IAAI,MAAM,YAAY,SAAS,IAAI,MAAM,YAAY,YAAY,EAAE;YACjE,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;SACzB;QACD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;CACF;AAED,MAAM,OAAO,eAAgB,SAAQ,KAAK;IACxC,MAAM,CAAC,gBAAgB,CAAC,MAAmB;QACzC,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjD,CAAC;IACD,YAAmB,MAAmB;QACpC,KAAK,CAAC,eAAe,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC;QAD/B,WAAM,GAAN,MAAM,CAAa;IAEtC,CAAC;CACF"}

package/dist/generators.d.ts

@@ -0,0 +1,6 @@
+import { DartSchemaGenerator } from './DartSchemaGenerator.js';
+import { JsSchemaGenerator } from './JsSchemaGenerator.js';
+export declare const schemaGenerators: {
+    js: JsSchemaGenerator;
+    dart: DartSchemaGenerator;
+};

package/dist/generators.js

@@ -0,0 +1,7 @@
+import { DartSchemaGenerator } from './DartSchemaGenerator.js';
+import { JsSchemaGenerator } from './JsSchemaGenerator.js';
+export const schemaGenerators = {
+    js: new JsSchemaGenerator(),
+    dart: new DartSchemaGenerator()
+};
+//# sourceMappingURL=generators.js.map

package/dist/generators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generators.js","sourceRoot":"","sources":["../src/generators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAE3D,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,EAAE,EAAE,IAAI,iBAAiB,EAAE;IAC3B,IAAI,EAAE,IAAI,mBAAmB,EAAE;CAChC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,19 @@
+export * from './errors.js';
+export * from './IdSequence.js';
+export * from './SourceTableInterface.js';
+export * from './sql_filters.js';
+export * from './sql_functions.js';
+export * from './SqlSyncRules.js';
+export * from './TablePattern.js';
+export * from './types.js';
+export * from './utils.js';
+export * from './SqlParameterQuery.js';
+export * from './json_schema.js';
+export * from './StaticSchema.js';
+export * from './ExpressionType.js';
+export * from './SchemaGenerator.js';
+export * from './DartSchemaGenerator.js';
+export * from './JsSchemaGenerator.js';
+export * from './generators.js';
+export * from './SqlDataQuery.js';
+export * from './request_functions.js';

package/dist/index.js

@@ -0,0 +1,20 @@
+export * from './errors.js';
+export * from './IdSequence.js';
+export * from './SourceTableInterface.js';
+export * from './sql_filters.js';
+export * from './sql_functions.js';
+export * from './SqlSyncRules.js';
+export * from './TablePattern.js';
+export * from './types.js';
+export * from './utils.js';
+export * from './SqlParameterQuery.js';
+export * from './json_schema.js';
+export * from './StaticSchema.js';
+export * from './ExpressionType.js';
+export * from './SchemaGenerator.js';
+export * from './DartSchemaGenerator.js';
+export * from './JsSchemaGenerator.js';
+export * from './generators.js';
+export * from './SqlDataQuery.js';
+export * from './request_functions.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,wBAAwB,CAAC;AACvC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,0BAA0B,CAAC;AACzC,cAAc,wBAAwB,CAAC;AACvC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC"}

package/dist/json_schema.d.ts

@@ -0,0 +1,3 @@
+import ajvModule from 'ajv';
+export declare const syncRulesSchema: ajvModule.Schema;
+export declare const validateSyncRulesSchema: any;

package/dist/json_schema.js

@@ -0,0 +1,52 @@
+import ajvModule from 'ajv';
+// Hack to make this work both in NodeJS and a browser
+const Ajv = ajvModule.default ?? ajvModule;
+const ajv = new Ajv({ allErrors: true, verbose: true });
+export const syncRulesSchema = {
+    type: 'object',
+    properties: {
+        bucket_definitions: {
+            type: 'object',
+            description: 'List of bucket definitions',
+            examples: [{ global: { data: 'select * from mytable' } }],
+            patternProperties: {
+                '.*': {
+                    type: 'object',
+                    required: ['data'],
+                    examples: [{ data: ['select * from mytable'] }],
+                    properties: {
+                        accept_potentially_dangerous_queries: {
+                            description: 'If true, disables warnings on potentially dangerous queries',
+                            type: 'boolean'
+                        },
+                        parameters: {
+                            description: 'Parameter query(ies)',
+                            anyOf: [
+                                { type: 'string', description: 'Parameter query' },
+                                {
+                                    type: 'array',
+                                    description: 'Parameter queries',
+                                    items: {
+                                        type: 'string'
+                                    }
+                                }
+                            ]
+                        },
+                        data: {
+                            type: 'array',
+                            description: 'Data queries',
+                            items: {
+                                type: 'string'
+                            }
+                        }
+                    },
+                    additionalProperties: false
+                }
+            }
+        }
+    },
+    required: ['bucket_definitions'],
+    additionalProperties: false
+};
+export const validateSyncRulesSchema = ajv.compile(syncRulesSchema);
+//# sourceMappingURL=json_schema.js.map

package/dist/json_schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json_schema.js","sourceRoot":"","sources":["../src/json_schema.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,KAAK,CAAC;AAC5B,sDAAsD;AACtD,MAAM,GAAG,GAAG,SAAS,CAAC,OAAO,IAAI,SAAS,CAAC;AAC3C,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;AAExD,MAAM,CAAC,MAAM,eAAe,GAAqB;IAC/C,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,kBAAkB,EAAE;YAClB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,4BAA4B;YACzC,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,uBAAuB,EAAE,EAAE,CAAC;YACzD,iBAAiB,EAAE;gBACjB,IAAI,EAAE;oBACJ,IAAI,EAAE,QAAQ;oBACd,QAAQ,EAAE,CAAC,MAAM,CAAC;oBAClB,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,uBAAuB,CAAC,EAAE,CAAC;oBAC/C,UAAU,EAAE;wBACV,oCAAoC,EAAE;4BACpC,WAAW,EAAE,6DAA6D;4BAC1E,IAAI,EAAE,SAAS;yBAChB;wBACD,UAAU,EAAE;4BACV,WAAW,EAAE,sBAAsB;4BACnC,KAAK,EAAE;gCACL,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,iBAAiB,EAAE;gCAClD;oCACE,IAAI,EAAE,OAAO;oCACb,WAAW,EAAE,mBAAmB;oCAChC,KAAK,EAAE;wCACL,IAAI,EAAE,QAAQ;qCACf;iCACF;6BACF;yBACF;wBACD,IAAI,EAAE;4BACJ,IAAI,EAAE,OAAO;4BACb,WAAW,EAAE,cAAc;4BAC3B,KAAK,EAAE;gCACL,IAAI,EAAE,QAAQ;6BACf;yBACF;qBACF;oBACD,oBAAoB,EAAE,KAAK;iBAC5B;aACF;SACF;KACF;IACD,QAAQ,EAAE,CAAC,oBAAoB,CAAC;IAChC,oBAAoB,EAAE,KAAK;CACnB,CAAC;AAEX,MAAM,CAAC,MAAM,uBAAuB,GAAQ,GAAG,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC"}

package/dist/request_functions.d.ts

@@ -0,0 +1,17 @@
+import { ExpressionType } from './ExpressionType.js';
+import { RequestParameters, SqliteValue } from './types.js';
+export interface SqlParameterFunction {
+    readonly debugName: string;
+    call: (parameters: RequestParameters) => SqliteValue;
+    getReturnType(): ExpressionType;
+    /** request.user_id(), request.jwt(), token_parameters.* */
+    usesAuthenticatedRequestParameters: boolean;
+    /** request.parameters(), user_parameters.* */
+    usesUnauthenticatedRequestParameters: boolean;
+}
+export declare const REQUEST_FUNCTIONS_NAMED: {
+    parameters: SqlParameterFunction;
+    jwt: SqlParameterFunction;
+    user_id: SqlParameterFunction;
+};
+export declare const REQUEST_FUNCTIONS: Record<string, SqlParameterFunction>;

package/dist/request_functions.js

@@ -0,0 +1,41 @@
+import { ExpressionType } from './ExpressionType.js';
+const request_parameters = {
+    debugName: 'request.parameters',
+    call(parameters) {
+        return parameters.raw_user_parameters;
+    },
+    getReturnType() {
+        return ExpressionType.TEXT;
+    },
+    usesAuthenticatedRequestParameters: false,
+    usesUnauthenticatedRequestParameters: true
+};
+const request_jwt = {
+    debugName: 'request.jwt',
+    call(parameters) {
+        return parameters.raw_token_payload;
+    },
+    getReturnType() {
+        return ExpressionType.TEXT;
+    },
+    usesAuthenticatedRequestParameters: true,
+    usesUnauthenticatedRequestParameters: false
+};
+const request_user_id = {
+    debugName: 'request.user_id',
+    call(parameters) {
+        return parameters.user_id;
+    },
+    getReturnType() {
+        return ExpressionType.TEXT;
+    },
+    usesAuthenticatedRequestParameters: true,
+    usesUnauthenticatedRequestParameters: false
+};
+export const REQUEST_FUNCTIONS_NAMED = {
+    parameters: request_parameters,
+    jwt: request_jwt,
+    user_id: request_user_id
+};
+export const REQUEST_FUNCTIONS = REQUEST_FUNCTIONS_NAMED;
+//# sourceMappingURL=request_functions.js.map

package/dist/request_functions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request_functions.js","sourceRoot":"","sources":["../src/request_functions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAarD,MAAM,kBAAkB,GAAyB;IAC/C,SAAS,EAAE,oBAAoB;IAC/B,IAAI,CAAC,UAA6B;QAChC,OAAO,UAAU,CAAC,mBAAmB,CAAC;IACxC,CAAC;IACD,aAAa;QACX,OAAO,cAAc,CAAC,IAAI,CAAC;IAC7B,CAAC;IACD,kCAAkC,EAAE,KAAK;IACzC,oCAAoC,EAAE,IAAI;CAC3C,CAAC;AAEF,MAAM,WAAW,GAAyB;IACxC,SAAS,EAAE,aAAa;IACxB,IAAI,CAAC,UAA6B;QAChC,OAAO,UAAU,CAAC,iBAAiB,CAAC;IACtC,CAAC;IACD,aAAa;QACX,OAAO,cAAc,CAAC,IAAI,CAAC;IAC7B,CAAC;IACD,kCAAkC,EAAE,IAAI;IACxC,oCAAoC,EAAE,KAAK;CAC5C,CAAC;AAEF,MAAM,eAAe,GAAyB;IAC5C,SAAS,EAAE,iBAAiB;IAC5B,IAAI,CAAC,UAA6B;QAChC,OAAO,UAAU,CAAC,OAAO,CAAC;IAC5B,CAAC;IACD,aAAa;QACX,OAAO,cAAc,CAAC,IAAI,CAAC;IAC7B,CAAC;IACD,kCAAkC,EAAE,IAAI;IACxC,oCAAoC,EAAE,KAAK;CAC5C,CAAC;AAEF,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,UAAU,EAAE,kBAAkB;IAC9B,GAAG,EAAE,WAAW;IAChB,OAAO,EAAE,eAAe;CACzB,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAyC,uBAAuB,CAAC"}