Better tests

Author: acrodrig

resources/tjs.ts

@@ -0,0 +1,15 @@
+#!/usr/bin/env -S deno run -A
+
+// Example of invoking TypeScript JSON Schema
+
+import * as TJS from "npm:typescript-json-schema";
+import { DDL } from "../mod.ts";
+
+// See https://github.com/YousefED/typescript-json-schema/issues/251
+const settings: TJS.PartialArgs = { required: true, defaultNumberType: "integer", ignoreErrors: true, validationKeywords: DDL.EXTENSIONS };
+const compilerOptions = { lib: [ "es2020" ], target: "es2020" };
+const program = TJS.getProgramFromFiles([ import.meta.dirname! + "/account.ts" ], compilerOptions);
+
+// We can either get the schema for one file and one type...
+const schema = TJS.generateSchema(program, "Account", settings);
+console.log(schema);

src/repository.ts

@@ -119,9 +119,10 @@ export class Repository<T extends Identifiable> extends EventTarget {
 
   // https://dev.mysql.com/doc/refman/8.0/en/select.html
   // Follow Loopback model (see https://loopback.io/doc/en/lb4/Querying-data.html)
-  async find(filter: Filter<T> = {}, debug?: boolean): Promise<T[]> {
+  async find(filterOrWhere?: Filter<T> | Where<T>, debug?: boolean): Promise<T[]> {
     // If there is no filter, we are better off returning the results from all
-    if (!filter) return this.all();
+    if (!filterOrWhere) return this.all();
+    const filter: Filter<T> = Object.hasOwn(filterOrWhere, "where") ? filterOrWhere as Filter<T> : { where: filterOrWhere as Where<T> };
 
     assert(typeof filter === "object" && !Array.isArray(filter), "Parameter 'filter' must be an object");
 
@@ -166,7 +167,8 @@ export class Repository<T extends Identifiable> extends EventTarget {
   }
 
   // https://dev.mysql.com/doc/refman/8.0/en/select.html
-  async findOne(filter: Filter<T> = {}, debug?: boolean): Promise<T | undefined> {
+  async findOne(filterOrWhere: Filter<T> | Where<T> = {}, debug?: boolean): Promise<T | undefined> {
+    const filter: Filter<T> = Object.hasOwn(filterOrWhere, "where") ? filterOrWhere as Filter<T> : { where: filterOrWhere as Where<T> };
     filter.limit = 1;
     return (await this.find(filter, debug)).pop();
   }

test/basic.test.ts

@@ -42,6 +42,11 @@ test("Retrieve via generic find", options, async function () {
   assertEquals(account.length, 1);
 });
 
+test("Retrieve via simplified filter (where clause)", options, async function () {
+  const account = await repo.find({ id });
+  assertEquals(account.length, 1);
+});
+
 test("Retrieve via another column", options, async function () {
   const account = await repo.findOne({ where: { name: NAME } }) as AccountModel;
   assertExists(account);
@@ -54,8 +59,13 @@ test("Retrieve via SQL query", options, async function () {
   assertEquals(accounts[0].name, NAME);
 });
 
+test("Retrieve via SQL query with named parameter(s)", options, async function () {
+  const records = await DB.query(`SELECT * FROM accounts WHERE name = :n`, { n: NAME });
+  assertEquals(records.length, 1);
+});
+
 test("Boolean Values", options, async function () {
-  const accounts = await repo.find({ where: { name: "xyz", enabled: true } });
+  const accounts = await repo.find({ name: "xyz", enabled: true });
   assertEquals(accounts.length, 0);
 });
 

test/helpers.ts

@@ -42,7 +42,6 @@ export async function createTables(schemas: Schema[]) {
   for (const schema of schemas) {
     if (DB.type !== DB.Provider.SQLITE) await DB.execute(`DROP TABLE IF EXISTS ${schema.table} CASCADE;`);
     const sql = DDL.createTable(schema, DB.type as DB.Provider);
-    console.log(sql);
     await dbExec(sql);
   }
 }