@takaro/db 0.0.0-next.09a7ca1

package/dist/queryBuilder.js

@@ -0,0 +1,224 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { IsEnum, IsNumber, IsOptional, IsString } from 'class-validator';
+import { errors } from '@takaro/util';
+import { getKnex, isDbAvailable } from './knex.js';
+export class ITakaroQuery {
+}
+__decorate([
+    IsOptional(),
+    __metadata("design:type", Object)
+], ITakaroQuery.prototype, "filters", void 0);
+__decorate([
+    IsOptional(),
+    __metadata("design:type", Object)
+], ITakaroQuery.prototype, "search", void 0);
+__decorate([
+    IsOptional(),
+    __metadata("design:type", Object)
+], ITakaroQuery.prototype, "greaterThan", void 0);
+__decorate([
+    IsOptional(),
+    __metadata("design:type", Object)
+], ITakaroQuery.prototype, "lessThan", void 0);
+__decorate([
+    IsOptional(),
+    IsNumber(),
+    __metadata("design:type", Number)
+], ITakaroQuery.prototype, "page", void 0);
+__decorate([
+    IsOptional(),
+    IsNumber(),
+    __metadata("design:type", Number)
+], ITakaroQuery.prototype, "limit", void 0);
+__decorate([
+    IsOptional(),
+    IsString(),
+    __metadata("design:type", String)
+], ITakaroQuery.prototype, "sortBy", void 0);
+__decorate([
+    IsOptional(),
+    IsString(),
+    IsEnum(['asc', 'desc']),
+    __metadata("design:type", String)
+], ITakaroQuery.prototype, "sortDirection", void 0);
+__decorate([
+    IsOptional(),
+    IsString({ each: true }),
+    __metadata("design:type", Array)
+], ITakaroQuery.prototype, "extend", void 0);
+export var SortDirection;
+(function (SortDirection) {
+    SortDirection["asc"] = "asc";
+    SortDirection["desc"] = "desc";
+})(SortDirection || (SortDirection = {}));
+const modelColumns = new Map();
+export async function populateModelColumns() {
+    if (await isDbAvailable()) {
+        const knex = await getKnex();
+        // Find all tables
+        const tables = await knex.raw("SELECT table_name FROM information_schema.tables WHERE table_schema = 'public' AND table_type = 'BASE TABLE'");
+        // For each table, store the columns
+        for (const table of tables.rows) {
+            const tableName = table.table_name;
+            const columns = await knex(tableName).columnInfo();
+            modelColumns.set(tableName, Object.keys(columns));
+        }
+    }
+}
+await populateModelColumns();
+export class QueryBuilder {
+    constructor(rawQuery = new ITakaroQuery()) {
+        this.query = JSON.parse(JSON.stringify(rawQuery));
+        this.validateArrayFilters();
+    }
+    validateArrayFilters() {
+        // Validate filters
+        if (this.query.filters) {
+            for (const [key, value] of Object.entries(this.query.filters)) {
+                if (value !== null && value !== undefined && !Array.isArray(value) && typeof value !== 'boolean') {
+                    throw new errors.BadRequestError(`Filter values must be arrays or boolean. Found invalid value for '${key}': '${value}'. Example: { ${key}: ["${value}"] }`);
+                }
+            }
+        }
+        // Validate search
+        if (this.query.search) {
+            for (const [key, value] of Object.entries(this.query.search)) {
+                if (value !== null && value !== undefined && !Array.isArray(value) && typeof value !== 'boolean') {
+                    throw new errors.BadRequestError(`Search values must be arrays or boolean. Found invalid value for '${key}': '${value}'. Example: { ${key}: ["${value}"] }`);
+                }
+            }
+        }
+    }
+    /**
+     * Our custom query builder can only handle columns that exist in the table
+     * However, we might want to do complex/relational logic in higher layers
+     * To make sure we don't error out here, we filter out any columns that don't exist in the current table
+     */
+    cleanQueryObject(tableName) {
+        const columns = modelColumns.get(tableName) ?? [];
+        for (const key in this.query.filters) {
+            if (Object.prototype.hasOwnProperty.call(this.query.filters, key)) {
+                if (!columns.includes(key)) {
+                    if (this.query.filters) {
+                        // Preserve boolean values, only clear arrays
+                        if (typeof this.query.filters[key] !== 'boolean') {
+                            this.query.filters[key] = [];
+                        }
+                    }
+                }
+            }
+        }
+        for (const key in this.query.search) {
+            if (Object.prototype.hasOwnProperty.call(this.query.search, key)) {
+                if (!columns.includes(key)) {
+                    if (this.query.search) {
+                        // Preserve boolean values, only clear arrays
+                        if (typeof this.query.search[key] !== 'boolean') {
+                            this.query.search[key] = [];
+                        }
+                    }
+                }
+            }
+        }
+        return this.query;
+    }
+    build(queryBuilder) {
+        const tableName = queryBuilder.modelClass().tableName;
+        this.cleanQueryObject(tableName);
+        const pagination = this.pagination();
+        const sorting = this.sorting();
+        let qry = queryBuilder.page(pagination.page, pagination.limit).orderBy(sorting.sortBy, sorting.sortDirection);
+        qry = this.filters(tableName, qry);
+        qry = this.greaterThan(tableName, qry);
+        qry = this.lessThan(tableName, qry);
+        if (this.query.search) {
+            qry.where((builder) => {
+                for (const search in this.query.search) {
+                    if (Object.prototype.hasOwnProperty.call(this.query.search, search)) {
+                        const searchVal = this.query.search[search];
+                        if (Array.isArray(searchVal)) {
+                            searchVal.forEach((val) => {
+                                if (val) {
+                                    builder.orWhere(`${tableName}.${search}`, 'ilike', `%${val}%`);
+                                }
+                            });
+                        }
+                    }
+                }
+            });
+        }
+        for (const extend of this.query.extend ?? []) {
+            qry.withGraphFetched(extend);
+        }
+        return qry;
+    }
+    filters(tableName, query) {
+        for (const filter in this.query.filters) {
+            if (Object.prototype.hasOwnProperty.call(this.query.filters, filter)) {
+                const searchVal = this.query.filters[filter];
+                if (typeof searchVal === 'boolean') {
+                    query.where(`${tableName}.${filter}`, searchVal);
+                }
+                else if (searchVal && Array.isArray(searchVal)) {
+                    if (searchVal.includes('null')) {
+                        query.whereNull(`${tableName}.${filter}`);
+                        continue;
+                    }
+                    if (searchVal.length) {
+                        query.whereIn(`${tableName}.${filter}`, searchVal.filter(Boolean));
+                    }
+                }
+            }
+        }
+        return query;
+    }
+    greaterThan(tableName, query) {
+        for (const filter in this.query.greaterThan) {
+            if (Object.prototype.hasOwnProperty.call(this.query.greaterThan, filter)) {
+                const searchVal = this.query.greaterThan[filter];
+                if (searchVal) {
+                    query.where(`${tableName}.${filter}`, '>=', searchVal);
+                }
+            }
+        }
+        return query;
+    }
+    lessThan(tableName, query) {
+        for (const filter in this.query.lessThan) {
+            if (Object.prototype.hasOwnProperty.call(this.query.lessThan, filter)) {
+                const searchVal = this.query.lessThan[filter];
+                if (searchVal) {
+                    query.where(`${tableName}.${filter}`, '<=', searchVal);
+                }
+            }
+        }
+        return query;
+    }
+    sorting() {
+        if (!this.query.sortBy) {
+            return {
+                sortBy: 'id',
+                sortDirection: SortDirection.asc,
+            };
+        }
+        return {
+            sortBy: this.query.sortBy,
+            sortDirection: this.query.sortDirection ?? SortDirection.asc,
+        };
+    }
+    pagination() {
+        return {
+            page: this.query.page ?? 0,
+            limit: this.query.limit ?? 100,
+        };
+    }
+}
+//# sourceMappingURL=queryBuilder.js.map

