@takaro/db 0.0.9 → 0.0.11

package/dist/knex.d.ts

@@ -15,5 +15,6 @@ export declare function getKnexOptions(extra?: Record<string, unknown>): {
     };
 };
 export declare function getKnex(): Promise<KnexClient>;
+export declare function isDbAvailable(): Promise<boolean>;
 export declare function disconnectKnex(): Promise<void>;
 export {};

package/dist/knex.js

@@ -25,18 +25,20 @@ export async function getKnex() {
     log.debug('Missed knex cache, creating new client');
     const knex = createKnex(getKnexOptions());
     cachedKnex = knex;
-    health.registerHook('db', async () => {
-        try {
-            await knex.raw('SELECT 1');
-            return true;
-        }
-        catch (error) {
-            log.error(error);
-            return false;
-        }
-    });
+    health.registerHook('db', isDbAvailable);
     return cachedKnex;
 }
+export async function isDbAvailable() {
+    try {
+        const knex = await getKnex();
+        await knex.raw('SELECT 1');
+        return true;
+    }
+    catch (error) {
+        log.error(error);
+        return false;
+    }
+}
 export async function disconnectKnex() {
     if (!cachedKnex)
         return;

package/dist/knex.js.map

@@ -1 +1 @@
-{"version":3,"file":"knex.js","sourceRoot":"","sources":["../src/knex.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,MAAM,CAAC;AAC3B,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAG9C,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;AAE1B,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;AAIrC,MAAM,UAAU,cAAc,CAAC,QAAiC,EAAE;IAChE,MAAM,IAAI,GAAG;QACX,MAAM,EAAE,IAAI;QACZ,UAAU,EAAE;YACV,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC;YACjC,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC;YACjC,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC;YACjC,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC;YACzC,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC;YACzC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK;SAC5E;QACD,GAAG,KAAK;KACT,CAAC;IACF,OAAO,IAAI,CAAC;AACd,CAAC;AAED,IAAI,UAAU,GAAsB,IAAI,CAAC;AAEzC,MAAM,CAAC,KAAK,UAAU,OAAO;IAC3B,IAAI,UAAU;QAAE,OAAO,UAAU,CAAC;IAElC,GAAG,CAAC,KAAK,CAAC,wCAAwC,CAAC,CAAC;IACpD,MAAM,IAAI,GAAG,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;IAC1C,UAAU,GAAG,IAAI,CAAC;IAElB,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,IAAI,EAAE;QACnC,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAC3B,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACjB,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc;IAClC,IAAI,CAAC,UAAU;QAAE,OAAO;IACxB,MAAM,UAAU,CAAC,OAAO,EAAE,CAAC;IAC3B,UAAU,GAAG,IAAI,CAAC;IAClB,GAAG,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;AAChC,CAAC"}
+{"version":3,"file":"knex.js","sourceRoot":"","sources":["../src/knex.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,MAAM,CAAC;AAC3B,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAG9C,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;AAE1B,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;AAIrC,MAAM,UAAU,cAAc,CAAC,QAAiC,EAAE;IAChE,MAAM,IAAI,GAAG;QACX,MAAM,EAAE,IAAI;QACZ,UAAU,EAAE;YACV,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC;YACjC,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC;YACjC,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC;YACjC,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC;YACzC,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC;YACzC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK;SAC5E;QACD,GAAG,KAAK;KACT,CAAC;IACF,OAAO,IAAI,CAAC;AACd,CAAC;AAED,IAAI,UAAU,GAAsB,IAAI,CAAC;AAEzC,MAAM,CAAC,KAAK,UAAU,OAAO;IAC3B,IAAI,UAAU;QAAE,OAAO,UAAU,CAAC;IAElC,GAAG,CAAC,KAAK,CAAC,wCAAwC,CAAC,CAAC;IACpD,MAAM,IAAI,GAAG,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;IAC1C,UAAU,GAAG,IAAI,CAAC;IAElB,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;IAEzC,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,aAAa;IACjC,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,OAAO,EAAE,CAAC;QAC7B,MAAM,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACjB,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc;IAClC,IAAI,CAAC,UAAU;QAAE,OAAO;IACxB,MAAM,UAAU,CAAC,OAAO,EAAE,CAAC;IAC3B,UAAU,GAAG,IAAI,CAAC;IAClB,GAAG,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;AAChC,CAAC"}

package/dist/migrations/sql/20240906125101-gameserver-enable.d.ts

@@ -0,0 +1,3 @@
+import { Knex } from 'knex';
+export declare function up(knex: Knex): Promise<void>;
+export declare function down(knex: Knex): Promise<void>;

package/dist/migrations/sql/20240906125101-gameserver-enable.js

@@ -0,0 +1,11 @@
+export async function up(knex) {
+    await knex.schema.alterTable('gameservers', (table) => {
+        table.boolean('enabled').defaultTo(true);
+    });
+}
+export async function down(knex) {
+    await knex.schema.alterTable('gameservers', (table) => {
+        table.dropColumn('enabled');
+    });
+}
+//# sourceMappingURL=20240906125101-gameserver-enable.js.map

package/dist/migrations/sql/20240906125101-gameserver-enable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"20240906125101-gameserver-enable.js","sourceRoot":"","sources":["../../../src/migrations/sql/20240906125101-gameserver-enable.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,KAAK,UAAU,EAAE,CAAC,IAAU;IACjC,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,aAAa,EAAE,CAAC,KAAK,EAAE,EAAE;QACpD,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,IAAU;IACnC,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,aAAa,EAAE,CAAC,KAAK,EAAE,EAAE;QACpD,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IAC9B,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/migrations/sql/20240908185212-domain-name-not-unique.d.ts

@@ -0,0 +1,3 @@
+import { Knex } from 'knex';
+export declare function up(knex: Knex): Promise<void>;
+export declare function down(knex: Knex): Promise<void>;

package/dist/migrations/sql/20240908185212-domain-name-not-unique.js

@@ -0,0 +1,9 @@
+export async function up(knex) {
+    await knex.schema.alterTable('domains', (table) => {
+        table.dropUnique(['name'], 'domains_name_unique');
+    });
+}
+export async function down(knex) {
+    // None, this is a one-way migration
+}
+//# sourceMappingURL=20240908185212-domain-name-not-unique.js.map

package/dist/migrations/sql/20240908185212-domain-name-not-unique.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"20240908185212-domain-name-not-unique.js","sourceRoot":"","sources":["../../../src/migrations/sql/20240908185212-domain-name-not-unique.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,KAAK,UAAU,EAAE,CAAC,IAAU;IACjC,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE;QAChD,KAAK,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,EAAE,qBAAqB,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,IAAU;IACnC,oCAAoC;AACtC,CAAC"}

package/dist/queryBuilder.d.ts

@@ -1,10 +1,10 @@
 import { QueryBuilder as ObjectionQueryBuilder, Model as ObjectionModel, Page } from 'objection';
 export declare class ITakaroQuery<T> {
     filters?: {
-        [key in keyof T]?: unknown[] | unknown;
+        [key: string]: unknown[] | string[] | boolean | null | undefined;
     };
     search?: {
-        [key in keyof T]?: unknown[] | unknown;
+        [key: string]: unknown[] | string[] | boolean | null | undefined;
     };
     greaterThan?: {
         [key in keyof T]?: unknown;
@@ -14,7 +14,7 @@ export declare class ITakaroQuery<T> {
     };
     page?: number;
     limit?: number;
-    sortBy?: Extract<keyof T, string>;
+    sortBy?: string;
     sortDirection?: SortDirection;
     extend?: string[];
 }
@@ -22,10 +22,17 @@ export declare enum SortDirection {
     asc = "asc",
     desc = "desc"
 }
+export declare function populateModelColumns(): Promise<void>;
 export declare class QueryBuilder<Model extends ObjectionModel, OutputDTO> {
-    private readonly query;
-    constructor(query?: ITakaroQuery<OutputDTO>);
-    build(query: ObjectionQueryBuilder<Model, Model[]>): ObjectionQueryBuilder<Model, Page<Model>>;
+    private query;
+    constructor(rawQuery?: ITakaroQuery<OutputDTO>);
+    /**
+     * 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
+     */
+    private cleanQueryObject;
+    build(queryBuilder: ObjectionQueryBuilder<Model, Model[]>): ObjectionQueryBuilder<Model, Page<Model>>;
     private filters;
     private greaterThan;
     private lessThan;

package/dist/queryBuilder.js

@@ -8,6 +8,7 @@ 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 { getKnex, isDbAvailable } from './knex.js';
 export class ITakaroQuery {
 }
 __decorate([
@@ -39,7 +40,7 @@ __decorate([
 __decorate([
     IsOptional(),
     IsString(),
-    __metadata("design:type", Object)
+    __metadata("design:type", String)
 ], ITakaroQuery.prototype, "sortBy", void 0);
 __decorate([
     IsOptional(),
@@ -57,15 +58,60 @@ export var 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(
+        // eslint-disable-next-line
+        "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(query = new ITakaroQuery()) {
-        this.query = query;
+    constructor(rawQuery = new ITakaroQuery()) {
+        this.query = JSON.parse(JSON.stringify(rawQuery));
+    }
+    /**
+     * 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) {
+                        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) {
+                        this.query.search[key] = [];
+                    }
+                }
+            }
+        }
+        return this.query;
     }
-    build(query) {
-        const tableName = query.modelClass().tableName;
+    build(queryBuilder) {
+        const tableName = queryBuilder.modelClass().tableName;
+        this.cleanQueryObject(tableName);
         const pagination = this.pagination();
         const sorting = this.sorting();
-        let qry = query.page(pagination.page, pagination.limit).orderBy(sorting.sortBy, sorting.sortDirection);
+        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);
@@ -95,7 +141,7 @@ export class QueryBuilder {
             if (Object.prototype.hasOwnProperty.call(this.query.filters, filter)) {
                 const searchVal = this.query.filters[filter];
                 if (searchVal && Array.isArray(searchVal)) {
-                    if (searchVal.includes(null) || searchVal.includes('null')) {
+                    if (searchVal.includes('null')) {
                         query.whereNull(`${tableName}.${filter}`);
                         continue;
                     }

package/dist/queryBuilder.js.map

@@ -1 +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;AAUzE,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;;4CACuB;AAKlC;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,OAAO,YAAY;IACvB,YAA6B,QAAiC,IAAI,YAAY,EAAE;QAAnD,UAAK,GAAL,KAAK,CAA8C;IAAG,CAAC;IAEpF,KAAK,CAAC,KAA4C;QAChD,MAAM,SAAS,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC,SAAS,CAAC;QAE/C,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QACrC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;QAE/B,IAAI,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;QAEvG,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,SAAS,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC1C,IAAI,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;wBAC3D,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"}
+{"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;AASzE,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;QAC3B,2BAA2B;QAC3B,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;IACpD,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,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;oBAC/B,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,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;oBAC9B,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,SAAS,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC1C,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@takaro/db",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "description": "An opinionated data layer",
   "main": "dist/main.js",
   "types": "dist/main.d.ts",
@@ -18,7 +18,6 @@
   "license": "ISC",
   "dependencies": {
     "convict": "^6.2.3",
-    "knex": "^3.0.0",
     "objection": "^3.0.1",
     "pg": "^8.8.0"
   },

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

@@ -1,5 +1,5 @@
 import { disconnectKnex, getKnex } from '../knex.js';
-import { QueryBuilder, SortDirection } from '../queryBuilder.js';
+import { populateModelColumns, QueryBuilder, SortDirection } from '../queryBuilder.js';
 import { expect } from '@takaro/test';
 import { TakaroModel } from '../TakaroModel.js';
 import { Model } from 'objection';
@@ -60,6 +60,8 @@ describe('QueryBuilder', () => {
 
     TestUserModel.knex(knex);
     TestPostModel.knex(knex);
+
+    await populateModelColumns();
   });
 
   afterEach(async () => {

package/src/knex.ts

@@ -34,19 +34,22 @@ export async function getKnex(): Promise<KnexClient> {
   const knex = createKnex(getKnexOptions());
   cachedKnex = knex;
 
-  health.registerHook('db', async () => {
-    try {
-      await knex.raw('SELECT 1');
-      return true;
-    } catch (error) {
-      log.error(error);
-      return false;
-    }
-  });
+  health.registerHook('db', isDbAvailable);
 
   return cachedKnex;
 }
 
+export async function isDbAvailable(): Promise<boolean> {
+  try {
+    const knex = await getKnex();
+    await knex.raw('SELECT 1');
+    return true;
+  } catch (error) {
+    log.error(error);
+    return false;
+  }
+}
+
 export async function disconnectKnex(): Promise<void> {
   if (!cachedKnex) return;
   await cachedKnex.destroy();

package/src/migrations/sql/20240906125101-gameserver-enable.ts

@@ -0,0 +1,14 @@
+import ms from 'ms';
+import { Knex } from 'knex';
+
+export async function up(knex: Knex): Promise<void> {
+  await knex.schema.alterTable('gameservers', (table) => {
+    table.boolean('enabled').defaultTo(true);
+  });
+}
+
+export async function down(knex: Knex): Promise<void> {
+  await knex.schema.alterTable('gameservers', (table) => {
+    table.dropColumn('enabled');
+  });
+}

package/src/migrations/sql/20240908185212-domain-name-not-unique.ts

@@ -0,0 +1,12 @@
+import ms from 'ms';
+import { Knex } from 'knex';
+
+export async function up(knex: Knex): Promise<void> {
+  await knex.schema.alterTable('domains', (table) => {
+    table.dropUnique(['name'], 'domains_name_unique');
+  });
+}
+
+export async function down(knex: Knex): Promise<void> {
+  // None, this is a one-way migration
+}

package/src/queryBuilder.ts

@@ -7,16 +7,17 @@ import {
   Expression,
   PrimitiveValue,
 } from 'objection';
+import { getKnex, isDbAvailable } from './knex.js';
 
 export class ITakaroQuery<T> {
   @IsOptional()
   filters?: {
-    [key in keyof T]?: unknown[] | unknown;
+    [key: string]: unknown[] | string[] | boolean | null | undefined;
   };
 
   @IsOptional()
   search?: {
-    [key in keyof T]?: unknown[] | unknown;
+    [key: string]: unknown[] | string[] | boolean | null | undefined;
   };
 
   @IsOptional()
@@ -39,7 +40,7 @@ export class ITakaroQuery<T> {
 
   @IsOptional()
   @IsString()
-  sortBy?: Extract<keyof T, string>;
+  sortBy?: string;
 
   @IsOptional()
   @IsString()
@@ -56,16 +57,72 @@ export enum SortDirection {
   desc = 'desc',
 }
 
+const modelColumns = new Map<string, string[]>();
+
+export async function populateModelColumns() {
+  if (await isDbAvailable()) {
+    const knex = await getKnex();
+    // Find all tables
+    const tables = await knex.raw(
+      // eslint-disable-next-line
+      "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<Model extends ObjectionModel, OutputDTO> {
-  constructor(private readonly query: ITakaroQuery<OutputDTO> = new ITakaroQuery()) {}
+  private query: ITakaroQuery<OutputDTO>;
+  constructor(rawQuery: ITakaroQuery<OutputDTO> = new ITakaroQuery()) {
+    this.query = JSON.parse(JSON.stringify(rawQuery));
+  }
+
+  /**
+   * 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
+   */
+  private cleanQueryObject(tableName: string) {
+    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) {
+            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) {
+            this.query.search[key] = [];
+          }
+        }
+      }
+    }
+
+    return this.query;
+  }
 
-  build(query: ObjectionQueryBuilder<Model, Model[]>): ObjectionQueryBuilder<Model, Page<Model>> {
-    const tableName = query.modelClass().tableName;
+  build(queryBuilder: ObjectionQueryBuilder<Model, Model[]>): ObjectionQueryBuilder<Model, Page<Model>> {
+    const tableName = queryBuilder.modelClass().tableName;
+    this.cleanQueryObject(tableName);
 
     const pagination = this.pagination();
     const sorting = this.sorting();
 
-    let qry = query.page(pagination.page, pagination.limit).orderBy(sorting.sortBy, sorting.sortDirection);
+    let qry = queryBuilder.page(pagination.page, pagination.limit).orderBy(sorting.sortBy, sorting.sortDirection);
 
     qry = this.filters(tableName, qry);
     qry = this.greaterThan(tableName, qry);
@@ -104,7 +161,7 @@ export class QueryBuilder<Model extends ObjectionModel, OutputDTO> {
         const searchVal = this.query.filters[filter];
 
         if (searchVal && Array.isArray(searchVal)) {
-          if (searchVal.includes(null) || searchVal.includes('null')) {
+          if (searchVal.includes('null')) {
             query.whereNull(`${tableName}.${filter}`);
             continue;
           }