core-express 0.1.0 → 0.1.1

package/lib/view.js

@@ -1,63 +1,77 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict"
+Object.defineProperty(exports, "__esModule", { value: true })
+function buildAndCheckId(req, res, keys) {
+  var id = buildId(req, keys)
+  if (!id) {
+    res.status(400).end("invalid parameters")
+    return undefined
+  }
+  return id
+}
+exports.buildAndCheckId = buildAndCheckId
 function buildId(req, attrs) {
-  if (!attrs) {
-    var id = req.params['id'];
+  if (!attrs || attrs.length === 0) {
+    var id = req.params["id"]
     if (id && id.length > 0) {
-      return id;
+      return id
     }
-    return null;
+    return undefined
   }
   if (attrs && attrs.length === 1) {
-    var key = (attrs[0].name ? attrs[0].name : 'id');
-    var id = req.params[key];
+    var id = req.params["id"]
+    var n = attrs[0].name
+    if ((!id || id.length === 0) && n && n.length > 0) {
+      id = req.params[n]
+    }
     if (id && id.length > 0) {
-      if (attrs[0].type === 'integer' || attrs[0].type === 'number') {
+      if (attrs[0].type === "integer" || attrs[0].type === "number") {
         if (isNaN(id)) {
-          return null;
+          return undefined
         }
-        var v = parseFloat(id);
-        return v;
+        var v = parseFloat(id)
+        return v
       }
-      return id;
+      return id
     }
   }
-  var ids = {};
+  var ids = {}
   for (var _i = 0, attrs_1 = attrs; _i < attrs_1.length; _i++) {
-    var attr = attrs_1[_i];
-    var v = req.params[attr.name];
+    var attr = attrs_1[_i]
+    if (!attr.name) {
+      return undefined
+    }
+    var v = req.params[attr.name]
     if (!v) {
-      return null;
+      return undefined
     }
-    if (attr.type === 'integer' || attr.type === 'number') {
+    if (attr.type === "integer" || attr.type === "number") {
       if (isNaN(v)) {
-        return null;
+        return undefined
       }
-      ids[attr.name] = parseFloat(v);
-    }
-    else {
-      ids[attr.name] = v;
+      ids[attr.name] = parseFloat(v)
+    } else {
+      ids[attr.name] = v
     }
-    return ids;
+    return ids
   }
 }
-exports.buildId = buildId;
+exports.buildId = buildId
 function buildKeys(attrs) {
   if (!attrs) {
-    return undefined;
+    return undefined
   }
-  var keys = Object.keys(attrs);
-  var ats = [];
+  var keys = Object.keys(attrs)
+  var ats = []
   for (var _i = 0, keys_1 = keys; _i < keys_1.length; _i++) {
-    var key = keys_1[_i];
-    var attr = attrs[key];
+    var key = keys_1[_i]
+    var attr = attrs[key]
     if (attr) {
       if (attr.key === true) {
-        var at = { name: key, type: attr.type };
-        ats.push(at);
+        var at = { name: key, type: attr.type }
+        ats.push(at)
       }
     }
   }
-  return ats;
+  return ats
 }
-exports.buildKeys = buildKeys;
+exports.buildKeys = buildKeys

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "core-express",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "core-express",
   "main": "./lib/index.js",
   "types": "./src/index.ts",
@@ -21,11 +21,15 @@
   },
   "repository": {
     "type": "git",
-    "url": "git@github.com/common-ts/express"
+    "url": "git@github.com/core-ts/core-express"
   },
   "keywords": [
     "express",
-    "core-express",
-    "core express"
+    "express-plus",
+    "express plus",
+    "express-ext",
+    "express ext",
+    "express-extension",
+    "express extension"
   ]
 }

package/src/GenericController.ts

@@ -1,134 +1,245 @@
-import {Request, Response} from 'express';
-import {checkId, create, initializeStatus, isTypeError, ResultInfo, StatusConfig, update} from './edit';
-import {LoadController} from './LoadController';
-import {Attributes, ErrorMessage, Model} from './metadata';
-import {resources} from './resources';
-import {handleError} from './response';
-import {buildId} from './view';
+import { Request, Response } from "express"
+import { checkId, create, getStatusCode, update } from "./edit"
+import { handleError } from "./http"
+import { LoadController } from "./LoadController"
+import { Attribute, Attributes, ErrorMessage } from "./metadata"
+import { resources, StringMap } from "./resources"
+import { buildAndCheckId, buildId } from "./view"
 
+export type Build<T> = (res: Response, obj: T, isCreate?: boolean, isPatch?: boolean) => void
+export type Validate<T> = (obj: T, resource?: StringMap, patch?: boolean) => Promise<ErrorMessage[]>
+export type Save<T> = (obj: T, ctx?: any) => Promise<number | T | ErrorMessage[]>
 export interface GenericService<T, ID, R> {
-  metadata?(): Model;
-  load(id: ID, ctx?: any): Promise<T>;
-  insert(obj: T, ctx?: any): Promise<R>;
-  update(obj: T, ctx?: any): Promise<R>;
-  patch?(obj: T, ctx?: any): Promise<R>;
-  delete?(id: ID, ctx?: any): Promise<number>;
+  metadata?(): Attributes | undefined
+  load(id: ID, ctx?: any): Promise<T | null>
+  create(obj: T, ctx?: any): Promise<R>
+  update(obj: T, ctx?: any): Promise<R>
+  patch?(obj: Partial<T>, ctx?: any): Promise<R>
+  delete?(id: ID, ctx?: any): Promise<number>
 }
 export class GenericController<T, ID> extends LoadController<T, ID> {
-  status: StatusConfig;
-  metadata: Attributes;
-  constructor(log: (msg: string, ctx?: any) => void, public service: GenericService<T, ID, number|ResultInfo<T>>, status?: StatusConfig, public validate?: (obj: T, patch?: boolean) => Promise<ErrorMessage[]>) {
-    super(log, service);
-    this.status = initializeStatus(status);
+  metadata?: Attributes
+  returnNumber?: boolean
+  constructor(
+    public service: GenericService<T, ID, number | T | ErrorMessage[]>,
+    public build?: Build<T>,
+    public validate?: Validate<T>,
+    returnNumber?: boolean,
+  ) {
+    super(service)
+    this.returnNumber = returnNumber
     if (service.metadata) {
-      const m = service.metadata();
+      const m = service.metadata()
       if (m) {
-        this.metadata = m.attributes;
+        this.metadata = m
       }
     }
-    this.insert = this.insert.bind(this);
-    this.update = this.update.bind(this);
-    this.patch = this.patch.bind(this);
-    this.delete = this.delete.bind(this);
+    this.create = this.create.bind(this)
+    this.update = this.update.bind(this)
+    this.patch = this.patch.bind(this)
+    this.delete = this.delete.bind(this)
     if (!validate && resources.createValidator && this.metadata) {
-      const v = resources.createValidator(this.metadata);
-      this.validate = v.validate;
+      const v = resources.createValidator(this.metadata)
+      this.validate = v.validate
     }
   }
-  insert(req: Request, res: Response) {
-    const obj = req.body;
-    if (!obj) {
-      return res.status(400).end('The request body cannot be empty.');
-    }
-    if (this.validate) {
-      const l = this.log;
-      this.validate(obj).then(errors => {
-        if (errors && errors.length > 0) {
-          const r: ResultInfo<T> = {status: this.status.validation_error, errors};
-          res.status(getStatusCode(errors)).json(r);
-        } else {
-          create(res, this.status, obj, this.service.insert, this.log);
-        }
-      }).catch(err => handleError(err, res, l));
-    } else {
-      create(res, this.status, obj, this.service.insert, this.log);
+  create(req: Request, res: Response): void {
+    validateAndCreate(req, res, this.service.create, this.validate, this.build)
+  }
+  update(req: Request, res: Response): void {
+    const id = buildAndCheckIdWithBody<T, ID, any>(req, res, this.keys, this.service.update)
+    if (id) {
+      validateAndUpdate(res, req.body, false, this.service.update, this.validate, undefined, this.build)
     }
   }
-  update(req: Request, res: Response) {
-    const obj = req.body;
-    if (!obj) {
-      return res.status(400).end('The request body cannot be empty.');
+  patch(req: Request, res: Response): void {
+    const id = buildAndCheckIdWithBody<T, ID, any>(req, res, this.keys, this.service.patch)
+    if (id && this.service.patch) {
+      validateAndUpdate(res, req.body, true, this.service.patch, this.validate, undefined, this.build)
     }
-    const id = buildId<ID>(req, this.keys);
-    if (!id) {
-      return res.status(400).end('Invalid parameters');
+  }
+  delete(req: Request, res: Response): void {
+    const id = buildAndCheckId<ID>(req, res, this.keys)
+    if (id) {
+      if (!this.service.delete) {
+        res.status(405).end("Method Not Allowed")
+      } else {
+        this.service
+          .delete(id)
+          .then((count) => {
+            res.status(getDeleteStatus(count)).json(count).end()
+          })
+          .catch((err) => handleError(err, res))
+      }
     }
-    const ok = checkId<T, ID>(obj, id, this.keys);
-    if (!ok) {
-      return res.status(400).end('Invalid parameters');
+  }
+}
+export function validateAndCreate<T>(req: Request, res: Response, save: Save<T>, validate?: Validate<T>, build?: Build<T>, returnNumber?: boolean): void {
+  const obj = req.body
+  if (!obj || obj === "") {
+    res.status(400).end("The request body cannot be empty.")
+  } else {
+    if (validate) {
+      validate(obj)
+        .then((errors) => {
+          if (errors && errors.length > 0) {
+            res.status(getStatusCode(errors)).json(errors).end()
+          } else {
+            if (build) {
+              build(res, obj, true)
+            }
+            create(res, obj, save, returnNumber)
+          }
+        })
+        .catch((err) => handleError(err, res))
+    } else {
+      create(res, obj, save, returnNumber)
     }
-    if (this.validate) {
-      const l = this.log;
-      this.validate(obj).then(errors => {
+  }
+}
+export function validateAndUpdate<T>(
+  res: Response,
+  obj: T,
+  isPatch: boolean,
+  save: Save<T>,
+  validate?: Validate<T>,
+  resource?: StringMap,
+  build?: Build<T>,
+  returnNumber?: boolean,
+): void {
+  if (validate) {
+    validate(obj, resource, isPatch)
+      .then((errors) => {
         if (errors && errors.length > 0) {
-          const r: ResultInfo<T> = {status: this.status.validation_error, errors};
-          res.status(getStatusCode(errors)).json(r);
+          res.status(getStatusCode(errors)).json(errors).end()
         } else {
-          update(res, this.status, obj, this.service.update, this.log);
+          if (build) {
+            build(res, obj, false, isPatch)
+          }
+          update(res, obj, save, returnNumber)
         }
-      }).catch(err => handleError(err, res, l));
-    } else {
-      update(res, this.status, obj, this.service.update, this.log);
-    }
+      })
+      .catch((err) => handleError(err, res))
+  } else {
+    update(res, obj, save, returnNumber)
   }
-  patch(req: Request, res: Response) {
-    const obj = req.body;
-    if (!obj) {
-      return res.status(400).end('The request body cannot be empty.');
-    }
-    const id = buildId<ID>(req, this.keys);
-    if (!id) {
-      return res.status(400).end('Invalid parameters');
+}
+export function buildAndCheckIdWithBody<T, ID, R>(req: Request, res: Response, keys?: Attribute[], patch?: (obj: T, ctx?: any) => Promise<R>): ID | undefined {
+  const obj = req.body
+  if (!obj || obj === "") {
+    res.status(400).end("The request body cannot be empty.")
+    return undefined
+  }
+  if (!patch) {
+    res.status(405).end("Method Not Allowed")
+    return undefined
+  }
+  const id = buildId<ID>(req, keys)
+  if (!id) {
+    res.status(400).end("Invalid parameters")
+    return undefined
+  }
+  const ok = checkId<T, ID>(obj, id, keys)
+  if (!ok) {
+    res.status(400).end("body and url are not matched")
+    return undefined
+  }
+  return id
+}
+export function getDeleteStatus(count: number): number {
+  if (count > 0) {
+    return 200
+  } else if (count === 0) {
+    return 404
+  } else {
+    return 409
+  }
+}
+
+export interface ModelConfig {
+  id?: string
+  payload?: string
+  user?: string
+  updatedBy?: string
+  updatedAt?: string
+  createdBy?: string
+  createdAt?: string
+  version?: string
+}
+export function useBuild<T>(c: ModelConfig, generate?: () => string): Build<T> {
+  const b = new Builder<T>(
+    generate,
+    c.id ? c.id : "",
+    c.payload ? c.payload : "",
+    c.user ? c.user : "",
+    c.updatedBy ? c.updatedBy : "",
+    c.updatedAt ? c.updatedAt : "",
+    c.createdBy ? c.createdBy : "",
+    c.createdAt ? c.createdAt : "",
+    c.version ? c.version : "",
+  )
+  return b.build
+}
+// tslint:disable-next-line:max-classes-per-file
+export class Builder<T> {
+  constructor(
+    public generate: (() => string) | undefined,
+    public id: string,
+    public payload: string,
+    public user: string,
+    public updatedBy: string,
+    public updatedAt: string,
+    public createdBy: string,
+    public createdAt: string,
+    public version: string,
+  ) {
+    this.build = this.build.bind(this)
+  }
+  build(res: Response, obj: T, isCreate?: boolean, isPatch?: boolean): void {
+    const o: any = obj
+    let usr = ""
+    if (this.user.length > 0) {
+      if (this.payload.length > 0) {
+        const payload = res.locals[this.payload]
+        if (payload) {
+          usr = payload[this.user]
+        }
+      } else {
+        usr = res.locals[this.user]
+      }
     }
-    const ok = checkId<T, ID>(obj, id, this.keys);
-    if (!ok) {
-      return res.status(400).end('Invalid parameters');
+    if (!usr) {
+      usr = ""
     }
-    if (this.validate) {
-      const l = this.log;
-      this.validate(obj, true).then(errors => {
-        if (errors && errors.length > 0) {
-          const r: ResultInfo<T> = {status: this.status.validation_error, errors};
-          res.status(getStatusCode(errors)).json(r);
-        } else {
-          update(res, this.status, obj, this.service.patch, this.log);
+    const now = new Date()
+    if (isCreate) {
+      if (this.generate && this.id.length > 0) {
+        o[this.id] = this.generate()
+      }
+      if (usr.length > 0) {
+        if (this.createdAt.length > 0) {
+          o[this.createdAt] = now
         }
-      }).catch(err => handleError(err, res, l));
-    } else {
-      update(res, this.status, obj, this.service.update, this.log);
-    }
-  }
-  delete(req: Request, res: Response) {
-    const id = buildId<ID>(req, this.keys);
-    if (!id) {
-      return res.status(400).end('invalid parameters');
+        if (this.createdBy.length > 0) {
+          o[this.createdBy] = usr
+        }
+      }
+      if (this.version.length > 0) {
+        o[this.version] = 1
+      }
+    } else if (isPatch) {
+      const keys = Object.keys(o)
+      if (keys.length === 0) {
+        return
+      }
     }
-    this.service.delete(id).then(count => {
-      if (count > 0) {
-        res.status(200).json(count);
-      } else if (count === 0) {
-        res.status(404).json(count);
-      } else {
-        res.status(409).json(count);
+    if (usr.length > 0) {
+      if (this.updatedAt.length > 0) {
+        o[this.updatedAt] = now
       }
-    }).catch(err => {
-      if (this.log) {
-        this.log(err as any);
+      if (this.updatedBy.length > 0) {
+        o[this.updatedBy] = usr
       }
-      res.status(500).end('Internal Server Error');
-    });
+    }
   }
 }
-function getStatusCode(errs: ErrorMessage[]): number {
-  return (isTypeError(errs) ? 400 : 422);
-}

package/src/GenericSearchController.ts

@@ -1,28 +1,45 @@
-import {Request, Response} from 'express';
-import {ResultInfo, StatusConfig} from './edit';
-import {GenericController, GenericService} from './GenericController';
-import {ErrorMessage} from './metadata';
-import {handleError} from './response';
-import {fromRequest, getLimit, initializeConfig, jsonResult, SearchConfig, SearchModel, SearchResult} from './search';
+import { Request, Response } from "express"
+import { Build, GenericController, GenericService } from "./GenericController"
+import { handleError } from "./http"
+import { ErrorMessage } from "./metadata"
+import { resources, StringMap } from "./resources"
+import { buildArray, Filter, format, fromRequest, getMetadataFunc, getParameters, initializeConfig, jsonResult, SearchConfig, SearchResult } from "./search"
 
-export interface Config extends StatusConfig, SearchConfig {
-}
-export class GenericSearchController<T, ID, S extends SearchModel> extends GenericController<T, ID> {
-  config?: SearchConfig;
-  csv?: boolean;
-  constructor(log: (msg: string, ctx?: any) => void, public find: (s: S, limit?: number, skip?: number, refId?: string) => Promise<SearchResult<T>>, service: GenericService<T, ID, number|ResultInfo<T>>, config?: Config, validate?: (obj: T, patch?: boolean) => Promise<ErrorMessage[]>, public format?: (s: S) => S) {
-    super(log, service, config, validate);
-    this.search = this.search.bind(this);
-    this.config = initializeConfig(config);
+export class GenericSearchController<T, ID, S extends Filter> extends GenericController<T, ID> {
+  config?: SearchConfig
+  csv?: boolean
+  dates?: string[]
+  numbers?: string[]
+  excluding?: string
+  array?: string[]
+  constructor(
+    public find: (s: S, limit: number, page?: number | string, fields?: string[]) => Promise<SearchResult<T>>,
+    service: GenericService<T, ID, number | ErrorMessage[]>,
+    config?: SearchConfig,
+    build?: Build<T>,
+    validate?: (obj: T, resource?: StringMap, patch?: boolean) => Promise<ErrorMessage[]>,
+    dates?: string[],
+    numbers?: string[],
+  ) {
+    super(service, build, validate)
+    this.search = this.search.bind(this)
+    this.config = initializeConfig(config)
     if (this.config) {
-      this.csv = this.config.csv;
+      this.csv = this.config.csv
+      this.excluding = this.config.excluding
+    }
+    const m = getMetadataFunc(service, dates, numbers)
+    if (m) {
+      this.dates = m.dates
+      this.numbers = m.numbers
     }
   }
   search(req: Request, res: Response) {
-    const s = fromRequest<S>(req, this.format);
-    const l = getLimit(s);
-    this.find(s, l.limit, l.skip, l.refId)
-      .then(result => jsonResult(res, result, this.csv, s.fields, this.config))
-      .catch(err => handleError(err, res, this.log));
+    const s = fromRequest<S>(req, buildArray(this.array, resources.fields, this.excluding))
+    const l = getParameters(s)
+    const s2 = format(s, this.dates, this.numbers)
+    this.find(s2, l.limit, l.pageOrNextPageToken, l.fields)
+      .then((result) => jsonResult(res, result, this.csv, l.fields, this.config))
+      .catch((err) => handleError(err, res))
   }
 }

package/src/HealthController.ts

@@ -1,17 +1,17 @@
-import {Request, Response} from 'express';
-import {check, HealthChecker} from './health';
+import { Request, Response } from "express"
+import { health, HealthChecker } from "./health"
 
 export class HealthController {
   constructor(protected checkers: HealthChecker[]) {
-    this.check = this.check.bind(this);
+    this.check = this.check.bind(this)
   }
-  async check(req: Request, res: Response) {
-    check(this.checkers).then(heath => {
-      if (heath.status === 'UP') {
-        return res.status(200).json(heath);
+  check(req: Request, res: Response) {
+    health(this.checkers).then((r) => {
+      if (r.status === "UP") {
+        res.status(200).json(r).end()
       } else {
-        return res.status(500).json(heath);
+        res.status(500).json(r).end()
       }
-    });
+    })
   }
 }