package/dist/queryBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryBuilder.js","sourceRoot":"","sources":["../src/queryBuilder.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AACzE,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAStC,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAEnD,MAAM,OAAO,YAAY;CAyCxB;AAvCC;IADC,UAAU,EAAE;;6CAGX;AAGF;IADC,UAAU,EAAE;;4CAGX;AAGF;IADC,UAAU,EAAE;;iDAGX;AAGF;IADC,UAAU,EAAE;;8CAGX;AAIF;IAFC,UAAU,EAAE;IACZ,QAAQ,EAAE;;0CACG;AAId;IAFC,UAAU,EAAE;IACZ,QAAQ,EAAE;;2CACI;AAIf;IAFC,UAAU,EAAE;IACZ,QAAQ,EAAE;;4CACK;AAKhB;IAHC,UAAU,EAAE;IACZ,QAAQ,EAAE;IACV,MAAM,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;;mDACM;AAI9B;IAFC,UAAU,EAAE;IACZ,QAAQ,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;;4CACP;AAGpB,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,4BAAW,CAAA;IACX,8BAAa,CAAA;AACf,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB;AAED,MAAM,YAAY,GAAG,IAAI,GAAG,EAAoB,CAAC;AAEjD,MAAM,CAAC,KAAK,UAAU,oBAAoB;IACxC,IAAI,MAAM,aAAa,EAAE,EAAE,CAAC;QAC1B,MAAM,IAAI,GAAG,MAAM,OAAO,EAAE,CAAC;QAC7B,kBAAkB;QAClB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAC3B,8GAA8G,CAC/G,CAAC;QACF,oCAAoC;QACpC,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;YAChC,MAAM,SAAS,GAAG,KAAK,CAAC,UAAU,CAAC;YACnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,CAAC;YACnD,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;AACH,CAAC;AAED,MAAM,oBAAoB,EAAE,CAAC;AAE7B,MAAM,OAAO,YAAY;IAEvB,YAAY,WAAoC,IAAI,YAAY,EAAE;QAChE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;QAClD,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAC9B,CAAC;IAEO,oBAAoB;QAC1B,mBAAmB;QACnB,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YACvB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC9D,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;oBACjG,MAAM,IAAI,MAAM,CAAC,eAAe,CAC9B,qEAAqE,GAAG,OAAO,KAAK,iBAAiB,GAAG,OAAO,KAAK,MAAM,CAC3H,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;QAED,kBAAkB;QAClB,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YACtB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC7D,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;oBACjG,MAAM,IAAI,MAAM,CAAC,eAAe,CAC9B,qEAAqE,GAAG,OAAO,KAAK,iBAAiB,GAAG,OAAO,KAAK,MAAM,CAC3H,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;OAIG;IACK,gBAAgB,CAAC,SAAiB;QACxC,MAAM,OAAO,GAAG,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;QAElD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YACrC,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE,CAAC;gBAClE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;oBAC3B,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;wBACvB,6CAA6C;wBAC7C,IAAI,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE,CAAC;4BACjD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;wBAC/B,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YACpC,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;gBACjE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;oBAC3B,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;wBACtB,6CAA6C;wBAC7C,IAAI,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE,CAAC;4BAChD,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;wBAC9B,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,KAAK,CAAC,YAAmD;QACvD,MAAM,SAAS,GAAG,YAAY,CAAC,UAAU,EAAE,CAAC,SAAS,CAAC;QACtD,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;QAEjC,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QACrC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;QAE/B,IAAI,GAAG,GAAG,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;QAE9G,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;QACnC,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;QACvC,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;QAEpC,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YACtB,GAAG,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,EAAE;gBACpB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;oBACvC,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;wBACpE,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;wBAC5C,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;4BAC7B,SAAS,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gCACxB,IAAI,GAAG,EAAE,CAAC;oCACR,OAAO,CAAC,OAAO,CAAC,GAAG,SAAS,IAAI,MAAM,EAAE,EAAE,OAAO,EAAE,IAAI,GAAG,GAAG,CAAC,CAAC;gCACjE,CAAC;4BACH,CAAC,CAAC,CAAC;wBACL,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;QAED,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,EAAE,EAAE,CAAC;YAC7C,GAAG,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAC/B,CAAC;QAED,OAAO,GAAG,CAAC;IACb,CAAC;IAEO,OAAO,CACb,SAAiB,EACjB,KAAgD;QAEhD,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YACxC,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC;gBACrE,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;gBAE7C,IAAI,OAAO,SAAS,KAAK,SAAS,EAAE,CAAC;oBACnC,KAAK,CAAC,KAAK,CAAC,GAAG,SAAS,IAAI,MAAM,EAAE,EAAE,SAAS,CAAC,CAAC;gBACnD,CAAC;qBAAM,IAAI,SAAS,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;oBACjD,IAAI,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;wBAC/B,KAAK,CAAC,SAAS,CAAC,GAAG,SAAS,IAAI,MAAM,EAAE,CAAC,CAAC;wBAC1C,SAAS;oBACX,CAAC;oBAED,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC;wBACrB,KAAK,CAAC,OAAO,CAAC,GAAG,SAAS,IAAI,MAAM,EAAE,EAAE,SAAS,CAAC,MAAM,CAAC,OAAO,CAA+B,CAAC,CAAC;oBACnG,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,WAAW,CACjB,SAAiB,EACjB,KAAgD;QAEhD,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;YAC5C,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE,CAAC;gBACzE,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;gBACjD,IAAI,SAAS,EAAE,CAAC;oBACd,KAAK,CAAC,KAAK,CAAC,GAAG,SAAS,IAAI,MAAM,EAAE,EAAE,IAAI,EAAE,SAAkD,CAAC,CAAC;gBAClG,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,QAAQ,CACd,SAAiB,EACjB,KAAgD;QAEhD,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;YACzC,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,CAAC;gBACtE,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;gBAC9C,IAAI,SAAS,EAAE,CAAC;oBACd,KAAK,CAAC,KAAK,CAAC,GAAG,SAAS,IAAI,MAAM,EAAE,EAAE,IAAI,EAAE,SAAkD,CAAC,CAAC;gBAClG,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,OAAO;QACb,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YACvB,OAAO;gBACL,MAAM,EAAE,IAAI;gBACZ,aAAa,EAAE,aAAa,CAAC,GAAG;aACjC,CAAC;QACJ,CAAC;QACD,OAAO;YACL,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM;YACzB,aAAa,EAAE,IAAI,CAAC,KAAK,CAAC,aAAa,IAAI,aAAa,CAAC,GAAG;SAC7D,CAAC;IACJ,CAAC;IAEO,UAAU;QAChB,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC;YAC1B,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,GAAG;SAC/B,CAAC;IACJ,CAAC;CACF"}

