complete

lib/CrudHandler.ts

@@ -1,8 +1,8 @@
 import { Request, Response } from 'express';
 
 export interface CrudHandler {
-  public create(req: Request, res: Response): Promise<void>;
+  create(req: Request, res: Response): Promise<void>;
-  public read(req: Request, res: Response): Promise<void>;
+  read(req: Request, res: Response): Promise<void>;
-  public update(req: Request, res: Response): Promise<void>;
+  update(req: Request, res: Response): Promise<void>;
-  public delete(req: Request, res: Response): Promise<void>;
+  delete(req: Request, res: Response): Promise<void>;
 }

lib/DatabaseCrudHandler.ts

@@ -1,35 +1,33 @@
 import { Request, Response, Router } from 'express';
 import { http } from '@scode/consts';
-import { DatabaseCrudOptions } from './DatabaseCrudOptions';
+import { ControlModel, DatabaseModel } from '@scode/modelling';
 import { CrudHandler } from './CrudHandler';
 import { HttpHandler } from './HttpHandler';
 import { DatabaseCrudOptionsReader } from './DatabaseCrudOptionsReader';
+import { DatabaseCrudOptions } from './DatabaseCrudOptions';
 
 export class DatabaseCrudHandler extends HttpHandler implements CrudHandler {
-  protected table: string;
+  protected cm:
-  protected columns: Array<string>;
+    new (object: Record<string, string|number|boolean>) => ControlModel;
+
+  protected dm: new (id?: number) => DatabaseModel;
   protected options: DatabaseCrudOptionsReader;
 
   public constructor (
-    table: string,
+    cm: new (object: Record<string, string|number|boolean>) => ControlModel,
-    columns: Array<string>,
+    dm: new (id?: number) => DatabaseModel,
     options: DatabaseCrudOptions = {}
   ) {
     super ();
-    this.table = table;
+    this.cm = cm;
-    this.columns = columns;
+    this.dm = dm;
     this.options = new DatabaseCrudOptionsReader (options);
-    if (this.columns.filter ((val) => val.toLowerCase () === 'id').length > 0) {
-      throw new Error (
-        'the column id cannot be made available to modification'
-      );
-    }
   }
 
   protected validate_body (
     req: Request,
     res: Response
-  ): Promise<Record<string, unknown>> | Record<string, unknown> {
+  ): Promise<Record<string, unknown> | null> | Record<string, unknown> | null {
     if (typeof req.body === 'undefined') {
       res.status (http.status_bad_request);
       res.end ('body was undefined');
@@ -45,29 +43,6 @@ export class DatabaseCrudHandler extends HttpHandler implements CrudHandler {
     return null;
   }
 
-  protected ensure_data (
-    data: Record<string, unknown>,
-    res: Response,
-    fail_on_undef = true
-  ): Promise<Record<string, unknown>> | Record<string, unknown> {
-    const obj = {};
-    const keys = Object.keys (data);
-    for (const col of this.columns) {
-      if (!keys.includes (col) && fail_on_undef) {
-        res.status (http.status_bad_request)
-          .end (`missing field: ${col}`);
-        return null;
-      }
-      obj[col] = data[col];
-    }
-    if (typeof this.options.optional_columns !== 'undefined') {
-      for (const col of this.options.optional_columns)
-        obj[col] = data[col];
-    }
-
-    return obj;
-  }
-
   public async create (req: Request, res: Response): Promise<void> {
     if (!await this.options.create_authorization (req, res))
       return;
@@ -76,16 +51,16 @@ export class DatabaseCrudHandler extends HttpHandler implements CrudHandler {
     if (body_data === null)
       return;
 
-    const db_data = await this.ensure_data (body_data, res);
+    const cm = new this.cm (body_data as Record<string|string, number|boolean>);
-    if (db_data === null)
+    cm.update ();
-      return;
 
-    const inserted = await this.knex (this.table)
+    const dm = new this.dm;
-      .returning ('id')
+    for (const key of Object.keys (body_data))
-      .insert (db_data);
+      dm.set (key, cm.get (key));
+    await dm.write ();
 
     res.status (http.status_created)
-      .end (inserted[0]);
+      .end (dm.id);
   }
 
   public async read (req: Request, res: Response): Promise<void> {
@@ -98,14 +73,14 @@ export class DatabaseCrudHandler extends HttpHandler implements CrudHandler {
       return;
     }
 
-    const json = await this.knex (this.table)
+    const dm = new this.dm (parseInt (req.headers.id as string));
-      .where ({ id: req.headers.id })
+    const found = await dm.read ();
-      .select (
+
-        'id',
+    const cm = new this.cm (dm.object);
-        ...this.columns
+    cm.update ();
-      );
+
-    res.status (json.length > 0 ? http.status_ok : http.status_not_found)
+    res.status (found ? http.status_ok : http.status_not_found)
-      .json (json[0]);
+      .json (cm.object);
   }
 
   public async update (req: Request, res: Response): Promise<void> {
@@ -116,21 +91,33 @@ export class DatabaseCrudHandler extends HttpHandler implements CrudHandler {
     if (body_data === null)
       return;
 
-    const db_data = await this.ensure_data (body_data, res, false);
-    if (db_data === null)
-      return;
-
     if (typeof req.headers.id === 'undefined') {
       res.status (http.status_bad_request)
         .end ('id undefined');
       return;
     }
 
-    await this.knex (this.table)
+    const dm = new this.dm (parseInt (req.headers.id as string));
-      .where ({ id: req.headers.id })
+    const found = await dm.read ();
-      .update (db_data);
+    if (!found) {
+      res.status (http.status_not_found)
+        .end ();
+      return;
+    }
 
-    res.status (http.status_ok)
+    const cm = new this.cm (dm.object);
+    cm.update ();
+
+    for (const key of Object.keys (body_data))
+      cm.set (key, body_data[key] as string|number|boolean);
+    cm.update ();
+
+    for (const key of Object.keys (cm.object))
+      dm.set (key, cm.get (key));
+
+    const written = await dm.write ();
+
+    res.status (written ? http.status_ok : http.status_internal_server_error)
       .end ();
   }
 
@@ -144,11 +131,17 @@ export class DatabaseCrudHandler extends HttpHandler implements CrudHandler {
       return;
     }
 
-    await this.knex (this.table)
+    const dm = new this.dm (parseInt (req.headers.id as string));
-      .where ({ id: req.headers.id })
+    const found = await dm.read ();
-      .delete ();
+    if (!found) {
+      res.status (http.status_not_found)
+        .end ();
+      return;
+    }
 
-    res.status (http.status_ok)
+    const deleted = await dm.delete ();
+
+    res.status (deleted ? http.status_ok : http.status_internal_server_error)
       .end ();
   }
 

lib/DatabaseCrudOptions.ts

@@ -1,5 +1,4 @@
 import { Request, Response } from 'express';
-import ControlModel from '@scode/modelling';
 
 type Authorization = {
   (req: Request, res: Response): Promise<boolean>;
@@ -13,7 +12,6 @@ interface DatabaseCrudOptions {
   update_authorization?: Authorization;
   delete_authorization?: Authorization;
   optional_columns?: Array<string>;
-  control_model?: Type<ControlModel>;
 }
 
 export { Authorization, DatabaseCrudOptions };

lib/DatabaseCrudOptionsReader.ts

@@ -1,15 +1,15 @@
 import { Request, Response } from 'express';
-import { KnexCrudOptions, Authorization } from './DatabaseCrudOptions';
+import { DatabaseCrudOptions, Authorization } from './DatabaseCrudOptions';
 
 type AuthRunner = {
   (req: Request, res: Response): Promise<boolean>;
 }
 
-export class KnexCrudOptionsReader {
+export class DatabaseCrudOptionsReader {
-  private options: KnexCrudOptions;
+  private _options: DatabaseCrudOptions;
 
-  public constructor (options: KnexCrudOptions) {
+  public constructor (options: DatabaseCrudOptions) {
-    this.options = options;
+    this._options = options;
   }
 
   private get_auth_runner (
@@ -17,20 +17,28 @@ export class KnexCrudOptionsReader {
   ): AuthRunner {
     if (typeof auth === 'undefined')
       return (): Promise<boolean> => new Promise ((r) => r (true));
-    return (req, res): Promise<boolean> => new Promise ((resolve) => {
+    return (req, res): Promise<boolean> => new Promise (
-      const result = auth (req, res, resolve);
+      (resolve: (value: boolean) => void) => {
-      if (typeof result !== 'undefined')
+        (async (): Promise<void> => {
-        resolve (result as boolean);
+          let resolved = false;
-    });
+          const result = await auth (req, res, (cb: unknown) => {
+            resolved = true;
+            resolve (typeof cb === 'undefined' || cb === true);
+          });
+          if (!resolved)
+            resolve (result === true);
+        }) ();
+      }
+    );
   }
 
   public get optional_columns (): Array<string> | undefined {
-    return this.options.optional_columns;
+    return this._options.optional_columns;
   }
 
   public get create_authorization (): Authorization {
-    const general = this.get_auth_runner (this.options.general_authorization);
+    const general = this.get_auth_runner (this._options.general_authorization);
-    const specific = this.get_auth_runner (this.options.create_authorization);
+    const specific = this.get_auth_runner (this._options.create_authorization);
     return async (req: Request, res: Response): Promise<boolean> => {
       const result = (await general (req, res)) && (await specific (req, res));
       return result;
@@ -38,8 +46,8 @@ export class KnexCrudOptionsReader {
   }
 
   public get read_authorization (): Authorization {
-    const general = this.get_auth_runner (this.options.general_authorization);
+    const general = this.get_auth_runner (this._options.general_authorization);
-    const specific = this.get_auth_runner (this.options.read_authorization);
+    const specific = this.get_auth_runner (this._options.read_authorization);
     return async (req: Request, res: Response): Promise<boolean> => {
       const result = (await general (req, res)) && (await specific (req, res));
       return result;
@@ -47,8 +55,8 @@ export class KnexCrudOptionsReader {
   }
 
   public get update_authorization (): Authorization {
-    const general = this.get_auth_runner (this.options.general_authorization);
+    const general = this.get_auth_runner (this._options.general_authorization);
-    const specific = this.get_auth_runner (this.options.update_authorization);
+    const specific = this.get_auth_runner (this._options.update_authorization);
     return async (req: Request, res: Response): Promise<boolean> => {
       const result = (await general (req, res)) && (await specific (req, res));
       return result;
@@ -56,8 +64,8 @@ export class KnexCrudOptionsReader {
   }
 
   public get delete_authorization (): Authorization {
-    const general = this.get_auth_runner (this.options.general_authorization);
+    const general = this.get_auth_runner (this._options.general_authorization);
-    const specific = this.get_auth_runner (this.options.delete_authorization);
+    const specific = this.get_auth_runner (this._options.delete_authorization);
     return async (req: Request, res: Response): Promise<boolean> => {
       const result = (await general (req, res)) && (await specific (req, res));
       return result;

lib/HttpHandler.ts

@@ -1,6 +1,6 @@
 import { Router } from 'express';
 
-export class HttpHandler {
+export abstract class HttpHandler {
   public abstract register_handlers(router: Router): void;
 
   public get_router (): Router {

package.json

@@ -4,7 +4,7 @@
   "description": "Express handler templates",
   "main": "dist/index.js",
   "scripts": {
-    "test": "nyc ava",
+    "test": "echo \"no test\"",
     "compile": "tsc",
     "lint": "eslint . --ext .js,.jsx,.ts,.tsx,.vue,.mjs",
     "ci": "yarn --frozen-lockfile && node jenkins.js"
@@ -23,17 +23,17 @@
   },
   "devDependencies": {
     "@ava/typescript": "^1.1.1",
-    "@scode/eslint-config-ts": "^1.0.22",
+    "@scode/eslint-config-ts": "^1.0.27",
     "@stryker-mutator/core": "^3.1.0",
     "@stryker-mutator/javascript-mutator": "^3.1.0",
-    "ava": "^3.7.1",
+    "ava": "^3.8.1",
     "eslint": "^6.8.0",
     "nyc": "^15.0.1",
     "typescript": "^3.8.3"
   },
   "dependencies": {
-    "@scode/consts": "^1.1.5",
+    "@scode/consts": "^1.1.7",
-    "@scode/modelling": "^1.0.3",
+    "@scode/modelling": "^1.0.16",
     "@types/express": "^4.17.6",
     "express": "^4.17.1"
   }

test/.eslintrc.js

@@ -1,20 +0,0 @@
-/*
- * Copyright (C) Sapphirecode - All Rights Reserved
- * This file is part of Requestor which is released under BSD-3-Clause.
- * See file 'LICENSE' for full license details.
- * Created by Timo Hocker <timo@scode.ovh>, March 2020
- */
-
-module.exports = {
-  env: {
-    commonjs: true,
-    es6: true,
-    node: true
-  },
-  extends: [
-    '@scode/eslint-config-ts'
-  ],
-  rules: {
-    'node/no-unpublished-import': 'off'
-  }
-}

test/KnexCrudHandler.ts

@@ -1,88 +0,0 @@
-import knex from 'knex';
-import test from 'ava';
-import express, { Request, Response } from 'express';
-import { http } from '@scode/consts';
-import { KnexCrudHandler } from '../lib/DatabaseCrudHandler';
-
-const db = knex ({
-  client:     'sqlite',
-  connection: { filename: './db.sqlite' }
-});
-
-/**
- * general auth
- *
- * @param {any} req request
- * @param {any} res response
- * @returns {Promise<boolean>} successful response
- */
-function general_auth (req: Request, res: Response): Promise<boolean> {
-  return new Promise ((resolve) => {
-    if (req.headers.auth === 'on') {
-      resolve (true);
-    }
-    else {
-      res.status (http.status_forbidden);
-      res.end ('auth failed');
-      resolve (false);
-    }
-  });
-}
-
-/**
- * read auth
- *
- * @param {any} req request
- * @param {any} res response
- * @returns {Promise<boolean>} successful response
- */
-function read_auth (req: Request, res: Response): Promise<boolean> {
-  return new Promise ((resolve) => {
-    if (req.headers.readauth === 'on') {
-      resolve (true);
-    }
-    else {
-      res.status (http.status_forbidden);
-      res.end ('readauth failed');
-      resolve (false);
-    }
-  });
-}
-
-test.before (async () => {
-  await db.schema.dropTableIfExists ('test');
-  await db.schema.createTable ('test', (t) => {
-    t.increments ('id');
-    t.string ('name');
-    t.integer ('number');
-  });
-
-  const no_auth = new KnexCrudHandler (db, 'test', [
-    'name',
-    'number'
-  ], {});
-
-  const auth = new KnexCrudHandler (db, 'test', [ 'name' ], {
-    optional_columns:      [ 'number' ],
-    general_authorization: general_auth,
-    read_authorization:    read_auth
-  });
-
-  const app = express ();
-  app.use ('/test', no_auth.get_router ());
-  app.use ('/auth', auth.get_router ());
-  // eslint-disable-next-line no-magic-numbers
-  app.listen (3000);
-});
-
-test ('insert data', (t) => {});
-test ('read data', (t) => {});
-test ('update data', (t) => {});
-test ('read updated data', (t) => {});
-
-test ('[a] insert data', (t) => {});
-test ('[a] insert data without auth', (t) => {});
-test ('[a] insert data without optional column', (t) => {});
-test ('[a] read data', (t) => {});
-test ('[a] read data without auth', (t) => {});
-test ('[a] read data without readauth', (t) => {});