package/dist/redis.d.ts

@@ -0,0 +1,21 @@
+import { createClient, RedisClientOptions } from 'redis';
+export type RedisClient = ReturnType<typeof createClient>;
+declare class RedisClass {
+    private log;
+    private clients;
+    /**
+     * Get a Redis client from the cache, or create a new one.
+     * The client will already be connected.
+     * @param name Name for the client, used to cache the client.
+     * @param extra Any extra Redis options to pass to the client.
+     * @returns
+     */
+    getClient(name: string, extra?: RedisClientOptions): Promise<RedisClient>;
+    /**
+     * Disconnect all clients and clear the cache.
+     */
+    destroy(): Promise<void>;
+}
+export declare const Redis: RedisClass;
+export {};
+//# sourceMappingURL=redis.d.ts.map

package/dist/redis.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis.d.ts","sourceRoot":"","sources":["../src/redis.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAIzD,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;AAE1D,cAAM,UAAU;IACd,OAAO,CAAC,GAAG,CAAmB;IAE9B,OAAO,CAAC,OAAO,CAAkC;IAEjD;;;;;;OAMG;IACG,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,GAAE,kBAAuB,GAAG,OAAO,CAAC,WAAW,CAAC;IA6BnF;;OAEG;IACG,OAAO;CAMd;AAED,eAAO,MAAM,KAAK,YAAmB,CAAC"}

package/dist/redis.js

@@ -0,0 +1,50 @@
+import { createClient } from 'redis';
+import { config } from './config.js';
+import { logger, health } from '@takaro/util';
+class RedisClass {
+    constructor() {
+        this.log = logger('redis');
+        this.clients = new Map();
+    }
+    /**
+     * Get a Redis client from the cache, or create a new one.
+     * The client will already be connected.
+     * @param name Name for the client, used to cache the client.
+     * @param extra Any extra Redis options to pass to the client.
+     * @returns
+     */
+    async getClient(name, extra = {}) {
+        const normalizedName = name.toLowerCase().replaceAll(/[^a-z0-9]/g, '_');
+        const cachedClient = this.clients.get(normalizedName);
+        if (cachedClient)
+            return cachedClient;
+        this.log.debug(`Creating new Redis client for ${normalizedName}`);
+        const client = createClient({
+            name: normalizedName,
+            username: config.get('redis.username'),
+            password: config.get('redis.password'),
+            socket: {
+                host: config.get('redis.host'),
+                port: config.get('redis.port'),
+            },
+            ...extra,
+        });
+        await client.connect();
+        this.clients.set(normalizedName, client);
+        health.registerHook(normalizedName, async () => {
+            await client.ping();
+        });
+        return client;
+    }
+    /**
+     * Disconnect all clients and clear the cache.
+     */
+    async destroy() {
+        for (const [name, client] of this.clients.entries()) {
+            this.log.debug(`Disconnecting Redis client ${name}`);
+            await client.disconnect();
+        }
+    }
+}
+export const Redis = new RedisClass();
+//# sourceMappingURL=redis.js.map

package/dist/redis.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis.js","sourceRoot":"","sources":["../src/redis.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAsB,MAAM,OAAO,CAAC;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAI9C,MAAM,UAAU;IAAhB;QACU,QAAG,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;QAEtB,YAAO,GAAG,IAAI,GAAG,EAAuB,CAAC;IA+CnD,CAAC;IA7CC;;;;;;OAMG;IACH,KAAK,CAAC,SAAS,CAAC,IAAY,EAAE,QAA4B,EAAE;QAC1D,MAAM,cAAc,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;QACxE,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAEtD,IAAI,YAAY;YAAE,OAAO,YAAY,CAAC;QAEtC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,iCAAiC,cAAc,EAAE,CAAC,CAAC;QAElE,MAAM,MAAM,GAAG,YAAY,CAAC;YAC1B,IAAI,EAAE,cAAc;YACpB,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,gBAAgB,CAAC;YACtC,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,gBAAgB,CAAC;YACtC,MAAM,EAAE;gBACN,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC;gBAC9B,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC;aAC/B;YACD,GAAG,KAAK;SACT,CAAC,CAAC;QAEH,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;QACvB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;QAEzC,MAAM,CAAC,YAAY,CAAC,cAAc,EAAE,KAAK,IAAI,EAAE;YAC7C,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;QACtB,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO;QACX,KAAK,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;YACpD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,8BAA8B,IAAI,EAAE,CAAC,CAAC;YACrD,MAAM,MAAM,CAAC,UAAU,EAAE,CAAC;QAC5B,CAAC;IACH,CAAC;CACF;AAED,MAAM,CAAC,MAAM,KAAK,GAAG,IAAI,UAAU,EAAE,CAAC"}

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@takaro/db",
+  "description": "An opinionated data layer",
+  "version": "0.0.0-next.09a7ca1",
+  "author": "",
+  "dependencies": {
+    "class-validator": "0.14.3",
+    "knex": "3.1.0",
+    "ms": "2.1.3",
+    "objection": "3.1.5",
+    "redis": "4.7.0"
+  },
+  "keywords": [],
+  "license": "ISC",
+  "main": "dist/main.js",
+  "peerDependencies": {
+    "@takaro/config": "*",
+    "@takaro/util": "*"
+  },
+  "scripts": {
+    "build": "tsc -p ./tsconfig.build.json",
+    "migrate:create": "run(){ touch ./src/migrations/sql/$(date -u +\"%Y%m%d%H%M%S\")-$1.ts; }; run",
+    "start:dev": ":"
+  },
+  "type": "module",
+  "types": "dist/main.d.ts"
+}

package/src/TakaroModel.ts

@@ -0,0 +1,33 @@
+import Objection, { Model } from 'objection';
+
+export class NOT_DOMAIN_SCOPED_TakaroModel extends Model {
+  id: string;
+  createdAt: string;
+  updatedAt: string;
+
+  static get idColumn() {
+    return 'id';
+  }
+
+  $beforeInsert() {
+    this.createdAt = new Date().toISOString();
+  }
+
+  $beforeUpdate() {
+    this.updatedAt = new Date().toISOString();
+  }
+}
+
+export class TakaroModel extends NOT_DOMAIN_SCOPED_TakaroModel {
+  domain: string;
+
+  static get modifiers() {
+    return {
+      domainScoped(query: Objection.QueryBuilder<Model>, domainId: string) {
+        const tableName = query.modelClass().tableName;
+        if (!domainId) throw new Error('Domain ID is required for domainScoped modifier');
+        query.where(`${tableName}.domain`, domainId);
+      },
+    };
+  }
+}

package/src/__tests__/encryption.integration.test.ts

@@ -0,0 +1,57 @@
+import { compareHashed, decrypt, encrypt, hash } from '../encryption.js';
+import { expect } from '@takaro/test';
+import { getKnex } from '../knex.js';
+import { describe, before, it } from 'node:test';
+
+describe('Database encryption', () => {
+  before(async () => {
+    const knex = await getKnex();
+    await knex.raw('CREATE EXTENSION IF NOT EXISTS pgcrypto;');
+  });
+
+  describe('Encryption', () => {
+    it('Can encrypt a simple string', async () => {
+      const encrypted = await encrypt('test');
+      expect(encrypted).to.not.eq('test');
+    });
+
+    it('Can decrypt a simple string', async () => {
+      const encrypted = await encrypt('test');
+      const decrypted = await decrypt(encrypted);
+      expect(decrypted).to.eq('test');
+    });
+
+    it('Can handle complex JSON structures', async () => {
+      const encrypted = await encrypt(JSON.stringify({ foo: 'bar' }));
+      const decrypted = await decrypt(encrypted);
+      expect(decrypted).to.eq(JSON.stringify({ foo: 'bar' }));
+    });
+
+    it('Can handle very long values', async () => {
+      const longValue = 'a'.repeat(10000);
+      const encrypted = await encrypt(longValue);
+      const decrypted = await decrypt(encrypted);
+      expect(decrypted).to.eq(longValue);
+    });
+  });
+
+  describe('Hashing', async () => {
+    it('Can hash a simple string', async () => {
+      const hashed = await hash('test');
+      expect(hashed).to.not.eq('test');
+      expect(hashed).to.match(/^\$2a\$06\$/);
+    });
+
+    it('Can compare a simple string', async () => {
+      const hashed = await hash('test');
+      const result = await compareHashed('test', hashed);
+      expect(result).to.eq(true);
+    });
+
+    it('Returns false when comparing different strings', async () => {
+      const hashed = await hash('test');
+      const result = await compareHashed('test2', hashed);
+      expect(result).to.eq(false);
+    });
+  });
+});

package/src/__tests__/queryBuilder.integration.test.ts

@@ -0,0 +1,208 @@
+import { disconnectKnex, getKnex } from '../knex.js';
+import { populateModelColumns, QueryBuilder, SortDirection } from '../queryBuilder.js';
+import { expect } from '@takaro/test';
+import { TakaroModel } from '../TakaroModel.js';
+import { Model } from 'objection';
+import { sleep } from '@takaro/util';
+import { describe, beforeEach, afterEach, it } from 'node:test';
+
+const TEST_TABLE_USERS_NAME = 'test_users';
+const TEST_TABLE_POSTS_NAME = 'test_posts';
+
+class TestPostModel extends TakaroModel {
+  static tableName = TEST_TABLE_POSTS_NAME;
+  title!: string;
+  userId!: string;
+
+  static relationMappings = {
+    author: {
+      relation: Model.HasOneRelation,
+      modelClass: () => TestUserModel,
+      join: {
+        from: `${TEST_TABLE_POSTS_NAME}.userId`,
+        to: `${TEST_TABLE_USERS_NAME}.id`,
+      },
+    },
+  };
+}
+
+class TestUserModel extends TakaroModel {
+  static tableName = TEST_TABLE_USERS_NAME;
+  name!: string;
+
+  static relationMappings = {
+    posts: {
+      relation: Model.HasManyRelation,
+      modelClass: TestPostModel,
+      join: {
+        from: `${TEST_TABLE_USERS_NAME}.id`,
+        to: `${TEST_TABLE_POSTS_NAME}.userId`,
+      },
+    },
+  };
+}
+
+describe('QueryBuilder', () => {
+  beforeEach(async () => {
+    const knex = await getKnex();
+    await knex.schema.dropTableIfExists(TEST_TABLE_USERS_NAME);
+    await knex.schema.dropTableIfExists(TEST_TABLE_POSTS_NAME);
+    await knex.schema.createTable(TEST_TABLE_USERS_NAME, (table) => {
+      table.timestamps(true, true, true);
+      table.uuid('id').primary().defaultTo(knex.raw('gen_random_uuid ()'));
+      table.string('name');
+    });
+    await knex.schema.createTable(TEST_TABLE_POSTS_NAME, (table) => {
+      table.timestamps(true, true, true);
+      table.uuid('id').primary().defaultTo(knex.raw('gen_random_uuid ()'));
+      table.string('title');
+      table.uuid('userId');
+    });
+
+    TestUserModel.knex(knex);
+    TestPostModel.knex(knex);
+
+    await populateModelColumns();
+  });
+
+  afterEach(async () => {
+    const knex = await getKnex();
+    await knex.schema.dropTableIfExists(TEST_TABLE_USERS_NAME);
+    await disconnectKnex();
+  });
+
+  it('Can create basic filters', async () => {
+    await TestUserModel.query().insert({ name: 'test1' });
+    await TestUserModel.query().insert({ name: 'test2' });
+    await TestUserModel.query().insert({ name: 'test3' });
+
+    const res = await new QueryBuilder<TestUserModel, TestUserModel>({
+      filters: { name: ['test2'] },
+    }).build(TestUserModel.query());
+
+    expect(res.results).to.have.lengthOf(1);
+    expect(res.results[0].name).to.equal('test2');
+  });
+
+  it('Can filter based on multiple values', async () => {
+    await TestUserModel.query().insert({ name: 'test1' });
+    await TestUserModel.query().insert({ name: 'test2' });
+    await TestUserModel.query().insert({ name: 'test3' });
+
+    const res = await new QueryBuilder<TestUserModel, TestUserModel>({
+      filters: { name: ['test2', 'test3'] },
+      sortBy: 'name',
+    }).build(TestUserModel.query());
+
+    expect(res.results).to.have.lengthOf(2);
+    expect(res.results[0].name).to.equal('test2');
+    expect(res.results[1].name).to.equal('test3');
+  });
+
+  it('Can do paging', async () => {
+    const totalTestRecords = 100;
+
+    for (let i = 0; i < totalTestRecords; i++) {
+      const number = i.toString().padStart(3, '0');
+      await TestUserModel.query().insert({ name: `test${number}` });
+    }
+
+    const res = await new QueryBuilder<TestUserModel, TestUserModel>({
+      page: 2,
+      limit: 10,
+      sortBy: 'name',
+      sortDirection: SortDirection.asc,
+    }).build(TestUserModel.query());
+
+    expect(res.results).to.have.lengthOf(10);
+    expect(res.results[0].name).to.equal('test020');
+    expect(res.total).to.equal(totalTestRecords);
+  });
+
+  it('Can do sorting', async () => {
+    await TestUserModel.query().insert({ name: 'test1' });
+    await TestUserModel.query().insert({ name: 'test2' });
+    await TestUserModel.query().insert({ name: 'test3' });
+
+    const res = await new QueryBuilder<TestUserModel, TestUserModel>({
+      sortBy: 'name',
+      sortDirection: SortDirection.desc,
+    }).build(TestUserModel.query());
+
+    expect(res.results).to.have.lengthOf(3);
+    expect(res.results[0].name).to.equal('test3');
+  });
+
+  it('Can do extending', async () => {
+    const user = await TestUserModel.query().insert({ name: 'test1' });
+    await TestPostModel.query().insert({ title: 'test1', userId: user.id });
+
+    const res = await new QueryBuilder<
+      TestPostModel & { author?: TestUserModel },
+      TestPostModel & { author?: TestUserModel }
+    >({ extend: ['author'] }).build(TestPostModel.query());
+
+    expect(res.results).to.have.lengthOf(1);
+    expect(res.results[0].author?.name).to.equal('test1');
+  });
+
+  it('Can do partial matching of strings', async () => {
+    await TestUserModel.query().insert({ name: 'test1' });
+    await TestUserModel.query().insert({ name: 'test2' });
+    await TestUserModel.query().insert({ name: 'test3' });
+
+    const res = await new QueryBuilder<TestUserModel, TestUserModel>({
+      search: {
+        name: ['test'],
+      },
+    }).build(TestUserModel.query());
+
+    expect(res.results).to.have.lengthOf(3);
+
+    const res2 = await new QueryBuilder<TestUserModel, TestUserModel>({
+      search: {
+        name: ['1'],
+      },
+    }).build(TestUserModel.query());
+
+    expect(res2.results).to.have.lengthOf(1);
+  });
+
+  it('Can search for multiple values, ORs them', async () => {
+    await TestUserModel.query().insert({ name: 'test1' });
+    await TestUserModel.query().insert({ name: 'test2' });
+    await TestUserModel.query().insert({ name: 'test3' });
+
+    const res = await new QueryBuilder<TestUserModel, TestUserModel>({
+      search: {
+        name: ['st1', 'st2'],
+      },
+    }).build(TestUserModel.query());
+
+    expect(res.results).to.have.lengthOf(2);
+  });
+
+  it('Can search between a date range', async () => {
+    const start = new Date();
+    await TestUserModel.query().insert({ name: 'test1' });
+    await TestUserModel.query().insert({ name: 'test2' });
+    const end = new Date();
+
+    // Quick hack to make the test pass
+    // Relying on times like this with an external DB is troublesome...
+    await sleep(250);
+
+    await TestUserModel.query().insert({ name: 'test3' });
+
+    const res = await new QueryBuilder<TestUserModel, TestUserModel>({
+      greaterThan: {
+        createdAt: start.toISOString(),
+      },
+      lessThan: {
+        createdAt: end.toISOString(),
+      },
+    }).build(TestUserModel.query());
+
+    expect(res.results).to.have.lengthOf(2);
+  });
+});